VirtualBox.xidl@ 33295

Last change on this file since 33295 was 33295, checked in by vboxsync, 14 years ago
Main: support aggregation of multiple event sources into one, to allow listen on multiple event sources without heavy polling (pretty much what select() do with fds)
Property svn:eol-style set to `native`
File size: 561.8 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="5e887b09-e3f3-4787-b9f3-8ade5d04d675"
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	<method name="composeMachineFilename">
1517	<desc>
1518	Returns the full path of the settings file name that <link to="#createMachine" />
1519	would use. This method gets called by createMachine(), but calling this method
1520	independently might be helpful if one needs to create the machine directory
1521	to place files (such as disk images) there before actually creating the machine.
1522
1523	See the <link to="IMachine::name"/> attribute description for more details about
1524	the machine name.
1525
1526	Every machine has a <i>settings file</i> that is used to store
1527	the machine configuration. This file is stored in a directory called the
1528	<i>machine settings subfolder</i>. Both the settings subfolder and file
1529	will have a name that corresponds to the name of the virtual machine.
1530	You can specify where to create the machine setting subfolder using the
1531	@a baseFolder argument. The base folder can be absolute (full path) or
1532	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1533	directory</link>.
1534
1535	If @a baseFolder is a @c null or empty string (which is recommended), the
1536	<link to="ISystemProperties::defaultMachineFolder">default machine
1537	settings folder</link> will be used as a base folder for the created
1538	machine. Otherwise the given base folder will be used. In either case,
1539	the full path to the resulting settings file has the following
1540	structure:
1541	<pre>
1542	<base_folder>/<machine_name>/<machine_name>.xml
1543	</pre>
1544
1545
1546	This method does not access the host disks. In particular, it does not check for
1547	whether a machine of this name already exists.
1548	</desc>
1549	<param name="name" type="wstring" dir="in">
1550	<desc>Suggested machine name.</desc>
1551	</param>
1552	<param name="baseFolder" type="wstring" dir="in">
1553	<desc>Base machine folder (optional).</desc>
1554	</param>
1555	<param name="file" type="wstring" dir="return">
1556	<desc>Fully qualified path where the machine would be created.</desc>
1557	</param>
1558	</method>
1559
1560	<method name="createMachine">
1561	<desc>
1562	Creates a new virtual machine.
1563
1564	The new machine is created unregistered, with the initial configuration
1565	set according to the specified guest OS type. A typical sequence of
1566	actions to create a new virtual machine is as follows:
1567
1568	<ol>
1569	<li>
1570	Call this method to have a new machine created. The returned machine
1571	object will be "mutable" allowing to change any machine property.
1572	</li>
1573
1574	<li>
1575	Configure the machine using the appropriate attributes and methods.
1576	</li>
1577
1578	<li>
1579	Call <link to="IMachine::saveSettings" /> to write the settings
1580	to the machine's XML settings file. The configuration of the newly
1581	created machine will not be saved to disk until this method is
1582	called.
1583	</li>
1584
1585	<li>
1586	Call <link to="#registerMachine" /> to add the machine to the list
1587	of machines known to VirtualBox.
1588	</li>
1589	</ol>
1590
1591	The specified guest OS type identifier must match an ID of one of known
1592	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1593	array.
1594
1595	This method uses the <link to="#composeMachineFilename" /> method to determine
1596	where to create the machine's directory and settings file. Please refer
1597	to the additional remarks and restrictions there.
1598
1599	If the resulting settings file already exists, this method will fail
1600	with <link to="VBOX_E_FILE_ERROR"/>.
1601
1602	Optionally, you may specify an UUID of to assign to the created machine.
1603	However, this is not recommended and you should normally pass an empty
1604	(@c null) UUID to this method so that a new UUID will be automatically
1605	generated for every created machine. You can use UUID
1606	00000000-0000-0000-0000-000000000000 as @c null value.
1607
1608	<note>
1609	There is no way to change the name of the settings file or
1610	subfolder of the created machine directly.
1611	</note>
1612
1613	<result name="VBOX_E_OBJECT_NOT_FOUND">
1614	@a osTypeId is invalid.
1615	</result>
1616	<result name="VBOX_E_FILE_ERROR">
1617	Resulting settings file name is invalid or the settings file already
1618	exists or could not be created due to an I/O error.
1619	</result>
1620	<result name="E_INVALIDARG">
1621	@a name is empty or @c null.
1622	</result>
1623	</desc>
1624
1625	<param name="name" type="wstring" dir="in">
1626	<desc>Machine name.</desc>
1627	</param>
1628	<param name="osTypeId" type="wstring" dir="in">
1629	<desc>Guest OS Type ID.</desc>
1630	</param>
1631	<param name="baseFolder" type="wstring" dir="in">
1632	<desc>Base machine folder (optional).</desc>
1633	</param>
1634	<param name="id" type="uuid" mod="string" dir="in">
1635	<desc>Machine UUID (optional).</desc>
1636	</param>
1637	<param name="override" type="boolean" dir="in">
1638	<desc>Create the VM even if there are conflicting files.</desc>
1639	</param>
1640	<param name="machine" type="IMachine" dir="return">
1641	<desc>Created machine object.</desc>
1642	</param>
1643	</method>
1644
1645	<method name="openMachine">
1646	<desc>
1647	Opens a virtual machine from the existing settings file.
1648	The opened machine remains unregistered until you call
1649	<link to="#registerMachine"/>.
1650
1651	The specified settings file name can be absolute
1652	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1653	VirtualBox home directory</link>. This file must exist
1654	and must be a valid machine settings file whose contents
1655	will be used to construct the machine object.
1656
1657	<result name="VBOX_E_FILE_ERROR">
1658	Settings file name invalid, not found or sharing violation.
1659	</result>
1660	</desc>
1661	<param name="settingsFile" type="wstring" dir="in">
1662	<desc>
1663	Name of the machine settings file.
1664	</desc>
1665	</param>
1666	<param name="machine" type="IMachine" dir="return">
1667	<desc>Opened machine object.</desc>
1668	</param>
1669	<note>
1670	<link to="IMachine::settingsModified"/> will return
1671	@c false for the created machine, until any of machine settings
1672	are changed.
1673	</note>
1674	</method>
1675
1676	<method name="registerMachine">
1677	<desc>
1678
1679	Registers the machine previously created using
1680	<link to="#createMachine"/> or opened using
1681	<link to="#openMachine"/> within this VirtualBox installation. After
1682	successful method invocation, the
1683	<link to="IMachineRegisteredEvent"/> event is fired.
1684
1685	<note>
1686	This method implicitly calls <link to="IMachine::saveSettings"/>
1687	to save all current machine settings before registering it.
1688	</note>
1689
1690	<result name="VBOX_E_OBJECT_NOT_FOUND">
1691	No matching virtual machine found.
1692	</result>
1693	<result name="VBOX_E_INVALID_OBJECT_STATE">
1694	Virtual machine was not created within this VirtualBox instance.
1695	</result>
1696
1697	</desc>
1698	<param name="machine" type="IMachine" dir="in"/>
1699	</method>
1700
1701	<method name="findMachine">
1702	<desc>
1703	Attempts to find a virtual machine given its name or UUID.
1704
1705	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1706	cannot safely be determined.</note>
1707
1708	<result name="VBOX_E_OBJECT_NOT_FOUND">
1709	Could not find registered machine matching @a nameOrId.
1710	</result>
1711
1712	</desc>
1713	<param name="nameOrId" type="wstring" dir="in">
1714	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1715	</param>
1716	<param name="machine" type="IMachine" dir="return">
1717	<desc>Machine object, if found.</desc>
1718	</param>
1719	</method>
1720
1721	<method name="createAppliance">
1722	<desc>
1723	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1724	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1725	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1726	</desc>
1727	<param name="appliance" type="IAppliance" dir="return">
1728	<desc>New appliance.</desc>
1729	</param>
1730	</method>
1731
1732	<method name="createHardDisk">
1733	<desc>
1734	Creates a new base medium object that will use the given storage
1735	format and location for medium data.
1736
1737	Note that the actual storage unit is not created by this method. In
1738	order to do it, and before you are able to attach the created medium
1739	to virtual machines, you must call one of the following methods to
1740	allocate a format-specific storage unit at the specified location:
1741	<ul>
1742	<li><link to="IMedium::createBaseStorage"/></li>
1743	<li><link to="IMedium::createDiffStorage"/></li>
1744	</ul>
1745
1746	Some medium attributes, such as <link to="IMedium::id"/>, may
1747	remain uninitialized until the medium storage unit is successfully
1748	created by one of the above methods.
1749
1750	After the storage unit is successfully created, it will be
1751	accessible through the <link to="#findMedium"/> method and can
1752	be found in the <link to="#hardDisks"/> array.
1753
1754	The list of all storage formats supported by this VirtualBox
1755	installation can be obtained using
1756	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1757	attribute is empty or @c null then the default storage format
1758	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1759	be used for creating a storage unit of the medium.
1760
1761	Note that the format of the location string is storage format specific.
1762	See <link to="IMedium::location"/> and IMedium for more details.
1763
1764	<result name="VBOX_E_OBJECT_NOT_FOUND">
1765	@a format identifier is invalid. See
1766	<link to="ISystemProperties::mediumFormats"/>.
1767	</result>
1768	<result name="VBOX_E_FILE_ERROR">
1769	@a location is a not valid file name (for file-based formats only).
1770	</result>
1771	</desc>
1772	<param name="format" type="wstring" dir="in">
1773	<desc>
1774	Identifier of the storage format to use for the new medium.
1775	</desc>
1776	</param>
1777	<param name="location" type="wstring" dir="in">
1778	<desc>
1779	Location of the storage unit for the new medium.
1780	</desc>
1781	</param>
1782	<param name="medium" type="IMedium" dir="return">
1783	<desc>Created medium object.</desc>
1784	</param>
1785	</method>
1786
1787	<method name="openMedium">
1788	<desc>
1789	Opens a medium from an existing storage location.
1790
1791	Once a medium has been opened, it can be passed to other VirtualBox
1792	methods, in particular to <link to="IMachine::attachDevice" />.
1793
1794	Depending on the given device type, the file at the storage location
1795	must be in one of the media formats understood by VirtualBox:
1796
1797	<ul>
1798	<li>With a "HardDisk" device type, the file must be a hard disk image
1799	in one of the formats supported by VirtualBox (see
1800	<link to="ISystemProperties::mediumFormats" />).
1801	After this method succeeds, if the medium is a base medium, it
1802	will be added to the <link to="#hardDisks"/> array attribute. </li>
1803	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1804	After this method succeeds, the medium will be added to the
1805	<link to="#DVDImages"/> array attribute.</li>
1806	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1807	After this method succeeds, the medium will be added to the
1808	<link to="#floppyImages"/> array attribute.</li>
1809	</ul>
1810
1811	After having been opened, the medium can be found by the <link to="#findMedium"/>
1812	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1813
1814	The UUID of the newly opened medium will either be retrieved from the
1815	storage location, if the format supports it (e.g. for hard disk images),
1816	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1817	If for some reason you need to change the medium's UUID, use
1818	<link to="IMedium::setIDs" />.
1819
1820	If a differencing hard disk medium is to be opened by this method, the
1821	operation will succeed only if its parent medium and all ancestors,
1822	if any, are already known to this VirtualBox installation (for example,
1823	were opened by this method before).
1824
1825	This method attempts to guess the storage format of the specified medium
1826	by reading medium data at the specified location.
1827
1828	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1829	the image is opened for read/write access and must have according permissions,
1830	as VirtualBox may actually write status information into the disk's metadata
1831	sections.
1832
1833	Note that write access is required for all typical hard disk usage in VirtualBox,
1834	since VirtualBox may need to write metadata such as a UUID into the image.
1835	The only exception is opening a source image temporarily for copying and
1836	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1837	again soon.
1838
1839	The format of the location string is storage format specific. See
1840	<link to="IMedium::location"/> and IMedium for more details.
1841
1842	Prior to VirtualBox 3.3, opening a medium added it to a global media
1843	registry in the VirtualBox.xml file, which was shared between
1844	all machines and made transporting machines and their media from one
1845	host to another difficult.
1846
1847	Starting with VirtualBox 3.3, media are only added to a registry when
1848	they are attached to a machine. Machines created with VirtualBox 3.3
1849	or later can have their own media registry. As a result, a medium attached
1850	to such a machine will be remembered in that machine's XML settings file.
1851	Media attached to older machines will continue to be added to the global
1852	registry.
1853
1854	<result name="VBOX_E_FILE_ERROR">
1855	Invalid medium storage file location or could not find the medium
1856	at the specified location.
1857	</result>
1858	<result name="VBOX_E_IPRT_ERROR">
1859	Could not get medium storage format.
1860	</result>
1861	<result name="E_INVALIDARG">
1862	Invalid medium storage format.
1863	</result>
1864	<result name="VBOX_E_INVALID_OBJECT_STATE">
1865	Medium has already been added to a media registry.
1866	</result>
1867	</desc>
1868	<param name="location" type="wstring" dir="in">
1869	<desc>
1870	Location of the storage unit that contains medium data in one of
1871	the supported storage formats.
1872	</desc>
1873	</param>
1874	<param name="deviceType" type="DeviceType" dir="in">
1875	<desc>
1876	Must be one of "HardDisk", "DVD" or "Floppy".
1877	</desc>
1878	</param>
1879	<param name="accessMode" type="AccessMode" dir="in">
1880	<desc>Whether to open the image in read/write or read-only mode. For
1881	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1882	</param>
1883	<param name="medium" type="IMedium" dir="return">
1884	<desc>Opened medium object.</desc>
1885	</param>
1886	</method>
1887
1888	<method name="findMedium">
1889	<desc>
1890	Returns a medium of the given type that uses the given fully qualified
1891	location or UUID to store medium data.
1892
1893	The given medium must be known to this VirtualBox installation, i.e.
1894	it must be previously created by <link to="#createHardDisk"/> or opened
1895	by <link to="#openMedium"/>.
1896
1897	The search is done by comparing the value of the @a location argument to
1898	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1899	attributes of each known medium.
1900
1901	On case sensitive file systems, a case sensitive comparison is performed,
1902	otherwise the case of symbols in the file path is ignored.
1903
1904	<result name="VBOX_E_OBJECT_NOT_FOUND">
1905	No medium object matching @a location found.
1906	</result>
1907	</desc>
1908	<param name="location" type="wstring" dir="in">
1909	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1910	</param>
1911	<param name="type" type="DeviceType" dir="in">
1912	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1913	</param>
1914	<param name="medium" type="IMedium" dir="return">
1915	<desc>Medium object, if found.</desc>
1916	</param>
1917	</method>
1918
1919	<method name="getGuestOSType">
1920	<desc>
1921	Returns an object describing the specified guest OS type.
1922
1923	The requested guest OS type is specified using a string which is a
1924	mnemonic identifier of the guest operating system, such as
1925	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1926	particular virtual machine can be read or set using the
1927	<link to="IMachine::OSTypeId"/> attribute.
1928
1929	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1930	available guest OS type objects. Each object has an
1931	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1932	the guest OS this object describes.
1933
1934	<result name="E_INVALIDARG">
1935	@a id is not a valid Guest OS type.
1936	</result>
1937
1938	</desc>
1939	<param name="id" type="uuid" mod="string" dir="in">
1940	<desc>Guest OS type ID string.</desc>
1941	</param>
1942	<param name="type" type="IGuestOSType" dir="return">
1943	<desc>Guest OS type object.</desc>
1944	</param>
1945	</method>
1946
1947	<method name="createSharedFolder">
1948	<desc>
1949	Creates a new global shared folder by associating the given logical
1950	name with the given host path, adds it to the collection of shared
1951	folders and starts sharing it. Refer to the description of
1952	<link to="ISharedFolder"/> to read more about logical names.
1953	<note>
1954	In the current implementation, this operation is not
1955	implemented.
1956	</note>
1957	</desc>
1958	<param name="name" type="wstring" dir="in">
1959	<desc>Unique logical name of the shared folder.</desc>
1960	</param>
1961	<param name="hostPath" type="wstring" dir="in">
1962	<desc>Full path to the shared folder in the host file system.</desc>
1963	</param>
1964	<param name="writable" type="boolean" dir="in">
1965	<desc>Whether the share is writable or readonly</desc>
1966	</param>
1967	<param name="automount" type="boolean" dir="in">
1968	<desc>Whether the share gets automatically mounted by the guest
1969	or not.</desc>
1970	</param>
1971	</method>
1972
1973	<method name="removeSharedFolder">
1974	<desc>
1975	Removes the global shared folder with the given name previously
1976	created by <link to="#createSharedFolder"/> from the collection of
1977	shared folders and stops sharing it.
1978	<note>
1979	In the current implementation, this operation is not
1980	implemented.
1981	</note>
1982	</desc>
1983	<param name="name" type="wstring" dir="in">
1984	<desc>Logical name of the shared folder to remove.</desc>
1985	</param>
1986	</method>
1987
1988	<method name="getExtraDataKeys">
1989	<desc>
1990	Returns an array representing the global extra data keys which currently
1991	have values defined.
1992	</desc>
1993	<param name="value" type="wstring" dir="return" safearray="yes">
1994	<desc>Array of extra data keys.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="getExtraData">
1999	<desc>
2000	Returns associated global extra data.
2001
2002	If the requested data @a key does not exist, this function will
2003	succeed and return an empty string in the @a value argument.
2004
2005	<result name="VBOX_E_FILE_ERROR">
2006	Settings file not accessible.
2007	</result>
2008	<result name="VBOX_E_XML_ERROR">
2009	Could not parse the settings file.
2010	</result>
2011
2012	</desc>
2013	<param name="key" type="wstring" dir="in">
2014	<desc>Name of the data key to get.</desc>
2015	</param>
2016	<param name="value" type="wstring" dir="return">
2017	<desc>Value of the requested data key.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="setExtraData">
2022	<desc>
2023	Sets associated global extra data.
2024
2025	If you pass @c null or empty string as a key @a value, the given @a key
2026	will be deleted.
2027
2028	<note>
2029	Before performing the actual data change, this method will ask all
2030	registered event listener using the
2031	<link to="IExtraDataCanChangeEvent"/>
2032	notification for a permission. If one of the listeners refuses the
2033	new value, the change will not be performed.
2034	</note>
2035	<note>
2036	On success, the
2037	<link to="IExtraDataChangedEvent"/> notification
2038	is called to inform all registered listeners about a successful data
2039	change.
2040	</note>
2041
2042	<result name="VBOX_E_FILE_ERROR">
2043	Settings file not accessible.
2044	</result>
2045	<result name="VBOX_E_XML_ERROR">
2046	Could not parse the settings file.
2047	</result>
2048	<result name="E_ACCESSDENIED">
2049	Modification request refused.
2050	</result>
2051
2052	</desc>
2053	<param name="key" type="wstring" dir="in">
2054	<desc>Name of the data key to set.</desc>
2055	</param>
2056	<param name="value" type="wstring" dir="in">
2057	<desc>Value to assign to the key.</desc>
2058	</param>
2059	</method>
2060
2061	<!--method name="createDHCPServerForInterface">
2062	<desc>
2063	Creates a dhcp server settings to be used for the given interface
2064	<result name="E_INVALIDARG">
2065	Host network interface @a name already exists.
2066	</result>
2067	</desc>
2068	<param name="interface" type="IHostNetworkInterface" dir="in">
2069	<desc>Network Interface</desc>
2070	</param>
2071	<param name="server" type="IDHCPServer" dir="out">
2072	<desc>Dhcp server settings</desc>
2073	</param>
2074	</method-->
2075
2076	<method name="createDHCPServer">
2077	<desc>
2078	Creates a dhcp server settings to be used for the given internal network name
2079	<result name="E_INVALIDARG">
2080	Host network interface @a name already exists.
2081	</result>
2082	</desc>
2083	<param name="name" type="wstring" dir="in">
2084	<desc>server name</desc>
2085	</param>
2086	<param name="server" type="IDHCPServer" dir="return">
2087	<desc>Dhcp server settings</desc>
2088	</param>
2089	</method>
2090
2091	<method name="findDHCPServerByNetworkName">
2092	<desc>
2093	Searches a dhcp server settings to be used for the given internal network name
2094	<result name="E_INVALIDARG">
2095	Host network interface @a name already exists.
2096	</result>
2097
2098	</desc>
2099	<param name="name" type="wstring" dir="in">
2100	<desc>server name</desc>
2101	</param>
2102	<param name="server" type="IDHCPServer" dir="return">
2103	<desc>Dhcp server settings</desc>
2104	</param>
2105	</method>
2106
2107	<!--method name="findDHCPServerForInterface">
2108	<desc>
2109	Searches a dhcp server settings to be used for the given interface
2110	<result name="E_INVALIDARG">
2111	Host network interface @a name already exists.
2112	</result>
2113	</desc>
2114	<param name="interface" type="IHostNetworkInterface" dir="in">
2115	<desc>Network Interface</desc>
2116	</param>
2117	<param name="server" type="IDHCPServer" dir="out">
2118	<desc>Dhcp server settings</desc>
2119	</param>
2120	</method-->
2121
2122	<method name="removeDHCPServer">
2123	<desc>
2124	Removes the dhcp server settings
2125	<result name="E_INVALIDARG">
2126	Host network interface @a name already exists.
2127	</result>
2128	</desc>
2129	<param name="server" type="IDHCPServer" dir="in">
2130	<desc>Dhcp server settings to be removed</desc>
2131	</param>
2132	</method>
2133
2134
2135	<method name="checkFirmwarePresent">
2136	<desc>
2137	Check if this VirtualBox installation has a firmware
2138	of the given type available, either system-wide or per-user.
2139	Optionally, this may return a hint where this firmware can be
2140	downloaded from.
2141	</desc>
2142	<param name="firmwareType" type="FirmwareType" dir="in">
2143	<desc>
2144	Type of firmware to check.
2145	</desc>
2146	</param>
2147	<param name="version" type="wstring" dir="in">
2148	<desc>Expected version number, usually empty string (presently ignored).</desc>
2149	</param>
2150
2151	<param name="url" type="wstring" dir="out">
2152	<desc>
2153	Suggested URL to download this firmware from.
2154	</desc>
2155	</param>
2156
2157	<param name="file" type="wstring" dir="out">
2158	<desc>
2159	Filename of firmware, only valid if result == TRUE.
2160	</desc>
2161	</param>
2162
2163	<param name="result" type="boolean" dir="return">
2164	<desc>If firmware of this type and version is available.</desc>
2165	</param>
2166	</method>
2167
2168	</interface>
2169
2170	<!--
2171	// IVFSExplorer
2172	/////////////////////////////////////////////////////////////////////////
2173	-->
2174
2175	<enum
2176	name="VFSType"
2177	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2178	>
2179	<desc>
2180	Virtual file systems supported by VFSExplorer.
2181	</desc>
2182
2183	<const name="File" value="1" />
2184	<const name="Cloud" value="2" />
2185	<const name="S3" value="3" />
2186	<const name="WebDav" value="4" />
2187	</enum>
2188
2189	<enum
2190	name="VFSFileType"
2191	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2192	>
2193	<desc>
2194	File types known by VFSExplorer.
2195	</desc>
2196
2197	<const name="Unknown" value="1" />
2198	<const name="Fifo" value="2" />
2199	<const name="DevChar" value="3" />
2200	<const name="Directory" value="4" />
2201	<const name="DevBlock" value="5" />
2202	<const name="File" value="6" />
2203	<const name="SymLink" value="7" />
2204	<const name="Socket" value="8" />
2205	<const name="WhiteOut" value="9" />
2206	</enum>
2207
2208	<interface
2209	name="IVFSExplorer" extends="$unknown"
2210	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2211	wsmap="managed"
2212	>
2213	<desc>
2214	The VFSExplorer interface unifies access to different file system
2215	types. This includes local file systems as well remote file systems like
2216	S3. For a list of supported types see <link to="VFSType" />.
2217	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2218	</desc>
2219
2220	<attribute name="path" type="wstring" readonly="yes">
2221	<desc>Returns the current path in the virtual file system.</desc>
2222	</attribute>
2223
2224	<attribute name="type" type="VFSType" readonly="yes">
2225	<desc>Returns the file system type which is currently in use.</desc>
2226	</attribute>
2227
2228	<method name="update">
2229	<desc>Updates the internal list of files/directories from the
2230	current directory level. Use <link to="#entryList" /> to get the full list
2231	after a call to this method.</desc>
2232
2233	<param name="aProgress" type="IProgress" dir="return">
2234	<desc>Progress object to track the operation completion.</desc>
2235	</param>
2236	</method>
2237
2238	<method name="cd">
2239	<desc>Change the current directory level.</desc>
2240
2241	<param name="aDir" type="wstring" dir="in">
2242	<desc>The name of the directory to go in.</desc>
2243	</param>
2244
2245	<param name="aProgress" type="IProgress" dir="return">
2246	<desc>Progress object to track the operation completion.</desc>
2247	</param>
2248	</method>
2249
2250	<method name="cdUp">
2251	<desc>Go one directory upwards from the current directory level.</desc>
2252
2253	<param name="aProgress" type="IProgress" dir="return">
2254	<desc>Progress object to track the operation completion.</desc>
2255	</param>
2256	</method>
2257
2258	<method name="entryList">
2259	<desc>Returns a list of files/directories after a call to <link
2260	to="#update" />. The user is responsible for keeping this internal
2261	list up do date.</desc>
2262
2263	<param name="aNames" type="wstring" safearray="yes" dir="out">
2264	<desc>The list of names for the entries.</desc>
2265	</param>
2266
2267	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2268	<desc>The list of types for the entries.</desc>
2269	</param>
2270	</method>
2271
2272	<method name="exists">
2273	<desc>Checks if the given file list exists in the current directory
2274	level.</desc>
2275
2276	<param name="aNames" type="wstring" safearray="yes" dir="in">
2277	<desc>The names to check.</desc>
2278	</param>
2279
2280	<param name="aExists" type="wstring" safearray="yes" dir="return">
2281	<desc>The names which exist.</desc>
2282	</param>
2283	</method>
2284
2285	<method name="remove">
2286	<desc>Deletes the given files in the current directory level.</desc>
2287
2288	<param name="aNames" type="wstring" safearray="yes" dir="in">
2289	<desc>The names to remove.</desc>
2290	</param>
2291
2292	<param name="aProgress" type="IProgress" dir="return">
2293	<desc>Progress object to track the operation completion.</desc>
2294	</param>
2295	</method>
2296
2297	</interface>
2298
2299	<!--
2300	// IAppliance
2301	/////////////////////////////////////////////////////////////////////////
2302	-->
2303
2304	<interface
2305	name="IAppliance" extends="$unknown"
2306	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2307	wsmap="managed"
2308	>
2309	<desc>
2310	Represents a platform-independent appliance in OVF format. An instance of this is returned
2311	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2312	virtual machines within an appliance with VirtualBox.
2313
2314	The OVF standard suggests two different physical file formats:
2315
2316	<ol>
2317	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2318	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2319	this descriptor file references other files such as disk images, as OVF appliances typically
2320	do, those additional files must be in the same directory as the descriptor file.</li>
2321
2322	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2323	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2324	files and optionally other files.
2325
2326	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2327	be added with a later version.</li>
2328	</ol>
2329
2330	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2331	<link to="IMachine" /> involves the following sequence of API calls:
2332
2333	<ol>
2334	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2335	</li>
2336
2337	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2338	would like to import. So long as this file is syntactically valid, this will succeed
2339	and fill the appliance object with the parsed data from the OVF file.
2340	</li>
2341
2342	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2343	contents of the IAppliance attributes accordingly. These can be inspected by a
2344	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2345	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2346	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2347	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2348	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2349	The GUI can then give the user the option to confirm and/or change these suggestions.
2350	</li>
2351
2352	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2353	virtual system (machine) to override the suggestions made by the interpret() routine.
2354	</li>
2355
2356	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2357	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2358	virtual system descriptions. After this call suceeded, the UUIDs of the machines created
2359	can be found in the <link to="#machines" /> array attribute.
2360	</li>
2361	</ol>
2362
2363	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2364
2365	<ol>
2366	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2367	an empty IAppliance object.
2368	</li>
2369
2370	<li>For each machine you would like to export, call <link to="IMachine::export" />
2371	with the IAppliance object you just created. Each such call creates one instance of
2372	<link to="IVirtualSystemDescription" /> inside the appliance.
2373	</li>
2374
2375	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2376	virtual system (machine) to override the suggestions made by the export() routine.
2377	</li>
2378
2379	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2380	file written.</li>
2381	</ol>
2382
2383	</desc>
2384
2385	<attribute name="path" type="wstring" readonly="yes">
2386	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2387	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2388	<link to="#write" /> (for export).
2389	This attribute is empty until one of these methods has been called.
2390	</desc>
2391	</attribute>
2392
2393	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2394	<desc>
2395	Array of virtual disk definitions. One such description exists for each
2396	disk definition in the OVF; each string array item represents one such piece of
2397	disk information, with the information fields separated by tab (\t) characters.
2398
2399	The caller should be prepared for additional fields being appended to
2400	this string in future versions of VirtualBox and therefore check for
2401	the number of tabs in the strings returned.
2402
2403	In the current version, the following eight fields are returned per string
2404	in the array:
2405
2406	<ol>
2407	<li>Disk ID (unique string identifier given to disk)</li>
2408
2409	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2410
2411	<li>Populated size (optional unsigned integer indicating the current size of the
2412	disk; can be approximate; -1 if unspecified)</li>
2413
2414	<li>Format (string identifying the disk format, typically
2415	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2416
2417	<li>Reference (where to find the disk image, typically a file name; if empty,
2418	then the disk should be created on import)</li>
2419
2420	<li>Image size (optional unsigned integer indicating the size of the image,
2421	which need not necessarily be the same as the values specified above, since
2422	the image may be compressed or sparse; -1 if not specified)</li>
2423
2424	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2425	presently unsupported and always -1)</li>
2426
2427	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2428	</ol>
2429	</desc>
2430	</attribute>
2431
2432	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2433	<desc> Array of virtual system descriptions. One such description is created
2434	for each virtual system (machine) found in the OVF.
2435	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2436	(for export) has been called.
2437	</desc>
2438	</attribute>
2439
2440	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2441	<desc>
2442	Contains the UUIDs of the machines created from the information in this appliances. This is only
2443	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2444	succeeded.
2445	</desc>
2446	</attribute>
2447
2448	<method name="read">
2449	<desc>
2450	Reads an OVF file into the appliance object.
2451
2452	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2453	mere fact that this method returns successfully does not mean that VirtualBox supports all
2454	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2455	</desc>
2456	<param name="file" type="wstring" dir="in">
2457	<desc>
2458	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2459	on whether the appliance is distributed as a set of files or as a single file, respectively).
2460	</desc>
2461	</param>
2462	<param name="aProgress" type="IProgress" dir="return">
2463	<desc>Progress object to track the operation completion.</desc>
2464	</param>
2465	</method>
2466
2467	<method name="interpret">
2468	<desc>
2469	Interprets the OVF data that was read when the appliance was constructed. After
2470	calling this method, one can inspect the
2471	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2472	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2473	the appliance.
2474
2475	Calling this method is the second step of importing an appliance into VirtualBox;
2476	see <link to="IAppliance" /> for an overview.
2477
2478	After calling this method, one should call <link to="#getWarnings" /> to find out
2479	if problems were encountered during the processing which might later lead to
2480	errors.
2481	</desc>
2482	</method>
2483
2484	<method name="importMachines">
2485	<desc>
2486	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2487	and other interfaces that match the information contained in the appliance as
2488	closely as possible, as represented by the import instructions in the
2489	<link to="#virtualSystemDescriptions" /> array.
2490
2491	Calling this method is the final step of importing an appliance into VirtualBox;
2492	see <link to="IAppliance" /> for an overview.
2493
2494	Since importing the appliance will most probably involve copying and converting
2495	disk images, which can take a long time, this method operates asynchronously and
2496	returns an IProgress object to allow the caller to monitor the progress.
2497
2498	After the import succeeded, the UUIDs of the IMachine instances created can be
2499	retrieved from the <link to="#machines" /> array attribute.
2500	</desc>
2501
2502	<param name="aProgress" type="IProgress" dir="return">
2503	<desc>Progress object to track the operation completion.</desc>
2504	</param>
2505	</method>
2506
2507	<method name="createVFSExplorer">
2508	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2509
2510	<param name="aUri" type="wstring" dir="in">
2511	<desc>The URI describing the file system to use.</desc>
2512	</param>
2513
2514	<param name="aExplorer" type="IVFSExplorer" dir="return">
2515	<desc></desc>
2516	</param>
2517	</method>
2518
2519	<method name="write">
2520	<desc>
2521	Writes the contents of the appliance exports into a new OVF file.
2522
2523	Calling this method is the final step of exporting an appliance from VirtualBox;
2524	see <link to="IAppliance" /> for an overview.
2525
2526	Since exporting the appliance will most probably involve copying and converting
2527	disk images, which can take a long time, this method operates asynchronously and
2528	returns an IProgress object to allow the caller to monitor the progress.
2529	</desc>
2530	<param name="format" type="wstring" dir="in">
2531	<desc>
2532	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2533	future versions of VirtualBox may support additional formats.
2534	</desc>
2535	</param>
2536	<param name="manifest" type="boolean" dir="in">
2537	<desc>
2538	Indicate if the optional manifest file (.mf) should be written. The manifest file
2539	is used for integrity checks prior import.
2540	</desc>
2541	</param>
2542	<param name="path" type="wstring" dir="in">
2543	<desc>
2544	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2545	on whether the appliance is distributed as a set of files or as a single file, respectively).
2546	</desc>
2547	</param>
2548	<param name="progress" type="IProgress" dir="return">
2549	<desc>Progress object to track the operation completion.</desc>
2550	</param>
2551	</method>
2552
2553	<method name="getWarnings">
2554	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2555
2556	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2557	<desc></desc>
2558	</param>
2559	</method>
2560
2561	</interface>
2562
2563	<enum
2564	name="VirtualSystemDescriptionType"
2565	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2566	>
2567	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2568	a configuration value.</desc>
2569
2570	<const name="Ignore" value="1" />
2571	<const name="OS" value="2" />
2572	<const name="Name" value="3" />
2573	<const name="Product" value="4" />
2574	<const name="Vendor" value="5" />
2575	<const name="Version" value="6" />
2576	<const name="ProductUrl" value="7" />
2577	<const name="VendorUrl" value="8" />
2578	<const name="Description" value="9" />
2579	<const name="License" value="10" />
2580	<const name="Miscellaneous" value="11" />
2581	<const name="CPU" value="12" />
2582	<const name="Memory" value="13" />
2583	<const name="HardDiskControllerIDE" value="14" />
2584	<const name="HardDiskControllerSATA" value="15" />
2585	<const name="HardDiskControllerSCSI" value="16" />
2586	<const name="HardDiskControllerSAS" value="17" />
2587	<const name="HardDiskImage" value="18" />
2588	<const name="Floppy" value="19" />
2589	<const name="CDROM" value="20" />
2590	<const name="NetworkAdapter" value="21" />
2591	<const name="USBController" value="22" />
2592	<const name="SoundCard" value="23" />
2593
2594	</enum>
2595
2596	<enum
2597	name="VirtualSystemDescriptionValueType"
2598	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2599	>
2600	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2601	type to fetch.</desc>
2602
2603	<const name="Reference" value="1" />
2604	<const name="Original" value="2" />
2605	<const name="Auto" value="3" />
2606	<const name="ExtraConfig" value="4" />
2607
2608	</enum>
2609
2610	<interface
2611	name="IVirtualSystemDescription" extends="$unknown"
2612	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2613	wsmap="managed"
2614	>
2615
2616	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2617	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2618	<link to="IAppliance::interpret" /> has been called, that array contains information
2619	about how the virtual systems described in the OVF should best be imported into
2620	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2621	import an OVF into VirtualBox.
2622	</desc>
2623
2624	<attribute name="count" type="unsigned long" readonly="yes">
2625	<desc>Return the number of virtual system description entries.</desc>
2626	</attribute>
2627
2628	<method name="getDescription">
2629	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2630	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2631
2632	The list below identifies the value sets that are possible depending on the
2633	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2634	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2635	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2636	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2637	the @a aExtraConfigValues[] array item may also be used.
2638
2639	<ul>
2640	<li>
2641	"OS": the guest operating system type. There must be exactly one such array item on import. The
2642	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2643	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2644	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2645	</li>
2646	<li>
2647	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2648	if none is present on import, then an automatic name will be created from the operating system
2649	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
2650	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2651	<link to="IMachine" /> name that does not exist yet.
2652	</li>
2653	<li>
2654	"Description": an arbitrary description.
2655	</li>
2656	<li>
2657	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2658	code to display such a license for agreement; the Main API does not enforce any such policy.
2659	</li>
2660	<li>
2661	Miscellaneous: reserved for future use.
2662	</li>
2663	<li>
2664	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2665	</li>
2666	<li>
2667	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2668	is present on import, then VirtualBox will set a meaningful default based on the operating system
2669	type.
2670	</li>
2671	<li>
2672	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2673	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2674	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2675	writes into the OVF.
2676	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2677	type can use to specify which hard disk controller a virtual disk should be connected to.
2678	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2679	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2680	its virtual machines supports four channels (primary master, primary slave, secondary master,
2681	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2682	</li>
2683	<li>
2684	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2685	has no value in @a aOvfValues[] or @a aVBoxValues[].
2686	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2687	</li>
2688	<li>
2689	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2690	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2691	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2692	whereas VirtualBox considers it a class of storage controllers of its own; see
2693	<link to="StorageControllerType" />).
2694	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2695	</li>
2696	<li>
2697	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2698	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2699
2700	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2701	a path since the image file should be in the same location as the OVF file itself), whereas the
2702	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2703	hard disk image. This means that on import the image will be copied and converted from the
2704	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2705
2706	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2707	format: "controller=<index>;channel=<c>"
2708	In this string, <index> must be an integer specifying the hard disk controller to connect
2709	the image to. That number must be the index of an array item with one of the hard disk controller
2710	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2711	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2712	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2713	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2714	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2715	</li>
2716	<li>
2717	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2718	attachment information as with "HardDiskImage" items.
2719	</li>
2720	<li>
2721	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2722	attachment information as with "HardDiskImage" items.
2723	</li>
2724	<li>
2725	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2726	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2727	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2728	</li>
2729	<li>
2730	"USBController": a USB controller. There can be at most one such item. If and only if such an
2731	item ispresent, USB support will be enabled for the new virtual machine.
2732	</li>
2733	<li>
2734	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2735	present, sound support will be enabled for the new virtual machine. Note that the virtual
2736	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2737	may be different from the virtual soundcard expected by the appliance.
2738	</li>
2739	</ul>
2740
2741	</desc>
2742
2743	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2744	<desc></desc>
2745	</param>
2746
2747	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2748	<desc></desc>
2749	</param>
2750
2751	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2752	<desc></desc>
2753	</param>
2754
2755	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2756	<desc></desc>
2757	</param>
2758
2759	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2760	<desc></desc>
2761	</param>
2762
2763	</method>
2764
2765	<method name="getDescriptionByType">
2766	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2767	should be returned.</desc>
2768
2769	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2770	<desc></desc>
2771	</param>
2772
2773	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2774	<desc></desc>
2775	</param>
2776
2777	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2778	<desc></desc>
2779	</param>
2780
2781	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2782	<desc></desc>
2783	</param>
2784
2785	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2786	<desc></desc>
2787	</param>
2788
2789	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2790	<desc></desc>
2791	</param>
2792
2793	</method>
2794
2795	<method name="getValuesByType">
2796	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2797	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2798	values.</desc>
2799
2800	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2801	<desc></desc>
2802	</param>
2803
2804	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2805	<desc></desc>
2806	</param>
2807
2808	<param name="aValues" type="wstring" dir="return" safearray="yes">
2809	<desc></desc>
2810	</param>
2811
2812	</method>
2813
2814	<method name="setFinalValues">
2815	<desc>
2816	This method allows the appliance's user to change the configuration for the virtual
2817	system descriptions. For each array item returned from <link to="#getDescription" />,
2818	you must pass in one boolean value and one configuration value.
2819
2820	Each item in the boolean array determines whether the particular configuration item
2821	should be enabled.
2822	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2823	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2824	and SoundCard.
2825
2826	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2827	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2828	the configuration remains unchanged. Please see the documentation for getDescription()
2829	for valid configuration values for the individual array item types. If the
2830	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2831	</desc>
2832
2833	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2838	<desc></desc>
2839	</param>
2840
2841	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2842	<desc></desc>
2843	</param>
2844	</method>
2845
2846	<method name="addDescription">
2847	<desc>
2848	This method adds an additional description entry to the stack of already
2849	available descriptions for this virtual system. This is handy for writing
2850	values which aren't directly supported by VirtualBox. One example would
2851	be the License type of <link to="VirtualSystemDescriptionType" />.
2852	</desc>
2853
2854	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aVBoxValue" type="wstring" dir="in">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aExtraConfigValue" type="wstring" dir="in">
2863	<desc></desc>
2864	</param>
2865	</method>
2866	</interface>
2867
2868
2869	<!--
2870	// IMachine
2871	/////////////////////////////////////////////////////////////////////////
2872	-->
2873
2874	<interface
2875	name="IInternalMachineControl" extends="$unknown"
2876	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
2877	internal="yes"
2878	wsmap="suppress"
2879	>
2880	<method name="setRemoveSavedStateFile">
2881	<desc>
2882	Updates the flag whether the saved state file is removed on a
2883	machine state change from Saved to PoweredOff.
2884	</desc>
2885	<param name="aRemove" type="boolean" dir="in"/>
2886	</method>
2887
2888	<method name="updateState">
2889	<desc>
2890	Updates the VM state.
2891	<note>
2892	This operation will also update the settings file with the correct
2893	information about the saved state file and delete this file from disk
2894	when appropriate.
2895	</note>
2896	</desc>
2897	<param name="state" type="MachineState" dir="in"/>
2898	</method>
2899
2900	<method name="getIPCId">
2901	<param name="id" type="wstring" dir="return"/>
2902	</method>
2903
2904	<method name="beginPowerUp">
2905	<desc>
2906	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2907	gives it the progress object that should be part of any pending
2908	<link to="IMachine::launchVMProcess"/> operations. The progress
2909	object may be called back to reflect an early cancelation, so some care
2910	have to be taken with respect to any cancelation callbacks. The console
2911	object will call <link to="IInternalMachineControl::endPowerUp"/>
2912	to signal the completion of the progress object.
2913	</desc>
2914	<param name="aProgress" type="IProgress" dir="in" />
2915	</method>
2916
2917	<method name="endPowerUp">
2918	<desc>
2919	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2920	This method may query status information from the progress object it
2921	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2922	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2923	call in order to complete that progress object.
2924	</desc>
2925	<param name="result" type="long" dir="in"/>
2926	</method>
2927
2928	<method name="runUSBDeviceFilters">
2929	<desc>
2930	Asks the server to run USB devices filters of the associated
2931	machine against the given USB device and tell if there is
2932	a match.
2933	<note>
2934	Intended to be used only for remote USB devices. Local
2935	ones don't require to call this method (this is done
2936	implicitly by the Host and USBProxyService).
2937	</note>
2938	</desc>
2939	<param name="device" type="IUSBDevice" dir="in"/>
2940	<param name="matched" type="boolean" dir="out"/>
2941	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
2942	</method>
2943
2944	<method name="captureUSBDevice">
2945	<desc>
2946	Requests a capture of the given host USB device.
2947	When the request is completed, the VM process will
2948	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
2949	notification.
2950	</desc>
2951	<param name="id" type="uuid" mod="string" dir="in"/>
2952	</method>
2953
2954	<method name="detachUSBDevice">
2955	<desc>
2956	Notification that a VM is going to detach (@a done = @c false) or has
2957	already detached (@a done = @c true) the given USB device.
2958	When the @a done = @c true request is completed, the VM process will
2959	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
2960	notification.
2961	<note>
2962	In the @a done = @c true case, the server must run its own filters
2963	and filters of all VMs but this one on the detached device
2964	as if it were just attached to the host computer.
2965	</note>
2966	</desc>
2967	<param name="id" type="uuid" mod="string" dir="in"/>
2968	<param name="done" type="boolean" dir="in"/>
2969	</method>
2970
2971	<method name="autoCaptureUSBDevices">
2972	<desc>
2973	Requests a capture all matching USB devices attached to the host.
2974	When the request is completed, the VM process will
2975	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
2976	notification per every captured device.
2977	</desc>
2978	</method>
2979
2980	<method name="detachAllUSBDevices">
2981	<desc>
2982	Notification that a VM that is being powered down. The done
2983	parameter indicates whether which stage of the power down
2984	we're at. When @a done = @c false the VM is announcing its
2985	intentions, while when @a done = @c true the VM is reporting
2986	what it has done.
2987	<note>
2988	In the @a done = @c true case, the server must run its own filters
2989	and filters of all VMs but this one on all detach devices as
2990	if they were just attached to the host computer.
2991	</note>
2992	</desc>
2993	<param name="done" type="boolean" dir="in"/>
2994	</method>
2995
2996	<method name="onSessionEnd">
2997	<desc>
2998	Triggered by the given session object when the session is about
2999	to close normally.
3000	</desc>
3001	<param name="session" type="ISession" dir="in">
3002	<desc>Session that is being closed</desc>
3003	</param>
3004	<param name="progress" type="IProgress" dir="return">
3005	<desc>
3006	Used to wait until the corresponding machine is actually
3007	dissociated from the given session on the server.
3008	Returned only when this session is a direct one.
3009	</desc>
3010	</param>
3011	</method>
3012
3013	<method name="beginSavingState">
3014	<desc>
3015	Called by the VM process to inform the server it wants to
3016	save the current state and stop the VM execution.
3017	</desc>
3018	<param name="progress" type="IProgress" dir="in">
3019	<desc>
3020	Progress object created by the VM process to wait until
3021	the state is saved.
3022	</desc>
3023	</param>
3024	<param name="stateFilePath" type="wstring" dir="out">
3025	<desc>
3026	File path the VM process must save the execution state to.
3027	</desc>
3028	</param>
3029	</method>
3030
3031	<method name="endSavingState">
3032	<desc>
3033	Called by the VM process to inform the server that saving
3034	the state previously requested by #beginSavingState is either
3035	successfully finished or there was a failure.
3036
3037	<result name="VBOX_E_FILE_ERROR">
3038	Settings file not accessible.
3039	</result>
3040	<result name="VBOX_E_XML_ERROR">
3041	Could not parse the settings file.
3042	</result>
3043
3044	</desc>
3045
3046	<param name="success" type="boolean" dir="in">
3047	<desc>@c true to indicate success and @c false otherwise.
3048	</desc>
3049	</param>
3050	</method>
3051
3052	<method name="adoptSavedState">
3053	<desc>
3054	Gets called by IConsole::adoptSavedState.
3055	<result name="VBOX_E_FILE_ERROR">
3056	Invalid saved state file path.
3057	</result>
3058	</desc>
3059	<param name="savedStateFile" type="wstring" dir="in">
3060	<desc>Path to the saved state file to adopt.</desc>
3061	</param>
3062	</method>
3063
3064	<method name="beginTakingSnapshot">
3065	<desc>
3066	Called from the VM process to request from the server to perform the
3067	server-side actions of creating a snapshot (creating differencing images
3068	and the snapshot object).
3069
3070	<result name="VBOX_E_FILE_ERROR">
3071	Settings file not accessible.
3072	</result>
3073	<result name="VBOX_E_XML_ERROR">
3074	Could not parse the settings file.
3075	</result>
3076	</desc>
3077	<param name="initiator" type="IConsole" dir="in">
3078	<desc>The console object that initiated this call.</desc>
3079	</param>
3080	<param name="name" type="wstring" dir="in">
3081	<desc>Snapshot name.</desc>
3082	</param>
3083	<param name="description" type="wstring" dir="in">
3084	<desc>Snapshot description.</desc>
3085	</param>
3086	<param name="consoleProgress" type="IProgress" dir="in">
3087	<desc>
3088	Progress object created by the VM process tracking the
3089	snapshot's progress. This has the following sub-operations:
3090	<ul>
3091	<li>setting up (weight 1);</li>
3092	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3093	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3094	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3095	<li>finishing up (weight 1)</li>
3096	</ul>
3097	</desc>
3098	</param>
3099	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3100	<desc>
3101	Whether this is an online snapshot (i.e. the machine is running).
3102	</desc>
3103	</param>
3104	<param name="stateFilePath" type="wstring" dir="out">
3105	<desc>
3106	File path the VM process must save the execution state to.
3107	</desc>
3108	</param>
3109	</method>
3110
3111	<method name="endTakingSnapshot">
3112	<desc>
3113	Called by the VM process to inform the server that the snapshot
3114	previously requested by #beginTakingSnapshot is either
3115	successfully taken or there was a failure.
3116	</desc>
3117
3118	<param name="success" type="boolean" dir="in">
3119	<desc>@c true to indicate success and @c false otherwise</desc>
3120	</param>
3121	</method>
3122
3123	<method name="deleteSnapshot">
3124	<desc>
3125	Gets called by IConsole::deleteSnapshot.
3126	<result name="VBOX_E_INVALID_OBJECT_STATE">
3127	Snapshot has more than one child snapshot.
3128	</result>
3129	</desc>
3130	<param name="initiator" type="IConsole" dir="in">
3131	<desc>The console object that initiated this call.</desc>
3132	</param>
3133	<param name="id" type="uuid" mod="string" dir="in">
3134	<desc>UUID of the snapshot to delete.</desc>
3135	</param>
3136	<param name="machineState" type="MachineState" dir="out">
3137	<desc>New machine state after this operation is started.</desc>
3138	</param>
3139	<param name="progress" type="IProgress" dir="return">
3140	<desc>Progress object to track the operation completion.</desc>
3141	</param>
3142	</method>
3143
3144	<method name="finishOnlineMergeMedium">
3145	<desc>
3146	Gets called by IConsole::onlineMergeMedium.
3147	</desc>
3148	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3149	<desc>The medium attachment which needs to be cleaned up.</desc>
3150	</param>
3151	<param name="source" type="IMedium" dir="in">
3152	<desc>Merge source medium.</desc>
3153	</param>
3154	<param name="target" type="IMedium" dir="in">
3155	<desc>Merge target medium.</desc>
3156	</param>
3157	<param name="mergeForward" type="boolean" dir="in">
3158	<desc>Merge direction.</desc>
3159	</param>
3160	<param name="parentForTarget" type="IMedium" dir="in">
3161	<desc>For forward merges: new parent for target medium.</desc>
3162	</param>
3163	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3164	<desc>For backward merges: list of media which need their parent UUID
3165	updated.</desc>
3166	</param>
3167	</method>
3168
3169	<method name="restoreSnapshot">
3170	<desc>
3171	Gets called by IConsole::RestoreSnapshot.
3172	</desc>
3173	<param name="initiator" type="IConsole" dir="in">
3174	<desc>The console object that initiated this call.</desc>
3175	</param>
3176	<param name="snapshot" type="ISnapshot" dir="in">
3177	<desc>The snapshot to restore the VM state from.</desc>
3178	</param>
3179	<param name="machineState" type="MachineState" dir="out">
3180	<desc>New machine state after this operation is started.</desc>
3181	</param>
3182	<param name="progress" type="IProgress" dir="return">
3183	<desc>Progress object to track the operation completion.</desc>
3184	</param>
3185	</method>
3186
3187	<method name="pullGuestProperties">
3188	<desc>
3189	Get the list of the guest properties matching a set of patterns along
3190	with their values, time stamps and flags and give responsibility for
3191	managing properties to the console.
3192	</desc>
3193	<param name="name" type="wstring" dir="out" safearray="yes">
3194	<desc>
3195	The names of the properties returned.
3196	</desc>
3197	</param>
3198	<param name="value" type="wstring" dir="out" safearray="yes">
3199	<desc>
3200	The values of the properties returned. The array entries match the
3201	corresponding entries in the @a name array.
3202	</desc>
3203	</param>
3204	<param name="timestamp" type="long long" dir="out" safearray="yes">
3205	<desc>
3206	The time stamps of the properties returned. The array entries match
3207	the corresponding entries in the @a name array.
3208	</desc>
3209	</param>
3210	<param name="flags" type="wstring" dir="out" safearray="yes">
3211	<desc>
3212	The flags of the properties returned. The array entries match the
3213	corresponding entries in the @a name array.
3214	</desc>
3215	</param>
3216	</method>
3217
3218	<method name="pushGuestProperty">
3219	<desc>
3220	Update a single guest property in IMachine.
3221	</desc>
3222	<param name="name" type="wstring" dir="in">
3223	<desc>
3224	The name of the property to be updated.
3225	</desc>
3226	</param>
3227	<param name="value" type="wstring" dir="in">
3228	<desc>
3229	The value of the property.
3230	</desc>
3231	</param>
3232	<param name="timestamp" type="long long" dir="in">
3233	<desc>
3234	The timestamp of the property.
3235	</desc>
3236	</param>
3237	<param name="flags" type="wstring" dir="in">
3238	<desc>
3239	The flags of the property.
3240	</desc>
3241	</param>
3242	</method>
3243
3244	<method name="lockMedia">
3245	<desc>
3246	Locks all media attached to the machine for writing and parents of
3247	attached differencing media (if any) for reading. This operation is
3248	atomic so that if it fails no media is actually locked.
3249
3250	This method is intended to be called when the machine is in Starting or
3251	Restoring state. The locked media will be automatically unlocked when
3252	the machine is powered off or crashed.
3253	</desc>
3254	</method>
3255	<method name="unlockMedia">
3256	<desc>
3257	Unlocks all media previously locked using
3258	<link to="IInternalMachineControl::lockMedia"/>.
3259
3260	This method is intended to be used with teleportation so that it is
3261	possible to teleport between processes on the same machine.
3262	</desc>
3263	</method>
3264	</interface>
3265
3266	<interface
3267	name="IBIOSSettings" extends="$unknown"
3268	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3269	wsmap="managed"
3270	>
3271	<desc>
3272	The IBIOSSettings interface represents BIOS settings of the virtual
3273	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3274	</desc>
3275	<attribute name="logoFadeIn" type="boolean">
3276	<desc>Fade in flag for BIOS logo animation.</desc>
3277	</attribute>
3278
3279	<attribute name="logoFadeOut" type="boolean">
3280	<desc>Fade out flag for BIOS logo animation.</desc>
3281	</attribute>
3282
3283	<attribute name="logoDisplayTime" type="unsigned long">
3284	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3285	</attribute>
3286
3287	<attribute name="logoImagePath" type="wstring">
3288	<desc>
3289	Local file system path for external BIOS splash image. Empty string
3290	means the default image is shown on boot.
3291	</desc>
3292	</attribute>
3293
3294	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3295	<desc>Mode of the BIOS boot device menu.</desc>
3296	</attribute>
3297
3298	<attribute name="ACPIEnabled" type="boolean">
3299	<desc>ACPI support flag.</desc>
3300	</attribute>
3301
3302	<attribute name="IOAPICEnabled" type="boolean">
3303	<desc>
3304	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3305	and support IRQs above 15.
3306	</desc>
3307	</attribute>
3308
3309	<attribute name="timeOffset" type="long long">
3310	<desc>
3311	Offset in milliseconds from the host system time. This allows for
3312	guests running with a different system date/time than the host.
3313	It is equivalent to setting the system date/time in the BIOS except
3314	it is not an absolute value but a relative one. Guest Additions
3315	time synchronization honors this offset.
3316	</desc>
3317	</attribute>
3318
3319	<attribute name="PXEDebugEnabled" type="boolean">
3320	<desc>
3321	PXE debug logging flag. If set, VirtualBox will write extensive
3322	PXE trace information to the release log.
3323	</desc>
3324	</attribute>
3325
3326	</interface>
3327
3328	<enum name="CleanupMode"
3329	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3330	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3331	</desc>
3332	<const name="UnregisterOnly" value="1">
3333	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3334	</const>
3335	<const name="DetachAllReturnNone" value="2">
3336	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3337	</const>
3338	<const name="DetachAllReturnHardDisksOnly" value="3">
3339	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3340	</const>
3341	<const name="Full" value="4">
3342	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3343	</const>
3344	</enum>
3345
3346	<interface
3347	name="IMachine" extends="$unknown"
3348	uuid="5c91359b-5bdb-4518-9bd1-5f2c50a3c129"
3349	wsmap="managed"
3350	>
3351	<desc>
3352	The IMachine interface represents a virtual machine, or guest, created
3353	in VirtualBox.
3354
3355	This interface is used in two contexts. First of all, a collection of
3356	objects implementing this interface is stored in the
3357	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3358	machines that are currently registered with this VirtualBox
3359	installation. Also, once a session has been opened for the given virtual
3360	machine (e.g. the virtual machine is running), the machine object
3361	associated with the open session can be queried from the session object;
3362	see <link to="ISession"/> for details.
3363
3364	The main role of this interface is to expose the settings of the virtual
3365	machine and provide methods to change various aspects of the virtual
3366	machine's configuration. For machine objects stored in the
3367	<link to="IVirtualBox::machines"/> collection, all attributes are
3368	read-only unless explicitly stated otherwise in individual attribute
3369	and method descriptions.
3370
3371	In order to change a machine setting, a session for this machine must be
3372	opened using one of the <link to="IMachine::lockMachine" /> or
3373	<link to="IMachine::launchVMProcess"/> methods. After the
3374	machine has been successfully locked for a session, a mutable machine object
3375	needs to be queried from the session object and then the desired settings
3376	changes can be applied to the returned object using IMachine attributes and
3377	methods. See the <link to="ISession"/> interface description for more
3378	information about sessions.
3379
3380	Note that IMachine does not provide methods to control virtual machine
3381	execution (such as start the machine, or power it down) -- these methods
3382	are grouped in a separate interface called <link to="IConsole" />.
3383
3384	<see>ISession, IConsole</see>
3385	</desc>
3386
3387	<attribute name="parent" type="IVirtualBox" readonly="yes">
3388	<desc>Associated parent object.</desc>
3389	</attribute>
3390
3391	<attribute name="accessible" type="boolean" readonly="yes">
3392	<desc>
3393	Whether this virtual machine is currently accessible or not.
3394
3395	A machine is always deemed accessible unless it is registered <i>and</i>
3396	its settings file cannot be read or parsed (either because the file itself
3397	is unavailable or has invalid XML contents).
3398
3399	Every time this property is read, the accessibility state of
3400	this machine is re-evaluated. If the returned value is @c false,
3401	the <link to="#accessError"/> property may be used to get the
3402	detailed error information describing the reason of
3403	inaccessibility, including XML error messages.
3404
3405	When the machine is inaccessible, only the following properties
3406	can be used on it:
3407	<ul>
3408	<li><link to="#parent"/></li>
3409	<li><link to="#id"/></li>
3410	<li><link to="#settingsFilePath"/></li>
3411	<li><link to="#accessible"/></li>
3412	<li><link to="#accessError"/></li>
3413	</ul>
3414
3415	An attempt to access any other property or method will return
3416	an error.
3417
3418	The only possible action you can perform on an inaccessible
3419	machine is to unregister it using the
3420	<link to="IMachine::unregister"/> call (or, to check
3421	for the accessibility state once more by querying this
3422	property).
3423
3424	<note>
3425	In the current implementation, once this property returns
3426	@c true, the machine will never become inaccessible
3427	later, even if its settings file cannot be successfully
3428	read/written any more (at least, until the VirtualBox
3429	server is restarted). This limitation may be removed in
3430	future releases.
3431	</note>
3432	</desc>
3433	</attribute>
3434
3435	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3436	<desc>
3437	Error information describing the reason of machine
3438	inaccessibility.
3439
3440	Reading this property is only valid after the last call to
3441	<link to="#accessible"/> returned @c false (i.e. the
3442	machine is currently unaccessible). Otherwise, a @c null
3443	IVirtualBoxErrorInfo object will be returned.
3444	</desc>
3445	</attribute>
3446
3447	<attribute name="name" type="wstring">
3448	<desc>
3449	Name of the virtual machine.
3450
3451	Besides being used for human-readable identification purposes
3452	everywhere in VirtualBox, the virtual machine name is also used
3453	as a name of the machine's settings file and as a name of the
3454	subdirectory this settings file resides in. Thus, every time you
3455	change the value of this property, the settings file will be
3456	renamed once you call <link to="#saveSettings"/> to confirm the
3457	change. The containing subdirectory will be also renamed, but
3458	only if it has exactly the same name as the settings file
3459	itself prior to changing this property (for backward compatibility
3460	with previous API releases). The above implies the following
3461	limitations:
3462	<ul>
3463	<li>The machine name cannot be empty.</li>
3464	<li>The machine name can contain only characters that are valid
3465	file name characters according to the rules of the file
3466	system used to store VirtualBox configuration.</li>
3467	<li>You cannot have two or more machines with the same name
3468	if they use the same subdirectory for storing the machine
3469	settings files.</li>
3470	<li>You cannot change the name of the machine if it is running,
3471	or if any file in the directory containing the settings file
3472	is being used by another running machine or by any other
3473	process in the host operating system at a time when
3474	<link to="#saveSettings"/> is called.
3475	</li>
3476	</ul>
3477	If any of the above limitations are hit, <link to="#saveSettings"/>
3478	will return an appropriate error message explaining the exact
3479	reason and the changes you made to this machine will not be saved.
3480	</desc>
3481	</attribute>
3482
3483	<attribute name="description" type="wstring">
3484	<desc>
3485	Description of the virtual machine.
3486
3487	The description attribute can contain any text and is
3488	typically used to describe the hardware and software
3489	configuration of the virtual machine in detail (i.e. network
3490	settings, versions of the installed software and so on).
3491	</desc>
3492	</attribute>
3493
3494	<attribute name="id" type="uuid" mod="string" readonly="yes">
3495	<desc>UUID of the virtual machine.</desc>
3496	</attribute>
3497
3498	<attribute name="OSTypeId" type="wstring">
3499	<desc>
3500	User-defined identifier of the Guest OS type.
3501	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3502	an IGuestOSType object representing details about the given
3503	Guest OS type.
3504	<note>
3505	This value may differ from the value returned by
3506	<link to="IGuest::OSTypeId"/> if Guest Additions are
3507	installed to the guest OS.
3508	</note>
3509	</desc>
3510	</attribute>
3511
3512	<attribute name="HardwareVersion" type="wstring">
3513	<desc>Hardware version identifier. Internal use only for now.</desc>
3514	</attribute>
3515
3516	<attribute name="hardwareUUID" type="uuid" mod="string">
3517	<desc>
3518	The UUID presented to the guest via memory tables, hardware and guest
3519	properties. For most VMs this is the same as the @a id, but for VMs
3520	which have been cloned or teleported it may be the same as the source
3521	VM. This latter is because the guest shouldn't notice that it was
3522	cloned or teleported.
3523	</desc>
3524	</attribute>
3525
3526	<attribute name="CPUCount" type="unsigned long">
3527	<desc>Number of virtual CPUs in the VM.</desc>
3528	</attribute>
3529
3530	<attribute name="CPUHotPlugEnabled" type="boolean">
3531	<desc>
3532	This setting determines whether VirtualBox allows CPU
3533	hotplugging for this machine.</desc>
3534	</attribute>
3535
3536	<attribute name="CPUExecutionCap" type="unsigned long">
3537	<desc>
3538	Means to limit the number of CPU cycles a guest can use. The unit
3539	is percentage of host CPU cycles per second. The valid range
3540	is 1 - 100. 100 (the default) implies no limit.
3541	</desc>
3542	</attribute>
3543
3544	<attribute name="memorySize" type="unsigned long">
3545	<desc>System memory size in megabytes.</desc>
3546	</attribute>
3547
3548	<attribute name="memoryBalloonSize" type="unsigned long">
3549	<desc>Memory balloon size in megabytes.</desc>
3550	</attribute>
3551
3552	<attribute name="PageFusionEnabled" type="boolean">
3553	<desc>
3554	This setting determines whether VirtualBox allows page
3555	fusion for this machine (64 bits host only).
3556	</desc>
3557	</attribute>
3558
3559	<attribute name="VRAMSize" type="unsigned long">
3560	<desc>Video memory size in megabytes.</desc>
3561	</attribute>
3562
3563	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3564	<desc>
3565	This setting determines whether VirtualBox allows this machine to make
3566	use of the 3D graphics support available on the host.</desc>
3567	</attribute>
3568
3569	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3570	<desc>
3571	This setting determines whether VirtualBox allows this machine to make
3572	use of the 2D video acceleration support available on the host.</desc>
3573	</attribute>
3574
3575	<attribute name="monitorCount" type="unsigned long">
3576	<desc>
3577	Number of virtual monitors.
3578	<note>
3579	Only effective on Windows XP and later guests with
3580	Guest Additions installed.
3581	</note>
3582	</desc>
3583	</attribute>
3584
3585	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3586	<desc>Object containing all BIOS settings.</desc>
3587	</attribute>
3588
3589	<attribute name="firmwareType" type="FirmwareType">
3590	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3591	bootstrap in this VM.</desc>
3592	</attribute>
3593
3594	<attribute name="pointingHidType" type="PointingHidType">
3595	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3596	The default is typically "PS2Mouse" but can vary depending on the
3597	requirements of the guest operating system.</desc>
3598	</attribute>
3599
3600	<attribute name="keyboardHidType" type="KeyboardHidType">
3601	<desc>Type of keyboard HID used in this VM.
3602	The default is typically "PS2Keyboard" but can vary depending on the
3603	requirements of the guest operating system.</desc>
3604	</attribute>
3605
3606	<attribute name="hpetEnabled" type="boolean">
3607	<desc>This attribute controls if High Precision Event Timer (HPET) is
3608	enabled in this VM. Use this property if you want to provide guests
3609	with additional time source, or if guest requires HPET to function correctly.
3610	Default is false.</desc>
3611	</attribute>
3612
3613	<attribute name="chipsetType" type="ChipsetType">
3614	<desc>Chipset type used in this VM.</desc>
3615	</attribute>
3616
3617	<attribute name="snapshotFolder" type="wstring">
3618	<desc>
3619	Full path to the directory used to store snapshot data
3620	(differencing media and saved state files) of this machine.
3621
3622	The initial value of this property is
3623	<tt><</tt><link to="#settingsFilePath">
3624	path_to_settings_file</link><tt>>/<</tt>
3625	<link to="#id">machine_uuid</link>
3626	<tt>></tt>.
3627
3628	Currently, it is an error to try to change this property on
3629	a machine that has snapshots (because this would require to
3630	move possibly large files to a different location).
3631	A separate method will be available for this purpose later.
3632
3633	<note>
3634	Setting this property to @c null or to an empty string will restore
3635	the initial value.
3636	</note>
3637	<note>
3638	When setting this property, the specified path can be
3639	absolute (full path) or relative to the directory where the
3640	<link to="#settingsFilePath">machine settings file</link>
3641	is located. When reading this property, a full path is
3642	always returned.
3643	</note>
3644	<note>
3645	The specified path may not exist, it will be created
3646	when necessary.
3647	</note>
3648	</desc>
3649	</attribute>
3650
3651	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
3652	<desc>VRDP server object.</desc>
3653	</attribute>
3654
3655	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3656	<desc>Array of media attached to this machine.</desc>
3657	</attribute>
3658
3659	<attribute name="USBController" type="IUSBController" readonly="yes">
3660	<desc>
3661	Associated USB controller object.
3662
3663	<note>
3664	If USB functionality is not available in the given edition of
3665	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3666	</note>
3667	</desc>
3668	</attribute>
3669
3670	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3671	<desc>Associated audio adapter, always present.</desc>
3672	</attribute>
3673
3674	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3675	<desc>Array of storage controllers attached to this machine.</desc>
3676	</attribute>
3677
3678	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3679	<desc>
3680	Full name of the file containing machine settings data.
3681	</desc>
3682	</attribute>
3683
3684	<attribute name="settingsModified" type="boolean" readonly="yes">
3685	<desc>
3686	Whether the settings of this machine have been modified
3687	(but neither yet saved nor discarded).
3688	<note>
3689	Reading this property is only valid on instances returned
3690	by <link to="ISession::machine"/> and on new machines
3691	created by <link to="IVirtualBox::createMachine"/> or opened
3692	by <link to="IVirtualBox::openMachine"/> but not
3693	yet registered, or on unregistered machines after calling
3694	<link to="IMachine::unregister"/>. For all other
3695	cases, the settings can never be modified.
3696	</note>
3697	<note>
3698	For newly created unregistered machines, the value of this
3699	property is always @c true until <link to="#saveSettings"/>
3700	is called (no matter if any machine settings have been
3701	changed after the creation or not). For opened machines
3702	the value is set to @c false (and then follows to normal rules).
3703	</note>
3704	</desc>
3705	</attribute>
3706
3707	<attribute name="sessionState" type="SessionState" readonly="yes">
3708	<desc>Current session state for this machine.</desc>
3709	</attribute>
3710
3711	<attribute name="sessionType" type="wstring" readonly="yes">
3712	<desc>
3713	Type of the session. If <link to="#sessionState"/> is
3714	Spawning or Locked, this attribute contains the
3715	same value as passed to the
3716	<link to="IMachine::launchVMProcess"/> method in the
3717	@a type parameter. If the session was used with
3718	<link to="IMachine::lockMachine" />, or if
3719	<link to="#sessionState"/> is SessionClosed, the value of this
3720	attribute is an empty string.
3721	</desc>
3722	</attribute>
3723
3724	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3725	<desc>
3726	Identifier of the session process. This attribute contains the
3727	platform-dependent identifier of the process whose session was
3728	used with <link to="IMachine::lockMachine" /> call. The returned
3729	value is only valid if <link to="#sessionState"/> is Locked or
3730	Unlocking by the time this property is read.
3731	</desc>
3732	</attribute>
3733
3734	<attribute name="state" type="MachineState" readonly="yes">
3735	<desc>Current execution state of this machine.</desc>
3736	</attribute>
3737
3738	<attribute name="lastStateChange" type="long long" readonly="yes">
3739	<desc>
3740	Time stamp of the last execution state change,
3741	in milliseconds since 1970-01-01 UTC.
3742	</desc>
3743	</attribute>
3744
3745	<attribute name="stateFilePath" type="wstring" readonly="yes">
3746	<desc>
3747	Full path to the file that stores the execution state of
3748	the machine when it is in the <link to="MachineState_Saved"/> state.
3749	<note>
3750	When the machine is not in the Saved state, this attribute is
3751	an empty string.
3752	</note>
3753	</desc>
3754	</attribute>
3755
3756	<attribute name="logFolder" type="wstring" readonly="yes">
3757	<desc>
3758	Full path to the folder that stores a set of rotated log files
3759	recorded during machine execution. The most recent log file is
3760	named <tt>VBox.log</tt>, the previous log file is
3761	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3762	in the current version).
3763	</desc>
3764	</attribute>
3765
3766	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3767	<desc>
3768	Current snapshot of this machine. This is @c null if the machine
3769	currently has no snapshots. If it is not @c null, then it was
3770	set by one of <link to="IConsole::takeSnapshot" />,
3771	<link to="IConsole::deleteSnapshot" />
3772	or <link to="IConsole::restoreSnapshot" />, depending on which
3773	was called last. See <link to="ISnapshot"/> for details.
3774	</desc>
3775	</attribute>
3776
3777	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3778	<desc>
3779	Number of snapshots taken on this machine. Zero means the
3780	machine doesn't have any snapshots.
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="currentStateModified" type="boolean" readonly="yes">
3785	<desc>
3786	Returns @c true if the current state of the machine is not
3787	identical to the state stored in the current snapshot.
3788
3789	The current state is identical to the current snapshot only
3790	directly after one of the following calls are made:
3791
3792	<ul>
3793	<li><link to="IConsole::restoreSnapshot"/>
3794	</li>
3795	<li><link to="IConsole::takeSnapshot"/> (issued on a
3796	"powered off" or "saved" machine, for which
3797	<link to="#settingsModified"/> returns @c false)
3798	</li>
3799	<li><link to="IMachine::setCurrentSnapshot"/>
3800	</li>
3801	</ul>
3802
3803	The current state remains identical until one of the following
3804	happens:
3805	<ul>
3806	<li>settings of the machine are changed</li>
3807	<li>the saved state is deleted</li>
3808	<li>the current snapshot is deleted</li>
3809	<li>an attempt to execute the machine is made</li>
3810	</ul>
3811
3812	<note>
3813	For machines that don't have snapshots, this property is
3814	always @c false.
3815	</note>
3816	</desc>
3817	</attribute>
3818
3819	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3820	<desc>
3821	Collection of shared folders for this machine (permanent shared
3822	folders). These folders are shared automatically at machine startup
3823	and available only to the guest OS installed within this machine.
3824
3825	New shared folders are added to the collection using
3826	<link to="#createSharedFolder"/>. Existing shared folders can be
3827	removed using <link to="#removeSharedFolder"/>.
3828	</desc>
3829	</attribute>
3830
3831	<attribute name="clipboardMode" type="ClipboardMode">
3832	<desc>
3833	Synchronization mode between the host OS clipboard
3834	and the guest OS clipboard.
3835	</desc>
3836	</attribute>
3837
3838	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3839	<desc>
3840	A comma-separated list of simple glob patterns. Changes to guest
3841	properties whose name matches one of the patterns will generate an
3842	<link to="IGuestPropertyChangedEvent"/> signal.
3843	</desc>
3844	</attribute>
3845
3846	<attribute name="teleporterEnabled" type="boolean">
3847	<desc>
3848	When set to @a true, the virtual machine becomes a target teleporter
3849	the next time it is powered on. This can only set to @a true when the
3850	VM is in the @a PoweredOff or @a Aborted state.
3851
3852	<!-- This property is automatically set to @a false when the VM is powered
3853	on. (bird: This doesn't work yet ) -->
3854	</desc>
3855	</attribute>
3856
3857	<attribute name="teleporterPort" type="unsigned long">
3858	<desc>
3859	The TCP port the target teleporter will listen for incoming
3860	teleportations on.
3861
3862	0 means the port is automatically selected upon power on. The actual
3863	value can be read from this property while the machine is waiting for
3864	incoming teleportations.
3865	</desc>
3866	</attribute>
3867
3868	<attribute name="teleporterAddress" type="wstring">
3869	<desc>
3870	The address the target teleporter will listen on. If set to an empty
3871	string, it will listen on all addresses.
3872	</desc>
3873	</attribute>
3874
3875	<attribute name="teleporterPassword" type="wstring">
3876	<desc>
3877	The password to check for on the target teleporter. This is just a
3878	very basic measure to prevent simple hacks and operators accidentally
3879	beaming a virtual machine to the wrong place.
3880	</desc>
3881	</attribute>
3882
3883	<attribute name="faultToleranceState" type="FaultToleranceState">
3884	<desc>
3885	Fault tolerance state; disabled, source or target.
3886	This property can be changed at any time. If you change it for a running
3887	VM, then the fault tolerance address and port must be set beforehand.
3888	</desc>
3889	</attribute>
3890
3891	<attribute name="faultTolerancePort" type="unsigned long">
3892	<desc>
3893	The TCP port the fault tolerance source or target will use for
3894	communication.
3895	</desc>
3896	</attribute>
3897
3898	<attribute name="faultToleranceAddress" type="wstring">
3899	<desc>
3900	The address the fault tolerance source or target.
3901	</desc>
3902	</attribute>
3903
3904	<attribute name="faultTolerancePassword" type="wstring">
3905	<desc>
3906	The password to check for on the standby VM. This is just a
3907	very basic measure to prevent simple hacks and operators accidentally
3908	choosing the wrong standby VM.
3909	</desc>
3910	</attribute>
3911
3912	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3913	<desc>
3914	The interval in ms used for syncing the state between source and target.
3915	</desc>
3916	</attribute>
3917
3918	<attribute name="RTCUseUTC" type="boolean">
3919	<desc>
3920	When set to @a true, the RTC device of the virtual machine will run
3921	in UTC time, otherwise in local time. Especially Unix guests prefer
3922	the time in UTC.
3923	</desc>
3924	</attribute>
3925
3926	<attribute name="ioCacheEnabled" type="boolean">
3927	<desc>
3928	When set to @a true, the builtin I/O cache of the virtual machine
3929	will be enabled.
3930	</desc>
3931	</attribute>
3932
3933	<attribute name="ioCacheSize" type="unsigned long">
3934	<desc>
3935	Maximum size of the I/O cache in MB.
3936	</desc>
3937	</attribute>
3938
3939	<method name="lockMachine">
3940	<desc>
3941	Locks the machine for the given session to enable the caller
3942	to make changes to the machine or start the VM or control
3943	VM execution.
3944
3945	There are two ways to lock a machine for such uses:
3946
3947	<ul>
3948	<li>If you want to make changes to the machine settings,
3949	you must obtain an exclusive write lock on the machine
3950	by setting @a lockType to @c Write.
3951
3952	This will only succeed if no other process has locked
3953	the machine to prevent conflicting changes. Only after
3954	an exclusive write lock has been obtained using this method, one
3955	can change all VM settings or execute the VM in the process
3956	space of the session object. (Note that the latter is only of
3957	interest if you actually want to write a new front-end for
3958	virtual machines; but this API gets called internally by
3959	the existing front-ends such as VBoxHeadless and the VirtualBox
3960	GUI to acquire a write lock on the machine that they are running.)
3961
3962	On success, write-locking the machine for a session creates
3963	a second copy of the IMachine object. It is this second object
3964	upon which changes can be made; in VirtualBox terminology, the
3965	second copy is "mutable". It is only this second, mutable machine
3966	object upon which you can call methods that change the
3967	machine state. After having called this method, you can
3968	obtain this second, mutable machine object using the
3969	<link to="ISession::machine" /> attribute.
3970	</li>
3971	<li>If you only want to check the machine state or control
3972	machine execution without actually changing machine
3973	settings (e.g. to get access to VM statistics or take
3974	a snapshot or save the machine state), then set the
3975	@a lockType argument to @c Shared.
3976
3977	If no other session has obtained a lock, you will obtain an
3978	exclusive write lock as described above. However, if another
3979	session has already obtained such a lock, then a link to that
3980	existing session will be established which allows you
3981	to control that existing session.
3982
3983	To find out which type of lock was obtained, you can
3984	inspect <link to="ISession::type" />, which will have been
3985	set to either @c WriteLock or @c Shared.
3986	</li>
3987	</ul>
3988
3989	In either case, you can get access to the <link to="IConsole" />
3990	object which controls VM execution.
3991
3992	Also in all of the above cases, one must always call
3993	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
3994	the machine's state will eventually be set to "Aborted".
3995
3996	To change settings on a machine, the following sequence is typically
3997	performed:
3998
3999	<ol>
4000	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4001
4002	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4003
4004	<li>Change the settings of the machine by invoking IMachine methods.</li>
4005
4006	<li>Call <link to="IMachine::saveSettings" />.</li>
4007
4008	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4009	</ol>
4010
4011	<result name="E_UNEXPECTED">
4012	Virtual machine not registered.
4013	</result>
4014	<result name="E_ACCESSDENIED">
4015	Process not started by OpenRemoteSession.
4016	</result>
4017	<result name="VBOX_E_INVALID_OBJECT_STATE">
4018	Session already open or being opened.
4019	</result>
4020	<result name="VBOX_E_VM_ERROR">
4021	Failed to assign machine to session.
4022	</result>
4023	</desc>
4024	<param name="session" type="ISession" dir="in">
4025	<desc>
4026	Session object for which the machine will be locked.
4027	</desc>
4028	</param>
4029	<param name="lockType" type="LockType" dir="in">
4030	<desc>
4031	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4032	If set to @c Shared, then either acquire an exclusive write lock or establish
4033	a link to an existing session.
4034	</desc>
4035	</param>
4036	</method>
4037
4038	<method name="launchVMProcess">
4039	<desc>
4040	Spawns a new process that will execute the virtual machine and obtains a shared
4041	lock on the machine for the calling session.
4042
4043	If launching the VM succeeds, the new VM process will create its own session
4044	and write-lock the machine for it, preventing conflicting changes from other
4045	processes. If the machine is already locked (because it is already running or
4046	because another session has a write lock), launching the VM process will therefore
4047	fail. Reversely, future attempts to obtain a write lock will also fail while the
4048	machine is running.
4049
4050	The caller's session object remains separate from the session opened by the new
4051	VM process. It receives its own <link to="IConsole" /> object which can be used
4052	to control machine execution, but it cannot be used to change all VM settings
4053	which would be available after a <link to="#lockMachine" /> call.
4054
4055	The caller must eventually release the session's shared lock by calling
4056	<link to="ISession::unlockMachine" /> on the local session object once this call
4057	has returned. However, the session's state (see <link to="ISession::state" />)
4058	will not return to "Unlocked" until the remote session has also unlocked
4059	the machine (i.e. the machine has stopped running).
4060
4061	Lauching a VM process can take some time (a new VM is started in a new process,
4062	for which memory and other resources need to be set up). Because of this,
4063	an <link to="IProgress" /> object is returned to allow the caller to wait
4064	for this asynchronous operation to be completed. Until then, the caller's
4065	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4066	and <link to="ISession::console" /> attributes cannot be accessed.
4067	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4068	similar calls to wait for completion. Completion is signalled when the VM
4069	is powered on. If launching the VM fails, error messages can be queried
4070	via the progress object, if available.
4071
4072	The progress object will have at least 2 sub-operations. The first
4073	operation covers the period up to the new VM process calls powerUp.
4074	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4075	progress object. Because <link to="IConsole::powerUp"/> may require
4076	some extra sub-operations, the <link to="IProgress::operationCount"/>
4077	may change at the completion of operation.
4078
4079	For details on the teleportation progress operation, see
4080	<link to="IConsole::powerUp"/>.
4081
4082	The @a environment argument is a string containing definitions of
4083	environment variables in the following format:
4084	@code
4085	NAME[=VALUE]\n
4086	NAME[=VALUE]\n
4087	...
4088	@endcode
4089	where <tt>\\n</tt> is the new line character. These environment
4090	variables will be appended to the environment of the VirtualBox server
4091	process. If an environment variable exists both in the server process
4092	and in this list, the value from this list takes precedence over the
4093	server's variable. If the value of the environment variable is
4094	omitted, this variable will be removed from the resulting environment.
4095	If the environment string is @c null or empty, the server environment
4096	is inherited by the started process as is.
4097
4098	<result name="E_UNEXPECTED">
4099	Virtual machine not registered.
4100	</result>
4101	<result name="E_INVALIDARG">
4102	Invalid session type @a type.
4103	</result>
4104	<result name="VBOX_E_OBJECT_NOT_FOUND">
4105	No machine matching @a machineId found.
4106	</result>
4107	<result name="VBOX_E_INVALID_OBJECT_STATE">
4108	Session already open or being opened.
4109	</result>
4110	<result name="VBOX_E_IPRT_ERROR">
4111	Launching process for machine failed.
4112	</result>
4113	<result name="VBOX_E_VM_ERROR">
4114	Failed to assign machine to session.
4115	</result>
4116	</desc>
4117	<param name="session" type="ISession" dir="in">
4118	<desc>
4119	Client session object to which the VM process will be connected (this
4120	must be in "Unlocked" state).
4121	</desc>
4122	</param>
4123	<param name="type" type="wstring" dir="in">
4124	<desc>
4125	Front-end to use for the new VM process. The following are currently supported:
4126	<ul>
4127	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4128	<li><tt>"vrdp"</tt>: VBoxHeadless (VRDP Server) front-end</li>
4129	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4130	</ul>
4131	</desc>
4132	</param>
4133	<param name="environment" type="wstring" dir="in">
4134	<desc>
4135	Environment to pass to the VM process.
4136	</desc>
4137	</param>
4138	<param name="progress" type="IProgress" dir="return">
4139	<desc>Progress object to track the operation completion.</desc>
4140	</param>
4141	</method>
4142
4143	<method name="setBootOrder">
4144	<desc>
4145	Puts the given device to the specified position in
4146	the boot order.
4147
4148	To indicate that no device is associated with the given position,
4149	<link to="DeviceType_Null"/> should be used.
4150
4151	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4152
4153	<result name="E_INVALIDARG">
4154	Boot @a position out of range.
4155	</result>
4156	<result name="E_NOTIMPL">
4157	Booting from USB @a device currently not supported.
4158	</result>
4159
4160	</desc>
4161	<param name="position" type="unsigned long" dir="in">
4162	<desc>
4163	Position in the boot order (@c 1 to the total number of
4164	devices the machine can boot from, as returned by
4165	<link to="ISystemProperties::maxBootPosition"/>).
4166	</desc>
4167	</param>
4168	<param name="device" type="DeviceType" dir="in">
4169	<desc>
4170	The type of the device used to boot at the given position.
4171	</desc>
4172	</param>
4173	</method>
4174
4175	<method name="getBootOrder" const="yes">
4176	<desc>
4177	Returns the device type that occupies the specified
4178	position in the boot order.
4179
4180	@todo [remove?]
4181	If the machine can have more than one device of the returned type
4182	(such as hard disks), then a separate method should be used to
4183	retrieve the individual device that occupies the given position.
4184
4185	If here are no devices at the given position, then
4186	<link to="DeviceType_Null"/> is returned.
4187
4188	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4189
4190	<result name="E_INVALIDARG">
4191	Boot @a position out of range.
4192	</result>
4193
4194	</desc>
4195	<param name="position" type="unsigned long" dir="in">
4196	<desc>
4197	Position in the boot order (@c 1 to the total number of
4198	devices the machine can boot from, as returned by
4199	<link to="ISystemProperties::maxBootPosition"/>).
4200	</desc>
4201	</param>
4202	<param name="device" type="DeviceType" dir="return">
4203	<desc>
4204	Device at the given position.
4205	</desc>
4206	</param>
4207	</method>
4208
4209	<method name="attachDevice">
4210	<desc>
4211	Attaches a device and optionally mounts a medium to the given storage
4212	controller (<link to="IStorageController" />, identified by @a name),
4213	at the indicated port and device.
4214
4215	This method is intended for managing storage devices in general while a
4216	machine is powered off. It can be used to attach and detach fixed
4217	and removeable media. The following kind of media can be attached
4218	to a machine:
4219
4220	<ul>
4221	<li>For fixed and removable media, you can pass in a medium that was
4222	previously opened using <link to="IVirtualBox::openMedium" />.
4223	</li>
4224
4225	<li>Only for storage devices supporting removable media (such as
4226	DVDs and floppies), you can also specify a null pointer to
4227	indicate an empty drive or one of the medium objects listed
4228	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4229	arrays to indicate a host drive.
4230	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4231	to change the media while the machine is running.
4232	</li>
4233	</ul>
4234
4235	In a VM's default configuration of virtual machines, the secondary
4236	master of the IDE controller is used for a CD/DVD drive.
4237
4238	After calling this returns successfully, a new instance of
4239	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4240	attachments (see <link to="IMachine::mediumAttachments"/>).
4241
4242	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4243	information about attaching media.
4244
4245	The specified device slot must not have a device attached to it,
4246	or this method will fail.
4247
4248	<note>
4249	You cannot attach a device to a newly created machine until
4250	this machine's settings are saved to disk using
4251	<link to="#saveSettings"/>.
4252	</note>
4253	<note>
4254	If the medium is being attached indirectly, a new differencing medium
4255	will implicitly be created for it and attached instead. If the
4256	changes made to the machine settings (including this indirect
4257	attachment) are later cancelled using <link to="#discardSettings"/>,
4258	this implicitly created differencing medium will implicitly
4259	be deleted.
4260	</note>
4261
4262	<result name="E_INVALIDARG">
4263	SATA device, SATA port, IDE port or IDE slot out of range, or
4264	file or UUID not found.
4265	</result>
4266	<result name="VBOX_E_INVALID_OBJECT_STATE">
4267	Machine must be registered before media can be attached.
4268	</result>
4269	<result name="VBOX_E_INVALID_VM_STATE">
4270	Invalid machine state.
4271	</result>
4272	<result name="VBOX_E_OBJECT_IN_USE">
4273	A medium is already attached to this or another virtual machine.
4274	</result>
4275
4276	</desc>
4277	<param name="name" type="wstring" dir="in">
4278	<desc>Name of the storage controller to attach the device to.</desc>
4279	</param>
4280	<param name="controllerPort" type="long" dir="in">
4281	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4282	the primary controller and 1 specifies the secondary controller.
4283	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4284	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4285	</param>
4286	<param name="device" type="long" dir="in">
4287	<desc>Device slot in the given port to attach the device to. This is only
4288	relevant for IDE controllers, for which 0 specifies the master device and
4289	1 specifies the slave device. For all other controller types, this must
4290	be 0.</desc>
4291	</param>
4292	<param name="type" type="DeviceType" dir="in">
4293	<desc>Device type of the attached device. For media opened by
4294	<link to="IVirtualBox::openMedium" />, this must match the device type
4295	specified there.</desc>
4296	</param>
4297	<param name="medium" type="IMedium" dir="in">
4298	<desc>Medium to mount or NULL for an empty drive.</desc>
4299	</param>
4300	</method>
4301
4302	<method name="detachDevice">
4303	<desc>
4304	Detaches the device attached to a device slot of the specified bus.
4305
4306	Detaching the device from the virtual machine is deferred. This means
4307	that the medium remains associated with the machine when this method
4308	returns and gets actually de-associated only after a successful
4309	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4310	for more detailed information about attaching media.
4311
4312	<note>
4313	You cannot detach a device from a running machine.
4314	</note>
4315	<note>
4316	Detaching differencing media implicitly created by <link
4317	to="#attachDevice"/> for the indirect attachment using this
4318	method will <b>not</b> implicitly delete them. The
4319	<link to="IMedium::deleteStorage"/> operation should be
4320	explicitly performed by the caller after the medium is successfully
4321	detached and the settings are saved with
4322	<link to="#saveSettings"/>, if it is the desired action.
4323	</note>
4324
4325	<result name="VBOX_E_INVALID_VM_STATE">
4326	Attempt to detach medium from a running virtual machine.
4327	</result>
4328	<result name="VBOX_E_OBJECT_NOT_FOUND">
4329	No medium attached to given slot/bus.
4330	</result>
4331	<result name="VBOX_E_NOT_SUPPORTED">
4332	Medium format does not support storage deletion.
4333	</result>
4334
4335	</desc>
4336	<param name="name" type="wstring" dir="in">
4337	<desc>Name of the storage controller to detach the medium from.</desc>
4338	</param>
4339	<param name="controllerPort" type="long" dir="in">
4340	<desc>Port number to detach the medium from.</desc>
4341	</param>
4342	<param name="device" type="long" dir="in">
4343	<desc>Device slot number to detach the medium from.</desc>
4344	</param>
4345	</method>
4346
4347	<method name="passthroughDevice">
4348	<desc>
4349	Sets the passthrough mode of an existing DVD device. Changing the
4350	setting while the VM is running is forbidden. The setting is only used
4351	if at VM start the device is configured as a host DVD drive, in all
4352	other cases it is ignored. The device must already exist; see
4353	<link to="IMachine::attachDevice"/> for how to attach a new device.
4354
4355	The @a controllerPort and @a device parameters specify the device slot and
4356	have have the same meaning as with <link to="IMachine::attachDevice" />.
4357
4358	<result name="E_INVALIDARG">
4359	SATA device, SATA port, IDE port or IDE slot out of range.
4360	</result>
4361	<result name="VBOX_E_INVALID_OBJECT_STATE">
4362	Attempt to modify an unregistered virtual machine.
4363	</result>
4364	<result name="VBOX_E_INVALID_VM_STATE">
4365	Invalid machine state.
4366	</result>
4367
4368	</desc>
4369	<param name="name" type="wstring" dir="in">
4370	<desc>Name of the storage controller.</desc>
4371	</param>
4372	<param name="controllerPort" type="long" dir="in">
4373	<desc>Storage controller port.</desc>
4374	</param>
4375	<param name="device" type="long" dir="in">
4376	<desc>Device slot in the given port.</desc>
4377	</param>
4378	<param name="passthrough" type="boolean" dir="in">
4379	<desc>New value for the passthrough setting.</desc>
4380	</param>
4381	</method>
4382
4383	<method name="mountMedium">
4384	<desc>
4385	Mounts a medium (<link to="IMedium" />, identified
4386	by the given UUID @a id) to the given storage controller
4387	(<link to="IStorageController" />, identified by @a name),
4388	at the indicated port and device. The device must already exist;
4389	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4390
4391	This method is intended only for managing removable media, where the
4392	device is fixed but media is changeable at runtime (such as DVDs
4393	and floppies). It cannot be used for fixed media such as hard disks.
4394
4395	The @a controllerPort and @a device parameters specify the device slot and
4396	have have the same meaning as with <link to="IMachine::attachDevice" />.
4397
4398	The specified device slot can have a medium mounted, which will be
4399	unmounted first. Specifying a zero UUID (or an empty string) for
4400	@a medium does just an unmount.
4401
4402	See <link to="IMedium"/> for more detailed information about
4403	attaching media.
4404
4405	<result name="E_INVALIDARG">
4406	SATA device, SATA port, IDE port or IDE slot out of range.
4407	</result>
4408	<result name="VBOX_E_INVALID_OBJECT_STATE">
4409	Attempt to attach medium to an unregistered virtual machine.
4410	</result>
4411	<result name="VBOX_E_INVALID_VM_STATE">
4412	Invalid machine state.
4413	</result>
4414	<result name="VBOX_E_OBJECT_IN_USE">
4415	Medium already attached to this or another virtual machine.
4416	</result>
4417
4418	</desc>
4419	<param name="name" type="wstring" dir="in">
4420	<desc>Name of the storage controller to attach the medium to.</desc>
4421	</param>
4422	<param name="controllerPort" type="long" dir="in">
4423	<desc>Port to attach the medium to.</desc>
4424	</param>
4425	<param name="device" type="long" dir="in">
4426	<desc>Device slot in the given port to attach the medium to.</desc>
4427	</param>
4428	<param name="medium" type="IMedium" dir="in">
4429	<desc>Medium to mount or NULL for an empty drive.</desc>
4430	</param>
4431	<param name="force" type="boolean" dir="in">
4432	<desc>Allows to force unmount/mount of a medium which is locked by
4433	the device slot in the given port to attach the medium to.</desc>
4434	</param>
4435	</method>
4436
4437	<method name="getMedium" const="yes">
4438	<desc>
4439	Returns the virtual medium attached to a device slot of the specified
4440	bus.
4441
4442	Note that if the medium was indirectly attached by
4443	<link to="#mountMedium"/> to the given device slot then this
4444	method will return not the same object as passed to the
4445	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4446	more detailed information about mounting a medium.
4447
4448	<result name="VBOX_E_OBJECT_NOT_FOUND">
4449	No medium attached to given slot/bus.
4450	</result>
4451
4452	</desc>
4453	<param name="name" type="wstring" dir="in">
4454	<desc>Name of the storage controller the medium is attached to.</desc>
4455	</param>
4456	<param name="controllerPort" type="long" dir="in">
4457	<desc>Port to query.</desc>
4458	</param>
4459	<param name="device" type="long" dir="in">
4460	<desc>Device slot in the given port to query.</desc>
4461	</param>
4462	<param name="medium" type="IMedium" dir="return">
4463	<desc>Attached medium object.</desc>
4464	</param>
4465	</method>
4466
4467	<method name="getMediumAttachmentsOfController" const="yes">
4468	<desc>
4469	Returns an array of medium attachments which are attached to the
4470	the controller with the given name.
4471
4472	<result name="VBOX_E_OBJECT_NOT_FOUND">
4473	A storage controller with given name doesn't exist.
4474	</result>
4475	</desc>
4476	<param name="name" type="wstring" dir="in"/>
4477	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4478	</method>
4479
4480	<method name="getMediumAttachment" const="yes">
4481	<desc>
4482	Returns a medium attachment which corresponds to the controller with
4483	the given name, on the given port and device slot.
4484
4485	<result name="VBOX_E_OBJECT_NOT_FOUND">
4486	No attachment exists for the given controller/port/device combination.
4487	</result>
4488	</desc>
4489	<param name="name" type="wstring" dir="in"/>
4490	<param name="controllerPort" type="long" dir="in"/>
4491	<param name="device" type="long" dir="in"/>
4492	<param name="attachment" type="IMediumAttachment" dir="return"/>
4493	</method>
4494
4495	<method name="getNetworkAdapter" const="yes">
4496	<desc>
4497	Returns the network adapter associated with the given slot.
4498	Slots are numbered sequentially, starting with zero. The total
4499	number of adapters per machine is defined by the
4500	<link to="ISystemProperties::networkAdapterCount"/> property,
4501	so the maximum slot number is one less than that property's value.
4502
4503	<result name="E_INVALIDARG">
4504	Invalid @a slot number.
4505	</result>
4506
4507	</desc>
4508	<param name="slot" type="unsigned long" dir="in"/>
4509	<param name="adapter" type="INetworkAdapter" dir="return"/>
4510	</method>
4511
4512	<method name="addStorageController">
4513	<desc>
4514	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4515	machine and returns it as an instance of
4516	<link to="IStorageController" />.
4517
4518	@a name identifies the controller for subsequent calls such as
4519	<link to="#getStorageControllerByName" />,
4520	<link to="#getStorageControllerByInstance" />,
4521	<link to="#removeStorageController" />,
4522	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4523
4524	After the controller has been added, you can set its exact
4525	type by setting the <link to="IStorageController::controllerType" />.
4526
4527	<result name="VBOX_E_OBJECT_IN_USE">
4528	A storage controller with given name exists already.
4529	</result>
4530	<result name="E_INVALIDARG">
4531	Invalid @a controllerType.
4532	</result>
4533	</desc>
4534	<param name="name" type="wstring" dir="in"/>
4535	<param name="connectionType" type="StorageBus" dir="in"/>
4536	<param name="controller" type="IStorageController" dir="return"/>
4537	</method>
4538
4539	<method name="getStorageControllerByName" const="yes">
4540	<desc>
4541	Returns a storage controller with the given name.
4542
4543	<result name="VBOX_E_OBJECT_NOT_FOUND">
4544	A storage controller with given name doesn't exist.
4545	</result>
4546	</desc>
4547	<param name="name" type="wstring" dir="in"/>
4548	<param name="storageController" type="IStorageController" dir="return"/>
4549	</method>
4550
4551	<method name="getStorageControllerByInstance" const="yes">
4552	<desc>
4553	Returns a storage controller with the given instance number.
4554
4555	<result name="VBOX_E_OBJECT_NOT_FOUND">
4556	A storage controller with given instance number doesn't exist.
4557	</result>
4558	</desc>
4559	<param name="instance" type="unsigned long" dir="in"/>
4560	<param name="storageController" type="IStorageController" dir="return"/>
4561	</method>
4562
4563	<method name="removeStorageController">
4564	<desc>
4565	Removes a storage controller from the machine.
4566
4567	<result name="VBOX_E_OBJECT_NOT_FOUND">
4568	A storage controller with given name doesn't exist.
4569	</result>
4570	</desc>
4571	<param name="name" type="wstring" dir="in"/>
4572	</method>
4573
4574	<method name="getSerialPort" const="yes">
4575	<desc>
4576	Returns the serial port associated with the given slot.
4577	Slots are numbered sequentially, starting with zero. The total
4578	number of serial ports per machine is defined by the
4579	<link to="ISystemProperties::serialPortCount"/> property,
4580	so the maximum slot number is one less than that property's value.
4581
4582	<result name="E_INVALIDARG">
4583	Invalid @a slot number.
4584	</result>
4585
4586	</desc>
4587	<param name="slot" type="unsigned long" dir="in"/>
4588	<param name="port" type="ISerialPort" dir="return"/>
4589	</method>
4590
4591	<method name="getParallelPort" const="yes">
4592	<desc>
4593	Returns the parallel port associated with the given slot.
4594	Slots are numbered sequentially, starting with zero. The total
4595	number of parallel ports per machine is defined by the
4596	<link to="ISystemProperties::parallelPortCount"/> property,
4597	so the maximum slot number is one less than that property's value.
4598
4599	<result name="E_INVALIDARG">
4600	Invalid @a slot number.
4601	</result>
4602
4603	</desc>
4604	<param name="slot" type="unsigned long" dir="in"/>
4605	<param name="port" type="IParallelPort" dir="return"/>
4606	</method>
4607
4608	<method name="getExtraDataKeys">
4609	<desc>
4610	Returns an array representing the machine-specific extra data keys
4611	which currently have values defined.
4612	</desc>
4613	<param name="value" type="wstring" dir="return" safearray="yes">
4614	<desc>Array of extra data keys.</desc>
4615	</param>
4616	</method>
4617
4618	<method name="getExtraData">
4619	<desc>
4620	Returns associated machine-specific extra data.
4621
4622	If the requested data @a key does not exist, this function will
4623	succeed and return an empty string in the @a value argument.
4624
4625	<result name="VBOX_E_FILE_ERROR">
4626	Settings file not accessible.
4627	</result>
4628	<result name="VBOX_E_XML_ERROR">
4629	Could not parse the settings file.
4630	</result>
4631
4632	</desc>
4633	<param name="key" type="wstring" dir="in">
4634	<desc>Name of the data key to get.</desc>
4635	</param>
4636	<param name="value" type="wstring" dir="return">
4637	<desc>Value of the requested data key.</desc>
4638	</param>
4639	</method>
4640
4641	<method name="setExtraData">
4642	<desc>
4643	Sets associated machine-specific extra data.
4644
4645	If you pass @c null or an empty string as a key @a value, the given
4646	@a key will be deleted.
4647
4648	<note>
4649	Before performing the actual data change, this method will ask all
4650	registered listeners using the
4651	<link to="IExtraDataCanChangeEvent"/>
4652	notification for a permission. If one of the listeners refuses the
4653	new value, the change will not be performed.
4654	</note>
4655	<note>
4656	On success, the
4657	<link to="IExtraDataChangedEvent"/> notification
4658	is called to inform all registered listeners about a successful data
4659	change.
4660	</note>
4661	<note>
4662	This method can be called outside the machine session and therefore
4663	it's a caller's responsibility to handle possible race conditions
4664	when several clients change the same key at the same time.
4665	</note>
4666
4667	<result name="VBOX_E_FILE_ERROR">
4668	Settings file not accessible.
4669	</result>
4670	<result name="VBOX_E_XML_ERROR">
4671	Could not parse the settings file.
4672	</result>
4673
4674	</desc>
4675	<param name="key" type="wstring" dir="in">
4676	<desc>Name of the data key to set.</desc>
4677	</param>
4678	<param name="value" type="wstring" dir="in">
4679	<desc>Value to assign to the key.</desc>
4680	</param>
4681	</method>
4682
4683	<method name="getCPUProperty" const="yes">
4684	<desc>
4685	Returns the virtual CPU boolean value of the specified property.
4686
4687	<result name="E_INVALIDARG">
4688	Invalid property.
4689	</result>
4690
4691	</desc>
4692	<param name="property" type="CPUPropertyType" dir="in">
4693	<desc>
4694	Property type to query.
4695	</desc>
4696	</param>
4697	<param name="value" type="boolean" dir="return">
4698	<desc>
4699	Property value.
4700	</desc>
4701	</param>
4702	</method>
4703
4704	<method name="setCPUProperty">
4705	<desc>
4706	Sets the virtual CPU boolean value of the specified property.
4707
4708	<result name="E_INVALIDARG">
4709	Invalid property.
4710	</result>
4711
4712	</desc>
4713	<param name="property" type="CPUPropertyType" dir="in">
4714	<desc>
4715	Property type to query.
4716	</desc>
4717	</param>
4718	<param name="value" type="boolean" dir="in">
4719	<desc>
4720	Property value.
4721	</desc>
4722	</param>
4723	</method>
4724
4725	<method name="getCPUIDLeaf" const="yes">
4726	<desc>
4727	Returns the virtual CPU cpuid information for the specified leaf.
4728
4729	Currently supported index values for cpuid:
4730	Standard CPUID leafs: 0 - 0xA
4731	Extended CPUID leafs: 0x80000000 - 0x8000000A
4732
4733	See the Intel and AMD programmer's manuals for detailed information
4734	about the cpuid instruction and its leafs.
4735	<result name="E_INVALIDARG">
4736	Invalid id.
4737	</result>
4738
4739	</desc>
4740	<param name="id" type="unsigned long" dir="in">
4741	<desc>
4742	CPUID leaf index.
4743	</desc>
4744	</param>
4745	<param name="valEax" type="unsigned long" dir="out">
4746	<desc>
4747	CPUID leaf value for register eax.
4748	</desc>
4749	</param>
4750	<param name="valEbx" type="unsigned long" dir="out">
4751	<desc>
4752	CPUID leaf value for register ebx.
4753	</desc>
4754	</param>
4755	<param name="valEcx" type="unsigned long" dir="out">
4756	<desc>
4757	CPUID leaf value for register ecx.
4758	</desc>
4759	</param>
4760	<param name="valEdx" type="unsigned long" dir="out">
4761	<desc>
4762	CPUID leaf value for register edx.
4763	</desc>
4764	</param>
4765	</method>
4766
4767	<method name="setCPUIDLeaf">
4768	<desc>
4769	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4770	are not passed unmodified. VirtualBox clears features that it doesn't support.
4771
4772	Currently supported index values for cpuid:
4773	Standard CPUID leafs: 0 - 0xA
4774	Extended CPUID leafs: 0x80000000 - 0x8000000A
4775
4776	See the Intel and AMD programmer's manuals for detailed information
4777	about the cpuid instruction and its leafs.
4778
4779	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4780	random crashes inside VMs.
4781	<result name="E_INVALIDARG">
4782	Invalid id.
4783	</result>
4784
4785	</desc>
4786	<param name="id" type="unsigned long" dir="in">
4787	<desc>
4788	CPUID leaf index.
4789	</desc>
4790	</param>
4791	<param name="valEax" type="unsigned long" dir="in">
4792	<desc>
4793	CPUID leaf value for register eax.
4794	</desc>
4795	</param>
4796	<param name="valEbx" type="unsigned long" dir="in">
4797	<desc>
4798	CPUID leaf value for register ebx.
4799	</desc>
4800	</param>
4801	<param name="valEcx" type="unsigned long" dir="in">
4802	<desc>
4803	CPUID leaf value for register ecx.
4804	</desc>
4805	</param>
4806	<param name="valEdx" type="unsigned long" dir="in">
4807	<desc>
4808	CPUID leaf value for register edx.
4809	</desc>
4810	</param>
4811	</method>
4812
4813	<method name="removeCPUIDLeaf">
4814	<desc>
4815	Removes the virtual CPU cpuid leaf for the specified index
4816
4817	<result name="E_INVALIDARG">
4818	Invalid id.
4819	</result>
4820
4821	</desc>
4822	<param name="id" type="unsigned long" dir="in">
4823	<desc>
4824	CPUID leaf index.
4825	</desc>
4826	</param>
4827	</method>
4828
4829	<method name="removeAllCPUIDLeaves">
4830	<desc>
4831	Removes all the virtual CPU cpuid leaves
4832	</desc>
4833	</method>
4834
4835	<method name="getHWVirtExProperty" const="yes">
4836	<desc>
4837	Returns the value of the specified hardware virtualization boolean property.
4838
4839	<result name="E_INVALIDARG">
4840	Invalid property.
4841	</result>
4842
4843	</desc>
4844	<param name="property" type="HWVirtExPropertyType" dir="in">
4845	<desc>
4846	Property type to query.
4847	</desc>
4848	</param>
4849	<param name="value" type="boolean" dir="return">
4850	<desc>
4851	Property value.
4852	</desc>
4853	</param>
4854	</method>
4855
4856	<method name="setHWVirtExProperty">
4857	<desc>
4858	Sets a new value for the specified hardware virtualization boolean property.
4859
4860	<result name="E_INVALIDARG">
4861	Invalid property.
4862	</result>
4863
4864	</desc>
4865	<param name="property" type="HWVirtExPropertyType" dir="in">
4866	<desc>
4867	Property type to set.
4868	</desc>
4869	</param>
4870	<param name="value" type="boolean" dir="in">
4871	<desc>
4872	New property value.
4873	</desc>
4874	</param>
4875	</method>
4876
4877	<method name="saveSettings">
4878	<desc>
4879	Saves any changes to machine settings made since the session
4880	has been opened or a new machine has been created, or since the
4881	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4882	For registered machines, new settings become visible to all
4883	other VirtualBox clients after successful invocation of this
4884	method.
4885	<note>
4886	The method sends <link to="IMachineDataChangedEvent"/>
4887	notification event after the configuration has been successfully
4888	saved (only for registered machines).
4889	</note>
4890	<note>
4891	Calling this method is only valid on instances returned
4892	by <link to="ISession::machine"/> and on new machines
4893	created by <link to="IVirtualBox::createMachine"/> but not
4894	yet registered, or on unregistered machines after calling
4895	<link to="IMachine::unregister"/>.
4896	</note>
4897
4898	<result name="VBOX_E_FILE_ERROR">
4899	Settings file not accessible.
4900	</result>
4901	<result name="VBOX_E_XML_ERROR">
4902	Could not parse the settings file.
4903	</result>
4904	<result name="E_ACCESSDENIED">
4905	Modification request refused.
4906	</result>
4907
4908	</desc>
4909	</method>
4910
4911	<method name="discardSettings">
4912	<desc>
4913	Discards any changes to the machine settings made since the session
4914	has been opened or since the last call to <link to="#saveSettings"/>
4915	or <link to="#discardSettings"/>.
4916	<note>
4917	Calling this method is only valid on instances returned
4918	by <link to="ISession::machine"/> and on new machines
4919	created by <link to="IVirtualBox::createMachine"/> or
4920	opened by <link to="IVirtualBox::openMachine"/> but not
4921	yet registered, or on unregistered machines after calling
4922	<link to="IMachine::unregister"/>.
4923	</note>
4924
4925	<result name="VBOX_E_INVALID_VM_STATE">
4926	Virtual machine is not mutable.
4927	</result>
4928
4929	</desc>
4930	</method>
4931
4932	<method name="unregister">
4933	<desc>
4934	Unregisters the machine, which must have been previously registered using
4935	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
4936	cleanup before the machine is unregistered.
4937
4938	This method does not delete any files. It only changes the machine configuration and
4939	the list of registered machines in the VirtualBox object. To delete the files which
4940	belonged to the machine, including the XML file of the machine itself, call
4941	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
4942	from this method.
4943
4944	How thoroughly this method cleans up the machine configuration before unregistering
4945	the machine depends on the @a cleanupMode argument.
4946
4947	<ul>
4948	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
4949	cleanup will be performed. The call will fail if the machine is in "Saved" state
4950	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
4951	It is the responsibility of the caller to delete all such configuration in this mode.
4952	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
4953	which it replaces.</li>
4954	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
4955	state or if it has snapshots or media attached. All media attached to the current machine
4956	state or in snapshots will be detached. No medium objects will be returned; all of the
4957	machine's media will remain open.</li>
4958	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
4959	except that all the hard disk medium objects which were detached from the machine will
4960	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
4961	API for closing and deletion.</li>
4962	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
4963	that all media will be returned in the array, including removeable media like DVDs and
4964	floppies. This might be useful if the user wants to inspect in detail which media were
4965	attached to the machine. Be careful when passing the media array to <link to="#delete" />
4966	in that case because users will typically want to preserve ISO and RAW image files.</li>
4967	</ul>
4968
4969	This API does not verify whether the media files returned in the array are still
4970	attached to other machines (i.e. shared between several machines). If such a shared
4971	image is passed to <link to="#delete" /> however, closing the image will fail there
4972	and the image will be silently skipped.
4973
4974	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
4975	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
4976	deleted with all its saved states and hard disk images, but images for removeable
4977	drives (such as ISO and RAW files) will remain on disk.
4978
4979	The call will fail if the machine is currently locked (see <link to="ISession" />).
4980	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
4981	before unregistering it.
4982
4983	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
4984	is fired.
4985
4986	<note>
4987	If the given machine is inaccessible (see <link to="#accessible"/>), it
4988	will be unregistered and fully uninitialized right afterwards. As a result,
4989	the returned machine object will be unusable and an attempt to call
4990	<b>any</b> method will return the "Object not ready" error.
4991	</note>
4992
4993	<result name="VBOX_E_INVALID_OBJECT_STATE">
4994	Machine is currently locked for a session.
4995	</result>
4996	</desc>
4997
4998	<param name="cleanupMode" type="CleanupMode" dir="in">
4999	<desc>How to clean up after the machine has been unregistered.</desc>
5000	</param>
5001	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5002	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5003	</param>
5004	</method>
5005
5006	<method name="delete">
5007	<desc>
5008	Deletes the files associated with this machine from disk. If medium objects are passed
5009	in with the @a aMedia argument, they are closed and, if closing was succesful, their
5010	storage files are deleted as well. For convenience, this array of media files can be
5011	the same as the one returned from a previous <link to="#unregister" /> call.
5012
5013	This method must only be called on machines which are either write-locked (i.e. on instances
5014	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5015	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5016	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5017
5018	The following files will be deleted by this method:
5019	<ul>
5020	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5021	argument other than "UnregisterOnly", this will delete all saved state files that
5022	the machine had in use; possibly one if the machine was in "Saved" state and one
5023	for each online snapshot that the machine had.</li>
5024	<li>On each medium object passed in the @a aMedia array, this will call
5025	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5026	medium's storage on disk. Since the close() call will fail if the medium is still
5027	in use, e.g. because it is still attached to a second machine; in that case the
5028	storage will not be deleted.</li>
5029	<li>Finally, the machine's own XML file will be deleted.</li>
5030	</ul>
5031
5032	Since deleting large disk image files can be a time-consuming I/O operation, this
5033	method operates asynchronously and returns an IProgress object to allow the caller
5034	to monitor the progress. There will be one sub-operation for each file that is
5035	being deleted (saved state or medium storage file).
5036
5037	<note>
5038	<link to="#settingsModified"/> will return @c true after this
5039	method successfully returns.
5040	</note>
5041
5042	<result name="VBOX_E_INVALID_VM_STATE">
5043	Machine is registered but not write-locked.
5044	</result>
5045	<result name="VBOX_E_IPRT_ERROR">
5046	Could not delete the settings file.
5047	</result>
5048	</desc>
5049	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5050	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5051	</param>
5052	<param name="aProgress" type="IProgress" dir="return">
5053	<desc>Progress object to track the operation completion.</desc>
5054	</param>
5055	</method>
5056
5057	<method name="export">
5058	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5059	steps required to export VirtualBox machines to OVF.
5060	</desc>
5061
5062	<param name="aAppliance" type="IAppliance" dir="in">
5063	<desc>Appliance to export this machine to.</desc>
5064	</param>
5065	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5066	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5067	</param>
5068	</method >
5069
5070	<method name="getSnapshot">
5071	<desc>
5072	Returns a snapshot of this machine with the given UUID.
5073	A @c null UUID can be used to obtain the first snapshot
5074	taken on this machine. This is useful if you want to traverse
5075	the whole tree of snapshots starting from the root.
5076
5077	<result name="VBOX_E_OBJECT_NOT_FOUND">
5078	Virtual machine has no snapshots or snapshot not found.
5079	</result>
5080
5081	</desc>
5082	<param name="id" type="uuid" mod="string" dir="in">
5083	<desc>UUID of the snapshot to get</desc>
5084	</param>
5085	<param name="snapshot" type="ISnapshot" dir="return">
5086	<desc>Snapshot object with the given UUID.</desc>
5087	</param>
5088	</method>
5089
5090	<method name="findSnapshot">
5091	<desc>
5092	Returns a snapshot of this machine with the given name.
5093
5094	<result name="VBOX_E_OBJECT_NOT_FOUND">
5095	Virtual machine has no snapshots or snapshot not found.
5096	</result>
5097
5098	</desc>
5099	<param name="name" type="wstring" dir="in">
5100	<desc>Name of the snapshot to find</desc>
5101	</param>
5102	<param name="snapshot" type="ISnapshot" dir="return">
5103	<desc>Snapshot object with the given name.</desc>
5104	</param>
5105	</method>
5106
5107	<method name="setCurrentSnapshot">
5108	<desc>
5109	Sets the current snapshot of this machine.
5110	<note>
5111	In the current implementation, this operation is not
5112	implemented.
5113	</note>
5114	</desc>
5115	<param name="id" type="uuid" mod="string" dir="in">
5116	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5117	</param>
5118	</method>
5119
5120	<method name="createSharedFolder">
5121	<desc>
5122	Creates a new permanent shared folder by associating the given logical
5123	name with the given host path, adds it to the collection of shared
5124	folders and starts sharing it. Refer to the description of
5125	<link to="ISharedFolder"/> to read more about logical names.
5126
5127	<result name="VBOX_E_OBJECT_IN_USE">
5128	Shared folder already exists.
5129	</result>
5130	<result name="VBOX_E_FILE_ERROR">
5131	Shared folder @a hostPath not accessible.
5132	</result>
5133
5134	</desc>
5135	<param name="name" type="wstring" dir="in">
5136	<desc>Unique logical name of the shared folder.</desc>
5137	</param>
5138	<param name="hostPath" type="wstring" dir="in">
5139	<desc>Full path to the shared folder in the host file system.</desc>
5140	</param>
5141	<param name="writable" type="boolean" dir="in">
5142	<desc>Whether the share is writable or readonly.</desc>
5143	</param>
5144	<param name="automount" type="boolean" dir="in">
5145	<desc>Whether the share gets automatically mounted by the guest
5146	or not.</desc>
5147	</param>
5148	</method>
5149
5150	<method name="removeSharedFolder">
5151	<desc>
5152	Removes the permanent shared folder with the given name previously
5153	created by <link to="#createSharedFolder"/> from the collection of
5154	shared folders and stops sharing it.
5155
5156	<result name="VBOX_E_INVALID_VM_STATE">
5157	Virtual machine is not mutable.
5158	</result>
5159	<result name="VBOX_E_OBJECT_NOT_FOUND">
5160	Shared folder @a name does not exist.
5161	</result>
5162
5163	</desc>
5164	<param name="name" type="wstring" dir="in">
5165	<desc>Logical name of the shared folder to remove.</desc>
5166	</param>
5167	</method>
5168
5169	<method name="canShowConsoleWindow">
5170	<desc>
5171	Returns @c true if the VM console process can activate the
5172	console window and bring it to foreground on the desktop of
5173	the host PC.
5174	<note>
5175	This method will fail if a session for this machine is not
5176	currently open.
5177	</note>
5178
5179	<result name="VBOX_E_INVALID_VM_STATE">
5180	Machine session is not open.
5181	</result>
5182
5183	</desc>
5184	<param name="canShow" type="boolean" dir="return">
5185	<desc>
5186	@c true if the console window can be shown and @c false otherwise.
5187	</desc>
5188	</param>
5189	</method>
5190
5191	<method name="showConsoleWindow">
5192	<desc>
5193	Activates the console window and brings it to foreground on
5194	the desktop of the host PC. Many modern window managers on
5195	many platforms implement some sort of focus stealing
5196	prevention logic, so that it may be impossible to activate
5197	a window without the help of the currently active
5198	application. In this case, this method will return a non-zero
5199	identifier that represents the top-level window of the VM
5200	console process. The caller, if it represents a currently
5201	active process, is responsible to use this identifier (in a
5202	platform-dependent manner) to perform actual window
5203	activation.
5204	<note>
5205	This method will fail if a session for this machine is not
5206	currently open.
5207	</note>
5208
5209	<result name="VBOX_E_INVALID_VM_STATE">
5210	Machine session is not open.
5211	</result>
5212
5213	</desc>
5214	<param name="winId" type="long long" dir="return">
5215	<desc>
5216	Platform-dependent identifier of the top-level VM console
5217	window, or zero if this method has performed all actions
5218	necessary to implement the <i>show window</i> semantics for
5219	the given platform and/or VirtualBox front-end.
5220	</desc>
5221	</param>
5222	</method>
5223
5224	<method name="getGuestProperty" const="yes">
5225	<desc>
5226	Reads an entry from the machine's guest property store.
5227
5228	<result name="VBOX_E_INVALID_VM_STATE">
5229	Machine session is not open.
5230	</result>
5231
5232	</desc>
5233	<param name="name" type="wstring" dir="in">
5234	<desc>
5235	The name of the property to read.
5236	</desc>
5237	</param>
5238	<param name="value" type="wstring" dir="out">
5239	<desc>
5240	The value of the property. If the property does not exist then this
5241	will be empty.
5242	</desc>
5243	</param>
5244	<param name="timestamp" type="long long" dir="out">
5245	<desc>
5246	The time at which the property was last modified, as seen by the
5247	server process.
5248	</desc>
5249	</param>
5250	<param name="flags" type="wstring" dir="out">
5251	<desc>
5252	Additional property parameters, passed as a comma-separated list of
5253	"name=value" type entries.
5254	</desc>
5255	</param>
5256	</method>
5257
5258	<method name="getGuestPropertyValue" const="yes">
5259	<desc>
5260	Reads a value from the machine's guest property store.
5261
5262	<result name="VBOX_E_INVALID_VM_STATE">
5263	Machine session is not open.
5264	</result>
5265
5266	</desc>
5267	<param name="property" type="wstring" dir="in">
5268	<desc>
5269	The name of the property to read.
5270	</desc>
5271	</param>
5272	<param name="value" type="wstring" dir="return">
5273	<desc>
5274	The value of the property. If the property does not exist then this
5275	will be empty.
5276	</desc>
5277	</param>
5278	</method>
5279
5280	<method name="getGuestPropertyTimestamp" const="yes">
5281	<desc>
5282	Reads a property timestamp from the machine's guest property store.
5283
5284	<result name="VBOX_E_INVALID_VM_STATE">
5285	Machine session is not open.
5286	</result>
5287
5288	</desc>
5289	<param name="property" type="wstring" dir="in">
5290	<desc>
5291	The name of the property to read.
5292	</desc>
5293	</param>
5294	<param name="value" type="long long" dir="return">
5295	<desc>
5296	The timestamp. If the property does not exist then this will be
5297	empty.
5298	</desc>
5299	</param>
5300	</method>
5301
5302	<method name="setGuestProperty">
5303	<desc>
5304	Sets, changes or deletes an entry in the machine's guest property
5305	store.
5306
5307	<result name="E_ACCESSDENIED">
5308	Property cannot be changed.
5309	</result>
5310	<result name="E_INVALIDARG">
5311	Invalid @a flags.
5312	</result>
5313	<result name="VBOX_E_INVALID_VM_STATE">
5314	Virtual machine is not mutable or session not open.
5315	</result>
5316	<result name="VBOX_E_INVALID_OBJECT_STATE">
5317	Cannot set transient property when machine not running.
5318	</result>
5319
5320	</desc>
5321	<param name="property" type="wstring" dir="in">
5322	<desc>
5323	The name of the property to set, change or delete.
5324	</desc>
5325	</param>
5326	<param name="value" type="wstring" dir="in">
5327	<desc>
5328	The new value of the property to set, change or delete. If the
5329	property does not yet exist and value is non-empty, it will be
5330	created. If the value is @c null or empty, the property will be
5331	deleted if it exists.
5332	</desc>
5333	</param>
5334	<param name="flags" type="wstring" dir="in">
5335	<desc>
5336	Additional property parameters, passed as a comma-separated list of
5337	"name=value" type entries.
5338	</desc>
5339	</param>
5340	</method>
5341
5342	<method name="setGuestPropertyValue">
5343	<desc>
5344	Sets, changes or deletes a value in the machine's guest property
5345	store. The flags field will be left unchanged or created empty for a
5346	new property.
5347
5348	<result name="E_ACCESSDENIED">
5349	Property cannot be changed.
5350	</result>
5351	<result name="VBOX_E_INVALID_VM_STATE">
5352	Virtual machine is not mutable or session not open.
5353	</result>
5354	<result name="VBOX_E_INVALID_OBJECT_STATE">
5355	Cannot set transient property when machine not running.
5356	</result>
5357	</desc>
5358
5359	<param name="property" type="wstring" dir="in">
5360	<desc>
5361	The name of the property to set, change or delete.
5362	</desc>
5363	</param>
5364	<param name="value" type="wstring" dir="in">
5365	<desc>
5366	The new value of the property to set, change or delete. If the
5367	property does not yet exist and value is non-empty, it will be
5368	created. If the value is @c null or empty, the property will be
5369	deleted if it exists.
5370	</desc>
5371	</param>
5372	</method>
5373
5374	<method name="enumerateGuestProperties">
5375	<desc>
5376	Return a list of the guest properties matching a set of patterns along
5377	with their values, time stamps and flags.
5378	</desc>
5379	<param name="patterns" type="wstring" dir="in">
5380	<desc>
5381	The patterns to match the properties against, separated by '\|'
5382	characters. If this is empty or @c null, all properties will match.
5383	</desc>
5384	</param>
5385	<param name="name" type="wstring" dir="out" safearray="yes">
5386	<desc>
5387	The names of the properties returned.
5388	</desc>
5389	</param>
5390	<param name="value" type="wstring" dir="out" safearray="yes">
5391	<desc>
5392	The values of the properties returned. The array entries match the
5393	corresponding entries in the @a name array.
5394	</desc>
5395	</param>
5396	<param name="timestamp" type="long long" dir="out" safearray="yes">
5397	<desc>
5398	The time stamps of the properties returned. The array entries match
5399	the corresponding entries in the @a name array.
5400	</desc>
5401	</param>
5402	<param name="flags" type="wstring" dir="out" safearray="yes">
5403	<desc>
5404	The flags of the properties returned. The array entries match the
5405	corresponding entries in the @a name array.
5406	</desc>
5407	</param>
5408	</method>
5409
5410	<method name="querySavedGuestSize">
5411	<desc>
5412	Returns the guest dimensions from the saved state.
5413	</desc>
5414	<param name="screenId" type="unsigned long" dir="in">
5415	<desc>
5416	Saved guest screen to query info from.
5417	</desc>
5418	</param>
5419	<param name="width" type="unsigned long" dir="out">
5420	<desc>
5421	Guest width at the time of the saved state was taken.
5422	</desc>
5423	</param>
5424	<param name="height" type="unsigned long" dir="out">
5425	<desc>
5426	Guest height at the time of the saved state was taken.
5427	</desc>
5428	</param>
5429	</method>
5430
5431	<method name="querySavedThumbnailSize">
5432	<desc>
5433	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5434	</desc>
5435	<param name="screenId" type="unsigned long" dir="in">
5436	<desc>
5437	Saved guest screen to query info from.
5438	</desc>
5439	</param>
5440	<param name="size" type="unsigned long" dir="out">
5441	<desc>
5442	Size of buffer required to store the bitmap.
5443	</desc>
5444	</param>
5445	<param name="width" type="unsigned long" dir="out">
5446	<desc>
5447	Bitmap width.
5448	</desc>
5449	</param>
5450	<param name="height" type="unsigned long" dir="out">
5451	<desc>
5452	Bitmap height.
5453	</desc>
5454	</param>
5455	</method>
5456
5457	<method name="readSavedThumbnailToArray">
5458	<desc>
5459	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5460	</desc>
5461	<param name="screenId" type="unsigned long" dir="in">
5462	<desc>
5463	Saved guest screen to read from.
5464	</desc>
5465	</param>
5466	<param name="BGR" type="boolean" dir="in">
5467	<desc>
5468	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5469	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5470	</desc>
5471	</param>
5472	<param name="width" type="unsigned long" dir="out">
5473	<desc>
5474	Bitmap width.
5475	</desc>
5476	</param>
5477	<param name="height" type="unsigned long" dir="out">
5478	<desc>
5479	Bitmap height.
5480	</desc>
5481	</param>
5482	<param name="data" type="octet" safearray="yes" dir="return">
5483	<desc>
5484	Array with resulting bitmap data.
5485	</desc>
5486	</param>
5487	</method>
5488
5489	<method name="readSavedThumbnailPNGToArray">
5490	<desc>
5491	Thumbnail in PNG format is retrieved to an array of bytes.
5492	</desc>
5493	<param name="screenId" type="unsigned long" dir="in">
5494	<desc>
5495	Saved guest screen to read from.
5496	</desc>
5497	</param>
5498	<param name="width" type="unsigned long" dir="out">
5499	<desc>
5500	Image width.
5501	</desc>
5502	</param>
5503	<param name="height" type="unsigned long" dir="out">
5504	<desc>
5505	Image height.
5506	</desc>
5507	</param>
5508	<param name="data" type="octet" dir="return" safearray="yes">
5509	<desc>
5510	Array with resulting PNG data.
5511	</desc>
5512	</param>
5513	</method>
5514
5515	<method name="querySavedScreenshotPNGSize">
5516	<desc>
5517	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5518	</desc>
5519	<param name="screenId" type="unsigned long" dir="in">
5520	<desc>
5521	Saved guest screen to query info from.
5522	</desc>
5523	</param>
5524	<param name="size" type="unsigned long" dir="out">
5525	<desc>
5526	Size of buffer required to store the PNG binary data.
5527	</desc>
5528	</param>
5529	<param name="width" type="unsigned long" dir="out">
5530	<desc>
5531	Image width.
5532	</desc>
5533	</param>
5534	<param name="height" type="unsigned long" dir="out">
5535	<desc>
5536	Image height.
5537	</desc>
5538	</param>
5539	</method>
5540
5541	<method name="readSavedScreenshotPNGToArray">
5542	<desc>
5543	Screenshot in PNG format is retrieved to an array of bytes.
5544	</desc>
5545	<param name="screenId" type="unsigned long" dir="in">
5546	<desc>
5547	Saved guest screen to read from.
5548	</desc>
5549	</param>
5550	<param name="width" type="unsigned long" dir="out">
5551	<desc>
5552	Image width.
5553	</desc>
5554	</param>
5555	<param name="height" type="unsigned long" dir="out">
5556	<desc>
5557	Image height.
5558	</desc>
5559	</param>
5560	<param name="data" type="octet" dir="return" safearray="yes">
5561	<desc>
5562	Array with resulting PNG data.
5563	</desc>
5564	</param>
5565	</method>
5566
5567	<method name="hotPlugCPU">
5568	<desc>
5569	Plugs a CPU into the machine.
5570	</desc>
5571	<param name="cpu" type="unsigned long" dir="in">
5572	<desc>
5573	The CPU id to insert.
5574	</desc>
5575	</param>
5576	</method>
5577
5578	<method name="hotUnplugCPU">
5579	<desc>
5580	Removes a CPU from the machine.
5581	</desc>
5582	<param name="cpu" type="unsigned long" dir="in">
5583	<desc>
5584	The CPU id to remove.
5585	</desc>
5586	</param>
5587	</method>
5588
5589	<method name="getCPUStatus">
5590	<desc>
5591	Returns the current status of the given CPU.
5592	</desc>
5593	<param name="cpu" type="unsigned long" dir="in">
5594	<desc>
5595	The CPU id to check for.
5596	</desc>
5597	</param>
5598	<param name="attached" type="boolean" dir="return">
5599	<desc>
5600	Status of the CPU.
5601	</desc>
5602	</param>
5603	</method>
5604
5605	<method name="queryLogFilename">
5606	<desc>
5607	Queries for the VM log file name of an given index. Returns an empty
5608	string if a log file with that index doesn't exists.
5609	</desc>
5610	<param name="idx" type="unsigned long" dir="in">
5611	<desc>
5612	Which log file name to query. 0=current log file.
5613	</desc>
5614	</param>
5615	<param name="filename" type="wstring" dir="return">
5616	<desc>
5617	On return the full path to the log file or an empty string on error.
5618	</desc>
5619	</param>
5620	</method>
5621
5622	<method name="readLog">
5623	<desc>
5624	Reads the VM log file. The chunk size is limited, so even if you
5625	ask for a big piece there might be less data returned.
5626	</desc>
5627	<param name="idx" type="unsigned long" dir="in">
5628	<desc>
5629	Which log file to read. 0=current log file.
5630	</desc>
5631	</param>
5632	<param name="offset" type="long long" dir="in">
5633	<desc>
5634	Offset in the log file.
5635	</desc>
5636	</param>
5637	<param name="size" type="long long" dir="in">
5638	<desc>
5639	Chunk size to read in the log file.
5640	</desc>
5641	</param>
5642	<param name="data" type="octet" dir="return" safearray="yes">
5643	<desc>
5644	Data read from the log file. A data size of 0 means end of file
5645	if the requested chunk size was not 0. This is the unprocessed
5646	file data, i.e. the line ending style depends on the platform of
5647	the system the server is running on.
5648	</desc>
5649	</param>
5650	</method>
5651	</interface>
5652
5653	<!--
5654	// IConsole
5655	/////////////////////////////////////////////////////////////////////////
5656	-->
5657
5658	<interface
5659	name="IRemoteDisplayInfo" extends="$unknown"
5660	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
5661	wsmap="struct"
5662	>
5663	<desc>
5664	Contains information about the remote display (VRDP) capabilities and status.
5665	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5666	</desc>
5667
5668	<attribute name="active" type="boolean" readonly="yes">
5669	<desc>
5670	Whether the remote display connection is active.
5671	</desc>
5672	</attribute>
5673
5674	<attribute name="port" type="long" readonly="yes">
5675	<desc>
5676	VRDP server port number. If this property is equal to <tt>0</tt>, then
5677	the VRDP server failed to start, usually because there are no free TCP
5678	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
5679	server has not yet been started.
5680	</desc>
5681	</attribute>
5682
5683	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5684	<desc>
5685	How many times a client connected.
5686	</desc>
5687	</attribute>
5688
5689	<attribute name="beginTime" type="long long" readonly="yes">
5690	<desc>
5691	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5692	</desc>
5693	</attribute>
5694
5695	<attribute name="endTime" type="long long" readonly="yes">
5696	<desc>
5697	When the last connection was terminated or the current time, if
5698	connection is still active, in milliseconds since 1970-01-01 UTC.
5699	</desc>
5700	</attribute>
5701
5702	<attribute name="bytesSent" type="long long" readonly="yes">
5703	<desc>
5704	How many bytes were sent in last or current, if still active, connection.
5705	</desc>
5706	</attribute>
5707
5708	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5709	<desc>
5710	How many bytes were sent in all connections.
5711	</desc>
5712	</attribute>
5713
5714	<attribute name="bytesReceived" type="long long" readonly="yes">
5715	<desc>
5716	How many bytes were received in last or current, if still active, connection.
5717	</desc>
5718	</attribute>
5719
5720	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5721	<desc>
5722	How many bytes were received in all connections.
5723	</desc>
5724	</attribute>
5725
5726	<attribute name="user" type="wstring" readonly="yes">
5727	<desc>
5728	Login user name supplied by the client.
5729	</desc>
5730	</attribute>
5731
5732	<attribute name="domain" type="wstring" readonly="yes">
5733	<desc>
5734	Login domain name supplied by the client.
5735	</desc>
5736	</attribute>
5737
5738	<attribute name="clientName" type="wstring" readonly="yes">
5739	<desc>
5740	The client name supplied by the client.
5741	</desc>
5742	</attribute>
5743
5744	<attribute name="clientIP" type="wstring" readonly="yes">
5745	<desc>
5746	The IP address of the client.
5747	</desc>
5748	</attribute>
5749
5750	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5751	<desc>
5752	The client software version number.
5753	</desc>
5754	</attribute>
5755
5756	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5757	<desc>
5758	Public key exchange method used when connection was established.
5759	Values: 0 - RDP4 public key exchange scheme.
5760	1 - X509 certificates were sent to client.
5761	</desc>
5762	</attribute>
5763
5764	</interface>
5765
5766	<interface
5767	name="IConsole" extends="$unknown"
5768	uuid="03cb7897-ea17-4e6c-81ae-4bd90be2fde2"
5769	wsmap="managed"
5770	>
5771	<desc>
5772	The IConsole interface represents an interface to control virtual
5773	machine execution.
5774
5775	A console object gets created when a machine has been locked for a
5776	particular session (client process) using <link to="IMachine::lockMachine" />
5777	or <link to="IMachine::launchVMProcess"/>. The console object can
5778	then be found in the session's <link to="ISession::console" /> attribute.
5779
5780	Methods of the IConsole interface allow the caller to query the current
5781	virtual machine execution state, pause the machine or power it down, save
5782	the machine state or take a snapshot, attach and detach removable media
5783	and so on.
5784
5785	<see>ISession</see>
5786	</desc>
5787
5788	<attribute name="machine" type="IMachine" readonly="yes">
5789	<desc>
5790	Machine object this console is sessioned with.
5791	<note>
5792	This is a convenience property, it has the same value as
5793	<link to="ISession::machine"/> of the corresponding session
5794	object.
5795	</note>
5796	</desc>
5797	</attribute>
5798
5799	<attribute name="state" type="MachineState" readonly="yes">
5800	<desc>
5801	Current execution state of the machine.
5802	<note>
5803	This property always returns the same value as the corresponding
5804	property of the IMachine object this console is sessioned with.
5805	For the process that owns (executes) the VM, this is the
5806	preferable way of querying the VM state, because no IPC
5807	calls are made.
5808	</note>
5809	</desc>
5810	</attribute>
5811
5812	<attribute name="guest" type="IGuest" readonly="yes">
5813	<desc>Guest object.</desc>
5814	</attribute>
5815
5816	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5817	<desc>
5818	Virtual keyboard object.
5819	<note>
5820	If the machine is not running, any attempt to use
5821	the returned object will result in an error.
5822	</note>
5823	</desc>
5824	</attribute>
5825
5826	<attribute name="mouse" type="IMouse" readonly="yes">
5827	<desc>
5828	Virtual mouse object.
5829	<note>
5830	If the machine is not running, any attempt to use
5831	the returned object will result in an error.
5832	</note>
5833	</desc>
5834	</attribute>
5835
5836	<attribute name="display" type="IDisplay" readonly="yes">
5837	<desc>Virtual display object.
5838	<note>
5839	If the machine is not running, any attempt to use
5840	the returned object will result in an error.
5841	</note>
5842	</desc>
5843	</attribute>
5844
5845	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5846	<desc>Debugging interface.</desc>
5847	</attribute>
5848
5849	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5850	<desc>
5851	Collection of USB devices currently attached to the virtual
5852	USB controller.
5853	<note>
5854	The collection is empty if the machine is not running.
5855	</note>
5856	</desc>
5857	</attribute>
5858
5859	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5860	<desc>
5861	List of USB devices currently attached to the remote VRDP client.
5862	Once a new device is physically attached to the remote host computer,
5863	it appears in this list and remains there until detached.
5864	</desc>
5865	</attribute>
5866
5867	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5868	<desc>
5869	Collection of shared folders for the current session. These folders
5870	are called transient shared folders because they are available to the
5871	guest OS running inside the associated virtual machine only for the
5872	duration of the session (as opposed to
5873	<link to="IMachine::sharedFolders"/> which represent permanent shared
5874	folders). When the session is closed (e.g. the machine is powered down),
5875	these folders are automatically discarded.
5876
5877	New shared folders are added to the collection using
5878	<link to="#createSharedFolder"/>. Existing shared folders can be
5879	removed using <link to="#removeSharedFolder"/>.
5880	</desc>
5881	</attribute>
5882
5883	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
5884	<desc>
5885	Interface that provides information on Remote Display (VRDP) connection.
5886	</desc>
5887	</attribute>
5888
5889	<attribute name="eventSource" type="IEventSource" readonly="yes">
5890	<desc>
5891	Event source for console events.
5892	</desc>
5893	</attribute>
5894
5895	<method name="powerUp">
5896	<desc>
5897	Starts the virtual machine execution using the current machine
5898	state (that is, its current execution state, current settings and
5899	current storage devices).
5900
5901	<note>
5902	This method is only useful for front-ends that want to actually
5903	execute virtual machines in their own process (like the VirtualBox
5904	or VBoxSDL front-ends). Unless you are intending to write such a
5905	front-end, do not call this method. If you simply want to
5906	start virtual machine execution using one of the existing front-ends
5907	(for example the VirtualBox GUI or headless server), use
5908	<link to="IMachine::launchVMProcess"/> instead; these
5909	front-ends will power up the machine automatically for you.
5910	</note>
5911
5912	If the machine is powered off or aborted, the execution will
5913	start from the beginning (as if the real hardware were just
5914	powered on).
5915
5916	If the machine is in the <link to="MachineState_Saved"/> state,
5917	it will continue its execution the point where the state has
5918	been saved.
5919
5920	If the machine <link to="IMachine::teleporterEnabled"/> property is
5921	enabled on the machine being powered up, the machine will wait for an
5922	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
5923	state. The returned progress object will have at least three
5924	operations where the last three are defined as: (1) powering up and
5925	starting TCP server, (2) waiting for incoming teleportations, and
5926	(3) perform teleportation. These operations will be reflected as the
5927	last three operations of the progress objected returned by
5928	<link to="IMachine::launchVMProcess"/> as well.
5929
5930	<see>#saveState</see>
5931
5932	<result name="VBOX_E_INVALID_VM_STATE">
5933	Virtual machine already running.
5934	</result>
5935	<result name="VBOX_E_HOST_ERROR">
5936	Host interface does not exist or name not set.
5937	</result>
5938	<result name="VBOX_E_FILE_ERROR">
5939	Invalid saved state file.
5940	</result>
5941	</desc>
5942	<param name="progress" type="IProgress" dir="return">
5943	<desc>Progress object to track the operation completion.</desc>
5944	</param>
5945	</method>
5946
5947	<method name="powerUpPaused">
5948	<desc>
5949	Identical to powerUp except that the VM will enter the
5950	<link to="MachineState_Paused"/> state, instead of
5951	<link to="MachineState_Running"/>.
5952
5953	<see>#powerUp</see>
5954	<result name="VBOX_E_INVALID_VM_STATE">
5955	Virtual machine already running.
5956	</result>
5957	<result name="VBOX_E_HOST_ERROR">
5958	Host interface does not exist or name not set.
5959	</result>
5960	<result name="VBOX_E_FILE_ERROR">
5961	Invalid saved state file.
5962	</result>
5963	</desc>
5964	<param name="progress" type="IProgress" dir="return">
5965	<desc>Progress object to track the operation completion.</desc>
5966	</param>
5967	</method>
5968
5969	<method name="powerDown">
5970	<desc>
5971	Initiates the power down procedure to stop the virtual machine
5972	execution.
5973
5974	The completion of the power down procedure is tracked using the returned
5975	IProgress object. After the operation is complete, the machine will go
5976	to the PoweredOff state.
5977	<result name="VBOX_E_INVALID_VM_STATE">
5978	Virtual machine must be Running, Paused or Stuck to be powered down.
5979	</result>
5980	</desc>
5981	<param name="progress" type="IProgress" dir="return">
5982	<desc>Progress object to track the operation completion.</desc>
5983	</param>
5984	</method>
5985
5986	<method name="reset">
5987	<desc>Resets the virtual machine.
5988	<result name="VBOX_E_INVALID_VM_STATE">
5989	Virtual machine not in Running state.
5990	</result>
5991	<result name="VBOX_E_VM_ERROR">
5992	Virtual machine error in reset operation.
5993	</result>
5994	</desc>
5995	</method>
5996
5997	<method name="pause">
5998	<desc>Pauses the virtual machine execution.
5999	<result name="VBOX_E_INVALID_VM_STATE">
6000	Virtual machine not in Running state.
6001	</result>
6002	<result name="VBOX_E_VM_ERROR">
6003	Virtual machine error in suspend operation.
6004	</result>
6005	</desc>
6006	</method>
6007
6008	<method name="resume">
6009	<desc>Resumes the virtual machine execution.
6010	<result name="VBOX_E_INVALID_VM_STATE">
6011	Virtual machine not in Paused state.
6012	</result>
6013	<result name="VBOX_E_VM_ERROR">
6014	Virtual machine error in resume operation.
6015	</result>
6016	</desc>
6017	</method>
6018
6019	<method name="powerButton">
6020	<desc>Sends the ACPI power button event to the guest.
6021	<result name="VBOX_E_INVALID_VM_STATE">
6022	Virtual machine not in Running state.
6023	</result>
6024	<result name="VBOX_E_PDM_ERROR">
6025	Controlled power off failed.
6026	</result>
6027	</desc>
6028	</method>
6029
6030	<method name="sleepButton">
6031	<desc>Sends the ACPI sleep button event to the guest.
6032	<result name="VBOX_E_INVALID_VM_STATE">
6033	Virtual machine not in Running state.
6034	</result>
6035	<result name="VBOX_E_PDM_ERROR">
6036	Sending sleep button event failed.
6037	</result>
6038	</desc>
6039	</method>
6040
6041	<method name="getPowerButtonHandled">
6042	<desc>Checks if the last power button event was handled by guest.
6043	<result name="VBOX_E_PDM_ERROR">
6044	Checking if the event was handled by the guest OS failed.
6045	</result>
6046	</desc>
6047	<param name="handled" type="boolean" dir="return"/>
6048	</method>
6049
6050	<method name="getGuestEnteredACPIMode">
6051	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6052	G1 (sleeping). If this method returns @c false, the guest will
6053	most likely not respond to external ACPI events.
6054	<result name="VBOX_E_INVALID_VM_STATE">
6055	Virtual machine not in Running state.
6056	</result>
6057	</desc>
6058	<param name="entered" type="boolean" dir="return"/>
6059	</method>
6060
6061	<method name="saveState">
6062	<desc>
6063	Saves the current execution state of a running virtual machine
6064	and stops its execution.
6065
6066	After this operation completes, the machine will go to the
6067	Saved state. Next time it is powered up, this state will
6068	be restored and the machine will continue its execution from
6069	the place where it was saved.
6070
6071	This operation differs from taking a snapshot to the effect
6072	that it doesn't create new differencing media. Also, once
6073	the machine is powered up from the state saved using this method,
6074	the saved state is deleted, so it will be impossible to return
6075	to this state later.
6076
6077	<note>
6078	On success, this method implicitly calls
6079	<link to="IMachine::saveSettings"/> to save all current machine
6080	settings (including runtime changes to the DVD medium, etc.).
6081	Together with the impossibility to change any VM settings when it is
6082	in the Saved state, this guarantees adequate hardware
6083	configuration of the machine when it is restored from the saved
6084	state file.
6085	</note>
6086
6087	<note>
6088	The machine must be in the Running or Paused state, otherwise
6089	the operation will fail.
6090	</note>
6091	<result name="VBOX_E_INVALID_VM_STATE">
6092	Virtual machine state neither Running nor Paused.
6093	</result>
6094	<result name="VBOX_E_FILE_ERROR">
6095	Failed to create directory for saved state file.
6096	</result>
6097
6098	<see><link to="#takeSnapshot"/></see>
6099	</desc>
6100	<param name="progress" type="IProgress" dir="return">
6101	<desc>Progress object to track the operation completion.</desc>
6102	</param>
6103	</method>
6104
6105	<method name="adoptSavedState">
6106	<desc>
6107	Associates the given saved state file to the virtual machine.
6108
6109	On success, the machine will go to the Saved state. Next time it is
6110	powered up, it will be restored from the adopted saved state and
6111	continue execution from the place where the saved state file was
6112	created.
6113
6114	The specified saved state file path may be absolute or relative to the
6115	folder the VM normally saves the state to (usually,
6116	<link to="IMachine::snapshotFolder"/>).
6117
6118	<note>
6119	It's a caller's responsibility to make sure the given saved state
6120	file is compatible with the settings of this virtual machine that
6121	represent its virtual hardware (memory size, storage disk configuration
6122	etc.). If there is a mismatch, the behavior of the virtual machine
6123	is undefined.
6124	</note>
6125	<result name="VBOX_E_INVALID_VM_STATE">
6126	Virtual machine state neither PoweredOff nor Aborted.
6127	</result>
6128	</desc>
6129	<param name="savedStateFile" type="wstring" dir="in">
6130	<desc>Path to the saved state file to adopt.</desc>
6131	</param>
6132	</method>
6133
6134	<method name="discardSavedState">
6135	<desc>
6136	Forcibly resets the machine to "Powered Off" state if it is
6137	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6138	Next time the machine is powered up, a clean boot will occur.
6139	<note>
6140	This operation is equivalent to resetting or powering off
6141	the machine without doing a proper shutdown of the guest
6142	operating system; as with resetting a running phyiscal
6143	computer, it can can lead to data loss.
6144	</note>
6145	If @a fRemoveFile is @c true, the file in the machine directory
6146	into which the machine state was saved is also deleted. If
6147	this is @c false, then the state can be recovered and later
6148	re-inserted into a machine using <link to="#adoptSavedState" />.
6149	The location of the file can be found in the
6150	<link to="IMachine::stateFilePath" /> attribute.
6151	<result name="VBOX_E_INVALID_VM_STATE">
6152	Virtual machine not in state Saved.
6153	</result>
6154	</desc>
6155	<param name="fRemoveFile" type="boolean" dir="in" >
6156	<desc>Whether to also remove the saved state file.</desc>
6157	</param>
6158	</method>
6159
6160	<method name="getDeviceActivity">
6161	<desc>
6162	Gets the current activity type of a given device or device group.
6163	<result name="E_INVALIDARG">
6164	Invalid device type.
6165	</result>
6166	</desc>
6167	<param name="type" type="DeviceType" dir="in"/>
6168	<param name="activity" type="DeviceActivity" dir="return"/>
6169	</method>
6170
6171	<method name="attachUSBDevice">
6172	<desc>
6173	Attaches a host USB device with the given UUID to the
6174	USB controller of the virtual machine.
6175
6176	The device needs to be in one of the following states:
6177	<link to="USBDeviceState_Busy"/>,
6178	<link to="USBDeviceState_Available"/> or
6179	<link to="USBDeviceState_Held"/>,
6180	otherwise an error is immediately returned.
6181
6182	When the device state is
6183	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6184	be returned if the host computer refuses to release it for some reason.
6185
6186	<see>IUSBController::deviceFilters, USBDeviceState</see>
6187	<result name="VBOX_E_INVALID_VM_STATE">
6188	Virtual machine state neither Running nor Paused.
6189	</result>
6190	<result name="VBOX_E_PDM_ERROR">
6191	Virtual machine does not have a USB controller.
6192	</result>
6193	</desc>
6194	<param name="id" type="uuid" mod="string" dir="in">
6195	<desc>UUID of the host USB device to attach.</desc>
6196	</param>
6197	</method>
6198
6199	<method name="detachUSBDevice">
6200	<desc>
6201	Detaches an USB device with the given UUID from the USB controller
6202	of the virtual machine.
6203
6204	After this method succeeds, the VirtualBox server re-initiates
6205	all USB filters as if the device were just physically attached
6206	to the host, but filters of this machine are ignored to avoid
6207	a possible automatic re-attachment.
6208
6209	<see>IUSBController::deviceFilters, USBDeviceState</see>
6210
6211	<result name="VBOX_E_PDM_ERROR">
6212	Virtual machine does not have a USB controller.
6213	</result>
6214	<result name="E_INVALIDARG">
6215	USB device not attached to this virtual machine.
6216	</result>
6217	</desc>
6218	<param name="id" type="uuid" mod="string" dir="in">
6219	<desc>UUID of the USB device to detach.</desc>
6220	</param>
6221	<param name="device" type="IUSBDevice" dir="return">
6222	<desc>Detached USB device.</desc>
6223	</param>
6224	</method>
6225
6226	<method name="findUSBDeviceByAddress">
6227	<desc>
6228	Searches for a USB device with the given host address.
6229
6230	<result name="VBOX_E_OBJECT_NOT_FOUND">
6231	Given @c name does not correspond to any USB device.
6232	</result>
6233
6234	<see>IUSBDevice::address</see>
6235	</desc>
6236	<param name="name" type="wstring" dir="in">
6237	<desc>
6238	Address of the USB device (as assigned by the host) to
6239	search for.
6240	</desc>
6241	</param>
6242	<param name="device" type="IUSBDevice" dir="return">
6243	<desc>Found USB device object.</desc>
6244	</param>
6245	</method>
6246
6247	<method name="findUSBDeviceById">
6248	<desc>
6249	Searches for a USB device with the given UUID.
6250
6251	<result name="VBOX_E_OBJECT_NOT_FOUND">
6252	Given @c id does not correspond to any USB device.
6253	</result>
6254
6255	<see>IUSBDevice::id</see>
6256	</desc>
6257	<param name="id" type="uuid" mod="string" dir="in">
6258	<desc>UUID of the USB device to search for.</desc>
6259	</param>
6260	<param name="device" type="IUSBDevice" dir="return">
6261	<desc>Found USB device object.</desc>
6262	</param>
6263	</method>
6264
6265	<method name="createSharedFolder">
6266	<desc>
6267	Creates a transient new shared folder by associating the given logical
6268	name with the given host path, adds it to the collection of shared
6269	folders and starts sharing it. Refer to the description of
6270	<link to="ISharedFolder"/> to read more about logical names.
6271
6272	<result name="VBOX_E_INVALID_VM_STATE">
6273	Virtual machine in Saved state or currently changing state.
6274	</result>
6275	<result name="VBOX_E_FILE_ERROR">
6276	Shared folder already exists or not accessible.
6277	</result>
6278	</desc>
6279	<param name="name" type="wstring" dir="in">
6280	<desc>Unique logical name of the shared folder.</desc>
6281	</param>
6282	<param name="hostPath" type="wstring" dir="in">
6283	<desc>Full path to the shared folder in the host file system.</desc>
6284	</param>
6285	<param name="writable" type="boolean" dir="in">
6286	<desc>Whether the share is writable or readonly</desc>
6287	</param>
6288	<param name="automount" type="boolean" dir="in">
6289	<desc>Whether the share gets automatically mounted by the guest
6290	or not.</desc>
6291	</param>
6292	</method>
6293
6294	<method name="removeSharedFolder">
6295	<desc>
6296	Removes a transient shared folder with the given name previously
6297	created by <link to="#createSharedFolder"/> from the collection of
6298	shared folders and stops sharing it.
6299	<result name="VBOX_E_INVALID_VM_STATE">
6300	Virtual machine in Saved state or currently changing state.
6301	</result>
6302	<result name="VBOX_E_FILE_ERROR">
6303	Shared folder does not exists.
6304	</result>
6305	</desc>
6306	<param name="name" type="wstring" dir="in">
6307	<desc>Logical name of the shared folder to remove.</desc>
6308	</param>
6309	</method>
6310
6311	<method name="takeSnapshot">
6312	<desc>
6313	Saves the current execution state
6314	and all settings of the machine and creates differencing images
6315	for all normal (non-independent) media.
6316	See <link to="ISnapshot" /> for an introduction to snapshots.
6317
6318	This method can be called for a PoweredOff, Saved (see
6319	<link to="#saveState"/>), Running or
6320	Paused virtual machine. When the machine is PoweredOff, an
6321	offline snapshot is created. When the machine is Running a live
6322	snapshot is created, and an online snapshot is is created when Paused.
6323
6324	The taken snapshot is always based on the
6325	<link to="IMachine::currentSnapshot">current snapshot</link>
6326	of the associated virtual machine and becomes a new current snapshot.
6327
6328	<note>
6329	This method implicitly calls <link to="IMachine::saveSettings"/> to
6330	save all current machine settings before taking an offline snapshot.
6331	</note>
6332
6333	<result name="VBOX_E_INVALID_VM_STATE">
6334	Virtual machine currently changing state.
6335	</result>
6336	</desc>
6337	<param name="name" type="wstring" dir="in">
6338	<desc>Short name for the snapshot.</desc>
6339	</param>
6340	<param name="description" type="wstring" dir="in">
6341	<desc>Optional description of the snapshot.</desc>
6342	</param>
6343	<param name="progress" type="IProgress" dir="return">
6344	<desc>Progress object to track the operation completion.</desc>
6345	</param>
6346	</method>
6347
6348	<method name="deleteSnapshot">
6349	<desc>
6350	Starts deleting the specified snapshot asynchronously.
6351	See <link to="ISnapshot" /> for an introduction to snapshots.
6352
6353	The execution state and settings of the associated machine stored in
6354	the snapshot will be deleted. The contents of all differencing media of
6355	this snapshot will be merged with the contents of their dependent child
6356	media to keep the medium chain valid (in other words, all changes
6357	represented by media being deleted will be propagated to their child
6358	medium). After that, this snapshot's differencing medium will be
6359	deleted. The parent of this snapshot will become a new parent for all
6360	its child snapshots.
6361
6362	If the deleted snapshot is the current one, its parent snapshot will
6363	become a new current snapshot. The current machine state is not directly
6364	affected in this case, except that currently attached differencing
6365	media based on media of the deleted snapshot will be also merged as
6366	described above.
6367
6368	If the deleted snapshot is the first or current snapshot, then the
6369	respective IMachine attributes will be adjusted. Deleting the current
6370	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6371	to make all current machine settings permanent.
6372
6373	Deleting a snapshot has the following preconditions:
6374
6375	<ul>
6376	<li>Child media of all normal media of the deleted snapshot
6377	must be accessible (see <link to="IMedium::state"/>) for this
6378	operation to succeed. In particular, this means that all virtual
6379	machines, whose media are directly or indirectly based on the
6380	media of deleted snapshot, must be powered off.</li>
6381
6382	<li>You cannot delete the snapshot if a medium attached to it has
6383	more than once child medium (differencing images) because otherwise
6384	merging would be impossible. This might be the case if there is
6385	more than one child snapshot or differencing images were created
6386	for other reason (e.g. implicitly because of multiple machine
6387	attachments).</li>
6388	</ul>
6389
6390
6391	The virtual machine's <link to="IMachine::state">state</link> is
6392	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6393	"DeletingSnapshotPaused" while this operation is in progress.
6394
6395	<note>
6396	Merging medium contents can be very time and disk space
6397	consuming, if these media are big in size and have many
6398	children. However, if the snapshot being deleted is the last
6399	(head) snapshot on the branch, the operation will be rather
6400	quick.
6401	</note>
6402	<result name="VBOX_E_INVALID_VM_STATE">
6403	The running virtual machine prevents deleting this snapshot. This
6404	happens only in very specific situations, usually snapshots can be
6405	deleted without trouble while a VM is running. The error message
6406	text explains the reason for the failure.
6407	</result>
6408	</desc>
6409	<param name="id" type="uuid" mod="string" dir="in">
6410	<desc>UUID of the snapshot to delete.</desc>
6411	</param>
6412	<param name="progress" type="IProgress" dir="return">
6413	<desc>Progress object to track the operation completion.</desc>
6414	</param>
6415	</method>
6416
6417	<method name="restoreSnapshot">
6418	<desc>
6419	Starts resetting the machine's current state to the state contained
6420	in the given snapshot, asynchronously. All current settings of the
6421	machine will be reset and changes stored in differencing media
6422	will be lost.
6423	See <link to="ISnapshot" /> for an introduction to snapshots.
6424
6425	After this operation is successfully completed, new empty differencing
6426	media are created for all normal media of the machine.
6427
6428	If the given snapshot is an online snapshot, the machine will go to
6429	the <link to="MachineState_Saved"> saved state</link>, so that the
6430	next time it is powered on, the execution state will be restored
6431	from the state of the snapshot.
6432
6433	<note>
6434	The machine must not be running, otherwise the operation will fail.
6435	</note>
6436
6437	<note>
6438	If the machine state is <link to="MachineState_Saved">Saved</link>
6439	prior to this operation, the saved state file will be implicitly
6440	deleted (as if <link to="IConsole::discardSavedState"/> were
6441	called).
6442	</note>
6443
6444	<result name="VBOX_E_INVALID_VM_STATE">
6445	Virtual machine is running.
6446	</result>
6447	</desc>
6448	<param name="snapshot" type="ISnapshot" dir="in">
6449	<desc>The snapshot to restore the VM state from.</desc>
6450	</param>
6451	<param name="progress" type="IProgress" dir="return">
6452	<desc>Progress object to track the operation completion.</desc>
6453	</param>
6454	</method>
6455
6456	<method name="teleport">
6457	<desc>
6458	Teleport the VM to a different host machine or process.
6459
6460	TODO explain the details.
6461
6462	<result name="VBOX_E_INVALID_VM_STATE">
6463	Virtual machine not running or paused.
6464	</result>
6465	</desc>
6466	<param name="hostname" type="wstring" dir="in">
6467	<desc>The name or IP of the host to teleport to.</desc>
6468	</param>
6469	<param name="tcpport" type="unsigned long" dir="in">
6470	<desc>The TCP port to connect to (1..65535).</desc>
6471	</param>
6472	<param name="password" type="wstring" dir="in">
6473	<desc>The password.</desc>
6474	</param>
6475	<param name="maxDowntime" type="unsigned long" dir="in">
6476	<desc>
6477	The maximum allowed downtime given as milliseconds. 0 is not a valid
6478	value. Recommended value: 250 ms.
6479
6480	The higher the value is, the greater the chance for a successful
6481	teleportation. A small value may easily result in the teleportation
6482	process taking hours and eventually fail.
6483
6484	<note>
6485	The current implementation treats this a guideline, not as an
6486	absolute rule.
6487	</note>
6488	</desc>
6489	</param>
6490	<param name="progress" type="IProgress" dir="return">
6491	<desc>Progress object to track the operation completion.</desc>
6492	</param>
6493	</method>
6494
6495	</interface>
6496
6497	<!--
6498	// IHost
6499	/////////////////////////////////////////////////////////////////////////
6500	-->
6501
6502	<enum
6503	name="HostNetworkInterfaceMediumType"
6504	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6505	>
6506	<desc>
6507	Type of encapsulation. Ethernet encapsulation includes both wired and
6508	wireless Ethernet connections.
6509	<see>IHostNetworkInterface</see>
6510	</desc>
6511
6512	<const name="Unknown" value="0">
6513	<desc>
6514	The type of interface cannot be determined.
6515	</desc>
6516	</const>
6517	<const name="Ethernet" value="1">
6518	<desc>
6519	Ethernet frame encapsulation.
6520	</desc>
6521	</const>
6522	<const name="PPP" value="2">
6523	<desc>
6524	Point-to-point protocol encapsulation.
6525	</desc>
6526	</const>
6527	<const name="SLIP" value="3">
6528	<desc>
6529	Serial line IP encapsulation.
6530	</desc>
6531	</const>
6532	</enum>
6533
6534	<enum
6535	name="HostNetworkInterfaceStatus"
6536	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6537	>
6538	<desc>
6539	Current status of the interface.
6540	<see>IHostNetworkInterface</see>
6541	</desc>
6542
6543	<const name="Unknown" value="0">
6544	<desc>
6545	The state of interface cannot be determined.
6546	</desc>
6547	</const>
6548	<const name="Up" value="1">
6549	<desc>
6550	The interface is fully operational.
6551	</desc>
6552	</const>
6553	<const name="Down" value="2">
6554	<desc>
6555	The interface is not functioning.
6556	</desc>
6557	</const>
6558	</enum>
6559
6560	<enum
6561	name="HostNetworkInterfaceType"
6562	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6563	>
6564	<desc>
6565	Network interface type.
6566	</desc>
6567	<const name="Bridged" value="1"/>
6568	<const name="HostOnly" value="2"/>
6569	</enum>
6570
6571	<interface
6572	name="IHostNetworkInterface" extends="$unknown"
6573	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6574	wsmap="managed"
6575	>
6576	<desc>
6577	Represents one of host's network interfaces. IP V6 address and network
6578	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6579	separated by colons.
6580	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6581	</desc>
6582	<attribute name="name" type="wstring" readonly="yes">
6583	<desc>Returns the host network interface name.</desc>
6584	</attribute>
6585
6586	<attribute name="id" type="uuid" mod="string" readonly="yes">
6587	<desc>Returns the interface UUID.</desc>
6588	</attribute>
6589
6590	<attribute name="networkName" type="wstring" readonly="yes">
6591	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6592	</attribute>
6593
6594	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6595	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6596	</attribute>
6597
6598	<attribute name="IPAddress" type="wstring" readonly="yes">
6599	<desc>Returns the IP V4 address of the interface.</desc>
6600	</attribute>
6601
6602	<attribute name="networkMask" type="wstring" readonly="yes">
6603	<desc>Returns the network mask of the interface.</desc>
6604	</attribute>
6605
6606	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6607	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6608	</attribute>
6609
6610	<attribute name="IPV6Address" type="wstring" readonly="yes">
6611	<desc>Returns the IP V6 address of the interface.</desc>
6612	</attribute>
6613
6614	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6615	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6616	</attribute>
6617
6618	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6619	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6620	</attribute>
6621
6622	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6623	<desc>Type of protocol encapsulation used.</desc>
6624	</attribute>
6625
6626	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6627	<desc>Status of the interface.</desc>
6628	</attribute>
6629
6630	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6631	<desc>specifies the host interface type.</desc>
6632	</attribute>
6633
6634	<method name="enableStaticIpConfig">
6635	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6636	<param name="IPAddress" type="wstring" dir="in">
6637	<desc>
6638	IP address.
6639	</desc>
6640	</param>
6641	<param name="networkMask" type="wstring" dir="in">
6642	<desc>
6643	network mask.
6644	</desc>
6645	</param>
6646	</method>
6647
6648	<method name="enableStaticIpConfigV6">
6649	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6650	<param name="IPV6Address" type="wstring" dir="in">
6651	<desc>
6652	IP address.
6653	</desc>
6654	</param>
6655	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6656	<desc>
6657	network mask.
6658	</desc>
6659	</param>
6660	</method>
6661
6662	<method name="enableDynamicIpConfig">
6663	<desc>enables the dynamic IP configuration.</desc>
6664	</method>
6665
6666	<method name="dhcpRediscover">
6667	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6668	</method>
6669
6670	</interface>
6671
6672	<interface
6673	name="IHost" extends="$unknown"
6674	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6675	wsmap="managed"
6676	>
6677	<desc>
6678	The IHost interface represents the physical machine that this VirtualBox
6679	installation runs on.
6680
6681	An object implementing this interface is returned by the
6682	<link to="IVirtualBox::host" /> attribute. This interface contains
6683	read-only information about the host's physical hardware (such as what
6684	processors and disks are available, what the host operating system is,
6685	and so on) and also allows for manipulating some of the host's hardware,
6686	such as global USB device filters and host interface networking.
6687
6688	</desc>
6689	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6690	<desc>List of DVD drives available on the host.</desc>
6691	</attribute>
6692
6693	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6694	<desc>List of floppy drives available on the host.</desc>
6695	</attribute>
6696
6697	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6698	<desc>
6699	List of USB devices currently attached to the host.
6700	Once a new device is physically attached to the host computer,
6701	it appears in this list and remains there until detached.
6702
6703	<note>
6704	If USB functionality is not available in the given edition of
6705	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6706	</note>
6707	</desc>
6708	</attribute>
6709
6710	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6711	<desc>
6712	List of USB device filters in action.
6713	When a new device is physically attached to the host computer,
6714	filters from this list are applied to it (in order they are stored
6715	in the list). The first matched filter will determine the
6716	<link to="IHostUSBDeviceFilter::action">action</link>
6717	performed on the device.
6718
6719	Unless the device is ignored by these filters, filters of all
6720	currently running virtual machines
6721	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6722
6723	<note>
6724	If USB functionality is not available in the given edition of
6725	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6726	</note>
6727
6728	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6729	</desc>
6730	</attribute>
6731
6732	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6733	<desc>List of host network interfaces currently defined on the host.</desc>
6734	</attribute>
6735
6736	<attribute name="processorCount" type="unsigned long" readonly="yes">
6737	<desc>Number of (logical) CPUs installed in the host system.</desc>
6738	</attribute>
6739
6740	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6741	<desc>Number of (logical) CPUs online in the host system.</desc>
6742	</attribute>
6743
6744	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6745	<desc>Number of physical processor cores installed in the host system.</desc>
6746	</attribute>
6747
6748	<method name="getProcessorSpeed">
6749	<desc>Query the (approximate) maximum speed of a specified host CPU in
6750	Megahertz.
6751	</desc>
6752	<param name="cpuId" type="unsigned long" dir="in">
6753	<desc>
6754	Identifier of the CPU.
6755	</desc>
6756	</param>
6757	<param name="speed" type="unsigned long" dir="return">
6758	<desc>
6759	Speed value. 0 is returned if value is not known or @a cpuId is
6760	invalid.
6761	</desc>
6762	</param>
6763	</method>
6764
6765	<method name="getProcessorFeature">
6766	<desc>Query whether a CPU feature is supported or not.</desc>
6767	<param name="feature" type="ProcessorFeature" dir="in">
6768	<desc>
6769	CPU Feature identifier.
6770	</desc>
6771	</param>
6772	<param name="supported" type="boolean" dir="return">
6773	<desc>
6774	Feature is supported or not.
6775	</desc>
6776	</param>
6777	</method>
6778
6779	<method name="getProcessorDescription">
6780	<desc>Query the model string of a specified host CPU.
6781	</desc>
6782	<param name="cpuId" type="unsigned long" dir="in">
6783	<desc>
6784	Identifier of the CPU.
6785	<note>
6786	The current implementation might not necessarily return the
6787	description for this exact CPU.
6788	</note>
6789	</desc>
6790	</param>
6791	<param name="description" type="wstring" dir="return">
6792	<desc>
6793	Model string. An empty string is returned if value is not known or
6794	@a cpuId is invalid.
6795	</desc>
6796	</param>
6797	</method>
6798
6799	<method name="getProcessorCPUIDLeaf">
6800	<desc>
6801	Returns the CPU cpuid information for the specified leaf.
6802	</desc>
6803	<param name="cpuId" type="unsigned long" dir="in">
6804	<desc>
6805	Identifier of the CPU. The CPU most be online.
6806	<note>
6807	The current implementation might not necessarily return the
6808	description for this exact CPU.
6809	</note>
6810	</desc>
6811	</param>
6812	<param name="leaf" type="unsigned long" dir="in">
6813	<desc>
6814	CPUID leaf index (eax).
6815	</desc>
6816	</param>
6817	<param name="subLeaf" type="unsigned long" dir="in">
6818	<desc>
6819	CPUID leaf sub index (ecx). This currently only applies to cache
6820	information on Intel CPUs. Use 0 if retriving values for
6821	<link to="IMachine::setCPUIDLeaf"/>.
6822	</desc>
6823	</param>
6824	<param name="valEax" type="unsigned long" dir="out">
6825	<desc>
6826	CPUID leaf value for register eax.
6827	</desc>
6828	</param>
6829	<param name="valEbx" type="unsigned long" dir="out">
6830	<desc>
6831	CPUID leaf value for register ebx.
6832	</desc>
6833	</param>
6834	<param name="valEcx" type="unsigned long" dir="out">
6835	<desc>
6836	CPUID leaf value for register ecx.
6837	</desc>
6838	</param>
6839	<param name="valEdx" type="unsigned long" dir="out">
6840	<desc>
6841	CPUID leaf value for register edx.
6842	</desc>
6843	</param>
6844	</method>
6845
6846	<attribute name="memorySize" type="unsigned long" readonly="yes">
6847	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6848	</attribute>
6849
6850	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6851	<desc>Available system memory in the host system.</desc>
6852	</attribute>
6853
6854	<attribute name="operatingSystem" type="wstring" readonly="yes">
6855	<desc>Name of the host system's operating system.</desc>
6856	</attribute>
6857
6858	<attribute name="OSVersion" type="wstring" readonly="yes">
6859	<desc>Host operating system's version string.</desc>
6860	</attribute>
6861
6862	<attribute name="UTCTime" type="long long" readonly="yes">
6863	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6864	</attribute>
6865
6866	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6867	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6868	</attribute>
6869
6870	<method name="createHostOnlyNetworkInterface">
6871	<desc>
6872	Creates a new adapter for Host Only Networking.
6873	<result name="E_INVALIDARG">
6874	Host network interface @a name already exists.
6875	</result>
6876	</desc>
6877	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6878	<desc>
6879	Created host interface object.
6880	</desc>
6881	</param>
6882	<param name="progress" type="IProgress" dir="return">
6883	<desc>
6884	Progress object to track the operation completion.
6885	</desc>
6886	</param>
6887	</method>
6888
6889	<method name="removeHostOnlyNetworkInterface">
6890	<desc>
6891	Removes the given Host Only Networking interface.
6892	<result name="VBOX_E_OBJECT_NOT_FOUND">
6893	No host network interface matching @a id found.
6894	</result>
6895	</desc>
6896	<param name="id" type="uuid" mod="string" dir="in">
6897	<desc>
6898	Adapter GUID.
6899	</desc>
6900	</param>
6901	<param name="progress" type="IProgress" dir="return">
6902	<desc>
6903	Progress object to track the operation completion.
6904	</desc>
6905	</param>
6906	</method>
6907
6908	<method name="createUSBDeviceFilter">
6909	<desc>
6910	Creates a new USB device filter. All attributes except
6911	the filter name are set to empty (any match),
6912	<i>active</i> is @c false (the filter is not active).
6913
6914	The created filter can be added to the list of filters using
6915	<link to="#insertUSBDeviceFilter"/>.
6916
6917	<see>#USBDeviceFilters</see>
6918	</desc>
6919	<param name="name" type="wstring" dir="in">
6920	<desc>
6921	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6922	</desc>
6923	</param>
6924	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6925	<desc>Created filter object.</desc>
6926	</param>
6927	</method>
6928
6929	<method name="insertUSBDeviceFilter">
6930	<desc>
6931	Inserts the given USB device to the specified position
6932	in the list of filters.
6933
6934	Positions are numbered starting from @c 0. If the specified
6935	position is equal to or greater than the number of elements in
6936	the list, the filter is added at the end of the collection.
6937
6938	<note>
6939	Duplicates are not allowed, so an attempt to insert a
6940	filter already in the list is an error.
6941	</note>
6942	<note>
6943	If USB functionality is not available in the given edition of
6944	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6945	</note>
6946
6947	<see>#USBDeviceFilters</see>
6948
6949	<result name="VBOX_E_INVALID_OBJECT_STATE">
6950	USB device filter is not created within this VirtualBox instance.
6951	</result>
6952	<result name="E_INVALIDARG">
6953	USB device filter already in list.
6954	</result>
6955
6956	</desc>
6957	<param name="position" type="unsigned long" dir="in">
6958	<desc>Position to insert the filter to.</desc>
6959	</param>
6960	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
6961	<desc>USB device filter to insert.</desc>
6962	</param>
6963	</method>
6964
6965	<method name="removeUSBDeviceFilter">
6966	<desc>
6967	Removes a USB device filter from the specified position in the
6968	list of filters.
6969
6970	Positions are numbered starting from @c 0. Specifying a
6971	position equal to or greater than the number of elements in
6972	the list will produce an error.
6973
6974	<note>
6975	If USB functionality is not available in the given edition of
6976	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6977	</note>
6978
6979	<see>#USBDeviceFilters</see>
6980
6981	<result name="E_INVALIDARG">
6982	USB device filter list empty or invalid @a position.
6983	</result>
6984
6985	</desc>
6986	<param name="position" type="unsigned long" dir="in">
6987	<desc>Position to remove the filter from.</desc>
6988	</param>
6989	</method>
6990
6991	<method name="findHostDVDDrive">
6992	<desc>
6993	Searches for a host DVD drive with the given @c name.
6994
6995	<result name="VBOX_E_OBJECT_NOT_FOUND">
6996	Given @c name does not correspond to any host drive.
6997	</result>
6998
6999	</desc>
7000	<param name="name" type="wstring" dir="in">
7001	<desc>Name of the host drive to search for</desc>
7002	</param>
7003	<param name="drive" type="IMedium" dir="return">
7004	<desc>Found host drive object</desc>
7005	</param>
7006	</method>
7007
7008	<method name="findHostFloppyDrive">
7009	<desc>
7010	Searches for a host floppy drive with the given @c name.
7011
7012	<result name="VBOX_E_OBJECT_NOT_FOUND">
7013	Given @c name does not correspond to any host floppy drive.
7014	</result>
7015
7016	</desc>
7017	<param name="name" type="wstring" dir="in">
7018	<desc>Name of the host floppy drive to search for</desc>
7019	</param>
7020	<param name="drive" type="IMedium" dir="return">
7021	<desc>Found host floppy drive object</desc>
7022	</param>
7023	</method>
7024
7025	<method name="findHostNetworkInterfaceByName">
7026	<desc>
7027	Searches through all host network interfaces for an interface with
7028	the given @c name.
7029	<note>
7030	The method returns an error if the given @c name does not
7031	correspond to any host network interface.
7032	</note>
7033	</desc>
7034	<param name="name" type="wstring" dir="in">
7035	<desc>Name of the host network interface to search for.</desc>
7036	</param>
7037	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7038	<desc>Found host network interface object.</desc>
7039	</param>
7040	</method>
7041	<method name="findHostNetworkInterfaceById">
7042	<desc>
7043	Searches through all host network interfaces for an interface with
7044	the given GUID.
7045	<note>
7046	The method returns an error if the given GUID does not
7047	correspond to any host network interface.
7048	</note>
7049	</desc>
7050	<param name="id" type="uuid" mod="string" dir="in">
7051	<desc>GUID of the host network interface to search for.</desc>
7052	</param>
7053	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7054	<desc>Found host network interface object.</desc>
7055	</param>
7056	</method>
7057	<method name="findHostNetworkInterfacesOfType">
7058	<desc>
7059	Searches through all host network interfaces and returns a list of interfaces of the specified type
7060	</desc>
7061	<param name="type" type="HostNetworkInterfaceType" dir="in">
7062	<desc>type of the host network interfaces to search for.</desc>
7063	</param>
7064	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7065	<desc>Found host network interface objects.</desc>
7066	</param>
7067	</method>
7068
7069	<method name="findUSBDeviceById">
7070	<desc>
7071	Searches for a USB device with the given UUID.
7072
7073	<result name="VBOX_E_OBJECT_NOT_FOUND">
7074	Given @c id does not correspond to any USB device.
7075	</result>
7076
7077	<see>IHostUSBDevice::id</see>
7078	</desc>
7079	<param name="id" type="uuid" mod="string" dir="in">
7080	<desc>UUID of the USB device to search for.</desc>
7081	</param>
7082	<param name="device" type="IHostUSBDevice" dir="return">
7083	<desc>Found USB device object.</desc>
7084	</param>
7085	</method>
7086
7087	<method name="findUSBDeviceByAddress">
7088	<desc>
7089	Searches for a USB device with the given host address.
7090
7091	<result name="VBOX_E_OBJECT_NOT_FOUND">
7092	Given @c name does not correspond to any USB device.
7093	</result>
7094
7095	<see>IHostUSBDevice::address</see>
7096	</desc>
7097	<param name="name" type="wstring" dir="in">
7098	<desc>
7099	Address of the USB device (as assigned by the host) to
7100	search for.
7101	</desc>
7102	</param>
7103	<param name="device" type="IHostUSBDevice" dir="return">
7104	<desc>Found USB device object.</desc>
7105	</param>
7106	</method>
7107
7108	</interface>
7109
7110	<!--
7111	// ISystemProperties
7112	/////////////////////////////////////////////////////////////////////////
7113	-->
7114
7115	<interface
7116	name="ISystemProperties"
7117	extends="$unknown"
7118	uuid="f8fff1f1-eeb4-4483-a2a4-b4186fab5a1e"
7119	wsmap="managed"
7120	>
7121	<desc>
7122	The ISystemProperties interface represents global properties of the given
7123	VirtualBox installation.
7124
7125	These properties define limits and default values for various attributes
7126	and parameters. Most of the properties are read-only, but some can be
7127	changed by a user.
7128	</desc>
7129
7130	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7131	<desc>Minimum guest system memory in Megabytes.</desc>
7132	</attribute>
7133
7134	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7135	<desc>Maximum guest system memory in Megabytes.</desc>
7136	</attribute>
7137
7138	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7139	<desc>Minimum guest video memory in Megabytes.</desc>
7140	</attribute>
7141
7142	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7143	<desc>Maximum guest video memory in Megabytes.</desc>
7144	</attribute>
7145
7146	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7147	<desc>Minimum CPU count.</desc>
7148	</attribute>
7149
7150	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7151	<desc>Maximum CPU count.</desc>
7152	</attribute>
7153
7154	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7155	<desc>Maximum of monitors which could be connected.</desc>
7156	</attribute>
7157
7158	<attribute name="infoVDSize" type="long long" readonly="yes">
7159	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7160	does not reflect the limits of any virtual disk image format.</desc>
7161	</attribute>
7162
7163	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7164	<desc>
7165	Number of network adapters associated with every
7166	<link to="IMachine"/> instance.
7167	</desc>
7168	</attribute>
7169
7170	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7171	<desc>
7172	Number of serial ports associated with every
7173	<link to="IMachine"/> instance.
7174	</desc>
7175	</attribute>
7176
7177	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7178	<desc>
7179	Number of parallel ports associated with every
7180	<link to="IMachine"/> instance.
7181	</desc>
7182	</attribute>
7183
7184	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7185	<desc>
7186	Maximum device position in the boot order. This value corresponds
7187	to the total number of devices a machine can boot from, to make it
7188	possible to include all possible devices to the boot list.
7189	<see><link to="IMachine::setBootOrder"/></see>
7190	</desc>
7191	</attribute>
7192
7193	<attribute name="defaultMachineFolder" type="wstring">
7194	<desc>
7195	Full path to the default directory used to create new or open
7196	existing machines when a settings file name contains no
7197	path.
7198
7199	The initial value of this property is
7200	<tt><</tt><link to="IVirtualBox::homeFolder">
7201	VirtualBox_home</link><tt>>/Machines</tt>.
7202
7203	<note>
7204	Setting this property to @c null or an empty string will restore the
7205	initial value.
7206	</note>
7207	<note>
7208	When settings this property, the specified path can be
7209	absolute (full path) or relative
7210	to the <link to="IVirtualBox::homeFolder">
7211	VirtualBox home directory</link>.
7212	When reading this property, a full path is
7213	always returned.
7214	</note>
7215	<note>
7216	The specified path may not exist, it will be created
7217	when necessary.
7218	</note>
7219
7220	<see>
7221	<link to="IVirtualBox::createMachine"/>,
7222	<link to="IVirtualBox::openMachine"/>
7223	</see>
7224	</desc>
7225	</attribute>
7226
7227	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7228	<desc>
7229	List of all medium storage formats supported by this VirtualBox
7230	installation.
7231
7232	Keep in mind that the medium format identifier
7233	(<link to="IMediumFormat::id"/>) used in other API calls like
7234	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7235	medium format is a case-insensitive string. This means that, for
7236	example, all of the following strings:
7237	<pre>
7238	"VDI"
7239	"vdi"
7240	"VdI"</pre>
7241	refer to the same medium format.
7242
7243	Note that the virtual medium framework is backend-based, therefore
7244	the list of supported formats depends on what backends are currently
7245	installed.
7246
7247	<see>
7248	<link to="IMediumFormat"/>,
7249	</see>
7250	</desc>
7251	</attribute>
7252
7253	<attribute name="defaultHardDiskFormat" type="wstring">
7254	<desc>
7255	Identifier of the default medium format used by VirtualBox.
7256
7257	The medium format set by this attribute is used by VirtualBox
7258	when the medium format was not specified explicitly. One example is
7259	<link to="IVirtualBox::createHardDisk"/> with the empty
7260	format argument. A more complex example is implicit creation of
7261	differencing media when taking a snapshot of a virtual machine:
7262	this operation will try to use a format of the parent medium first
7263	and if this format does not support differencing media the default
7264	format specified by this argument will be used.
7265
7266	The list of supported medium formats may be obtained by the
7267	<link to="#mediumFormats"/> call. Note that the default medium
7268	format must have a capability to create differencing media;
7269	otherwise operations that create media implicitly may fail
7270	unexpectedly.
7271
7272	The initial value of this property is <tt>"VDI"</tt> in the current
7273	version of the VirtualBox product, but may change in the future.
7274
7275	<note>
7276	Setting this property to @c null or empty string will restore the
7277	initial value.
7278	</note>
7279
7280	<see>
7281	<link to="#mediumFormats"/>,
7282	<link to="IMediumFormat::id"/>,
7283	<link to="IVirtualBox::createHardDisk"/>
7284	</see>
7285	</desc>
7286	</attribute>
7287
7288	<attribute name="freeDiskSpaceWarning" type="long long">
7289	<desc>Issue a warning if the free disk space is below (or in some disk
7290	intensive operation is expected to go below) the given size in
7291	bytes.</desc>
7292	</attribute>
7293
7294	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7295	<desc>Issue a warning if the free disk space is below (or in some disk
7296	intensive operation is expected to go below) the given percentage.</desc>
7297	</attribute>
7298
7299	<attribute name="freeDiskSpaceError" type="long long">
7300	<desc>Issue an error if the free disk space is below (or in some disk
7301	intensive operation is expected to go below) the given size in
7302	bytes.</desc>
7303	</attribute>
7304
7305	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7306	<desc>Issue an error if the free disk space is below (or in some disk
7307	intensive operation is expected to go below) the given percentage.</desc>
7308	</attribute>
7309
7310	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7311	<desc>
7312	Library that provides authentication for VRDP clients. The library
7313	is used if a virtual machine's authentication type is set to "external"
7314	in the VM RemoteDisplay configuration.
7315
7316	The system library extension (".DLL" or ".so") must be omitted.
7317	A full path can be specified; if not, then the library must reside on the
7318	system's default library path.
7319
7320	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7321	of that name in one of the default VirtualBox library directories.
7322
7323	For details about VirtualBox authentication libraries and how to implement
7324	them, please refer to the VirtualBox manual.
7325
7326	<note>
7327	Setting this property to @c null or empty string will restore the
7328	initial value.
7329	</note>
7330	</desc>
7331	</attribute>
7332
7333	<attribute name="webServiceAuthLibrary" type="wstring">
7334	<desc>
7335	Library that provides authentication for webservice clients. The library
7336	is used if a virtual machine's authentication type is set to "external"
7337	in the VM RemoteDisplay configuration and will be called from
7338	within the <link to="IWebsessionManager::logon" /> implementation.
7339
7340	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7341	there is no per-VM setting for this, as the webservice is a global
7342	resource (if it is running). Only for this setting (for the webservice),
7343	setting this value to a literal <tt>"null"</tt> string disables authentication,
7344	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7345	no matter what user name and password are supplied.
7346
7347	The initial value of this property is <tt>"VRDPAuth"</tt>,
7348	meaning that the webservice will use the same authentication
7349	library that is used by default for VBoxVRDP (again, see
7350	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7351	The format and calling convention of authentication libraries
7352	is the same for the webservice as it is for VBoxVRDP.
7353
7354	<note>
7355	Setting this property to @c null or empty string will restore the
7356	initial value.
7357	</note>
7358	</desc>
7359	</attribute>
7360
7361	<attribute name="LogHistoryCount" type="unsigned long">
7362	<desc>
7363	This value specifies how many old release log files are kept.
7364	</desc>
7365	</attribute>
7366
7367	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7368	<desc>This value hold the default audio driver for the current
7369	system.</desc>
7370	</attribute>
7371
7372	<method name="getMaxDevicesPerPortForStorageBus">
7373	<desc>Returns the maximum number of devices which can be attached to a port
7374	for the given storage bus.</desc>
7375
7376	<param name="bus" type="StorageBus" dir="in">
7377	<desc>The storage bus type to get the value for.</desc>
7378	</param>
7379
7380	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7381	<desc>The maximum number of devices which can eb attached to the port for the given
7382	storage bus.</desc>
7383	</param>
7384	</method>
7385
7386	<method name="getMinPortCountForStorageBus">
7387	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7388
7389	<param name="bus" type="StorageBus" dir="in">
7390	<desc>The storage bus type to get the value for.</desc>
7391	</param>
7392
7393	<param name="minPortCount" type="unsigned long" dir="return">
7394	<desc>The minimum number of ports for the given storage bus.</desc>
7395	</param>
7396	</method>
7397
7398	<method name="getMaxPortCountForStorageBus">
7399	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7400
7401	<param name="bus" type="StorageBus" dir="in">
7402	<desc>The storage bus type to get the value for.</desc>
7403	</param>
7404
7405	<param name="maxPortCount" type="unsigned long" dir="return">
7406	<desc>The maximum number of ports for the given storage bus.</desc>
7407	</param>
7408	</method>
7409
7410	<method name="getMaxInstancesOfStorageBus">
7411	<desc>Returns the maximum number of storage bus instances which
7412	can be configured for each VM. This corresponds to the number of
7413	storage controllers one can have.</desc>
7414
7415	<param name="bus" type="StorageBus" dir="in">
7416	<desc>The storage bus type to get the value for.</desc>
7417	</param>
7418
7419	<param name="maxInstances" type="unsigned long" dir="return">
7420	<desc>The maximum number of instances for the given storage bus.</desc>
7421	</param>
7422	</method>
7423
7424	<method name="getDeviceTypesForStorageBus">
7425	<desc>Returns list of all the supported device types
7426	(<link to="DeviceType"/>) for the given type of storage
7427	bus.</desc>
7428
7429	<param name="bus" type="StorageBus" dir="in">
7430	<desc>The storage bus type to get the value for.</desc>
7431	</param>
7432
7433	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7434	<desc>The list of all supported device types for the given storage bus.</desc>
7435	</param>
7436	</method>
7437
7438	<method name="getDefaultIoCacheSettingForStorageController">
7439	<desc>Returns the default I/O cache setting for the
7440	given storage controller</desc>
7441
7442	<param name="controllerType" type="StorageControllerType" dir="in">
7443	<desc>The storage controller to the setting for.</desc>
7444	</param>
7445
7446	<param name="enabled" type="boolean" dir="return">
7447	<desc>Returned flag indicating the default value</desc>
7448	</param>
7449	</method>
7450	</interface>
7451
7452	<!--
7453	// IGuest
7454	/////////////////////////////////////////////////////////////////////////
7455	-->
7456
7457	<interface
7458	name="IGuestOSType" extends="$unknown"
7459	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7460	wsmap="struct"
7461	>
7462	<desc>
7463	</desc>
7464
7465	<attribute name="familyId" type="wstring" readonly="yes">
7466	<desc>Guest OS family identifier string.</desc>
7467	</attribute>
7468
7469	<attribute name="familyDescription" type="wstring" readonly="yes">
7470	<desc>Human readable description of the guest OS family.</desc>
7471	</attribute>
7472
7473	<attribute name="id" type="wstring" readonly="yes">
7474	<desc>Guest OS identifier string.</desc>
7475	</attribute>
7476
7477	<attribute name="description" type="wstring" readonly="yes">
7478	<desc>Human readable description of the guest OS.</desc>
7479	</attribute>
7480
7481	<attribute name="is64Bit" type="boolean" readonly="yes">
7482	<desc>Returns @c true if the given OS is 64-bit</desc>
7483	</attribute>
7484
7485	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7486	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7487	</attribute>
7488
7489	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7490	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7491	</attribute>
7492
7493	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7494	<desc>Recommended RAM size in Megabytes.</desc>
7495	</attribute>
7496
7497	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7498	<desc>Recommended video RAM size in Megabytes.</desc>
7499	</attribute>
7500
7501	<attribute name="recommendedHDD" type="long long" readonly="yes">
7502	<desc>Recommended hard disk size in bytes.</desc>
7503	</attribute>
7504
7505	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7506	<desc>Returns recommended network adapter for this OS type.</desc>
7507	</attribute>
7508
7509	<attribute name="recommendedPae" type="boolean" readonly="yes">
7510	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7511	</attribute>
7512
7513	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7514	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7515	</attribute>
7516
7517	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7518	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7519	</attribute>
7520
7521	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7522	<desc>Recommended storage controller type for HD drives.</desc>
7523	</attribute>
7524
7525	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7526	<desc>Recommended storage bus type for HD drives.</desc>
7527	</attribute>
7528
7529	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7530	<desc>Recommended firmware type.</desc>
7531	</attribute>
7532
7533	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7534	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7535	</attribute>
7536
7537	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7538	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7539	</attribute>
7540
7541	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7542	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7543	</attribute>
7544
7545	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7546	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7547	</attribute>
7548
7549	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7550	<desc>Recommended chipset type.</desc>
7551	</attribute>
7552
7553	</interface>
7554
7555	<enum
7556	name="AdditionsRunLevelType"
7557	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7558	>
7559	<desc>
7560	Guest Additions run level type.
7561	</desc>
7562
7563	<const name="None" value="0">
7564	<desc>Guest Additions are not loaded.</desc>
7565	</const>
7566	<const name="System" value="1">
7567	<desc>Guest drivers are loaded.</desc>
7568	</const>
7569	<const name="Userland" value="2">
7570	<desc>Common components (such as application services) are loaded.</desc>
7571	</const>
7572	<const name="Desktop" value="3">
7573	<desc>Per-user desktop components are loaded.</desc>
7574	</const>
7575	</enum>
7576
7577	<enum
7578	name="ExecuteProcessFlag"
7579	uuid="9a24c17d-bd46-4207-b247-517fdd6d6b8f"
7580	>
7581	<desc>
7582	Guest process execution flags.
7583	</desc>
7584
7585	<const name="None" value="0">
7586	<desc>No flag set.</desc>
7587	</const>
7588
7589	<const name="IgnoreOrphanedProcesses" value="2">
7590	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7591	</const>
7592	</enum>
7593
7594	<enum
7595	name="ProcessInputFlag"
7596	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7597	>
7598	<desc>
7599	Guest process input flags.
7600	</desc>
7601
7602	<const name="None" value="0">
7603	<desc>No flag set.</desc>
7604	</const>
7605	<const name="EndOfFile" value="1">
7606	<desc>End of file (input) reached.</desc>
7607	</const>
7608	</enum>
7609
7610	<enum
7611	name="CopyFileFlag"
7612	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7613	>
7614	<desc>
7615	Host/Guest copy flags.
7616	</desc>
7617
7618	<const name="None" value="0">
7619	<desc>No flag set.</desc>
7620	</const>
7621
7622	<const name="Recursive" value="1">
7623	<desc>Copy directories recursively.</desc>
7624	</const>
7625
7626	<const name="Update" value="2">
7627	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7628	</const>
7629
7630	<const name="FollowLinks" value="4">
7631	<desc>Follow symbolic links.</desc>
7632	</const>
7633	</enum>
7634
7635	<interface
7636	name="IGuest" extends="$unknown"
7637	uuid="9a2d971f-62cb-4e84-b91a-c5adc2b7c6b8"
7638	wsmap="managed"
7639	>
7640	<desc>
7641	The IGuest interface represents information about the operating system
7642	running inside the virtual machine. Used in
7643	<link to="IConsole::guest"/>.
7644
7645	IGuest provides information about the guest operating system, whether
7646	Guest Additions are installed and other OS-specific virtual machine
7647	properties.
7648	</desc>
7649
7650	<attribute name="OSTypeId" type="wstring" readonly="yes">
7651	<desc>
7652	Identifier of the Guest OS type as reported by the Guest
7653	Additions.
7654	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7655	an IGuestOSType object representing details about the given
7656	Guest OS type.
7657	<note>
7658	If Guest Additions are not installed, this value will be
7659	the same as <link to="IMachine::OSTypeId"/>.
7660	</note>
7661	</desc>
7662	</attribute>
7663
7664	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7665	<desc>
7666	Current run level of the Guest Additions.
7667	</desc>
7668	</attribute>
7669
7670	<attribute name="additionsVersion" type="wstring" readonly="yes">
7671	<desc>
7672	Version of the Guest Additions including the revision (3 decimal numbers
7673	separated by dots + revision number) installed on the guest or empty
7674	when the Additions are not installed.
7675	</desc>
7676	</attribute>
7677
7678	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7679	<desc>
7680	Flag whether seamless guest display rendering (seamless desktop
7681	integration) is supported.
7682	</desc>
7683	</attribute>
7684
7685	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7686	<desc>
7687	Flag whether the guest is in graphics mode. If it is not, then
7688	seamless rendering will not work, resize hints are not immediately
7689	acted on and guest display resizes are probably not initiated by
7690	the guest additions.
7691	</desc>
7692	</attribute>
7693
7694	<attribute name="memoryBalloonSize" type="unsigned long">
7695	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7696	</attribute>
7697
7698	<attribute name="statisticsUpdateInterval" type="unsigned long">
7699	<desc>Interval to update guest statistics in seconds.</desc>
7700	</attribute>
7701
7702	<method name="internalGetStatistics">
7703	<desc>
7704	Internal method; do not use as it might change at any time
7705	</desc>
7706	<param name="cpuUser" type="unsigned long" dir="out">
7707	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7708	</param>
7709	<param name="cpuKernel" type="unsigned long" dir="out">
7710	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7711	</param>
7712	<param name="cpuIdle" type="unsigned long" dir="out">
7713	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7714	</param>
7715	<param name="memTotal" type="unsigned long" dir="out">
7716	<desc>Total amount of physical guest RAM</desc>
7717	</param>
7718	<param name="memFree" type="unsigned long" dir="out">
7719	<desc>Free amount of physical guest RAM</desc>
7720	</param>
7721	<param name="memBalloon" type="unsigned long" dir="out">
7722	<desc>Amount of ballooned physical guest RAM</desc>
7723	</param>
7724	<param name="memShared" type="unsigned long" dir="out">
7725	<desc>Amount of shared physical guest RAM</desc>
7726	</param>
7727	<param name="memCache" type="unsigned long" dir="out">
7728	<desc>Total amount of guest (disk) cache memory</desc>
7729	</param>
7730	<param name="pagedTotal" type="unsigned long" dir="out">
7731	<desc>Total amount of space in the page file</desc>
7732	</param>
7733	<param name="memAllocTotal" type="unsigned long" dir="out">
7734	<desc>Total amount of memory allocated by the hypervisor</desc>
7735	</param>
7736	<param name="memFreeTotal" type="unsigned long" dir="out">
7737	<desc>Total amount of free memory available in the hypervisor</desc>
7738	</param>
7739	<param name="memBalloonTotal" type="unsigned long" dir="out">
7740	<desc>Total amount of memory ballooned by the hypervisor</desc>
7741	</param>
7742	<param name="memSharedTotal" type="unsigned long" dir="out">
7743	<desc>Total amount of shared memory in the hypervisor</desc>
7744	</param>
7745	</method>
7746
7747	<method name="getAdditionsStatus">
7748	<desc>
7749	Retrieve the current status of a certain Guest Additions run level.
7750
7751	<result name="VBOX_E_NOT_SUPPORTED">
7752	Wrong status level specified.
7753	</result>
7754
7755	</desc>
7756	<param name="level" type="AdditionsRunLevelType" dir="in">
7757	<desc>Status level to check</desc>
7758	</param>
7759	<param name="active" type="boolean" dir="return">
7760	<desc>Flag whether the status level has been reached or not</desc>
7761	</param>
7762	</method>
7763
7764	<method name="setCredentials">
7765	<desc>
7766	Store login credentials that can be queried by guest operating
7767	systems with Additions installed. The credentials are transient
7768	to the session and the guest may also choose to erase them. Note
7769	that the caller cannot determine whether the guest operating system
7770	has queried or made use of the credentials.
7771
7772	<result name="VBOX_E_VM_ERROR">
7773	VMM device is not available.
7774	</result>
7775
7776	</desc>
7777	<param name="userName" type="wstring" dir="in">
7778	<desc>User name string, can be empty</desc>
7779	</param>
7780	<param name="password" type="wstring" dir="in">
7781	<desc>Password string, can be empty</desc>
7782	</param>
7783	<param name="domain" type="wstring" dir="in">
7784	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7785	</param>
7786	<param name="allowInteractiveLogon" type="boolean" dir="in">
7787	<desc>
7788	Flag whether the guest should alternatively allow the user to
7789	interactively specify different credentials. This flag might
7790	not be supported by all versions of the Additions.
7791	</desc>
7792	</param>
7793	</method>
7794
7795	<method name="executeProcess">
7796	<desc>
7797	Executes an existing program inside the guest VM.
7798
7799	<result name="VBOX_E_IPRT_ERROR">
7800	Could not execute process.
7801	</result>
7802
7803	</desc>
7804	<param name="execName" type="wstring" dir="in">
7805	<desc>
7806	Full path name of the command to execute on the guest; the
7807	commands has to exists in the guest VM in order to be executed.
7808	</desc>
7809	</param>
7810	<param name="flags" type="unsigned long" dir="in">
7811	<desc>
7812	Execution flags - currently not supported and therefore
7813	has to be set to 0.
7814	</desc>
7815	</param>
7816	<param name="arguments" type="wstring" safearray="yes" dir="in">
7817	<desc>
7818	Array of arguments passed to the execution command.
7819	</desc>
7820	</param>
7821	<param name="environment" type="wstring" safearray="yes" dir="in">
7822	<desc>
7823	Environment variables that can be set while the command is being
7824	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7825	variable just set its name ("NAME") without a value.
7826	</desc>
7827	</param>
7828	<param name="userName" type="wstring" dir="in">
7829	<desc>
7830	User name under which the command will be executed; has to exist
7831	and have the appropriate rights to execute programs in the VM.
7832	</desc>
7833	</param>
7834	<param name="password" type="wstring" dir="in">
7835	<desc>
7836	Password of the user account specified.
7837	</desc>
7838	</param>
7839	<param name="timeoutMS" type="unsigned long" dir="in">
7840	<desc>
7841	The maximum timeout value (in msec) to wait for finished program
7842	execution. Pass 0 for an infinite timeout.
7843	</desc>
7844	</param>
7845	<param name="pid" type="unsigned long" dir="out">
7846	<desc>
7847	The PID (process ID) of the started command for later reference.
7848	</desc>
7849	</param>
7850	<param name="progress" type="IProgress" dir="return">
7851	<desc>Progress object to track the operation completion.</desc>
7852	</param>
7853	</method>
7854
7855	<method name="getProcessOutput">
7856	<desc>
7857	Retrieves output of a formerly started process.
7858
7859	<result name="VBOX_E_IPRT_ERROR">
7860	Could not retrieve output.
7861	</result>
7862
7863	</desc>
7864	<param name="pid" type="unsigned long" dir="in">
7865	<desc>
7866	Process id returned by earlier executeProcess() call.
7867	</desc>
7868	</param>
7869	<param name="flags" type="unsigned long" dir="in">
7870	<desc>
7871	Flags describing which output to retrieve.
7872	</desc>
7873	</param>
7874	<param name="timeoutMS" type="unsigned long" dir="in">
7875	<desc>
7876	The maximum timeout value (in msec) to wait for output
7877	data. Pass 0 for an infinite timeout.
7878	</desc>
7879	</param>
7880	<param name="size" type="long long" dir="in">
7881	<desc>
7882	Size in bytes to read in the buffer.
7883	</desc>
7884	</param>
7885	<param name="data" type="octet" dir="return" safearray="yes">
7886	<desc>
7887	Buffer for retrieving the actual output. A data size of 0 means end of file
7888	if the requested size was not 0. This is the unprocessed
7889	output data, i.e. the line ending style depends on the platform of
7890	the system the server is running on.
7891	</desc>
7892	</param>
7893	</method>
7894
7895	<method name="getProcessStatus">
7896	<desc>
7897	Retrieves status, exit code and the exit reason of a formerly started process.
7898
7899	<result name="VBOX_E_IPRT_ERROR">
7900	Process with specified PID was not found.
7901	</result>
7902
7903	</desc>
7904	<param name="pid" type="unsigned long" dir="in">
7905	<desc>
7906	Process id returned by earlier executeProcess() call.
7907	</desc>
7908	</param>
7909	<param name="exitcode" type="unsigned long" dir="out">
7910	<desc>
7911	The exit code (if available).
7912	</desc>
7913	</param>
7914	<param name="flags" type="unsigned long" dir="out">
7915	<desc>
7916	Additional flags of process status (not used at the moment).
7917	</desc>
7918	</param>
7919	<param name="reason" type="unsigned long" dir="return">
7920	<desc>
7921	The current process status.
7922	</desc>
7923	</param>
7924	</method>
7925
7926	<method name="copyToGuest">
7927	<desc>
7928	Copies files/directories from host to the guest.
7929
7930	<result name="VBOX_E_IPRT_ERROR">
7931	Error while copying.
7932	</result>
7933
7934	</desc>
7935	<param name="source" type="wstring" dir="in">
7936	<desc>
7937	Foo.
7938	</desc>
7939	</param>
7940	<param name="dest" type="wstring" dir="in">
7941	<desc>
7942	Bar.
7943	</desc>
7944	</param>
7945	<param name="flags" type="unsigned long" dir="in">
7946	<desc>
7947	Copy flags.
7948	</desc>
7949	</param>
7950	<param name="progress" type="IProgress" dir="return">
7951	<desc>Progress object to track the operation completion.</desc>
7952	</param>
7953	</method>
7954
7955	<method name="setProcessInput">
7956	<desc>
7957	Sends input into a formerly started process.
7958
7959	<result name="VBOX_E_IPRT_ERROR">
7960	Could not send input.
7961	</result>
7962
7963	</desc>
7964	<param name="pid" type="unsigned long" dir="in">
7965	<desc>
7966	Process id returned by earlier executeProcess() call.
7967	</desc>
7968	</param>
7969	<param name="flags" type="unsigned long" dir="in">
7970	<desc>
7971	Not used, must be set to zero.
7972	</desc>
7973	</param>
7974	<param name="data" type="octet" dir="in" safearray="yes">
7975	<desc>
7976	Buffer of input data to send to the started process to.
7977	</desc>
7978	</param>
7979	<param name="written" type="unsigned long" dir="return">
7980	<desc>
7981	Number of bytes written.
7982	</desc>
7983	</param>
7984	</method>
7985
7986	</interface>
7987
7988
7989	<!--
7990	// IProgress
7991	/////////////////////////////////////////////////////////////////////////
7992	-->
7993
7994	<interface
7995	name="IProgress" extends="$unknown"
7996	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
7997	wsmap="managed"
7998	>
7999	<desc>
8000	The IProgress interface is used to track and control
8001	asynchronous tasks within VirtualBox.
8002
8003	An instance of this is returned every time VirtualBox starts
8004	an asynchronous task (in other words, a separate thread) which
8005	continues to run after a method call returns. For example,
8006	<link to="IConsole::saveState" />, which saves the state of
8007	a running virtual machine, can take a long time to complete.
8008	To be able to display a progress bar, a user interface such as
8009	the VirtualBox graphical user interface can use the IProgress
8010	object returned by that method.
8011
8012	Note that IProgress is a "read-only" interface in the sense
8013	that only the VirtualBox internals behind the Main API can
8014	create and manipulate progress objects, whereas client code
8015	can only use the IProgress object to monitor a task's
8016	progress and, if <link to="#cancelable" /> is @c true,
8017	cancel the task by calling <link to="#cancel" />.
8018
8019	A task represented by IProgress consists of either one or
8020	several sub-operations that run sequentially, one by one (see
8021	<link to="#operation" /> and <link to="#operationCount" />).
8022	Every operation is identified by a number (starting from 0)
8023	and has a separate description.
8024
8025	You can find the individual percentage of completion of the current
8026	operation in <link to="#operationPercent" /> and the
8027	percentage of completion of the task as a whole
8028	in <link to="#percent" />.
8029
8030	Similarly, you can wait for the completion of a particular
8031	operation via <link to="#waitForOperationCompletion" /> or
8032	for the completion of the whole task via
8033	<link to="#waitForCompletion" />.
8034	</desc>
8035
8036	<attribute name="id" type="uuid" mod="string" readonly="yes">
8037	<desc>ID of the task.</desc>
8038	</attribute>
8039
8040	<attribute name="description" type="wstring" readonly="yes">
8041	<desc>Description of the task.</desc>
8042	</attribute>
8043
8044	<attribute name="initiator" type="$unknown" readonly="yes">
8045	<desc>Initiator of the task.</desc>
8046	</attribute>
8047
8048	<attribute name="cancelable" type="boolean" readonly="yes">
8049	<desc>Whether the task can be interrupted.</desc>
8050	</attribute>
8051
8052	<attribute name="percent" type="unsigned long" readonly="yes">
8053	<desc>
8054	Current progress value of the task as a whole, in percent.
8055	This value depends on how many operations are already complete.
8056	Returns 100 if <link to="#completed" /> is @c true.
8057	</desc>
8058	</attribute>
8059
8060	<attribute name="timeRemaining" type="long" readonly="yes">
8061	<desc>
8062	Estimated remaining time until the task completes, in
8063	seconds. Returns 0 once the task has completed; returns -1
8064	if the remaining time cannot be computed, in particular if
8065	the current progress is 0.
8066
8067	Even if a value is returned, the estimate will be unreliable
8068	for low progress values. It will become more reliable as the
8069	task progresses; it is not recommended to display an ETA
8070	before at least 20% of a task have completed.
8071	</desc>
8072	</attribute>
8073
8074	<attribute name="completed" type="boolean" readonly="yes">
8075	<desc>Whether the task has been completed.</desc>
8076	</attribute>
8077
8078	<attribute name="canceled" type="boolean" readonly="yes">
8079	<desc>Whether the task has been canceled.</desc>
8080	</attribute>
8081
8082	<attribute name="resultCode" type="long" readonly="yes">
8083	<desc>
8084	Result code of the progress task.
8085	Valid only if <link to="#completed"/> is @c true.
8086	</desc>
8087	</attribute>
8088
8089	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8090	<desc>
8091	Extended information about the unsuccessful result of the
8092	progress operation. May be @c null if no extended information
8093	is available.
8094	Valid only if <link to="#completed"/> is @c true and
8095	<link to="#resultCode"/> indicates a failure.
8096	</desc>
8097	</attribute>
8098
8099	<attribute name="operationCount" type="unsigned long" readonly="yes">
8100	<desc>
8101	Number of sub-operations this task is divided into.
8102	Every task consists of at least one suboperation.
8103	</desc>
8104	</attribute>
8105
8106	<attribute name="operation" type="unsigned long" readonly="yes">
8107	<desc>Number of the sub-operation being currently executed.</desc>
8108	</attribute>
8109
8110	<attribute name="operationDescription" type="wstring" readonly="yes">
8111	<desc>
8112	Description of the sub-operation being currently executed.
8113	</desc>
8114	</attribute>
8115
8116	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8117	<desc>Progress value of the current sub-operation only, in percent.</desc>
8118	</attribute>
8119
8120	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8121	<desc>Weight value of the current sub-operation only.</desc>
8122	</attribute>
8123
8124	<attribute name="timeout" type="unsigned long">
8125	<desc>
8126	When non-zero, this specifies the number of milliseconds after which
8127	the operation will automatically be canceled. This can only be set on
8128	cancelable objects.
8129	</desc>
8130	</attribute>
8131
8132	<method name="setCurrentOperationProgress">
8133	<desc>Internal method, not to be called externally.</desc>
8134	<param name="percent" type="unsigned long" dir="in" />
8135	</method>
8136	<method name="setNextOperation">
8137	<desc>Internal method, not to be called externally.</desc>
8138	<param name="nextOperationDescription" type="wstring" dir="in" />
8139	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8140	</method>
8141
8142	<method name="waitForCompletion">
8143	<desc>
8144	Waits until the task is done (including all sub-operations)
8145	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8146
8147	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8148	thread are not processed while waiting. Neglecting event queues may
8149	have dire consequences (degrade performance, resource hogs,
8150	deadlocks, etc.), this is specially so for the main thread on
8151	platforms using XPCOM. Callers are adviced wait for short periods
8152	and service their event queues between calls, or to create a worker
8153	thread to do the waiting.
8154
8155	<result name="VBOX_E_IPRT_ERROR">
8156	Failed to wait for task completion.
8157	</result>
8158	</desc>
8159
8160	<param name="timeout" type="long" dir="in">
8161	<desc>
8162	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8163	</desc>
8164	</param>
8165	</method>
8166
8167	<method name="waitForOperationCompletion">
8168	<desc>
8169	Waits until the given operation is done with a given timeout in
8170	milliseconds; specify -1 for an indefinite wait.
8171
8172	See <link to="#waitForCompletion"> for event queue considerations.</link>
8173
8174	<result name="VBOX_E_IPRT_ERROR">
8175	Failed to wait for operation completion.
8176	</result>
8177
8178	</desc>
8179	<param name="operation" type="unsigned long" dir="in">
8180	<desc>
8181	Number of the operation to wait for.
8182	Must be less than <link to="#operationCount"/>.
8183	</desc>
8184	</param>
8185	<param name="timeout" type="long" dir="in">
8186	<desc>
8187	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8188	</desc>
8189	</param>
8190	</method>
8191
8192	<method name="cancel">
8193	<desc>
8194	Cancels the task.
8195	<note>
8196	If <link to="#cancelable"/> is @c false, then this method will fail.
8197	</note>
8198
8199	<result name="VBOX_E_INVALID_OBJECT_STATE">
8200	Operation cannot be canceled.
8201	</result>
8202
8203	</desc>
8204	</method>
8205
8206	</interface>
8207
8208	<!--
8209	// ISnapshot
8210	/////////////////////////////////////////////////////////////////////////
8211	-->
8212
8213	<interface
8214	name="ISnapshot" extends="$unknown"
8215	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8216	wsmap="managed"
8217	>
8218	<desc>
8219	The ISnapshot interface represents a snapshot of the virtual
8220	machine.
8221
8222	Together with the differencing media that are created
8223	when a snapshot is taken, a machine can be brought back to
8224	the exact state it was in when the snapshot was taken.
8225
8226	The ISnapshot interface has no methods, only attributes; snapshots
8227	are controlled through methods of the <link to="IConsole" /> interface
8228	which also manage the media associated with the snapshot.
8229	The following operations exist:
8230
8231	<ul>
8232	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8233	by creating new, empty differencing images for the machine's
8234	media and saving the VM settings and (if the VM is running)
8235	the current VM state in the snapshot.
8236
8237	The differencing images will then receive all data written to
8238	the machine's media, while their parent (base) images
8239	remain unmodified after the snapshot has been taken (see
8240	<link to="IMedium" /> for details about differencing images).
8241	This simplifies restoring a machine to the state of a snapshot:
8242	only the differencing images need to be deleted.
8243
8244	The current machine state is not changed by taking a snapshot.
8245	If the machine is running, it will resume execution after the
8246	snapshot has been taken. After calling this,
8247	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8248	just created.
8249	</li>
8250
8251	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8252	the state of a previous snapshot by deleting the differencing
8253	image of each of the machine's media and setting the machine's
8254	settings and state to the state that was saved in the snapshot (if any).
8255
8256	This destroys the machine's current state. After calling this,
8257	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8258	restored.
8259	</li>
8260
8261	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8262	without affecting the current machine state.
8263
8264	This does not change the current machine state, but instead frees the
8265	resources allocated when the snapshot was taken: the settings and machine
8266	state file are deleted (if any), and the snapshot's differencing image for
8267	each of the machine's media gets merged with its parent image.
8268
8269	Neither the current machine state nor other snapshots are affected
8270	by this operation, except that parent media will be modified
8271	to contain the disk data associated with the snapshot being deleted.
8272
8273	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8274	attribute is set to the current snapshot's parent or NULL if it
8275	has no parent. Otherwise the attribute is unchanged.
8276	</li>
8277	</ul>
8278
8279	Each snapshot contains the settings of the virtual machine (hardware
8280	configuration etc.). In addition, if the machine was running when the
8281	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8282	the current VM state is saved in the snapshot (similarly to what happens
8283	when a VM's state is saved). The snapshot is then said to
8284	be <i>online</i> because when restoring it, the VM will be running.
8285
8286	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8287	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8288
8289	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8290	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8291	it then contains a so-called "zero execution state", representing a
8292	machine that is powered off.
8293	</desc>
8294
8295	<attribute name="id" type="uuid" mod="string" readonly="yes">
8296	<desc>UUID of the snapshot.</desc>
8297	</attribute>
8298
8299	<attribute name="name" type="wstring">
8300	<desc>Short name of the snapshot.</desc>
8301	</attribute>
8302
8303	<attribute name="description" type="wstring">
8304	<desc>Optional description of the snapshot.</desc>
8305	</attribute>
8306
8307	<attribute name="timeStamp" type="long long" readonly="yes">
8308	<desc>
8309	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8310	</desc>
8311	</attribute>
8312
8313	<attribute name="online" type="boolean" readonly="yes">
8314	<desc>
8315	@c true if this snapshot is an online snapshot and @c false otherwise.
8316
8317	When this attribute is @c true, the
8318	<link to="IMachine::stateFilePath"/> attribute of the
8319	<link to="#machine"/> object associated with this snapshot
8320	will point to the saved state file. Otherwise, it will be
8321	an empty string.
8322	</desc>
8323	</attribute>
8324
8325	<attribute name="machine" type="IMachine" readonly="yes">
8326	<desc>
8327	Virtual machine this snapshot is taken on. This object
8328	stores all settings the machine had when taking this snapshot.
8329	<note>
8330	The returned machine object is immutable, i.e. no
8331	any settings can be changed.
8332	</note>
8333	</desc>
8334	</attribute>
8335
8336	<attribute name="parent" type="ISnapshot" readonly="yes">
8337	<desc>
8338	Parent snapshot (a snapshot this one is based on), or
8339	@c null if the snapshot has no parent (i.e. is the first snapshot).
8340	</desc>
8341	</attribute>
8342
8343	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8344	<desc>
8345	Child snapshots (all snapshots having this one as a parent).
8346	</desc>
8347	</attribute>
8348
8349	</interface>
8350
8351
8352	<!--
8353	// IMedium
8354	/////////////////////////////////////////////////////////////////////////
8355	-->
8356
8357	<enum
8358	name="MediumState"
8359	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8360	>
8361	<desc>
8362	Virtual medium state.
8363	<see>IMedium</see>
8364	</desc>
8365
8366	<const name="NotCreated" value="0">
8367	<desc>
8368	Associated medium storage does not exist (either was not created yet or
8369	was deleted).
8370	</desc>
8371	</const>
8372	<const name="Created" value="1">
8373	<desc>
8374	Associated storage exists and accessible; this gets set if the
8375	accessibility check performed by <link to="IMedium::refreshState" />
8376	was successful.
8377	</desc>
8378	</const>
8379	<const name="LockedRead" value="2">
8380	<desc>
8381	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8382	no data modification is possible.
8383	</desc>
8384	</const>
8385	<const name="LockedWrite" value="3">
8386	<desc>
8387	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8388	no concurrent data reading or modification is possible.
8389	</desc>
8390	</const>
8391	<const name="Inaccessible" value="4">
8392	<desc>
8393	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8394	not yet been performed, or else, associated medium storage is not
8395	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8396	is empty, in the second case, it describes the error that occured.
8397	</desc>
8398	</const>
8399	<const name="Creating" value="5">
8400	<desc>
8401	Associated medium storage is being created.
8402	</desc>
8403	</const>
8404	<const name="Deleting" value="6">
8405	<desc>
8406	Associated medium storage is being deleted.
8407	</desc>
8408	</const>
8409	</enum>
8410
8411	<enum
8412	name="MediumType"
8413	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
8414	>
8415	<desc>
8416	Virtual medium type.
8417	<see>IMedium</see>
8418	</desc>
8419
8420	<const name="Normal" value="0">
8421	<desc>
8422	Normal medium (attached directly or indirectly, preserved
8423	when taking snapshots).
8424	</desc>
8425	</const>
8426	<const name="Immutable" value="1">
8427	<desc>
8428	Immutable medium (attached indirectly, changes are wiped out
8429	the next time the virtual machine is started).
8430	</desc>
8431	</const>
8432	<const name="Writethrough" value="2">
8433	<desc>
8434	Write through medium (attached directly, ignored when
8435	taking snapshots).
8436	</desc>
8437	</const>
8438	<const name="Shareable" value="3">
8439	<desc>
8440	Allow using this medium concurrently by several machines.
8441	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8442	</desc>
8443	</const>
8444	</enum>
8445
8446	<enum
8447	name="MediumVariant"
8448	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8449	>
8450	<desc>
8451	Virtual medium image variant. More than one flag may be set.
8452	<see>IMedium</see>
8453	</desc>
8454
8455	<const name="Standard" value="0">
8456	<desc>
8457	No particular variant requested, results in using the backend default.
8458	</desc>
8459	</const>
8460	<const name="VmdkSplit2G" value="0x01">
8461	<desc>
8462	VMDK image split in chunks of less than 2GByte.
8463	</desc>
8464	</const>
8465	<const name="VmdkStreamOptimized" value="0x04">
8466	<desc>
8467	VMDK streamOptimized image. Special import/export format which is
8468	read-only/append-only.
8469	</desc>
8470	</const>
8471	<const name="VmdkESX" value="0x08">
8472	<desc>
8473	VMDK format variant used on ESX products.
8474	</desc>
8475	</const>
8476	<const name="Fixed" value="0x10000">
8477	<desc>
8478	Fixed image. Only allowed for base images.
8479	</desc>
8480	</const>
8481	<const name="Diff" value="0x20000">
8482	<desc>
8483	Differencing image. Only allowed for child images.
8484	</desc>
8485	</const>
8486	</enum>
8487
8488	<interface
8489	name="IMediumAttachment" extends="$unknown"
8490	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8491	wsmap="struct"
8492	>
8493	<desc>
8494	The IMediumAttachment interface links storage media to virtual machines.
8495	For each medium (<link to="IMedium"/>) which has been attached to a
8496	storage controller (<link to="IStorageController"/>) of a machine
8497	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8498	method, one instance of IMediumAttachment is added to the machine's
8499	<link to="IMachine::mediumAttachments"/> array attribute.
8500
8501	Each medium attachment specifies the storage controller as well as a
8502	port and device number and the IMedium instance representing a virtual
8503	hard disk or floppy or DVD image.
8504
8505	For removeable media (DVDs or floppies), there are two additional
8506	options. For one, the IMedium instance can be @c null to represent
8507	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8508	secondly, the medium can be one of the pseudo-media for host drives
8509	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8510	</desc>
8511
8512	<attribute name="medium" type="IMedium" readonly="yes">
8513	<desc>Medium object associated with this attachment; it
8514	can be @c null for removable devices.</desc>
8515	</attribute>
8516
8517	<attribute name="controller" type="wstring" readonly="yes">
8518	<desc>Name of the storage controller of this attachment; this
8519	refers to one of the controllers in <link to="IMachine::storageControllers" />
8520	by name.</desc>
8521	</attribute>
8522
8523	<attribute name="port" type="long" readonly="yes">
8524	<desc>Port number of this attachment.
8525	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8526	</desc>
8527	</attribute>
8528
8529	<attribute name="device" type="long" readonly="yes">
8530	<desc>Device slot number of this attachment.
8531	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8532	</desc>
8533	</attribute>
8534
8535	<attribute name="type" type="DeviceType" readonly="yes">
8536	<desc>Device type of this attachment.</desc>
8537	</attribute>
8538
8539	<attribute name="passthrough" type="boolean" readonly="yes">
8540	<desc>Pass I/O requests through to a device on the host.</desc>
8541	</attribute>
8542
8543	<attribute name="bandwidthLimit" type="unsigned long">
8544	<desc>
8545	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8546	A zero value means uncapped/unlimited.
8547	</desc>
8548	</attribute>
8549
8550	</interface>
8551
8552	<interface
8553	name="IMedium" extends="$unknown"
8554	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8555	wsmap="managed"
8556	>
8557	<desc>
8558	The IMedium interface represents virtual storage for a machine's
8559	hard disks, CD/DVD or floppy drives. It will typically represent
8560	a disk image on the host, for example a VDI or VMDK file representing
8561	a virtual hard disk, or an ISO or RAW file representing virtual
8562	removable media, but can also point to a network location (e.g.
8563	for iSCSI targets).
8564
8565	Instances of IMedium are connected to virtual machines by way of
8566	medium attachments (see <link to="IMediumAttachment" />), which link
8567	the storage medium to a particular device slot of a storage controller
8568	of the virtual machine.
8569	In the VirtualBox API, virtual storage is therefore always represented
8570	by the following chain of object links:
8571
8572	<ul>
8573	<li><link to="IMachine::storageControllers"/> contains an array of
8574	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8575	these are instances of <link to="IStorageController"/>).</li>
8576	<li><link to="IMachine::mediumAttachments"/> contains an array of
8577	medium attachments (instances of <link to="IMediumAttachment"/>),
8578	each containing a storage controller from the above array, a
8579	port/device specification, and an instance of IMedium representing
8580	the medium storage (image file).
8581
8582	For removable media, the storage medium is optional; a medium
8583	attachment with no medium represents a CD/DVD or floppy drive
8584	with no medium inserted. By contrast, hard disk attachments
8585	will always have an IMedium object attached.</li>
8586	<li>Each IMedium in turn points to a storage unit (such as a file
8587	on the host computer or a network resource) that holds actual
8588	data. This location is represented by the <link to="#location"/>
8589	attribute.</li>
8590	</ul>
8591
8592	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8593	new hard disk media can be created with the VirtualBox API using the
8594	<link to="IVirtualBox::createHardDisk"/> method.
8595
8596	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8597	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8598	type in a regular file.
8599
8600	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8601	drive; in that case the <link to="#id" /> attribute contains the UUID of
8602	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8603
8604	<h3>Known media</h3>
8605
8606	When an existing medium is opened for the first time, it is automatically
8607	remembered by the given VirtualBox installation or, in other words, becomes
8608	a <i>known medium</i>. Known media are stored in the media
8609	registry transparently maintained by VirtualBox and stored in settings
8610	files so that this registry is preserved when VirtualBox is not running.
8611
8612	Newly created virtual media are remembered only when the associated
8613	storage unit is actually created.
8614
8615	All known media can be enumerated using
8616	<link to="IVirtualBox::hardDisks"/>,
8617	<link to="IVirtualBox::DVDImages"/> and
8618	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8619	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8620
8621	Only known media can be attached to virtual machines.
8622
8623	Removing known media from the media registry is performed when the given
8624	medium is closed using the <link to="#close"/> method or when its
8625	associated storage unit is deleted.
8626
8627	<h3>Accessibility checks</h3>
8628
8629	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8630	method is called explicitly on a medium. This is done to make the VirtualBox object
8631	ready for serving requests as fast as possible and let the end-user
8632	application decide if it needs to check media accessibility right away or not.
8633
8634	As a result, when VirtualBox starts up (e.g. the VirtualBox
8635	object gets created for the first time), all known media are in the
8636	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8637	attribute is an empty string because no actual accessibility check has
8638	been made yet.
8639
8640	After calling <link to="#refreshState" />, a medium is considered
8641	<i>accessible</i> if its storage unit can be read. In that case, the
8642	<link to="#state"/> attribute has a value of "Created". If the storage
8643	unit cannot be read (for example, because it is located on a disconnected
8644	network resource, or was accidentally deleted outside VirtualBox),
8645	the medium is considered <i>inaccessible</i>, which is indicated by the
8646	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8647	obtained by reading the <link to="#lastAccessError"/> attribute.
8648
8649	<h3>Medium types</h3>
8650
8651	There are four types of medium behavior (see <link to="MediumType" />):
8652	"normal", "immutable", "writethrough" and "shareable", represented by the
8653	<link to="#type"/> attribute. The type of the medium defines how the
8654	medium is attached to a virtual machine and what happens when a
8655	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8656	attached medium is taken. At the moment DVD and floppy media are always
8657	of type "writethrough".
8658
8659	All media can be also divided in two groups: <i>base</i> media and
8660	<i>differencing</i> media. A base medium contains all sectors of the
8661	medium data in its own storage and therefore can be used independently.
8662	In contrast, a differencing mediun is a "delta" to some other medium and
8663	contains only those sectors which differ from that other medium, which is
8664	then called a <i>parent</i>. The differencing medium is said to be
8665	<i>linked to</i> that parent. The parent may be itself a differencing
8666	medium, thus forming a chain of linked media. The last element in that
8667	chain must always be a base medium. Note that several differencing
8668	media may be linked to the same parent medium.
8669
8670	Differencing media can be distinguished from base media by querying the
8671	<link to="#parent"/> attribute: base media do not have parents they would
8672	depend on, so the value of this attribute is always @c null for them.
8673	Using this attribute, it is possible to walk up the medium tree (from the
8674	child medium to its parent). It is also possible to walk down the tree
8675	using the <link to="#children"/> attribute.
8676
8677	Note that the type of all differencing media is "normal"; all other
8678	values are meaningless for them. Base media may be of any type.
8679
8680	<h3>Creating hard disks</h3>
8681
8682	New base hard disks are created using
8683	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8684	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8685	disks are usually implicitly created by VirtualBox when needed but may
8686	also be created explicitly using <link to="#createDiffStorage"/>.
8687
8688	After the hard disk is successfully created (including the storage unit)
8689	or opened, it becomes a known hard disk (remembered in the internal media
8690	registry). Known hard disks can be attached to a virtual machine, accessed
8691	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8692	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8693
8694	The following methods, besides <link to="IMedium::close"/>,
8695	automatically remove the hard disk from the media registry:
8696	<ul>
8697	<li><link to="#deleteStorage"/></li>
8698	<li><link to="#mergeTo"/></li>
8699	</ul>
8700
8701	If the storage unit of the hard disk is a regular file in the host's
8702	file system then the rules stated in the description of the
8703	<link to="IMedium::location"/> attribute apply when setting its value.
8704
8705	<h4>Automatic composition of the file name part</h4>
8706
8707	Another extension to the <link to="IMedium::location"/> attribute is that
8708	there is a possibility to cause VirtualBox to compose a unique value for
8709	the file name part of the location using the UUID of the hard disk. This
8710	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8711	e.g. before the storage unit is created, and works as follows. You set the
8712	value of the <link to="IMedium::location"/> attribute to a location
8713	specification which only contains the path specification but not the file
8714	name part and ends with either a forward slash or a backslash character.
8715	In response, VirtualBox will generate a new UUID for the hard disk and
8716	compose the file name using the following pattern:
8717	<pre>
8718	<path>/{<uuid>}.<ext>
8719	</pre>
8720	where <tt><path></tt> is the supplied path specification,
8721	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8722	is the default extension for the storage format of this hard disk. After
8723	that, you may call any of the methods that create a new hard disk storage
8724	unit and they will use the generated UUID and file name.
8725
8726	<h3>Attaching Hard Disks</h3>
8727
8728	Hard disks are attached to virtual machines using the
8729	<link to="IMachine::attachDevice"/> method and detached using the
8730	<link to="IMachine::detachDevice"/> method. Depending on their
8731	<link to="#type"/>, hard disks are attached either
8732	<i>directly</i> or <i>indirectly</i>.
8733
8734	When a hard disk is being attached directly, it is associated with the
8735	virtual machine and used for hard disk operations when the machine is
8736	running. When a hard disk is being attached indirectly, a new differencing
8737	hard disk linked to it is implicitly created and this differencing hard
8738	disk is associated with the machine and used for hard disk operations.
8739	This also means that if <link to="IMachine::attachDevice"/> performs
8740	a direct attachment then the same hard disk will be returned in response
8741	to the subsequent <link to="IMachine::getMedium"/> call; however if
8742	an indirect attachment is performed then
8743	<link to="IMachine::getMedium"/> will return the implicitly created
8744	differencing hard disk, not the original one passed to <link
8745	to="IMachine::attachDevice"/>. In detail:
8746
8747	<ul>
8748	<li><b>Normal base</b> hard disks that do not have children (i.e.
8749	differencing hard disks linked to them) and that are not already
8750	attached to virtual machines in snapshots are attached <b>directly</b>.
8751	Otherwise, they are attached <b>indirectly</b> because having
8752	dependent children or being part of the snapshot makes it impossible
8753	to modify hard disk contents without breaking the integrity of the
8754	dependent party. The <link to="#readOnly"/> attribute allows to
8755	quickly determine the kind of the attachment for the given hard
8756	disk. Note that if a normal base hard disk is to be indirectly
8757	attached to a virtual machine with snapshots then a special
8758	procedure called <i>smart attachment</i> is performed (see below).</li>
8759	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8760	they are attached <b>directly</b> if they do not have children and are
8761	not attached to virtual machines in snapshots, and <b>indirectly</b>
8762	otherwise. Note that the smart attachment procedure is never performed
8763	for differencing hard disks.</li>
8764	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8765	they are designed to be non-writable. If an immutable hard disk is
8766	attached to a virtual machine with snapshots then a special
8767	procedure called smart attachment is performed (see below).</li>
8768	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8769	also as designed. This also means that writethrough hard disks cannot
8770	have other hard disks linked to them at all.</li>
8771	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8772	also as designed. This also means that shareable hard disks cannot
8773	have other hard disks linked to them at all. They behave almost
8774	like writethrough hard disks, except that shareable hard disks can
8775	be attached to several virtual machines which are running, allowing
8776	concurrent accesses. You need special cluster software running in
8777	the virtual machines to make use of such disks.</li>
8778	</ul>
8779
8780	Note that the same hard disk, regardless of its type, may be attached to
8781	more than one virtual machine at a time. In this case, the machine that is
8782	started first gains exclusive access to the hard disk and attempts to
8783	start other machines having this hard disk attached will fail until the
8784	first machine is powered down.
8785
8786	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8787	that the given hard disk remains associated with the given machine after a
8788	successful <link to="IMachine::detachDevice"/> call until
8789	<link to="IMachine::saveSettings"/> is called to save all changes to
8790	machine settings to disk. This deferring is necessary to guarantee that
8791	the hard disk configuration may be restored at any time by a call to
8792	<link to="IMachine::discardSettings"/> before the settings
8793	are saved (committed).
8794
8795	Note that if <link to="IMachine::discardSettings"/> is called after
8796	indirectly attaching some hard disks to the machine but before a call to
8797	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8798	all differencing hard disks implicitly created by
8799	<link to="IMachine::attachDevice"/> for these indirect attachments.
8800	Such implicitly created hard disks will also be immediately deleted when
8801	detached explicitly using the <link to="IMachine::detachDevice"/>
8802	call if it is made before <link to="IMachine::saveSettings"/>. This
8803	implicit deletion is safe because newly created differencing hard
8804	disks do not contain any user data.
8805
8806	However, keep in mind that detaching differencing hard disks that were
8807	implicitly created by <link to="IMachine::attachDevice"/>
8808	before the last <link to="IMachine::saveSettings"/> call will
8809	<b>not</b> implicitly delete them as they may already contain some data
8810	(for example, as a result of virtual machine execution). If these hard
8811	disks are no more necessary, the caller can always delete them explicitly
8812	using <link to="#deleteStorage"/> after they are actually de-associated
8813	from this machine by the <link to="IMachine::saveSettings"/> call.
8814
8815	<h3>Smart Attachment</h3>
8816
8817	When normal base or immutable hard disks are indirectly attached to a
8818	virtual machine then some additional steps are performed to make sure the
8819	virtual machine will have the most recent "view" of the hard disk being
8820	attached. These steps include walking through the machine's snapshots
8821	starting from the current one and going through ancestors up to the first
8822	snapshot. Hard disks attached to the virtual machine in all
8823	of the encountered snapshots are checked whether they are descendants of
8824	the given normal base or immutable hard disk. The first found child (which
8825	is the differencing hard disk) will be used instead of the normal base or
8826	immutable hard disk as a parent for creating a new differencing hard disk
8827	that will be actually attached to the machine. And only if no descendants
8828	are found or if the virtual machine does not have any snapshots then the
8829	normal base or immutable hard disk will be used itself as a parent for
8830	this differencing hard disk.
8831
8832	It is easier to explain what smart attachment does using the
8833	following example:
8834	<pre>
8835	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8836
8837	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8838	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8839	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8840	Snapshot 4 (none) Snapshot 4 (none)
8841	CurState (none) CurState (D3->D2.vdi)
8842
8843	NOT
8844	...
8845	CurState (D3->B.vdi)
8846	</pre>
8847	The first column is the virtual machine configuration before the base hard
8848	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8849	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8850	mean that the hard disk that is actually attached to the machine is a
8851	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8852	another hard disk, <tt>B.vdi</tt>.
8853
8854	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8855	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8856	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8857	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8858	it cannot be attached directly and needs an indirect attachment (i.e.
8859	implicit creation of a new differencing hard disk). Due to the smart
8860	attachment procedure, the new differencing hard disk
8861	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8862	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8863	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8864	machine.
8865
8866	Note that if there is more than one descendant hard disk of the given base
8867	hard disk found in a snapshot, and there is an exact device, channel and
8868	bus match, then this exact match will be used. Otherwise, the youngest
8869	descendant will be picked up.
8870
8871	There is one more important aspect of the smart attachment procedure which
8872	is not related to snapshots at all. Before walking through the snapshots
8873	as described above, the backup copy of the current list of hard disk
8874	attachment is searched for descendants. This backup copy is created when
8875	the hard disk configuration is changed for the first time after the last
8876	<link to="IMachine::saveSettings"/> call and used by
8877	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8878	changes. When such a descendant is found in this backup copy, it will be
8879	simply re-attached back, without creating a new differencing hard disk for
8880	it. This optimization is necessary to make it possible to re-attach the
8881	base or immutable hard disk to a different bus, channel or device slot
8882	without losing the contents of the differencing hard disk actually
8883	attached to the machine in place of it.
8884	</desc>
8885
8886	<attribute name="id" type="uuid" mod="string" readonly="yes">
8887	<desc>
8888	UUID of the medium. For a newly created medium, this value is a randomly
8889	generated UUID.
8890
8891	<note>
8892	For media in one of MediumState_NotCreated, MediumState_Creating or
8893	MediumState_Deleting states, the value of this property is undefined
8894	and will most likely be an empty UUID.
8895	</note>
8896	</desc>
8897	</attribute>
8898
8899	<attribute name="description" type="wstring">
8900	<desc>
8901	Optional description of the medium. For a newly created medium the value
8902	of this attribute is an empty string.
8903
8904	Medium types that don't support this attribute will return E_NOTIMPL in
8905	attempt to get or set this attribute's value.
8906
8907	<note>
8908	For some storage types, reading this attribute may return an outdated
8909	(last known) value when <link to="#state"/> is <link
8910	to="MediumState_Inaccessible"/> or <link
8911	to="MediumState_LockedWrite"/> because the value of this attribute is
8912	stored within the storage unit itself. Also note that changing the
8913	attribute value is not possible in such case, as well as when the
8914	medium is the <link to="MediumState_LockedRead"/> state.
8915	</note>
8916	</desc>
8917	</attribute>
8918
8919	<attribute name="state" type="MediumState" readonly="yes">
8920	<desc>
8921	Returns the current medium state, which is the last state set by
8922	the accessibility check performed by <link to="#refreshState"/>.
8923	If that method has not yet been called on the medium, the state
8924	is "Inaccessible"; as opposed to truly inaccessible media, the
8925	value of <link to="#lastAccessError"/> will be an empty string in
8926	that case.
8927
8928	<note>As of version 3.1, this no longer performs an accessibility check
8929	automatically; call <link to="#refreshState"/> for that.
8930	</note>
8931	</desc>
8932	</attribute>
8933
8934	<attribute name="variant" type="MediumVariant" readonly="yes">
8935	<desc>
8936	Returns the storage format variant information for this medium.
8937	Before <link to="#refreshState"/> is called this method returns
8938	an undefined value.
8939	</desc>
8940	</attribute>
8941
8942	<attribute name="location" type="wstring">
8943	<desc>
8944	Location of the storage unit holding medium data.
8945
8946	The format of the location string is medium type specific. For medium
8947	types using regular files in a host's file system, the location
8948	string is the full file name.
8949
8950	Some medium types may support changing the storage unit location by
8951	simply changing the value of this property. If this operation is not
8952	supported, the implementation will return E_NOTIMPL in attempt to set
8953	this attribute's value.
8954
8955	When setting a value of the location attribute which is a regular file
8956	in the host's file system, the given file name may be either relative to
8957	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
8958	absolute. Note that if the given location specification does not contain
8959	the file extension part then a proper default extension will be
8960	automatically appended by the implementation depending on the medium type.
8961	</desc>
8962	</attribute>
8963
8964	<attribute name="name" type="wstring" readonly="yes">
8965	<desc>
8966	Name of the storage unit holding medium data.
8967
8968	The returned string is a short version of the <link to="#location"/>
8969	attribute that is suitable for representing the medium in situations
8970	where the full location specification is too long (such as lists
8971	and comboboxes in GUI frontends). This string is also used by frontends
8972	to sort the media list alphabetically when needed.
8973
8974	For example, for locations that are regular files in the host's file
8975	system, the value of this attribute is just the file name (+ extension),
8976	without the path specification.
8977
8978	Note that as opposed to the <link to="#location"/> attribute, the name
8979	attribute will not necessary be unique for a list of media of the
8980	given type and format.
8981	</desc>
8982	</attribute>
8983
8984	<attribute name="deviceType" type="DeviceType" readonly="yes">
8985	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
8986	medium.</desc>
8987	</attribute>
8988
8989	<attribute name="hostDrive" type="boolean" readonly="yes">
8990	<desc>True if this corresponds to a drive on the host.</desc>
8991	</attribute>
8992
8993	<attribute name="size" type="long long" readonly="yes">
8994	<desc>
8995	Physical size of the storage unit used to hold medium data (in bytes).
8996
8997	<note>
8998	For media whose <link to="#state"/> is <link
8999	to="MediumState_Inaccessible"/>, the value of this property is the
9000	last known size. For <link to="MediumState_NotCreated"/> media,
9001	the returned value is zero.
9002	</note>
9003	</desc>
9004	</attribute>
9005
9006	<attribute name="format" type="wstring" readonly="yes">
9007	<desc>
9008	Storage format of this medium.
9009
9010	The value of this attribute is a string that specifies a backend used
9011	to store medium data. The storage format is defined when you create a
9012	new medium or automatically detected when you open an existing medium,
9013	and cannot be changed later.
9014
9015	The list of all storage formats supported by this VirtualBox
9016	installation can be obtained using
9017	<link to="ISystemProperties::mediumFormats"/>.
9018	</desc>
9019	</attribute>
9020
9021	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9022	<desc>
9023	Storage medium format object corresponding to this medium.
9024
9025	The value of this attribute is a reference to the medium format object
9026	that specifies the backend properties used to store medium data. The
9027	storage format is defined when you create a new medium or automatically
9028	detected when you open an existing medium, and cannot be changed later.
9029
9030	<note>@c null is returned if there is no associated medium format
9031	object. This can e.g. happen for medium objects representing host
9032	drives and other special medium objects.</note>
9033	</desc>
9034	</attribute>
9035
9036	<attribute name="type" type="MediumType">
9037	<desc>
9038	Type (role) of this medium.
9039
9040	The following constraints apply when changing the value of this
9041	attribute:
9042	<ul>
9043	<li>If a medium is attached to a virtual machine (either in the
9044	current state or in one of the snapshots), its type cannot be
9045	changed.
9046	</li>
9047	<li>As long as the medium has children, its type cannot be set
9048	to <link to="MediumType_Writethrough"/>.
9049	</li>
9050	<li>The type of all differencing media is
9051	<link to="MediumType_Normal"/> and cannot be changed.
9052	</li>
9053	</ul>
9054
9055	The type of a newly created or opened medium is set to
9056	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9057	which have a type of <link to="MediumType_Writethrough"/>.
9058	</desc>
9059	</attribute>
9060
9061	<attribute name="parent" type="IMedium" readonly="yes">
9062	<desc>
9063	Parent of this medium (the medium this medium is directly based
9064	on).
9065
9066	Only differencing media have parents. For base (non-differencing)
9067	media, @c null is returned.
9068	</desc>
9069	</attribute>
9070
9071	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9072	<desc>
9073	Children of this medium (all differencing media directly based
9074	on this medium). A @c null array is returned if this medium
9075	does not have any children.
9076	</desc>
9077	</attribute>
9078
9079	<attribute name="base" type="IMedium" readonly="yes">
9080	<desc>
9081	Base medium of this medium.
9082
9083	If this is a differencing medium, its base medium is the medium
9084	the given medium branch starts from. For all other types of media, this
9085	property returns the medium object itself (i.e. the same object this
9086	property is read on).
9087	</desc>
9088	</attribute>
9089
9090	<attribute name="readOnly" type="boolean" readonly="yes">
9091	<desc>
9092	Returns @c true if this medium is read-only and @c false otherwise.
9093
9094	A medium is considered to be read-only when its contents cannot be
9095	modified without breaking the integrity of other parties that depend on
9096	this medium such as its child media or snapshots of virtual machines
9097	where this medium is attached to these machines. If there are no
9098	children and no such snapshots then there is no dependency and the
9099	medium is not read-only.
9100
9101	The value of this attribute can be used to determine the kind of the
9102	attachment that will take place when attaching this medium to a
9103	virtual machine. If the value is @c false then the medium will
9104	be attached directly. If the value is @c true then the medium
9105	will be attached indirectly by creating a new differencing child
9106	medium for that. See the interface description for more information.
9107
9108	Note that all <link to="MediumType_Immutable">Immutable</link> media
9109	are always read-only while all
9110	<link to="MediumType_Writethrough">Writethrough</link> media are
9111	always not.
9112
9113	<note>
9114	The read-only condition represented by this attribute is related to
9115	the medium type and usage, not to the current
9116	<link to="IMedium::state">medium state</link> and not to the read-only
9117	state of the storage unit.
9118	</note>
9119	</desc>
9120	</attribute>
9121
9122	<attribute name="logicalSize" type="long long" readonly="yes">
9123	<desc>
9124	Logical size of this medium (in bytes), as reported to the
9125	guest OS running inside the virtual machine this medium is
9126	attached to. The logical size is defined when the medium is created
9127	and cannot be changed later.
9128
9129	<note>
9130	Reading this property on a differencing medium will return the size
9131	of its <link to="#base"/> medium.
9132	</note>
9133	<note>
9134	For media whose state is <link to="#state"/> is <link
9135	to="MediumState_Inaccessible"/>, the value of this property is the
9136	last known logical size. For <link to="MediumState_NotCreated"/>
9137	media, the returned value is zero.
9138	</note>
9139	</desc>
9140	</attribute>
9141
9142	<attribute name="autoReset" type="boolean">
9143	<desc>
9144	Whether this differencing medium will be automatically reset each
9145	time a virtual machine it is attached to is powered up. This
9146	attribute is automatically set to @c true for the last
9147	differencing image of an "immutable" medium (see
9148	<link to="MediumType" />).
9149
9150	See <link to="#reset"/> for more information about resetting
9151	differencing media.
9152
9153	<note>
9154	Reading this property on a base (non-differencing) medium will
9155	always @c false. Changing the value of this property in this
9156	case is not supported.
9157	</note>
9158
9159	<result name="VBOX_E_NOT_SUPPORTED">
9160	This is not a differencing medium (when changing the attribute
9161	value).
9162	</result>
9163	</desc>
9164	</attribute>
9165
9166	<attribute name="lastAccessError" type="wstring" readonly="yes">
9167	<desc>
9168	Text message that represents the result of the last accessibility
9169	check performed by <link to="#refreshState"/>.
9170
9171	An empty string is returned if the last accessibility check
9172	was successful or has not yet been called. As a result, if
9173	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9174	then <link to="#refreshState"/> has yet to be called; this is the
9175	default value of media after VirtualBox initialization.
9176	A non-empty string indicates a failure and should normally describe
9177	a reason of the failure (for example, a file read error).
9178	</desc>
9179	</attribute>
9180
9181	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9182	<desc>
9183	Array of UUIDs of all machines this medium is attached to.
9184
9185	A @c null array is returned if this medium is not attached to any
9186	machine or to any machine's snapshot.
9187
9188	<note>
9189	The returned array will include a machine even if this medium is not
9190	attached to that machine in the current state but attached to it in
9191	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9192	details.
9193	</note>
9194	</desc>
9195	</attribute>
9196
9197	<method name="setIDs">
9198	<desc>
9199	Changes the UUID and parent UUID for a hard disk medium.
9200	</desc>
9201	<param name="setImageId" type="boolean" dir="in">
9202	<desc>
9203	Select whether a new image UUID is set or not.
9204	</desc>
9205	</param>
9206	<param name="imageId" type="uuid" mod="string" dir="in">
9207	<desc>
9208	New UUID for the image. If an empty string is passed, then a new
9209	UUID is automatically created, provided that @a setImageId is @c true.
9210	Specifying a zero UUID is not allowed.
9211	</desc>
9212	</param>
9213	<param name="setParentId" type="boolean" dir="in">
9214	<desc>
9215	Select whether a new parent UUID is set or not.
9216	</desc>
9217	</param>
9218	<param name="parentId" type="uuid" mod="string" dir="in">
9219	<desc>
9220	New parent UUID for the image. If an empty string is passed, then a
9221	new UUID is automatically created, provided @a setParentId is
9222	@c true. A zero UUID is valid.
9223	</desc>
9224	</param>
9225	<result name="E_INVALIDARG">
9226	Invalid parameter combination.
9227	</result>
9228	<result name="VBOX_E_NOT_SUPPORTED">
9229	Medium is not a hard disk medium.
9230	</result>
9231	</method>
9232
9233	<method name="refreshState">
9234	<desc>
9235	If the current medium state (see <link to="MediumState"/>) is one of
9236	"Created", "Inaccessible" or "LockedRead", then this performs an
9237	accessibility check on the medium and sets the value of the <link to="#state"/>
9238	attribute accordingly; that value is also returned for convenience.
9239
9240	For all other state values, this does not perform a refresh but returns
9241	the state only.
9242
9243	The refresh, if performed, may take a long time (several seconds or even
9244	minutes, depending on the storage unit location and format) because it performs an
9245	accessibility check of the storage unit. This check may cause a significant
9246	delay if the storage unit of the given medium is, for example, a file located
9247	on a network share which is not currently accessible due to connectivity
9248	problems. In that case, the call will not return until a timeout
9249	interval defined by the host OS for this operation expires. For this reason,
9250	it is recommended to never read this attribute on the main UI thread to avoid
9251	making the UI unresponsive.
9252
9253	If the last known state of the medium is "Created" and the accessibility
9254	check fails, then the state would be set to "Inaccessible", and
9255	<link to="#lastAccessError"/> may be used to get more details about the
9256	failure. If the state of the medium is "LockedRead", then it remains the
9257	same, and a non-empty value of <link to="#lastAccessError"/> will
9258	indicate a failed accessibility check in this case.
9259
9260	Note that not all medium states are applicable to all medium types.
9261	</desc>
9262	<param name="state" type="MediumState" dir="return">
9263	<desc>
9264	New medium state.
9265	</desc>
9266	</param>
9267	</method>
9268
9269	<method name="getSnapshotIds">
9270	<desc>
9271	Returns an array of UUIDs of all snapshots of the given machine where
9272	this medium is attached to.
9273
9274	If the medium is attached to the machine in the current state, then the
9275	first element in the array will always be the ID of the queried machine
9276	(i.e. the value equal to the @c machineId argument), followed by
9277	snapshot IDs (if any).
9278
9279	If the medium is not attached to the machine in the current state, then
9280	the array will contain only snapshot IDs.
9281
9282	The returned array may be @c null if this medium is not attached
9283	to the given machine at all, neither in the current state nor in one of
9284	the snapshots.
9285	</desc>
9286	<param name="machineId" type="uuid" mod="string" dir="in">
9287	<desc>
9288	UUID of the machine to query.
9289	</desc>
9290	</param>
9291	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9292	<desc>
9293	Array of snapshot UUIDs of the given machine using this medium.
9294	</desc>
9295	</param>
9296	</method>
9297
9298	<method name="lockRead">
9299	<desc>
9300	Locks this medium for reading.
9301
9302	A read lock is shared: many clients can simultaneously lock the
9303	same medium for reading unless it is already locked for writing (see
9304	<link to="#lockWrite"/>) in which case an error is returned.
9305
9306	When the medium is locked for reading, it cannot be modified
9307	from within VirtualBox. This means that any method that changes
9308	the properties of this medium or contents of the storage unit
9309	will return an error (unless explicitly stated otherwise). That
9310	includes an attempt to start a virtual machine that wants to
9311	write to the the medium.
9312
9313	When the virtual machine is started up, it locks for reading all
9314	media it uses in read-only mode. If some medium cannot be locked
9315	for reading, the startup procedure will fail.
9316	A medium is typically locked for reading while it is used by a running
9317	virtual machine but has a depending differencing image that receives
9318	the actual write operations. This way one base medium can have
9319	multiple child differencing images which can be written to
9320	simultaneously. Read-only media such as DVD and floppy images are
9321	also locked for reading only (so they can be in use by multiple
9322	machines simultaneously).
9323
9324	A medium is also locked for reading when it is the source of a
9325	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9326
9327	The medium locked for reading must be unlocked using the <link
9328	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9329	can be nested and must be followed by the same number of paired
9330	<link to="#unlockRead"/> calls.
9331
9332	This method sets the medium state (see <link to="#state"/>) to
9333	"LockedRead" on success. The medium's previous state must be
9334	one of "Created", "Inaccessible" or "LockedRead".
9335
9336	Locking an inaccessible medium is not an error; this method performs
9337	a logical lock that prevents modifications of this medium through
9338	the VirtualBox API, not a physical file-system lock of the underlying
9339	storage unit.
9340
9341	This method returns the current state of the medium
9342	<i>before</i> the operation.
9343
9344	<result name="VBOX_E_INVALID_OBJECT_STATE">
9345	Invalid medium state (e.g. not created, locked, inaccessible,
9346	creating, deleting).
9347	</result>
9348
9349	</desc>
9350	<param name="state" type="MediumState" dir="return">
9351	<desc>
9352	State of the medium after the operation.
9353	</desc>
9354	</param>
9355	</method>
9356
9357	<method name="unlockRead">
9358	<desc>
9359	Cancels the read lock previously set by <link to="#lockRead"/>.
9360
9361	For both success and failure, this method returns the current state
9362	of the medium <i>after</i> the operation.
9363
9364	See <link to="#lockRead"/> for more details.
9365
9366	<result name="VBOX_E_INVALID_OBJECT_STATE">
9367	Medium not locked for reading.
9368	</result>
9369
9370	</desc>
9371	<param name="state" type="MediumState" dir="return">
9372	<desc>
9373	State of the medium after the operation.
9374	</desc>
9375	</param>
9376	</method>
9377
9378	<method name="lockWrite">
9379	<desc>
9380	Locks this medium for writing.
9381
9382	A write lock, as opposed to <link to="#lockRead"/>, is
9383	exclusive: there may be only one client holding a write lock,
9384	and there may be no read locks while the write lock is held.
9385	As a result, read-locking fails if a write lock is held, and
9386	write-locking fails if either a read or another write lock is held.
9387
9388	When a medium is locked for writing, it cannot be modified
9389	from within VirtualBox, and it is not guaranteed that the values
9390	of its properties are up-to-date. Any method that changes the
9391	properties of this medium or contents of the storage unit will
9392	return an error (unless explicitly stated otherwise).
9393
9394	When a virtual machine is started up, it locks for writing all
9395	media it uses to write data to. If any medium could not be locked
9396	for writing, the startup procedure will fail. If a medium has
9397	differencing images, then while the machine is running, only
9398	the last ("leaf") differencing image is locked for writing,
9399	whereas its parents are locked for reading only.
9400
9401	A medium is also locked for writing when it is the target of a
9402	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9403
9404	The medium locked for writing must be unlocked using the <link
9405	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9406
9407	This method sets the medium state (see <link to="#state"/>) to
9408	"LockedWrite" on success. The medium's previous state must be
9409	either "Created" or "Inaccessible".
9410
9411	Locking an inaccessible medium is not an error; this method performs
9412	a logical lock that prevents modifications of this medium through
9413	the VirtualBox API, not a physical file-system lock of the underlying
9414	storage unit.
9415
9416	For both, success and failure, this method returns the current
9417	state of the medium <i>before</i> the operation.
9418
9419	<result name="VBOX_E_INVALID_OBJECT_STATE">
9420	Invalid medium state (e.g. not created, locked, inaccessible,
9421	creating, deleting).
9422	</result>
9423
9424	</desc>
9425	<param name="state" type="MediumState" dir="return">
9426	<desc>
9427	State of the medium after the operation.
9428	</desc>
9429	</param>
9430	</method>
9431
9432	<method name="unlockWrite">
9433	<desc>
9434	Cancels the write lock previously set by <link to="#lockWrite"/>.
9435
9436	For both success and failure, this method returns the current
9437	state of the medium <i>after</i> the operation.
9438
9439	See <link to="#lockWrite"/> for more details.
9440
9441	<result name="VBOX_E_INVALID_OBJECT_STATE">
9442	Medium not locked for writing.
9443	</result>
9444
9445	</desc>
9446	<param name="state" type="MediumState" dir="return">
9447	<desc>
9448	State of the medium after the operation.
9449	</desc>
9450	</param>
9451	</method>
9452
9453	<method name="close">
9454	<desc>
9455	Closes this medium.
9456
9457	The medium must not be attached to any known virtual machine
9458	and must not have any known child media, otherwise the
9459	operation will fail.
9460
9461	When the medium is successfully closed, it is removed from
9462	the list of registered media, but its storage unit is not
9463	deleted. In particular, this means that this medium can
9464	later be opened again using the <link to="IVirtualBox::openMedium"/>
9465	call.
9466
9467	Note that after this method successfully returns, the given medium
9468	object becomes uninitialized. This means that any attempt
9469	to call any of its methods or attributes will fail with the
9470	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9471
9472	<result name="VBOX_E_INVALID_OBJECT_STATE">
9473	Invalid medium state (other than not created, created or
9474	inaccessible).
9475	</result>
9476	<result name="VBOX_E_OBJECT_IN_USE">
9477	Medium attached to virtual machine.
9478	</result>
9479	<result name="VBOX_E_FILE_ERROR">
9480	Settings file not accessible.
9481	</result>
9482	<result name="VBOX_E_XML_ERROR">
9483	Could not parse the settings file.
9484	</result>
9485
9486	</desc>
9487	</method>
9488
9489	<!-- storage methods -->
9490
9491	<method name="getProperty">
9492	<desc>
9493	Returns the value of the custom medium property with the given name.
9494
9495	The list of all properties supported by the given medium format can
9496	be obtained with <link to="IMediumFormat::describeProperties"/>.
9497
9498	Note that if this method returns an empty string in @a value, the
9499	requested property is supported but currently not assigned any value.
9500
9501	<result name="VBOX_E_OBJECT_NOT_FOUND">
9502	Requested property does not exist (not supported by the format).
9503	</result>
9504	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9505	</desc>
9506	<param name="name" type="wstring" dir="in">
9507	<desc>Name of the property to get.</desc>
9508	</param>
9509	<param name="value" type="wstring" dir="return">
9510	<desc>Current property value.</desc>
9511	</param>
9512	</method>
9513
9514	<method name="setProperty">
9515	<desc>
9516	Sets the value of the custom medium property with the given name.
9517
9518	The list of all properties supported by the given medium format can
9519	be obtained with <link to="IMediumFormat::describeProperties"/>.
9520
9521	Note that setting the property value to @c null or an empty string is
9522	equivalent to deleting the existing value. A default value (if it is
9523	defined for this property) will be used by the format backend in this
9524	case.
9525
9526	<result name="VBOX_E_OBJECT_NOT_FOUND">
9527	Requested property does not exist (not supported by the format).
9528	</result>
9529	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9530	</desc>
9531	<param name="name" type="wstring" dir="in">
9532	<desc>Name of the property to set.</desc>
9533	</param>
9534	<param name="value" type="wstring" dir="in">
9535	<desc>Property value to set.</desc>
9536	</param>
9537	</method>
9538
9539	<method name="getProperties">
9540	<desc>
9541	Returns values for a group of properties in one call.
9542
9543	The names of the properties to get are specified using the @a names
9544	argument which is a list of comma-separated property names or
9545	an empty string if all properties are to be returned. Note that currently
9546	the value of this argument is ignored and the method always returns all
9547	existing properties.
9548
9549	The list of all properties supported by the given medium format can
9550	be obtained with <link to="IMediumFormat::describeProperties"/>.
9551
9552	The method returns two arrays, the array of property names corresponding
9553	to the @a names argument and the current values of these properties.
9554	Both arrays have the same number of elements with each elemend at the
9555	given index in the first array corresponds to an element at the same
9556	index in the second array.
9557
9558	Note that for properties that do not have assigned values,
9559	an empty string is returned at the appropriate index in the
9560	@a returnValues array.
9561
9562	</desc>
9563	<param name="names" type="wstring" dir="in">
9564	<desc>
9565	Names of properties to get.
9566	</desc>
9567	</param>
9568	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9569	<desc>Names of returned properties.</desc>
9570	</param>
9571	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9572	<desc>Values of returned properties.</desc>
9573	</param>
9574	</method>
9575
9576	<method name="setProperties">
9577	<desc>
9578	Sets values for a group of properties in one call.
9579
9580	The names of the properties to set are passed in the @a names
9581	array along with the new values for them in the @a values array. Both
9582	arrays have the same number of elements with each elemend at the given
9583	index in the first array corresponding to an element at the same index
9584	in the second array.
9585
9586	If there is at least one property name in @a names that is not valid,
9587	the method will fail before changing the values of any other properties
9588	from the @a names array.
9589
9590	Using this method over <link to="#setProperty"/> is preferred if you
9591	need to set several properties at once since it will result into less
9592	IPC calls.
9593
9594	The list of all properties supported by the given medium format can
9595	be obtained with <link to="IMediumFormat::describeProperties"/>.
9596
9597	Note that setting the property value to @c null or an empty string is
9598	equivalent to deleting the existing value. A default value (if it is
9599	defined for this property) will be used by the format backend in this
9600	case.
9601	</desc>
9602	<param name="names" type="wstring" safearray="yes" dir="in">
9603	<desc>Names of properties to set.</desc>
9604	</param>
9605	<param name="values" type="wstring" safearray="yes" dir="in">
9606	<desc>Values of properties to set.</desc>
9607	</param>
9608	</method>
9609
9610	<!-- storage methods -->
9611
9612	<method name="createBaseStorage">
9613	<desc>
9614	Starts creating a hard disk storage unit (fixed/dynamic, according
9615	to the variant flags) in in the background. The previous storage unit
9616	created for this object, if any, must first be deleted using
9617	<link to="#deleteStorage"/>, otherwise the operation will fail.
9618
9619	Before the operation starts, the medium is placed in
9620	<link to="MediumState_Creating"/> state. If the create operation
9621	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9622	state.
9623
9624	After the returned progress object reports that the operation has
9625	successfully completed, the medium state will be set to <link
9626	to="MediumState_Created"/>, the medium will be remembered by this
9627	VirtualBox installation and may be attached to virtual machines.
9628
9629	<result name="VBOX_E_NOT_SUPPORTED">
9630	The variant of storage creation operation is not supported. See <link
9631	to="IMediumFormat::capabilities"/>.
9632	</result>
9633	</desc>
9634	<param name="logicalSize" type="long long" dir="in">
9635	<desc>Maximum logical size of the medium in bytes.</desc>
9636	</param>
9637	<param name="variant" type="MediumVariant" dir="in">
9638	<desc>Exact image variant which should be created.</desc>
9639	</param>
9640	<param name="progress" type="IProgress" dir="return">
9641	<desc>Progress object to track the operation completion.</desc>
9642	</param>
9643	</method>
9644
9645	<method name="deleteStorage">
9646	<desc>
9647	Starts deleting the storage unit of this medium.
9648
9649	The medium must not be attached to any known virtual machine and must
9650	not have any known child media, otherwise the operation will fail.
9651	It will also fail if there is no storage unit to delete or if deletion
9652	is already in progress, or if the medium is being in use (locked for
9653	read or for write) or inaccessible. Therefore, the only valid state for
9654	this operation to succeed is <link to="MediumState_Created"/>.
9655
9656	Before the operation starts, the medium is placed in
9657	<link to="MediumState_Deleting"/> state and gets removed from the list
9658	of remembered hard disks (media registry). If the delete operation
9659	fails, the medium will be remembered again and placed back to
9660	<link to="MediumState_Created"/> state.
9661
9662	After the returned progress object reports that the operation is
9663	complete, the medium state will be set to
9664	<link to="MediumState_NotCreated"/> and you will be able to use one of
9665	the storage creation methods to create it again.
9666
9667	<see>#close()</see>
9668
9669	<result name="VBOX_E_OBJECT_IN_USE">
9670	Medium is attached to a virtual machine.
9671	</result>
9672	<result name="VBOX_E_NOT_SUPPORTED">
9673	Storage deletion is not allowed because neither of storage creation
9674	operations are supported. See
9675	<link to="IMediumFormat::capabilities"/>.
9676	</result>
9677
9678	<note>
9679	If the deletion operation fails, it is not guaranteed that the storage
9680	unit still exists. You may check the <link to="IMedium::state"/> value
9681	to answer this question.
9682	</note>
9683	</desc>
9684	<param name="progress" type="IProgress" dir="return">
9685	<desc>Progress object to track the operation completion.</desc>
9686	</param>
9687	</method>
9688
9689	<!-- diff methods -->
9690
9691	<method name="createDiffStorage">
9692	<desc>
9693	Starts creating an empty differencing storage unit based on this
9694	medium in the format and at the location defined by the @a target
9695	argument.
9696
9697	The target medium must be in <link to="MediumState_NotCreated"/>
9698	state (i.e. must not have an existing storage unit). Upon successful
9699	completion, this operation will set the type of the target medium to
9700	<link to="MediumType_Normal"/> and create a storage unit necessary to
9701	represent the differencing medium data in the given format (according
9702	to the storage format of the target object).
9703
9704	After the returned progress object reports that the operation is
9705	successfully complete, the target medium gets remembered by this
9706	VirtualBox installation and may be attached to virtual machines.
9707
9708	<note>
9709	The medium will be set to <link to="MediumState_LockedRead"/>
9710	state for the duration of this operation.
9711	</note>
9712	<result name="VBOX_E_OBJECT_IN_USE">
9713	Medium not in @c NotCreated state.
9714	</result>
9715	</desc>
9716	<param name="target" type="IMedium" dir="in">
9717	<desc>Target medium.</desc>
9718	</param>
9719	<param name="variant" type="MediumVariant" dir="in">
9720	<desc>Exact image variant which should be created.</desc>
9721	</param>
9722	<param name="progress" type="IProgress" dir="return">
9723	<desc>Progress object to track the operation completion.</desc>
9724	</param>
9725	</method>
9726
9727	<method name="mergeTo">
9728	<desc>
9729	Starts merging the contents of this medium and all intermediate
9730	differencing media in the chain to the given target medium.
9731
9732	The target medium must be either a descendant of this medium or
9733	its ancestor (otherwise this method will immediately return a failure).
9734	It follows that there are two logical directions of the merge operation:
9735	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9736	ancestor (<i>backward merge</i>). Let us consider the following medium
9737	chain:
9738
9739	<pre>Base <- Diff_1 <- Diff_2</pre>
9740
9741	Here, calling this method on the <tt>Base</tt> medium object with
9742	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9743	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9744	merge. Note that in both cases the contents of the resulting medium
9745	will be the same, the only difference is the medium object that takes
9746	the result of the merge operation. In case of the forward merge in the
9747	above example, the result will be written to <tt>Diff_2</tt>; in case of
9748	the backward merge, the result will be written to <tt>Base</tt>. In
9749	other words, the result of the operation is always stored in the target
9750	medium.
9751
9752	Upon successful operation completion, the storage units of all media in
9753	the chain between this (source) medium and the target medium, including
9754	the source medium itself, will be automatically deleted and the
9755	relevant medium objects (including this medium) will become
9756	uninitialized. This means that any attempt to call any of
9757	their methods or attributes will fail with the
9758	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9759	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9760	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9761	Note that <tt>Diff_2</tt> in this case will become a base medium
9762	itself since it will no longer be based on any other medium.
9763
9764	Considering the above, all of the following conditions must be met in
9765	order for the merge operation to succeed:
9766	<ul>
9767	<li>
9768	Neither this (source) medium nor any intermediate
9769	differencing medium in the chain between it and the target
9770	medium is attached to any virtual machine.
9771	</li>
9772	<li>
9773	Neither the source medium nor the target medium is an
9774	<link to="MediumType_Immutable"/> medium.
9775	</li>
9776	<li>
9777	The part of the medium tree from the source medium to the
9778	target medium is a linear chain, i.e. all medium in this
9779	chain have exactly one child which is the next medium in this
9780	chain. The only exception from this rule is the target medium in
9781	the forward merge operation; it is allowed to have any number of
9782	child media because the merge operation will not change its
9783	logical contents (as it is seen by the guest OS or by children).
9784	</li>
9785	<li>
9786	None of the involved media are in
9787	<link to="MediumState_LockedRead"/> or
9788	<link to="MediumState_LockedWrite"/> state.
9789	</li>
9790	</ul>
9791
9792	<note>
9793	This (source) medium and all intermediates will be placed to <link
9794	to="MediumState_Deleting"/> state and the target medium will be
9795	placed to <link to="MediumState_LockedWrite"/> state and for the
9796	duration of this operation.
9797	</note>
9798	</desc>
9799	<param name="target" type="IMedium" dir="in">
9800	<desc>Target medium.</desc>
9801	</param>
9802	<param name="progress" type="IProgress" dir="return">
9803	<desc>Progress object to track the operation completion.</desc>
9804	</param>
9805	</method>
9806
9807	<!-- clone method -->
9808
9809	<method name="cloneTo">
9810	<desc>
9811	Starts creating a clone of this medium in the format and at the
9812	location defined by the @a target argument.
9813
9814	The target medium must be either in <link to="MediumState_NotCreated"/>
9815	state (i.e. must not have an existing storage unit) or in
9816	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9817	big enough to hold the data or else the copy will be partial). Upon
9818	successful completion, the cloned medium will contain exactly the
9819	same sector data as the medium being cloned, except that in the
9820	first case a new UUID for the clone will be randomly generated, and in
9821	the second case the UUID will remain unchanged.
9822
9823	The @a parent argument defines which medium will be the parent
9824	of the clone. Passing a @c null reference indicates that the clone will
9825	be a base image, i.e. completely independent. It is possible to specify
9826	an arbitrary medium for this parameter, including the parent of the
9827	medium which is being cloned. Even cloning to a child of the source
9828	medium is possible. Note that when cloning to an existing image, the
9829	@a parent irgument is ignored.
9830
9831	After the returned progress object reports that the operation is
9832	successfully complete, the target medium gets remembered by this
9833	VirtualBox installation and may be attached to virtual machines.
9834
9835	<note>
9836	This medium will be placed to <link to="MediumState_LockedRead"/>
9837	state for the duration of this operation.
9838	</note>
9839	<result name="E_NOTIMPL">
9840	The specified cloning variant is not supported at the moment.
9841	</result>
9842	</desc>
9843	<param name="target" type="IMedium" dir="in">
9844	<desc>Target medium.</desc>
9845	</param>
9846	<param name="variant" type="MediumVariant" dir="in">
9847	<desc>Exact image variant which should be created.</desc>
9848	</param>
9849	<param name="parent" type="IMedium" dir="in">
9850	<desc>Parent of the cloned medium.</desc>
9851	</param>
9852	<param name="progress" type="IProgress" dir="return">
9853	<desc>Progress object to track the operation completion.</desc>
9854	</param>
9855	</method>
9856
9857	<!-- other methods -->
9858
9859	<method name="compact">
9860	<desc>
9861	Starts compacting of this medium. This means that the medium is
9862	transformed into a possibly more compact storage representation.
9863	This potentially creates temporary images, which can require a
9864	substantial amount of additional disk space.
9865
9866	This medium will be placed to <link to="MediumState_LockedWrite"/>
9867	state and all its parent media (if any) will be placed to
9868	<link to="MediumState_LockedRead"/> state for the duration of this
9869	operation.
9870
9871	Please note that the results can be either returned straight away,
9872	or later as the result of the background operation via the object
9873	returned via the @a progress parameter.
9874
9875	<result name="VBOX_E_NOT_SUPPORTED">
9876	Medium format does not support compacting (but potentially
9877	needs it).
9878	</result>
9879	</desc>
9880	<param name="progress" type="IProgress" dir="return">
9881	<desc>Progress object to track the operation completion.</desc>
9882	</param>
9883	</method>
9884
9885	<method name="resize">
9886	<desc>
9887	Starts resizing this medium. This means that the nominal size of the
9888	medium is set to the new value. Both increasing and decreasing the
9889	size is possible, and there are no safety checks, since VirtualBox
9890	does not make any assumptions about the medium contents.
9891
9892	Resizing usually needs additional disk space, and possibly also
9893	some temporary disk space. Note that resize does not create a full
9894	temporary copy of the medium, so the additional disk space requirement
9895	is usually much lower than using the clone operation.
9896
9897	This medium will be placed to <link to="MediumState_LockedWrite"/>
9898	state for the duration of this operation.
9899
9900	Please note that the results can be either returned straight away,
9901	or later as the result of the background operation via the object
9902	returned via the @a progress parameter.
9903
9904	<result name="VBOX_E_NOT_SUPPORTED">
9905	Medium format does not support resizing.
9906	</result>
9907	</desc>
9908	<param name="logicalSize" type="long long" dir="in">
9909	<desc>New nominal capacity of the medium in bytes.</desc>
9910	</param>
9911	<param name="progress" type="IProgress" dir="return">
9912	<desc>Progress object to track the operation completion.</desc>
9913	</param>
9914	</method>
9915
9916	<method name="reset">
9917	<desc>
9918	Starts erasing the contents of this differencing medium.
9919
9920	This operation will reset the differencing medium to its initial
9921	state when it does not contain any sector data and any read operation is
9922	redirected to its parent medium. This automatically gets called
9923	during VM power-up for every medium whose <link to="#autoReset" />
9924	attribute is @c true.
9925
9926	The medium will be write-locked for the duration of this operation (see
9927	<link to="#lockWrite" />).
9928
9929	<result name="VBOX_E_NOT_SUPPORTED">
9930	This is not a differencing medium.
9931	</result>
9932	<result name="VBOX_E_INVALID_OBJECT_STATE">
9933	Medium is not in <link to="MediumState_Created"/> or
9934	<link to="MediumState_Inaccessible"/> state.
9935	</result>
9936	</desc>
9937	<param name="progress" type="IProgress" dir="return">
9938	<desc>Progress object to track the operation completion.</desc>
9939	</param>
9940	</method>
9941
9942	</interface>
9943
9944
9945	<!--
9946	// IMediumFormat
9947	/////////////////////////////////////////////////////////////////////////
9948	-->
9949
9950	<enum
9951	name="DataType"
9952	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9953	>
9954	<const name="Int32" value="0"/>
9955	<const name="Int8" value="1"/>
9956	<const name="String" value="2"/>
9957	</enum>
9958
9959	<enum
9960	name="DataFlags"
9961	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9962	>
9963	<const name="None" value="0x00"/>
9964	<const name="Mandatory" value="0x01"/>
9965	<const name="Expert" value="0x02"/>
9966	<const name="Array" value="0x04"/>
9967	<const name="FlagMask" value="0x07"/>
9968	</enum>
9969
9970	<enum
9971	name="MediumFormatCapabilities"
9972	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
9973	>
9974	<desc>
9975	Medium format capability flags.
9976	</desc>
9977
9978	<const name="Uuid" value="0x01">
9979	<desc>
9980	Supports UUIDs as expected by VirtualBox code.
9981	</desc>
9982	</const>
9983
9984	<const name="CreateFixed" value="0x02">
9985	<desc>
9986	Supports creating fixed size images, allocating all space instantly.
9987	</desc>
9988	</const>
9989
9990	<const name="CreateDynamic" value="0x04">
9991	<desc>
9992	Supports creating dynamically growing images, allocating space on
9993	demand.
9994	</desc>
9995	</const>
9996
9997	<const name="CreateSplit2G" value="0x08">
9998	<desc>
9999	Supports creating images split in chunks of a bit less than 2 GBytes.
10000	</desc>
10001	</const>
10002
10003	<const name="Differencing" value="0x10">
10004	<desc>
10005	Supports being used as a format for differencing media (see <link
10006	to="IMedium::createDiffStorage"/>).
10007	</desc>
10008	</const>
10009
10010	<const name="Asynchronous" value="0x20">
10011	<desc>
10012	Supports asynchronous I/O operations for at least some configurations.
10013	</desc>
10014	</const>
10015
10016	<const name="File" value="0x40">
10017	<desc>
10018	The format backend operates on files (the <link to="IMedium::location"/>
10019	attribute of the medium specifies a file used to store medium
10020	data; for a list of supported file extensions see
10021	<link to="IMediumFormat::fileExtensions"/>).
10022	</desc>
10023	</const>
10024
10025	<const name="Properties" value="0x80">
10026	<desc>
10027	The format backend uses the property interface to configure the storage
10028	location and properties (the <link to="IMediumFormat::describeProperties"/>
10029	method is used to get access to properties supported by the given medium format).
10030	</desc>
10031	</const>
10032
10033	<const name="TcpNetworking" value="0x100">
10034	<desc>
10035	The format backend uses the TCP networking interface for network access.
10036	</desc>
10037	</const>
10038
10039	<const name="VFS" value="0x200">
10040	<desc>
10041	The format backend supports virtual filesystem functionality.
10042	</desc>
10043	</const>
10044
10045	<const name="CapabilityMask" value="0x3FF"/>
10046	</enum>
10047
10048	<interface
10049	name="IMediumFormat" extends="$unknown"
10050	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10051	wsmap="managed"
10052	>
10053	<desc>
10054	The IMediumFormat interface represents a medium format.
10055
10056	Each medium format has an associated backend which is used to handle
10057	media stored in this format. This interface provides information
10058	about the properties of the associated backend.
10059
10060	Each medium format is identified by a string represented by the
10061	<link to="#id"/> attribute. This string is used in calls like
10062	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10063	format.
10064
10065	The list of all supported medium formats can be obtained using
10066	<link to="ISystemProperties::mediumFormats"/>.
10067
10068	<see>IMedium</see>
10069	</desc>
10070
10071	<attribute name="id" type="wstring" readonly="yes">
10072	<desc>
10073	Identifier of this format.
10074
10075	The format identifier is a non-@c null non-empty ASCII string. Note that
10076	this string is case-insensitive. This means that, for example, all of
10077	the following strings:
10078	<pre>
10079	"VDI"
10080	"vdi"
10081	"VdI"</pre>
10082	refer to the same medium format.
10083
10084	This string is used in methods of other interfaces where it is necessary
10085	to specify a medium format, such as
10086	<link to="IVirtualBox::createHardDisk"/>.
10087	</desc>
10088	</attribute>
10089
10090	<attribute name="name" type="wstring" readonly="yes">
10091	<desc>
10092	Human readable description of this format.
10093
10094	Mainly for use in file open dialogs.
10095	</desc>
10096	</attribute>
10097
10098	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10099	<desc>
10100	Array of strings containing the supported file extensions.
10101
10102	The first extension in the array is the extension preferred by the
10103	backend. It is recommended to use this extension when specifying a
10104	location of the storage unit for a new medium.
10105
10106	Note that some backends do not work on files, so this array may be
10107	empty.
10108
10109	<see>IMediumFormat::capabilities</see>
10110	</desc>
10111	</attribute>
10112
10113	<attribute name="capabilities" type="unsigned long" readonly="yes">
10114	<desc>
10115	Capabilities of the format as a set of bit flags.
10116
10117	For the meaning of individual capability flags see
10118	<link to="MediumFormatCapabilities"/>.
10119	</desc>
10120	</attribute>
10121
10122	<method name="describeProperties">
10123	<desc>
10124	Returns several arrays describing the properties supported by this
10125	format.
10126
10127	An element with the given index in each array describes one
10128	property. Thus, the number of elements in each returned array is the
10129	same and corresponds to the number of supported properties.
10130
10131	The returned arrays are filled in only if the
10132	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10133	All arguments must be non-@c null.
10134
10135	<see>DataType</see>
10136	<see>DataFlags</see>
10137	</desc>
10138
10139	<param name="names" type="wstring" safearray="yes" dir="out">
10140	<desc>Array of property names.</desc>
10141	</param>
10142	<param name="description" type="wstring" safearray="yes" dir="out">
10143	<desc>Array of property descriptions.</desc>
10144	</param>
10145	<param name="types" type="DataType" safearray="yes" dir="out">
10146	<desc>Array of property types.</desc>
10147	</param>
10148	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10149	<desc>Array of property flags.</desc>
10150	</param>
10151	<param name="defaults" type="wstring" safearray="yes" dir="out">
10152	<desc>Array of default property values.</desc>
10153	</param>
10154	</method>
10155
10156	</interface>
10157
10158
10159	<!--
10160	// IKeyboard
10161	/////////////////////////////////////////////////////////////////////////
10162	-->
10163
10164	<interface
10165	name="IKeyboard" extends="$unknown"
10166	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10167	wsmap="managed"
10168	>
10169	<desc>
10170	The IKeyboard interface represents the virtual machine's keyboard. Used
10171	in <link to="IConsole::keyboard"/>.
10172
10173	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10174	to the virtual machine.
10175
10176	</desc>
10177	<method name="putScancode">
10178	<desc>Sends a scancode to the keyboard.
10179
10180	<result name="VBOX_E_IPRT_ERROR">
10181	Could not send scan code to virtual keyboard.
10182	</result>
10183
10184	</desc>
10185	<param name="scancode" type="long" dir="in"/>
10186	</method>
10187
10188	<method name="putScancodes">
10189	<desc>Sends an array of scancodes to the keyboard.
10190
10191	<result name="VBOX_E_IPRT_ERROR">
10192	Could not send all scan codes to virtual keyboard.
10193	</result>
10194
10195	</desc>
10196	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10197	<param name="codesStored" type="unsigned long" dir="return"/>
10198	</method>
10199
10200	<method name="putCAD">
10201	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10202	function is nothing special, it is just a convenience function
10203	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10204
10205	<result name="VBOX_E_IPRT_ERROR">
10206	Could not send all scan codes to virtual keyboard.
10207	</result>
10208
10209	</desc>
10210	</method>
10211
10212	<attribute name="eventSource" type="IEventSource" readonly="yes">
10213	<desc>
10214	Event source for keyboard events.
10215	</desc>
10216	</attribute>
10217
10218	</interface>
10219
10220
10221	<!--
10222	// IMouse
10223	/////////////////////////////////////////////////////////////////////////
10224	-->
10225
10226	<enum
10227	name="MouseButtonState"
10228	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10229	>
10230	<desc>
10231	Mouse button state.
10232	</desc>
10233
10234	<const name="LeftButton" value="0x01"/>
10235	<const name="RightButton" value="0x02"/>
10236	<const name="MiddleButton" value="0x04"/>
10237	<const name="WheelUp" value="0x08"/>
10238	<const name="WheelDown" value="0x10"/>
10239	<const name="XButton1" value="0x20"/>
10240	<const name="XButton2" value="0x40"/>
10241	<const name="MouseStateMask" value="0x7F"/>
10242	</enum>
10243
10244	<interface
10245	name="IMouse" extends="$unknown"
10246	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10247	wsmap="managed"
10248	>
10249	<desc>
10250	The IMouse interface represents the virtual machine's mouse. Used in
10251	<link to="IConsole::mouse"/>.
10252
10253	Through this interface, the virtual machine's virtual mouse can be
10254	controlled.
10255	</desc>
10256
10257	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10258	<desc>
10259	Whether the guest OS supports absolute mouse pointer positioning
10260	or not.
10261	<note>
10262	You can use the <link to="IMouseCapabilityChangedEvent"/>
10263	event to be instantly informed about changes of this attribute
10264	during virtual machine execution.
10265	</note>
10266	<see><link to="#putMouseEventAbsolute"/></see>
10267	</desc>
10268	</attribute>
10269
10270	<attribute name="relativeSupported" type="boolean" readonly="yes">
10271	<desc>
10272	Whether the guest OS supports relative mouse pointer positioning
10273	or not.
10274	<note>
10275	You can use the <link to="IMouseCapabilityChangedEvent"/>
10276	event to be instantly informed about changes of this attribute
10277	during virtual machine execution.
10278	</note>
10279	<see><link to="#putMouseEvent"/></see>
10280	</desc>
10281	</attribute>
10282
10283	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10284	<desc>
10285	Whether the guest OS can currently switch to drawing it's own mouse
10286	cursor on demand.
10287	<note>
10288	You can use the <link to="IMouseCapabilityChangedEvent"/>
10289	event to be instantly informed about changes of this attribute
10290	during virtual machine execution.
10291	</note>
10292	<see><link to="#putMouseEvent"/></see>
10293	</desc>
10294	</attribute>
10295
10296	<method name="putMouseEvent">
10297	<desc>
10298	Initiates a mouse event using relative pointer movements
10299	along x and y axis.
10300
10301	<result name="E_ACCESSDENIED">
10302	Console not powered up.
10303	</result>
10304	<result name="VBOX_E_IPRT_ERROR">
10305	Could not send mouse event to virtual mouse.
10306	</result>
10307
10308	</desc>
10309
10310	<param name="dx" type="long" dir="in">
10311	<desc>
10312	Amount of pixels the mouse should move to the right.
10313	Negative values move the mouse to the left.
10314	</desc>
10315	</param>
10316	<param name="dy" type="long" dir="in">
10317	<desc>
10318	Amount of pixels the mouse should move downwards.
10319	Negative values move the mouse upwards.
10320	</desc>
10321	</param>
10322	<param name="dz" type="long" dir="in">
10323	<desc>
10324	Amount of mouse wheel moves.
10325	Positive values describe clockwise wheel rotations,
10326	negative values describe counterclockwise rotations.
10327	</desc>
10328	</param>
10329	<param name="dw" type="long" dir="in">
10330	<desc>
10331	Amount of horizontal mouse wheel moves.
10332	Positive values describe a movement to the left,
10333	negative values describe a movement to the right.
10334	</desc>
10335	</param>
10336	<param name="buttonState" type="long" dir="in">
10337	<desc>
10338	The current state of mouse buttons. Every bit represents
10339	a mouse button as follows:
10340	<table>
10341	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10342	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10343	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10344	</table>
10345	A value of <tt>1</tt> means the corresponding button is pressed.
10346	otherwise it is released.
10347	</desc>
10348	</param>
10349	</method>
10350
10351	<method name="putMouseEventAbsolute">
10352	<desc>
10353	Positions the mouse pointer using absolute x and y coordinates.
10354	These coordinates are expressed in pixels and
10355	start from <tt>[1,1]</tt> which corresponds to the top left
10356	corner of the virtual display.
10357
10358	<result name="E_ACCESSDENIED">
10359	Console not powered up.
10360	</result>
10361	<result name="VBOX_E_IPRT_ERROR">
10362	Could not send mouse event to virtual mouse.
10363	</result>
10364
10365	<note>
10366	This method will have effect only if absolute mouse
10367	positioning is supported by the guest OS.
10368	</note>
10369
10370	<see><link to="#absoluteSupported"/></see>
10371	</desc>
10372
10373	<param name="x" type="long" dir="in">
10374	<desc>
10375	X coordinate of the pointer in pixels, starting from @c 1.
10376	</desc>
10377	</param>
10378	<param name="y" type="long" dir="in">
10379	<desc>
10380	Y coordinate of the pointer in pixels, starting from @c 1.
10381	</desc>
10382	</param>
10383	<param name="dz" type="long" dir="in">
10384	<desc>
10385	Amount of mouse wheel moves.
10386	Positive values describe clockwise wheel rotations,
10387	negative values describe counterclockwise rotations.
10388	</desc>
10389	</param>
10390	<param name="dw" type="long" dir="in">
10391	<desc>
10392	Amount of horizontal mouse wheel moves.
10393	Positive values describe a movement to the left,
10394	negative values describe a movement to the right.
10395	</desc>
10396	</param>
10397	<param name="buttonState" type="long" dir="in">
10398	<desc>
10399	The current state of mouse buttons. Every bit represents
10400	a mouse button as follows:
10401	<table>
10402	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10403	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10404	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10405	</table>
10406	A value of @c 1 means the corresponding button is pressed.
10407	otherwise it is released.
10408	</desc>
10409	</param>
10410	</method>
10411
10412	<attribute name="eventSource" type="IEventSource" readonly="yes">
10413	<desc>
10414	Event source for mouse events.
10415	</desc>
10416	</attribute>
10417
10418	</interface>
10419
10420	<!--
10421	// IDisplay
10422	/////////////////////////////////////////////////////////////////////////
10423	-->
10424
10425	<enum
10426	name="FramebufferPixelFormat"
10427	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10428	>
10429	<desc>
10430	Format of the video memory buffer. Constants represented by this enum can
10431	be used to test for particular values of <link
10432	to="IFramebuffer::pixelFormat"/>. See also <link
10433	to="IFramebuffer::requestResize"/>.
10434
10435	See also www.fourcc.org for more information about FOURCC pixel formats.
10436	</desc>
10437
10438	<const name="Opaque" value="0">
10439	<desc>
10440	Unknown buffer format (the user may not assume any particular format of
10441	the buffer).
10442	</desc>
10443	</const>
10444	<const name="FOURCC_RGB" value="0x32424752">
10445	<desc>
10446	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10447	bit layout).
10448	</desc>
10449	</const>
10450	</enum>
10451
10452	<interface
10453	name="IFramebuffer" extends="$unknown"
10454	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10455	wsmap="suppress"
10456	>
10457	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10458	<desc>Address of the start byte of the frame buffer.</desc>
10459	</attribute>
10460
10461	<attribute name="width" type="unsigned long" readonly="yes">
10462	<desc>Frame buffer width, in pixels.</desc>
10463	</attribute>
10464
10465	<attribute name="height" type="unsigned long" readonly="yes">
10466	<desc>Frame buffer height, in pixels.</desc>
10467	</attribute>
10468
10469	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10470	<desc>
10471	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10472	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10473	are: 8, 15, 16, 24 and 32.
10474	</desc>
10475	</attribute>
10476
10477	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10478	<desc>
10479	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10480	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10481	size of the scan line must be aligned to 32 bits.
10482	</desc>
10483	</attribute>
10484
10485	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10486	<desc>
10487	Frame buffer pixel format. It's either one of the values defined by <link
10488	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10489	<note>
10490	This attribute must never return <link
10491	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10492	<link to="#address"/> points to must be always known.
10493	</note>
10494	</desc>
10495	</attribute>
10496
10497	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10498	<desc>
10499	Defines whether this frame buffer uses the virtual video card's memory
10500	buffer (guest VRAM) directly or not. See <link
10501	to="IFramebuffer::requestResize"/> for more information.
10502	</desc>
10503	</attribute>
10504
10505	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10506	<desc>
10507	Hint from the frame buffer about how much of the standard
10508	screen height it wants to use for itself. This information is
10509	exposed to the guest through the VESA BIOS and VMMDev interface
10510	so that it can use it for determining its video mode table. It
10511	is not guaranteed that the guest respects the value.
10512	</desc>
10513	</attribute>
10514
10515	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10516	<desc>
10517	An alpha-blended overlay which is superposed over the frame buffer.
10518	The initial purpose is to allow the display of icons providing
10519	information about the VM state, including disk activity, in front
10520	ends which do not have other means of doing that. The overlay is
10521	designed to controlled exclusively by IDisplay. It has no locking
10522	of its own, and any changes made to it are not guaranteed to be
10523	visible until the affected portion of IFramebuffer is updated. The
10524	overlay can be created lazily the first time it is requested. This
10525	attribute can also return @c null to signal that the overlay is not
10526	implemented.
10527	</desc>
10528	</attribute>
10529
10530	<attribute name="winId" type="long long" readonly="yes">
10531	<desc>
10532	Platform-dependent identifier of the window where context of this
10533	frame buffer is drawn, or zero if there's no such window.
10534	</desc>
10535	</attribute>
10536
10537	<method name="lock">
10538	<desc>
10539	Locks the frame buffer.
10540	Gets called by the IDisplay object where this frame buffer is
10541	bound to.
10542	</desc>
10543	</method>
10544
10545	<method name="unlock">
10546	<desc>
10547	Unlocks the frame buffer.
10548	Gets called by the IDisplay object where this frame buffer is
10549	bound to.
10550	</desc>
10551	</method>
10552
10553	<method name="notifyUpdate">
10554	<desc>
10555	Informs about an update.
10556	Gets called by the display object where this buffer is
10557	registered.
10558	</desc>
10559	<param name="x" type="unsigned long" dir="in"/>
10560	<param name="y" type="unsigned long" dir="in"/>
10561	<param name="width" type="unsigned long" dir="in"/>
10562	<param name="height" type="unsigned long" dir="in"/>
10563	</method>
10564
10565	<method name="requestResize">
10566	<desc>
10567	Requests a size and pixel format change.
10568
10569	There are two modes of working with the video buffer of the virtual
10570	machine. The <i>indirect</i> mode implies that the IFramebuffer
10571	implementation allocates a memory buffer for the requested display mode
10572	and provides it to the virtual machine. In <i>direct</i> mode, the
10573	IFramebuffer implementation uses the memory buffer allocated and owned
10574	by the virtual machine. This buffer represents the video memory of the
10575	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10576	usually faster because the implementation gets a raw pointer to the
10577	guest VRAM buffer which it can directly use for visualizing the contents
10578	of the virtual display, as opposed to the indirect mode where the
10579	contents of guest VRAM are copied to the memory buffer provided by
10580	the implementation every time a display update occurs.
10581
10582	It is important to note that the direct mode is really fast only when
10583	the implementation uses the given guest VRAM buffer directly, for
10584	example, by blitting it to the window representing the virtual machine's
10585	display, which saves at least one copy operation comparing to the
10586	indirect mode. However, using the guest VRAM buffer directly is not
10587	always possible: the format and the color depth of this buffer may be
10588	not supported by the target window, or it may be unknown (opaque) as in
10589	case of text or non-linear multi-plane VGA video modes. In this case,
10590	the indirect mode (that is always available) should be used as a
10591	fallback: when the guest VRAM contents are copied to the
10592	implementation-provided memory buffer, color and format conversion is
10593	done automatically by the underlying code.
10594
10595	The @a pixelFormat parameter defines whether the direct mode is
10596	available or not. If @a pixelFormat is <link
10597	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10598	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10599	@a bytesPerLine parameters must be ignored and the implementation must use
10600	the indirect mode (where it provides its own buffer in one of the
10601	supported formats). In all other cases, @a pixelFormat together with
10602	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10603	buffer pointed to by the @a VRAM parameter and the implementation is
10604	free to choose which mode to use. To indicate that this frame buffer uses
10605	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10606	attribute must return @c true and <link to="#address"/> must
10607	return exactly the same address that is passed in the @a VRAM parameter
10608	of this method; otherwise it is assumed that the indirect strategy is
10609	chosen.
10610
10611	The @a width and @a height parameters represent the size of the
10612	requested display mode in both modes. In case of indirect mode, the
10613	provided memory buffer should be big enough to store data of the given
10614	display mode. In case of direct mode, it is guaranteed that the given
10615	@a VRAM buffer contains enough space to represent the display mode of the
10616	given size. Note that this frame buffer's <link to="#width"/> and <link
10617	to="#height"/> attributes must return exactly the same values as
10618	passed to this method after the resize is completed (see below).
10619
10620	The @a finished output parameter determines if the implementation has
10621	finished resizing the frame buffer or not. If, for some reason, the
10622	resize cannot be finished immediately during this call, @a finished
10623	must be set to @c false, and the implementation must call
10624	<link to="IDisplay::resizeCompleted"/> after it has returned from
10625	this method as soon as possible. If @a finished is @c false, the
10626	machine will not call any frame buffer methods until
10627	<link to="IDisplay::resizeCompleted"/> is called.
10628
10629	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10630	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10631	this frame buffer must return exactly the same values as specified in the
10632	parameters of this method, after the resize is completed. If the
10633	indirect mode is chosen, these attributes must return values describing
10634	the format of the implementation's own memory buffer <link
10635	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10636	value must always correlate with <link to="#pixelFormat"/>. Note that
10637	the <link to="#pixelFormat"/> attribute must never return <link
10638	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10639
10640	<note>
10641	This method is called by the IDisplay object under the
10642	<link to="#lock"/> provided by this IFramebuffer
10643	implementation. If this method returns @c false in @a finished, then
10644	this lock is not released until
10645	<link to="IDisplay::resizeCompleted"/> is called.
10646	</note>
10647	</desc>
10648	<param name="screenId" type="unsigned long" dir="in">
10649	<desc>
10650	Logical screen number. Must be used in the corresponding call to
10651	<link to="IDisplay::resizeCompleted"/> if this call is made.
10652	</desc>
10653	</param>
10654	<param name="pixelFormat" type="unsigned long" dir="in">
10655	<desc>
10656	Pixel format of the memory buffer pointed to by @a VRAM.
10657	See also <link to="FramebufferPixelFormat"/>.
10658	</desc>
10659	</param>
10660	<param name="VRAM" type="octet" mod="ptr" dir="in">
10661	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10662	</param>
10663	<param name="bitsPerPixel" type="unsigned long" dir="in">
10664	<desc>Color depth, bits per pixel.</desc>
10665	</param>
10666	<param name="bytesPerLine" type="unsigned long" dir="in">
10667	<desc>Size of one scan line, in bytes.</desc>
10668	</param>
10669	<param name="width" type="unsigned long" dir="in">
10670	<desc>Width of the guest display, in pixels.</desc>
10671	</param>
10672	<param name="height" type="unsigned long" dir="in">
10673	<desc>Height of the guest display, in pixels.</desc>
10674	</param>
10675	<param name="finished" type="boolean" dir="return">
10676	<desc>
10677	Can the VM start using the new frame buffer immediately
10678	after this method returns or it should wait for
10679	<link to="IDisplay::resizeCompleted"/>.
10680	</desc>
10681	</param>
10682	</method>
10683
10684	<method name="videoModeSupported">
10685	<desc>
10686	Returns whether the frame buffer implementation is willing to
10687	support a given video mode. In case it is not able to render
10688	the video mode (or for some reason not willing), it should
10689	return @c false. Usually this method is called when the guest
10690	asks the VMM device whether a given video mode is supported
10691	so the information returned is directly exposed to the guest.
10692	It is important that this method returns very quickly.
10693	</desc>
10694	<param name="width" type="unsigned long" dir="in"/>
10695	<param name="height" type="unsigned long" dir="in"/>
10696	<param name="bpp" type="unsigned long" dir="in"/>
10697	<param name="supported" type="boolean" dir="return"/>
10698	</method>
10699
10700	<method name="getVisibleRegion">
10701	<desc>
10702	Returns the visible region of this frame buffer.
10703
10704	If the @a rectangles parameter is @c null then the value of the
10705	@a count parameter is ignored and the number of elements necessary to
10706	describe the current visible region is returned in @a countCopied.
10707
10708	If @a rectangles is not @c null but @a count is less
10709	than the required number of elements to store region data, the method
10710	will report a failure. If @a count is equal or greater than the
10711	required number of elements, then the actual number of elements copied
10712	to the provided array will be returned in @a countCopied.
10713
10714	<note>
10715	The address of the provided array must be in the process space of
10716	this IFramebuffer object.
10717	</note>
10718	<note>
10719	Method not yet implemented.
10720	</note>
10721	</desc>
10722	<param name="rectangles" type="octet" mod="ptr" dir="in">
10723	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10724	</param>
10725	<param name="count" type="unsigned long" dir="in">
10726	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10727	</param>
10728	<param name="countCopied" type="unsigned long" dir="return">
10729	<desc>Number of elements copied to the @a rectangles array.</desc>
10730	</param>
10731	</method>
10732
10733	<method name="setVisibleRegion">
10734	<desc>
10735	Suggests a new visible region to this frame buffer. This region
10736	represents the area of the VM display which is a union of regions of
10737	all top-level windows of the guest operating system running inside the
10738	VM (if the Guest Additions for this system support this
10739	functionality). This information may be used by the frontends to
10740	implement the seamless desktop integration feature.
10741
10742	<note>
10743	The address of the provided array must be in the process space of
10744	this IFramebuffer object.
10745	</note>
10746	<note>
10747	The IFramebuffer implementation must make a copy of the provided
10748	array of rectangles.
10749	</note>
10750	<note>
10751	Method not yet implemented.
10752	</note>
10753	</desc>
10754	<param name="rectangles" type="octet" mod="ptr" dir="in">
10755	<desc>Pointer to the @c RTRECT array.</desc>
10756	</param>
10757	<param name="count" type="unsigned long" dir="in">
10758	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10759	</param>
10760	</method>
10761
10762	<method name="processVHWACommand">
10763	<desc>
10764	Posts a Video HW Acceleration Command to the frame buffer for processing.
10765	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10766	are posted from quest to the host to be processed by the host hardware.
10767
10768	<note>
10769	The address of the provided command must be in the process space of
10770	this IFramebuffer object.
10771	</note>
10772	</desc>
10773
10774	<param name="command" type="octet" mod="ptr" dir="in">
10775	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10776	</param>
10777	</method>
10778
10779	</interface>
10780
10781	<interface
10782	name="IFramebufferOverlay" extends="IFramebuffer"
10783	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10784	wsmap="suppress"
10785	>
10786	<desc>
10787	The IFramebufferOverlay interface represents an alpha blended overlay
10788	for displaying status icons above an IFramebuffer. It is always created
10789	not visible, so that it must be explicitly shown. It only covers a
10790	portion of the IFramebuffer, determined by its width, height and
10791	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10792	that order) format, and may be written to directly. Do re-read the
10793	width though, after setting it, as it may be adjusted (increased) to
10794	make it more suitable for the front end.
10795	</desc>
10796	<attribute name="x" type="unsigned long" readonly="yes">
10797	<desc>X position of the overlay, relative to the frame buffer.</desc>
10798	</attribute>
10799
10800	<attribute name="y" type="unsigned long" readonly="yes">
10801	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10802	</attribute>
10803
10804	<attribute name="visible" type="boolean" readonly="no">
10805	<desc>
10806	Whether the overlay is currently visible.
10807	</desc>
10808	</attribute>
10809
10810	<attribute name="alpha" type="unsigned long" readonly="no">
10811	<desc>
10812	The global alpha value for the overlay. This may or may not be
10813	supported by a given front end.
10814	</desc>
10815	</attribute>
10816
10817	<method name="move">
10818	<desc>
10819	Changes the overlay's position relative to the IFramebuffer.
10820	</desc>
10821	<param name="x" type="unsigned long" dir="in"/>
10822	<param name="y" type="unsigned long" dir="in"/>
10823	</method>
10824
10825	</interface>
10826
10827	<interface
10828	name="IDisplay" extends="$unknown"
10829	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
10830	wsmap="managed"
10831	>
10832	<desc>
10833	The IDisplay interface represents the virtual machine's display.
10834
10835	The object implementing this interface is contained in each
10836	<link to="IConsole::display"/> attribute and represents the visual
10837	output of the virtual machine.
10838
10839	The virtual display supports pluggable output targets represented by the
10840	IFramebuffer interface. Examples of the output target are a window on
10841	the host computer or an RDP session's display on a remote computer.
10842	</desc>
10843	<method name="getScreenResolution">
10844	<desc>Queries display width, height and color depth for given screen.</desc>
10845	<param name="screenId" type="unsigned long" dir="in"/>
10846	<param name="width" type="unsigned long" dir="out"/>
10847	<param name="height" type="unsigned long" dir="out"/>
10848	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10849	</method>
10850
10851	<method name="setFramebuffer">
10852	<desc>
10853	Sets the framebuffer for given screen.
10854	</desc>
10855	<param name="screenId" type="unsigned long" dir="in"/>
10856	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10857	</method>
10858
10859	<method name="getFramebuffer">
10860	<desc>
10861	Queries the framebuffer for given screen.
10862	</desc>
10863	<param name="screenId" type="unsigned long" dir="in"/>
10864	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10865	<param name="xOrigin" type="long" dir="out"/>
10866	<param name="yOrigin" type="long" dir="out"/>
10867	</method>
10868
10869	<method name="setVideoModeHint">
10870	<desc>
10871	Asks VirtualBox to request the given video mode from
10872	the guest. This is just a hint and it cannot be guaranteed
10873	that the requested resolution will be used. Guest Additions
10874	are required for the request to be seen by guests. The caller
10875	should issue the request and wait for a resolution change and
10876	after a timeout retry.
10877
10878	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10879	parameters means that the corresponding values should be taken from the
10880	current video mode (i.e. left unchanged).
10881
10882	If the guest OS supports multi-monitor configuration then the @a display
10883	parameter specifies the number of the guest display to send the hint to:
10884	@c 0 is the primary display, @c 1 is the first secondary and
10885	so on. If the multi-monitor configuration is not supported, @a display
10886	must be @c 0.
10887
10888	<result name="E_INVALIDARG">
10889	The @a display is not associated with any monitor.
10890	</result>
10891
10892	</desc>
10893	<param name="width" type="unsigned long" dir="in"/>
10894	<param name="height" type="unsigned long" dir="in"/>
10895	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10896	<param name="display" type="unsigned long" dir="in"/>
10897	</method>
10898
10899	<method name="setSeamlessMode">
10900	<desc>
10901	Enables or disables seamless guest display rendering (seamless desktop
10902	integration) mode.
10903	<note>
10904	Calling this method has no effect if <link
10905	to="IGuest::supportsSeamless"/> returns @c false.
10906	</note>
10907	</desc>
10908	<param name="enabled" type="boolean" dir="in"/>
10909	</method>
10910
10911	<method name="takeScreenShot">
10912	<desc>
10913	Takes a screen shot of the requested size and copies it to the
10914	32-bpp buffer allocated by the caller and pointed to by @a address.
10915	A pixel consists of 4 bytes in order: B, G, R, 0.
10916
10917	<note>This API can be used only by the COM/XPCOM C++ API as it
10918	requires pointer support. Use <link to="#takeScreenShotToArray" />
10919	with other language bindings.
10920	</note>
10921
10922	<result name="E_NOTIMPL">
10923	Feature not implemented.
10924	</result>
10925	<result name="VBOX_E_IPRT_ERROR">
10926	Could not take a screenshot.
10927	</result>
10928
10929	</desc>
10930	<param name="screenId" type="unsigned long" dir="in"/>
10931	<param name="address" type="octet" mod="ptr" dir="in"/>
10932	<param name="width" type="unsigned long" dir="in"/>
10933	<param name="height" type="unsigned long" dir="in"/>
10934	</method>
10935
10936	<method name="takeScreenShotToArray">
10937	<desc>
10938	Takes a guest screen shot of the requested size and returns it as
10939	an array of bytes in uncompressed 32-bit RGBA format.
10940	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
10941
10942	This API is slow, but could be the only option to get guest screenshot
10943	for scriptable languages not allowed to manipulate with addresses
10944	directly.
10945
10946	<result name="E_NOTIMPL">
10947	Feature not implemented.
10948	</result>
10949	<result name="VBOX_E_IPRT_ERROR">
10950	Could not take a screenshot.
10951	</result>
10952	</desc>
10953	<param name="screenId" type="unsigned long" dir="in">
10954	<desc>
10955	Monitor to take screenshot from.
10956	</desc>
10957	</param>
10958	<param name="width" type="unsigned long" dir="in">
10959	<desc>
10960	Desired image width.
10961	</desc>
10962	</param>
10963	<param name="height" type="unsigned long" dir="in">
10964	<desc>
10965	Desired image height.
10966	</desc>
10967	</param>
10968	<param name="screenData" type="octet" dir="return" safearray="yes">
10969	<desc>
10970	Array with resulting screen data.
10971	</desc>
10972	</param>
10973	</method>
10974
10975	<method name="takeScreenShotPNGToArray">
10976	<desc>
10977	Takes a guest screen shot of the requested size and returns it as
10978	PNG image in array.
10979
10980	<result name="E_NOTIMPL">
10981	Feature not implemented.
10982	</result>
10983	<result name="VBOX_E_IPRT_ERROR">
10984	Could not take a screenshot.
10985	</result>
10986	</desc>
10987	<param name="screenId" type="unsigned long" dir="in">
10988	<desc>
10989	Monitor to take the screenshot from.
10990	</desc>
10991	</param>
10992	<param name="width" type="unsigned long" dir="in">
10993	<desc>
10994	Desired image width.
10995	</desc>
10996	</param>
10997	<param name="height" type="unsigned long" dir="in">
10998	<desc>
10999	Desired image height.
11000	</desc>
11001	</param>
11002	<param name="screenData" type="octet" dir="return" safearray="yes">
11003	<desc>
11004	Array with resulting screen data.
11005	</desc>
11006	</param>
11007	</method>
11008
11009	<method name="drawToScreen">
11010	<desc>
11011	Draws a 32-bpp image of the specified size from the given buffer
11012	to the given point on the VM display.
11013
11014	<result name="E_NOTIMPL">
11015	Feature not implemented.
11016	</result>
11017	<result name="VBOX_E_IPRT_ERROR">
11018	Could not draw to screen.
11019	</result>
11020
11021	</desc>
11022	<param name="screenId" type="unsigned long" dir="in">
11023	<desc>
11024	Monitor to take the screenshot from.
11025	</desc>
11026	</param>
11027	<param name="address" type="octet" mod="ptr" dir="in">
11028	<desc>
11029	Address to store the screenshot to
11030	</desc>
11031	</param>
11032	<param name="x" type="unsigned long" dir="in">
11033	<desc>
11034	Relative to the screen top left corner.
11035	</desc>
11036	</param>
11037	<param name="y" type="unsigned long" dir="in">
11038	<desc>
11039	Relative to the screen top left corner.
11040	</desc>
11041	</param>
11042	<param name="width" type="unsigned long" dir="in">
11043	<desc>
11044	Desired image width.
11045	</desc>
11046	</param>
11047	<param name="height" type="unsigned long" dir="in">
11048	<desc>
11049	Desired image height.
11050	</desc>
11051	</param>
11052	</method>
11053
11054	<method name="invalidateAndUpdate">
11055	<desc>
11056	Does a full invalidation of the VM display and instructs the VM
11057	to update it.
11058
11059	<result name="VBOX_E_IPRT_ERROR">
11060	Could not invalidate and update screen.
11061	</result>
11062
11063	</desc>
11064	</method>
11065
11066	<method name="resizeCompleted">
11067	<desc>
11068	Signals that a framebuffer has completed the resize operation.
11069
11070	<result name="VBOX_E_NOT_SUPPORTED">
11071	Operation only valid for external frame buffers.
11072	</result>
11073
11074	</desc>
11075	<param name="screenId" type="unsigned long" dir="in"/>
11076	</method>
11077
11078	<method name="completeVHWACommand">
11079	<desc>
11080	Signals that the Video HW Acceleration command has completed.
11081	</desc>
11082
11083	<param name="command" type="octet" mod="ptr" dir="in">
11084	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11085	</param>
11086	</method>
11087
11088	</interface>
11089
11090	<!--
11091	// INetworkAdapter
11092	/////////////////////////////////////////////////////////////////////////
11093	-->
11094
11095	<enum
11096	name="NetworkAttachmentType"
11097	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11098	>
11099	<desc>
11100	Network attachment type.
11101	</desc>
11102
11103	<const name="Null" value="0">
11104	<desc>Null value, also means "not attached".</desc>
11105	</const>
11106	<const name="NAT" value="1"/>
11107	<const name="Bridged" value="2"/>
11108	<const name="Internal" value="3"/>
11109	<const name="HostOnly" value="4"/>
11110	<const name="VDE" value="5"/>
11111	</enum>
11112
11113	<enum
11114	name="NetworkAdapterType"
11115	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11116	>
11117	<desc>
11118	Network adapter type.
11119	</desc>
11120
11121	<const name="Null" value="0">
11122	<desc>Null value (never used by the API).</desc>
11123	</const>
11124	<const name="Am79C970A" value="1">
11125	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11126	</const>
11127	<const name="Am79C973" value="2">
11128	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11129	</const>
11130	<const name="I82540EM" value="3">
11131	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11132	</const>
11133	<const name="I82543GC" value="4">
11134	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11135	</const>
11136	<const name="I82545EM" value="5">
11137	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11138	</const>
11139	<const name="Virtio" value="6">
11140	<desc>Virtio network device.</desc>
11141	</const>
11142	</enum>
11143
11144	<interface
11145	name="INetworkAdapter" extends="$unknown"
11146	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11147	wsmap="managed"
11148	>
11149	<desc>
11150	Represents a virtual network adapter that is attached to a virtual machine.
11151	Each virtual machine has a fixed number of network adapter slots with one
11152	instance of this attached to each of them. Call
11153	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11154	is attached to a given slot in a given machine.
11155
11156	Each network adapter can be in one of five attachment modes, which are
11157	represented by the <link to="NetworkAttachmentType" /> enumeration;
11158	see the <link to="#attachmentType" /> attribute.
11159	</desc>
11160
11161	<attribute name="adapterType" type="NetworkAdapterType">
11162	<desc>
11163	Type of the virtual network adapter. Depending on this value,
11164	VirtualBox will provide a different virtual network hardware
11165	to the guest.
11166	</desc>
11167	</attribute>
11168
11169	<attribute name="slot" type="unsigned long" readonly="yes">
11170	<desc>
11171	Slot number this adapter is plugged into. Corresponds to
11172	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11173	to obtain this instance.
11174	</desc>
11175	</attribute>
11176
11177	<attribute name="enabled" type="boolean">
11178	<desc>
11179	Flag whether the network adapter is present in the
11180	guest system. If disabled, the virtual guest hardware will
11181	not contain this network adapter. Can only be changed when
11182	the VM is not running.
11183	</desc>
11184	</attribute>
11185
11186	<attribute name="MACAddress" type="wstring">
11187	<desc>
11188	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11189	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11190	</desc>
11191	</attribute>
11192
11193	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11194
11195	<attribute name="hostInterface" type="wstring">
11196	<desc>
11197	Name of the host network interface the VM is attached to.
11198	</desc>
11199	</attribute>
11200
11201	<attribute name="internalNetwork" type="wstring">
11202	<desc>
11203	Name of the internal network the VM is attached to.
11204	</desc>
11205	</attribute>
11206
11207	<attribute name="NATNetwork" type="wstring">
11208	<desc>
11209	Name of the NAT network the VM is attached to.
11210	</desc>
11211	</attribute>
11212
11213	<attribute name="VDENetwork" type="wstring">
11214	<desc>
11215	Name of the VDE switch the VM is attached to.
11216	</desc>
11217	</attribute>
11218
11219	<attribute name="cableConnected" type="boolean">
11220	<desc>
11221	Flag whether the adapter reports the cable as connected or not.
11222	It can be used to report offline situations to a VM.
11223	</desc>
11224	</attribute>
11225
11226	<attribute name="lineSpeed" type="unsigned long">
11227	<desc>
11228	Line speed reported by custom drivers, in units of 1 kbps.
11229	</desc>
11230	</attribute>
11231
11232	<attribute name="traceEnabled" type="boolean">
11233	<desc>
11234	Flag whether network traffic from/to the network card should be traced.
11235	Can only be toggled when the VM is turned off.
11236	</desc>
11237	</attribute>
11238
11239	<attribute name="traceFile" type="wstring">
11240	<desc>
11241	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11242	will be used.
11243	</desc>
11244	</attribute>
11245
11246	<attribute name="natDriver" type="INATEngine" readonly="yes">
11247	<desc>
11248	Points to the NAT engine which handles the network address translation
11249	for this interface. This is active only when the interface actually uses
11250	NAT (see <link to="#attachToNAT" />).
11251	</desc>
11252	</attribute>
11253
11254	<attribute name="bootPriority" type="unsigned long">
11255	<desc>
11256	Network boot priority of the adapter. Priority 1 is highest. If not set,
11257	the priority is considered to be at the lowest possible setting.
11258	</desc>
11259	</attribute>
11260
11261	<attribute name="bandwidthLimit" type="unsigned long">
11262	<desc>
11263	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11264	A zero value means uncapped/unlimited.
11265	</desc>
11266	</attribute>
11267
11268	<method name="attachToNAT">
11269	<desc>
11270	Attach the network adapter to the Network Address Translation (NAT) interface.
11271	</desc>
11272	</method>
11273
11274	<method name="attachToBridgedInterface">
11275	<desc>
11276	Attach the network adapter to a bridged host interface.
11277	</desc>
11278	</method>
11279
11280	<method name="attachToInternalNetwork">
11281	<desc>
11282	Attach the network adapter to an internal network.
11283	</desc>
11284	</method>
11285
11286	<method name="attachToHostOnlyInterface">
11287	<desc>
11288	Attach the network adapter to the host-only network.
11289	</desc>
11290	</method>
11291
11292	<method name="attachToVDE">
11293	<desc>
11294	Attach the network adapter to a VDE network.
11295	</desc>
11296	</method>
11297
11298	<method name="detach">
11299	<desc>
11300	Detach the network adapter
11301	</desc>
11302	</method>
11303	</interface>
11304
11305
11306	<!--
11307	// ISerialPort
11308	/////////////////////////////////////////////////////////////////////////
11309	-->
11310
11311	<enum
11312	name="PortMode"
11313	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11314	>
11315	<desc>
11316	The PortMode enumeration represents possible communication modes for
11317	the virtual serial port device.
11318	</desc>
11319
11320	<const name="Disconnected" value="0">
11321	<desc>Virtual device is not attached to any real host device.</desc>
11322	</const>
11323	<const name="HostPipe" value="1">
11324	<desc>Virtual device is attached to a host pipe.</desc>
11325	</const>
11326	<const name="HostDevice" value="2">
11327	<desc>Virtual device is attached to a host device.</desc>
11328	</const>
11329	<const name="RawFile" value="3">
11330	<desc>Virtual device is attached to a raw file.</desc>
11331	</const>
11332	</enum>
11333
11334	<interface
11335	name="ISerialPort" extends="$unknown"
11336	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11337	wsmap="managed"
11338	>
11339
11340	<desc>
11341	The ISerialPort interface represents the virtual serial port device.
11342
11343	The virtual serial port device acts like an ordinary serial port
11344	inside the virtual machine. This device communicates to the real
11345	serial port hardware in one of two modes: host pipe or host device.
11346
11347	In host pipe mode, the #path attribute specifies the path to the pipe on
11348	the host computer that represents a serial port. The #server attribute
11349	determines if this pipe is created by the virtual machine process at
11350	machine startup or it must already exist before starting machine
11351	execution.
11352
11353	In host device mode, the #path attribute specifies the name of the
11354	serial port device on the host computer.
11355
11356	There is also a third communication mode: the disconnected mode. In this
11357	mode, the guest OS running inside the virtual machine will be able to
11358	detect the serial port, but all port write operations will be discarded
11359	and all port read operations will return no data.
11360
11361	<see>IMachine::getSerialPort</see>
11362	</desc>
11363
11364	<attribute name="slot" type="unsigned long" readonly="yes">
11365	<desc>
11366	Slot number this serial port is plugged into. Corresponds to
11367	the value you pass to <link to="IMachine::getSerialPort"/>
11368	to obtain this instance.
11369	</desc>
11370	</attribute>
11371
11372	<attribute name="enabled" type="boolean">
11373	<desc>
11374	Flag whether the serial port is enabled. If disabled,
11375	the serial port will not be reported to the guest OS.
11376	</desc>
11377	</attribute>
11378
11379	<attribute name="IOBase" type="unsigned long">
11380	<desc>Base I/O address of the serial port.</desc>
11381	</attribute>
11382
11383	<attribute name="IRQ" type="unsigned long">
11384	<desc>IRQ number of the serial port.</desc>
11385	</attribute>
11386
11387	<attribute name="hostMode" type="PortMode">
11388	<desc>
11389	How is this port connected to the host.
11390	<note>
11391	Changing this attribute may fail if the conditions for
11392	<link to="#path"/> are not met.
11393	</note>
11394	</desc>
11395	</attribute>
11396
11397	<attribute name="server" type="boolean">
11398	<desc>
11399	Flag whether this serial port acts as a server (creates a new pipe on
11400	the host) or as a client (uses the existing pipe). This attribute is
11401	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11402	</desc>
11403	</attribute>
11404
11405	<attribute name="path" type="wstring">
11406	<desc>
11407	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11408	PortMode_HostPipe, or the host serial device name when
11409	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11410	cases, setting a @c null or empty string as the attribute's value
11411	is an error. Otherwise, the value of this property is ignored.
11412	</desc>
11413	</attribute>
11414
11415	</interface>
11416
11417	<!--
11418	// IParallelPort
11419	/////////////////////////////////////////////////////////////////////////
11420	-->
11421
11422	<interface
11423	name="IParallelPort" extends="$unknown"
11424	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11425	wsmap="managed"
11426	>
11427
11428	<desc>
11429	The IParallelPort interface represents the virtual parallel port device.
11430
11431	The virtual parallel port device acts like an ordinary parallel port
11432	inside the virtual machine. This device communicates to the real
11433	parallel port hardware using the name of the parallel device on the host
11434	computer specified in the #path attribute.
11435
11436	Each virtual parallel port device is assigned a base I/O address and an
11437	IRQ number that will be reported to the guest operating system and used
11438	to operate the given parallel port from within the virtual machine.
11439
11440	<see>IMachine::getParallelPort</see>
11441	</desc>
11442
11443	<attribute name="slot" type="unsigned long" readonly="yes">
11444	<desc>
11445	Slot number this parallel port is plugged into. Corresponds to
11446	the value you pass to <link to="IMachine::getParallelPort"/>
11447	to obtain this instance.
11448	</desc>
11449	</attribute>
11450
11451	<attribute name="enabled" type="boolean">
11452	<desc>
11453	Flag whether the parallel port is enabled. If disabled,
11454	the parallel port will not be reported to the guest OS.
11455	</desc>
11456	</attribute>
11457
11458	<attribute name="IOBase" type="unsigned long">
11459	<desc>Base I/O address of the parallel port.</desc>
11460	</attribute>
11461
11462	<attribute name="IRQ" type="unsigned long">
11463	<desc>IRQ number of the parallel port.</desc>
11464	</attribute>
11465
11466	<attribute name="path" type="wstring">
11467	<desc>
11468	Host parallel device name. If this parallel port is enabled, setting a
11469	@c null or an empty string as this attribute's value will result into
11470	an error.
11471	</desc>
11472	</attribute>
11473
11474	</interface>
11475
11476
11477	<!--
11478	// IMachineDebugger
11479	/////////////////////////////////////////////////////////////////////////
11480	-->
11481
11482	<interface
11483	name="IMachineDebugger" extends="$unknown"
11484	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11485	wsmap="suppress"
11486	>
11487	<method name="resetStats">
11488	<desc>
11489	Reset VM statistics.
11490	</desc>
11491	<param name="pattern" type="wstring" dir="in">
11492	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11493	</param>
11494	</method>
11495
11496	<method name="dumpStats">
11497	<desc>
11498	Dumps VM statistics.
11499	</desc>
11500	<param name="pattern" type="wstring" dir="in">
11501	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11502	</param>
11503	</method>
11504
11505	<method name="getStats">
11506	<desc>
11507	Get the VM statistics in a XMLish format.
11508	</desc>
11509	<param name="pattern" type="wstring" dir="in">
11510	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11511	</param>
11512	<param name="withDescriptions" type="boolean" dir="in">
11513	<desc>Whether to include the descriptions.</desc>
11514	</param>
11515	<param name="stats" type="wstring" dir="out">
11516	<desc>The XML document containing the statistics.</desc>
11517	</param>
11518	</method>
11519
11520	<method name="injectNMI">
11521	<desc>
11522	Inject an NMI into a running VT-x/AMD-V VM.
11523	</desc>
11524	</method>
11525
11526	<attribute name="singlestep" type="boolean">
11527	<desc>Switch for enabling singlestepping.</desc>
11528	</attribute>
11529
11530	<attribute name="recompileUser" type="boolean">
11531	<desc>Switch for forcing code recompilation for user mode code.</desc>
11532	</attribute>
11533
11534	<attribute name="recompileSupervisor" type="boolean">
11535	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11536	</attribute>
11537
11538	<attribute name="PATMEnabled" type="boolean">
11539	<desc>Switch for enabling and disabling the PATM component.</desc>
11540	</attribute>
11541
11542	<attribute name="CSAMEnabled" type="boolean">
11543	<desc>Switch for enabling and disabling the CSAM component.</desc>
11544	</attribute>
11545
11546	<attribute name="logEnabled" type="boolean">
11547	<desc>Switch for enabling and disabling logging.</desc>
11548	</attribute>
11549
11550	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11551	<desc>
11552	Flag indicating whether the VM is currently making use of CPU hardware
11553	virtualization extensions.
11554	</desc>
11555	</attribute>
11556
11557	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11558	<desc>
11559	Flag indicating whether the VM is currently making use of the nested paging
11560	CPU hardware virtualization extension.
11561	</desc>
11562	</attribute>
11563
11564	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11565	<desc>
11566	Flag indicating whether the VM is currently making use of the VPID
11567	VT-x extension.
11568	</desc>
11569	</attribute>
11570
11571	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11572	<desc>
11573	Flag indicating whether the VM is currently making use of the Physical
11574	Address Extension CPU feature.
11575	</desc>
11576	</attribute>
11577
11578	<attribute name="virtualTimeRate" type="unsigned long">
11579	<desc>
11580	The rate at which the virtual time runs expressed as a percentage.
11581	The accepted range is 2% to 20000%.
11582	</desc>
11583	</attribute>
11584
11585	<!-- @todo method for setting log flags, groups and destination! -->
11586
11587	<attribute name="VM" type="long long" readonly="yes">
11588	<desc>
11589	Gets the VM handle. This is only for internal use while
11590	we carve the details of this interface.
11591	</desc>
11592	</attribute>
11593
11594	</interface>
11595
11596	<!--
11597	// IUSBController
11598	/////////////////////////////////////////////////////////////////////////
11599	-->
11600
11601	<interface
11602	name="IUSBController" extends="$unknown"
11603	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11604	wsmap="managed"
11605	>
11606	<attribute name="enabled" type="boolean">
11607	<desc>
11608	Flag whether the USB controller is present in the
11609	guest system. If disabled, the virtual guest hardware will
11610	not contain any USB controller. Can only be changed when
11611	the VM is powered off.
11612	</desc>
11613	</attribute>
11614
11615	<attribute name="enabledEhci" type="boolean">
11616	<desc>
11617	Flag whether the USB EHCI controller is present in the
11618	guest system. If disabled, the virtual guest hardware will
11619	not contain a USB EHCI controller. Can only be changed when
11620	the VM is powered off.
11621	</desc>
11622	</attribute>
11623
11624	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11625	<desc>
11626	Flag whether there is an USB proxy available.
11627	</desc>
11628	</attribute>
11629
11630	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11631	<desc>
11632	USB standard version which the controller implements.
11633	This is a BCD which means that the major version is in the
11634	high byte and minor version is in the low byte.
11635	</desc>
11636	</attribute>
11637
11638	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11639	<desc>
11640	List of USB device filters associated with the machine.
11641
11642	If the machine is currently running, these filters are activated
11643	every time a new (supported) USB device is attached to the host
11644	computer that was not ignored by global filters
11645	(<link to="IHost::USBDeviceFilters"/>).
11646
11647	These filters are also activated when the machine is powered up.
11648	They are run against a list of all currently available USB
11649	devices (in states
11650	<link to="USBDeviceState_Available"/>,
11651	<link to="USBDeviceState_Busy"/>,
11652	<link to="USBDeviceState_Held"/>) that were not previously
11653	ignored by global filters.
11654
11655	If at least one filter matches the USB device in question, this
11656	device is automatically captured (attached to) the virtual USB
11657	controller of this machine.
11658
11659	<see>IUSBDeviceFilter, ::IUSBController</see>
11660	</desc>
11661	</attribute>
11662
11663	<method name="createDeviceFilter">
11664	<desc>
11665	Creates a new USB device filter. All attributes except
11666	the filter name are set to empty (any match),
11667	<i>active</i> is @c false (the filter is not active).
11668
11669	The created filter can then be added to the list of filters using
11670	<link to="#insertDeviceFilter"/>.
11671
11672	<result name="VBOX_E_INVALID_VM_STATE">
11673	The virtual machine is not mutable.
11674	</result>
11675
11676	<see>#deviceFilters</see>
11677	</desc>
11678	<param name="name" type="wstring" dir="in">
11679	<desc>
11680	Filter name. See <link to="IUSBDeviceFilter::name"/>
11681	for more info.
11682	</desc>
11683	</param>
11684	<param name="filter" type="IUSBDeviceFilter" dir="return">
11685	<desc>Created filter object.</desc>
11686	</param>
11687	</method>
11688
11689	<method name="insertDeviceFilter">
11690	<desc>
11691	Inserts the given USB device to the specified position
11692	in the list of filters.
11693
11694	Positions are numbered starting from <tt>0</tt>. If the specified
11695	position is equal to or greater than the number of elements in
11696	the list, the filter is added to the end of the collection.
11697
11698	<note>
11699	Duplicates are not allowed, so an attempt to insert a
11700	filter that is already in the collection, will return an
11701	error.
11702	</note>
11703
11704	<result name="VBOX_E_INVALID_VM_STATE">
11705	Virtual machine is not mutable.
11706	</result>
11707	<result name="E_INVALIDARG">
11708	USB device filter not created within this VirtualBox instance.
11709	</result>
11710	<result name="VBOX_E_INVALID_OBJECT_STATE">
11711	USB device filter already in list.
11712	</result>
11713
11714	<see>#deviceFilters</see>
11715	</desc>
11716	<param name="position" type="unsigned long" dir="in">
11717	<desc>Position to insert the filter to.</desc>
11718	</param>
11719	<param name="filter" type="IUSBDeviceFilter" dir="in">
11720	<desc>USB device filter to insert.</desc>
11721	</param>
11722	</method>
11723
11724	<method name="removeDeviceFilter">
11725	<desc>
11726	Removes a USB device filter from the specified position in the
11727	list of filters.
11728
11729	Positions are numbered starting from <tt>0</tt>. Specifying a
11730	position equal to or greater than the number of elements in
11731	the list will produce an error.
11732
11733	<see>#deviceFilters</see>
11734
11735	<result name="VBOX_E_INVALID_VM_STATE">
11736	Virtual machine is not mutable.
11737	</result>
11738	<result name="E_INVALIDARG">
11739	USB device filter list empty or invalid @a position.
11740	</result>
11741
11742	</desc>
11743	<param name="position" type="unsigned long" dir="in">
11744	<desc>Position to remove the filter from.</desc>
11745	</param>
11746	<param name="filter" type="IUSBDeviceFilter" dir="return">
11747	<desc>Removed USB device filter.</desc>
11748	</param>
11749	</method>
11750
11751	</interface>
11752
11753
11754	<!--
11755	// IUSBDevice
11756	/////////////////////////////////////////////////////////////////////////
11757	-->
11758
11759	<interface
11760	name="IUSBDevice" extends="$unknown"
11761	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11762	wsmap="managed"
11763	>
11764	<desc>
11765	The IUSBDevice interface represents a virtual USB device attached to the
11766	virtual machine.
11767
11768	A collection of objects implementing this interface is stored in the
11769	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11770	attached to a running virtual machine's USB controller.
11771	</desc>
11772
11773	<attribute name="id" type="uuid" mod="string" readonly="yes">
11774	<desc>
11775	Unique USB device ID. This ID is built from #vendorId,
11776	#productId, #revision and #serialNumber.
11777	</desc>
11778	</attribute>
11779
11780	<attribute name="vendorId" type="unsigned short" readonly="yes">
11781	<desc>Vendor ID.</desc>
11782	</attribute>
11783
11784	<attribute name="productId" type="unsigned short" readonly="yes">
11785	<desc>Product ID.</desc>
11786	</attribute>
11787
11788	<attribute name="revision" type="unsigned short" readonly="yes">
11789	<desc>
11790	Product revision number. This is a packed BCD represented as
11791	unsigned short. The high byte is the integer part and the low
11792	byte is the decimal.
11793	</desc>
11794	</attribute>
11795
11796	<attribute name="manufacturer" type="wstring" readonly="yes">
11797	<desc>Manufacturer string.</desc>
11798	</attribute>
11799
11800	<attribute name="product" type="wstring" readonly="yes">
11801	<desc>Product string.</desc>
11802	</attribute>
11803
11804	<attribute name="serialNumber" type="wstring" readonly="yes">
11805	<desc>Serial number string.</desc>
11806	</attribute>
11807
11808	<attribute name="address" type="wstring" readonly="yes">
11809	<desc>Host specific address of the device.</desc>
11810	</attribute>
11811
11812	<attribute name="port" type="unsigned short" readonly="yes">
11813	<desc>
11814	Host USB port number the device is physically
11815	connected to.
11816	</desc>
11817	</attribute>
11818
11819	<attribute name="version" type="unsigned short" readonly="yes">
11820	<desc>
11821	The major USB version of the device - 1 or 2.
11822	</desc>
11823	</attribute>
11824
11825	<attribute name="portVersion" type="unsigned short" readonly="yes">
11826	<desc>
11827	The major USB version of the host USB port the device is
11828	physically connected to - 1 or 2. For devices not connected to
11829	anything this will have the same value as the version attribute.
11830	</desc>
11831	</attribute>
11832
11833	<attribute name="remote" type="boolean" readonly="yes">
11834	<desc>
11835	Whether the device is physically connected to a remote VRDP
11836	client or to a local host machine.
11837	</desc>
11838	</attribute>
11839
11840	</interface>
11841
11842
11843	<!--
11844	// IUSBDeviceFilter
11845	/////////////////////////////////////////////////////////////////////////
11846	-->
11847
11848	<interface
11849	name="IUSBDeviceFilter" extends="$unknown"
11850	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11851	wsmap="managed"
11852	>
11853	<desc>
11854	The IUSBDeviceFilter interface represents an USB device filter used
11855	to perform actions on a group of USB devices.
11856
11857	This type of filters is used by running virtual machines to
11858	automatically capture selected USB devices once they are physically
11859	attached to the host computer.
11860
11861	A USB device is matched to the given device filter if and only if all
11862	attributes of the device match the corresponding attributes of the
11863	filter (that is, attributes are joined together using the logical AND
11864	operation). On the other hand, all together, filters in the list of
11865	filters carry the semantics of the logical OR operation. So if it is
11866	desirable to create a match like "this vendor id OR this product id",
11867	one needs to create two filters and specify "any match" (see below)
11868	for unused attributes.
11869
11870	All filter attributes used for matching are strings. Each string
11871	is an expression representing a set of values of the corresponding
11872	device attribute, that will match the given filter. Currently, the
11873	following filtering expressions are supported:
11874
11875	<ul>
11876	<li><i>Interval filters</i>. Used to specify valid intervals for
11877	integer device attributes (Vendor ID, Product ID and Revision).
11878	The format of the string is:
11879
11880	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11881
11882	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11883	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11884	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11885	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11886	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11887	possible integer is assumed.
11888	</li>
11889	<li><i>Boolean filters</i>. Used to specify acceptable values for
11890	boolean device attributes. The format of the string is:
11891
11892	<tt>true\|false\|yes\|no\|0\|1</tt>
11893
11894	</li>
11895	<li><i>Exact match</i>. Used to specify a single value for the given
11896	device attribute. Any string that doesn't start with <tt>int:</tt>
11897	represents the exact match. String device attributes are compared to
11898	this string including case of symbols. Integer attributes are first
11899	converted to a string (see individual filter attributes) and then
11900	compared ignoring case.
11901
11902	</li>
11903	<li><i>Any match</i>. Any value of the corresponding device attribute
11904	will match the given filter. An empty or @c null string is
11905	used to construct this type of filtering expressions.
11906
11907	</li>
11908	</ul>
11909
11910	<note>
11911	On the Windows host platform, interval filters are not currently
11912	available. Also all string filter attributes
11913	(<link to="#manufacturer"/>, <link to="#product"/>,
11914	<link to="#serialNumber"/>) are ignored, so they behave as
11915	<i>any match</i> no matter what string expression is specified.
11916	</note>
11917
11918	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11919	</desc>
11920
11921	<attribute name="name" type="wstring">
11922	<desc>
11923	Visible name for this filter.
11924	This name is used to visually distinguish one filter from another,
11925	so it can neither be @c null nor an empty string.
11926	</desc>
11927	</attribute>
11928
11929	<attribute name="active" type="boolean">
11930	<desc>Whether this filter active or has been temporarily disabled.</desc>
11931	</attribute>
11932
11933	<attribute name="vendorId" type="wstring">
11934	<desc>
11935	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11936	The string representation for the <i>exact matching</i>
11937	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11938	(including leading zeroes).
11939	</desc>
11940	</attribute>
11941
11942	<attribute name="productId" type="wstring">
11943	<desc>
11944	<link to="IUSBDevice::productId">Product ID</link> filter.
11945	The string representation for the <i>exact matching</i>
11946	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11947	(including leading zeroes).
11948	</desc>
11949	</attribute>
11950
11951	<attribute name="revision" type="wstring">
11952	<desc>
11953	<link to="IUSBDevice::productId">Product revision number</link>
11954	filter. The string representation for the <i>exact matching</i>
11955	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11956	of the integer part of the revision, and <tt>F</tt> is the
11957	decimal digit of its fractional part (including leading and
11958	trailing zeros).
11959	Note that for interval filters, it's best to use the hexadecimal
11960	form, because the revision is stored as a 16 bit packed BCD value;
11961	so the expression <tt>int:0x0100-0x0199</tt> will match any
11962	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11963	</desc>
11964	</attribute>
11965
11966	<attribute name="manufacturer" type="wstring">
11967	<desc>
11968	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11969	</desc>
11970	</attribute>
11971
11972	<attribute name="product" type="wstring">
11973	<desc>
11974	<link to="IUSBDevice::product">Product</link> filter.
11975	</desc>
11976	</attribute>
11977
11978	<attribute name="serialNumber" type="wstring">
11979	<desc>
11980	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11981	</desc>
11982	</attribute>
11983
11984	<attribute name="port" type="wstring">
11985	<desc>
11986	<link to="IUSBDevice::port">Host USB port</link> filter.
11987	</desc>
11988	</attribute>
11989
11990	<attribute name="remote" type="wstring">
11991	<desc>
11992	<link to="IUSBDevice::remote">Remote state</link> filter.
11993	<note>
11994	This filter makes sense only for machine USB filters,
11995	i.e. it is ignored by IHostUSBDeviceFilter objects.
11996	</note>
11997	</desc>
11998	</attribute>
11999
12000	<attribute name="maskedInterfaces" type="unsigned long">
12001	<desc>
12002	This is an advanced option for hiding one or more USB interfaces
12003	from the guest. The value is a bit mask where the bits that are set
12004	means the corresponding USB interface should be hidden, masked off
12005	if you like.
12006	This feature only works on Linux hosts.
12007	</desc>
12008	</attribute>
12009
12010	</interface>
12011
12012
12013	<!--
12014	// IHostUSBDevice
12015	/////////////////////////////////////////////////////////////////////////
12016	-->
12017
12018	<enum
12019	name="USBDeviceState"
12020	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12021	>
12022	<desc>
12023	USB device state. This enumeration represents all possible states
12024	of the USB device physically attached to the host computer regarding
12025	its state on the host computer and availability to guest computers
12026	(all currently running virtual machines).
12027
12028	Once a supported USB device is attached to the host, global USB
12029	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12030	either ignore the device, or put it to USBDeviceState_Held state, or do
12031	nothing. Unless the device is ignored by global filters, filters of all
12032	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12033	activated that can put it to USBDeviceState_Captured state.
12034
12035	If the device was ignored by global filters, or didn't match
12036	any filters at all (including guest ones), it is handled by the host
12037	in a normal way. In this case, the device state is determined by
12038	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12039	or USBDeviceState_Available, depending on the current device usage.
12040
12041	Besides auto-capturing based on filters, the device can be manually
12042	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12043	state is USBDeviceState_Busy, USBDeviceState_Available or
12044	USBDeviceState_Held.
12045
12046	<note>
12047	Due to differences in USB stack implementations in Linux and Win32,
12048	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12049	only to the Linux version of the product. This also means that (<link
12050	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12051	device state is USBDeviceState_Held.
12052	</note>
12053
12054	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12055	</desc>
12056
12057	<const name="NotSupported" value="0">
12058	<desc>
12059	Not supported by the VirtualBox server, not available to guests.
12060	</desc>
12061	</const>
12062	<const name="Unavailable" value="1">
12063	<desc>
12064	Being used by the host computer exclusively,
12065	not available to guests.
12066	</desc>
12067	</const>
12068	<const name="Busy" value="2">
12069	<desc>
12070	Being used by the host computer, potentially available to guests.
12071	</desc>
12072	</const>
12073	<const name="Available" value="3">
12074	<desc>
12075	Not used by the host computer, available to guests (the host computer
12076	can also start using the device at any time).
12077	</desc>
12078	</const>
12079	<const name="Held" value="4">
12080	<desc>
12081	Held by the VirtualBox server (ignored by the host computer),
12082	available to guests.
12083	</desc>
12084	</const>
12085	<const name="Captured" value="5">
12086	<desc>
12087	Captured by one of the guest computers, not available
12088	to anybody else.
12089	</desc>
12090	</const>
12091	</enum>
12092
12093	<interface
12094	name="IHostUSBDevice" extends="IUSBDevice"
12095	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12096	wsmap="managed"
12097	>
12098	<desc>
12099	The IHostUSBDevice interface represents a physical USB device attached
12100	to the host computer.
12101
12102	Besides properties inherited from IUSBDevice, this interface adds the
12103	<link to="#state"/> property that holds the current state of the USB
12104	device.
12105
12106	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12107	</desc>
12108
12109	<attribute name="state" type="USBDeviceState" readonly="yes">
12110	<desc>
12111	Current state of the device.
12112	</desc>
12113	</attribute>
12114
12115	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12116
12117	</interface>
12118
12119
12120	<!--
12121	// IHostUSBDeviceFilter
12122	/////////////////////////////////////////////////////////////////////////
12123	-->
12124
12125	<enum
12126	name="USBDeviceFilterAction"
12127	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12128	>
12129	<desc>
12130	Actions for host USB device filters.
12131	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12132	</desc>
12133
12134	<const name="Null" value="0">
12135	<desc>Null value (never used by the API).</desc>
12136	</const>
12137	<const name="Ignore" value="1">
12138	<desc>Ignore the matched USB device.</desc>
12139	</const>
12140	<const name="Hold" value="2">
12141	<desc>Hold the matched USB device.</desc>
12142	</const>
12143	</enum>
12144
12145	<interface
12146	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12147	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12148	wsmap="managed"
12149	>
12150	<desc>
12151	The IHostUSBDeviceFilter interface represents a global filter for a
12152	physical USB device used by the host computer. Used indirectly in
12153	<link to="IHost::USBDeviceFilters"/>.
12154
12155	Using filters of this type, the host computer determines the initial
12156	state of the USB device after it is physically attached to the
12157	host's USB controller.
12158
12159	<note>
12160	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12161	filters, because it makes sense only for
12162	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12163	</note>
12164
12165	<see>IHost::USBDeviceFilters</see>
12166	</desc>
12167
12168	<attribute name="action" type="USBDeviceFilterAction">
12169	<desc>
12170	Action performed by the host when an attached USB device
12171	matches this filter.
12172	</desc>
12173	</attribute>
12174
12175	</interface>
12176
12177	<!--
12178	// IAudioAdapter
12179	/////////////////////////////////////////////////////////////////////////
12180	-->
12181
12182	<enum
12183	name="AudioDriverType"
12184	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12185	>
12186	<desc>
12187	Host audio driver type.
12188	</desc>
12189
12190	<const name="Null" value="0">
12191	<desc>Null value, also means "dummy audio driver".</desc>
12192	</const>
12193	<const name="WinMM" value="1">
12194	<desc>Windows multimedia (Windows hosts only).</desc>
12195	</const>
12196	<const name="OSS" value="2">
12197	<desc>Open Sound System (Linux hosts only).</desc>
12198	</const>
12199	<const name="ALSA" value="3">
12200	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12201	</const>
12202	<const name="DirectSound" value="4">
12203	<desc>DirectSound (Windows hosts only).</desc>
12204	</const>
12205	<const name="CoreAudio" value="5">
12206	<desc>CoreAudio (Mac hosts only).</desc>
12207	</const>
12208	<const name="MMPM" value="6">
12209	<desc>Reserved for historical reasons.</desc>
12210	</const>
12211	<const name="Pulse" value="7">
12212	<desc>PulseAudio (Linux hosts only).</desc>
12213	</const>
12214	<const name="SolAudio" value="8">
12215	<desc>Solaris audio (Solaris hosts only).</desc>
12216	</const>
12217	</enum>
12218
12219	<enum
12220	name="AudioControllerType"
12221	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12222	>
12223	<desc>
12224	Virtual audio controller type.
12225	</desc>
12226
12227	<const name="AC97" value="0"/>
12228	<const name="SB16" value="1"/>
12229	<const name="HDA" value="2"/>
12230	</enum>
12231
12232	<interface
12233	name="IAudioAdapter" extends="$unknown"
12234	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12235	wsmap="managed"
12236	>
12237	<desc>
12238	The IAudioAdapter interface represents the virtual audio adapter of
12239	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12240	</desc>
12241	<attribute name="enabled" type="boolean">
12242	<desc>
12243	Flag whether the audio adapter is present in the
12244	guest system. If disabled, the virtual guest hardware will
12245	not contain any audio adapter. Can only be changed when
12246	the VM is not running.
12247	</desc>
12248	</attribute>
12249	<attribute name="audioController" type="AudioControllerType">
12250	<desc>
12251	The audio hardware we emulate.
12252	</desc>
12253	</attribute>
12254	<attribute name="audioDriver" type="AudioDriverType">
12255	<desc>
12256	Audio driver the adapter is connected to. This setting
12257	can only be changed when the VM is not running.
12258	</desc>
12259	</attribute>
12260	</interface>
12261
12262	<!--
12263	// IVRDPServer
12264	/////////////////////////////////////////////////////////////////////////
12265	-->
12266
12267	<enum
12268	name="VRDPAuthType"
12269	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12270	>
12271	<desc>
12272	VRDP authentication type.
12273	</desc>
12274
12275	<const name="Null" value="0">
12276	<desc>Null value, also means "no authentication".</desc>
12277	</const>
12278	<const name="External" value="1"/>
12279	<const name="Guest" value="2"/>
12280	</enum>
12281
12282	<interface
12283	name="IVRDPServer" extends="$unknown"
12284	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12285	wsmap="managed"
12286	>
12287	<attribute name="enabled" type="boolean">
12288	<desc>VRDP server status.</desc>
12289	</attribute>
12290
12291	<attribute name="ports" type="wstring">
12292	<desc>
12293	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12294	<note>
12295	This is a string of comma separated TCP port numbers or port number ranges.
12296	Example <tt>5000,5010-5012,5015</tt>
12297	</note>
12298	</desc>
12299	</attribute>
12300
12301	<attribute name="netAddress" type="wstring">
12302	<desc>VRDP server address.</desc>
12303	</attribute>
12304
12305	<attribute name="authType" type="VRDPAuthType">
12306	<desc>VRDP authentication method.</desc>
12307	</attribute>
12308
12309	<attribute name="authTimeout" type="unsigned long">
12310	<desc>Timeout for guest authentication. Milliseconds.</desc>
12311	</attribute>
12312
12313	<attribute name="allowMultiConnection" type="boolean">
12314	<desc>
12315	Flag whether multiple simultaneous connections to the VM are permitted.
12316	Note that this will be replaced by a more powerful mechanism in the future.
12317	</desc>
12318	</attribute>
12319
12320	<attribute name="reuseSingleConnection" type="boolean">
12321	<desc>
12322	Flag whether the existing connection must be dropped and a new connection
12323	must be established by the VRDP server, when a new client connects in single
12324	connection mode.
12325	</desc>
12326	</attribute>
12327
12328	<attribute name="videoChannel" type="boolean">
12329	<desc>
12330	Flag whether RDP video channel is supported.
12331	</desc>
12332	</attribute>
12333
12334	<attribute name="videoChannelQuality" type="unsigned long">
12335	<desc>
12336	Image quality in percents.
12337	</desc>
12338	</attribute>
12339
12340	</interface>
12341
12342
12343	<!--
12344	// ISharedFolder
12345	/////////////////////////////////////////////////////////////////////////
12346	-->
12347
12348	<interface
12349	name="ISharedFolder" extends="$unknown"
12350	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12351	wsmap="struct"
12352	>
12353	<desc>
12354	The ISharedFolder interface represents a folder in the host computer's
12355	file system accessible from the guest OS running inside a virtual
12356	machine using an associated logical name.
12357
12358	There are three types of shared folders:
12359	<ul>
12360	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12361	folders available to all virtual machines.</li>
12362	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12363	VM-specific shared folders available to the given virtual machine at
12364	startup.</li>
12365	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12366	VM-specific shared folders created in the session context (for
12367	example, when the virtual machine is running) and automatically
12368	discarded when the session is closed (the VM is powered off).</li>
12369	</ul>
12370
12371	Logical names of shared folders must be unique within the given scope
12372	(global, permanent or transient). However, they do not need to be unique
12373	across scopes. In this case, the definition of the shared folder in a
12374	more specific scope takes precedence over definitions in all other
12375	scopes. The order of precedence is (more specific to more general):
12376	<ol>
12377	<li>Transient definitions</li>
12378	<li>Permanent definitions</li>
12379	<li>Global definitions</li>
12380	</ol>
12381
12382	For example, if MyMachine has a shared folder named
12383	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12384	transient shared folder named <tt>C_DRIVE</tt> (that points
12385	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12386	of <tt>C_DRIVE</tt> in the guest OS so
12387	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12388	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12389	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12390	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12391	to <tt>C:\\</tt> if it still exists.
12392
12393	Note that permanent and transient shared folders of different machines
12394	are in different name spaces, so they don't overlap and don't need to
12395	have unique logical names.
12396
12397	<note>
12398	Global shared folders are not implemented in the current version of the
12399	product.
12400	</note>
12401	</desc>
12402
12403	<attribute name="name" type="wstring" readonly="yes">
12404	<desc>Logical name of the shared folder.</desc>
12405	</attribute>
12406
12407	<attribute name="hostPath" type="wstring" readonly="yes">
12408	<desc>Full path to the shared folder in the host file system.</desc>
12409	</attribute>
12410
12411	<attribute name="accessible" type="boolean" readonly="yes">
12412	<desc>
12413	Whether the folder defined by the host path is currently
12414	accessible or not.
12415	For example, the folder can be unaccessible if it is placed
12416	on the network share that is not available by the time
12417	this property is read.
12418	</desc>
12419	</attribute>
12420
12421	<attribute name="writable" type="boolean" readonly="yes">
12422	<desc>
12423	Whether the folder defined by the host path is writable or
12424	not.
12425	</desc>
12426	</attribute>
12427
12428	<attribute name="autoMount" type="boolean" readonly="yes">
12429	<desc>
12430	Whether the folder gets automatically mounted by the guest or not.
12431	</desc>
12432	</attribute>
12433
12434	<attribute name="lastAccessError" type="wstring" readonly="yes">
12435	<desc>
12436	Text message that represents the result of the last accessibility
12437	check.
12438
12439	Accessibility checks are performed each time the <link to="#accessible"/>
12440	attribute is read. An empty string is returned if the last
12441	accessibility check was successful. A non-empty string indicates a
12442	failure and should normally describe a reason of the failure (for
12443	example, a file read error).
12444	</desc>
12445	</attribute>
12446
12447	</interface>
12448
12449	<!--
12450	// ISession
12451	/////////////////////////////////////////////////////////////////////////
12452	-->
12453
12454	<interface
12455	name="IInternalSessionControl" extends="$unknown"
12456	uuid="0431ef9e-2c2e-42af-87d7-c8f52455f28a"
12457	internal="yes"
12458	wsmap="suppress"
12459	>
12460	<method name="getPID">
12461	<desc>PID of the process that has created this Session object.
12462	</desc>
12463	<param name="pid" type="unsigned long" dir="return"/>
12464	</method>
12465
12466	<method name="getRemoteConsole">
12467	<desc>
12468	Returns the console object suitable for remote control.
12469
12470	<result name="VBOX_E_INVALID_VM_STATE">
12471	Session state prevents operation.
12472	</result>
12473	<result name="VBOX_E_INVALID_OBJECT_STATE">
12474	Session type prevents operation.
12475	</result>
12476
12477	</desc>
12478	<param name="console" type="IConsole" dir="return"/>
12479	</method>
12480
12481	<method name="assignMachine">
12482	<desc>
12483	Assigns the machine object associated with this direct-type
12484	session or informs the session that it will be a remote one
12485	(if @a machine == @c null).
12486
12487	<result name="VBOX_E_INVALID_VM_STATE">
12488	Session state prevents operation.
12489	</result>
12490	<result name="VBOX_E_INVALID_OBJECT_STATE">
12491	Session type prevents operation.
12492	</result>
12493
12494	</desc>
12495	<param name="machine" type="IMachine" dir="in"/>
12496	</method>
12497
12498	<method name="assignRemoteMachine">
12499	<desc>
12500	Assigns the machine and the (remote) console object associated with
12501	this remote-type session.
12502
12503	<result name="VBOX_E_INVALID_VM_STATE">
12504	Session state prevents operation.
12505	</result>
12506
12507	</desc>
12508	<param name="machine" type="IMachine" dir="in"/>
12509	<param name="console" type="IConsole" dir="in"/>
12510	</method>
12511
12512	<method name="updateMachineState">
12513	<desc>
12514	Updates the machine state in the VM process.
12515	Must be called only in certain cases
12516	(see the method implementation).
12517
12518	<result name="VBOX_E_INVALID_VM_STATE">
12519	Session state prevents operation.
12520	</result>
12521	<result name="VBOX_E_INVALID_OBJECT_STATE">
12522	Session type prevents operation.
12523	</result>
12524
12525	</desc>
12526	<param name="aMachineState" type="MachineState" dir="in"/>
12527	</method>
12528
12529	<method name="uninitialize">
12530	<desc>
12531	Uninitializes (closes) this session. Used by VirtualBox to close
12532	the corresponding remote session when the direct session dies
12533	or gets closed.
12534
12535	<result name="VBOX_E_INVALID_VM_STATE">
12536	Session state prevents operation.
12537	</result>
12538
12539	</desc>
12540	</method>
12541
12542	<method name="onNetworkAdapterChange">
12543	<desc>
12544	Triggered when settings of a network adapter of the
12545	associated virtual machine have changed.
12546
12547	<result name="VBOX_E_INVALID_VM_STATE">
12548	Session state prevents operation.
12549	</result>
12550	<result name="VBOX_E_INVALID_OBJECT_STATE">
12551	Session type prevents operation.
12552	</result>
12553
12554	</desc>
12555	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12556	<param name="changeAdapter" type="boolean" dir="in"/>
12557	</method>
12558
12559	<method name="onSerialPortChange">
12560	<desc>
12561	Triggered when settings of a serial port of the
12562	associated virtual machine have changed.
12563
12564	<result name="VBOX_E_INVALID_VM_STATE">
12565	Session state prevents operation.
12566	</result>
12567	<result name="VBOX_E_INVALID_OBJECT_STATE">
12568	Session type prevents operation.
12569	</result>
12570
12571	</desc>
12572	<param name="serialPort" type="ISerialPort" dir="in"/>
12573	</method>
12574
12575	<method name="onParallelPortChange">
12576	<desc>
12577	Triggered when settings of a parallel port of the
12578	associated virtual machine have changed.
12579
12580	<result name="VBOX_E_INVALID_VM_STATE">
12581	Session state prevents operation.
12582	</result>
12583	<result name="VBOX_E_INVALID_OBJECT_STATE">
12584	Session type prevents operation.
12585	</result>
12586
12587	</desc>
12588	<param name="parallelPort" type="IParallelPort" dir="in"/>
12589	</method>
12590
12591	<method name="onStorageControllerChange">
12592	<desc>
12593	Triggered when settings of a storage controller of the
12594	associated virtual machine have changed.
12595
12596	<result name="VBOX_E_INVALID_VM_STATE">
12597	Session state prevents operation.
12598	</result>
12599	<result name="VBOX_E_INVALID_OBJECT_STATE">
12600	Session type prevents operation.
12601	</result>
12602
12603	</desc>
12604	</method>
12605
12606	<method name="onMediumChange">
12607	<desc>
12608	Triggered when attached media of the
12609	associated virtual machine have changed.
12610
12611	<result name="VBOX_E_INVALID_VM_STATE">
12612	Session state prevents operation.
12613	</result>
12614	<result name="VBOX_E_INVALID_OBJECT_STATE">
12615	Session type prevents operation.
12616	</result>
12617
12618	</desc>
12619
12620	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12621	<param name="force" type="boolean" dir="in"/>
12622	</method>
12623
12624	<method name="onCPUChange">
12625	<desc>
12626	Notification when a CPU changes.
12627	</desc>
12628	<param name="cpu" type="unsigned long" dir="in">
12629	<desc>The CPU which changed</desc>
12630	</param>
12631	<param name="add" type="boolean" dir="in">
12632	<desc>Flag whether the CPU was added or removed</desc>
12633	</param>
12634	</method>
12635
12636	<method name="onCPUExecutionCapChange">
12637	<desc>
12638	Notification when the CPU execution cap changes.
12639	</desc>
12640	<param name="executionCap" type="unsigned long" dir="in">
12641	<desc>The new CPU execution cap value. (1-100)</desc>
12642	</param>
12643	</method>
12644
12645	<method name="onVRDPServerChange">
12646	<desc>
12647	Triggered when settings of the VRDP server object of the
12648	associated virtual machine have changed.
12649
12650	<result name="VBOX_E_INVALID_VM_STATE">
12651	Session state prevents operation.
12652	</result>
12653	<result name="VBOX_E_INVALID_OBJECT_STATE">
12654	Session type prevents operation.
12655	</result>
12656
12657	</desc>
12658	<param name="restart" type="boolean" dir="in">
12659	<desc>Flag whether the server must be restarted</desc>
12660	</param>
12661	</method>
12662
12663	<method name="onUSBControllerChange">
12664	<desc>
12665	Triggered when settings of the USB controller object of the
12666	associated virtual machine have changed.
12667
12668	<result name="VBOX_E_INVALID_VM_STATE">
12669	Session state prevents operation.
12670	</result>
12671	<result name="VBOX_E_INVALID_OBJECT_STATE">
12672	Session type prevents operation.
12673	</result>
12674
12675	</desc>
12676	</method>
12677
12678	<method name="onSharedFolderChange">
12679	<desc>
12680	Triggered when a permanent (global or machine) shared folder has been
12681	created or removed.
12682	<note>
12683	We don't pass shared folder parameters in this notification because
12684	the order in which parallel notifications are delivered is not defined,
12685	therefore it could happen that these parameters were outdated by the
12686	time of processing this notification.
12687	</note>
12688
12689	<result name="VBOX_E_INVALID_VM_STATE">
12690	Session state prevents operation.
12691	</result>
12692	<result name="VBOX_E_INVALID_OBJECT_STATE">
12693	Session type prevents operation.
12694	</result>
12695
12696	</desc>
12697	<param name="global" type="boolean" dir="in"/>
12698	</method>
12699
12700	<method name="onUSBDeviceAttach">
12701	<desc>
12702	Triggered when a request to capture a USB device (as a result
12703	of matched USB filters or direct call to
12704	<link to="IConsole::attachUSBDevice"/>) has completed.
12705	A @c null @a error object means success, otherwise it
12706	describes a failure.
12707
12708	<result name="VBOX_E_INVALID_VM_STATE">
12709	Session state prevents operation.
12710	</result>
12711	<result name="VBOX_E_INVALID_OBJECT_STATE">
12712	Session type prevents operation.
12713	</result>
12714
12715	</desc>
12716	<param name="device" type="IUSBDevice" dir="in"/>
12717	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12718	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12719	</method>
12720
12721	<method name="onUSBDeviceDetach">
12722	<desc>
12723	Triggered when a request to release the USB device (as a result
12724	of machine termination or direct call to
12725	<link to="IConsole::detachUSBDevice"/>) has completed.
12726	A @c null @a error object means success, otherwise it
12727	describes a failure.
12728
12729	<result name="VBOX_E_INVALID_VM_STATE">
12730	Session state prevents operation.
12731	</result>
12732	<result name="VBOX_E_INVALID_OBJECT_STATE">
12733	Session type prevents operation.
12734	</result>
12735
12736	</desc>
12737	<param name="id" type="uuid" mod="string" dir="in"/>
12738	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12739	</method>
12740
12741	<method name="onShowWindow">
12742	<desc>
12743	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12744	<link to="IMachine::showConsoleWindow"/> in order to notify
12745	console listeners
12746	<link to="ICanShowWindowEvent"/>
12747	and <link to="IShowWindowEvent"/>.
12748
12749	<result name="VBOX_E_INVALID_OBJECT_STATE">
12750	Session type prevents operation.
12751	</result>
12752
12753	</desc>
12754	<param name="check" type="boolean" dir="in"/>
12755	<param name="canShow" type="boolean" dir="out"/>
12756	<param name="winId" type="long long" dir="out"/>
12757	</method>
12758
12759	<method name="accessGuestProperty">
12760	<desc>
12761	Called by <link to="IMachine::getGuestProperty"/> and by
12762	<link to="IMachine::setGuestProperty"/> in order to read and
12763	modify guest properties.
12764
12765	<result name="VBOX_E_INVALID_VM_STATE">
12766	Machine session is not open.
12767	</result>
12768	<result name="VBOX_E_INVALID_OBJECT_STATE">
12769	Session type is not direct.
12770	</result>
12771
12772	</desc>
12773	<param name="name" type="wstring" dir="in"/>
12774	<param name="value" type="wstring" dir="in"/>
12775	<param name="flags" type="wstring" dir="in"/>
12776	<param name="isSetter" type="boolean" dir="in"/>
12777	<param name="retValue" type="wstring" dir="out"/>
12778	<param name="retTimestamp" type="long long" dir="out"/>
12779	<param name="retFlags" type="wstring" dir="out"/>
12780	</method>
12781
12782	<method name="enumerateGuestProperties">
12783	<desc>
12784	Return a list of the guest properties matching a set of patterns along
12785	with their values, time stamps and flags.
12786
12787	<result name="VBOX_E_INVALID_VM_STATE">
12788	Machine session is not open.
12789	</result>
12790	<result name="VBOX_E_INVALID_OBJECT_STATE">
12791	Session type is not direct.
12792	</result>
12793
12794	</desc>
12795	<param name="patterns" type="wstring" dir="in">
12796	<desc>
12797	The patterns to match the properties against as a comma-separated
12798	string. If this is empty, all properties currently set will be
12799	returned.
12800	</desc>
12801	</param>
12802	<param name="key" type="wstring" dir="out" safearray="yes">
12803	<desc>
12804	The key names of the properties returned.
12805	</desc>
12806	</param>
12807	<param name="value" type="wstring" dir="out" safearray="yes">
12808	<desc>
12809	The values of the properties returned. The array entries match the
12810	corresponding entries in the @a key array.
12811	</desc>
12812	</param>
12813	<param name="timestamp" type="long long" dir="out" safearray="yes">
12814	<desc>
12815	The time stamps of the properties returned. The array entries match
12816	the corresponding entries in the @a key array.
12817	</desc>
12818	</param>
12819	<param name="flags" type="wstring" dir="out" safearray="yes">
12820	<desc>
12821	The flags of the properties returned. The array entries match the
12822	corresponding entries in the @a key array.
12823	</desc>
12824	</param>
12825	</method>
12826
12827	<method name="onlineMergeMedium">
12828	<desc>
12829	Triggers online merging of a hard disk. Used internally when deleting
12830	a snapshot while a VM referring to the same hard disk chain is running.
12831
12832	<result name="VBOX_E_INVALID_VM_STATE">
12833	Machine session is not open.
12834	</result>
12835	<result name="VBOX_E_INVALID_OBJECT_STATE">
12836	Session type is not direct.
12837	</result>
12838
12839	</desc>
12840	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12841	<desc>The medium attachment to identify the medium chain.</desc>
12842	</param>
12843	<param name="sourceIdx" type="unsigned long" dir="in">
12844	<desc>The index of the source image in the chain.
12845	Redundant, but drastically reduces IPC.</desc>
12846	</param>
12847	<param name="targetIdx" type="unsigned long" dir="in">
12848	<desc>The index of the target image in the chain.
12849	Redundant, but drastically reduces IPC.</desc>
12850	</param>
12851	<param name="source" type="IMedium" dir="in">
12852	<desc>Merge source medium.</desc>
12853	</param>
12854	<param name="target" type="IMedium" dir="in">
12855	<desc>Merge target medium.</desc>
12856	</param>
12857	<param name="mergeForward" type="boolean" dir="in">
12858	<desc>Merge direction.</desc>
12859	</param>
12860	<param name="parentForTarget" type="IMedium" dir="in">
12861	<desc>For forward merges: new parent for target medium.</desc>
12862	</param>
12863	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12864	<desc>For backward merges: list of media which need their parent UUID
12865	updated.</desc>
12866	</param>
12867	<param name="progress" type="IProgress" dir="in">
12868	<desc>
12869	Progress object for this operation.
12870	</desc>
12871	</param>
12872	</method>
12873
12874	</interface>
12875
12876	<interface
12877	name="ISession" extends="$unknown"
12878	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12879	wsmap="managed"
12880	>
12881	<desc>
12882	The ISession interface represents a client process and allows for locking
12883	virtual machines (represented by IMachine objects) to prevent conflicting
12884	changes to the machine.
12885
12886	Any caller wishing to manipulate a virtual machine needs to create a session
12887	object first, which lives in its own process space. Such session objects are
12888	then associated with <link to="IMachine" /> objects living in the VirtualBox
12889	server process to coordinate such changes.
12890
12891	There are two typical scenarios in which sessions are used:
12892
12893	<ul>
12894	<li>To alter machine settings or control a running virtual machine, one
12895	needs to lock a machine for a given session (client process) by calling
12896	<link to="IMachine::lockMachine"/>.
12897
12898	Whereas multiple sessions may control a running virtual machine, only
12899	one process can obtain a write lock on the machine to prevent conflicting
12900	changes. A write lock is also needed if a process wants to actually run a
12901	virtual machine in its own context, such as the VirtualBox GUI or
12902	VBoxHeadless front-ends. They must also lock a machine for their own
12903	sessions before they are allowed to power up the virtual machine.
12904
12905	As a result, no machine settings can be altered while another process is
12906	already using it, either because that process is modifying machine settings
12907	or because the machine is running.
12908	</li>
12909	<li>
12910	To start a VM using one of the existing VirtualBox front-ends (e.g. the
12911	VirtualBox GUI or VBoxHeadless), one would use
12912	<link to="IMachine::launchVMProcess"/>, which also takes a session object
12913	as its first parameter. This session then identifies the caller and lets the
12914	caller control the started machine (for example, pause machine execution or
12915	power it down) as well as be notified about machine execution state changes.
12916	</li>
12917	</ul>
12918
12919	How sessions objects are created in a client process depends on whether you use
12920	the Main API via COM or via the webservice:
12921
12922	<ul>
12923	<li>When using the COM API directly, an object of the Session class from the
12924	VirtualBox type library needs to be created. In regular COM C++ client code,
12925	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12926	This object will then act as a local session object in further calls to open
12927	a session.
12928	</li>
12929
12930	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12931	a session object automatically whenever <link to="IWebsessionManager::logon" />
12932	is called. A managed object reference to that session object can be retrieved by
12933	calling <link to="IWebsessionManager::getSessionObject" />.
12934	</li>
12935	</ul>
12936	</desc>
12937
12938	<attribute name="state" type="SessionState" readonly="yes">
12939	<desc>Current state of this session.</desc>
12940	</attribute>
12941
12942	<attribute name="type" type="SessionType" readonly="yes">
12943	<desc>
12944	Type of this session. The value of this attribute is valid only
12945	if the session currently has a machine locked (i.e. its
12946	<link to="#state" /> is Locked), otherwise an error will be returned.
12947	</desc>
12948	</attribute>
12949
12950	<attribute name="machine" type="IMachine" readonly="yes">
12951	<desc>Machine object associated with this session.</desc>
12952	</attribute>
12953
12954	<attribute name="console" type="IConsole" readonly="yes">
12955	<desc>Console object associated with this session.</desc>
12956	</attribute>
12957
12958	<method name="unlockMachine">
12959	<desc>
12960	Unlocks a machine that was previously locked for the current session.
12961
12962	Calling this method is required every time a machine has been locked
12963	for a particular session using the <link to="IMachine::launchVMProcess" />
12964	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
12965	the machine will be set to <link to="MachineState_Aborted" /> on the
12966	server, and changes made to the machine settings will be lost.
12967
12968	Generally, it is recommended to unlock all machines explicitly
12969	before terminating the application (regardless of the reason for
12970	the termination).
12971
12972	<note>
12973	Do not expect the session state (<link to="ISession::state" />
12974	to return to "Unlocked" immediately after you invoke this method,
12975	particularly if you have started a new VM process. The session
12976	state will automatically return to "Unlocked" once the VM is no
12977	longer executing, which can of course take a very long time.
12978	</note>
12979
12980	<result name="E_UNEXPECTED">
12981	Session is not locked.
12982	</result>
12983
12984	</desc>
12985	</method>
12986
12987	</interface>
12988
12989	<!--
12990	// IStorageController
12991	/////////////////////////////////////////////////////////////////////////
12992	-->
12993
12994	<enum
12995	name="StorageBus"
12996	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12997	>
12998	<desc>
12999	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13000	see <link to="IStorageController::bus" />.
13001	</desc>
13002	<const name="Null" value="0">
13003	<desc>@c null value. Never used by the API.</desc>
13004	</const>
13005	<const name="IDE" value="1"/>
13006	<const name="SATA" value="2"/>
13007	<const name="SCSI" value="3"/>
13008	<const name="Floppy" value="4"/>
13009	<const name="SAS" value="5"/>
13010	</enum>
13011
13012	<enum
13013	name="StorageControllerType"
13014	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13015	>
13016	<desc>
13017	The exact variant of storage controller hardware presented
13018	to the guest; see <link to="IStorageController::controllerType" />.
13019	</desc>
13020
13021	<const name="Null" value="0">
13022	<desc>@c null value. Never used by the API.</desc>
13023	</const>
13024	<const name="LsiLogic" value="1">
13025	<desc>A SCSI controller of the LsiLogic variant.</desc>
13026	</const>
13027	<const name="BusLogic" value="2">
13028	<desc>A SCSI controller of the BusLogic variant.</desc>
13029	</const>
13030	<const name="IntelAhci" value="3">
13031	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13032	</const>
13033	<const name="PIIX3" value="4">
13034	<desc>An IDE controller of the PIIX3 variant.</desc>
13035	</const>
13036	<const name="PIIX4" value="5">
13037	<desc>An IDE controller of the PIIX4 variant.</desc>
13038	</const>
13039	<const name="ICH6" value="6">
13040	<desc>An IDE controller of the ICH6 variant.</desc>
13041	</const>
13042	<const name="I82078" value="7">
13043	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13044	</const>
13045	<const name="LsiLogicSas" value="8">
13046	<desc>A variant of the LsiLogic controller using SAS.</desc>
13047	</const>
13048	</enum>
13049
13050	<enum
13051	name="ChipsetType"
13052	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13053	>
13054	<desc>
13055	Type of emulated chipset (mostly southbridge).
13056	</desc>
13057
13058	<const name="Null" value="0">
13059	<desc>@c null value. Never used by the API.</desc>
13060	</const>
13061	<const name="PIIX3" value="1">
13062	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13063	</const>
13064	<const name="ICH9" value="2">
13065	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13066	</const>
13067	</enum>
13068
13069	<interface
13070	name="IStorageController" extends="$unknown"
13071	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13072	wsmap="managed"
13073	>
13074	<desc>
13075	Represents a storage controller that is attached to a virtual machine
13076	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13077	attached to storage controllers in a real computer, virtual drives
13078	(represented by <link to="IMediumAttachment" />) are attached to virtual
13079	storage controllers, represented by this interface.
13080
13081	As opposed to physical hardware, VirtualBox has a very generic concept
13082	of a storage controller, and for purposes of the Main API, all virtual
13083	storage is attached to virtual machines via instances of this interface.
13084	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13085	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13086	is used, certain sub-types may be available and can be selected in
13087	<link to="#controllerType" />.
13088
13089	Depending on these settings, the guest operating system might see
13090	significantly different virtual hardware.
13091	</desc>
13092
13093	<attribute name="name" type="wstring" readonly="yes">
13094	<desc>
13095	Name of the storage controller, as originally specified with
13096	<link to="IMachine::addStorageController" />. This then uniquely
13097	identifies this controller with other method calls such as
13098	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13099	</desc>
13100	</attribute>
13101
13102	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13103	<desc>
13104	Maximum number of devices which can be attached to one port.
13105	</desc>
13106	</attribute>
13107
13108	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13109	<desc>
13110	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13111	</desc>
13112	</attribute>
13113
13114	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13115	<desc>
13116	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13117	</desc>
13118	</attribute>
13119
13120	<attribute name="instance" type="unsigned long">
13121	<desc>
13122	The instance number of the device in the running VM.
13123	</desc>
13124	</attribute>
13125
13126	<attribute name="portCount" type="unsigned long">
13127	<desc>
13128	The number of currently usable ports on the controller.
13129	The minimum and maximum number of ports for one controller are
13130	stored in <link to="IStorageController::minPortCount"/>
13131	and <link to="IStorageController::maxPortCount"/>.
13132	</desc>
13133	</attribute>
13134
13135	<attribute name="bus" type="StorageBus" readonly="yes">
13136	<desc>
13137	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13138	</desc>
13139	</attribute>
13140
13141	<attribute name="controllerType" type="StorageControllerType">
13142	<desc>
13143	The exact variant of storage controller hardware presented
13144	to the guest.
13145	Depending on this value, VirtualBox will provide a different
13146	virtual storage controller hardware to the guest.
13147	For SATA, SAS and floppy controllers, only one variant is
13148	available, but for IDE and SCSI, there are several.
13149
13150	For SCSI controllers, the default type is LsiLogic.
13151	</desc>
13152	</attribute>
13153
13154	<attribute name="useHostIOCache" type="boolean">
13155	<desc>
13156	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13157	caches and use synchronous file APIs on the host. This was the only option in the API before
13158	VirtualBox 3.2 and is still the default for IDE controllers.
13159
13160	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13161	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13162	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13163	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13164	virtual machines are running at the same time to prevent I/O cache related hangs.
13165	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13166	</desc>
13167	</attribute>
13168
13169	<method name="getIDEEmulationPort">
13170	<desc>
13171	Gets the corresponding port number which is emulated as an IDE device.
13172	Works only with SATA controllers.
13173
13174	<result name="E_INVALIDARG">
13175	The @a devicePosition is not in the range 0 to 3.
13176	</result>
13177	<result name="E_NOTIMPL">
13178	The storage controller type is not SATAIntelAhci.
13179	</result>
13180
13181	</desc>
13182	<param name="devicePosition" type="long" dir="in"/>
13183	<param name="portNumber" type="long" dir="return"/>
13184	</method>
13185
13186	<method name="setIDEEmulationPort">
13187	<desc>
13188	Sets the port number which is emulated as an IDE device.
13189	Works only with SATA controllers.
13190
13191	<result name="E_INVALIDARG">
13192	The @a devicePosition is not in the range 0 to 3 or the
13193	@a portNumber is not in the range 0 to 29.
13194	</result>
13195	<result name="E_NOTIMPL">
13196	The storage controller type is not SATAIntelAhci.
13197	</result>
13198
13199	</desc>
13200	<param name="devicePosition" type="long" dir="in"/>
13201	<param name="portNumber" type="long" dir="in"/>
13202	</method>
13203
13204	</interface>
13205
13206	<if target="wsdl">
13207
13208	<!--
13209	// IManagedObjectRef
13210	/////////////////////////////////////////////////////////////////////////
13211	-->
13212
13213	<interface
13214	name="IManagedObjectRef" extends="$unknown"
13215	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13216	internal="yes"
13217	wsmap="managed"
13218	wscpp="hardcoded"
13219	>
13220	<desc>
13221	Managed object reference.
13222
13223	Only within the webservice, a managed object reference (which is really
13224	an opaque number) allows a webservice client to address an object
13225	that lives in the address space of the webservice server.
13226
13227	Behind each managed object reference, there is a COM object that lives
13228	in the webservice server's address space. The COM object is not freed
13229	until the managed object reference is released, either by an explicit
13230	call to <link to="IManagedObjectRef::release" /> or by logging off from
13231	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13232	all objects created during the webservice session.
13233
13234	Whenever a method call of the VirtualBox API returns a COM object, the
13235	webservice representation of that method will instead return a
13236	managed object reference, which can then be used to invoke methods
13237	on that object.
13238	</desc>
13239
13240	<method name="getInterfaceName">
13241	<desc>
13242	Returns the name of the interface that this managed object represents,
13243	for example, "IMachine", as a string.
13244	</desc>
13245	<param name="return" type="wstring" dir="return"/>
13246	</method>
13247
13248	<method name="release">
13249	<desc>
13250	Releases this managed object reference and frees the resources that
13251	were allocated for it in the webservice server process. After calling
13252	this method, the identifier of the reference can no longer be used.
13253	</desc>
13254	</method>
13255
13256	</interface>
13257
13258	<!--
13259	// IWebsessionManager
13260	/////////////////////////////////////////////////////////////////////////
13261	-->
13262
13263	<interface
13264	name="IWebsessionManager" extends="$unknown"
13265	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13266	internal="yes"
13267	wsmap="global"
13268	wscpp="hardcoded"
13269	>
13270	<desc>
13271	Websession manager. This provides essential services
13272	to webservice clients.
13273	</desc>
13274	<method name="logon">
13275	<desc>
13276	Logs a new client onto the webservice and returns a managed object reference to
13277	the IVirtualBox instance, which the client can then use as a basis to further
13278	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13279	interface, in one way or the other.
13280	</desc>
13281	<param name="username" type="wstring" dir="in"/>
13282	<param name="password" type="wstring" dir="in"/>
13283	<param name="return" type="IVirtualBox" dir="return"/>
13284	</method>
13285
13286	<method name="getSessionObject">
13287	<desc>
13288	Returns a managed object reference to the internal ISession object that was created
13289	for this web service session when the client logged on.
13290
13291	<see>ISession</see>
13292	</desc>
13293	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13294	<param name="return" type="ISession" dir="return"/>
13295	</method>
13296
13297	<method name="logoff">
13298	<desc>
13299	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13300	and destroys all resources associated with the session (most importantly, all
13301	managed objects created in the server while the session was active).
13302	</desc>
13303	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13304	</method>
13305
13306	</interface>
13307
13308	</if>
13309
13310	<!--
13311	// IPerformanceCollector & friends
13312	/////////////////////////////////////////////////////////////////////////
13313	-->
13314
13315	<interface
13316	name="IPerformanceMetric" extends="$unknown"
13317	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13318	>
13319	<desc>
13320	The IPerformanceMetric interface represents parameters of the given
13321	performance metric.
13322	</desc>
13323
13324	<attribute name="metricName" type="wstring" readonly="yes">
13325	<desc>
13326	Name of the metric.
13327	</desc>
13328	</attribute>
13329
13330	<attribute name="object" type="$unknown" readonly="yes">
13331	<desc>
13332	Object this metric belongs to.
13333	</desc>
13334	</attribute>
13335
13336	<attribute name="description" type="wstring" readonly="yes">
13337	<desc>
13338	Textual description of the metric.
13339	</desc>
13340	</attribute>
13341
13342	<attribute name="period" type="unsigned long" readonly="yes">
13343	<desc>
13344	Time interval between samples, measured in seconds.
13345	</desc>
13346	</attribute>
13347
13348	<attribute name="count" type="unsigned long" readonly="yes">
13349	<desc>
13350	Number of recent samples retained by the performance collector for this
13351	metric.
13352
13353	When the collected sample count exceeds this number, older samples
13354	are discarded.
13355	</desc>
13356	</attribute>
13357
13358	<attribute name="unit" type="wstring" readonly="yes">
13359	<desc>
13360	Unit of measurement.
13361	</desc>
13362	</attribute>
13363
13364	<attribute name="minimumValue" type="long" readonly="yes">
13365	<desc>
13366	Minimum possible value of this metric.
13367	</desc>
13368	</attribute>
13369
13370	<attribute name="maximumValue" type="long" readonly="yes">
13371	<desc>
13372	Maximum possible value of this metric.
13373	</desc>
13374	</attribute>
13375	</interface>
13376
13377	<interface
13378	name="IPerformanceCollector" extends="$unknown"
13379	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13380	wsmap="managed"
13381	>
13382	<desc>
13383	The IPerformanceCollector interface represents a service that collects
13384	and stores performance metrics data.
13385
13386	Performance metrics are associated with objects of interfaces like IHost
13387	and IMachine. Each object has a distinct set of performance metrics. The
13388	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13389
13390	Metric data is collected at the specified intervals and is retained
13391	internally. The interval and the number of retained samples can be set
13392	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13393	and collection settings are not persistent, they are discarded as soon as
13394	VBoxSVC process terminates. Moreover, metric settings and data associated
13395	with a particular VM only exist while VM is running. They disappear as
13396	soon as VM shuts down. It is not possible to set up metrics for machines
13397	that are powered off. One needs to start VM first, then set up metric
13398	collection parameters.
13399
13400	Metrics are organized hierarchically, with each level separated by a
13401	slash (/) character. Generally, the scheme for metric names is like this:
13402
13403	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13404
13405	"Category/Metric" together form the base metric name. A base metric is
13406	the smallest unit for which a sampling interval and the number of
13407	retained samples can be set. Only base metrics can be enabled and
13408	disabled. All sub-metrics are collected when their base metric is
13409	collected. Collected values for any set of sub-metrics can be queried
13410	with <link to="IPerformanceCollector::queryMetricsData" />.
13411
13412	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13413	category, "Load" metric, "User" submetric, "average" aggregate. An
13414	aggregate function is computed over all retained data. Valid aggregate
13415	functions are:
13416
13417	<ul>
13418	<li>avg -- average</li>
13419	<li>min -- minimum</li>
13420	<li>max -- maximum</li>
13421	</ul>
13422
13423	When setting up metric parameters, querying metric data, enabling or
13424	disabling metrics wildcards can be used in metric names to specify a
13425	subset of metrics. For example, to select all CPU-related metrics
13426	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13427	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13428
13429	The valid names for base metrics are:
13430
13431	<ul>
13432	<li>CPU/Load</li>
13433	<li>CPU/MHz</li>
13434	<li>RAM/Usage</li>
13435	</ul>
13436
13437	The general sequence for collecting and retrieving the metrics is:
13438	<ul>
13439	<li>
13440	Obtain an instance of IPerformanceCollector with
13441	<link to="IVirtualBox::performanceCollector" />
13442	</li>
13443	<li>
13444	Allocate and populate an array with references to objects the metrics
13445	will be collected for. Use references to IHost and IMachine objects.
13446	</li>
13447	<li>
13448	Allocate and populate an array with base metric names the data will
13449	be collected for.
13450	</li>
13451	<li>
13452	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13453	the metric data will be collected and stored.
13454	</li>
13455	<li>
13456	Wait for the data to get collected.
13457	</li>
13458	<li>
13459	Allocate and populate an array with references to objects the metric
13460	values will be queried for. You can re-use the object array used for
13461	setting base metrics.
13462	</li>
13463	<li>
13464	Allocate and populate an array with metric names the data will be
13465	collected for. Note that metric names differ from base metric names.
13466	</li>
13467	<li>
13468	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13469	that have been collected so far are returned. Note that the values
13470	are still retained internally and data collection continues.
13471	</li>
13472	</ul>
13473
13474	For an example of usage refer to the following files in VirtualBox SDK:
13475	<ul>
13476	<li>
13477	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13478	</li>
13479	<li>
13480	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13481	</li>
13482	</ul>
13483	</desc>
13484
13485	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13486	<desc>
13487	Array of unique names of metrics.
13488
13489	This array represents all metrics supported by the performance
13490	collector. Individual objects do not necessarily support all of them.
13491	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13492	list of supported metrics for a particular object.
13493	</desc>
13494	</attribute>
13495
13496	<method name="getMetrics">
13497	<desc>
13498	Returns parameters of specified metrics for a set of objects.
13499	<note>
13500	@c Null metrics array means all metrics. @c Null object array means
13501	all existing objects.
13502	</note>
13503	</desc>
13504	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13505	<desc>
13506	Metric name filter. Currently, only a comma-separated list of metrics
13507	is supported.
13508	</desc>
13509	</param>
13510	<param name="objects" type="$unknown" dir="in" safearray="yes">
13511	<desc>
13512	Set of objects to return metric parameters for.
13513	</desc>
13514	</param>
13515	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13516	<desc>
13517	Array of returned metric parameters.
13518	</desc>
13519	</param>
13520	</method>
13521
13522	<method name="setupMetrics">
13523	<desc>
13524	Sets parameters of specified base metrics for a set of objects. Returns
13525	an array of <link to="IPerformanceMetric" /> describing the metrics
13526	have been affected.
13527	<note>
13528	@c Null or empty metric name array means all metrics. @c Null or
13529	empty object array means all existing objects. If metric name array
13530	contains a single element and object array contains many, the single
13531	metric name array element is applied to each object array element to
13532	form metric/object pairs.
13533	</note>
13534	</desc>
13535	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13536	<desc>
13537	Metric name filter. Comma-separated list of metrics with wildcard
13538	support.
13539	</desc>
13540	</param>
13541	<param name="objects" type="$unknown" dir="in" safearray="yes">
13542	<desc>
13543	Set of objects to setup metric parameters for.
13544	</desc>
13545	</param>
13546	<param name="period" type="unsigned long" dir="in">
13547	<desc>
13548	Time interval in seconds between two consecutive samples of
13549	performance data.
13550	</desc>
13551	</param>
13552	<param name="count" type="unsigned long" dir="in">
13553	<desc>
13554	Number of samples to retain in performance data history. Older
13555	samples get discarded.
13556	</desc>
13557	</param>
13558	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13559	<desc>
13560	Array of metrics that have been modified by the call to this method.
13561	</desc>
13562	</param>
13563	</method>
13564
13565	<method name="enableMetrics">
13566	<desc>
13567	Turns on collecting specified base metrics. Returns an array of
13568	<link to="IPerformanceMetric" /> describing the metrics have been
13569	affected.
13570	<note>
13571	@c Null or empty metric name array means all metrics. @c Null or
13572	empty object array means all existing objects. If metric name array
13573	contains a single element and object array contains many, the single
13574	metric name array element is applied to each object array element to
13575	form metric/object pairs.
13576	</note>
13577	</desc>
13578	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13579	<desc>
13580	Metric name filter. Comma-separated list of metrics with wildcard
13581	support.
13582	</desc>
13583	</param>
13584	<param name="objects" type="$unknown" dir="in" safearray="yes">
13585	<desc>
13586	Set of objects to enable metrics for.
13587	</desc>
13588	</param>
13589	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13590	<desc>
13591	Array of metrics that have been modified by the call to this method.
13592	</desc>
13593	</param>
13594	</method>
13595
13596	<method name="disableMetrics">
13597	<desc>
13598	Turns off collecting specified base metrics. Returns an array of
13599	<link to="IPerformanceMetric" /> describing the metrics have been
13600	affected.
13601	<note>
13602	@c Null or empty metric name array means all metrics. @c Null or
13603	empty object array means all existing objects. If metric name array
13604	contains a single element and object array contains many, the single
13605	metric name array element is applied to each object array element to
13606	form metric/object pairs.
13607	</note>
13608	</desc>
13609	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13610	<desc>
13611	Metric name filter. Comma-separated list of metrics with wildcard
13612	support.
13613	</desc>
13614	</param>
13615	<param name="objects" type="$unknown" dir="in" safearray="yes">
13616	<desc>
13617	Set of objects to disable metrics for.
13618	</desc>
13619	</param>
13620	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13621	<desc>
13622	Array of metrics that have been modified by the call to this method.
13623	</desc>
13624	</param>
13625	</method>
13626
13627	<method name="queryMetricsData">
13628	<desc>
13629	Queries collected metrics data for a set of objects.
13630
13631	The data itself and related metric information are returned in seven
13632	parallel and one flattened array of arrays. Elements of
13633	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13634	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13635	the same index describe one set of values corresponding to a single
13636	metric.
13637
13638	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13639	start and length of a sub-array is indicated by
13640	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13641	value for metric <tt>metricNames[i]</tt> is at
13642	<tt>returnData[returnIndices[i]]</tt>.
13643
13644	<note>
13645	@c Null or empty metric name array means all metrics. @c Null or
13646	empty object array means all existing objects. If metric name array
13647	contains a single element and object array contains many, the single
13648	metric name array element is applied to each object array element to
13649	form metric/object pairs.
13650	</note>
13651	<note>
13652	Data collection continues behind the scenes after call to @c
13653	queryMetricsData. The return data can be seen as the snapshot of the
13654	current state at the time of @c queryMetricsData call. The internally
13655	kept metric values are not cleared by the call. This makes possible
13656	querying different subsets of metrics or aggregates with subsequent
13657	calls. If periodic querying is needed it is highly suggested to query
13658	the values with @c interval*count period to avoid confusion. This way
13659	a completely new set of data values will be provided by each query.
13660	</note>
13661	</desc>
13662	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13663	<desc>
13664	Metric name filter. Comma-separated list of metrics with wildcard
13665	support.
13666	</desc>
13667	</param>
13668	<param name="objects" type="$unknown" dir="in" safearray="yes">
13669	<desc>
13670	Set of objects to query metrics for.
13671	</desc>
13672	</param>
13673	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13674	<desc>
13675	Names of metrics returned in @c returnData.
13676	</desc>
13677	</param>
13678	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13679	<desc>
13680	Objects associated with metrics returned in @c returnData.
13681	</desc>
13682	</param>
13683	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13684	<desc>
13685	Units of measurement for each returned metric.
13686	</desc>
13687	</param>
13688	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13689	<desc>
13690	Divisor that should be applied to return values in order to get
13691	floating point values. For example:
13692	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13693	will retrieve the floating point value of i-th sample of the first
13694	metric.
13695	</desc>
13696	</param>
13697	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13698	<desc>
13699	Sequence numbers of the first elements of value sequences of
13700	particular metrics returned in @c returnData. For aggregate metrics
13701	it is the sequence number of the sample the aggregate started
13702	calculation from.
13703	</desc>
13704	</param>
13705	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13706	<desc>
13707	Indices of the first elements of value sequences of particular
13708	metrics returned in @c returnData.
13709	</desc>
13710	</param>
13711	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13712	<desc>
13713	Lengths of value sequences of particular metrics.
13714	</desc>
13715	</param>
13716	<param name="returnData" type="long" dir="return" safearray="yes">
13717	<desc>
13718	Flattened array of all metric data containing sequences of values for
13719	each metric.
13720	</desc>
13721	</param>
13722	</method>
13723
13724	</interface>
13725	<enum
13726	name="NATAliasMode"
13727	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13728	<desc></desc>
13729	<const name="AliasLog" value="0x1">
13730	<desc></desc>
13731	</const>
13732	<const name="AliasProxyOnly" value="0x02">
13733	<desc></desc>
13734	</const>
13735	<const name="AliasUseSamePorts" value="0x04">
13736	<desc></desc>
13737	</const>
13738	</enum>
13739	<enum
13740	name="NATProtocol"
13741	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13742	>
13743	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13744	<const name="UDP" value="0">
13745	<desc>Port-forwarding uses UDP protocol.</desc>
13746	</const>
13747	<const name="TCP" value="1">
13748	<desc>Port-forwarding uses TCP protocol.</desc>
13749	</const>
13750	</enum>
13751
13752	<interface
13753	name="INATEngine" extends="$unknown"
13754	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13755	wsmap="managed"
13756	>
13757	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13758	allows for changing NAT behavior such as port-forwarding rules. This interface is
13759	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13760	<attribute name="network" type="wstring">
13761	<desc>The network attribute of the NAT engine (the same value is used with built-in
13762	DHCP server to fill corresponding fields of DHCP leases).</desc>
13763	</attribute>
13764	<attribute name="hostIP" type="wstring">
13765	<desc>IP of host interface to bind all opened sockets to.
13766	<note>Changing this does not change binding of port forwarding.</note>
13767	</desc>
13768	</attribute>
13769	<attribute name="tftpPrefix" type="wstring">
13770	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13771	the corresponding fields of DHCP leases.</desc>
13772	</attribute>
13773	<attribute name="tftpBootFile" type="wstring">
13774	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13775	the corresponding fields of DHCP leases.</desc>
13776	</attribute>
13777	<attribute name="tftpNextServer" type="wstring">
13778	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13779	the corresponding fields of DHCP leases.
13780	<note>The preferred form is IPv4 addresses.</note>
13781	</desc>
13782	</attribute>
13783	<attribute name="aliasMode" type="unsigned long">
13784	<desc></desc>
13785	</attribute>
13786	<attribute name="dnsPassDomain" type="boolean">
13787	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13788	</attribute>
13789	<attribute name="dnsProxy" type="boolean">
13790	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13791	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13792	</attribute>
13793	<attribute name="dnsUseHostResolver" type="boolean">
13794	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13795	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13796	</attribute>
13797	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13798	<desc>Array of NAT port-forwarding rules in string representation, in the following
13799	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13800	</attribute>
13801	<method name="setNetworkSettings">
13802	<desc>Sets network configuration of the NAT engine.</desc>
13803	<param name="mtu" type="unsigned long" dir="in">
13804	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13805	</param>
13806	<param name="sockSnd" type="unsigned long" dir="in">
13807	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13808	</param>
13809	<param name="sockRcv" type="unsigned long" dir="in">
13810	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13811	</param>
13812	<param name="TcpWndSnd" type="unsigned long" dir="in">
13813	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13814	establishing a new TCP connection.</desc>
13815	</param>
13816	<param name="TcpWndRcv" type="unsigned long" dir="in">
13817	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13818	establishing a new TCP connection.</desc>
13819	</param>
13820	</method>
13821	<method name="getNetworkSettings">
13822	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13823	for parameter descriptions.</desc>
13824	<param name="mtu" type="unsigned long" dir="out" />
13825	<param name="sockSnd" type="unsigned long" dir="out" />
13826	<param name="sockRcv" type="unsigned long" dir="out" />
13827	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13828	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13829	</method>
13830	<method name="addRedirect">
13831	<desc>Adds a new NAT port-forwarding rule.</desc>
13832	<param name="name" type="wstring" dir="in">
13833	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13834	auto-generates one using the other parameters.</desc>
13835	</param>
13836	<param name="proto" type="NATProtocol" dir="in">
13837	<desc>Protocol handled with the rule.</desc>
13838	</param>
13839	<param name="hostIp" type="wstring" dir="in">
13840	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13841	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13842	</param>
13843	<param name="hostPort" type="unsigned short" dir="in">
13844	<desc>The port number to listen on.</desc>
13845	</param>
13846	<param name="guestIp" type="wstring" dir="in">
13847	<desc>The IP address of the guest which the NAT engine will forward matching packets
13848	to. An empty IP address is acceptable, in which case the NAT engine will forward
13849	packets to the first DHCP lease (x.x.x.15).</desc>
13850	</param>
13851	<param name="guestPort" type="unsigned short" dir="in">
13852	<desc>The port number to forward.</desc>
13853	</param>
13854	</method>
13855	<method name="removeRedirect">
13856	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13857	<param name="name" type="wstring" dir="in">
13858	<desc>The name of the rule to delete.</desc>
13859	</param>
13860	</method>
13861	</interface>
13862
13863	<enum
13864	name="VBoxEventType"
13865	uuid="1728bb3b-4843-4f12-af67-f7a1f69f3a52">
13866
13867	<desc>
13868	Type of an event.
13869	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
13870	</desc>
13871
13872	<const name="Invalid" value="0">
13873	<desc>
13874	Invalid event, must be first.
13875	</desc>
13876	</const>
13877
13878	<const name="Any" value="1">
13879	<desc>
13880	Wildcard for all events.
13881	Events of this type are never delivered, and only used in
13882	registerListener() call to simplify registration.
13883	</desc>
13884	</const>
13885
13886	<const name="Vetoable" value="2">
13887	<desc>
13888	Wildcard for all vetoable events. Events of this type are never delivered, and only
13889	used in registerListener() call to simplify registration.
13890	</desc>
13891	</const>
13892
13893	<const name="MachineEvent" value="3">
13894	<desc>
13895	Wildcard for all machine events. Events of this type are never delivered, and only used in
13896	registerListener() call to simplify registration.
13897	</desc>
13898	</const>
13899
13900	<const name="SnapshotEvent" value="4">
13901	<desc>
13902	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
13903	registerListener() call to simplify registration.
13904	</desc>
13905	</const>
13906
13907	<const name="InputEvent" value="5">
13908	<desc>
13909	Wildcard for all input device (keyboard, mouse) events.
13910	Events of this type are never delivered, and only used in
13911	registerListener() call to simplify registration.
13912	</desc>
13913	</const>
13914
13915	<const name="LastWildcard" value="31">
13916	<desc>
13917	Last wildcard.
13918	</desc>
13919	</const>
13920
13921	<const name="OnMachineStateChanged" value="32">
13922	<desc>
13923	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
13924	</desc>
13925	</const>
13926	<const name="OnMachineDataChanged" value="33">
13927	<desc>
13928	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
13929	</desc>
13930	</const>
13931	<const name="OnExtraDataChanged" value="34">
13932	<desc>
13933	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
13934	</desc>
13935	</const>
13936	<const name="OnExtraDataCanChange" value="35">
13937	<desc>
13938	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
13939	</desc>
13940	</const>
13941	<const name="OnMediumRegistered" value="36">
13942	<desc>
13943	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
13944	</desc>
13945	</const>
13946	<const name="OnMachineRegistered" value="37">
13947	<desc>
13948	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
13949	</desc>
13950	</const>
13951	<const name="OnSessionStateChanged" value="38">
13952	<desc>
13953	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
13954	</desc>
13955	</const>
13956	<const name="OnSnapshotTaken" value="39">
13957	<desc>
13958	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
13959	</desc>
13960	</const>
13961	<const name="OnSnapshotDeleted" value="40">
13962	<desc>
13963	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
13964	</desc>
13965	</const>
13966	<const name="OnSnapshotChanged" value="41">
13967	<desc>
13968	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
13969	</desc>
13970	</const>
13971	<const name="OnGuestPropertyChanged" value="42">
13972	<desc>
13973	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
13974	</desc>
13975	</const>
13976	<!-- Console events -->
13977	<const name="OnMousePointerShapeChanged" value="43">
13978	<desc>
13979	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
13980	</desc>
13981	</const>
13982	<const name="OnMouseCapabilityChanged" value="44">
13983	<desc>
13984	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
13985	</desc>
13986	</const>
13987	<const name="OnKeyboardLedsChanged" value="45">
13988	<desc>
13989	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
13990	</desc>
13991	</const>
13992	<const name="OnStateChanged" value="46">
13993	<desc>
13994	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
13995	</desc>
13996	</const>
13997	<const name="OnAdditionsStateChanged" value="47">
13998	<desc>
13999	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14000	</desc>
14001	</const>
14002	<const name="OnNetworkAdapterChanged" value="48">
14003	<desc>
14004	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14005	</desc>
14006	</const>
14007	<const name="OnSerialPortChanged" value="49">
14008	<desc>
14009	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14010	</desc>
14011	</const>
14012	<const name="OnParallelPortChanged" value="50">
14013	<desc>
14014	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14015	</desc>
14016	</const>
14017	<const name="OnStorageControllerChanged" value="51">
14018	<desc>
14019	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14020	</desc>
14021	</const>
14022	<const name="OnMediumChanged" value="52">
14023	<desc>
14024	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14025	</desc>
14026	</const>
14027	<const name="OnVRDPServerChanged" value="53">
14028	<desc>
14029	See <link to="IVRDPServerChangedEvent">IVRDPServerChangedEvent</link>.
14030	</desc>
14031	</const>
14032	<const name="OnUSBControllerChanged" value="54">
14033	<desc>
14034	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14035	</desc>
14036	</const>
14037	<const name="OnUSBDeviceStateChanged" value="55">
14038	<desc>
14039	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14040	</desc>
14041	</const>
14042	<const name="OnSharedFolderChanged" value="56">
14043	<desc>
14044	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14045	</desc>
14046	</const>
14047	<const name="OnRuntimeError" value="57">
14048	<desc>
14049	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14050	</desc>
14051	</const>
14052	<const name="OnCanShowWindow" value="58">
14053	<desc>
14054	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14055	</desc>
14056	</const>
14057	<const name="OnShowWindow" value="59">
14058	<desc>
14059	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14060	</desc>
14061	</const>
14062	<const name="OnCPUChanged" value="60">
14063	<desc>
14064	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14065	</desc>
14066	</const>
14067	<const name="OnRemoteDisplayInfoChanged" value="61">
14068	<desc>
14069	See <link to="IRemoteDisplayInfoChangedEvent">IRemoteDisplayInfoChangedEvent</link>.
14070	</desc>
14071	</const>
14072	<const name="OnEventSourceChanged" value="62">
14073	<desc>
14074	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14075	</desc>
14076	</const>
14077	<const name="OnCPUExecutionCapChanged" value="63">
14078	<desc>
14079	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14080	</desc>
14081	</const>
14082	<const name="OnGuestKeyboardEvent" value="64">
14083	<desc>
14084	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14085	</desc>
14086	</const>
14087	<const name="OnGuestMouseEvent" value="65">
14088	<desc>
14089	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14090	</desc>
14091	</const>
14092	<!-- Last event marker -->
14093	<const name="Last" value="66">
14094	<desc>
14095	Must be last event, used for iterations and structures relying on numerical event values.
14096	</desc>
14097	</const>
14098
14099	</enum>
14100
14101	<interface
14102	name="IEventSource" extends="$unknown"
14103	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14104	wsmap="managed"
14105	>
14106	<desc>
14107	Event source. Generally, any object which could generate events can be an event source,
14108	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14109	an event source can work with listeners in either active or passive mode. In active mode it is up to
14110	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14111	event source keeps track of pending events for each listener and returns available events on demand.
14112
14113	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14114	</desc>
14115
14116	<method name="createListener">
14117	<desc>
14118	Creates a new listener object, useful for passive mode.
14119	</desc>
14120	<param name="listener" type="IEventListener" dir="return"/>
14121	</method>
14122
14123	<method name="createAggregator">
14124	<desc>
14125	Creates a aggregator event source, collecting events from multiple source.
14126	This way single listener can collect events from multiple sources, using
14127	getEvent() of this aggregator.
14128	</desc>
14129	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14130	<desc>
14131	Subordinate event source this one aggregatres.
14132	</desc>
14133	</param>
14134	<param name="result" type="IEventSource" dir="return"/>
14135	</method>
14136
14137	<method name="registerListener">
14138	<desc>
14139	Register an event listener.
14140
14141	<note>
14142	To avoid system overload, the VirtualBox server process checks if passive event
14143	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14144	current implementation, if more than 500 pending events are detected for a passive
14145	event listener, it is forcefully unregistered by the system, and further
14146	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14147	</note>
14148	</desc>
14149	<param name="listener" type="IEventListener" dir="in">
14150	<desc>Listener to register.</desc>
14151	</param>
14152	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14153	<desc>
14154	Event types listener is interested in. One can use wildcards like -
14155	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14156	than one event.
14157	</desc>
14158	</param>
14159	<param name="active" type="boolean" dir="in">
14160	<desc>
14161	Which mode this listener is operating in.
14162	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14163	In passive mode, an internal event queue is created for this this IEventListener.
14164	For each event coming in, it is added to queues for all interested registered passive
14165	listeners. It is then up to the external code to call the listener's
14166	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14167	external code must call <link to="#eventProcessed" />.
14168	</desc>
14169	</param>
14170	</method>
14171
14172	<method name="unregisterListener">
14173	<desc>
14174	Unregister an event listener. If listener is passive, and some waitable events are still
14175	in queue they are marked as processed automatically.
14176	</desc>
14177	<param name="listener" type="IEventListener" dir="in">
14178	<desc>Listener to unregister.</desc>
14179	</param>
14180	</method>
14181
14182	<method name="fireEvent">
14183	<desc>
14184	Fire an event for this source.
14185	</desc>
14186	<param name="event" type="IEvent" dir="in">
14187	<desc>Event to deliver.</desc>
14188	</param>
14189	<param name="timeout" type="long" dir="in">
14190	<desc>
14191	Maximum time to wait for event processing (if event is waitable), in ms;
14192	0 = no wait, -1 = indefinite wait.
14193	</desc>
14194	</param>
14195	<param name="result" type="boolean" dir="return">
14196	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14197	</param>
14198	</method>
14199
14200	<method name="getEvent">
14201	<desc>
14202	Get events from this peer's event queue (for passive mode). Calling this method
14203	regularly is required for passive event listeners to avoid system overload;
14204	see <link to="IEventSource::registerListener" /> for details.
14205
14206	<result name="VBOX_E_OBJECT_NOT_FOUND">
14207	Listener is not registered, or autounregistered.
14208	</result>
14209	</desc>
14210	<param name="listener" type="IEventListener" dir="in">
14211	<desc>Which listener to get data for.</desc>
14212	</param>
14213	<param name="timeout" type="long" dir="in">
14214	<desc>
14215	Maximum time to wait for events, in ms;
14216	0 = no wait, -1 = indefinite wait.
14217	</desc>
14218	</param>
14219	<param name="event" type="IEvent" dir="return">
14220	<desc>Event retrieved, or null if none available.</desc>
14221	</param>
14222	</method>
14223
14224	<method name="eventProcessed">
14225	<desc>
14226	Must be called for waitable events after a particular listener finished its
14227	event processing. When all listeners of a particular event have called this
14228	method, the system will then call <link to="IEvent::setProcessed" />.
14229	</desc>
14230	<param name="listener" type="IEventListener" dir="in">
14231	<desc>Which listener processed event.</desc>
14232	</param>
14233	<param name="event" type="IEvent" dir="in">
14234	<desc>Which event.</desc>
14235	</param>
14236	</method>
14237
14238	</interface>
14239
14240	<interface
14241	name="IEventListener" extends="$unknown"
14242	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14243	wsmap="managed"
14244	>
14245	<desc>
14246	Event listener. An event listener can work in either active or passive mode, depending on the way
14247	it was registered.
14248	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14249	</desc>
14250
14251	<method name="handleEvent">
14252	<desc>
14253	Handle event callback (called directly by IEventSource in active mode, or could be
14254	called by event processor thread in passive mode).
14255	</desc>
14256	<param name="event" type="IEvent" dir="in">
14257	<desc>Event available.</desc>
14258	</param>
14259	</method>
14260
14261	</interface>
14262
14263	<interface
14264	name="IEvent" extends="$unknown"
14265	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14266	wsmap="managed"
14267	>
14268	<desc>
14269	Abstract parent interface for VirtualBox events. Actual events will typically implement
14270	a more specific interface which derives from this (see below).
14271
14272	<b>Introduction to VirtualBox events</b>
14273
14274	Generally speaking, an event (represented by this interface) signals that something
14275	happened, while an event listener (see <link to="IEventListener" />) represents an
14276	entity that is interested in certain events. In order for this to work with
14277	unidirectional protocols (i.e. web services), the concepts of passive and active
14278	listener are used.
14279
14280	Event consumers can register themselves as listeners, providing an array of
14281	events they are interested in (see <link to="IEventSource::registerListener" />).
14282	When an event triggers, the listener is notified about the event. The exact
14283	mechanism of the notification depends on whether the listener was registered as
14284	an active or passive listener:
14285
14286	<ul>
14287	<li>An active listener is very similar to a callback: it is a function invoked
14288	by the API. As opposed to the callbacks that were used in the API before
14289	VirtualBox 3.3 however, events are now objects with an interface hierarchy.
14290	</li>
14291
14292	<li>Passive listeners are somewhat tricker to implement, but do not require
14293	a client function to be callable, which is not an option with scripting
14294	languages or web service clients. Internally the <link to="IEventSource" />
14295	implementation maintains an event queue for each passive listener, and
14296	newly arrived events are put in this queue. When the listener calls
14297	<link to="IEventSource::getEvent"/>, first element from its internal event
14298	queue is returned. When the client completes processing of an event,
14299	the <link to="IEventSource::eventProcessed" /> function must be called,
14300	acknowledging that the event was processed. It supports implementing
14301	waitable events. On passive listener unregistration, all events from its
14302	queue are auto-acknowledged.
14303	</li>
14304	</ul>
14305
14306	Waitable events are useful in situations where the event generator wants to track
14307	delivery or a party wants to wait until all listeners have completed the event. A
14308	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14309	listeners might veto a certain action, and thus the event producer has to make
14310	sure that all listeners have processed the event and not vetoed before taking
14311	the action.
14312
14313	A given event may have both passive and active listeners at the same time.
14314
14315	<b>Using events</b>
14316
14317	Any VirtualBox object capable of producing externally visible events provides an
14318	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14319	This event source object is notified by VirtualBox once something has happened, so
14320	consumers may register event listeners with this event source. To register a listener,
14321	an object implementing the <link to="IEventListener" /> interface must be provided.
14322	For active listeners, such an object is typically created by the consumer, while for
14323	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14324	note that a listener created with @c createListener() must not be used as an active listener.
14325
14326	Once created, the listener must be registered to listen for the desired events
14327	(see <link to="IEventSource::registerListener" />), providing an array of
14328	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14329	event IDs or wildcards matching multiple event IDs.
14330
14331	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14332	called automatically when the event is triggered, while passive listeners have to call
14333	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14334	an event processing loop.
14335
14336	The IEvent interface is an abstract parent interface for all such VirtualBox events
14337	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14338	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14339	then cast to the appropriate specific interface using @c QueryInterface().
14340	</desc>
14341
14342	<attribute name="type" readonly="yes" type="VBoxEventType">
14343	<desc>
14344	Event type.
14345	</desc>
14346	</attribute>
14347
14348	<attribute name="source" readonly="yes" type="IEventSource">
14349	<desc>
14350	Source of this event.
14351	</desc>
14352	</attribute>
14353
14354	<attribute name="waitable" readonly="yes" type="boolean">
14355	<desc>
14356	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14357	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14358	as no additional overhead associated with waitability imposed.
14359	Waitable events are needed when one need to be able to wait for particular event processed,
14360	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14361	until all consumers confirmed events.
14362	</desc>
14363	</attribute>
14364
14365	<method name="setProcessed">
14366	<desc>
14367	Internal method called by the system when all listeners of a particular event have called
14368	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14369	</desc>
14370	</method>
14371
14372	<method name="waitProcessed">
14373	<desc>
14374	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14375	described semantics, for non-waitable returns true immediately.
14376	</desc>
14377	<param name="timeout" type="long" dir="in">
14378	<desc>
14379	Maximum time to wait for event processeing, in ms;
14380	0 = no wait, -1 = indefinite wait.
14381	</desc>
14382	</param>
14383	<param name="result" type="boolean" dir="return">
14384	<desc>If this event was processed before timeout.</desc>
14385	</param>
14386	</method>
14387	</interface>
14388
14389
14390	<interface
14391	name="IReusableEvent" extends="IEvent"
14392	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14393	wsmap="managed"
14394	>
14395	<desc>Base abstract interface for all reusable events.</desc>
14396
14397	<attribute name="generation" readonly="yes" type="unsigned long">
14398	<desc>Current generation of event, incremented on reuse.</desc>
14399	</attribute>
14400
14401	<method name="reuse">
14402	<desc>
14403	Marks an event as reused, increments 'generation', fields shall no
14404	longer be considered valid.
14405	</desc>
14406	</method>
14407	</interface>
14408
14409	<interface
14410	name="IMachineEvent" extends="IEvent"
14411	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14412	wsmap="managed" id="MachineEvent"
14413	>
14414	<desc>Base abstract interface for all machine events.</desc>
14415
14416	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14417	<desc>ID of the machine this event relates to.</desc>
14418	</attribute>
14419
14420	</interface>
14421
14422	<interface
14423	name="IMachineStateChangedEvent" extends="IMachineEvent"
14424	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14425	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14426	>
14427	<desc>Machine state change event.</desc>
14428
14429	<attribute name="state" readonly="yes" type="MachineState">
14430	<desc>New execution state.</desc>
14431	</attribute>
14432	</interface>
14433
14434	<interface
14435	name="IMachineDataChangedEvent" extends="IMachineEvent"
14436	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14437	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14438	>
14439	<desc>
14440	Any of the settings of the given machine has changed.
14441	</desc>
14442	</interface>
14443
14444	<interface
14445	name="IMediumRegisteredEvent" extends="IEvent"
14446	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14447	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14448	>
14449	<desc>
14450	The given medium was registered or unregistered
14451	within this VirtualBox installation.
14452	</desc>
14453
14454	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14455	<desc>ID of the medium this event relates to.</desc>
14456	</attribute>
14457
14458	<attribute name="mediumType" readonly="yes" type="DeviceType">
14459	<desc>Type of the medium this event relates to.</desc>
14460	</attribute>
14461
14462	<attribute name="registered" type="boolean" readonly="yes">
14463	<desc>
14464	If @c true, the medium was registered, otherwise it was
14465	unregistered.
14466	</desc>
14467	</attribute>
14468	</interface>
14469
14470	<interface
14471	name="IMachineRegisteredEvent" extends="IMachineEvent"
14472	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14473	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14474	>
14475	<desc>
14476	The given machine was registered or unregistered
14477	within this VirtualBox installation.
14478	</desc>
14479
14480	<attribute name="registered" type="boolean" readonly="yes">
14481	<desc>
14482	If @c true, the machine was registered, otherwise it was
14483	unregistered.
14484	</desc>
14485	</attribute>
14486	</interface>
14487
14488	<interface
14489	name="ISessionStateChangedEvent" extends="IMachineEvent"
14490	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14491	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14492	>
14493	<desc>
14494	The state of the session for the given machine was changed.
14495	<see>IMachine::sessionState</see>
14496	</desc>
14497
14498	<attribute name="state" type="SessionState" readonly="yes">
14499	<desc>
14500	New session state.
14501	</desc>
14502	</attribute>
14503	</interface>
14504
14505	<interface
14506	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14507	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14508	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14509	>
14510	<desc>
14511	Notification when a guest property has changed.
14512	</desc>
14513
14514	<attribute name="name" readonly="yes" type="wstring">
14515	<desc>
14516	The name of the property that has changed.
14517	</desc>
14518	</attribute>
14519
14520	<attribute name="value" readonly="yes" type="wstring">
14521	<desc>
14522	The new property value.
14523	</desc>
14524	</attribute>
14525
14526	<attribute name="flags" readonly="yes" type="wstring">
14527	<desc>
14528	The new property flags.
14529	</desc>
14530	</attribute>
14531
14532	</interface>
14533
14534	<interface
14535	name="ISnapshotEvent" extends="IMachineEvent"
14536	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14537	wsmap="managed" id="SnapshotEvent"
14538	>
14539	<desc>Base interface for all snapshot events.</desc>
14540
14541	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14542	<desc>ID of the snapshot this event relates to.</desc>
14543	</attribute>
14544
14545	</interface>
14546
14547	<interface
14548	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14549	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14550	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14551	>
14552	<desc>
14553	A new snapshot of the machine has been taken.
14554	<see>ISnapshot</see>
14555	</desc>
14556	</interface>
14557
14558	<interface
14559	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14560	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14561	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14562	>
14563	<desc>
14564	Snapshot of the given machine has been deleted.
14565
14566	<note>
14567	This notification is delivered <b>after</b> the snapshot
14568	object has been uninitialized on the server (so that any
14569	attempt to call its methods will return an error).
14570	</note>
14571
14572	<see>ISnapshot</see>
14573	</desc>
14574	</interface>
14575
14576	<interface
14577	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14578	uuid="07541941-8079-447a-a33e-47a69c7980db"
14579	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14580	>
14581	<desc>
14582	Snapshot properties (name and/or description) have been changed.
14583	<see>ISnapshot</see>
14584	</desc>
14585	</interface>
14586
14587	<interface
14588	name="IMousePointerShapeChangedEvent" extends="IEvent"
14589	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14590	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14591	>
14592	<desc>
14593	Notification when the guest mouse pointer shape has
14594	changed. The new shape data is given.
14595	</desc>
14596
14597	<attribute name="visible" type="boolean" readonly="yes">
14598	<desc>
14599	Flag whether the pointer is visible.
14600	</desc>
14601	</attribute>
14602	<attribute name="alpha" type="boolean" readonly="yes">
14603	<desc>
14604	Flag whether the pointer has an alpha channel.
14605	</desc>
14606	</attribute>
14607	<attribute name="xhot" type="unsigned long" readonly="yes">
14608	<desc>
14609	The pointer hot spot X coordinate.
14610	</desc>
14611	</attribute>
14612	<attribute name="yhot" type="unsigned long" readonly="yes">
14613	<desc>
14614	The pointer hot spot Y coordinate.
14615	</desc>
14616	</attribute>
14617	<attribute name="width" type="unsigned long" readonly="yes">
14618	<desc>
14619	Width of the pointer shape in pixels.
14620	</desc>
14621	</attribute>
14622	<attribute name="height" type="unsigned long" readonly="yes">
14623	<desc>
14624	Height of the pointer shape in pixels.
14625	</desc>
14626	</attribute>
14627	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14628	<desc>
14629	Shape buffer arrays.
14630
14631	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14632	followed by a 32-bpp XOR (color) mask.
14633
14634	For pointers without alpha channel the XOR mask pixels are 32
14635	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14636	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14637
14638	An AND mask is used for pointers with alpha channel, so if the
14639	callback does not support alpha, the pointer could be
14640	displayed as a normal color pointer.
14641
14642	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14643	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14644	height</tt>. The padding bits at the end of each scanline are
14645	undefined.
14646
14647	The XOR mask follows the AND mask on the next 4-byte aligned
14648	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14649	Bytes in the gap between the AND and the XOR mask are undefined.
14650	The XOR mask scanlines have no gap between them and the size of
14651	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14652
14653	<note>
14654	If @a shape is 0, only the pointer visibility is changed.
14655	</note>
14656	</desc>
14657	</attribute>
14658	</interface>
14659
14660	<interface
14661	name="IMouseCapabilityChangedEvent" extends="IEvent"
14662	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14663	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14664	>
14665	<desc>
14666	Notification when the mouse capabilities reported by the
14667	guest have changed. The new capabilities are passed.
14668	</desc>
14669	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14670	<desc>
14671	Supports absolute coordinates.
14672	</desc>
14673	</attribute>
14674	<attribute name="supportsRelative" type="boolean" readonly="yes">
14675	<desc>
14676	Supports relative coordinates.
14677	</desc>
14678	</attribute>
14679	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14680	<desc>
14681	If host cursor is needed.
14682	</desc>
14683	</attribute>
14684	</interface>
14685
14686	<interface
14687	name="IKeyboardLedsChangedEvent" extends="IEvent"
14688	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14689	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14690	>
14691	<desc>
14692	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14693	to alter the state of the keyboard LEDs.
14694	</desc>
14695	<attribute name="numLock" type="boolean" readonly="yes">
14696	<desc>
14697	NumLock status.
14698	</desc>
14699	</attribute>
14700	<attribute name="capsLock" type="boolean" readonly="yes">
14701	<desc>
14702	CapsLock status.
14703	</desc>
14704	</attribute>
14705	<attribute name="scrollLock" type="boolean" readonly="yes">
14706	<desc>
14707	ScrollLock status.
14708	</desc>
14709	</attribute>
14710	</interface>
14711
14712	<interface
14713	name="IStateChangedEvent" extends="IEvent"
14714	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14715	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14716	>
14717	<desc>
14718	Notification when the execution state of the machine has changed.
14719	The new state is given.
14720	</desc>
14721	<attribute name="state" type="MachineState" readonly="yes">
14722	<desc>
14723	New machine state.
14724	</desc>
14725	</attribute>
14726	</interface>
14727
14728	<interface
14729	name="IAdditionsStateChangedEvent" extends="IEvent"
14730	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14731	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14732	>
14733	<desc>
14734	Notification when a Guest Additions property changes.
14735	Interested callees should query IGuest attributes to
14736	find out what has changed.
14737	</desc>
14738	</interface>
14739
14740	<interface
14741	name="INetworkAdapterChangedEvent" extends="IEvent"
14742	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14743	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14744	>
14745	<desc>
14746	Notification when a property of one of the
14747	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14748	changes. Interested callees should use INetworkAdapter methods and
14749	attributes to find out what has changed.
14750	</desc>
14751	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14752	<desc>
14753	Network adapter that is subject to change.
14754	</desc>
14755	</attribute>
14756	</interface>
14757
14758	<interface
14759	name="ISerialPortChangedEvent" extends="IEvent"
14760	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14761	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14762	>
14763	<desc>
14764	Notification when a property of one of the
14765	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14766	Interested callees should use ISerialPort methods and attributes
14767	to find out what has changed.
14768	</desc>
14769	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14770	<desc>
14771	Serial port that is subject to change.
14772	</desc>
14773	</attribute>
14774	</interface>
14775
14776	<interface
14777	name="IParallelPortChangedEvent" extends="IEvent"
14778	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
14779	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
14780	>
14781	<desc>
14782	Notification when a property of one of the
14783	virtual <link to="IMachine::getParallelPort">parallel ports</link>
14784	changes. Interested callees should use ISerialPort methods and
14785	attributes to find out what has changed.
14786	</desc>
14787	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
14788	<desc>
14789	Parallel port that is subject to change.
14790	</desc>
14791	</attribute>
14792	</interface>
14793
14794	<interface
14795	name="IStorageControllerChangedEvent" extends="IEvent"
14796	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
14797	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
14798	>
14799	<desc>
14800	Notification when a
14801	<link to="IMachine::mediumAttachments">medium attachment</link>
14802	changes.
14803	</desc>
14804	</interface>
14805
14806	<interface
14807	name="IMediumChangedEvent" extends="IEvent"
14808	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
14809	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
14810	>
14811	<desc>
14812	Notification when a
14813	<link to="IMachine::mediumAttachments">medium attachment</link>
14814	changes.
14815	</desc>
14816	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
14817	<desc>
14818	Medium attachment that is subject to change.
14819	</desc>
14820	</attribute>
14821	</interface>
14822
14823	<interface
14824	name="ICPUChangedEvent" extends="IEvent"
14825	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
14826	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
14827	>
14828	<desc>
14829	Notification when a CPU changes.
14830	</desc>
14831	<attribute name="cpu" type="unsigned long" readonly="yes">
14832	<desc>
14833	The CPU which changed.
14834	</desc>
14835	</attribute>
14836	<attribute name="add" type="boolean" readonly="yes">
14837	<desc>
14838	Flag whether the CPU was added or removed.
14839	</desc>
14840	</attribute>
14841	</interface>
14842
14843	<interface
14844	name="ICPUExecutionCapChangedEvent" extends="IEvent"
14845	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
14846	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
14847	>
14848	<desc>
14849	Notification when the CPU execution cap changes.
14850	</desc>
14851	<attribute name="executionCap" type="unsigned long" readonly="yes">
14852	<desc>
14853	The new CPU execution cap value. (1-100)
14854	</desc>
14855	</attribute>
14856	</interface>
14857
14858	<interface
14859	name="IGuestKeyboardEvent" extends="IEvent"
14860	uuid="88394258-7006-40d4-b339-472ee3801844"
14861	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboardEvent"
14862	>
14863	<desc>
14864	Notification when guest keyboard event happens.
14865	</desc>
14866	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
14867	<desc>
14868	Array of scancodes.
14869	</desc>
14870	</attribute>
14871	</interface>
14872
14873	<interface
14874	name="IGuestMouseEvent" extends="IReusableEvent"
14875	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
14876	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouseEvent"
14877	>
14878	<desc>
14879	Notification when guest mouse event happens.
14880	</desc>
14881
14882	<attribute name="absolute" type="boolean" readonly="yes">
14883	<desc>
14884	If this event is relative or absolute.
14885	</desc>
14886	</attribute>
14887
14888	<attribute name="x" type="long" readonly="yes">
14889	<desc>
14890	New X position, or X delta.
14891	</desc>
14892	</attribute>
14893
14894	<attribute name="y" type="long" readonly="yes">
14895	<desc>
14896	New Y position, or Y delta.
14897	</desc>
14898	</attribute>
14899
14900	<attribute name="z" type="long" readonly="yes">
14901	<desc>
14902	Z delta.
14903	</desc>
14904	</attribute>
14905
14906	<attribute name="w" type="long" readonly="yes">
14907	<desc>
14908	W delta.
14909	</desc>
14910	</attribute>
14911
14912	<attribute name="buttons" type="long" readonly="yes">
14913	<desc>
14914	Button state bitmask.
14915	</desc>
14916	</attribute>
14917
14918	</interface>
14919
14920
14921	<interface
14922	name="IVRDPServerChangedEvent" extends="IEvent"
14923	uuid="726038B6-6279-4A7A-8037-D041693D1915"
14924	wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
14925	>
14926	<desc>
14927	Notification when a property of the
14928	<link to="IMachine::VRDPServer">VRDP server</link> changes.
14929	Interested callees should use IVRDPServer methods and attributes to
14930	find out what has changed.
14931	</desc>
14932	</interface>
14933
14934	<interface
14935	name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
14936	uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
14937	wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
14938	>
14939	<desc>
14940	Notification when the status of the VRDP server changes. Interested callees
14941	should use <link to="IConsole::remoteDisplayInfo">IRemoteDisplayInfo</link>
14942	attributes to find out what is the current status.
14943	</desc>
14944	</interface>
14945
14946	<interface
14947	name="IUSBControllerChangedEvent" extends="IEvent"
14948	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
14949	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
14950	>
14951	<desc>
14952	Notification when a property of the virtual
14953	<link to="IMachine::USBController">USB controller</link> changes.
14954	Interested callees should use IUSBController methods and attributes to
14955	find out what has changed.
14956	</desc>
14957	</interface>
14958
14959	<interface
14960	name="IUSBDeviceStateChangedEvent" extends="IEvent"
14961	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
14962	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
14963	>
14964	<desc>
14965	Notification when a USB device is attached to or detached from
14966	the virtual USB controller.
14967
14968	This notification is sent as a result of the indirect
14969	request to attach the device because it matches one of the
14970	machine USB filters, or as a result of the direct request
14971	issued by <link to="IConsole::attachUSBDevice"/> or
14972	<link to="IConsole::detachUSBDevice"/>.
14973
14974	This notification is sent in case of both a succeeded and a
14975	failed request completion. When the request succeeds, the
14976	@a error parameter is @c null, and the given device has been
14977	already added to (when @a attached is @c true) or removed from
14978	(when @a attached is @c false) the collection represented by
14979	<link to="IConsole::USBDevices"/>. On failure, the collection
14980	doesn't change and the @a error parameter represents the error
14981	message describing the failure.
14982	</desc>
14983	<attribute name="device" type="IUSBDevice" readonly="yes">
14984	<desc>
14985	Device that is subject to state change.
14986	</desc>
14987	</attribute>
14988	<attribute name="attached" type="boolean" readonly="yes">
14989	<desc>
14990	@c true if the device was attached and @c false otherwise.
14991	</desc>
14992	</attribute>
14993	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
14994	<desc>
14995	@c null on success or an error message object on failure.
14996	</desc>
14997	</attribute>
14998	</interface>
14999
15000	<interface
15001	name="ISharedFolderChangedEvent" extends="IEvent"
15002	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15003	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15004	>
15005	<desc>
15006	Notification when a shared folder is added or removed.
15007	The @a scope argument defines one of three scopes:
15008	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15009	(<link to="Scope_Global">Global</link>),
15010	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15011	the machine (<link to="Scope_Machine">Machine</link>) or <link
15012	to="IConsole::sharedFolders">transient shared folders</link> of the
15013	machine (<link to="Scope_Session">Session</link>). Interested callees
15014	should use query the corresponding collections to find out what has
15015	changed.
15016	</desc>
15017	<attribute name="scope" type="Scope" readonly="yes">
15018	<desc>
15019	Scope of the notification.
15020	</desc>
15021	</attribute>
15022	</interface>
15023
15024	<interface
15025	name="IRuntimeErrorEvent" extends="IEvent"
15026	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15027	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15028	>
15029	<desc>
15030	Notification when an error happens during the virtual
15031	machine execution.
15032
15033	There are three kinds of runtime errors:
15034	<ul>
15035	<li><i>fatal</i></li>
15036	<li><i>non-fatal with retry</i></li>
15037	<li><i>non-fatal warnings</i></li>
15038	</ul>
15039
15040	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15041	to @c true. In case of fatal errors, the virtual machine
15042	execution is always paused before calling this notification, and
15043	the notification handler is supposed either to immediately save
15044	the virtual machine state using <link to="IConsole::saveState"/>
15045	or power it off using <link to="IConsole::powerDown"/>.
15046	Resuming the execution can lead to unpredictable results.
15047
15048	<b>Non-fatal</b> errors and warnings are indicated by the
15049	@a fatal parameter set to @c false. If the virtual machine
15050	is in the Paused state by the time the error notification is
15051	received, it means that the user can <i>try to resume</i> the machine
15052	execution after attempting to solve the problem that caused the
15053	error. In this case, the notification handler is supposed
15054	to show an appropriate message to the user (depending on the
15055	value of the @a id parameter) that offers several actions such
15056	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15057	wants to retry, the notification handler should continue
15058	the machine execution using the <link to="IConsole::resume"/>
15059	call. If the machine execution is not Paused during this
15060	notification, then it means this notification is a <i>warning</i>
15061	(for example, about a fatal condition that can happen very soon);
15062	no immediate action is required from the user, the machine
15063	continues its normal execution.
15064
15065	Note that in either case the notification handler
15066	<b>must not</b> perform any action directly on a thread
15067	where this notification is called. Everything it is allowed to
15068	do is to post a message to another thread that will then talk
15069	to the user and take the corresponding action.
15070
15071	Currently, the following error identifiers are known:
15072	<ul>
15073	<li><tt>"HostMemoryLow"</tt></li>
15074	<li><tt>"HostAudioNotResponding"</tt></li>
15075	<li><tt>"VDIStorageFull"</tt></li>
15076	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15077	</ul>
15078	</desc>
15079	<attribute name="fatal" type="boolean" readonly="yes">
15080	<desc>
15081	Whether the error is fatal or not.
15082	</desc>
15083	</attribute>
15084	<attribute name="id" type="wstring" readonly="yes">
15085	<desc>
15086	Error identifier.
15087	</desc>
15088	</attribute>
15089	<attribute name="message" type="wstring" readonly="yes">
15090	<desc>
15091	Optional error message.
15092	</desc>
15093	</attribute>
15094	</interface>
15095
15096
15097	<interface
15098	name="IEventSourceChangedEvent" extends="IEvent"
15099	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15100	waitable="yes"
15101	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15102	>
15103	<desc>
15104	Notification when an event source state changes (listener added or removed).
15105	</desc>
15106
15107	<attribute name="listener" type="IEventListener" readonly="yes">
15108	<desc>
15109	Event listener which has changed.
15110	</desc>
15111	</attribute>
15112
15113	<attribute name="add" type="boolean" readonly="yes">
15114	<desc>
15115	Flag whether listener was added or removed.
15116	</desc>
15117	</attribute>
15118	</interface>
15119
15120	<interface
15121	name="IExtraDataChangedEvent" extends="IEvent"
15122	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15123	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15124	>
15125	<desc>
15126	Notification when machine specific or global extra data
15127	has changed.
15128	</desc>
15129	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15130	<desc>
15131	ID of the machine this event relates to.
15132	Null for global extra data changes.
15133	</desc>
15134	</attribute>
15135	<attribute name="key" type="wstring" readonly="yes">
15136	<desc>
15137	Extra data key that has changed.
15138	</desc>
15139	</attribute>
15140	<attribute name="value" type="wstring" readonly="yes">
15141	<desc>
15142	Extra data value for the given key.
15143	</desc>
15144	</attribute>
15145	</interface>
15146
15147	<interface
15148	name="IVetoEvent" extends="IEvent"
15149	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15150	wsmap="managed"
15151	>
15152	<desc>Base abstract interface for veto events.</desc>
15153
15154	<method name="addVeto">
15155	<desc>
15156	Adds a veto on this event.
15157	</desc>
15158	<param name="reason" type="wstring" dir="in">
15159	<desc>
15160	Reason for veto, could be null or empty string.
15161	</desc>
15162	</param>
15163	</method>
15164
15165	<method name="isVetoed">
15166	<desc>
15167	If this event was vetoed.
15168	</desc>
15169	<param name="result" type="boolean" dir="return">
15170	<desc>
15171	Reason for veto.
15172	</desc>
15173	</param>
15174	</method>
15175
15176	<method name="getVetos">
15177	<desc>
15178	Current veto reason list, if size is 0 - no veto.
15179	</desc>
15180	<param name="result" type="wstring" dir="return" safearray="yes">
15181	<desc>
15182	Array of reasons for veto provided by different event handlers.
15183	</desc>
15184	</param>
15185	</method>
15186
15187	</interface>
15188
15189	<interface
15190	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15191	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15192	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15193	waitable="true"
15194	>
15195	<desc>
15196	Notification when someone tries to change extra data for
15197	either the given machine or (if @c null) global extra data.
15198	This gives the chance to veto against changes.
15199	</desc>
15200	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15201	<desc>
15202	ID of the machine this event relates to.
15203	Null for global extra data changes.
15204	</desc>
15205	</attribute>
15206	<attribute name="key" type="wstring" readonly="yes">
15207	<desc>
15208	Extra data key that has changed.
15209	</desc>
15210	</attribute>
15211	<attribute name="value" type="wstring" readonly="yes">
15212	<desc>
15213	Extra data value for the given key.
15214	</desc>
15215	</attribute>
15216	</interface>
15217
15218	<interface
15219	name="ICanShowWindowEvent" extends="IVetoEvent"
15220	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15221	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15222	waitable="true"
15223	>
15224	<desc>
15225	Notification when a call to
15226	<link to="IMachine::canShowConsoleWindow"/> is made by a
15227	front-end to check if a subsequent call to
15228	<link to="IMachine::showConsoleWindow"/> can succeed.
15229
15230	The callee should give an answer appropriate to the current
15231	machine state using event veto. This answer must
15232	remain valid at least until the next
15233	<link to="IConsole::state">machine state</link> change.
15234	</desc>
15235	</interface>
15236
15237	<interface
15238	name="IShowWindowEvent" extends="IEvent"
15239	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15240	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15241	waitable="true"
15242	>
15243	<desc>
15244	Notification when a call to
15245	<link to="IMachine::showConsoleWindow"/>
15246	requests the console window to be activated and brought to
15247	foreground on the desktop of the host PC.
15248
15249	This notification should cause the VM console process to
15250	perform the requested action as described above. If it is
15251	impossible to do it at a time of this notification, this
15252	method should return a failure.
15253
15254	Note that many modern window managers on many platforms
15255	implement some sort of focus stealing prevention logic, so
15256	that it may be impossible to activate a window without the
15257	help of the currently active application (which is supposedly
15258	an initiator of this notification). In this case, this method
15259	must return a non-zero identifier that represents the
15260	top-level window of the VM console process. The caller, if it
15261	represents a currently active process, is responsible to use
15262	this identifier (in a platform-dependent manner) to perform
15263	actual window activation.
15264
15265	This method must set @a winId to zero if it has performed all
15266	actions necessary to complete the request and the console
15267	window is now active and in foreground, to indicate that no
15268	further action is required on the caller's side.
15269	</desc>
15270	<attribute name="winId" type="long long">
15271	<desc>
15272	Platform-dependent identifier of the top-level VM console
15273	window, or zero if this method has performed all actions
15274	necessary to implement the <i>show window</i> semantics for
15275	the given platform and/or this VirtualBox front-end.
15276	</desc>
15277	</attribute>
15278	</interface>
15279
15280	<module name="VBoxSVC" context="LocalServer">
15281	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15282	namespace="virtualbox.org">
15283	<interface name="IVirtualBox" default="yes"/>
15284	</class>
15285	</module>
15286
15287	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15288	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15289	namespace="virtualbox.org">
15290	<interface name="ISession" default="yes"/>
15291	</class>
15292
15293	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15294	namespace="virtualbox.org">
15295	<interface name="IConsole" default="yes"/>
15296	</class>
15297	</module>
15298
15299	</library>
15300
15301	</idl>
15302
15303	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format