VirtualBox.xidl@ 37244

Last change on this file since 37244 was 37244, checked in by vboxsync, 14 years ago
Main/VirtualBox: new method for querying the API version
Property svn:eol-style set to `native`
File size: 624.1 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.215389.xyz. 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.11", 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="bc166b9b-9b62-4145-b1f6-6c39068aaf00"
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	<method name="composeMachineFilename">
1554	<desc>
1555	Returns a recommended full path of the settings file name for a new virtual
1556	machine.
1557
1558	This API serves two purposes:
1559
1560	<ul>
1561	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1562	for the @a settingsFile argument there, which means that API should use
1563	a recommended default file name.</li>
1564
1565	<li>It can be called manually by a client software before creating a machine,
1566	e.g. if that client wants to pre-create the machine directory to create
1567	virtual hard disks in that directory together with the new machine
1568	settings file. In that case, the file name should be stripped from the
1569	full settings file path returned by this function to obtain the
1570	machine directory.</li>
1571	</ul>
1572
1573	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1574	details about the machine name.
1575
1576	If @a baseFolder is a @c null or empty string (which is recommended), the
1577	default machine settings folder
1578	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1579	a base folder for the created machine, resulting in a file name like
1580	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1581	will be used.
1582
1583	This method does not access the host disks. In particular, it does not check
1584	for whether a machine of this name already exists.
1585	</desc>
1586	<param name="name" type="wstring" dir="in">
1587	<desc>Suggested machine name.</desc>
1588	</param>
1589	<param name="baseFolder" type="wstring" dir="in">
1590	<desc>Base machine folder (optional).</desc>
1591	</param>
1592	<param name="file" type="wstring" dir="return">
1593	<desc>Fully qualified path where the machine would be created.</desc>
1594	</param>
1595	</method>
1596
1597	<method name="createMachine">
1598	<desc>
1599	Creates a new virtual machine by creating a machine settings file at
1600	the given location.
1601
1602	VirtualBox machine settings files use a custom XML dialect. Starting
1603	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1604	and machine files can be created at arbitrary locations.
1605
1606	However, it is is recommended that machines be created in the default
1607	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1608	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1609	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1610	is called automatically to have such a recommended name composed based
1611	on the machine name given in the @a name argument.
1612
1613	If the resulting settings file already exists, this method will fail,
1614	unless @a forceOverwrite is set.
1615
1616	The new machine is created unregistered, with the initial configuration
1617	set according to the specified guest OS type. A typical sequence of
1618	actions to create a new virtual machine is as follows:
1619
1620	<ol>
1621	<li>
1622	Call this method to have a new machine created. The returned machine
1623	object will be "mutable" allowing to change any machine property.
1624	</li>
1625
1626	<li>
1627	Configure the machine using the appropriate attributes and methods.
1628	</li>
1629
1630	<li>
1631	Call <link to="IMachine::saveSettings" /> to write the settings
1632	to the machine's XML settings file. The configuration of the newly
1633	created machine will not be saved to disk until this method is
1634	called.
1635	</li>
1636
1637	<li>
1638	Call <link to="#registerMachine" /> to add the machine to the list
1639	of machines known to VirtualBox.
1640	</li>
1641	</ol>
1642
1643	The specified guest OS type identifier must match an ID of one of known
1644	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1645	array.
1646
1647	Optionally, you may specify an UUID of to assign to the created machine.
1648	However, this is not recommended and you should normally pass an empty
1649	(@c null) UUID to this method so that a new UUID will be automatically
1650	generated for every created machine. You can use UUID
1651	00000000-0000-0000-0000-000000000000 as @c null value.
1652
1653	<note>
1654	There is no way to change the name of the settings file or
1655	subfolder of the created machine directly.
1656	</note>
1657
1658	<result name="VBOX_E_OBJECT_NOT_FOUND">
1659	@a osTypeId is invalid.
1660	</result>
1661	<result name="VBOX_E_FILE_ERROR">
1662	Resulting settings file name is invalid or the settings file already
1663	exists or could not be created due to an I/O error.
1664	</result>
1665	<result name="E_INVALIDARG">
1666	@a name is empty or @c null.
1667	</result>
1668	</desc>
1669
1670	<param name="settingsFile" type="wstring" dir="in">
1671	<desc>Fully qualified path where the settings file should be created,
1672	or NULL for a default folder and file based on the @a name argument
1673	(see <link to="#composeMachineFilename" />).</desc>
1674	</param>
1675	<param name="name" type="wstring" dir="in">
1676	<desc>Machine name.</desc>
1677	</param>
1678	<param name="osTypeId" type="wstring" dir="in">
1679	<desc>Guest OS Type ID.</desc>
1680	</param>
1681	<param name="id" type="uuid" mod="string" dir="in">
1682	<desc>Machine UUID (optional).</desc>
1683	</param>
1684	<param name="forceOverwrite" type="boolean" dir="in">
1685	<desc>If true, an existing machine settings file will be overwritten.</desc>
1686	</param>
1687	<param name="machine" type="IMachine" dir="return">
1688	<desc>Created machine object.</desc>
1689	</param>
1690	</method>
1691
1692	<method name="openMachine">
1693	<desc>
1694	Opens a virtual machine from the existing settings file.
1695	The opened machine remains unregistered until you call
1696	<link to="#registerMachine"/>.
1697
1698	The specified settings file name must be fully qualified.
1699	The file must exist and be a valid machine XML settings file
1700	whose contents will be used to construct the machine object.
1701
1702	<result name="VBOX_E_FILE_ERROR">
1703	Settings file name invalid, not found or sharing violation.
1704	</result>
1705	</desc>
1706	<param name="settingsFile" type="wstring" dir="in">
1707	<desc>
1708	Name of the machine settings file.
1709	</desc>
1710	</param>
1711	<param name="machine" type="IMachine" dir="return">
1712	<desc>Opened machine object.</desc>
1713	</param>
1714	<note>
1715	<link to="IMachine::settingsModified"/> will return
1716	@c false for the created machine, until any of machine settings
1717	are changed.
1718	</note>
1719	</method>
1720
1721	<method name="registerMachine">
1722	<desc>
1723
1724	Registers the machine previously created using
1725	<link to="#createMachine"/> or opened using
1726	<link to="#openMachine"/> within this VirtualBox installation. After
1727	successful method invocation, the
1728	<link to="IMachineRegisteredEvent"/> event is fired.
1729
1730	<note>
1731	This method implicitly calls <link to="IMachine::saveSettings"/>
1732	to save all current machine settings before registering it.
1733	</note>
1734
1735	<result name="VBOX_E_OBJECT_NOT_FOUND">
1736	No matching virtual machine found.
1737	</result>
1738	<result name="VBOX_E_INVALID_OBJECT_STATE">
1739	Virtual machine was not created within this VirtualBox instance.
1740	</result>
1741
1742	</desc>
1743	<param name="machine" type="IMachine" dir="in"/>
1744	</method>
1745
1746	<method name="findMachine">
1747	<desc>
1748	Attempts to find a virtual machine given its name or UUID.
1749
1750	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1751	cannot safely be determined.</note>
1752
1753	<result name="VBOX_E_OBJECT_NOT_FOUND">
1754	Could not find registered machine matching @a nameOrId.
1755	</result>
1756
1757	</desc>
1758	<param name="nameOrId" type="wstring" dir="in">
1759	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1760	</param>
1761	<param name="machine" type="IMachine" dir="return">
1762	<desc>Machine object, if found.</desc>
1763	</param>
1764	</method>
1765
1766	<method name="createAppliance">
1767	<desc>
1768	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1769	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1770	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1771	</desc>
1772	<param name="appliance" type="IAppliance" dir="return">
1773	<desc>New appliance.</desc>
1774	</param>
1775	</method>
1776
1777	<method name="createHardDisk">
1778	<desc>
1779	Creates a new base medium object that will use the given storage
1780	format and location for medium data.
1781
1782	The actual storage unit is not created by this method. In order to
1783	do it, and before you are able to attach the created medium to
1784	virtual machines, you must call one of the following methods to
1785	allocate a format-specific storage unit at the specified location:
1786	<ul>
1787	<li><link to="IMedium::createBaseStorage"/></li>
1788	<li><link to="IMedium::createDiffStorage"/></li>
1789	</ul>
1790
1791	Some medium attributes, such as <link to="IMedium::id"/>, may
1792	remain uninitialized until the medium storage unit is successfully
1793	created by one of the above methods.
1794
1795	After the storage unit is successfully created, it will be
1796	accessible through the <link to="#findMedium"/> method and can
1797	be found in the <link to="#hardDisks"/> array.
1798
1799	The list of all storage formats supported by this VirtualBox
1800	installation can be obtained using
1801	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1802	attribute is empty or @c null then the default storage format
1803	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1804	be used for creating a storage unit of the medium.
1805
1806	Note that the format of the location string is storage format specific.
1807	See <link to="IMedium::location"/> and IMedium for more details.
1808
1809	<result name="VBOX_E_OBJECT_NOT_FOUND">
1810	@a format identifier is invalid. See
1811	<link to="ISystemProperties::mediumFormats"/>.
1812	</result>
1813	<result name="VBOX_E_FILE_ERROR">
1814	@a location is a not valid file name (for file-based formats only).
1815	</result>
1816	</desc>
1817	<param name="format" type="wstring" dir="in">
1818	<desc>
1819	Identifier of the storage format to use for the new medium.
1820	</desc>
1821	</param>
1822	<param name="location" type="wstring" dir="in">
1823	<desc>
1824	Location of the storage unit for the new medium.
1825	</desc>
1826	</param>
1827	<param name="medium" type="IMedium" dir="return">
1828	<desc>Created medium object.</desc>
1829	</param>
1830	</method>
1831
1832	<method name="openMedium">
1833	<desc>
1834	Opens a medium from an existing storage location.
1835
1836	Once a medium has been opened, it can be passed to other VirtualBox
1837	methods, in particular to <link to="IMachine::attachDevice" />.
1838
1839	Depending on the given device type, the file at the storage location
1840	must be in one of the media formats understood by VirtualBox:
1841
1842	<ul>
1843	<li>With a "HardDisk" device type, the file must be a hard disk image
1844	in one of the formats supported by VirtualBox (see
1845	<link to="ISystemProperties::mediumFormats" />).
1846	After this method succeeds, if the medium is a base medium, it
1847	will be added to the <link to="#hardDisks"/> array attribute. </li>
1848	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1849	After this method succeeds, the medium will be added to the
1850	<link to="#DVDImages"/> array attribute.</li>
1851	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1852	After this method succeeds, the medium will be added to the
1853	<link to="#floppyImages"/> array attribute.</li>
1854	</ul>
1855
1856	After having been opened, the medium can be found by the <link to="#findMedium"/>
1857	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1858
1859	The UUID of the newly opened medium will either be retrieved from the
1860	storage location, if the format supports it (e.g. for hard disk images),
1861	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1862	If for some reason you need to change the medium's UUID, use
1863	<link to="IMedium::setIDs" />.
1864
1865	If a differencing hard disk medium is to be opened by this method, the
1866	operation will succeed only if its parent medium and all ancestors,
1867	if any, are already known to this VirtualBox installation (for example,
1868	were opened by this method before).
1869
1870	This method attempts to guess the storage format of the specified medium
1871	by reading medium data at the specified location.
1872
1873	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1874	the image is opened for read/write access and must have according permissions,
1875	as VirtualBox may actually write status information into the disk's metadata
1876	sections.
1877
1878	Note that write access is required for all typical hard disk usage in VirtualBox,
1879	since VirtualBox may need to write metadata such as a UUID into the image.
1880	The only exception is opening a source image temporarily for copying and
1881	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1882	again soon.
1883
1884	The format of the location string is storage format specific. See
1885	<link to="IMedium::location"/> and IMedium for more details.
1886
1887	<result name="VBOX_E_FILE_ERROR">
1888	Invalid medium storage file location or could not find the medium
1889	at the specified location.
1890	</result>
1891	<result name="VBOX_E_IPRT_ERROR">
1892	Could not get medium storage format.
1893	</result>
1894	<result name="E_INVALIDARG">
1895	Invalid medium storage format.
1896	</result>
1897	<result name="VBOX_E_INVALID_OBJECT_STATE">
1898	Medium has already been added to a media registry.
1899	</result>
1900	</desc>
1901	<param name="location" type="wstring" dir="in">
1902	<desc>
1903	Location of the storage unit that contains medium data in one of
1904	the supported storage formats.
1905	</desc>
1906	</param>
1907	<param name="deviceType" type="DeviceType" dir="in">
1908	<desc>
1909	Must be one of "HardDisk", "DVD" or "Floppy".
1910	</desc>
1911	</param>
1912	<param name="accessMode" type="AccessMode" dir="in">
1913	<desc>Whether to open the image in read/write or read-only mode. For
1914	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1915	</param>
1916	<param name="medium" type="IMedium" dir="return">
1917	<desc>Opened medium object.</desc>
1918	</param>
1919	</method>
1920
1921	<method name="findMedium">
1922	<desc>
1923	Returns a medium of the given type that uses the given fully qualified
1924	location or UUID to store medium data.
1925
1926	The given medium must be known to this VirtualBox installation, i.e.
1927	it must be previously created by <link to="#createHardDisk"/> or opened
1928	by <link to="#openMedium"/>.
1929
1930	The search is done by comparing the value of the @a location argument to
1931	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1932	attributes of each known medium.
1933
1934	On case sensitive file systems, a case sensitive comparison is performed,
1935	otherwise the case of symbols in the file path is ignored.
1936
1937	<result name="VBOX_E_OBJECT_NOT_FOUND">
1938	No medium object matching @a location found.
1939	</result>
1940	</desc>
1941	<param name="location" type="wstring" dir="in">
1942	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1943	</param>
1944	<param name="type" type="DeviceType" dir="in">
1945	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1946	</param>
1947	<param name="medium" type="IMedium" dir="return">
1948	<desc>Medium object, if found.</desc>
1949	</param>
1950	</method>
1951
1952	<method name="getGuestOSType">
1953	<desc>
1954	Returns an object describing the specified guest OS type.
1955
1956	The requested guest OS type is specified using a string which is a
1957	mnemonic identifier of the guest operating system, such as
1958	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1959	particular virtual machine can be read or set using the
1960	<link to="IMachine::OSTypeId"/> attribute.
1961
1962	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1963	available guest OS type objects. Each object has an
1964	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1965	the guest OS this object describes.
1966
1967	<result name="E_INVALIDARG">
1968	@a id is not a valid Guest OS type.
1969	</result>
1970
1971	</desc>
1972	<param name="id" type="uuid" mod="string" dir="in">
1973	<desc>Guest OS type ID string.</desc>
1974	</param>
1975	<param name="type" type="IGuestOSType" dir="return">
1976	<desc>Guest OS type object.</desc>
1977	</param>
1978	</method>
1979
1980	<method name="createSharedFolder">
1981	<desc>
1982	Creates a new global shared folder by associating the given logical
1983	name with the given host path, adds it to the collection of shared
1984	folders and starts sharing it. Refer to the description of
1985	<link to="ISharedFolder"/> to read more about logical names.
1986	<note>
1987	In the current implementation, this operation is not
1988	implemented.
1989	</note>
1990	</desc>
1991	<param name="name" type="wstring" dir="in">
1992	<desc>Unique logical name of the shared folder.</desc>
1993	</param>
1994	<param name="hostPath" type="wstring" dir="in">
1995	<desc>Full path to the shared folder in the host file system.</desc>
1996	</param>
1997	<param name="writable" type="boolean" dir="in">
1998	<desc>Whether the share is writable or readonly</desc>
1999	</param>
2000	<param name="automount" type="boolean" dir="in">
2001	<desc>Whether the share gets automatically mounted by the guest
2002	or not.</desc>
2003	</param>
2004	</method>
2005
2006	<method name="removeSharedFolder">
2007	<desc>
2008	Removes the global shared folder with the given name previously
2009	created by <link to="#createSharedFolder"/> from the collection of
2010	shared folders and stops sharing it.
2011	<note>
2012	In the current implementation, this operation is not
2013	implemented.
2014	</note>
2015	</desc>
2016	<param name="name" type="wstring" dir="in">
2017	<desc>Logical name of the shared folder to remove.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="getExtraDataKeys">
2022	<desc>
2023	Returns an array representing the global extra data keys which currently
2024	have values defined.
2025	</desc>
2026	<param name="value" type="wstring" dir="return" safearray="yes">
2027	<desc>Array of extra data keys.</desc>
2028	</param>
2029	</method>
2030
2031	<method name="getExtraData">
2032	<desc>
2033	Returns associated global extra data.
2034
2035	If the requested data @a key does not exist, this function will
2036	succeed and return an empty string in the @a value argument.
2037
2038	<result name="VBOX_E_FILE_ERROR">
2039	Settings file not accessible.
2040	</result>
2041	<result name="VBOX_E_XML_ERROR">
2042	Could not parse the settings file.
2043	</result>
2044
2045	</desc>
2046	<param name="key" type="wstring" dir="in">
2047	<desc>Name of the data key to get.</desc>
2048	</param>
2049	<param name="value" type="wstring" dir="return">
2050	<desc>Value of the requested data key.</desc>
2051	</param>
2052	</method>
2053
2054	<method name="setExtraData">
2055	<desc>
2056	Sets associated global extra data.
2057
2058	If you pass @c null or empty string as a key @a value, the given @a key
2059	will be deleted.
2060
2061	<note>
2062	Before performing the actual data change, this method will ask all
2063	registered event listener using the
2064	<link to="IExtraDataCanChangeEvent"/>
2065	notification for a permission. If one of the listeners refuses the
2066	new value, the change will not be performed.
2067	</note>
2068	<note>
2069	On success, the
2070	<link to="IExtraDataChangedEvent"/> notification
2071	is called to inform all registered listeners about a successful data
2072	change.
2073	</note>
2074
2075	<result name="VBOX_E_FILE_ERROR">
2076	Settings file not accessible.
2077	</result>
2078	<result name="VBOX_E_XML_ERROR">
2079	Could not parse the settings file.
2080	</result>
2081	<result name="E_ACCESSDENIED">
2082	Modification request refused.
2083	</result>
2084
2085	</desc>
2086	<param name="key" type="wstring" dir="in">
2087	<desc>Name of the data key to set.</desc>
2088	</param>
2089	<param name="value" type="wstring" dir="in">
2090	<desc>Value to assign to the key.</desc>
2091	</param>
2092	</method>
2093
2094	<!--method name="createDHCPServerForInterface">
2095	<desc>
2096	Creates a dhcp server settings to be used for the given interface
2097	<result name="E_INVALIDARG">
2098	Host network interface @a name already exists.
2099	</result>
2100	</desc>
2101	<param name="interface" type="IHostNetworkInterface" dir="in">
2102	<desc>Network Interface</desc>
2103	</param>
2104	<param name="server" type="IDHCPServer" dir="out">
2105	<desc>Dhcp server settings</desc>
2106	</param>
2107	</method-->
2108
2109	<method name="createDHCPServer">
2110	<desc>
2111	Creates a dhcp server settings to be used for the given internal network name
2112	<result name="E_INVALIDARG">
2113	Host network interface @a name already exists.
2114	</result>
2115	</desc>
2116	<param name="name" type="wstring" dir="in">
2117	<desc>server name</desc>
2118	</param>
2119	<param name="server" type="IDHCPServer" dir="return">
2120	<desc>Dhcp server settings</desc>
2121	</param>
2122	</method>
2123
2124	<method name="findDHCPServerByNetworkName">
2125	<desc>
2126	Searches a dhcp server settings to be used for the given internal network name
2127	<result name="E_INVALIDARG">
2128	Host network interface @a name already exists.
2129	</result>
2130
2131	</desc>
2132	<param name="name" type="wstring" dir="in">
2133	<desc>server name</desc>
2134	</param>
2135	<param name="server" type="IDHCPServer" dir="return">
2136	<desc>Dhcp server settings</desc>
2137	</param>
2138	</method>
2139
2140	<!--method name="findDHCPServerForInterface">
2141	<desc>
2142	Searches a dhcp server settings to be used for the given interface
2143	<result name="E_INVALIDARG">
2144	Host network interface @a name already exists.
2145	</result>
2146	</desc>
2147	<param name="interface" type="IHostNetworkInterface" dir="in">
2148	<desc>Network Interface</desc>
2149	</param>
2150	<param name="server" type="IDHCPServer" dir="out">
2151	<desc>Dhcp server settings</desc>
2152	</param>
2153	</method-->
2154
2155	<method name="removeDHCPServer">
2156	<desc>
2157	Removes the dhcp server settings
2158	<result name="E_INVALIDARG">
2159	Host network interface @a name already exists.
2160	</result>
2161	</desc>
2162	<param name="server" type="IDHCPServer" dir="in">
2163	<desc>Dhcp server settings to be removed</desc>
2164	</param>
2165	</method>
2166
2167
2168	<method name="checkFirmwarePresent">
2169	<desc>
2170	Check if this VirtualBox installation has a firmware
2171	of the given type available, either system-wide or per-user.
2172	Optionally, this may return a hint where this firmware can be
2173	downloaded from.
2174	</desc>
2175	<param name="firmwareType" type="FirmwareType" dir="in">
2176	<desc>
2177	Type of firmware to check.
2178	</desc>
2179	</param>
2180	<param name="version" type="wstring" dir="in">
2181	<desc>Expected version number, usually empty string (presently ignored).</desc>
2182	</param>
2183
2184	<param name="url" type="wstring" dir="out">
2185	<desc>
2186	Suggested URL to download this firmware from.
2187	</desc>
2188	</param>
2189
2190	<param name="file" type="wstring" dir="out">
2191	<desc>
2192	Filename of firmware, only valid if result == TRUE.
2193	</desc>
2194	</param>
2195
2196	<param name="result" type="boolean" dir="return">
2197	<desc>If firmware of this type and version is available.</desc>
2198	</param>
2199	</method>
2200
2201	</interface>
2202
2203	<!--
2204	// IVFSExplorer
2205	/////////////////////////////////////////////////////////////////////////
2206	-->
2207
2208	<enum
2209	name="VFSType"
2210	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2211	>
2212	<desc>
2213	Virtual file systems supported by VFSExplorer.
2214	</desc>
2215
2216	<const name="File" value="1" />
2217	<const name="Cloud" value="2" />
2218	<const name="S3" value="3" />
2219	<const name="WebDav" value="4" />
2220	</enum>
2221
2222	<enum
2223	name="VFSFileType"
2224	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2225	>
2226	<desc>
2227	File types known by VFSExplorer.
2228	</desc>
2229
2230	<const name="Unknown" value="1" />
2231	<const name="Fifo" value="2" />
2232	<const name="DevChar" value="3" />
2233	<const name="Directory" value="4" />
2234	<const name="DevBlock" value="5" />
2235	<const name="File" value="6" />
2236	<const name="SymLink" value="7" />
2237	<const name="Socket" value="8" />
2238	<const name="WhiteOut" value="9" />
2239	</enum>
2240
2241	<interface
2242	name="IVFSExplorer" extends="$unknown"
2243	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2244	wsmap="managed"
2245	>
2246	<desc>
2247	The VFSExplorer interface unifies access to different file system
2248	types. This includes local file systems as well remote file systems like
2249	S3. For a list of supported types see <link to="VFSType" />.
2250	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2251	</desc>
2252
2253	<attribute name="path" type="wstring" readonly="yes">
2254	<desc>Returns the current path in the virtual file system.</desc>
2255	</attribute>
2256
2257	<attribute name="type" type="VFSType" readonly="yes">
2258	<desc>Returns the file system type which is currently in use.</desc>
2259	</attribute>
2260
2261	<method name="update">
2262	<desc>Updates the internal list of files/directories from the
2263	current directory level. Use <link to="#entryList" /> to get the full list
2264	after a call to this method.</desc>
2265
2266	<param name="aProgress" type="IProgress" dir="return">
2267	<desc>Progress object to track the operation completion.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="cd">
2272	<desc>Change the current directory level.</desc>
2273
2274	<param name="aDir" type="wstring" dir="in">
2275	<desc>The name of the directory to go in.</desc>
2276	</param>
2277
2278	<param name="aProgress" type="IProgress" dir="return">
2279	<desc>Progress object to track the operation completion.</desc>
2280	</param>
2281	</method>
2282
2283	<method name="cdUp">
2284	<desc>Go one directory upwards from the current directory level.</desc>
2285
2286	<param name="aProgress" type="IProgress" dir="return">
2287	<desc>Progress object to track the operation completion.</desc>
2288	</param>
2289	</method>
2290
2291	<method name="entryList">
2292	<desc>Returns a list of files/directories after a call to <link
2293	to="#update" />. The user is responsible for keeping this internal
2294	list up do date.</desc>
2295
2296	<param name="aNames" type="wstring" safearray="yes" dir="out">
2297	<desc>The list of names for the entries.</desc>
2298	</param>
2299
2300	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of types for the entries.</desc>
2302	</param>
2303
2304	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2305	<desc>The list of sizes (in bytes) for the entries.</desc>
2306	</param>
2307
2308	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2309	<desc>The list of file modes (in octal form) for the entries.</desc>
2310	</param>
2311	</method>
2312
2313	<method name="exists">
2314	<desc>Checks if the given file list exists in the current directory
2315	level.</desc>
2316
2317	<param name="aNames" type="wstring" safearray="yes" dir="in">
2318	<desc>The names to check.</desc>
2319	</param>
2320
2321	<param name="aExists" type="wstring" safearray="yes" dir="return">
2322	<desc>The names which exist.</desc>
2323	</param>
2324	</method>
2325
2326	<method name="remove">
2327	<desc>Deletes the given files in the current directory level.</desc>
2328
2329	<param name="aNames" type="wstring" safearray="yes" dir="in">
2330	<desc>The names to remove.</desc>
2331	</param>
2332
2333	<param name="aProgress" type="IProgress" dir="return">
2334	<desc>Progress object to track the operation completion.</desc>
2335	</param>
2336	</method>
2337
2338	</interface>
2339
2340	<!--
2341	// IAppliance
2342	/////////////////////////////////////////////////////////////////////////
2343	-->
2344
2345	<interface
2346	name="IAppliance" extends="$unknown"
2347	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2348	wsmap="managed"
2349	>
2350	<desc>
2351	Represents a platform-independent appliance in OVF format. An instance of this is returned
2352	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2353	virtual machines within an appliance with VirtualBox.
2354
2355	The OVF standard suggests two different physical file formats:
2356
2357	<ol>
2358	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2359	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2360	this descriptor file references other files such as disk images, as OVF appliances typically
2361	do, those additional files must be in the same directory as the descriptor file.</li>
2362
2363	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2364	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2365	files and optionally other files.
2366
2367	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2368	be added with a later version.</li>
2369	</ol>
2370
2371	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2372	<link to="IMachine" /> involves the following sequence of API calls:
2373
2374	<ol>
2375	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2376	</li>
2377
2378	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2379	would like to import. So long as this file is syntactically valid, this will succeed
2380	and fill the appliance object with the parsed data from the OVF file.
2381	</li>
2382
2383	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2384	contents of the IAppliance attributes accordingly. These can be inspected by a
2385	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2386	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2387	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2388	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2389	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2390	The GUI can then give the user the option to confirm and/or change these suggestions.
2391	</li>
2392
2393	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2394	virtual system (machine) to override the suggestions made by the interpret() routine.
2395	</li>
2396
2397	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2398	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2399	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2400	can be found in the <link to="#machines" /> array attribute.
2401	</li>
2402	</ol>
2403
2404	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2405
2406	<ol>
2407	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2408	an empty IAppliance object.
2409	</li>
2410
2411	<li>For each machine you would like to export, call <link to="IMachine::export" />
2412	with the IAppliance object you just created. Each such call creates one instance of
2413	<link to="IVirtualSystemDescription" /> inside the appliance.
2414	</li>
2415
2416	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2417	virtual system (machine) to override the suggestions made by the export() routine.
2418	</li>
2419
2420	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2421	file written.</li>
2422	</ol>
2423
2424	</desc>
2425
2426	<attribute name="path" type="wstring" readonly="yes">
2427	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2428	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2429	<link to="#write" /> (for export).
2430	This attribute is empty until one of these methods has been called.
2431	</desc>
2432	</attribute>
2433
2434	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2435	<desc>
2436	Array of virtual disk definitions. One such description exists for each
2437	disk definition in the OVF; each string array item represents one such piece of
2438	disk information, with the information fields separated by tab (\\t) characters.
2439
2440	The caller should be prepared for additional fields being appended to
2441	this string in future versions of VirtualBox and therefore check for
2442	the number of tabs in the strings returned.
2443
2444	In the current version, the following eight fields are returned per string
2445	in the array:
2446
2447	<ol>
2448	<li>Disk ID (unique string identifier given to disk)</li>
2449
2450	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2451
2452	<li>Populated size (optional unsigned integer indicating the current size of the
2453	disk; can be approximate; -1 if unspecified)</li>
2454
2455	<li>Format (string identifying the disk format, typically
2456	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2457
2458	<li>Reference (where to find the disk image, typically a file name; if empty,
2459	then the disk should be created on import)</li>
2460
2461	<li>Image size (optional unsigned integer indicating the size of the image,
2462	which need not necessarily be the same as the values specified above, since
2463	the image may be compressed or sparse; -1 if not specified)</li>
2464
2465	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2466	presently unsupported and always -1)</li>
2467
2468	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2469	</ol>
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2474	<desc> Array of virtual system descriptions. One such description is created
2475	for each virtual system (machine) found in the OVF.
2476	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2477	(for export) has been called.
2478	</desc>
2479	</attribute>
2480
2481	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2482	<desc>
2483	Contains the UUIDs of the machines created from the information in this appliances. This is only
2484	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2485	succeeded.
2486	</desc>
2487	</attribute>
2488
2489	<method name="read">
2490	<desc>
2491	Reads an OVF file into the appliance object.
2492
2493	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2494	mere fact that this method returns successfully does not mean that VirtualBox supports all
2495	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2496	</desc>
2497	<param name="file" type="wstring" dir="in">
2498	<desc>
2499	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2500	on whether the appliance is distributed as a set of files or as a single file, respectively).
2501	</desc>
2502	</param>
2503	<param name="aProgress" type="IProgress" dir="return">
2504	<desc>Progress object to track the operation completion.</desc>
2505	</param>
2506	</method>
2507
2508	<method name="interpret">
2509	<desc>
2510	Interprets the OVF data that was read when the appliance was constructed. After
2511	calling this method, one can inspect the
2512	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2513	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2514	the appliance.
2515
2516	Calling this method is the second step of importing an appliance into VirtualBox;
2517	see <link to="IAppliance" /> for an overview.
2518
2519	After calling this method, one should call <link to="#getWarnings" /> to find out
2520	if problems were encountered during the processing which might later lead to
2521	errors.
2522	</desc>
2523	</method>
2524
2525	<method name="importMachines">
2526	<desc>
2527	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2528	and other interfaces that match the information contained in the appliance as
2529	closely as possible, as represented by the import instructions in the
2530	<link to="#virtualSystemDescriptions" /> array.
2531
2532	Calling this method is the final step of importing an appliance into VirtualBox;
2533	see <link to="IAppliance" /> for an overview.
2534
2535	Since importing the appliance will most probably involve copying and converting
2536	disk images, which can take a long time, this method operates asynchronously and
2537	returns an IProgress object to allow the caller to monitor the progress.
2538
2539	After the import succeeded, the UUIDs of the IMachine instances created can be
2540	retrieved from the <link to="#machines" /> array attribute.
2541	</desc>
2542
2543	<param name="aProgress" type="IProgress" dir="return">
2544	<desc>Progress object to track the operation completion.</desc>
2545	</param>
2546	</method>
2547
2548	<method name="createVFSExplorer">
2549	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2550
2551	<param name="aUri" type="wstring" dir="in">
2552	<desc>The URI describing the file system to use.</desc>
2553	</param>
2554
2555	<param name="aExplorer" type="IVFSExplorer" dir="return">
2556	<desc></desc>
2557	</param>
2558	</method>
2559
2560	<method name="write">
2561	<desc>
2562	Writes the contents of the appliance exports into a new OVF file.
2563
2564	Calling this method is the final step of exporting an appliance from VirtualBox;
2565	see <link to="IAppliance" /> for an overview.
2566
2567	Since exporting the appliance will most probably involve copying and converting
2568	disk images, which can take a long time, this method operates asynchronously and
2569	returns an IProgress object to allow the caller to monitor the progress.
2570	</desc>
2571	<param name="format" type="wstring" dir="in">
2572	<desc>
2573	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2574	future versions of VirtualBox may support additional formats.
2575	</desc>
2576	</param>
2577	<param name="manifest" type="boolean" dir="in">
2578	<desc>
2579	Indicate if the optional manifest file (.mf) should be written. The manifest file
2580	is used for integrity checks prior import.
2581	</desc>
2582	</param>
2583	<param name="path" type="wstring" dir="in">
2584	<desc>
2585	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2586	on whether the appliance is distributed as a set of files or as a single file, respectively).
2587	</desc>
2588	</param>
2589	<param name="progress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="getWarnings">
2595	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2596
2597	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2598	<desc></desc>
2599	</param>
2600	</method>
2601
2602	</interface>
2603
2604	<enum
2605	name="VirtualSystemDescriptionType"
2606	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2607	>
2608	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2609	a configuration value.</desc>
2610
2611	<const name="Ignore" value="1" />
2612	<const name="OS" value="2" />
2613	<const name="Name" value="3" />
2614	<const name="Product" value="4" />
2615	<const name="Vendor" value="5" />
2616	<const name="Version" value="6" />
2617	<const name="ProductUrl" value="7" />
2618	<const name="VendorUrl" value="8" />
2619	<const name="Description" value="9" />
2620	<const name="License" value="10" />
2621	<const name="Miscellaneous" value="11" />
2622	<const name="CPU" value="12" />
2623	<const name="Memory" value="13" />
2624	<const name="HardDiskControllerIDE" value="14" />
2625	<const name="HardDiskControllerSATA" value="15" />
2626	<const name="HardDiskControllerSCSI" value="16" />
2627	<const name="HardDiskControllerSAS" value="17" />
2628	<const name="HardDiskImage" value="18" />
2629	<const name="Floppy" value="19" />
2630	<const name="CDROM" value="20" />
2631	<const name="NetworkAdapter" value="21" />
2632	<const name="USBController" value="22" />
2633	<const name="SoundCard" value="23" />
2634
2635	</enum>
2636
2637	<enum
2638	name="VirtualSystemDescriptionValueType"
2639	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2640	>
2641	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2642	type to fetch.</desc>
2643
2644	<const name="Reference" value="1" />
2645	<const name="Original" value="2" />
2646	<const name="Auto" value="3" />
2647	<const name="ExtraConfig" value="4" />
2648
2649	</enum>
2650
2651	<interface
2652	name="IVirtualSystemDescription" extends="$unknown"
2653	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2654	wsmap="managed"
2655	>
2656
2657	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2658	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2659	<link to="IAppliance::interpret" /> has been called, that array contains information
2660	about how the virtual systems described in the OVF should best be imported into
2661	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2662	import an OVF into VirtualBox.
2663	</desc>
2664
2665	<attribute name="count" type="unsigned long" readonly="yes">
2666	<desc>Return the number of virtual system description entries.</desc>
2667	</attribute>
2668
2669	<method name="getDescription">
2670	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2671	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2672
2673	The list below identifies the value sets that are possible depending on the
2674	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2675	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2676	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2677	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2678	the @a aExtraConfigValues[] array item may also be used.
2679
2680	<ul>
2681	<li>
2682	"OS": the guest operating system type. There must be exactly one such array item on import. The
2683	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2684	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2685	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2686	</li>
2687	<li>
2688	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2689	if none is present on import, then an automatic name will be created from the operating system
2690	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2691	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2692	<link to="IMachine" /> name that does not exist yet.
2693	</li>
2694	<li>
2695	"Description": an arbitrary description.
2696	</li>
2697	<li>
2698	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2699	code to display such a license for agreement; the Main API does not enforce any such policy.
2700	</li>
2701	<li>
2702	Miscellaneous: reserved for future use.
2703	</li>
2704	<li>
2705	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2706	</li>
2707	<li>
2708	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2709	is present on import, then VirtualBox will set a meaningful default based on the operating system
2710	type.
2711	</li>
2712	<li>
2713	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2714	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2715	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2716	writes into the OVF.
2717	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2718	type can use to specify which hard disk controller a virtual disk should be connected to.
2719	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2720	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2721	its virtual machines supports four channels (primary master, primary slave, secondary master,
2722	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2723	</li>
2724	<li>
2725	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2726	has no value in @a aOvfValues[] or @a aVBoxValues[].
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2731	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2732	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2733	whereas VirtualBox considers it a class of storage controllers of its own; see
2734	<link to="StorageControllerType" />).
2735	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2736	</li>
2737	<li>
2738	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2739	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2740
2741	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2742	a path since the image file should be in the same location as the OVF file itself), whereas the
2743	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2744	hard disk image. This means that on import the image will be copied and converted from the
2745	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2746
2747	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2748	format: "controller=<index>;channel=<c>"
2749	In this string, <index> must be an integer specifying the hard disk controller to connect
2750	the image to. That number must be the index of an array item with one of the hard disk controller
2751	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2752	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2753	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2754	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2755	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2756	</li>
2757	<li>
2758	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2759	attachment information as with "HardDiskImage" items.
2760	</li>
2761	<li>
2762	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2763	attachment information as with "HardDiskImage" items.
2764	</li>
2765	<li>
2766	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2767	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2768	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2769	</li>
2770	<li>
2771	"USBController": a USB controller. There can be at most one such item. If and only if such an
2772	item ispresent, USB support will be enabled for the new virtual machine.
2773	</li>
2774	<li>
2775	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2776	present, sound support will be enabled for the new virtual machine. Note that the virtual
2777	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2778	may be different from the virtual soundcard expected by the appliance.
2779	</li>
2780	</ul>
2781
2782	</desc>
2783
2784	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2797	<desc></desc>
2798	</param>
2799
2800	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2801	<desc></desc>
2802	</param>
2803
2804	</method>
2805
2806	<method name="getDescriptionByType">
2807	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2808	should be returned.</desc>
2809
2810	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2827	<desc></desc>
2828	</param>
2829
2830	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2831	<desc></desc>
2832	</param>
2833
2834	</method>
2835
2836	<method name="getValuesByType">
2837	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2838	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2839	values.</desc>
2840
2841	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2842	<desc></desc>
2843	</param>
2844
2845	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2846	<desc></desc>
2847	</param>
2848
2849	<param name="aValues" type="wstring" dir="return" safearray="yes">
2850	<desc></desc>
2851	</param>
2852
2853	</method>
2854
2855	<method name="setFinalValues">
2856	<desc>
2857	This method allows the appliance's user to change the configuration for the virtual
2858	system descriptions. For each array item returned from <link to="#getDescription" />,
2859	you must pass in one boolean value and one configuration value.
2860
2861	Each item in the boolean array determines whether the particular configuration item
2862	should be enabled.
2863	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2864	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2865	and SoundCard.
2866
2867	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2868	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2869	the configuration remains unchanged. Please see the documentation for getDescription()
2870	for valid configuration values for the individual array item types. If the
2871	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2872	</desc>
2873
2874	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877
2878	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2879	<desc></desc>
2880	</param>
2881
2882	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2883	<desc></desc>
2884	</param>
2885	</method>
2886
2887	<method name="addDescription">
2888	<desc>
2889	This method adds an additional description entry to the stack of already
2890	available descriptions for this virtual system. This is handy for writing
2891	values which aren't directly supported by VirtualBox. One example would
2892	be the License type of <link to="VirtualSystemDescriptionType" />.
2893	</desc>
2894
2895	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2896	<desc></desc>
2897	</param>
2898
2899	<param name="aVBoxValue" type="wstring" dir="in">
2900	<desc></desc>
2901	</param>
2902
2903	<param name="aExtraConfigValue" type="wstring" dir="in">
2904	<desc></desc>
2905	</param>
2906	</method>
2907	</interface>
2908
2909
2910	<!--
2911	// IMachine
2912	/////////////////////////////////////////////////////////////////////////
2913	-->
2914
2915	<interface
2916	name="IInternalMachineControl" extends="$unknown"
2917	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2918	internal="yes"
2919	wsmap="suppress"
2920	>
2921	<method name="setRemoveSavedStateFile">
2922	<desc>
2923	Updates the flag whether the saved state file is removed on a
2924	machine state change from Saved to PoweredOff.
2925	</desc>
2926	<param name="aRemove" type="boolean" dir="in"/>
2927	</method>
2928
2929	<method name="updateState">
2930	<desc>
2931	Updates the VM state.
2932	<note>
2933	This operation will also update the settings file with the correct
2934	information about the saved state file and delete this file from disk
2935	when appropriate.
2936	</note>
2937	</desc>
2938	<param name="state" type="MachineState" dir="in"/>
2939	</method>
2940
2941	<method name="getIPCId">
2942	<param name="id" type="wstring" dir="return"/>
2943	</method>
2944
2945	<method name="beginPowerUp">
2946	<desc>
2947	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2948	gives it the progress object that should be part of any pending
2949	<link to="IMachine::launchVMProcess"/> operations. The progress
2950	object may be called back to reflect an early cancelation, so some care
2951	have to be taken with respect to any cancelation callbacks. The console
2952	object will call <link to="IInternalMachineControl::endPowerUp"/>
2953	to signal the completion of the progress object.
2954	</desc>
2955	<param name="aProgress" type="IProgress" dir="in" />
2956	</method>
2957
2958	<method name="endPowerUp">
2959	<desc>
2960	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2961	This method may query status information from the progress object it
2962	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2963	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2964	call in order to complete that progress object.
2965	</desc>
2966	<param name="result" type="long" dir="in"/>
2967	</method>
2968
2969	<method name="beginPoweringDown">
2970	<desc>
2971	Called by the VM process to inform the server it wants to
2972	stop the VM execution and power down.
2973	</desc>
2974	<param name="progress" type="IProgress" dir="out">
2975	<desc>
2976	Progress object created by VBoxSVC to wait until
2977	the VM is powered down.
2978	</desc>
2979	</param>
2980	</method>
2981
2982	<method name="endPoweringDown">
2983	<desc>
2984	Called by the VM process to inform the server that powering
2985	down previously requested by #beginPoweringDown is either
2986	successfully finished or there was a failure.
2987
2988	<result name="VBOX_E_FILE_ERROR">
2989	Settings file not accessible.
2990	</result>
2991	<result name="VBOX_E_XML_ERROR">
2992	Could not parse the settings file.
2993	</result>
2994
2995	</desc>
2996
2997	<param name="result" type="long" dir="in">
2998	<desc>@c S_OK to indicate success.
2999	</desc>
3000	</param>
3001	<param name="errMsg" type="wstring" dir="in">
3002	<desc>@c human readable error message in case of failure.
3003	</desc>
3004	</param>
3005	</method>
3006
3007	<method name="runUSBDeviceFilters">
3008	<desc>
3009	Asks the server to run USB devices filters of the associated
3010	machine against the given USB device and tell if there is
3011	a match.
3012	<note>
3013	Intended to be used only for remote USB devices. Local
3014	ones don't require to call this method (this is done
3015	implicitly by the Host and USBProxyService).
3016	</note>
3017	</desc>
3018	<param name="device" type="IUSBDevice" dir="in"/>
3019	<param name="matched" type="boolean" dir="out"/>
3020	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3021	</method>
3022
3023	<method name="captureUSBDevice">
3024	<desc>
3025	Requests a capture of the given host USB device.
3026	When the request is completed, the VM process will
3027	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3028	notification.
3029	</desc>
3030	<param name="id" type="uuid" mod="string" dir="in"/>
3031	</method>
3032
3033	<method name="detachUSBDevice">
3034	<desc>
3035	Notification that a VM is going to detach (@a done = @c false) or has
3036	already detached (@a done = @c true) the given USB device.
3037	When the @a done = @c true request is completed, the VM process will
3038	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3039	notification.
3040	<note>
3041	In the @a done = @c true case, the server must run its own filters
3042	and filters of all VMs but this one on the detached device
3043	as if it were just attached to the host computer.
3044	</note>
3045	</desc>
3046	<param name="id" type="uuid" mod="string" dir="in"/>
3047	<param name="done" type="boolean" dir="in"/>
3048	</method>
3049
3050	<method name="autoCaptureUSBDevices">
3051	<desc>
3052	Requests a capture all matching USB devices attached to the host.
3053	When the request is completed, the VM process will
3054	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3055	notification per every captured device.
3056	</desc>
3057	</method>
3058
3059	<method name="detachAllUSBDevices">
3060	<desc>
3061	Notification that a VM that is being powered down. The done
3062	parameter indicates whether which stage of the power down
3063	we're at. When @a done = @c false the VM is announcing its
3064	intentions, while when @a done = @c true the VM is reporting
3065	what it has done.
3066	<note>
3067	In the @a done = @c true case, the server must run its own filters
3068	and filters of all VMs but this one on all detach devices as
3069	if they were just attached to the host computer.
3070	</note>
3071	</desc>
3072	<param name="done" type="boolean" dir="in"/>
3073	</method>
3074
3075	<method name="onSessionEnd">
3076	<desc>
3077	Triggered by the given session object when the session is about
3078	to close normally.
3079	</desc>
3080	<param name="session" type="ISession" dir="in">
3081	<desc>Session that is being closed</desc>
3082	</param>
3083	<param name="progress" type="IProgress" dir="return">
3084	<desc>
3085	Used to wait until the corresponding machine is actually
3086	dissociated from the given session on the server.
3087	Returned only when this session is a direct one.
3088	</desc>
3089	</param>
3090	</method>
3091
3092	<method name="beginSavingState">
3093	<desc>
3094	Called by the VM process to inform the server it wants to
3095	save the current state and stop the VM execution.
3096	</desc>
3097	<param name="progress" type="IProgress" dir="out">
3098	<desc>
3099	Progress object created by VBoxSVC to wait until
3100	the state is saved.
3101	</desc>
3102	</param>
3103	<param name="stateFilePath" type="wstring" dir="out">
3104	<desc>
3105	File path the VM process must save the execution state to.
3106	</desc>
3107	</param>
3108	</method>
3109
3110	<method name="endSavingState">
3111	<desc>
3112	Called by the VM process to inform the server that saving
3113	the state previously requested by #beginSavingState is either
3114	successfully finished or there was a failure.
3115
3116	<result name="VBOX_E_FILE_ERROR">
3117	Settings file not accessible.
3118	</result>
3119	<result name="VBOX_E_XML_ERROR">
3120	Could not parse the settings file.
3121	</result>
3122
3123	</desc>
3124
3125	<param name="result" type="long" dir="in">
3126	<desc>@c S_OK to indicate success.
3127	</desc>
3128	</param>
3129	<param name="errMsg" type="wstring" dir="in">
3130	<desc>@c human readable error message in case of failure.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="adoptSavedState">
3136	<desc>
3137	Gets called by IConsole::adoptSavedState.
3138	<result name="VBOX_E_FILE_ERROR">
3139	Invalid saved state file path.
3140	</result>
3141	</desc>
3142	<param name="savedStateFile" type="wstring" dir="in">
3143	<desc>Path to the saved state file to adopt.</desc>
3144	</param>
3145	</method>
3146
3147	<method name="beginTakingSnapshot">
3148	<desc>
3149	Called from the VM process to request from the server to perform the
3150	server-side actions of creating a snapshot (creating differencing images
3151	and the snapshot object).
3152
3153	<result name="VBOX_E_FILE_ERROR">
3154	Settings file not accessible.
3155	</result>
3156	<result name="VBOX_E_XML_ERROR">
3157	Could not parse the settings file.
3158	</result>
3159	</desc>
3160	<param name="initiator" type="IConsole" dir="in">
3161	<desc>The console object that initiated this call.</desc>
3162	</param>
3163	<param name="name" type="wstring" dir="in">
3164	<desc>Snapshot name.</desc>
3165	</param>
3166	<param name="description" type="wstring" dir="in">
3167	<desc>Snapshot description.</desc>
3168	</param>
3169	<param name="consoleProgress" type="IProgress" dir="in">
3170	<desc>
3171	Progress object created by the VM process tracking the
3172	snapshot's progress. This has the following sub-operations:
3173	<ul>
3174	<li>setting up (weight 1);</li>
3175	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3176	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3177	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3178	<li>finishing up (weight 1)</li>
3179	</ul>
3180	</desc>
3181	</param>
3182	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3183	<desc>
3184	Whether this is an online snapshot (i.e. the machine is running).
3185	</desc>
3186	</param>
3187	<param name="stateFilePath" type="wstring" dir="out">
3188	<desc>
3189	File path the VM process must save the execution state to.
3190	</desc>
3191	</param>
3192	</method>
3193
3194	<method name="endTakingSnapshot">
3195	<desc>
3196	Called by the VM process to inform the server that the snapshot
3197	previously requested by #beginTakingSnapshot is either
3198	successfully taken or there was a failure.
3199	</desc>
3200
3201	<param name="success" type="boolean" dir="in">
3202	<desc>@c true to indicate success and @c false otherwise</desc>
3203	</param>
3204	</method>
3205
3206	<method name="deleteSnapshot">
3207	<desc>
3208	Gets called by IConsole::deleteSnapshot.
3209	<result name="VBOX_E_INVALID_OBJECT_STATE">
3210	Snapshot has more than one child snapshot.
3211	</result>
3212	</desc>
3213	<param name="initiator" type="IConsole" dir="in">
3214	<desc>The console object that initiated this call.</desc>
3215	</param>
3216	<param name="id" type="uuid" mod="string" dir="in">
3217	<desc>UUID of the snapshot to delete.</desc>
3218	</param>
3219	<param name="machineState" type="MachineState" dir="out">
3220	<desc>New machine state after this operation is started.</desc>
3221	</param>
3222	<param name="progress" type="IProgress" dir="return">
3223	<desc>Progress object to track the operation completion.</desc>
3224	</param>
3225	</method>
3226
3227	<method name="finishOnlineMergeMedium">
3228	<desc>
3229	Gets called by IConsole::onlineMergeMedium.
3230	</desc>
3231	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3232	<desc>The medium attachment which needs to be cleaned up.</desc>
3233	</param>
3234	<param name="source" type="IMedium" dir="in">
3235	<desc>Merge source medium.</desc>
3236	</param>
3237	<param name="target" type="IMedium" dir="in">
3238	<desc>Merge target medium.</desc>
3239	</param>
3240	<param name="mergeForward" type="boolean" dir="in">
3241	<desc>Merge direction.</desc>
3242	</param>
3243	<param name="parentForTarget" type="IMedium" dir="in">
3244	<desc>For forward merges: new parent for target medium.</desc>
3245	</param>
3246	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3247	<desc>For backward merges: list of media which need their parent UUID
3248	updated.</desc>
3249	</param>
3250	</method>
3251
3252	<method name="restoreSnapshot">
3253	<desc>
3254	Gets called by IConsole::RestoreSnapshot.
3255	</desc>
3256	<param name="initiator" type="IConsole" dir="in">
3257	<desc>The console object that initiated this call.</desc>
3258	</param>
3259	<param name="snapshot" type="ISnapshot" dir="in">
3260	<desc>The snapshot to restore the VM state from.</desc>
3261	</param>
3262	<param name="machineState" type="MachineState" dir="out">
3263	<desc>New machine state after this operation is started.</desc>
3264	</param>
3265	<param name="progress" type="IProgress" dir="return">
3266	<desc>Progress object to track the operation completion.</desc>
3267	</param>
3268	</method>
3269
3270	<method name="pullGuestProperties">
3271	<desc>
3272	Get the list of the guest properties matching a set of patterns along
3273	with their values, time stamps and flags and give responsibility for
3274	managing properties to the console.
3275	</desc>
3276	<param name="name" type="wstring" dir="out" safearray="yes">
3277	<desc>
3278	The names of the properties returned.
3279	</desc>
3280	</param>
3281	<param name="value" type="wstring" dir="out" safearray="yes">
3282	<desc>
3283	The values of the properties returned. The array entries match the
3284	corresponding entries in the @a name array.
3285	</desc>
3286	</param>
3287	<param name="timestamp" type="long long" dir="out" safearray="yes">
3288	<desc>
3289	The time stamps of the properties returned. The array entries match
3290	the corresponding entries in the @a name array.
3291	</desc>
3292	</param>
3293	<param name="flags" type="wstring" dir="out" safearray="yes">
3294	<desc>
3295	The flags of the properties returned. The array entries match the
3296	corresponding entries in the @a name array.
3297	</desc>
3298	</param>
3299	</method>
3300
3301	<method name="pushGuestProperty">
3302	<desc>
3303	Update a single guest property in IMachine.
3304	</desc>
3305	<param name="name" type="wstring" dir="in">
3306	<desc>
3307	The name of the property to be updated.
3308	</desc>
3309	</param>
3310	<param name="value" type="wstring" dir="in">
3311	<desc>
3312	The value of the property.
3313	</desc>
3314	</param>
3315	<param name="timestamp" type="long long" dir="in">
3316	<desc>
3317	The timestamp of the property.
3318	</desc>
3319	</param>
3320	<param name="flags" type="wstring" dir="in">
3321	<desc>
3322	The flags of the property.
3323	</desc>
3324	</param>
3325	</method>
3326
3327	<method name="lockMedia">
3328	<desc>
3329	Locks all media attached to the machine for writing and parents of
3330	attached differencing media (if any) for reading. This operation is
3331	atomic so that if it fails no media is actually locked.
3332
3333	This method is intended to be called when the machine is in Starting or
3334	Restoring state. The locked media will be automatically unlocked when
3335	the machine is powered off or crashed.
3336	</desc>
3337	</method>
3338	<method name="unlockMedia">
3339	<desc>
3340	Unlocks all media previously locked using
3341	<link to="IInternalMachineControl::lockMedia"/>.
3342
3343	This method is intended to be used with teleportation so that it is
3344	possible to teleport between processes on the same machine.
3345	</desc>
3346	</method>
3347	</interface>
3348
3349	<interface
3350	name="IBIOSSettings" extends="$unknown"
3351	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3352	wsmap="managed"
3353	>
3354	<desc>
3355	The IBIOSSettings interface represents BIOS settings of the virtual
3356	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3357	</desc>
3358	<attribute name="logoFadeIn" type="boolean">
3359	<desc>Fade in flag for BIOS logo animation.</desc>
3360	</attribute>
3361
3362	<attribute name="logoFadeOut" type="boolean">
3363	<desc>Fade out flag for BIOS logo animation.</desc>
3364	</attribute>
3365
3366	<attribute name="logoDisplayTime" type="unsigned long">
3367	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3368	</attribute>
3369
3370	<attribute name="logoImagePath" type="wstring">
3371	<desc>
3372	Local file system path for external BIOS splash image. Empty string
3373	means the default image is shown on boot.
3374	</desc>
3375	</attribute>
3376
3377	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3378	<desc>Mode of the BIOS boot device menu.</desc>
3379	</attribute>
3380
3381	<attribute name="ACPIEnabled" type="boolean">
3382	<desc>ACPI support flag.</desc>
3383	</attribute>
3384
3385	<attribute name="IOAPICEnabled" type="boolean">
3386	<desc>
3387	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3388	and support IRQs above 15.
3389	</desc>
3390	</attribute>
3391
3392	<attribute name="timeOffset" type="long long">
3393	<desc>
3394	Offset in milliseconds from the host system time. This allows for
3395	guests running with a different system date/time than the host.
3396	It is equivalent to setting the system date/time in the BIOS except
3397	it is not an absolute value but a relative one. Guest Additions
3398	time synchronization honors this offset.
3399	</desc>
3400	</attribute>
3401
3402	<attribute name="PXEDebugEnabled" type="boolean">
3403	<desc>
3404	PXE debug logging flag. If set, VirtualBox will write extensive
3405	PXE trace information to the release log.
3406	</desc>
3407	</attribute>
3408
3409	</interface>
3410
3411	<enum
3412	name="CleanupMode"
3413	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3414	>
3415	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3416	</desc>
3417	<const name="UnregisterOnly" value="1">
3418	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3419	</const>
3420	<const name="DetachAllReturnNone" value="2">
3421	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3422	</const>
3423	<const name="DetachAllReturnHardDisksOnly" value="3">
3424	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3425	</const>
3426	<const name="Full" value="4">
3427	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3428	</const>
3429	</enum>
3430
3431	<interface
3432	name="IPciAddress" extends="$unknown"
3433	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3434	wsmap="struct"
3435	>
3436
3437	<desc>
3438	Address on the PCI bus.
3439	</desc>
3440
3441	<attribute name="bus" type="short">
3442	<desc>
3443	Bus number.
3444	</desc>
3445	</attribute>
3446
3447	<attribute name="device" type="short">
3448	<desc>
3449	Device number.
3450	</desc>
3451	</attribute>
3452
3453	<attribute name="devFunction" type="short">
3454	<desc>
3455	Device function number.
3456	</desc>
3457	</attribute>
3458
3459	<method name="asLong">
3460	<desc>
3461	Convert PCI address into long.
3462	</desc>
3463	<param name="result" type="long" dir="return" />
3464	</method>
3465
3466	<method name="fromLong">
3467	<desc>
3468	Make PCI address from long.
3469	</desc>
3470	<param name="number" type="long" dir="in" />
3471	</method>
3472	</interface>
3473
3474	<interface
3475	name="IPciDeviceAttachment" extends="$unknown"
3476	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3477	wsmap="struct"
3478	>
3479
3480	<desc>
3481	Information about PCI attachments.
3482	</desc>
3483
3484	<attribute name="name" type="wstring" readonly="yes">
3485	<desc>
3486	Device name.
3487	</desc>
3488	</attribute>
3489
3490	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3491	<desc>
3492	If this is physical or virtual device.
3493	</desc>
3494	</attribute>
3495
3496	<attribute name="hostAddress" type="long" readonly="yes">
3497	<desc>
3498	Address of device on the host, applicable only to host devices.
3499	</desc>
3500	</attribute>
3501
3502	<attribute name="guestAddress" type="long" readonly="yes">
3503	<desc>
3504	Address of device on the guest.
3505	</desc>
3506	</attribute>
3507
3508	</interface>
3509
3510
3511	<interface
3512	name="IMachine" extends="$unknown"
3513	uuid="59d09c78-2558-45c8-a95e-8761d70fdc95"
3514	wsmap="managed"
3515	>
3516	<desc>
3517	The IMachine interface represents a virtual machine, or guest, created
3518	in VirtualBox.
3519
3520	This interface is used in two contexts. First of all, a collection of
3521	objects implementing this interface is stored in the
3522	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3523	machines that are currently registered with this VirtualBox
3524	installation. Also, once a session has been opened for the given virtual
3525	machine (e.g. the virtual machine is running), the machine object
3526	associated with the open session can be queried from the session object;
3527	see <link to="ISession"/> for details.
3528
3529	The main role of this interface is to expose the settings of the virtual
3530	machine and provide methods to change various aspects of the virtual
3531	machine's configuration. For machine objects stored in the
3532	<link to="IVirtualBox::machines"/> collection, all attributes are
3533	read-only unless explicitly stated otherwise in individual attribute
3534	and method descriptions.
3535
3536	In order to change a machine setting, a session for this machine must be
3537	opened using one of the <link to="IMachine::lockMachine" /> or
3538	<link to="IMachine::launchVMProcess"/> methods. After the
3539	machine has been successfully locked for a session, a mutable machine object
3540	needs to be queried from the session object and then the desired settings
3541	changes can be applied to the returned object using IMachine attributes and
3542	methods. See the <link to="ISession"/> interface description for more
3543	information about sessions.
3544
3545	Note that IMachine does not provide methods to control virtual machine
3546	execution (such as start the machine, or power it down) -- these methods
3547	are grouped in a separate interface called <link to="IConsole" />.
3548
3549	<see>ISession, IConsole</see>
3550	</desc>
3551
3552	<attribute name="parent" type="IVirtualBox" readonly="yes">
3553	<desc>Associated parent object.</desc>
3554	</attribute>
3555
3556	<attribute name="accessible" type="boolean" readonly="yes">
3557	<desc>
3558	Whether this virtual machine is currently accessible or not.
3559
3560	A machine is always deemed accessible unless it is registered <i>and</i>
3561	its settings file cannot be read or parsed (either because the file itself
3562	is unavailable or has invalid XML contents).
3563
3564	Every time this property is read, the accessibility state of
3565	this machine is re-evaluated. If the returned value is @c false,
3566	the <link to="#accessError"/> property may be used to get the
3567	detailed error information describing the reason of
3568	inaccessibility, including XML error messages.
3569
3570	When the machine is inaccessible, only the following properties
3571	can be used on it:
3572	<ul>
3573	<li><link to="#parent"/></li>
3574	<li><link to="#id"/></li>
3575	<li><link to="#settingsFilePath"/></li>
3576	<li><link to="#accessible"/></li>
3577	<li><link to="#accessError"/></li>
3578	</ul>
3579
3580	An attempt to access any other property or method will return
3581	an error.
3582
3583	The only possible action you can perform on an inaccessible
3584	machine is to unregister it using the
3585	<link to="IMachine::unregister"/> call (or, to check
3586	for the accessibility state once more by querying this
3587	property).
3588
3589	<note>
3590	In the current implementation, once this property returns
3591	@c true, the machine will never become inaccessible
3592	later, even if its settings file cannot be successfully
3593	read/written any more (at least, until the VirtualBox
3594	server is restarted). This limitation may be removed in
3595	future releases.
3596	</note>
3597	</desc>
3598	</attribute>
3599
3600	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3601	<desc>
3602	Error information describing the reason of machine
3603	inaccessibility.
3604
3605	Reading this property is only valid after the last call to
3606	<link to="#accessible"/> returned @c false (i.e. the
3607	machine is currently inaccessible). Otherwise, a @c null
3608	IVirtualBoxErrorInfo object will be returned.
3609	</desc>
3610	</attribute>
3611
3612	<attribute name="name" type="wstring">
3613	<desc>
3614	Name of the virtual machine.
3615
3616	Besides being used for human-readable identification purposes
3617	everywhere in VirtualBox, the virtual machine name is also used
3618	as a name of the machine's settings file and as a name of the
3619	subdirectory this settings file resides in. Thus, every time you
3620	change the value of this property, the settings file will be
3621	renamed once you call <link to="#saveSettings"/> to confirm the
3622	change. The containing subdirectory will be also renamed, but
3623	only if it has exactly the same name as the settings file
3624	itself prior to changing this property (for backward compatibility
3625	with previous API releases). The above implies the following
3626	limitations:
3627	<ul>
3628	<li>The machine name cannot be empty.</li>
3629	<li>The machine name can contain only characters that are valid
3630	file name characters according to the rules of the file
3631	system used to store VirtualBox configuration.</li>
3632	<li>You cannot have two or more machines with the same name
3633	if they use the same subdirectory for storing the machine
3634	settings files.</li>
3635	<li>You cannot change the name of the machine if it is running,
3636	or if any file in the directory containing the settings file
3637	is being used by another running machine or by any other
3638	process in the host operating system at a time when
3639	<link to="#saveSettings"/> is called.
3640	</li>
3641	</ul>
3642	If any of the above limitations are hit, <link to="#saveSettings"/>
3643	will return an appropriate error message explaining the exact
3644	reason and the changes you made to this machine will not be saved.
3645
3646	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3647	file is recommended, but not enforced. (Previous versions always
3648	used a generic ".xml" extension.)
3649	</desc>
3650	</attribute>
3651
3652	<attribute name="description" type="wstring">
3653	<desc>
3654	Description of the virtual machine.
3655
3656	The description attribute can contain any text and is
3657	typically used to describe the hardware and software
3658	configuration of the virtual machine in detail (i.e. network
3659	settings, versions of the installed software and so on).
3660	</desc>
3661	</attribute>
3662
3663	<attribute name="id" type="uuid" mod="string" readonly="yes">
3664	<desc>UUID of the virtual machine.</desc>
3665	</attribute>
3666
3667	<attribute name="OSTypeId" type="wstring">
3668	<desc>
3669	User-defined identifier of the Guest OS type.
3670	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3671	an IGuestOSType object representing details about the given
3672	Guest OS type.
3673	<note>
3674	This value may differ from the value returned by
3675	<link to="IGuest::OSTypeId"/> if Guest Additions are
3676	installed to the guest OS.
3677	</note>
3678	</desc>
3679	</attribute>
3680
3681	<attribute name="HardwareVersion" type="wstring">
3682	<desc>Hardware version identifier. Internal use only for now.</desc>
3683	</attribute>
3684
3685	<attribute name="hardwareUUID" type="uuid" mod="string">
3686	<desc>
3687	The UUID presented to the guest via memory tables, hardware and guest
3688	properties. For most VMs this is the same as the @a id, but for VMs
3689	which have been cloned or teleported it may be the same as the source
3690	VM. This latter is because the guest shouldn't notice that it was
3691	cloned or teleported.
3692	</desc>
3693	</attribute>
3694
3695	<attribute name="CPUCount" type="unsigned long">
3696	<desc>Number of virtual CPUs in the VM.</desc>
3697	</attribute>
3698
3699	<attribute name="CPUHotPlugEnabled" type="boolean">
3700	<desc>
3701	This setting determines whether VirtualBox allows CPU
3702	hotplugging for this machine.</desc>
3703	</attribute>
3704
3705	<attribute name="CPUExecutionCap" type="unsigned long">
3706	<desc>
3707	Means to limit the number of CPU cycles a guest can use. The unit
3708	is percentage of host CPU cycles per second. The valid range
3709	is 1 - 100. 100 (the default) implies no limit.
3710	</desc>
3711	</attribute>
3712
3713	<attribute name="memorySize" type="unsigned long">
3714	<desc>System memory size in megabytes.</desc>
3715	</attribute>
3716
3717	<attribute name="memoryBalloonSize" type="unsigned long">
3718	<desc>Memory balloon size in megabytes.</desc>
3719	</attribute>
3720
3721	<attribute name="PageFusionEnabled" type="boolean">
3722	<desc>
3723	This setting determines whether VirtualBox allows page
3724	fusion for this machine (64 bits host only).
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="VRAMSize" type="unsigned long">
3729	<desc>Video memory size in megabytes.</desc>
3730	</attribute>
3731
3732	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3733	<desc>
3734	This setting determines whether VirtualBox allows this machine to make
3735	use of the 3D graphics support available on the host.</desc>
3736	</attribute>
3737
3738	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3739	<desc>
3740	This setting determines whether VirtualBox allows this machine to make
3741	use of the 2D video acceleration support available on the host.</desc>
3742	</attribute>
3743
3744	<attribute name="monitorCount" type="unsigned long">
3745	<desc>
3746	Number of virtual monitors.
3747	<note>
3748	Only effective on Windows XP and later guests with
3749	Guest Additions installed.
3750	</note>
3751	</desc>
3752	</attribute>
3753
3754	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3755	<desc>Object containing all BIOS settings.</desc>
3756	</attribute>
3757
3758	<attribute name="firmwareType" type="FirmwareType">
3759	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3760	bootstrap in this VM.</desc>
3761	</attribute>
3762
3763	<attribute name="pointingHidType" type="PointingHidType">
3764	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3765	The default is typically "PS2Mouse" but can vary depending on the
3766	requirements of the guest operating system.</desc>
3767	</attribute>
3768
3769	<attribute name="keyboardHidType" type="KeyboardHidType">
3770	<desc>Type of keyboard HID used in this VM.
3771	The default is typically "PS2Keyboard" but can vary depending on the
3772	requirements of the guest operating system.</desc>
3773	</attribute>
3774
3775	<attribute name="hpetEnabled" type="boolean">
3776	<desc>This attribute controls if High Precision Event Timer (HPET) is
3777	enabled in this VM. Use this property if you want to provide guests
3778	with additional time source, or if guest requires HPET to function correctly.
3779	Default is false.</desc>
3780	</attribute>
3781
3782	<attribute name="chipsetType" type="ChipsetType">
3783	<desc>Chipset type used in this VM.</desc>
3784	</attribute>
3785
3786	<attribute name="snapshotFolder" type="wstring">
3787	<desc>
3788	Full path to the directory used to store snapshot data
3789	(differencing media and saved state files) of this machine.
3790
3791	The initial value of this property is
3792	<tt><</tt><link to="#settingsFilePath">
3793	path_to_settings_file</link><tt>>/<</tt>
3794	<link to="#id">machine_uuid</link>
3795	<tt>></tt>.
3796
3797	Currently, it is an error to try to change this property on
3798	a machine that has snapshots (because this would require to
3799	move possibly large files to a different location).
3800	A separate method will be available for this purpose later.
3801
3802	<note>
3803	Setting this property to @c null or to an empty string will restore
3804	the initial value.
3805	</note>
3806	<note>
3807	When setting this property, the specified path can be
3808	absolute (full path) or relative to the directory where the
3809	<link to="#settingsFilePath">machine settings file</link>
3810	is located. When reading this property, a full path is
3811	always returned.
3812	</note>
3813	<note>
3814	The specified path may not exist, it will be created
3815	when necessary.
3816	</note>
3817	</desc>
3818	</attribute>
3819
3820	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3821	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3822	</attribute>
3823
3824	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3825	<desc>Array of media attached to this machine.</desc>
3826	</attribute>
3827
3828	<attribute name="USBController" type="IUSBController" readonly="yes">
3829	<desc>
3830	Associated USB controller object.
3831
3832	<note>
3833	If USB functionality is not available in the given edition of
3834	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3835	</note>
3836	</desc>
3837	</attribute>
3838
3839	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3840	<desc>Associated audio adapter, always present.</desc>
3841	</attribute>
3842
3843	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3844	<desc>Array of storage controllers attached to this machine.</desc>
3845	</attribute>
3846
3847	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3848	<desc>
3849	Full name of the file containing machine settings data.
3850	</desc>
3851	</attribute>
3852
3853	<attribute name="settingsModified" type="boolean" readonly="yes">
3854	<desc>
3855	Whether the settings of this machine have been modified
3856	(but neither yet saved nor discarded).
3857	<note>
3858	Reading this property is only valid on instances returned
3859	by <link to="ISession::machine"/> and on new machines
3860	created by <link to="IVirtualBox::createMachine"/> or opened
3861	by <link to="IVirtualBox::openMachine"/> but not
3862	yet registered, or on unregistered machines after calling
3863	<link to="IMachine::unregister"/>. For all other
3864	cases, the settings can never be modified.
3865	</note>
3866	<note>
3867	For newly created unregistered machines, the value of this
3868	property is always @c true until <link to="#saveSettings"/>
3869	is called (no matter if any machine settings have been
3870	changed after the creation or not). For opened machines
3871	the value is set to @c false (and then follows to normal rules).
3872	</note>
3873	</desc>
3874	</attribute>
3875
3876	<attribute name="sessionState" type="SessionState" readonly="yes">
3877	<desc>Current session state for this machine.</desc>
3878	</attribute>
3879
3880	<attribute name="sessionType" type="wstring" readonly="yes">
3881	<desc>
3882	Type of the session. If <link to="#sessionState"/> is
3883	Spawning or Locked, this attribute contains the
3884	same value as passed to the
3885	<link to="IMachine::launchVMProcess"/> method in the
3886	@a type parameter. If the session was used with
3887	<link to="IMachine::lockMachine" />, or if
3888	<link to="#sessionState"/> is SessionClosed, the value of this
3889	attribute is an empty string.
3890	</desc>
3891	</attribute>
3892
3893	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3894	<desc>
3895	Identifier of the session process. This attribute contains the
3896	platform-dependent identifier of the process whose session was
3897	used with <link to="IMachine::lockMachine" /> call. The returned
3898	value is only valid if <link to="#sessionState"/> is Locked or
3899	Unlocking by the time this property is read.
3900	</desc>
3901	</attribute>
3902
3903	<attribute name="state" type="MachineState" readonly="yes">
3904	<desc>Current execution state of this machine.</desc>
3905	</attribute>
3906
3907	<attribute name="lastStateChange" type="long long" readonly="yes">
3908	<desc>
3909	Time stamp of the last execution state change,
3910	in milliseconds since 1970-01-01 UTC.
3911	</desc>
3912	</attribute>
3913
3914	<attribute name="stateFilePath" type="wstring" readonly="yes">
3915	<desc>
3916	Full path to the file that stores the execution state of
3917	the machine when it is in the <link to="MachineState_Saved"/> state.
3918	<note>
3919	When the machine is not in the Saved state, this attribute is
3920	an empty string.
3921	</note>
3922	</desc>
3923	</attribute>
3924
3925	<attribute name="logFolder" type="wstring" readonly="yes">
3926	<desc>
3927	Full path to the folder that stores a set of rotated log files
3928	recorded during machine execution. The most recent log file is
3929	named <tt>VBox.log</tt>, the previous log file is
3930	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3931	in the current version).
3932	</desc>
3933	</attribute>
3934
3935	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3936	<desc>
3937	Current snapshot of this machine. This is @c null if the machine
3938	currently has no snapshots. If it is not @c null, then it was
3939	set by one of <link to="IConsole::takeSnapshot" />,
3940	<link to="IConsole::deleteSnapshot" />
3941	or <link to="IConsole::restoreSnapshot" />, depending on which
3942	was called last. See <link to="ISnapshot"/> for details.
3943	</desc>
3944	</attribute>
3945
3946	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3947	<desc>
3948	Number of snapshots taken on this machine. Zero means the
3949	machine doesn't have any snapshots.
3950	</desc>
3951	</attribute>
3952
3953	<attribute name="currentStateModified" type="boolean" readonly="yes">
3954	<desc>
3955	Returns @c true if the current state of the machine is not
3956	identical to the state stored in the current snapshot.
3957
3958	The current state is identical to the current snapshot only
3959	directly after one of the following calls are made:
3960
3961	<ul>
3962	<li><link to="IConsole::restoreSnapshot"/>
3963	</li>
3964	<li><link to="IConsole::takeSnapshot"/> (issued on a
3965	"powered off" or "saved" machine, for which
3966	<link to="#settingsModified"/> returns @c false)
3967	</li>
3968	</ul>
3969
3970	The current state remains identical until one of the following
3971	happens:
3972	<ul>
3973	<li>settings of the machine are changed</li>
3974	<li>the saved state is deleted</li>
3975	<li>the current snapshot is deleted</li>
3976	<li>an attempt to execute the machine is made</li>
3977	</ul>
3978
3979	<note>
3980	For machines that don't have snapshots, this property is
3981	always @c false.
3982	</note>
3983	</desc>
3984	</attribute>
3985
3986	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3987	<desc>
3988	Collection of shared folders for this machine (permanent shared
3989	folders). These folders are shared automatically at machine startup
3990	and available only to the guest OS installed within this machine.
3991
3992	New shared folders are added to the collection using
3993	<link to="#createSharedFolder"/>. Existing shared folders can be
3994	removed using <link to="#removeSharedFolder"/>.
3995	</desc>
3996	</attribute>
3997
3998	<attribute name="clipboardMode" type="ClipboardMode">
3999	<desc>
4000	Synchronization mode between the host OS clipboard
4001	and the guest OS clipboard.
4002	</desc>
4003	</attribute>
4004
4005	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4006	<desc>
4007	A comma-separated list of simple glob patterns. Changes to guest
4008	properties whose name matches one of the patterns will generate an
4009	<link to="IGuestPropertyChangedEvent"/> signal.
4010	</desc>
4011	</attribute>
4012
4013	<attribute name="teleporterEnabled" type="boolean">
4014	<desc>
4015	When set to @a true, the virtual machine becomes a target teleporter
4016	the next time it is powered on. This can only set to @a true when the
4017	VM is in the @a PoweredOff or @a Aborted state.
4018
4019	<!-- This property is automatically set to @a false when the VM is powered
4020	on. (bird: This doesn't work yet ) -->
4021	</desc>
4022	</attribute>
4023
4024	<attribute name="teleporterPort" type="unsigned long">
4025	<desc>
4026	The TCP port the target teleporter will listen for incoming
4027	teleportations on.
4028
4029	0 means the port is automatically selected upon power on. The actual
4030	value can be read from this property while the machine is waiting for
4031	incoming teleportations.
4032	</desc>
4033	</attribute>
4034
4035	<attribute name="teleporterAddress" type="wstring">
4036	<desc>
4037	The address the target teleporter will listen on. If set to an empty
4038	string, it will listen on all addresses.
4039	</desc>
4040	</attribute>
4041
4042	<attribute name="teleporterPassword" type="wstring">
4043	<desc>
4044	The password to check for on the target teleporter. This is just a
4045	very basic measure to prevent simple hacks and operators accidentally
4046	beaming a virtual machine to the wrong place.
4047	</desc>
4048	</attribute>
4049
4050	<attribute name="faultToleranceState" type="FaultToleranceState">
4051	<desc>
4052	Fault tolerance state; disabled, source or target.
4053	This property can be changed at any time. If you change it for a running
4054	VM, then the fault tolerance address and port must be set beforehand.
4055	</desc>
4056	</attribute>
4057
4058	<attribute name="faultTolerancePort" type="unsigned long">
4059	<desc>
4060	The TCP port the fault tolerance source or target will use for
4061	communication.
4062	</desc>
4063	</attribute>
4064
4065	<attribute name="faultToleranceAddress" type="wstring">
4066	<desc>
4067	The address the fault tolerance source or target.
4068	</desc>
4069	</attribute>
4070
4071	<attribute name="faultTolerancePassword" type="wstring">
4072	<desc>
4073	The password to check for on the standby VM. This is just a
4074	very basic measure to prevent simple hacks and operators accidentally
4075	choosing the wrong standby VM.
4076	</desc>
4077	</attribute>
4078
4079	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4080	<desc>
4081	The interval in ms used for syncing the state between source and target.
4082	</desc>
4083	</attribute>
4084
4085	<attribute name="RTCUseUTC" type="boolean">
4086	<desc>
4087	When set to @a true, the RTC device of the virtual machine will run
4088	in UTC time, otherwise in local time. Especially Unix guests prefer
4089	the time in UTC.
4090	</desc>
4091	</attribute>
4092
4093	<attribute name="ioCacheEnabled" type="boolean">
4094	<desc>
4095	When set to @a true, the builtin I/O cache of the virtual machine
4096	will be enabled.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="ioCacheSize" type="unsigned long">
4101	<desc>
4102	Maximum size of the I/O cache in MB.
4103	</desc>
4104	</attribute>
4105
4106	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4107	<desc>
4108	Bandwidth control manager.
4109	</desc>
4110	</attribute>
4111
4112	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4113	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4114	attached to the machine use IConsole::attachedPciDevices attribute, as
4115	this attribute is intended to list only devices additional to what
4116	described in virtual hardware config. Usually, this list keeps host's
4117	physical devices assigned to the particular machine.
4118	</desc>
4119	</attribute>
4120
4121	<method name="lockMachine">
4122	<desc>
4123	Locks the machine for the given session to enable the caller
4124	to make changes to the machine or start the VM or control
4125	VM execution.
4126
4127	There are two ways to lock a machine for such uses:
4128
4129	<ul>
4130	<li>If you want to make changes to the machine settings,
4131	you must obtain an exclusive write lock on the machine
4132	by setting @a lockType to @c Write.
4133
4134	This will only succeed if no other process has locked
4135	the machine to prevent conflicting changes. Only after
4136	an exclusive write lock has been obtained using this method, one
4137	can change all VM settings or execute the VM in the process
4138	space of the session object. (Note that the latter is only of
4139	interest if you actually want to write a new front-end for
4140	virtual machines; but this API gets called internally by
4141	the existing front-ends such as VBoxHeadless and the VirtualBox
4142	GUI to acquire a write lock on the machine that they are running.)
4143
4144	On success, write-locking the machine for a session creates
4145	a second copy of the IMachine object. It is this second object
4146	upon which changes can be made; in VirtualBox terminology, the
4147	second copy is "mutable". It is only this second, mutable machine
4148	object upon which you can call methods that change the
4149	machine state. After having called this method, you can
4150	obtain this second, mutable machine object using the
4151	<link to="ISession::machine" /> attribute.
4152	</li>
4153	<li>If you only want to check the machine state or control
4154	machine execution without actually changing machine
4155	settings (e.g. to get access to VM statistics or take
4156	a snapshot or save the machine state), then set the
4157	@a lockType argument to @c Shared.
4158
4159	If no other session has obtained a lock, you will obtain an
4160	exclusive write lock as described above. However, if another
4161	session has already obtained such a lock, then a link to that
4162	existing session will be established which allows you
4163	to control that existing session.
4164
4165	To find out which type of lock was obtained, you can
4166	inspect <link to="ISession::type" />, which will have been
4167	set to either @c WriteLock or @c Shared.
4168	</li>
4169	</ul>
4170
4171	In either case, you can get access to the <link to="IConsole" />
4172	object which controls VM execution.
4173
4174	Also in all of the above cases, one must always call
4175	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4176	the machine's state will eventually be set to "Aborted".
4177
4178	To change settings on a machine, the following sequence is typically
4179	performed:
4180
4181	<ol>
4182	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4183
4184	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4185
4186	<li>Change the settings of the machine by invoking IMachine methods.</li>
4187
4188	<li>Call <link to="IMachine::saveSettings" />.</li>
4189
4190	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4191	</ol>
4192
4193	<result name="E_UNEXPECTED">
4194	Virtual machine not registered.
4195	</result>
4196	<result name="E_ACCESSDENIED">
4197	Process not started by OpenRemoteSession.
4198	</result>
4199	<result name="VBOX_E_INVALID_OBJECT_STATE">
4200	Session already open or being opened.
4201	</result>
4202	<result name="VBOX_E_VM_ERROR">
4203	Failed to assign machine to session.
4204	</result>
4205	</desc>
4206	<param name="session" type="ISession" dir="in">
4207	<desc>
4208	Session object for which the machine will be locked.
4209	</desc>
4210	</param>
4211	<param name="lockType" type="LockType" dir="in">
4212	<desc>
4213	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4214	If set to @c Shared, then either acquire an exclusive write lock or establish
4215	a link to an existing session.
4216	</desc>
4217	</param>
4218	</method>
4219
4220	<method name="launchVMProcess">
4221	<desc>
4222	Spawns a new process that will execute the virtual machine and obtains a shared
4223	lock on the machine for the calling session.
4224
4225	If launching the VM succeeds, the new VM process will create its own session
4226	and write-lock the machine for it, preventing conflicting changes from other
4227	processes. If the machine is already locked (because it is already running or
4228	because another session has a write lock), launching the VM process will therefore
4229	fail. Reversely, future attempts to obtain a write lock will also fail while the
4230	machine is running.
4231
4232	The caller's session object remains separate from the session opened by the new
4233	VM process. It receives its own <link to="IConsole" /> object which can be used
4234	to control machine execution, but it cannot be used to change all VM settings
4235	which would be available after a <link to="#lockMachine" /> call.
4236
4237	The caller must eventually release the session's shared lock by calling
4238	<link to="ISession::unlockMachine" /> on the local session object once this call
4239	has returned. However, the session's state (see <link to="ISession::state" />)
4240	will not return to "Unlocked" until the remote session has also unlocked
4241	the machine (i.e. the machine has stopped running).
4242
4243	Launching a VM process can take some time (a new VM is started in a new process,
4244	for which memory and other resources need to be set up). Because of this,
4245	an <link to="IProgress" /> object is returned to allow the caller to wait
4246	for this asynchronous operation to be completed. Until then, the caller's
4247	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4248	and <link to="ISession::console" /> attributes cannot be accessed.
4249	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4250	similar calls to wait for completion. Completion is signalled when the VM
4251	is powered on. If launching the VM fails, error messages can be queried
4252	via the progress object, if available.
4253
4254	The progress object will have at least 2 sub-operations. The first
4255	operation covers the period up to the new VM process calls powerUp.
4256	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4257	progress object. Because <link to="IConsole::powerUp"/> may require
4258	some extra sub-operations, the <link to="IProgress::operationCount"/>
4259	may change at the completion of operation.
4260
4261	For details on the teleportation progress operation, see
4262	<link to="IConsole::powerUp"/>.
4263
4264	The @a environment argument is a string containing definitions of
4265	environment variables in the following format:
4266	@code
4267	NAME[=VALUE]\n
4268	NAME[=VALUE]\n
4269	...
4270	@endcode
4271	where <tt>\\n</tt> is the new line character. These environment
4272	variables will be appended to the environment of the VirtualBox server
4273	process. If an environment variable exists both in the server process
4274	and in this list, the value from this list takes precedence over the
4275	server's variable. If the value of the environment variable is
4276	omitted, this variable will be removed from the resulting environment.
4277	If the environment string is @c null or empty, the server environment
4278	is inherited by the started process as is.
4279
4280	<result name="E_UNEXPECTED">
4281	Virtual machine not registered.
4282	</result>
4283	<result name="E_INVALIDARG">
4284	Invalid session type @a type.
4285	</result>
4286	<result name="VBOX_E_OBJECT_NOT_FOUND">
4287	No machine matching @a machineId found.
4288	</result>
4289	<result name="VBOX_E_INVALID_OBJECT_STATE">
4290	Session already open or being opened.
4291	</result>
4292	<result name="VBOX_E_IPRT_ERROR">
4293	Launching process for machine failed.
4294	</result>
4295	<result name="VBOX_E_VM_ERROR">
4296	Failed to assign machine to session.
4297	</result>
4298	</desc>
4299	<param name="session" type="ISession" dir="in">
4300	<desc>
4301	Client session object to which the VM process will be connected (this
4302	must be in "Unlocked" state).
4303	</desc>
4304	</param>
4305	<param name="type" type="wstring" dir="in">
4306	<desc>
4307	Front-end to use for the new VM process. The following are currently supported:
4308	<ul>
4309	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4310	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4311	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4312	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4313	the currently running VM or session owner. In this case the
4314	@a session parameter may be @c NULL (if it is non-null it isn't
4315	used in any way), and the @a progress return value will be always
4316	NULL. The operation completes immediately.</li>
4317	</ul>
4318	</desc>
4319	</param>
4320	<param name="environment" type="wstring" dir="in">
4321	<desc>
4322	Environment to pass to the VM process.
4323	</desc>
4324	</param>
4325	<param name="progress" type="IProgress" dir="return">
4326	<desc>Progress object to track the operation completion.</desc>
4327	</param>
4328	</method>
4329
4330	<method name="setBootOrder">
4331	<desc>
4332	Puts the given device to the specified position in
4333	the boot order.
4334
4335	To indicate that no device is associated with the given position,
4336	<link to="DeviceType_Null"/> should be used.
4337
4338	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4339
4340	<result name="E_INVALIDARG">
4341	Boot @a position out of range.
4342	</result>
4343	<result name="E_NOTIMPL">
4344	Booting from USB @a device currently not supported.
4345	</result>
4346
4347	</desc>
4348	<param name="position" type="unsigned long" dir="in">
4349	<desc>
4350	Position in the boot order (@c 1 to the total number of
4351	devices the machine can boot from, as returned by
4352	<link to="ISystemProperties::maxBootPosition"/>).
4353	</desc>
4354	</param>
4355	<param name="device" type="DeviceType" dir="in">
4356	<desc>
4357	The type of the device used to boot at the given position.
4358	</desc>
4359	</param>
4360	</method>
4361
4362	<method name="getBootOrder" const="yes">
4363	<desc>
4364	Returns the device type that occupies the specified
4365	position in the boot order.
4366
4367	@todo [remove?]
4368	If the machine can have more than one device of the returned type
4369	(such as hard disks), then a separate method should be used to
4370	retrieve the individual device that occupies the given position.
4371
4372	If here are no devices at the given position, then
4373	<link to="DeviceType_Null"/> is returned.
4374
4375	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4376
4377	<result name="E_INVALIDARG">
4378	Boot @a position out of range.
4379	</result>
4380
4381	</desc>
4382	<param name="position" type="unsigned long" dir="in">
4383	<desc>
4384	Position in the boot order (@c 1 to the total number of
4385	devices the machine can boot from, as returned by
4386	<link to="ISystemProperties::maxBootPosition"/>).
4387	</desc>
4388	</param>
4389	<param name="device" type="DeviceType" dir="return">
4390	<desc>
4391	Device at the given position.
4392	</desc>
4393	</param>
4394	</method>
4395
4396	<method name="attachDevice">
4397	<desc>
4398	Attaches a device and optionally mounts a medium to the given storage
4399	controller (<link to="IStorageController" />, identified by @a name),
4400	at the indicated port and device.
4401
4402	This method is intended for managing storage devices in general while a
4403	machine is powered off. It can be used to attach and detach fixed
4404	and removable media. The following kind of media can be attached
4405	to a machine:
4406
4407	<ul>
4408	<li>For fixed and removable media, you can pass in a medium that was
4409	previously opened using <link to="IVirtualBox::openMedium" />.
4410	</li>
4411
4412	<li>Only for storage devices supporting removable media (such as
4413	DVDs and floppies), you can also specify a null pointer to
4414	indicate an empty drive or one of the medium objects listed
4415	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4416	arrays to indicate a host drive.
4417	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4418	to change the media while the machine is running.
4419	</li>
4420	</ul>
4421
4422	In a VM's default configuration of virtual machines, the secondary
4423	master of the IDE controller is used for a CD/DVD drive.
4424
4425	After calling this returns successfully, a new instance of
4426	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4427	attachments (see <link to="IMachine::mediumAttachments"/>).
4428
4429	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4430	information about attaching media.
4431
4432	The specified device slot must not have a device attached to it,
4433	or this method will fail.
4434
4435	<note>
4436	You cannot attach a device to a newly created machine until
4437	this machine's settings are saved to disk using
4438	<link to="#saveSettings"/>.
4439	</note>
4440	<note>
4441	If the medium is being attached indirectly, a new differencing medium
4442	will implicitly be created for it and attached instead. If the
4443	changes made to the machine settings (including this indirect
4444	attachment) are later cancelled using <link to="#discardSettings"/>,
4445	this implicitly created differencing medium will implicitly
4446	be deleted.
4447	</note>
4448
4449	<result name="E_INVALIDARG">
4450	SATA device, SATA port, IDE port or IDE slot out of range, or
4451	file or UUID not found.
4452	</result>
4453	<result name="VBOX_E_INVALID_OBJECT_STATE">
4454	Machine must be registered before media can be attached.
4455	</result>
4456	<result name="VBOX_E_INVALID_VM_STATE">
4457	Invalid machine state.
4458	</result>
4459	<result name="VBOX_E_OBJECT_IN_USE">
4460	A medium is already attached to this or another virtual machine.
4461	</result>
4462
4463	</desc>
4464	<param name="name" type="wstring" dir="in">
4465	<desc>Name of the storage controller to attach the device to.</desc>
4466	</param>
4467	<param name="controllerPort" type="long" dir="in">
4468	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4469	the primary controller and 1 specifies the secondary controller.
4470	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4471	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4472	</param>
4473	<param name="device" type="long" dir="in">
4474	<desc>Device slot in the given port to attach the device to. This is only
4475	relevant for IDE controllers, for which 0 specifies the master device and
4476	1 specifies the slave device. For all other controller types, this must
4477	be 0.</desc>
4478	</param>
4479	<param name="type" type="DeviceType" dir="in">
4480	<desc>Device type of the attached device. For media opened by
4481	<link to="IVirtualBox::openMedium" />, this must match the device type
4482	specified there.</desc>
4483	</param>
4484	<param name="medium" type="IMedium" dir="in">
4485	<desc>Medium to mount or NULL for an empty drive.</desc>
4486	</param>
4487	</method>
4488
4489	<method name="detachDevice">
4490	<desc>
4491	Detaches the device attached to a device slot of the specified bus.
4492
4493	Detaching the device from the virtual machine is deferred. This means
4494	that the medium remains associated with the machine when this method
4495	returns and gets actually de-associated only after a successful
4496	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4497	for more detailed information about attaching media.
4498
4499	<note>
4500	You cannot detach a device from a running machine.
4501	</note>
4502	<note>
4503	Detaching differencing media implicitly created by <link
4504	to="#attachDevice"/> for the indirect attachment using this
4505	method will <b>not</b> implicitly delete them. The
4506	<link to="IMedium::deleteStorage"/> operation should be
4507	explicitly performed by the caller after the medium is successfully
4508	detached and the settings are saved with
4509	<link to="#saveSettings"/>, if it is the desired action.
4510	</note>
4511
4512	<result name="VBOX_E_INVALID_VM_STATE">
4513	Attempt to detach medium from a running virtual machine.
4514	</result>
4515	<result name="VBOX_E_OBJECT_NOT_FOUND">
4516	No medium attached to given slot/bus.
4517	</result>
4518	<result name="VBOX_E_NOT_SUPPORTED">
4519	Medium format does not support storage deletion.
4520	</result>
4521
4522	</desc>
4523	<param name="name" type="wstring" dir="in">
4524	<desc>Name of the storage controller to detach the medium from.</desc>
4525	</param>
4526	<param name="controllerPort" type="long" dir="in">
4527	<desc>Port number to detach the medium from.</desc>
4528	</param>
4529	<param name="device" type="long" dir="in">
4530	<desc>Device slot number to detach the medium from.</desc>
4531	</param>
4532	</method>
4533
4534	<method name="passthroughDevice">
4535	<desc>
4536	Sets the passthrough mode of an existing DVD device. Changing the
4537	setting while the VM is running is forbidden. The setting is only used
4538	if at VM start the device is configured as a host DVD drive, in all
4539	other cases it is ignored. The device must already exist; see
4540	<link to="IMachine::attachDevice"/> for how to attach a new device.
4541
4542	The @a controllerPort and @a device parameters specify the device slot and
4543	have have the same meaning as with <link to="IMachine::attachDevice" />.
4544
4545	<result name="E_INVALIDARG">
4546	SATA device, SATA port, IDE port or IDE slot out of range.
4547	</result>
4548	<result name="VBOX_E_INVALID_OBJECT_STATE">
4549	Attempt to modify an unregistered virtual machine.
4550	</result>
4551	<result name="VBOX_E_INVALID_VM_STATE">
4552	Invalid machine state.
4553	</result>
4554
4555	</desc>
4556	<param name="name" type="wstring" dir="in">
4557	<desc>Name of the storage controller.</desc>
4558	</param>
4559	<param name="controllerPort" type="long" dir="in">
4560	<desc>Storage controller port.</desc>
4561	</param>
4562	<param name="device" type="long" dir="in">
4563	<desc>Device slot in the given port.</desc>
4564	</param>
4565	<param name="passthrough" type="boolean" dir="in">
4566	<desc>New value for the passthrough setting.</desc>
4567	</param>
4568	</method>
4569
4570	<method name="setBandwidthGroupForDevice">
4571	<desc>
4572	Sets the bandwidth group of an existing storage device.
4573	The device must already exist; see <link to="IMachine::attachDevice"/>
4574	for how to attach a new device.
4575
4576	The @a controllerPort and @a device parameters specify the device slot and
4577	have have the same meaning as with <link to="IMachine::attachDevice" />.
4578
4579	<result name="E_INVALIDARG">
4580	SATA device, SATA port, IDE port or IDE slot out of range.
4581	</result>
4582	<result name="VBOX_E_INVALID_OBJECT_STATE">
4583	Attempt to modify an unregistered virtual machine.
4584	</result>
4585	<result name="VBOX_E_INVALID_VM_STATE">
4586	Invalid machine state.
4587	</result>
4588
4589	</desc>
4590	<param name="name" type="wstring" dir="in">
4591	<desc>Name of the storage controller.</desc>
4592	</param>
4593	<param name="controllerPort" type="long" dir="in">
4594	<desc>Storage controller port.</desc>
4595	</param>
4596	<param name="device" type="long" dir="in">
4597	<desc>Device slot in the given port.</desc>
4598	</param>
4599	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4600	<desc>New value for the bandwidth group or NULL for no group.</desc>
4601	</param>
4602	</method>
4603
4604	<method name="mountMedium">
4605	<desc>
4606	Mounts a medium (<link to="IMedium" />, identified
4607	by the given UUID @a id) to the given storage controller
4608	(<link to="IStorageController" />, identified by @a name),
4609	at the indicated port and device. The device must already exist;
4610	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4611
4612	This method is intended only for managing removable media, where the
4613	device is fixed but media is changeable at runtime (such as DVDs
4614	and floppies). It cannot be used for fixed media such as hard disks.
4615
4616	The @a controllerPort and @a device parameters specify the device slot and
4617	have have the same meaning as with <link to="IMachine::attachDevice" />.
4618
4619	The specified device slot can have a medium mounted, which will be
4620	unmounted first. Specifying a zero UUID (or an empty string) for
4621	@a medium does just an unmount.
4622
4623	See <link to="IMedium"/> for more detailed information about
4624	attaching media.
4625
4626	<result name="E_INVALIDARG">
4627	SATA device, SATA port, IDE port or IDE slot out of range.
4628	</result>
4629	<result name="VBOX_E_INVALID_OBJECT_STATE">
4630	Attempt to attach medium to an unregistered virtual machine.
4631	</result>
4632	<result name="VBOX_E_INVALID_VM_STATE">
4633	Invalid machine state.
4634	</result>
4635	<result name="VBOX_E_OBJECT_IN_USE">
4636	Medium already attached to this or another virtual machine.
4637	</result>
4638
4639	</desc>
4640	<param name="name" type="wstring" dir="in">
4641	<desc>Name of the storage controller to attach the medium to.</desc>
4642	</param>
4643	<param name="controllerPort" type="long" dir="in">
4644	<desc>Port to attach the medium to.</desc>
4645	</param>
4646	<param name="device" type="long" dir="in">
4647	<desc>Device slot in the given port to attach the medium to.</desc>
4648	</param>
4649	<param name="medium" type="IMedium" dir="in">
4650	<desc>Medium to mount or NULL for an empty drive.</desc>
4651	</param>
4652	<param name="force" type="boolean" dir="in">
4653	<desc>Allows to force unmount/mount of a medium which is locked by
4654	the device slot in the given port to attach the medium to.</desc>
4655	</param>
4656	</method>
4657
4658	<method name="getMedium" const="yes">
4659	<desc>
4660	Returns the virtual medium attached to a device slot of the specified
4661	bus.
4662
4663	Note that if the medium was indirectly attached by
4664	<link to="#mountMedium"/> to the given device slot then this
4665	method will return not the same object as passed to the
4666	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4667	more detailed information about mounting a medium.
4668
4669	<result name="VBOX_E_OBJECT_NOT_FOUND">
4670	No medium attached to given slot/bus.
4671	</result>
4672
4673	</desc>
4674	<param name="name" type="wstring" dir="in">
4675	<desc>Name of the storage controller the medium is attached to.</desc>
4676	</param>
4677	<param name="controllerPort" type="long" dir="in">
4678	<desc>Port to query.</desc>
4679	</param>
4680	<param name="device" type="long" dir="in">
4681	<desc>Device slot in the given port to query.</desc>
4682	</param>
4683	<param name="medium" type="IMedium" dir="return">
4684	<desc>Attached medium object.</desc>
4685	</param>
4686	</method>
4687
4688	<method name="getMediumAttachmentsOfController" const="yes">
4689	<desc>
4690	Returns an array of medium attachments which are attached to the
4691	the controller with the given name.
4692
4693	<result name="VBOX_E_OBJECT_NOT_FOUND">
4694	A storage controller with given name doesn't exist.
4695	</result>
4696	</desc>
4697	<param name="name" type="wstring" dir="in"/>
4698	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4699	</method>
4700
4701	<method name="getMediumAttachment" const="yes">
4702	<desc>
4703	Returns a medium attachment which corresponds to the controller with
4704	the given name, on the given port and device slot.
4705
4706	<result name="VBOX_E_OBJECT_NOT_FOUND">
4707	No attachment exists for the given controller/port/device combination.
4708	</result>
4709	</desc>
4710	<param name="name" type="wstring" dir="in"/>
4711	<param name="controllerPort" type="long" dir="in"/>
4712	<param name="device" type="long" dir="in"/>
4713	<param name="attachment" type="IMediumAttachment" dir="return"/>
4714	</method>
4715
4716	<method name="attachHostPciDevice">
4717	<desc>
4718	Attaches host PCI device with the given (host) PCI address to the
4719	PCI bus of the virtual machine. Please note, that this operation
4720	is two phase, as real attachment will happen when VM will start,
4721	and most information will be delivered as IHostPciDevicePlugEvent
4722	on IVirtualBox event source.
4723
4724	<see>IHostPciDevicePlugEvent</see>
4725
4726	<result name="VBOX_E_INVALID_VM_STATE">
4727	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4728	</result>
4729	<result name="VBOX_E_PDM_ERROR">
4730	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4731	</result>
4732	<result name="VBOX_E_NOT_SUPPORTED">
4733	Hardware or host OS doesn't allow PCI device passthrought.
4734	</result>
4735	</desc>
4736	<param name="hostAddress" type="long" dir="in">
4737	<desc>Address of the host PCI device.</desc>
4738	</param>
4739	<param name="desiredGuestAddress" type="long" dir="in">
4740	<desc>Desired position of this device on guest PCI bus.</desc>
4741	</param>
4742	<param name="tryToUnbind" type="boolean" dir="in">
4743	<desc>If VMM shall try to unbind existing drivers from the
4744	device before attaching it to the guest.</desc>
4745	</param>
4746	</method>
4747
4748	<method name="detachHostPciDevice">
4749	<desc>
4750	Detach host PCI device from the virtual machine.
4751	Also HostPciDevicePlugEvent on IVirtualBox event source
4752	will be delivered. As currently we don't support hot device
4753	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4754
4755	<see>IHostPciDevicePlugEvent</see>
4756
4757	<result name="VBOX_E_INVALID_VM_STATE">
4758	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4759	</result>
4760	<result name="VBOX_E_OBJECT_NOT_FOUND">
4761	This host device is not attached to this machine.
4762	</result>
4763	<result name="VBOX_E_PDM_ERROR">
4764	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4765	</result>
4766	<result name="VBOX_E_NOT_SUPPORTED">
4767	Hardware or host OS doesn't allow PCI device passthrought.
4768	</result>
4769	</desc>
4770	<param name="hostAddress" type="long" dir="in">
4771	<desc>Address of the host PCI device.</desc>
4772	</param>
4773	</method>
4774
4775	<method name="getNetworkAdapter" const="yes">
4776	<desc>
4777	Returns the network adapter associated with the given slot.
4778	Slots are numbered sequentially, starting with zero. The total
4779	number of adapters per machine is defined by the
4780	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4781	so the maximum slot number is one less than that property's value.
4782
4783	<result name="E_INVALIDARG">
4784	Invalid @a slot number.
4785	</result>
4786
4787	</desc>
4788	<param name="slot" type="unsigned long" dir="in"/>
4789	<param name="adapter" type="INetworkAdapter" dir="return"/>
4790	</method>
4791
4792	<method name="addStorageController">
4793	<desc>
4794	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4795	machine and returns it as an instance of
4796	<link to="IStorageController" />.
4797
4798	@a name identifies the controller for subsequent calls such as
4799	<link to="#getStorageControllerByName" />,
4800	<link to="#getStorageControllerByInstance" />,
4801	<link to="#removeStorageController" />,
4802	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4803
4804	After the controller has been added, you can set its exact
4805	type by setting the <link to="IStorageController::controllerType" />.
4806
4807	<result name="VBOX_E_OBJECT_IN_USE">
4808	A storage controller with given name exists already.
4809	</result>
4810	<result name="E_INVALIDARG">
4811	Invalid @a controllerType.
4812	</result>
4813	</desc>
4814	<param name="name" type="wstring" dir="in"/>
4815	<param name="connectionType" type="StorageBus" dir="in"/>
4816	<param name="controller" type="IStorageController" dir="return"/>
4817	</method>
4818
4819	<method name="getStorageControllerByName" const="yes">
4820	<desc>
4821	Returns a storage controller with the given name.
4822
4823	<result name="VBOX_E_OBJECT_NOT_FOUND">
4824	A storage controller with given name doesn't exist.
4825	</result>
4826	</desc>
4827	<param name="name" type="wstring" dir="in"/>
4828	<param name="storageController" type="IStorageController" dir="return"/>
4829	</method>
4830
4831	<method name="getStorageControllerByInstance" const="yes">
4832	<desc>
4833	Returns a storage controller with the given instance number.
4834
4835	<result name="VBOX_E_OBJECT_NOT_FOUND">
4836	A storage controller with given instance number doesn't exist.
4837	</result>
4838	</desc>
4839	<param name="instance" type="unsigned long" dir="in"/>
4840	<param name="storageController" type="IStorageController" dir="return"/>
4841	</method>
4842
4843	<method name="removeStorageController">
4844	<desc>
4845	Removes a storage controller from the machine.
4846
4847	<result name="VBOX_E_OBJECT_NOT_FOUND">
4848	A storage controller with given name doesn't exist.
4849	</result>
4850	</desc>
4851	<param name="name" type="wstring" dir="in"/>
4852	</method>
4853
4854	<method name="setStorageControllerBootable">
4855	<desc>
4856	Sets the bootable flag of the storage controller with the given name.
4857
4858	<result name="VBOX_E_OBJECT_NOT_FOUND">
4859	A storage controller with given name doesn't exist.
4860	</result>
4861	<result name="VBOX_E_OBJECT_IN_USE">
4862	Another storage controller is marked as bootable already.
4863	</result>
4864	</desc>
4865	<param name="name" type="wstring" dir="in"/>
4866	<param name="bootable" type="boolean" dir="in"/>
4867	</method>
4868
4869	<method name="getSerialPort" const="yes">
4870	<desc>
4871	Returns the serial port associated with the given slot.
4872	Slots are numbered sequentially, starting with zero. The total
4873	number of serial ports per machine is defined by the
4874	<link to="ISystemProperties::serialPortCount"/> property,
4875	so the maximum slot number is one less than that property's value.
4876
4877	<result name="E_INVALIDARG">
4878	Invalid @a slot number.
4879	</result>
4880
4881	</desc>
4882	<param name="slot" type="unsigned long" dir="in"/>
4883	<param name="port" type="ISerialPort" dir="return"/>
4884	</method>
4885
4886	<method name="getParallelPort" const="yes">
4887	<desc>
4888	Returns the parallel port associated with the given slot.
4889	Slots are numbered sequentially, starting with zero. The total
4890	number of parallel ports per machine is defined by the
4891	<link to="ISystemProperties::parallelPortCount"/> property,
4892	so the maximum slot number is one less than that property's value.
4893
4894	<result name="E_INVALIDARG">
4895	Invalid @a slot number.
4896	</result>
4897
4898	</desc>
4899	<param name="slot" type="unsigned long" dir="in"/>
4900	<param name="port" type="IParallelPort" dir="return"/>
4901	</method>
4902
4903	<method name="getExtraDataKeys">
4904	<desc>
4905	Returns an array representing the machine-specific extra data keys
4906	which currently have values defined.
4907	</desc>
4908	<param name="value" type="wstring" dir="return" safearray="yes">
4909	<desc>Array of extra data keys.</desc>
4910	</param>
4911	</method>
4912
4913	<method name="getExtraData">
4914	<desc>
4915	Returns associated machine-specific extra data.
4916
4917	If the requested data @a key does not exist, this function will
4918	succeed and return an empty string in the @a value argument.
4919
4920	<result name="VBOX_E_FILE_ERROR">
4921	Settings file not accessible.
4922	</result>
4923	<result name="VBOX_E_XML_ERROR">
4924	Could not parse the settings file.
4925	</result>
4926
4927	</desc>
4928	<param name="key" type="wstring" dir="in">
4929	<desc>Name of the data key to get.</desc>
4930	</param>
4931	<param name="value" type="wstring" dir="return">
4932	<desc>Value of the requested data key.</desc>
4933	</param>
4934	</method>
4935
4936	<method name="setExtraData">
4937	<desc>
4938	Sets associated machine-specific extra data.
4939
4940	If you pass @c null or an empty string as a key @a value, the given
4941	@a key will be deleted.
4942
4943	<note>
4944	Before performing the actual data change, this method will ask all
4945	registered listeners using the
4946	<link to="IExtraDataCanChangeEvent"/>
4947	notification for a permission. If one of the listeners refuses the
4948	new value, the change will not be performed.
4949	</note>
4950	<note>
4951	On success, the
4952	<link to="IExtraDataChangedEvent"/> notification
4953	is called to inform all registered listeners about a successful data
4954	change.
4955	</note>
4956	<note>
4957	This method can be called outside the machine session and therefore
4958	it's a caller's responsibility to handle possible race conditions
4959	when several clients change the same key at the same time.
4960	</note>
4961
4962	<result name="VBOX_E_FILE_ERROR">
4963	Settings file not accessible.
4964	</result>
4965	<result name="VBOX_E_XML_ERROR">
4966	Could not parse the settings file.
4967	</result>
4968
4969	</desc>
4970	<param name="key" type="wstring" dir="in">
4971	<desc>Name of the data key to set.</desc>
4972	</param>
4973	<param name="value" type="wstring" dir="in">
4974	<desc>Value to assign to the key.</desc>
4975	</param>
4976	</method>
4977
4978	<method name="getCPUProperty" const="yes">
4979	<desc>
4980	Returns the virtual CPU boolean value of the specified property.
4981
4982	<result name="E_INVALIDARG">
4983	Invalid property.
4984	</result>
4985
4986	</desc>
4987	<param name="property" type="CPUPropertyType" dir="in">
4988	<desc>
4989	Property type to query.
4990	</desc>
4991	</param>
4992	<param name="value" type="boolean" dir="return">
4993	<desc>
4994	Property value.
4995	</desc>
4996	</param>
4997	</method>
4998
4999	<method name="setCPUProperty">
5000	<desc>
5001	Sets the virtual CPU boolean value of the specified property.
5002
5003	<result name="E_INVALIDARG">
5004	Invalid property.
5005	</result>
5006
5007	</desc>
5008	<param name="property" type="CPUPropertyType" dir="in">
5009	<desc>
5010	Property type to query.
5011	</desc>
5012	</param>
5013	<param name="value" type="boolean" dir="in">
5014	<desc>
5015	Property value.
5016	</desc>
5017	</param>
5018	</method>
5019
5020	<method name="getCPUIDLeaf" const="yes">
5021	<desc>
5022	Returns the virtual CPU cpuid information for the specified leaf.
5023
5024	Currently supported index values for cpuid:
5025	Standard CPUID leafs: 0 - 0xA
5026	Extended CPUID leafs: 0x80000000 - 0x8000000A
5027
5028	See the Intel and AMD programmer's manuals for detailed information
5029	about the cpuid instruction and its leafs.
5030	<result name="E_INVALIDARG">
5031	Invalid id.
5032	</result>
5033
5034	</desc>
5035	<param name="id" type="unsigned long" dir="in">
5036	<desc>
5037	CPUID leaf index.
5038	</desc>
5039	</param>
5040	<param name="valEax" type="unsigned long" dir="out">
5041	<desc>
5042	CPUID leaf value for register eax.
5043	</desc>
5044	</param>
5045	<param name="valEbx" type="unsigned long" dir="out">
5046	<desc>
5047	CPUID leaf value for register ebx.
5048	</desc>
5049	</param>
5050	<param name="valEcx" type="unsigned long" dir="out">
5051	<desc>
5052	CPUID leaf value for register ecx.
5053	</desc>
5054	</param>
5055	<param name="valEdx" type="unsigned long" dir="out">
5056	<desc>
5057	CPUID leaf value for register edx.
5058	</desc>
5059	</param>
5060	</method>
5061
5062	<method name="setCPUIDLeaf">
5063	<desc>
5064	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5065	are not passed unmodified. VirtualBox clears features that it doesn't support.
5066
5067	Currently supported index values for cpuid:
5068	Standard CPUID leafs: 0 - 0xA
5069	Extended CPUID leafs: 0x80000000 - 0x8000000A
5070
5071	See the Intel and AMD programmer's manuals for detailed information
5072	about the cpuid instruction and its leafs.
5073
5074	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5075	random crashes inside VMs.
5076	<result name="E_INVALIDARG">
5077	Invalid id.
5078	</result>
5079
5080	</desc>
5081	<param name="id" type="unsigned long" dir="in">
5082	<desc>
5083	CPUID leaf index.
5084	</desc>
5085	</param>
5086	<param name="valEax" type="unsigned long" dir="in">
5087	<desc>
5088	CPUID leaf value for register eax.
5089	</desc>
5090	</param>
5091	<param name="valEbx" type="unsigned long" dir="in">
5092	<desc>
5093	CPUID leaf value for register ebx.
5094	</desc>
5095	</param>
5096	<param name="valEcx" type="unsigned long" dir="in">
5097	<desc>
5098	CPUID leaf value for register ecx.
5099	</desc>
5100	</param>
5101	<param name="valEdx" type="unsigned long" dir="in">
5102	<desc>
5103	CPUID leaf value for register edx.
5104	</desc>
5105	</param>
5106	</method>
5107
5108	<method name="removeCPUIDLeaf">
5109	<desc>
5110	Removes the virtual CPU cpuid leaf for the specified index
5111
5112	<result name="E_INVALIDARG">
5113	Invalid id.
5114	</result>
5115
5116	</desc>
5117	<param name="id" type="unsigned long" dir="in">
5118	<desc>
5119	CPUID leaf index.
5120	</desc>
5121	</param>
5122	</method>
5123
5124	<method name="removeAllCPUIDLeaves">
5125	<desc>
5126	Removes all the virtual CPU cpuid leaves
5127	</desc>
5128	</method>
5129
5130	<method name="getHWVirtExProperty" const="yes">
5131	<desc>
5132	Returns the value of the specified hardware virtualization boolean property.
5133
5134	<result name="E_INVALIDARG">
5135	Invalid property.
5136	</result>
5137
5138	</desc>
5139	<param name="property" type="HWVirtExPropertyType" dir="in">
5140	<desc>
5141	Property type to query.
5142	</desc>
5143	</param>
5144	<param name="value" type="boolean" dir="return">
5145	<desc>
5146	Property value.
5147	</desc>
5148	</param>
5149	</method>
5150
5151	<method name="setHWVirtExProperty">
5152	<desc>
5153	Sets a new value for the specified hardware virtualization boolean property.
5154
5155	<result name="E_INVALIDARG">
5156	Invalid property.
5157	</result>
5158
5159	</desc>
5160	<param name="property" type="HWVirtExPropertyType" dir="in">
5161	<desc>
5162	Property type to set.
5163	</desc>
5164	</param>
5165	<param name="value" type="boolean" dir="in">
5166	<desc>
5167	New property value.
5168	</desc>
5169	</param>
5170	</method>
5171
5172	<method name="saveSettings">
5173	<desc>
5174	Saves any changes to machine settings made since the session
5175	has been opened or a new machine has been created, or since the
5176	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5177	For registered machines, new settings become visible to all
5178	other VirtualBox clients after successful invocation of this
5179	method.
5180	<note>
5181	The method sends <link to="IMachineDataChangedEvent"/>
5182	notification event after the configuration has been successfully
5183	saved (only for registered machines).
5184	</note>
5185	<note>
5186	Calling this method is only valid on instances returned
5187	by <link to="ISession::machine"/> and on new machines
5188	created by <link to="IVirtualBox::createMachine"/> but not
5189	yet registered, or on unregistered machines after calling
5190	<link to="IMachine::unregister"/>.
5191	</note>
5192
5193	<result name="VBOX_E_FILE_ERROR">
5194	Settings file not accessible.
5195	</result>
5196	<result name="VBOX_E_XML_ERROR">
5197	Could not parse the settings file.
5198	</result>
5199	<result name="E_ACCESSDENIED">
5200	Modification request refused.
5201	</result>
5202
5203	</desc>
5204	</method>
5205
5206	<method name="discardSettings">
5207	<desc>
5208	Discards any changes to the machine settings made since the session
5209	has been opened or since the last call to <link to="#saveSettings"/>
5210	or <link to="#discardSettings"/>.
5211	<note>
5212	Calling this method is only valid on instances returned
5213	by <link to="ISession::machine"/> and on new machines
5214	created by <link to="IVirtualBox::createMachine"/> or
5215	opened by <link to="IVirtualBox::openMachine"/> but not
5216	yet registered, or on unregistered machines after calling
5217	<link to="IMachine::unregister"/>.
5218	</note>
5219
5220	<result name="VBOX_E_INVALID_VM_STATE">
5221	Virtual machine is not mutable.
5222	</result>
5223
5224	</desc>
5225	</method>
5226
5227	<method name="unregister">
5228	<desc>
5229	Unregisters a machine previously registered with
5230	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5231	cleanup before the machine is unregistered.
5232
5233	This method does not delete any files. It only changes the machine configuration and
5234	the list of registered machines in the VirtualBox object. To delete the files which
5235	belonged to the machine, including the XML file of the machine itself, call
5236	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5237	from this method.
5238
5239	How thoroughly this method cleans up the machine configuration before unregistering
5240	the machine depends on the @a cleanupMode argument.
5241
5242	<ul>
5243	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5244	cleanup will be performed. The call will fail if the machine is in "Saved" state
5245	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5246	It is the responsibility of the caller to delete all such configuration in this mode.
5247	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5248	which it replaces.</li>
5249	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5250	state or if it has snapshots or media attached. All media attached to the current machine
5251	state or in snapshots will be detached. No medium objects will be returned;
5252	all of the machine's media will remain open.</li>
5253	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5254	except that all the hard disk medium objects which were detached from the machine will
5255	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5256	API for closing and deletion.</li>
5257	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5258	that all media will be returned in the array, including removable media like DVDs and
5259	floppies. This might be useful if the user wants to inspect in detail which media were
5260	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5261	in that case because users will typically want to preserve ISO and RAW image files.</li>
5262	</ul>
5263
5264	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5265	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5266	deleted with all its saved states and hard disk images, but images for removable
5267	drives (such as ISO and RAW files) will remain on disk.
5268
5269	This API does not verify whether the media files returned in the array are still
5270	attached to other machines (i.e. shared between several machines). If such a shared
5271	image is passed to <link to="#delete" /> however, closing the image will fail there
5272	and the image will be silently skipped.
5273
5274	This API may, however, move media from this machine's media registry to other media
5275	registries (see <link to="IMedium" /> for details on media registries). For machines
5276	created with VirtualBox 4.0 or later, if media from this machine's media registry
5277	are also attached to another machine (shared attachments), each such medium will be
5278	moved to another machine's registry. This is because without this machine's media
5279	registry, the other machine cannot find its media any more and would become inaccessible.
5280
5281	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5282	before unregistering it. It may also silently call saveSettings() on other machines
5283	if media are moved to other machines' media registries.
5284
5285	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5286	is fired.
5287
5288	The call will fail if the machine is currently locked (see <link to="ISession" />).
5289
5290	<note>
5291	If the given machine is inaccessible (see <link to="#accessible"/>), it
5292	will be unregistered and fully uninitialized right afterwards. As a result,
5293	the returned machine object will be unusable and an attempt to call
5294	<b>any</b> method will return the "Object not ready" error.
5295	</note>
5296
5297	<result name="VBOX_E_INVALID_OBJECT_STATE">
5298	Machine is currently locked for a session.
5299	</result>
5300	</desc>
5301
5302	<param name="cleanupMode" type="CleanupMode" dir="in">
5303	<desc>How to clean up after the machine has been unregistered.</desc>
5304	</param>
5305	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5306	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5307	</param>
5308	</method>
5309
5310	<method name="delete">
5311	<desc>
5312	Deletes the files associated with this machine from disk. If medium objects are passed
5313	in with the @a aMedia argument, they are closed and, if closing was successful, their
5314	storage files are deleted as well. For convenience, this array of media files can be
5315	the same as the one returned from a previous <link to="#unregister" /> call.
5316
5317	This method must only be called on machines which are either write-locked (i.e. on instances
5318	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5319	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5320	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5321
5322	The following files will be deleted by this method:
5323	<ul>
5324	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5325	argument other than "UnregisterOnly", this will delete all saved state files that
5326	the machine had in use; possibly one if the machine was in "Saved" state and one
5327	for each online snapshot that the machine had.</li>
5328	<li>On each medium object passed in the @a aMedia array, this will call
5329	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5330	medium's storage on disk. Since the close() call will fail if the medium is still
5331	in use, e.g. because it is still attached to a second machine; in that case the
5332	storage will not be deleted.</li>
5333	<li>Finally, the machine's own XML file will be deleted.</li>
5334	</ul>
5335
5336	Since deleting large disk image files can be a time-consuming I/O operation, this
5337	method operates asynchronously and returns an IProgress object to allow the caller
5338	to monitor the progress. There will be one sub-operation for each file that is
5339	being deleted (saved state or medium storage file).
5340
5341	<note>
5342	<link to="#settingsModified"/> will return @c true after this
5343	method successfully returns.
5344	</note>
5345
5346	<result name="VBOX_E_INVALID_VM_STATE">
5347	Machine is registered but not write-locked.
5348	</result>
5349	<result name="VBOX_E_IPRT_ERROR">
5350	Could not delete the settings file.
5351	</result>
5352	</desc>
5353	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5354	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5355	</param>
5356	<param name="aProgress" type="IProgress" dir="return">
5357	<desc>Progress object to track the operation completion.</desc>
5358	</param>
5359	</method>
5360
5361	<method name="export">
5362	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5363	steps required to export VirtualBox machines to OVF.
5364	</desc>
5365
5366	<param name="aAppliance" type="IAppliance" dir="in">
5367	<desc>Appliance to export this machine to.</desc>
5368	</param>
5369	<param name="location" type="wstring" dir="in">
5370	<desc>The target location.</desc>
5371	</param>
5372	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5373	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5374	</param>
5375	</method >
5376
5377	<method name="findSnapshot">
5378	<desc>
5379	Returns a snapshot of this machine with the given name or UUID.
5380
5381	Returns a snapshot of this machine with the given UUID.
5382	A @c null argument can be used to obtain the first snapshot
5383	taken on this machine. To traverse the whole tree of snapshots
5384	starting from the root, inspect the root snapshot's
5385	<link to="ISnapshot::children" /> attribute and recurse over those children.
5386
5387	<result name="VBOX_E_OBJECT_NOT_FOUND">
5388	Virtual machine has no snapshots or snapshot not found.
5389	</result>
5390
5391	</desc>
5392	<param name="nameOrId" type="wstring" dir="in">
5393	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5394	</param>
5395	<param name="snapshot" type="ISnapshot" dir="return">
5396	<desc>Snapshot object with the given name.</desc>
5397	</param>
5398	</method>
5399
5400	<method name="createSharedFolder">
5401	<desc>
5402	Creates a new permanent shared folder by associating the given logical
5403	name with the given host path, adds it to the collection of shared
5404	folders and starts sharing it. Refer to the description of
5405	<link to="ISharedFolder"/> to read more about logical names.
5406
5407	<result name="VBOX_E_OBJECT_IN_USE">
5408	Shared folder already exists.
5409	</result>
5410	<result name="VBOX_E_FILE_ERROR">
5411	Shared folder @a hostPath not accessible.
5412	</result>
5413
5414	</desc>
5415	<param name="name" type="wstring" dir="in">
5416	<desc>Unique logical name of the shared folder.</desc>
5417	</param>
5418	<param name="hostPath" type="wstring" dir="in">
5419	<desc>Full path to the shared folder in the host file system.</desc>
5420	</param>
5421	<param name="writable" type="boolean" dir="in">
5422	<desc>Whether the share is writable or readonly.</desc>
5423	</param>
5424	<param name="automount" type="boolean" dir="in">
5425	<desc>Whether the share gets automatically mounted by the guest
5426	or not.</desc>
5427	</param>
5428	</method>
5429
5430	<method name="removeSharedFolder">
5431	<desc>
5432	Removes the permanent shared folder with the given name previously
5433	created by <link to="#createSharedFolder"/> from the collection of
5434	shared folders and stops sharing it.
5435
5436	<result name="VBOX_E_INVALID_VM_STATE">
5437	Virtual machine is not mutable.
5438	</result>
5439	<result name="VBOX_E_OBJECT_NOT_FOUND">
5440	Shared folder @a name does not exist.
5441	</result>
5442
5443	</desc>
5444	<param name="name" type="wstring" dir="in">
5445	<desc>Logical name of the shared folder to remove.</desc>
5446	</param>
5447	</method>
5448
5449	<method name="canShowConsoleWindow">
5450	<desc>
5451	Returns @c true if the VM console process can activate the
5452	console window and bring it to foreground on the desktop of
5453	the host PC.
5454	<note>
5455	This method will fail if a session for this machine is not
5456	currently open.
5457	</note>
5458
5459	<result name="VBOX_E_INVALID_VM_STATE">
5460	Machine session is not open.
5461	</result>
5462
5463	</desc>
5464	<param name="canShow" type="boolean" dir="return">
5465	<desc>
5466	@c true if the console window can be shown and @c false otherwise.
5467	</desc>
5468	</param>
5469	</method>
5470
5471	<method name="showConsoleWindow">
5472	<desc>
5473	Activates the console window and brings it to foreground on
5474	the desktop of the host PC. Many modern window managers on
5475	many platforms implement some sort of focus stealing
5476	prevention logic, so that it may be impossible to activate
5477	a window without the help of the currently active
5478	application. In this case, this method will return a non-zero
5479	identifier that represents the top-level window of the VM
5480	console process. The caller, if it represents a currently
5481	active process, is responsible to use this identifier (in a
5482	platform-dependent manner) to perform actual window
5483	activation.
5484	<note>
5485	This method will fail if a session for this machine is not
5486	currently open.
5487	</note>
5488
5489	<result name="VBOX_E_INVALID_VM_STATE">
5490	Machine session is not open.
5491	</result>
5492
5493	</desc>
5494	<param name="winId" type="long long" dir="return">
5495	<desc>
5496	Platform-dependent identifier of the top-level VM console
5497	window, or zero if this method has performed all actions
5498	necessary to implement the <i>show window</i> semantics for
5499	the given platform and/or VirtualBox front-end.
5500	</desc>
5501	</param>
5502	</method>
5503
5504	<method name="getGuestProperty" const="yes">
5505	<desc>
5506	Reads an entry from the machine's guest property store.
5507
5508	<result name="VBOX_E_INVALID_VM_STATE">
5509	Machine session is not open.
5510	</result>
5511
5512	</desc>
5513	<param name="name" type="wstring" dir="in">
5514	<desc>
5515	The name of the property to read.
5516	</desc>
5517	</param>
5518	<param name="value" type="wstring" dir="out">
5519	<desc>
5520	The value of the property. If the property does not exist then this
5521	will be empty.
5522	</desc>
5523	</param>
5524	<param name="timestamp" type="long long" dir="out">
5525	<desc>
5526	The time at which the property was last modified, as seen by the
5527	server process.
5528	</desc>
5529	</param>
5530	<param name="flags" type="wstring" dir="out">
5531	<desc>
5532	Additional property parameters, passed as a comma-separated list of
5533	"name=value" type entries.
5534	</desc>
5535	</param>
5536	</method>
5537
5538	<method name="getGuestPropertyValue" const="yes">
5539	<desc>
5540	Reads a value from the machine's guest property store.
5541
5542	<result name="VBOX_E_INVALID_VM_STATE">
5543	Machine session is not open.
5544	</result>
5545
5546	</desc>
5547	<param name="property" type="wstring" dir="in">
5548	<desc>
5549	The name of the property to read.
5550	</desc>
5551	</param>
5552	<param name="value" type="wstring" dir="return">
5553	<desc>
5554	The value of the property. If the property does not exist then this
5555	will be empty.
5556	</desc>
5557	</param>
5558	</method>
5559
5560	<method name="getGuestPropertyTimestamp" const="yes">
5561	<desc>
5562	Reads a property timestamp from the machine's guest property store.
5563
5564	<result name="VBOX_E_INVALID_VM_STATE">
5565	Machine session is not open.
5566	</result>
5567
5568	</desc>
5569	<param name="property" type="wstring" dir="in">
5570	<desc>
5571	The name of the property to read.
5572	</desc>
5573	</param>
5574	<param name="value" type="long long" dir="return">
5575	<desc>
5576	The timestamp. If the property does not exist then this will be
5577	empty.
5578	</desc>
5579	</param>
5580	</method>
5581
5582	<method name="setGuestProperty">
5583	<desc>
5584	Sets, changes or deletes an entry in the machine's guest property
5585	store.
5586
5587	<result name="E_ACCESSDENIED">
5588	Property cannot be changed.
5589	</result>
5590	<result name="E_INVALIDARG">
5591	Invalid @a flags.
5592	</result>
5593	<result name="VBOX_E_INVALID_VM_STATE">
5594	Virtual machine is not mutable or session not open.
5595	</result>
5596	<result name="VBOX_E_INVALID_OBJECT_STATE">
5597	Cannot set transient property when machine not running.
5598	</result>
5599
5600	</desc>
5601	<param name="property" type="wstring" dir="in">
5602	<desc>
5603	The name of the property to set, change or delete.
5604	</desc>
5605	</param>
5606	<param name="value" type="wstring" dir="in">
5607	<desc>
5608	The new value of the property to set, change or delete. If the
5609	property does not yet exist and value is non-empty, it will be
5610	created. If the value is @c null or empty, the property will be
5611	deleted if it exists.
5612	</desc>
5613	</param>
5614	<param name="flags" type="wstring" dir="in">
5615	<desc>
5616	Additional property parameters, passed as a comma-separated list of
5617	"name=value" type entries.
5618	</desc>
5619	</param>
5620	</method>
5621
5622	<method name="setGuestPropertyValue">
5623	<desc>
5624	Sets, changes or deletes a value in the machine's guest property
5625	store. The flags field will be left unchanged or created empty for a
5626	new property.
5627
5628	<result name="E_ACCESSDENIED">
5629	Property cannot be changed.
5630	</result>
5631	<result name="VBOX_E_INVALID_VM_STATE">
5632	Virtual machine is not mutable or session not open.
5633	</result>
5634	<result name="VBOX_E_INVALID_OBJECT_STATE">
5635	Cannot set transient property when machine not running.
5636	</result>
5637	</desc>
5638
5639	<param name="property" type="wstring" dir="in">
5640	<desc>
5641	The name of the property to set, change or delete.
5642	</desc>
5643	</param>
5644	<param name="value" type="wstring" dir="in">
5645	<desc>
5646	The new value of the property to set, change or delete. If the
5647	property does not yet exist and value is non-empty, it will be
5648	created. If the value is @c null or empty, the property will be
5649	deleted if it exists.
5650	</desc>
5651	</param>
5652	</method>
5653
5654	<method name="enumerateGuestProperties">
5655	<desc>
5656	Return a list of the guest properties matching a set of patterns along
5657	with their values, time stamps and flags.
5658	</desc>
5659	<param name="patterns" type="wstring" dir="in">
5660	<desc>
5661	The patterns to match the properties against, separated by '\|'
5662	characters. If this is empty or @c null, all properties will match.
5663	</desc>
5664	</param>
5665	<param name="name" type="wstring" dir="out" safearray="yes">
5666	<desc>
5667	The names of the properties returned.
5668	</desc>
5669	</param>
5670	<param name="value" type="wstring" dir="out" safearray="yes">
5671	<desc>
5672	The values of the properties returned. The array entries match the
5673	corresponding entries in the @a name array.
5674	</desc>
5675	</param>
5676	<param name="timestamp" type="long long" dir="out" safearray="yes">
5677	<desc>
5678	The time stamps of the properties returned. The array entries match
5679	the corresponding entries in the @a name array.
5680	</desc>
5681	</param>
5682	<param name="flags" type="wstring" dir="out" safearray="yes">
5683	<desc>
5684	The flags of the properties returned. The array entries match the
5685	corresponding entries in the @a name array.
5686	</desc>
5687	</param>
5688	</method>
5689
5690	<method name="querySavedGuestSize">
5691	<desc>
5692	Returns the guest dimensions from the saved state.
5693	</desc>
5694	<param name="screenId" type="unsigned long" dir="in">
5695	<desc>
5696	Saved guest screen to query info from.
5697	</desc>
5698	</param>
5699	<param name="width" type="unsigned long" dir="out">
5700	<desc>
5701	Guest width at the time of the saved state was taken.
5702	</desc>
5703	</param>
5704	<param name="height" type="unsigned long" dir="out">
5705	<desc>
5706	Guest height at the time of the saved state was taken.
5707	</desc>
5708	</param>
5709	</method>
5710
5711	<method name="querySavedThumbnailSize">
5712	<desc>
5713	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5714	</desc>
5715	<param name="screenId" type="unsigned long" dir="in">
5716	<desc>
5717	Saved guest screen to query info from.
5718	</desc>
5719	</param>
5720	<param name="size" type="unsigned long" dir="out">
5721	<desc>
5722	Size of buffer required to store the bitmap.
5723	</desc>
5724	</param>
5725	<param name="width" type="unsigned long" dir="out">
5726	<desc>
5727	Bitmap width.
5728	</desc>
5729	</param>
5730	<param name="height" type="unsigned long" dir="out">
5731	<desc>
5732	Bitmap height.
5733	</desc>
5734	</param>
5735	</method>
5736
5737	<method name="readSavedThumbnailToArray">
5738	<desc>
5739	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5740	</desc>
5741	<param name="screenId" type="unsigned long" dir="in">
5742	<desc>
5743	Saved guest screen to read from.
5744	</desc>
5745	</param>
5746	<param name="BGR" type="boolean" dir="in">
5747	<desc>
5748	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5749	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5750	</desc>
5751	</param>
5752	<param name="width" type="unsigned long" dir="out">
5753	<desc>
5754	Bitmap width.
5755	</desc>
5756	</param>
5757	<param name="height" type="unsigned long" dir="out">
5758	<desc>
5759	Bitmap height.
5760	</desc>
5761	</param>
5762	<param name="data" type="octet" safearray="yes" dir="return">
5763	<desc>
5764	Array with resulting bitmap data.
5765	</desc>
5766	</param>
5767	</method>
5768
5769	<method name="readSavedThumbnailPNGToArray">
5770	<desc>
5771	Thumbnail in PNG format is retrieved to an array of bytes.
5772	</desc>
5773	<param name="screenId" type="unsigned long" dir="in">
5774	<desc>
5775	Saved guest screen to read from.
5776	</desc>
5777	</param>
5778	<param name="width" type="unsigned long" dir="out">
5779	<desc>
5780	Image width.
5781	</desc>
5782	</param>
5783	<param name="height" type="unsigned long" dir="out">
5784	<desc>
5785	Image height.
5786	</desc>
5787	</param>
5788	<param name="data" type="octet" dir="return" safearray="yes">
5789	<desc>
5790	Array with resulting PNG data.
5791	</desc>
5792	</param>
5793	</method>
5794
5795	<method name="querySavedScreenshotPNGSize">
5796	<desc>
5797	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5798	</desc>
5799	<param name="screenId" type="unsigned long" dir="in">
5800	<desc>
5801	Saved guest screen to query info from.
5802	</desc>
5803	</param>
5804	<param name="size" type="unsigned long" dir="out">
5805	<desc>
5806	Size of buffer required to store the PNG binary data.
5807	</desc>
5808	</param>
5809	<param name="width" type="unsigned long" dir="out">
5810	<desc>
5811	Image width.
5812	</desc>
5813	</param>
5814	<param name="height" type="unsigned long" dir="out">
5815	<desc>
5816	Image height.
5817	</desc>
5818	</param>
5819	</method>
5820
5821	<method name="readSavedScreenshotPNGToArray">
5822	<desc>
5823	Screenshot in PNG format is retrieved to an array of bytes.
5824	</desc>
5825	<param name="screenId" type="unsigned long" dir="in">
5826	<desc>
5827	Saved guest screen to read from.
5828	</desc>
5829	</param>
5830	<param name="width" type="unsigned long" dir="out">
5831	<desc>
5832	Image width.
5833	</desc>
5834	</param>
5835	<param name="height" type="unsigned long" dir="out">
5836	<desc>
5837	Image height.
5838	</desc>
5839	</param>
5840	<param name="data" type="octet" dir="return" safearray="yes">
5841	<desc>
5842	Array with resulting PNG data.
5843	</desc>
5844	</param>
5845	</method>
5846
5847	<method name="hotPlugCPU">
5848	<desc>
5849	Plugs a CPU into the machine.
5850	</desc>
5851	<param name="cpu" type="unsigned long" dir="in">
5852	<desc>
5853	The CPU id to insert.
5854	</desc>
5855	</param>
5856	</method>
5857
5858	<method name="hotUnplugCPU">
5859	<desc>
5860	Removes a CPU from the machine.
5861	</desc>
5862	<param name="cpu" type="unsigned long" dir="in">
5863	<desc>
5864	The CPU id to remove.
5865	</desc>
5866	</param>
5867	</method>
5868
5869	<method name="getCPUStatus">
5870	<desc>
5871	Returns the current status of the given CPU.
5872	</desc>
5873	<param name="cpu" type="unsigned long" dir="in">
5874	<desc>
5875	The CPU id to check for.
5876	</desc>
5877	</param>
5878	<param name="attached" type="boolean" dir="return">
5879	<desc>
5880	Status of the CPU.
5881	</desc>
5882	</param>
5883	</method>
5884
5885	<method name="queryLogFilename">
5886	<desc>
5887	Queries for the VM log file name of an given index. Returns an empty
5888	string if a log file with that index doesn't exists.
5889	</desc>
5890	<param name="idx" type="unsigned long" dir="in">
5891	<desc>
5892	Which log file name to query. 0=current log file.
5893	</desc>
5894	</param>
5895	<param name="filename" type="wstring" dir="return">
5896	<desc>
5897	On return the full path to the log file or an empty string on error.
5898	</desc>
5899	</param>
5900	</method>
5901
5902	<method name="readLog">
5903	<desc>
5904	Reads the VM log file. The chunk size is limited, so even if you
5905	ask for a big piece there might be less data returned.
5906	</desc>
5907	<param name="idx" type="unsigned long" dir="in">
5908	<desc>
5909	Which log file to read. 0=current log file.
5910	</desc>
5911	</param>
5912	<param name="offset" type="long long" dir="in">
5913	<desc>
5914	Offset in the log file.
5915	</desc>
5916	</param>
5917	<param name="size" type="long long" dir="in">
5918	<desc>
5919	Chunk size to read in the log file.
5920	</desc>
5921	</param>
5922	<param name="data" type="octet" dir="return" safearray="yes">
5923	<desc>
5924	Data read from the log file. A data size of 0 means end of file
5925	if the requested chunk size was not 0. This is the unprocessed
5926	file data, i.e. the line ending style depends on the platform of
5927	the system the server is running on.
5928	</desc>
5929	</param>
5930	</method>
5931
5932	<method name="cloneTo">
5933	<desc>
5934	Creates a clone of this machine, either as a full clone (which means
5935	creating independent copies of the hard disk media), or as a linked
5936	clone (which uses its own differencing media, sharing the parent media
5937	with the source machine).
5938
5939	The target machine object must have been created previously with
5940	<link to="IVirtualBox::createMachine"/>, and all the settings will be
5941	transferred except the VM name, hardware UUID and the network card
5942	MAC addresses. These can be set after the clone operation if required.
5943	The operation is performed asynchronously, so the machine object will
5944	be not be usable until the @a progress object signals completion. If
5945	any step of the machine clone operation fails this will abort the
5946	operation. The result will be a machine which is not a complete clone.
5947	It is the responsibility of the caller to delete this incomplete
5948	machine if desired with <link to="#unregister"/> and/or
5949	<link to="#delete"/>.
5950
5951	<result name="E_INVALIDARG">
5952	@a target is @c null.
5953	</result>
5954	</desc>
5955
5956	<param name="target" type="IMachine" dir="in">
5957	<desc>Target machine object.</desc>
5958	</param>
5959	<param name="fullClone" type="boolean" dir="in">
5960	<desc>Selects whether a full or linked clone is created.</desc>
5961	</param>
5962	<param name="progress" type="IProgress" dir="return">
5963	<desc>Progress object to track the operation completion.</desc>
5964	</param>
5965	</method>
5966
5967	</interface>
5968
5969	<!--
5970	// IConsole
5971	/////////////////////////////////////////////////////////////////////////
5972	-->
5973
5974	<interface
5975	name="IVRDEServerInfo" extends="$unknown"
5976	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5977	wsmap="struct"
5978	>
5979	<desc>
5980	Contains information about the remote desktop (VRDE) server capabilities and status.
5981	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5982	</desc>
5983
5984	<attribute name="active" type="boolean" readonly="yes">
5985	<desc>
5986	Whether the remote desktop connection is active.
5987	</desc>
5988	</attribute>
5989
5990	<attribute name="port" type="long" readonly="yes">
5991	<desc>
5992	VRDE server port number. If this property is equal to <tt>0</tt>, then
5993	the VRDE server failed to start, usually because there are no free IP
5994	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5995	server has not yet been started.
5996	</desc>
5997	</attribute>
5998
5999	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6000	<desc>
6001	How many times a client connected.
6002	</desc>
6003	</attribute>
6004
6005	<attribute name="beginTime" type="long long" readonly="yes">
6006	<desc>
6007	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6008	</desc>
6009	</attribute>
6010
6011	<attribute name="endTime" type="long long" readonly="yes">
6012	<desc>
6013	When the last connection was terminated or the current time, if
6014	connection is still active, in milliseconds since 1970-01-01 UTC.
6015	</desc>
6016	</attribute>
6017
6018	<attribute name="bytesSent" type="long long" readonly="yes">
6019	<desc>
6020	How many bytes were sent in last or current, if still active, connection.
6021	</desc>
6022	</attribute>
6023
6024	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6025	<desc>
6026	How many bytes were sent in all connections.
6027	</desc>
6028	</attribute>
6029
6030	<attribute name="bytesReceived" type="long long" readonly="yes">
6031	<desc>
6032	How many bytes were received in last or current, if still active, connection.
6033	</desc>
6034	</attribute>
6035
6036	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6037	<desc>
6038	How many bytes were received in all connections.
6039	</desc>
6040	</attribute>
6041
6042	<attribute name="user" type="wstring" readonly="yes">
6043	<desc>
6044	Login user name supplied by the client.
6045	</desc>
6046	</attribute>
6047
6048	<attribute name="domain" type="wstring" readonly="yes">
6049	<desc>
6050	Login domain name supplied by the client.
6051	</desc>
6052	</attribute>
6053
6054	<attribute name="clientName" type="wstring" readonly="yes">
6055	<desc>
6056	The client name supplied by the client.
6057	</desc>
6058	</attribute>
6059
6060	<attribute name="clientIP" type="wstring" readonly="yes">
6061	<desc>
6062	The IP address of the client.
6063	</desc>
6064	</attribute>
6065
6066	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6067	<desc>
6068	The client software version number.
6069	</desc>
6070	</attribute>
6071
6072	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6073	<desc>
6074	Public key exchange method used when connection was established.
6075	Values: 0 - RDP4 public key exchange scheme.
6076	1 - X509 certificates were sent to client.
6077	</desc>
6078	</attribute>
6079
6080	</interface>
6081
6082	<interface
6083	name="IConsole" extends="$unknown"
6084	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6085	wsmap="managed"
6086	>
6087	<desc>
6088	The IConsole interface represents an interface to control virtual
6089	machine execution.
6090
6091	A console object gets created when a machine has been locked for a
6092	particular session (client process) using <link to="IMachine::lockMachine" />
6093	or <link to="IMachine::launchVMProcess"/>. The console object can
6094	then be found in the session's <link to="ISession::console" /> attribute.
6095
6096	Methods of the IConsole interface allow the caller to query the current
6097	virtual machine execution state, pause the machine or power it down, save
6098	the machine state or take a snapshot, attach and detach removable media
6099	and so on.
6100
6101	<see>ISession</see>
6102	</desc>
6103
6104	<attribute name="machine" type="IMachine" readonly="yes">
6105	<desc>
6106	Machine object for this console session.
6107	<note>
6108	This is a convenience property, it has the same value as
6109	<link to="ISession::machine"/> of the corresponding session
6110	object.
6111	</note>
6112	</desc>
6113	</attribute>
6114
6115	<attribute name="state" type="MachineState" readonly="yes">
6116	<desc>
6117	Current execution state of the machine.
6118	<note>
6119	This property always returns the same value as the corresponding
6120	property of the IMachine object for this console session.
6121	For the process that owns (executes) the VM, this is the
6122	preferable way of querying the VM state, because no IPC
6123	calls are made.
6124	</note>
6125	</desc>
6126	</attribute>
6127
6128	<attribute name="guest" type="IGuest" readonly="yes">
6129	<desc>Guest object.</desc>
6130	</attribute>
6131
6132	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6133	<desc>
6134	Virtual keyboard object.
6135	<note>
6136	If the machine is not running, any attempt to use
6137	the returned object will result in an error.
6138	</note>
6139	</desc>
6140	</attribute>
6141
6142	<attribute name="mouse" type="IMouse" readonly="yes">
6143	<desc>
6144	Virtual mouse object.
6145	<note>
6146	If the machine is not running, any attempt to use
6147	the returned object will result in an error.
6148	</note>
6149	</desc>
6150	</attribute>
6151
6152	<attribute name="display" type="IDisplay" readonly="yes">
6153	<desc>Virtual display object.
6154	<note>
6155	If the machine is not running, any attempt to use
6156	the returned object will result in an error.
6157	</note>
6158	</desc>
6159	</attribute>
6160
6161	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6162	<desc>Debugging interface.</desc>
6163	</attribute>
6164
6165	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6166	<desc>
6167	Collection of USB devices currently attached to the virtual
6168	USB controller.
6169	<note>
6170	The collection is empty if the machine is not running.
6171	</note>
6172	</desc>
6173	</attribute>
6174
6175	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6176	<desc>
6177	List of USB devices currently attached to the remote VRDE client.
6178	Once a new device is physically attached to the remote host computer,
6179	it appears in this list and remains there until detached.
6180	</desc>
6181	</attribute>
6182
6183	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6184	<desc>
6185	Collection of shared folders for the current session. These folders
6186	are called transient shared folders because they are available to the
6187	guest OS running inside the associated virtual machine only for the
6188	duration of the session (as opposed to
6189	<link to="IMachine::sharedFolders"/> which represent permanent shared
6190	folders). When the session is closed (e.g. the machine is powered down),
6191	these folders are automatically discarded.
6192
6193	New shared folders are added to the collection using
6194	<link to="#createSharedFolder"/>. Existing shared folders can be
6195	removed using <link to="#removeSharedFolder"/>.
6196	</desc>
6197	</attribute>
6198
6199	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6200	<desc>
6201	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6202	</desc>
6203	</attribute>
6204
6205	<attribute name="eventSource" type="IEventSource" readonly="yes">
6206	<desc>
6207	Event source for console events.
6208	</desc>
6209	</attribute>
6210
6211	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6212	<desc>Array of PCI devices attached to this machine.</desc>
6213	</attribute>
6214
6215	<method name="powerUp">
6216	<desc>
6217	Starts the virtual machine execution using the current machine
6218	state (that is, its current execution state, current settings and
6219	current storage devices).
6220
6221	<note>
6222	This method is only useful for front-ends that want to actually
6223	execute virtual machines in their own process (like the VirtualBox
6224	or VBoxSDL front-ends). Unless you are intending to write such a
6225	front-end, do not call this method. If you simply want to
6226	start virtual machine execution using one of the existing front-ends
6227	(for example the VirtualBox GUI or headless server), use
6228	<link to="IMachine::launchVMProcess"/> instead; these
6229	front-ends will power up the machine automatically for you.
6230	</note>
6231
6232	If the machine is powered off or aborted, the execution will
6233	start from the beginning (as if the real hardware were just
6234	powered on).
6235
6236	If the machine is in the <link to="MachineState_Saved"/> state,
6237	it will continue its execution the point where the state has
6238	been saved.
6239
6240	If the machine <link to="IMachine::teleporterEnabled"/> property is
6241	enabled on the machine being powered up, the machine will wait for an
6242	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6243	state. The returned progress object will have at least three
6244	operations where the last three are defined as: (1) powering up and
6245	starting TCP server, (2) waiting for incoming teleportations, and
6246	(3) perform teleportation. These operations will be reflected as the
6247	last three operations of the progress objected returned by
6248	<link to="IMachine::launchVMProcess"/> as well.
6249
6250	<see>#saveState</see>
6251
6252	<result name="VBOX_E_INVALID_VM_STATE">
6253	Virtual machine already running.
6254	</result>
6255	<result name="VBOX_E_HOST_ERROR">
6256	Host interface does not exist or name not set.
6257	</result>
6258	<result name="VBOX_E_FILE_ERROR">
6259	Invalid saved state file.
6260	</result>
6261	</desc>
6262	<param name="progress" type="IProgress" dir="return">
6263	<desc>Progress object to track the operation completion.</desc>
6264	</param>
6265	</method>
6266
6267	<method name="powerUpPaused">
6268	<desc>
6269	Identical to powerUp except that the VM will enter the
6270	<link to="MachineState_Paused"/> state, instead of
6271	<link to="MachineState_Running"/>.
6272
6273	<see>#powerUp</see>
6274	<result name="VBOX_E_INVALID_VM_STATE">
6275	Virtual machine already running.
6276	</result>
6277	<result name="VBOX_E_HOST_ERROR">
6278	Host interface does not exist or name not set.
6279	</result>
6280	<result name="VBOX_E_FILE_ERROR">
6281	Invalid saved state file.
6282	</result>
6283	</desc>
6284	<param name="progress" type="IProgress" dir="return">
6285	<desc>Progress object to track the operation completion.</desc>
6286	</param>
6287	</method>
6288
6289	<method name="powerDown">
6290	<desc>
6291	Initiates the power down procedure to stop the virtual machine
6292	execution.
6293
6294	The completion of the power down procedure is tracked using the returned
6295	IProgress object. After the operation is complete, the machine will go
6296	to the PoweredOff state.
6297	<result name="VBOX_E_INVALID_VM_STATE">
6298	Virtual machine must be Running, Paused or Stuck to be powered down.
6299	</result>
6300	</desc>
6301	<param name="progress" type="IProgress" dir="return">
6302	<desc>Progress object to track the operation completion.</desc>
6303	</param>
6304	</method>
6305
6306	<method name="reset">
6307	<desc>Resets the virtual machine.
6308	<result name="VBOX_E_INVALID_VM_STATE">
6309	Virtual machine not in Running state.
6310	</result>
6311	<result name="VBOX_E_VM_ERROR">
6312	Virtual machine error in reset operation.
6313	</result>
6314	</desc>
6315	</method>
6316
6317	<method name="pause">
6318	<desc>Pauses the virtual machine execution.
6319	<result name="VBOX_E_INVALID_VM_STATE">
6320	Virtual machine not in Running state.
6321	</result>
6322	<result name="VBOX_E_VM_ERROR">
6323	Virtual machine error in suspend operation.
6324	</result>
6325	</desc>
6326	</method>
6327
6328	<method name="resume">
6329	<desc>Resumes the virtual machine execution.
6330	<result name="VBOX_E_INVALID_VM_STATE">
6331	Virtual machine not in Paused state.
6332	</result>
6333	<result name="VBOX_E_VM_ERROR">
6334	Virtual machine error in resume operation.
6335	</result>
6336	</desc>
6337	</method>
6338
6339	<method name="powerButton">
6340	<desc>Sends the ACPI power button event to the guest.
6341	<result name="VBOX_E_INVALID_VM_STATE">
6342	Virtual machine not in Running state.
6343	</result>
6344	<result name="VBOX_E_PDM_ERROR">
6345	Controlled power off failed.
6346	</result>
6347	</desc>
6348	</method>
6349
6350	<method name="sleepButton">
6351	<desc>Sends the ACPI sleep button event to the guest.
6352	<result name="VBOX_E_INVALID_VM_STATE">
6353	Virtual machine not in Running state.
6354	</result>
6355	<result name="VBOX_E_PDM_ERROR">
6356	Sending sleep button event failed.
6357	</result>
6358	</desc>
6359	</method>
6360
6361	<method name="getPowerButtonHandled">
6362	<desc>Checks if the last power button event was handled by guest.
6363	<result name="VBOX_E_PDM_ERROR">
6364	Checking if the event was handled by the guest OS failed.
6365	</result>
6366	</desc>
6367	<param name="handled" type="boolean" dir="return"/>
6368	</method>
6369
6370	<method name="getGuestEnteredACPIMode">
6371	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6372	G1 (sleeping). If this method returns @c false, the guest will
6373	most likely not respond to external ACPI events.
6374	<result name="VBOX_E_INVALID_VM_STATE">
6375	Virtual machine not in Running state.
6376	</result>
6377	</desc>
6378	<param name="entered" type="boolean" dir="return"/>
6379	</method>
6380
6381	<method name="saveState">
6382	<desc>
6383	Saves the current execution state of a running virtual machine
6384	and stops its execution.
6385
6386	After this operation completes, the machine will go to the
6387	Saved state. Next time it is powered up, this state will
6388	be restored and the machine will continue its execution from
6389	the place where it was saved.
6390
6391	This operation differs from taking a snapshot to the effect
6392	that it doesn't create new differencing media. Also, once
6393	the machine is powered up from the state saved using this method,
6394	the saved state is deleted, so it will be impossible to return
6395	to this state later.
6396
6397	<note>
6398	On success, this method implicitly calls
6399	<link to="IMachine::saveSettings"/> to save all current machine
6400	settings (including runtime changes to the DVD medium, etc.).
6401	Together with the impossibility to change any VM settings when it is
6402	in the Saved state, this guarantees adequate hardware
6403	configuration of the machine when it is restored from the saved
6404	state file.
6405	</note>
6406
6407	<note>
6408	The machine must be in the Running or Paused state, otherwise
6409	the operation will fail.
6410	</note>
6411	<result name="VBOX_E_INVALID_VM_STATE">
6412	Virtual machine state neither Running nor Paused.
6413	</result>
6414	<result name="VBOX_E_FILE_ERROR">
6415	Failed to create directory for saved state file.
6416	</result>
6417
6418	<see><link to="#takeSnapshot"/></see>
6419	</desc>
6420	<param name="progress" type="IProgress" dir="return">
6421	<desc>Progress object to track the operation completion.</desc>
6422	</param>
6423	</method>
6424
6425	<method name="adoptSavedState">
6426	<desc>
6427	Associates the given saved state file to the virtual machine.
6428
6429	On success, the machine will go to the Saved state. Next time it is
6430	powered up, it will be restored from the adopted saved state and
6431	continue execution from the place where the saved state file was
6432	created.
6433
6434	The specified saved state file path may be absolute or relative to the
6435	folder the VM normally saves the state to (usually,
6436	<link to="IMachine::snapshotFolder"/>).
6437
6438	<note>
6439	It's a caller's responsibility to make sure the given saved state
6440	file is compatible with the settings of this virtual machine that
6441	represent its virtual hardware (memory size, storage disk configuration
6442	etc.). If there is a mismatch, the behavior of the virtual machine
6443	is undefined.
6444	</note>
6445	<result name="VBOX_E_INVALID_VM_STATE">
6446	Virtual machine state neither PoweredOff nor Aborted.
6447	</result>
6448	</desc>
6449	<param name="savedStateFile" type="wstring" dir="in">
6450	<desc>Path to the saved state file to adopt.</desc>
6451	</param>
6452	</method>
6453
6454	<method name="discardSavedState">
6455	<desc>
6456	Forcibly resets the machine to "Powered Off" state if it is
6457	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6458	Next time the machine is powered up, a clean boot will occur.
6459	<note>
6460	This operation is equivalent to resetting or powering off
6461	the machine without doing a proper shutdown of the guest
6462	operating system; as with resetting a running phyiscal
6463	computer, it can can lead to data loss.
6464	</note>
6465	If @a fRemoveFile is @c true, the file in the machine directory
6466	into which the machine state was saved is also deleted. If
6467	this is @c false, then the state can be recovered and later
6468	re-inserted into a machine using <link to="#adoptSavedState" />.
6469	The location of the file can be found in the
6470	<link to="IMachine::stateFilePath" /> attribute.
6471	<result name="VBOX_E_INVALID_VM_STATE">
6472	Virtual machine not in state Saved.
6473	</result>
6474	</desc>
6475	<param name="fRemoveFile" type="boolean" dir="in" >
6476	<desc>Whether to also remove the saved state file.</desc>
6477	</param>
6478	</method>
6479
6480	<method name="getDeviceActivity">
6481	<desc>
6482	Gets the current activity type of a given device or device group.
6483	<result name="E_INVALIDARG">
6484	Invalid device type.
6485	</result>
6486	</desc>
6487	<param name="type" type="DeviceType" dir="in"/>
6488	<param name="activity" type="DeviceActivity" dir="return"/>
6489	</method>
6490
6491	<method name="attachUSBDevice">
6492	<desc>
6493	Attaches a host USB device with the given UUID to the
6494	USB controller of the virtual machine.
6495
6496	The device needs to be in one of the following states:
6497	<link to="USBDeviceState_Busy"/>,
6498	<link to="USBDeviceState_Available"/> or
6499	<link to="USBDeviceState_Held"/>,
6500	otherwise an error is immediately returned.
6501
6502	When the device state is
6503	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6504	be returned if the host computer refuses to release it for some reason.
6505
6506	<see>IUSBController::deviceFilters, USBDeviceState</see>
6507	<result name="VBOX_E_INVALID_VM_STATE">
6508	Virtual machine state neither Running nor Paused.
6509	</result>
6510	<result name="VBOX_E_PDM_ERROR">
6511	Virtual machine does not have a USB controller.
6512	</result>
6513	</desc>
6514	<param name="id" type="uuid" mod="string" dir="in">
6515	<desc>UUID of the host USB device to attach.</desc>
6516	</param>
6517	</method>
6518
6519	<method name="detachUSBDevice">
6520	<desc>
6521	Detaches an USB device with the given UUID from the USB controller
6522	of the virtual machine.
6523
6524	After this method succeeds, the VirtualBox server re-initiates
6525	all USB filters as if the device were just physically attached
6526	to the host, but filters of this machine are ignored to avoid
6527	a possible automatic re-attachment.
6528
6529	<see>IUSBController::deviceFilters, USBDeviceState</see>
6530
6531	<result name="VBOX_E_PDM_ERROR">
6532	Virtual machine does not have a USB controller.
6533	</result>
6534	<result name="E_INVALIDARG">
6535	USB device not attached to this virtual machine.
6536	</result>
6537	</desc>
6538	<param name="id" type="uuid" mod="string" dir="in">
6539	<desc>UUID of the USB device to detach.</desc>
6540	</param>
6541	<param name="device" type="IUSBDevice" dir="return">
6542	<desc>Detached USB device.</desc>
6543	</param>
6544	</method>
6545
6546	<method name="findUSBDeviceByAddress">
6547	<desc>
6548	Searches for a USB device with the given host address.
6549
6550	<result name="VBOX_E_OBJECT_NOT_FOUND">
6551	Given @c name does not correspond to any USB device.
6552	</result>
6553
6554	<see>IUSBDevice::address</see>
6555	</desc>
6556	<param name="name" type="wstring" dir="in">
6557	<desc>
6558	Address of the USB device (as assigned by the host) to
6559	search for.
6560	</desc>
6561	</param>
6562	<param name="device" type="IUSBDevice" dir="return">
6563	<desc>Found USB device object.</desc>
6564	</param>
6565	</method>
6566
6567	<method name="findUSBDeviceById">
6568	<desc>
6569	Searches for a USB device with the given UUID.
6570
6571	<result name="VBOX_E_OBJECT_NOT_FOUND">
6572	Given @c id does not correspond to any USB device.
6573	</result>
6574
6575	<see>IUSBDevice::id</see>
6576	</desc>
6577	<param name="id" type="uuid" mod="string" dir="in">
6578	<desc>UUID of the USB device to search for.</desc>
6579	</param>
6580	<param name="device" type="IUSBDevice" dir="return">
6581	<desc>Found USB device object.</desc>
6582	</param>
6583	</method>
6584
6585	<method name="createSharedFolder">
6586	<desc>
6587	Creates a transient new shared folder by associating the given logical
6588	name with the given host path, adds it to the collection of shared
6589	folders and starts sharing it. Refer to the description of
6590	<link to="ISharedFolder"/> to read more about logical names.
6591
6592	<result name="VBOX_E_INVALID_VM_STATE">
6593	Virtual machine in Saved state or currently changing state.
6594	</result>
6595	<result name="VBOX_E_FILE_ERROR">
6596	Shared folder already exists or not accessible.
6597	</result>
6598	</desc>
6599	<param name="name" type="wstring" dir="in">
6600	<desc>Unique logical name of the shared folder.</desc>
6601	</param>
6602	<param name="hostPath" type="wstring" dir="in">
6603	<desc>Full path to the shared folder in the host file system.</desc>
6604	</param>
6605	<param name="writable" type="boolean" dir="in">
6606	<desc>Whether the share is writable or readonly</desc>
6607	</param>
6608	<param name="automount" type="boolean" dir="in">
6609	<desc>Whether the share gets automatically mounted by the guest
6610	or not.</desc>
6611	</param>
6612	</method>
6613
6614	<method name="removeSharedFolder">
6615	<desc>
6616	Removes a transient shared folder with the given name previously
6617	created by <link to="#createSharedFolder"/> from the collection of
6618	shared folders and stops sharing it.
6619	<result name="VBOX_E_INVALID_VM_STATE">
6620	Virtual machine in Saved state or currently changing state.
6621	</result>
6622	<result name="VBOX_E_FILE_ERROR">
6623	Shared folder does not exists.
6624	</result>
6625	</desc>
6626	<param name="name" type="wstring" dir="in">
6627	<desc>Logical name of the shared folder to remove.</desc>
6628	</param>
6629	</method>
6630
6631	<method name="takeSnapshot">
6632	<desc>
6633	Saves the current execution state
6634	and all settings of the machine and creates differencing images
6635	for all normal (non-independent) media.
6636	See <link to="ISnapshot" /> for an introduction to snapshots.
6637
6638	This method can be called for a PoweredOff, Saved (see
6639	<link to="#saveState"/>), Running or
6640	Paused virtual machine. When the machine is PoweredOff, an
6641	offline snapshot is created. When the machine is Running a live
6642	snapshot is created, and an online snapshot is is created when Paused.
6643
6644	The taken snapshot is always based on the
6645	<link to="IMachine::currentSnapshot">current snapshot</link>
6646	of the associated virtual machine and becomes a new current snapshot.
6647
6648	<note>
6649	This method implicitly calls <link to="IMachine::saveSettings"/> to
6650	save all current machine settings before taking an offline snapshot.
6651	</note>
6652
6653	<result name="VBOX_E_INVALID_VM_STATE">
6654	Virtual machine currently changing state.
6655	</result>
6656	</desc>
6657	<param name="name" type="wstring" dir="in">
6658	<desc>Short name for the snapshot.</desc>
6659	</param>
6660	<param name="description" type="wstring" dir="in">
6661	<desc>Optional description of the snapshot.</desc>
6662	</param>
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="deleteSnapshot">
6669	<desc>
6670	Starts deleting the specified snapshot asynchronously.
6671	See <link to="ISnapshot" /> for an introduction to snapshots.
6672
6673	The execution state and settings of the associated machine stored in
6674	the snapshot will be deleted. The contents of all differencing media of
6675	this snapshot will be merged with the contents of their dependent child
6676	media to keep the medium chain valid (in other words, all changes
6677	represented by media being deleted will be propagated to their child
6678	medium). After that, this snapshot's differencing medium will be
6679	deleted. The parent of this snapshot will become a new parent for all
6680	its child snapshots.
6681
6682	If the deleted snapshot is the current one, its parent snapshot will
6683	become a new current snapshot. The current machine state is not directly
6684	affected in this case, except that currently attached differencing
6685	media based on media of the deleted snapshot will be also merged as
6686	described above.
6687
6688	If the deleted snapshot is the first or current snapshot, then the
6689	respective IMachine attributes will be adjusted. Deleting the current
6690	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6691	to make all current machine settings permanent.
6692
6693	Deleting a snapshot has the following preconditions:
6694
6695	<ul>
6696	<li>Child media of all normal media of the deleted snapshot
6697	must be accessible (see <link to="IMedium::state"/>) for this
6698	operation to succeed. In particular, this means that all virtual
6699	machines whose media are directly or indirectly based on the
6700	media of deleted snapshot must be powered off.</li>
6701
6702	<li>You cannot delete the snapshot if a medium attached to it has
6703	more than once child medium (differencing images) because otherwise
6704	merging would be impossible. This might be the case if there is
6705	more than one child snapshot or differencing images were created
6706	for other reason (e.g. implicitly because of multiple machine
6707	attachments).</li>
6708	</ul>
6709
6710
6711	The virtual machine's <link to="IMachine::state">state</link> is
6712	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6713	"DeletingSnapshotPaused" while this operation is in progress.
6714
6715	<note>
6716	Merging medium contents can be very time and disk space
6717	consuming, if these media are big in size and have many
6718	children. However, if the snapshot being deleted is the last
6719	(head) snapshot on the branch, the operation will be rather
6720	quick.
6721	</note>
6722	<result name="VBOX_E_INVALID_VM_STATE">
6723	The running virtual machine prevents deleting this snapshot. This
6724	happens only in very specific situations, usually snapshots can be
6725	deleted without trouble while a VM is running. The error message
6726	text explains the reason for the failure.
6727	</result>
6728	</desc>
6729	<param name="id" type="uuid" mod="string" dir="in">
6730	<desc>UUID of the snapshot to delete.</desc>
6731	</param>
6732	<param name="progress" type="IProgress" dir="return">
6733	<desc>Progress object to track the operation completion.</desc>
6734	</param>
6735	</method>
6736
6737	<method name="restoreSnapshot">
6738	<desc>
6739	Starts resetting the machine's current state to the state contained
6740	in the given snapshot, asynchronously. All current settings of the
6741	machine will be reset and changes stored in differencing media
6742	will be lost.
6743	See <link to="ISnapshot" /> for an introduction to snapshots.
6744
6745	After this operation is successfully completed, new empty differencing
6746	media are created for all normal media of the machine.
6747
6748	If the given snapshot is an online snapshot, the machine will go to
6749	the <link to="MachineState_Saved"> saved state</link>, so that the
6750	next time it is powered on, the execution state will be restored
6751	from the state of the snapshot.
6752
6753	<note>
6754	The machine must not be running, otherwise the operation will fail.
6755	</note>
6756
6757	<note>
6758	If the machine state is <link to="MachineState_Saved">Saved</link>
6759	prior to this operation, the saved state file will be implicitly
6760	deleted (as if <link to="IConsole::discardSavedState"/> were
6761	called).
6762	</note>
6763
6764	<result name="VBOX_E_INVALID_VM_STATE">
6765	Virtual machine is running.
6766	</result>
6767	</desc>
6768	<param name="snapshot" type="ISnapshot" dir="in">
6769	<desc>The snapshot to restore the VM state from.</desc>
6770	</param>
6771	<param name="progress" type="IProgress" dir="return">
6772	<desc>Progress object to track the operation completion.</desc>
6773	</param>
6774	</method>
6775
6776	<method name="teleport">
6777	<desc>
6778	Teleport the VM to a different host machine or process.
6779
6780	TODO explain the details.
6781
6782	<result name="VBOX_E_INVALID_VM_STATE">
6783	Virtual machine not running or paused.
6784	</result>
6785	</desc>
6786	<param name="hostname" type="wstring" dir="in">
6787	<desc>The name or IP of the host to teleport to.</desc>
6788	</param>
6789	<param name="tcpport" type="unsigned long" dir="in">
6790	<desc>The TCP port to connect to (1..65535).</desc>
6791	</param>
6792	<param name="password" type="wstring" dir="in">
6793	<desc>The password.</desc>
6794	</param>
6795	<param name="maxDowntime" type="unsigned long" dir="in">
6796	<desc>
6797	The maximum allowed downtime given as milliseconds. 0 is not a valid
6798	value. Recommended value: 250 ms.
6799
6800	The higher the value is, the greater the chance for a successful
6801	teleportation. A small value may easily result in the teleportation
6802	process taking hours and eventually fail.
6803
6804	<note>
6805	The current implementation treats this a guideline, not as an
6806	absolute rule.
6807	</note>
6808	</desc>
6809	</param>
6810	<param name="progress" type="IProgress" dir="return">
6811	<desc>Progress object to track the operation completion.</desc>
6812	</param>
6813	</method>
6814
6815	</interface>
6816
6817	<!--
6818	// IHost
6819	/////////////////////////////////////////////////////////////////////////
6820	-->
6821
6822	<enum
6823	name="HostNetworkInterfaceMediumType"
6824	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6825	>
6826	<desc>
6827	Type of encapsulation. Ethernet encapsulation includes both wired and
6828	wireless Ethernet connections.
6829	<see>IHostNetworkInterface</see>
6830	</desc>
6831
6832	<const name="Unknown" value="0">
6833	<desc>
6834	The type of interface cannot be determined.
6835	</desc>
6836	</const>
6837	<const name="Ethernet" value="1">
6838	<desc>
6839	Ethernet frame encapsulation.
6840	</desc>
6841	</const>
6842	<const name="PPP" value="2">
6843	<desc>
6844	Point-to-point protocol encapsulation.
6845	</desc>
6846	</const>
6847	<const name="SLIP" value="3">
6848	<desc>
6849	Serial line IP encapsulation.
6850	</desc>
6851	</const>
6852	</enum>
6853
6854	<enum
6855	name="HostNetworkInterfaceStatus"
6856	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6857	>
6858	<desc>
6859	Current status of the interface.
6860	<see>IHostNetworkInterface</see>
6861	</desc>
6862
6863	<const name="Unknown" value="0">
6864	<desc>
6865	The state of interface cannot be determined.
6866	</desc>
6867	</const>
6868	<const name="Up" value="1">
6869	<desc>
6870	The interface is fully operational.
6871	</desc>
6872	</const>
6873	<const name="Down" value="2">
6874	<desc>
6875	The interface is not functioning.
6876	</desc>
6877	</const>
6878	</enum>
6879
6880	<enum
6881	name="HostNetworkInterfaceType"
6882	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6883	>
6884	<desc>
6885	Network interface type.
6886	</desc>
6887	<const name="Bridged" value="1"/>
6888	<const name="HostOnly" value="2"/>
6889	</enum>
6890
6891	<interface
6892	name="IHostNetworkInterface" extends="$unknown"
6893	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6894	wsmap="managed"
6895	>
6896	<desc>
6897	Represents one of host's network interfaces. IP V6 address and network
6898	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6899	separated by colons.
6900	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6901	</desc>
6902	<attribute name="name" type="wstring" readonly="yes">
6903	<desc>Returns the host network interface name.</desc>
6904	</attribute>
6905
6906	<attribute name="id" type="uuid" mod="string" readonly="yes">
6907	<desc>Returns the interface UUID.</desc>
6908	</attribute>
6909
6910	<attribute name="networkName" type="wstring" readonly="yes">
6911	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6912	</attribute>
6913
6914	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6915	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6916	</attribute>
6917
6918	<attribute name="IPAddress" type="wstring" readonly="yes">
6919	<desc>Returns the IP V4 address of the interface.</desc>
6920	</attribute>
6921
6922	<attribute name="networkMask" type="wstring" readonly="yes">
6923	<desc>Returns the network mask of the interface.</desc>
6924	</attribute>
6925
6926	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6927	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6928	</attribute>
6929
6930	<attribute name="IPV6Address" type="wstring" readonly="yes">
6931	<desc>Returns the IP V6 address of the interface.</desc>
6932	</attribute>
6933
6934	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6935	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6936	</attribute>
6937
6938	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6939	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6940	</attribute>
6941
6942	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6943	<desc>Type of protocol encapsulation used.</desc>
6944	</attribute>
6945
6946	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6947	<desc>Status of the interface.</desc>
6948	</attribute>
6949
6950	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6951	<desc>specifies the host interface type.</desc>
6952	</attribute>
6953
6954	<method name="enableStaticIpConfig">
6955	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6956	<param name="IPAddress" type="wstring" dir="in">
6957	<desc>
6958	IP address.
6959	</desc>
6960	</param>
6961	<param name="networkMask" type="wstring" dir="in">
6962	<desc>
6963	network mask.
6964	</desc>
6965	</param>
6966	</method>
6967
6968	<method name="enableStaticIpConfigV6">
6969	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6970	<param name="IPV6Address" type="wstring" dir="in">
6971	<desc>
6972	IP address.
6973	</desc>
6974	</param>
6975	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6976	<desc>
6977	network mask.
6978	</desc>
6979	</param>
6980	</method>
6981
6982	<method name="enableDynamicIpConfig">
6983	<desc>enables the dynamic IP configuration.</desc>
6984	</method>
6985
6986	<method name="dhcpRediscover">
6987	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6988	</method>
6989
6990	</interface>
6991
6992	<interface
6993	name="IHost" extends="$unknown"
6994	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
6995	wsmap="managed"
6996	>
6997	<desc>
6998	The IHost interface represents the physical machine that this VirtualBox
6999	installation runs on.
7000
7001	An object implementing this interface is returned by the
7002	<link to="IVirtualBox::host" /> attribute. This interface contains
7003	read-only information about the host's physical hardware (such as what
7004	processors and disks are available, what the host operating system is,
7005	and so on) and also allows for manipulating some of the host's hardware,
7006	such as global USB device filters and host interface networking.
7007
7008	</desc>
7009	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7010	<desc>List of DVD drives available on the host.</desc>
7011	</attribute>
7012
7013	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7014	<desc>List of floppy drives available on the host.</desc>
7015	</attribute>
7016
7017	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7018	<desc>
7019	List of USB devices currently attached to the host.
7020	Once a new device is physically attached to the host computer,
7021	it appears in this list and remains there until detached.
7022
7023	<note>
7024	If USB functionality is not available in the given edition of
7025	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7026	</note>
7027	</desc>
7028	</attribute>
7029
7030	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7031	<desc>
7032	List of USB device filters in action.
7033	When a new device is physically attached to the host computer,
7034	filters from this list are applied to it (in order they are stored
7035	in the list). The first matched filter will determine the
7036	<link to="IHostUSBDeviceFilter::action">action</link>
7037	performed on the device.
7038
7039	Unless the device is ignored by these filters, filters of all
7040	currently running virtual machines
7041	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7042
7043	<note>
7044	If USB functionality is not available in the given edition of
7045	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7046	</note>
7047
7048	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7049	</desc>
7050	</attribute>
7051
7052	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7053	<desc>List of host network interfaces currently defined on the host.</desc>
7054	</attribute>
7055
7056	<attribute name="processorCount" type="unsigned long" readonly="yes">
7057	<desc>Number of (logical) CPUs installed in the host system.</desc>
7058	</attribute>
7059
7060	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7061	<desc>Number of (logical) CPUs online in the host system.</desc>
7062	</attribute>
7063
7064	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7065	<desc>Number of physical processor cores installed in the host system.</desc>
7066	</attribute>
7067
7068	<method name="getProcessorSpeed">
7069	<desc>Query the (approximate) maximum speed of a specified host CPU in
7070	Megahertz.
7071	</desc>
7072	<param name="cpuId" type="unsigned long" dir="in">
7073	<desc>
7074	Identifier of the CPU.
7075	</desc>
7076	</param>
7077	<param name="speed" type="unsigned long" dir="return">
7078	<desc>
7079	Speed value. 0 is returned if value is not known or @a cpuId is
7080	invalid.
7081	</desc>
7082	</param>
7083	</method>
7084
7085	<method name="getProcessorFeature">
7086	<desc>Query whether a CPU feature is supported or not.</desc>
7087	<param name="feature" type="ProcessorFeature" dir="in">
7088	<desc>
7089	CPU Feature identifier.
7090	</desc>
7091	</param>
7092	<param name="supported" type="boolean" dir="return">
7093	<desc>
7094	Feature is supported or not.
7095	</desc>
7096	</param>
7097	</method>
7098
7099	<method name="getProcessorDescription">
7100	<desc>Query the model string of a specified host CPU.
7101	</desc>
7102	<param name="cpuId" type="unsigned long" dir="in">
7103	<desc>
7104	Identifier of the CPU.
7105	<note>
7106	The current implementation might not necessarily return the
7107	description for this exact CPU.
7108	</note>
7109	</desc>
7110	</param>
7111	<param name="description" type="wstring" dir="return">
7112	<desc>
7113	Model string. An empty string is returned if value is not known or
7114	@a cpuId is invalid.
7115	</desc>
7116	</param>
7117	</method>
7118
7119	<method name="getProcessorCPUIDLeaf">
7120	<desc>
7121	Returns the CPU cpuid information for the specified leaf.
7122	</desc>
7123	<param name="cpuId" type="unsigned long" dir="in">
7124	<desc>
7125	Identifier of the CPU. The CPU most be online.
7126	<note>
7127	The current implementation might not necessarily return the
7128	description for this exact CPU.
7129	</note>
7130	</desc>
7131	</param>
7132	<param name="leaf" type="unsigned long" dir="in">
7133	<desc>
7134	CPUID leaf index (eax).
7135	</desc>
7136	</param>
7137	<param name="subLeaf" type="unsigned long" dir="in">
7138	<desc>
7139	CPUID leaf sub index (ecx). This currently only applies to cache
7140	information on Intel CPUs. Use 0 if retrieving values for
7141	<link to="IMachine::setCPUIDLeaf"/>.
7142	</desc>
7143	</param>
7144	<param name="valEax" type="unsigned long" dir="out">
7145	<desc>
7146	CPUID leaf value for register eax.
7147	</desc>
7148	</param>
7149	<param name="valEbx" type="unsigned long" dir="out">
7150	<desc>
7151	CPUID leaf value for register ebx.
7152	</desc>
7153	</param>
7154	<param name="valEcx" type="unsigned long" dir="out">
7155	<desc>
7156	CPUID leaf value for register ecx.
7157	</desc>
7158	</param>
7159	<param name="valEdx" type="unsigned long" dir="out">
7160	<desc>
7161	CPUID leaf value for register edx.
7162	</desc>
7163	</param>
7164	</method>
7165
7166	<attribute name="memorySize" type="unsigned long" readonly="yes">
7167	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7168	</attribute>
7169
7170	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7171	<desc>Available system memory in the host system.</desc>
7172	</attribute>
7173
7174	<attribute name="operatingSystem" type="wstring" readonly="yes">
7175	<desc>Name of the host system's operating system.</desc>
7176	</attribute>
7177
7178	<attribute name="OSVersion" type="wstring" readonly="yes">
7179	<desc>Host operating system's version string.</desc>
7180	</attribute>
7181
7182	<attribute name="UTCTime" type="long long" readonly="yes">
7183	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7184	</attribute>
7185
7186	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7187	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7188	</attribute>
7189
7190	<method name="createHostOnlyNetworkInterface">
7191	<desc>
7192	Creates a new adapter for Host Only Networking.
7193	<result name="E_INVALIDARG">
7194	Host network interface @a name already exists.
7195	</result>
7196	</desc>
7197	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7198	<desc>
7199	Created host interface object.
7200	</desc>
7201	</param>
7202	<param name="progress" type="IProgress" dir="return">
7203	<desc>
7204	Progress object to track the operation completion.
7205	</desc>
7206	</param>
7207	</method>
7208
7209	<method name="removeHostOnlyNetworkInterface">
7210	<desc>
7211	Removes the given Host Only Networking interface.
7212	<result name="VBOX_E_OBJECT_NOT_FOUND">
7213	No host network interface matching @a id found.
7214	</result>
7215	</desc>
7216	<param name="id" type="uuid" mod="string" dir="in">
7217	<desc>
7218	Adapter GUID.
7219	</desc>
7220	</param>
7221	<param name="progress" type="IProgress" dir="return">
7222	<desc>
7223	Progress object to track the operation completion.
7224	</desc>
7225	</param>
7226	</method>
7227
7228	<method name="createUSBDeviceFilter">
7229	<desc>
7230	Creates a new USB device filter. All attributes except
7231	the filter name are set to empty (any match),
7232	<i>active</i> is @c false (the filter is not active).
7233
7234	The created filter can be added to the list of filters using
7235	<link to="#insertUSBDeviceFilter"/>.
7236
7237	<see>#USBDeviceFilters</see>
7238	</desc>
7239	<param name="name" type="wstring" dir="in">
7240	<desc>
7241	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7242	</desc>
7243	</param>
7244	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7245	<desc>Created filter object.</desc>
7246	</param>
7247	</method>
7248
7249	<method name="insertUSBDeviceFilter">
7250	<desc>
7251	Inserts the given USB device to the specified position
7252	in the list of filters.
7253
7254	Positions are numbered starting from @c 0. If the specified
7255	position is equal to or greater than the number of elements in
7256	the list, the filter is added at the end of the collection.
7257
7258	<note>
7259	Duplicates are not allowed, so an attempt to insert a
7260	filter already in the list is an error.
7261	</note>
7262	<note>
7263	If USB functionality is not available in the given edition of
7264	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7265	</note>
7266
7267	<see>#USBDeviceFilters</see>
7268
7269	<result name="VBOX_E_INVALID_OBJECT_STATE">
7270	USB device filter is not created within this VirtualBox instance.
7271	</result>
7272	<result name="E_INVALIDARG">
7273	USB device filter already in list.
7274	</result>
7275
7276	</desc>
7277	<param name="position" type="unsigned long" dir="in">
7278	<desc>Position to insert the filter to.</desc>
7279	</param>
7280	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7281	<desc>USB device filter to insert.</desc>
7282	</param>
7283	</method>
7284
7285	<method name="removeUSBDeviceFilter">
7286	<desc>
7287	Removes a USB device filter from the specified position in the
7288	list of filters.
7289
7290	Positions are numbered starting from @c 0. Specifying a
7291	position equal to or greater than the number of elements in
7292	the list will produce an error.
7293
7294	<note>
7295	If USB functionality is not available in the given edition of
7296	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7297	</note>
7298
7299	<see>#USBDeviceFilters</see>
7300
7301	<result name="E_INVALIDARG">
7302	USB device filter list empty or invalid @a position.
7303	</result>
7304
7305	</desc>
7306	<param name="position" type="unsigned long" dir="in">
7307	<desc>Position to remove the filter from.</desc>
7308	</param>
7309	</method>
7310
7311	<method name="findHostDVDDrive">
7312	<desc>
7313	Searches for a host DVD drive with the given @c name.
7314
7315	<result name="VBOX_E_OBJECT_NOT_FOUND">
7316	Given @c name does not correspond to any host drive.
7317	</result>
7318
7319	</desc>
7320	<param name="name" type="wstring" dir="in">
7321	<desc>Name of the host drive to search for</desc>
7322	</param>
7323	<param name="drive" type="IMedium" dir="return">
7324	<desc>Found host drive object</desc>
7325	</param>
7326	</method>
7327
7328	<method name="findHostFloppyDrive">
7329	<desc>
7330	Searches for a host floppy drive with the given @c name.
7331
7332	<result name="VBOX_E_OBJECT_NOT_FOUND">
7333	Given @c name does not correspond to any host floppy drive.
7334	</result>
7335
7336	</desc>
7337	<param name="name" type="wstring" dir="in">
7338	<desc>Name of the host floppy drive to search for</desc>
7339	</param>
7340	<param name="drive" type="IMedium" dir="return">
7341	<desc>Found host floppy drive object</desc>
7342	</param>
7343	</method>
7344
7345	<method name="findHostNetworkInterfaceByName">
7346	<desc>
7347	Searches through all host network interfaces for an interface with
7348	the given @c name.
7349	<note>
7350	The method returns an error if the given @c name does not
7351	correspond to any host network interface.
7352	</note>
7353	</desc>
7354	<param name="name" type="wstring" dir="in">
7355	<desc>Name of the host network interface to search for.</desc>
7356	</param>
7357	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7358	<desc>Found host network interface object.</desc>
7359	</param>
7360	</method>
7361	<method name="findHostNetworkInterfaceById">
7362	<desc>
7363	Searches through all host network interfaces for an interface with
7364	the given GUID.
7365	<note>
7366	The method returns an error if the given GUID does not
7367	correspond to any host network interface.
7368	</note>
7369	</desc>
7370	<param name="id" type="uuid" mod="string" dir="in">
7371	<desc>GUID of the host network interface to search for.</desc>
7372	</param>
7373	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7374	<desc>Found host network interface object.</desc>
7375	</param>
7376	</method>
7377	<method name="findHostNetworkInterfacesOfType">
7378	<desc>
7379	Searches through all host network interfaces and returns a list of interfaces of the specified type
7380	</desc>
7381	<param name="type" type="HostNetworkInterfaceType" dir="in">
7382	<desc>type of the host network interfaces to search for.</desc>
7383	</param>
7384	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7385	<desc>Found host network interface objects.</desc>
7386	</param>
7387	</method>
7388
7389	<method name="findUSBDeviceById">
7390	<desc>
7391	Searches for a USB device with the given UUID.
7392
7393	<result name="VBOX_E_OBJECT_NOT_FOUND">
7394	Given @c id does not correspond to any USB device.
7395	</result>
7396
7397	<see>IHostUSBDevice::id</see>
7398	</desc>
7399	<param name="id" type="uuid" mod="string" dir="in">
7400	<desc>UUID of the USB device to search for.</desc>
7401	</param>
7402	<param name="device" type="IHostUSBDevice" dir="return">
7403	<desc>Found USB device object.</desc>
7404	</param>
7405	</method>
7406
7407	<method name="findUSBDeviceByAddress">
7408	<desc>
7409	Searches for a USB device with the given host address.
7410
7411	<result name="VBOX_E_OBJECT_NOT_FOUND">
7412	Given @c name does not correspond to any USB device.
7413	</result>
7414
7415	<see>IHostUSBDevice::address</see>
7416	</desc>
7417	<param name="name" type="wstring" dir="in">
7418	<desc>
7419	Address of the USB device (as assigned by the host) to
7420	search for.
7421	</desc>
7422	</param>
7423	<param name="device" type="IHostUSBDevice" dir="return">
7424	<desc>Found USB device object.</desc>
7425	</param>
7426	</method>
7427
7428	<method name="generateMACAddress">
7429	<desc>
7430	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7431	</desc>
7432	<param name="address" type="wstring" dir="return">
7433	<desc>New Ethernet MAC address.</desc>
7434	</param>
7435	</method>
7436
7437	</interface>
7438
7439	<!--
7440	// ISystemProperties
7441	/////////////////////////////////////////////////////////////////////////
7442	-->
7443
7444	<interface
7445	name="ISystemProperties"
7446	extends="$unknown"
7447	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7448	wsmap="managed"
7449	>
7450	<desc>
7451	The ISystemProperties interface represents global properties of the given
7452	VirtualBox installation.
7453
7454	These properties define limits and default values for various attributes
7455	and parameters. Most of the properties are read-only, but some can be
7456	changed by a user.
7457	</desc>
7458
7459	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7460	<desc>Minimum guest system memory in Megabytes.</desc>
7461	</attribute>
7462
7463	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7464	<desc>Maximum guest system memory in Megabytes.</desc>
7465	</attribute>
7466
7467	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7468	<desc>Minimum guest video memory in Megabytes.</desc>
7469	</attribute>
7470
7471	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7472	<desc>Maximum guest video memory in Megabytes.</desc>
7473	</attribute>
7474
7475	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7476	<desc>Minimum CPU count.</desc>
7477	</attribute>
7478
7479	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7480	<desc>Maximum CPU count.</desc>
7481	</attribute>
7482
7483	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7484	<desc>Maximum of monitors which could be connected.</desc>
7485	</attribute>
7486
7487	<attribute name="infoVDSize" type="long long" readonly="yes">
7488	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7489	does not reflect the limits of any virtual disk image format.</desc>
7490	</attribute>
7491
7492	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7493	<desc>
7494	Maximum number of serial ports associated with every
7495	<link to="IMachine"/> instance.
7496	</desc>
7497	</attribute>
7498
7499	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7500	<desc>
7501	Maximum number of parallel ports associated with every
7502	<link to="IMachine"/> instance.
7503	</desc>
7504	</attribute>
7505
7506	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7507	<desc>
7508	Maximum device position in the boot order. This value corresponds
7509	to the total number of devices a machine can boot from, to make it
7510	possible to include all possible devices to the boot list.
7511	<see><link to="IMachine::setBootOrder"/></see>
7512	</desc>
7513	</attribute>
7514
7515	<attribute name="defaultMachineFolder" type="wstring">
7516	<desc>
7517	Full path to the default directory used to create new or open
7518	existing machines when a machine settings file name contains no
7519	path.
7520
7521	Starting with VirtualBox 4.0, by default, this attribute contains
7522	the full path of folder named "VirtualBox VMs" in the user's
7523	home directory, which depends on the host platform.
7524
7525	When setting this attribute, a full path must be specified.
7526	Setting this property to @c null or an empty string or the
7527	special value "Machines" (for compatibility reasons) will restore
7528	that default value.
7529
7530	If the folder specified herein does not exist, it will be created
7531	automatically as needed.
7532
7533	<see>
7534	<link to="IVirtualBox::createMachine"/>,
7535	<link to="IVirtualBox::openMachine"/>
7536	</see>
7537	</desc>
7538	</attribute>
7539
7540	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7541	<desc>
7542	List of all medium storage formats supported by this VirtualBox
7543	installation.
7544
7545	Keep in mind that the medium format identifier
7546	(<link to="IMediumFormat::id"/>) used in other API calls like
7547	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7548	medium format is a case-insensitive string. This means that, for
7549	example, all of the following strings:
7550	<pre>
7551	"VDI"
7552	"vdi"
7553	"VdI"</pre>
7554	refer to the same medium format.
7555
7556	Note that the virtual medium framework is backend-based, therefore
7557	the list of supported formats depends on what backends are currently
7558	installed.
7559
7560	<see>
7561	<link to="IMediumFormat"/>,
7562	</see>
7563	</desc>
7564	</attribute>
7565
7566	<attribute name="defaultHardDiskFormat" type="wstring">
7567	<desc>
7568	Identifier of the default medium format used by VirtualBox.
7569
7570	The medium format set by this attribute is used by VirtualBox
7571	when the medium format was not specified explicitly. One example is
7572	<link to="IVirtualBox::createHardDisk"/> with the empty
7573	format argument. A more complex example is implicit creation of
7574	differencing media when taking a snapshot of a virtual machine:
7575	this operation will try to use a format of the parent medium first
7576	and if this format does not support differencing media the default
7577	format specified by this argument will be used.
7578
7579	The list of supported medium formats may be obtained by the
7580	<link to="#mediumFormats"/> call. Note that the default medium
7581	format must have a capability to create differencing media;
7582	otherwise operations that create media implicitly may fail
7583	unexpectedly.
7584
7585	The initial value of this property is <tt>"VDI"</tt> in the current
7586	version of the VirtualBox product, but may change in the future.
7587
7588	<note>
7589	Setting this property to @c null or empty string will restore the
7590	initial value.
7591	</note>
7592
7593	<see>
7594	<link to="#mediumFormats"/>,
7595	<link to="IMediumFormat::id"/>,
7596	<link to="IVirtualBox::createHardDisk"/>
7597	</see>
7598	</desc>
7599	</attribute>
7600
7601	<attribute name="freeDiskSpaceWarning" type="long long">
7602	<desc>Issue a warning if the free disk space is below (or in some disk
7603	intensive operation is expected to go below) the given size in
7604	bytes.</desc>
7605	</attribute>
7606
7607	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7608	<desc>Issue a warning if the free disk space is below (or in some disk
7609	intensive operation is expected to go below) the given percentage.</desc>
7610	</attribute>
7611
7612	<attribute name="freeDiskSpaceError" type="long long">
7613	<desc>Issue an error if the free disk space is below (or in some disk
7614	intensive operation is expected to go below) the given size in
7615	bytes.</desc>
7616	</attribute>
7617
7618	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7619	<desc>Issue an error if the free disk space is below (or in some disk
7620	intensive operation is expected to go below) the given percentage.</desc>
7621	</attribute>
7622
7623	<attribute name="VRDEAuthLibrary" type="wstring">
7624	<desc>
7625	Library that provides authentication for Remote Desktop clients. The library
7626	is used if a virtual machine's authentication type is set to "external"
7627	in the VM RemoteDisplay configuration.
7628
7629	The system library extension (".DLL" or ".so") must be omitted.
7630	A full path can be specified; if not, then the library must reside on the
7631	system's default library path.
7632
7633	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7634	of that name in one of the default VirtualBox library directories.
7635
7636	For details about VirtualBox authentication libraries and how to implement
7637	them, please refer to the VirtualBox manual.
7638
7639	<note>
7640	Setting this property to @c null or empty string will restore the
7641	initial value.
7642	</note>
7643	</desc>
7644	</attribute>
7645
7646	<attribute name="webServiceAuthLibrary" type="wstring">
7647	<desc>
7648	Library that provides authentication for webservice clients. The library
7649	is used if a virtual machine's authentication type is set to "external"
7650	in the VM RemoteDisplay configuration and will be called from
7651	within the <link to="IWebsessionManager::logon" /> implementation.
7652
7653	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7654	there is no per-VM setting for this, as the webservice is a global
7655	resource (if it is running). Only for this setting (for the webservice),
7656	setting this value to a literal <tt>"null"</tt> string disables authentication,
7657	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7658	no matter what user name and password are supplied.
7659
7660	The initial value of this property is <tt>"VBoxAuth"</tt>,
7661	meaning that the webservice will use the same authentication
7662	library that is used by default for VRDE (again, see
7663	<link to="ISystemProperties::VRDEAuthLibrary" />).
7664	The format and calling convention of authentication libraries
7665	is the same for the webservice as it is for VRDE.
7666
7667	<note>
7668	Setting this property to @c null or empty string will restore the
7669	initial value.
7670	</note>
7671	</desc>
7672	</attribute>
7673
7674	<attribute name="defaultVRDEExtPack" type="wstring">
7675	<desc>
7676	The name of the extension pack providing the default VRDE.
7677
7678	This attribute is for choosing between multiple extension packs
7679	providing VRDE. If only one is installed, it will automatically be the
7680	default one. The attribute value can be empty if no VRDE extension
7681	pack is installed.
7682
7683	For details about VirtualBox Remote Desktop Extension and how to
7684	implement one, please refer to the VirtualBox SDK.
7685	</desc>
7686	</attribute>
7687
7688	<attribute name="LogHistoryCount" type="unsigned long">
7689	<desc>
7690	This value specifies how many old release log files are kept.
7691	</desc>
7692	</attribute>
7693
7694	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7695	<desc>This value hold the default audio driver for the current
7696	system.</desc>
7697	</attribute>
7698
7699
7700	<method name="getMaxNetworkAdapters">
7701	<desc>
7702	Maximum total number of network adapters associated with every
7703	<link to="IMachine"/> instance.
7704	</desc>
7705
7706	<param name="chipset" type="ChipsetType" dir="in">
7707	<desc>The chipset type to get the value for.</desc>
7708	</param>
7709
7710
7711	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7712	<desc>The maximum total number of network adapters allowed.</desc>
7713	</param>
7714
7715	</method>
7716
7717	<method name="getMaxNetworkAdaptersOfType">
7718	<desc>
7719	Maximum number of network adapters of a given attachment type,
7720	associated with every <link to="IMachine"/> instance.
7721	</desc>
7722
7723	<param name="chipset" type="ChipsetType" dir="in">
7724	<desc>The chipset type to get the value for.</desc>
7725	</param>
7726
7727	<param name="type" type="NetworkAttachmentType" dir="in">
7728	<desc>Type of attachment.</desc>
7729	</param>
7730
7731	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7732	<desc>The maximum number of network adapters allowed for
7733	particular chipset and attachment type.</desc>
7734	</param>
7735
7736	</method>
7737
7738
7739	<method name="getMaxDevicesPerPortForStorageBus">
7740	<desc>Returns the maximum number of devices which can be attached to a port
7741	for the given storage bus.</desc>
7742
7743	<param name="bus" type="StorageBus" dir="in">
7744	<desc>The storage bus type to get the value for.</desc>
7745	</param>
7746
7747	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7748	<desc>The maximum number of devices which can be attached to the port for the given
7749	storage bus.</desc>
7750	</param>
7751	</method>
7752
7753	<method name="getMinPortCountForStorageBus">
7754	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7755
7756	<param name="bus" type="StorageBus" dir="in">
7757	<desc>The storage bus type to get the value for.</desc>
7758	</param>
7759
7760	<param name="minPortCount" type="unsigned long" dir="return">
7761	<desc>The minimum number of ports for the given storage bus.</desc>
7762	</param>
7763	</method>
7764
7765	<method name="getMaxPortCountForStorageBus">
7766	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7767
7768	<param name="bus" type="StorageBus" dir="in">
7769	<desc>The storage bus type to get the value for.</desc>
7770	</param>
7771
7772	<param name="maxPortCount" type="unsigned long" dir="return">
7773	<desc>The maximum number of ports for the given storage bus.</desc>
7774	</param>
7775	</method>
7776
7777	<method name="getMaxInstancesOfStorageBus">
7778	<desc>Returns the maximum number of storage bus instances which
7779	can be configured for each VM. This corresponds to the number of
7780	storage controllers one can have. Value may depend on chipset type
7781	used.</desc>
7782
7783	<param name="chipset" type="ChipsetType" dir="in">
7784	<desc>The chipset type to get the value for.</desc>
7785	</param>
7786
7787	<param name="bus" type="StorageBus" dir="in">
7788	<desc>The storage bus type to get the value for.</desc>
7789	</param>
7790
7791	<param name="maxInstances" type="unsigned long" dir="return">
7792	<desc>The maximum number of instances for the given storage bus.</desc>
7793	</param>
7794	</method>
7795
7796	<method name="getDeviceTypesForStorageBus">
7797	<desc>Returns list of all the supported device types
7798	(<link to="DeviceType"/>) for the given type of storage
7799	bus.</desc>
7800
7801	<param name="bus" type="StorageBus" dir="in">
7802	<desc>The storage bus type to get the value for.</desc>
7803	</param>
7804
7805	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7806	<desc>The list of all supported device types for the given storage bus.</desc>
7807	</param>
7808	</method>
7809
7810	<method name="getDefaultIoCacheSettingForStorageController">
7811	<desc>Returns the default I/O cache setting for the
7812	given storage controller</desc>
7813
7814	<param name="controllerType" type="StorageControllerType" dir="in">
7815	<desc>The storage controller to the setting for.</desc>
7816	</param>
7817
7818	<param name="enabled" type="boolean" dir="return">
7819	<desc>Returned flag indicating the default value</desc>
7820	</param>
7821	</method>
7822	</interface>
7823
7824	<!--
7825	// IGuest
7826	/////////////////////////////////////////////////////////////////////////
7827	-->
7828
7829	<interface
7830	name="IGuestOSType" extends="$unknown"
7831	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7832	wsmap="struct"
7833	>
7834	<desc>
7835	</desc>
7836
7837	<attribute name="familyId" type="wstring" readonly="yes">
7838	<desc>Guest OS family identifier string.</desc>
7839	</attribute>
7840
7841	<attribute name="familyDescription" type="wstring" readonly="yes">
7842	<desc>Human readable description of the guest OS family.</desc>
7843	</attribute>
7844
7845	<attribute name="id" type="wstring" readonly="yes">
7846	<desc>Guest OS identifier string.</desc>
7847	</attribute>
7848
7849	<attribute name="description" type="wstring" readonly="yes">
7850	<desc>Human readable description of the guest OS.</desc>
7851	</attribute>
7852
7853	<attribute name="is64Bit" type="boolean" readonly="yes">
7854	<desc>Returns @c true if the given OS is 64-bit</desc>
7855	</attribute>
7856
7857	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7858	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7859	</attribute>
7860
7861	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7862	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7863	</attribute>
7864
7865	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7866	<desc>Recommended RAM size in Megabytes.</desc>
7867	</attribute>
7868
7869	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7870	<desc>Recommended video RAM size in Megabytes.</desc>
7871	</attribute>
7872
7873	<attribute name="recommendedHDD" type="long long" readonly="yes">
7874	<desc>Recommended hard disk size in bytes.</desc>
7875	</attribute>
7876
7877	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7878	<desc>Returns recommended network adapter for this OS type.</desc>
7879	</attribute>
7880
7881	<attribute name="recommendedPae" type="boolean" readonly="yes">
7882	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7883	</attribute>
7884
7885	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7886	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7887	</attribute>
7888
7889	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7890	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7891	</attribute>
7892
7893	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7894	<desc>Recommended storage controller type for HD drives.</desc>
7895	</attribute>
7896
7897	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7898	<desc>Recommended storage bus type for HD drives.</desc>
7899	</attribute>
7900
7901	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7902	<desc>Recommended firmware type.</desc>
7903	</attribute>
7904
7905	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7906	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7907	</attribute>
7908
7909	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7910	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7911	</attribute>
7912
7913	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7914	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7915	</attribute>
7916
7917	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7918	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7919	</attribute>
7920
7921	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7922	<desc>Recommended chipset type.</desc>
7923	</attribute>
7924
7925	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7926	<desc>Recommended audio type.</desc>
7927	</attribute>
7928
7929	</interface>
7930
7931	<enum
7932	name="AdditionsFacilityType"
7933	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
7934	>
7935	<desc>
7936	Guest Additions facility IDs.
7937	</desc>
7938
7939	<const name="None" value="0">
7940	<desc>No/invalid facility.</desc>
7941	</const>
7942	<const name="VBoxGuestDriver" value="20">
7943	<desc>VirtualBox base driver (VBoxGuest).</desc>
7944	</const>
7945	<const name="VBoxService" value="100">
7946	<desc>VirtualBox system service (VBoxService).</desc>
7947	</const>
7948	<const name="VBoxTrayClient" value="101">
7949	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7950	</const>
7951	<const name="Seamless" value="1000">
7952	<desc>Seamless guest desktop integration.</desc>
7953	</const>
7954	<const name="Graphics" value="1100">
7955	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
7956	are not immediately acted on and guest display resizes are probably not initiated by
7957	the guest additions.
7958	</desc>
7959	</const>
7960	<const name="All" value="2147483646">
7961	<desc>All facilities selected.</desc>
7962	</const>
7963	</enum>
7964
7965	<enum
7966	name="AdditionsFacilityClass"
7967	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
7968	>
7969	<desc>
7970	Guest Additions facility classes.
7971	</desc>
7972
7973	<const name="None" value="0">
7974	<desc>No/invalid class.</desc>
7975	</const>
7976	<const name="Driver" value="10">
7977	<desc>Driver.</desc>
7978	</const>
7979	<const name="Service" value="30">
7980	<desc>System service.</desc>
7981	</const>
7982	<const name="Program" value="50">
7983	<desc>Program.</desc>
7984	</const>
7985	<const name="Feature" value="100">
7986	<desc>Feature.</desc>
7987	</const>
7988	<const name="ThirdParty" value="999">
7989	<desc>Third party.</desc>
7990	</const>
7991	<const name="All" value="2147483646">
7992	<desc>All facility classes selected.</desc>
7993	</const>
7994	</enum>
7995
7996	<enum
7997	name="AdditionsFacilityStatus"
7998	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
7999	>
8000	<desc>
8001	Guest Additions facility states.
8002	</desc>
8003
8004	<const name="Inactive" value="0">
8005	<desc>Facility is not active.</desc>
8006	</const>
8007	<const name="Paused" value="1">
8008	<desc>Facility has been paused.</desc>
8009	</const>
8010	<const name="PreInit" value="20">
8011	<desc>Facility is preparing to initialize.</desc>
8012	</const>
8013	<const name="Init" value="30">
8014	<desc>Facility is initializing.</desc>
8015	</const>
8016	<const name="Active" value="50">
8017	<desc>Facility is up and running.</desc>
8018	</const>
8019	<const name="Terminating" value="100">
8020	<desc>Facility is shutting down.</desc>
8021	</const>
8022	<const name="Terminated" value="101">
8023	<desc>Facility successfully shut down.</desc>
8024	</const>
8025	<const name="Failed" value="800">
8026	<desc>Facility failed to start.</desc>
8027	</const>
8028	<const name="Unknown" value="999">
8029	<desc>Facility status is unknown.</desc>
8030	</const>
8031	</enum>
8032
8033	<interface
8034	name="IAdditionsFacility" extends="$unknown"
8035	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8036	wsmap="struct"
8037	>
8038	<desc>
8039	Structure representing a Guest Additions facility.
8040	</desc>
8041
8042	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8043	<desc>The class this facility is part of.</desc>
8044	</attribute>
8045
8046	<attribute name="lastUpdated" type="long long" readonly="yes">
8047	<desc>
8048	Time stamp of the last status update,
8049	in milliseconds since 1970-01-01 UTC.
8050	</desc>
8051	</attribute>
8052
8053	<attribute name="name" type="wstring" readonly="yes">
8054	<desc>The facility's friendly name.</desc>
8055	</attribute>
8056
8057	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8058	<desc>The current status.</desc>
8059	</attribute>
8060
8061	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8062	<desc>The facility's type ID.</desc>
8063	</attribute>
8064	</interface>
8065
8066	<enum
8067	name="AdditionsRunLevelType"
8068	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8069	>
8070	<desc>
8071	Guest Additions run level type.
8072	</desc>
8073
8074	<const name="None" value="0">
8075	<desc>Guest Additions are not loaded.</desc>
8076	</const>
8077	<const name="System" value="1">
8078	<desc>Guest drivers are loaded.</desc>
8079	</const>
8080	<const name="Userland" value="2">
8081	<desc>Common components (such as application services) are loaded.</desc>
8082	</const>
8083	<const name="Desktop" value="3">
8084	<desc>Per-user desktop components are loaded.</desc>
8085	</const>
8086	</enum>
8087
8088	<enum
8089	name="AdditionsUpdateFlag"
8090	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8091	>
8092	<desc>
8093	Guest Additions update flags.
8094	</desc>
8095
8096	<const name="None" value="0">
8097	<desc>No flag set.</desc>
8098	</const>
8099	<const name="WaitForUpdateStartOnly" value="1">
8100	<desc>Only wait for the update process being started and do not
8101	wait while peforming the actual update.</desc>
8102	</const>
8103	</enum>
8104
8105	<enum
8106	name="ExecuteProcessFlag"
8107	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
8108	>
8109	<desc>
8110	Guest process execution flags.
8111	</desc>
8112
8113	<const name="None" value="0">
8114	<desc>No flag set.</desc>
8115	</const>
8116
8117	<const name="WaitForProcessStartOnly" value="1">
8118	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8119	process itself then uses an infinite timeout.</desc>
8120	</const>
8121
8122	<const name="IgnoreOrphanedProcesses" value="2">
8123	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8124	</const>
8125
8126	<const name="Hidden" value="4">
8127	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8128	</const>
8129	</enum>
8130
8131	<enum
8132	name="ExecuteProcessStatus"
8133	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8134	>
8135	<desc>
8136	Guest process execution status.
8137	</desc>
8138
8139	<const name="Undefined" value="0">
8140	<desc>Process is in an undefined state.</desc>
8141	</const>
8142
8143	<const name="Started" value="1">
8144	<desc>Process has been started.</desc>
8145	</const>
8146
8147	<const name="TerminatedNormally" value="2">
8148	<desc>Process terminated normally.</desc>
8149	</const>
8150
8151	<const name="TerminatedSignal" value="3">
8152	<desc>Process terminated via signal.</desc>
8153	</const>
8154
8155	<const name="TerminatedAbnormally" value="4">
8156	<desc>Process terminated abnormally.</desc>
8157	</const>
8158
8159	<const name="TimedOutKilled" value="5">
8160	<desc>Process timed out and was killed.</desc>
8161	</const>
8162
8163	<const name="TimedOutAbnormally" value="6">
8164	<desc>Process timed out and was not killed successfully.</desc>
8165	</const>
8166
8167	<const name="Down" value="7">
8168	<desc>Service/OS is stopping, process was killed.</desc>
8169	</const>
8170
8171	<const name="Error" value="8">
8172	<desc>Something went wrong (error code in flags).</desc>
8173	</const>
8174	</enum>
8175
8176	<enum
8177	name="ProcessInputFlag"
8178	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8179	>
8180	<desc>
8181	Guest process input flags.
8182	</desc>
8183
8184	<const name="None" value="0">
8185	<desc>No flag set.</desc>
8186	</const>
8187
8188	<const name="EndOfFile" value="1">
8189	<desc>End of file (input) reached.</desc>
8190	</const>
8191	</enum>
8192
8193	<enum
8194	name="ProcessOutputFlag"
8195	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8196	>
8197	<desc>
8198	Guest process output flags for specifying which
8199	type of output to retrieve.
8200	</desc>
8201
8202	<const name="None" value="0">
8203	<desc>No flags set. Get output from stdout.</desc>
8204	</const>
8205
8206	<const name="StdErr" value="1">
8207	<desc>Get output from stderr.</desc>
8208	</const>
8209	</enum>
8210
8211	<enum
8212	name="CopyFileFlag"
8213	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8214	>
8215	<desc>
8216	Host/Guest copy flags. At the moment none of these flags
8217	are implemented.
8218	</desc>
8219
8220	<const name="None" value="0">
8221	<desc>No flag set.</desc>
8222	</const>
8223
8224	<const name="Recursive" value="1">
8225	<desc>Copy directories recursively.</desc>
8226	</const>
8227
8228	<const name="Update" value="2">
8229	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8230	</const>
8231
8232	<const name="FollowLinks" value="4">
8233	<desc>Follow symbolic links.</desc>
8234	</const>
8235	</enum>
8236
8237	<enum
8238	name="CreateDirectoryFlag"
8239	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
8240	>
8241	<desc>
8242	Directory creation flags.
8243	</desc>
8244
8245	<const name="None" value="0">
8246	<desc>No flag set.</desc>
8247	</const>
8248
8249	<const name="Parents" value="1">
8250	<desc>No error if existing, make parent directories as needed.</desc>
8251	</const>
8252	</enum>
8253
8254	<interface
8255	name="IGuest" extends="$unknown"
8256	uuid="4e78f7dd-8ca1-47e5-a344-5207f793df71"
8257	wsmap="managed"
8258	>
8259	<desc>
8260	The IGuest interface represents information about the operating system
8261	running inside the virtual machine. Used in
8262	<link to="IConsole::guest"/>.
8263
8264	IGuest provides information about the guest operating system, whether
8265	Guest Additions are installed and other OS-specific virtual machine
8266	properties.
8267	</desc>
8268
8269	<attribute name="OSTypeId" type="wstring" readonly="yes">
8270	<desc>
8271	Identifier of the Guest OS type as reported by the Guest
8272	Additions.
8273	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8274	an IGuestOSType object representing details about the given
8275	Guest OS type.
8276	<note>
8277	If Guest Additions are not installed, this value will be
8278	the same as <link to="IMachine::OSTypeId"/>.
8279	</note>
8280	</desc>
8281	</attribute>
8282
8283	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8284	<desc>
8285	Current run level of the Guest Additions.
8286	</desc>
8287	</attribute>
8288
8289	<attribute name="additionsVersion" type="wstring" readonly="yes">
8290	<desc>
8291	Version of the Guest Additions including the revision (3 decimal numbers
8292	separated by dots + revision number) installed on the guest or empty
8293	when the Additions are not installed.
8294	</desc>
8295	</attribute>
8296
8297	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8298	<desc>
8299	Array of current known facilities. Only returns facilities where a status is known,
8300	e.g. facilities with an unknown status will not be returned.
8301	</desc>
8302	</attribute>
8303
8304	<attribute name="memoryBalloonSize" type="unsigned long">
8305	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8306	</attribute>
8307
8308	<attribute name="statisticsUpdateInterval" type="unsigned long">
8309	<desc>Interval to update guest statistics in seconds.</desc>
8310	</attribute>
8311
8312	<method name="internalGetStatistics">
8313	<desc>
8314	Internal method; do not use as it might change at any time.
8315	</desc>
8316	<param name="cpuUser" type="unsigned long" dir="out">
8317	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8318	</param>
8319	<param name="cpuKernel" type="unsigned long" dir="out">
8320	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8321	</param>
8322	<param name="cpuIdle" type="unsigned long" dir="out">
8323	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8324	</param>
8325	<param name="memTotal" type="unsigned long" dir="out">
8326	<desc>Total amount of physical guest RAM.</desc>
8327	</param>
8328	<param name="memFree" type="unsigned long" dir="out">
8329	<desc>Free amount of physical guest RAM.</desc>
8330	</param>
8331	<param name="memBalloon" type="unsigned long" dir="out">
8332	<desc>Amount of ballooned physical guest RAM.</desc>
8333	</param>
8334	<param name="memShared" type="unsigned long" dir="out">
8335	<desc>Amount of shared physical guest RAM.</desc>
8336	</param>
8337	<param name="memCache" type="unsigned long" dir="out">
8338	<desc>Total amount of guest (disk) cache memory.</desc>
8339	</param>
8340	<param name="pagedTotal" type="unsigned long" dir="out">
8341	<desc>Total amount of space in the page file.</desc>
8342	</param>
8343	<param name="memAllocTotal" type="unsigned long" dir="out">
8344	<desc>Total amount of memory allocated by the hypervisor.</desc>
8345	</param>
8346	<param name="memFreeTotal" type="unsigned long" dir="out">
8347	<desc>Total amount of free memory available in the hypervisor.</desc>
8348	</param>
8349	<param name="memBalloonTotal" type="unsigned long" dir="out">
8350	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8351	</param>
8352	<param name="memSharedTotal" type="unsigned long" dir="out">
8353	<desc>Total amount of shared memory in the hypervisor.</desc>
8354	</param>
8355	</method>
8356
8357	<method name="getFacilityStatus">
8358	<desc>
8359	Get the current status of a Guest Additions facility.
8360	</desc>
8361	<param name="facility" type="AdditionsFacilityType" dir="in">
8362	<desc>Facility to check status for.</desc>
8363	</param>
8364	<param name="timestamp" type="long long" dir="out">
8365	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8366	</param>
8367	<param name="status" type="AdditionsFacilityStatus" dir="return">
8368	<desc>The current (latest) facility status.</desc>
8369	</param>
8370	</method>
8371
8372	<method name="getAdditionsStatus">
8373	<desc>
8374	Retrieve the current status of a certain Guest Additions run level.
8375
8376	<result name="VBOX_E_NOT_SUPPORTED">
8377	Wrong status level specified.
8378	</result>
8379
8380	</desc>
8381	<param name="level" type="AdditionsRunLevelType" dir="in">
8382	<desc>Status level to check</desc>
8383	</param>
8384	<param name="active" type="boolean" dir="return">
8385	<desc>Flag whether the status level has been reached or not</desc>
8386	</param>
8387	</method>
8388
8389	<method name="setCredentials">
8390	<desc>
8391	Store login credentials that can be queried by guest operating
8392	systems with Additions installed. The credentials are transient
8393	to the session and the guest may also choose to erase them. Note
8394	that the caller cannot determine whether the guest operating system
8395	has queried or made use of the credentials.
8396
8397	<result name="VBOX_E_VM_ERROR">
8398	VMM device is not available.
8399	</result>
8400
8401	</desc>
8402	<param name="userName" type="wstring" dir="in">
8403	<desc>User name string, can be empty</desc>
8404	</param>
8405	<param name="password" type="wstring" dir="in">
8406	<desc>Password string, can be empty</desc>
8407	</param>
8408	<param name="domain" type="wstring" dir="in">
8409	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8410	</param>
8411	<param name="allowInteractiveLogon" type="boolean" dir="in">
8412	<desc>
8413	Flag whether the guest should alternatively allow the user to
8414	interactively specify different credentials. This flag might
8415	not be supported by all versions of the Additions.
8416	</desc>
8417	</param>
8418	</method>
8419
8420	<method name="executeProcess">
8421	<desc>
8422	Executes an existing program inside the guest VM.
8423
8424	<result name="VBOX_E_IPRT_ERROR">
8425	Could not execute process.
8426	</result>
8427
8428	</desc>
8429	<param name="execName" type="wstring" dir="in">
8430	<desc>
8431	Full path name of the command to execute on the guest; the
8432	commands has to exists in the guest VM in order to be executed.
8433	</desc>
8434	</param>
8435	<param name="flags" type="unsigned long" dir="in">
8436	<desc>
8437	<link to="ExecuteProcessFlag"/> flags.
8438	</desc>
8439	</param>
8440	<param name="arguments" type="wstring" safearray="yes" dir="in">
8441	<desc>
8442	Array of arguments passed to the execution command.
8443	</desc>
8444	</param>
8445	<param name="environment" type="wstring" safearray="yes" dir="in">
8446	<desc>
8447	Environment variables that can be set while the command is being
8448	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8449	variable just set its name ("NAME") without a value.
8450	</desc>
8451	</param>
8452	<param name="userName" type="wstring" dir="in">
8453	<desc>
8454	User name under which the command will be executed; has to exist
8455	and have the appropriate rights to execute programs in the VM.
8456	</desc>
8457	</param>
8458	<param name="password" type="wstring" dir="in">
8459	<desc>
8460	Password of the user account specified.
8461	</desc>
8462	</param>
8463	<param name="timeoutMS" type="unsigned long" dir="in">
8464	<desc>
8465	The maximum timeout value (in msec) to wait for finished program
8466	execution. Pass 0 for an infinite timeout.
8467	</desc>
8468	</param>
8469	<param name="pid" type="unsigned long" dir="out">
8470	<desc>
8471	The PID (process ID) of the started command for later reference.
8472	</desc>
8473	</param>
8474	<param name="progress" type="IProgress" dir="return">
8475	<desc>Progress object to track the operation completion.</desc>
8476	</param>
8477	</method>
8478
8479	<method name="getProcessOutput">
8480	<desc>
8481	Retrieves output of a formerly started process.
8482
8483	<result name="VBOX_E_IPRT_ERROR">
8484	Could not retrieve output.
8485	</result>
8486
8487	</desc>
8488	<param name="pid" type="unsigned long" dir="in">
8489	<desc>
8490	Process id returned by earlier executeProcess() call.
8491	</desc>
8492	</param>
8493	<param name="flags" type="unsigned long" dir="in">
8494	<desc>
8495	<link to="ProcessOutputFlag"/> flags.
8496	</desc>
8497	</param>
8498	<param name="timeoutMS" type="unsigned long" dir="in">
8499	<desc>
8500	The maximum timeout value (in msec) to wait for output
8501	data. Pass 0 for an infinite timeout.
8502	</desc>
8503	</param>
8504	<param name="size" type="long long" dir="in">
8505	<desc>
8506	Size in bytes to read in the buffer.
8507	</desc>
8508	</param>
8509	<param name="data" type="octet" dir="return" safearray="yes">
8510	<desc>
8511	Buffer for retrieving the actual output. A data size of 0 means end of file
8512	if the requested size was not 0. This is the unprocessed
8513	output data, i.e. the line ending style depends on the platform of
8514	the system the server is running on.
8515	</desc>
8516	</param>
8517	</method>
8518
8519	<method name="getProcessStatus">
8520	<desc>
8521	Retrieves status, exit code and the exit reason of a formerly started process.
8522
8523	<result name="VBOX_E_IPRT_ERROR">
8524	Process with specified PID was not found.
8525	</result>
8526
8527	</desc>
8528	<param name="pid" type="unsigned long" dir="in">
8529	<desc>
8530	Process id returned by earlier executeProcess() call.
8531	</desc>
8532	</param>
8533	<param name="exitcode" type="unsigned long" dir="out">
8534	<desc>
8535	The exit code (if available).
8536	</desc>
8537	</param>
8538	<param name="flags" type="unsigned long" dir="out">
8539	<desc>
8540	Additional flags of process status. Not used at the moment and
8541	must be set to 0.
8542	</desc>
8543	</param>
8544	<param name="reason" type="ExecuteProcessStatus" dir="return">
8545	<desc>
8546	The current process status.
8547	</desc>
8548	</param>
8549	</method>
8550
8551	<method name="copyToGuest">
8552	<desc>
8553	Copies files/directories from host to the guest.
8554
8555	<result name="VBOX_E_IPRT_ERROR">
8556	Error while copying.
8557	</result>
8558
8559	</desc>
8560	<param name="source" type="wstring" dir="in">
8561	<desc>
8562	Source file on the host to copy.
8563	</desc>
8564	</param>
8565	<param name="dest" type="wstring" dir="in">
8566	<desc>
8567	Destination path on the guest.
8568	</desc>
8569	</param>
8570	<param name="userName" type="wstring" dir="in">
8571	<desc>
8572	User name under which the copy command will be executed; the
8573	user has to exist and have the appropriate rights to write to
8574	the destination path.
8575	</desc>
8576	</param>
8577	<param name="password" type="wstring" dir="in">
8578	<desc>
8579	Password of the user account specified.
8580	</desc>
8581	</param>
8582	<param name="flags" type="unsigned long" dir="in">
8583	<desc>
8584	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8585	</desc>
8586	</param>
8587	<param name="progress" type="IProgress" dir="return">
8588	<desc>Progress object to track the operation completion.</desc>
8589	</param>
8590	</method>
8591
8592	<method name="createDirectory">
8593	<desc>
8594	Creates a directory on the guest.
8595
8596	<result name="VBOX_E_IPRT_ERROR">
8597	Error while creating directory.
8598	</result>
8599
8600	</desc>
8601	<param name="directory" type="wstring" dir="in">
8602	<desc>
8603	Directory to create.
8604	</desc>
8605	</param>
8606	<param name="userName" type="wstring" dir="in">
8607	<desc>
8608	User name under which the directory creation will be executed; the
8609	user has to exist and have the appropriate rights to create the
8610	desired directory.
8611	</desc>
8612	</param>
8613	<param name="password" type="wstring" dir="in">
8614	<desc>
8615	Password of the user account specified.
8616	</desc>
8617	</param>
8618	<param name="mode" type="unsigned long" dir="in">
8619	<desc>
8620	File mode.
8621	</desc>
8622	</param>
8623	<param name="flags" type="unsigned long" dir="in">
8624	<desc>
8625	<link to="CreateDirectoryFlag"/> flags.
8626	</desc>
8627	</param>
8628	<param name="progress" type="IProgress" dir="return">
8629	<desc>Progress object to track the operation completion.</desc>
8630	</param>
8631	</method>
8632
8633	<method name="setProcessInput">
8634	<desc>
8635	Sends input into a formerly started process.
8636
8637	<result name="VBOX_E_IPRT_ERROR">
8638	Could not send input.
8639	</result>
8640
8641	</desc>
8642	<param name="pid" type="unsigned long" dir="in">
8643	<desc>
8644	Process id returned by earlier executeProcess() call.
8645	</desc>
8646	</param>
8647	<param name="flags" type="unsigned long" dir="in">
8648	<desc>
8649	<link to="ProcessInputFlag"/> flags.
8650	</desc>
8651	</param>
8652	<param name="timeoutMS" type="unsigned long" dir="in">
8653	<desc>
8654	The maximum timeout value (in msec) to wait for getting the
8655	data transfered to the guest. Pass 0 for an infinite timeout.
8656	</desc>
8657	</param>
8658	<param name="data" type="octet" dir="in" safearray="yes">
8659	<desc>
8660	Buffer of input data to send to the started process to.
8661	</desc>
8662	</param>
8663	<param name="written" type="unsigned long" dir="return">
8664	<desc>
8665	Number of bytes written.
8666	</desc>
8667	</param>
8668	</method>
8669
8670	<method name="updateGuestAdditions">
8671	<desc>
8672	Updates already installed Guest Additions in a VM
8673	(Windows guests only).
8674
8675	<result name="VBOX_E_IPRT_ERROR">
8676	Error while updating.
8677	</result>
8678
8679	</desc>
8680	<param name="source" type="wstring" dir="in">
8681	<desc>
8682	Path to the Guest Additions .ISO file to use for the upate.
8683	</desc>
8684	</param>
8685	<param name="flags" type="unsigned long" dir="in">
8686	<desc>
8687	<link to="AdditionsUpdateFlag"/> flags.
8688	</desc>
8689	</param>
8690	<param name="progress" type="IProgress" dir="return">
8691	<desc>Progress object to track the operation completion.</desc>
8692	</param>
8693	</method>
8694
8695	</interface>
8696
8697
8698	<!--
8699	// IProgress
8700	/////////////////////////////////////////////////////////////////////////
8701	-->
8702
8703	<interface
8704	name="IProgress" extends="$unknown"
8705	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
8706	wsmap="managed"
8707	>
8708	<desc>
8709	The IProgress interface is used to track and control
8710	asynchronous tasks within VirtualBox.
8711
8712	An instance of this is returned every time VirtualBox starts
8713	an asynchronous task (in other words, a separate thread) which
8714	continues to run after a method call returns. For example,
8715	<link to="IConsole::saveState" />, which saves the state of
8716	a running virtual machine, can take a long time to complete.
8717	To be able to display a progress bar, a user interface such as
8718	the VirtualBox graphical user interface can use the IProgress
8719	object returned by that method.
8720
8721	Note that IProgress is a "read-only" interface in the sense
8722	that only the VirtualBox internals behind the Main API can
8723	create and manipulate progress objects, whereas client code
8724	can only use the IProgress object to monitor a task's
8725	progress and, if <link to="#cancelable" /> is @c true,
8726	cancel the task by calling <link to="#cancel" />.
8727
8728	A task represented by IProgress consists of either one or
8729	several sub-operations that run sequentially, one by one (see
8730	<link to="#operation" /> and <link to="#operationCount" />).
8731	Every operation is identified by a number (starting from 0)
8732	and has a separate description.
8733
8734	You can find the individual percentage of completion of the current
8735	operation in <link to="#operationPercent" /> and the
8736	percentage of completion of the task as a whole
8737	in <link to="#percent" />.
8738
8739	Similarly, you can wait for the completion of a particular
8740	operation via <link to="#waitForOperationCompletion" /> or
8741	for the completion of the whole task via
8742	<link to="#waitForCompletion" />.
8743	</desc>
8744
8745	<attribute name="id" type="uuid" mod="string" readonly="yes">
8746	<desc>ID of the task.</desc>
8747	</attribute>
8748
8749	<attribute name="description" type="wstring" readonly="yes">
8750	<desc>Description of the task.</desc>
8751	</attribute>
8752
8753	<attribute name="initiator" type="$unknown" readonly="yes">
8754	<desc>Initiator of the task.</desc>
8755	</attribute>
8756
8757	<attribute name="cancelable" type="boolean" readonly="yes">
8758	<desc>Whether the task can be interrupted.</desc>
8759	</attribute>
8760
8761	<attribute name="percent" type="unsigned long" readonly="yes">
8762	<desc>
8763	Current progress value of the task as a whole, in percent.
8764	This value depends on how many operations are already complete.
8765	Returns 100 if <link to="#completed" /> is @c true.
8766	</desc>
8767	</attribute>
8768
8769	<attribute name="timeRemaining" type="long" readonly="yes">
8770	<desc>
8771	Estimated remaining time until the task completes, in
8772	seconds. Returns 0 once the task has completed; returns -1
8773	if the remaining time cannot be computed, in particular if
8774	the current progress is 0.
8775
8776	Even if a value is returned, the estimate will be unreliable
8777	for low progress values. It will become more reliable as the
8778	task progresses; it is not recommended to display an ETA
8779	before at least 20% of a task have completed.
8780	</desc>
8781	</attribute>
8782
8783	<attribute name="completed" type="boolean" readonly="yes">
8784	<desc>Whether the task has been completed.</desc>
8785	</attribute>
8786
8787	<attribute name="canceled" type="boolean" readonly="yes">
8788	<desc>Whether the task has been canceled.</desc>
8789	</attribute>
8790
8791	<attribute name="resultCode" type="long" readonly="yes">
8792	<desc>
8793	Result code of the progress task.
8794	Valid only if <link to="#completed"/> is @c true.
8795	</desc>
8796	</attribute>
8797
8798	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8799	<desc>
8800	Extended information about the unsuccessful result of the
8801	progress operation. May be @c null if no extended information
8802	is available.
8803	Valid only if <link to="#completed"/> is @c true and
8804	<link to="#resultCode"/> indicates a failure.
8805	</desc>
8806	</attribute>
8807
8808	<attribute name="operationCount" type="unsigned long" readonly="yes">
8809	<desc>
8810	Number of sub-operations this task is divided into.
8811	Every task consists of at least one suboperation.
8812	</desc>
8813	</attribute>
8814
8815	<attribute name="operation" type="unsigned long" readonly="yes">
8816	<desc>Number of the sub-operation being currently executed.</desc>
8817	</attribute>
8818
8819	<attribute name="operationDescription" type="wstring" readonly="yes">
8820	<desc>
8821	Description of the sub-operation being currently executed.
8822	</desc>
8823	</attribute>
8824
8825	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8826	<desc>Progress value of the current sub-operation only, in percent.</desc>
8827	</attribute>
8828
8829	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8830	<desc>Weight value of the current sub-operation only.</desc>
8831	</attribute>
8832
8833	<attribute name="timeout" type="unsigned long">
8834	<desc>
8835	When non-zero, this specifies the number of milliseconds after which
8836	the operation will automatically be canceled. This can only be set on
8837	cancelable objects.
8838	</desc>
8839	</attribute>
8840
8841	<method name="setCurrentOperationProgress">
8842	<desc>Internal method, not to be called externally.</desc>
8843	<param name="percent" type="unsigned long" dir="in" />
8844	</method>
8845	<method name="setNextOperation">
8846	<desc>Internal method, not to be called externally.</desc>
8847	<param name="nextOperationDescription" type="wstring" dir="in" />
8848	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8849	</method>
8850
8851	<method name="waitForCompletion">
8852	<desc>
8853	Waits until the task is done (including all sub-operations)
8854	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8855
8856	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8857	thread are not processed while waiting. Neglecting event queues may
8858	have dire consequences (degrade performance, resource hogs,
8859	deadlocks, etc.), this is specially so for the main thread on
8860	platforms using XPCOM. Callers are adviced wait for short periods
8861	and service their event queues between calls, or to create a worker
8862	thread to do the waiting.
8863
8864	<result name="VBOX_E_IPRT_ERROR">
8865	Failed to wait for task completion.
8866	</result>
8867	</desc>
8868
8869	<param name="timeout" type="long" dir="in">
8870	<desc>
8871	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8872	</desc>
8873	</param>
8874	</method>
8875
8876	<method name="waitForOperationCompletion">
8877	<desc>
8878	Waits until the given operation is done with a given timeout in
8879	milliseconds; specify -1 for an indefinite wait.
8880
8881	See <link to="#waitForCompletion"> for event queue considerations.</link>
8882
8883	<result name="VBOX_E_IPRT_ERROR">
8884	Failed to wait for operation completion.
8885	</result>
8886
8887	</desc>
8888	<param name="operation" type="unsigned long" dir="in">
8889	<desc>
8890	Number of the operation to wait for.
8891	Must be less than <link to="#operationCount"/>.
8892	</desc>
8893	</param>
8894	<param name="timeout" type="long" dir="in">
8895	<desc>
8896	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8897	</desc>
8898	</param>
8899	</method>
8900
8901	<method name="waitForAsyncProgressCompletion">
8902	<desc>
8903	Waits until the other task is completed (including all
8904	sub-operations) and forward all changes from the other progress to
8905	this progress. This means sub-operation number, description, percent
8906	and so on.
8907
8908	You have to take care on setting up at least the same count on
8909	sub-operations in this progress object like there are in the other
8910	progress object.
8911
8912	If the other progress object supports cancel and this object gets any
8913	cancel request (when here enabled as well), it will be forwarded to
8914	the other progress object.
8915
8916	If there is an error in the other progress, this error isn't
8917	automatically transfered to this progress object. So you have to
8918	check any operation error within the other progress object, after
8919	this method returns.
8920	</desc>
8921
8922	<param name="pProgressAsync" type="IProgress" dir="in">
8923	<desc>
8924	The progress object of the asynchrony process.
8925	</desc>
8926	</param>
8927	</method>
8928
8929	<method name="cancel">
8930	<desc>
8931	Cancels the task.
8932	<note>
8933	If <link to="#cancelable"/> is @c false, then this method will fail.
8934	</note>
8935
8936	<result name="VBOX_E_INVALID_OBJECT_STATE">
8937	Operation cannot be canceled.
8938	</result>
8939
8940	</desc>
8941	</method>
8942
8943	</interface>
8944
8945	<!--
8946	// ISnapshot
8947	/////////////////////////////////////////////////////////////////////////
8948	-->
8949
8950	<interface
8951	name="ISnapshot" extends="$unknown"
8952	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8953	wsmap="managed"
8954	>
8955	<desc>
8956	The ISnapshot interface represents a snapshot of the virtual
8957	machine.
8958
8959	Together with the differencing media that are created
8960	when a snapshot is taken, a machine can be brought back to
8961	the exact state it was in when the snapshot was taken.
8962
8963	The ISnapshot interface has no methods, only attributes; snapshots
8964	are controlled through methods of the <link to="IConsole" /> interface
8965	which also manage the media associated with the snapshot.
8966	The following operations exist:
8967
8968	<ul>
8969	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8970	by creating new, empty differencing images for the machine's
8971	media and saving the VM settings and (if the VM is running)
8972	the current VM state in the snapshot.
8973
8974	The differencing images will then receive all data written to
8975	the machine's media, while their parent (base) images
8976	remain unmodified after the snapshot has been taken (see
8977	<link to="IMedium" /> for details about differencing images).
8978	This simplifies restoring a machine to the state of a snapshot:
8979	only the differencing images need to be deleted.
8980
8981	The current machine state is not changed by taking a snapshot
8982	except that <link to="IMachine::currentSnapshot" /> is set to
8983	the newly created snapshot, which is also added to the machine's
8984	snapshots tree.
8985	</li>
8986
8987	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8988	the state of a previous snapshot by deleting the differencing
8989	image of each of the machine's media and setting the machine's
8990	settings and state to the state that was saved in the snapshot (if any).
8991
8992	This destroys the machine's current state. After calling this,
8993	<link to="IMachine::currentSnapshot" /> points to the snapshot
8994	that was restored.
8995	</li>
8996
8997	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8998	without affecting the current machine state.
8999
9000	This does not change the current machine state, but instead frees the
9001	resources allocated when the snapshot was taken: the settings and machine
9002	state file are deleted (if any), and the snapshot's differencing image for
9003	each of the machine's media gets merged with its parent image.
9004
9005	Neither the current machine state nor other snapshots are affected
9006	by this operation, except that parent media will be modified
9007	to contain the disk data associated with the snapshot being deleted.
9008
9009	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9010	attribute is set to the current snapshot's parent or NULL if it
9011	has no parent. Otherwise the attribute is unchanged.
9012	</li>
9013	</ul>
9014
9015	Each snapshot contains a copy of virtual machine's settings (hardware
9016	configuration etc.). This copy is contained in an immutable (read-only)
9017	instance of <link to="IMachine" /> which is available from the snapshot's
9018	<link to="#machine" /> attribute. When restoring the snapshot, these
9019	settings are copied back to the original machine.
9020
9021	In addition, if the machine was running when the
9022	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9023	the current VM state is saved in the snapshot (similarly to what happens
9024	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9025	because when restoring it, the VM will be running.
9026
9027	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9028	the snapshot receives a copy of the execution state file
9029	(<link to="IMachine::stateFilePath"/>).
9030
9031	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9032	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9033	it then contains a so-called "zero execution state", representing a
9034	machine that is powered off.
9035	</desc>
9036
9037	<attribute name="id" type="uuid" mod="string" readonly="yes">
9038	<desc>UUID of the snapshot.</desc>
9039	</attribute>
9040
9041	<attribute name="name" type="wstring">
9042	<desc>Short name of the snapshot.
9043	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9044	be called implicitly.</note>
9045	</desc>
9046	</attribute>
9047
9048	<attribute name="description" type="wstring">
9049	<desc>Optional description of the snapshot.
9050	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9051	be called implicitly.</note>
9052	</desc>
9053	</attribute>
9054
9055	<attribute name="timeStamp" type="long long" readonly="yes">
9056	<desc>
9057	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9058	</desc>
9059	</attribute>
9060
9061	<attribute name="online" type="boolean" readonly="yes">
9062	<desc>
9063	@c true if this snapshot is an online snapshot and @c false otherwise.
9064
9065	When this attribute is @c true, the
9066	<link to="IMachine::stateFilePath"/> attribute of the
9067	<link to="#machine"/> object associated with this snapshot
9068	will point to the saved state file. Otherwise, it will be
9069	an empty string.
9070	</desc>
9071	</attribute>
9072
9073	<attribute name="machine" type="IMachine" readonly="yes">
9074	<desc>
9075	Virtual machine this snapshot is taken on. This object
9076	stores all settings the machine had when taking this snapshot.
9077	<note>
9078	The returned machine object is immutable, i.e. no
9079	any settings can be changed.
9080	</note>
9081	</desc>
9082	</attribute>
9083
9084	<attribute name="parent" type="ISnapshot" readonly="yes">
9085	<desc>
9086	Parent snapshot (a snapshot this one is based on), or
9087	@c null if the snapshot has no parent (i.e. is the first snapshot).
9088	</desc>
9089	</attribute>
9090
9091	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9092	<desc>
9093	Child snapshots (all snapshots having this one as a parent).
9094	By inspecting this attribute starting with a machine's root snapshot
9095	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9096	with a @c null UUID), a machine's snapshots tree can be iterated over.
9097	</desc>
9098	</attribute>
9099
9100	</interface>
9101
9102
9103	<!--
9104	// IMedium
9105	/////////////////////////////////////////////////////////////////////////
9106	-->
9107
9108	<enum
9109	name="MediumState"
9110	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9111	>
9112	<desc>
9113	Virtual medium state.
9114	<see>IMedium</see>
9115	</desc>
9116
9117	<const name="NotCreated" value="0">
9118	<desc>
9119	Associated medium storage does not exist (either was not created yet or
9120	was deleted).
9121	</desc>
9122	</const>
9123	<const name="Created" value="1">
9124	<desc>
9125	Associated storage exists and accessible; this gets set if the
9126	accessibility check performed by <link to="IMedium::refreshState" />
9127	was successful.
9128	</desc>
9129	</const>
9130	<const name="LockedRead" value="2">
9131	<desc>
9132	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9133	no data modification is possible.
9134	</desc>
9135	</const>
9136	<const name="LockedWrite" value="3">
9137	<desc>
9138	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9139	no concurrent data reading or modification is possible.
9140	</desc>
9141	</const>
9142	<const name="Inaccessible" value="4">
9143	<desc>
9144	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9145	not yet been performed, or else, associated medium storage is not
9146	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9147	is empty, in the second case, it describes the error that occurred.
9148	</desc>
9149	</const>
9150	<const name="Creating" value="5">
9151	<desc>
9152	Associated medium storage is being created.
9153	</desc>
9154	</const>
9155	<const name="Deleting" value="6">
9156	<desc>
9157	Associated medium storage is being deleted.
9158	</desc>
9159	</const>
9160	</enum>
9161
9162	<enum
9163	name="MediumType"
9164	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9165	>
9166	<desc>
9167	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9168	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9169	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9170	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9171	</desc>
9172
9173	<const name="Normal" value="0">
9174	<desc>
9175	Normal medium (attached directly or indirectly, preserved
9176	when taking snapshots).
9177	</desc>
9178	</const>
9179	<const name="Immutable" value="1">
9180	<desc>
9181	Immutable medium (attached indirectly, changes are wiped out
9182	the next time the virtual machine is started).
9183	</desc>
9184	</const>
9185	<const name="Writethrough" value="2">
9186	<desc>
9187	Write through medium (attached directly, ignored when
9188	taking snapshots).
9189	</desc>
9190	</const>
9191	<const name="Shareable" value="3">
9192	<desc>
9193	Allow using this medium concurrently by several machines.
9194	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9195	</desc>
9196	</const>
9197	<const name="Readonly" value="4">
9198	<desc>
9199	A readonly medium, which can of course be used by several machines.
9200	<note>Present and accepted since VirtualBox 4.0.</note>
9201	</desc>
9202	</const>
9203	<const name="MultiAttach" value="5">
9204	<desc>
9205	A medium which is is indirectly attached, so that one base medium can
9206	be used for several VMs which have their own differencing medium to
9207	store their modifications. In some sense a variant of Immutable
9208	with unset AutoReset flag in each differencing medium.
9209	<note>Present and accepted since VirtualBox 4.0.</note>
9210	</desc>
9211	</const>
9212	</enum>
9213
9214	<enum
9215	name="MediumVariant"
9216	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9217	>
9218	<desc>
9219	Virtual medium image variant. More than one flag may be set.
9220	<see>IMedium</see>
9221	</desc>
9222
9223	<const name="Standard" value="0">
9224	<desc>
9225	No particular variant requested, results in using the backend default.
9226	</desc>
9227	</const>
9228	<const name="VmdkSplit2G" value="0x01">
9229	<desc>
9230	VMDK image split in chunks of less than 2GByte.
9231	</desc>
9232	</const>
9233	<const name="VmdkStreamOptimized" value="0x04">
9234	<desc>
9235	VMDK streamOptimized image. Special import/export format which is
9236	read-only/append-only.
9237	</desc>
9238	</const>
9239	<const name="VmdkESX" value="0x08">
9240	<desc>
9241	VMDK format variant used on ESX products.
9242	</desc>
9243	</const>
9244	<const name="Fixed" value="0x10000">
9245	<desc>
9246	Fixed image. Only allowed for base images.
9247	</desc>
9248	</const>
9249	<const name="Diff" value="0x20000">
9250	<desc>
9251	Differencing image. Only allowed for child images.
9252	</desc>
9253	</const>
9254	</enum>
9255
9256	<interface
9257	name="IMediumAttachment" extends="$unknown"
9258	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9259	wsmap="struct"
9260	>
9261	<desc>
9262	The IMediumAttachment interface links storage media to virtual machines.
9263	For each medium (<link to="IMedium"/>) which has been attached to a
9264	storage controller (<link to="IStorageController"/>) of a machine
9265	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9266	method, one instance of IMediumAttachment is added to the machine's
9267	<link to="IMachine::mediumAttachments"/> array attribute.
9268
9269	Each medium attachment specifies the storage controller as well as a
9270	port and device number and the IMedium instance representing a virtual
9271	hard disk or floppy or DVD image.
9272
9273	For removable media (DVDs or floppies), there are two additional
9274	options. For one, the IMedium instance can be @c null to represent
9275	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9276	secondly, the medium can be one of the pseudo-media for host drives
9277	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9278
9279	<h3>Attaching Hard Disks</h3>
9280
9281	Hard disks are attached to virtual machines using the
9282	<link to="IMachine::attachDevice"/> method and detached using the
9283	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9284	type (see <link to="IMedium::type" />), hard disks are attached either
9285	<i>directly</i> or <i>indirectly</i>.
9286
9287	When a hard disk is being attached directly, it is associated with the
9288	virtual machine and used for hard disk operations when the machine is
9289	running. When a hard disk is being attached indirectly, a new differencing
9290	hard disk linked to it is implicitly created and this differencing hard
9291	disk is associated with the machine and used for hard disk operations.
9292	This also means that if <link to="IMachine::attachDevice"/> performs
9293	a direct attachment then the same hard disk will be returned in response
9294	to the subsequent <link to="IMachine::getMedium"/> call; however if
9295	an indirect attachment is performed then
9296	<link to="IMachine::getMedium"/> will return the implicitly created
9297	differencing hard disk, not the original one passed to <link
9298	to="IMachine::attachDevice"/>. In detail:
9299
9300	<ul>
9301	<li><b>Normal base</b> hard disks that do not have children (i.e.
9302	differencing hard disks linked to them) and that are not already
9303	attached to virtual machines in snapshots are attached <b>directly</b>.
9304	Otherwise, they are attached <b>indirectly</b> because having
9305	dependent children or being part of the snapshot makes it impossible
9306	to modify hard disk contents without breaking the integrity of the
9307	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9308	quickly determine the kind of the attachment for the given hard
9309	disk. Note that if a normal base hard disk is to be indirectly
9310	attached to a virtual machine with snapshots then a special
9311	procedure called <i>smart attachment</i> is performed (see below).</li>
9312	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9313	they are attached <b>directly</b> if they do not have children and are
9314	not attached to virtual machines in snapshots, and <b>indirectly</b>
9315	otherwise. Note that the smart attachment procedure is never performed
9316	for differencing hard disks.</li>
9317	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9318	they are designed to be non-writable. If an immutable hard disk is
9319	attached to a virtual machine with snapshots then a special
9320	procedure called smart attachment is performed (see below).</li>
9321	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9322	also as designed. This also means that writethrough hard disks cannot
9323	have other hard disks linked to them at all.</li>
9324	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9325	also as designed. This also means that shareable hard disks cannot
9326	have other hard disks linked to them at all. They behave almost
9327	like writethrough hard disks, except that shareable hard disks can
9328	be attached to several virtual machines which are running, allowing
9329	concurrent accesses. You need special cluster software running in
9330	the virtual machines to make use of such disks.</li>
9331	</ul>
9332
9333	Note that the same hard disk, regardless of its type, may be attached to
9334	more than one virtual machine at a time. In this case, the machine that is
9335	started first gains exclusive access to the hard disk and attempts to
9336	start other machines having this hard disk attached will fail until the
9337	first machine is powered down.
9338
9339	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9340	that the given hard disk remains associated with the given machine after a
9341	successful <link to="IMachine::detachDevice"/> call until
9342	<link to="IMachine::saveSettings"/> is called to save all changes to
9343	machine settings to disk. This deferring is necessary to guarantee that
9344	the hard disk configuration may be restored at any time by a call to
9345	<link to="IMachine::discardSettings"/> before the settings
9346	are saved (committed).
9347
9348	Note that if <link to="IMachine::discardSettings"/> is called after
9349	indirectly attaching some hard disks to the machine but before a call to
9350	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9351	all differencing hard disks implicitly created by
9352	<link to="IMachine::attachDevice"/> for these indirect attachments.
9353	Such implicitly created hard disks will also be immediately deleted when
9354	detached explicitly using the <link to="IMachine::detachDevice"/>
9355	call if it is made before <link to="IMachine::saveSettings"/>. This
9356	implicit deletion is safe because newly created differencing hard
9357	disks do not contain any user data.
9358
9359	However, keep in mind that detaching differencing hard disks that were
9360	implicitly created by <link to="IMachine::attachDevice"/>
9361	before the last <link to="IMachine::saveSettings"/> call will
9362	<b>not</b> implicitly delete them as they may already contain some data
9363	(for example, as a result of virtual machine execution). If these hard
9364	disks are no more necessary, the caller can always delete them explicitly
9365	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9366	from this machine by the <link to="IMachine::saveSettings"/> call.
9367
9368	<h3>Smart Attachment</h3>
9369
9370	When normal base or immutable hard disks are indirectly attached to a
9371	virtual machine then some additional steps are performed to make sure the
9372	virtual machine will have the most recent "view" of the hard disk being
9373	attached. These steps include walking through the machine's snapshots
9374	starting from the current one and going through ancestors up to the first
9375	snapshot. Hard disks attached to the virtual machine in all
9376	of the encountered snapshots are checked whether they are descendants of
9377	the given normal base or immutable hard disk. The first found child (which
9378	is the differencing hard disk) will be used instead of the normal base or
9379	immutable hard disk as a parent for creating a new differencing hard disk
9380	that will be actually attached to the machine. And only if no descendants
9381	are found or if the virtual machine does not have any snapshots then the
9382	normal base or immutable hard disk will be used itself as a parent for
9383	this differencing hard disk.
9384
9385	It is easier to explain what smart attachment does using the
9386	following example:
9387	<pre>
9388	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9389
9390	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9391	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9392	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9393	Snapshot 4 (none) Snapshot 4 (none)
9394	CurState (none) CurState (D3->D2.vdi)
9395
9396	NOT
9397	...
9398	CurState (D3->B.vdi)
9399	</pre>
9400	The first column is the virtual machine configuration before the base hard
9401	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9402	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9403	mean that the hard disk that is actually attached to the machine is a
9404	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9405	another hard disk, <tt>B.vdi</tt>.
9406
9407	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9408	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9409	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9410	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9411	it cannot be attached directly and needs an indirect attachment (i.e.
9412	implicit creation of a new differencing hard disk). Due to the smart
9413	attachment procedure, the new differencing hard disk
9414	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9415	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9416	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9417	machine.
9418
9419	Note that if there is more than one descendant hard disk of the given base
9420	hard disk found in a snapshot, and there is an exact device, channel and
9421	bus match, then this exact match will be used. Otherwise, the youngest
9422	descendant will be picked up.
9423
9424	There is one more important aspect of the smart attachment procedure which
9425	is not related to snapshots at all. Before walking through the snapshots
9426	as described above, the backup copy of the current list of hard disk
9427	attachment is searched for descendants. This backup copy is created when
9428	the hard disk configuration is changed for the first time after the last
9429	<link to="IMachine::saveSettings"/> call and used by
9430	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9431	changes. When such a descendant is found in this backup copy, it will be
9432	simply re-attached back, without creating a new differencing hard disk for
9433	it. This optimization is necessary to make it possible to re-attach the
9434	base or immutable hard disk to a different bus, channel or device slot
9435	without losing the contents of the differencing hard disk actually
9436	attached to the machine in place of it.
9437
9438	</desc>
9439
9440	<attribute name="medium" type="IMedium" readonly="yes">
9441	<desc>Medium object associated with this attachment; it
9442	can be @c null for removable devices.</desc>
9443	</attribute>
9444
9445	<attribute name="controller" type="wstring" readonly="yes">
9446	<desc>Name of the storage controller of this attachment; this
9447	refers to one of the controllers in <link to="IMachine::storageControllers" />
9448	by name.</desc>
9449	</attribute>
9450
9451	<attribute name="port" type="long" readonly="yes">
9452	<desc>Port number of this attachment.
9453	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9454	</desc>
9455	</attribute>
9456
9457	<attribute name="device" type="long" readonly="yes">
9458	<desc>Device slot number of this attachment.
9459	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9460	</desc>
9461	</attribute>
9462
9463	<attribute name="type" type="DeviceType" readonly="yes">
9464	<desc>Device type of this attachment.</desc>
9465	</attribute>
9466
9467	<attribute name="passthrough" type="boolean" readonly="yes">
9468	<desc>Pass I/O requests through to a device on the host.</desc>
9469	</attribute>
9470
9471	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9472	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9473	</attribute>
9474
9475	</interface>
9476
9477	<interface
9478	name="IMedium" extends="$unknown"
9479	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9480	wsmap="managed"
9481	>
9482	<desc>
9483	The IMedium interface represents virtual storage for a machine's
9484	hard disks, CD/DVD or floppy drives. It will typically represent
9485	a disk image on the host, for example a VDI or VMDK file representing
9486	a virtual hard disk, or an ISO or RAW file representing virtual
9487	removable media, but can also point to a network location (e.g.
9488	for iSCSI targets).
9489
9490	Instances of IMedium are connected to virtual machines by way of medium
9491	attachments, which link the storage medium to a particular device slot
9492	of a storage controller of the virtual machine.
9493	In the VirtualBox API, virtual storage is therefore always represented
9494	by the following chain of object links:
9495
9496	<ul>
9497	<li><link to="IMachine::storageControllers"/> contains an array of
9498	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9499	these are instances of <link to="IStorageController"/>).</li>
9500	<li><link to="IMachine::mediumAttachments"/> contains an array of
9501	medium attachments (instances of <link to="IMediumAttachment"/>
9502	created by <link to="IMachine::attachDevice" />),
9503	each containing a storage controller from the above array, a
9504	port/device specification, and an instance of IMedium representing
9505	the medium storage (image file).
9506
9507	For removable media, the storage medium is optional; a medium
9508	attachment with no medium represents a CD/DVD or floppy drive
9509	with no medium inserted. By contrast, hard disk attachments
9510	will always have an IMedium object attached.</li>
9511	<li>Each IMedium in turn points to a storage unit (such as a file
9512	on the host computer or a network resource) that holds actual
9513	data. This location is represented by the <link to="#location"/>
9514	attribute.</li>
9515	</ul>
9516
9517	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9518	new hard disk media can be created with the VirtualBox API using the
9519	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
9520	disks (see below) are usually implicitly created by VirtualBox as
9521	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
9522	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
9523	should be created with external tools and then opened from within VirtualBox.
9524
9525	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9526	drive. In that case the <link to="#id" /> attribute contains the UUID of
9527	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9528
9529	<h3>Media registries</h3>
9530
9531	When a medium has been opened or created using one of the aforementioned
9532	APIs, it becomes "known" to VirtualBox. Known media can be attached
9533	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
9534	They also appear in the global
9535	<link to="IVirtualBox::hardDisks" />,
9536	<link to="IVirtualBox::DVDImages" /> and
9537	<link to="IVirtualBox::floppyImages" /> arrays.
9538
9539	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
9540	in the VirtualBox.xml file, which was shared between all machines and made
9541	transporting machines and their media from one host to another difficult.
9542
9543	Starting with VirtualBox 4.0, media are only added to a registry when they are
9544	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
9545	backwards compatibility, which registry a medium is added to depends on which
9546	VirtualBox version created a machine:
9547
9548	<ul>
9549	<li>If the medium has first been attached to a machine which was created by
9550	VirtualBox 4.0 or later, it is added to that machine's media registry in
9551	the machine XML settings file. This way all information about a machine's
9552	media attachments is contained in a single file and can be transported
9553	easily.</li>
9554	<li>For older media attachments (i.e. if the medium was first attached to a
9555	machine which was created with a VirtualBox version before 4.0), media
9556	continue to be registered in the global VirtualBox settings file, for
9557	backwards compatibility.</li>
9558	</ul>
9559
9560	See <link to="IVirtualBox::openMedium" /> for more information.
9561
9562	Media are removed from media registries by the <link to="#close"/>,
9563	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
9564
9565	<h3>Accessibility checks</h3>
9566
9567	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9568	method is called explicitly on a medium. This is done to make the VirtualBox object
9569	ready for serving requests as fast as possible and let the end-user
9570	application decide if it needs to check media accessibility right away or not.
9571
9572	As a result, when VirtualBox starts up (e.g. the VirtualBox
9573	object gets created for the first time), all known media are in the
9574	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9575	attribute is an empty string because no actual accessibility check has
9576	been made yet.
9577
9578	After calling <link to="#refreshState" />, a medium is considered
9579	<i>accessible</i> if its storage unit can be read. In that case, the
9580	<link to="#state"/> attribute has a value of "Created". If the storage
9581	unit cannot be read (for example, because it is located on a disconnected
9582	network resource, or was accidentally deleted outside VirtualBox),
9583	the medium is considered <i>inaccessible</i>, which is indicated by the
9584	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9585	obtained by reading the <link to="#lastAccessError"/> attribute.
9586
9587	<h3>Medium types</h3>
9588
9589	There are five types of medium behavior which are stored in the
9590	<link to="#type"/> attribute (see <link to="MediumType" />) and
9591	which define the medium's behavior with attachments and snapshots.
9592
9593	All media can be also divided in two groups: <i>base</i> media and
9594	<i>differencing</i> media. A base medium contains all sectors of the
9595	medium data in its own storage and therefore can be used independently.
9596	In contrast, a differencing medium is a "delta" to some other medium and
9597	contains only those sectors which differ from that other medium, which is
9598	then called a <i>parent</i>. The differencing medium is said to be
9599	<i>linked to</i> that parent. The parent may be itself a differencing
9600	medium, thus forming a chain of linked media. The last element in that
9601	chain must always be a base medium. Note that several differencing
9602	media may be linked to the same parent medium.
9603
9604	Differencing media can be distinguished from base media by querying the
9605	<link to="#parent"/> attribute: base media do not have parents they would
9606	depend on, so the value of this attribute is always @c null for them.
9607	Using this attribute, it is possible to walk up the medium tree (from the
9608	child medium to its parent). It is also possible to walk down the tree
9609	using the <link to="#children"/> attribute.
9610
9611	Note that the type of all differencing media is "normal"; all other
9612	values are meaningless for them. Base media may be of any type.
9613
9614	<h3>Automatic composition of the file name part</h3>
9615
9616	Another extension to the <link to="IMedium::location"/> attribute is that
9617	there is a possibility to cause VirtualBox to compose a unique value for
9618	the file name part of the location using the UUID of the hard disk. This
9619	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9620	e.g. before the storage unit is created, and works as follows. You set the
9621	value of the <link to="IMedium::location"/> attribute to a location
9622	specification which only contains the path specification but not the file
9623	name part and ends with either a forward slash or a backslash character.
9624	In response, VirtualBox will generate a new UUID for the hard disk and
9625	compose the file name using the following pattern:
9626	<pre>
9627	<path>/{<uuid>}.<ext>
9628	</pre>
9629	where <tt><path></tt> is the supplied path specification,
9630	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9631	is the default extension for the storage format of this hard disk. After
9632	that, you may call any of the methods that create a new hard disk storage
9633	unit and they will use the generated UUID and file name.
9634	</desc>
9635
9636	<attribute name="id" type="uuid" mod="string" readonly="yes">
9637	<desc>
9638	UUID of the medium. For a newly created medium, this value is a randomly
9639	generated UUID.
9640
9641	<note>
9642	For media in one of MediumState_NotCreated, MediumState_Creating or
9643	MediumState_Deleting states, the value of this property is undefined
9644	and will most likely be an empty UUID.
9645	</note>
9646	</desc>
9647	</attribute>
9648
9649	<attribute name="description" type="wstring">
9650	<desc>
9651	Optional description of the medium. For a newly created medium the value
9652	of this attribute is an empty string.
9653
9654	Medium types that don't support this attribute will return E_NOTIMPL in
9655	attempt to get or set this attribute's value.
9656
9657	<note>
9658	For some storage types, reading this attribute may return an outdated
9659	(last known) value when <link to="#state"/> is <link
9660	to="MediumState_Inaccessible"/> or <link
9661	to="MediumState_LockedWrite"/> because the value of this attribute is
9662	stored within the storage unit itself. Also note that changing the
9663	attribute value is not possible in such case, as well as when the
9664	medium is the <link to="MediumState_LockedRead"/> state.
9665	</note>
9666	</desc>
9667	</attribute>
9668
9669	<attribute name="state" type="MediumState" readonly="yes">
9670	<desc>
9671	Returns the current medium state, which is the last state set by
9672	the accessibility check performed by <link to="#refreshState"/>.
9673	If that method has not yet been called on the medium, the state
9674	is "Inaccessible"; as opposed to truly inaccessible media, the
9675	value of <link to="#lastAccessError"/> will be an empty string in
9676	that case.
9677
9678	<note>As of version 3.1, this no longer performs an accessibility check
9679	automatically; call <link to="#refreshState"/> for that.
9680	</note>
9681	</desc>
9682	</attribute>
9683
9684	<attribute name="variant" type="unsigned long" readonly="yes">
9685	<desc>
9686	Returns the storage format variant information for this medium
9687	as a combination of the flags described at <link to="MediumVariant" />.
9688	Before <link to="#refreshState"/> is called this method returns
9689	an undefined value.
9690	</desc>
9691	</attribute>
9692
9693	<attribute name="location" type="wstring">
9694	<desc>
9695	Location of the storage unit holding medium data.
9696
9697	The format of the location string is medium type specific. For medium
9698	types using regular files in a host's file system, the location
9699	string is the full file name.
9700
9701	Some medium types may support changing the storage unit location by
9702	simply changing the value of this property. If this operation is not
9703	supported, the implementation will return E_NOTIMPL in attempt to set
9704	this attribute's value.
9705
9706	When setting a value of the location attribute which is a regular file
9707	in the host's file system, the given file name may be either relative to
9708	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9709	absolute. Note that if the given location specification does not contain
9710	the file extension part then a proper default extension will be
9711	automatically appended by the implementation depending on the medium type.
9712	</desc>
9713	</attribute>
9714
9715	<attribute name="name" type="wstring" readonly="yes">
9716	<desc>
9717	Name of the storage unit holding medium data.
9718
9719	The returned string is a short version of the <link to="#location"/>
9720	attribute that is suitable for representing the medium in situations
9721	where the full location specification is too long (such as lists
9722	and comboboxes in GUI frontends). This string is also used by frontends
9723	to sort the media list alphabetically when needed.
9724
9725	For example, for locations that are regular files in the host's file
9726	system, the value of this attribute is just the file name (+ extension),
9727	without the path specification.
9728
9729	Note that as opposed to the <link to="#location"/> attribute, the name
9730	attribute will not necessary be unique for a list of media of the
9731	given type and format.
9732	</desc>
9733	</attribute>
9734
9735	<attribute name="deviceType" type="DeviceType" readonly="yes">
9736	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9737	medium.</desc>
9738	</attribute>
9739
9740	<attribute name="hostDrive" type="boolean" readonly="yes">
9741	<desc>True if this corresponds to a drive on the host.</desc>
9742	</attribute>
9743
9744	<attribute name="size" type="long long" readonly="yes">
9745	<desc>
9746	Physical size of the storage unit used to hold medium data (in bytes).
9747
9748	<note>
9749	For media whose <link to="#state"/> is <link
9750	to="MediumState_Inaccessible"/>, the value of this property is the
9751	last known size. For <link to="MediumState_NotCreated"/> media,
9752	the returned value is zero.
9753	</note>
9754	</desc>
9755	</attribute>
9756
9757	<attribute name="format" type="wstring" readonly="yes">
9758	<desc>
9759	Storage format of this medium.
9760
9761	The value of this attribute is a string that specifies a backend used
9762	to store medium data. The storage format is defined when you create a
9763	new medium or automatically detected when you open an existing medium,
9764	and cannot be changed later.
9765
9766	The list of all storage formats supported by this VirtualBox
9767	installation can be obtained using
9768	<link to="ISystemProperties::mediumFormats"/>.
9769	</desc>
9770	</attribute>
9771
9772	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9773	<desc>
9774	Storage medium format object corresponding to this medium.
9775
9776	The value of this attribute is a reference to the medium format object
9777	that specifies the backend properties used to store medium data. The
9778	storage format is defined when you create a new medium or automatically
9779	detected when you open an existing medium, and cannot be changed later.
9780
9781	<note>@c null is returned if there is no associated medium format
9782	object. This can e.g. happen for medium objects representing host
9783	drives and other special medium objects.</note>
9784	</desc>
9785	</attribute>
9786
9787	<attribute name="type" type="MediumType">
9788	<desc>
9789	Type (role) of this medium.
9790
9791	The following constraints apply when changing the value of this
9792	attribute:
9793	<ul>
9794	<li>If a medium is attached to a virtual machine (either in the
9795	current state or in one of the snapshots), its type cannot be
9796	changed.
9797	</li>
9798	<li>As long as the medium has children, its type cannot be set
9799	to <link to="MediumType_Writethrough"/>.
9800	</li>
9801	<li>The type of all differencing media is
9802	<link to="MediumType_Normal"/> and cannot be changed.
9803	</li>
9804	</ul>
9805
9806	The type of a newly created or opened medium is set to
9807	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9808	which have a type of <link to="MediumType_Writethrough"/>.
9809	</desc>
9810	</attribute>
9811
9812	<attribute name="parent" type="IMedium" readonly="yes">
9813	<desc>
9814	Parent of this medium (the medium this medium is directly based
9815	on).
9816
9817	Only differencing media have parents. For base (non-differencing)
9818	media, @c null is returned.
9819	</desc>
9820	</attribute>
9821
9822	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9823	<desc>
9824	Children of this medium (all differencing media directly based
9825	on this medium). A @c null array is returned if this medium
9826	does not have any children.
9827	</desc>
9828	</attribute>
9829
9830	<attribute name="base" type="IMedium" readonly="yes">
9831	<desc>
9832	Base medium of this medium.
9833
9834	If this is a differencing medium, its base medium is the medium
9835	the given medium branch starts from. For all other types of media, this
9836	property returns the medium object itself (i.e. the same object this
9837	property is read on).
9838	</desc>
9839	</attribute>
9840
9841	<attribute name="readOnly" type="boolean" readonly="yes">
9842	<desc>
9843	Returns @c true if this medium is read-only and @c false otherwise.
9844
9845	A medium is considered to be read-only when its contents cannot be
9846	modified without breaking the integrity of other parties that depend on
9847	this medium such as its child media or snapshots of virtual machines
9848	where this medium is attached to these machines. If there are no
9849	children and no such snapshots then there is no dependency and the
9850	medium is not read-only.
9851
9852	The value of this attribute can be used to determine the kind of the
9853	attachment that will take place when attaching this medium to a
9854	virtual machine. If the value is @c false then the medium will
9855	be attached directly. If the value is @c true then the medium
9856	will be attached indirectly by creating a new differencing child
9857	medium for that. See the interface description for more information.
9858
9859	Note that all <link to="MediumType_Immutable">Immutable</link> media
9860	are always read-only while all
9861	<link to="MediumType_Writethrough">Writethrough</link> media are
9862	always not.
9863
9864	<note>
9865	The read-only condition represented by this attribute is related to
9866	the medium type and usage, not to the current
9867	<link to="IMedium::state">medium state</link> and not to the read-only
9868	state of the storage unit.
9869	</note>
9870	</desc>
9871	</attribute>
9872
9873	<attribute name="logicalSize" type="long long" readonly="yes">
9874	<desc>
9875	Logical size of this medium (in bytes), as reported to the
9876	guest OS running inside the virtual machine this medium is
9877	attached to. The logical size is defined when the medium is created
9878	and cannot be changed later.
9879
9880	<note>
9881	Reading this property on a differencing medium will return the size
9882	of its <link to="#base"/> medium.
9883	</note>
9884	<note>
9885	For media whose state is <link to="#state"/> is <link
9886	to="MediumState_Inaccessible"/>, the value of this property is the
9887	last known logical size. For <link to="MediumState_NotCreated"/>
9888	media, the returned value is zero.
9889	</note>
9890	</desc>
9891	</attribute>
9892
9893	<attribute name="autoReset" type="boolean">
9894	<desc>
9895	Whether this differencing medium will be automatically reset each
9896	time a virtual machine it is attached to is powered up. This
9897	attribute is automatically set to @c true for the last
9898	differencing image of an "immutable" medium (see
9899	<link to="MediumType" />).
9900
9901	See <link to="#reset"/> for more information about resetting
9902	differencing media.
9903
9904	<note>
9905	Reading this property on a base (non-differencing) medium will
9906	always @c false. Changing the value of this property in this
9907	case is not supported.
9908	</note>
9909
9910	<result name="VBOX_E_NOT_SUPPORTED">
9911	This is not a differencing medium (when changing the attribute
9912	value).
9913	</result>
9914	</desc>
9915	</attribute>
9916
9917	<attribute name="lastAccessError" type="wstring" readonly="yes">
9918	<desc>
9919	Text message that represents the result of the last accessibility
9920	check performed by <link to="#refreshState"/>.
9921
9922	An empty string is returned if the last accessibility check
9923	was successful or has not yet been called. As a result, if
9924	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9925	then <link to="#refreshState"/> has yet to be called; this is the
9926	default value of media after VirtualBox initialization.
9927	A non-empty string indicates a failure and should normally describe
9928	a reason of the failure (for example, a file read error).
9929	</desc>
9930	</attribute>
9931
9932	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9933	<desc>
9934	Array of UUIDs of all machines this medium is attached to.
9935
9936	A @c null array is returned if this medium is not attached to any
9937	machine or to any machine's snapshot.
9938
9939	<note>
9940	The returned array will include a machine even if this medium is not
9941	attached to that machine in the current state but attached to it in
9942	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9943	details.
9944	</note>
9945	</desc>
9946	</attribute>
9947
9948	<method name="setIDs">
9949	<desc>
9950	Changes the UUID and parent UUID for a hard disk medium.
9951	</desc>
9952	<param name="setImageId" type="boolean" dir="in">
9953	<desc>
9954	Select whether a new image UUID is set or not.
9955	</desc>
9956	</param>
9957	<param name="imageId" type="uuid" mod="string" dir="in">
9958	<desc>
9959	New UUID for the image. If an empty string is passed, then a new
9960	UUID is automatically created, provided that @a setImageId is @c true.
9961	Specifying a zero UUID is not allowed.
9962	</desc>
9963	</param>
9964	<param name="setParentId" type="boolean" dir="in">
9965	<desc>
9966	Select whether a new parent UUID is set or not.
9967	</desc>
9968	</param>
9969	<param name="parentId" type="uuid" mod="string" dir="in">
9970	<desc>
9971	New parent UUID for the image. If an empty string is passed, then a
9972	new UUID is automatically created, provided @a setParentId is
9973	@c true. A zero UUID is valid.
9974	</desc>
9975	</param>
9976	<result name="E_INVALIDARG">
9977	Invalid parameter combination.
9978	</result>
9979	<result name="VBOX_E_NOT_SUPPORTED">
9980	Medium is not a hard disk medium.
9981	</result>
9982	</method>
9983
9984	<method name="refreshState">
9985	<desc>
9986	If the current medium state (see <link to="MediumState"/>) is one of
9987	"Created", "Inaccessible" or "LockedRead", then this performs an
9988	accessibility check on the medium and sets the value of the <link to="#state"/>
9989	attribute accordingly; that value is also returned for convenience.
9990
9991	For all other state values, this does not perform a refresh but returns
9992	the state only.
9993
9994	The refresh, if performed, may take a long time (several seconds or even
9995	minutes, depending on the storage unit location and format) because it performs an
9996	accessibility check of the storage unit. This check may cause a significant
9997	delay if the storage unit of the given medium is, for example, a file located
9998	on a network share which is not currently accessible due to connectivity
9999	problems. In that case, the call will not return until a timeout
10000	interval defined by the host OS for this operation expires. For this reason,
10001	it is recommended to never read this attribute on the main UI thread to avoid
10002	making the UI unresponsive.
10003
10004	If the last known state of the medium is "Created" and the accessibility
10005	check fails, then the state would be set to "Inaccessible", and
10006	<link to="#lastAccessError"/> may be used to get more details about the
10007	failure. If the state of the medium is "LockedRead", then it remains the
10008	same, and a non-empty value of <link to="#lastAccessError"/> will
10009	indicate a failed accessibility check in this case.
10010
10011	Note that not all medium states are applicable to all medium types.
10012	</desc>
10013	<param name="state" type="MediumState" dir="return">
10014	<desc>
10015	New medium state.
10016	</desc>
10017	</param>
10018	</method>
10019
10020	<method name="getSnapshotIds">
10021	<desc>
10022	Returns an array of UUIDs of all snapshots of the given machine where
10023	this medium is attached to.
10024
10025	If the medium is attached to the machine in the current state, then the
10026	first element in the array will always be the ID of the queried machine
10027	(i.e. the value equal to the @c machineId argument), followed by
10028	snapshot IDs (if any).
10029
10030	If the medium is not attached to the machine in the current state, then
10031	the array will contain only snapshot IDs.
10032
10033	The returned array may be @c null if this medium is not attached
10034	to the given machine at all, neither in the current state nor in one of
10035	the snapshots.
10036	</desc>
10037	<param name="machineId" type="uuid" mod="string" dir="in">
10038	<desc>
10039	UUID of the machine to query.
10040	</desc>
10041	</param>
10042	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10043	<desc>
10044	Array of snapshot UUIDs of the given machine using this medium.
10045	</desc>
10046	</param>
10047	</method>
10048
10049	<method name="lockRead">
10050	<desc>
10051	Locks this medium for reading.
10052
10053	A read lock is shared: many clients can simultaneously lock the
10054	same medium for reading unless it is already locked for writing (see
10055	<link to="#lockWrite"/>) in which case an error is returned.
10056
10057	When the medium is locked for reading, it cannot be modified
10058	from within VirtualBox. This means that any method that changes
10059	the properties of this medium or contents of the storage unit
10060	will return an error (unless explicitly stated otherwise). That
10061	includes an attempt to start a virtual machine that wants to
10062	write to the the medium.
10063
10064	When the virtual machine is started up, it locks for reading all
10065	media it uses in read-only mode. If some medium cannot be locked
10066	for reading, the startup procedure will fail.
10067	A medium is typically locked for reading while it is used by a running
10068	virtual machine but has a depending differencing image that receives
10069	the actual write operations. This way one base medium can have
10070	multiple child differencing images which can be written to
10071	simultaneously. Read-only media such as DVD and floppy images are
10072	also locked for reading only (so they can be in use by multiple
10073	machines simultaneously).
10074
10075	A medium is also locked for reading when it is the source of a
10076	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10077
10078	The medium locked for reading must be unlocked using the <link
10079	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10080	can be nested and must be followed by the same number of paired
10081	<link to="#unlockRead"/> calls.
10082
10083	This method sets the medium state (see <link to="#state"/>) to
10084	"LockedRead" on success. The medium's previous state must be
10085	one of "Created", "Inaccessible" or "LockedRead".
10086
10087	Locking an inaccessible medium is not an error; this method performs
10088	a logical lock that prevents modifications of this medium through
10089	the VirtualBox API, not a physical file-system lock of the underlying
10090	storage unit.
10091
10092	This method returns the current state of the medium
10093	<i>before</i> the operation.
10094
10095	<result name="VBOX_E_INVALID_OBJECT_STATE">
10096	Invalid medium state (e.g. not created, locked, inaccessible,
10097	creating, deleting).
10098	</result>
10099
10100	</desc>
10101	<param name="state" type="MediumState" dir="return">
10102	<desc>
10103	State of the medium after the operation.
10104	</desc>
10105	</param>
10106	</method>
10107
10108	<method name="unlockRead">
10109	<desc>
10110	Cancels the read lock previously set by <link to="#lockRead"/>.
10111
10112	For both success and failure, this method returns the current state
10113	of the medium <i>after</i> the operation.
10114
10115	See <link to="#lockRead"/> for more details.
10116
10117	<result name="VBOX_E_INVALID_OBJECT_STATE">
10118	Medium not locked for reading.
10119	</result>
10120
10121	</desc>
10122	<param name="state" type="MediumState" dir="return">
10123	<desc>
10124	State of the medium after the operation.
10125	</desc>
10126	</param>
10127	</method>
10128
10129	<method name="lockWrite">
10130	<desc>
10131	Locks this medium for writing.
10132
10133	A write lock, as opposed to <link to="#lockRead"/>, is
10134	exclusive: there may be only one client holding a write lock,
10135	and there may be no read locks while the write lock is held.
10136	As a result, read-locking fails if a write lock is held, and
10137	write-locking fails if either a read or another write lock is held.
10138
10139	When a medium is locked for writing, it cannot be modified
10140	from within VirtualBox, and it is not guaranteed that the values
10141	of its properties are up-to-date. Any method that changes the
10142	properties of this medium or contents of the storage unit will
10143	return an error (unless explicitly stated otherwise).
10144
10145	When a virtual machine is started up, it locks for writing all
10146	media it uses to write data to. If any medium could not be locked
10147	for writing, the startup procedure will fail. If a medium has
10148	differencing images, then while the machine is running, only
10149	the last ("leaf") differencing image is locked for writing,
10150	whereas its parents are locked for reading only.
10151
10152	A medium is also locked for writing when it is the target of a
10153	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10154
10155	The medium locked for writing must be unlocked using the <link
10156	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10157
10158	This method sets the medium state (see <link to="#state"/>) to
10159	"LockedWrite" on success. The medium's previous state must be
10160	either "Created" or "Inaccessible".
10161
10162	Locking an inaccessible medium is not an error; this method performs
10163	a logical lock that prevents modifications of this medium through
10164	the VirtualBox API, not a physical file-system lock of the underlying
10165	storage unit.
10166
10167	For both, success and failure, this method returns the current
10168	state of the medium <i>before</i> the operation.
10169
10170	<result name="VBOX_E_INVALID_OBJECT_STATE">
10171	Invalid medium state (e.g. not created, locked, inaccessible,
10172	creating, deleting).
10173	</result>
10174
10175	</desc>
10176	<param name="state" type="MediumState" dir="return">
10177	<desc>
10178	State of the medium after the operation.
10179	</desc>
10180	</param>
10181	</method>
10182
10183	<method name="unlockWrite">
10184	<desc>
10185	Cancels the write lock previously set by <link to="#lockWrite"/>.
10186
10187	For both success and failure, this method returns the current
10188	state of the medium <i>after</i> the operation.
10189
10190	See <link to="#lockWrite"/> for more details.
10191
10192	<result name="VBOX_E_INVALID_OBJECT_STATE">
10193	Medium not locked for writing.
10194	</result>
10195
10196	</desc>
10197	<param name="state" type="MediumState" dir="return">
10198	<desc>
10199	State of the medium after the operation.
10200	</desc>
10201	</param>
10202	</method>
10203
10204	<method name="close">
10205	<desc>
10206	Closes this medium.
10207
10208	The medium must not be attached to any known virtual machine
10209	and must not have any known child media, otherwise the
10210	operation will fail.
10211
10212	When the medium is successfully closed, it is removed from
10213	the list of registered media, but its storage unit is not
10214	deleted. In particular, this means that this medium can
10215	later be opened again using the <link to="IVirtualBox::openMedium"/>
10216	call.
10217
10218	Note that after this method successfully returns, the given medium
10219	object becomes uninitialized. This means that any attempt
10220	to call any of its methods or attributes will fail with the
10221	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10222
10223	<result name="VBOX_E_INVALID_OBJECT_STATE">
10224	Invalid medium state (other than not created, created or
10225	inaccessible).
10226	</result>
10227	<result name="VBOX_E_OBJECT_IN_USE">
10228	Medium attached to virtual machine.
10229	</result>
10230	<result name="VBOX_E_FILE_ERROR">
10231	Settings file not accessible.
10232	</result>
10233	<result name="VBOX_E_XML_ERROR">
10234	Could not parse the settings file.
10235	</result>
10236
10237	</desc>
10238	</method>
10239
10240	<!-- property methods -->
10241
10242	<method name="getProperty">
10243	<desc>
10244	Returns the value of the custom medium property with the given name.
10245
10246	The list of all properties supported by the given medium format can
10247	be obtained with <link to="IMediumFormat::describeProperties"/>.
10248
10249	<note>If this method returns an empty string in @a value, the requested
10250	property is supported but currently not assigned any value.</note>
10251
10252	<result name="VBOX_E_OBJECT_NOT_FOUND">
10253	Requested property does not exist (not supported by the format).
10254	</result>
10255	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10256	</desc>
10257	<param name="name" type="wstring" dir="in">
10258	<desc>Name of the property to get.</desc>
10259	</param>
10260	<param name="value" type="wstring" dir="return">
10261	<desc>Current property value.</desc>
10262	</param>
10263	</method>
10264
10265	<method name="setProperty">
10266	<desc>
10267	Sets the value of the custom medium property with the given name.
10268
10269	The list of all properties supported by the given medium format can
10270	be obtained with <link to="IMediumFormat::describeProperties"/>.
10271
10272	<note>Setting the property value to @c null or an empty string is
10273	equivalent to deleting the existing value. A default value (if it is
10274	defined for this property) will be used by the format backend in this
10275	case.</note>
10276
10277	<result name="VBOX_E_OBJECT_NOT_FOUND">
10278	Requested property does not exist (not supported by the format).
10279	</result>
10280	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10281	</desc>
10282	<param name="name" type="wstring" dir="in">
10283	<desc>Name of the property to set.</desc>
10284	</param>
10285	<param name="value" type="wstring" dir="in">
10286	<desc>Property value to set.</desc>
10287	</param>
10288	</method>
10289
10290	<method name="getProperties">
10291	<desc>
10292	Returns values for a group of properties in one call.
10293
10294	The names of the properties to get are specified using the @a names
10295	argument which is a list of comma-separated property names or
10296	an empty string if all properties are to be returned.
10297	<note>Currently the value of this argument is ignored and the method
10298	always returns all existing properties.</note>
10299
10300	The list of all properties supported by the given medium format can
10301	be obtained with <link to="IMediumFormat::describeProperties"/>.
10302
10303	The method returns two arrays, the array of property names corresponding
10304	to the @a names argument and the current values of these properties.
10305	Both arrays have the same number of elements with each element at the
10306	given index in the first array corresponds to an element at the same
10307	index in the second array.
10308
10309	For properties that do not have assigned values, an empty string is
10310	returned at the appropriate index in the @a returnValues array.
10311
10312	</desc>
10313	<param name="names" type="wstring" dir="in">
10314	<desc>
10315	Names of properties to get.
10316	</desc>
10317	</param>
10318	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10319	<desc>Names of returned properties.</desc>
10320	</param>
10321	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10322	<desc>Values of returned properties.</desc>
10323	</param>
10324	</method>
10325
10326	<method name="setProperties">
10327	<desc>
10328	Sets values for a group of properties in one call.
10329
10330	The names of the properties to set are passed in the @a names
10331	array along with the new values for them in the @a values array. Both
10332	arrays have the same number of elements with each element at the given
10333	index in the first array corresponding to an element at the same index
10334	in the second array.
10335
10336	If there is at least one property name in @a names that is not valid,
10337	the method will fail before changing the values of any other properties
10338	from the @a names array.
10339
10340	Using this method over <link to="#setProperty"/> is preferred if you
10341	need to set several properties at once since it is more efficient.
10342
10343	The list of all properties supported by the given medium format can
10344	be obtained with <link to="IMediumFormat::describeProperties"/>.
10345
10346	Setting the property value to @c null or an empty string is equivalent
10347	to deleting the existing value. A default value (if it is defined for
10348	this property) will be used by the format backend in this case.
10349	</desc>
10350	<param name="names" type="wstring" safearray="yes" dir="in">
10351	<desc>Names of properties to set.</desc>
10352	</param>
10353	<param name="values" type="wstring" safearray="yes" dir="in">
10354	<desc>Values of properties to set.</desc>
10355	</param>
10356	</method>
10357
10358	<!-- storage methods -->
10359
10360	<method name="createBaseStorage">
10361	<desc>
10362	Starts creating a hard disk storage unit (fixed/dynamic, according
10363	to the variant flags) in in the background. The previous storage unit
10364	created for this object, if any, must first be deleted using
10365	<link to="#deleteStorage"/>, otherwise the operation will fail.
10366
10367	Before the operation starts, the medium is placed in
10368	<link to="MediumState_Creating"/> state. If the create operation
10369	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10370	state.
10371
10372	After the returned progress object reports that the operation has
10373	successfully completed, the medium state will be set to <link
10374	to="MediumState_Created"/>, the medium will be remembered by this
10375	VirtualBox installation and may be attached to virtual machines.
10376
10377	<result name="VBOX_E_NOT_SUPPORTED">
10378	The variant of storage creation operation is not supported. See <link
10379	to="IMediumFormat::capabilities"/>.
10380	</result>
10381	</desc>
10382	<param name="logicalSize" type="long long" dir="in">
10383	<desc>Maximum logical size of the medium in bytes.</desc>
10384	</param>
10385	<param name="variant" type="unsigned long" dir="in">
10386	<desc>Exact image variant which should be created (as a combination of
10387	<link to="MediumVariant" /> flags).</desc>
10388	</param>
10389	<param name="progress" type="IProgress" dir="return">
10390	<desc>Progress object to track the operation completion.</desc>
10391	</param>
10392	</method>
10393
10394	<method name="deleteStorage">
10395	<desc>
10396	Starts deleting the storage unit of this medium.
10397
10398	The medium must not be attached to any known virtual machine and must
10399	not have any known child media, otherwise the operation will fail.
10400	It will also fail if there is no storage unit to delete or if deletion
10401	is already in progress, or if the medium is being in use (locked for
10402	read or for write) or inaccessible. Therefore, the only valid state for
10403	this operation to succeed is <link to="MediumState_Created"/>.
10404
10405	Before the operation starts, the medium is placed in
10406	<link to="MediumState_Deleting"/> state and gets removed from the list
10407	of remembered hard disks (media registry). If the delete operation
10408	fails, the medium will be remembered again and placed back to
10409	<link to="MediumState_Created"/> state.
10410
10411	After the returned progress object reports that the operation is
10412	complete, the medium state will be set to
10413	<link to="MediumState_NotCreated"/> and you will be able to use one of
10414	the storage creation methods to create it again.
10415
10416	<see>#close()</see>
10417
10418	<result name="VBOX_E_OBJECT_IN_USE">
10419	Medium is attached to a virtual machine.
10420	</result>
10421	<result name="VBOX_E_NOT_SUPPORTED">
10422	Storage deletion is not allowed because neither of storage creation
10423	operations are supported. See
10424	<link to="IMediumFormat::capabilities"/>.
10425	</result>
10426
10427	<note>
10428	If the deletion operation fails, it is not guaranteed that the storage
10429	unit still exists. You may check the <link to="IMedium::state"/> value
10430	to answer this question.
10431	</note>
10432	</desc>
10433	<param name="progress" type="IProgress" dir="return">
10434	<desc>Progress object to track the operation completion.</desc>
10435	</param>
10436	</method>
10437
10438	<!-- diff methods -->
10439
10440	<method name="createDiffStorage">
10441	<desc>
10442	Starts creating an empty differencing storage unit based on this
10443	medium in the format and at the location defined by the @a target
10444	argument.
10445
10446	The target medium must be in <link to="MediumState_NotCreated"/>
10447	state (i.e. must not have an existing storage unit). Upon successful
10448	completion, this operation will set the type of the target medium to
10449	<link to="MediumType_Normal"/> and create a storage unit necessary to
10450	represent the differencing medium data in the given format (according
10451	to the storage format of the target object).
10452
10453	After the returned progress object reports that the operation is
10454	successfully complete, the target medium gets remembered by this
10455	VirtualBox installation and may be attached to virtual machines.
10456
10457	<note>
10458	The medium will be set to <link to="MediumState_LockedRead"/>
10459	state for the duration of this operation.
10460	</note>
10461	<result name="VBOX_E_OBJECT_IN_USE">
10462	Medium not in @c NotCreated state.
10463	</result>
10464	</desc>
10465	<param name="target" type="IMedium" dir="in">
10466	<desc>Target medium.</desc>
10467	</param>
10468	<param name="variant" type="unsigned long" dir="in">
10469	<desc>Exact image variant which should be created (as a combination of
10470	<link to="MediumVariant" /> flags).</desc>
10471	</param>
10472	<param name="progress" type="IProgress" dir="return">
10473	<desc>Progress object to track the operation completion.</desc>
10474	</param>
10475	</method>
10476
10477	<method name="mergeTo">
10478	<desc>
10479	Starts merging the contents of this medium and all intermediate
10480	differencing media in the chain to the given target medium.
10481
10482	The target medium must be either a descendant of this medium or
10483	its ancestor (otherwise this method will immediately return a failure).
10484	It follows that there are two logical directions of the merge operation:
10485	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10486	ancestor (<i>backward merge</i>). Let us consider the following medium
10487	chain:
10488
10489	<pre>Base <- Diff_1 <- Diff_2</pre>
10490
10491	Here, calling this method on the <tt>Base</tt> medium object with
10492	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10493	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10494	merge. Note that in both cases the contents of the resulting medium
10495	will be the same, the only difference is the medium object that takes
10496	the result of the merge operation. In case of the forward merge in the
10497	above example, the result will be written to <tt>Diff_2</tt>; in case of
10498	the backward merge, the result will be written to <tt>Base</tt>. In
10499	other words, the result of the operation is always stored in the target
10500	medium.
10501
10502	Upon successful operation completion, the storage units of all media in
10503	the chain between this (source) medium and the target medium, including
10504	the source medium itself, will be automatically deleted and the
10505	relevant medium objects (including this medium) will become
10506	uninitialized. This means that any attempt to call any of
10507	their methods or attributes will fail with the
10508	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10509	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10510	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10511	Note that <tt>Diff_2</tt> in this case will become a base medium
10512	itself since it will no longer be based on any other medium.
10513
10514	Considering the above, all of the following conditions must be met in
10515	order for the merge operation to succeed:
10516	<ul>
10517	<li>
10518	Neither this (source) medium nor any intermediate
10519	differencing medium in the chain between it and the target
10520	medium is attached to any virtual machine.
10521	</li>
10522	<li>
10523	Neither the source medium nor the target medium is an
10524	<link to="MediumType_Immutable"/> medium.
10525	</li>
10526	<li>
10527	The part of the medium tree from the source medium to the
10528	target medium is a linear chain, i.e. all medium in this
10529	chain have exactly one child which is the next medium in this
10530	chain. The only exception from this rule is the target medium in
10531	the forward merge operation; it is allowed to have any number of
10532	child media because the merge operation will not change its
10533	logical contents (as it is seen by the guest OS or by children).
10534	</li>
10535	<li>
10536	None of the involved media are in
10537	<link to="MediumState_LockedRead"/> or
10538	<link to="MediumState_LockedWrite"/> state.
10539	</li>
10540	</ul>
10541
10542	<note>
10543	This (source) medium and all intermediates will be placed to <link
10544	to="MediumState_Deleting"/> state and the target medium will be
10545	placed to <link to="MediumState_LockedWrite"/> state and for the
10546	duration of this operation.
10547	</note>
10548	</desc>
10549	<param name="target" type="IMedium" dir="in">
10550	<desc>Target medium.</desc>
10551	</param>
10552	<param name="progress" type="IProgress" dir="return">
10553	<desc>Progress object to track the operation completion.</desc>
10554	</param>
10555	</method>
10556
10557	<!-- clone method -->
10558
10559	<method name="cloneTo">
10560	<desc>
10561	Starts creating a clone of this medium in the format and at the
10562	location defined by the @a target argument.
10563
10564	The target medium must be either in <link to="MediumState_NotCreated"/>
10565	state (i.e. must not have an existing storage unit) or in
10566	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10567	big enough to hold the data or else the copy will be partial). Upon
10568	successful completion, the cloned medium will contain exactly the
10569	same sector data as the medium being cloned, except that in the
10570	first case a new UUID for the clone will be randomly generated, and in
10571	the second case the UUID will remain unchanged.
10572
10573	The @a parent argument defines which medium will be the parent
10574	of the clone. Passing a @c null reference indicates that the clone will
10575	be a base image, i.e. completely independent. It is possible to specify
10576	an arbitrary medium for this parameter, including the parent of the
10577	medium which is being cloned. Even cloning to a child of the source
10578	medium is possible. Note that when cloning to an existing image, the
10579	@a parent irgument is ignored.
10580
10581	After the returned progress object reports that the operation is
10582	successfully complete, the target medium gets remembered by this
10583	VirtualBox installation and may be attached to virtual machines.
10584
10585	<note>
10586	This medium will be placed to <link to="MediumState_LockedRead"/>
10587	state for the duration of this operation.
10588	</note>
10589	<result name="E_NOTIMPL">
10590	The specified cloning variant is not supported at the moment.
10591	</result>
10592	</desc>
10593	<param name="target" type="IMedium" dir="in">
10594	<desc>Target medium.</desc>
10595	</param>
10596	<param name="variant" type="unsigned long" dir="in">
10597	<desc>Exact image variant which should be created (as a combination of
10598	<link to="MediumVariant" /> flags).</desc>
10599	</param>
10600	<param name="parent" type="IMedium" dir="in">
10601	<desc>Parent of the cloned medium.</desc>
10602	</param>
10603	<param name="progress" type="IProgress" dir="return">
10604	<desc>Progress object to track the operation completion.</desc>
10605	</param>
10606	</method>
10607
10608	<!-- other methods -->
10609
10610	<method name="compact">
10611	<desc>
10612	Starts compacting of this medium. This means that the medium is
10613	transformed into a possibly more compact storage representation.
10614	This potentially creates temporary images, which can require a
10615	substantial amount of additional disk space.
10616
10617	This medium will be placed to <link to="MediumState_LockedWrite"/>
10618	state and all its parent media (if any) will be placed to
10619	<link to="MediumState_LockedRead"/> state for the duration of this
10620	operation.
10621
10622	Please note that the results can be either returned straight away,
10623	or later as the result of the background operation via the object
10624	returned via the @a progress parameter.
10625
10626	<result name="VBOX_E_NOT_SUPPORTED">
10627	Medium format does not support compacting (but potentially
10628	needs it).
10629	</result>
10630	</desc>
10631	<param name="progress" type="IProgress" dir="return">
10632	<desc>Progress object to track the operation completion.</desc>
10633	</param>
10634	</method>
10635
10636	<method name="resize">
10637	<desc>
10638	Starts resizing this medium. This means that the nominal size of the
10639	medium is set to the new value. Both increasing and decreasing the
10640	size is possible, and there are no safety checks, since VirtualBox
10641	does not make any assumptions about the medium contents.
10642
10643	Resizing usually needs additional disk space, and possibly also
10644	some temporary disk space. Note that resize does not create a full
10645	temporary copy of the medium, so the additional disk space requirement
10646	is usually much lower than using the clone operation.
10647
10648	This medium will be placed to <link to="MediumState_LockedWrite"/>
10649	state for the duration of this operation.
10650
10651	Please note that the results can be either returned straight away,
10652	or later as the result of the background operation via the object
10653	returned via the @a progress parameter.
10654
10655	<result name="VBOX_E_NOT_SUPPORTED">
10656	Medium format does not support resizing.
10657	</result>
10658	</desc>
10659	<param name="logicalSize" type="long long" dir="in">
10660	<desc>New nominal capacity of the medium in bytes.</desc>
10661	</param>
10662	<param name="progress" type="IProgress" dir="return">
10663	<desc>Progress object to track the operation completion.</desc>
10664	</param>
10665	</method>
10666
10667	<method name="reset">
10668	<desc>
10669	Starts erasing the contents of this differencing medium.
10670
10671	This operation will reset the differencing medium to its initial
10672	state when it does not contain any sector data and any read operation is
10673	redirected to its parent medium. This automatically gets called
10674	during VM power-up for every medium whose <link to="#autoReset" />
10675	attribute is @c true.
10676
10677	The medium will be write-locked for the duration of this operation (see
10678	<link to="#lockWrite" />).
10679
10680	<result name="VBOX_E_NOT_SUPPORTED">
10681	This is not a differencing medium.
10682	</result>
10683	<result name="VBOX_E_INVALID_OBJECT_STATE">
10684	Medium is not in <link to="MediumState_Created"/> or
10685	<link to="MediumState_Inaccessible"/> state.
10686	</result>
10687	</desc>
10688	<param name="progress" type="IProgress" dir="return">
10689	<desc>Progress object to track the operation completion.</desc>
10690	</param>
10691	</method>
10692
10693	</interface>
10694
10695
10696	<!--
10697	// IMediumFormat
10698	/////////////////////////////////////////////////////////////////////////
10699	-->
10700
10701	<enum
10702	name="DataType"
10703	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10704	>
10705	<const name="Int32" value="0"/>
10706	<const name="Int8" value="1"/>
10707	<const name="String" value="2"/>
10708	</enum>
10709
10710	<enum
10711	name="DataFlags"
10712	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10713	>
10714	<const name="None" value="0x00"/>
10715	<const name="Mandatory" value="0x01"/>
10716	<const name="Expert" value="0x02"/>
10717	<const name="Array" value="0x04"/>
10718	<const name="FlagMask" value="0x07"/>
10719	</enum>
10720
10721	<enum
10722	name="MediumFormatCapabilities"
10723	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10724	>
10725	<desc>
10726	Medium format capability flags.
10727	</desc>
10728
10729	<const name="Uuid" value="0x01">
10730	<desc>
10731	Supports UUIDs as expected by VirtualBox code.
10732	</desc>
10733	</const>
10734
10735	<const name="CreateFixed" value="0x02">
10736	<desc>
10737	Supports creating fixed size images, allocating all space instantly.
10738	</desc>
10739	</const>
10740
10741	<const name="CreateDynamic" value="0x04">
10742	<desc>
10743	Supports creating dynamically growing images, allocating space on
10744	demand.
10745	</desc>
10746	</const>
10747
10748	<const name="CreateSplit2G" value="0x08">
10749	<desc>
10750	Supports creating images split in chunks of a bit less than 2 GBytes.
10751	</desc>
10752	</const>
10753
10754	<const name="Differencing" value="0x10">
10755	<desc>
10756	Supports being used as a format for differencing media (see <link
10757	to="IMedium::createDiffStorage"/>).
10758	</desc>
10759	</const>
10760
10761	<const name="Asynchronous" value="0x20">
10762	<desc>
10763	Supports asynchronous I/O operations for at least some configurations.
10764	</desc>
10765	</const>
10766
10767	<const name="File" value="0x40">
10768	<desc>
10769	The format backend operates on files (the <link to="IMedium::location"/>
10770	attribute of the medium specifies a file used to store medium
10771	data; for a list of supported file extensions see
10772	<link to="IMediumFormat::describeFileExtensions"/>).
10773	</desc>
10774	</const>
10775
10776	<const name="Properties" value="0x80">
10777	<desc>
10778	The format backend uses the property interface to configure the storage
10779	location and properties (the <link to="IMediumFormat::describeProperties"/>
10780	method is used to get access to properties supported by the given medium format).
10781	</desc>
10782	</const>
10783
10784	<const name="TcpNetworking" value="0x100">
10785	<desc>
10786	The format backend uses the TCP networking interface for network access.
10787	</desc>
10788	</const>
10789
10790	<const name="VFS" value="0x200">
10791	<desc>
10792	The format backend supports virtual filesystem functionality.
10793	</desc>
10794	</const>
10795
10796	<const name="CapabilityMask" value="0x3FF"/>
10797	</enum>
10798
10799	<interface
10800	name="IMediumFormat" extends="$unknown"
10801	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10802	wsmap="managed"
10803	>
10804	<desc>
10805	The IMediumFormat interface represents a medium format.
10806
10807	Each medium format has an associated backend which is used to handle
10808	media stored in this format. This interface provides information
10809	about the properties of the associated backend.
10810
10811	Each medium format is identified by a string represented by the
10812	<link to="#id"/> attribute. This string is used in calls like
10813	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10814	format.
10815
10816	The list of all supported medium formats can be obtained using
10817	<link to="ISystemProperties::mediumFormats"/>.
10818
10819	<see>IMedium</see>
10820	</desc>
10821
10822	<attribute name="id" type="wstring" readonly="yes">
10823	<desc>
10824	Identifier of this format.
10825
10826	The format identifier is a non-@c null non-empty ASCII string. Note that
10827	this string is case-insensitive. This means that, for example, all of
10828	the following strings:
10829	<pre>
10830	"VDI"
10831	"vdi"
10832	"VdI"</pre>
10833	refer to the same medium format.
10834
10835	This string is used in methods of other interfaces where it is necessary
10836	to specify a medium format, such as
10837	<link to="IVirtualBox::createHardDisk"/>.
10838	</desc>
10839	</attribute>
10840
10841	<attribute name="name" type="wstring" readonly="yes">
10842	<desc>
10843	Human readable description of this format.
10844
10845	Mainly for use in file open dialogs.
10846	</desc>
10847	</attribute>
10848
10849	<attribute name="capabilities" type="unsigned long" readonly="yes">
10850	<desc>
10851	Capabilities of the format as a set of bit flags.
10852
10853	For the meaning of individual capability flags see
10854	<link to="MediumFormatCapabilities"/>.
10855	</desc>
10856	</attribute>
10857
10858	<method name="describeFileExtensions">
10859	<desc>
10860	Returns two arrays describing the supported file extensions.
10861
10862	The first array contains the supported extensions and the seconds one
10863	the type each extension supports. Both have the same size.
10864
10865	Note that some backends do not work on files, so this array may be
10866	empty.
10867
10868	<see>IMediumFormat::capabilities</see>
10869	</desc>
10870	<param name="extensions" type="wstring" safearray="yes" dir="out">
10871	<desc>The array of supported extensions.</desc>
10872	</param>
10873	<param name="type" type="DeviceType" safearray="yes" dir="out">
10874	<desc>The array which indicates the device type for every given extension.</desc>
10875	</param>
10876	</method>
10877
10878	<method name="describeProperties">
10879	<desc>
10880	Returns several arrays describing the properties supported by this
10881	format.
10882
10883	An element with the given index in each array describes one
10884	property. Thus, the number of elements in each returned array is the
10885	same and corresponds to the number of supported properties.
10886
10887	The returned arrays are filled in only if the
10888	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10889	All arguments must be non-@c null.
10890
10891	<see>DataType</see>
10892	<see>DataFlags</see>
10893	</desc>
10894
10895	<param name="names" type="wstring" safearray="yes" dir="out">
10896	<desc>Array of property names.</desc>
10897	</param>
10898	<param name="description" type="wstring" safearray="yes" dir="out">
10899	<desc>Array of property descriptions.</desc>
10900	</param>
10901	<param name="types" type="DataType" safearray="yes" dir="out">
10902	<desc>Array of property types.</desc>
10903	</param>
10904	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10905	<desc>Array of property flags.</desc>
10906	</param>
10907	<param name="defaults" type="wstring" safearray="yes" dir="out">
10908	<desc>Array of default property values.</desc>
10909	</param>
10910	</method>
10911
10912	</interface>
10913
10914
10915	<!--
10916	// IKeyboard
10917	/////////////////////////////////////////////////////////////////////////
10918	-->
10919
10920	<interface
10921	name="IKeyboard" extends="$unknown"
10922	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10923	wsmap="managed"
10924	>
10925	<desc>
10926	The IKeyboard interface represents the virtual machine's keyboard. Used
10927	in <link to="IConsole::keyboard"/>.
10928
10929	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10930	to the virtual machine.
10931
10932	</desc>
10933	<method name="putScancode">
10934	<desc>Sends a scancode to the keyboard.
10935
10936	<result name="VBOX_E_IPRT_ERROR">
10937	Could not send scan code to virtual keyboard.
10938	</result>
10939
10940	</desc>
10941	<param name="scancode" type="long" dir="in"/>
10942	</method>
10943
10944	<method name="putScancodes">
10945	<desc>Sends an array of scancodes to the keyboard.
10946
10947	<result name="VBOX_E_IPRT_ERROR">
10948	Could not send all scan codes to virtual keyboard.
10949	</result>
10950
10951	</desc>
10952	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10953	<param name="codesStored" type="unsigned long" dir="return"/>
10954	</method>
10955
10956	<method name="putCAD">
10957	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10958	function is nothing special, it is just a convenience function
10959	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10960
10961	<result name="VBOX_E_IPRT_ERROR">
10962	Could not send all scan codes to virtual keyboard.
10963	</result>
10964
10965	</desc>
10966	</method>
10967
10968	<attribute name="eventSource" type="IEventSource" readonly="yes">
10969	<desc>
10970	Event source for keyboard events.
10971	</desc>
10972	</attribute>
10973
10974	</interface>
10975
10976
10977	<!--
10978	// IMouse
10979	/////////////////////////////////////////////////////////////////////////
10980	-->
10981
10982	<enum
10983	name="MouseButtonState"
10984	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10985	>
10986	<desc>
10987	Mouse button state.
10988	</desc>
10989
10990	<const name="LeftButton" value="0x01"/>
10991	<const name="RightButton" value="0x02"/>
10992	<const name="MiddleButton" value="0x04"/>
10993	<const name="WheelUp" value="0x08"/>
10994	<const name="WheelDown" value="0x10"/>
10995	<const name="XButton1" value="0x20"/>
10996	<const name="XButton2" value="0x40"/>
10997	<const name="MouseStateMask" value="0x7F"/>
10998	</enum>
10999
11000	<interface
11001	name="IMouse" extends="$unknown"
11002	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11003	wsmap="managed"
11004	>
11005	<desc>
11006	The IMouse interface represents the virtual machine's mouse. Used in
11007	<link to="IConsole::mouse"/>.
11008
11009	Through this interface, the virtual machine's virtual mouse can be
11010	controlled.
11011	</desc>
11012
11013	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11014	<desc>
11015	Whether the guest OS supports absolute mouse pointer positioning
11016	or not.
11017	<note>
11018	You can use the <link to="IMouseCapabilityChangedEvent"/>
11019	event to be instantly informed about changes of this attribute
11020	during virtual machine execution.
11021	</note>
11022	<see><link to="#putMouseEventAbsolute"/></see>
11023	</desc>
11024	</attribute>
11025
11026	<attribute name="relativeSupported" type="boolean" readonly="yes">
11027	<desc>
11028	Whether the guest OS supports relative mouse pointer positioning
11029	or not.
11030	<note>
11031	You can use the <link to="IMouseCapabilityChangedEvent"/>
11032	event to be instantly informed about changes of this attribute
11033	during virtual machine execution.
11034	</note>
11035	<see><link to="#putMouseEvent"/></see>
11036	</desc>
11037	</attribute>
11038
11039	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11040	<desc>
11041	Whether the guest OS can currently switch to drawing it's own mouse
11042	cursor on demand.
11043	<note>
11044	You can use the <link to="IMouseCapabilityChangedEvent"/>
11045	event to be instantly informed about changes of this attribute
11046	during virtual machine execution.
11047	</note>
11048	<see><link to="#putMouseEvent"/></see>
11049	</desc>
11050	</attribute>
11051
11052	<method name="putMouseEvent">
11053	<desc>
11054	Initiates a mouse event using relative pointer movements
11055	along x and y axis.
11056
11057	<result name="E_ACCESSDENIED">
11058	Console not powered up.
11059	</result>
11060	<result name="VBOX_E_IPRT_ERROR">
11061	Could not send mouse event to virtual mouse.
11062	</result>
11063
11064	</desc>
11065
11066	<param name="dx" type="long" dir="in">
11067	<desc>
11068	Amount of pixels the mouse should move to the right.
11069	Negative values move the mouse to the left.
11070	</desc>
11071	</param>
11072	<param name="dy" type="long" dir="in">
11073	<desc>
11074	Amount of pixels the mouse should move downwards.
11075	Negative values move the mouse upwards.
11076	</desc>
11077	</param>
11078	<param name="dz" type="long" dir="in">
11079	<desc>
11080	Amount of mouse wheel moves.
11081	Positive values describe clockwise wheel rotations,
11082	negative values describe counterclockwise rotations.
11083	</desc>
11084	</param>
11085	<param name="dw" type="long" dir="in">
11086	<desc>
11087	Amount of horizontal mouse wheel moves.
11088	Positive values describe a movement to the left,
11089	negative values describe a movement to the right.
11090	</desc>
11091	</param>
11092	<param name="buttonState" type="long" dir="in">
11093	<desc>
11094	The current state of mouse buttons. Every bit represents
11095	a mouse button as follows:
11096	<table>
11097	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11098	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11099	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11100	</table>
11101	A value of <tt>1</tt> means the corresponding button is pressed.
11102	otherwise it is released.
11103	</desc>
11104	</param>
11105	</method>
11106
11107	<method name="putMouseEventAbsolute">
11108	<desc>
11109	Positions the mouse pointer using absolute x and y coordinates.
11110	These coordinates are expressed in pixels and
11111	start from <tt>[1,1]</tt> which corresponds to the top left
11112	corner of the virtual display.
11113
11114	<result name="E_ACCESSDENIED">
11115	Console not powered up.
11116	</result>
11117	<result name="VBOX_E_IPRT_ERROR">
11118	Could not send mouse event to virtual mouse.
11119	</result>
11120
11121	<note>
11122	This method will have effect only if absolute mouse
11123	positioning is supported by the guest OS.
11124	</note>
11125
11126	<see><link to="#absoluteSupported"/></see>
11127	</desc>
11128
11129	<param name="x" type="long" dir="in">
11130	<desc>
11131	X coordinate of the pointer in pixels, starting from @c 1.
11132	</desc>
11133	</param>
11134	<param name="y" type="long" dir="in">
11135	<desc>
11136	Y coordinate of the pointer in pixels, starting from @c 1.
11137	</desc>
11138	</param>
11139	<param name="dz" type="long" dir="in">
11140	<desc>
11141	Amount of mouse wheel moves.
11142	Positive values describe clockwise wheel rotations,
11143	negative values describe counterclockwise rotations.
11144	</desc>
11145	</param>
11146	<param name="dw" type="long" dir="in">
11147	<desc>
11148	Amount of horizontal mouse wheel moves.
11149	Positive values describe a movement to the left,
11150	negative values describe a movement to the right.
11151	</desc>
11152	</param>
11153	<param name="buttonState" type="long" dir="in">
11154	<desc>
11155	The current state of mouse buttons. Every bit represents
11156	a mouse button as follows:
11157	<table>
11158	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11159	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11160	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11161	</table>
11162	A value of @c 1 means the corresponding button is pressed.
11163	otherwise it is released.
11164	</desc>
11165	</param>
11166	</method>
11167
11168	<attribute name="eventSource" type="IEventSource" readonly="yes">
11169	<desc>
11170	Event source for mouse events.
11171	</desc>
11172	</attribute>
11173
11174	</interface>
11175
11176	<!--
11177	// IDisplay
11178	/////////////////////////////////////////////////////////////////////////
11179	-->
11180
11181	<enum
11182	name="FramebufferPixelFormat"
11183	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11184	>
11185	<desc>
11186	Format of the video memory buffer. Constants represented by this enum can
11187	be used to test for particular values of <link
11188	to="IFramebuffer::pixelFormat"/>. See also <link
11189	to="IFramebuffer::requestResize"/>.
11190
11191	See also www.fourcc.org for more information about FOURCC pixel formats.
11192	</desc>
11193
11194	<const name="Opaque" value="0">
11195	<desc>
11196	Unknown buffer format (the user may not assume any particular format of
11197	the buffer).
11198	</desc>
11199	</const>
11200	<const name="FOURCC_RGB" value="0x32424752">
11201	<desc>
11202	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11203	bit layout).
11204	</desc>
11205	</const>
11206	</enum>
11207
11208	<interface
11209	name="IFramebuffer" extends="$unknown"
11210	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11211	wsmap="suppress"
11212	>
11213	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11214	<desc>Address of the start byte of the frame buffer.</desc>
11215	</attribute>
11216
11217	<attribute name="width" type="unsigned long" readonly="yes">
11218	<desc>Frame buffer width, in pixels.</desc>
11219	</attribute>
11220
11221	<attribute name="height" type="unsigned long" readonly="yes">
11222	<desc>Frame buffer height, in pixels.</desc>
11223	</attribute>
11224
11225	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11226	<desc>
11227	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11228	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11229	are: 8, 15, 16, 24 and 32.
11230	</desc>
11231	</attribute>
11232
11233	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11234	<desc>
11235	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11236	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11237	size of the scan line must be aligned to 32 bits.
11238	</desc>
11239	</attribute>
11240
11241	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11242	<desc>
11243	Frame buffer pixel format. It's either one of the values defined by <link
11244	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11245	<note>
11246	This attribute must never return <link
11247	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11248	<link to="#address"/> points to must be always known.
11249	</note>
11250	</desc>
11251	</attribute>
11252
11253	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11254	<desc>
11255	Defines whether this frame buffer uses the virtual video card's memory
11256	buffer (guest VRAM) directly or not. See <link
11257	to="IFramebuffer::requestResize"/> for more information.
11258	</desc>
11259	</attribute>
11260
11261	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11262	<desc>
11263	Hint from the frame buffer about how much of the standard
11264	screen height it wants to use for itself. This information is
11265	exposed to the guest through the VESA BIOS and VMMDev interface
11266	so that it can use it for determining its video mode table. It
11267	is not guaranteed that the guest respects the value.
11268	</desc>
11269	</attribute>
11270
11271	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11272	<desc>
11273	An alpha-blended overlay which is superposed over the frame buffer.
11274	The initial purpose is to allow the display of icons providing
11275	information about the VM state, including disk activity, in front
11276	ends which do not have other means of doing that. The overlay is
11277	designed to controlled exclusively by IDisplay. It has no locking
11278	of its own, and any changes made to it are not guaranteed to be
11279	visible until the affected portion of IFramebuffer is updated. The
11280	overlay can be created lazily the first time it is requested. This
11281	attribute can also return @c null to signal that the overlay is not
11282	implemented.
11283	</desc>
11284	</attribute>
11285
11286	<attribute name="winId" type="long long" readonly="yes">
11287	<desc>
11288	Platform-dependent identifier of the window where context of this
11289	frame buffer is drawn, or zero if there's no such window.
11290	</desc>
11291	</attribute>
11292
11293	<method name="lock">
11294	<desc>
11295	Locks the frame buffer.
11296	Gets called by the IDisplay object where this frame buffer is
11297	bound to.
11298	</desc>
11299	</method>
11300
11301	<method name="unlock">
11302	<desc>
11303	Unlocks the frame buffer.
11304	Gets called by the IDisplay object where this frame buffer is
11305	bound to.
11306	</desc>
11307	</method>
11308
11309	<method name="notifyUpdate">
11310	<desc>
11311	Informs about an update.
11312	Gets called by the display object where this buffer is
11313	registered.
11314	</desc>
11315	<param name="x" type="unsigned long" dir="in"/>
11316	<param name="y" type="unsigned long" dir="in"/>
11317	<param name="width" type="unsigned long" dir="in"/>
11318	<param name="height" type="unsigned long" dir="in"/>
11319	</method>
11320
11321	<method name="requestResize">
11322	<desc>
11323	Requests a size and pixel format change.
11324
11325	There are two modes of working with the video buffer of the virtual
11326	machine. The <i>indirect</i> mode implies that the IFramebuffer
11327	implementation allocates a memory buffer for the requested display mode
11328	and provides it to the virtual machine. In <i>direct</i> mode, the
11329	IFramebuffer implementation uses the memory buffer allocated and owned
11330	by the virtual machine. This buffer represents the video memory of the
11331	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11332	usually faster because the implementation gets a raw pointer to the
11333	guest VRAM buffer which it can directly use for visualizing the contents
11334	of the virtual display, as opposed to the indirect mode where the
11335	contents of guest VRAM are copied to the memory buffer provided by
11336	the implementation every time a display update occurs.
11337
11338	It is important to note that the direct mode is really fast only when
11339	the implementation uses the given guest VRAM buffer directly, for
11340	example, by blitting it to the window representing the virtual machine's
11341	display, which saves at least one copy operation comparing to the
11342	indirect mode. However, using the guest VRAM buffer directly is not
11343	always possible: the format and the color depth of this buffer may be
11344	not supported by the target window, or it may be unknown (opaque) as in
11345	case of text or non-linear multi-plane VGA video modes. In this case,
11346	the indirect mode (that is always available) should be used as a
11347	fallback: when the guest VRAM contents are copied to the
11348	implementation-provided memory buffer, color and format conversion is
11349	done automatically by the underlying code.
11350
11351	The @a pixelFormat parameter defines whether the direct mode is
11352	available or not. If @a pixelFormat is <link
11353	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11354	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11355	@a bytesPerLine parameters must be ignored and the implementation must use
11356	the indirect mode (where it provides its own buffer in one of the
11357	supported formats). In all other cases, @a pixelFormat together with
11358	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11359	buffer pointed to by the @a VRAM parameter and the implementation is
11360	free to choose which mode to use. To indicate that this frame buffer uses
11361	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11362	attribute must return @c true and <link to="#address"/> must
11363	return exactly the same address that is passed in the @a VRAM parameter
11364	of this method; otherwise it is assumed that the indirect strategy is
11365	chosen.
11366
11367	The @a width and @a height parameters represent the size of the
11368	requested display mode in both modes. In case of indirect mode, the
11369	provided memory buffer should be big enough to store data of the given
11370	display mode. In case of direct mode, it is guaranteed that the given
11371	@a VRAM buffer contains enough space to represent the display mode of the
11372	given size. Note that this frame buffer's <link to="#width"/> and <link
11373	to="#height"/> attributes must return exactly the same values as
11374	passed to this method after the resize is completed (see below).
11375
11376	The @a finished output parameter determines if the implementation has
11377	finished resizing the frame buffer or not. If, for some reason, the
11378	resize cannot be finished immediately during this call, @a finished
11379	must be set to @c false, and the implementation must call
11380	<link to="IDisplay::resizeCompleted"/> after it has returned from
11381	this method as soon as possible. If @a finished is @c false, the
11382	machine will not call any frame buffer methods until
11383	<link to="IDisplay::resizeCompleted"/> is called.
11384
11385	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11386	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11387	this frame buffer must return exactly the same values as specified in the
11388	parameters of this method, after the resize is completed. If the
11389	indirect mode is chosen, these attributes must return values describing
11390	the format of the implementation's own memory buffer <link
11391	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11392	value must always correlate with <link to="#pixelFormat"/>. Note that
11393	the <link to="#pixelFormat"/> attribute must never return <link
11394	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11395
11396	<note>
11397	This method is called by the IDisplay object under the
11398	<link to="#lock"/> provided by this IFramebuffer
11399	implementation. If this method returns @c false in @a finished, then
11400	this lock is not released until
11401	<link to="IDisplay::resizeCompleted"/> is called.
11402	</note>
11403	</desc>
11404	<param name="screenId" type="unsigned long" dir="in">
11405	<desc>
11406	Logical screen number. Must be used in the corresponding call to
11407	<link to="IDisplay::resizeCompleted"/> if this call is made.
11408	</desc>
11409	</param>
11410	<param name="pixelFormat" type="unsigned long" dir="in">
11411	<desc>
11412	Pixel format of the memory buffer pointed to by @a VRAM.
11413	See also <link to="FramebufferPixelFormat"/>.
11414	</desc>
11415	</param>
11416	<param name="VRAM" type="octet" mod="ptr" dir="in">
11417	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11418	</param>
11419	<param name="bitsPerPixel" type="unsigned long" dir="in">
11420	<desc>Color depth, bits per pixel.</desc>
11421	</param>
11422	<param name="bytesPerLine" type="unsigned long" dir="in">
11423	<desc>Size of one scan line, in bytes.</desc>
11424	</param>
11425	<param name="width" type="unsigned long" dir="in">
11426	<desc>Width of the guest display, in pixels.</desc>
11427	</param>
11428	<param name="height" type="unsigned long" dir="in">
11429	<desc>Height of the guest display, in pixels.</desc>
11430	</param>
11431	<param name="finished" type="boolean" dir="return">
11432	<desc>
11433	Can the VM start using the new frame buffer immediately
11434	after this method returns or it should wait for
11435	<link to="IDisplay::resizeCompleted"/>.
11436	</desc>
11437	</param>
11438	</method>
11439
11440	<method name="videoModeSupported">
11441	<desc>
11442	Returns whether the frame buffer implementation is willing to
11443	support a given video mode. In case it is not able to render
11444	the video mode (or for some reason not willing), it should
11445	return @c false. Usually this method is called when the guest
11446	asks the VMM device whether a given video mode is supported
11447	so the information returned is directly exposed to the guest.
11448	It is important that this method returns very quickly.
11449	</desc>
11450	<param name="width" type="unsigned long" dir="in"/>
11451	<param name="height" type="unsigned long" dir="in"/>
11452	<param name="bpp" type="unsigned long" dir="in"/>
11453	<param name="supported" type="boolean" dir="return"/>
11454	</method>
11455
11456	<method name="getVisibleRegion">
11457	<desc>
11458	Returns the visible region of this frame buffer.
11459
11460	If the @a rectangles parameter is @c null then the value of the
11461	@a count parameter is ignored and the number of elements necessary to
11462	describe the current visible region is returned in @a countCopied.
11463
11464	If @a rectangles is not @c null but @a count is less
11465	than the required number of elements to store region data, the method
11466	will report a failure. If @a count is equal or greater than the
11467	required number of elements, then the actual number of elements copied
11468	to the provided array will be returned in @a countCopied.
11469
11470	<note>
11471	The address of the provided array must be in the process space of
11472	this IFramebuffer object.
11473	</note>
11474	<note>
11475	Method not yet implemented.
11476	</note>
11477	</desc>
11478	<param name="rectangles" type="octet" mod="ptr" dir="in">
11479	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11480	</param>
11481	<param name="count" type="unsigned long" dir="in">
11482	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11483	</param>
11484	<param name="countCopied" type="unsigned long" dir="return">
11485	<desc>Number of elements copied to the @a rectangles array.</desc>
11486	</param>
11487	</method>
11488
11489	<method name="setVisibleRegion">
11490	<desc>
11491	Suggests a new visible region to this frame buffer. This region
11492	represents the area of the VM display which is a union of regions of
11493	all top-level windows of the guest operating system running inside the
11494	VM (if the Guest Additions for this system support this
11495	functionality). This information may be used by the frontends to
11496	implement the seamless desktop integration feature.
11497
11498	<note>
11499	The address of the provided array must be in the process space of
11500	this IFramebuffer object.
11501	</note>
11502	<note>
11503	The IFramebuffer implementation must make a copy of the provided
11504	array of rectangles.
11505	</note>
11506	<note>
11507	Method not yet implemented.
11508	</note>
11509	</desc>
11510	<param name="rectangles" type="octet" mod="ptr" dir="in">
11511	<desc>Pointer to the @c RTRECT array.</desc>
11512	</param>
11513	<param name="count" type="unsigned long" dir="in">
11514	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11515	</param>
11516	</method>
11517
11518	<method name="processVHWACommand">
11519	<desc>
11520	Posts a Video HW Acceleration Command to the frame buffer for processing.
11521	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11522	are posted from quest to the host to be processed by the host hardware.
11523
11524	<note>
11525	The address of the provided command must be in the process space of
11526	this IFramebuffer object.
11527	</note>
11528	</desc>
11529
11530	<param name="command" type="octet" mod="ptr" dir="in">
11531	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11532	</param>
11533	</method>
11534
11535	</interface>
11536
11537	<interface
11538	name="IFramebufferOverlay" extends="IFramebuffer"
11539	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11540	wsmap="suppress"
11541	>
11542	<desc>
11543	The IFramebufferOverlay interface represents an alpha blended overlay
11544	for displaying status icons above an IFramebuffer. It is always created
11545	not visible, so that it must be explicitly shown. It only covers a
11546	portion of the IFramebuffer, determined by its width, height and
11547	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11548	that order) format, and may be written to directly. Do re-read the
11549	width though, after setting it, as it may be adjusted (increased) to
11550	make it more suitable for the front end.
11551	</desc>
11552	<attribute name="x" type="unsigned long" readonly="yes">
11553	<desc>X position of the overlay, relative to the frame buffer.</desc>
11554	</attribute>
11555
11556	<attribute name="y" type="unsigned long" readonly="yes">
11557	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11558	</attribute>
11559
11560	<attribute name="visible" type="boolean" readonly="no">
11561	<desc>
11562	Whether the overlay is currently visible.
11563	</desc>
11564	</attribute>
11565
11566	<attribute name="alpha" type="unsigned long" readonly="no">
11567	<desc>
11568	The global alpha value for the overlay. This may or may not be
11569	supported by a given front end.
11570	</desc>
11571	</attribute>
11572
11573	<method name="move">
11574	<desc>
11575	Changes the overlay's position relative to the IFramebuffer.
11576	</desc>
11577	<param name="x" type="unsigned long" dir="in"/>
11578	<param name="y" type="unsigned long" dir="in"/>
11579	</method>
11580
11581	</interface>
11582
11583	<interface
11584	name="IDisplay" extends="$unknown"
11585	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11586	wsmap="managed"
11587	>
11588	<desc>
11589	The IDisplay interface represents the virtual machine's display.
11590
11591	The object implementing this interface is contained in each
11592	<link to="IConsole::display"/> attribute and represents the visual
11593	output of the virtual machine.
11594
11595	The virtual display supports pluggable output targets represented by the
11596	IFramebuffer interface. Examples of the output target are a window on
11597	the host computer or an RDP session's display on a remote computer.
11598	</desc>
11599	<method name="getScreenResolution">
11600	<desc>Queries display width, height and color depth for given screen.</desc>
11601	<param name="screenId" type="unsigned long" dir="in"/>
11602	<param name="width" type="unsigned long" dir="out"/>
11603	<param name="height" type="unsigned long" dir="out"/>
11604	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11605	</method>
11606
11607	<method name="setFramebuffer">
11608	<desc>
11609	Sets the framebuffer for given screen.
11610	</desc>
11611	<param name="screenId" type="unsigned long" dir="in"/>
11612	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11613	</method>
11614
11615	<method name="getFramebuffer">
11616	<desc>
11617	Queries the framebuffer for given screen.
11618	</desc>
11619	<param name="screenId" type="unsigned long" dir="in"/>
11620	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11621	<param name="xOrigin" type="long" dir="out"/>
11622	<param name="yOrigin" type="long" dir="out"/>
11623	</method>
11624
11625	<method name="setVideoModeHint">
11626	<desc>
11627	Asks VirtualBox to request the given video mode from
11628	the guest. This is just a hint and it cannot be guaranteed
11629	that the requested resolution will be used. Guest Additions
11630	are required for the request to be seen by guests. The caller
11631	should issue the request and wait for a resolution change and
11632	after a timeout retry.
11633
11634	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11635	parameters means that the corresponding values should be taken from the
11636	current video mode (i.e. left unchanged).
11637
11638	If the guest OS supports multi-monitor configuration then the @a display
11639	parameter specifies the number of the guest display to send the hint to:
11640	@c 0 is the primary display, @c 1 is the first secondary and
11641	so on. If the multi-monitor configuration is not supported, @a display
11642	must be @c 0.
11643
11644	<result name="E_INVALIDARG">
11645	The @a display is not associated with any monitor.
11646	</result>
11647
11648	</desc>
11649	<param name="width" type="unsigned long" dir="in"/>
11650	<param name="height" type="unsigned long" dir="in"/>
11651	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11652	<param name="display" type="unsigned long" dir="in"/>
11653	</method>
11654
11655	<method name="setSeamlessMode">
11656	<desc>
11657	Enables or disables seamless guest display rendering (seamless desktop
11658	integration) mode.
11659	<note>
11660	Calling this method has no effect if <link
11661	to="IGuest::getFacilityStatus"/> with facility <link to="AdditionsFacilityType::Seamless"/>
11662	does not return <link to="AdditionsFacilityStatus::Active"/>.
11663	</note>
11664	</desc>
11665	<param name="enabled" type="boolean" dir="in"/>
11666	</method>
11667
11668	<method name="takeScreenShot">
11669	<desc>
11670	Takes a screen shot of the requested size and copies it to the
11671	32-bpp buffer allocated by the caller and pointed to by @a address.
11672	A pixel consists of 4 bytes in order: B, G, R, 0.
11673
11674	<note>This API can be used only locally by a VM process through the
11675	COM/XPCOM C++ API as it requires pointer support. It is not
11676	available for scripting langages, Java or any webservice clients.
11677	Unless you are writing a new VM frontend use
11678	<link to="#takeScreenShotToArray" />.
11679	</note>
11680
11681	<result name="E_NOTIMPL">
11682	Feature not implemented.
11683	</result>
11684	<result name="VBOX_E_IPRT_ERROR">
11685	Could not take a screenshot.
11686	</result>
11687
11688	</desc>
11689	<param name="screenId" type="unsigned long" dir="in"/>
11690	<param name="address" type="octet" mod="ptr" dir="in"/>
11691	<param name="width" type="unsigned long" dir="in"/>
11692	<param name="height" type="unsigned long" dir="in"/>
11693	</method>
11694
11695	<method name="takeScreenShotToArray">
11696	<desc>
11697	Takes a guest screen shot of the requested size and returns it as
11698	an array of bytes in uncompressed 32-bit RGBA format.
11699	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11700
11701	This API is slow, but could be the only option to get guest screenshot
11702	for scriptable languages not allowed to manipulate with addresses
11703	directly.
11704
11705	<result name="E_NOTIMPL">
11706	Feature not implemented.
11707	</result>
11708	<result name="VBOX_E_IPRT_ERROR">
11709	Could not take a screenshot.
11710	</result>
11711	</desc>
11712	<param name="screenId" type="unsigned long" dir="in">
11713	<desc>
11714	Monitor to take screenshot from.
11715	</desc>
11716	</param>
11717	<param name="width" type="unsigned long" dir="in">
11718	<desc>
11719	Desired image width.
11720	</desc>
11721	</param>
11722	<param name="height" type="unsigned long" dir="in">
11723	<desc>
11724	Desired image height.
11725	</desc>
11726	</param>
11727	<param name="screenData" type="octet" dir="return" safearray="yes">
11728	<desc>
11729	Array with resulting screen data.
11730	</desc>
11731	</param>
11732	</method>
11733
11734	<method name="takeScreenShotPNGToArray">
11735	<desc>
11736	Takes a guest screen shot of the requested size and returns it as
11737	PNG image in array.
11738
11739	<result name="E_NOTIMPL">
11740	Feature not implemented.
11741	</result>
11742	<result name="VBOX_E_IPRT_ERROR">
11743	Could not take a screenshot.
11744	</result>
11745	</desc>
11746	<param name="screenId" type="unsigned long" dir="in">
11747	<desc>
11748	Monitor to take the screenshot from.
11749	</desc>
11750	</param>
11751	<param name="width" type="unsigned long" dir="in">
11752	<desc>
11753	Desired image width.
11754	</desc>
11755	</param>
11756	<param name="height" type="unsigned long" dir="in">
11757	<desc>
11758	Desired image height.
11759	</desc>
11760	</param>
11761	<param name="screenData" type="octet" dir="return" safearray="yes">
11762	<desc>
11763	Array with resulting screen data.
11764	</desc>
11765	</param>
11766	</method>
11767
11768	<method name="drawToScreen">
11769	<desc>
11770	Draws a 32-bpp image of the specified size from the given buffer
11771	to the given point on the VM display.
11772
11773	<result name="E_NOTIMPL">
11774	Feature not implemented.
11775	</result>
11776	<result name="VBOX_E_IPRT_ERROR">
11777	Could not draw to screen.
11778	</result>
11779
11780	</desc>
11781	<param name="screenId" type="unsigned long" dir="in">
11782	<desc>
11783	Monitor to take the screenshot from.
11784	</desc>
11785	</param>
11786	<param name="address" type="octet" mod="ptr" dir="in">
11787	<desc>
11788	Address to store the screenshot to
11789	</desc>
11790	</param>
11791	<param name="x" type="unsigned long" dir="in">
11792	<desc>
11793	Relative to the screen top left corner.
11794	</desc>
11795	</param>
11796	<param name="y" type="unsigned long" dir="in">
11797	<desc>
11798	Relative to the screen top left corner.
11799	</desc>
11800	</param>
11801	<param name="width" type="unsigned long" dir="in">
11802	<desc>
11803	Desired image width.
11804	</desc>
11805	</param>
11806	<param name="height" type="unsigned long" dir="in">
11807	<desc>
11808	Desired image height.
11809	</desc>
11810	</param>
11811	</method>
11812
11813	<method name="invalidateAndUpdate">
11814	<desc>
11815	Does a full invalidation of the VM display and instructs the VM
11816	to update it.
11817
11818	<result name="VBOX_E_IPRT_ERROR">
11819	Could not invalidate and update screen.
11820	</result>
11821
11822	</desc>
11823	</method>
11824
11825	<method name="resizeCompleted">
11826	<desc>
11827	Signals that a framebuffer has completed the resize operation.
11828
11829	<result name="VBOX_E_NOT_SUPPORTED">
11830	Operation only valid for external frame buffers.
11831	</result>
11832
11833	</desc>
11834	<param name="screenId" type="unsigned long" dir="in"/>
11835	</method>
11836
11837	<method name="completeVHWACommand">
11838	<desc>
11839	Signals that the Video HW Acceleration command has completed.
11840	</desc>
11841
11842	<param name="command" type="octet" mod="ptr" dir="in">
11843	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11844	</param>
11845	</method>
11846
11847	</interface>
11848
11849	<!--
11850	// INetworkAdapter
11851	/////////////////////////////////////////////////////////////////////////
11852	-->
11853
11854	<enum
11855	name="NetworkAttachmentType"
11856	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
11857	>
11858	<desc>
11859	Network attachment type.
11860	</desc>
11861
11862	<const name="Null" value="0">
11863	<desc>Null value, also means "not attached".</desc>
11864	</const>
11865	<const name="NAT" value="1"/>
11866	<const name="Bridged" value="2"/>
11867	<const name="Internal" value="3"/>
11868	<const name="HostOnly" value="4"/>
11869	<const name="Generic" value="5"/>
11870	</enum>
11871
11872	<enum
11873	name="NetworkAdapterType"
11874	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11875	>
11876	<desc>
11877	Network adapter type.
11878	</desc>
11879
11880	<const name="Null" value="0">
11881	<desc>Null value (never used by the API).</desc>
11882	</const>
11883	<const name="Am79C970A" value="1">
11884	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11885	</const>
11886	<const name="Am79C973" value="2">
11887	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11888	</const>
11889	<const name="I82540EM" value="3">
11890	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11891	</const>
11892	<const name="I82543GC" value="4">
11893	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11894	</const>
11895	<const name="I82545EM" value="5">
11896	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11897	</const>
11898	<const name="Virtio" value="6">
11899	<desc>Virtio network device.</desc>
11900	</const>
11901	</enum>
11902
11903	<enum
11904	name="NetworkAdapterPromiscModePolicy"
11905	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
11906	>
11907	<desc>
11908	The promiscuous mode policy of an interface.
11909	</desc>
11910
11911	<const name="Deny" value="1">
11912	<desc>Deny promiscuous mode requests.</desc>
11913	</const>
11914	<const name="AllowNetwork" value="2">
11915	<desc>
11916	Allow promicuous mode, but restrict the scope it to the internal
11917	network so that it only applies to other VMs.
11918	</desc>
11919	</const>
11920	<const name="AllowAll" value="3">
11921	<desc>
11922	Allow promicuous mode, include unrelated traffic going over the wire
11923	and internally on the host.
11924	</desc>
11925	</const>
11926	</enum>
11927
11928	<interface
11929	name="INetworkAdapter" extends="$unknown"
11930	uuid="b22f71f6-082e-4a1d-aaf2-3ce40e275dd9"
11931	wsmap="managed"
11932	>
11933	<desc>
11934	Represents a virtual network adapter that is attached to a virtual machine.
11935	Each virtual machine has a fixed number of network adapter slots with one
11936	instance of this attached to each of them. Call
11937	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11938	is attached to a given slot in a given machine.
11939
11940	Each network adapter can be in one of five attachment modes, which are
11941	represented by the <link to="NetworkAttachmentType" /> enumeration;
11942	see the <link to="#attachmentType" /> attribute.
11943	</desc>
11944
11945	<attribute name="adapterType" type="NetworkAdapterType">
11946	<desc>
11947	Type of the virtual network adapter. Depending on this value,
11948	VirtualBox will provide a different virtual network hardware
11949	to the guest.
11950	</desc>
11951	</attribute>
11952
11953	<attribute name="slot" type="unsigned long" readonly="yes">
11954	<desc>
11955	Slot number this adapter is plugged into. Corresponds to
11956	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11957	to obtain this instance.
11958	</desc>
11959	</attribute>
11960
11961	<attribute name="enabled" type="boolean">
11962	<desc>
11963	Flag whether the network adapter is present in the
11964	guest system. If disabled, the virtual guest hardware will
11965	not contain this network adapter. Can only be changed when
11966	the VM is not running.
11967	</desc>
11968	</attribute>
11969
11970	<attribute name="MACAddress" type="wstring">
11971	<desc>
11972	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11973	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11974	</desc>
11975	</attribute>
11976
11977	<attribute name="attachmentType" type="NetworkAttachmentType">
11978	<desc>
11979	Sets/Gets network attachment type of this network adapter.
11980	</desc>
11981	</attribute>
11982
11983	<attribute name="bridgedInterface" type="wstring">
11984	<desc>
11985	Name of the network interface the VM should be bridged to.
11986	</desc>
11987	</attribute>
11988
11989	<attribute name="hostOnlyInterface" type="wstring">
11990	<desc>
11991	Name of the host only network interface the VM is attached to.
11992	</desc>
11993	</attribute>
11994
11995	<attribute name="internalNetwork" type="wstring">
11996	<desc>
11997	Name of the internal network the VM is attached to.
11998	</desc>
11999	</attribute>
12000
12001	<attribute name="NATNetwork" type="wstring">
12002	<desc>
12003	Name of the NAT network the VM is attached to.
12004	</desc>
12005	</attribute>
12006
12007	<attribute name="genericDriver" type="wstring">
12008	<desc>
12009	Name of the driver to use for the "Generic" network attachment type.
12010	</desc>
12011	</attribute>
12012
12013	<attribute name="cableConnected" type="boolean">
12014	<desc>
12015	Flag whether the adapter reports the cable as connected or not.
12016	It can be used to report offline situations to a VM.
12017	</desc>
12018	</attribute>
12019
12020	<attribute name="lineSpeed" type="unsigned long">
12021	<desc>
12022	Line speed reported by custom drivers, in units of 1 kbps.
12023	</desc>
12024	</attribute>
12025
12026	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12027	<desc>
12028	The promiscuous mode policy of the network adapter when attached to an
12029	internal network, host only network or a bridge.
12030	</desc>
12031	</attribute>
12032
12033	<attribute name="traceEnabled" type="boolean">
12034	<desc>
12035	Flag whether network traffic from/to the network card should be traced.
12036	Can only be toggled when the VM is turned off.
12037	</desc>
12038	</attribute>
12039
12040	<attribute name="traceFile" type="wstring">
12041	<desc>
12042	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12043	will be used.
12044	</desc>
12045	</attribute>
12046
12047	<attribute name="natDriver" type="INATEngine" readonly="yes">
12048	<desc>
12049	Points to the NAT engine which handles the network address translation
12050	for this interface. This is active only when the interface actually uses
12051	NAT.
12052	</desc>
12053	</attribute>
12054
12055	<attribute name="bootPriority" type="unsigned long">
12056	<desc>
12057	Network boot priority of the adapter. Priority 1 is highest. If not set,
12058	the priority is considered to be at the lowest possible setting.
12059	</desc>
12060	</attribute>
12061
12062	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12063	<desc>The bandwidth group this network adapter is assigned to.</desc>
12064	</attribute>
12065
12066	<!-- property methods -->
12067
12068	<method name="getProperty">
12069	<desc>
12070	Returns the value of the network attachment property with the given name.
12071
12072	If the requested data @a key does not exist, this function will
12073	succeed and return an empty string in the @a value argument.
12074
12075	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12076	</desc>
12077	<param name="key" type="wstring" dir="in">
12078	<desc>Name of the property to get.</desc>
12079	</param>
12080	<param name="value" type="wstring" dir="return">
12081	<desc>Current property value.</desc>
12082	</param>
12083	</method>
12084
12085	<method name="setProperty">
12086	<desc>
12087	Sets the value of the network attachment property with the given name.
12088
12089	Setting the property value to @c null or an empty string is equivalent
12090	to deleting the existing value.
12091
12092	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12093	</desc>
12094	<param name="key" type="wstring" dir="in">
12095	<desc>Name of the property to set.</desc>
12096	</param>
12097	<param name="value" type="wstring" dir="in">
12098	<desc>Property value to set.</desc>
12099	</param>
12100	</method>
12101
12102	<method name="getProperties">
12103	<desc>
12104	Returns values for a group of properties in one call.
12105
12106	The names of the properties to get are specified using the @a names
12107	argument which is a list of comma-separated property names or
12108	an empty string if all properties are to be returned.
12109	<note>Currently the value of this argument is ignored and the method
12110	always returns all existing properties.</note>
12111
12112	The method returns two arrays, the array of property names corresponding
12113	to the @a names argument and the current values of these properties.
12114	Both arrays have the same number of elements with each element at the
12115	given index in the first array corresponds to an element at the same
12116	index in the second array.
12117	</desc>
12118	<param name="names" type="wstring" dir="in">
12119	<desc>
12120	Names of properties to get.
12121	</desc>
12122	</param>
12123	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12124	<desc>Names of returned properties.</desc>
12125	</param>
12126	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12127	<desc>Values of returned properties.</desc>
12128	</param>
12129	</method>
12130
12131	</interface>
12132
12133
12134	<!--
12135	// ISerialPort
12136	/////////////////////////////////////////////////////////////////////////
12137	-->
12138
12139	<enum
12140	name="PortMode"
12141	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12142	>
12143	<desc>
12144	The PortMode enumeration represents possible communication modes for
12145	the virtual serial port device.
12146	</desc>
12147
12148	<const name="Disconnected" value="0">
12149	<desc>Virtual device is not attached to any real host device.</desc>
12150	</const>
12151	<const name="HostPipe" value="1">
12152	<desc>Virtual device is attached to a host pipe.</desc>
12153	</const>
12154	<const name="HostDevice" value="2">
12155	<desc>Virtual device is attached to a host device.</desc>
12156	</const>
12157	<const name="RawFile" value="3">
12158	<desc>Virtual device is attached to a raw file.</desc>
12159	</const>
12160	</enum>
12161
12162	<interface
12163	name="ISerialPort" extends="$unknown"
12164	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12165	wsmap="managed"
12166	>
12167
12168	<desc>
12169	The ISerialPort interface represents the virtual serial port device.
12170
12171	The virtual serial port device acts like an ordinary serial port
12172	inside the virtual machine. This device communicates to the real
12173	serial port hardware in one of two modes: host pipe or host device.
12174
12175	In host pipe mode, the #path attribute specifies the path to the pipe on
12176	the host computer that represents a serial port. The #server attribute
12177	determines if this pipe is created by the virtual machine process at
12178	machine startup or it must already exist before starting machine
12179	execution.
12180
12181	In host device mode, the #path attribute specifies the name of the
12182	serial port device on the host computer.
12183
12184	There is also a third communication mode: the disconnected mode. In this
12185	mode, the guest OS running inside the virtual machine will be able to
12186	detect the serial port, but all port write operations will be discarded
12187	and all port read operations will return no data.
12188
12189	<see>IMachine::getSerialPort</see>
12190	</desc>
12191
12192	<attribute name="slot" type="unsigned long" readonly="yes">
12193	<desc>
12194	Slot number this serial port is plugged into. Corresponds to
12195	the value you pass to <link to="IMachine::getSerialPort"/>
12196	to obtain this instance.
12197	</desc>
12198	</attribute>
12199
12200	<attribute name="enabled" type="boolean">
12201	<desc>
12202	Flag whether the serial port is enabled. If disabled,
12203	the serial port will not be reported to the guest OS.
12204	</desc>
12205	</attribute>
12206
12207	<attribute name="IOBase" type="unsigned long">
12208	<desc>Base I/O address of the serial port.</desc>
12209	</attribute>
12210
12211	<attribute name="IRQ" type="unsigned long">
12212	<desc>IRQ number of the serial port.</desc>
12213	</attribute>
12214
12215	<attribute name="hostMode" type="PortMode">
12216	<desc>
12217	How is this port connected to the host.
12218	<note>
12219	Changing this attribute may fail if the conditions for
12220	<link to="#path"/> are not met.
12221	</note>
12222	</desc>
12223	</attribute>
12224
12225	<attribute name="server" type="boolean">
12226	<desc>
12227	Flag whether this serial port acts as a server (creates a new pipe on
12228	the host) or as a client (uses the existing pipe). This attribute is
12229	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12230	</desc>
12231	</attribute>
12232
12233	<attribute name="path" type="wstring">
12234	<desc>
12235	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12236	PortMode_HostPipe, or the host serial device name when
12237	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12238	cases, setting a @c null or empty string as the attribute's value
12239	is an error. Otherwise, the value of this property is ignored.
12240	</desc>
12241	</attribute>
12242
12243	</interface>
12244
12245	<!--
12246	// IParallelPort
12247	/////////////////////////////////////////////////////////////////////////
12248	-->
12249
12250	<interface
12251	name="IParallelPort" extends="$unknown"
12252	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12253	wsmap="managed"
12254	>
12255
12256	<desc>
12257	The IParallelPort interface represents the virtual parallel port device.
12258
12259	The virtual parallel port device acts like an ordinary parallel port
12260	inside the virtual machine. This device communicates to the real
12261	parallel port hardware using the name of the parallel device on the host
12262	computer specified in the #path attribute.
12263
12264	Each virtual parallel port device is assigned a base I/O address and an
12265	IRQ number that will be reported to the guest operating system and used
12266	to operate the given parallel port from within the virtual machine.
12267
12268	<see>IMachine::getParallelPort</see>
12269	</desc>
12270
12271	<attribute name="slot" type="unsigned long" readonly="yes">
12272	<desc>
12273	Slot number this parallel port is plugged into. Corresponds to
12274	the value you pass to <link to="IMachine::getParallelPort"/>
12275	to obtain this instance.
12276	</desc>
12277	</attribute>
12278
12279	<attribute name="enabled" type="boolean">
12280	<desc>
12281	Flag whether the parallel port is enabled. If disabled,
12282	the parallel port will not be reported to the guest OS.
12283	</desc>
12284	</attribute>
12285
12286	<attribute name="IOBase" type="unsigned long">
12287	<desc>Base I/O address of the parallel port.</desc>
12288	</attribute>
12289
12290	<attribute name="IRQ" type="unsigned long">
12291	<desc>IRQ number of the parallel port.</desc>
12292	</attribute>
12293
12294	<attribute name="path" type="wstring">
12295	<desc>
12296	Host parallel device name. If this parallel port is enabled, setting a
12297	@c null or an empty string as this attribute's value will result in
12298	an error.
12299	</desc>
12300	</attribute>
12301
12302	</interface>
12303
12304
12305	<!--
12306	// IMachineDebugger
12307	/////////////////////////////////////////////////////////////////////////
12308	-->
12309
12310	<interface
12311	name="IMachineDebugger" extends="$unknown"
12312	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12313	wsmap="suppress"
12314	>
12315	<method name="dumpGuestCore">
12316	<desc>
12317	Takes a core dump of the guest.
12318
12319	See include/VBox/dbgfcorefmt.h for details on the file format.
12320	</desc>
12321	<param name="filename" type="wstring" dir="in">
12322	<desc>
12323	The name of the output file. The file must not exist.
12324	</desc>
12325	</param>
12326	<param name="compression" type="wstring" dir="in">
12327	<desc>
12328	Reserved for future compression method indicator.
12329	</desc>
12330	</param>
12331	</method>
12332
12333	<method name="dumpHostProcessCore">
12334	<desc>
12335	Takes a core dump of the VM process on the host.
12336
12337	This feature is not implemented in the 4.0.0 release but it may show up
12338	in a dot release.
12339	</desc>
12340	<param name="filename" type="wstring" dir="in">
12341	<desc>
12342	The name of the output file. The file must not exist.
12343	</desc>
12344	</param>
12345	<param name="compression" type="wstring" dir="in">
12346	<desc>
12347	Reserved for future compression method indicator.
12348	</desc>
12349	</param>
12350	</method>
12351
12352	<method name="info">
12353	<desc>
12354	Interfaces with the info dumpers (DBGFInfo).
12355
12356	This feature is not implemented in the 4.0.0 release but it may show up
12357	in a dot release.
12358	</desc>
12359	<param name="name" type="wstring" dir="in">
12360	<desc>
12361	The name of the info item.
12362	</desc>
12363	</param>
12364	<param name="args" type="wstring" dir="in">
12365	<desc>
12366	Arguments to the info dumper.
12367	</desc>
12368	</param>
12369	<param name="info" type="wstring" dir="return">
12370	<desc>
12371	The into string.
12372	</desc>
12373	</param>
12374	</method>
12375
12376	<method name="injectNMI">
12377	<desc>
12378	Inject an NMI into a running VT-x/AMD-V VM.
12379	</desc>
12380	</method>
12381
12382	<method name="modifyLogGroups">
12383	<desc>
12384	Modifies the group settings of the debug logger.
12385
12386	This feature is not implemented in the 4.0.0 release but may show up
12387	in a dot release.
12388	</desc>
12389	<param name="settings" type="wstring" dir="in">
12390	<desc>The group settings string. See iprt/log.h for details.</desc>
12391	</param>
12392	</method>
12393
12394	<method name="modifyLogFlags">
12395	<desc>
12396	Modifies the debug logger flags.
12397
12398	This feature is not implemented in the 4.0.0 release but may show up
12399	in a dot release.
12400	</desc>
12401	<param name="settings" type="wstring" dir="in">
12402	<desc>The flags settings string. See iprt/log.h for details.</desc>
12403	</param>
12404	</method>
12405
12406	<method name="modifyLogDestinations">
12407	<desc>
12408	Modifies the debug logger destinations.
12409
12410	This feature is not implemented in the 4.0.0 release but may show up
12411	in a dot release.
12412	</desc>
12413	<param name="settings" type="wstring" dir="in">
12414	<desc>The destination settings string. See iprt/log.h for details.</desc>
12415	</param>
12416	</method>
12417
12418	<method name="readPhysicalMemory">
12419	<desc>
12420	Reads guest physical memory, no side effects (MMIO++).
12421
12422	This feature is not implemented in the 4.0.0 release but may show up
12423	in a dot release.
12424	</desc>
12425	<param name="address" type="long long" dir="in">
12426	<desc>The guest physical address.</desc>
12427	</param>
12428	<param name="size" type="unsigned long" dir="in">
12429	<desc>The number of bytes to read.</desc>
12430	</param>
12431	<param name="bytes" type="octet" safearray="yes" dir="return">
12432	<desc>The bytes read.</desc>
12433	</param>
12434	</method>
12435
12436	<method name="writePhysicalMemory">
12437	<desc>
12438	Writes guest physical memory, access handles (MMIO++) are ignored.
12439
12440	This feature is not implemented in the 4.0.0 release but may show up
12441	in a dot release.
12442	</desc>
12443	<param name="address" type="long long" dir="in">
12444	<desc>The guest physical address.</desc>
12445	</param>
12446	<param name="size" type="unsigned long" dir="in">
12447	<desc>The number of bytes to read.</desc>
12448	</param>
12449	<param name="bytes" type="octet" safearray="yes" dir="in">
12450	<desc>The bytes to write.</desc>
12451	</param>
12452	</method>
12453
12454	<method name="readVirtualMemory">
12455	<desc>
12456	Reads guest virtual memory, no side effects (MMIO++).
12457
12458	This feature is not implemented in the 4.0.0 release but may show up
12459	in a dot release.
12460	</desc>
12461	<param name="cpuId" type="unsigned long" dir="in">
12462	<desc>The identifier of the Virtual CPU.</desc>
12463	</param>
12464	<param name="address" type="long long" dir="in">
12465	<desc>The guest virtual address.</desc>
12466	</param>
12467	<param name="size" type="unsigned long" dir="in">
12468	<desc>The number of bytes to read.</desc>
12469	</param>
12470	<param name="bytes" type="octet" safearray="yes" dir="return">
12471	<desc>The bytes read.</desc>
12472	</param>
12473	</method>
12474
12475	<method name="writeVirtualMemory">
12476	<desc>
12477	Writes guest virtual memory, access handles (MMIO++) are ignored.
12478
12479	This feature is not implemented in the 4.0.0 release but may show up
12480	in a dot release.
12481	</desc>
12482	<param name="cpuId" type="unsigned long" dir="in">
12483	<desc>The identifier of the Virtual CPU.</desc>
12484	</param>
12485	<param name="address" type="long long" dir="in">
12486	<desc>The guest virtual address.</desc>
12487	</param>
12488	<param name="size" type="unsigned long" dir="in">
12489	<desc>The number of bytes to read.</desc>
12490	</param>
12491	<param name="bytes" type="octet" safearray="yes" dir="in">
12492	<desc>The bytes to write.</desc>
12493	</param>
12494	</method>
12495
12496	<method name="detectOS">
12497	<desc>
12498	Tries to (re-)detect the guest OS kernel.
12499
12500	This feature is not implemented in the 4.0.0 release but may show up
12501	in a dot release.
12502	</desc>
12503	<param name="os" type="wstring" dir="return">
12504	<desc>
12505	The detected OS kernel on success.
12506	</desc>
12507	</param>
12508	</method>
12509
12510	<method name="getRegister">
12511	<desc>
12512	Gets one register.
12513
12514	This feature is not implemented in the 4.0.0 release but may show up
12515	in a dot release.
12516	</desc>
12517	<param name="cpuId" type="unsigned long" dir="in">
12518	<desc>The identifier of the Virtual CPU.</desc>
12519	</param>
12520	<param name="name" type="wstring" dir="in">
12521	<desc>The register name, case is ignored.</desc>
12522	</param>
12523	<param name="value" type="wstring" dir="return">
12524	<desc>
12525	The register value. This is usually a hex value (always 0x prefixed)
12526	but other format may be used for floating point registers (TBD).
12527	</desc>
12528	</param>
12529	</method>
12530
12531	<method name="getRegisters">
12532	<desc>
12533	Gets all the registers for the given CPU.
12534
12535	This feature is not implemented in the 4.0.0 release but may show up
12536	in a dot release.
12537	</desc>
12538	<param name="cpuId" type="unsigned long" dir="in">
12539	<desc>The identifier of the Virtual CPU.</desc>
12540	</param>
12541	<param name="names" type="wstring" dir="out" safearray="yes">
12542	<desc>Array containing the lowercase register names.</desc>
12543	</param>
12544	<param name="values" type="wstring" dir="out" safearray="yes">
12545	<desc>
12546	Array paralell to the names holding the register values as if the
12547	register was returned by <link to="IMachineDebugger::getRegister"/>.
12548	</desc>
12549	</param>
12550	</method>
12551
12552	<method name="setRegister">
12553	<desc>
12554	Gets one register.
12555
12556	This feature is not implemented in the 4.0.0 release but may show up
12557	in a dot release.
12558	</desc>
12559	<param name="cpuId" type="unsigned long" dir="in">
12560	<desc>The identifier of the Virtual CPU.</desc>
12561	</param>
12562	<param name="name" type="wstring" dir="in">
12563	<desc>The register name, case is ignored.</desc>
12564	</param>
12565	<param name="value" type="wstring" dir="in">
12566	<desc>
12567	The new register value. Hexadecimal, decimal and octal formattings
12568	are supported in addition to any special formattings returned by
12569	the getters.
12570	</desc>
12571	</param>
12572	</method>
12573
12574	<method name="setRegisters">
12575	<desc>
12576	Sets zero or more registers atomically.
12577
12578	This feature is not implemented in the 4.0.0 release but may show up
12579	in a dot release.
12580	</desc>
12581	<param name="cpuId" type="unsigned long" dir="in">
12582	<desc>The identifier of the Virtual CPU.</desc>
12583	</param>
12584	<param name="names" type="wstring" dir="in" safearray="yes">
12585	<desc>Array containing the register names, case ignored.</desc>
12586	</param>
12587	<param name="values" type="wstring" dir="in" safearray="yes">
12588	<desc>
12589	Array paralell to the names holding the register values. See
12590	<link to="IMachineDebugger::setRegister"/> for formatting
12591	guidelines.
12592	</desc>
12593	</param>
12594	</method>
12595
12596	<method name="dumpGuestStack">
12597	<desc>
12598	Produce a simple stack dump using the current guest state.
12599
12600	This feature is not implemented in the 4.0.0 release but may show up
12601	in a dot release.
12602	</desc>
12603	<param name="cpuId" type="unsigned long" dir="in">
12604	<desc>The identifier of the Virtual CPU.</desc>
12605	</param>
12606	<param name="stack" type="wstring" dir="return">
12607	<desc>String containing the formatted stack dump.</desc>
12608	</param>
12609	</method>
12610
12611	<method name="resetStats">
12612	<desc>
12613	Reset VM statistics.
12614	</desc>
12615	<param name="pattern" type="wstring" dir="in">
12616	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12617	</param>
12618	</method>
12619
12620	<method name="dumpStats">
12621	<desc>
12622	Dumps VM statistics.
12623	</desc>
12624	<param name="pattern" type="wstring" dir="in">
12625	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12626	</param>
12627	</method>
12628
12629	<method name="getStats">
12630	<desc>
12631	Get the VM statistics in a XMLish format.
12632	</desc>
12633	<param name="pattern" type="wstring" dir="in">
12634	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12635	</param>
12636	<param name="withDescriptions" type="boolean" dir="in">
12637	<desc>Whether to include the descriptions.</desc>
12638	</param>
12639	<param name="stats" type="wstring" dir="out">
12640	<desc>The XML document containing the statistics.</desc>
12641	</param>
12642	</method>
12643
12644	<attribute name="singlestep" type="boolean">
12645	<desc>Switch for enabling singlestepping.</desc>
12646	</attribute>
12647
12648	<attribute name="recompileUser" type="boolean">
12649	<desc>Switch for forcing code recompilation for user mode code.</desc>
12650	</attribute>
12651
12652	<attribute name="recompileSupervisor" type="boolean">
12653	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12654	</attribute>
12655
12656	<attribute name="PATMEnabled" type="boolean">
12657	<desc>Switch for enabling and disabling the PATM component.</desc>
12658	</attribute>
12659
12660	<attribute name="CSAMEnabled" type="boolean">
12661	<desc>Switch for enabling and disabling the CSAM component.</desc>
12662	</attribute>
12663
12664	<attribute name="logEnabled" type="boolean">
12665	<desc>Switch for enabling and disabling the debug logger.</desc>
12666	</attribute>
12667
12668	<attribute name="logFlags" type="wstring" readonly="yes">
12669	<desc>The debug logger flags.</desc>
12670	</attribute>
12671
12672	<attribute name="logGroups" type="wstring" readonly="yes">
12673	<desc>The debug logger's group settings.</desc>
12674	</attribute>
12675
12676	<attribute name="logDestinations" type="wstring" readonly="yes">
12677	<desc>The debug logger's destination settings.</desc>
12678	</attribute>
12679
12680	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12681	<desc>
12682	Flag indicating whether the VM is currently making use of CPU hardware
12683	virtualization extensions.
12684	</desc>
12685	</attribute>
12686
12687	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12688	<desc>
12689	Flag indicating whether the VM is currently making use of the nested paging
12690	CPU hardware virtualization extension.
12691	</desc>
12692	</attribute>
12693
12694	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12695	<desc>
12696	Flag indicating whether the VM is currently making use of the VPID
12697	VT-x extension.
12698	</desc>
12699	</attribute>
12700
12701	<attribute name="OSName" type="wstring" readonly="yes">
12702	<desc>
12703	Query the guest OS kernel name as detected by the DBGF.
12704
12705	This feature is not implemented in the 4.0.0 release but may show up
12706	in a dot release.
12707	</desc>
12708	</attribute>
12709
12710	<attribute name="OSVersion" type="wstring" readonly="yes">
12711	<desc>
12712	Query the guest OS kernel version string as detected by the DBGF.
12713
12714	This feature is not implemented in the 4.0.0 release but may show up
12715	in a dot release.
12716	</desc>
12717	</attribute>
12718
12719	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12720	<desc>
12721	Flag indicating whether the VM is currently making use of the Physical
12722	Address Extension CPU feature.
12723	</desc>
12724	</attribute>
12725
12726	<attribute name="virtualTimeRate" type="unsigned long">
12727	<desc>
12728	The rate at which the virtual time runs expressed as a percentage.
12729	The accepted range is 2% to 20000%.
12730	</desc>
12731	</attribute>
12732
12733	<attribute name="VM" type="long long" readonly="yes">
12734	<desc>
12735	Gets the VM handle. This is only for internal use while
12736	we carve the details of this interface.
12737	</desc>
12738	</attribute>
12739
12740	</interface>
12741
12742	<!--
12743	// IUSBController
12744	/////////////////////////////////////////////////////////////////////////
12745	-->
12746
12747	<interface
12748	name="IUSBController" extends="$unknown"
12749	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12750	wsmap="managed"
12751	>
12752	<attribute name="enabled" type="boolean">
12753	<desc>
12754	Flag whether the USB controller is present in the
12755	guest system. If disabled, the virtual guest hardware will
12756	not contain any USB controller. Can only be changed when
12757	the VM is powered off.
12758	</desc>
12759	</attribute>
12760
12761	<attribute name="enabledEhci" type="boolean">
12762	<desc>
12763	Flag whether the USB EHCI controller is present in the
12764	guest system. If disabled, the virtual guest hardware will
12765	not contain a USB EHCI controller. Can only be changed when
12766	the VM is powered off.
12767	</desc>
12768	</attribute>
12769
12770	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12771	<desc>
12772	Flag whether there is an USB proxy available.
12773	</desc>
12774	</attribute>
12775
12776	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12777	<desc>
12778	USB standard version which the controller implements.
12779	This is a BCD which means that the major version is in the
12780	high byte and minor version is in the low byte.
12781	</desc>
12782	</attribute>
12783
12784	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12785	<desc>
12786	List of USB device filters associated with the machine.
12787
12788	If the machine is currently running, these filters are activated
12789	every time a new (supported) USB device is attached to the host
12790	computer that was not ignored by global filters
12791	(<link to="IHost::USBDeviceFilters"/>).
12792
12793	These filters are also activated when the machine is powered up.
12794	They are run against a list of all currently available USB
12795	devices (in states
12796	<link to="USBDeviceState_Available"/>,
12797	<link to="USBDeviceState_Busy"/>,
12798	<link to="USBDeviceState_Held"/>) that were not previously
12799	ignored by global filters.
12800
12801	If at least one filter matches the USB device in question, this
12802	device is automatically captured (attached to) the virtual USB
12803	controller of this machine.
12804
12805	<see>IUSBDeviceFilter, ::IUSBController</see>
12806	</desc>
12807	</attribute>
12808
12809	<method name="createDeviceFilter">
12810	<desc>
12811	Creates a new USB device filter. All attributes except
12812	the filter name are set to empty (any match),
12813	<i>active</i> is @c false (the filter is not active).
12814
12815	The created filter can then be added to the list of filters using
12816	<link to="#insertDeviceFilter"/>.
12817
12818	<result name="VBOX_E_INVALID_VM_STATE">
12819	The virtual machine is not mutable.
12820	</result>
12821
12822	<see>#deviceFilters</see>
12823	</desc>
12824	<param name="name" type="wstring" dir="in">
12825	<desc>
12826	Filter name. See <link to="IUSBDeviceFilter::name"/>
12827	for more info.
12828	</desc>
12829	</param>
12830	<param name="filter" type="IUSBDeviceFilter" dir="return">
12831	<desc>Created filter object.</desc>
12832	</param>
12833	</method>
12834
12835	<method name="insertDeviceFilter">
12836	<desc>
12837	Inserts the given USB device to the specified position
12838	in the list of filters.
12839
12840	Positions are numbered starting from <tt>0</tt>. If the specified
12841	position is equal to or greater than the number of elements in
12842	the list, the filter is added to the end of the collection.
12843
12844	<note>
12845	Duplicates are not allowed, so an attempt to insert a
12846	filter that is already in the collection, will return an
12847	error.
12848	</note>
12849
12850	<result name="VBOX_E_INVALID_VM_STATE">
12851	Virtual machine is not mutable.
12852	</result>
12853	<result name="E_INVALIDARG">
12854	USB device filter not created within this VirtualBox instance.
12855	</result>
12856	<result name="VBOX_E_INVALID_OBJECT_STATE">
12857	USB device filter already in list.
12858	</result>
12859
12860	<see>#deviceFilters</see>
12861	</desc>
12862	<param name="position" type="unsigned long" dir="in">
12863	<desc>Position to insert the filter to.</desc>
12864	</param>
12865	<param name="filter" type="IUSBDeviceFilter" dir="in">
12866	<desc>USB device filter to insert.</desc>
12867	</param>
12868	</method>
12869
12870	<method name="removeDeviceFilter">
12871	<desc>
12872	Removes a USB device filter from the specified position in the
12873	list of filters.
12874
12875	Positions are numbered starting from <tt>0</tt>. Specifying a
12876	position equal to or greater than the number of elements in
12877	the list will produce an error.
12878
12879	<see>#deviceFilters</see>
12880
12881	<result name="VBOX_E_INVALID_VM_STATE">
12882	Virtual machine is not mutable.
12883	</result>
12884	<result name="E_INVALIDARG">
12885	USB device filter list empty or invalid @a position.
12886	</result>
12887
12888	</desc>
12889	<param name="position" type="unsigned long" dir="in">
12890	<desc>Position to remove the filter from.</desc>
12891	</param>
12892	<param name="filter" type="IUSBDeviceFilter" dir="return">
12893	<desc>Removed USB device filter.</desc>
12894	</param>
12895	</method>
12896
12897	</interface>
12898
12899
12900	<!--
12901	// IUSBDevice
12902	/////////////////////////////////////////////////////////////////////////
12903	-->
12904
12905	<interface
12906	name="IUSBDevice" extends="$unknown"
12907	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12908	wsmap="managed"
12909	>
12910	<desc>
12911	The IUSBDevice interface represents a virtual USB device attached to the
12912	virtual machine.
12913
12914	A collection of objects implementing this interface is stored in the
12915	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12916	attached to a running virtual machine's USB controller.
12917	</desc>
12918
12919	<attribute name="id" type="uuid" mod="string" readonly="yes">
12920	<desc>
12921	Unique USB device ID. This ID is built from #vendorId,
12922	#productId, #revision and #serialNumber.
12923	</desc>
12924	</attribute>
12925
12926	<attribute name="vendorId" type="unsigned short" readonly="yes">
12927	<desc>Vendor ID.</desc>
12928	</attribute>
12929
12930	<attribute name="productId" type="unsigned short" readonly="yes">
12931	<desc>Product ID.</desc>
12932	</attribute>
12933
12934	<attribute name="revision" type="unsigned short" readonly="yes">
12935	<desc>
12936	Product revision number. This is a packed BCD represented as
12937	unsigned short. The high byte is the integer part and the low
12938	byte is the decimal.
12939	</desc>
12940	</attribute>
12941
12942	<attribute name="manufacturer" type="wstring" readonly="yes">
12943	<desc>Manufacturer string.</desc>
12944	</attribute>
12945
12946	<attribute name="product" type="wstring" readonly="yes">
12947	<desc>Product string.</desc>
12948	</attribute>
12949
12950	<attribute name="serialNumber" type="wstring" readonly="yes">
12951	<desc>Serial number string.</desc>
12952	</attribute>
12953
12954	<attribute name="address" type="wstring" readonly="yes">
12955	<desc>Host specific address of the device.</desc>
12956	</attribute>
12957
12958	<attribute name="port" type="unsigned short" readonly="yes">
12959	<desc>
12960	Host USB port number the device is physically
12961	connected to.
12962	</desc>
12963	</attribute>
12964
12965	<attribute name="version" type="unsigned short" readonly="yes">
12966	<desc>
12967	The major USB version of the device - 1 or 2.
12968	</desc>
12969	</attribute>
12970
12971	<attribute name="portVersion" type="unsigned short" readonly="yes">
12972	<desc>
12973	The major USB version of the host USB port the device is
12974	physically connected to - 1 or 2. For devices not connected to
12975	anything this will have the same value as the version attribute.
12976	</desc>
12977	</attribute>
12978
12979	<attribute name="remote" type="boolean" readonly="yes">
12980	<desc>
12981	Whether the device is physically connected to a remote VRDE
12982	client or to a local host machine.
12983	</desc>
12984	</attribute>
12985
12986	</interface>
12987
12988
12989	<!--
12990	// IUSBDeviceFilter
12991	/////////////////////////////////////////////////////////////////////////
12992	-->
12993
12994	<interface
12995	name="IUSBDeviceFilter" extends="$unknown"
12996	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12997	wsmap="managed"
12998	>
12999	<desc>
13000	The IUSBDeviceFilter interface represents an USB device filter used
13001	to perform actions on a group of USB devices.
13002
13003	This type of filters is used by running virtual machines to
13004	automatically capture selected USB devices once they are physically
13005	attached to the host computer.
13006
13007	A USB device is matched to the given device filter if and only if all
13008	attributes of the device match the corresponding attributes of the
13009	filter (that is, attributes are joined together using the logical AND
13010	operation). On the other hand, all together, filters in the list of
13011	filters carry the semantics of the logical OR operation. So if it is
13012	desirable to create a match like "this vendor id OR this product id",
13013	one needs to create two filters and specify "any match" (see below)
13014	for unused attributes.
13015
13016	All filter attributes used for matching are strings. Each string
13017	is an expression representing a set of values of the corresponding
13018	device attribute, that will match the given filter. Currently, the
13019	following filtering expressions are supported:
13020
13021	<ul>
13022	<li><i>Interval filters</i>. Used to specify valid intervals for
13023	integer device attributes (Vendor ID, Product ID and Revision).
13024	The format of the string is:
13025
13026	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13027
13028	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13029	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13030	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13031	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13032	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13033	possible integer is assumed.
13034	</li>
13035	<li><i>Boolean filters</i>. Used to specify acceptable values for
13036	boolean device attributes. The format of the string is:
13037
13038	<tt>true\|false\|yes\|no\|0\|1</tt>
13039
13040	</li>
13041	<li><i>Exact match</i>. Used to specify a single value for the given
13042	device attribute. Any string that doesn't start with <tt>int:</tt>
13043	represents the exact match. String device attributes are compared to
13044	this string including case of symbols. Integer attributes are first
13045	converted to a string (see individual filter attributes) and then
13046	compared ignoring case.
13047
13048	</li>
13049	<li><i>Any match</i>. Any value of the corresponding device attribute
13050	will match the given filter. An empty or @c null string is
13051	used to construct this type of filtering expressions.
13052
13053	</li>
13054	</ul>
13055
13056	<note>
13057	On the Windows host platform, interval filters are not currently
13058	available. Also all string filter attributes
13059	(<link to="#manufacturer"/>, <link to="#product"/>,
13060	<link to="#serialNumber"/>) are ignored, so they behave as
13061	<i>any match</i> no matter what string expression is specified.
13062	</note>
13063
13064	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
13065	</desc>
13066
13067	<attribute name="name" type="wstring">
13068	<desc>
13069	Visible name for this filter.
13070	This name is used to visually distinguish one filter from another,
13071	so it can neither be @c null nor an empty string.
13072	</desc>
13073	</attribute>
13074
13075	<attribute name="active" type="boolean">
13076	<desc>Whether this filter active or has been temporarily disabled.</desc>
13077	</attribute>
13078
13079	<attribute name="vendorId" type="wstring">
13080	<desc>
13081	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
13082	The string representation for the <i>exact matching</i>
13083	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13084	(including leading zeroes).
13085	</desc>
13086	</attribute>
13087
13088	<attribute name="productId" type="wstring">
13089	<desc>
13090	<link to="IUSBDevice::productId">Product ID</link> filter.
13091	The string representation for the <i>exact matching</i>
13092	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13093	(including leading zeroes).
13094	</desc>
13095	</attribute>
13096
13097	<attribute name="revision" type="wstring">
13098	<desc>
13099	<link to="IUSBDevice::productId">Product revision number</link>
13100	filter. The string representation for the <i>exact matching</i>
13101	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
13102	of the integer part of the revision, and <tt>F</tt> is the
13103	decimal digit of its fractional part (including leading and
13104	trailing zeros).
13105	Note that for interval filters, it's best to use the hexadecimal
13106	form, because the revision is stored as a 16 bit packed BCD value;
13107	so the expression <tt>int:0x0100-0x0199</tt> will match any
13108	revision from <tt>1.0</tt> to <tt>1.99</tt>.
13109	</desc>
13110	</attribute>
13111
13112	<attribute name="manufacturer" type="wstring">
13113	<desc>
13114	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
13115	</desc>
13116	</attribute>
13117
13118	<attribute name="product" type="wstring">
13119	<desc>
13120	<link to="IUSBDevice::product">Product</link> filter.
13121	</desc>
13122	</attribute>
13123
13124	<attribute name="serialNumber" type="wstring">
13125	<desc>
13126	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
13127	</desc>
13128	</attribute>
13129
13130	<attribute name="port" type="wstring">
13131	<desc>
13132	<link to="IUSBDevice::port">Host USB port</link> filter.
13133	</desc>
13134	</attribute>
13135
13136	<attribute name="remote" type="wstring">
13137	<desc>
13138	<link to="IUSBDevice::remote">Remote state</link> filter.
13139	<note>
13140	This filter makes sense only for machine USB filters,
13141	i.e. it is ignored by IHostUSBDeviceFilter objects.
13142	</note>
13143	</desc>
13144	</attribute>
13145
13146	<attribute name="maskedInterfaces" type="unsigned long">
13147	<desc>
13148	This is an advanced option for hiding one or more USB interfaces
13149	from the guest. The value is a bit mask where the bits that are set
13150	means the corresponding USB interface should be hidden, masked off
13151	if you like.
13152	This feature only works on Linux hosts.
13153	</desc>
13154	</attribute>
13155
13156	</interface>
13157
13158
13159	<!--
13160	// IHostUSBDevice
13161	/////////////////////////////////////////////////////////////////////////
13162	-->
13163
13164	<enum
13165	name="USBDeviceState"
13166	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
13167	>
13168	<desc>
13169	USB device state. This enumeration represents all possible states
13170	of the USB device physically attached to the host computer regarding
13171	its state on the host computer and availability to guest computers
13172	(all currently running virtual machines).
13173
13174	Once a supported USB device is attached to the host, global USB
13175	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
13176	either ignore the device, or put it to USBDeviceState_Held state, or do
13177	nothing. Unless the device is ignored by global filters, filters of all
13178	currently running guests (<link to="IUSBController::deviceFilters"/>) are
13179	activated that can put it to USBDeviceState_Captured state.
13180
13181	If the device was ignored by global filters, or didn't match
13182	any filters at all (including guest ones), it is handled by the host
13183	in a normal way. In this case, the device state is determined by
13184	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
13185	or USBDeviceState_Available, depending on the current device usage.
13186
13187	Besides auto-capturing based on filters, the device can be manually
13188	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
13189	state is USBDeviceState_Busy, USBDeviceState_Available or
13190	USBDeviceState_Held.
13191
13192	<note>
13193	Due to differences in USB stack implementations in Linux and Win32,
13194	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
13195	only to the Linux version of the product. This also means that (<link
13196	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
13197	device state is USBDeviceState_Held.
13198	</note>
13199
13200	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
13201	</desc>
13202
13203	<const name="NotSupported" value="0">
13204	<desc>
13205	Not supported by the VirtualBox server, not available to guests.
13206	</desc>
13207	</const>
13208	<const name="Unavailable" value="1">
13209	<desc>
13210	Being used by the host computer exclusively,
13211	not available to guests.
13212	</desc>
13213	</const>
13214	<const name="Busy" value="2">
13215	<desc>
13216	Being used by the host computer, potentially available to guests.
13217	</desc>
13218	</const>
13219	<const name="Available" value="3">
13220	<desc>
13221	Not used by the host computer, available to guests (the host computer
13222	can also start using the device at any time).
13223	</desc>
13224	</const>
13225	<const name="Held" value="4">
13226	<desc>
13227	Held by the VirtualBox server (ignored by the host computer),
13228	available to guests.
13229	</desc>
13230	</const>
13231	<const name="Captured" value="5">
13232	<desc>
13233	Captured by one of the guest computers, not available
13234	to anybody else.
13235	</desc>
13236	</const>
13237	</enum>
13238
13239	<interface
13240	name="IHostUSBDevice" extends="IUSBDevice"
13241	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13242	wsmap="managed"
13243	>
13244	<desc>
13245	The IHostUSBDevice interface represents a physical USB device attached
13246	to the host computer.
13247
13248	Besides properties inherited from IUSBDevice, this interface adds the
13249	<link to="#state"/> property that holds the current state of the USB
13250	device.
13251
13252	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
13253	</desc>
13254
13255	<attribute name="state" type="USBDeviceState" readonly="yes">
13256	<desc>
13257	Current state of the device.
13258	</desc>
13259	</attribute>
13260
13261	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13262
13263	</interface>
13264
13265
13266	<!--
13267	// IHostUSBDeviceFilter
13268	/////////////////////////////////////////////////////////////////////////
13269	-->
13270
13271	<enum
13272	name="USBDeviceFilterAction"
13273	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13274	>
13275	<desc>
13276	Actions for host USB device filters.
13277	<see>IHostUSBDeviceFilter, USBDeviceState</see>
13278	</desc>
13279
13280	<const name="Null" value="0">
13281	<desc>Null value (never used by the API).</desc>
13282	</const>
13283	<const name="Ignore" value="1">
13284	<desc>Ignore the matched USB device.</desc>
13285	</const>
13286	<const name="Hold" value="2">
13287	<desc>Hold the matched USB device.</desc>
13288	</const>
13289	</enum>
13290
13291	<interface
13292	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13293	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13294	wsmap="managed"
13295	>
13296	<desc>
13297	The IHostUSBDeviceFilter interface represents a global filter for a
13298	physical USB device used by the host computer. Used indirectly in
13299	<link to="IHost::USBDeviceFilters"/>.
13300
13301	Using filters of this type, the host computer determines the initial
13302	state of the USB device after it is physically attached to the
13303	host's USB controller.
13304
13305	<note>
13306	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13307	filters, because it makes sense only for
13308	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13309	</note>
13310
13311	<see>IHost::USBDeviceFilters</see>
13312	</desc>
13313
13314	<attribute name="action" type="USBDeviceFilterAction">
13315	<desc>
13316	Action performed by the host when an attached USB device
13317	matches this filter.
13318	</desc>
13319	</attribute>
13320
13321	</interface>
13322
13323	<!--
13324	// IAudioAdapter
13325	/////////////////////////////////////////////////////////////////////////
13326	-->
13327
13328	<enum
13329	name="AudioDriverType"
13330	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13331	>
13332	<desc>
13333	Host audio driver type.
13334	</desc>
13335
13336	<const name="Null" value="0">
13337	<desc>Null value, also means "dummy audio driver".</desc>
13338	</const>
13339	<const name="WinMM" value="1">
13340	<desc>Windows multimedia (Windows hosts only).</desc>
13341	</const>
13342	<const name="OSS" value="2">
13343	<desc>Open Sound System (Linux hosts only).</desc>
13344	</const>
13345	<const name="ALSA" value="3">
13346	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13347	</const>
13348	<const name="DirectSound" value="4">
13349	<desc>DirectSound (Windows hosts only).</desc>
13350	</const>
13351	<const name="CoreAudio" value="5">
13352	<desc>CoreAudio (Mac hosts only).</desc>
13353	</const>
13354	<const name="MMPM" value="6">
13355	<desc>Reserved for historical reasons.</desc>
13356	</const>
13357	<const name="Pulse" value="7">
13358	<desc>PulseAudio (Linux hosts only).</desc>
13359	</const>
13360	<const name="SolAudio" value="8">
13361	<desc>Solaris audio (Solaris hosts only).</desc>
13362	</const>
13363	</enum>
13364
13365	<enum
13366	name="AudioControllerType"
13367	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13368	>
13369	<desc>
13370	Virtual audio controller type.
13371	</desc>
13372
13373	<const name="AC97" value="0"/>
13374	<const name="SB16" value="1"/>
13375	<const name="HDA" value="2"/>
13376	</enum>
13377
13378	<interface
13379	name="IAudioAdapter" extends="$unknown"
13380	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13381	wsmap="managed"
13382	>
13383	<desc>
13384	The IAudioAdapter interface represents the virtual audio adapter of
13385	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13386	</desc>
13387	<attribute name="enabled" type="boolean">
13388	<desc>
13389	Flag whether the audio adapter is present in the
13390	guest system. If disabled, the virtual guest hardware will
13391	not contain any audio adapter. Can only be changed when
13392	the VM is not running.
13393	</desc>
13394	</attribute>
13395	<attribute name="audioController" type="AudioControllerType">
13396	<desc>
13397	The audio hardware we emulate.
13398	</desc>
13399	</attribute>
13400	<attribute name="audioDriver" type="AudioDriverType">
13401	<desc>
13402	Audio driver the adapter is connected to. This setting
13403	can only be changed when the VM is not running.
13404	</desc>
13405	</attribute>
13406	</interface>
13407
13408	<enum
13409	name="AuthType"
13410	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13411	>
13412	<desc>
13413	VirtualBox authentication type.
13414	</desc>
13415
13416	<const name="Null" value="0">
13417	<desc>Null value, also means "no authentication".</desc>
13418	</const>
13419	<const name="External" value="1"/>
13420	<const name="Guest" value="2"/>
13421	</enum>
13422
13423	<!--
13424	// IVRDEServer
13425	/////////////////////////////////////////////////////////////////////////
13426	-->
13427
13428	<interface
13429	name="IVRDEServer" extends="$unknown"
13430	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13431	wsmap="managed"
13432	>
13433	<attribute name="enabled" type="boolean">
13434	<desc>VRDE server status.</desc>
13435	</attribute>
13436
13437	<attribute name="authType" type="AuthType">
13438	<desc>VRDE authentication method.</desc>
13439	</attribute>
13440
13441	<attribute name="authTimeout" type="unsigned long">
13442	<desc>Timeout for guest authentication. Milliseconds.</desc>
13443	</attribute>
13444
13445	<attribute name="allowMultiConnection" type="boolean">
13446	<desc>
13447	Flag whether multiple simultaneous connections to the VM are permitted.
13448	Note that this will be replaced by a more powerful mechanism in the future.
13449	</desc>
13450	</attribute>
13451
13452	<attribute name="reuseSingleConnection" type="boolean">
13453	<desc>
13454	Flag whether the existing connection must be dropped and a new connection
13455	must be established by the VRDE server, when a new client connects in single
13456	connection mode.
13457	</desc>
13458	</attribute>
13459
13460	<attribute name="VRDEExtPack" type="wstring">
13461	<desc>
13462	The name of Extension Pack providing VRDE for this VM. Overrides
13463	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13464	</desc>
13465	</attribute>
13466
13467	<attribute name="AuthLibrary" type="wstring">
13468	<desc>
13469	Library used for authentication of RDP clients by this VM. Overrides
13470	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13471	</desc>
13472	</attribute>
13473
13474	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13475	<desc>
13476	Array of names of properties, which are supported by this VRDE server.
13477	</desc>
13478	</attribute>
13479
13480	<method name="setVRDEProperty">
13481	<desc>
13482	Sets a VRDE specific property string.
13483
13484	If you pass @c null or empty string as a key @a value, the given @a key
13485	will be deleted.
13486
13487	</desc>
13488	<param name="key" type="wstring" dir="in">
13489	<desc>Name of the key to set.</desc>
13490	</param>
13491	<param name="value" type="wstring" dir="in">
13492	<desc>Value to assign to the key.</desc>
13493	</param>
13494	</method>
13495
13496	<method name="getVRDEProperty">
13497	<desc>
13498	Returns a VRDE specific property string.
13499
13500	If the requested data @a key does not exist, this function will
13501	succeed and return an empty string in the @a value argument.
13502
13503	</desc>
13504	<param name="key" type="wstring" dir="in">
13505	<desc>Name of the key to get.</desc>
13506	</param>
13507	<param name="value" type="wstring" dir="return">
13508	<desc>Value of the requested key.</desc>
13509	</param>
13510	</method>
13511
13512	</interface>
13513
13514
13515	<!--
13516	// ISharedFolder
13517	/////////////////////////////////////////////////////////////////////////
13518	-->
13519
13520	<interface
13521	name="ISharedFolder" extends="$unknown"
13522	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13523	wsmap="struct"
13524	>
13525	<desc>
13526	The ISharedFolder interface represents a folder in the host computer's
13527	file system accessible from the guest OS running inside a virtual
13528	machine using an associated logical name.
13529
13530	There are three types of shared folders:
13531	<ul>
13532	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13533	folders available to all virtual machines.</li>
13534	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13535	VM-specific shared folders available to the given virtual machine at
13536	startup.</li>
13537	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13538	VM-specific shared folders created in the session context (for
13539	example, when the virtual machine is running) and automatically
13540	discarded when the session is closed (the VM is powered off).</li>
13541	</ul>
13542
13543	Logical names of shared folders must be unique within the given scope
13544	(global, permanent or transient). However, they do not need to be unique
13545	across scopes. In this case, the definition of the shared folder in a
13546	more specific scope takes precedence over definitions in all other
13547	scopes. The order of precedence is (more specific to more general):
13548	<ol>
13549	<li>Transient definitions</li>
13550	<li>Permanent definitions</li>
13551	<li>Global definitions</li>
13552	</ol>
13553
13554	For example, if MyMachine has a shared folder named
13555	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13556	transient shared folder named <tt>C_DRIVE</tt> (that points
13557	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13558	of <tt>C_DRIVE</tt> in the guest OS so
13559	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13560	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13561	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13562	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13563	to <tt>C:\\</tt> if it still exists.
13564
13565	Note that permanent and transient shared folders of different machines
13566	are in different name spaces, so they don't overlap and don't need to
13567	have unique logical names.
13568
13569	<note>
13570	Global shared folders are not implemented in the current version of the
13571	product.
13572	</note>
13573	</desc>
13574
13575	<attribute name="name" type="wstring" readonly="yes">
13576	<desc>Logical name of the shared folder.</desc>
13577	</attribute>
13578
13579	<attribute name="hostPath" type="wstring" readonly="yes">
13580	<desc>Full path to the shared folder in the host file system.</desc>
13581	</attribute>
13582
13583	<attribute name="accessible" type="boolean" readonly="yes">
13584	<desc>
13585	Whether the folder defined by the host path is currently
13586	accessible or not.
13587	For example, the folder can be inaccessible if it is placed
13588	on the network share that is not available by the time
13589	this property is read.
13590	</desc>
13591	</attribute>
13592
13593	<attribute name="writable" type="boolean" readonly="yes">
13594	<desc>
13595	Whether the folder defined by the host path is writable or
13596	not.
13597	</desc>
13598	</attribute>
13599
13600	<attribute name="autoMount" type="boolean" readonly="yes">
13601	<desc>
13602	Whether the folder gets automatically mounted by the guest or not.
13603	</desc>
13604	</attribute>
13605
13606	<attribute name="lastAccessError" type="wstring" readonly="yes">
13607	<desc>
13608	Text message that represents the result of the last accessibility
13609	check.
13610
13611	Accessibility checks are performed each time the <link to="#accessible"/>
13612	attribute is read. An empty string is returned if the last
13613	accessibility check was successful. A non-empty string indicates a
13614	failure and should normally describe a reason of the failure (for
13615	example, a file read error).
13616	</desc>
13617	</attribute>
13618
13619	</interface>
13620
13621	<!--
13622	// ISession
13623	/////////////////////////////////////////////////////////////////////////
13624	-->
13625
13626	<interface
13627	name="IInternalSessionControl" extends="$unknown"
13628	uuid="3a975b65-27e7-42fa-9176-d097d7bd78d4"
13629	internal="yes"
13630	wsmap="suppress"
13631	>
13632	<method name="getPID">
13633	<desc>PID of the process that has created this Session object.
13634	</desc>
13635	<param name="pid" type="unsigned long" dir="return"/>
13636	</method>
13637
13638	<method name="getRemoteConsole">
13639	<desc>
13640	Returns the console object suitable for remote control.
13641
13642	<result name="VBOX_E_INVALID_VM_STATE">
13643	Session state prevents operation.
13644	</result>
13645	<result name="VBOX_E_INVALID_OBJECT_STATE">
13646	Session type prevents operation.
13647	</result>
13648
13649	</desc>
13650	<param name="console" type="IConsole" dir="return"/>
13651	</method>
13652
13653	<method name="assignMachine">
13654	<desc>
13655	Assigns the machine object associated with this direct-type
13656	session or informs the session that it will be a remote one
13657	(if @a machine == @c null).
13658
13659	<result name="VBOX_E_INVALID_VM_STATE">
13660	Session state prevents operation.
13661	</result>
13662	<result name="VBOX_E_INVALID_OBJECT_STATE">
13663	Session type prevents operation.
13664	</result>
13665
13666	</desc>
13667	<param name="machine" type="IMachine" dir="in"/>
13668	</method>
13669
13670	<method name="assignRemoteMachine">
13671	<desc>
13672	Assigns the machine and the (remote) console object associated with
13673	this remote-type session.
13674
13675	<result name="VBOX_E_INVALID_VM_STATE">
13676	Session state prevents operation.
13677	</result>
13678
13679	</desc>
13680	<param name="machine" type="IMachine" dir="in"/>
13681	<param name="console" type="IConsole" dir="in"/>
13682	</method>
13683
13684	<method name="updateMachineState">
13685	<desc>
13686	Updates the machine state in the VM process.
13687	Must be called only in certain cases
13688	(see the method implementation).
13689
13690	<result name="VBOX_E_INVALID_VM_STATE">
13691	Session state prevents operation.
13692	</result>
13693	<result name="VBOX_E_INVALID_OBJECT_STATE">
13694	Session type prevents operation.
13695	</result>
13696
13697	</desc>
13698	<param name="aMachineState" type="MachineState" dir="in"/>
13699	</method>
13700
13701	<method name="uninitialize">
13702	<desc>
13703	Uninitializes (closes) this session. Used by VirtualBox to close
13704	the corresponding remote session when the direct session dies
13705	or gets closed.
13706
13707	<result name="VBOX_E_INVALID_VM_STATE">
13708	Session state prevents operation.
13709	</result>
13710
13711	</desc>
13712	</method>
13713
13714	<method name="onNetworkAdapterChange">
13715	<desc>
13716	Triggered when settings of a network adapter of the
13717	associated virtual machine have changed.
13718
13719	<result name="VBOX_E_INVALID_VM_STATE">
13720	Session state prevents operation.
13721	</result>
13722	<result name="VBOX_E_INVALID_OBJECT_STATE">
13723	Session type prevents operation.
13724	</result>
13725
13726	</desc>
13727	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13728	<param name="changeAdapter" type="boolean" dir="in"/>
13729	</method>
13730
13731	<method name="onSerialPortChange">
13732	<desc>
13733	Triggered when settings of a serial port of the
13734	associated virtual machine have changed.
13735
13736	<result name="VBOX_E_INVALID_VM_STATE">
13737	Session state prevents operation.
13738	</result>
13739	<result name="VBOX_E_INVALID_OBJECT_STATE">
13740	Session type prevents operation.
13741	</result>
13742
13743	</desc>
13744	<param name="serialPort" type="ISerialPort" dir="in"/>
13745	</method>
13746
13747	<method name="onParallelPortChange">
13748	<desc>
13749	Triggered when settings of a parallel port of the
13750	associated virtual machine have changed.
13751
13752	<result name="VBOX_E_INVALID_VM_STATE">
13753	Session state prevents operation.
13754	</result>
13755	<result name="VBOX_E_INVALID_OBJECT_STATE">
13756	Session type prevents operation.
13757	</result>
13758
13759	</desc>
13760	<param name="parallelPort" type="IParallelPort" dir="in"/>
13761	</method>
13762
13763	<method name="onStorageControllerChange">
13764	<desc>
13765	Triggered when settings of a storage controller of the
13766	associated virtual machine have changed.
13767
13768	<result name="VBOX_E_INVALID_VM_STATE">
13769	Session state prevents operation.
13770	</result>
13771	<result name="VBOX_E_INVALID_OBJECT_STATE">
13772	Session type prevents operation.
13773	</result>
13774
13775	</desc>
13776	</method>
13777
13778	<method name="onMediumChange">
13779	<desc>
13780	Triggered when attached media of the
13781	associated virtual machine have changed.
13782
13783	<result name="VBOX_E_INVALID_VM_STATE">
13784	Session state prevents operation.
13785	</result>
13786	<result name="VBOX_E_INVALID_OBJECT_STATE">
13787	Session type prevents operation.
13788	</result>
13789
13790	</desc>
13791
13792	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13793	<param name="force" type="boolean" dir="in"/>
13794	</method>
13795
13796	<method name="onStorageDeviceChange">
13797	<desc>
13798	Triggered when attached storage devices of the
13799	associated virtual machine have changed.
13800
13801	<result name="VBOX_E_INVALID_VM_STATE">
13802	Session state prevents operation.
13803	</result>
13804	<result name="VBOX_E_INVALID_OBJECT_STATE">
13805	Session type prevents operation.
13806	</result>
13807
13808	</desc>
13809
13810	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13811	<param name="remove" type="boolean" dir="in">
13812	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
13813	</param>
13814	</method>
13815
13816	<method name="onCPUChange">
13817	<desc>
13818	Notification when a CPU changes.
13819	</desc>
13820	<param name="cpu" type="unsigned long" dir="in">
13821	<desc>The CPU which changed</desc>
13822	</param>
13823	<param name="add" type="boolean" dir="in">
13824	<desc>Flag whether the CPU was added or removed</desc>
13825	</param>
13826	</method>
13827
13828	<method name="onCPUExecutionCapChange">
13829	<desc>
13830	Notification when the CPU execution cap changes.
13831	</desc>
13832	<param name="executionCap" type="unsigned long" dir="in">
13833	<desc>The new CPU execution cap value. (1-100)</desc>
13834	</param>
13835	</method>
13836
13837	<method name="onVRDEServerChange">
13838	<desc>
13839	Triggered when settings of the VRDE server object of the
13840	associated virtual machine have changed.
13841
13842	<result name="VBOX_E_INVALID_VM_STATE">
13843	Session state prevents operation.
13844	</result>
13845	<result name="VBOX_E_INVALID_OBJECT_STATE">
13846	Session type prevents operation.
13847	</result>
13848
13849	</desc>
13850	<param name="restart" type="boolean" dir="in">
13851	<desc>Flag whether the server must be restarted</desc>
13852	</param>
13853	</method>
13854
13855	<method name="onUSBControllerChange">
13856	<desc>
13857	Triggered when settings of the USB controller object of the
13858	associated virtual machine have changed.
13859
13860	<result name="VBOX_E_INVALID_VM_STATE">
13861	Session state prevents operation.
13862	</result>
13863	<result name="VBOX_E_INVALID_OBJECT_STATE">
13864	Session type prevents operation.
13865	</result>
13866
13867	</desc>
13868	</method>
13869
13870	<method name="onSharedFolderChange">
13871	<desc>
13872	Triggered when a permanent (global or machine) shared folder has been
13873	created or removed.
13874	<note>
13875	We don't pass shared folder parameters in this notification because
13876	the order in which parallel notifications are delivered is not defined,
13877	therefore it could happen that these parameters were outdated by the
13878	time of processing this notification.
13879	</note>
13880
13881	<result name="VBOX_E_INVALID_VM_STATE">
13882	Session state prevents operation.
13883	</result>
13884	<result name="VBOX_E_INVALID_OBJECT_STATE">
13885	Session type prevents operation.
13886	</result>
13887
13888	</desc>
13889	<param name="global" type="boolean" dir="in"/>
13890	</method>
13891
13892	<method name="onUSBDeviceAttach">
13893	<desc>
13894	Triggered when a request to capture a USB device (as a result
13895	of matched USB filters or direct call to
13896	<link to="IConsole::attachUSBDevice"/>) has completed.
13897	A @c null @a error object means success, otherwise it
13898	describes a failure.
13899
13900	<result name="VBOX_E_INVALID_VM_STATE">
13901	Session state prevents operation.
13902	</result>
13903	<result name="VBOX_E_INVALID_OBJECT_STATE">
13904	Session type prevents operation.
13905	</result>
13906
13907	</desc>
13908	<param name="device" type="IUSBDevice" dir="in"/>
13909	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13910	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13911	</method>
13912
13913	<method name="onUSBDeviceDetach">
13914	<desc>
13915	Triggered when a request to release the USB device (as a result
13916	of machine termination or direct call to
13917	<link to="IConsole::detachUSBDevice"/>) has completed.
13918	A @c null @a error object means success, otherwise it
13919	describes a failure.
13920
13921	<result name="VBOX_E_INVALID_VM_STATE">
13922	Session state prevents operation.
13923	</result>
13924	<result name="VBOX_E_INVALID_OBJECT_STATE">
13925	Session type prevents operation.
13926	</result>
13927
13928	</desc>
13929	<param name="id" type="uuid" mod="string" dir="in"/>
13930	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13931	</method>
13932
13933	<method name="onShowWindow">
13934	<desc>
13935	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13936	<link to="IMachine::showConsoleWindow"/> in order to notify
13937	console listeners
13938	<link to="ICanShowWindowEvent"/>
13939	and <link to="IShowWindowEvent"/>.
13940
13941	<result name="VBOX_E_INVALID_OBJECT_STATE">
13942	Session type prevents operation.
13943	</result>
13944
13945	</desc>
13946	<param name="check" type="boolean" dir="in"/>
13947	<param name="canShow" type="boolean" dir="out"/>
13948	<param name="winId" type="long long" dir="out"/>
13949	</method>
13950
13951	<method name="onBandwidthGroupChange">
13952	<desc>
13953	Notification when one of the bandwidth groups change.
13954	</desc>
13955	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13956	<desc>The bandwidth group which changed.</desc>
13957	</param>
13958	</method>
13959
13960	<method name="accessGuestProperty">
13961	<desc>
13962	Called by <link to="IMachine::getGuestProperty"/> and by
13963	<link to="IMachine::setGuestProperty"/> in order to read and
13964	modify guest properties.
13965
13966	<result name="VBOX_E_INVALID_VM_STATE">
13967	Machine session is not open.
13968	</result>
13969	<result name="VBOX_E_INVALID_OBJECT_STATE">
13970	Session type is not direct.
13971	</result>
13972
13973	</desc>
13974	<param name="name" type="wstring" dir="in"/>
13975	<param name="value" type="wstring" dir="in"/>
13976	<param name="flags" type="wstring" dir="in"/>
13977	<param name="isSetter" type="boolean" dir="in"/>
13978	<param name="retValue" type="wstring" dir="out"/>
13979	<param name="retTimestamp" type="long long" dir="out"/>
13980	<param name="retFlags" type="wstring" dir="out"/>
13981	</method>
13982
13983	<method name="enumerateGuestProperties">
13984	<desc>
13985	Return a list of the guest properties matching a set of patterns along
13986	with their values, time stamps and flags.
13987
13988	<result name="VBOX_E_INVALID_VM_STATE">
13989	Machine session is not open.
13990	</result>
13991	<result name="VBOX_E_INVALID_OBJECT_STATE">
13992	Session type is not direct.
13993	</result>
13994
13995	</desc>
13996	<param name="patterns" type="wstring" dir="in">
13997	<desc>
13998	The patterns to match the properties against as a comma-separated
13999	string. If this is empty, all properties currently set will be
14000	returned.
14001	</desc>
14002	</param>
14003	<param name="key" type="wstring" dir="out" safearray="yes">
14004	<desc>
14005	The key names of the properties returned.
14006	</desc>
14007	</param>
14008	<param name="value" type="wstring" dir="out" safearray="yes">
14009	<desc>
14010	The values of the properties returned. The array entries match the
14011	corresponding entries in the @a key array.
14012	</desc>
14013	</param>
14014	<param name="timestamp" type="long long" dir="out" safearray="yes">
14015	<desc>
14016	The time stamps of the properties returned. The array entries match
14017	the corresponding entries in the @a key array.
14018	</desc>
14019	</param>
14020	<param name="flags" type="wstring" dir="out" safearray="yes">
14021	<desc>
14022	The flags of the properties returned. The array entries match the
14023	corresponding entries in the @a key array.
14024	</desc>
14025	</param>
14026	</method>
14027
14028	<method name="onlineMergeMedium">
14029	<desc>
14030	Triggers online merging of a hard disk. Used internally when deleting
14031	a snapshot while a VM referring to the same hard disk chain is running.
14032
14033	<result name="VBOX_E_INVALID_VM_STATE">
14034	Machine session is not open.
14035	</result>
14036	<result name="VBOX_E_INVALID_OBJECT_STATE">
14037	Session type is not direct.
14038	</result>
14039
14040	</desc>
14041	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14042	<desc>The medium attachment to identify the medium chain.</desc>
14043	</param>
14044	<param name="sourceIdx" type="unsigned long" dir="in">
14045	<desc>The index of the source image in the chain.
14046	Redundant, but drastically reduces IPC.</desc>
14047	</param>
14048	<param name="targetIdx" type="unsigned long" dir="in">
14049	<desc>The index of the target image in the chain.
14050	Redundant, but drastically reduces IPC.</desc>
14051	</param>
14052	<param name="source" type="IMedium" dir="in">
14053	<desc>Merge source medium.</desc>
14054	</param>
14055	<param name="target" type="IMedium" dir="in">
14056	<desc>Merge target medium.</desc>
14057	</param>
14058	<param name="mergeForward" type="boolean" dir="in">
14059	<desc>Merge direction.</desc>
14060	</param>
14061	<param name="parentForTarget" type="IMedium" dir="in">
14062	<desc>For forward merges: new parent for target medium.</desc>
14063	</param>
14064	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14065	<desc>For backward merges: list of media which need their parent UUID
14066	updated.</desc>
14067	</param>
14068	<param name="progress" type="IProgress" dir="in">
14069	<desc>
14070	Progress object for this operation.
14071	</desc>
14072	</param>
14073	</method>
14074
14075	</interface>
14076
14077	<interface
14078	name="ISession" extends="$unknown"
14079	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
14080	wsmap="managed"
14081	>
14082	<desc>
14083	The ISession interface represents a client process and allows for locking
14084	virtual machines (represented by IMachine objects) to prevent conflicting
14085	changes to the machine.
14086
14087	Any caller wishing to manipulate a virtual machine needs to create a session
14088	object first, which lives in its own process space. Such session objects are
14089	then associated with <link to="IMachine" /> objects living in the VirtualBox
14090	server process to coordinate such changes.
14091
14092	There are two typical scenarios in which sessions are used:
14093
14094	<ul>
14095	<li>To alter machine settings or control a running virtual machine, one
14096	needs to lock a machine for a given session (client process) by calling
14097	<link to="IMachine::lockMachine"/>.
14098
14099	Whereas multiple sessions may control a running virtual machine, only
14100	one process can obtain a write lock on the machine to prevent conflicting
14101	changes. A write lock is also needed if a process wants to actually run a
14102	virtual machine in its own context, such as the VirtualBox GUI or
14103	VBoxHeadless front-ends. They must also lock a machine for their own
14104	sessions before they are allowed to power up the virtual machine.
14105
14106	As a result, no machine settings can be altered while another process is
14107	already using it, either because that process is modifying machine settings
14108	or because the machine is running.
14109	</li>
14110	<li>
14111	To start a VM using one of the existing VirtualBox front-ends (e.g. the
14112	VirtualBox GUI or VBoxHeadless), one would use
14113	<link to="IMachine::launchVMProcess"/>, which also takes a session object
14114	as its first parameter. This session then identifies the caller and lets the
14115	caller control the started machine (for example, pause machine execution or
14116	power it down) as well as be notified about machine execution state changes.
14117	</li>
14118	</ul>
14119
14120	How sessions objects are created in a client process depends on whether you use
14121	the Main API via COM or via the webservice:
14122
14123	<ul>
14124	<li>When using the COM API directly, an object of the Session class from the
14125	VirtualBox type library needs to be created. In regular COM C++ client code,
14126	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
14127	This object will then act as a local session object in further calls to open
14128	a session.
14129	</li>
14130
14131	<li>In the webservice, the session manager (IWebsessionManager) instead creates
14132	a session object automatically whenever <link to="IWebsessionManager::logon" />
14133	is called. A managed object reference to that session object can be retrieved by
14134	calling <link to="IWebsessionManager::getSessionObject" />.
14135	</li>
14136	</ul>
14137	</desc>
14138
14139	<attribute name="state" type="SessionState" readonly="yes">
14140	<desc>Current state of this session.</desc>
14141	</attribute>
14142
14143	<attribute name="type" type="SessionType" readonly="yes">
14144	<desc>
14145	Type of this session. The value of this attribute is valid only
14146	if the session currently has a machine locked (i.e. its
14147	<link to="#state" /> is Locked), otherwise an error will be returned.
14148	</desc>
14149	</attribute>
14150
14151	<attribute name="machine" type="IMachine" readonly="yes">
14152	<desc>Machine object associated with this session.</desc>
14153	</attribute>
14154
14155	<attribute name="console" type="IConsole" readonly="yes">
14156	<desc>Console object associated with this session.</desc>
14157	</attribute>
14158
14159	<method name="unlockMachine">
14160	<desc>
14161	Unlocks a machine that was previously locked for the current session.
14162
14163	Calling this method is required every time a machine has been locked
14164	for a particular session using the <link to="IMachine::launchVMProcess" />
14165	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
14166	the machine will be set to <link to="MachineState_Aborted" /> on the
14167	server, and changes made to the machine settings will be lost.
14168
14169	Generally, it is recommended to unlock all machines explicitly
14170	before terminating the application (regardless of the reason for
14171	the termination).
14172
14173	<note>
14174	Do not expect the session state (<link to="ISession::state" />
14175	to return to "Unlocked" immediately after you invoke this method,
14176	particularly if you have started a new VM process. The session
14177	state will automatically return to "Unlocked" once the VM is no
14178	longer executing, which can of course take a very long time.
14179	</note>
14180
14181	<result name="E_UNEXPECTED">
14182	Session is not locked.
14183	</result>
14184
14185	</desc>
14186	</method>
14187
14188	</interface>
14189
14190	<!--
14191	// IStorageController
14192	/////////////////////////////////////////////////////////////////////////
14193	-->
14194
14195	<enum
14196	name="StorageBus"
14197	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
14198	>
14199	<desc>
14200	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
14201	see <link to="IStorageController::bus" />.
14202	</desc>
14203	<const name="Null" value="0">
14204	<desc>@c null value. Never used by the API.</desc>
14205	</const>
14206	<const name="IDE" value="1"/>
14207	<const name="SATA" value="2"/>
14208	<const name="SCSI" value="3"/>
14209	<const name="Floppy" value="4"/>
14210	<const name="SAS" value="5"/>
14211	</enum>
14212
14213	<enum
14214	name="StorageControllerType"
14215	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
14216	>
14217	<desc>
14218	The exact variant of storage controller hardware presented
14219	to the guest; see <link to="IStorageController::controllerType" />.
14220	</desc>
14221
14222	<const name="Null" value="0">
14223	<desc>@c null value. Never used by the API.</desc>
14224	</const>
14225	<const name="LsiLogic" value="1">
14226	<desc>A SCSI controller of the LsiLogic variant.</desc>
14227	</const>
14228	<const name="BusLogic" value="2">
14229	<desc>A SCSI controller of the BusLogic variant.</desc>
14230	</const>
14231	<const name="IntelAhci" value="3">
14232	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
14233	</const>
14234	<const name="PIIX3" value="4">
14235	<desc>An IDE controller of the PIIX3 variant.</desc>
14236	</const>
14237	<const name="PIIX4" value="5">
14238	<desc>An IDE controller of the PIIX4 variant.</desc>
14239	</const>
14240	<const name="ICH6" value="6">
14241	<desc>An IDE controller of the ICH6 variant.</desc>
14242	</const>
14243	<const name="I82078" value="7">
14244	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14245	</const>
14246	<const name="LsiLogicSas" value="8">
14247	<desc>A variant of the LsiLogic controller using SAS.</desc>
14248	</const>
14249	</enum>
14250
14251	<enum
14252	name="ChipsetType"
14253	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14254	>
14255	<desc>
14256	Type of emulated chipset (mostly southbridge).
14257	</desc>
14258
14259	<const name="Null" value="0">
14260	<desc>@c null value. Never used by the API.</desc>
14261	</const>
14262	<const name="PIIX3" value="1">
14263	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14264	</const>
14265	<const name="ICH9" value="2">
14266	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14267	</const>
14268	</enum>
14269
14270	<interface
14271	name="IStorageController" extends="$unknown"
14272	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14273	wsmap="managed"
14274	>
14275	<desc>
14276	Represents a storage controller that is attached to a virtual machine
14277	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14278	attached to storage controllers in a real computer, virtual drives
14279	(represented by <link to="IMediumAttachment" />) are attached to virtual
14280	storage controllers, represented by this interface.
14281
14282	As opposed to physical hardware, VirtualBox has a very generic concept
14283	of a storage controller, and for purposes of the Main API, all virtual
14284	storage is attached to virtual machines via instances of this interface.
14285	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14286	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14287	is used, certain sub-types may be available and can be selected in
14288	<link to="#controllerType" />.
14289
14290	Depending on these settings, the guest operating system might see
14291	significantly different virtual hardware.
14292	</desc>
14293
14294	<attribute name="name" type="wstring" readonly="yes">
14295	<desc>
14296	Name of the storage controller, as originally specified with
14297	<link to="IMachine::addStorageController" />. This then uniquely
14298	identifies this controller with other method calls such as
14299	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14300	</desc>
14301	</attribute>
14302
14303	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14304	<desc>
14305	Maximum number of devices which can be attached to one port.
14306	</desc>
14307	</attribute>
14308
14309	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14310	<desc>
14311	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14312	</desc>
14313	</attribute>
14314
14315	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14316	<desc>
14317	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14318	</desc>
14319	</attribute>
14320
14321	<attribute name="instance" type="unsigned long">
14322	<desc>
14323	The instance number of the device in the running VM.
14324	</desc>
14325	</attribute>
14326
14327	<attribute name="portCount" type="unsigned long">
14328	<desc>
14329	The number of currently usable ports on the controller.
14330	The minimum and maximum number of ports for one controller are
14331	stored in <link to="IStorageController::minPortCount"/>
14332	and <link to="IStorageController::maxPortCount"/>.
14333	</desc>
14334	</attribute>
14335
14336	<attribute name="bus" type="StorageBus" readonly="yes">
14337	<desc>
14338	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14339	</desc>
14340	</attribute>
14341
14342	<attribute name="controllerType" type="StorageControllerType">
14343	<desc>
14344	The exact variant of storage controller hardware presented
14345	to the guest.
14346	Depending on this value, VirtualBox will provide a different
14347	virtual storage controller hardware to the guest.
14348	For SATA, SAS and floppy controllers, only one variant is
14349	available, but for IDE and SCSI, there are several.
14350
14351	For SCSI controllers, the default type is LsiLogic.
14352	</desc>
14353	</attribute>
14354
14355	<attribute name="useHostIOCache" type="boolean">
14356	<desc>
14357	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14358	caches and use synchronous file APIs on the host. This was the only option in the API before
14359	VirtualBox 3.2 and is still the default for IDE controllers.
14360
14361	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14362	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14363	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14364	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14365	virtual machines are running at the same time to prevent I/O cache related hangs.
14366	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14367	</desc>
14368	</attribute>
14369
14370	<attribute name="bootable" type="boolean" readonly="yes">
14371	<desc>
14372	Returns whether it is possible to boot from disks attached to this controller.
14373	</desc>
14374	</attribute>
14375
14376	<method name="getIDEEmulationPort">
14377	<desc>
14378	Gets the corresponding port number which is emulated as an IDE device.
14379	Works only with SATA controllers.
14380
14381	<result name="E_INVALIDARG">
14382	The @a devicePosition is not in the range 0 to 3.
14383	</result>
14384	<result name="E_NOTIMPL">
14385	The storage controller type is not SATAIntelAhci.
14386	</result>
14387
14388	</desc>
14389	<param name="devicePosition" type="long" dir="in"/>
14390	<param name="portNumber" type="long" dir="return"/>
14391	</method>
14392
14393	<method name="setIDEEmulationPort">
14394	<desc>
14395	Sets the port number which is emulated as an IDE device.
14396	Works only with SATA controllers.
14397
14398	<result name="E_INVALIDARG">
14399	The @a devicePosition is not in the range 0 to 3 or the
14400	@a portNumber is not in the range 0 to 29.
14401	</result>
14402	<result name="E_NOTIMPL">
14403	The storage controller type is not SATAIntelAhci.
14404	</result>
14405
14406	</desc>
14407	<param name="devicePosition" type="long" dir="in"/>
14408	<param name="portNumber" type="long" dir="in"/>
14409	</method>
14410
14411	</interface>
14412
14413	<if target="wsdl">
14414
14415	<!--
14416	// IManagedObjectRef
14417	/////////////////////////////////////////////////////////////////////////
14418	-->
14419
14420	<interface
14421	name="IManagedObjectRef" extends="$unknown"
14422	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14423	internal="yes"
14424	wsmap="managed"
14425	wscpp="hardcoded"
14426	>
14427	<desc>
14428	Managed object reference.
14429
14430	Only within the webservice, a managed object reference (which is really
14431	an opaque number) allows a webservice client to address an object
14432	that lives in the address space of the webservice server.
14433
14434	Behind each managed object reference, there is a COM object that lives
14435	in the webservice server's address space. The COM object is not freed
14436	until the managed object reference is released, either by an explicit
14437	call to <link to="IManagedObjectRef::release" /> or by logging off from
14438	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14439	all objects created during the webservice session.
14440
14441	Whenever a method call of the VirtualBox API returns a COM object, the
14442	webservice representation of that method will instead return a
14443	managed object reference, which can then be used to invoke methods
14444	on that object.
14445	</desc>
14446
14447	<method name="getInterfaceName">
14448	<desc>
14449	Returns the name of the interface that this managed object represents,
14450	for example, "IMachine", as a string.
14451	</desc>
14452	<param name="return" type="wstring" dir="return"/>
14453	</method>
14454
14455	<method name="release">
14456	<desc>
14457	Releases this managed object reference and frees the resources that
14458	were allocated for it in the webservice server process. After calling
14459	this method, the identifier of the reference can no longer be used.
14460	</desc>
14461	</method>
14462
14463	</interface>
14464
14465	<!--
14466	// IWebsessionManager
14467	/////////////////////////////////////////////////////////////////////////
14468	-->
14469
14470	<interface
14471	name="IWebsessionManager" extends="$unknown"
14472	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14473	internal="yes"
14474	wsmap="global"
14475	wscpp="hardcoded"
14476	>
14477	<desc>
14478	Websession manager. This provides essential services
14479	to webservice clients.
14480	</desc>
14481	<method name="logon">
14482	<desc>
14483	Logs a new client onto the webservice and returns a managed object reference to
14484	the IVirtualBox instance, which the client can then use as a basis to further
14485	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14486	interface, in one way or the other.
14487	</desc>
14488	<param name="username" type="wstring" dir="in"/>
14489	<param name="password" type="wstring" dir="in"/>
14490	<param name="return" type="IVirtualBox" dir="return"/>
14491	</method>
14492
14493	<method name="getSessionObject">
14494	<desc>
14495	Returns a managed object reference to the internal ISession object that was created
14496	for this web service session when the client logged on.
14497
14498	<see>ISession</see>
14499	</desc>
14500	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14501	<param name="return" type="ISession" dir="return"/>
14502	</method>
14503
14504	<method name="logoff">
14505	<desc>
14506	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14507	and destroys all resources associated with the session (most importantly, all
14508	managed objects created in the server while the session was active).
14509	</desc>
14510	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14511	</method>
14512
14513	</interface>
14514
14515	</if>
14516
14517	<!--
14518	// IPerformanceCollector & friends
14519	/////////////////////////////////////////////////////////////////////////
14520	-->
14521
14522	<interface
14523	name="IPerformanceMetric" extends="$unknown"
14524	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14525	>
14526	<desc>
14527	The IPerformanceMetric interface represents parameters of the given
14528	performance metric.
14529	</desc>
14530
14531	<attribute name="metricName" type="wstring" readonly="yes">
14532	<desc>
14533	Name of the metric.
14534	</desc>
14535	</attribute>
14536
14537	<attribute name="object" type="$unknown" readonly="yes">
14538	<desc>
14539	Object this metric belongs to.
14540	</desc>
14541	</attribute>
14542
14543	<attribute name="description" type="wstring" readonly="yes">
14544	<desc>
14545	Textual description of the metric.
14546	</desc>
14547	</attribute>
14548
14549	<attribute name="period" type="unsigned long" readonly="yes">
14550	<desc>
14551	Time interval between samples, measured in seconds.
14552	</desc>
14553	</attribute>
14554
14555	<attribute name="count" type="unsigned long" readonly="yes">
14556	<desc>
14557	Number of recent samples retained by the performance collector for this
14558	metric.
14559
14560	When the collected sample count exceeds this number, older samples
14561	are discarded.
14562	</desc>
14563	</attribute>
14564
14565	<attribute name="unit" type="wstring" readonly="yes">
14566	<desc>
14567	Unit of measurement.
14568	</desc>
14569	</attribute>
14570
14571	<attribute name="minimumValue" type="long" readonly="yes">
14572	<desc>
14573	Minimum possible value of this metric.
14574	</desc>
14575	</attribute>
14576
14577	<attribute name="maximumValue" type="long" readonly="yes">
14578	<desc>
14579	Maximum possible value of this metric.
14580	</desc>
14581	</attribute>
14582	</interface>
14583
14584	<interface
14585	name="IPerformanceCollector" extends="$unknown"
14586	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14587	wsmap="managed"
14588	>
14589	<desc>
14590	The IPerformanceCollector interface represents a service that collects
14591	and stores performance metrics data.
14592
14593	Performance metrics are associated with objects of interfaces like IHost
14594	and IMachine. Each object has a distinct set of performance metrics. The
14595	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14596
14597	Metric data is collected at the specified intervals and is retained
14598	internally. The interval and the number of retained samples can be set
14599	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14600	and collection settings are not persistent, they are discarded as soon as
14601	VBoxSVC process terminates. Moreover, metric settings and data associated
14602	with a particular VM only exist while VM is running. They disappear as
14603	soon as VM shuts down. It is not possible to set up metrics for machines
14604	that are powered off. One needs to start VM first, then set up metric
14605	collection parameters.
14606
14607	Metrics are organized hierarchically, with each level separated by a
14608	slash (/) character. Generally, the scheme for metric names is like this:
14609
14610	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14611
14612	"Category/Metric" together form the base metric name. A base metric is
14613	the smallest unit for which a sampling interval and the number of
14614	retained samples can be set. Only base metrics can be enabled and
14615	disabled. All sub-metrics are collected when their base metric is
14616	collected. Collected values for any set of sub-metrics can be queried
14617	with <link to="IPerformanceCollector::queryMetricsData" />.
14618
14619	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14620	category, "Load" metric, "User" submetric, "average" aggregate. An
14621	aggregate function is computed over all retained data. Valid aggregate
14622	functions are:
14623
14624	<ul>
14625	<li>avg -- average</li>
14626	<li>min -- minimum</li>
14627	<li>max -- maximum</li>
14628	</ul>
14629
14630	When setting up metric parameters, querying metric data, enabling or
14631	disabling metrics wildcards can be used in metric names to specify a
14632	subset of metrics. For example, to select all CPU-related metrics
14633	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14634	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14635
14636	The valid names for base metrics are:
14637
14638	<ul>
14639	<li>CPU/Load</li>
14640	<li>CPU/MHz</li>
14641	<li>RAM/Usage</li>
14642	<li>RAM/VMM</li>
14643	</ul>
14644
14645	The general sequence for collecting and retrieving the metrics is:
14646	<ul>
14647	<li>
14648	Obtain an instance of IPerformanceCollector with
14649	<link to="IVirtualBox::performanceCollector" />
14650	</li>
14651	<li>
14652	Allocate and populate an array with references to objects the metrics
14653	will be collected for. Use references to IHost and IMachine objects.
14654	</li>
14655	<li>
14656	Allocate and populate an array with base metric names the data will
14657	be collected for.
14658	</li>
14659	<li>
14660	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14661	the metric data will be collected and stored.
14662	</li>
14663	<li>
14664	Wait for the data to get collected.
14665	</li>
14666	<li>
14667	Allocate and populate an array with references to objects the metric
14668	values will be queried for. You can re-use the object array used for
14669	setting base metrics.
14670	</li>
14671	<li>
14672	Allocate and populate an array with metric names the data will be
14673	collected for. Note that metric names differ from base metric names.
14674	</li>
14675	<li>
14676	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14677	that have been collected so far are returned. Note that the values
14678	are still retained internally and data collection continues.
14679	</li>
14680	</ul>
14681
14682	For an example of usage refer to the following files in VirtualBox SDK:
14683	<ul>
14684	<li>
14685	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14686	</li>
14687	<li>
14688	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14689	</li>
14690	</ul>
14691	</desc>
14692
14693	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14694	<desc>
14695	Array of unique names of metrics.
14696
14697	This array represents all metrics supported by the performance
14698	collector. Individual objects do not necessarily support all of them.
14699	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14700	list of supported metrics for a particular object.
14701	</desc>
14702	</attribute>
14703
14704	<method name="getMetrics">
14705	<desc>
14706	Returns parameters of specified metrics for a set of objects.
14707	<note>
14708	@c Null metrics array means all metrics. @c Null object array means
14709	all existing objects.
14710	</note>
14711	</desc>
14712	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14713	<desc>
14714	Metric name filter. Currently, only a comma-separated list of metrics
14715	is supported.
14716	</desc>
14717	</param>
14718	<param name="objects" type="$unknown" dir="in" safearray="yes">
14719	<desc>
14720	Set of objects to return metric parameters for.
14721	</desc>
14722	</param>
14723	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14724	<desc>
14725	Array of returned metric parameters.
14726	</desc>
14727	</param>
14728	</method>
14729
14730	<method name="setupMetrics">
14731	<desc>
14732	Sets parameters of specified base metrics for a set of objects. Returns
14733	an array of <link to="IPerformanceMetric" /> describing the metrics
14734	have been affected.
14735	<note>
14736	@c Null or empty metric name array means all metrics. @c Null or
14737	empty object array means all existing objects. If metric name array
14738	contains a single element and object array contains many, the single
14739	metric name array element is applied to each object array element to
14740	form metric/object pairs.
14741	</note>
14742	</desc>
14743	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14744	<desc>
14745	Metric name filter. Comma-separated list of metrics with wildcard
14746	support.
14747	</desc>
14748	</param>
14749	<param name="objects" type="$unknown" dir="in" safearray="yes">
14750	<desc>
14751	Set of objects to setup metric parameters for.
14752	</desc>
14753	</param>
14754	<param name="period" type="unsigned long" dir="in">
14755	<desc>
14756	Time interval in seconds between two consecutive samples of
14757	performance data.
14758	</desc>
14759	</param>
14760	<param name="count" type="unsigned long" dir="in">
14761	<desc>
14762	Number of samples to retain in performance data history. Older
14763	samples get discarded.
14764	</desc>
14765	</param>
14766	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14767	<desc>
14768	Array of metrics that have been modified by the call to this method.
14769	</desc>
14770	</param>
14771	</method>
14772
14773	<method name="enableMetrics">
14774	<desc>
14775	Turns on collecting specified base metrics. Returns an array of
14776	<link to="IPerformanceMetric" /> describing the metrics have been
14777	affected.
14778	<note>
14779	@c Null or empty metric name array means all metrics. @c Null or
14780	empty object array means all existing objects. If metric name array
14781	contains a single element and object array contains many, the single
14782	metric name array element is applied to each object array element to
14783	form metric/object pairs.
14784	</note>
14785	</desc>
14786	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14787	<desc>
14788	Metric name filter. Comma-separated list of metrics with wildcard
14789	support.
14790	</desc>
14791	</param>
14792	<param name="objects" type="$unknown" dir="in" safearray="yes">
14793	<desc>
14794	Set of objects to enable metrics for.
14795	</desc>
14796	</param>
14797	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14798	<desc>
14799	Array of metrics that have been modified by the call to this method.
14800	</desc>
14801	</param>
14802	</method>
14803
14804	<method name="disableMetrics">
14805	<desc>
14806	Turns off collecting specified base metrics. Returns an array of
14807	<link to="IPerformanceMetric" /> describing the metrics have been
14808	affected.
14809	<note>
14810	@c Null or empty metric name array means all metrics. @c Null or
14811	empty object array means all existing objects. If metric name array
14812	contains a single element and object array contains many, the single
14813	metric name array element is applied to each object array element to
14814	form metric/object pairs.
14815	</note>
14816	</desc>
14817	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14818	<desc>
14819	Metric name filter. Comma-separated list of metrics with wildcard
14820	support.
14821	</desc>
14822	</param>
14823	<param name="objects" type="$unknown" dir="in" safearray="yes">
14824	<desc>
14825	Set of objects to disable metrics for.
14826	</desc>
14827	</param>
14828	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14829	<desc>
14830	Array of metrics that have been modified by the call to this method.
14831	</desc>
14832	</param>
14833	</method>
14834
14835	<method name="queryMetricsData">
14836	<desc>
14837	Queries collected metrics data for a set of objects.
14838
14839	The data itself and related metric information are returned in seven
14840	parallel and one flattened array of arrays. Elements of
14841	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14842	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14843	the same index describe one set of values corresponding to a single
14844	metric.
14845
14846	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14847	start and length of a sub-array is indicated by
14848	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14849	value for metric <tt>metricNames[i]</tt> is at
14850	<tt>returnData[returnIndices[i]]</tt>.
14851
14852	<note>
14853	@c Null or empty metric name array means all metrics. @c Null or
14854	empty object array means all existing objects. If metric name array
14855	contains a single element and object array contains many, the single
14856	metric name array element is applied to each object array element to
14857	form metric/object pairs.
14858	</note>
14859	<note>
14860	Data collection continues behind the scenes after call to @c
14861	queryMetricsData. The return data can be seen as the snapshot of the
14862	current state at the time of @c queryMetricsData call. The internally
14863	kept metric values are not cleared by the call. This makes possible
14864	querying different subsets of metrics or aggregates with subsequent
14865	calls. If periodic querying is needed it is highly suggested to query
14866	the values with @c interval*count period to avoid confusion. This way
14867	a completely new set of data values will be provided by each query.
14868	</note>
14869	</desc>
14870	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14871	<desc>
14872	Metric name filter. Comma-separated list of metrics with wildcard
14873	support.
14874	</desc>
14875	</param>
14876	<param name="objects" type="$unknown" dir="in" safearray="yes">
14877	<desc>
14878	Set of objects to query metrics for.
14879	</desc>
14880	</param>
14881	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14882	<desc>
14883	Names of metrics returned in @c returnData.
14884	</desc>
14885	</param>
14886	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14887	<desc>
14888	Objects associated with metrics returned in @c returnData.
14889	</desc>
14890	</param>
14891	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14892	<desc>
14893	Units of measurement for each returned metric.
14894	</desc>
14895	</param>
14896	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14897	<desc>
14898	Divisor that should be applied to return values in order to get
14899	floating point values. For example:
14900	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14901	will retrieve the floating point value of i-th sample of the first
14902	metric.
14903	</desc>
14904	</param>
14905	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14906	<desc>
14907	Sequence numbers of the first elements of value sequences of
14908	particular metrics returned in @c returnData. For aggregate metrics
14909	it is the sequence number of the sample the aggregate started
14910	calculation from.
14911	</desc>
14912	</param>
14913	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14914	<desc>
14915	Indices of the first elements of value sequences of particular
14916	metrics returned in @c returnData.
14917	</desc>
14918	</param>
14919	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14920	<desc>
14921	Lengths of value sequences of particular metrics.
14922	</desc>
14923	</param>
14924	<param name="returnData" type="long" dir="return" safearray="yes">
14925	<desc>
14926	Flattened array of all metric data containing sequences of values for
14927	each metric.
14928	</desc>
14929	</param>
14930	</method>
14931
14932	</interface>
14933
14934	<enum
14935	name="NATAliasMode"
14936	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14937	>
14938	<desc></desc>
14939	<const name="AliasLog" value="0x1">
14940	<desc></desc>
14941	</const>
14942	<const name="AliasProxyOnly" value="0x02">
14943	<desc></desc>
14944	</const>
14945	<const name="AliasUseSamePorts" value="0x04">
14946	<desc></desc>
14947	</const>
14948	</enum>
14949
14950	<enum
14951	name="NATProtocol"
14952	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14953	>
14954	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14955	<const name="UDP" value="0">
14956	<desc>Port-forwarding uses UDP protocol.</desc>
14957	</const>
14958	<const name="TCP" value="1">
14959	<desc>Port-forwarding uses TCP protocol.</desc>
14960	</const>
14961	</enum>
14962
14963	<interface
14964	name="INATEngine" extends="$unknown"
14965	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14966	wsmap="managed"
14967	>
14968	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14969	allows for changing NAT behavior such as port-forwarding rules. This interface is
14970	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14971	<attribute name="network" type="wstring">
14972	<desc>The network attribute of the NAT engine (the same value is used with built-in
14973	DHCP server to fill corresponding fields of DHCP leases).</desc>
14974	</attribute>
14975	<attribute name="hostIP" type="wstring">
14976	<desc>IP of host interface to bind all opened sockets to.
14977	<note>Changing this does not change binding of port forwarding.</note>
14978	</desc>
14979	</attribute>
14980	<attribute name="tftpPrefix" type="wstring">
14981	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14982	the corresponding fields of DHCP leases.</desc>
14983	</attribute>
14984	<attribute name="tftpBootFile" type="wstring">
14985	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14986	the corresponding fields of DHCP leases.</desc>
14987	</attribute>
14988	<attribute name="tftpNextServer" type="wstring">
14989	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14990	the corresponding fields of DHCP leases.
14991	<note>The preferred form is IPv4 addresses.</note>
14992	</desc>
14993	</attribute>
14994	<attribute name="aliasMode" type="unsigned long">
14995	<desc></desc>
14996	</attribute>
14997	<attribute name="dnsPassDomain" type="boolean">
14998	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14999	</attribute>
15000	<attribute name="dnsProxy" type="boolean">
15001	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15002	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15003	</attribute>
15004	<attribute name="dnsUseHostResolver" type="boolean">
15005	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15006	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15007	</attribute>
15008	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15009	<desc>Array of NAT port-forwarding rules in string representation, in the following
15010	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15011	</attribute>
15012	<method name="setNetworkSettings">
15013	<desc>Sets network configuration of the NAT engine.</desc>
15014	<param name="mtu" type="unsigned long" dir="in">
15015	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15016	</param>
15017	<param name="sockSnd" type="unsigned long" dir="in">
15018	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15019	</param>
15020	<param name="sockRcv" type="unsigned long" dir="in">
15021	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15022	</param>
15023	<param name="TcpWndSnd" type="unsigned long" dir="in">
15024	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15025	establishing a new TCP connection.</desc>
15026	</param>
15027	<param name="TcpWndRcv" type="unsigned long" dir="in">
15028	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15029	establishing a new TCP connection.</desc>
15030	</param>
15031	</method>
15032	<method name="getNetworkSettings">
15033	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15034	for parameter descriptions.</desc>
15035	<param name="mtu" type="unsigned long" dir="out" />
15036	<param name="sockSnd" type="unsigned long" dir="out" />
15037	<param name="sockRcv" type="unsigned long" dir="out" />
15038	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15039	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15040	</method>
15041	<method name="addRedirect">
15042	<desc>Adds a new NAT port-forwarding rule.</desc>
15043	<param name="name" type="wstring" dir="in">
15044	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15045	auto-generates one using the other parameters.</desc>
15046	</param>
15047	<param name="proto" type="NATProtocol" dir="in">
15048	<desc>Protocol handled with the rule.</desc>
15049	</param>
15050	<param name="hostIp" type="wstring" dir="in">
15051	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15052	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15053	</param>
15054	<param name="hostPort" type="unsigned short" dir="in">
15055	<desc>The port number to listen on.</desc>
15056	</param>
15057	<param name="guestIp" type="wstring" dir="in">
15058	<desc>The IP address of the guest which the NAT engine will forward matching packets
15059	to. An empty IP address is acceptable, in which case the NAT engine will forward
15060	packets to the first DHCP lease (x.x.x.15).</desc>
15061	</param>
15062	<param name="guestPort" type="unsigned short" dir="in">
15063	<desc>The port number to forward.</desc>
15064	</param>
15065	</method>
15066	<method name="removeRedirect">
15067	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15068	<param name="name" type="wstring" dir="in">
15069	<desc>The name of the rule to delete.</desc>
15070	</param>
15071	</method>
15072	</interface>
15073
15074	<!--
15075	// IExtPackManager
15076	/////////////////////////////////////////////////////////////////////////
15077	-->
15078
15079	<interface
15080	name="IExtPackPlugIn" extends="$unknown"
15081	uuid="58000040-e718-4746-bbce-4b86d96da461"
15082	wsmap="suppress"
15083	>
15084	<desc>
15085	Interface for keeping information about a plug-in that ships with an
15086	extension pack.
15087	</desc>
15088	<attribute name="name" type="wstring" readonly="yes">
15089	<desc>The plug-in name.</desc>
15090	</attribute>
15091	<attribute name="description" type="wstring" readonly="yes">
15092	<desc>The plug-in description.</desc>
15093	</attribute>
15094	<attribute name="frontend" type="wstring" readonly="yes">
15095	<desc>
15096	The name of the frontend or component name this plug-in plugs into.
15097	</desc>
15098	</attribute>
15099	<attribute name="modulePath" type="wstring" readonly="yes">
15100	<desc> The module path. </desc>
15101	</attribute>
15102	</interface>
15103
15104	<interface
15105	name="IExtPackBase" extends="$unknown"
15106	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
15107	wsmap="suppress"
15108	>
15109	<desc>
15110	Interface for querying information about an extension pack as well as
15111	accessing COM objects within it.
15112	</desc>
15113	<attribute name="name" type="wstring" readonly="yes">
15114	<desc>The extension pack name. This is unique.</desc>
15115	</attribute>
15116	<attribute name="description" type="wstring" readonly="yes">
15117	<desc>The extension pack description.</desc>
15118	</attribute>
15119	<attribute name="version" type="wstring" readonly="yes">
15120	<desc>
15121	The extension pack version string. This is on the same form as
15122	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
15123	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
15124	or "1.2.3_BETA1-r45678-OSE"
15125	</desc>
15126	</attribute>
15127	<attribute name="revision" type="unsigned long" readonly="yes">
15128	<desc>The extension pack internal revision number.</desc>
15129	</attribute>
15130	<attribute name="VRDEModule" type="wstring" readonly="yes">
15131	<desc>The name of the VRDE module if the extension pack sports one.</desc>
15132	</attribute>
15133	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
15134	<desc>Plug-ins provided by this extension pack.</desc>
15135	</attribute>
15136	<attribute name="usable" type="boolean" readonly="yes">
15137	<desc>
15138	Indicates whether the extension pack is usable or not.
15139
15140	There are a number of reasons why an extension pack might be unusable,
15141	typical examples would be broken installation/file or that it is
15142	incompatible with the current VirtualBox version.
15143	</desc>
15144	</attribute>
15145	<attribute name="whyUnusable" type="wstring" readonly="yes">
15146	<desc>
15147	String indicating why the extension pack is not usable. This is an
15148	empty string if usable and always a non-empty string if not usable.
15149	</desc>
15150	</attribute>
15151	<attribute name="showLicense" type="boolean" readonly="yes">
15152	<desc>Whether to show the license before installation</desc>
15153	</attribute>
15154	<attribute name="license" type="wstring" readonly="yes">
15155	<desc>
15156	The default HTML license text for the extension pack. Same as
15157	calling <link to="#queryLicense">queryLicense</link> with
15158	preferredLocale and preferredLanguage as empty strings and format set
15159	to html.
15160	</desc>
15161	</attribute>
15162
15163	<method name="queryLicense">
15164	<desc>
15165	Full feature version of the license attribute.
15166	</desc>
15167	<param name="preferredLocale" type="wstring" dir="in">
15168	<desc>
15169	The preferred license locale. Pass an empty string to get the default
15170	license.
15171	</desc>
15172	</param>
15173	<param name="preferredLanguage" type="wstring" dir="in">
15174	<desc>
15175	The preferred license language. Pass an empty string to get the
15176	default language for the locale.
15177	</desc>
15178	</param>
15179	<param name="format" type="wstring" dir="in">
15180	<desc>
15181	The license format: html, rtf or txt. If a license is present there
15182	will always be an HTML of it, the rich text format (RTF) and plain
15183	text (txt) versions are optional. If
15184	</desc>
15185	</param>
15186	<param name="licenseText" type="wstring" dir="return">
15187	<desc>The license text.</desc>
15188	</param>
15189	</method>
15190
15191	</interface>
15192
15193	<interface
15194	name="IExtPack" extends="IExtPackBase"
15195	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
15196	wsmap="suppress"
15197	>
15198	<desc>
15199	Interface for querying information about an extension pack as well as
15200	accessing COM objects within it.
15201	</desc>
15202	<method name="queryObject">
15203	<desc>
15204	Queries the IUnknown interface to an object in the extension pack
15205	main module. This allows plug-ins and others to talk directly to an
15206	extension pack.
15207	</desc>
15208	<param name="objUuid" type="wstring" dir="in">
15209	<desc>The object ID. What exactly this is </desc>
15210	</param>
15211	<param name="returnInterface" type="$unknown" dir="return">
15212	<desc>The queried interface.</desc>
15213	</param>
15214	</method>
15215	</interface>
15216
15217	<interface
15218	name="IExtPackFile" extends="IExtPackBase"
15219	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
15220	wsmap="suppress"
15221	>
15222	<desc>
15223	Extension pack file (aka tarball, .vbox-extpack) representation returned
15224	by IExtPackManager::openExtPackFile. This provides the base extension
15225	pack information with the addition of the file name. It also provides an
15226	alternative to IExtPackManager::install.
15227	</desc>
15228	<attribute name="filePath" type="wstring" readonly="yes">
15229	<desc>
15230	The path to the extension pack file.
15231	</desc>
15232	</attribute>
15233
15234	<method name="install">
15235	<desc>
15236	Install the extension pack.
15237	</desc>
15238	<param name="replace" type="boolean" dir="in">
15239	<desc>
15240	Set this to automatically uninstall any existing extension pack with
15241	the same name as the one being installed.
15242	</desc>
15243	</param>
15244	<param name="displayInfo" type="wstring" dir="in">
15245	<desc>
15246	Platform specific display information. Reserved for future hacks.
15247	</desc>
15248	</param>
15249	<param name="progess" type="IProgress" dir="return">
15250	<desc>
15251	Progress object for the operation.
15252	</desc>
15253	</param>
15254	</method>
15255	</interface>
15256
15257	<interface
15258	name="IExtPackManager" extends="$unknown"
15259	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
15260	wsmap="suppress"
15261	>
15262	<desc>
15263	Interface for managing VirtualBox Extension Packs.
15264
15265	TODO: Describe extension packs, how they are managed and how to create
15266	one.
15267	</desc>
15268
15269	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15270	<desc>
15271	List of the installed extension packs.
15272	</desc>
15273	</attribute>
15274
15275	<method name="find">
15276	<desc>
15277	Returns the extension pack with the specified name if found.
15278
15279	<result name="VBOX_E_OBJECT_NOT_FOUND">
15280	No extension pack matching @a name was found.
15281	</result>
15282	</desc>
15283	<param name="name" type="wstring" dir="in">
15284	<desc>The name of the extension pack to locate.</desc>
15285	</param>
15286	<param name="returnData" type="IExtPack" dir="return">
15287	<desc>The extension pack if found.</desc>
15288	</param>
15289	</method>
15290
15291	<method name="openExtPackFile">
15292	<desc>
15293	Attempts to open an extension pack file in preparation for
15294	installation.
15295	</desc>
15296	<param name="path" type="wstring" dir="in">
15297	<desc>The path of the extension pack tarball.</desc>
15298	</param>
15299	<param name="file" type="IExtPackFile" dir="return">
15300	<desc>The interface of the extension pack file object.</desc>
15301	</param>
15302	</method>
15303
15304	<method name="uninstall">
15305	<desc>Uninstalls an extension pack, removing all related files.</desc>
15306	<param name="name" type="wstring" dir="in">
15307	<desc>The name of the extension pack to uninstall.</desc>
15308	</param>
15309	<param name="forcedRemoval" type="boolean" dir="in">
15310	<desc>
15311	Forced removal of the extension pack. This means that the uninstall
15312	hook will not be called.
15313	</desc>
15314	</param>
15315	<param name="displayInfo" type="wstring" dir="in">
15316	<desc>
15317	Platform specific display information. Reserved for future hacks.
15318	</desc>
15319	</param>
15320	<param name="progess" type="IProgress" dir="return">
15321	<desc>
15322	Progress object for the operation.
15323	</desc>
15324	</param>
15325	</method>
15326
15327	<method name="cleanup">
15328	<desc>Cleans up failed installs and uninstalls</desc>
15329	</method>
15330
15331	<method name="QueryAllPlugInsForFrontend">
15332	<desc>
15333	Gets the path to all the plug-in modules for a given frontend.
15334
15335	This is a convenience method that is intended to simplify the plug-in
15336	loading process for a frontend.
15337	</desc>
15338	<param name="frontendName" type="wstring" dir="in">
15339	<desc>The name of the frontend or component.</desc>
15340	</param>
15341	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15342	<desc>Array containing the plug-in modules (full paths).</desc>
15343	</param>
15344	</method>
15345
15346	<method name="IsExtPackUsable">
15347	<desc>Check if the given extension pack is loaded and usable.</desc>
15348	<param name="name" type="wstring" dir="in">
15349	<desc>The name of the extension pack to check for.</desc>
15350	</param>
15351	<param name="usable" type="boolean" dir="return">
15352	<desc>Is the given extension pack loaded and usable.</desc>
15353	</param>
15354	</method>
15355
15356	</interface>
15357
15358	<!--
15359	// BandwidthGroupType
15360	/////////////////////////////////////////////////////////////////////////
15361	-->
15362	<enum
15363	name="BandwidthGroupType"
15364	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15365
15366	<desc>
15367	Type of a bandwidth control group.
15368	</desc>
15369
15370	<const name="Null" value="0">
15371	<desc>
15372	Null type, must be first.
15373	</desc>
15374	</const>
15375
15376	<const name="Disk" value="1">
15377	<desc>
15378	The bandwidth group controls disk I/O.
15379	</desc>
15380	</const>
15381
15382	<const name="Network" value="2">
15383	<desc>
15384	The bandwidth group controls network I/O.
15385	</desc>
15386	</const>
15387
15388	</enum>
15389
15390	<!--
15391	// IBandwidthGroup
15392	/////////////////////////////////////////////////////////////////////////
15393	-->
15394	<interface
15395	name="IBandwidthGroup" extends="$unknown"
15396	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15397	wsmap="managed"
15398	>
15399	<desc>Represents one bandwidth group.</desc>
15400
15401	<attribute name="name" type="wstring" readonly="yes">
15402	<desc>Name of the group.</desc>
15403	</attribute>
15404
15405	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15406	<desc>Type of the group.</desc>
15407	</attribute>
15408
15409	<attribute name="reference" type="unsigned long" readonly="yes">
15410	<desc>How many devices/medium attachements use this group.</desc>
15411	</attribute>
15412
15413	<attribute name="maxMbPerSec" type="unsigned long">
15414	<desc>The maximum number of MBytes which can be transfered by all
15415	entities attached to this group during one second.</desc>
15416	</attribute>
15417
15418	</interface>
15419
15420	<!--
15421	// IBandwidthControl
15422	/////////////////////////////////////////////////////////////////////////
15423	-->
15424	<interface
15425	name="IBandwidthControl" extends="$unknown"
15426	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15427	wsmap="managed"
15428	>
15429	<desc>
15430	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15431	This includes network and disk I/O.
15432	</desc>
15433
15434	<attribute name="numGroups" type="unsigned long" readonly="yes">
15435	<desc>
15436	The current number of existing bandwidth groups managed.
15437	</desc>
15438	</attribute>
15439
15440	<method name="CreateBandwidthGroup">
15441	<desc>
15442	Creates a new bandwidth group.
15443	</desc>
15444
15445	<param name="name" type="wstring" dir="in">
15446	<desc>Name of the bandwidth group.</desc>
15447	</param>
15448	<param name="type" type="BandwidthGroupType" dir="in">
15449	<desc>The type of the bandwidth group (network or disk).</desc>
15450	</param>
15451	<param name="maxMbPerSec" type="unsigned long" dir="in">
15452	<desc>The maximum number of MBytes which can be transfered by all
15453	entities attached to this group during one second.</desc>
15454	</param>
15455	</method>
15456
15457	<method name="DeleteBandwidthGroup">
15458	<desc>
15459	Deletes a new bandwidth group.
15460	</desc>
15461
15462	<param name="name" type="wstring" dir="in">
15463	<desc>Name of the bandwidth group to delete.</desc>
15464	</param>
15465	</method>
15466
15467	<method name="GetBandwidthGroup" const="yes">
15468	<desc>
15469	Get a bandwidth group by name.
15470	</desc>
15471
15472	<param name="name" type="wstring" dir="in">
15473	<desc>Name of the bandwidth group to get.</desc>
15474	</param>
15475	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15476	<desc>Where to store the bandwidth group on success.</desc>
15477	</param>
15478	</method>
15479
15480	<method name="GetAllBandwidthGroups" const="yes">
15481	<desc>
15482	Get all managed bandwidth groups.
15483	</desc>
15484
15485	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15486	<desc>The array of managed bandwidth groups.</desc>
15487	</param>
15488	</method>
15489	</interface>
15490
15491	<!--
15492	// IVirtualBoxClient
15493	/////////////////////////////////////////////////////////////////////////
15494	-->
15495
15496	<interface
15497	name="IVirtualBoxClient" extends="$unknown"
15498	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15499	wsmap="suppress"
15500	>
15501	<desc>
15502	Convenience interface for client applications. Treat this as a
15503	singleton, i.e. never create more than one instance of this interface.
15504
15505	At the moment only available for clients of the local API (not usable
15506	via the webservice). Once the session logic is redesigned this might
15507	change.
15508	</desc>
15509
15510	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15511	<desc>
15512	Reference to the server-side API root object.
15513	</desc>
15514	</attribute>
15515
15516	<attribute name="session" type="ISession" readonly="yes">
15517	<desc>
15518	Create a new session object and return the reference to it.
15519	</desc>
15520	</attribute>
15521
15522	<attribute name="eventSource" type="IEventSource" readonly="yes">
15523	<desc>
15524	Event source for VirtualBoxClient events.
15525	</desc>
15526	</attribute>
15527
15528	</interface>
15529
15530	<!--
15531	// Events
15532	/////////////////////////////////////////////////////////////////////////
15533	-->
15534	<enum
15535	name="VBoxEventType"
15536	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
15537	>
15538
15539	<desc>
15540	Type of an event.
15541	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15542	</desc>
15543
15544	<const name="Invalid" value="0">
15545	<desc>
15546	Invalid event, must be first.
15547	</desc>
15548	</const>
15549
15550	<const name="Any" value="1">
15551	<desc>
15552	Wildcard for all events.
15553	Events of this type are never delivered, and only used in
15554	registerListener() call to simplify registration.
15555	</desc>
15556	</const>
15557
15558	<const name="Vetoable" value="2">
15559	<desc>
15560	Wildcard for all vetoable events. Events of this type are never delivered, and only
15561	used in registerListener() call to simplify registration.
15562	</desc>
15563	</const>
15564
15565	<const name="MachineEvent" value="3">
15566	<desc>
15567	Wildcard for all machine events. Events of this type are never delivered, and only used in
15568	registerListener() call to simplify registration.
15569	</desc>
15570	</const>
15571
15572	<const name="SnapshotEvent" value="4">
15573	<desc>
15574	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15575	registerListener() call to simplify registration.
15576	</desc>
15577	</const>
15578
15579	<const name="InputEvent" value="5">
15580	<desc>
15581	Wildcard for all input device (keyboard, mouse) events.
15582	Events of this type are never delivered, and only used in
15583	registerListener() call to simplify registration.
15584	</desc>
15585	</const>
15586
15587	<const name="LastWildcard" value="31">
15588	<desc>
15589	Last wildcard.
15590	</desc>
15591	</const>
15592
15593	<const name="OnMachineStateChanged" value="32">
15594	<desc>
15595	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15596	</desc>
15597	</const>
15598	<const name="OnMachineDataChanged" value="33">
15599	<desc>
15600	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15601	</desc>
15602	</const>
15603	<const name="OnExtraDataChanged" value="34">
15604	<desc>
15605	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15606	</desc>
15607	</const>
15608	<const name="OnExtraDataCanChange" value="35">
15609	<desc>
15610	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15611	</desc>
15612	</const>
15613	<const name="OnMediumRegistered" value="36">
15614	<desc>
15615	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15616	</desc>
15617	</const>
15618	<const name="OnMachineRegistered" value="37">
15619	<desc>
15620	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15621	</desc>
15622	</const>
15623	<const name="OnSessionStateChanged" value="38">
15624	<desc>
15625	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15626	</desc>
15627	</const>
15628	<const name="OnSnapshotTaken" value="39">
15629	<desc>
15630	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15631	</desc>
15632	</const>
15633	<const name="OnSnapshotDeleted" value="40">
15634	<desc>
15635	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15636	</desc>
15637	</const>
15638	<const name="OnSnapshotChanged" value="41">
15639	<desc>
15640	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15641	</desc>
15642	</const>
15643	<const name="OnGuestPropertyChanged" value="42">
15644	<desc>
15645	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15646	</desc>
15647	</const>
15648	<!-- Console events -->
15649	<const name="OnMousePointerShapeChanged" value="43">
15650	<desc>
15651	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15652	</desc>
15653	</const>
15654	<const name="OnMouseCapabilityChanged" value="44">
15655	<desc>
15656	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15657	</desc>
15658	</const>
15659	<const name="OnKeyboardLedsChanged" value="45">
15660	<desc>
15661	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15662	</desc>
15663	</const>
15664	<const name="OnStateChanged" value="46">
15665	<desc>
15666	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15667	</desc>
15668	</const>
15669	<const name="OnAdditionsStateChanged" value="47">
15670	<desc>
15671	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15672	</desc>
15673	</const>
15674	<const name="OnNetworkAdapterChanged" value="48">
15675	<desc>
15676	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15677	</desc>
15678	</const>
15679	<const name="OnSerialPortChanged" value="49">
15680	<desc>
15681	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15682	</desc>
15683	</const>
15684	<const name="OnParallelPortChanged" value="50">
15685	<desc>
15686	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15687	</desc>
15688	</const>
15689	<const name="OnStorageControllerChanged" value="51">
15690	<desc>
15691	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15692	</desc>
15693	</const>
15694	<const name="OnMediumChanged" value="52">
15695	<desc>
15696	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15697	</desc>
15698	</const>
15699	<const name="OnVRDEServerChanged" value="53">
15700	<desc>
15701	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15702	</desc>
15703	</const>
15704	<const name="OnUSBControllerChanged" value="54">
15705	<desc>
15706	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15707	</desc>
15708	</const>
15709	<const name="OnUSBDeviceStateChanged" value="55">
15710	<desc>
15711	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15712	</desc>
15713	</const>
15714	<const name="OnSharedFolderChanged" value="56">
15715	<desc>
15716	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15717	</desc>
15718	</const>
15719	<const name="OnRuntimeError" value="57">
15720	<desc>
15721	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15722	</desc>
15723	</const>
15724	<const name="OnCanShowWindow" value="58">
15725	<desc>
15726	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15727	</desc>
15728	</const>
15729	<const name="OnShowWindow" value="59">
15730	<desc>
15731	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15732	</desc>
15733	</const>
15734	<const name="OnCPUChanged" value="60">
15735	<desc>
15736	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15737	</desc>
15738	</const>
15739	<const name="OnVRDEServerInfoChanged" value="61">
15740	<desc>
15741	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15742	</desc>
15743	</const>
15744	<const name="OnEventSourceChanged" value="62">
15745	<desc>
15746	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15747	</desc>
15748	</const>
15749	<const name="OnCPUExecutionCapChanged" value="63">
15750	<desc>
15751	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15752	</desc>
15753	</const>
15754	<const name="OnGuestKeyboard" value="64">
15755	<desc>
15756	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15757	</desc>
15758	</const>
15759	<const name="OnGuestMouse" value="65">
15760	<desc>
15761	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15762	</desc>
15763	</const>
15764	<const name="OnNATRedirect" value="66">
15765	<desc>
15766	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15767	</desc>
15768	</const>
15769	<const name="OnHostPciDevicePlug" value="67">
15770	<desc>
15771	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15772	</desc>
15773	</const>
15774	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15775	<desc>
15776	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15777	</desc>
15778	</const>
15779	<const name="OnBandwidthGroupChanged" value="69">
15780	<desc>
15781	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15782	</desc>
15783	</const>
15784	<const name="OnGuestMonitorChanged" value="70">
15785	<desc>
15786	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15787	</desc>
15788	</const>
15789	<const name="OnStorageDeviceChanged" value="71">
15790	<desc>
15791	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
15792	</desc>
15793	</const>
15794
15795	<!-- Last event marker -->
15796	<const name="Last" value="72">
15797	<desc>
15798	Must be last event, used for iterations and structures relying on numerical event values.
15799	</desc>
15800	</const>
15801
15802	</enum>
15803
15804	<interface
15805	name="IEventSource" extends="$unknown"
15806	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15807	wsmap="managed"
15808	>
15809	<desc>
15810	Event source. Generally, any object which could generate events can be an event source,
15811	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15812	an event source can work with listeners in either active or passive mode. In active mode it is up to
15813	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15814	event source keeps track of pending events for each listener and returns available events on demand.
15815
15816	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15817	</desc>
15818
15819	<method name="createListener">
15820	<desc>
15821	Creates a new listener object, useful for passive mode.
15822	</desc>
15823	<param name="listener" type="IEventListener" dir="return"/>
15824	</method>
15825
15826	<method name="createAggregator">
15827	<desc>
15828	Creates an aggregator event source, collecting events from multiple sources.
15829	This way a single listener can listen for events coming from multiple sources,
15830	using a single blocking getEvent() on the returned aggregator.
15831	</desc>
15832	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15833	<desc>
15834	Subordinate event source this one aggregatres.
15835	</desc>
15836	</param>
15837	<param name="result" type="IEventSource" dir="return">
15838	<desc>
15839	Event source aggregating passed sources.
15840	</desc>
15841	</param>
15842	</method>
15843
15844	<method name="registerListener">
15845	<desc>
15846	Register an event listener.
15847
15848	<note>
15849	To avoid system overload, the VirtualBox server process checks if passive event
15850	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15851	current implementation, if more than 500 pending events are detected for a passive
15852	event listener, it is forcefully unregistered by the system, and further
15853	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15854	</note>
15855	</desc>
15856	<param name="listener" type="IEventListener" dir="in">
15857	<desc>Listener to register.</desc>
15858	</param>
15859	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15860	<desc>
15861	Event types listener is interested in. One can use wildcards like -
15862	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15863	than one event.
15864	</desc>
15865	</param>
15866	<param name="active" type="boolean" dir="in">
15867	<desc>
15868	Which mode this listener is operating in.
15869	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15870	In passive mode, an internal event queue is created for this this IEventListener.
15871	For each event coming in, it is added to queues for all interested registered passive
15872	listeners. It is then up to the external code to call the listener's
15873	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15874	external code must call <link to="#eventProcessed" />.
15875	</desc>
15876	</param>
15877	</method>
15878
15879	<method name="unregisterListener">
15880	<desc>
15881	Unregister an event listener. If listener is passive, and some waitable events are still
15882	in queue they are marked as processed automatically.
15883	</desc>
15884	<param name="listener" type="IEventListener" dir="in">
15885	<desc>Listener to unregister.</desc>
15886	</param>
15887	</method>
15888
15889	<method name="fireEvent">
15890	<desc>
15891	Fire an event for this source.
15892	</desc>
15893	<param name="event" type="IEvent" dir="in">
15894	<desc>Event to deliver.</desc>
15895	</param>
15896	<param name="timeout" type="long" dir="in">
15897	<desc>
15898	Maximum time to wait for event processing (if event is waitable), in ms;
15899	0 = no wait, -1 = indefinite wait.
15900	</desc>
15901	</param>
15902	<param name="result" type="boolean" dir="return">
15903	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15904	</param>
15905	</method>
15906
15907	<method name="getEvent">
15908	<desc>
15909	Get events from this peer's event queue (for passive mode). Calling this method
15910	regularly is required for passive event listeners to avoid system overload;
15911	see <link to="IEventSource::registerListener" /> for details.
15912
15913	<result name="VBOX_E_OBJECT_NOT_FOUND">
15914	Listener is not registered, or autounregistered.
15915	</result>
15916	</desc>
15917	<param name="listener" type="IEventListener" dir="in">
15918	<desc>Which listener to get data for.</desc>
15919	</param>
15920	<param name="timeout" type="long" dir="in">
15921	<desc>
15922	Maximum time to wait for events, in ms;
15923	0 = no wait, -1 = indefinite wait.
15924	</desc>
15925	</param>
15926	<param name="event" type="IEvent" dir="return">
15927	<desc>Event retrieved, or null if none available.</desc>
15928	</param>
15929	</method>
15930
15931	<method name="eventProcessed">
15932	<desc>
15933	Must be called for waitable events after a particular listener finished its
15934	event processing. When all listeners of a particular event have called this
15935	method, the system will then call <link to="IEvent::setProcessed" />.
15936	</desc>
15937	<param name="listener" type="IEventListener" dir="in">
15938	<desc>Which listener processed event.</desc>
15939	</param>
15940	<param name="event" type="IEvent" dir="in">
15941	<desc>Which event.</desc>
15942	</param>
15943	</method>
15944
15945	</interface>
15946
15947	<interface
15948	name="IEventListener" extends="$unknown"
15949	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15950	wsmap="managed"
15951	>
15952	<desc>
15953	Event listener. An event listener can work in either active or passive mode, depending on the way
15954	it was registered.
15955	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15956	</desc>
15957
15958	<method name="handleEvent">
15959	<desc>
15960	Handle event callback for active listeners. It is not called for passive listeners. After
15961	calling handleEvent() on all active listeners and having received acknowledgement from all
15962	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15963	IEvent::waitProcessed() will return immediately.
15964	</desc>
15965	<param name="event" type="IEvent" dir="in">
15966	<desc>Event available.</desc>
15967	</param>
15968	</method>
15969
15970	</interface>
15971
15972	<interface
15973	name="IEvent" extends="$unknown"
15974	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15975	wsmap="managed"
15976	>
15977	<desc>
15978	Abstract parent interface for VirtualBox events. Actual events will typically implement
15979	a more specific interface which derives from this (see below).
15980
15981	<b>Introduction to VirtualBox events</b>
15982
15983	Generally speaking, an event (represented by this interface) signals that something
15984	happened, while an event listener (see <link to="IEventListener" />) represents an
15985	entity that is interested in certain events. In order for this to work with
15986	unidirectional protocols (i.e. web services), the concepts of passive and active
15987	listener are used.
15988
15989	Event consumers can register themselves as listeners, providing an array of
15990	events they are interested in (see <link to="IEventSource::registerListener" />).
15991	When an event triggers, the listener is notified about the event. The exact
15992	mechanism of the notification depends on whether the listener was registered as
15993	an active or passive listener:
15994
15995	<ul>
15996	<li>An active listener is very similar to a callback: it is a function invoked
15997	by the API. As opposed to the callbacks that were used in the API before
15998	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15999	</li>
16000
16001	<li>Passive listeners are somewhat trickier to implement, but do not require
16002	a client function to be callable, which is not an option with scripting
16003	languages or web service clients. Internally the <link to="IEventSource" />
16004	implementation maintains an event queue for each passive listener, and
16005	newly arrived events are put in this queue. When the listener calls
16006	<link to="IEventSource::getEvent"/>, first element from its internal event
16007	queue is returned. When the client completes processing of an event,
16008	the <link to="IEventSource::eventProcessed" /> function must be called,
16009	acknowledging that the event was processed. It supports implementing
16010	waitable events. On passive listener unregistration, all events from its
16011	queue are auto-acknowledged.
16012	</li>
16013	</ul>
16014
16015	Waitable events are useful in situations where the event generator wants to track
16016	delivery or a party wants to wait until all listeners have completed the event. A
16017	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16018	listeners might veto a certain action, and thus the event producer has to make
16019	sure that all listeners have processed the event and not vetoed before taking
16020	the action.
16021
16022	A given event may have both passive and active listeners at the same time.
16023
16024	<b>Using events</b>
16025
16026	Any VirtualBox object capable of producing externally visible events provides an
16027	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16028	This event source object is notified by VirtualBox once something has happened, so
16029	consumers may register event listeners with this event source. To register a listener,
16030	an object implementing the <link to="IEventListener" /> interface must be provided.
16031	For active listeners, such an object is typically created by the consumer, while for
16032	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16033	note that a listener created with @c createListener() must not be used as an active listener.
16034
16035	Once created, the listener must be registered to listen for the desired events
16036	(see <link to="IEventSource::registerListener" />), providing an array of
16037	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16038	event IDs or wildcards matching multiple event IDs.
16039
16040	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16041	called automatically when the event is triggered, while passive listeners have to call
16042	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16043	an event processing loop.
16044
16045	The IEvent interface is an abstract parent interface for all such VirtualBox events
16046	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16047	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16048	then cast to the appropriate specific interface using @c QueryInterface().
16049	</desc>
16050
16051	<attribute name="type" readonly="yes" type="VBoxEventType">
16052	<desc>
16053	Event type.
16054	</desc>
16055	</attribute>
16056
16057	<attribute name="source" readonly="yes" type="IEventSource">
16058	<desc>
16059	Source of this event.
16060	</desc>
16061	</attribute>
16062
16063	<attribute name="waitable" readonly="yes" type="boolean">
16064	<desc>
16065	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
16066	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
16067	as no additional overhead associated with waitability imposed.
16068	Waitable events are needed when one need to be able to wait for particular event processed,
16069	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
16070	until all consumers confirmed events.
16071	</desc>
16072	</attribute>
16073
16074	<method name="setProcessed">
16075	<desc>
16076	Internal method called by the system when all listeners of a particular event have called
16077	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
16078	</desc>
16079	</method>
16080
16081	<method name="waitProcessed">
16082	<desc>
16083	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
16084	described semantics, for non-waitable returns true immediately.
16085	</desc>
16086	<param name="timeout" type="long" dir="in">
16087	<desc>
16088	Maximum time to wait for event processeing, in ms;
16089	0 = no wait, -1 = indefinite wait.
16090	</desc>
16091	</param>
16092	<param name="result" type="boolean" dir="return">
16093	<desc>If this event was processed before timeout.</desc>
16094	</param>
16095	</method>
16096	</interface>
16097
16098
16099	<interface
16100	name="IReusableEvent" extends="IEvent"
16101	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
16102	wsmap="managed"
16103	>
16104	<desc>Base abstract interface for all reusable events.</desc>
16105
16106	<attribute name="generation" readonly="yes" type="unsigned long">
16107	<desc>Current generation of event, incremented on reuse.</desc>
16108	</attribute>
16109
16110	<method name="reuse">
16111	<desc>
16112	Marks an event as reused, increments 'generation', fields shall no
16113	longer be considered valid.
16114	</desc>
16115	</method>
16116	</interface>
16117
16118	<interface
16119	name="IMachineEvent" extends="IEvent"
16120	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
16121	wsmap="managed" id="MachineEvent"
16122	>
16123	<desc>Base abstract interface for all machine events.</desc>
16124
16125	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
16126	<desc>ID of the machine this event relates to.</desc>
16127	</attribute>
16128
16129	</interface>
16130
16131	<interface
16132	name="IMachineStateChangedEvent" extends="IMachineEvent"
16133	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
16134	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
16135	>
16136	<desc>Machine state change event.</desc>
16137
16138	<attribute name="state" readonly="yes" type="MachineState">
16139	<desc>New execution state.</desc>
16140	</attribute>
16141	</interface>
16142
16143	<interface
16144	name="IMachineDataChangedEvent" extends="IMachineEvent"
16145	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
16146	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
16147	>
16148	<desc>
16149	Any of the settings of the given machine has changed.
16150	</desc>
16151	</interface>
16152
16153	<interface
16154	name="IMediumRegisteredEvent" extends="IEvent"
16155	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
16156	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
16157	>
16158	<desc>
16159	The given medium was registered or unregistered
16160	within this VirtualBox installation.
16161	</desc>
16162
16163	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
16164	<desc>ID of the medium this event relates to.</desc>
16165	</attribute>
16166
16167	<attribute name="mediumType" readonly="yes" type="DeviceType">
16168	<desc>Type of the medium this event relates to.</desc>
16169	</attribute>
16170
16171	<attribute name="registered" type="boolean" readonly="yes">
16172	<desc>
16173	If @c true, the medium was registered, otherwise it was
16174	unregistered.
16175	</desc>
16176	</attribute>
16177	</interface>
16178
16179	<interface
16180	name="IMachineRegisteredEvent" extends="IMachineEvent"
16181	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
16182	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
16183	>
16184	<desc>
16185	The given machine was registered or unregistered
16186	within this VirtualBox installation.
16187	</desc>
16188
16189	<attribute name="registered" type="boolean" readonly="yes">
16190	<desc>
16191	If @c true, the machine was registered, otherwise it was
16192	unregistered.
16193	</desc>
16194	</attribute>
16195	</interface>
16196
16197	<interface
16198	name="ISessionStateChangedEvent" extends="IMachineEvent"
16199	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
16200	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
16201	>
16202	<desc>
16203	The state of the session for the given machine was changed.
16204	<see>IMachine::sessionState</see>
16205	</desc>
16206
16207	<attribute name="state" type="SessionState" readonly="yes">
16208	<desc>
16209	New session state.
16210	</desc>
16211	</attribute>
16212	</interface>
16213
16214	<interface
16215	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
16216	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
16217	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
16218	>
16219	<desc>
16220	Notification when a guest property has changed.
16221	</desc>
16222
16223	<attribute name="name" readonly="yes" type="wstring">
16224	<desc>
16225	The name of the property that has changed.
16226	</desc>
16227	</attribute>
16228
16229	<attribute name="value" readonly="yes" type="wstring">
16230	<desc>
16231	The new property value.
16232	</desc>
16233	</attribute>
16234
16235	<attribute name="flags" readonly="yes" type="wstring">
16236	<desc>
16237	The new property flags.
16238	</desc>
16239	</attribute>
16240
16241	</interface>
16242
16243	<interface
16244	name="ISnapshotEvent" extends="IMachineEvent"
16245	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16246	wsmap="managed" id="SnapshotEvent"
16247	>
16248	<desc>Base interface for all snapshot events.</desc>
16249
16250	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16251	<desc>ID of the snapshot this event relates to.</desc>
16252	</attribute>
16253
16254	</interface>
16255
16256	<interface
16257	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16258	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16259	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16260	>
16261	<desc>
16262	A new snapshot of the machine has been taken.
16263	<see>ISnapshot</see>
16264	</desc>
16265	</interface>
16266
16267	<interface
16268	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16269	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16270	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16271	>
16272	<desc>
16273	Snapshot of the given machine has been deleted.
16274
16275	<note>
16276	This notification is delivered <b>after</b> the snapshot
16277	object has been uninitialized on the server (so that any
16278	attempt to call its methods will return an error).
16279	</note>
16280
16281	<see>ISnapshot</see>
16282	</desc>
16283	</interface>
16284
16285	<interface
16286	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16287	uuid="07541941-8079-447a-a33e-47a69c7980db"
16288	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16289	>
16290	<desc>
16291	Snapshot properties (name and/or description) have been changed.
16292	<see>ISnapshot</see>
16293	</desc>
16294	</interface>
16295
16296	<interface
16297	name="IMousePointerShapeChangedEvent" extends="IEvent"
16298	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16299	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16300	>
16301	<desc>
16302	Notification when the guest mouse pointer shape has
16303	changed. The new shape data is given.
16304	</desc>
16305
16306	<attribute name="visible" type="boolean" readonly="yes">
16307	<desc>
16308	Flag whether the pointer is visible.
16309	</desc>
16310	</attribute>
16311	<attribute name="alpha" type="boolean" readonly="yes">
16312	<desc>
16313	Flag whether the pointer has an alpha channel.
16314	</desc>
16315	</attribute>
16316	<attribute name="xhot" type="unsigned long" readonly="yes">
16317	<desc>
16318	The pointer hot spot X coordinate.
16319	</desc>
16320	</attribute>
16321	<attribute name="yhot" type="unsigned long" readonly="yes">
16322	<desc>
16323	The pointer hot spot Y coordinate.
16324	</desc>
16325	</attribute>
16326	<attribute name="width" type="unsigned long" readonly="yes">
16327	<desc>
16328	Width of the pointer shape in pixels.
16329	</desc>
16330	</attribute>
16331	<attribute name="height" type="unsigned long" readonly="yes">
16332	<desc>
16333	Height of the pointer shape in pixels.
16334	</desc>
16335	</attribute>
16336	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16337	<desc>
16338	Shape buffer arrays.
16339
16340	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16341	followed by a 32-bpp XOR (color) mask.
16342
16343	For pointers without alpha channel the XOR mask pixels are 32
16344	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16345	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16346
16347	An AND mask is used for pointers with alpha channel, so if the
16348	callback does not support alpha, the pointer could be
16349	displayed as a normal color pointer.
16350
16351	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16352	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16353	height</tt>. The padding bits at the end of each scanline are
16354	undefined.
16355
16356	The XOR mask follows the AND mask on the next 4-byte aligned
16357	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16358	Bytes in the gap between the AND and the XOR mask are undefined.
16359	The XOR mask scanlines have no gap between them and the size of
16360	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16361
16362	<note>
16363	If @a shape is 0, only the pointer visibility is changed.
16364	</note>
16365	</desc>
16366	</attribute>
16367	</interface>
16368
16369	<interface
16370	name="IMouseCapabilityChangedEvent" extends="IEvent"
16371	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16372	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16373	>
16374	<desc>
16375	Notification when the mouse capabilities reported by the
16376	guest have changed. The new capabilities are passed.
16377	</desc>
16378	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16379	<desc>
16380	Supports absolute coordinates.
16381	</desc>
16382	</attribute>
16383	<attribute name="supportsRelative" type="boolean" readonly="yes">
16384	<desc>
16385	Supports relative coordinates.
16386	</desc>
16387	</attribute>
16388	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16389	<desc>
16390	If host cursor is needed.
16391	</desc>
16392	</attribute>
16393	</interface>
16394
16395	<interface
16396	name="IKeyboardLedsChangedEvent" extends="IEvent"
16397	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16398	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16399	>
16400	<desc>
16401	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16402	to alter the state of the keyboard LEDs.
16403	</desc>
16404	<attribute name="numLock" type="boolean" readonly="yes">
16405	<desc>
16406	NumLock status.
16407	</desc>
16408	</attribute>
16409	<attribute name="capsLock" type="boolean" readonly="yes">
16410	<desc>
16411	CapsLock status.
16412	</desc>
16413	</attribute>
16414	<attribute name="scrollLock" type="boolean" readonly="yes">
16415	<desc>
16416	ScrollLock status.
16417	</desc>
16418	</attribute>
16419	</interface>
16420
16421	<interface
16422	name="IStateChangedEvent" extends="IEvent"
16423	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16424	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16425	>
16426	<desc>
16427	Notification when the execution state of the machine has changed.
16428	The new state is given.
16429	</desc>
16430	<attribute name="state" type="MachineState" readonly="yes">
16431	<desc>
16432	New machine state.
16433	</desc>
16434	</attribute>
16435	</interface>
16436
16437	<interface
16438	name="IAdditionsStateChangedEvent" extends="IEvent"
16439	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16440	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16441	>
16442	<desc>
16443	Notification when a Guest Additions property changes.
16444	Interested callees should query IGuest attributes to
16445	find out what has changed.
16446	</desc>
16447	</interface>
16448
16449	<interface
16450	name="INetworkAdapterChangedEvent" extends="IEvent"
16451	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16452	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16453	>
16454	<desc>
16455	Notification when a property of one of the
16456	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16457	changes. Interested callees should use INetworkAdapter methods and
16458	attributes to find out what has changed.
16459	</desc>
16460	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16461	<desc>
16462	Network adapter that is subject to change.
16463	</desc>
16464	</attribute>
16465	</interface>
16466
16467	<interface
16468	name="ISerialPortChangedEvent" extends="IEvent"
16469	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16470	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16471	>
16472	<desc>
16473	Notification when a property of one of the
16474	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16475	Interested callees should use ISerialPort methods and attributes
16476	to find out what has changed.
16477	</desc>
16478	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16479	<desc>
16480	Serial port that is subject to change.
16481	</desc>
16482	</attribute>
16483	</interface>
16484
16485	<interface
16486	name="IParallelPortChangedEvent" extends="IEvent"
16487	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16488	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16489	>
16490	<desc>
16491	Notification when a property of one of the
16492	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16493	changes. Interested callees should use ISerialPort methods and
16494	attributes to find out what has changed.
16495	</desc>
16496	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16497	<desc>
16498	Parallel port that is subject to change.
16499	</desc>
16500	</attribute>
16501	</interface>
16502
16503	<interface
16504	name="IStorageControllerChangedEvent" extends="IEvent"
16505	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16506	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16507	>
16508	<desc>
16509	Notification when a
16510	<link to="IMachine::mediumAttachments">medium attachment</link>
16511	changes.
16512	</desc>
16513	</interface>
16514
16515	<interface
16516	name="IMediumChangedEvent" extends="IEvent"
16517	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16518	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16519	>
16520	<desc>
16521	Notification when a
16522	<link to="IMachine::mediumAttachments">medium attachment</link>
16523	changes.
16524	</desc>
16525	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16526	<desc>
16527	Medium attachment that is subject to change.
16528	</desc>
16529	</attribute>
16530	</interface>
16531
16532	<interface
16533	name="ICPUChangedEvent" extends="IEvent"
16534	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16535	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16536	>
16537	<desc>
16538	Notification when a CPU changes.
16539	</desc>
16540	<attribute name="cpu" type="unsigned long" readonly="yes">
16541	<desc>
16542	The CPU which changed.
16543	</desc>
16544	</attribute>
16545	<attribute name="add" type="boolean" readonly="yes">
16546	<desc>
16547	Flag whether the CPU was added or removed.
16548	</desc>
16549	</attribute>
16550	</interface>
16551
16552	<interface
16553	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16554	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16555	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16556	>
16557	<desc>
16558	Notification when the CPU execution cap changes.
16559	</desc>
16560	<attribute name="executionCap" type="unsigned long" readonly="yes">
16561	<desc>
16562	The new CPU execution cap value. (1-100)
16563	</desc>
16564	</attribute>
16565	</interface>
16566
16567	<interface
16568	name="IGuestKeyboardEvent" extends="IEvent"
16569	uuid="88394258-7006-40d4-b339-472ee3801844"
16570	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16571	>
16572	<desc>
16573	Notification when guest keyboard event happens.
16574	</desc>
16575	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16576	<desc>
16577	Array of scancodes.
16578	</desc>
16579	</attribute>
16580	</interface>
16581
16582	<interface
16583	name="IGuestMouseEvent" extends="IReusableEvent"
16584	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16585	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16586	>
16587	<desc>
16588	Notification when guest mouse event happens.
16589	</desc>
16590
16591	<attribute name="absolute" type="boolean" readonly="yes">
16592	<desc>
16593	If this event is relative or absolute.
16594	</desc>
16595	</attribute>
16596
16597	<attribute name="x" type="long" readonly="yes">
16598	<desc>
16599	New X position, or X delta.
16600	</desc>
16601	</attribute>
16602
16603	<attribute name="y" type="long" readonly="yes">
16604	<desc>
16605	New Y position, or Y delta.
16606	</desc>
16607	</attribute>
16608
16609	<attribute name="z" type="long" readonly="yes">
16610	<desc>
16611	Z delta.
16612	</desc>
16613	</attribute>
16614
16615	<attribute name="w" type="long" readonly="yes">
16616	<desc>
16617	W delta.
16618	</desc>
16619	</attribute>
16620
16621	<attribute name="buttons" type="long" readonly="yes">
16622	<desc>
16623	Button state bitmask.
16624	</desc>
16625	</attribute>
16626
16627	</interface>
16628
16629
16630	<interface
16631	name="IVRDEServerChangedEvent" extends="IEvent"
16632	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16633	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16634	>
16635	<desc>
16636	Notification when a property of the
16637	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16638	Interested callees should use IVRDEServer methods and attributes to
16639	find out what has changed.
16640	</desc>
16641	</interface>
16642
16643	<interface
16644	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16645	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16646	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16647	>
16648	<desc>
16649	Notification when the status of the VRDE server changes. Interested callees
16650	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16651	attributes to find out what is the current status.
16652	</desc>
16653	</interface>
16654
16655	<interface
16656	name="IUSBControllerChangedEvent" extends="IEvent"
16657	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16658	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16659	>
16660	<desc>
16661	Notification when a property of the virtual
16662	<link to="IMachine::USBController">USB controller</link> changes.
16663	Interested callees should use IUSBController methods and attributes to
16664	find out what has changed.
16665	</desc>
16666	</interface>
16667
16668	<interface
16669	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16670	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16671	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16672	>
16673	<desc>
16674	Notification when a USB device is attached to or detached from
16675	the virtual USB controller.
16676
16677	This notification is sent as a result of the indirect
16678	request to attach the device because it matches one of the
16679	machine USB filters, or as a result of the direct request
16680	issued by <link to="IConsole::attachUSBDevice"/> or
16681	<link to="IConsole::detachUSBDevice"/>.
16682
16683	This notification is sent in case of both a succeeded and a
16684	failed request completion. When the request succeeds, the
16685	@a error parameter is @c null, and the given device has been
16686	already added to (when @a attached is @c true) or removed from
16687	(when @a attached is @c false) the collection represented by
16688	<link to="IConsole::USBDevices"/>. On failure, the collection
16689	doesn't change and the @a error parameter represents the error
16690	message describing the failure.
16691	</desc>
16692	<attribute name="device" type="IUSBDevice" readonly="yes">
16693	<desc>
16694	Device that is subject to state change.
16695	</desc>
16696	</attribute>
16697	<attribute name="attached" type="boolean" readonly="yes">
16698	<desc>
16699	@c true if the device was attached and @c false otherwise.
16700	</desc>
16701	</attribute>
16702	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16703	<desc>
16704	@c null on success or an error message object on failure.
16705	</desc>
16706	</attribute>
16707	</interface>
16708
16709	<interface
16710	name="ISharedFolderChangedEvent" extends="IEvent"
16711	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16712	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16713	>
16714	<desc>
16715	Notification when a shared folder is added or removed.
16716	The @a scope argument defines one of three scopes:
16717	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16718	(<link to="Scope_Global">Global</link>),
16719	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16720	the machine (<link to="Scope_Machine">Machine</link>) or <link
16721	to="IConsole::sharedFolders">transient shared folders</link> of the
16722	machine (<link to="Scope_Session">Session</link>). Interested callees
16723	should use query the corresponding collections to find out what has
16724	changed.
16725	</desc>
16726	<attribute name="scope" type="Scope" readonly="yes">
16727	<desc>
16728	Scope of the notification.
16729	</desc>
16730	</attribute>
16731	</interface>
16732
16733	<interface
16734	name="IRuntimeErrorEvent" extends="IEvent"
16735	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16736	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16737	>
16738	<desc>
16739	Notification when an error happens during the virtual
16740	machine execution.
16741
16742	There are three kinds of runtime errors:
16743	<ul>
16744	<li><i>fatal</i></li>
16745	<li><i>non-fatal with retry</i></li>
16746	<li><i>non-fatal warnings</i></li>
16747	</ul>
16748
16749	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16750	to @c true. In case of fatal errors, the virtual machine
16751	execution is always paused before calling this notification, and
16752	the notification handler is supposed either to immediately save
16753	the virtual machine state using <link to="IConsole::saveState"/>
16754	or power it off using <link to="IConsole::powerDown"/>.
16755	Resuming the execution can lead to unpredictable results.
16756
16757	<b>Non-fatal</b> errors and warnings are indicated by the
16758	@a fatal parameter set to @c false. If the virtual machine
16759	is in the Paused state by the time the error notification is
16760	received, it means that the user can <i>try to resume</i> the machine
16761	execution after attempting to solve the problem that caused the
16762	error. In this case, the notification handler is supposed
16763	to show an appropriate message to the user (depending on the
16764	value of the @a id parameter) that offers several actions such
16765	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16766	wants to retry, the notification handler should continue
16767	the machine execution using the <link to="IConsole::resume"/>
16768	call. If the machine execution is not Paused during this
16769	notification, then it means this notification is a <i>warning</i>
16770	(for example, about a fatal condition that can happen very soon);
16771	no immediate action is required from the user, the machine
16772	continues its normal execution.
16773
16774	Note that in either case the notification handler
16775	<b>must not</b> perform any action directly on a thread
16776	where this notification is called. Everything it is allowed to
16777	do is to post a message to another thread that will then talk
16778	to the user and take the corresponding action.
16779
16780	Currently, the following error identifiers are known:
16781	<ul>
16782	<li><tt>"HostMemoryLow"</tt></li>
16783	<li><tt>"HostAudioNotResponding"</tt></li>
16784	<li><tt>"VDIStorageFull"</tt></li>
16785	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16786	</ul>
16787	</desc>
16788	<attribute name="fatal" type="boolean" readonly="yes">
16789	<desc>
16790	Whether the error is fatal or not.
16791	</desc>
16792	</attribute>
16793	<attribute name="id" type="wstring" readonly="yes">
16794	<desc>
16795	Error identifier.
16796	</desc>
16797	</attribute>
16798	<attribute name="message" type="wstring" readonly="yes">
16799	<desc>
16800	Optional error message.
16801	</desc>
16802	</attribute>
16803	</interface>
16804
16805
16806	<interface
16807	name="IEventSourceChangedEvent" extends="IEvent"
16808	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16809	waitable="yes"
16810	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16811	>
16812	<desc>
16813	Notification when an event source state changes (listener added or removed).
16814	</desc>
16815
16816	<attribute name="listener" type="IEventListener" readonly="yes">
16817	<desc>
16818	Event listener which has changed.
16819	</desc>
16820	</attribute>
16821
16822	<attribute name="add" type="boolean" readonly="yes">
16823	<desc>
16824	Flag whether listener was added or removed.
16825	</desc>
16826	</attribute>
16827	</interface>
16828
16829	<interface
16830	name="IExtraDataChangedEvent" extends="IEvent"
16831	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16832	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16833	>
16834	<desc>
16835	Notification when machine specific or global extra data
16836	has changed.
16837	</desc>
16838	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16839	<desc>
16840	ID of the machine this event relates to.
16841	Null for global extra data changes.
16842	</desc>
16843	</attribute>
16844	<attribute name="key" type="wstring" readonly="yes">
16845	<desc>
16846	Extra data key that has changed.
16847	</desc>
16848	</attribute>
16849	<attribute name="value" type="wstring" readonly="yes">
16850	<desc>
16851	Extra data value for the given key.
16852	</desc>
16853	</attribute>
16854	</interface>
16855
16856	<interface
16857	name="IVetoEvent" extends="IEvent"
16858	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16859	wsmap="managed"
16860	>
16861	<desc>Base abstract interface for veto events.</desc>
16862
16863	<method name="addVeto">
16864	<desc>
16865	Adds a veto on this event.
16866	</desc>
16867	<param name="reason" type="wstring" dir="in">
16868	<desc>
16869	Reason for veto, could be null or empty string.
16870	</desc>
16871	</param>
16872	</method>
16873
16874	<method name="isVetoed">
16875	<desc>
16876	If this event was vetoed.
16877	</desc>
16878	<param name="result" type="boolean" dir="return">
16879	<desc>
16880	Reason for veto.
16881	</desc>
16882	</param>
16883	</method>
16884
16885	<method name="getVetos">
16886	<desc>
16887	Current veto reason list, if size is 0 - no veto.
16888	</desc>
16889	<param name="result" type="wstring" dir="return" safearray="yes">
16890	<desc>
16891	Array of reasons for veto provided by different event handlers.
16892	</desc>
16893	</param>
16894	</method>
16895
16896	</interface>
16897
16898	<interface
16899	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16900	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16901	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16902	waitable="true"
16903	>
16904	<desc>
16905	Notification when someone tries to change extra data for
16906	either the given machine or (if @c null) global extra data.
16907	This gives the chance to veto against changes.
16908	</desc>
16909	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16910	<desc>
16911	ID of the machine this event relates to.
16912	Null for global extra data changes.
16913	</desc>
16914	</attribute>
16915	<attribute name="key" type="wstring" readonly="yes">
16916	<desc>
16917	Extra data key that has changed.
16918	</desc>
16919	</attribute>
16920	<attribute name="value" type="wstring" readonly="yes">
16921	<desc>
16922	Extra data value for the given key.
16923	</desc>
16924	</attribute>
16925	</interface>
16926
16927	<interface
16928	name="ICanShowWindowEvent" extends="IVetoEvent"
16929	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16930	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16931	waitable="true"
16932	>
16933	<desc>
16934	Notification when a call to
16935	<link to="IMachine::canShowConsoleWindow"/> is made by a
16936	front-end to check if a subsequent call to
16937	<link to="IMachine::showConsoleWindow"/> can succeed.
16938
16939	The callee should give an answer appropriate to the current
16940	machine state using event veto. This answer must
16941	remain valid at least until the next
16942	<link to="IConsole::state">machine state</link> change.
16943	</desc>
16944	</interface>
16945
16946	<interface
16947	name="IShowWindowEvent" extends="IEvent"
16948	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16949	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16950	waitable="true"
16951	>
16952	<desc>
16953	Notification when a call to
16954	<link to="IMachine::showConsoleWindow"/>
16955	requests the console window to be activated and brought to
16956	foreground on the desktop of the host PC.
16957
16958	This notification should cause the VM console process to
16959	perform the requested action as described above. If it is
16960	impossible to do it at a time of this notification, this
16961	method should return a failure.
16962
16963	Note that many modern window managers on many platforms
16964	implement some sort of focus stealing prevention logic, so
16965	that it may be impossible to activate a window without the
16966	help of the currently active application (which is supposedly
16967	an initiator of this notification). In this case, this method
16968	must return a non-zero identifier that represents the
16969	top-level window of the VM console process. The caller, if it
16970	represents a currently active process, is responsible to use
16971	this identifier (in a platform-dependent manner) to perform
16972	actual window activation.
16973
16974	This method must set @a winId to zero if it has performed all
16975	actions necessary to complete the request and the console
16976	window is now active and in foreground, to indicate that no
16977	further action is required on the caller's side.
16978	</desc>
16979	<attribute name="winId" type="long long">
16980	<desc>
16981	Platform-dependent identifier of the top-level VM console
16982	window, or zero if this method has performed all actions
16983	necessary to implement the <i>show window</i> semantics for
16984	the given platform and/or this VirtualBox front-end.
16985	</desc>
16986	</attribute>
16987	</interface>
16988
16989	<interface
16990	name="INATRedirectEvent" extends="IMachineEvent"
16991	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16992	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16993	>
16994	<desc>
16995	Notification when NAT redirect rule added or removed.
16996	</desc>
16997	<attribute name="slot" type="unsigned long" readonly="yes">
16998	<desc>
16999	Adapter which NAT attached to.
17000	</desc>
17001	</attribute>
17002	<attribute name="remove" type="boolean" readonly="yes">
17003	<desc>
17004	Whether rule remove or add.
17005	</desc>
17006	</attribute>
17007	<attribute name="name" type="wstring" readonly="yes">
17008	<desc>
17009	Name of the rule.
17010	</desc>
17011	</attribute>
17012	<attribute name="proto" type="NATProtocol" readonly="yes">
17013	<desc>
17014	Protocol (TCP or UDP) of the redirect rule.
17015	</desc>
17016	</attribute>
17017	<attribute name="hostIp" type="wstring" readonly="yes">
17018	<desc>
17019	Host ip address to bind socket on.
17020	</desc>
17021	</attribute>
17022	<attribute name="hostPort" type="long" readonly="yes">
17023	<desc>
17024	Host port to bind socket on.
17025	</desc>
17026	</attribute>
17027	<attribute name="guestIp" type="wstring" readonly="yes">
17028	<desc>
17029	Guest ip address to redirect to.
17030	</desc>
17031	</attribute>
17032	<attribute name="guestPort" type="long" readonly="yes">
17033	<desc>
17034	Guest port to redirect to.
17035	</desc>
17036	</attribute>
17037	</interface>
17038
17039	<interface
17040	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17041	waitable="yes"
17042	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17043	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17044	>
17045	<desc>
17046	Notification when host PCI device is plugged/unplugged. Plugging
17047	usually takes place on VM startup, unplug - when
17048	IMachine::DetachHostPciDevice is called.
17049
17050	<see>IMachine::DetachHostPciDevice</see>
17051
17052	</desc>
17053
17054	<attribute name="plugged" type="boolean" readonly="yes">
17055	<desc>
17056	If device successfully plugged or unplugged.
17057	</desc>
17058	</attribute>
17059
17060	<attribute name="success" type="boolean" readonly="yes">
17061	<desc>
17062	If operation was successful, if false - 'message' attribute
17063	may be of interest.
17064	</desc>
17065	</attribute>
17066
17067	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
17068	<desc>
17069	Attachment info for this device.
17070	</desc>
17071	</attribute>
17072
17073	<attribute name="message" type="wstring" readonly="yes">
17074	<desc>
17075	Optional error message.
17076	</desc>
17077	</attribute>
17078
17079	</interface>
17080
17081	<interface
17082	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
17083	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
17084	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
17085	>
17086	<desc>
17087	Notification when VBoxSVC becomes unavailable (due to a crash or similar
17088	unexpected circumstances) or available again.
17089	</desc>
17090
17091	<attribute name="available" type="boolean" readonly="yes">
17092	<desc>
17093	Whether VBoxSVC is available now.
17094	</desc>
17095	</attribute>
17096	</interface>
17097
17098	<interface
17099	name="IBandwidthGroupChangedEvent" extends="IEvent"
17100	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
17101	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
17102	>
17103	<desc>
17104	Notification when one of the bandwidth groups changed
17105	</desc>
17106	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
17107	<desc>
17108	The changed bandwidth group.
17109	</desc>
17110	</attribute>
17111	</interface>
17112
17113	<enum
17114	name="GuestMonitorChangedEventType"
17115	uuid="ef172985-7e36-4297-95be-e46396968d66"
17116	>
17117
17118	<desc>
17119	How the guest monitor has been changed.
17120	</desc>
17121
17122	<const name="Enabled" value="0">
17123	<desc>
17124	The guest monitor has been enabled by the guest.
17125	</desc>
17126	</const>
17127
17128	<const name="Disabled" value="1">
17129	<desc>
17130	The guest monitor has been disabled by the guest.
17131	</desc>
17132	</const>
17133
17134	<const name="NewOrigin" value="2">
17135	<desc>
17136	The guest monitor origin has changed in the guest.
17137	</desc>
17138	</const>
17139	</enum>
17140
17141	<interface
17142	name="IGuestMonitorChangedEvent" extends="IEvent"
17143	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
17144	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
17145	>
17146	<desc>
17147	Notification when the guest enables one of its monitors.
17148	</desc>
17149
17150	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
17151	<desc>
17152	What was changed for this guest monitor.
17153	</desc>
17154	</attribute>
17155
17156	<attribute name="screenId" type="unsigned long" readonly="yes">
17157	<desc>
17158	The monitor which was changed.
17159	</desc>
17160	</attribute>
17161
17162	<attribute name="originX" type="unsigned long" readonly="yes">
17163	<desc>
17164	Physical X origin relative to the primary screen.
17165	Valid for Enabled and NewOrigin.
17166	</desc>
17167	</attribute>
17168
17169	<attribute name="originY" type="unsigned long" readonly="yes">
17170	<desc>
17171	Physical Y origin relative to the primary screen.
17172	Valid for Enabled and NewOrigin.
17173	</desc>
17174	</attribute>
17175
17176	<attribute name="width" type="unsigned long" readonly="yes">
17177	<desc>
17178	Width of the screen.
17179	Valid for Enabled.
17180	</desc>
17181	</attribute>
17182
17183	<attribute name="height" type="unsigned long" readonly="yes">
17184	<desc>
17185	Height of the screen.
17186	Valid for Enabled.
17187	</desc>
17188	</attribute>
17189
17190	</interface>
17191
17192	<interface
17193	name="IStorageDeviceChangedEvent" extends="IEvent"
17194	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
17195	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
17196	>
17197	<desc>
17198	Notification when a
17199	<link to="IMachine::mediumAttachments">storage device</link>
17200	is attached or removed.
17201	</desc>
17202	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
17203	<desc>
17204	Storage device that is subject to change.
17205	</desc>
17206	</attribute>
17207	<attribute name="removed" type="boolean" readonly="yes">
17208	<desc>
17209	Flag whether the device was removed or added to the VM.
17210	</desc>
17211	</attribute>
17212	</interface>
17213
17214	<module name="VBoxSVC" context="LocalServer">
17215	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
17216	namespace="virtualbox.org">
17217	<interface name="IVirtualBox" default="yes"/>
17218	</class>
17219	</module>
17220
17221	<module name="VBoxC" context="InprocServer" threadingModel="Free">
17222	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
17223	namespace="virtualbox.org">
17224	<interface name="IVirtualBoxClient" default="yes"/>
17225	</class>
17226
17227	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
17228	namespace="virtualbox.org">
17229	<interface name="ISession" default="yes"/>
17230	</class>
17231	</module>
17232
17233	</library>
17234
17235	</idl>
17236
17237	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format