VirtualBox.xidl@ 33044

Last change on this file since 33044 was 32885, checked in by vboxsync, 15 years ago
Renaming cpu priority to cpu execution cap
Property svn:eol-style set to `native`
File size: 563.1 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.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
80	the VBoxManage command-line interface and the VBoxVRDP server) 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	-->
472	</const>
473	<const name="Future" value="99999">
474	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
475	</const>
476	</enum>
477
478	<enum
479	name="AccessMode"
480	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
481	>
482	<desc>
483	Access mode for opening files.
484	</desc>
485
486	<const name="ReadOnly" value="1"/>
487	<const name="ReadWrite" value="2"/>
488	</enum>
489
490	<enum
491	name="MachineState"
492	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
493	>
494	<desc>
495	Virtual machine execution state.
496
497	This enumeration represents possible values of the <link
498	to="IMachine::state"/> attribute.
499
500	Below is the basic virtual machine state diagram. It shows how the state
501	changes during virtual machine execution. The text in square braces shows
502	a method of the IConsole interface that performs the given state
503	transition.
504
505	<pre>
506	+---------[powerDown()] <- Stuck <--[failure]-+
507	V \|
508	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
509	\| \| \| \| V \|
510	\| Aborted -----+ +--> Running --[pause()]--> Paused
511	\| \| ^ \| ^ \|
512	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
513	\| ^ \| \| \| \|
514	\| \| +-----------------------------------------+-\|-------------------+ +
515	\| \| \| \| \|
516	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
517	\| \| \| \|
518	\| +-------- Saving <--------[saveState()]<----------+---------------------+
519	\| \| \|
520	+-------------- Stopping -------[powerDown()]<----------+---------------------+
521	</pre>
522
523	Note that states to the right from PoweredOff, Aborted and Saved in the
524	above diagram are called <i>online VM states</i>. These states
525	represent the virtual machine which is being executed in a dedicated
526	process (usually with a GUI window attached to it where you can see the
527	activity of the virtual machine and interact with it). There are two
528	special pseudo-states, FirstOnline and LastOnline, that can be used in
529	relational expressions to detect if the given machine state is online or
530	not:
531
532	<pre>
533	if (machine.GetState() >= MachineState_FirstOnline &&
534	machine.GetState() <= MachineState_LastOnline)
535	{
536	...the machine is being executed...
537	}
538	</pre>
539
540	When the virtual machine is in one of the online VM states (that is, being
541	executed), only a few machine settings can be modified. Methods working
542	with such settings contain an explicit note about that. An attempt to
543	change any oter setting or perform a modifying operation during this time
544	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
545
546	All online states except Running, Paused and Stuck are transitional: they
547	represent temporary conditions of the virtual machine that will last as
548	long as the operation that initiated such a condition.
549
550	The Stuck state is a special case. It means that execution of the machine
551	has reached the "Guru Meditation" condition. This condition indicates an
552	internal VMM (virtual machine manager) failure which may happen as a
553	result of either an unhandled low-level virtual hardware exception or one
554	of the recompiler exceptions (such as the <i>too-many-traps</i>
555	condition).
556
557	Note also that any online VM state may transit to the Aborted state. This
558	happens if the process that is executing the virtual machine terminates
559	unexpectedly (for example, crashes). Other than that, the Aborted state is
560	equivalent to PoweredOff.
561
562	There are also a few additional state diagrams that do not deal with
563	virtual machine execution and therefore are shown separately. The states
564	shown on these diagrams are called <i>offline VM states</i> (this includes
565	PoweredOff, Aborted and Saved too).
566
567	The first diagram shows what happens when a lengthy setup operation is
568	being executed (such as <link to="IMachine::attachDevice"/>).
569
570	<pre>
571	+----------------------------------(same state as before the call)------+
572	\| \|
573	+-> PoweredOff --+ \|
574	\| \| \|
575	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
576	\| \|
577	+-> Saved -------+
578	</pre>
579
580	The next two diagrams demonstrate the process of taking a snapshot of a
581	powered off virtual machine, restoring the state to that as of a snapshot
582	or deleting a snapshot, respectively.
583
584	<pre>
585	+----------------------------------(same state as before the call)------+
586	\| \|
587	+-> PoweredOff --+ \|
588	\| +-->[takeSnapshot()] -------------------> Saving ------+
589	+-> Aborted -----+
590
591	+-> PoweredOff --+
592	\| \|
593	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
594	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
595	+-> Saved -------+ \|
596	\| \|
597	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
598	</pre>
599
600	Note that the Saving state is present in both the offline state group and
601	online state group. Currently, the only way to determine what group is
602	assumed in a particular case is to remember the previous machine state: if
603	it was Running or Paused, then Saving is an online state, otherwise it is
604	an offline state. This inconsistency may be removed in one of the future
605	versions of VirtualBox by adding a new state.
606
607	<note internal="yes">
608	For whoever decides to touch this enum: In order to keep the
609	comparisons involving FirstOnline and LastOnline pseudo-states valid,
610	the numeric values of these states must be correspondingly updated if
611	needed: for any online VM state, the condition
612	<tt>FirstOnline <= state <= LastOnline</tt> must be
613	@c true. The same relates to transient states for which
614	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
615	@c true.
616	</note>
617	</desc>
618
619	<const name="Null" value="0">
620	<desc>Null value (never used by the API).</desc>
621	</const>
622	<const name="PoweredOff" value="1">
623	<desc>
624	The machine is not running and has no saved execution state; it has
625	either never been started or been shut down successfully.
626	</desc>
627	</const>
628	<const name="Saved" value="2">
629	<desc>
630	The machine is not currently running, but the execution state of the machine
631	has been saved to an external file when it was running, from where
632	it can be resumed.
633	</desc>
634	</const>
635	<const name="Teleported" value="3">
636	<desc>
637	The machine was teleported to a different host (or process) and then
638	powered off. Take care when powering it on again may corrupt resources
639	it shares with the teleportation target (e.g. disk and network).
640	</desc>
641	</const>
642	<const name="Aborted" value="4">
643	<desc>
644	The process running the machine has terminated abnormally. This may
645	indicate a crash of the VM process in host execution context, or
646	the VM process has been terminated externally.
647	</desc>
648	</const>
649	<const name="Running" value="5">
650	<desc>
651	The machine is currently being executed.
652	<note internal="yes">
653	For whoever decides to touch this enum: In order to keep the
654	comparisons in the old source code valid, this state must immediately
655	precede the Paused state.
656	TODO: Lift this spectacularly wonderful restriction.
657	</note>
658	</desc>
659	</const>
660	<const name="Paused" value="6">
661	<desc>
662	Execution of the machine has been paused.
663	<note internal="yes">
664	For whoever decides to touch this enum: In order to keep the
665	comparisons in the old source code valid, this state must immediately
666	follow the Running state.
667	TODO: Lift this spectacularly wonderful restriction.
668	</note>
669	</desc>
670	</const>
671	<const name="Stuck" value="7">
672	<desc>
673	Execution of the machine has reached the "Guru Meditation"
674	condition. This indicates a severe error in the hypervisor itself.
675	<note internal="yes">
676	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
677	"Guru", perhaps? Or are there some other VMM states that are
678	intended to be lumped in here as well?
679	</note>
680	</desc>
681	</const>
682	<const name="Teleporting" value="8">
683	<desc>
684	The machine is about to be teleported to a different host or process.
685	It is possible to pause a machine in this state, but it will go to the
686	@c TeleportingPausedVM state and it will not be
687	possible to resume it again unless the teleportation fails.
688	</desc>
689	</const>
690	<const name="LiveSnapshotting" value="9">
691	<desc>
692	A live snapshot is being taken. The machine is running normally, but
693	some of the runtime configuration options are inaccessible. Also, if
694	paused while in this state it will transition to
695	@c Saving and it will not be resume the
696	execution until the snapshot operation has completed.
697	</desc>
698	</const>
699	<const name="Starting" value="10">
700	<desc>
701	Machine is being started after powering it on from a
702	zero execution state.
703	</desc>
704	</const>
705	<const name="Stopping" value="11">
706	<desc>
707	Machine is being normally stopped powering it off, or after the guest OS
708	has initiated a shutdown sequence.
709	</desc>
710	</const>
711	<const name="Saving" value="12">
712	<desc>
713	Machine is saving its execution state to a file, or an online
714	snapshot of the machine is being taken.
715	</desc>
716	</const>
717	<const name="Restoring" value="13">
718	<desc>
719	Execution state of the machine is being restored from a file
720	after powering it on from the saved execution state.
721	</desc>
722	</const>
723	<const name="TeleportingPausedVM" value="14">
724	<desc>
725	The machine is being teleported to another host or process, but it is
726	not running. This is the paused variant of the
727	@c state.
728	</desc>
729	</const>
730	<const name="TeleportingIn" value="15">
731	<desc>
732	Teleporting the machine state in from another host or process.
733	</desc>
734	</const>
735	<const name="FaultTolerantSyncing" value="16">
736	<desc>
737	The machine is being synced with a fault tolerant VM running elsewhere.
738	</desc>
739	</const>
740	<const name="DeletingSnapshotOnline" value="17">
741	<desc>
742	Like @c DeletingSnapshot, but the merging of media is ongoing in
743	the background while the machine is running.
744	</desc>
745	</const>
746	<const name="DeletingSnapshotPaused" value="18">
747	<desc>
748	Like @c DeletingSnapshotOnline, but the machine was paused when the
749	merging of differencing media was started.
750	</desc>
751	</const>
752	<const name="RestoringSnapshot" value="19">
753	<desc>
754	A machine snapshot is being restored; this typically does not take long.
755	</desc>
756	</const>
757	<const name="DeletingSnapshot" value="20">
758	<desc>
759	A machine snapshot is being deleted; this can take a long time since this
760	may require merging differencing media. This value indicates that the
761	machine is not running while the snapshot is being deleted.
762	</desc>
763	</const>
764	<const name="SettingUp" value="21">
765	<desc>
766	Lengthy setup operation is in progress.
767	</desc>
768	</const>
769
770	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
771	<desc>
772	Pseudo-state: first online state (for use in relational expressions).
773	</desc>
774	</const>
775	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
776	<desc>
777	Pseudo-state: last online state (for use in relational expressions).
778	</desc>
779	</const>
780
781	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
782	<desc>
783	Pseudo-state: first transient state (for use in relational expressions).
784	</desc>
785	</const>
786	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
787	<desc>
788	Pseudo-state: last transient state (for use in relational expressions).
789	</desc>
790	</const>
791
792	</enum>
793
794	<enum
795	name="SessionState"
796	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
797	>
798	<desc>
799	Session state. This enumeration represents possible values of
800	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
801	attributes.
802	</desc>
803
804	<const name="Null" value="0">
805	<desc>Null value (never used by the API).</desc>
806	</const>
807	<const name="Unlocked" value="1">
808	<desc>
809	In <link to="IMachine::sessionState"/>, this means that the machine
810	is not locked for any sessions.
811
812	In <link to="ISession::state"/>, this means that no machine is
813	currently locked for this session.
814	</desc>
815	</const>
816	<const name="Locked" value="2">
817	<desc>
818	In <link to="IMachine::sessionState"/>, this means that the machine
819	is currently locked for a session, whose process identifier can
820	then be found in the <link to="IMachine::sessionPid" /> attribute.
821
822	In <link to="ISession::state"/>, this means that a machine is
823	currently locked for this session, and the mutable machine object
824	can be found in the <link to="ISession::machine"/> attribute
825	(see <link to="IMachine::lockMachine" /> for details).
826	</desc>
827	</const>
828	<const name="Spawning" value="3">
829	<desc>
830	A new process is being spawned for the machine as a result of
831	<link to="IMachine::launchVMProcess"/> call. This state also occurs
832	as a short transient state during an <link to="IMachine::lockMachine"/>
833	call.
834	</desc>
835	</const>
836	<const name="Unlocking" value="4">
837	<desc>
838	The session is being unlocked.
839	</desc>
840	</const>
841	</enum>
842
843	<enum
844	name="CPUPropertyType"
845	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
846	>
847	<desc>
848	Virtual CPU property type. This enumeration represents possible values of the
849	IMachine get- and setCPUProperty methods.
850	</desc>
851	<const name="Null" value="0">
852	<desc>Null value (never used by the API).</desc>
853	</const>
854	<const name="PAE" value="1">
855	<desc>
856	This setting determines whether VirtualBox will expose the Physical Address
857	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
858	is not available, it will not be reported.
859	</desc>
860	</const>
861	<const name="Synthetic" value="2">
862	<desc>
863	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
864	teleporting between host systems that differ significantly.
865	</desc>
866	</const>
867	</enum>
868
869
870	<enum
871	name="HWVirtExPropertyType"
872	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
873	>
874	<desc>
875	Hardware virtualization property type. This enumeration represents possible values
876	for the <link to="IMachine::getHWVirtExProperty"/> and
877	<link to="IMachine::setHWVirtExProperty"/> methods.
878	</desc>
879	<const name="Null" value="0">
880	<desc>Null value (never used by the API).</desc>
881	</const>
882	<const name="Enabled" value="1">
883	<desc>
884	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
885	such extensions are not available, they will not be used.
886	</desc>
887	</const>
888	<const name="Exclusive" value="2">
889	<desc>
890	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
891	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
892	feature of the host. To share these with other hypervisors, you must disable this property.
893	</desc>
894	</const>
895	<const name="VPID" value="3">
896	<desc>
897	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
898	</desc>
899	</const>
900	<const name="NestedPaging" value="4">
901	<desc>
902	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
903	</desc>
904	</const>
905	<const name="LargePages" value="5">
906	<desc>
907	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
908	</desc>
909	</const>
910	<const name="Force" value="6">
911	<desc>
912	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
913	not set, there will be an automatic fallback to software virtualization.
914	</desc>
915	</const>
916	</enum>
917
918	<enum
919	name="FaultToleranceState"
920	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
921	>
922	<desc>
923	Used with <link to="IMachine::faultToleranceState" />.
924	</desc>
925	<const name="Inactive" value="1">
926	<desc>No fault tolerance enabled.</desc>
927	</const>
928	<const name="Master" value="2">
929	<desc>Fault tolerant master VM.</desc>
930	</const>
931	<const name="Standby" value="3">
932	<desc>Fault tolerant standby VM.</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="LockType"
938	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
939	>
940	<desc>
941	Used with <link to="IMachine::lockMachine" />.
942	</desc>
943	<const name="Write" value="2">
944	<desc>Lock the machine for writing.</desc>
945	</const>
946	<const name="Shared" value="1">
947	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
948	</const>
949	</enum>
950
951	<enum
952	name="SessionType"
953	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
954	>
955	<desc>
956	Session type. This enumeration represents possible values of the
957	<link to="ISession::type"/> attribute.
958	</desc>
959
960	<const name="Null" value="0">
961	<desc>Null value (never used by the API).</desc>
962	</const>
963	<const name="WriteLock" value="1">
964	<desc>
965	Session has acquired an exclusive write lock on a machine
966	using <link to="IMachine::lockMachine"/>.
967	</desc>
968	</const>
969	<const name="Remote" value="2">
970	<desc>
971	Session has launched a VM process using
972	<link to="IMachine::launchVMProcess"/>
973	</desc>
974	</const>
975	<const name="Shared" value="3">
976	<desc>
977	Session has obtained a link to another session using
978	<link to="IMachine::lockMachine"/>
979	</desc>
980	</const>
981	</enum>
982
983	<enum
984	name="DeviceType"
985	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
986	>
987	<desc>
988	Device type.
989	</desc>
990	<const name="Null" value="0">
991	<desc>
992	Null value, may also mean "no device" (not allowed for
993	<link to="IConsole::getDeviceActivity"/>).
994	</desc>
995	</const>
996	<const name="Floppy" value="1">
997	<desc>Floppy device.</desc>
998	</const>
999	<const name="DVD" value="2">
1000	<desc>CD/DVD-ROM device.</desc>
1001	</const>
1002	<const name="HardDisk" value="3">
1003	<desc>Hard disk device.</desc>
1004	</const>
1005	<const name="Network" value="4">
1006	<desc>Network device.</desc>
1007	</const>
1008	<const name="USB" value="5">
1009	<desc>USB device.</desc>
1010	</const>
1011	<const name="SharedFolder" value="6">
1012	<desc>Shared folder device.</desc>
1013	</const>
1014	</enum>
1015
1016	<enum
1017	name="DeviceActivity"
1018	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1019	>
1020	<desc>
1021	Device activity for <link to="IConsole::getDeviceActivity"/>.
1022	</desc>
1023
1024	<const name="Null" value="0"/>
1025	<const name="Idle" value="1"/>
1026	<const name="Reading" value="2"/>
1027	<const name="Writing" value="3"/>
1028	</enum>
1029
1030	<enum
1031	name="ClipboardMode"
1032	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1033	>
1034	<desc>
1035	Host-Guest clipboard interchange mode.
1036	</desc>
1037
1038	<const name="Disabled" value="0"/>
1039	<const name="HostToGuest" value="1"/>
1040	<const name="GuestToHost" value="2"/>
1041	<const name="Bidirectional" value="3"/>
1042	</enum>
1043
1044	<enum
1045	name="Scope"
1046	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1047	>
1048	<desc>
1049	Scope of the operation.
1050
1051	A generic enumeration used in various methods to define the action or
1052	argument scope.
1053	</desc>
1054
1055	<const name="Global" value="0"/>
1056	<const name="Machine" value="1"/>
1057	<const name="Session" value="2"/>
1058	</enum>
1059
1060	<enum
1061	name="BIOSBootMenuMode"
1062	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1063	>
1064	<desc>
1065	BIOS boot menu mode.
1066	</desc>
1067
1068	<const name="Disabled" value="0"/>
1069	<const name="MenuOnly" value="1"/>
1070	<const name="MessageAndMenu" value="2"/>
1071	</enum>
1072
1073	<enum
1074	name="ProcessorFeature"
1075	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1076	>
1077	<desc>
1078	CPU features.
1079	</desc>
1080
1081	<const name="HWVirtEx" value="0"/>
1082	<const name="PAE" value="1"/>
1083	<const name="LongMode" value="2"/>
1084	<const name="NestedPaging" value="3"/>
1085	</enum>
1086
1087	<enum
1088	name="FirmwareType"
1089	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1090	>
1091	<desc>
1092	Firmware type.
1093	</desc>
1094	<const name="BIOS" value="1">
1095	<desc>BIOS Firmware.</desc>
1096	</const>
1097	<const name="EFI" value="2">
1098	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1099	</const>
1100	<const name="EFI32" value="3">
1101	<desc>Efi firmware, 32-bit.</desc>
1102	</const>
1103	<const name="EFI64" value="4">
1104	<desc>Efi firmware, 64-bit.</desc>
1105	</const>
1106	<const name="EFIDUAL" value="5">
1107	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1108	</const>
1109	</enum>
1110
1111	<enum
1112	name="PointingHidType"
1113	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1114	>
1115	<desc>
1116	Type of pointing device used in a virtual machine.
1117	</desc>
1118	<const name="None" value="1">
1119	<desc>No mouse.</desc>
1120	</const>
1121	<const name="PS2Mouse" value="2">
1122	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1123	</const>
1124	<const name="USBMouse" value="3">
1125	<desc>USB mouse (relative pointer).</desc>
1126	</const>
1127	<const name="USBTablet" value="4">
1128	<desc>USB tablet (absolute pointer).</desc>
1129	</const>
1130	<const name="ComboMouse" value="5">
1131	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1132	Using of such device can have negative performance implications. </desc>
1133	</const>
1134	</enum>
1135
1136	<enum
1137	name="KeyboardHidType"
1138	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1139	>
1140	<desc>
1141	Type of keyboard device used in a virtual machine.
1142	</desc>
1143	<const name="None" value="1">
1144	<desc>No keyboard.</desc>
1145	</const>
1146	<const name="PS2Keyboard" value="2">
1147	<desc>PS/2 keyboard.</desc>
1148	</const>
1149	<const name="USBKeyboard" value="3">
1150	<desc>USB keyboard.</desc>
1151	</const>
1152	<const name="ComboKeyboard" value="4">
1153	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1154	Using of such device can have negative performance implications. </desc>
1155	</const>
1156	</enum>
1157
1158	<!--
1159	// IVirtualBoxErrorInfo
1160	/////////////////////////////////////////////////////////////////////////
1161	-->
1162
1163	<interface
1164	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1165	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1166	supportsErrorInfo="no"
1167	wsmap="managed"
1168	>
1169	<desc>
1170	The IVirtualBoxErrorInfo interface represents extended error information.
1171
1172	Extended error information can be set by VirtualBox components after
1173	unsuccessful or partially successful method invocation. This information
1174	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1175	and then shown to the client in addition to the plain 32-bit result code.
1176
1177	In MS COM, this interface extends the IErrorInfo interface,
1178	in XPCOM, it extends the nsIException interface. In both cases,
1179	it provides a set of common attributes to retrieve error
1180	information.
1181
1182	Sometimes invocation of some component's method may involve methods of
1183	other components that may also fail (independently of this method's
1184	failure), or a series of non-fatal errors may precede a fatal error that
1185	causes method failure. In cases like that, it may be desirable to preserve
1186	information about all errors happened during method invocation and deliver
1187	it to the caller. The <link to="#next"/> attribute is intended
1188	specifically for this purpose and allows to represent a chain of errors
1189	through a single IVirtualBoxErrorInfo object set after method invocation.
1190
1191	Note that errors are stored to a chain in the reverse order, i.e. the
1192	initial error object you query right after method invocation is the last
1193	error set by the callee, the object it points to in the @a next attribute
1194	is the previous error and so on, up to the first error (which is the last
1195	in the chain).
1196	</desc>
1197
1198	<attribute name="resultCode" type="long" readonly="yes">
1199	<desc>
1200	Result code of the error.
1201	Usually, it will be the same as the result code returned
1202	by the method that provided this error information, but not
1203	always. For example, on Win32, CoCreateInstance() will most
1204	likely return E_NOINTERFACE upon unsuccessful component
1205	instantiation attempt, but not the value the component factory
1206	returned. Value is typed 'long', not 'result',
1207	to make interface usable from scripting languages.
1208	<note>
1209	In MS COM, there is no equivalent.
1210	In XPCOM, it is the same as nsIException::result.
1211	</note>
1212	</desc>
1213	</attribute>
1214
1215	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1216	<desc>
1217	UUID of the interface that defined the error.
1218	<note>
1219	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1220	data type.
1221	In XPCOM, there is no equivalent.
1222	</note>
1223	</desc>
1224	</attribute>
1225
1226	<attribute name="component" type="wstring" readonly="yes">
1227	<desc>
1228	Name of the component that generated the error.
1229	<note>
1230	In MS COM, it is the same as IErrorInfo::GetSource.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="text" type="wstring" readonly="yes">
1237	<desc>
1238	Text description of the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetDescription.
1241	In XPCOM, it is the same as nsIException::message.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1247	<desc>
1248	Next error object if there is any, or @c null otherwise.
1249	<note>
1250	In MS COM, there is no equivalent.
1251	In XPCOM, it is the same as nsIException::inner.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	</interface>
1257
1258	<!--
1259	// IVirtualBox
1260	/////////////////////////////////////////////////////////////////////////
1261	-->
1262
1263	<interface
1264	name="IDHCPServer" extends="$unknown"
1265	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1266	wsmap="managed"
1267	>
1268	<desc>
1269	The IDHCPServer interface represents the vbox dhcp server configuration.
1270
1271	To enumerate all the dhcp servers on the host, use the
1272	<link to="IVirtualBox::DHCPServers"/> attribute.
1273	</desc>
1274
1275	<attribute name="enabled" type="boolean">
1276	<desc>
1277	specifies if the dhcp server is enabled
1278	</desc>
1279	</attribute>
1280
1281	<attribute name="IPAddress" type="wstring" readonly="yes">
1282	<desc>
1283	specifies server IP
1284	</desc>
1285	</attribute>
1286
1287	<attribute name="networkMask" type="wstring" readonly="yes">
1288	<desc>
1289	specifies server network mask
1290	</desc>
1291	</attribute>
1292
1293	<attribute name="networkName" type="wstring" readonly="yes">
1294	<desc>
1295	specifies internal network name the server is used for
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="lowerIP" type="wstring" readonly="yes">
1300	<desc>
1301	specifies from IP adrres in server address range
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="upperIP" type="wstring" readonly="yes">
1306	<desc>
1307	specifies to IP adrres in server address range
1308	</desc>
1309	</attribute>
1310
1311	<method name="setConfiguration">
1312	<desc>
1313	configures the server
1314	<result name="E_INVALIDARG">
1315	invalid configuration supplied
1316	</result>
1317	</desc>
1318	<param name="IPAddress" type="wstring" dir="in">
1319	<desc>
1320	server IP address
1321	</desc>
1322	</param>
1323	<param name="networkMask" type="wstring" dir="in">
1324	<desc>
1325	server network mask
1326	</desc>
1327	</param>
1328	<param name="FromIPAddress" type="wstring" dir="in">
1329	<desc>
1330	server From IP address for address range
1331	</desc>
1332	</param>
1333	<param name="ToIPAddress" type="wstring" dir="in">
1334	<desc>
1335	server To IP address for address range
1336	</desc>
1337	</param>
1338	</method>
1339
1340	<method name="start">
1341	<desc>
1342	Starts DHCP server process.
1343	<result name="E_FAIL">
1344	Failed to start the process.
1345	</result>
1346	</desc>
1347	<param name="networkName" type="wstring" dir="in">
1348	<desc>
1349	Name of internal network DHCP server should attach to.
1350	</desc>
1351	</param>
1352	<param name="trunkName" type="wstring" dir="in">
1353	<desc>
1354	Name of internal network trunk.
1355	</desc>
1356	</param>
1357	<param name="trunkType" type="wstring" dir="in">
1358	<desc>
1359	Type of internal network trunk.
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="stop">
1365	<desc>
1366	Stops DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to stop the process.
1369	</result>
1370	</desc>
1371	</method>
1372	</interface>
1373
1374	<interface
1375	name="IVirtualBox" extends="$unknown"
1376	uuid="ec6cc7e7-06a2-4c5d-8993-1e3619c53817"
1377	wsmap="managed"
1378	>
1379	<desc>
1380	The IVirtualBox interface represents the main interface exposed by the
1381	product that provides virtual machine management.
1382
1383	An instance of IVirtualBox is required for the product to do anything
1384	useful. Even though the interface does not expose this, internally,
1385	IVirtualBox is implemented as a singleton and actually lives in the
1386	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1387	IVirtualBox can track the state of all virtual machines on a particular
1388	host, regardless of which frontend started them.
1389
1390	To enumerate all the virtual machines on the host, use the
1391	<link to="IVirtualBox::machines"/> attribute.
1392	</desc>
1393
1394	<attribute name="version" type="wstring" readonly="yes">
1395	<desc>
1396	A string representing the version number of the product. The
1397	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1398	last number represents the build number and will frequently change.
1399	</desc>
1400	</attribute>
1401
1402	<attribute name="revision" type="unsigned long" readonly="yes">
1403	<desc>
1404	The internal build revision number of the product.
1405	</desc>
1406	</attribute>
1407
1408	<attribute name="packageType" type="wstring" readonly="yes">
1409	<desc>
1410	A string representing the package type of this product. The
1411	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1412	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1413	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1414	this.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="homeFolder" type="wstring" readonly="yes">
1419	<desc>
1420	Full path to the directory where the global settings file,
1421	<tt>VirtualBox.xml</tt>, is stored.
1422
1423	In this version of VirtualBox, the value of this property is
1424	always <tt><user_dir>/.VirtualBox</tt> (where
1425	<tt><user_dir></tt> is the path to the user directory,
1426	as determined by the host OS), and cannot be changed.
1427
1428	This path is also used as the base to resolve relative paths in
1429	places where relative paths are allowed (unless otherwise
1430	expressly indicated).
1431	</desc>
1432	</attribute>
1433
1434	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1435	<desc>
1436	Full name of the global settings file.
1437	The value of this property corresponds to the value of
1438	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1439	</desc>
1440	</attribute>
1441
1442	<attribute name="host" type="IHost" readonly="yes">
1443	<desc>Associated host object.</desc>
1444	</attribute>
1445
1446	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1447	<desc>Associated system information object.</desc>
1448	</attribute>
1449
1450	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1451	<desc>
1452	Array of machine objects registered within this VirtualBox instance.
1453	</desc>
1454	</attribute>
1455
1456	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1457	<desc>
1458	Array of medium objects known to this VirtualBox installation.
1459
1460	This array contains only base media. All differencing
1461	media of the given base medium can be enumerated using
1462	<link to="IMedium::children"/>.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1473	<desc>
1474	Array of floppy image objects currently in use by this VirtualBox instance.
1475	</desc>
1476	</attribute>
1477
1478	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1479
1480	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1481
1482	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1483	<desc>
1484	Collection of global shared folders. Global shared folders are
1485	available to all virtual machines.
1486
1487	New shared folders are added to the collection using
1488	<link to="#createSharedFolder"/>. Existing shared folders can be
1489	removed using <link to="#removeSharedFolder"/>.
1490
1491	<note>
1492	In the current version of the product, global shared folders are not
1493	implemented and therefore this collection is always empty.
1494	</note>
1495	</desc>
1496	</attribute>
1497
1498	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1499	<desc>
1500	Associated performance collector object.
1501	</desc>
1502	</attribute>
1503
1504	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1505	<desc>
1506	dhcp server settings.
1507	</desc>
1508	</attribute>
1509
1510	<attribute name="eventSource" type="IEventSource" readonly="yes">
1511	<desc>
1512	Event source for VirtualBox events.
1513	</desc>
1514	</attribute>
1515
1516
1517	<method name="createMachine">
1518	<desc>
1519	Creates a new virtual machine.
1520
1521	The new machine is created unregistered, with the initial configuration
1522	set according to the specified guest OS type. A typical sequence of
1523	actions to create a new virtual machine is as follows:
1524
1525	<ol>
1526	<li>
1527	Call this method to have a new machine created. The returned machine
1528	object will be "mutable" allowing to change any machine property.
1529	</li>
1530
1531	<li>
1532	Configure the machine using the appropriate attributes and methods.
1533	</li>
1534
1535	<li>
1536	Call <link to="IMachine::saveSettings" /> to write the settings
1537	to the machine's XML settings file. The configuration of the newly
1538	created machine will not be saved to disk until this method is
1539	called.
1540	</li>
1541
1542	<li>
1543	Call <link to="#registerMachine" /> to add the machine to the list
1544	of machines known to VirtualBox.
1545	</li>
1546	</ol>
1547
1548	You should specify valid name for the newly created machine when calling
1549	this method. See the <link to="IMachine::name"/> attribute description
1550	for more details about the machine name.
1551
1552	The specified guest OS type identifier must match an ID of one of known
1553	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1554	array.
1555
1556	Every machine has a <i>settings file</i> that is used to store
1557	the machine configuration. This file is stored in a directory called the
1558	<i>machine settings subfolder</i>. Both the settings subfolder and file
1559	will have a name that corresponds to the name of the virtual machine.
1560	You can specify where to create the machine setting subfolder using the
1561	@a baseFolder argument. The base folder can be absolute (full path) or
1562	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1563	directory</link>.
1564
1565	If @a baseFolder is a @c null or empty string (which is recommended), the
1566	<link to="ISystemProperties::defaultMachineFolder">default machine
1567	settings folder</link> will be used as a base folder for the created
1568	machine. Otherwise the given base folder will be used. In either case,
1569	the full path to the resulting settings file has the following
1570	structure:
1571	<pre>
1572	<base_folder>/<machine_name>/<machine_name>.xml
1573	</pre>
1574
1575	Note that if the resulting settings file already exists, this method
1576	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1577
1578	Optionally, you may specify an UUID of to assign to the created machine.
1579	However, this is not recommended and you should normally pass an empty
1580	(@c null) UUID to this method so that a new UUID will be automatically
1581	generated for every created machine. You can use UUID
1582	00000000-0000-0000-0000-000000000000 as @c null value.
1583
1584	<note>
1585	There is no way to change the name of the settings file or
1586	subfolder of the created machine directly.
1587	</note>
1588
1589	<result name="VBOX_E_OBJECT_NOT_FOUND">
1590	@a osTypeId is invalid.
1591	</result>
1592	<result name="VBOX_E_FILE_ERROR">
1593	Resulting settings file name is invalid or the settings file already
1594	exists or could not be created due to an I/O error.
1595	</result>
1596	<result name="E_INVALIDARG">
1597	@a name is empty or @c null.
1598	</result>
1599	</desc>
1600
1601	<param name="name" type="wstring" dir="in">
1602	<desc>Machine name.</desc>
1603	</param>
1604	<param name="osTypeId" type="wstring" dir="in">
1605	<desc>Guest OS Type ID.</desc>
1606	</param>
1607	<param name="baseFolder" type="wstring" dir="in">
1608	<desc>Base machine folder (optional).</desc>
1609	</param>
1610	<param name="id" type="uuid" mod="string" dir="in">
1611	<desc>Machine UUID (optional).</desc>
1612	</param>
1613	<param name="override" type="boolean" dir="in">
1614	<desc>Create the VM even if there are conflicting files.</desc>
1615	</param>
1616	<param name="machine" type="IMachine" dir="return">
1617	<desc>Created machine object.</desc>
1618	</param>
1619	</method>
1620
1621	<method name="openMachine">
1622	<desc>
1623	Opens a virtual machine from the existing settings file.
1624	The opened machine remains unregistered until you call
1625	<link to="#registerMachine"/>.
1626
1627	The specified settings file name can be absolute
1628	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1629	VirtualBox home directory</link>. This file must exist
1630	and must be a valid machine settings file whose contents
1631	will be used to construct the machine object.
1632
1633	<result name="VBOX_E_FILE_ERROR">
1634	Settings file name invalid, not found or sharing violation.
1635	</result>
1636	</desc>
1637	<param name="settingsFile" type="wstring" dir="in">
1638	<desc>
1639	Name of the machine settings file.
1640	</desc>
1641	</param>
1642	<param name="machine" type="IMachine" dir="return">
1643	<desc>Opened machine object.</desc>
1644	</param>
1645	<note>
1646	<link to="IMachine::settingsModified"/> will return
1647	@c false for the created machine, until any of machine settings
1648	are changed.
1649	</note>
1650	</method>
1651
1652	<method name="registerMachine">
1653	<desc>
1654
1655	Registers the machine previously created using
1656	<link to="#createMachine"/> or opened using
1657	<link to="#openMachine"/> within this VirtualBox installation. After
1658	successful method invocation, the
1659	<link to="IMachineRegisteredEvent"/> event is fired.
1660
1661	<note>
1662	This method implicitly calls <link to="IMachine::saveSettings"/>
1663	to save all current machine settings before registering it.
1664	</note>
1665
1666	<result name="VBOX_E_OBJECT_NOT_FOUND">
1667	No matching virtual machine found.
1668	</result>
1669	<result name="VBOX_E_INVALID_OBJECT_STATE">
1670	Virtual machine was not created within this VirtualBox instance.
1671	</result>
1672
1673	</desc>
1674	<param name="machine" type="IMachine" dir="in"/>
1675	</method>
1676
1677	<method name="getMachine">
1678	<desc>
1679	Attempts to find a virtual machine given its UUID.
1680	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1681	instead.
1682
1683	<result name="VBOX_E_OBJECT_NOT_FOUND">
1684	Could not find registered machine matching @a id.
1685	</result>
1686
1687	</desc>
1688	<param name="id" type="uuid" mod="string" dir="in"/>
1689	<param name="machine" type="IMachine" dir="return"/>
1690	</method>
1691
1692	<method name="findMachine">
1693	<desc>
1694	Attempts to find a virtual machine given its name.
1695	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1696	instead.
1697
1698	<result name="VBOX_E_OBJECT_NOT_FOUND">
1699	Could not find registered machine matching @a name.
1700	</result>
1701
1702	</desc>
1703	<param name="name" type="wstring" dir="in"/>
1704	<param name="machine" type="IMachine" dir="return"/>
1705	</method>
1706
1707	<method name="createAppliance">
1708	<desc>
1709	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1710	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1711	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1712	</desc>
1713	<param name="appliance" type="IAppliance" dir="return">
1714	<desc>New appliance.</desc>
1715	</param>
1716	</method>
1717
1718	<method name="createHardDisk">
1719	<desc>
1720	Creates a new base medium object that will use the given storage
1721	format and location for medium data.
1722
1723	Note that the actual storage unit is not created by this method. In
1724	order to do it, and before you are able to attach the created medium
1725	to virtual machines, you must call one of the following methods to
1726	allocate a format-specific storage unit at the specified location:
1727	<ul>
1728	<li><link to="IMedium::createBaseStorage"/></li>
1729	<li><link to="IMedium::createDiffStorage"/></li>
1730	</ul>
1731
1732	Some medium attributes, such as <link to="IMedium::id"/>, may
1733	remain uninitialized until the medium storage unit is successfully
1734	created by one of the above methods.
1735
1736	After the storage unit is successfully created, it will be
1737	accessible through the <link to="#findMedium"/> method and can
1738	be found in the <link to="#hardDisks"/> array.
1739
1740	The list of all storage formats supported by this VirtualBox
1741	installation can be obtained using
1742	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1743	attribute is empty or @c null then the default storage format
1744	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1745	be used for creating a storage unit of the medium.
1746
1747	Note that the format of the location string is storage format specific.
1748	See <link to="IMedium::location"/>, IMedium and
1749	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1750
1751	<result name="VBOX_E_OBJECT_NOT_FOUND">
1752	@a format identifier is invalid. See
1753	<link to="ISystemProperties::mediumFormats"/>.
1754	</result>
1755	<result name="VBOX_E_FILE_ERROR">
1756	@a location is a not valid file name (for file-based formats only).
1757	</result>
1758	</desc>
1759	<param name="format" type="wstring" dir="in">
1760	<desc>
1761	Identifier of the storage format to use for the new medium.
1762	</desc>
1763	</param>
1764	<param name="location" type="wstring" dir="in">
1765	<desc>
1766	Location of the storage unit for the new medium.
1767	</desc>
1768	</param>
1769	<param name="medium" type="IMedium" dir="return">
1770	<desc>Created medium object.</desc>
1771	</param>
1772	</method>
1773
1774	<method name="openMedium">
1775	<desc>
1776	Opens a medium from an existing storage location.
1777
1778	Once a medium has been opened, it can be passed to other VirtualBox
1779	methods, in particular to <link to="IMachine::attachDevice" />.
1780
1781	Depending on the given device type, the file at the storage location
1782	must be in one of the media formats understood by VirtualBox:
1783
1784	<ul>
1785	<li>With a "HardDisk" device type, the file must be a hard disk image
1786	in one of the formats supported by VirtualBox (see
1787	<link to="ISystemProperties::mediumFormats" />).
1788	After this method succeeds, if the medium is a base medium, it
1789	will be added to the <link to="#hardDisks"/> array attribute. </li>
1790	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1791	After this method succeeds, the medium will be added to the
1792	<link to="#DVDImages"/> array attribute.</li>
1793	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1794	After this method succeeds, the medium will be added to the
1795	<link to="#floppyImages"/> array attribute.</li>
1796	</ul>
1797
1798	After having been opened, the medium can be found by the <link to="#findMedium"/>
1799	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1800
1801	The UUID of the newly opened medium will either be retrieved from the
1802	storage location, if the format supports it (e.g. for hard disk images),
1803	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1804	If for some reason you need to change the medium's UUID, use
1805	<link to="IMedium::setIDs" />.
1806
1807	If a differencing hard disk medium is to be opened by this method, the
1808	operation will succeed only if its parent medium and all ancestors,
1809	if any, are already known to this VirtualBox installation (for example,
1810	were opened by this method before).
1811
1812	This method attempts to guess the storage format of the specified medium
1813	by reading medium data at the specified location.
1814
1815	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1816	the image is opened for read/write access and must have according permissions,
1817	as VirtualBox may actually write status information into the disk's metadata
1818	sections.
1819
1820	Note that write access is required for all typical hard disk usage in VirtualBox,
1821	since VirtualBox may need to write metadata such as a UUID into the image.
1822	The only exception is opening a source image temporarily for copying and
1823	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1824	again soon.
1825
1826	The format of the location string is storage format specific. See
1827	<link to="IMedium::location"/>, IMedium and
1828	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1829
1830	Prior to VirtualBox 3.3, opening a medium added it to a global media
1831	registry in the VirtualBox.xml file, which was shared between
1832	all machines and made transporting machines and their media from one
1833	host to another difficult.
1834
1835	Starting with VirtualBox 3.3, media are only added to a registry when
1836	they are attached to a machine. Machines created with VirtualBox 3.3
1837	or later can have their own media registry. As a result, a medium attached
1838	to such a machine will be remembered in that machine's XML settings file.
1839	Media attached to older machines will continue to be added to the global
1840	registry.
1841
1842	<result name="VBOX_E_FILE_ERROR">
1843	Invalid medium storage file location or could not find the medium
1844	at the specified location.
1845	</result>
1846	<result name="VBOX_E_IPRT_ERROR">
1847	Could not get medium storage format.
1848	</result>
1849	<result name="E_INVALIDARG">
1850	Invalid medium storage format.
1851	</result>
1852	<result name="VBOX_E_INVALID_OBJECT_STATE">
1853	Medium has already been added to a media registry.
1854	</result>
1855	</desc>
1856	<param name="location" type="wstring" dir="in">
1857	<desc>
1858	Location of the storage unit that contains medium data in one of
1859	the supported storage formats.
1860	</desc>
1861	</param>
1862	<param name="deviceType" type="DeviceType" dir="in">
1863	<desc>
1864	Must be one of "HardDisk", "DVD" or "Floppy".
1865	</desc>
1866	</param>
1867	<param name="accessMode" type="AccessMode" dir="in">
1868	<desc>Whether to open the image in read/write or read-only mode. For
1869	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1870	</param>
1871	<param name="medium" type="IMedium" dir="return">
1872	<desc>Opened medium object.</desc>
1873	</param>
1874	</method>
1875
1876	<method name="findMedium">
1877	<desc>
1878	Returns a medium of the given type that uses the given location or
1879	UUID to store medium data.
1880
1881	The given medium must be known to this VirtualBox installation, i.e.
1882	it must be previously created by <link to="#createHardDisk"/> or opened
1883	by <link to="#openMedium"/>.
1884
1885	The search is done by comparing the value of the @a location argument to
1886	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1887	attributes of each known medium.
1888
1889	For locations represented by file names in the host's file system, the
1890	requested location can be a path relative to the
1891	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1892	only a file name without any path is given, the
1893	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
1894	folder</link> will be prepended to the file name before searching. Note
1895	that on case sensitive file systems, a case sensitive comparison is
1896	performed, otherwise the case of symbols in the file path is ignored.
1897
1898	<result name="VBOX_E_OBJECT_NOT_FOUND">
1899	No medium object matching @a location found.
1900	</result>
1901	</desc>
1902	<param name="location" type="wstring" dir="in">
1903	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1904	</param>
1905	<param name="type" type="DeviceType" dir="in">
1906	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Medium object, if found.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="getGuestOSType">
1914	<desc>
1915	Returns an object describing the specified guest OS type.
1916
1917	The requested guest OS type is specified using a string which is a
1918	mnemonic identifier of the guest operating system, such as
1919	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1920	particular virtual machine can be read or set using the
1921	<link to="IMachine::OSTypeId"/> attribute.
1922
1923	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1924	available guest OS type objects. Each object has an
1925	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1926	the guest OS this object describes.
1927
1928	<result name="E_INVALIDARG">
1929	@a id is not a valid Guest OS type.
1930	</result>
1931
1932	</desc>
1933	<param name="id" type="uuid" mod="string" dir="in">
1934	<desc>Guest OS type ID string.</desc>
1935	</param>
1936	<param name="type" type="IGuestOSType" dir="return">
1937	<desc>Guest OS type object.</desc>
1938	</param>
1939	</method>
1940
1941	<method name="createSharedFolder">
1942	<desc>
1943	Creates a new global shared folder by associating the given logical
1944	name with the given host path, adds it to the collection of shared
1945	folders and starts sharing it. Refer to the description of
1946	<link to="ISharedFolder"/> to read more about logical names.
1947	<note>
1948	In the current implementation, this operation is not
1949	implemented.
1950	</note>
1951	</desc>
1952	<param name="name" type="wstring" dir="in">
1953	<desc>Unique logical name of the shared folder.</desc>
1954	</param>
1955	<param name="hostPath" type="wstring" dir="in">
1956	<desc>Full path to the shared folder in the host file system.</desc>
1957	</param>
1958	<param name="writable" type="boolean" dir="in">
1959	<desc>Whether the share is writable or readonly</desc>
1960	</param>
1961	<param name="automount" type="boolean" dir="in">
1962	<desc>Whether the share gets automatically mounted by the guest
1963	or not.</desc>
1964	</param>
1965	</method>
1966
1967	<method name="removeSharedFolder">
1968	<desc>
1969	Removes the global shared folder with the given name previously
1970	created by <link to="#createSharedFolder"/> from the collection of
1971	shared folders and stops sharing it.
1972	<note>
1973	In the current implementation, this operation is not
1974	implemented.
1975	</note>
1976	</desc>
1977	<param name="name" type="wstring" dir="in">
1978	<desc>Logical name of the shared folder to remove.</desc>
1979	</param>
1980	</method>
1981
1982	<method name="getExtraDataKeys">
1983	<desc>
1984	Returns an array representing the global extra data keys which currently
1985	have values defined.
1986	</desc>
1987	<param name="value" type="wstring" dir="return" safearray="yes">
1988	<desc>Array of extra data keys.</desc>
1989	</param>
1990	</method>
1991
1992	<method name="getExtraData">
1993	<desc>
1994	Returns associated global extra data.
1995
1996	If the requested data @a key does not exist, this function will
1997	succeed and return an empty string in the @a value argument.
1998
1999	<result name="VBOX_E_FILE_ERROR">
2000	Settings file not accessible.
2001	</result>
2002	<result name="VBOX_E_XML_ERROR">
2003	Could not parse the settings file.
2004	</result>
2005
2006	</desc>
2007	<param name="key" type="wstring" dir="in">
2008	<desc>Name of the data key to get.</desc>
2009	</param>
2010	<param name="value" type="wstring" dir="return">
2011	<desc>Value of the requested data key.</desc>
2012	</param>
2013	</method>
2014
2015	<method name="setExtraData">
2016	<desc>
2017	Sets associated global extra data.
2018
2019	If you pass @c null or empty string as a key @a value, the given @a key
2020	will be deleted.
2021
2022	<note>
2023	Before performing the actual data change, this method will ask all
2024	registered event listener using the
2025	<link to="IExtraDataCanChangeEvent"/>
2026	notification for a permission. If one of the listeners refuses the
2027	new value, the change will not be performed.
2028	</note>
2029	<note>
2030	On success, the
2031	<link to="IExtraDataChangedEvent"/> notification
2032	is called to inform all registered listeners about a successful data
2033	change.
2034	</note>
2035
2036	<result name="VBOX_E_FILE_ERROR">
2037	Settings file not accessible.
2038	</result>
2039	<result name="VBOX_E_XML_ERROR">
2040	Could not parse the settings file.
2041	</result>
2042	<result name="E_ACCESSDENIED">
2043	Modification request refused.
2044	</result>
2045
2046	</desc>
2047	<param name="key" type="wstring" dir="in">
2048	<desc>Name of the data key to set.</desc>
2049	</param>
2050	<param name="value" type="wstring" dir="in">
2051	<desc>Value to assign to the key.</desc>
2052	</param>
2053	</method>
2054
2055	<method name="waitForPropertyChange">
2056	<desc>
2057	Blocks the caller until any of the properties represented by the
2058	@a what argument changes the value or until the given timeout interval
2059	expires.
2060
2061	The @a what argument is a comma separated list of property masks that
2062	describe properties the caller is interested in. The property mask is
2063	a string in the following format:
2064
2065	<pre>
2066	[[group.]subgroup.]name
2067	</pre>
2068
2069	where @c name is the property name and @c group, @c subgroup are zero
2070	or more property group specifiers. Each element (group or name) in
2071	the property mask may be either a Latin string or an asterisk symbol
2072	(@c "*") which is used to match any string for the given element. A
2073	property mask that doesn't contain asterisk symbols represents a
2074	single fully qualified property name.
2075
2076	Groups in the fully qualified property name go from more generic (the
2077	left-most part) to more specific (the right-most part). The first
2078	element is usually a name of the object the property belongs to. The
2079	second element may be either a property name, or a child object name,
2080	or an index if the preceding element names an object which is one of
2081	many objects of the same type. This way, property names form a
2082	hierarchy of properties. Here are some examples of property names:
2083
2084	<table>
2085	<tr>
2086	<td><tt>VirtualBox.version</tt></td>
2087	<td><link to="IVirtualBox::version"/> property</td>
2088	</tr>
2089	<tr>
2090	<td><tt>Machine.<UUID>.name</tt></td>
2091	<td><link to="IMachine::name"/> property of the machine with the
2092	given UUID</td>
2093	</tr>
2094	</table>
2095
2096	Most property names directly correspond to the properties of objects
2097	(components) provided by the VirtualBox library and may be used to
2098	track changes to these properties. However, there may be
2099	pseudo-property names that don't correspond to any existing object's
2100	property directly, as well as there may be object properties that
2101	don't have a corresponding property name that is understood by this
2102	method, and therefore changes to such properties cannot be
2103	tracked. See individual object's property descriptions to get a
2104	fully qualified property name that can be used with this method (if
2105	any).
2106
2107	There is a special property mask @c "*" (i.e. a string consisting of a
2108	single asterisk symbol) that can be used to match all properties.
2109	Below are more examples of property masks:
2110
2111	<table>
2112	<tr>
2113	<td><tt>VirtualBox.*</tt></td>
2114	<td>Track all properties of the VirtualBox object</td>
2115	</tr>
2116	<tr>
2117	<td><tt>Machine.*.name</tt></td>
2118	<td>Track changes to the <link to="IMachine::name"/> property of
2119	all registered virtual machines</td>
2120	</tr>
2121	</table>
2122
2123	<note>
2124	This function is not implemented in the current version of the
2125	product.
2126	</note>
2127	</desc>
2128	<param name="what" type="wstring" dir="in">
2129	<desc>Comma separated list of property masks.</desc>
2130	</param>
2131	<param name="timeout" type="unsigned long" dir="in">
2132	<desc>
2133	Wait timeout in milliseconds.
2134	Specify -1 for an indefinite wait.
2135	</desc>
2136	</param>
2137	<param name="changed" type="wstring" dir="out">
2138	<desc>
2139	Comma separated list of properties that have been changed and caused
2140	this method to return to the caller.
2141	</desc>
2142	</param>
2143	<param name="values" type="wstring" dir="out">
2144	<desc>Reserved, not currently used.</desc>
2145	</param>
2146	</method>
2147
2148	<!--method name="createDHCPServerForInterface">
2149	<desc>
2150	Creates a dhcp server settings to be used for the given interface
2151	<result name="E_INVALIDARG">
2152	Host network interface @a name already exists.
2153	</result>
2154	</desc>
2155	<param name="interface" type="IHostNetworkInterface" dir="in">
2156	<desc>Network Interface</desc>
2157	</param>
2158	<param name="server" type="IDHCPServer" dir="out">
2159	<desc>Dhcp server settings</desc>
2160	</param>
2161	</method-->
2162
2163	<method name="createDHCPServer">
2164	<desc>
2165	Creates a dhcp server settings to be used for the given internal network name
2166	<result name="E_INVALIDARG">
2167	Host network interface @a name already exists.
2168	</result>
2169	</desc>
2170	<param name="name" type="wstring" dir="in">
2171	<desc>server name</desc>
2172	</param>
2173	<param name="server" type="IDHCPServer" dir="return">
2174	<desc>Dhcp server settings</desc>
2175	</param>
2176	</method>
2177
2178	<method name="findDHCPServerByNetworkName">
2179	<desc>
2180	Searches a dhcp server settings to be used for the given internal network name
2181	<result name="E_INVALIDARG">
2182	Host network interface @a name already exists.
2183	</result>
2184
2185	</desc>
2186	<param name="name" type="wstring" dir="in">
2187	<desc>server name</desc>
2188	</param>
2189	<param name="server" type="IDHCPServer" dir="return">
2190	<desc>Dhcp server settings</desc>
2191	</param>
2192	</method>
2193
2194	<!--method name="findDHCPServerForInterface">
2195	<desc>
2196	Searches a dhcp server settings to be used for the given interface
2197	<result name="E_INVALIDARG">
2198	Host network interface @a name already exists.
2199	</result>
2200	</desc>
2201	<param name="interface" type="IHostNetworkInterface" dir="in">
2202	<desc>Network Interface</desc>
2203	</param>
2204	<param name="server" type="IDHCPServer" dir="out">
2205	<desc>Dhcp server settings</desc>
2206	</param>
2207	</method-->
2208
2209	<method name="removeDHCPServer">
2210	<desc>
2211	Removes the dhcp server settings
2212	<result name="E_INVALIDARG">
2213	Host network interface @a name already exists.
2214	</result>
2215	</desc>
2216	<param name="server" type="IDHCPServer" dir="in">
2217	<desc>Dhcp server settings to be removed</desc>
2218	</param>
2219	</method>
2220
2221
2222	<method name="checkFirmwarePresent">
2223	<desc>
2224	Check if this VirtualBox installation has a firmware
2225	of the given type available, either system-wide or per-user.
2226	Optionally, this may return a hint where this firmware can be
2227	downloaded from.
2228	</desc>
2229	<param name="firmwareType" type="FirmwareType" dir="in">
2230	<desc>
2231	Type of firmware to check.
2232	</desc>
2233	</param>
2234	<param name="version" type="wstring" dir="in">
2235	<desc>Expected version number, usually empty string (presently ignored).</desc>
2236	</param>
2237
2238	<param name="url" type="wstring" dir="out">
2239	<desc>
2240	Suggested URL to download this firmware from.
2241	</desc>
2242	</param>
2243
2244	<param name="file" type="wstring" dir="out">
2245	<desc>
2246	Filename of firmware, only valid if result == TRUE.
2247	</desc>
2248	</param>
2249
2250	<param name="result" type="boolean" dir="return">
2251	<desc>If firmware of this type and version is available.</desc>
2252	</param>
2253	</method>
2254
2255	</interface>
2256
2257	<!--
2258	// IVFSExplorer
2259	/////////////////////////////////////////////////////////////////////////
2260	-->
2261
2262	<enum
2263	name="VFSType"
2264	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2265	>
2266	<desc>
2267	Virtual file systems supported by VFSExplorer.
2268	</desc>
2269
2270	<const name="File" value="1" />
2271	<const name="Cloud" value="2" />
2272	<const name="S3" value="3" />
2273	<const name="WebDav" value="4" />
2274	</enum>
2275
2276	<enum
2277	name="VFSFileType"
2278	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2279	>
2280	<desc>
2281	File types known by VFSExplorer.
2282	</desc>
2283
2284	<const name="Unknown" value="1" />
2285	<const name="Fifo" value="2" />
2286	<const name="DevChar" value="3" />
2287	<const name="Directory" value="4" />
2288	<const name="DevBlock" value="5" />
2289	<const name="File" value="6" />
2290	<const name="SymLink" value="7" />
2291	<const name="Socket" value="8" />
2292	<const name="WhiteOut" value="9" />
2293	</enum>
2294
2295	<interface
2296	name="IVFSExplorer" extends="$unknown"
2297	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2298	wsmap="managed"
2299	>
2300	<desc>
2301	The VFSExplorer interface unifies access to different file system
2302	types. This includes local file systems as well remote file systems like
2303	S3. For a list of supported types see <link to="VFSType" />.
2304	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2305	</desc>
2306
2307	<attribute name="path" type="wstring" readonly="yes">
2308	<desc>Returns the current path in the virtual file system.</desc>
2309	</attribute>
2310
2311	<attribute name="type" type="VFSType" readonly="yes">
2312	<desc>Returns the file system type which is currently in use.</desc>
2313	</attribute>
2314
2315	<method name="update">
2316	<desc>Updates the internal list of files/directories from the
2317	current directory level. Use <link to="#entryList" /> to get the full list
2318	after a call to this method.</desc>
2319
2320	<param name="aProgress" type="IProgress" dir="return">
2321	<desc>Progress object to track the operation completion.</desc>
2322	</param>
2323	</method>
2324
2325	<method name="cd">
2326	<desc>Change the current directory level.</desc>
2327
2328	<param name="aDir" type="wstring" dir="in">
2329	<desc>The name of the directory to go in.</desc>
2330	</param>
2331
2332	<param name="aProgress" type="IProgress" dir="return">
2333	<desc>Progress object to track the operation completion.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="cdUp">
2338	<desc>Go one directory upwards from the current directory level.</desc>
2339
2340	<param name="aProgress" type="IProgress" dir="return">
2341	<desc>Progress object to track the operation completion.</desc>
2342	</param>
2343	</method>
2344
2345	<method name="entryList">
2346	<desc>Returns a list of files/directories after a call to <link
2347	to="#update" />. The user is responsible for keeping this internal
2348	list up do date.</desc>
2349
2350	<param name="aNames" type="wstring" safearray="yes" dir="out">
2351	<desc>The list of names for the entries.</desc>
2352	</param>
2353
2354	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2355	<desc>The list of types for the entries.</desc>
2356	</param>
2357	</method>
2358
2359	<method name="exists">
2360	<desc>Checks if the given file list exists in the current directory
2361	level.</desc>
2362
2363	<param name="aNames" type="wstring" safearray="yes" dir="in">
2364	<desc>The names to check.</desc>
2365	</param>
2366
2367	<param name="aExists" type="wstring" safearray="yes" dir="return">
2368	<desc>The names which exist.</desc>
2369	</param>
2370	</method>
2371
2372	<method name="remove">
2373	<desc>Deletes the given files in the current directory level.</desc>
2374
2375	<param name="aNames" type="wstring" safearray="yes" dir="in">
2376	<desc>The names to remove.</desc>
2377	</param>
2378
2379	<param name="aProgress" type="IProgress" dir="return">
2380	<desc>Progress object to track the operation completion.</desc>
2381	</param>
2382	</method>
2383
2384	</interface>
2385
2386	<!--
2387	// IAppliance
2388	/////////////////////////////////////////////////////////////////////////
2389	-->
2390
2391	<interface
2392	name="IAppliance" extends="$unknown"
2393	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2394	wsmap="managed"
2395	>
2396	<desc>
2397	Represents a platform-independent appliance in OVF format. An instance of this is returned
2398	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2399	virtual machines within an appliance with VirtualBox.
2400
2401	The OVF standard suggests two different physical file formats:
2402
2403	<ol>
2404	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2405	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2406	this descriptor file references other files such as disk images, as OVF appliances typically
2407	do, those additional files must be in the same directory as the descriptor file.</li>
2408
2409	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2410	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2411	files and optionally other files.
2412
2413	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2414	be added with a later version.</li>
2415	</ol>
2416
2417	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2418	<link to="IMachine" /> involves the following sequence of API calls:
2419
2420	<ol>
2421	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2422	</li>
2423
2424	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2425	would like to import. So long as this file is syntactically valid, this will succeed
2426	and fill the appliance object with the parsed data from the OVF file.
2427	</li>
2428
2429	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2430	contents of the IAppliance attributes accordingly. These can be inspected by a
2431	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2432	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2433	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2434	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2435	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2436	The GUI can then give the user the option to confirm and/or change these suggestions.
2437	</li>
2438
2439	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2440	virtual system (machine) to override the suggestions made by the interpret() routine.
2441	</li>
2442
2443	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2444	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2445	virtual system descriptions. After this call suceeded, the UUIDs of the machines created
2446	can be found in the <link to="#machines" /> array attribute.
2447	</li>
2448	</ol>
2449
2450	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2451
2452	<ol>
2453	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2454	an empty IAppliance object.
2455	</li>
2456
2457	<li>For each machine you would like to export, call <link to="IMachine::export" />
2458	with the IAppliance object you just created. Each such call creates one instance of
2459	<link to="IVirtualSystemDescription" /> inside the appliance.
2460	</li>
2461
2462	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2463	virtual system (machine) to override the suggestions made by the export() routine.
2464	</li>
2465
2466	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2467	file written.</li>
2468	</ol>
2469
2470	</desc>
2471
2472	<attribute name="path" type="wstring" readonly="yes">
2473	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2474	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2475	<link to="#write" /> (for export).
2476	This attribute is empty until one of these methods has been called.
2477	</desc>
2478	</attribute>
2479
2480	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2481	<desc>
2482	Array of virtual disk definitions. One such description exists for each
2483	disk definition in the OVF; each string array item represents one such piece of
2484	disk information, with the information fields separated by tab (\t) characters.
2485
2486	The caller should be prepared for additional fields being appended to
2487	this string in future versions of VirtualBox and therefore check for
2488	the number of tabs in the strings returned.
2489
2490	In the current version, the following eight fields are returned per string
2491	in the array:
2492
2493	<ol>
2494	<li>Disk ID (unique string identifier given to disk)</li>
2495
2496	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2497
2498	<li>Populated size (optional unsigned integer indicating the current size of the
2499	disk; can be approximate; -1 if unspecified)</li>
2500
2501	<li>Format (string identifying the disk format, typically
2502	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2503
2504	<li>Reference (where to find the disk image, typically a file name; if empty,
2505	then the disk should be created on import)</li>
2506
2507	<li>Image size (optional unsigned integer indicating the size of the image,
2508	which need not necessarily be the same as the values specified above, since
2509	the image may be compressed or sparse; -1 if not specified)</li>
2510
2511	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2512	presently unsupported and always -1)</li>
2513
2514	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2515	</ol>
2516	</desc>
2517	</attribute>
2518
2519	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2520	<desc> Array of virtual system descriptions. One such description is created
2521	for each virtual system (machine) found in the OVF.
2522	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2523	(for export) has been called.
2524	</desc>
2525	</attribute>
2526
2527	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2528	<desc>
2529	Contains the UUIDs of the machines created from the information in this appliances. This is only
2530	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2531	succeeded.
2532	</desc>
2533	</attribute>
2534
2535	<method name="read">
2536	<desc>
2537	Reads an OVF file into the appliance object.
2538
2539	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2540	mere fact that this method returns successfully does not mean that VirtualBox supports all
2541	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2542	</desc>
2543	<param name="file" type="wstring" dir="in">
2544	<desc>
2545	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2546	on whether the appliance is distributed as a set of files or as a single file, respectively).
2547	</desc>
2548	</param>
2549	<param name="aProgress" type="IProgress" dir="return">
2550	<desc>Progress object to track the operation completion.</desc>
2551	</param>
2552	</method>
2553
2554	<method name="interpret">
2555	<desc>
2556	Interprets the OVF data that was read when the appliance was constructed. After
2557	calling this method, one can inspect the
2558	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2559	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2560	the appliance.
2561
2562	Calling this method is the second step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	After calling this method, one should call <link to="#getWarnings" /> to find out
2566	if problems were encountered during the processing which might later lead to
2567	errors.
2568	</desc>
2569	</method>
2570
2571	<method name="importMachines">
2572	<desc>
2573	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2574	and other interfaces that match the information contained in the appliance as
2575	closely as possible, as represented by the import instructions in the
2576	<link to="#virtualSystemDescriptions" /> array.
2577
2578	Calling this method is the final step of importing an appliance into VirtualBox;
2579	see <link to="IAppliance" /> for an overview.
2580
2581	Since importing the appliance will most probably involve copying and converting
2582	disk images, which can take a long time, this method operates asynchronously and
2583	returns an IProgress object to allow the caller to monitor the progress.
2584
2585	After the import succeeded, the UUIDs of the IMachine instances created can be
2586	retrieved from the <link to="#machines" /> array attribute.
2587	</desc>
2588
2589	<param name="aProgress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="createVFSExplorer">
2595	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2596
2597	<param name="aUri" type="wstring" dir="in">
2598	<desc>The URI describing the file system to use.</desc>
2599	</param>
2600
2601	<param name="aExplorer" type="IVFSExplorer" dir="return">
2602	<desc></desc>
2603	</param>
2604	</method>
2605
2606	<method name="write">
2607	<desc>
2608	Writes the contents of the appliance exports into a new OVF file.
2609
2610	Calling this method is the final step of exporting an appliance from VirtualBox;
2611	see <link to="IAppliance" /> for an overview.
2612
2613	Since exporting the appliance will most probably involve copying and converting
2614	disk images, which can take a long time, this method operates asynchronously and
2615	returns an IProgress object to allow the caller to monitor the progress.
2616	</desc>
2617	<param name="format" type="wstring" dir="in">
2618	<desc>
2619	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2620	future versions of VirtualBox may support additional formats.
2621	</desc>
2622	</param>
2623	<param name="manifest" type="boolean" dir="in">
2624	<desc>
2625	Indicate if the optional manifest file (.mf) should be written. The manifest file
2626	is used for integrity checks prior import.
2627	</desc>
2628	</param>
2629	<param name="path" type="wstring" dir="in">
2630	<desc>
2631	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2632	on whether the appliance is distributed as a set of files or as a single file, respectively).
2633	</desc>
2634	</param>
2635	<param name="progress" type="IProgress" dir="return">
2636	<desc>Progress object to track the operation completion.</desc>
2637	</param>
2638	</method>
2639
2640	<method name="getWarnings">
2641	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2642
2643	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2644	<desc></desc>
2645	</param>
2646	</method>
2647
2648	</interface>
2649
2650	<enum
2651	name="VirtualSystemDescriptionType"
2652	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2653	>
2654	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2655	a configuration value.</desc>
2656
2657	<const name="Ignore" value="1" />
2658	<const name="OS" value="2" />
2659	<const name="Name" value="3" />
2660	<const name="Product" value="4" />
2661	<const name="Vendor" value="5" />
2662	<const name="Version" value="6" />
2663	<const name="ProductUrl" value="7" />
2664	<const name="VendorUrl" value="8" />
2665	<const name="Description" value="9" />
2666	<const name="License" value="10" />
2667	<const name="Miscellaneous" value="11" />
2668	<const name="CPU" value="12" />
2669	<const name="Memory" value="13" />
2670	<const name="HardDiskControllerIDE" value="14" />
2671	<const name="HardDiskControllerSATA" value="15" />
2672	<const name="HardDiskControllerSCSI" value="16" />
2673	<const name="HardDiskControllerSAS" value="17" />
2674	<const name="HardDiskImage" value="18" />
2675	<const name="Floppy" value="19" />
2676	<const name="CDROM" value="20" />
2677	<const name="NetworkAdapter" value="21" />
2678	<const name="USBController" value="22" />
2679	<const name="SoundCard" value="23" />
2680
2681	</enum>
2682
2683	<enum
2684	name="VirtualSystemDescriptionValueType"
2685	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2686	>
2687	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2688	type to fetch.</desc>
2689
2690	<const name="Reference" value="1" />
2691	<const name="Original" value="2" />
2692	<const name="Auto" value="3" />
2693	<const name="ExtraConfig" value="4" />
2694
2695	</enum>
2696
2697	<interface
2698	name="IVirtualSystemDescription" extends="$unknown"
2699	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2700	wsmap="managed"
2701	>
2702
2703	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2704	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2705	<link to="IAppliance::interpret" /> has been called, that array contains information
2706	about how the virtual systems described in the OVF should best be imported into
2707	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2708	import an OVF into VirtualBox.
2709	</desc>
2710
2711	<attribute name="count" type="unsigned long" readonly="yes">
2712	<desc>Return the number of virtual system description entries.</desc>
2713	</attribute>
2714
2715	<method name="getDescription">
2716	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2717	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2718
2719	The list below identifies the value sets that are possible depending on the
2720	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2721	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2722	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2723	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2724	the @a aExtraConfigValues[] array item may also be used.
2725
2726	<ul>
2727	<li>
2728	"OS": the guest operating system type. There must be exactly one such array item on import. The
2729	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2730	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2731	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2732	</li>
2733	<li>
2734	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2735	if none is present on import, then an automatic name will be created from the operating system
2736	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
2737	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2738	<link to="IMachine" /> name that does not exist yet.
2739	</li>
2740	<li>
2741	"Description": an arbitrary description.
2742	</li>
2743	<li>
2744	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2745	code to display such a license for agreement; the Main API does not enforce any such policy.
2746	</li>
2747	<li>
2748	Miscellaneous: reserved for future use.
2749	</li>
2750	<li>
2751	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2752	</li>
2753	<li>
2754	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2755	is present on import, then VirtualBox will set a meaningful default based on the operating system
2756	type.
2757	</li>
2758	<li>
2759	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2760	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2761	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2762	writes into the OVF.
2763	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2764	type can use to specify which hard disk controller a virtual disk should be connected to.
2765	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2766	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2767	its virtual machines supports four channels (primary master, primary slave, secondary master,
2768	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2769	</li>
2770	<li>
2771	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2772	has no value in @a aOvfValues[] or @a aVBoxValues[].
2773	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2774	</li>
2775	<li>
2776	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2777	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2778	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2779	whereas VirtualBox considers it a class of storage controllers of its own; see
2780	<link to="StorageControllerType" />).
2781	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2782	</li>
2783	<li>
2784	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2785	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2786
2787	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2788	a path since the image file should be in the same location as the OVF file itself), whereas the
2789	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2790	hard disk image. This means that on import the image will be copied and converted from the
2791	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2792
2793	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2794	format: "controller=<index>;channel=<c>"
2795	In this string, <index> must be an integer specifying the hard disk controller to connect
2796	the image to. That number must be the index of an array item with one of the hard disk controller
2797	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2798	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2799	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2800	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2801	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2802	</li>
2803	<li>
2804	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2805	attachment information as with "HardDiskImage" items.
2806	</li>
2807	<li>
2808	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2809	attachment information as with "HardDiskImage" items.
2810	</li>
2811	<li>
2812	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2813	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2814	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2815	</li>
2816	<li>
2817	"USBController": a USB controller. There can be at most one such item. If and only if such an
2818	item ispresent, USB support will be enabled for the new virtual machine.
2819	</li>
2820	<li>
2821	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2822	present, sound support will be enabled for the new virtual machine. Note that the virtual
2823	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2824	may be different from the virtual soundcard expected by the appliance.
2825	</li>
2826	</ul>
2827
2828	</desc>
2829
2830	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2831	<desc></desc>
2832	</param>
2833
2834	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2835	<desc></desc>
2836	</param>
2837
2838	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2839	<desc></desc>
2840	</param>
2841
2842	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2843	<desc></desc>
2844	</param>
2845
2846	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2847	<desc></desc>
2848	</param>
2849
2850	</method>
2851
2852	<method name="getDescriptionByType">
2853	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2854	should be returned.</desc>
2855
2856	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2857	<desc></desc>
2858	</param>
2859
2860	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2861	<desc></desc>
2862	</param>
2863
2864	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2865	<desc></desc>
2866	</param>
2867
2868	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2869	<desc></desc>
2870	</param>
2871
2872	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2873	<desc></desc>
2874	</param>
2875
2876	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2877	<desc></desc>
2878	</param>
2879
2880	</method>
2881
2882	<method name="getValuesByType">
2883	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2884	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2885	values.</desc>
2886
2887	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2892	<desc></desc>
2893	</param>
2894
2895	<param name="aValues" type="wstring" dir="return" safearray="yes">
2896	<desc></desc>
2897	</param>
2898
2899	</method>
2900
2901	<method name="setFinalValues">
2902	<desc>
2903	This method allows the appliance's user to change the configuration for the virtual
2904	system descriptions. For each array item returned from <link to="#getDescription" />,
2905	you must pass in one boolean value and one configuration value.
2906
2907	Each item in the boolean array determines whether the particular configuration item
2908	should be enabled.
2909	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2910	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2911	and SoundCard.
2912
2913	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2914	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2915	the configuration remains unchanged. Please see the documentation for getDescription()
2916	for valid configuration values for the individual array item types. If the
2917	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2918	</desc>
2919
2920	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2921	<desc></desc>
2922	</param>
2923
2924	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2925	<desc></desc>
2926	</param>
2927
2928	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2929	<desc></desc>
2930	</param>
2931	</method>
2932
2933	<method name="addDescription">
2934	<desc>
2935	This method adds an additional description entry to the stack of already
2936	available descriptions for this virtual system. This is handy for writing
2937	values which aren't directly supported by VirtualBox. One example would
2938	be the License type of <link to="VirtualSystemDescriptionType" />.
2939	</desc>
2940
2941	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2942	<desc></desc>
2943	</param>
2944
2945	<param name="aVBoxValue" type="wstring" dir="in">
2946	<desc></desc>
2947	</param>
2948
2949	<param name="aExtraConfigValue" type="wstring" dir="in">
2950	<desc></desc>
2951	</param>
2952	</method>
2953	</interface>
2954
2955
2956	<!--
2957	// IMachine
2958	/////////////////////////////////////////////////////////////////////////
2959	-->
2960
2961	<interface
2962	name="IInternalMachineControl" extends="$unknown"
2963	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
2964	internal="yes"
2965	wsmap="suppress"
2966	>
2967	<method name="setRemoveSavedStateFile">
2968	<desc>
2969	Updates the flag whether the saved state file is removed on a
2970	machine state change from Saved to PoweredOff.
2971	</desc>
2972	<param name="aRemove" type="boolean" dir="in"/>
2973	</method>
2974
2975	<method name="updateState">
2976	<desc>
2977	Updates the VM state.
2978	<note>
2979	This operation will also update the settings file with the correct
2980	information about the saved state file and delete this file from disk
2981	when appropriate.
2982	</note>
2983	</desc>
2984	<param name="state" type="MachineState" dir="in"/>
2985	</method>
2986
2987	<method name="getIPCId">
2988	<param name="id" type="wstring" dir="return"/>
2989	</method>
2990
2991	<method name="beginPowerUp">
2992	<desc>
2993	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2994	gives it the progress object that should be part of any pending
2995	<link to="IMachine::launchVMProcess"/> operations. The progress
2996	object may be called back to reflect an early cancelation, so some care
2997	have to be taken with respect to any cancelation callbacks. The console
2998	object will call <link to="IInternalMachineControl::endPowerUp"/>
2999	to signal the completion of the progress object.
3000	</desc>
3001	<param name="aProgress" type="IProgress" dir="in" />
3002	</method>
3003
3004	<method name="endPowerUp">
3005	<desc>
3006	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3007	This method may query status information from the progress object it
3008	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3009	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3010	call in order to complete that progress object.
3011	</desc>
3012	<param name="result" type="long" dir="in"/>
3013	</method>
3014
3015	<method name="runUSBDeviceFilters">
3016	<desc>
3017	Asks the server to run USB devices filters of the associated
3018	machine against the given USB device and tell if there is
3019	a match.
3020	<note>
3021	Intended to be used only for remote USB devices. Local
3022	ones don't require to call this method (this is done
3023	implicitly by the Host and USBProxyService).
3024	</note>
3025	</desc>
3026	<param name="device" type="IUSBDevice" dir="in"/>
3027	<param name="matched" type="boolean" dir="out"/>
3028	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3029	</method>
3030
3031	<method name="captureUSBDevice">
3032	<desc>
3033	Requests a capture of the given host USB device.
3034	When the request is completed, the VM process will
3035	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3036	notification.
3037	</desc>
3038	<param name="id" type="uuid" mod="string" dir="in"/>
3039	</method>
3040
3041	<method name="detachUSBDevice">
3042	<desc>
3043	Notification that a VM is going to detach (@a done = @c false) or has
3044	already detached (@a done = @c true) the given USB device.
3045	When the @a done = @c true request is completed, the VM process will
3046	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3047	notification.
3048	<note>
3049	In the @a done = @c true case, the server must run its own filters
3050	and filters of all VMs but this one on the detached device
3051	as if it were just attached to the host computer.
3052	</note>
3053	</desc>
3054	<param name="id" type="uuid" mod="string" dir="in"/>
3055	<param name="done" type="boolean" dir="in"/>
3056	</method>
3057
3058	<method name="autoCaptureUSBDevices">
3059	<desc>
3060	Requests a capture all matching USB devices attached to the host.
3061	When the request is completed, the VM process will
3062	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3063	notification per every captured device.
3064	</desc>
3065	</method>
3066
3067	<method name="detachAllUSBDevices">
3068	<desc>
3069	Notification that a VM that is being powered down. The done
3070	parameter indicates whether which stage of the power down
3071	we're at. When @a done = @c false the VM is announcing its
3072	intentions, while when @a done = @c true the VM is reporting
3073	what it has done.
3074	<note>
3075	In the @a done = @c true case, the server must run its own filters
3076	and filters of all VMs but this one on all detach devices as
3077	if they were just attached to the host computer.
3078	</note>
3079	</desc>
3080	<param name="done" type="boolean" dir="in"/>
3081	</method>
3082
3083	<method name="onSessionEnd">
3084	<desc>
3085	Triggered by the given session object when the session is about
3086	to close normally.
3087	</desc>
3088	<param name="session" type="ISession" dir="in">
3089	<desc>Session that is being closed</desc>
3090	</param>
3091	<param name="progress" type="IProgress" dir="return">
3092	<desc>
3093	Used to wait until the corresponding machine is actually
3094	dissociated from the given session on the server.
3095	Returned only when this session is a direct one.
3096	</desc>
3097	</param>
3098	</method>
3099
3100	<method name="beginSavingState">
3101	<desc>
3102	Called by the VM process to inform the server it wants to
3103	save the current state and stop the VM execution.
3104	</desc>
3105	<param name="progress" type="IProgress" dir="in">
3106	<desc>
3107	Progress object created by the VM process to wait until
3108	the state is saved.
3109	</desc>
3110	</param>
3111	<param name="stateFilePath" type="wstring" dir="out">
3112	<desc>
3113	File path the VM process must save the execution state to.
3114	</desc>
3115	</param>
3116	</method>
3117
3118	<method name="endSavingState">
3119	<desc>
3120	Called by the VM process to inform the server that saving
3121	the state previously requested by #beginSavingState is either
3122	successfully finished or there was a failure.
3123
3124	<result name="VBOX_E_FILE_ERROR">
3125	Settings file not accessible.
3126	</result>
3127	<result name="VBOX_E_XML_ERROR">
3128	Could not parse the settings file.
3129	</result>
3130
3131	</desc>
3132
3133	<param name="success" type="boolean" dir="in">
3134	<desc>@c true to indicate success and @c false otherwise.
3135	</desc>
3136	</param>
3137	</method>
3138
3139	<method name="adoptSavedState">
3140	<desc>
3141	Gets called by IConsole::adoptSavedState.
3142	<result name="VBOX_E_FILE_ERROR">
3143	Invalid saved state file path.
3144	</result>
3145	</desc>
3146	<param name="savedStateFile" type="wstring" dir="in">
3147	<desc>Path to the saved state file to adopt.</desc>
3148	</param>
3149	</method>
3150
3151	<method name="beginTakingSnapshot">
3152	<desc>
3153	Called from the VM process to request from the server to perform the
3154	server-side actions of creating a snapshot (creating differencing images
3155	and the snapshot object).
3156
3157	<result name="VBOX_E_FILE_ERROR">
3158	Settings file not accessible.
3159	</result>
3160	<result name="VBOX_E_XML_ERROR">
3161	Could not parse the settings file.
3162	</result>
3163	</desc>
3164	<param name="initiator" type="IConsole" dir="in">
3165	<desc>The console object that initiated this call.</desc>
3166	</param>
3167	<param name="name" type="wstring" dir="in">
3168	<desc>Snapshot name.</desc>
3169	</param>
3170	<param name="description" type="wstring" dir="in">
3171	<desc>Snapshot description.</desc>
3172	</param>
3173	<param name="consoleProgress" type="IProgress" dir="in">
3174	<desc>
3175	Progress object created by the VM process tracking the
3176	snapshot's progress. This has the following sub-operations:
3177	<ul>
3178	<li>setting up (weight 1);</li>
3179	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3180	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3181	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3182	<li>finishing up (weight 1)</li>
3183	</ul>
3184	</desc>
3185	</param>
3186	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3187	<desc>
3188	Whether this is an online snapshot (i.e. the machine is running).
3189	</desc>
3190	</param>
3191	<param name="stateFilePath" type="wstring" dir="out">
3192	<desc>
3193	File path the VM process must save the execution state to.
3194	</desc>
3195	</param>
3196	</method>
3197
3198	<method name="endTakingSnapshot">
3199	<desc>
3200	Called by the VM process to inform the server that the snapshot
3201	previously requested by #beginTakingSnapshot is either
3202	successfully taken or there was a failure.
3203	</desc>
3204
3205	<param name="success" type="boolean" dir="in">
3206	<desc>@c true to indicate success and @c false otherwise</desc>
3207	</param>
3208	</method>
3209
3210	<method name="deleteSnapshot">
3211	<desc>
3212	Gets called by IConsole::deleteSnapshot.
3213	<result name="VBOX_E_INVALID_OBJECT_STATE">
3214	Snapshot has more than one child snapshot.
3215	</result>
3216	</desc>
3217	<param name="initiator" type="IConsole" dir="in">
3218	<desc>The console object that initiated this call.</desc>
3219	</param>
3220	<param name="id" type="uuid" mod="string" dir="in">
3221	<desc>UUID of the snapshot to delete.</desc>
3222	</param>
3223	<param name="machineState" type="MachineState" dir="out">
3224	<desc>New machine state after this operation is started.</desc>
3225	</param>
3226	<param name="progress" type="IProgress" dir="return">
3227	<desc>Progress object to track the operation completion.</desc>
3228	</param>
3229	</method>
3230
3231	<method name="finishOnlineMergeMedium">
3232	<desc>
3233	Gets called by IConsole::onlineMergeMedium.
3234	</desc>
3235	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3236	<desc>The medium attachment which needs to be cleaned up.</desc>
3237	</param>
3238	<param name="source" type="IMedium" dir="in">
3239	<desc>Merge source medium.</desc>
3240	</param>
3241	<param name="target" type="IMedium" dir="in">
3242	<desc>Merge target medium.</desc>
3243	</param>
3244	<param name="mergeForward" type="boolean" dir="in">
3245	<desc>Merge direction.</desc>
3246	</param>
3247	<param name="parentForTarget" type="IMedium" dir="in">
3248	<desc>For forward merges: new parent for target medium.</desc>
3249	</param>
3250	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3251	<desc>For backward merges: list of media which need their parent UUID
3252	updated.</desc>
3253	</param>
3254	</method>
3255
3256	<method name="restoreSnapshot">
3257	<desc>
3258	Gets called by IConsole::RestoreSnapshot.
3259	</desc>
3260	<param name="initiator" type="IConsole" dir="in">
3261	<desc>The console object that initiated this call.</desc>
3262	</param>
3263	<param name="snapshot" type="ISnapshot" dir="in">
3264	<desc>The snapshot to restore the VM state from.</desc>
3265	</param>
3266	<param name="machineState" type="MachineState" dir="out">
3267	<desc>New machine state after this operation is started.</desc>
3268	</param>
3269	<param name="progress" type="IProgress" dir="return">
3270	<desc>Progress object to track the operation completion.</desc>
3271	</param>
3272	</method>
3273
3274	<method name="pullGuestProperties">
3275	<desc>
3276	Get the list of the guest properties matching a set of patterns along
3277	with their values, time stamps and flags and give responsibility for
3278	managing properties to the console.
3279	</desc>
3280	<param name="name" type="wstring" dir="out" safearray="yes">
3281	<desc>
3282	The names of the properties returned.
3283	</desc>
3284	</param>
3285	<param name="value" type="wstring" dir="out" safearray="yes">
3286	<desc>
3287	The values of the properties returned. The array entries match the
3288	corresponding entries in the @a name array.
3289	</desc>
3290	</param>
3291	<param name="timestamp" type="long long" dir="out" safearray="yes">
3292	<desc>
3293	The time stamps of the properties returned. The array entries match
3294	the corresponding entries in the @a name array.
3295	</desc>
3296	</param>
3297	<param name="flags" type="wstring" dir="out" safearray="yes">
3298	<desc>
3299	The flags of the properties returned. The array entries match the
3300	corresponding entries in the @a name array.
3301	</desc>
3302	</param>
3303	</method>
3304
3305	<method name="pushGuestProperty">
3306	<desc>
3307	Update a single guest property in IMachine.
3308	</desc>
3309	<param name="name" type="wstring" dir="in">
3310	<desc>
3311	The name of the property to be updated.
3312	</desc>
3313	</param>
3314	<param name="value" type="wstring" dir="in">
3315	<desc>
3316	The value of the property.
3317	</desc>
3318	</param>
3319	<param name="timestamp" type="long long" dir="in">
3320	<desc>
3321	The timestamp of the property.
3322	</desc>
3323	</param>
3324	<param name="flags" type="wstring" dir="in">
3325	<desc>
3326	The flags of the property.
3327	</desc>
3328	</param>
3329	</method>
3330
3331	<method name="lockMedia">
3332	<desc>
3333	Locks all media attached to the machine for writing and parents of
3334	attached differencing media (if any) for reading. This operation is
3335	atomic so that if it fails no media is actually locked.
3336
3337	This method is intended to be called when the machine is in Starting or
3338	Restoring state. The locked media will be automatically unlocked when
3339	the machine is powered off or crashed.
3340	</desc>
3341	</method>
3342	<method name="unlockMedia">
3343	<desc>
3344	Unlocks all media previously locked using
3345	<link to="IInternalMachineControl::lockMedia"/>.
3346
3347	This method is intended to be used with teleportation so that it is
3348	possible to teleport between processes on the same machine.
3349	</desc>
3350	</method>
3351	</interface>
3352
3353	<interface
3354	name="IBIOSSettings" extends="$unknown"
3355	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3356	wsmap="managed"
3357	>
3358	<desc>
3359	The IBIOSSettings interface represents BIOS settings of the virtual
3360	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3361	</desc>
3362	<attribute name="logoFadeIn" type="boolean">
3363	<desc>Fade in flag for BIOS logo animation.</desc>
3364	</attribute>
3365
3366	<attribute name="logoFadeOut" type="boolean">
3367	<desc>Fade out flag for BIOS logo animation.</desc>
3368	</attribute>
3369
3370	<attribute name="logoDisplayTime" type="unsigned long">
3371	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3372	</attribute>
3373
3374	<attribute name="logoImagePath" type="wstring">
3375	<desc>
3376	Local file system path for external BIOS splash image. Empty string
3377	means the default image is shown on boot.
3378	</desc>
3379	</attribute>
3380
3381	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3382	<desc>Mode of the BIOS boot device menu.</desc>
3383	</attribute>
3384
3385	<attribute name="ACPIEnabled" type="boolean">
3386	<desc>ACPI support flag.</desc>
3387	</attribute>
3388
3389	<attribute name="IOAPICEnabled" type="boolean">
3390	<desc>
3391	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3392	and support IRQs above 15.
3393	</desc>
3394	</attribute>
3395
3396	<attribute name="timeOffset" type="long long">
3397	<desc>
3398	Offset in milliseconds from the host system time. This allows for
3399	guests running with a different system date/time than the host.
3400	It is equivalent to setting the system date/time in the BIOS except
3401	it is not an absolute value but a relative one. Guest Additions
3402	time synchronization honors this offset.
3403	</desc>
3404	</attribute>
3405
3406	<attribute name="PXEDebugEnabled" type="boolean">
3407	<desc>
3408	PXE debug logging flag. If set, VirtualBox will write extensive
3409	PXE trace information to the release log.
3410	</desc>
3411	</attribute>
3412
3413	</interface>
3414
3415	<enum name="CleanupMode"
3416	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3417	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3418	</desc>
3419	<const name="UnregisterOnly" value="1">
3420	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3421	</const>
3422	<const name="DetachAllReturnNone" value="2">
3423	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3424	</const>
3425	<const name="DetachAllReturnHardDisksOnly" value="3">
3426	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3427	</const>
3428	<const name="Full" value="4">
3429	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3430	</const>
3431	</enum>
3432
3433	<interface
3434	name="IMachine" extends="$unknown"
3435	uuid="5c91359b-5bdb-4518-9bd1-5f2c50a3c129"
3436	wsmap="managed"
3437	>
3438	<desc>
3439	The IMachine interface represents a virtual machine, or guest, created
3440	in VirtualBox.
3441
3442	This interface is used in two contexts. First of all, a collection of
3443	objects implementing this interface is stored in the
3444	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3445	machines that are currently registered with this VirtualBox
3446	installation. Also, once a session has been opened for the given virtual
3447	machine (e.g. the virtual machine is running), the machine object
3448	associated with the open session can be queried from the session object;
3449	see <link to="ISession"/> for details.
3450
3451	The main role of this interface is to expose the settings of the virtual
3452	machine and provide methods to change various aspects of the virtual
3453	machine's configuration. For machine objects stored in the
3454	<link to="IVirtualBox::machines"/> collection, all attributes are
3455	read-only unless explicitly stated otherwise in individual attribute
3456	and method descriptions.
3457
3458	In order to change a machine setting, a session for this machine must be
3459	opened using one of the <link to="IMachine::lockMachine" /> or
3460	<link to="IMachine::launchVMProcess"/> methods. After the
3461	machine has been successfully locked for a session, a mutable machine object
3462	needs to be queried from the session object and then the desired settings
3463	changes can be applied to the returned object using IMachine attributes and
3464	methods. See the <link to="ISession"/> interface description for more
3465	information about sessions.
3466
3467	Note that IMachine does not provide methods to control virtual machine
3468	execution (such as start the machine, or power it down) -- these methods
3469	are grouped in a separate interface called <link to="IConsole" />.
3470
3471	<see>ISession, IConsole</see>
3472	</desc>
3473
3474	<attribute name="parent" type="IVirtualBox" readonly="yes">
3475	<desc>Associated parent object.</desc>
3476	</attribute>
3477
3478	<attribute name="accessible" type="boolean" readonly="yes">
3479	<desc>
3480	Whether this virtual machine is currently accessible or not.
3481
3482	A machine is always deemed accessible unless it is registered <i>and</i>
3483	its settings file cannot be read or parsed (either because the file itself
3484	is unavailable or has invalid XML contents).
3485
3486	Every time this property is read, the accessibility state of
3487	this machine is re-evaluated. If the returned value is @c false,
3488	the <link to="#accessError"/> property may be used to get the
3489	detailed error information describing the reason of
3490	inaccessibility, including XML error messages.
3491
3492	When the machine is inaccessible, only the following properties
3493	can be used on it:
3494	<ul>
3495	<li><link to="#parent"/></li>
3496	<li><link to="#id"/></li>
3497	<li><link to="#settingsFilePath"/></li>
3498	<li><link to="#accessible"/></li>
3499	<li><link to="#accessError"/></li>
3500	</ul>
3501
3502	An attempt to access any other property or method will return
3503	an error.
3504
3505	The only possible action you can perform on an inaccessible
3506	machine is to unregister it using the
3507	<link to="IMachine::unregister"/> call (or, to check
3508	for the accessibility state once more by querying this
3509	property).
3510
3511	<note>
3512	In the current implementation, once this property returns
3513	@c true, the machine will never become inaccessible
3514	later, even if its settings file cannot be successfully
3515	read/written any more (at least, until the VirtualBox
3516	server is restarted). This limitation may be removed in
3517	future releases.
3518	</note>
3519	</desc>
3520	</attribute>
3521
3522	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3523	<desc>
3524	Error information describing the reason of machine
3525	inaccessibility.
3526
3527	Reading this property is only valid after the last call to
3528	<link to="#accessible"/> returned @c false (i.e. the
3529	machine is currently unaccessible). Otherwise, a @c null
3530	IVirtualBoxErrorInfo object will be returned.
3531	</desc>
3532	</attribute>
3533
3534	<attribute name="name" type="wstring">
3535	<desc>
3536	Name of the virtual machine.
3537
3538	Besides being used for human-readable identification purposes
3539	everywhere in VirtualBox, the virtual machine name is also used
3540	as a name of the machine's settings file and as a name of the
3541	subdirectory this settings file resides in. Thus, every time you
3542	change the value of this property, the settings file will be
3543	renamed once you call <link to="#saveSettings"/> to confirm the
3544	change. The containing subdirectory will be also renamed, but
3545	only if it has exactly the same name as the settings file
3546	itself prior to changing this property (for backward compatibility
3547	with previous API releases). The above implies the following
3548	limitations:
3549	<ul>
3550	<li>The machine name cannot be empty.</li>
3551	<li>The machine name can contain only characters that are valid
3552	file name characters according to the rules of the file
3553	system used to store VirtualBox configuration.</li>
3554	<li>You cannot have two or more machines with the same name
3555	if they use the same subdirectory for storing the machine
3556	settings files.</li>
3557	<li>You cannot change the name of the machine if it is running,
3558	or if any file in the directory containing the settings file
3559	is being used by another running machine or by any other
3560	process in the host operating system at a time when
3561	<link to="#saveSettings"/> is called.
3562	</li>
3563	</ul>
3564	If any of the above limitations are hit, <link to="#saveSettings"/>
3565	will return an appropriate error message explaining the exact
3566	reason and the changes you made to this machine will not be saved.
3567	</desc>
3568	</attribute>
3569
3570	<attribute name="description" type="wstring">
3571	<desc>
3572	Description of the virtual machine.
3573
3574	The description attribute can contain any text and is
3575	typically used to describe the hardware and software
3576	configuration of the virtual machine in detail (i.e. network
3577	settings, versions of the installed software and so on).
3578	</desc>
3579	</attribute>
3580
3581	<attribute name="id" type="uuid" mod="string" readonly="yes">
3582	<desc>UUID of the virtual machine.</desc>
3583	</attribute>
3584
3585	<attribute name="OSTypeId" type="wstring">
3586	<desc>
3587	User-defined identifier of the Guest OS type.
3588	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3589	an IGuestOSType object representing details about the given
3590	Guest OS type.
3591	<note>
3592	This value may differ from the value returned by
3593	<link to="IGuest::OSTypeId"/> if Guest Additions are
3594	installed to the guest OS.
3595	</note>
3596	</desc>
3597	</attribute>
3598
3599	<attribute name="HardwareVersion" type="wstring">
3600	<desc>Hardware version identifier. Internal use only for now.</desc>
3601	</attribute>
3602
3603	<attribute name="hardwareUUID" type="uuid" mod="string">
3604	<desc>
3605	The UUID presented to the guest via memory tables, hardware and guest
3606	properties. For most VMs this is the same as the @a id, but for VMs
3607	which have been cloned or teleported it may be the same as the source
3608	VM. This latter is because the guest shouldn't notice that it was
3609	cloned or teleported.
3610	</desc>
3611	</attribute>
3612
3613	<attribute name="CPUCount" type="unsigned long">
3614	<desc>Number of virtual CPUs in the VM.</desc>
3615	</attribute>
3616
3617	<attribute name="CPUHotPlugEnabled" type="boolean">
3618	<desc>
3619	This setting determines whether VirtualBox allows CPU
3620	hotplugging for this machine.</desc>
3621	</attribute>
3622
3623	<attribute name="CPUExecutionCap" type="unsigned long">
3624	<desc>
3625	Means to limit the number of CPU cycles a guest can use. The unit
3626	is percentage of host CPU cycles per second. The valid range
3627	is 1 - 100. 100 (the default) implies no limit.
3628	</desc>
3629	</attribute>
3630
3631	<attribute name="memorySize" type="unsigned long">
3632	<desc>System memory size in megabytes.</desc>
3633	</attribute>
3634
3635	<attribute name="memoryBalloonSize" type="unsigned long">
3636	<desc>Memory balloon size in megabytes.</desc>
3637	</attribute>
3638
3639	<attribute name="PageFusionEnabled" type="boolean">
3640	<desc>
3641	This setting determines whether VirtualBox allows page
3642	fusion for this machine (64 bits host only).
3643	</desc>
3644	</attribute>
3645
3646	<attribute name="VRAMSize" type="unsigned long">
3647	<desc>Video memory size in megabytes.</desc>
3648	</attribute>
3649
3650	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3651	<desc>
3652	This setting determines whether VirtualBox allows this machine to make
3653	use of the 3D graphics support available on the host.</desc>
3654	</attribute>
3655
3656	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3657	<desc>
3658	This setting determines whether VirtualBox allows this machine to make
3659	use of the 2D video acceleration support available on the host.</desc>
3660	</attribute>
3661
3662	<attribute name="monitorCount" type="unsigned long">
3663	<desc>
3664	Number of virtual monitors.
3665	<note>
3666	Only effective on Windows XP and later guests with
3667	Guest Additions installed.
3668	</note>
3669	</desc>
3670	</attribute>
3671
3672	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3673	<desc>Object containing all BIOS settings.</desc>
3674	</attribute>
3675
3676	<attribute name="firmwareType" type="FirmwareType">
3677	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3678	bootstrap in this VM.</desc>
3679	</attribute>
3680
3681	<attribute name="pointingHidType" type="PointingHidType">
3682	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3683	The default is typically "PS2Mouse" but can vary depending on the
3684	requirements of the guest operating system.</desc>
3685	</attribute>
3686
3687	<attribute name="keyboardHidType" type="KeyboardHidType">
3688	<desc>Type of keyboard HID used in this VM.
3689	The default is typically "PS2Keyboard" but can vary depending on the
3690	requirements of the guest operating system.</desc>
3691	</attribute>
3692
3693	<attribute name="hpetEnabled" type="boolean">
3694	<desc>This attribute controls if High Precision Event Timer (HPET) is
3695	enabled in this VM. Use this property if you want to provide guests
3696	with additional time source, or if guest requires HPET to function correctly.
3697	Default is false.</desc>
3698	</attribute>
3699
3700	<attribute name="chipsetType" type="ChipsetType">
3701	<desc>Chipset type used in this VM.</desc>
3702	</attribute>
3703
3704	<attribute name="snapshotFolder" type="wstring">
3705	<desc>
3706	Full path to the directory used to store snapshot data
3707	(differencing media and saved state files) of this machine.
3708
3709	The initial value of this property is
3710	<tt><</tt><link to="#settingsFilePath">
3711	path_to_settings_file</link><tt>>/<</tt>
3712	<link to="#id">machine_uuid</link>
3713	<tt>></tt>.
3714
3715	Currently, it is an error to try to change this property on
3716	a machine that has snapshots (because this would require to
3717	move possibly large files to a different location).
3718	A separate method will be available for this purpose later.
3719
3720	<note>
3721	Setting this property to @c null or to an empty string will restore
3722	the initial value.
3723	</note>
3724	<note>
3725	When setting this property, the specified path can be
3726	absolute (full path) or relative to the directory where the
3727	<link to="#settingsFilePath">machine settings file</link>
3728	is located. When reading this property, a full path is
3729	always returned.
3730	</note>
3731	<note>
3732	The specified path may not exist, it will be created
3733	when necessary.
3734	</note>
3735	</desc>
3736	</attribute>
3737
3738	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
3739	<desc>VRDP server object.</desc>
3740	</attribute>
3741
3742	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3743	<desc>Array of media attached to this machine.</desc>
3744	</attribute>
3745
3746	<attribute name="USBController" type="IUSBController" readonly="yes">
3747	<desc>
3748	Associated USB controller object.
3749
3750	<note>
3751	If USB functionality is not available in the given edition of
3752	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3753	</note>
3754	</desc>
3755	</attribute>
3756
3757	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3758	<desc>Associated audio adapter, always present.</desc>
3759	</attribute>
3760
3761	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3762	<desc>Array of storage controllers attached to this machine.</desc>
3763	</attribute>
3764
3765	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3766	<desc>
3767	Full name of the file containing machine settings data.
3768	</desc>
3769	</attribute>
3770
3771	<attribute name="settingsModified" type="boolean" readonly="yes">
3772	<desc>
3773	Whether the settings of this machine have been modified
3774	(but neither yet saved nor discarded).
3775	<note>
3776	Reading this property is only valid on instances returned
3777	by <link to="ISession::machine"/> and on new machines
3778	created by <link to="IVirtualBox::createMachine"/> or opened
3779	by <link to="IVirtualBox::openMachine"/> but not
3780	yet registered, or on unregistered machines after calling
3781	<link to="IMachine::unregister"/>. For all other
3782	cases, the settings can never be modified.
3783	</note>
3784	<note>
3785	For newly created unregistered machines, the value of this
3786	property is always @c true until <link to="#saveSettings"/>
3787	is called (no matter if any machine settings have been
3788	changed after the creation or not). For opened machines
3789	the value is set to @c false (and then follows to normal rules).
3790	</note>
3791	</desc>
3792	</attribute>
3793
3794	<attribute name="sessionState" type="SessionState" readonly="yes">
3795	<desc>Current session state for this machine.</desc>
3796	</attribute>
3797
3798	<attribute name="sessionType" type="wstring" readonly="yes">
3799	<desc>
3800	Type of the session. If <link to="#sessionState"/> is
3801	Spawning or Locked, this attribute contains the
3802	same value as passed to the
3803	<link to="IMachine::launchVMProcess"/> method in the
3804	@a type parameter. If the session was used with
3805	<link to="IMachine::lockMachine" />, or if
3806	<link to="#sessionState"/> is SessionClosed, the value of this
3807	attribute is an empty string.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3812	<desc>
3813	Identifier of the session process. This attribute contains the
3814	platform-dependent identifier of the process whose session was
3815	used with <link to="IMachine::lockMachine" /> call. The returned
3816	value is only valid if <link to="#sessionState"/> is Locked or
3817	Unlocking by the time this property is read.
3818	</desc>
3819	</attribute>
3820
3821	<attribute name="state" type="MachineState" readonly="yes">
3822	<desc>Current execution state of this machine.</desc>
3823	</attribute>
3824
3825	<attribute name="lastStateChange" type="long long" readonly="yes">
3826	<desc>
3827	Time stamp of the last execution state change,
3828	in milliseconds since 1970-01-01 UTC.
3829	</desc>
3830	</attribute>
3831
3832	<attribute name="stateFilePath" type="wstring" readonly="yes">
3833	<desc>
3834	Full path to the file that stores the execution state of
3835	the machine when it is in the <link to="MachineState_Saved"/> state.
3836	<note>
3837	When the machine is not in the Saved state, this attribute is
3838	an empty string.
3839	</note>
3840	</desc>
3841	</attribute>
3842
3843	<attribute name="logFolder" type="wstring" readonly="yes">
3844	<desc>
3845	Full path to the folder that stores a set of rotated log files
3846	recorded during machine execution. The most recent log file is
3847	named <tt>VBox.log</tt>, the previous log file is
3848	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3849	in the current version).
3850	</desc>
3851	</attribute>
3852
3853	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3854	<desc>
3855	Current snapshot of this machine. This is @c null if the machine
3856	currently has no snapshots. If it is not @c null, then it was
3857	set by one of <link to="IConsole::takeSnapshot" />,
3858	<link to="IConsole::deleteSnapshot" />
3859	or <link to="IConsole::restoreSnapshot" />, depending on which
3860	was called last. See <link to="ISnapshot"/> for details.
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3865	<desc>
3866	Number of snapshots taken on this machine. Zero means the
3867	machine doesn't have any snapshots.
3868	</desc>
3869	</attribute>
3870
3871	<attribute name="currentStateModified" type="boolean" readonly="yes">
3872	<desc>
3873	Returns @c true if the current state of the machine is not
3874	identical to the state stored in the current snapshot.
3875
3876	The current state is identical to the current snapshot only
3877	directly after one of the following calls are made:
3878
3879	<ul>
3880	<li><link to="IConsole::restoreSnapshot"/>
3881	</li>
3882	<li><link to="IConsole::takeSnapshot"/> (issued on a
3883	"powered off" or "saved" machine, for which
3884	<link to="#settingsModified"/> returns @c false)
3885	</li>
3886	<li><link to="IMachine::setCurrentSnapshot"/>
3887	</li>
3888	</ul>
3889
3890	The current state remains identical until one of the following
3891	happens:
3892	<ul>
3893	<li>settings of the machine are changed</li>
3894	<li>the saved state is deleted</li>
3895	<li>the current snapshot is deleted</li>
3896	<li>an attempt to execute the machine is made</li>
3897	</ul>
3898
3899	<note>
3900	For machines that don't have snapshots, this property is
3901	always @c false.
3902	</note>
3903	</desc>
3904	</attribute>
3905
3906	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3907	<desc>
3908	Collection of shared folders for this machine (permanent shared
3909	folders). These folders are shared automatically at machine startup
3910	and available only to the guest OS installed within this machine.
3911
3912	New shared folders are added to the collection using
3913	<link to="#createSharedFolder"/>. Existing shared folders can be
3914	removed using <link to="#removeSharedFolder"/>.
3915	</desc>
3916	</attribute>
3917
3918	<attribute name="clipboardMode" type="ClipboardMode">
3919	<desc>
3920	Synchronization mode between the host OS clipboard
3921	and the guest OS clipboard.
3922	</desc>
3923	</attribute>
3924
3925	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3926	<desc>
3927	A comma-separated list of simple glob patterns. Changes to guest
3928	properties whose name matches one of the patterns will generate an
3929	<link to="IGuestPropertyChangedEvent"/> signal.
3930	</desc>
3931	</attribute>
3932
3933	<attribute name="teleporterEnabled" type="boolean">
3934	<desc>
3935	When set to @a true, the virtual machine becomes a target teleporter
3936	the next time it is powered on. This can only set to @a true when the
3937	VM is in the @a PoweredOff or @a Aborted state.
3938
3939	<!-- This property is automatically set to @a false when the VM is powered
3940	on. (bird: This doesn't work yet ) -->
3941	</desc>
3942	</attribute>
3943
3944	<attribute name="teleporterPort" type="unsigned long">
3945	<desc>
3946	The TCP port the target teleporter will listen for incoming
3947	teleportations on.
3948
3949	0 means the port is automatically selected upon power on. The actual
3950	value can be read from this property while the machine is waiting for
3951	incoming teleportations.
3952	</desc>
3953	</attribute>
3954
3955	<attribute name="teleporterAddress" type="wstring">
3956	<desc>
3957	The address the target teleporter will listen on. If set to an empty
3958	string, it will listen on all addresses.
3959	</desc>
3960	</attribute>
3961
3962	<attribute name="teleporterPassword" type="wstring">
3963	<desc>
3964	The password to check for on the target teleporter. This is just a
3965	very basic measure to prevent simple hacks and operators accidentally
3966	beaming a virtual machine to the wrong place.
3967	</desc>
3968	</attribute>
3969
3970	<attribute name="faultToleranceState" type="FaultToleranceState">
3971	<desc>
3972	Fault tolerance state; disabled, source or target.
3973	This property can be changed at any time. If you change it for a running
3974	VM, then the fault tolerance address and port must be set beforehand.
3975	</desc>
3976	</attribute>
3977
3978	<attribute name="faultTolerancePort" type="unsigned long">
3979	<desc>
3980	The TCP port the fault tolerance source or target will use for
3981	communication.
3982	</desc>
3983	</attribute>
3984
3985	<attribute name="faultToleranceAddress" type="wstring">
3986	<desc>
3987	The address the fault tolerance source or target.
3988	</desc>
3989	</attribute>
3990
3991	<attribute name="faultTolerancePassword" type="wstring">
3992	<desc>
3993	The password to check for on the standby VM. This is just a
3994	very basic measure to prevent simple hacks and operators accidentally
3995	choosing the wrong standby VM.
3996	</desc>
3997	</attribute>
3998
3999	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4000	<desc>
4001	The interval in ms used for syncing the state between source and target.
4002	</desc>
4003	</attribute>
4004
4005	<attribute name="RTCUseUTC" type="boolean">
4006	<desc>
4007	When set to @a true, the RTC device of the virtual machine will run
4008	in UTC time, otherwise in local time. Especially Unix guests prefer
4009	the time in UTC.
4010	</desc>
4011	</attribute>
4012
4013	<attribute name="ioCacheEnabled" type="boolean">
4014	<desc>
4015	When set to @a true, the builtin I/O cache of the virtual machine
4016	will be enabled.
4017	</desc>
4018	</attribute>
4019
4020	<attribute name="ioCacheSize" type="unsigned long">
4021	<desc>
4022	Maximum size of the I/O cache in MB.
4023	</desc>
4024	</attribute>
4025
4026	<method name="lockMachine">
4027	<desc>
4028	Locks the machine for the given session to enable the caller
4029	to make changes to the machine or start the VM or control
4030	VM execution.
4031
4032	There are two ways to lock a machine for such uses:
4033
4034	<ul>
4035	<li>If you want to make changes to the machine settings,
4036	you must obtain an exclusive write lock on the machine
4037	by setting @a lockType to @c Write.
4038
4039	This will only succeed if no other process has locked
4040	the machine to prevent conflicting changes. Only after
4041	an exclusive write lock has been obtained using this method, one
4042	can change all VM settings or execute the VM in the process
4043	space of the session object. (Note that the latter is only of
4044	interest if you actually want to write a new front-end for
4045	virtual machines; but this API gets called internally by
4046	the existing front-ends such as VBoxHeadless and the VirtualBox
4047	GUI to acquire a write lock on the machine that they are running.)
4048
4049	On success, write-locking the machine for a session creates
4050	a second copy of the IMachine object. It is this second object
4051	upon which changes can be made; in VirtualBox terminology, the
4052	second copy is "mutable". It is only this second, mutable machine
4053	object upon which you can call methods that change the
4054	machine state. After having called this method, you can
4055	obtain this second, mutable machine object using the
4056	<link to="ISession::machine" /> attribute.
4057	</li>
4058	<li>If you only want to check the machine state or control
4059	machine execution without actually changing machine
4060	settings (e.g. to get access to VM statistics or take
4061	a snapshot or save the machine state), then set the
4062	@a lockType argument to @c Shared.
4063
4064	If no other session has obtained a lock, you will obtain an
4065	exclusive write lock as described above. However, if another
4066	session has already obtained such a lock, then a link to that
4067	existing session will be established which allows you
4068	to control that existing session.
4069
4070	To find out which type of lock was obtained, you can
4071	inspect <link to="ISession::type" />, which will have been
4072	set to either @c WriteLock or @c Shared.
4073	</li>
4074	</ul>
4075
4076	In either case, you can get access to the <link to="IConsole" />
4077	object which controls VM execution.
4078
4079	Also in all of the above cases, one must always call
4080	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4081	the machine's state will eventually be set to "Aborted".
4082
4083	To change settings on a machine, the following sequence is typically
4084	performed:
4085
4086	<ol>
4087	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4088
4089	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4090
4091	<li>Change the settings of the machine by invoking IMachine methods.</li>
4092
4093	<li>Call <link to="IMachine::saveSettings" />.</li>
4094
4095	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4096	</ol>
4097
4098	<result name="E_UNEXPECTED">
4099	Virtual machine not registered.
4100	</result>
4101	<result name="E_ACCESSDENIED">
4102	Process not started by OpenRemoteSession.
4103	</result>
4104	<result name="VBOX_E_INVALID_OBJECT_STATE">
4105	Session already open or being opened.
4106	</result>
4107	<result name="VBOX_E_VM_ERROR">
4108	Failed to assign machine to session.
4109	</result>
4110	</desc>
4111	<param name="session" type="ISession" dir="in">
4112	<desc>
4113	Session object for which the machine will be locked.
4114	</desc>
4115	</param>
4116	<param name="lockType" type="LockType" dir="in">
4117	<desc>
4118	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4119	If set to @c Shared, then either acquire an exclusive write lock or establish
4120	a link to an existing session.
4121	</desc>
4122	</param>
4123	</method>
4124
4125	<method name="launchVMProcess">
4126	<desc>
4127	Spawns a new process that will execute the virtual machine and obtains a shared
4128	lock on the machine for the calling session.
4129
4130	If launching the VM succeeds, the new VM process will create its own session
4131	and write-lock the machine for it, preventing conflicting changes from other
4132	processes. If the machine is already locked (because it is already running or
4133	because another session has a write lock), launching the VM process will therefore
4134	fail. Reversely, future attempts to obtain a write lock will also fail while the
4135	machine is running.
4136
4137	The caller's session object remains separate from the session opened by the new
4138	VM process. It receives its own <link to="IConsole" /> object which can be used
4139	to control machine execution, but it cannot be used to change all VM settings
4140	which would be available after a <link to="#lockMachine" /> call.
4141
4142	The caller must eventually release the session's shared lock by calling
4143	<link to="ISession::unlockMachine" /> on the local session object once this call
4144	has returned. However, the session's state (see <link to="ISession::state" />)
4145	will not return to "Unlocked" until the remote session has also unlocked
4146	the machine (i.e. the machine has stopped running).
4147
4148	Lauching a VM process can take some time (a new VM is started in a new process,
4149	for which memory and other resources need to be set up). Because of this,
4150	an <link to="IProgress" /> object is returned to allow the caller to wait
4151	for this asynchronous operation to be completed. Until then, the caller's
4152	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4153	and <link to="ISession::console" /> attributes cannot be accessed.
4154	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4155	similar calls to wait for completion. Completion is signalled when the VM
4156	is powered on. If launching the VM fails, error messages can be queried
4157	via the progress object, if available.
4158
4159	The progress object will have at least 2 sub-operations. The first
4160	operation covers the period up to the new VM process calls powerUp.
4161	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4162	progress object. Because <link to="IConsole::powerUp"/> may require
4163	some extra sub-operations, the <link to="IProgress::operationCount"/>
4164	may change at the completion of operation.
4165
4166	For details on the teleportation progress operation, see
4167	<link to="IConsole::powerUp"/>.
4168
4169	The @a environment argument is a string containing definitions of
4170	environment variables in the following format:
4171	@code
4172	NAME[=VALUE]\n
4173	NAME[=VALUE]\n
4174	...
4175	@endcode
4176	where <tt>\\n</tt> is the new line character. These environment
4177	variables will be appended to the environment of the VirtualBox server
4178	process. If an environment variable exists both in the server process
4179	and in this list, the value from this list takes precedence over the
4180	server's variable. If the value of the environment variable is
4181	omitted, this variable will be removed from the resulting environment.
4182	If the environment string is @c null or empty, the server environment
4183	is inherited by the started process as is.
4184
4185	<result name="E_UNEXPECTED">
4186	Virtual machine not registered.
4187	</result>
4188	<result name="E_INVALIDARG">
4189	Invalid session type @a type.
4190	</result>
4191	<result name="VBOX_E_OBJECT_NOT_FOUND">
4192	No machine matching @a machineId found.
4193	</result>
4194	<result name="VBOX_E_INVALID_OBJECT_STATE">
4195	Session already open or being opened.
4196	</result>
4197	<result name="VBOX_E_IPRT_ERROR">
4198	Launching process for machine failed.
4199	</result>
4200	<result name="VBOX_E_VM_ERROR">
4201	Failed to assign machine to session.
4202	</result>
4203	</desc>
4204	<param name="session" type="ISession" dir="in">
4205	<desc>
4206	Client session object to which the VM process will be connected (this
4207	must be in "Unlocked" state).
4208	</desc>
4209	</param>
4210	<param name="type" type="wstring" dir="in">
4211	<desc>
4212	Front-end to use for the new VM process. The following are currently supported:
4213	<ul>
4214	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4215	<li><tt>"vrdp"</tt>: VBoxHeadless (VRDP Server) front-end</li>
4216	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4217	</ul>
4218	</desc>
4219	</param>
4220	<param name="environment" type="wstring" dir="in">
4221	<desc>
4222	Environment to pass to the VM process.
4223	</desc>
4224	</param>
4225	<param name="progress" type="IProgress" dir="return">
4226	<desc>Progress object to track the operation completion.</desc>
4227	</param>
4228	</method>
4229
4230	<method name="setBootOrder">
4231	<desc>
4232	Puts the given device to the specified position in
4233	the boot order.
4234
4235	To indicate that no device is associated with the given position,
4236	<link to="DeviceType_Null"/> should be used.
4237
4238	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4239
4240	<result name="E_INVALIDARG">
4241	Boot @a position out of range.
4242	</result>
4243	<result name="E_NOTIMPL">
4244	Booting from USB @a device currently not supported.
4245	</result>
4246
4247	</desc>
4248	<param name="position" type="unsigned long" dir="in">
4249	<desc>
4250	Position in the boot order (@c 1 to the total number of
4251	devices the machine can boot from, as returned by
4252	<link to="ISystemProperties::maxBootPosition"/>).
4253	</desc>
4254	</param>
4255	<param name="device" type="DeviceType" dir="in">
4256	<desc>
4257	The type of the device used to boot at the given position.
4258	</desc>
4259	</param>
4260	</method>
4261
4262	<method name="getBootOrder" const="yes">
4263	<desc>
4264	Returns the device type that occupies the specified
4265	position in the boot order.
4266
4267	@todo [remove?]
4268	If the machine can have more than one device of the returned type
4269	(such as hard disks), then a separate method should be used to
4270	retrieve the individual device that occupies the given position.
4271
4272	If here are no devices at the given position, then
4273	<link to="DeviceType_Null"/> is returned.
4274
4275	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4276
4277	<result name="E_INVALIDARG">
4278	Boot @a position out of range.
4279	</result>
4280
4281	</desc>
4282	<param name="position" type="unsigned long" dir="in">
4283	<desc>
4284	Position in the boot order (@c 1 to the total number of
4285	devices the machine can boot from, as returned by
4286	<link to="ISystemProperties::maxBootPosition"/>).
4287	</desc>
4288	</param>
4289	<param name="device" type="DeviceType" dir="return">
4290	<desc>
4291	Device at the given position.
4292	</desc>
4293	</param>
4294	</method>
4295
4296	<method name="attachDevice">
4297	<desc>
4298	Attaches a device and optionally mounts a medium to the given storage
4299	controller (<link to="IStorageController" />, identified by @a name),
4300	at the indicated port and device.
4301
4302	This method is intended for managing storage devices in general while a
4303	machine is powered off. It can be used to attach and detach fixed
4304	and removeable media. The following kind of media can be attached
4305	to a machine:
4306
4307	<ul>
4308	<li>For fixed and removable media, you can pass in a medium that was
4309	previously opened using <link to="IVirtualBox::openMedium" />.
4310	</li>
4311
4312	<li>Only for storage devices supporting removable media (such as
4313	DVDs and floppies), you can also specify a null pointer to
4314	indicate an empty drive or one of the medium objects listed
4315	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4316	arrays to indicate a host drive.
4317	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4318	to change the media while the machine is running.
4319	</li>
4320	</ul>
4321
4322	In a VM's default configuration of virtual machines, the secondary
4323	master of the IDE controller is used for a CD/DVD drive.
4324
4325	After calling this returns successfully, a new instance of
4326	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4327	attachments (see <link to="IMachine::mediumAttachments"/>).
4328
4329	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4330	information about attaching media.
4331
4332	The specified device slot must not have a device attached to it,
4333	or this method will fail.
4334
4335	<note>
4336	You cannot attach a device to a newly created machine until
4337	this machine's settings are saved to disk using
4338	<link to="#saveSettings"/>.
4339	</note>
4340	<note>
4341	If the medium is being attached indirectly, a new differencing medium
4342	will implicitly be created for it and attached instead. If the
4343	changes made to the machine settings (including this indirect
4344	attachment) are later cancelled using <link to="#discardSettings"/>,
4345	this implicitly created differencing medium will implicitly
4346	be deleted.
4347	</note>
4348
4349	<result name="E_INVALIDARG">
4350	SATA device, SATA port, IDE port or IDE slot out of range, or
4351	file or UUID not found.
4352	</result>
4353	<result name="VBOX_E_INVALID_OBJECT_STATE">
4354	Machine must be registered before media can be attached.
4355	</result>
4356	<result name="VBOX_E_INVALID_VM_STATE">
4357	Invalid machine state.
4358	</result>
4359	<result name="VBOX_E_OBJECT_IN_USE">
4360	A medium is already attached to this or another virtual machine.
4361	</result>
4362
4363	</desc>
4364	<param name="name" type="wstring" dir="in">
4365	<desc>Name of the storage controller to attach the device to.</desc>
4366	</param>
4367	<param name="controllerPort" type="long" dir="in">
4368	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4369	the primary controller and 1 specifies the secondary controller.
4370	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4371	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4372	</param>
4373	<param name="device" type="long" dir="in">
4374	<desc>Device slot in the given port to attach the device to. This is only
4375	relevant for IDE controllers, for which 0 specifies the master device and
4376	1 specifies the slave device. For all other controller types, this must
4377	be 0.</desc>
4378	</param>
4379	<param name="type" type="DeviceType" dir="in">
4380	<desc>Device type of the attached device. For media opened by
4381	<link to="IVirtualBox::openMedium" />, this must match the device type
4382	specified there.</desc>
4383	</param>
4384	<param name="medium" type="IMedium" dir="in">
4385	<desc>Medium to mount or NULL for an empty drive.</desc>
4386	</param>
4387	</method>
4388
4389	<method name="detachDevice">
4390	<desc>
4391	Detaches the device attached to a device slot of the specified bus.
4392
4393	Detaching the device from the virtual machine is deferred. This means
4394	that the medium remains associated with the machine when this method
4395	returns and gets actually de-associated only after a successful
4396	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4397	for more detailed information about attaching media.
4398
4399	<note>
4400	You cannot detach a device from a running machine.
4401	</note>
4402	<note>
4403	Detaching differencing media implicitly created by <link
4404	to="#attachDevice"/> for the indirect attachment using this
4405	method will <b>not</b> implicitly delete them. The
4406	<link to="IMedium::deleteStorage"/> operation should be
4407	explicitly performed by the caller after the medium is successfully
4408	detached and the settings are saved with
4409	<link to="#saveSettings"/>, if it is the desired action.
4410	</note>
4411
4412	<result name="VBOX_E_INVALID_VM_STATE">
4413	Attempt to detach medium from a running virtual machine.
4414	</result>
4415	<result name="VBOX_E_OBJECT_NOT_FOUND">
4416	No medium attached to given slot/bus.
4417	</result>
4418	<result name="VBOX_E_NOT_SUPPORTED">
4419	Medium format does not support storage deletion.
4420	</result>
4421
4422	</desc>
4423	<param name="name" type="wstring" dir="in">
4424	<desc>Name of the storage controller to detach the medium from.</desc>
4425	</param>
4426	<param name="controllerPort" type="long" dir="in">
4427	<desc>Port number to detach the medium from.</desc>
4428	</param>
4429	<param name="device" type="long" dir="in">
4430	<desc>Device slot number to detach the medium from.</desc>
4431	</param>
4432	</method>
4433
4434	<method name="passthroughDevice">
4435	<desc>
4436	Sets the passthrough mode of an existing DVD device. Changing the
4437	setting while the VM is running is forbidden. The setting is only used
4438	if at VM start the device is configured as a host DVD drive, in all
4439	other cases it is ignored. The device must already exist; see
4440	<link to="IMachine::attachDevice"/> for how to attach a new device.
4441
4442	The @a controllerPort and @a device parameters specify the device slot and
4443	have have the same meaning as with <link to="IMachine::attachDevice" />.
4444
4445	<result name="E_INVALIDARG">
4446	SATA device, SATA port, IDE port or IDE slot out of range.
4447	</result>
4448	<result name="VBOX_E_INVALID_OBJECT_STATE">
4449	Attempt to modify an unregistered virtual machine.
4450	</result>
4451	<result name="VBOX_E_INVALID_VM_STATE">
4452	Invalid machine state.
4453	</result>
4454
4455	</desc>
4456	<param name="name" type="wstring" dir="in">
4457	<desc>Name of the storage controller.</desc>
4458	</param>
4459	<param name="controllerPort" type="long" dir="in">
4460	<desc>Storage controller port.</desc>
4461	</param>
4462	<param name="device" type="long" dir="in">
4463	<desc>Device slot in the given port.</desc>
4464	</param>
4465	<param name="passthrough" type="boolean" dir="in">
4466	<desc>New value for the passthrough setting.</desc>
4467	</param>
4468	</method>
4469
4470	<method name="mountMedium">
4471	<desc>
4472	Mounts a medium (<link to="IMedium" />, identified
4473	by the given UUID @a id) to the given storage controller
4474	(<link to="IStorageController" />, identified by @a name),
4475	at the indicated port and device. The device must already exist;
4476	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4477
4478	This method is intended only for managing removable media, where the
4479	device is fixed but media is changeable at runtime (such as DVDs
4480	and floppies). It cannot be used for fixed media such as hard disks.
4481
4482	The @a controllerPort and @a device parameters specify the device slot and
4483	have have the same meaning as with <link to="IMachine::attachDevice" />.
4484
4485	The specified device slot can have a medium mounted, which will be
4486	unmounted first. Specifying a zero UUID (or an empty string) for
4487	@a medium does just an unmount.
4488
4489	See <link to="IMedium"/> for more detailed information about
4490	attaching media.
4491
4492	<result name="E_INVALIDARG">
4493	SATA device, SATA port, IDE port or IDE slot out of range.
4494	</result>
4495	<result name="VBOX_E_INVALID_OBJECT_STATE">
4496	Attempt to attach medium to an unregistered virtual machine.
4497	</result>
4498	<result name="VBOX_E_INVALID_VM_STATE">
4499	Invalid machine state.
4500	</result>
4501	<result name="VBOX_E_OBJECT_IN_USE">
4502	Medium already attached to this or another virtual machine.
4503	</result>
4504
4505	</desc>
4506	<param name="name" type="wstring" dir="in">
4507	<desc>Name of the storage controller to attach the medium to.</desc>
4508	</param>
4509	<param name="controllerPort" type="long" dir="in">
4510	<desc>Port to attach the medium to.</desc>
4511	</param>
4512	<param name="device" type="long" dir="in">
4513	<desc>Device slot in the given port to attach the medium to.</desc>
4514	</param>
4515	<param name="medium" type="uuid" mod="string" dir="in">
4516	<desc>UUID of the medium to attach. A zero UUID means unmount the
4517	currently mounted medium.</desc>
4518	</param>
4519	<param name="force" type="boolean" dir="in">
4520	<desc>Allows to force unmount/mount of a medium which is locked by
4521	theDevice slot in the given port to attach the medium to.</desc>
4522	</param>
4523	</method>
4524
4525	<method name="getMedium" const="yes">
4526	<desc>
4527	Returns the virtual medium attached to a device slot of the specified
4528	bus.
4529
4530	Note that if the medium was indirectly attached by
4531	<link to="#mountMedium"/> to the given device slot then this
4532	method will return not the same object as passed to the
4533	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4534	more detailed information about mounting a medium.
4535
4536	<result name="VBOX_E_OBJECT_NOT_FOUND">
4537	No medium attached to given slot/bus.
4538	</result>
4539
4540	</desc>
4541	<param name="name" type="wstring" dir="in">
4542	<desc>Name of the storage controller the medium is attached to.</desc>
4543	</param>
4544	<param name="controllerPort" type="long" dir="in">
4545	<desc>Port to query.</desc>
4546	</param>
4547	<param name="device" type="long" dir="in">
4548	<desc>Device slot in the given port to query.</desc>
4549	</param>
4550	<param name="medium" type="IMedium" dir="return">
4551	<desc>Attached medium object.</desc>
4552	</param>
4553	</method>
4554
4555	<method name="getMediumAttachmentsOfController" const="yes">
4556	<desc>
4557	Returns an array of medium attachments which are attached to the
4558	the controller with the given name.
4559
4560	<result name="VBOX_E_OBJECT_NOT_FOUND">
4561	A storage controller with given name doesn't exist.
4562	</result>
4563	</desc>
4564	<param name="name" type="wstring" dir="in"/>
4565	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4566	</method>
4567
4568	<method name="getMediumAttachment" const="yes">
4569	<desc>
4570	Returns a medium attachment which corresponds to the controller with
4571	the given name, on the given port and device slot.
4572
4573	<result name="VBOX_E_OBJECT_NOT_FOUND">
4574	No attachment exists for the given controller/port/device combination.
4575	</result>
4576	</desc>
4577	<param name="name" type="wstring" dir="in"/>
4578	<param name="controllerPort" type="long" dir="in"/>
4579	<param name="device" type="long" dir="in"/>
4580	<param name="attachment" type="IMediumAttachment" dir="return"/>
4581	</method>
4582
4583	<method name="getNetworkAdapter" const="yes">
4584	<desc>
4585	Returns the network adapter associated with the given slot.
4586	Slots are numbered sequentially, starting with zero. The total
4587	number of adapters per machine is defined by the
4588	<link to="ISystemProperties::networkAdapterCount"/> property,
4589	so the maximum slot number is one less than that property's value.
4590
4591	<result name="E_INVALIDARG">
4592	Invalid @a slot number.
4593	</result>
4594
4595	</desc>
4596	<param name="slot" type="unsigned long" dir="in"/>
4597	<param name="adapter" type="INetworkAdapter" dir="return"/>
4598	</method>
4599
4600	<method name="addStorageController">
4601	<desc>
4602	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4603	machine and returns it as an instance of
4604	<link to="IStorageController" />.
4605
4606	@a name identifies the controller for subsequent calls such as
4607	<link to="#getStorageControllerByName" />,
4608	<link to="#getStorageControllerByInstance" />,
4609	<link to="#removeStorageController" />,
4610	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4611
4612	After the controller has been added, you can set its exact
4613	type by setting the <link to="IStorageController::controllerType" />.
4614
4615	<result name="VBOX_E_OBJECT_IN_USE">
4616	A storage controller with given name exists already.
4617	</result>
4618	<result name="E_INVALIDARG">
4619	Invalid @a controllerType.
4620	</result>
4621	</desc>
4622	<param name="name" type="wstring" dir="in"/>
4623	<param name="connectionType" type="StorageBus" dir="in"/>
4624	<param name="controller" type="IStorageController" dir="return"/>
4625	</method>
4626
4627	<method name="getStorageControllerByName" const="yes">
4628	<desc>
4629	Returns a storage controller with the given name.
4630
4631	<result name="VBOX_E_OBJECT_NOT_FOUND">
4632	A storage controller with given name doesn't exist.
4633	</result>
4634	</desc>
4635	<param name="name" type="wstring" dir="in"/>
4636	<param name="storageController" type="IStorageController" dir="return"/>
4637	</method>
4638
4639	<method name="getStorageControllerByInstance" const="yes">
4640	<desc>
4641	Returns a storage controller with the given instance number.
4642
4643	<result name="VBOX_E_OBJECT_NOT_FOUND">
4644	A storage controller with given instance number doesn't exist.
4645	</result>
4646	</desc>
4647	<param name="instance" type="unsigned long" dir="in"/>
4648	<param name="storageController" type="IStorageController" dir="return"/>
4649	</method>
4650
4651	<method name="removeStorageController">
4652	<desc>
4653	Removes a storage controller from the machine.
4654
4655	<result name="VBOX_E_OBJECT_NOT_FOUND">
4656	A storage controller with given name doesn't exist.
4657	</result>
4658	</desc>
4659	<param name="name" type="wstring" dir="in"/>
4660	</method>
4661
4662	<method name="getSerialPort" const="yes">
4663	<desc>
4664	Returns the serial port associated with the given slot.
4665	Slots are numbered sequentially, starting with zero. The total
4666	number of serial ports per machine is defined by the
4667	<link to="ISystemProperties::serialPortCount"/> property,
4668	so the maximum slot number is one less than that property's value.
4669
4670	<result name="E_INVALIDARG">
4671	Invalid @a slot number.
4672	</result>
4673
4674	</desc>
4675	<param name="slot" type="unsigned long" dir="in"/>
4676	<param name="port" type="ISerialPort" dir="return"/>
4677	</method>
4678
4679	<method name="getParallelPort" const="yes">
4680	<desc>
4681	Returns the parallel port associated with the given slot.
4682	Slots are numbered sequentially, starting with zero. The total
4683	number of parallel ports per machine is defined by the
4684	<link to="ISystemProperties::parallelPortCount"/> property,
4685	so the maximum slot number is one less than that property's value.
4686
4687	<result name="E_INVALIDARG">
4688	Invalid @a slot number.
4689	</result>
4690
4691	</desc>
4692	<param name="slot" type="unsigned long" dir="in"/>
4693	<param name="port" type="IParallelPort" dir="return"/>
4694	</method>
4695
4696	<method name="getExtraDataKeys">
4697	<desc>
4698	Returns an array representing the machine-specific extra data keys
4699	which currently have values defined.
4700	</desc>
4701	<param name="value" type="wstring" dir="return" safearray="yes">
4702	<desc>Array of extra data keys.</desc>
4703	</param>
4704	</method>
4705
4706	<method name="getExtraData">
4707	<desc>
4708	Returns associated machine-specific extra data.
4709
4710	If the requested data @a key does not exist, this function will
4711	succeed and return an empty string in the @a value argument.
4712
4713	<result name="VBOX_E_FILE_ERROR">
4714	Settings file not accessible.
4715	</result>
4716	<result name="VBOX_E_XML_ERROR">
4717	Could not parse the settings file.
4718	</result>
4719
4720	</desc>
4721	<param name="key" type="wstring" dir="in">
4722	<desc>Name of the data key to get.</desc>
4723	</param>
4724	<param name="value" type="wstring" dir="return">
4725	<desc>Value of the requested data key.</desc>
4726	</param>
4727	</method>
4728
4729	<method name="setExtraData">
4730	<desc>
4731	Sets associated machine-specific extra data.
4732
4733	If you pass @c null or an empty string as a key @a value, the given
4734	@a key will be deleted.
4735
4736	<note>
4737	Before performing the actual data change, this method will ask all
4738	registered listeners using the
4739	<link to="IExtraDataCanChangeEvent"/>
4740	notification for a permission. If one of the listeners refuses the
4741	new value, the change will not be performed.
4742	</note>
4743	<note>
4744	On success, the
4745	<link to="IExtraDataChangedEvent"/> notification
4746	is called to inform all registered listeners about a successful data
4747	change.
4748	</note>
4749	<note>
4750	This method can be called outside the machine session and therefore
4751	it's a caller's responsibility to handle possible race conditions
4752	when several clients change the same key at the same time.
4753	</note>
4754
4755	<result name="VBOX_E_FILE_ERROR">
4756	Settings file not accessible.
4757	</result>
4758	<result name="VBOX_E_XML_ERROR">
4759	Could not parse the settings file.
4760	</result>
4761
4762	</desc>
4763	<param name="key" type="wstring" dir="in">
4764	<desc>Name of the data key to set.</desc>
4765	</param>
4766	<param name="value" type="wstring" dir="in">
4767	<desc>Value to assign to the key.</desc>
4768	</param>
4769	</method>
4770
4771	<method name="getCPUProperty" const="yes">
4772	<desc>
4773	Returns the virtual CPU boolean value of the specified property.
4774
4775	<result name="E_INVALIDARG">
4776	Invalid property.
4777	</result>
4778
4779	</desc>
4780	<param name="property" type="CPUPropertyType" dir="in">
4781	<desc>
4782	Property type to query.
4783	</desc>
4784	</param>
4785	<param name="value" type="boolean" dir="return">
4786	<desc>
4787	Property value.
4788	</desc>
4789	</param>
4790	</method>
4791
4792	<method name="setCPUProperty">
4793	<desc>
4794	Sets the virtual CPU boolean value of the specified property.
4795
4796	<result name="E_INVALIDARG">
4797	Invalid property.
4798	</result>
4799
4800	</desc>
4801	<param name="property" type="CPUPropertyType" dir="in">
4802	<desc>
4803	Property type to query.
4804	</desc>
4805	</param>
4806	<param name="value" type="boolean" dir="in">
4807	<desc>
4808	Property value.
4809	</desc>
4810	</param>
4811	</method>
4812
4813	<method name="getCPUIDLeaf" const="yes">
4814	<desc>
4815	Returns the virtual CPU cpuid information for the specified leaf.
4816
4817	Currently supported index values for cpuid:
4818	Standard CPUID leafs: 0 - 0xA
4819	Extended CPUID leafs: 0x80000000 - 0x8000000A
4820
4821	See the Intel and AMD programmer's manuals for detailed information
4822	about the cpuid instruction and its leafs.
4823	<result name="E_INVALIDARG">
4824	Invalid id.
4825	</result>
4826
4827	</desc>
4828	<param name="id" type="unsigned long" dir="in">
4829	<desc>
4830	CPUID leaf index.
4831	</desc>
4832	</param>
4833	<param name="valEax" type="unsigned long" dir="out">
4834	<desc>
4835	CPUID leaf value for register eax.
4836	</desc>
4837	</param>
4838	<param name="valEbx" type="unsigned long" dir="out">
4839	<desc>
4840	CPUID leaf value for register ebx.
4841	</desc>
4842	</param>
4843	<param name="valEcx" type="unsigned long" dir="out">
4844	<desc>
4845	CPUID leaf value for register ecx.
4846	</desc>
4847	</param>
4848	<param name="valEdx" type="unsigned long" dir="out">
4849	<desc>
4850	CPUID leaf value for register edx.
4851	</desc>
4852	</param>
4853	</method>
4854
4855	<method name="setCPUIDLeaf">
4856	<desc>
4857	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4858	are not passed unmodified. VirtualBox clears features that it doesn't support.
4859
4860	Currently supported index values for cpuid:
4861	Standard CPUID leafs: 0 - 0xA
4862	Extended CPUID leafs: 0x80000000 - 0x8000000A
4863
4864	See the Intel and AMD programmer's manuals for detailed information
4865	about the cpuid instruction and its leafs.
4866
4867	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4868	random crashes inside VMs.
4869	<result name="E_INVALIDARG">
4870	Invalid id.
4871	</result>
4872
4873	</desc>
4874	<param name="id" type="unsigned long" dir="in">
4875	<desc>
4876	CPUID leaf index.
4877	</desc>
4878	</param>
4879	<param name="valEax" type="unsigned long" dir="in">
4880	<desc>
4881	CPUID leaf value for register eax.
4882	</desc>
4883	</param>
4884	<param name="valEbx" type="unsigned long" dir="in">
4885	<desc>
4886	CPUID leaf value for register ebx.
4887	</desc>
4888	</param>
4889	<param name="valEcx" type="unsigned long" dir="in">
4890	<desc>
4891	CPUID leaf value for register ecx.
4892	</desc>
4893	</param>
4894	<param name="valEdx" type="unsigned long" dir="in">
4895	<desc>
4896	CPUID leaf value for register edx.
4897	</desc>
4898	</param>
4899	</method>
4900
4901	<method name="removeCPUIDLeaf">
4902	<desc>
4903	Removes the virtual CPU cpuid leaf for the specified index
4904
4905	<result name="E_INVALIDARG">
4906	Invalid id.
4907	</result>
4908
4909	</desc>
4910	<param name="id" type="unsigned long" dir="in">
4911	<desc>
4912	CPUID leaf index.
4913	</desc>
4914	</param>
4915	</method>
4916
4917	<method name="removeAllCPUIDLeaves">
4918	<desc>
4919	Removes all the virtual CPU cpuid leaves
4920	</desc>
4921	</method>
4922
4923	<method name="getHWVirtExProperty" const="yes">
4924	<desc>
4925	Returns the value of the specified hardware virtualization boolean property.
4926
4927	<result name="E_INVALIDARG">
4928	Invalid property.
4929	</result>
4930
4931	</desc>
4932	<param name="property" type="HWVirtExPropertyType" dir="in">
4933	<desc>
4934	Property type to query.
4935	</desc>
4936	</param>
4937	<param name="value" type="boolean" dir="return">
4938	<desc>
4939	Property value.
4940	</desc>
4941	</param>
4942	</method>
4943
4944	<method name="setHWVirtExProperty">
4945	<desc>
4946	Sets a new value for the specified hardware virtualization boolean property.
4947
4948	<result name="E_INVALIDARG">
4949	Invalid property.
4950	</result>
4951
4952	</desc>
4953	<param name="property" type="HWVirtExPropertyType" dir="in">
4954	<desc>
4955	Property type to set.
4956	</desc>
4957	</param>
4958	<param name="value" type="boolean" dir="in">
4959	<desc>
4960	New property value.
4961	</desc>
4962	</param>
4963	</method>
4964
4965	<method name="saveSettings">
4966	<desc>
4967	Saves any changes to machine settings made since the session
4968	has been opened or a new machine has been created, or since the
4969	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4970	For registered machines, new settings become visible to all
4971	other VirtualBox clients after successful invocation of this
4972	method.
4973	<note>
4974	The method sends <link to="IMachineDataChangedEvent"/>
4975	notification event after the configuration has been successfully
4976	saved (only for registered machines).
4977	</note>
4978	<note>
4979	Calling this method is only valid on instances returned
4980	by <link to="ISession::machine"/> and on new machines
4981	created by <link to="IVirtualBox::createMachine"/> but not
4982	yet registered, or on unregistered machines after calling
4983	<link to="IMachine::unregister"/>.
4984	</note>
4985
4986	<result name="VBOX_E_FILE_ERROR">
4987	Settings file not accessible.
4988	</result>
4989	<result name="VBOX_E_XML_ERROR">
4990	Could not parse the settings file.
4991	</result>
4992	<result name="E_ACCESSDENIED">
4993	Modification request refused.
4994	</result>
4995
4996	</desc>
4997	</method>
4998
4999	<method name="discardSettings">
5000	<desc>
5001	Discards any changes to the machine settings made since the session
5002	has been opened or since the last call to <link to="#saveSettings"/>
5003	or <link to="#discardSettings"/>.
5004	<note>
5005	Calling this method is only valid on instances returned
5006	by <link to="ISession::machine"/> and on new machines
5007	created by <link to="IVirtualBox::createMachine"/> or
5008	opened by <link to="IVirtualBox::openMachine"/> but not
5009	yet registered, or on unregistered machines after calling
5010	<link to="IMachine::unregister"/>.
5011	</note>
5012
5013	<result name="VBOX_E_INVALID_VM_STATE">
5014	Virtual machine is not mutable.
5015	</result>
5016
5017	</desc>
5018	</method>
5019
5020	<method name="unregister">
5021	<desc>
5022	Unregisters the machine, which must have been previously registered using
5023	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5024	cleanup before the machine is unregistered.
5025
5026	This method does not delete any files. It only changes the machine configuration and
5027	the list of registered machines in the VirtualBox object. To delete the files which
5028	belonged to the machine, including the XML file of the machine itself, call
5029	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5030	from this method.
5031
5032	How thoroughly this method cleans up the machine configuration before unregistering
5033	the machine depends on the @a cleanupMode argument.
5034
5035	<ul>
5036	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5037	cleanup will be performed. The call will fail if the machine is in "Saved" state
5038	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5039	It is the responsibility of the caller to delete all such configuration in this mode.
5040	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5041	which it replaces.</li>
5042	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5043	state or if it has snapshots or media attached. All media attached to the current machine
5044	state or in snapshots will be detached. No medium objects will be returned; all of the
5045	machine's media will remain open.</li>
5046	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5047	except that all the hard disk medium objects which were detached from the machine will
5048	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5049	API for closing and deletion.</li>
5050	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5051	that all media will be returned in the array, including removeable media like DVDs and
5052	floppies. This might be useful if the user wants to inspect in detail which media were
5053	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5054	in that case because users will typically want to preserve ISO and RAW image files.</li>
5055	</ul>
5056
5057	This API does not verify whether the media files returned in the array are still
5058	attached to other machines (i.e. shared between several machines). If such a shared
5059	image is passed to <link to="#delete" /> however, closing the image will fail there
5060	and the image will be silently skipped.
5061
5062	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5063	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5064	deleted with all its saved states and hard disk images, but images for removeable
5065	drives (such as ISO and RAW files) will remain on disk.
5066
5067	The call will fail if the machine is currently locked (see <link to="ISession" />).
5068	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5069	before unregistering it.
5070
5071	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5072	is fired.
5073
5074	<note>
5075	If the given machine is inaccessible (see <link to="#accessible"/>), it
5076	will be unregistered and fully uninitialized right afterwards. As a result,
5077	the returned machine object will be unusable and an attempt to call
5078	<b>any</b> method will return the "Object not ready" error.
5079	</note>
5080
5081	<result name="VBOX_E_INVALID_OBJECT_STATE">
5082	Machine is currently locked for a session.
5083	</result>
5084	</desc>
5085
5086	<param name="cleanupMode" type="CleanupMode" dir="in">
5087	<desc>How to clean up after the machine has been unregistered.</desc>
5088	</param>
5089	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5090	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5091	</param>
5092	</method>
5093
5094	<method name="delete">
5095	<desc>
5096	Deletes the files associated with this machine from disk. If medium objects are passed
5097	in with the @a aMedia argument, they are closed and, if closing was succesful, their
5098	storage files are deleted as well. For convenience, this array of media files can be
5099	the same as the one returned from a previous <link to="#unregister" /> call.
5100
5101	This method must only be called on machines which are either write-locked (i.e. on instances
5102	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5103	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5104	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5105
5106	The following files will be deleted by this method:
5107	<ul>
5108	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5109	argument other than "UnregisterOnly", this will delete all saved state files that
5110	the machine had in use; possibly one if the machine was in "Saved" state and one
5111	for each online snapshot that the machine had.</li>
5112	<li>On each medium object passed in the @a aMedia array, this will call
5113	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5114	medium's storage on disk. Since the close() call will fail if the medium is still
5115	in use, e.g. because it is still attached to a second machine; in that case the
5116	storage will not be deleted.</li>
5117	<li>Finally, the machine's own XML file will be deleted.</li>
5118	</ul>
5119
5120	Since deleting large disk image files can be a time-consuming I/O operation, this
5121	method operates asynchronously and returns an IProgress object to allow the caller
5122	to monitor the progress. There will be one sub-operation for each file that is
5123	being deleted (saved state or medium storage file).
5124
5125	<note>
5126	<link to="#settingsModified"/> will return @c true after this
5127	method successfully returns.
5128	</note>
5129
5130	<result name="VBOX_E_INVALID_VM_STATE">
5131	Machine is registered but not write-locked.
5132	</result>
5133	<result name="VBOX_E_IPRT_ERROR">
5134	Could not delete the settings file.
5135	</result>
5136	</desc>
5137	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5138	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5139	</param>
5140	<param name="aProgress" type="IProgress" dir="return">
5141	<desc>Progress object to track the operation completion.</desc>
5142	</param>
5143	</method>
5144
5145	<method name="export">
5146	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5147	steps required to export VirtualBox machines to OVF.
5148	</desc>
5149
5150	<param name="aAppliance" type="IAppliance" dir="in">
5151	<desc>Appliance to export this machine to.</desc>
5152	</param>
5153	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5154	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5155	</param>
5156	</method >
5157
5158	<method name="getSnapshot">
5159	<desc>
5160	Returns a snapshot of this machine with the given UUID.
5161	A @c null UUID can be used to obtain the first snapshot
5162	taken on this machine. This is useful if you want to traverse
5163	the whole tree of snapshots starting from the root.
5164
5165	<result name="VBOX_E_OBJECT_NOT_FOUND">
5166	Virtual machine has no snapshots or snapshot not found.
5167	</result>
5168
5169	</desc>
5170	<param name="id" type="uuid" mod="string" dir="in">
5171	<desc>UUID of the snapshot to get</desc>
5172	</param>
5173	<param name="snapshot" type="ISnapshot" dir="return">
5174	<desc>Snapshot object with the given UUID.</desc>
5175	</param>
5176	</method>
5177
5178	<method name="findSnapshot">
5179	<desc>
5180	Returns a snapshot of this machine with the given name.
5181
5182	<result name="VBOX_E_OBJECT_NOT_FOUND">
5183	Virtual machine has no snapshots or snapshot not found.
5184	</result>
5185
5186	</desc>
5187	<param name="name" type="wstring" dir="in">
5188	<desc>Name of the snapshot to find</desc>
5189	</param>
5190	<param name="snapshot" type="ISnapshot" dir="return">
5191	<desc>Snapshot object with the given name.</desc>
5192	</param>
5193	</method>
5194
5195	<method name="setCurrentSnapshot">
5196	<desc>
5197	Sets the current snapshot of this machine.
5198	<note>
5199	In the current implementation, this operation is not
5200	implemented.
5201	</note>
5202	</desc>
5203	<param name="id" type="uuid" mod="string" dir="in">
5204	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5205	</param>
5206	</method>
5207
5208	<method name="createSharedFolder">
5209	<desc>
5210	Creates a new permanent shared folder by associating the given logical
5211	name with the given host path, adds it to the collection of shared
5212	folders and starts sharing it. Refer to the description of
5213	<link to="ISharedFolder"/> to read more about logical names.
5214
5215	<result name="VBOX_E_OBJECT_IN_USE">
5216	Shared folder already exists.
5217	</result>
5218	<result name="VBOX_E_FILE_ERROR">
5219	Shared folder @a hostPath not accessible.
5220	</result>
5221
5222	</desc>
5223	<param name="name" type="wstring" dir="in">
5224	<desc>Unique logical name of the shared folder.</desc>
5225	</param>
5226	<param name="hostPath" type="wstring" dir="in">
5227	<desc>Full path to the shared folder in the host file system.</desc>
5228	</param>
5229	<param name="writable" type="boolean" dir="in">
5230	<desc>Whether the share is writable or readonly.</desc>
5231	</param>
5232	<param name="automount" type="boolean" dir="in">
5233	<desc>Whether the share gets automatically mounted by the guest
5234	or not.</desc>
5235	</param>
5236	</method>
5237
5238	<method name="removeSharedFolder">
5239	<desc>
5240	Removes the permanent shared folder with the given name previously
5241	created by <link to="#createSharedFolder"/> from the collection of
5242	shared folders and stops sharing it.
5243
5244	<result name="VBOX_E_INVALID_VM_STATE">
5245	Virtual machine is not mutable.
5246	</result>
5247	<result name="VBOX_E_OBJECT_NOT_FOUND">
5248	Shared folder @a name does not exist.
5249	</result>
5250
5251	</desc>
5252	<param name="name" type="wstring" dir="in">
5253	<desc>Logical name of the shared folder to remove.</desc>
5254	</param>
5255	</method>
5256
5257	<method name="canShowConsoleWindow">
5258	<desc>
5259	Returns @c true if the VM console process can activate the
5260	console window and bring it to foreground on the desktop of
5261	the host PC.
5262	<note>
5263	This method will fail if a session for this machine is not
5264	currently open.
5265	</note>
5266
5267	<result name="VBOX_E_INVALID_VM_STATE">
5268	Machine session is not open.
5269	</result>
5270
5271	</desc>
5272	<param name="canShow" type="boolean" dir="return">
5273	<desc>
5274	@c true if the console window can be shown and @c false otherwise.
5275	</desc>
5276	</param>
5277	</method>
5278
5279	<method name="showConsoleWindow">
5280	<desc>
5281	Activates the console window and brings it to foreground on
5282	the desktop of the host PC. Many modern window managers on
5283	many platforms implement some sort of focus stealing
5284	prevention logic, so that it may be impossible to activate
5285	a window without the help of the currently active
5286	application. In this case, this method will return a non-zero
5287	identifier that represents the top-level window of the VM
5288	console process. The caller, if it represents a currently
5289	active process, is responsible to use this identifier (in a
5290	platform-dependent manner) to perform actual window
5291	activation.
5292	<note>
5293	This method will fail if a session for this machine is not
5294	currently open.
5295	</note>
5296
5297	<result name="VBOX_E_INVALID_VM_STATE">
5298	Machine session is not open.
5299	</result>
5300
5301	</desc>
5302	<param name="winId" type="long long" dir="return">
5303	<desc>
5304	Platform-dependent identifier of the top-level VM console
5305	window, or zero if this method has performed all actions
5306	necessary to implement the <i>show window</i> semantics for
5307	the given platform and/or VirtualBox front-end.
5308	</desc>
5309	</param>
5310	</method>
5311
5312	<method name="getGuestProperty" const="yes">
5313	<desc>
5314	Reads an entry from the machine's guest property store.
5315
5316	<result name="VBOX_E_INVALID_VM_STATE">
5317	Machine session is not open.
5318	</result>
5319
5320	</desc>
5321	<param name="name" type="wstring" dir="in">
5322	<desc>
5323	The name of the property to read.
5324	</desc>
5325	</param>
5326	<param name="value" type="wstring" dir="out">
5327	<desc>
5328	The value of the property. If the property does not exist then this
5329	will be empty.
5330	</desc>
5331	</param>
5332	<param name="timestamp" type="long long" dir="out">
5333	<desc>
5334	The time at which the property was last modified, as seen by the
5335	server process.
5336	</desc>
5337	</param>
5338	<param name="flags" type="wstring" dir="out">
5339	<desc>
5340	Additional property parameters, passed as a comma-separated list of
5341	"name=value" type entries.
5342	</desc>
5343	</param>
5344	</method>
5345
5346	<method name="getGuestPropertyValue" const="yes">
5347	<desc>
5348	Reads a value from the machine's guest property store.
5349
5350	<result name="VBOX_E_INVALID_VM_STATE">
5351	Machine session is not open.
5352	</result>
5353
5354	</desc>
5355	<param name="property" type="wstring" dir="in">
5356	<desc>
5357	The name of the property to read.
5358	</desc>
5359	</param>
5360	<param name="value" type="wstring" dir="return">
5361	<desc>
5362	The value of the property. If the property does not exist then this
5363	will be empty.
5364	</desc>
5365	</param>
5366	</method>
5367
5368	<method name="getGuestPropertyTimestamp" const="yes">
5369	<desc>
5370	Reads a property timestamp from the machine's guest property store.
5371
5372	<result name="VBOX_E_INVALID_VM_STATE">
5373	Machine session is not open.
5374	</result>
5375
5376	</desc>
5377	<param name="property" type="wstring" dir="in">
5378	<desc>
5379	The name of the property to read.
5380	</desc>
5381	</param>
5382	<param name="value" type="long long" dir="return">
5383	<desc>
5384	The timestamp. If the property does not exist then this will be
5385	empty.
5386	</desc>
5387	</param>
5388	</method>
5389
5390	<method name="setGuestProperty">
5391	<desc>
5392	Sets, changes or deletes an entry in the machine's guest property
5393	store.
5394
5395	<result name="E_ACCESSDENIED">
5396	Property cannot be changed.
5397	</result>
5398	<result name="E_INVALIDARG">
5399	Invalid @a flags.
5400	</result>
5401	<result name="VBOX_E_INVALID_VM_STATE">
5402	Virtual machine is not mutable or session not open.
5403	</result>
5404	<result name="VBOX_E_INVALID_OBJECT_STATE">
5405	Cannot set transient property when machine not running.
5406	</result>
5407
5408	</desc>
5409	<param name="property" type="wstring" dir="in">
5410	<desc>
5411	The name of the property to set, change or delete.
5412	</desc>
5413	</param>
5414	<param name="value" type="wstring" dir="in">
5415	<desc>
5416	The new value of the property to set, change or delete. If the
5417	property does not yet exist and value is non-empty, it will be
5418	created. If the value is @c null or empty, the property will be
5419	deleted if it exists.
5420	</desc>
5421	</param>
5422	<param name="flags" type="wstring" dir="in">
5423	<desc>
5424	Additional property parameters, passed as a comma-separated list of
5425	"name=value" type entries.
5426	</desc>
5427	</param>
5428	</method>
5429
5430	<method name="setGuestPropertyValue">
5431	<desc>
5432	Sets, changes or deletes a value in the machine's guest property
5433	store. The flags field will be left unchanged or created empty for a
5434	new property.
5435
5436	<result name="E_ACCESSDENIED">
5437	Property cannot be changed.
5438	</result>
5439	<result name="VBOX_E_INVALID_VM_STATE">
5440	Virtual machine is not mutable or session not open.
5441	</result>
5442	<result name="VBOX_E_INVALID_OBJECT_STATE">
5443	Cannot set transient property when machine not running.
5444	</result>
5445	</desc>
5446
5447	<param name="property" type="wstring" dir="in">
5448	<desc>
5449	The name of the property to set, change or delete.
5450	</desc>
5451	</param>
5452	<param name="value" type="wstring" dir="in">
5453	<desc>
5454	The new value of the property to set, change or delete. If the
5455	property does not yet exist and value is non-empty, it will be
5456	created. If the value is @c null or empty, the property will be
5457	deleted if it exists.
5458	</desc>
5459	</param>
5460	</method>
5461
5462	<method name="enumerateGuestProperties">
5463	<desc>
5464	Return a list of the guest properties matching a set of patterns along
5465	with their values, time stamps and flags.
5466	</desc>
5467	<param name="patterns" type="wstring" dir="in">
5468	<desc>
5469	The patterns to match the properties against, separated by '\|'
5470	characters. If this is empty or @c null, all properties will match.
5471	</desc>
5472	</param>
5473	<param name="name" type="wstring" dir="out" safearray="yes">
5474	<desc>
5475	The names of the properties returned.
5476	</desc>
5477	</param>
5478	<param name="value" type="wstring" dir="out" safearray="yes">
5479	<desc>
5480	The values of the properties returned. The array entries match the
5481	corresponding entries in the @a name array.
5482	</desc>
5483	</param>
5484	<param name="timestamp" type="long long" dir="out" safearray="yes">
5485	<desc>
5486	The time stamps of the properties returned. The array entries match
5487	the corresponding entries in the @a name array.
5488	</desc>
5489	</param>
5490	<param name="flags" type="wstring" dir="out" safearray="yes">
5491	<desc>
5492	The flags of the properties returned. The array entries match the
5493	corresponding entries in the @a name array.
5494	</desc>
5495	</param>
5496	</method>
5497
5498	<method name="querySavedGuestSize">
5499	<desc>
5500	Returns the guest dimensions from the saved state.
5501	</desc>
5502	<param name="screenId" type="unsigned long" dir="in">
5503	<desc>
5504	Saved guest screen to query info from.
5505	</desc>
5506	</param>
5507	<param name="width" type="unsigned long" dir="out">
5508	<desc>
5509	Guest width at the time of the saved state was taken.
5510	</desc>
5511	</param>
5512	<param name="height" type="unsigned long" dir="out">
5513	<desc>
5514	Guest height at the time of the saved state was taken.
5515	</desc>
5516	</param>
5517	</method>
5518
5519	<method name="querySavedThumbnailSize">
5520	<desc>
5521	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5522	</desc>
5523	<param name="screenId" type="unsigned long" dir="in">
5524	<desc>
5525	Saved guest screen to query info from.
5526	</desc>
5527	</param>
5528	<param name="size" type="unsigned long" dir="out">
5529	<desc>
5530	Size of buffer required to store the bitmap.
5531	</desc>
5532	</param>
5533	<param name="width" type="unsigned long" dir="out">
5534	<desc>
5535	Bitmap width.
5536	</desc>
5537	</param>
5538	<param name="height" type="unsigned long" dir="out">
5539	<desc>
5540	Bitmap height.
5541	</desc>
5542	</param>
5543	</method>
5544
5545	<method name="readSavedThumbnailToArray">
5546	<desc>
5547	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5548	</desc>
5549	<param name="screenId" type="unsigned long" dir="in">
5550	<desc>
5551	Saved guest screen to read from.
5552	</desc>
5553	</param>
5554	<param name="BGR" type="boolean" dir="in">
5555	<desc>
5556	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5557	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5558	</desc>
5559	</param>
5560	<param name="width" type="unsigned long" dir="out">
5561	<desc>
5562	Bitmap width.
5563	</desc>
5564	</param>
5565	<param name="height" type="unsigned long" dir="out">
5566	<desc>
5567	Bitmap height.
5568	</desc>
5569	</param>
5570	<param name="data" type="octet" safearray="yes" dir="return">
5571	<desc>
5572	Array with resulting bitmap data.
5573	</desc>
5574	</param>
5575	</method>
5576
5577	<method name="readSavedThumbnailPNGToArray">
5578	<desc>
5579	Thumbnail in PNG format is retrieved to an array of bytes.
5580	</desc>
5581	<param name="screenId" type="unsigned long" dir="in">
5582	<desc>
5583	Saved guest screen to read from.
5584	</desc>
5585	</param>
5586	<param name="width" type="unsigned long" dir="out">
5587	<desc>
5588	Image width.
5589	</desc>
5590	</param>
5591	<param name="height" type="unsigned long" dir="out">
5592	<desc>
5593	Image height.
5594	</desc>
5595	</param>
5596	<param name="data" type="octet" dir="return" safearray="yes">
5597	<desc>
5598	Array with resulting PNG data.
5599	</desc>
5600	</param>
5601	</method>
5602
5603	<method name="querySavedScreenshotPNGSize">
5604	<desc>
5605	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5606	</desc>
5607	<param name="screenId" type="unsigned long" dir="in">
5608	<desc>
5609	Saved guest screen to query info from.
5610	</desc>
5611	</param>
5612	<param name="size" type="unsigned long" dir="out">
5613	<desc>
5614	Size of buffer required to store the PNG binary data.
5615	</desc>
5616	</param>
5617	<param name="width" type="unsigned long" dir="out">
5618	<desc>
5619	Image width.
5620	</desc>
5621	</param>
5622	<param name="height" type="unsigned long" dir="out">
5623	<desc>
5624	Image height.
5625	</desc>
5626	</param>
5627	</method>
5628
5629	<method name="readSavedScreenshotPNGToArray">
5630	<desc>
5631	Screenshot in PNG format is retrieved to an array of bytes.
5632	</desc>
5633	<param name="screenId" type="unsigned long" dir="in">
5634	<desc>
5635	Saved guest screen to read from.
5636	</desc>
5637	</param>
5638	<param name="width" type="unsigned long" dir="out">
5639	<desc>
5640	Image width.
5641	</desc>
5642	</param>
5643	<param name="height" type="unsigned long" dir="out">
5644	<desc>
5645	Image height.
5646	</desc>
5647	</param>
5648	<param name="data" type="octet" dir="return" safearray="yes">
5649	<desc>
5650	Array with resulting PNG data.
5651	</desc>
5652	</param>
5653	</method>
5654
5655	<method name="hotPlugCPU">
5656	<desc>
5657	Plugs a CPU into the machine.
5658	</desc>
5659	<param name="cpu" type="unsigned long" dir="in">
5660	<desc>
5661	The CPU id to insert.
5662	</desc>
5663	</param>
5664	</method>
5665
5666	<method name="hotUnplugCPU">
5667	<desc>
5668	Removes a CPU from the machine.
5669	</desc>
5670	<param name="cpu" type="unsigned long" dir="in">
5671	<desc>
5672	The CPU id to remove.
5673	</desc>
5674	</param>
5675	</method>
5676
5677	<method name="getCPUStatus">
5678	<desc>
5679	Returns the current status of the given CPU.
5680	</desc>
5681	<param name="cpu" type="unsigned long" dir="in">
5682	<desc>
5683	The CPU id to check for.
5684	</desc>
5685	</param>
5686	<param name="attached" type="boolean" dir="return">
5687	<desc>
5688	Status of the CPU.
5689	</desc>
5690	</param>
5691	</method>
5692
5693	<method name="queryLogFilename">
5694	<desc>
5695	Queries for the VM log file name of an given index. Returns an empty
5696	string if a log file with that index doesn't exists.
5697	</desc>
5698	<param name="idx" type="unsigned long" dir="in">
5699	<desc>
5700	Which log file name to query. 0=current log file.
5701	</desc>
5702	</param>
5703	<param name="filename" type="wstring" dir="return">
5704	<desc>
5705	On return the full path to the log file or an empty string on error.
5706	</desc>
5707	</param>
5708	</method>
5709
5710	<method name="readLog">
5711	<desc>
5712	Reads the VM log file. The chunk size is limited, so even if you
5713	ask for a big piece there might be less data returned.
5714	</desc>
5715	<param name="idx" type="unsigned long" dir="in">
5716	<desc>
5717	Which log file to read. 0=current log file.
5718	</desc>
5719	</param>
5720	<param name="offset" type="long long" dir="in">
5721	<desc>
5722	Offset in the log file.
5723	</desc>
5724	</param>
5725	<param name="size" type="long long" dir="in">
5726	<desc>
5727	Chunk size to read in the log file.
5728	</desc>
5729	</param>
5730	<param name="data" type="octet" dir="return" safearray="yes">
5731	<desc>
5732	Data read from the log file. A data size of 0 means end of file
5733	if the requested chunk size was not 0. This is the unprocessed
5734	file data, i.e. the line ending style depends on the platform of
5735	the system the server is running on.
5736	</desc>
5737	</param>
5738	</method>
5739	</interface>
5740
5741	<!--
5742	// IConsole
5743	/////////////////////////////////////////////////////////////////////////
5744	-->
5745
5746	<interface
5747	name="IRemoteDisplayInfo" extends="$unknown"
5748	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
5749	wsmap="struct"
5750	>
5751	<desc>
5752	Contains information about the remote display (VRDP) capabilities and status.
5753	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5754	</desc>
5755
5756	<attribute name="active" type="boolean" readonly="yes">
5757	<desc>
5758	Whether the remote display connection is active.
5759	</desc>
5760	</attribute>
5761
5762	<attribute name="port" type="long" readonly="yes">
5763	<desc>
5764	VRDP server port number. If this property is equal to <tt>0</tt>, then
5765	the VRDP server failed to start, usually because there are no free TCP
5766	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
5767	server has not yet been started.
5768	</desc>
5769	</attribute>
5770
5771	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5772	<desc>
5773	How many times a client connected.
5774	</desc>
5775	</attribute>
5776
5777	<attribute name="beginTime" type="long long" readonly="yes">
5778	<desc>
5779	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5780	</desc>
5781	</attribute>
5782
5783	<attribute name="endTime" type="long long" readonly="yes">
5784	<desc>
5785	When the last connection was terminated or the current time, if
5786	connection is still active, in milliseconds since 1970-01-01 UTC.
5787	</desc>
5788	</attribute>
5789
5790	<attribute name="bytesSent" type="long long" readonly="yes">
5791	<desc>
5792	How many bytes were sent in last or current, if still active, connection.
5793	</desc>
5794	</attribute>
5795
5796	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5797	<desc>
5798	How many bytes were sent in all connections.
5799	</desc>
5800	</attribute>
5801
5802	<attribute name="bytesReceived" type="long long" readonly="yes">
5803	<desc>
5804	How many bytes were received in last or current, if still active, connection.
5805	</desc>
5806	</attribute>
5807
5808	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5809	<desc>
5810	How many bytes were received in all connections.
5811	</desc>
5812	</attribute>
5813
5814	<attribute name="user" type="wstring" readonly="yes">
5815	<desc>
5816	Login user name supplied by the client.
5817	</desc>
5818	</attribute>
5819
5820	<attribute name="domain" type="wstring" readonly="yes">
5821	<desc>
5822	Login domain name supplied by the client.
5823	</desc>
5824	</attribute>
5825
5826	<attribute name="clientName" type="wstring" readonly="yes">
5827	<desc>
5828	The client name supplied by the client.
5829	</desc>
5830	</attribute>
5831
5832	<attribute name="clientIP" type="wstring" readonly="yes">
5833	<desc>
5834	The IP address of the client.
5835	</desc>
5836	</attribute>
5837
5838	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5839	<desc>
5840	The client software version number.
5841	</desc>
5842	</attribute>
5843
5844	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5845	<desc>
5846	Public key exchange method used when connection was established.
5847	Values: 0 - RDP4 public key exchange scheme.
5848	1 - X509 certificates were sent to client.
5849	</desc>
5850	</attribute>
5851
5852	</interface>
5853
5854	<interface
5855	name="IConsole" extends="$unknown"
5856	uuid="03cb7897-ea17-4e6c-81ae-4bd90be2fde2"
5857	wsmap="managed"
5858	>
5859	<desc>
5860	The IConsole interface represents an interface to control virtual
5861	machine execution.
5862
5863	A console object gets created when a machine has been locked for a
5864	particular session (client process) using <link to="IMachine::lockMachine" />
5865	or <link to="IMachine::launchVMProcess"/>. The console object can
5866	then be found in the session's <link to="ISession::console" /> attribute.
5867
5868	Methods of the IConsole interface allow the caller to query the current
5869	virtual machine execution state, pause the machine or power it down, save
5870	the machine state or take a snapshot, attach and detach removable media
5871	and so on.
5872
5873	<see>ISession</see>
5874	</desc>
5875
5876	<attribute name="machine" type="IMachine" readonly="yes">
5877	<desc>
5878	Machine object this console is sessioned with.
5879	<note>
5880	This is a convenience property, it has the same value as
5881	<link to="ISession::machine"/> of the corresponding session
5882	object.
5883	</note>
5884	</desc>
5885	</attribute>
5886
5887	<attribute name="state" type="MachineState" readonly="yes">
5888	<desc>
5889	Current execution state of the machine.
5890	<note>
5891	This property always returns the same value as the corresponding
5892	property of the IMachine object this console is sessioned with.
5893	For the process that owns (executes) the VM, this is the
5894	preferable way of querying the VM state, because no IPC
5895	calls are made.
5896	</note>
5897	</desc>
5898	</attribute>
5899
5900	<attribute name="guest" type="IGuest" readonly="yes">
5901	<desc>Guest object.</desc>
5902	</attribute>
5903
5904	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5905	<desc>
5906	Virtual keyboard object.
5907	<note>
5908	If the machine is not running, any attempt to use
5909	the returned object will result in an error.
5910	</note>
5911	</desc>
5912	</attribute>
5913
5914	<attribute name="mouse" type="IMouse" readonly="yes">
5915	<desc>
5916	Virtual mouse object.
5917	<note>
5918	If the machine is not running, any attempt to use
5919	the returned object will result in an error.
5920	</note>
5921	</desc>
5922	</attribute>
5923
5924	<attribute name="display" type="IDisplay" readonly="yes">
5925	<desc>Virtual display object.
5926	<note>
5927	If the machine is not running, any attempt to use
5928	the returned object will result in an error.
5929	</note>
5930	</desc>
5931	</attribute>
5932
5933	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5934	<desc>Debugging interface.</desc>
5935	</attribute>
5936
5937	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5938	<desc>
5939	Collection of USB devices currently attached to the virtual
5940	USB controller.
5941	<note>
5942	The collection is empty if the machine is not running.
5943	</note>
5944	</desc>
5945	</attribute>
5946
5947	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5948	<desc>
5949	List of USB devices currently attached to the remote VRDP client.
5950	Once a new device is physically attached to the remote host computer,
5951	it appears in this list and remains there until detached.
5952	</desc>
5953	</attribute>
5954
5955	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5956	<desc>
5957	Collection of shared folders for the current session. These folders
5958	are called transient shared folders because they are available to the
5959	guest OS running inside the associated virtual machine only for the
5960	duration of the session (as opposed to
5961	<link to="IMachine::sharedFolders"/> which represent permanent shared
5962	folders). When the session is closed (e.g. the machine is powered down),
5963	these folders are automatically discarded.
5964
5965	New shared folders are added to the collection using
5966	<link to="#createSharedFolder"/>. Existing shared folders can be
5967	removed using <link to="#removeSharedFolder"/>.
5968	</desc>
5969	</attribute>
5970
5971	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
5972	<desc>
5973	Interface that provides information on Remote Display (VRDP) connection.
5974	</desc>
5975	</attribute>
5976
5977	<attribute name="eventSource" type="IEventSource" readonly="yes">
5978	<desc>
5979	Event source for console events.
5980	</desc>
5981	</attribute>
5982
5983	<method name="powerUp">
5984	<desc>
5985	Starts the virtual machine execution using the current machine
5986	state (that is, its current execution state, current settings and
5987	current storage devices).
5988
5989	<note>
5990	This method is only useful for front-ends that want to actually
5991	execute virtual machines in their own process (like the VirtualBox
5992	or VBoxSDL front-ends). Unless you are intending to write such a
5993	front-end, do not call this method. If you simply want to
5994	start virtual machine execution using one of the existing front-ends
5995	(for example the VirtualBox GUI or headless server), use
5996	<link to="IMachine::launchVMProcess"/> instead; these
5997	front-ends will power up the machine automatically for you.
5998	</note>
5999
6000	If the machine is powered off or aborted, the execution will
6001	start from the beginning (as if the real hardware were just
6002	powered on).
6003
6004	If the machine is in the <link to="MachineState_Saved"/> state,
6005	it will continue its execution the point where the state has
6006	been saved.
6007
6008	If the machine <link to="IMachine::teleporterEnabled"/> property is
6009	enabled on the machine being powered up, the machine will wait for an
6010	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6011	state. The returned progress object will have at least three
6012	operations where the last three are defined as: (1) powering up and
6013	starting TCP server, (2) waiting for incoming teleportations, and
6014	(3) perform teleportation. These operations will be reflected as the
6015	last three operations of the progress objected returned by
6016	<link to="IMachine::launchVMProcess"/> as well.
6017
6018	<see>#saveState</see>
6019
6020	<result name="VBOX_E_INVALID_VM_STATE">
6021	Virtual machine already running.
6022	</result>
6023	<result name="VBOX_E_HOST_ERROR">
6024	Host interface does not exist or name not set.
6025	</result>
6026	<result name="VBOX_E_FILE_ERROR">
6027	Invalid saved state file.
6028	</result>
6029	</desc>
6030	<param name="progress" type="IProgress" dir="return">
6031	<desc>Progress object to track the operation completion.</desc>
6032	</param>
6033	</method>
6034
6035	<method name="powerUpPaused">
6036	<desc>
6037	Identical to powerUp except that the VM will enter the
6038	<link to="MachineState_Paused"/> state, instead of
6039	<link to="MachineState_Running"/>.
6040
6041	<see>#powerUp</see>
6042	<result name="VBOX_E_INVALID_VM_STATE">
6043	Virtual machine already running.
6044	</result>
6045	<result name="VBOX_E_HOST_ERROR">
6046	Host interface does not exist or name not set.
6047	</result>
6048	<result name="VBOX_E_FILE_ERROR">
6049	Invalid saved state file.
6050	</result>
6051	</desc>
6052	<param name="progress" type="IProgress" dir="return">
6053	<desc>Progress object to track the operation completion.</desc>
6054	</param>
6055	</method>
6056
6057	<method name="powerDown">
6058	<desc>
6059	Initiates the power down procedure to stop the virtual machine
6060	execution.
6061
6062	The completion of the power down procedure is tracked using the returned
6063	IProgress object. After the operation is complete, the machine will go
6064	to the PoweredOff state.
6065	<result name="VBOX_E_INVALID_VM_STATE">
6066	Virtual machine must be Running, Paused or Stuck to be powered down.
6067	</result>
6068	</desc>
6069	<param name="progress" type="IProgress" dir="return">
6070	<desc>Progress object to track the operation completion.</desc>
6071	</param>
6072	</method>
6073
6074	<method name="reset">
6075	<desc>Resets the virtual machine.
6076	<result name="VBOX_E_INVALID_VM_STATE">
6077	Virtual machine not in Running state.
6078	</result>
6079	<result name="VBOX_E_VM_ERROR">
6080	Virtual machine error in reset operation.
6081	</result>
6082	</desc>
6083	</method>
6084
6085	<method name="pause">
6086	<desc>Pauses the virtual machine execution.
6087	<result name="VBOX_E_INVALID_VM_STATE">
6088	Virtual machine not in Running state.
6089	</result>
6090	<result name="VBOX_E_VM_ERROR">
6091	Virtual machine error in suspend operation.
6092	</result>
6093	</desc>
6094	</method>
6095
6096	<method name="resume">
6097	<desc>Resumes the virtual machine execution.
6098	<result name="VBOX_E_INVALID_VM_STATE">
6099	Virtual machine not in Paused state.
6100	</result>
6101	<result name="VBOX_E_VM_ERROR">
6102	Virtual machine error in resume operation.
6103	</result>
6104	</desc>
6105	</method>
6106
6107	<method name="powerButton">
6108	<desc>Sends the ACPI power button event to the guest.
6109	<result name="VBOX_E_INVALID_VM_STATE">
6110	Virtual machine not in Running state.
6111	</result>
6112	<result name="VBOX_E_PDM_ERROR">
6113	Controlled power off failed.
6114	</result>
6115	</desc>
6116	</method>
6117
6118	<method name="sleepButton">
6119	<desc>Sends the ACPI sleep button event to the guest.
6120	<result name="VBOX_E_INVALID_VM_STATE">
6121	Virtual machine not in Running state.
6122	</result>
6123	<result name="VBOX_E_PDM_ERROR">
6124	Sending sleep button event failed.
6125	</result>
6126	</desc>
6127	</method>
6128
6129	<method name="getPowerButtonHandled">
6130	<desc>Checks if the last power button event was handled by guest.
6131	<result name="VBOX_E_PDM_ERROR">
6132	Checking if the event was handled by the guest OS failed.
6133	</result>
6134	</desc>
6135	<param name="handled" type="boolean" dir="return"/>
6136	</method>
6137
6138	<method name="getGuestEnteredACPIMode">
6139	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6140	G1 (sleeping). If this method returns @c false, the guest will
6141	most likely not respond to external ACPI events.
6142	<result name="VBOX_E_INVALID_VM_STATE">
6143	Virtual machine not in Running state.
6144	</result>
6145	</desc>
6146	<param name="entered" type="boolean" dir="return"/>
6147	</method>
6148
6149	<method name="saveState">
6150	<desc>
6151	Saves the current execution state of a running virtual machine
6152	and stops its execution.
6153
6154	After this operation completes, the machine will go to the
6155	Saved state. Next time it is powered up, this state will
6156	be restored and the machine will continue its execution from
6157	the place where it was saved.
6158
6159	This operation differs from taking a snapshot to the effect
6160	that it doesn't create new differencing media. Also, once
6161	the machine is powered up from the state saved using this method,
6162	the saved state is deleted, so it will be impossible to return
6163	to this state later.
6164
6165	<note>
6166	On success, this method implicitly calls
6167	<link to="IMachine::saveSettings"/> to save all current machine
6168	settings (including runtime changes to the DVD medium, etc.).
6169	Together with the impossibility to change any VM settings when it is
6170	in the Saved state, this guarantees adequate hardware
6171	configuration of the machine when it is restored from the saved
6172	state file.
6173	</note>
6174
6175	<note>
6176	The machine must be in the Running or Paused state, otherwise
6177	the operation will fail.
6178	</note>
6179	<result name="VBOX_E_INVALID_VM_STATE">
6180	Virtual machine state neither Running nor Paused.
6181	</result>
6182	<result name="VBOX_E_FILE_ERROR">
6183	Failed to create directory for saved state file.
6184	</result>
6185
6186	<see><link to="#takeSnapshot"/></see>
6187	</desc>
6188	<param name="progress" type="IProgress" dir="return">
6189	<desc>Progress object to track the operation completion.</desc>
6190	</param>
6191	</method>
6192
6193	<method name="adoptSavedState">
6194	<desc>
6195	Associates the given saved state file to the virtual machine.
6196
6197	On success, the machine will go to the Saved state. Next time it is
6198	powered up, it will be restored from the adopted saved state and
6199	continue execution from the place where the saved state file was
6200	created.
6201
6202	The specified saved state file path may be absolute or relative to the
6203	folder the VM normally saves the state to (usually,
6204	<link to="IMachine::snapshotFolder"/>).
6205
6206	<note>
6207	It's a caller's responsibility to make sure the given saved state
6208	file is compatible with the settings of this virtual machine that
6209	represent its virtual hardware (memory size, storage disk configuration
6210	etc.). If there is a mismatch, the behavior of the virtual machine
6211	is undefined.
6212	</note>
6213	<result name="VBOX_E_INVALID_VM_STATE">
6214	Virtual machine state neither PoweredOff nor Aborted.
6215	</result>
6216	</desc>
6217	<param name="savedStateFile" type="wstring" dir="in">
6218	<desc>Path to the saved state file to adopt.</desc>
6219	</param>
6220	</method>
6221
6222	<method name="discardSavedState">
6223	<desc>
6224	Forcibly resets the machine to "Powered Off" state if it is
6225	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6226	Next time the machine is powered up, a clean boot will occur.
6227	<note>
6228	This operation is equivalent to resetting or powering off
6229	the machine without doing a proper shutdown of the guest
6230	operating system; as with resetting a running phyiscal
6231	computer, it can can lead to data loss.
6232	</note>
6233	If @a fRemoveFile is @c true, the file in the machine directory
6234	into which the machine state was saved is also deleted. If
6235	this is @c false, then the state can be recovered and later
6236	re-inserted into a machine using <link to="#adoptSavedState" />.
6237	The location of the file can be found in the
6238	<link to="IMachine::stateFilePath" /> attribute.
6239	<result name="VBOX_E_INVALID_VM_STATE">
6240	Virtual machine not in state Saved.
6241	</result>
6242	</desc>
6243	<param name="fRemoveFile" type="boolean" dir="in" >
6244	<desc>Whether to also remove the saved state file.</desc>
6245	</param>
6246	</method>
6247
6248	<method name="getDeviceActivity">
6249	<desc>
6250	Gets the current activity type of a given device or device group.
6251	<result name="E_INVALIDARG">
6252	Invalid device type.
6253	</result>
6254	</desc>
6255	<param name="type" type="DeviceType" dir="in"/>
6256	<param name="activity" type="DeviceActivity" dir="return"/>
6257	</method>
6258
6259	<method name="attachUSBDevice">
6260	<desc>
6261	Attaches a host USB device with the given UUID to the
6262	USB controller of the virtual machine.
6263
6264	The device needs to be in one of the following states:
6265	<link to="USBDeviceState_Busy"/>,
6266	<link to="USBDeviceState_Available"/> or
6267	<link to="USBDeviceState_Held"/>,
6268	otherwise an error is immediately returned.
6269
6270	When the device state is
6271	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6272	be returned if the host computer refuses to release it for some reason.
6273
6274	<see>IUSBController::deviceFilters, USBDeviceState</see>
6275	<result name="VBOX_E_INVALID_VM_STATE">
6276	Virtual machine state neither Running nor Paused.
6277	</result>
6278	<result name="VBOX_E_PDM_ERROR">
6279	Virtual machine does not have a USB controller.
6280	</result>
6281	</desc>
6282	<param name="id" type="uuid" mod="string" dir="in">
6283	<desc>UUID of the host USB device to attach.</desc>
6284	</param>
6285	</method>
6286
6287	<method name="detachUSBDevice">
6288	<desc>
6289	Detaches an USB device with the given UUID from the USB controller
6290	of the virtual machine.
6291
6292	After this method succeeds, the VirtualBox server re-initiates
6293	all USB filters as if the device were just physically attached
6294	to the host, but filters of this machine are ignored to avoid
6295	a possible automatic re-attachment.
6296
6297	<see>IUSBController::deviceFilters, USBDeviceState</see>
6298
6299	<result name="VBOX_E_PDM_ERROR">
6300	Virtual machine does not have a USB controller.
6301	</result>
6302	<result name="E_INVALIDARG">
6303	USB device not attached to this virtual machine.
6304	</result>
6305	</desc>
6306	<param name="id" type="uuid" mod="string" dir="in">
6307	<desc>UUID of the USB device to detach.</desc>
6308	</param>
6309	<param name="device" type="IUSBDevice" dir="return">
6310	<desc>Detached USB device.</desc>
6311	</param>
6312	</method>
6313
6314	<method name="findUSBDeviceByAddress">
6315	<desc>
6316	Searches for a USB device with the given host address.
6317
6318	<result name="VBOX_E_OBJECT_NOT_FOUND">
6319	Given @c name does not correspond to any USB device.
6320	</result>
6321
6322	<see>IUSBDevice::address</see>
6323	</desc>
6324	<param name="name" type="wstring" dir="in">
6325	<desc>
6326	Address of the USB device (as assigned by the host) to
6327	search for.
6328	</desc>
6329	</param>
6330	<param name="device" type="IUSBDevice" dir="return">
6331	<desc>Found USB device object.</desc>
6332	</param>
6333	</method>
6334
6335	<method name="findUSBDeviceById">
6336	<desc>
6337	Searches for a USB device with the given UUID.
6338
6339	<result name="VBOX_E_OBJECT_NOT_FOUND">
6340	Given @c id does not correspond to any USB device.
6341	</result>
6342
6343	<see>IUSBDevice::id</see>
6344	</desc>
6345	<param name="id" type="uuid" mod="string" dir="in">
6346	<desc>UUID of the USB device to search for.</desc>
6347	</param>
6348	<param name="device" type="IUSBDevice" dir="return">
6349	<desc>Found USB device object.</desc>
6350	</param>
6351	</method>
6352
6353	<method name="createSharedFolder">
6354	<desc>
6355	Creates a transient new shared folder by associating the given logical
6356	name with the given host path, adds it to the collection of shared
6357	folders and starts sharing it. Refer to the description of
6358	<link to="ISharedFolder"/> to read more about logical names.
6359
6360	<result name="VBOX_E_INVALID_VM_STATE">
6361	Virtual machine in Saved state or currently changing state.
6362	</result>
6363	<result name="VBOX_E_FILE_ERROR">
6364	Shared folder already exists or not accessible.
6365	</result>
6366	</desc>
6367	<param name="name" type="wstring" dir="in">
6368	<desc>Unique logical name of the shared folder.</desc>
6369	</param>
6370	<param name="hostPath" type="wstring" dir="in">
6371	<desc>Full path to the shared folder in the host file system.</desc>
6372	</param>
6373	<param name="writable" type="boolean" dir="in">
6374	<desc>Whether the share is writable or readonly</desc>
6375	</param>
6376	<param name="automount" type="boolean" dir="in">
6377	<desc>Whether the share gets automatically mounted by the guest
6378	or not.</desc>
6379	</param>
6380	</method>
6381
6382	<method name="removeSharedFolder">
6383	<desc>
6384	Removes a transient shared folder with the given name previously
6385	created by <link to="#createSharedFolder"/> from the collection of
6386	shared folders and stops sharing it.
6387	<result name="VBOX_E_INVALID_VM_STATE">
6388	Virtual machine in Saved state or currently changing state.
6389	</result>
6390	<result name="VBOX_E_FILE_ERROR">
6391	Shared folder does not exists.
6392	</result>
6393	</desc>
6394	<param name="name" type="wstring" dir="in">
6395	<desc>Logical name of the shared folder to remove.</desc>
6396	</param>
6397	</method>
6398
6399	<method name="takeSnapshot">
6400	<desc>
6401	Saves the current execution state
6402	and all settings of the machine and creates differencing images
6403	for all normal (non-independent) media.
6404	See <link to="ISnapshot" /> for an introduction to snapshots.
6405
6406	This method can be called for a PoweredOff, Saved (see
6407	<link to="#saveState"/>), Running or
6408	Paused virtual machine. When the machine is PoweredOff, an
6409	offline snapshot is created. When the machine is Running a live
6410	snapshot is created, and an online snapshot is is created when Paused.
6411
6412	The taken snapshot is always based on the
6413	<link to="IMachine::currentSnapshot">current snapshot</link>
6414	of the associated virtual machine and becomes a new current snapshot.
6415
6416	<note>
6417	This method implicitly calls <link to="IMachine::saveSettings"/> to
6418	save all current machine settings before taking an offline snapshot.
6419	</note>
6420
6421	<result name="VBOX_E_INVALID_VM_STATE">
6422	Virtual machine currently changing state.
6423	</result>
6424	</desc>
6425	<param name="name" type="wstring" dir="in">
6426	<desc>Short name for the snapshot.</desc>
6427	</param>
6428	<param name="description" type="wstring" dir="in">
6429	<desc>Optional description of the snapshot.</desc>
6430	</param>
6431	<param name="progress" type="IProgress" dir="return">
6432	<desc>Progress object to track the operation completion.</desc>
6433	</param>
6434	</method>
6435
6436	<method name="deleteSnapshot">
6437	<desc>
6438	Starts deleting the specified snapshot asynchronously.
6439	See <link to="ISnapshot" /> for an introduction to snapshots.
6440
6441	The execution state and settings of the associated machine stored in
6442	the snapshot will be deleted. The contents of all differencing media of
6443	this snapshot will be merged with the contents of their dependent child
6444	media to keep the medium chain valid (in other words, all changes
6445	represented by media being deleted will be propagated to their child
6446	medium). After that, this snapshot's differencing medium will be
6447	deleted. The parent of this snapshot will become a new parent for all
6448	its child snapshots.
6449
6450	If the deleted snapshot is the current one, its parent snapshot will
6451	become a new current snapshot. The current machine state is not directly
6452	affected in this case, except that currently attached differencing
6453	media based on media of the deleted snapshot will be also merged as
6454	described above.
6455
6456	If the deleted snapshot is the first or current snapshot, then the
6457	respective IMachine attributes will be adjusted. Deleting the current
6458	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6459	to make all current machine settings permanent.
6460
6461	Deleting a snapshot has the following preconditions:
6462
6463	<ul>
6464	<li>Child media of all normal media of the deleted snapshot
6465	must be accessible (see <link to="IMedium::state"/>) for this
6466	operation to succeed. In particular, this means that all virtual
6467	machines, whose media are directly or indirectly based on the
6468	media of deleted snapshot, must be powered off.</li>
6469
6470	<li>You cannot delete the snapshot if a medium attached to it has
6471	more than once child medium (differencing images) because otherwise
6472	merging would be impossible. This might be the case if there is
6473	more than one child snapshot or differencing images were created
6474	for other reason (e.g. implicitly because of multiple machine
6475	attachments).</li>
6476	</ul>
6477
6478
6479	The virtual machine's <link to="IMachine::state">state</link> is
6480	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6481	"DeletingSnapshotPaused" while this operation is in progress.
6482
6483	<note>
6484	Merging medium contents can be very time and disk space
6485	consuming, if these media are big in size and have many
6486	children. However, if the snapshot being deleted is the last
6487	(head) snapshot on the branch, the operation will be rather
6488	quick.
6489	</note>
6490	<result name="VBOX_E_INVALID_VM_STATE">
6491	The running virtual machine prevents deleting this snapshot. This
6492	happens only in very specific situations, usually snapshots can be
6493	deleted without trouble while a VM is running. The error message
6494	text explains the reason for the failure.
6495	</result>
6496	</desc>
6497	<param name="id" type="uuid" mod="string" dir="in">
6498	<desc>UUID of the snapshot to delete.</desc>
6499	</param>
6500	<param name="progress" type="IProgress" dir="return">
6501	<desc>Progress object to track the operation completion.</desc>
6502	</param>
6503	</method>
6504
6505	<method name="restoreSnapshot">
6506	<desc>
6507	Starts resetting the machine's current state to the state contained
6508	in the given snapshot, asynchronously. All current settings of the
6509	machine will be reset and changes stored in differencing media
6510	will be lost.
6511	See <link to="ISnapshot" /> for an introduction to snapshots.
6512
6513	After this operation is successfully completed, new empty differencing
6514	media are created for all normal media of the machine.
6515
6516	If the given snapshot is an online snapshot, the machine will go to
6517	the <link to="MachineState_Saved"> saved state</link>, so that the
6518	next time it is powered on, the execution state will be restored
6519	from the state of the snapshot.
6520
6521	<note>
6522	The machine must not be running, otherwise the operation will fail.
6523	</note>
6524
6525	<note>
6526	If the machine state is <link to="MachineState_Saved">Saved</link>
6527	prior to this operation, the saved state file will be implicitly
6528	deleted (as if <link to="IConsole::discardSavedState"/> were
6529	called).
6530	</note>
6531
6532	<result name="VBOX_E_INVALID_VM_STATE">
6533	Virtual machine is running.
6534	</result>
6535	</desc>
6536	<param name="snapshot" type="ISnapshot" dir="in">
6537	<desc>The snapshot to restore the VM state from.</desc>
6538	</param>
6539	<param name="progress" type="IProgress" dir="return">
6540	<desc>Progress object to track the operation completion.</desc>
6541	</param>
6542	</method>
6543
6544	<method name="teleport">
6545	<desc>
6546	Teleport the VM to a different host machine or process.
6547
6548	TODO explain the details.
6549
6550	<result name="VBOX_E_INVALID_VM_STATE">
6551	Virtual machine not running or paused.
6552	</result>
6553	</desc>
6554	<param name="hostname" type="wstring" dir="in">
6555	<desc>The name or IP of the host to teleport to.</desc>
6556	</param>
6557	<param name="tcpport" type="unsigned long" dir="in">
6558	<desc>The TCP port to connect to (1..65535).</desc>
6559	</param>
6560	<param name="password" type="wstring" dir="in">
6561	<desc>The password.</desc>
6562	</param>
6563	<param name="maxDowntime" type="unsigned long" dir="in">
6564	<desc>
6565	The maximum allowed downtime given as milliseconds. 0 is not a valid
6566	value. Recommended value: 250 ms.
6567
6568	The higher the value is, the greater the chance for a successful
6569	teleportation. A small value may easily result in the teleportation
6570	process taking hours and eventually fail.
6571
6572	<note>
6573	The current implementation treats this a guideline, not as an
6574	absolute rule.
6575	</note>
6576	</desc>
6577	</param>
6578	<param name="progress" type="IProgress" dir="return">
6579	<desc>Progress object to track the operation completion.</desc>
6580	</param>
6581	</method>
6582
6583	</interface>
6584
6585	<!--
6586	// IHost
6587	/////////////////////////////////////////////////////////////////////////
6588	-->
6589
6590	<enum
6591	name="HostNetworkInterfaceMediumType"
6592	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6593	>
6594	<desc>
6595	Type of encapsulation. Ethernet encapsulation includes both wired and
6596	wireless Ethernet connections.
6597	<see>IHostNetworkInterface</see>
6598	</desc>
6599
6600	<const name="Unknown" value="0">
6601	<desc>
6602	The type of interface cannot be determined.
6603	</desc>
6604	</const>
6605	<const name="Ethernet" value="1">
6606	<desc>
6607	Ethernet frame encapsulation.
6608	</desc>
6609	</const>
6610	<const name="PPP" value="2">
6611	<desc>
6612	Point-to-point protocol encapsulation.
6613	</desc>
6614	</const>
6615	<const name="SLIP" value="3">
6616	<desc>
6617	Serial line IP encapsulation.
6618	</desc>
6619	</const>
6620	</enum>
6621
6622	<enum
6623	name="HostNetworkInterfaceStatus"
6624	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6625	>
6626	<desc>
6627	Current status of the interface.
6628	<see>IHostNetworkInterface</see>
6629	</desc>
6630
6631	<const name="Unknown" value="0">
6632	<desc>
6633	The state of interface cannot be determined.
6634	</desc>
6635	</const>
6636	<const name="Up" value="1">
6637	<desc>
6638	The interface is fully operational.
6639	</desc>
6640	</const>
6641	<const name="Down" value="2">
6642	<desc>
6643	The interface is not functioning.
6644	</desc>
6645	</const>
6646	</enum>
6647
6648	<enum
6649	name="HostNetworkInterfaceType"
6650	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6651	>
6652	<desc>
6653	Network interface type.
6654	</desc>
6655	<const name="Bridged" value="1"/>
6656	<const name="HostOnly" value="2"/>
6657	</enum>
6658
6659	<interface
6660	name="IHostNetworkInterface" extends="$unknown"
6661	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6662	wsmap="managed"
6663	>
6664	<desc>
6665	Represents one of host's network interfaces. IP V6 address and network
6666	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6667	separated by colons.
6668	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6669	</desc>
6670	<attribute name="name" type="wstring" readonly="yes">
6671	<desc>Returns the host network interface name.</desc>
6672	</attribute>
6673
6674	<attribute name="id" type="uuid" mod="string" readonly="yes">
6675	<desc>Returns the interface UUID.</desc>
6676	</attribute>
6677
6678	<attribute name="networkName" type="wstring" readonly="yes">
6679	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6680	</attribute>
6681
6682	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6683	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6684	</attribute>
6685
6686	<attribute name="IPAddress" type="wstring" readonly="yes">
6687	<desc>Returns the IP V4 address of the interface.</desc>
6688	</attribute>
6689
6690	<attribute name="networkMask" type="wstring" readonly="yes">
6691	<desc>Returns the network mask of the interface.</desc>
6692	</attribute>
6693
6694	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6695	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6696	</attribute>
6697
6698	<attribute name="IPV6Address" type="wstring" readonly="yes">
6699	<desc>Returns the IP V6 address of the interface.</desc>
6700	</attribute>
6701
6702	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6703	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6704	</attribute>
6705
6706	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6707	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6708	</attribute>
6709
6710	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6711	<desc>Type of protocol encapsulation used.</desc>
6712	</attribute>
6713
6714	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6715	<desc>Status of the interface.</desc>
6716	</attribute>
6717
6718	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6719	<desc>specifies the host interface type.</desc>
6720	</attribute>
6721
6722	<method name="enableStaticIpConfig">
6723	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6724	<param name="IPAddress" type="wstring" dir="in">
6725	<desc>
6726	IP address.
6727	</desc>
6728	</param>
6729	<param name="networkMask" type="wstring" dir="in">
6730	<desc>
6731	network mask.
6732	</desc>
6733	</param>
6734	</method>
6735
6736	<method name="enableStaticIpConfigV6">
6737	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6738	<param name="IPV6Address" type="wstring" dir="in">
6739	<desc>
6740	IP address.
6741	</desc>
6742	</param>
6743	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6744	<desc>
6745	network mask.
6746	</desc>
6747	</param>
6748	</method>
6749
6750	<method name="enableDynamicIpConfig">
6751	<desc>enables the dynamic IP configuration.</desc>
6752	</method>
6753
6754	<method name="dhcpRediscover">
6755	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6756	</method>
6757
6758	</interface>
6759
6760	<interface
6761	name="IHost" extends="$unknown"
6762	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6763	wsmap="managed"
6764	>
6765	<desc>
6766	The IHost interface represents the physical machine that this VirtualBox
6767	installation runs on.
6768
6769	An object implementing this interface is returned by the
6770	<link to="IVirtualBox::host" /> attribute. This interface contains
6771	read-only information about the host's physical hardware (such as what
6772	processors and disks are available, what the host operating system is,
6773	and so on) and also allows for manipulating some of the host's hardware,
6774	such as global USB device filters and host interface networking.
6775
6776	</desc>
6777	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6778	<desc>List of DVD drives available on the host.</desc>
6779	</attribute>
6780
6781	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6782	<desc>List of floppy drives available on the host.</desc>
6783	</attribute>
6784
6785	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6786	<desc>
6787	List of USB devices currently attached to the host.
6788	Once a new device is physically attached to the host computer,
6789	it appears in this list and remains there until detached.
6790
6791	<note>
6792	If USB functionality is not available in the given edition of
6793	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6794	</note>
6795	</desc>
6796	</attribute>
6797
6798	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6799	<desc>
6800	List of USB device filters in action.
6801	When a new device is physically attached to the host computer,
6802	filters from this list are applied to it (in order they are stored
6803	in the list). The first matched filter will determine the
6804	<link to="IHostUSBDeviceFilter::action">action</link>
6805	performed on the device.
6806
6807	Unless the device is ignored by these filters, filters of all
6808	currently running virtual machines
6809	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6810
6811	<note>
6812	If USB functionality is not available in the given edition of
6813	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6814	</note>
6815
6816	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6817	</desc>
6818	</attribute>
6819
6820	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6821	<desc>List of host network interfaces currently defined on the host.</desc>
6822	</attribute>
6823
6824	<attribute name="processorCount" type="unsigned long" readonly="yes">
6825	<desc>Number of (logical) CPUs installed in the host system.</desc>
6826	</attribute>
6827
6828	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6829	<desc>Number of (logical) CPUs online in the host system.</desc>
6830	</attribute>
6831
6832	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6833	<desc>Number of physical processor cores installed in the host system.</desc>
6834	</attribute>
6835
6836	<method name="getProcessorSpeed">
6837	<desc>Query the (approximate) maximum speed of a specified host CPU in
6838	Megahertz.
6839	</desc>
6840	<param name="cpuId" type="unsigned long" dir="in">
6841	<desc>
6842	Identifier of the CPU.
6843	</desc>
6844	</param>
6845	<param name="speed" type="unsigned long" dir="return">
6846	<desc>
6847	Speed value. 0 is returned if value is not known or @a cpuId is
6848	invalid.
6849	</desc>
6850	</param>
6851	</method>
6852
6853	<method name="getProcessorFeature">
6854	<desc>Query whether a CPU feature is supported or not.</desc>
6855	<param name="feature" type="ProcessorFeature" dir="in">
6856	<desc>
6857	CPU Feature identifier.
6858	</desc>
6859	</param>
6860	<param name="supported" type="boolean" dir="return">
6861	<desc>
6862	Feature is supported or not.
6863	</desc>
6864	</param>
6865	</method>
6866
6867	<method name="getProcessorDescription">
6868	<desc>Query the model string of a specified host CPU.
6869	</desc>
6870	<param name="cpuId" type="unsigned long" dir="in">
6871	<desc>
6872	Identifier of the CPU.
6873	<note>
6874	The current implementation might not necessarily return the
6875	description for this exact CPU.
6876	</note>
6877	</desc>
6878	</param>
6879	<param name="description" type="wstring" dir="return">
6880	<desc>
6881	Model string. An empty string is returned if value is not known or
6882	@a cpuId is invalid.
6883	</desc>
6884	</param>
6885	</method>
6886
6887	<method name="getProcessorCPUIDLeaf">
6888	<desc>
6889	Returns the CPU cpuid information for the specified leaf.
6890	</desc>
6891	<param name="cpuId" type="unsigned long" dir="in">
6892	<desc>
6893	Identifier of the CPU. The CPU most be online.
6894	<note>
6895	The current implementation might not necessarily return the
6896	description for this exact CPU.
6897	</note>
6898	</desc>
6899	</param>
6900	<param name="leaf" type="unsigned long" dir="in">
6901	<desc>
6902	CPUID leaf index (eax).
6903	</desc>
6904	</param>
6905	<param name="subLeaf" type="unsigned long" dir="in">
6906	<desc>
6907	CPUID leaf sub index (ecx). This currently only applies to cache
6908	information on Intel CPUs. Use 0 if retriving values for
6909	<link to="IMachine::setCPUIDLeaf"/>.
6910	</desc>
6911	</param>
6912	<param name="valEax" type="unsigned long" dir="out">
6913	<desc>
6914	CPUID leaf value for register eax.
6915	</desc>
6916	</param>
6917	<param name="valEbx" type="unsigned long" dir="out">
6918	<desc>
6919	CPUID leaf value for register ebx.
6920	</desc>
6921	</param>
6922	<param name="valEcx" type="unsigned long" dir="out">
6923	<desc>
6924	CPUID leaf value for register ecx.
6925	</desc>
6926	</param>
6927	<param name="valEdx" type="unsigned long" dir="out">
6928	<desc>
6929	CPUID leaf value for register edx.
6930	</desc>
6931	</param>
6932	</method>
6933
6934	<attribute name="memorySize" type="unsigned long" readonly="yes">
6935	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6936	</attribute>
6937
6938	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6939	<desc>Available system memory in the host system.</desc>
6940	</attribute>
6941
6942	<attribute name="operatingSystem" type="wstring" readonly="yes">
6943	<desc>Name of the host system's operating system.</desc>
6944	</attribute>
6945
6946	<attribute name="OSVersion" type="wstring" readonly="yes">
6947	<desc>Host operating system's version string.</desc>
6948	</attribute>
6949
6950	<attribute name="UTCTime" type="long long" readonly="yes">
6951	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6952	</attribute>
6953
6954	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6955	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6956	</attribute>
6957
6958	<method name="createHostOnlyNetworkInterface">
6959	<desc>
6960	Creates a new adapter for Host Only Networking.
6961	<result name="E_INVALIDARG">
6962	Host network interface @a name already exists.
6963	</result>
6964	</desc>
6965	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6966	<desc>
6967	Created host interface object.
6968	</desc>
6969	</param>
6970	<param name="progress" type="IProgress" dir="return">
6971	<desc>
6972	Progress object to track the operation completion.
6973	</desc>
6974	</param>
6975	</method>
6976
6977	<method name="removeHostOnlyNetworkInterface">
6978	<desc>
6979	Removes the given Host Only Networking interface.
6980	<result name="VBOX_E_OBJECT_NOT_FOUND">
6981	No host network interface matching @a id found.
6982	</result>
6983	</desc>
6984	<param name="id" type="uuid" mod="string" dir="in">
6985	<desc>
6986	Adapter GUID.
6987	</desc>
6988	</param>
6989	<param name="progress" type="IProgress" dir="return">
6990	<desc>
6991	Progress object to track the operation completion.
6992	</desc>
6993	</param>
6994	</method>
6995
6996	<method name="createUSBDeviceFilter">
6997	<desc>
6998	Creates a new USB device filter. All attributes except
6999	the filter name are set to empty (any match),
7000	<i>active</i> is @c false (the filter is not active).
7001
7002	The created filter can be added to the list of filters using
7003	<link to="#insertUSBDeviceFilter"/>.
7004
7005	<see>#USBDeviceFilters</see>
7006	</desc>
7007	<param name="name" type="wstring" dir="in">
7008	<desc>
7009	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7010	</desc>
7011	</param>
7012	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7013	<desc>Created filter object.</desc>
7014	</param>
7015	</method>
7016
7017	<method name="insertUSBDeviceFilter">
7018	<desc>
7019	Inserts the given USB device to the specified position
7020	in the list of filters.
7021
7022	Positions are numbered starting from @c 0. If the specified
7023	position is equal to or greater than the number of elements in
7024	the list, the filter is added at the end of the collection.
7025
7026	<note>
7027	Duplicates are not allowed, so an attempt to insert a
7028	filter already in the list is an error.
7029	</note>
7030	<note>
7031	If USB functionality is not available in the given edition of
7032	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7033	</note>
7034
7035	<see>#USBDeviceFilters</see>
7036
7037	<result name="VBOX_E_INVALID_OBJECT_STATE">
7038	USB device filter is not created within this VirtualBox instance.
7039	</result>
7040	<result name="E_INVALIDARG">
7041	USB device filter already in list.
7042	</result>
7043
7044	</desc>
7045	<param name="position" type="unsigned long" dir="in">
7046	<desc>Position to insert the filter to.</desc>
7047	</param>
7048	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7049	<desc>USB device filter to insert.</desc>
7050	</param>
7051	</method>
7052
7053	<method name="removeUSBDeviceFilter">
7054	<desc>
7055	Removes a USB device filter from the specified position in the
7056	list of filters.
7057
7058	Positions are numbered starting from @c 0. Specifying a
7059	position equal to or greater than the number of elements in
7060	the list will produce an error.
7061
7062	<note>
7063	If USB functionality is not available in the given edition of
7064	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7065	</note>
7066
7067	<see>#USBDeviceFilters</see>
7068
7069	<result name="E_INVALIDARG">
7070	USB device filter list empty or invalid @a position.
7071	</result>
7072
7073	</desc>
7074	<param name="position" type="unsigned long" dir="in">
7075	<desc>Position to remove the filter from.</desc>
7076	</param>
7077	</method>
7078
7079	<method name="findHostDVDDrive">
7080	<desc>
7081	Searches for a host DVD drive with the given @c name.
7082
7083	<result name="VBOX_E_OBJECT_NOT_FOUND">
7084	Given @c name does not correspond to any host drive.
7085	</result>
7086
7087	</desc>
7088	<param name="name" type="wstring" dir="in">
7089	<desc>Name of the host drive to search for</desc>
7090	</param>
7091	<param name="drive" type="IMedium" dir="return">
7092	<desc>Found host drive object</desc>
7093	</param>
7094	</method>
7095
7096	<method name="findHostFloppyDrive">
7097	<desc>
7098	Searches for a host floppy drive with the given @c name.
7099
7100	<result name="VBOX_E_OBJECT_NOT_FOUND">
7101	Given @c name does not correspond to any host floppy drive.
7102	</result>
7103
7104	</desc>
7105	<param name="name" type="wstring" dir="in">
7106	<desc>Name of the host floppy drive to search for</desc>
7107	</param>
7108	<param name="drive" type="IMedium" dir="return">
7109	<desc>Found host floppy drive object</desc>
7110	</param>
7111	</method>
7112
7113	<method name="findHostNetworkInterfaceByName">
7114	<desc>
7115	Searches through all host network interfaces for an interface with
7116	the given @c name.
7117	<note>
7118	The method returns an error if the given @c name does not
7119	correspond to any host network interface.
7120	</note>
7121	</desc>
7122	<param name="name" type="wstring" dir="in">
7123	<desc>Name of the host network interface to search for.</desc>
7124	</param>
7125	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7126	<desc>Found host network interface object.</desc>
7127	</param>
7128	</method>
7129	<method name="findHostNetworkInterfaceById">
7130	<desc>
7131	Searches through all host network interfaces for an interface with
7132	the given GUID.
7133	<note>
7134	The method returns an error if the given GUID does not
7135	correspond to any host network interface.
7136	</note>
7137	</desc>
7138	<param name="id" type="uuid" mod="string" dir="in">
7139	<desc>GUID of the host network interface to search for.</desc>
7140	</param>
7141	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7142	<desc>Found host network interface object.</desc>
7143	</param>
7144	</method>
7145	<method name="findHostNetworkInterfacesOfType">
7146	<desc>
7147	Searches through all host network interfaces and returns a list of interfaces of the specified type
7148	</desc>
7149	<param name="type" type="HostNetworkInterfaceType" dir="in">
7150	<desc>type of the host network interfaces to search for.</desc>
7151	</param>
7152	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7153	<desc>Found host network interface objects.</desc>
7154	</param>
7155	</method>
7156
7157	<method name="findUSBDeviceById">
7158	<desc>
7159	Searches for a USB device with the given UUID.
7160
7161	<result name="VBOX_E_OBJECT_NOT_FOUND">
7162	Given @c id does not correspond to any USB device.
7163	</result>
7164
7165	<see>IHostUSBDevice::id</see>
7166	</desc>
7167	<param name="id" type="uuid" mod="string" dir="in">
7168	<desc>UUID of the USB device to search for.</desc>
7169	</param>
7170	<param name="device" type="IHostUSBDevice" dir="return">
7171	<desc>Found USB device object.</desc>
7172	</param>
7173	</method>
7174
7175	<method name="findUSBDeviceByAddress">
7176	<desc>
7177	Searches for a USB device with the given host address.
7178
7179	<result name="VBOX_E_OBJECT_NOT_FOUND">
7180	Given @c name does not correspond to any USB device.
7181	</result>
7182
7183	<see>IHostUSBDevice::address</see>
7184	</desc>
7185	<param name="name" type="wstring" dir="in">
7186	<desc>
7187	Address of the USB device (as assigned by the host) to
7188	search for.
7189	</desc>
7190	</param>
7191	<param name="device" type="IHostUSBDevice" dir="return">
7192	<desc>Found USB device object.</desc>
7193	</param>
7194	</method>
7195
7196	</interface>
7197
7198	<!--
7199	// ISystemProperties
7200	/////////////////////////////////////////////////////////////////////////
7201	-->
7202
7203	<interface
7204	name="ISystemProperties"
7205	extends="$unknown"
7206	uuid="5e54e767-293c-441b-a5e4-03a1fdbc0dcb"
7207	wsmap="managed"
7208	>
7209	<desc>
7210	The ISystemProperties interface represents global properties of the given
7211	VirtualBox installation.
7212
7213	These properties define limits and default values for various attributes
7214	and parameters. Most of the properties are read-only, but some can be
7215	changed by a user.
7216	</desc>
7217
7218	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7219	<desc>Minimum guest system memory in Megabytes.</desc>
7220	</attribute>
7221
7222	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7223	<desc>Maximum guest system memory in Megabytes.</desc>
7224	</attribute>
7225
7226	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7227	<desc>Minimum guest video memory in Megabytes.</desc>
7228	</attribute>
7229
7230	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7231	<desc>Maximum guest video memory in Megabytes.</desc>
7232	</attribute>
7233
7234	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7235	<desc>Minimum CPU count.</desc>
7236	</attribute>
7237
7238	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7239	<desc>Maximum CPU count.</desc>
7240	</attribute>
7241
7242	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7243	<desc>Maximum of monitors which could be connected.</desc>
7244	</attribute>
7245
7246	<attribute name="infoVDSize" type="long long" readonly="yes">
7247	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7248	does not reflect the limits of any virtual disk image format.</desc>
7249	</attribute>
7250
7251	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7252	<desc>
7253	Number of network adapters associated with every
7254	<link to="IMachine"/> instance.
7255	</desc>
7256	</attribute>
7257
7258	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7259	<desc>
7260	Number of serial ports associated with every
7261	<link to="IMachine"/> instance.
7262	</desc>
7263	</attribute>
7264
7265	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7266	<desc>
7267	Number of parallel ports associated with every
7268	<link to="IMachine"/> instance.
7269	</desc>
7270	</attribute>
7271
7272	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7273	<desc>
7274	Maximum device position in the boot order. This value corresponds
7275	to the total number of devices a machine can boot from, to make it
7276	possible to include all possible devices to the boot list.
7277	<see><link to="IMachine::setBootOrder"/></see>
7278	</desc>
7279	</attribute>
7280
7281	<attribute name="defaultMachineFolder" type="wstring">
7282	<desc>
7283	Full path to the default directory used to create new or open
7284	existing machines when a settings file name contains no
7285	path.
7286
7287	The initial value of this property is
7288	<tt><</tt><link to="IVirtualBox::homeFolder">
7289	VirtualBox_home</link><tt>>/Machines</tt>.
7290
7291	<note>
7292	Setting this property to @c null or an empty string will restore the
7293	initial value.
7294	</note>
7295	<note>
7296	When settings this property, the specified path can be
7297	absolute (full path) or relative
7298	to the <link to="IVirtualBox::homeFolder">
7299	VirtualBox home directory</link>.
7300	When reading this property, a full path is
7301	always returned.
7302	</note>
7303	<note>
7304	The specified path may not exist, it will be created
7305	when necessary.
7306	</note>
7307
7308	<see>
7309	<link to="IVirtualBox::createMachine"/>,
7310	<link to="IVirtualBox::openMachine"/>
7311	</see>
7312	</desc>
7313	</attribute>
7314
7315	<attribute name="defaultHardDiskFolder" type="wstring">
7316	<desc>
7317	Full path to the default directory used to create new or open existing
7318	virtual disks.
7319
7320	This path is used when the storage unit of a hard disk is a regular file
7321	in the host's file system and only a file name that contains no path is
7322	given.
7323
7324	The initial value of this property is
7325	<tt><</tt>
7326	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7327	<tt>>/HardDisks</tt>.
7328
7329	<note>
7330	Setting this property to @c null or empty string will restore the
7331	initial value.
7332	</note>
7333	<note>
7334	When settings this property, the specified path can be relative
7335	to the
7336	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7337	absolute. When reading this property, a full path is
7338	always returned.
7339	</note>
7340	<note>
7341	The specified path may not exist, it will be created
7342	when necessary.
7343	</note>
7344
7345	<see>
7346	IMedium,
7347	<link to="IVirtualBox::createHardDisk"/>,
7348	<link to="IVirtualBox::openMedium"/>,
7349	<link to="IMedium::location"/>
7350	</see>
7351	</desc>
7352	</attribute>
7353
7354	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7355	<desc>
7356	List of all medium storage formats supported by this VirtualBox
7357	installation.
7358
7359	Keep in mind that the medium format identifier
7360	(<link to="IMediumFormat::id"/>) used in other API calls like
7361	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7362	medium format is a case-insensitive string. This means that, for
7363	example, all of the following strings:
7364	<pre>
7365	"VDI"
7366	"vdi"
7367	"VdI"</pre>
7368	refer to the same medium format.
7369
7370	Note that the virtual medium framework is backend-based, therefore
7371	the list of supported formats depends on what backends are currently
7372	installed.
7373
7374	<see>
7375	<link to="IMediumFormat"/>,
7376	</see>
7377	</desc>
7378	</attribute>
7379
7380	<attribute name="defaultHardDiskFormat" type="wstring">
7381	<desc>
7382	Identifier of the default medium format used by VirtualBox.
7383
7384	The medium format set by this attribute is used by VirtualBox
7385	when the medium format was not specified explicitly. One example is
7386	<link to="IVirtualBox::createHardDisk"/> with the empty
7387	format argument. A more complex example is implicit creation of
7388	differencing media when taking a snapshot of a virtual machine:
7389	this operation will try to use a format of the parent medium first
7390	and if this format does not support differencing media the default
7391	format specified by this argument will be used.
7392
7393	The list of supported medium formats may be obtained by the
7394	<link to="#mediumFormats"/> call. Note that the default medium
7395	format must have a capability to create differencing media;
7396	otherwise operations that create media implicitly may fail
7397	unexpectedly.
7398
7399	The initial value of this property is <tt>"VDI"</tt> in the current
7400	version of the VirtualBox product, but may change in the future.
7401
7402	<note>
7403	Setting this property to @c null or empty string will restore the
7404	initial value.
7405	</note>
7406
7407	<see>
7408	<link to="#mediumFormats"/>,
7409	<link to="IMediumFormat::id"/>,
7410	<link to="IVirtualBox::createHardDisk"/>
7411	</see>
7412	</desc>
7413	</attribute>
7414
7415	<attribute name="freeDiskSpaceWarning" type="long long">
7416	<desc>Issue a warning if the free disk space is below (or in some disk
7417	intensive operation is expected to go below) the given size in
7418	bytes.</desc>
7419	</attribute>
7420
7421	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7422	<desc>Issue a warning if the free disk space is below (or in some disk
7423	intensive operation is expected to go below) the given percentage.</desc>
7424	</attribute>
7425
7426	<attribute name="freeDiskSpaceError" type="long long">
7427	<desc>Issue an error if the free disk space is below (or in some disk
7428	intensive operation is expected to go below) the given size in
7429	bytes.</desc>
7430	</attribute>
7431
7432	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7433	<desc>Issue an error if the free disk space is below (or in some disk
7434	intensive operation is expected to go below) the given percentage.</desc>
7435	</attribute>
7436
7437	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7438	<desc>
7439	Library that provides authentication for VRDP clients. The library
7440	is used if a virtual machine's authentication type is set to "external"
7441	in the VM RemoteDisplay configuration.
7442
7443	The system library extension (".DLL" or ".so") must be omitted.
7444	A full path can be specified; if not, then the library must reside on the
7445	system's default library path.
7446
7447	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7448	of that name in one of the default VirtualBox library directories.
7449
7450	For details about VirtualBox authentication libraries and how to implement
7451	them, please refer to the VirtualBox manual.
7452
7453	<note>
7454	Setting this property to @c null or empty string will restore the
7455	initial value.
7456	</note>
7457	</desc>
7458	</attribute>
7459
7460	<attribute name="webServiceAuthLibrary" type="wstring">
7461	<desc>
7462	Library that provides authentication for webservice clients. The library
7463	is used if a virtual machine's authentication type is set to "external"
7464	in the VM RemoteDisplay configuration and will be called from
7465	within the <link to="IWebsessionManager::logon" /> implementation.
7466
7467	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7468	there is no per-VM setting for this, as the webservice is a global
7469	resource (if it is running). Only for this setting (for the webservice),
7470	setting this value to a literal <tt>"null"</tt> string disables authentication,
7471	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7472	no matter what user name and password are supplied.
7473
7474	The initial value of this property is <tt>"VRDPAuth"</tt>,
7475	meaning that the webservice will use the same authentication
7476	library that is used by default for VBoxVRDP (again, see
7477	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7478	The format and calling convention of authentication libraries
7479	is the same for the webservice as it is for VBoxVRDP.
7480
7481	<note>
7482	Setting this property to @c null or empty string will restore the
7483	initial value.
7484	</note>
7485	</desc>
7486	</attribute>
7487
7488	<attribute name="LogHistoryCount" type="unsigned long">
7489	<desc>
7490	This value specifies how many old release log files are kept.
7491	</desc>
7492	</attribute>
7493
7494	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7495	<desc>This value hold the default audio driver for the current
7496	system.</desc>
7497	</attribute>
7498
7499	<method name="getMaxDevicesPerPortForStorageBus">
7500	<desc>Returns the maximum number of devices which can be attached to a port
7501	for the given storage bus.</desc>
7502
7503	<param name="bus" type="StorageBus" dir="in">
7504	<desc>The storage bus type to get the value for.</desc>
7505	</param>
7506
7507	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7508	<desc>The maximum number of devices which can eb attached to the port for the given
7509	storage bus.</desc>
7510	</param>
7511	</method>
7512
7513	<method name="getMinPortCountForStorageBus">
7514	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7515
7516	<param name="bus" type="StorageBus" dir="in">
7517	<desc>The storage bus type to get the value for.</desc>
7518	</param>
7519
7520	<param name="minPortCount" type="unsigned long" dir="return">
7521	<desc>The minimum number of ports for the given storage bus.</desc>
7522	</param>
7523	</method>
7524
7525	<method name="getMaxPortCountForStorageBus">
7526	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7527
7528	<param name="bus" type="StorageBus" dir="in">
7529	<desc>The storage bus type to get the value for.</desc>
7530	</param>
7531
7532	<param name="maxPortCount" type="unsigned long" dir="return">
7533	<desc>The maximum number of ports for the given storage bus.</desc>
7534	</param>
7535	</method>
7536
7537	<method name="getMaxInstancesOfStorageBus">
7538	<desc>Returns the maximum number of storage bus instances which
7539	can be configured for each VM. This corresponds to the number of
7540	storage controllers one can have.</desc>
7541
7542	<param name="bus" type="StorageBus" dir="in">
7543	<desc>The storage bus type to get the value for.</desc>
7544	</param>
7545
7546	<param name="maxInstances" type="unsigned long" dir="return">
7547	<desc>The maximum number of instances for the given storage bus.</desc>
7548	</param>
7549	</method>
7550
7551	<method name="getDeviceTypesForStorageBus">
7552	<desc>Returns list of all the supported device types
7553	(<link to="DeviceType"/>) for the given type of storage
7554	bus.</desc>
7555
7556	<param name="bus" type="StorageBus" dir="in">
7557	<desc>The storage bus type to get the value for.</desc>
7558	</param>
7559
7560	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7561	<desc>The list of all supported device types for the given storage bus.</desc>
7562	</param>
7563	</method>
7564
7565	<method name="getDefaultIoCacheSettingForStorageController">
7566	<desc>Returns the default I/O cache setting for the
7567	given storage controller</desc>
7568
7569	<param name="controllerType" type="StorageControllerType" dir="in">
7570	<desc>The storage controller to the setting for.</desc>
7571	</param>
7572
7573	<param name="enabled" type="boolean" dir="return">
7574	<desc>Returned flag indicating the default value</desc>
7575	</param>
7576	</method>
7577	</interface>
7578
7579	<!--
7580	// IGuest
7581	/////////////////////////////////////////////////////////////////////////
7582	-->
7583
7584	<interface
7585	name="IGuestOSType" extends="$unknown"
7586	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7587	wsmap="struct"
7588	>
7589	<desc>
7590	</desc>
7591
7592	<attribute name="familyId" type="wstring" readonly="yes">
7593	<desc>Guest OS family identifier string.</desc>
7594	</attribute>
7595
7596	<attribute name="familyDescription" type="wstring" readonly="yes">
7597	<desc>Human readable description of the guest OS family.</desc>
7598	</attribute>
7599
7600	<attribute name="id" type="wstring" readonly="yes">
7601	<desc>Guest OS identifier string.</desc>
7602	</attribute>
7603
7604	<attribute name="description" type="wstring" readonly="yes">
7605	<desc>Human readable description of the guest OS.</desc>
7606	</attribute>
7607
7608	<attribute name="is64Bit" type="boolean" readonly="yes">
7609	<desc>Returns @c true if the given OS is 64-bit</desc>
7610	</attribute>
7611
7612	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7613	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7614	</attribute>
7615
7616	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7617	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7618	</attribute>
7619
7620	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7621	<desc>Recommended RAM size in Megabytes.</desc>
7622	</attribute>
7623
7624	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7625	<desc>Recommended video RAM size in Megabytes.</desc>
7626	</attribute>
7627
7628	<attribute name="recommendedHDD" type="long long" readonly="yes">
7629	<desc>Recommended hard disk size in bytes.</desc>
7630	</attribute>
7631
7632	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7633	<desc>Returns recommended network adapter for this OS type.</desc>
7634	</attribute>
7635
7636	<attribute name="recommendedPae" type="boolean" readonly="yes">
7637	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7638	</attribute>
7639
7640	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7641	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7642	</attribute>
7643
7644	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7645	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7646	</attribute>
7647
7648	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7649	<desc>Recommended storage controller type for HD drives.</desc>
7650	</attribute>
7651
7652	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7653	<desc>Recommended storage bus type for HD drives.</desc>
7654	</attribute>
7655
7656	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7657	<desc>Recommended firmware type.</desc>
7658	</attribute>
7659
7660	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7661	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7662	</attribute>
7663
7664	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7665	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7666	</attribute>
7667
7668	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7669	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7670	</attribute>
7671
7672	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7673	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7674	</attribute>
7675
7676	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7677	<desc>Recommended chipset type.</desc>
7678	</attribute>
7679
7680	</interface>
7681
7682	<enum
7683	name="AdditionsRunLevelType"
7684	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7685	>
7686	<desc>
7687	Guest Additions run level type.
7688	</desc>
7689
7690	<const name="None" value="0">
7691	<desc>Guest Additions are not loaded.</desc>
7692	</const>
7693	<const name="System" value="1">
7694	<desc>Guest drivers are loaded.</desc>
7695	</const>
7696	<const name="Userland" value="2">
7697	<desc>Common components (such as application services) are loaded.</desc>
7698	</const>
7699	<const name="Desktop" value="3">
7700	<desc>Per-user desktop components are loaded.</desc>
7701	</const>
7702	</enum>
7703
7704	<enum
7705	name="ExecuteProcessFlag"
7706	uuid="9a24c17d-bd46-4207-b247-517fdd6d6b8f"
7707	>
7708	<desc>
7709	Guest process execution flags.
7710	</desc>
7711
7712	<const name="None" value="0">
7713	<desc>No flag set.</desc>
7714	</const>
7715
7716	<const name="IgnoreOrphanedProcesses" value="2">
7717	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7718	</const>
7719	</enum>
7720
7721	<enum
7722	name="CopyFileFlag"
7723	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7724	>
7725	<desc>
7726	Host/Guest copy flags.
7727	</desc>
7728
7729	<const name="None" value="0">
7730	<desc>No flag set.</desc>
7731	</const>
7732
7733	<const name="Recursive" value="2">
7734	<desc>Copy directories recursively.</desc>
7735	</const>
7736
7737	<const name="Update" value="4">
7738	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7739	</const>
7740
7741	<const name="FollowLinks" value="8">
7742	<desc>Follow symbolic links.</desc>
7743	</const>
7744	</enum>
7745
7746	<interface
7747	name="IGuest" extends="$unknown"
7748	uuid="6e3113ac-ed90-4864-8c2c-942c8022324d"
7749	wsmap="managed"
7750	>
7751	<desc>
7752	The IGuest interface represents information about the operating system
7753	running inside the virtual machine. Used in
7754	<link to="IConsole::guest"/>.
7755
7756	IGuest provides information about the guest operating system, whether
7757	Guest Additions are installed and other OS-specific virtual machine
7758	properties.
7759	</desc>
7760
7761	<attribute name="OSTypeId" type="wstring" readonly="yes">
7762	<desc>
7763	Identifier of the Guest OS type as reported by the Guest
7764	Additions.
7765	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7766	an IGuestOSType object representing details about the given
7767	Guest OS type.
7768	<note>
7769	If Guest Additions are not installed, this value will be
7770	the same as <link to="IMachine::OSTypeId"/>.
7771	</note>
7772	</desc>
7773	</attribute>
7774
7775	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7776	<desc>
7777	Current run level of the Guest Additions.
7778	</desc>
7779	</attribute>
7780
7781	<attribute name="additionsVersion" type="wstring" readonly="yes">
7782	<desc>
7783	Version of the Guest Additions including the revision (3 decimal numbers
7784	separated by dots + revision number) installed on the guest or empty
7785	when the Additions are not installed.
7786	</desc>
7787	</attribute>
7788
7789	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7790	<desc>
7791	Flag whether seamless guest display rendering (seamless desktop
7792	integration) is supported.
7793	</desc>
7794	</attribute>
7795
7796	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7797	<desc>
7798	Flag whether the guest is in graphics mode. If it is not, then
7799	seamless rendering will not work, resize hints are not immediately
7800	acted on and guest display resizes are probably not initiated by
7801	the guest additions.
7802	</desc>
7803	</attribute>
7804
7805	<attribute name="memoryBalloonSize" type="unsigned long">
7806	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7807	</attribute>
7808
7809	<attribute name="statisticsUpdateInterval" type="unsigned long">
7810	<desc>Interval to update guest statistics in seconds.</desc>
7811	</attribute>
7812
7813	<method name="internalGetStatistics">
7814	<desc>
7815	Internal method; do not use as it might change at any time
7816	</desc>
7817	<param name="cpuUser" type="unsigned long" dir="out">
7818	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7819	</param>
7820	<param name="cpuKernel" type="unsigned long" dir="out">
7821	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7822	</param>
7823	<param name="cpuIdle" type="unsigned long" dir="out">
7824	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7825	</param>
7826	<param name="memTotal" type="unsigned long" dir="out">
7827	<desc>Total amount of physical guest RAM</desc>
7828	</param>
7829	<param name="memFree" type="unsigned long" dir="out">
7830	<desc>Free amount of physical guest RAM</desc>
7831	</param>
7832	<param name="memBalloon" type="unsigned long" dir="out">
7833	<desc>Amount of ballooned physical guest RAM</desc>
7834	</param>
7835	<param name="memShared" type="unsigned long" dir="out">
7836	<desc>Amount of shared physical guest RAM</desc>
7837	</param>
7838	<param name="memCache" type="unsigned long" dir="out">
7839	<desc>Total amount of guest (disk) cache memory</desc>
7840	</param>
7841	<param name="pagedTotal" type="unsigned long" dir="out">
7842	<desc>Total amount of space in the page file</desc>
7843	</param>
7844	<param name="memAllocTotal" type="unsigned long" dir="out">
7845	<desc>Total amount of memory allocated by the hypervisor</desc>
7846	</param>
7847	<param name="memFreeTotal" type="unsigned long" dir="out">
7848	<desc>Total amount of free memory available in the hypervisor</desc>
7849	</param>
7850	<param name="memBalloonTotal" type="unsigned long" dir="out">
7851	<desc>Total amount of memory ballooned by the hypervisor</desc>
7852	</param>
7853	<param name="memSharedTotal" type="unsigned long" dir="out">
7854	<desc>Total amount of shared memory in the hypervisor</desc>
7855	</param>
7856	</method>
7857
7858	<method name="getAdditionsStatus">
7859	<desc>
7860	Retrieve the current status of a certain Guest Additions run level.
7861
7862	<result name="VBOX_E_NOT_SUPPORTED">
7863	Wrong status level specified.
7864	</result>
7865
7866	</desc>
7867	<param name="level" type="AdditionsRunLevelType" dir="in">
7868	<desc>Status level to check</desc>
7869	</param>
7870	<param name="active" type="boolean" dir="return">
7871	<desc>Flag whether the status level has been reached or not</desc>
7872	</param>
7873	</method>
7874
7875	<method name="setCredentials">
7876	<desc>
7877	Store login credentials that can be queried by guest operating
7878	systems with Additions installed. The credentials are transient
7879	to the session and the guest may also choose to erase them. Note
7880	that the caller cannot determine whether the guest operating system
7881	has queried or made use of the credentials.
7882
7883	<result name="VBOX_E_VM_ERROR">
7884	VMM device is not available.
7885	</result>
7886
7887	</desc>
7888	<param name="userName" type="wstring" dir="in">
7889	<desc>User name string, can be empty</desc>
7890	</param>
7891	<param name="password" type="wstring" dir="in">
7892	<desc>Password string, can be empty</desc>
7893	</param>
7894	<param name="domain" type="wstring" dir="in">
7895	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7896	</param>
7897	<param name="allowInteractiveLogon" type="boolean" dir="in">
7898	<desc>
7899	Flag whether the guest should alternatively allow the user to
7900	interactively specify different credentials. This flag might
7901	not be supported by all versions of the Additions.
7902	</desc>
7903	</param>
7904	</method>
7905
7906	<method name="executeProcess">
7907	<desc>
7908	Executes an existing program inside the guest VM.
7909
7910	<result name="VBOX_E_IPRT_ERROR">
7911	Could not execute process.
7912	</result>
7913
7914	</desc>
7915	<param name="execName" type="wstring" dir="in">
7916	<desc>
7917	Full path name of the command to execute on the guest; the
7918	commands has to exists in the guest VM in order to be executed.
7919	</desc>
7920	</param>
7921	<param name="flags" type="unsigned long" dir="in">
7922	<desc>
7923	Execution flags - currently not supported and therefore
7924	has to be set to 0.
7925	</desc>
7926	</param>
7927	<param name="arguments" type="wstring" safearray="yes" dir="in">
7928	<desc>
7929	Array of arguments passed to the execution command.
7930	</desc>
7931	</param>
7932	<param name="environment" type="wstring" safearray="yes" dir="in">
7933	<desc>
7934	Environment variables that can be set while the command is being
7935	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7936	variable just set its name ("NAME") without a value.
7937	</desc>
7938	</param>
7939	<param name="userName" type="wstring" dir="in">
7940	<desc>
7941	User name under which the command will be executed; has to exist
7942	and have the appropriate rights to execute programs in the VM.
7943	</desc>
7944	</param>
7945	<param name="password" type="wstring" dir="in">
7946	<desc>
7947	Password of the user account specified.
7948	</desc>
7949	</param>
7950	<param name="timeoutMS" type="unsigned long" dir="in">
7951	<desc>
7952	The maximum timeout value (in msec) to wait for finished program
7953	execution. Pass 0 for an infinite timeout.
7954	</desc>
7955	</param>
7956	<param name="pid" type="unsigned long" dir="out">
7957	<desc>
7958	The PID (process ID) of the started command for later reference.
7959	</desc>
7960	</param>
7961	<param name="progress" type="IProgress" dir="return">
7962	<desc>Progress object to track the operation completion.</desc>
7963	</param>
7964	</method>
7965
7966	<method name="getProcessOutput">
7967	<desc>
7968	Retrieves output of a formerly started process.
7969
7970	<result name="VBOX_E_IPRT_ERROR">
7971	Could not retrieve output.
7972	</result>
7973
7974	</desc>
7975	<param name="pid" type="unsigned long" dir="in">
7976	<desc>
7977	Process id returned by earlier executeProcess() call.
7978	</desc>
7979	</param>
7980	<param name="flags" type="unsigned long" dir="in">
7981	<desc>
7982	Flags describing which output to retrieve.
7983	</desc>
7984	</param>
7985	<param name="timeoutMS" type="unsigned long" dir="in">
7986	<desc>
7987	The maximum timeout value (in msec) to wait for output
7988	data. Pass 0 for an infinite timeout.
7989	</desc>
7990	</param>
7991	<param name="size" type="long long" dir="in">
7992	<desc>
7993	Size in bytes to read in the buffer.
7994	</desc>
7995	</param>
7996	<param name="data" type="octet" dir="return" safearray="yes">
7997	<desc>
7998	Buffer for retrieving the actual output. A data size of 0 means end of file
7999	if the requested size was not 0. This is the unprocessed
8000	output data, i.e. the line ending style depends on the platform of
8001	the system the server is running on.
8002	</desc>
8003	</param>
8004	</method>
8005
8006	<method name="getProcessStatus">
8007	<desc>
8008	Retrieves status, exit code and the exit reason of a formerly started process.
8009
8010	<result name="VBOX_E_IPRT_ERROR">
8011	Process with specified PID was not found.
8012	</result>
8013
8014	</desc>
8015	<param name="pid" type="unsigned long" dir="in">
8016	<desc>
8017	Process id returned by earlier executeProcess() call.
8018	</desc>
8019	</param>
8020	<param name="exitcode" type="unsigned long" dir="out">
8021	<desc>
8022	The exit code (if available).
8023	</desc>
8024	</param>
8025	<param name="flags" type="unsigned long" dir="out">
8026	<desc>
8027	Additional flags of process status (not used at the moment).
8028	</desc>
8029	</param>
8030	<param name="reason" type="unsigned long" dir="return">
8031	<desc>
8032	The current process status.
8033	</desc>
8034	</param>
8035	</method>
8036
8037	<method name="copyToGuest">
8038	<desc>
8039	Copies files/directories from host to the guest.
8040
8041	<result name="VBOX_E_IPRT_ERROR">
8042	Error while copying.
8043	</result>
8044
8045	</desc>
8046	<param name="source" type="wstring" dir="in">
8047	<desc>
8048	Foo.
8049	</desc>
8050	</param>
8051	<param name="dest" type="wstring" dir="in">
8052	<desc>
8053	Bar.
8054	</desc>
8055	</param>
8056	<param name="flags" type="unsigned long" dir="in">
8057	<desc>
8058	Copy flags.
8059	</desc>
8060	</param>
8061	<param name="progress" type="IProgress" dir="return">
8062	<desc>Progress object to track the operation completion.</desc>
8063	</param>
8064	</method>
8065
8066	</interface>
8067
8068
8069	<!--
8070	// IProgress
8071	/////////////////////////////////////////////////////////////////////////
8072	-->
8073
8074	<interface
8075	name="IProgress" extends="$unknown"
8076	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8077	wsmap="managed"
8078	>
8079	<desc>
8080	The IProgress interface is used to track and control
8081	asynchronous tasks within VirtualBox.
8082
8083	An instance of this is returned every time VirtualBox starts
8084	an asynchronous task (in other words, a separate thread) which
8085	continues to run after a method call returns. For example,
8086	<link to="IConsole::saveState" />, which saves the state of
8087	a running virtual machine, can take a long time to complete.
8088	To be able to display a progress bar, a user interface such as
8089	the VirtualBox graphical user interface can use the IProgress
8090	object returned by that method.
8091
8092	Note that IProgress is a "read-only" interface in the sense
8093	that only the VirtualBox internals behind the Main API can
8094	create and manipulate progress objects, whereas client code
8095	can only use the IProgress object to monitor a task's
8096	progress and, if <link to="#cancelable" /> is @c true,
8097	cancel the task by calling <link to="#cancel" />.
8098
8099	A task represented by IProgress consists of either one or
8100	several sub-operations that run sequentially, one by one (see
8101	<link to="#operation" /> and <link to="#operationCount" />).
8102	Every operation is identified by a number (starting from 0)
8103	and has a separate description.
8104
8105	You can find the individual percentage of completion of the current
8106	operation in <link to="#operationPercent" /> and the
8107	percentage of completion of the task as a whole
8108	in <link to="#percent" />.
8109
8110	Similarly, you can wait for the completion of a particular
8111	operation via <link to="#waitForOperationCompletion" /> or
8112	for the completion of the whole task via
8113	<link to="#waitForCompletion" />.
8114	</desc>
8115
8116	<attribute name="id" type="uuid" mod="string" readonly="yes">
8117	<desc>ID of the task.</desc>
8118	</attribute>
8119
8120	<attribute name="description" type="wstring" readonly="yes">
8121	<desc>Description of the task.</desc>
8122	</attribute>
8123
8124	<attribute name="initiator" type="$unknown" readonly="yes">
8125	<desc>Initiator of the task.</desc>
8126	</attribute>
8127
8128	<attribute name="cancelable" type="boolean" readonly="yes">
8129	<desc>Whether the task can be interrupted.</desc>
8130	</attribute>
8131
8132	<attribute name="percent" type="unsigned long" readonly="yes">
8133	<desc>
8134	Current progress value of the task as a whole, in percent.
8135	This value depends on how many operations are already complete.
8136	Returns 100 if <link to="#completed" /> is @c true.
8137	</desc>
8138	</attribute>
8139
8140	<attribute name="timeRemaining" type="long" readonly="yes">
8141	<desc>
8142	Estimated remaining time until the task completes, in
8143	seconds. Returns 0 once the task has completed; returns -1
8144	if the remaining time cannot be computed, in particular if
8145	the current progress is 0.
8146
8147	Even if a value is returned, the estimate will be unreliable
8148	for low progress values. It will become more reliable as the
8149	task progresses; it is not recommended to display an ETA
8150	before at least 20% of a task have completed.
8151	</desc>
8152	</attribute>
8153
8154	<attribute name="completed" type="boolean" readonly="yes">
8155	<desc>Whether the task has been completed.</desc>
8156	</attribute>
8157
8158	<attribute name="canceled" type="boolean" readonly="yes">
8159	<desc>Whether the task has been canceled.</desc>
8160	</attribute>
8161
8162	<attribute name="resultCode" type="long" readonly="yes">
8163	<desc>
8164	Result code of the progress task.
8165	Valid only if <link to="#completed"/> is @c true.
8166	</desc>
8167	</attribute>
8168
8169	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8170	<desc>
8171	Extended information about the unsuccessful result of the
8172	progress operation. May be @c null if no extended information
8173	is available.
8174	Valid only if <link to="#completed"/> is @c true and
8175	<link to="#resultCode"/> indicates a failure.
8176	</desc>
8177	</attribute>
8178
8179	<attribute name="operationCount" type="unsigned long" readonly="yes">
8180	<desc>
8181	Number of sub-operations this task is divided into.
8182	Every task consists of at least one suboperation.
8183	</desc>
8184	</attribute>
8185
8186	<attribute name="operation" type="unsigned long" readonly="yes">
8187	<desc>Number of the sub-operation being currently executed.</desc>
8188	</attribute>
8189
8190	<attribute name="operationDescription" type="wstring" readonly="yes">
8191	<desc>
8192	Description of the sub-operation being currently executed.
8193	</desc>
8194	</attribute>
8195
8196	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8197	<desc>Progress value of the current sub-operation only, in percent.</desc>
8198	</attribute>
8199
8200	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8201	<desc>Weight value of the current sub-operation only.</desc>
8202	</attribute>
8203
8204	<attribute name="timeout" type="unsigned long">
8205	<desc>
8206	When non-zero, this specifies the number of milliseconds after which
8207	the operation will automatically be canceled. This can only be set on
8208	cancelable objects.
8209	</desc>
8210	</attribute>
8211
8212	<method name="setCurrentOperationProgress">
8213	<desc>Internal method, not to be called externally.</desc>
8214	<param name="percent" type="unsigned long" dir="in" />
8215	</method>
8216	<method name="setNextOperation">
8217	<desc>Internal method, not to be called externally.</desc>
8218	<param name="nextOperationDescription" type="wstring" dir="in" />
8219	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8220	</method>
8221
8222	<method name="waitForCompletion">
8223	<desc>
8224	Waits until the task is done (including all sub-operations)
8225	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8226
8227	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8228	thread are not processed while waiting. Neglecting event queues may
8229	have dire consequences (degrade performance, resource hogs,
8230	deadlocks, etc.), this is specially so for the main thread on
8231	platforms using XPCOM. Callers are adviced wait for short periods
8232	and service their event queues between calls, or to create a worker
8233	thread to do the waiting.
8234
8235	<result name="VBOX_E_IPRT_ERROR">
8236	Failed to wait for task completion.
8237	</result>
8238	</desc>
8239
8240	<param name="timeout" type="long" dir="in">
8241	<desc>
8242	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8243	</desc>
8244	</param>
8245	</method>
8246
8247	<method name="waitForOperationCompletion">
8248	<desc>
8249	Waits until the given operation is done with a given timeout in
8250	milliseconds; specify -1 for an indefinite wait.
8251
8252	See <link to="#waitForCompletion"> for event queue considerations.</link>
8253
8254	<result name="VBOX_E_IPRT_ERROR">
8255	Failed to wait for operation completion.
8256	</result>
8257
8258	</desc>
8259	<param name="operation" type="unsigned long" dir="in">
8260	<desc>
8261	Number of the operation to wait for.
8262	Must be less than <link to="#operationCount"/>.
8263	</desc>
8264	</param>
8265	<param name="timeout" type="long" dir="in">
8266	<desc>
8267	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8268	</desc>
8269	</param>
8270	</method>
8271
8272	<method name="cancel">
8273	<desc>
8274	Cancels the task.
8275	<note>
8276	If <link to="#cancelable"/> is @c false, then this method will fail.
8277	</note>
8278
8279	<result name="VBOX_E_INVALID_OBJECT_STATE">
8280	Operation cannot be canceled.
8281	</result>
8282
8283	</desc>
8284	</method>
8285
8286	</interface>
8287
8288	<!--
8289	// ISnapshot
8290	/////////////////////////////////////////////////////////////////////////
8291	-->
8292
8293	<interface
8294	name="ISnapshot" extends="$unknown"
8295	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8296	wsmap="managed"
8297	>
8298	<desc>
8299	The ISnapshot interface represents a snapshot of the virtual
8300	machine.
8301
8302	Together with the differencing media that are created
8303	when a snapshot is taken, a machine can be brought back to
8304	the exact state it was in when the snapshot was taken.
8305
8306	The ISnapshot interface has no methods, only attributes; snapshots
8307	are controlled through methods of the <link to="IConsole" /> interface
8308	which also manage the media associated with the snapshot.
8309	The following operations exist:
8310
8311	<ul>
8312	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8313	by creating new, empty differencing images for the machine's
8314	media and saving the VM settings and (if the VM is running)
8315	the current VM state in the snapshot.
8316
8317	The differencing images will then receive all data written to
8318	the machine's media, while their parent (base) images
8319	remain unmodified after the snapshot has been taken (see
8320	<link to="IMedium" /> for details about differencing images).
8321	This simplifies restoring a machine to the state of a snapshot:
8322	only the differencing images need to be deleted.
8323
8324	The current machine state is not changed by taking a snapshot.
8325	If the machine is running, it will resume execution after the
8326	snapshot has been taken. After calling this,
8327	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8328	just created.
8329	</li>
8330
8331	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8332	the state of a previous snapshot by deleting the differencing
8333	image of each of the machine's media and setting the machine's
8334	settings and state to the state that was saved in the snapshot (if any).
8335
8336	This destroys the machine's current state. After calling this,
8337	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8338	restored.
8339	</li>
8340
8341	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8342	without affecting the current machine state.
8343
8344	This does not change the current machine state, but instead frees the
8345	resources allocated when the snapshot was taken: the settings and machine
8346	state file are deleted (if any), and the snapshot's differencing image for
8347	each of the machine's media gets merged with its parent image.
8348
8349	Neither the current machine state nor other snapshots are affected
8350	by this operation, except that parent media will be modified
8351	to contain the disk data associated with the snapshot being deleted.
8352
8353	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8354	attribute is set to the current snapshot's parent or NULL if it
8355	has no parent. Otherwise the attribute is unchanged.
8356	</li>
8357	</ul>
8358
8359	Each snapshot contains the settings of the virtual machine (hardware
8360	configuration etc.). In addition, if the machine was running when the
8361	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8362	the current VM state is saved in the snapshot (similarly to what happens
8363	when a VM's state is saved). The snapshot is then said to
8364	be <i>online</i> because when restoring it, the VM will be running.
8365
8366	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8367	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8368
8369	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8370	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8371	it then contains a so-called "zero execution state", representing a
8372	machine that is powered off.
8373	</desc>
8374
8375	<attribute name="id" type="uuid" mod="string" readonly="yes">
8376	<desc>UUID of the snapshot.</desc>
8377	</attribute>
8378
8379	<attribute name="name" type="wstring">
8380	<desc>Short name of the snapshot.</desc>
8381	</attribute>
8382
8383	<attribute name="description" type="wstring">
8384	<desc>Optional description of the snapshot.</desc>
8385	</attribute>
8386
8387	<attribute name="timeStamp" type="long long" readonly="yes">
8388	<desc>
8389	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8390	</desc>
8391	</attribute>
8392
8393	<attribute name="online" type="boolean" readonly="yes">
8394	<desc>
8395	@c true if this snapshot is an online snapshot and @c false otherwise.
8396
8397	When this attribute is @c true, the
8398	<link to="IMachine::stateFilePath"/> attribute of the
8399	<link to="#machine"/> object associated with this snapshot
8400	will point to the saved state file. Otherwise, it will be
8401	an empty string.
8402	</desc>
8403	</attribute>
8404
8405	<attribute name="machine" type="IMachine" readonly="yes">
8406	<desc>
8407	Virtual machine this snapshot is taken on. This object
8408	stores all settings the machine had when taking this snapshot.
8409	<note>
8410	The returned machine object is immutable, i.e. no
8411	any settings can be changed.
8412	</note>
8413	</desc>
8414	</attribute>
8415
8416	<attribute name="parent" type="ISnapshot" readonly="yes">
8417	<desc>
8418	Parent snapshot (a snapshot this one is based on), or
8419	@c null if the snapshot has no parent (i.e. is the first snapshot).
8420	</desc>
8421	</attribute>
8422
8423	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8424	<desc>
8425	Child snapshots (all snapshots having this one as a parent).
8426	</desc>
8427	</attribute>
8428
8429	</interface>
8430
8431
8432	<!--
8433	// IMedium
8434	/////////////////////////////////////////////////////////////////////////
8435	-->
8436
8437	<enum
8438	name="MediumState"
8439	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8440	>
8441	<desc>
8442	Virtual medium state.
8443	<see>IMedium</see>
8444	</desc>
8445
8446	<const name="NotCreated" value="0">
8447	<desc>
8448	Associated medium storage does not exist (either was not created yet or
8449	was deleted).
8450	</desc>
8451	</const>
8452	<const name="Created" value="1">
8453	<desc>
8454	Associated storage exists and accessible; this gets set if the
8455	accessibility check performed by <link to="IMedium::refreshState" />
8456	was successful.
8457	</desc>
8458	</const>
8459	<const name="LockedRead" value="2">
8460	<desc>
8461	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8462	no data modification is possible.
8463	</desc>
8464	</const>
8465	<const name="LockedWrite" value="3">
8466	<desc>
8467	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8468	no concurrent data reading or modification is possible.
8469	</desc>
8470	</const>
8471	<const name="Inaccessible" value="4">
8472	<desc>
8473	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8474	not yet been performed, or else, associated medium storage is not
8475	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8476	is empty, in the second case, it describes the error that occured.
8477	</desc>
8478	</const>
8479	<const name="Creating" value="5">
8480	<desc>
8481	Associated medium storage is being created.
8482	</desc>
8483	</const>
8484	<const name="Deleting" value="6">
8485	<desc>
8486	Associated medium storage is being deleted.
8487	</desc>
8488	</const>
8489	</enum>
8490
8491	<enum
8492	name="MediumType"
8493	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
8494	>
8495	<desc>
8496	Virtual medium type.
8497	<see>IMedium</see>
8498	</desc>
8499
8500	<const name="Normal" value="0">
8501	<desc>
8502	Normal medium (attached directly or indirectly, preserved
8503	when taking snapshots).
8504	</desc>
8505	</const>
8506	<const name="Immutable" value="1">
8507	<desc>
8508	Immutable medium (attached indirectly, changes are wiped out
8509	the next time the virtual machine is started).
8510	</desc>
8511	</const>
8512	<const name="Writethrough" value="2">
8513	<desc>
8514	Write through medium (attached directly, ignored when
8515	taking snapshots).
8516	</desc>
8517	</const>
8518	<const name="Shareable" value="3">
8519	<desc>
8520	Allow using this medium concurrently by several machines.
8521	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8522	</desc>
8523	</const>
8524	</enum>
8525
8526	<enum
8527	name="MediumVariant"
8528	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8529	>
8530	<desc>
8531	Virtual medium image variant. More than one flag may be set.
8532	<see>IMedium</see>
8533	</desc>
8534
8535	<const name="Standard" value="0">
8536	<desc>
8537	No particular variant requested, results in using the backend default.
8538	</desc>
8539	</const>
8540	<const name="VmdkSplit2G" value="0x01">
8541	<desc>
8542	VMDK image split in chunks of less than 2GByte.
8543	</desc>
8544	</const>
8545	<const name="VmdkStreamOptimized" value="0x04">
8546	<desc>
8547	VMDK streamOptimized image. Special import/export format which is
8548	read-only/append-only.
8549	</desc>
8550	</const>
8551	<const name="VmdkESX" value="0x08">
8552	<desc>
8553	VMDK format variant used on ESX products.
8554	</desc>
8555	</const>
8556	<const name="Fixed" value="0x10000">
8557	<desc>
8558	Fixed image. Only allowed for base images.
8559	</desc>
8560	</const>
8561	<const name="Diff" value="0x20000">
8562	<desc>
8563	Differencing image. Only allowed for child images.
8564	</desc>
8565	</const>
8566	</enum>
8567
8568	<interface
8569	name="IMediumAttachment" extends="$unknown"
8570	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8571	wsmap="struct"
8572	>
8573	<desc>
8574	The IMediumAttachment interface links storage media to virtual machines.
8575	For each medium (<link to="IMedium"/>) which has been attached to a
8576	storage controller (<link to="IStorageController"/>) of a machine
8577	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8578	method, one instance of IMediumAttachment is added to the machine's
8579	<link to="IMachine::mediumAttachments"/> array attribute.
8580
8581	Each medium attachment specifies the storage controller as well as a
8582	port and device number and the IMedium instance representing a virtual
8583	hard disk or floppy or DVD image.
8584
8585	For removeable media (DVDs or floppies), there are two additional
8586	options. For one, the IMedium instance can be @c null to represent
8587	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8588	secondly, the medium can be one of the pseudo-media for host drives
8589	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8590	</desc>
8591
8592	<attribute name="medium" type="IMedium" readonly="yes">
8593	<desc>Medium object associated with this attachment; it
8594	can be @c null for removable devices.</desc>
8595	</attribute>
8596
8597	<attribute name="controller" type="wstring" readonly="yes">
8598	<desc>Name of the storage controller of this attachment; this
8599	refers to one of the controllers in <link to="IMachine::storageControllers" />
8600	by name.</desc>
8601	</attribute>
8602
8603	<attribute name="port" type="long" readonly="yes">
8604	<desc>Port number of this attachment.
8605	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8606	</desc>
8607	</attribute>
8608
8609	<attribute name="device" type="long" readonly="yes">
8610	<desc>Device slot number of this attachment.
8611	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8612	</desc>
8613	</attribute>
8614
8615	<attribute name="type" type="DeviceType" readonly="yes">
8616	<desc>Device type of this attachment.</desc>
8617	</attribute>
8618
8619	<attribute name="passthrough" type="boolean" readonly="yes">
8620	<desc>Pass I/O requests through to a device on the host.</desc>
8621	</attribute>
8622
8623	<attribute name="bandwidthLimit" type="unsigned long">
8624	<desc>
8625	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8626	A zero value means uncapped/unlimited.
8627	</desc>
8628	</attribute>
8629
8630	</interface>
8631
8632	<interface
8633	name="IMedium" extends="$unknown"
8634	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8635	wsmap="managed"
8636	>
8637	<desc>
8638	The IMedium interface represents virtual storage for a machine's
8639	hard disks, CD/DVD or floppy drives. It will typically represent
8640	a disk image on the host, for example a VDI or VMDK file representing
8641	a virtual hard disk, or an ISO or RAW file representing virtual
8642	removable media, but can also point to a network location (e.g.
8643	for iSCSI targets).
8644
8645	Instances of IMedium are connected to virtual machines by way of
8646	medium attachments (see <link to="IMediumAttachment" />), which link
8647	the storage medium to a particular device slot of a storage controller
8648	of the virtual machine.
8649	In the VirtualBox API, virtual storage is therefore always represented
8650	by the following chain of object links:
8651
8652	<ul>
8653	<li><link to="IMachine::storageControllers"/> contains an array of
8654	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8655	these are instances of <link to="IStorageController"/>).</li>
8656	<li><link to="IMachine::mediumAttachments"/> contains an array of
8657	medium attachments (instances of <link to="IMediumAttachment"/>),
8658	each containing a storage controller from the above array, a
8659	port/device specification, and an instance of IMedium representing
8660	the medium storage (image file).
8661
8662	For removable media, the storage medium is optional; a medium
8663	attachment with no medium represents a CD/DVD or floppy drive
8664	with no medium inserted. By contrast, hard disk attachments
8665	will always have an IMedium object attached.</li>
8666	<li>Each IMedium in turn points to a storage unit (such as a file
8667	on the host computer or a network resource) that holds actual
8668	data. This location is represented by the <link to="#location"/>
8669	attribute.</li>
8670	</ul>
8671
8672	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8673	new hard disk media can be created with the VirtualBox API using the
8674	<link to="IVirtualBox::createHardDisk"/> method.
8675
8676	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8677	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8678	type in a regular file.
8679
8680	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8681	drive; in that case the <link to="#id" /> attribute contains the UUID of
8682	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8683
8684	<h3>Known media</h3>
8685
8686	When an existing medium is opened for the first time, it is automatically
8687	remembered by the given VirtualBox installation or, in other words, becomes
8688	a <i>known medium</i>. Known media are stored in the media
8689	registry transparently maintained by VirtualBox and stored in settings
8690	files so that this registry is preserved when VirtualBox is not running.
8691
8692	Newly created virtual media are remembered only when the associated
8693	storage unit is actually created.
8694
8695	All known media can be enumerated using
8696	<link to="IVirtualBox::hardDisks"/>,
8697	<link to="IVirtualBox::DVDImages"/> and
8698	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8699	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8700
8701	Only known media can be attached to virtual machines.
8702
8703	Removing known media from the media registry is performed when the given
8704	medium is closed using the <link to="#close"/> method or when its
8705	associated storage unit is deleted.
8706
8707	<h3>Accessibility checks</h3>
8708
8709	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8710	method is called explicitly on a medium. This is done to make the VirtualBox object
8711	ready for serving requests as fast as possible and let the end-user
8712	application decide if it needs to check media accessibility right away or not.
8713
8714	As a result, when VirtualBox starts up (e.g. the VirtualBox
8715	object gets created for the first time), all known media are in the
8716	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8717	attribute is an empty string because no actual accessibility check has
8718	been made yet.
8719
8720	After calling <link to="#refreshState" />, a medium is considered
8721	<i>accessible</i> if its storage unit can be read. In that case, the
8722	<link to="#state"/> attribute has a value of "Created". If the storage
8723	unit cannot be read (for example, because it is located on a disconnected
8724	network resource, or was accidentally deleted outside VirtualBox),
8725	the medium is considered <i>inaccessible</i>, which is indicated by the
8726	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8727	obtained by reading the <link to="#lastAccessError"/> attribute.
8728
8729	<h3>Medium types</h3>
8730
8731	There are four types of medium behavior (see <link to="MediumType" />):
8732	"normal", "immutable", "writethrough" and "shareable", represented by the
8733	<link to="#type"/> attribute. The type of the medium defines how the
8734	medium is attached to a virtual machine and what happens when a
8735	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8736	attached medium is taken. At the moment DVD and floppy media are always
8737	of type "writethrough".
8738
8739	All media can be also divided in two groups: <i>base</i> media and
8740	<i>differencing</i> media. A base medium contains all sectors of the
8741	medium data in its own storage and therefore can be used independently.
8742	In contrast, a differencing mediun is a "delta" to some other medium and
8743	contains only those sectors which differ from that other medium, which is
8744	then called a <i>parent</i>. The differencing medium is said to be
8745	<i>linked to</i> that parent. The parent may be itself a differencing
8746	medium, thus forming a chain of linked media. The last element in that
8747	chain must always be a base medium. Note that several differencing
8748	media may be linked to the same parent medium.
8749
8750	Differencing media can be distinguished from base media by querying the
8751	<link to="#parent"/> attribute: base media do not have parents they would
8752	depend on, so the value of this attribute is always @c null for them.
8753	Using this attribute, it is possible to walk up the medium tree (from the
8754	child medium to its parent). It is also possible to walk down the tree
8755	using the <link to="#children"/> attribute.
8756
8757	Note that the type of all differencing media is "normal"; all other
8758	values are meaningless for them. Base media may be of any type.
8759
8760	<h3>Creating hard disks</h3>
8761
8762	New base hard disks are created using
8763	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8764	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8765	disks are usually implicitly created by VirtualBox when needed but may
8766	also be created explicitly using <link to="#createDiffStorage"/>.
8767
8768	After the hard disk is successfully created (including the storage unit)
8769	or opened, it becomes a known hard disk (remembered in the internal media
8770	registry). Known hard disks can be attached to a virtual machine, accessed
8771	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8772	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8773
8774	The following methods, besides <link to="IMedium::close"/>,
8775	automatically remove the hard disk from the media registry:
8776	<ul>
8777	<li><link to="#deleteStorage"/></li>
8778	<li><link to="#mergeTo"/></li>
8779	</ul>
8780
8781	If the storage unit of the hard disk is a regular file in the host's
8782	file system then the rules stated in the description of the
8783	<link to="IMedium::location"/> attribute apply when setting its value. In
8784	addition, a plain file name without any path may be given, in which case
8785	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8786	folder</link> will be prepended to it.
8787
8788	<h4>Automatic composition of the file name part</h4>
8789
8790	Another extension to the <link to="IMedium::location"/> attribute is that
8791	there is a possibility to cause VirtualBox to compose a unique value for
8792	the file name part of the location using the UUID of the hard disk. This
8793	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8794	e.g. before the storage unit is created, and works as follows. You set the
8795	value of the <link to="IMedium::location"/> attribute to a location
8796	specification which only contains the path specification but not the file
8797	name part and ends with either a forward slash or a backslash character.
8798	In response, VirtualBox will generate a new UUID for the hard disk and
8799	compose the file name using the following pattern:
8800	<pre>
8801	<path>/{<uuid>}.<ext>
8802	</pre>
8803	where <tt><path></tt> is the supplied path specification,
8804	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8805	is the default extension for the storage format of this hard disk. After
8806	that, you may call any of the methods that create a new hard disk storage
8807	unit and they will use the generated UUID and file name.
8808
8809	<h3>Attaching Hard Disks</h3>
8810
8811	Hard disks are attached to virtual machines using the
8812	<link to="IMachine::attachDevice"/> method and detached using the
8813	<link to="IMachine::detachDevice"/> method. Depending on their
8814	<link to="#type"/>, hard disks are attached either
8815	<i>directly</i> or <i>indirectly</i>.
8816
8817	When a hard disk is being attached directly, it is associated with the
8818	virtual machine and used for hard disk operations when the machine is
8819	running. When a hard disk is being attached indirectly, a new differencing
8820	hard disk linked to it is implicitly created and this differencing hard
8821	disk is associated with the machine and used for hard disk operations.
8822	This also means that if <link to="IMachine::attachDevice"/> performs
8823	a direct attachment then the same hard disk will be returned in response
8824	to the subsequent <link to="IMachine::getMedium"/> call; however if
8825	an indirect attachment is performed then
8826	<link to="IMachine::getMedium"/> will return the implicitly created
8827	differencing hard disk, not the original one passed to <link
8828	to="IMachine::attachDevice"/>. In detail:
8829
8830	<ul>
8831	<li><b>Normal base</b> hard disks that do not have children (i.e.
8832	differencing hard disks linked to them) and that are not already
8833	attached to virtual machines in snapshots are attached <b>directly</b>.
8834	Otherwise, they are attached <b>indirectly</b> because having
8835	dependent children or being part of the snapshot makes it impossible
8836	to modify hard disk contents without breaking the integrity of the
8837	dependent party. The <link to="#readOnly"/> attribute allows to
8838	quickly determine the kind of the attachment for the given hard
8839	disk. Note that if a normal base hard disk is to be indirectly
8840	attached to a virtual machine with snapshots then a special
8841	procedure called <i>smart attachment</i> is performed (see below).</li>
8842	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8843	they are attached <b>directly</b> if they do not have children and are
8844	not attached to virtual machines in snapshots, and <b>indirectly</b>
8845	otherwise. Note that the smart attachment procedure is never performed
8846	for differencing hard disks.</li>
8847	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8848	they are designed to be non-writable. If an immutable hard disk is
8849	attached to a virtual machine with snapshots then a special
8850	procedure called smart attachment is performed (see below).</li>
8851	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8852	also as designed. This also means that writethrough hard disks cannot
8853	have other hard disks linked to them at all.</li>
8854	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8855	also as designed. This also means that shareable hard disks cannot
8856	have other hard disks linked to them at all. They behave almost
8857	like writethrough hard disks, except that shareable hard disks can
8858	be attached to several virtual machines which are running, allowing
8859	concurrent accesses. You need special cluster software running in
8860	the virtual machines to make use of such disks.</li>
8861	</ul>
8862
8863	Note that the same hard disk, regardless of its type, may be attached to
8864	more than one virtual machine at a time. In this case, the machine that is
8865	started first gains exclusive access to the hard disk and attempts to
8866	start other machines having this hard disk attached will fail until the
8867	first machine is powered down.
8868
8869	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8870	that the given hard disk remains associated with the given machine after a
8871	successful <link to="IMachine::detachDevice"/> call until
8872	<link to="IMachine::saveSettings"/> is called to save all changes to
8873	machine settings to disk. This deferring is necessary to guarantee that
8874	the hard disk configuration may be restored at any time by a call to
8875	<link to="IMachine::discardSettings"/> before the settings
8876	are saved (committed).
8877
8878	Note that if <link to="IMachine::discardSettings"/> is called after
8879	indirectly attaching some hard disks to the machine but before a call to
8880	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8881	all differencing hard disks implicitly created by
8882	<link to="IMachine::attachDevice"/> for these indirect attachments.
8883	Such implicitly created hard disks will also be immediately deleted when
8884	detached explicitly using the <link to="IMachine::detachDevice"/>
8885	call if it is made before <link to="IMachine::saveSettings"/>. This
8886	implicit deletion is safe because newly created differencing hard
8887	disks do not contain any user data.
8888
8889	However, keep in mind that detaching differencing hard disks that were
8890	implicitly created by <link to="IMachine::attachDevice"/>
8891	before the last <link to="IMachine::saveSettings"/> call will
8892	<b>not</b> implicitly delete them as they may already contain some data
8893	(for example, as a result of virtual machine execution). If these hard
8894	disks are no more necessary, the caller can always delete them explicitly
8895	using <link to="#deleteStorage"/> after they are actually de-associated
8896	from this machine by the <link to="IMachine::saveSettings"/> call.
8897
8898	<h3>Smart Attachment</h3>
8899
8900	When normal base or immutable hard disks are indirectly attached to a
8901	virtual machine then some additional steps are performed to make sure the
8902	virtual machine will have the most recent "view" of the hard disk being
8903	attached. These steps include walking through the machine's snapshots
8904	starting from the current one and going through ancestors up to the first
8905	snapshot. Hard disks attached to the virtual machine in all
8906	of the encountered snapshots are checked whether they are descendants of
8907	the given normal base or immutable hard disk. The first found child (which
8908	is the differencing hard disk) will be used instead of the normal base or
8909	immutable hard disk as a parent for creating a new differencing hard disk
8910	that will be actually attached to the machine. And only if no descendants
8911	are found or if the virtual machine does not have any snapshots then the
8912	normal base or immutable hard disk will be used itself as a parent for
8913	this differencing hard disk.
8914
8915	It is easier to explain what smart attachment does using the
8916	following example:
8917	<pre>
8918	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8919
8920	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8921	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8922	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8923	Snapshot 4 (none) Snapshot 4 (none)
8924	CurState (none) CurState (D3->D2.vdi)
8925
8926	NOT
8927	...
8928	CurState (D3->B.vdi)
8929	</pre>
8930	The first column is the virtual machine configuration before the base hard
8931	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8932	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8933	mean that the hard disk that is actually attached to the machine is a
8934	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8935	another hard disk, <tt>B.vdi</tt>.
8936
8937	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8938	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8939	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8940	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8941	it cannot be attached directly and needs an indirect attachment (i.e.
8942	implicit creation of a new differencing hard disk). Due to the smart
8943	attachment procedure, the new differencing hard disk
8944	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8945	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8946	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8947	machine.
8948
8949	Note that if there is more than one descendant hard disk of the given base
8950	hard disk found in a snapshot, and there is an exact device, channel and
8951	bus match, then this exact match will be used. Otherwise, the youngest
8952	descendant will be picked up.
8953
8954	There is one more important aspect of the smart attachment procedure which
8955	is not related to snapshots at all. Before walking through the snapshots
8956	as described above, the backup copy of the current list of hard disk
8957	attachment is searched for descendants. This backup copy is created when
8958	the hard disk configuration is changed for the first time after the last
8959	<link to="IMachine::saveSettings"/> call and used by
8960	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8961	changes. When such a descendant is found in this backup copy, it will be
8962	simply re-attached back, without creating a new differencing hard disk for
8963	it. This optimization is necessary to make it possible to re-attach the
8964	base or immutable hard disk to a different bus, channel or device slot
8965	without losing the contents of the differencing hard disk actually
8966	attached to the machine in place of it.
8967	</desc>
8968
8969	<attribute name="id" type="uuid" mod="string" readonly="yes">
8970	<desc>
8971	UUID of the medium. For a newly created medium, this value is a randomly
8972	generated UUID.
8973
8974	<note>
8975	For media in one of MediumState_NotCreated, MediumState_Creating or
8976	MediumState_Deleting states, the value of this property is undefined
8977	and will most likely be an empty UUID.
8978	</note>
8979	</desc>
8980	</attribute>
8981
8982	<attribute name="description" type="wstring">
8983	<desc>
8984	Optional description of the medium. For a newly created medium the value
8985	of this attribute is an empty string.
8986
8987	Medium types that don't support this attribute will return E_NOTIMPL in
8988	attempt to get or set this attribute's value.
8989
8990	<note>
8991	For some storage types, reading this attribute may return an outdated
8992	(last known) value when <link to="#state"/> is <link
8993	to="MediumState_Inaccessible"/> or <link
8994	to="MediumState_LockedWrite"/> because the value of this attribute is
8995	stored within the storage unit itself. Also note that changing the
8996	attribute value is not possible in such case, as well as when the
8997	medium is the <link to="MediumState_LockedRead"/> state.
8998	</note>
8999	</desc>
9000	</attribute>
9001
9002	<attribute name="state" type="MediumState" readonly="yes">
9003	<desc>
9004	Returns the current medium state, which is the last state set by
9005	the accessibility check performed by <link to="#refreshState"/>.
9006	If that method has not yet been called on the medium, the state
9007	is "Inaccessible"; as opposed to truly inaccessible media, the
9008	value of <link to="#lastAccessError"/> will be an empty string in
9009	that case.
9010
9011	<note>As of version 3.1, this no longer performs an accessibility check
9012	automatically; call <link to="#refreshState"/> for that.
9013	</note>
9014	</desc>
9015	</attribute>
9016
9017	<attribute name="variant" type="MediumVariant" readonly="yes">
9018	<desc>
9019	Returns the storage format variant information for this medium.
9020	Before <link to="#refreshState"/> is called this method returns
9021	an undefined value.
9022	</desc>
9023	</attribute>
9024
9025	<attribute name="location" type="wstring">
9026	<desc>
9027	Location of the storage unit holding medium data.
9028
9029	The format of the location string is medium type specific. For medium
9030	types using regular files in a host's file system, the location
9031	string is the full file name.
9032
9033	Some medium types may support changing the storage unit location by
9034	simply changing the value of this property. If this operation is not
9035	supported, the implementation will return E_NOTIMPL in attempt to set
9036	this attribute's value.
9037
9038	When setting a value of the location attribute which is a regular file
9039	in the host's file system, the given file name may be either relative to
9040	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9041	absolute. Note that if the given location specification does not contain
9042	the file extension part then a proper default extension will be
9043	automatically appended by the implementation depending on the medium type.
9044	</desc>
9045	</attribute>
9046
9047	<attribute name="name" type="wstring" readonly="yes">
9048	<desc>
9049	Name of the storage unit holding medium data.
9050
9051	The returned string is a short version of the <link to="#location"/>
9052	attribute that is suitable for representing the medium in situations
9053	where the full location specification is too long (such as lists
9054	and comboboxes in GUI frontends). This string is also used by frontends
9055	to sort the media list alphabetically when needed.
9056
9057	For example, for locations that are regular files in the host's file
9058	system, the value of this attribute is just the file name (+ extension),
9059	without the path specification.
9060
9061	Note that as opposed to the <link to="#location"/> attribute, the name
9062	attribute will not necessary be unique for a list of media of the
9063	given type and format.
9064	</desc>
9065	</attribute>
9066
9067	<attribute name="deviceType" type="DeviceType" readonly="yes">
9068	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9069	medium.</desc>
9070	</attribute>
9071
9072	<attribute name="hostDrive" type="boolean" readonly="yes">
9073	<desc>True if this corresponds to a drive on the host.</desc>
9074	</attribute>
9075
9076	<attribute name="size" type="long long" readonly="yes">
9077	<desc>
9078	Physical size of the storage unit used to hold medium data (in bytes).
9079
9080	<note>
9081	For media whose <link to="#state"/> is <link
9082	to="MediumState_Inaccessible"/>, the value of this property is the
9083	last known size. For <link to="MediumState_NotCreated"/> media,
9084	the returned value is zero.
9085	</note>
9086	</desc>
9087	</attribute>
9088
9089	<attribute name="format" type="wstring" readonly="yes">
9090	<desc>
9091	Storage format of this medium.
9092
9093	The value of this attribute is a string that specifies a backend used
9094	to store medium data. The storage format is defined when you create a
9095	new medium or automatically detected when you open an existing medium,
9096	and cannot be changed later.
9097
9098	The list of all storage formats supported by this VirtualBox
9099	installation can be obtained using
9100	<link to="ISystemProperties::mediumFormats"/>.
9101	</desc>
9102	</attribute>
9103
9104	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9105	<desc>
9106	Storage medium format object corresponding to this medium.
9107
9108	The value of this attribute is a reference to the medium format object
9109	that specifies the backend properties used to store medium data. The
9110	storage format is defined when you create a new medium or automatically
9111	detected when you open an existing medium, and cannot be changed later.
9112
9113	<note>@c null is returned if there is no associated medium format
9114	object. This can e.g. happen for medium objects representing host
9115	drives and other special medium objects.</note>
9116	</desc>
9117	</attribute>
9118
9119	<attribute name="type" type="MediumType">
9120	<desc>
9121	Type (role) of this medium.
9122
9123	The following constraints apply when changing the value of this
9124	attribute:
9125	<ul>
9126	<li>If a medium is attached to a virtual machine (either in the
9127	current state or in one of the snapshots), its type cannot be
9128	changed.
9129	</li>
9130	<li>As long as the medium has children, its type cannot be set
9131	to <link to="MediumType_Writethrough"/>.
9132	</li>
9133	<li>The type of all differencing media is
9134	<link to="MediumType_Normal"/> and cannot be changed.
9135	</li>
9136	</ul>
9137
9138	The type of a newly created or opened medium is set to
9139	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9140	which have a type of <link to="MediumType_Writethrough"/>.
9141	</desc>
9142	</attribute>
9143
9144	<attribute name="parent" type="IMedium" readonly="yes">
9145	<desc>
9146	Parent of this medium (the medium this medium is directly based
9147	on).
9148
9149	Only differencing media have parents. For base (non-differencing)
9150	media, @c null is returned.
9151	</desc>
9152	</attribute>
9153
9154	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9155	<desc>
9156	Children of this medium (all differencing media directly based
9157	on this medium). A @c null array is returned if this medium
9158	does not have any children.
9159	</desc>
9160	</attribute>
9161
9162	<attribute name="base" type="IMedium" readonly="yes">
9163	<desc>
9164	Base medium of this medium.
9165
9166	If this is a differencing medium, its base medium is the medium
9167	the given medium branch starts from. For all other types of media, this
9168	property returns the medium object itself (i.e. the same object this
9169	property is read on).
9170	</desc>
9171	</attribute>
9172
9173	<attribute name="readOnly" type="boolean" readonly="yes">
9174	<desc>
9175	Returns @c true if this medium is read-only and @c false otherwise.
9176
9177	A medium is considered to be read-only when its contents cannot be
9178	modified without breaking the integrity of other parties that depend on
9179	this medium such as its child media or snapshots of virtual machines
9180	where this medium is attached to these machines. If there are no
9181	children and no such snapshots then there is no dependency and the
9182	medium is not read-only.
9183
9184	The value of this attribute can be used to determine the kind of the
9185	attachment that will take place when attaching this medium to a
9186	virtual machine. If the value is @c false then the medium will
9187	be attached directly. If the value is @c true then the medium
9188	will be attached indirectly by creating a new differencing child
9189	medium for that. See the interface description for more information.
9190
9191	Note that all <link to="MediumType_Immutable">Immutable</link> media
9192	are always read-only while all
9193	<link to="MediumType_Writethrough">Writethrough</link> media are
9194	always not.
9195
9196	<note>
9197	The read-only condition represented by this attribute is related to
9198	the medium type and usage, not to the current
9199	<link to="IMedium::state">medium state</link> and not to the read-only
9200	state of the storage unit.
9201	</note>
9202	</desc>
9203	</attribute>
9204
9205	<attribute name="logicalSize" type="long long" readonly="yes">
9206	<desc>
9207	Logical size of this medium (in bytes), as reported to the
9208	guest OS running inside the virtual machine this medium is
9209	attached to. The logical size is defined when the medium is created
9210	and cannot be changed later.
9211
9212	<note>
9213	Reading this property on a differencing medium will return the size
9214	of its <link to="#base"/> medium.
9215	</note>
9216	<note>
9217	For media whose state is <link to="#state"/> is <link
9218	to="MediumState_Inaccessible"/>, the value of this property is the
9219	last known logical size. For <link to="MediumState_NotCreated"/>
9220	media, the returned value is zero.
9221	</note>
9222	</desc>
9223	</attribute>
9224
9225	<attribute name="autoReset" type="boolean">
9226	<desc>
9227	Whether this differencing medium will be automatically reset each
9228	time a virtual machine it is attached to is powered up. This
9229	attribute is automatically set to @c true for the last
9230	differencing image of an "immutable" medium (see
9231	<link to="MediumType" />).
9232
9233	See <link to="#reset"/> for more information about resetting
9234	differencing media.
9235
9236	<note>
9237	Reading this property on a base (non-differencing) medium will
9238	always @c false. Changing the value of this property in this
9239	case is not supported.
9240	</note>
9241
9242	<result name="VBOX_E_NOT_SUPPORTED">
9243	This is not a differencing medium (when changing the attribute
9244	value).
9245	</result>
9246	</desc>
9247	</attribute>
9248
9249	<attribute name="lastAccessError" type="wstring" readonly="yes">
9250	<desc>
9251	Text message that represents the result of the last accessibility
9252	check performed by <link to="#refreshState"/>.
9253
9254	An empty string is returned if the last accessibility check
9255	was successful or has not yet been called. As a result, if
9256	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9257	then <link to="#refreshState"/> has yet to be called; this is the
9258	default value of media after VirtualBox initialization.
9259	A non-empty string indicates a failure and should normally describe
9260	a reason of the failure (for example, a file read error).
9261	</desc>
9262	</attribute>
9263
9264	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9265	<desc>
9266	Array of UUIDs of all machines this medium is attached to.
9267
9268	A @c null array is returned if this medium is not attached to any
9269	machine or to any machine's snapshot.
9270
9271	<note>
9272	The returned array will include a machine even if this medium is not
9273	attached to that machine in the current state but attached to it in
9274	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9275	details.
9276	</note>
9277	</desc>
9278	</attribute>
9279
9280	<method name="setIDs">
9281	<desc>
9282	Changes the UUID and parent UUID for a hard disk medium.
9283	</desc>
9284	<param name="setImageId" type="boolean" dir="in">
9285	<desc>
9286	Select whether a new image UUID is set or not.
9287	</desc>
9288	</param>
9289	<param name="imageId" type="uuid" mod="string" dir="in">
9290	<desc>
9291	New UUID for the image. If an empty string is passed, then a new
9292	UUID is automatically created, provided that @a setImageId is @c true.
9293	Specifying a zero UUID is not allowed.
9294	</desc>
9295	</param>
9296	<param name="setParentId" type="boolean" dir="in">
9297	<desc>
9298	Select whether a new parent UUID is set or not.
9299	</desc>
9300	</param>
9301	<param name="parentId" type="uuid" mod="string" dir="in">
9302	<desc>
9303	New parent UUID for the image. If an empty string is passed, then a
9304	new UUID is automatically created, provided @a setParentId is
9305	@c true. A zero UUID is valid.
9306	</desc>
9307	</param>
9308	<result name="E_INVALIDARG">
9309	Invalid parameter combination.
9310	</result>
9311	<result name="VBOX_E_NOT_SUPPORTED">
9312	Medium is not a hard disk medium.
9313	</result>
9314	</method>
9315
9316	<method name="refreshState">
9317	<desc>
9318	If the current medium state (see <link to="MediumState"/>) is one of
9319	"Created", "Inaccessible" or "LockedRead", then this performs an
9320	accessibility check on the medium and sets the value of the <link to="#state"/>
9321	attribute accordingly; that value is also returned for convenience.
9322
9323	For all other state values, this does not perform a refresh but returns
9324	the state only.
9325
9326	The refresh, if performed, may take a long time (several seconds or even
9327	minutes, depending on the storage unit location and format) because it performs an
9328	accessibility check of the storage unit. This check may cause a significant
9329	delay if the storage unit of the given medium is, for example, a file located
9330	on a network share which is not currently accessible due to connectivity
9331	problems. In that case, the call will not return until a timeout
9332	interval defined by the host OS for this operation expires. For this reason,
9333	it is recommended to never read this attribute on the main UI thread to avoid
9334	making the UI unresponsive.
9335
9336	If the last known state of the medium is "Created" and the accessibility
9337	check fails, then the state would be set to "Inaccessible", and
9338	<link to="#lastAccessError"/> may be used to get more details about the
9339	failure. If the state of the medium is "LockedRead", then it remains the
9340	same, and a non-empty value of <link to="#lastAccessError"/> will
9341	indicate a failed accessibility check in this case.
9342
9343	Note that not all medium states are applicable to all medium types.
9344	</desc>
9345	<param name="state" type="MediumState" dir="return">
9346	<desc>
9347	New medium state.
9348	</desc>
9349	</param>
9350	</method>
9351
9352	<method name="getSnapshotIds">
9353	<desc>
9354	Returns an array of UUIDs of all snapshots of the given machine where
9355	this medium is attached to.
9356
9357	If the medium is attached to the machine in the current state, then the
9358	first element in the array will always be the ID of the queried machine
9359	(i.e. the value equal to the @c machineId argument), followed by
9360	snapshot IDs (if any).
9361
9362	If the medium is not attached to the machine in the current state, then
9363	the array will contain only snapshot IDs.
9364
9365	The returned array may be @c null if this medium is not attached
9366	to the given machine at all, neither in the current state nor in one of
9367	the snapshots.
9368	</desc>
9369	<param name="machineId" type="uuid" mod="string" dir="in">
9370	<desc>
9371	UUID of the machine to query.
9372	</desc>
9373	</param>
9374	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9375	<desc>
9376	Array of snapshot UUIDs of the given machine using this medium.
9377	</desc>
9378	</param>
9379	</method>
9380
9381	<method name="lockRead">
9382	<desc>
9383	Locks this medium for reading.
9384
9385	A read lock is shared: many clients can simultaneously lock the
9386	same medium for reading unless it is already locked for writing (see
9387	<link to="#lockWrite"/>) in which case an error is returned.
9388
9389	When the medium is locked for reading, it cannot be modified
9390	from within VirtualBox. This means that any method that changes
9391	the properties of this medium or contents of the storage unit
9392	will return an error (unless explicitly stated otherwise). That
9393	includes an attempt to start a virtual machine that wants to
9394	write to the the medium.
9395
9396	When the virtual machine is started up, it locks for reading all
9397	media it uses in read-only mode. If some medium cannot be locked
9398	for reading, the startup procedure will fail.
9399	A medium is typically locked for reading while it is used by a running
9400	virtual machine but has a depending differencing image that receives
9401	the actual write operations. This way one base medium can have
9402	multiple child differencing images which can be written to
9403	simultaneously. Read-only media such as DVD and floppy images are
9404	also locked for reading only (so they can be in use by multiple
9405	machines simultaneously).
9406
9407	A medium is also locked for reading when it is the source of a
9408	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9409
9410	The medium locked for reading must be unlocked using the <link
9411	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9412	can be nested and must be followed by the same number of paired
9413	<link to="#unlockRead"/> calls.
9414
9415	This method sets the medium state (see <link to="#state"/>) to
9416	"LockedRead" on success. The medium's previous state must be
9417	one of "Created", "Inaccessible" or "LockedRead".
9418
9419	Locking an inaccessible medium is not an error; this method performs
9420	a logical lock that prevents modifications of this medium through
9421	the VirtualBox API, not a physical file-system lock of the underlying
9422	storage unit.
9423
9424	This method returns the current state of the medium
9425	<i>before</i> the operation.
9426
9427	<result name="VBOX_E_INVALID_OBJECT_STATE">
9428	Invalid medium state (e.g. not created, locked, inaccessible,
9429	creating, deleting).
9430	</result>
9431
9432	</desc>
9433	<param name="state" type="MediumState" dir="return">
9434	<desc>
9435	State of the medium after the operation.
9436	</desc>
9437	</param>
9438	</method>
9439
9440	<method name="unlockRead">
9441	<desc>
9442	Cancels the read lock previously set by <link to="#lockRead"/>.
9443
9444	For both success and failure, this method returns the current state
9445	of the medium <i>after</i> the operation.
9446
9447	See <link to="#lockRead"/> for more details.
9448
9449	<result name="VBOX_E_INVALID_OBJECT_STATE">
9450	Medium not locked for reading.
9451	</result>
9452
9453	</desc>
9454	<param name="state" type="MediumState" dir="return">
9455	<desc>
9456	State of the medium after the operation.
9457	</desc>
9458	</param>
9459	</method>
9460
9461	<method name="lockWrite">
9462	<desc>
9463	Locks this medium for writing.
9464
9465	A write lock, as opposed to <link to="#lockRead"/>, is
9466	exclusive: there may be only one client holding a write lock,
9467	and there may be no read locks while the write lock is held.
9468	As a result, read-locking fails if a write lock is held, and
9469	write-locking fails if either a read or another write lock is held.
9470
9471	When a medium is locked for writing, it cannot be modified
9472	from within VirtualBox, and it is not guaranteed that the values
9473	of its properties are up-to-date. Any method that changes the
9474	properties of this medium or contents of the storage unit will
9475	return an error (unless explicitly stated otherwise).
9476
9477	When a virtual machine is started up, it locks for writing all
9478	media it uses to write data to. If any medium could not be locked
9479	for writing, the startup procedure will fail. If a medium has
9480	differencing images, then while the machine is running, only
9481	the last ("leaf") differencing image is locked for writing,
9482	whereas its parents are locked for reading only.
9483
9484	A medium is also locked for writing when it is the target of a
9485	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9486
9487	The medium locked for writing must be unlocked using the <link
9488	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9489
9490	This method sets the medium state (see <link to="#state"/>) to
9491	"LockedWrite" on success. The medium's previous state must be
9492	either "Created" or "Inaccessible".
9493
9494	Locking an inaccessible medium is not an error; this method performs
9495	a logical lock that prevents modifications of this medium through
9496	the VirtualBox API, not a physical file-system lock of the underlying
9497	storage unit.
9498
9499	For both, success and failure, this method returns the current
9500	state of the medium <i>before</i> the operation.
9501
9502	<result name="VBOX_E_INVALID_OBJECT_STATE">
9503	Invalid medium state (e.g. not created, locked, inaccessible,
9504	creating, deleting).
9505	</result>
9506
9507	</desc>
9508	<param name="state" type="MediumState" dir="return">
9509	<desc>
9510	State of the medium after the operation.
9511	</desc>
9512	</param>
9513	</method>
9514
9515	<method name="unlockWrite">
9516	<desc>
9517	Cancels the write lock previously set by <link to="#lockWrite"/>.
9518
9519	For both success and failure, this method returns the current
9520	state of the medium <i>after</i> the operation.
9521
9522	See <link to="#lockWrite"/> for more details.
9523
9524	<result name="VBOX_E_INVALID_OBJECT_STATE">
9525	Medium not locked for writing.
9526	</result>
9527
9528	</desc>
9529	<param name="state" type="MediumState" dir="return">
9530	<desc>
9531	State of the medium after the operation.
9532	</desc>
9533	</param>
9534	</method>
9535
9536	<method name="close">
9537	<desc>
9538	Closes this medium.
9539
9540	The medium must not be attached to any known virtual machine
9541	and must not have any known child media, otherwise the
9542	operation will fail.
9543
9544	When the medium is successfully closed, it is removed from
9545	the list of registered media, but its storage unit is not
9546	deleted. In particular, this means that this medium can
9547	later be opened again using the <link to="IVirtualBox::openMedium"/>
9548	call.
9549
9550	Note that after this method successfully returns, the given medium
9551	object becomes uninitialized. This means that any attempt
9552	to call any of its methods or attributes will fail with the
9553	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9554
9555	<result name="VBOX_E_INVALID_OBJECT_STATE">
9556	Invalid medium state (other than not created, created or
9557	inaccessible).
9558	</result>
9559	<result name="VBOX_E_OBJECT_IN_USE">
9560	Medium attached to virtual machine.
9561	</result>
9562	<result name="VBOX_E_FILE_ERROR">
9563	Settings file not accessible.
9564	</result>
9565	<result name="VBOX_E_XML_ERROR">
9566	Could not parse the settings file.
9567	</result>
9568
9569	</desc>
9570	</method>
9571
9572	<!-- storage methods -->
9573
9574	<method name="getProperty">
9575	<desc>
9576	Returns the value of the custom medium property with the given name.
9577
9578	The list of all properties supported by the given medium format can
9579	be obtained with <link to="IMediumFormat::describeProperties"/>.
9580
9581	Note that if this method returns an empty string in @a value, the
9582	requested property is supported but currently not assigned any value.
9583
9584	<result name="VBOX_E_OBJECT_NOT_FOUND">
9585	Requested property does not exist (not supported by the format).
9586	</result>
9587	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9588	</desc>
9589	<param name="name" type="wstring" dir="in">
9590	<desc>Name of the property to get.</desc>
9591	</param>
9592	<param name="value" type="wstring" dir="return">
9593	<desc>Current property value.</desc>
9594	</param>
9595	</method>
9596
9597	<method name="setProperty">
9598	<desc>
9599	Sets the value of the custom medium property with the given name.
9600
9601	The list of all properties supported by the given medium format can
9602	be obtained with <link to="IMediumFormat::describeProperties"/>.
9603
9604	Note that setting the property value to @c null or an empty string is
9605	equivalent to deleting the existing value. A default value (if it is
9606	defined for this property) will be used by the format backend in this
9607	case.
9608
9609	<result name="VBOX_E_OBJECT_NOT_FOUND">
9610	Requested property does not exist (not supported by the format).
9611	</result>
9612	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9613	</desc>
9614	<param name="name" type="wstring" dir="in">
9615	<desc>Name of the property to set.</desc>
9616	</param>
9617	<param name="value" type="wstring" dir="in">
9618	<desc>Property value to set.</desc>
9619	</param>
9620	</method>
9621
9622	<method name="getProperties">
9623	<desc>
9624	Returns values for a group of properties in one call.
9625
9626	The names of the properties to get are specified using the @a names
9627	argument which is a list of comma-separated property names or
9628	an empty string if all properties are to be returned. Note that currently
9629	the value of this argument is ignored and the method always returns all
9630	existing properties.
9631
9632	The list of all properties supported by the given medium format can
9633	be obtained with <link to="IMediumFormat::describeProperties"/>.
9634
9635	The method returns two arrays, the array of property names corresponding
9636	to the @a names argument and the current values of these properties.
9637	Both arrays have the same number of elements with each elemend at the
9638	given index in the first array corresponds to an element at the same
9639	index in the second array.
9640
9641	Note that for properties that do not have assigned values,
9642	an empty string is returned at the appropriate index in the
9643	@a returnValues array.
9644
9645	</desc>
9646	<param name="names" type="wstring" dir="in">
9647	<desc>
9648	Names of properties to get.
9649	</desc>
9650	</param>
9651	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9652	<desc>Names of returned properties.</desc>
9653	</param>
9654	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9655	<desc>Values of returned properties.</desc>
9656	</param>
9657	</method>
9658
9659	<method name="setProperties">
9660	<desc>
9661	Sets values for a group of properties in one call.
9662
9663	The names of the properties to set are passed in the @a names
9664	array along with the new values for them in the @a values array. Both
9665	arrays have the same number of elements with each elemend at the given
9666	index in the first array corresponding to an element at the same index
9667	in the second array.
9668
9669	If there is at least one property name in @a names that is not valid,
9670	the method will fail before changing the values of any other properties
9671	from the @a names array.
9672
9673	Using this method over <link to="#setProperty"/> is preferred if you
9674	need to set several properties at once since it will result into less
9675	IPC calls.
9676
9677	The list of all properties supported by the given medium format can
9678	be obtained with <link to="IMediumFormat::describeProperties"/>.
9679
9680	Note that setting the property value to @c null or an empty string is
9681	equivalent to deleting the existing value. A default value (if it is
9682	defined for this property) will be used by the format backend in this
9683	case.
9684	</desc>
9685	<param name="names" type="wstring" safearray="yes" dir="in">
9686	<desc>Names of properties to set.</desc>
9687	</param>
9688	<param name="values" type="wstring" safearray="yes" dir="in">
9689	<desc>Values of properties to set.</desc>
9690	</param>
9691	</method>
9692
9693	<!-- storage methods -->
9694
9695	<method name="createBaseStorage">
9696	<desc>
9697	Starts creating a hard disk storage unit (fixed/dynamic, according
9698	to the variant flags) in in the background. The previous storage unit
9699	created for this object, if any, must first be deleted using
9700	<link to="#deleteStorage"/>, otherwise the operation will fail.
9701
9702	Before the operation starts, the medium is placed in
9703	<link to="MediumState_Creating"/> state. If the create operation
9704	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9705	state.
9706
9707	After the returned progress object reports that the operation has
9708	successfully completed, the medium state will be set to <link
9709	to="MediumState_Created"/>, the medium will be remembered by this
9710	VirtualBox installation and may be attached to virtual machines.
9711
9712	<result name="VBOX_E_NOT_SUPPORTED">
9713	The variant of storage creation operation is not supported. See <link
9714	to="IMediumFormat::capabilities"/>.
9715	</result>
9716	</desc>
9717	<param name="logicalSize" type="long long" dir="in">
9718	<desc>Maximum logical size of the medium in bytes.</desc>
9719	</param>
9720	<param name="variant" type="MediumVariant" dir="in">
9721	<desc>Exact image variant which should be created.</desc>
9722	</param>
9723	<param name="progress" type="IProgress" dir="return">
9724	<desc>Progress object to track the operation completion.</desc>
9725	</param>
9726	</method>
9727
9728	<method name="deleteStorage">
9729	<desc>
9730	Starts deleting the storage unit of this medium.
9731
9732	The medium must not be attached to any known virtual machine and must
9733	not have any known child media, otherwise the operation will fail.
9734	It will also fail if there is no storage unit to delete or if deletion
9735	is already in progress, or if the medium is being in use (locked for
9736	read or for write) or inaccessible. Therefore, the only valid state for
9737	this operation to succeed is <link to="MediumState_Created"/>.
9738
9739	Before the operation starts, the medium is placed in
9740	<link to="MediumState_Deleting"/> state and gets removed from the list
9741	of remembered hard disks (media registry). If the delete operation
9742	fails, the medium will be remembered again and placed back to
9743	<link to="MediumState_Created"/> state.
9744
9745	After the returned progress object reports that the operation is
9746	complete, the medium state will be set to
9747	<link to="MediumState_NotCreated"/> and you will be able to use one of
9748	the storage creation methods to create it again.
9749
9750	<see>#close()</see>
9751
9752	<result name="VBOX_E_OBJECT_IN_USE">
9753	Medium is attached to a virtual machine.
9754	</result>
9755	<result name="VBOX_E_NOT_SUPPORTED">
9756	Storage deletion is not allowed because neither of storage creation
9757	operations are supported. See
9758	<link to="IMediumFormat::capabilities"/>.
9759	</result>
9760
9761	<note>
9762	If the deletion operation fails, it is not guaranteed that the storage
9763	unit still exists. You may check the <link to="IMedium::state"/> value
9764	to answer this question.
9765	</note>
9766	</desc>
9767	<param name="progress" type="IProgress" dir="return">
9768	<desc>Progress object to track the operation completion.</desc>
9769	</param>
9770	</method>
9771
9772	<!-- diff methods -->
9773
9774	<method name="createDiffStorage">
9775	<desc>
9776	Starts creating an empty differencing storage unit based on this
9777	medium in the format and at the location defined by the @a target
9778	argument.
9779
9780	The target medium must be in <link to="MediumState_NotCreated"/>
9781	state (i.e. must not have an existing storage unit). Upon successful
9782	completion, this operation will set the type of the target medium to
9783	<link to="MediumType_Normal"/> and create a storage unit necessary to
9784	represent the differencing medium data in the given format (according
9785	to the storage format of the target object).
9786
9787	After the returned progress object reports that the operation is
9788	successfully complete, the target medium gets remembered by this
9789	VirtualBox installation and may be attached to virtual machines.
9790
9791	<note>
9792	The medium will be set to <link to="MediumState_LockedRead"/>
9793	state for the duration of this operation.
9794	</note>
9795	<result name="VBOX_E_OBJECT_IN_USE">
9796	Medium not in @c NotCreated state.
9797	</result>
9798	</desc>
9799	<param name="target" type="IMedium" dir="in">
9800	<desc>Target medium.</desc>
9801	</param>
9802	<param name="variant" type="MediumVariant" dir="in">
9803	<desc>Exact image variant which should be created.</desc>
9804	</param>
9805	<param name="progress" type="IProgress" dir="return">
9806	<desc>Progress object to track the operation completion.</desc>
9807	</param>
9808	</method>
9809
9810	<method name="mergeTo">
9811	<desc>
9812	Starts merging the contents of this medium and all intermediate
9813	differencing media in the chain to the given target medium.
9814
9815	The target medium must be either a descendant of this medium or
9816	its ancestor (otherwise this method will immediately return a failure).
9817	It follows that there are two logical directions of the merge operation:
9818	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9819	ancestor (<i>backward merge</i>). Let us consider the following medium
9820	chain:
9821
9822	<pre>Base <- Diff_1 <- Diff_2</pre>
9823
9824	Here, calling this method on the <tt>Base</tt> medium object with
9825	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9826	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9827	merge. Note that in both cases the contents of the resulting medium
9828	will be the same, the only difference is the medium object that takes
9829	the result of the merge operation. In case of the forward merge in the
9830	above example, the result will be written to <tt>Diff_2</tt>; in case of
9831	the backward merge, the result will be written to <tt>Base</tt>. In
9832	other words, the result of the operation is always stored in the target
9833	medium.
9834
9835	Upon successful operation completion, the storage units of all media in
9836	the chain between this (source) medium and the target medium, including
9837	the source medium itself, will be automatically deleted and the
9838	relevant medium objects (including this medium) will become
9839	uninitialized. This means that any attempt to call any of
9840	their methods or attributes will fail with the
9841	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9842	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9843	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9844	Note that <tt>Diff_2</tt> in this case will become a base medium
9845	itself since it will no longer be based on any other medium.
9846
9847	Considering the above, all of the following conditions must be met in
9848	order for the merge operation to succeed:
9849	<ul>
9850	<li>
9851	Neither this (source) medium nor any intermediate
9852	differencing medium in the chain between it and the target
9853	medium is attached to any virtual machine.
9854	</li>
9855	<li>
9856	Neither the source medium nor the target medium is an
9857	<link to="MediumType_Immutable"/> medium.
9858	</li>
9859	<li>
9860	The part of the medium tree from the source medium to the
9861	target medium is a linear chain, i.e. all medium in this
9862	chain have exactly one child which is the next medium in this
9863	chain. The only exception from this rule is the target medium in
9864	the forward merge operation; it is allowed to have any number of
9865	child media because the merge operation will not change its
9866	logical contents (as it is seen by the guest OS or by children).
9867	</li>
9868	<li>
9869	None of the involved media are in
9870	<link to="MediumState_LockedRead"/> or
9871	<link to="MediumState_LockedWrite"/> state.
9872	</li>
9873	</ul>
9874
9875	<note>
9876	This (source) medium and all intermediates will be placed to <link
9877	to="MediumState_Deleting"/> state and the target medium will be
9878	placed to <link to="MediumState_LockedWrite"/> state and for the
9879	duration of this operation.
9880	</note>
9881	</desc>
9882	<param name="target" type="IMedium" dir="in">
9883	<desc>Target medium.</desc>
9884	</param>
9885	<param name="progress" type="IProgress" dir="return">
9886	<desc>Progress object to track the operation completion.</desc>
9887	</param>
9888	</method>
9889
9890	<!-- clone method -->
9891
9892	<method name="cloneTo">
9893	<desc>
9894	Starts creating a clone of this medium in the format and at the
9895	location defined by the @a target argument.
9896
9897	The target medium must be either in <link to="MediumState_NotCreated"/>
9898	state (i.e. must not have an existing storage unit) or in
9899	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9900	big enough to hold the data or else the copy will be partial). Upon
9901	successful completion, the cloned medium will contain exactly the
9902	same sector data as the medium being cloned, except that in the
9903	first case a new UUID for the clone will be randomly generated, and in
9904	the second case the UUID will remain unchanged.
9905
9906	The @a parent argument defines which medium will be the parent
9907	of the clone. Passing a @c null reference indicates that the clone will
9908	be a base image, i.e. completely independent. It is possible to specify
9909	an arbitrary medium for this parameter, including the parent of the
9910	medium which is being cloned. Even cloning to a child of the source
9911	medium is possible. Note that when cloning to an existing image, the
9912	@a parent irgument is ignored.
9913
9914	After the returned progress object reports that the operation is
9915	successfully complete, the target medium gets remembered by this
9916	VirtualBox installation and may be attached to virtual machines.
9917
9918	<note>
9919	This medium will be placed to <link to="MediumState_LockedRead"/>
9920	state for the duration of this operation.
9921	</note>
9922	<result name="E_NOTIMPL">
9923	The specified cloning variant is not supported at the moment.
9924	</result>
9925	</desc>
9926	<param name="target" type="IMedium" dir="in">
9927	<desc>Target medium.</desc>
9928	</param>
9929	<param name="variant" type="MediumVariant" dir="in">
9930	<desc>Exact image variant which should be created.</desc>
9931	</param>
9932	<param name="parent" type="IMedium" dir="in">
9933	<desc>Parent of the cloned medium.</desc>
9934	</param>
9935	<param name="progress" type="IProgress" dir="return">
9936	<desc>Progress object to track the operation completion.</desc>
9937	</param>
9938	</method>
9939
9940	<!-- other methods -->
9941
9942	<method name="compact">
9943	<desc>
9944	Starts compacting of this medium. This means that the medium is
9945	transformed into a possibly more compact storage representation.
9946	This potentially creates temporary images, which can require a
9947	substantial amount of additional disk space.
9948
9949	This medium will be placed to <link to="MediumState_LockedWrite"/>
9950	state and all its parent media (if any) will be placed to
9951	<link to="MediumState_LockedRead"/> state for the duration of this
9952	operation.
9953
9954	Please note that the results can be either returned straight away,
9955	or later as the result of the background operation via the object
9956	returned via the @a progress parameter.
9957
9958	<result name="VBOX_E_NOT_SUPPORTED">
9959	Medium format does not support compacting (but potentially
9960	needs it).
9961	</result>
9962	</desc>
9963	<param name="progress" type="IProgress" dir="return">
9964	<desc>Progress object to track the operation completion.</desc>
9965	</param>
9966	</method>
9967
9968	<method name="resize">
9969	<desc>
9970	Starts resizing this medium. This means that the nominal size of the
9971	medium is set to the new value. Both increasing and decreasing the
9972	size is possible, and there are no safety checks, since VirtualBox
9973	does not make any assumptions about the medium contents.
9974
9975	Resizing usually needs additional disk space, and possibly also
9976	some temporary disk space. Note that resize does not create a full
9977	temporary copy of the medium, so the additional disk space requirement
9978	is usually much lower than using the clone operation.
9979
9980	This medium will be placed to <link to="MediumState_LockedWrite"/>
9981	state for the duration of this operation.
9982
9983	Please note that the results can be either returned straight away,
9984	or later as the result of the background operation via the object
9985	returned via the @a progress parameter.
9986
9987	<result name="VBOX_E_NOT_SUPPORTED">
9988	Medium format does not support resizing.
9989	</result>
9990	</desc>
9991	<param name="logicalSize" type="long long" dir="in">
9992	<desc>New nominal capacity of the medium in bytes.</desc>
9993	</param>
9994	<param name="progress" type="IProgress" dir="return">
9995	<desc>Progress object to track the operation completion.</desc>
9996	</param>
9997	</method>
9998
9999	<method name="reset">
10000	<desc>
10001	Starts erasing the contents of this differencing medium.
10002
10003	This operation will reset the differencing medium to its initial
10004	state when it does not contain any sector data and any read operation is
10005	redirected to its parent medium. This automatically gets called
10006	during VM power-up for every medium whose <link to="#autoReset" />
10007	attribute is @c true.
10008
10009	The medium will be write-locked for the duration of this operation (see
10010	<link to="#lockWrite" />).
10011
10012	<result name="VBOX_E_NOT_SUPPORTED">
10013	This is not a differencing medium.
10014	</result>
10015	<result name="VBOX_E_INVALID_OBJECT_STATE">
10016	Medium is not in <link to="MediumState_Created"/> or
10017	<link to="MediumState_Inaccessible"/> state.
10018	</result>
10019	</desc>
10020	<param name="progress" type="IProgress" dir="return">
10021	<desc>Progress object to track the operation completion.</desc>
10022	</param>
10023	</method>
10024
10025	</interface>
10026
10027
10028	<!--
10029	// IMediumFormat
10030	/////////////////////////////////////////////////////////////////////////
10031	-->
10032
10033	<enum
10034	name="DataType"
10035	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10036	>
10037	<const name="Int32" value="0"/>
10038	<const name="Int8" value="1"/>
10039	<const name="String" value="2"/>
10040	</enum>
10041
10042	<enum
10043	name="DataFlags"
10044	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10045	>
10046	<const name="None" value="0x00"/>
10047	<const name="Mandatory" value="0x01"/>
10048	<const name="Expert" value="0x02"/>
10049	<const name="Array" value="0x04"/>
10050	<const name="FlagMask" value="0x07"/>
10051	</enum>
10052
10053	<enum
10054	name="MediumFormatCapabilities"
10055	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10056	>
10057	<desc>
10058	Medium format capability flags.
10059	</desc>
10060
10061	<const name="Uuid" value="0x01">
10062	<desc>
10063	Supports UUIDs as expected by VirtualBox code.
10064	</desc>
10065	</const>
10066
10067	<const name="CreateFixed" value="0x02">
10068	<desc>
10069	Supports creating fixed size images, allocating all space instantly.
10070	</desc>
10071	</const>
10072
10073	<const name="CreateDynamic" value="0x04">
10074	<desc>
10075	Supports creating dynamically growing images, allocating space on
10076	demand.
10077	</desc>
10078	</const>
10079
10080	<const name="CreateSplit2G" value="0x08">
10081	<desc>
10082	Supports creating images split in chunks of a bit less than 2 GBytes.
10083	</desc>
10084	</const>
10085
10086	<const name="Differencing" value="0x10">
10087	<desc>
10088	Supports being used as a format for differencing media (see <link
10089	to="IMedium::createDiffStorage"/>).
10090	</desc>
10091	</const>
10092
10093	<const name="Asynchronous" value="0x20">
10094	<desc>
10095	Supports asynchronous I/O operations for at least some configurations.
10096	</desc>
10097	</const>
10098
10099	<const name="File" value="0x40">
10100	<desc>
10101	The format backend operates on files (the <link to="IMedium::location"/>
10102	attribute of the medium specifies a file used to store medium
10103	data; for a list of supported file extensions see
10104	<link to="IMediumFormat::fileExtensions"/>).
10105	</desc>
10106	</const>
10107
10108	<const name="Properties" value="0x80">
10109	<desc>
10110	The format backend uses the property interface to configure the storage
10111	location and properties (the <link to="IMediumFormat::describeProperties"/>
10112	method is used to get access to properties supported by the given medium format).
10113	</desc>
10114	</const>
10115
10116	<const name="TcpNetworking" value="0x100">
10117	<desc>
10118	The format backend uses the TCP networking interface for network access.
10119	</desc>
10120	</const>
10121
10122	<const name="VFS" value="0x200">
10123	<desc>
10124	The format backend supports virtual filesystem functionality.
10125	</desc>
10126	</const>
10127
10128	<const name="CapabilityMask" value="0x3FF"/>
10129	</enum>
10130
10131	<interface
10132	name="IMediumFormat" extends="$unknown"
10133	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10134	wsmap="managed"
10135	>
10136	<desc>
10137	The IMediumFormat interface represents a medium format.
10138
10139	Each medium format has an associated backend which is used to handle
10140	media stored in this format. This interface provides information
10141	about the properties of the associated backend.
10142
10143	Each medium format is identified by a string represented by the
10144	<link to="#id"/> attribute. This string is used in calls like
10145	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10146	format.
10147
10148	The list of all supported medium formats can be obtained using
10149	<link to="ISystemProperties::mediumFormats"/>.
10150
10151	<see>IMedium</see>
10152	</desc>
10153
10154	<attribute name="id" type="wstring" readonly="yes">
10155	<desc>
10156	Identifier of this format.
10157
10158	The format identifier is a non-@c null non-empty ASCII string. Note that
10159	this string is case-insensitive. This means that, for example, all of
10160	the following strings:
10161	<pre>
10162	"VDI"
10163	"vdi"
10164	"VdI"</pre>
10165	refer to the same medium format.
10166
10167	This string is used in methods of other interfaces where it is necessary
10168	to specify a medium format, such as
10169	<link to="IVirtualBox::createHardDisk"/>.
10170	</desc>
10171	</attribute>
10172
10173	<attribute name="name" type="wstring" readonly="yes">
10174	<desc>
10175	Human readable description of this format.
10176
10177	Mainly for use in file open dialogs.
10178	</desc>
10179	</attribute>
10180
10181	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10182	<desc>
10183	Array of strings containing the supported file extensions.
10184
10185	The first extension in the array is the extension preferred by the
10186	backend. It is recommended to use this extension when specifying a
10187	location of the storage unit for a new medium.
10188
10189	Note that some backends do not work on files, so this array may be
10190	empty.
10191
10192	<see>IMediumFormat::capabilities</see>
10193	</desc>
10194	</attribute>
10195
10196	<attribute name="capabilities" type="unsigned long" readonly="yes">
10197	<desc>
10198	Capabilities of the format as a set of bit flags.
10199
10200	For the meaning of individual capability flags see
10201	<link to="MediumFormatCapabilities"/>.
10202	</desc>
10203	</attribute>
10204
10205	<method name="describeProperties">
10206	<desc>
10207	Returns several arrays describing the properties supported by this
10208	format.
10209
10210	An element with the given index in each array describes one
10211	property. Thus, the number of elements in each returned array is the
10212	same and corresponds to the number of supported properties.
10213
10214	The returned arrays are filled in only if the
10215	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10216	All arguments must be non-@c null.
10217
10218	<see>DataType</see>
10219	<see>DataFlags</see>
10220	</desc>
10221
10222	<param name="names" type="wstring" safearray="yes" dir="out">
10223	<desc>Array of property names.</desc>
10224	</param>
10225	<param name="description" type="wstring" safearray="yes" dir="out">
10226	<desc>Array of property descriptions.</desc>
10227	</param>
10228	<param name="types" type="DataType" safearray="yes" dir="out">
10229	<desc>Array of property types.</desc>
10230	</param>
10231	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10232	<desc>Array of property flags.</desc>
10233	</param>
10234	<param name="defaults" type="wstring" safearray="yes" dir="out">
10235	<desc>Array of default property values.</desc>
10236	</param>
10237	</method>
10238
10239	</interface>
10240
10241
10242	<!--
10243	// IKeyboard
10244	/////////////////////////////////////////////////////////////////////////
10245	-->
10246
10247	<interface
10248	name="IKeyboard" extends="$unknown"
10249	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10250	wsmap="managed"
10251	>
10252	<desc>
10253	The IKeyboard interface represents the virtual machine's keyboard. Used
10254	in <link to="IConsole::keyboard"/>.
10255
10256	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10257	to the virtual machine.
10258
10259	</desc>
10260	<method name="putScancode">
10261	<desc>Sends a scancode to the keyboard.
10262
10263	<result name="VBOX_E_IPRT_ERROR">
10264	Could not send scan code to virtual keyboard.
10265	</result>
10266
10267	</desc>
10268	<param name="scancode" type="long" dir="in"/>
10269	</method>
10270
10271	<method name="putScancodes">
10272	<desc>Sends an array of scancodes to the keyboard.
10273
10274	<result name="VBOX_E_IPRT_ERROR">
10275	Could not send all scan codes to virtual keyboard.
10276	</result>
10277
10278	</desc>
10279	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10280	<param name="codesStored" type="unsigned long" dir="return"/>
10281	</method>
10282
10283	<method name="putCAD">
10284	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10285	function is nothing special, it is just a convenience function
10286	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10287
10288	<result name="VBOX_E_IPRT_ERROR">
10289	Could not send all scan codes to virtual keyboard.
10290	</result>
10291
10292	</desc>
10293	</method>
10294
10295	</interface>
10296
10297
10298	<!--
10299	// IMouse
10300	/////////////////////////////////////////////////////////////////////////
10301	-->
10302
10303	<enum
10304	name="MouseButtonState"
10305	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10306	>
10307	<desc>
10308	Mouse button state.
10309	</desc>
10310
10311	<const name="LeftButton" value="0x01"/>
10312	<const name="RightButton" value="0x02"/>
10313	<const name="MiddleButton" value="0x04"/>
10314	<const name="WheelUp" value="0x08"/>
10315	<const name="WheelDown" value="0x10"/>
10316	<const name="XButton1" value="0x20"/>
10317	<const name="XButton2" value="0x40"/>
10318	<const name="MouseStateMask" value="0x7F"/>
10319	</enum>
10320
10321	<interface
10322	name="IMouse" extends="$unknown"
10323	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10324	wsmap="managed"
10325	>
10326	<desc>
10327	The IMouse interface represents the virtual machine's mouse. Used in
10328	<link to="IConsole::mouse"/>.
10329
10330	Through this interface, the virtual machine's virtual mouse can be
10331	controlled.
10332	</desc>
10333
10334	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10335	<desc>
10336	Whether the guest OS supports absolute mouse pointer positioning
10337	or not.
10338	<note>
10339	You can use the <link to="IMouseCapabilityChangedEvent"/>
10340	event to be instantly informed about changes of this attribute
10341	during virtual machine execution.
10342	</note>
10343	<see><link to="#putMouseEventAbsolute"/></see>
10344	</desc>
10345	</attribute>
10346
10347	<attribute name="relativeSupported" type="boolean" readonly="yes">
10348	<desc>
10349	Whether the guest OS supports relative mouse pointer positioning
10350	or not.
10351	<note>
10352	You can use the <link to="IMouseCapabilityChangedEvent"/>
10353	event to be instantly informed about changes of this attribute
10354	during virtual machine execution.
10355	</note>
10356	<see><link to="#putMouseEvent"/></see>
10357	</desc>
10358	</attribute>
10359
10360	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10361	<desc>
10362	Whether the guest OS can currently switch to drawing it's own mouse
10363	cursor on demand.
10364	<note>
10365	You can use the <link to="IMouseCapabilityChangedEvent"/>
10366	event to be instantly informed about changes of this attribute
10367	during virtual machine execution.
10368	</note>
10369	<see><link to="#putMouseEvent"/></see>
10370	</desc>
10371	</attribute>
10372
10373	<method name="putMouseEvent">
10374	<desc>
10375	Initiates a mouse event using relative pointer movements
10376	along x and y axis.
10377
10378	<result name="E_ACCESSDENIED">
10379	Console not powered up.
10380	</result>
10381	<result name="VBOX_E_IPRT_ERROR">
10382	Could not send mouse event to virtual mouse.
10383	</result>
10384
10385	</desc>
10386
10387	<param name="dx" type="long" dir="in">
10388	<desc>
10389	Amount of pixels the mouse should move to the right.
10390	Negative values move the mouse to the left.
10391	</desc>
10392	</param>
10393	<param name="dy" type="long" dir="in">
10394	<desc>
10395	Amount of pixels the mouse should move downwards.
10396	Negative values move the mouse upwards.
10397	</desc>
10398	</param>
10399	<param name="dz" type="long" dir="in">
10400	<desc>
10401	Amount of mouse wheel moves.
10402	Positive values describe clockwise wheel rotations,
10403	negative values describe counterclockwise rotations.
10404	</desc>
10405	</param>
10406	<param name="dw" type="long" dir="in">
10407	<desc>
10408	Amount of horizontal mouse wheel moves.
10409	Positive values describe a movement to the left,
10410	negative values describe a movement to the right.
10411	</desc>
10412	</param>
10413	<param name="buttonState" type="long" dir="in">
10414	<desc>
10415	The current state of mouse buttons. Every bit represents
10416	a mouse button as follows:
10417	<table>
10418	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10419	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10420	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10421	</table>
10422	A value of <tt>1</tt> means the corresponding button is pressed.
10423	otherwise it is released.
10424	</desc>
10425	</param>
10426	</method>
10427
10428	<method name="putMouseEventAbsolute">
10429	<desc>
10430	Positions the mouse pointer using absolute x and y coordinates.
10431	These coordinates are expressed in pixels and
10432	start from <tt>[1,1]</tt> which corresponds to the top left
10433	corner of the virtual display.
10434
10435	<result name="E_ACCESSDENIED">
10436	Console not powered up.
10437	</result>
10438	<result name="VBOX_E_IPRT_ERROR">
10439	Could not send mouse event to virtual mouse.
10440	</result>
10441
10442	<note>
10443	This method will have effect only if absolute mouse
10444	positioning is supported by the guest OS.
10445	</note>
10446
10447	<see><link to="#absoluteSupported"/></see>
10448	</desc>
10449
10450	<param name="x" type="long" dir="in">
10451	<desc>
10452	X coordinate of the pointer in pixels, starting from @c 1.
10453	</desc>
10454	</param>
10455	<param name="y" type="long" dir="in">
10456	<desc>
10457	Y coordinate of the pointer in pixels, starting from @c 1.
10458	</desc>
10459	</param>
10460	<param name="dz" type="long" dir="in">
10461	<desc>
10462	Amount of mouse wheel moves.
10463	Positive values describe clockwise wheel rotations,
10464	negative values describe counterclockwise rotations.
10465	</desc>
10466	</param>
10467	<param name="dw" type="long" dir="in">
10468	<desc>
10469	Amount of horizontal mouse wheel moves.
10470	Positive values describe a movement to the left,
10471	negative values describe a movement to the right.
10472	</desc>
10473	</param>
10474	<param name="buttonState" type="long" dir="in">
10475	<desc>
10476	The current state of mouse buttons. Every bit represents
10477	a mouse button as follows:
10478	<table>
10479	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10480	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10481	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10482	</table>
10483	A value of @c 1 means the corresponding button is pressed.
10484	otherwise it is released.
10485	</desc>
10486	</param>
10487	</method>
10488
10489	</interface>
10490
10491	<!--
10492	// IDisplay
10493	/////////////////////////////////////////////////////////////////////////
10494	-->
10495
10496	<enum
10497	name="FramebufferPixelFormat"
10498	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10499	>
10500	<desc>
10501	Format of the video memory buffer. Constants represented by this enum can
10502	be used to test for particular values of <link
10503	to="IFramebuffer::pixelFormat"/>. See also <link
10504	to="IFramebuffer::requestResize"/>.
10505
10506	See also www.fourcc.org for more information about FOURCC pixel formats.
10507	</desc>
10508
10509	<const name="Opaque" value="0">
10510	<desc>
10511	Unknown buffer format (the user may not assume any particular format of
10512	the buffer).
10513	</desc>
10514	</const>
10515	<const name="FOURCC_RGB" value="0x32424752">
10516	<desc>
10517	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10518	bit layout).
10519	</desc>
10520	</const>
10521	</enum>
10522
10523	<interface
10524	name="IFramebuffer" extends="$unknown"
10525	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10526	wsmap="suppress"
10527	>
10528	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10529	<desc>Address of the start byte of the frame buffer.</desc>
10530	</attribute>
10531
10532	<attribute name="width" type="unsigned long" readonly="yes">
10533	<desc>Frame buffer width, in pixels.</desc>
10534	</attribute>
10535
10536	<attribute name="height" type="unsigned long" readonly="yes">
10537	<desc>Frame buffer height, in pixels.</desc>
10538	</attribute>
10539
10540	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10541	<desc>
10542	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10543	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10544	are: 8, 15, 16, 24 and 32.
10545	</desc>
10546	</attribute>
10547
10548	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10549	<desc>
10550	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10551	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10552	size of the scan line must be aligned to 32 bits.
10553	</desc>
10554	</attribute>
10555
10556	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10557	<desc>
10558	Frame buffer pixel format. It's either one of the values defined by <link
10559	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10560	<note>
10561	This attribute must never return <link
10562	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10563	<link to="#address"/> points to must be always known.
10564	</note>
10565	</desc>
10566	</attribute>
10567
10568	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10569	<desc>
10570	Defines whether this frame buffer uses the virtual video card's memory
10571	buffer (guest VRAM) directly or not. See <link
10572	to="IFramebuffer::requestResize"/> for more information.
10573	</desc>
10574	</attribute>
10575
10576	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10577	<desc>
10578	Hint from the frame buffer about how much of the standard
10579	screen height it wants to use for itself. This information is
10580	exposed to the guest through the VESA BIOS and VMMDev interface
10581	so that it can use it for determining its video mode table. It
10582	is not guaranteed that the guest respects the value.
10583	</desc>
10584	</attribute>
10585
10586	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10587	<desc>
10588	An alpha-blended overlay which is superposed over the frame buffer.
10589	The initial purpose is to allow the display of icons providing
10590	information about the VM state, including disk activity, in front
10591	ends which do not have other means of doing that. The overlay is
10592	designed to controlled exclusively by IDisplay. It has no locking
10593	of its own, and any changes made to it are not guaranteed to be
10594	visible until the affected portion of IFramebuffer is updated. The
10595	overlay can be created lazily the first time it is requested. This
10596	attribute can also return @c null to signal that the overlay is not
10597	implemented.
10598	</desc>
10599	</attribute>
10600
10601	<attribute name="winId" type="long long" readonly="yes">
10602	<desc>
10603	Platform-dependent identifier of the window where context of this
10604	frame buffer is drawn, or zero if there's no such window.
10605	</desc>
10606	</attribute>
10607
10608	<method name="lock">
10609	<desc>
10610	Locks the frame buffer.
10611	Gets called by the IDisplay object where this frame buffer is
10612	bound to.
10613	</desc>
10614	</method>
10615
10616	<method name="unlock">
10617	<desc>
10618	Unlocks the frame buffer.
10619	Gets called by the IDisplay object where this frame buffer is
10620	bound to.
10621	</desc>
10622	</method>
10623
10624	<method name="notifyUpdate">
10625	<desc>
10626	Informs about an update.
10627	Gets called by the display object where this buffer is
10628	registered.
10629	</desc>
10630	<param name="x" type="unsigned long" dir="in"/>
10631	<param name="y" type="unsigned long" dir="in"/>
10632	<param name="width" type="unsigned long" dir="in"/>
10633	<param name="height" type="unsigned long" dir="in"/>
10634	</method>
10635
10636	<method name="requestResize">
10637	<desc>
10638	Requests a size and pixel format change.
10639
10640	There are two modes of working with the video buffer of the virtual
10641	machine. The <i>indirect</i> mode implies that the IFramebuffer
10642	implementation allocates a memory buffer for the requested display mode
10643	and provides it to the virtual machine. In <i>direct</i> mode, the
10644	IFramebuffer implementation uses the memory buffer allocated and owned
10645	by the virtual machine. This buffer represents the video memory of the
10646	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10647	usually faster because the implementation gets a raw pointer to the
10648	guest VRAM buffer which it can directly use for visualizing the contents
10649	of the virtual display, as opposed to the indirect mode where the
10650	contents of guest VRAM are copied to the memory buffer provided by
10651	the implementation every time a display update occurs.
10652
10653	It is important to note that the direct mode is really fast only when
10654	the implementation uses the given guest VRAM buffer directly, for
10655	example, by blitting it to the window representing the virtual machine's
10656	display, which saves at least one copy operation comparing to the
10657	indirect mode. However, using the guest VRAM buffer directly is not
10658	always possible: the format and the color depth of this buffer may be
10659	not supported by the target window, or it may be unknown (opaque) as in
10660	case of text or non-linear multi-plane VGA video modes. In this case,
10661	the indirect mode (that is always available) should be used as a
10662	fallback: when the guest VRAM contents are copied to the
10663	implementation-provided memory buffer, color and format conversion is
10664	done automatically by the underlying code.
10665
10666	The @a pixelFormat parameter defines whether the direct mode is
10667	available or not. If @a pixelFormat is <link
10668	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10669	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10670	@a bytesPerLine parameters must be ignored and the implementation must use
10671	the indirect mode (where it provides its own buffer in one of the
10672	supported formats). In all other cases, @a pixelFormat together with
10673	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10674	buffer pointed to by the @a VRAM parameter and the implementation is
10675	free to choose which mode to use. To indicate that this frame buffer uses
10676	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10677	attribute must return @c true and <link to="#address"/> must
10678	return exactly the same address that is passed in the @a VRAM parameter
10679	of this method; otherwise it is assumed that the indirect strategy is
10680	chosen.
10681
10682	The @a width and @a height parameters represent the size of the
10683	requested display mode in both modes. In case of indirect mode, the
10684	provided memory buffer should be big enough to store data of the given
10685	display mode. In case of direct mode, it is guaranteed that the given
10686	@a VRAM buffer contains enough space to represent the display mode of the
10687	given size. Note that this frame buffer's <link to="#width"/> and <link
10688	to="#height"/> attributes must return exactly the same values as
10689	passed to this method after the resize is completed (see below).
10690
10691	The @a finished output parameter determines if the implementation has
10692	finished resizing the frame buffer or not. If, for some reason, the
10693	resize cannot be finished immediately during this call, @a finished
10694	must be set to @c false, and the implementation must call
10695	<link to="IDisplay::resizeCompleted"/> after it has returned from
10696	this method as soon as possible. If @a finished is @c false, the
10697	machine will not call any frame buffer methods until
10698	<link to="IDisplay::resizeCompleted"/> is called.
10699
10700	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10701	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10702	this frame buffer must return exactly the same values as specified in the
10703	parameters of this method, after the resize is completed. If the
10704	indirect mode is chosen, these attributes must return values describing
10705	the format of the implementation's own memory buffer <link
10706	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10707	value must always correlate with <link to="#pixelFormat"/>. Note that
10708	the <link to="#pixelFormat"/> attribute must never return <link
10709	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10710
10711	<note>
10712	This method is called by the IDisplay object under the
10713	<link to="#lock"/> provided by this IFramebuffer
10714	implementation. If this method returns @c false in @a finished, then
10715	this lock is not released until
10716	<link to="IDisplay::resizeCompleted"/> is called.
10717	</note>
10718	</desc>
10719	<param name="screenId" type="unsigned long" dir="in">
10720	<desc>
10721	Logical screen number. Must be used in the corresponding call to
10722	<link to="IDisplay::resizeCompleted"/> if this call is made.
10723	</desc>
10724	</param>
10725	<param name="pixelFormat" type="unsigned long" dir="in">
10726	<desc>
10727	Pixel format of the memory buffer pointed to by @a VRAM.
10728	See also <link to="FramebufferPixelFormat"/>.
10729	</desc>
10730	</param>
10731	<param name="VRAM" type="octet" mod="ptr" dir="in">
10732	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10733	</param>
10734	<param name="bitsPerPixel" type="unsigned long" dir="in">
10735	<desc>Color depth, bits per pixel.</desc>
10736	</param>
10737	<param name="bytesPerLine" type="unsigned long" dir="in">
10738	<desc>Size of one scan line, in bytes.</desc>
10739	</param>
10740	<param name="width" type="unsigned long" dir="in">
10741	<desc>Width of the guest display, in pixels.</desc>
10742	</param>
10743	<param name="height" type="unsigned long" dir="in">
10744	<desc>Height of the guest display, in pixels.</desc>
10745	</param>
10746	<param name="finished" type="boolean" dir="return">
10747	<desc>
10748	Can the VM start using the new frame buffer immediately
10749	after this method returns or it should wait for
10750	<link to="IDisplay::resizeCompleted"/>.
10751	</desc>
10752	</param>
10753	</method>
10754
10755	<method name="videoModeSupported">
10756	<desc>
10757	Returns whether the frame buffer implementation is willing to
10758	support a given video mode. In case it is not able to render
10759	the video mode (or for some reason not willing), it should
10760	return @c false. Usually this method is called when the guest
10761	asks the VMM device whether a given video mode is supported
10762	so the information returned is directly exposed to the guest.
10763	It is important that this method returns very quickly.
10764	</desc>
10765	<param name="width" type="unsigned long" dir="in"/>
10766	<param name="height" type="unsigned long" dir="in"/>
10767	<param name="bpp" type="unsigned long" dir="in"/>
10768	<param name="supported" type="boolean" dir="return"/>
10769	</method>
10770
10771	<method name="getVisibleRegion">
10772	<desc>
10773	Returns the visible region of this frame buffer.
10774
10775	If the @a rectangles parameter is @c null then the value of the
10776	@a count parameter is ignored and the number of elements necessary to
10777	describe the current visible region is returned in @a countCopied.
10778
10779	If @a rectangles is not @c null but @a count is less
10780	than the required number of elements to store region data, the method
10781	will report a failure. If @a count is equal or greater than the
10782	required number of elements, then the actual number of elements copied
10783	to the provided array will be returned in @a countCopied.
10784
10785	<note>
10786	The address of the provided array must be in the process space of
10787	this IFramebuffer object.
10788	</note>
10789	<note>
10790	Method not yet implemented.
10791	</note>
10792	</desc>
10793	<param name="rectangles" type="octet" mod="ptr" dir="in">
10794	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10795	</param>
10796	<param name="count" type="unsigned long" dir="in">
10797	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10798	</param>
10799	<param name="countCopied" type="unsigned long" dir="return">
10800	<desc>Number of elements copied to the @a rectangles array.</desc>
10801	</param>
10802	</method>
10803
10804	<method name="setVisibleRegion">
10805	<desc>
10806	Suggests a new visible region to this frame buffer. This region
10807	represents the area of the VM display which is a union of regions of
10808	all top-level windows of the guest operating system running inside the
10809	VM (if the Guest Additions for this system support this
10810	functionality). This information may be used by the frontends to
10811	implement the seamless desktop integration feature.
10812
10813	<note>
10814	The address of the provided array must be in the process space of
10815	this IFramebuffer object.
10816	</note>
10817	<note>
10818	The IFramebuffer implementation must make a copy of the provided
10819	array of rectangles.
10820	</note>
10821	<note>
10822	Method not yet implemented.
10823	</note>
10824	</desc>
10825	<param name="rectangles" type="octet" mod="ptr" dir="in">
10826	<desc>Pointer to the @c RTRECT array.</desc>
10827	</param>
10828	<param name="count" type="unsigned long" dir="in">
10829	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10830	</param>
10831	</method>
10832
10833	<method name="processVHWACommand">
10834	<desc>
10835	Posts a Video HW Acceleration Command to the frame buffer for processing.
10836	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10837	are posted from quest to the host to be processed by the host hardware.
10838
10839	<note>
10840	The address of the provided command must be in the process space of
10841	this IFramebuffer object.
10842	</note>
10843	</desc>
10844
10845	<param name="command" type="octet" mod="ptr" dir="in">
10846	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10847	</param>
10848	</method>
10849
10850	</interface>
10851
10852	<interface
10853	name="IFramebufferOverlay" extends="IFramebuffer"
10854	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10855	wsmap="suppress"
10856	>
10857	<desc>
10858	The IFramebufferOverlay interface represents an alpha blended overlay
10859	for displaying status icons above an IFramebuffer. It is always created
10860	not visible, so that it must be explicitly shown. It only covers a
10861	portion of the IFramebuffer, determined by its width, height and
10862	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10863	that order) format, and may be written to directly. Do re-read the
10864	width though, after setting it, as it may be adjusted (increased) to
10865	make it more suitable for the front end.
10866	</desc>
10867	<attribute name="x" type="unsigned long" readonly="yes">
10868	<desc>X position of the overlay, relative to the frame buffer.</desc>
10869	</attribute>
10870
10871	<attribute name="y" type="unsigned long" readonly="yes">
10872	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10873	</attribute>
10874
10875	<attribute name="visible" type="boolean" readonly="no">
10876	<desc>
10877	Whether the overlay is currently visible.
10878	</desc>
10879	</attribute>
10880
10881	<attribute name="alpha" type="unsigned long" readonly="no">
10882	<desc>
10883	The global alpha value for the overlay. This may or may not be
10884	supported by a given front end.
10885	</desc>
10886	</attribute>
10887
10888	<method name="move">
10889	<desc>
10890	Changes the overlay's position relative to the IFramebuffer.
10891	</desc>
10892	<param name="x" type="unsigned long" dir="in"/>
10893	<param name="y" type="unsigned long" dir="in"/>
10894	</method>
10895
10896	</interface>
10897
10898	<interface
10899	name="IDisplay" extends="$unknown"
10900	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
10901	wsmap="managed"
10902	>
10903	<desc>
10904	The IDisplay interface represents the virtual machine's display.
10905
10906	The object implementing this interface is contained in each
10907	<link to="IConsole::display"/> attribute and represents the visual
10908	output of the virtual machine.
10909
10910	The virtual display supports pluggable output targets represented by the
10911	IFramebuffer interface. Examples of the output target are a window on
10912	the host computer or an RDP session's display on a remote computer.
10913	</desc>
10914	<method name="getScreenResolution">
10915	<desc>Queries display width, height and color depth for given screen.</desc>
10916	<param name="screenId" type="unsigned long" dir="in"/>
10917	<param name="width" type="unsigned long" dir="out"/>
10918	<param name="height" type="unsigned long" dir="out"/>
10919	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10920	</method>
10921
10922	<method name="setFramebuffer">
10923	<desc>
10924	Sets the framebuffer for given screen.
10925	</desc>
10926	<param name="screenId" type="unsigned long" dir="in"/>
10927	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10928	</method>
10929
10930	<method name="getFramebuffer">
10931	<desc>
10932	Queries the framebuffer for given screen.
10933	</desc>
10934	<param name="screenId" type="unsigned long" dir="in"/>
10935	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10936	<param name="xOrigin" type="long" dir="out"/>
10937	<param name="yOrigin" type="long" dir="out"/>
10938	</method>
10939
10940	<method name="setVideoModeHint">
10941	<desc>
10942	Asks VirtualBox to request the given video mode from
10943	the guest. This is just a hint and it cannot be guaranteed
10944	that the requested resolution will be used. Guest Additions
10945	are required for the request to be seen by guests. The caller
10946	should issue the request and wait for a resolution change and
10947	after a timeout retry.
10948
10949	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10950	parameters means that the corresponding values should be taken from the
10951	current video mode (i.e. left unchanged).
10952
10953	If the guest OS supports multi-monitor configuration then the @a display
10954	parameter specifies the number of the guest display to send the hint to:
10955	@c 0 is the primary display, @c 1 is the first secondary and
10956	so on. If the multi-monitor configuration is not supported, @a display
10957	must be @c 0.
10958
10959	<result name="E_INVALIDARG">
10960	The @a display is not associated with any monitor.
10961	</result>
10962
10963	</desc>
10964	<param name="width" type="unsigned long" dir="in"/>
10965	<param name="height" type="unsigned long" dir="in"/>
10966	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10967	<param name="display" type="unsigned long" dir="in"/>
10968	</method>
10969
10970	<method name="setSeamlessMode">
10971	<desc>
10972	Enables or disables seamless guest display rendering (seamless desktop
10973	integration) mode.
10974	<note>
10975	Calling this method has no effect if <link
10976	to="IGuest::supportsSeamless"/> returns @c false.
10977	</note>
10978	</desc>
10979	<param name="enabled" type="boolean" dir="in"/>
10980	</method>
10981
10982	<method name="takeScreenShot">
10983	<desc>
10984	Takes a screen shot of the requested size and copies it to the
10985	32-bpp buffer allocated by the caller and pointed to by @a address.
10986	A pixel consists of 4 bytes in order: B, G, R, 0.
10987
10988	<note>This API can be used only by the COM/XPCOM C++ API as it
10989	requires pointer support. Use <link to="#takeScreenShotToArray" />
10990	with other language bindings.
10991	</note>
10992
10993	<result name="E_NOTIMPL">
10994	Feature not implemented.
10995	</result>
10996	<result name="VBOX_E_IPRT_ERROR">
10997	Could not take a screenshot.
10998	</result>
10999
11000	</desc>
11001	<param name="screenId" type="unsigned long" dir="in"/>
11002	<param name="address" type="octet" mod="ptr" dir="in"/>
11003	<param name="width" type="unsigned long" dir="in"/>
11004	<param name="height" type="unsigned long" dir="in"/>
11005	</method>
11006
11007	<method name="takeScreenShotToArray">
11008	<desc>
11009	Takes a guest screen shot of the requested size and returns it as
11010	an array of bytes in uncompressed 32-bit RGBA format.
11011	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11012
11013	This API is slow, but could be the only option to get guest screenshot
11014	for scriptable languages not allowed to manipulate with addresses
11015	directly.
11016
11017	<result name="E_NOTIMPL">
11018	Feature not implemented.
11019	</result>
11020	<result name="VBOX_E_IPRT_ERROR">
11021	Could not take a screenshot.
11022	</result>
11023	</desc>
11024	<param name="screenId" type="unsigned long" dir="in">
11025	<desc>
11026	Monitor to take screenshot from.
11027	</desc>
11028	</param>
11029	<param name="width" type="unsigned long" dir="in">
11030	<desc>
11031	Desired image width.
11032	</desc>
11033	</param>
11034	<param name="height" type="unsigned long" dir="in">
11035	<desc>
11036	Desired image height.
11037	</desc>
11038	</param>
11039	<param name="screenData" type="octet" dir="return" safearray="yes">
11040	<desc>
11041	Array with resulting screen data.
11042	</desc>
11043	</param>
11044	</method>
11045
11046	<method name="takeScreenShotPNGToArray">
11047	<desc>
11048	Takes a guest screen shot of the requested size and returns it as
11049	PNG image in array.
11050
11051	<result name="E_NOTIMPL">
11052	Feature not implemented.
11053	</result>
11054	<result name="VBOX_E_IPRT_ERROR">
11055	Could not take a screenshot.
11056	</result>
11057	</desc>
11058	<param name="screenId" type="unsigned long" dir="in">
11059	<desc>
11060	Monitor to take the screenshot from.
11061	</desc>
11062	</param>
11063	<param name="width" type="unsigned long" dir="in">
11064	<desc>
11065	Desired image width.
11066	</desc>
11067	</param>
11068	<param name="height" type="unsigned long" dir="in">
11069	<desc>
11070	Desired image height.
11071	</desc>
11072	</param>
11073	<param name="screenData" type="octet" dir="return" safearray="yes">
11074	<desc>
11075	Array with resulting screen data.
11076	</desc>
11077	</param>
11078	</method>
11079
11080	<method name="drawToScreen">
11081	<desc>
11082	Draws a 32-bpp image of the specified size from the given buffer
11083	to the given point on the VM display.
11084
11085	<result name="E_NOTIMPL">
11086	Feature not implemented.
11087	</result>
11088	<result name="VBOX_E_IPRT_ERROR">
11089	Could not draw to screen.
11090	</result>
11091
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="address" type="octet" mod="ptr" dir="in">
11099	<desc>
11100	Address to store the screenshot to
11101	</desc>
11102	</param>
11103	<param name="x" type="unsigned long" dir="in">
11104	<desc>
11105	Relative to the screen top left corner.
11106	</desc>
11107	</param>
11108	<param name="y" type="unsigned long" dir="in">
11109	<desc>
11110	Relative to the screen top left corner.
11111	</desc>
11112	</param>
11113	<param name="width" type="unsigned long" dir="in">
11114	<desc>
11115	Desired image width.
11116	</desc>
11117	</param>
11118	<param name="height" type="unsigned long" dir="in">
11119	<desc>
11120	Desired image height.
11121	</desc>
11122	</param>
11123	</method>
11124
11125	<method name="invalidateAndUpdate">
11126	<desc>
11127	Does a full invalidation of the VM display and instructs the VM
11128	to update it.
11129
11130	<result name="VBOX_E_IPRT_ERROR">
11131	Could not invalidate and update screen.
11132	</result>
11133
11134	</desc>
11135	</method>
11136
11137	<method name="resizeCompleted">
11138	<desc>
11139	Signals that a framebuffer has completed the resize operation.
11140
11141	<result name="VBOX_E_NOT_SUPPORTED">
11142	Operation only valid for external frame buffers.
11143	</result>
11144
11145	</desc>
11146	<param name="screenId" type="unsigned long" dir="in"/>
11147	</method>
11148
11149	<method name="completeVHWACommand">
11150	<desc>
11151	Signals that the Video HW Acceleration command has completed.
11152	</desc>
11153
11154	<param name="command" type="octet" mod="ptr" dir="in">
11155	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11156	</param>
11157	</method>
11158
11159	</interface>
11160
11161	<!--
11162	// INetworkAdapter
11163	/////////////////////////////////////////////////////////////////////////
11164	-->
11165
11166	<enum
11167	name="NetworkAttachmentType"
11168	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11169	>
11170	<desc>
11171	Network attachment type.
11172	</desc>
11173
11174	<const name="Null" value="0">
11175	<desc>Null value, also means "not attached".</desc>
11176	</const>
11177	<const name="NAT" value="1"/>
11178	<const name="Bridged" value="2"/>
11179	<const name="Internal" value="3"/>
11180	<const name="HostOnly" value="4"/>
11181	<const name="VDE" value="5"/>
11182	</enum>
11183
11184	<enum
11185	name="NetworkAdapterType"
11186	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11187	>
11188	<desc>
11189	Network adapter type.
11190	</desc>
11191
11192	<const name="Null" value="0">
11193	<desc>Null value (never used by the API).</desc>
11194	</const>
11195	<const name="Am79C970A" value="1">
11196	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11197	</const>
11198	<const name="Am79C973" value="2">
11199	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11200	</const>
11201	<const name="I82540EM" value="3">
11202	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11203	</const>
11204	<const name="I82543GC" value="4">
11205	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11206	</const>
11207	<const name="I82545EM" value="5">
11208	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11209	</const>
11210	<const name="Virtio" value="6">
11211	<desc>Virtio network device.</desc>
11212	</const>
11213	</enum>
11214
11215	<interface
11216	name="INetworkAdapter" extends="$unknown"
11217	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11218	wsmap="managed"
11219	>
11220	<desc>
11221	Represents a virtual network adapter that is attached to a virtual machine.
11222	Each virtual machine has a fixed number of network adapter slots with one
11223	instance of this attached to each of them. Call
11224	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11225	is attached to a given slot in a given machine.
11226
11227	Each network adapter can be in one of five attachment modes, which are
11228	represented by the <link to="NetworkAttachmentType" /> enumeration;
11229	see the <link to="#attachmentType" /> attribute.
11230	</desc>
11231
11232	<attribute name="adapterType" type="NetworkAdapterType">
11233	<desc>
11234	Type of the virtual network adapter. Depending on this value,
11235	VirtualBox will provide a different virtual network hardware
11236	to the guest.
11237	</desc>
11238	</attribute>
11239
11240	<attribute name="slot" type="unsigned long" readonly="yes">
11241	<desc>
11242	Slot number this adapter is plugged into. Corresponds to
11243	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11244	to obtain this instance.
11245	</desc>
11246	</attribute>
11247
11248	<attribute name="enabled" type="boolean">
11249	<desc>
11250	Flag whether the network adapter is present in the
11251	guest system. If disabled, the virtual guest hardware will
11252	not contain this network adapter. Can only be changed when
11253	the VM is not running.
11254	</desc>
11255	</attribute>
11256
11257	<attribute name="MACAddress" type="wstring">
11258	<desc>
11259	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11260	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11261	</desc>
11262	</attribute>
11263
11264	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11265
11266	<attribute name="hostInterface" type="wstring">
11267	<desc>
11268	Name of the host network interface the VM is attached to.
11269	</desc>
11270	</attribute>
11271
11272	<attribute name="internalNetwork" type="wstring">
11273	<desc>
11274	Name of the internal network the VM is attached to.
11275	</desc>
11276	</attribute>
11277
11278	<attribute name="NATNetwork" type="wstring">
11279	<desc>
11280	Name of the NAT network the VM is attached to.
11281	</desc>
11282	</attribute>
11283
11284	<attribute name="VDENetwork" type="wstring">
11285	<desc>
11286	Name of the VDE switch the VM is attached to.
11287	</desc>
11288	</attribute>
11289
11290	<attribute name="cableConnected" type="boolean">
11291	<desc>
11292	Flag whether the adapter reports the cable as connected or not.
11293	It can be used to report offline situations to a VM.
11294	</desc>
11295	</attribute>
11296
11297	<attribute name="lineSpeed" type="unsigned long">
11298	<desc>
11299	Line speed reported by custom drivers, in units of 1 kbps.
11300	</desc>
11301	</attribute>
11302
11303	<attribute name="traceEnabled" type="boolean">
11304	<desc>
11305	Flag whether network traffic from/to the network card should be traced.
11306	Can only be toggled when the VM is turned off.
11307	</desc>
11308	</attribute>
11309
11310	<attribute name="traceFile" type="wstring">
11311	<desc>
11312	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11313	will be used.
11314	</desc>
11315	</attribute>
11316
11317	<attribute name="natDriver" type="INATEngine" readonly="yes">
11318	<desc>
11319	Points to the NAT engine which handles the network address translation
11320	for this interface. This is active only when the interface actually uses
11321	NAT (see <link to="#attachToNAT" />).
11322	</desc>
11323	</attribute>
11324
11325	<attribute name="bootPriority" type="unsigned long">
11326	<desc>
11327	Network boot priority of the adapter. Priority 1 is highest. If not set,
11328	the priority is considered to be at the lowest possible setting.
11329	</desc>
11330	</attribute>
11331
11332	<attribute name="bandwidthLimit" type="unsigned long">
11333	<desc>
11334	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11335	A zero value means uncapped/unlimited.
11336	</desc>
11337	</attribute>
11338
11339	<method name="attachToNAT">
11340	<desc>
11341	Attach the network adapter to the Network Address Translation (NAT) interface.
11342	</desc>
11343	</method>
11344
11345	<method name="attachToBridgedInterface">
11346	<desc>
11347	Attach the network adapter to a bridged host interface.
11348	</desc>
11349	</method>
11350
11351	<method name="attachToInternalNetwork">
11352	<desc>
11353	Attach the network adapter to an internal network.
11354	</desc>
11355	</method>
11356
11357	<method name="attachToHostOnlyInterface">
11358	<desc>
11359	Attach the network adapter to the host-only network.
11360	</desc>
11361	</method>
11362
11363	<method name="attachToVDE">
11364	<desc>
11365	Attach the network adapter to a VDE network.
11366	</desc>
11367	</method>
11368
11369	<method name="detach">
11370	<desc>
11371	Detach the network adapter
11372	</desc>
11373	</method>
11374	</interface>
11375
11376
11377	<!--
11378	// ISerialPort
11379	/////////////////////////////////////////////////////////////////////////
11380	-->
11381
11382	<enum
11383	name="PortMode"
11384	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11385	>
11386	<desc>
11387	The PortMode enumeration represents possible communication modes for
11388	the virtual serial port device.
11389	</desc>
11390
11391	<const name="Disconnected" value="0">
11392	<desc>Virtual device is not attached to any real host device.</desc>
11393	</const>
11394	<const name="HostPipe" value="1">
11395	<desc>Virtual device is attached to a host pipe.</desc>
11396	</const>
11397	<const name="HostDevice" value="2">
11398	<desc>Virtual device is attached to a host device.</desc>
11399	</const>
11400	<const name="RawFile" value="3">
11401	<desc>Virtual device is attached to a raw file.</desc>
11402	</const>
11403	</enum>
11404
11405	<interface
11406	name="ISerialPort" extends="$unknown"
11407	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11408	wsmap="managed"
11409	>
11410
11411	<desc>
11412	The ISerialPort interface represents the virtual serial port device.
11413
11414	The virtual serial port device acts like an ordinary serial port
11415	inside the virtual machine. This device communicates to the real
11416	serial port hardware in one of two modes: host pipe or host device.
11417
11418	In host pipe mode, the #path attribute specifies the path to the pipe on
11419	the host computer that represents a serial port. The #server attribute
11420	determines if this pipe is created by the virtual machine process at
11421	machine startup or it must already exist before starting machine
11422	execution.
11423
11424	In host device mode, the #path attribute specifies the name of the
11425	serial port device on the host computer.
11426
11427	There is also a third communication mode: the disconnected mode. In this
11428	mode, the guest OS running inside the virtual machine will be able to
11429	detect the serial port, but all port write operations will be discarded
11430	and all port read operations will return no data.
11431
11432	<see>IMachine::getSerialPort</see>
11433	</desc>
11434
11435	<attribute name="slot" type="unsigned long" readonly="yes">
11436	<desc>
11437	Slot number this serial port is plugged into. Corresponds to
11438	the value you pass to <link to="IMachine::getSerialPort"/>
11439	to obtain this instance.
11440	</desc>
11441	</attribute>
11442
11443	<attribute name="enabled" type="boolean">
11444	<desc>
11445	Flag whether the serial port is enabled. If disabled,
11446	the serial port will not be reported to the guest OS.
11447	</desc>
11448	</attribute>
11449
11450	<attribute name="IOBase" type="unsigned long">
11451	<desc>Base I/O address of the serial port.</desc>
11452	</attribute>
11453
11454	<attribute name="IRQ" type="unsigned long">
11455	<desc>IRQ number of the serial port.</desc>
11456	</attribute>
11457
11458	<attribute name="hostMode" type="PortMode">
11459	<desc>
11460	How is this port connected to the host.
11461	<note>
11462	Changing this attribute may fail if the conditions for
11463	<link to="#path"/> are not met.
11464	</note>
11465	</desc>
11466	</attribute>
11467
11468	<attribute name="server" type="boolean">
11469	<desc>
11470	Flag whether this serial port acts as a server (creates a new pipe on
11471	the host) or as a client (uses the existing pipe). This attribute is
11472	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11473	</desc>
11474	</attribute>
11475
11476	<attribute name="path" type="wstring">
11477	<desc>
11478	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11479	PortMode_HostPipe, or the host serial device name when
11480	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11481	cases, setting a @c null or empty string as the attribute's value
11482	is an error. Otherwise, the value of this property is ignored.
11483	</desc>
11484	</attribute>
11485
11486	</interface>
11487
11488	<!--
11489	// IParallelPort
11490	/////////////////////////////////////////////////////////////////////////
11491	-->
11492
11493	<interface
11494	name="IParallelPort" extends="$unknown"
11495	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11496	wsmap="managed"
11497	>
11498
11499	<desc>
11500	The IParallelPort interface represents the virtual parallel port device.
11501
11502	The virtual parallel port device acts like an ordinary parallel port
11503	inside the virtual machine. This device communicates to the real
11504	parallel port hardware using the name of the parallel device on the host
11505	computer specified in the #path attribute.
11506
11507	Each virtual parallel port device is assigned a base I/O address and an
11508	IRQ number that will be reported to the guest operating system and used
11509	to operate the given parallel port from within the virtual machine.
11510
11511	<see>IMachine::getParallelPort</see>
11512	</desc>
11513
11514	<attribute name="slot" type="unsigned long" readonly="yes">
11515	<desc>
11516	Slot number this parallel port is plugged into. Corresponds to
11517	the value you pass to <link to="IMachine::getParallelPort"/>
11518	to obtain this instance.
11519	</desc>
11520	</attribute>
11521
11522	<attribute name="enabled" type="boolean">
11523	<desc>
11524	Flag whether the parallel port is enabled. If disabled,
11525	the parallel port will not be reported to the guest OS.
11526	</desc>
11527	</attribute>
11528
11529	<attribute name="IOBase" type="unsigned long">
11530	<desc>Base I/O address of the parallel port.</desc>
11531	</attribute>
11532
11533	<attribute name="IRQ" type="unsigned long">
11534	<desc>IRQ number of the parallel port.</desc>
11535	</attribute>
11536
11537	<attribute name="path" type="wstring">
11538	<desc>
11539	Host parallel device name. If this parallel port is enabled, setting a
11540	@c null or an empty string as this attribute's value will result into
11541	an error.
11542	</desc>
11543	</attribute>
11544
11545	</interface>
11546
11547
11548	<!--
11549	// IMachineDebugger
11550	/////////////////////////////////////////////////////////////////////////
11551	-->
11552
11553	<interface
11554	name="IMachineDebugger" extends="$unknown"
11555	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11556	wsmap="suppress"
11557	>
11558	<method name="resetStats">
11559	<desc>
11560	Reset VM statistics.
11561	</desc>
11562	<param name="pattern" type="wstring" dir="in">
11563	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11564	</param>
11565	</method>
11566
11567	<method name="dumpStats">
11568	<desc>
11569	Dumps VM statistics.
11570	</desc>
11571	<param name="pattern" type="wstring" dir="in">
11572	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11573	</param>
11574	</method>
11575
11576	<method name="getStats">
11577	<desc>
11578	Get the VM statistics in a XMLish format.
11579	</desc>
11580	<param name="pattern" type="wstring" dir="in">
11581	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11582	</param>
11583	<param name="withDescriptions" type="boolean" dir="in">
11584	<desc>Whether to include the descriptions.</desc>
11585	</param>
11586	<param name="stats" type="wstring" dir="out">
11587	<desc>The XML document containing the statistics.</desc>
11588	</param>
11589	</method>
11590
11591	<method name="injectNMI">
11592	<desc>
11593	Inject an NMI into a running VT-x/AMD-V VM.
11594	</desc>
11595	</method>
11596
11597	<attribute name="singlestep" type="boolean">
11598	<desc>Switch for enabling singlestepping.</desc>
11599	</attribute>
11600
11601	<attribute name="recompileUser" type="boolean">
11602	<desc>Switch for forcing code recompilation for user mode code.</desc>
11603	</attribute>
11604
11605	<attribute name="recompileSupervisor" type="boolean">
11606	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11607	</attribute>
11608
11609	<attribute name="PATMEnabled" type="boolean">
11610	<desc>Switch for enabling and disabling the PATM component.</desc>
11611	</attribute>
11612
11613	<attribute name="CSAMEnabled" type="boolean">
11614	<desc>Switch for enabling and disabling the CSAM component.</desc>
11615	</attribute>
11616
11617	<attribute name="logEnabled" type="boolean">
11618	<desc>Switch for enabling and disabling logging.</desc>
11619	</attribute>
11620
11621	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11622	<desc>
11623	Flag indicating whether the VM is currently making use of CPU hardware
11624	virtualization extensions.
11625	</desc>
11626	</attribute>
11627
11628	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11629	<desc>
11630	Flag indicating whether the VM is currently making use of the nested paging
11631	CPU hardware virtualization extension.
11632	</desc>
11633	</attribute>
11634
11635	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11636	<desc>
11637	Flag indicating whether the VM is currently making use of the VPID
11638	VT-x extension.
11639	</desc>
11640	</attribute>
11641
11642	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11643	<desc>
11644	Flag indicating whether the VM is currently making use of the Physical
11645	Address Extension CPU feature.
11646	</desc>
11647	</attribute>
11648
11649	<attribute name="virtualTimeRate" type="unsigned long">
11650	<desc>
11651	The rate at which the virtual time runs expressed as a percentage.
11652	The accepted range is 2% to 20000%.
11653	</desc>
11654	</attribute>
11655
11656	<!-- @todo method for setting log flags, groups and destination! -->
11657
11658	<attribute name="VM" type="long long" readonly="yes">
11659	<desc>
11660	Gets the VM handle. This is only for internal use while
11661	we carve the details of this interface.
11662	</desc>
11663	</attribute>
11664
11665	</interface>
11666
11667	<!--
11668	// IUSBController
11669	/////////////////////////////////////////////////////////////////////////
11670	-->
11671
11672	<interface
11673	name="IUSBController" extends="$unknown"
11674	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11675	wsmap="managed"
11676	>
11677	<attribute name="enabled" type="boolean">
11678	<desc>
11679	Flag whether the USB controller is present in the
11680	guest system. If disabled, the virtual guest hardware will
11681	not contain any USB controller. Can only be changed when
11682	the VM is powered off.
11683	</desc>
11684	</attribute>
11685
11686	<attribute name="enabledEhci" type="boolean">
11687	<desc>
11688	Flag whether the USB EHCI controller is present in the
11689	guest system. If disabled, the virtual guest hardware will
11690	not contain a USB EHCI controller. Can only be changed when
11691	the VM is powered off.
11692	</desc>
11693	</attribute>
11694
11695	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11696	<desc>
11697	Flag whether there is an USB proxy available.
11698	</desc>
11699	</attribute>
11700
11701	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11702	<desc>
11703	USB standard version which the controller implements.
11704	This is a BCD which means that the major version is in the
11705	high byte and minor version is in the low byte.
11706	</desc>
11707	</attribute>
11708
11709	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11710	<desc>
11711	List of USB device filters associated with the machine.
11712
11713	If the machine is currently running, these filters are activated
11714	every time a new (supported) USB device is attached to the host
11715	computer that was not ignored by global filters
11716	(<link to="IHost::USBDeviceFilters"/>).
11717
11718	These filters are also activated when the machine is powered up.
11719	They are run against a list of all currently available USB
11720	devices (in states
11721	<link to="USBDeviceState_Available"/>,
11722	<link to="USBDeviceState_Busy"/>,
11723	<link to="USBDeviceState_Held"/>) that were not previously
11724	ignored by global filters.
11725
11726	If at least one filter matches the USB device in question, this
11727	device is automatically captured (attached to) the virtual USB
11728	controller of this machine.
11729
11730	<see>IUSBDeviceFilter, ::IUSBController</see>
11731	</desc>
11732	</attribute>
11733
11734	<method name="createDeviceFilter">
11735	<desc>
11736	Creates a new USB device filter. All attributes except
11737	the filter name are set to empty (any match),
11738	<i>active</i> is @c false (the filter is not active).
11739
11740	The created filter can then be added to the list of filters using
11741	<link to="#insertDeviceFilter"/>.
11742
11743	<result name="VBOX_E_INVALID_VM_STATE">
11744	The virtual machine is not mutable.
11745	</result>
11746
11747	<see>#deviceFilters</see>
11748	</desc>
11749	<param name="name" type="wstring" dir="in">
11750	<desc>
11751	Filter name. See <link to="IUSBDeviceFilter::name"/>
11752	for more info.
11753	</desc>
11754	</param>
11755	<param name="filter" type="IUSBDeviceFilter" dir="return">
11756	<desc>Created filter object.</desc>
11757	</param>
11758	</method>
11759
11760	<method name="insertDeviceFilter">
11761	<desc>
11762	Inserts the given USB device to the specified position
11763	in the list of filters.
11764
11765	Positions are numbered starting from <tt>0</tt>. If the specified
11766	position is equal to or greater than the number of elements in
11767	the list, the filter is added to the end of the collection.
11768
11769	<note>
11770	Duplicates are not allowed, so an attempt to insert a
11771	filter that is already in the collection, will return an
11772	error.
11773	</note>
11774
11775	<result name="VBOX_E_INVALID_VM_STATE">
11776	Virtual machine is not mutable.
11777	</result>
11778	<result name="E_INVALIDARG">
11779	USB device filter not created within this VirtualBox instance.
11780	</result>
11781	<result name="VBOX_E_INVALID_OBJECT_STATE">
11782	USB device filter already in list.
11783	</result>
11784
11785	<see>#deviceFilters</see>
11786	</desc>
11787	<param name="position" type="unsigned long" dir="in">
11788	<desc>Position to insert the filter to.</desc>
11789	</param>
11790	<param name="filter" type="IUSBDeviceFilter" dir="in">
11791	<desc>USB device filter to insert.</desc>
11792	</param>
11793	</method>
11794
11795	<method name="removeDeviceFilter">
11796	<desc>
11797	Removes a USB device filter from the specified position in the
11798	list of filters.
11799
11800	Positions are numbered starting from <tt>0</tt>. Specifying a
11801	position equal to or greater than the number of elements in
11802	the list will produce an error.
11803
11804	<see>#deviceFilters</see>
11805
11806	<result name="VBOX_E_INVALID_VM_STATE">
11807	Virtual machine is not mutable.
11808	</result>
11809	<result name="E_INVALIDARG">
11810	USB device filter list empty or invalid @a position.
11811	</result>
11812
11813	</desc>
11814	<param name="position" type="unsigned long" dir="in">
11815	<desc>Position to remove the filter from.</desc>
11816	</param>
11817	<param name="filter" type="IUSBDeviceFilter" dir="return">
11818	<desc>Removed USB device filter.</desc>
11819	</param>
11820	</method>
11821
11822	</interface>
11823
11824
11825	<!--
11826	// IUSBDevice
11827	/////////////////////////////////////////////////////////////////////////
11828	-->
11829
11830	<interface
11831	name="IUSBDevice" extends="$unknown"
11832	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11833	wsmap="managed"
11834	>
11835	<desc>
11836	The IUSBDevice interface represents a virtual USB device attached to the
11837	virtual machine.
11838
11839	A collection of objects implementing this interface is stored in the
11840	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11841	attached to a running virtual machine's USB controller.
11842	</desc>
11843
11844	<attribute name="id" type="uuid" mod="string" readonly="yes">
11845	<desc>
11846	Unique USB device ID. This ID is built from #vendorId,
11847	#productId, #revision and #serialNumber.
11848	</desc>
11849	</attribute>
11850
11851	<attribute name="vendorId" type="unsigned short" readonly="yes">
11852	<desc>Vendor ID.</desc>
11853	</attribute>
11854
11855	<attribute name="productId" type="unsigned short" readonly="yes">
11856	<desc>Product ID.</desc>
11857	</attribute>
11858
11859	<attribute name="revision" type="unsigned short" readonly="yes">
11860	<desc>
11861	Product revision number. This is a packed BCD represented as
11862	unsigned short. The high byte is the integer part and the low
11863	byte is the decimal.
11864	</desc>
11865	</attribute>
11866
11867	<attribute name="manufacturer" type="wstring" readonly="yes">
11868	<desc>Manufacturer string.</desc>
11869	</attribute>
11870
11871	<attribute name="product" type="wstring" readonly="yes">
11872	<desc>Product string.</desc>
11873	</attribute>
11874
11875	<attribute name="serialNumber" type="wstring" readonly="yes">
11876	<desc>Serial number string.</desc>
11877	</attribute>
11878
11879	<attribute name="address" type="wstring" readonly="yes">
11880	<desc>Host specific address of the device.</desc>
11881	</attribute>
11882
11883	<attribute name="port" type="unsigned short" readonly="yes">
11884	<desc>
11885	Host USB port number the device is physically
11886	connected to.
11887	</desc>
11888	</attribute>
11889
11890	<attribute name="version" type="unsigned short" readonly="yes">
11891	<desc>
11892	The major USB version of the device - 1 or 2.
11893	</desc>
11894	</attribute>
11895
11896	<attribute name="portVersion" type="unsigned short" readonly="yes">
11897	<desc>
11898	The major USB version of the host USB port the device is
11899	physically connected to - 1 or 2. For devices not connected to
11900	anything this will have the same value as the version attribute.
11901	</desc>
11902	</attribute>
11903
11904	<attribute name="remote" type="boolean" readonly="yes">
11905	<desc>
11906	Whether the device is physically connected to a remote VRDP
11907	client or to a local host machine.
11908	</desc>
11909	</attribute>
11910
11911	</interface>
11912
11913
11914	<!--
11915	// IUSBDeviceFilter
11916	/////////////////////////////////////////////////////////////////////////
11917	-->
11918
11919	<interface
11920	name="IUSBDeviceFilter" extends="$unknown"
11921	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11922	wsmap="managed"
11923	>
11924	<desc>
11925	The IUSBDeviceFilter interface represents an USB device filter used
11926	to perform actions on a group of USB devices.
11927
11928	This type of filters is used by running virtual machines to
11929	automatically capture selected USB devices once they are physically
11930	attached to the host computer.
11931
11932	A USB device is matched to the given device filter if and only if all
11933	attributes of the device match the corresponding attributes of the
11934	filter (that is, attributes are joined together using the logical AND
11935	operation). On the other hand, all together, filters in the list of
11936	filters carry the semantics of the logical OR operation. So if it is
11937	desirable to create a match like "this vendor id OR this product id",
11938	one needs to create two filters and specify "any match" (see below)
11939	for unused attributes.
11940
11941	All filter attributes used for matching are strings. Each string
11942	is an expression representing a set of values of the corresponding
11943	device attribute, that will match the given filter. Currently, the
11944	following filtering expressions are supported:
11945
11946	<ul>
11947	<li><i>Interval filters</i>. Used to specify valid intervals for
11948	integer device attributes (Vendor ID, Product ID and Revision).
11949	The format of the string is:
11950
11951	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11952
11953	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11954	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11955	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11956	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11957	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11958	possible integer is assumed.
11959	</li>
11960	<li><i>Boolean filters</i>. Used to specify acceptable values for
11961	boolean device attributes. The format of the string is:
11962
11963	<tt>true\|false\|yes\|no\|0\|1</tt>
11964
11965	</li>
11966	<li><i>Exact match</i>. Used to specify a single value for the given
11967	device attribute. Any string that doesn't start with <tt>int:</tt>
11968	represents the exact match. String device attributes are compared to
11969	this string including case of symbols. Integer attributes are first
11970	converted to a string (see individual filter attributes) and then
11971	compared ignoring case.
11972
11973	</li>
11974	<li><i>Any match</i>. Any value of the corresponding device attribute
11975	will match the given filter. An empty or @c null string is
11976	used to construct this type of filtering expressions.
11977
11978	</li>
11979	</ul>
11980
11981	<note>
11982	On the Windows host platform, interval filters are not currently
11983	available. Also all string filter attributes
11984	(<link to="#manufacturer"/>, <link to="#product"/>,
11985	<link to="#serialNumber"/>) are ignored, so they behave as
11986	<i>any match</i> no matter what string expression is specified.
11987	</note>
11988
11989	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11990	</desc>
11991
11992	<attribute name="name" type="wstring">
11993	<desc>
11994	Visible name for this filter.
11995	This name is used to visually distinguish one filter from another,
11996	so it can neither be @c null nor an empty string.
11997	</desc>
11998	</attribute>
11999
12000	<attribute name="active" type="boolean">
12001	<desc>Whether this filter active or has been temporarily disabled.</desc>
12002	</attribute>
12003
12004	<attribute name="vendorId" type="wstring">
12005	<desc>
12006	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12007	The string representation for the <i>exact matching</i>
12008	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12009	(including leading zeroes).
12010	</desc>
12011	</attribute>
12012
12013	<attribute name="productId" type="wstring">
12014	<desc>
12015	<link to="IUSBDevice::productId">Product ID</link> filter.
12016	The string representation for the <i>exact matching</i>
12017	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12018	(including leading zeroes).
12019	</desc>
12020	</attribute>
12021
12022	<attribute name="revision" type="wstring">
12023	<desc>
12024	<link to="IUSBDevice::productId">Product revision number</link>
12025	filter. The string representation for the <i>exact matching</i>
12026	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12027	of the integer part of the revision, and <tt>F</tt> is the
12028	decimal digit of its fractional part (including leading and
12029	trailing zeros).
12030	Note that for interval filters, it's best to use the hexadecimal
12031	form, because the revision is stored as a 16 bit packed BCD value;
12032	so the expression <tt>int:0x0100-0x0199</tt> will match any
12033	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12034	</desc>
12035	</attribute>
12036
12037	<attribute name="manufacturer" type="wstring">
12038	<desc>
12039	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12040	</desc>
12041	</attribute>
12042
12043	<attribute name="product" type="wstring">
12044	<desc>
12045	<link to="IUSBDevice::product">Product</link> filter.
12046	</desc>
12047	</attribute>
12048
12049	<attribute name="serialNumber" type="wstring">
12050	<desc>
12051	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12052	</desc>
12053	</attribute>
12054
12055	<attribute name="port" type="wstring">
12056	<desc>
12057	<link to="IUSBDevice::port">Host USB port</link> filter.
12058	</desc>
12059	</attribute>
12060
12061	<attribute name="remote" type="wstring">
12062	<desc>
12063	<link to="IUSBDevice::remote">Remote state</link> filter.
12064	<note>
12065	This filter makes sense only for machine USB filters,
12066	i.e. it is ignored by IHostUSBDeviceFilter objects.
12067	</note>
12068	</desc>
12069	</attribute>
12070
12071	<attribute name="maskedInterfaces" type="unsigned long">
12072	<desc>
12073	This is an advanced option for hiding one or more USB interfaces
12074	from the guest. The value is a bit mask where the bits that are set
12075	means the corresponding USB interface should be hidden, masked off
12076	if you like.
12077	This feature only works on Linux hosts.
12078	</desc>
12079	</attribute>
12080
12081	</interface>
12082
12083
12084	<!--
12085	// IHostUSBDevice
12086	/////////////////////////////////////////////////////////////////////////
12087	-->
12088
12089	<enum
12090	name="USBDeviceState"
12091	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12092	>
12093	<desc>
12094	USB device state. This enumeration represents all possible states
12095	of the USB device physically attached to the host computer regarding
12096	its state on the host computer and availability to guest computers
12097	(all currently running virtual machines).
12098
12099	Once a supported USB device is attached to the host, global USB
12100	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12101	either ignore the device, or put it to USBDeviceState_Held state, or do
12102	nothing. Unless the device is ignored by global filters, filters of all
12103	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12104	activated that can put it to USBDeviceState_Captured state.
12105
12106	If the device was ignored by global filters, or didn't match
12107	any filters at all (including guest ones), it is handled by the host
12108	in a normal way. In this case, the device state is determined by
12109	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12110	or USBDeviceState_Available, depending on the current device usage.
12111
12112	Besides auto-capturing based on filters, the device can be manually
12113	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12114	state is USBDeviceState_Busy, USBDeviceState_Available or
12115	USBDeviceState_Held.
12116
12117	<note>
12118	Due to differences in USB stack implementations in Linux and Win32,
12119	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12120	only to the Linux version of the product. This also means that (<link
12121	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12122	device state is USBDeviceState_Held.
12123	</note>
12124
12125	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12126	</desc>
12127
12128	<const name="NotSupported" value="0">
12129	<desc>
12130	Not supported by the VirtualBox server, not available to guests.
12131	</desc>
12132	</const>
12133	<const name="Unavailable" value="1">
12134	<desc>
12135	Being used by the host computer exclusively,
12136	not available to guests.
12137	</desc>
12138	</const>
12139	<const name="Busy" value="2">
12140	<desc>
12141	Being used by the host computer, potentially available to guests.
12142	</desc>
12143	</const>
12144	<const name="Available" value="3">
12145	<desc>
12146	Not used by the host computer, available to guests (the host computer
12147	can also start using the device at any time).
12148	</desc>
12149	</const>
12150	<const name="Held" value="4">
12151	<desc>
12152	Held by the VirtualBox server (ignored by the host computer),
12153	available to guests.
12154	</desc>
12155	</const>
12156	<const name="Captured" value="5">
12157	<desc>
12158	Captured by one of the guest computers, not available
12159	to anybody else.
12160	</desc>
12161	</const>
12162	</enum>
12163
12164	<interface
12165	name="IHostUSBDevice" extends="IUSBDevice"
12166	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12167	wsmap="managed"
12168	>
12169	<desc>
12170	The IHostUSBDevice interface represents a physical USB device attached
12171	to the host computer.
12172
12173	Besides properties inherited from IUSBDevice, this interface adds the
12174	<link to="#state"/> property that holds the current state of the USB
12175	device.
12176
12177	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12178	</desc>
12179
12180	<attribute name="state" type="USBDeviceState" readonly="yes">
12181	<desc>
12182	Current state of the device.
12183	</desc>
12184	</attribute>
12185
12186	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12187
12188	</interface>
12189
12190
12191	<!--
12192	// IHostUSBDeviceFilter
12193	/////////////////////////////////////////////////////////////////////////
12194	-->
12195
12196	<enum
12197	name="USBDeviceFilterAction"
12198	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12199	>
12200	<desc>
12201	Actions for host USB device filters.
12202	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12203	</desc>
12204
12205	<const name="Null" value="0">
12206	<desc>Null value (never used by the API).</desc>
12207	</const>
12208	<const name="Ignore" value="1">
12209	<desc>Ignore the matched USB device.</desc>
12210	</const>
12211	<const name="Hold" value="2">
12212	<desc>Hold the matched USB device.</desc>
12213	</const>
12214	</enum>
12215
12216	<interface
12217	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12218	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12219	wsmap="managed"
12220	>
12221	<desc>
12222	The IHostUSBDeviceFilter interface represents a global filter for a
12223	physical USB device used by the host computer. Used indirectly in
12224	<link to="IHost::USBDeviceFilters"/>.
12225
12226	Using filters of this type, the host computer determines the initial
12227	state of the USB device after it is physically attached to the
12228	host's USB controller.
12229
12230	<note>
12231	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12232	filters, because it makes sense only for
12233	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12234	</note>
12235
12236	<see>IHost::USBDeviceFilters</see>
12237	</desc>
12238
12239	<attribute name="action" type="USBDeviceFilterAction">
12240	<desc>
12241	Action performed by the host when an attached USB device
12242	matches this filter.
12243	</desc>
12244	</attribute>
12245
12246	</interface>
12247
12248	<!--
12249	// IAudioAdapter
12250	/////////////////////////////////////////////////////////////////////////
12251	-->
12252
12253	<enum
12254	name="AudioDriverType"
12255	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12256	>
12257	<desc>
12258	Host audio driver type.
12259	</desc>
12260
12261	<const name="Null" value="0">
12262	<desc>Null value, also means "dummy audio driver".</desc>
12263	</const>
12264	<const name="WinMM" value="1">
12265	<desc>Windows multimedia (Windows hosts only).</desc>
12266	</const>
12267	<const name="OSS" value="2">
12268	<desc>Open Sound System (Linux hosts only).</desc>
12269	</const>
12270	<const name="ALSA" value="3">
12271	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12272	</const>
12273	<const name="DirectSound" value="4">
12274	<desc>DirectSound (Windows hosts only).</desc>
12275	</const>
12276	<const name="CoreAudio" value="5">
12277	<desc>CoreAudio (Mac hosts only).</desc>
12278	</const>
12279	<const name="MMPM" value="6">
12280	<desc>Reserved for historical reasons.</desc>
12281	</const>
12282	<const name="Pulse" value="7">
12283	<desc>PulseAudio (Linux hosts only).</desc>
12284	</const>
12285	<const name="SolAudio" value="8">
12286	<desc>Solaris audio (Solaris hosts only).</desc>
12287	</const>
12288	</enum>
12289
12290	<enum
12291	name="AudioControllerType"
12292	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12293	>
12294	<desc>
12295	Virtual audio controller type.
12296	</desc>
12297
12298	<const name="AC97" value="0"/>
12299	<const name="SB16" value="1"/>
12300	<const name="HDA" value="2"/>
12301	</enum>
12302
12303	<interface
12304	name="IAudioAdapter" extends="$unknown"
12305	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12306	wsmap="managed"
12307	>
12308	<desc>
12309	The IAudioAdapter interface represents the virtual audio adapter of
12310	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12311	</desc>
12312	<attribute name="enabled" type="boolean">
12313	<desc>
12314	Flag whether the audio adapter is present in the
12315	guest system. If disabled, the virtual guest hardware will
12316	not contain any audio adapter. Can only be changed when
12317	the VM is not running.
12318	</desc>
12319	</attribute>
12320	<attribute name="audioController" type="AudioControllerType">
12321	<desc>
12322	The audio hardware we emulate.
12323	</desc>
12324	</attribute>
12325	<attribute name="audioDriver" type="AudioDriverType">
12326	<desc>
12327	Audio driver the adapter is connected to. This setting
12328	can only be changed when the VM is not running.
12329	</desc>
12330	</attribute>
12331	</interface>
12332
12333	<!--
12334	// IVRDPServer
12335	/////////////////////////////////////////////////////////////////////////
12336	-->
12337
12338	<enum
12339	name="VRDPAuthType"
12340	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12341	>
12342	<desc>
12343	VRDP authentication type.
12344	</desc>
12345
12346	<const name="Null" value="0">
12347	<desc>Null value, also means "no authentication".</desc>
12348	</const>
12349	<const name="External" value="1"/>
12350	<const name="Guest" value="2"/>
12351	</enum>
12352
12353	<interface
12354	name="IVRDPServer" extends="$unknown"
12355	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12356	wsmap="managed"
12357	>
12358	<attribute name="enabled" type="boolean">
12359	<desc>VRDP server status.</desc>
12360	</attribute>
12361
12362	<attribute name="ports" type="wstring">
12363	<desc>
12364	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12365	<note>
12366	This is a string of comma separated TCP port numbers or port number ranges.
12367	Example <tt>5000,5010-5012,5015</tt>
12368	</note>
12369	</desc>
12370	</attribute>
12371
12372	<attribute name="netAddress" type="wstring">
12373	<desc>VRDP server address.</desc>
12374	</attribute>
12375
12376	<attribute name="authType" type="VRDPAuthType">
12377	<desc>VRDP authentication method.</desc>
12378	</attribute>
12379
12380	<attribute name="authTimeout" type="unsigned long">
12381	<desc>Timeout for guest authentication. Milliseconds.</desc>
12382	</attribute>
12383
12384	<attribute name="allowMultiConnection" type="boolean">
12385	<desc>
12386	Flag whether multiple simultaneous connections to the VM are permitted.
12387	Note that this will be replaced by a more powerful mechanism in the future.
12388	</desc>
12389	</attribute>
12390
12391	<attribute name="reuseSingleConnection" type="boolean">
12392	<desc>
12393	Flag whether the existing connection must be dropped and a new connection
12394	must be established by the VRDP server, when a new client connects in single
12395	connection mode.
12396	</desc>
12397	</attribute>
12398
12399	<attribute name="videoChannel" type="boolean">
12400	<desc>
12401	Flag whether RDP video channel is supported.
12402	</desc>
12403	</attribute>
12404
12405	<attribute name="videoChannelQuality" type="unsigned long">
12406	<desc>
12407	Image quality in percents.
12408	</desc>
12409	</attribute>
12410
12411	</interface>
12412
12413
12414	<!--
12415	// ISharedFolder
12416	/////////////////////////////////////////////////////////////////////////
12417	-->
12418
12419	<interface
12420	name="ISharedFolder" extends="$unknown"
12421	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12422	wsmap="struct"
12423	>
12424	<desc>
12425	The ISharedFolder interface represents a folder in the host computer's
12426	file system accessible from the guest OS running inside a virtual
12427	machine using an associated logical name.
12428
12429	There are three types of shared folders:
12430	<ul>
12431	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12432	folders available to all virtual machines.</li>
12433	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12434	VM-specific shared folders available to the given virtual machine at
12435	startup.</li>
12436	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12437	VM-specific shared folders created in the session context (for
12438	example, when the virtual machine is running) and automatically
12439	discarded when the session is closed (the VM is powered off).</li>
12440	</ul>
12441
12442	Logical names of shared folders must be unique within the given scope
12443	(global, permanent or transient). However, they do not need to be unique
12444	across scopes. In this case, the definition of the shared folder in a
12445	more specific scope takes precedence over definitions in all other
12446	scopes. The order of precedence is (more specific to more general):
12447	<ol>
12448	<li>Transient definitions</li>
12449	<li>Permanent definitions</li>
12450	<li>Global definitions</li>
12451	</ol>
12452
12453	For example, if MyMachine has a shared folder named
12454	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12455	transient shared folder named <tt>C_DRIVE</tt> (that points
12456	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12457	of <tt>C_DRIVE</tt> in the guest OS so
12458	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12459	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12460	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12461	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12462	to <tt>C:\\</tt> if it still exists.
12463
12464	Note that permanent and transient shared folders of different machines
12465	are in different name spaces, so they don't overlap and don't need to
12466	have unique logical names.
12467
12468	<note>
12469	Global shared folders are not implemented in the current version of the
12470	product.
12471	</note>
12472	</desc>
12473
12474	<attribute name="name" type="wstring" readonly="yes">
12475	<desc>Logical name of the shared folder.</desc>
12476	</attribute>
12477
12478	<attribute name="hostPath" type="wstring" readonly="yes">
12479	<desc>Full path to the shared folder in the host file system.</desc>
12480	</attribute>
12481
12482	<attribute name="accessible" type="boolean" readonly="yes">
12483	<desc>
12484	Whether the folder defined by the host path is currently
12485	accessible or not.
12486	For example, the folder can be unaccessible if it is placed
12487	on the network share that is not available by the time
12488	this property is read.
12489	</desc>
12490	</attribute>
12491
12492	<attribute name="writable" type="boolean" readonly="yes">
12493	<desc>
12494	Whether the folder defined by the host path is writable or
12495	not.
12496	</desc>
12497	</attribute>
12498
12499	<attribute name="autoMount" type="boolean" readonly="yes">
12500	<desc>
12501	Whether the folder gets automatically mounted by the guest or not.
12502	</desc>
12503	</attribute>
12504
12505	<attribute name="lastAccessError" type="wstring" readonly="yes">
12506	<desc>
12507	Text message that represents the result of the last accessibility
12508	check.
12509
12510	Accessibility checks are performed each time the <link to="#accessible"/>
12511	attribute is read. An empty string is returned if the last
12512	accessibility check was successful. A non-empty string indicates a
12513	failure and should normally describe a reason of the failure (for
12514	example, a file read error).
12515	</desc>
12516	</attribute>
12517
12518	</interface>
12519
12520	<!--
12521	// ISession
12522	/////////////////////////////////////////////////////////////////////////
12523	-->
12524
12525	<interface
12526	name="IInternalSessionControl" extends="$unknown"
12527	uuid="0431ef9e-2c2e-42af-87d7-c8f52455f28a"
12528	internal="yes"
12529	wsmap="suppress"
12530	>
12531	<method name="getPID">
12532	<desc>PID of the process that has created this Session object.
12533	</desc>
12534	<param name="pid" type="unsigned long" dir="return"/>
12535	</method>
12536
12537	<method name="getRemoteConsole">
12538	<desc>
12539	Returns the console object suitable for remote control.
12540
12541	<result name="VBOX_E_INVALID_VM_STATE">
12542	Session state prevents operation.
12543	</result>
12544	<result name="VBOX_E_INVALID_OBJECT_STATE">
12545	Session type prevents operation.
12546	</result>
12547
12548	</desc>
12549	<param name="console" type="IConsole" dir="return"/>
12550	</method>
12551
12552	<method name="assignMachine">
12553	<desc>
12554	Assigns the machine object associated with this direct-type
12555	session or informs the session that it will be a remote one
12556	(if @a machine == @c null).
12557
12558	<result name="VBOX_E_INVALID_VM_STATE">
12559	Session state prevents operation.
12560	</result>
12561	<result name="VBOX_E_INVALID_OBJECT_STATE">
12562	Session type prevents operation.
12563	</result>
12564
12565	</desc>
12566	<param name="machine" type="IMachine" dir="in"/>
12567	</method>
12568
12569	<method name="assignRemoteMachine">
12570	<desc>
12571	Assigns the machine and the (remote) console object associated with
12572	this remote-type session.
12573
12574	<result name="VBOX_E_INVALID_VM_STATE">
12575	Session state prevents operation.
12576	</result>
12577
12578	</desc>
12579	<param name="machine" type="IMachine" dir="in"/>
12580	<param name="console" type="IConsole" dir="in"/>
12581	</method>
12582
12583	<method name="updateMachineState">
12584	<desc>
12585	Updates the machine state in the VM process.
12586	Must be called only in certain cases
12587	(see the method implementation).
12588
12589	<result name="VBOX_E_INVALID_VM_STATE">
12590	Session state prevents operation.
12591	</result>
12592	<result name="VBOX_E_INVALID_OBJECT_STATE">
12593	Session type prevents operation.
12594	</result>
12595
12596	</desc>
12597	<param name="aMachineState" type="MachineState" dir="in"/>
12598	</method>
12599
12600	<method name="uninitialize">
12601	<desc>
12602	Uninitializes (closes) this session. Used by VirtualBox to close
12603	the corresponding remote session when the direct session dies
12604	or gets closed.
12605
12606	<result name="VBOX_E_INVALID_VM_STATE">
12607	Session state prevents operation.
12608	</result>
12609
12610	</desc>
12611	</method>
12612
12613	<method name="onNetworkAdapterChange">
12614	<desc>
12615	Triggered when settings of a network adapter of the
12616	associated virtual machine have changed.
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="networkAdapter" type="INetworkAdapter" dir="in"/>
12627	<param name="changeAdapter" type="boolean" dir="in"/>
12628	</method>
12629
12630	<method name="onSerialPortChange">
12631	<desc>
12632	Triggered when settings of a serial port of the
12633	associated virtual machine have changed.
12634
12635	<result name="VBOX_E_INVALID_VM_STATE">
12636	Session state prevents operation.
12637	</result>
12638	<result name="VBOX_E_INVALID_OBJECT_STATE">
12639	Session type prevents operation.
12640	</result>
12641
12642	</desc>
12643	<param name="serialPort" type="ISerialPort" dir="in"/>
12644	</method>
12645
12646	<method name="onParallelPortChange">
12647	<desc>
12648	Triggered when settings of a parallel port of the
12649	associated virtual machine have changed.
12650
12651	<result name="VBOX_E_INVALID_VM_STATE">
12652	Session state prevents operation.
12653	</result>
12654	<result name="VBOX_E_INVALID_OBJECT_STATE">
12655	Session type prevents operation.
12656	</result>
12657
12658	</desc>
12659	<param name="parallelPort" type="IParallelPort" dir="in"/>
12660	</method>
12661
12662	<method name="onStorageControllerChange">
12663	<desc>
12664	Triggered when settings of a storage controller of the
12665	associated virtual machine have changed.
12666
12667	<result name="VBOX_E_INVALID_VM_STATE">
12668	Session state prevents operation.
12669	</result>
12670	<result name="VBOX_E_INVALID_OBJECT_STATE">
12671	Session type prevents operation.
12672	</result>
12673
12674	</desc>
12675	</method>
12676
12677	<method name="onMediumChange">
12678	<desc>
12679	Triggered when attached media of the
12680	associated virtual machine have changed.
12681
12682	<result name="VBOX_E_INVALID_VM_STATE">
12683	Session state prevents operation.
12684	</result>
12685	<result name="VBOX_E_INVALID_OBJECT_STATE">
12686	Session type prevents operation.
12687	</result>
12688
12689	</desc>
12690
12691	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12692	<param name="force" type="boolean" dir="in"/>
12693	</method>
12694
12695	<method name="onCPUChange">
12696	<desc>
12697	Notification when a CPU changes.
12698	</desc>
12699	<param name="cpu" type="unsigned long" dir="in">
12700	<desc>The CPU which changed</desc>
12701	</param>
12702	<param name="add" type="boolean" dir="in">
12703	<desc>Flag whether the CPU was added or removed</desc>
12704	</param>
12705	</method>
12706
12707	<method name="onCPUExecutionCapChange">
12708	<desc>
12709	Notification when the CPU execution cap changes.
12710	</desc>
12711	<param name="executionCap" type="unsigned long" dir="in">
12712	<desc>The new CPU execution cap value. (1-100)</desc>
12713	</param>
12714	</method>
12715
12716	<method name="onVRDPServerChange">
12717	<desc>
12718	Triggered when settings of the VRDP server object of the
12719	associated virtual machine have changed.
12720
12721	<result name="VBOX_E_INVALID_VM_STATE">
12722	Session state prevents operation.
12723	</result>
12724	<result name="VBOX_E_INVALID_OBJECT_STATE">
12725	Session type prevents operation.
12726	</result>
12727
12728	</desc>
12729	<param name="restart" type="boolean" dir="in">
12730	<desc>Flag whether the server must be restarted</desc>
12731	</param>
12732	</method>
12733
12734	<method name="onUSBControllerChange">
12735	<desc>
12736	Triggered when settings of the USB controller object of the
12737	associated virtual machine have changed.
12738
12739	<result name="VBOX_E_INVALID_VM_STATE">
12740	Session state prevents operation.
12741	</result>
12742	<result name="VBOX_E_INVALID_OBJECT_STATE">
12743	Session type prevents operation.
12744	</result>
12745
12746	</desc>
12747	</method>
12748
12749	<method name="onSharedFolderChange">
12750	<desc>
12751	Triggered when a permanent (global or machine) shared folder has been
12752	created or removed.
12753	<note>
12754	We don't pass shared folder parameters in this notification because
12755	the order in which parallel notifications are delivered is not defined,
12756	therefore it could happen that these parameters were outdated by the
12757	time of processing this notification.
12758	</note>
12759
12760	<result name="VBOX_E_INVALID_VM_STATE">
12761	Session state prevents operation.
12762	</result>
12763	<result name="VBOX_E_INVALID_OBJECT_STATE">
12764	Session type prevents operation.
12765	</result>
12766
12767	</desc>
12768	<param name="global" type="boolean" dir="in"/>
12769	</method>
12770
12771	<method name="onUSBDeviceAttach">
12772	<desc>
12773	Triggered when a request to capture a USB device (as a result
12774	of matched USB filters or direct call to
12775	<link to="IConsole::attachUSBDevice"/>) has completed.
12776	A @c null @a error object means success, otherwise it
12777	describes a failure.
12778
12779	<result name="VBOX_E_INVALID_VM_STATE">
12780	Session state prevents operation.
12781	</result>
12782	<result name="VBOX_E_INVALID_OBJECT_STATE">
12783	Session type prevents operation.
12784	</result>
12785
12786	</desc>
12787	<param name="device" type="IUSBDevice" dir="in"/>
12788	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12789	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12790	</method>
12791
12792	<method name="onUSBDeviceDetach">
12793	<desc>
12794	Triggered when a request to release the USB device (as a result
12795	of machine termination or direct call to
12796	<link to="IConsole::detachUSBDevice"/>) has completed.
12797	A @c null @a error object means success, otherwise it
12798	describes a failure.
12799
12800	<result name="VBOX_E_INVALID_VM_STATE">
12801	Session state prevents operation.
12802	</result>
12803	<result name="VBOX_E_INVALID_OBJECT_STATE">
12804	Session type prevents operation.
12805	</result>
12806
12807	</desc>
12808	<param name="id" type="uuid" mod="string" dir="in"/>
12809	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12810	</method>
12811
12812	<method name="onShowWindow">
12813	<desc>
12814	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12815	<link to="IMachine::showConsoleWindow"/> in order to notify
12816	console listeners
12817	<link to="ICanShowWindowEvent"/>
12818	and <link to="IShowWindowEvent"/>.
12819
12820	<result name="VBOX_E_INVALID_OBJECT_STATE">
12821	Session type prevents operation.
12822	</result>
12823
12824	</desc>
12825	<param name="check" type="boolean" dir="in"/>
12826	<param name="canShow" type="boolean" dir="out"/>
12827	<param name="winId" type="long long" dir="out"/>
12828	</method>
12829
12830	<method name="accessGuestProperty">
12831	<desc>
12832	Called by <link to="IMachine::getGuestProperty"/> and by
12833	<link to="IMachine::setGuestProperty"/> in order to read and
12834	modify guest properties.
12835
12836	<result name="VBOX_E_INVALID_VM_STATE">
12837	Machine session is not open.
12838	</result>
12839	<result name="VBOX_E_INVALID_OBJECT_STATE">
12840	Session type is not direct.
12841	</result>
12842
12843	</desc>
12844	<param name="name" type="wstring" dir="in"/>
12845	<param name="value" type="wstring" dir="in"/>
12846	<param name="flags" type="wstring" dir="in"/>
12847	<param name="isSetter" type="boolean" dir="in"/>
12848	<param name="retValue" type="wstring" dir="out"/>
12849	<param name="retTimestamp" type="long long" dir="out"/>
12850	<param name="retFlags" type="wstring" dir="out"/>
12851	</method>
12852
12853	<method name="enumerateGuestProperties">
12854	<desc>
12855	Return a list of the guest properties matching a set of patterns along
12856	with their values, time stamps and flags.
12857
12858	<result name="VBOX_E_INVALID_VM_STATE">
12859	Machine session is not open.
12860	</result>
12861	<result name="VBOX_E_INVALID_OBJECT_STATE">
12862	Session type is not direct.
12863	</result>
12864
12865	</desc>
12866	<param name="patterns" type="wstring" dir="in">
12867	<desc>
12868	The patterns to match the properties against as a comma-separated
12869	string. If this is empty, all properties currently set will be
12870	returned.
12871	</desc>
12872	</param>
12873	<param name="key" type="wstring" dir="out" safearray="yes">
12874	<desc>
12875	The key names of the properties returned.
12876	</desc>
12877	</param>
12878	<param name="value" type="wstring" dir="out" safearray="yes">
12879	<desc>
12880	The values of the properties returned. The array entries match the
12881	corresponding entries in the @a key array.
12882	</desc>
12883	</param>
12884	<param name="timestamp" type="long long" dir="out" safearray="yes">
12885	<desc>
12886	The time stamps of the properties returned. The array entries match
12887	the corresponding entries in the @a key array.
12888	</desc>
12889	</param>
12890	<param name="flags" type="wstring" dir="out" safearray="yes">
12891	<desc>
12892	The flags of the properties returned. The array entries match the
12893	corresponding entries in the @a key array.
12894	</desc>
12895	</param>
12896	</method>
12897
12898	<method name="onlineMergeMedium">
12899	<desc>
12900	Triggers online merging of a hard disk. Used internally when deleting
12901	a snapshot while a VM referring to the same hard disk chain is running.
12902
12903	<result name="VBOX_E_INVALID_VM_STATE">
12904	Machine session is not open.
12905	</result>
12906	<result name="VBOX_E_INVALID_OBJECT_STATE">
12907	Session type is not direct.
12908	</result>
12909
12910	</desc>
12911	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12912	<desc>The medium attachment to identify the medium chain.</desc>
12913	</param>
12914	<param name="sourceIdx" type="unsigned long" dir="in">
12915	<desc>The index of the source image in the chain.
12916	Redundant, but drastically reduces IPC.</desc>
12917	</param>
12918	<param name="targetIdx" type="unsigned long" dir="in">
12919	<desc>The index of the target image in the chain.
12920	Redundant, but drastically reduces IPC.</desc>
12921	</param>
12922	<param name="source" type="IMedium" dir="in">
12923	<desc>Merge source medium.</desc>
12924	</param>
12925	<param name="target" type="IMedium" dir="in">
12926	<desc>Merge target medium.</desc>
12927	</param>
12928	<param name="mergeForward" type="boolean" dir="in">
12929	<desc>Merge direction.</desc>
12930	</param>
12931	<param name="parentForTarget" type="IMedium" dir="in">
12932	<desc>For forward merges: new parent for target medium.</desc>
12933	</param>
12934	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12935	<desc>For backward merges: list of media which need their parent UUID
12936	updated.</desc>
12937	</param>
12938	<param name="progress" type="IProgress" dir="in">
12939	<desc>
12940	Progress object for this operation.
12941	</desc>
12942	</param>
12943	</method>
12944
12945	</interface>
12946
12947	<interface
12948	name="ISession" extends="$unknown"
12949	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12950	wsmap="managed"
12951	>
12952	<desc>
12953	The ISession interface represents a client process and allows for locking
12954	virtual machines (represented by IMachine objects) to prevent conflicting
12955	changes to the machine.
12956
12957	Any caller wishing to manipulate a virtual machine needs to create a session
12958	object first, which lives in its own process space. Such session objects are
12959	then associated with <link to="IMachine" /> objects living in the VirtualBox
12960	server process to coordinate such changes.
12961
12962	There are two typical scenarios in which sessions are used:
12963
12964	<ul>
12965	<li>To alter machine settings or control a running virtual machine, one
12966	needs to lock a machine for a given session (client process) by calling
12967	<link to="IMachine::lockMachine"/>.
12968
12969	Whereas multiple sessions may control a running virtual machine, only
12970	one process can obtain a write lock on the machine to prevent conflicting
12971	changes. A write lock is also needed if a process wants to actually run a
12972	virtual machine in its own context, such as the VirtualBox GUI or
12973	VBoxHeadless front-ends. They must also lock a machine for their own
12974	sessions before they are allowed to power up the virtual machine.
12975
12976	As a result, no machine settings can be altered while another process is
12977	already using it, either because that process is modifying machine settings
12978	or because the machine is running.
12979	</li>
12980	<li>
12981	To start a VM using one of the existing VirtualBox front-ends (e.g. the
12982	VirtualBox GUI or VBoxHeadless), one would use
12983	<link to="IMachine::launchVMProcess"/>, which also takes a session object
12984	as its first parameter. This session then identifies the caller and lets the
12985	caller control the started machine (for example, pause machine execution or
12986	power it down) as well as be notified about machine execution state changes.
12987	</li>
12988	</ul>
12989
12990	How sessions objects are created in a client process depends on whether you use
12991	the Main API via COM or via the webservice:
12992
12993	<ul>
12994	<li>When using the COM API directly, an object of the Session class from the
12995	VirtualBox type library needs to be created. In regular COM C++ client code,
12996	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12997	This object will then act as a local session object in further calls to open
12998	a session.
12999	</li>
13000
13001	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13002	a session object automatically whenever <link to="IWebsessionManager::logon" />
13003	is called. A managed object reference to that session object can be retrieved by
13004	calling <link to="IWebsessionManager::getSessionObject" />.
13005	</li>
13006	</ul>
13007	</desc>
13008
13009	<attribute name="state" type="SessionState" readonly="yes">
13010	<desc>Current state of this session.</desc>
13011	</attribute>
13012
13013	<attribute name="type" type="SessionType" readonly="yes">
13014	<desc>
13015	Type of this session. The value of this attribute is valid only
13016	if the session currently has a machine locked (i.e. its
13017	<link to="#state" /> is Locked), otherwise an error will be returned.
13018	</desc>
13019	</attribute>
13020
13021	<attribute name="machine" type="IMachine" readonly="yes">
13022	<desc>Machine object associated with this session.</desc>
13023	</attribute>
13024
13025	<attribute name="console" type="IConsole" readonly="yes">
13026	<desc>Console object associated with this session.</desc>
13027	</attribute>
13028
13029	<method name="unlockMachine">
13030	<desc>
13031	Unlocks a machine that was previously locked for the current session.
13032
13033	Calling this method is required every time a machine has been locked
13034	for a particular session using the <link to="IMachine::launchVMProcess" />
13035	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13036	the machine will be set to <link to="MachineState_Aborted" /> on the
13037	server, and changes made to the machine settings will be lost.
13038
13039	Generally, it is recommended to unlock all machines explicitly
13040	before terminating the application (regardless of the reason for
13041	the termination).
13042
13043	<note>
13044	Do not expect the session state (<link to="ISession::state" />
13045	to return to "Unlocked" immediately after you invoke this method,
13046	particularly if you have started a new VM process. The session
13047	state will automatically return to "Unlocked" once the VM is no
13048	longer executing, which can of course take a very long time.
13049	</note>
13050
13051	<result name="E_UNEXPECTED">
13052	Session is not locked.
13053	</result>
13054
13055	</desc>
13056	</method>
13057
13058	</interface>
13059
13060	<!--
13061	// IStorageController
13062	/////////////////////////////////////////////////////////////////////////
13063	-->
13064
13065	<enum
13066	name="StorageBus"
13067	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13068	>
13069	<desc>
13070	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13071	see <link to="IStorageController::bus" />.
13072	</desc>
13073	<const name="Null" value="0">
13074	<desc>@c null value. Never used by the API.</desc>
13075	</const>
13076	<const name="IDE" value="1"/>
13077	<const name="SATA" value="2"/>
13078	<const name="SCSI" value="3"/>
13079	<const name="Floppy" value="4"/>
13080	<const name="SAS" value="5"/>
13081	</enum>
13082
13083	<enum
13084	name="StorageControllerType"
13085	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13086	>
13087	<desc>
13088	The exact variant of storage controller hardware presented
13089	to the guest; see <link to="IStorageController::controllerType" />.
13090	</desc>
13091
13092	<const name="Null" value="0">
13093	<desc>@c null value. Never used by the API.</desc>
13094	</const>
13095	<const name="LsiLogic" value="1">
13096	<desc>A SCSI controller of the LsiLogic variant.</desc>
13097	</const>
13098	<const name="BusLogic" value="2">
13099	<desc>A SCSI controller of the BusLogic variant.</desc>
13100	</const>
13101	<const name="IntelAhci" value="3">
13102	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13103	</const>
13104	<const name="PIIX3" value="4">
13105	<desc>An IDE controller of the PIIX3 variant.</desc>
13106	</const>
13107	<const name="PIIX4" value="5">
13108	<desc>An IDE controller of the PIIX4 variant.</desc>
13109	</const>
13110	<const name="ICH6" value="6">
13111	<desc>An IDE controller of the ICH6 variant.</desc>
13112	</const>
13113	<const name="I82078" value="7">
13114	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13115	</const>
13116	<const name="LsiLogicSas" value="8">
13117	<desc>A variant of the LsiLogic controller using SAS.</desc>
13118	</const>
13119	</enum>
13120
13121	<enum
13122	name="ChipsetType"
13123	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13124	>
13125	<desc>
13126	Type of emulated chipset (mostly southbridge).
13127	</desc>
13128
13129	<const name="Null" value="0">
13130	<desc>@c null value. Never used by the API.</desc>
13131	</const>
13132	<const name="PIIX3" value="1">
13133	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13134	</const>
13135	<const name="ICH9" value="2">
13136	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13137	</const>
13138	</enum>
13139
13140	<interface
13141	name="IStorageController" extends="$unknown"
13142	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13143	wsmap="managed"
13144	>
13145	<desc>
13146	Represents a storage controller that is attached to a virtual machine
13147	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13148	attached to storage controllers in a real computer, virtual drives
13149	(represented by <link to="IMediumAttachment" />) are attached to virtual
13150	storage controllers, represented by this interface.
13151
13152	As opposed to physical hardware, VirtualBox has a very generic concept
13153	of a storage controller, and for purposes of the Main API, all virtual
13154	storage is attached to virtual machines via instances of this interface.
13155	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13156	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13157	is used, certain sub-types may be available and can be selected in
13158	<link to="#controllerType" />.
13159
13160	Depending on these settings, the guest operating system might see
13161	significantly different virtual hardware.
13162	</desc>
13163
13164	<attribute name="name" type="wstring" readonly="yes">
13165	<desc>
13166	Name of the storage controller, as originally specified with
13167	<link to="IMachine::addStorageController" />. This then uniquely
13168	identifies this controller with other method calls such as
13169	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13170	</desc>
13171	</attribute>
13172
13173	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13174	<desc>
13175	Maximum number of devices which can be attached to one port.
13176	</desc>
13177	</attribute>
13178
13179	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13180	<desc>
13181	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13182	</desc>
13183	</attribute>
13184
13185	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13186	<desc>
13187	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13188	</desc>
13189	</attribute>
13190
13191	<attribute name="instance" type="unsigned long">
13192	<desc>
13193	The instance number of the device in the running VM.
13194	</desc>
13195	</attribute>
13196
13197	<attribute name="portCount" type="unsigned long">
13198	<desc>
13199	The number of currently usable ports on the controller.
13200	The minimum and maximum number of ports for one controller are
13201	stored in <link to="IStorageController::minPortCount"/>
13202	and <link to="IStorageController::maxPortCount"/>.
13203	</desc>
13204	</attribute>
13205
13206	<attribute name="bus" type="StorageBus" readonly="yes">
13207	<desc>
13208	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13209	</desc>
13210	</attribute>
13211
13212	<attribute name="controllerType" type="StorageControllerType">
13213	<desc>
13214	The exact variant of storage controller hardware presented
13215	to the guest.
13216	Depending on this value, VirtualBox will provide a different
13217	virtual storage controller hardware to the guest.
13218	For SATA, SAS and floppy controllers, only one variant is
13219	available, but for IDE and SCSI, there are several.
13220
13221	For SCSI controllers, the default type is LsiLogic.
13222	</desc>
13223	</attribute>
13224
13225	<attribute name="useHostIOCache" type="boolean">
13226	<desc>
13227	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13228	caches and use synchronous file APIs on the host. This was the only option in the API before
13229	VirtualBox 3.2 and is still the default for IDE controllers.
13230
13231	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13232	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13233	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13234	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13235	virtual machines are running at the same time to prevent I/O cache related hangs.
13236	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13237	</desc>
13238	</attribute>
13239
13240	<method name="getIDEEmulationPort">
13241	<desc>
13242	Gets the corresponding port number which is emulated as an IDE device.
13243	Works only with SATA controllers.
13244
13245	<result name="E_INVALIDARG">
13246	The @a devicePosition is not in the range 0 to 3.
13247	</result>
13248	<result name="E_NOTIMPL">
13249	The storage controller type is not SATAIntelAhci.
13250	</result>
13251
13252	</desc>
13253	<param name="devicePosition" type="long" dir="in"/>
13254	<param name="portNumber" type="long" dir="return"/>
13255	</method>
13256
13257	<method name="setIDEEmulationPort">
13258	<desc>
13259	Sets the port number which is emulated as an IDE device.
13260	Works only with SATA controllers.
13261
13262	<result name="E_INVALIDARG">
13263	The @a devicePosition is not in the range 0 to 3 or the
13264	@a portNumber is not in the range 0 to 29.
13265	</result>
13266	<result name="E_NOTIMPL">
13267	The storage controller type is not SATAIntelAhci.
13268	</result>
13269
13270	</desc>
13271	<param name="devicePosition" type="long" dir="in"/>
13272	<param name="portNumber" type="long" dir="in"/>
13273	</method>
13274
13275	</interface>
13276
13277	<if target="wsdl">
13278
13279	<!--
13280	// IManagedObjectRef
13281	/////////////////////////////////////////////////////////////////////////
13282	-->
13283
13284	<interface
13285	name="IManagedObjectRef" extends="$unknown"
13286	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13287	internal="yes"
13288	wsmap="managed"
13289	wscpp="hardcoded"
13290	>
13291	<desc>
13292	Managed object reference.
13293
13294	Only within the webservice, a managed object reference (which is really
13295	an opaque number) allows a webservice client to address an object
13296	that lives in the address space of the webservice server.
13297
13298	Behind each managed object reference, there is a COM object that lives
13299	in the webservice server's address space. The COM object is not freed
13300	until the managed object reference is released, either by an explicit
13301	call to <link to="IManagedObjectRef::release" /> or by logging off from
13302	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13303	all objects created during the webservice session.
13304
13305	Whenever a method call of the VirtualBox API returns a COM object, the
13306	webservice representation of that method will instead return a
13307	managed object reference, which can then be used to invoke methods
13308	on that object.
13309	</desc>
13310
13311	<method name="getInterfaceName">
13312	<desc>
13313	Returns the name of the interface that this managed object represents,
13314	for example, "IMachine", as a string.
13315	</desc>
13316	<param name="return" type="wstring" dir="return"/>
13317	</method>
13318
13319	<method name="release">
13320	<desc>
13321	Releases this managed object reference and frees the resources that
13322	were allocated for it in the webservice server process. After calling
13323	this method, the identifier of the reference can no longer be used.
13324	</desc>
13325	</method>
13326
13327	</interface>
13328
13329	<!--
13330	// IWebsessionManager
13331	/////////////////////////////////////////////////////////////////////////
13332	-->
13333
13334	<interface
13335	name="IWebsessionManager" extends="$unknown"
13336	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13337	internal="yes"
13338	wsmap="global"
13339	wscpp="hardcoded"
13340	>
13341	<desc>
13342	Websession manager. This provides essential services
13343	to webservice clients.
13344	</desc>
13345	<method name="logon">
13346	<desc>
13347	Logs a new client onto the webservice and returns a managed object reference to
13348	the IVirtualBox instance, which the client can then use as a basis to further
13349	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13350	interface, in one way or the other.
13351	</desc>
13352	<param name="username" type="wstring" dir="in"/>
13353	<param name="password" type="wstring" dir="in"/>
13354	<param name="return" type="IVirtualBox" dir="return"/>
13355	</method>
13356
13357	<method name="getSessionObject">
13358	<desc>
13359	Returns a managed object reference to the internal ISession object that was created
13360	for this web service session when the client logged on.
13361
13362	<see>ISession</see>
13363	</desc>
13364	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13365	<param name="return" type="ISession" dir="return"/>
13366	</method>
13367
13368	<method name="logoff">
13369	<desc>
13370	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13371	and destroys all resources associated with the session (most importantly, all
13372	managed objects created in the server while the session was active).
13373	</desc>
13374	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13375	</method>
13376
13377	</interface>
13378
13379	</if>
13380
13381	<!--
13382	// IPerformanceCollector & friends
13383	/////////////////////////////////////////////////////////////////////////
13384	-->
13385
13386	<interface
13387	name="IPerformanceMetric" extends="$unknown"
13388	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13389	>
13390	<desc>
13391	The IPerformanceMetric interface represents parameters of the given
13392	performance metric.
13393	</desc>
13394
13395	<attribute name="metricName" type="wstring" readonly="yes">
13396	<desc>
13397	Name of the metric.
13398	</desc>
13399	</attribute>
13400
13401	<attribute name="object" type="$unknown" readonly="yes">
13402	<desc>
13403	Object this metric belongs to.
13404	</desc>
13405	</attribute>
13406
13407	<attribute name="description" type="wstring" readonly="yes">
13408	<desc>
13409	Textual description of the metric.
13410	</desc>
13411	</attribute>
13412
13413	<attribute name="period" type="unsigned long" readonly="yes">
13414	<desc>
13415	Time interval between samples, measured in seconds.
13416	</desc>
13417	</attribute>
13418
13419	<attribute name="count" type="unsigned long" readonly="yes">
13420	<desc>
13421	Number of recent samples retained by the performance collector for this
13422	metric.
13423
13424	When the collected sample count exceeds this number, older samples
13425	are discarded.
13426	</desc>
13427	</attribute>
13428
13429	<attribute name="unit" type="wstring" readonly="yes">
13430	<desc>
13431	Unit of measurement.
13432	</desc>
13433	</attribute>
13434
13435	<attribute name="minimumValue" type="long" readonly="yes">
13436	<desc>
13437	Minimum possible value of this metric.
13438	</desc>
13439	</attribute>
13440
13441	<attribute name="maximumValue" type="long" readonly="yes">
13442	<desc>
13443	Maximum possible value of this metric.
13444	</desc>
13445	</attribute>
13446	</interface>
13447
13448	<interface
13449	name="IPerformanceCollector" extends="$unknown"
13450	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13451	wsmap="managed"
13452	>
13453	<desc>
13454	The IPerformanceCollector interface represents a service that collects
13455	and stores performance metrics data.
13456
13457	Performance metrics are associated with objects of interfaces like IHost
13458	and IMachine. Each object has a distinct set of performance metrics. The
13459	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13460
13461	Metric data is collected at the specified intervals and is retained
13462	internally. The interval and the number of retained samples can be set
13463	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13464	and collection settings are not persistent, they are discarded as soon as
13465	VBoxSVC process terminates. Moreover, metric settings and data associated
13466	with a particular VM only exist while VM is running. They disappear as
13467	soon as VM shuts down. It is not possible to set up metrics for machines
13468	that are powered off. One needs to start VM first, then set up metric
13469	collection parameters.
13470
13471	Metrics are organized hierarchically, with each level separated by a
13472	slash (/) character. Generally, the scheme for metric names is like this:
13473
13474	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13475
13476	"Category/Metric" together form the base metric name. A base metric is
13477	the smallest unit for which a sampling interval and the number of
13478	retained samples can be set. Only base metrics can be enabled and
13479	disabled. All sub-metrics are collected when their base metric is
13480	collected. Collected values for any set of sub-metrics can be queried
13481	with <link to="IPerformanceCollector::queryMetricsData" />.
13482
13483	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13484	category, "Load" metric, "User" submetric, "average" aggregate. An
13485	aggregate function is computed over all retained data. Valid aggregate
13486	functions are:
13487
13488	<ul>
13489	<li>avg -- average</li>
13490	<li>min -- minimum</li>
13491	<li>max -- maximum</li>
13492	</ul>
13493
13494	When setting up metric parameters, querying metric data, enabling or
13495	disabling metrics wildcards can be used in metric names to specify a
13496	subset of metrics. For example, to select all CPU-related metrics
13497	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13498	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13499
13500	The valid names for base metrics are:
13501
13502	<ul>
13503	<li>CPU/Load</li>
13504	<li>CPU/MHz</li>
13505	<li>RAM/Usage</li>
13506	</ul>
13507
13508	The general sequence for collecting and retrieving the metrics is:
13509	<ul>
13510	<li>
13511	Obtain an instance of IPerformanceCollector with
13512	<link to="IVirtualBox::performanceCollector" />
13513	</li>
13514	<li>
13515	Allocate and populate an array with references to objects the metrics
13516	will be collected for. Use references to IHost and IMachine objects.
13517	</li>
13518	<li>
13519	Allocate and populate an array with base metric names the data will
13520	be collected for.
13521	</li>
13522	<li>
13523	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13524	the metric data will be collected and stored.
13525	</li>
13526	<li>
13527	Wait for the data to get collected.
13528	</li>
13529	<li>
13530	Allocate and populate an array with references to objects the metric
13531	values will be queried for. You can re-use the object array used for
13532	setting base metrics.
13533	</li>
13534	<li>
13535	Allocate and populate an array with metric names the data will be
13536	collected for. Note that metric names differ from base metric names.
13537	</li>
13538	<li>
13539	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13540	that have been collected so far are returned. Note that the values
13541	are still retained internally and data collection continues.
13542	</li>
13543	</ul>
13544
13545	For an example of usage refer to the following files in VirtualBox SDK:
13546	<ul>
13547	<li>
13548	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13549	</li>
13550	<li>
13551	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13552	</li>
13553	</ul>
13554	</desc>
13555
13556	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13557	<desc>
13558	Array of unique names of metrics.
13559
13560	This array represents all metrics supported by the performance
13561	collector. Individual objects do not necessarily support all of them.
13562	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13563	list of supported metrics for a particular object.
13564	</desc>
13565	</attribute>
13566
13567	<method name="getMetrics">
13568	<desc>
13569	Returns parameters of specified metrics for a set of objects.
13570	<note>
13571	@c Null metrics array means all metrics. @c Null object array means
13572	all existing objects.
13573	</note>
13574	</desc>
13575	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13576	<desc>
13577	Metric name filter. Currently, only a comma-separated list of metrics
13578	is supported.
13579	</desc>
13580	</param>
13581	<param name="objects" type="$unknown" dir="in" safearray="yes">
13582	<desc>
13583	Set of objects to return metric parameters for.
13584	</desc>
13585	</param>
13586	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13587	<desc>
13588	Array of returned metric parameters.
13589	</desc>
13590	</param>
13591	</method>
13592
13593	<method name="setupMetrics">
13594	<desc>
13595	Sets parameters of specified base metrics for a set of objects. Returns
13596	an array of <link to="IPerformanceMetric" /> describing the metrics
13597	have been affected.
13598	<note>
13599	@c Null or empty metric name array means all metrics. @c Null or
13600	empty object array means all existing objects. If metric name array
13601	contains a single element and object array contains many, the single
13602	metric name array element is applied to each object array element to
13603	form metric/object pairs.
13604	</note>
13605	</desc>
13606	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13607	<desc>
13608	Metric name filter. Comma-separated list of metrics with wildcard
13609	support.
13610	</desc>
13611	</param>
13612	<param name="objects" type="$unknown" dir="in" safearray="yes">
13613	<desc>
13614	Set of objects to setup metric parameters for.
13615	</desc>
13616	</param>
13617	<param name="period" type="unsigned long" dir="in">
13618	<desc>
13619	Time interval in seconds between two consecutive samples of
13620	performance data.
13621	</desc>
13622	</param>
13623	<param name="count" type="unsigned long" dir="in">
13624	<desc>
13625	Number of samples to retain in performance data history. Older
13626	samples get discarded.
13627	</desc>
13628	</param>
13629	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13630	<desc>
13631	Array of metrics that have been modified by the call to this method.
13632	</desc>
13633	</param>
13634	</method>
13635
13636	<method name="enableMetrics">
13637	<desc>
13638	Turns on collecting specified base metrics. Returns an array of
13639	<link to="IPerformanceMetric" /> describing the metrics have been
13640	affected.
13641	<note>
13642	@c Null or empty metric name array means all metrics. @c Null or
13643	empty object array means all existing objects. If metric name array
13644	contains a single element and object array contains many, the single
13645	metric name array element is applied to each object array element to
13646	form metric/object pairs.
13647	</note>
13648	</desc>
13649	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13650	<desc>
13651	Metric name filter. Comma-separated list of metrics with wildcard
13652	support.
13653	</desc>
13654	</param>
13655	<param name="objects" type="$unknown" dir="in" safearray="yes">
13656	<desc>
13657	Set of objects to enable metrics for.
13658	</desc>
13659	</param>
13660	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13661	<desc>
13662	Array of metrics that have been modified by the call to this method.
13663	</desc>
13664	</param>
13665	</method>
13666
13667	<method name="disableMetrics">
13668	<desc>
13669	Turns off collecting specified base metrics. Returns an array of
13670	<link to="IPerformanceMetric" /> describing the metrics have been
13671	affected.
13672	<note>
13673	@c Null or empty metric name array means all metrics. @c Null or
13674	empty object array means all existing objects. If metric name array
13675	contains a single element and object array contains many, the single
13676	metric name array element is applied to each object array element to
13677	form metric/object pairs.
13678	</note>
13679	</desc>
13680	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13681	<desc>
13682	Metric name filter. Comma-separated list of metrics with wildcard
13683	support.
13684	</desc>
13685	</param>
13686	<param name="objects" type="$unknown" dir="in" safearray="yes">
13687	<desc>
13688	Set of objects to disable metrics for.
13689	</desc>
13690	</param>
13691	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13692	<desc>
13693	Array of metrics that have been modified by the call to this method.
13694	</desc>
13695	</param>
13696	</method>
13697
13698	<method name="queryMetricsData">
13699	<desc>
13700	Queries collected metrics data for a set of objects.
13701
13702	The data itself and related metric information are returned in seven
13703	parallel and one flattened array of arrays. Elements of
13704	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13705	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13706	the same index describe one set of values corresponding to a single
13707	metric.
13708
13709	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13710	start and length of a sub-array is indicated by
13711	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13712	value for metric <tt>metricNames[i]</tt> is at
13713	<tt>returnData[returnIndices[i]]</tt>.
13714
13715	<note>
13716	@c Null or empty metric name array means all metrics. @c Null or
13717	empty object array means all existing objects. If metric name array
13718	contains a single element and object array contains many, the single
13719	metric name array element is applied to each object array element to
13720	form metric/object pairs.
13721	</note>
13722	<note>
13723	Data collection continues behind the scenes after call to @c
13724	queryMetricsData. The return data can be seen as the snapshot of the
13725	current state at the time of @c queryMetricsData call. The internally
13726	kept metric values are not cleared by the call. This makes possible
13727	querying different subsets of metrics or aggregates with subsequent
13728	calls. If periodic querying is needed it is highly suggested to query
13729	the values with @c interval*count period to avoid confusion. This way
13730	a completely new set of data values will be provided by each query.
13731	</note>
13732	</desc>
13733	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13734	<desc>
13735	Metric name filter. Comma-separated list of metrics with wildcard
13736	support.
13737	</desc>
13738	</param>
13739	<param name="objects" type="$unknown" dir="in" safearray="yes">
13740	<desc>
13741	Set of objects to query metrics for.
13742	</desc>
13743	</param>
13744	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13745	<desc>
13746	Names of metrics returned in @c returnData.
13747	</desc>
13748	</param>
13749	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13750	<desc>
13751	Objects associated with metrics returned in @c returnData.
13752	</desc>
13753	</param>
13754	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13755	<desc>
13756	Units of measurement for each returned metric.
13757	</desc>
13758	</param>
13759	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13760	<desc>
13761	Divisor that should be applied to return values in order to get
13762	floating point values. For example:
13763	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13764	will retrieve the floating point value of i-th sample of the first
13765	metric.
13766	</desc>
13767	</param>
13768	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13769	<desc>
13770	Sequence numbers of the first elements of value sequences of
13771	particular metrics returned in @c returnData. For aggregate metrics
13772	it is the sequence number of the sample the aggregate started
13773	calculation from.
13774	</desc>
13775	</param>
13776	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13777	<desc>
13778	Indices of the first elements of value sequences of particular
13779	metrics returned in @c returnData.
13780	</desc>
13781	</param>
13782	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13783	<desc>
13784	Lengths of value sequences of particular metrics.
13785	</desc>
13786	</param>
13787	<param name="returnData" type="long" dir="return" safearray="yes">
13788	<desc>
13789	Flattened array of all metric data containing sequences of values for
13790	each metric.
13791	</desc>
13792	</param>
13793	</method>
13794
13795	</interface>
13796	<enum
13797	name="NATAliasMode"
13798	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13799	<desc></desc>
13800	<const name="AliasLog" value="0x1">
13801	<desc></desc>
13802	</const>
13803	<const name="AliasProxyOnly" value="0x02">
13804	<desc></desc>
13805	</const>
13806	<const name="AliasUseSamePorts" value="0x04">
13807	<desc></desc>
13808	</const>
13809	</enum>
13810	<enum
13811	name="NATProtocol"
13812	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13813	>
13814	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13815	<const name="UDP" value="0">
13816	<desc>Port-forwarding uses UDP protocol.</desc>
13817	</const>
13818	<const name="TCP" value="1">
13819	<desc>Port-forwarding uses TCP protocol.</desc>
13820	</const>
13821	</enum>
13822
13823	<interface
13824	name="INATEngine" extends="$unknown"
13825	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13826	wsmap="managed"
13827	>
13828	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13829	allows for changing NAT behavior such as port-forwarding rules. This interface is
13830	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13831	<attribute name="network" type="wstring">
13832	<desc>The network attribute of the NAT engine (the same value is used with built-in
13833	DHCP server to fill corresponding fields of DHCP leases).</desc>
13834	</attribute>
13835	<attribute name="hostIP" type="wstring">
13836	<desc>IP of host interface to bind all opened sockets to.
13837	<note>Changing this does not change binding of port forwarding.</note>
13838	</desc>
13839	</attribute>
13840	<attribute name="tftpPrefix" type="wstring">
13841	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13842	the corresponding fields of DHCP leases.</desc>
13843	</attribute>
13844	<attribute name="tftpBootFile" type="wstring">
13845	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13846	the corresponding fields of DHCP leases.</desc>
13847	</attribute>
13848	<attribute name="tftpNextServer" type="wstring">
13849	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13850	the corresponding fields of DHCP leases.
13851	<note>The preferred form is IPv4 addresses.</note>
13852	</desc>
13853	</attribute>
13854	<attribute name="aliasMode" type="unsigned long">
13855	<desc></desc>
13856	</attribute>
13857	<attribute name="dnsPassDomain" type="boolean">
13858	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13859	</attribute>
13860	<attribute name="dnsProxy" type="boolean">
13861	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13862	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13863	</attribute>
13864	<attribute name="dnsUseHostResolver" type="boolean">
13865	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13866	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13867	</attribute>
13868	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13869	<desc>Array of NAT port-forwarding rules in string representation, in the following
13870	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13871	</attribute>
13872	<method name="setNetworkSettings">
13873	<desc>Sets network configuration of the NAT engine.</desc>
13874	<param name="mtu" type="unsigned long" dir="in">
13875	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13876	</param>
13877	<param name="sockSnd" type="unsigned long" dir="in">
13878	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13879	</param>
13880	<param name="sockRcv" type="unsigned long" dir="in">
13881	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13882	</param>
13883	<param name="TcpWndSnd" type="unsigned long" dir="in">
13884	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13885	establishing a new TCP connection.</desc>
13886	</param>
13887	<param name="TcpWndRcv" type="unsigned long" dir="in">
13888	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13889	establishing a new TCP connection.</desc>
13890	</param>
13891	</method>
13892	<method name="getNetworkSettings">
13893	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13894	for parameter descriptions.</desc>
13895	<param name="mtu" type="unsigned long" dir="out" />
13896	<param name="sockSnd" type="unsigned long" dir="out" />
13897	<param name="sockRcv" type="unsigned long" dir="out" />
13898	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13899	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13900	</method>
13901	<method name="addRedirect">
13902	<desc>Adds a new NAT port-forwarding rule.</desc>
13903	<param name="name" type="wstring" dir="in">
13904	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13905	auto-generates one using the other parameters.</desc>
13906	</param>
13907	<param name="proto" type="NATProtocol" dir="in">
13908	<desc>Protocol handled with the rule.</desc>
13909	</param>
13910	<param name="hostIp" type="wstring" dir="in">
13911	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13912	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13913	</param>
13914	<param name="hostPort" type="unsigned short" dir="in">
13915	<desc>The port number to listen on.</desc>
13916	</param>
13917	<param name="guestIp" type="wstring" dir="in">
13918	<desc>The IP address of the guest which the NAT engine will forward matching packets
13919	to. An empty IP address is acceptable, in which case the NAT engine will forward
13920	packets to the first DHCP lease (x.x.x.15).</desc>
13921	</param>
13922	<param name="guestPort" type="unsigned short" dir="in">
13923	<desc>The port number to forward.</desc>
13924	</param>
13925	</method>
13926	<method name="removeRedirect">
13927	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13928	<param name="name" type="wstring" dir="in">
13929	<desc>The name of the rule to delete.</desc>
13930	</param>
13931	</method>
13932	</interface>
13933
13934	<enum
13935	name="VBoxEventType"
13936	uuid="d00980f3-bfcb-4e7d-a20e-08cabf3eb89f">
13937
13938	<desc>
13939	Type of an event.
13940	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
13941	</desc>
13942
13943	<const name="Invalid" value="0">
13944	<desc>
13945	Invalid event, must be first.
13946	</desc>
13947	</const>
13948
13949	<const name="Any" value="1">
13950	<desc>
13951	Wildcard for all events.
13952	Events of this type are never delivered, and only used in
13953	registerListener() call to simplify registration.
13954	</desc>
13955	</const>
13956
13957	<const name="Vetoable" value="2">
13958	<desc>
13959	Wildcard for all vetoable events. Events of this type are never delivered, and only
13960	used in registerListener() call to simplify registration.
13961	</desc>
13962	</const>
13963
13964	<const name="MachineEvent" value="3">
13965	<desc>
13966	Wildcard for all machine events. Events of this type are never delivered, and only used in
13967	registerListener() call to simplify registration.
13968	</desc>
13969	</const>
13970
13971	<const name="SnapshotEvent" value="4">
13972	<desc>
13973	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
13974	registerListener() call to simplify registration.
13975	</desc>
13976	</const>
13977
13978	<const name="InputEvent" value="5">
13979	<desc>
13980	Wildcard for all input device (keyboard, mouse) events.
13981	Events of this type are never delivered, and only used in
13982	registerListener() call to simplify registration.
13983	</desc>
13984	</const>
13985
13986	<const name="LastWildcard" value="31">
13987	<desc>
13988	Last wildcard.
13989	</desc>
13990	</const>
13991
13992	<const name="OnMachineStateChanged" value="32">
13993	<desc>
13994	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
13995	</desc>
13996	</const>
13997	<const name="OnMachineDataChanged" value="33">
13998	<desc>
13999	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14000	</desc>
14001	</const>
14002	<const name="OnExtraDataChanged" value="34">
14003	<desc>
14004	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14005	</desc>
14006	</const>
14007	<const name="OnExtraDataCanChange" value="35">
14008	<desc>
14009	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14010	</desc>
14011	</const>
14012	<const name="OnMediumRegistered" value="36">
14013	<desc>
14014	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14015	</desc>
14016	</const>
14017	<const name="OnMachineRegistered" value="37">
14018	<desc>
14019	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14020	</desc>
14021	</const>
14022	<const name="OnSessionStateChanged" value="38">
14023	<desc>
14024	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14025	</desc>
14026	</const>
14027	<const name="OnSnapshotTaken" value="39">
14028	<desc>
14029	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14030	</desc>
14031	</const>
14032	<const name="OnSnapshotDeleted" value="40">
14033	<desc>
14034	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14035	</desc>
14036	</const>
14037	<const name="OnSnapshotChanged" value="41">
14038	<desc>
14039	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14040	</desc>
14041	</const>
14042	<const name="OnGuestPropertyChanged" value="42">
14043	<desc>
14044	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14045	</desc>
14046	</const>
14047	<!-- Console events -->
14048	<const name="OnMousePointerShapeChanged" value="43">
14049	<desc>
14050	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14051	</desc>
14052	</const>
14053	<const name="OnMouseCapabilityChanged" value="44">
14054	<desc>
14055	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14056	</desc>
14057	</const>
14058	<const name="OnKeyboardLedsChanged" value="45">
14059	<desc>
14060	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14061	</desc>
14062	</const>
14063	<const name="OnStateChanged" value="46">
14064	<desc>
14065	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14066	</desc>
14067	</const>
14068	<const name="OnAdditionsStateChanged" value="47">
14069	<desc>
14070	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14071	</desc>
14072	</const>
14073	<const name="OnNetworkAdapterChanged" value="48">
14074	<desc>
14075	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14076	</desc>
14077	</const>
14078	<const name="OnSerialPortChanged" value="49">
14079	<desc>
14080	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14081	</desc>
14082	</const>
14083	<const name="OnParallelPortChanged" value="50">
14084	<desc>
14085	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14086	</desc>
14087	</const>
14088	<const name="OnStorageControllerChanged" value="51">
14089	<desc>
14090	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14091	</desc>
14092	</const>
14093	<const name="OnMediumChanged" value="52">
14094	<desc>
14095	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14096	</desc>
14097	</const>
14098	<const name="OnVRDPServerChanged" value="53">
14099	<desc>
14100	See <link to="IVRDPServerChangedEvent">IVRDPServerChangedEvent</link>.
14101	</desc>
14102	</const>
14103	<const name="OnUSBControllerChanged" value="54">
14104	<desc>
14105	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14106	</desc>
14107	</const>
14108	<const name="OnUSBDeviceStateChanged" value="55">
14109	<desc>
14110	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14111	</desc>
14112	</const>
14113	<const name="OnSharedFolderChanged" value="56">
14114	<desc>
14115	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14116	</desc>
14117	</const>
14118	<const name="OnRuntimeError" value="57">
14119	<desc>
14120	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14121	</desc>
14122	</const>
14123	<const name="OnCanShowWindow" value="58">
14124	<desc>
14125	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14126	</desc>
14127	</const>
14128	<const name="OnShowWindow" value="59">
14129	<desc>
14130	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14131	</desc>
14132	</const>
14133	<const name="OnCPUChanged" value="60">
14134	<desc>
14135	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14136	</desc>
14137	</const>
14138	<const name="OnRemoteDisplayInfoChanged" value="61">
14139	<desc>
14140	See <link to="IRemoteDisplayInfoChangedEvent">IRemoteDisplayInfoChangedEvent</link>.
14141	</desc>
14142	</const>
14143	<const name="OnEventSourceChanged" value="62">
14144	<desc>
14145	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14146	</desc>
14147	</const>
14148	<const name="OnCPUExecutionCapChanged" value="63">
14149	<desc>
14150	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14151	</desc>
14152	</const>
14153	<!-- Last event marker -->
14154	<const name="Last" value="64">
14155	<desc>
14156	Must be last event, used for iterations and structures relying on numerical event values.
14157	</desc>
14158	</const>
14159
14160	</enum>
14161
14162	<interface
14163	name="IEventSource" extends="$unknown"
14164	uuid="3c670618-f727-4fe9-94d2-8243f489a033"
14165	wsmap="managed"
14166	>
14167	<desc>
14168	Event source. Generally, any object which could generate events can be an event source,
14169	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14170	an event source can work with listeners in either active or passive mode. In active mode it is up to
14171	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14172	event source keeps track of pending events for each listener and returns available events on demand.
14173
14174	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14175	</desc>
14176
14177	<method name="createListener">
14178	<desc>
14179	Creates a new listener object, useful for passive mode.
14180	</desc>
14181	<param name="listener" type="IEventListener" dir="return"/>
14182	</method>
14183
14184	<method name="registerListener">
14185	<desc>
14186	Register an event listener.
14187
14188	<note>
14189	To avoid system overload, the VirtualBox server process checks if passive event
14190	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14191	current implementation, if more than 100 pending events are detected for a passive
14192	event listener, it is forcefully unregistered by the system, and further
14193	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14194	</note>
14195	</desc>
14196	<param name="listener" type="IEventListener" dir="in">
14197	<desc>Listener to register.</desc>
14198	</param>
14199	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14200	<desc>
14201	Event types listener is interested in. One can use wildcards like -
14202	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14203	than one event.
14204	</desc>
14205	</param>
14206	<param name="active" type="boolean" dir="in">
14207	<desc>
14208	Which mode this listener is operating in.
14209	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14210	In passive mode, an internal event queue is created for this this IEventListener.
14211	For each event coming in, it is added to queues for all interested registered passive
14212	listeners. It is then up to the external code to call the listener's
14213	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14214	external code must call <link to="#eventProcessed" />.
14215	</desc>
14216	</param>
14217	</method>
14218
14219	<method name="unregisterListener">
14220	<desc>
14221	Unregister an event listener. If listener is passive, and some waitable events are still
14222	in queue they are marked as processed automatically.
14223	</desc>
14224	<param name="listener" type="IEventListener" dir="in">
14225	<desc>Listener to unregister.</desc>
14226	</param>
14227	</method>
14228
14229	<method name="fireEvent">
14230	<desc>
14231	Fire an event for this source.
14232	</desc>
14233	<param name="event" type="IEvent" dir="in">
14234	<desc>Event to deliver.</desc>
14235	</param>
14236	<param name="timeout" type="long" dir="in">
14237	<desc>
14238	Maximum time to wait for event processing (if event is waitable), in ms;
14239	0 = no wait, -1 = indefinite wait.
14240	</desc>
14241	</param>
14242	<param name="result" type="boolean" dir="return">
14243	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14244	</param>
14245	</method>
14246
14247	<method name="getEvent">
14248	<desc>
14249	Get events from this peer's event queue (for passive mode). Calling this method
14250	regularly is required for passive event listeners to avoid system overload;
14251	see <link to="IEventSource::registerListener" /> for details.
14252
14253	<result name="VBOX_E_OBJECT_NOT_FOUND">
14254	Listener is not registered, or autounregistered.
14255	</result>
14256	</desc>
14257	<param name="listener" type="IEventListener" dir="in">
14258	<desc>Which listener to get data for.</desc>
14259	</param>
14260	<param name="timeout" type="long" dir="in">
14261	<desc>
14262	Maximum time to wait for events, in ms;
14263	0 = no wait, -1 = indefinite wait.
14264	</desc>
14265	</param>
14266	<param name="event" type="IEvent" dir="return">
14267	<desc>Event retrieved, or null if none available.</desc>
14268	</param>
14269	</method>
14270
14271	<method name="eventProcessed">
14272	<desc>
14273	Must be called for waitable events after a particular listener finished its
14274	event processing. When all listeners of a particular event have called this
14275	method, the system will then call <link to="IEvent::setProcessed" />.
14276	</desc>
14277	<param name="listener" type="IEventListener" dir="in">
14278	<desc>Which listener processed event.</desc>
14279	</param>
14280	<param name="event" type="IEvent" dir="in">
14281	<desc>Which event.</desc>
14282	</param>
14283	</method>
14284
14285	</interface>
14286
14287	<interface
14288	name="IEventListener" extends="$unknown"
14289	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14290	wsmap="managed"
14291	>
14292	<desc>
14293	Event listener. An event listener can work in either active or passive mode, depending on the way
14294	it was registered.
14295	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14296	</desc>
14297
14298	<method name="handleEvent">
14299	<desc>
14300	Handle event callback (called directly by IEventSource in active mode, or could be
14301	called by event processor thread in passive mode).
14302	</desc>
14303	<param name="event" type="IEvent" dir="in">
14304	<desc>Event available.</desc>
14305	</param>
14306	</method>
14307
14308	</interface>
14309
14310	<interface
14311	name="IEvent" extends="$unknown"
14312	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14313	wsmap="managed"
14314	>
14315	<desc>
14316	Abstract parent interface for VirtualBox events. Actual events will typically implement
14317	a more specific interface which derives from this (see below).
14318
14319	<b>Introduction to VirtualBox events</b>
14320
14321	Generally speaking, an event (represented by this interface) signals that something
14322	happened, while an event listener (see <link to="IEventListener" />) represents an
14323	entity that is interested in certain events. In order for this to work with
14324	unidirectional protocols (i.e. web services), the concepts of passive and active
14325	listener are used.
14326
14327	Event consumers can register themselves as listeners, providing an array of
14328	events they are interested in (see <link to="IEventSource::registerListener" />).
14329	When an event triggers, the listener is notified about the event. The exact
14330	mechanism of the notification depends on whether the listener was registered as
14331	an active or passive listener:
14332
14333	<ul>
14334	<li>An active listener is very similar to a callback: it is a function invoked
14335	by the API. As opposed to the callbacks that were used in the API before
14336	VirtualBox 3.3 however, events are now objects with an interface hierarchy.
14337	</li>
14338
14339	<li>Passive listeners are somewhat tricker to implement, but do not require
14340	a client function to be callable, which is not an option with scripting
14341	languages or web service clients. Internally the <link to="IEventSource" />
14342	implementation maintains an event queue for each passive listener, and
14343	newly arrived events are put in this queue. When the listener calls
14344	<link to="IEventSource::getEvent"/>, first element from its internal event
14345	queue is returned. When the client completes processing of an event,
14346	the <link to="IEventSource::eventProcessed" /> function must be called,
14347	acknowledging that the event was processed. It supports implementing
14348	waitable events. On passive listener unregistration, all events from its
14349	queue are auto-acknowledged.
14350	</li>
14351	</ul>
14352
14353	Waitable events are useful in situations where the event generator wants to track
14354	delivery or a party wants to wait until all listeners have completed the event. A
14355	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14356	listeners might veto a certain action, and thus the event producer has to make
14357	sure that all listeners have processed the event and not vetoed before taking
14358	the action.
14359
14360	A given event may have both passive and active listeners at the same time.
14361
14362	<b>Using events</b>
14363
14364	Any VirtualBox object capable of producing externally visible events provides an
14365	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14366	This event source object is notified by VirtualBox once something has happened, so
14367	consumers may register event listeners with this event source. To register a listener,
14368	an object implementing the <link to="IEventListener" /> interface must be provided.
14369	For active listeners, such an object is typically created by the consumer, while for
14370	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14371	note that a listener created with @c createListener() must not be used as an active listener.
14372
14373	Once created, the listener must be registered to listen for the desired events
14374	(see <link to="IEventSource::registerListener" />), providing an array of
14375	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14376	event IDs or wildcards matching multiple event IDs.
14377
14378	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14379	called automatically when the event is triggered, while passive listeners have to call
14380	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14381	an event processing loop.
14382
14383	The IEvent interface is an abstract parent interface for all such VirtualBox events
14384	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14385	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14386	then cast to the appropriate specific interface using @c QueryInterface().
14387	</desc>
14388
14389	<attribute name="type" readonly="yes" type="VBoxEventType">
14390	<desc>
14391	Event type.
14392	</desc>
14393	</attribute>
14394
14395	<attribute name="source" readonly="yes" type="IEventSource">
14396	<desc>
14397	Source of this event.
14398	</desc>
14399	</attribute>
14400
14401	<attribute name="waitable" readonly="yes" type="boolean">
14402	<desc>
14403	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14404	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14405	as no additional overhead associated with waitability imposed.
14406	Waitable events are needed when one need to be able to wait for particular event processed,
14407	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14408	until all consumers confirmed events.
14409	</desc>
14410	</attribute>
14411
14412	<method name="setProcessed">
14413	<desc>
14414	Internal method called by the system when all listeners of a particular event have called
14415	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14416	</desc>
14417	</method>
14418
14419	<method name="waitProcessed">
14420	<desc>
14421	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14422	described semantics, for non-waitable returns true immediately.
14423	</desc>
14424	<param name="timeout" type="long" dir="in">
14425	<desc>
14426	Maximum time to wait for event processeing, in ms;
14427	0 = no wait, -1 = indefinite wait.
14428	</desc>
14429	</param>
14430	<param name="result" type="boolean" dir="return">
14431	<desc>If this event was processed before timeout.</desc>
14432	</param>
14433	</method>
14434	</interface>
14435
14436
14437	<interface
14438	name="IReusableEvent" extends="IEvent"
14439	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14440	wsmap="managed"
14441	>
14442	<desc>Base abstract interface for all reusable events.</desc>
14443
14444	<attribute name="generation" readonly="yes" type="unsigned long">
14445	<desc>Current generation of event, incremented on reuse.</desc>
14446	</attribute>
14447
14448	<method name="reuse">
14449	<desc>
14450	Marks an event as reused, increments 'generation', fields shall no
14451	longer be considered valid.
14452	</desc>
14453	</method>
14454	</interface>
14455
14456	<interface
14457	name="IMachineEvent" extends="IEvent"
14458	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14459	wsmap="managed" id="MachineEvent"
14460	>
14461	<desc>Base abstract interface for all machine events.</desc>
14462
14463	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14464	<desc>ID of the machine this event relates to.</desc>
14465	</attribute>
14466
14467	</interface>
14468
14469	<interface
14470	name="IMachineStateChangedEvent" extends="IMachineEvent"
14471	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14472	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14473	>
14474	<desc>Machine state change event.</desc>
14475
14476	<attribute name="state" readonly="yes" type="MachineState">
14477	<desc>New execution state.</desc>
14478	</attribute>
14479	</interface>
14480
14481	<interface
14482	name="IMachineDataChangedEvent" extends="IMachineEvent"
14483	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14484	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14485	>
14486	<desc>
14487	Any of the settings of the given machine has changed.
14488	</desc>
14489	</interface>
14490
14491	<interface
14492	name="IMediumRegisteredEvent" extends="IEvent"
14493	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14494	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14495	>
14496	<desc>
14497	The given medium was registered or unregistered
14498	within this VirtualBox installation.
14499	</desc>
14500
14501	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14502	<desc>ID of the medium this event relates to.</desc>
14503	</attribute>
14504
14505	<attribute name="mediumType" readonly="yes" type="DeviceType">
14506	<desc>Type of the medium this event relates to.</desc>
14507	</attribute>
14508
14509	<attribute name="registered" type="boolean" readonly="yes">
14510	<desc>
14511	If @c true, the medium was registered, otherwise it was
14512	unregistered.
14513	</desc>
14514	</attribute>
14515	</interface>
14516
14517	<interface
14518	name="IMachineRegisteredEvent" extends="IMachineEvent"
14519	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14520	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14521	>
14522	<desc>
14523	The given machine was registered or unregistered
14524	within this VirtualBox installation.
14525	</desc>
14526
14527	<attribute name="registered" type="boolean" readonly="yes">
14528	<desc>
14529	If @c true, the machine was registered, otherwise it was
14530	unregistered.
14531	</desc>
14532	</attribute>
14533	</interface>
14534
14535	<interface
14536	name="ISessionStateChangedEvent" extends="IMachineEvent"
14537	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14538	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14539	>
14540	<desc>
14541	The state of the session for the given machine was changed.
14542	<see>IMachine::sessionState</see>
14543	</desc>
14544
14545	<attribute name="state" type="SessionState" readonly="yes">
14546	<desc>
14547	New session state.
14548	</desc>
14549	</attribute>
14550	</interface>
14551
14552	<interface
14553	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14554	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14555	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14556	>
14557	<desc>
14558	Notification when a guest property has changed.
14559	</desc>
14560
14561	<attribute name="name" readonly="yes" type="wstring">
14562	<desc>
14563	The name of the property that has changed.
14564	</desc>
14565	</attribute>
14566
14567	<attribute name="value" readonly="yes" type="wstring">
14568	<desc>
14569	The new property value.
14570	</desc>
14571	</attribute>
14572
14573	<attribute name="flags" readonly="yes" type="wstring">
14574	<desc>
14575	The new property flags.
14576	</desc>
14577	</attribute>
14578
14579	</interface>
14580
14581	<interface
14582	name="ISnapshotEvent" extends="IMachineEvent"
14583	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14584	wsmap="managed" id="SnapshotEvent"
14585	>
14586	<desc>Base interface for all snapshot events.</desc>
14587
14588	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14589	<desc>ID of the snapshot this event relates to.</desc>
14590	</attribute>
14591
14592	</interface>
14593
14594	<interface
14595	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14596	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14597	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14598	>
14599	<desc>
14600	A new snapshot of the machine has been taken.
14601	<see>ISnapshot</see>
14602	</desc>
14603	</interface>
14604
14605	<interface
14606	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14607	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14608	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14609	>
14610	<desc>
14611	Snapshot of the given machine has been deleted.
14612
14613	<note>
14614	This notification is delivered <b>after</b> the snapshot
14615	object has been uninitialized on the server (so that any
14616	attempt to call its methods will return an error).
14617	</note>
14618
14619	<see>ISnapshot</see>
14620	</desc>
14621	</interface>
14622
14623	<interface
14624	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14625	uuid="07541941-8079-447a-a33e-47a69c7980db"
14626	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14627	>
14628	<desc>
14629	Snapshot properties (name and/or description) have been changed.
14630	<see>ISnapshot</see>
14631	</desc>
14632	</interface>
14633
14634	<interface
14635	name="IMousePointerShapeChangedEvent" extends="IEvent"
14636	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14637	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14638	>
14639	<desc>
14640	Notification when the guest mouse pointer shape has
14641	changed. The new shape data is given.
14642	</desc>
14643
14644	<attribute name="visible" type="boolean" readonly="yes">
14645	<desc>
14646	Flag whether the pointer is visible.
14647	</desc>
14648	</attribute>
14649	<attribute name="alpha" type="boolean" readonly="yes">
14650	<desc>
14651	Flag whether the pointer has an alpha channel.
14652	</desc>
14653	</attribute>
14654	<attribute name="xhot" type="unsigned long" readonly="yes">
14655	<desc>
14656	The pointer hot spot X coordinate.
14657	</desc>
14658	</attribute>
14659	<attribute name="yhot" type="unsigned long" readonly="yes">
14660	<desc>
14661	The pointer hot spot Y coordinate.
14662	</desc>
14663	</attribute>
14664	<attribute name="width" type="unsigned long" readonly="yes">
14665	<desc>
14666	Width of the pointer shape in pixels.
14667	</desc>
14668	</attribute>
14669	<attribute name="height" type="unsigned long" readonly="yes">
14670	<desc>
14671	Height of the pointer shape in pixels.
14672	</desc>
14673	</attribute>
14674	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14675	<desc>
14676	Shape buffer arrays.
14677
14678	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14679	followed by a 32-bpp XOR (color) mask.
14680
14681	For pointers without alpha channel the XOR mask pixels are 32
14682	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14683	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14684
14685	An AND mask is used for pointers with alpha channel, so if the
14686	callback does not support alpha, the pointer could be
14687	displayed as a normal color pointer.
14688
14689	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14690	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14691	height</tt>. The padding bits at the end of each scanline are
14692	undefined.
14693
14694	The XOR mask follows the AND mask on the next 4-byte aligned
14695	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14696	Bytes in the gap between the AND and the XOR mask are undefined.
14697	The XOR mask scanlines have no gap between them and the size of
14698	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14699
14700	<note>
14701	If @a shape is 0, only the pointer visibility is changed.
14702	</note>
14703	</desc>
14704	</attribute>
14705	</interface>
14706
14707	<interface
14708	name="IMouseCapabilityChangedEvent" extends="IEvent"
14709	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14710	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14711	>
14712	<desc>
14713	Notification when the mouse capabilities reported by the
14714	guest have changed. The new capabilities are passed.
14715	</desc>
14716	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14717	<desc>
14718	Supports absolute coordinates.
14719	</desc>
14720	</attribute>
14721	<attribute name="supportsRelative" type="boolean" readonly="yes">
14722	<desc>
14723	Supports relative coordinates.
14724	</desc>
14725	</attribute>
14726	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14727	<desc>
14728	If host cursor is needed.
14729	</desc>
14730	</attribute>
14731	</interface>
14732
14733	<interface
14734	name="IKeyboardLedsChangedEvent" extends="IEvent"
14735	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14736	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14737	>
14738	<desc>
14739	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14740	to alter the state of the keyboard LEDs.
14741	</desc>
14742	<attribute name="numLock" type="boolean" readonly="yes">
14743	<desc>
14744	NumLock status.
14745	</desc>
14746	</attribute>
14747	<attribute name="capsLock" type="boolean" readonly="yes">
14748	<desc>
14749	CapsLock status.
14750	</desc>
14751	</attribute>
14752	<attribute name="scrollLock" type="boolean" readonly="yes">
14753	<desc>
14754	ScrollLock status.
14755	</desc>
14756	</attribute>
14757	</interface>
14758
14759	<interface
14760	name="IStateChangedEvent" extends="IEvent"
14761	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14762	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14763	>
14764	<desc>
14765	Notification when the execution state of the machine has changed.
14766	The new state is given.
14767	</desc>
14768	<attribute name="state" type="MachineState" readonly="yes">
14769	<desc>
14770	New machine state.
14771	</desc>
14772	</attribute>
14773	</interface>
14774
14775	<interface
14776	name="IAdditionsStateChangedEvent" extends="IEvent"
14777	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14778	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14779	>
14780	<desc>
14781	Notification when a Guest Additions property changes.
14782	Interested callees should query IGuest attributes to
14783	find out what has changed.
14784	</desc>
14785	</interface>
14786
14787	<interface
14788	name="INetworkAdapterChangedEvent" extends="IEvent"
14789	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14790	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14791	>
14792	<desc>
14793	Notification when a property of one of the
14794	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14795	changes. Interested callees should use INetworkAdapter methods and
14796	attributes to find out what has changed.
14797	</desc>
14798	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14799	<desc>
14800	Network adapter that is subject to change.
14801	</desc>
14802	</attribute>
14803	</interface>
14804
14805	<interface
14806	name="ISerialPortChangedEvent" extends="IEvent"
14807	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14808	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14809	>
14810	<desc>
14811	Notification when a property of one of the
14812	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14813	Interested callees should use ISerialPort methods and attributes
14814	to find out what has changed.
14815	</desc>
14816	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14817	<desc>
14818	Serial port that is subject to change.
14819	</desc>
14820	</attribute>
14821	</interface>
14822
14823	<interface
14824	name="IParallelPortChangedEvent" extends="IEvent"
14825	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
14826	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
14827	>
14828	<desc>
14829	Notification when a property of one of the
14830	virtual <link to="IMachine::getParallelPort">parallel ports</link>
14831	changes. Interested callees should use ISerialPort methods and
14832	attributes to find out what has changed.
14833	</desc>
14834	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
14835	<desc>
14836	Parallel port that is subject to change.
14837	</desc>
14838	</attribute>
14839	</interface>
14840
14841	<interface
14842	name="IStorageControllerChangedEvent" extends="IEvent"
14843	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
14844	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
14845	>
14846	<desc>
14847	Notification when a
14848	<link to="IMachine::mediumAttachments">medium attachment</link>
14849	changes.
14850	</desc>
14851	</interface>
14852
14853	<interface
14854	name="IMediumChangedEvent" extends="IEvent"
14855	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
14856	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
14857	>
14858	<desc>
14859	Notification when a
14860	<link to="IMachine::mediumAttachments">medium attachment</link>
14861	changes.
14862	</desc>
14863	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
14864	<desc>
14865	Medium attachment that is subject to change.
14866	</desc>
14867	</attribute>
14868	</interface>
14869
14870	<interface
14871	name="ICPUChangedEvent" extends="IEvent"
14872	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
14873	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
14874	>
14875	<desc>
14876	Notification when a CPU changes.
14877	</desc>
14878	<attribute name="cpu" type="unsigned long" readonly="yes">
14879	<desc>
14880	The CPU which changed.
14881	</desc>
14882	</attribute>
14883	<attribute name="add" type="boolean" readonly="yes">
14884	<desc>
14885	Flag whether the CPU was added or removed.
14886	</desc>
14887	</attribute>
14888	</interface>
14889
14890	<interface
14891	name="ICPUExecutionCapChangedEvent" extends="IEvent"
14892	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
14893	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
14894	>
14895	<desc>
14896	Notification when the CPU execution cap changes.
14897	</desc>
14898	<attribute name="executionCap" type="unsigned long" readonly="yes">
14899	<desc>
14900	The new CPU execution cap value. (1-100)
14901	</desc>
14902	</attribute>
14903	</interface>
14904
14905	<interface
14906	name="IVRDPServerChangedEvent" extends="IEvent"
14907	uuid="726038B6-6279-4A7A-8037-D041693D1915"
14908	wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
14909	>
14910	<desc>
14911	Notification when a property of the
14912	<link to="IMachine::VRDPServer">VRDP server</link> changes.
14913	Interested callees should use IVRDPServer methods and attributes to
14914	find out what has changed.
14915	</desc>
14916	</interface>
14917
14918	<interface
14919	name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
14920	uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
14921	wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
14922	>
14923	<desc>
14924	Notification when the status of the VRDP server changes. Interested callees
14925	should use <link to="IConsole::remoteDisplayInfo">IRemoteDisplayInfo</link>
14926	attributes to find out what is the current status.
14927	</desc>
14928	</interface>
14929
14930	<interface
14931	name="IUSBControllerChangedEvent" extends="IEvent"
14932	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
14933	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
14934	>
14935	<desc>
14936	Notification when a property of the virtual
14937	<link to="IMachine::USBController">USB controller</link> changes.
14938	Interested callees should use IUSBController methods and attributes to
14939	find out what has changed.
14940	</desc>
14941	</interface>
14942
14943	<interface
14944	name="IUSBDeviceStateChangedEvent" extends="IEvent"
14945	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
14946	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
14947	>
14948	<desc>
14949	Notification when a USB device is attached to or detached from
14950	the virtual USB controller.
14951
14952	This notification is sent as a result of the indirect
14953	request to attach the device because it matches one of the
14954	machine USB filters, or as a result of the direct request
14955	issued by <link to="IConsole::attachUSBDevice"/> or
14956	<link to="IConsole::detachUSBDevice"/>.
14957
14958	This notification is sent in case of both a succeeded and a
14959	failed request completion. When the request succeeds, the
14960	@a error parameter is @c null, and the given device has been
14961	already added to (when @a attached is @c true) or removed from
14962	(when @a attached is @c false) the collection represented by
14963	<link to="IConsole::USBDevices"/>. On failure, the collection
14964	doesn't change and the @a error parameter represents the error
14965	message describing the failure.
14966	</desc>
14967	<attribute name="device" type="IUSBDevice" readonly="yes">
14968	<desc>
14969	Device that is subject to state change.
14970	</desc>
14971	</attribute>
14972	<attribute name="attached" type="boolean" readonly="yes">
14973	<desc>
14974	@c true if the device was attached and @c false otherwise.
14975	</desc>
14976	</attribute>
14977	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
14978	<desc>
14979	@c null on success or an error message object on failure.
14980	</desc>
14981	</attribute>
14982	</interface>
14983
14984	<interface
14985	name="ISharedFolderChangedEvent" extends="IEvent"
14986	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
14987	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
14988	>
14989	<desc>
14990	Notification when a shared folder is added or removed.
14991	The @a scope argument defines one of three scopes:
14992	<link to="IVirtualBox::sharedFolders">global shared folders</link>
14993	(<link to="Scope_Global">Global</link>),
14994	<link to="IMachine::sharedFolders">permanent shared folders</link> of
14995	the machine (<link to="Scope_Machine">Machine</link>) or <link
14996	to="IConsole::sharedFolders">transient shared folders</link> of the
14997	machine (<link to="Scope_Session">Session</link>). Interested callees
14998	should use query the corresponding collections to find out what has
14999	changed.
15000	</desc>
15001	<attribute name="scope" type="Scope" readonly="yes">
15002	<desc>
15003	Scope of the notification.
15004	</desc>
15005	</attribute>
15006	</interface>
15007
15008	<interface
15009	name="IRuntimeErrorEvent" extends="IEvent"
15010	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15011	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15012	>
15013	<desc>
15014	Notification when an error happens during the virtual
15015	machine execution.
15016
15017	There are three kinds of runtime errors:
15018	<ul>
15019	<li><i>fatal</i></li>
15020	<li><i>non-fatal with retry</i></li>
15021	<li><i>non-fatal warnings</i></li>
15022	</ul>
15023
15024	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15025	to @c true. In case of fatal errors, the virtual machine
15026	execution is always paused before calling this notification, and
15027	the notification handler is supposed either to immediately save
15028	the virtual machine state using <link to="IConsole::saveState"/>
15029	or power it off using <link to="IConsole::powerDown"/>.
15030	Resuming the execution can lead to unpredictable results.
15031
15032	<b>Non-fatal</b> errors and warnings are indicated by the
15033	@a fatal parameter set to @c false. If the virtual machine
15034	is in the Paused state by the time the error notification is
15035	received, it means that the user can <i>try to resume</i> the machine
15036	execution after attempting to solve the problem that caused the
15037	error. In this case, the notification handler is supposed
15038	to show an appropriate message to the user (depending on the
15039	value of the @a id parameter) that offers several actions such
15040	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15041	wants to retry, the notification handler should continue
15042	the machine execution using the <link to="IConsole::resume"/>
15043	call. If the machine execution is not Paused during this
15044	notification, then it means this notification is a <i>warning</i>
15045	(for example, about a fatal condition that can happen very soon);
15046	no immediate action is required from the user, the machine
15047	continues its normal execution.
15048
15049	Note that in either case the notification handler
15050	<b>must not</b> perform any action directly on a thread
15051	where this notification is called. Everything it is allowed to
15052	do is to post a message to another thread that will then talk
15053	to the user and take the corresponding action.
15054
15055	Currently, the following error identifiers are known:
15056	<ul>
15057	<li><tt>"HostMemoryLow"</tt></li>
15058	<li><tt>"HostAudioNotResponding"</tt></li>
15059	<li><tt>"VDIStorageFull"</tt></li>
15060	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15061	</ul>
15062	</desc>
15063	<attribute name="fatal" type="boolean" readonly="yes">
15064	<desc>
15065	Whether the error is fatal or not.
15066	</desc>
15067	</attribute>
15068	<attribute name="id" type="wstring" readonly="yes">
15069	<desc>
15070	Error identifier.
15071	</desc>
15072	</attribute>
15073	<attribute name="message" type="wstring" readonly="yes">
15074	<desc>
15075	Optional error message.
15076	</desc>
15077	</attribute>
15078	</interface>
15079
15080
15081	<interface
15082	name="IEventSourceChangedEvent" extends="IEvent"
15083	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15084	waitable="yes"
15085	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15086	>
15087	<desc>
15088	Notification when an event source state changes (listener added or removed).
15089	</desc>
15090
15091	<attribute name="listener" type="IEventListener" readonly="yes">
15092	<desc>
15093	Event listener which has changed.
15094	</desc>
15095	</attribute>
15096
15097	<attribute name="add" type="boolean" readonly="yes">
15098	<desc>
15099	Flag whether listener was added or removed.
15100	</desc>
15101	</attribute>
15102	</interface>
15103
15104	<interface
15105	name="IExtraDataChangedEvent" extends="IEvent"
15106	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15107	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15108	>
15109	<desc>
15110	Notification when machine specific or global extra data
15111	has changed.
15112	</desc>
15113	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15114	<desc>
15115	ID of the machine this event relates to.
15116	Null for global extra data changes.
15117	</desc>
15118	</attribute>
15119	<attribute name="key" type="wstring" readonly="yes">
15120	<desc>
15121	Extra data key that has changed.
15122	</desc>
15123	</attribute>
15124	<attribute name="value" type="wstring" readonly="yes">
15125	<desc>
15126	Extra data value for the given key.
15127	</desc>
15128	</attribute>
15129	</interface>
15130
15131	<interface
15132	name="IVetoEvent" extends="IEvent"
15133	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15134	wsmap="managed"
15135	>
15136	<desc>Base abstract interface for veto events.</desc>
15137
15138	<method name="addVeto">
15139	<desc>
15140	Adds a veto on this event.
15141	</desc>
15142	<param name="reason" type="wstring" dir="in">
15143	<desc>
15144	Reason for veto, could be null or empty string.
15145	</desc>
15146	</param>
15147	</method>
15148
15149	<method name="isVetoed">
15150	<desc>
15151	If this event was vetoed.
15152	</desc>
15153	<param name="result" type="boolean" dir="return">
15154	<desc>
15155	Reason for veto.
15156	</desc>
15157	</param>
15158	</method>
15159
15160	<method name="getVetos">
15161	<desc>
15162	Current veto reason list, if size is 0 - no veto.
15163	</desc>
15164	<param name="result" type="wstring" dir="return" safearray="yes">
15165	<desc>
15166	Array of reasons for veto provided by different event handlers.
15167	</desc>
15168	</param>
15169	</method>
15170
15171	</interface>
15172
15173	<interface
15174	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15175	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15176	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15177	waitable="true"
15178	>
15179	<desc>
15180	Notification when someone tries to change extra data for
15181	either the given machine or (if @c null) global extra data.
15182	This gives the chance to veto against changes.
15183	</desc>
15184	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15185	<desc>
15186	ID of the machine this event relates to.
15187	Null for global extra data changes.
15188	</desc>
15189	</attribute>
15190	<attribute name="key" type="wstring" readonly="yes">
15191	<desc>
15192	Extra data key that has changed.
15193	</desc>
15194	</attribute>
15195	<attribute name="value" type="wstring" readonly="yes">
15196	<desc>
15197	Extra data value for the given key.
15198	</desc>
15199	</attribute>
15200	</interface>
15201
15202	<interface
15203	name="ICanShowWindowEvent" extends="IVetoEvent"
15204	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15205	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15206	waitable="true"
15207	>
15208	<desc>
15209	Notification when a call to
15210	<link to="IMachine::canShowConsoleWindow"/> is made by a
15211	front-end to check if a subsequent call to
15212	<link to="IMachine::showConsoleWindow"/> can succeed.
15213
15214	The callee should give an answer appropriate to the current
15215	machine state using event veto. This answer must
15216	remain valid at least until the next
15217	<link to="IConsole::state">machine state</link> change.
15218	</desc>
15219	</interface>
15220
15221	<interface
15222	name="IShowWindowEvent" extends="IEvent"
15223	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15224	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15225	waitable="true"
15226	>
15227	<desc>
15228	Notification when a call to
15229	<link to="IMachine::showConsoleWindow"/>
15230	requests the console window to be activated and brought to
15231	foreground on the desktop of the host PC.
15232
15233	This notification should cause the VM console process to
15234	perform the requested action as described above. If it is
15235	impossible to do it at a time of this notification, this
15236	method should return a failure.
15237
15238	Note that many modern window managers on many platforms
15239	implement some sort of focus stealing prevention logic, so
15240	that it may be impossible to activate a window without the
15241	help of the currently active application (which is supposedly
15242	an initiator of this notification). In this case, this method
15243	must return a non-zero identifier that represents the
15244	top-level window of the VM console process. The caller, if it
15245	represents a currently active process, is responsible to use
15246	this identifier (in a platform-dependent manner) to perform
15247	actual window activation.
15248
15249	This method must set @a winId to zero if it has performed all
15250	actions necessary to complete the request and the console
15251	window is now active and in foreground, to indicate that no
15252	further action is required on the caller's side.
15253	</desc>
15254	<attribute name="winId" type="long long">
15255	<desc>
15256	Platform-dependent identifier of the top-level VM console
15257	window, or zero if this method has performed all actions
15258	necessary to implement the <i>show window</i> semantics for
15259	the given platform and/or this VirtualBox front-end.
15260	</desc>
15261	</attribute>
15262	</interface>
15263
15264	<module name="VBoxSVC" context="LocalServer">
15265	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15266	namespace="virtualbox.org">
15267	<interface name="IVirtualBox" default="yes"/>
15268	</class>
15269	</module>
15270
15271	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15272	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15273	namespace="virtualbox.org">
15274	<interface name="ISession" default="yes"/>
15275	</class>
15276
15277	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15278	namespace="virtualbox.org">
15279	<interface name="IConsole" default="yes"/>
15280	</class>
15281	</module>
15282
15283	</library>
15284
15285	</idl>
15286
15287	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format