VirtualBox.xidl@ 34821

Last change on this file since 34821 was 34821, checked in by vboxsync, 14 years ago
language
Property svn:eol-style set to `native`
File size: 591.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	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="Future" value="99999">
484	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
485	</const>
486	</enum>
487
488	<enum
489	name="AccessMode"
490	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
491	>
492	<desc>
493	Access mode for opening files.
494	</desc>
495
496	<const name="ReadOnly" value="1"/>
497	<const name="ReadWrite" value="2"/>
498	</enum>
499
500	<enum
501	name="MachineState"
502	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
503	>
504	<desc>
505	Virtual machine execution state.
506
507	This enumeration represents possible values of the <link
508	to="IMachine::state"/> attribute.
509
510	Below is the basic virtual machine state diagram. It shows how the state
511	changes during virtual machine execution. The text in square braces shows
512	a method of the IConsole interface that performs the given state
513	transition.
514
515	<pre>
516	+---------[powerDown()] <- Stuck <--[failure]-+
517	V \|
518	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
519	\| \| \| \| V \|
520	\| Aborted -----+ +--> Running --[pause()]--> Paused
521	\| \| ^ \| ^ \|
522	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
523	\| ^ \| \| \| \|
524	\| \| +-----------------------------------------+-\|-------------------+ +
525	\| \| \| \| \|
526	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
527	\| \| \| \|
528	\| +-------- Saving <--------[saveState()]<----------+---------------------+
529	\| \| \|
530	+-------------- Stopping -------[powerDown()]<----------+---------------------+
531	</pre>
532
533	Note that states to the right from PoweredOff, Aborted and Saved in the
534	above diagram are called <i>online VM states</i>. These states
535	represent the virtual machine which is being executed in a dedicated
536	process (usually with a GUI window attached to it where you can see the
537	activity of the virtual machine and interact with it). There are two
538	special pseudo-states, FirstOnline and LastOnline, that can be used in
539	relational expressions to detect if the given machine state is online or
540	not:
541
542	<pre>
543	if (machine.GetState() >= MachineState_FirstOnline &&
544	machine.GetState() <= MachineState_LastOnline)
545	{
546	...the machine is being executed...
547	}
548	</pre>
549
550	When the virtual machine is in one of the online VM states (that is, being
551	executed), only a few machine settings can be modified. Methods working
552	with such settings contain an explicit note about that. An attempt to
553	change any oter setting or perform a modifying operation during this time
554	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
555
556	All online states except Running, Paused and Stuck are transitional: they
557	represent temporary conditions of the virtual machine that will last as
558	long as the operation that initiated such a condition.
559
560	The Stuck state is a special case. It means that execution of the machine
561	has reached the "Guru Meditation" condition. This condition indicates an
562	internal VMM (virtual machine manager) failure which may happen as a
563	result of either an unhandled low-level virtual hardware exception or one
564	of the recompiler exceptions (such as the <i>too-many-traps</i>
565	condition).
566
567	Note also that any online VM state may transit to the Aborted state. This
568	happens if the process that is executing the virtual machine terminates
569	unexpectedly (for example, crashes). Other than that, the Aborted state is
570	equivalent to PoweredOff.
571
572	There are also a few additional state diagrams that do not deal with
573	virtual machine execution and therefore are shown separately. The states
574	shown on these diagrams are called <i>offline VM states</i> (this includes
575	PoweredOff, Aborted and Saved too).
576
577	The first diagram shows what happens when a lengthy setup operation is
578	being executed (such as <link to="IMachine::attachDevice"/>).
579
580	<pre>
581	+----------------------------------(same state as before the call)------+
582	\| \|
583	+-> PoweredOff --+ \|
584	\| \| \|
585	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
586	\| \|
587	+-> Saved -------+
588	</pre>
589
590	The next two diagrams demonstrate the process of taking a snapshot of a
591	powered off virtual machine, restoring the state to that as of a snapshot
592	or deleting a snapshot, respectively.
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| +-->[takeSnapshot()] -------------------> Saving ------+
599	+-> Aborted -----+
600
601	+-> PoweredOff --+
602	\| \|
603	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
604	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
605	+-> Saved -------+ \|
606	\| \|
607	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
608	</pre>
609
610	Note that the Saving state is present in both the offline state group and
611	online state group. Currently, the only way to determine what group is
612	assumed in a particular case is to remember the previous machine state: if
613	it was Running or Paused, then Saving is an online state, otherwise it is
614	an offline state. This inconsistency may be removed in one of the future
615	versions of VirtualBox by adding a new state.
616
617	<note internal="yes">
618	For whoever decides to touch this enum: In order to keep the
619	comparisons involving FirstOnline and LastOnline pseudo-states valid,
620	the numeric values of these states must be correspondingly updated if
621	needed: for any online VM state, the condition
622	<tt>FirstOnline <= state <= LastOnline</tt> must be
623	@c true. The same relates to transient states for which
624	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
625	@c true.
626	</note>
627	</desc>
628
629	<const name="Null" value="0">
630	<desc>Null value (never used by the API).</desc>
631	</const>
632	<const name="PoweredOff" value="1">
633	<desc>
634	The machine is not running and has no saved execution state; it has
635	either never been started or been shut down successfully.
636	</desc>
637	</const>
638	<const name="Saved" value="2">
639	<desc>
640	The machine is not currently running, but the execution state of the machine
641	has been saved to an external file when it was running, from where
642	it can be resumed.
643	</desc>
644	</const>
645	<const name="Teleported" value="3">
646	<desc>
647	The machine was teleported to a different host (or process) and then
648	powered off. Take care when powering it on again may corrupt resources
649	it shares with the teleportation target (e.g. disk and network).
650	</desc>
651	</const>
652	<const name="Aborted" value="4">
653	<desc>
654	The process running the machine has terminated abnormally. This may
655	indicate a crash of the VM process in host execution context, or
656	the VM process has been terminated externally.
657	</desc>
658	</const>
659	<const name="Running" value="5">
660	<desc>
661	The machine is currently being executed.
662	<note internal="yes">
663	For whoever decides to touch this enum: In order to keep the
664	comparisons in the old source code valid, this state must immediately
665	precede the Paused state.
666	TODO: Lift this spectacularly wonderful restriction.
667	</note>
668	</desc>
669	</const>
670	<const name="Paused" value="6">
671	<desc>
672	Execution of the machine has been paused.
673	<note internal="yes">
674	For whoever decides to touch this enum: In order to keep the
675	comparisons in the old source code valid, this state must immediately
676	follow the Running state.
677	TODO: Lift this spectacularly wonderful restriction.
678	</note>
679	</desc>
680	</const>
681	<const name="Stuck" value="7">
682	<desc>
683	Execution of the machine has reached the "Guru Meditation"
684	condition. This indicates a severe error in the hypervisor itself.
685	<note internal="yes">
686	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
687	"Guru", perhaps? Or are there some other VMM states that are
688	intended to be lumped in here as well?
689	</note>
690	</desc>
691	</const>
692	<const name="Teleporting" value="8">
693	<desc>
694	The machine is about to be teleported to a different host or process.
695	It is possible to pause a machine in this state, but it will go to the
696	@c TeleportingPausedVM state and it will not be
697	possible to resume it again unless the teleportation fails.
698	</desc>
699	</const>
700	<const name="LiveSnapshotting" value="9">
701	<desc>
702	A live snapshot is being taken. The machine is running normally, but
703	some of the runtime configuration options are inaccessible. Also, if
704	paused while in this state it will transition to
705	@c Saving and it will not be resume the
706	execution until the snapshot operation has completed.
707	</desc>
708	</const>
709	<const name="Starting" value="10">
710	<desc>
711	Machine is being started after powering it on from a
712	zero execution state.
713	</desc>
714	</const>
715	<const name="Stopping" value="11">
716	<desc>
717	Machine is being normally stopped powering it off, or after the guest OS
718	has initiated a shutdown sequence.
719	</desc>
720	</const>
721	<const name="Saving" value="12">
722	<desc>
723	Machine is saving its execution state to a file, or an online
724	snapshot of the machine is being taken.
725	</desc>
726	</const>
727	<const name="Restoring" value="13">
728	<desc>
729	Execution state of the machine is being restored from a file
730	after powering it on from the saved execution state.
731	</desc>
732	</const>
733	<const name="TeleportingPausedVM" value="14">
734	<desc>
735	The machine is being teleported to another host or process, but it is
736	not running. This is the paused variant of the
737	@c state.
738	</desc>
739	</const>
740	<const name="TeleportingIn" value="15">
741	<desc>
742	Teleporting the machine state in from another host or process.
743	</desc>
744	</const>
745	<const name="FaultTolerantSyncing" value="16">
746	<desc>
747	The machine is being synced with a fault tolerant VM running elsewhere.
748	</desc>
749	</const>
750	<const name="DeletingSnapshotOnline" value="17">
751	<desc>
752	Like @c DeletingSnapshot, but the merging of media is ongoing in
753	the background while the machine is running.
754	</desc>
755	</const>
756	<const name="DeletingSnapshotPaused" value="18">
757	<desc>
758	Like @c DeletingSnapshotOnline, but the machine was paused when the
759	merging of differencing media was started.
760	</desc>
761	</const>
762	<const name="RestoringSnapshot" value="19">
763	<desc>
764	A machine snapshot is being restored; this typically does not take long.
765	</desc>
766	</const>
767	<const name="DeletingSnapshot" value="20">
768	<desc>
769	A machine snapshot is being deleted; this can take a long time since this
770	may require merging differencing media. This value indicates that the
771	machine is not running while the snapshot is being deleted.
772	</desc>
773	</const>
774	<const name="SettingUp" value="21">
775	<desc>
776	Lengthy setup operation is in progress.
777	</desc>
778	</const>
779
780	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
781	<desc>
782	Pseudo-state: first online state (for use in relational expressions).
783	</desc>
784	</const>
785	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
786	<desc>
787	Pseudo-state: last online state (for use in relational expressions).
788	</desc>
789	</const>
790
791	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
792	<desc>
793	Pseudo-state: first transient state (for use in relational expressions).
794	</desc>
795	</const>
796	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
797	<desc>
798	Pseudo-state: last transient state (for use in relational expressions).
799	</desc>
800	</const>
801
802	</enum>
803
804	<enum
805	name="SessionState"
806	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
807	>
808	<desc>
809	Session state. This enumeration represents possible values of
810	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
811	attributes.
812	</desc>
813
814	<const name="Null" value="0">
815	<desc>Null value (never used by the API).</desc>
816	</const>
817	<const name="Unlocked" value="1">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is not locked for any sessions.
821
822	In <link to="ISession::state"/>, this means that no machine is
823	currently locked for this session.
824	</desc>
825	</const>
826	<const name="Locked" value="2">
827	<desc>
828	In <link to="IMachine::sessionState"/>, this means that the machine
829	is currently locked for a session, whose process identifier can
830	then be found in the <link to="IMachine::sessionPid" /> attribute.
831
832	In <link to="ISession::state"/>, this means that a machine is
833	currently locked for this session, and the mutable machine object
834	can be found in the <link to="ISession::machine"/> attribute
835	(see <link to="IMachine::lockMachine" /> for details).
836	</desc>
837	</const>
838	<const name="Spawning" value="3">
839	<desc>
840	A new process is being spawned for the machine as a result of
841	<link to="IMachine::launchVMProcess"/> call. This state also occurs
842	as a short transient state during an <link to="IMachine::lockMachine"/>
843	call.
844	</desc>
845	</const>
846	<const name="Unlocking" value="4">
847	<desc>
848	The session is being unlocked.
849	</desc>
850	</const>
851	</enum>
852
853	<enum
854	name="CPUPropertyType"
855	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
856	>
857	<desc>
858	Virtual CPU property type. This enumeration represents possible values of the
859	IMachine get- and setCPUProperty methods.
860	</desc>
861	<const name="Null" value="0">
862	<desc>Null value (never used by the API).</desc>
863	</const>
864	<const name="PAE" value="1">
865	<desc>
866	This setting determines whether VirtualBox will expose the Physical Address
867	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
868	is not available, it will not be reported.
869	</desc>
870	</const>
871	<const name="Synthetic" value="2">
872	<desc>
873	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
874	teleporting between host systems that differ significantly.
875	</desc>
876	</const>
877	</enum>
878
879
880	<enum
881	name="HWVirtExPropertyType"
882	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
883	>
884	<desc>
885	Hardware virtualization property type. This enumeration represents possible values
886	for the <link to="IMachine::getHWVirtExProperty"/> and
887	<link to="IMachine::setHWVirtExProperty"/> methods.
888	</desc>
889	<const name="Null" value="0">
890	<desc>Null value (never used by the API).</desc>
891	</const>
892	<const name="Enabled" value="1">
893	<desc>
894	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
895	such extensions are not available, they will not be used.
896	</desc>
897	</const>
898	<const name="Exclusive" value="2">
899	<desc>
900	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
901	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
902	feature of the host. To share these with other hypervisors, you must disable this property.
903	</desc>
904	</const>
905	<const name="VPID" value="3">
906	<desc>
907	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
908	</desc>
909	</const>
910	<const name="NestedPaging" value="4">
911	<desc>
912	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
913	</desc>
914	</const>
915	<const name="LargePages" value="5">
916	<desc>
917	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
918	</desc>
919	</const>
920	<const name="Force" value="6">
921	<desc>
922	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
923	not set, there will be an automatic fallback to software virtualization.
924	</desc>
925	</const>
926	</enum>
927
928	<enum
929	name="FaultToleranceState"
930	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
931	>
932	<desc>
933	Used with <link to="IMachine::faultToleranceState" />.
934	</desc>
935	<const name="Inactive" value="1">
936	<desc>No fault tolerance enabled.</desc>
937	</const>
938	<const name="Master" value="2">
939	<desc>Fault tolerant master VM.</desc>
940	</const>
941	<const name="Standby" value="3">
942	<desc>Fault tolerant standby VM.</desc>
943	</const>
944	</enum>
945
946	<enum
947	name="LockType"
948	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
949	>
950	<desc>
951	Used with <link to="IMachine::lockMachine" />.
952	</desc>
953	<const name="Write" value="2">
954	<desc>Lock the machine for writing.</desc>
955	</const>
956	<const name="Shared" value="1">
957	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
958	</const>
959	</enum>
960
961	<enum
962	name="SessionType"
963	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
964	>
965	<desc>
966	Session type. This enumeration represents possible values of the
967	<link to="ISession::type"/> attribute.
968	</desc>
969
970	<const name="Null" value="0">
971	<desc>Null value (never used by the API).</desc>
972	</const>
973	<const name="WriteLock" value="1">
974	<desc>
975	Session has acquired an exclusive write lock on a machine
976	using <link to="IMachine::lockMachine"/>.
977	</desc>
978	</const>
979	<const name="Remote" value="2">
980	<desc>
981	Session has launched a VM process using
982	<link to="IMachine::launchVMProcess"/>
983	</desc>
984	</const>
985	<const name="Shared" value="3">
986	<desc>
987	Session has obtained a link to another session using
988	<link to="IMachine::lockMachine"/>
989	</desc>
990	</const>
991	</enum>
992
993	<enum
994	name="DeviceType"
995	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
996	>
997	<desc>
998	Device type.
999	</desc>
1000	<const name="Null" value="0">
1001	<desc>
1002	Null value, may also mean "no device" (not allowed for
1003	<link to="IConsole::getDeviceActivity"/>).
1004	</desc>
1005	</const>
1006	<const name="Floppy" value="1">
1007	<desc>Floppy device.</desc>
1008	</const>
1009	<const name="DVD" value="2">
1010	<desc>CD/DVD-ROM device.</desc>
1011	</const>
1012	<const name="HardDisk" value="3">
1013	<desc>Hard disk device.</desc>
1014	</const>
1015	<const name="Network" value="4">
1016	<desc>Network device.</desc>
1017	</const>
1018	<const name="USB" value="5">
1019	<desc>USB device.</desc>
1020	</const>
1021	<const name="SharedFolder" value="6">
1022	<desc>Shared folder device.</desc>
1023	</const>
1024	</enum>
1025
1026	<enum
1027	name="DeviceActivity"
1028	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1029	>
1030	<desc>
1031	Device activity for <link to="IConsole::getDeviceActivity"/>.
1032	</desc>
1033
1034	<const name="Null" value="0"/>
1035	<const name="Idle" value="1"/>
1036	<const name="Reading" value="2"/>
1037	<const name="Writing" value="3"/>
1038	</enum>
1039
1040	<enum
1041	name="ClipboardMode"
1042	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1043	>
1044	<desc>
1045	Host-Guest clipboard interchange mode.
1046	</desc>
1047
1048	<const name="Disabled" value="0"/>
1049	<const name="HostToGuest" value="1"/>
1050	<const name="GuestToHost" value="2"/>
1051	<const name="Bidirectional" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="Scope"
1056	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1057	>
1058	<desc>
1059	Scope of the operation.
1060
1061	A generic enumeration used in various methods to define the action or
1062	argument scope.
1063	</desc>
1064
1065	<const name="Global" value="0"/>
1066	<const name="Machine" value="1"/>
1067	<const name="Session" value="2"/>
1068	</enum>
1069
1070	<enum
1071	name="BIOSBootMenuMode"
1072	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1073	>
1074	<desc>
1075	BIOS boot menu mode.
1076	</desc>
1077
1078	<const name="Disabled" value="0"/>
1079	<const name="MenuOnly" value="1"/>
1080	<const name="MessageAndMenu" value="2"/>
1081	</enum>
1082
1083	<enum
1084	name="ProcessorFeature"
1085	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1086	>
1087	<desc>
1088	CPU features.
1089	</desc>
1090
1091	<const name="HWVirtEx" value="0"/>
1092	<const name="PAE" value="1"/>
1093	<const name="LongMode" value="2"/>
1094	<const name="NestedPaging" value="3"/>
1095	</enum>
1096
1097	<enum
1098	name="FirmwareType"
1099	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1100	>
1101	<desc>
1102	Firmware type.
1103	</desc>
1104	<const name="BIOS" value="1">
1105	<desc>BIOS Firmware.</desc>
1106	</const>
1107	<const name="EFI" value="2">
1108	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1109	</const>
1110	<const name="EFI32" value="3">
1111	<desc>Efi firmware, 32-bit.</desc>
1112	</const>
1113	<const name="EFI64" value="4">
1114	<desc>Efi firmware, 64-bit.</desc>
1115	</const>
1116	<const name="EFIDUAL" value="5">
1117	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1118	</const>
1119	</enum>
1120
1121	<enum
1122	name="PointingHidType"
1123	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1124	>
1125	<desc>
1126	Type of pointing device used in a virtual machine.
1127	</desc>
1128	<const name="None" value="1">
1129	<desc>No mouse.</desc>
1130	</const>
1131	<const name="PS2Mouse" value="2">
1132	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1133	</const>
1134	<const name="USBMouse" value="3">
1135	<desc>USB mouse (relative pointer).</desc>
1136	</const>
1137	<const name="USBTablet" value="4">
1138	<desc>USB tablet (absolute pointer).</desc>
1139	</const>
1140	<const name="ComboMouse" value="5">
1141	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1142	Using of such device can have negative performance implications. </desc>
1143	</const>
1144	</enum>
1145
1146	<enum
1147	name="KeyboardHidType"
1148	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1149	>
1150	<desc>
1151	Type of keyboard device used in a virtual machine.
1152	</desc>
1153	<const name="None" value="1">
1154	<desc>No keyboard.</desc>
1155	</const>
1156	<const name="PS2Keyboard" value="2">
1157	<desc>PS/2 keyboard.</desc>
1158	</const>
1159	<const name="USBKeyboard" value="3">
1160	<desc>USB keyboard.</desc>
1161	</const>
1162	<const name="ComboKeyboard" value="4">
1163	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1164	Using of such device can have negative performance implications. </desc>
1165	</const>
1166	</enum>
1167
1168	<!--
1169	// IVirtualBoxErrorInfo
1170	/////////////////////////////////////////////////////////////////////////
1171	-->
1172
1173	<interface
1174	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1175	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1176	supportsErrorInfo="no"
1177	wsmap="managed"
1178	>
1179	<desc>
1180	The IVirtualBoxErrorInfo interface represents extended error information.
1181
1182	Extended error information can be set by VirtualBox components after
1183	unsuccessful or partially successful method invocation. This information
1184	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1185	and then shown to the client in addition to the plain 32-bit result code.
1186
1187	In MS COM, this interface extends the IErrorInfo interface,
1188	in XPCOM, it extends the nsIException interface. In both cases,
1189	it provides a set of common attributes to retrieve error
1190	information.
1191
1192	Sometimes invocation of some component's method may involve methods of
1193	other components that may also fail (independently of this method's
1194	failure), or a series of non-fatal errors may precede a fatal error that
1195	causes method failure. In cases like that, it may be desirable to preserve
1196	information about all errors happened during method invocation and deliver
1197	it to the caller. The <link to="#next"/> attribute is intended
1198	specifically for this purpose and allows to represent a chain of errors
1199	through a single IVirtualBoxErrorInfo object set after method invocation.
1200
1201	Note that errors are stored to a chain in the reverse order, i.e. the
1202	initial error object you query right after method invocation is the last
1203	error set by the callee, the object it points to in the @a next attribute
1204	is the previous error and so on, up to the first error (which is the last
1205	in the chain).
1206	</desc>
1207
1208	<attribute name="resultCode" type="long" readonly="yes">
1209	<desc>
1210	Result code of the error.
1211	Usually, it will be the same as the result code returned
1212	by the method that provided this error information, but not
1213	always. For example, on Win32, CoCreateInstance() will most
1214	likely return E_NOINTERFACE upon unsuccessful component
1215	instantiation attempt, but not the value the component factory
1216	returned. Value is typed 'long', not 'result',
1217	to make interface usable from scripting languages.
1218	<note>
1219	In MS COM, there is no equivalent.
1220	In XPCOM, it is the same as nsIException::result.
1221	</note>
1222	</desc>
1223	</attribute>
1224
1225	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1226	<desc>
1227	UUID of the interface that defined the error.
1228	<note>
1229	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1230	data type.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="component" type="wstring" readonly="yes">
1237	<desc>
1238	Name of the component that generated the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetSource.
1241	In XPCOM, there is no equivalent.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="text" type="wstring" readonly="yes">
1247	<desc>
1248	Text description of the error.
1249	<note>
1250	In MS COM, it is the same as IErrorInfo::GetDescription.
1251	In XPCOM, it is the same as nsIException::message.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1257	<desc>
1258	Next error object if there is any, or @c null otherwise.
1259	<note>
1260	In MS COM, there is no equivalent.
1261	In XPCOM, it is the same as nsIException::inner.
1262	</note>
1263	</desc>
1264	</attribute>
1265
1266	</interface>
1267
1268	<!--
1269	// IVirtualBox
1270	/////////////////////////////////////////////////////////////////////////
1271	-->
1272
1273	<interface
1274	name="IDHCPServer" extends="$unknown"
1275	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1276	wsmap="managed"
1277	>
1278	<desc>
1279	The IDHCPServer interface represents the vbox dhcp server configuration.
1280
1281	To enumerate all the dhcp servers on the host, use the
1282	<link to="IVirtualBox::DHCPServers"/> attribute.
1283	</desc>
1284
1285	<attribute name="enabled" type="boolean">
1286	<desc>
1287	specifies if the dhcp server is enabled
1288	</desc>
1289	</attribute>
1290
1291	<attribute name="IPAddress" type="wstring" readonly="yes">
1292	<desc>
1293	specifies server IP
1294	</desc>
1295	</attribute>
1296
1297	<attribute name="networkMask" type="wstring" readonly="yes">
1298	<desc>
1299	specifies server network mask
1300	</desc>
1301	</attribute>
1302
1303	<attribute name="networkName" type="wstring" readonly="yes">
1304	<desc>
1305	specifies internal network name the server is used for
1306	</desc>
1307	</attribute>
1308
1309	<attribute name="lowerIP" type="wstring" readonly="yes">
1310	<desc>
1311	specifies from IP address in server address range
1312	</desc>
1313	</attribute>
1314
1315	<attribute name="upperIP" type="wstring" readonly="yes">
1316	<desc>
1317	specifies to IP address in server address range
1318	</desc>
1319	</attribute>
1320
1321	<method name="setConfiguration">
1322	<desc>
1323	configures the server
1324	<result name="E_INVALIDARG">
1325	invalid configuration supplied
1326	</result>
1327	</desc>
1328	<param name="IPAddress" type="wstring" dir="in">
1329	<desc>
1330	server IP address
1331	</desc>
1332	</param>
1333	<param name="networkMask" type="wstring" dir="in">
1334	<desc>
1335	server network mask
1336	</desc>
1337	</param>
1338	<param name="FromIPAddress" type="wstring" dir="in">
1339	<desc>
1340	server From IP address for address range
1341	</desc>
1342	</param>
1343	<param name="ToIPAddress" type="wstring" dir="in">
1344	<desc>
1345	server To IP address for address range
1346	</desc>
1347	</param>
1348	</method>
1349
1350	<method name="start">
1351	<desc>
1352	Starts DHCP server process.
1353	<result name="E_FAIL">
1354	Failed to start the process.
1355	</result>
1356	</desc>
1357	<param name="networkName" type="wstring" dir="in">
1358	<desc>
1359	Name of internal network DHCP server should attach to.
1360	</desc>
1361	</param>
1362	<param name="trunkName" type="wstring" dir="in">
1363	<desc>
1364	Name of internal network trunk.
1365	</desc>
1366	</param>
1367	<param name="trunkType" type="wstring" dir="in">
1368	<desc>
1369	Type of internal network trunk.
1370	</desc>
1371	</param>
1372	</method>
1373
1374	<method name="stop">
1375	<desc>
1376	Stops DHCP server process.
1377	<result name="E_FAIL">
1378	Failed to stop the process.
1379	</result>
1380	</desc>
1381	</method>
1382	</interface>
1383
1384	<interface
1385	name="IVirtualBox" extends="$unknown"
1386	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1387	wsmap="managed"
1388	>
1389	<desc>
1390	The IVirtualBox interface represents the main interface exposed by the
1391	product that provides virtual machine management.
1392
1393	An instance of IVirtualBox is required for the product to do anything
1394	useful. Even though the interface does not expose this, internally,
1395	IVirtualBox is implemented as a singleton and actually lives in the
1396	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1397	IVirtualBox can track the state of all virtual machines on a particular
1398	host, regardless of which frontend started them.
1399
1400	To enumerate all the virtual machines on the host, use the
1401	<link to="IVirtualBox::machines"/> attribute.
1402	</desc>
1403
1404	<attribute name="version" type="wstring" readonly="yes">
1405	<desc>
1406	A string representing the version number of the product. The
1407	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1408	last number represents the build number and will frequently change.
1409	</desc>
1410	</attribute>
1411
1412	<attribute name="revision" type="unsigned long" readonly="yes">
1413	<desc>
1414	The internal build revision number of the product.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="packageType" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the package type of this product. The
1421	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1422	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1423	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1424	this.
1425	</desc>
1426	</attribute>
1427
1428	<attribute name="homeFolder" type="wstring" readonly="yes">
1429	<desc>
1430	Full path to the directory where the global settings file,
1431	<tt>VirtualBox.xml</tt>, is stored.
1432
1433	In this version of VirtualBox, the value of this property is
1434	always <tt><user_dir>/.VirtualBox</tt> (where
1435	<tt><user_dir></tt> is the path to the user directory,
1436	as determined by the host OS), and cannot be changed.
1437
1438	This path is also used as the base to resolve relative paths in
1439	places where relative paths are allowed (unless otherwise
1440	expressly indicated).
1441	</desc>
1442	</attribute>
1443
1444	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1445	<desc>
1446	Full name of the global settings file.
1447	The value of this property corresponds to the value of
1448	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="host" type="IHost" readonly="yes">
1453	<desc>Associated host object.</desc>
1454	</attribute>
1455
1456	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1457	<desc>Associated system information object.</desc>
1458	</attribute>
1459
1460	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1461	<desc>
1462	Array of machine objects registered within this VirtualBox instance.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of medium objects known to this VirtualBox installation.
1469
1470	This array contains only base media. All differencing
1471	media of the given base medium can be enumerated using
1472	<link to="IMedium::children"/>.
1473	</desc>
1474	</attribute>
1475
1476	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1477	<desc>
1478	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1479	</desc>
1480	</attribute>
1481
1482	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1483	<desc>
1484	Array of floppy image objects currently in use by this VirtualBox instance.
1485	</desc>
1486	</attribute>
1487
1488	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1489
1490	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1491
1492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1493	<desc>
1494	Collection of global shared folders. Global shared folders are
1495	available to all virtual machines.
1496
1497	New shared folders are added to the collection using
1498	<link to="#createSharedFolder"/>. Existing shared folders can be
1499	removed using <link to="#removeSharedFolder"/>.
1500
1501	<note>
1502	In the current version of the product, global shared folders are not
1503	implemented and therefore this collection is always empty.
1504	</note>
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1509	<desc>
1510	Associated performance collector object.
1511	</desc>
1512	</attribute>
1513
1514	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1515	<desc>
1516	DHCP servers.
1517	</desc>
1518	</attribute>
1519
1520	<attribute name="eventSource" type="IEventSource" readonly="yes">
1521	<desc>
1522	Event source for VirtualBox events.
1523	</desc>
1524	</attribute>
1525
1526	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1527	<desc>
1528	The extension pack manager.
1529	</desc>
1530	</attribute>
1531
1532
1533	<method name="composeMachineFilename">
1534	<desc>
1535	Returns a recommended full path of the settings file name for a new virtual
1536	machine.
1537
1538	This API serves two purposes:
1539
1540	<ul>
1541	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1542	for the @a settingsFile argument there, which means that API should use
1543	a recommended default file name.</li>
1544
1545	<li>It can be called manually by a client software before creating a machine,
1546	e.g. if that client wants to pre-create the machine directory to create
1547	virtual hard disks in that directory together with the new machine
1548	settings file. In that case, the file name should be stripped from the
1549	full settings file path returned by this function to obtain the
1550	machine directory.</li>
1551	</ul>
1552
1553	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1554	details about the machine name.
1555
1556	If @a baseFolder is a @c null or empty string (which is recommended), the
1557	default machine settings folder
1558	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1559	a base folder for the created machine, resulting in a file name like
1560	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1561	will be used.
1562
1563	This method does not access the host disks. In particular, it does not check
1564	for whether a machine of this name already exists.
1565	</desc>
1566	<param name="name" type="wstring" dir="in">
1567	<desc>Suggested machine name.</desc>
1568	</param>
1569	<param name="baseFolder" type="wstring" dir="in">
1570	<desc>Base machine folder (optional).</desc>
1571	</param>
1572	<param name="file" type="wstring" dir="return">
1573	<desc>Fully qualified path where the machine would be created.</desc>
1574	</param>
1575	</method>
1576
1577	<method name="createMachine">
1578	<desc>
1579	Creates a new virtual machine by creating a machine settings file at
1580	the given location.
1581
1582	VirtualBox machine settings files use a custom XML dialect. Starting
1583	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1584	and machine files can be created at arbitrary locations.
1585
1586	However, it is is recommended that machines be created in the default
1587	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1588	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1589	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1590	is called automatically to have such a recommended name composed based
1591	on the machine name given in the @a name argument.
1592
1593	If the resulting settings file already exists, this method will fail,
1594	unless @a forceOverwrite is set.
1595
1596	The new machine is created unregistered, with the initial configuration
1597	set according to the specified guest OS type. A typical sequence of
1598	actions to create a new virtual machine is as follows:
1599
1600	<ol>
1601	<li>
1602	Call this method to have a new machine created. The returned machine
1603	object will be "mutable" allowing to change any machine property.
1604	</li>
1605
1606	<li>
1607	Configure the machine using the appropriate attributes and methods.
1608	</li>
1609
1610	<li>
1611	Call <link to="IMachine::saveSettings" /> to write the settings
1612	to the machine's XML settings file. The configuration of the newly
1613	created machine will not be saved to disk until this method is
1614	called.
1615	</li>
1616
1617	<li>
1618	Call <link to="#registerMachine" /> to add the machine to the list
1619	of machines known to VirtualBox.
1620	</li>
1621	</ol>
1622
1623	The specified guest OS type identifier must match an ID of one of known
1624	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1625	array.
1626
1627	Optionally, you may specify an UUID of to assign to the created machine.
1628	However, this is not recommended and you should normally pass an empty
1629	(@c null) UUID to this method so that a new UUID will be automatically
1630	generated for every created machine. You can use UUID
1631	00000000-0000-0000-0000-000000000000 as @c null value.
1632
1633	<note>
1634	There is no way to change the name of the settings file or
1635	subfolder of the created machine directly.
1636	</note>
1637
1638	<result name="VBOX_E_OBJECT_NOT_FOUND">
1639	@a osTypeId is invalid.
1640	</result>
1641	<result name="VBOX_E_FILE_ERROR">
1642	Resulting settings file name is invalid or the settings file already
1643	exists or could not be created due to an I/O error.
1644	</result>
1645	<result name="E_INVALIDARG">
1646	@a name is empty or @c null.
1647	</result>
1648	</desc>
1649
1650	<param name="settingsFile" type="wstring" dir="in">
1651	<desc>Fully qualified path where the settings file should be created,
1652	or NULL for a default folder and file based on the @a name argument
1653	(see <link to="#composeMachineFilename" />).</desc>
1654	</param>
1655	<param name="name" type="wstring" dir="in">
1656	<desc>Machine name.</desc>
1657	</param>
1658	<param name="osTypeId" type="wstring" dir="in">
1659	<desc>Guest OS Type ID.</desc>
1660	</param>
1661	<param name="id" type="uuid" mod="string" dir="in">
1662	<desc>Machine UUID (optional).</desc>
1663	</param>
1664	<param name="forceOverwrite" type="boolean" dir="in">
1665	<desc>If true, an existing machine settings file will be overwritten.</desc>
1666	</param>
1667	<param name="machine" type="IMachine" dir="return">
1668	<desc>Created machine object.</desc>
1669	</param>
1670	</method>
1671
1672	<method name="openMachine">
1673	<desc>
1674	Opens a virtual machine from the existing settings file.
1675	The opened machine remains unregistered until you call
1676	<link to="#registerMachine"/>.
1677
1678	The specified settings file name must be fully qualified.
1679	The file must exist and be a valid machine XML settings file
1680	whose contents will be used to construct the machine object.
1681
1682	<result name="VBOX_E_FILE_ERROR">
1683	Settings file name invalid, not found or sharing violation.
1684	</result>
1685	</desc>
1686	<param name="settingsFile" type="wstring" dir="in">
1687	<desc>
1688	Name of the machine settings file.
1689	</desc>
1690	</param>
1691	<param name="machine" type="IMachine" dir="return">
1692	<desc>Opened machine object.</desc>
1693	</param>
1694	<note>
1695	<link to="IMachine::settingsModified"/> will return
1696	@c false for the created machine, until any of machine settings
1697	are changed.
1698	</note>
1699	</method>
1700
1701	<method name="registerMachine">
1702	<desc>
1703
1704	Registers the machine previously created using
1705	<link to="#createMachine"/> or opened using
1706	<link to="#openMachine"/> within this VirtualBox installation. After
1707	successful method invocation, the
1708	<link to="IMachineRegisteredEvent"/> event is fired.
1709
1710	<note>
1711	This method implicitly calls <link to="IMachine::saveSettings"/>
1712	to save all current machine settings before registering it.
1713	</note>
1714
1715	<result name="VBOX_E_OBJECT_NOT_FOUND">
1716	No matching virtual machine found.
1717	</result>
1718	<result name="VBOX_E_INVALID_OBJECT_STATE">
1719	Virtual machine was not created within this VirtualBox instance.
1720	</result>
1721
1722	</desc>
1723	<param name="machine" type="IMachine" dir="in"/>
1724	</method>
1725
1726	<method name="findMachine">
1727	<desc>
1728	Attempts to find a virtual machine given its name or UUID.
1729
1730	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1731	cannot safely be determined.</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	Could not find registered machine matching @a nameOrId.
1735	</result>
1736
1737	</desc>
1738	<param name="nameOrId" type="wstring" dir="in">
1739	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1740	</param>
1741	<param name="machine" type="IMachine" dir="return">
1742	<desc>Machine object, if found.</desc>
1743	</param>
1744	</method>
1745
1746	<method name="createAppliance">
1747	<desc>
1748	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1749	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1750	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1751	</desc>
1752	<param name="appliance" type="IAppliance" dir="return">
1753	<desc>New appliance.</desc>
1754	</param>
1755	</method>
1756
1757	<method name="createHardDisk">
1758	<desc>
1759	Creates a new base medium object that will use the given storage
1760	format and location for medium data.
1761
1762	Note that the actual storage unit is not created by this method. In
1763	order to do it, and before you are able to attach the created medium
1764	to virtual machines, you must call one of the following methods to
1765	allocate a format-specific storage unit at the specified location:
1766	<ul>
1767	<li><link to="IMedium::createBaseStorage"/></li>
1768	<li><link to="IMedium::createDiffStorage"/></li>
1769	</ul>
1770
1771	Some medium attributes, such as <link to="IMedium::id"/>, may
1772	remain uninitialized until the medium storage unit is successfully
1773	created by one of the above methods.
1774
1775	After the storage unit is successfully created, it will be
1776	accessible through the <link to="#findMedium"/> method and can
1777	be found in the <link to="#hardDisks"/> array.
1778
1779	The list of all storage formats supported by this VirtualBox
1780	installation can be obtained using
1781	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1782	attribute is empty or @c null then the default storage format
1783	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1784	be used for creating a storage unit of the medium.
1785
1786	Note that the format of the location string is storage format specific.
1787	See <link to="IMedium::location"/> and IMedium for more details.
1788
1789	<result name="VBOX_E_OBJECT_NOT_FOUND">
1790	@a format identifier is invalid. See
1791	<link to="ISystemProperties::mediumFormats"/>.
1792	</result>
1793	<result name="VBOX_E_FILE_ERROR">
1794	@a location is a not valid file name (for file-based formats only).
1795	</result>
1796	</desc>
1797	<param name="format" type="wstring" dir="in">
1798	<desc>
1799	Identifier of the storage format to use for the new medium.
1800	</desc>
1801	</param>
1802	<param name="location" type="wstring" dir="in">
1803	<desc>
1804	Location of the storage unit for the new medium.
1805	</desc>
1806	</param>
1807	<param name="medium" type="IMedium" dir="return">
1808	<desc>Created medium object.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="openMedium">
1813	<desc>
1814	Opens a medium from an existing storage location.
1815
1816	Once a medium has been opened, it can be passed to other VirtualBox
1817	methods, in particular to <link to="IMachine::attachDevice" />.
1818
1819	Depending on the given device type, the file at the storage location
1820	must be in one of the media formats understood by VirtualBox:
1821
1822	<ul>
1823	<li>With a "HardDisk" device type, the file must be a hard disk image
1824	in one of the formats supported by VirtualBox (see
1825	<link to="ISystemProperties::mediumFormats" />).
1826	After this method succeeds, if the medium is a base medium, it
1827	will be added to the <link to="#hardDisks"/> array attribute. </li>
1828	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1829	After this method succeeds, the medium will be added to the
1830	<link to="#DVDImages"/> array attribute.</li>
1831	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1832	After this method succeeds, the medium will be added to the
1833	<link to="#floppyImages"/> array attribute.</li>
1834	</ul>
1835
1836	After having been opened, the medium can be found by the <link to="#findMedium"/>
1837	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1838
1839	The UUID of the newly opened medium will either be retrieved from the
1840	storage location, if the format supports it (e.g. for hard disk images),
1841	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1842	If for some reason you need to change the medium's UUID, use
1843	<link to="IMedium::setIDs" />.
1844
1845	If a differencing hard disk medium is to be opened by this method, the
1846	operation will succeed only if its parent medium and all ancestors,
1847	if any, are already known to this VirtualBox installation (for example,
1848	were opened by this method before).
1849
1850	This method attempts to guess the storage format of the specified medium
1851	by reading medium data at the specified location.
1852
1853	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1854	the image is opened for read/write access and must have according permissions,
1855	as VirtualBox may actually write status information into the disk's metadata
1856	sections.
1857
1858	Note that write access is required for all typical hard disk usage in VirtualBox,
1859	since VirtualBox may need to write metadata such as a UUID into the image.
1860	The only exception is opening a source image temporarily for copying and
1861	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1862	again soon.
1863
1864	The format of the location string is storage format specific. See
1865	<link to="IMedium::location"/> and IMedium for more details.
1866
1867	Prior to VirtualBox 4.0, opening a medium added it to a global media
1868	registry in the VirtualBox.xml file, which was shared between all machines
1869	and made transporting machines and their media from one host to another
1870	difficult.
1871
1872	Starting with VirtualBox 4.0, media are only added to a registry when
1873	they are attached to a machine. Machines created with VirtualBox 4.0
1874	or later can have their own media registry. As a result, a medium attached
1875	to such a machine will be remembered in that machine's XML settings file.
1876	Media attached to older machines will continue to be added to the global
1877	registry.
1878
1879	<result name="VBOX_E_FILE_ERROR">
1880	Invalid medium storage file location or could not find the medium
1881	at the specified location.
1882	</result>
1883	<result name="VBOX_E_IPRT_ERROR">
1884	Could not get medium storage format.
1885	</result>
1886	<result name="E_INVALIDARG">
1887	Invalid medium storage format.
1888	</result>
1889	<result name="VBOX_E_INVALID_OBJECT_STATE">
1890	Medium has already been added to a media registry.
1891	</result>
1892	</desc>
1893	<param name="location" type="wstring" dir="in">
1894	<desc>
1895	Location of the storage unit that contains medium data in one of
1896	the supported storage formats.
1897	</desc>
1898	</param>
1899	<param name="deviceType" type="DeviceType" dir="in">
1900	<desc>
1901	Must be one of "HardDisk", "DVD" or "Floppy".
1902	</desc>
1903	</param>
1904	<param name="accessMode" type="AccessMode" dir="in">
1905	<desc>Whether to open the image in read/write or read-only mode. For
1906	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Opened medium object.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="findMedium">
1914	<desc>
1915	Returns a medium of the given type that uses the given fully qualified
1916	location or UUID to store medium data.
1917
1918	The given medium must be known to this VirtualBox installation, i.e.
1919	it must be previously created by <link to="#createHardDisk"/> or opened
1920	by <link to="#openMedium"/>.
1921
1922	The search is done by comparing the value of the @a location argument to
1923	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1924	attributes of each known medium.
1925
1926	On case sensitive file systems, a case sensitive comparison is performed,
1927	otherwise the case of symbols in the file path is ignored.
1928
1929	<result name="VBOX_E_OBJECT_NOT_FOUND">
1930	No medium object matching @a location found.
1931	</result>
1932	</desc>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1935	</param>
1936	<param name="type" type="DeviceType" dir="in">
1937	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Medium object, if found.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="getGuestOSType">
1945	<desc>
1946	Returns an object describing the specified guest OS type.
1947
1948	The requested guest OS type is specified using a string which is a
1949	mnemonic identifier of the guest operating system, such as
1950	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1951	particular virtual machine can be read or set using the
1952	<link to="IMachine::OSTypeId"/> attribute.
1953
1954	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1955	available guest OS type objects. Each object has an
1956	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1957	the guest OS this object describes.
1958
1959	<result name="E_INVALIDARG">
1960	@a id is not a valid Guest OS type.
1961	</result>
1962
1963	</desc>
1964	<param name="id" type="uuid" mod="string" dir="in">
1965	<desc>Guest OS type ID string.</desc>
1966	</param>
1967	<param name="type" type="IGuestOSType" dir="return">
1968	<desc>Guest OS type object.</desc>
1969	</param>
1970	</method>
1971
1972	<method name="createSharedFolder">
1973	<desc>
1974	Creates a new global shared folder by associating the given logical
1975	name with the given host path, adds it to the collection of shared
1976	folders and starts sharing it. Refer to the description of
1977	<link to="ISharedFolder"/> to read more about logical names.
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>Unique logical name of the shared folder.</desc>
1985	</param>
1986	<param name="hostPath" type="wstring" dir="in">
1987	<desc>Full path to the shared folder in the host file system.</desc>
1988	</param>
1989	<param name="writable" type="boolean" dir="in">
1990	<desc>Whether the share is writable or readonly</desc>
1991	</param>
1992	<param name="automount" type="boolean" dir="in">
1993	<desc>Whether the share gets automatically mounted by the guest
1994	or not.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="removeSharedFolder">
1999	<desc>
2000	Removes the global shared folder with the given name previously
2001	created by <link to="#createSharedFolder"/> from the collection of
2002	shared folders and stops sharing it.
2003	<note>
2004	In the current implementation, this operation is not
2005	implemented.
2006	</note>
2007	</desc>
2008	<param name="name" type="wstring" dir="in">
2009	<desc>Logical name of the shared folder to remove.</desc>
2010	</param>
2011	</method>
2012
2013	<method name="getExtraDataKeys">
2014	<desc>
2015	Returns an array representing the global extra data keys which currently
2016	have values defined.
2017	</desc>
2018	<param name="value" type="wstring" dir="return" safearray="yes">
2019	<desc>Array of extra data keys.</desc>
2020	</param>
2021	</method>
2022
2023	<method name="getExtraData">
2024	<desc>
2025	Returns associated global extra data.
2026
2027	If the requested data @a key does not exist, this function will
2028	succeed and return an empty string in the @a value argument.
2029
2030	<result name="VBOX_E_FILE_ERROR">
2031	Settings file not accessible.
2032	</result>
2033	<result name="VBOX_E_XML_ERROR">
2034	Could not parse the settings file.
2035	</result>
2036
2037	</desc>
2038	<param name="key" type="wstring" dir="in">
2039	<desc>Name of the data key to get.</desc>
2040	</param>
2041	<param name="value" type="wstring" dir="return">
2042	<desc>Value of the requested data key.</desc>
2043	</param>
2044	</method>
2045
2046	<method name="setExtraData">
2047	<desc>
2048	Sets associated global extra data.
2049
2050	If you pass @c null or empty string as a key @a value, the given @a key
2051	will be deleted.
2052
2053	<note>
2054	Before performing the actual data change, this method will ask all
2055	registered event listener using the
2056	<link to="IExtraDataCanChangeEvent"/>
2057	notification for a permission. If one of the listeners refuses the
2058	new value, the change will not be performed.
2059	</note>
2060	<note>
2061	On success, the
2062	<link to="IExtraDataChangedEvent"/> notification
2063	is called to inform all registered listeners about a successful data
2064	change.
2065	</note>
2066
2067	<result name="VBOX_E_FILE_ERROR">
2068	Settings file not accessible.
2069	</result>
2070	<result name="VBOX_E_XML_ERROR">
2071	Could not parse the settings file.
2072	</result>
2073	<result name="E_ACCESSDENIED">
2074	Modification request refused.
2075	</result>
2076
2077	</desc>
2078	<param name="key" type="wstring" dir="in">
2079	<desc>Name of the data key to set.</desc>
2080	</param>
2081	<param name="value" type="wstring" dir="in">
2082	<desc>Value to assign to the key.</desc>
2083	</param>
2084	</method>
2085
2086	<!--method name="createDHCPServerForInterface">
2087	<desc>
2088	Creates a dhcp server settings to be used for the given interface
2089	<result name="E_INVALIDARG">
2090	Host network interface @a name already exists.
2091	</result>
2092	</desc>
2093	<param name="interface" type="IHostNetworkInterface" dir="in">
2094	<desc>Network Interface</desc>
2095	</param>
2096	<param name="server" type="IDHCPServer" dir="out">
2097	<desc>Dhcp server settings</desc>
2098	</param>
2099	</method-->
2100
2101	<method name="createDHCPServer">
2102	<desc>
2103	Creates a dhcp server settings to be used for the given internal network name
2104	<result name="E_INVALIDARG">
2105	Host network interface @a name already exists.
2106	</result>
2107	</desc>
2108	<param name="name" type="wstring" dir="in">
2109	<desc>server name</desc>
2110	</param>
2111	<param name="server" type="IDHCPServer" dir="return">
2112	<desc>Dhcp server settings</desc>
2113	</param>
2114	</method>
2115
2116	<method name="findDHCPServerByNetworkName">
2117	<desc>
2118	Searches a dhcp server settings to be used for the given internal network name
2119	<result name="E_INVALIDARG">
2120	Host network interface @a name already exists.
2121	</result>
2122
2123	</desc>
2124	<param name="name" type="wstring" dir="in">
2125	<desc>server name</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="return">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method>
2131
2132	<!--method name="findDHCPServerForInterface">
2133	<desc>
2134	Searches a dhcp server settings to be used for the given interface
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="interface" type="IHostNetworkInterface" dir="in">
2140	<desc>Network Interface</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="out">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method-->
2146
2147	<method name="removeDHCPServer">
2148	<desc>
2149	Removes the dhcp server settings
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153	</desc>
2154	<param name="server" type="IDHCPServer" dir="in">
2155	<desc>Dhcp server settings to be removed</desc>
2156	</param>
2157	</method>
2158
2159
2160	<method name="checkFirmwarePresent">
2161	<desc>
2162	Check if this VirtualBox installation has a firmware
2163	of the given type available, either system-wide or per-user.
2164	Optionally, this may return a hint where this firmware can be
2165	downloaded from.
2166	</desc>
2167	<param name="firmwareType" type="FirmwareType" dir="in">
2168	<desc>
2169	Type of firmware to check.
2170	</desc>
2171	</param>
2172	<param name="version" type="wstring" dir="in">
2173	<desc>Expected version number, usually empty string (presently ignored).</desc>
2174	</param>
2175
2176	<param name="url" type="wstring" dir="out">
2177	<desc>
2178	Suggested URL to download this firmware from.
2179	</desc>
2180	</param>
2181
2182	<param name="file" type="wstring" dir="out">
2183	<desc>
2184	Filename of firmware, only valid if result == TRUE.
2185	</desc>
2186	</param>
2187
2188	<param name="result" type="boolean" dir="return">
2189	<desc>If firmware of this type and version is available.</desc>
2190	</param>
2191	</method>
2192
2193	</interface>
2194
2195	<!--
2196	// IVFSExplorer
2197	/////////////////////////////////////////////////////////////////////////
2198	-->
2199
2200	<enum
2201	name="VFSType"
2202	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2203	>
2204	<desc>
2205	Virtual file systems supported by VFSExplorer.
2206	</desc>
2207
2208	<const name="File" value="1" />
2209	<const name="Cloud" value="2" />
2210	<const name="S3" value="3" />
2211	<const name="WebDav" value="4" />
2212	</enum>
2213
2214	<enum
2215	name="VFSFileType"
2216	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2217	>
2218	<desc>
2219	File types known by VFSExplorer.
2220	</desc>
2221
2222	<const name="Unknown" value="1" />
2223	<const name="Fifo" value="2" />
2224	<const name="DevChar" value="3" />
2225	<const name="Directory" value="4" />
2226	<const name="DevBlock" value="5" />
2227	<const name="File" value="6" />
2228	<const name="SymLink" value="7" />
2229	<const name="Socket" value="8" />
2230	<const name="WhiteOut" value="9" />
2231	</enum>
2232
2233	<interface
2234	name="IVFSExplorer" extends="$unknown"
2235	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2236	wsmap="managed"
2237	>
2238	<desc>
2239	The VFSExplorer interface unifies access to different file system
2240	types. This includes local file systems as well remote file systems like
2241	S3. For a list of supported types see <link to="VFSType" />.
2242	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2243	</desc>
2244
2245	<attribute name="path" type="wstring" readonly="yes">
2246	<desc>Returns the current path in the virtual file system.</desc>
2247	</attribute>
2248
2249	<attribute name="type" type="VFSType" readonly="yes">
2250	<desc>Returns the file system type which is currently in use.</desc>
2251	</attribute>
2252
2253	<method name="update">
2254	<desc>Updates the internal list of files/directories from the
2255	current directory level. Use <link to="#entryList" /> to get the full list
2256	after a call to this method.</desc>
2257
2258	<param name="aProgress" type="IProgress" dir="return">
2259	<desc>Progress object to track the operation completion.</desc>
2260	</param>
2261	</method>
2262
2263	<method name="cd">
2264	<desc>Change the current directory level.</desc>
2265
2266	<param name="aDir" type="wstring" dir="in">
2267	<desc>The name of the directory to go in.</desc>
2268	</param>
2269
2270	<param name="aProgress" type="IProgress" dir="return">
2271	<desc>Progress object to track the operation completion.</desc>
2272	</param>
2273	</method>
2274
2275	<method name="cdUp">
2276	<desc>Go one directory upwards from the current directory level.</desc>
2277
2278	<param name="aProgress" type="IProgress" dir="return">
2279	<desc>Progress object to track the operation completion.</desc>
2280	</param>
2281	</method>
2282
2283	<method name="entryList">
2284	<desc>Returns a list of files/directories after a call to <link
2285	to="#update" />. The user is responsible for keeping this internal
2286	list up do date.</desc>
2287
2288	<param name="aNames" type="wstring" safearray="yes" dir="out">
2289	<desc>The list of names for the entries.</desc>
2290	</param>
2291
2292	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of types for the entries.</desc>
2294	</param>
2295
2296	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of sizes (in bytes) for the entries.</desc>
2298	</param>
2299
2300	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of file modes (in octal form) for the entries.</desc>
2302	</param>
2303	</method>
2304
2305	<method name="exists">
2306	<desc>Checks if the given file list exists in the current directory
2307	level.</desc>
2308
2309	<param name="aNames" type="wstring" safearray="yes" dir="in">
2310	<desc>The names to check.</desc>
2311	</param>
2312
2313	<param name="aExists" type="wstring" safearray="yes" dir="return">
2314	<desc>The names which exist.</desc>
2315	</param>
2316	</method>
2317
2318	<method name="remove">
2319	<desc>Deletes the given files in the current directory level.</desc>
2320
2321	<param name="aNames" type="wstring" safearray="yes" dir="in">
2322	<desc>The names to remove.</desc>
2323	</param>
2324
2325	<param name="aProgress" type="IProgress" dir="return">
2326	<desc>Progress object to track the operation completion.</desc>
2327	</param>
2328	</method>
2329
2330	</interface>
2331
2332	<!--
2333	// IAppliance
2334	/////////////////////////////////////////////////////////////////////////
2335	-->
2336
2337	<interface
2338	name="IAppliance" extends="$unknown"
2339	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2340	wsmap="managed"
2341	>
2342	<desc>
2343	Represents a platform-independent appliance in OVF format. An instance of this is returned
2344	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2345	virtual machines within an appliance with VirtualBox.
2346
2347	The OVF standard suggests two different physical file formats:
2348
2349	<ol>
2350	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2351	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2352	this descriptor file references other files such as disk images, as OVF appliances typically
2353	do, those additional files must be in the same directory as the descriptor file.</li>
2354
2355	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2356	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2357	files and optionally other files.
2358
2359	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2360	be added with a later version.</li>
2361	</ol>
2362
2363	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2364	<link to="IMachine" /> involves the following sequence of API calls:
2365
2366	<ol>
2367	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2368	</li>
2369
2370	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2371	would like to import. So long as this file is syntactically valid, this will succeed
2372	and fill the appliance object with the parsed data from the OVF file.
2373	</li>
2374
2375	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2376	contents of the IAppliance attributes accordingly. These can be inspected by a
2377	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2378	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2379	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2380	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2381	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2382	The GUI can then give the user the option to confirm and/or change these suggestions.
2383	</li>
2384
2385	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2386	virtual system (machine) to override the suggestions made by the interpret() routine.
2387	</li>
2388
2389	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2390	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2391	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2392	can be found in the <link to="#machines" /> array attribute.
2393	</li>
2394	</ol>
2395
2396	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2397
2398	<ol>
2399	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2400	an empty IAppliance object.
2401	</li>
2402
2403	<li>For each machine you would like to export, call <link to="IMachine::export" />
2404	with the IAppliance object you just created. Each such call creates one instance of
2405	<link to="IVirtualSystemDescription" /> inside the appliance.
2406	</li>
2407
2408	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2409	virtual system (machine) to override the suggestions made by the export() routine.
2410	</li>
2411
2412	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2413	file written.</li>
2414	</ol>
2415
2416	</desc>
2417
2418	<attribute name="path" type="wstring" readonly="yes">
2419	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2420	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2421	<link to="#write" /> (for export).
2422	This attribute is empty until one of these methods has been called.
2423	</desc>
2424	</attribute>
2425
2426	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2427	<desc>
2428	Array of virtual disk definitions. One such description exists for each
2429	disk definition in the OVF; each string array item represents one such piece of
2430	disk information, with the information fields separated by tab (\t) characters.
2431
2432	The caller should be prepared for additional fields being appended to
2433	this string in future versions of VirtualBox and therefore check for
2434	the number of tabs in the strings returned.
2435
2436	In the current version, the following eight fields are returned per string
2437	in the array:
2438
2439	<ol>
2440	<li>Disk ID (unique string identifier given to disk)</li>
2441
2442	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2443
2444	<li>Populated size (optional unsigned integer indicating the current size of the
2445	disk; can be approximate; -1 if unspecified)</li>
2446
2447	<li>Format (string identifying the disk format, typically
2448	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2449
2450	<li>Reference (where to find the disk image, typically a file name; if empty,
2451	then the disk should be created on import)</li>
2452
2453	<li>Image size (optional unsigned integer indicating the size of the image,
2454	which need not necessarily be the same as the values specified above, since
2455	the image may be compressed or sparse; -1 if not specified)</li>
2456
2457	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2458	presently unsupported and always -1)</li>
2459
2460	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2461	</ol>
2462	</desc>
2463	</attribute>
2464
2465	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2466	<desc> Array of virtual system descriptions. One such description is created
2467	for each virtual system (machine) found in the OVF.
2468	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2469	(for export) has been called.
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2474	<desc>
2475	Contains the UUIDs of the machines created from the information in this appliances. This is only
2476	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2477	succeeded.
2478	</desc>
2479	</attribute>
2480
2481	<method name="read">
2482	<desc>
2483	Reads an OVF file into the appliance object.
2484
2485	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2486	mere fact that this method returns successfully does not mean that VirtualBox supports all
2487	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2488	</desc>
2489	<param name="file" type="wstring" dir="in">
2490	<desc>
2491	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2492	on whether the appliance is distributed as a set of files or as a single file, respectively).
2493	</desc>
2494	</param>
2495	<param name="aProgress" type="IProgress" dir="return">
2496	<desc>Progress object to track the operation completion.</desc>
2497	</param>
2498	</method>
2499
2500	<method name="interpret">
2501	<desc>
2502	Interprets the OVF data that was read when the appliance was constructed. After
2503	calling this method, one can inspect the
2504	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2505	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2506	the appliance.
2507
2508	Calling this method is the second step of importing an appliance into VirtualBox;
2509	see <link to="IAppliance" /> for an overview.
2510
2511	After calling this method, one should call <link to="#getWarnings" /> to find out
2512	if problems were encountered during the processing which might later lead to
2513	errors.
2514	</desc>
2515	</method>
2516
2517	<method name="importMachines">
2518	<desc>
2519	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2520	and other interfaces that match the information contained in the appliance as
2521	closely as possible, as represented by the import instructions in the
2522	<link to="#virtualSystemDescriptions" /> array.
2523
2524	Calling this method is the final step of importing an appliance into VirtualBox;
2525	see <link to="IAppliance" /> for an overview.
2526
2527	Since importing the appliance will most probably involve copying and converting
2528	disk images, which can take a long time, this method operates asynchronously and
2529	returns an IProgress object to allow the caller to monitor the progress.
2530
2531	After the import succeeded, the UUIDs of the IMachine instances created can be
2532	retrieved from the <link to="#machines" /> array attribute.
2533	</desc>
2534
2535	<param name="aProgress" type="IProgress" dir="return">
2536	<desc>Progress object to track the operation completion.</desc>
2537	</param>
2538	</method>
2539
2540	<method name="createVFSExplorer">
2541	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2542
2543	<param name="aUri" type="wstring" dir="in">
2544	<desc>The URI describing the file system to use.</desc>
2545	</param>
2546
2547	<param name="aExplorer" type="IVFSExplorer" dir="return">
2548	<desc></desc>
2549	</param>
2550	</method>
2551
2552	<method name="write">
2553	<desc>
2554	Writes the contents of the appliance exports into a new OVF file.
2555
2556	Calling this method is the final step of exporting an appliance from VirtualBox;
2557	see <link to="IAppliance" /> for an overview.
2558
2559	Since exporting the appliance will most probably involve copying and converting
2560	disk images, which can take a long time, this method operates asynchronously and
2561	returns an IProgress object to allow the caller to monitor the progress.
2562	</desc>
2563	<param name="format" type="wstring" dir="in">
2564	<desc>
2565	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2566	future versions of VirtualBox may support additional formats.
2567	</desc>
2568	</param>
2569	<param name="manifest" type="boolean" dir="in">
2570	<desc>
2571	Indicate if the optional manifest file (.mf) should be written. The manifest file
2572	is used for integrity checks prior import.
2573	</desc>
2574	</param>
2575	<param name="path" type="wstring" dir="in">
2576	<desc>
2577	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2578	on whether the appliance is distributed as a set of files or as a single file, respectively).
2579	</desc>
2580	</param>
2581	<param name="progress" type="IProgress" dir="return">
2582	<desc>Progress object to track the operation completion.</desc>
2583	</param>
2584	</method>
2585
2586	<method name="getWarnings">
2587	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2588
2589	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	</interface>
2595
2596	<enum
2597	name="VirtualSystemDescriptionType"
2598	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2599	>
2600	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2601	a configuration value.</desc>
2602
2603	<const name="Ignore" value="1" />
2604	<const name="OS" value="2" />
2605	<const name="Name" value="3" />
2606	<const name="Product" value="4" />
2607	<const name="Vendor" value="5" />
2608	<const name="Version" value="6" />
2609	<const name="ProductUrl" value="7" />
2610	<const name="VendorUrl" value="8" />
2611	<const name="Description" value="9" />
2612	<const name="License" value="10" />
2613	<const name="Miscellaneous" value="11" />
2614	<const name="CPU" value="12" />
2615	<const name="Memory" value="13" />
2616	<const name="HardDiskControllerIDE" value="14" />
2617	<const name="HardDiskControllerSATA" value="15" />
2618	<const name="HardDiskControllerSCSI" value="16" />
2619	<const name="HardDiskControllerSAS" value="17" />
2620	<const name="HardDiskImage" value="18" />
2621	<const name="Floppy" value="19" />
2622	<const name="CDROM" value="20" />
2623	<const name="NetworkAdapter" value="21" />
2624	<const name="USBController" value="22" />
2625	<const name="SoundCard" value="23" />
2626
2627	</enum>
2628
2629	<enum
2630	name="VirtualSystemDescriptionValueType"
2631	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2632	>
2633	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2634	type to fetch.</desc>
2635
2636	<const name="Reference" value="1" />
2637	<const name="Original" value="2" />
2638	<const name="Auto" value="3" />
2639	<const name="ExtraConfig" value="4" />
2640
2641	</enum>
2642
2643	<interface
2644	name="IVirtualSystemDescription" extends="$unknown"
2645	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2646	wsmap="managed"
2647	>
2648
2649	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2650	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2651	<link to="IAppliance::interpret" /> has been called, that array contains information
2652	about how the virtual systems described in the OVF should best be imported into
2653	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2654	import an OVF into VirtualBox.
2655	</desc>
2656
2657	<attribute name="count" type="unsigned long" readonly="yes">
2658	<desc>Return the number of virtual system description entries.</desc>
2659	</attribute>
2660
2661	<method name="getDescription">
2662	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2663	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2664
2665	The list below identifies the value sets that are possible depending on the
2666	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2667	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2668	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2669	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2670	the @a aExtraConfigValues[] array item may also be used.
2671
2672	<ul>
2673	<li>
2674	"OS": the guest operating system type. There must be exactly one such array item on import. The
2675	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2676	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2677	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2678	</li>
2679	<li>
2680	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2681	if none is present on import, then an automatic name will be created from the operating system
2682	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2683	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2684	<link to="IMachine" /> name that does not exist yet.
2685	</li>
2686	<li>
2687	"Description": an arbitrary description.
2688	</li>
2689	<li>
2690	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2691	code to display such a license for agreement; the Main API does not enforce any such policy.
2692	</li>
2693	<li>
2694	Miscellaneous: reserved for future use.
2695	</li>
2696	<li>
2697	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2698	</li>
2699	<li>
2700	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2701	is present on import, then VirtualBox will set a meaningful default based on the operating system
2702	type.
2703	</li>
2704	<li>
2705	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2706	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2707	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2708	writes into the OVF.
2709	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2710	type can use to specify which hard disk controller a virtual disk should be connected to.
2711	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2712	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2713	its virtual machines supports four channels (primary master, primary slave, secondary master,
2714	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2715	</li>
2716	<li>
2717	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2718	has no value in @a aOvfValues[] or @a aVBoxValues[].
2719	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2720	</li>
2721	<li>
2722	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2723	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2724	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2725	whereas VirtualBox considers it a class of storage controllers of its own; see
2726	<link to="StorageControllerType" />).
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2731	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2732
2733	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2734	a path since the image file should be in the same location as the OVF file itself), whereas the
2735	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2736	hard disk image. This means that on import the image will be copied and converted from the
2737	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2738
2739	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2740	format: "controller=<index>;channel=<c>"
2741	In this string, <index> must be an integer specifying the hard disk controller to connect
2742	the image to. That number must be the index of an array item with one of the hard disk controller
2743	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2744	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2745	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2746	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2747	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2748	</li>
2749	<li>
2750	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2755	attachment information as with "HardDiskImage" items.
2756	</li>
2757	<li>
2758	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2759	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2760	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2761	</li>
2762	<li>
2763	"USBController": a USB controller. There can be at most one such item. If and only if such an
2764	item ispresent, USB support will be enabled for the new virtual machine.
2765	</li>
2766	<li>
2767	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2768	present, sound support will be enabled for the new virtual machine. Note that the virtual
2769	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2770	may be different from the virtual soundcard expected by the appliance.
2771	</li>
2772	</ul>
2773
2774	</desc>
2775
2776	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	</method>
2797
2798	<method name="getDescriptionByType">
2799	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2800	should be returned.</desc>
2801
2802	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	</method>
2827
2828	<method name="getValuesByType">
2829	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2830	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2831	values.</desc>
2832
2833	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2838	<desc></desc>
2839	</param>
2840
2841	<param name="aValues" type="wstring" dir="return" safearray="yes">
2842	<desc></desc>
2843	</param>
2844
2845	</method>
2846
2847	<method name="setFinalValues">
2848	<desc>
2849	This method allows the appliance's user to change the configuration for the virtual
2850	system descriptions. For each array item returned from <link to="#getDescription" />,
2851	you must pass in one boolean value and one configuration value.
2852
2853	Each item in the boolean array determines whether the particular configuration item
2854	should be enabled.
2855	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2856	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2857	and SoundCard.
2858
2859	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2860	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2861	the configuration remains unchanged. Please see the documentation for getDescription()
2862	for valid configuration values for the individual array item types. If the
2863	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2864	</desc>
2865
2866	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877	</method>
2878
2879	<method name="addDescription">
2880	<desc>
2881	This method adds an additional description entry to the stack of already
2882	available descriptions for this virtual system. This is handy for writing
2883	values which aren't directly supported by VirtualBox. One example would
2884	be the License type of <link to="VirtualSystemDescriptionType" />.
2885	</desc>
2886
2887	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aVBoxValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894
2895	<param name="aExtraConfigValue" type="wstring" dir="in">
2896	<desc></desc>
2897	</param>
2898	</method>
2899	</interface>
2900
2901
2902	<!--
2903	// IMachine
2904	/////////////////////////////////////////////////////////////////////////
2905	-->
2906
2907	<interface
2908	name="IInternalMachineControl" extends="$unknown"
2909	uuid="476126af-e223-4490-a8a0-b1f1575be013"
2910	internal="yes"
2911	wsmap="suppress"
2912	>
2913	<method name="setRemoveSavedStateFile">
2914	<desc>
2915	Updates the flag whether the saved state file is removed on a
2916	machine state change from Saved to PoweredOff.
2917	</desc>
2918	<param name="aRemove" type="boolean" dir="in"/>
2919	</method>
2920
2921	<method name="updateState">
2922	<desc>
2923	Updates the VM state.
2924	<note>
2925	This operation will also update the settings file with the correct
2926	information about the saved state file and delete this file from disk
2927	when appropriate.
2928	</note>
2929	</desc>
2930	<param name="state" type="MachineState" dir="in"/>
2931	</method>
2932
2933	<method name="getIPCId">
2934	<param name="id" type="wstring" dir="return"/>
2935	</method>
2936
2937	<method name="beginPowerUp">
2938	<desc>
2939	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2940	gives it the progress object that should be part of any pending
2941	<link to="IMachine::launchVMProcess"/> operations. The progress
2942	object may be called back to reflect an early cancelation, so some care
2943	have to be taken with respect to any cancelation callbacks. The console
2944	object will call <link to="IInternalMachineControl::endPowerUp"/>
2945	to signal the completion of the progress object.
2946	</desc>
2947	<param name="aProgress" type="IProgress" dir="in" />
2948	</method>
2949
2950	<method name="endPowerUp">
2951	<desc>
2952	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2953	This method may query status information from the progress object it
2954	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2955	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2956	call in order to complete that progress object.
2957	</desc>
2958	<param name="result" type="long" dir="in"/>
2959	</method>
2960
2961	<method name="runUSBDeviceFilters">
2962	<desc>
2963	Asks the server to run USB devices filters of the associated
2964	machine against the given USB device and tell if there is
2965	a match.
2966	<note>
2967	Intended to be used only for remote USB devices. Local
2968	ones don't require to call this method (this is done
2969	implicitly by the Host and USBProxyService).
2970	</note>
2971	</desc>
2972	<param name="device" type="IUSBDevice" dir="in"/>
2973	<param name="matched" type="boolean" dir="out"/>
2974	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
2975	</method>
2976
2977	<method name="captureUSBDevice">
2978	<desc>
2979	Requests a capture of the given host USB device.
2980	When the request is completed, the VM process will
2981	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
2982	notification.
2983	</desc>
2984	<param name="id" type="uuid" mod="string" dir="in"/>
2985	</method>
2986
2987	<method name="detachUSBDevice">
2988	<desc>
2989	Notification that a VM is going to detach (@a done = @c false) or has
2990	already detached (@a done = @c true) the given USB device.
2991	When the @a done = @c true request is completed, the VM process will
2992	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
2993	notification.
2994	<note>
2995	In the @a done = @c true case, the server must run its own filters
2996	and filters of all VMs but this one on the detached device
2997	as if it were just attached to the host computer.
2998	</note>
2999	</desc>
3000	<param name="id" type="uuid" mod="string" dir="in"/>
3001	<param name="done" type="boolean" dir="in"/>
3002	</method>
3003
3004	<method name="autoCaptureUSBDevices">
3005	<desc>
3006	Requests a capture all matching USB devices attached to the host.
3007	When the request is completed, the VM process will
3008	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3009	notification per every captured device.
3010	</desc>
3011	</method>
3012
3013	<method name="detachAllUSBDevices">
3014	<desc>
3015	Notification that a VM that is being powered down. The done
3016	parameter indicates whether which stage of the power down
3017	we're at. When @a done = @c false the VM is announcing its
3018	intentions, while when @a done = @c true the VM is reporting
3019	what it has done.
3020	<note>
3021	In the @a done = @c true case, the server must run its own filters
3022	and filters of all VMs but this one on all detach devices as
3023	if they were just attached to the host computer.
3024	</note>
3025	</desc>
3026	<param name="done" type="boolean" dir="in"/>
3027	</method>
3028
3029	<method name="onSessionEnd">
3030	<desc>
3031	Triggered by the given session object when the session is about
3032	to close normally.
3033	</desc>
3034	<param name="session" type="ISession" dir="in">
3035	<desc>Session that is being closed</desc>
3036	</param>
3037	<param name="progress" type="IProgress" dir="return">
3038	<desc>
3039	Used to wait until the corresponding machine is actually
3040	dissociated from the given session on the server.
3041	Returned only when this session is a direct one.
3042	</desc>
3043	</param>
3044	</method>
3045
3046	<method name="beginSavingState">
3047	<desc>
3048	Called by the VM process to inform the server it wants to
3049	save the current state and stop the VM execution.
3050	</desc>
3051	<param name="progress" type="IProgress" dir="out">
3052	<desc>
3053	Progress object created by VBoxSVC to wait until
3054	the state is saved.
3055	</desc>
3056	</param>
3057	<param name="stateFilePath" type="wstring" dir="out">
3058	<desc>
3059	File path the VM process must save the execution state to.
3060	</desc>
3061	</param>
3062	</method>
3063
3064	<method name="endSavingState">
3065	<desc>
3066	Called by the VM process to inform the server that saving
3067	the state previously requested by #beginSavingState is either
3068	successfully finished or there was a failure.
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
3077	</desc>
3078
3079	<param name="result" type="long" dir="in">
3080	<desc>@c S_OK to indicate success.
3081	</desc>
3082	</param>
3083	<param name="errMsg" type="wstring" dir="in">
3084	<desc>@c human readable error message in case of failure.
3085	</desc>
3086	</param>
3087	</method>
3088
3089	<method name="adoptSavedState">
3090	<desc>
3091	Gets called by IConsole::adoptSavedState.
3092	<result name="VBOX_E_FILE_ERROR">
3093	Invalid saved state file path.
3094	</result>
3095	</desc>
3096	<param name="savedStateFile" type="wstring" dir="in">
3097	<desc>Path to the saved state file to adopt.</desc>
3098	</param>
3099	</method>
3100
3101	<method name="beginTakingSnapshot">
3102	<desc>
3103	Called from the VM process to request from the server to perform the
3104	server-side actions of creating a snapshot (creating differencing images
3105	and the snapshot object).
3106
3107	<result name="VBOX_E_FILE_ERROR">
3108	Settings file not accessible.
3109	</result>
3110	<result name="VBOX_E_XML_ERROR">
3111	Could not parse the settings file.
3112	</result>
3113	</desc>
3114	<param name="initiator" type="IConsole" dir="in">
3115	<desc>The console object that initiated this call.</desc>
3116	</param>
3117	<param name="name" type="wstring" dir="in">
3118	<desc>Snapshot name.</desc>
3119	</param>
3120	<param name="description" type="wstring" dir="in">
3121	<desc>Snapshot description.</desc>
3122	</param>
3123	<param name="consoleProgress" type="IProgress" dir="in">
3124	<desc>
3125	Progress object created by the VM process tracking the
3126	snapshot's progress. This has the following sub-operations:
3127	<ul>
3128	<li>setting up (weight 1);</li>
3129	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3130	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3131	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3132	<li>finishing up (weight 1)</li>
3133	</ul>
3134	</desc>
3135	</param>
3136	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3137	<desc>
3138	Whether this is an online snapshot (i.e. the machine is running).
3139	</desc>
3140	</param>
3141	<param name="stateFilePath" type="wstring" dir="out">
3142	<desc>
3143	File path the VM process must save the execution state to.
3144	</desc>
3145	</param>
3146	</method>
3147
3148	<method name="endTakingSnapshot">
3149	<desc>
3150	Called by the VM process to inform the server that the snapshot
3151	previously requested by #beginTakingSnapshot is either
3152	successfully taken or there was a failure.
3153	</desc>
3154
3155	<param name="success" type="boolean" dir="in">
3156	<desc>@c true to indicate success and @c false otherwise</desc>
3157	</param>
3158	</method>
3159
3160	<method name="deleteSnapshot">
3161	<desc>
3162	Gets called by IConsole::deleteSnapshot.
3163	<result name="VBOX_E_INVALID_OBJECT_STATE">
3164	Snapshot has more than one child snapshot.
3165	</result>
3166	</desc>
3167	<param name="initiator" type="IConsole" dir="in">
3168	<desc>The console object that initiated this call.</desc>
3169	</param>
3170	<param name="id" type="uuid" mod="string" dir="in">
3171	<desc>UUID of the snapshot to delete.</desc>
3172	</param>
3173	<param name="machineState" type="MachineState" dir="out">
3174	<desc>New machine state after this operation is started.</desc>
3175	</param>
3176	<param name="progress" type="IProgress" dir="return">
3177	<desc>Progress object to track the operation completion.</desc>
3178	</param>
3179	</method>
3180
3181	<method name="finishOnlineMergeMedium">
3182	<desc>
3183	Gets called by IConsole::onlineMergeMedium.
3184	</desc>
3185	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3186	<desc>The medium attachment which needs to be cleaned up.</desc>
3187	</param>
3188	<param name="source" type="IMedium" dir="in">
3189	<desc>Merge source medium.</desc>
3190	</param>
3191	<param name="target" type="IMedium" dir="in">
3192	<desc>Merge target medium.</desc>
3193	</param>
3194	<param name="mergeForward" type="boolean" dir="in">
3195	<desc>Merge direction.</desc>
3196	</param>
3197	<param name="parentForTarget" type="IMedium" dir="in">
3198	<desc>For forward merges: new parent for target medium.</desc>
3199	</param>
3200	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3201	<desc>For backward merges: list of media which need their parent UUID
3202	updated.</desc>
3203	</param>
3204	</method>
3205
3206	<method name="restoreSnapshot">
3207	<desc>
3208	Gets called by IConsole::RestoreSnapshot.
3209	</desc>
3210	<param name="initiator" type="IConsole" dir="in">
3211	<desc>The console object that initiated this call.</desc>
3212	</param>
3213	<param name="snapshot" type="ISnapshot" dir="in">
3214	<desc>The snapshot to restore the VM state from.</desc>
3215	</param>
3216	<param name="machineState" type="MachineState" dir="out">
3217	<desc>New machine state after this operation is started.</desc>
3218	</param>
3219	<param name="progress" type="IProgress" dir="return">
3220	<desc>Progress object to track the operation completion.</desc>
3221	</param>
3222	</method>
3223
3224	<method name="pullGuestProperties">
3225	<desc>
3226	Get the list of the guest properties matching a set of patterns along
3227	with their values, time stamps and flags and give responsibility for
3228	managing properties to the console.
3229	</desc>
3230	<param name="name" type="wstring" dir="out" safearray="yes">
3231	<desc>
3232	The names of the properties returned.
3233	</desc>
3234	</param>
3235	<param name="value" type="wstring" dir="out" safearray="yes">
3236	<desc>
3237	The values of the properties returned. The array entries match the
3238	corresponding entries in the @a name array.
3239	</desc>
3240	</param>
3241	<param name="timestamp" type="long long" dir="out" safearray="yes">
3242	<desc>
3243	The time stamps of the properties returned. The array entries match
3244	the corresponding entries in the @a name array.
3245	</desc>
3246	</param>
3247	<param name="flags" type="wstring" dir="out" safearray="yes">
3248	<desc>
3249	The flags of the properties returned. The array entries match the
3250	corresponding entries in the @a name array.
3251	</desc>
3252	</param>
3253	</method>
3254
3255	<method name="pushGuestProperty">
3256	<desc>
3257	Update a single guest property in IMachine.
3258	</desc>
3259	<param name="name" type="wstring" dir="in">
3260	<desc>
3261	The name of the property to be updated.
3262	</desc>
3263	</param>
3264	<param name="value" type="wstring" dir="in">
3265	<desc>
3266	The value of the property.
3267	</desc>
3268	</param>
3269	<param name="timestamp" type="long long" dir="in">
3270	<desc>
3271	The timestamp of the property.
3272	</desc>
3273	</param>
3274	<param name="flags" type="wstring" dir="in">
3275	<desc>
3276	The flags of the property.
3277	</desc>
3278	</param>
3279	</method>
3280
3281	<method name="lockMedia">
3282	<desc>
3283	Locks all media attached to the machine for writing and parents of
3284	attached differencing media (if any) for reading. This operation is
3285	atomic so that if it fails no media is actually locked.
3286
3287	This method is intended to be called when the machine is in Starting or
3288	Restoring state. The locked media will be automatically unlocked when
3289	the machine is powered off or crashed.
3290	</desc>
3291	</method>
3292	<method name="unlockMedia">
3293	<desc>
3294	Unlocks all media previously locked using
3295	<link to="IInternalMachineControl::lockMedia"/>.
3296
3297	This method is intended to be used with teleportation so that it is
3298	possible to teleport between processes on the same machine.
3299	</desc>
3300	</method>
3301	</interface>
3302
3303	<interface
3304	name="IBIOSSettings" extends="$unknown"
3305	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3306	wsmap="managed"
3307	>
3308	<desc>
3309	The IBIOSSettings interface represents BIOS settings of the virtual
3310	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3311	</desc>
3312	<attribute name="logoFadeIn" type="boolean">
3313	<desc>Fade in flag for BIOS logo animation.</desc>
3314	</attribute>
3315
3316	<attribute name="logoFadeOut" type="boolean">
3317	<desc>Fade out flag for BIOS logo animation.</desc>
3318	</attribute>
3319
3320	<attribute name="logoDisplayTime" type="unsigned long">
3321	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3322	</attribute>
3323
3324	<attribute name="logoImagePath" type="wstring">
3325	<desc>
3326	Local file system path for external BIOS splash image. Empty string
3327	means the default image is shown on boot.
3328	</desc>
3329	</attribute>
3330
3331	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3332	<desc>Mode of the BIOS boot device menu.</desc>
3333	</attribute>
3334
3335	<attribute name="ACPIEnabled" type="boolean">
3336	<desc>ACPI support flag.</desc>
3337	</attribute>
3338
3339	<attribute name="IOAPICEnabled" type="boolean">
3340	<desc>
3341	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3342	and support IRQs above 15.
3343	</desc>
3344	</attribute>
3345
3346	<attribute name="timeOffset" type="long long">
3347	<desc>
3348	Offset in milliseconds from the host system time. This allows for
3349	guests running with a different system date/time than the host.
3350	It is equivalent to setting the system date/time in the BIOS except
3351	it is not an absolute value but a relative one. Guest Additions
3352	time synchronization honors this offset.
3353	</desc>
3354	</attribute>
3355
3356	<attribute name="PXEDebugEnabled" type="boolean">
3357	<desc>
3358	PXE debug logging flag. If set, VirtualBox will write extensive
3359	PXE trace information to the release log.
3360	</desc>
3361	</attribute>
3362
3363	</interface>
3364
3365	<enum
3366	name="CleanupMode"
3367	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3368	>
3369	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3370	</desc>
3371	<const name="UnregisterOnly" value="1">
3372	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3373	</const>
3374	<const name="DetachAllReturnNone" value="2">
3375	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3376	</const>
3377	<const name="DetachAllReturnHardDisksOnly" value="3">
3378	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3379	</const>
3380	<const name="Full" value="4">
3381	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3382	</const>
3383	</enum>
3384
3385	<interface
3386	name="IEventContext" extends="$unknown"
3387	uuid="7563F4E7-1583-40F7-B4C4-C9BA02CB0AE3"
3388	wsmap="managed"
3389	>
3390	<desc>
3391	Placeholder class for event contexts.
3392	</desc>
3393	</interface>
3394
3395
3396	<interface
3397	name="IPciAddress" extends="$unknown"
3398	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3399	wsmap="struct"
3400	>
3401
3402	<desc>
3403	Address on the PCI bus.
3404	</desc>
3405
3406	<attribute name="bus" type="short">
3407	<desc>
3408	Bus number.
3409	</desc>
3410	</attribute>
3411
3412	<attribute name="device" type="short">
3413	<desc>
3414	Device number.
3415	</desc>
3416	</attribute>
3417
3418	<attribute name="devFunction" type="short">
3419	<desc>
3420	Device function number.
3421	</desc>
3422	</attribute>
3423
3424	<method name="asLong">
3425	<desc>
3426	Convert PCI address into long.
3427	</desc>
3428	<param name="result" type="long" dir="return" />
3429	</method>
3430
3431	<method name="fromLong">
3432	<desc>
3433	Make PCI address from long.
3434	</desc>
3435	<param name="number" type="long" dir="in" />
3436	</method>
3437	</interface>
3438
3439	<interface
3440	name="IPciDeviceAttachment" extends="$unknown"
3441	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3442	wsmap="struct"
3443	>
3444
3445	<desc>
3446	Information about PCI attachments.
3447	</desc>
3448
3449	<attribute name="name" type="wstring" readonly="yes">
3450	<desc>
3451	Device name.
3452	</desc>
3453	</attribute>
3454
3455	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3456	<desc>
3457	If this is physical or virtual device.
3458	</desc>
3459	</attribute>
3460
3461	<attribute name="hostAddress" type="long" readonly="yes">
3462	<desc>
3463	Address of device on the host, applicable only to host devices.
3464	</desc>
3465	</attribute>
3466
3467	<attribute name="guestAddress" type="long" readonly="yes">
3468	<desc>
3469	Address of device on the guest.
3470	</desc>
3471	</attribute>
3472
3473	</interface>
3474
3475
3476	<interface
3477	name="IMachine" extends="$unknown"
3478	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3479	wsmap="managed"
3480	>
3481	<desc>
3482	The IMachine interface represents a virtual machine, or guest, created
3483	in VirtualBox.
3484
3485	This interface is used in two contexts. First of all, a collection of
3486	objects implementing this interface is stored in the
3487	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3488	machines that are currently registered with this VirtualBox
3489	installation. Also, once a session has been opened for the given virtual
3490	machine (e.g. the virtual machine is running), the machine object
3491	associated with the open session can be queried from the session object;
3492	see <link to="ISession"/> for details.
3493
3494	The main role of this interface is to expose the settings of the virtual
3495	machine and provide methods to change various aspects of the virtual
3496	machine's configuration. For machine objects stored in the
3497	<link to="IVirtualBox::machines"/> collection, all attributes are
3498	read-only unless explicitly stated otherwise in individual attribute
3499	and method descriptions.
3500
3501	In order to change a machine setting, a session for this machine must be
3502	opened using one of the <link to="IMachine::lockMachine" /> or
3503	<link to="IMachine::launchVMProcess"/> methods. After the
3504	machine has been successfully locked for a session, a mutable machine object
3505	needs to be queried from the session object and then the desired settings
3506	changes can be applied to the returned object using IMachine attributes and
3507	methods. See the <link to="ISession"/> interface description for more
3508	information about sessions.
3509
3510	Note that IMachine does not provide methods to control virtual machine
3511	execution (such as start the machine, or power it down) -- these methods
3512	are grouped in a separate interface called <link to="IConsole" />.
3513
3514	<see>ISession, IConsole</see>
3515	</desc>
3516
3517	<attribute name="parent" type="IVirtualBox" readonly="yes">
3518	<desc>Associated parent object.</desc>
3519	</attribute>
3520
3521	<attribute name="accessible" type="boolean" readonly="yes">
3522	<desc>
3523	Whether this virtual machine is currently accessible or not.
3524
3525	A machine is always deemed accessible unless it is registered <i>and</i>
3526	its settings file cannot be read or parsed (either because the file itself
3527	is unavailable or has invalid XML contents).
3528
3529	Every time this property is read, the accessibility state of
3530	this machine is re-evaluated. If the returned value is @c false,
3531	the <link to="#accessError"/> property may be used to get the
3532	detailed error information describing the reason of
3533	inaccessibility, including XML error messages.
3534
3535	When the machine is inaccessible, only the following properties
3536	can be used on it:
3537	<ul>
3538	<li><link to="#parent"/></li>
3539	<li><link to="#id"/></li>
3540	<li><link to="#settingsFilePath"/></li>
3541	<li><link to="#accessible"/></li>
3542	<li><link to="#accessError"/></li>
3543	</ul>
3544
3545	An attempt to access any other property or method will return
3546	an error.
3547
3548	The only possible action you can perform on an inaccessible
3549	machine is to unregister it using the
3550	<link to="IMachine::unregister"/> call (or, to check
3551	for the accessibility state once more by querying this
3552	property).
3553
3554	<note>
3555	In the current implementation, once this property returns
3556	@c true, the machine will never become inaccessible
3557	later, even if its settings file cannot be successfully
3558	read/written any more (at least, until the VirtualBox
3559	server is restarted). This limitation may be removed in
3560	future releases.
3561	</note>
3562	</desc>
3563	</attribute>
3564
3565	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3566	<desc>
3567	Error information describing the reason of machine
3568	inaccessibility.
3569
3570	Reading this property is only valid after the last call to
3571	<link to="#accessible"/> returned @c false (i.e. the
3572	machine is currently inaccessible). Otherwise, a @c null
3573	IVirtualBoxErrorInfo object will be returned.
3574	</desc>
3575	</attribute>
3576
3577	<attribute name="name" type="wstring">
3578	<desc>
3579	Name of the virtual machine.
3580
3581	Besides being used for human-readable identification purposes
3582	everywhere in VirtualBox, the virtual machine name is also used
3583	as a name of the machine's settings file and as a name of the
3584	subdirectory this settings file resides in. Thus, every time you
3585	change the value of this property, the settings file will be
3586	renamed once you call <link to="#saveSettings"/> to confirm the
3587	change. The containing subdirectory will be also renamed, but
3588	only if it has exactly the same name as the settings file
3589	itself prior to changing this property (for backward compatibility
3590	with previous API releases). The above implies the following
3591	limitations:
3592	<ul>
3593	<li>The machine name cannot be empty.</li>
3594	<li>The machine name can contain only characters that are valid
3595	file name characters according to the rules of the file
3596	system used to store VirtualBox configuration.</li>
3597	<li>You cannot have two or more machines with the same name
3598	if they use the same subdirectory for storing the machine
3599	settings files.</li>
3600	<li>You cannot change the name of the machine if it is running,
3601	or if any file in the directory containing the settings file
3602	is being used by another running machine or by any other
3603	process in the host operating system at a time when
3604	<link to="#saveSettings"/> is called.
3605	</li>
3606	</ul>
3607	If any of the above limitations are hit, <link to="#saveSettings"/>
3608	will return an appropriate error message explaining the exact
3609	reason and the changes you made to this machine will not be saved.
3610
3611	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3612	file is recommended, but not enforced. (Previous versions always
3613	used a generic ".xml" extension.)
3614	</desc>
3615	</attribute>
3616
3617	<attribute name="description" type="wstring">
3618	<desc>
3619	Description of the virtual machine.
3620
3621	The description attribute can contain any text and is
3622	typically used to describe the hardware and software
3623	configuration of the virtual machine in detail (i.e. network
3624	settings, versions of the installed software and so on).
3625	</desc>
3626	</attribute>
3627
3628	<attribute name="id" type="uuid" mod="string" readonly="yes">
3629	<desc>UUID of the virtual machine.</desc>
3630	</attribute>
3631
3632	<attribute name="OSTypeId" type="wstring">
3633	<desc>
3634	User-defined identifier of the Guest OS type.
3635	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3636	an IGuestOSType object representing details about the given
3637	Guest OS type.
3638	<note>
3639	This value may differ from the value returned by
3640	<link to="IGuest::OSTypeId"/> if Guest Additions are
3641	installed to the guest OS.
3642	</note>
3643	</desc>
3644	</attribute>
3645
3646	<attribute name="HardwareVersion" type="wstring">
3647	<desc>Hardware version identifier. Internal use only for now.</desc>
3648	</attribute>
3649
3650	<attribute name="hardwareUUID" type="uuid" mod="string">
3651	<desc>
3652	The UUID presented to the guest via memory tables, hardware and guest
3653	properties. For most VMs this is the same as the @a id, but for VMs
3654	which have been cloned or teleported it may be the same as the source
3655	VM. This latter is because the guest shouldn't notice that it was
3656	cloned or teleported.
3657	</desc>
3658	</attribute>
3659
3660	<attribute name="CPUCount" type="unsigned long">
3661	<desc>Number of virtual CPUs in the VM.</desc>
3662	</attribute>
3663
3664	<attribute name="CPUHotPlugEnabled" type="boolean">
3665	<desc>
3666	This setting determines whether VirtualBox allows CPU
3667	hotplugging for this machine.</desc>
3668	</attribute>
3669
3670	<attribute name="CPUExecutionCap" type="unsigned long">
3671	<desc>
3672	Means to limit the number of CPU cycles a guest can use. The unit
3673	is percentage of host CPU cycles per second. The valid range
3674	is 1 - 100. 100 (the default) implies no limit.
3675	</desc>
3676	</attribute>
3677
3678	<attribute name="memorySize" type="unsigned long">
3679	<desc>System memory size in megabytes.</desc>
3680	</attribute>
3681
3682	<attribute name="memoryBalloonSize" type="unsigned long">
3683	<desc>Memory balloon size in megabytes.</desc>
3684	</attribute>
3685
3686	<attribute name="PageFusionEnabled" type="boolean">
3687	<desc>
3688	This setting determines whether VirtualBox allows page
3689	fusion for this machine (64 bits host only).
3690	</desc>
3691	</attribute>
3692
3693	<attribute name="VRAMSize" type="unsigned long">
3694	<desc>Video memory size in megabytes.</desc>
3695	</attribute>
3696
3697	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3698	<desc>
3699	This setting determines whether VirtualBox allows this machine to make
3700	use of the 3D graphics support available on the host.</desc>
3701	</attribute>
3702
3703	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3704	<desc>
3705	This setting determines whether VirtualBox allows this machine to make
3706	use of the 2D video acceleration support available on the host.</desc>
3707	</attribute>
3708
3709	<attribute name="monitorCount" type="unsigned long">
3710	<desc>
3711	Number of virtual monitors.
3712	<note>
3713	Only effective on Windows XP and later guests with
3714	Guest Additions installed.
3715	</note>
3716	</desc>
3717	</attribute>
3718
3719	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3720	<desc>Object containing all BIOS settings.</desc>
3721	</attribute>
3722
3723	<attribute name="firmwareType" type="FirmwareType">
3724	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3725	bootstrap in this VM.</desc>
3726	</attribute>
3727
3728	<attribute name="pointingHidType" type="PointingHidType">
3729	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3730	The default is typically "PS2Mouse" but can vary depending on the
3731	requirements of the guest operating system.</desc>
3732	</attribute>
3733
3734	<attribute name="keyboardHidType" type="KeyboardHidType">
3735	<desc>Type of keyboard HID used in this VM.
3736	The default is typically "PS2Keyboard" but can vary depending on the
3737	requirements of the guest operating system.</desc>
3738	</attribute>
3739
3740	<attribute name="hpetEnabled" type="boolean">
3741	<desc>This attribute controls if High Precision Event Timer (HPET) is
3742	enabled in this VM. Use this property if you want to provide guests
3743	with additional time source, or if guest requires HPET to function correctly.
3744	Default is false.</desc>
3745	</attribute>
3746
3747	<attribute name="chipsetType" type="ChipsetType">
3748	<desc>Chipset type used in this VM.</desc>
3749	</attribute>
3750
3751	<attribute name="snapshotFolder" type="wstring">
3752	<desc>
3753	Full path to the directory used to store snapshot data
3754	(differencing media and saved state files) of this machine.
3755
3756	The initial value of this property is
3757	<tt><</tt><link to="#settingsFilePath">
3758	path_to_settings_file</link><tt>>/<</tt>
3759	<link to="#id">machine_uuid</link>
3760	<tt>></tt>.
3761
3762	Currently, it is an error to try to change this property on
3763	a machine that has snapshots (because this would require to
3764	move possibly large files to a different location).
3765	A separate method will be available for this purpose later.
3766
3767	<note>
3768	Setting this property to @c null or to an empty string will restore
3769	the initial value.
3770	</note>
3771	<note>
3772	When setting this property, the specified path can be
3773	absolute (full path) or relative to the directory where the
3774	<link to="#settingsFilePath">machine settings file</link>
3775	is located. When reading this property, a full path is
3776	always returned.
3777	</note>
3778	<note>
3779	The specified path may not exist, it will be created
3780	when necessary.
3781	</note>
3782	</desc>
3783	</attribute>
3784
3785	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3786	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3787	</attribute>
3788
3789	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3790	<desc>Array of media attached to this machine.</desc>
3791	</attribute>
3792
3793	<attribute name="USBController" type="IUSBController" readonly="yes">
3794	<desc>
3795	Associated USB controller object.
3796
3797	<note>
3798	If USB functionality is not available in the given edition of
3799	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3800	</note>
3801	</desc>
3802	</attribute>
3803
3804	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3805	<desc>Associated audio adapter, always present.</desc>
3806	</attribute>
3807
3808	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3809	<desc>Array of storage controllers attached to this machine.</desc>
3810	</attribute>
3811
3812	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3813	<desc>
3814	Full name of the file containing machine settings data.
3815	</desc>
3816	</attribute>
3817
3818	<attribute name="settingsModified" type="boolean" readonly="yes">
3819	<desc>
3820	Whether the settings of this machine have been modified
3821	(but neither yet saved nor discarded).
3822	<note>
3823	Reading this property is only valid on instances returned
3824	by <link to="ISession::machine"/> and on new machines
3825	created by <link to="IVirtualBox::createMachine"/> or opened
3826	by <link to="IVirtualBox::openMachine"/> but not
3827	yet registered, or on unregistered machines after calling
3828	<link to="IMachine::unregister"/>. For all other
3829	cases, the settings can never be modified.
3830	</note>
3831	<note>
3832	For newly created unregistered machines, the value of this
3833	property is always @c true until <link to="#saveSettings"/>
3834	is called (no matter if any machine settings have been
3835	changed after the creation or not). For opened machines
3836	the value is set to @c false (and then follows to normal rules).
3837	</note>
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="sessionState" type="SessionState" readonly="yes">
3842	<desc>Current session state for this machine.</desc>
3843	</attribute>
3844
3845	<attribute name="sessionType" type="wstring" readonly="yes">
3846	<desc>
3847	Type of the session. If <link to="#sessionState"/> is
3848	Spawning or Locked, this attribute contains the
3849	same value as passed to the
3850	<link to="IMachine::launchVMProcess"/> method in the
3851	@a type parameter. If the session was used with
3852	<link to="IMachine::lockMachine" />, or if
3853	<link to="#sessionState"/> is SessionClosed, the value of this
3854	attribute is an empty string.
3855	</desc>
3856	</attribute>
3857
3858	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3859	<desc>
3860	Identifier of the session process. This attribute contains the
3861	platform-dependent identifier of the process whose session was
3862	used with <link to="IMachine::lockMachine" /> call. The returned
3863	value is only valid if <link to="#sessionState"/> is Locked or
3864	Unlocking by the time this property is read.
3865	</desc>
3866	</attribute>
3867
3868	<attribute name="state" type="MachineState" readonly="yes">
3869	<desc>Current execution state of this machine.</desc>
3870	</attribute>
3871
3872	<attribute name="lastStateChange" type="long long" readonly="yes">
3873	<desc>
3874	Time stamp of the last execution state change,
3875	in milliseconds since 1970-01-01 UTC.
3876	</desc>
3877	</attribute>
3878
3879	<attribute name="stateFilePath" type="wstring" readonly="yes">
3880	<desc>
3881	Full path to the file that stores the execution state of
3882	the machine when it is in the <link to="MachineState_Saved"/> state.
3883	<note>
3884	When the machine is not in the Saved state, this attribute is
3885	an empty string.
3886	</note>
3887	</desc>
3888	</attribute>
3889
3890	<attribute name="logFolder" type="wstring" readonly="yes">
3891	<desc>
3892	Full path to the folder that stores a set of rotated log files
3893	recorded during machine execution. The most recent log file is
3894	named <tt>VBox.log</tt>, the previous log file is
3895	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3896	in the current version).
3897	</desc>
3898	</attribute>
3899
3900	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3901	<desc>
3902	Current snapshot of this machine. This is @c null if the machine
3903	currently has no snapshots. If it is not @c null, then it was
3904	set by one of <link to="IConsole::takeSnapshot" />,
3905	<link to="IConsole::deleteSnapshot" />
3906	or <link to="IConsole::restoreSnapshot" />, depending on which
3907	was called last. See <link to="ISnapshot"/> for details.
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3912	<desc>
3913	Number of snapshots taken on this machine. Zero means the
3914	machine doesn't have any snapshots.
3915	</desc>
3916	</attribute>
3917
3918	<attribute name="currentStateModified" type="boolean" readonly="yes">
3919	<desc>
3920	Returns @c true if the current state of the machine is not
3921	identical to the state stored in the current snapshot.
3922
3923	The current state is identical to the current snapshot only
3924	directly after one of the following calls are made:
3925
3926	<ul>
3927	<li><link to="IConsole::restoreSnapshot"/>
3928	</li>
3929	<li><link to="IConsole::takeSnapshot"/> (issued on a
3930	"powered off" or "saved" machine, for which
3931	<link to="#settingsModified"/> returns @c false)
3932	</li>
3933	</ul>
3934
3935	The current state remains identical until one of the following
3936	happens:
3937	<ul>
3938	<li>settings of the machine are changed</li>
3939	<li>the saved state is deleted</li>
3940	<li>the current snapshot is deleted</li>
3941	<li>an attempt to execute the machine is made</li>
3942	</ul>
3943
3944	<note>
3945	For machines that don't have snapshots, this property is
3946	always @c false.
3947	</note>
3948	</desc>
3949	</attribute>
3950
3951	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3952	<desc>
3953	Collection of shared folders for this machine (permanent shared
3954	folders). These folders are shared automatically at machine startup
3955	and available only to the guest OS installed within this machine.
3956
3957	New shared folders are added to the collection using
3958	<link to="#createSharedFolder"/>. Existing shared folders can be
3959	removed using <link to="#removeSharedFolder"/>.
3960	</desc>
3961	</attribute>
3962
3963	<attribute name="clipboardMode" type="ClipboardMode">
3964	<desc>
3965	Synchronization mode between the host OS clipboard
3966	and the guest OS clipboard.
3967	</desc>
3968	</attribute>
3969
3970	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3971	<desc>
3972	A comma-separated list of simple glob patterns. Changes to guest
3973	properties whose name matches one of the patterns will generate an
3974	<link to="IGuestPropertyChangedEvent"/> signal.
3975	</desc>
3976	</attribute>
3977
3978	<attribute name="teleporterEnabled" type="boolean">
3979	<desc>
3980	When set to @a true, the virtual machine becomes a target teleporter
3981	the next time it is powered on. This can only set to @a true when the
3982	VM is in the @a PoweredOff or @a Aborted state.
3983
3984	<!-- This property is automatically set to @a false when the VM is powered
3985	on. (bird: This doesn't work yet ) -->
3986	</desc>
3987	</attribute>
3988
3989	<attribute name="teleporterPort" type="unsigned long">
3990	<desc>
3991	The TCP port the target teleporter will listen for incoming
3992	teleportations on.
3993
3994	0 means the port is automatically selected upon power on. The actual
3995	value can be read from this property while the machine is waiting for
3996	incoming teleportations.
3997	</desc>
3998	</attribute>
3999
4000	<attribute name="teleporterAddress" type="wstring">
4001	<desc>
4002	The address the target teleporter will listen on. If set to an empty
4003	string, it will listen on all addresses.
4004	</desc>
4005	</attribute>
4006
4007	<attribute name="teleporterPassword" type="wstring">
4008	<desc>
4009	The password to check for on the target teleporter. This is just a
4010	very basic measure to prevent simple hacks and operators accidentally
4011	beaming a virtual machine to the wrong place.
4012	</desc>
4013	</attribute>
4014
4015	<attribute name="faultToleranceState" type="FaultToleranceState">
4016	<desc>
4017	Fault tolerance state; disabled, source or target.
4018	This property can be changed at any time. If you change it for a running
4019	VM, then the fault tolerance address and port must be set beforehand.
4020	</desc>
4021	</attribute>
4022
4023	<attribute name="faultTolerancePort" type="unsigned long">
4024	<desc>
4025	The TCP port the fault tolerance source or target will use for
4026	communication.
4027	</desc>
4028	</attribute>
4029
4030	<attribute name="faultToleranceAddress" type="wstring">
4031	<desc>
4032	The address the fault tolerance source or target.
4033	</desc>
4034	</attribute>
4035
4036	<attribute name="faultTolerancePassword" type="wstring">
4037	<desc>
4038	The password to check for on the standby VM. This is just a
4039	very basic measure to prevent simple hacks and operators accidentally
4040	choosing the wrong standby VM.
4041	</desc>
4042	</attribute>
4043
4044	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4045	<desc>
4046	The interval in ms used for syncing the state between source and target.
4047	</desc>
4048	</attribute>
4049
4050	<attribute name="RTCUseUTC" type="boolean">
4051	<desc>
4052	When set to @a true, the RTC device of the virtual machine will run
4053	in UTC time, otherwise in local time. Especially Unix guests prefer
4054	the time in UTC.
4055	</desc>
4056	</attribute>
4057
4058	<attribute name="ioCacheEnabled" type="boolean">
4059	<desc>
4060	When set to @a true, the builtin I/O cache of the virtual machine
4061	will be enabled.
4062	</desc>
4063	</attribute>
4064
4065	<attribute name="ioCacheSize" type="unsigned long">
4066	<desc>
4067	Maximum size of the I/O cache in MB.
4068	</desc>
4069	</attribute>
4070
4071	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4072	<desc>
4073	Bandwidth control manager.
4074	</desc>
4075	</attribute>
4076
4077	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4078	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4079	attached to the machine use IConsole::attachedPciDevices attribute, as
4080	this attribute is intended to list only devices additional to what
4081	described in virtual hardware config. Usually, this list keeps host's
4082	physical devices assigned to the particular machine.
4083	</desc>
4084	</attribute>
4085
4086	<method name="lockMachine">
4087	<desc>
4088	Locks the machine for the given session to enable the caller
4089	to make changes to the machine or start the VM or control
4090	VM execution.
4091
4092	There are two ways to lock a machine for such uses:
4093
4094	<ul>
4095	<li>If you want to make changes to the machine settings,
4096	you must obtain an exclusive write lock on the machine
4097	by setting @a lockType to @c Write.
4098
4099	This will only succeed if no other process has locked
4100	the machine to prevent conflicting changes. Only after
4101	an exclusive write lock has been obtained using this method, one
4102	can change all VM settings or execute the VM in the process
4103	space of the session object. (Note that the latter is only of
4104	interest if you actually want to write a new front-end for
4105	virtual machines; but this API gets called internally by
4106	the existing front-ends such as VBoxHeadless and the VirtualBox
4107	GUI to acquire a write lock on the machine that they are running.)
4108
4109	On success, write-locking the machine for a session creates
4110	a second copy of the IMachine object. It is this second object
4111	upon which changes can be made; in VirtualBox terminology, the
4112	second copy is "mutable". It is only this second, mutable machine
4113	object upon which you can call methods that change the
4114	machine state. After having called this method, you can
4115	obtain this second, mutable machine object using the
4116	<link to="ISession::machine" /> attribute.
4117	</li>
4118	<li>If you only want to check the machine state or control
4119	machine execution without actually changing machine
4120	settings (e.g. to get access to VM statistics or take
4121	a snapshot or save the machine state), then set the
4122	@a lockType argument to @c Shared.
4123
4124	If no other session has obtained a lock, you will obtain an
4125	exclusive write lock as described above. However, if another
4126	session has already obtained such a lock, then a link to that
4127	existing session will be established which allows you
4128	to control that existing session.
4129
4130	To find out which type of lock was obtained, you can
4131	inspect <link to="ISession::type" />, which will have been
4132	set to either @c WriteLock or @c Shared.
4133	</li>
4134	</ul>
4135
4136	In either case, you can get access to the <link to="IConsole" />
4137	object which controls VM execution.
4138
4139	Also in all of the above cases, one must always call
4140	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4141	the machine's state will eventually be set to "Aborted".
4142
4143	To change settings on a machine, the following sequence is typically
4144	performed:
4145
4146	<ol>
4147	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4148
4149	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4150
4151	<li>Change the settings of the machine by invoking IMachine methods.</li>
4152
4153	<li>Call <link to="IMachine::saveSettings" />.</li>
4154
4155	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4156	</ol>
4157
4158	<result name="E_UNEXPECTED">
4159	Virtual machine not registered.
4160	</result>
4161	<result name="E_ACCESSDENIED">
4162	Process not started by OpenRemoteSession.
4163	</result>
4164	<result name="VBOX_E_INVALID_OBJECT_STATE">
4165	Session already open or being opened.
4166	</result>
4167	<result name="VBOX_E_VM_ERROR">
4168	Failed to assign machine to session.
4169	</result>
4170	</desc>
4171	<param name="session" type="ISession" dir="in">
4172	<desc>
4173	Session object for which the machine will be locked.
4174	</desc>
4175	</param>
4176	<param name="lockType" type="LockType" dir="in">
4177	<desc>
4178	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4179	If set to @c Shared, then either acquire an exclusive write lock or establish
4180	a link to an existing session.
4181	</desc>
4182	</param>
4183	</method>
4184
4185	<method name="launchVMProcess">
4186	<desc>
4187	Spawns a new process that will execute the virtual machine and obtains a shared
4188	lock on the machine for the calling session.
4189
4190	If launching the VM succeeds, the new VM process will create its own session
4191	and write-lock the machine for it, preventing conflicting changes from other
4192	processes. If the machine is already locked (because it is already running or
4193	because another session has a write lock), launching the VM process will therefore
4194	fail. Reversely, future attempts to obtain a write lock will also fail while the
4195	machine is running.
4196
4197	The caller's session object remains separate from the session opened by the new
4198	VM process. It receives its own <link to="IConsole" /> object which can be used
4199	to control machine execution, but it cannot be used to change all VM settings
4200	which would be available after a <link to="#lockMachine" /> call.
4201
4202	The caller must eventually release the session's shared lock by calling
4203	<link to="ISession::unlockMachine" /> on the local session object once this call
4204	has returned. However, the session's state (see <link to="ISession::state" />)
4205	will not return to "Unlocked" until the remote session has also unlocked
4206	the machine (i.e. the machine has stopped running).
4207
4208	Launching a VM process can take some time (a new VM is started in a new process,
4209	for which memory and other resources need to be set up). Because of this,
4210	an <link to="IProgress" /> object is returned to allow the caller to wait
4211	for this asynchronous operation to be completed. Until then, the caller's
4212	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4213	and <link to="ISession::console" /> attributes cannot be accessed.
4214	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4215	similar calls to wait for completion. Completion is signalled when the VM
4216	is powered on. If launching the VM fails, error messages can be queried
4217	via the progress object, if available.
4218
4219	The progress object will have at least 2 sub-operations. The first
4220	operation covers the period up to the new VM process calls powerUp.
4221	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4222	progress object. Because <link to="IConsole::powerUp"/> may require
4223	some extra sub-operations, the <link to="IProgress::operationCount"/>
4224	may change at the completion of operation.
4225
4226	For details on the teleportation progress operation, see
4227	<link to="IConsole::powerUp"/>.
4228
4229	The @a environment argument is a string containing definitions of
4230	environment variables in the following format:
4231	@code
4232	NAME[=VALUE]\n
4233	NAME[=VALUE]\n
4234	...
4235	@endcode
4236	where <tt>\\n</tt> is the new line character. These environment
4237	variables will be appended to the environment of the VirtualBox server
4238	process. If an environment variable exists both in the server process
4239	and in this list, the value from this list takes precedence over the
4240	server's variable. If the value of the environment variable is
4241	omitted, this variable will be removed from the resulting environment.
4242	If the environment string is @c null or empty, the server environment
4243	is inherited by the started process as is.
4244
4245	<result name="E_UNEXPECTED">
4246	Virtual machine not registered.
4247	</result>
4248	<result name="E_INVALIDARG">
4249	Invalid session type @a type.
4250	</result>
4251	<result name="VBOX_E_OBJECT_NOT_FOUND">
4252	No machine matching @a machineId found.
4253	</result>
4254	<result name="VBOX_E_INVALID_OBJECT_STATE">
4255	Session already open or being opened.
4256	</result>
4257	<result name="VBOX_E_IPRT_ERROR">
4258	Launching process for machine failed.
4259	</result>
4260	<result name="VBOX_E_VM_ERROR">
4261	Failed to assign machine to session.
4262	</result>
4263	</desc>
4264	<param name="session" type="ISession" dir="in">
4265	<desc>
4266	Client session object to which the VM process will be connected (this
4267	must be in "Unlocked" state).
4268	</desc>
4269	</param>
4270	<param name="type" type="wstring" dir="in">
4271	<desc>
4272	Front-end to use for the new VM process. The following are currently supported:
4273	<ul>
4274	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4275	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4276	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4277	</ul>
4278	</desc>
4279	</param>
4280	<param name="environment" type="wstring" dir="in">
4281	<desc>
4282	Environment to pass to the VM process.
4283	</desc>
4284	</param>
4285	<param name="progress" type="IProgress" dir="return">
4286	<desc>Progress object to track the operation completion.</desc>
4287	</param>
4288	</method>
4289
4290	<method name="setBootOrder">
4291	<desc>
4292	Puts the given device to the specified position in
4293	the boot order.
4294
4295	To indicate that no device is associated with the given position,
4296	<link to="DeviceType_Null"/> should be used.
4297
4298	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4299
4300	<result name="E_INVALIDARG">
4301	Boot @a position out of range.
4302	</result>
4303	<result name="E_NOTIMPL">
4304	Booting from USB @a device currently not supported.
4305	</result>
4306
4307	</desc>
4308	<param name="position" type="unsigned long" dir="in">
4309	<desc>
4310	Position in the boot order (@c 1 to the total number of
4311	devices the machine can boot from, as returned by
4312	<link to="ISystemProperties::maxBootPosition"/>).
4313	</desc>
4314	</param>
4315	<param name="device" type="DeviceType" dir="in">
4316	<desc>
4317	The type of the device used to boot at the given position.
4318	</desc>
4319	</param>
4320	</method>
4321
4322	<method name="getBootOrder" const="yes">
4323	<desc>
4324	Returns the device type that occupies the specified
4325	position in the boot order.
4326
4327	@todo [remove?]
4328	If the machine can have more than one device of the returned type
4329	(such as hard disks), then a separate method should be used to
4330	retrieve the individual device that occupies the given position.
4331
4332	If here are no devices at the given position, then
4333	<link to="DeviceType_Null"/> is returned.
4334
4335	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4336
4337	<result name="E_INVALIDARG">
4338	Boot @a position out of range.
4339	</result>
4340
4341	</desc>
4342	<param name="position" type="unsigned long" dir="in">
4343	<desc>
4344	Position in the boot order (@c 1 to the total number of
4345	devices the machine can boot from, as returned by
4346	<link to="ISystemProperties::maxBootPosition"/>).
4347	</desc>
4348	</param>
4349	<param name="device" type="DeviceType" dir="return">
4350	<desc>
4351	Device at the given position.
4352	</desc>
4353	</param>
4354	</method>
4355
4356	<method name="attachDevice">
4357	<desc>
4358	Attaches a device and optionally mounts a medium to the given storage
4359	controller (<link to="IStorageController" />, identified by @a name),
4360	at the indicated port and device.
4361
4362	This method is intended for managing storage devices in general while a
4363	machine is powered off. It can be used to attach and detach fixed
4364	and removeable media. The following kind of media can be attached
4365	to a machine:
4366
4367	<ul>
4368	<li>For fixed and removable media, you can pass in a medium that was
4369	previously opened using <link to="IVirtualBox::openMedium" />.
4370	</li>
4371
4372	<li>Only for storage devices supporting removable media (such as
4373	DVDs and floppies), you can also specify a null pointer to
4374	indicate an empty drive or one of the medium objects listed
4375	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4376	arrays to indicate a host drive.
4377	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4378	to change the media while the machine is running.
4379	</li>
4380	</ul>
4381
4382	In a VM's default configuration of virtual machines, the secondary
4383	master of the IDE controller is used for a CD/DVD drive.
4384
4385	After calling this returns successfully, a new instance of
4386	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4387	attachments (see <link to="IMachine::mediumAttachments"/>).
4388
4389	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4390	information about attaching media.
4391
4392	The specified device slot must not have a device attached to it,
4393	or this method will fail.
4394
4395	<note>
4396	You cannot attach a device to a newly created machine until
4397	this machine's settings are saved to disk using
4398	<link to="#saveSettings"/>.
4399	</note>
4400	<note>
4401	If the medium is being attached indirectly, a new differencing medium
4402	will implicitly be created for it and attached instead. If the
4403	changes made to the machine settings (including this indirect
4404	attachment) are later cancelled using <link to="#discardSettings"/>,
4405	this implicitly created differencing medium will implicitly
4406	be deleted.
4407	</note>
4408
4409	<result name="E_INVALIDARG">
4410	SATA device, SATA port, IDE port or IDE slot out of range, or
4411	file or UUID not found.
4412	</result>
4413	<result name="VBOX_E_INVALID_OBJECT_STATE">
4414	Machine must be registered before media can be attached.
4415	</result>
4416	<result name="VBOX_E_INVALID_VM_STATE">
4417	Invalid machine state.
4418	</result>
4419	<result name="VBOX_E_OBJECT_IN_USE">
4420	A medium is already attached to this or another virtual machine.
4421	</result>
4422
4423	</desc>
4424	<param name="name" type="wstring" dir="in">
4425	<desc>Name of the storage controller to attach the device to.</desc>
4426	</param>
4427	<param name="controllerPort" type="long" dir="in">
4428	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4429	the primary controller and 1 specifies the secondary controller.
4430	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4431	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4432	</param>
4433	<param name="device" type="long" dir="in">
4434	<desc>Device slot in the given port to attach the device to. This is only
4435	relevant for IDE controllers, for which 0 specifies the master device and
4436	1 specifies the slave device. For all other controller types, this must
4437	be 0.</desc>
4438	</param>
4439	<param name="type" type="DeviceType" dir="in">
4440	<desc>Device type of the attached device. For media opened by
4441	<link to="IVirtualBox::openMedium" />, this must match the device type
4442	specified there.</desc>
4443	</param>
4444	<param name="medium" type="IMedium" dir="in">
4445	<desc>Medium to mount or NULL for an empty drive.</desc>
4446	</param>
4447	</method>
4448
4449	<method name="detachDevice">
4450	<desc>
4451	Detaches the device attached to a device slot of the specified bus.
4452
4453	Detaching the device from the virtual machine is deferred. This means
4454	that the medium remains associated with the machine when this method
4455	returns and gets actually de-associated only after a successful
4456	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4457	for more detailed information about attaching media.
4458
4459	<note>
4460	You cannot detach a device from a running machine.
4461	</note>
4462	<note>
4463	Detaching differencing media implicitly created by <link
4464	to="#attachDevice"/> for the indirect attachment using this
4465	method will <b>not</b> implicitly delete them. The
4466	<link to="IMedium::deleteStorage"/> operation should be
4467	explicitly performed by the caller after the medium is successfully
4468	detached and the settings are saved with
4469	<link to="#saveSettings"/>, if it is the desired action.
4470	</note>
4471
4472	<result name="VBOX_E_INVALID_VM_STATE">
4473	Attempt to detach medium from a running virtual machine.
4474	</result>
4475	<result name="VBOX_E_OBJECT_NOT_FOUND">
4476	No medium attached to given slot/bus.
4477	</result>
4478	<result name="VBOX_E_NOT_SUPPORTED">
4479	Medium format does not support storage deletion.
4480	</result>
4481
4482	</desc>
4483	<param name="name" type="wstring" dir="in">
4484	<desc>Name of the storage controller to detach the medium from.</desc>
4485	</param>
4486	<param name="controllerPort" type="long" dir="in">
4487	<desc>Port number to detach the medium from.</desc>
4488	</param>
4489	<param name="device" type="long" dir="in">
4490	<desc>Device slot number to detach the medium from.</desc>
4491	</param>
4492	</method>
4493
4494	<method name="passthroughDevice">
4495	<desc>
4496	Sets the passthrough mode of an existing DVD device. Changing the
4497	setting while the VM is running is forbidden. The setting is only used
4498	if at VM start the device is configured as a host DVD drive, in all
4499	other cases it is ignored. The device must already exist; see
4500	<link to="IMachine::attachDevice"/> for how to attach a new device.
4501
4502	The @a controllerPort and @a device parameters specify the device slot and
4503	have have the same meaning as with <link to="IMachine::attachDevice" />.
4504
4505	<result name="E_INVALIDARG">
4506	SATA device, SATA port, IDE port or IDE slot out of range.
4507	</result>
4508	<result name="VBOX_E_INVALID_OBJECT_STATE">
4509	Attempt to modify an unregistered virtual machine.
4510	</result>
4511	<result name="VBOX_E_INVALID_VM_STATE">
4512	Invalid machine state.
4513	</result>
4514
4515	</desc>
4516	<param name="name" type="wstring" dir="in">
4517	<desc>Name of the storage controller.</desc>
4518	</param>
4519	<param name="controllerPort" type="long" dir="in">
4520	<desc>Storage controller port.</desc>
4521	</param>
4522	<param name="device" type="long" dir="in">
4523	<desc>Device slot in the given port.</desc>
4524	</param>
4525	<param name="passthrough" type="boolean" dir="in">
4526	<desc>New value for the passthrough setting.</desc>
4527	</param>
4528	</method>
4529
4530	<method name="setBandwidthGroupForDevice">
4531	<desc>
4532	Sets the passthrough mode of an existing DVD device. Changing the
4533	setting while the VM is running is forbidden. The setting is only used
4534	if at VM start the device is configured as a host DVD drive, in all
4535	other cases it is ignored. The device must already exist; see
4536	<link to="IMachine::attachDevice"/> for how to attach a new device.
4537
4538	The @a controllerPort and @a device parameters specify the device slot and
4539	have have the same meaning as with <link to="IMachine::attachDevice" />.
4540
4541	<result name="E_INVALIDARG">
4542	SATA device, SATA port, IDE port or IDE slot out of range.
4543	</result>
4544	<result name="VBOX_E_INVALID_OBJECT_STATE">
4545	Attempt to modify an unregistered virtual machine.
4546	</result>
4547	<result name="VBOX_E_INVALID_VM_STATE">
4548	Invalid machine state.
4549	</result>
4550
4551	</desc>
4552	<param name="name" type="wstring" dir="in">
4553	<desc>Name of the storage controller.</desc>
4554	</param>
4555	<param name="controllerPort" type="long" dir="in">
4556	<desc>Storage controller port.</desc>
4557	</param>
4558	<param name="device" type="long" dir="in">
4559	<desc>Device slot in the given port.</desc>
4560	</param>
4561	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4562	<desc>New value for the bandwidth group or NULL for no group.</desc>
4563	</param>
4564	</method>
4565
4566	<method name="mountMedium">
4567	<desc>
4568	Mounts a medium (<link to="IMedium" />, identified
4569	by the given UUID @a id) to the given storage controller
4570	(<link to="IStorageController" />, identified by @a name),
4571	at the indicated port and device. The device must already exist;
4572	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4573
4574	This method is intended only for managing removable media, where the
4575	device is fixed but media is changeable at runtime (such as DVDs
4576	and floppies). It cannot be used for fixed media such as hard disks.
4577
4578	The @a controllerPort and @a device parameters specify the device slot and
4579	have have the same meaning as with <link to="IMachine::attachDevice" />.
4580
4581	The specified device slot can have a medium mounted, which will be
4582	unmounted first. Specifying a zero UUID (or an empty string) for
4583	@a medium does just an unmount.
4584
4585	See <link to="IMedium"/> for more detailed information about
4586	attaching media.
4587
4588	<result name="E_INVALIDARG">
4589	SATA device, SATA port, IDE port or IDE slot out of range.
4590	</result>
4591	<result name="VBOX_E_INVALID_OBJECT_STATE">
4592	Attempt to attach medium to an unregistered virtual machine.
4593	</result>
4594	<result name="VBOX_E_INVALID_VM_STATE">
4595	Invalid machine state.
4596	</result>
4597	<result name="VBOX_E_OBJECT_IN_USE">
4598	Medium already attached to this or another virtual machine.
4599	</result>
4600
4601	</desc>
4602	<param name="name" type="wstring" dir="in">
4603	<desc>Name of the storage controller to attach the medium to.</desc>
4604	</param>
4605	<param name="controllerPort" type="long" dir="in">
4606	<desc>Port to attach the medium to.</desc>
4607	</param>
4608	<param name="device" type="long" dir="in">
4609	<desc>Device slot in the given port to attach the medium to.</desc>
4610	</param>
4611	<param name="medium" type="IMedium" dir="in">
4612	<desc>Medium to mount or NULL for an empty drive.</desc>
4613	</param>
4614	<param name="force" type="boolean" dir="in">
4615	<desc>Allows to force unmount/mount of a medium which is locked by
4616	the device slot in the given port to attach the medium to.</desc>
4617	</param>
4618	</method>
4619
4620	<method name="getMedium" const="yes">
4621	<desc>
4622	Returns the virtual medium attached to a device slot of the specified
4623	bus.
4624
4625	Note that if the medium was indirectly attached by
4626	<link to="#mountMedium"/> to the given device slot then this
4627	method will return not the same object as passed to the
4628	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4629	more detailed information about mounting a medium.
4630
4631	<result name="VBOX_E_OBJECT_NOT_FOUND">
4632	No medium attached to given slot/bus.
4633	</result>
4634
4635	</desc>
4636	<param name="name" type="wstring" dir="in">
4637	<desc>Name of the storage controller the medium is attached to.</desc>
4638	</param>
4639	<param name="controllerPort" type="long" dir="in">
4640	<desc>Port to query.</desc>
4641	</param>
4642	<param name="device" type="long" dir="in">
4643	<desc>Device slot in the given port to query.</desc>
4644	</param>
4645	<param name="medium" type="IMedium" dir="return">
4646	<desc>Attached medium object.</desc>
4647	</param>
4648	</method>
4649
4650	<method name="getMediumAttachmentsOfController" const="yes">
4651	<desc>
4652	Returns an array of medium attachments which are attached to the
4653	the controller with the given name.
4654
4655	<result name="VBOX_E_OBJECT_NOT_FOUND">
4656	A storage controller with given name doesn't exist.
4657	</result>
4658	</desc>
4659	<param name="name" type="wstring" dir="in"/>
4660	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4661	</method>
4662
4663	<method name="getMediumAttachment" const="yes">
4664	<desc>
4665	Returns a medium attachment which corresponds to the controller with
4666	the given name, on the given port and device slot.
4667
4668	<result name="VBOX_E_OBJECT_NOT_FOUND">
4669	No attachment exists for the given controller/port/device combination.
4670	</result>
4671	</desc>
4672	<param name="name" type="wstring" dir="in"/>
4673	<param name="controllerPort" type="long" dir="in"/>
4674	<param name="device" type="long" dir="in"/>
4675	<param name="attachment" type="IMediumAttachment" dir="return"/>
4676	</method>
4677
4678	<method name="attachHostPciDevice">
4679	<desc>
4680	Attaches host PCI device with the given (host) PCI address to the
4681	PCI bus of the virtual machine. Please note, that this operation
4682	is two phase, as real attachment will happen when VM will start,
4683	and most information will be delivered as IHostPciDevicePlugEvent
4684	on IVirtualBox event source.
4685	<note>
4686	Not yet implemented.
4687	</note>
4688
4689	<see>IHostPciDevicePlugEvent</see>
4690
4691	<result name="VBOX_E_INVALID_VM_STATE">
4692	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4693	</result>
4694	<result name="VBOX_E_PDM_ERROR">
4695	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4696	</result>
4697	<result name="VBOX_E_NOT_SUPPORTED">
4698	Hardware or host OS doesn't allow PCI device passthrought.
4699	</result>
4700	</desc>
4701	<param name="hostAddress" type="long" dir="in">
4702	<desc>Address of the host PCI device.</desc>
4703	</param>
4704	<param name="desiredGuestAddress" type="long" dir="in">
4705	<desc>Desired position of this device on guest PCI bus.</desc>
4706	</param>
4707	<param name="eventContext" type="IEventContext" dir="in">
4708	<desc>Context passed into IHostPciDevicePlugEvent event.</desc>
4709	</param>
4710	<param name="tryToUnbind" type="boolean" dir="in">
4711	<desc>If VMM shall try to unbind existing drivers from the
4712	device before attaching it to the guest.</desc>
4713	</param>
4714	</method>
4715
4716	<method name="detachHostPciDevice">
4717	<desc>
4718	Detach host PCI device from the virtual machine.
4719	Also HostPciDevicePlugEvent on IVirtualBox event source
4720	will be delivered.
4721
4722	<note>
4723	Not yet implemented.
4724	</note>
4725
4726	<see>IHostPciDevicePlugEvent</see>
4727
4728	<result name="VBOX_E_INVALID_VM_STATE">
4729	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4730	</result>
4731	<result name="VBOX_E_OBJECT_NOT_FOUND">
4732	This host device is not attached to this machine.
4733	</result>
4734	<result name="VBOX_E_PDM_ERROR">
4735	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4736	</result>
4737	<result name="VBOX_E_NOT_SUPPORTED">
4738	Hardware or host OS doesn't allow PCI device passthrought.
4739	</result>
4740	</desc>
4741	<param name="hostAddress" type="long" dir="in">
4742	<desc>Address of the host PCI device.</desc>
4743	</param>
4744	</method>
4745
4746	<method name="getNetworkAdapter" const="yes">
4747	<desc>
4748	Returns the network adapter associated with the given slot.
4749	Slots are numbered sequentially, starting with zero. The total
4750	number of adapters per machine is defined by the
4751	<link to="ISystemProperties::networkAdapterCount"/> property,
4752	so the maximum slot number is one less than that property's value.
4753
4754	<result name="E_INVALIDARG">
4755	Invalid @a slot number.
4756	</result>
4757
4758	</desc>
4759	<param name="slot" type="unsigned long" dir="in"/>
4760	<param name="adapter" type="INetworkAdapter" dir="return"/>
4761	</method>
4762
4763	<method name="addStorageController">
4764	<desc>
4765	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4766	machine and returns it as an instance of
4767	<link to="IStorageController" />.
4768
4769	@a name identifies the controller for subsequent calls such as
4770	<link to="#getStorageControllerByName" />,
4771	<link to="#getStorageControllerByInstance" />,
4772	<link to="#removeStorageController" />,
4773	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4774
4775	After the controller has been added, you can set its exact
4776	type by setting the <link to="IStorageController::controllerType" />.
4777
4778	<result name="VBOX_E_OBJECT_IN_USE">
4779	A storage controller with given name exists already.
4780	</result>
4781	<result name="E_INVALIDARG">
4782	Invalid @a controllerType.
4783	</result>
4784	</desc>
4785	<param name="name" type="wstring" dir="in"/>
4786	<param name="connectionType" type="StorageBus" dir="in"/>
4787	<param name="controller" type="IStorageController" dir="return"/>
4788	</method>
4789
4790	<method name="getStorageControllerByName" const="yes">
4791	<desc>
4792	Returns a storage controller with the given name.
4793
4794	<result name="VBOX_E_OBJECT_NOT_FOUND">
4795	A storage controller with given name doesn't exist.
4796	</result>
4797	</desc>
4798	<param name="name" type="wstring" dir="in"/>
4799	<param name="storageController" type="IStorageController" dir="return"/>
4800	</method>
4801
4802	<method name="getStorageControllerByInstance" const="yes">
4803	<desc>
4804	Returns a storage controller with the given instance number.
4805
4806	<result name="VBOX_E_OBJECT_NOT_FOUND">
4807	A storage controller with given instance number doesn't exist.
4808	</result>
4809	</desc>
4810	<param name="instance" type="unsigned long" dir="in"/>
4811	<param name="storageController" type="IStorageController" dir="return"/>
4812	</method>
4813
4814	<method name="removeStorageController">
4815	<desc>
4816	Removes a storage controller from the machine.
4817
4818	<result name="VBOX_E_OBJECT_NOT_FOUND">
4819	A storage controller with given name doesn't exist.
4820	</result>
4821	</desc>
4822	<param name="name" type="wstring" dir="in"/>
4823	</method>
4824
4825	<method name="setStorageControllerBootable">
4826	<desc>
4827	Sets the bootable flag of the storage controller with the given name.
4828
4829	<result name="VBOX_E_OBJECT_NOT_FOUND">
4830	A storage controller with given name doesn't exist.
4831	</result>
4832	<result name="VBOX_E_OBJECT_IN_USE">
4833	Another storage controller is marked as bootable already.
4834	</result>
4835	</desc>
4836	<param name="name" type="wstring" dir="in"/>
4837	<param name="bootable" type="boolean" dir="in"/>
4838	</method>
4839
4840	<method name="getSerialPort" const="yes">
4841	<desc>
4842	Returns the serial port associated with the given slot.
4843	Slots are numbered sequentially, starting with zero. The total
4844	number of serial ports per machine is defined by the
4845	<link to="ISystemProperties::serialPortCount"/> property,
4846	so the maximum slot number is one less than that property's value.
4847
4848	<result name="E_INVALIDARG">
4849	Invalid @a slot number.
4850	</result>
4851
4852	</desc>
4853	<param name="slot" type="unsigned long" dir="in"/>
4854	<param name="port" type="ISerialPort" dir="return"/>
4855	</method>
4856
4857	<method name="getParallelPort" const="yes">
4858	<desc>
4859	Returns the parallel port associated with the given slot.
4860	Slots are numbered sequentially, starting with zero. The total
4861	number of parallel ports per machine is defined by the
4862	<link to="ISystemProperties::parallelPortCount"/> property,
4863	so the maximum slot number is one less than that property's value.
4864
4865	<result name="E_INVALIDARG">
4866	Invalid @a slot number.
4867	</result>
4868
4869	</desc>
4870	<param name="slot" type="unsigned long" dir="in"/>
4871	<param name="port" type="IParallelPort" dir="return"/>
4872	</method>
4873
4874	<method name="getExtraDataKeys">
4875	<desc>
4876	Returns an array representing the machine-specific extra data keys
4877	which currently have values defined.
4878	</desc>
4879	<param name="value" type="wstring" dir="return" safearray="yes">
4880	<desc>Array of extra data keys.</desc>
4881	</param>
4882	</method>
4883
4884	<method name="getExtraData">
4885	<desc>
4886	Returns associated machine-specific extra data.
4887
4888	If the requested data @a key does not exist, this function will
4889	succeed and return an empty string in the @a value argument.
4890
4891	<result name="VBOX_E_FILE_ERROR">
4892	Settings file not accessible.
4893	</result>
4894	<result name="VBOX_E_XML_ERROR">
4895	Could not parse the settings file.
4896	</result>
4897
4898	</desc>
4899	<param name="key" type="wstring" dir="in">
4900	<desc>Name of the data key to get.</desc>
4901	</param>
4902	<param name="value" type="wstring" dir="return">
4903	<desc>Value of the requested data key.</desc>
4904	</param>
4905	</method>
4906
4907	<method name="setExtraData">
4908	<desc>
4909	Sets associated machine-specific extra data.
4910
4911	If you pass @c null or an empty string as a key @a value, the given
4912	@a key will be deleted.
4913
4914	<note>
4915	Before performing the actual data change, this method will ask all
4916	registered listeners using the
4917	<link to="IExtraDataCanChangeEvent"/>
4918	notification for a permission. If one of the listeners refuses the
4919	new value, the change will not be performed.
4920	</note>
4921	<note>
4922	On success, the
4923	<link to="IExtraDataChangedEvent"/> notification
4924	is called to inform all registered listeners about a successful data
4925	change.
4926	</note>
4927	<note>
4928	This method can be called outside the machine session and therefore
4929	it's a caller's responsibility to handle possible race conditions
4930	when several clients change the same key at the same time.
4931	</note>
4932
4933	<result name="VBOX_E_FILE_ERROR">
4934	Settings file not accessible.
4935	</result>
4936	<result name="VBOX_E_XML_ERROR">
4937	Could not parse the settings file.
4938	</result>
4939
4940	</desc>
4941	<param name="key" type="wstring" dir="in">
4942	<desc>Name of the data key to set.</desc>
4943	</param>
4944	<param name="value" type="wstring" dir="in">
4945	<desc>Value to assign to the key.</desc>
4946	</param>
4947	</method>
4948
4949	<method name="getCPUProperty" const="yes">
4950	<desc>
4951	Returns the virtual CPU boolean value of the specified property.
4952
4953	<result name="E_INVALIDARG">
4954	Invalid property.
4955	</result>
4956
4957	</desc>
4958	<param name="property" type="CPUPropertyType" dir="in">
4959	<desc>
4960	Property type to query.
4961	</desc>
4962	</param>
4963	<param name="value" type="boolean" dir="return">
4964	<desc>
4965	Property value.
4966	</desc>
4967	</param>
4968	</method>
4969
4970	<method name="setCPUProperty">
4971	<desc>
4972	Sets the virtual CPU boolean value of the specified property.
4973
4974	<result name="E_INVALIDARG">
4975	Invalid property.
4976	</result>
4977
4978	</desc>
4979	<param name="property" type="CPUPropertyType" dir="in">
4980	<desc>
4981	Property type to query.
4982	</desc>
4983	</param>
4984	<param name="value" type="boolean" dir="in">
4985	<desc>
4986	Property value.
4987	</desc>
4988	</param>
4989	</method>
4990
4991	<method name="getCPUIDLeaf" const="yes">
4992	<desc>
4993	Returns the virtual CPU cpuid information for the specified leaf.
4994
4995	Currently supported index values for cpuid:
4996	Standard CPUID leafs: 0 - 0xA
4997	Extended CPUID leafs: 0x80000000 - 0x8000000A
4998
4999	See the Intel and AMD programmer's manuals for detailed information
5000	about the cpuid instruction and its leafs.
5001	<result name="E_INVALIDARG">
5002	Invalid id.
5003	</result>
5004
5005	</desc>
5006	<param name="id" type="unsigned long" dir="in">
5007	<desc>
5008	CPUID leaf index.
5009	</desc>
5010	</param>
5011	<param name="valEax" type="unsigned long" dir="out">
5012	<desc>
5013	CPUID leaf value for register eax.
5014	</desc>
5015	</param>
5016	<param name="valEbx" type="unsigned long" dir="out">
5017	<desc>
5018	CPUID leaf value for register ebx.
5019	</desc>
5020	</param>
5021	<param name="valEcx" type="unsigned long" dir="out">
5022	<desc>
5023	CPUID leaf value for register ecx.
5024	</desc>
5025	</param>
5026	<param name="valEdx" type="unsigned long" dir="out">
5027	<desc>
5028	CPUID leaf value for register edx.
5029	</desc>
5030	</param>
5031	</method>
5032
5033	<method name="setCPUIDLeaf">
5034	<desc>
5035	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5036	are not passed unmodified. VirtualBox clears features that it doesn't support.
5037
5038	Currently supported index values for cpuid:
5039	Standard CPUID leafs: 0 - 0xA
5040	Extended CPUID leafs: 0x80000000 - 0x8000000A
5041
5042	See the Intel and AMD programmer's manuals for detailed information
5043	about the cpuid instruction and its leafs.
5044
5045	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5046	random crashes inside VMs.
5047	<result name="E_INVALIDARG">
5048	Invalid id.
5049	</result>
5050
5051	</desc>
5052	<param name="id" type="unsigned long" dir="in">
5053	<desc>
5054	CPUID leaf index.
5055	</desc>
5056	</param>
5057	<param name="valEax" type="unsigned long" dir="in">
5058	<desc>
5059	CPUID leaf value for register eax.
5060	</desc>
5061	</param>
5062	<param name="valEbx" type="unsigned long" dir="in">
5063	<desc>
5064	CPUID leaf value for register ebx.
5065	</desc>
5066	</param>
5067	<param name="valEcx" type="unsigned long" dir="in">
5068	<desc>
5069	CPUID leaf value for register ecx.
5070	</desc>
5071	</param>
5072	<param name="valEdx" type="unsigned long" dir="in">
5073	<desc>
5074	CPUID leaf value for register edx.
5075	</desc>
5076	</param>
5077	</method>
5078
5079	<method name="removeCPUIDLeaf">
5080	<desc>
5081	Removes the virtual CPU cpuid leaf for the specified index
5082
5083	<result name="E_INVALIDARG">
5084	Invalid id.
5085	</result>
5086
5087	</desc>
5088	<param name="id" type="unsigned long" dir="in">
5089	<desc>
5090	CPUID leaf index.
5091	</desc>
5092	</param>
5093	</method>
5094
5095	<method name="removeAllCPUIDLeaves">
5096	<desc>
5097	Removes all the virtual CPU cpuid leaves
5098	</desc>
5099	</method>
5100
5101	<method name="getHWVirtExProperty" const="yes">
5102	<desc>
5103	Returns the value of the specified hardware virtualization boolean property.
5104
5105	<result name="E_INVALIDARG">
5106	Invalid property.
5107	</result>
5108
5109	</desc>
5110	<param name="property" type="HWVirtExPropertyType" dir="in">
5111	<desc>
5112	Property type to query.
5113	</desc>
5114	</param>
5115	<param name="value" type="boolean" dir="return">
5116	<desc>
5117	Property value.
5118	</desc>
5119	</param>
5120	</method>
5121
5122	<method name="setHWVirtExProperty">
5123	<desc>
5124	Sets a new value for the specified hardware virtualization boolean property.
5125
5126	<result name="E_INVALIDARG">
5127	Invalid property.
5128	</result>
5129
5130	</desc>
5131	<param name="property" type="HWVirtExPropertyType" dir="in">
5132	<desc>
5133	Property type to set.
5134	</desc>
5135	</param>
5136	<param name="value" type="boolean" dir="in">
5137	<desc>
5138	New property value.
5139	</desc>
5140	</param>
5141	</method>
5142
5143	<method name="saveSettings">
5144	<desc>
5145	Saves any changes to machine settings made since the session
5146	has been opened or a new machine has been created, or since the
5147	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5148	For registered machines, new settings become visible to all
5149	other VirtualBox clients after successful invocation of this
5150	method.
5151	<note>
5152	The method sends <link to="IMachineDataChangedEvent"/>
5153	notification event after the configuration has been successfully
5154	saved (only for registered machines).
5155	</note>
5156	<note>
5157	Calling this method is only valid on instances returned
5158	by <link to="ISession::machine"/> and on new machines
5159	created by <link to="IVirtualBox::createMachine"/> but not
5160	yet registered, or on unregistered machines after calling
5161	<link to="IMachine::unregister"/>.
5162	</note>
5163
5164	<result name="VBOX_E_FILE_ERROR">
5165	Settings file not accessible.
5166	</result>
5167	<result name="VBOX_E_XML_ERROR">
5168	Could not parse the settings file.
5169	</result>
5170	<result name="E_ACCESSDENIED">
5171	Modification request refused.
5172	</result>
5173
5174	</desc>
5175	</method>
5176
5177	<method name="discardSettings">
5178	<desc>
5179	Discards any changes to the machine settings made since the session
5180	has been opened or since the last call to <link to="#saveSettings"/>
5181	or <link to="#discardSettings"/>.
5182	<note>
5183	Calling this method is only valid on instances returned
5184	by <link to="ISession::machine"/> and on new machines
5185	created by <link to="IVirtualBox::createMachine"/> or
5186	opened by <link to="IVirtualBox::openMachine"/> but not
5187	yet registered, or on unregistered machines after calling
5188	<link to="IMachine::unregister"/>.
5189	</note>
5190
5191	<result name="VBOX_E_INVALID_VM_STATE">
5192	Virtual machine is not mutable.
5193	</result>
5194
5195	</desc>
5196	</method>
5197
5198	<method name="unregister">
5199	<desc>
5200	Unregisters the machine, which must have been previously registered using
5201	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5202	cleanup before the machine is unregistered.
5203
5204	This method does not delete any files. It only changes the machine configuration and
5205	the list of registered machines in the VirtualBox object. To delete the files which
5206	belonged to the machine, including the XML file of the machine itself, call
5207	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5208	from this method.
5209
5210	How thoroughly this method cleans up the machine configuration before unregistering
5211	the machine depends on the @a cleanupMode argument.
5212
5213	<ul>
5214	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5215	cleanup will be performed. The call will fail if the machine is in "Saved" state
5216	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5217	It is the responsibility of the caller to delete all such configuration in this mode.
5218	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5219	which it replaces.</li>
5220	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5221	state or if it has snapshots or media attached. All media attached to the current machine
5222	state or in snapshots will be detached. No medium objects will be returned; all of the
5223	machine's media will remain open.</li>
5224	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5225	except that all the hard disk medium objects which were detached from the machine will
5226	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5227	API for closing and deletion.</li>
5228	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5229	that all media will be returned in the array, including removeable media like DVDs and
5230	floppies. This might be useful if the user wants to inspect in detail which media were
5231	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5232	in that case because users will typically want to preserve ISO and RAW image files.</li>
5233	</ul>
5234
5235	This API does not verify whether the media files returned in the array are still
5236	attached to other machines (i.e. shared between several machines). If such a shared
5237	image is passed to <link to="#delete" /> however, closing the image will fail there
5238	and the image will be silently skipped.
5239
5240	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5241	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5242	deleted with all its saved states and hard disk images, but images for removeable
5243	drives (such as ISO and RAW files) will remain on disk.
5244
5245	The call will fail if the machine is currently locked (see <link to="ISession" />).
5246	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5247	before unregistering it.
5248
5249	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5250	is fired.
5251
5252	<note>
5253	If the given machine is inaccessible (see <link to="#accessible"/>), it
5254	will be unregistered and fully uninitialized right afterwards. As a result,
5255	the returned machine object will be unusable and an attempt to call
5256	<b>any</b> method will return the "Object not ready" error.
5257	</note>
5258
5259	<result name="VBOX_E_INVALID_OBJECT_STATE">
5260	Machine is currently locked for a session.
5261	</result>
5262	</desc>
5263
5264	<param name="cleanupMode" type="CleanupMode" dir="in">
5265	<desc>How to clean up after the machine has been unregistered.</desc>
5266	</param>
5267	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5268	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5269	</param>
5270	</method>
5271
5272	<method name="delete">
5273	<desc>
5274	Deletes the files associated with this machine from disk. If medium objects are passed
5275	in with the @a aMedia argument, they are closed and, if closing was successful, their
5276	storage files are deleted as well. For convenience, this array of media files can be
5277	the same as the one returned from a previous <link to="#unregister" /> call.
5278
5279	This method must only be called on machines which are either write-locked (i.e. on instances
5280	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5281	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5282	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5283
5284	The following files will be deleted by this method:
5285	<ul>
5286	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5287	argument other than "UnregisterOnly", this will delete all saved state files that
5288	the machine had in use; possibly one if the machine was in "Saved" state and one
5289	for each online snapshot that the machine had.</li>
5290	<li>On each medium object passed in the @a aMedia array, this will call
5291	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5292	medium's storage on disk. Since the close() call will fail if the medium is still
5293	in use, e.g. because it is still attached to a second machine; in that case the
5294	storage will not be deleted.</li>
5295	<li>Finally, the machine's own XML file will be deleted.</li>
5296	</ul>
5297
5298	Since deleting large disk image files can be a time-consuming I/O operation, this
5299	method operates asynchronously and returns an IProgress object to allow the caller
5300	to monitor the progress. There will be one sub-operation for each file that is
5301	being deleted (saved state or medium storage file).
5302
5303	<note>
5304	<link to="#settingsModified"/> will return @c true after this
5305	method successfully returns.
5306	</note>
5307
5308	<result name="VBOX_E_INVALID_VM_STATE">
5309	Machine is registered but not write-locked.
5310	</result>
5311	<result name="VBOX_E_IPRT_ERROR">
5312	Could not delete the settings file.
5313	</result>
5314	</desc>
5315	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5316	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5317	</param>
5318	<param name="aProgress" type="IProgress" dir="return">
5319	<desc>Progress object to track the operation completion.</desc>
5320	</param>
5321	</method>
5322
5323	<method name="export">
5324	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5325	steps required to export VirtualBox machines to OVF.
5326	</desc>
5327
5328	<param name="aAppliance" type="IAppliance" dir="in">
5329	<desc>Appliance to export this machine to.</desc>
5330	</param>
5331	<param name="location" type="wstring" dir="in">
5332	<desc>The target location.</desc>
5333	</param>
5334	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5335	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5336	</param>
5337	</method >
5338
5339	<method name="findSnapshot">
5340	<desc>
5341	Returns a snapshot of this machine with the given name or UUID.
5342
5343	Returns a snapshot of this machine with the given UUID.
5344	A @c null argument can be used to obtain the first snapshot
5345	taken on this machine. This is useful if you want to traverse
5346	the whole tree of snapshots starting from the root.
5347
5348	<result name="VBOX_E_OBJECT_NOT_FOUND">
5349	Virtual machine has no snapshots or snapshot not found.
5350	</result>
5351
5352	</desc>
5353	<param name="nameOrId" type="wstring" dir="in">
5354	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5355	</param>
5356	<param name="snapshot" type="ISnapshot" dir="return">
5357	<desc>Snapshot object with the given name.</desc>
5358	</param>
5359	</method>
5360
5361	<method name="createSharedFolder">
5362	<desc>
5363	Creates a new permanent shared folder by associating the given logical
5364	name with the given host path, adds it to the collection of shared
5365	folders and starts sharing it. Refer to the description of
5366	<link to="ISharedFolder"/> to read more about logical names.
5367
5368	<result name="VBOX_E_OBJECT_IN_USE">
5369	Shared folder already exists.
5370	</result>
5371	<result name="VBOX_E_FILE_ERROR">
5372	Shared folder @a hostPath not accessible.
5373	</result>
5374
5375	</desc>
5376	<param name="name" type="wstring" dir="in">
5377	<desc>Unique logical name of the shared folder.</desc>
5378	</param>
5379	<param name="hostPath" type="wstring" dir="in">
5380	<desc>Full path to the shared folder in the host file system.</desc>
5381	</param>
5382	<param name="writable" type="boolean" dir="in">
5383	<desc>Whether the share is writable or readonly.</desc>
5384	</param>
5385	<param name="automount" type="boolean" dir="in">
5386	<desc>Whether the share gets automatically mounted by the guest
5387	or not.</desc>
5388	</param>
5389	</method>
5390
5391	<method name="removeSharedFolder">
5392	<desc>
5393	Removes the permanent shared folder with the given name previously
5394	created by <link to="#createSharedFolder"/> from the collection of
5395	shared folders and stops sharing it.
5396
5397	<result name="VBOX_E_INVALID_VM_STATE">
5398	Virtual machine is not mutable.
5399	</result>
5400	<result name="VBOX_E_OBJECT_NOT_FOUND">
5401	Shared folder @a name does not exist.
5402	</result>
5403
5404	</desc>
5405	<param name="name" type="wstring" dir="in">
5406	<desc>Logical name of the shared folder to remove.</desc>
5407	</param>
5408	</method>
5409
5410	<method name="canShowConsoleWindow">
5411	<desc>
5412	Returns @c true if the VM console process can activate the
5413	console window and bring it to foreground on the desktop of
5414	the host PC.
5415	<note>
5416	This method will fail if a session for this machine is not
5417	currently open.
5418	</note>
5419
5420	<result name="VBOX_E_INVALID_VM_STATE">
5421	Machine session is not open.
5422	</result>
5423
5424	</desc>
5425	<param name="canShow" type="boolean" dir="return">
5426	<desc>
5427	@c true if the console window can be shown and @c false otherwise.
5428	</desc>
5429	</param>
5430	</method>
5431
5432	<method name="showConsoleWindow">
5433	<desc>
5434	Activates the console window and brings it to foreground on
5435	the desktop of the host PC. Many modern window managers on
5436	many platforms implement some sort of focus stealing
5437	prevention logic, so that it may be impossible to activate
5438	a window without the help of the currently active
5439	application. In this case, this method will return a non-zero
5440	identifier that represents the top-level window of the VM
5441	console process. The caller, if it represents a currently
5442	active process, is responsible to use this identifier (in a
5443	platform-dependent manner) to perform actual window
5444	activation.
5445	<note>
5446	This method will fail if a session for this machine is not
5447	currently open.
5448	</note>
5449
5450	<result name="VBOX_E_INVALID_VM_STATE">
5451	Machine session is not open.
5452	</result>
5453
5454	</desc>
5455	<param name="winId" type="long long" dir="return">
5456	<desc>
5457	Platform-dependent identifier of the top-level VM console
5458	window, or zero if this method has performed all actions
5459	necessary to implement the <i>show window</i> semantics for
5460	the given platform and/or VirtualBox front-end.
5461	</desc>
5462	</param>
5463	</method>
5464
5465	<method name="getGuestProperty" const="yes">
5466	<desc>
5467	Reads an entry from the machine's guest property store.
5468
5469	<result name="VBOX_E_INVALID_VM_STATE">
5470	Machine session is not open.
5471	</result>
5472
5473	</desc>
5474	<param name="name" type="wstring" dir="in">
5475	<desc>
5476	The name of the property to read.
5477	</desc>
5478	</param>
5479	<param name="value" type="wstring" dir="out">
5480	<desc>
5481	The value of the property. If the property does not exist then this
5482	will be empty.
5483	</desc>
5484	</param>
5485	<param name="timestamp" type="long long" dir="out">
5486	<desc>
5487	The time at which the property was last modified, as seen by the
5488	server process.
5489	</desc>
5490	</param>
5491	<param name="flags" type="wstring" dir="out">
5492	<desc>
5493	Additional property parameters, passed as a comma-separated list of
5494	"name=value" type entries.
5495	</desc>
5496	</param>
5497	</method>
5498
5499	<method name="getGuestPropertyValue" const="yes">
5500	<desc>
5501	Reads a value from the machine's guest property store.
5502
5503	<result name="VBOX_E_INVALID_VM_STATE">
5504	Machine session is not open.
5505	</result>
5506
5507	</desc>
5508	<param name="property" type="wstring" dir="in">
5509	<desc>
5510	The name of the property to read.
5511	</desc>
5512	</param>
5513	<param name="value" type="wstring" dir="return">
5514	<desc>
5515	The value of the property. If the property does not exist then this
5516	will be empty.
5517	</desc>
5518	</param>
5519	</method>
5520
5521	<method name="getGuestPropertyTimestamp" const="yes">
5522	<desc>
5523	Reads a property timestamp from the machine's guest property store.
5524
5525	<result name="VBOX_E_INVALID_VM_STATE">
5526	Machine session is not open.
5527	</result>
5528
5529	</desc>
5530	<param name="property" type="wstring" dir="in">
5531	<desc>
5532	The name of the property to read.
5533	</desc>
5534	</param>
5535	<param name="value" type="long long" dir="return">
5536	<desc>
5537	The timestamp. If the property does not exist then this will be
5538	empty.
5539	</desc>
5540	</param>
5541	</method>
5542
5543	<method name="setGuestProperty">
5544	<desc>
5545	Sets, changes or deletes an entry in the machine's guest property
5546	store.
5547
5548	<result name="E_ACCESSDENIED">
5549	Property cannot be changed.
5550	</result>
5551	<result name="E_INVALIDARG">
5552	Invalid @a flags.
5553	</result>
5554	<result name="VBOX_E_INVALID_VM_STATE">
5555	Virtual machine is not mutable or session not open.
5556	</result>
5557	<result name="VBOX_E_INVALID_OBJECT_STATE">
5558	Cannot set transient property when machine not running.
5559	</result>
5560
5561	</desc>
5562	<param name="property" type="wstring" dir="in">
5563	<desc>
5564	The name of the property to set, change or delete.
5565	</desc>
5566	</param>
5567	<param name="value" type="wstring" dir="in">
5568	<desc>
5569	The new value of the property to set, change or delete. If the
5570	property does not yet exist and value is non-empty, it will be
5571	created. If the value is @c null or empty, the property will be
5572	deleted if it exists.
5573	</desc>
5574	</param>
5575	<param name="flags" type="wstring" dir="in">
5576	<desc>
5577	Additional property parameters, passed as a comma-separated list of
5578	"name=value" type entries.
5579	</desc>
5580	</param>
5581	</method>
5582
5583	<method name="setGuestPropertyValue">
5584	<desc>
5585	Sets, changes or deletes a value in the machine's guest property
5586	store. The flags field will be left unchanged or created empty for a
5587	new property.
5588
5589	<result name="E_ACCESSDENIED">
5590	Property cannot be changed.
5591	</result>
5592	<result name="VBOX_E_INVALID_VM_STATE">
5593	Virtual machine is not mutable or session not open.
5594	</result>
5595	<result name="VBOX_E_INVALID_OBJECT_STATE">
5596	Cannot set transient property when machine not running.
5597	</result>
5598	</desc>
5599
5600	<param name="property" type="wstring" dir="in">
5601	<desc>
5602	The name of the property to set, change or delete.
5603	</desc>
5604	</param>
5605	<param name="value" type="wstring" dir="in">
5606	<desc>
5607	The new value of the property to set, change or delete. If the
5608	property does not yet exist and value is non-empty, it will be
5609	created. If the value is @c null or empty, the property will be
5610	deleted if it exists.
5611	</desc>
5612	</param>
5613	</method>
5614
5615	<method name="enumerateGuestProperties">
5616	<desc>
5617	Return a list of the guest properties matching a set of patterns along
5618	with their values, time stamps and flags.
5619	</desc>
5620	<param name="patterns" type="wstring" dir="in">
5621	<desc>
5622	The patterns to match the properties against, separated by '\|'
5623	characters. If this is empty or @c null, all properties will match.
5624	</desc>
5625	</param>
5626	<param name="name" type="wstring" dir="out" safearray="yes">
5627	<desc>
5628	The names of the properties returned.
5629	</desc>
5630	</param>
5631	<param name="value" type="wstring" dir="out" safearray="yes">
5632	<desc>
5633	The values of the properties returned. The array entries match the
5634	corresponding entries in the @a name array.
5635	</desc>
5636	</param>
5637	<param name="timestamp" type="long long" dir="out" safearray="yes">
5638	<desc>
5639	The time stamps of the properties returned. The array entries match
5640	the corresponding entries in the @a name array.
5641	</desc>
5642	</param>
5643	<param name="flags" type="wstring" dir="out" safearray="yes">
5644	<desc>
5645	The flags of the properties returned. The array entries match the
5646	corresponding entries in the @a name array.
5647	</desc>
5648	</param>
5649	</method>
5650
5651	<method name="querySavedGuestSize">
5652	<desc>
5653	Returns the guest dimensions from the saved state.
5654	</desc>
5655	<param name="screenId" type="unsigned long" dir="in">
5656	<desc>
5657	Saved guest screen to query info from.
5658	</desc>
5659	</param>
5660	<param name="width" type="unsigned long" dir="out">
5661	<desc>
5662	Guest width at the time of the saved state was taken.
5663	</desc>
5664	</param>
5665	<param name="height" type="unsigned long" dir="out">
5666	<desc>
5667	Guest height at the time of the saved state was taken.
5668	</desc>
5669	</param>
5670	</method>
5671
5672	<method name="querySavedThumbnailSize">
5673	<desc>
5674	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5675	</desc>
5676	<param name="screenId" type="unsigned long" dir="in">
5677	<desc>
5678	Saved guest screen to query info from.
5679	</desc>
5680	</param>
5681	<param name="size" type="unsigned long" dir="out">
5682	<desc>
5683	Size of buffer required to store the bitmap.
5684	</desc>
5685	</param>
5686	<param name="width" type="unsigned long" dir="out">
5687	<desc>
5688	Bitmap width.
5689	</desc>
5690	</param>
5691	<param name="height" type="unsigned long" dir="out">
5692	<desc>
5693	Bitmap height.
5694	</desc>
5695	</param>
5696	</method>
5697
5698	<method name="readSavedThumbnailToArray">
5699	<desc>
5700	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5701	</desc>
5702	<param name="screenId" type="unsigned long" dir="in">
5703	<desc>
5704	Saved guest screen to read from.
5705	</desc>
5706	</param>
5707	<param name="BGR" type="boolean" dir="in">
5708	<desc>
5709	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5710	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5711	</desc>
5712	</param>
5713	<param name="width" type="unsigned long" dir="out">
5714	<desc>
5715	Bitmap width.
5716	</desc>
5717	</param>
5718	<param name="height" type="unsigned long" dir="out">
5719	<desc>
5720	Bitmap height.
5721	</desc>
5722	</param>
5723	<param name="data" type="octet" safearray="yes" dir="return">
5724	<desc>
5725	Array with resulting bitmap data.
5726	</desc>
5727	</param>
5728	</method>
5729
5730	<method name="readSavedThumbnailPNGToArray">
5731	<desc>
5732	Thumbnail in PNG format is retrieved to an array of bytes.
5733	</desc>
5734	<param name="screenId" type="unsigned long" dir="in">
5735	<desc>
5736	Saved guest screen to read from.
5737	</desc>
5738	</param>
5739	<param name="width" type="unsigned long" dir="out">
5740	<desc>
5741	Image width.
5742	</desc>
5743	</param>
5744	<param name="height" type="unsigned long" dir="out">
5745	<desc>
5746	Image height.
5747	</desc>
5748	</param>
5749	<param name="data" type="octet" dir="return" safearray="yes">
5750	<desc>
5751	Array with resulting PNG data.
5752	</desc>
5753	</param>
5754	</method>
5755
5756	<method name="querySavedScreenshotPNGSize">
5757	<desc>
5758	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5759	</desc>
5760	<param name="screenId" type="unsigned long" dir="in">
5761	<desc>
5762	Saved guest screen to query info from.
5763	</desc>
5764	</param>
5765	<param name="size" type="unsigned long" dir="out">
5766	<desc>
5767	Size of buffer required to store the PNG binary data.
5768	</desc>
5769	</param>
5770	<param name="width" type="unsigned long" dir="out">
5771	<desc>
5772	Image width.
5773	</desc>
5774	</param>
5775	<param name="height" type="unsigned long" dir="out">
5776	<desc>
5777	Image height.
5778	</desc>
5779	</param>
5780	</method>
5781
5782	<method name="readSavedScreenshotPNGToArray">
5783	<desc>
5784	Screenshot in PNG format is retrieved to an array of bytes.
5785	</desc>
5786	<param name="screenId" type="unsigned long" dir="in">
5787	<desc>
5788	Saved guest screen to read from.
5789	</desc>
5790	</param>
5791	<param name="width" type="unsigned long" dir="out">
5792	<desc>
5793	Image width.
5794	</desc>
5795	</param>
5796	<param name="height" type="unsigned long" dir="out">
5797	<desc>
5798	Image height.
5799	</desc>
5800	</param>
5801	<param name="data" type="octet" dir="return" safearray="yes">
5802	<desc>
5803	Array with resulting PNG data.
5804	</desc>
5805	</param>
5806	</method>
5807
5808	<method name="hotPlugCPU">
5809	<desc>
5810	Plugs a CPU into the machine.
5811	</desc>
5812	<param name="cpu" type="unsigned long" dir="in">
5813	<desc>
5814	The CPU id to insert.
5815	</desc>
5816	</param>
5817	</method>
5818
5819	<method name="hotUnplugCPU">
5820	<desc>
5821	Removes a CPU from the machine.
5822	</desc>
5823	<param name="cpu" type="unsigned long" dir="in">
5824	<desc>
5825	The CPU id to remove.
5826	</desc>
5827	</param>
5828	</method>
5829
5830	<method name="getCPUStatus">
5831	<desc>
5832	Returns the current status of the given CPU.
5833	</desc>
5834	<param name="cpu" type="unsigned long" dir="in">
5835	<desc>
5836	The CPU id to check for.
5837	</desc>
5838	</param>
5839	<param name="attached" type="boolean" dir="return">
5840	<desc>
5841	Status of the CPU.
5842	</desc>
5843	</param>
5844	</method>
5845
5846	<method name="queryLogFilename">
5847	<desc>
5848	Queries for the VM log file name of an given index. Returns an empty
5849	string if a log file with that index doesn't exists.
5850	</desc>
5851	<param name="idx" type="unsigned long" dir="in">
5852	<desc>
5853	Which log file name to query. 0=current log file.
5854	</desc>
5855	</param>
5856	<param name="filename" type="wstring" dir="return">
5857	<desc>
5858	On return the full path to the log file or an empty string on error.
5859	</desc>
5860	</param>
5861	</method>
5862
5863	<method name="readLog">
5864	<desc>
5865	Reads the VM log file. The chunk size is limited, so even if you
5866	ask for a big piece there might be less data returned.
5867	</desc>
5868	<param name="idx" type="unsigned long" dir="in">
5869	<desc>
5870	Which log file to read. 0=current log file.
5871	</desc>
5872	</param>
5873	<param name="offset" type="long long" dir="in">
5874	<desc>
5875	Offset in the log file.
5876	</desc>
5877	</param>
5878	<param name="size" type="long long" dir="in">
5879	<desc>
5880	Chunk size to read in the log file.
5881	</desc>
5882	</param>
5883	<param name="data" type="octet" dir="return" safearray="yes">
5884	<desc>
5885	Data read from the log file. A data size of 0 means end of file
5886	if the requested chunk size was not 0. This is the unprocessed
5887	file data, i.e. the line ending style depends on the platform of
5888	the system the server is running on.
5889	</desc>
5890	</param>
5891	</method>
5892	</interface>
5893
5894	<!--
5895	// IConsole
5896	/////////////////////////////////////////////////////////////////////////
5897	-->
5898
5899	<interface
5900	name="IVRDEServerInfo" extends="$unknown"
5901	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5902	wsmap="struct"
5903	>
5904	<desc>
5905	Contains information about the remote desktop (VRDE) server capabilities and status.
5906	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5907	</desc>
5908
5909	<attribute name="active" type="boolean" readonly="yes">
5910	<desc>
5911	Whether the remote desktop connection is active.
5912	</desc>
5913	</attribute>
5914
5915	<attribute name="port" type="long" readonly="yes">
5916	<desc>
5917	VRDE server port number. If this property is equal to <tt>0</tt>, then
5918	the VRDE server failed to start, usually because there are no free IP
5919	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5920	server has not yet been started.
5921	</desc>
5922	</attribute>
5923
5924	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5925	<desc>
5926	How many times a client connected.
5927	</desc>
5928	</attribute>
5929
5930	<attribute name="beginTime" type="long long" readonly="yes">
5931	<desc>
5932	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5933	</desc>
5934	</attribute>
5935
5936	<attribute name="endTime" type="long long" readonly="yes">
5937	<desc>
5938	When the last connection was terminated or the current time, if
5939	connection is still active, in milliseconds since 1970-01-01 UTC.
5940	</desc>
5941	</attribute>
5942
5943	<attribute name="bytesSent" type="long long" readonly="yes">
5944	<desc>
5945	How many bytes were sent in last or current, if still active, connection.
5946	</desc>
5947	</attribute>
5948
5949	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5950	<desc>
5951	How many bytes were sent in all connections.
5952	</desc>
5953	</attribute>
5954
5955	<attribute name="bytesReceived" type="long long" readonly="yes">
5956	<desc>
5957	How many bytes were received in last or current, if still active, connection.
5958	</desc>
5959	</attribute>
5960
5961	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5962	<desc>
5963	How many bytes were received in all connections.
5964	</desc>
5965	</attribute>
5966
5967	<attribute name="user" type="wstring" readonly="yes">
5968	<desc>
5969	Login user name supplied by the client.
5970	</desc>
5971	</attribute>
5972
5973	<attribute name="domain" type="wstring" readonly="yes">
5974	<desc>
5975	Login domain name supplied by the client.
5976	</desc>
5977	</attribute>
5978
5979	<attribute name="clientName" type="wstring" readonly="yes">
5980	<desc>
5981	The client name supplied by the client.
5982	</desc>
5983	</attribute>
5984
5985	<attribute name="clientIP" type="wstring" readonly="yes">
5986	<desc>
5987	The IP address of the client.
5988	</desc>
5989	</attribute>
5990
5991	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5992	<desc>
5993	The client software version number.
5994	</desc>
5995	</attribute>
5996
5997	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5998	<desc>
5999	Public key exchange method used when connection was established.
6000	Values: 0 - RDP4 public key exchange scheme.
6001	1 - X509 certificates were sent to client.
6002	</desc>
6003	</attribute>
6004
6005	</interface>
6006
6007	<interface
6008	name="IConsole" extends="$unknown"
6009	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6010	wsmap="managed"
6011	>
6012	<desc>
6013	The IConsole interface represents an interface to control virtual
6014	machine execution.
6015
6016	A console object gets created when a machine has been locked for a
6017	particular session (client process) using <link to="IMachine::lockMachine" />
6018	or <link to="IMachine::launchVMProcess"/>. The console object can
6019	then be found in the session's <link to="ISession::console" /> attribute.
6020
6021	Methods of the IConsole interface allow the caller to query the current
6022	virtual machine execution state, pause the machine or power it down, save
6023	the machine state or take a snapshot, attach and detach removable media
6024	and so on.
6025
6026	<see>ISession</see>
6027	</desc>
6028
6029	<attribute name="machine" type="IMachine" readonly="yes">
6030	<desc>
6031	Machine object for this console session.
6032	<note>
6033	This is a convenience property, it has the same value as
6034	<link to="ISession::machine"/> of the corresponding session
6035	object.
6036	</note>
6037	</desc>
6038	</attribute>
6039
6040	<attribute name="state" type="MachineState" readonly="yes">
6041	<desc>
6042	Current execution state of the machine.
6043	<note>
6044	This property always returns the same value as the corresponding
6045	property of the IMachine object for this console session.
6046	For the process that owns (executes) the VM, this is the
6047	preferable way of querying the VM state, because no IPC
6048	calls are made.
6049	</note>
6050	</desc>
6051	</attribute>
6052
6053	<attribute name="guest" type="IGuest" readonly="yes">
6054	<desc>Guest object.</desc>
6055	</attribute>
6056
6057	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6058	<desc>
6059	Virtual keyboard object.
6060	<note>
6061	If the machine is not running, any attempt to use
6062	the returned object will result in an error.
6063	</note>
6064	</desc>
6065	</attribute>
6066
6067	<attribute name="mouse" type="IMouse" readonly="yes">
6068	<desc>
6069	Virtual mouse object.
6070	<note>
6071	If the machine is not running, any attempt to use
6072	the returned object will result in an error.
6073	</note>
6074	</desc>
6075	</attribute>
6076
6077	<attribute name="display" type="IDisplay" readonly="yes">
6078	<desc>Virtual display object.
6079	<note>
6080	If the machine is not running, any attempt to use
6081	the returned object will result in an error.
6082	</note>
6083	</desc>
6084	</attribute>
6085
6086	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6087	<desc>Debugging interface.</desc>
6088	</attribute>
6089
6090	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6091	<desc>
6092	Collection of USB devices currently attached to the virtual
6093	USB controller.
6094	<note>
6095	The collection is empty if the machine is not running.
6096	</note>
6097	</desc>
6098	</attribute>
6099
6100	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6101	<desc>
6102	List of USB devices currently attached to the remote VRDE client.
6103	Once a new device is physically attached to the remote host computer,
6104	it appears in this list and remains there until detached.
6105	</desc>
6106	</attribute>
6107
6108	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6109	<desc>
6110	Collection of shared folders for the current session. These folders
6111	are called transient shared folders because they are available to the
6112	guest OS running inside the associated virtual machine only for the
6113	duration of the session (as opposed to
6114	<link to="IMachine::sharedFolders"/> which represent permanent shared
6115	folders). When the session is closed (e.g. the machine is powered down),
6116	these folders are automatically discarded.
6117
6118	New shared folders are added to the collection using
6119	<link to="#createSharedFolder"/>. Existing shared folders can be
6120	removed using <link to="#removeSharedFolder"/>.
6121	</desc>
6122	</attribute>
6123
6124	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6125	<desc>
6126	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6127	</desc>
6128	</attribute>
6129
6130	<attribute name="eventSource" type="IEventSource" readonly="yes">
6131	<desc>
6132	Event source for console events.
6133	</desc>
6134	</attribute>
6135
6136	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6137	<desc>Array of PCI devices attached to this machine.</desc>
6138	</attribute>
6139
6140	<method name="powerUp">
6141	<desc>
6142	Starts the virtual machine execution using the current machine
6143	state (that is, its current execution state, current settings and
6144	current storage devices).
6145
6146	<note>
6147	This method is only useful for front-ends that want to actually
6148	execute virtual machines in their own process (like the VirtualBox
6149	or VBoxSDL front-ends). Unless you are intending to write such a
6150	front-end, do not call this method. If you simply want to
6151	start virtual machine execution using one of the existing front-ends
6152	(for example the VirtualBox GUI or headless server), use
6153	<link to="IMachine::launchVMProcess"/> instead; these
6154	front-ends will power up the machine automatically for you.
6155	</note>
6156
6157	If the machine is powered off or aborted, the execution will
6158	start from the beginning (as if the real hardware were just
6159	powered on).
6160
6161	If the machine is in the <link to="MachineState_Saved"/> state,
6162	it will continue its execution the point where the state has
6163	been saved.
6164
6165	If the machine <link to="IMachine::teleporterEnabled"/> property is
6166	enabled on the machine being powered up, the machine will wait for an
6167	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6168	state. The returned progress object will have at least three
6169	operations where the last three are defined as: (1) powering up and
6170	starting TCP server, (2) waiting for incoming teleportations, and
6171	(3) perform teleportation. These operations will be reflected as the
6172	last three operations of the progress objected returned by
6173	<link to="IMachine::launchVMProcess"/> as well.
6174
6175	<see>#saveState</see>
6176
6177	<result name="VBOX_E_INVALID_VM_STATE">
6178	Virtual machine already running.
6179	</result>
6180	<result name="VBOX_E_HOST_ERROR">
6181	Host interface does not exist or name not set.
6182	</result>
6183	<result name="VBOX_E_FILE_ERROR">
6184	Invalid saved state file.
6185	</result>
6186	</desc>
6187	<param name="progress" type="IProgress" dir="return">
6188	<desc>Progress object to track the operation completion.</desc>
6189	</param>
6190	</method>
6191
6192	<method name="powerUpPaused">
6193	<desc>
6194	Identical to powerUp except that the VM will enter the
6195	<link to="MachineState_Paused"/> state, instead of
6196	<link to="MachineState_Running"/>.
6197
6198	<see>#powerUp</see>
6199	<result name="VBOX_E_INVALID_VM_STATE">
6200	Virtual machine already running.
6201	</result>
6202	<result name="VBOX_E_HOST_ERROR">
6203	Host interface does not exist or name not set.
6204	</result>
6205	<result name="VBOX_E_FILE_ERROR">
6206	Invalid saved state file.
6207	</result>
6208	</desc>
6209	<param name="progress" type="IProgress" dir="return">
6210	<desc>Progress object to track the operation completion.</desc>
6211	</param>
6212	</method>
6213
6214	<method name="powerDown">
6215	<desc>
6216	Initiates the power down procedure to stop the virtual machine
6217	execution.
6218
6219	The completion of the power down procedure is tracked using the returned
6220	IProgress object. After the operation is complete, the machine will go
6221	to the PoweredOff state.
6222	<result name="VBOX_E_INVALID_VM_STATE">
6223	Virtual machine must be Running, Paused or Stuck to be powered down.
6224	</result>
6225	</desc>
6226	<param name="progress" type="IProgress" dir="return">
6227	<desc>Progress object to track the operation completion.</desc>
6228	</param>
6229	</method>
6230
6231	<method name="reset">
6232	<desc>Resets the virtual machine.
6233	<result name="VBOX_E_INVALID_VM_STATE">
6234	Virtual machine not in Running state.
6235	</result>
6236	<result name="VBOX_E_VM_ERROR">
6237	Virtual machine error in reset operation.
6238	</result>
6239	</desc>
6240	</method>
6241
6242	<method name="pause">
6243	<desc>Pauses the virtual machine execution.
6244	<result name="VBOX_E_INVALID_VM_STATE">
6245	Virtual machine not in Running state.
6246	</result>
6247	<result name="VBOX_E_VM_ERROR">
6248	Virtual machine error in suspend operation.
6249	</result>
6250	</desc>
6251	</method>
6252
6253	<method name="resume">
6254	<desc>Resumes the virtual machine execution.
6255	<result name="VBOX_E_INVALID_VM_STATE">
6256	Virtual machine not in Paused state.
6257	</result>
6258	<result name="VBOX_E_VM_ERROR">
6259	Virtual machine error in resume operation.
6260	</result>
6261	</desc>
6262	</method>
6263
6264	<method name="powerButton">
6265	<desc>Sends the ACPI power button event to the guest.
6266	<result name="VBOX_E_INVALID_VM_STATE">
6267	Virtual machine not in Running state.
6268	</result>
6269	<result name="VBOX_E_PDM_ERROR">
6270	Controlled power off failed.
6271	</result>
6272	</desc>
6273	</method>
6274
6275	<method name="sleepButton">
6276	<desc>Sends the ACPI sleep button event to the guest.
6277	<result name="VBOX_E_INVALID_VM_STATE">
6278	Virtual machine not in Running state.
6279	</result>
6280	<result name="VBOX_E_PDM_ERROR">
6281	Sending sleep button event failed.
6282	</result>
6283	</desc>
6284	</method>
6285
6286	<method name="getPowerButtonHandled">
6287	<desc>Checks if the last power button event was handled by guest.
6288	<result name="VBOX_E_PDM_ERROR">
6289	Checking if the event was handled by the guest OS failed.
6290	</result>
6291	</desc>
6292	<param name="handled" type="boolean" dir="return"/>
6293	</method>
6294
6295	<method name="getGuestEnteredACPIMode">
6296	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6297	G1 (sleeping). If this method returns @c false, the guest will
6298	most likely not respond to external ACPI events.
6299	<result name="VBOX_E_INVALID_VM_STATE">
6300	Virtual machine not in Running state.
6301	</result>
6302	</desc>
6303	<param name="entered" type="boolean" dir="return"/>
6304	</method>
6305
6306	<method name="saveState">
6307	<desc>
6308	Saves the current execution state of a running virtual machine
6309	and stops its execution.
6310
6311	After this operation completes, the machine will go to the
6312	Saved state. Next time it is powered up, this state will
6313	be restored and the machine will continue its execution from
6314	the place where it was saved.
6315
6316	This operation differs from taking a snapshot to the effect
6317	that it doesn't create new differencing media. Also, once
6318	the machine is powered up from the state saved using this method,
6319	the saved state is deleted, so it will be impossible to return
6320	to this state later.
6321
6322	<note>
6323	On success, this method implicitly calls
6324	<link to="IMachine::saveSettings"/> to save all current machine
6325	settings (including runtime changes to the DVD medium, etc.).
6326	Together with the impossibility to change any VM settings when it is
6327	in the Saved state, this guarantees adequate hardware
6328	configuration of the machine when it is restored from the saved
6329	state file.
6330	</note>
6331
6332	<note>
6333	The machine must be in the Running or Paused state, otherwise
6334	the operation will fail.
6335	</note>
6336	<result name="VBOX_E_INVALID_VM_STATE">
6337	Virtual machine state neither Running nor Paused.
6338	</result>
6339	<result name="VBOX_E_FILE_ERROR">
6340	Failed to create directory for saved state file.
6341	</result>
6342
6343	<see><link to="#takeSnapshot"/></see>
6344	</desc>
6345	<param name="progress" type="IProgress" dir="return">
6346	<desc>Progress object to track the operation completion.</desc>
6347	</param>
6348	</method>
6349
6350	<method name="adoptSavedState">
6351	<desc>
6352	Associates the given saved state file to the virtual machine.
6353
6354	On success, the machine will go to the Saved state. Next time it is
6355	powered up, it will be restored from the adopted saved state and
6356	continue execution from the place where the saved state file was
6357	created.
6358
6359	The specified saved state file path may be absolute or relative to the
6360	folder the VM normally saves the state to (usually,
6361	<link to="IMachine::snapshotFolder"/>).
6362
6363	<note>
6364	It's a caller's responsibility to make sure the given saved state
6365	file is compatible with the settings of this virtual machine that
6366	represent its virtual hardware (memory size, storage disk configuration
6367	etc.). If there is a mismatch, the behavior of the virtual machine
6368	is undefined.
6369	</note>
6370	<result name="VBOX_E_INVALID_VM_STATE">
6371	Virtual machine state neither PoweredOff nor Aborted.
6372	</result>
6373	</desc>
6374	<param name="savedStateFile" type="wstring" dir="in">
6375	<desc>Path to the saved state file to adopt.</desc>
6376	</param>
6377	</method>
6378
6379	<method name="discardSavedState">
6380	<desc>
6381	Forcibly resets the machine to "Powered Off" state if it is
6382	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6383	Next time the machine is powered up, a clean boot will occur.
6384	<note>
6385	This operation is equivalent to resetting or powering off
6386	the machine without doing a proper shutdown of the guest
6387	operating system; as with resetting a running phyiscal
6388	computer, it can can lead to data loss.
6389	</note>
6390	If @a fRemoveFile is @c true, the file in the machine directory
6391	into which the machine state was saved is also deleted. If
6392	this is @c false, then the state can be recovered and later
6393	re-inserted into a machine using <link to="#adoptSavedState" />.
6394	The location of the file can be found in the
6395	<link to="IMachine::stateFilePath" /> attribute.
6396	<result name="VBOX_E_INVALID_VM_STATE">
6397	Virtual machine not in state Saved.
6398	</result>
6399	</desc>
6400	<param name="fRemoveFile" type="boolean" dir="in" >
6401	<desc>Whether to also remove the saved state file.</desc>
6402	</param>
6403	</method>
6404
6405	<method name="getDeviceActivity">
6406	<desc>
6407	Gets the current activity type of a given device or device group.
6408	<result name="E_INVALIDARG">
6409	Invalid device type.
6410	</result>
6411	</desc>
6412	<param name="type" type="DeviceType" dir="in"/>
6413	<param name="activity" type="DeviceActivity" dir="return"/>
6414	</method>
6415
6416	<method name="attachUSBDevice">
6417	<desc>
6418	Attaches a host USB device with the given UUID to the
6419	USB controller of the virtual machine.
6420
6421	The device needs to be in one of the following states:
6422	<link to="USBDeviceState_Busy"/>,
6423	<link to="USBDeviceState_Available"/> or
6424	<link to="USBDeviceState_Held"/>,
6425	otherwise an error is immediately returned.
6426
6427	When the device state is
6428	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6429	be returned if the host computer refuses to release it for some reason.
6430
6431	<see>IUSBController::deviceFilters, USBDeviceState</see>
6432	<result name="VBOX_E_INVALID_VM_STATE">
6433	Virtual machine state neither Running nor Paused.
6434	</result>
6435	<result name="VBOX_E_PDM_ERROR">
6436	Virtual machine does not have a USB controller.
6437	</result>
6438	</desc>
6439	<param name="id" type="uuid" mod="string" dir="in">
6440	<desc>UUID of the host USB device to attach.</desc>
6441	</param>
6442	</method>
6443
6444	<method name="detachUSBDevice">
6445	<desc>
6446	Detaches an USB device with the given UUID from the USB controller
6447	of the virtual machine.
6448
6449	After this method succeeds, the VirtualBox server re-initiates
6450	all USB filters as if the device were just physically attached
6451	to the host, but filters of this machine are ignored to avoid
6452	a possible automatic re-attachment.
6453
6454	<see>IUSBController::deviceFilters, USBDeviceState</see>
6455
6456	<result name="VBOX_E_PDM_ERROR">
6457	Virtual machine does not have a USB controller.
6458	</result>
6459	<result name="E_INVALIDARG">
6460	USB device not attached to this virtual machine.
6461	</result>
6462	</desc>
6463	<param name="id" type="uuid" mod="string" dir="in">
6464	<desc>UUID of the USB device to detach.</desc>
6465	</param>
6466	<param name="device" type="IUSBDevice" dir="return">
6467	<desc>Detached USB device.</desc>
6468	</param>
6469	</method>
6470
6471	<method name="findUSBDeviceByAddress">
6472	<desc>
6473	Searches for a USB device with the given host address.
6474
6475	<result name="VBOX_E_OBJECT_NOT_FOUND">
6476	Given @c name does not correspond to any USB device.
6477	</result>
6478
6479	<see>IUSBDevice::address</see>
6480	</desc>
6481	<param name="name" type="wstring" dir="in">
6482	<desc>
6483	Address of the USB device (as assigned by the host) to
6484	search for.
6485	</desc>
6486	</param>
6487	<param name="device" type="IUSBDevice" dir="return">
6488	<desc>Found USB device object.</desc>
6489	</param>
6490	</method>
6491
6492	<method name="findUSBDeviceById">
6493	<desc>
6494	Searches for a USB device with the given UUID.
6495
6496	<result name="VBOX_E_OBJECT_NOT_FOUND">
6497	Given @c id does not correspond to any USB device.
6498	</result>
6499
6500	<see>IUSBDevice::id</see>
6501	</desc>
6502	<param name="id" type="uuid" mod="string" dir="in">
6503	<desc>UUID of the USB device to search for.</desc>
6504	</param>
6505	<param name="device" type="IUSBDevice" dir="return">
6506	<desc>Found USB device object.</desc>
6507	</param>
6508	</method>
6509
6510	<method name="createSharedFolder">
6511	<desc>
6512	Creates a transient new shared folder by associating the given logical
6513	name with the given host path, adds it to the collection of shared
6514	folders and starts sharing it. Refer to the description of
6515	<link to="ISharedFolder"/> to read more about logical names.
6516
6517	<result name="VBOX_E_INVALID_VM_STATE">
6518	Virtual machine in Saved state or currently changing state.
6519	</result>
6520	<result name="VBOX_E_FILE_ERROR">
6521	Shared folder already exists or not accessible.
6522	</result>
6523	</desc>
6524	<param name="name" type="wstring" dir="in">
6525	<desc>Unique logical name of the shared folder.</desc>
6526	</param>
6527	<param name="hostPath" type="wstring" dir="in">
6528	<desc>Full path to the shared folder in the host file system.</desc>
6529	</param>
6530	<param name="writable" type="boolean" dir="in">
6531	<desc>Whether the share is writable or readonly</desc>
6532	</param>
6533	<param name="automount" type="boolean" dir="in">
6534	<desc>Whether the share gets automatically mounted by the guest
6535	or not.</desc>
6536	</param>
6537	</method>
6538
6539	<method name="removeSharedFolder">
6540	<desc>
6541	Removes a transient shared folder with the given name previously
6542	created by <link to="#createSharedFolder"/> from the collection of
6543	shared folders and stops sharing it.
6544	<result name="VBOX_E_INVALID_VM_STATE">
6545	Virtual machine in Saved state or currently changing state.
6546	</result>
6547	<result name="VBOX_E_FILE_ERROR">
6548	Shared folder does not exists.
6549	</result>
6550	</desc>
6551	<param name="name" type="wstring" dir="in">
6552	<desc>Logical name of the shared folder to remove.</desc>
6553	</param>
6554	</method>
6555
6556	<method name="takeSnapshot">
6557	<desc>
6558	Saves the current execution state
6559	and all settings of the machine and creates differencing images
6560	for all normal (non-independent) media.
6561	See <link to="ISnapshot" /> for an introduction to snapshots.
6562
6563	This method can be called for a PoweredOff, Saved (see
6564	<link to="#saveState"/>), Running or
6565	Paused virtual machine. When the machine is PoweredOff, an
6566	offline snapshot is created. When the machine is Running a live
6567	snapshot is created, and an online snapshot is is created when Paused.
6568
6569	The taken snapshot is always based on the
6570	<link to="IMachine::currentSnapshot">current snapshot</link>
6571	of the associated virtual machine and becomes a new current snapshot.
6572
6573	<note>
6574	This method implicitly calls <link to="IMachine::saveSettings"/> to
6575	save all current machine settings before taking an offline snapshot.
6576	</note>
6577
6578	<result name="VBOX_E_INVALID_VM_STATE">
6579	Virtual machine currently changing state.
6580	</result>
6581	</desc>
6582	<param name="name" type="wstring" dir="in">
6583	<desc>Short name for the snapshot.</desc>
6584	</param>
6585	<param name="description" type="wstring" dir="in">
6586	<desc>Optional description of the snapshot.</desc>
6587	</param>
6588	<param name="progress" type="IProgress" dir="return">
6589	<desc>Progress object to track the operation completion.</desc>
6590	</param>
6591	</method>
6592
6593	<method name="deleteSnapshot">
6594	<desc>
6595	Starts deleting the specified snapshot asynchronously.
6596	See <link to="ISnapshot" /> for an introduction to snapshots.
6597
6598	The execution state and settings of the associated machine stored in
6599	the snapshot will be deleted. The contents of all differencing media of
6600	this snapshot will be merged with the contents of their dependent child
6601	media to keep the medium chain valid (in other words, all changes
6602	represented by media being deleted will be propagated to their child
6603	medium). After that, this snapshot's differencing medium will be
6604	deleted. The parent of this snapshot will become a new parent for all
6605	its child snapshots.
6606
6607	If the deleted snapshot is the current one, its parent snapshot will
6608	become a new current snapshot. The current machine state is not directly
6609	affected in this case, except that currently attached differencing
6610	media based on media of the deleted snapshot will be also merged as
6611	described above.
6612
6613	If the deleted snapshot is the first or current snapshot, then the
6614	respective IMachine attributes will be adjusted. Deleting the current
6615	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6616	to make all current machine settings permanent.
6617
6618	Deleting a snapshot has the following preconditions:
6619
6620	<ul>
6621	<li>Child media of all normal media of the deleted snapshot
6622	must be accessible (see <link to="IMedium::state"/>) for this
6623	operation to succeed. In particular, this means that all virtual
6624	machines whose media are directly or indirectly based on the
6625	media of deleted snapshot must be powered off.</li>
6626
6627	<li>You cannot delete the snapshot if a medium attached to it has
6628	more than once child medium (differencing images) because otherwise
6629	merging would be impossible. This might be the case if there is
6630	more than one child snapshot or differencing images were created
6631	for other reason (e.g. implicitly because of multiple machine
6632	attachments).</li>
6633	</ul>
6634
6635
6636	The virtual machine's <link to="IMachine::state">state</link> is
6637	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6638	"DeletingSnapshotPaused" while this operation is in progress.
6639
6640	<note>
6641	Merging medium contents can be very time and disk space
6642	consuming, if these media are big in size and have many
6643	children. However, if the snapshot being deleted is the last
6644	(head) snapshot on the branch, the operation will be rather
6645	quick.
6646	</note>
6647	<result name="VBOX_E_INVALID_VM_STATE">
6648	The running virtual machine prevents deleting this snapshot. This
6649	happens only in very specific situations, usually snapshots can be
6650	deleted without trouble while a VM is running. The error message
6651	text explains the reason for the failure.
6652	</result>
6653	</desc>
6654	<param name="id" type="uuid" mod="string" dir="in">
6655	<desc>UUID of the snapshot to delete.</desc>
6656	</param>
6657	<param name="progress" type="IProgress" dir="return">
6658	<desc>Progress object to track the operation completion.</desc>
6659	</param>
6660	</method>
6661
6662	<method name="restoreSnapshot">
6663	<desc>
6664	Starts resetting the machine's current state to the state contained
6665	in the given snapshot, asynchronously. All current settings of the
6666	machine will be reset and changes stored in differencing media
6667	will be lost.
6668	See <link to="ISnapshot" /> for an introduction to snapshots.
6669
6670	After this operation is successfully completed, new empty differencing
6671	media are created for all normal media of the machine.
6672
6673	If the given snapshot is an online snapshot, the machine will go to
6674	the <link to="MachineState_Saved"> saved state</link>, so that the
6675	next time it is powered on, the execution state will be restored
6676	from the state of the snapshot.
6677
6678	<note>
6679	The machine must not be running, otherwise the operation will fail.
6680	</note>
6681
6682	<note>
6683	If the machine state is <link to="MachineState_Saved">Saved</link>
6684	prior to this operation, the saved state file will be implicitly
6685	deleted (as if <link to="IConsole::discardSavedState"/> were
6686	called).
6687	</note>
6688
6689	<result name="VBOX_E_INVALID_VM_STATE">
6690	Virtual machine is running.
6691	</result>
6692	</desc>
6693	<param name="snapshot" type="ISnapshot" dir="in">
6694	<desc>The snapshot to restore the VM state from.</desc>
6695	</param>
6696	<param name="progress" type="IProgress" dir="return">
6697	<desc>Progress object to track the operation completion.</desc>
6698	</param>
6699	</method>
6700
6701	<method name="teleport">
6702	<desc>
6703	Teleport the VM to a different host machine or process.
6704
6705	TODO explain the details.
6706
6707	<result name="VBOX_E_INVALID_VM_STATE">
6708	Virtual machine not running or paused.
6709	</result>
6710	</desc>
6711	<param name="hostname" type="wstring" dir="in">
6712	<desc>The name or IP of the host to teleport to.</desc>
6713	</param>
6714	<param name="tcpport" type="unsigned long" dir="in">
6715	<desc>The TCP port to connect to (1..65535).</desc>
6716	</param>
6717	<param name="password" type="wstring" dir="in">
6718	<desc>The password.</desc>
6719	</param>
6720	<param name="maxDowntime" type="unsigned long" dir="in">
6721	<desc>
6722	The maximum allowed downtime given as milliseconds. 0 is not a valid
6723	value. Recommended value: 250 ms.
6724
6725	The higher the value is, the greater the chance for a successful
6726	teleportation. A small value may easily result in the teleportation
6727	process taking hours and eventually fail.
6728
6729	<note>
6730	The current implementation treats this a guideline, not as an
6731	absolute rule.
6732	</note>
6733	</desc>
6734	</param>
6735	<param name="progress" type="IProgress" dir="return">
6736	<desc>Progress object to track the operation completion.</desc>
6737	</param>
6738	</method>
6739
6740	</interface>
6741
6742	<!--
6743	// IHost
6744	/////////////////////////////////////////////////////////////////////////
6745	-->
6746
6747	<enum
6748	name="HostNetworkInterfaceMediumType"
6749	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6750	>
6751	<desc>
6752	Type of encapsulation. Ethernet encapsulation includes both wired and
6753	wireless Ethernet connections.
6754	<see>IHostNetworkInterface</see>
6755	</desc>
6756
6757	<const name="Unknown" value="0">
6758	<desc>
6759	The type of interface cannot be determined.
6760	</desc>
6761	</const>
6762	<const name="Ethernet" value="1">
6763	<desc>
6764	Ethernet frame encapsulation.
6765	</desc>
6766	</const>
6767	<const name="PPP" value="2">
6768	<desc>
6769	Point-to-point protocol encapsulation.
6770	</desc>
6771	</const>
6772	<const name="SLIP" value="3">
6773	<desc>
6774	Serial line IP encapsulation.
6775	</desc>
6776	</const>
6777	</enum>
6778
6779	<enum
6780	name="HostNetworkInterfaceStatus"
6781	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6782	>
6783	<desc>
6784	Current status of the interface.
6785	<see>IHostNetworkInterface</see>
6786	</desc>
6787
6788	<const name="Unknown" value="0">
6789	<desc>
6790	The state of interface cannot be determined.
6791	</desc>
6792	</const>
6793	<const name="Up" value="1">
6794	<desc>
6795	The interface is fully operational.
6796	</desc>
6797	</const>
6798	<const name="Down" value="2">
6799	<desc>
6800	The interface is not functioning.
6801	</desc>
6802	</const>
6803	</enum>
6804
6805	<enum
6806	name="HostNetworkInterfaceType"
6807	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6808	>
6809	<desc>
6810	Network interface type.
6811	</desc>
6812	<const name="Bridged" value="1"/>
6813	<const name="HostOnly" value="2"/>
6814	</enum>
6815
6816	<interface
6817	name="IHostNetworkInterface" extends="$unknown"
6818	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6819	wsmap="managed"
6820	>
6821	<desc>
6822	Represents one of host's network interfaces. IP V6 address and network
6823	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6824	separated by colons.
6825	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6826	</desc>
6827	<attribute name="name" type="wstring" readonly="yes">
6828	<desc>Returns the host network interface name.</desc>
6829	</attribute>
6830
6831	<attribute name="id" type="uuid" mod="string" readonly="yes">
6832	<desc>Returns the interface UUID.</desc>
6833	</attribute>
6834
6835	<attribute name="networkName" type="wstring" readonly="yes">
6836	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6837	</attribute>
6838
6839	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6840	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6841	</attribute>
6842
6843	<attribute name="IPAddress" type="wstring" readonly="yes">
6844	<desc>Returns the IP V4 address of the interface.</desc>
6845	</attribute>
6846
6847	<attribute name="networkMask" type="wstring" readonly="yes">
6848	<desc>Returns the network mask of the interface.</desc>
6849	</attribute>
6850
6851	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6852	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6853	</attribute>
6854
6855	<attribute name="IPV6Address" type="wstring" readonly="yes">
6856	<desc>Returns the IP V6 address of the interface.</desc>
6857	</attribute>
6858
6859	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6860	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6861	</attribute>
6862
6863	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6864	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6865	</attribute>
6866
6867	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6868	<desc>Type of protocol encapsulation used.</desc>
6869	</attribute>
6870
6871	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6872	<desc>Status of the interface.</desc>
6873	</attribute>
6874
6875	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6876	<desc>specifies the host interface type.</desc>
6877	</attribute>
6878
6879	<method name="enableStaticIpConfig">
6880	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6881	<param name="IPAddress" type="wstring" dir="in">
6882	<desc>
6883	IP address.
6884	</desc>
6885	</param>
6886	<param name="networkMask" type="wstring" dir="in">
6887	<desc>
6888	network mask.
6889	</desc>
6890	</param>
6891	</method>
6892
6893	<method name="enableStaticIpConfigV6">
6894	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6895	<param name="IPV6Address" type="wstring" dir="in">
6896	<desc>
6897	IP address.
6898	</desc>
6899	</param>
6900	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6901	<desc>
6902	network mask.
6903	</desc>
6904	</param>
6905	</method>
6906
6907	<method name="enableDynamicIpConfig">
6908	<desc>enables the dynamic IP configuration.</desc>
6909	</method>
6910
6911	<method name="dhcpRediscover">
6912	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6913	</method>
6914
6915	</interface>
6916
6917	<interface
6918	name="IHost" extends="$unknown"
6919	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6920	wsmap="managed"
6921	>
6922	<desc>
6923	The IHost interface represents the physical machine that this VirtualBox
6924	installation runs on.
6925
6926	An object implementing this interface is returned by the
6927	<link to="IVirtualBox::host" /> attribute. This interface contains
6928	read-only information about the host's physical hardware (such as what
6929	processors and disks are available, what the host operating system is,
6930	and so on) and also allows for manipulating some of the host's hardware,
6931	such as global USB device filters and host interface networking.
6932
6933	</desc>
6934	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6935	<desc>List of DVD drives available on the host.</desc>
6936	</attribute>
6937
6938	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6939	<desc>List of floppy drives available on the host.</desc>
6940	</attribute>
6941
6942	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6943	<desc>
6944	List of USB devices currently attached to the host.
6945	Once a new device is physically attached to the host computer,
6946	it appears in this list and remains there until detached.
6947
6948	<note>
6949	If USB functionality is not available in the given edition of
6950	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6951	</note>
6952	</desc>
6953	</attribute>
6954
6955	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6956	<desc>
6957	List of USB device filters in action.
6958	When a new device is physically attached to the host computer,
6959	filters from this list are applied to it (in order they are stored
6960	in the list). The first matched filter will determine the
6961	<link to="IHostUSBDeviceFilter::action">action</link>
6962	performed on the device.
6963
6964	Unless the device is ignored by these filters, filters of all
6965	currently running virtual machines
6966	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6967
6968	<note>
6969	If USB functionality is not available in the given edition of
6970	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6971	</note>
6972
6973	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6974	</desc>
6975	</attribute>
6976
6977	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6978	<desc>List of host network interfaces currently defined on the host.</desc>
6979	</attribute>
6980
6981	<attribute name="processorCount" type="unsigned long" readonly="yes">
6982	<desc>Number of (logical) CPUs installed in the host system.</desc>
6983	</attribute>
6984
6985	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6986	<desc>Number of (logical) CPUs online in the host system.</desc>
6987	</attribute>
6988
6989	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6990	<desc>Number of physical processor cores installed in the host system.</desc>
6991	</attribute>
6992
6993	<method name="getProcessorSpeed">
6994	<desc>Query the (approximate) maximum speed of a specified host CPU in
6995	Megahertz.
6996	</desc>
6997	<param name="cpuId" type="unsigned long" dir="in">
6998	<desc>
6999	Identifier of the CPU.
7000	</desc>
7001	</param>
7002	<param name="speed" type="unsigned long" dir="return">
7003	<desc>
7004	Speed value. 0 is returned if value is not known or @a cpuId is
7005	invalid.
7006	</desc>
7007	</param>
7008	</method>
7009
7010	<method name="getProcessorFeature">
7011	<desc>Query whether a CPU feature is supported or not.</desc>
7012	<param name="feature" type="ProcessorFeature" dir="in">
7013	<desc>
7014	CPU Feature identifier.
7015	</desc>
7016	</param>
7017	<param name="supported" type="boolean" dir="return">
7018	<desc>
7019	Feature is supported or not.
7020	</desc>
7021	</param>
7022	</method>
7023
7024	<method name="getProcessorDescription">
7025	<desc>Query the model string of a specified host CPU.
7026	</desc>
7027	<param name="cpuId" type="unsigned long" dir="in">
7028	<desc>
7029	Identifier of the CPU.
7030	<note>
7031	The current implementation might not necessarily return the
7032	description for this exact CPU.
7033	</note>
7034	</desc>
7035	</param>
7036	<param name="description" type="wstring" dir="return">
7037	<desc>
7038	Model string. An empty string is returned if value is not known or
7039	@a cpuId is invalid.
7040	</desc>
7041	</param>
7042	</method>
7043
7044	<method name="getProcessorCPUIDLeaf">
7045	<desc>
7046	Returns the CPU cpuid information for the specified leaf.
7047	</desc>
7048	<param name="cpuId" type="unsigned long" dir="in">
7049	<desc>
7050	Identifier of the CPU. The CPU most be online.
7051	<note>
7052	The current implementation might not necessarily return the
7053	description for this exact CPU.
7054	</note>
7055	</desc>
7056	</param>
7057	<param name="leaf" type="unsigned long" dir="in">
7058	<desc>
7059	CPUID leaf index (eax).
7060	</desc>
7061	</param>
7062	<param name="subLeaf" type="unsigned long" dir="in">
7063	<desc>
7064	CPUID leaf sub index (ecx). This currently only applies to cache
7065	information on Intel CPUs. Use 0 if retrieving values for
7066	<link to="IMachine::setCPUIDLeaf"/>.
7067	</desc>
7068	</param>
7069	<param name="valEax" type="unsigned long" dir="out">
7070	<desc>
7071	CPUID leaf value for register eax.
7072	</desc>
7073	</param>
7074	<param name="valEbx" type="unsigned long" dir="out">
7075	<desc>
7076	CPUID leaf value for register ebx.
7077	</desc>
7078	</param>
7079	<param name="valEcx" type="unsigned long" dir="out">
7080	<desc>
7081	CPUID leaf value for register ecx.
7082	</desc>
7083	</param>
7084	<param name="valEdx" type="unsigned long" dir="out">
7085	<desc>
7086	CPUID leaf value for register edx.
7087	</desc>
7088	</param>
7089	</method>
7090
7091	<attribute name="memorySize" type="unsigned long" readonly="yes">
7092	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7093	</attribute>
7094
7095	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7096	<desc>Available system memory in the host system.</desc>
7097	</attribute>
7098
7099	<attribute name="operatingSystem" type="wstring" readonly="yes">
7100	<desc>Name of the host system's operating system.</desc>
7101	</attribute>
7102
7103	<attribute name="OSVersion" type="wstring" readonly="yes">
7104	<desc>Host operating system's version string.</desc>
7105	</attribute>
7106
7107	<attribute name="UTCTime" type="long long" readonly="yes">
7108	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7109	</attribute>
7110
7111	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7112	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7113	</attribute>
7114
7115	<method name="createHostOnlyNetworkInterface">
7116	<desc>
7117	Creates a new adapter for Host Only Networking.
7118	<result name="E_INVALIDARG">
7119	Host network interface @a name already exists.
7120	</result>
7121	</desc>
7122	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7123	<desc>
7124	Created host interface object.
7125	</desc>
7126	</param>
7127	<param name="progress" type="IProgress" dir="return">
7128	<desc>
7129	Progress object to track the operation completion.
7130	</desc>
7131	</param>
7132	</method>
7133
7134	<method name="removeHostOnlyNetworkInterface">
7135	<desc>
7136	Removes the given Host Only Networking interface.
7137	<result name="VBOX_E_OBJECT_NOT_FOUND">
7138	No host network interface matching @a id found.
7139	</result>
7140	</desc>
7141	<param name="id" type="uuid" mod="string" dir="in">
7142	<desc>
7143	Adapter GUID.
7144	</desc>
7145	</param>
7146	<param name="progress" type="IProgress" dir="return">
7147	<desc>
7148	Progress object to track the operation completion.
7149	</desc>
7150	</param>
7151	</method>
7152
7153	<method name="createUSBDeviceFilter">
7154	<desc>
7155	Creates a new USB device filter. All attributes except
7156	the filter name are set to empty (any match),
7157	<i>active</i> is @c false (the filter is not active).
7158
7159	The created filter can be added to the list of filters using
7160	<link to="#insertUSBDeviceFilter"/>.
7161
7162	<see>#USBDeviceFilters</see>
7163	</desc>
7164	<param name="name" type="wstring" dir="in">
7165	<desc>
7166	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7167	</desc>
7168	</param>
7169	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7170	<desc>Created filter object.</desc>
7171	</param>
7172	</method>
7173
7174	<method name="insertUSBDeviceFilter">
7175	<desc>
7176	Inserts the given USB device to the specified position
7177	in the list of filters.
7178
7179	Positions are numbered starting from @c 0. If the specified
7180	position is equal to or greater than the number of elements in
7181	the list, the filter is added at the end of the collection.
7182
7183	<note>
7184	Duplicates are not allowed, so an attempt to insert a
7185	filter already in the list is an error.
7186	</note>
7187	<note>
7188	If USB functionality is not available in the given edition of
7189	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7190	</note>
7191
7192	<see>#USBDeviceFilters</see>
7193
7194	<result name="VBOX_E_INVALID_OBJECT_STATE">
7195	USB device filter is not created within this VirtualBox instance.
7196	</result>
7197	<result name="E_INVALIDARG">
7198	USB device filter already in list.
7199	</result>
7200
7201	</desc>
7202	<param name="position" type="unsigned long" dir="in">
7203	<desc>Position to insert the filter to.</desc>
7204	</param>
7205	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7206	<desc>USB device filter to insert.</desc>
7207	</param>
7208	</method>
7209
7210	<method name="removeUSBDeviceFilter">
7211	<desc>
7212	Removes a USB device filter from the specified position in the
7213	list of filters.
7214
7215	Positions are numbered starting from @c 0. Specifying a
7216	position equal to or greater than the number of elements in
7217	the list will produce an error.
7218
7219	<note>
7220	If USB functionality is not available in the given edition of
7221	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7222	</note>
7223
7224	<see>#USBDeviceFilters</see>
7225
7226	<result name="E_INVALIDARG">
7227	USB device filter list empty or invalid @a position.
7228	</result>
7229
7230	</desc>
7231	<param name="position" type="unsigned long" dir="in">
7232	<desc>Position to remove the filter from.</desc>
7233	</param>
7234	</method>
7235
7236	<method name="findHostDVDDrive">
7237	<desc>
7238	Searches for a host DVD drive with the given @c name.
7239
7240	<result name="VBOX_E_OBJECT_NOT_FOUND">
7241	Given @c name does not correspond to any host drive.
7242	</result>
7243
7244	</desc>
7245	<param name="name" type="wstring" dir="in">
7246	<desc>Name of the host drive to search for</desc>
7247	</param>
7248	<param name="drive" type="IMedium" dir="return">
7249	<desc>Found host drive object</desc>
7250	</param>
7251	</method>
7252
7253	<method name="findHostFloppyDrive">
7254	<desc>
7255	Searches for a host floppy drive with the given @c name.
7256
7257	<result name="VBOX_E_OBJECT_NOT_FOUND">
7258	Given @c name does not correspond to any host floppy drive.
7259	</result>
7260
7261	</desc>
7262	<param name="name" type="wstring" dir="in">
7263	<desc>Name of the host floppy drive to search for</desc>
7264	</param>
7265	<param name="drive" type="IMedium" dir="return">
7266	<desc>Found host floppy drive object</desc>
7267	</param>
7268	</method>
7269
7270	<method name="findHostNetworkInterfaceByName">
7271	<desc>
7272	Searches through all host network interfaces for an interface with
7273	the given @c name.
7274	<note>
7275	The method returns an error if the given @c name does not
7276	correspond to any host network interface.
7277	</note>
7278	</desc>
7279	<param name="name" type="wstring" dir="in">
7280	<desc>Name of the host network interface to search for.</desc>
7281	</param>
7282	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7283	<desc>Found host network interface object.</desc>
7284	</param>
7285	</method>
7286	<method name="findHostNetworkInterfaceById">
7287	<desc>
7288	Searches through all host network interfaces for an interface with
7289	the given GUID.
7290	<note>
7291	The method returns an error if the given GUID does not
7292	correspond to any host network interface.
7293	</note>
7294	</desc>
7295	<param name="id" type="uuid" mod="string" dir="in">
7296	<desc>GUID of the host network interface to search for.</desc>
7297	</param>
7298	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7299	<desc>Found host network interface object.</desc>
7300	</param>
7301	</method>
7302	<method name="findHostNetworkInterfacesOfType">
7303	<desc>
7304	Searches through all host network interfaces and returns a list of interfaces of the specified type
7305	</desc>
7306	<param name="type" type="HostNetworkInterfaceType" dir="in">
7307	<desc>type of the host network interfaces to search for.</desc>
7308	</param>
7309	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7310	<desc>Found host network interface objects.</desc>
7311	</param>
7312	</method>
7313
7314	<method name="findUSBDeviceById">
7315	<desc>
7316	Searches for a USB device with the given UUID.
7317
7318	<result name="VBOX_E_OBJECT_NOT_FOUND">
7319	Given @c id does not correspond to any USB device.
7320	</result>
7321
7322	<see>IHostUSBDevice::id</see>
7323	</desc>
7324	<param name="id" type="uuid" mod="string" dir="in">
7325	<desc>UUID of the USB device to search for.</desc>
7326	</param>
7327	<param name="device" type="IHostUSBDevice" dir="return">
7328	<desc>Found USB device object.</desc>
7329	</param>
7330	</method>
7331
7332	<method name="findUSBDeviceByAddress">
7333	<desc>
7334	Searches for a USB device with the given host address.
7335
7336	<result name="VBOX_E_OBJECT_NOT_FOUND">
7337	Given @c name does not correspond to any USB device.
7338	</result>
7339
7340	<see>IHostUSBDevice::address</see>
7341	</desc>
7342	<param name="name" type="wstring" dir="in">
7343	<desc>
7344	Address of the USB device (as assigned by the host) to
7345	search for.
7346	</desc>
7347	</param>
7348	<param name="device" type="IHostUSBDevice" dir="return">
7349	<desc>Found USB device object.</desc>
7350	</param>
7351	</method>
7352
7353	</interface>
7354
7355	<!--
7356	// ISystemProperties
7357	/////////////////////////////////////////////////////////////////////////
7358	-->
7359
7360	<interface
7361	name="ISystemProperties"
7362	extends="$unknown"
7363	uuid="51c81048-b261-4fa2-a44e-fd756f0db589"
7364	wsmap="managed"
7365	>
7366	<desc>
7367	The ISystemProperties interface represents global properties of the given
7368	VirtualBox installation.
7369
7370	These properties define limits and default values for various attributes
7371	and parameters. Most of the properties are read-only, but some can be
7372	changed by a user.
7373	</desc>
7374
7375	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7376	<desc>Minimum guest system memory in Megabytes.</desc>
7377	</attribute>
7378
7379	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7380	<desc>Maximum guest system memory in Megabytes.</desc>
7381	</attribute>
7382
7383	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7384	<desc>Minimum guest video memory in Megabytes.</desc>
7385	</attribute>
7386
7387	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7388	<desc>Maximum guest video memory in Megabytes.</desc>
7389	</attribute>
7390
7391	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7392	<desc>Minimum CPU count.</desc>
7393	</attribute>
7394
7395	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7396	<desc>Maximum CPU count.</desc>
7397	</attribute>
7398
7399	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7400	<desc>Maximum of monitors which could be connected.</desc>
7401	</attribute>
7402
7403	<attribute name="infoVDSize" type="long long" readonly="yes">
7404	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7405	does not reflect the limits of any virtual disk image format.</desc>
7406	</attribute>
7407
7408	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7409	<desc>
7410	Number of network adapters associated with every
7411	<link to="IMachine"/> instance.
7412	</desc>
7413	</attribute>
7414
7415	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7416	<desc>
7417	Number of serial ports associated with every
7418	<link to="IMachine"/> instance.
7419	</desc>
7420	</attribute>
7421
7422	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7423	<desc>
7424	Number of parallel ports associated with every
7425	<link to="IMachine"/> instance.
7426	</desc>
7427	</attribute>
7428
7429	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7430	<desc>
7431	Maximum device position in the boot order. This value corresponds
7432	to the total number of devices a machine can boot from, to make it
7433	possible to include all possible devices to the boot list.
7434	<see><link to="IMachine::setBootOrder"/></see>
7435	</desc>
7436	</attribute>
7437
7438	<attribute name="defaultMachineFolder" type="wstring">
7439	<desc>
7440	Full path to the default directory used to create new or open
7441	existing machines when a machine settings file name contains no
7442	path.
7443
7444	Starting with VirtualBox 4.0, by default, this attribute contains
7445	the full path of folder named "VirtualBox VMs" in the user's
7446	home directory, which depends on the host platform.
7447
7448	When setting this attribute, a full path must be specified.
7449	Setting this property to @c null or an empty string or the
7450	special value "Machines" (for compatibility reasons) will restore
7451	that default value.
7452
7453	If the folder specified herein does not exist, it will be created
7454	automatically as needed.
7455
7456	<see>
7457	<link to="IVirtualBox::createMachine"/>,
7458	<link to="IVirtualBox::openMachine"/>
7459	</see>
7460	</desc>
7461	</attribute>
7462
7463	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7464	<desc>
7465	List of all medium storage formats supported by this VirtualBox
7466	installation.
7467
7468	Keep in mind that the medium format identifier
7469	(<link to="IMediumFormat::id"/>) used in other API calls like
7470	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7471	medium format is a case-insensitive string. This means that, for
7472	example, all of the following strings:
7473	<pre>
7474	"VDI"
7475	"vdi"
7476	"VdI"</pre>
7477	refer to the same medium format.
7478
7479	Note that the virtual medium framework is backend-based, therefore
7480	the list of supported formats depends on what backends are currently
7481	installed.
7482
7483	<see>
7484	<link to="IMediumFormat"/>,
7485	</see>
7486	</desc>
7487	</attribute>
7488
7489	<attribute name="defaultHardDiskFormat" type="wstring">
7490	<desc>
7491	Identifier of the default medium format used by VirtualBox.
7492
7493	The medium format set by this attribute is used by VirtualBox
7494	when the medium format was not specified explicitly. One example is
7495	<link to="IVirtualBox::createHardDisk"/> with the empty
7496	format argument. A more complex example is implicit creation of
7497	differencing media when taking a snapshot of a virtual machine:
7498	this operation will try to use a format of the parent medium first
7499	and if this format does not support differencing media the default
7500	format specified by this argument will be used.
7501
7502	The list of supported medium formats may be obtained by the
7503	<link to="#mediumFormats"/> call. Note that the default medium
7504	format must have a capability to create differencing media;
7505	otherwise operations that create media implicitly may fail
7506	unexpectedly.
7507
7508	The initial value of this property is <tt>"VDI"</tt> in the current
7509	version of the VirtualBox product, but may change in the future.
7510
7511	<note>
7512	Setting this property to @c null or empty string will restore the
7513	initial value.
7514	</note>
7515
7516	<see>
7517	<link to="#mediumFormats"/>,
7518	<link to="IMediumFormat::id"/>,
7519	<link to="IVirtualBox::createHardDisk"/>
7520	</see>
7521	</desc>
7522	</attribute>
7523
7524	<attribute name="freeDiskSpaceWarning" type="long long">
7525	<desc>Issue a warning if the free disk space is below (or in some disk
7526	intensive operation is expected to go below) the given size in
7527	bytes.</desc>
7528	</attribute>
7529
7530	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7531	<desc>Issue a warning if the free disk space is below (or in some disk
7532	intensive operation is expected to go below) the given percentage.</desc>
7533	</attribute>
7534
7535	<attribute name="freeDiskSpaceError" type="long long">
7536	<desc>Issue an error if the free disk space is below (or in some disk
7537	intensive operation is expected to go below) the given size in
7538	bytes.</desc>
7539	</attribute>
7540
7541	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7542	<desc>Issue an error if the free disk space is below (or in some disk
7543	intensive operation is expected to go below) the given percentage.</desc>
7544	</attribute>
7545
7546	<attribute name="VRDEAuthLibrary" type="wstring">
7547	<desc>
7548	Library that provides authentication for Remote Desktop clients. The library
7549	is used if a virtual machine's authentication type is set to "external"
7550	in the VM RemoteDisplay configuration.
7551
7552	The system library extension (".DLL" or ".so") must be omitted.
7553	A full path can be specified; if not, then the library must reside on the
7554	system's default library path.
7555
7556	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7557	of that name in one of the default VirtualBox library directories.
7558
7559	For details about VirtualBox authentication libraries and how to implement
7560	them, please refer to the VirtualBox manual.
7561
7562	<note>
7563	Setting this property to @c null or empty string will restore the
7564	initial value.
7565	</note>
7566	</desc>
7567	</attribute>
7568
7569	<attribute name="webServiceAuthLibrary" type="wstring">
7570	<desc>
7571	Library that provides authentication for webservice clients. The library
7572	is used if a virtual machine's authentication type is set to "external"
7573	in the VM RemoteDisplay configuration and will be called from
7574	within the <link to="IWebsessionManager::logon" /> implementation.
7575
7576	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7577	there is no per-VM setting for this, as the webservice is a global
7578	resource (if it is running). Only for this setting (for the webservice),
7579	setting this value to a literal <tt>"null"</tt> string disables authentication,
7580	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7581	no matter what user name and password are supplied.
7582
7583	The initial value of this property is <tt>"VBoxAuth"</tt>,
7584	meaning that the webservice will use the same authentication
7585	library that is used by default for VRDE (again, see
7586	<link to="ISystemProperties::VRDEAuthLibrary" />).
7587	The format and calling convention of authentication libraries
7588	is the same for the webservice as it is for VRDE.
7589
7590	<note>
7591	Setting this property to @c null or empty string will restore the
7592	initial value.
7593	</note>
7594	</desc>
7595	</attribute>
7596
7597	<attribute name="defaultVRDEExtPack" type="wstring">
7598	<desc>
7599	The name of the extension pack providing the default VRDE.
7600
7601	This attribute is for choosing between multiple extension packs
7602	providing VRDE. If only one is installed, it will automatically be the
7603	default one. The attribute value can be empty if no VRDE extension
7604	pack is installed.
7605
7606	For details about VirtualBox Remote Desktop Extension and how to
7607	implement one, please refer to the VirtualBox SDK.
7608	</desc>
7609	</attribute>
7610
7611	<attribute name="LogHistoryCount" type="unsigned long">
7612	<desc>
7613	This value specifies how many old release log files are kept.
7614	</desc>
7615	</attribute>
7616
7617	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7618	<desc>This value hold the default audio driver for the current
7619	system.</desc>
7620	</attribute>
7621
7622	<method name="getMaxDevicesPerPortForStorageBus">
7623	<desc>Returns the maximum number of devices which can be attached to a port
7624	for the given storage bus.</desc>
7625
7626	<param name="bus" type="StorageBus" dir="in">
7627	<desc>The storage bus type to get the value for.</desc>
7628	</param>
7629
7630	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7631	<desc>The maximum number of devices which can eb attached to the port for the given
7632	storage bus.</desc>
7633	</param>
7634	</method>
7635
7636	<method name="getMinPortCountForStorageBus">
7637	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7638
7639	<param name="bus" type="StorageBus" dir="in">
7640	<desc>The storage bus type to get the value for.</desc>
7641	</param>
7642
7643	<param name="minPortCount" type="unsigned long" dir="return">
7644	<desc>The minimum number of ports for the given storage bus.</desc>
7645	</param>
7646	</method>
7647
7648	<method name="getMaxPortCountForStorageBus">
7649	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7650
7651	<param name="bus" type="StorageBus" dir="in">
7652	<desc>The storage bus type to get the value for.</desc>
7653	</param>
7654
7655	<param name="maxPortCount" type="unsigned long" dir="return">
7656	<desc>The maximum number of ports for the given storage bus.</desc>
7657	</param>
7658	</method>
7659
7660	<method name="getMaxInstancesOfStorageBus">
7661	<desc>Returns the maximum number of storage bus instances which
7662	can be configured for each VM. This corresponds to the number of
7663	storage controllers one can have. Value may depend on chipset type
7664	used.</desc>
7665
7666	<param name="chipset" type="ChipsetType" dir="in">
7667	<desc>The chipset type to get the value for.</desc>
7668	</param>
7669
7670	<param name="bus" type="StorageBus" dir="in">
7671	<desc>The storage bus type to get the value for.</desc>
7672	</param>
7673
7674	<param name="maxInstances" type="unsigned long" dir="return">
7675	<desc>The maximum number of instances for the given storage bus.</desc>
7676	</param>
7677	</method>
7678
7679	<method name="getDeviceTypesForStorageBus">
7680	<desc>Returns list of all the supported device types
7681	(<link to="DeviceType"/>) for the given type of storage
7682	bus.</desc>
7683
7684	<param name="bus" type="StorageBus" dir="in">
7685	<desc>The storage bus type to get the value for.</desc>
7686	</param>
7687
7688	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7689	<desc>The list of all supported device types for the given storage bus.</desc>
7690	</param>
7691	</method>
7692
7693	<method name="getDefaultIoCacheSettingForStorageController">
7694	<desc>Returns the default I/O cache setting for the
7695	given storage controller</desc>
7696
7697	<param name="controllerType" type="StorageControllerType" dir="in">
7698	<desc>The storage controller to the setting for.</desc>
7699	</param>
7700
7701	<param name="enabled" type="boolean" dir="return">
7702	<desc>Returned flag indicating the default value</desc>
7703	</param>
7704	</method>
7705	</interface>
7706
7707	<!--
7708	// IGuest
7709	/////////////////////////////////////////////////////////////////////////
7710	-->
7711
7712	<interface
7713	name="IGuestOSType" extends="$unknown"
7714	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7715	wsmap="struct"
7716	>
7717	<desc>
7718	</desc>
7719
7720	<attribute name="familyId" type="wstring" readonly="yes">
7721	<desc>Guest OS family identifier string.</desc>
7722	</attribute>
7723
7724	<attribute name="familyDescription" type="wstring" readonly="yes">
7725	<desc>Human readable description of the guest OS family.</desc>
7726	</attribute>
7727
7728	<attribute name="id" type="wstring" readonly="yes">
7729	<desc>Guest OS identifier string.</desc>
7730	</attribute>
7731
7732	<attribute name="description" type="wstring" readonly="yes">
7733	<desc>Human readable description of the guest OS.</desc>
7734	</attribute>
7735
7736	<attribute name="is64Bit" type="boolean" readonly="yes">
7737	<desc>Returns @c true if the given OS is 64-bit</desc>
7738	</attribute>
7739
7740	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7741	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7742	</attribute>
7743
7744	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7745	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7746	</attribute>
7747
7748	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7749	<desc>Recommended RAM size in Megabytes.</desc>
7750	</attribute>
7751
7752	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7753	<desc>Recommended video RAM size in Megabytes.</desc>
7754	</attribute>
7755
7756	<attribute name="recommendedHDD" type="long long" readonly="yes">
7757	<desc>Recommended hard disk size in bytes.</desc>
7758	</attribute>
7759
7760	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7761	<desc>Returns recommended network adapter for this OS type.</desc>
7762	</attribute>
7763
7764	<attribute name="recommendedPae" type="boolean" readonly="yes">
7765	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7766	</attribute>
7767
7768	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7769	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7770	</attribute>
7771
7772	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7773	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7774	</attribute>
7775
7776	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7777	<desc>Recommended storage controller type for HD drives.</desc>
7778	</attribute>
7779
7780	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7781	<desc>Recommended storage bus type for HD drives.</desc>
7782	</attribute>
7783
7784	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7785	<desc>Recommended firmware type.</desc>
7786	</attribute>
7787
7788	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7789	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7790	</attribute>
7791
7792	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7793	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7794	</attribute>
7795
7796	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7797	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7798	</attribute>
7799
7800	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7801	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7802	</attribute>
7803
7804	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7805	<desc>Recommended chipset type.</desc>
7806	</attribute>
7807
7808	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7809	<desc>Recommended audio type.</desc>
7810	</attribute>
7811
7812	</interface>
7813
7814	<enum
7815	name="AdditionsRunLevelType"
7816	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7817	>
7818	<desc>
7819	Guest Additions run level type.
7820	</desc>
7821
7822	<const name="None" value="0">
7823	<desc>Guest Additions are not loaded.</desc>
7824	</const>
7825	<const name="System" value="1">
7826	<desc>Guest drivers are loaded.</desc>
7827	</const>
7828	<const name="Userland" value="2">
7829	<desc>Common components (such as application services) are loaded.</desc>
7830	</const>
7831	<const name="Desktop" value="3">
7832	<desc>Per-user desktop components are loaded.</desc>
7833	</const>
7834	</enum>
7835
7836	<enum
7837	name="AdditionsUpdateFlag"
7838	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
7839	>
7840	<desc>
7841	Guest Additions update flags.
7842	</desc>
7843
7844	<const name="None" value="0">
7845	<desc>No flag set.</desc>
7846	</const>
7847	<const name="WaitForUpdateStartOnly" value="1">
7848	<desc>Only wait for the update process being started and do not
7849	wait while peforming the actual update.</desc>
7850	</const>
7851	</enum>
7852
7853	<enum
7854	name="ExecuteProcessFlag"
7855	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7856	>
7857	<desc>
7858	Guest process execution flags.
7859	</desc>
7860
7861	<const name="None" value="0">
7862	<desc>No flag set.</desc>
7863	</const>
7864
7865	<const name="WaitForProcessStartOnly" value="1">
7866	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7867	process itself then uses an infinite timeout.</desc>
7868	</const>
7869
7870	<const name="IgnoreOrphanedProcesses" value="2">
7871	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7872	</const>
7873
7874	<const name="Hidden" value="4">
7875	<desc>Don't show the started process according to the guest OS guidelines.</desc>
7876	</const>
7877	</enum>
7878
7879	<enum
7880	name="ProcessInputFlag"
7881	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7882	>
7883	<desc>
7884	Guest process input flags.
7885	</desc>
7886
7887	<const name="None" value="0">
7888	<desc>No flag set.</desc>
7889	</const>
7890	<const name="EndOfFile" value="1">
7891	<desc>End of file (input) reached.</desc>
7892	</const>
7893	</enum>
7894
7895	<enum
7896	name="CopyFileFlag"
7897	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7898	>
7899	<desc>
7900	Host/Guest copy flags.
7901	</desc>
7902
7903	<const name="None" value="0">
7904	<desc>No flag set.</desc>
7905	</const>
7906
7907	<const name="Recursive" value="1">
7908	<desc>Copy directories recursively.</desc>
7909	</const>
7910
7911	<const name="Update" value="2">
7912	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7913	</const>
7914
7915	<const name="FollowLinks" value="4">
7916	<desc>Follow symbolic links.</desc>
7917	</const>
7918	</enum>
7919
7920	<enum
7921	name="CreateDirectoryFlag"
7922	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7923	>
7924	<desc>
7925	Directory creation flags.
7926	</desc>
7927
7928	<const name="None" value="0">
7929	<desc>No flag set.</desc>
7930	</const>
7931
7932	<const name="Parents" value="1">
7933	<desc>No error if existing, make parent directories as needed.</desc>
7934	</const>
7935	</enum>
7936
7937	<interface
7938	name="IGuest" extends="$unknown"
7939	uuid="1039b0cc-9bc1-4c6d-8d12-864aa48aa5b9"
7940	wsmap="managed"
7941	>
7942	<desc>
7943	The IGuest interface represents information about the operating system
7944	running inside the virtual machine. Used in
7945	<link to="IConsole::guest"/>.
7946
7947	IGuest provides information about the guest operating system, whether
7948	Guest Additions are installed and other OS-specific virtual machine
7949	properties.
7950	</desc>
7951
7952	<attribute name="OSTypeId" type="wstring" readonly="yes">
7953	<desc>
7954	Identifier of the Guest OS type as reported by the Guest
7955	Additions.
7956	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7957	an IGuestOSType object representing details about the given
7958	Guest OS type.
7959	<note>
7960	If Guest Additions are not installed, this value will be
7961	the same as <link to="IMachine::OSTypeId"/>.
7962	</note>
7963	</desc>
7964	</attribute>
7965
7966	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7967	<desc>
7968	Current run level of the Guest Additions.
7969	</desc>
7970	</attribute>
7971
7972	<attribute name="additionsVersion" type="wstring" readonly="yes">
7973	<desc>
7974	Version of the Guest Additions including the revision (3 decimal numbers
7975	separated by dots + revision number) installed on the guest or empty
7976	when the Additions are not installed.
7977	</desc>
7978	</attribute>
7979
7980	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7981	<desc>
7982	Flag whether seamless guest display rendering (seamless desktop
7983	integration) is supported.
7984	</desc>
7985	</attribute>
7986
7987	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7988	<desc>
7989	Flag whether the guest is in graphics mode. If it is not, then
7990	seamless rendering will not work, resize hints are not immediately
7991	acted on and guest display resizes are probably not initiated by
7992	the guest additions.
7993	</desc>
7994	</attribute>
7995
7996	<attribute name="memoryBalloonSize" type="unsigned long">
7997	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7998	</attribute>
7999
8000	<attribute name="statisticsUpdateInterval" type="unsigned long">
8001	<desc>Interval to update guest statistics in seconds.</desc>
8002	</attribute>
8003
8004	<method name="internalGetStatistics">
8005	<desc>
8006	Internal method; do not use as it might change at any time
8007	</desc>
8008	<param name="cpuUser" type="unsigned long" dir="out">
8009	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
8010	</param>
8011	<param name="cpuKernel" type="unsigned long" dir="out">
8012	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
8013	</param>
8014	<param name="cpuIdle" type="unsigned long" dir="out">
8015	<desc>Percentage of processor time spent idling as seen by the guest</desc>
8016	</param>
8017	<param name="memTotal" type="unsigned long" dir="out">
8018	<desc>Total amount of physical guest RAM</desc>
8019	</param>
8020	<param name="memFree" type="unsigned long" dir="out">
8021	<desc>Free amount of physical guest RAM</desc>
8022	</param>
8023	<param name="memBalloon" type="unsigned long" dir="out">
8024	<desc>Amount of ballooned physical guest RAM</desc>
8025	</param>
8026	<param name="memShared" type="unsigned long" dir="out">
8027	<desc>Amount of shared physical guest RAM</desc>
8028	</param>
8029	<param name="memCache" type="unsigned long" dir="out">
8030	<desc>Total amount of guest (disk) cache memory</desc>
8031	</param>
8032	<param name="pagedTotal" type="unsigned long" dir="out">
8033	<desc>Total amount of space in the page file</desc>
8034	</param>
8035	<param name="memAllocTotal" type="unsigned long" dir="out">
8036	<desc>Total amount of memory allocated by the hypervisor</desc>
8037	</param>
8038	<param name="memFreeTotal" type="unsigned long" dir="out">
8039	<desc>Total amount of free memory available in the hypervisor</desc>
8040	</param>
8041	<param name="memBalloonTotal" type="unsigned long" dir="out">
8042	<desc>Total amount of memory ballooned by the hypervisor</desc>
8043	</param>
8044	<param name="memSharedTotal" type="unsigned long" dir="out">
8045	<desc>Total amount of shared memory in the hypervisor</desc>
8046	</param>
8047	</method>
8048
8049	<method name="getAdditionsStatus">
8050	<desc>
8051	Retrieve the current status of a certain Guest Additions run level.
8052
8053	<result name="VBOX_E_NOT_SUPPORTED">
8054	Wrong status level specified.
8055	</result>
8056
8057	</desc>
8058	<param name="level" type="AdditionsRunLevelType" dir="in">
8059	<desc>Status level to check</desc>
8060	</param>
8061	<param name="active" type="boolean" dir="return">
8062	<desc>Flag whether the status level has been reached or not</desc>
8063	</param>
8064	</method>
8065
8066	<method name="setCredentials">
8067	<desc>
8068	Store login credentials that can be queried by guest operating
8069	systems with Additions installed. The credentials are transient
8070	to the session and the guest may also choose to erase them. Note
8071	that the caller cannot determine whether the guest operating system
8072	has queried or made use of the credentials.
8073
8074	<result name="VBOX_E_VM_ERROR">
8075	VMM device is not available.
8076	</result>
8077
8078	</desc>
8079	<param name="userName" type="wstring" dir="in">
8080	<desc>User name string, can be empty</desc>
8081	</param>
8082	<param name="password" type="wstring" dir="in">
8083	<desc>Password string, can be empty</desc>
8084	</param>
8085	<param name="domain" type="wstring" dir="in">
8086	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8087	</param>
8088	<param name="allowInteractiveLogon" type="boolean" dir="in">
8089	<desc>
8090	Flag whether the guest should alternatively allow the user to
8091	interactively specify different credentials. This flag might
8092	not be supported by all versions of the Additions.
8093	</desc>
8094	</param>
8095	</method>
8096
8097	<method name="executeProcess">
8098	<desc>
8099	Executes an existing program inside the guest VM.
8100
8101	<result name="VBOX_E_IPRT_ERROR">
8102	Could not execute process.
8103	</result>
8104
8105	</desc>
8106	<param name="execName" type="wstring" dir="in">
8107	<desc>
8108	Full path name of the command to execute on the guest; the
8109	commands has to exists in the guest VM in order to be executed.
8110	</desc>
8111	</param>
8112	<param name="flags" type="unsigned long" dir="in">
8113	<desc>
8114	Execution flags - currently not supported and therefore
8115	has to be set to 0.
8116	</desc>
8117	</param>
8118	<param name="arguments" type="wstring" safearray="yes" dir="in">
8119	<desc>
8120	Array of arguments passed to the execution command.
8121	</desc>
8122	</param>
8123	<param name="environment" type="wstring" safearray="yes" dir="in">
8124	<desc>
8125	Environment variables that can be set while the command is being
8126	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8127	variable just set its name ("NAME") without a value.
8128	</desc>
8129	</param>
8130	<param name="userName" type="wstring" dir="in">
8131	<desc>
8132	User name under which the command will be executed; has to exist
8133	and have the appropriate rights to execute programs in the VM.
8134	</desc>
8135	</param>
8136	<param name="password" type="wstring" dir="in">
8137	<desc>
8138	Password of the user account specified.
8139	</desc>
8140	</param>
8141	<param name="timeoutMS" type="unsigned long" dir="in">
8142	<desc>
8143	The maximum timeout value (in msec) to wait for finished program
8144	execution. Pass 0 for an infinite timeout.
8145	</desc>
8146	</param>
8147	<param name="pid" type="unsigned long" dir="out">
8148	<desc>
8149	The PID (process ID) of the started command for later reference.
8150	</desc>
8151	</param>
8152	<param name="progress" type="IProgress" dir="return">
8153	<desc>Progress object to track the operation completion.</desc>
8154	</param>
8155	</method>
8156
8157	<method name="getProcessOutput">
8158	<desc>
8159	Retrieves output of a formerly started process.
8160
8161	<result name="VBOX_E_IPRT_ERROR">
8162	Could not retrieve output.
8163	</result>
8164
8165	</desc>
8166	<param name="pid" type="unsigned long" dir="in">
8167	<desc>
8168	Process id returned by earlier executeProcess() call.
8169	</desc>
8170	</param>
8171	<param name="flags" type="unsigned long" dir="in">
8172	<desc>
8173	Flags describing which output to retrieve.
8174	</desc>
8175	</param>
8176	<param name="timeoutMS" type="unsigned long" dir="in">
8177	<desc>
8178	The maximum timeout value (in msec) to wait for output
8179	data. Pass 0 for an infinite timeout.
8180	</desc>
8181	</param>
8182	<param name="size" type="long long" dir="in">
8183	<desc>
8184	Size in bytes to read in the buffer.
8185	</desc>
8186	</param>
8187	<param name="data" type="octet" dir="return" safearray="yes">
8188	<desc>
8189	Buffer for retrieving the actual output. A data size of 0 means end of file
8190	if the requested size was not 0. This is the unprocessed
8191	output data, i.e. the line ending style depends on the platform of
8192	the system the server is running on.
8193	</desc>
8194	</param>
8195	</method>
8196
8197	<method name="getProcessStatus">
8198	<desc>
8199	Retrieves status, exit code and the exit reason of a formerly started process.
8200
8201	<result name="VBOX_E_IPRT_ERROR">
8202	Process with specified PID was not found.
8203	</result>
8204
8205	</desc>
8206	<param name="pid" type="unsigned long" dir="in">
8207	<desc>
8208	Process id returned by earlier executeProcess() call.
8209	</desc>
8210	</param>
8211	<param name="exitcode" type="unsigned long" dir="out">
8212	<desc>
8213	The exit code (if available).
8214	</desc>
8215	</param>
8216	<param name="flags" type="unsigned long" dir="out">
8217	<desc>
8218	Additional flags of process status. Not used at the moment and
8219	must be set to 0.
8220	</desc>
8221	</param>
8222	<param name="reason" type="unsigned long" dir="return">
8223	<desc>
8224	The current process status.
8225	</desc>
8226	</param>
8227	</method>
8228
8229	<method name="copyToGuest">
8230	<desc>
8231	Copies files/directories from host to the guest.
8232
8233	<result name="VBOX_E_IPRT_ERROR">
8234	Error while copying.
8235	</result>
8236
8237	</desc>
8238	<param name="source" type="wstring" dir="in">
8239	<desc>
8240	Source file on the host to copy.
8241	</desc>
8242	</param>
8243	<param name="dest" type="wstring" dir="in">
8244	<desc>
8245	Destination path on the guest.
8246	</desc>
8247	</param>
8248	<param name="userName" type="wstring" dir="in">
8249	<desc>
8250	User name under which the copy command will be executed; the
8251	user has to exist and have the appropriate rights to write to
8252	the destination path.
8253	</desc>
8254	</param>
8255	<param name="password" type="wstring" dir="in">
8256	<desc>
8257	Password of the user account specified.
8258	</desc>
8259	</param>
8260	<param name="flags" type="unsigned long" dir="in">
8261	<desc>
8262	Copy flags. Not used at the moment and must be set to 0.
8263	</desc>
8264	</param>
8265	<param name="progress" type="IProgress" dir="return">
8266	<desc>Progress object to track the operation completion.</desc>
8267	</param>
8268	</method>
8269
8270	<method name="createDirectory">
8271	<desc>
8272	Creates a directory on the guest.
8273
8274	<result name="VBOX_E_IPRT_ERROR">
8275	Error while creating directory.
8276	</result>
8277
8278	</desc>
8279	<param name="directory" type="wstring" dir="in">
8280	<desc>
8281	Directory to create.
8282	</desc>
8283	</param>
8284	<param name="userName" type="wstring" dir="in">
8285	<desc>
8286	User name under which the directory creation will be executed; the
8287	user has to exist and have the appropriate rights to create the
8288	desired directory.
8289	</desc>
8290	</param>
8291	<param name="password" type="wstring" dir="in">
8292	<desc>
8293	Password of the user account specified.
8294	</desc>
8295	</param>
8296	<param name="mode" type="unsigned long" dir="in">
8297	<desc>
8298	File mode.
8299	</desc>
8300	</param>
8301	<param name="flags" type="unsigned long" dir="in">
8302	<desc>
8303	Additional flags. Not used at the moment and must be set to 0.
8304	</desc>
8305	</param>
8306	<param name="progress" type="IProgress" dir="return">
8307	<desc>Progress object to track the operation completion.</desc>
8308	</param>
8309	</method>
8310
8311	<method name="setProcessInput">
8312	<desc>
8313	Sends input into a formerly started process.
8314
8315	<result name="VBOX_E_IPRT_ERROR">
8316	Could not send input.
8317	</result>
8318
8319	</desc>
8320	<param name="pid" type="unsigned long" dir="in">
8321	<desc>
8322	Process id returned by earlier executeProcess() call.
8323	</desc>
8324	</param>
8325	<param name="flags" type="unsigned long" dir="in">
8326	<desc>
8327	Not used, must be set to zero.
8328	</desc>
8329	</param>
8330	<param name="data" type="octet" dir="in" safearray="yes">
8331	<desc>
8332	Buffer of input data to send to the started process to.
8333	</desc>
8334	</param>
8335	<param name="written" type="unsigned long" dir="return">
8336	<desc>
8337	Number of bytes written.
8338	</desc>
8339	</param>
8340	</method>
8341
8342	<method name="updateGuestAdditions">
8343	<desc>
8344	Updates already installed Guest Additions in a VM
8345	(Windows guests only).
8346
8347	<result name="VBOX_E_IPRT_ERROR">
8348	Error while updating.
8349	</result>
8350
8351	</desc>
8352	<param name="source" type="wstring" dir="in">
8353	<desc>
8354	Path to the Guest Additions .ISO file to use for the upate.
8355	</desc>
8356	</param>
8357	<param name="flags" type="unsigned long" dir="in">
8358	<desc>
8359	Flags for Guest Additions update.
8360	</desc>
8361	</param>
8362	<param name="progress" type="IProgress" dir="return">
8363	<desc>Progress object to track the operation completion.</desc>
8364	</param>
8365	</method>
8366
8367	</interface>
8368
8369
8370	<!--
8371	// IProgress
8372	/////////////////////////////////////////////////////////////////////////
8373	-->
8374
8375	<interface
8376	name="IProgress" extends="$unknown"
8377	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8378	wsmap="managed"
8379	>
8380	<desc>
8381	The IProgress interface is used to track and control
8382	asynchronous tasks within VirtualBox.
8383
8384	An instance of this is returned every time VirtualBox starts
8385	an asynchronous task (in other words, a separate thread) which
8386	continues to run after a method call returns. For example,
8387	<link to="IConsole::saveState" />, which saves the state of
8388	a running virtual machine, can take a long time to complete.
8389	To be able to display a progress bar, a user interface such as
8390	the VirtualBox graphical user interface can use the IProgress
8391	object returned by that method.
8392
8393	Note that IProgress is a "read-only" interface in the sense
8394	that only the VirtualBox internals behind the Main API can
8395	create and manipulate progress objects, whereas client code
8396	can only use the IProgress object to monitor a task's
8397	progress and, if <link to="#cancelable" /> is @c true,
8398	cancel the task by calling <link to="#cancel" />.
8399
8400	A task represented by IProgress consists of either one or
8401	several sub-operations that run sequentially, one by one (see
8402	<link to="#operation" /> and <link to="#operationCount" />).
8403	Every operation is identified by a number (starting from 0)
8404	and has a separate description.
8405
8406	You can find the individual percentage of completion of the current
8407	operation in <link to="#operationPercent" /> and the
8408	percentage of completion of the task as a whole
8409	in <link to="#percent" />.
8410
8411	Similarly, you can wait for the completion of a particular
8412	operation via <link to="#waitForOperationCompletion" /> or
8413	for the completion of the whole task via
8414	<link to="#waitForCompletion" />.
8415	</desc>
8416
8417	<attribute name="id" type="uuid" mod="string" readonly="yes">
8418	<desc>ID of the task.</desc>
8419	</attribute>
8420
8421	<attribute name="description" type="wstring" readonly="yes">
8422	<desc>Description of the task.</desc>
8423	</attribute>
8424
8425	<attribute name="initiator" type="$unknown" readonly="yes">
8426	<desc>Initiator of the task.</desc>
8427	</attribute>
8428
8429	<attribute name="cancelable" type="boolean" readonly="yes">
8430	<desc>Whether the task can be interrupted.</desc>
8431	</attribute>
8432
8433	<attribute name="percent" type="unsigned long" readonly="yes">
8434	<desc>
8435	Current progress value of the task as a whole, in percent.
8436	This value depends on how many operations are already complete.
8437	Returns 100 if <link to="#completed" /> is @c true.
8438	</desc>
8439	</attribute>
8440
8441	<attribute name="timeRemaining" type="long" readonly="yes">
8442	<desc>
8443	Estimated remaining time until the task completes, in
8444	seconds. Returns 0 once the task has completed; returns -1
8445	if the remaining time cannot be computed, in particular if
8446	the current progress is 0.
8447
8448	Even if a value is returned, the estimate will be unreliable
8449	for low progress values. It will become more reliable as the
8450	task progresses; it is not recommended to display an ETA
8451	before at least 20% of a task have completed.
8452	</desc>
8453	</attribute>
8454
8455	<attribute name="completed" type="boolean" readonly="yes">
8456	<desc>Whether the task has been completed.</desc>
8457	</attribute>
8458
8459	<attribute name="canceled" type="boolean" readonly="yes">
8460	<desc>Whether the task has been canceled.</desc>
8461	</attribute>
8462
8463	<attribute name="resultCode" type="long" readonly="yes">
8464	<desc>
8465	Result code of the progress task.
8466	Valid only if <link to="#completed"/> is @c true.
8467	</desc>
8468	</attribute>
8469
8470	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8471	<desc>
8472	Extended information about the unsuccessful result of the
8473	progress operation. May be @c null if no extended information
8474	is available.
8475	Valid only if <link to="#completed"/> is @c true and
8476	<link to="#resultCode"/> indicates a failure.
8477	</desc>
8478	</attribute>
8479
8480	<attribute name="operationCount" type="unsigned long" readonly="yes">
8481	<desc>
8482	Number of sub-operations this task is divided into.
8483	Every task consists of at least one suboperation.
8484	</desc>
8485	</attribute>
8486
8487	<attribute name="operation" type="unsigned long" readonly="yes">
8488	<desc>Number of the sub-operation being currently executed.</desc>
8489	</attribute>
8490
8491	<attribute name="operationDescription" type="wstring" readonly="yes">
8492	<desc>
8493	Description of the sub-operation being currently executed.
8494	</desc>
8495	</attribute>
8496
8497	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8498	<desc>Progress value of the current sub-operation only, in percent.</desc>
8499	</attribute>
8500
8501	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8502	<desc>Weight value of the current sub-operation only.</desc>
8503	</attribute>
8504
8505	<attribute name="timeout" type="unsigned long">
8506	<desc>
8507	When non-zero, this specifies the number of milliseconds after which
8508	the operation will automatically be canceled. This can only be set on
8509	cancelable objects.
8510	</desc>
8511	</attribute>
8512
8513	<method name="setCurrentOperationProgress">
8514	<desc>Internal method, not to be called externally.</desc>
8515	<param name="percent" type="unsigned long" dir="in" />
8516	</method>
8517	<method name="setNextOperation">
8518	<desc>Internal method, not to be called externally.</desc>
8519	<param name="nextOperationDescription" type="wstring" dir="in" />
8520	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8521	</method>
8522
8523	<method name="waitForCompletion">
8524	<desc>
8525	Waits until the task is done (including all sub-operations)
8526	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8527
8528	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8529	thread are not processed while waiting. Neglecting event queues may
8530	have dire consequences (degrade performance, resource hogs,
8531	deadlocks, etc.), this is specially so for the main thread on
8532	platforms using XPCOM. Callers are adviced wait for short periods
8533	and service their event queues between calls, or to create a worker
8534	thread to do the waiting.
8535
8536	<result name="VBOX_E_IPRT_ERROR">
8537	Failed to wait for task completion.
8538	</result>
8539	</desc>
8540
8541	<param name="timeout" type="long" dir="in">
8542	<desc>
8543	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8544	</desc>
8545	</param>
8546	</method>
8547
8548	<method name="waitForOperationCompletion">
8549	<desc>
8550	Waits until the given operation is done with a given timeout in
8551	milliseconds; specify -1 for an indefinite wait.
8552
8553	See <link to="#waitForCompletion"> for event queue considerations.</link>
8554
8555	<result name="VBOX_E_IPRT_ERROR">
8556	Failed to wait for operation completion.
8557	</result>
8558
8559	</desc>
8560	<param name="operation" type="unsigned long" dir="in">
8561	<desc>
8562	Number of the operation to wait for.
8563	Must be less than <link to="#operationCount"/>.
8564	</desc>
8565	</param>
8566	<param name="timeout" type="long" dir="in">
8567	<desc>
8568	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8569	</desc>
8570	</param>
8571	</method>
8572
8573	<method name="cancel">
8574	<desc>
8575	Cancels the task.
8576	<note>
8577	If <link to="#cancelable"/> is @c false, then this method will fail.
8578	</note>
8579
8580	<result name="VBOX_E_INVALID_OBJECT_STATE">
8581	Operation cannot be canceled.
8582	</result>
8583
8584	</desc>
8585	</method>
8586
8587	</interface>
8588
8589	<!--
8590	// ISnapshot
8591	/////////////////////////////////////////////////////////////////////////
8592	-->
8593
8594	<interface
8595	name="ISnapshot" extends="$unknown"
8596	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8597	wsmap="managed"
8598	>
8599	<desc>
8600	The ISnapshot interface represents a snapshot of the virtual
8601	machine.
8602
8603	Together with the differencing media that are created
8604	when a snapshot is taken, a machine can be brought back to
8605	the exact state it was in when the snapshot was taken.
8606
8607	The ISnapshot interface has no methods, only attributes; snapshots
8608	are controlled through methods of the <link to="IConsole" /> interface
8609	which also manage the media associated with the snapshot.
8610	The following operations exist:
8611
8612	<ul>
8613	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8614	by creating new, empty differencing images for the machine's
8615	media and saving the VM settings and (if the VM is running)
8616	the current VM state in the snapshot.
8617
8618	The differencing images will then receive all data written to
8619	the machine's media, while their parent (base) images
8620	remain unmodified after the snapshot has been taken (see
8621	<link to="IMedium" /> for details about differencing images).
8622	This simplifies restoring a machine to the state of a snapshot:
8623	only the differencing images need to be deleted.
8624
8625	The current machine state is not changed by taking a snapshot.
8626	If the machine is running, it will resume execution after the
8627	snapshot has been taken. After calling this,
8628	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8629	just created.
8630	</li>
8631
8632	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8633	the state of a previous snapshot by deleting the differencing
8634	image of each of the machine's media and setting the machine's
8635	settings and state to the state that was saved in the snapshot (if any).
8636
8637	This destroys the machine's current state. After calling this,
8638	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8639	restored.
8640	</li>
8641
8642	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8643	without affecting the current machine state.
8644
8645	This does not change the current machine state, but instead frees the
8646	resources allocated when the snapshot was taken: the settings and machine
8647	state file are deleted (if any), and the snapshot's differencing image for
8648	each of the machine's media gets merged with its parent image.
8649
8650	Neither the current machine state nor other snapshots are affected
8651	by this operation, except that parent media will be modified
8652	to contain the disk data associated with the snapshot being deleted.
8653
8654	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8655	attribute is set to the current snapshot's parent or NULL if it
8656	has no parent. Otherwise the attribute is unchanged.
8657	</li>
8658	</ul>
8659
8660	Each snapshot contains the settings of the virtual machine (hardware
8661	configuration etc.). In addition, if the machine was running when the
8662	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8663	the current VM state is saved in the snapshot (similarly to what happens
8664	when a VM's state is saved). The snapshot is then said to
8665	be <i>online</i> because when restoring it, the VM will be running.
8666
8667	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8668	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8669
8670	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8671	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8672	it then contains a so-called "zero execution state", representing a
8673	machine that is powered off.
8674	</desc>
8675
8676	<attribute name="id" type="uuid" mod="string" readonly="yes">
8677	<desc>UUID of the snapshot.</desc>
8678	</attribute>
8679
8680	<attribute name="name" type="wstring">
8681	<desc>Short name of the snapshot.</desc>
8682	</attribute>
8683
8684	<attribute name="description" type="wstring">
8685	<desc>Optional description of the snapshot.</desc>
8686	</attribute>
8687
8688	<attribute name="timeStamp" type="long long" readonly="yes">
8689	<desc>
8690	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8691	</desc>
8692	</attribute>
8693
8694	<attribute name="online" type="boolean" readonly="yes">
8695	<desc>
8696	@c true if this snapshot is an online snapshot and @c false otherwise.
8697
8698	When this attribute is @c true, the
8699	<link to="IMachine::stateFilePath"/> attribute of the
8700	<link to="#machine"/> object associated with this snapshot
8701	will point to the saved state file. Otherwise, it will be
8702	an empty string.
8703	</desc>
8704	</attribute>
8705
8706	<attribute name="machine" type="IMachine" readonly="yes">
8707	<desc>
8708	Virtual machine this snapshot is taken on. This object
8709	stores all settings the machine had when taking this snapshot.
8710	<note>
8711	The returned machine object is immutable, i.e. no
8712	any settings can be changed.
8713	</note>
8714	</desc>
8715	</attribute>
8716
8717	<attribute name="parent" type="ISnapshot" readonly="yes">
8718	<desc>
8719	Parent snapshot (a snapshot this one is based on), or
8720	@c null if the snapshot has no parent (i.e. is the first snapshot).
8721	</desc>
8722	</attribute>
8723
8724	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8725	<desc>
8726	Child snapshots (all snapshots having this one as a parent).
8727	</desc>
8728	</attribute>
8729
8730	</interface>
8731
8732
8733	<!--
8734	// IMedium
8735	/////////////////////////////////////////////////////////////////////////
8736	-->
8737
8738	<enum
8739	name="MediumState"
8740	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8741	>
8742	<desc>
8743	Virtual medium state.
8744	<see>IMedium</see>
8745	</desc>
8746
8747	<const name="NotCreated" value="0">
8748	<desc>
8749	Associated medium storage does not exist (either was not created yet or
8750	was deleted).
8751	</desc>
8752	</const>
8753	<const name="Created" value="1">
8754	<desc>
8755	Associated storage exists and accessible; this gets set if the
8756	accessibility check performed by <link to="IMedium::refreshState" />
8757	was successful.
8758	</desc>
8759	</const>
8760	<const name="LockedRead" value="2">
8761	<desc>
8762	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8763	no data modification is possible.
8764	</desc>
8765	</const>
8766	<const name="LockedWrite" value="3">
8767	<desc>
8768	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8769	no concurrent data reading or modification is possible.
8770	</desc>
8771	</const>
8772	<const name="Inaccessible" value="4">
8773	<desc>
8774	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8775	not yet been performed, or else, associated medium storage is not
8776	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8777	is empty, in the second case, it describes the error that occurred.
8778	</desc>
8779	</const>
8780	<const name="Creating" value="5">
8781	<desc>
8782	Associated medium storage is being created.
8783	</desc>
8784	</const>
8785	<const name="Deleting" value="6">
8786	<desc>
8787	Associated medium storage is being deleted.
8788	</desc>
8789	</const>
8790	</enum>
8791
8792	<enum
8793	name="MediumType"
8794	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8795	>
8796	<desc>
8797	Virtual medium type.
8798	<see>IMedium</see>
8799	</desc>
8800
8801	<const name="Normal" value="0">
8802	<desc>
8803	Normal medium (attached directly or indirectly, preserved
8804	when taking snapshots).
8805	</desc>
8806	</const>
8807	<const name="Immutable" value="1">
8808	<desc>
8809	Immutable medium (attached indirectly, changes are wiped out
8810	the next time the virtual machine is started).
8811	</desc>
8812	</const>
8813	<const name="Writethrough" value="2">
8814	<desc>
8815	Write through medium (attached directly, ignored when
8816	taking snapshots).
8817	</desc>
8818	</const>
8819	<const name="Shareable" value="3">
8820	<desc>
8821	Allow using this medium concurrently by several machines.
8822	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8823	</desc>
8824	</const>
8825	<const name="Readonly" value="4">
8826	<desc>
8827	A readonly medium, which can of course be used by several machines.
8828	<note>Present and accepted since VirtualBox 4.0.</note>
8829	</desc>
8830	</const>
8831	</enum>
8832
8833	<enum
8834	name="MediumVariant"
8835	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8836	>
8837	<desc>
8838	Virtual medium image variant. More than one flag may be set.
8839	<see>IMedium</see>
8840	</desc>
8841
8842	<const name="Standard" value="0">
8843	<desc>
8844	No particular variant requested, results in using the backend default.
8845	</desc>
8846	</const>
8847	<const name="VmdkSplit2G" value="0x01">
8848	<desc>
8849	VMDK image split in chunks of less than 2GByte.
8850	</desc>
8851	</const>
8852	<const name="VmdkStreamOptimized" value="0x04">
8853	<desc>
8854	VMDK streamOptimized image. Special import/export format which is
8855	read-only/append-only.
8856	</desc>
8857	</const>
8858	<const name="VmdkESX" value="0x08">
8859	<desc>
8860	VMDK format variant used on ESX products.
8861	</desc>
8862	</const>
8863	<const name="Fixed" value="0x10000">
8864	<desc>
8865	Fixed image. Only allowed for base images.
8866	</desc>
8867	</const>
8868	<const name="Diff" value="0x20000">
8869	<desc>
8870	Differencing image. Only allowed for child images.
8871	</desc>
8872	</const>
8873	</enum>
8874
8875	<interface
8876	name="IMediumAttachment" extends="$unknown"
8877	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
8878	wsmap="struct"
8879	>
8880	<desc>
8881	The IMediumAttachment interface links storage media to virtual machines.
8882	For each medium (<link to="IMedium"/>) which has been attached to a
8883	storage controller (<link to="IStorageController"/>) of a machine
8884	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8885	method, one instance of IMediumAttachment is added to the machine's
8886	<link to="IMachine::mediumAttachments"/> array attribute.
8887
8888	Each medium attachment specifies the storage controller as well as a
8889	port and device number and the IMedium instance representing a virtual
8890	hard disk or floppy or DVD image.
8891
8892	For removeable media (DVDs or floppies), there are two additional
8893	options. For one, the IMedium instance can be @c null to represent
8894	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8895	secondly, the medium can be one of the pseudo-media for host drives
8896	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8897	</desc>
8898
8899	<attribute name="medium" type="IMedium" readonly="yes">
8900	<desc>Medium object associated with this attachment; it
8901	can be @c null for removable devices.</desc>
8902	</attribute>
8903
8904	<attribute name="controller" type="wstring" readonly="yes">
8905	<desc>Name of the storage controller of this attachment; this
8906	refers to one of the controllers in <link to="IMachine::storageControllers" />
8907	by name.</desc>
8908	</attribute>
8909
8910	<attribute name="port" type="long" readonly="yes">
8911	<desc>Port number of this attachment.
8912	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8913	</desc>
8914	</attribute>
8915
8916	<attribute name="device" type="long" readonly="yes">
8917	<desc>Device slot number of this attachment.
8918	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8919	</desc>
8920	</attribute>
8921
8922	<attribute name="type" type="DeviceType" readonly="yes">
8923	<desc>Device type of this attachment.</desc>
8924	</attribute>
8925
8926	<attribute name="passthrough" type="boolean" readonly="yes">
8927	<desc>Pass I/O requests through to a device on the host.</desc>
8928	</attribute>
8929
8930	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
8931	<desc>The bandwidth group this medium attachment is assigned to.</desc>
8932	</attribute>
8933
8934	</interface>
8935
8936	<interface
8937	name="IMedium" extends="$unknown"
8938	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8939	wsmap="managed"
8940	>
8941	<desc>
8942	The IMedium interface represents virtual storage for a machine's
8943	hard disks, CD/DVD or floppy drives. It will typically represent
8944	a disk image on the host, for example a VDI or VMDK file representing
8945	a virtual hard disk, or an ISO or RAW file representing virtual
8946	removable media, but can also point to a network location (e.g.
8947	for iSCSI targets).
8948
8949	Instances of IMedium are connected to virtual machines by way of
8950	medium attachments (see <link to="IMediumAttachment" />), which link
8951	the storage medium to a particular device slot of a storage controller
8952	of the virtual machine.
8953	In the VirtualBox API, virtual storage is therefore always represented
8954	by the following chain of object links:
8955
8956	<ul>
8957	<li><link to="IMachine::storageControllers"/> contains an array of
8958	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8959	these are instances of <link to="IStorageController"/>).</li>
8960	<li><link to="IMachine::mediumAttachments"/> contains an array of
8961	medium attachments (instances of <link to="IMediumAttachment"/>),
8962	each containing a storage controller from the above array, a
8963	port/device specification, and an instance of IMedium representing
8964	the medium storage (image file).
8965
8966	For removable media, the storage medium is optional; a medium
8967	attachment with no medium represents a CD/DVD or floppy drive
8968	with no medium inserted. By contrast, hard disk attachments
8969	will always have an IMedium object attached.</li>
8970	<li>Each IMedium in turn points to a storage unit (such as a file
8971	on the host computer or a network resource) that holds actual
8972	data. This location is represented by the <link to="#location"/>
8973	attribute.</li>
8974	</ul>
8975
8976	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8977	new hard disk media can be created with the VirtualBox API using the
8978	<link to="IVirtualBox::createHardDisk"/> method.
8979
8980	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8981	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8982	type in a regular file.
8983
8984	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8985	drive; in that case the <link to="#id" /> attribute contains the UUID of
8986	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8987
8988	<h3>Known media</h3>
8989
8990	When an existing medium is opened and attached to a virtual machine, it
8991	is automatically added to a media registry. If the medium has first
8992	been attached to a machine which was created by VirtualBox 4.0 or later,
8993	it is added to that machine's media registry (in the machine XML settings
8994	file; this way all information about a machine's media attachments is
8995	contained in a single file). For older media attachments (i.e. if the
8996	medium was first attached to a machine which was created with a VirtualBox
8997	version before 4.0), media continue to be registered in the global
8998	VirtualBox settings file, for backwards compatibility.
8999
9000	See <link to="IVirtualBox::openMedium" /> for more information.
9001
9002	All known media can be enumerated using
9003	<link to="IVirtualBox::hardDisks"/>,
9004	<link to="IVirtualBox::DVDImages"/> and
9005	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9006	quickly found using the <link to="IVirtualBox::findMedium"/> method.
9007
9008	Only known media can be attached to virtual machines.
9009
9010	Removing known media from the media registry is performed when the given
9011	medium is closed using the <link to="#close"/> method or when its
9012	associated storage unit is deleted.
9013
9014	<h3>Accessibility checks</h3>
9015
9016	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9017	method is called explicitly on a medium. This is done to make the VirtualBox object
9018	ready for serving requests as fast as possible and let the end-user
9019	application decide if it needs to check media accessibility right away or not.
9020
9021	As a result, when VirtualBox starts up (e.g. the VirtualBox
9022	object gets created for the first time), all known media are in the
9023	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9024	attribute is an empty string because no actual accessibility check has
9025	been made yet.
9026
9027	After calling <link to="#refreshState" />, a medium is considered
9028	<i>accessible</i> if its storage unit can be read. In that case, the
9029	<link to="#state"/> attribute has a value of "Created". If the storage
9030	unit cannot be read (for example, because it is located on a disconnected
9031	network resource, or was accidentally deleted outside VirtualBox),
9032	the medium is considered <i>inaccessible</i>, which is indicated by the
9033	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9034	obtained by reading the <link to="#lastAccessError"/> attribute.
9035
9036	<h3>Medium types</h3>
9037
9038	There are four types of medium behavior (see <link to="MediumType" />):
9039	"normal", "immutable", "writethrough" and "shareable", represented by the
9040	<link to="#type"/> attribute. The type of the medium defines how the
9041	medium is attached to a virtual machine and what happens when a
9042	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9043	attached medium is taken. At the moment DVD and floppy media are always
9044	of type "writethrough".
9045
9046	All media can be also divided in two groups: <i>base</i> media and
9047	<i>differencing</i> media. A base medium contains all sectors of the
9048	medium data in its own storage and therefore can be used independently.
9049	In contrast, a differencing medium is a "delta" to some other medium and
9050	contains only those sectors which differ from that other medium, which is
9051	then called a <i>parent</i>. The differencing medium is said to be
9052	<i>linked to</i> that parent. The parent may be itself a differencing
9053	medium, thus forming a chain of linked media. The last element in that
9054	chain must always be a base medium. Note that several differencing
9055	media may be linked to the same parent medium.
9056
9057	Differencing media can be distinguished from base media by querying the
9058	<link to="#parent"/> attribute: base media do not have parents they would
9059	depend on, so the value of this attribute is always @c null for them.
9060	Using this attribute, it is possible to walk up the medium tree (from the
9061	child medium to its parent). It is also possible to walk down the tree
9062	using the <link to="#children"/> attribute.
9063
9064	Note that the type of all differencing media is "normal"; all other
9065	values are meaningless for them. Base media may be of any type.
9066
9067	<h3>Creating hard disks</h3>
9068
9069	New base hard disks are created using
9070	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9071	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
9072	disks are usually implicitly created by VirtualBox when needed but may
9073	also be created explicitly using <link to="#createDiffStorage"/>.
9074
9075	After the hard disk is successfully created (including the storage unit)
9076	or opened, it becomes a known hard disk (remembered in the internal media
9077	registry). Known hard disks can be attached to a virtual machine, accessed
9078	through <link to="IVirtualBox::findMedium"/> or enumerated using the
9079	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9080
9081	The following methods, besides <link to="IMedium::close"/>,
9082	automatically remove the hard disk from the media registry:
9083	<ul>
9084	<li><link to="#deleteStorage"/></li>
9085	<li><link to="#mergeTo"/></li>
9086	</ul>
9087
9088	If the storage unit of the hard disk is a regular file in the host's
9089	file system then the rules stated in the description of the
9090	<link to="IMedium::location"/> attribute apply when setting its value.
9091
9092	<h4>Automatic composition of the file name part</h4>
9093
9094	Another extension to the <link to="IMedium::location"/> attribute is that
9095	there is a possibility to cause VirtualBox to compose a unique value for
9096	the file name part of the location using the UUID of the hard disk. This
9097	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9098	e.g. before the storage unit is created, and works as follows. You set the
9099	value of the <link to="IMedium::location"/> attribute to a location
9100	specification which only contains the path specification but not the file
9101	name part and ends with either a forward slash or a backslash character.
9102	In response, VirtualBox will generate a new UUID for the hard disk and
9103	compose the file name using the following pattern:
9104	<pre>
9105	<path>/{<uuid>}.<ext>
9106	</pre>
9107	where <tt><path></tt> is the supplied path specification,
9108	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9109	is the default extension for the storage format of this hard disk. After
9110	that, you may call any of the methods that create a new hard disk storage
9111	unit and they will use the generated UUID and file name.
9112
9113	<h3>Attaching Hard Disks</h3>
9114
9115	Hard disks are attached to virtual machines using the
9116	<link to="IMachine::attachDevice"/> method and detached using the
9117	<link to="IMachine::detachDevice"/> method. Depending on their
9118	<link to="#type"/>, hard disks are attached either
9119	<i>directly</i> or <i>indirectly</i>.
9120
9121	When a hard disk is being attached directly, it is associated with the
9122	virtual machine and used for hard disk operations when the machine is
9123	running. When a hard disk is being attached indirectly, a new differencing
9124	hard disk linked to it is implicitly created and this differencing hard
9125	disk is associated with the machine and used for hard disk operations.
9126	This also means that if <link to="IMachine::attachDevice"/> performs
9127	a direct attachment then the same hard disk will be returned in response
9128	to the subsequent <link to="IMachine::getMedium"/> call; however if
9129	an indirect attachment is performed then
9130	<link to="IMachine::getMedium"/> will return the implicitly created
9131	differencing hard disk, not the original one passed to <link
9132	to="IMachine::attachDevice"/>. In detail:
9133
9134	<ul>
9135	<li><b>Normal base</b> hard disks that do not have children (i.e.
9136	differencing hard disks linked to them) and that are not already
9137	attached to virtual machines in snapshots are attached <b>directly</b>.
9138	Otherwise, they are attached <b>indirectly</b> because having
9139	dependent children or being part of the snapshot makes it impossible
9140	to modify hard disk contents without breaking the integrity of the
9141	dependent party. The <link to="#readOnly"/> attribute allows to
9142	quickly determine the kind of the attachment for the given hard
9143	disk. Note that if a normal base hard disk is to be indirectly
9144	attached to a virtual machine with snapshots then a special
9145	procedure called <i>smart attachment</i> is performed (see below).</li>
9146	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9147	they are attached <b>directly</b> if they do not have children and are
9148	not attached to virtual machines in snapshots, and <b>indirectly</b>
9149	otherwise. Note that the smart attachment procedure is never performed
9150	for differencing hard disks.</li>
9151	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9152	they are designed to be non-writable. If an immutable hard disk is
9153	attached to a virtual machine with snapshots then a special
9154	procedure called smart attachment is performed (see below).</li>
9155	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9156	also as designed. This also means that writethrough hard disks cannot
9157	have other hard disks linked to them at all.</li>
9158	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9159	also as designed. This also means that shareable hard disks cannot
9160	have other hard disks linked to them at all. They behave almost
9161	like writethrough hard disks, except that shareable hard disks can
9162	be attached to several virtual machines which are running, allowing
9163	concurrent accesses. You need special cluster software running in
9164	the virtual machines to make use of such disks.</li>
9165	</ul>
9166
9167	Note that the same hard disk, regardless of its type, may be attached to
9168	more than one virtual machine at a time. In this case, the machine that is
9169	started first gains exclusive access to the hard disk and attempts to
9170	start other machines having this hard disk attached will fail until the
9171	first machine is powered down.
9172
9173	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9174	that the given hard disk remains associated with the given machine after a
9175	successful <link to="IMachine::detachDevice"/> call until
9176	<link to="IMachine::saveSettings"/> is called to save all changes to
9177	machine settings to disk. This deferring is necessary to guarantee that
9178	the hard disk configuration may be restored at any time by a call to
9179	<link to="IMachine::discardSettings"/> before the settings
9180	are saved (committed).
9181
9182	Note that if <link to="IMachine::discardSettings"/> is called after
9183	indirectly attaching some hard disks to the machine but before a call to
9184	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9185	all differencing hard disks implicitly created by
9186	<link to="IMachine::attachDevice"/> for these indirect attachments.
9187	Such implicitly created hard disks will also be immediately deleted when
9188	detached explicitly using the <link to="IMachine::detachDevice"/>
9189	call if it is made before <link to="IMachine::saveSettings"/>. This
9190	implicit deletion is safe because newly created differencing hard
9191	disks do not contain any user data.
9192
9193	However, keep in mind that detaching differencing hard disks that were
9194	implicitly created by <link to="IMachine::attachDevice"/>
9195	before the last <link to="IMachine::saveSettings"/> call will
9196	<b>not</b> implicitly delete them as they may already contain some data
9197	(for example, as a result of virtual machine execution). If these hard
9198	disks are no more necessary, the caller can always delete them explicitly
9199	using <link to="#deleteStorage"/> after they are actually de-associated
9200	from this machine by the <link to="IMachine::saveSettings"/> call.
9201
9202	<h3>Smart Attachment</h3>
9203
9204	When normal base or immutable hard disks are indirectly attached to a
9205	virtual machine then some additional steps are performed to make sure the
9206	virtual machine will have the most recent "view" of the hard disk being
9207	attached. These steps include walking through the machine's snapshots
9208	starting from the current one and going through ancestors up to the first
9209	snapshot. Hard disks attached to the virtual machine in all
9210	of the encountered snapshots are checked whether they are descendants of
9211	the given normal base or immutable hard disk. The first found child (which
9212	is the differencing hard disk) will be used instead of the normal base or
9213	immutable hard disk as a parent for creating a new differencing hard disk
9214	that will be actually attached to the machine. And only if no descendants
9215	are found or if the virtual machine does not have any snapshots then the
9216	normal base or immutable hard disk will be used itself as a parent for
9217	this differencing hard disk.
9218
9219	It is easier to explain what smart attachment does using the
9220	following example:
9221	<pre>
9222	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9223
9224	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9225	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9226	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9227	Snapshot 4 (none) Snapshot 4 (none)
9228	CurState (none) CurState (D3->D2.vdi)
9229
9230	NOT
9231	...
9232	CurState (D3->B.vdi)
9233	</pre>
9234	The first column is the virtual machine configuration before the base hard
9235	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9236	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9237	mean that the hard disk that is actually attached to the machine is a
9238	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9239	another hard disk, <tt>B.vdi</tt>.
9240
9241	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9242	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9243	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9244	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9245	it cannot be attached directly and needs an indirect attachment (i.e.
9246	implicit creation of a new differencing hard disk). Due to the smart
9247	attachment procedure, the new differencing hard disk
9248	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9249	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9250	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9251	machine.
9252
9253	Note that if there is more than one descendant hard disk of the given base
9254	hard disk found in a snapshot, and there is an exact device, channel and
9255	bus match, then this exact match will be used. Otherwise, the youngest
9256	descendant will be picked up.
9257
9258	There is one more important aspect of the smart attachment procedure which
9259	is not related to snapshots at all. Before walking through the snapshots
9260	as described above, the backup copy of the current list of hard disk
9261	attachment is searched for descendants. This backup copy is created when
9262	the hard disk configuration is changed for the first time after the last
9263	<link to="IMachine::saveSettings"/> call and used by
9264	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9265	changes. When such a descendant is found in this backup copy, it will be
9266	simply re-attached back, without creating a new differencing hard disk for
9267	it. This optimization is necessary to make it possible to re-attach the
9268	base or immutable hard disk to a different bus, channel or device slot
9269	without losing the contents of the differencing hard disk actually
9270	attached to the machine in place of it.
9271	</desc>
9272
9273	<attribute name="id" type="uuid" mod="string" readonly="yes">
9274	<desc>
9275	UUID of the medium. For a newly created medium, this value is a randomly
9276	generated UUID.
9277
9278	<note>
9279	For media in one of MediumState_NotCreated, MediumState_Creating or
9280	MediumState_Deleting states, the value of this property is undefined
9281	and will most likely be an empty UUID.
9282	</note>
9283	</desc>
9284	</attribute>
9285
9286	<attribute name="description" type="wstring">
9287	<desc>
9288	Optional description of the medium. For a newly created medium the value
9289	of this attribute is an empty string.
9290
9291	Medium types that don't support this attribute will return E_NOTIMPL in
9292	attempt to get or set this attribute's value.
9293
9294	<note>
9295	For some storage types, reading this attribute may return an outdated
9296	(last known) value when <link to="#state"/> is <link
9297	to="MediumState_Inaccessible"/> or <link
9298	to="MediumState_LockedWrite"/> because the value of this attribute is
9299	stored within the storage unit itself. Also note that changing the
9300	attribute value is not possible in such case, as well as when the
9301	medium is the <link to="MediumState_LockedRead"/> state.
9302	</note>
9303	</desc>
9304	</attribute>
9305
9306	<attribute name="state" type="MediumState" readonly="yes">
9307	<desc>
9308	Returns the current medium state, which is the last state set by
9309	the accessibility check performed by <link to="#refreshState"/>.
9310	If that method has not yet been called on the medium, the state
9311	is "Inaccessible"; as opposed to truly inaccessible media, the
9312	value of <link to="#lastAccessError"/> will be an empty string in
9313	that case.
9314
9315	<note>As of version 3.1, this no longer performs an accessibility check
9316	automatically; call <link to="#refreshState"/> for that.
9317	</note>
9318	</desc>
9319	</attribute>
9320
9321	<attribute name="variant" type="MediumVariant" readonly="yes">
9322	<desc>
9323	Returns the storage format variant information for this medium.
9324	Before <link to="#refreshState"/> is called this method returns
9325	an undefined value.
9326	</desc>
9327	</attribute>
9328
9329	<attribute name="location" type="wstring">
9330	<desc>
9331	Location of the storage unit holding medium data.
9332
9333	The format of the location string is medium type specific. For medium
9334	types using regular files in a host's file system, the location
9335	string is the full file name.
9336
9337	Some medium types may support changing the storage unit location by
9338	simply changing the value of this property. If this operation is not
9339	supported, the implementation will return E_NOTIMPL in attempt to set
9340	this attribute's value.
9341
9342	When setting a value of the location attribute which is a regular file
9343	in the host's file system, the given file name may be either relative to
9344	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9345	absolute. Note that if the given location specification does not contain
9346	the file extension part then a proper default extension will be
9347	automatically appended by the implementation depending on the medium type.
9348	</desc>
9349	</attribute>
9350
9351	<attribute name="name" type="wstring" readonly="yes">
9352	<desc>
9353	Name of the storage unit holding medium data.
9354
9355	The returned string is a short version of the <link to="#location"/>
9356	attribute that is suitable for representing the medium in situations
9357	where the full location specification is too long (such as lists
9358	and comboboxes in GUI frontends). This string is also used by frontends
9359	to sort the media list alphabetically when needed.
9360
9361	For example, for locations that are regular files in the host's file
9362	system, the value of this attribute is just the file name (+ extension),
9363	without the path specification.
9364
9365	Note that as opposed to the <link to="#location"/> attribute, the name
9366	attribute will not necessary be unique for a list of media of the
9367	given type and format.
9368	</desc>
9369	</attribute>
9370
9371	<attribute name="deviceType" type="DeviceType" readonly="yes">
9372	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9373	medium.</desc>
9374	</attribute>
9375
9376	<attribute name="hostDrive" type="boolean" readonly="yes">
9377	<desc>True if this corresponds to a drive on the host.</desc>
9378	</attribute>
9379
9380	<attribute name="size" type="long long" readonly="yes">
9381	<desc>
9382	Physical size of the storage unit used to hold medium data (in bytes).
9383
9384	<note>
9385	For media whose <link to="#state"/> is <link
9386	to="MediumState_Inaccessible"/>, the value of this property is the
9387	last known size. For <link to="MediumState_NotCreated"/> media,
9388	the returned value is zero.
9389	</note>
9390	</desc>
9391	</attribute>
9392
9393	<attribute name="format" type="wstring" readonly="yes">
9394	<desc>
9395	Storage format of this medium.
9396
9397	The value of this attribute is a string that specifies a backend used
9398	to store medium data. The storage format is defined when you create a
9399	new medium or automatically detected when you open an existing medium,
9400	and cannot be changed later.
9401
9402	The list of all storage formats supported by this VirtualBox
9403	installation can be obtained using
9404	<link to="ISystemProperties::mediumFormats"/>.
9405	</desc>
9406	</attribute>
9407
9408	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9409	<desc>
9410	Storage medium format object corresponding to this medium.
9411
9412	The value of this attribute is a reference to the medium format object
9413	that specifies the backend properties used to store medium data. The
9414	storage format is defined when you create a new medium or automatically
9415	detected when you open an existing medium, and cannot be changed later.
9416
9417	<note>@c null is returned if there is no associated medium format
9418	object. This can e.g. happen for medium objects representing host
9419	drives and other special medium objects.</note>
9420	</desc>
9421	</attribute>
9422
9423	<attribute name="type" type="MediumType">
9424	<desc>
9425	Type (role) of this medium.
9426
9427	The following constraints apply when changing the value of this
9428	attribute:
9429	<ul>
9430	<li>If a medium is attached to a virtual machine (either in the
9431	current state or in one of the snapshots), its type cannot be
9432	changed.
9433	</li>
9434	<li>As long as the medium has children, its type cannot be set
9435	to <link to="MediumType_Writethrough"/>.
9436	</li>
9437	<li>The type of all differencing media is
9438	<link to="MediumType_Normal"/> and cannot be changed.
9439	</li>
9440	</ul>
9441
9442	The type of a newly created or opened medium is set to
9443	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9444	which have a type of <link to="MediumType_Writethrough"/>.
9445	</desc>
9446	</attribute>
9447
9448	<attribute name="parent" type="IMedium" readonly="yes">
9449	<desc>
9450	Parent of this medium (the medium this medium is directly based
9451	on).
9452
9453	Only differencing media have parents. For base (non-differencing)
9454	media, @c null is returned.
9455	</desc>
9456	</attribute>
9457
9458	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9459	<desc>
9460	Children of this medium (all differencing media directly based
9461	on this medium). A @c null array is returned if this medium
9462	does not have any children.
9463	</desc>
9464	</attribute>
9465
9466	<attribute name="base" type="IMedium" readonly="yes">
9467	<desc>
9468	Base medium of this medium.
9469
9470	If this is a differencing medium, its base medium is the medium
9471	the given medium branch starts from. For all other types of media, this
9472	property returns the medium object itself (i.e. the same object this
9473	property is read on).
9474	</desc>
9475	</attribute>
9476
9477	<attribute name="readOnly" type="boolean" readonly="yes">
9478	<desc>
9479	Returns @c true if this medium is read-only and @c false otherwise.
9480
9481	A medium is considered to be read-only when its contents cannot be
9482	modified without breaking the integrity of other parties that depend on
9483	this medium such as its child media or snapshots of virtual machines
9484	where this medium is attached to these machines. If there are no
9485	children and no such snapshots then there is no dependency and the
9486	medium is not read-only.
9487
9488	The value of this attribute can be used to determine the kind of the
9489	attachment that will take place when attaching this medium to a
9490	virtual machine. If the value is @c false then the medium will
9491	be attached directly. If the value is @c true then the medium
9492	will be attached indirectly by creating a new differencing child
9493	medium for that. See the interface description for more information.
9494
9495	Note that all <link to="MediumType_Immutable">Immutable</link> media
9496	are always read-only while all
9497	<link to="MediumType_Writethrough">Writethrough</link> media are
9498	always not.
9499
9500	<note>
9501	The read-only condition represented by this attribute is related to
9502	the medium type and usage, not to the current
9503	<link to="IMedium::state">medium state</link> and not to the read-only
9504	state of the storage unit.
9505	</note>
9506	</desc>
9507	</attribute>
9508
9509	<attribute name="logicalSize" type="long long" readonly="yes">
9510	<desc>
9511	Logical size of this medium (in bytes), as reported to the
9512	guest OS running inside the virtual machine this medium is
9513	attached to. The logical size is defined when the medium is created
9514	and cannot be changed later.
9515
9516	<note>
9517	Reading this property on a differencing medium will return the size
9518	of its <link to="#base"/> medium.
9519	</note>
9520	<note>
9521	For media whose state is <link to="#state"/> is <link
9522	to="MediumState_Inaccessible"/>, the value of this property is the
9523	last known logical size. For <link to="MediumState_NotCreated"/>
9524	media, the returned value is zero.
9525	</note>
9526	</desc>
9527	</attribute>
9528
9529	<attribute name="autoReset" type="boolean">
9530	<desc>
9531	Whether this differencing medium will be automatically reset each
9532	time a virtual machine it is attached to is powered up. This
9533	attribute is automatically set to @c true for the last
9534	differencing image of an "immutable" medium (see
9535	<link to="MediumType" />).
9536
9537	See <link to="#reset"/> for more information about resetting
9538	differencing media.
9539
9540	<note>
9541	Reading this property on a base (non-differencing) medium will
9542	always @c false. Changing the value of this property in this
9543	case is not supported.
9544	</note>
9545
9546	<result name="VBOX_E_NOT_SUPPORTED">
9547	This is not a differencing medium (when changing the attribute
9548	value).
9549	</result>
9550	</desc>
9551	</attribute>
9552
9553	<attribute name="lastAccessError" type="wstring" readonly="yes">
9554	<desc>
9555	Text message that represents the result of the last accessibility
9556	check performed by <link to="#refreshState"/>.
9557
9558	An empty string is returned if the last accessibility check
9559	was successful or has not yet been called. As a result, if
9560	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9561	then <link to="#refreshState"/> has yet to be called; this is the
9562	default value of media after VirtualBox initialization.
9563	A non-empty string indicates a failure and should normally describe
9564	a reason of the failure (for example, a file read error).
9565	</desc>
9566	</attribute>
9567
9568	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9569	<desc>
9570	Array of UUIDs of all machines this medium is attached to.
9571
9572	A @c null array is returned if this medium is not attached to any
9573	machine or to any machine's snapshot.
9574
9575	<note>
9576	The returned array will include a machine even if this medium is not
9577	attached to that machine in the current state but attached to it in
9578	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9579	details.
9580	</note>
9581	</desc>
9582	</attribute>
9583
9584	<method name="setIDs">
9585	<desc>
9586	Changes the UUID and parent UUID for a hard disk medium.
9587	</desc>
9588	<param name="setImageId" type="boolean" dir="in">
9589	<desc>
9590	Select whether a new image UUID is set or not.
9591	</desc>
9592	</param>
9593	<param name="imageId" type="uuid" mod="string" dir="in">
9594	<desc>
9595	New UUID for the image. If an empty string is passed, then a new
9596	UUID is automatically created, provided that @a setImageId is @c true.
9597	Specifying a zero UUID is not allowed.
9598	</desc>
9599	</param>
9600	<param name="setParentId" type="boolean" dir="in">
9601	<desc>
9602	Select whether a new parent UUID is set or not.
9603	</desc>
9604	</param>
9605	<param name="parentId" type="uuid" mod="string" dir="in">
9606	<desc>
9607	New parent UUID for the image. If an empty string is passed, then a
9608	new UUID is automatically created, provided @a setParentId is
9609	@c true. A zero UUID is valid.
9610	</desc>
9611	</param>
9612	<result name="E_INVALIDARG">
9613	Invalid parameter combination.
9614	</result>
9615	<result name="VBOX_E_NOT_SUPPORTED">
9616	Medium is not a hard disk medium.
9617	</result>
9618	</method>
9619
9620	<method name="refreshState">
9621	<desc>
9622	If the current medium state (see <link to="MediumState"/>) is one of
9623	"Created", "Inaccessible" or "LockedRead", then this performs an
9624	accessibility check on the medium and sets the value of the <link to="#state"/>
9625	attribute accordingly; that value is also returned for convenience.
9626
9627	For all other state values, this does not perform a refresh but returns
9628	the state only.
9629
9630	The refresh, if performed, may take a long time (several seconds or even
9631	minutes, depending on the storage unit location and format) because it performs an
9632	accessibility check of the storage unit. This check may cause a significant
9633	delay if the storage unit of the given medium is, for example, a file located
9634	on a network share which is not currently accessible due to connectivity
9635	problems. In that case, the call will not return until a timeout
9636	interval defined by the host OS for this operation expires. For this reason,
9637	it is recommended to never read this attribute on the main UI thread to avoid
9638	making the UI unresponsive.
9639
9640	If the last known state of the medium is "Created" and the accessibility
9641	check fails, then the state would be set to "Inaccessible", and
9642	<link to="#lastAccessError"/> may be used to get more details about the
9643	failure. If the state of the medium is "LockedRead", then it remains the
9644	same, and a non-empty value of <link to="#lastAccessError"/> will
9645	indicate a failed accessibility check in this case.
9646
9647	Note that not all medium states are applicable to all medium types.
9648	</desc>
9649	<param name="state" type="MediumState" dir="return">
9650	<desc>
9651	New medium state.
9652	</desc>
9653	</param>
9654	</method>
9655
9656	<method name="getSnapshotIds">
9657	<desc>
9658	Returns an array of UUIDs of all snapshots of the given machine where
9659	this medium is attached to.
9660
9661	If the medium is attached to the machine in the current state, then the
9662	first element in the array will always be the ID of the queried machine
9663	(i.e. the value equal to the @c machineId argument), followed by
9664	snapshot IDs (if any).
9665
9666	If the medium is not attached to the machine in the current state, then
9667	the array will contain only snapshot IDs.
9668
9669	The returned array may be @c null if this medium is not attached
9670	to the given machine at all, neither in the current state nor in one of
9671	the snapshots.
9672	</desc>
9673	<param name="machineId" type="uuid" mod="string" dir="in">
9674	<desc>
9675	UUID of the machine to query.
9676	</desc>
9677	</param>
9678	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9679	<desc>
9680	Array of snapshot UUIDs of the given machine using this medium.
9681	</desc>
9682	</param>
9683	</method>
9684
9685	<method name="lockRead">
9686	<desc>
9687	Locks this medium for reading.
9688
9689	A read lock is shared: many clients can simultaneously lock the
9690	same medium for reading unless it is already locked for writing (see
9691	<link to="#lockWrite"/>) in which case an error is returned.
9692
9693	When the medium is locked for reading, it cannot be modified
9694	from within VirtualBox. This means that any method that changes
9695	the properties of this medium or contents of the storage unit
9696	will return an error (unless explicitly stated otherwise). That
9697	includes an attempt to start a virtual machine that wants to
9698	write to the the medium.
9699
9700	When the virtual machine is started up, it locks for reading all
9701	media it uses in read-only mode. If some medium cannot be locked
9702	for reading, the startup procedure will fail.
9703	A medium is typically locked for reading while it is used by a running
9704	virtual machine but has a depending differencing image that receives
9705	the actual write operations. This way one base medium can have
9706	multiple child differencing images which can be written to
9707	simultaneously. Read-only media such as DVD and floppy images are
9708	also locked for reading only (so they can be in use by multiple
9709	machines simultaneously).
9710
9711	A medium is also locked for reading when it is the source of a
9712	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9713
9714	The medium locked for reading must be unlocked using the <link
9715	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9716	can be nested and must be followed by the same number of paired
9717	<link to="#unlockRead"/> calls.
9718
9719	This method sets the medium state (see <link to="#state"/>) to
9720	"LockedRead" on success. The medium's previous state must be
9721	one of "Created", "Inaccessible" or "LockedRead".
9722
9723	Locking an inaccessible medium is not an error; this method performs
9724	a logical lock that prevents modifications of this medium through
9725	the VirtualBox API, not a physical file-system lock of the underlying
9726	storage unit.
9727
9728	This method returns the current state of the medium
9729	<i>before</i> the operation.
9730
9731	<result name="VBOX_E_INVALID_OBJECT_STATE">
9732	Invalid medium state (e.g. not created, locked, inaccessible,
9733	creating, deleting).
9734	</result>
9735
9736	</desc>
9737	<param name="state" type="MediumState" dir="return">
9738	<desc>
9739	State of the medium after the operation.
9740	</desc>
9741	</param>
9742	</method>
9743
9744	<method name="unlockRead">
9745	<desc>
9746	Cancels the read lock previously set by <link to="#lockRead"/>.
9747
9748	For both success and failure, this method returns the current state
9749	of the medium <i>after</i> the operation.
9750
9751	See <link to="#lockRead"/> for more details.
9752
9753	<result name="VBOX_E_INVALID_OBJECT_STATE">
9754	Medium not locked for reading.
9755	</result>
9756
9757	</desc>
9758	<param name="state" type="MediumState" dir="return">
9759	<desc>
9760	State of the medium after the operation.
9761	</desc>
9762	</param>
9763	</method>
9764
9765	<method name="lockWrite">
9766	<desc>
9767	Locks this medium for writing.
9768
9769	A write lock, as opposed to <link to="#lockRead"/>, is
9770	exclusive: there may be only one client holding a write lock,
9771	and there may be no read locks while the write lock is held.
9772	As a result, read-locking fails if a write lock is held, and
9773	write-locking fails if either a read or another write lock is held.
9774
9775	When a medium is locked for writing, it cannot be modified
9776	from within VirtualBox, and it is not guaranteed that the values
9777	of its properties are up-to-date. Any method that changes the
9778	properties of this medium or contents of the storage unit will
9779	return an error (unless explicitly stated otherwise).
9780
9781	When a virtual machine is started up, it locks for writing all
9782	media it uses to write data to. If any medium could not be locked
9783	for writing, the startup procedure will fail. If a medium has
9784	differencing images, then while the machine is running, only
9785	the last ("leaf") differencing image is locked for writing,
9786	whereas its parents are locked for reading only.
9787
9788	A medium is also locked for writing when it is the target of a
9789	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9790
9791	The medium locked for writing must be unlocked using the <link
9792	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9793
9794	This method sets the medium state (see <link to="#state"/>) to
9795	"LockedWrite" on success. The medium's previous state must be
9796	either "Created" or "Inaccessible".
9797
9798	Locking an inaccessible medium is not an error; this method performs
9799	a logical lock that prevents modifications of this medium through
9800	the VirtualBox API, not a physical file-system lock of the underlying
9801	storage unit.
9802
9803	For both, success and failure, this method returns the current
9804	state of the medium <i>before</i> the operation.
9805
9806	<result name="VBOX_E_INVALID_OBJECT_STATE">
9807	Invalid medium state (e.g. not created, locked, inaccessible,
9808	creating, deleting).
9809	</result>
9810
9811	</desc>
9812	<param name="state" type="MediumState" dir="return">
9813	<desc>
9814	State of the medium after the operation.
9815	</desc>
9816	</param>
9817	</method>
9818
9819	<method name="unlockWrite">
9820	<desc>
9821	Cancels the write lock previously set by <link to="#lockWrite"/>.
9822
9823	For both success and failure, this method returns the current
9824	state of the medium <i>after</i> the operation.
9825
9826	See <link to="#lockWrite"/> for more details.
9827
9828	<result name="VBOX_E_INVALID_OBJECT_STATE">
9829	Medium not locked for writing.
9830	</result>
9831
9832	</desc>
9833	<param name="state" type="MediumState" dir="return">
9834	<desc>
9835	State of the medium after the operation.
9836	</desc>
9837	</param>
9838	</method>
9839
9840	<method name="close">
9841	<desc>
9842	Closes this medium.
9843
9844	The medium must not be attached to any known virtual machine
9845	and must not have any known child media, otherwise the
9846	operation will fail.
9847
9848	When the medium is successfully closed, it is removed from
9849	the list of registered media, but its storage unit is not
9850	deleted. In particular, this means that this medium can
9851	later be opened again using the <link to="IVirtualBox::openMedium"/>
9852	call.
9853
9854	Note that after this method successfully returns, the given medium
9855	object becomes uninitialized. This means that any attempt
9856	to call any of its methods or attributes will fail with the
9857	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9858
9859	<result name="VBOX_E_INVALID_OBJECT_STATE">
9860	Invalid medium state (other than not created, created or
9861	inaccessible).
9862	</result>
9863	<result name="VBOX_E_OBJECT_IN_USE">
9864	Medium attached to virtual machine.
9865	</result>
9866	<result name="VBOX_E_FILE_ERROR">
9867	Settings file not accessible.
9868	</result>
9869	<result name="VBOX_E_XML_ERROR">
9870	Could not parse the settings file.
9871	</result>
9872
9873	</desc>
9874	</method>
9875
9876	<!-- storage methods -->
9877
9878	<method name="getProperty">
9879	<desc>
9880	Returns the value of the custom medium property with the given name.
9881
9882	The list of all properties supported by the given medium format can
9883	be obtained with <link to="IMediumFormat::describeProperties"/>.
9884
9885	Note that if this method returns an empty string in @a value, the
9886	requested property is supported but currently not assigned any value.
9887
9888	<result name="VBOX_E_OBJECT_NOT_FOUND">
9889	Requested property does not exist (not supported by the format).
9890	</result>
9891	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9892	</desc>
9893	<param name="name" type="wstring" dir="in">
9894	<desc>Name of the property to get.</desc>
9895	</param>
9896	<param name="value" type="wstring" dir="return">
9897	<desc>Current property value.</desc>
9898	</param>
9899	</method>
9900
9901	<method name="setProperty">
9902	<desc>
9903	Sets the value of the custom medium property with the given name.
9904
9905	The list of all properties supported by the given medium format can
9906	be obtained with <link to="IMediumFormat::describeProperties"/>.
9907
9908	Note that setting the property value to @c null or an empty string is
9909	equivalent to deleting the existing value. A default value (if it is
9910	defined for this property) will be used by the format backend in this
9911	case.
9912
9913	<result name="VBOX_E_OBJECT_NOT_FOUND">
9914	Requested property does not exist (not supported by the format).
9915	</result>
9916	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9917	</desc>
9918	<param name="name" type="wstring" dir="in">
9919	<desc>Name of the property to set.</desc>
9920	</param>
9921	<param name="value" type="wstring" dir="in">
9922	<desc>Property value to set.</desc>
9923	</param>
9924	</method>
9925
9926	<method name="getProperties">
9927	<desc>
9928	Returns values for a group of properties in one call.
9929
9930	The names of the properties to get are specified using the @a names
9931	argument which is a list of comma-separated property names or
9932	an empty string if all properties are to be returned. Note that currently
9933	the value of this argument is ignored and the method always returns all
9934	existing properties.
9935
9936	The list of all properties supported by the given medium format can
9937	be obtained with <link to="IMediumFormat::describeProperties"/>.
9938
9939	The method returns two arrays, the array of property names corresponding
9940	to the @a names argument and the current values of these properties.
9941	Both arrays have the same number of elements with each elemend at the
9942	given index in the first array corresponds to an element at the same
9943	index in the second array.
9944
9945	Note that for properties that do not have assigned values,
9946	an empty string is returned at the appropriate index in the
9947	@a returnValues array.
9948
9949	</desc>
9950	<param name="names" type="wstring" dir="in">
9951	<desc>
9952	Names of properties to get.
9953	</desc>
9954	</param>
9955	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9956	<desc>Names of returned properties.</desc>
9957	</param>
9958	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9959	<desc>Values of returned properties.</desc>
9960	</param>
9961	</method>
9962
9963	<method name="setProperties">
9964	<desc>
9965	Sets values for a group of properties in one call.
9966
9967	The names of the properties to set are passed in the @a names
9968	array along with the new values for them in the @a values array. Both
9969	arrays have the same number of elements with each elemend at the given
9970	index in the first array corresponding to an element at the same index
9971	in the second array.
9972
9973	If there is at least one property name in @a names that is not valid,
9974	the method will fail before changing the values of any other properties
9975	from the @a names array.
9976
9977	Using this method over <link to="#setProperty"/> is preferred if you
9978	need to set several properties at once since it will result into less
9979	IPC calls.
9980
9981	The list of all properties supported by the given medium format can
9982	be obtained with <link to="IMediumFormat::describeProperties"/>.
9983
9984	Note that setting the property value to @c null or an empty string is
9985	equivalent to deleting the existing value. A default value (if it is
9986	defined for this property) will be used by the format backend in this
9987	case.
9988	</desc>
9989	<param name="names" type="wstring" safearray="yes" dir="in">
9990	<desc>Names of properties to set.</desc>
9991	</param>
9992	<param name="values" type="wstring" safearray="yes" dir="in">
9993	<desc>Values of properties to set.</desc>
9994	</param>
9995	</method>
9996
9997	<!-- storage methods -->
9998
9999	<method name="createBaseStorage">
10000	<desc>
10001	Starts creating a hard disk storage unit (fixed/dynamic, according
10002	to the variant flags) in in the background. The previous storage unit
10003	created for this object, if any, must first be deleted using
10004	<link to="#deleteStorage"/>, otherwise the operation will fail.
10005
10006	Before the operation starts, the medium is placed in
10007	<link to="MediumState_Creating"/> state. If the create operation
10008	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10009	state.
10010
10011	After the returned progress object reports that the operation has
10012	successfully completed, the medium state will be set to <link
10013	to="MediumState_Created"/>, the medium will be remembered by this
10014	VirtualBox installation and may be attached to virtual machines.
10015
10016	<result name="VBOX_E_NOT_SUPPORTED">
10017	The variant of storage creation operation is not supported. See <link
10018	to="IMediumFormat::capabilities"/>.
10019	</result>
10020	</desc>
10021	<param name="logicalSize" type="long long" dir="in">
10022	<desc>Maximum logical size of the medium in bytes.</desc>
10023	</param>
10024	<param name="variant" type="MediumVariant" dir="in">
10025	<desc>Exact image variant which should be created.</desc>
10026	</param>
10027	<param name="progress" type="IProgress" dir="return">
10028	<desc>Progress object to track the operation completion.</desc>
10029	</param>
10030	</method>
10031
10032	<method name="deleteStorage">
10033	<desc>
10034	Starts deleting the storage unit of this medium.
10035
10036	The medium must not be attached to any known virtual machine and must
10037	not have any known child media, otherwise the operation will fail.
10038	It will also fail if there is no storage unit to delete or if deletion
10039	is already in progress, or if the medium is being in use (locked for
10040	read or for write) or inaccessible. Therefore, the only valid state for
10041	this operation to succeed is <link to="MediumState_Created"/>.
10042
10043	Before the operation starts, the medium is placed in
10044	<link to="MediumState_Deleting"/> state and gets removed from the list
10045	of remembered hard disks (media registry). If the delete operation
10046	fails, the medium will be remembered again and placed back to
10047	<link to="MediumState_Created"/> state.
10048
10049	After the returned progress object reports that the operation is
10050	complete, the medium state will be set to
10051	<link to="MediumState_NotCreated"/> and you will be able to use one of
10052	the storage creation methods to create it again.
10053
10054	<see>#close()</see>
10055
10056	<result name="VBOX_E_OBJECT_IN_USE">
10057	Medium is attached to a virtual machine.
10058	</result>
10059	<result name="VBOX_E_NOT_SUPPORTED">
10060	Storage deletion is not allowed because neither of storage creation
10061	operations are supported. See
10062	<link to="IMediumFormat::capabilities"/>.
10063	</result>
10064
10065	<note>
10066	If the deletion operation fails, it is not guaranteed that the storage
10067	unit still exists. You may check the <link to="IMedium::state"/> value
10068	to answer this question.
10069	</note>
10070	</desc>
10071	<param name="progress" type="IProgress" dir="return">
10072	<desc>Progress object to track the operation completion.</desc>
10073	</param>
10074	</method>
10075
10076	<!-- diff methods -->
10077
10078	<method name="createDiffStorage">
10079	<desc>
10080	Starts creating an empty differencing storage unit based on this
10081	medium in the format and at the location defined by the @a target
10082	argument.
10083
10084	The target medium must be in <link to="MediumState_NotCreated"/>
10085	state (i.e. must not have an existing storage unit). Upon successful
10086	completion, this operation will set the type of the target medium to
10087	<link to="MediumType_Normal"/> and create a storage unit necessary to
10088	represent the differencing medium data in the given format (according
10089	to the storage format of the target object).
10090
10091	After the returned progress object reports that the operation is
10092	successfully complete, the target medium gets remembered by this
10093	VirtualBox installation and may be attached to virtual machines.
10094
10095	<note>
10096	The medium will be set to <link to="MediumState_LockedRead"/>
10097	state for the duration of this operation.
10098	</note>
10099	<result name="VBOX_E_OBJECT_IN_USE">
10100	Medium not in @c NotCreated state.
10101	</result>
10102	</desc>
10103	<param name="target" type="IMedium" dir="in">
10104	<desc>Target medium.</desc>
10105	</param>
10106	<param name="variant" type="MediumVariant" dir="in">
10107	<desc>Exact image variant which should be created.</desc>
10108	</param>
10109	<param name="progress" type="IProgress" dir="return">
10110	<desc>Progress object to track the operation completion.</desc>
10111	</param>
10112	</method>
10113
10114	<method name="mergeTo">
10115	<desc>
10116	Starts merging the contents of this medium and all intermediate
10117	differencing media in the chain to the given target medium.
10118
10119	The target medium must be either a descendant of this medium or
10120	its ancestor (otherwise this method will immediately return a failure).
10121	It follows that there are two logical directions of the merge operation:
10122	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10123	ancestor (<i>backward merge</i>). Let us consider the following medium
10124	chain:
10125
10126	<pre>Base <- Diff_1 <- Diff_2</pre>
10127
10128	Here, calling this method on the <tt>Base</tt> medium object with
10129	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10130	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10131	merge. Note that in both cases the contents of the resulting medium
10132	will be the same, the only difference is the medium object that takes
10133	the result of the merge operation. In case of the forward merge in the
10134	above example, the result will be written to <tt>Diff_2</tt>; in case of
10135	the backward merge, the result will be written to <tt>Base</tt>. In
10136	other words, the result of the operation is always stored in the target
10137	medium.
10138
10139	Upon successful operation completion, the storage units of all media in
10140	the chain between this (source) medium and the target medium, including
10141	the source medium itself, will be automatically deleted and the
10142	relevant medium objects (including this medium) will become
10143	uninitialized. This means that any attempt to call any of
10144	their methods or attributes will fail with the
10145	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10146	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10147	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10148	Note that <tt>Diff_2</tt> in this case will become a base medium
10149	itself since it will no longer be based on any other medium.
10150
10151	Considering the above, all of the following conditions must be met in
10152	order for the merge operation to succeed:
10153	<ul>
10154	<li>
10155	Neither this (source) medium nor any intermediate
10156	differencing medium in the chain between it and the target
10157	medium is attached to any virtual machine.
10158	</li>
10159	<li>
10160	Neither the source medium nor the target medium is an
10161	<link to="MediumType_Immutable"/> medium.
10162	</li>
10163	<li>
10164	The part of the medium tree from the source medium to the
10165	target medium is a linear chain, i.e. all medium in this
10166	chain have exactly one child which is the next medium in this
10167	chain. The only exception from this rule is the target medium in
10168	the forward merge operation; it is allowed to have any number of
10169	child media because the merge operation will not change its
10170	logical contents (as it is seen by the guest OS or by children).
10171	</li>
10172	<li>
10173	None of the involved media are in
10174	<link to="MediumState_LockedRead"/> or
10175	<link to="MediumState_LockedWrite"/> state.
10176	</li>
10177	</ul>
10178
10179	<note>
10180	This (source) medium and all intermediates will be placed to <link
10181	to="MediumState_Deleting"/> state and the target medium will be
10182	placed to <link to="MediumState_LockedWrite"/> state and for the
10183	duration of this operation.
10184	</note>
10185	</desc>
10186	<param name="target" type="IMedium" dir="in">
10187	<desc>Target medium.</desc>
10188	</param>
10189	<param name="progress" type="IProgress" dir="return">
10190	<desc>Progress object to track the operation completion.</desc>
10191	</param>
10192	</method>
10193
10194	<!-- clone method -->
10195
10196	<method name="cloneTo">
10197	<desc>
10198	Starts creating a clone of this medium in the format and at the
10199	location defined by the @a target argument.
10200
10201	The target medium must be either in <link to="MediumState_NotCreated"/>
10202	state (i.e. must not have an existing storage unit) or in
10203	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10204	big enough to hold the data or else the copy will be partial). Upon
10205	successful completion, the cloned medium will contain exactly the
10206	same sector data as the medium being cloned, except that in the
10207	first case a new UUID for the clone will be randomly generated, and in
10208	the second case the UUID will remain unchanged.
10209
10210	The @a parent argument defines which medium will be the parent
10211	of the clone. Passing a @c null reference indicates that the clone will
10212	be a base image, i.e. completely independent. It is possible to specify
10213	an arbitrary medium for this parameter, including the parent of the
10214	medium which is being cloned. Even cloning to a child of the source
10215	medium is possible. Note that when cloning to an existing image, the
10216	@a parent irgument is ignored.
10217
10218	After the returned progress object reports that the operation is
10219	successfully complete, the target medium gets remembered by this
10220	VirtualBox installation and may be attached to virtual machines.
10221
10222	<note>
10223	This medium will be placed to <link to="MediumState_LockedRead"/>
10224	state for the duration of this operation.
10225	</note>
10226	<result name="E_NOTIMPL">
10227	The specified cloning variant is not supported at the moment.
10228	</result>
10229	</desc>
10230	<param name="target" type="IMedium" dir="in">
10231	<desc>Target medium.</desc>
10232	</param>
10233	<param name="variant" type="MediumVariant" dir="in">
10234	<desc>Exact image variant which should be created.</desc>
10235	</param>
10236	<param name="parent" type="IMedium" dir="in">
10237	<desc>Parent of the cloned medium.</desc>
10238	</param>
10239	<param name="progress" type="IProgress" dir="return">
10240	<desc>Progress object to track the operation completion.</desc>
10241	</param>
10242	</method>
10243
10244	<!-- other methods -->
10245
10246	<method name="compact">
10247	<desc>
10248	Starts compacting of this medium. This means that the medium is
10249	transformed into a possibly more compact storage representation.
10250	This potentially creates temporary images, which can require a
10251	substantial amount of additional disk space.
10252
10253	This medium will be placed to <link to="MediumState_LockedWrite"/>
10254	state and all its parent media (if any) will be placed to
10255	<link to="MediumState_LockedRead"/> state for the duration of this
10256	operation.
10257
10258	Please note that the results can be either returned straight away,
10259	or later as the result of the background operation via the object
10260	returned via the @a progress parameter.
10261
10262	<result name="VBOX_E_NOT_SUPPORTED">
10263	Medium format does not support compacting (but potentially
10264	needs it).
10265	</result>
10266	</desc>
10267	<param name="progress" type="IProgress" dir="return">
10268	<desc>Progress object to track the operation completion.</desc>
10269	</param>
10270	</method>
10271
10272	<method name="resize">
10273	<desc>
10274	Starts resizing this medium. This means that the nominal size of the
10275	medium is set to the new value. Both increasing and decreasing the
10276	size is possible, and there are no safety checks, since VirtualBox
10277	does not make any assumptions about the medium contents.
10278
10279	Resizing usually needs additional disk space, and possibly also
10280	some temporary disk space. Note that resize does not create a full
10281	temporary copy of the medium, so the additional disk space requirement
10282	is usually much lower than using the clone operation.
10283
10284	This medium will be placed to <link to="MediumState_LockedWrite"/>
10285	state for the duration of this operation.
10286
10287	Please note that the results can be either returned straight away,
10288	or later as the result of the background operation via the object
10289	returned via the @a progress parameter.
10290
10291	<result name="VBOX_E_NOT_SUPPORTED">
10292	Medium format does not support resizing.
10293	</result>
10294	</desc>
10295	<param name="logicalSize" type="long long" dir="in">
10296	<desc>New nominal capacity of the medium in bytes.</desc>
10297	</param>
10298	<param name="progress" type="IProgress" dir="return">
10299	<desc>Progress object to track the operation completion.</desc>
10300	</param>
10301	</method>
10302
10303	<method name="reset">
10304	<desc>
10305	Starts erasing the contents of this differencing medium.
10306
10307	This operation will reset the differencing medium to its initial
10308	state when it does not contain any sector data and any read operation is
10309	redirected to its parent medium. This automatically gets called
10310	during VM power-up for every medium whose <link to="#autoReset" />
10311	attribute is @c true.
10312
10313	The medium will be write-locked for the duration of this operation (see
10314	<link to="#lockWrite" />).
10315
10316	<result name="VBOX_E_NOT_SUPPORTED">
10317	This is not a differencing medium.
10318	</result>
10319	<result name="VBOX_E_INVALID_OBJECT_STATE">
10320	Medium is not in <link to="MediumState_Created"/> or
10321	<link to="MediumState_Inaccessible"/> state.
10322	</result>
10323	</desc>
10324	<param name="progress" type="IProgress" dir="return">
10325	<desc>Progress object to track the operation completion.</desc>
10326	</param>
10327	</method>
10328
10329	</interface>
10330
10331
10332	<!--
10333	// IMediumFormat
10334	/////////////////////////////////////////////////////////////////////////
10335	-->
10336
10337	<enum
10338	name="DataType"
10339	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10340	>
10341	<const name="Int32" value="0"/>
10342	<const name="Int8" value="1"/>
10343	<const name="String" value="2"/>
10344	</enum>
10345
10346	<enum
10347	name="DataFlags"
10348	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10349	>
10350	<const name="None" value="0x00"/>
10351	<const name="Mandatory" value="0x01"/>
10352	<const name="Expert" value="0x02"/>
10353	<const name="Array" value="0x04"/>
10354	<const name="FlagMask" value="0x07"/>
10355	</enum>
10356
10357	<enum
10358	name="MediumFormatCapabilities"
10359	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10360	>
10361	<desc>
10362	Medium format capability flags.
10363	</desc>
10364
10365	<const name="Uuid" value="0x01">
10366	<desc>
10367	Supports UUIDs as expected by VirtualBox code.
10368	</desc>
10369	</const>
10370
10371	<const name="CreateFixed" value="0x02">
10372	<desc>
10373	Supports creating fixed size images, allocating all space instantly.
10374	</desc>
10375	</const>
10376
10377	<const name="CreateDynamic" value="0x04">
10378	<desc>
10379	Supports creating dynamically growing images, allocating space on
10380	demand.
10381	</desc>
10382	</const>
10383
10384	<const name="CreateSplit2G" value="0x08">
10385	<desc>
10386	Supports creating images split in chunks of a bit less than 2 GBytes.
10387	</desc>
10388	</const>
10389
10390	<const name="Differencing" value="0x10">
10391	<desc>
10392	Supports being used as a format for differencing media (see <link
10393	to="IMedium::createDiffStorage"/>).
10394	</desc>
10395	</const>
10396
10397	<const name="Asynchronous" value="0x20">
10398	<desc>
10399	Supports asynchronous I/O operations for at least some configurations.
10400	</desc>
10401	</const>
10402
10403	<const name="File" value="0x40">
10404	<desc>
10405	The format backend operates on files (the <link to="IMedium::location"/>
10406	attribute of the medium specifies a file used to store medium
10407	data; for a list of supported file extensions see
10408	<link to="IMediumFormat::describeFileExtensions"/>).
10409	</desc>
10410	</const>
10411
10412	<const name="Properties" value="0x80">
10413	<desc>
10414	The format backend uses the property interface to configure the storage
10415	location and properties (the <link to="IMediumFormat::describeProperties"/>
10416	method is used to get access to properties supported by the given medium format).
10417	</desc>
10418	</const>
10419
10420	<const name="TcpNetworking" value="0x100">
10421	<desc>
10422	The format backend uses the TCP networking interface for network access.
10423	</desc>
10424	</const>
10425
10426	<const name="VFS" value="0x200">
10427	<desc>
10428	The format backend supports virtual filesystem functionality.
10429	</desc>
10430	</const>
10431
10432	<const name="CapabilityMask" value="0x3FF"/>
10433	</enum>
10434
10435	<interface
10436	name="IMediumFormat" extends="$unknown"
10437	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10438	wsmap="managed"
10439	>
10440	<desc>
10441	The IMediumFormat interface represents a medium format.
10442
10443	Each medium format has an associated backend which is used to handle
10444	media stored in this format. This interface provides information
10445	about the properties of the associated backend.
10446
10447	Each medium format is identified by a string represented by the
10448	<link to="#id"/> attribute. This string is used in calls like
10449	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10450	format.
10451
10452	The list of all supported medium formats can be obtained using
10453	<link to="ISystemProperties::mediumFormats"/>.
10454
10455	<see>IMedium</see>
10456	</desc>
10457
10458	<attribute name="id" type="wstring" readonly="yes">
10459	<desc>
10460	Identifier of this format.
10461
10462	The format identifier is a non-@c null non-empty ASCII string. Note that
10463	this string is case-insensitive. This means that, for example, all of
10464	the following strings:
10465	<pre>
10466	"VDI"
10467	"vdi"
10468	"VdI"</pre>
10469	refer to the same medium format.
10470
10471	This string is used in methods of other interfaces where it is necessary
10472	to specify a medium format, such as
10473	<link to="IVirtualBox::createHardDisk"/>.
10474	</desc>
10475	</attribute>
10476
10477	<attribute name="name" type="wstring" readonly="yes">
10478	<desc>
10479	Human readable description of this format.
10480
10481	Mainly for use in file open dialogs.
10482	</desc>
10483	</attribute>
10484
10485	<attribute name="capabilities" type="unsigned long" readonly="yes">
10486	<desc>
10487	Capabilities of the format as a set of bit flags.
10488
10489	For the meaning of individual capability flags see
10490	<link to="MediumFormatCapabilities"/>.
10491	</desc>
10492	</attribute>
10493
10494	<method name="describeFileExtensions">
10495	<desc>
10496	Returns two arrays describing the supported file extensions.
10497
10498	The first array contains the supported extensions and the seconds one
10499	the type each extension supports. Both have the same size.
10500
10501	Note that some backends do not work on files, so this array may be
10502	empty.
10503
10504	<see>IMediumFormat::capabilities</see>
10505	</desc>
10506	<param name="extensions" type="wstring" safearray="yes" dir="out">
10507	<desc>The array of supported extensions.</desc>
10508	</param>
10509	<param name="type" type="DeviceType" safearray="yes" dir="out">
10510	<desc>The array which indicates the device type for every given extension.</desc>
10511	</param>
10512	</method>
10513
10514	<method name="describeProperties">
10515	<desc>
10516	Returns several arrays describing the properties supported by this
10517	format.
10518
10519	An element with the given index in each array describes one
10520	property. Thus, the number of elements in each returned array is the
10521	same and corresponds to the number of supported properties.
10522
10523	The returned arrays are filled in only if the
10524	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10525	All arguments must be non-@c null.
10526
10527	<see>DataType</see>
10528	<see>DataFlags</see>
10529	</desc>
10530
10531	<param name="names" type="wstring" safearray="yes" dir="out">
10532	<desc>Array of property names.</desc>
10533	</param>
10534	<param name="description" type="wstring" safearray="yes" dir="out">
10535	<desc>Array of property descriptions.</desc>
10536	</param>
10537	<param name="types" type="DataType" safearray="yes" dir="out">
10538	<desc>Array of property types.</desc>
10539	</param>
10540	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10541	<desc>Array of property flags.</desc>
10542	</param>
10543	<param name="defaults" type="wstring" safearray="yes" dir="out">
10544	<desc>Array of default property values.</desc>
10545	</param>
10546	</method>
10547
10548	</interface>
10549
10550
10551	<!--
10552	// IKeyboard
10553	/////////////////////////////////////////////////////////////////////////
10554	-->
10555
10556	<interface
10557	name="IKeyboard" extends="$unknown"
10558	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10559	wsmap="managed"
10560	>
10561	<desc>
10562	The IKeyboard interface represents the virtual machine's keyboard. Used
10563	in <link to="IConsole::keyboard"/>.
10564
10565	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10566	to the virtual machine.
10567
10568	</desc>
10569	<method name="putScancode">
10570	<desc>Sends a scancode to the keyboard.
10571
10572	<result name="VBOX_E_IPRT_ERROR">
10573	Could not send scan code to virtual keyboard.
10574	</result>
10575
10576	</desc>
10577	<param name="scancode" type="long" dir="in"/>
10578	</method>
10579
10580	<method name="putScancodes">
10581	<desc>Sends an array of scancodes to the keyboard.
10582
10583	<result name="VBOX_E_IPRT_ERROR">
10584	Could not send all scan codes to virtual keyboard.
10585	</result>
10586
10587	</desc>
10588	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10589	<param name="codesStored" type="unsigned long" dir="return"/>
10590	</method>
10591
10592	<method name="putCAD">
10593	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10594	function is nothing special, it is just a convenience function
10595	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10596
10597	<result name="VBOX_E_IPRT_ERROR">
10598	Could not send all scan codes to virtual keyboard.
10599	</result>
10600
10601	</desc>
10602	</method>
10603
10604	<attribute name="eventSource" type="IEventSource" readonly="yes">
10605	<desc>
10606	Event source for keyboard events.
10607	</desc>
10608	</attribute>
10609
10610	</interface>
10611
10612
10613	<!--
10614	// IMouse
10615	/////////////////////////////////////////////////////////////////////////
10616	-->
10617
10618	<enum
10619	name="MouseButtonState"
10620	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10621	>
10622	<desc>
10623	Mouse button state.
10624	</desc>
10625
10626	<const name="LeftButton" value="0x01"/>
10627	<const name="RightButton" value="0x02"/>
10628	<const name="MiddleButton" value="0x04"/>
10629	<const name="WheelUp" value="0x08"/>
10630	<const name="WheelDown" value="0x10"/>
10631	<const name="XButton1" value="0x20"/>
10632	<const name="XButton2" value="0x40"/>
10633	<const name="MouseStateMask" value="0x7F"/>
10634	</enum>
10635
10636	<interface
10637	name="IMouse" extends="$unknown"
10638	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10639	wsmap="managed"
10640	>
10641	<desc>
10642	The IMouse interface represents the virtual machine's mouse. Used in
10643	<link to="IConsole::mouse"/>.
10644
10645	Through this interface, the virtual machine's virtual mouse can be
10646	controlled.
10647	</desc>
10648
10649	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10650	<desc>
10651	Whether the guest OS supports absolute mouse pointer positioning
10652	or not.
10653	<note>
10654	You can use the <link to="IMouseCapabilityChangedEvent"/>
10655	event to be instantly informed about changes of this attribute
10656	during virtual machine execution.
10657	</note>
10658	<see><link to="#putMouseEventAbsolute"/></see>
10659	</desc>
10660	</attribute>
10661
10662	<attribute name="relativeSupported" type="boolean" readonly="yes">
10663	<desc>
10664	Whether the guest OS supports relative mouse pointer positioning
10665	or not.
10666	<note>
10667	You can use the <link to="IMouseCapabilityChangedEvent"/>
10668	event to be instantly informed about changes of this attribute
10669	during virtual machine execution.
10670	</note>
10671	<see><link to="#putMouseEvent"/></see>
10672	</desc>
10673	</attribute>
10674
10675	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10676	<desc>
10677	Whether the guest OS can currently switch to drawing it's own mouse
10678	cursor on demand.
10679	<note>
10680	You can use the <link to="IMouseCapabilityChangedEvent"/>
10681	event to be instantly informed about changes of this attribute
10682	during virtual machine execution.
10683	</note>
10684	<see><link to="#putMouseEvent"/></see>
10685	</desc>
10686	</attribute>
10687
10688	<method name="putMouseEvent">
10689	<desc>
10690	Initiates a mouse event using relative pointer movements
10691	along x and y axis.
10692
10693	<result name="E_ACCESSDENIED">
10694	Console not powered up.
10695	</result>
10696	<result name="VBOX_E_IPRT_ERROR">
10697	Could not send mouse event to virtual mouse.
10698	</result>
10699
10700	</desc>
10701
10702	<param name="dx" type="long" dir="in">
10703	<desc>
10704	Amount of pixels the mouse should move to the right.
10705	Negative values move the mouse to the left.
10706	</desc>
10707	</param>
10708	<param name="dy" type="long" dir="in">
10709	<desc>
10710	Amount of pixels the mouse should move downwards.
10711	Negative values move the mouse upwards.
10712	</desc>
10713	</param>
10714	<param name="dz" type="long" dir="in">
10715	<desc>
10716	Amount of mouse wheel moves.
10717	Positive values describe clockwise wheel rotations,
10718	negative values describe counterclockwise rotations.
10719	</desc>
10720	</param>
10721	<param name="dw" type="long" dir="in">
10722	<desc>
10723	Amount of horizontal mouse wheel moves.
10724	Positive values describe a movement to the left,
10725	negative values describe a movement to the right.
10726	</desc>
10727	</param>
10728	<param name="buttonState" type="long" dir="in">
10729	<desc>
10730	The current state of mouse buttons. Every bit represents
10731	a mouse button as follows:
10732	<table>
10733	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10734	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10735	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10736	</table>
10737	A value of <tt>1</tt> means the corresponding button is pressed.
10738	otherwise it is released.
10739	</desc>
10740	</param>
10741	</method>
10742
10743	<method name="putMouseEventAbsolute">
10744	<desc>
10745	Positions the mouse pointer using absolute x and y coordinates.
10746	These coordinates are expressed in pixels and
10747	start from <tt>[1,1]</tt> which corresponds to the top left
10748	corner of the virtual display.
10749
10750	<result name="E_ACCESSDENIED">
10751	Console not powered up.
10752	</result>
10753	<result name="VBOX_E_IPRT_ERROR">
10754	Could not send mouse event to virtual mouse.
10755	</result>
10756
10757	<note>
10758	This method will have effect only if absolute mouse
10759	positioning is supported by the guest OS.
10760	</note>
10761
10762	<see><link to="#absoluteSupported"/></see>
10763	</desc>
10764
10765	<param name="x" type="long" dir="in">
10766	<desc>
10767	X coordinate of the pointer in pixels, starting from @c 1.
10768	</desc>
10769	</param>
10770	<param name="y" type="long" dir="in">
10771	<desc>
10772	Y coordinate of the pointer in pixels, starting from @c 1.
10773	</desc>
10774	</param>
10775	<param name="dz" type="long" dir="in">
10776	<desc>
10777	Amount of mouse wheel moves.
10778	Positive values describe clockwise wheel rotations,
10779	negative values describe counterclockwise rotations.
10780	</desc>
10781	</param>
10782	<param name="dw" type="long" dir="in">
10783	<desc>
10784	Amount of horizontal mouse wheel moves.
10785	Positive values describe a movement to the left,
10786	negative values describe a movement to the right.
10787	</desc>
10788	</param>
10789	<param name="buttonState" type="long" dir="in">
10790	<desc>
10791	The current state of mouse buttons. Every bit represents
10792	a mouse button as follows:
10793	<table>
10794	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10795	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10796	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10797	</table>
10798	A value of @c 1 means the corresponding button is pressed.
10799	otherwise it is released.
10800	</desc>
10801	</param>
10802	</method>
10803
10804	<attribute name="eventSource" type="IEventSource" readonly="yes">
10805	<desc>
10806	Event source for mouse events.
10807	</desc>
10808	</attribute>
10809
10810	</interface>
10811
10812	<!--
10813	// IDisplay
10814	/////////////////////////////////////////////////////////////////////////
10815	-->
10816
10817	<enum
10818	name="FramebufferPixelFormat"
10819	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10820	>
10821	<desc>
10822	Format of the video memory buffer. Constants represented by this enum can
10823	be used to test for particular values of <link
10824	to="IFramebuffer::pixelFormat"/>. See also <link
10825	to="IFramebuffer::requestResize"/>.
10826
10827	See also www.fourcc.org for more information about FOURCC pixel formats.
10828	</desc>
10829
10830	<const name="Opaque" value="0">
10831	<desc>
10832	Unknown buffer format (the user may not assume any particular format of
10833	the buffer).
10834	</desc>
10835	</const>
10836	<const name="FOURCC_RGB" value="0x32424752">
10837	<desc>
10838	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10839	bit layout).
10840	</desc>
10841	</const>
10842	</enum>
10843
10844	<interface
10845	name="IFramebuffer" extends="$unknown"
10846	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10847	wsmap="suppress"
10848	>
10849	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10850	<desc>Address of the start byte of the frame buffer.</desc>
10851	</attribute>
10852
10853	<attribute name="width" type="unsigned long" readonly="yes">
10854	<desc>Frame buffer width, in pixels.</desc>
10855	</attribute>
10856
10857	<attribute name="height" type="unsigned long" readonly="yes">
10858	<desc>Frame buffer height, in pixels.</desc>
10859	</attribute>
10860
10861	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10862	<desc>
10863	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10864	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10865	are: 8, 15, 16, 24 and 32.
10866	</desc>
10867	</attribute>
10868
10869	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10870	<desc>
10871	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10872	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10873	size of the scan line must be aligned to 32 bits.
10874	</desc>
10875	</attribute>
10876
10877	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10878	<desc>
10879	Frame buffer pixel format. It's either one of the values defined by <link
10880	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10881	<note>
10882	This attribute must never return <link
10883	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10884	<link to="#address"/> points to must be always known.
10885	</note>
10886	</desc>
10887	</attribute>
10888
10889	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10890	<desc>
10891	Defines whether this frame buffer uses the virtual video card's memory
10892	buffer (guest VRAM) directly or not. See <link
10893	to="IFramebuffer::requestResize"/> for more information.
10894	</desc>
10895	</attribute>
10896
10897	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10898	<desc>
10899	Hint from the frame buffer about how much of the standard
10900	screen height it wants to use for itself. This information is
10901	exposed to the guest through the VESA BIOS and VMMDev interface
10902	so that it can use it for determining its video mode table. It
10903	is not guaranteed that the guest respects the value.
10904	</desc>
10905	</attribute>
10906
10907	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10908	<desc>
10909	An alpha-blended overlay which is superposed over the frame buffer.
10910	The initial purpose is to allow the display of icons providing
10911	information about the VM state, including disk activity, in front
10912	ends which do not have other means of doing that. The overlay is
10913	designed to controlled exclusively by IDisplay. It has no locking
10914	of its own, and any changes made to it are not guaranteed to be
10915	visible until the affected portion of IFramebuffer is updated. The
10916	overlay can be created lazily the first time it is requested. This
10917	attribute can also return @c null to signal that the overlay is not
10918	implemented.
10919	</desc>
10920	</attribute>
10921
10922	<attribute name="winId" type="long long" readonly="yes">
10923	<desc>
10924	Platform-dependent identifier of the window where context of this
10925	frame buffer is drawn, or zero if there's no such window.
10926	</desc>
10927	</attribute>
10928
10929	<method name="lock">
10930	<desc>
10931	Locks the frame buffer.
10932	Gets called by the IDisplay object where this frame buffer is
10933	bound to.
10934	</desc>
10935	</method>
10936
10937	<method name="unlock">
10938	<desc>
10939	Unlocks the frame buffer.
10940	Gets called by the IDisplay object where this frame buffer is
10941	bound to.
10942	</desc>
10943	</method>
10944
10945	<method name="notifyUpdate">
10946	<desc>
10947	Informs about an update.
10948	Gets called by the display object where this buffer is
10949	registered.
10950	</desc>
10951	<param name="x" type="unsigned long" dir="in"/>
10952	<param name="y" type="unsigned long" dir="in"/>
10953	<param name="width" type="unsigned long" dir="in"/>
10954	<param name="height" type="unsigned long" dir="in"/>
10955	</method>
10956
10957	<method name="requestResize">
10958	<desc>
10959	Requests a size and pixel format change.
10960
10961	There are two modes of working with the video buffer of the virtual
10962	machine. The <i>indirect</i> mode implies that the IFramebuffer
10963	implementation allocates a memory buffer for the requested display mode
10964	and provides it to the virtual machine. In <i>direct</i> mode, the
10965	IFramebuffer implementation uses the memory buffer allocated and owned
10966	by the virtual machine. This buffer represents the video memory of the
10967	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10968	usually faster because the implementation gets a raw pointer to the
10969	guest VRAM buffer which it can directly use for visualizing the contents
10970	of the virtual display, as opposed to the indirect mode where the
10971	contents of guest VRAM are copied to the memory buffer provided by
10972	the implementation every time a display update occurs.
10973
10974	It is important to note that the direct mode is really fast only when
10975	the implementation uses the given guest VRAM buffer directly, for
10976	example, by blitting it to the window representing the virtual machine's
10977	display, which saves at least one copy operation comparing to the
10978	indirect mode. However, using the guest VRAM buffer directly is not
10979	always possible: the format and the color depth of this buffer may be
10980	not supported by the target window, or it may be unknown (opaque) as in
10981	case of text or non-linear multi-plane VGA video modes. In this case,
10982	the indirect mode (that is always available) should be used as a
10983	fallback: when the guest VRAM contents are copied to the
10984	implementation-provided memory buffer, color and format conversion is
10985	done automatically by the underlying code.
10986
10987	The @a pixelFormat parameter defines whether the direct mode is
10988	available or not. If @a pixelFormat is <link
10989	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10990	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10991	@a bytesPerLine parameters must be ignored and the implementation must use
10992	the indirect mode (where it provides its own buffer in one of the
10993	supported formats). In all other cases, @a pixelFormat together with
10994	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10995	buffer pointed to by the @a VRAM parameter and the implementation is
10996	free to choose which mode to use. To indicate that this frame buffer uses
10997	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10998	attribute must return @c true and <link to="#address"/> must
10999	return exactly the same address that is passed in the @a VRAM parameter
11000	of this method; otherwise it is assumed that the indirect strategy is
11001	chosen.
11002
11003	The @a width and @a height parameters represent the size of the
11004	requested display mode in both modes. In case of indirect mode, the
11005	provided memory buffer should be big enough to store data of the given
11006	display mode. In case of direct mode, it is guaranteed that the given
11007	@a VRAM buffer contains enough space to represent the display mode of the
11008	given size. Note that this frame buffer's <link to="#width"/> and <link
11009	to="#height"/> attributes must return exactly the same values as
11010	passed to this method after the resize is completed (see below).
11011
11012	The @a finished output parameter determines if the implementation has
11013	finished resizing the frame buffer or not. If, for some reason, the
11014	resize cannot be finished immediately during this call, @a finished
11015	must be set to @c false, and the implementation must call
11016	<link to="IDisplay::resizeCompleted"/> after it has returned from
11017	this method as soon as possible. If @a finished is @c false, the
11018	machine will not call any frame buffer methods until
11019	<link to="IDisplay::resizeCompleted"/> is called.
11020
11021	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11022	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11023	this frame buffer must return exactly the same values as specified in the
11024	parameters of this method, after the resize is completed. If the
11025	indirect mode is chosen, these attributes must return values describing
11026	the format of the implementation's own memory buffer <link
11027	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11028	value must always correlate with <link to="#pixelFormat"/>. Note that
11029	the <link to="#pixelFormat"/> attribute must never return <link
11030	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11031
11032	<note>
11033	This method is called by the IDisplay object under the
11034	<link to="#lock"/> provided by this IFramebuffer
11035	implementation. If this method returns @c false in @a finished, then
11036	this lock is not released until
11037	<link to="IDisplay::resizeCompleted"/> is called.
11038	</note>
11039	</desc>
11040	<param name="screenId" type="unsigned long" dir="in">
11041	<desc>
11042	Logical screen number. Must be used in the corresponding call to
11043	<link to="IDisplay::resizeCompleted"/> if this call is made.
11044	</desc>
11045	</param>
11046	<param name="pixelFormat" type="unsigned long" dir="in">
11047	<desc>
11048	Pixel format of the memory buffer pointed to by @a VRAM.
11049	See also <link to="FramebufferPixelFormat"/>.
11050	</desc>
11051	</param>
11052	<param name="VRAM" type="octet" mod="ptr" dir="in">
11053	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11054	</param>
11055	<param name="bitsPerPixel" type="unsigned long" dir="in">
11056	<desc>Color depth, bits per pixel.</desc>
11057	</param>
11058	<param name="bytesPerLine" type="unsigned long" dir="in">
11059	<desc>Size of one scan line, in bytes.</desc>
11060	</param>
11061	<param name="width" type="unsigned long" dir="in">
11062	<desc>Width of the guest display, in pixels.</desc>
11063	</param>
11064	<param name="height" type="unsigned long" dir="in">
11065	<desc>Height of the guest display, in pixels.</desc>
11066	</param>
11067	<param name="finished" type="boolean" dir="return">
11068	<desc>
11069	Can the VM start using the new frame buffer immediately
11070	after this method returns or it should wait for
11071	<link to="IDisplay::resizeCompleted"/>.
11072	</desc>
11073	</param>
11074	</method>
11075
11076	<method name="videoModeSupported">
11077	<desc>
11078	Returns whether the frame buffer implementation is willing to
11079	support a given video mode. In case it is not able to render
11080	the video mode (or for some reason not willing), it should
11081	return @c false. Usually this method is called when the guest
11082	asks the VMM device whether a given video mode is supported
11083	so the information returned is directly exposed to the guest.
11084	It is important that this method returns very quickly.
11085	</desc>
11086	<param name="width" type="unsigned long" dir="in"/>
11087	<param name="height" type="unsigned long" dir="in"/>
11088	<param name="bpp" type="unsigned long" dir="in"/>
11089	<param name="supported" type="boolean" dir="return"/>
11090	</method>
11091
11092	<method name="getVisibleRegion">
11093	<desc>
11094	Returns the visible region of this frame buffer.
11095
11096	If the @a rectangles parameter is @c null then the value of the
11097	@a count parameter is ignored and the number of elements necessary to
11098	describe the current visible region is returned in @a countCopied.
11099
11100	If @a rectangles is not @c null but @a count is less
11101	than the required number of elements to store region data, the method
11102	will report a failure. If @a count is equal or greater than the
11103	required number of elements, then the actual number of elements copied
11104	to the provided array will be returned in @a countCopied.
11105
11106	<note>
11107	The address of the provided array must be in the process space of
11108	this IFramebuffer object.
11109	</note>
11110	<note>
11111	Method not yet implemented.
11112	</note>
11113	</desc>
11114	<param name="rectangles" type="octet" mod="ptr" dir="in">
11115	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11116	</param>
11117	<param name="count" type="unsigned long" dir="in">
11118	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11119	</param>
11120	<param name="countCopied" type="unsigned long" dir="return">
11121	<desc>Number of elements copied to the @a rectangles array.</desc>
11122	</param>
11123	</method>
11124
11125	<method name="setVisibleRegion">
11126	<desc>
11127	Suggests a new visible region to this frame buffer. This region
11128	represents the area of the VM display which is a union of regions of
11129	all top-level windows of the guest operating system running inside the
11130	VM (if the Guest Additions for this system support this
11131	functionality). This information may be used by the frontends to
11132	implement the seamless desktop integration feature.
11133
11134	<note>
11135	The address of the provided array must be in the process space of
11136	this IFramebuffer object.
11137	</note>
11138	<note>
11139	The IFramebuffer implementation must make a copy of the provided
11140	array of rectangles.
11141	</note>
11142	<note>
11143	Method not yet implemented.
11144	</note>
11145	</desc>
11146	<param name="rectangles" type="octet" mod="ptr" dir="in">
11147	<desc>Pointer to the @c RTRECT array.</desc>
11148	</param>
11149	<param name="count" type="unsigned long" dir="in">
11150	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11151	</param>
11152	</method>
11153
11154	<method name="processVHWACommand">
11155	<desc>
11156	Posts a Video HW Acceleration Command to the frame buffer for processing.
11157	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11158	are posted from quest to the host to be processed by the host hardware.
11159
11160	<note>
11161	The address of the provided command must be in the process space of
11162	this IFramebuffer object.
11163	</note>
11164	</desc>
11165
11166	<param name="command" type="octet" mod="ptr" dir="in">
11167	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11168	</param>
11169	</method>
11170
11171	</interface>
11172
11173	<interface
11174	name="IFramebufferOverlay" extends="IFramebuffer"
11175	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11176	wsmap="suppress"
11177	>
11178	<desc>
11179	The IFramebufferOverlay interface represents an alpha blended overlay
11180	for displaying status icons above an IFramebuffer. It is always created
11181	not visible, so that it must be explicitly shown. It only covers a
11182	portion of the IFramebuffer, determined by its width, height and
11183	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11184	that order) format, and may be written to directly. Do re-read the
11185	width though, after setting it, as it may be adjusted (increased) to
11186	make it more suitable for the front end.
11187	</desc>
11188	<attribute name="x" type="unsigned long" readonly="yes">
11189	<desc>X position of the overlay, relative to the frame buffer.</desc>
11190	</attribute>
11191
11192	<attribute name="y" type="unsigned long" readonly="yes">
11193	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11194	</attribute>
11195
11196	<attribute name="visible" type="boolean" readonly="no">
11197	<desc>
11198	Whether the overlay is currently visible.
11199	</desc>
11200	</attribute>
11201
11202	<attribute name="alpha" type="unsigned long" readonly="no">
11203	<desc>
11204	The global alpha value for the overlay. This may or may not be
11205	supported by a given front end.
11206	</desc>
11207	</attribute>
11208
11209	<method name="move">
11210	<desc>
11211	Changes the overlay's position relative to the IFramebuffer.
11212	</desc>
11213	<param name="x" type="unsigned long" dir="in"/>
11214	<param name="y" type="unsigned long" dir="in"/>
11215	</method>
11216
11217	</interface>
11218
11219	<interface
11220	name="IDisplay" extends="$unknown"
11221	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11222	wsmap="managed"
11223	>
11224	<desc>
11225	The IDisplay interface represents the virtual machine's display.
11226
11227	The object implementing this interface is contained in each
11228	<link to="IConsole::display"/> attribute and represents the visual
11229	output of the virtual machine.
11230
11231	The virtual display supports pluggable output targets represented by the
11232	IFramebuffer interface. Examples of the output target are a window on
11233	the host computer or an RDP session's display on a remote computer.
11234	</desc>
11235	<method name="getScreenResolution">
11236	<desc>Queries display width, height and color depth for given screen.</desc>
11237	<param name="screenId" type="unsigned long" dir="in"/>
11238	<param name="width" type="unsigned long" dir="out"/>
11239	<param name="height" type="unsigned long" dir="out"/>
11240	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11241	</method>
11242
11243	<method name="setFramebuffer">
11244	<desc>
11245	Sets the framebuffer for given screen.
11246	</desc>
11247	<param name="screenId" type="unsigned long" dir="in"/>
11248	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11249	</method>
11250
11251	<method name="getFramebuffer">
11252	<desc>
11253	Queries the framebuffer for given screen.
11254	</desc>
11255	<param name="screenId" type="unsigned long" dir="in"/>
11256	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11257	<param name="xOrigin" type="long" dir="out"/>
11258	<param name="yOrigin" type="long" dir="out"/>
11259	</method>
11260
11261	<method name="setVideoModeHint">
11262	<desc>
11263	Asks VirtualBox to request the given video mode from
11264	the guest. This is just a hint and it cannot be guaranteed
11265	that the requested resolution will be used. Guest Additions
11266	are required for the request to be seen by guests. The caller
11267	should issue the request and wait for a resolution change and
11268	after a timeout retry.
11269
11270	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11271	parameters means that the corresponding values should be taken from the
11272	current video mode (i.e. left unchanged).
11273
11274	If the guest OS supports multi-monitor configuration then the @a display
11275	parameter specifies the number of the guest display to send the hint to:
11276	@c 0 is the primary display, @c 1 is the first secondary and
11277	so on. If the multi-monitor configuration is not supported, @a display
11278	must be @c 0.
11279
11280	<result name="E_INVALIDARG">
11281	The @a display is not associated with any monitor.
11282	</result>
11283
11284	</desc>
11285	<param name="width" type="unsigned long" dir="in"/>
11286	<param name="height" type="unsigned long" dir="in"/>
11287	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11288	<param name="display" type="unsigned long" dir="in"/>
11289	</method>
11290
11291	<method name="setSeamlessMode">
11292	<desc>
11293	Enables or disables seamless guest display rendering (seamless desktop
11294	integration) mode.
11295	<note>
11296	Calling this method has no effect if <link
11297	to="IGuest::supportsSeamless"/> returns @c false.
11298	</note>
11299	</desc>
11300	<param name="enabled" type="boolean" dir="in"/>
11301	</method>
11302
11303	<method name="takeScreenShot">
11304	<desc>
11305	Takes a screen shot of the requested size and copies it to the
11306	32-bpp buffer allocated by the caller and pointed to by @a address.
11307	A pixel consists of 4 bytes in order: B, G, R, 0.
11308
11309	<note>This API can be used only by the COM/XPCOM C++ API as it
11310	requires pointer support. Use <link to="#takeScreenShotToArray" />
11311	with other language bindings.
11312	</note>
11313
11314	<result name="E_NOTIMPL">
11315	Feature not implemented.
11316	</result>
11317	<result name="VBOX_E_IPRT_ERROR">
11318	Could not take a screenshot.
11319	</result>
11320
11321	</desc>
11322	<param name="screenId" type="unsigned long" dir="in"/>
11323	<param name="address" type="octet" mod="ptr" dir="in"/>
11324	<param name="width" type="unsigned long" dir="in"/>
11325	<param name="height" type="unsigned long" dir="in"/>
11326	</method>
11327
11328	<method name="takeScreenShotToArray">
11329	<desc>
11330	Takes a guest screen shot of the requested size and returns it as
11331	an array of bytes in uncompressed 32-bit RGBA format.
11332	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11333
11334	This API is slow, but could be the only option to get guest screenshot
11335	for scriptable languages not allowed to manipulate with addresses
11336	directly.
11337
11338	<result name="E_NOTIMPL">
11339	Feature not implemented.
11340	</result>
11341	<result name="VBOX_E_IPRT_ERROR">
11342	Could not take a screenshot.
11343	</result>
11344	</desc>
11345	<param name="screenId" type="unsigned long" dir="in">
11346	<desc>
11347	Monitor to take screenshot from.
11348	</desc>
11349	</param>
11350	<param name="width" type="unsigned long" dir="in">
11351	<desc>
11352	Desired image width.
11353	</desc>
11354	</param>
11355	<param name="height" type="unsigned long" dir="in">
11356	<desc>
11357	Desired image height.
11358	</desc>
11359	</param>
11360	<param name="screenData" type="octet" dir="return" safearray="yes">
11361	<desc>
11362	Array with resulting screen data.
11363	</desc>
11364	</param>
11365	</method>
11366
11367	<method name="takeScreenShotPNGToArray">
11368	<desc>
11369	Takes a guest screen shot of the requested size and returns it as
11370	PNG image in array.
11371
11372	<result name="E_NOTIMPL">
11373	Feature not implemented.
11374	</result>
11375	<result name="VBOX_E_IPRT_ERROR">
11376	Could not take a screenshot.
11377	</result>
11378	</desc>
11379	<param name="screenId" type="unsigned long" dir="in">
11380	<desc>
11381	Monitor to take the screenshot from.
11382	</desc>
11383	</param>
11384	<param name="width" type="unsigned long" dir="in">
11385	<desc>
11386	Desired image width.
11387	</desc>
11388	</param>
11389	<param name="height" type="unsigned long" dir="in">
11390	<desc>
11391	Desired image height.
11392	</desc>
11393	</param>
11394	<param name="screenData" type="octet" dir="return" safearray="yes">
11395	<desc>
11396	Array with resulting screen data.
11397	</desc>
11398	</param>
11399	</method>
11400
11401	<method name="drawToScreen">
11402	<desc>
11403	Draws a 32-bpp image of the specified size from the given buffer
11404	to the given point on the VM display.
11405
11406	<result name="E_NOTIMPL">
11407	Feature not implemented.
11408	</result>
11409	<result name="VBOX_E_IPRT_ERROR">
11410	Could not draw to screen.
11411	</result>
11412
11413	</desc>
11414	<param name="screenId" type="unsigned long" dir="in">
11415	<desc>
11416	Monitor to take the screenshot from.
11417	</desc>
11418	</param>
11419	<param name="address" type="octet" mod="ptr" dir="in">
11420	<desc>
11421	Address to store the screenshot to
11422	</desc>
11423	</param>
11424	<param name="x" type="unsigned long" dir="in">
11425	<desc>
11426	Relative to the screen top left corner.
11427	</desc>
11428	</param>
11429	<param name="y" type="unsigned long" dir="in">
11430	<desc>
11431	Relative to the screen top left corner.
11432	</desc>
11433	</param>
11434	<param name="width" type="unsigned long" dir="in">
11435	<desc>
11436	Desired image width.
11437	</desc>
11438	</param>
11439	<param name="height" type="unsigned long" dir="in">
11440	<desc>
11441	Desired image height.
11442	</desc>
11443	</param>
11444	</method>
11445
11446	<method name="invalidateAndUpdate">
11447	<desc>
11448	Does a full invalidation of the VM display and instructs the VM
11449	to update it.
11450
11451	<result name="VBOX_E_IPRT_ERROR">
11452	Could not invalidate and update screen.
11453	</result>
11454
11455	</desc>
11456	</method>
11457
11458	<method name="resizeCompleted">
11459	<desc>
11460	Signals that a framebuffer has completed the resize operation.
11461
11462	<result name="VBOX_E_NOT_SUPPORTED">
11463	Operation only valid for external frame buffers.
11464	</result>
11465
11466	</desc>
11467	<param name="screenId" type="unsigned long" dir="in"/>
11468	</method>
11469
11470	<method name="completeVHWACommand">
11471	<desc>
11472	Signals that the Video HW Acceleration command has completed.
11473	</desc>
11474
11475	<param name="command" type="octet" mod="ptr" dir="in">
11476	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11477	</param>
11478	</method>
11479
11480	</interface>
11481
11482	<!--
11483	// INetworkAdapter
11484	/////////////////////////////////////////////////////////////////////////
11485	-->
11486
11487	<enum
11488	name="NetworkAttachmentType"
11489	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11490	>
11491	<desc>
11492	Network attachment type.
11493	</desc>
11494
11495	<const name="Null" value="0">
11496	<desc>Null value, also means "not attached".</desc>
11497	</const>
11498	<const name="NAT" value="1"/>
11499	<const name="Bridged" value="2"/>
11500	<const name="Internal" value="3"/>
11501	<const name="HostOnly" value="4"/>
11502	<const name="VDE" value="5"/>
11503	</enum>
11504
11505	<enum
11506	name="NetworkAdapterType"
11507	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11508	>
11509	<desc>
11510	Network adapter type.
11511	</desc>
11512
11513	<const name="Null" value="0">
11514	<desc>Null value (never used by the API).</desc>
11515	</const>
11516	<const name="Am79C970A" value="1">
11517	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11518	</const>
11519	<const name="Am79C973" value="2">
11520	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11521	</const>
11522	<const name="I82540EM" value="3">
11523	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11524	</const>
11525	<const name="I82543GC" value="4">
11526	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11527	</const>
11528	<const name="I82545EM" value="5">
11529	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11530	</const>
11531	<const name="Virtio" value="6">
11532	<desc>Virtio network device.</desc>
11533	</const>
11534	</enum>
11535
11536	<interface
11537	name="INetworkAdapter" extends="$unknown"
11538	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11539	wsmap="managed"
11540	>
11541	<desc>
11542	Represents a virtual network adapter that is attached to a virtual machine.
11543	Each virtual machine has a fixed number of network adapter slots with one
11544	instance of this attached to each of them. Call
11545	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11546	is attached to a given slot in a given machine.
11547
11548	Each network adapter can be in one of five attachment modes, which are
11549	represented by the <link to="NetworkAttachmentType" /> enumeration;
11550	see the <link to="#attachmentType" /> attribute.
11551	</desc>
11552
11553	<attribute name="adapterType" type="NetworkAdapterType">
11554	<desc>
11555	Type of the virtual network adapter. Depending on this value,
11556	VirtualBox will provide a different virtual network hardware
11557	to the guest.
11558	</desc>
11559	</attribute>
11560
11561	<attribute name="slot" type="unsigned long" readonly="yes">
11562	<desc>
11563	Slot number this adapter is plugged into. Corresponds to
11564	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11565	to obtain this instance.
11566	</desc>
11567	</attribute>
11568
11569	<attribute name="enabled" type="boolean">
11570	<desc>
11571	Flag whether the network adapter is present in the
11572	guest system. If disabled, the virtual guest hardware will
11573	not contain this network adapter. Can only be changed when
11574	the VM is not running.
11575	</desc>
11576	</attribute>
11577
11578	<attribute name="MACAddress" type="wstring">
11579	<desc>
11580	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11581	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11582	</desc>
11583	</attribute>
11584
11585	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11586
11587	<attribute name="hostInterface" type="wstring">
11588	<desc>
11589	Name of the host network interface the VM is attached to.
11590	</desc>
11591	</attribute>
11592
11593	<attribute name="internalNetwork" type="wstring">
11594	<desc>
11595	Name of the internal network the VM is attached to.
11596	</desc>
11597	</attribute>
11598
11599	<attribute name="NATNetwork" type="wstring">
11600	<desc>
11601	Name of the NAT network the VM is attached to.
11602	</desc>
11603	</attribute>
11604
11605	<attribute name="VDENetwork" type="wstring">
11606	<desc>
11607	Name of the VDE switch the VM is attached to.
11608	</desc>
11609	</attribute>
11610
11611	<attribute name="cableConnected" type="boolean">
11612	<desc>
11613	Flag whether the adapter reports the cable as connected or not.
11614	It can be used to report offline situations to a VM.
11615	</desc>
11616	</attribute>
11617
11618	<attribute name="lineSpeed" type="unsigned long">
11619	<desc>
11620	Line speed reported by custom drivers, in units of 1 kbps.
11621	</desc>
11622	</attribute>
11623
11624	<attribute name="traceEnabled" type="boolean">
11625	<desc>
11626	Flag whether network traffic from/to the network card should be traced.
11627	Can only be toggled when the VM is turned off.
11628	</desc>
11629	</attribute>
11630
11631	<attribute name="traceFile" type="wstring">
11632	<desc>
11633	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11634	will be used.
11635	</desc>
11636	</attribute>
11637
11638	<attribute name="natDriver" type="INATEngine" readonly="yes">
11639	<desc>
11640	Points to the NAT engine which handles the network address translation
11641	for this interface. This is active only when the interface actually uses
11642	NAT (see <link to="#attachToNAT" />).
11643	</desc>
11644	</attribute>
11645
11646	<attribute name="bootPriority" type="unsigned long">
11647	<desc>
11648	Network boot priority of the adapter. Priority 1 is highest. If not set,
11649	the priority is considered to be at the lowest possible setting.
11650	</desc>
11651	</attribute>
11652
11653	<attribute name="bandwidthLimit" type="unsigned long">
11654	<desc>
11655	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11656	A zero value means uncapped/unlimited.
11657	</desc>
11658	</attribute>
11659
11660	<method name="attachToNAT">
11661	<desc>
11662	Attach the network adapter to the Network Address Translation (NAT) interface.
11663	</desc>
11664	</method>
11665
11666	<method name="attachToBridgedInterface">
11667	<desc>
11668	Attach the network adapter to a bridged host interface.
11669	</desc>
11670	</method>
11671
11672	<method name="attachToInternalNetwork">
11673	<desc>
11674	Attach the network adapter to an internal network.
11675	</desc>
11676	</method>
11677
11678	<method name="attachToHostOnlyInterface">
11679	<desc>
11680	Attach the network adapter to the host-only network.
11681	</desc>
11682	</method>
11683
11684	<method name="attachToVDE">
11685	<desc>
11686	Attach the network adapter to a VDE network.
11687	</desc>
11688	</method>
11689
11690	<method name="detach">
11691	<desc>
11692	Detach the network adapter
11693	</desc>
11694	</method>
11695	</interface>
11696
11697
11698	<!--
11699	// ISerialPort
11700	/////////////////////////////////////////////////////////////////////////
11701	-->
11702
11703	<enum
11704	name="PortMode"
11705	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11706	>
11707	<desc>
11708	The PortMode enumeration represents possible communication modes for
11709	the virtual serial port device.
11710	</desc>
11711
11712	<const name="Disconnected" value="0">
11713	<desc>Virtual device is not attached to any real host device.</desc>
11714	</const>
11715	<const name="HostPipe" value="1">
11716	<desc>Virtual device is attached to a host pipe.</desc>
11717	</const>
11718	<const name="HostDevice" value="2">
11719	<desc>Virtual device is attached to a host device.</desc>
11720	</const>
11721	<const name="RawFile" value="3">
11722	<desc>Virtual device is attached to a raw file.</desc>
11723	</const>
11724	</enum>
11725
11726	<interface
11727	name="ISerialPort" extends="$unknown"
11728	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11729	wsmap="managed"
11730	>
11731
11732	<desc>
11733	The ISerialPort interface represents the virtual serial port device.
11734
11735	The virtual serial port device acts like an ordinary serial port
11736	inside the virtual machine. This device communicates to the real
11737	serial port hardware in one of two modes: host pipe or host device.
11738
11739	In host pipe mode, the #path attribute specifies the path to the pipe on
11740	the host computer that represents a serial port. The #server attribute
11741	determines if this pipe is created by the virtual machine process at
11742	machine startup or it must already exist before starting machine
11743	execution.
11744
11745	In host device mode, the #path attribute specifies the name of the
11746	serial port device on the host computer.
11747
11748	There is also a third communication mode: the disconnected mode. In this
11749	mode, the guest OS running inside the virtual machine will be able to
11750	detect the serial port, but all port write operations will be discarded
11751	and all port read operations will return no data.
11752
11753	<see>IMachine::getSerialPort</see>
11754	</desc>
11755
11756	<attribute name="slot" type="unsigned long" readonly="yes">
11757	<desc>
11758	Slot number this serial port is plugged into. Corresponds to
11759	the value you pass to <link to="IMachine::getSerialPort"/>
11760	to obtain this instance.
11761	</desc>
11762	</attribute>
11763
11764	<attribute name="enabled" type="boolean">
11765	<desc>
11766	Flag whether the serial port is enabled. If disabled,
11767	the serial port will not be reported to the guest OS.
11768	</desc>
11769	</attribute>
11770
11771	<attribute name="IOBase" type="unsigned long">
11772	<desc>Base I/O address of the serial port.</desc>
11773	</attribute>
11774
11775	<attribute name="IRQ" type="unsigned long">
11776	<desc>IRQ number of the serial port.</desc>
11777	</attribute>
11778
11779	<attribute name="hostMode" type="PortMode">
11780	<desc>
11781	How is this port connected to the host.
11782	<note>
11783	Changing this attribute may fail if the conditions for
11784	<link to="#path"/> are not met.
11785	</note>
11786	</desc>
11787	</attribute>
11788
11789	<attribute name="server" type="boolean">
11790	<desc>
11791	Flag whether this serial port acts as a server (creates a new pipe on
11792	the host) or as a client (uses the existing pipe). This attribute is
11793	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11794	</desc>
11795	</attribute>
11796
11797	<attribute name="path" type="wstring">
11798	<desc>
11799	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11800	PortMode_HostPipe, or the host serial device name when
11801	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11802	cases, setting a @c null or empty string as the attribute's value
11803	is an error. Otherwise, the value of this property is ignored.
11804	</desc>
11805	</attribute>
11806
11807	</interface>
11808
11809	<!--
11810	// IParallelPort
11811	/////////////////////////////////////////////////////////////////////////
11812	-->
11813
11814	<interface
11815	name="IParallelPort" extends="$unknown"
11816	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11817	wsmap="managed"
11818	>
11819
11820	<desc>
11821	The IParallelPort interface represents the virtual parallel port device.
11822
11823	The virtual parallel port device acts like an ordinary parallel port
11824	inside the virtual machine. This device communicates to the real
11825	parallel port hardware using the name of the parallel device on the host
11826	computer specified in the #path attribute.
11827
11828	Each virtual parallel port device is assigned a base I/O address and an
11829	IRQ number that will be reported to the guest operating system and used
11830	to operate the given parallel port from within the virtual machine.
11831
11832	<see>IMachine::getParallelPort</see>
11833	</desc>
11834
11835	<attribute name="slot" type="unsigned long" readonly="yes">
11836	<desc>
11837	Slot number this parallel port is plugged into. Corresponds to
11838	the value you pass to <link to="IMachine::getParallelPort"/>
11839	to obtain this instance.
11840	</desc>
11841	</attribute>
11842
11843	<attribute name="enabled" type="boolean">
11844	<desc>
11845	Flag whether the parallel port is enabled. If disabled,
11846	the parallel port will not be reported to the guest OS.
11847	</desc>
11848	</attribute>
11849
11850	<attribute name="IOBase" type="unsigned long">
11851	<desc>Base I/O address of the parallel port.</desc>
11852	</attribute>
11853
11854	<attribute name="IRQ" type="unsigned long">
11855	<desc>IRQ number of the parallel port.</desc>
11856	</attribute>
11857
11858	<attribute name="path" type="wstring">
11859	<desc>
11860	Host parallel device name. If this parallel port is enabled, setting a
11861	@c null or an empty string as this attribute's value will result into
11862	an error.
11863	</desc>
11864	</attribute>
11865
11866	</interface>
11867
11868
11869	<!--
11870	// IMachineDebugger
11871	/////////////////////////////////////////////////////////////////////////
11872	-->
11873
11874	<interface
11875	name="IMachineDebugger" extends="$unknown"
11876	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11877	wsmap="suppress"
11878	>
11879	<method name="resetStats">
11880	<desc>
11881	Reset VM statistics.
11882	</desc>
11883	<param name="pattern" type="wstring" dir="in">
11884	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11885	</param>
11886	</method>
11887
11888	<method name="dumpStats">
11889	<desc>
11890	Dumps VM statistics.
11891	</desc>
11892	<param name="pattern" type="wstring" dir="in">
11893	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11894	</param>
11895	</method>
11896
11897	<method name="getStats">
11898	<desc>
11899	Get the VM statistics in a XMLish format.
11900	</desc>
11901	<param name="pattern" type="wstring" dir="in">
11902	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11903	</param>
11904	<param name="withDescriptions" type="boolean" dir="in">
11905	<desc>Whether to include the descriptions.</desc>
11906	</param>
11907	<param name="stats" type="wstring" dir="out">
11908	<desc>The XML document containing the statistics.</desc>
11909	</param>
11910	</method>
11911
11912	<method name="injectNMI">
11913	<desc>
11914	Inject an NMI into a running VT-x/AMD-V VM.
11915	</desc>
11916	</method>
11917
11918	<attribute name="singlestep" type="boolean">
11919	<desc>Switch for enabling singlestepping.</desc>
11920	</attribute>
11921
11922	<attribute name="recompileUser" type="boolean">
11923	<desc>Switch for forcing code recompilation for user mode code.</desc>
11924	</attribute>
11925
11926	<attribute name="recompileSupervisor" type="boolean">
11927	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11928	</attribute>
11929
11930	<attribute name="PATMEnabled" type="boolean">
11931	<desc>Switch for enabling and disabling the PATM component.</desc>
11932	</attribute>
11933
11934	<attribute name="CSAMEnabled" type="boolean">
11935	<desc>Switch for enabling and disabling the CSAM component.</desc>
11936	</attribute>
11937
11938	<attribute name="logEnabled" type="boolean">
11939	<desc>Switch for enabling and disabling logging.</desc>
11940	</attribute>
11941
11942	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11943	<desc>
11944	Flag indicating whether the VM is currently making use of CPU hardware
11945	virtualization extensions.
11946	</desc>
11947	</attribute>
11948
11949	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11950	<desc>
11951	Flag indicating whether the VM is currently making use of the nested paging
11952	CPU hardware virtualization extension.
11953	</desc>
11954	</attribute>
11955
11956	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11957	<desc>
11958	Flag indicating whether the VM is currently making use of the VPID
11959	VT-x extension.
11960	</desc>
11961	</attribute>
11962
11963	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11964	<desc>
11965	Flag indicating whether the VM is currently making use of the Physical
11966	Address Extension CPU feature.
11967	</desc>
11968	</attribute>
11969
11970	<attribute name="virtualTimeRate" type="unsigned long">
11971	<desc>
11972	The rate at which the virtual time runs expressed as a percentage.
11973	The accepted range is 2% to 20000%.
11974	</desc>
11975	</attribute>
11976
11977	<!-- @todo method for setting log flags, groups and destination! -->
11978
11979	<attribute name="VM" type="long long" readonly="yes">
11980	<desc>
11981	Gets the VM handle. This is only for internal use while
11982	we carve the details of this interface.
11983	</desc>
11984	</attribute>
11985
11986	</interface>
11987
11988	<!--
11989	// IUSBController
11990	/////////////////////////////////////////////////////////////////////////
11991	-->
11992
11993	<interface
11994	name="IUSBController" extends="$unknown"
11995	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11996	wsmap="managed"
11997	>
11998	<attribute name="enabled" type="boolean">
11999	<desc>
12000	Flag whether the USB controller is present in the
12001	guest system. If disabled, the virtual guest hardware will
12002	not contain any USB controller. Can only be changed when
12003	the VM is powered off.
12004	</desc>
12005	</attribute>
12006
12007	<attribute name="enabledEhci" type="boolean">
12008	<desc>
12009	Flag whether the USB EHCI controller is present in the
12010	guest system. If disabled, the virtual guest hardware will
12011	not contain a USB EHCI controller. Can only be changed when
12012	the VM is powered off.
12013	</desc>
12014	</attribute>
12015
12016	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12017	<desc>
12018	Flag whether there is an USB proxy available.
12019	</desc>
12020	</attribute>
12021
12022	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12023	<desc>
12024	USB standard version which the controller implements.
12025	This is a BCD which means that the major version is in the
12026	high byte and minor version is in the low byte.
12027	</desc>
12028	</attribute>
12029
12030	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12031	<desc>
12032	List of USB device filters associated with the machine.
12033
12034	If the machine is currently running, these filters are activated
12035	every time a new (supported) USB device is attached to the host
12036	computer that was not ignored by global filters
12037	(<link to="IHost::USBDeviceFilters"/>).
12038
12039	These filters are also activated when the machine is powered up.
12040	They are run against a list of all currently available USB
12041	devices (in states
12042	<link to="USBDeviceState_Available"/>,
12043	<link to="USBDeviceState_Busy"/>,
12044	<link to="USBDeviceState_Held"/>) that were not previously
12045	ignored by global filters.
12046
12047	If at least one filter matches the USB device in question, this
12048	device is automatically captured (attached to) the virtual USB
12049	controller of this machine.
12050
12051	<see>IUSBDeviceFilter, ::IUSBController</see>
12052	</desc>
12053	</attribute>
12054
12055	<method name="createDeviceFilter">
12056	<desc>
12057	Creates a new USB device filter. All attributes except
12058	the filter name are set to empty (any match),
12059	<i>active</i> is @c false (the filter is not active).
12060
12061	The created filter can then be added to the list of filters using
12062	<link to="#insertDeviceFilter"/>.
12063
12064	<result name="VBOX_E_INVALID_VM_STATE">
12065	The virtual machine is not mutable.
12066	</result>
12067
12068	<see>#deviceFilters</see>
12069	</desc>
12070	<param name="name" type="wstring" dir="in">
12071	<desc>
12072	Filter name. See <link to="IUSBDeviceFilter::name"/>
12073	for more info.
12074	</desc>
12075	</param>
12076	<param name="filter" type="IUSBDeviceFilter" dir="return">
12077	<desc>Created filter object.</desc>
12078	</param>
12079	</method>
12080
12081	<method name="insertDeviceFilter">
12082	<desc>
12083	Inserts the given USB device to the specified position
12084	in the list of filters.
12085
12086	Positions are numbered starting from <tt>0</tt>. If the specified
12087	position is equal to or greater than the number of elements in
12088	the list, the filter is added to the end of the collection.
12089
12090	<note>
12091	Duplicates are not allowed, so an attempt to insert a
12092	filter that is already in the collection, will return an
12093	error.
12094	</note>
12095
12096	<result name="VBOX_E_INVALID_VM_STATE">
12097	Virtual machine is not mutable.
12098	</result>
12099	<result name="E_INVALIDARG">
12100	USB device filter not created within this VirtualBox instance.
12101	</result>
12102	<result name="VBOX_E_INVALID_OBJECT_STATE">
12103	USB device filter already in list.
12104	</result>
12105
12106	<see>#deviceFilters</see>
12107	</desc>
12108	<param name="position" type="unsigned long" dir="in">
12109	<desc>Position to insert the filter to.</desc>
12110	</param>
12111	<param name="filter" type="IUSBDeviceFilter" dir="in">
12112	<desc>USB device filter to insert.</desc>
12113	</param>
12114	</method>
12115
12116	<method name="removeDeviceFilter">
12117	<desc>
12118	Removes a USB device filter from the specified position in the
12119	list of filters.
12120
12121	Positions are numbered starting from <tt>0</tt>. Specifying a
12122	position equal to or greater than the number of elements in
12123	the list will produce an error.
12124
12125	<see>#deviceFilters</see>
12126
12127	<result name="VBOX_E_INVALID_VM_STATE">
12128	Virtual machine is not mutable.
12129	</result>
12130	<result name="E_INVALIDARG">
12131	USB device filter list empty or invalid @a position.
12132	</result>
12133
12134	</desc>
12135	<param name="position" type="unsigned long" dir="in">
12136	<desc>Position to remove the filter from.</desc>
12137	</param>
12138	<param name="filter" type="IUSBDeviceFilter" dir="return">
12139	<desc>Removed USB device filter.</desc>
12140	</param>
12141	</method>
12142
12143	</interface>
12144
12145
12146	<!--
12147	// IUSBDevice
12148	/////////////////////////////////////////////////////////////////////////
12149	-->
12150
12151	<interface
12152	name="IUSBDevice" extends="$unknown"
12153	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12154	wsmap="managed"
12155	>
12156	<desc>
12157	The IUSBDevice interface represents a virtual USB device attached to the
12158	virtual machine.
12159
12160	A collection of objects implementing this interface is stored in the
12161	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12162	attached to a running virtual machine's USB controller.
12163	</desc>
12164
12165	<attribute name="id" type="uuid" mod="string" readonly="yes">
12166	<desc>
12167	Unique USB device ID. This ID is built from #vendorId,
12168	#productId, #revision and #serialNumber.
12169	</desc>
12170	</attribute>
12171
12172	<attribute name="vendorId" type="unsigned short" readonly="yes">
12173	<desc>Vendor ID.</desc>
12174	</attribute>
12175
12176	<attribute name="productId" type="unsigned short" readonly="yes">
12177	<desc>Product ID.</desc>
12178	</attribute>
12179
12180	<attribute name="revision" type="unsigned short" readonly="yes">
12181	<desc>
12182	Product revision number. This is a packed BCD represented as
12183	unsigned short. The high byte is the integer part and the low
12184	byte is the decimal.
12185	</desc>
12186	</attribute>
12187
12188	<attribute name="manufacturer" type="wstring" readonly="yes">
12189	<desc>Manufacturer string.</desc>
12190	</attribute>
12191
12192	<attribute name="product" type="wstring" readonly="yes">
12193	<desc>Product string.</desc>
12194	</attribute>
12195
12196	<attribute name="serialNumber" type="wstring" readonly="yes">
12197	<desc>Serial number string.</desc>
12198	</attribute>
12199
12200	<attribute name="address" type="wstring" readonly="yes">
12201	<desc>Host specific address of the device.</desc>
12202	</attribute>
12203
12204	<attribute name="port" type="unsigned short" readonly="yes">
12205	<desc>
12206	Host USB port number the device is physically
12207	connected to.
12208	</desc>
12209	</attribute>
12210
12211	<attribute name="version" type="unsigned short" readonly="yes">
12212	<desc>
12213	The major USB version of the device - 1 or 2.
12214	</desc>
12215	</attribute>
12216
12217	<attribute name="portVersion" type="unsigned short" readonly="yes">
12218	<desc>
12219	The major USB version of the host USB port the device is
12220	physically connected to - 1 or 2. For devices not connected to
12221	anything this will have the same value as the version attribute.
12222	</desc>
12223	</attribute>
12224
12225	<attribute name="remote" type="boolean" readonly="yes">
12226	<desc>
12227	Whether the device is physically connected to a remote VRDE
12228	client or to a local host machine.
12229	</desc>
12230	</attribute>
12231
12232	</interface>
12233
12234
12235	<!--
12236	// IUSBDeviceFilter
12237	/////////////////////////////////////////////////////////////////////////
12238	-->
12239
12240	<interface
12241	name="IUSBDeviceFilter" extends="$unknown"
12242	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12243	wsmap="managed"
12244	>
12245	<desc>
12246	The IUSBDeviceFilter interface represents an USB device filter used
12247	to perform actions on a group of USB devices.
12248
12249	This type of filters is used by running virtual machines to
12250	automatically capture selected USB devices once they are physically
12251	attached to the host computer.
12252
12253	A USB device is matched to the given device filter if and only if all
12254	attributes of the device match the corresponding attributes of the
12255	filter (that is, attributes are joined together using the logical AND
12256	operation). On the other hand, all together, filters in the list of
12257	filters carry the semantics of the logical OR operation. So if it is
12258	desirable to create a match like "this vendor id OR this product id",
12259	one needs to create two filters and specify "any match" (see below)
12260	for unused attributes.
12261
12262	All filter attributes used for matching are strings. Each string
12263	is an expression representing a set of values of the corresponding
12264	device attribute, that will match the given filter. Currently, the
12265	following filtering expressions are supported:
12266
12267	<ul>
12268	<li><i>Interval filters</i>. Used to specify valid intervals for
12269	integer device attributes (Vendor ID, Product ID and Revision).
12270	The format of the string is:
12271
12272	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12273
12274	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12275	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12276	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12277	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12278	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12279	possible integer is assumed.
12280	</li>
12281	<li><i>Boolean filters</i>. Used to specify acceptable values for
12282	boolean device attributes. The format of the string is:
12283
12284	<tt>true\|false\|yes\|no\|0\|1</tt>
12285
12286	</li>
12287	<li><i>Exact match</i>. Used to specify a single value for the given
12288	device attribute. Any string that doesn't start with <tt>int:</tt>
12289	represents the exact match. String device attributes are compared to
12290	this string including case of symbols. Integer attributes are first
12291	converted to a string (see individual filter attributes) and then
12292	compared ignoring case.
12293
12294	</li>
12295	<li><i>Any match</i>. Any value of the corresponding device attribute
12296	will match the given filter. An empty or @c null string is
12297	used to construct this type of filtering expressions.
12298
12299	</li>
12300	</ul>
12301
12302	<note>
12303	On the Windows host platform, interval filters are not currently
12304	available. Also all string filter attributes
12305	(<link to="#manufacturer"/>, <link to="#product"/>,
12306	<link to="#serialNumber"/>) are ignored, so they behave as
12307	<i>any match</i> no matter what string expression is specified.
12308	</note>
12309
12310	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12311	</desc>
12312
12313	<attribute name="name" type="wstring">
12314	<desc>
12315	Visible name for this filter.
12316	This name is used to visually distinguish one filter from another,
12317	so it can neither be @c null nor an empty string.
12318	</desc>
12319	</attribute>
12320
12321	<attribute name="active" type="boolean">
12322	<desc>Whether this filter active or has been temporarily disabled.</desc>
12323	</attribute>
12324
12325	<attribute name="vendorId" type="wstring">
12326	<desc>
12327	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12328	The string representation for the <i>exact matching</i>
12329	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12330	(including leading zeroes).
12331	</desc>
12332	</attribute>
12333
12334	<attribute name="productId" type="wstring">
12335	<desc>
12336	<link to="IUSBDevice::productId">Product ID</link> filter.
12337	The string representation for the <i>exact matching</i>
12338	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12339	(including leading zeroes).
12340	</desc>
12341	</attribute>
12342
12343	<attribute name="revision" type="wstring">
12344	<desc>
12345	<link to="IUSBDevice::productId">Product revision number</link>
12346	filter. The string representation for the <i>exact matching</i>
12347	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12348	of the integer part of the revision, and <tt>F</tt> is the
12349	decimal digit of its fractional part (including leading and
12350	trailing zeros).
12351	Note that for interval filters, it's best to use the hexadecimal
12352	form, because the revision is stored as a 16 bit packed BCD value;
12353	so the expression <tt>int:0x0100-0x0199</tt> will match any
12354	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12355	</desc>
12356	</attribute>
12357
12358	<attribute name="manufacturer" type="wstring">
12359	<desc>
12360	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12361	</desc>
12362	</attribute>
12363
12364	<attribute name="product" type="wstring">
12365	<desc>
12366	<link to="IUSBDevice::product">Product</link> filter.
12367	</desc>
12368	</attribute>
12369
12370	<attribute name="serialNumber" type="wstring">
12371	<desc>
12372	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12373	</desc>
12374	</attribute>
12375
12376	<attribute name="port" type="wstring">
12377	<desc>
12378	<link to="IUSBDevice::port">Host USB port</link> filter.
12379	</desc>
12380	</attribute>
12381
12382	<attribute name="remote" type="wstring">
12383	<desc>
12384	<link to="IUSBDevice::remote">Remote state</link> filter.
12385	<note>
12386	This filter makes sense only for machine USB filters,
12387	i.e. it is ignored by IHostUSBDeviceFilter objects.
12388	</note>
12389	</desc>
12390	</attribute>
12391
12392	<attribute name="maskedInterfaces" type="unsigned long">
12393	<desc>
12394	This is an advanced option for hiding one or more USB interfaces
12395	from the guest. The value is a bit mask where the bits that are set
12396	means the corresponding USB interface should be hidden, masked off
12397	if you like.
12398	This feature only works on Linux hosts.
12399	</desc>
12400	</attribute>
12401
12402	</interface>
12403
12404
12405	<!--
12406	// IHostUSBDevice
12407	/////////////////////////////////////////////////////////////////////////
12408	-->
12409
12410	<enum
12411	name="USBDeviceState"
12412	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12413	>
12414	<desc>
12415	USB device state. This enumeration represents all possible states
12416	of the USB device physically attached to the host computer regarding
12417	its state on the host computer and availability to guest computers
12418	(all currently running virtual machines).
12419
12420	Once a supported USB device is attached to the host, global USB
12421	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12422	either ignore the device, or put it to USBDeviceState_Held state, or do
12423	nothing. Unless the device is ignored by global filters, filters of all
12424	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12425	activated that can put it to USBDeviceState_Captured state.
12426
12427	If the device was ignored by global filters, or didn't match
12428	any filters at all (including guest ones), it is handled by the host
12429	in a normal way. In this case, the device state is determined by
12430	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12431	or USBDeviceState_Available, depending on the current device usage.
12432
12433	Besides auto-capturing based on filters, the device can be manually
12434	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12435	state is USBDeviceState_Busy, USBDeviceState_Available or
12436	USBDeviceState_Held.
12437
12438	<note>
12439	Due to differences in USB stack implementations in Linux and Win32,
12440	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12441	only to the Linux version of the product. This also means that (<link
12442	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12443	device state is USBDeviceState_Held.
12444	</note>
12445
12446	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12447	</desc>
12448
12449	<const name="NotSupported" value="0">
12450	<desc>
12451	Not supported by the VirtualBox server, not available to guests.
12452	</desc>
12453	</const>
12454	<const name="Unavailable" value="1">
12455	<desc>
12456	Being used by the host computer exclusively,
12457	not available to guests.
12458	</desc>
12459	</const>
12460	<const name="Busy" value="2">
12461	<desc>
12462	Being used by the host computer, potentially available to guests.
12463	</desc>
12464	</const>
12465	<const name="Available" value="3">
12466	<desc>
12467	Not used by the host computer, available to guests (the host computer
12468	can also start using the device at any time).
12469	</desc>
12470	</const>
12471	<const name="Held" value="4">
12472	<desc>
12473	Held by the VirtualBox server (ignored by the host computer),
12474	available to guests.
12475	</desc>
12476	</const>
12477	<const name="Captured" value="5">
12478	<desc>
12479	Captured by one of the guest computers, not available
12480	to anybody else.
12481	</desc>
12482	</const>
12483	</enum>
12484
12485	<interface
12486	name="IHostUSBDevice" extends="IUSBDevice"
12487	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12488	wsmap="managed"
12489	>
12490	<desc>
12491	The IHostUSBDevice interface represents a physical USB device attached
12492	to the host computer.
12493
12494	Besides properties inherited from IUSBDevice, this interface adds the
12495	<link to="#state"/> property that holds the current state of the USB
12496	device.
12497
12498	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12499	</desc>
12500
12501	<attribute name="state" type="USBDeviceState" readonly="yes">
12502	<desc>
12503	Current state of the device.
12504	</desc>
12505	</attribute>
12506
12507	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12508
12509	</interface>
12510
12511
12512	<!--
12513	// IHostUSBDeviceFilter
12514	/////////////////////////////////////////////////////////////////////////
12515	-->
12516
12517	<enum
12518	name="USBDeviceFilterAction"
12519	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12520	>
12521	<desc>
12522	Actions for host USB device filters.
12523	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12524	</desc>
12525
12526	<const name="Null" value="0">
12527	<desc>Null value (never used by the API).</desc>
12528	</const>
12529	<const name="Ignore" value="1">
12530	<desc>Ignore the matched USB device.</desc>
12531	</const>
12532	<const name="Hold" value="2">
12533	<desc>Hold the matched USB device.</desc>
12534	</const>
12535	</enum>
12536
12537	<interface
12538	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12539	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12540	wsmap="managed"
12541	>
12542	<desc>
12543	The IHostUSBDeviceFilter interface represents a global filter for a
12544	physical USB device used by the host computer. Used indirectly in
12545	<link to="IHost::USBDeviceFilters"/>.
12546
12547	Using filters of this type, the host computer determines the initial
12548	state of the USB device after it is physically attached to the
12549	host's USB controller.
12550
12551	<note>
12552	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12553	filters, because it makes sense only for
12554	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12555	</note>
12556
12557	<see>IHost::USBDeviceFilters</see>
12558	</desc>
12559
12560	<attribute name="action" type="USBDeviceFilterAction">
12561	<desc>
12562	Action performed by the host when an attached USB device
12563	matches this filter.
12564	</desc>
12565	</attribute>
12566
12567	</interface>
12568
12569	<!--
12570	// IAudioAdapter
12571	/////////////////////////////////////////////////////////////////////////
12572	-->
12573
12574	<enum
12575	name="AudioDriverType"
12576	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12577	>
12578	<desc>
12579	Host audio driver type.
12580	</desc>
12581
12582	<const name="Null" value="0">
12583	<desc>Null value, also means "dummy audio driver".</desc>
12584	</const>
12585	<const name="WinMM" value="1">
12586	<desc>Windows multimedia (Windows hosts only).</desc>
12587	</const>
12588	<const name="OSS" value="2">
12589	<desc>Open Sound System (Linux hosts only).</desc>
12590	</const>
12591	<const name="ALSA" value="3">
12592	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12593	</const>
12594	<const name="DirectSound" value="4">
12595	<desc>DirectSound (Windows hosts only).</desc>
12596	</const>
12597	<const name="CoreAudio" value="5">
12598	<desc>CoreAudio (Mac hosts only).</desc>
12599	</const>
12600	<const name="MMPM" value="6">
12601	<desc>Reserved for historical reasons.</desc>
12602	</const>
12603	<const name="Pulse" value="7">
12604	<desc>PulseAudio (Linux hosts only).</desc>
12605	</const>
12606	<const name="SolAudio" value="8">
12607	<desc>Solaris audio (Solaris hosts only).</desc>
12608	</const>
12609	</enum>
12610
12611	<enum
12612	name="AudioControllerType"
12613	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12614	>
12615	<desc>
12616	Virtual audio controller type.
12617	</desc>
12618
12619	<const name="AC97" value="0"/>
12620	<const name="SB16" value="1"/>
12621	<const name="HDA" value="2"/>
12622	</enum>
12623
12624	<interface
12625	name="IAudioAdapter" extends="$unknown"
12626	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12627	wsmap="managed"
12628	>
12629	<desc>
12630	The IAudioAdapter interface represents the virtual audio adapter of
12631	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12632	</desc>
12633	<attribute name="enabled" type="boolean">
12634	<desc>
12635	Flag whether the audio adapter is present in the
12636	guest system. If disabled, the virtual guest hardware will
12637	not contain any audio adapter. Can only be changed when
12638	the VM is not running.
12639	</desc>
12640	</attribute>
12641	<attribute name="audioController" type="AudioControllerType">
12642	<desc>
12643	The audio hardware we emulate.
12644	</desc>
12645	</attribute>
12646	<attribute name="audioDriver" type="AudioDriverType">
12647	<desc>
12648	Audio driver the adapter is connected to. This setting
12649	can only be changed when the VM is not running.
12650	</desc>
12651	</attribute>
12652	</interface>
12653
12654	<enum
12655	name="AuthType"
12656	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12657	>
12658	<desc>
12659	VirtualBox authentication type.
12660	</desc>
12661
12662	<const name="Null" value="0">
12663	<desc>Null value, also means "no authentication".</desc>
12664	</const>
12665	<const name="External" value="1"/>
12666	<const name="Guest" value="2"/>
12667	</enum>
12668
12669	<!--
12670	// IVRDEServer
12671	/////////////////////////////////////////////////////////////////////////
12672	-->
12673
12674	<interface
12675	name="IVRDEServer" extends="$unknown"
12676	uuid="444e5d4a-ecd9-4c38-af95-a2fbfd69b486"
12677	wsmap="managed"
12678	>
12679	<attribute name="enabled" type="boolean">
12680	<desc>VRDE server status.</desc>
12681	</attribute>
12682
12683	<attribute name="authType" type="AuthType">
12684	<desc>VRDE authentication method.</desc>
12685	</attribute>
12686
12687	<attribute name="authTimeout" type="unsigned long">
12688	<desc>Timeout for guest authentication. Milliseconds.</desc>
12689	</attribute>
12690
12691	<attribute name="allowMultiConnection" type="boolean">
12692	<desc>
12693	Flag whether multiple simultaneous connections to the VM are permitted.
12694	Note that this will be replaced by a more powerful mechanism in the future.
12695	</desc>
12696	</attribute>
12697
12698	<attribute name="reuseSingleConnection" type="boolean">
12699	<desc>
12700	Flag whether the existing connection must be dropped and a new connection
12701	must be established by the VRDE server, when a new client connects in single
12702	connection mode.
12703	</desc>
12704	</attribute>
12705
12706	<attribute name="videoChannel" type="boolean">
12707	<desc>
12708	Flag whether video redirectiron channel is enabled.
12709	</desc>
12710	</attribute>
12711
12712	<attribute name="videoChannelQuality" type="unsigned long">
12713	<desc>
12714	Image quality in percents.
12715	</desc>
12716	</attribute>
12717
12718	<attribute name="VRDEExtPack" type="wstring">
12719	<desc>
12720	The name of Extension Pack providing VRDE for this VM. Overrides
12721	<link to="ISystemProperties::defaultVRDEExtPack"/>.
12722	</desc>
12723	</attribute>
12724
12725	<attribute name="AuthLibrary" type="wstring">
12726	<desc>
12727	Library used for authentication of RDP clients by this VM. Overrides
12728	<link to="ISystemProperties::VRDEAuthLibrary"/>.
12729	</desc>
12730	</attribute>
12731
12732	<method name="setVRDEProperty">
12733	<desc>
12734	Sets a VRDE specific property string.
12735
12736	If you pass @c null or empty string as a key @a value, the given @a key
12737	will be deleted.
12738
12739	</desc>
12740	<param name="key" type="wstring" dir="in">
12741	<desc>Name of the key to set.</desc>
12742	</param>
12743	<param name="value" type="wstring" dir="in">
12744	<desc>Value to assign to the key.</desc>
12745	</param>
12746	</method>
12747
12748	<method name="getVRDEProperty">
12749	<desc>
12750	Returns a VRDE specific property string.
12751
12752	If the requested data @a key does not exist, this function will
12753	succeed and return an empty string in the @a value argument.
12754
12755	</desc>
12756	<param name="key" type="wstring" dir="in">
12757	<desc>Name of the key to get.</desc>
12758	</param>
12759	<param name="value" type="wstring" dir="return">
12760	<desc>Value of the requested key.</desc>
12761	</param>
12762	</method>
12763
12764	</interface>
12765
12766
12767	<!--
12768	// ISharedFolder
12769	/////////////////////////////////////////////////////////////////////////
12770	-->
12771
12772	<interface
12773	name="ISharedFolder" extends="$unknown"
12774	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12775	wsmap="struct"
12776	>
12777	<desc>
12778	The ISharedFolder interface represents a folder in the host computer's
12779	file system accessible from the guest OS running inside a virtual
12780	machine using an associated logical name.
12781
12782	There are three types of shared folders:
12783	<ul>
12784	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12785	folders available to all virtual machines.</li>
12786	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12787	VM-specific shared folders available to the given virtual machine at
12788	startup.</li>
12789	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12790	VM-specific shared folders created in the session context (for
12791	example, when the virtual machine is running) and automatically
12792	discarded when the session is closed (the VM is powered off).</li>
12793	</ul>
12794
12795	Logical names of shared folders must be unique within the given scope
12796	(global, permanent or transient). However, they do not need to be unique
12797	across scopes. In this case, the definition of the shared folder in a
12798	more specific scope takes precedence over definitions in all other
12799	scopes. The order of precedence is (more specific to more general):
12800	<ol>
12801	<li>Transient definitions</li>
12802	<li>Permanent definitions</li>
12803	<li>Global definitions</li>
12804	</ol>
12805
12806	For example, if MyMachine has a shared folder named
12807	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12808	transient shared folder named <tt>C_DRIVE</tt> (that points
12809	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12810	of <tt>C_DRIVE</tt> in the guest OS so
12811	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12812	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12813	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12814	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12815	to <tt>C:\\</tt> if it still exists.
12816
12817	Note that permanent and transient shared folders of different machines
12818	are in different name spaces, so they don't overlap and don't need to
12819	have unique logical names.
12820
12821	<note>
12822	Global shared folders are not implemented in the current version of the
12823	product.
12824	</note>
12825	</desc>
12826
12827	<attribute name="name" type="wstring" readonly="yes">
12828	<desc>Logical name of the shared folder.</desc>
12829	</attribute>
12830
12831	<attribute name="hostPath" type="wstring" readonly="yes">
12832	<desc>Full path to the shared folder in the host file system.</desc>
12833	</attribute>
12834
12835	<attribute name="accessible" type="boolean" readonly="yes">
12836	<desc>
12837	Whether the folder defined by the host path is currently
12838	accessible or not.
12839	For example, the folder can be inaccessible if it is placed
12840	on the network share that is not available by the time
12841	this property is read.
12842	</desc>
12843	</attribute>
12844
12845	<attribute name="writable" type="boolean" readonly="yes">
12846	<desc>
12847	Whether the folder defined by the host path is writable or
12848	not.
12849	</desc>
12850	</attribute>
12851
12852	<attribute name="autoMount" type="boolean" readonly="yes">
12853	<desc>
12854	Whether the folder gets automatically mounted by the guest or not.
12855	</desc>
12856	</attribute>
12857
12858	<attribute name="lastAccessError" type="wstring" readonly="yes">
12859	<desc>
12860	Text message that represents the result of the last accessibility
12861	check.
12862
12863	Accessibility checks are performed each time the <link to="#accessible"/>
12864	attribute is read. An empty string is returned if the last
12865	accessibility check was successful. A non-empty string indicates a
12866	failure and should normally describe a reason of the failure (for
12867	example, a file read error).
12868	</desc>
12869	</attribute>
12870
12871	</interface>
12872
12873	<!--
12874	// ISession
12875	/////////////////////////////////////////////////////////////////////////
12876	-->
12877
12878	<interface
12879	name="IInternalSessionControl" extends="$unknown"
12880	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
12881	internal="yes"
12882	wsmap="suppress"
12883	>
12884	<method name="getPID">
12885	<desc>PID of the process that has created this Session object.
12886	</desc>
12887	<param name="pid" type="unsigned long" dir="return"/>
12888	</method>
12889
12890	<method name="getRemoteConsole">
12891	<desc>
12892	Returns the console object suitable for remote control.
12893
12894	<result name="VBOX_E_INVALID_VM_STATE">
12895	Session state prevents operation.
12896	</result>
12897	<result name="VBOX_E_INVALID_OBJECT_STATE">
12898	Session type prevents operation.
12899	</result>
12900
12901	</desc>
12902	<param name="console" type="IConsole" dir="return"/>
12903	</method>
12904
12905	<method name="assignMachine">
12906	<desc>
12907	Assigns the machine object associated with this direct-type
12908	session or informs the session that it will be a remote one
12909	(if @a machine == @c null).
12910
12911	<result name="VBOX_E_INVALID_VM_STATE">
12912	Session state prevents operation.
12913	</result>
12914	<result name="VBOX_E_INVALID_OBJECT_STATE">
12915	Session type prevents operation.
12916	</result>
12917
12918	</desc>
12919	<param name="machine" type="IMachine" dir="in"/>
12920	</method>
12921
12922	<method name="assignRemoteMachine">
12923	<desc>
12924	Assigns the machine and the (remote) console object associated with
12925	this remote-type session.
12926
12927	<result name="VBOX_E_INVALID_VM_STATE">
12928	Session state prevents operation.
12929	</result>
12930
12931	</desc>
12932	<param name="machine" type="IMachine" dir="in"/>
12933	<param name="console" type="IConsole" dir="in"/>
12934	</method>
12935
12936	<method name="updateMachineState">
12937	<desc>
12938	Updates the machine state in the VM process.
12939	Must be called only in certain cases
12940	(see the method implementation).
12941
12942	<result name="VBOX_E_INVALID_VM_STATE">
12943	Session state prevents operation.
12944	</result>
12945	<result name="VBOX_E_INVALID_OBJECT_STATE">
12946	Session type prevents operation.
12947	</result>
12948
12949	</desc>
12950	<param name="aMachineState" type="MachineState" dir="in"/>
12951	</method>
12952
12953	<method name="uninitialize">
12954	<desc>
12955	Uninitializes (closes) this session. Used by VirtualBox to close
12956	the corresponding remote session when the direct session dies
12957	or gets closed.
12958
12959	<result name="VBOX_E_INVALID_VM_STATE">
12960	Session state prevents operation.
12961	</result>
12962
12963	</desc>
12964	</method>
12965
12966	<method name="onNetworkAdapterChange">
12967	<desc>
12968	Triggered when settings of a network adapter of the
12969	associated virtual machine have changed.
12970
12971	<result name="VBOX_E_INVALID_VM_STATE">
12972	Session state prevents operation.
12973	</result>
12974	<result name="VBOX_E_INVALID_OBJECT_STATE">
12975	Session type prevents operation.
12976	</result>
12977
12978	</desc>
12979	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12980	<param name="changeAdapter" type="boolean" dir="in"/>
12981	</method>
12982
12983	<method name="onSerialPortChange">
12984	<desc>
12985	Triggered when settings of a serial port of the
12986	associated virtual machine have changed.
12987
12988	<result name="VBOX_E_INVALID_VM_STATE">
12989	Session state prevents operation.
12990	</result>
12991	<result name="VBOX_E_INVALID_OBJECT_STATE">
12992	Session type prevents operation.
12993	</result>
12994
12995	</desc>
12996	<param name="serialPort" type="ISerialPort" dir="in"/>
12997	</method>
12998
12999	<method name="onParallelPortChange">
13000	<desc>
13001	Triggered when settings of a parallel port of the
13002	associated virtual machine have changed.
13003
13004	<result name="VBOX_E_INVALID_VM_STATE">
13005	Session state prevents operation.
13006	</result>
13007	<result name="VBOX_E_INVALID_OBJECT_STATE">
13008	Session type prevents operation.
13009	</result>
13010
13011	</desc>
13012	<param name="parallelPort" type="IParallelPort" dir="in"/>
13013	</method>
13014
13015	<method name="onStorageControllerChange">
13016	<desc>
13017	Triggered when settings of a storage controller of the
13018	associated virtual machine have changed.
13019
13020	<result name="VBOX_E_INVALID_VM_STATE">
13021	Session state prevents operation.
13022	</result>
13023	<result name="VBOX_E_INVALID_OBJECT_STATE">
13024	Session type prevents operation.
13025	</result>
13026
13027	</desc>
13028	</method>
13029
13030	<method name="onMediumChange">
13031	<desc>
13032	Triggered when attached media of the
13033	associated virtual machine have changed.
13034
13035	<result name="VBOX_E_INVALID_VM_STATE">
13036	Session state prevents operation.
13037	</result>
13038	<result name="VBOX_E_INVALID_OBJECT_STATE">
13039	Session type prevents operation.
13040	</result>
13041
13042	</desc>
13043
13044	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13045	<param name="force" type="boolean" dir="in"/>
13046	</method>
13047
13048	<method name="onCPUChange">
13049	<desc>
13050	Notification when a CPU changes.
13051	</desc>
13052	<param name="cpu" type="unsigned long" dir="in">
13053	<desc>The CPU which changed</desc>
13054	</param>
13055	<param name="add" type="boolean" dir="in">
13056	<desc>Flag whether the CPU was added or removed</desc>
13057	</param>
13058	</method>
13059
13060	<method name="onCPUExecutionCapChange">
13061	<desc>
13062	Notification when the CPU execution cap changes.
13063	</desc>
13064	<param name="executionCap" type="unsigned long" dir="in">
13065	<desc>The new CPU execution cap value. (1-100)</desc>
13066	</param>
13067	</method>
13068
13069	<method name="onVRDEServerChange">
13070	<desc>
13071	Triggered when settings of the VRDE server object of the
13072	associated virtual machine have changed.
13073
13074	<result name="VBOX_E_INVALID_VM_STATE">
13075	Session state prevents operation.
13076	</result>
13077	<result name="VBOX_E_INVALID_OBJECT_STATE">
13078	Session type prevents operation.
13079	</result>
13080
13081	</desc>
13082	<param name="restart" type="boolean" dir="in">
13083	<desc>Flag whether the server must be restarted</desc>
13084	</param>
13085	</method>
13086
13087	<method name="onUSBControllerChange">
13088	<desc>
13089	Triggered when settings of the USB controller object of the
13090	associated virtual machine have changed.
13091
13092	<result name="VBOX_E_INVALID_VM_STATE">
13093	Session state prevents operation.
13094	</result>
13095	<result name="VBOX_E_INVALID_OBJECT_STATE">
13096	Session type prevents operation.
13097	</result>
13098
13099	</desc>
13100	</method>
13101
13102	<method name="onSharedFolderChange">
13103	<desc>
13104	Triggered when a permanent (global or machine) shared folder has been
13105	created or removed.
13106	<note>
13107	We don't pass shared folder parameters in this notification because
13108	the order in which parallel notifications are delivered is not defined,
13109	therefore it could happen that these parameters were outdated by the
13110	time of processing this notification.
13111	</note>
13112
13113	<result name="VBOX_E_INVALID_VM_STATE">
13114	Session state prevents operation.
13115	</result>
13116	<result name="VBOX_E_INVALID_OBJECT_STATE">
13117	Session type prevents operation.
13118	</result>
13119
13120	</desc>
13121	<param name="global" type="boolean" dir="in"/>
13122	</method>
13123
13124	<method name="onUSBDeviceAttach">
13125	<desc>
13126	Triggered when a request to capture a USB device (as a result
13127	of matched USB filters or direct call to
13128	<link to="IConsole::attachUSBDevice"/>) has completed.
13129	A @c null @a error object means success, otherwise it
13130	describes a failure.
13131
13132	<result name="VBOX_E_INVALID_VM_STATE">
13133	Session state prevents operation.
13134	</result>
13135	<result name="VBOX_E_INVALID_OBJECT_STATE">
13136	Session type prevents operation.
13137	</result>
13138
13139	</desc>
13140	<param name="device" type="IUSBDevice" dir="in"/>
13141	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13142	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13143	</method>
13144
13145	<method name="onUSBDeviceDetach">
13146	<desc>
13147	Triggered when a request to release the USB device (as a result
13148	of machine termination or direct call to
13149	<link to="IConsole::detachUSBDevice"/>) has completed.
13150	A @c null @a error object means success, otherwise it
13151	describes a failure.
13152
13153	<result name="VBOX_E_INVALID_VM_STATE">
13154	Session state prevents operation.
13155	</result>
13156	<result name="VBOX_E_INVALID_OBJECT_STATE">
13157	Session type prevents operation.
13158	</result>
13159
13160	</desc>
13161	<param name="id" type="uuid" mod="string" dir="in"/>
13162	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13163	</method>
13164
13165	<method name="onShowWindow">
13166	<desc>
13167	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13168	<link to="IMachine::showConsoleWindow"/> in order to notify
13169	console listeners
13170	<link to="ICanShowWindowEvent"/>
13171	and <link to="IShowWindowEvent"/>.
13172
13173	<result name="VBOX_E_INVALID_OBJECT_STATE">
13174	Session type prevents operation.
13175	</result>
13176
13177	</desc>
13178	<param name="check" type="boolean" dir="in"/>
13179	<param name="canShow" type="boolean" dir="out"/>
13180	<param name="winId" type="long long" dir="out"/>
13181	</method>
13182
13183	<method name="onBandwidthGroupChange">
13184	<desc>
13185	Notification when one of the bandwidth groups change.
13186	</desc>
13187	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13188	<desc>The bandwidth group which changed.</desc>
13189	</param>
13190	</method>
13191
13192	<method name="accessGuestProperty">
13193	<desc>
13194	Called by <link to="IMachine::getGuestProperty"/> and by
13195	<link to="IMachine::setGuestProperty"/> in order to read and
13196	modify guest properties.
13197
13198	<result name="VBOX_E_INVALID_VM_STATE">
13199	Machine session is not open.
13200	</result>
13201	<result name="VBOX_E_INVALID_OBJECT_STATE">
13202	Session type is not direct.
13203	</result>
13204
13205	</desc>
13206	<param name="name" type="wstring" dir="in"/>
13207	<param name="value" type="wstring" dir="in"/>
13208	<param name="flags" type="wstring" dir="in"/>
13209	<param name="isSetter" type="boolean" dir="in"/>
13210	<param name="retValue" type="wstring" dir="out"/>
13211	<param name="retTimestamp" type="long long" dir="out"/>
13212	<param name="retFlags" type="wstring" dir="out"/>
13213	</method>
13214
13215	<method name="enumerateGuestProperties">
13216	<desc>
13217	Return a list of the guest properties matching a set of patterns along
13218	with their values, time stamps and flags.
13219
13220	<result name="VBOX_E_INVALID_VM_STATE">
13221	Machine session is not open.
13222	</result>
13223	<result name="VBOX_E_INVALID_OBJECT_STATE">
13224	Session type is not direct.
13225	</result>
13226
13227	</desc>
13228	<param name="patterns" type="wstring" dir="in">
13229	<desc>
13230	The patterns to match the properties against as a comma-separated
13231	string. If this is empty, all properties currently set will be
13232	returned.
13233	</desc>
13234	</param>
13235	<param name="key" type="wstring" dir="out" safearray="yes">
13236	<desc>
13237	The key names of the properties returned.
13238	</desc>
13239	</param>
13240	<param name="value" type="wstring" dir="out" safearray="yes">
13241	<desc>
13242	The values of the properties returned. The array entries match the
13243	corresponding entries in the @a key array.
13244	</desc>
13245	</param>
13246	<param name="timestamp" type="long long" dir="out" safearray="yes">
13247	<desc>
13248	The time stamps of the properties returned. The array entries match
13249	the corresponding entries in the @a key array.
13250	</desc>
13251	</param>
13252	<param name="flags" type="wstring" dir="out" safearray="yes">
13253	<desc>
13254	The flags of the properties returned. The array entries match the
13255	corresponding entries in the @a key array.
13256	</desc>
13257	</param>
13258	</method>
13259
13260	<method name="onlineMergeMedium">
13261	<desc>
13262	Triggers online merging of a hard disk. Used internally when deleting
13263	a snapshot while a VM referring to the same hard disk chain is running.
13264
13265	<result name="VBOX_E_INVALID_VM_STATE">
13266	Machine session is not open.
13267	</result>
13268	<result name="VBOX_E_INVALID_OBJECT_STATE">
13269	Session type is not direct.
13270	</result>
13271
13272	</desc>
13273	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13274	<desc>The medium attachment to identify the medium chain.</desc>
13275	</param>
13276	<param name="sourceIdx" type="unsigned long" dir="in">
13277	<desc>The index of the source image in the chain.
13278	Redundant, but drastically reduces IPC.</desc>
13279	</param>
13280	<param name="targetIdx" type="unsigned long" dir="in">
13281	<desc>The index of the target image in the chain.
13282	Redundant, but drastically reduces IPC.</desc>
13283	</param>
13284	<param name="source" type="IMedium" dir="in">
13285	<desc>Merge source medium.</desc>
13286	</param>
13287	<param name="target" type="IMedium" dir="in">
13288	<desc>Merge target medium.</desc>
13289	</param>
13290	<param name="mergeForward" type="boolean" dir="in">
13291	<desc>Merge direction.</desc>
13292	</param>
13293	<param name="parentForTarget" type="IMedium" dir="in">
13294	<desc>For forward merges: new parent for target medium.</desc>
13295	</param>
13296	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13297	<desc>For backward merges: list of media which need their parent UUID
13298	updated.</desc>
13299	</param>
13300	<param name="progress" type="IProgress" dir="in">
13301	<desc>
13302	Progress object for this operation.
13303	</desc>
13304	</param>
13305	</method>
13306
13307	</interface>
13308
13309	<interface
13310	name="ISession" extends="$unknown"
13311	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13312	wsmap="managed"
13313	>
13314	<desc>
13315	The ISession interface represents a client process and allows for locking
13316	virtual machines (represented by IMachine objects) to prevent conflicting
13317	changes to the machine.
13318
13319	Any caller wishing to manipulate a virtual machine needs to create a session
13320	object first, which lives in its own process space. Such session objects are
13321	then associated with <link to="IMachine" /> objects living in the VirtualBox
13322	server process to coordinate such changes.
13323
13324	There are two typical scenarios in which sessions are used:
13325
13326	<ul>
13327	<li>To alter machine settings or control a running virtual machine, one
13328	needs to lock a machine for a given session (client process) by calling
13329	<link to="IMachine::lockMachine"/>.
13330
13331	Whereas multiple sessions may control a running virtual machine, only
13332	one process can obtain a write lock on the machine to prevent conflicting
13333	changes. A write lock is also needed if a process wants to actually run a
13334	virtual machine in its own context, such as the VirtualBox GUI or
13335	VBoxHeadless front-ends. They must also lock a machine for their own
13336	sessions before they are allowed to power up the virtual machine.
13337
13338	As a result, no machine settings can be altered while another process is
13339	already using it, either because that process is modifying machine settings
13340	or because the machine is running.
13341	</li>
13342	<li>
13343	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13344	VirtualBox GUI or VBoxHeadless), one would use
13345	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13346	as its first parameter. This session then identifies the caller and lets the
13347	caller control the started machine (for example, pause machine execution or
13348	power it down) as well as be notified about machine execution state changes.
13349	</li>
13350	</ul>
13351
13352	How sessions objects are created in a client process depends on whether you use
13353	the Main API via COM or via the webservice:
13354
13355	<ul>
13356	<li>When using the COM API directly, an object of the Session class from the
13357	VirtualBox type library needs to be created. In regular COM C++ client code,
13358	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13359	This object will then act as a local session object in further calls to open
13360	a session.
13361	</li>
13362
13363	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13364	a session object automatically whenever <link to="IWebsessionManager::logon" />
13365	is called. A managed object reference to that session object can be retrieved by
13366	calling <link to="IWebsessionManager::getSessionObject" />.
13367	</li>
13368	</ul>
13369	</desc>
13370
13371	<attribute name="state" type="SessionState" readonly="yes">
13372	<desc>Current state of this session.</desc>
13373	</attribute>
13374
13375	<attribute name="type" type="SessionType" readonly="yes">
13376	<desc>
13377	Type of this session. The value of this attribute is valid only
13378	if the session currently has a machine locked (i.e. its
13379	<link to="#state" /> is Locked), otherwise an error will be returned.
13380	</desc>
13381	</attribute>
13382
13383	<attribute name="machine" type="IMachine" readonly="yes">
13384	<desc>Machine object associated with this session.</desc>
13385	</attribute>
13386
13387	<attribute name="console" type="IConsole" readonly="yes">
13388	<desc>Console object associated with this session.</desc>
13389	</attribute>
13390
13391	<method name="unlockMachine">
13392	<desc>
13393	Unlocks a machine that was previously locked for the current session.
13394
13395	Calling this method is required every time a machine has been locked
13396	for a particular session using the <link to="IMachine::launchVMProcess" />
13397	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13398	the machine will be set to <link to="MachineState_Aborted" /> on the
13399	server, and changes made to the machine settings will be lost.
13400
13401	Generally, it is recommended to unlock all machines explicitly
13402	before terminating the application (regardless of the reason for
13403	the termination).
13404
13405	<note>
13406	Do not expect the session state (<link to="ISession::state" />
13407	to return to "Unlocked" immediately after you invoke this method,
13408	particularly if you have started a new VM process. The session
13409	state will automatically return to "Unlocked" once the VM is no
13410	longer executing, which can of course take a very long time.
13411	</note>
13412
13413	<result name="E_UNEXPECTED">
13414	Session is not locked.
13415	</result>
13416
13417	</desc>
13418	</method>
13419
13420	</interface>
13421
13422	<!--
13423	// IStorageController
13424	/////////////////////////////////////////////////////////////////////////
13425	-->
13426
13427	<enum
13428	name="StorageBus"
13429	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13430	>
13431	<desc>
13432	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13433	see <link to="IStorageController::bus" />.
13434	</desc>
13435	<const name="Null" value="0">
13436	<desc>@c null value. Never used by the API.</desc>
13437	</const>
13438	<const name="IDE" value="1"/>
13439	<const name="SATA" value="2"/>
13440	<const name="SCSI" value="3"/>
13441	<const name="Floppy" value="4"/>
13442	<const name="SAS" value="5"/>
13443	</enum>
13444
13445	<enum
13446	name="StorageControllerType"
13447	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13448	>
13449	<desc>
13450	The exact variant of storage controller hardware presented
13451	to the guest; see <link to="IStorageController::controllerType" />.
13452	</desc>
13453
13454	<const name="Null" value="0">
13455	<desc>@c null value. Never used by the API.</desc>
13456	</const>
13457	<const name="LsiLogic" value="1">
13458	<desc>A SCSI controller of the LsiLogic variant.</desc>
13459	</const>
13460	<const name="BusLogic" value="2">
13461	<desc>A SCSI controller of the BusLogic variant.</desc>
13462	</const>
13463	<const name="IntelAhci" value="3">
13464	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13465	</const>
13466	<const name="PIIX3" value="4">
13467	<desc>An IDE controller of the PIIX3 variant.</desc>
13468	</const>
13469	<const name="PIIX4" value="5">
13470	<desc>An IDE controller of the PIIX4 variant.</desc>
13471	</const>
13472	<const name="ICH6" value="6">
13473	<desc>An IDE controller of the ICH6 variant.</desc>
13474	</const>
13475	<const name="I82078" value="7">
13476	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13477	</const>
13478	<const name="LsiLogicSas" value="8">
13479	<desc>A variant of the LsiLogic controller using SAS.</desc>
13480	</const>
13481	</enum>
13482
13483	<enum
13484	name="ChipsetType"
13485	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13486	>
13487	<desc>
13488	Type of emulated chipset (mostly southbridge).
13489	</desc>
13490
13491	<const name="Null" value="0">
13492	<desc>@c null value. Never used by the API.</desc>
13493	</const>
13494	<const name="PIIX3" value="1">
13495	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13496	</const>
13497	<const name="ICH9" value="2">
13498	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13499	</const>
13500	</enum>
13501
13502	<interface
13503	name="IStorageController" extends="$unknown"
13504	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13505	wsmap="managed"
13506	>
13507	<desc>
13508	Represents a storage controller that is attached to a virtual machine
13509	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13510	attached to storage controllers in a real computer, virtual drives
13511	(represented by <link to="IMediumAttachment" />) are attached to virtual
13512	storage controllers, represented by this interface.
13513
13514	As opposed to physical hardware, VirtualBox has a very generic concept
13515	of a storage controller, and for purposes of the Main API, all virtual
13516	storage is attached to virtual machines via instances of this interface.
13517	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13518	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13519	is used, certain sub-types may be available and can be selected in
13520	<link to="#controllerType" />.
13521
13522	Depending on these settings, the guest operating system might see
13523	significantly different virtual hardware.
13524	</desc>
13525
13526	<attribute name="name" type="wstring" readonly="yes">
13527	<desc>
13528	Name of the storage controller, as originally specified with
13529	<link to="IMachine::addStorageController" />. This then uniquely
13530	identifies this controller with other method calls such as
13531	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13532	</desc>
13533	</attribute>
13534
13535	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13536	<desc>
13537	Maximum number of devices which can be attached to one port.
13538	</desc>
13539	</attribute>
13540
13541	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13542	<desc>
13543	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13544	</desc>
13545	</attribute>
13546
13547	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13548	<desc>
13549	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13550	</desc>
13551	</attribute>
13552
13553	<attribute name="instance" type="unsigned long">
13554	<desc>
13555	The instance number of the device in the running VM.
13556	</desc>
13557	</attribute>
13558
13559	<attribute name="portCount" type="unsigned long">
13560	<desc>
13561	The number of currently usable ports on the controller.
13562	The minimum and maximum number of ports for one controller are
13563	stored in <link to="IStorageController::minPortCount"/>
13564	and <link to="IStorageController::maxPortCount"/>.
13565	</desc>
13566	</attribute>
13567
13568	<attribute name="bus" type="StorageBus" readonly="yes">
13569	<desc>
13570	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13571	</desc>
13572	</attribute>
13573
13574	<attribute name="controllerType" type="StorageControllerType">
13575	<desc>
13576	The exact variant of storage controller hardware presented
13577	to the guest.
13578	Depending on this value, VirtualBox will provide a different
13579	virtual storage controller hardware to the guest.
13580	For SATA, SAS and floppy controllers, only one variant is
13581	available, but for IDE and SCSI, there are several.
13582
13583	For SCSI controllers, the default type is LsiLogic.
13584	</desc>
13585	</attribute>
13586
13587	<attribute name="useHostIOCache" type="boolean">
13588	<desc>
13589	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13590	caches and use synchronous file APIs on the host. This was the only option in the API before
13591	VirtualBox 3.2 and is still the default for IDE controllers.
13592
13593	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13594	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13595	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13596	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13597	virtual machines are running at the same time to prevent I/O cache related hangs.
13598	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13599	</desc>
13600	</attribute>
13601
13602	<attribute name="bootable" type="boolean" readonly="yes">
13603	<desc>
13604	Returns whether it is possible to boot from disks attached to this controller.
13605	</desc>
13606	</attribute>
13607
13608	<method name="getIDEEmulationPort">
13609	<desc>
13610	Gets the corresponding port number which is emulated as an IDE device.
13611	Works only with SATA controllers.
13612
13613	<result name="E_INVALIDARG">
13614	The @a devicePosition is not in the range 0 to 3.
13615	</result>
13616	<result name="E_NOTIMPL">
13617	The storage controller type is not SATAIntelAhci.
13618	</result>
13619
13620	</desc>
13621	<param name="devicePosition" type="long" dir="in"/>
13622	<param name="portNumber" type="long" dir="return"/>
13623	</method>
13624
13625	<method name="setIDEEmulationPort">
13626	<desc>
13627	Sets the port number which is emulated as an IDE device.
13628	Works only with SATA controllers.
13629
13630	<result name="E_INVALIDARG">
13631	The @a devicePosition is not in the range 0 to 3 or the
13632	@a portNumber is not in the range 0 to 29.
13633	</result>
13634	<result name="E_NOTIMPL">
13635	The storage controller type is not SATAIntelAhci.
13636	</result>
13637
13638	</desc>
13639	<param name="devicePosition" type="long" dir="in"/>
13640	<param name="portNumber" type="long" dir="in"/>
13641	</method>
13642
13643	</interface>
13644
13645	<if target="wsdl">
13646
13647	<!--
13648	// IManagedObjectRef
13649	/////////////////////////////////////////////////////////////////////////
13650	-->
13651
13652	<interface
13653	name="IManagedObjectRef" extends="$unknown"
13654	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13655	internal="yes"
13656	wsmap="managed"
13657	wscpp="hardcoded"
13658	>
13659	<desc>
13660	Managed object reference.
13661
13662	Only within the webservice, a managed object reference (which is really
13663	an opaque number) allows a webservice client to address an object
13664	that lives in the address space of the webservice server.
13665
13666	Behind each managed object reference, there is a COM object that lives
13667	in the webservice server's address space. The COM object is not freed
13668	until the managed object reference is released, either by an explicit
13669	call to <link to="IManagedObjectRef::release" /> or by logging off from
13670	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13671	all objects created during the webservice session.
13672
13673	Whenever a method call of the VirtualBox API returns a COM object, the
13674	webservice representation of that method will instead return a
13675	managed object reference, which can then be used to invoke methods
13676	on that object.
13677	</desc>
13678
13679	<method name="getInterfaceName">
13680	<desc>
13681	Returns the name of the interface that this managed object represents,
13682	for example, "IMachine", as a string.
13683	</desc>
13684	<param name="return" type="wstring" dir="return"/>
13685	</method>
13686
13687	<method name="release">
13688	<desc>
13689	Releases this managed object reference and frees the resources that
13690	were allocated for it in the webservice server process. After calling
13691	this method, the identifier of the reference can no longer be used.
13692	</desc>
13693	</method>
13694
13695	</interface>
13696
13697	<!--
13698	// IWebsessionManager
13699	/////////////////////////////////////////////////////////////////////////
13700	-->
13701
13702	<interface
13703	name="IWebsessionManager" extends="$unknown"
13704	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13705	internal="yes"
13706	wsmap="global"
13707	wscpp="hardcoded"
13708	>
13709	<desc>
13710	Websession manager. This provides essential services
13711	to webservice clients.
13712	</desc>
13713	<method name="logon">
13714	<desc>
13715	Logs a new client onto the webservice and returns a managed object reference to
13716	the IVirtualBox instance, which the client can then use as a basis to further
13717	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13718	interface, in one way or the other.
13719	</desc>
13720	<param name="username" type="wstring" dir="in"/>
13721	<param name="password" type="wstring" dir="in"/>
13722	<param name="return" type="IVirtualBox" dir="return"/>
13723	</method>
13724
13725	<method name="getSessionObject">
13726	<desc>
13727	Returns a managed object reference to the internal ISession object that was created
13728	for this web service session when the client logged on.
13729
13730	<see>ISession</see>
13731	</desc>
13732	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13733	<param name="return" type="ISession" dir="return"/>
13734	</method>
13735
13736	<method name="logoff">
13737	<desc>
13738	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13739	and destroys all resources associated with the session (most importantly, all
13740	managed objects created in the server while the session was active).
13741	</desc>
13742	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13743	</method>
13744
13745	</interface>
13746
13747	</if>
13748
13749	<!--
13750	// IPerformanceCollector & friends
13751	/////////////////////////////////////////////////////////////////////////
13752	-->
13753
13754	<interface
13755	name="IPerformanceMetric" extends="$unknown"
13756	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13757	>
13758	<desc>
13759	The IPerformanceMetric interface represents parameters of the given
13760	performance metric.
13761	</desc>
13762
13763	<attribute name="metricName" type="wstring" readonly="yes">
13764	<desc>
13765	Name of the metric.
13766	</desc>
13767	</attribute>
13768
13769	<attribute name="object" type="$unknown" readonly="yes">
13770	<desc>
13771	Object this metric belongs to.
13772	</desc>
13773	</attribute>
13774
13775	<attribute name="description" type="wstring" readonly="yes">
13776	<desc>
13777	Textual description of the metric.
13778	</desc>
13779	</attribute>
13780
13781	<attribute name="period" type="unsigned long" readonly="yes">
13782	<desc>
13783	Time interval between samples, measured in seconds.
13784	</desc>
13785	</attribute>
13786
13787	<attribute name="count" type="unsigned long" readonly="yes">
13788	<desc>
13789	Number of recent samples retained by the performance collector for this
13790	metric.
13791
13792	When the collected sample count exceeds this number, older samples
13793	are discarded.
13794	</desc>
13795	</attribute>
13796
13797	<attribute name="unit" type="wstring" readonly="yes">
13798	<desc>
13799	Unit of measurement.
13800	</desc>
13801	</attribute>
13802
13803	<attribute name="minimumValue" type="long" readonly="yes">
13804	<desc>
13805	Minimum possible value of this metric.
13806	</desc>
13807	</attribute>
13808
13809	<attribute name="maximumValue" type="long" readonly="yes">
13810	<desc>
13811	Maximum possible value of this metric.
13812	</desc>
13813	</attribute>
13814	</interface>
13815
13816	<interface
13817	name="IPerformanceCollector" extends="$unknown"
13818	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13819	wsmap="managed"
13820	>
13821	<desc>
13822	The IPerformanceCollector interface represents a service that collects
13823	and stores performance metrics data.
13824
13825	Performance metrics are associated with objects of interfaces like IHost
13826	and IMachine. Each object has a distinct set of performance metrics. The
13827	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13828
13829	Metric data is collected at the specified intervals and is retained
13830	internally. The interval and the number of retained samples can be set
13831	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13832	and collection settings are not persistent, they are discarded as soon as
13833	VBoxSVC process terminates. Moreover, metric settings and data associated
13834	with a particular VM only exist while VM is running. They disappear as
13835	soon as VM shuts down. It is not possible to set up metrics for machines
13836	that are powered off. One needs to start VM first, then set up metric
13837	collection parameters.
13838
13839	Metrics are organized hierarchically, with each level separated by a
13840	slash (/) character. Generally, the scheme for metric names is like this:
13841
13842	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13843
13844	"Category/Metric" together form the base metric name. A base metric is
13845	the smallest unit for which a sampling interval and the number of
13846	retained samples can be set. Only base metrics can be enabled and
13847	disabled. All sub-metrics are collected when their base metric is
13848	collected. Collected values for any set of sub-metrics can be queried
13849	with <link to="IPerformanceCollector::queryMetricsData" />.
13850
13851	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13852	category, "Load" metric, "User" submetric, "average" aggregate. An
13853	aggregate function is computed over all retained data. Valid aggregate
13854	functions are:
13855
13856	<ul>
13857	<li>avg -- average</li>
13858	<li>min -- minimum</li>
13859	<li>max -- maximum</li>
13860	</ul>
13861
13862	When setting up metric parameters, querying metric data, enabling or
13863	disabling metrics wildcards can be used in metric names to specify a
13864	subset of metrics. For example, to select all CPU-related metrics
13865	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13866	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13867
13868	The valid names for base metrics are:
13869
13870	<ul>
13871	<li>CPU/Load</li>
13872	<li>CPU/MHz</li>
13873	<li>RAM/Usage</li>
13874	</ul>
13875
13876	The general sequence for collecting and retrieving the metrics is:
13877	<ul>
13878	<li>
13879	Obtain an instance of IPerformanceCollector with
13880	<link to="IVirtualBox::performanceCollector" />
13881	</li>
13882	<li>
13883	Allocate and populate an array with references to objects the metrics
13884	will be collected for. Use references to IHost and IMachine objects.
13885	</li>
13886	<li>
13887	Allocate and populate an array with base metric names the data will
13888	be collected for.
13889	</li>
13890	<li>
13891	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13892	the metric data will be collected and stored.
13893	</li>
13894	<li>
13895	Wait for the data to get collected.
13896	</li>
13897	<li>
13898	Allocate and populate an array with references to objects the metric
13899	values will be queried for. You can re-use the object array used for
13900	setting base metrics.
13901	</li>
13902	<li>
13903	Allocate and populate an array with metric names the data will be
13904	collected for. Note that metric names differ from base metric names.
13905	</li>
13906	<li>
13907	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13908	that have been collected so far are returned. Note that the values
13909	are still retained internally and data collection continues.
13910	</li>
13911	</ul>
13912
13913	For an example of usage refer to the following files in VirtualBox SDK:
13914	<ul>
13915	<li>
13916	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13917	</li>
13918	<li>
13919	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13920	</li>
13921	</ul>
13922	</desc>
13923
13924	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13925	<desc>
13926	Array of unique names of metrics.
13927
13928	This array represents all metrics supported by the performance
13929	collector. Individual objects do not necessarily support all of them.
13930	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13931	list of supported metrics for a particular object.
13932	</desc>
13933	</attribute>
13934
13935	<method name="getMetrics">
13936	<desc>
13937	Returns parameters of specified metrics for a set of objects.
13938	<note>
13939	@c Null metrics array means all metrics. @c Null object array means
13940	all existing objects.
13941	</note>
13942	</desc>
13943	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13944	<desc>
13945	Metric name filter. Currently, only a comma-separated list of metrics
13946	is supported.
13947	</desc>
13948	</param>
13949	<param name="objects" type="$unknown" dir="in" safearray="yes">
13950	<desc>
13951	Set of objects to return metric parameters for.
13952	</desc>
13953	</param>
13954	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13955	<desc>
13956	Array of returned metric parameters.
13957	</desc>
13958	</param>
13959	</method>
13960
13961	<method name="setupMetrics">
13962	<desc>
13963	Sets parameters of specified base metrics for a set of objects. Returns
13964	an array of <link to="IPerformanceMetric" /> describing the metrics
13965	have been affected.
13966	<note>
13967	@c Null or empty metric name array means all metrics. @c Null or
13968	empty object array means all existing objects. If metric name array
13969	contains a single element and object array contains many, the single
13970	metric name array element is applied to each object array element to
13971	form metric/object pairs.
13972	</note>
13973	</desc>
13974	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13975	<desc>
13976	Metric name filter. Comma-separated list of metrics with wildcard
13977	support.
13978	</desc>
13979	</param>
13980	<param name="objects" type="$unknown" dir="in" safearray="yes">
13981	<desc>
13982	Set of objects to setup metric parameters for.
13983	</desc>
13984	</param>
13985	<param name="period" type="unsigned long" dir="in">
13986	<desc>
13987	Time interval in seconds between two consecutive samples of
13988	performance data.
13989	</desc>
13990	</param>
13991	<param name="count" type="unsigned long" dir="in">
13992	<desc>
13993	Number of samples to retain in performance data history. Older
13994	samples get discarded.
13995	</desc>
13996	</param>
13997	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13998	<desc>
13999	Array of metrics that have been modified by the call to this method.
14000	</desc>
14001	</param>
14002	</method>
14003
14004	<method name="enableMetrics">
14005	<desc>
14006	Turns on collecting specified base metrics. Returns an array of
14007	<link to="IPerformanceMetric" /> describing the metrics have been
14008	affected.
14009	<note>
14010	@c Null or empty metric name array means all metrics. @c Null or
14011	empty object array means all existing objects. If metric name array
14012	contains a single element and object array contains many, the single
14013	metric name array element is applied to each object array element to
14014	form metric/object pairs.
14015	</note>
14016	</desc>
14017	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14018	<desc>
14019	Metric name filter. Comma-separated list of metrics with wildcard
14020	support.
14021	</desc>
14022	</param>
14023	<param name="objects" type="$unknown" dir="in" safearray="yes">
14024	<desc>
14025	Set of objects to enable metrics for.
14026	</desc>
14027	</param>
14028	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14029	<desc>
14030	Array of metrics that have been modified by the call to this method.
14031	</desc>
14032	</param>
14033	</method>
14034
14035	<method name="disableMetrics">
14036	<desc>
14037	Turns off collecting specified base metrics. Returns an array of
14038	<link to="IPerformanceMetric" /> describing the metrics have been
14039	affected.
14040	<note>
14041	@c Null or empty metric name array means all metrics. @c Null or
14042	empty object array means all existing objects. If metric name array
14043	contains a single element and object array contains many, the single
14044	metric name array element is applied to each object array element to
14045	form metric/object pairs.
14046	</note>
14047	</desc>
14048	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14049	<desc>
14050	Metric name filter. Comma-separated list of metrics with wildcard
14051	support.
14052	</desc>
14053	</param>
14054	<param name="objects" type="$unknown" dir="in" safearray="yes">
14055	<desc>
14056	Set of objects to disable metrics for.
14057	</desc>
14058	</param>
14059	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14060	<desc>
14061	Array of metrics that have been modified by the call to this method.
14062	</desc>
14063	</param>
14064	</method>
14065
14066	<method name="queryMetricsData">
14067	<desc>
14068	Queries collected metrics data for a set of objects.
14069
14070	The data itself and related metric information are returned in seven
14071	parallel and one flattened array of arrays. Elements of
14072	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14073	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14074	the same index describe one set of values corresponding to a single
14075	metric.
14076
14077	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14078	start and length of a sub-array is indicated by
14079	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14080	value for metric <tt>metricNames[i]</tt> is at
14081	<tt>returnData[returnIndices[i]]</tt>.
14082
14083	<note>
14084	@c Null or empty metric name array means all metrics. @c Null or
14085	empty object array means all existing objects. If metric name array
14086	contains a single element and object array contains many, the single
14087	metric name array element is applied to each object array element to
14088	form metric/object pairs.
14089	</note>
14090	<note>
14091	Data collection continues behind the scenes after call to @c
14092	queryMetricsData. The return data can be seen as the snapshot of the
14093	current state at the time of @c queryMetricsData call. The internally
14094	kept metric values are not cleared by the call. This makes possible
14095	querying different subsets of metrics or aggregates with subsequent
14096	calls. If periodic querying is needed it is highly suggested to query
14097	the values with @c interval*count period to avoid confusion. This way
14098	a completely new set of data values will be provided by each query.
14099	</note>
14100	</desc>
14101	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14102	<desc>
14103	Metric name filter. Comma-separated list of metrics with wildcard
14104	support.
14105	</desc>
14106	</param>
14107	<param name="objects" type="$unknown" dir="in" safearray="yes">
14108	<desc>
14109	Set of objects to query metrics for.
14110	</desc>
14111	</param>
14112	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14113	<desc>
14114	Names of metrics returned in @c returnData.
14115	</desc>
14116	</param>
14117	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14118	<desc>
14119	Objects associated with metrics returned in @c returnData.
14120	</desc>
14121	</param>
14122	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14123	<desc>
14124	Units of measurement for each returned metric.
14125	</desc>
14126	</param>
14127	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14128	<desc>
14129	Divisor that should be applied to return values in order to get
14130	floating point values. For example:
14131	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14132	will retrieve the floating point value of i-th sample of the first
14133	metric.
14134	</desc>
14135	</param>
14136	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14137	<desc>
14138	Sequence numbers of the first elements of value sequences of
14139	particular metrics returned in @c returnData. For aggregate metrics
14140	it is the sequence number of the sample the aggregate started
14141	calculation from.
14142	</desc>
14143	</param>
14144	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14145	<desc>
14146	Indices of the first elements of value sequences of particular
14147	metrics returned in @c returnData.
14148	</desc>
14149	</param>
14150	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14151	<desc>
14152	Lengths of value sequences of particular metrics.
14153	</desc>
14154	</param>
14155	<param name="returnData" type="long" dir="return" safearray="yes">
14156	<desc>
14157	Flattened array of all metric data containing sequences of values for
14158	each metric.
14159	</desc>
14160	</param>
14161	</method>
14162
14163	</interface>
14164
14165	<enum
14166	name="NATAliasMode"
14167	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14168	>
14169	<desc></desc>
14170	<const name="AliasLog" value="0x1">
14171	<desc></desc>
14172	</const>
14173	<const name="AliasProxyOnly" value="0x02">
14174	<desc></desc>
14175	</const>
14176	<const name="AliasUseSamePorts" value="0x04">
14177	<desc></desc>
14178	</const>
14179	</enum>
14180
14181	<enum
14182	name="NATProtocol"
14183	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14184	>
14185	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14186	<const name="UDP" value="0">
14187	<desc>Port-forwarding uses UDP protocol.</desc>
14188	</const>
14189	<const name="TCP" value="1">
14190	<desc>Port-forwarding uses TCP protocol.</desc>
14191	</const>
14192	</enum>
14193
14194	<interface
14195	name="INATEngine" extends="$unknown"
14196	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14197	wsmap="managed"
14198	>
14199	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14200	allows for changing NAT behavior such as port-forwarding rules. This interface is
14201	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14202	<attribute name="network" type="wstring">
14203	<desc>The network attribute of the NAT engine (the same value is used with built-in
14204	DHCP server to fill corresponding fields of DHCP leases).</desc>
14205	</attribute>
14206	<attribute name="hostIP" type="wstring">
14207	<desc>IP of host interface to bind all opened sockets to.
14208	<note>Changing this does not change binding of port forwarding.</note>
14209	</desc>
14210	</attribute>
14211	<attribute name="tftpPrefix" type="wstring">
14212	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14213	the corresponding fields of DHCP leases.</desc>
14214	</attribute>
14215	<attribute name="tftpBootFile" type="wstring">
14216	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14217	the corresponding fields of DHCP leases.</desc>
14218	</attribute>
14219	<attribute name="tftpNextServer" type="wstring">
14220	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14221	the corresponding fields of DHCP leases.
14222	<note>The preferred form is IPv4 addresses.</note>
14223	</desc>
14224	</attribute>
14225	<attribute name="aliasMode" type="unsigned long">
14226	<desc></desc>
14227	</attribute>
14228	<attribute name="dnsPassDomain" type="boolean">
14229	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14230	</attribute>
14231	<attribute name="dnsProxy" type="boolean">
14232	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14233	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14234	</attribute>
14235	<attribute name="dnsUseHostResolver" type="boolean">
14236	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14237	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14238	</attribute>
14239	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14240	<desc>Array of NAT port-forwarding rules in string representation, in the following
14241	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14242	</attribute>
14243	<method name="setNetworkSettings">
14244	<desc>Sets network configuration of the NAT engine.</desc>
14245	<param name="mtu" type="unsigned long" dir="in">
14246	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14247	</param>
14248	<param name="sockSnd" type="unsigned long" dir="in">
14249	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14250	</param>
14251	<param name="sockRcv" type="unsigned long" dir="in">
14252	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14253	</param>
14254	<param name="TcpWndSnd" type="unsigned long" dir="in">
14255	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14256	establishing a new TCP connection.</desc>
14257	</param>
14258	<param name="TcpWndRcv" type="unsigned long" dir="in">
14259	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14260	establishing a new TCP connection.</desc>
14261	</param>
14262	</method>
14263	<method name="getNetworkSettings">
14264	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14265	for parameter descriptions.</desc>
14266	<param name="mtu" type="unsigned long" dir="out" />
14267	<param name="sockSnd" type="unsigned long" dir="out" />
14268	<param name="sockRcv" type="unsigned long" dir="out" />
14269	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14270	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14271	</method>
14272	<method name="addRedirect">
14273	<desc>Adds a new NAT port-forwarding rule.</desc>
14274	<param name="name" type="wstring" dir="in">
14275	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14276	auto-generates one using the other parameters.</desc>
14277	</param>
14278	<param name="proto" type="NATProtocol" dir="in">
14279	<desc>Protocol handled with the rule.</desc>
14280	</param>
14281	<param name="hostIp" type="wstring" dir="in">
14282	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14283	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14284	</param>
14285	<param name="hostPort" type="unsigned short" dir="in">
14286	<desc>The port number to listen on.</desc>
14287	</param>
14288	<param name="guestIp" type="wstring" dir="in">
14289	<desc>The IP address of the guest which the NAT engine will forward matching packets
14290	to. An empty IP address is acceptable, in which case the NAT engine will forward
14291	packets to the first DHCP lease (x.x.x.15).</desc>
14292	</param>
14293	<param name="guestPort" type="unsigned short" dir="in">
14294	<desc>The port number to forward.</desc>
14295	</param>
14296	</method>
14297	<method name="removeRedirect">
14298	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14299	<param name="name" type="wstring" dir="in">
14300	<desc>The name of the rule to delete.</desc>
14301	</param>
14302	</method>
14303	</interface>
14304
14305	<!--
14306	// IExtPackManager
14307	/////////////////////////////////////////////////////////////////////////
14308	-->
14309
14310	<interface
14311	name="IExtPackPlugIn" extends="$unknown"
14312	uuid="58000040-e718-4746-bbce-4b86d96da461"
14313	wsmap="suppress"
14314	>
14315	<desc>
14316	Interface for keeping information about a plug-in that ships with an
14317	extension pack.
14318	</desc>
14319	<attribute name="name" type="wstring" readonly="yes">
14320	<desc>The plug-in name.</desc>
14321	</attribute>
14322	<attribute name="description" type="wstring" readonly="yes">
14323	<desc>The plug-in description.</desc>
14324	</attribute>
14325	<attribute name="frontend" type="wstring" readonly="yes">
14326	<desc>
14327	The name of the frontend or component name this plug-in plugs into.
14328	</desc>
14329	</attribute>
14330	<attribute name="modulePath" type="wstring" readonly="yes">
14331	<desc> The module path. </desc>
14332	</attribute>
14333	</interface>
14334
14335	<interface
14336	name="IExtPackBase" extends="$unknown"
14337	uuid="ddc90e1d-b156-480e-b128-d3ccacbb42e0"
14338	wsmap="suppress"
14339	>
14340	<desc>
14341	Interface for querying information about an extension pack as well as
14342	accessing COM objects within it.
14343	</desc>
14344	<attribute name="name" type="wstring" readonly="yes">
14345	<desc>The extension pack name. This is unique.</desc>
14346	</attribute>
14347	<attribute name="description" type="wstring" readonly="yes">
14348	<desc>The extension pack description.</desc>
14349	</attribute>
14350	<attribute name="version" type="wstring" readonly="yes">
14351	<desc>
14352	The extension pack version string. This is on the same form as
14353	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14354	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14355	or "1.2.3_BETA1-r45678-OSE"
14356	</desc>
14357	</attribute>
14358	<attribute name="revision" type="unsigned long" readonly="yes">
14359	<desc>The extension pack internal revision number.</desc>
14360	</attribute>
14361	<attribute name="VRDEModule" type="wstring" readonly="yes">
14362	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14363	</attribute>
14364	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14365	<desc>Plug-ins provided by this extension pack.</desc>
14366	</attribute>
14367	<attribute name="license" type="wstring" readonly="yes">
14368	<desc>The HTML license text for the extension pack.</desc>
14369	</attribute>
14370	<attribute name="showLicense" type="boolean" readonly="yes">
14371	<desc>Whether to show the license before installation</desc>
14372	</attribute>
14373	<attribute name="usable" type="boolean" readonly="yes">
14374	<desc>
14375	Indicates whether the extension pack is usable or not.
14376
14377	There are a number of reasons why an extension pack might be unusable,
14378	typical examples would be broken installation/file or that it is
14379	incompatible with the current VirtualBox version.
14380	</desc>
14381	</attribute>
14382	<attribute name="whyUnusable" type="wstring" readonly="yes">
14383	<desc>
14384	String indicating why the extension pack is not usable. This is an
14385	empty string if usable and always a non-empty string if not usable.
14386	</desc>
14387	</attribute>
14388	</interface>
14389
14390	<interface
14391	name="IExtPack" extends="IExtPackBase"
14392	uuid="b9c18b10-611e-46ea-abcc-bfa1e680ea80"
14393	wsmap="suppress"
14394	>
14395	<desc>
14396	Interface for querying information about an extension pack as well as
14397	accessing COM objects within it.
14398	</desc>
14399	<method name="queryObject">
14400	<desc>
14401	Queries the IUnknown interface to an object in the extension pack
14402	main module. This allows plug-ins and others to talk directly to an
14403	extension pack.
14404	</desc>
14405	<param name="objUuid" type="wstring" dir="in">
14406	<desc>The object ID. What exactly this is </desc>
14407	</param>
14408	<param name="returnInterface" type="$unknown" dir="out">
14409	<desc>The queried interface.</desc>
14410	</param>
14411	</method>
14412	</interface>
14413
14414	<interface
14415	name="IExtPackFile" extends="IExtPackBase"
14416	uuid="d9eab28b-b28f-4400-a956-403f28750225"
14417	wsmap="suppress"
14418	>
14419	<desc>
14420	Extension pack file (aka tarball, .vbox-extpack) representation returned
14421	by IExtPackManager::openExtPackFile. This provides the base extension
14422	pack information with the addition of the file name. It also provides an
14423	alternative to IExtPackManager::install.
14424	</desc>
14425	<attribute name="filePath" type="wstring" readonly="yes">
14426	<desc>
14427	The path to the extension pack file.
14428	</desc>
14429	</attribute>
14430
14431	<method name="install">
14432	<desc>
14433	Install the extension pack.
14434	</desc>
14435	</method>
14436	</interface>
14437
14438	<interface
14439	name="IExtPackManager" extends="$unknown"
14440	uuid="70d808a9-176f-4d45-adad-7c509b8309b3"
14441	wsmap="suppress"
14442	>
14443	<desc>
14444	Interface for managing VirtualBox Extension Packs.
14445
14446	TODO: Describe extension packs, how they are managed and how to create
14447	one.
14448	</desc>
14449
14450	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14451	<desc>
14452	List of the installed extension packs.
14453	</desc>
14454	</attribute>
14455
14456	<method name="find">
14457	<desc>
14458	Returns the extension pack with the specified name if found.
14459
14460	<result name="VBOX_E_OBJECT_NOT_FOUND">
14461	No extension pack matching @a name was found.
14462	</result>
14463	</desc>
14464	<param name="name" type="wstring" dir="in">
14465	<desc>The name of the extension pack to locate.</desc>
14466	</param>
14467	<param name="returnData" type="IExtPack" dir="return">
14468	<desc>The extension pack if found.</desc>
14469	</param>
14470	</method>
14471
14472	<method name="openExtPackFile">
14473	<desc>
14474	Attempts to open an extension pack file in preparation for
14475	installation.
14476	</desc>
14477	<param name="path" type="wstring" dir="in">
14478	<desc>The path of the extension pack tarball.</desc>
14479	</param>
14480	<param name="file" type="IExtPackFile" dir="return">
14481	<desc>The interface of the extension pack file object.</desc>
14482	</param>
14483	</method>
14484
14485	<method name="uninstall">
14486	<desc>Uninstalls an extension pack, removing all related files.</desc>
14487	<param name="name" type="wstring" dir="in">
14488	<desc>The name of the extension pack to uninstall.</desc>
14489	</param>
14490	<param name="forcedRemoval" type="boolean" dir="in">
14491	<desc>
14492	Forced removal of the extension pack. This means that the uninstall
14493	hook will not be called.
14494	</desc>
14495	</param>
14496	</method>
14497
14498	<method name="cleanup">
14499	<desc>Cleans up failed installs and uninstalls</desc>
14500	</method>
14501
14502	<method name="QueryAllPlugInsForFrontend">
14503	<desc>
14504	Gets the path to all the plug-in modules for a given frontend.
14505
14506	This is a convenience method that is intended to simplify the plug-in
14507	loading process for a frontend.
14508	</desc>
14509	<param name="frontendName" type="wstring" dir="in">
14510	<desc>The name of the frontend or component.</desc>
14511	</param>
14512	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
14513	<desc>Array containing the plug-in modules (full paths).</desc>
14514	</param>
14515	</method>
14516
14517	</interface>
14518
14519	<!--
14520	// BandwidthGroupType
14521	/////////////////////////////////////////////////////////////////////////
14522	-->
14523	<enum
14524	name="BandwidthGroupType"
14525	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
14526
14527	<desc>
14528	Type of a bandwidth control group.
14529	</desc>
14530
14531	<const name="Null" value="0">
14532	<desc>
14533	Null type, must be first.
14534	</desc>
14535	</const>
14536
14537	<const name="Disk" value="1">
14538	<desc>
14539	The bandwidth group controls disk I/O.
14540	</desc>
14541	</const>
14542
14543	<const name="Network" value="2">
14544	<desc>
14545	The bandwidth group controls network I/O.
14546	</desc>
14547	</const>
14548
14549	</enum>
14550
14551	<!--
14552	// IBandwidthGroup
14553	/////////////////////////////////////////////////////////////////////////
14554	-->
14555	<interface
14556	name="IBandwidthGroup" extends="$unknown"
14557	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
14558	wsmap="managed"
14559	>
14560	<desc>Represents one bandwidth group.</desc>
14561
14562	<attribute name="name" type="wstring" readonly="yes">
14563	<desc>Name of the group.</desc>
14564	</attribute>
14565
14566	<attribute name="type" type="BandwidthGroupType" readonly="yes">
14567	<desc>Type of the group.</desc>
14568	</attribute>
14569
14570	<attribute name="reference" type="unsigned long" readonly="yes">
14571	<desc>How many devices/medium attachements use this group.</desc>
14572	</attribute>
14573
14574	<attribute name="maxMbPerSec" type="unsigned long">
14575	<desc>The maximum number of MB which can be transfered by all
14576	entities attached to this group during one second.</desc>
14577	</attribute>
14578
14579	</interface>
14580
14581	<!--
14582	// IBandwidthControl
14583	/////////////////////////////////////////////////////////////////////////
14584	-->
14585	<interface
14586	name="IBandwidthControl" extends="$unknown"
14587	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
14588	wsmap="managed"
14589	>
14590	<desc>
14591	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
14592	This includes network and disk I/O.
14593	</desc>
14594
14595	<attribute name="numGroups" type="unsigned long" readonly="yes">
14596	<desc>
14597	The current number of existing bandwidth groups managed.
14598	</desc>
14599	</attribute>
14600
14601	<method name="CreateBandwidthGroup">
14602	<desc>
14603	Creates a new bandwidth group.
14604	</desc>
14605
14606	<param name="name" type="wstring" dir="in">
14607	<desc>Name of the bandwidth group.</desc>
14608	</param>
14609	<param name="type" type="BandwidthGroupType" dir="in">
14610	<desc>The type of the bandwidth group (network or disk).</desc>
14611	</param>
14612	<param name="maxBytesPerSec" type="unsigned long" dir="in">
14613	<desc>The maximum number of bytes which can be transfered by all
14614	entities attached to this group during one second.</desc>
14615	</param>
14616	</method>
14617
14618	<method name="DeleteBandwidthGroup">
14619	<desc>
14620	Deletes a new bandwidth group.
14621	</desc>
14622
14623	<param name="name" type="wstring" dir="in">
14624	<desc>Name of the bandwidth group to delete.</desc>
14625	</param>
14626	</method>
14627
14628	<method name="GetBandwidthGroup" const="yes">
14629	<desc>
14630	Get a bandwidth group by name.
14631	</desc>
14632
14633	<param name="name" type="wstring" dir="in">
14634	<desc>Name of the bandwidth group to get.</desc>
14635	</param>
14636	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
14637	<desc>Where to store the bandwidth group on success.</desc>
14638	</param>
14639	</method>
14640
14641	<method name="GetAllBandwidthGroups" const="yes">
14642	<desc>
14643	Get all managed bandwidth groups.
14644	</desc>
14645
14646	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
14647	<desc>The array of managed bandwidth groups.</desc>
14648	</param>
14649	</method>
14650	</interface>
14651
14652	<!--
14653	// IVirtualBoxClient
14654	/////////////////////////////////////////////////////////////////////////
14655	-->
14656
14657	<interface
14658	name="IVirtualBoxClient" extends="$unknown"
14659	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
14660	wsmap="suppress"
14661	>
14662	<desc>
14663	Convenience interface for client applications. Treat this as a
14664	singleton, i.e. never create more than one instance of this interface.
14665
14666	At the moment only available for clients of the local API (not usable
14667	via the webservice). Once the session logic is redesigned this might
14668	change.
14669	</desc>
14670
14671	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
14672	<desc>
14673	Reference to the server-side API root object.
14674	</desc>
14675	</attribute>
14676
14677	<attribute name="session" type="ISession" readonly="yes">
14678	<desc>
14679	Create a new session object and return the reference to it.
14680	</desc>
14681	</attribute>
14682
14683	<attribute name="eventSource" type="IEventSource" readonly="yes">
14684	<desc>
14685	Event source for VirtualBoxClient events.
14686	</desc>
14687	</attribute>
14688
14689	</interface>
14690
14691	<!--
14692	// Events
14693	/////////////////////////////////////////////////////////////////////////
14694	-->
14695	<enum
14696	name="VBoxEventType"
14697	uuid="c9412a17-c1e1-46db-b4b7-18de9c967e85"
14698	>
14699
14700	<desc>
14701	Type of an event.
14702	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14703	</desc>
14704
14705	<const name="Invalid" value="0">
14706	<desc>
14707	Invalid event, must be first.
14708	</desc>
14709	</const>
14710
14711	<const name="Any" value="1">
14712	<desc>
14713	Wildcard for all events.
14714	Events of this type are never delivered, and only used in
14715	registerListener() call to simplify registration.
14716	</desc>
14717	</const>
14718
14719	<const name="Vetoable" value="2">
14720	<desc>
14721	Wildcard for all vetoable events. Events of this type are never delivered, and only
14722	used in registerListener() call to simplify registration.
14723	</desc>
14724	</const>
14725
14726	<const name="MachineEvent" value="3">
14727	<desc>
14728	Wildcard for all machine events. Events of this type are never delivered, and only used in
14729	registerListener() call to simplify registration.
14730	</desc>
14731	</const>
14732
14733	<const name="SnapshotEvent" value="4">
14734	<desc>
14735	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14736	registerListener() call to simplify registration.
14737	</desc>
14738	</const>
14739
14740	<const name="InputEvent" value="5">
14741	<desc>
14742	Wildcard for all input device (keyboard, mouse) events.
14743	Events of this type are never delivered, and only used in
14744	registerListener() call to simplify registration.
14745	</desc>
14746	</const>
14747
14748	<const name="LastWildcard" value="31">
14749	<desc>
14750	Last wildcard.
14751	</desc>
14752	</const>
14753
14754	<const name="OnMachineStateChanged" value="32">
14755	<desc>
14756	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14757	</desc>
14758	</const>
14759	<const name="OnMachineDataChanged" value="33">
14760	<desc>
14761	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14762	</desc>
14763	</const>
14764	<const name="OnExtraDataChanged" value="34">
14765	<desc>
14766	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14767	</desc>
14768	</const>
14769	<const name="OnExtraDataCanChange" value="35">
14770	<desc>
14771	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14772	</desc>
14773	</const>
14774	<const name="OnMediumRegistered" value="36">
14775	<desc>
14776	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14777	</desc>
14778	</const>
14779	<const name="OnMachineRegistered" value="37">
14780	<desc>
14781	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14782	</desc>
14783	</const>
14784	<const name="OnSessionStateChanged" value="38">
14785	<desc>
14786	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14787	</desc>
14788	</const>
14789	<const name="OnSnapshotTaken" value="39">
14790	<desc>
14791	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14792	</desc>
14793	</const>
14794	<const name="OnSnapshotDeleted" value="40">
14795	<desc>
14796	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14797	</desc>
14798	</const>
14799	<const name="OnSnapshotChanged" value="41">
14800	<desc>
14801	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14802	</desc>
14803	</const>
14804	<const name="OnGuestPropertyChanged" value="42">
14805	<desc>
14806	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14807	</desc>
14808	</const>
14809	<!-- Console events -->
14810	<const name="OnMousePointerShapeChanged" value="43">
14811	<desc>
14812	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14813	</desc>
14814	</const>
14815	<const name="OnMouseCapabilityChanged" value="44">
14816	<desc>
14817	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14818	</desc>
14819	</const>
14820	<const name="OnKeyboardLedsChanged" value="45">
14821	<desc>
14822	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14823	</desc>
14824	</const>
14825	<const name="OnStateChanged" value="46">
14826	<desc>
14827	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14828	</desc>
14829	</const>
14830	<const name="OnAdditionsStateChanged" value="47">
14831	<desc>
14832	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14833	</desc>
14834	</const>
14835	<const name="OnNetworkAdapterChanged" value="48">
14836	<desc>
14837	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14838	</desc>
14839	</const>
14840	<const name="OnSerialPortChanged" value="49">
14841	<desc>
14842	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14843	</desc>
14844	</const>
14845	<const name="OnParallelPortChanged" value="50">
14846	<desc>
14847	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14848	</desc>
14849	</const>
14850	<const name="OnStorageControllerChanged" value="51">
14851	<desc>
14852	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14853	</desc>
14854	</const>
14855	<const name="OnMediumChanged" value="52">
14856	<desc>
14857	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14858	</desc>
14859	</const>
14860	<const name="OnVRDEServerChanged" value="53">
14861	<desc>
14862	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14863	</desc>
14864	</const>
14865	<const name="OnUSBControllerChanged" value="54">
14866	<desc>
14867	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14868	</desc>
14869	</const>
14870	<const name="OnUSBDeviceStateChanged" value="55">
14871	<desc>
14872	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14873	</desc>
14874	</const>
14875	<const name="OnSharedFolderChanged" value="56">
14876	<desc>
14877	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14878	</desc>
14879	</const>
14880	<const name="OnRuntimeError" value="57">
14881	<desc>
14882	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14883	</desc>
14884	</const>
14885	<const name="OnCanShowWindow" value="58">
14886	<desc>
14887	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14888	</desc>
14889	</const>
14890	<const name="OnShowWindow" value="59">
14891	<desc>
14892	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14893	</desc>
14894	</const>
14895	<const name="OnCPUChanged" value="60">
14896	<desc>
14897	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14898	</desc>
14899	</const>
14900	<const name="OnVRDEServerInfoChanged" value="61">
14901	<desc>
14902	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14903	</desc>
14904	</const>
14905	<const name="OnEventSourceChanged" value="62">
14906	<desc>
14907	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14908	</desc>
14909	</const>
14910	<const name="OnCPUExecutionCapChanged" value="63">
14911	<desc>
14912	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14913	</desc>
14914	</const>
14915	<const name="OnGuestKeyboard" value="64">
14916	<desc>
14917	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14918	</desc>
14919	</const>
14920	<const name="OnGuestMouse" value="65">
14921	<desc>
14922	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14923	</desc>
14924	</const>
14925	<const name="OnNATRedirect" value="66">
14926	<desc>
14927	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
14928	</desc>
14929	</const>
14930	<const name="OnHostPciDevicePlug" value="67">
14931	<desc>
14932	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
14933	</desc>
14934	</const>
14935	<const name="OnVBoxSVCUnavailable" value="68">
14936	<desc>
14937	See <link to="IVBoxSVCUnavailableEvent">IVBoxSVCUnavailableEvent</link>.
14938	</desc>
14939	</const>
14940	<const name="OnBandwidthGroupChanged" value="69">
14941	<desc>
14942	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
14943	</desc>
14944	</const>
14945
14946	<!-- Last event marker -->
14947	<const name="Last" value="70">
14948	<desc>
14949	Must be last event, used for iterations and structures relying on numerical event values.
14950	</desc>
14951	</const>
14952
14953	</enum>
14954
14955	<interface
14956	name="IEventSource" extends="$unknown"
14957	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14958	wsmap="managed"
14959	>
14960	<desc>
14961	Event source. Generally, any object which could generate events can be an event source,
14962	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14963	an event source can work with listeners in either active or passive mode. In active mode it is up to
14964	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14965	event source keeps track of pending events for each listener and returns available events on demand.
14966
14967	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14968	</desc>
14969
14970	<method name="createListener">
14971	<desc>
14972	Creates a new listener object, useful for passive mode.
14973	</desc>
14974	<param name="listener" type="IEventListener" dir="return"/>
14975	</method>
14976
14977	<method name="createAggregator">
14978	<desc>
14979	Creates an aggregator event source, collecting events from multiple sources.
14980	This way a single listener can listen for events coming from multiple sources,
14981	using a single blocking getEvent() on the returned aggregator.
14982	</desc>
14983	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14984	<desc>
14985	Subordinate event source this one aggregatres.
14986	</desc>
14987	</param>
14988	<param name="result" type="IEventSource" dir="return"/>
14989	</method>
14990
14991	<method name="registerListener">
14992	<desc>
14993	Register an event listener.
14994
14995	<note>
14996	To avoid system overload, the VirtualBox server process checks if passive event
14997	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14998	current implementation, if more than 500 pending events are detected for a passive
14999	event listener, it is forcefully unregistered by the system, and further
15000	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15001	</note>
15002	</desc>
15003	<param name="listener" type="IEventListener" dir="in">
15004	<desc>Listener to register.</desc>
15005	</param>
15006	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15007	<desc>
15008	Event types listener is interested in. One can use wildcards like -
15009	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15010	than one event.
15011	</desc>
15012	</param>
15013	<param name="active" type="boolean" dir="in">
15014	<desc>
15015	Which mode this listener is operating in.
15016	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15017	In passive mode, an internal event queue is created for this this IEventListener.
15018	For each event coming in, it is added to queues for all interested registered passive
15019	listeners. It is then up to the external code to call the listener's
15020	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15021	external code must call <link to="#eventProcessed" />.
15022	</desc>
15023	</param>
15024	</method>
15025
15026	<method name="unregisterListener">
15027	<desc>
15028	Unregister an event listener. If listener is passive, and some waitable events are still
15029	in queue they are marked as processed automatically.
15030	</desc>
15031	<param name="listener" type="IEventListener" dir="in">
15032	<desc>Listener to unregister.</desc>
15033	</param>
15034	</method>
15035
15036	<method name="fireEvent">
15037	<desc>
15038	Fire an event for this source.
15039	</desc>
15040	<param name="event" type="IEvent" dir="in">
15041	<desc>Event to deliver.</desc>
15042	</param>
15043	<param name="timeout" type="long" dir="in">
15044	<desc>
15045	Maximum time to wait for event processing (if event is waitable), in ms;
15046	0 = no wait, -1 = indefinite wait.
15047	</desc>
15048	</param>
15049	<param name="result" type="boolean" dir="return">
15050	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15051	</param>
15052	</method>
15053
15054	<method name="getEvent">
15055	<desc>
15056	Get events from this peer's event queue (for passive mode). Calling this method
15057	regularly is required for passive event listeners to avoid system overload;
15058	see <link to="IEventSource::registerListener" /> for details.
15059
15060	<result name="VBOX_E_OBJECT_NOT_FOUND">
15061	Listener is not registered, or autounregistered.
15062	</result>
15063	</desc>
15064	<param name="listener" type="IEventListener" dir="in">
15065	<desc>Which listener to get data for.</desc>
15066	</param>
15067	<param name="timeout" type="long" dir="in">
15068	<desc>
15069	Maximum time to wait for events, in ms;
15070	0 = no wait, -1 = indefinite wait.
15071	</desc>
15072	</param>
15073	<param name="event" type="IEvent" dir="return">
15074	<desc>Event retrieved, or null if none available.</desc>
15075	</param>
15076	</method>
15077
15078	<method name="eventProcessed">
15079	<desc>
15080	Must be called for waitable events after a particular listener finished its
15081	event processing. When all listeners of a particular event have called this
15082	method, the system will then call <link to="IEvent::setProcessed" />.
15083	</desc>
15084	<param name="listener" type="IEventListener" dir="in">
15085	<desc>Which listener processed event.</desc>
15086	</param>
15087	<param name="event" type="IEvent" dir="in">
15088	<desc>Which event.</desc>
15089	</param>
15090	</method>
15091
15092	</interface>
15093
15094	<interface
15095	name="IEventListener" extends="$unknown"
15096	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15097	wsmap="managed"
15098	>
15099	<desc>
15100	Event listener. An event listener can work in either active or passive mode, depending on the way
15101	it was registered.
15102	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15103	</desc>
15104
15105	<method name="handleEvent">
15106	<desc>
15107	Handle event callback for active listeners. It is not called for passive listeners. After
15108	calling handleEvent() on all active listeners and having received acknowledgement from all
15109	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15110	IEvent::waitProcessed() will return immediately.
15111	</desc>
15112	<param name="event" type="IEvent" dir="in">
15113	<desc>Event available.</desc>
15114	</param>
15115	</method>
15116
15117	</interface>
15118
15119	<interface
15120	name="IEvent" extends="$unknown"
15121	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15122	wsmap="managed"
15123	>
15124	<desc>
15125	Abstract parent interface for VirtualBox events. Actual events will typically implement
15126	a more specific interface which derives from this (see below).
15127
15128	<b>Introduction to VirtualBox events</b>
15129
15130	Generally speaking, an event (represented by this interface) signals that something
15131	happened, while an event listener (see <link to="IEventListener" />) represents an
15132	entity that is interested in certain events. In order for this to work with
15133	unidirectional protocols (i.e. web services), the concepts of passive and active
15134	listener are used.
15135
15136	Event consumers can register themselves as listeners, providing an array of
15137	events they are interested in (see <link to="IEventSource::registerListener" />).
15138	When an event triggers, the listener is notified about the event. The exact
15139	mechanism of the notification depends on whether the listener was registered as
15140	an active or passive listener:
15141
15142	<ul>
15143	<li>An active listener is very similar to a callback: it is a function invoked
15144	by the API. As opposed to the callbacks that were used in the API before
15145	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15146	</li>
15147
15148	<li>Passive listeners are somewhat trickier to implement, but do not require
15149	a client function to be callable, which is not an option with scripting
15150	languages or web service clients. Internally the <link to="IEventSource" />
15151	implementation maintains an event queue for each passive listener, and
15152	newly arrived events are put in this queue. When the listener calls
15153	<link to="IEventSource::getEvent"/>, first element from its internal event
15154	queue is returned. When the client completes processing of an event,
15155	the <link to="IEventSource::eventProcessed" /> function must be called,
15156	acknowledging that the event was processed. It supports implementing
15157	waitable events. On passive listener unregistration, all events from its
15158	queue are auto-acknowledged.
15159	</li>
15160	</ul>
15161
15162	Waitable events are useful in situations where the event generator wants to track
15163	delivery or a party wants to wait until all listeners have completed the event. A
15164	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15165	listeners might veto a certain action, and thus the event producer has to make
15166	sure that all listeners have processed the event and not vetoed before taking
15167	the action.
15168
15169	A given event may have both passive and active listeners at the same time.
15170
15171	<b>Using events</b>
15172
15173	Any VirtualBox object capable of producing externally visible events provides an
15174	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15175	This event source object is notified by VirtualBox once something has happened, so
15176	consumers may register event listeners with this event source. To register a listener,
15177	an object implementing the <link to="IEventListener" /> interface must be provided.
15178	For active listeners, such an object is typically created by the consumer, while for
15179	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15180	note that a listener created with @c createListener() must not be used as an active listener.
15181
15182	Once created, the listener must be registered to listen for the desired events
15183	(see <link to="IEventSource::registerListener" />), providing an array of
15184	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15185	event IDs or wildcards matching multiple event IDs.
15186
15187	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15188	called automatically when the event is triggered, while passive listeners have to call
15189	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15190	an event processing loop.
15191
15192	The IEvent interface is an abstract parent interface for all such VirtualBox events
15193	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15194	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15195	then cast to the appropriate specific interface using @c QueryInterface().
15196	</desc>
15197
15198	<attribute name="type" readonly="yes" type="VBoxEventType">
15199	<desc>
15200	Event type.
15201	</desc>
15202	</attribute>
15203
15204	<attribute name="source" readonly="yes" type="IEventSource">
15205	<desc>
15206	Source of this event.
15207	</desc>
15208	</attribute>
15209
15210	<attribute name="waitable" readonly="yes" type="boolean">
15211	<desc>
15212	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15213	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15214	as no additional overhead associated with waitability imposed.
15215	Waitable events are needed when one need to be able to wait for particular event processed,
15216	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15217	until all consumers confirmed events.
15218	</desc>
15219	</attribute>
15220
15221	<method name="setProcessed">
15222	<desc>
15223	Internal method called by the system when all listeners of a particular event have called
15224	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15225	</desc>
15226	</method>
15227
15228	<method name="waitProcessed">
15229	<desc>
15230	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15231	described semantics, for non-waitable returns true immediately.
15232	</desc>
15233	<param name="timeout" type="long" dir="in">
15234	<desc>
15235	Maximum time to wait for event processeing, in ms;
15236	0 = no wait, -1 = indefinite wait.
15237	</desc>
15238	</param>
15239	<param name="result" type="boolean" dir="return">
15240	<desc>If this event was processed before timeout.</desc>
15241	</param>
15242	</method>
15243	</interface>
15244
15245
15246	<interface
15247	name="IReusableEvent" extends="IEvent"
15248	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15249	wsmap="managed"
15250	>
15251	<desc>Base abstract interface for all reusable events.</desc>
15252
15253	<attribute name="generation" readonly="yes" type="unsigned long">
15254	<desc>Current generation of event, incremented on reuse.</desc>
15255	</attribute>
15256
15257	<method name="reuse">
15258	<desc>
15259	Marks an event as reused, increments 'generation', fields shall no
15260	longer be considered valid.
15261	</desc>
15262	</method>
15263	</interface>
15264
15265	<interface
15266	name="IMachineEvent" extends="IEvent"
15267	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15268	wsmap="managed" id="MachineEvent"
15269	>
15270	<desc>Base abstract interface for all machine events.</desc>
15271
15272	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15273	<desc>ID of the machine this event relates to.</desc>
15274	</attribute>
15275
15276	</interface>
15277
15278	<interface
15279	name="IMachineStateChangedEvent" extends="IMachineEvent"
15280	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15281	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15282	>
15283	<desc>Machine state change event.</desc>
15284
15285	<attribute name="state" readonly="yes" type="MachineState">
15286	<desc>New execution state.</desc>
15287	</attribute>
15288	</interface>
15289
15290	<interface
15291	name="IMachineDataChangedEvent" extends="IMachineEvent"
15292	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15293	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15294	>
15295	<desc>
15296	Any of the settings of the given machine has changed.
15297	</desc>
15298	</interface>
15299
15300	<interface
15301	name="IMediumRegisteredEvent" extends="IEvent"
15302	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15303	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15304	>
15305	<desc>
15306	The given medium was registered or unregistered
15307	within this VirtualBox installation.
15308	</desc>
15309
15310	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15311	<desc>ID of the medium this event relates to.</desc>
15312	</attribute>
15313
15314	<attribute name="mediumType" readonly="yes" type="DeviceType">
15315	<desc>Type of the medium this event relates to.</desc>
15316	</attribute>
15317
15318	<attribute name="registered" type="boolean" readonly="yes">
15319	<desc>
15320	If @c true, the medium was registered, otherwise it was
15321	unregistered.
15322	</desc>
15323	</attribute>
15324	</interface>
15325
15326	<interface
15327	name="IMachineRegisteredEvent" extends="IMachineEvent"
15328	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15329	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15330	>
15331	<desc>
15332	The given machine was registered or unregistered
15333	within this VirtualBox installation.
15334	</desc>
15335
15336	<attribute name="registered" type="boolean" readonly="yes">
15337	<desc>
15338	If @c true, the machine was registered, otherwise it was
15339	unregistered.
15340	</desc>
15341	</attribute>
15342	</interface>
15343
15344	<interface
15345	name="ISessionStateChangedEvent" extends="IMachineEvent"
15346	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15347	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15348	>
15349	<desc>
15350	The state of the session for the given machine was changed.
15351	<see>IMachine::sessionState</see>
15352	</desc>
15353
15354	<attribute name="state" type="SessionState" readonly="yes">
15355	<desc>
15356	New session state.
15357	</desc>
15358	</attribute>
15359	</interface>
15360
15361	<interface
15362	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15363	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15364	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15365	>
15366	<desc>
15367	Notification when a guest property has changed.
15368	</desc>
15369
15370	<attribute name="name" readonly="yes" type="wstring">
15371	<desc>
15372	The name of the property that has changed.
15373	</desc>
15374	</attribute>
15375
15376	<attribute name="value" readonly="yes" type="wstring">
15377	<desc>
15378	The new property value.
15379	</desc>
15380	</attribute>
15381
15382	<attribute name="flags" readonly="yes" type="wstring">
15383	<desc>
15384	The new property flags.
15385	</desc>
15386	</attribute>
15387
15388	</interface>
15389
15390	<interface
15391	name="ISnapshotEvent" extends="IMachineEvent"
15392	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
15393	wsmap="managed" id="SnapshotEvent"
15394	>
15395	<desc>Base interface for all snapshot events.</desc>
15396
15397	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
15398	<desc>ID of the snapshot this event relates to.</desc>
15399	</attribute>
15400
15401	</interface>
15402
15403	<interface
15404	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
15405	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
15406	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
15407	>
15408	<desc>
15409	A new snapshot of the machine has been taken.
15410	<see>ISnapshot</see>
15411	</desc>
15412	</interface>
15413
15414	<interface
15415	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
15416	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
15417	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
15418	>
15419	<desc>
15420	Snapshot of the given machine has been deleted.
15421
15422	<note>
15423	This notification is delivered <b>after</b> the snapshot
15424	object has been uninitialized on the server (so that any
15425	attempt to call its methods will return an error).
15426	</note>
15427
15428	<see>ISnapshot</see>
15429	</desc>
15430	</interface>
15431
15432	<interface
15433	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
15434	uuid="07541941-8079-447a-a33e-47a69c7980db"
15435	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
15436	>
15437	<desc>
15438	Snapshot properties (name and/or description) have been changed.
15439	<see>ISnapshot</see>
15440	</desc>
15441	</interface>
15442
15443	<interface
15444	name="IMousePointerShapeChangedEvent" extends="IEvent"
15445	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
15446	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
15447	>
15448	<desc>
15449	Notification when the guest mouse pointer shape has
15450	changed. The new shape data is given.
15451	</desc>
15452
15453	<attribute name="visible" type="boolean" readonly="yes">
15454	<desc>
15455	Flag whether the pointer is visible.
15456	</desc>
15457	</attribute>
15458	<attribute name="alpha" type="boolean" readonly="yes">
15459	<desc>
15460	Flag whether the pointer has an alpha channel.
15461	</desc>
15462	</attribute>
15463	<attribute name="xhot" type="unsigned long" readonly="yes">
15464	<desc>
15465	The pointer hot spot X coordinate.
15466	</desc>
15467	</attribute>
15468	<attribute name="yhot" type="unsigned long" readonly="yes">
15469	<desc>
15470	The pointer hot spot Y coordinate.
15471	</desc>
15472	</attribute>
15473	<attribute name="width" type="unsigned long" readonly="yes">
15474	<desc>
15475	Width of the pointer shape in pixels.
15476	</desc>
15477	</attribute>
15478	<attribute name="height" type="unsigned long" readonly="yes">
15479	<desc>
15480	Height of the pointer shape in pixels.
15481	</desc>
15482	</attribute>
15483	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
15484	<desc>
15485	Shape buffer arrays.
15486
15487	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
15488	followed by a 32-bpp XOR (color) mask.
15489
15490	For pointers without alpha channel the XOR mask pixels are 32
15491	bit values: (lsb)BGR0(msb). For pointers with alpha channel
15492	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
15493
15494	An AND mask is used for pointers with alpha channel, so if the
15495	callback does not support alpha, the pointer could be
15496	displayed as a normal color pointer.
15497
15498	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
15499	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
15500	height</tt>. The padding bits at the end of each scanline are
15501	undefined.
15502
15503	The XOR mask follows the AND mask on the next 4-byte aligned
15504	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
15505	Bytes in the gap between the AND and the XOR mask are undefined.
15506	The XOR mask scanlines have no gap between them and the size of
15507	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
15508
15509	<note>
15510	If @a shape is 0, only the pointer visibility is changed.
15511	</note>
15512	</desc>
15513	</attribute>
15514	</interface>
15515
15516	<interface
15517	name="IMouseCapabilityChangedEvent" extends="IEvent"
15518	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
15519	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
15520	>
15521	<desc>
15522	Notification when the mouse capabilities reported by the
15523	guest have changed. The new capabilities are passed.
15524	</desc>
15525	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
15526	<desc>
15527	Supports absolute coordinates.
15528	</desc>
15529	</attribute>
15530	<attribute name="supportsRelative" type="boolean" readonly="yes">
15531	<desc>
15532	Supports relative coordinates.
15533	</desc>
15534	</attribute>
15535	<attribute name="needsHostCursor" type="boolean" readonly="yes">
15536	<desc>
15537	If host cursor is needed.
15538	</desc>
15539	</attribute>
15540	</interface>
15541
15542	<interface
15543	name="IKeyboardLedsChangedEvent" extends="IEvent"
15544	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
15545	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
15546	>
15547	<desc>
15548	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
15549	to alter the state of the keyboard LEDs.
15550	</desc>
15551	<attribute name="numLock" type="boolean" readonly="yes">
15552	<desc>
15553	NumLock status.
15554	</desc>
15555	</attribute>
15556	<attribute name="capsLock" type="boolean" readonly="yes">
15557	<desc>
15558	CapsLock status.
15559	</desc>
15560	</attribute>
15561	<attribute name="scrollLock" type="boolean" readonly="yes">
15562	<desc>
15563	ScrollLock status.
15564	</desc>
15565	</attribute>
15566	</interface>
15567
15568	<interface
15569	name="IStateChangedEvent" extends="IEvent"
15570	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
15571	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
15572	>
15573	<desc>
15574	Notification when the execution state of the machine has changed.
15575	The new state is given.
15576	</desc>
15577	<attribute name="state" type="MachineState" readonly="yes">
15578	<desc>
15579	New machine state.
15580	</desc>
15581	</attribute>
15582	</interface>
15583
15584	<interface
15585	name="IAdditionsStateChangedEvent" extends="IEvent"
15586	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
15587	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
15588	>
15589	<desc>
15590	Notification when a Guest Additions property changes.
15591	Interested callees should query IGuest attributes to
15592	find out what has changed.
15593	</desc>
15594	</interface>
15595
15596	<interface
15597	name="INetworkAdapterChangedEvent" extends="IEvent"
15598	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
15599	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
15600	>
15601	<desc>
15602	Notification when a property of one of the
15603	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
15604	changes. Interested callees should use INetworkAdapter methods and
15605	attributes to find out what has changed.
15606	</desc>
15607	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
15608	<desc>
15609	Network adapter that is subject to change.
15610	</desc>
15611	</attribute>
15612	</interface>
15613
15614	<interface
15615	name="ISerialPortChangedEvent" extends="IEvent"
15616	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
15617	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
15618	>
15619	<desc>
15620	Notification when a property of one of the
15621	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
15622	Interested callees should use ISerialPort methods and attributes
15623	to find out what has changed.
15624	</desc>
15625	<attribute name="serialPort" type="ISerialPort" readonly="yes">
15626	<desc>
15627	Serial port that is subject to change.
15628	</desc>
15629	</attribute>
15630	</interface>
15631
15632	<interface
15633	name="IParallelPortChangedEvent" extends="IEvent"
15634	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15635	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15636	>
15637	<desc>
15638	Notification when a property of one of the
15639	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15640	changes. Interested callees should use ISerialPort methods and
15641	attributes to find out what has changed.
15642	</desc>
15643	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15644	<desc>
15645	Parallel port that is subject to change.
15646	</desc>
15647	</attribute>
15648	</interface>
15649
15650	<interface
15651	name="IStorageControllerChangedEvent" extends="IEvent"
15652	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15653	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15654	>
15655	<desc>
15656	Notification when a
15657	<link to="IMachine::mediumAttachments">medium attachment</link>
15658	changes.
15659	</desc>
15660	</interface>
15661
15662	<interface
15663	name="IMediumChangedEvent" extends="IEvent"
15664	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15665	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15666	>
15667	<desc>
15668	Notification when a
15669	<link to="IMachine::mediumAttachments">medium attachment</link>
15670	changes.
15671	</desc>
15672	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15673	<desc>
15674	Medium attachment that is subject to change.
15675	</desc>
15676	</attribute>
15677	</interface>
15678
15679	<interface
15680	name="ICPUChangedEvent" extends="IEvent"
15681	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15682	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15683	>
15684	<desc>
15685	Notification when a CPU changes.
15686	</desc>
15687	<attribute name="cpu" type="unsigned long" readonly="yes">
15688	<desc>
15689	The CPU which changed.
15690	</desc>
15691	</attribute>
15692	<attribute name="add" type="boolean" readonly="yes">
15693	<desc>
15694	Flag whether the CPU was added or removed.
15695	</desc>
15696	</attribute>
15697	</interface>
15698
15699	<interface
15700	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15701	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15702	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15703	>
15704	<desc>
15705	Notification when the CPU execution cap changes.
15706	</desc>
15707	<attribute name="executionCap" type="unsigned long" readonly="yes">
15708	<desc>
15709	The new CPU execution cap value. (1-100)
15710	</desc>
15711	</attribute>
15712	</interface>
15713
15714	<interface
15715	name="IGuestKeyboardEvent" extends="IEvent"
15716	uuid="88394258-7006-40d4-b339-472ee3801844"
15717	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
15718	>
15719	<desc>
15720	Notification when guest keyboard event happens.
15721	</desc>
15722	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15723	<desc>
15724	Array of scancodes.
15725	</desc>
15726	</attribute>
15727	</interface>
15728
15729	<interface
15730	name="IGuestMouseEvent" extends="IReusableEvent"
15731	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15732	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
15733	>
15734	<desc>
15735	Notification when guest mouse event happens.
15736	</desc>
15737
15738	<attribute name="absolute" type="boolean" readonly="yes">
15739	<desc>
15740	If this event is relative or absolute.
15741	</desc>
15742	</attribute>
15743
15744	<attribute name="x" type="long" readonly="yes">
15745	<desc>
15746	New X position, or X delta.
15747	</desc>
15748	</attribute>
15749
15750	<attribute name="y" type="long" readonly="yes">
15751	<desc>
15752	New Y position, or Y delta.
15753	</desc>
15754	</attribute>
15755
15756	<attribute name="z" type="long" readonly="yes">
15757	<desc>
15758	Z delta.
15759	</desc>
15760	</attribute>
15761
15762	<attribute name="w" type="long" readonly="yes">
15763	<desc>
15764	W delta.
15765	</desc>
15766	</attribute>
15767
15768	<attribute name="buttons" type="long" readonly="yes">
15769	<desc>
15770	Button state bitmask.
15771	</desc>
15772	</attribute>
15773
15774	</interface>
15775
15776
15777	<interface
15778	name="IVRDEServerChangedEvent" extends="IEvent"
15779	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15780	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15781	>
15782	<desc>
15783	Notification when a property of the
15784	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15785	Interested callees should use IVRDEServer methods and attributes to
15786	find out what has changed.
15787	</desc>
15788	</interface>
15789
15790	<interface
15791	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15792	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15793	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15794	>
15795	<desc>
15796	Notification when the status of the VRDE server changes. Interested callees
15797	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15798	attributes to find out what is the current status.
15799	</desc>
15800	</interface>
15801
15802	<interface
15803	name="IUSBControllerChangedEvent" extends="IEvent"
15804	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15805	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15806	>
15807	<desc>
15808	Notification when a property of the virtual
15809	<link to="IMachine::USBController">USB controller</link> changes.
15810	Interested callees should use IUSBController methods and attributes to
15811	find out what has changed.
15812	</desc>
15813	</interface>
15814
15815	<interface
15816	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15817	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15818	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15819	>
15820	<desc>
15821	Notification when a USB device is attached to or detached from
15822	the virtual USB controller.
15823
15824	This notification is sent as a result of the indirect
15825	request to attach the device because it matches one of the
15826	machine USB filters, or as a result of the direct request
15827	issued by <link to="IConsole::attachUSBDevice"/> or
15828	<link to="IConsole::detachUSBDevice"/>.
15829
15830	This notification is sent in case of both a succeeded and a
15831	failed request completion. When the request succeeds, the
15832	@a error parameter is @c null, and the given device has been
15833	already added to (when @a attached is @c true) or removed from
15834	(when @a attached is @c false) the collection represented by
15835	<link to="IConsole::USBDevices"/>. On failure, the collection
15836	doesn't change and the @a error parameter represents the error
15837	message describing the failure.
15838	</desc>
15839	<attribute name="device" type="IUSBDevice" readonly="yes">
15840	<desc>
15841	Device that is subject to state change.
15842	</desc>
15843	</attribute>
15844	<attribute name="attached" type="boolean" readonly="yes">
15845	<desc>
15846	@c true if the device was attached and @c false otherwise.
15847	</desc>
15848	</attribute>
15849	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15850	<desc>
15851	@c null on success or an error message object on failure.
15852	</desc>
15853	</attribute>
15854	</interface>
15855
15856	<interface
15857	name="ISharedFolderChangedEvent" extends="IEvent"
15858	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15859	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15860	>
15861	<desc>
15862	Notification when a shared folder is added or removed.
15863	The @a scope argument defines one of three scopes:
15864	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15865	(<link to="Scope_Global">Global</link>),
15866	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15867	the machine (<link to="Scope_Machine">Machine</link>) or <link
15868	to="IConsole::sharedFolders">transient shared folders</link> of the
15869	machine (<link to="Scope_Session">Session</link>). Interested callees
15870	should use query the corresponding collections to find out what has
15871	changed.
15872	</desc>
15873	<attribute name="scope" type="Scope" readonly="yes">
15874	<desc>
15875	Scope of the notification.
15876	</desc>
15877	</attribute>
15878	</interface>
15879
15880	<interface
15881	name="IRuntimeErrorEvent" extends="IEvent"
15882	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15883	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15884	>
15885	<desc>
15886	Notification when an error happens during the virtual
15887	machine execution.
15888
15889	There are three kinds of runtime errors:
15890	<ul>
15891	<li><i>fatal</i></li>
15892	<li><i>non-fatal with retry</i></li>
15893	<li><i>non-fatal warnings</i></li>
15894	</ul>
15895
15896	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15897	to @c true. In case of fatal errors, the virtual machine
15898	execution is always paused before calling this notification, and
15899	the notification handler is supposed either to immediately save
15900	the virtual machine state using <link to="IConsole::saveState"/>
15901	or power it off using <link to="IConsole::powerDown"/>.
15902	Resuming the execution can lead to unpredictable results.
15903
15904	<b>Non-fatal</b> errors and warnings are indicated by the
15905	@a fatal parameter set to @c false. If the virtual machine
15906	is in the Paused state by the time the error notification is
15907	received, it means that the user can <i>try to resume</i> the machine
15908	execution after attempting to solve the problem that caused the
15909	error. In this case, the notification handler is supposed
15910	to show an appropriate message to the user (depending on the
15911	value of the @a id parameter) that offers several actions such
15912	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15913	wants to retry, the notification handler should continue
15914	the machine execution using the <link to="IConsole::resume"/>
15915	call. If the machine execution is not Paused during this
15916	notification, then it means this notification is a <i>warning</i>
15917	(for example, about a fatal condition that can happen very soon);
15918	no immediate action is required from the user, the machine
15919	continues its normal execution.
15920
15921	Note that in either case the notification handler
15922	<b>must not</b> perform any action directly on a thread
15923	where this notification is called. Everything it is allowed to
15924	do is to post a message to another thread that will then talk
15925	to the user and take the corresponding action.
15926
15927	Currently, the following error identifiers are known:
15928	<ul>
15929	<li><tt>"HostMemoryLow"</tt></li>
15930	<li><tt>"HostAudioNotResponding"</tt></li>
15931	<li><tt>"VDIStorageFull"</tt></li>
15932	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15933	</ul>
15934	</desc>
15935	<attribute name="fatal" type="boolean" readonly="yes">
15936	<desc>
15937	Whether the error is fatal or not.
15938	</desc>
15939	</attribute>
15940	<attribute name="id" type="wstring" readonly="yes">
15941	<desc>
15942	Error identifier.
15943	</desc>
15944	</attribute>
15945	<attribute name="message" type="wstring" readonly="yes">
15946	<desc>
15947	Optional error message.
15948	</desc>
15949	</attribute>
15950	</interface>
15951
15952
15953	<interface
15954	name="IEventSourceChangedEvent" extends="IEvent"
15955	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15956	waitable="yes"
15957	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15958	>
15959	<desc>
15960	Notification when an event source state changes (listener added or removed).
15961	</desc>
15962
15963	<attribute name="listener" type="IEventListener" readonly="yes">
15964	<desc>
15965	Event listener which has changed.
15966	</desc>
15967	</attribute>
15968
15969	<attribute name="add" type="boolean" readonly="yes">
15970	<desc>
15971	Flag whether listener was added or removed.
15972	</desc>
15973	</attribute>
15974	</interface>
15975
15976	<interface
15977	name="IExtraDataChangedEvent" extends="IEvent"
15978	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15979	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15980	>
15981	<desc>
15982	Notification when machine specific or global extra data
15983	has changed.
15984	</desc>
15985	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15986	<desc>
15987	ID of the machine this event relates to.
15988	Null for global extra data changes.
15989	</desc>
15990	</attribute>
15991	<attribute name="key" type="wstring" readonly="yes">
15992	<desc>
15993	Extra data key that has changed.
15994	</desc>
15995	</attribute>
15996	<attribute name="value" type="wstring" readonly="yes">
15997	<desc>
15998	Extra data value for the given key.
15999	</desc>
16000	</attribute>
16001	</interface>
16002
16003	<interface
16004	name="IVetoEvent" extends="IEvent"
16005	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16006	wsmap="managed"
16007	>
16008	<desc>Base abstract interface for veto events.</desc>
16009
16010	<method name="addVeto">
16011	<desc>
16012	Adds a veto on this event.
16013	</desc>
16014	<param name="reason" type="wstring" dir="in">
16015	<desc>
16016	Reason for veto, could be null or empty string.
16017	</desc>
16018	</param>
16019	</method>
16020
16021	<method name="isVetoed">
16022	<desc>
16023	If this event was vetoed.
16024	</desc>
16025	<param name="result" type="boolean" dir="return">
16026	<desc>
16027	Reason for veto.
16028	</desc>
16029	</param>
16030	</method>
16031
16032	<method name="getVetos">
16033	<desc>
16034	Current veto reason list, if size is 0 - no veto.
16035	</desc>
16036	<param name="result" type="wstring" dir="return" safearray="yes">
16037	<desc>
16038	Array of reasons for veto provided by different event handlers.
16039	</desc>
16040	</param>
16041	</method>
16042
16043	</interface>
16044
16045	<interface
16046	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16047	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16048	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16049	waitable="true"
16050	>
16051	<desc>
16052	Notification when someone tries to change extra data for
16053	either the given machine or (if @c null) global extra data.
16054	This gives the chance to veto against changes.
16055	</desc>
16056	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16057	<desc>
16058	ID of the machine this event relates to.
16059	Null for global extra data changes.
16060	</desc>
16061	</attribute>
16062	<attribute name="key" type="wstring" readonly="yes">
16063	<desc>
16064	Extra data key that has changed.
16065	</desc>
16066	</attribute>
16067	<attribute name="value" type="wstring" readonly="yes">
16068	<desc>
16069	Extra data value for the given key.
16070	</desc>
16071	</attribute>
16072	</interface>
16073
16074	<interface
16075	name="ICanShowWindowEvent" extends="IVetoEvent"
16076	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16077	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16078	waitable="true"
16079	>
16080	<desc>
16081	Notification when a call to
16082	<link to="IMachine::canShowConsoleWindow"/> is made by a
16083	front-end to check if a subsequent call to
16084	<link to="IMachine::showConsoleWindow"/> can succeed.
16085
16086	The callee should give an answer appropriate to the current
16087	machine state using event veto. This answer must
16088	remain valid at least until the next
16089	<link to="IConsole::state">machine state</link> change.
16090	</desc>
16091	</interface>
16092
16093	<interface
16094	name="IShowWindowEvent" extends="IEvent"
16095	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16096	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16097	waitable="true"
16098	>
16099	<desc>
16100	Notification when a call to
16101	<link to="IMachine::showConsoleWindow"/>
16102	requests the console window to be activated and brought to
16103	foreground on the desktop of the host PC.
16104
16105	This notification should cause the VM console process to
16106	perform the requested action as described above. If it is
16107	impossible to do it at a time of this notification, this
16108	method should return a failure.
16109
16110	Note that many modern window managers on many platforms
16111	implement some sort of focus stealing prevention logic, so
16112	that it may be impossible to activate a window without the
16113	help of the currently active application (which is supposedly
16114	an initiator of this notification). In this case, this method
16115	must return a non-zero identifier that represents the
16116	top-level window of the VM console process. The caller, if it
16117	represents a currently active process, is responsible to use
16118	this identifier (in a platform-dependent manner) to perform
16119	actual window activation.
16120
16121	This method must set @a winId to zero if it has performed all
16122	actions necessary to complete the request and the console
16123	window is now active and in foreground, to indicate that no
16124	further action is required on the caller's side.
16125	</desc>
16126	<attribute name="winId" type="long long">
16127	<desc>
16128	Platform-dependent identifier of the top-level VM console
16129	window, or zero if this method has performed all actions
16130	necessary to implement the <i>show window</i> semantics for
16131	the given platform and/or this VirtualBox front-end.
16132	</desc>
16133	</attribute>
16134	</interface>
16135
16136	<interface
16137	name="INATRedirectEvent" extends="IMachineEvent"
16138	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16139	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16140	>
16141	<desc>
16142	Notification when NAT redirect rule added or removed.
16143	</desc>
16144	<attribute name="slot" type="unsigned long" readonly="yes">
16145	<desc>
16146	Adapter which NAT attached to.
16147	</desc>
16148	</attribute>
16149	<attribute name="remove" type="boolean" readonly="yes">
16150	<desc>
16151	Whether rule remove or add.
16152	</desc>
16153	</attribute>
16154	<attribute name="name" type="wstring" readonly="yes">
16155	<desc>
16156	Name of the rule.
16157	</desc>
16158	</attribute>
16159	<attribute name="proto" type="NATProtocol" readonly="yes">
16160	<desc>
16161	Protocol (TCP or UDP) of the redirect rule.
16162	</desc>
16163	</attribute>
16164	<attribute name="hostIp" type="wstring" readonly="yes">
16165	<desc>
16166	Host ip address to bind socket on.
16167	</desc>
16168	</attribute>
16169	<attribute name="hostPort" type="long" readonly="yes">
16170	<desc>
16171	Host port to bind socket on.
16172	</desc>
16173	</attribute>
16174	<attribute name="guestIp" type="wstring" readonly="yes">
16175	<desc>
16176	Guest ip address to redirect to.
16177	</desc>
16178	</attribute>
16179	<attribute name="guestPort" type="long" readonly="yes">
16180	<desc>
16181	Guest port to redirect to.
16182	</desc>
16183	</attribute>
16184	</interface>
16185
16186	<interface
16187	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16188	waitable="yes"
16189	uuid="EDD4782B-DB74-43A0-B724-2BAA36F039CC"
16190	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16191	>
16192	<desc>
16193	Notification when host PCI device is plugged/unplugged.
16194	</desc>
16195
16196	<attribute name="plugged" type="boolean" readonly="yes">
16197	<desc>
16198	If device successfully plugged or unplugged.
16199	</desc>
16200	</attribute>
16201
16202	<attribute name="success" type="boolean" readonly="yes">
16203	<desc>
16204	If operation was successful, if false - 'message' attribute
16205	may be of interest.
16206	</desc>
16207	</attribute>
16208
16209	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16210	<desc>
16211	Attachment info for this device.
16212	</desc>
16213	</attribute>
16214
16215	<attribute name="eventContext" type="IEventContext" readonly="yes">
16216	<desc>
16217	Context object, passed into attachHostPciDevice() and
16218	attachHostPciDevice().
16219	</desc>
16220	</attribute>
16221
16222	<attribute name="message" type="wstring" readonly="yes">
16223	<desc>
16224	Optional error message.
16225	</desc>
16226	</attribute>
16227
16228	</interface>
16229
16230	<interface
16231	name="IVBoxSVCUnavailableEvent" extends="IEvent"
16232	uuid="99f6b352-f5c1-4d15-9c32-939158da8983"
16233	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCUnavailable"
16234	>
16235	<desc>
16236	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16237	unexpected circumstances).
16238	</desc>
16239	</interface>
16240
16241	<interface
16242	name="IBandwidthGroupChangedEvent" extends="IEvent"
16243	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16244	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16245	>
16246	<desc>
16247	Notification when one of the bandwidth groups changed
16248	</desc>
16249	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16250	<desc>
16251	The changed bandwidth group.
16252	</desc>
16253	</attribute>
16254	</interface>
16255
16256	<module name="VBoxSVC" context="LocalServer">
16257	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
16258	namespace="virtualbox.org">
16259	<interface name="IVirtualBox" default="yes"/>
16260	</class>
16261	</module>
16262
16263	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16264	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16265	namespace="virtualbox.org">
16266	<interface name="IVirtualBoxClient" default="yes"/>
16267	</class>
16268
16269	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16270	namespace="virtualbox.org">
16271	<interface name="ISession" default="yes"/>
16272	</class>
16273	</module>
16274
16275	</library>
16276
16277	</idl>
16278
16279	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format