VirtualBox.xidl@ 33767

Last change on this file since 33767 was 33767, checked in by vboxsync, 15 years ago
Main: API docs
Property svn:eol-style set to `native`
File size: 570.2 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.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). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum name="SettingsVersion"
388	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
389	>
390	<desc>Settings version of VirtualBox settings files. This is written to
391	the "version" attribute of the root "VirtualBox" element in the settings
392	file XML and indicates which VirtualBox version wrote the file.
393	</desc>
394
395	<const name="Null" value="0">
396	<desc>Null value, indicates invalid version.</desc>
397	</const>
398	<const name="v1_0" value="1">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_1" value="2">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_2" value="3">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3pre" value="4">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_3" value="5">
411	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
412	<!--
413	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
414	-->
415	</const>
416	<const name="v1_4" value="6">
417	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
418	<!--
419	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
420	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
421	-->
422	</const>
423	<const name="v1_5" value="7">
424	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
425	<!-- 2008-09-04: 2.0.0 released
426	2008-11-20: settings version 1.5 introduced
427	2008-12-17: 2.1.0 released
428	Machine changes:
429	guest OS identifiers changed;
430	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
431	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
432	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
433	-->
434	</const>
435	<const name="v1_6" value="8">
436	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
437	<!-- 2008-12-17: 2.1.0 released
438	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
439	2009-04-08: 2.2.0 released
440	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
441	-->
442	</const>
443	<const name="v1_7" value="9">
444	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
445	<!-- 2008-12-17: 2.1.0 released
446	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
447	2009-04-08: 2.2.0 released
448	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
449	Machine changes: HardDiskAttachments is now StorageControllers (done)
450	-->
451	</const>
452	<const name="v1_8" value="10">
453	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
454	<!-- Machine additions: Display/@accelerate2DVideo (done)
455	-->
456	</const>
457	<const name="v1_9" value="11">
458	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
459	<!-- The big storage controller / DVD / Floppy rework (done)
460	-->
461	</const>
462	<const name="v1_10" value="12">
463	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
464	<!-- Machine changes: RTC localOrUTC (done)
465	CPU hot-plug support
466	-->
467	</const>
468	<const name="v1_11" value="13">
469	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
470	<!-- Machine changes: HD Audio controller, per-machine disk registries,
471	/@format attribute for DVD and floppy images.
472	-->
473	</const>
474	<const name="Future" value="99999">
475	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
476	</const>
477	</enum>
478
479	<enum
480	name="AccessMode"
481	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
482	>
483	<desc>
484	Access mode for opening files.
485	</desc>
486
487	<const name="ReadOnly" value="1"/>
488	<const name="ReadWrite" value="2"/>
489	</enum>
490
491	<enum
492	name="MachineState"
493	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
494	>
495	<desc>
496	Virtual machine execution state.
497
498	This enumeration represents possible values of the <link
499	to="IMachine::state"/> attribute.
500
501	Below is the basic virtual machine state diagram. It shows how the state
502	changes during virtual machine execution. The text in square braces shows
503	a method of the IConsole interface that performs the given state
504	transition.
505
506	<pre>
507	+---------[powerDown()] <- Stuck <--[failure]-+
508	V \|
509	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
510	\| \| \| \| V \|
511	\| Aborted -----+ +--> Running --[pause()]--> Paused
512	\| \| ^ \| ^ \|
513	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
514	\| ^ \| \| \| \|
515	\| \| +-----------------------------------------+-\|-------------------+ +
516	\| \| \| \| \|
517	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
518	\| \| \| \|
519	\| +-------- Saving <--------[saveState()]<----------+---------------------+
520	\| \| \|
521	+-------------- Stopping -------[powerDown()]<----------+---------------------+
522	</pre>
523
524	Note that states to the right from PoweredOff, Aborted and Saved in the
525	above diagram are called <i>online VM states</i>. These states
526	represent the virtual machine which is being executed in a dedicated
527	process (usually with a GUI window attached to it where you can see the
528	activity of the virtual machine and interact with it). There are two
529	special pseudo-states, FirstOnline and LastOnline, that can be used in
530	relational expressions to detect if the given machine state is online or
531	not:
532
533	<pre>
534	if (machine.GetState() >= MachineState_FirstOnline &&
535	machine.GetState() <= MachineState_LastOnline)
536	{
537	...the machine is being executed...
538	}
539	</pre>
540
541	When the virtual machine is in one of the online VM states (that is, being
542	executed), only a few machine settings can be modified. Methods working
543	with such settings contain an explicit note about that. An attempt to
544	change any oter setting or perform a modifying operation during this time
545	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
546
547	All online states except Running, Paused and Stuck are transitional: they
548	represent temporary conditions of the virtual machine that will last as
549	long as the operation that initiated such a condition.
550
551	The Stuck state is a special case. It means that execution of the machine
552	has reached the "Guru Meditation" condition. This condition indicates an
553	internal VMM (virtual machine manager) failure which may happen as a
554	result of either an unhandled low-level virtual hardware exception or one
555	of the recompiler exceptions (such as the <i>too-many-traps</i>
556	condition).
557
558	Note also that any online VM state may transit to the Aborted state. This
559	happens if the process that is executing the virtual machine terminates
560	unexpectedly (for example, crashes). Other than that, the Aborted state is
561	equivalent to PoweredOff.
562
563	There are also a few additional state diagrams that do not deal with
564	virtual machine execution and therefore are shown separately. The states
565	shown on these diagrams are called <i>offline VM states</i> (this includes
566	PoweredOff, Aborted and Saved too).
567
568	The first diagram shows what happens when a lengthy setup operation is
569	being executed (such as <link to="IMachine::attachDevice"/>).
570
571	<pre>
572	+----------------------------------(same state as before the call)------+
573	\| \|
574	+-> PoweredOff --+ \|
575	\| \| \|
576	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
577	\| \|
578	+-> Saved -------+
579	</pre>
580
581	The next two diagrams demonstrate the process of taking a snapshot of a
582	powered off virtual machine, restoring the state to that as of a snapshot
583	or deleting a snapshot, respectively.
584
585	<pre>
586	+----------------------------------(same state as before the call)------+
587	\| \|
588	+-> PoweredOff --+ \|
589	\| +-->[takeSnapshot()] -------------------> Saving ------+
590	+-> Aborted -----+
591
592	+-> PoweredOff --+
593	\| \|
594	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
595	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
596	+-> Saved -------+ \|
597	\| \|
598	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
599	</pre>
600
601	Note that the Saving state is present in both the offline state group and
602	online state group. Currently, the only way to determine what group is
603	assumed in a particular case is to remember the previous machine state: if
604	it was Running or Paused, then Saving is an online state, otherwise it is
605	an offline state. This inconsistency may be removed in one of the future
606	versions of VirtualBox by adding a new state.
607
608	<note internal="yes">
609	For whoever decides to touch this enum: In order to keep the
610	comparisons involving FirstOnline and LastOnline pseudo-states valid,
611	the numeric values of these states must be correspondingly updated if
612	needed: for any online VM state, the condition
613	<tt>FirstOnline <= state <= LastOnline</tt> must be
614	@c true. The same relates to transient states for which
615	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
616	@c true.
617	</note>
618	</desc>
619
620	<const name="Null" value="0">
621	<desc>Null value (never used by the API).</desc>
622	</const>
623	<const name="PoweredOff" value="1">
624	<desc>
625	The machine is not running and has no saved execution state; it has
626	either never been started or been shut down successfully.
627	</desc>
628	</const>
629	<const name="Saved" value="2">
630	<desc>
631	The machine is not currently running, but the execution state of the machine
632	has been saved to an external file when it was running, from where
633	it can be resumed.
634	</desc>
635	</const>
636	<const name="Teleported" value="3">
637	<desc>
638	The machine was teleported to a different host (or process) and then
639	powered off. Take care when powering it on again may corrupt resources
640	it shares with the teleportation target (e.g. disk and network).
641	</desc>
642	</const>
643	<const name="Aborted" value="4">
644	<desc>
645	The process running the machine has terminated abnormally. This may
646	indicate a crash of the VM process in host execution context, or
647	the VM process has been terminated externally.
648	</desc>
649	</const>
650	<const name="Running" value="5">
651	<desc>
652	The machine is currently being executed.
653	<note internal="yes">
654	For whoever decides to touch this enum: In order to keep the
655	comparisons in the old source code valid, this state must immediately
656	precede the Paused state.
657	TODO: Lift this spectacularly wonderful restriction.
658	</note>
659	</desc>
660	</const>
661	<const name="Paused" value="6">
662	<desc>
663	Execution of the machine has been paused.
664	<note internal="yes">
665	For whoever decides to touch this enum: In order to keep the
666	comparisons in the old source code valid, this state must immediately
667	follow the Running state.
668	TODO: Lift this spectacularly wonderful restriction.
669	</note>
670	</desc>
671	</const>
672	<const name="Stuck" value="7">
673	<desc>
674	Execution of the machine has reached the "Guru Meditation"
675	condition. This indicates a severe error in the hypervisor itself.
676	<note internal="yes">
677	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
678	"Guru", perhaps? Or are there some other VMM states that are
679	intended to be lumped in here as well?
680	</note>
681	</desc>
682	</const>
683	<const name="Teleporting" value="8">
684	<desc>
685	The machine is about to be teleported to a different host or process.
686	It is possible to pause a machine in this state, but it will go to the
687	@c TeleportingPausedVM state and it will not be
688	possible to resume it again unless the teleportation fails.
689	</desc>
690	</const>
691	<const name="LiveSnapshotting" value="9">
692	<desc>
693	A live snapshot is being taken. The machine is running normally, but
694	some of the runtime configuration options are inaccessible. Also, if
695	paused while in this state it will transition to
696	@c Saving and it will not be resume the
697	execution until the snapshot operation has completed.
698	</desc>
699	</const>
700	<const name="Starting" value="10">
701	<desc>
702	Machine is being started after powering it on from a
703	zero execution state.
704	</desc>
705	</const>
706	<const name="Stopping" value="11">
707	<desc>
708	Machine is being normally stopped powering it off, or after the guest OS
709	has initiated a shutdown sequence.
710	</desc>
711	</const>
712	<const name="Saving" value="12">
713	<desc>
714	Machine is saving its execution state to a file, or an online
715	snapshot of the machine is being taken.
716	</desc>
717	</const>
718	<const name="Restoring" value="13">
719	<desc>
720	Execution state of the machine is being restored from a file
721	after powering it on from the saved execution state.
722	</desc>
723	</const>
724	<const name="TeleportingPausedVM" value="14">
725	<desc>
726	The machine is being teleported to another host or process, but it is
727	not running. This is the paused variant of the
728	@c state.
729	</desc>
730	</const>
731	<const name="TeleportingIn" value="15">
732	<desc>
733	Teleporting the machine state in from another host or process.
734	</desc>
735	</const>
736	<const name="FaultTolerantSyncing" value="16">
737	<desc>
738	The machine is being synced with a fault tolerant VM running elsewhere.
739	</desc>
740	</const>
741	<const name="DeletingSnapshotOnline" value="17">
742	<desc>
743	Like @c DeletingSnapshot, but the merging of media is ongoing in
744	the background while the machine is running.
745	</desc>
746	</const>
747	<const name="DeletingSnapshotPaused" value="18">
748	<desc>
749	Like @c DeletingSnapshotOnline, but the machine was paused when the
750	merging of differencing media was started.
751	</desc>
752	</const>
753	<const name="RestoringSnapshot" value="19">
754	<desc>
755	A machine snapshot is being restored; this typically does not take long.
756	</desc>
757	</const>
758	<const name="DeletingSnapshot" value="20">
759	<desc>
760	A machine snapshot is being deleted; this can take a long time since this
761	may require merging differencing media. This value indicates that the
762	machine is not running while the snapshot is being deleted.
763	</desc>
764	</const>
765	<const name="SettingUp" value="21">
766	<desc>
767	Lengthy setup operation is in progress.
768	</desc>
769	</const>
770
771	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
772	<desc>
773	Pseudo-state: first online state (for use in relational expressions).
774	</desc>
775	</const>
776	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
777	<desc>
778	Pseudo-state: last online state (for use in relational expressions).
779	</desc>
780	</const>
781
782	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
783	<desc>
784	Pseudo-state: first transient state (for use in relational expressions).
785	</desc>
786	</const>
787	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
788	<desc>
789	Pseudo-state: last transient state (for use in relational expressions).
790	</desc>
791	</const>
792
793	</enum>
794
795	<enum
796	name="SessionState"
797	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
798	>
799	<desc>
800	Session state. This enumeration represents possible values of
801	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
802	attributes.
803	</desc>
804
805	<const name="Null" value="0">
806	<desc>Null value (never used by the API).</desc>
807	</const>
808	<const name="Unlocked" value="1">
809	<desc>
810	In <link to="IMachine::sessionState"/>, this means that the machine
811	is not locked for any sessions.
812
813	In <link to="ISession::state"/>, this means that no machine is
814	currently locked for this session.
815	</desc>
816	</const>
817	<const name="Locked" value="2">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is currently locked for a session, whose process identifier can
821	then be found in the <link to="IMachine::sessionPid" /> attribute.
822
823	In <link to="ISession::state"/>, this means that a machine is
824	currently locked for this session, and the mutable machine object
825	can be found in the <link to="ISession::machine"/> attribute
826	(see <link to="IMachine::lockMachine" /> for details).
827	</desc>
828	</const>
829	<const name="Spawning" value="3">
830	<desc>
831	A new process is being spawned for the machine as a result of
832	<link to="IMachine::launchVMProcess"/> call. This state also occurs
833	as a short transient state during an <link to="IMachine::lockMachine"/>
834	call.
835	</desc>
836	</const>
837	<const name="Unlocking" value="4">
838	<desc>
839	The session is being unlocked.
840	</desc>
841	</const>
842	</enum>
843
844	<enum
845	name="CPUPropertyType"
846	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
847	>
848	<desc>
849	Virtual CPU property type. This enumeration represents possible values of the
850	IMachine get- and setCPUProperty methods.
851	</desc>
852	<const name="Null" value="0">
853	<desc>Null value (never used by the API).</desc>
854	</const>
855	<const name="PAE" value="1">
856	<desc>
857	This setting determines whether VirtualBox will expose the Physical Address
858	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
859	is not available, it will not be reported.
860	</desc>
861	</const>
862	<const name="Synthetic" value="2">
863	<desc>
864	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
865	teleporting between host systems that differ significantly.
866	</desc>
867	</const>
868	</enum>
869
870
871	<enum
872	name="HWVirtExPropertyType"
873	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
874	>
875	<desc>
876	Hardware virtualization property type. This enumeration represents possible values
877	for the <link to="IMachine::getHWVirtExProperty"/> and
878	<link to="IMachine::setHWVirtExProperty"/> methods.
879	</desc>
880	<const name="Null" value="0">
881	<desc>Null value (never used by the API).</desc>
882	</const>
883	<const name="Enabled" value="1">
884	<desc>
885	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
886	such extensions are not available, they will not be used.
887	</desc>
888	</const>
889	<const name="Exclusive" value="2">
890	<desc>
891	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
892	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
893	feature of the host. To share these with other hypervisors, you must disable this property.
894	</desc>
895	</const>
896	<const name="VPID" value="3">
897	<desc>
898	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
899	</desc>
900	</const>
901	<const name="NestedPaging" value="4">
902	<desc>
903	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
904	</desc>
905	</const>
906	<const name="LargePages" value="5">
907	<desc>
908	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
909	</desc>
910	</const>
911	<const name="Force" value="6">
912	<desc>
913	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
914	not set, there will be an automatic fallback to software virtualization.
915	</desc>
916	</const>
917	</enum>
918
919	<enum
920	name="FaultToleranceState"
921	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
922	>
923	<desc>
924	Used with <link to="IMachine::faultToleranceState" />.
925	</desc>
926	<const name="Inactive" value="1">
927	<desc>No fault tolerance enabled.</desc>
928	</const>
929	<const name="Master" value="2">
930	<desc>Fault tolerant master VM.</desc>
931	</const>
932	<const name="Standby" value="3">
933	<desc>Fault tolerant standby VM.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="LockType"
939	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
940	>
941	<desc>
942	Used with <link to="IMachine::lockMachine" />.
943	</desc>
944	<const name="Write" value="2">
945	<desc>Lock the machine for writing.</desc>
946	</const>
947	<const name="Shared" value="1">
948	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
949	</const>
950	</enum>
951
952	<enum
953	name="SessionType"
954	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
955	>
956	<desc>
957	Session type. This enumeration represents possible values of the
958	<link to="ISession::type"/> attribute.
959	</desc>
960
961	<const name="Null" value="0">
962	<desc>Null value (never used by the API).</desc>
963	</const>
964	<const name="WriteLock" value="1">
965	<desc>
966	Session has acquired an exclusive write lock on a machine
967	using <link to="IMachine::lockMachine"/>.
968	</desc>
969	</const>
970	<const name="Remote" value="2">
971	<desc>
972	Session has launched a VM process using
973	<link to="IMachine::launchVMProcess"/>
974	</desc>
975	</const>
976	<const name="Shared" value="3">
977	<desc>
978	Session has obtained a link to another session using
979	<link to="IMachine::lockMachine"/>
980	</desc>
981	</const>
982	</enum>
983
984	<enum
985	name="DeviceType"
986	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
987	>
988	<desc>
989	Device type.
990	</desc>
991	<const name="Null" value="0">
992	<desc>
993	Null value, may also mean "no device" (not allowed for
994	<link to="IConsole::getDeviceActivity"/>).
995	</desc>
996	</const>
997	<const name="Floppy" value="1">
998	<desc>Floppy device.</desc>
999	</const>
1000	<const name="DVD" value="2">
1001	<desc>CD/DVD-ROM device.</desc>
1002	</const>
1003	<const name="HardDisk" value="3">
1004	<desc>Hard disk device.</desc>
1005	</const>
1006	<const name="Network" value="4">
1007	<desc>Network device.</desc>
1008	</const>
1009	<const name="USB" value="5">
1010	<desc>USB device.</desc>
1011	</const>
1012	<const name="SharedFolder" value="6">
1013	<desc>Shared folder device.</desc>
1014	</const>
1015	</enum>
1016
1017	<enum
1018	name="DeviceActivity"
1019	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1020	>
1021	<desc>
1022	Device activity for <link to="IConsole::getDeviceActivity"/>.
1023	</desc>
1024
1025	<const name="Null" value="0"/>
1026	<const name="Idle" value="1"/>
1027	<const name="Reading" value="2"/>
1028	<const name="Writing" value="3"/>
1029	</enum>
1030
1031	<enum
1032	name="ClipboardMode"
1033	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1034	>
1035	<desc>
1036	Host-Guest clipboard interchange mode.
1037	</desc>
1038
1039	<const name="Disabled" value="0"/>
1040	<const name="HostToGuest" value="1"/>
1041	<const name="GuestToHost" value="2"/>
1042	<const name="Bidirectional" value="3"/>
1043	</enum>
1044
1045	<enum
1046	name="Scope"
1047	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1048	>
1049	<desc>
1050	Scope of the operation.
1051
1052	A generic enumeration used in various methods to define the action or
1053	argument scope.
1054	</desc>
1055
1056	<const name="Global" value="0"/>
1057	<const name="Machine" value="1"/>
1058	<const name="Session" value="2"/>
1059	</enum>
1060
1061	<enum
1062	name="BIOSBootMenuMode"
1063	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1064	>
1065	<desc>
1066	BIOS boot menu mode.
1067	</desc>
1068
1069	<const name="Disabled" value="0"/>
1070	<const name="MenuOnly" value="1"/>
1071	<const name="MessageAndMenu" value="2"/>
1072	</enum>
1073
1074	<enum
1075	name="ProcessorFeature"
1076	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1077	>
1078	<desc>
1079	CPU features.
1080	</desc>
1081
1082	<const name="HWVirtEx" value="0"/>
1083	<const name="PAE" value="1"/>
1084	<const name="LongMode" value="2"/>
1085	<const name="NestedPaging" value="3"/>
1086	</enum>
1087
1088	<enum
1089	name="FirmwareType"
1090	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1091	>
1092	<desc>
1093	Firmware type.
1094	</desc>
1095	<const name="BIOS" value="1">
1096	<desc>BIOS Firmware.</desc>
1097	</const>
1098	<const name="EFI" value="2">
1099	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1100	</const>
1101	<const name="EFI32" value="3">
1102	<desc>Efi firmware, 32-bit.</desc>
1103	</const>
1104	<const name="EFI64" value="4">
1105	<desc>Efi firmware, 64-bit.</desc>
1106	</const>
1107	<const name="EFIDUAL" value="5">
1108	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1109	</const>
1110	</enum>
1111
1112	<enum
1113	name="PointingHidType"
1114	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1115	>
1116	<desc>
1117	Type of pointing device used in a virtual machine.
1118	</desc>
1119	<const name="None" value="1">
1120	<desc>No mouse.</desc>
1121	</const>
1122	<const name="PS2Mouse" value="2">
1123	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1124	</const>
1125	<const name="USBMouse" value="3">
1126	<desc>USB mouse (relative pointer).</desc>
1127	</const>
1128	<const name="USBTablet" value="4">
1129	<desc>USB tablet (absolute pointer).</desc>
1130	</const>
1131	<const name="ComboMouse" value="5">
1132	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1133	Using of such device can have negative performance implications. </desc>
1134	</const>
1135	</enum>
1136
1137	<enum
1138	name="KeyboardHidType"
1139	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1140	>
1141	<desc>
1142	Type of keyboard device used in a virtual machine.
1143	</desc>
1144	<const name="None" value="1">
1145	<desc>No keyboard.</desc>
1146	</const>
1147	<const name="PS2Keyboard" value="2">
1148	<desc>PS/2 keyboard.</desc>
1149	</const>
1150	<const name="USBKeyboard" value="3">
1151	<desc>USB keyboard.</desc>
1152	</const>
1153	<const name="ComboKeyboard" value="4">
1154	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1155	Using of such device can have negative performance implications. </desc>
1156	</const>
1157	</enum>
1158
1159	<!--
1160	// IVirtualBoxErrorInfo
1161	/////////////////////////////////////////////////////////////////////////
1162	-->
1163
1164	<interface
1165	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1166	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1167	supportsErrorInfo="no"
1168	wsmap="managed"
1169	>
1170	<desc>
1171	The IVirtualBoxErrorInfo interface represents extended error information.
1172
1173	Extended error information can be set by VirtualBox components after
1174	unsuccessful or partially successful method invocation. This information
1175	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1176	and then shown to the client in addition to the plain 32-bit result code.
1177
1178	In MS COM, this interface extends the IErrorInfo interface,
1179	in XPCOM, it extends the nsIException interface. In both cases,
1180	it provides a set of common attributes to retrieve error
1181	information.
1182
1183	Sometimes invocation of some component's method may involve methods of
1184	other components that may also fail (independently of this method's
1185	failure), or a series of non-fatal errors may precede a fatal error that
1186	causes method failure. In cases like that, it may be desirable to preserve
1187	information about all errors happened during method invocation and deliver
1188	it to the caller. The <link to="#next"/> attribute is intended
1189	specifically for this purpose and allows to represent a chain of errors
1190	through a single IVirtualBoxErrorInfo object set after method invocation.
1191
1192	Note that errors are stored to a chain in the reverse order, i.e. the
1193	initial error object you query right after method invocation is the last
1194	error set by the callee, the object it points to in the @a next attribute
1195	is the previous error and so on, up to the first error (which is the last
1196	in the chain).
1197	</desc>
1198
1199	<attribute name="resultCode" type="long" readonly="yes">
1200	<desc>
1201	Result code of the error.
1202	Usually, it will be the same as the result code returned
1203	by the method that provided this error information, but not
1204	always. For example, on Win32, CoCreateInstance() will most
1205	likely return E_NOINTERFACE upon unsuccessful component
1206	instantiation attempt, but not the value the component factory
1207	returned. Value is typed 'long', not 'result',
1208	to make interface usable from scripting languages.
1209	<note>
1210	In MS COM, there is no equivalent.
1211	In XPCOM, it is the same as nsIException::result.
1212	</note>
1213	</desc>
1214	</attribute>
1215
1216	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1217	<desc>
1218	UUID of the interface that defined the error.
1219	<note>
1220	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1221	data type.
1222	In XPCOM, there is no equivalent.
1223	</note>
1224	</desc>
1225	</attribute>
1226
1227	<attribute name="component" type="wstring" readonly="yes">
1228	<desc>
1229	Name of the component that generated the error.
1230	<note>
1231	In MS COM, it is the same as IErrorInfo::GetSource.
1232	In XPCOM, there is no equivalent.
1233	</note>
1234	</desc>
1235	</attribute>
1236
1237	<attribute name="text" type="wstring" readonly="yes">
1238	<desc>
1239	Text description of the error.
1240	<note>
1241	In MS COM, it is the same as IErrorInfo::GetDescription.
1242	In XPCOM, it is the same as nsIException::message.
1243	</note>
1244	</desc>
1245	</attribute>
1246
1247	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1248	<desc>
1249	Next error object if there is any, or @c null otherwise.
1250	<note>
1251	In MS COM, there is no equivalent.
1252	In XPCOM, it is the same as nsIException::inner.
1253	</note>
1254	</desc>
1255	</attribute>
1256
1257	</interface>
1258
1259	<!--
1260	// IVirtualBox
1261	/////////////////////////////////////////////////////////////////////////
1262	-->
1263
1264	<interface
1265	name="IDHCPServer" extends="$unknown"
1266	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1267	wsmap="managed"
1268	>
1269	<desc>
1270	The IDHCPServer interface represents the vbox dhcp server configuration.
1271
1272	To enumerate all the dhcp servers on the host, use the
1273	<link to="IVirtualBox::DHCPServers"/> attribute.
1274	</desc>
1275
1276	<attribute name="enabled" type="boolean">
1277	<desc>
1278	specifies if the dhcp server is enabled
1279	</desc>
1280	</attribute>
1281
1282	<attribute name="IPAddress" type="wstring" readonly="yes">
1283	<desc>
1284	specifies server IP
1285	</desc>
1286	</attribute>
1287
1288	<attribute name="networkMask" type="wstring" readonly="yes">
1289	<desc>
1290	specifies server network mask
1291	</desc>
1292	</attribute>
1293
1294	<attribute name="networkName" type="wstring" readonly="yes">
1295	<desc>
1296	specifies internal network name the server is used for
1297	</desc>
1298	</attribute>
1299
1300	<attribute name="lowerIP" type="wstring" readonly="yes">
1301	<desc>
1302	specifies from IP address in server address range
1303	</desc>
1304	</attribute>
1305
1306	<attribute name="upperIP" type="wstring" readonly="yes">
1307	<desc>
1308	specifies to IP address in server address range
1309	</desc>
1310	</attribute>
1311
1312	<method name="setConfiguration">
1313	<desc>
1314	configures the server
1315	<result name="E_INVALIDARG">
1316	invalid configuration supplied
1317	</result>
1318	</desc>
1319	<param name="IPAddress" type="wstring" dir="in">
1320	<desc>
1321	server IP address
1322	</desc>
1323	</param>
1324	<param name="networkMask" type="wstring" dir="in">
1325	<desc>
1326	server network mask
1327	</desc>
1328	</param>
1329	<param name="FromIPAddress" type="wstring" dir="in">
1330	<desc>
1331	server From IP address for address range
1332	</desc>
1333	</param>
1334	<param name="ToIPAddress" type="wstring" dir="in">
1335	<desc>
1336	server To IP address for address range
1337	</desc>
1338	</param>
1339	</method>
1340
1341	<method name="start">
1342	<desc>
1343	Starts DHCP server process.
1344	<result name="E_FAIL">
1345	Failed to start the process.
1346	</result>
1347	</desc>
1348	<param name="networkName" type="wstring" dir="in">
1349	<desc>
1350	Name of internal network DHCP server should attach to.
1351	</desc>
1352	</param>
1353	<param name="trunkName" type="wstring" dir="in">
1354	<desc>
1355	Name of internal network trunk.
1356	</desc>
1357	</param>
1358	<param name="trunkType" type="wstring" dir="in">
1359	<desc>
1360	Type of internal network trunk.
1361	</desc>
1362	</param>
1363	</method>
1364
1365	<method name="stop">
1366	<desc>
1367	Stops DHCP server process.
1368	<result name="E_FAIL">
1369	Failed to stop the process.
1370	</result>
1371	</desc>
1372	</method>
1373	</interface>
1374
1375	<interface
1376	name="IVirtualBox" extends="$unknown"
1377	uuid="e03d6527-9b72-43b5-b87f-88f1033d3866"
1378	wsmap="managed"
1379	>
1380	<desc>
1381	The IVirtualBox interface represents the main interface exposed by the
1382	product that provides virtual machine management.
1383
1384	An instance of IVirtualBox is required for the product to do anything
1385	useful. Even though the interface does not expose this, internally,
1386	IVirtualBox is implemented as a singleton and actually lives in the
1387	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1388	IVirtualBox can track the state of all virtual machines on a particular
1389	host, regardless of which frontend started them.
1390
1391	To enumerate all the virtual machines on the host, use the
1392	<link to="IVirtualBox::machines"/> attribute.
1393	</desc>
1394
1395	<attribute name="version" type="wstring" readonly="yes">
1396	<desc>
1397	A string representing the version number of the product. The
1398	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1399	last number represents the build number and will frequently change.
1400	</desc>
1401	</attribute>
1402
1403	<attribute name="revision" type="unsigned long" readonly="yes">
1404	<desc>
1405	The internal build revision number of the product.
1406	</desc>
1407	</attribute>
1408
1409	<attribute name="packageType" type="wstring" readonly="yes">
1410	<desc>
1411	A string representing the package type of this product. The
1412	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1413	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1414	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1415	this.
1416	</desc>
1417	</attribute>
1418
1419	<attribute name="homeFolder" type="wstring" readonly="yes">
1420	<desc>
1421	Full path to the directory where the global settings file,
1422	<tt>VirtualBox.xml</tt>, is stored.
1423
1424	In this version of VirtualBox, the value of this property is
1425	always <tt><user_dir>/.VirtualBox</tt> (where
1426	<tt><user_dir></tt> is the path to the user directory,
1427	as determined by the host OS), and cannot be changed.
1428
1429	This path is also used as the base to resolve relative paths in
1430	places where relative paths are allowed (unless otherwise
1431	expressly indicated).
1432	</desc>
1433	</attribute>
1434
1435	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1436	<desc>
1437	Full name of the global settings file.
1438	The value of this property corresponds to the value of
1439	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1440	</desc>
1441	</attribute>
1442
1443	<attribute name="host" type="IHost" readonly="yes">
1444	<desc>Associated host object.</desc>
1445	</attribute>
1446
1447	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1448	<desc>Associated system information object.</desc>
1449	</attribute>
1450
1451	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1452	<desc>
1453	Array of machine objects registered within this VirtualBox instance.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1458	<desc>
1459	Array of medium objects known to this VirtualBox installation.
1460
1461	This array contains only base media. All differencing
1462	media of the given base medium can be enumerated using
1463	<link to="IMedium::children"/>.
1464	</desc>
1465	</attribute>
1466
1467	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1468	<desc>
1469	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1474	<desc>
1475	Array of floppy image objects currently in use by this VirtualBox instance.
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1480
1481	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1482
1483	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1484	<desc>
1485	Collection of global shared folders. Global shared folders are
1486	available to all virtual machines.
1487
1488	New shared folders are added to the collection using
1489	<link to="#createSharedFolder"/>. Existing shared folders can be
1490	removed using <link to="#removeSharedFolder"/>.
1491
1492	<note>
1493	In the current version of the product, global shared folders are not
1494	implemented and therefore this collection is always empty.
1495	</note>
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1500	<desc>
1501	Associated performance collector object.
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1506	<desc>
1507	DHCP servers.
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="eventSource" type="IEventSource" readonly="yes">
1512	<desc>
1513	Event source for VirtualBox events.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1518	<desc>
1519	The extension pack manager.
1520	</desc>
1521	</attribute>
1522
1523
1524	<method name="composeMachineFilename">
1525	<desc>
1526	Returns a recommended full path of the settings file name for a new virtual
1527	machine.
1528
1529	This API serves two purposes:
1530
1531	<ul>
1532	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1533	for the @a settingsFile argument there, which means that API should use
1534	a recommended default file name.</li>
1535
1536	<li>It can be called manually by a client software before creating a machine,
1537	e.g. if that client wants to pre-create the machine directory to create
1538	virtual hard disks in that directory together with the new machine
1539	settings file. In that case, the file name should be stripped from the
1540	full settings file path returned by this function to obtain the
1541	machine directory.</li>
1542	</ul>
1543
1544	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1545	details about the machine name.
1546
1547	If @a baseFolder is a @c null or empty string (which is recommended), the
1548	default machine settings folder
1549	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1550	a base folder for the created machine, resulting in a file name like
1551	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1552	will be used.
1553
1554	This method does not access the host disks. In particular, it does not check
1555	for whether a machine of this name already exists.
1556	</desc>
1557	<param name="name" type="wstring" dir="in">
1558	<desc>Suggested machine name.</desc>
1559	</param>
1560	<param name="baseFolder" type="wstring" dir="in">
1561	<desc>Base machine folder (optional).</desc>
1562	</param>
1563	<param name="file" type="wstring" dir="return">
1564	<desc>Fully qualified path where the machine would be created.</desc>
1565	</param>
1566	</method>
1567
1568	<method name="createMachine">
1569	<desc>
1570	Creates a new virtual machine by creating a machine settings file at
1571	the given location.
1572
1573	VirtualBox machine settings files use a custom XML dialect. Starting
1574	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1575	and machine files can be created at arbitrary locations.
1576
1577	However, it is is recommended that machines be created in the default
1578	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1579	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1580	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1581	is called automatically to have such a recommended name composed based
1582	on the machine name given in the @a name argument.
1583
1584	If the resulting settings file already exists, this method will fail,
1585	unless @a forceOverwrite is set.
1586
1587	The new machine is created unregistered, with the initial configuration
1588	set according to the specified guest OS type. A typical sequence of
1589	actions to create a new virtual machine is as follows:
1590
1591	<ol>
1592	<li>
1593	Call this method to have a new machine created. The returned machine
1594	object will be "mutable" allowing to change any machine property.
1595	</li>
1596
1597	<li>
1598	Configure the machine using the appropriate attributes and methods.
1599	</li>
1600
1601	<li>
1602	Call <link to="IMachine::saveSettings" /> to write the settings
1603	to the machine's XML settings file. The configuration of the newly
1604	created machine will not be saved to disk until this method is
1605	called.
1606	</li>
1607
1608	<li>
1609	Call <link to="#registerMachine" /> to add the machine to the list
1610	of machines known to VirtualBox.
1611	</li>
1612	</ol>
1613
1614	The specified guest OS type identifier must match an ID of one of known
1615	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1616	array.
1617
1618	Optionally, you may specify an UUID of to assign to the created machine.
1619	However, this is not recommended and you should normally pass an empty
1620	(@c null) UUID to this method so that a new UUID will be automatically
1621	generated for every created machine. You can use UUID
1622	00000000-0000-0000-0000-000000000000 as @c null value.
1623
1624	<note>
1625	There is no way to change the name of the settings file or
1626	subfolder of the created machine directly.
1627	</note>
1628
1629	<result name="VBOX_E_OBJECT_NOT_FOUND">
1630	@a osTypeId is invalid.
1631	</result>
1632	<result name="VBOX_E_FILE_ERROR">
1633	Resulting settings file name is invalid or the settings file already
1634	exists or could not be created due to an I/O error.
1635	</result>
1636	<result name="E_INVALIDARG">
1637	@a name is empty or @c null.
1638	</result>
1639	</desc>
1640
1641	<param name="settingsFile" type="wstring" dir="in">
1642	<desc>Fully qualified path where the settings file should be created,
1643	or NULL for a default folder and file based on the @a name argument
1644	(see <link to="#composeMachineFilename" />).</desc>
1645	</param>
1646	<param name="name" type="wstring" dir="in">
1647	<desc>Machine name.</desc>
1648	</param>
1649	<param name="osTypeId" type="wstring" dir="in">
1650	<desc>Guest OS Type ID.</desc>
1651	</param>
1652	<param name="id" type="uuid" mod="string" dir="in">
1653	<desc>Machine UUID (optional).</desc>
1654	</param>
1655	<param name="forceOverwrite" type="boolean" dir="in">
1656	<desc>If true, an existing machine settings file will be overwritten.</desc>
1657	</param>
1658	<param name="machine" type="IMachine" dir="return">
1659	<desc>Created machine object.</desc>
1660	</param>
1661	</method>
1662
1663	<method name="openMachine">
1664	<desc>
1665	Opens a virtual machine from the existing settings file.
1666	The opened machine remains unregistered until you call
1667	<link to="#registerMachine"/>.
1668
1669	The specified settings file name can be absolute
1670	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1671	VirtualBox home directory</link>. This file must exist
1672	and must be a valid machine settings file whose contents
1673	will be used to construct the machine object.
1674
1675	<result name="VBOX_E_FILE_ERROR">
1676	Settings file name invalid, not found or sharing violation.
1677	</result>
1678	</desc>
1679	<param name="settingsFile" type="wstring" dir="in">
1680	<desc>
1681	Name of the machine settings file.
1682	</desc>
1683	</param>
1684	<param name="machine" type="IMachine" dir="return">
1685	<desc>Opened machine object.</desc>
1686	</param>
1687	<note>
1688	<link to="IMachine::settingsModified"/> will return
1689	@c false for the created machine, until any of machine settings
1690	are changed.
1691	</note>
1692	</method>
1693
1694	<method name="registerMachine">
1695	<desc>
1696
1697	Registers the machine previously created using
1698	<link to="#createMachine"/> or opened using
1699	<link to="#openMachine"/> within this VirtualBox installation. After
1700	successful method invocation, the
1701	<link to="IMachineRegisteredEvent"/> event is fired.
1702
1703	<note>
1704	This method implicitly calls <link to="IMachine::saveSettings"/>
1705	to save all current machine settings before registering it.
1706	</note>
1707
1708	<result name="VBOX_E_OBJECT_NOT_FOUND">
1709	No matching virtual machine found.
1710	</result>
1711	<result name="VBOX_E_INVALID_OBJECT_STATE">
1712	Virtual machine was not created within this VirtualBox instance.
1713	</result>
1714
1715	</desc>
1716	<param name="machine" type="IMachine" dir="in"/>
1717	</method>
1718
1719	<method name="findMachine">
1720	<desc>
1721	Attempts to find a virtual machine given its name or UUID.
1722
1723	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1724	cannot safely be determined.</note>
1725
1726	<result name="VBOX_E_OBJECT_NOT_FOUND">
1727	Could not find registered machine matching @a nameOrId.
1728	</result>
1729
1730	</desc>
1731	<param name="nameOrId" type="wstring" dir="in">
1732	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Machine object, if found.</desc>
1736	</param>
1737	</method>
1738
1739	<method name="createAppliance">
1740	<desc>
1741	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1742	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1743	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1744	</desc>
1745	<param name="appliance" type="IAppliance" dir="return">
1746	<desc>New appliance.</desc>
1747	</param>
1748	</method>
1749
1750	<method name="createHardDisk">
1751	<desc>
1752	Creates a new base medium object that will use the given storage
1753	format and location for medium data.
1754
1755	Note that the actual storage unit is not created by this method. In
1756	order to do it, and before you are able to attach the created medium
1757	to virtual machines, you must call one of the following methods to
1758	allocate a format-specific storage unit at the specified location:
1759	<ul>
1760	<li><link to="IMedium::createBaseStorage"/></li>
1761	<li><link to="IMedium::createDiffStorage"/></li>
1762	</ul>
1763
1764	Some medium attributes, such as <link to="IMedium::id"/>, may
1765	remain uninitialized until the medium storage unit is successfully
1766	created by one of the above methods.
1767
1768	After the storage unit is successfully created, it will be
1769	accessible through the <link to="#findMedium"/> method and can
1770	be found in the <link to="#hardDisks"/> array.
1771
1772	The list of all storage formats supported by this VirtualBox
1773	installation can be obtained using
1774	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1775	attribute is empty or @c null then the default storage format
1776	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1777	be used for creating a storage unit of the medium.
1778
1779	Note that the format of the location string is storage format specific.
1780	See <link to="IMedium::location"/> and IMedium for more details.
1781
1782	<result name="VBOX_E_OBJECT_NOT_FOUND">
1783	@a format identifier is invalid. See
1784	<link to="ISystemProperties::mediumFormats"/>.
1785	</result>
1786	<result name="VBOX_E_FILE_ERROR">
1787	@a location is a not valid file name (for file-based formats only).
1788	</result>
1789	</desc>
1790	<param name="format" type="wstring" dir="in">
1791	<desc>
1792	Identifier of the storage format to use for the new medium.
1793	</desc>
1794	</param>
1795	<param name="location" type="wstring" dir="in">
1796	<desc>
1797	Location of the storage unit for the new medium.
1798	</desc>
1799	</param>
1800	<param name="medium" type="IMedium" dir="return">
1801	<desc>Created medium object.</desc>
1802	</param>
1803	</method>
1804
1805	<method name="openMedium">
1806	<desc>
1807	Opens a medium from an existing storage location.
1808
1809	Once a medium has been opened, it can be passed to other VirtualBox
1810	methods, in particular to <link to="IMachine::attachDevice" />.
1811
1812	Depending on the given device type, the file at the storage location
1813	must be in one of the media formats understood by VirtualBox:
1814
1815	<ul>
1816	<li>With a "HardDisk" device type, the file must be a hard disk image
1817	in one of the formats supported by VirtualBox (see
1818	<link to="ISystemProperties::mediumFormats" />).
1819	After this method succeeds, if the medium is a base medium, it
1820	will be added to the <link to="#hardDisks"/> array attribute. </li>
1821	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1822	After this method succeeds, the medium will be added to the
1823	<link to="#DVDImages"/> array attribute.</li>
1824	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1825	After this method succeeds, the medium will be added to the
1826	<link to="#floppyImages"/> array attribute.</li>
1827	</ul>
1828
1829	After having been opened, the medium can be found by the <link to="#findMedium"/>
1830	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1831
1832	The UUID of the newly opened medium will either be retrieved from the
1833	storage location, if the format supports it (e.g. for hard disk images),
1834	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1835	If for some reason you need to change the medium's UUID, use
1836	<link to="IMedium::setIDs" />.
1837
1838	If a differencing hard disk medium is to be opened by this method, the
1839	operation will succeed only if its parent medium and all ancestors,
1840	if any, are already known to this VirtualBox installation (for example,
1841	were opened by this method before).
1842
1843	This method attempts to guess the storage format of the specified medium
1844	by reading medium data at the specified location.
1845
1846	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1847	the image is opened for read/write access and must have according permissions,
1848	as VirtualBox may actually write status information into the disk's metadata
1849	sections.
1850
1851	Note that write access is required for all typical hard disk usage in VirtualBox,
1852	since VirtualBox may need to write metadata such as a UUID into the image.
1853	The only exception is opening a source image temporarily for copying and
1854	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1855	again soon.
1856
1857	The format of the location string is storage format specific. See
1858	<link to="IMedium::location"/> and IMedium for more details.
1859
1860	Prior to VirtualBox 4.0, opening a medium added it to a global media
1861	registry in the VirtualBox.xml file, which was shared between all machines
1862	and made transporting machines and their media from one host to another
1863	difficult.
1864
1865	Starting with VirtualBox 4.0, media are only added to a registry when
1866	they are attached to a machine. Machines created with VirtualBox 4.0
1867	or later can have their own media registry. As a result, a medium attached
1868	to such a machine will be remembered in that machine's XML settings file.
1869	Media attached to older machines will continue to be added to the global
1870	registry.
1871
1872	<result name="VBOX_E_FILE_ERROR">
1873	Invalid medium storage file location or could not find the medium
1874	at the specified location.
1875	</result>
1876	<result name="VBOX_E_IPRT_ERROR">
1877	Could not get medium storage format.
1878	</result>
1879	<result name="E_INVALIDARG">
1880	Invalid medium storage format.
1881	</result>
1882	<result name="VBOX_E_INVALID_OBJECT_STATE">
1883	Medium has already been added to a media registry.
1884	</result>
1885	</desc>
1886	<param name="location" type="wstring" dir="in">
1887	<desc>
1888	Location of the storage unit that contains medium data in one of
1889	the supported storage formats.
1890	</desc>
1891	</param>
1892	<param name="deviceType" type="DeviceType" dir="in">
1893	<desc>
1894	Must be one of "HardDisk", "DVD" or "Floppy".
1895	</desc>
1896	</param>
1897	<param name="accessMode" type="AccessMode" dir="in">
1898	<desc>Whether to open the image in read/write or read-only mode. For
1899	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1900	</param>
1901	<param name="medium" type="IMedium" dir="return">
1902	<desc>Opened medium object.</desc>
1903	</param>
1904	</method>
1905
1906	<method name="findMedium">
1907	<desc>
1908	Returns a medium of the given type that uses the given fully qualified
1909	location or UUID to store medium data.
1910
1911	The given medium must be known to this VirtualBox installation, i.e.
1912	it must be previously created by <link to="#createHardDisk"/> or opened
1913	by <link to="#openMedium"/>.
1914
1915	The search is done by comparing the value of the @a location argument to
1916	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1917	attributes of each known medium.
1918
1919	On case sensitive file systems, a case sensitive comparison is performed,
1920	otherwise the case of symbols in the file path is ignored.
1921
1922	<result name="VBOX_E_OBJECT_NOT_FOUND">
1923	No medium object matching @a location found.
1924	</result>
1925	</desc>
1926	<param name="location" type="wstring" dir="in">
1927	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1928	</param>
1929	<param name="type" type="DeviceType" dir="in">
1930	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1931	</param>
1932	<param name="medium" type="IMedium" dir="return">
1933	<desc>Medium object, if found.</desc>
1934	</param>
1935	</method>
1936
1937	<method name="getGuestOSType">
1938	<desc>
1939	Returns an object describing the specified guest OS type.
1940
1941	The requested guest OS type is specified using a string which is a
1942	mnemonic identifier of the guest operating system, such as
1943	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1944	particular virtual machine can be read or set using the
1945	<link to="IMachine::OSTypeId"/> attribute.
1946
1947	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1948	available guest OS type objects. Each object has an
1949	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1950	the guest OS this object describes.
1951
1952	<result name="E_INVALIDARG">
1953	@a id is not a valid Guest OS type.
1954	</result>
1955
1956	</desc>
1957	<param name="id" type="uuid" mod="string" dir="in">
1958	<desc>Guest OS type ID string.</desc>
1959	</param>
1960	<param name="type" type="IGuestOSType" dir="return">
1961	<desc>Guest OS type object.</desc>
1962	</param>
1963	</method>
1964
1965	<method name="createSharedFolder">
1966	<desc>
1967	Creates a new global shared folder by associating the given logical
1968	name with the given host path, adds it to the collection of shared
1969	folders and starts sharing it. Refer to the description of
1970	<link to="ISharedFolder"/> to read more about logical names.
1971	<note>
1972	In the current implementation, this operation is not
1973	implemented.
1974	</note>
1975	</desc>
1976	<param name="name" type="wstring" dir="in">
1977	<desc>Unique logical name of the shared folder.</desc>
1978	</param>
1979	<param name="hostPath" type="wstring" dir="in">
1980	<desc>Full path to the shared folder in the host file system.</desc>
1981	</param>
1982	<param name="writable" type="boolean" dir="in">
1983	<desc>Whether the share is writable or readonly</desc>
1984	</param>
1985	<param name="automount" type="boolean" dir="in">
1986	<desc>Whether the share gets automatically mounted by the guest
1987	or not.</desc>
1988	</param>
1989	</method>
1990
1991	<method name="removeSharedFolder">
1992	<desc>
1993	Removes the global shared folder with the given name previously
1994	created by <link to="#createSharedFolder"/> from the collection of
1995	shared folders and stops sharing it.
1996	<note>
1997	In the current implementation, this operation is not
1998	implemented.
1999	</note>
2000	</desc>
2001	<param name="name" type="wstring" dir="in">
2002	<desc>Logical name of the shared folder to remove.</desc>
2003	</param>
2004	</method>
2005
2006	<method name="getExtraDataKeys">
2007	<desc>
2008	Returns an array representing the global extra data keys which currently
2009	have values defined.
2010	</desc>
2011	<param name="value" type="wstring" dir="return" safearray="yes">
2012	<desc>Array of extra data keys.</desc>
2013	</param>
2014	</method>
2015
2016	<method name="getExtraData">
2017	<desc>
2018	Returns associated global extra data.
2019
2020	If the requested data @a key does not exist, this function will
2021	succeed and return an empty string in the @a value argument.
2022
2023	<result name="VBOX_E_FILE_ERROR">
2024	Settings file not accessible.
2025	</result>
2026	<result name="VBOX_E_XML_ERROR">
2027	Could not parse the settings file.
2028	</result>
2029
2030	</desc>
2031	<param name="key" type="wstring" dir="in">
2032	<desc>Name of the data key to get.</desc>
2033	</param>
2034	<param name="value" type="wstring" dir="return">
2035	<desc>Value of the requested data key.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="setExtraData">
2040	<desc>
2041	Sets associated global extra data.
2042
2043	If you pass @c null or empty string as a key @a value, the given @a key
2044	will be deleted.
2045
2046	<note>
2047	Before performing the actual data change, this method will ask all
2048	registered event listener using the
2049	<link to="IExtraDataCanChangeEvent"/>
2050	notification for a permission. If one of the listeners refuses the
2051	new value, the change will not be performed.
2052	</note>
2053	<note>
2054	On success, the
2055	<link to="IExtraDataChangedEvent"/> notification
2056	is called to inform all registered listeners about a successful data
2057	change.
2058	</note>
2059
2060	<result name="VBOX_E_FILE_ERROR">
2061	Settings file not accessible.
2062	</result>
2063	<result name="VBOX_E_XML_ERROR">
2064	Could not parse the settings file.
2065	</result>
2066	<result name="E_ACCESSDENIED">
2067	Modification request refused.
2068	</result>
2069
2070	</desc>
2071	<param name="key" type="wstring" dir="in">
2072	<desc>Name of the data key to set.</desc>
2073	</param>
2074	<param name="value" type="wstring" dir="in">
2075	<desc>Value to assign to the key.</desc>
2076	</param>
2077	</method>
2078
2079	<!--method name="createDHCPServerForInterface">
2080	<desc>
2081	Creates a dhcp server settings to be used for the given interface
2082	<result name="E_INVALIDARG">
2083	Host network interface @a name already exists.
2084	</result>
2085	</desc>
2086	<param name="interface" type="IHostNetworkInterface" dir="in">
2087	<desc>Network Interface</desc>
2088	</param>
2089	<param name="server" type="IDHCPServer" dir="out">
2090	<desc>Dhcp server settings</desc>
2091	</param>
2092	</method-->
2093
2094	<method name="createDHCPServer">
2095	<desc>
2096	Creates a dhcp server settings to be used for the given internal network name
2097	<result name="E_INVALIDARG">
2098	Host network interface @a name already exists.
2099	</result>
2100	</desc>
2101	<param name="name" type="wstring" dir="in">
2102	<desc>server name</desc>
2103	</param>
2104	<param name="server" type="IDHCPServer" dir="return">
2105	<desc>Dhcp server settings</desc>
2106	</param>
2107	</method>
2108
2109	<method name="findDHCPServerByNetworkName">
2110	<desc>
2111	Searches 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
2116	</desc>
2117	<param name="name" type="wstring" dir="in">
2118	<desc>server name</desc>
2119	</param>
2120	<param name="server" type="IDHCPServer" dir="return">
2121	<desc>Dhcp server settings</desc>
2122	</param>
2123	</method>
2124
2125	<!--method name="findDHCPServerForInterface">
2126	<desc>
2127	Searches a dhcp server settings to be used for the given interface
2128	<result name="E_INVALIDARG">
2129	Host network interface @a name already exists.
2130	</result>
2131	</desc>
2132	<param name="interface" type="IHostNetworkInterface" dir="in">
2133	<desc>Network Interface</desc>
2134	</param>
2135	<param name="server" type="IDHCPServer" dir="out">
2136	<desc>Dhcp server settings</desc>
2137	</param>
2138	</method-->
2139
2140	<method name="removeDHCPServer">
2141	<desc>
2142	Removes the dhcp server settings
2143	<result name="E_INVALIDARG">
2144	Host network interface @a name already exists.
2145	</result>
2146	</desc>
2147	<param name="server" type="IDHCPServer" dir="in">
2148	<desc>Dhcp server settings to be removed</desc>
2149	</param>
2150	</method>
2151
2152
2153	<method name="checkFirmwarePresent">
2154	<desc>
2155	Check if this VirtualBox installation has a firmware
2156	of the given type available, either system-wide or per-user.
2157	Optionally, this may return a hint where this firmware can be
2158	downloaded from.
2159	</desc>
2160	<param name="firmwareType" type="FirmwareType" dir="in">
2161	<desc>
2162	Type of firmware to check.
2163	</desc>
2164	</param>
2165	<param name="version" type="wstring" dir="in">
2166	<desc>Expected version number, usually empty string (presently ignored).</desc>
2167	</param>
2168
2169	<param name="url" type="wstring" dir="out">
2170	<desc>
2171	Suggested URL to download this firmware from.
2172	</desc>
2173	</param>
2174
2175	<param name="file" type="wstring" dir="out">
2176	<desc>
2177	Filename of firmware, only valid if result == TRUE.
2178	</desc>
2179	</param>
2180
2181	<param name="result" type="boolean" dir="return">
2182	<desc>If firmware of this type and version is available.</desc>
2183	</param>
2184	</method>
2185
2186	<method name="VRDERegisterLibrary">
2187	<desc>
2188	Appends a VRDE library to this VirtualBox installation.
2189
2190	The library implements a VirtualBox Remote Desktop Extension (VRDE),
2191	which is used to remotely connect to the virtual machines.
2192
2193	The system library extension (".DLL" or ".so") must be omitted.
2194	The library must reside in the VirtualBox installation directory.
2195	</desc>
2196	<param name="name" type="wstring" dir="in">
2197	<desc>The library name.</desc>
2198	</param>
2199	</method>
2200
2201	<method name="VRDEUnregisterLibrary">
2202	<desc>
2203	Removes a VRDE library from this VirtualBox installation.
2204	</desc>
2205	<param name="name" type="wstring" dir="in">
2206	<desc>The library name.</desc>
2207	</param>
2208	</method>
2209
2210	<method name="VRDEListLibraries">
2211	<desc>
2212	List registered libraries.
2213	</desc>
2214	<param name="names" type="wstring" dir="return" safearray="yes">
2215	<desc>Array of names of the libraries.</desc>
2216	</param>
2217	</method>
2218
2219	<method name="VRDEIsLibraryRegistered">
2220	<desc>
2221	Check if the library is registered.
2222	</desc>
2223	<param name="name" type="wstring" dir="in">
2224	<desc>The library name.</desc>
2225	</param>
2226	<param name="registered" type="boolean" dir="return">
2227	<desc>Whether the library is registered.</desc>
2228	</param>
2229	</method>
2230
2231	</interface>
2232
2233	<!--
2234	// IVFSExplorer
2235	/////////////////////////////////////////////////////////////////////////
2236	-->
2237
2238	<enum
2239	name="VFSType"
2240	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2241	>
2242	<desc>
2243	Virtual file systems supported by VFSExplorer.
2244	</desc>
2245
2246	<const name="File" value="1" />
2247	<const name="Cloud" value="2" />
2248	<const name="S3" value="3" />
2249	<const name="WebDav" value="4" />
2250	</enum>
2251
2252	<enum
2253	name="VFSFileType"
2254	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2255	>
2256	<desc>
2257	File types known by VFSExplorer.
2258	</desc>
2259
2260	<const name="Unknown" value="1" />
2261	<const name="Fifo" value="2" />
2262	<const name="DevChar" value="3" />
2263	<const name="Directory" value="4" />
2264	<const name="DevBlock" value="5" />
2265	<const name="File" value="6" />
2266	<const name="SymLink" value="7" />
2267	<const name="Socket" value="8" />
2268	<const name="WhiteOut" value="9" />
2269	</enum>
2270
2271	<interface
2272	name="IVFSExplorer" extends="$unknown"
2273	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2274	wsmap="managed"
2275	>
2276	<desc>
2277	The VFSExplorer interface unifies access to different file system
2278	types. This includes local file systems as well remote file systems like
2279	S3. For a list of supported types see <link to="VFSType" />.
2280	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2281	</desc>
2282
2283	<attribute name="path" type="wstring" readonly="yes">
2284	<desc>Returns the current path in the virtual file system.</desc>
2285	</attribute>
2286
2287	<attribute name="type" type="VFSType" readonly="yes">
2288	<desc>Returns the file system type which is currently in use.</desc>
2289	</attribute>
2290
2291	<method name="update">
2292	<desc>Updates the internal list of files/directories from the
2293	current directory level. Use <link to="#entryList" /> to get the full list
2294	after a call to this method.</desc>
2295
2296	<param name="aProgress" type="IProgress" dir="return">
2297	<desc>Progress object to track the operation completion.</desc>
2298	</param>
2299	</method>
2300
2301	<method name="cd">
2302	<desc>Change the current directory level.</desc>
2303
2304	<param name="aDir" type="wstring" dir="in">
2305	<desc>The name of the directory to go in.</desc>
2306	</param>
2307
2308	<param name="aProgress" type="IProgress" dir="return">
2309	<desc>Progress object to track the operation completion.</desc>
2310	</param>
2311	</method>
2312
2313	<method name="cdUp">
2314	<desc>Go one directory upwards from the current directory level.</desc>
2315
2316	<param name="aProgress" type="IProgress" dir="return">
2317	<desc>Progress object to track the operation completion.</desc>
2318	</param>
2319	</method>
2320
2321	<method name="entryList">
2322	<desc>Returns a list of files/directories after a call to <link
2323	to="#update" />. The user is responsible for keeping this internal
2324	list up do date.</desc>
2325
2326	<param name="aNames" type="wstring" safearray="yes" dir="out">
2327	<desc>The list of names for the entries.</desc>
2328	</param>
2329
2330	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2331	<desc>The list of types for the entries.</desc>
2332	</param>
2333
2334	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2335	<desc>The list of sizes (in bytes) for the entries.</desc>
2336	</param>
2337
2338	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2339	<desc>The list of file modes (in octal form) for the entries.</desc>
2340	</param>
2341	</method>
2342
2343	<method name="exists">
2344	<desc>Checks if the given file list exists in the current directory
2345	level.</desc>
2346
2347	<param name="aNames" type="wstring" safearray="yes" dir="in">
2348	<desc>The names to check.</desc>
2349	</param>
2350
2351	<param name="aExists" type="wstring" safearray="yes" dir="return">
2352	<desc>The names which exist.</desc>
2353	</param>
2354	</method>
2355
2356	<method name="remove">
2357	<desc>Deletes the given files in the current directory level.</desc>
2358
2359	<param name="aNames" type="wstring" safearray="yes" dir="in">
2360	<desc>The names to remove.</desc>
2361	</param>
2362
2363	<param name="aProgress" type="IProgress" dir="return">
2364	<desc>Progress object to track the operation completion.</desc>
2365	</param>
2366	</method>
2367
2368	</interface>
2369
2370	<!--
2371	// IAppliance
2372	/////////////////////////////////////////////////////////////////////////
2373	-->
2374
2375	<interface
2376	name="IAppliance" extends="$unknown"
2377	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2378	wsmap="managed"
2379	>
2380	<desc>
2381	Represents a platform-independent appliance in OVF format. An instance of this is returned
2382	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2383	virtual machines within an appliance with VirtualBox.
2384
2385	The OVF standard suggests two different physical file formats:
2386
2387	<ol>
2388	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2389	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2390	this descriptor file references other files such as disk images, as OVF appliances typically
2391	do, those additional files must be in the same directory as the descriptor file.</li>
2392
2393	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2394	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2395	files and optionally other files.
2396
2397	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2398	be added with a later version.</li>
2399	</ol>
2400
2401	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2402	<link to="IMachine" /> involves the following sequence of API calls:
2403
2404	<ol>
2405	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2406	</li>
2407
2408	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2409	would like to import. So long as this file is syntactically valid, this will succeed
2410	and fill the appliance object with the parsed data from the OVF file.
2411	</li>
2412
2413	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2414	contents of the IAppliance attributes accordingly. These can be inspected by a
2415	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2416	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2417	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2418	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2419	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2420	The GUI can then give the user the option to confirm and/or change these suggestions.
2421	</li>
2422
2423	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2424	virtual system (machine) to override the suggestions made by the interpret() routine.
2425	</li>
2426
2427	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2428	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2429	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2430	can be found in the <link to="#machines" /> array attribute.
2431	</li>
2432	</ol>
2433
2434	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2435
2436	<ol>
2437	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2438	an empty IAppliance object.
2439	</li>
2440
2441	<li>For each machine you would like to export, call <link to="IMachine::export" />
2442	with the IAppliance object you just created. Each such call creates one instance of
2443	<link to="IVirtualSystemDescription" /> inside the appliance.
2444	</li>
2445
2446	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2447	virtual system (machine) to override the suggestions made by the export() routine.
2448	</li>
2449
2450	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2451	file written.</li>
2452	</ol>
2453
2454	</desc>
2455
2456	<attribute name="path" type="wstring" readonly="yes">
2457	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2458	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2459	<link to="#write" /> (for export).
2460	This attribute is empty until one of these methods has been called.
2461	</desc>
2462	</attribute>
2463
2464	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2465	<desc>
2466	Array of virtual disk definitions. One such description exists for each
2467	disk definition in the OVF; each string array item represents one such piece of
2468	disk information, with the information fields separated by tab (\t) characters.
2469
2470	The caller should be prepared for additional fields being appended to
2471	this string in future versions of VirtualBox and therefore check for
2472	the number of tabs in the strings returned.
2473
2474	In the current version, the following eight fields are returned per string
2475	in the array:
2476
2477	<ol>
2478	<li>Disk ID (unique string identifier given to disk)</li>
2479
2480	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2481
2482	<li>Populated size (optional unsigned integer indicating the current size of the
2483	disk; can be approximate; -1 if unspecified)</li>
2484
2485	<li>Format (string identifying the disk format, typically
2486	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2487
2488	<li>Reference (where to find the disk image, typically a file name; if empty,
2489	then the disk should be created on import)</li>
2490
2491	<li>Image size (optional unsigned integer indicating the size of the image,
2492	which need not necessarily be the same as the values specified above, since
2493	the image may be compressed or sparse; -1 if not specified)</li>
2494
2495	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2496	presently unsupported and always -1)</li>
2497
2498	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2499	</ol>
2500	</desc>
2501	</attribute>
2502
2503	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2504	<desc> Array of virtual system descriptions. One such description is created
2505	for each virtual system (machine) found in the OVF.
2506	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2507	(for export) has been called.
2508	</desc>
2509	</attribute>
2510
2511	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2512	<desc>
2513	Contains the UUIDs of the machines created from the information in this appliances. This is only
2514	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2515	succeeded.
2516	</desc>
2517	</attribute>
2518
2519	<method name="read">
2520	<desc>
2521	Reads an OVF file into the appliance object.
2522
2523	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2524	mere fact that this method returns successfully does not mean that VirtualBox supports all
2525	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2526	</desc>
2527	<param name="file" type="wstring" dir="in">
2528	<desc>
2529	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2530	on whether the appliance is distributed as a set of files or as a single file, respectively).
2531	</desc>
2532	</param>
2533	<param name="aProgress" type="IProgress" dir="return">
2534	<desc>Progress object to track the operation completion.</desc>
2535	</param>
2536	</method>
2537
2538	<method name="interpret">
2539	<desc>
2540	Interprets the OVF data that was read when the appliance was constructed. After
2541	calling this method, one can inspect the
2542	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2543	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2544	the appliance.
2545
2546	Calling this method is the second step of importing an appliance into VirtualBox;
2547	see <link to="IAppliance" /> for an overview.
2548
2549	After calling this method, one should call <link to="#getWarnings" /> to find out
2550	if problems were encountered during the processing which might later lead to
2551	errors.
2552	</desc>
2553	</method>
2554
2555	<method name="importMachines">
2556	<desc>
2557	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2558	and other interfaces that match the information contained in the appliance as
2559	closely as possible, as represented by the import instructions in the
2560	<link to="#virtualSystemDescriptions" /> array.
2561
2562	Calling this method is the final step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	Since importing the appliance will most probably involve copying and converting
2566	disk images, which can take a long time, this method operates asynchronously and
2567	returns an IProgress object to allow the caller to monitor the progress.
2568
2569	After the import succeeded, the UUIDs of the IMachine instances created can be
2570	retrieved from the <link to="#machines" /> array attribute.
2571	</desc>
2572
2573	<param name="aProgress" type="IProgress" dir="return">
2574	<desc>Progress object to track the operation completion.</desc>
2575	</param>
2576	</method>
2577
2578	<method name="createVFSExplorer">
2579	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2580
2581	<param name="aUri" type="wstring" dir="in">
2582	<desc>The URI describing the file system to use.</desc>
2583	</param>
2584
2585	<param name="aExplorer" type="IVFSExplorer" dir="return">
2586	<desc></desc>
2587	</param>
2588	</method>
2589
2590	<method name="write">
2591	<desc>
2592	Writes the contents of the appliance exports into a new OVF file.
2593
2594	Calling this method is the final step of exporting an appliance from VirtualBox;
2595	see <link to="IAppliance" /> for an overview.
2596
2597	Since exporting the appliance will most probably involve copying and converting
2598	disk images, which can take a long time, this method operates asynchronously and
2599	returns an IProgress object to allow the caller to monitor the progress.
2600	</desc>
2601	<param name="format" type="wstring" dir="in">
2602	<desc>
2603	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2604	future versions of VirtualBox may support additional formats.
2605	</desc>
2606	</param>
2607	<param name="manifest" type="boolean" dir="in">
2608	<desc>
2609	Indicate if the optional manifest file (.mf) should be written. The manifest file
2610	is used for integrity checks prior import.
2611	</desc>
2612	</param>
2613	<param name="path" type="wstring" dir="in">
2614	<desc>
2615	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2616	on whether the appliance is distributed as a set of files or as a single file, respectively).
2617	</desc>
2618	</param>
2619	<param name="progress" type="IProgress" dir="return">
2620	<desc>Progress object to track the operation completion.</desc>
2621	</param>
2622	</method>
2623
2624	<method name="getWarnings">
2625	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2626
2627	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2628	<desc></desc>
2629	</param>
2630	</method>
2631
2632	</interface>
2633
2634	<enum
2635	name="VirtualSystemDescriptionType"
2636	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2637	>
2638	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2639	a configuration value.</desc>
2640
2641	<const name="Ignore" value="1" />
2642	<const name="OS" value="2" />
2643	<const name="Name" value="3" />
2644	<const name="Product" value="4" />
2645	<const name="Vendor" value="5" />
2646	<const name="Version" value="6" />
2647	<const name="ProductUrl" value="7" />
2648	<const name="VendorUrl" value="8" />
2649	<const name="Description" value="9" />
2650	<const name="License" value="10" />
2651	<const name="Miscellaneous" value="11" />
2652	<const name="CPU" value="12" />
2653	<const name="Memory" value="13" />
2654	<const name="HardDiskControllerIDE" value="14" />
2655	<const name="HardDiskControllerSATA" value="15" />
2656	<const name="HardDiskControllerSCSI" value="16" />
2657	<const name="HardDiskControllerSAS" value="17" />
2658	<const name="HardDiskImage" value="18" />
2659	<const name="Floppy" value="19" />
2660	<const name="CDROM" value="20" />
2661	<const name="NetworkAdapter" value="21" />
2662	<const name="USBController" value="22" />
2663	<const name="SoundCard" value="23" />
2664
2665	</enum>
2666
2667	<enum
2668	name="VirtualSystemDescriptionValueType"
2669	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2670	>
2671	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2672	type to fetch.</desc>
2673
2674	<const name="Reference" value="1" />
2675	<const name="Original" value="2" />
2676	<const name="Auto" value="3" />
2677	<const name="ExtraConfig" value="4" />
2678
2679	</enum>
2680
2681	<interface
2682	name="IVirtualSystemDescription" extends="$unknown"
2683	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2684	wsmap="managed"
2685	>
2686
2687	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2688	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2689	<link to="IAppliance::interpret" /> has been called, that array contains information
2690	about how the virtual systems described in the OVF should best be imported into
2691	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2692	import an OVF into VirtualBox.
2693	</desc>
2694
2695	<attribute name="count" type="unsigned long" readonly="yes">
2696	<desc>Return the number of virtual system description entries.</desc>
2697	</attribute>
2698
2699	<method name="getDescription">
2700	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2701	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2702
2703	The list below identifies the value sets that are possible depending on the
2704	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2705	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2706	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2707	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2708	the @a aExtraConfigValues[] array item may also be used.
2709
2710	<ul>
2711	<li>
2712	"OS": the guest operating system type. There must be exactly one such array item on import. The
2713	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2714	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2715	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2716	</li>
2717	<li>
2718	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2719	if none is present on import, then an automatic name will be created from the operating system
2720	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2721	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2722	<link to="IMachine" /> name that does not exist yet.
2723	</li>
2724	<li>
2725	"Description": an arbitrary description.
2726	</li>
2727	<li>
2728	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2729	code to display such a license for agreement; the Main API does not enforce any such policy.
2730	</li>
2731	<li>
2732	Miscellaneous: reserved for future use.
2733	</li>
2734	<li>
2735	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2736	</li>
2737	<li>
2738	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2739	is present on import, then VirtualBox will set a meaningful default based on the operating system
2740	type.
2741	</li>
2742	<li>
2743	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2744	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2745	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2746	writes into the OVF.
2747	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2748	type can use to specify which hard disk controller a virtual disk should be connected to.
2749	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2750	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2751	its virtual machines supports four channels (primary master, primary slave, secondary master,
2752	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2753	</li>
2754	<li>
2755	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2756	has no value in @a aOvfValues[] or @a aVBoxValues[].
2757	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2758	</li>
2759	<li>
2760	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2761	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2762	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2763	whereas VirtualBox considers it a class of storage controllers of its own; see
2764	<link to="StorageControllerType" />).
2765	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2766	</li>
2767	<li>
2768	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2769	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2770
2771	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2772	a path since the image file should be in the same location as the OVF file itself), whereas the
2773	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2774	hard disk image. This means that on import the image will be copied and converted from the
2775	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2776
2777	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2778	format: "controller=<index>;channel=<c>"
2779	In this string, <index> must be an integer specifying the hard disk controller to connect
2780	the image to. That number must be the index of an array item with one of the hard disk controller
2781	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2782	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2783	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2784	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2785	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2786	</li>
2787	<li>
2788	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2789	attachment information as with "HardDiskImage" items.
2790	</li>
2791	<li>
2792	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2793	attachment information as with "HardDiskImage" items.
2794	</li>
2795	<li>
2796	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2797	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2798	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2799	</li>
2800	<li>
2801	"USBController": a USB controller. There can be at most one such item. If and only if such an
2802	item ispresent, USB support will be enabled for the new virtual machine.
2803	</li>
2804	<li>
2805	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2806	present, sound support will be enabled for the new virtual machine. Note that the virtual
2807	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2808	may be different from the virtual soundcard expected by the appliance.
2809	</li>
2810	</ul>
2811
2812	</desc>
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="getDescriptionByType">
2837	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2838	should be returned.</desc>
2839
2840	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2841	<desc></desc>
2842	</param>
2843
2844	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2845	<desc></desc>
2846	</param>
2847
2848	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2849	<desc></desc>
2850	</param>
2851
2852	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2853	<desc></desc>
2854	</param>
2855
2856	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2857	<desc></desc>
2858	</param>
2859
2860	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2861	<desc></desc>
2862	</param>
2863
2864	</method>
2865
2866	<method name="getValuesByType">
2867	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2868	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2869	values.</desc>
2870
2871	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2872	<desc></desc>
2873	</param>
2874
2875	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2876	<desc></desc>
2877	</param>
2878
2879	<param name="aValues" type="wstring" dir="return" safearray="yes">
2880	<desc></desc>
2881	</param>
2882
2883	</method>
2884
2885	<method name="setFinalValues">
2886	<desc>
2887	This method allows the appliance's user to change the configuration for the virtual
2888	system descriptions. For each array item returned from <link to="#getDescription" />,
2889	you must pass in one boolean value and one configuration value.
2890
2891	Each item in the boolean array determines whether the particular configuration item
2892	should be enabled.
2893	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2894	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2895	and SoundCard.
2896
2897	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2898	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2899	the configuration remains unchanged. Please see the documentation for getDescription()
2900	for valid configuration values for the individual array item types. If the
2901	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2902	</desc>
2903
2904	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2905	<desc></desc>
2906	</param>
2907
2908	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2909	<desc></desc>
2910	</param>
2911
2912	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2913	<desc></desc>
2914	</param>
2915	</method>
2916
2917	<method name="addDescription">
2918	<desc>
2919	This method adds an additional description entry to the stack of already
2920	available descriptions for this virtual system. This is handy for writing
2921	values which aren't directly supported by VirtualBox. One example would
2922	be the License type of <link to="VirtualSystemDescriptionType" />.
2923	</desc>
2924
2925	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2926	<desc></desc>
2927	</param>
2928
2929	<param name="aVBoxValue" type="wstring" dir="in">
2930	<desc></desc>
2931	</param>
2932
2933	<param name="aExtraConfigValue" type="wstring" dir="in">
2934	<desc></desc>
2935	</param>
2936	</method>
2937	</interface>
2938
2939
2940	<!--
2941	// IMachine
2942	/////////////////////////////////////////////////////////////////////////
2943	-->
2944
2945	<interface
2946	name="IInternalMachineControl" extends="$unknown"
2947	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
2948	internal="yes"
2949	wsmap="suppress"
2950	>
2951	<method name="setRemoveSavedStateFile">
2952	<desc>
2953	Updates the flag whether the saved state file is removed on a
2954	machine state change from Saved to PoweredOff.
2955	</desc>
2956	<param name="aRemove" type="boolean" dir="in"/>
2957	</method>
2958
2959	<method name="updateState">
2960	<desc>
2961	Updates the VM state.
2962	<note>
2963	This operation will also update the settings file with the correct
2964	information about the saved state file and delete this file from disk
2965	when appropriate.
2966	</note>
2967	</desc>
2968	<param name="state" type="MachineState" dir="in"/>
2969	</method>
2970
2971	<method name="getIPCId">
2972	<param name="id" type="wstring" dir="return"/>
2973	</method>
2974
2975	<method name="beginPowerUp">
2976	<desc>
2977	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2978	gives it the progress object that should be part of any pending
2979	<link to="IMachine::launchVMProcess"/> operations. The progress
2980	object may be called back to reflect an early cancelation, so some care
2981	have to be taken with respect to any cancelation callbacks. The console
2982	object will call <link to="IInternalMachineControl::endPowerUp"/>
2983	to signal the completion of the progress object.
2984	</desc>
2985	<param name="aProgress" type="IProgress" dir="in" />
2986	</method>
2987
2988	<method name="endPowerUp">
2989	<desc>
2990	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2991	This method may query status information from the progress object it
2992	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2993	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2994	call in order to complete that progress object.
2995	</desc>
2996	<param name="result" type="long" dir="in"/>
2997	</method>
2998
2999	<method name="runUSBDeviceFilters">
3000	<desc>
3001	Asks the server to run USB devices filters of the associated
3002	machine against the given USB device and tell if there is
3003	a match.
3004	<note>
3005	Intended to be used only for remote USB devices. Local
3006	ones don't require to call this method (this is done
3007	implicitly by the Host and USBProxyService).
3008	</note>
3009	</desc>
3010	<param name="device" type="IUSBDevice" dir="in"/>
3011	<param name="matched" type="boolean" dir="out"/>
3012	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3013	</method>
3014
3015	<method name="captureUSBDevice">
3016	<desc>
3017	Requests a capture of the given host USB device.
3018	When the request is completed, the VM process will
3019	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3020	notification.
3021	</desc>
3022	<param name="id" type="uuid" mod="string" dir="in"/>
3023	</method>
3024
3025	<method name="detachUSBDevice">
3026	<desc>
3027	Notification that a VM is going to detach (@a done = @c false) or has
3028	already detached (@a done = @c true) the given USB device.
3029	When the @a done = @c true request is completed, the VM process will
3030	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3031	notification.
3032	<note>
3033	In the @a done = @c true case, the server must run its own filters
3034	and filters of all VMs but this one on the detached device
3035	as if it were just attached to the host computer.
3036	</note>
3037	</desc>
3038	<param name="id" type="uuid" mod="string" dir="in"/>
3039	<param name="done" type="boolean" dir="in"/>
3040	</method>
3041
3042	<method name="autoCaptureUSBDevices">
3043	<desc>
3044	Requests a capture all matching USB devices attached to the host.
3045	When the request is completed, the VM process will
3046	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3047	notification per every captured device.
3048	</desc>
3049	</method>
3050
3051	<method name="detachAllUSBDevices">
3052	<desc>
3053	Notification that a VM that is being powered down. The done
3054	parameter indicates whether which stage of the power down
3055	we're at. When @a done = @c false the VM is announcing its
3056	intentions, while when @a done = @c true the VM is reporting
3057	what it has done.
3058	<note>
3059	In the @a done = @c true case, the server must run its own filters
3060	and filters of all VMs but this one on all detach devices as
3061	if they were just attached to the host computer.
3062	</note>
3063	</desc>
3064	<param name="done" type="boolean" dir="in"/>
3065	</method>
3066
3067	<method name="onSessionEnd">
3068	<desc>
3069	Triggered by the given session object when the session is about
3070	to close normally.
3071	</desc>
3072	<param name="session" type="ISession" dir="in">
3073	<desc>Session that is being closed</desc>
3074	</param>
3075	<param name="progress" type="IProgress" dir="return">
3076	<desc>
3077	Used to wait until the corresponding machine is actually
3078	dissociated from the given session on the server.
3079	Returned only when this session is a direct one.
3080	</desc>
3081	</param>
3082	</method>
3083
3084	<method name="beginSavingState">
3085	<desc>
3086	Called by the VM process to inform the server it wants to
3087	save the current state and stop the VM execution.
3088	</desc>
3089	<param name="progress" type="IProgress" dir="in">
3090	<desc>
3091	Progress object created by the VM process to wait until
3092	the state is saved.
3093	</desc>
3094	</param>
3095	<param name="stateFilePath" type="wstring" dir="out">
3096	<desc>
3097	File path the VM process must save the execution state to.
3098	</desc>
3099	</param>
3100	</method>
3101
3102	<method name="endSavingState">
3103	<desc>
3104	Called by the VM process to inform the server that saving
3105	the state previously requested by #beginSavingState is either
3106	successfully finished or there was a failure.
3107
3108	<result name="VBOX_E_FILE_ERROR">
3109	Settings file not accessible.
3110	</result>
3111	<result name="VBOX_E_XML_ERROR">
3112	Could not parse the settings file.
3113	</result>
3114
3115	</desc>
3116
3117	<param name="success" type="boolean" dir="in">
3118	<desc>@c true to indicate success and @c false otherwise.
3119	</desc>
3120	</param>
3121	</method>
3122
3123	<method name="adoptSavedState">
3124	<desc>
3125	Gets called by IConsole::adoptSavedState.
3126	<result name="VBOX_E_FILE_ERROR">
3127	Invalid saved state file path.
3128	</result>
3129	</desc>
3130	<param name="savedStateFile" type="wstring" dir="in">
3131	<desc>Path to the saved state file to adopt.</desc>
3132	</param>
3133	</method>
3134
3135	<method name="beginTakingSnapshot">
3136	<desc>
3137	Called from the VM process to request from the server to perform the
3138	server-side actions of creating a snapshot (creating differencing images
3139	and the snapshot object).
3140
3141	<result name="VBOX_E_FILE_ERROR">
3142	Settings file not accessible.
3143	</result>
3144	<result name="VBOX_E_XML_ERROR">
3145	Could not parse the settings file.
3146	</result>
3147	</desc>
3148	<param name="initiator" type="IConsole" dir="in">
3149	<desc>The console object that initiated this call.</desc>
3150	</param>
3151	<param name="name" type="wstring" dir="in">
3152	<desc>Snapshot name.</desc>
3153	</param>
3154	<param name="description" type="wstring" dir="in">
3155	<desc>Snapshot description.</desc>
3156	</param>
3157	<param name="consoleProgress" type="IProgress" dir="in">
3158	<desc>
3159	Progress object created by the VM process tracking the
3160	snapshot's progress. This has the following sub-operations:
3161	<ul>
3162	<li>setting up (weight 1);</li>
3163	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3164	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3165	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3166	<li>finishing up (weight 1)</li>
3167	</ul>
3168	</desc>
3169	</param>
3170	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3171	<desc>
3172	Whether this is an online snapshot (i.e. the machine is running).
3173	</desc>
3174	</param>
3175	<param name="stateFilePath" type="wstring" dir="out">
3176	<desc>
3177	File path the VM process must save the execution state to.
3178	</desc>
3179	</param>
3180	</method>
3181
3182	<method name="endTakingSnapshot">
3183	<desc>
3184	Called by the VM process to inform the server that the snapshot
3185	previously requested by #beginTakingSnapshot is either
3186	successfully taken or there was a failure.
3187	</desc>
3188
3189	<param name="success" type="boolean" dir="in">
3190	<desc>@c true to indicate success and @c false otherwise</desc>
3191	</param>
3192	</method>
3193
3194	<method name="deleteSnapshot">
3195	<desc>
3196	Gets called by IConsole::deleteSnapshot.
3197	<result name="VBOX_E_INVALID_OBJECT_STATE">
3198	Snapshot has more than one child snapshot.
3199	</result>
3200	</desc>
3201	<param name="initiator" type="IConsole" dir="in">
3202	<desc>The console object that initiated this call.</desc>
3203	</param>
3204	<param name="id" type="uuid" mod="string" dir="in">
3205	<desc>UUID of the snapshot to delete.</desc>
3206	</param>
3207	<param name="machineState" type="MachineState" dir="out">
3208	<desc>New machine state after this operation is started.</desc>
3209	</param>
3210	<param name="progress" type="IProgress" dir="return">
3211	<desc>Progress object to track the operation completion.</desc>
3212	</param>
3213	</method>
3214
3215	<method name="finishOnlineMergeMedium">
3216	<desc>
3217	Gets called by IConsole::onlineMergeMedium.
3218	</desc>
3219	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3220	<desc>The medium attachment which needs to be cleaned up.</desc>
3221	</param>
3222	<param name="source" type="IMedium" dir="in">
3223	<desc>Merge source medium.</desc>
3224	</param>
3225	<param name="target" type="IMedium" dir="in">
3226	<desc>Merge target medium.</desc>
3227	</param>
3228	<param name="mergeForward" type="boolean" dir="in">
3229	<desc>Merge direction.</desc>
3230	</param>
3231	<param name="parentForTarget" type="IMedium" dir="in">
3232	<desc>For forward merges: new parent for target medium.</desc>
3233	</param>
3234	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3235	<desc>For backward merges: list of media which need their parent UUID
3236	updated.</desc>
3237	</param>
3238	</method>
3239
3240	<method name="restoreSnapshot">
3241	<desc>
3242	Gets called by IConsole::RestoreSnapshot.
3243	</desc>
3244	<param name="initiator" type="IConsole" dir="in">
3245	<desc>The console object that initiated this call.</desc>
3246	</param>
3247	<param name="snapshot" type="ISnapshot" dir="in">
3248	<desc>The snapshot to restore the VM state from.</desc>
3249	</param>
3250	<param name="machineState" type="MachineState" dir="out">
3251	<desc>New machine state after this operation is started.</desc>
3252	</param>
3253	<param name="progress" type="IProgress" dir="return">
3254	<desc>Progress object to track the operation completion.</desc>
3255	</param>
3256	</method>
3257
3258	<method name="pullGuestProperties">
3259	<desc>
3260	Get the list of the guest properties matching a set of patterns along
3261	with their values, time stamps and flags and give responsibility for
3262	managing properties to the console.
3263	</desc>
3264	<param name="name" type="wstring" dir="out" safearray="yes">
3265	<desc>
3266	The names of the properties returned.
3267	</desc>
3268	</param>
3269	<param name="value" type="wstring" dir="out" safearray="yes">
3270	<desc>
3271	The values of the properties returned. The array entries match the
3272	corresponding entries in the @a name array.
3273	</desc>
3274	</param>
3275	<param name="timestamp" type="long long" dir="out" safearray="yes">
3276	<desc>
3277	The time stamps of the properties returned. The array entries match
3278	the corresponding entries in the @a name array.
3279	</desc>
3280	</param>
3281	<param name="flags" type="wstring" dir="out" safearray="yes">
3282	<desc>
3283	The flags of the properties returned. The array entries match the
3284	corresponding entries in the @a name array.
3285	</desc>
3286	</param>
3287	</method>
3288
3289	<method name="pushGuestProperty">
3290	<desc>
3291	Update a single guest property in IMachine.
3292	</desc>
3293	<param name="name" type="wstring" dir="in">
3294	<desc>
3295	The name of the property to be updated.
3296	</desc>
3297	</param>
3298	<param name="value" type="wstring" dir="in">
3299	<desc>
3300	The value of the property.
3301	</desc>
3302	</param>
3303	<param name="timestamp" type="long long" dir="in">
3304	<desc>
3305	The timestamp of the property.
3306	</desc>
3307	</param>
3308	<param name="flags" type="wstring" dir="in">
3309	<desc>
3310	The flags of the property.
3311	</desc>
3312	</param>
3313	</method>
3314
3315	<method name="lockMedia">
3316	<desc>
3317	Locks all media attached to the machine for writing and parents of
3318	attached differencing media (if any) for reading. This operation is
3319	atomic so that if it fails no media is actually locked.
3320
3321	This method is intended to be called when the machine is in Starting or
3322	Restoring state. The locked media will be automatically unlocked when
3323	the machine is powered off or crashed.
3324	</desc>
3325	</method>
3326	<method name="unlockMedia">
3327	<desc>
3328	Unlocks all media previously locked using
3329	<link to="IInternalMachineControl::lockMedia"/>.
3330
3331	This method is intended to be used with teleportation so that it is
3332	possible to teleport between processes on the same machine.
3333	</desc>
3334	</method>
3335	</interface>
3336
3337	<interface
3338	name="IBIOSSettings" extends="$unknown"
3339	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3340	wsmap="managed"
3341	>
3342	<desc>
3343	The IBIOSSettings interface represents BIOS settings of the virtual
3344	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3345	</desc>
3346	<attribute name="logoFadeIn" type="boolean">
3347	<desc>Fade in flag for BIOS logo animation.</desc>
3348	</attribute>
3349
3350	<attribute name="logoFadeOut" type="boolean">
3351	<desc>Fade out flag for BIOS logo animation.</desc>
3352	</attribute>
3353
3354	<attribute name="logoDisplayTime" type="unsigned long">
3355	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3356	</attribute>
3357
3358	<attribute name="logoImagePath" type="wstring">
3359	<desc>
3360	Local file system path for external BIOS splash image. Empty string
3361	means the default image is shown on boot.
3362	</desc>
3363	</attribute>
3364
3365	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3366	<desc>Mode of the BIOS boot device menu.</desc>
3367	</attribute>
3368
3369	<attribute name="ACPIEnabled" type="boolean">
3370	<desc>ACPI support flag.</desc>
3371	</attribute>
3372
3373	<attribute name="IOAPICEnabled" type="boolean">
3374	<desc>
3375	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3376	and support IRQs above 15.
3377	</desc>
3378	</attribute>
3379
3380	<attribute name="timeOffset" type="long long">
3381	<desc>
3382	Offset in milliseconds from the host system time. This allows for
3383	guests running with a different system date/time than the host.
3384	It is equivalent to setting the system date/time in the BIOS except
3385	it is not an absolute value but a relative one. Guest Additions
3386	time synchronization honors this offset.
3387	</desc>
3388	</attribute>
3389
3390	<attribute name="PXEDebugEnabled" type="boolean">
3391	<desc>
3392	PXE debug logging flag. If set, VirtualBox will write extensive
3393	PXE trace information to the release log.
3394	</desc>
3395	</attribute>
3396
3397	</interface>
3398
3399	<enum name="CleanupMode"
3400	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3401	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3402	</desc>
3403	<const name="UnregisterOnly" value="1">
3404	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3405	</const>
3406	<const name="DetachAllReturnNone" value="2">
3407	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3408	</const>
3409	<const name="DetachAllReturnHardDisksOnly" value="3">
3410	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3411	</const>
3412	<const name="Full" value="4">
3413	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3414	</const>
3415	</enum>
3416
3417	<interface
3418	name="IMachine" extends="$unknown"
3419	uuid="cc4fec9a-3150-45df-9ee9-f00ba54d6ac3"
3420	wsmap="managed"
3421	>
3422	<desc>
3423	The IMachine interface represents a virtual machine, or guest, created
3424	in VirtualBox.
3425
3426	This interface is used in two contexts. First of all, a collection of
3427	objects implementing this interface is stored in the
3428	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3429	machines that are currently registered with this VirtualBox
3430	installation. Also, once a session has been opened for the given virtual
3431	machine (e.g. the virtual machine is running), the machine object
3432	associated with the open session can be queried from the session object;
3433	see <link to="ISession"/> for details.
3434
3435	The main role of this interface is to expose the settings of the virtual
3436	machine and provide methods to change various aspects of the virtual
3437	machine's configuration. For machine objects stored in the
3438	<link to="IVirtualBox::machines"/> collection, all attributes are
3439	read-only unless explicitly stated otherwise in individual attribute
3440	and method descriptions.
3441
3442	In order to change a machine setting, a session for this machine must be
3443	opened using one of the <link to="IMachine::lockMachine" /> or
3444	<link to="IMachine::launchVMProcess"/> methods. After the
3445	machine has been successfully locked for a session, a mutable machine object
3446	needs to be queried from the session object and then the desired settings
3447	changes can be applied to the returned object using IMachine attributes and
3448	methods. See the <link to="ISession"/> interface description for more
3449	information about sessions.
3450
3451	Note that IMachine does not provide methods to control virtual machine
3452	execution (such as start the machine, or power it down) -- these methods
3453	are grouped in a separate interface called <link to="IConsole" />.
3454
3455	<see>ISession, IConsole</see>
3456	</desc>
3457
3458	<attribute name="parent" type="IVirtualBox" readonly="yes">
3459	<desc>Associated parent object.</desc>
3460	</attribute>
3461
3462	<attribute name="accessible" type="boolean" readonly="yes">
3463	<desc>
3464	Whether this virtual machine is currently accessible or not.
3465
3466	A machine is always deemed accessible unless it is registered <i>and</i>
3467	its settings file cannot be read or parsed (either because the file itself
3468	is unavailable or has invalid XML contents).
3469
3470	Every time this property is read, the accessibility state of
3471	this machine is re-evaluated. If the returned value is @c false,
3472	the <link to="#accessError"/> property may be used to get the
3473	detailed error information describing the reason of
3474	inaccessibility, including XML error messages.
3475
3476	When the machine is inaccessible, only the following properties
3477	can be used on it:
3478	<ul>
3479	<li><link to="#parent"/></li>
3480	<li><link to="#id"/></li>
3481	<li><link to="#settingsFilePath"/></li>
3482	<li><link to="#accessible"/></li>
3483	<li><link to="#accessError"/></li>
3484	</ul>
3485
3486	An attempt to access any other property or method will return
3487	an error.
3488
3489	The only possible action you can perform on an inaccessible
3490	machine is to unregister it using the
3491	<link to="IMachine::unregister"/> call (or, to check
3492	for the accessibility state once more by querying this
3493	property).
3494
3495	<note>
3496	In the current implementation, once this property returns
3497	@c true, the machine will never become inaccessible
3498	later, even if its settings file cannot be successfully
3499	read/written any more (at least, until the VirtualBox
3500	server is restarted). This limitation may be removed in
3501	future releases.
3502	</note>
3503	</desc>
3504	</attribute>
3505
3506	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3507	<desc>
3508	Error information describing the reason of machine
3509	inaccessibility.
3510
3511	Reading this property is only valid after the last call to
3512	<link to="#accessible"/> returned @c false (i.e. the
3513	machine is currently inaccessible). Otherwise, a @c null
3514	IVirtualBoxErrorInfo object will be returned.
3515	</desc>
3516	</attribute>
3517
3518	<attribute name="name" type="wstring">
3519	<desc>
3520	Name of the virtual machine.
3521
3522	Besides being used for human-readable identification purposes
3523	everywhere in VirtualBox, the virtual machine name is also used
3524	as a name of the machine's settings file and as a name of the
3525	subdirectory this settings file resides in. Thus, every time you
3526	change the value of this property, the settings file will be
3527	renamed once you call <link to="#saveSettings"/> to confirm the
3528	change. The containing subdirectory will be also renamed, but
3529	only if it has exactly the same name as the settings file
3530	itself prior to changing this property (for backward compatibility
3531	with previous API releases). The above implies the following
3532	limitations:
3533	<ul>
3534	<li>The machine name cannot be empty.</li>
3535	<li>The machine name can contain only characters that are valid
3536	file name characters according to the rules of the file
3537	system used to store VirtualBox configuration.</li>
3538	<li>You cannot have two or more machines with the same name
3539	if they use the same subdirectory for storing the machine
3540	settings files.</li>
3541	<li>You cannot change the name of the machine if it is running,
3542	or if any file in the directory containing the settings file
3543	is being used by another running machine or by any other
3544	process in the host operating system at a time when
3545	<link to="#saveSettings"/> is called.
3546	</li>
3547	</ul>
3548	If any of the above limitations are hit, <link to="#saveSettings"/>
3549	will return an appropriate error message explaining the exact
3550	reason and the changes you made to this machine will not be saved.
3551
3552	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3553	file is recommended, but not enforced. (Previous versions always
3554	used a generic ".xml" extension.)
3555	</desc>
3556	</attribute>
3557
3558	<attribute name="description" type="wstring">
3559	<desc>
3560	Description of the virtual machine.
3561
3562	The description attribute can contain any text and is
3563	typically used to describe the hardware and software
3564	configuration of the virtual machine in detail (i.e. network
3565	settings, versions of the installed software and so on).
3566	</desc>
3567	</attribute>
3568
3569	<attribute name="id" type="uuid" mod="string" readonly="yes">
3570	<desc>UUID of the virtual machine.</desc>
3571	</attribute>
3572
3573	<attribute name="OSTypeId" type="wstring">
3574	<desc>
3575	User-defined identifier of the Guest OS type.
3576	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3577	an IGuestOSType object representing details about the given
3578	Guest OS type.
3579	<note>
3580	This value may differ from the value returned by
3581	<link to="IGuest::OSTypeId"/> if Guest Additions are
3582	installed to the guest OS.
3583	</note>
3584	</desc>
3585	</attribute>
3586
3587	<attribute name="HardwareVersion" type="wstring">
3588	<desc>Hardware version identifier. Internal use only for now.</desc>
3589	</attribute>
3590
3591	<attribute name="hardwareUUID" type="uuid" mod="string">
3592	<desc>
3593	The UUID presented to the guest via memory tables, hardware and guest
3594	properties. For most VMs this is the same as the @a id, but for VMs
3595	which have been cloned or teleported it may be the same as the source
3596	VM. This latter is because the guest shouldn't notice that it was
3597	cloned or teleported.
3598	</desc>
3599	</attribute>
3600
3601	<attribute name="CPUCount" type="unsigned long">
3602	<desc>Number of virtual CPUs in the VM.</desc>
3603	</attribute>
3604
3605	<attribute name="CPUHotPlugEnabled" type="boolean">
3606	<desc>
3607	This setting determines whether VirtualBox allows CPU
3608	hotplugging for this machine.</desc>
3609	</attribute>
3610
3611	<attribute name="CPUExecutionCap" type="unsigned long">
3612	<desc>
3613	Means to limit the number of CPU cycles a guest can use. The unit
3614	is percentage of host CPU cycles per second. The valid range
3615	is 1 - 100. 100 (the default) implies no limit.
3616	</desc>
3617	</attribute>
3618
3619	<attribute name="memorySize" type="unsigned long">
3620	<desc>System memory size in megabytes.</desc>
3621	</attribute>
3622
3623	<attribute name="memoryBalloonSize" type="unsigned long">
3624	<desc>Memory balloon size in megabytes.</desc>
3625	</attribute>
3626
3627	<attribute name="PageFusionEnabled" type="boolean">
3628	<desc>
3629	This setting determines whether VirtualBox allows page
3630	fusion for this machine (64 bits host only).
3631	</desc>
3632	</attribute>
3633
3634	<attribute name="VRAMSize" type="unsigned long">
3635	<desc>Video memory size in megabytes.</desc>
3636	</attribute>
3637
3638	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3639	<desc>
3640	This setting determines whether VirtualBox allows this machine to make
3641	use of the 3D graphics support available on the host.</desc>
3642	</attribute>
3643
3644	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3645	<desc>
3646	This setting determines whether VirtualBox allows this machine to make
3647	use of the 2D video acceleration support available on the host.</desc>
3648	</attribute>
3649
3650	<attribute name="monitorCount" type="unsigned long">
3651	<desc>
3652	Number of virtual monitors.
3653	<note>
3654	Only effective on Windows XP and later guests with
3655	Guest Additions installed.
3656	</note>
3657	</desc>
3658	</attribute>
3659
3660	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3661	<desc>Object containing all BIOS settings.</desc>
3662	</attribute>
3663
3664	<attribute name="firmwareType" type="FirmwareType">
3665	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3666	bootstrap in this VM.</desc>
3667	</attribute>
3668
3669	<attribute name="pointingHidType" type="PointingHidType">
3670	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3671	The default is typically "PS2Mouse" but can vary depending on the
3672	requirements of the guest operating system.</desc>
3673	</attribute>
3674
3675	<attribute name="keyboardHidType" type="KeyboardHidType">
3676	<desc>Type of keyboard HID used in this VM.
3677	The default is typically "PS2Keyboard" but can vary depending on the
3678	requirements of the guest operating system.</desc>
3679	</attribute>
3680
3681	<attribute name="hpetEnabled" type="boolean">
3682	<desc>This attribute controls if High Precision Event Timer (HPET) is
3683	enabled in this VM. Use this property if you want to provide guests
3684	with additional time source, or if guest requires HPET to function correctly.
3685	Default is false.</desc>
3686	</attribute>
3687
3688	<attribute name="chipsetType" type="ChipsetType">
3689	<desc>Chipset type used in this VM.</desc>
3690	</attribute>
3691
3692	<attribute name="snapshotFolder" type="wstring">
3693	<desc>
3694	Full path to the directory used to store snapshot data
3695	(differencing media and saved state files) of this machine.
3696
3697	The initial value of this property is
3698	<tt><</tt><link to="#settingsFilePath">
3699	path_to_settings_file</link><tt>>/<</tt>
3700	<link to="#id">machine_uuid</link>
3701	<tt>></tt>.
3702
3703	Currently, it is an error to try to change this property on
3704	a machine that has snapshots (because this would require to
3705	move possibly large files to a different location).
3706	A separate method will be available for this purpose later.
3707
3708	<note>
3709	Setting this property to @c null or to an empty string will restore
3710	the initial value.
3711	</note>
3712	<note>
3713	When setting this property, the specified path can be
3714	absolute (full path) or relative to the directory where the
3715	<link to="#settingsFilePath">machine settings file</link>
3716	is located. When reading this property, a full path is
3717	always returned.
3718	</note>
3719	<note>
3720	The specified path may not exist, it will be created
3721	when necessary.
3722	</note>
3723	</desc>
3724	</attribute>
3725
3726	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3727	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3728	</attribute>
3729
3730	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3731	<desc>Array of media attached to this machine.</desc>
3732	</attribute>
3733
3734	<attribute name="USBController" type="IUSBController" readonly="yes">
3735	<desc>
3736	Associated USB controller object.
3737
3738	<note>
3739	If USB functionality is not available in the given edition of
3740	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3741	</note>
3742	</desc>
3743	</attribute>
3744
3745	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3746	<desc>Associated audio adapter, always present.</desc>
3747	</attribute>
3748
3749	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3750	<desc>Array of storage controllers attached to this machine.</desc>
3751	</attribute>
3752
3753	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3754	<desc>
3755	Full name of the file containing machine settings data.
3756	</desc>
3757	</attribute>
3758
3759	<attribute name="settingsModified" type="boolean" readonly="yes">
3760	<desc>
3761	Whether the settings of this machine have been modified
3762	(but neither yet saved nor discarded).
3763	<note>
3764	Reading this property is only valid on instances returned
3765	by <link to="ISession::machine"/> and on new machines
3766	created by <link to="IVirtualBox::createMachine"/> or opened
3767	by <link to="IVirtualBox::openMachine"/> but not
3768	yet registered, or on unregistered machines after calling
3769	<link to="IMachine::unregister"/>. For all other
3770	cases, the settings can never be modified.
3771	</note>
3772	<note>
3773	For newly created unregistered machines, the value of this
3774	property is always @c true until <link to="#saveSettings"/>
3775	is called (no matter if any machine settings have been
3776	changed after the creation or not). For opened machines
3777	the value is set to @c false (and then follows to normal rules).
3778	</note>
3779	</desc>
3780	</attribute>
3781
3782	<attribute name="sessionState" type="SessionState" readonly="yes">
3783	<desc>Current session state for this machine.</desc>
3784	</attribute>
3785
3786	<attribute name="sessionType" type="wstring" readonly="yes">
3787	<desc>
3788	Type of the session. If <link to="#sessionState"/> is
3789	Spawning or Locked, this attribute contains the
3790	same value as passed to the
3791	<link to="IMachine::launchVMProcess"/> method in the
3792	@a type parameter. If the session was used with
3793	<link to="IMachine::lockMachine" />, or if
3794	<link to="#sessionState"/> is SessionClosed, the value of this
3795	attribute is an empty string.
3796	</desc>
3797	</attribute>
3798
3799	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3800	<desc>
3801	Identifier of the session process. This attribute contains the
3802	platform-dependent identifier of the process whose session was
3803	used with <link to="IMachine::lockMachine" /> call. The returned
3804	value is only valid if <link to="#sessionState"/> is Locked or
3805	Unlocking by the time this property is read.
3806	</desc>
3807	</attribute>
3808
3809	<attribute name="state" type="MachineState" readonly="yes">
3810	<desc>Current execution state of this machine.</desc>
3811	</attribute>
3812
3813	<attribute name="lastStateChange" type="long long" readonly="yes">
3814	<desc>
3815	Time stamp of the last execution state change,
3816	in milliseconds since 1970-01-01 UTC.
3817	</desc>
3818	</attribute>
3819
3820	<attribute name="stateFilePath" type="wstring" readonly="yes">
3821	<desc>
3822	Full path to the file that stores the execution state of
3823	the machine when it is in the <link to="MachineState_Saved"/> state.
3824	<note>
3825	When the machine is not in the Saved state, this attribute is
3826	an empty string.
3827	</note>
3828	</desc>
3829	</attribute>
3830
3831	<attribute name="logFolder" type="wstring" readonly="yes">
3832	<desc>
3833	Full path to the folder that stores a set of rotated log files
3834	recorded during machine execution. The most recent log file is
3835	named <tt>VBox.log</tt>, the previous log file is
3836	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3837	in the current version).
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3842	<desc>
3843	Current snapshot of this machine. This is @c null if the machine
3844	currently has no snapshots. If it is not @c null, then it was
3845	set by one of <link to="IConsole::takeSnapshot" />,
3846	<link to="IConsole::deleteSnapshot" />
3847	or <link to="IConsole::restoreSnapshot" />, depending on which
3848	was called last. See <link to="ISnapshot"/> for details.
3849	</desc>
3850	</attribute>
3851
3852	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3853	<desc>
3854	Number of snapshots taken on this machine. Zero means the
3855	machine doesn't have any snapshots.
3856	</desc>
3857	</attribute>
3858
3859	<attribute name="currentStateModified" type="boolean" readonly="yes">
3860	<desc>
3861	Returns @c true if the current state of the machine is not
3862	identical to the state stored in the current snapshot.
3863
3864	The current state is identical to the current snapshot only
3865	directly after one of the following calls are made:
3866
3867	<ul>
3868	<li><link to="IConsole::restoreSnapshot"/>
3869	</li>
3870	<li><link to="IConsole::takeSnapshot"/> (issued on a
3871	"powered off" or "saved" machine, for which
3872	<link to="#settingsModified"/> returns @c false)
3873	</li>
3874	</ul>
3875
3876	The current state remains identical until one of the following
3877	happens:
3878	<ul>
3879	<li>settings of the machine are changed</li>
3880	<li>the saved state is deleted</li>
3881	<li>the current snapshot is deleted</li>
3882	<li>an attempt to execute the machine is made</li>
3883	</ul>
3884
3885	<note>
3886	For machines that don't have snapshots, this property is
3887	always @c false.
3888	</note>
3889	</desc>
3890	</attribute>
3891
3892	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3893	<desc>
3894	Collection of shared folders for this machine (permanent shared
3895	folders). These folders are shared automatically at machine startup
3896	and available only to the guest OS installed within this machine.
3897
3898	New shared folders are added to the collection using
3899	<link to="#createSharedFolder"/>. Existing shared folders can be
3900	removed using <link to="#removeSharedFolder"/>.
3901	</desc>
3902	</attribute>
3903
3904	<attribute name="clipboardMode" type="ClipboardMode">
3905	<desc>
3906	Synchronization mode between the host OS clipboard
3907	and the guest OS clipboard.
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3912	<desc>
3913	A comma-separated list of simple glob patterns. Changes to guest
3914	properties whose name matches one of the patterns will generate an
3915	<link to="IGuestPropertyChangedEvent"/> signal.
3916	</desc>
3917	</attribute>
3918
3919	<attribute name="teleporterEnabled" type="boolean">
3920	<desc>
3921	When set to @a true, the virtual machine becomes a target teleporter
3922	the next time it is powered on. This can only set to @a true when the
3923	VM is in the @a PoweredOff or @a Aborted state.
3924
3925	<!-- This property is automatically set to @a false when the VM is powered
3926	on. (bird: This doesn't work yet ) -->
3927	</desc>
3928	</attribute>
3929
3930	<attribute name="teleporterPort" type="unsigned long">
3931	<desc>
3932	The TCP port the target teleporter will listen for incoming
3933	teleportations on.
3934
3935	0 means the port is automatically selected upon power on. The actual
3936	value can be read from this property while the machine is waiting for
3937	incoming teleportations.
3938	</desc>
3939	</attribute>
3940
3941	<attribute name="teleporterAddress" type="wstring">
3942	<desc>
3943	The address the target teleporter will listen on. If set to an empty
3944	string, it will listen on all addresses.
3945	</desc>
3946	</attribute>
3947
3948	<attribute name="teleporterPassword" type="wstring">
3949	<desc>
3950	The password to check for on the target teleporter. This is just a
3951	very basic measure to prevent simple hacks and operators accidentally
3952	beaming a virtual machine to the wrong place.
3953	</desc>
3954	</attribute>
3955
3956	<attribute name="faultToleranceState" type="FaultToleranceState">
3957	<desc>
3958	Fault tolerance state; disabled, source or target.
3959	This property can be changed at any time. If you change it for a running
3960	VM, then the fault tolerance address and port must be set beforehand.
3961	</desc>
3962	</attribute>
3963
3964	<attribute name="faultTolerancePort" type="unsigned long">
3965	<desc>
3966	The TCP port the fault tolerance source or target will use for
3967	communication.
3968	</desc>
3969	</attribute>
3970
3971	<attribute name="faultToleranceAddress" type="wstring">
3972	<desc>
3973	The address the fault tolerance source or target.
3974	</desc>
3975	</attribute>
3976
3977	<attribute name="faultTolerancePassword" type="wstring">
3978	<desc>
3979	The password to check for on the standby VM. This is just a
3980	very basic measure to prevent simple hacks and operators accidentally
3981	choosing the wrong standby VM.
3982	</desc>
3983	</attribute>
3984
3985	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3986	<desc>
3987	The interval in ms used for syncing the state between source and target.
3988	</desc>
3989	</attribute>
3990
3991	<attribute name="RTCUseUTC" type="boolean">
3992	<desc>
3993	When set to @a true, the RTC device of the virtual machine will run
3994	in UTC time, otherwise in local time. Especially Unix guests prefer
3995	the time in UTC.
3996	</desc>
3997	</attribute>
3998
3999	<attribute name="ioCacheEnabled" type="boolean">
4000	<desc>
4001	When set to @a true, the builtin I/O cache of the virtual machine
4002	will be enabled.
4003	</desc>
4004	</attribute>
4005
4006	<attribute name="ioCacheSize" type="unsigned long">
4007	<desc>
4008	Maximum size of the I/O cache in MB.
4009	</desc>
4010	</attribute>
4011
4012	<method name="lockMachine">
4013	<desc>
4014	Locks the machine for the given session to enable the caller
4015	to make changes to the machine or start the VM or control
4016	VM execution.
4017
4018	There are two ways to lock a machine for such uses:
4019
4020	<ul>
4021	<li>If you want to make changes to the machine settings,
4022	you must obtain an exclusive write lock on the machine
4023	by setting @a lockType to @c Write.
4024
4025	This will only succeed if no other process has locked
4026	the machine to prevent conflicting changes. Only after
4027	an exclusive write lock has been obtained using this method, one
4028	can change all VM settings or execute the VM in the process
4029	space of the session object. (Note that the latter is only of
4030	interest if you actually want to write a new front-end for
4031	virtual machines; but this API gets called internally by
4032	the existing front-ends such as VBoxHeadless and the VirtualBox
4033	GUI to acquire a write lock on the machine that they are running.)
4034
4035	On success, write-locking the machine for a session creates
4036	a second copy of the IMachine object. It is this second object
4037	upon which changes can be made; in VirtualBox terminology, the
4038	second copy is "mutable". It is only this second, mutable machine
4039	object upon which you can call methods that change the
4040	machine state. After having called this method, you can
4041	obtain this second, mutable machine object using the
4042	<link to="ISession::machine" /> attribute.
4043	</li>
4044	<li>If you only want to check the machine state or control
4045	machine execution without actually changing machine
4046	settings (e.g. to get access to VM statistics or take
4047	a snapshot or save the machine state), then set the
4048	@a lockType argument to @c Shared.
4049
4050	If no other session has obtained a lock, you will obtain an
4051	exclusive write lock as described above. However, if another
4052	session has already obtained such a lock, then a link to that
4053	existing session will be established which allows you
4054	to control that existing session.
4055
4056	To find out which type of lock was obtained, you can
4057	inspect <link to="ISession::type" />, which will have been
4058	set to either @c WriteLock or @c Shared.
4059	</li>
4060	</ul>
4061
4062	In either case, you can get access to the <link to="IConsole" />
4063	object which controls VM execution.
4064
4065	Also in all of the above cases, one must always call
4066	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4067	the machine's state will eventually be set to "Aborted".
4068
4069	To change settings on a machine, the following sequence is typically
4070	performed:
4071
4072	<ol>
4073	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4074
4075	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4076
4077	<li>Change the settings of the machine by invoking IMachine methods.</li>
4078
4079	<li>Call <link to="IMachine::saveSettings" />.</li>
4080
4081	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4082	</ol>
4083
4084	<result name="E_UNEXPECTED">
4085	Virtual machine not registered.
4086	</result>
4087	<result name="E_ACCESSDENIED">
4088	Process not started by OpenRemoteSession.
4089	</result>
4090	<result name="VBOX_E_INVALID_OBJECT_STATE">
4091	Session already open or being opened.
4092	</result>
4093	<result name="VBOX_E_VM_ERROR">
4094	Failed to assign machine to session.
4095	</result>
4096	</desc>
4097	<param name="session" type="ISession" dir="in">
4098	<desc>
4099	Session object for which the machine will be locked.
4100	</desc>
4101	</param>
4102	<param name="lockType" type="LockType" dir="in">
4103	<desc>
4104	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4105	If set to @c Shared, then either acquire an exclusive write lock or establish
4106	a link to an existing session.
4107	</desc>
4108	</param>
4109	</method>
4110
4111	<method name="launchVMProcess">
4112	<desc>
4113	Spawns a new process that will execute the virtual machine and obtains a shared
4114	lock on the machine for the calling session.
4115
4116	If launching the VM succeeds, the new VM process will create its own session
4117	and write-lock the machine for it, preventing conflicting changes from other
4118	processes. If the machine is already locked (because it is already running or
4119	because another session has a write lock), launching the VM process will therefore
4120	fail. Reversely, future attempts to obtain a write lock will also fail while the
4121	machine is running.
4122
4123	The caller's session object remains separate from the session opened by the new
4124	VM process. It receives its own <link to="IConsole" /> object which can be used
4125	to control machine execution, but it cannot be used to change all VM settings
4126	which would be available after a <link to="#lockMachine" /> call.
4127
4128	The caller must eventually release the session's shared lock by calling
4129	<link to="ISession::unlockMachine" /> on the local session object once this call
4130	has returned. However, the session's state (see <link to="ISession::state" />)
4131	will not return to "Unlocked" until the remote session has also unlocked
4132	the machine (i.e. the machine has stopped running).
4133
4134	Launching a VM process can take some time (a new VM is started in a new process,
4135	for which memory and other resources need to be set up). Because of this,
4136	an <link to="IProgress" /> object is returned to allow the caller to wait
4137	for this asynchronous operation to be completed. Until then, the caller's
4138	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4139	and <link to="ISession::console" /> attributes cannot be accessed.
4140	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4141	similar calls to wait for completion. Completion is signalled when the VM
4142	is powered on. If launching the VM fails, error messages can be queried
4143	via the progress object, if available.
4144
4145	The progress object will have at least 2 sub-operations. The first
4146	operation covers the period up to the new VM process calls powerUp.
4147	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4148	progress object. Because <link to="IConsole::powerUp"/> may require
4149	some extra sub-operations, the <link to="IProgress::operationCount"/>
4150	may change at the completion of operation.
4151
4152	For details on the teleportation progress operation, see
4153	<link to="IConsole::powerUp"/>.
4154
4155	The @a environment argument is a string containing definitions of
4156	environment variables in the following format:
4157	@code
4158	NAME[=VALUE]\n
4159	NAME[=VALUE]\n
4160	...
4161	@endcode
4162	where <tt>\\n</tt> is the new line character. These environment
4163	variables will be appended to the environment of the VirtualBox server
4164	process. If an environment variable exists both in the server process
4165	and in this list, the value from this list takes precedence over the
4166	server's variable. If the value of the environment variable is
4167	omitted, this variable will be removed from the resulting environment.
4168	If the environment string is @c null or empty, the server environment
4169	is inherited by the started process as is.
4170
4171	<result name="E_UNEXPECTED">
4172	Virtual machine not registered.
4173	</result>
4174	<result name="E_INVALIDARG">
4175	Invalid session type @a type.
4176	</result>
4177	<result name="VBOX_E_OBJECT_NOT_FOUND">
4178	No machine matching @a machineId found.
4179	</result>
4180	<result name="VBOX_E_INVALID_OBJECT_STATE">
4181	Session already open or being opened.
4182	</result>
4183	<result name="VBOX_E_IPRT_ERROR">
4184	Launching process for machine failed.
4185	</result>
4186	<result name="VBOX_E_VM_ERROR">
4187	Failed to assign machine to session.
4188	</result>
4189	</desc>
4190	<param name="session" type="ISession" dir="in">
4191	<desc>
4192	Client session object to which the VM process will be connected (this
4193	must be in "Unlocked" state).
4194	</desc>
4195	</param>
4196	<param name="type" type="wstring" dir="in">
4197	<desc>
4198	Front-end to use for the new VM process. The following are currently supported:
4199	<ul>
4200	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4201	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4202	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4203	</ul>
4204	</desc>
4205	</param>
4206	<param name="environment" type="wstring" dir="in">
4207	<desc>
4208	Environment to pass to the VM process.
4209	</desc>
4210	</param>
4211	<param name="progress" type="IProgress" dir="return">
4212	<desc>Progress object to track the operation completion.</desc>
4213	</param>
4214	</method>
4215
4216	<method name="setBootOrder">
4217	<desc>
4218	Puts the given device to the specified position in
4219	the boot order.
4220
4221	To indicate that no device is associated with the given position,
4222	<link to="DeviceType_Null"/> should be used.
4223
4224	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4225
4226	<result name="E_INVALIDARG">
4227	Boot @a position out of range.
4228	</result>
4229	<result name="E_NOTIMPL">
4230	Booting from USB @a device currently not supported.
4231	</result>
4232
4233	</desc>
4234	<param name="position" type="unsigned long" dir="in">
4235	<desc>
4236	Position in the boot order (@c 1 to the total number of
4237	devices the machine can boot from, as returned by
4238	<link to="ISystemProperties::maxBootPosition"/>).
4239	</desc>
4240	</param>
4241	<param name="device" type="DeviceType" dir="in">
4242	<desc>
4243	The type of the device used to boot at the given position.
4244	</desc>
4245	</param>
4246	</method>
4247
4248	<method name="getBootOrder" const="yes">
4249	<desc>
4250	Returns the device type that occupies the specified
4251	position in the boot order.
4252
4253	@todo [remove?]
4254	If the machine can have more than one device of the returned type
4255	(such as hard disks), then a separate method should be used to
4256	retrieve the individual device that occupies the given position.
4257
4258	If here are no devices at the given position, then
4259	<link to="DeviceType_Null"/> is returned.
4260
4261	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4262
4263	<result name="E_INVALIDARG">
4264	Boot @a position out of range.
4265	</result>
4266
4267	</desc>
4268	<param name="position" type="unsigned long" dir="in">
4269	<desc>
4270	Position in the boot order (@c 1 to the total number of
4271	devices the machine can boot from, as returned by
4272	<link to="ISystemProperties::maxBootPosition"/>).
4273	</desc>
4274	</param>
4275	<param name="device" type="DeviceType" dir="return">
4276	<desc>
4277	Device at the given position.
4278	</desc>
4279	</param>
4280	</method>
4281
4282	<method name="attachDevice">
4283	<desc>
4284	Attaches a device and optionally mounts a medium to the given storage
4285	controller (<link to="IStorageController" />, identified by @a name),
4286	at the indicated port and device.
4287
4288	This method is intended for managing storage devices in general while a
4289	machine is powered off. It can be used to attach and detach fixed
4290	and removeable media. The following kind of media can be attached
4291	to a machine:
4292
4293	<ul>
4294	<li>For fixed and removable media, you can pass in a medium that was
4295	previously opened using <link to="IVirtualBox::openMedium" />.
4296	</li>
4297
4298	<li>Only for storage devices supporting removable media (such as
4299	DVDs and floppies), you can also specify a null pointer to
4300	indicate an empty drive or one of the medium objects listed
4301	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4302	arrays to indicate a host drive.
4303	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4304	to change the media while the machine is running.
4305	</li>
4306	</ul>
4307
4308	In a VM's default configuration of virtual machines, the secondary
4309	master of the IDE controller is used for a CD/DVD drive.
4310
4311	After calling this returns successfully, a new instance of
4312	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4313	attachments (see <link to="IMachine::mediumAttachments"/>).
4314
4315	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4316	information about attaching media.
4317
4318	The specified device slot must not have a device attached to it,
4319	or this method will fail.
4320
4321	<note>
4322	You cannot attach a device to a newly created machine until
4323	this machine's settings are saved to disk using
4324	<link to="#saveSettings"/>.
4325	</note>
4326	<note>
4327	If the medium is being attached indirectly, a new differencing medium
4328	will implicitly be created for it and attached instead. If the
4329	changes made to the machine settings (including this indirect
4330	attachment) are later cancelled using <link to="#discardSettings"/>,
4331	this implicitly created differencing medium will implicitly
4332	be deleted.
4333	</note>
4334
4335	<result name="E_INVALIDARG">
4336	SATA device, SATA port, IDE port or IDE slot out of range, or
4337	file or UUID not found.
4338	</result>
4339	<result name="VBOX_E_INVALID_OBJECT_STATE">
4340	Machine must be registered before media can be attached.
4341	</result>
4342	<result name="VBOX_E_INVALID_VM_STATE">
4343	Invalid machine state.
4344	</result>
4345	<result name="VBOX_E_OBJECT_IN_USE">
4346	A medium is already attached to this or another virtual machine.
4347	</result>
4348
4349	</desc>
4350	<param name="name" type="wstring" dir="in">
4351	<desc>Name of the storage controller to attach the device to.</desc>
4352	</param>
4353	<param name="controllerPort" type="long" dir="in">
4354	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4355	the primary controller and 1 specifies the secondary controller.
4356	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4357	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4358	</param>
4359	<param name="device" type="long" dir="in">
4360	<desc>Device slot in the given port to attach the device to. This is only
4361	relevant for IDE controllers, for which 0 specifies the master device and
4362	1 specifies the slave device. For all other controller types, this must
4363	be 0.</desc>
4364	</param>
4365	<param name="type" type="DeviceType" dir="in">
4366	<desc>Device type of the attached device. For media opened by
4367	<link to="IVirtualBox::openMedium" />, this must match the device type
4368	specified there.</desc>
4369	</param>
4370	<param name="medium" type="IMedium" dir="in">
4371	<desc>Medium to mount or NULL for an empty drive.</desc>
4372	</param>
4373	</method>
4374
4375	<method name="detachDevice">
4376	<desc>
4377	Detaches the device attached to a device slot of the specified bus.
4378
4379	Detaching the device from the virtual machine is deferred. This means
4380	that the medium remains associated with the machine when this method
4381	returns and gets actually de-associated only after a successful
4382	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4383	for more detailed information about attaching media.
4384
4385	<note>
4386	You cannot detach a device from a running machine.
4387	</note>
4388	<note>
4389	Detaching differencing media implicitly created by <link
4390	to="#attachDevice"/> for the indirect attachment using this
4391	method will <b>not</b> implicitly delete them. The
4392	<link to="IMedium::deleteStorage"/> operation should be
4393	explicitly performed by the caller after the medium is successfully
4394	detached and the settings are saved with
4395	<link to="#saveSettings"/>, if it is the desired action.
4396	</note>
4397
4398	<result name="VBOX_E_INVALID_VM_STATE">
4399	Attempt to detach medium from a running virtual machine.
4400	</result>
4401	<result name="VBOX_E_OBJECT_NOT_FOUND">
4402	No medium attached to given slot/bus.
4403	</result>
4404	<result name="VBOX_E_NOT_SUPPORTED">
4405	Medium format does not support storage deletion.
4406	</result>
4407
4408	</desc>
4409	<param name="name" type="wstring" dir="in">
4410	<desc>Name of the storage controller to detach the medium from.</desc>
4411	</param>
4412	<param name="controllerPort" type="long" dir="in">
4413	<desc>Port number to detach the medium from.</desc>
4414	</param>
4415	<param name="device" type="long" dir="in">
4416	<desc>Device slot number to detach the medium from.</desc>
4417	</param>
4418	</method>
4419
4420	<method name="passthroughDevice">
4421	<desc>
4422	Sets the passthrough mode of an existing DVD device. Changing the
4423	setting while the VM is running is forbidden. The setting is only used
4424	if at VM start the device is configured as a host DVD drive, in all
4425	other cases it is ignored. The device must already exist; see
4426	<link to="IMachine::attachDevice"/> for how to attach a new device.
4427
4428	The @a controllerPort and @a device parameters specify the device slot and
4429	have have the same meaning as with <link to="IMachine::attachDevice" />.
4430
4431	<result name="E_INVALIDARG">
4432	SATA device, SATA port, IDE port or IDE slot out of range.
4433	</result>
4434	<result name="VBOX_E_INVALID_OBJECT_STATE">
4435	Attempt to modify an unregistered virtual machine.
4436	</result>
4437	<result name="VBOX_E_INVALID_VM_STATE">
4438	Invalid machine state.
4439	</result>
4440
4441	</desc>
4442	<param name="name" type="wstring" dir="in">
4443	<desc>Name of the storage controller.</desc>
4444	</param>
4445	<param name="controllerPort" type="long" dir="in">
4446	<desc>Storage controller port.</desc>
4447	</param>
4448	<param name="device" type="long" dir="in">
4449	<desc>Device slot in the given port.</desc>
4450	</param>
4451	<param name="passthrough" type="boolean" dir="in">
4452	<desc>New value for the passthrough setting.</desc>
4453	</param>
4454	</method>
4455
4456	<method name="mountMedium">
4457	<desc>
4458	Mounts a medium (<link to="IMedium" />, identified
4459	by the given UUID @a id) to the given storage controller
4460	(<link to="IStorageController" />, identified by @a name),
4461	at the indicated port and device. The device must already exist;
4462	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4463
4464	This method is intended only for managing removable media, where the
4465	device is fixed but media is changeable at runtime (such as DVDs
4466	and floppies). It cannot be used for fixed media such as hard disks.
4467
4468	The @a controllerPort and @a device parameters specify the device slot and
4469	have have the same meaning as with <link to="IMachine::attachDevice" />.
4470
4471	The specified device slot can have a medium mounted, which will be
4472	unmounted first. Specifying a zero UUID (or an empty string) for
4473	@a medium does just an unmount.
4474
4475	See <link to="IMedium"/> for more detailed information about
4476	attaching media.
4477
4478	<result name="E_INVALIDARG">
4479	SATA device, SATA port, IDE port or IDE slot out of range.
4480	</result>
4481	<result name="VBOX_E_INVALID_OBJECT_STATE">
4482	Attempt to attach medium to an unregistered virtual machine.
4483	</result>
4484	<result name="VBOX_E_INVALID_VM_STATE">
4485	Invalid machine state.
4486	</result>
4487	<result name="VBOX_E_OBJECT_IN_USE">
4488	Medium already attached to this or another virtual machine.
4489	</result>
4490
4491	</desc>
4492	<param name="name" type="wstring" dir="in">
4493	<desc>Name of the storage controller to attach the medium to.</desc>
4494	</param>
4495	<param name="controllerPort" type="long" dir="in">
4496	<desc>Port to attach the medium to.</desc>
4497	</param>
4498	<param name="device" type="long" dir="in">
4499	<desc>Device slot in the given port to attach the medium to.</desc>
4500	</param>
4501	<param name="medium" type="IMedium" dir="in">
4502	<desc>Medium to mount or NULL for an empty drive.</desc>
4503	</param>
4504	<param name="force" type="boolean" dir="in">
4505	<desc>Allows to force unmount/mount of a medium which is locked by
4506	the device slot in the given port to attach the medium to.</desc>
4507	</param>
4508	</method>
4509
4510	<method name="getMedium" const="yes">
4511	<desc>
4512	Returns the virtual medium attached to a device slot of the specified
4513	bus.
4514
4515	Note that if the medium was indirectly attached by
4516	<link to="#mountMedium"/> to the given device slot then this
4517	method will return not the same object as passed to the
4518	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4519	more detailed information about mounting a medium.
4520
4521	<result name="VBOX_E_OBJECT_NOT_FOUND">
4522	No medium attached to given slot/bus.
4523	</result>
4524
4525	</desc>
4526	<param name="name" type="wstring" dir="in">
4527	<desc>Name of the storage controller the medium is attached to.</desc>
4528	</param>
4529	<param name="controllerPort" type="long" dir="in">
4530	<desc>Port to query.</desc>
4531	</param>
4532	<param name="device" type="long" dir="in">
4533	<desc>Device slot in the given port to query.</desc>
4534	</param>
4535	<param name="medium" type="IMedium" dir="return">
4536	<desc>Attached medium object.</desc>
4537	</param>
4538	</method>
4539
4540	<method name="getMediumAttachmentsOfController" const="yes">
4541	<desc>
4542	Returns an array of medium attachments which are attached to the
4543	the controller with the given name.
4544
4545	<result name="VBOX_E_OBJECT_NOT_FOUND">
4546	A storage controller with given name doesn't exist.
4547	</result>
4548	</desc>
4549	<param name="name" type="wstring" dir="in"/>
4550	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4551	</method>
4552
4553	<method name="getMediumAttachment" const="yes">
4554	<desc>
4555	Returns a medium attachment which corresponds to the controller with
4556	the given name, on the given port and device slot.
4557
4558	<result name="VBOX_E_OBJECT_NOT_FOUND">
4559	No attachment exists for the given controller/port/device combination.
4560	</result>
4561	</desc>
4562	<param name="name" type="wstring" dir="in"/>
4563	<param name="controllerPort" type="long" dir="in"/>
4564	<param name="device" type="long" dir="in"/>
4565	<param name="attachment" type="IMediumAttachment" dir="return"/>
4566	</method>
4567
4568	<method name="getNetworkAdapter" const="yes">
4569	<desc>
4570	Returns the network adapter associated with the given slot.
4571	Slots are numbered sequentially, starting with zero. The total
4572	number of adapters per machine is defined by the
4573	<link to="ISystemProperties::networkAdapterCount"/> property,
4574	so the maximum slot number is one less than that property's value.
4575
4576	<result name="E_INVALIDARG">
4577	Invalid @a slot number.
4578	</result>
4579
4580	</desc>
4581	<param name="slot" type="unsigned long" dir="in"/>
4582	<param name="adapter" type="INetworkAdapter" dir="return"/>
4583	</method>
4584
4585	<method name="addStorageController">
4586	<desc>
4587	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4588	machine and returns it as an instance of
4589	<link to="IStorageController" />.
4590
4591	@a name identifies the controller for subsequent calls such as
4592	<link to="#getStorageControllerByName" />,
4593	<link to="#getStorageControllerByInstance" />,
4594	<link to="#removeStorageController" />,
4595	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4596
4597	After the controller has been added, you can set its exact
4598	type by setting the <link to="IStorageController::controllerType" />.
4599
4600	<result name="VBOX_E_OBJECT_IN_USE">
4601	A storage controller with given name exists already.
4602	</result>
4603	<result name="E_INVALIDARG">
4604	Invalid @a controllerType.
4605	</result>
4606	</desc>
4607	<param name="name" type="wstring" dir="in"/>
4608	<param name="connectionType" type="StorageBus" dir="in"/>
4609	<param name="controller" type="IStorageController" dir="return"/>
4610	</method>
4611
4612	<method name="getStorageControllerByName" const="yes">
4613	<desc>
4614	Returns a storage controller with the given name.
4615
4616	<result name="VBOX_E_OBJECT_NOT_FOUND">
4617	A storage controller with given name doesn't exist.
4618	</result>
4619	</desc>
4620	<param name="name" type="wstring" dir="in"/>
4621	<param name="storageController" type="IStorageController" dir="return"/>
4622	</method>
4623
4624	<method name="getStorageControllerByInstance" const="yes">
4625	<desc>
4626	Returns a storage controller with the given instance number.
4627
4628	<result name="VBOX_E_OBJECT_NOT_FOUND">
4629	A storage controller with given instance number doesn't exist.
4630	</result>
4631	</desc>
4632	<param name="instance" type="unsigned long" dir="in"/>
4633	<param name="storageController" type="IStorageController" dir="return"/>
4634	</method>
4635
4636	<method name="removeStorageController">
4637	<desc>
4638	Removes a storage controller from the machine.
4639
4640	<result name="VBOX_E_OBJECT_NOT_FOUND">
4641	A storage controller with given name doesn't exist.
4642	</result>
4643	</desc>
4644	<param name="name" type="wstring" dir="in"/>
4645	</method>
4646
4647	<method name="getSerialPort" const="yes">
4648	<desc>
4649	Returns the serial port associated with the given slot.
4650	Slots are numbered sequentially, starting with zero. The total
4651	number of serial ports per machine is defined by the
4652	<link to="ISystemProperties::serialPortCount"/> property,
4653	so the maximum slot number is one less than that property's value.
4654
4655	<result name="E_INVALIDARG">
4656	Invalid @a slot number.
4657	</result>
4658
4659	</desc>
4660	<param name="slot" type="unsigned long" dir="in"/>
4661	<param name="port" type="ISerialPort" dir="return"/>
4662	</method>
4663
4664	<method name="getParallelPort" const="yes">
4665	<desc>
4666	Returns the parallel port associated with the given slot.
4667	Slots are numbered sequentially, starting with zero. The total
4668	number of parallel ports per machine is defined by the
4669	<link to="ISystemProperties::parallelPortCount"/> property,
4670	so the maximum slot number is one less than that property's value.
4671
4672	<result name="E_INVALIDARG">
4673	Invalid @a slot number.
4674	</result>
4675
4676	</desc>
4677	<param name="slot" type="unsigned long" dir="in"/>
4678	<param name="port" type="IParallelPort" dir="return"/>
4679	</method>
4680
4681	<method name="getExtraDataKeys">
4682	<desc>
4683	Returns an array representing the machine-specific extra data keys
4684	which currently have values defined.
4685	</desc>
4686	<param name="value" type="wstring" dir="return" safearray="yes">
4687	<desc>Array of extra data keys.</desc>
4688	</param>
4689	</method>
4690
4691	<method name="getExtraData">
4692	<desc>
4693	Returns associated machine-specific extra data.
4694
4695	If the requested data @a key does not exist, this function will
4696	succeed and return an empty string in the @a value argument.
4697
4698	<result name="VBOX_E_FILE_ERROR">
4699	Settings file not accessible.
4700	</result>
4701	<result name="VBOX_E_XML_ERROR">
4702	Could not parse the settings file.
4703	</result>
4704
4705	</desc>
4706	<param name="key" type="wstring" dir="in">
4707	<desc>Name of the data key to get.</desc>
4708	</param>
4709	<param name="value" type="wstring" dir="return">
4710	<desc>Value of the requested data key.</desc>
4711	</param>
4712	</method>
4713
4714	<method name="setExtraData">
4715	<desc>
4716	Sets associated machine-specific extra data.
4717
4718	If you pass @c null or an empty string as a key @a value, the given
4719	@a key will be deleted.
4720
4721	<note>
4722	Before performing the actual data change, this method will ask all
4723	registered listeners using the
4724	<link to="IExtraDataCanChangeEvent"/>
4725	notification for a permission. If one of the listeners refuses the
4726	new value, the change will not be performed.
4727	</note>
4728	<note>
4729	On success, the
4730	<link to="IExtraDataChangedEvent"/> notification
4731	is called to inform all registered listeners about a successful data
4732	change.
4733	</note>
4734	<note>
4735	This method can be called outside the machine session and therefore
4736	it's a caller's responsibility to handle possible race conditions
4737	when several clients change the same key at the same time.
4738	</note>
4739
4740	<result name="VBOX_E_FILE_ERROR">
4741	Settings file not accessible.
4742	</result>
4743	<result name="VBOX_E_XML_ERROR">
4744	Could not parse the settings file.
4745	</result>
4746
4747	</desc>
4748	<param name="key" type="wstring" dir="in">
4749	<desc>Name of the data key to set.</desc>
4750	</param>
4751	<param name="value" type="wstring" dir="in">
4752	<desc>Value to assign to the key.</desc>
4753	</param>
4754	</method>
4755
4756	<method name="getCPUProperty" const="yes">
4757	<desc>
4758	Returns the virtual CPU boolean value of the specified property.
4759
4760	<result name="E_INVALIDARG">
4761	Invalid property.
4762	</result>
4763
4764	</desc>
4765	<param name="property" type="CPUPropertyType" dir="in">
4766	<desc>
4767	Property type to query.
4768	</desc>
4769	</param>
4770	<param name="value" type="boolean" dir="return">
4771	<desc>
4772	Property value.
4773	</desc>
4774	</param>
4775	</method>
4776
4777	<method name="setCPUProperty">
4778	<desc>
4779	Sets the virtual CPU boolean value of the specified property.
4780
4781	<result name="E_INVALIDARG">
4782	Invalid property.
4783	</result>
4784
4785	</desc>
4786	<param name="property" type="CPUPropertyType" dir="in">
4787	<desc>
4788	Property type to query.
4789	</desc>
4790	</param>
4791	<param name="value" type="boolean" dir="in">
4792	<desc>
4793	Property value.
4794	</desc>
4795	</param>
4796	</method>
4797
4798	<method name="getCPUIDLeaf" const="yes">
4799	<desc>
4800	Returns the virtual CPU cpuid information for the specified leaf.
4801
4802	Currently supported index values for cpuid:
4803	Standard CPUID leafs: 0 - 0xA
4804	Extended CPUID leafs: 0x80000000 - 0x8000000A
4805
4806	See the Intel and AMD programmer's manuals for detailed information
4807	about the cpuid instruction and its leafs.
4808	<result name="E_INVALIDARG">
4809	Invalid id.
4810	</result>
4811
4812	</desc>
4813	<param name="id" type="unsigned long" dir="in">
4814	<desc>
4815	CPUID leaf index.
4816	</desc>
4817	</param>
4818	<param name="valEax" type="unsigned long" dir="out">
4819	<desc>
4820	CPUID leaf value for register eax.
4821	</desc>
4822	</param>
4823	<param name="valEbx" type="unsigned long" dir="out">
4824	<desc>
4825	CPUID leaf value for register ebx.
4826	</desc>
4827	</param>
4828	<param name="valEcx" type="unsigned long" dir="out">
4829	<desc>
4830	CPUID leaf value for register ecx.
4831	</desc>
4832	</param>
4833	<param name="valEdx" type="unsigned long" dir="out">
4834	<desc>
4835	CPUID leaf value for register edx.
4836	</desc>
4837	</param>
4838	</method>
4839
4840	<method name="setCPUIDLeaf">
4841	<desc>
4842	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4843	are not passed unmodified. VirtualBox clears features that it doesn't support.
4844
4845	Currently supported index values for cpuid:
4846	Standard CPUID leafs: 0 - 0xA
4847	Extended CPUID leafs: 0x80000000 - 0x8000000A
4848
4849	See the Intel and AMD programmer's manuals for detailed information
4850	about the cpuid instruction and its leafs.
4851
4852	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4853	random crashes inside VMs.
4854	<result name="E_INVALIDARG">
4855	Invalid id.
4856	</result>
4857
4858	</desc>
4859	<param name="id" type="unsigned long" dir="in">
4860	<desc>
4861	CPUID leaf index.
4862	</desc>
4863	</param>
4864	<param name="valEax" type="unsigned long" dir="in">
4865	<desc>
4866	CPUID leaf value for register eax.
4867	</desc>
4868	</param>
4869	<param name="valEbx" type="unsigned long" dir="in">
4870	<desc>
4871	CPUID leaf value for register ebx.
4872	</desc>
4873	</param>
4874	<param name="valEcx" type="unsigned long" dir="in">
4875	<desc>
4876	CPUID leaf value for register ecx.
4877	</desc>
4878	</param>
4879	<param name="valEdx" type="unsigned long" dir="in">
4880	<desc>
4881	CPUID leaf value for register edx.
4882	</desc>
4883	</param>
4884	</method>
4885
4886	<method name="removeCPUIDLeaf">
4887	<desc>
4888	Removes the virtual CPU cpuid leaf for the specified index
4889
4890	<result name="E_INVALIDARG">
4891	Invalid id.
4892	</result>
4893
4894	</desc>
4895	<param name="id" type="unsigned long" dir="in">
4896	<desc>
4897	CPUID leaf index.
4898	</desc>
4899	</param>
4900	</method>
4901
4902	<method name="removeAllCPUIDLeaves">
4903	<desc>
4904	Removes all the virtual CPU cpuid leaves
4905	</desc>
4906	</method>
4907
4908	<method name="getHWVirtExProperty" const="yes">
4909	<desc>
4910	Returns the value of the specified hardware virtualization boolean property.
4911
4912	<result name="E_INVALIDARG">
4913	Invalid property.
4914	</result>
4915
4916	</desc>
4917	<param name="property" type="HWVirtExPropertyType" dir="in">
4918	<desc>
4919	Property type to query.
4920	</desc>
4921	</param>
4922	<param name="value" type="boolean" dir="return">
4923	<desc>
4924	Property value.
4925	</desc>
4926	</param>
4927	</method>
4928
4929	<method name="setHWVirtExProperty">
4930	<desc>
4931	Sets a new value for the specified hardware virtualization boolean property.
4932
4933	<result name="E_INVALIDARG">
4934	Invalid property.
4935	</result>
4936
4937	</desc>
4938	<param name="property" type="HWVirtExPropertyType" dir="in">
4939	<desc>
4940	Property type to set.
4941	</desc>
4942	</param>
4943	<param name="value" type="boolean" dir="in">
4944	<desc>
4945	New property value.
4946	</desc>
4947	</param>
4948	</method>
4949
4950	<method name="saveSettings">
4951	<desc>
4952	Saves any changes to machine settings made since the session
4953	has been opened or a new machine has been created, or since the
4954	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4955	For registered machines, new settings become visible to all
4956	other VirtualBox clients after successful invocation of this
4957	method.
4958	<note>
4959	The method sends <link to="IMachineDataChangedEvent"/>
4960	notification event after the configuration has been successfully
4961	saved (only for registered machines).
4962	</note>
4963	<note>
4964	Calling this method is only valid on instances returned
4965	by <link to="ISession::machine"/> and on new machines
4966	created by <link to="IVirtualBox::createMachine"/> but not
4967	yet registered, or on unregistered machines after calling
4968	<link to="IMachine::unregister"/>.
4969	</note>
4970
4971	<result name="VBOX_E_FILE_ERROR">
4972	Settings file not accessible.
4973	</result>
4974	<result name="VBOX_E_XML_ERROR">
4975	Could not parse the settings file.
4976	</result>
4977	<result name="E_ACCESSDENIED">
4978	Modification request refused.
4979	</result>
4980
4981	</desc>
4982	</method>
4983
4984	<method name="discardSettings">
4985	<desc>
4986	Discards any changes to the machine settings made since the session
4987	has been opened or since the last call to <link to="#saveSettings"/>
4988	or <link to="#discardSettings"/>.
4989	<note>
4990	Calling this method is only valid on instances returned
4991	by <link to="ISession::machine"/> and on new machines
4992	created by <link to="IVirtualBox::createMachine"/> or
4993	opened by <link to="IVirtualBox::openMachine"/> but not
4994	yet registered, or on unregistered machines after calling
4995	<link to="IMachine::unregister"/>.
4996	</note>
4997
4998	<result name="VBOX_E_INVALID_VM_STATE">
4999	Virtual machine is not mutable.
5000	</result>
5001
5002	</desc>
5003	</method>
5004
5005	<method name="unregister">
5006	<desc>
5007	Unregisters the machine, which must have been previously registered using
5008	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5009	cleanup before the machine is unregistered.
5010
5011	This method does not delete any files. It only changes the machine configuration and
5012	the list of registered machines in the VirtualBox object. To delete the files which
5013	belonged to the machine, including the XML file of the machine itself, call
5014	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5015	from this method.
5016
5017	How thoroughly this method cleans up the machine configuration before unregistering
5018	the machine depends on the @a cleanupMode argument.
5019
5020	<ul>
5021	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5022	cleanup will be performed. The call will fail if the machine is in "Saved" state
5023	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5024	It is the responsibility of the caller to delete all such configuration in this mode.
5025	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5026	which it replaces.</li>
5027	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5028	state or if it has snapshots or media attached. All media attached to the current machine
5029	state or in snapshots will be detached. No medium objects will be returned; all of the
5030	machine's media will remain open.</li>
5031	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5032	except that all the hard disk medium objects which were detached from the machine will
5033	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5034	API for closing and deletion.</li>
5035	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5036	that all media will be returned in the array, including removeable media like DVDs and
5037	floppies. This might be useful if the user wants to inspect in detail which media were
5038	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5039	in that case because users will typically want to preserve ISO and RAW image files.</li>
5040	</ul>
5041
5042	This API does not verify whether the media files returned in the array are still
5043	attached to other machines (i.e. shared between several machines). If such a shared
5044	image is passed to <link to="#delete" /> however, closing the image will fail there
5045	and the image will be silently skipped.
5046
5047	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5048	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5049	deleted with all its saved states and hard disk images, but images for removeable
5050	drives (such as ISO and RAW files) will remain on disk.
5051
5052	The call will fail if the machine is currently locked (see <link to="ISession" />).
5053	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5054	before unregistering it.
5055
5056	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5057	is fired.
5058
5059	<note>
5060	If the given machine is inaccessible (see <link to="#accessible"/>), it
5061	will be unregistered and fully uninitialized right afterwards. As a result,
5062	the returned machine object will be unusable and an attempt to call
5063	<b>any</b> method will return the "Object not ready" error.
5064	</note>
5065
5066	<result name="VBOX_E_INVALID_OBJECT_STATE">
5067	Machine is currently locked for a session.
5068	</result>
5069	</desc>
5070
5071	<param name="cleanupMode" type="CleanupMode" dir="in">
5072	<desc>How to clean up after the machine has been unregistered.</desc>
5073	</param>
5074	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5075	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5076	</param>
5077	</method>
5078
5079	<method name="delete">
5080	<desc>
5081	Deletes the files associated with this machine from disk. If medium objects are passed
5082	in with the @a aMedia argument, they are closed and, if closing was successful, their
5083	storage files are deleted as well. For convenience, this array of media files can be
5084	the same as the one returned from a previous <link to="#unregister" /> call.
5085
5086	This method must only be called on machines which are either write-locked (i.e. on instances
5087	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5088	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5089	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5090
5091	The following files will be deleted by this method:
5092	<ul>
5093	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5094	argument other than "UnregisterOnly", this will delete all saved state files that
5095	the machine had in use; possibly one if the machine was in "Saved" state and one
5096	for each online snapshot that the machine had.</li>
5097	<li>On each medium object passed in the @a aMedia array, this will call
5098	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5099	medium's storage on disk. Since the close() call will fail if the medium is still
5100	in use, e.g. because it is still attached to a second machine; in that case the
5101	storage will not be deleted.</li>
5102	<li>Finally, the machine's own XML file will be deleted.</li>
5103	</ul>
5104
5105	Since deleting large disk image files can be a time-consuming I/O operation, this
5106	method operates asynchronously and returns an IProgress object to allow the caller
5107	to monitor the progress. There will be one sub-operation for each file that is
5108	being deleted (saved state or medium storage file).
5109
5110	<note>
5111	<link to="#settingsModified"/> will return @c true after this
5112	method successfully returns.
5113	</note>
5114
5115	<result name="VBOX_E_INVALID_VM_STATE">
5116	Machine is registered but not write-locked.
5117	</result>
5118	<result name="VBOX_E_IPRT_ERROR">
5119	Could not delete the settings file.
5120	</result>
5121	</desc>
5122	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5123	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5124	</param>
5125	<param name="aProgress" type="IProgress" dir="return">
5126	<desc>Progress object to track the operation completion.</desc>
5127	</param>
5128	</method>
5129
5130	<method name="export">
5131	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5132	steps required to export VirtualBox machines to OVF.
5133	</desc>
5134
5135	<param name="aAppliance" type="IAppliance" dir="in">
5136	<desc>Appliance to export this machine to.</desc>
5137	</param>
5138	<param name="location" type="wstring" dir="in">
5139	<desc>The target location.</desc>
5140	</param>
5141	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5142	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5143	</param>
5144	</method >
5145
5146	<method name="findSnapshot">
5147	<desc>
5148	Returns a snapshot of this machine with the given name or UUID.
5149
5150	Returns a snapshot of this machine with the given UUID.
5151	A @c null argument can be used to obtain the first snapshot
5152	taken on this machine. This is useful if you want to traverse
5153	the whole tree of snapshots starting from the root.
5154
5155	<result name="VBOX_E_OBJECT_NOT_FOUND">
5156	Virtual machine has no snapshots or snapshot not found.
5157	</result>
5158
5159	</desc>
5160	<param name="nameOrId" type="wstring" dir="in">
5161	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5162	</param>
5163	<param name="snapshot" type="ISnapshot" dir="return">
5164	<desc>Snapshot object with the given name.</desc>
5165	</param>
5166	</method>
5167
5168	<method name="createSharedFolder">
5169	<desc>
5170	Creates a new permanent shared folder by associating the given logical
5171	name with the given host path, adds it to the collection of shared
5172	folders and starts sharing it. Refer to the description of
5173	<link to="ISharedFolder"/> to read more about logical names.
5174
5175	<result name="VBOX_E_OBJECT_IN_USE">
5176	Shared folder already exists.
5177	</result>
5178	<result name="VBOX_E_FILE_ERROR">
5179	Shared folder @a hostPath not accessible.
5180	</result>
5181
5182	</desc>
5183	<param name="name" type="wstring" dir="in">
5184	<desc>Unique logical name of the shared folder.</desc>
5185	</param>
5186	<param name="hostPath" type="wstring" dir="in">
5187	<desc>Full path to the shared folder in the host file system.</desc>
5188	</param>
5189	<param name="writable" type="boolean" dir="in">
5190	<desc>Whether the share is writable or readonly.</desc>
5191	</param>
5192	<param name="automount" type="boolean" dir="in">
5193	<desc>Whether the share gets automatically mounted by the guest
5194	or not.</desc>
5195	</param>
5196	</method>
5197
5198	<method name="removeSharedFolder">
5199	<desc>
5200	Removes the permanent shared folder with the given name previously
5201	created by <link to="#createSharedFolder"/> from the collection of
5202	shared folders and stops sharing it.
5203
5204	<result name="VBOX_E_INVALID_VM_STATE">
5205	Virtual machine is not mutable.
5206	</result>
5207	<result name="VBOX_E_OBJECT_NOT_FOUND">
5208	Shared folder @a name does not exist.
5209	</result>
5210
5211	</desc>
5212	<param name="name" type="wstring" dir="in">
5213	<desc>Logical name of the shared folder to remove.</desc>
5214	</param>
5215	</method>
5216
5217	<method name="canShowConsoleWindow">
5218	<desc>
5219	Returns @c true if the VM console process can activate the
5220	console window and bring it to foreground on the desktop of
5221	the host PC.
5222	<note>
5223	This method will fail if a session for this machine is not
5224	currently open.
5225	</note>
5226
5227	<result name="VBOX_E_INVALID_VM_STATE">
5228	Machine session is not open.
5229	</result>
5230
5231	</desc>
5232	<param name="canShow" type="boolean" dir="return">
5233	<desc>
5234	@c true if the console window can be shown and @c false otherwise.
5235	</desc>
5236	</param>
5237	</method>
5238
5239	<method name="showConsoleWindow">
5240	<desc>
5241	Activates the console window and brings it to foreground on
5242	the desktop of the host PC. Many modern window managers on
5243	many platforms implement some sort of focus stealing
5244	prevention logic, so that it may be impossible to activate
5245	a window without the help of the currently active
5246	application. In this case, this method will return a non-zero
5247	identifier that represents the top-level window of the VM
5248	console process. The caller, if it represents a currently
5249	active process, is responsible to use this identifier (in a
5250	platform-dependent manner) to perform actual window
5251	activation.
5252	<note>
5253	This method will fail if a session for this machine is not
5254	currently open.
5255	</note>
5256
5257	<result name="VBOX_E_INVALID_VM_STATE">
5258	Machine session is not open.
5259	</result>
5260
5261	</desc>
5262	<param name="winId" type="long long" dir="return">
5263	<desc>
5264	Platform-dependent identifier of the top-level VM console
5265	window, or zero if this method has performed all actions
5266	necessary to implement the <i>show window</i> semantics for
5267	the given platform and/or VirtualBox front-end.
5268	</desc>
5269	</param>
5270	</method>
5271
5272	<method name="getGuestProperty" const="yes">
5273	<desc>
5274	Reads an entry from the machine's guest property store.
5275
5276	<result name="VBOX_E_INVALID_VM_STATE">
5277	Machine session is not open.
5278	</result>
5279
5280	</desc>
5281	<param name="name" type="wstring" dir="in">
5282	<desc>
5283	The name of the property to read.
5284	</desc>
5285	</param>
5286	<param name="value" type="wstring" dir="out">
5287	<desc>
5288	The value of the property. If the property does not exist then this
5289	will be empty.
5290	</desc>
5291	</param>
5292	<param name="timestamp" type="long long" dir="out">
5293	<desc>
5294	The time at which the property was last modified, as seen by the
5295	server process.
5296	</desc>
5297	</param>
5298	<param name="flags" type="wstring" dir="out">
5299	<desc>
5300	Additional property parameters, passed as a comma-separated list of
5301	"name=value" type entries.
5302	</desc>
5303	</param>
5304	</method>
5305
5306	<method name="getGuestPropertyValue" const="yes">
5307	<desc>
5308	Reads a value from the machine's guest property store.
5309
5310	<result name="VBOX_E_INVALID_VM_STATE">
5311	Machine session is not open.
5312	</result>
5313
5314	</desc>
5315	<param name="property" type="wstring" dir="in">
5316	<desc>
5317	The name of the property to read.
5318	</desc>
5319	</param>
5320	<param name="value" type="wstring" dir="return">
5321	<desc>
5322	The value of the property. If the property does not exist then this
5323	will be empty.
5324	</desc>
5325	</param>
5326	</method>
5327
5328	<method name="getGuestPropertyTimestamp" const="yes">
5329	<desc>
5330	Reads a property timestamp from the machine's guest property store.
5331
5332	<result name="VBOX_E_INVALID_VM_STATE">
5333	Machine session is not open.
5334	</result>
5335
5336	</desc>
5337	<param name="property" type="wstring" dir="in">
5338	<desc>
5339	The name of the property to read.
5340	</desc>
5341	</param>
5342	<param name="value" type="long long" dir="return">
5343	<desc>
5344	The timestamp. If the property does not exist then this will be
5345	empty.
5346	</desc>
5347	</param>
5348	</method>
5349
5350	<method name="setGuestProperty">
5351	<desc>
5352	Sets, changes or deletes an entry in the machine's guest property
5353	store.
5354
5355	<result name="E_ACCESSDENIED">
5356	Property cannot be changed.
5357	</result>
5358	<result name="E_INVALIDARG">
5359	Invalid @a flags.
5360	</result>
5361	<result name="VBOX_E_INVALID_VM_STATE">
5362	Virtual machine is not mutable or session not open.
5363	</result>
5364	<result name="VBOX_E_INVALID_OBJECT_STATE">
5365	Cannot set transient property when machine not running.
5366	</result>
5367
5368	</desc>
5369	<param name="property" type="wstring" dir="in">
5370	<desc>
5371	The name of the property to set, change or delete.
5372	</desc>
5373	</param>
5374	<param name="value" type="wstring" dir="in">
5375	<desc>
5376	The new value of the property to set, change or delete. If the
5377	property does not yet exist and value is non-empty, it will be
5378	created. If the value is @c null or empty, the property will be
5379	deleted if it exists.
5380	</desc>
5381	</param>
5382	<param name="flags" type="wstring" dir="in">
5383	<desc>
5384	Additional property parameters, passed as a comma-separated list of
5385	"name=value" type entries.
5386	</desc>
5387	</param>
5388	</method>
5389
5390	<method name="setGuestPropertyValue">
5391	<desc>
5392	Sets, changes or deletes a value in the machine's guest property
5393	store. The flags field will be left unchanged or created empty for a
5394	new property.
5395
5396	<result name="E_ACCESSDENIED">
5397	Property cannot be changed.
5398	</result>
5399	<result name="VBOX_E_INVALID_VM_STATE">
5400	Virtual machine is not mutable or session not open.
5401	</result>
5402	<result name="VBOX_E_INVALID_OBJECT_STATE">
5403	Cannot set transient property when machine not running.
5404	</result>
5405	</desc>
5406
5407	<param name="property" type="wstring" dir="in">
5408	<desc>
5409	The name of the property to set, change or delete.
5410	</desc>
5411	</param>
5412	<param name="value" type="wstring" dir="in">
5413	<desc>
5414	The new value of the property to set, change or delete. If the
5415	property does not yet exist and value is non-empty, it will be
5416	created. If the value is @c null or empty, the property will be
5417	deleted if it exists.
5418	</desc>
5419	</param>
5420	</method>
5421
5422	<method name="enumerateGuestProperties">
5423	<desc>
5424	Return a list of the guest properties matching a set of patterns along
5425	with their values, time stamps and flags.
5426	</desc>
5427	<param name="patterns" type="wstring" dir="in">
5428	<desc>
5429	The patterns to match the properties against, separated by '\|'
5430	characters. If this is empty or @c null, all properties will match.
5431	</desc>
5432	</param>
5433	<param name="name" type="wstring" dir="out" safearray="yes">
5434	<desc>
5435	The names of the properties returned.
5436	</desc>
5437	</param>
5438	<param name="value" type="wstring" dir="out" safearray="yes">
5439	<desc>
5440	The values of the properties returned. The array entries match the
5441	corresponding entries in the @a name array.
5442	</desc>
5443	</param>
5444	<param name="timestamp" type="long long" dir="out" safearray="yes">
5445	<desc>
5446	The time stamps of the properties returned. The array entries match
5447	the corresponding entries in the @a name array.
5448	</desc>
5449	</param>
5450	<param name="flags" type="wstring" dir="out" safearray="yes">
5451	<desc>
5452	The flags of the properties returned. The array entries match the
5453	corresponding entries in the @a name array.
5454	</desc>
5455	</param>
5456	</method>
5457
5458	<method name="querySavedGuestSize">
5459	<desc>
5460	Returns the guest dimensions from the saved state.
5461	</desc>
5462	<param name="screenId" type="unsigned long" dir="in">
5463	<desc>
5464	Saved guest screen to query info from.
5465	</desc>
5466	</param>
5467	<param name="width" type="unsigned long" dir="out">
5468	<desc>
5469	Guest width at the time of the saved state was taken.
5470	</desc>
5471	</param>
5472	<param name="height" type="unsigned long" dir="out">
5473	<desc>
5474	Guest height at the time of the saved state was taken.
5475	</desc>
5476	</param>
5477	</method>
5478
5479	<method name="querySavedThumbnailSize">
5480	<desc>
5481	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5482	</desc>
5483	<param name="screenId" type="unsigned long" dir="in">
5484	<desc>
5485	Saved guest screen to query info from.
5486	</desc>
5487	</param>
5488	<param name="size" type="unsigned long" dir="out">
5489	<desc>
5490	Size of buffer required to store the bitmap.
5491	</desc>
5492	</param>
5493	<param name="width" type="unsigned long" dir="out">
5494	<desc>
5495	Bitmap width.
5496	</desc>
5497	</param>
5498	<param name="height" type="unsigned long" dir="out">
5499	<desc>
5500	Bitmap height.
5501	</desc>
5502	</param>
5503	</method>
5504
5505	<method name="readSavedThumbnailToArray">
5506	<desc>
5507	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5508	</desc>
5509	<param name="screenId" type="unsigned long" dir="in">
5510	<desc>
5511	Saved guest screen to read from.
5512	</desc>
5513	</param>
5514	<param name="BGR" type="boolean" dir="in">
5515	<desc>
5516	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5517	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5518	</desc>
5519	</param>
5520	<param name="width" type="unsigned long" dir="out">
5521	<desc>
5522	Bitmap width.
5523	</desc>
5524	</param>
5525	<param name="height" type="unsigned long" dir="out">
5526	<desc>
5527	Bitmap height.
5528	</desc>
5529	</param>
5530	<param name="data" type="octet" safearray="yes" dir="return">
5531	<desc>
5532	Array with resulting bitmap data.
5533	</desc>
5534	</param>
5535	</method>
5536
5537	<method name="readSavedThumbnailPNGToArray">
5538	<desc>
5539	Thumbnail in PNG format is retrieved to an array of bytes.
5540	</desc>
5541	<param name="screenId" type="unsigned long" dir="in">
5542	<desc>
5543	Saved guest screen to read from.
5544	</desc>
5545	</param>
5546	<param name="width" type="unsigned long" dir="out">
5547	<desc>
5548	Image width.
5549	</desc>
5550	</param>
5551	<param name="height" type="unsigned long" dir="out">
5552	<desc>
5553	Image height.
5554	</desc>
5555	</param>
5556	<param name="data" type="octet" dir="return" safearray="yes">
5557	<desc>
5558	Array with resulting PNG data.
5559	</desc>
5560	</param>
5561	</method>
5562
5563	<method name="querySavedScreenshotPNGSize">
5564	<desc>
5565	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5566	</desc>
5567	<param name="screenId" type="unsigned long" dir="in">
5568	<desc>
5569	Saved guest screen to query info from.
5570	</desc>
5571	</param>
5572	<param name="size" type="unsigned long" dir="out">
5573	<desc>
5574	Size of buffer required to store the PNG binary data.
5575	</desc>
5576	</param>
5577	<param name="width" type="unsigned long" dir="out">
5578	<desc>
5579	Image width.
5580	</desc>
5581	</param>
5582	<param name="height" type="unsigned long" dir="out">
5583	<desc>
5584	Image height.
5585	</desc>
5586	</param>
5587	</method>
5588
5589	<method name="readSavedScreenshotPNGToArray">
5590	<desc>
5591	Screenshot in PNG format is retrieved to an array of bytes.
5592	</desc>
5593	<param name="screenId" type="unsigned long" dir="in">
5594	<desc>
5595	Saved guest screen to read from.
5596	</desc>
5597	</param>
5598	<param name="width" type="unsigned long" dir="out">
5599	<desc>
5600	Image width.
5601	</desc>
5602	</param>
5603	<param name="height" type="unsigned long" dir="out">
5604	<desc>
5605	Image height.
5606	</desc>
5607	</param>
5608	<param name="data" type="octet" dir="return" safearray="yes">
5609	<desc>
5610	Array with resulting PNG data.
5611	</desc>
5612	</param>
5613	</method>
5614
5615	<method name="hotPlugCPU">
5616	<desc>
5617	Plugs a CPU into the machine.
5618	</desc>
5619	<param name="cpu" type="unsigned long" dir="in">
5620	<desc>
5621	The CPU id to insert.
5622	</desc>
5623	</param>
5624	</method>
5625
5626	<method name="hotUnplugCPU">
5627	<desc>
5628	Removes a CPU from the machine.
5629	</desc>
5630	<param name="cpu" type="unsigned long" dir="in">
5631	<desc>
5632	The CPU id to remove.
5633	</desc>
5634	</param>
5635	</method>
5636
5637	<method name="getCPUStatus">
5638	<desc>
5639	Returns the current status of the given CPU.
5640	</desc>
5641	<param name="cpu" type="unsigned long" dir="in">
5642	<desc>
5643	The CPU id to check for.
5644	</desc>
5645	</param>
5646	<param name="attached" type="boolean" dir="return">
5647	<desc>
5648	Status of the CPU.
5649	</desc>
5650	</param>
5651	</method>
5652
5653	<method name="queryLogFilename">
5654	<desc>
5655	Queries for the VM log file name of an given index. Returns an empty
5656	string if a log file with that index doesn't exists.
5657	</desc>
5658	<param name="idx" type="unsigned long" dir="in">
5659	<desc>
5660	Which log file name to query. 0=current log file.
5661	</desc>
5662	</param>
5663	<param name="filename" type="wstring" dir="return">
5664	<desc>
5665	On return the full path to the log file or an empty string on error.
5666	</desc>
5667	</param>
5668	</method>
5669
5670	<method name="readLog">
5671	<desc>
5672	Reads the VM log file. The chunk size is limited, so even if you
5673	ask for a big piece there might be less data returned.
5674	</desc>
5675	<param name="idx" type="unsigned long" dir="in">
5676	<desc>
5677	Which log file to read. 0=current log file.
5678	</desc>
5679	</param>
5680	<param name="offset" type="long long" dir="in">
5681	<desc>
5682	Offset in the log file.
5683	</desc>
5684	</param>
5685	<param name="size" type="long long" dir="in">
5686	<desc>
5687	Chunk size to read in the log file.
5688	</desc>
5689	</param>
5690	<param name="data" type="octet" dir="return" safearray="yes">
5691	<desc>
5692	Data read from the log file. A data size of 0 means end of file
5693	if the requested chunk size was not 0. This is the unprocessed
5694	file data, i.e. the line ending style depends on the platform of
5695	the system the server is running on.
5696	</desc>
5697	</param>
5698	</method>
5699	</interface>
5700
5701	<!--
5702	// IConsole
5703	/////////////////////////////////////////////////////////////////////////
5704	-->
5705
5706	<interface
5707	name="IVRDEServerInfo" extends="$unknown"
5708	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5709	wsmap="struct"
5710	>
5711	<desc>
5712	Contains information about the remote desktop (VRDE) server capabilities and status.
5713	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5714	</desc>
5715
5716	<attribute name="active" type="boolean" readonly="yes">
5717	<desc>
5718	Whether the remote desktop connection is active.
5719	</desc>
5720	</attribute>
5721
5722	<attribute name="port" type="long" readonly="yes">
5723	<desc>
5724	VRDE server port number. If this property is equal to <tt>0</tt>, then
5725	the VRDE server failed to start, usually because there are no free IP
5726	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5727	server has not yet been started.
5728	</desc>
5729	</attribute>
5730
5731	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5732	<desc>
5733	How many times a client connected.
5734	</desc>
5735	</attribute>
5736
5737	<attribute name="beginTime" type="long long" readonly="yes">
5738	<desc>
5739	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5740	</desc>
5741	</attribute>
5742
5743	<attribute name="endTime" type="long long" readonly="yes">
5744	<desc>
5745	When the last connection was terminated or the current time, if
5746	connection is still active, in milliseconds since 1970-01-01 UTC.
5747	</desc>
5748	</attribute>
5749
5750	<attribute name="bytesSent" type="long long" readonly="yes">
5751	<desc>
5752	How many bytes were sent in last or current, if still active, connection.
5753	</desc>
5754	</attribute>
5755
5756	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5757	<desc>
5758	How many bytes were sent in all connections.
5759	</desc>
5760	</attribute>
5761
5762	<attribute name="bytesReceived" type="long long" readonly="yes">
5763	<desc>
5764	How many bytes were received in last or current, if still active, connection.
5765	</desc>
5766	</attribute>
5767
5768	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5769	<desc>
5770	How many bytes were received in all connections.
5771	</desc>
5772	</attribute>
5773
5774	<attribute name="user" type="wstring" readonly="yes">
5775	<desc>
5776	Login user name supplied by the client.
5777	</desc>
5778	</attribute>
5779
5780	<attribute name="domain" type="wstring" readonly="yes">
5781	<desc>
5782	Login domain name supplied by the client.
5783	</desc>
5784	</attribute>
5785
5786	<attribute name="clientName" type="wstring" readonly="yes">
5787	<desc>
5788	The client name supplied by the client.
5789	</desc>
5790	</attribute>
5791
5792	<attribute name="clientIP" type="wstring" readonly="yes">
5793	<desc>
5794	The IP address of the client.
5795	</desc>
5796	</attribute>
5797
5798	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5799	<desc>
5800	The client software version number.
5801	</desc>
5802	</attribute>
5803
5804	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5805	<desc>
5806	Public key exchange method used when connection was established.
5807	Values: 0 - RDP4 public key exchange scheme.
5808	1 - X509 certificates were sent to client.
5809	</desc>
5810	</attribute>
5811
5812	</interface>
5813
5814	<interface
5815	name="IConsole" extends="$unknown"
5816	uuid="3c4a453e-d27b-44a2-b59d-dda6e1835e57"
5817	wsmap="managed"
5818	>
5819	<desc>
5820	The IConsole interface represents an interface to control virtual
5821	machine execution.
5822
5823	A console object gets created when a machine has been locked for a
5824	particular session (client process) using <link to="IMachine::lockMachine" />
5825	or <link to="IMachine::launchVMProcess"/>. The console object can
5826	then be found in the session's <link to="ISession::console" /> attribute.
5827
5828	Methods of the IConsole interface allow the caller to query the current
5829	virtual machine execution state, pause the machine or power it down, save
5830	the machine state or take a snapshot, attach and detach removable media
5831	and so on.
5832
5833	<see>ISession</see>
5834	</desc>
5835
5836	<attribute name="machine" type="IMachine" readonly="yes">
5837	<desc>
5838	Machine object for this console session.
5839	<note>
5840	This is a convenience property, it has the same value as
5841	<link to="ISession::machine"/> of the corresponding session
5842	object.
5843	</note>
5844	</desc>
5845	</attribute>
5846
5847	<attribute name="state" type="MachineState" readonly="yes">
5848	<desc>
5849	Current execution state of the machine.
5850	<note>
5851	This property always returns the same value as the corresponding
5852	property of the IMachine object for this console session.
5853	For the process that owns (executes) the VM, this is the
5854	preferable way of querying the VM state, because no IPC
5855	calls are made.
5856	</note>
5857	</desc>
5858	</attribute>
5859
5860	<attribute name="guest" type="IGuest" readonly="yes">
5861	<desc>Guest object.</desc>
5862	</attribute>
5863
5864	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5865	<desc>
5866	Virtual keyboard object.
5867	<note>
5868	If the machine is not running, any attempt to use
5869	the returned object will result in an error.
5870	</note>
5871	</desc>
5872	</attribute>
5873
5874	<attribute name="mouse" type="IMouse" readonly="yes">
5875	<desc>
5876	Virtual mouse object.
5877	<note>
5878	If the machine is not running, any attempt to use
5879	the returned object will result in an error.
5880	</note>
5881	</desc>
5882	</attribute>
5883
5884	<attribute name="display" type="IDisplay" readonly="yes">
5885	<desc>Virtual display object.
5886	<note>
5887	If the machine is not running, any attempt to use
5888	the returned object will result in an error.
5889	</note>
5890	</desc>
5891	</attribute>
5892
5893	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5894	<desc>Debugging interface.</desc>
5895	</attribute>
5896
5897	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5898	<desc>
5899	Collection of USB devices currently attached to the virtual
5900	USB controller.
5901	<note>
5902	The collection is empty if the machine is not running.
5903	</note>
5904	</desc>
5905	</attribute>
5906
5907	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5908	<desc>
5909	List of USB devices currently attached to the remote VRDE client.
5910	Once a new device is physically attached to the remote host computer,
5911	it appears in this list and remains there until detached.
5912	</desc>
5913	</attribute>
5914
5915	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5916	<desc>
5917	Collection of shared folders for the current session. These folders
5918	are called transient shared folders because they are available to the
5919	guest OS running inside the associated virtual machine only for the
5920	duration of the session (as opposed to
5921	<link to="IMachine::sharedFolders"/> which represent permanent shared
5922	folders). When the session is closed (e.g. the machine is powered down),
5923	these folders are automatically discarded.
5924
5925	New shared folders are added to the collection using
5926	<link to="#createSharedFolder"/>. Existing shared folders can be
5927	removed using <link to="#removeSharedFolder"/>.
5928	</desc>
5929	</attribute>
5930
5931	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
5932	<desc>
5933	Interface that provides information on Remote Desktop Extension (VRDE) connection.
5934	</desc>
5935	</attribute>
5936
5937	<attribute name="eventSource" type="IEventSource" readonly="yes">
5938	<desc>
5939	Event source for console events.
5940	</desc>
5941	</attribute>
5942
5943	<method name="powerUp">
5944	<desc>
5945	Starts the virtual machine execution using the current machine
5946	state (that is, its current execution state, current settings and
5947	current storage devices).
5948
5949	<note>
5950	This method is only useful for front-ends that want to actually
5951	execute virtual machines in their own process (like the VirtualBox
5952	or VBoxSDL front-ends). Unless you are intending to write such a
5953	front-end, do not call this method. If you simply want to
5954	start virtual machine execution using one of the existing front-ends
5955	(for example the VirtualBox GUI or headless server), use
5956	<link to="IMachine::launchVMProcess"/> instead; these
5957	front-ends will power up the machine automatically for you.
5958	</note>
5959
5960	If the machine is powered off or aborted, the execution will
5961	start from the beginning (as if the real hardware were just
5962	powered on).
5963
5964	If the machine is in the <link to="MachineState_Saved"/> state,
5965	it will continue its execution the point where the state has
5966	been saved.
5967
5968	If the machine <link to="IMachine::teleporterEnabled"/> property is
5969	enabled on the machine being powered up, the machine will wait for an
5970	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
5971	state. The returned progress object will have at least three
5972	operations where the last three are defined as: (1) powering up and
5973	starting TCP server, (2) waiting for incoming teleportations, and
5974	(3) perform teleportation. These operations will be reflected as the
5975	last three operations of the progress objected returned by
5976	<link to="IMachine::launchVMProcess"/> as well.
5977
5978	<see>#saveState</see>
5979
5980	<result name="VBOX_E_INVALID_VM_STATE">
5981	Virtual machine already running.
5982	</result>
5983	<result name="VBOX_E_HOST_ERROR">
5984	Host interface does not exist or name not set.
5985	</result>
5986	<result name="VBOX_E_FILE_ERROR">
5987	Invalid saved state file.
5988	</result>
5989	</desc>
5990	<param name="progress" type="IProgress" dir="return">
5991	<desc>Progress object to track the operation completion.</desc>
5992	</param>
5993	</method>
5994
5995	<method name="powerUpPaused">
5996	<desc>
5997	Identical to powerUp except that the VM will enter the
5998	<link to="MachineState_Paused"/> state, instead of
5999	<link to="MachineState_Running"/>.
6000
6001	<see>#powerUp</see>
6002	<result name="VBOX_E_INVALID_VM_STATE">
6003	Virtual machine already running.
6004	</result>
6005	<result name="VBOX_E_HOST_ERROR">
6006	Host interface does not exist or name not set.
6007	</result>
6008	<result name="VBOX_E_FILE_ERROR">
6009	Invalid saved state file.
6010	</result>
6011	</desc>
6012	<param name="progress" type="IProgress" dir="return">
6013	<desc>Progress object to track the operation completion.</desc>
6014	</param>
6015	</method>
6016
6017	<method name="powerDown">
6018	<desc>
6019	Initiates the power down procedure to stop the virtual machine
6020	execution.
6021
6022	The completion of the power down procedure is tracked using the returned
6023	IProgress object. After the operation is complete, the machine will go
6024	to the PoweredOff state.
6025	<result name="VBOX_E_INVALID_VM_STATE">
6026	Virtual machine must be Running, Paused or Stuck to be powered down.
6027	</result>
6028	</desc>
6029	<param name="progress" type="IProgress" dir="return">
6030	<desc>Progress object to track the operation completion.</desc>
6031	</param>
6032	</method>
6033
6034	<method name="reset">
6035	<desc>Resets the virtual machine.
6036	<result name="VBOX_E_INVALID_VM_STATE">
6037	Virtual machine not in Running state.
6038	</result>
6039	<result name="VBOX_E_VM_ERROR">
6040	Virtual machine error in reset operation.
6041	</result>
6042	</desc>
6043	</method>
6044
6045	<method name="pause">
6046	<desc>Pauses the virtual machine execution.
6047	<result name="VBOX_E_INVALID_VM_STATE">
6048	Virtual machine not in Running state.
6049	</result>
6050	<result name="VBOX_E_VM_ERROR">
6051	Virtual machine error in suspend operation.
6052	</result>
6053	</desc>
6054	</method>
6055
6056	<method name="resume">
6057	<desc>Resumes the virtual machine execution.
6058	<result name="VBOX_E_INVALID_VM_STATE">
6059	Virtual machine not in Paused state.
6060	</result>
6061	<result name="VBOX_E_VM_ERROR">
6062	Virtual machine error in resume operation.
6063	</result>
6064	</desc>
6065	</method>
6066
6067	<method name="powerButton">
6068	<desc>Sends the ACPI power button event to the guest.
6069	<result name="VBOX_E_INVALID_VM_STATE">
6070	Virtual machine not in Running state.
6071	</result>
6072	<result name="VBOX_E_PDM_ERROR">
6073	Controlled power off failed.
6074	</result>
6075	</desc>
6076	</method>
6077
6078	<method name="sleepButton">
6079	<desc>Sends the ACPI sleep button event to the guest.
6080	<result name="VBOX_E_INVALID_VM_STATE">
6081	Virtual machine not in Running state.
6082	</result>
6083	<result name="VBOX_E_PDM_ERROR">
6084	Sending sleep button event failed.
6085	</result>
6086	</desc>
6087	</method>
6088
6089	<method name="getPowerButtonHandled">
6090	<desc>Checks if the last power button event was handled by guest.
6091	<result name="VBOX_E_PDM_ERROR">
6092	Checking if the event was handled by the guest OS failed.
6093	</result>
6094	</desc>
6095	<param name="handled" type="boolean" dir="return"/>
6096	</method>
6097
6098	<method name="getGuestEnteredACPIMode">
6099	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6100	G1 (sleeping). If this method returns @c false, the guest will
6101	most likely not respond to external ACPI events.
6102	<result name="VBOX_E_INVALID_VM_STATE">
6103	Virtual machine not in Running state.
6104	</result>
6105	</desc>
6106	<param name="entered" type="boolean" dir="return"/>
6107	</method>
6108
6109	<method name="saveState">
6110	<desc>
6111	Saves the current execution state of a running virtual machine
6112	and stops its execution.
6113
6114	After this operation completes, the machine will go to the
6115	Saved state. Next time it is powered up, this state will
6116	be restored and the machine will continue its execution from
6117	the place where it was saved.
6118
6119	This operation differs from taking a snapshot to the effect
6120	that it doesn't create new differencing media. Also, once
6121	the machine is powered up from the state saved using this method,
6122	the saved state is deleted, so it will be impossible to return
6123	to this state later.
6124
6125	<note>
6126	On success, this method implicitly calls
6127	<link to="IMachine::saveSettings"/> to save all current machine
6128	settings (including runtime changes to the DVD medium, etc.).
6129	Together with the impossibility to change any VM settings when it is
6130	in the Saved state, this guarantees adequate hardware
6131	configuration of the machine when it is restored from the saved
6132	state file.
6133	</note>
6134
6135	<note>
6136	The machine must be in the Running or Paused state, otherwise
6137	the operation will fail.
6138	</note>
6139	<result name="VBOX_E_INVALID_VM_STATE">
6140	Virtual machine state neither Running nor Paused.
6141	</result>
6142	<result name="VBOX_E_FILE_ERROR">
6143	Failed to create directory for saved state file.
6144	</result>
6145
6146	<see><link to="#takeSnapshot"/></see>
6147	</desc>
6148	<param name="progress" type="IProgress" dir="return">
6149	<desc>Progress object to track the operation completion.</desc>
6150	</param>
6151	</method>
6152
6153	<method name="adoptSavedState">
6154	<desc>
6155	Associates the given saved state file to the virtual machine.
6156
6157	On success, the machine will go to the Saved state. Next time it is
6158	powered up, it will be restored from the adopted saved state and
6159	continue execution from the place where the saved state file was
6160	created.
6161
6162	The specified saved state file path may be absolute or relative to the
6163	folder the VM normally saves the state to (usually,
6164	<link to="IMachine::snapshotFolder"/>).
6165
6166	<note>
6167	It's a caller's responsibility to make sure the given saved state
6168	file is compatible with the settings of this virtual machine that
6169	represent its virtual hardware (memory size, storage disk configuration
6170	etc.). If there is a mismatch, the behavior of the virtual machine
6171	is undefined.
6172	</note>
6173	<result name="VBOX_E_INVALID_VM_STATE">
6174	Virtual machine state neither PoweredOff nor Aborted.
6175	</result>
6176	</desc>
6177	<param name="savedStateFile" type="wstring" dir="in">
6178	<desc>Path to the saved state file to adopt.</desc>
6179	</param>
6180	</method>
6181
6182	<method name="discardSavedState">
6183	<desc>
6184	Forcibly resets the machine to "Powered Off" state if it is
6185	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6186	Next time the machine is powered up, a clean boot will occur.
6187	<note>
6188	This operation is equivalent to resetting or powering off
6189	the machine without doing a proper shutdown of the guest
6190	operating system; as with resetting a running phyiscal
6191	computer, it can can lead to data loss.
6192	</note>
6193	If @a fRemoveFile is @c true, the file in the machine directory
6194	into which the machine state was saved is also deleted. If
6195	this is @c false, then the state can be recovered and later
6196	re-inserted into a machine using <link to="#adoptSavedState" />.
6197	The location of the file can be found in the
6198	<link to="IMachine::stateFilePath" /> attribute.
6199	<result name="VBOX_E_INVALID_VM_STATE">
6200	Virtual machine not in state Saved.
6201	</result>
6202	</desc>
6203	<param name="fRemoveFile" type="boolean" dir="in" >
6204	<desc>Whether to also remove the saved state file.</desc>
6205	</param>
6206	</method>
6207
6208	<method name="getDeviceActivity">
6209	<desc>
6210	Gets the current activity type of a given device or device group.
6211	<result name="E_INVALIDARG">
6212	Invalid device type.
6213	</result>
6214	</desc>
6215	<param name="type" type="DeviceType" dir="in"/>
6216	<param name="activity" type="DeviceActivity" dir="return"/>
6217	</method>
6218
6219	<method name="attachUSBDevice">
6220	<desc>
6221	Attaches a host USB device with the given UUID to the
6222	USB controller of the virtual machine.
6223
6224	The device needs to be in one of the following states:
6225	<link to="USBDeviceState_Busy"/>,
6226	<link to="USBDeviceState_Available"/> or
6227	<link to="USBDeviceState_Held"/>,
6228	otherwise an error is immediately returned.
6229
6230	When the device state is
6231	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6232	be returned if the host computer refuses to release it for some reason.
6233
6234	<see>IUSBController::deviceFilters, USBDeviceState</see>
6235	<result name="VBOX_E_INVALID_VM_STATE">
6236	Virtual machine state neither Running nor Paused.
6237	</result>
6238	<result name="VBOX_E_PDM_ERROR">
6239	Virtual machine does not have a USB controller.
6240	</result>
6241	</desc>
6242	<param name="id" type="uuid" mod="string" dir="in">
6243	<desc>UUID of the host USB device to attach.</desc>
6244	</param>
6245	</method>
6246
6247	<method name="detachUSBDevice">
6248	<desc>
6249	Detaches an USB device with the given UUID from the USB controller
6250	of the virtual machine.
6251
6252	After this method succeeds, the VirtualBox server re-initiates
6253	all USB filters as if the device were just physically attached
6254	to the host, but filters of this machine are ignored to avoid
6255	a possible automatic re-attachment.
6256
6257	<see>IUSBController::deviceFilters, USBDeviceState</see>
6258
6259	<result name="VBOX_E_PDM_ERROR">
6260	Virtual machine does not have a USB controller.
6261	</result>
6262	<result name="E_INVALIDARG">
6263	USB device not attached to this virtual machine.
6264	</result>
6265	</desc>
6266	<param name="id" type="uuid" mod="string" dir="in">
6267	<desc>UUID of the USB device to detach.</desc>
6268	</param>
6269	<param name="device" type="IUSBDevice" dir="return">
6270	<desc>Detached USB device.</desc>
6271	</param>
6272	</method>
6273
6274	<method name="findUSBDeviceByAddress">
6275	<desc>
6276	Searches for a USB device with the given host address.
6277
6278	<result name="VBOX_E_OBJECT_NOT_FOUND">
6279	Given @c name does not correspond to any USB device.
6280	</result>
6281
6282	<see>IUSBDevice::address</see>
6283	</desc>
6284	<param name="name" type="wstring" dir="in">
6285	<desc>
6286	Address of the USB device (as assigned by the host) to
6287	search for.
6288	</desc>
6289	</param>
6290	<param name="device" type="IUSBDevice" dir="return">
6291	<desc>Found USB device object.</desc>
6292	</param>
6293	</method>
6294
6295	<method name="findUSBDeviceById">
6296	<desc>
6297	Searches for a USB device with the given UUID.
6298
6299	<result name="VBOX_E_OBJECT_NOT_FOUND">
6300	Given @c id does not correspond to any USB device.
6301	</result>
6302
6303	<see>IUSBDevice::id</see>
6304	</desc>
6305	<param name="id" type="uuid" mod="string" dir="in">
6306	<desc>UUID of the USB device to search for.</desc>
6307	</param>
6308	<param name="device" type="IUSBDevice" dir="return">
6309	<desc>Found USB device object.</desc>
6310	</param>
6311	</method>
6312
6313	<method name="createSharedFolder">
6314	<desc>
6315	Creates a transient new shared folder by associating the given logical
6316	name with the given host path, adds it to the collection of shared
6317	folders and starts sharing it. Refer to the description of
6318	<link to="ISharedFolder"/> to read more about logical names.
6319
6320	<result name="VBOX_E_INVALID_VM_STATE">
6321	Virtual machine in Saved state or currently changing state.
6322	</result>
6323	<result name="VBOX_E_FILE_ERROR">
6324	Shared folder already exists or not accessible.
6325	</result>
6326	</desc>
6327	<param name="name" type="wstring" dir="in">
6328	<desc>Unique logical name of the shared folder.</desc>
6329	</param>
6330	<param name="hostPath" type="wstring" dir="in">
6331	<desc>Full path to the shared folder in the host file system.</desc>
6332	</param>
6333	<param name="writable" type="boolean" dir="in">
6334	<desc>Whether the share is writable or readonly</desc>
6335	</param>
6336	<param name="automount" type="boolean" dir="in">
6337	<desc>Whether the share gets automatically mounted by the guest
6338	or not.</desc>
6339	</param>
6340	</method>
6341
6342	<method name="removeSharedFolder">
6343	<desc>
6344	Removes a transient shared folder with the given name previously
6345	created by <link to="#createSharedFolder"/> from the collection of
6346	shared folders and stops sharing it.
6347	<result name="VBOX_E_INVALID_VM_STATE">
6348	Virtual machine in Saved state or currently changing state.
6349	</result>
6350	<result name="VBOX_E_FILE_ERROR">
6351	Shared folder does not exists.
6352	</result>
6353	</desc>
6354	<param name="name" type="wstring" dir="in">
6355	<desc>Logical name of the shared folder to remove.</desc>
6356	</param>
6357	</method>
6358
6359	<method name="takeSnapshot">
6360	<desc>
6361	Saves the current execution state
6362	and all settings of the machine and creates differencing images
6363	for all normal (non-independent) media.
6364	See <link to="ISnapshot" /> for an introduction to snapshots.
6365
6366	This method can be called for a PoweredOff, Saved (see
6367	<link to="#saveState"/>), Running or
6368	Paused virtual machine. When the machine is PoweredOff, an
6369	offline snapshot is created. When the machine is Running a live
6370	snapshot is created, and an online snapshot is is created when Paused.
6371
6372	The taken snapshot is always based on the
6373	<link to="IMachine::currentSnapshot">current snapshot</link>
6374	of the associated virtual machine and becomes a new current snapshot.
6375
6376	<note>
6377	This method implicitly calls <link to="IMachine::saveSettings"/> to
6378	save all current machine settings before taking an offline snapshot.
6379	</note>
6380
6381	<result name="VBOX_E_INVALID_VM_STATE">
6382	Virtual machine currently changing state.
6383	</result>
6384	</desc>
6385	<param name="name" type="wstring" dir="in">
6386	<desc>Short name for the snapshot.</desc>
6387	</param>
6388	<param name="description" type="wstring" dir="in">
6389	<desc>Optional description of the snapshot.</desc>
6390	</param>
6391	<param name="progress" type="IProgress" dir="return">
6392	<desc>Progress object to track the operation completion.</desc>
6393	</param>
6394	</method>
6395
6396	<method name="deleteSnapshot">
6397	<desc>
6398	Starts deleting the specified snapshot asynchronously.
6399	See <link to="ISnapshot" /> for an introduction to snapshots.
6400
6401	The execution state and settings of the associated machine stored in
6402	the snapshot will be deleted. The contents of all differencing media of
6403	this snapshot will be merged with the contents of their dependent child
6404	media to keep the medium chain valid (in other words, all changes
6405	represented by media being deleted will be propagated to their child
6406	medium). After that, this snapshot's differencing medium will be
6407	deleted. The parent of this snapshot will become a new parent for all
6408	its child snapshots.
6409
6410	If the deleted snapshot is the current one, its parent snapshot will
6411	become a new current snapshot. The current machine state is not directly
6412	affected in this case, except that currently attached differencing
6413	media based on media of the deleted snapshot will be also merged as
6414	described above.
6415
6416	If the deleted snapshot is the first or current snapshot, then the
6417	respective IMachine attributes will be adjusted. Deleting the current
6418	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6419	to make all current machine settings permanent.
6420
6421	Deleting a snapshot has the following preconditions:
6422
6423	<ul>
6424	<li>Child media of all normal media of the deleted snapshot
6425	must be accessible (see <link to="IMedium::state"/>) for this
6426	operation to succeed. In particular, this means that all virtual
6427	machines whose media are directly or indirectly based on the
6428	media of deleted snapshot must be powered off.</li>
6429
6430	<li>You cannot delete the snapshot if a medium attached to it has
6431	more than once child medium (differencing images) because otherwise
6432	merging would be impossible. This might be the case if there is
6433	more than one child snapshot or differencing images were created
6434	for other reason (e.g. implicitly because of multiple machine
6435	attachments).</li>
6436	</ul>
6437
6438
6439	The virtual machine's <link to="IMachine::state">state</link> is
6440	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6441	"DeletingSnapshotPaused" while this operation is in progress.
6442
6443	<note>
6444	Merging medium contents can be very time and disk space
6445	consuming, if these media are big in size and have many
6446	children. However, if the snapshot being deleted is the last
6447	(head) snapshot on the branch, the operation will be rather
6448	quick.
6449	</note>
6450	<result name="VBOX_E_INVALID_VM_STATE">
6451	The running virtual machine prevents deleting this snapshot. This
6452	happens only in very specific situations, usually snapshots can be
6453	deleted without trouble while a VM is running. The error message
6454	text explains the reason for the failure.
6455	</result>
6456	</desc>
6457	<param name="id" type="uuid" mod="string" dir="in">
6458	<desc>UUID of the snapshot to delete.</desc>
6459	</param>
6460	<param name="progress" type="IProgress" dir="return">
6461	<desc>Progress object to track the operation completion.</desc>
6462	</param>
6463	</method>
6464
6465	<method name="restoreSnapshot">
6466	<desc>
6467	Starts resetting the machine's current state to the state contained
6468	in the given snapshot, asynchronously. All current settings of the
6469	machine will be reset and changes stored in differencing media
6470	will be lost.
6471	See <link to="ISnapshot" /> for an introduction to snapshots.
6472
6473	After this operation is successfully completed, new empty differencing
6474	media are created for all normal media of the machine.
6475
6476	If the given snapshot is an online snapshot, the machine will go to
6477	the <link to="MachineState_Saved"> saved state</link>, so that the
6478	next time it is powered on, the execution state will be restored
6479	from the state of the snapshot.
6480
6481	<note>
6482	The machine must not be running, otherwise the operation will fail.
6483	</note>
6484
6485	<note>
6486	If the machine state is <link to="MachineState_Saved">Saved</link>
6487	prior to this operation, the saved state file will be implicitly
6488	deleted (as if <link to="IConsole::discardSavedState"/> were
6489	called).
6490	</note>
6491
6492	<result name="VBOX_E_INVALID_VM_STATE">
6493	Virtual machine is running.
6494	</result>
6495	</desc>
6496	<param name="snapshot" type="ISnapshot" dir="in">
6497	<desc>The snapshot to restore the VM state from.</desc>
6498	</param>
6499	<param name="progress" type="IProgress" dir="return">
6500	<desc>Progress object to track the operation completion.</desc>
6501	</param>
6502	</method>
6503
6504	<method name="teleport">
6505	<desc>
6506	Teleport the VM to a different host machine or process.
6507
6508	TODO explain the details.
6509
6510	<result name="VBOX_E_INVALID_VM_STATE">
6511	Virtual machine not running or paused.
6512	</result>
6513	</desc>
6514	<param name="hostname" type="wstring" dir="in">
6515	<desc>The name or IP of the host to teleport to.</desc>
6516	</param>
6517	<param name="tcpport" type="unsigned long" dir="in">
6518	<desc>The TCP port to connect to (1..65535).</desc>
6519	</param>
6520	<param name="password" type="wstring" dir="in">
6521	<desc>The password.</desc>
6522	</param>
6523	<param name="maxDowntime" type="unsigned long" dir="in">
6524	<desc>
6525	The maximum allowed downtime given as milliseconds. 0 is not a valid
6526	value. Recommended value: 250 ms.
6527
6528	The higher the value is, the greater the chance for a successful
6529	teleportation. A small value may easily result in the teleportation
6530	process taking hours and eventually fail.
6531
6532	<note>
6533	The current implementation treats this a guideline, not as an
6534	absolute rule.
6535	</note>
6536	</desc>
6537	</param>
6538	<param name="progress" type="IProgress" dir="return">
6539	<desc>Progress object to track the operation completion.</desc>
6540	</param>
6541	</method>
6542
6543	</interface>
6544
6545	<!--
6546	// IHost
6547	/////////////////////////////////////////////////////////////////////////
6548	-->
6549
6550	<enum
6551	name="HostNetworkInterfaceMediumType"
6552	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6553	>
6554	<desc>
6555	Type of encapsulation. Ethernet encapsulation includes both wired and
6556	wireless Ethernet connections.
6557	<see>IHostNetworkInterface</see>
6558	</desc>
6559
6560	<const name="Unknown" value="0">
6561	<desc>
6562	The type of interface cannot be determined.
6563	</desc>
6564	</const>
6565	<const name="Ethernet" value="1">
6566	<desc>
6567	Ethernet frame encapsulation.
6568	</desc>
6569	</const>
6570	<const name="PPP" value="2">
6571	<desc>
6572	Point-to-point protocol encapsulation.
6573	</desc>
6574	</const>
6575	<const name="SLIP" value="3">
6576	<desc>
6577	Serial line IP encapsulation.
6578	</desc>
6579	</const>
6580	</enum>
6581
6582	<enum
6583	name="HostNetworkInterfaceStatus"
6584	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6585	>
6586	<desc>
6587	Current status of the interface.
6588	<see>IHostNetworkInterface</see>
6589	</desc>
6590
6591	<const name="Unknown" value="0">
6592	<desc>
6593	The state of interface cannot be determined.
6594	</desc>
6595	</const>
6596	<const name="Up" value="1">
6597	<desc>
6598	The interface is fully operational.
6599	</desc>
6600	</const>
6601	<const name="Down" value="2">
6602	<desc>
6603	The interface is not functioning.
6604	</desc>
6605	</const>
6606	</enum>
6607
6608	<enum
6609	name="HostNetworkInterfaceType"
6610	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6611	>
6612	<desc>
6613	Network interface type.
6614	</desc>
6615	<const name="Bridged" value="1"/>
6616	<const name="HostOnly" value="2"/>
6617	</enum>
6618
6619	<interface
6620	name="IHostNetworkInterface" extends="$unknown"
6621	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6622	wsmap="managed"
6623	>
6624	<desc>
6625	Represents one of host's network interfaces. IP V6 address and network
6626	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6627	separated by colons.
6628	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6629	</desc>
6630	<attribute name="name" type="wstring" readonly="yes">
6631	<desc>Returns the host network interface name.</desc>
6632	</attribute>
6633
6634	<attribute name="id" type="uuid" mod="string" readonly="yes">
6635	<desc>Returns the interface UUID.</desc>
6636	</attribute>
6637
6638	<attribute name="networkName" type="wstring" readonly="yes">
6639	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6640	</attribute>
6641
6642	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6643	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6644	</attribute>
6645
6646	<attribute name="IPAddress" type="wstring" readonly="yes">
6647	<desc>Returns the IP V4 address of the interface.</desc>
6648	</attribute>
6649
6650	<attribute name="networkMask" type="wstring" readonly="yes">
6651	<desc>Returns the network mask of the interface.</desc>
6652	</attribute>
6653
6654	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6655	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6656	</attribute>
6657
6658	<attribute name="IPV6Address" type="wstring" readonly="yes">
6659	<desc>Returns the IP V6 address of the interface.</desc>
6660	</attribute>
6661
6662	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6663	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6664	</attribute>
6665
6666	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6667	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6668	</attribute>
6669
6670	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6671	<desc>Type of protocol encapsulation used.</desc>
6672	</attribute>
6673
6674	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6675	<desc>Status of the interface.</desc>
6676	</attribute>
6677
6678	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6679	<desc>specifies the host interface type.</desc>
6680	</attribute>
6681
6682	<method name="enableStaticIpConfig">
6683	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6684	<param name="IPAddress" type="wstring" dir="in">
6685	<desc>
6686	IP address.
6687	</desc>
6688	</param>
6689	<param name="networkMask" type="wstring" dir="in">
6690	<desc>
6691	network mask.
6692	</desc>
6693	</param>
6694	</method>
6695
6696	<method name="enableStaticIpConfigV6">
6697	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6698	<param name="IPV6Address" type="wstring" dir="in">
6699	<desc>
6700	IP address.
6701	</desc>
6702	</param>
6703	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6704	<desc>
6705	network mask.
6706	</desc>
6707	</param>
6708	</method>
6709
6710	<method name="enableDynamicIpConfig">
6711	<desc>enables the dynamic IP configuration.</desc>
6712	</method>
6713
6714	<method name="dhcpRediscover">
6715	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6716	</method>
6717
6718	</interface>
6719
6720	<interface
6721	name="IHost" extends="$unknown"
6722	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6723	wsmap="managed"
6724	>
6725	<desc>
6726	The IHost interface represents the physical machine that this VirtualBox
6727	installation runs on.
6728
6729	An object implementing this interface is returned by the
6730	<link to="IVirtualBox::host" /> attribute. This interface contains
6731	read-only information about the host's physical hardware (such as what
6732	processors and disks are available, what the host operating system is,
6733	and so on) and also allows for manipulating some of the host's hardware,
6734	such as global USB device filters and host interface networking.
6735
6736	</desc>
6737	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6738	<desc>List of DVD drives available on the host.</desc>
6739	</attribute>
6740
6741	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6742	<desc>List of floppy drives available on the host.</desc>
6743	</attribute>
6744
6745	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6746	<desc>
6747	List of USB devices currently attached to the host.
6748	Once a new device is physically attached to the host computer,
6749	it appears in this list and remains there until detached.
6750
6751	<note>
6752	If USB functionality is not available in the given edition of
6753	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6754	</note>
6755	</desc>
6756	</attribute>
6757
6758	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6759	<desc>
6760	List of USB device filters in action.
6761	When a new device is physically attached to the host computer,
6762	filters from this list are applied to it (in order they are stored
6763	in the list). The first matched filter will determine the
6764	<link to="IHostUSBDeviceFilter::action">action</link>
6765	performed on the device.
6766
6767	Unless the device is ignored by these filters, filters of all
6768	currently running virtual machines
6769	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6770
6771	<note>
6772	If USB functionality is not available in the given edition of
6773	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6774	</note>
6775
6776	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6777	</desc>
6778	</attribute>
6779
6780	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6781	<desc>List of host network interfaces currently defined on the host.</desc>
6782	</attribute>
6783
6784	<attribute name="processorCount" type="unsigned long" readonly="yes">
6785	<desc>Number of (logical) CPUs installed in the host system.</desc>
6786	</attribute>
6787
6788	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6789	<desc>Number of (logical) CPUs online in the host system.</desc>
6790	</attribute>
6791
6792	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6793	<desc>Number of physical processor cores installed in the host system.</desc>
6794	</attribute>
6795
6796	<method name="getProcessorSpeed">
6797	<desc>Query the (approximate) maximum speed of a specified host CPU in
6798	Megahertz.
6799	</desc>
6800	<param name="cpuId" type="unsigned long" dir="in">
6801	<desc>
6802	Identifier of the CPU.
6803	</desc>
6804	</param>
6805	<param name="speed" type="unsigned long" dir="return">
6806	<desc>
6807	Speed value. 0 is returned if value is not known or @a cpuId is
6808	invalid.
6809	</desc>
6810	</param>
6811	</method>
6812
6813	<method name="getProcessorFeature">
6814	<desc>Query whether a CPU feature is supported or not.</desc>
6815	<param name="feature" type="ProcessorFeature" dir="in">
6816	<desc>
6817	CPU Feature identifier.
6818	</desc>
6819	</param>
6820	<param name="supported" type="boolean" dir="return">
6821	<desc>
6822	Feature is supported or not.
6823	</desc>
6824	</param>
6825	</method>
6826
6827	<method name="getProcessorDescription">
6828	<desc>Query the model string of a specified host CPU.
6829	</desc>
6830	<param name="cpuId" type="unsigned long" dir="in">
6831	<desc>
6832	Identifier of the CPU.
6833	<note>
6834	The current implementation might not necessarily return the
6835	description for this exact CPU.
6836	</note>
6837	</desc>
6838	</param>
6839	<param name="description" type="wstring" dir="return">
6840	<desc>
6841	Model string. An empty string is returned if value is not known or
6842	@a cpuId is invalid.
6843	</desc>
6844	</param>
6845	</method>
6846
6847	<method name="getProcessorCPUIDLeaf">
6848	<desc>
6849	Returns the CPU cpuid information for the specified leaf.
6850	</desc>
6851	<param name="cpuId" type="unsigned long" dir="in">
6852	<desc>
6853	Identifier of the CPU. The CPU most be online.
6854	<note>
6855	The current implementation might not necessarily return the
6856	description for this exact CPU.
6857	</note>
6858	</desc>
6859	</param>
6860	<param name="leaf" type="unsigned long" dir="in">
6861	<desc>
6862	CPUID leaf index (eax).
6863	</desc>
6864	</param>
6865	<param name="subLeaf" type="unsigned long" dir="in">
6866	<desc>
6867	CPUID leaf sub index (ecx). This currently only applies to cache
6868	information on Intel CPUs. Use 0 if retrieving values for
6869	<link to="IMachine::setCPUIDLeaf"/>.
6870	</desc>
6871	</param>
6872	<param name="valEax" type="unsigned long" dir="out">
6873	<desc>
6874	CPUID leaf value for register eax.
6875	</desc>
6876	</param>
6877	<param name="valEbx" type="unsigned long" dir="out">
6878	<desc>
6879	CPUID leaf value for register ebx.
6880	</desc>
6881	</param>
6882	<param name="valEcx" type="unsigned long" dir="out">
6883	<desc>
6884	CPUID leaf value for register ecx.
6885	</desc>
6886	</param>
6887	<param name="valEdx" type="unsigned long" dir="out">
6888	<desc>
6889	CPUID leaf value for register edx.
6890	</desc>
6891	</param>
6892	</method>
6893
6894	<attribute name="memorySize" type="unsigned long" readonly="yes">
6895	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6896	</attribute>
6897
6898	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6899	<desc>Available system memory in the host system.</desc>
6900	</attribute>
6901
6902	<attribute name="operatingSystem" type="wstring" readonly="yes">
6903	<desc>Name of the host system's operating system.</desc>
6904	</attribute>
6905
6906	<attribute name="OSVersion" type="wstring" readonly="yes">
6907	<desc>Host operating system's version string.</desc>
6908	</attribute>
6909
6910	<attribute name="UTCTime" type="long long" readonly="yes">
6911	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6912	</attribute>
6913
6914	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6915	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6916	</attribute>
6917
6918	<method name="createHostOnlyNetworkInterface">
6919	<desc>
6920	Creates a new adapter for Host Only Networking.
6921	<result name="E_INVALIDARG">
6922	Host network interface @a name already exists.
6923	</result>
6924	</desc>
6925	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6926	<desc>
6927	Created host interface object.
6928	</desc>
6929	</param>
6930	<param name="progress" type="IProgress" dir="return">
6931	<desc>
6932	Progress object to track the operation completion.
6933	</desc>
6934	</param>
6935	</method>
6936
6937	<method name="removeHostOnlyNetworkInterface">
6938	<desc>
6939	Removes the given Host Only Networking interface.
6940	<result name="VBOX_E_OBJECT_NOT_FOUND">
6941	No host network interface matching @a id found.
6942	</result>
6943	</desc>
6944	<param name="id" type="uuid" mod="string" dir="in">
6945	<desc>
6946	Adapter GUID.
6947	</desc>
6948	</param>
6949	<param name="progress" type="IProgress" dir="return">
6950	<desc>
6951	Progress object to track the operation completion.
6952	</desc>
6953	</param>
6954	</method>
6955
6956	<method name="createUSBDeviceFilter">
6957	<desc>
6958	Creates a new USB device filter. All attributes except
6959	the filter name are set to empty (any match),
6960	<i>active</i> is @c false (the filter is not active).
6961
6962	The created filter can be added to the list of filters using
6963	<link to="#insertUSBDeviceFilter"/>.
6964
6965	<see>#USBDeviceFilters</see>
6966	</desc>
6967	<param name="name" type="wstring" dir="in">
6968	<desc>
6969	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6970	</desc>
6971	</param>
6972	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6973	<desc>Created filter object.</desc>
6974	</param>
6975	</method>
6976
6977	<method name="insertUSBDeviceFilter">
6978	<desc>
6979	Inserts the given USB device to the specified position
6980	in the list of filters.
6981
6982	Positions are numbered starting from @c 0. If the specified
6983	position is equal to or greater than the number of elements in
6984	the list, the filter is added at the end of the collection.
6985
6986	<note>
6987	Duplicates are not allowed, so an attempt to insert a
6988	filter already in the list is an error.
6989	</note>
6990	<note>
6991	If USB functionality is not available in the given edition of
6992	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6993	</note>
6994
6995	<see>#USBDeviceFilters</see>
6996
6997	<result name="VBOX_E_INVALID_OBJECT_STATE">
6998	USB device filter is not created within this VirtualBox instance.
6999	</result>
7000	<result name="E_INVALIDARG">
7001	USB device filter already in list.
7002	</result>
7003
7004	</desc>
7005	<param name="position" type="unsigned long" dir="in">
7006	<desc>Position to insert the filter to.</desc>
7007	</param>
7008	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7009	<desc>USB device filter to insert.</desc>
7010	</param>
7011	</method>
7012
7013	<method name="removeUSBDeviceFilter">
7014	<desc>
7015	Removes a USB device filter from the specified position in the
7016	list of filters.
7017
7018	Positions are numbered starting from @c 0. Specifying a
7019	position equal to or greater than the number of elements in
7020	the list will produce an error.
7021
7022	<note>
7023	If USB functionality is not available in the given edition of
7024	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7025	</note>
7026
7027	<see>#USBDeviceFilters</see>
7028
7029	<result name="E_INVALIDARG">
7030	USB device filter list empty or invalid @a position.
7031	</result>
7032
7033	</desc>
7034	<param name="position" type="unsigned long" dir="in">
7035	<desc>Position to remove the filter from.</desc>
7036	</param>
7037	</method>
7038
7039	<method name="findHostDVDDrive">
7040	<desc>
7041	Searches for a host DVD drive with the given @c name.
7042
7043	<result name="VBOX_E_OBJECT_NOT_FOUND">
7044	Given @c name does not correspond to any host drive.
7045	</result>
7046
7047	</desc>
7048	<param name="name" type="wstring" dir="in">
7049	<desc>Name of the host drive to search for</desc>
7050	</param>
7051	<param name="drive" type="IMedium" dir="return">
7052	<desc>Found host drive object</desc>
7053	</param>
7054	</method>
7055
7056	<method name="findHostFloppyDrive">
7057	<desc>
7058	Searches for a host floppy drive with the given @c name.
7059
7060	<result name="VBOX_E_OBJECT_NOT_FOUND">
7061	Given @c name does not correspond to any host floppy drive.
7062	</result>
7063
7064	</desc>
7065	<param name="name" type="wstring" dir="in">
7066	<desc>Name of the host floppy drive to search for</desc>
7067	</param>
7068	<param name="drive" type="IMedium" dir="return">
7069	<desc>Found host floppy drive object</desc>
7070	</param>
7071	</method>
7072
7073	<method name="findHostNetworkInterfaceByName">
7074	<desc>
7075	Searches through all host network interfaces for an interface with
7076	the given @c name.
7077	<note>
7078	The method returns an error if the given @c name does not
7079	correspond to any host network interface.
7080	</note>
7081	</desc>
7082	<param name="name" type="wstring" dir="in">
7083	<desc>Name of the host network interface to search for.</desc>
7084	</param>
7085	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7086	<desc>Found host network interface object.</desc>
7087	</param>
7088	</method>
7089	<method name="findHostNetworkInterfaceById">
7090	<desc>
7091	Searches through all host network interfaces for an interface with
7092	the given GUID.
7093	<note>
7094	The method returns an error if the given GUID does not
7095	correspond to any host network interface.
7096	</note>
7097	</desc>
7098	<param name="id" type="uuid" mod="string" dir="in">
7099	<desc>GUID of the host network interface to search for.</desc>
7100	</param>
7101	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7102	<desc>Found host network interface object.</desc>
7103	</param>
7104	</method>
7105	<method name="findHostNetworkInterfacesOfType">
7106	<desc>
7107	Searches through all host network interfaces and returns a list of interfaces of the specified type
7108	</desc>
7109	<param name="type" type="HostNetworkInterfaceType" dir="in">
7110	<desc>type of the host network interfaces to search for.</desc>
7111	</param>
7112	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7113	<desc>Found host network interface objects.</desc>
7114	</param>
7115	</method>
7116
7117	<method name="findUSBDeviceById">
7118	<desc>
7119	Searches for a USB device with the given UUID.
7120
7121	<result name="VBOX_E_OBJECT_NOT_FOUND">
7122	Given @c id does not correspond to any USB device.
7123	</result>
7124
7125	<see>IHostUSBDevice::id</see>
7126	</desc>
7127	<param name="id" type="uuid" mod="string" dir="in">
7128	<desc>UUID of the USB device to search for.</desc>
7129	</param>
7130	<param name="device" type="IHostUSBDevice" dir="return">
7131	<desc>Found USB device object.</desc>
7132	</param>
7133	</method>
7134
7135	<method name="findUSBDeviceByAddress">
7136	<desc>
7137	Searches for a USB device with the given host address.
7138
7139	<result name="VBOX_E_OBJECT_NOT_FOUND">
7140	Given @c name does not correspond to any USB device.
7141	</result>
7142
7143	<see>IHostUSBDevice::address</see>
7144	</desc>
7145	<param name="name" type="wstring" dir="in">
7146	<desc>
7147	Address of the USB device (as assigned by the host) to
7148	search for.
7149	</desc>
7150	</param>
7151	<param name="device" type="IHostUSBDevice" dir="return">
7152	<desc>Found USB device object.</desc>
7153	</param>
7154	</method>
7155
7156	</interface>
7157
7158	<!--
7159	// ISystemProperties
7160	/////////////////////////////////////////////////////////////////////////
7161	-->
7162
7163	<interface
7164	name="ISystemProperties"
7165	extends="$unknown"
7166	uuid="2af0100b-fda2-4c6a-8e8f-31e4ba871886"
7167	wsmap="managed"
7168	>
7169	<desc>
7170	The ISystemProperties interface represents global properties of the given
7171	VirtualBox installation.
7172
7173	These properties define limits and default values for various attributes
7174	and parameters. Most of the properties are read-only, but some can be
7175	changed by a user.
7176	</desc>
7177
7178	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7179	<desc>Minimum guest system memory in Megabytes.</desc>
7180	</attribute>
7181
7182	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7183	<desc>Maximum guest system memory in Megabytes.</desc>
7184	</attribute>
7185
7186	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7187	<desc>Minimum guest video memory in Megabytes.</desc>
7188	</attribute>
7189
7190	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7191	<desc>Maximum guest video memory in Megabytes.</desc>
7192	</attribute>
7193
7194	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7195	<desc>Minimum CPU count.</desc>
7196	</attribute>
7197
7198	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7199	<desc>Maximum CPU count.</desc>
7200	</attribute>
7201
7202	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7203	<desc>Maximum of monitors which could be connected.</desc>
7204	</attribute>
7205
7206	<attribute name="infoVDSize" type="long long" readonly="yes">
7207	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7208	does not reflect the limits of any virtual disk image format.</desc>
7209	</attribute>
7210
7211	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7212	<desc>
7213	Number of network adapters associated with every
7214	<link to="IMachine"/> instance.
7215	</desc>
7216	</attribute>
7217
7218	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7219	<desc>
7220	Number of serial ports associated with every
7221	<link to="IMachine"/> instance.
7222	</desc>
7223	</attribute>
7224
7225	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7226	<desc>
7227	Number of parallel ports associated with every
7228	<link to="IMachine"/> instance.
7229	</desc>
7230	</attribute>
7231
7232	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7233	<desc>
7234	Maximum device position in the boot order. This value corresponds
7235	to the total number of devices a machine can boot from, to make it
7236	possible to include all possible devices to the boot list.
7237	<see><link to="IMachine::setBootOrder"/></see>
7238	</desc>
7239	</attribute>
7240
7241	<attribute name="defaultMachineFolder" type="wstring">
7242	<desc>
7243	Full path to the default directory used to create new or open
7244	existing machines when a machine settings file name contains no
7245	path.
7246
7247	Starting with VirtualBox 4.0, by default, this attribute contains
7248	the full path of folder named "VirtualBox VMs" in the user's
7249	home directory, which depends on the host platform.
7250
7251	When setting this attribute, a full path must be specified.
7252	Setting this property to @c null or an empty string or the
7253	special value "Machines" (for compatibility reasons) will restore
7254	that default value.
7255
7256	If the folder specified herein does not exist, it will be created
7257	automatically as needed.
7258
7259	<see>
7260	<link to="IVirtualBox::createMachine"/>,
7261	<link to="IVirtualBox::openMachine"/>
7262	</see>
7263	</desc>
7264	</attribute>
7265
7266	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7267	<desc>
7268	List of all medium storage formats supported by this VirtualBox
7269	installation.
7270
7271	Keep in mind that the medium format identifier
7272	(<link to="IMediumFormat::id"/>) used in other API calls like
7273	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7274	medium format is a case-insensitive string. This means that, for
7275	example, all of the following strings:
7276	<pre>
7277	"VDI"
7278	"vdi"
7279	"VdI"</pre>
7280	refer to the same medium format.
7281
7282	Note that the virtual medium framework is backend-based, therefore
7283	the list of supported formats depends on what backends are currently
7284	installed.
7285
7286	<see>
7287	<link to="IMediumFormat"/>,
7288	</see>
7289	</desc>
7290	</attribute>
7291
7292	<attribute name="defaultHardDiskFormat" type="wstring">
7293	<desc>
7294	Identifier of the default medium format used by VirtualBox.
7295
7296	The medium format set by this attribute is used by VirtualBox
7297	when the medium format was not specified explicitly. One example is
7298	<link to="IVirtualBox::createHardDisk"/> with the empty
7299	format argument. A more complex example is implicit creation of
7300	differencing media when taking a snapshot of a virtual machine:
7301	this operation will try to use a format of the parent medium first
7302	and if this format does not support differencing media the default
7303	format specified by this argument will be used.
7304
7305	The list of supported medium formats may be obtained by the
7306	<link to="#mediumFormats"/> call. Note that the default medium
7307	format must have a capability to create differencing media;
7308	otherwise operations that create media implicitly may fail
7309	unexpectedly.
7310
7311	The initial value of this property is <tt>"VDI"</tt> in the current
7312	version of the VirtualBox product, but may change in the future.
7313
7314	<note>
7315	Setting this property to @c null or empty string will restore the
7316	initial value.
7317	</note>
7318
7319	<see>
7320	<link to="#mediumFormats"/>,
7321	<link to="IMediumFormat::id"/>,
7322	<link to="IVirtualBox::createHardDisk"/>
7323	</see>
7324	</desc>
7325	</attribute>
7326
7327	<attribute name="freeDiskSpaceWarning" type="long long">
7328	<desc>Issue a warning if the free disk space is below (or in some disk
7329	intensive operation is expected to go below) the given size in
7330	bytes.</desc>
7331	</attribute>
7332
7333	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7334	<desc>Issue a warning if the free disk space is below (or in some disk
7335	intensive operation is expected to go below) the given percentage.</desc>
7336	</attribute>
7337
7338	<attribute name="freeDiskSpaceError" type="long long">
7339	<desc>Issue an error if the free disk space is below (or in some disk
7340	intensive operation is expected to go below) the given size in
7341	bytes.</desc>
7342	</attribute>
7343
7344	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7345	<desc>Issue an error if the free disk space is below (or in some disk
7346	intensive operation is expected to go below) the given percentage.</desc>
7347	</attribute>
7348
7349	<attribute name="VRDEAuthLibrary" type="wstring">
7350	<desc>
7351	Library that provides authentication for Remote Desktop clients. The library
7352	is used if a virtual machine's authentication type is set to "external"
7353	in the VM RemoteDisplay configuration.
7354
7355	The system library extension (".DLL" or ".so") must be omitted.
7356	A full path can be specified; if not, then the library must reside on the
7357	system's default library path.
7358
7359	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7360	of that name in one of the default VirtualBox library directories.
7361
7362	For details about VirtualBox authentication libraries and how to implement
7363	them, please refer to the VirtualBox manual.
7364
7365	<note>
7366	Setting this property to @c null or empty string will restore the
7367	initial value.
7368	</note>
7369	</desc>
7370	</attribute>
7371
7372	<attribute name="webServiceAuthLibrary" type="wstring">
7373	<desc>
7374	Library that provides authentication for webservice clients. The library
7375	is used if a virtual machine's authentication type is set to "external"
7376	in the VM RemoteDisplay configuration and will be called from
7377	within the <link to="IWebsessionManager::logon" /> implementation.
7378
7379	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7380	there is no per-VM setting for this, as the webservice is a global
7381	resource (if it is running). Only for this setting (for the webservice),
7382	setting this value to a literal <tt>"null"</tt> string disables authentication,
7383	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7384	no matter what user name and password are supplied.
7385
7386	The initial value of this property is <tt>"VRDPAuth"</tt>,
7387	meaning that the webservice will use the same authentication
7388	library that is used by default for VRDE (again, see
7389	<link to="ISystemProperties::VRDEAuthLibrary" />).
7390	The format and calling convention of authentication libraries
7391	is the same for the webservice as it is for VRDE.
7392
7393	<note>
7394	Setting this property to @c null or empty string will restore the
7395	initial value.
7396	</note>
7397	</desc>
7398	</attribute>
7399
7400	<attribute name="defaultVRDELibrary" type="wstring">
7401	<desc>
7402	Default VRDE library.
7403
7404	The default value of this property is an empty string, which means that the
7405	VRDE is not available.
7406
7407	For details about VirtualBox Remote Desktop Extension and how to implement
7408	it, please refer to the VirtualBox SDK.
7409	</desc>
7410	</attribute>
7411
7412	<attribute name="LogHistoryCount" type="unsigned long">
7413	<desc>
7414	This value specifies how many old release log files are kept.
7415	</desc>
7416	</attribute>
7417
7418	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7419	<desc>This value hold the default audio driver for the current
7420	system.</desc>
7421	</attribute>
7422
7423	<method name="getMaxDevicesPerPortForStorageBus">
7424	<desc>Returns the maximum number of devices which can be attached to a port
7425	for the given storage bus.</desc>
7426
7427	<param name="bus" type="StorageBus" dir="in">
7428	<desc>The storage bus type to get the value for.</desc>
7429	</param>
7430
7431	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7432	<desc>The maximum number of devices which can eb attached to the port for the given
7433	storage bus.</desc>
7434	</param>
7435	</method>
7436
7437	<method name="getMinPortCountForStorageBus">
7438	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7439
7440	<param name="bus" type="StorageBus" dir="in">
7441	<desc>The storage bus type to get the value for.</desc>
7442	</param>
7443
7444	<param name="minPortCount" type="unsigned long" dir="return">
7445	<desc>The minimum number of ports for the given storage bus.</desc>
7446	</param>
7447	</method>
7448
7449	<method name="getMaxPortCountForStorageBus">
7450	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7451
7452	<param name="bus" type="StorageBus" dir="in">
7453	<desc>The storage bus type to get the value for.</desc>
7454	</param>
7455
7456	<param name="maxPortCount" type="unsigned long" dir="return">
7457	<desc>The maximum number of ports for the given storage bus.</desc>
7458	</param>
7459	</method>
7460
7461	<method name="getMaxInstancesOfStorageBus">
7462	<desc>Returns the maximum number of storage bus instances which
7463	can be configured for each VM. This corresponds to the number of
7464	storage controllers one can have.</desc>
7465
7466	<param name="bus" type="StorageBus" dir="in">
7467	<desc>The storage bus type to get the value for.</desc>
7468	</param>
7469
7470	<param name="maxInstances" type="unsigned long" dir="return">
7471	<desc>The maximum number of instances for the given storage bus.</desc>
7472	</param>
7473	</method>
7474
7475	<method name="getDeviceTypesForStorageBus">
7476	<desc>Returns list of all the supported device types
7477	(<link to="DeviceType"/>) for the given type of storage
7478	bus.</desc>
7479
7480	<param name="bus" type="StorageBus" dir="in">
7481	<desc>The storage bus type to get the value for.</desc>
7482	</param>
7483
7484	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7485	<desc>The list of all supported device types for the given storage bus.</desc>
7486	</param>
7487	</method>
7488
7489	<method name="getDefaultIoCacheSettingForStorageController">
7490	<desc>Returns the default I/O cache setting for the
7491	given storage controller</desc>
7492
7493	<param name="controllerType" type="StorageControllerType" dir="in">
7494	<desc>The storage controller to the setting for.</desc>
7495	</param>
7496
7497	<param name="enabled" type="boolean" dir="return">
7498	<desc>Returned flag indicating the default value</desc>
7499	</param>
7500	</method>
7501	</interface>
7502
7503	<!--
7504	// IGuest
7505	/////////////////////////////////////////////////////////////////////////
7506	-->
7507
7508	<interface
7509	name="IGuestOSType" extends="$unknown"
7510	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7511	wsmap="struct"
7512	>
7513	<desc>
7514	</desc>
7515
7516	<attribute name="familyId" type="wstring" readonly="yes">
7517	<desc>Guest OS family identifier string.</desc>
7518	</attribute>
7519
7520	<attribute name="familyDescription" type="wstring" readonly="yes">
7521	<desc>Human readable description of the guest OS family.</desc>
7522	</attribute>
7523
7524	<attribute name="id" type="wstring" readonly="yes">
7525	<desc>Guest OS identifier string.</desc>
7526	</attribute>
7527
7528	<attribute name="description" type="wstring" readonly="yes">
7529	<desc>Human readable description of the guest OS.</desc>
7530	</attribute>
7531
7532	<attribute name="is64Bit" type="boolean" readonly="yes">
7533	<desc>Returns @c true if the given OS is 64-bit</desc>
7534	</attribute>
7535
7536	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7537	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7538	</attribute>
7539
7540	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7541	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7542	</attribute>
7543
7544	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7545	<desc>Recommended RAM size in Megabytes.</desc>
7546	</attribute>
7547
7548	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7549	<desc>Recommended video RAM size in Megabytes.</desc>
7550	</attribute>
7551
7552	<attribute name="recommendedHDD" type="long long" readonly="yes">
7553	<desc>Recommended hard disk size in bytes.</desc>
7554	</attribute>
7555
7556	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7557	<desc>Returns recommended network adapter for this OS type.</desc>
7558	</attribute>
7559
7560	<attribute name="recommendedPae" type="boolean" readonly="yes">
7561	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7562	</attribute>
7563
7564	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7565	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7566	</attribute>
7567
7568	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7569	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7570	</attribute>
7571
7572	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7573	<desc>Recommended storage controller type for HD drives.</desc>
7574	</attribute>
7575
7576	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7577	<desc>Recommended storage bus type for HD drives.</desc>
7578	</attribute>
7579
7580	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7581	<desc>Recommended firmware type.</desc>
7582	</attribute>
7583
7584	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7585	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7586	</attribute>
7587
7588	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7589	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7590	</attribute>
7591
7592	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7593	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7594	</attribute>
7595
7596	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7597	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7598	</attribute>
7599
7600	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7601	<desc>Recommended chipset type.</desc>
7602	</attribute>
7603
7604	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7605	<desc>Recommended audio type.</desc>
7606	</attribute>
7607
7608	</interface>
7609
7610	<enum
7611	name="AdditionsRunLevelType"
7612	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7613	>
7614	<desc>
7615	Guest Additions run level type.
7616	</desc>
7617
7618	<const name="None" value="0">
7619	<desc>Guest Additions are not loaded.</desc>
7620	</const>
7621	<const name="System" value="1">
7622	<desc>Guest drivers are loaded.</desc>
7623	</const>
7624	<const name="Userland" value="2">
7625	<desc>Common components (such as application services) are loaded.</desc>
7626	</const>
7627	<const name="Desktop" value="3">
7628	<desc>Per-user desktop components are loaded.</desc>
7629	</const>
7630	</enum>
7631
7632	<enum
7633	name="ExecuteProcessFlag"
7634	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7635	>
7636	<desc>
7637	Guest process execution flags.
7638	</desc>
7639
7640	<const name="None" value="0">
7641	<desc>No flag set.</desc>
7642	</const>
7643
7644	<const name="WaitForProcessStartOnly" value="1">
7645	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7646	process itself then uses an infinite timeout.</desc>
7647	</const>
7648
7649	<const name="IgnoreOrphanedProcesses" value="2">
7650	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7651	</const>
7652	</enum>
7653
7654	<enum
7655	name="ProcessInputFlag"
7656	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7657	>
7658	<desc>
7659	Guest process input flags.
7660	</desc>
7661
7662	<const name="None" value="0">
7663	<desc>No flag set.</desc>
7664	</const>
7665	<const name="EndOfFile" value="1">
7666	<desc>End of file (input) reached.</desc>
7667	</const>
7668	</enum>
7669
7670	<enum
7671	name="CopyFileFlag"
7672	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7673	>
7674	<desc>
7675	Host/Guest copy flags.
7676	</desc>
7677
7678	<const name="None" value="0">
7679	<desc>No flag set.</desc>
7680	</const>
7681
7682	<const name="Recursive" value="1">
7683	<desc>Copy directories recursively.</desc>
7684	</const>
7685
7686	<const name="Update" value="2">
7687	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7688	</const>
7689
7690	<const name="FollowLinks" value="4">
7691	<desc>Follow symbolic links.</desc>
7692	</const>
7693	</enum>
7694
7695	<interface
7696	name="IGuest" extends="$unknown"
7697	uuid="5a4f265c-0c0e-495a-8ff6-7d68682e276b"
7698	wsmap="managed"
7699	>
7700	<desc>
7701	The IGuest interface represents information about the operating system
7702	running inside the virtual machine. Used in
7703	<link to="IConsole::guest"/>.
7704
7705	IGuest provides information about the guest operating system, whether
7706	Guest Additions are installed and other OS-specific virtual machine
7707	properties.
7708	</desc>
7709
7710	<attribute name="OSTypeId" type="wstring" readonly="yes">
7711	<desc>
7712	Identifier of the Guest OS type as reported by the Guest
7713	Additions.
7714	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7715	an IGuestOSType object representing details about the given
7716	Guest OS type.
7717	<note>
7718	If Guest Additions are not installed, this value will be
7719	the same as <link to="IMachine::OSTypeId"/>.
7720	</note>
7721	</desc>
7722	</attribute>
7723
7724	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7725	<desc>
7726	Current run level of the Guest Additions.
7727	</desc>
7728	</attribute>
7729
7730	<attribute name="additionsVersion" type="wstring" readonly="yes">
7731	<desc>
7732	Version of the Guest Additions including the revision (3 decimal numbers
7733	separated by dots + revision number) installed on the guest or empty
7734	when the Additions are not installed.
7735	</desc>
7736	</attribute>
7737
7738	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7739	<desc>
7740	Flag whether seamless guest display rendering (seamless desktop
7741	integration) is supported.
7742	</desc>
7743	</attribute>
7744
7745	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7746	<desc>
7747	Flag whether the guest is in graphics mode. If it is not, then
7748	seamless rendering will not work, resize hints are not immediately
7749	acted on and guest display resizes are probably not initiated by
7750	the guest additions.
7751	</desc>
7752	</attribute>
7753
7754	<attribute name="memoryBalloonSize" type="unsigned long">
7755	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7756	</attribute>
7757
7758	<attribute name="statisticsUpdateInterval" type="unsigned long">
7759	<desc>Interval to update guest statistics in seconds.</desc>
7760	</attribute>
7761
7762	<method name="internalGetStatistics">
7763	<desc>
7764	Internal method; do not use as it might change at any time
7765	</desc>
7766	<param name="cpuUser" type="unsigned long" dir="out">
7767	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7768	</param>
7769	<param name="cpuKernel" type="unsigned long" dir="out">
7770	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7771	</param>
7772	<param name="cpuIdle" type="unsigned long" dir="out">
7773	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7774	</param>
7775	<param name="memTotal" type="unsigned long" dir="out">
7776	<desc>Total amount of physical guest RAM</desc>
7777	</param>
7778	<param name="memFree" type="unsigned long" dir="out">
7779	<desc>Free amount of physical guest RAM</desc>
7780	</param>
7781	<param name="memBalloon" type="unsigned long" dir="out">
7782	<desc>Amount of ballooned physical guest RAM</desc>
7783	</param>
7784	<param name="memShared" type="unsigned long" dir="out">
7785	<desc>Amount of shared physical guest RAM</desc>
7786	</param>
7787	<param name="memCache" type="unsigned long" dir="out">
7788	<desc>Total amount of guest (disk) cache memory</desc>
7789	</param>
7790	<param name="pagedTotal" type="unsigned long" dir="out">
7791	<desc>Total amount of space in the page file</desc>
7792	</param>
7793	<param name="memAllocTotal" type="unsigned long" dir="out">
7794	<desc>Total amount of memory allocated by the hypervisor</desc>
7795	</param>
7796	<param name="memFreeTotal" type="unsigned long" dir="out">
7797	<desc>Total amount of free memory available in the hypervisor</desc>
7798	</param>
7799	<param name="memBalloonTotal" type="unsigned long" dir="out">
7800	<desc>Total amount of memory ballooned by the hypervisor</desc>
7801	</param>
7802	<param name="memSharedTotal" type="unsigned long" dir="out">
7803	<desc>Total amount of shared memory in the hypervisor</desc>
7804	</param>
7805	</method>
7806
7807	<method name="getAdditionsStatus">
7808	<desc>
7809	Retrieve the current status of a certain Guest Additions run level.
7810
7811	<result name="VBOX_E_NOT_SUPPORTED">
7812	Wrong status level specified.
7813	</result>
7814
7815	</desc>
7816	<param name="level" type="AdditionsRunLevelType" dir="in">
7817	<desc>Status level to check</desc>
7818	</param>
7819	<param name="active" type="boolean" dir="return">
7820	<desc>Flag whether the status level has been reached or not</desc>
7821	</param>
7822	</method>
7823
7824	<method name="setCredentials">
7825	<desc>
7826	Store login credentials that can be queried by guest operating
7827	systems with Additions installed. The credentials are transient
7828	to the session and the guest may also choose to erase them. Note
7829	that the caller cannot determine whether the guest operating system
7830	has queried or made use of the credentials.
7831
7832	<result name="VBOX_E_VM_ERROR">
7833	VMM device is not available.
7834	</result>
7835
7836	</desc>
7837	<param name="userName" type="wstring" dir="in">
7838	<desc>User name string, can be empty</desc>
7839	</param>
7840	<param name="password" type="wstring" dir="in">
7841	<desc>Password string, can be empty</desc>
7842	</param>
7843	<param name="domain" type="wstring" dir="in">
7844	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7845	</param>
7846	<param name="allowInteractiveLogon" type="boolean" dir="in">
7847	<desc>
7848	Flag whether the guest should alternatively allow the user to
7849	interactively specify different credentials. This flag might
7850	not be supported by all versions of the Additions.
7851	</desc>
7852	</param>
7853	</method>
7854
7855	<method name="executeProcess">
7856	<desc>
7857	Executes an existing program inside the guest VM.
7858
7859	<result name="VBOX_E_IPRT_ERROR">
7860	Could not execute process.
7861	</result>
7862
7863	</desc>
7864	<param name="execName" type="wstring" dir="in">
7865	<desc>
7866	Full path name of the command to execute on the guest; the
7867	commands has to exists in the guest VM in order to be executed.
7868	</desc>
7869	</param>
7870	<param name="flags" type="unsigned long" dir="in">
7871	<desc>
7872	Execution flags - currently not supported and therefore
7873	has to be set to 0.
7874	</desc>
7875	</param>
7876	<param name="arguments" type="wstring" safearray="yes" dir="in">
7877	<desc>
7878	Array of arguments passed to the execution command.
7879	</desc>
7880	</param>
7881	<param name="environment" type="wstring" safearray="yes" dir="in">
7882	<desc>
7883	Environment variables that can be set while the command is being
7884	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7885	variable just set its name ("NAME") without a value.
7886	</desc>
7887	</param>
7888	<param name="userName" type="wstring" dir="in">
7889	<desc>
7890	User name under which the command will be executed; has to exist
7891	and have the appropriate rights to execute programs in the VM.
7892	</desc>
7893	</param>
7894	<param name="password" type="wstring" dir="in">
7895	<desc>
7896	Password of the user account specified.
7897	</desc>
7898	</param>
7899	<param name="timeoutMS" type="unsigned long" dir="in">
7900	<desc>
7901	The maximum timeout value (in msec) to wait for finished program
7902	execution. Pass 0 for an infinite timeout.
7903	</desc>
7904	</param>
7905	<param name="pid" type="unsigned long" dir="out">
7906	<desc>
7907	The PID (process ID) of the started command for later reference.
7908	</desc>
7909	</param>
7910	<param name="progress" type="IProgress" dir="return">
7911	<desc>Progress object to track the operation completion.</desc>
7912	</param>
7913	</method>
7914
7915	<method name="getProcessOutput">
7916	<desc>
7917	Retrieves output of a formerly started process.
7918
7919	<result name="VBOX_E_IPRT_ERROR">
7920	Could not retrieve output.
7921	</result>
7922
7923	</desc>
7924	<param name="pid" type="unsigned long" dir="in">
7925	<desc>
7926	Process id returned by earlier executeProcess() call.
7927	</desc>
7928	</param>
7929	<param name="flags" type="unsigned long" dir="in">
7930	<desc>
7931	Flags describing which output to retrieve.
7932	</desc>
7933	</param>
7934	<param name="timeoutMS" type="unsigned long" dir="in">
7935	<desc>
7936	The maximum timeout value (in msec) to wait for output
7937	data. Pass 0 for an infinite timeout.
7938	</desc>
7939	</param>
7940	<param name="size" type="long long" dir="in">
7941	<desc>
7942	Size in bytes to read in the buffer.
7943	</desc>
7944	</param>
7945	<param name="data" type="octet" dir="return" safearray="yes">
7946	<desc>
7947	Buffer for retrieving the actual output. A data size of 0 means end of file
7948	if the requested size was not 0. This is the unprocessed
7949	output data, i.e. the line ending style depends on the platform of
7950	the system the server is running on.
7951	</desc>
7952	</param>
7953	</method>
7954
7955	<method name="getProcessStatus">
7956	<desc>
7957	Retrieves status, exit code and the exit reason of a formerly started process.
7958
7959	<result name="VBOX_E_IPRT_ERROR">
7960	Process with specified PID was not found.
7961	</result>
7962
7963	</desc>
7964	<param name="pid" type="unsigned long" dir="in">
7965	<desc>
7966	Process id returned by earlier executeProcess() call.
7967	</desc>
7968	</param>
7969	<param name="exitcode" type="unsigned long" dir="out">
7970	<desc>
7971	The exit code (if available).
7972	</desc>
7973	</param>
7974	<param name="flags" type="unsigned long" dir="out">
7975	<desc>
7976	Additional flags of process status (not used at the moment).
7977	</desc>
7978	</param>
7979	<param name="reason" type="unsigned long" dir="return">
7980	<desc>
7981	The current process status.
7982	</desc>
7983	</param>
7984	</method>
7985
7986	<method name="copyToGuest">
7987	<desc>
7988	Copies files/directories from host to the guest.
7989
7990	<result name="VBOX_E_IPRT_ERROR">
7991	Error while copying.
7992	</result>
7993
7994	</desc>
7995	<param name="source" type="wstring" dir="in">
7996	<desc>
7997	Source file on the host to copy.
7998	</desc>
7999	</param>
8000	<param name="dest" type="wstring" dir="in">
8001	<desc>
8002	Destination path on the guest.
8003	</desc>
8004	</param>
8005	<param name="userName" type="wstring" dir="in">
8006	<desc>
8007	User name under which the copy command will be executed; the
8008	user has to exist and have the appropriate rights to write to
8009	the destination path.
8010	</desc>
8011	</param>
8012	<param name="password" type="wstring" dir="in">
8013	<desc>
8014	Password of the user account specified.
8015	</desc>
8016	</param>
8017	<param name="flags" type="unsigned long" dir="in">
8018	<desc>
8019	Copy flags.
8020	</desc>
8021	</param>
8022	<param name="progress" type="IProgress" dir="return">
8023	<desc>Progress object to track the operation completion.</desc>
8024	</param>
8025	</method>
8026
8027	<method name="setProcessInput">
8028	<desc>
8029	Sends input into a formerly started process.
8030
8031	<result name="VBOX_E_IPRT_ERROR">
8032	Could not send input.
8033	</result>
8034
8035	</desc>
8036	<param name="pid" type="unsigned long" dir="in">
8037	<desc>
8038	Process id returned by earlier executeProcess() call.
8039	</desc>
8040	</param>
8041	<param name="flags" type="unsigned long" dir="in">
8042	<desc>
8043	Not used, must be set to zero.
8044	</desc>
8045	</param>
8046	<param name="data" type="octet" dir="in" safearray="yes">
8047	<desc>
8048	Buffer of input data to send to the started process to.
8049	</desc>
8050	</param>
8051	<param name="written" type="unsigned long" dir="return">
8052	<desc>
8053	Number of bytes written.
8054	</desc>
8055	</param>
8056	</method>
8057
8058	<method name="updateGuestAdditions">
8059	<desc>
8060	Updates already installed Guest Additions in a VM
8061	(Windows guests only).
8062
8063	<result name="VBOX_E_IPRT_ERROR">
8064	Error while updating.
8065	</result>
8066
8067	</desc>
8068	<param name="source" type="wstring" dir="in">
8069	<desc>
8070	Path to the Guest Additions .ISO file to use for the upate.
8071	</desc>
8072	</param>
8073	<param name="progress" type="IProgress" dir="return">
8074	<desc>Progress object to track the operation completion.</desc>
8075	</param>
8076	</method>
8077
8078	</interface>
8079
8080
8081	<!--
8082	// IProgress
8083	/////////////////////////////////////////////////////////////////////////
8084	-->
8085
8086	<interface
8087	name="IProgress" extends="$unknown"
8088	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8089	wsmap="managed"
8090	>
8091	<desc>
8092	The IProgress interface is used to track and control
8093	asynchronous tasks within VirtualBox.
8094
8095	An instance of this is returned every time VirtualBox starts
8096	an asynchronous task (in other words, a separate thread) which
8097	continues to run after a method call returns. For example,
8098	<link to="IConsole::saveState" />, which saves the state of
8099	a running virtual machine, can take a long time to complete.
8100	To be able to display a progress bar, a user interface such as
8101	the VirtualBox graphical user interface can use the IProgress
8102	object returned by that method.
8103
8104	Note that IProgress is a "read-only" interface in the sense
8105	that only the VirtualBox internals behind the Main API can
8106	create and manipulate progress objects, whereas client code
8107	can only use the IProgress object to monitor a task's
8108	progress and, if <link to="#cancelable" /> is @c true,
8109	cancel the task by calling <link to="#cancel" />.
8110
8111	A task represented by IProgress consists of either one or
8112	several sub-operations that run sequentially, one by one (see
8113	<link to="#operation" /> and <link to="#operationCount" />).
8114	Every operation is identified by a number (starting from 0)
8115	and has a separate description.
8116
8117	You can find the individual percentage of completion of the current
8118	operation in <link to="#operationPercent" /> and the
8119	percentage of completion of the task as a whole
8120	in <link to="#percent" />.
8121
8122	Similarly, you can wait for the completion of a particular
8123	operation via <link to="#waitForOperationCompletion" /> or
8124	for the completion of the whole task via
8125	<link to="#waitForCompletion" />.
8126	</desc>
8127
8128	<attribute name="id" type="uuid" mod="string" readonly="yes">
8129	<desc>ID of the task.</desc>
8130	</attribute>
8131
8132	<attribute name="description" type="wstring" readonly="yes">
8133	<desc>Description of the task.</desc>
8134	</attribute>
8135
8136	<attribute name="initiator" type="$unknown" readonly="yes">
8137	<desc>Initiator of the task.</desc>
8138	</attribute>
8139
8140	<attribute name="cancelable" type="boolean" readonly="yes">
8141	<desc>Whether the task can be interrupted.</desc>
8142	</attribute>
8143
8144	<attribute name="percent" type="unsigned long" readonly="yes">
8145	<desc>
8146	Current progress value of the task as a whole, in percent.
8147	This value depends on how many operations are already complete.
8148	Returns 100 if <link to="#completed" /> is @c true.
8149	</desc>
8150	</attribute>
8151
8152	<attribute name="timeRemaining" type="long" readonly="yes">
8153	<desc>
8154	Estimated remaining time until the task completes, in
8155	seconds. Returns 0 once the task has completed; returns -1
8156	if the remaining time cannot be computed, in particular if
8157	the current progress is 0.
8158
8159	Even if a value is returned, the estimate will be unreliable
8160	for low progress values. It will become more reliable as the
8161	task progresses; it is not recommended to display an ETA
8162	before at least 20% of a task have completed.
8163	</desc>
8164	</attribute>
8165
8166	<attribute name="completed" type="boolean" readonly="yes">
8167	<desc>Whether the task has been completed.</desc>
8168	</attribute>
8169
8170	<attribute name="canceled" type="boolean" readonly="yes">
8171	<desc>Whether the task has been canceled.</desc>
8172	</attribute>
8173
8174	<attribute name="resultCode" type="long" readonly="yes">
8175	<desc>
8176	Result code of the progress task.
8177	Valid only if <link to="#completed"/> is @c true.
8178	</desc>
8179	</attribute>
8180
8181	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8182	<desc>
8183	Extended information about the unsuccessful result of the
8184	progress operation. May be @c null if no extended information
8185	is available.
8186	Valid only if <link to="#completed"/> is @c true and
8187	<link to="#resultCode"/> indicates a failure.
8188	</desc>
8189	</attribute>
8190
8191	<attribute name="operationCount" type="unsigned long" readonly="yes">
8192	<desc>
8193	Number of sub-operations this task is divided into.
8194	Every task consists of at least one suboperation.
8195	</desc>
8196	</attribute>
8197
8198	<attribute name="operation" type="unsigned long" readonly="yes">
8199	<desc>Number of the sub-operation being currently executed.</desc>
8200	</attribute>
8201
8202	<attribute name="operationDescription" type="wstring" readonly="yes">
8203	<desc>
8204	Description of the sub-operation being currently executed.
8205	</desc>
8206	</attribute>
8207
8208	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8209	<desc>Progress value of the current sub-operation only, in percent.</desc>
8210	</attribute>
8211
8212	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8213	<desc>Weight value of the current sub-operation only.</desc>
8214	</attribute>
8215
8216	<attribute name="timeout" type="unsigned long">
8217	<desc>
8218	When non-zero, this specifies the number of milliseconds after which
8219	the operation will automatically be canceled. This can only be set on
8220	cancelable objects.
8221	</desc>
8222	</attribute>
8223
8224	<method name="setCurrentOperationProgress">
8225	<desc>Internal method, not to be called externally.</desc>
8226	<param name="percent" type="unsigned long" dir="in" />
8227	</method>
8228	<method name="setNextOperation">
8229	<desc>Internal method, not to be called externally.</desc>
8230	<param name="nextOperationDescription" type="wstring" dir="in" />
8231	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8232	</method>
8233
8234	<method name="waitForCompletion">
8235	<desc>
8236	Waits until the task is done (including all sub-operations)
8237	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8238
8239	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8240	thread are not processed while waiting. Neglecting event queues may
8241	have dire consequences (degrade performance, resource hogs,
8242	deadlocks, etc.), this is specially so for the main thread on
8243	platforms using XPCOM. Callers are adviced wait for short periods
8244	and service their event queues between calls, or to create a worker
8245	thread to do the waiting.
8246
8247	<result name="VBOX_E_IPRT_ERROR">
8248	Failed to wait for task completion.
8249	</result>
8250	</desc>
8251
8252	<param name="timeout" type="long" dir="in">
8253	<desc>
8254	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8255	</desc>
8256	</param>
8257	</method>
8258
8259	<method name="waitForOperationCompletion">
8260	<desc>
8261	Waits until the given operation is done with a given timeout in
8262	milliseconds; specify -1 for an indefinite wait.
8263
8264	See <link to="#waitForCompletion"> for event queue considerations.</link>
8265
8266	<result name="VBOX_E_IPRT_ERROR">
8267	Failed to wait for operation completion.
8268	</result>
8269
8270	</desc>
8271	<param name="operation" type="unsigned long" dir="in">
8272	<desc>
8273	Number of the operation to wait for.
8274	Must be less than <link to="#operationCount"/>.
8275	</desc>
8276	</param>
8277	<param name="timeout" type="long" dir="in">
8278	<desc>
8279	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8280	</desc>
8281	</param>
8282	</method>
8283
8284	<method name="cancel">
8285	<desc>
8286	Cancels the task.
8287	<note>
8288	If <link to="#cancelable"/> is @c false, then this method will fail.
8289	</note>
8290
8291	<result name="VBOX_E_INVALID_OBJECT_STATE">
8292	Operation cannot be canceled.
8293	</result>
8294
8295	</desc>
8296	</method>
8297
8298	</interface>
8299
8300	<!--
8301	// ISnapshot
8302	/////////////////////////////////////////////////////////////////////////
8303	-->
8304
8305	<interface
8306	name="ISnapshot" extends="$unknown"
8307	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8308	wsmap="managed"
8309	>
8310	<desc>
8311	The ISnapshot interface represents a snapshot of the virtual
8312	machine.
8313
8314	Together with the differencing media that are created
8315	when a snapshot is taken, a machine can be brought back to
8316	the exact state it was in when the snapshot was taken.
8317
8318	The ISnapshot interface has no methods, only attributes; snapshots
8319	are controlled through methods of the <link to="IConsole" /> interface
8320	which also manage the media associated with the snapshot.
8321	The following operations exist:
8322
8323	<ul>
8324	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8325	by creating new, empty differencing images for the machine's
8326	media and saving the VM settings and (if the VM is running)
8327	the current VM state in the snapshot.
8328
8329	The differencing images will then receive all data written to
8330	the machine's media, while their parent (base) images
8331	remain unmodified after the snapshot has been taken (see
8332	<link to="IMedium" /> for details about differencing images).
8333	This simplifies restoring a machine to the state of a snapshot:
8334	only the differencing images need to be deleted.
8335
8336	The current machine state is not changed by taking a snapshot.
8337	If the machine is running, it will resume execution after the
8338	snapshot has been taken. After calling this,
8339	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8340	just created.
8341	</li>
8342
8343	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8344	the state of a previous snapshot by deleting the differencing
8345	image of each of the machine's media and setting the machine's
8346	settings and state to the state that was saved in the snapshot (if any).
8347
8348	This destroys the machine's current state. After calling this,
8349	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8350	restored.
8351	</li>
8352
8353	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8354	without affecting the current machine state.
8355
8356	This does not change the current machine state, but instead frees the
8357	resources allocated when the snapshot was taken: the settings and machine
8358	state file are deleted (if any), and the snapshot's differencing image for
8359	each of the machine's media gets merged with its parent image.
8360
8361	Neither the current machine state nor other snapshots are affected
8362	by this operation, except that parent media will be modified
8363	to contain the disk data associated with the snapshot being deleted.
8364
8365	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8366	attribute is set to the current snapshot's parent or NULL if it
8367	has no parent. Otherwise the attribute is unchanged.
8368	</li>
8369	</ul>
8370
8371	Each snapshot contains the settings of the virtual machine (hardware
8372	configuration etc.). In addition, if the machine was running when the
8373	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8374	the current VM state is saved in the snapshot (similarly to what happens
8375	when a VM's state is saved). The snapshot is then said to
8376	be <i>online</i> because when restoring it, the VM will be running.
8377
8378	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8379	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8380
8381	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8382	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8383	it then contains a so-called "zero execution state", representing a
8384	machine that is powered off.
8385	</desc>
8386
8387	<attribute name="id" type="uuid" mod="string" readonly="yes">
8388	<desc>UUID of the snapshot.</desc>
8389	</attribute>
8390
8391	<attribute name="name" type="wstring">
8392	<desc>Short name of the snapshot.</desc>
8393	</attribute>
8394
8395	<attribute name="description" type="wstring">
8396	<desc>Optional description of the snapshot.</desc>
8397	</attribute>
8398
8399	<attribute name="timeStamp" type="long long" readonly="yes">
8400	<desc>
8401	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8402	</desc>
8403	</attribute>
8404
8405	<attribute name="online" type="boolean" readonly="yes">
8406	<desc>
8407	@c true if this snapshot is an online snapshot and @c false otherwise.
8408
8409	When this attribute is @c true, the
8410	<link to="IMachine::stateFilePath"/> attribute of the
8411	<link to="#machine"/> object associated with this snapshot
8412	will point to the saved state file. Otherwise, it will be
8413	an empty string.
8414	</desc>
8415	</attribute>
8416
8417	<attribute name="machine" type="IMachine" readonly="yes">
8418	<desc>
8419	Virtual machine this snapshot is taken on. This object
8420	stores all settings the machine had when taking this snapshot.
8421	<note>
8422	The returned machine object is immutable, i.e. no
8423	any settings can be changed.
8424	</note>
8425	</desc>
8426	</attribute>
8427
8428	<attribute name="parent" type="ISnapshot" readonly="yes">
8429	<desc>
8430	Parent snapshot (a snapshot this one is based on), or
8431	@c null if the snapshot has no parent (i.e. is the first snapshot).
8432	</desc>
8433	</attribute>
8434
8435	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8436	<desc>
8437	Child snapshots (all snapshots having this one as a parent).
8438	</desc>
8439	</attribute>
8440
8441	</interface>
8442
8443
8444	<!--
8445	// IMedium
8446	/////////////////////////////////////////////////////////////////////////
8447	-->
8448
8449	<enum
8450	name="MediumState"
8451	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8452	>
8453	<desc>
8454	Virtual medium state.
8455	<see>IMedium</see>
8456	</desc>
8457
8458	<const name="NotCreated" value="0">
8459	<desc>
8460	Associated medium storage does not exist (either was not created yet or
8461	was deleted).
8462	</desc>
8463	</const>
8464	<const name="Created" value="1">
8465	<desc>
8466	Associated storage exists and accessible; this gets set if the
8467	accessibility check performed by <link to="IMedium::refreshState" />
8468	was successful.
8469	</desc>
8470	</const>
8471	<const name="LockedRead" value="2">
8472	<desc>
8473	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8474	no data modification is possible.
8475	</desc>
8476	</const>
8477	<const name="LockedWrite" value="3">
8478	<desc>
8479	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8480	no concurrent data reading or modification is possible.
8481	</desc>
8482	</const>
8483	<const name="Inaccessible" value="4">
8484	<desc>
8485	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8486	not yet been performed, or else, associated medium storage is not
8487	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8488	is empty, in the second case, it describes the error that occurred.
8489	</desc>
8490	</const>
8491	<const name="Creating" value="5">
8492	<desc>
8493	Associated medium storage is being created.
8494	</desc>
8495	</const>
8496	<const name="Deleting" value="6">
8497	<desc>
8498	Associated medium storage is being deleted.
8499	</desc>
8500	</const>
8501	</enum>
8502
8503	<enum
8504	name="MediumType"
8505	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8506	>
8507	<desc>
8508	Virtual medium type.
8509	<see>IMedium</see>
8510	</desc>
8511
8512	<const name="Normal" value="0">
8513	<desc>
8514	Normal medium (attached directly or indirectly, preserved
8515	when taking snapshots).
8516	</desc>
8517	</const>
8518	<const name="Immutable" value="1">
8519	<desc>
8520	Immutable medium (attached indirectly, changes are wiped out
8521	the next time the virtual machine is started).
8522	</desc>
8523	</const>
8524	<const name="Writethrough" value="2">
8525	<desc>
8526	Write through medium (attached directly, ignored when
8527	taking snapshots).
8528	</desc>
8529	</const>
8530	<const name="Shareable" value="3">
8531	<desc>
8532	Allow using this medium concurrently by several machines.
8533	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8534	</desc>
8535	</const>
8536	<const name="Readonly" value="4">
8537	<desc>
8538	A readonly medium, which can of course be used by several machines.
8539	<note>Present and accepted since VirtualBox 4.0.</note>
8540	</desc>
8541	</const>
8542	</enum>
8543
8544	<enum
8545	name="MediumVariant"
8546	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8547	>
8548	<desc>
8549	Virtual medium image variant. More than one flag may be set.
8550	<see>IMedium</see>
8551	</desc>
8552
8553	<const name="Standard" value="0">
8554	<desc>
8555	No particular variant requested, results in using the backend default.
8556	</desc>
8557	</const>
8558	<const name="VmdkSplit2G" value="0x01">
8559	<desc>
8560	VMDK image split in chunks of less than 2GByte.
8561	</desc>
8562	</const>
8563	<const name="VmdkStreamOptimized" value="0x04">
8564	<desc>
8565	VMDK streamOptimized image. Special import/export format which is
8566	read-only/append-only.
8567	</desc>
8568	</const>
8569	<const name="VmdkESX" value="0x08">
8570	<desc>
8571	VMDK format variant used on ESX products.
8572	</desc>
8573	</const>
8574	<const name="Fixed" value="0x10000">
8575	<desc>
8576	Fixed image. Only allowed for base images.
8577	</desc>
8578	</const>
8579	<const name="Diff" value="0x20000">
8580	<desc>
8581	Differencing image. Only allowed for child images.
8582	</desc>
8583	</const>
8584	</enum>
8585
8586	<interface
8587	name="IMediumAttachment" extends="$unknown"
8588	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8589	wsmap="struct"
8590	>
8591	<desc>
8592	The IMediumAttachment interface links storage media to virtual machines.
8593	For each medium (<link to="IMedium"/>) which has been attached to a
8594	storage controller (<link to="IStorageController"/>) of a machine
8595	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8596	method, one instance of IMediumAttachment is added to the machine's
8597	<link to="IMachine::mediumAttachments"/> array attribute.
8598
8599	Each medium attachment specifies the storage controller as well as a
8600	port and device number and the IMedium instance representing a virtual
8601	hard disk or floppy or DVD image.
8602
8603	For removeable media (DVDs or floppies), there are two additional
8604	options. For one, the IMedium instance can be @c null to represent
8605	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8606	secondly, the medium can be one of the pseudo-media for host drives
8607	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8608	</desc>
8609
8610	<attribute name="medium" type="IMedium" readonly="yes">
8611	<desc>Medium object associated with this attachment; it
8612	can be @c null for removable devices.</desc>
8613	</attribute>
8614
8615	<attribute name="controller" type="wstring" readonly="yes">
8616	<desc>Name of the storage controller of this attachment; this
8617	refers to one of the controllers in <link to="IMachine::storageControllers" />
8618	by name.</desc>
8619	</attribute>
8620
8621	<attribute name="port" type="long" readonly="yes">
8622	<desc>Port number of this attachment.
8623	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8624	</desc>
8625	</attribute>
8626
8627	<attribute name="device" type="long" readonly="yes">
8628	<desc>Device slot number of this attachment.
8629	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8630	</desc>
8631	</attribute>
8632
8633	<attribute name="type" type="DeviceType" readonly="yes">
8634	<desc>Device type of this attachment.</desc>
8635	</attribute>
8636
8637	<attribute name="passthrough" type="boolean" readonly="yes">
8638	<desc>Pass I/O requests through to a device on the host.</desc>
8639	</attribute>
8640
8641	<attribute name="bandwidthLimit" type="unsigned long">
8642	<desc>
8643	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8644	A zero value means uncapped/unlimited.
8645	</desc>
8646	</attribute>
8647
8648	</interface>
8649
8650	<interface
8651	name="IMedium" extends="$unknown"
8652	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8653	wsmap="managed"
8654	>
8655	<desc>
8656	The IMedium interface represents virtual storage for a machine's
8657	hard disks, CD/DVD or floppy drives. It will typically represent
8658	a disk image on the host, for example a VDI or VMDK file representing
8659	a virtual hard disk, or an ISO or RAW file representing virtual
8660	removable media, but can also point to a network location (e.g.
8661	for iSCSI targets).
8662
8663	Instances of IMedium are connected to virtual machines by way of
8664	medium attachments (see <link to="IMediumAttachment" />), which link
8665	the storage medium to a particular device slot of a storage controller
8666	of the virtual machine.
8667	In the VirtualBox API, virtual storage is therefore always represented
8668	by the following chain of object links:
8669
8670	<ul>
8671	<li><link to="IMachine::storageControllers"/> contains an array of
8672	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8673	these are instances of <link to="IStorageController"/>).</li>
8674	<li><link to="IMachine::mediumAttachments"/> contains an array of
8675	medium attachments (instances of <link to="IMediumAttachment"/>),
8676	each containing a storage controller from the above array, a
8677	port/device specification, and an instance of IMedium representing
8678	the medium storage (image file).
8679
8680	For removable media, the storage medium is optional; a medium
8681	attachment with no medium represents a CD/DVD or floppy drive
8682	with no medium inserted. By contrast, hard disk attachments
8683	will always have an IMedium object attached.</li>
8684	<li>Each IMedium in turn points to a storage unit (such as a file
8685	on the host computer or a network resource) that holds actual
8686	data. This location is represented by the <link to="#location"/>
8687	attribute.</li>
8688	</ul>
8689
8690	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8691	new hard disk media can be created with the VirtualBox API using the
8692	<link to="IVirtualBox::createHardDisk"/> method.
8693
8694	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8695	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8696	type in a regular file.
8697
8698	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8699	drive; in that case the <link to="#id" /> attribute contains the UUID of
8700	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8701
8702	<h3>Known media</h3>
8703
8704	When an existing medium is opened and attached to a virtual machine, it
8705	is automatically added to a media registry. If the medium has first
8706	been attached to a machine which was created by VirtualBox 4.0 or later,
8707	it is added to that machine's media registry (in the machine XML settings
8708	file; this way all information about a machine's media attachments is
8709	contained in a single file). For older media attachments (i.e. if the
8710	medium was first attached to a machine which was created with a VirtualBox
8711	version before 4.0), media continue to be registered in the global
8712	VirtualBox settings file, for backwards compatibility.
8713
8714	See <link to="IVirtualBox::openMedium" /> for more information.
8715
8716	All known media can be enumerated using
8717	<link to="IVirtualBox::hardDisks"/>,
8718	<link to="IVirtualBox::DVDImages"/> and
8719	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8720	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8721
8722	Only known media can be attached to virtual machines.
8723
8724	Removing known media from the media registry is performed when the given
8725	medium is closed using the <link to="#close"/> method or when its
8726	associated storage unit is deleted.
8727
8728	<h3>Accessibility checks</h3>
8729
8730	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8731	method is called explicitly on a medium. This is done to make the VirtualBox object
8732	ready for serving requests as fast as possible and let the end-user
8733	application decide if it needs to check media accessibility right away or not.
8734
8735	As a result, when VirtualBox starts up (e.g. the VirtualBox
8736	object gets created for the first time), all known media are in the
8737	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8738	attribute is an empty string because no actual accessibility check has
8739	been made yet.
8740
8741	After calling <link to="#refreshState" />, a medium is considered
8742	<i>accessible</i> if its storage unit can be read. In that case, the
8743	<link to="#state"/> attribute has a value of "Created". If the storage
8744	unit cannot be read (for example, because it is located on a disconnected
8745	network resource, or was accidentally deleted outside VirtualBox),
8746	the medium is considered <i>inaccessible</i>, which is indicated by the
8747	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8748	obtained by reading the <link to="#lastAccessError"/> attribute.
8749
8750	<h3>Medium types</h3>
8751
8752	There are four types of medium behavior (see <link to="MediumType" />):
8753	"normal", "immutable", "writethrough" and "shareable", represented by the
8754	<link to="#type"/> attribute. The type of the medium defines how the
8755	medium is attached to a virtual machine and what happens when a
8756	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8757	attached medium is taken. At the moment DVD and floppy media are always
8758	of type "writethrough".
8759
8760	All media can be also divided in two groups: <i>base</i> media and
8761	<i>differencing</i> media. A base medium contains all sectors of the
8762	medium data in its own storage and therefore can be used independently.
8763	In contrast, a differencing medium is a "delta" to some other medium and
8764	contains only those sectors which differ from that other medium, which is
8765	then called a <i>parent</i>. The differencing medium is said to be
8766	<i>linked to</i> that parent. The parent may be itself a differencing
8767	medium, thus forming a chain of linked media. The last element in that
8768	chain must always be a base medium. Note that several differencing
8769	media may be linked to the same parent medium.
8770
8771	Differencing media can be distinguished from base media by querying the
8772	<link to="#parent"/> attribute: base media do not have parents they would
8773	depend on, so the value of this attribute is always @c null for them.
8774	Using this attribute, it is possible to walk up the medium tree (from the
8775	child medium to its parent). It is also possible to walk down the tree
8776	using the <link to="#children"/> attribute.
8777
8778	Note that the type of all differencing media is "normal"; all other
8779	values are meaningless for them. Base media may be of any type.
8780
8781	<h3>Creating hard disks</h3>
8782
8783	New base hard disks are created using
8784	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8785	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8786	disks are usually implicitly created by VirtualBox when needed but may
8787	also be created explicitly using <link to="#createDiffStorage"/>.
8788
8789	After the hard disk is successfully created (including the storage unit)
8790	or opened, it becomes a known hard disk (remembered in the internal media
8791	registry). Known hard disks can be attached to a virtual machine, accessed
8792	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8793	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8794
8795	The following methods, besides <link to="IMedium::close"/>,
8796	automatically remove the hard disk from the media registry:
8797	<ul>
8798	<li><link to="#deleteStorage"/></li>
8799	<li><link to="#mergeTo"/></li>
8800	</ul>
8801
8802	If the storage unit of the hard disk is a regular file in the host's
8803	file system then the rules stated in the description of the
8804	<link to="IMedium::location"/> attribute apply when setting its value.
8805
8806	<h4>Automatic composition of the file name part</h4>
8807
8808	Another extension to the <link to="IMedium::location"/> attribute is that
8809	there is a possibility to cause VirtualBox to compose a unique value for
8810	the file name part of the location using the UUID of the hard disk. This
8811	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8812	e.g. before the storage unit is created, and works as follows. You set the
8813	value of the <link to="IMedium::location"/> attribute to a location
8814	specification which only contains the path specification but not the file
8815	name part and ends with either a forward slash or a backslash character.
8816	In response, VirtualBox will generate a new UUID for the hard disk and
8817	compose the file name using the following pattern:
8818	<pre>
8819	<path>/{<uuid>}.<ext>
8820	</pre>
8821	where <tt><path></tt> is the supplied path specification,
8822	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8823	is the default extension for the storage format of this hard disk. After
8824	that, you may call any of the methods that create a new hard disk storage
8825	unit and they will use the generated UUID and file name.
8826
8827	<h3>Attaching Hard Disks</h3>
8828
8829	Hard disks are attached to virtual machines using the
8830	<link to="IMachine::attachDevice"/> method and detached using the
8831	<link to="IMachine::detachDevice"/> method. Depending on their
8832	<link to="#type"/>, hard disks are attached either
8833	<i>directly</i> or <i>indirectly</i>.
8834
8835	When a hard disk is being attached directly, it is associated with the
8836	virtual machine and used for hard disk operations when the machine is
8837	running. When a hard disk is being attached indirectly, a new differencing
8838	hard disk linked to it is implicitly created and this differencing hard
8839	disk is associated with the machine and used for hard disk operations.
8840	This also means that if <link to="IMachine::attachDevice"/> performs
8841	a direct attachment then the same hard disk will be returned in response
8842	to the subsequent <link to="IMachine::getMedium"/> call; however if
8843	an indirect attachment is performed then
8844	<link to="IMachine::getMedium"/> will return the implicitly created
8845	differencing hard disk, not the original one passed to <link
8846	to="IMachine::attachDevice"/>. In detail:
8847
8848	<ul>
8849	<li><b>Normal base</b> hard disks that do not have children (i.e.
8850	differencing hard disks linked to them) and that are not already
8851	attached to virtual machines in snapshots are attached <b>directly</b>.
8852	Otherwise, they are attached <b>indirectly</b> because having
8853	dependent children or being part of the snapshot makes it impossible
8854	to modify hard disk contents without breaking the integrity of the
8855	dependent party. The <link to="#readOnly"/> attribute allows to
8856	quickly determine the kind of the attachment for the given hard
8857	disk. Note that if a normal base hard disk is to be indirectly
8858	attached to a virtual machine with snapshots then a special
8859	procedure called <i>smart attachment</i> is performed (see below).</li>
8860	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8861	they are attached <b>directly</b> if they do not have children and are
8862	not attached to virtual machines in snapshots, and <b>indirectly</b>
8863	otherwise. Note that the smart attachment procedure is never performed
8864	for differencing hard disks.</li>
8865	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8866	they are designed to be non-writable. If an immutable hard disk is
8867	attached to a virtual machine with snapshots then a special
8868	procedure called smart attachment is performed (see below).</li>
8869	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8870	also as designed. This also means that writethrough hard disks cannot
8871	have other hard disks linked to them at all.</li>
8872	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8873	also as designed. This also means that shareable hard disks cannot
8874	have other hard disks linked to them at all. They behave almost
8875	like writethrough hard disks, except that shareable hard disks can
8876	be attached to several virtual machines which are running, allowing
8877	concurrent accesses. You need special cluster software running in
8878	the virtual machines to make use of such disks.</li>
8879	</ul>
8880
8881	Note that the same hard disk, regardless of its type, may be attached to
8882	more than one virtual machine at a time. In this case, the machine that is
8883	started first gains exclusive access to the hard disk and attempts to
8884	start other machines having this hard disk attached will fail until the
8885	first machine is powered down.
8886
8887	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8888	that the given hard disk remains associated with the given machine after a
8889	successful <link to="IMachine::detachDevice"/> call until
8890	<link to="IMachine::saveSettings"/> is called to save all changes to
8891	machine settings to disk. This deferring is necessary to guarantee that
8892	the hard disk configuration may be restored at any time by a call to
8893	<link to="IMachine::discardSettings"/> before the settings
8894	are saved (committed).
8895
8896	Note that if <link to="IMachine::discardSettings"/> is called after
8897	indirectly attaching some hard disks to the machine but before a call to
8898	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8899	all differencing hard disks implicitly created by
8900	<link to="IMachine::attachDevice"/> for these indirect attachments.
8901	Such implicitly created hard disks will also be immediately deleted when
8902	detached explicitly using the <link to="IMachine::detachDevice"/>
8903	call if it is made before <link to="IMachine::saveSettings"/>. This
8904	implicit deletion is safe because newly created differencing hard
8905	disks do not contain any user data.
8906
8907	However, keep in mind that detaching differencing hard disks that were
8908	implicitly created by <link to="IMachine::attachDevice"/>
8909	before the last <link to="IMachine::saveSettings"/> call will
8910	<b>not</b> implicitly delete them as they may already contain some data
8911	(for example, as a result of virtual machine execution). If these hard
8912	disks are no more necessary, the caller can always delete them explicitly
8913	using <link to="#deleteStorage"/> after they are actually de-associated
8914	from this machine by the <link to="IMachine::saveSettings"/> call.
8915
8916	<h3>Smart Attachment</h3>
8917
8918	When normal base or immutable hard disks are indirectly attached to a
8919	virtual machine then some additional steps are performed to make sure the
8920	virtual machine will have the most recent "view" of the hard disk being
8921	attached. These steps include walking through the machine's snapshots
8922	starting from the current one and going through ancestors up to the first
8923	snapshot. Hard disks attached to the virtual machine in all
8924	of the encountered snapshots are checked whether they are descendants of
8925	the given normal base or immutable hard disk. The first found child (which
8926	is the differencing hard disk) will be used instead of the normal base or
8927	immutable hard disk as a parent for creating a new differencing hard disk
8928	that will be actually attached to the machine. And only if no descendants
8929	are found or if the virtual machine does not have any snapshots then the
8930	normal base or immutable hard disk will be used itself as a parent for
8931	this differencing hard disk.
8932
8933	It is easier to explain what smart attachment does using the
8934	following example:
8935	<pre>
8936	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8937
8938	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8939	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8940	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8941	Snapshot 4 (none) Snapshot 4 (none)
8942	CurState (none) CurState (D3->D2.vdi)
8943
8944	NOT
8945	...
8946	CurState (D3->B.vdi)
8947	</pre>
8948	The first column is the virtual machine configuration before the base hard
8949	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8950	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8951	mean that the hard disk that is actually attached to the machine is a
8952	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8953	another hard disk, <tt>B.vdi</tt>.
8954
8955	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8956	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8957	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8958	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8959	it cannot be attached directly and needs an indirect attachment (i.e.
8960	implicit creation of a new differencing hard disk). Due to the smart
8961	attachment procedure, the new differencing hard disk
8962	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8963	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8964	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8965	machine.
8966
8967	Note that if there is more than one descendant hard disk of the given base
8968	hard disk found in a snapshot, and there is an exact device, channel and
8969	bus match, then this exact match will be used. Otherwise, the youngest
8970	descendant will be picked up.
8971
8972	There is one more important aspect of the smart attachment procedure which
8973	is not related to snapshots at all. Before walking through the snapshots
8974	as described above, the backup copy of the current list of hard disk
8975	attachment is searched for descendants. This backup copy is created when
8976	the hard disk configuration is changed for the first time after the last
8977	<link to="IMachine::saveSettings"/> call and used by
8978	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8979	changes. When such a descendant is found in this backup copy, it will be
8980	simply re-attached back, without creating a new differencing hard disk for
8981	it. This optimization is necessary to make it possible to re-attach the
8982	base or immutable hard disk to a different bus, channel or device slot
8983	without losing the contents of the differencing hard disk actually
8984	attached to the machine in place of it.
8985	</desc>
8986
8987	<attribute name="id" type="uuid" mod="string" readonly="yes">
8988	<desc>
8989	UUID of the medium. For a newly created medium, this value is a randomly
8990	generated UUID.
8991
8992	<note>
8993	For media in one of MediumState_NotCreated, MediumState_Creating or
8994	MediumState_Deleting states, the value of this property is undefined
8995	and will most likely be an empty UUID.
8996	</note>
8997	</desc>
8998	</attribute>
8999
9000	<attribute name="description" type="wstring">
9001	<desc>
9002	Optional description of the medium. For a newly created medium the value
9003	of this attribute is an empty string.
9004
9005	Medium types that don't support this attribute will return E_NOTIMPL in
9006	attempt to get or set this attribute's value.
9007
9008	<note>
9009	For some storage types, reading this attribute may return an outdated
9010	(last known) value when <link to="#state"/> is <link
9011	to="MediumState_Inaccessible"/> or <link
9012	to="MediumState_LockedWrite"/> because the value of this attribute is
9013	stored within the storage unit itself. Also note that changing the
9014	attribute value is not possible in such case, as well as when the
9015	medium is the <link to="MediumState_LockedRead"/> state.
9016	</note>
9017	</desc>
9018	</attribute>
9019
9020	<attribute name="state" type="MediumState" readonly="yes">
9021	<desc>
9022	Returns the current medium state, which is the last state set by
9023	the accessibility check performed by <link to="#refreshState"/>.
9024	If that method has not yet been called on the medium, the state
9025	is "Inaccessible"; as opposed to truly inaccessible media, the
9026	value of <link to="#lastAccessError"/> will be an empty string in
9027	that case.
9028
9029	<note>As of version 3.1, this no longer performs an accessibility check
9030	automatically; call <link to="#refreshState"/> for that.
9031	</note>
9032	</desc>
9033	</attribute>
9034
9035	<attribute name="variant" type="MediumVariant" readonly="yes">
9036	<desc>
9037	Returns the storage format variant information for this medium.
9038	Before <link to="#refreshState"/> is called this method returns
9039	an undefined value.
9040	</desc>
9041	</attribute>
9042
9043	<attribute name="location" type="wstring">
9044	<desc>
9045	Location of the storage unit holding medium data.
9046
9047	The format of the location string is medium type specific. For medium
9048	types using regular files in a host's file system, the location
9049	string is the full file name.
9050
9051	Some medium types may support changing the storage unit location by
9052	simply changing the value of this property. If this operation is not
9053	supported, the implementation will return E_NOTIMPL in attempt to set
9054	this attribute's value.
9055
9056	When setting a value of the location attribute which is a regular file
9057	in the host's file system, the given file name may be either relative to
9058	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9059	absolute. Note that if the given location specification does not contain
9060	the file extension part then a proper default extension will be
9061	automatically appended by the implementation depending on the medium type.
9062	</desc>
9063	</attribute>
9064
9065	<attribute name="name" type="wstring" readonly="yes">
9066	<desc>
9067	Name of the storage unit holding medium data.
9068
9069	The returned string is a short version of the <link to="#location"/>
9070	attribute that is suitable for representing the medium in situations
9071	where the full location specification is too long (such as lists
9072	and comboboxes in GUI frontends). This string is also used by frontends
9073	to sort the media list alphabetically when needed.
9074
9075	For example, for locations that are regular files in the host's file
9076	system, the value of this attribute is just the file name (+ extension),
9077	without the path specification.
9078
9079	Note that as opposed to the <link to="#location"/> attribute, the name
9080	attribute will not necessary be unique for a list of media of the
9081	given type and format.
9082	</desc>
9083	</attribute>
9084
9085	<attribute name="deviceType" type="DeviceType" readonly="yes">
9086	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9087	medium.</desc>
9088	</attribute>
9089
9090	<attribute name="hostDrive" type="boolean" readonly="yes">
9091	<desc>True if this corresponds to a drive on the host.</desc>
9092	</attribute>
9093
9094	<attribute name="size" type="long long" readonly="yes">
9095	<desc>
9096	Physical size of the storage unit used to hold medium data (in bytes).
9097
9098	<note>
9099	For media whose <link to="#state"/> is <link
9100	to="MediumState_Inaccessible"/>, the value of this property is the
9101	last known size. For <link to="MediumState_NotCreated"/> media,
9102	the returned value is zero.
9103	</note>
9104	</desc>
9105	</attribute>
9106
9107	<attribute name="format" type="wstring" readonly="yes">
9108	<desc>
9109	Storage format of this medium.
9110
9111	The value of this attribute is a string that specifies a backend used
9112	to store medium data. The storage format is defined when you create a
9113	new medium or automatically detected when you open an existing medium,
9114	and cannot be changed later.
9115
9116	The list of all storage formats supported by this VirtualBox
9117	installation can be obtained using
9118	<link to="ISystemProperties::mediumFormats"/>.
9119	</desc>
9120	</attribute>
9121
9122	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9123	<desc>
9124	Storage medium format object corresponding to this medium.
9125
9126	The value of this attribute is a reference to the medium format object
9127	that specifies the backend properties used to store medium data. The
9128	storage format is defined when you create a new medium or automatically
9129	detected when you open an existing medium, and cannot be changed later.
9130
9131	<note>@c null is returned if there is no associated medium format
9132	object. This can e.g. happen for medium objects representing host
9133	drives and other special medium objects.</note>
9134	</desc>
9135	</attribute>
9136
9137	<attribute name="type" type="MediumType">
9138	<desc>
9139	Type (role) of this medium.
9140
9141	The following constraints apply when changing the value of this
9142	attribute:
9143	<ul>
9144	<li>If a medium is attached to a virtual machine (either in the
9145	current state or in one of the snapshots), its type cannot be
9146	changed.
9147	</li>
9148	<li>As long as the medium has children, its type cannot be set
9149	to <link to="MediumType_Writethrough"/>.
9150	</li>
9151	<li>The type of all differencing media is
9152	<link to="MediumType_Normal"/> and cannot be changed.
9153	</li>
9154	</ul>
9155
9156	The type of a newly created or opened medium is set to
9157	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9158	which have a type of <link to="MediumType_Writethrough"/>.
9159	</desc>
9160	</attribute>
9161
9162	<attribute name="parent" type="IMedium" readonly="yes">
9163	<desc>
9164	Parent of this medium (the medium this medium is directly based
9165	on).
9166
9167	Only differencing media have parents. For base (non-differencing)
9168	media, @c null is returned.
9169	</desc>
9170	</attribute>
9171
9172	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9173	<desc>
9174	Children of this medium (all differencing media directly based
9175	on this medium). A @c null array is returned if this medium
9176	does not have any children.
9177	</desc>
9178	</attribute>
9179
9180	<attribute name="base" type="IMedium" readonly="yes">
9181	<desc>
9182	Base medium of this medium.
9183
9184	If this is a differencing medium, its base medium is the medium
9185	the given medium branch starts from. For all other types of media, this
9186	property returns the medium object itself (i.e. the same object this
9187	property is read on).
9188	</desc>
9189	</attribute>
9190
9191	<attribute name="readOnly" type="boolean" readonly="yes">
9192	<desc>
9193	Returns @c true if this medium is read-only and @c false otherwise.
9194
9195	A medium is considered to be read-only when its contents cannot be
9196	modified without breaking the integrity of other parties that depend on
9197	this medium such as its child media or snapshots of virtual machines
9198	where this medium is attached to these machines. If there are no
9199	children and no such snapshots then there is no dependency and the
9200	medium is not read-only.
9201
9202	The value of this attribute can be used to determine the kind of the
9203	attachment that will take place when attaching this medium to a
9204	virtual machine. If the value is @c false then the medium will
9205	be attached directly. If the value is @c true then the medium
9206	will be attached indirectly by creating a new differencing child
9207	medium for that. See the interface description for more information.
9208
9209	Note that all <link to="MediumType_Immutable">Immutable</link> media
9210	are always read-only while all
9211	<link to="MediumType_Writethrough">Writethrough</link> media are
9212	always not.
9213
9214	<note>
9215	The read-only condition represented by this attribute is related to
9216	the medium type and usage, not to the current
9217	<link to="IMedium::state">medium state</link> and not to the read-only
9218	state of the storage unit.
9219	</note>
9220	</desc>
9221	</attribute>
9222
9223	<attribute name="logicalSize" type="long long" readonly="yes">
9224	<desc>
9225	Logical size of this medium (in bytes), as reported to the
9226	guest OS running inside the virtual machine this medium is
9227	attached to. The logical size is defined when the medium is created
9228	and cannot be changed later.
9229
9230	<note>
9231	Reading this property on a differencing medium will return the size
9232	of its <link to="#base"/> medium.
9233	</note>
9234	<note>
9235	For media whose state is <link to="#state"/> is <link
9236	to="MediumState_Inaccessible"/>, the value of this property is the
9237	last known logical size. For <link to="MediumState_NotCreated"/>
9238	media, the returned value is zero.
9239	</note>
9240	</desc>
9241	</attribute>
9242
9243	<attribute name="autoReset" type="boolean">
9244	<desc>
9245	Whether this differencing medium will be automatically reset each
9246	time a virtual machine it is attached to is powered up. This
9247	attribute is automatically set to @c true for the last
9248	differencing image of an "immutable" medium (see
9249	<link to="MediumType" />).
9250
9251	See <link to="#reset"/> for more information about resetting
9252	differencing media.
9253
9254	<note>
9255	Reading this property on a base (non-differencing) medium will
9256	always @c false. Changing the value of this property in this
9257	case is not supported.
9258	</note>
9259
9260	<result name="VBOX_E_NOT_SUPPORTED">
9261	This is not a differencing medium (when changing the attribute
9262	value).
9263	</result>
9264	</desc>
9265	</attribute>
9266
9267	<attribute name="lastAccessError" type="wstring" readonly="yes">
9268	<desc>
9269	Text message that represents the result of the last accessibility
9270	check performed by <link to="#refreshState"/>.
9271
9272	An empty string is returned if the last accessibility check
9273	was successful or has not yet been called. As a result, if
9274	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9275	then <link to="#refreshState"/> has yet to be called; this is the
9276	default value of media after VirtualBox initialization.
9277	A non-empty string indicates a failure and should normally describe
9278	a reason of the failure (for example, a file read error).
9279	</desc>
9280	</attribute>
9281
9282	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9283	<desc>
9284	Array of UUIDs of all machines this medium is attached to.
9285
9286	A @c null array is returned if this medium is not attached to any
9287	machine or to any machine's snapshot.
9288
9289	<note>
9290	The returned array will include a machine even if this medium is not
9291	attached to that machine in the current state but attached to it in
9292	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9293	details.
9294	</note>
9295	</desc>
9296	</attribute>
9297
9298	<method name="setIDs">
9299	<desc>
9300	Changes the UUID and parent UUID for a hard disk medium.
9301	</desc>
9302	<param name="setImageId" type="boolean" dir="in">
9303	<desc>
9304	Select whether a new image UUID is set or not.
9305	</desc>
9306	</param>
9307	<param name="imageId" type="uuid" mod="string" dir="in">
9308	<desc>
9309	New UUID for the image. If an empty string is passed, then a new
9310	UUID is automatically created, provided that @a setImageId is @c true.
9311	Specifying a zero UUID is not allowed.
9312	</desc>
9313	</param>
9314	<param name="setParentId" type="boolean" dir="in">
9315	<desc>
9316	Select whether a new parent UUID is set or not.
9317	</desc>
9318	</param>
9319	<param name="parentId" type="uuid" mod="string" dir="in">
9320	<desc>
9321	New parent UUID for the image. If an empty string is passed, then a
9322	new UUID is automatically created, provided @a setParentId is
9323	@c true. A zero UUID is valid.
9324	</desc>
9325	</param>
9326	<result name="E_INVALIDARG">
9327	Invalid parameter combination.
9328	</result>
9329	<result name="VBOX_E_NOT_SUPPORTED">
9330	Medium is not a hard disk medium.
9331	</result>
9332	</method>
9333
9334	<method name="refreshState">
9335	<desc>
9336	If the current medium state (see <link to="MediumState"/>) is one of
9337	"Created", "Inaccessible" or "LockedRead", then this performs an
9338	accessibility check on the medium and sets the value of the <link to="#state"/>
9339	attribute accordingly; that value is also returned for convenience.
9340
9341	For all other state values, this does not perform a refresh but returns
9342	the state only.
9343
9344	The refresh, if performed, may take a long time (several seconds or even
9345	minutes, depending on the storage unit location and format) because it performs an
9346	accessibility check of the storage unit. This check may cause a significant
9347	delay if the storage unit of the given medium is, for example, a file located
9348	on a network share which is not currently accessible due to connectivity
9349	problems. In that case, the call will not return until a timeout
9350	interval defined by the host OS for this operation expires. For this reason,
9351	it is recommended to never read this attribute on the main UI thread to avoid
9352	making the UI unresponsive.
9353
9354	If the last known state of the medium is "Created" and the accessibility
9355	check fails, then the state would be set to "Inaccessible", and
9356	<link to="#lastAccessError"/> may be used to get more details about the
9357	failure. If the state of the medium is "LockedRead", then it remains the
9358	same, and a non-empty value of <link to="#lastAccessError"/> will
9359	indicate a failed accessibility check in this case.
9360
9361	Note that not all medium states are applicable to all medium types.
9362	</desc>
9363	<param name="state" type="MediumState" dir="return">
9364	<desc>
9365	New medium state.
9366	</desc>
9367	</param>
9368	</method>
9369
9370	<method name="getSnapshotIds">
9371	<desc>
9372	Returns an array of UUIDs of all snapshots of the given machine where
9373	this medium is attached to.
9374
9375	If the medium is attached to the machine in the current state, then the
9376	first element in the array will always be the ID of the queried machine
9377	(i.e. the value equal to the @c machineId argument), followed by
9378	snapshot IDs (if any).
9379
9380	If the medium is not attached to the machine in the current state, then
9381	the array will contain only snapshot IDs.
9382
9383	The returned array may be @c null if this medium is not attached
9384	to the given machine at all, neither in the current state nor in one of
9385	the snapshots.
9386	</desc>
9387	<param name="machineId" type="uuid" mod="string" dir="in">
9388	<desc>
9389	UUID of the machine to query.
9390	</desc>
9391	</param>
9392	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9393	<desc>
9394	Array of snapshot UUIDs of the given machine using this medium.
9395	</desc>
9396	</param>
9397	</method>
9398
9399	<method name="lockRead">
9400	<desc>
9401	Locks this medium for reading.
9402
9403	A read lock is shared: many clients can simultaneously lock the
9404	same medium for reading unless it is already locked for writing (see
9405	<link to="#lockWrite"/>) in which case an error is returned.
9406
9407	When the medium is locked for reading, it cannot be modified
9408	from within VirtualBox. This means that any method that changes
9409	the properties of this medium or contents of the storage unit
9410	will return an error (unless explicitly stated otherwise). That
9411	includes an attempt to start a virtual machine that wants to
9412	write to the the medium.
9413
9414	When the virtual machine is started up, it locks for reading all
9415	media it uses in read-only mode. If some medium cannot be locked
9416	for reading, the startup procedure will fail.
9417	A medium is typically locked for reading while it is used by a running
9418	virtual machine but has a depending differencing image that receives
9419	the actual write operations. This way one base medium can have
9420	multiple child differencing images which can be written to
9421	simultaneously. Read-only media such as DVD and floppy images are
9422	also locked for reading only (so they can be in use by multiple
9423	machines simultaneously).
9424
9425	A medium is also locked for reading when it is the source of a
9426	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9427
9428	The medium locked for reading must be unlocked using the <link
9429	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9430	can be nested and must be followed by the same number of paired
9431	<link to="#unlockRead"/> calls.
9432
9433	This method sets the medium state (see <link to="#state"/>) to
9434	"LockedRead" on success. The medium's previous state must be
9435	one of "Created", "Inaccessible" or "LockedRead".
9436
9437	Locking an inaccessible medium is not an error; this method performs
9438	a logical lock that prevents modifications of this medium through
9439	the VirtualBox API, not a physical file-system lock of the underlying
9440	storage unit.
9441
9442	This method returns the current state of the medium
9443	<i>before</i> the operation.
9444
9445	<result name="VBOX_E_INVALID_OBJECT_STATE">
9446	Invalid medium state (e.g. not created, locked, inaccessible,
9447	creating, deleting).
9448	</result>
9449
9450	</desc>
9451	<param name="state" type="MediumState" dir="return">
9452	<desc>
9453	State of the medium after the operation.
9454	</desc>
9455	</param>
9456	</method>
9457
9458	<method name="unlockRead">
9459	<desc>
9460	Cancels the read lock previously set by <link to="#lockRead"/>.
9461
9462	For both success and failure, this method returns the current state
9463	of the medium <i>after</i> the operation.
9464
9465	See <link to="#lockRead"/> for more details.
9466
9467	<result name="VBOX_E_INVALID_OBJECT_STATE">
9468	Medium not locked for reading.
9469	</result>
9470
9471	</desc>
9472	<param name="state" type="MediumState" dir="return">
9473	<desc>
9474	State of the medium after the operation.
9475	</desc>
9476	</param>
9477	</method>
9478
9479	<method name="lockWrite">
9480	<desc>
9481	Locks this medium for writing.
9482
9483	A write lock, as opposed to <link to="#lockRead"/>, is
9484	exclusive: there may be only one client holding a write lock,
9485	and there may be no read locks while the write lock is held.
9486	As a result, read-locking fails if a write lock is held, and
9487	write-locking fails if either a read or another write lock is held.
9488
9489	When a medium is locked for writing, it cannot be modified
9490	from within VirtualBox, and it is not guaranteed that the values
9491	of its properties are up-to-date. Any method that changes the
9492	properties of this medium or contents of the storage unit will
9493	return an error (unless explicitly stated otherwise).
9494
9495	When a virtual machine is started up, it locks for writing all
9496	media it uses to write data to. If any medium could not be locked
9497	for writing, the startup procedure will fail. If a medium has
9498	differencing images, then while the machine is running, only
9499	the last ("leaf") differencing image is locked for writing,
9500	whereas its parents are locked for reading only.
9501
9502	A medium is also locked for writing when it is the target of a
9503	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9504
9505	The medium locked for writing must be unlocked using the <link
9506	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9507
9508	This method sets the medium state (see <link to="#state"/>) to
9509	"LockedWrite" on success. The medium's previous state must be
9510	either "Created" or "Inaccessible".
9511
9512	Locking an inaccessible medium is not an error; this method performs
9513	a logical lock that prevents modifications of this medium through
9514	the VirtualBox API, not a physical file-system lock of the underlying
9515	storage unit.
9516
9517	For both, success and failure, this method returns the current
9518	state of the medium <i>before</i> the operation.
9519
9520	<result name="VBOX_E_INVALID_OBJECT_STATE">
9521	Invalid medium state (e.g. not created, locked, inaccessible,
9522	creating, deleting).
9523	</result>
9524
9525	</desc>
9526	<param name="state" type="MediumState" dir="return">
9527	<desc>
9528	State of the medium after the operation.
9529	</desc>
9530	</param>
9531	</method>
9532
9533	<method name="unlockWrite">
9534	<desc>
9535	Cancels the write lock previously set by <link to="#lockWrite"/>.
9536
9537	For both success and failure, this method returns the current
9538	state of the medium <i>after</i> the operation.
9539
9540	See <link to="#lockWrite"/> for more details.
9541
9542	<result name="VBOX_E_INVALID_OBJECT_STATE">
9543	Medium not locked for writing.
9544	</result>
9545
9546	</desc>
9547	<param name="state" type="MediumState" dir="return">
9548	<desc>
9549	State of the medium after the operation.
9550	</desc>
9551	</param>
9552	</method>
9553
9554	<method name="close">
9555	<desc>
9556	Closes this medium.
9557
9558	The medium must not be attached to any known virtual machine
9559	and must not have any known child media, otherwise the
9560	operation will fail.
9561
9562	When the medium is successfully closed, it is removed from
9563	the list of registered media, but its storage unit is not
9564	deleted. In particular, this means that this medium can
9565	later be opened again using the <link to="IVirtualBox::openMedium"/>
9566	call.
9567
9568	Note that after this method successfully returns, the given medium
9569	object becomes uninitialized. This means that any attempt
9570	to call any of its methods or attributes will fail with the
9571	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9572
9573	<result name="VBOX_E_INVALID_OBJECT_STATE">
9574	Invalid medium state (other than not created, created or
9575	inaccessible).
9576	</result>
9577	<result name="VBOX_E_OBJECT_IN_USE">
9578	Medium attached to virtual machine.
9579	</result>
9580	<result name="VBOX_E_FILE_ERROR">
9581	Settings file not accessible.
9582	</result>
9583	<result name="VBOX_E_XML_ERROR">
9584	Could not parse the settings file.
9585	</result>
9586
9587	</desc>
9588	</method>
9589
9590	<!-- storage methods -->
9591
9592	<method name="getProperty">
9593	<desc>
9594	Returns the value of the custom medium property with the given name.
9595
9596	The list of all properties supported by the given medium format can
9597	be obtained with <link to="IMediumFormat::describeProperties"/>.
9598
9599	Note that if this method returns an empty string in @a value, the
9600	requested property is supported but currently not assigned any value.
9601
9602	<result name="VBOX_E_OBJECT_NOT_FOUND">
9603	Requested property does not exist (not supported by the format).
9604	</result>
9605	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9606	</desc>
9607	<param name="name" type="wstring" dir="in">
9608	<desc>Name of the property to get.</desc>
9609	</param>
9610	<param name="value" type="wstring" dir="return">
9611	<desc>Current property value.</desc>
9612	</param>
9613	</method>
9614
9615	<method name="setProperty">
9616	<desc>
9617	Sets the value of the custom medium property with the given name.
9618
9619	The list of all properties supported by the given medium format can
9620	be obtained with <link to="IMediumFormat::describeProperties"/>.
9621
9622	Note that setting the property value to @c null or an empty string is
9623	equivalent to deleting the existing value. A default value (if it is
9624	defined for this property) will be used by the format backend in this
9625	case.
9626
9627	<result name="VBOX_E_OBJECT_NOT_FOUND">
9628	Requested property does not exist (not supported by the format).
9629	</result>
9630	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9631	</desc>
9632	<param name="name" type="wstring" dir="in">
9633	<desc>Name of the property to set.</desc>
9634	</param>
9635	<param name="value" type="wstring" dir="in">
9636	<desc>Property value to set.</desc>
9637	</param>
9638	</method>
9639
9640	<method name="getProperties">
9641	<desc>
9642	Returns values for a group of properties in one call.
9643
9644	The names of the properties to get are specified using the @a names
9645	argument which is a list of comma-separated property names or
9646	an empty string if all properties are to be returned. Note that currently
9647	the value of this argument is ignored and the method always returns all
9648	existing properties.
9649
9650	The list of all properties supported by the given medium format can
9651	be obtained with <link to="IMediumFormat::describeProperties"/>.
9652
9653	The method returns two arrays, the array of property names corresponding
9654	to the @a names argument and the current values of these properties.
9655	Both arrays have the same number of elements with each elemend at the
9656	given index in the first array corresponds to an element at the same
9657	index in the second array.
9658
9659	Note that for properties that do not have assigned values,
9660	an empty string is returned at the appropriate index in the
9661	@a returnValues array.
9662
9663	</desc>
9664	<param name="names" type="wstring" dir="in">
9665	<desc>
9666	Names of properties to get.
9667	</desc>
9668	</param>
9669	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9670	<desc>Names of returned properties.</desc>
9671	</param>
9672	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9673	<desc>Values of returned properties.</desc>
9674	</param>
9675	</method>
9676
9677	<method name="setProperties">
9678	<desc>
9679	Sets values for a group of properties in one call.
9680
9681	The names of the properties to set are passed in the @a names
9682	array along with the new values for them in the @a values array. Both
9683	arrays have the same number of elements with each elemend at the given
9684	index in the first array corresponding to an element at the same index
9685	in the second array.
9686
9687	If there is at least one property name in @a names that is not valid,
9688	the method will fail before changing the values of any other properties
9689	from the @a names array.
9690
9691	Using this method over <link to="#setProperty"/> is preferred if you
9692	need to set several properties at once since it will result into less
9693	IPC calls.
9694
9695	The list of all properties supported by the given medium format can
9696	be obtained with <link to="IMediumFormat::describeProperties"/>.
9697
9698	Note that setting the property value to @c null or an empty string is
9699	equivalent to deleting the existing value. A default value (if it is
9700	defined for this property) will be used by the format backend in this
9701	case.
9702	</desc>
9703	<param name="names" type="wstring" safearray="yes" dir="in">
9704	<desc>Names of properties to set.</desc>
9705	</param>
9706	<param name="values" type="wstring" safearray="yes" dir="in">
9707	<desc>Values of properties to set.</desc>
9708	</param>
9709	</method>
9710
9711	<!-- storage methods -->
9712
9713	<method name="createBaseStorage">
9714	<desc>
9715	Starts creating a hard disk storage unit (fixed/dynamic, according
9716	to the variant flags) in in the background. The previous storage unit
9717	created for this object, if any, must first be deleted using
9718	<link to="#deleteStorage"/>, otherwise the operation will fail.
9719
9720	Before the operation starts, the medium is placed in
9721	<link to="MediumState_Creating"/> state. If the create operation
9722	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9723	state.
9724
9725	After the returned progress object reports that the operation has
9726	successfully completed, the medium state will be set to <link
9727	to="MediumState_Created"/>, the medium will be remembered by this
9728	VirtualBox installation and may be attached to virtual machines.
9729
9730	<result name="VBOX_E_NOT_SUPPORTED">
9731	The variant of storage creation operation is not supported. See <link
9732	to="IMediumFormat::capabilities"/>.
9733	</result>
9734	</desc>
9735	<param name="logicalSize" type="long long" dir="in">
9736	<desc>Maximum logical size of the medium in bytes.</desc>
9737	</param>
9738	<param name="variant" type="MediumVariant" dir="in">
9739	<desc>Exact image variant which should be created.</desc>
9740	</param>
9741	<param name="progress" type="IProgress" dir="return">
9742	<desc>Progress object to track the operation completion.</desc>
9743	</param>
9744	</method>
9745
9746	<method name="deleteStorage">
9747	<desc>
9748	Starts deleting the storage unit of this medium.
9749
9750	The medium must not be attached to any known virtual machine and must
9751	not have any known child media, otherwise the operation will fail.
9752	It will also fail if there is no storage unit to delete or if deletion
9753	is already in progress, or if the medium is being in use (locked for
9754	read or for write) or inaccessible. Therefore, the only valid state for
9755	this operation to succeed is <link to="MediumState_Created"/>.
9756
9757	Before the operation starts, the medium is placed in
9758	<link to="MediumState_Deleting"/> state and gets removed from the list
9759	of remembered hard disks (media registry). If the delete operation
9760	fails, the medium will be remembered again and placed back to
9761	<link to="MediumState_Created"/> state.
9762
9763	After the returned progress object reports that the operation is
9764	complete, the medium state will be set to
9765	<link to="MediumState_NotCreated"/> and you will be able to use one of
9766	the storage creation methods to create it again.
9767
9768	<see>#close()</see>
9769
9770	<result name="VBOX_E_OBJECT_IN_USE">
9771	Medium is attached to a virtual machine.
9772	</result>
9773	<result name="VBOX_E_NOT_SUPPORTED">
9774	Storage deletion is not allowed because neither of storage creation
9775	operations are supported. See
9776	<link to="IMediumFormat::capabilities"/>.
9777	</result>
9778
9779	<note>
9780	If the deletion operation fails, it is not guaranteed that the storage
9781	unit still exists. You may check the <link to="IMedium::state"/> value
9782	to answer this question.
9783	</note>
9784	</desc>
9785	<param name="progress" type="IProgress" dir="return">
9786	<desc>Progress object to track the operation completion.</desc>
9787	</param>
9788	</method>
9789
9790	<!-- diff methods -->
9791
9792	<method name="createDiffStorage">
9793	<desc>
9794	Starts creating an empty differencing storage unit based on this
9795	medium in the format and at the location defined by the @a target
9796	argument.
9797
9798	The target medium must be in <link to="MediumState_NotCreated"/>
9799	state (i.e. must not have an existing storage unit). Upon successful
9800	completion, this operation will set the type of the target medium to
9801	<link to="MediumType_Normal"/> and create a storage unit necessary to
9802	represent the differencing medium data in the given format (according
9803	to the storage format of the target object).
9804
9805	After the returned progress object reports that the operation is
9806	successfully complete, the target medium gets remembered by this
9807	VirtualBox installation and may be attached to virtual machines.
9808
9809	<note>
9810	The medium will be set to <link to="MediumState_LockedRead"/>
9811	state for the duration of this operation.
9812	</note>
9813	<result name="VBOX_E_OBJECT_IN_USE">
9814	Medium not in @c NotCreated state.
9815	</result>
9816	</desc>
9817	<param name="target" type="IMedium" dir="in">
9818	<desc>Target medium.</desc>
9819	</param>
9820	<param name="variant" type="MediumVariant" dir="in">
9821	<desc>Exact image variant which should be created.</desc>
9822	</param>
9823	<param name="progress" type="IProgress" dir="return">
9824	<desc>Progress object to track the operation completion.</desc>
9825	</param>
9826	</method>
9827
9828	<method name="mergeTo">
9829	<desc>
9830	Starts merging the contents of this medium and all intermediate
9831	differencing media in the chain to the given target medium.
9832
9833	The target medium must be either a descendant of this medium or
9834	its ancestor (otherwise this method will immediately return a failure).
9835	It follows that there are two logical directions of the merge operation:
9836	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9837	ancestor (<i>backward merge</i>). Let us consider the following medium
9838	chain:
9839
9840	<pre>Base <- Diff_1 <- Diff_2</pre>
9841
9842	Here, calling this method on the <tt>Base</tt> medium object with
9843	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9844	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9845	merge. Note that in both cases the contents of the resulting medium
9846	will be the same, the only difference is the medium object that takes
9847	the result of the merge operation. In case of the forward merge in the
9848	above example, the result will be written to <tt>Diff_2</tt>; in case of
9849	the backward merge, the result will be written to <tt>Base</tt>. In
9850	other words, the result of the operation is always stored in the target
9851	medium.
9852
9853	Upon successful operation completion, the storage units of all media in
9854	the chain between this (source) medium and the target medium, including
9855	the source medium itself, will be automatically deleted and the
9856	relevant medium objects (including this medium) will become
9857	uninitialized. This means that any attempt to call any of
9858	their methods or attributes will fail with the
9859	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9860	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9861	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9862	Note that <tt>Diff_2</tt> in this case will become a base medium
9863	itself since it will no longer be based on any other medium.
9864
9865	Considering the above, all of the following conditions must be met in
9866	order for the merge operation to succeed:
9867	<ul>
9868	<li>
9869	Neither this (source) medium nor any intermediate
9870	differencing medium in the chain between it and the target
9871	medium is attached to any virtual machine.
9872	</li>
9873	<li>
9874	Neither the source medium nor the target medium is an
9875	<link to="MediumType_Immutable"/> medium.
9876	</li>
9877	<li>
9878	The part of the medium tree from the source medium to the
9879	target medium is a linear chain, i.e. all medium in this
9880	chain have exactly one child which is the next medium in this
9881	chain. The only exception from this rule is the target medium in
9882	the forward merge operation; it is allowed to have any number of
9883	child media because the merge operation will not change its
9884	logical contents (as it is seen by the guest OS or by children).
9885	</li>
9886	<li>
9887	None of the involved media are in
9888	<link to="MediumState_LockedRead"/> or
9889	<link to="MediumState_LockedWrite"/> state.
9890	</li>
9891	</ul>
9892
9893	<note>
9894	This (source) medium and all intermediates will be placed to <link
9895	to="MediumState_Deleting"/> state and the target medium will be
9896	placed to <link to="MediumState_LockedWrite"/> state and for the
9897	duration of this operation.
9898	</note>
9899	</desc>
9900	<param name="target" type="IMedium" dir="in">
9901	<desc>Target medium.</desc>
9902	</param>
9903	<param name="progress" type="IProgress" dir="return">
9904	<desc>Progress object to track the operation completion.</desc>
9905	</param>
9906	</method>
9907
9908	<!-- clone method -->
9909
9910	<method name="cloneTo">
9911	<desc>
9912	Starts creating a clone of this medium in the format and at the
9913	location defined by the @a target argument.
9914
9915	The target medium must be either in <link to="MediumState_NotCreated"/>
9916	state (i.e. must not have an existing storage unit) or in
9917	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9918	big enough to hold the data or else the copy will be partial). Upon
9919	successful completion, the cloned medium will contain exactly the
9920	same sector data as the medium being cloned, except that in the
9921	first case a new UUID for the clone will be randomly generated, and in
9922	the second case the UUID will remain unchanged.
9923
9924	The @a parent argument defines which medium will be the parent
9925	of the clone. Passing a @c null reference indicates that the clone will
9926	be a base image, i.e. completely independent. It is possible to specify
9927	an arbitrary medium for this parameter, including the parent of the
9928	medium which is being cloned. Even cloning to a child of the source
9929	medium is possible. Note that when cloning to an existing image, the
9930	@a parent irgument is ignored.
9931
9932	After the returned progress object reports that the operation is
9933	successfully complete, the target medium gets remembered by this
9934	VirtualBox installation and may be attached to virtual machines.
9935
9936	<note>
9937	This medium will be placed to <link to="MediumState_LockedRead"/>
9938	state for the duration of this operation.
9939	</note>
9940	<result name="E_NOTIMPL">
9941	The specified cloning variant is not supported at the moment.
9942	</result>
9943	</desc>
9944	<param name="target" type="IMedium" dir="in">
9945	<desc>Target medium.</desc>
9946	</param>
9947	<param name="variant" type="MediumVariant" dir="in">
9948	<desc>Exact image variant which should be created.</desc>
9949	</param>
9950	<param name="parent" type="IMedium" dir="in">
9951	<desc>Parent of the cloned medium.</desc>
9952	</param>
9953	<param name="progress" type="IProgress" dir="return">
9954	<desc>Progress object to track the operation completion.</desc>
9955	</param>
9956	</method>
9957
9958	<!-- other methods -->
9959
9960	<method name="compact">
9961	<desc>
9962	Starts compacting of this medium. This means that the medium is
9963	transformed into a possibly more compact storage representation.
9964	This potentially creates temporary images, which can require a
9965	substantial amount of additional disk space.
9966
9967	This medium will be placed to <link to="MediumState_LockedWrite"/>
9968	state and all its parent media (if any) will be placed to
9969	<link to="MediumState_LockedRead"/> state for the duration of this
9970	operation.
9971
9972	Please note that the results can be either returned straight away,
9973	or later as the result of the background operation via the object
9974	returned via the @a progress parameter.
9975
9976	<result name="VBOX_E_NOT_SUPPORTED">
9977	Medium format does not support compacting (but potentially
9978	needs it).
9979	</result>
9980	</desc>
9981	<param name="progress" type="IProgress" dir="return">
9982	<desc>Progress object to track the operation completion.</desc>
9983	</param>
9984	</method>
9985
9986	<method name="resize">
9987	<desc>
9988	Starts resizing this medium. This means that the nominal size of the
9989	medium is set to the new value. Both increasing and decreasing the
9990	size is possible, and there are no safety checks, since VirtualBox
9991	does not make any assumptions about the medium contents.
9992
9993	Resizing usually needs additional disk space, and possibly also
9994	some temporary disk space. Note that resize does not create a full
9995	temporary copy of the medium, so the additional disk space requirement
9996	is usually much lower than using the clone operation.
9997
9998	This medium will be placed to <link to="MediumState_LockedWrite"/>
9999	state for the duration of this operation.
10000
10001	Please note that the results can be either returned straight away,
10002	or later as the result of the background operation via the object
10003	returned via the @a progress parameter.
10004
10005	<result name="VBOX_E_NOT_SUPPORTED">
10006	Medium format does not support resizing.
10007	</result>
10008	</desc>
10009	<param name="logicalSize" type="long long" dir="in">
10010	<desc>New nominal capacity of the medium in bytes.</desc>
10011	</param>
10012	<param name="progress" type="IProgress" dir="return">
10013	<desc>Progress object to track the operation completion.</desc>
10014	</param>
10015	</method>
10016
10017	<method name="reset">
10018	<desc>
10019	Starts erasing the contents of this differencing medium.
10020
10021	This operation will reset the differencing medium to its initial
10022	state when it does not contain any sector data and any read operation is
10023	redirected to its parent medium. This automatically gets called
10024	during VM power-up for every medium whose <link to="#autoReset" />
10025	attribute is @c true.
10026
10027	The medium will be write-locked for the duration of this operation (see
10028	<link to="#lockWrite" />).
10029
10030	<result name="VBOX_E_NOT_SUPPORTED">
10031	This is not a differencing medium.
10032	</result>
10033	<result name="VBOX_E_INVALID_OBJECT_STATE">
10034	Medium is not in <link to="MediumState_Created"/> or
10035	<link to="MediumState_Inaccessible"/> state.
10036	</result>
10037	</desc>
10038	<param name="progress" type="IProgress" dir="return">
10039	<desc>Progress object to track the operation completion.</desc>
10040	</param>
10041	</method>
10042
10043	</interface>
10044
10045
10046	<!--
10047	// IMediumFormat
10048	/////////////////////////////////////////////////////////////////////////
10049	-->
10050
10051	<enum
10052	name="DataType"
10053	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10054	>
10055	<const name="Int32" value="0"/>
10056	<const name="Int8" value="1"/>
10057	<const name="String" value="2"/>
10058	</enum>
10059
10060	<enum
10061	name="DataFlags"
10062	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10063	>
10064	<const name="None" value="0x00"/>
10065	<const name="Mandatory" value="0x01"/>
10066	<const name="Expert" value="0x02"/>
10067	<const name="Array" value="0x04"/>
10068	<const name="FlagMask" value="0x07"/>
10069	</enum>
10070
10071	<enum
10072	name="MediumFormatCapabilities"
10073	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10074	>
10075	<desc>
10076	Medium format capability flags.
10077	</desc>
10078
10079	<const name="Uuid" value="0x01">
10080	<desc>
10081	Supports UUIDs as expected by VirtualBox code.
10082	</desc>
10083	</const>
10084
10085	<const name="CreateFixed" value="0x02">
10086	<desc>
10087	Supports creating fixed size images, allocating all space instantly.
10088	</desc>
10089	</const>
10090
10091	<const name="CreateDynamic" value="0x04">
10092	<desc>
10093	Supports creating dynamically growing images, allocating space on
10094	demand.
10095	</desc>
10096	</const>
10097
10098	<const name="CreateSplit2G" value="0x08">
10099	<desc>
10100	Supports creating images split in chunks of a bit less than 2 GBytes.
10101	</desc>
10102	</const>
10103
10104	<const name="Differencing" value="0x10">
10105	<desc>
10106	Supports being used as a format for differencing media (see <link
10107	to="IMedium::createDiffStorage"/>).
10108	</desc>
10109	</const>
10110
10111	<const name="Asynchronous" value="0x20">
10112	<desc>
10113	Supports asynchronous I/O operations for at least some configurations.
10114	</desc>
10115	</const>
10116
10117	<const name="File" value="0x40">
10118	<desc>
10119	The format backend operates on files (the <link to="IMedium::location"/>
10120	attribute of the medium specifies a file used to store medium
10121	data; for a list of supported file extensions see
10122	<link to="IMediumFormat::describeFileExtensions"/>).
10123	</desc>
10124	</const>
10125
10126	<const name="Properties" value="0x80">
10127	<desc>
10128	The format backend uses the property interface to configure the storage
10129	location and properties (the <link to="IMediumFormat::describeProperties"/>
10130	method is used to get access to properties supported by the given medium format).
10131	</desc>
10132	</const>
10133
10134	<const name="TcpNetworking" value="0x100">
10135	<desc>
10136	The format backend uses the TCP networking interface for network access.
10137	</desc>
10138	</const>
10139
10140	<const name="VFS" value="0x200">
10141	<desc>
10142	The format backend supports virtual filesystem functionality.
10143	</desc>
10144	</const>
10145
10146	<const name="CapabilityMask" value="0x3FF"/>
10147	</enum>
10148
10149	<interface
10150	name="IMediumFormat" extends="$unknown"
10151	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10152	wsmap="managed"
10153	>
10154	<desc>
10155	The IMediumFormat interface represents a medium format.
10156
10157	Each medium format has an associated backend which is used to handle
10158	media stored in this format. This interface provides information
10159	about the properties of the associated backend.
10160
10161	Each medium format is identified by a string represented by the
10162	<link to="#id"/> attribute. This string is used in calls like
10163	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10164	format.
10165
10166	The list of all supported medium formats can be obtained using
10167	<link to="ISystemProperties::mediumFormats"/>.
10168
10169	<see>IMedium</see>
10170	</desc>
10171
10172	<attribute name="id" type="wstring" readonly="yes">
10173	<desc>
10174	Identifier of this format.
10175
10176	The format identifier is a non-@c null non-empty ASCII string. Note that
10177	this string is case-insensitive. This means that, for example, all of
10178	the following strings:
10179	<pre>
10180	"VDI"
10181	"vdi"
10182	"VdI"</pre>
10183	refer to the same medium format.
10184
10185	This string is used in methods of other interfaces where it is necessary
10186	to specify a medium format, such as
10187	<link to="IVirtualBox::createHardDisk"/>.
10188	</desc>
10189	</attribute>
10190
10191	<attribute name="name" type="wstring" readonly="yes">
10192	<desc>
10193	Human readable description of this format.
10194
10195	Mainly for use in file open dialogs.
10196	</desc>
10197	</attribute>
10198
10199	<attribute name="capabilities" type="unsigned long" readonly="yes">
10200	<desc>
10201	Capabilities of the format as a set of bit flags.
10202
10203	For the meaning of individual capability flags see
10204	<link to="MediumFormatCapabilities"/>.
10205	</desc>
10206	</attribute>
10207
10208	<method name="describeFileExtensions">
10209	<desc>
10210	Returns two arrays describing the supported file extensions.
10211
10212	The first array contains the supported extensions and the seconds one
10213	the type each extension supports. Both have the same size.
10214
10215	Note that some backends do not work on files, so this array may be
10216	empty.
10217
10218	<see>IMediumFormat::capabilities</see>
10219	</desc>
10220	<param name="extensions" type="wstring" safearray="yes" dir="out">
10221	<desc>The array of supported extensions.</desc>
10222	</param>
10223	<param name="type" type="DeviceType" safearray="yes" dir="out">
10224	<desc>The array which indicates the device type for every given extension.</desc>
10225	</param>
10226	</method>
10227
10228	<method name="describeProperties">
10229	<desc>
10230	Returns several arrays describing the properties supported by this
10231	format.
10232
10233	An element with the given index in each array describes one
10234	property. Thus, the number of elements in each returned array is the
10235	same and corresponds to the number of supported properties.
10236
10237	The returned arrays are filled in only if the
10238	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10239	All arguments must be non-@c null.
10240
10241	<see>DataType</see>
10242	<see>DataFlags</see>
10243	</desc>
10244
10245	<param name="names" type="wstring" safearray="yes" dir="out">
10246	<desc>Array of property names.</desc>
10247	</param>
10248	<param name="description" type="wstring" safearray="yes" dir="out">
10249	<desc>Array of property descriptions.</desc>
10250	</param>
10251	<param name="types" type="DataType" safearray="yes" dir="out">
10252	<desc>Array of property types.</desc>
10253	</param>
10254	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10255	<desc>Array of property flags.</desc>
10256	</param>
10257	<param name="defaults" type="wstring" safearray="yes" dir="out">
10258	<desc>Array of default property values.</desc>
10259	</param>
10260	</method>
10261
10262	</interface>
10263
10264
10265	<!--
10266	// IKeyboard
10267	/////////////////////////////////////////////////////////////////////////
10268	-->
10269
10270	<interface
10271	name="IKeyboard" extends="$unknown"
10272	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10273	wsmap="managed"
10274	>
10275	<desc>
10276	The IKeyboard interface represents the virtual machine's keyboard. Used
10277	in <link to="IConsole::keyboard"/>.
10278
10279	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10280	to the virtual machine.
10281
10282	</desc>
10283	<method name="putScancode">
10284	<desc>Sends a scancode to the keyboard.
10285
10286	<result name="VBOX_E_IPRT_ERROR">
10287	Could not send scan code to virtual keyboard.
10288	</result>
10289
10290	</desc>
10291	<param name="scancode" type="long" dir="in"/>
10292	</method>
10293
10294	<method name="putScancodes">
10295	<desc>Sends an array of scancodes to the keyboard.
10296
10297	<result name="VBOX_E_IPRT_ERROR">
10298	Could not send all scan codes to virtual keyboard.
10299	</result>
10300
10301	</desc>
10302	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10303	<param name="codesStored" type="unsigned long" dir="return"/>
10304	</method>
10305
10306	<method name="putCAD">
10307	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10308	function is nothing special, it is just a convenience function
10309	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10310
10311	<result name="VBOX_E_IPRT_ERROR">
10312	Could not send all scan codes to virtual keyboard.
10313	</result>
10314
10315	</desc>
10316	</method>
10317
10318	<attribute name="eventSource" type="IEventSource" readonly="yes">
10319	<desc>
10320	Event source for keyboard events.
10321	</desc>
10322	</attribute>
10323
10324	</interface>
10325
10326
10327	<!--
10328	// IMouse
10329	/////////////////////////////////////////////////////////////////////////
10330	-->
10331
10332	<enum
10333	name="MouseButtonState"
10334	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10335	>
10336	<desc>
10337	Mouse button state.
10338	</desc>
10339
10340	<const name="LeftButton" value="0x01"/>
10341	<const name="RightButton" value="0x02"/>
10342	<const name="MiddleButton" value="0x04"/>
10343	<const name="WheelUp" value="0x08"/>
10344	<const name="WheelDown" value="0x10"/>
10345	<const name="XButton1" value="0x20"/>
10346	<const name="XButton2" value="0x40"/>
10347	<const name="MouseStateMask" value="0x7F"/>
10348	</enum>
10349
10350	<interface
10351	name="IMouse" extends="$unknown"
10352	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10353	wsmap="managed"
10354	>
10355	<desc>
10356	The IMouse interface represents the virtual machine's mouse. Used in
10357	<link to="IConsole::mouse"/>.
10358
10359	Through this interface, the virtual machine's virtual mouse can be
10360	controlled.
10361	</desc>
10362
10363	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10364	<desc>
10365	Whether the guest OS supports absolute mouse pointer positioning
10366	or not.
10367	<note>
10368	You can use the <link to="IMouseCapabilityChangedEvent"/>
10369	event to be instantly informed about changes of this attribute
10370	during virtual machine execution.
10371	</note>
10372	<see><link to="#putMouseEventAbsolute"/></see>
10373	</desc>
10374	</attribute>
10375
10376	<attribute name="relativeSupported" type="boolean" readonly="yes">
10377	<desc>
10378	Whether the guest OS supports relative mouse pointer positioning
10379	or not.
10380	<note>
10381	You can use the <link to="IMouseCapabilityChangedEvent"/>
10382	event to be instantly informed about changes of this attribute
10383	during virtual machine execution.
10384	</note>
10385	<see><link to="#putMouseEvent"/></see>
10386	</desc>
10387	</attribute>
10388
10389	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10390	<desc>
10391	Whether the guest OS can currently switch to drawing it's own mouse
10392	cursor on demand.
10393	<note>
10394	You can use the <link to="IMouseCapabilityChangedEvent"/>
10395	event to be instantly informed about changes of this attribute
10396	during virtual machine execution.
10397	</note>
10398	<see><link to="#putMouseEvent"/></see>
10399	</desc>
10400	</attribute>
10401
10402	<method name="putMouseEvent">
10403	<desc>
10404	Initiates a mouse event using relative pointer movements
10405	along x and y axis.
10406
10407	<result name="E_ACCESSDENIED">
10408	Console not powered up.
10409	</result>
10410	<result name="VBOX_E_IPRT_ERROR">
10411	Could not send mouse event to virtual mouse.
10412	</result>
10413
10414	</desc>
10415
10416	<param name="dx" type="long" dir="in">
10417	<desc>
10418	Amount of pixels the mouse should move to the right.
10419	Negative values move the mouse to the left.
10420	</desc>
10421	</param>
10422	<param name="dy" type="long" dir="in">
10423	<desc>
10424	Amount of pixels the mouse should move downwards.
10425	Negative values move the mouse upwards.
10426	</desc>
10427	</param>
10428	<param name="dz" type="long" dir="in">
10429	<desc>
10430	Amount of mouse wheel moves.
10431	Positive values describe clockwise wheel rotations,
10432	negative values describe counterclockwise rotations.
10433	</desc>
10434	</param>
10435	<param name="dw" type="long" dir="in">
10436	<desc>
10437	Amount of horizontal mouse wheel moves.
10438	Positive values describe a movement to the left,
10439	negative values describe a movement to the right.
10440	</desc>
10441	</param>
10442	<param name="buttonState" type="long" dir="in">
10443	<desc>
10444	The current state of mouse buttons. Every bit represents
10445	a mouse button as follows:
10446	<table>
10447	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10448	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10449	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10450	</table>
10451	A value of <tt>1</tt> means the corresponding button is pressed.
10452	otherwise it is released.
10453	</desc>
10454	</param>
10455	</method>
10456
10457	<method name="putMouseEventAbsolute">
10458	<desc>
10459	Positions the mouse pointer using absolute x and y coordinates.
10460	These coordinates are expressed in pixels and
10461	start from <tt>[1,1]</tt> which corresponds to the top left
10462	corner of the virtual display.
10463
10464	<result name="E_ACCESSDENIED">
10465	Console not powered up.
10466	</result>
10467	<result name="VBOX_E_IPRT_ERROR">
10468	Could not send mouse event to virtual mouse.
10469	</result>
10470
10471	<note>
10472	This method will have effect only if absolute mouse
10473	positioning is supported by the guest OS.
10474	</note>
10475
10476	<see><link to="#absoluteSupported"/></see>
10477	</desc>
10478
10479	<param name="x" type="long" dir="in">
10480	<desc>
10481	X coordinate of the pointer in pixels, starting from @c 1.
10482	</desc>
10483	</param>
10484	<param name="y" type="long" dir="in">
10485	<desc>
10486	Y coordinate of the pointer in pixels, starting from @c 1.
10487	</desc>
10488	</param>
10489	<param name="dz" type="long" dir="in">
10490	<desc>
10491	Amount of mouse wheel moves.
10492	Positive values describe clockwise wheel rotations,
10493	negative values describe counterclockwise rotations.
10494	</desc>
10495	</param>
10496	<param name="dw" type="long" dir="in">
10497	<desc>
10498	Amount of horizontal mouse wheel moves.
10499	Positive values describe a movement to the left,
10500	negative values describe a movement to the right.
10501	</desc>
10502	</param>
10503	<param name="buttonState" type="long" dir="in">
10504	<desc>
10505	The current state of mouse buttons. Every bit represents
10506	a mouse button as follows:
10507	<table>
10508	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10509	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10510	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10511	</table>
10512	A value of @c 1 means the corresponding button is pressed.
10513	otherwise it is released.
10514	</desc>
10515	</param>
10516	</method>
10517
10518	<attribute name="eventSource" type="IEventSource" readonly="yes">
10519	<desc>
10520	Event source for mouse events.
10521	</desc>
10522	</attribute>
10523
10524	</interface>
10525
10526	<!--
10527	// IDisplay
10528	/////////////////////////////////////////////////////////////////////////
10529	-->
10530
10531	<enum
10532	name="FramebufferPixelFormat"
10533	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10534	>
10535	<desc>
10536	Format of the video memory buffer. Constants represented by this enum can
10537	be used to test for particular values of <link
10538	to="IFramebuffer::pixelFormat"/>. See also <link
10539	to="IFramebuffer::requestResize"/>.
10540
10541	See also www.fourcc.org for more information about FOURCC pixel formats.
10542	</desc>
10543
10544	<const name="Opaque" value="0">
10545	<desc>
10546	Unknown buffer format (the user may not assume any particular format of
10547	the buffer).
10548	</desc>
10549	</const>
10550	<const name="FOURCC_RGB" value="0x32424752">
10551	<desc>
10552	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10553	bit layout).
10554	</desc>
10555	</const>
10556	</enum>
10557
10558	<interface
10559	name="IFramebuffer" extends="$unknown"
10560	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10561	wsmap="suppress"
10562	>
10563	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10564	<desc>Address of the start byte of the frame buffer.</desc>
10565	</attribute>
10566
10567	<attribute name="width" type="unsigned long" readonly="yes">
10568	<desc>Frame buffer width, in pixels.</desc>
10569	</attribute>
10570
10571	<attribute name="height" type="unsigned long" readonly="yes">
10572	<desc>Frame buffer height, in pixels.</desc>
10573	</attribute>
10574
10575	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10576	<desc>
10577	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10578	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10579	are: 8, 15, 16, 24 and 32.
10580	</desc>
10581	</attribute>
10582
10583	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10584	<desc>
10585	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10586	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10587	size of the scan line must be aligned to 32 bits.
10588	</desc>
10589	</attribute>
10590
10591	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10592	<desc>
10593	Frame buffer pixel format. It's either one of the values defined by <link
10594	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10595	<note>
10596	This attribute must never return <link
10597	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10598	<link to="#address"/> points to must be always known.
10599	</note>
10600	</desc>
10601	</attribute>
10602
10603	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10604	<desc>
10605	Defines whether this frame buffer uses the virtual video card's memory
10606	buffer (guest VRAM) directly or not. See <link
10607	to="IFramebuffer::requestResize"/> for more information.
10608	</desc>
10609	</attribute>
10610
10611	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10612	<desc>
10613	Hint from the frame buffer about how much of the standard
10614	screen height it wants to use for itself. This information is
10615	exposed to the guest through the VESA BIOS and VMMDev interface
10616	so that it can use it for determining its video mode table. It
10617	is not guaranteed that the guest respects the value.
10618	</desc>
10619	</attribute>
10620
10621	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10622	<desc>
10623	An alpha-blended overlay which is superposed over the frame buffer.
10624	The initial purpose is to allow the display of icons providing
10625	information about the VM state, including disk activity, in front
10626	ends which do not have other means of doing that. The overlay is
10627	designed to controlled exclusively by IDisplay. It has no locking
10628	of its own, and any changes made to it are not guaranteed to be
10629	visible until the affected portion of IFramebuffer is updated. The
10630	overlay can be created lazily the first time it is requested. This
10631	attribute can also return @c null to signal that the overlay is not
10632	implemented.
10633	</desc>
10634	</attribute>
10635
10636	<attribute name="winId" type="long long" readonly="yes">
10637	<desc>
10638	Platform-dependent identifier of the window where context of this
10639	frame buffer is drawn, or zero if there's no such window.
10640	</desc>
10641	</attribute>
10642
10643	<method name="lock">
10644	<desc>
10645	Locks the frame buffer.
10646	Gets called by the IDisplay object where this frame buffer is
10647	bound to.
10648	</desc>
10649	</method>
10650
10651	<method name="unlock">
10652	<desc>
10653	Unlocks the frame buffer.
10654	Gets called by the IDisplay object where this frame buffer is
10655	bound to.
10656	</desc>
10657	</method>
10658
10659	<method name="notifyUpdate">
10660	<desc>
10661	Informs about an update.
10662	Gets called by the display object where this buffer is
10663	registered.
10664	</desc>
10665	<param name="x" type="unsigned long" dir="in"/>
10666	<param name="y" type="unsigned long" dir="in"/>
10667	<param name="width" type="unsigned long" dir="in"/>
10668	<param name="height" type="unsigned long" dir="in"/>
10669	</method>
10670
10671	<method name="requestResize">
10672	<desc>
10673	Requests a size and pixel format change.
10674
10675	There are two modes of working with the video buffer of the virtual
10676	machine. The <i>indirect</i> mode implies that the IFramebuffer
10677	implementation allocates a memory buffer for the requested display mode
10678	and provides it to the virtual machine. In <i>direct</i> mode, the
10679	IFramebuffer implementation uses the memory buffer allocated and owned
10680	by the virtual machine. This buffer represents the video memory of the
10681	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10682	usually faster because the implementation gets a raw pointer to the
10683	guest VRAM buffer which it can directly use for visualizing the contents
10684	of the virtual display, as opposed to the indirect mode where the
10685	contents of guest VRAM are copied to the memory buffer provided by
10686	the implementation every time a display update occurs.
10687
10688	It is important to note that the direct mode is really fast only when
10689	the implementation uses the given guest VRAM buffer directly, for
10690	example, by blitting it to the window representing the virtual machine's
10691	display, which saves at least one copy operation comparing to the
10692	indirect mode. However, using the guest VRAM buffer directly is not
10693	always possible: the format and the color depth of this buffer may be
10694	not supported by the target window, or it may be unknown (opaque) as in
10695	case of text or non-linear multi-plane VGA video modes. In this case,
10696	the indirect mode (that is always available) should be used as a
10697	fallback: when the guest VRAM contents are copied to the
10698	implementation-provided memory buffer, color and format conversion is
10699	done automatically by the underlying code.
10700
10701	The @a pixelFormat parameter defines whether the direct mode is
10702	available or not. If @a pixelFormat is <link
10703	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10704	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10705	@a bytesPerLine parameters must be ignored and the implementation must use
10706	the indirect mode (where it provides its own buffer in one of the
10707	supported formats). In all other cases, @a pixelFormat together with
10708	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10709	buffer pointed to by the @a VRAM parameter and the implementation is
10710	free to choose which mode to use. To indicate that this frame buffer uses
10711	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10712	attribute must return @c true and <link to="#address"/> must
10713	return exactly the same address that is passed in the @a VRAM parameter
10714	of this method; otherwise it is assumed that the indirect strategy is
10715	chosen.
10716
10717	The @a width and @a height parameters represent the size of the
10718	requested display mode in both modes. In case of indirect mode, the
10719	provided memory buffer should be big enough to store data of the given
10720	display mode. In case of direct mode, it is guaranteed that the given
10721	@a VRAM buffer contains enough space to represent the display mode of the
10722	given size. Note that this frame buffer's <link to="#width"/> and <link
10723	to="#height"/> attributes must return exactly the same values as
10724	passed to this method after the resize is completed (see below).
10725
10726	The @a finished output parameter determines if the implementation has
10727	finished resizing the frame buffer or not. If, for some reason, the
10728	resize cannot be finished immediately during this call, @a finished
10729	must be set to @c false, and the implementation must call
10730	<link to="IDisplay::resizeCompleted"/> after it has returned from
10731	this method as soon as possible. If @a finished is @c false, the
10732	machine will not call any frame buffer methods until
10733	<link to="IDisplay::resizeCompleted"/> is called.
10734
10735	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10736	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10737	this frame buffer must return exactly the same values as specified in the
10738	parameters of this method, after the resize is completed. If the
10739	indirect mode is chosen, these attributes must return values describing
10740	the format of the implementation's own memory buffer <link
10741	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10742	value must always correlate with <link to="#pixelFormat"/>. Note that
10743	the <link to="#pixelFormat"/> attribute must never return <link
10744	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10745
10746	<note>
10747	This method is called by the IDisplay object under the
10748	<link to="#lock"/> provided by this IFramebuffer
10749	implementation. If this method returns @c false in @a finished, then
10750	this lock is not released until
10751	<link to="IDisplay::resizeCompleted"/> is called.
10752	</note>
10753	</desc>
10754	<param name="screenId" type="unsigned long" dir="in">
10755	<desc>
10756	Logical screen number. Must be used in the corresponding call to
10757	<link to="IDisplay::resizeCompleted"/> if this call is made.
10758	</desc>
10759	</param>
10760	<param name="pixelFormat" type="unsigned long" dir="in">
10761	<desc>
10762	Pixel format of the memory buffer pointed to by @a VRAM.
10763	See also <link to="FramebufferPixelFormat"/>.
10764	</desc>
10765	</param>
10766	<param name="VRAM" type="octet" mod="ptr" dir="in">
10767	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10768	</param>
10769	<param name="bitsPerPixel" type="unsigned long" dir="in">
10770	<desc>Color depth, bits per pixel.</desc>
10771	</param>
10772	<param name="bytesPerLine" type="unsigned long" dir="in">
10773	<desc>Size of one scan line, in bytes.</desc>
10774	</param>
10775	<param name="width" type="unsigned long" dir="in">
10776	<desc>Width of the guest display, in pixels.</desc>
10777	</param>
10778	<param name="height" type="unsigned long" dir="in">
10779	<desc>Height of the guest display, in pixels.</desc>
10780	</param>
10781	<param name="finished" type="boolean" dir="return">
10782	<desc>
10783	Can the VM start using the new frame buffer immediately
10784	after this method returns or it should wait for
10785	<link to="IDisplay::resizeCompleted"/>.
10786	</desc>
10787	</param>
10788	</method>
10789
10790	<method name="videoModeSupported">
10791	<desc>
10792	Returns whether the frame buffer implementation is willing to
10793	support a given video mode. In case it is not able to render
10794	the video mode (or for some reason not willing), it should
10795	return @c false. Usually this method is called when the guest
10796	asks the VMM device whether a given video mode is supported
10797	so the information returned is directly exposed to the guest.
10798	It is important that this method returns very quickly.
10799	</desc>
10800	<param name="width" type="unsigned long" dir="in"/>
10801	<param name="height" type="unsigned long" dir="in"/>
10802	<param name="bpp" type="unsigned long" dir="in"/>
10803	<param name="supported" type="boolean" dir="return"/>
10804	</method>
10805
10806	<method name="getVisibleRegion">
10807	<desc>
10808	Returns the visible region of this frame buffer.
10809
10810	If the @a rectangles parameter is @c null then the value of the
10811	@a count parameter is ignored and the number of elements necessary to
10812	describe the current visible region is returned in @a countCopied.
10813
10814	If @a rectangles is not @c null but @a count is less
10815	than the required number of elements to store region data, the method
10816	will report a failure. If @a count is equal or greater than the
10817	required number of elements, then the actual number of elements copied
10818	to the provided array will be returned in @a countCopied.
10819
10820	<note>
10821	The address of the provided array must be in the process space of
10822	this IFramebuffer object.
10823	</note>
10824	<note>
10825	Method not yet implemented.
10826	</note>
10827	</desc>
10828	<param name="rectangles" type="octet" mod="ptr" dir="in">
10829	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10830	</param>
10831	<param name="count" type="unsigned long" dir="in">
10832	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10833	</param>
10834	<param name="countCopied" type="unsigned long" dir="return">
10835	<desc>Number of elements copied to the @a rectangles array.</desc>
10836	</param>
10837	</method>
10838
10839	<method name="setVisibleRegion">
10840	<desc>
10841	Suggests a new visible region to this frame buffer. This region
10842	represents the area of the VM display which is a union of regions of
10843	all top-level windows of the guest operating system running inside the
10844	VM (if the Guest Additions for this system support this
10845	functionality). This information may be used by the frontends to
10846	implement the seamless desktop integration feature.
10847
10848	<note>
10849	The address of the provided array must be in the process space of
10850	this IFramebuffer object.
10851	</note>
10852	<note>
10853	The IFramebuffer implementation must make a copy of the provided
10854	array of rectangles.
10855	</note>
10856	<note>
10857	Method not yet implemented.
10858	</note>
10859	</desc>
10860	<param name="rectangles" type="octet" mod="ptr" dir="in">
10861	<desc>Pointer to the @c RTRECT array.</desc>
10862	</param>
10863	<param name="count" type="unsigned long" dir="in">
10864	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10865	</param>
10866	</method>
10867
10868	<method name="processVHWACommand">
10869	<desc>
10870	Posts a Video HW Acceleration Command to the frame buffer for processing.
10871	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
10872	are posted from quest to the host to be processed by the host hardware.
10873
10874	<note>
10875	The address of the provided command must be in the process space of
10876	this IFramebuffer object.
10877	</note>
10878	</desc>
10879
10880	<param name="command" type="octet" mod="ptr" dir="in">
10881	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10882	</param>
10883	</method>
10884
10885	</interface>
10886
10887	<interface
10888	name="IFramebufferOverlay" extends="IFramebuffer"
10889	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10890	wsmap="suppress"
10891	>
10892	<desc>
10893	The IFramebufferOverlay interface represents an alpha blended overlay
10894	for displaying status icons above an IFramebuffer. It is always created
10895	not visible, so that it must be explicitly shown. It only covers a
10896	portion of the IFramebuffer, determined by its width, height and
10897	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10898	that order) format, and may be written to directly. Do re-read the
10899	width though, after setting it, as it may be adjusted (increased) to
10900	make it more suitable for the front end.
10901	</desc>
10902	<attribute name="x" type="unsigned long" readonly="yes">
10903	<desc>X position of the overlay, relative to the frame buffer.</desc>
10904	</attribute>
10905
10906	<attribute name="y" type="unsigned long" readonly="yes">
10907	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10908	</attribute>
10909
10910	<attribute name="visible" type="boolean" readonly="no">
10911	<desc>
10912	Whether the overlay is currently visible.
10913	</desc>
10914	</attribute>
10915
10916	<attribute name="alpha" type="unsigned long" readonly="no">
10917	<desc>
10918	The global alpha value for the overlay. This may or may not be
10919	supported by a given front end.
10920	</desc>
10921	</attribute>
10922
10923	<method name="move">
10924	<desc>
10925	Changes the overlay's position relative to the IFramebuffer.
10926	</desc>
10927	<param name="x" type="unsigned long" dir="in"/>
10928	<param name="y" type="unsigned long" dir="in"/>
10929	</method>
10930
10931	</interface>
10932
10933	<interface
10934	name="IDisplay" extends="$unknown"
10935	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
10936	wsmap="managed"
10937	>
10938	<desc>
10939	The IDisplay interface represents the virtual machine's display.
10940
10941	The object implementing this interface is contained in each
10942	<link to="IConsole::display"/> attribute and represents the visual
10943	output of the virtual machine.
10944
10945	The virtual display supports pluggable output targets represented by the
10946	IFramebuffer interface. Examples of the output target are a window on
10947	the host computer or an RDP session's display on a remote computer.
10948	</desc>
10949	<method name="getScreenResolution">
10950	<desc>Queries display width, height and color depth for given screen.</desc>
10951	<param name="screenId" type="unsigned long" dir="in"/>
10952	<param name="width" type="unsigned long" dir="out"/>
10953	<param name="height" type="unsigned long" dir="out"/>
10954	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10955	</method>
10956
10957	<method name="setFramebuffer">
10958	<desc>
10959	Sets the framebuffer for given screen.
10960	</desc>
10961	<param name="screenId" type="unsigned long" dir="in"/>
10962	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10963	</method>
10964
10965	<method name="getFramebuffer">
10966	<desc>
10967	Queries the framebuffer for given screen.
10968	</desc>
10969	<param name="screenId" type="unsigned long" dir="in"/>
10970	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10971	<param name="xOrigin" type="long" dir="out"/>
10972	<param name="yOrigin" type="long" dir="out"/>
10973	</method>
10974
10975	<method name="setVideoModeHint">
10976	<desc>
10977	Asks VirtualBox to request the given video mode from
10978	the guest. This is just a hint and it cannot be guaranteed
10979	that the requested resolution will be used. Guest Additions
10980	are required for the request to be seen by guests. The caller
10981	should issue the request and wait for a resolution change and
10982	after a timeout retry.
10983
10984	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10985	parameters means that the corresponding values should be taken from the
10986	current video mode (i.e. left unchanged).
10987
10988	If the guest OS supports multi-monitor configuration then the @a display
10989	parameter specifies the number of the guest display to send the hint to:
10990	@c 0 is the primary display, @c 1 is the first secondary and
10991	so on. If the multi-monitor configuration is not supported, @a display
10992	must be @c 0.
10993
10994	<result name="E_INVALIDARG">
10995	The @a display is not associated with any monitor.
10996	</result>
10997
10998	</desc>
10999	<param name="width" type="unsigned long" dir="in"/>
11000	<param name="height" type="unsigned long" dir="in"/>
11001	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11002	<param name="display" type="unsigned long" dir="in"/>
11003	</method>
11004
11005	<method name="setSeamlessMode">
11006	<desc>
11007	Enables or disables seamless guest display rendering (seamless desktop
11008	integration) mode.
11009	<note>
11010	Calling this method has no effect if <link
11011	to="IGuest::supportsSeamless"/> returns @c false.
11012	</note>
11013	</desc>
11014	<param name="enabled" type="boolean" dir="in"/>
11015	</method>
11016
11017	<method name="takeScreenShot">
11018	<desc>
11019	Takes a screen shot of the requested size and copies it to the
11020	32-bpp buffer allocated by the caller and pointed to by @a address.
11021	A pixel consists of 4 bytes in order: B, G, R, 0.
11022
11023	<note>This API can be used only by the COM/XPCOM C++ API as it
11024	requires pointer support. Use <link to="#takeScreenShotToArray" />
11025	with other language bindings.
11026	</note>
11027
11028	<result name="E_NOTIMPL">
11029	Feature not implemented.
11030	</result>
11031	<result name="VBOX_E_IPRT_ERROR">
11032	Could not take a screenshot.
11033	</result>
11034
11035	</desc>
11036	<param name="screenId" type="unsigned long" dir="in"/>
11037	<param name="address" type="octet" mod="ptr" dir="in"/>
11038	<param name="width" type="unsigned long" dir="in"/>
11039	<param name="height" type="unsigned long" dir="in"/>
11040	</method>
11041
11042	<method name="takeScreenShotToArray">
11043	<desc>
11044	Takes a guest screen shot of the requested size and returns it as
11045	an array of bytes in uncompressed 32-bit RGBA format.
11046	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11047
11048	This API is slow, but could be the only option to get guest screenshot
11049	for scriptable languages not allowed to manipulate with addresses
11050	directly.
11051
11052	<result name="E_NOTIMPL">
11053	Feature not implemented.
11054	</result>
11055	<result name="VBOX_E_IPRT_ERROR">
11056	Could not take a screenshot.
11057	</result>
11058	</desc>
11059	<param name="screenId" type="unsigned long" dir="in">
11060	<desc>
11061	Monitor to take screenshot from.
11062	</desc>
11063	</param>
11064	<param name="width" type="unsigned long" dir="in">
11065	<desc>
11066	Desired image width.
11067	</desc>
11068	</param>
11069	<param name="height" type="unsigned long" dir="in">
11070	<desc>
11071	Desired image height.
11072	</desc>
11073	</param>
11074	<param name="screenData" type="octet" dir="return" safearray="yes">
11075	<desc>
11076	Array with resulting screen data.
11077	</desc>
11078	</param>
11079	</method>
11080
11081	<method name="takeScreenShotPNGToArray">
11082	<desc>
11083	Takes a guest screen shot of the requested size and returns it as
11084	PNG image in array.
11085
11086	<result name="E_NOTIMPL">
11087	Feature not implemented.
11088	</result>
11089	<result name="VBOX_E_IPRT_ERROR">
11090	Could not take a screenshot.
11091	</result>
11092	</desc>
11093	<param name="screenId" type="unsigned long" dir="in">
11094	<desc>
11095	Monitor to take the screenshot from.
11096	</desc>
11097	</param>
11098	<param name="width" type="unsigned long" dir="in">
11099	<desc>
11100	Desired image width.
11101	</desc>
11102	</param>
11103	<param name="height" type="unsigned long" dir="in">
11104	<desc>
11105	Desired image height.
11106	</desc>
11107	</param>
11108	<param name="screenData" type="octet" dir="return" safearray="yes">
11109	<desc>
11110	Array with resulting screen data.
11111	</desc>
11112	</param>
11113	</method>
11114
11115	<method name="drawToScreen">
11116	<desc>
11117	Draws a 32-bpp image of the specified size from the given buffer
11118	to the given point on the VM display.
11119
11120	<result name="E_NOTIMPL">
11121	Feature not implemented.
11122	</result>
11123	<result name="VBOX_E_IPRT_ERROR">
11124	Could not draw to screen.
11125	</result>
11126
11127	</desc>
11128	<param name="screenId" type="unsigned long" dir="in">
11129	<desc>
11130	Monitor to take the screenshot from.
11131	</desc>
11132	</param>
11133	<param name="address" type="octet" mod="ptr" dir="in">
11134	<desc>
11135	Address to store the screenshot to
11136	</desc>
11137	</param>
11138	<param name="x" type="unsigned long" dir="in">
11139	<desc>
11140	Relative to the screen top left corner.
11141	</desc>
11142	</param>
11143	<param name="y" type="unsigned long" dir="in">
11144	<desc>
11145	Relative to the screen top left corner.
11146	</desc>
11147	</param>
11148	<param name="width" type="unsigned long" dir="in">
11149	<desc>
11150	Desired image width.
11151	</desc>
11152	</param>
11153	<param name="height" type="unsigned long" dir="in">
11154	<desc>
11155	Desired image height.
11156	</desc>
11157	</param>
11158	</method>
11159
11160	<method name="invalidateAndUpdate">
11161	<desc>
11162	Does a full invalidation of the VM display and instructs the VM
11163	to update it.
11164
11165	<result name="VBOX_E_IPRT_ERROR">
11166	Could not invalidate and update screen.
11167	</result>
11168
11169	</desc>
11170	</method>
11171
11172	<method name="resizeCompleted">
11173	<desc>
11174	Signals that a framebuffer has completed the resize operation.
11175
11176	<result name="VBOX_E_NOT_SUPPORTED">
11177	Operation only valid for external frame buffers.
11178	</result>
11179
11180	</desc>
11181	<param name="screenId" type="unsigned long" dir="in"/>
11182	</method>
11183
11184	<method name="completeVHWACommand">
11185	<desc>
11186	Signals that the Video HW Acceleration command has completed.
11187	</desc>
11188
11189	<param name="command" type="octet" mod="ptr" dir="in">
11190	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11191	</param>
11192	</method>
11193
11194	</interface>
11195
11196	<!--
11197	// INetworkAdapter
11198	/////////////////////////////////////////////////////////////////////////
11199	-->
11200
11201	<enum
11202	name="NetworkAttachmentType"
11203	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11204	>
11205	<desc>
11206	Network attachment type.
11207	</desc>
11208
11209	<const name="Null" value="0">
11210	<desc>Null value, also means "not attached".</desc>
11211	</const>
11212	<const name="NAT" value="1"/>
11213	<const name="Bridged" value="2"/>
11214	<const name="Internal" value="3"/>
11215	<const name="HostOnly" value="4"/>
11216	<const name="VDE" value="5"/>
11217	</enum>
11218
11219	<enum
11220	name="NetworkAdapterType"
11221	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11222	>
11223	<desc>
11224	Network adapter type.
11225	</desc>
11226
11227	<const name="Null" value="0">
11228	<desc>Null value (never used by the API).</desc>
11229	</const>
11230	<const name="Am79C970A" value="1">
11231	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11232	</const>
11233	<const name="Am79C973" value="2">
11234	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11235	</const>
11236	<const name="I82540EM" value="3">
11237	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11238	</const>
11239	<const name="I82543GC" value="4">
11240	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11241	</const>
11242	<const name="I82545EM" value="5">
11243	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11244	</const>
11245	<const name="Virtio" value="6">
11246	<desc>Virtio network device.</desc>
11247	</const>
11248	</enum>
11249
11250	<interface
11251	name="INetworkAdapter" extends="$unknown"
11252	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11253	wsmap="managed"
11254	>
11255	<desc>
11256	Represents a virtual network adapter that is attached to a virtual machine.
11257	Each virtual machine has a fixed number of network adapter slots with one
11258	instance of this attached to each of them. Call
11259	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11260	is attached to a given slot in a given machine.
11261
11262	Each network adapter can be in one of five attachment modes, which are
11263	represented by the <link to="NetworkAttachmentType" /> enumeration;
11264	see the <link to="#attachmentType" /> attribute.
11265	</desc>
11266
11267	<attribute name="adapterType" type="NetworkAdapterType">
11268	<desc>
11269	Type of the virtual network adapter. Depending on this value,
11270	VirtualBox will provide a different virtual network hardware
11271	to the guest.
11272	</desc>
11273	</attribute>
11274
11275	<attribute name="slot" type="unsigned long" readonly="yes">
11276	<desc>
11277	Slot number this adapter is plugged into. Corresponds to
11278	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11279	to obtain this instance.
11280	</desc>
11281	</attribute>
11282
11283	<attribute name="enabled" type="boolean">
11284	<desc>
11285	Flag whether the network adapter is present in the
11286	guest system. If disabled, the virtual guest hardware will
11287	not contain this network adapter. Can only be changed when
11288	the VM is not running.
11289	</desc>
11290	</attribute>
11291
11292	<attribute name="MACAddress" type="wstring">
11293	<desc>
11294	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11295	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11296	</desc>
11297	</attribute>
11298
11299	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11300
11301	<attribute name="hostInterface" type="wstring">
11302	<desc>
11303	Name of the host network interface the VM is attached to.
11304	</desc>
11305	</attribute>
11306
11307	<attribute name="internalNetwork" type="wstring">
11308	<desc>
11309	Name of the internal network the VM is attached to.
11310	</desc>
11311	</attribute>
11312
11313	<attribute name="NATNetwork" type="wstring">
11314	<desc>
11315	Name of the NAT network the VM is attached to.
11316	</desc>
11317	</attribute>
11318
11319	<attribute name="VDENetwork" type="wstring">
11320	<desc>
11321	Name of the VDE switch the VM is attached to.
11322	</desc>
11323	</attribute>
11324
11325	<attribute name="cableConnected" type="boolean">
11326	<desc>
11327	Flag whether the adapter reports the cable as connected or not.
11328	It can be used to report offline situations to a VM.
11329	</desc>
11330	</attribute>
11331
11332	<attribute name="lineSpeed" type="unsigned long">
11333	<desc>
11334	Line speed reported by custom drivers, in units of 1 kbps.
11335	</desc>
11336	</attribute>
11337
11338	<attribute name="traceEnabled" type="boolean">
11339	<desc>
11340	Flag whether network traffic from/to the network card should be traced.
11341	Can only be toggled when the VM is turned off.
11342	</desc>
11343	</attribute>
11344
11345	<attribute name="traceFile" type="wstring">
11346	<desc>
11347	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11348	will be used.
11349	</desc>
11350	</attribute>
11351
11352	<attribute name="natDriver" type="INATEngine" readonly="yes">
11353	<desc>
11354	Points to the NAT engine which handles the network address translation
11355	for this interface. This is active only when the interface actually uses
11356	NAT (see <link to="#attachToNAT" />).
11357	</desc>
11358	</attribute>
11359
11360	<attribute name="bootPriority" type="unsigned long">
11361	<desc>
11362	Network boot priority of the adapter. Priority 1 is highest. If not set,
11363	the priority is considered to be at the lowest possible setting.
11364	</desc>
11365	</attribute>
11366
11367	<attribute name="bandwidthLimit" type="unsigned long">
11368	<desc>
11369	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11370	A zero value means uncapped/unlimited.
11371	</desc>
11372	</attribute>
11373
11374	<method name="attachToNAT">
11375	<desc>
11376	Attach the network adapter to the Network Address Translation (NAT) interface.
11377	</desc>
11378	</method>
11379
11380	<method name="attachToBridgedInterface">
11381	<desc>
11382	Attach the network adapter to a bridged host interface.
11383	</desc>
11384	</method>
11385
11386	<method name="attachToInternalNetwork">
11387	<desc>
11388	Attach the network adapter to an internal network.
11389	</desc>
11390	</method>
11391
11392	<method name="attachToHostOnlyInterface">
11393	<desc>
11394	Attach the network adapter to the host-only network.
11395	</desc>
11396	</method>
11397
11398	<method name="attachToVDE">
11399	<desc>
11400	Attach the network adapter to a VDE network.
11401	</desc>
11402	</method>
11403
11404	<method name="detach">
11405	<desc>
11406	Detach the network adapter
11407	</desc>
11408	</method>
11409	</interface>
11410
11411
11412	<!--
11413	// ISerialPort
11414	/////////////////////////////////////////////////////////////////////////
11415	-->
11416
11417	<enum
11418	name="PortMode"
11419	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11420	>
11421	<desc>
11422	The PortMode enumeration represents possible communication modes for
11423	the virtual serial port device.
11424	</desc>
11425
11426	<const name="Disconnected" value="0">
11427	<desc>Virtual device is not attached to any real host device.</desc>
11428	</const>
11429	<const name="HostPipe" value="1">
11430	<desc>Virtual device is attached to a host pipe.</desc>
11431	</const>
11432	<const name="HostDevice" value="2">
11433	<desc>Virtual device is attached to a host device.</desc>
11434	</const>
11435	<const name="RawFile" value="3">
11436	<desc>Virtual device is attached to a raw file.</desc>
11437	</const>
11438	</enum>
11439
11440	<interface
11441	name="ISerialPort" extends="$unknown"
11442	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11443	wsmap="managed"
11444	>
11445
11446	<desc>
11447	The ISerialPort interface represents the virtual serial port device.
11448
11449	The virtual serial port device acts like an ordinary serial port
11450	inside the virtual machine. This device communicates to the real
11451	serial port hardware in one of two modes: host pipe or host device.
11452
11453	In host pipe mode, the #path attribute specifies the path to the pipe on
11454	the host computer that represents a serial port. The #server attribute
11455	determines if this pipe is created by the virtual machine process at
11456	machine startup or it must already exist before starting machine
11457	execution.
11458
11459	In host device mode, the #path attribute specifies the name of the
11460	serial port device on the host computer.
11461
11462	There is also a third communication mode: the disconnected mode. In this
11463	mode, the guest OS running inside the virtual machine will be able to
11464	detect the serial port, but all port write operations will be discarded
11465	and all port read operations will return no data.
11466
11467	<see>IMachine::getSerialPort</see>
11468	</desc>
11469
11470	<attribute name="slot" type="unsigned long" readonly="yes">
11471	<desc>
11472	Slot number this serial port is plugged into. Corresponds to
11473	the value you pass to <link to="IMachine::getSerialPort"/>
11474	to obtain this instance.
11475	</desc>
11476	</attribute>
11477
11478	<attribute name="enabled" type="boolean">
11479	<desc>
11480	Flag whether the serial port is enabled. If disabled,
11481	the serial port will not be reported to the guest OS.
11482	</desc>
11483	</attribute>
11484
11485	<attribute name="IOBase" type="unsigned long">
11486	<desc>Base I/O address of the serial port.</desc>
11487	</attribute>
11488
11489	<attribute name="IRQ" type="unsigned long">
11490	<desc>IRQ number of the serial port.</desc>
11491	</attribute>
11492
11493	<attribute name="hostMode" type="PortMode">
11494	<desc>
11495	How is this port connected to the host.
11496	<note>
11497	Changing this attribute may fail if the conditions for
11498	<link to="#path"/> are not met.
11499	</note>
11500	</desc>
11501	</attribute>
11502
11503	<attribute name="server" type="boolean">
11504	<desc>
11505	Flag whether this serial port acts as a server (creates a new pipe on
11506	the host) or as a client (uses the existing pipe). This attribute is
11507	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11508	</desc>
11509	</attribute>
11510
11511	<attribute name="path" type="wstring">
11512	<desc>
11513	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11514	PortMode_HostPipe, or the host serial device name when
11515	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11516	cases, setting a @c null or empty string as the attribute's value
11517	is an error. Otherwise, the value of this property is ignored.
11518	</desc>
11519	</attribute>
11520
11521	</interface>
11522
11523	<!--
11524	// IParallelPort
11525	/////////////////////////////////////////////////////////////////////////
11526	-->
11527
11528	<interface
11529	name="IParallelPort" extends="$unknown"
11530	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11531	wsmap="managed"
11532	>
11533
11534	<desc>
11535	The IParallelPort interface represents the virtual parallel port device.
11536
11537	The virtual parallel port device acts like an ordinary parallel port
11538	inside the virtual machine. This device communicates to the real
11539	parallel port hardware using the name of the parallel device on the host
11540	computer specified in the #path attribute.
11541
11542	Each virtual parallel port device is assigned a base I/O address and an
11543	IRQ number that will be reported to the guest operating system and used
11544	to operate the given parallel port from within the virtual machine.
11545
11546	<see>IMachine::getParallelPort</see>
11547	</desc>
11548
11549	<attribute name="slot" type="unsigned long" readonly="yes">
11550	<desc>
11551	Slot number this parallel port is plugged into. Corresponds to
11552	the value you pass to <link to="IMachine::getParallelPort"/>
11553	to obtain this instance.
11554	</desc>
11555	</attribute>
11556
11557	<attribute name="enabled" type="boolean">
11558	<desc>
11559	Flag whether the parallel port is enabled. If disabled,
11560	the parallel port will not be reported to the guest OS.
11561	</desc>
11562	</attribute>
11563
11564	<attribute name="IOBase" type="unsigned long">
11565	<desc>Base I/O address of the parallel port.</desc>
11566	</attribute>
11567
11568	<attribute name="IRQ" type="unsigned long">
11569	<desc>IRQ number of the parallel port.</desc>
11570	</attribute>
11571
11572	<attribute name="path" type="wstring">
11573	<desc>
11574	Host parallel device name. If this parallel port is enabled, setting a
11575	@c null or an empty string as this attribute's value will result into
11576	an error.
11577	</desc>
11578	</attribute>
11579
11580	</interface>
11581
11582
11583	<!--
11584	// IMachineDebugger
11585	/////////////////////////////////////////////////////////////////////////
11586	-->
11587
11588	<interface
11589	name="IMachineDebugger" extends="$unknown"
11590	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11591	wsmap="suppress"
11592	>
11593	<method name="resetStats">
11594	<desc>
11595	Reset VM statistics.
11596	</desc>
11597	<param name="pattern" type="wstring" dir="in">
11598	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11599	</param>
11600	</method>
11601
11602	<method name="dumpStats">
11603	<desc>
11604	Dumps VM statistics.
11605	</desc>
11606	<param name="pattern" type="wstring" dir="in">
11607	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11608	</param>
11609	</method>
11610
11611	<method name="getStats">
11612	<desc>
11613	Get the VM statistics in a XMLish format.
11614	</desc>
11615	<param name="pattern" type="wstring" dir="in">
11616	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11617	</param>
11618	<param name="withDescriptions" type="boolean" dir="in">
11619	<desc>Whether to include the descriptions.</desc>
11620	</param>
11621	<param name="stats" type="wstring" dir="out">
11622	<desc>The XML document containing the statistics.</desc>
11623	</param>
11624	</method>
11625
11626	<method name="injectNMI">
11627	<desc>
11628	Inject an NMI into a running VT-x/AMD-V VM.
11629	</desc>
11630	</method>
11631
11632	<attribute name="singlestep" type="boolean">
11633	<desc>Switch for enabling singlestepping.</desc>
11634	</attribute>
11635
11636	<attribute name="recompileUser" type="boolean">
11637	<desc>Switch for forcing code recompilation for user mode code.</desc>
11638	</attribute>
11639
11640	<attribute name="recompileSupervisor" type="boolean">
11641	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11642	</attribute>
11643
11644	<attribute name="PATMEnabled" type="boolean">
11645	<desc>Switch for enabling and disabling the PATM component.</desc>
11646	</attribute>
11647
11648	<attribute name="CSAMEnabled" type="boolean">
11649	<desc>Switch for enabling and disabling the CSAM component.</desc>
11650	</attribute>
11651
11652	<attribute name="logEnabled" type="boolean">
11653	<desc>Switch for enabling and disabling logging.</desc>
11654	</attribute>
11655
11656	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11657	<desc>
11658	Flag indicating whether the VM is currently making use of CPU hardware
11659	virtualization extensions.
11660	</desc>
11661	</attribute>
11662
11663	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11664	<desc>
11665	Flag indicating whether the VM is currently making use of the nested paging
11666	CPU hardware virtualization extension.
11667	</desc>
11668	</attribute>
11669
11670	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11671	<desc>
11672	Flag indicating whether the VM is currently making use of the VPID
11673	VT-x extension.
11674	</desc>
11675	</attribute>
11676
11677	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11678	<desc>
11679	Flag indicating whether the VM is currently making use of the Physical
11680	Address Extension CPU feature.
11681	</desc>
11682	</attribute>
11683
11684	<attribute name="virtualTimeRate" type="unsigned long">
11685	<desc>
11686	The rate at which the virtual time runs expressed as a percentage.
11687	The accepted range is 2% to 20000%.
11688	</desc>
11689	</attribute>
11690
11691	<!-- @todo method for setting log flags, groups and destination! -->
11692
11693	<attribute name="VM" type="long long" readonly="yes">
11694	<desc>
11695	Gets the VM handle. This is only for internal use while
11696	we carve the details of this interface.
11697	</desc>
11698	</attribute>
11699
11700	</interface>
11701
11702	<!--
11703	// IUSBController
11704	/////////////////////////////////////////////////////////////////////////
11705	-->
11706
11707	<interface
11708	name="IUSBController" extends="$unknown"
11709	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11710	wsmap="managed"
11711	>
11712	<attribute name="enabled" type="boolean">
11713	<desc>
11714	Flag whether the USB controller is present in the
11715	guest system. If disabled, the virtual guest hardware will
11716	not contain any USB controller. Can only be changed when
11717	the VM is powered off.
11718	</desc>
11719	</attribute>
11720
11721	<attribute name="enabledEhci" type="boolean">
11722	<desc>
11723	Flag whether the USB EHCI controller is present in the
11724	guest system. If disabled, the virtual guest hardware will
11725	not contain a USB EHCI controller. Can only be changed when
11726	the VM is powered off.
11727	</desc>
11728	</attribute>
11729
11730	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11731	<desc>
11732	Flag whether there is an USB proxy available.
11733	</desc>
11734	</attribute>
11735
11736	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11737	<desc>
11738	USB standard version which the controller implements.
11739	This is a BCD which means that the major version is in the
11740	high byte and minor version is in the low byte.
11741	</desc>
11742	</attribute>
11743
11744	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11745	<desc>
11746	List of USB device filters associated with the machine.
11747
11748	If the machine is currently running, these filters are activated
11749	every time a new (supported) USB device is attached to the host
11750	computer that was not ignored by global filters
11751	(<link to="IHost::USBDeviceFilters"/>).
11752
11753	These filters are also activated when the machine is powered up.
11754	They are run against a list of all currently available USB
11755	devices (in states
11756	<link to="USBDeviceState_Available"/>,
11757	<link to="USBDeviceState_Busy"/>,
11758	<link to="USBDeviceState_Held"/>) that were not previously
11759	ignored by global filters.
11760
11761	If at least one filter matches the USB device in question, this
11762	device is automatically captured (attached to) the virtual USB
11763	controller of this machine.
11764
11765	<see>IUSBDeviceFilter, ::IUSBController</see>
11766	</desc>
11767	</attribute>
11768
11769	<method name="createDeviceFilter">
11770	<desc>
11771	Creates a new USB device filter. All attributes except
11772	the filter name are set to empty (any match),
11773	<i>active</i> is @c false (the filter is not active).
11774
11775	The created filter can then be added to the list of filters using
11776	<link to="#insertDeviceFilter"/>.
11777
11778	<result name="VBOX_E_INVALID_VM_STATE">
11779	The virtual machine is not mutable.
11780	</result>
11781
11782	<see>#deviceFilters</see>
11783	</desc>
11784	<param name="name" type="wstring" dir="in">
11785	<desc>
11786	Filter name. See <link to="IUSBDeviceFilter::name"/>
11787	for more info.
11788	</desc>
11789	</param>
11790	<param name="filter" type="IUSBDeviceFilter" dir="return">
11791	<desc>Created filter object.</desc>
11792	</param>
11793	</method>
11794
11795	<method name="insertDeviceFilter">
11796	<desc>
11797	Inserts the given USB device to the specified position
11798	in the list of filters.
11799
11800	Positions are numbered starting from <tt>0</tt>. If the specified
11801	position is equal to or greater than the number of elements in
11802	the list, the filter is added to the end of the collection.
11803
11804	<note>
11805	Duplicates are not allowed, so an attempt to insert a
11806	filter that is already in the collection, will return an
11807	error.
11808	</note>
11809
11810	<result name="VBOX_E_INVALID_VM_STATE">
11811	Virtual machine is not mutable.
11812	</result>
11813	<result name="E_INVALIDARG">
11814	USB device filter not created within this VirtualBox instance.
11815	</result>
11816	<result name="VBOX_E_INVALID_OBJECT_STATE">
11817	USB device filter already in list.
11818	</result>
11819
11820	<see>#deviceFilters</see>
11821	</desc>
11822	<param name="position" type="unsigned long" dir="in">
11823	<desc>Position to insert the filter to.</desc>
11824	</param>
11825	<param name="filter" type="IUSBDeviceFilter" dir="in">
11826	<desc>USB device filter to insert.</desc>
11827	</param>
11828	</method>
11829
11830	<method name="removeDeviceFilter">
11831	<desc>
11832	Removes a USB device filter from the specified position in the
11833	list of filters.
11834
11835	Positions are numbered starting from <tt>0</tt>. Specifying a
11836	position equal to or greater than the number of elements in
11837	the list will produce an error.
11838
11839	<see>#deviceFilters</see>
11840
11841	<result name="VBOX_E_INVALID_VM_STATE">
11842	Virtual machine is not mutable.
11843	</result>
11844	<result name="E_INVALIDARG">
11845	USB device filter list empty or invalid @a position.
11846	</result>
11847
11848	</desc>
11849	<param name="position" type="unsigned long" dir="in">
11850	<desc>Position to remove the filter from.</desc>
11851	</param>
11852	<param name="filter" type="IUSBDeviceFilter" dir="return">
11853	<desc>Removed USB device filter.</desc>
11854	</param>
11855	</method>
11856
11857	</interface>
11858
11859
11860	<!--
11861	// IUSBDevice
11862	/////////////////////////////////////////////////////////////////////////
11863	-->
11864
11865	<interface
11866	name="IUSBDevice" extends="$unknown"
11867	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11868	wsmap="managed"
11869	>
11870	<desc>
11871	The IUSBDevice interface represents a virtual USB device attached to the
11872	virtual machine.
11873
11874	A collection of objects implementing this interface is stored in the
11875	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11876	attached to a running virtual machine's USB controller.
11877	</desc>
11878
11879	<attribute name="id" type="uuid" mod="string" readonly="yes">
11880	<desc>
11881	Unique USB device ID. This ID is built from #vendorId,
11882	#productId, #revision and #serialNumber.
11883	</desc>
11884	</attribute>
11885
11886	<attribute name="vendorId" type="unsigned short" readonly="yes">
11887	<desc>Vendor ID.</desc>
11888	</attribute>
11889
11890	<attribute name="productId" type="unsigned short" readonly="yes">
11891	<desc>Product ID.</desc>
11892	</attribute>
11893
11894	<attribute name="revision" type="unsigned short" readonly="yes">
11895	<desc>
11896	Product revision number. This is a packed BCD represented as
11897	unsigned short. The high byte is the integer part and the low
11898	byte is the decimal.
11899	</desc>
11900	</attribute>
11901
11902	<attribute name="manufacturer" type="wstring" readonly="yes">
11903	<desc>Manufacturer string.</desc>
11904	</attribute>
11905
11906	<attribute name="product" type="wstring" readonly="yes">
11907	<desc>Product string.</desc>
11908	</attribute>
11909
11910	<attribute name="serialNumber" type="wstring" readonly="yes">
11911	<desc>Serial number string.</desc>
11912	</attribute>
11913
11914	<attribute name="address" type="wstring" readonly="yes">
11915	<desc>Host specific address of the device.</desc>
11916	</attribute>
11917
11918	<attribute name="port" type="unsigned short" readonly="yes">
11919	<desc>
11920	Host USB port number the device is physically
11921	connected to.
11922	</desc>
11923	</attribute>
11924
11925	<attribute name="version" type="unsigned short" readonly="yes">
11926	<desc>
11927	The major USB version of the device - 1 or 2.
11928	</desc>
11929	</attribute>
11930
11931	<attribute name="portVersion" type="unsigned short" readonly="yes">
11932	<desc>
11933	The major USB version of the host USB port the device is
11934	physically connected to - 1 or 2. For devices not connected to
11935	anything this will have the same value as the version attribute.
11936	</desc>
11937	</attribute>
11938
11939	<attribute name="remote" type="boolean" readonly="yes">
11940	<desc>
11941	Whether the device is physically connected to a remote VRDE
11942	client or to a local host machine.
11943	</desc>
11944	</attribute>
11945
11946	</interface>
11947
11948
11949	<!--
11950	// IUSBDeviceFilter
11951	/////////////////////////////////////////////////////////////////////////
11952	-->
11953
11954	<interface
11955	name="IUSBDeviceFilter" extends="$unknown"
11956	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11957	wsmap="managed"
11958	>
11959	<desc>
11960	The IUSBDeviceFilter interface represents an USB device filter used
11961	to perform actions on a group of USB devices.
11962
11963	This type of filters is used by running virtual machines to
11964	automatically capture selected USB devices once they are physically
11965	attached to the host computer.
11966
11967	A USB device is matched to the given device filter if and only if all
11968	attributes of the device match the corresponding attributes of the
11969	filter (that is, attributes are joined together using the logical AND
11970	operation). On the other hand, all together, filters in the list of
11971	filters carry the semantics of the logical OR operation. So if it is
11972	desirable to create a match like "this vendor id OR this product id",
11973	one needs to create two filters and specify "any match" (see below)
11974	for unused attributes.
11975
11976	All filter attributes used for matching are strings. Each string
11977	is an expression representing a set of values of the corresponding
11978	device attribute, that will match the given filter. Currently, the
11979	following filtering expressions are supported:
11980
11981	<ul>
11982	<li><i>Interval filters</i>. Used to specify valid intervals for
11983	integer device attributes (Vendor ID, Product ID and Revision).
11984	The format of the string is:
11985
11986	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11987
11988	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11989	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11990	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11991	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11992	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11993	possible integer is assumed.
11994	</li>
11995	<li><i>Boolean filters</i>. Used to specify acceptable values for
11996	boolean device attributes. The format of the string is:
11997
11998	<tt>true\|false\|yes\|no\|0\|1</tt>
11999
12000	</li>
12001	<li><i>Exact match</i>. Used to specify a single value for the given
12002	device attribute. Any string that doesn't start with <tt>int:</tt>
12003	represents the exact match. String device attributes are compared to
12004	this string including case of symbols. Integer attributes are first
12005	converted to a string (see individual filter attributes) and then
12006	compared ignoring case.
12007
12008	</li>
12009	<li><i>Any match</i>. Any value of the corresponding device attribute
12010	will match the given filter. An empty or @c null string is
12011	used to construct this type of filtering expressions.
12012
12013	</li>
12014	</ul>
12015
12016	<note>
12017	On the Windows host platform, interval filters are not currently
12018	available. Also all string filter attributes
12019	(<link to="#manufacturer"/>, <link to="#product"/>,
12020	<link to="#serialNumber"/>) are ignored, so they behave as
12021	<i>any match</i> no matter what string expression is specified.
12022	</note>
12023
12024	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12025	</desc>
12026
12027	<attribute name="name" type="wstring">
12028	<desc>
12029	Visible name for this filter.
12030	This name is used to visually distinguish one filter from another,
12031	so it can neither be @c null nor an empty string.
12032	</desc>
12033	</attribute>
12034
12035	<attribute name="active" type="boolean">
12036	<desc>Whether this filter active or has been temporarily disabled.</desc>
12037	</attribute>
12038
12039	<attribute name="vendorId" type="wstring">
12040	<desc>
12041	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12042	The string representation for the <i>exact matching</i>
12043	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12044	(including leading zeroes).
12045	</desc>
12046	</attribute>
12047
12048	<attribute name="productId" type="wstring">
12049	<desc>
12050	<link to="IUSBDevice::productId">Product ID</link> filter.
12051	The string representation for the <i>exact matching</i>
12052	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12053	(including leading zeroes).
12054	</desc>
12055	</attribute>
12056
12057	<attribute name="revision" type="wstring">
12058	<desc>
12059	<link to="IUSBDevice::productId">Product revision number</link>
12060	filter. The string representation for the <i>exact matching</i>
12061	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12062	of the integer part of the revision, and <tt>F</tt> is the
12063	decimal digit of its fractional part (including leading and
12064	trailing zeros).
12065	Note that for interval filters, it's best to use the hexadecimal
12066	form, because the revision is stored as a 16 bit packed BCD value;
12067	so the expression <tt>int:0x0100-0x0199</tt> will match any
12068	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12069	</desc>
12070	</attribute>
12071
12072	<attribute name="manufacturer" type="wstring">
12073	<desc>
12074	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12075	</desc>
12076	</attribute>
12077
12078	<attribute name="product" type="wstring">
12079	<desc>
12080	<link to="IUSBDevice::product">Product</link> filter.
12081	</desc>
12082	</attribute>
12083
12084	<attribute name="serialNumber" type="wstring">
12085	<desc>
12086	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12087	</desc>
12088	</attribute>
12089
12090	<attribute name="port" type="wstring">
12091	<desc>
12092	<link to="IUSBDevice::port">Host USB port</link> filter.
12093	</desc>
12094	</attribute>
12095
12096	<attribute name="remote" type="wstring">
12097	<desc>
12098	<link to="IUSBDevice::remote">Remote state</link> filter.
12099	<note>
12100	This filter makes sense only for machine USB filters,
12101	i.e. it is ignored by IHostUSBDeviceFilter objects.
12102	</note>
12103	</desc>
12104	</attribute>
12105
12106	<attribute name="maskedInterfaces" type="unsigned long">
12107	<desc>
12108	This is an advanced option for hiding one or more USB interfaces
12109	from the guest. The value is a bit mask where the bits that are set
12110	means the corresponding USB interface should be hidden, masked off
12111	if you like.
12112	This feature only works on Linux hosts.
12113	</desc>
12114	</attribute>
12115
12116	</interface>
12117
12118
12119	<!--
12120	// IHostUSBDevice
12121	/////////////////////////////////////////////////////////////////////////
12122	-->
12123
12124	<enum
12125	name="USBDeviceState"
12126	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12127	>
12128	<desc>
12129	USB device state. This enumeration represents all possible states
12130	of the USB device physically attached to the host computer regarding
12131	its state on the host computer and availability to guest computers
12132	(all currently running virtual machines).
12133
12134	Once a supported USB device is attached to the host, global USB
12135	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12136	either ignore the device, or put it to USBDeviceState_Held state, or do
12137	nothing. Unless the device is ignored by global filters, filters of all
12138	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12139	activated that can put it to USBDeviceState_Captured state.
12140
12141	If the device was ignored by global filters, or didn't match
12142	any filters at all (including guest ones), it is handled by the host
12143	in a normal way. In this case, the device state is determined by
12144	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12145	or USBDeviceState_Available, depending on the current device usage.
12146
12147	Besides auto-capturing based on filters, the device can be manually
12148	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12149	state is USBDeviceState_Busy, USBDeviceState_Available or
12150	USBDeviceState_Held.
12151
12152	<note>
12153	Due to differences in USB stack implementations in Linux and Win32,
12154	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12155	only to the Linux version of the product. This also means that (<link
12156	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12157	device state is USBDeviceState_Held.
12158	</note>
12159
12160	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12161	</desc>
12162
12163	<const name="NotSupported" value="0">
12164	<desc>
12165	Not supported by the VirtualBox server, not available to guests.
12166	</desc>
12167	</const>
12168	<const name="Unavailable" value="1">
12169	<desc>
12170	Being used by the host computer exclusively,
12171	not available to guests.
12172	</desc>
12173	</const>
12174	<const name="Busy" value="2">
12175	<desc>
12176	Being used by the host computer, potentially available to guests.
12177	</desc>
12178	</const>
12179	<const name="Available" value="3">
12180	<desc>
12181	Not used by the host computer, available to guests (the host computer
12182	can also start using the device at any time).
12183	</desc>
12184	</const>
12185	<const name="Held" value="4">
12186	<desc>
12187	Held by the VirtualBox server (ignored by the host computer),
12188	available to guests.
12189	</desc>
12190	</const>
12191	<const name="Captured" value="5">
12192	<desc>
12193	Captured by one of the guest computers, not available
12194	to anybody else.
12195	</desc>
12196	</const>
12197	</enum>
12198
12199	<interface
12200	name="IHostUSBDevice" extends="IUSBDevice"
12201	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12202	wsmap="managed"
12203	>
12204	<desc>
12205	The IHostUSBDevice interface represents a physical USB device attached
12206	to the host computer.
12207
12208	Besides properties inherited from IUSBDevice, this interface adds the
12209	<link to="#state"/> property that holds the current state of the USB
12210	device.
12211
12212	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12213	</desc>
12214
12215	<attribute name="state" type="USBDeviceState" readonly="yes">
12216	<desc>
12217	Current state of the device.
12218	</desc>
12219	</attribute>
12220
12221	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12222
12223	</interface>
12224
12225
12226	<!--
12227	// IHostUSBDeviceFilter
12228	/////////////////////////////////////////////////////////////////////////
12229	-->
12230
12231	<enum
12232	name="USBDeviceFilterAction"
12233	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12234	>
12235	<desc>
12236	Actions for host USB device filters.
12237	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12238	</desc>
12239
12240	<const name="Null" value="0">
12241	<desc>Null value (never used by the API).</desc>
12242	</const>
12243	<const name="Ignore" value="1">
12244	<desc>Ignore the matched USB device.</desc>
12245	</const>
12246	<const name="Hold" value="2">
12247	<desc>Hold the matched USB device.</desc>
12248	</const>
12249	</enum>
12250
12251	<interface
12252	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12253	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12254	wsmap="managed"
12255	>
12256	<desc>
12257	The IHostUSBDeviceFilter interface represents a global filter for a
12258	physical USB device used by the host computer. Used indirectly in
12259	<link to="IHost::USBDeviceFilters"/>.
12260
12261	Using filters of this type, the host computer determines the initial
12262	state of the USB device after it is physically attached to the
12263	host's USB controller.
12264
12265	<note>
12266	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12267	filters, because it makes sense only for
12268	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12269	</note>
12270
12271	<see>IHost::USBDeviceFilters</see>
12272	</desc>
12273
12274	<attribute name="action" type="USBDeviceFilterAction">
12275	<desc>
12276	Action performed by the host when an attached USB device
12277	matches this filter.
12278	</desc>
12279	</attribute>
12280
12281	</interface>
12282
12283	<!--
12284	// IAudioAdapter
12285	/////////////////////////////////////////////////////////////////////////
12286	-->
12287
12288	<enum
12289	name="AudioDriverType"
12290	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12291	>
12292	<desc>
12293	Host audio driver type.
12294	</desc>
12295
12296	<const name="Null" value="0">
12297	<desc>Null value, also means "dummy audio driver".</desc>
12298	</const>
12299	<const name="WinMM" value="1">
12300	<desc>Windows multimedia (Windows hosts only).</desc>
12301	</const>
12302	<const name="OSS" value="2">
12303	<desc>Open Sound System (Linux hosts only).</desc>
12304	</const>
12305	<const name="ALSA" value="3">
12306	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12307	</const>
12308	<const name="DirectSound" value="4">
12309	<desc>DirectSound (Windows hosts only).</desc>
12310	</const>
12311	<const name="CoreAudio" value="5">
12312	<desc>CoreAudio (Mac hosts only).</desc>
12313	</const>
12314	<const name="MMPM" value="6">
12315	<desc>Reserved for historical reasons.</desc>
12316	</const>
12317	<const name="Pulse" value="7">
12318	<desc>PulseAudio (Linux hosts only).</desc>
12319	</const>
12320	<const name="SolAudio" value="8">
12321	<desc>Solaris audio (Solaris hosts only).</desc>
12322	</const>
12323	</enum>
12324
12325	<enum
12326	name="AudioControllerType"
12327	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12328	>
12329	<desc>
12330	Virtual audio controller type.
12331	</desc>
12332
12333	<const name="AC97" value="0"/>
12334	<const name="SB16" value="1"/>
12335	<const name="HDA" value="2"/>
12336	</enum>
12337
12338	<interface
12339	name="IAudioAdapter" extends="$unknown"
12340	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12341	wsmap="managed"
12342	>
12343	<desc>
12344	The IAudioAdapter interface represents the virtual audio adapter of
12345	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12346	</desc>
12347	<attribute name="enabled" type="boolean">
12348	<desc>
12349	Flag whether the audio adapter is present in the
12350	guest system. If disabled, the virtual guest hardware will
12351	not contain any audio adapter. Can only be changed when
12352	the VM is not running.
12353	</desc>
12354	</attribute>
12355	<attribute name="audioController" type="AudioControllerType">
12356	<desc>
12357	The audio hardware we emulate.
12358	</desc>
12359	</attribute>
12360	<attribute name="audioDriver" type="AudioDriverType">
12361	<desc>
12362	Audio driver the adapter is connected to. This setting
12363	can only be changed when the VM is not running.
12364	</desc>
12365	</attribute>
12366	</interface>
12367
12368	<enum
12369	name="AuthType"
12370	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12371	>
12372	<desc>
12373	VirtualBox authentication type.
12374	</desc>
12375
12376	<const name="Null" value="0">
12377	<desc>Null value, also means "no authentication".</desc>
12378	</const>
12379	<const name="External" value="1"/>
12380	<const name="Guest" value="2"/>
12381	</enum>
12382
12383	<!--
12384	// IVRDEServer
12385	/////////////////////////////////////////////////////////////////////////
12386	-->
12387
12388	<interface
12389	name="IVRDEServer" extends="$unknown"
12390	uuid="f68a6b34-6f09-4040-8de1-e8d746c4a9ea"
12391	wsmap="managed"
12392	>
12393	<attribute name="enabled" type="boolean">
12394	<desc>VRDE server status.</desc>
12395	</attribute>
12396
12397	<attribute name="authType" type="AuthType">
12398	<desc>VRDE authentication method.</desc>
12399	</attribute>
12400
12401	<attribute name="authTimeout" type="unsigned long">
12402	<desc>Timeout for guest authentication. Milliseconds.</desc>
12403	</attribute>
12404
12405	<attribute name="allowMultiConnection" type="boolean">
12406	<desc>
12407	Flag whether multiple simultaneous connections to the VM are permitted.
12408	Note that this will be replaced by a more powerful mechanism in the future.
12409	</desc>
12410	</attribute>
12411
12412	<attribute name="reuseSingleConnection" type="boolean">
12413	<desc>
12414	Flag whether the existing connection must be dropped and a new connection
12415	must be established by the VRDE server, when a new client connects in single
12416	connection mode.
12417	</desc>
12418	</attribute>
12419
12420	<attribute name="videoChannel" type="boolean">
12421	<desc>
12422	Flag whether video redirectiron channel is enabled.
12423	</desc>
12424	</attribute>
12425
12426	<attribute name="videoChannelQuality" type="unsigned long">
12427	<desc>
12428	Image quality in percents.
12429	</desc>
12430	</attribute>
12431
12432	<attribute name="VRDELibrary" type="wstring">
12433	<desc>
12434	VRDE library used by this VM. Overrides
12435	<link to="ISystemProperties::defaultVRDELibrary"/>.
12436	</desc>
12437	</attribute>
12438
12439	<method name="setVRDEProperty">
12440	<desc>
12441	Sets a VRDE specific property string.
12442
12443	If you pass @c null or empty string as a key @a value, the given @a key
12444	will be deleted.
12445
12446	</desc>
12447	<param name="key" type="wstring" dir="in">
12448	<desc>Name of the key to set.</desc>
12449	</param>
12450	<param name="value" type="wstring" dir="in">
12451	<desc>Value to assign to the key.</desc>
12452	</param>
12453	</method>
12454
12455	<method name="getVRDEProperty">
12456	<desc>
12457	Returns a VRDE specific property string.
12458
12459	If the requested data @a key does not exist, this function will
12460	succeed and return an empty string in the @a value argument.
12461
12462	</desc>
12463	<param name="key" type="wstring" dir="in">
12464	<desc>Name of the key to get.</desc>
12465	</param>
12466	<param name="value" type="wstring" dir="return">
12467	<desc>Value of the requested key.</desc>
12468	</param>
12469	</method>
12470
12471	</interface>
12472
12473
12474	<!--
12475	// ISharedFolder
12476	/////////////////////////////////////////////////////////////////////////
12477	-->
12478
12479	<interface
12480	name="ISharedFolder" extends="$unknown"
12481	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12482	wsmap="struct"
12483	>
12484	<desc>
12485	The ISharedFolder interface represents a folder in the host computer's
12486	file system accessible from the guest OS running inside a virtual
12487	machine using an associated logical name.
12488
12489	There are three types of shared folders:
12490	<ul>
12491	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12492	folders available to all virtual machines.</li>
12493	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12494	VM-specific shared folders available to the given virtual machine at
12495	startup.</li>
12496	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12497	VM-specific shared folders created in the session context (for
12498	example, when the virtual machine is running) and automatically
12499	discarded when the session is closed (the VM is powered off).</li>
12500	</ul>
12501
12502	Logical names of shared folders must be unique within the given scope
12503	(global, permanent or transient). However, they do not need to be unique
12504	across scopes. In this case, the definition of the shared folder in a
12505	more specific scope takes precedence over definitions in all other
12506	scopes. The order of precedence is (more specific to more general):
12507	<ol>
12508	<li>Transient definitions</li>
12509	<li>Permanent definitions</li>
12510	<li>Global definitions</li>
12511	</ol>
12512
12513	For example, if MyMachine has a shared folder named
12514	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12515	transient shared folder named <tt>C_DRIVE</tt> (that points
12516	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12517	of <tt>C_DRIVE</tt> in the guest OS so
12518	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12519	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12520	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12521	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12522	to <tt>C:\\</tt> if it still exists.
12523
12524	Note that permanent and transient shared folders of different machines
12525	are in different name spaces, so they don't overlap and don't need to
12526	have unique logical names.
12527
12528	<note>
12529	Global shared folders are not implemented in the current version of the
12530	product.
12531	</note>
12532	</desc>
12533
12534	<attribute name="name" type="wstring" readonly="yes">
12535	<desc>Logical name of the shared folder.</desc>
12536	</attribute>
12537
12538	<attribute name="hostPath" type="wstring" readonly="yes">
12539	<desc>Full path to the shared folder in the host file system.</desc>
12540	</attribute>
12541
12542	<attribute name="accessible" type="boolean" readonly="yes">
12543	<desc>
12544	Whether the folder defined by the host path is currently
12545	accessible or not.
12546	For example, the folder can be inaccessible if it is placed
12547	on the network share that is not available by the time
12548	this property is read.
12549	</desc>
12550	</attribute>
12551
12552	<attribute name="writable" type="boolean" readonly="yes">
12553	<desc>
12554	Whether the folder defined by the host path is writable or
12555	not.
12556	</desc>
12557	</attribute>
12558
12559	<attribute name="autoMount" type="boolean" readonly="yes">
12560	<desc>
12561	Whether the folder gets automatically mounted by the guest or not.
12562	</desc>
12563	</attribute>
12564
12565	<attribute name="lastAccessError" type="wstring" readonly="yes">
12566	<desc>
12567	Text message that represents the result of the last accessibility
12568	check.
12569
12570	Accessibility checks are performed each time the <link to="#accessible"/>
12571	attribute is read. An empty string is returned if the last
12572	accessibility check was successful. A non-empty string indicates a
12573	failure and should normally describe a reason of the failure (for
12574	example, a file read error).
12575	</desc>
12576	</attribute>
12577
12578	</interface>
12579
12580	<!--
12581	// ISession
12582	/////////////////////////////////////////////////////////////////////////
12583	-->
12584
12585	<interface
12586	name="IInternalSessionControl" extends="$unknown"
12587	uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
12588	internal="yes"
12589	wsmap="suppress"
12590	>
12591	<method name="getPID">
12592	<desc>PID of the process that has created this Session object.
12593	</desc>
12594	<param name="pid" type="unsigned long" dir="return"/>
12595	</method>
12596
12597	<method name="getRemoteConsole">
12598	<desc>
12599	Returns the console object suitable for remote control.
12600
12601	<result name="VBOX_E_INVALID_VM_STATE">
12602	Session state prevents operation.
12603	</result>
12604	<result name="VBOX_E_INVALID_OBJECT_STATE">
12605	Session type prevents operation.
12606	</result>
12607
12608	</desc>
12609	<param name="console" type="IConsole" dir="return"/>
12610	</method>
12611
12612	<method name="assignMachine">
12613	<desc>
12614	Assigns the machine object associated with this direct-type
12615	session or informs the session that it will be a remote one
12616	(if @a machine == @c null).
12617
12618	<result name="VBOX_E_INVALID_VM_STATE">
12619	Session state prevents operation.
12620	</result>
12621	<result name="VBOX_E_INVALID_OBJECT_STATE">
12622	Session type prevents operation.
12623	</result>
12624
12625	</desc>
12626	<param name="machine" type="IMachine" dir="in"/>
12627	</method>
12628
12629	<method name="assignRemoteMachine">
12630	<desc>
12631	Assigns the machine and the (remote) console object associated with
12632	this remote-type session.
12633
12634	<result name="VBOX_E_INVALID_VM_STATE">
12635	Session state prevents operation.
12636	</result>
12637
12638	</desc>
12639	<param name="machine" type="IMachine" dir="in"/>
12640	<param name="console" type="IConsole" dir="in"/>
12641	</method>
12642
12643	<method name="updateMachineState">
12644	<desc>
12645	Updates the machine state in the VM process.
12646	Must be called only in certain cases
12647	(see the method implementation).
12648
12649	<result name="VBOX_E_INVALID_VM_STATE">
12650	Session state prevents operation.
12651	</result>
12652	<result name="VBOX_E_INVALID_OBJECT_STATE">
12653	Session type prevents operation.
12654	</result>
12655
12656	</desc>
12657	<param name="aMachineState" type="MachineState" dir="in"/>
12658	</method>
12659
12660	<method name="uninitialize">
12661	<desc>
12662	Uninitializes (closes) this session. Used by VirtualBox to close
12663	the corresponding remote session when the direct session dies
12664	or gets closed.
12665
12666	<result name="VBOX_E_INVALID_VM_STATE">
12667	Session state prevents operation.
12668	</result>
12669
12670	</desc>
12671	</method>
12672
12673	<method name="onNetworkAdapterChange">
12674	<desc>
12675	Triggered when settings of a network adapter of the
12676	associated virtual machine have changed.
12677
12678	<result name="VBOX_E_INVALID_VM_STATE">
12679	Session state prevents operation.
12680	</result>
12681	<result name="VBOX_E_INVALID_OBJECT_STATE">
12682	Session type prevents operation.
12683	</result>
12684
12685	</desc>
12686	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12687	<param name="changeAdapter" type="boolean" dir="in"/>
12688	</method>
12689
12690	<method name="onSerialPortChange">
12691	<desc>
12692	Triggered when settings of a serial port of the
12693	associated virtual machine have changed.
12694
12695	<result name="VBOX_E_INVALID_VM_STATE">
12696	Session state prevents operation.
12697	</result>
12698	<result name="VBOX_E_INVALID_OBJECT_STATE">
12699	Session type prevents operation.
12700	</result>
12701
12702	</desc>
12703	<param name="serialPort" type="ISerialPort" dir="in"/>
12704	</method>
12705
12706	<method name="onParallelPortChange">
12707	<desc>
12708	Triggered when settings of a parallel port of the
12709	associated virtual machine have changed.
12710
12711	<result name="VBOX_E_INVALID_VM_STATE">
12712	Session state prevents operation.
12713	</result>
12714	<result name="VBOX_E_INVALID_OBJECT_STATE">
12715	Session type prevents operation.
12716	</result>
12717
12718	</desc>
12719	<param name="parallelPort" type="IParallelPort" dir="in"/>
12720	</method>
12721
12722	<method name="onStorageControllerChange">
12723	<desc>
12724	Triggered when settings of a storage controller of the
12725	associated virtual machine have changed.
12726
12727	<result name="VBOX_E_INVALID_VM_STATE">
12728	Session state prevents operation.
12729	</result>
12730	<result name="VBOX_E_INVALID_OBJECT_STATE">
12731	Session type prevents operation.
12732	</result>
12733
12734	</desc>
12735	</method>
12736
12737	<method name="onMediumChange">
12738	<desc>
12739	Triggered when attached media of the
12740	associated virtual machine have changed.
12741
12742	<result name="VBOX_E_INVALID_VM_STATE">
12743	Session state prevents operation.
12744	</result>
12745	<result name="VBOX_E_INVALID_OBJECT_STATE">
12746	Session type prevents operation.
12747	</result>
12748
12749	</desc>
12750
12751	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12752	<param name="force" type="boolean" dir="in"/>
12753	</method>
12754
12755	<method name="onCPUChange">
12756	<desc>
12757	Notification when a CPU changes.
12758	</desc>
12759	<param name="cpu" type="unsigned long" dir="in">
12760	<desc>The CPU which changed</desc>
12761	</param>
12762	<param name="add" type="boolean" dir="in">
12763	<desc>Flag whether the CPU was added or removed</desc>
12764	</param>
12765	</method>
12766
12767	<method name="onCPUExecutionCapChange">
12768	<desc>
12769	Notification when the CPU execution cap changes.
12770	</desc>
12771	<param name="executionCap" type="unsigned long" dir="in">
12772	<desc>The new CPU execution cap value. (1-100)</desc>
12773	</param>
12774	</method>
12775
12776	<method name="onVRDEServerChange">
12777	<desc>
12778	Triggered when settings of the VRDE server object of the
12779	associated virtual machine have changed.
12780
12781	<result name="VBOX_E_INVALID_VM_STATE">
12782	Session state prevents operation.
12783	</result>
12784	<result name="VBOX_E_INVALID_OBJECT_STATE">
12785	Session type prevents operation.
12786	</result>
12787
12788	</desc>
12789	<param name="restart" type="boolean" dir="in">
12790	<desc>Flag whether the server must be restarted</desc>
12791	</param>
12792	</method>
12793
12794	<method name="onUSBControllerChange">
12795	<desc>
12796	Triggered when settings of the USB controller object of the
12797	associated virtual machine have changed.
12798
12799	<result name="VBOX_E_INVALID_VM_STATE">
12800	Session state prevents operation.
12801	</result>
12802	<result name="VBOX_E_INVALID_OBJECT_STATE">
12803	Session type prevents operation.
12804	</result>
12805
12806	</desc>
12807	</method>
12808
12809	<method name="onSharedFolderChange">
12810	<desc>
12811	Triggered when a permanent (global or machine) shared folder has been
12812	created or removed.
12813	<note>
12814	We don't pass shared folder parameters in this notification because
12815	the order in which parallel notifications are delivered is not defined,
12816	therefore it could happen that these parameters were outdated by the
12817	time of processing this notification.
12818	</note>
12819
12820	<result name="VBOX_E_INVALID_VM_STATE">
12821	Session state prevents operation.
12822	</result>
12823	<result name="VBOX_E_INVALID_OBJECT_STATE">
12824	Session type prevents operation.
12825	</result>
12826
12827	</desc>
12828	<param name="global" type="boolean" dir="in"/>
12829	</method>
12830
12831	<method name="onUSBDeviceAttach">
12832	<desc>
12833	Triggered when a request to capture a USB device (as a result
12834	of matched USB filters or direct call to
12835	<link to="IConsole::attachUSBDevice"/>) has completed.
12836	A @c null @a error object means success, otherwise it
12837	describes a failure.
12838
12839	<result name="VBOX_E_INVALID_VM_STATE">
12840	Session state prevents operation.
12841	</result>
12842	<result name="VBOX_E_INVALID_OBJECT_STATE">
12843	Session type prevents operation.
12844	</result>
12845
12846	</desc>
12847	<param name="device" type="IUSBDevice" dir="in"/>
12848	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12849	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12850	</method>
12851
12852	<method name="onUSBDeviceDetach">
12853	<desc>
12854	Triggered when a request to release the USB device (as a result
12855	of machine termination or direct call to
12856	<link to="IConsole::detachUSBDevice"/>) has completed.
12857	A @c null @a error object means success, otherwise it
12858	describes a failure.
12859
12860	<result name="VBOX_E_INVALID_VM_STATE">
12861	Session state prevents operation.
12862	</result>
12863	<result name="VBOX_E_INVALID_OBJECT_STATE">
12864	Session type prevents operation.
12865	</result>
12866
12867	</desc>
12868	<param name="id" type="uuid" mod="string" dir="in"/>
12869	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12870	</method>
12871
12872	<method name="onShowWindow">
12873	<desc>
12874	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12875	<link to="IMachine::showConsoleWindow"/> in order to notify
12876	console listeners
12877	<link to="ICanShowWindowEvent"/>
12878	and <link to="IShowWindowEvent"/>.
12879
12880	<result name="VBOX_E_INVALID_OBJECT_STATE">
12881	Session type prevents operation.
12882	</result>
12883
12884	</desc>
12885	<param name="check" type="boolean" dir="in"/>
12886	<param name="canShow" type="boolean" dir="out"/>
12887	<param name="winId" type="long long" dir="out"/>
12888	</method>
12889
12890	<method name="accessGuestProperty">
12891	<desc>
12892	Called by <link to="IMachine::getGuestProperty"/> and by
12893	<link to="IMachine::setGuestProperty"/> in order to read and
12894	modify guest properties.
12895
12896	<result name="VBOX_E_INVALID_VM_STATE">
12897	Machine session is not open.
12898	</result>
12899	<result name="VBOX_E_INVALID_OBJECT_STATE">
12900	Session type is not direct.
12901	</result>
12902
12903	</desc>
12904	<param name="name" type="wstring" dir="in"/>
12905	<param name="value" type="wstring" dir="in"/>
12906	<param name="flags" type="wstring" dir="in"/>
12907	<param name="isSetter" type="boolean" dir="in"/>
12908	<param name="retValue" type="wstring" dir="out"/>
12909	<param name="retTimestamp" type="long long" dir="out"/>
12910	<param name="retFlags" type="wstring" dir="out"/>
12911	</method>
12912
12913	<method name="enumerateGuestProperties">
12914	<desc>
12915	Return a list of the guest properties matching a set of patterns along
12916	with their values, time stamps and flags.
12917
12918	<result name="VBOX_E_INVALID_VM_STATE">
12919	Machine session is not open.
12920	</result>
12921	<result name="VBOX_E_INVALID_OBJECT_STATE">
12922	Session type is not direct.
12923	</result>
12924
12925	</desc>
12926	<param name="patterns" type="wstring" dir="in">
12927	<desc>
12928	The patterns to match the properties against as a comma-separated
12929	string. If this is empty, all properties currently set will be
12930	returned.
12931	</desc>
12932	</param>
12933	<param name="key" type="wstring" dir="out" safearray="yes">
12934	<desc>
12935	The key names of the properties returned.
12936	</desc>
12937	</param>
12938	<param name="value" type="wstring" dir="out" safearray="yes">
12939	<desc>
12940	The values of the properties returned. The array entries match the
12941	corresponding entries in the @a key array.
12942	</desc>
12943	</param>
12944	<param name="timestamp" type="long long" dir="out" safearray="yes">
12945	<desc>
12946	The time stamps of the properties returned. The array entries match
12947	the corresponding entries in the @a key array.
12948	</desc>
12949	</param>
12950	<param name="flags" type="wstring" dir="out" safearray="yes">
12951	<desc>
12952	The flags of the properties returned. The array entries match the
12953	corresponding entries in the @a key array.
12954	</desc>
12955	</param>
12956	</method>
12957
12958	<method name="onlineMergeMedium">
12959	<desc>
12960	Triggers online merging of a hard disk. Used internally when deleting
12961	a snapshot while a VM referring to the same hard disk chain is running.
12962
12963	<result name="VBOX_E_INVALID_VM_STATE">
12964	Machine session is not open.
12965	</result>
12966	<result name="VBOX_E_INVALID_OBJECT_STATE">
12967	Session type is not direct.
12968	</result>
12969
12970	</desc>
12971	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12972	<desc>The medium attachment to identify the medium chain.</desc>
12973	</param>
12974	<param name="sourceIdx" type="unsigned long" dir="in">
12975	<desc>The index of the source image in the chain.
12976	Redundant, but drastically reduces IPC.</desc>
12977	</param>
12978	<param name="targetIdx" type="unsigned long" dir="in">
12979	<desc>The index of the target image in the chain.
12980	Redundant, but drastically reduces IPC.</desc>
12981	</param>
12982	<param name="source" type="IMedium" dir="in">
12983	<desc>Merge source medium.</desc>
12984	</param>
12985	<param name="target" type="IMedium" dir="in">
12986	<desc>Merge target medium.</desc>
12987	</param>
12988	<param name="mergeForward" type="boolean" dir="in">
12989	<desc>Merge direction.</desc>
12990	</param>
12991	<param name="parentForTarget" type="IMedium" dir="in">
12992	<desc>For forward merges: new parent for target medium.</desc>
12993	</param>
12994	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12995	<desc>For backward merges: list of media which need their parent UUID
12996	updated.</desc>
12997	</param>
12998	<param name="progress" type="IProgress" dir="in">
12999	<desc>
13000	Progress object for this operation.
13001	</desc>
13002	</param>
13003	</method>
13004
13005	</interface>
13006
13007	<interface
13008	name="ISession" extends="$unknown"
13009	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13010	wsmap="managed"
13011	>
13012	<desc>
13013	The ISession interface represents a client process and allows for locking
13014	virtual machines (represented by IMachine objects) to prevent conflicting
13015	changes to the machine.
13016
13017	Any caller wishing to manipulate a virtual machine needs to create a session
13018	object first, which lives in its own process space. Such session objects are
13019	then associated with <link to="IMachine" /> objects living in the VirtualBox
13020	server process to coordinate such changes.
13021
13022	There are two typical scenarios in which sessions are used:
13023
13024	<ul>
13025	<li>To alter machine settings or control a running virtual machine, one
13026	needs to lock a machine for a given session (client process) by calling
13027	<link to="IMachine::lockMachine"/>.
13028
13029	Whereas multiple sessions may control a running virtual machine, only
13030	one process can obtain a write lock on the machine to prevent conflicting
13031	changes. A write lock is also needed if a process wants to actually run a
13032	virtual machine in its own context, such as the VirtualBox GUI or
13033	VBoxHeadless front-ends. They must also lock a machine for their own
13034	sessions before they are allowed to power up the virtual machine.
13035
13036	As a result, no machine settings can be altered while another process is
13037	already using it, either because that process is modifying machine settings
13038	or because the machine is running.
13039	</li>
13040	<li>
13041	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13042	VirtualBox GUI or VBoxHeadless), one would use
13043	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13044	as its first parameter. This session then identifies the caller and lets the
13045	caller control the started machine (for example, pause machine execution or
13046	power it down) as well as be notified about machine execution state changes.
13047	</li>
13048	</ul>
13049
13050	How sessions objects are created in a client process depends on whether you use
13051	the Main API via COM or via the webservice:
13052
13053	<ul>
13054	<li>When using the COM API directly, an object of the Session class from the
13055	VirtualBox type library needs to be created. In regular COM C++ client code,
13056	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13057	This object will then act as a local session object in further calls to open
13058	a session.
13059	</li>
13060
13061	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13062	a session object automatically whenever <link to="IWebsessionManager::logon" />
13063	is called. A managed object reference to that session object can be retrieved by
13064	calling <link to="IWebsessionManager::getSessionObject" />.
13065	</li>
13066	</ul>
13067	</desc>
13068
13069	<attribute name="state" type="SessionState" readonly="yes">
13070	<desc>Current state of this session.</desc>
13071	</attribute>
13072
13073	<attribute name="type" type="SessionType" readonly="yes">
13074	<desc>
13075	Type of this session. The value of this attribute is valid only
13076	if the session currently has a machine locked (i.e. its
13077	<link to="#state" /> is Locked), otherwise an error will be returned.
13078	</desc>
13079	</attribute>
13080
13081	<attribute name="machine" type="IMachine" readonly="yes">
13082	<desc>Machine object associated with this session.</desc>
13083	</attribute>
13084
13085	<attribute name="console" type="IConsole" readonly="yes">
13086	<desc>Console object associated with this session.</desc>
13087	</attribute>
13088
13089	<method name="unlockMachine">
13090	<desc>
13091	Unlocks a machine that was previously locked for the current session.
13092
13093	Calling this method is required every time a machine has been locked
13094	for a particular session using the <link to="IMachine::launchVMProcess" />
13095	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13096	the machine will be set to <link to="MachineState_Aborted" /> on the
13097	server, and changes made to the machine settings will be lost.
13098
13099	Generally, it is recommended to unlock all machines explicitly
13100	before terminating the application (regardless of the reason for
13101	the termination).
13102
13103	<note>
13104	Do not expect the session state (<link to="ISession::state" />
13105	to return to "Unlocked" immediately after you invoke this method,
13106	particularly if you have started a new VM process. The session
13107	state will automatically return to "Unlocked" once the VM is no
13108	longer executing, which can of course take a very long time.
13109	</note>
13110
13111	<result name="E_UNEXPECTED">
13112	Session is not locked.
13113	</result>
13114
13115	</desc>
13116	</method>
13117
13118	</interface>
13119
13120	<!--
13121	// IStorageController
13122	/////////////////////////////////////////////////////////////////////////
13123	-->
13124
13125	<enum
13126	name="StorageBus"
13127	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13128	>
13129	<desc>
13130	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13131	see <link to="IStorageController::bus" />.
13132	</desc>
13133	<const name="Null" value="0">
13134	<desc>@c null value. Never used by the API.</desc>
13135	</const>
13136	<const name="IDE" value="1"/>
13137	<const name="SATA" value="2"/>
13138	<const name="SCSI" value="3"/>
13139	<const name="Floppy" value="4"/>
13140	<const name="SAS" value="5"/>
13141	</enum>
13142
13143	<enum
13144	name="StorageControllerType"
13145	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13146	>
13147	<desc>
13148	The exact variant of storage controller hardware presented
13149	to the guest; see <link to="IStorageController::controllerType" />.
13150	</desc>
13151
13152	<const name="Null" value="0">
13153	<desc>@c null value. Never used by the API.</desc>
13154	</const>
13155	<const name="LsiLogic" value="1">
13156	<desc>A SCSI controller of the LsiLogic variant.</desc>
13157	</const>
13158	<const name="BusLogic" value="2">
13159	<desc>A SCSI controller of the BusLogic variant.</desc>
13160	</const>
13161	<const name="IntelAhci" value="3">
13162	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13163	</const>
13164	<const name="PIIX3" value="4">
13165	<desc>An IDE controller of the PIIX3 variant.</desc>
13166	</const>
13167	<const name="PIIX4" value="5">
13168	<desc>An IDE controller of the PIIX4 variant.</desc>
13169	</const>
13170	<const name="ICH6" value="6">
13171	<desc>An IDE controller of the ICH6 variant.</desc>
13172	</const>
13173	<const name="I82078" value="7">
13174	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13175	</const>
13176	<const name="LsiLogicSas" value="8">
13177	<desc>A variant of the LsiLogic controller using SAS.</desc>
13178	</const>
13179	</enum>
13180
13181	<enum
13182	name="ChipsetType"
13183	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13184	>
13185	<desc>
13186	Type of emulated chipset (mostly southbridge).
13187	</desc>
13188
13189	<const name="Null" value="0">
13190	<desc>@c null value. Never used by the API.</desc>
13191	</const>
13192	<const name="PIIX3" value="1">
13193	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13194	</const>
13195	<const name="ICH9" value="2">
13196	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13197	</const>
13198	</enum>
13199
13200	<interface
13201	name="IStorageController" extends="$unknown"
13202	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13203	wsmap="managed"
13204	>
13205	<desc>
13206	Represents a storage controller that is attached to a virtual machine
13207	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13208	attached to storage controllers in a real computer, virtual drives
13209	(represented by <link to="IMediumAttachment" />) are attached to virtual
13210	storage controllers, represented by this interface.
13211
13212	As opposed to physical hardware, VirtualBox has a very generic concept
13213	of a storage controller, and for purposes of the Main API, all virtual
13214	storage is attached to virtual machines via instances of this interface.
13215	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13216	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13217	is used, certain sub-types may be available and can be selected in
13218	<link to="#controllerType" />.
13219
13220	Depending on these settings, the guest operating system might see
13221	significantly different virtual hardware.
13222	</desc>
13223
13224	<attribute name="name" type="wstring" readonly="yes">
13225	<desc>
13226	Name of the storage controller, as originally specified with
13227	<link to="IMachine::addStorageController" />. This then uniquely
13228	identifies this controller with other method calls such as
13229	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13230	</desc>
13231	</attribute>
13232
13233	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13234	<desc>
13235	Maximum number of devices which can be attached to one port.
13236	</desc>
13237	</attribute>
13238
13239	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13240	<desc>
13241	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13242	</desc>
13243	</attribute>
13244
13245	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13246	<desc>
13247	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13248	</desc>
13249	</attribute>
13250
13251	<attribute name="instance" type="unsigned long">
13252	<desc>
13253	The instance number of the device in the running VM.
13254	</desc>
13255	</attribute>
13256
13257	<attribute name="portCount" type="unsigned long">
13258	<desc>
13259	The number of currently usable ports on the controller.
13260	The minimum and maximum number of ports for one controller are
13261	stored in <link to="IStorageController::minPortCount"/>
13262	and <link to="IStorageController::maxPortCount"/>.
13263	</desc>
13264	</attribute>
13265
13266	<attribute name="bus" type="StorageBus" readonly="yes">
13267	<desc>
13268	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13269	</desc>
13270	</attribute>
13271
13272	<attribute name="controllerType" type="StorageControllerType">
13273	<desc>
13274	The exact variant of storage controller hardware presented
13275	to the guest.
13276	Depending on this value, VirtualBox will provide a different
13277	virtual storage controller hardware to the guest.
13278	For SATA, SAS and floppy controllers, only one variant is
13279	available, but for IDE and SCSI, there are several.
13280
13281	For SCSI controllers, the default type is LsiLogic.
13282	</desc>
13283	</attribute>
13284
13285	<attribute name="useHostIOCache" type="boolean">
13286	<desc>
13287	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13288	caches and use synchronous file APIs on the host. This was the only option in the API before
13289	VirtualBox 3.2 and is still the default for IDE controllers.
13290
13291	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13292	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13293	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13294	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13295	virtual machines are running at the same time to prevent I/O cache related hangs.
13296	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13297	</desc>
13298	</attribute>
13299
13300	<method name="getIDEEmulationPort">
13301	<desc>
13302	Gets the corresponding port number which is emulated as an IDE device.
13303	Works only with SATA controllers.
13304
13305	<result name="E_INVALIDARG">
13306	The @a devicePosition is not in the range 0 to 3.
13307	</result>
13308	<result name="E_NOTIMPL">
13309	The storage controller type is not SATAIntelAhci.
13310	</result>
13311
13312	</desc>
13313	<param name="devicePosition" type="long" dir="in"/>
13314	<param name="portNumber" type="long" dir="return"/>
13315	</method>
13316
13317	<method name="setIDEEmulationPort">
13318	<desc>
13319	Sets the port number which is emulated as an IDE device.
13320	Works only with SATA controllers.
13321
13322	<result name="E_INVALIDARG">
13323	The @a devicePosition is not in the range 0 to 3 or the
13324	@a portNumber is not in the range 0 to 29.
13325	</result>
13326	<result name="E_NOTIMPL">
13327	The storage controller type is not SATAIntelAhci.
13328	</result>
13329
13330	</desc>
13331	<param name="devicePosition" type="long" dir="in"/>
13332	<param name="portNumber" type="long" dir="in"/>
13333	</method>
13334
13335	</interface>
13336
13337	<if target="wsdl">
13338
13339	<!--
13340	// IManagedObjectRef
13341	/////////////////////////////////////////////////////////////////////////
13342	-->
13343
13344	<interface
13345	name="IManagedObjectRef" extends="$unknown"
13346	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13347	internal="yes"
13348	wsmap="managed"
13349	wscpp="hardcoded"
13350	>
13351	<desc>
13352	Managed object reference.
13353
13354	Only within the webservice, a managed object reference (which is really
13355	an opaque number) allows a webservice client to address an object
13356	that lives in the address space of the webservice server.
13357
13358	Behind each managed object reference, there is a COM object that lives
13359	in the webservice server's address space. The COM object is not freed
13360	until the managed object reference is released, either by an explicit
13361	call to <link to="IManagedObjectRef::release" /> or by logging off from
13362	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13363	all objects created during the webservice session.
13364
13365	Whenever a method call of the VirtualBox API returns a COM object, the
13366	webservice representation of that method will instead return a
13367	managed object reference, which can then be used to invoke methods
13368	on that object.
13369	</desc>
13370
13371	<method name="getInterfaceName">
13372	<desc>
13373	Returns the name of the interface that this managed object represents,
13374	for example, "IMachine", as a string.
13375	</desc>
13376	<param name="return" type="wstring" dir="return"/>
13377	</method>
13378
13379	<method name="release">
13380	<desc>
13381	Releases this managed object reference and frees the resources that
13382	were allocated for it in the webservice server process. After calling
13383	this method, the identifier of the reference can no longer be used.
13384	</desc>
13385	</method>
13386
13387	</interface>
13388
13389	<!--
13390	// IWebsessionManager
13391	/////////////////////////////////////////////////////////////////////////
13392	-->
13393
13394	<interface
13395	name="IWebsessionManager" extends="$unknown"
13396	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13397	internal="yes"
13398	wsmap="global"
13399	wscpp="hardcoded"
13400	>
13401	<desc>
13402	Websession manager. This provides essential services
13403	to webservice clients.
13404	</desc>
13405	<method name="logon">
13406	<desc>
13407	Logs a new client onto the webservice and returns a managed object reference to
13408	the IVirtualBox instance, which the client can then use as a basis to further
13409	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13410	interface, in one way or the other.
13411	</desc>
13412	<param name="username" type="wstring" dir="in"/>
13413	<param name="password" type="wstring" dir="in"/>
13414	<param name="return" type="IVirtualBox" dir="return"/>
13415	</method>
13416
13417	<method name="getSessionObject">
13418	<desc>
13419	Returns a managed object reference to the internal ISession object that was created
13420	for this web service session when the client logged on.
13421
13422	<see>ISession</see>
13423	</desc>
13424	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13425	<param name="return" type="ISession" dir="return"/>
13426	</method>
13427
13428	<method name="logoff">
13429	<desc>
13430	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13431	and destroys all resources associated with the session (most importantly, all
13432	managed objects created in the server while the session was active).
13433	</desc>
13434	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13435	</method>
13436
13437	</interface>
13438
13439	</if>
13440
13441	<!--
13442	// IPerformanceCollector & friends
13443	/////////////////////////////////////////////////////////////////////////
13444	-->
13445
13446	<interface
13447	name="IPerformanceMetric" extends="$unknown"
13448	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13449	>
13450	<desc>
13451	The IPerformanceMetric interface represents parameters of the given
13452	performance metric.
13453	</desc>
13454
13455	<attribute name="metricName" type="wstring" readonly="yes">
13456	<desc>
13457	Name of the metric.
13458	</desc>
13459	</attribute>
13460
13461	<attribute name="object" type="$unknown" readonly="yes">
13462	<desc>
13463	Object this metric belongs to.
13464	</desc>
13465	</attribute>
13466
13467	<attribute name="description" type="wstring" readonly="yes">
13468	<desc>
13469	Textual description of the metric.
13470	</desc>
13471	</attribute>
13472
13473	<attribute name="period" type="unsigned long" readonly="yes">
13474	<desc>
13475	Time interval between samples, measured in seconds.
13476	</desc>
13477	</attribute>
13478
13479	<attribute name="count" type="unsigned long" readonly="yes">
13480	<desc>
13481	Number of recent samples retained by the performance collector for this
13482	metric.
13483
13484	When the collected sample count exceeds this number, older samples
13485	are discarded.
13486	</desc>
13487	</attribute>
13488
13489	<attribute name="unit" type="wstring" readonly="yes">
13490	<desc>
13491	Unit of measurement.
13492	</desc>
13493	</attribute>
13494
13495	<attribute name="minimumValue" type="long" readonly="yes">
13496	<desc>
13497	Minimum possible value of this metric.
13498	</desc>
13499	</attribute>
13500
13501	<attribute name="maximumValue" type="long" readonly="yes">
13502	<desc>
13503	Maximum possible value of this metric.
13504	</desc>
13505	</attribute>
13506	</interface>
13507
13508	<interface
13509	name="IPerformanceCollector" extends="$unknown"
13510	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13511	wsmap="managed"
13512	>
13513	<desc>
13514	The IPerformanceCollector interface represents a service that collects
13515	and stores performance metrics data.
13516
13517	Performance metrics are associated with objects of interfaces like IHost
13518	and IMachine. Each object has a distinct set of performance metrics. The
13519	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13520
13521	Metric data is collected at the specified intervals and is retained
13522	internally. The interval and the number of retained samples can be set
13523	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13524	and collection settings are not persistent, they are discarded as soon as
13525	VBoxSVC process terminates. Moreover, metric settings and data associated
13526	with a particular VM only exist while VM is running. They disappear as
13527	soon as VM shuts down. It is not possible to set up metrics for machines
13528	that are powered off. One needs to start VM first, then set up metric
13529	collection parameters.
13530
13531	Metrics are organized hierarchically, with each level separated by a
13532	slash (/) character. Generally, the scheme for metric names is like this:
13533
13534	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13535
13536	"Category/Metric" together form the base metric name. A base metric is
13537	the smallest unit for which a sampling interval and the number of
13538	retained samples can be set. Only base metrics can be enabled and
13539	disabled. All sub-metrics are collected when their base metric is
13540	collected. Collected values for any set of sub-metrics can be queried
13541	with <link to="IPerformanceCollector::queryMetricsData" />.
13542
13543	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13544	category, "Load" metric, "User" submetric, "average" aggregate. An
13545	aggregate function is computed over all retained data. Valid aggregate
13546	functions are:
13547
13548	<ul>
13549	<li>avg -- average</li>
13550	<li>min -- minimum</li>
13551	<li>max -- maximum</li>
13552	</ul>
13553
13554	When setting up metric parameters, querying metric data, enabling or
13555	disabling metrics wildcards can be used in metric names to specify a
13556	subset of metrics. For example, to select all CPU-related metrics
13557	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13558	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13559
13560	The valid names for base metrics are:
13561
13562	<ul>
13563	<li>CPU/Load</li>
13564	<li>CPU/MHz</li>
13565	<li>RAM/Usage</li>
13566	</ul>
13567
13568	The general sequence for collecting and retrieving the metrics is:
13569	<ul>
13570	<li>
13571	Obtain an instance of IPerformanceCollector with
13572	<link to="IVirtualBox::performanceCollector" />
13573	</li>
13574	<li>
13575	Allocate and populate an array with references to objects the metrics
13576	will be collected for. Use references to IHost and IMachine objects.
13577	</li>
13578	<li>
13579	Allocate and populate an array with base metric names the data will
13580	be collected for.
13581	</li>
13582	<li>
13583	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13584	the metric data will be collected and stored.
13585	</li>
13586	<li>
13587	Wait for the data to get collected.
13588	</li>
13589	<li>
13590	Allocate and populate an array with references to objects the metric
13591	values will be queried for. You can re-use the object array used for
13592	setting base metrics.
13593	</li>
13594	<li>
13595	Allocate and populate an array with metric names the data will be
13596	collected for. Note that metric names differ from base metric names.
13597	</li>
13598	<li>
13599	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13600	that have been collected so far are returned. Note that the values
13601	are still retained internally and data collection continues.
13602	</li>
13603	</ul>
13604
13605	For an example of usage refer to the following files in VirtualBox SDK:
13606	<ul>
13607	<li>
13608	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13609	</li>
13610	<li>
13611	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13612	</li>
13613	</ul>
13614	</desc>
13615
13616	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13617	<desc>
13618	Array of unique names of metrics.
13619
13620	This array represents all metrics supported by the performance
13621	collector. Individual objects do not necessarily support all of them.
13622	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13623	list of supported metrics for a particular object.
13624	</desc>
13625	</attribute>
13626
13627	<method name="getMetrics">
13628	<desc>
13629	Returns parameters of specified metrics for a set of objects.
13630	<note>
13631	@c Null metrics array means all metrics. @c Null object array means
13632	all existing objects.
13633	</note>
13634	</desc>
13635	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13636	<desc>
13637	Metric name filter. Currently, only a comma-separated list of metrics
13638	is supported.
13639	</desc>
13640	</param>
13641	<param name="objects" type="$unknown" dir="in" safearray="yes">
13642	<desc>
13643	Set of objects to return metric parameters for.
13644	</desc>
13645	</param>
13646	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13647	<desc>
13648	Array of returned metric parameters.
13649	</desc>
13650	</param>
13651	</method>
13652
13653	<method name="setupMetrics">
13654	<desc>
13655	Sets parameters of specified base metrics for a set of objects. Returns
13656	an array of <link to="IPerformanceMetric" /> describing the metrics
13657	have been affected.
13658	<note>
13659	@c Null or empty metric name array means all metrics. @c Null or
13660	empty object array means all existing objects. If metric name array
13661	contains a single element and object array contains many, the single
13662	metric name array element is applied to each object array element to
13663	form metric/object pairs.
13664	</note>
13665	</desc>
13666	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13667	<desc>
13668	Metric name filter. Comma-separated list of metrics with wildcard
13669	support.
13670	</desc>
13671	</param>
13672	<param name="objects" type="$unknown" dir="in" safearray="yes">
13673	<desc>
13674	Set of objects to setup metric parameters for.
13675	</desc>
13676	</param>
13677	<param name="period" type="unsigned long" dir="in">
13678	<desc>
13679	Time interval in seconds between two consecutive samples of
13680	performance data.
13681	</desc>
13682	</param>
13683	<param name="count" type="unsigned long" dir="in">
13684	<desc>
13685	Number of samples to retain in performance data history. Older
13686	samples get discarded.
13687	</desc>
13688	</param>
13689	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13690	<desc>
13691	Array of metrics that have been modified by the call to this method.
13692	</desc>
13693	</param>
13694	</method>
13695
13696	<method name="enableMetrics">
13697	<desc>
13698	Turns on collecting specified base metrics. Returns an array of
13699	<link to="IPerformanceMetric" /> describing the metrics have been
13700	affected.
13701	<note>
13702	@c Null or empty metric name array means all metrics. @c Null or
13703	empty object array means all existing objects. If metric name array
13704	contains a single element and object array contains many, the single
13705	metric name array element is applied to each object array element to
13706	form metric/object pairs.
13707	</note>
13708	</desc>
13709	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13710	<desc>
13711	Metric name filter. Comma-separated list of metrics with wildcard
13712	support.
13713	</desc>
13714	</param>
13715	<param name="objects" type="$unknown" dir="in" safearray="yes">
13716	<desc>
13717	Set of objects to enable metrics for.
13718	</desc>
13719	</param>
13720	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13721	<desc>
13722	Array of metrics that have been modified by the call to this method.
13723	</desc>
13724	</param>
13725	</method>
13726
13727	<method name="disableMetrics">
13728	<desc>
13729	Turns off collecting specified base metrics. Returns an array of
13730	<link to="IPerformanceMetric" /> describing the metrics have been
13731	affected.
13732	<note>
13733	@c Null or empty metric name array means all metrics. @c Null or
13734	empty object array means all existing objects. If metric name array
13735	contains a single element and object array contains many, the single
13736	metric name array element is applied to each object array element to
13737	form metric/object pairs.
13738	</note>
13739	</desc>
13740	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13741	<desc>
13742	Metric name filter. Comma-separated list of metrics with wildcard
13743	support.
13744	</desc>
13745	</param>
13746	<param name="objects" type="$unknown" dir="in" safearray="yes">
13747	<desc>
13748	Set of objects to disable metrics for.
13749	</desc>
13750	</param>
13751	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13752	<desc>
13753	Array of metrics that have been modified by the call to this method.
13754	</desc>
13755	</param>
13756	</method>
13757
13758	<method name="queryMetricsData">
13759	<desc>
13760	Queries collected metrics data for a set of objects.
13761
13762	The data itself and related metric information are returned in seven
13763	parallel and one flattened array of arrays. Elements of
13764	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13765	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13766	the same index describe one set of values corresponding to a single
13767	metric.
13768
13769	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13770	start and length of a sub-array is indicated by
13771	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13772	value for metric <tt>metricNames[i]</tt> is at
13773	<tt>returnData[returnIndices[i]]</tt>.
13774
13775	<note>
13776	@c Null or empty metric name array means all metrics. @c Null or
13777	empty object array means all existing objects. If metric name array
13778	contains a single element and object array contains many, the single
13779	metric name array element is applied to each object array element to
13780	form metric/object pairs.
13781	</note>
13782	<note>
13783	Data collection continues behind the scenes after call to @c
13784	queryMetricsData. The return data can be seen as the snapshot of the
13785	current state at the time of @c queryMetricsData call. The internally
13786	kept metric values are not cleared by the call. This makes possible
13787	querying different subsets of metrics or aggregates with subsequent
13788	calls. If periodic querying is needed it is highly suggested to query
13789	the values with @c interval*count period to avoid confusion. This way
13790	a completely new set of data values will be provided by each query.
13791	</note>
13792	</desc>
13793	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13794	<desc>
13795	Metric name filter. Comma-separated list of metrics with wildcard
13796	support.
13797	</desc>
13798	</param>
13799	<param name="objects" type="$unknown" dir="in" safearray="yes">
13800	<desc>
13801	Set of objects to query metrics for.
13802	</desc>
13803	</param>
13804	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13805	<desc>
13806	Names of metrics returned in @c returnData.
13807	</desc>
13808	</param>
13809	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13810	<desc>
13811	Objects associated with metrics returned in @c returnData.
13812	</desc>
13813	</param>
13814	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13815	<desc>
13816	Units of measurement for each returned metric.
13817	</desc>
13818	</param>
13819	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13820	<desc>
13821	Divisor that should be applied to return values in order to get
13822	floating point values. For example:
13823	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13824	will retrieve the floating point value of i-th sample of the first
13825	metric.
13826	</desc>
13827	</param>
13828	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13829	<desc>
13830	Sequence numbers of the first elements of value sequences of
13831	particular metrics returned in @c returnData. For aggregate metrics
13832	it is the sequence number of the sample the aggregate started
13833	calculation from.
13834	</desc>
13835	</param>
13836	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13837	<desc>
13838	Indices of the first elements of value sequences of particular
13839	metrics returned in @c returnData.
13840	</desc>
13841	</param>
13842	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13843	<desc>
13844	Lengths of value sequences of particular metrics.
13845	</desc>
13846	</param>
13847	<param name="returnData" type="long" dir="return" safearray="yes">
13848	<desc>
13849	Flattened array of all metric data containing sequences of values for
13850	each metric.
13851	</desc>
13852	</param>
13853	</method>
13854
13855	</interface>
13856	<enum
13857	name="NATAliasMode"
13858	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13859	<desc></desc>
13860	<const name="AliasLog" value="0x1">
13861	<desc></desc>
13862	</const>
13863	<const name="AliasProxyOnly" value="0x02">
13864	<desc></desc>
13865	</const>
13866	<const name="AliasUseSamePorts" value="0x04">
13867	<desc></desc>
13868	</const>
13869	</enum>
13870	<enum
13871	name="NATProtocol"
13872	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13873	>
13874	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13875	<const name="UDP" value="0">
13876	<desc>Port-forwarding uses UDP protocol.</desc>
13877	</const>
13878	<const name="TCP" value="1">
13879	<desc>Port-forwarding uses TCP protocol.</desc>
13880	</const>
13881	</enum>
13882
13883	<interface
13884	name="INATEngine" extends="$unknown"
13885	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13886	wsmap="managed"
13887	>
13888	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13889	allows for changing NAT behavior such as port-forwarding rules. This interface is
13890	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13891	<attribute name="network" type="wstring">
13892	<desc>The network attribute of the NAT engine (the same value is used with built-in
13893	DHCP server to fill corresponding fields of DHCP leases).</desc>
13894	</attribute>
13895	<attribute name="hostIP" type="wstring">
13896	<desc>IP of host interface to bind all opened sockets to.
13897	<note>Changing this does not change binding of port forwarding.</note>
13898	</desc>
13899	</attribute>
13900	<attribute name="tftpPrefix" type="wstring">
13901	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13902	the corresponding fields of DHCP leases.</desc>
13903	</attribute>
13904	<attribute name="tftpBootFile" type="wstring">
13905	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13906	the corresponding fields of DHCP leases.</desc>
13907	</attribute>
13908	<attribute name="tftpNextServer" type="wstring">
13909	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13910	the corresponding fields of DHCP leases.
13911	<note>The preferred form is IPv4 addresses.</note>
13912	</desc>
13913	</attribute>
13914	<attribute name="aliasMode" type="unsigned long">
13915	<desc></desc>
13916	</attribute>
13917	<attribute name="dnsPassDomain" type="boolean">
13918	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13919	</attribute>
13920	<attribute name="dnsProxy" type="boolean">
13921	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13922	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13923	</attribute>
13924	<attribute name="dnsUseHostResolver" type="boolean">
13925	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13926	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13927	</attribute>
13928	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13929	<desc>Array of NAT port-forwarding rules in string representation, in the following
13930	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13931	</attribute>
13932	<method name="setNetworkSettings">
13933	<desc>Sets network configuration of the NAT engine.</desc>
13934	<param name="mtu" type="unsigned long" dir="in">
13935	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13936	</param>
13937	<param name="sockSnd" type="unsigned long" dir="in">
13938	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13939	</param>
13940	<param name="sockRcv" type="unsigned long" dir="in">
13941	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13942	</param>
13943	<param name="TcpWndSnd" type="unsigned long" dir="in">
13944	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13945	establishing a new TCP connection.</desc>
13946	</param>
13947	<param name="TcpWndRcv" type="unsigned long" dir="in">
13948	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13949	establishing a new TCP connection.</desc>
13950	</param>
13951	</method>
13952	<method name="getNetworkSettings">
13953	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13954	for parameter descriptions.</desc>
13955	<param name="mtu" type="unsigned long" dir="out" />
13956	<param name="sockSnd" type="unsigned long" dir="out" />
13957	<param name="sockRcv" type="unsigned long" dir="out" />
13958	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13959	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13960	</method>
13961	<method name="addRedirect">
13962	<desc>Adds a new NAT port-forwarding rule.</desc>
13963	<param name="name" type="wstring" dir="in">
13964	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13965	auto-generates one using the other parameters.</desc>
13966	</param>
13967	<param name="proto" type="NATProtocol" dir="in">
13968	<desc>Protocol handled with the rule.</desc>
13969	</param>
13970	<param name="hostIp" type="wstring" dir="in">
13971	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13972	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13973	</param>
13974	<param name="hostPort" type="unsigned short" dir="in">
13975	<desc>The port number to listen on.</desc>
13976	</param>
13977	<param name="guestIp" type="wstring" dir="in">
13978	<desc>The IP address of the guest which the NAT engine will forward matching packets
13979	to. An empty IP address is acceptable, in which case the NAT engine will forward
13980	packets to the first DHCP lease (x.x.x.15).</desc>
13981	</param>
13982	<param name="guestPort" type="unsigned short" dir="in">
13983	<desc>The port number to forward.</desc>
13984	</param>
13985	</method>
13986	<method name="removeRedirect">
13987	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13988	<param name="name" type="wstring" dir="in">
13989	<desc>The name of the rule to delete.</desc>
13990	</param>
13991	</method>
13992	</interface>
13993
13994	<!--
13995	// IExtPackManager
13996	/////////////////////////////////////////////////////////////////////////
13997	-->
13998
13999	<interface
14000	name="IExtPack" extends="$unknown"
14001	uuid="ab26b24e-d46c-4d09-aa44-e5092d2fe9ae"
14002	wsmap="suppress"
14003	>
14004	<desc>
14005	Interface for querying interfaces and information relating to an
14006	extension pack. The extension pack specific interfaces can be queried
14007	via the IUnknown::QueryInterface method.
14008	</desc>
14009	<attribute name="name" type="wstring" readonly="yes">
14010	<desc>The extension pack name. This is unique.</desc>
14011	</attribute>
14012	<attribute name="description" type="wstring" readonly="yes">
14013	<desc>The extension pack description.</desc>
14014	</attribute>
14015	<attribute name="version" type="wstring" readonly="yes">
14016	<desc>
14017	The extension pack version string. This is on the same form as
14018	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14019	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14020	or "1.2.3_BETA1-r45678-OSE"
14021	</desc>
14022	</attribute>
14023	<attribute name="revision" type="unsigned long" readonly="yes">
14024	<desc>The extension pack internal revision number.</desc>
14025	</attribute>
14026	<attribute name="usable" type="boolean" readonly="yes">
14027	<desc>
14028	Indicates whether the extension pack is usable or not. An
14029	extension pack that is not compatible with the current VirtualBox
14030	version will be flagged as not usable.
14031	</desc>
14032	</attribute>
14033	<attribute name="whyUnusable" type="wstring" readonly="yes">
14034	<desc>
14035	String indicating why the extension pack is not usable. This is an
14036	empty string if usable and always a non-empty string if not usable.
14037	</desc>
14038	</attribute>
14039	</interface>
14040
14041	<interface
14042	name="IExtPackManager" extends="$unknown"
14043	uuid="ba1fbfca-53f1-471c-b5a1-416386f0f52b"
14044	wsmap="suppress"
14045	>
14046	<desc>
14047	Interface for managing VirtualBox Extension Packs.
14048
14049	TODO: Describe extension packs, how they are managed and how to create
14050	one.
14051	</desc>
14052
14053	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14054	<desc>
14055	List of the installed extension packs.
14056	</desc>
14057	</attribute>
14058
14059	<method name="find">
14060	<desc>
14061	Returns the extension pack with the specified name if found.
14062
14063	<result name="VBOX_E_OBJECT_NOT_FOUND">
14064	No extension pack matching @a name was found.
14065	</result>
14066	</desc>
14067	<param name="name" type="wstring" dir="in">
14068	<desc>The name of the extension pack to locate.</desc>
14069	</param>
14070	<param name="returnData" type="IExtPack" dir="return">
14071	<desc>The extension pack if found.</desc>
14072	</param>
14073	</method>
14074
14075	<method name="install">
14076	<param name="path" type="wstring" dir="in">
14077	<desc>The path of the extension pack tarball.</desc>
14078	</param>
14079	<param name="name" type="wstring" dir="out">
14080	<desc>The name of the installed extension pack.</desc>
14081	</param>
14082	</method>
14083
14084	<method name="uninstall">
14085	<desc>Uninstalls an extension pack, removing all related files.</desc>
14086	<param name="name" type="wstring" dir="in">
14087	<desc>The name of the extension pack to uninstall.</desc>
14088	</param>
14089	<param name="forcedRemoval" type="boolean" dir="in">
14090	<desc>
14091	Forced removal of the extension pack. This means that the uninstall
14092	hook will not be called.
14093	</desc>
14094	</param>
14095	</method>
14096	</interface>
14097
14098	<!--
14099	// Events
14100	/////////////////////////////////////////////////////////////////////////
14101	-->
14102	<enum
14103	name="VBoxEventType"
14104	uuid="e085d0b1-05e6-4f40-a709-b7266fbdb236">
14105
14106	<desc>
14107	Type of an event.
14108	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14109	</desc>
14110
14111	<const name="Invalid" value="0">
14112	<desc>
14113	Invalid event, must be first.
14114	</desc>
14115	</const>
14116
14117	<const name="Any" value="1">
14118	<desc>
14119	Wildcard for all events.
14120	Events of this type are never delivered, and only used in
14121	registerListener() call to simplify registration.
14122	</desc>
14123	</const>
14124
14125	<const name="Vetoable" value="2">
14126	<desc>
14127	Wildcard for all vetoable events. Events of this type are never delivered, and only
14128	used in registerListener() call to simplify registration.
14129	</desc>
14130	</const>
14131
14132	<const name="MachineEvent" value="3">
14133	<desc>
14134	Wildcard for all machine events. Events of this type are never delivered, and only used in
14135	registerListener() call to simplify registration.
14136	</desc>
14137	</const>
14138
14139	<const name="SnapshotEvent" value="4">
14140	<desc>
14141	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14142	registerListener() call to simplify registration.
14143	</desc>
14144	</const>
14145
14146	<const name="InputEvent" value="5">
14147	<desc>
14148	Wildcard for all input device (keyboard, mouse) events.
14149	Events of this type are never delivered, and only used in
14150	registerListener() call to simplify registration.
14151	</desc>
14152	</const>
14153
14154	<const name="LastWildcard" value="31">
14155	<desc>
14156	Last wildcard.
14157	</desc>
14158	</const>
14159
14160	<const name="OnMachineStateChanged" value="32">
14161	<desc>
14162	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14163	</desc>
14164	</const>
14165	<const name="OnMachineDataChanged" value="33">
14166	<desc>
14167	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14168	</desc>
14169	</const>
14170	<const name="OnExtraDataChanged" value="34">
14171	<desc>
14172	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14173	</desc>
14174	</const>
14175	<const name="OnExtraDataCanChange" value="35">
14176	<desc>
14177	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14178	</desc>
14179	</const>
14180	<const name="OnMediumRegistered" value="36">
14181	<desc>
14182	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14183	</desc>
14184	</const>
14185	<const name="OnMachineRegistered" value="37">
14186	<desc>
14187	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14188	</desc>
14189	</const>
14190	<const name="OnSessionStateChanged" value="38">
14191	<desc>
14192	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14193	</desc>
14194	</const>
14195	<const name="OnSnapshotTaken" value="39">
14196	<desc>
14197	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14198	</desc>
14199	</const>
14200	<const name="OnSnapshotDeleted" value="40">
14201	<desc>
14202	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14203	</desc>
14204	</const>
14205	<const name="OnSnapshotChanged" value="41">
14206	<desc>
14207	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14208	</desc>
14209	</const>
14210	<const name="OnGuestPropertyChanged" value="42">
14211	<desc>
14212	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14213	</desc>
14214	</const>
14215	<!-- Console events -->
14216	<const name="OnMousePointerShapeChanged" value="43">
14217	<desc>
14218	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14219	</desc>
14220	</const>
14221	<const name="OnMouseCapabilityChanged" value="44">
14222	<desc>
14223	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14224	</desc>
14225	</const>
14226	<const name="OnKeyboardLedsChanged" value="45">
14227	<desc>
14228	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14229	</desc>
14230	</const>
14231	<const name="OnStateChanged" value="46">
14232	<desc>
14233	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14234	</desc>
14235	</const>
14236	<const name="OnAdditionsStateChanged" value="47">
14237	<desc>
14238	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14239	</desc>
14240	</const>
14241	<const name="OnNetworkAdapterChanged" value="48">
14242	<desc>
14243	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14244	</desc>
14245	</const>
14246	<const name="OnSerialPortChanged" value="49">
14247	<desc>
14248	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14249	</desc>
14250	</const>
14251	<const name="OnParallelPortChanged" value="50">
14252	<desc>
14253	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14254	</desc>
14255	</const>
14256	<const name="OnStorageControllerChanged" value="51">
14257	<desc>
14258	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14259	</desc>
14260	</const>
14261	<const name="OnMediumChanged" value="52">
14262	<desc>
14263	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14264	</desc>
14265	</const>
14266	<const name="OnVRDEServerChanged" value="53">
14267	<desc>
14268	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14269	</desc>
14270	</const>
14271	<const name="OnUSBControllerChanged" value="54">
14272	<desc>
14273	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14274	</desc>
14275	</const>
14276	<const name="OnUSBDeviceStateChanged" value="55">
14277	<desc>
14278	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14279	</desc>
14280	</const>
14281	<const name="OnSharedFolderChanged" value="56">
14282	<desc>
14283	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14284	</desc>
14285	</const>
14286	<const name="OnRuntimeError" value="57">
14287	<desc>
14288	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14289	</desc>
14290	</const>
14291	<const name="OnCanShowWindow" value="58">
14292	<desc>
14293	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14294	</desc>
14295	</const>
14296	<const name="OnShowWindow" value="59">
14297	<desc>
14298	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14299	</desc>
14300	</const>
14301	<const name="OnCPUChanged" value="60">
14302	<desc>
14303	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14304	</desc>
14305	</const>
14306	<const name="OnVRDEServerInfoChanged" value="61">
14307	<desc>
14308	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14309	</desc>
14310	</const>
14311	<const name="OnEventSourceChanged" value="62">
14312	<desc>
14313	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14314	</desc>
14315	</const>
14316	<const name="OnCPUExecutionCapChanged" value="63">
14317	<desc>
14318	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14319	</desc>
14320	</const>
14321	<const name="OnGuestKeyboardEvent" value="64">
14322	<desc>
14323	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14324	</desc>
14325	</const>
14326	<const name="OnGuestMouseEvent" value="65">
14327	<desc>
14328	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14329	</desc>
14330	</const>
14331	<!-- Last event marker -->
14332	<const name="Last" value="66">
14333	<desc>
14334	Must be last event, used for iterations and structures relying on numerical event values.
14335	</desc>
14336	</const>
14337
14338	</enum>
14339
14340	<interface
14341	name="IEventSource" extends="$unknown"
14342	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14343	wsmap="managed"
14344	>
14345	<desc>
14346	Event source. Generally, any object which could generate events can be an event source,
14347	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14348	an event source can work with listeners in either active or passive mode. In active mode it is up to
14349	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14350	event source keeps track of pending events for each listener and returns available events on demand.
14351
14352	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14353	</desc>
14354
14355	<method name="createListener">
14356	<desc>
14357	Creates a new listener object, useful for passive mode.
14358	</desc>
14359	<param name="listener" type="IEventListener" dir="return"/>
14360	</method>
14361
14362	<method name="createAggregator">
14363	<desc>
14364	Creates a aggregator event source, collecting events from multiple sources.
14365	This way single listener can listen for events coming from multiple sources,
14366	using single blocking getEvent() of this aggregator.
14367	</desc>
14368	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14369	<desc>
14370	Subordinate event source this one aggregatres.
14371	</desc>
14372	</param>
14373	<param name="result" type="IEventSource" dir="return"/>
14374	</method>
14375
14376	<method name="registerListener">
14377	<desc>
14378	Register an event listener.
14379
14380	<note>
14381	To avoid system overload, the VirtualBox server process checks if passive event
14382	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14383	current implementation, if more than 500 pending events are detected for a passive
14384	event listener, it is forcefully unregistered by the system, and further
14385	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14386	</note>
14387	</desc>
14388	<param name="listener" type="IEventListener" dir="in">
14389	<desc>Listener to register.</desc>
14390	</param>
14391	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14392	<desc>
14393	Event types listener is interested in. One can use wildcards like -
14394	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14395	than one event.
14396	</desc>
14397	</param>
14398	<param name="active" type="boolean" dir="in">
14399	<desc>
14400	Which mode this listener is operating in.
14401	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14402	In passive mode, an internal event queue is created for this this IEventListener.
14403	For each event coming in, it is added to queues for all interested registered passive
14404	listeners. It is then up to the external code to call the listener's
14405	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14406	external code must call <link to="#eventProcessed" />.
14407	</desc>
14408	</param>
14409	</method>
14410
14411	<method name="unregisterListener">
14412	<desc>
14413	Unregister an event listener. If listener is passive, and some waitable events are still
14414	in queue they are marked as processed automatically.
14415	</desc>
14416	<param name="listener" type="IEventListener" dir="in">
14417	<desc>Listener to unregister.</desc>
14418	</param>
14419	</method>
14420
14421	<method name="fireEvent">
14422	<desc>
14423	Fire an event for this source.
14424	</desc>
14425	<param name="event" type="IEvent" dir="in">
14426	<desc>Event to deliver.</desc>
14427	</param>
14428	<param name="timeout" type="long" dir="in">
14429	<desc>
14430	Maximum time to wait for event processing (if event is waitable), in ms;
14431	0 = no wait, -1 = indefinite wait.
14432	</desc>
14433	</param>
14434	<param name="result" type="boolean" dir="return">
14435	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14436	</param>
14437	</method>
14438
14439	<method name="getEvent">
14440	<desc>
14441	Get events from this peer's event queue (for passive mode). Calling this method
14442	regularly is required for passive event listeners to avoid system overload;
14443	see <link to="IEventSource::registerListener" /> for details.
14444
14445	<result name="VBOX_E_OBJECT_NOT_FOUND">
14446	Listener is not registered, or autounregistered.
14447	</result>
14448	</desc>
14449	<param name="listener" type="IEventListener" dir="in">
14450	<desc>Which listener to get data for.</desc>
14451	</param>
14452	<param name="timeout" type="long" dir="in">
14453	<desc>
14454	Maximum time to wait for events, in ms;
14455	0 = no wait, -1 = indefinite wait.
14456	</desc>
14457	</param>
14458	<param name="event" type="IEvent" dir="return">
14459	<desc>Event retrieved, or null if none available.</desc>
14460	</param>
14461	</method>
14462
14463	<method name="eventProcessed">
14464	<desc>
14465	Must be called for waitable events after a particular listener finished its
14466	event processing. When all listeners of a particular event have called this
14467	method, the system will then call <link to="IEvent::setProcessed" />.
14468	</desc>
14469	<param name="listener" type="IEventListener" dir="in">
14470	<desc>Which listener processed event.</desc>
14471	</param>
14472	<param name="event" type="IEvent" dir="in">
14473	<desc>Which event.</desc>
14474	</param>
14475	</method>
14476
14477	</interface>
14478
14479	<interface
14480	name="IEventListener" extends="$unknown"
14481	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14482	wsmap="managed"
14483	>
14484	<desc>
14485	Event listener. An event listener can work in either active or passive mode, depending on the way
14486	it was registered.
14487	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14488	</desc>
14489
14490	<method name="handleEvent">
14491	<desc>
14492	Handle event callback (called directly by IEventSource in active mode, or could be
14493	called by event processor thread in passive mode).
14494	</desc>
14495	<param name="event" type="IEvent" dir="in">
14496	<desc>Event available.</desc>
14497	</param>
14498	</method>
14499
14500	</interface>
14501
14502	<interface
14503	name="IEvent" extends="$unknown"
14504	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14505	wsmap="managed"
14506	>
14507	<desc>
14508	Abstract parent interface for VirtualBox events. Actual events will typically implement
14509	a more specific interface which derives from this (see below).
14510
14511	<b>Introduction to VirtualBox events</b>
14512
14513	Generally speaking, an event (represented by this interface) signals that something
14514	happened, while an event listener (see <link to="IEventListener" />) represents an
14515	entity that is interested in certain events. In order for this to work with
14516	unidirectional protocols (i.e. web services), the concepts of passive and active
14517	listener are used.
14518
14519	Event consumers can register themselves as listeners, providing an array of
14520	events they are interested in (see <link to="IEventSource::registerListener" />).
14521	When an event triggers, the listener is notified about the event. The exact
14522	mechanism of the notification depends on whether the listener was registered as
14523	an active or passive listener:
14524
14525	<ul>
14526	<li>An active listener is very similar to a callback: it is a function invoked
14527	by the API. As opposed to the callbacks that were used in the API before
14528	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
14529	</li>
14530
14531	<li>Passive listeners are somewhat trickier to implement, but do not require
14532	a client function to be callable, which is not an option with scripting
14533	languages or web service clients. Internally the <link to="IEventSource" />
14534	implementation maintains an event queue for each passive listener, and
14535	newly arrived events are put in this queue. When the listener calls
14536	<link to="IEventSource::getEvent"/>, first element from its internal event
14537	queue is returned. When the client completes processing of an event,
14538	the <link to="IEventSource::eventProcessed" /> function must be called,
14539	acknowledging that the event was processed. It supports implementing
14540	waitable events. On passive listener unregistration, all events from its
14541	queue are auto-acknowledged.
14542	</li>
14543	</ul>
14544
14545	Waitable events are useful in situations where the event generator wants to track
14546	delivery or a party wants to wait until all listeners have completed the event. A
14547	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14548	listeners might veto a certain action, and thus the event producer has to make
14549	sure that all listeners have processed the event and not vetoed before taking
14550	the action.
14551
14552	A given event may have both passive and active listeners at the same time.
14553
14554	<b>Using events</b>
14555
14556	Any VirtualBox object capable of producing externally visible events provides an
14557	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14558	This event source object is notified by VirtualBox once something has happened, so
14559	consumers may register event listeners with this event source. To register a listener,
14560	an object implementing the <link to="IEventListener" /> interface must be provided.
14561	For active listeners, such an object is typically created by the consumer, while for
14562	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14563	note that a listener created with @c createListener() must not be used as an active listener.
14564
14565	Once created, the listener must be registered to listen for the desired events
14566	(see <link to="IEventSource::registerListener" />), providing an array of
14567	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14568	event IDs or wildcards matching multiple event IDs.
14569
14570	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14571	called automatically when the event is triggered, while passive listeners have to call
14572	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14573	an event processing loop.
14574
14575	The IEvent interface is an abstract parent interface for all such VirtualBox events
14576	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14577	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14578	then cast to the appropriate specific interface using @c QueryInterface().
14579	</desc>
14580
14581	<attribute name="type" readonly="yes" type="VBoxEventType">
14582	<desc>
14583	Event type.
14584	</desc>
14585	</attribute>
14586
14587	<attribute name="source" readonly="yes" type="IEventSource">
14588	<desc>
14589	Source of this event.
14590	</desc>
14591	</attribute>
14592
14593	<attribute name="waitable" readonly="yes" type="boolean">
14594	<desc>
14595	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14596	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14597	as no additional overhead associated with waitability imposed.
14598	Waitable events are needed when one need to be able to wait for particular event processed,
14599	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14600	until all consumers confirmed events.
14601	</desc>
14602	</attribute>
14603
14604	<method name="setProcessed">
14605	<desc>
14606	Internal method called by the system when all listeners of a particular event have called
14607	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14608	</desc>
14609	</method>
14610
14611	<method name="waitProcessed">
14612	<desc>
14613	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14614	described semantics, for non-waitable returns true immediately.
14615	</desc>
14616	<param name="timeout" type="long" dir="in">
14617	<desc>
14618	Maximum time to wait for event processeing, in ms;
14619	0 = no wait, -1 = indefinite wait.
14620	</desc>
14621	</param>
14622	<param name="result" type="boolean" dir="return">
14623	<desc>If this event was processed before timeout.</desc>
14624	</param>
14625	</method>
14626	</interface>
14627
14628
14629	<interface
14630	name="IReusableEvent" extends="IEvent"
14631	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14632	wsmap="managed"
14633	>
14634	<desc>Base abstract interface for all reusable events.</desc>
14635
14636	<attribute name="generation" readonly="yes" type="unsigned long">
14637	<desc>Current generation of event, incremented on reuse.</desc>
14638	</attribute>
14639
14640	<method name="reuse">
14641	<desc>
14642	Marks an event as reused, increments 'generation', fields shall no
14643	longer be considered valid.
14644	</desc>
14645	</method>
14646	</interface>
14647
14648	<interface
14649	name="IMachineEvent" extends="IEvent"
14650	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14651	wsmap="managed" id="MachineEvent"
14652	>
14653	<desc>Base abstract interface for all machine events.</desc>
14654
14655	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14656	<desc>ID of the machine this event relates to.</desc>
14657	</attribute>
14658
14659	</interface>
14660
14661	<interface
14662	name="IMachineStateChangedEvent" extends="IMachineEvent"
14663	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14664	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14665	>
14666	<desc>Machine state change event.</desc>
14667
14668	<attribute name="state" readonly="yes" type="MachineState">
14669	<desc>New execution state.</desc>
14670	</attribute>
14671	</interface>
14672
14673	<interface
14674	name="IMachineDataChangedEvent" extends="IMachineEvent"
14675	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14676	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14677	>
14678	<desc>
14679	Any of the settings of the given machine has changed.
14680	</desc>
14681	</interface>
14682
14683	<interface
14684	name="IMediumRegisteredEvent" extends="IEvent"
14685	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14686	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14687	>
14688	<desc>
14689	The given medium was registered or unregistered
14690	within this VirtualBox installation.
14691	</desc>
14692
14693	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14694	<desc>ID of the medium this event relates to.</desc>
14695	</attribute>
14696
14697	<attribute name="mediumType" readonly="yes" type="DeviceType">
14698	<desc>Type of the medium this event relates to.</desc>
14699	</attribute>
14700
14701	<attribute name="registered" type="boolean" readonly="yes">
14702	<desc>
14703	If @c true, the medium was registered, otherwise it was
14704	unregistered.
14705	</desc>
14706	</attribute>
14707	</interface>
14708
14709	<interface
14710	name="IMachineRegisteredEvent" extends="IMachineEvent"
14711	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14712	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14713	>
14714	<desc>
14715	The given machine was registered or unregistered
14716	within this VirtualBox installation.
14717	</desc>
14718
14719	<attribute name="registered" type="boolean" readonly="yes">
14720	<desc>
14721	If @c true, the machine was registered, otherwise it was
14722	unregistered.
14723	</desc>
14724	</attribute>
14725	</interface>
14726
14727	<interface
14728	name="ISessionStateChangedEvent" extends="IMachineEvent"
14729	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14730	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14731	>
14732	<desc>
14733	The state of the session for the given machine was changed.
14734	<see>IMachine::sessionState</see>
14735	</desc>
14736
14737	<attribute name="state" type="SessionState" readonly="yes">
14738	<desc>
14739	New session state.
14740	</desc>
14741	</attribute>
14742	</interface>
14743
14744	<interface
14745	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14746	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14747	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14748	>
14749	<desc>
14750	Notification when a guest property has changed.
14751	</desc>
14752
14753	<attribute name="name" readonly="yes" type="wstring">
14754	<desc>
14755	The name of the property that has changed.
14756	</desc>
14757	</attribute>
14758
14759	<attribute name="value" readonly="yes" type="wstring">
14760	<desc>
14761	The new property value.
14762	</desc>
14763	</attribute>
14764
14765	<attribute name="flags" readonly="yes" type="wstring">
14766	<desc>
14767	The new property flags.
14768	</desc>
14769	</attribute>
14770
14771	</interface>
14772
14773	<interface
14774	name="ISnapshotEvent" extends="IMachineEvent"
14775	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14776	wsmap="managed" id="SnapshotEvent"
14777	>
14778	<desc>Base interface for all snapshot events.</desc>
14779
14780	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14781	<desc>ID of the snapshot this event relates to.</desc>
14782	</attribute>
14783
14784	</interface>
14785
14786	<interface
14787	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14788	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14789	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14790	>
14791	<desc>
14792	A new snapshot of the machine has been taken.
14793	<see>ISnapshot</see>
14794	</desc>
14795	</interface>
14796
14797	<interface
14798	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14799	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14800	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14801	>
14802	<desc>
14803	Snapshot of the given machine has been deleted.
14804
14805	<note>
14806	This notification is delivered <b>after</b> the snapshot
14807	object has been uninitialized on the server (so that any
14808	attempt to call its methods will return an error).
14809	</note>
14810
14811	<see>ISnapshot</see>
14812	</desc>
14813	</interface>
14814
14815	<interface
14816	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14817	uuid="07541941-8079-447a-a33e-47a69c7980db"
14818	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14819	>
14820	<desc>
14821	Snapshot properties (name and/or description) have been changed.
14822	<see>ISnapshot</see>
14823	</desc>
14824	</interface>
14825
14826	<interface
14827	name="IMousePointerShapeChangedEvent" extends="IEvent"
14828	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14829	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14830	>
14831	<desc>
14832	Notification when the guest mouse pointer shape has
14833	changed. The new shape data is given.
14834	</desc>
14835
14836	<attribute name="visible" type="boolean" readonly="yes">
14837	<desc>
14838	Flag whether the pointer is visible.
14839	</desc>
14840	</attribute>
14841	<attribute name="alpha" type="boolean" readonly="yes">
14842	<desc>
14843	Flag whether the pointer has an alpha channel.
14844	</desc>
14845	</attribute>
14846	<attribute name="xhot" type="unsigned long" readonly="yes">
14847	<desc>
14848	The pointer hot spot X coordinate.
14849	</desc>
14850	</attribute>
14851	<attribute name="yhot" type="unsigned long" readonly="yes">
14852	<desc>
14853	The pointer hot spot Y coordinate.
14854	</desc>
14855	</attribute>
14856	<attribute name="width" type="unsigned long" readonly="yes">
14857	<desc>
14858	Width of the pointer shape in pixels.
14859	</desc>
14860	</attribute>
14861	<attribute name="height" type="unsigned long" readonly="yes">
14862	<desc>
14863	Height of the pointer shape in pixels.
14864	</desc>
14865	</attribute>
14866	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14867	<desc>
14868	Shape buffer arrays.
14869
14870	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14871	followed by a 32-bpp XOR (color) mask.
14872
14873	For pointers without alpha channel the XOR mask pixels are 32
14874	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14875	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14876
14877	An AND mask is used for pointers with alpha channel, so if the
14878	callback does not support alpha, the pointer could be
14879	displayed as a normal color pointer.
14880
14881	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14882	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14883	height</tt>. The padding bits at the end of each scanline are
14884	undefined.
14885
14886	The XOR mask follows the AND mask on the next 4-byte aligned
14887	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14888	Bytes in the gap between the AND and the XOR mask are undefined.
14889	The XOR mask scanlines have no gap between them and the size of
14890	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14891
14892	<note>
14893	If @a shape is 0, only the pointer visibility is changed.
14894	</note>
14895	</desc>
14896	</attribute>
14897	</interface>
14898
14899	<interface
14900	name="IMouseCapabilityChangedEvent" extends="IEvent"
14901	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14902	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14903	>
14904	<desc>
14905	Notification when the mouse capabilities reported by the
14906	guest have changed. The new capabilities are passed.
14907	</desc>
14908	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14909	<desc>
14910	Supports absolute coordinates.
14911	</desc>
14912	</attribute>
14913	<attribute name="supportsRelative" type="boolean" readonly="yes">
14914	<desc>
14915	Supports relative coordinates.
14916	</desc>
14917	</attribute>
14918	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14919	<desc>
14920	If host cursor is needed.
14921	</desc>
14922	</attribute>
14923	</interface>
14924
14925	<interface
14926	name="IKeyboardLedsChangedEvent" extends="IEvent"
14927	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14928	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14929	>
14930	<desc>
14931	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14932	to alter the state of the keyboard LEDs.
14933	</desc>
14934	<attribute name="numLock" type="boolean" readonly="yes">
14935	<desc>
14936	NumLock status.
14937	</desc>
14938	</attribute>
14939	<attribute name="capsLock" type="boolean" readonly="yes">
14940	<desc>
14941	CapsLock status.
14942	</desc>
14943	</attribute>
14944	<attribute name="scrollLock" type="boolean" readonly="yes">
14945	<desc>
14946	ScrollLock status.
14947	</desc>
14948	</attribute>
14949	</interface>
14950
14951	<interface
14952	name="IStateChangedEvent" extends="IEvent"
14953	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14954	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14955	>
14956	<desc>
14957	Notification when the execution state of the machine has changed.
14958	The new state is given.
14959	</desc>
14960	<attribute name="state" type="MachineState" readonly="yes">
14961	<desc>
14962	New machine state.
14963	</desc>
14964	</attribute>
14965	</interface>
14966
14967	<interface
14968	name="IAdditionsStateChangedEvent" extends="IEvent"
14969	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14970	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14971	>
14972	<desc>
14973	Notification when a Guest Additions property changes.
14974	Interested callees should query IGuest attributes to
14975	find out what has changed.
14976	</desc>
14977	</interface>
14978
14979	<interface
14980	name="INetworkAdapterChangedEvent" extends="IEvent"
14981	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14982	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14983	>
14984	<desc>
14985	Notification when a property of one of the
14986	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14987	changes. Interested callees should use INetworkAdapter methods and
14988	attributes to find out what has changed.
14989	</desc>
14990	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14991	<desc>
14992	Network adapter that is subject to change.
14993	</desc>
14994	</attribute>
14995	</interface>
14996
14997	<interface
14998	name="ISerialPortChangedEvent" extends="IEvent"
14999	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
15000	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
15001	>
15002	<desc>
15003	Notification when a property of one of the
15004	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
15005	Interested callees should use ISerialPort methods and attributes
15006	to find out what has changed.
15007	</desc>
15008	<attribute name="serialPort" type="ISerialPort" readonly="yes">
15009	<desc>
15010	Serial port that is subject to change.
15011	</desc>
15012	</attribute>
15013	</interface>
15014
15015	<interface
15016	name="IParallelPortChangedEvent" extends="IEvent"
15017	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15018	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15019	>
15020	<desc>
15021	Notification when a property of one of the
15022	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15023	changes. Interested callees should use ISerialPort methods and
15024	attributes to find out what has changed.
15025	</desc>
15026	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15027	<desc>
15028	Parallel port that is subject to change.
15029	</desc>
15030	</attribute>
15031	</interface>
15032
15033	<interface
15034	name="IStorageControllerChangedEvent" extends="IEvent"
15035	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15036	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15037	>
15038	<desc>
15039	Notification when a
15040	<link to="IMachine::mediumAttachments">medium attachment</link>
15041	changes.
15042	</desc>
15043	</interface>
15044
15045	<interface
15046	name="IMediumChangedEvent" extends="IEvent"
15047	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15048	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15049	>
15050	<desc>
15051	Notification when a
15052	<link to="IMachine::mediumAttachments">medium attachment</link>
15053	changes.
15054	</desc>
15055	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15056	<desc>
15057	Medium attachment that is subject to change.
15058	</desc>
15059	</attribute>
15060	</interface>
15061
15062	<interface
15063	name="ICPUChangedEvent" extends="IEvent"
15064	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15065	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15066	>
15067	<desc>
15068	Notification when a CPU changes.
15069	</desc>
15070	<attribute name="cpu" type="unsigned long" readonly="yes">
15071	<desc>
15072	The CPU which changed.
15073	</desc>
15074	</attribute>
15075	<attribute name="add" type="boolean" readonly="yes">
15076	<desc>
15077	Flag whether the CPU was added or removed.
15078	</desc>
15079	</attribute>
15080	</interface>
15081
15082	<interface
15083	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15084	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15085	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15086	>
15087	<desc>
15088	Notification when the CPU execution cap changes.
15089	</desc>
15090	<attribute name="executionCap" type="unsigned long" readonly="yes">
15091	<desc>
15092	The new CPU execution cap value. (1-100)
15093	</desc>
15094	</attribute>
15095	</interface>
15096
15097	<interface
15098	name="IGuestKeyboardEvent" extends="IEvent"
15099	uuid="88394258-7006-40d4-b339-472ee3801844"
15100	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboardEvent"
15101	>
15102	<desc>
15103	Notification when guest keyboard event happens.
15104	</desc>
15105	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15106	<desc>
15107	Array of scancodes.
15108	</desc>
15109	</attribute>
15110	</interface>
15111
15112	<interface
15113	name="IGuestMouseEvent" extends="IReusableEvent"
15114	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15115	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouseEvent"
15116	>
15117	<desc>
15118	Notification when guest mouse event happens.
15119	</desc>
15120
15121	<attribute name="absolute" type="boolean" readonly="yes">
15122	<desc>
15123	If this event is relative or absolute.
15124	</desc>
15125	</attribute>
15126
15127	<attribute name="x" type="long" readonly="yes">
15128	<desc>
15129	New X position, or X delta.
15130	</desc>
15131	</attribute>
15132
15133	<attribute name="y" type="long" readonly="yes">
15134	<desc>
15135	New Y position, or Y delta.
15136	</desc>
15137	</attribute>
15138
15139	<attribute name="z" type="long" readonly="yes">
15140	<desc>
15141	Z delta.
15142	</desc>
15143	</attribute>
15144
15145	<attribute name="w" type="long" readonly="yes">
15146	<desc>
15147	W delta.
15148	</desc>
15149	</attribute>
15150
15151	<attribute name="buttons" type="long" readonly="yes">
15152	<desc>
15153	Button state bitmask.
15154	</desc>
15155	</attribute>
15156
15157	</interface>
15158
15159
15160	<interface
15161	name="IVRDEServerChangedEvent" extends="IEvent"
15162	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15163	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15164	>
15165	<desc>
15166	Notification when a property of the
15167	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15168	Interested callees should use IVRDEServer methods and attributes to
15169	find out what has changed.
15170	</desc>
15171	</interface>
15172
15173	<interface
15174	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15175	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15176	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15177	>
15178	<desc>
15179	Notification when the status of the VRDE server changes. Interested callees
15180	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15181	attributes to find out what is the current status.
15182	</desc>
15183	</interface>
15184
15185	<interface
15186	name="IUSBControllerChangedEvent" extends="IEvent"
15187	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15188	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15189	>
15190	<desc>
15191	Notification when a property of the virtual
15192	<link to="IMachine::USBController">USB controller</link> changes.
15193	Interested callees should use IUSBController methods and attributes to
15194	find out what has changed.
15195	</desc>
15196	</interface>
15197
15198	<interface
15199	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15200	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15201	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15202	>
15203	<desc>
15204	Notification when a USB device is attached to or detached from
15205	the virtual USB controller.
15206
15207	This notification is sent as a result of the indirect
15208	request to attach the device because it matches one of the
15209	machine USB filters, or as a result of the direct request
15210	issued by <link to="IConsole::attachUSBDevice"/> or
15211	<link to="IConsole::detachUSBDevice"/>.
15212
15213	This notification is sent in case of both a succeeded and a
15214	failed request completion. When the request succeeds, the
15215	@a error parameter is @c null, and the given device has been
15216	already added to (when @a attached is @c true) or removed from
15217	(when @a attached is @c false) the collection represented by
15218	<link to="IConsole::USBDevices"/>. On failure, the collection
15219	doesn't change and the @a error parameter represents the error
15220	message describing the failure.
15221	</desc>
15222	<attribute name="device" type="IUSBDevice" readonly="yes">
15223	<desc>
15224	Device that is subject to state change.
15225	</desc>
15226	</attribute>
15227	<attribute name="attached" type="boolean" readonly="yes">
15228	<desc>
15229	@c true if the device was attached and @c false otherwise.
15230	</desc>
15231	</attribute>
15232	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15233	<desc>
15234	@c null on success or an error message object on failure.
15235	</desc>
15236	</attribute>
15237	</interface>
15238
15239	<interface
15240	name="ISharedFolderChangedEvent" extends="IEvent"
15241	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15242	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15243	>
15244	<desc>
15245	Notification when a shared folder is added or removed.
15246	The @a scope argument defines one of three scopes:
15247	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15248	(<link to="Scope_Global">Global</link>),
15249	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15250	the machine (<link to="Scope_Machine">Machine</link>) or <link
15251	to="IConsole::sharedFolders">transient shared folders</link> of the
15252	machine (<link to="Scope_Session">Session</link>). Interested callees
15253	should use query the corresponding collections to find out what has
15254	changed.
15255	</desc>
15256	<attribute name="scope" type="Scope" readonly="yes">
15257	<desc>
15258	Scope of the notification.
15259	</desc>
15260	</attribute>
15261	</interface>
15262
15263	<interface
15264	name="IRuntimeErrorEvent" extends="IEvent"
15265	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15266	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15267	>
15268	<desc>
15269	Notification when an error happens during the virtual
15270	machine execution.
15271
15272	There are three kinds of runtime errors:
15273	<ul>
15274	<li><i>fatal</i></li>
15275	<li><i>non-fatal with retry</i></li>
15276	<li><i>non-fatal warnings</i></li>
15277	</ul>
15278
15279	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15280	to @c true. In case of fatal errors, the virtual machine
15281	execution is always paused before calling this notification, and
15282	the notification handler is supposed either to immediately save
15283	the virtual machine state using <link to="IConsole::saveState"/>
15284	or power it off using <link to="IConsole::powerDown"/>.
15285	Resuming the execution can lead to unpredictable results.
15286
15287	<b>Non-fatal</b> errors and warnings are indicated by the
15288	@a fatal parameter set to @c false. If the virtual machine
15289	is in the Paused state by the time the error notification is
15290	received, it means that the user can <i>try to resume</i> the machine
15291	execution after attempting to solve the problem that caused the
15292	error. In this case, the notification handler is supposed
15293	to show an appropriate message to the user (depending on the
15294	value of the @a id parameter) that offers several actions such
15295	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15296	wants to retry, the notification handler should continue
15297	the machine execution using the <link to="IConsole::resume"/>
15298	call. If the machine execution is not Paused during this
15299	notification, then it means this notification is a <i>warning</i>
15300	(for example, about a fatal condition that can happen very soon);
15301	no immediate action is required from the user, the machine
15302	continues its normal execution.
15303
15304	Note that in either case the notification handler
15305	<b>must not</b> perform any action directly on a thread
15306	where this notification is called. Everything it is allowed to
15307	do is to post a message to another thread that will then talk
15308	to the user and take the corresponding action.
15309
15310	Currently, the following error identifiers are known:
15311	<ul>
15312	<li><tt>"HostMemoryLow"</tt></li>
15313	<li><tt>"HostAudioNotResponding"</tt></li>
15314	<li><tt>"VDIStorageFull"</tt></li>
15315	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15316	</ul>
15317	</desc>
15318	<attribute name="fatal" type="boolean" readonly="yes">
15319	<desc>
15320	Whether the error is fatal or not.
15321	</desc>
15322	</attribute>
15323	<attribute name="id" type="wstring" readonly="yes">
15324	<desc>
15325	Error identifier.
15326	</desc>
15327	</attribute>
15328	<attribute name="message" type="wstring" readonly="yes">
15329	<desc>
15330	Optional error message.
15331	</desc>
15332	</attribute>
15333	</interface>
15334
15335
15336	<interface
15337	name="IEventSourceChangedEvent" extends="IEvent"
15338	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15339	waitable="yes"
15340	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15341	>
15342	<desc>
15343	Notification when an event source state changes (listener added or removed).
15344	</desc>
15345
15346	<attribute name="listener" type="IEventListener" readonly="yes">
15347	<desc>
15348	Event listener which has changed.
15349	</desc>
15350	</attribute>
15351
15352	<attribute name="add" type="boolean" readonly="yes">
15353	<desc>
15354	Flag whether listener was added or removed.
15355	</desc>
15356	</attribute>
15357	</interface>
15358
15359	<interface
15360	name="IExtraDataChangedEvent" extends="IEvent"
15361	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15362	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15363	>
15364	<desc>
15365	Notification when machine specific or global extra data
15366	has changed.
15367	</desc>
15368	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15369	<desc>
15370	ID of the machine this event relates to.
15371	Null for global extra data changes.
15372	</desc>
15373	</attribute>
15374	<attribute name="key" type="wstring" readonly="yes">
15375	<desc>
15376	Extra data key that has changed.
15377	</desc>
15378	</attribute>
15379	<attribute name="value" type="wstring" readonly="yes">
15380	<desc>
15381	Extra data value for the given key.
15382	</desc>
15383	</attribute>
15384	</interface>
15385
15386	<interface
15387	name="IVetoEvent" extends="IEvent"
15388	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15389	wsmap="managed"
15390	>
15391	<desc>Base abstract interface for veto events.</desc>
15392
15393	<method name="addVeto">
15394	<desc>
15395	Adds a veto on this event.
15396	</desc>
15397	<param name="reason" type="wstring" dir="in">
15398	<desc>
15399	Reason for veto, could be null or empty string.
15400	</desc>
15401	</param>
15402	</method>
15403
15404	<method name="isVetoed">
15405	<desc>
15406	If this event was vetoed.
15407	</desc>
15408	<param name="result" type="boolean" dir="return">
15409	<desc>
15410	Reason for veto.
15411	</desc>
15412	</param>
15413	</method>
15414
15415	<method name="getVetos">
15416	<desc>
15417	Current veto reason list, if size is 0 - no veto.
15418	</desc>
15419	<param name="result" type="wstring" dir="return" safearray="yes">
15420	<desc>
15421	Array of reasons for veto provided by different event handlers.
15422	</desc>
15423	</param>
15424	</method>
15425
15426	</interface>
15427
15428	<interface
15429	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15430	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15431	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15432	waitable="true"
15433	>
15434	<desc>
15435	Notification when someone tries to change extra data for
15436	either the given machine or (if @c null) global extra data.
15437	This gives the chance to veto against changes.
15438	</desc>
15439	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15440	<desc>
15441	ID of the machine this event relates to.
15442	Null for global extra data changes.
15443	</desc>
15444	</attribute>
15445	<attribute name="key" type="wstring" readonly="yes">
15446	<desc>
15447	Extra data key that has changed.
15448	</desc>
15449	</attribute>
15450	<attribute name="value" type="wstring" readonly="yes">
15451	<desc>
15452	Extra data value for the given key.
15453	</desc>
15454	</attribute>
15455	</interface>
15456
15457	<interface
15458	name="ICanShowWindowEvent" extends="IVetoEvent"
15459	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15460	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15461	waitable="true"
15462	>
15463	<desc>
15464	Notification when a call to
15465	<link to="IMachine::canShowConsoleWindow"/> is made by a
15466	front-end to check if a subsequent call to
15467	<link to="IMachine::showConsoleWindow"/> can succeed.
15468
15469	The callee should give an answer appropriate to the current
15470	machine state using event veto. This answer must
15471	remain valid at least until the next
15472	<link to="IConsole::state">machine state</link> change.
15473	</desc>
15474	</interface>
15475
15476	<interface
15477	name="IShowWindowEvent" extends="IEvent"
15478	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15479	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15480	waitable="true"
15481	>
15482	<desc>
15483	Notification when a call to
15484	<link to="IMachine::showConsoleWindow"/>
15485	requests the console window to be activated and brought to
15486	foreground on the desktop of the host PC.
15487
15488	This notification should cause the VM console process to
15489	perform the requested action as described above. If it is
15490	impossible to do it at a time of this notification, this
15491	method should return a failure.
15492
15493	Note that many modern window managers on many platforms
15494	implement some sort of focus stealing prevention logic, so
15495	that it may be impossible to activate a window without the
15496	help of the currently active application (which is supposedly
15497	an initiator of this notification). In this case, this method
15498	must return a non-zero identifier that represents the
15499	top-level window of the VM console process. The caller, if it
15500	represents a currently active process, is responsible to use
15501	this identifier (in a platform-dependent manner) to perform
15502	actual window activation.
15503
15504	This method must set @a winId to zero if it has performed all
15505	actions necessary to complete the request and the console
15506	window is now active and in foreground, to indicate that no
15507	further action is required on the caller's side.
15508	</desc>
15509	<attribute name="winId" type="long long">
15510	<desc>
15511	Platform-dependent identifier of the top-level VM console
15512	window, or zero if this method has performed all actions
15513	necessary to implement the <i>show window</i> semantics for
15514	the given platform and/or this VirtualBox front-end.
15515	</desc>
15516	</attribute>
15517	</interface>
15518
15519	<module name="VBoxSVC" context="LocalServer">
15520	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15521	namespace="virtualbox.org">
15522	<interface name="IVirtualBox" default="yes"/>
15523	</class>
15524	</module>
15525
15526	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15527	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15528	namespace="virtualbox.org">
15529	<interface name="ISession" default="yes"/>
15530	</class>
15531
15532	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15533	namespace="virtualbox.org">
15534	<interface name="IConsole" default="yes"/>
15535	</class>
15536	</module>
15537
15538	</library>
15539
15540	</idl>
15541
15542	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format