VirtualBox.xidl@ 33915

Last change on this file since 33915 was 33915, checked in by vboxsync, 14 years ago
Main, QT/FE, VBoxManage: per-chipset controller count limits
Property svn:eol-style set to `native`
File size: 573.1 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum name="SettingsVersion"
388	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
389	>
390	<desc>Settings version of VirtualBox settings files. This is written to
391	the "version" attribute of the root "VirtualBox" element in the settings
392	file XML and indicates which VirtualBox version wrote the file.
393	</desc>
394
395	<const name="Null" value="0">
396	<desc>Null value, indicates invalid version.</desc>
397	</const>
398	<const name="v1_0" value="1">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_1" value="2">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_2" value="3">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3pre" value="4">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_3" value="5">
411	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
412	<!--
413	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
414	-->
415	</const>
416	<const name="v1_4" value="6">
417	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
418	<!--
419	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
420	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
421	-->
422	</const>
423	<const name="v1_5" value="7">
424	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
425	<!-- 2008-09-04: 2.0.0 released
426	2008-11-20: settings version 1.5 introduced
427	2008-12-17: 2.1.0 released
428	Machine changes:
429	guest OS identifiers changed;
430	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
431	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
432	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
433	-->
434	</const>
435	<const name="v1_6" value="8">
436	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
437	<!-- 2008-12-17: 2.1.0 released
438	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
439	2009-04-08: 2.2.0 released
440	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
441	-->
442	</const>
443	<const name="v1_7" value="9">
444	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
445	<!-- 2008-12-17: 2.1.0 released
446	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
447	2009-04-08: 2.2.0 released
448	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
449	Machine changes: HardDiskAttachments is now StorageControllers (done)
450	-->
451	</const>
452	<const name="v1_8" value="10">
453	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
454	<!-- Machine additions: Display/@accelerate2DVideo (done)
455	-->
456	</const>
457	<const name="v1_9" value="11">
458	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
459	<!-- The big storage controller / DVD / Floppy rework (done)
460	-->
461	</const>
462	<const name="v1_10" value="12">
463	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
464	<!-- Machine changes: RTC localOrUTC (done)
465	CPU hot-plug support
466	-->
467	</const>
468	<const name="v1_11" value="13">
469	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
470	<!-- Machine changes: HD Audio controller, per-machine disk registries,
471	/@format attribute for DVD and floppy images.
472	-->
473	</const>
474	<const name="Future" value="99999">
475	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
476	</const>
477	</enum>
478
479	<enum
480	name="AccessMode"
481	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
482	>
483	<desc>
484	Access mode for opening files.
485	</desc>
486
487	<const name="ReadOnly" value="1"/>
488	<const name="ReadWrite" value="2"/>
489	</enum>
490
491	<enum
492	name="MachineState"
493	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
494	>
495	<desc>
496	Virtual machine execution state.
497
498	This enumeration represents possible values of the <link
499	to="IMachine::state"/> attribute.
500
501	Below is the basic virtual machine state diagram. It shows how the state
502	changes during virtual machine execution. The text in square braces shows
503	a method of the IConsole interface that performs the given state
504	transition.
505
506	<pre>
507	+---------[powerDown()] <- Stuck <--[failure]-+
508	V \|
509	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
510	\| \| \| \| V \|
511	\| Aborted -----+ +--> Running --[pause()]--> Paused
512	\| \| ^ \| ^ \|
513	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
514	\| ^ \| \| \| \|
515	\| \| +-----------------------------------------+-\|-------------------+ +
516	\| \| \| \| \|
517	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
518	\| \| \| \|
519	\| +-------- Saving <--------[saveState()]<----------+---------------------+
520	\| \| \|
521	+-------------- Stopping -------[powerDown()]<----------+---------------------+
522	</pre>
523
524	Note that states to the right from PoweredOff, Aborted and Saved in the
525	above diagram are called <i>online VM states</i>. These states
526	represent the virtual machine which is being executed in a dedicated
527	process (usually with a GUI window attached to it where you can see the
528	activity of the virtual machine and interact with it). There are two
529	special pseudo-states, FirstOnline and LastOnline, that can be used in
530	relational expressions to detect if the given machine state is online or
531	not:
532
533	<pre>
534	if (machine.GetState() >= MachineState_FirstOnline &&
535	machine.GetState() <= MachineState_LastOnline)
536	{
537	...the machine is being executed...
538	}
539	</pre>
540
541	When the virtual machine is in one of the online VM states (that is, being
542	executed), only a few machine settings can be modified. Methods working
543	with such settings contain an explicit note about that. An attempt to
544	change any oter setting or perform a modifying operation during this time
545	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
546
547	All online states except Running, Paused and Stuck are transitional: they
548	represent temporary conditions of the virtual machine that will last as
549	long as the operation that initiated such a condition.
550
551	The Stuck state is a special case. It means that execution of the machine
552	has reached the "Guru Meditation" condition. This condition indicates an
553	internal VMM (virtual machine manager) failure which may happen as a
554	result of either an unhandled low-level virtual hardware exception or one
555	of the recompiler exceptions (such as the <i>too-many-traps</i>
556	condition).
557
558	Note also that any online VM state may transit to the Aborted state. This
559	happens if the process that is executing the virtual machine terminates
560	unexpectedly (for example, crashes). Other than that, the Aborted state is
561	equivalent to PoweredOff.
562
563	There are also a few additional state diagrams that do not deal with
564	virtual machine execution and therefore are shown separately. The states
565	shown on these diagrams are called <i>offline VM states</i> (this includes
566	PoweredOff, Aborted and Saved too).
567
568	The first diagram shows what happens when a lengthy setup operation is
569	being executed (such as <link to="IMachine::attachDevice"/>).
570
571	<pre>
572	+----------------------------------(same state as before the call)------+
573	\| \|
574	+-> PoweredOff --+ \|
575	\| \| \|
576	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
577	\| \|
578	+-> Saved -------+
579	</pre>
580
581	The next two diagrams demonstrate the process of taking a snapshot of a
582	powered off virtual machine, restoring the state to that as of a snapshot
583	or deleting a snapshot, respectively.
584
585	<pre>
586	+----------------------------------(same state as before the call)------+
587	\| \|
588	+-> PoweredOff --+ \|
589	\| +-->[takeSnapshot()] -------------------> Saving ------+
590	+-> Aborted -----+
591
592	+-> PoweredOff --+
593	\| \|
594	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
595	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
596	+-> Saved -------+ \|
597	\| \|
598	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
599	</pre>
600
601	Note that the Saving state is present in both the offline state group and
602	online state group. Currently, the only way to determine what group is
603	assumed in a particular case is to remember the previous machine state: if
604	it was Running or Paused, then Saving is an online state, otherwise it is
605	an offline state. This inconsistency may be removed in one of the future
606	versions of VirtualBox by adding a new state.
607
608	<note internal="yes">
609	For whoever decides to touch this enum: In order to keep the
610	comparisons involving FirstOnline and LastOnline pseudo-states valid,
611	the numeric values of these states must be correspondingly updated if
612	needed: for any online VM state, the condition
613	<tt>FirstOnline <= state <= LastOnline</tt> must be
614	@c true. The same relates to transient states for which
615	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
616	@c true.
617	</note>
618	</desc>
619
620	<const name="Null" value="0">
621	<desc>Null value (never used by the API).</desc>
622	</const>
623	<const name="PoweredOff" value="1">
624	<desc>
625	The machine is not running and has no saved execution state; it has
626	either never been started or been shut down successfully.
627	</desc>
628	</const>
629	<const name="Saved" value="2">
630	<desc>
631	The machine is not currently running, but the execution state of the machine
632	has been saved to an external file when it was running, from where
633	it can be resumed.
634	</desc>
635	</const>
636	<const name="Teleported" value="3">
637	<desc>
638	The machine was teleported to a different host (or process) and then
639	powered off. Take care when powering it on again may corrupt resources
640	it shares with the teleportation target (e.g. disk and network).
641	</desc>
642	</const>
643	<const name="Aborted" value="4">
644	<desc>
645	The process running the machine has terminated abnormally. This may
646	indicate a crash of the VM process in host execution context, or
647	the VM process has been terminated externally.
648	</desc>
649	</const>
650	<const name="Running" value="5">
651	<desc>
652	The machine is currently being executed.
653	<note internal="yes">
654	For whoever decides to touch this enum: In order to keep the
655	comparisons in the old source code valid, this state must immediately
656	precede the Paused state.
657	TODO: Lift this spectacularly wonderful restriction.
658	</note>
659	</desc>
660	</const>
661	<const name="Paused" value="6">
662	<desc>
663	Execution of the machine has been paused.
664	<note internal="yes">
665	For whoever decides to touch this enum: In order to keep the
666	comparisons in the old source code valid, this state must immediately
667	follow the Running state.
668	TODO: Lift this spectacularly wonderful restriction.
669	</note>
670	</desc>
671	</const>
672	<const name="Stuck" value="7">
673	<desc>
674	Execution of the machine has reached the "Guru Meditation"
675	condition. This indicates a severe error in the hypervisor itself.
676	<note internal="yes">
677	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
678	"Guru", perhaps? Or are there some other VMM states that are
679	intended to be lumped in here as well?
680	</note>
681	</desc>
682	</const>
683	<const name="Teleporting" value="8">
684	<desc>
685	The machine is about to be teleported to a different host or process.
686	It is possible to pause a machine in this state, but it will go to the
687	@c TeleportingPausedVM state and it will not be
688	possible to resume it again unless the teleportation fails.
689	</desc>
690	</const>
691	<const name="LiveSnapshotting" value="9">
692	<desc>
693	A live snapshot is being taken. The machine is running normally, but
694	some of the runtime configuration options are inaccessible. Also, if
695	paused while in this state it will transition to
696	@c Saving and it will not be resume the
697	execution until the snapshot operation has completed.
698	</desc>
699	</const>
700	<const name="Starting" value="10">
701	<desc>
702	Machine is being started after powering it on from a
703	zero execution state.
704	</desc>
705	</const>
706	<const name="Stopping" value="11">
707	<desc>
708	Machine is being normally stopped powering it off, or after the guest OS
709	has initiated a shutdown sequence.
710	</desc>
711	</const>
712	<const name="Saving" value="12">
713	<desc>
714	Machine is saving its execution state to a file, or an online
715	snapshot of the machine is being taken.
716	</desc>
717	</const>
718	<const name="Restoring" value="13">
719	<desc>
720	Execution state of the machine is being restored from a file
721	after powering it on from the saved execution state.
722	</desc>
723	</const>
724	<const name="TeleportingPausedVM" value="14">
725	<desc>
726	The machine is being teleported to another host or process, but it is
727	not running. This is the paused variant of the
728	@c state.
729	</desc>
730	</const>
731	<const name="TeleportingIn" value="15">
732	<desc>
733	Teleporting the machine state in from another host or process.
734	</desc>
735	</const>
736	<const name="FaultTolerantSyncing" value="16">
737	<desc>
738	The machine is being synced with a fault tolerant VM running elsewhere.
739	</desc>
740	</const>
741	<const name="DeletingSnapshotOnline" value="17">
742	<desc>
743	Like @c DeletingSnapshot, but the merging of media is ongoing in
744	the background while the machine is running.
745	</desc>
746	</const>
747	<const name="DeletingSnapshotPaused" value="18">
748	<desc>
749	Like @c DeletingSnapshotOnline, but the machine was paused when the
750	merging of differencing media was started.
751	</desc>
752	</const>
753	<const name="RestoringSnapshot" value="19">
754	<desc>
755	A machine snapshot is being restored; this typically does not take long.
756	</desc>
757	</const>
758	<const name="DeletingSnapshot" value="20">
759	<desc>
760	A machine snapshot is being deleted; this can take a long time since this
761	may require merging differencing media. This value indicates that the
762	machine is not running while the snapshot is being deleted.
763	</desc>
764	</const>
765	<const name="SettingUp" value="21">
766	<desc>
767	Lengthy setup operation is in progress.
768	</desc>
769	</const>
770
771	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
772	<desc>
773	Pseudo-state: first online state (for use in relational expressions).
774	</desc>
775	</const>
776	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
777	<desc>
778	Pseudo-state: last online state (for use in relational expressions).
779	</desc>
780	</const>
781
782	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
783	<desc>
784	Pseudo-state: first transient state (for use in relational expressions).
785	</desc>
786	</const>
787	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
788	<desc>
789	Pseudo-state: last transient state (for use in relational expressions).
790	</desc>
791	</const>
792
793	</enum>
794
795	<enum
796	name="SessionState"
797	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
798	>
799	<desc>
800	Session state. This enumeration represents possible values of
801	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
802	attributes.
803	</desc>
804
805	<const name="Null" value="0">
806	<desc>Null value (never used by the API).</desc>
807	</const>
808	<const name="Unlocked" value="1">
809	<desc>
810	In <link to="IMachine::sessionState"/>, this means that the machine
811	is not locked for any sessions.
812
813	In <link to="ISession::state"/>, this means that no machine is
814	currently locked for this session.
815	</desc>
816	</const>
817	<const name="Locked" value="2">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is currently locked for a session, whose process identifier can
821	then be found in the <link to="IMachine::sessionPid" /> attribute.
822
823	In <link to="ISession::state"/>, this means that a machine is
824	currently locked for this session, and the mutable machine object
825	can be found in the <link to="ISession::machine"/> attribute
826	(see <link to="IMachine::lockMachine" /> for details).
827	</desc>
828	</const>
829	<const name="Spawning" value="3">
830	<desc>
831	A new process is being spawned for the machine as a result of
832	<link to="IMachine::launchVMProcess"/> call. This state also occurs
833	as a short transient state during an <link to="IMachine::lockMachine"/>
834	call.
835	</desc>
836	</const>
837	<const name="Unlocking" value="4">
838	<desc>
839	The session is being unlocked.
840	</desc>
841	</const>
842	</enum>
843
844	<enum
845	name="CPUPropertyType"
846	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
847	>
848	<desc>
849	Virtual CPU property type. This enumeration represents possible values of the
850	IMachine get- and setCPUProperty methods.
851	</desc>
852	<const name="Null" value="0">
853	<desc>Null value (never used by the API).</desc>
854	</const>
855	<const name="PAE" value="1">
856	<desc>
857	This setting determines whether VirtualBox will expose the Physical Address
858	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
859	is not available, it will not be reported.
860	</desc>
861	</const>
862	<const name="Synthetic" value="2">
863	<desc>
864	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
865	teleporting between host systems that differ significantly.
866	</desc>
867	</const>
868	</enum>
869
870
871	<enum
872	name="HWVirtExPropertyType"
873	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
874	>
875	<desc>
876	Hardware virtualization property type. This enumeration represents possible values
877	for the <link to="IMachine::getHWVirtExProperty"/> and
878	<link to="IMachine::setHWVirtExProperty"/> methods.
879	</desc>
880	<const name="Null" value="0">
881	<desc>Null value (never used by the API).</desc>
882	</const>
883	<const name="Enabled" value="1">
884	<desc>
885	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
886	such extensions are not available, they will not be used.
887	</desc>
888	</const>
889	<const name="Exclusive" value="2">
890	<desc>
891	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
892	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
893	feature of the host. To share these with other hypervisors, you must disable this property.
894	</desc>
895	</const>
896	<const name="VPID" value="3">
897	<desc>
898	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
899	</desc>
900	</const>
901	<const name="NestedPaging" value="4">
902	<desc>
903	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
904	</desc>
905	</const>
906	<const name="LargePages" value="5">
907	<desc>
908	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
909	</desc>
910	</const>
911	<const name="Force" value="6">
912	<desc>
913	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
914	not set, there will be an automatic fallback to software virtualization.
915	</desc>
916	</const>
917	</enum>
918
919	<enum
920	name="FaultToleranceState"
921	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
922	>
923	<desc>
924	Used with <link to="IMachine::faultToleranceState" />.
925	</desc>
926	<const name="Inactive" value="1">
927	<desc>No fault tolerance enabled.</desc>
928	</const>
929	<const name="Master" value="2">
930	<desc>Fault tolerant master VM.</desc>
931	</const>
932	<const name="Standby" value="3">
933	<desc>Fault tolerant standby VM.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="LockType"
939	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
940	>
941	<desc>
942	Used with <link to="IMachine::lockMachine" />.
943	</desc>
944	<const name="Write" value="2">
945	<desc>Lock the machine for writing.</desc>
946	</const>
947	<const name="Shared" value="1">
948	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
949	</const>
950	</enum>
951
952	<enum
953	name="SessionType"
954	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
955	>
956	<desc>
957	Session type. This enumeration represents possible values of the
958	<link to="ISession::type"/> attribute.
959	</desc>
960
961	<const name="Null" value="0">
962	<desc>Null value (never used by the API).</desc>
963	</const>
964	<const name="WriteLock" value="1">
965	<desc>
966	Session has acquired an exclusive write lock on a machine
967	using <link to="IMachine::lockMachine"/>.
968	</desc>
969	</const>
970	<const name="Remote" value="2">
971	<desc>
972	Session has launched a VM process using
973	<link to="IMachine::launchVMProcess"/>
974	</desc>
975	</const>
976	<const name="Shared" value="3">
977	<desc>
978	Session has obtained a link to another session using
979	<link to="IMachine::lockMachine"/>
980	</desc>
981	</const>
982	</enum>
983
984	<enum
985	name="DeviceType"
986	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
987	>
988	<desc>
989	Device type.
990	</desc>
991	<const name="Null" value="0">
992	<desc>
993	Null value, may also mean "no device" (not allowed for
994	<link to="IConsole::getDeviceActivity"/>).
995	</desc>
996	</const>
997	<const name="Floppy" value="1">
998	<desc>Floppy device.</desc>
999	</const>
1000	<const name="DVD" value="2">
1001	<desc>CD/DVD-ROM device.</desc>
1002	</const>
1003	<const name="HardDisk" value="3">
1004	<desc>Hard disk device.</desc>
1005	</const>
1006	<const name="Network" value="4">
1007	<desc>Network device.</desc>
1008	</const>
1009	<const name="USB" value="5">
1010	<desc>USB device.</desc>
1011	</const>
1012	<const name="SharedFolder" value="6">
1013	<desc>Shared folder device.</desc>
1014	</const>
1015	</enum>
1016
1017	<enum
1018	name="DeviceActivity"
1019	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1020	>
1021	<desc>
1022	Device activity for <link to="IConsole::getDeviceActivity"/>.
1023	</desc>
1024
1025	<const name="Null" value="0"/>
1026	<const name="Idle" value="1"/>
1027	<const name="Reading" value="2"/>
1028	<const name="Writing" value="3"/>
1029	</enum>
1030
1031	<enum
1032	name="ClipboardMode"
1033	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1034	>
1035	<desc>
1036	Host-Guest clipboard interchange mode.
1037	</desc>
1038
1039	<const name="Disabled" value="0"/>
1040	<const name="HostToGuest" value="1"/>
1041	<const name="GuestToHost" value="2"/>
1042	<const name="Bidirectional" value="3"/>
1043	</enum>
1044
1045	<enum
1046	name="Scope"
1047	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1048	>
1049	<desc>
1050	Scope of the operation.
1051
1052	A generic enumeration used in various methods to define the action or
1053	argument scope.
1054	</desc>
1055
1056	<const name="Global" value="0"/>
1057	<const name="Machine" value="1"/>
1058	<const name="Session" value="2"/>
1059	</enum>
1060
1061	<enum
1062	name="BIOSBootMenuMode"
1063	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1064	>
1065	<desc>
1066	BIOS boot menu mode.
1067	</desc>
1068
1069	<const name="Disabled" value="0"/>
1070	<const name="MenuOnly" value="1"/>
1071	<const name="MessageAndMenu" value="2"/>
1072	</enum>
1073
1074	<enum
1075	name="ProcessorFeature"
1076	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1077	>
1078	<desc>
1079	CPU features.
1080	</desc>
1081
1082	<const name="HWVirtEx" value="0"/>
1083	<const name="PAE" value="1"/>
1084	<const name="LongMode" value="2"/>
1085	<const name="NestedPaging" value="3"/>
1086	</enum>
1087
1088	<enum
1089	name="FirmwareType"
1090	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1091	>
1092	<desc>
1093	Firmware type.
1094	</desc>
1095	<const name="BIOS" value="1">
1096	<desc>BIOS Firmware.</desc>
1097	</const>
1098	<const name="EFI" value="2">
1099	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1100	</const>
1101	<const name="EFI32" value="3">
1102	<desc>Efi firmware, 32-bit.</desc>
1103	</const>
1104	<const name="EFI64" value="4">
1105	<desc>Efi firmware, 64-bit.</desc>
1106	</const>
1107	<const name="EFIDUAL" value="5">
1108	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1109	</const>
1110	</enum>
1111
1112	<enum
1113	name="PointingHidType"
1114	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1115	>
1116	<desc>
1117	Type of pointing device used in a virtual machine.
1118	</desc>
1119	<const name="None" value="1">
1120	<desc>No mouse.</desc>
1121	</const>
1122	<const name="PS2Mouse" value="2">
1123	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1124	</const>
1125	<const name="USBMouse" value="3">
1126	<desc>USB mouse (relative pointer).</desc>
1127	</const>
1128	<const name="USBTablet" value="4">
1129	<desc>USB tablet (absolute pointer).</desc>
1130	</const>
1131	<const name="ComboMouse" value="5">
1132	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1133	Using of such device can have negative performance implications. </desc>
1134	</const>
1135	</enum>
1136
1137	<enum
1138	name="KeyboardHidType"
1139	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1140	>
1141	<desc>
1142	Type of keyboard device used in a virtual machine.
1143	</desc>
1144	<const name="None" value="1">
1145	<desc>No keyboard.</desc>
1146	</const>
1147	<const name="PS2Keyboard" value="2">
1148	<desc>PS/2 keyboard.</desc>
1149	</const>
1150	<const name="USBKeyboard" value="3">
1151	<desc>USB keyboard.</desc>
1152	</const>
1153	<const name="ComboKeyboard" value="4">
1154	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1155	Using of such device can have negative performance implications. </desc>
1156	</const>
1157	</enum>
1158
1159	<!--
1160	// IVirtualBoxErrorInfo
1161	/////////////////////////////////////////////////////////////////////////
1162	-->
1163
1164	<interface
1165	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1166	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1167	supportsErrorInfo="no"
1168	wsmap="managed"
1169	>
1170	<desc>
1171	The IVirtualBoxErrorInfo interface represents extended error information.
1172
1173	Extended error information can be set by VirtualBox components after
1174	unsuccessful or partially successful method invocation. This information
1175	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1176	and then shown to the client in addition to the plain 32-bit result code.
1177
1178	In MS COM, this interface extends the IErrorInfo interface,
1179	in XPCOM, it extends the nsIException interface. In both cases,
1180	it provides a set of common attributes to retrieve error
1181	information.
1182
1183	Sometimes invocation of some component's method may involve methods of
1184	other components that may also fail (independently of this method's
1185	failure), or a series of non-fatal errors may precede a fatal error that
1186	causes method failure. In cases like that, it may be desirable to preserve
1187	information about all errors happened during method invocation and deliver
1188	it to the caller. The <link to="#next"/> attribute is intended
1189	specifically for this purpose and allows to represent a chain of errors
1190	through a single IVirtualBoxErrorInfo object set after method invocation.
1191
1192	Note that errors are stored to a chain in the reverse order, i.e. the
1193	initial error object you query right after method invocation is the last
1194	error set by the callee, the object it points to in the @a next attribute
1195	is the previous error and so on, up to the first error (which is the last
1196	in the chain).
1197	</desc>
1198
1199	<attribute name="resultCode" type="long" readonly="yes">
1200	<desc>
1201	Result code of the error.
1202	Usually, it will be the same as the result code returned
1203	by the method that provided this error information, but not
1204	always. For example, on Win32, CoCreateInstance() will most
1205	likely return E_NOINTERFACE upon unsuccessful component
1206	instantiation attempt, but not the value the component factory
1207	returned. Value is typed 'long', not 'result',
1208	to make interface usable from scripting languages.
1209	<note>
1210	In MS COM, there is no equivalent.
1211	In XPCOM, it is the same as nsIException::result.
1212	</note>
1213	</desc>
1214	</attribute>
1215
1216	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1217	<desc>
1218	UUID of the interface that defined the error.
1219	<note>
1220	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1221	data type.
1222	In XPCOM, there is no equivalent.
1223	</note>
1224	</desc>
1225	</attribute>
1226
1227	<attribute name="component" type="wstring" readonly="yes">
1228	<desc>
1229	Name of the component that generated the error.
1230	<note>
1231	In MS COM, it is the same as IErrorInfo::GetSource.
1232	In XPCOM, there is no equivalent.
1233	</note>
1234	</desc>
1235	</attribute>
1236
1237	<attribute name="text" type="wstring" readonly="yes">
1238	<desc>
1239	Text description of the error.
1240	<note>
1241	In MS COM, it is the same as IErrorInfo::GetDescription.
1242	In XPCOM, it is the same as nsIException::message.
1243	</note>
1244	</desc>
1245	</attribute>
1246
1247	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1248	<desc>
1249	Next error object if there is any, or @c null otherwise.
1250	<note>
1251	In MS COM, there is no equivalent.
1252	In XPCOM, it is the same as nsIException::inner.
1253	</note>
1254	</desc>
1255	</attribute>
1256
1257	</interface>
1258
1259	<!--
1260	// IVirtualBox
1261	/////////////////////////////////////////////////////////////////////////
1262	-->
1263
1264	<interface
1265	name="IDHCPServer" extends="$unknown"
1266	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1267	wsmap="managed"
1268	>
1269	<desc>
1270	The IDHCPServer interface represents the vbox dhcp server configuration.
1271
1272	To enumerate all the dhcp servers on the host, use the
1273	<link to="IVirtualBox::DHCPServers"/> attribute.
1274	</desc>
1275
1276	<attribute name="enabled" type="boolean">
1277	<desc>
1278	specifies if the dhcp server is enabled
1279	</desc>
1280	</attribute>
1281
1282	<attribute name="IPAddress" type="wstring" readonly="yes">
1283	<desc>
1284	specifies server IP
1285	</desc>
1286	</attribute>
1287
1288	<attribute name="networkMask" type="wstring" readonly="yes">
1289	<desc>
1290	specifies server network mask
1291	</desc>
1292	</attribute>
1293
1294	<attribute name="networkName" type="wstring" readonly="yes">
1295	<desc>
1296	specifies internal network name the server is used for
1297	</desc>
1298	</attribute>
1299
1300	<attribute name="lowerIP" type="wstring" readonly="yes">
1301	<desc>
1302	specifies from IP address in server address range
1303	</desc>
1304	</attribute>
1305
1306	<attribute name="upperIP" type="wstring" readonly="yes">
1307	<desc>
1308	specifies to IP address in server address range
1309	</desc>
1310	</attribute>
1311
1312	<method name="setConfiguration">
1313	<desc>
1314	configures the server
1315	<result name="E_INVALIDARG">
1316	invalid configuration supplied
1317	</result>
1318	</desc>
1319	<param name="IPAddress" type="wstring" dir="in">
1320	<desc>
1321	server IP address
1322	</desc>
1323	</param>
1324	<param name="networkMask" type="wstring" dir="in">
1325	<desc>
1326	server network mask
1327	</desc>
1328	</param>
1329	<param name="FromIPAddress" type="wstring" dir="in">
1330	<desc>
1331	server From IP address for address range
1332	</desc>
1333	</param>
1334	<param name="ToIPAddress" type="wstring" dir="in">
1335	<desc>
1336	server To IP address for address range
1337	</desc>
1338	</param>
1339	</method>
1340
1341	<method name="start">
1342	<desc>
1343	Starts DHCP server process.
1344	<result name="E_FAIL">
1345	Failed to start the process.
1346	</result>
1347	</desc>
1348	<param name="networkName" type="wstring" dir="in">
1349	<desc>
1350	Name of internal network DHCP server should attach to.
1351	</desc>
1352	</param>
1353	<param name="trunkName" type="wstring" dir="in">
1354	<desc>
1355	Name of internal network trunk.
1356	</desc>
1357	</param>
1358	<param name="trunkType" type="wstring" dir="in">
1359	<desc>
1360	Type of internal network trunk.
1361	</desc>
1362	</param>
1363	</method>
1364
1365	<method name="stop">
1366	<desc>
1367	Stops DHCP server process.
1368	<result name="E_FAIL">
1369	Failed to stop the process.
1370	</result>
1371	</desc>
1372	</method>
1373	</interface>
1374
1375	<interface
1376	name="IVirtualBox" extends="$unknown"
1377	uuid="e03d6527-9b72-43b5-b87f-88f1033d3866"
1378	wsmap="managed"
1379	>
1380	<desc>
1381	The IVirtualBox interface represents the main interface exposed by the
1382	product that provides virtual machine management.
1383
1384	An instance of IVirtualBox is required for the product to do anything
1385	useful. Even though the interface does not expose this, internally,
1386	IVirtualBox is implemented as a singleton and actually lives in the
1387	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1388	IVirtualBox can track the state of all virtual machines on a particular
1389	host, regardless of which frontend started them.
1390
1391	To enumerate all the virtual machines on the host, use the
1392	<link to="IVirtualBox::machines"/> attribute.
1393	</desc>
1394
1395	<attribute name="version" type="wstring" readonly="yes">
1396	<desc>
1397	A string representing the version number of the product. The
1398	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1399	last number represents the build number and will frequently change.
1400	</desc>
1401	</attribute>
1402
1403	<attribute name="revision" type="unsigned long" readonly="yes">
1404	<desc>
1405	The internal build revision number of the product.
1406	</desc>
1407	</attribute>
1408
1409	<attribute name="packageType" type="wstring" readonly="yes">
1410	<desc>
1411	A string representing the package type of this product. The
1412	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1413	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1414	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1415	this.
1416	</desc>
1417	</attribute>
1418
1419	<attribute name="homeFolder" type="wstring" readonly="yes">
1420	<desc>
1421	Full path to the directory where the global settings file,
1422	<tt>VirtualBox.xml</tt>, is stored.
1423
1424	In this version of VirtualBox, the value of this property is
1425	always <tt><user_dir>/.VirtualBox</tt> (where
1426	<tt><user_dir></tt> is the path to the user directory,
1427	as determined by the host OS), and cannot be changed.
1428
1429	This path is also used as the base to resolve relative paths in
1430	places where relative paths are allowed (unless otherwise
1431	expressly indicated).
1432	</desc>
1433	</attribute>
1434
1435	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1436	<desc>
1437	Full name of the global settings file.
1438	The value of this property corresponds to the value of
1439	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1440	</desc>
1441	</attribute>
1442
1443	<attribute name="host" type="IHost" readonly="yes">
1444	<desc>Associated host object.</desc>
1445	</attribute>
1446
1447	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1448	<desc>Associated system information object.</desc>
1449	</attribute>
1450
1451	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1452	<desc>
1453	Array of machine objects registered within this VirtualBox instance.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1458	<desc>
1459	Array of medium objects known to this VirtualBox installation.
1460
1461	This array contains only base media. All differencing
1462	media of the given base medium can be enumerated using
1463	<link to="IMedium::children"/>.
1464	</desc>
1465	</attribute>
1466
1467	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1468	<desc>
1469	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1474	<desc>
1475	Array of floppy image objects currently in use by this VirtualBox instance.
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1480
1481	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1482
1483	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1484	<desc>
1485	Collection of global shared folders. Global shared folders are
1486	available to all virtual machines.
1487
1488	New shared folders are added to the collection using
1489	<link to="#createSharedFolder"/>. Existing shared folders can be
1490	removed using <link to="#removeSharedFolder"/>.
1491
1492	<note>
1493	In the current version of the product, global shared folders are not
1494	implemented and therefore this collection is always empty.
1495	</note>
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1500	<desc>
1501	Associated performance collector object.
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1506	<desc>
1507	DHCP servers.
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="eventSource" type="IEventSource" readonly="yes">
1512	<desc>
1513	Event source for VirtualBox events.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1518	<desc>
1519	The extension pack manager.
1520	</desc>
1521	</attribute>
1522
1523
1524	<method name="composeMachineFilename">
1525	<desc>
1526	Returns a recommended full path of the settings file name for a new virtual
1527	machine.
1528
1529	This API serves two purposes:
1530
1531	<ul>
1532	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1533	for the @a settingsFile argument there, which means that API should use
1534	a recommended default file name.</li>
1535
1536	<li>It can be called manually by a client software before creating a machine,
1537	e.g. if that client wants to pre-create the machine directory to create
1538	virtual hard disks in that directory together with the new machine
1539	settings file. In that case, the file name should be stripped from the
1540	full settings file path returned by this function to obtain the
1541	machine directory.</li>
1542	</ul>
1543
1544	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1545	details about the machine name.
1546
1547	If @a baseFolder is a @c null or empty string (which is recommended), the
1548	default machine settings folder
1549	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1550	a base folder for the created machine, resulting in a file name like
1551	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1552	will be used.
1553
1554	This method does not access the host disks. In particular, it does not check
1555	for whether a machine of this name already exists.
1556	</desc>
1557	<param name="name" type="wstring" dir="in">
1558	<desc>Suggested machine name.</desc>
1559	</param>
1560	<param name="baseFolder" type="wstring" dir="in">
1561	<desc>Base machine folder (optional).</desc>
1562	</param>
1563	<param name="file" type="wstring" dir="return">
1564	<desc>Fully qualified path where the machine would be created.</desc>
1565	</param>
1566	</method>
1567
1568	<method name="createMachine">
1569	<desc>
1570	Creates a new virtual machine by creating a machine settings file at
1571	the given location.
1572
1573	VirtualBox machine settings files use a custom XML dialect. Starting
1574	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1575	and machine files can be created at arbitrary locations.
1576
1577	However, it is is recommended that machines be created in the default
1578	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1579	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1580	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1581	is called automatically to have such a recommended name composed based
1582	on the machine name given in the @a name argument.
1583
1584	If the resulting settings file already exists, this method will fail,
1585	unless @a forceOverwrite is set.
1586
1587	The new machine is created unregistered, with the initial configuration
1588	set according to the specified guest OS type. A typical sequence of
1589	actions to create a new virtual machine is as follows:
1590
1591	<ol>
1592	<li>
1593	Call this method to have a new machine created. The returned machine
1594	object will be "mutable" allowing to change any machine property.
1595	</li>
1596
1597	<li>
1598	Configure the machine using the appropriate attributes and methods.
1599	</li>
1600
1601	<li>
1602	Call <link to="IMachine::saveSettings" /> to write the settings
1603	to the machine's XML settings file. The configuration of the newly
1604	created machine will not be saved to disk until this method is
1605	called.
1606	</li>
1607
1608	<li>
1609	Call <link to="#registerMachine" /> to add the machine to the list
1610	of machines known to VirtualBox.
1611	</li>
1612	</ol>
1613
1614	The specified guest OS type identifier must match an ID of one of known
1615	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1616	array.
1617
1618	Optionally, you may specify an UUID of to assign to the created machine.
1619	However, this is not recommended and you should normally pass an empty
1620	(@c null) UUID to this method so that a new UUID will be automatically
1621	generated for every created machine. You can use UUID
1622	00000000-0000-0000-0000-000000000000 as @c null value.
1623
1624	<note>
1625	There is no way to change the name of the settings file or
1626	subfolder of the created machine directly.
1627	</note>
1628
1629	<result name="VBOX_E_OBJECT_NOT_FOUND">
1630	@a osTypeId is invalid.
1631	</result>
1632	<result name="VBOX_E_FILE_ERROR">
1633	Resulting settings file name is invalid or the settings file already
1634	exists or could not be created due to an I/O error.
1635	</result>
1636	<result name="E_INVALIDARG">
1637	@a name is empty or @c null.
1638	</result>
1639	</desc>
1640
1641	<param name="settingsFile" type="wstring" dir="in">
1642	<desc>Fully qualified path where the settings file should be created,
1643	or NULL for a default folder and file based on the @a name argument
1644	(see <link to="#composeMachineFilename" />).</desc>
1645	</param>
1646	<param name="name" type="wstring" dir="in">
1647	<desc>Machine name.</desc>
1648	</param>
1649	<param name="osTypeId" type="wstring" dir="in">
1650	<desc>Guest OS Type ID.</desc>
1651	</param>
1652	<param name="id" type="uuid" mod="string" dir="in">
1653	<desc>Machine UUID (optional).</desc>
1654	</param>
1655	<param name="forceOverwrite" type="boolean" dir="in">
1656	<desc>If true, an existing machine settings file will be overwritten.</desc>
1657	</param>
1658	<param name="machine" type="IMachine" dir="return">
1659	<desc>Created machine object.</desc>
1660	</param>
1661	</method>
1662
1663	<method name="openMachine">
1664	<desc>
1665	Opens a virtual machine from the existing settings file.
1666	The opened machine remains unregistered until you call
1667	<link to="#registerMachine"/>.
1668
1669	The specified settings file name must be fully qualified.
1670	The file must exist and be a valid machine XML settings file
1671	whose contents will be used to construct the machine object.
1672
1673	<result name="VBOX_E_FILE_ERROR">
1674	Settings file name invalid, not found or sharing violation.
1675	</result>
1676	</desc>
1677	<param name="settingsFile" type="wstring" dir="in">
1678	<desc>
1679	Name of the machine settings file.
1680	</desc>
1681	</param>
1682	<param name="machine" type="IMachine" dir="return">
1683	<desc>Opened machine object.</desc>
1684	</param>
1685	<note>
1686	<link to="IMachine::settingsModified"/> will return
1687	@c false for the created machine, until any of machine settings
1688	are changed.
1689	</note>
1690	</method>
1691
1692	<method name="registerMachine">
1693	<desc>
1694
1695	Registers the machine previously created using
1696	<link to="#createMachine"/> or opened using
1697	<link to="#openMachine"/> within this VirtualBox installation. After
1698	successful method invocation, the
1699	<link to="IMachineRegisteredEvent"/> event is fired.
1700
1701	<note>
1702	This method implicitly calls <link to="IMachine::saveSettings"/>
1703	to save all current machine settings before registering it.
1704	</note>
1705
1706	<result name="VBOX_E_OBJECT_NOT_FOUND">
1707	No matching virtual machine found.
1708	</result>
1709	<result name="VBOX_E_INVALID_OBJECT_STATE">
1710	Virtual machine was not created within this VirtualBox instance.
1711	</result>
1712
1713	</desc>
1714	<param name="machine" type="IMachine" dir="in"/>
1715	</method>
1716
1717	<method name="findMachine">
1718	<desc>
1719	Attempts to find a virtual machine given its name or UUID.
1720
1721	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1722	cannot safely be determined.</note>
1723
1724	<result name="VBOX_E_OBJECT_NOT_FOUND">
1725	Could not find registered machine matching @a nameOrId.
1726	</result>
1727
1728	</desc>
1729	<param name="nameOrId" type="wstring" dir="in">
1730	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1731	</param>
1732	<param name="machine" type="IMachine" dir="return">
1733	<desc>Machine object, if found.</desc>
1734	</param>
1735	</method>
1736
1737	<method name="createAppliance">
1738	<desc>
1739	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1740	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1741	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1742	</desc>
1743	<param name="appliance" type="IAppliance" dir="return">
1744	<desc>New appliance.</desc>
1745	</param>
1746	</method>
1747
1748	<method name="createHardDisk">
1749	<desc>
1750	Creates a new base medium object that will use the given storage
1751	format and location for medium data.
1752
1753	Note that the actual storage unit is not created by this method. In
1754	order to do it, and before you are able to attach the created medium
1755	to virtual machines, you must call one of the following methods to
1756	allocate a format-specific storage unit at the specified location:
1757	<ul>
1758	<li><link to="IMedium::createBaseStorage"/></li>
1759	<li><link to="IMedium::createDiffStorage"/></li>
1760	</ul>
1761
1762	Some medium attributes, such as <link to="IMedium::id"/>, may
1763	remain uninitialized until the medium storage unit is successfully
1764	created by one of the above methods.
1765
1766	After the storage unit is successfully created, it will be
1767	accessible through the <link to="#findMedium"/> method and can
1768	be found in the <link to="#hardDisks"/> array.
1769
1770	The list of all storage formats supported by this VirtualBox
1771	installation can be obtained using
1772	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1773	attribute is empty or @c null then the default storage format
1774	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1775	be used for creating a storage unit of the medium.
1776
1777	Note that the format of the location string is storage format specific.
1778	See <link to="IMedium::location"/> and IMedium for more details.
1779
1780	<result name="VBOX_E_OBJECT_NOT_FOUND">
1781	@a format identifier is invalid. See
1782	<link to="ISystemProperties::mediumFormats"/>.
1783	</result>
1784	<result name="VBOX_E_FILE_ERROR">
1785	@a location is a not valid file name (for file-based formats only).
1786	</result>
1787	</desc>
1788	<param name="format" type="wstring" dir="in">
1789	<desc>
1790	Identifier of the storage format to use for the new medium.
1791	</desc>
1792	</param>
1793	<param name="location" type="wstring" dir="in">
1794	<desc>
1795	Location of the storage unit for the new medium.
1796	</desc>
1797	</param>
1798	<param name="medium" type="IMedium" dir="return">
1799	<desc>Created medium object.</desc>
1800	</param>
1801	</method>
1802
1803	<method name="openMedium">
1804	<desc>
1805	Opens a medium from an existing storage location.
1806
1807	Once a medium has been opened, it can be passed to other VirtualBox
1808	methods, in particular to <link to="IMachine::attachDevice" />.
1809
1810	Depending on the given device type, the file at the storage location
1811	must be in one of the media formats understood by VirtualBox:
1812
1813	<ul>
1814	<li>With a "HardDisk" device type, the file must be a hard disk image
1815	in one of the formats supported by VirtualBox (see
1816	<link to="ISystemProperties::mediumFormats" />).
1817	After this method succeeds, if the medium is a base medium, it
1818	will be added to the <link to="#hardDisks"/> array attribute. </li>
1819	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1820	After this method succeeds, the medium will be added to the
1821	<link to="#DVDImages"/> array attribute.</li>
1822	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1823	After this method succeeds, the medium will be added to the
1824	<link to="#floppyImages"/> array attribute.</li>
1825	</ul>
1826
1827	After having been opened, the medium can be found by the <link to="#findMedium"/>
1828	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1829
1830	The UUID of the newly opened medium will either be retrieved from the
1831	storage location, if the format supports it (e.g. for hard disk images),
1832	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1833	If for some reason you need to change the medium's UUID, use
1834	<link to="IMedium::setIDs" />.
1835
1836	If a differencing hard disk medium is to be opened by this method, the
1837	operation will succeed only if its parent medium and all ancestors,
1838	if any, are already known to this VirtualBox installation (for example,
1839	were opened by this method before).
1840
1841	This method attempts to guess the storage format of the specified medium
1842	by reading medium data at the specified location.
1843
1844	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1845	the image is opened for read/write access and must have according permissions,
1846	as VirtualBox may actually write status information into the disk's metadata
1847	sections.
1848
1849	Note that write access is required for all typical hard disk usage in VirtualBox,
1850	since VirtualBox may need to write metadata such as a UUID into the image.
1851	The only exception is opening a source image temporarily for copying and
1852	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1853	again soon.
1854
1855	The format of the location string is storage format specific. See
1856	<link to="IMedium::location"/> and IMedium for more details.
1857
1858	Prior to VirtualBox 4.0, opening a medium added it to a global media
1859	registry in the VirtualBox.xml file, which was shared between all machines
1860	and made transporting machines and their media from one host to another
1861	difficult.
1862
1863	Starting with VirtualBox 4.0, media are only added to a registry when
1864	they are attached to a machine. Machines created with VirtualBox 4.0
1865	or later can have their own media registry. As a result, a medium attached
1866	to such a machine will be remembered in that machine's XML settings file.
1867	Media attached to older machines will continue to be added to the global
1868	registry.
1869
1870	<result name="VBOX_E_FILE_ERROR">
1871	Invalid medium storage file location or could not find the medium
1872	at the specified location.
1873	</result>
1874	<result name="VBOX_E_IPRT_ERROR">
1875	Could not get medium storage format.
1876	</result>
1877	<result name="E_INVALIDARG">
1878	Invalid medium storage format.
1879	</result>
1880	<result name="VBOX_E_INVALID_OBJECT_STATE">
1881	Medium has already been added to a media registry.
1882	</result>
1883	</desc>
1884	<param name="location" type="wstring" dir="in">
1885	<desc>
1886	Location of the storage unit that contains medium data in one of
1887	the supported storage formats.
1888	</desc>
1889	</param>
1890	<param name="deviceType" type="DeviceType" dir="in">
1891	<desc>
1892	Must be one of "HardDisk", "DVD" or "Floppy".
1893	</desc>
1894	</param>
1895	<param name="accessMode" type="AccessMode" dir="in">
1896	<desc>Whether to open the image in read/write or read-only mode. For
1897	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1898	</param>
1899	<param name="medium" type="IMedium" dir="return">
1900	<desc>Opened medium object.</desc>
1901	</param>
1902	</method>
1903
1904	<method name="findMedium">
1905	<desc>
1906	Returns a medium of the given type that uses the given fully qualified
1907	location or UUID to store medium data.
1908
1909	The given medium must be known to this VirtualBox installation, i.e.
1910	it must be previously created by <link to="#createHardDisk"/> or opened
1911	by <link to="#openMedium"/>.
1912
1913	The search is done by comparing the value of the @a location argument to
1914	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1915	attributes of each known medium.
1916
1917	On case sensitive file systems, a case sensitive comparison is performed,
1918	otherwise the case of symbols in the file path is ignored.
1919
1920	<result name="VBOX_E_OBJECT_NOT_FOUND">
1921	No medium object matching @a location found.
1922	</result>
1923	</desc>
1924	<param name="location" type="wstring" dir="in">
1925	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1926	</param>
1927	<param name="type" type="DeviceType" dir="in">
1928	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1929	</param>
1930	<param name="medium" type="IMedium" dir="return">
1931	<desc>Medium object, if found.</desc>
1932	</param>
1933	</method>
1934
1935	<method name="getGuestOSType">
1936	<desc>
1937	Returns an object describing the specified guest OS type.
1938
1939	The requested guest OS type is specified using a string which is a
1940	mnemonic identifier of the guest operating system, such as
1941	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1942	particular virtual machine can be read or set using the
1943	<link to="IMachine::OSTypeId"/> attribute.
1944
1945	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1946	available guest OS type objects. Each object has an
1947	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1948	the guest OS this object describes.
1949
1950	<result name="E_INVALIDARG">
1951	@a id is not a valid Guest OS type.
1952	</result>
1953
1954	</desc>
1955	<param name="id" type="uuid" mod="string" dir="in">
1956	<desc>Guest OS type ID string.</desc>
1957	</param>
1958	<param name="type" type="IGuestOSType" dir="return">
1959	<desc>Guest OS type object.</desc>
1960	</param>
1961	</method>
1962
1963	<method name="createSharedFolder">
1964	<desc>
1965	Creates a new global shared folder by associating the given logical
1966	name with the given host path, adds it to the collection of shared
1967	folders and starts sharing it. Refer to the description of
1968	<link to="ISharedFolder"/> to read more about logical names.
1969	<note>
1970	In the current implementation, this operation is not
1971	implemented.
1972	</note>
1973	</desc>
1974	<param name="name" type="wstring" dir="in">
1975	<desc>Unique logical name of the shared folder.</desc>
1976	</param>
1977	<param name="hostPath" type="wstring" dir="in">
1978	<desc>Full path to the shared folder in the host file system.</desc>
1979	</param>
1980	<param name="writable" type="boolean" dir="in">
1981	<desc>Whether the share is writable or readonly</desc>
1982	</param>
1983	<param name="automount" type="boolean" dir="in">
1984	<desc>Whether the share gets automatically mounted by the guest
1985	or not.</desc>
1986	</param>
1987	</method>
1988
1989	<method name="removeSharedFolder">
1990	<desc>
1991	Removes the global shared folder with the given name previously
1992	created by <link to="#createSharedFolder"/> from the collection of
1993	shared folders and stops sharing it.
1994	<note>
1995	In the current implementation, this operation is not
1996	implemented.
1997	</note>
1998	</desc>
1999	<param name="name" type="wstring" dir="in">
2000	<desc>Logical name of the shared folder to remove.</desc>
2001	</param>
2002	</method>
2003
2004	<method name="getExtraDataKeys">
2005	<desc>
2006	Returns an array representing the global extra data keys which currently
2007	have values defined.
2008	</desc>
2009	<param name="value" type="wstring" dir="return" safearray="yes">
2010	<desc>Array of extra data keys.</desc>
2011	</param>
2012	</method>
2013
2014	<method name="getExtraData">
2015	<desc>
2016	Returns associated global extra data.
2017
2018	If the requested data @a key does not exist, this function will
2019	succeed and return an empty string in the @a value argument.
2020
2021	<result name="VBOX_E_FILE_ERROR">
2022	Settings file not accessible.
2023	</result>
2024	<result name="VBOX_E_XML_ERROR">
2025	Could not parse the settings file.
2026	</result>
2027
2028	</desc>
2029	<param name="key" type="wstring" dir="in">
2030	<desc>Name of the data key to get.</desc>
2031	</param>
2032	<param name="value" type="wstring" dir="return">
2033	<desc>Value of the requested data key.</desc>
2034	</param>
2035	</method>
2036
2037	<method name="setExtraData">
2038	<desc>
2039	Sets associated global extra data.
2040
2041	If you pass @c null or empty string as a key @a value, the given @a key
2042	will be deleted.
2043
2044	<note>
2045	Before performing the actual data change, this method will ask all
2046	registered event listener using the
2047	<link to="IExtraDataCanChangeEvent"/>
2048	notification for a permission. If one of the listeners refuses the
2049	new value, the change will not be performed.
2050	</note>
2051	<note>
2052	On success, the
2053	<link to="IExtraDataChangedEvent"/> notification
2054	is called to inform all registered listeners about a successful data
2055	change.
2056	</note>
2057
2058	<result name="VBOX_E_FILE_ERROR">
2059	Settings file not accessible.
2060	</result>
2061	<result name="VBOX_E_XML_ERROR">
2062	Could not parse the settings file.
2063	</result>
2064	<result name="E_ACCESSDENIED">
2065	Modification request refused.
2066	</result>
2067
2068	</desc>
2069	<param name="key" type="wstring" dir="in">
2070	<desc>Name of the data key to set.</desc>
2071	</param>
2072	<param name="value" type="wstring" dir="in">
2073	<desc>Value to assign to the key.</desc>
2074	</param>
2075	</method>
2076
2077	<!--method name="createDHCPServerForInterface">
2078	<desc>
2079	Creates a dhcp server settings to be used for the given interface
2080	<result name="E_INVALIDARG">
2081	Host network interface @a name already exists.
2082	</result>
2083	</desc>
2084	<param name="interface" type="IHostNetworkInterface" dir="in">
2085	<desc>Network Interface</desc>
2086	</param>
2087	<param name="server" type="IDHCPServer" dir="out">
2088	<desc>Dhcp server settings</desc>
2089	</param>
2090	</method-->
2091
2092	<method name="createDHCPServer">
2093	<desc>
2094	Creates a dhcp server settings to be used for the given internal network name
2095	<result name="E_INVALIDARG">
2096	Host network interface @a name already exists.
2097	</result>
2098	</desc>
2099	<param name="name" type="wstring" dir="in">
2100	<desc>server name</desc>
2101	</param>
2102	<param name="server" type="IDHCPServer" dir="return">
2103	<desc>Dhcp server settings</desc>
2104	</param>
2105	</method>
2106
2107	<method name="findDHCPServerByNetworkName">
2108	<desc>
2109	Searches a dhcp server settings to be used for the given internal network name
2110	<result name="E_INVALIDARG">
2111	Host network interface @a name already exists.
2112	</result>
2113
2114	</desc>
2115	<param name="name" type="wstring" dir="in">
2116	<desc>server name</desc>
2117	</param>
2118	<param name="server" type="IDHCPServer" dir="return">
2119	<desc>Dhcp server settings</desc>
2120	</param>
2121	</method>
2122
2123	<!--method name="findDHCPServerForInterface">
2124	<desc>
2125	Searches a dhcp server settings to be used for the given interface
2126	<result name="E_INVALIDARG">
2127	Host network interface @a name already exists.
2128	</result>
2129	</desc>
2130	<param name="interface" type="IHostNetworkInterface" dir="in">
2131	<desc>Network Interface</desc>
2132	</param>
2133	<param name="server" type="IDHCPServer" dir="out">
2134	<desc>Dhcp server settings</desc>
2135	</param>
2136	</method-->
2137
2138	<method name="removeDHCPServer">
2139	<desc>
2140	Removes the dhcp server settings
2141	<result name="E_INVALIDARG">
2142	Host network interface @a name already exists.
2143	</result>
2144	</desc>
2145	<param name="server" type="IDHCPServer" dir="in">
2146	<desc>Dhcp server settings to be removed</desc>
2147	</param>
2148	</method>
2149
2150
2151	<method name="checkFirmwarePresent">
2152	<desc>
2153	Check if this VirtualBox installation has a firmware
2154	of the given type available, either system-wide or per-user.
2155	Optionally, this may return a hint where this firmware can be
2156	downloaded from.
2157	</desc>
2158	<param name="firmwareType" type="FirmwareType" dir="in">
2159	<desc>
2160	Type of firmware to check.
2161	</desc>
2162	</param>
2163	<param name="version" type="wstring" dir="in">
2164	<desc>Expected version number, usually empty string (presently ignored).</desc>
2165	</param>
2166
2167	<param name="url" type="wstring" dir="out">
2168	<desc>
2169	Suggested URL to download this firmware from.
2170	</desc>
2171	</param>
2172
2173	<param name="file" type="wstring" dir="out">
2174	<desc>
2175	Filename of firmware, only valid if result == TRUE.
2176	</desc>
2177	</param>
2178
2179	<param name="result" type="boolean" dir="return">
2180	<desc>If firmware of this type and version is available.</desc>
2181	</param>
2182	</method>
2183
2184	<method name="VRDERegisterLibrary">
2185	<desc>
2186	Appends a VRDE library to this VirtualBox installation.
2187
2188	The library implements a VirtualBox Remote Desktop Extension (VRDE),
2189	which is used to remotely connect to the virtual machines.
2190
2191	The system library extension (".DLL" or ".so") must be omitted.
2192	The library must reside in the VirtualBox installation directory.
2193	</desc>
2194	<param name="name" type="wstring" dir="in">
2195	<desc>The library name.</desc>
2196	</param>
2197	</method>
2198
2199	<method name="VRDEUnregisterLibrary">
2200	<desc>
2201	Removes a VRDE library from this VirtualBox installation.
2202	</desc>
2203	<param name="name" type="wstring" dir="in">
2204	<desc>The library name.</desc>
2205	</param>
2206	</method>
2207
2208	<method name="VRDEListLibraries">
2209	<desc>
2210	List registered libraries.
2211	</desc>
2212	<param name="names" type="wstring" dir="return" safearray="yes">
2213	<desc>Array of names of the libraries.</desc>
2214	</param>
2215	</method>
2216
2217	<method name="VRDEIsLibraryRegistered">
2218	<desc>
2219	Check if the library is registered.
2220	</desc>
2221	<param name="name" type="wstring" dir="in">
2222	<desc>The library name.</desc>
2223	</param>
2224	<param name="registered" type="boolean" dir="return">
2225	<desc>Whether the library is registered.</desc>
2226	</param>
2227	</method>
2228
2229	</interface>
2230
2231	<!--
2232	// IVFSExplorer
2233	/////////////////////////////////////////////////////////////////////////
2234	-->
2235
2236	<enum
2237	name="VFSType"
2238	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2239	>
2240	<desc>
2241	Virtual file systems supported by VFSExplorer.
2242	</desc>
2243
2244	<const name="File" value="1" />
2245	<const name="Cloud" value="2" />
2246	<const name="S3" value="3" />
2247	<const name="WebDav" value="4" />
2248	</enum>
2249
2250	<enum
2251	name="VFSFileType"
2252	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2253	>
2254	<desc>
2255	File types known by VFSExplorer.
2256	</desc>
2257
2258	<const name="Unknown" value="1" />
2259	<const name="Fifo" value="2" />
2260	<const name="DevChar" value="3" />
2261	<const name="Directory" value="4" />
2262	<const name="DevBlock" value="5" />
2263	<const name="File" value="6" />
2264	<const name="SymLink" value="7" />
2265	<const name="Socket" value="8" />
2266	<const name="WhiteOut" value="9" />
2267	</enum>
2268
2269	<interface
2270	name="IVFSExplorer" extends="$unknown"
2271	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2272	wsmap="managed"
2273	>
2274	<desc>
2275	The VFSExplorer interface unifies access to different file system
2276	types. This includes local file systems as well remote file systems like
2277	S3. For a list of supported types see <link to="VFSType" />.
2278	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2279	</desc>
2280
2281	<attribute name="path" type="wstring" readonly="yes">
2282	<desc>Returns the current path in the virtual file system.</desc>
2283	</attribute>
2284
2285	<attribute name="type" type="VFSType" readonly="yes">
2286	<desc>Returns the file system type which is currently in use.</desc>
2287	</attribute>
2288
2289	<method name="update">
2290	<desc>Updates the internal list of files/directories from the
2291	current directory level. Use <link to="#entryList" /> to get the full list
2292	after a call to this method.</desc>
2293
2294	<param name="aProgress" type="IProgress" dir="return">
2295	<desc>Progress object to track the operation completion.</desc>
2296	</param>
2297	</method>
2298
2299	<method name="cd">
2300	<desc>Change the current directory level.</desc>
2301
2302	<param name="aDir" type="wstring" dir="in">
2303	<desc>The name of the directory to go in.</desc>
2304	</param>
2305
2306	<param name="aProgress" type="IProgress" dir="return">
2307	<desc>Progress object to track the operation completion.</desc>
2308	</param>
2309	</method>
2310
2311	<method name="cdUp">
2312	<desc>Go one directory upwards from the current directory level.</desc>
2313
2314	<param name="aProgress" type="IProgress" dir="return">
2315	<desc>Progress object to track the operation completion.</desc>
2316	</param>
2317	</method>
2318
2319	<method name="entryList">
2320	<desc>Returns a list of files/directories after a call to <link
2321	to="#update" />. The user is responsible for keeping this internal
2322	list up do date.</desc>
2323
2324	<param name="aNames" type="wstring" safearray="yes" dir="out">
2325	<desc>The list of names for the entries.</desc>
2326	</param>
2327
2328	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2329	<desc>The list of types for the entries.</desc>
2330	</param>
2331
2332	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2333	<desc>The list of sizes (in bytes) for the entries.</desc>
2334	</param>
2335
2336	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2337	<desc>The list of file modes (in octal form) for the entries.</desc>
2338	</param>
2339	</method>
2340
2341	<method name="exists">
2342	<desc>Checks if the given file list exists in the current directory
2343	level.</desc>
2344
2345	<param name="aNames" type="wstring" safearray="yes" dir="in">
2346	<desc>The names to check.</desc>
2347	</param>
2348
2349	<param name="aExists" type="wstring" safearray="yes" dir="return">
2350	<desc>The names which exist.</desc>
2351	</param>
2352	</method>
2353
2354	<method name="remove">
2355	<desc>Deletes the given files in the current directory level.</desc>
2356
2357	<param name="aNames" type="wstring" safearray="yes" dir="in">
2358	<desc>The names to remove.</desc>
2359	</param>
2360
2361	<param name="aProgress" type="IProgress" dir="return">
2362	<desc>Progress object to track the operation completion.</desc>
2363	</param>
2364	</method>
2365
2366	</interface>
2367
2368	<!--
2369	// IAppliance
2370	/////////////////////////////////////////////////////////////////////////
2371	-->
2372
2373	<interface
2374	name="IAppliance" extends="$unknown"
2375	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2376	wsmap="managed"
2377	>
2378	<desc>
2379	Represents a platform-independent appliance in OVF format. An instance of this is returned
2380	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2381	virtual machines within an appliance with VirtualBox.
2382
2383	The OVF standard suggests two different physical file formats:
2384
2385	<ol>
2386	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2387	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2388	this descriptor file references other files such as disk images, as OVF appliances typically
2389	do, those additional files must be in the same directory as the descriptor file.</li>
2390
2391	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2392	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2393	files and optionally other files.
2394
2395	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2396	be added with a later version.</li>
2397	</ol>
2398
2399	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2400	<link to="IMachine" /> involves the following sequence of API calls:
2401
2402	<ol>
2403	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2404	</li>
2405
2406	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2407	would like to import. So long as this file is syntactically valid, this will succeed
2408	and fill the appliance object with the parsed data from the OVF file.
2409	</li>
2410
2411	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2412	contents of the IAppliance attributes accordingly. These can be inspected by a
2413	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2414	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2415	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2416	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2417	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2418	The GUI can then give the user the option to confirm and/or change these suggestions.
2419	</li>
2420
2421	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2422	virtual system (machine) to override the suggestions made by the interpret() routine.
2423	</li>
2424
2425	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2426	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2427	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2428	can be found in the <link to="#machines" /> array attribute.
2429	</li>
2430	</ol>
2431
2432	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2433
2434	<ol>
2435	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2436	an empty IAppliance object.
2437	</li>
2438
2439	<li>For each machine you would like to export, call <link to="IMachine::export" />
2440	with the IAppliance object you just created. Each such call creates one instance of
2441	<link to="IVirtualSystemDescription" /> inside the appliance.
2442	</li>
2443
2444	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2445	virtual system (machine) to override the suggestions made by the export() routine.
2446	</li>
2447
2448	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2449	file written.</li>
2450	</ol>
2451
2452	</desc>
2453
2454	<attribute name="path" type="wstring" readonly="yes">
2455	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2456	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2457	<link to="#write" /> (for export).
2458	This attribute is empty until one of these methods has been called.
2459	</desc>
2460	</attribute>
2461
2462	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2463	<desc>
2464	Array of virtual disk definitions. One such description exists for each
2465	disk definition in the OVF; each string array item represents one such piece of
2466	disk information, with the information fields separated by tab (\t) characters.
2467
2468	The caller should be prepared for additional fields being appended to
2469	this string in future versions of VirtualBox and therefore check for
2470	the number of tabs in the strings returned.
2471
2472	In the current version, the following eight fields are returned per string
2473	in the array:
2474
2475	<ol>
2476	<li>Disk ID (unique string identifier given to disk)</li>
2477
2478	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2479
2480	<li>Populated size (optional unsigned integer indicating the current size of the
2481	disk; can be approximate; -1 if unspecified)</li>
2482
2483	<li>Format (string identifying the disk format, typically
2484	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2485
2486	<li>Reference (where to find the disk image, typically a file name; if empty,
2487	then the disk should be created on import)</li>
2488
2489	<li>Image size (optional unsigned integer indicating the size of the image,
2490	which need not necessarily be the same as the values specified above, since
2491	the image may be compressed or sparse; -1 if not specified)</li>
2492
2493	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2494	presently unsupported and always -1)</li>
2495
2496	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2497	</ol>
2498	</desc>
2499	</attribute>
2500
2501	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2502	<desc> Array of virtual system descriptions. One such description is created
2503	for each virtual system (machine) found in the OVF.
2504	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2505	(for export) has been called.
2506	</desc>
2507	</attribute>
2508
2509	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2510	<desc>
2511	Contains the UUIDs of the machines created from the information in this appliances. This is only
2512	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2513	succeeded.
2514	</desc>
2515	</attribute>
2516
2517	<method name="read">
2518	<desc>
2519	Reads an OVF file into the appliance object.
2520
2521	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2522	mere fact that this method returns successfully does not mean that VirtualBox supports all
2523	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2524	</desc>
2525	<param name="file" type="wstring" dir="in">
2526	<desc>
2527	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2528	on whether the appliance is distributed as a set of files or as a single file, respectively).
2529	</desc>
2530	</param>
2531	<param name="aProgress" type="IProgress" dir="return">
2532	<desc>Progress object to track the operation completion.</desc>
2533	</param>
2534	</method>
2535
2536	<method name="interpret">
2537	<desc>
2538	Interprets the OVF data that was read when the appliance was constructed. After
2539	calling this method, one can inspect the
2540	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2541	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2542	the appliance.
2543
2544	Calling this method is the second step of importing an appliance into VirtualBox;
2545	see <link to="IAppliance" /> for an overview.
2546
2547	After calling this method, one should call <link to="#getWarnings" /> to find out
2548	if problems were encountered during the processing which might later lead to
2549	errors.
2550	</desc>
2551	</method>
2552
2553	<method name="importMachines">
2554	<desc>
2555	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2556	and other interfaces that match the information contained in the appliance as
2557	closely as possible, as represented by the import instructions in the
2558	<link to="#virtualSystemDescriptions" /> array.
2559
2560	Calling this method is the final step of importing an appliance into VirtualBox;
2561	see <link to="IAppliance" /> for an overview.
2562
2563	Since importing the appliance will most probably involve copying and converting
2564	disk images, which can take a long time, this method operates asynchronously and
2565	returns an IProgress object to allow the caller to monitor the progress.
2566
2567	After the import succeeded, the UUIDs of the IMachine instances created can be
2568	retrieved from the <link to="#machines" /> array attribute.
2569	</desc>
2570
2571	<param name="aProgress" type="IProgress" dir="return">
2572	<desc>Progress object to track the operation completion.</desc>
2573	</param>
2574	</method>
2575
2576	<method name="createVFSExplorer">
2577	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2578
2579	<param name="aUri" type="wstring" dir="in">
2580	<desc>The URI describing the file system to use.</desc>
2581	</param>
2582
2583	<param name="aExplorer" type="IVFSExplorer" dir="return">
2584	<desc></desc>
2585	</param>
2586	</method>
2587
2588	<method name="write">
2589	<desc>
2590	Writes the contents of the appliance exports into a new OVF file.
2591
2592	Calling this method is the final step of exporting an appliance from VirtualBox;
2593	see <link to="IAppliance" /> for an overview.
2594
2595	Since exporting the appliance will most probably involve copying and converting
2596	disk images, which can take a long time, this method operates asynchronously and
2597	returns an IProgress object to allow the caller to monitor the progress.
2598	</desc>
2599	<param name="format" type="wstring" dir="in">
2600	<desc>
2601	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2602	future versions of VirtualBox may support additional formats.
2603	</desc>
2604	</param>
2605	<param name="manifest" type="boolean" dir="in">
2606	<desc>
2607	Indicate if the optional manifest file (.mf) should be written. The manifest file
2608	is used for integrity checks prior import.
2609	</desc>
2610	</param>
2611	<param name="path" type="wstring" dir="in">
2612	<desc>
2613	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2614	on whether the appliance is distributed as a set of files or as a single file, respectively).
2615	</desc>
2616	</param>
2617	<param name="progress" type="IProgress" dir="return">
2618	<desc>Progress object to track the operation completion.</desc>
2619	</param>
2620	</method>
2621
2622	<method name="getWarnings">
2623	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2624
2625	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2626	<desc></desc>
2627	</param>
2628	</method>
2629
2630	</interface>
2631
2632	<enum
2633	name="VirtualSystemDescriptionType"
2634	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2635	>
2636	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2637	a configuration value.</desc>
2638
2639	<const name="Ignore" value="1" />
2640	<const name="OS" value="2" />
2641	<const name="Name" value="3" />
2642	<const name="Product" value="4" />
2643	<const name="Vendor" value="5" />
2644	<const name="Version" value="6" />
2645	<const name="ProductUrl" value="7" />
2646	<const name="VendorUrl" value="8" />
2647	<const name="Description" value="9" />
2648	<const name="License" value="10" />
2649	<const name="Miscellaneous" value="11" />
2650	<const name="CPU" value="12" />
2651	<const name="Memory" value="13" />
2652	<const name="HardDiskControllerIDE" value="14" />
2653	<const name="HardDiskControllerSATA" value="15" />
2654	<const name="HardDiskControllerSCSI" value="16" />
2655	<const name="HardDiskControllerSAS" value="17" />
2656	<const name="HardDiskImage" value="18" />
2657	<const name="Floppy" value="19" />
2658	<const name="CDROM" value="20" />
2659	<const name="NetworkAdapter" value="21" />
2660	<const name="USBController" value="22" />
2661	<const name="SoundCard" value="23" />
2662
2663	</enum>
2664
2665	<enum
2666	name="VirtualSystemDescriptionValueType"
2667	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2668	>
2669	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2670	type to fetch.</desc>
2671
2672	<const name="Reference" value="1" />
2673	<const name="Original" value="2" />
2674	<const name="Auto" value="3" />
2675	<const name="ExtraConfig" value="4" />
2676
2677	</enum>
2678
2679	<interface
2680	name="IVirtualSystemDescription" extends="$unknown"
2681	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2682	wsmap="managed"
2683	>
2684
2685	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2686	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2687	<link to="IAppliance::interpret" /> has been called, that array contains information
2688	about how the virtual systems described in the OVF should best be imported into
2689	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2690	import an OVF into VirtualBox.
2691	</desc>
2692
2693	<attribute name="count" type="unsigned long" readonly="yes">
2694	<desc>Return the number of virtual system description entries.</desc>
2695	</attribute>
2696
2697	<method name="getDescription">
2698	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2699	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2700
2701	The list below identifies the value sets that are possible depending on the
2702	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2703	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2704	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2705	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2706	the @a aExtraConfigValues[] array item may also be used.
2707
2708	<ul>
2709	<li>
2710	"OS": the guest operating system type. There must be exactly one such array item on import. The
2711	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2712	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2713	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2714	</li>
2715	<li>
2716	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2717	if none is present on import, then an automatic name will be created from the operating system
2718	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2719	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2720	<link to="IMachine" /> name that does not exist yet.
2721	</li>
2722	<li>
2723	"Description": an arbitrary description.
2724	</li>
2725	<li>
2726	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2727	code to display such a license for agreement; the Main API does not enforce any such policy.
2728	</li>
2729	<li>
2730	Miscellaneous: reserved for future use.
2731	</li>
2732	<li>
2733	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2734	</li>
2735	<li>
2736	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2737	is present on import, then VirtualBox will set a meaningful default based on the operating system
2738	type.
2739	</li>
2740	<li>
2741	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2742	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2743	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2744	writes into the OVF.
2745	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2746	type can use to specify which hard disk controller a virtual disk should be connected to.
2747	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2748	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2749	its virtual machines supports four channels (primary master, primary slave, secondary master,
2750	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2751	</li>
2752	<li>
2753	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2754	has no value in @a aOvfValues[] or @a aVBoxValues[].
2755	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2756	</li>
2757	<li>
2758	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2759	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2760	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2761	whereas VirtualBox considers it a class of storage controllers of its own; see
2762	<link to="StorageControllerType" />).
2763	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2764	</li>
2765	<li>
2766	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2767	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2768
2769	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2770	a path since the image file should be in the same location as the OVF file itself), whereas the
2771	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2772	hard disk image. This means that on import the image will be copied and converted from the
2773	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2774
2775	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2776	format: "controller=<index>;channel=<c>"
2777	In this string, <index> must be an integer specifying the hard disk controller to connect
2778	the image to. That number must be the index of an array item with one of the hard disk controller
2779	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2780	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2781	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2782	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2783	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2784	</li>
2785	<li>
2786	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2787	attachment information as with "HardDiskImage" items.
2788	</li>
2789	<li>
2790	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2791	attachment information as with "HardDiskImage" items.
2792	</li>
2793	<li>
2794	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2795	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2796	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2797	</li>
2798	<li>
2799	"USBController": a USB controller. There can be at most one such item. If and only if such an
2800	item ispresent, USB support will be enabled for the new virtual machine.
2801	</li>
2802	<li>
2803	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2804	present, sound support will be enabled for the new virtual machine. Note that the virtual
2805	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2806	may be different from the virtual soundcard expected by the appliance.
2807	</li>
2808	</ul>
2809
2810	</desc>
2811
2812	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2813	<desc></desc>
2814	</param>
2815
2816	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2817	<desc></desc>
2818	</param>
2819
2820	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	</method>
2833
2834	<method name="getDescriptionByType">
2835	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2836	should be returned.</desc>
2837
2838	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2839	<desc></desc>
2840	</param>
2841
2842	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2843	<desc></desc>
2844	</param>
2845
2846	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	</method>
2863
2864	<method name="getValuesByType">
2865	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2866	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2867	values.</desc>
2868
2869	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2870	<desc></desc>
2871	</param>
2872
2873	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2874	<desc></desc>
2875	</param>
2876
2877	<param name="aValues" type="wstring" dir="return" safearray="yes">
2878	<desc></desc>
2879	</param>
2880
2881	</method>
2882
2883	<method name="setFinalValues">
2884	<desc>
2885	This method allows the appliance's user to change the configuration for the virtual
2886	system descriptions. For each array item returned from <link to="#getDescription" />,
2887	you must pass in one boolean value and one configuration value.
2888
2889	Each item in the boolean array determines whether the particular configuration item
2890	should be enabled.
2891	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2892	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2893	and SoundCard.
2894
2895	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2896	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2897	the configuration remains unchanged. Please see the documentation for getDescription()
2898	for valid configuration values for the individual array item types. If the
2899	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2900	</desc>
2901
2902	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2903	<desc></desc>
2904	</param>
2905
2906	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2907	<desc></desc>
2908	</param>
2909
2910	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2911	<desc></desc>
2912	</param>
2913	</method>
2914
2915	<method name="addDescription">
2916	<desc>
2917	This method adds an additional description entry to the stack of already
2918	available descriptions for this virtual system. This is handy for writing
2919	values which aren't directly supported by VirtualBox. One example would
2920	be the License type of <link to="VirtualSystemDescriptionType" />.
2921	</desc>
2922
2923	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2924	<desc></desc>
2925	</param>
2926
2927	<param name="aVBoxValue" type="wstring" dir="in">
2928	<desc></desc>
2929	</param>
2930
2931	<param name="aExtraConfigValue" type="wstring" dir="in">
2932	<desc></desc>
2933	</param>
2934	</method>
2935	</interface>
2936
2937
2938	<!--
2939	// IMachine
2940	/////////////////////////////////////////////////////////////////////////
2941	-->
2942
2943	<interface
2944	name="IInternalMachineControl" extends="$unknown"
2945	uuid="476126af-e223-4490-a8a0-b1f1575be013"
2946	internal="yes"
2947	wsmap="suppress"
2948	>
2949	<method name="setRemoveSavedStateFile">
2950	<desc>
2951	Updates the flag whether the saved state file is removed on a
2952	machine state change from Saved to PoweredOff.
2953	</desc>
2954	<param name="aRemove" type="boolean" dir="in"/>
2955	</method>
2956
2957	<method name="updateState">
2958	<desc>
2959	Updates the VM state.
2960	<note>
2961	This operation will also update the settings file with the correct
2962	information about the saved state file and delete this file from disk
2963	when appropriate.
2964	</note>
2965	</desc>
2966	<param name="state" type="MachineState" dir="in"/>
2967	</method>
2968
2969	<method name="getIPCId">
2970	<param name="id" type="wstring" dir="return"/>
2971	</method>
2972
2973	<method name="beginPowerUp">
2974	<desc>
2975	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2976	gives it the progress object that should be part of any pending
2977	<link to="IMachine::launchVMProcess"/> operations. The progress
2978	object may be called back to reflect an early cancelation, so some care
2979	have to be taken with respect to any cancelation callbacks. The console
2980	object will call <link to="IInternalMachineControl::endPowerUp"/>
2981	to signal the completion of the progress object.
2982	</desc>
2983	<param name="aProgress" type="IProgress" dir="in" />
2984	</method>
2985
2986	<method name="endPowerUp">
2987	<desc>
2988	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2989	This method may query status information from the progress object it
2990	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2991	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2992	call in order to complete that progress object.
2993	</desc>
2994	<param name="result" type="long" dir="in"/>
2995	</method>
2996
2997	<method name="runUSBDeviceFilters">
2998	<desc>
2999	Asks the server to run USB devices filters of the associated
3000	machine against the given USB device and tell if there is
3001	a match.
3002	<note>
3003	Intended to be used only for remote USB devices. Local
3004	ones don't require to call this method (this is done
3005	implicitly by the Host and USBProxyService).
3006	</note>
3007	</desc>
3008	<param name="device" type="IUSBDevice" dir="in"/>
3009	<param name="matched" type="boolean" dir="out"/>
3010	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3011	</method>
3012
3013	<method name="captureUSBDevice">
3014	<desc>
3015	Requests a capture of the given host USB device.
3016	When the request is completed, the VM process will
3017	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3018	notification.
3019	</desc>
3020	<param name="id" type="uuid" mod="string" dir="in"/>
3021	</method>
3022
3023	<method name="detachUSBDevice">
3024	<desc>
3025	Notification that a VM is going to detach (@a done = @c false) or has
3026	already detached (@a done = @c true) the given USB device.
3027	When the @a done = @c true request is completed, the VM process will
3028	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3029	notification.
3030	<note>
3031	In the @a done = @c true case, the server must run its own filters
3032	and filters of all VMs but this one on the detached device
3033	as if it were just attached to the host computer.
3034	</note>
3035	</desc>
3036	<param name="id" type="uuid" mod="string" dir="in"/>
3037	<param name="done" type="boolean" dir="in"/>
3038	</method>
3039
3040	<method name="autoCaptureUSBDevices">
3041	<desc>
3042	Requests a capture all matching USB devices attached to the host.
3043	When the request is completed, the VM process will
3044	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3045	notification per every captured device.
3046	</desc>
3047	</method>
3048
3049	<method name="detachAllUSBDevices">
3050	<desc>
3051	Notification that a VM that is being powered down. The done
3052	parameter indicates whether which stage of the power down
3053	we're at. When @a done = @c false the VM is announcing its
3054	intentions, while when @a done = @c true the VM is reporting
3055	what it has done.
3056	<note>
3057	In the @a done = @c true case, the server must run its own filters
3058	and filters of all VMs but this one on all detach devices as
3059	if they were just attached to the host computer.
3060	</note>
3061	</desc>
3062	<param name="done" type="boolean" dir="in"/>
3063	</method>
3064
3065	<method name="onSessionEnd">
3066	<desc>
3067	Triggered by the given session object when the session is about
3068	to close normally.
3069	</desc>
3070	<param name="session" type="ISession" dir="in">
3071	<desc>Session that is being closed</desc>
3072	</param>
3073	<param name="progress" type="IProgress" dir="return">
3074	<desc>
3075	Used to wait until the corresponding machine is actually
3076	dissociated from the given session on the server.
3077	Returned only when this session is a direct one.
3078	</desc>
3079	</param>
3080	</method>
3081
3082	<method name="beginSavingState">
3083	<desc>
3084	Called by the VM process to inform the server it wants to
3085	save the current state and stop the VM execution.
3086	</desc>
3087	<param name="progress" type="IProgress" dir="out">
3088	<desc>
3089	Progress object created by VBoxSVC to wait until
3090	the state is saved.
3091	</desc>
3092	</param>
3093	<param name="stateFilePath" type="wstring" dir="out">
3094	<desc>
3095	File path the VM process must save the execution state to.
3096	</desc>
3097	</param>
3098	</method>
3099
3100	<method name="endSavingState">
3101	<desc>
3102	Called by the VM process to inform the server that saving
3103	the state previously requested by #beginSavingState is either
3104	successfully finished or there was a failure.
3105
3106	<result name="VBOX_E_FILE_ERROR">
3107	Settings file not accessible.
3108	</result>
3109	<result name="VBOX_E_XML_ERROR">
3110	Could not parse the settings file.
3111	</result>
3112
3113	</desc>
3114
3115	<param name="result" type="long" dir="in">
3116	<desc>@c S_OK to indicate success.
3117	</desc>
3118	</param>
3119	<param name="errMsg" type="wstring" dir="in">
3120	<desc>@c human readable error message in case of failure.
3121	</desc>
3122	</param>
3123	</method>
3124
3125	<method name="adoptSavedState">
3126	<desc>
3127	Gets called by IConsole::adoptSavedState.
3128	<result name="VBOX_E_FILE_ERROR">
3129	Invalid saved state file path.
3130	</result>
3131	</desc>
3132	<param name="savedStateFile" type="wstring" dir="in">
3133	<desc>Path to the saved state file to adopt.</desc>
3134	</param>
3135	</method>
3136
3137	<method name="beginTakingSnapshot">
3138	<desc>
3139	Called from the VM process to request from the server to perform the
3140	server-side actions of creating a snapshot (creating differencing images
3141	and the snapshot object).
3142
3143	<result name="VBOX_E_FILE_ERROR">
3144	Settings file not accessible.
3145	</result>
3146	<result name="VBOX_E_XML_ERROR">
3147	Could not parse the settings file.
3148	</result>
3149	</desc>
3150	<param name="initiator" type="IConsole" dir="in">
3151	<desc>The console object that initiated this call.</desc>
3152	</param>
3153	<param name="name" type="wstring" dir="in">
3154	<desc>Snapshot name.</desc>
3155	</param>
3156	<param name="description" type="wstring" dir="in">
3157	<desc>Snapshot description.</desc>
3158	</param>
3159	<param name="consoleProgress" type="IProgress" dir="in">
3160	<desc>
3161	Progress object created by the VM process tracking the
3162	snapshot's progress. This has the following sub-operations:
3163	<ul>
3164	<li>setting up (weight 1);</li>
3165	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3166	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3167	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3168	<li>finishing up (weight 1)</li>
3169	</ul>
3170	</desc>
3171	</param>
3172	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3173	<desc>
3174	Whether this is an online snapshot (i.e. the machine is running).
3175	</desc>
3176	</param>
3177	<param name="stateFilePath" type="wstring" dir="out">
3178	<desc>
3179	File path the VM process must save the execution state to.
3180	</desc>
3181	</param>
3182	</method>
3183
3184	<method name="endTakingSnapshot">
3185	<desc>
3186	Called by the VM process to inform the server that the snapshot
3187	previously requested by #beginTakingSnapshot is either
3188	successfully taken or there was a failure.
3189	</desc>
3190
3191	<param name="success" type="boolean" dir="in">
3192	<desc>@c true to indicate success and @c false otherwise</desc>
3193	</param>
3194	</method>
3195
3196	<method name="deleteSnapshot">
3197	<desc>
3198	Gets called by IConsole::deleteSnapshot.
3199	<result name="VBOX_E_INVALID_OBJECT_STATE">
3200	Snapshot has more than one child snapshot.
3201	</result>
3202	</desc>
3203	<param name="initiator" type="IConsole" dir="in">
3204	<desc>The console object that initiated this call.</desc>
3205	</param>
3206	<param name="id" type="uuid" mod="string" dir="in">
3207	<desc>UUID of the snapshot to delete.</desc>
3208	</param>
3209	<param name="machineState" type="MachineState" dir="out">
3210	<desc>New machine state after this operation is started.</desc>
3211	</param>
3212	<param name="progress" type="IProgress" dir="return">
3213	<desc>Progress object to track the operation completion.</desc>
3214	</param>
3215	</method>
3216
3217	<method name="finishOnlineMergeMedium">
3218	<desc>
3219	Gets called by IConsole::onlineMergeMedium.
3220	</desc>
3221	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3222	<desc>The medium attachment which needs to be cleaned up.</desc>
3223	</param>
3224	<param name="source" type="IMedium" dir="in">
3225	<desc>Merge source medium.</desc>
3226	</param>
3227	<param name="target" type="IMedium" dir="in">
3228	<desc>Merge target medium.</desc>
3229	</param>
3230	<param name="mergeForward" type="boolean" dir="in">
3231	<desc>Merge direction.</desc>
3232	</param>
3233	<param name="parentForTarget" type="IMedium" dir="in">
3234	<desc>For forward merges: new parent for target medium.</desc>
3235	</param>
3236	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3237	<desc>For backward merges: list of media which need their parent UUID
3238	updated.</desc>
3239	</param>
3240	</method>
3241
3242	<method name="restoreSnapshot">
3243	<desc>
3244	Gets called by IConsole::RestoreSnapshot.
3245	</desc>
3246	<param name="initiator" type="IConsole" dir="in">
3247	<desc>The console object that initiated this call.</desc>
3248	</param>
3249	<param name="snapshot" type="ISnapshot" dir="in">
3250	<desc>The snapshot to restore the VM state from.</desc>
3251	</param>
3252	<param name="machineState" type="MachineState" dir="out">
3253	<desc>New machine state after this operation is started.</desc>
3254	</param>
3255	<param name="progress" type="IProgress" dir="return">
3256	<desc>Progress object to track the operation completion.</desc>
3257	</param>
3258	</method>
3259
3260	<method name="pullGuestProperties">
3261	<desc>
3262	Get the list of the guest properties matching a set of patterns along
3263	with their values, time stamps and flags and give responsibility for
3264	managing properties to the console.
3265	</desc>
3266	<param name="name" type="wstring" dir="out" safearray="yes">
3267	<desc>
3268	The names of the properties returned.
3269	</desc>
3270	</param>
3271	<param name="value" type="wstring" dir="out" safearray="yes">
3272	<desc>
3273	The values of the properties returned. The array entries match the
3274	corresponding entries in the @a name array.
3275	</desc>
3276	</param>
3277	<param name="timestamp" type="long long" dir="out" safearray="yes">
3278	<desc>
3279	The time stamps of the properties returned. The array entries match
3280	the corresponding entries in the @a name array.
3281	</desc>
3282	</param>
3283	<param name="flags" type="wstring" dir="out" safearray="yes">
3284	<desc>
3285	The flags of the properties returned. The array entries match the
3286	corresponding entries in the @a name array.
3287	</desc>
3288	</param>
3289	</method>
3290
3291	<method name="pushGuestProperty">
3292	<desc>
3293	Update a single guest property in IMachine.
3294	</desc>
3295	<param name="name" type="wstring" dir="in">
3296	<desc>
3297	The name of the property to be updated.
3298	</desc>
3299	</param>
3300	<param name="value" type="wstring" dir="in">
3301	<desc>
3302	The value of the property.
3303	</desc>
3304	</param>
3305	<param name="timestamp" type="long long" dir="in">
3306	<desc>
3307	The timestamp of the property.
3308	</desc>
3309	</param>
3310	<param name="flags" type="wstring" dir="in">
3311	<desc>
3312	The flags of the property.
3313	</desc>
3314	</param>
3315	</method>
3316
3317	<method name="lockMedia">
3318	<desc>
3319	Locks all media attached to the machine for writing and parents of
3320	attached differencing media (if any) for reading. This operation is
3321	atomic so that if it fails no media is actually locked.
3322
3323	This method is intended to be called when the machine is in Starting or
3324	Restoring state. The locked media will be automatically unlocked when
3325	the machine is powered off or crashed.
3326	</desc>
3327	</method>
3328	<method name="unlockMedia">
3329	<desc>
3330	Unlocks all media previously locked using
3331	<link to="IInternalMachineControl::lockMedia"/>.
3332
3333	This method is intended to be used with teleportation so that it is
3334	possible to teleport between processes on the same machine.
3335	</desc>
3336	</method>
3337	</interface>
3338
3339	<interface
3340	name="IBIOSSettings" extends="$unknown"
3341	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3342	wsmap="managed"
3343	>
3344	<desc>
3345	The IBIOSSettings interface represents BIOS settings of the virtual
3346	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3347	</desc>
3348	<attribute name="logoFadeIn" type="boolean">
3349	<desc>Fade in flag for BIOS logo animation.</desc>
3350	</attribute>
3351
3352	<attribute name="logoFadeOut" type="boolean">
3353	<desc>Fade out flag for BIOS logo animation.</desc>
3354	</attribute>
3355
3356	<attribute name="logoDisplayTime" type="unsigned long">
3357	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3358	</attribute>
3359
3360	<attribute name="logoImagePath" type="wstring">
3361	<desc>
3362	Local file system path for external BIOS splash image. Empty string
3363	means the default image is shown on boot.
3364	</desc>
3365	</attribute>
3366
3367	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3368	<desc>Mode of the BIOS boot device menu.</desc>
3369	</attribute>
3370
3371	<attribute name="ACPIEnabled" type="boolean">
3372	<desc>ACPI support flag.</desc>
3373	</attribute>
3374
3375	<attribute name="IOAPICEnabled" type="boolean">
3376	<desc>
3377	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3378	and support IRQs above 15.
3379	</desc>
3380	</attribute>
3381
3382	<attribute name="timeOffset" type="long long">
3383	<desc>
3384	Offset in milliseconds from the host system time. This allows for
3385	guests running with a different system date/time than the host.
3386	It is equivalent to setting the system date/time in the BIOS except
3387	it is not an absolute value but a relative one. Guest Additions
3388	time synchronization honors this offset.
3389	</desc>
3390	</attribute>
3391
3392	<attribute name="PXEDebugEnabled" type="boolean">
3393	<desc>
3394	PXE debug logging flag. If set, VirtualBox will write extensive
3395	PXE trace information to the release log.
3396	</desc>
3397	</attribute>
3398
3399	</interface>
3400
3401	<enum name="CleanupMode"
3402	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3403	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3404	</desc>
3405	<const name="UnregisterOnly" value="1">
3406	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3407	</const>
3408	<const name="DetachAllReturnNone" value="2">
3409	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3410	</const>
3411	<const name="DetachAllReturnHardDisksOnly" value="3">
3412	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3413	</const>
3414	<const name="Full" value="4">
3415	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3416	</const>
3417	</enum>
3418
3419	<interface
3420	name="IMachine" extends="$unknown"
3421	uuid="cc4fec9a-3150-45df-9ee9-f00ba54d6ac3"
3422	wsmap="managed"
3423	>
3424	<desc>
3425	The IMachine interface represents a virtual machine, or guest, created
3426	in VirtualBox.
3427
3428	This interface is used in two contexts. First of all, a collection of
3429	objects implementing this interface is stored in the
3430	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3431	machines that are currently registered with this VirtualBox
3432	installation. Also, once a session has been opened for the given virtual
3433	machine (e.g. the virtual machine is running), the machine object
3434	associated with the open session can be queried from the session object;
3435	see <link to="ISession"/> for details.
3436
3437	The main role of this interface is to expose the settings of the virtual
3438	machine and provide methods to change various aspects of the virtual
3439	machine's configuration. For machine objects stored in the
3440	<link to="IVirtualBox::machines"/> collection, all attributes are
3441	read-only unless explicitly stated otherwise in individual attribute
3442	and method descriptions.
3443
3444	In order to change a machine setting, a session for this machine must be
3445	opened using one of the <link to="IMachine::lockMachine" /> or
3446	<link to="IMachine::launchVMProcess"/> methods. After the
3447	machine has been successfully locked for a session, a mutable machine object
3448	needs to be queried from the session object and then the desired settings
3449	changes can be applied to the returned object using IMachine attributes and
3450	methods. See the <link to="ISession"/> interface description for more
3451	information about sessions.
3452
3453	Note that IMachine does not provide methods to control virtual machine
3454	execution (such as start the machine, or power it down) -- these methods
3455	are grouped in a separate interface called <link to="IConsole" />.
3456
3457	<see>ISession, IConsole</see>
3458	</desc>
3459
3460	<attribute name="parent" type="IVirtualBox" readonly="yes">
3461	<desc>Associated parent object.</desc>
3462	</attribute>
3463
3464	<attribute name="accessible" type="boolean" readonly="yes">
3465	<desc>
3466	Whether this virtual machine is currently accessible or not.
3467
3468	A machine is always deemed accessible unless it is registered <i>and</i>
3469	its settings file cannot be read or parsed (either because the file itself
3470	is unavailable or has invalid XML contents).
3471
3472	Every time this property is read, the accessibility state of
3473	this machine is re-evaluated. If the returned value is @c false,
3474	the <link to="#accessError"/> property may be used to get the
3475	detailed error information describing the reason of
3476	inaccessibility, including XML error messages.
3477
3478	When the machine is inaccessible, only the following properties
3479	can be used on it:
3480	<ul>
3481	<li><link to="#parent"/></li>
3482	<li><link to="#id"/></li>
3483	<li><link to="#settingsFilePath"/></li>
3484	<li><link to="#accessible"/></li>
3485	<li><link to="#accessError"/></li>
3486	</ul>
3487
3488	An attempt to access any other property or method will return
3489	an error.
3490
3491	The only possible action you can perform on an inaccessible
3492	machine is to unregister it using the
3493	<link to="IMachine::unregister"/> call (or, to check
3494	for the accessibility state once more by querying this
3495	property).
3496
3497	<note>
3498	In the current implementation, once this property returns
3499	@c true, the machine will never become inaccessible
3500	later, even if its settings file cannot be successfully
3501	read/written any more (at least, until the VirtualBox
3502	server is restarted). This limitation may be removed in
3503	future releases.
3504	</note>
3505	</desc>
3506	</attribute>
3507
3508	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3509	<desc>
3510	Error information describing the reason of machine
3511	inaccessibility.
3512
3513	Reading this property is only valid after the last call to
3514	<link to="#accessible"/> returned @c false (i.e. the
3515	machine is currently inaccessible). Otherwise, a @c null
3516	IVirtualBoxErrorInfo object will be returned.
3517	</desc>
3518	</attribute>
3519
3520	<attribute name="name" type="wstring">
3521	<desc>
3522	Name of the virtual machine.
3523
3524	Besides being used for human-readable identification purposes
3525	everywhere in VirtualBox, the virtual machine name is also used
3526	as a name of the machine's settings file and as a name of the
3527	subdirectory this settings file resides in. Thus, every time you
3528	change the value of this property, the settings file will be
3529	renamed once you call <link to="#saveSettings"/> to confirm the
3530	change. The containing subdirectory will be also renamed, but
3531	only if it has exactly the same name as the settings file
3532	itself prior to changing this property (for backward compatibility
3533	with previous API releases). The above implies the following
3534	limitations:
3535	<ul>
3536	<li>The machine name cannot be empty.</li>
3537	<li>The machine name can contain only characters that are valid
3538	file name characters according to the rules of the file
3539	system used to store VirtualBox configuration.</li>
3540	<li>You cannot have two or more machines with the same name
3541	if they use the same subdirectory for storing the machine
3542	settings files.</li>
3543	<li>You cannot change the name of the machine if it is running,
3544	or if any file in the directory containing the settings file
3545	is being used by another running machine or by any other
3546	process in the host operating system at a time when
3547	<link to="#saveSettings"/> is called.
3548	</li>
3549	</ul>
3550	If any of the above limitations are hit, <link to="#saveSettings"/>
3551	will return an appropriate error message explaining the exact
3552	reason and the changes you made to this machine will not be saved.
3553
3554	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3555	file is recommended, but not enforced. (Previous versions always
3556	used a generic ".xml" extension.)
3557	</desc>
3558	</attribute>
3559
3560	<attribute name="description" type="wstring">
3561	<desc>
3562	Description of the virtual machine.
3563
3564	The description attribute can contain any text and is
3565	typically used to describe the hardware and software
3566	configuration of the virtual machine in detail (i.e. network
3567	settings, versions of the installed software and so on).
3568	</desc>
3569	</attribute>
3570
3571	<attribute name="id" type="uuid" mod="string" readonly="yes">
3572	<desc>UUID of the virtual machine.</desc>
3573	</attribute>
3574
3575	<attribute name="OSTypeId" type="wstring">
3576	<desc>
3577	User-defined identifier of the Guest OS type.
3578	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3579	an IGuestOSType object representing details about the given
3580	Guest OS type.
3581	<note>
3582	This value may differ from the value returned by
3583	<link to="IGuest::OSTypeId"/> if Guest Additions are
3584	installed to the guest OS.
3585	</note>
3586	</desc>
3587	</attribute>
3588
3589	<attribute name="HardwareVersion" type="wstring">
3590	<desc>Hardware version identifier. Internal use only for now.</desc>
3591	</attribute>
3592
3593	<attribute name="hardwareUUID" type="uuid" mod="string">
3594	<desc>
3595	The UUID presented to the guest via memory tables, hardware and guest
3596	properties. For most VMs this is the same as the @a id, but for VMs
3597	which have been cloned or teleported it may be the same as the source
3598	VM. This latter is because the guest shouldn't notice that it was
3599	cloned or teleported.
3600	</desc>
3601	</attribute>
3602
3603	<attribute name="CPUCount" type="unsigned long">
3604	<desc>Number of virtual CPUs in the VM.</desc>
3605	</attribute>
3606
3607	<attribute name="CPUHotPlugEnabled" type="boolean">
3608	<desc>
3609	This setting determines whether VirtualBox allows CPU
3610	hotplugging for this machine.</desc>
3611	</attribute>
3612
3613	<attribute name="CPUExecutionCap" type="unsigned long">
3614	<desc>
3615	Means to limit the number of CPU cycles a guest can use. The unit
3616	is percentage of host CPU cycles per second. The valid range
3617	is 1 - 100. 100 (the default) implies no limit.
3618	</desc>
3619	</attribute>
3620
3621	<attribute name="memorySize" type="unsigned long">
3622	<desc>System memory size in megabytes.</desc>
3623	</attribute>
3624
3625	<attribute name="memoryBalloonSize" type="unsigned long">
3626	<desc>Memory balloon size in megabytes.</desc>
3627	</attribute>
3628
3629	<attribute name="PageFusionEnabled" type="boolean">
3630	<desc>
3631	This setting determines whether VirtualBox allows page
3632	fusion for this machine (64 bits host only).
3633	</desc>
3634	</attribute>
3635
3636	<attribute name="VRAMSize" type="unsigned long">
3637	<desc>Video memory size in megabytes.</desc>
3638	</attribute>
3639
3640	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3641	<desc>
3642	This setting determines whether VirtualBox allows this machine to make
3643	use of the 3D graphics support available on the host.</desc>
3644	</attribute>
3645
3646	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3647	<desc>
3648	This setting determines whether VirtualBox allows this machine to make
3649	use of the 2D video acceleration support available on the host.</desc>
3650	</attribute>
3651
3652	<attribute name="monitorCount" type="unsigned long">
3653	<desc>
3654	Number of virtual monitors.
3655	<note>
3656	Only effective on Windows XP and later guests with
3657	Guest Additions installed.
3658	</note>
3659	</desc>
3660	</attribute>
3661
3662	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3663	<desc>Object containing all BIOS settings.</desc>
3664	</attribute>
3665
3666	<attribute name="firmwareType" type="FirmwareType">
3667	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3668	bootstrap in this VM.</desc>
3669	</attribute>
3670
3671	<attribute name="pointingHidType" type="PointingHidType">
3672	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3673	The default is typically "PS2Mouse" but can vary depending on the
3674	requirements of the guest operating system.</desc>
3675	</attribute>
3676
3677	<attribute name="keyboardHidType" type="KeyboardHidType">
3678	<desc>Type of keyboard HID used in this VM.
3679	The default is typically "PS2Keyboard" but can vary depending on the
3680	requirements of the guest operating system.</desc>
3681	</attribute>
3682
3683	<attribute name="hpetEnabled" type="boolean">
3684	<desc>This attribute controls if High Precision Event Timer (HPET) is
3685	enabled in this VM. Use this property if you want to provide guests
3686	with additional time source, or if guest requires HPET to function correctly.
3687	Default is false.</desc>
3688	</attribute>
3689
3690	<attribute name="chipsetType" type="ChipsetType">
3691	<desc>Chipset type used in this VM.</desc>
3692	</attribute>
3693
3694	<attribute name="snapshotFolder" type="wstring">
3695	<desc>
3696	Full path to the directory used to store snapshot data
3697	(differencing media and saved state files) of this machine.
3698
3699	The initial value of this property is
3700	<tt><</tt><link to="#settingsFilePath">
3701	path_to_settings_file</link><tt>>/<</tt>
3702	<link to="#id">machine_uuid</link>
3703	<tt>></tt>.
3704
3705	Currently, it is an error to try to change this property on
3706	a machine that has snapshots (because this would require to
3707	move possibly large files to a different location).
3708	A separate method will be available for this purpose later.
3709
3710	<note>
3711	Setting this property to @c null or to an empty string will restore
3712	the initial value.
3713	</note>
3714	<note>
3715	When setting this property, the specified path can be
3716	absolute (full path) or relative to the directory where the
3717	<link to="#settingsFilePath">machine settings file</link>
3718	is located. When reading this property, a full path is
3719	always returned.
3720	</note>
3721	<note>
3722	The specified path may not exist, it will be created
3723	when necessary.
3724	</note>
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3729	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3730	</attribute>
3731
3732	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3733	<desc>Array of media attached to this machine.</desc>
3734	</attribute>
3735
3736	<attribute name="USBController" type="IUSBController" readonly="yes">
3737	<desc>
3738	Associated USB controller object.
3739
3740	<note>
3741	If USB functionality is not available in the given edition of
3742	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3743	</note>
3744	</desc>
3745	</attribute>
3746
3747	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3748	<desc>Associated audio adapter, always present.</desc>
3749	</attribute>
3750
3751	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3752	<desc>Array of storage controllers attached to this machine.</desc>
3753	</attribute>
3754
3755	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3756	<desc>
3757	Full name of the file containing machine settings data.
3758	</desc>
3759	</attribute>
3760
3761	<attribute name="settingsModified" type="boolean" readonly="yes">
3762	<desc>
3763	Whether the settings of this machine have been modified
3764	(but neither yet saved nor discarded).
3765	<note>
3766	Reading this property is only valid on instances returned
3767	by <link to="ISession::machine"/> and on new machines
3768	created by <link to="IVirtualBox::createMachine"/> or opened
3769	by <link to="IVirtualBox::openMachine"/> but not
3770	yet registered, or on unregistered machines after calling
3771	<link to="IMachine::unregister"/>. For all other
3772	cases, the settings can never be modified.
3773	</note>
3774	<note>
3775	For newly created unregistered machines, the value of this
3776	property is always @c true until <link to="#saveSettings"/>
3777	is called (no matter if any machine settings have been
3778	changed after the creation or not). For opened machines
3779	the value is set to @c false (and then follows to normal rules).
3780	</note>
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="sessionState" type="SessionState" readonly="yes">
3785	<desc>Current session state for this machine.</desc>
3786	</attribute>
3787
3788	<attribute name="sessionType" type="wstring" readonly="yes">
3789	<desc>
3790	Type of the session. If <link to="#sessionState"/> is
3791	Spawning or Locked, this attribute contains the
3792	same value as passed to the
3793	<link to="IMachine::launchVMProcess"/> method in the
3794	@a type parameter. If the session was used with
3795	<link to="IMachine::lockMachine" />, or if
3796	<link to="#sessionState"/> is SessionClosed, the value of this
3797	attribute is an empty string.
3798	</desc>
3799	</attribute>
3800
3801	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3802	<desc>
3803	Identifier of the session process. This attribute contains the
3804	platform-dependent identifier of the process whose session was
3805	used with <link to="IMachine::lockMachine" /> call. The returned
3806	value is only valid if <link to="#sessionState"/> is Locked or
3807	Unlocking by the time this property is read.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="state" type="MachineState" readonly="yes">
3812	<desc>Current execution state of this machine.</desc>
3813	</attribute>
3814
3815	<attribute name="lastStateChange" type="long long" readonly="yes">
3816	<desc>
3817	Time stamp of the last execution state change,
3818	in milliseconds since 1970-01-01 UTC.
3819	</desc>
3820	</attribute>
3821
3822	<attribute name="stateFilePath" type="wstring" readonly="yes">
3823	<desc>
3824	Full path to the file that stores the execution state of
3825	the machine when it is in the <link to="MachineState_Saved"/> state.
3826	<note>
3827	When the machine is not in the Saved state, this attribute is
3828	an empty string.
3829	</note>
3830	</desc>
3831	</attribute>
3832
3833	<attribute name="logFolder" type="wstring" readonly="yes">
3834	<desc>
3835	Full path to the folder that stores a set of rotated log files
3836	recorded during machine execution. The most recent log file is
3837	named <tt>VBox.log</tt>, the previous log file is
3838	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3839	in the current version).
3840	</desc>
3841	</attribute>
3842
3843	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3844	<desc>
3845	Current snapshot of this machine. This is @c null if the machine
3846	currently has no snapshots. If it is not @c null, then it was
3847	set by one of <link to="IConsole::takeSnapshot" />,
3848	<link to="IConsole::deleteSnapshot" />
3849	or <link to="IConsole::restoreSnapshot" />, depending on which
3850	was called last. See <link to="ISnapshot"/> for details.
3851	</desc>
3852	</attribute>
3853
3854	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3855	<desc>
3856	Number of snapshots taken on this machine. Zero means the
3857	machine doesn't have any snapshots.
3858	</desc>
3859	</attribute>
3860
3861	<attribute name="currentStateModified" type="boolean" readonly="yes">
3862	<desc>
3863	Returns @c true if the current state of the machine is not
3864	identical to the state stored in the current snapshot.
3865
3866	The current state is identical to the current snapshot only
3867	directly after one of the following calls are made:
3868
3869	<ul>
3870	<li><link to="IConsole::restoreSnapshot"/>
3871	</li>
3872	<li><link to="IConsole::takeSnapshot"/> (issued on a
3873	"powered off" or "saved" machine, for which
3874	<link to="#settingsModified"/> returns @c false)
3875	</li>
3876	</ul>
3877
3878	The current state remains identical until one of the following
3879	happens:
3880	<ul>
3881	<li>settings of the machine are changed</li>
3882	<li>the saved state is deleted</li>
3883	<li>the current snapshot is deleted</li>
3884	<li>an attempt to execute the machine is made</li>
3885	</ul>
3886
3887	<note>
3888	For machines that don't have snapshots, this property is
3889	always @c false.
3890	</note>
3891	</desc>
3892	</attribute>
3893
3894	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3895	<desc>
3896	Collection of shared folders for this machine (permanent shared
3897	folders). These folders are shared automatically at machine startup
3898	and available only to the guest OS installed within this machine.
3899
3900	New shared folders are added to the collection using
3901	<link to="#createSharedFolder"/>. Existing shared folders can be
3902	removed using <link to="#removeSharedFolder"/>.
3903	</desc>
3904	</attribute>
3905
3906	<attribute name="clipboardMode" type="ClipboardMode">
3907	<desc>
3908	Synchronization mode between the host OS clipboard
3909	and the guest OS clipboard.
3910	</desc>
3911	</attribute>
3912
3913	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3914	<desc>
3915	A comma-separated list of simple glob patterns. Changes to guest
3916	properties whose name matches one of the patterns will generate an
3917	<link to="IGuestPropertyChangedEvent"/> signal.
3918	</desc>
3919	</attribute>
3920
3921	<attribute name="teleporterEnabled" type="boolean">
3922	<desc>
3923	When set to @a true, the virtual machine becomes a target teleporter
3924	the next time it is powered on. This can only set to @a true when the
3925	VM is in the @a PoweredOff or @a Aborted state.
3926
3927	<!-- This property is automatically set to @a false when the VM is powered
3928	on. (bird: This doesn't work yet ) -->
3929	</desc>
3930	</attribute>
3931
3932	<attribute name="teleporterPort" type="unsigned long">
3933	<desc>
3934	The TCP port the target teleporter will listen for incoming
3935	teleportations on.
3936
3937	0 means the port is automatically selected upon power on. The actual
3938	value can be read from this property while the machine is waiting for
3939	incoming teleportations.
3940	</desc>
3941	</attribute>
3942
3943	<attribute name="teleporterAddress" type="wstring">
3944	<desc>
3945	The address the target teleporter will listen on. If set to an empty
3946	string, it will listen on all addresses.
3947	</desc>
3948	</attribute>
3949
3950	<attribute name="teleporterPassword" type="wstring">
3951	<desc>
3952	The password to check for on the target teleporter. This is just a
3953	very basic measure to prevent simple hacks and operators accidentally
3954	beaming a virtual machine to the wrong place.
3955	</desc>
3956	</attribute>
3957
3958	<attribute name="faultToleranceState" type="FaultToleranceState">
3959	<desc>
3960	Fault tolerance state; disabled, source or target.
3961	This property can be changed at any time. If you change it for a running
3962	VM, then the fault tolerance address and port must be set beforehand.
3963	</desc>
3964	</attribute>
3965
3966	<attribute name="faultTolerancePort" type="unsigned long">
3967	<desc>
3968	The TCP port the fault tolerance source or target will use for
3969	communication.
3970	</desc>
3971	</attribute>
3972
3973	<attribute name="faultToleranceAddress" type="wstring">
3974	<desc>
3975	The address the fault tolerance source or target.
3976	</desc>
3977	</attribute>
3978
3979	<attribute name="faultTolerancePassword" type="wstring">
3980	<desc>
3981	The password to check for on the standby VM. This is just a
3982	very basic measure to prevent simple hacks and operators accidentally
3983	choosing the wrong standby VM.
3984	</desc>
3985	</attribute>
3986
3987	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3988	<desc>
3989	The interval in ms used for syncing the state between source and target.
3990	</desc>
3991	</attribute>
3992
3993	<attribute name="RTCUseUTC" type="boolean">
3994	<desc>
3995	When set to @a true, the RTC device of the virtual machine will run
3996	in UTC time, otherwise in local time. Especially Unix guests prefer
3997	the time in UTC.
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="ioCacheEnabled" type="boolean">
4002	<desc>
4003	When set to @a true, the builtin I/O cache of the virtual machine
4004	will be enabled.
4005	</desc>
4006	</attribute>
4007
4008	<attribute name="ioCacheSize" type="unsigned long">
4009	<desc>
4010	Maximum size of the I/O cache in MB.
4011	</desc>
4012	</attribute>
4013
4014	<method name="lockMachine">
4015	<desc>
4016	Locks the machine for the given session to enable the caller
4017	to make changes to the machine or start the VM or control
4018	VM execution.
4019
4020	There are two ways to lock a machine for such uses:
4021
4022	<ul>
4023	<li>If you want to make changes to the machine settings,
4024	you must obtain an exclusive write lock on the machine
4025	by setting @a lockType to @c Write.
4026
4027	This will only succeed if no other process has locked
4028	the machine to prevent conflicting changes. Only after
4029	an exclusive write lock has been obtained using this method, one
4030	can change all VM settings or execute the VM in the process
4031	space of the session object. (Note that the latter is only of
4032	interest if you actually want to write a new front-end for
4033	virtual machines; but this API gets called internally by
4034	the existing front-ends such as VBoxHeadless and the VirtualBox
4035	GUI to acquire a write lock on the machine that they are running.)
4036
4037	On success, write-locking the machine for a session creates
4038	a second copy of the IMachine object. It is this second object
4039	upon which changes can be made; in VirtualBox terminology, the
4040	second copy is "mutable". It is only this second, mutable machine
4041	object upon which you can call methods that change the
4042	machine state. After having called this method, you can
4043	obtain this second, mutable machine object using the
4044	<link to="ISession::machine" /> attribute.
4045	</li>
4046	<li>If you only want to check the machine state or control
4047	machine execution without actually changing machine
4048	settings (e.g. to get access to VM statistics or take
4049	a snapshot or save the machine state), then set the
4050	@a lockType argument to @c Shared.
4051
4052	If no other session has obtained a lock, you will obtain an
4053	exclusive write lock as described above. However, if another
4054	session has already obtained such a lock, then a link to that
4055	existing session will be established which allows you
4056	to control that existing session.
4057
4058	To find out which type of lock was obtained, you can
4059	inspect <link to="ISession::type" />, which will have been
4060	set to either @c WriteLock or @c Shared.
4061	</li>
4062	</ul>
4063
4064	In either case, you can get access to the <link to="IConsole" />
4065	object which controls VM execution.
4066
4067	Also in all of the above cases, one must always call
4068	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4069	the machine's state will eventually be set to "Aborted".
4070
4071	To change settings on a machine, the following sequence is typically
4072	performed:
4073
4074	<ol>
4075	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4076
4077	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4078
4079	<li>Change the settings of the machine by invoking IMachine methods.</li>
4080
4081	<li>Call <link to="IMachine::saveSettings" />.</li>
4082
4083	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4084	</ol>
4085
4086	<result name="E_UNEXPECTED">
4087	Virtual machine not registered.
4088	</result>
4089	<result name="E_ACCESSDENIED">
4090	Process not started by OpenRemoteSession.
4091	</result>
4092	<result name="VBOX_E_INVALID_OBJECT_STATE">
4093	Session already open or being opened.
4094	</result>
4095	<result name="VBOX_E_VM_ERROR">
4096	Failed to assign machine to session.
4097	</result>
4098	</desc>
4099	<param name="session" type="ISession" dir="in">
4100	<desc>
4101	Session object for which the machine will be locked.
4102	</desc>
4103	</param>
4104	<param name="lockType" type="LockType" dir="in">
4105	<desc>
4106	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4107	If set to @c Shared, then either acquire an exclusive write lock or establish
4108	a link to an existing session.
4109	</desc>
4110	</param>
4111	</method>
4112
4113	<method name="launchVMProcess">
4114	<desc>
4115	Spawns a new process that will execute the virtual machine and obtains a shared
4116	lock on the machine for the calling session.
4117
4118	If launching the VM succeeds, the new VM process will create its own session
4119	and write-lock the machine for it, preventing conflicting changes from other
4120	processes. If the machine is already locked (because it is already running or
4121	because another session has a write lock), launching the VM process will therefore
4122	fail. Reversely, future attempts to obtain a write lock will also fail while the
4123	machine is running.
4124
4125	The caller's session object remains separate from the session opened by the new
4126	VM process. It receives its own <link to="IConsole" /> object which can be used
4127	to control machine execution, but it cannot be used to change all VM settings
4128	which would be available after a <link to="#lockMachine" /> call.
4129
4130	The caller must eventually release the session's shared lock by calling
4131	<link to="ISession::unlockMachine" /> on the local session object once this call
4132	has returned. However, the session's state (see <link to="ISession::state" />)
4133	will not return to "Unlocked" until the remote session has also unlocked
4134	the machine (i.e. the machine has stopped running).
4135
4136	Launching a VM process can take some time (a new VM is started in a new process,
4137	for which memory and other resources need to be set up). Because of this,
4138	an <link to="IProgress" /> object is returned to allow the caller to wait
4139	for this asynchronous operation to be completed. Until then, the caller's
4140	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4141	and <link to="ISession::console" /> attributes cannot be accessed.
4142	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4143	similar calls to wait for completion. Completion is signalled when the VM
4144	is powered on. If launching the VM fails, error messages can be queried
4145	via the progress object, if available.
4146
4147	The progress object will have at least 2 sub-operations. The first
4148	operation covers the period up to the new VM process calls powerUp.
4149	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4150	progress object. Because <link to="IConsole::powerUp"/> may require
4151	some extra sub-operations, the <link to="IProgress::operationCount"/>
4152	may change at the completion of operation.
4153
4154	For details on the teleportation progress operation, see
4155	<link to="IConsole::powerUp"/>.
4156
4157	The @a environment argument is a string containing definitions of
4158	environment variables in the following format:
4159	@code
4160	NAME[=VALUE]\n
4161	NAME[=VALUE]\n
4162	...
4163	@endcode
4164	where <tt>\\n</tt> is the new line character. These environment
4165	variables will be appended to the environment of the VirtualBox server
4166	process. If an environment variable exists both in the server process
4167	and in this list, the value from this list takes precedence over the
4168	server's variable. If the value of the environment variable is
4169	omitted, this variable will be removed from the resulting environment.
4170	If the environment string is @c null or empty, the server environment
4171	is inherited by the started process as is.
4172
4173	<result name="E_UNEXPECTED">
4174	Virtual machine not registered.
4175	</result>
4176	<result name="E_INVALIDARG">
4177	Invalid session type @a type.
4178	</result>
4179	<result name="VBOX_E_OBJECT_NOT_FOUND">
4180	No machine matching @a machineId found.
4181	</result>
4182	<result name="VBOX_E_INVALID_OBJECT_STATE">
4183	Session already open or being opened.
4184	</result>
4185	<result name="VBOX_E_IPRT_ERROR">
4186	Launching process for machine failed.
4187	</result>
4188	<result name="VBOX_E_VM_ERROR">
4189	Failed to assign machine to session.
4190	</result>
4191	</desc>
4192	<param name="session" type="ISession" dir="in">
4193	<desc>
4194	Client session object to which the VM process will be connected (this
4195	must be in "Unlocked" state).
4196	</desc>
4197	</param>
4198	<param name="type" type="wstring" dir="in">
4199	<desc>
4200	Front-end to use for the new VM process. The following are currently supported:
4201	<ul>
4202	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4203	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4204	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4205	</ul>
4206	</desc>
4207	</param>
4208	<param name="environment" type="wstring" dir="in">
4209	<desc>
4210	Environment to pass to the VM process.
4211	</desc>
4212	</param>
4213	<param name="progress" type="IProgress" dir="return">
4214	<desc>Progress object to track the operation completion.</desc>
4215	</param>
4216	</method>
4217
4218	<method name="setBootOrder">
4219	<desc>
4220	Puts the given device to the specified position in
4221	the boot order.
4222
4223	To indicate that no device is associated with the given position,
4224	<link to="DeviceType_Null"/> should be used.
4225
4226	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4227
4228	<result name="E_INVALIDARG">
4229	Boot @a position out of range.
4230	</result>
4231	<result name="E_NOTIMPL">
4232	Booting from USB @a device currently not supported.
4233	</result>
4234
4235	</desc>
4236	<param name="position" type="unsigned long" dir="in">
4237	<desc>
4238	Position in the boot order (@c 1 to the total number of
4239	devices the machine can boot from, as returned by
4240	<link to="ISystemProperties::maxBootPosition"/>).
4241	</desc>
4242	</param>
4243	<param name="device" type="DeviceType" dir="in">
4244	<desc>
4245	The type of the device used to boot at the given position.
4246	</desc>
4247	</param>
4248	</method>
4249
4250	<method name="getBootOrder" const="yes">
4251	<desc>
4252	Returns the device type that occupies the specified
4253	position in the boot order.
4254
4255	@todo [remove?]
4256	If the machine can have more than one device of the returned type
4257	(such as hard disks), then a separate method should be used to
4258	retrieve the individual device that occupies the given position.
4259
4260	If here are no devices at the given position, then
4261	<link to="DeviceType_Null"/> is returned.
4262
4263	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4264
4265	<result name="E_INVALIDARG">
4266	Boot @a position out of range.
4267	</result>
4268
4269	</desc>
4270	<param name="position" type="unsigned long" dir="in">
4271	<desc>
4272	Position in the boot order (@c 1 to the total number of
4273	devices the machine can boot from, as returned by
4274	<link to="ISystemProperties::maxBootPosition"/>).
4275	</desc>
4276	</param>
4277	<param name="device" type="DeviceType" dir="return">
4278	<desc>
4279	Device at the given position.
4280	</desc>
4281	</param>
4282	</method>
4283
4284	<method name="attachDevice">
4285	<desc>
4286	Attaches a device and optionally mounts a medium to the given storage
4287	controller (<link to="IStorageController" />, identified by @a name),
4288	at the indicated port and device.
4289
4290	This method is intended for managing storage devices in general while a
4291	machine is powered off. It can be used to attach and detach fixed
4292	and removeable media. The following kind of media can be attached
4293	to a machine:
4294
4295	<ul>
4296	<li>For fixed and removable media, you can pass in a medium that was
4297	previously opened using <link to="IVirtualBox::openMedium" />.
4298	</li>
4299
4300	<li>Only for storage devices supporting removable media (such as
4301	DVDs and floppies), you can also specify a null pointer to
4302	indicate an empty drive or one of the medium objects listed
4303	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4304	arrays to indicate a host drive.
4305	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4306	to change the media while the machine is running.
4307	</li>
4308	</ul>
4309
4310	In a VM's default configuration of virtual machines, the secondary
4311	master of the IDE controller is used for a CD/DVD drive.
4312
4313	After calling this returns successfully, a new instance of
4314	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4315	attachments (see <link to="IMachine::mediumAttachments"/>).
4316
4317	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4318	information about attaching media.
4319
4320	The specified device slot must not have a device attached to it,
4321	or this method will fail.
4322
4323	<note>
4324	You cannot attach a device to a newly created machine until
4325	this machine's settings are saved to disk using
4326	<link to="#saveSettings"/>.
4327	</note>
4328	<note>
4329	If the medium is being attached indirectly, a new differencing medium
4330	will implicitly be created for it and attached instead. If the
4331	changes made to the machine settings (including this indirect
4332	attachment) are later cancelled using <link to="#discardSettings"/>,
4333	this implicitly created differencing medium will implicitly
4334	be deleted.
4335	</note>
4336
4337	<result name="E_INVALIDARG">
4338	SATA device, SATA port, IDE port or IDE slot out of range, or
4339	file or UUID not found.
4340	</result>
4341	<result name="VBOX_E_INVALID_OBJECT_STATE">
4342	Machine must be registered before media can be attached.
4343	</result>
4344	<result name="VBOX_E_INVALID_VM_STATE">
4345	Invalid machine state.
4346	</result>
4347	<result name="VBOX_E_OBJECT_IN_USE">
4348	A medium is already attached to this or another virtual machine.
4349	</result>
4350
4351	</desc>
4352	<param name="name" type="wstring" dir="in">
4353	<desc>Name of the storage controller to attach the device to.</desc>
4354	</param>
4355	<param name="controllerPort" type="long" dir="in">
4356	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4357	the primary controller and 1 specifies the secondary controller.
4358	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4359	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4360	</param>
4361	<param name="device" type="long" dir="in">
4362	<desc>Device slot in the given port to attach the device to. This is only
4363	relevant for IDE controllers, for which 0 specifies the master device and
4364	1 specifies the slave device. For all other controller types, this must
4365	be 0.</desc>
4366	</param>
4367	<param name="type" type="DeviceType" dir="in">
4368	<desc>Device type of the attached device. For media opened by
4369	<link to="IVirtualBox::openMedium" />, this must match the device type
4370	specified there.</desc>
4371	</param>
4372	<param name="medium" type="IMedium" dir="in">
4373	<desc>Medium to mount or NULL for an empty drive.</desc>
4374	</param>
4375	</method>
4376
4377	<method name="detachDevice">
4378	<desc>
4379	Detaches the device attached to a device slot of the specified bus.
4380
4381	Detaching the device from the virtual machine is deferred. This means
4382	that the medium remains associated with the machine when this method
4383	returns and gets actually de-associated only after a successful
4384	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4385	for more detailed information about attaching media.
4386
4387	<note>
4388	You cannot detach a device from a running machine.
4389	</note>
4390	<note>
4391	Detaching differencing media implicitly created by <link
4392	to="#attachDevice"/> for the indirect attachment using this
4393	method will <b>not</b> implicitly delete them. The
4394	<link to="IMedium::deleteStorage"/> operation should be
4395	explicitly performed by the caller after the medium is successfully
4396	detached and the settings are saved with
4397	<link to="#saveSettings"/>, if it is the desired action.
4398	</note>
4399
4400	<result name="VBOX_E_INVALID_VM_STATE">
4401	Attempt to detach medium from a running virtual machine.
4402	</result>
4403	<result name="VBOX_E_OBJECT_NOT_FOUND">
4404	No medium attached to given slot/bus.
4405	</result>
4406	<result name="VBOX_E_NOT_SUPPORTED">
4407	Medium format does not support storage deletion.
4408	</result>
4409
4410	</desc>
4411	<param name="name" type="wstring" dir="in">
4412	<desc>Name of the storage controller to detach the medium from.</desc>
4413	</param>
4414	<param name="controllerPort" type="long" dir="in">
4415	<desc>Port number to detach the medium from.</desc>
4416	</param>
4417	<param name="device" type="long" dir="in">
4418	<desc>Device slot number to detach the medium from.</desc>
4419	</param>
4420	</method>
4421
4422	<method name="passthroughDevice">
4423	<desc>
4424	Sets the passthrough mode of an existing DVD device. Changing the
4425	setting while the VM is running is forbidden. The setting is only used
4426	if at VM start the device is configured as a host DVD drive, in all
4427	other cases it is ignored. The device must already exist; see
4428	<link to="IMachine::attachDevice"/> for how to attach a new device.
4429
4430	The @a controllerPort and @a device parameters specify the device slot and
4431	have have the same meaning as with <link to="IMachine::attachDevice" />.
4432
4433	<result name="E_INVALIDARG">
4434	SATA device, SATA port, IDE port or IDE slot out of range.
4435	</result>
4436	<result name="VBOX_E_INVALID_OBJECT_STATE">
4437	Attempt to modify an unregistered virtual machine.
4438	</result>
4439	<result name="VBOX_E_INVALID_VM_STATE">
4440	Invalid machine state.
4441	</result>
4442
4443	</desc>
4444	<param name="name" type="wstring" dir="in">
4445	<desc>Name of the storage controller.</desc>
4446	</param>
4447	<param name="controllerPort" type="long" dir="in">
4448	<desc>Storage controller port.</desc>
4449	</param>
4450	<param name="device" type="long" dir="in">
4451	<desc>Device slot in the given port.</desc>
4452	</param>
4453	<param name="passthrough" type="boolean" dir="in">
4454	<desc>New value for the passthrough setting.</desc>
4455	</param>
4456	</method>
4457
4458	<method name="mountMedium">
4459	<desc>
4460	Mounts a medium (<link to="IMedium" />, identified
4461	by the given UUID @a id) to the given storage controller
4462	(<link to="IStorageController" />, identified by @a name),
4463	at the indicated port and device. The device must already exist;
4464	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4465
4466	This method is intended only for managing removable media, where the
4467	device is fixed but media is changeable at runtime (such as DVDs
4468	and floppies). It cannot be used for fixed media such as hard disks.
4469
4470	The @a controllerPort and @a device parameters specify the device slot and
4471	have have the same meaning as with <link to="IMachine::attachDevice" />.
4472
4473	The specified device slot can have a medium mounted, which will be
4474	unmounted first. Specifying a zero UUID (or an empty string) for
4475	@a medium does just an unmount.
4476
4477	See <link to="IMedium"/> for more detailed information about
4478	attaching media.
4479
4480	<result name="E_INVALIDARG">
4481	SATA device, SATA port, IDE port or IDE slot out of range.
4482	</result>
4483	<result name="VBOX_E_INVALID_OBJECT_STATE">
4484	Attempt to attach medium to an unregistered virtual machine.
4485	</result>
4486	<result name="VBOX_E_INVALID_VM_STATE">
4487	Invalid machine state.
4488	</result>
4489	<result name="VBOX_E_OBJECT_IN_USE">
4490	Medium already attached to this or another virtual machine.
4491	</result>
4492
4493	</desc>
4494	<param name="name" type="wstring" dir="in">
4495	<desc>Name of the storage controller to attach the medium to.</desc>
4496	</param>
4497	<param name="controllerPort" type="long" dir="in">
4498	<desc>Port to attach the medium to.</desc>
4499	</param>
4500	<param name="device" type="long" dir="in">
4501	<desc>Device slot in the given port to attach the medium to.</desc>
4502	</param>
4503	<param name="medium" type="IMedium" dir="in">
4504	<desc>Medium to mount or NULL for an empty drive.</desc>
4505	</param>
4506	<param name="force" type="boolean" dir="in">
4507	<desc>Allows to force unmount/mount of a medium which is locked by
4508	the device slot in the given port to attach the medium to.</desc>
4509	</param>
4510	</method>
4511
4512	<method name="getMedium" const="yes">
4513	<desc>
4514	Returns the virtual medium attached to a device slot of the specified
4515	bus.
4516
4517	Note that if the medium was indirectly attached by
4518	<link to="#mountMedium"/> to the given device slot then this
4519	method will return not the same object as passed to the
4520	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4521	more detailed information about mounting a medium.
4522
4523	<result name="VBOX_E_OBJECT_NOT_FOUND">
4524	No medium attached to given slot/bus.
4525	</result>
4526
4527	</desc>
4528	<param name="name" type="wstring" dir="in">
4529	<desc>Name of the storage controller the medium is attached to.</desc>
4530	</param>
4531	<param name="controllerPort" type="long" dir="in">
4532	<desc>Port to query.</desc>
4533	</param>
4534	<param name="device" type="long" dir="in">
4535	<desc>Device slot in the given port to query.</desc>
4536	</param>
4537	<param name="medium" type="IMedium" dir="return">
4538	<desc>Attached medium object.</desc>
4539	</param>
4540	</method>
4541
4542	<method name="getMediumAttachmentsOfController" const="yes">
4543	<desc>
4544	Returns an array of medium attachments which are attached to the
4545	the controller with the given name.
4546
4547	<result name="VBOX_E_OBJECT_NOT_FOUND">
4548	A storage controller with given name doesn't exist.
4549	</result>
4550	</desc>
4551	<param name="name" type="wstring" dir="in"/>
4552	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4553	</method>
4554
4555	<method name="getMediumAttachment" const="yes">
4556	<desc>
4557	Returns a medium attachment which corresponds to the controller with
4558	the given name, on the given port and device slot.
4559
4560	<result name="VBOX_E_OBJECT_NOT_FOUND">
4561	No attachment exists for the given controller/port/device combination.
4562	</result>
4563	</desc>
4564	<param name="name" type="wstring" dir="in"/>
4565	<param name="controllerPort" type="long" dir="in"/>
4566	<param name="device" type="long" dir="in"/>
4567	<param name="attachment" type="IMediumAttachment" dir="return"/>
4568	</method>
4569
4570	<method name="getNetworkAdapter" const="yes">
4571	<desc>
4572	Returns the network adapter associated with the given slot.
4573	Slots are numbered sequentially, starting with zero. The total
4574	number of adapters per machine is defined by the
4575	<link to="ISystemProperties::networkAdapterCount"/> property,
4576	so the maximum slot number is one less than that property's value.
4577
4578	<result name="E_INVALIDARG">
4579	Invalid @a slot number.
4580	</result>
4581
4582	</desc>
4583	<param name="slot" type="unsigned long" dir="in"/>
4584	<param name="adapter" type="INetworkAdapter" dir="return"/>
4585	</method>
4586
4587	<method name="addStorageController">
4588	<desc>
4589	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4590	machine and returns it as an instance of
4591	<link to="IStorageController" />.
4592
4593	@a name identifies the controller for subsequent calls such as
4594	<link to="#getStorageControllerByName" />,
4595	<link to="#getStorageControllerByInstance" />,
4596	<link to="#removeStorageController" />,
4597	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4598
4599	After the controller has been added, you can set its exact
4600	type by setting the <link to="IStorageController::controllerType" />.
4601
4602	<result name="VBOX_E_OBJECT_IN_USE">
4603	A storage controller with given name exists already.
4604	</result>
4605	<result name="E_INVALIDARG">
4606	Invalid @a controllerType.
4607	</result>
4608	</desc>
4609	<param name="name" type="wstring" dir="in"/>
4610	<param name="connectionType" type="StorageBus" dir="in"/>
4611	<param name="controller" type="IStorageController" dir="return"/>
4612	</method>
4613
4614	<method name="getStorageControllerByName" const="yes">
4615	<desc>
4616	Returns a storage controller with the given name.
4617
4618	<result name="VBOX_E_OBJECT_NOT_FOUND">
4619	A storage controller with given name doesn't exist.
4620	</result>
4621	</desc>
4622	<param name="name" type="wstring" dir="in"/>
4623	<param name="storageController" type="IStorageController" dir="return"/>
4624	</method>
4625
4626	<method name="getStorageControllerByInstance" const="yes">
4627	<desc>
4628	Returns a storage controller with the given instance number.
4629
4630	<result name="VBOX_E_OBJECT_NOT_FOUND">
4631	A storage controller with given instance number doesn't exist.
4632	</result>
4633	</desc>
4634	<param name="instance" type="unsigned long" dir="in"/>
4635	<param name="storageController" type="IStorageController" dir="return"/>
4636	</method>
4637
4638	<method name="removeStorageController">
4639	<desc>
4640	Removes a storage controller from the machine.
4641
4642	<result name="VBOX_E_OBJECT_NOT_FOUND">
4643	A storage controller with given name doesn't exist.
4644	</result>
4645	</desc>
4646	<param name="name" type="wstring" dir="in"/>
4647	</method>
4648
4649	<method name="getSerialPort" const="yes">
4650	<desc>
4651	Returns the serial port associated with the given slot.
4652	Slots are numbered sequentially, starting with zero. The total
4653	number of serial ports per machine is defined by the
4654	<link to="ISystemProperties::serialPortCount"/> property,
4655	so the maximum slot number is one less than that property's value.
4656
4657	<result name="E_INVALIDARG">
4658	Invalid @a slot number.
4659	</result>
4660
4661	</desc>
4662	<param name="slot" type="unsigned long" dir="in"/>
4663	<param name="port" type="ISerialPort" dir="return"/>
4664	</method>
4665
4666	<method name="getParallelPort" const="yes">
4667	<desc>
4668	Returns the parallel port associated with the given slot.
4669	Slots are numbered sequentially, starting with zero. The total
4670	number of parallel ports per machine is defined by the
4671	<link to="ISystemProperties::parallelPortCount"/> property,
4672	so the maximum slot number is one less than that property's value.
4673
4674	<result name="E_INVALIDARG">
4675	Invalid @a slot number.
4676	</result>
4677
4678	</desc>
4679	<param name="slot" type="unsigned long" dir="in"/>
4680	<param name="port" type="IParallelPort" dir="return"/>
4681	</method>
4682
4683	<method name="getExtraDataKeys">
4684	<desc>
4685	Returns an array representing the machine-specific extra data keys
4686	which currently have values defined.
4687	</desc>
4688	<param name="value" type="wstring" dir="return" safearray="yes">
4689	<desc>Array of extra data keys.</desc>
4690	</param>
4691	</method>
4692
4693	<method name="getExtraData">
4694	<desc>
4695	Returns associated machine-specific extra data.
4696
4697	If the requested data @a key does not exist, this function will
4698	succeed and return an empty string in the @a value argument.
4699
4700	<result name="VBOX_E_FILE_ERROR">
4701	Settings file not accessible.
4702	</result>
4703	<result name="VBOX_E_XML_ERROR">
4704	Could not parse the settings file.
4705	</result>
4706
4707	</desc>
4708	<param name="key" type="wstring" dir="in">
4709	<desc>Name of the data key to get.</desc>
4710	</param>
4711	<param name="value" type="wstring" dir="return">
4712	<desc>Value of the requested data key.</desc>
4713	</param>
4714	</method>
4715
4716	<method name="setExtraData">
4717	<desc>
4718	Sets associated machine-specific extra data.
4719
4720	If you pass @c null or an empty string as a key @a value, the given
4721	@a key will be deleted.
4722
4723	<note>
4724	Before performing the actual data change, this method will ask all
4725	registered listeners using the
4726	<link to="IExtraDataCanChangeEvent"/>
4727	notification for a permission. If one of the listeners refuses the
4728	new value, the change will not be performed.
4729	</note>
4730	<note>
4731	On success, the
4732	<link to="IExtraDataChangedEvent"/> notification
4733	is called to inform all registered listeners about a successful data
4734	change.
4735	</note>
4736	<note>
4737	This method can be called outside the machine session and therefore
4738	it's a caller's responsibility to handle possible race conditions
4739	when several clients change the same key at the same time.
4740	</note>
4741
4742	<result name="VBOX_E_FILE_ERROR">
4743	Settings file not accessible.
4744	</result>
4745	<result name="VBOX_E_XML_ERROR">
4746	Could not parse the settings file.
4747	</result>
4748
4749	</desc>
4750	<param name="key" type="wstring" dir="in">
4751	<desc>Name of the data key to set.</desc>
4752	</param>
4753	<param name="value" type="wstring" dir="in">
4754	<desc>Value to assign to the key.</desc>
4755	</param>
4756	</method>
4757
4758	<method name="getCPUProperty" const="yes">
4759	<desc>
4760	Returns the virtual CPU boolean value of the specified property.
4761
4762	<result name="E_INVALIDARG">
4763	Invalid property.
4764	</result>
4765
4766	</desc>
4767	<param name="property" type="CPUPropertyType" dir="in">
4768	<desc>
4769	Property type to query.
4770	</desc>
4771	</param>
4772	<param name="value" type="boolean" dir="return">
4773	<desc>
4774	Property value.
4775	</desc>
4776	</param>
4777	</method>
4778
4779	<method name="setCPUProperty">
4780	<desc>
4781	Sets the virtual CPU boolean value of the specified property.
4782
4783	<result name="E_INVALIDARG">
4784	Invalid property.
4785	</result>
4786
4787	</desc>
4788	<param name="property" type="CPUPropertyType" dir="in">
4789	<desc>
4790	Property type to query.
4791	</desc>
4792	</param>
4793	<param name="value" type="boolean" dir="in">
4794	<desc>
4795	Property value.
4796	</desc>
4797	</param>
4798	</method>
4799
4800	<method name="getCPUIDLeaf" const="yes">
4801	<desc>
4802	Returns the virtual CPU cpuid information for the specified leaf.
4803
4804	Currently supported index values for cpuid:
4805	Standard CPUID leafs: 0 - 0xA
4806	Extended CPUID leafs: 0x80000000 - 0x8000000A
4807
4808	See the Intel and AMD programmer's manuals for detailed information
4809	about the cpuid instruction and its leafs.
4810	<result name="E_INVALIDARG">
4811	Invalid id.
4812	</result>
4813
4814	</desc>
4815	<param name="id" type="unsigned long" dir="in">
4816	<desc>
4817	CPUID leaf index.
4818	</desc>
4819	</param>
4820	<param name="valEax" type="unsigned long" dir="out">
4821	<desc>
4822	CPUID leaf value for register eax.
4823	</desc>
4824	</param>
4825	<param name="valEbx" type="unsigned long" dir="out">
4826	<desc>
4827	CPUID leaf value for register ebx.
4828	</desc>
4829	</param>
4830	<param name="valEcx" type="unsigned long" dir="out">
4831	<desc>
4832	CPUID leaf value for register ecx.
4833	</desc>
4834	</param>
4835	<param name="valEdx" type="unsigned long" dir="out">
4836	<desc>
4837	CPUID leaf value for register edx.
4838	</desc>
4839	</param>
4840	</method>
4841
4842	<method name="setCPUIDLeaf">
4843	<desc>
4844	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4845	are not passed unmodified. VirtualBox clears features that it doesn't support.
4846
4847	Currently supported index values for cpuid:
4848	Standard CPUID leafs: 0 - 0xA
4849	Extended CPUID leafs: 0x80000000 - 0x8000000A
4850
4851	See the Intel and AMD programmer's manuals for detailed information
4852	about the cpuid instruction and its leafs.
4853
4854	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4855	random crashes inside VMs.
4856	<result name="E_INVALIDARG">
4857	Invalid id.
4858	</result>
4859
4860	</desc>
4861	<param name="id" type="unsigned long" dir="in">
4862	<desc>
4863	CPUID leaf index.
4864	</desc>
4865	</param>
4866	<param name="valEax" type="unsigned long" dir="in">
4867	<desc>
4868	CPUID leaf value for register eax.
4869	</desc>
4870	</param>
4871	<param name="valEbx" type="unsigned long" dir="in">
4872	<desc>
4873	CPUID leaf value for register ebx.
4874	</desc>
4875	</param>
4876	<param name="valEcx" type="unsigned long" dir="in">
4877	<desc>
4878	CPUID leaf value for register ecx.
4879	</desc>
4880	</param>
4881	<param name="valEdx" type="unsigned long" dir="in">
4882	<desc>
4883	CPUID leaf value for register edx.
4884	</desc>
4885	</param>
4886	</method>
4887
4888	<method name="removeCPUIDLeaf">
4889	<desc>
4890	Removes the virtual CPU cpuid leaf for the specified index
4891
4892	<result name="E_INVALIDARG">
4893	Invalid id.
4894	</result>
4895
4896	</desc>
4897	<param name="id" type="unsigned long" dir="in">
4898	<desc>
4899	CPUID leaf index.
4900	</desc>
4901	</param>
4902	</method>
4903
4904	<method name="removeAllCPUIDLeaves">
4905	<desc>
4906	Removes all the virtual CPU cpuid leaves
4907	</desc>
4908	</method>
4909
4910	<method name="getHWVirtExProperty" const="yes">
4911	<desc>
4912	Returns the value of the specified hardware virtualization boolean property.
4913
4914	<result name="E_INVALIDARG">
4915	Invalid property.
4916	</result>
4917
4918	</desc>
4919	<param name="property" type="HWVirtExPropertyType" dir="in">
4920	<desc>
4921	Property type to query.
4922	</desc>
4923	</param>
4924	<param name="value" type="boolean" dir="return">
4925	<desc>
4926	Property value.
4927	</desc>
4928	</param>
4929	</method>
4930
4931	<method name="setHWVirtExProperty">
4932	<desc>
4933	Sets a new value for the specified hardware virtualization boolean property.
4934
4935	<result name="E_INVALIDARG">
4936	Invalid property.
4937	</result>
4938
4939	</desc>
4940	<param name="property" type="HWVirtExPropertyType" dir="in">
4941	<desc>
4942	Property type to set.
4943	</desc>
4944	</param>
4945	<param name="value" type="boolean" dir="in">
4946	<desc>
4947	New property value.
4948	</desc>
4949	</param>
4950	</method>
4951
4952	<method name="saveSettings">
4953	<desc>
4954	Saves any changes to machine settings made since the session
4955	has been opened or a new machine has been created, or since the
4956	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4957	For registered machines, new settings become visible to all
4958	other VirtualBox clients after successful invocation of this
4959	method.
4960	<note>
4961	The method sends <link to="IMachineDataChangedEvent"/>
4962	notification event after the configuration has been successfully
4963	saved (only for registered machines).
4964	</note>
4965	<note>
4966	Calling this method is only valid on instances returned
4967	by <link to="ISession::machine"/> and on new machines
4968	created by <link to="IVirtualBox::createMachine"/> but not
4969	yet registered, or on unregistered machines after calling
4970	<link to="IMachine::unregister"/>.
4971	</note>
4972
4973	<result name="VBOX_E_FILE_ERROR">
4974	Settings file not accessible.
4975	</result>
4976	<result name="VBOX_E_XML_ERROR">
4977	Could not parse the settings file.
4978	</result>
4979	<result name="E_ACCESSDENIED">
4980	Modification request refused.
4981	</result>
4982
4983	</desc>
4984	</method>
4985
4986	<method name="discardSettings">
4987	<desc>
4988	Discards any changes to the machine settings made since the session
4989	has been opened or since the last call to <link to="#saveSettings"/>
4990	or <link to="#discardSettings"/>.
4991	<note>
4992	Calling this method is only valid on instances returned
4993	by <link to="ISession::machine"/> and on new machines
4994	created by <link to="IVirtualBox::createMachine"/> or
4995	opened by <link to="IVirtualBox::openMachine"/> but not
4996	yet registered, or on unregistered machines after calling
4997	<link to="IMachine::unregister"/>.
4998	</note>
4999
5000	<result name="VBOX_E_INVALID_VM_STATE">
5001	Virtual machine is not mutable.
5002	</result>
5003
5004	</desc>
5005	</method>
5006
5007	<method name="unregister">
5008	<desc>
5009	Unregisters the machine, which must have been previously registered using
5010	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5011	cleanup before the machine is unregistered.
5012
5013	This method does not delete any files. It only changes the machine configuration and
5014	the list of registered machines in the VirtualBox object. To delete the files which
5015	belonged to the machine, including the XML file of the machine itself, call
5016	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5017	from this method.
5018
5019	How thoroughly this method cleans up the machine configuration before unregistering
5020	the machine depends on the @a cleanupMode argument.
5021
5022	<ul>
5023	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5024	cleanup will be performed. The call will fail if the machine is in "Saved" state
5025	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5026	It is the responsibility of the caller to delete all such configuration in this mode.
5027	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5028	which it replaces.</li>
5029	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5030	state or if it has snapshots or media attached. All media attached to the current machine
5031	state or in snapshots will be detached. No medium objects will be returned; all of the
5032	machine's media will remain open.</li>
5033	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5034	except that all the hard disk medium objects which were detached from the machine will
5035	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5036	API for closing and deletion.</li>
5037	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5038	that all media will be returned in the array, including removeable media like DVDs and
5039	floppies. This might be useful if the user wants to inspect in detail which media were
5040	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5041	in that case because users will typically want to preserve ISO and RAW image files.</li>
5042	</ul>
5043
5044	This API does not verify whether the media files returned in the array are still
5045	attached to other machines (i.e. shared between several machines). If such a shared
5046	image is passed to <link to="#delete" /> however, closing the image will fail there
5047	and the image will be silently skipped.
5048
5049	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5050	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5051	deleted with all its saved states and hard disk images, but images for removeable
5052	drives (such as ISO and RAW files) will remain on disk.
5053
5054	The call will fail if the machine is currently locked (see <link to="ISession" />).
5055	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5056	before unregistering it.
5057
5058	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5059	is fired.
5060
5061	<note>
5062	If the given machine is inaccessible (see <link to="#accessible"/>), it
5063	will be unregistered and fully uninitialized right afterwards. As a result,
5064	the returned machine object will be unusable and an attempt to call
5065	<b>any</b> method will return the "Object not ready" error.
5066	</note>
5067
5068	<result name="VBOX_E_INVALID_OBJECT_STATE">
5069	Machine is currently locked for a session.
5070	</result>
5071	</desc>
5072
5073	<param name="cleanupMode" type="CleanupMode" dir="in">
5074	<desc>How to clean up after the machine has been unregistered.</desc>
5075	</param>
5076	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5077	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5078	</param>
5079	</method>
5080
5081	<method name="delete">
5082	<desc>
5083	Deletes the files associated with this machine from disk. If medium objects are passed
5084	in with the @a aMedia argument, they are closed and, if closing was successful, their
5085	storage files are deleted as well. For convenience, this array of media files can be
5086	the same as the one returned from a previous <link to="#unregister" /> call.
5087
5088	This method must only be called on machines which are either write-locked (i.e. on instances
5089	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5090	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5091	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5092
5093	The following files will be deleted by this method:
5094	<ul>
5095	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5096	argument other than "UnregisterOnly", this will delete all saved state files that
5097	the machine had in use; possibly one if the machine was in "Saved" state and one
5098	for each online snapshot that the machine had.</li>
5099	<li>On each medium object passed in the @a aMedia array, this will call
5100	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5101	medium's storage on disk. Since the close() call will fail if the medium is still
5102	in use, e.g. because it is still attached to a second machine; in that case the
5103	storage will not be deleted.</li>
5104	<li>Finally, the machine's own XML file will be deleted.</li>
5105	</ul>
5106
5107	Since deleting large disk image files can be a time-consuming I/O operation, this
5108	method operates asynchronously and returns an IProgress object to allow the caller
5109	to monitor the progress. There will be one sub-operation for each file that is
5110	being deleted (saved state or medium storage file).
5111
5112	<note>
5113	<link to="#settingsModified"/> will return @c true after this
5114	method successfully returns.
5115	</note>
5116
5117	<result name="VBOX_E_INVALID_VM_STATE">
5118	Machine is registered but not write-locked.
5119	</result>
5120	<result name="VBOX_E_IPRT_ERROR">
5121	Could not delete the settings file.
5122	</result>
5123	</desc>
5124	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5125	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5126	</param>
5127	<param name="aProgress" type="IProgress" dir="return">
5128	<desc>Progress object to track the operation completion.</desc>
5129	</param>
5130	</method>
5131
5132	<method name="export">
5133	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5134	steps required to export VirtualBox machines to OVF.
5135	</desc>
5136
5137	<param name="aAppliance" type="IAppliance" dir="in">
5138	<desc>Appliance to export this machine to.</desc>
5139	</param>
5140	<param name="location" type="wstring" dir="in">
5141	<desc>The target location.</desc>
5142	</param>
5143	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5144	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5145	</param>
5146	</method >
5147
5148	<method name="findSnapshot">
5149	<desc>
5150	Returns a snapshot of this machine with the given name or UUID.
5151
5152	Returns a snapshot of this machine with the given UUID.
5153	A @c null argument can be used to obtain the first snapshot
5154	taken on this machine. This is useful if you want to traverse
5155	the whole tree of snapshots starting from the root.
5156
5157	<result name="VBOX_E_OBJECT_NOT_FOUND">
5158	Virtual machine has no snapshots or snapshot not found.
5159	</result>
5160
5161	</desc>
5162	<param name="nameOrId" type="wstring" dir="in">
5163	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5164	</param>
5165	<param name="snapshot" type="ISnapshot" dir="return">
5166	<desc>Snapshot object with the given name.</desc>
5167	</param>
5168	</method>
5169
5170	<method name="createSharedFolder">
5171	<desc>
5172	Creates a new permanent shared folder by associating the given logical
5173	name with the given host path, adds it to the collection of shared
5174	folders and starts sharing it. Refer to the description of
5175	<link to="ISharedFolder"/> to read more about logical names.
5176
5177	<result name="VBOX_E_OBJECT_IN_USE">
5178	Shared folder already exists.
5179	</result>
5180	<result name="VBOX_E_FILE_ERROR">
5181	Shared folder @a hostPath not accessible.
5182	</result>
5183
5184	</desc>
5185	<param name="name" type="wstring" dir="in">
5186	<desc>Unique logical name of the shared folder.</desc>
5187	</param>
5188	<param name="hostPath" type="wstring" dir="in">
5189	<desc>Full path to the shared folder in the host file system.</desc>
5190	</param>
5191	<param name="writable" type="boolean" dir="in">
5192	<desc>Whether the share is writable or readonly.</desc>
5193	</param>
5194	<param name="automount" type="boolean" dir="in">
5195	<desc>Whether the share gets automatically mounted by the guest
5196	or not.</desc>
5197	</param>
5198	</method>
5199
5200	<method name="removeSharedFolder">
5201	<desc>
5202	Removes the permanent shared folder with the given name previously
5203	created by <link to="#createSharedFolder"/> from the collection of
5204	shared folders and stops sharing it.
5205
5206	<result name="VBOX_E_INVALID_VM_STATE">
5207	Virtual machine is not mutable.
5208	</result>
5209	<result name="VBOX_E_OBJECT_NOT_FOUND">
5210	Shared folder @a name does not exist.
5211	</result>
5212
5213	</desc>
5214	<param name="name" type="wstring" dir="in">
5215	<desc>Logical name of the shared folder to remove.</desc>
5216	</param>
5217	</method>
5218
5219	<method name="canShowConsoleWindow">
5220	<desc>
5221	Returns @c true if the VM console process can activate the
5222	console window and bring it to foreground on the desktop of
5223	the host PC.
5224	<note>
5225	This method will fail if a session for this machine is not
5226	currently open.
5227	</note>
5228
5229	<result name="VBOX_E_INVALID_VM_STATE">
5230	Machine session is not open.
5231	</result>
5232
5233	</desc>
5234	<param name="canShow" type="boolean" dir="return">
5235	<desc>
5236	@c true if the console window can be shown and @c false otherwise.
5237	</desc>
5238	</param>
5239	</method>
5240
5241	<method name="showConsoleWindow">
5242	<desc>
5243	Activates the console window and brings it to foreground on
5244	the desktop of the host PC. Many modern window managers on
5245	many platforms implement some sort of focus stealing
5246	prevention logic, so that it may be impossible to activate
5247	a window without the help of the currently active
5248	application. In this case, this method will return a non-zero
5249	identifier that represents the top-level window of the VM
5250	console process. The caller, if it represents a currently
5251	active process, is responsible to use this identifier (in a
5252	platform-dependent manner) to perform actual window
5253	activation.
5254	<note>
5255	This method will fail if a session for this machine is not
5256	currently open.
5257	</note>
5258
5259	<result name="VBOX_E_INVALID_VM_STATE">
5260	Machine session is not open.
5261	</result>
5262
5263	</desc>
5264	<param name="winId" type="long long" dir="return">
5265	<desc>
5266	Platform-dependent identifier of the top-level VM console
5267	window, or zero if this method has performed all actions
5268	necessary to implement the <i>show window</i> semantics for
5269	the given platform and/or VirtualBox front-end.
5270	</desc>
5271	</param>
5272	</method>
5273
5274	<method name="getGuestProperty" const="yes">
5275	<desc>
5276	Reads an entry from the machine's guest property store.
5277
5278	<result name="VBOX_E_INVALID_VM_STATE">
5279	Machine session is not open.
5280	</result>
5281
5282	</desc>
5283	<param name="name" type="wstring" dir="in">
5284	<desc>
5285	The name of the property to read.
5286	</desc>
5287	</param>
5288	<param name="value" type="wstring" dir="out">
5289	<desc>
5290	The value of the property. If the property does not exist then this
5291	will be empty.
5292	</desc>
5293	</param>
5294	<param name="timestamp" type="long long" dir="out">
5295	<desc>
5296	The time at which the property was last modified, as seen by the
5297	server process.
5298	</desc>
5299	</param>
5300	<param name="flags" type="wstring" dir="out">
5301	<desc>
5302	Additional property parameters, passed as a comma-separated list of
5303	"name=value" type entries.
5304	</desc>
5305	</param>
5306	</method>
5307
5308	<method name="getGuestPropertyValue" const="yes">
5309	<desc>
5310	Reads a value from the machine's guest property store.
5311
5312	<result name="VBOX_E_INVALID_VM_STATE">
5313	Machine session is not open.
5314	</result>
5315
5316	</desc>
5317	<param name="property" type="wstring" dir="in">
5318	<desc>
5319	The name of the property to read.
5320	</desc>
5321	</param>
5322	<param name="value" type="wstring" dir="return">
5323	<desc>
5324	The value of the property. If the property does not exist then this
5325	will be empty.
5326	</desc>
5327	</param>
5328	</method>
5329
5330	<method name="getGuestPropertyTimestamp" const="yes">
5331	<desc>
5332	Reads a property timestamp from the machine's guest property store.
5333
5334	<result name="VBOX_E_INVALID_VM_STATE">
5335	Machine session is not open.
5336	</result>
5337
5338	</desc>
5339	<param name="property" type="wstring" dir="in">
5340	<desc>
5341	The name of the property to read.
5342	</desc>
5343	</param>
5344	<param name="value" type="long long" dir="return">
5345	<desc>
5346	The timestamp. If the property does not exist then this will be
5347	empty.
5348	</desc>
5349	</param>
5350	</method>
5351
5352	<method name="setGuestProperty">
5353	<desc>
5354	Sets, changes or deletes an entry in the machine's guest property
5355	store.
5356
5357	<result name="E_ACCESSDENIED">
5358	Property cannot be changed.
5359	</result>
5360	<result name="E_INVALIDARG">
5361	Invalid @a flags.
5362	</result>
5363	<result name="VBOX_E_INVALID_VM_STATE">
5364	Virtual machine is not mutable or session not open.
5365	</result>
5366	<result name="VBOX_E_INVALID_OBJECT_STATE">
5367	Cannot set transient property when machine not running.
5368	</result>
5369
5370	</desc>
5371	<param name="property" type="wstring" dir="in">
5372	<desc>
5373	The name of the property to set, change or delete.
5374	</desc>
5375	</param>
5376	<param name="value" type="wstring" dir="in">
5377	<desc>
5378	The new value of the property to set, change or delete. If the
5379	property does not yet exist and value is non-empty, it will be
5380	created. If the value is @c null or empty, the property will be
5381	deleted if it exists.
5382	</desc>
5383	</param>
5384	<param name="flags" type="wstring" dir="in">
5385	<desc>
5386	Additional property parameters, passed as a comma-separated list of
5387	"name=value" type entries.
5388	</desc>
5389	</param>
5390	</method>
5391
5392	<method name="setGuestPropertyValue">
5393	<desc>
5394	Sets, changes or deletes a value in the machine's guest property
5395	store. The flags field will be left unchanged or created empty for a
5396	new property.
5397
5398	<result name="E_ACCESSDENIED">
5399	Property cannot be changed.
5400	</result>
5401	<result name="VBOX_E_INVALID_VM_STATE">
5402	Virtual machine is not mutable or session not open.
5403	</result>
5404	<result name="VBOX_E_INVALID_OBJECT_STATE">
5405	Cannot set transient property when machine not running.
5406	</result>
5407	</desc>
5408
5409	<param name="property" type="wstring" dir="in">
5410	<desc>
5411	The name of the property to set, change or delete.
5412	</desc>
5413	</param>
5414	<param name="value" type="wstring" dir="in">
5415	<desc>
5416	The new value of the property to set, change or delete. If the
5417	property does not yet exist and value is non-empty, it will be
5418	created. If the value is @c null or empty, the property will be
5419	deleted if it exists.
5420	</desc>
5421	</param>
5422	</method>
5423
5424	<method name="enumerateGuestProperties">
5425	<desc>
5426	Return a list of the guest properties matching a set of patterns along
5427	with their values, time stamps and flags.
5428	</desc>
5429	<param name="patterns" type="wstring" dir="in">
5430	<desc>
5431	The patterns to match the properties against, separated by '\|'
5432	characters. If this is empty or @c null, all properties will match.
5433	</desc>
5434	</param>
5435	<param name="name" type="wstring" dir="out" safearray="yes">
5436	<desc>
5437	The names of the properties returned.
5438	</desc>
5439	</param>
5440	<param name="value" type="wstring" dir="out" safearray="yes">
5441	<desc>
5442	The values of the properties returned. The array entries match the
5443	corresponding entries in the @a name array.
5444	</desc>
5445	</param>
5446	<param name="timestamp" type="long long" dir="out" safearray="yes">
5447	<desc>
5448	The time stamps of the properties returned. The array entries match
5449	the corresponding entries in the @a name array.
5450	</desc>
5451	</param>
5452	<param name="flags" type="wstring" dir="out" safearray="yes">
5453	<desc>
5454	The flags of the properties returned. The array entries match the
5455	corresponding entries in the @a name array.
5456	</desc>
5457	</param>
5458	</method>
5459
5460	<method name="querySavedGuestSize">
5461	<desc>
5462	Returns the guest dimensions from the saved state.
5463	</desc>
5464	<param name="screenId" type="unsigned long" dir="in">
5465	<desc>
5466	Saved guest screen to query info from.
5467	</desc>
5468	</param>
5469	<param name="width" type="unsigned long" dir="out">
5470	<desc>
5471	Guest width at the time of the saved state was taken.
5472	</desc>
5473	</param>
5474	<param name="height" type="unsigned long" dir="out">
5475	<desc>
5476	Guest height at the time of the saved state was taken.
5477	</desc>
5478	</param>
5479	</method>
5480
5481	<method name="querySavedThumbnailSize">
5482	<desc>
5483	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5484	</desc>
5485	<param name="screenId" type="unsigned long" dir="in">
5486	<desc>
5487	Saved guest screen to query info from.
5488	</desc>
5489	</param>
5490	<param name="size" type="unsigned long" dir="out">
5491	<desc>
5492	Size of buffer required to store the bitmap.
5493	</desc>
5494	</param>
5495	<param name="width" type="unsigned long" dir="out">
5496	<desc>
5497	Bitmap width.
5498	</desc>
5499	</param>
5500	<param name="height" type="unsigned long" dir="out">
5501	<desc>
5502	Bitmap height.
5503	</desc>
5504	</param>
5505	</method>
5506
5507	<method name="readSavedThumbnailToArray">
5508	<desc>
5509	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5510	</desc>
5511	<param name="screenId" type="unsigned long" dir="in">
5512	<desc>
5513	Saved guest screen to read from.
5514	</desc>
5515	</param>
5516	<param name="BGR" type="boolean" dir="in">
5517	<desc>
5518	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5519	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5520	</desc>
5521	</param>
5522	<param name="width" type="unsigned long" dir="out">
5523	<desc>
5524	Bitmap width.
5525	</desc>
5526	</param>
5527	<param name="height" type="unsigned long" dir="out">
5528	<desc>
5529	Bitmap height.
5530	</desc>
5531	</param>
5532	<param name="data" type="octet" safearray="yes" dir="return">
5533	<desc>
5534	Array with resulting bitmap data.
5535	</desc>
5536	</param>
5537	</method>
5538
5539	<method name="readSavedThumbnailPNGToArray">
5540	<desc>
5541	Thumbnail in PNG format is retrieved to an array of bytes.
5542	</desc>
5543	<param name="screenId" type="unsigned long" dir="in">
5544	<desc>
5545	Saved guest screen to read from.
5546	</desc>
5547	</param>
5548	<param name="width" type="unsigned long" dir="out">
5549	<desc>
5550	Image width.
5551	</desc>
5552	</param>
5553	<param name="height" type="unsigned long" dir="out">
5554	<desc>
5555	Image height.
5556	</desc>
5557	</param>
5558	<param name="data" type="octet" dir="return" safearray="yes">
5559	<desc>
5560	Array with resulting PNG data.
5561	</desc>
5562	</param>
5563	</method>
5564
5565	<method name="querySavedScreenshotPNGSize">
5566	<desc>
5567	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5568	</desc>
5569	<param name="screenId" type="unsigned long" dir="in">
5570	<desc>
5571	Saved guest screen to query info from.
5572	</desc>
5573	</param>
5574	<param name="size" type="unsigned long" dir="out">
5575	<desc>
5576	Size of buffer required to store the PNG binary data.
5577	</desc>
5578	</param>
5579	<param name="width" type="unsigned long" dir="out">
5580	<desc>
5581	Image width.
5582	</desc>
5583	</param>
5584	<param name="height" type="unsigned long" dir="out">
5585	<desc>
5586	Image height.
5587	</desc>
5588	</param>
5589	</method>
5590
5591	<method name="readSavedScreenshotPNGToArray">
5592	<desc>
5593	Screenshot in PNG format is retrieved to an array of bytes.
5594	</desc>
5595	<param name="screenId" type="unsigned long" dir="in">
5596	<desc>
5597	Saved guest screen to read from.
5598	</desc>
5599	</param>
5600	<param name="width" type="unsigned long" dir="out">
5601	<desc>
5602	Image width.
5603	</desc>
5604	</param>
5605	<param name="height" type="unsigned long" dir="out">
5606	<desc>
5607	Image height.
5608	</desc>
5609	</param>
5610	<param name="data" type="octet" dir="return" safearray="yes">
5611	<desc>
5612	Array with resulting PNG data.
5613	</desc>
5614	</param>
5615	</method>
5616
5617	<method name="hotPlugCPU">
5618	<desc>
5619	Plugs a CPU into the machine.
5620	</desc>
5621	<param name="cpu" type="unsigned long" dir="in">
5622	<desc>
5623	The CPU id to insert.
5624	</desc>
5625	</param>
5626	</method>
5627
5628	<method name="hotUnplugCPU">
5629	<desc>
5630	Removes a CPU from the machine.
5631	</desc>
5632	<param name="cpu" type="unsigned long" dir="in">
5633	<desc>
5634	The CPU id to remove.
5635	</desc>
5636	</param>
5637	</method>
5638
5639	<method name="getCPUStatus">
5640	<desc>
5641	Returns the current status of the given CPU.
5642	</desc>
5643	<param name="cpu" type="unsigned long" dir="in">
5644	<desc>
5645	The CPU id to check for.
5646	</desc>
5647	</param>
5648	<param name="attached" type="boolean" dir="return">
5649	<desc>
5650	Status of the CPU.
5651	</desc>
5652	</param>
5653	</method>
5654
5655	<method name="queryLogFilename">
5656	<desc>
5657	Queries for the VM log file name of an given index. Returns an empty
5658	string if a log file with that index doesn't exists.
5659	</desc>
5660	<param name="idx" type="unsigned long" dir="in">
5661	<desc>
5662	Which log file name to query. 0=current log file.
5663	</desc>
5664	</param>
5665	<param name="filename" type="wstring" dir="return">
5666	<desc>
5667	On return the full path to the log file or an empty string on error.
5668	</desc>
5669	</param>
5670	</method>
5671
5672	<method name="readLog">
5673	<desc>
5674	Reads the VM log file. The chunk size is limited, so even if you
5675	ask for a big piece there might be less data returned.
5676	</desc>
5677	<param name="idx" type="unsigned long" dir="in">
5678	<desc>
5679	Which log file to read. 0=current log file.
5680	</desc>
5681	</param>
5682	<param name="offset" type="long long" dir="in">
5683	<desc>
5684	Offset in the log file.
5685	</desc>
5686	</param>
5687	<param name="size" type="long long" dir="in">
5688	<desc>
5689	Chunk size to read in the log file.
5690	</desc>
5691	</param>
5692	<param name="data" type="octet" dir="return" safearray="yes">
5693	<desc>
5694	Data read from the log file. A data size of 0 means end of file
5695	if the requested chunk size was not 0. This is the unprocessed
5696	file data, i.e. the line ending style depends on the platform of
5697	the system the server is running on.
5698	</desc>
5699	</param>
5700	</method>
5701	</interface>
5702
5703	<!--
5704	// IConsole
5705	/////////////////////////////////////////////////////////////////////////
5706	-->
5707
5708	<interface
5709	name="IVRDEServerInfo" extends="$unknown"
5710	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5711	wsmap="struct"
5712	>
5713	<desc>
5714	Contains information about the remote desktop (VRDE) server capabilities and status.
5715	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5716	</desc>
5717
5718	<attribute name="active" type="boolean" readonly="yes">
5719	<desc>
5720	Whether the remote desktop connection is active.
5721	</desc>
5722	</attribute>
5723
5724	<attribute name="port" type="long" readonly="yes">
5725	<desc>
5726	VRDE server port number. If this property is equal to <tt>0</tt>, then
5727	the VRDE server failed to start, usually because there are no free IP
5728	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5729	server has not yet been started.
5730	</desc>
5731	</attribute>
5732
5733	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5734	<desc>
5735	How many times a client connected.
5736	</desc>
5737	</attribute>
5738
5739	<attribute name="beginTime" type="long long" readonly="yes">
5740	<desc>
5741	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5742	</desc>
5743	</attribute>
5744
5745	<attribute name="endTime" type="long long" readonly="yes">
5746	<desc>
5747	When the last connection was terminated or the current time, if
5748	connection is still active, in milliseconds since 1970-01-01 UTC.
5749	</desc>
5750	</attribute>
5751
5752	<attribute name="bytesSent" type="long long" readonly="yes">
5753	<desc>
5754	How many bytes were sent in last or current, if still active, connection.
5755	</desc>
5756	</attribute>
5757
5758	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5759	<desc>
5760	How many bytes were sent in all connections.
5761	</desc>
5762	</attribute>
5763
5764	<attribute name="bytesReceived" type="long long" readonly="yes">
5765	<desc>
5766	How many bytes were received in last or current, if still active, connection.
5767	</desc>
5768	</attribute>
5769
5770	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5771	<desc>
5772	How many bytes were received in all connections.
5773	</desc>
5774	</attribute>
5775
5776	<attribute name="user" type="wstring" readonly="yes">
5777	<desc>
5778	Login user name supplied by the client.
5779	</desc>
5780	</attribute>
5781
5782	<attribute name="domain" type="wstring" readonly="yes">
5783	<desc>
5784	Login domain name supplied by the client.
5785	</desc>
5786	</attribute>
5787
5788	<attribute name="clientName" type="wstring" readonly="yes">
5789	<desc>
5790	The client name supplied by the client.
5791	</desc>
5792	</attribute>
5793
5794	<attribute name="clientIP" type="wstring" readonly="yes">
5795	<desc>
5796	The IP address of the client.
5797	</desc>
5798	</attribute>
5799
5800	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5801	<desc>
5802	The client software version number.
5803	</desc>
5804	</attribute>
5805
5806	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5807	<desc>
5808	Public key exchange method used when connection was established.
5809	Values: 0 - RDP4 public key exchange scheme.
5810	1 - X509 certificates were sent to client.
5811	</desc>
5812	</attribute>
5813
5814	</interface>
5815
5816	<interface
5817	name="IConsole" extends="$unknown"
5818	uuid="3c4a453e-d27b-44a2-b59d-dda6e1835e57"
5819	wsmap="managed"
5820	>
5821	<desc>
5822	The IConsole interface represents an interface to control virtual
5823	machine execution.
5824
5825	A console object gets created when a machine has been locked for a
5826	particular session (client process) using <link to="IMachine::lockMachine" />
5827	or <link to="IMachine::launchVMProcess"/>. The console object can
5828	then be found in the session's <link to="ISession::console" /> attribute.
5829
5830	Methods of the IConsole interface allow the caller to query the current
5831	virtual machine execution state, pause the machine or power it down, save
5832	the machine state or take a snapshot, attach and detach removable media
5833	and so on.
5834
5835	<see>ISession</see>
5836	</desc>
5837
5838	<attribute name="machine" type="IMachine" readonly="yes">
5839	<desc>
5840	Machine object for this console session.
5841	<note>
5842	This is a convenience property, it has the same value as
5843	<link to="ISession::machine"/> of the corresponding session
5844	object.
5845	</note>
5846	</desc>
5847	</attribute>
5848
5849	<attribute name="state" type="MachineState" readonly="yes">
5850	<desc>
5851	Current execution state of the machine.
5852	<note>
5853	This property always returns the same value as the corresponding
5854	property of the IMachine object for this console session.
5855	For the process that owns (executes) the VM, this is the
5856	preferable way of querying the VM state, because no IPC
5857	calls are made.
5858	</note>
5859	</desc>
5860	</attribute>
5861
5862	<attribute name="guest" type="IGuest" readonly="yes">
5863	<desc>Guest object.</desc>
5864	</attribute>
5865
5866	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5867	<desc>
5868	Virtual keyboard object.
5869	<note>
5870	If the machine is not running, any attempt to use
5871	the returned object will result in an error.
5872	</note>
5873	</desc>
5874	</attribute>
5875
5876	<attribute name="mouse" type="IMouse" readonly="yes">
5877	<desc>
5878	Virtual mouse object.
5879	<note>
5880	If the machine is not running, any attempt to use
5881	the returned object will result in an error.
5882	</note>
5883	</desc>
5884	</attribute>
5885
5886	<attribute name="display" type="IDisplay" readonly="yes">
5887	<desc>Virtual display object.
5888	<note>
5889	If the machine is not running, any attempt to use
5890	the returned object will result in an error.
5891	</note>
5892	</desc>
5893	</attribute>
5894
5895	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5896	<desc>Debugging interface.</desc>
5897	</attribute>
5898
5899	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5900	<desc>
5901	Collection of USB devices currently attached to the virtual
5902	USB controller.
5903	<note>
5904	The collection is empty if the machine is not running.
5905	</note>
5906	</desc>
5907	</attribute>
5908
5909	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5910	<desc>
5911	List of USB devices currently attached to the remote VRDE client.
5912	Once a new device is physically attached to the remote host computer,
5913	it appears in this list and remains there until detached.
5914	</desc>
5915	</attribute>
5916
5917	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5918	<desc>
5919	Collection of shared folders for the current session. These folders
5920	are called transient shared folders because they are available to the
5921	guest OS running inside the associated virtual machine only for the
5922	duration of the session (as opposed to
5923	<link to="IMachine::sharedFolders"/> which represent permanent shared
5924	folders). When the session is closed (e.g. the machine is powered down),
5925	these folders are automatically discarded.
5926
5927	New shared folders are added to the collection using
5928	<link to="#createSharedFolder"/>. Existing shared folders can be
5929	removed using <link to="#removeSharedFolder"/>.
5930	</desc>
5931	</attribute>
5932
5933	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
5934	<desc>
5935	Interface that provides information on Remote Desktop Extension (VRDE) connection.
5936	</desc>
5937	</attribute>
5938
5939	<attribute name="eventSource" type="IEventSource" readonly="yes">
5940	<desc>
5941	Event source for console events.
5942	</desc>
5943	</attribute>
5944
5945	<method name="powerUp">
5946	<desc>
5947	Starts the virtual machine execution using the current machine
5948	state (that is, its current execution state, current settings and
5949	current storage devices).
5950
5951	<note>
5952	This method is only useful for front-ends that want to actually
5953	execute virtual machines in their own process (like the VirtualBox
5954	or VBoxSDL front-ends). Unless you are intending to write such a
5955	front-end, do not call this method. If you simply want to
5956	start virtual machine execution using one of the existing front-ends
5957	(for example the VirtualBox GUI or headless server), use
5958	<link to="IMachine::launchVMProcess"/> instead; these
5959	front-ends will power up the machine automatically for you.
5960	</note>
5961
5962	If the machine is powered off or aborted, the execution will
5963	start from the beginning (as if the real hardware were just
5964	powered on).
5965
5966	If the machine is in the <link to="MachineState_Saved"/> state,
5967	it will continue its execution the point where the state has
5968	been saved.
5969
5970	If the machine <link to="IMachine::teleporterEnabled"/> property is
5971	enabled on the machine being powered up, the machine will wait for an
5972	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
5973	state. The returned progress object will have at least three
5974	operations where the last three are defined as: (1) powering up and
5975	starting TCP server, (2) waiting for incoming teleportations, and
5976	(3) perform teleportation. These operations will be reflected as the
5977	last three operations of the progress objected returned by
5978	<link to="IMachine::launchVMProcess"/> as well.
5979
5980	<see>#saveState</see>
5981
5982	<result name="VBOX_E_INVALID_VM_STATE">
5983	Virtual machine already running.
5984	</result>
5985	<result name="VBOX_E_HOST_ERROR">
5986	Host interface does not exist or name not set.
5987	</result>
5988	<result name="VBOX_E_FILE_ERROR">
5989	Invalid saved state file.
5990	</result>
5991	</desc>
5992	<param name="progress" type="IProgress" dir="return">
5993	<desc>Progress object to track the operation completion.</desc>
5994	</param>
5995	</method>
5996
5997	<method name="powerUpPaused">
5998	<desc>
5999	Identical to powerUp except that the VM will enter the
6000	<link to="MachineState_Paused"/> state, instead of
6001	<link to="MachineState_Running"/>.
6002
6003	<see>#powerUp</see>
6004	<result name="VBOX_E_INVALID_VM_STATE">
6005	Virtual machine already running.
6006	</result>
6007	<result name="VBOX_E_HOST_ERROR">
6008	Host interface does not exist or name not set.
6009	</result>
6010	<result name="VBOX_E_FILE_ERROR">
6011	Invalid saved state file.
6012	</result>
6013	</desc>
6014	<param name="progress" type="IProgress" dir="return">
6015	<desc>Progress object to track the operation completion.</desc>
6016	</param>
6017	</method>
6018
6019	<method name="powerDown">
6020	<desc>
6021	Initiates the power down procedure to stop the virtual machine
6022	execution.
6023
6024	The completion of the power down procedure is tracked using the returned
6025	IProgress object. After the operation is complete, the machine will go
6026	to the PoweredOff state.
6027	<result name="VBOX_E_INVALID_VM_STATE">
6028	Virtual machine must be Running, Paused or Stuck to be powered down.
6029	</result>
6030	</desc>
6031	<param name="progress" type="IProgress" dir="return">
6032	<desc>Progress object to track the operation completion.</desc>
6033	</param>
6034	</method>
6035
6036	<method name="reset">
6037	<desc>Resets the virtual machine.
6038	<result name="VBOX_E_INVALID_VM_STATE">
6039	Virtual machine not in Running state.
6040	</result>
6041	<result name="VBOX_E_VM_ERROR">
6042	Virtual machine error in reset operation.
6043	</result>
6044	</desc>
6045	</method>
6046
6047	<method name="pause">
6048	<desc>Pauses the virtual machine execution.
6049	<result name="VBOX_E_INVALID_VM_STATE">
6050	Virtual machine not in Running state.
6051	</result>
6052	<result name="VBOX_E_VM_ERROR">
6053	Virtual machine error in suspend operation.
6054	</result>
6055	</desc>
6056	</method>
6057
6058	<method name="resume">
6059	<desc>Resumes the virtual machine execution.
6060	<result name="VBOX_E_INVALID_VM_STATE">
6061	Virtual machine not in Paused state.
6062	</result>
6063	<result name="VBOX_E_VM_ERROR">
6064	Virtual machine error in resume operation.
6065	</result>
6066	</desc>
6067	</method>
6068
6069	<method name="powerButton">
6070	<desc>Sends the ACPI power button event to the guest.
6071	<result name="VBOX_E_INVALID_VM_STATE">
6072	Virtual machine not in Running state.
6073	</result>
6074	<result name="VBOX_E_PDM_ERROR">
6075	Controlled power off failed.
6076	</result>
6077	</desc>
6078	</method>
6079
6080	<method name="sleepButton">
6081	<desc>Sends the ACPI sleep button event to the guest.
6082	<result name="VBOX_E_INVALID_VM_STATE">
6083	Virtual machine not in Running state.
6084	</result>
6085	<result name="VBOX_E_PDM_ERROR">
6086	Sending sleep button event failed.
6087	</result>
6088	</desc>
6089	</method>
6090
6091	<method name="getPowerButtonHandled">
6092	<desc>Checks if the last power button event was handled by guest.
6093	<result name="VBOX_E_PDM_ERROR">
6094	Checking if the event was handled by the guest OS failed.
6095	</result>
6096	</desc>
6097	<param name="handled" type="boolean" dir="return"/>
6098	</method>
6099
6100	<method name="getGuestEnteredACPIMode">
6101	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6102	G1 (sleeping). If this method returns @c false, the guest will
6103	most likely not respond to external ACPI events.
6104	<result name="VBOX_E_INVALID_VM_STATE">
6105	Virtual machine not in Running state.
6106	</result>
6107	</desc>
6108	<param name="entered" type="boolean" dir="return"/>
6109	</method>
6110
6111	<method name="saveState">
6112	<desc>
6113	Saves the current execution state of a running virtual machine
6114	and stops its execution.
6115
6116	After this operation completes, the machine will go to the
6117	Saved state. Next time it is powered up, this state will
6118	be restored and the machine will continue its execution from
6119	the place where it was saved.
6120
6121	This operation differs from taking a snapshot to the effect
6122	that it doesn't create new differencing media. Also, once
6123	the machine is powered up from the state saved using this method,
6124	the saved state is deleted, so it will be impossible to return
6125	to this state later.
6126
6127	<note>
6128	On success, this method implicitly calls
6129	<link to="IMachine::saveSettings"/> to save all current machine
6130	settings (including runtime changes to the DVD medium, etc.).
6131	Together with the impossibility to change any VM settings when it is
6132	in the Saved state, this guarantees adequate hardware
6133	configuration of the machine when it is restored from the saved
6134	state file.
6135	</note>
6136
6137	<note>
6138	The machine must be in the Running or Paused state, otherwise
6139	the operation will fail.
6140	</note>
6141	<result name="VBOX_E_INVALID_VM_STATE">
6142	Virtual machine state neither Running nor Paused.
6143	</result>
6144	<result name="VBOX_E_FILE_ERROR">
6145	Failed to create directory for saved state file.
6146	</result>
6147
6148	<see><link to="#takeSnapshot"/></see>
6149	</desc>
6150	<param name="progress" type="IProgress" dir="return">
6151	<desc>Progress object to track the operation completion.</desc>
6152	</param>
6153	</method>
6154
6155	<method name="adoptSavedState">
6156	<desc>
6157	Associates the given saved state file to the virtual machine.
6158
6159	On success, the machine will go to the Saved state. Next time it is
6160	powered up, it will be restored from the adopted saved state and
6161	continue execution from the place where the saved state file was
6162	created.
6163
6164	The specified saved state file path may be absolute or relative to the
6165	folder the VM normally saves the state to (usually,
6166	<link to="IMachine::snapshotFolder"/>).
6167
6168	<note>
6169	It's a caller's responsibility to make sure the given saved state
6170	file is compatible with the settings of this virtual machine that
6171	represent its virtual hardware (memory size, storage disk configuration
6172	etc.). If there is a mismatch, the behavior of the virtual machine
6173	is undefined.
6174	</note>
6175	<result name="VBOX_E_INVALID_VM_STATE">
6176	Virtual machine state neither PoweredOff nor Aborted.
6177	</result>
6178	</desc>
6179	<param name="savedStateFile" type="wstring" dir="in">
6180	<desc>Path to the saved state file to adopt.</desc>
6181	</param>
6182	</method>
6183
6184	<method name="discardSavedState">
6185	<desc>
6186	Forcibly resets the machine to "Powered Off" state if it is
6187	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6188	Next time the machine is powered up, a clean boot will occur.
6189	<note>
6190	This operation is equivalent to resetting or powering off
6191	the machine without doing a proper shutdown of the guest
6192	operating system; as with resetting a running phyiscal
6193	computer, it can can lead to data loss.
6194	</note>
6195	If @a fRemoveFile is @c true, the file in the machine directory
6196	into which the machine state was saved is also deleted. If
6197	this is @c false, then the state can be recovered and later
6198	re-inserted into a machine using <link to="#adoptSavedState" />.
6199	The location of the file can be found in the
6200	<link to="IMachine::stateFilePath" /> attribute.
6201	<result name="VBOX_E_INVALID_VM_STATE">
6202	Virtual machine not in state Saved.
6203	</result>
6204	</desc>
6205	<param name="fRemoveFile" type="boolean" dir="in" >
6206	<desc>Whether to also remove the saved state file.</desc>
6207	</param>
6208	</method>
6209
6210	<method name="getDeviceActivity">
6211	<desc>
6212	Gets the current activity type of a given device or device group.
6213	<result name="E_INVALIDARG">
6214	Invalid device type.
6215	</result>
6216	</desc>
6217	<param name="type" type="DeviceType" dir="in"/>
6218	<param name="activity" type="DeviceActivity" dir="return"/>
6219	</method>
6220
6221	<method name="attachUSBDevice">
6222	<desc>
6223	Attaches a host USB device with the given UUID to the
6224	USB controller of the virtual machine.
6225
6226	The device needs to be in one of the following states:
6227	<link to="USBDeviceState_Busy"/>,
6228	<link to="USBDeviceState_Available"/> or
6229	<link to="USBDeviceState_Held"/>,
6230	otherwise an error is immediately returned.
6231
6232	When the device state is
6233	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6234	be returned if the host computer refuses to release it for some reason.
6235
6236	<see>IUSBController::deviceFilters, USBDeviceState</see>
6237	<result name="VBOX_E_INVALID_VM_STATE">
6238	Virtual machine state neither Running nor Paused.
6239	</result>
6240	<result name="VBOX_E_PDM_ERROR">
6241	Virtual machine does not have a USB controller.
6242	</result>
6243	</desc>
6244	<param name="id" type="uuid" mod="string" dir="in">
6245	<desc>UUID of the host USB device to attach.</desc>
6246	</param>
6247	</method>
6248
6249	<method name="detachUSBDevice">
6250	<desc>
6251	Detaches an USB device with the given UUID from the USB controller
6252	of the virtual machine.
6253
6254	After this method succeeds, the VirtualBox server re-initiates
6255	all USB filters as if the device were just physically attached
6256	to the host, but filters of this machine are ignored to avoid
6257	a possible automatic re-attachment.
6258
6259	<see>IUSBController::deviceFilters, USBDeviceState</see>
6260
6261	<result name="VBOX_E_PDM_ERROR">
6262	Virtual machine does not have a USB controller.
6263	</result>
6264	<result name="E_INVALIDARG">
6265	USB device not attached to this virtual machine.
6266	</result>
6267	</desc>
6268	<param name="id" type="uuid" mod="string" dir="in">
6269	<desc>UUID of the USB device to detach.</desc>
6270	</param>
6271	<param name="device" type="IUSBDevice" dir="return">
6272	<desc>Detached USB device.</desc>
6273	</param>
6274	</method>
6275
6276	<method name="findUSBDeviceByAddress">
6277	<desc>
6278	Searches for a USB device with the given host address.
6279
6280	<result name="VBOX_E_OBJECT_NOT_FOUND">
6281	Given @c name does not correspond to any USB device.
6282	</result>
6283
6284	<see>IUSBDevice::address</see>
6285	</desc>
6286	<param name="name" type="wstring" dir="in">
6287	<desc>
6288	Address of the USB device (as assigned by the host) to
6289	search for.
6290	</desc>
6291	</param>
6292	<param name="device" type="IUSBDevice" dir="return">
6293	<desc>Found USB device object.</desc>
6294	</param>
6295	</method>
6296
6297	<method name="findUSBDeviceById">
6298	<desc>
6299	Searches for a USB device with the given UUID.
6300
6301	<result name="VBOX_E_OBJECT_NOT_FOUND">
6302	Given @c id does not correspond to any USB device.
6303	</result>
6304
6305	<see>IUSBDevice::id</see>
6306	</desc>
6307	<param name="id" type="uuid" mod="string" dir="in">
6308	<desc>UUID of the USB device to search for.</desc>
6309	</param>
6310	<param name="device" type="IUSBDevice" dir="return">
6311	<desc>Found USB device object.</desc>
6312	</param>
6313	</method>
6314
6315	<method name="createSharedFolder">
6316	<desc>
6317	Creates a transient new shared folder by associating the given logical
6318	name with the given host path, adds it to the collection of shared
6319	folders and starts sharing it. Refer to the description of
6320	<link to="ISharedFolder"/> to read more about logical names.
6321
6322	<result name="VBOX_E_INVALID_VM_STATE">
6323	Virtual machine in Saved state or currently changing state.
6324	</result>
6325	<result name="VBOX_E_FILE_ERROR">
6326	Shared folder already exists or not accessible.
6327	</result>
6328	</desc>
6329	<param name="name" type="wstring" dir="in">
6330	<desc>Unique logical name of the shared folder.</desc>
6331	</param>
6332	<param name="hostPath" type="wstring" dir="in">
6333	<desc>Full path to the shared folder in the host file system.</desc>
6334	</param>
6335	<param name="writable" type="boolean" dir="in">
6336	<desc>Whether the share is writable or readonly</desc>
6337	</param>
6338	<param name="automount" type="boolean" dir="in">
6339	<desc>Whether the share gets automatically mounted by the guest
6340	or not.</desc>
6341	</param>
6342	</method>
6343
6344	<method name="removeSharedFolder">
6345	<desc>
6346	Removes a transient shared folder with the given name previously
6347	created by <link to="#createSharedFolder"/> from the collection of
6348	shared folders and stops sharing it.
6349	<result name="VBOX_E_INVALID_VM_STATE">
6350	Virtual machine in Saved state or currently changing state.
6351	</result>
6352	<result name="VBOX_E_FILE_ERROR">
6353	Shared folder does not exists.
6354	</result>
6355	</desc>
6356	<param name="name" type="wstring" dir="in">
6357	<desc>Logical name of the shared folder to remove.</desc>
6358	</param>
6359	</method>
6360
6361	<method name="takeSnapshot">
6362	<desc>
6363	Saves the current execution state
6364	and all settings of the machine and creates differencing images
6365	for all normal (non-independent) media.
6366	See <link to="ISnapshot" /> for an introduction to snapshots.
6367
6368	This method can be called for a PoweredOff, Saved (see
6369	<link to="#saveState"/>), Running or
6370	Paused virtual machine. When the machine is PoweredOff, an
6371	offline snapshot is created. When the machine is Running a live
6372	snapshot is created, and an online snapshot is is created when Paused.
6373
6374	The taken snapshot is always based on the
6375	<link to="IMachine::currentSnapshot">current snapshot</link>
6376	of the associated virtual machine and becomes a new current snapshot.
6377
6378	<note>
6379	This method implicitly calls <link to="IMachine::saveSettings"/> to
6380	save all current machine settings before taking an offline snapshot.
6381	</note>
6382
6383	<result name="VBOX_E_INVALID_VM_STATE">
6384	Virtual machine currently changing state.
6385	</result>
6386	</desc>
6387	<param name="name" type="wstring" dir="in">
6388	<desc>Short name for the snapshot.</desc>
6389	</param>
6390	<param name="description" type="wstring" dir="in">
6391	<desc>Optional description of the snapshot.</desc>
6392	</param>
6393	<param name="progress" type="IProgress" dir="return">
6394	<desc>Progress object to track the operation completion.</desc>
6395	</param>
6396	</method>
6397
6398	<method name="deleteSnapshot">
6399	<desc>
6400	Starts deleting the specified snapshot asynchronously.
6401	See <link to="ISnapshot" /> for an introduction to snapshots.
6402
6403	The execution state and settings of the associated machine stored in
6404	the snapshot will be deleted. The contents of all differencing media of
6405	this snapshot will be merged with the contents of their dependent child
6406	media to keep the medium chain valid (in other words, all changes
6407	represented by media being deleted will be propagated to their child
6408	medium). After that, this snapshot's differencing medium will be
6409	deleted. The parent of this snapshot will become a new parent for all
6410	its child snapshots.
6411
6412	If the deleted snapshot is the current one, its parent snapshot will
6413	become a new current snapshot. The current machine state is not directly
6414	affected in this case, except that currently attached differencing
6415	media based on media of the deleted snapshot will be also merged as
6416	described above.
6417
6418	If the deleted snapshot is the first or current snapshot, then the
6419	respective IMachine attributes will be adjusted. Deleting the current
6420	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6421	to make all current machine settings permanent.
6422
6423	Deleting a snapshot has the following preconditions:
6424
6425	<ul>
6426	<li>Child media of all normal media of the deleted snapshot
6427	must be accessible (see <link to="IMedium::state"/>) for this
6428	operation to succeed. In particular, this means that all virtual
6429	machines whose media are directly or indirectly based on the
6430	media of deleted snapshot must be powered off.</li>
6431
6432	<li>You cannot delete the snapshot if a medium attached to it has
6433	more than once child medium (differencing images) because otherwise
6434	merging would be impossible. This might be the case if there is
6435	more than one child snapshot or differencing images were created
6436	for other reason (e.g. implicitly because of multiple machine
6437	attachments).</li>
6438	</ul>
6439
6440
6441	The virtual machine's <link to="IMachine::state">state</link> is
6442	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6443	"DeletingSnapshotPaused" while this operation is in progress.
6444
6445	<note>
6446	Merging medium contents can be very time and disk space
6447	consuming, if these media are big in size and have many
6448	children. However, if the snapshot being deleted is the last
6449	(head) snapshot on the branch, the operation will be rather
6450	quick.
6451	</note>
6452	<result name="VBOX_E_INVALID_VM_STATE">
6453	The running virtual machine prevents deleting this snapshot. This
6454	happens only in very specific situations, usually snapshots can be
6455	deleted without trouble while a VM is running. The error message
6456	text explains the reason for the failure.
6457	</result>
6458	</desc>
6459	<param name="id" type="uuid" mod="string" dir="in">
6460	<desc>UUID of the snapshot to delete.</desc>
6461	</param>
6462	<param name="progress" type="IProgress" dir="return">
6463	<desc>Progress object to track the operation completion.</desc>
6464	</param>
6465	</method>
6466
6467	<method name="restoreSnapshot">
6468	<desc>
6469	Starts resetting the machine's current state to the state contained
6470	in the given snapshot, asynchronously. All current settings of the
6471	machine will be reset and changes stored in differencing media
6472	will be lost.
6473	See <link to="ISnapshot" /> for an introduction to snapshots.
6474
6475	After this operation is successfully completed, new empty differencing
6476	media are created for all normal media of the machine.
6477
6478	If the given snapshot is an online snapshot, the machine will go to
6479	the <link to="MachineState_Saved"> saved state</link>, so that the
6480	next time it is powered on, the execution state will be restored
6481	from the state of the snapshot.
6482
6483	<note>
6484	The machine must not be running, otherwise the operation will fail.
6485	</note>
6486
6487	<note>
6488	If the machine state is <link to="MachineState_Saved">Saved</link>
6489	prior to this operation, the saved state file will be implicitly
6490	deleted (as if <link to="IConsole::discardSavedState"/> were
6491	called).
6492	</note>
6493
6494	<result name="VBOX_E_INVALID_VM_STATE">
6495	Virtual machine is running.
6496	</result>
6497	</desc>
6498	<param name="snapshot" type="ISnapshot" dir="in">
6499	<desc>The snapshot to restore the VM state from.</desc>
6500	</param>
6501	<param name="progress" type="IProgress" dir="return">
6502	<desc>Progress object to track the operation completion.</desc>
6503	</param>
6504	</method>
6505
6506	<method name="teleport">
6507	<desc>
6508	Teleport the VM to a different host machine or process.
6509
6510	TODO explain the details.
6511
6512	<result name="VBOX_E_INVALID_VM_STATE">
6513	Virtual machine not running or paused.
6514	</result>
6515	</desc>
6516	<param name="hostname" type="wstring" dir="in">
6517	<desc>The name or IP of the host to teleport to.</desc>
6518	</param>
6519	<param name="tcpport" type="unsigned long" dir="in">
6520	<desc>The TCP port to connect to (1..65535).</desc>
6521	</param>
6522	<param name="password" type="wstring" dir="in">
6523	<desc>The password.</desc>
6524	</param>
6525	<param name="maxDowntime" type="unsigned long" dir="in">
6526	<desc>
6527	The maximum allowed downtime given as milliseconds. 0 is not a valid
6528	value. Recommended value: 250 ms.
6529
6530	The higher the value is, the greater the chance for a successful
6531	teleportation. A small value may easily result in the teleportation
6532	process taking hours and eventually fail.
6533
6534	<note>
6535	The current implementation treats this a guideline, not as an
6536	absolute rule.
6537	</note>
6538	</desc>
6539	</param>
6540	<param name="progress" type="IProgress" dir="return">
6541	<desc>Progress object to track the operation completion.</desc>
6542	</param>
6543	</method>
6544
6545	</interface>
6546
6547	<!--
6548	// IHost
6549	/////////////////////////////////////////////////////////////////////////
6550	-->
6551
6552	<enum
6553	name="HostNetworkInterfaceMediumType"
6554	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6555	>
6556	<desc>
6557	Type of encapsulation. Ethernet encapsulation includes both wired and
6558	wireless Ethernet connections.
6559	<see>IHostNetworkInterface</see>
6560	</desc>
6561
6562	<const name="Unknown" value="0">
6563	<desc>
6564	The type of interface cannot be determined.
6565	</desc>
6566	</const>
6567	<const name="Ethernet" value="1">
6568	<desc>
6569	Ethernet frame encapsulation.
6570	</desc>
6571	</const>
6572	<const name="PPP" value="2">
6573	<desc>
6574	Point-to-point protocol encapsulation.
6575	</desc>
6576	</const>
6577	<const name="SLIP" value="3">
6578	<desc>
6579	Serial line IP encapsulation.
6580	</desc>
6581	</const>
6582	</enum>
6583
6584	<enum
6585	name="HostNetworkInterfaceStatus"
6586	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6587	>
6588	<desc>
6589	Current status of the interface.
6590	<see>IHostNetworkInterface</see>
6591	</desc>
6592
6593	<const name="Unknown" value="0">
6594	<desc>
6595	The state of interface cannot be determined.
6596	</desc>
6597	</const>
6598	<const name="Up" value="1">
6599	<desc>
6600	The interface is fully operational.
6601	</desc>
6602	</const>
6603	<const name="Down" value="2">
6604	<desc>
6605	The interface is not functioning.
6606	</desc>
6607	</const>
6608	</enum>
6609
6610	<enum
6611	name="HostNetworkInterfaceType"
6612	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6613	>
6614	<desc>
6615	Network interface type.
6616	</desc>
6617	<const name="Bridged" value="1"/>
6618	<const name="HostOnly" value="2"/>
6619	</enum>
6620
6621	<interface
6622	name="IHostNetworkInterface" extends="$unknown"
6623	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6624	wsmap="managed"
6625	>
6626	<desc>
6627	Represents one of host's network interfaces. IP V6 address and network
6628	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6629	separated by colons.
6630	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6631	</desc>
6632	<attribute name="name" type="wstring" readonly="yes">
6633	<desc>Returns the host network interface name.</desc>
6634	</attribute>
6635
6636	<attribute name="id" type="uuid" mod="string" readonly="yes">
6637	<desc>Returns the interface UUID.</desc>
6638	</attribute>
6639
6640	<attribute name="networkName" type="wstring" readonly="yes">
6641	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6642	</attribute>
6643
6644	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6645	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6646	</attribute>
6647
6648	<attribute name="IPAddress" type="wstring" readonly="yes">
6649	<desc>Returns the IP V4 address of the interface.</desc>
6650	</attribute>
6651
6652	<attribute name="networkMask" type="wstring" readonly="yes">
6653	<desc>Returns the network mask of the interface.</desc>
6654	</attribute>
6655
6656	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6657	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6658	</attribute>
6659
6660	<attribute name="IPV6Address" type="wstring" readonly="yes">
6661	<desc>Returns the IP V6 address of the interface.</desc>
6662	</attribute>
6663
6664	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6665	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6666	</attribute>
6667
6668	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6669	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6670	</attribute>
6671
6672	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6673	<desc>Type of protocol encapsulation used.</desc>
6674	</attribute>
6675
6676	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6677	<desc>Status of the interface.</desc>
6678	</attribute>
6679
6680	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6681	<desc>specifies the host interface type.</desc>
6682	</attribute>
6683
6684	<method name="enableStaticIpConfig">
6685	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6686	<param name="IPAddress" type="wstring" dir="in">
6687	<desc>
6688	IP address.
6689	</desc>
6690	</param>
6691	<param name="networkMask" type="wstring" dir="in">
6692	<desc>
6693	network mask.
6694	</desc>
6695	</param>
6696	</method>
6697
6698	<method name="enableStaticIpConfigV6">
6699	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6700	<param name="IPV6Address" type="wstring" dir="in">
6701	<desc>
6702	IP address.
6703	</desc>
6704	</param>
6705	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6706	<desc>
6707	network mask.
6708	</desc>
6709	</param>
6710	</method>
6711
6712	<method name="enableDynamicIpConfig">
6713	<desc>enables the dynamic IP configuration.</desc>
6714	</method>
6715
6716	<method name="dhcpRediscover">
6717	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6718	</method>
6719
6720	</interface>
6721
6722	<interface
6723	name="IHost" extends="$unknown"
6724	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6725	wsmap="managed"
6726	>
6727	<desc>
6728	The IHost interface represents the physical machine that this VirtualBox
6729	installation runs on.
6730
6731	An object implementing this interface is returned by the
6732	<link to="IVirtualBox::host" /> attribute. This interface contains
6733	read-only information about the host's physical hardware (such as what
6734	processors and disks are available, what the host operating system is,
6735	and so on) and also allows for manipulating some of the host's hardware,
6736	such as global USB device filters and host interface networking.
6737
6738	</desc>
6739	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6740	<desc>List of DVD drives available on the host.</desc>
6741	</attribute>
6742
6743	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6744	<desc>List of floppy drives available on the host.</desc>
6745	</attribute>
6746
6747	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6748	<desc>
6749	List of USB devices currently attached to the host.
6750	Once a new device is physically attached to the host computer,
6751	it appears in this list and remains there until detached.
6752
6753	<note>
6754	If USB functionality is not available in the given edition of
6755	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6756	</note>
6757	</desc>
6758	</attribute>
6759
6760	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6761	<desc>
6762	List of USB device filters in action.
6763	When a new device is physically attached to the host computer,
6764	filters from this list are applied to it (in order they are stored
6765	in the list). The first matched filter will determine the
6766	<link to="IHostUSBDeviceFilter::action">action</link>
6767	performed on the device.
6768
6769	Unless the device is ignored by these filters, filters of all
6770	currently running virtual machines
6771	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6772
6773	<note>
6774	If USB functionality is not available in the given edition of
6775	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6776	</note>
6777
6778	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6779	</desc>
6780	</attribute>
6781
6782	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6783	<desc>List of host network interfaces currently defined on the host.</desc>
6784	</attribute>
6785
6786	<attribute name="processorCount" type="unsigned long" readonly="yes">
6787	<desc>Number of (logical) CPUs installed in the host system.</desc>
6788	</attribute>
6789
6790	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6791	<desc>Number of (logical) CPUs online in the host system.</desc>
6792	</attribute>
6793
6794	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6795	<desc>Number of physical processor cores installed in the host system.</desc>
6796	</attribute>
6797
6798	<method name="getProcessorSpeed">
6799	<desc>Query the (approximate) maximum speed of a specified host CPU in
6800	Megahertz.
6801	</desc>
6802	<param name="cpuId" type="unsigned long" dir="in">
6803	<desc>
6804	Identifier of the CPU.
6805	</desc>
6806	</param>
6807	<param name="speed" type="unsigned long" dir="return">
6808	<desc>
6809	Speed value. 0 is returned if value is not known or @a cpuId is
6810	invalid.
6811	</desc>
6812	</param>
6813	</method>
6814
6815	<method name="getProcessorFeature">
6816	<desc>Query whether a CPU feature is supported or not.</desc>
6817	<param name="feature" type="ProcessorFeature" dir="in">
6818	<desc>
6819	CPU Feature identifier.
6820	</desc>
6821	</param>
6822	<param name="supported" type="boolean" dir="return">
6823	<desc>
6824	Feature is supported or not.
6825	</desc>
6826	</param>
6827	</method>
6828
6829	<method name="getProcessorDescription">
6830	<desc>Query the model string of a specified host CPU.
6831	</desc>
6832	<param name="cpuId" type="unsigned long" dir="in">
6833	<desc>
6834	Identifier of the CPU.
6835	<note>
6836	The current implementation might not necessarily return the
6837	description for this exact CPU.
6838	</note>
6839	</desc>
6840	</param>
6841	<param name="description" type="wstring" dir="return">
6842	<desc>
6843	Model string. An empty string is returned if value is not known or
6844	@a cpuId is invalid.
6845	</desc>
6846	</param>
6847	</method>
6848
6849	<method name="getProcessorCPUIDLeaf">
6850	<desc>
6851	Returns the CPU cpuid information for the specified leaf.
6852	</desc>
6853	<param name="cpuId" type="unsigned long" dir="in">
6854	<desc>
6855	Identifier of the CPU. The CPU most be online.
6856	<note>
6857	The current implementation might not necessarily return the
6858	description for this exact CPU.
6859	</note>
6860	</desc>
6861	</param>
6862	<param name="leaf" type="unsigned long" dir="in">
6863	<desc>
6864	CPUID leaf index (eax).
6865	</desc>
6866	</param>
6867	<param name="subLeaf" type="unsigned long" dir="in">
6868	<desc>
6869	CPUID leaf sub index (ecx). This currently only applies to cache
6870	information on Intel CPUs. Use 0 if retrieving values for
6871	<link to="IMachine::setCPUIDLeaf"/>.
6872	</desc>
6873	</param>
6874	<param name="valEax" type="unsigned long" dir="out">
6875	<desc>
6876	CPUID leaf value for register eax.
6877	</desc>
6878	</param>
6879	<param name="valEbx" type="unsigned long" dir="out">
6880	<desc>
6881	CPUID leaf value for register ebx.
6882	</desc>
6883	</param>
6884	<param name="valEcx" type="unsigned long" dir="out">
6885	<desc>
6886	CPUID leaf value for register ecx.
6887	</desc>
6888	</param>
6889	<param name="valEdx" type="unsigned long" dir="out">
6890	<desc>
6891	CPUID leaf value for register edx.
6892	</desc>
6893	</param>
6894	</method>
6895
6896	<attribute name="memorySize" type="unsigned long" readonly="yes">
6897	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6898	</attribute>
6899
6900	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6901	<desc>Available system memory in the host system.</desc>
6902	</attribute>
6903
6904	<attribute name="operatingSystem" type="wstring" readonly="yes">
6905	<desc>Name of the host system's operating system.</desc>
6906	</attribute>
6907
6908	<attribute name="OSVersion" type="wstring" readonly="yes">
6909	<desc>Host operating system's version string.</desc>
6910	</attribute>
6911
6912	<attribute name="UTCTime" type="long long" readonly="yes">
6913	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6914	</attribute>
6915
6916	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6917	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6918	</attribute>
6919
6920	<method name="createHostOnlyNetworkInterface">
6921	<desc>
6922	Creates a new adapter for Host Only Networking.
6923	<result name="E_INVALIDARG">
6924	Host network interface @a name already exists.
6925	</result>
6926	</desc>
6927	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6928	<desc>
6929	Created host interface object.
6930	</desc>
6931	</param>
6932	<param name="progress" type="IProgress" dir="return">
6933	<desc>
6934	Progress object to track the operation completion.
6935	</desc>
6936	</param>
6937	</method>
6938
6939	<method name="removeHostOnlyNetworkInterface">
6940	<desc>
6941	Removes the given Host Only Networking interface.
6942	<result name="VBOX_E_OBJECT_NOT_FOUND">
6943	No host network interface matching @a id found.
6944	</result>
6945	</desc>
6946	<param name="id" type="uuid" mod="string" dir="in">
6947	<desc>
6948	Adapter GUID.
6949	</desc>
6950	</param>
6951	<param name="progress" type="IProgress" dir="return">
6952	<desc>
6953	Progress object to track the operation completion.
6954	</desc>
6955	</param>
6956	</method>
6957
6958	<method name="createUSBDeviceFilter">
6959	<desc>
6960	Creates a new USB device filter. All attributes except
6961	the filter name are set to empty (any match),
6962	<i>active</i> is @c false (the filter is not active).
6963
6964	The created filter can be added to the list of filters using
6965	<link to="#insertUSBDeviceFilter"/>.
6966
6967	<see>#USBDeviceFilters</see>
6968	</desc>
6969	<param name="name" type="wstring" dir="in">
6970	<desc>
6971	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6972	</desc>
6973	</param>
6974	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6975	<desc>Created filter object.</desc>
6976	</param>
6977	</method>
6978
6979	<method name="insertUSBDeviceFilter">
6980	<desc>
6981	Inserts the given USB device to the specified position
6982	in the list of filters.
6983
6984	Positions are numbered starting from @c 0. If the specified
6985	position is equal to or greater than the number of elements in
6986	the list, the filter is added at the end of the collection.
6987
6988	<note>
6989	Duplicates are not allowed, so an attempt to insert a
6990	filter already in the list is an error.
6991	</note>
6992	<note>
6993	If USB functionality is not available in the given edition of
6994	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6995	</note>
6996
6997	<see>#USBDeviceFilters</see>
6998
6999	<result name="VBOX_E_INVALID_OBJECT_STATE">
7000	USB device filter is not created within this VirtualBox instance.
7001	</result>
7002	<result name="E_INVALIDARG">
7003	USB device filter already in list.
7004	</result>
7005
7006	</desc>
7007	<param name="position" type="unsigned long" dir="in">
7008	<desc>Position to insert the filter to.</desc>
7009	</param>
7010	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7011	<desc>USB device filter to insert.</desc>
7012	</param>
7013	</method>
7014
7015	<method name="removeUSBDeviceFilter">
7016	<desc>
7017	Removes a USB device filter from the specified position in the
7018	list of filters.
7019
7020	Positions are numbered starting from @c 0. Specifying a
7021	position equal to or greater than the number of elements in
7022	the list will produce an error.
7023
7024	<note>
7025	If USB functionality is not available in the given edition of
7026	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7027	</note>
7028
7029	<see>#USBDeviceFilters</see>
7030
7031	<result name="E_INVALIDARG">
7032	USB device filter list empty or invalid @a position.
7033	</result>
7034
7035	</desc>
7036	<param name="position" type="unsigned long" dir="in">
7037	<desc>Position to remove the filter from.</desc>
7038	</param>
7039	</method>
7040
7041	<method name="findHostDVDDrive">
7042	<desc>
7043	Searches for a host DVD drive with the given @c name.
7044
7045	<result name="VBOX_E_OBJECT_NOT_FOUND">
7046	Given @c name does not correspond to any host drive.
7047	</result>
7048
7049	</desc>
7050	<param name="name" type="wstring" dir="in">
7051	<desc>Name of the host drive to search for</desc>
7052	</param>
7053	<param name="drive" type="IMedium" dir="return">
7054	<desc>Found host drive object</desc>
7055	</param>
7056	</method>
7057
7058	<method name="findHostFloppyDrive">
7059	<desc>
7060	Searches for a host floppy drive with the given @c name.
7061
7062	<result name="VBOX_E_OBJECT_NOT_FOUND">
7063	Given @c name does not correspond to any host floppy drive.
7064	</result>
7065
7066	</desc>
7067	<param name="name" type="wstring" dir="in">
7068	<desc>Name of the host floppy drive to search for</desc>
7069	</param>
7070	<param name="drive" type="IMedium" dir="return">
7071	<desc>Found host floppy drive object</desc>
7072	</param>
7073	</method>
7074
7075	<method name="findHostNetworkInterfaceByName">
7076	<desc>
7077	Searches through all host network interfaces for an interface with
7078	the given @c name.
7079	<note>
7080	The method returns an error if the given @c name does not
7081	correspond to any host network interface.
7082	</note>
7083	</desc>
7084	<param name="name" type="wstring" dir="in">
7085	<desc>Name of the host network interface to search for.</desc>
7086	</param>
7087	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7088	<desc>Found host network interface object.</desc>
7089	</param>
7090	</method>
7091	<method name="findHostNetworkInterfaceById">
7092	<desc>
7093	Searches through all host network interfaces for an interface with
7094	the given GUID.
7095	<note>
7096	The method returns an error if the given GUID does not
7097	correspond to any host network interface.
7098	</note>
7099	</desc>
7100	<param name="id" type="uuid" mod="string" dir="in">
7101	<desc>GUID of the host network interface to search for.</desc>
7102	</param>
7103	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7104	<desc>Found host network interface object.</desc>
7105	</param>
7106	</method>
7107	<method name="findHostNetworkInterfacesOfType">
7108	<desc>
7109	Searches through all host network interfaces and returns a list of interfaces of the specified type
7110	</desc>
7111	<param name="type" type="HostNetworkInterfaceType" dir="in">
7112	<desc>type of the host network interfaces to search for.</desc>
7113	</param>
7114	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7115	<desc>Found host network interface objects.</desc>
7116	</param>
7117	</method>
7118
7119	<method name="findUSBDeviceById">
7120	<desc>
7121	Searches for a USB device with the given UUID.
7122
7123	<result name="VBOX_E_OBJECT_NOT_FOUND">
7124	Given @c id does not correspond to any USB device.
7125	</result>
7126
7127	<see>IHostUSBDevice::id</see>
7128	</desc>
7129	<param name="id" type="uuid" mod="string" dir="in">
7130	<desc>UUID of the USB device to search for.</desc>
7131	</param>
7132	<param name="device" type="IHostUSBDevice" dir="return">
7133	<desc>Found USB device object.</desc>
7134	</param>
7135	</method>
7136
7137	<method name="findUSBDeviceByAddress">
7138	<desc>
7139	Searches for a USB device with the given host address.
7140
7141	<result name="VBOX_E_OBJECT_NOT_FOUND">
7142	Given @c name does not correspond to any USB device.
7143	</result>
7144
7145	<see>IHostUSBDevice::address</see>
7146	</desc>
7147	<param name="name" type="wstring" dir="in">
7148	<desc>
7149	Address of the USB device (as assigned by the host) to
7150	search for.
7151	</desc>
7152	</param>
7153	<param name="device" type="IHostUSBDevice" dir="return">
7154	<desc>Found USB device object.</desc>
7155	</param>
7156	</method>
7157
7158	</interface>
7159
7160	<!--
7161	// ISystemProperties
7162	/////////////////////////////////////////////////////////////////////////
7163	-->
7164
7165	<interface
7166	name="ISystemProperties"
7167	extends="$unknown"
7168	uuid="9a949843-b237-46d4-8fcf-c83dcd9121ef"
7169	wsmap="managed"
7170	>
7171	<desc>
7172	The ISystemProperties interface represents global properties of the given
7173	VirtualBox installation.
7174
7175	These properties define limits and default values for various attributes
7176	and parameters. Most of the properties are read-only, but some can be
7177	changed by a user.
7178	</desc>
7179
7180	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7181	<desc>Minimum guest system memory in Megabytes.</desc>
7182	</attribute>
7183
7184	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7185	<desc>Maximum guest system memory in Megabytes.</desc>
7186	</attribute>
7187
7188	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7189	<desc>Minimum guest video memory in Megabytes.</desc>
7190	</attribute>
7191
7192	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7193	<desc>Maximum guest video memory in Megabytes.</desc>
7194	</attribute>
7195
7196	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7197	<desc>Minimum CPU count.</desc>
7198	</attribute>
7199
7200	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7201	<desc>Maximum CPU count.</desc>
7202	</attribute>
7203
7204	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7205	<desc>Maximum of monitors which could be connected.</desc>
7206	</attribute>
7207
7208	<attribute name="infoVDSize" type="long long" readonly="yes">
7209	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7210	does not reflect the limits of any virtual disk image format.</desc>
7211	</attribute>
7212
7213	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7214	<desc>
7215	Number of network adapters associated with every
7216	<link to="IMachine"/> instance.
7217	</desc>
7218	</attribute>
7219
7220	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7221	<desc>
7222	Number of serial ports associated with every
7223	<link to="IMachine"/> instance.
7224	</desc>
7225	</attribute>
7226
7227	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7228	<desc>
7229	Number of parallel ports associated with every
7230	<link to="IMachine"/> instance.
7231	</desc>
7232	</attribute>
7233
7234	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7235	<desc>
7236	Maximum device position in the boot order. This value corresponds
7237	to the total number of devices a machine can boot from, to make it
7238	possible to include all possible devices to the boot list.
7239	<see><link to="IMachine::setBootOrder"/></see>
7240	</desc>
7241	</attribute>
7242
7243	<attribute name="defaultMachineFolder" type="wstring">
7244	<desc>
7245	Full path to the default directory used to create new or open
7246	existing machines when a machine settings file name contains no
7247	path.
7248
7249	Starting with VirtualBox 4.0, by default, this attribute contains
7250	the full path of folder named "VirtualBox VMs" in the user's
7251	home directory, which depends on the host platform.
7252
7253	When setting this attribute, a full path must be specified.
7254	Setting this property to @c null or an empty string or the
7255	special value "Machines" (for compatibility reasons) will restore
7256	that default value.
7257
7258	If the folder specified herein does not exist, it will be created
7259	automatically as needed.
7260
7261	<see>
7262	<link to="IVirtualBox::createMachine"/>,
7263	<link to="IVirtualBox::openMachine"/>
7264	</see>
7265	</desc>
7266	</attribute>
7267
7268	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7269	<desc>
7270	List of all medium storage formats supported by this VirtualBox
7271	installation.
7272
7273	Keep in mind that the medium format identifier
7274	(<link to="IMediumFormat::id"/>) used in other API calls like
7275	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7276	medium format is a case-insensitive string. This means that, for
7277	example, all of the following strings:
7278	<pre>
7279	"VDI"
7280	"vdi"
7281	"VdI"</pre>
7282	refer to the same medium format.
7283
7284	Note that the virtual medium framework is backend-based, therefore
7285	the list of supported formats depends on what backends are currently
7286	installed.
7287
7288	<see>
7289	<link to="IMediumFormat"/>,
7290	</see>
7291	</desc>
7292	</attribute>
7293
7294	<attribute name="defaultHardDiskFormat" type="wstring">
7295	<desc>
7296	Identifier of the default medium format used by VirtualBox.
7297
7298	The medium format set by this attribute is used by VirtualBox
7299	when the medium format was not specified explicitly. One example is
7300	<link to="IVirtualBox::createHardDisk"/> with the empty
7301	format argument. A more complex example is implicit creation of
7302	differencing media when taking a snapshot of a virtual machine:
7303	this operation will try to use a format of the parent medium first
7304	and if this format does not support differencing media the default
7305	format specified by this argument will be used.
7306
7307	The list of supported medium formats may be obtained by the
7308	<link to="#mediumFormats"/> call. Note that the default medium
7309	format must have a capability to create differencing media;
7310	otherwise operations that create media implicitly may fail
7311	unexpectedly.
7312
7313	The initial value of this property is <tt>"VDI"</tt> in the current
7314	version of the VirtualBox product, but may change in the future.
7315
7316	<note>
7317	Setting this property to @c null or empty string will restore the
7318	initial value.
7319	</note>
7320
7321	<see>
7322	<link to="#mediumFormats"/>,
7323	<link to="IMediumFormat::id"/>,
7324	<link to="IVirtualBox::createHardDisk"/>
7325	</see>
7326	</desc>
7327	</attribute>
7328
7329	<attribute name="freeDiskSpaceWarning" type="long long">
7330	<desc>Issue a warning if the free disk space is below (or in some disk
7331	intensive operation is expected to go below) the given size in
7332	bytes.</desc>
7333	</attribute>
7334
7335	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7336	<desc>Issue a warning if the free disk space is below (or in some disk
7337	intensive operation is expected to go below) the given percentage.</desc>
7338	</attribute>
7339
7340	<attribute name="freeDiskSpaceError" type="long long">
7341	<desc>Issue an error if the free disk space is below (or in some disk
7342	intensive operation is expected to go below) the given size in
7343	bytes.</desc>
7344	</attribute>
7345
7346	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7347	<desc>Issue an error if the free disk space is below (or in some disk
7348	intensive operation is expected to go below) the given percentage.</desc>
7349	</attribute>
7350
7351	<attribute name="VRDEAuthLibrary" type="wstring">
7352	<desc>
7353	Library that provides authentication for Remote Desktop clients. The library
7354	is used if a virtual machine's authentication type is set to "external"
7355	in the VM RemoteDisplay configuration.
7356
7357	The system library extension (".DLL" or ".so") must be omitted.
7358	A full path can be specified; if not, then the library must reside on the
7359	system's default library path.
7360
7361	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7362	of that name in one of the default VirtualBox library directories.
7363
7364	For details about VirtualBox authentication libraries and how to implement
7365	them, please refer to the VirtualBox manual.
7366
7367	<note>
7368	Setting this property to @c null or empty string will restore the
7369	initial value.
7370	</note>
7371	</desc>
7372	</attribute>
7373
7374	<attribute name="webServiceAuthLibrary" type="wstring">
7375	<desc>
7376	Library that provides authentication for webservice clients. The library
7377	is used if a virtual machine's authentication type is set to "external"
7378	in the VM RemoteDisplay configuration and will be called from
7379	within the <link to="IWebsessionManager::logon" /> implementation.
7380
7381	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7382	there is no per-VM setting for this, as the webservice is a global
7383	resource (if it is running). Only for this setting (for the webservice),
7384	setting this value to a literal <tt>"null"</tt> string disables authentication,
7385	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7386	no matter what user name and password are supplied.
7387
7388	The initial value of this property is <tt>"VRDPAuth"</tt>,
7389	meaning that the webservice will use the same authentication
7390	library that is used by default for VRDE (again, see
7391	<link to="ISystemProperties::VRDEAuthLibrary" />).
7392	The format and calling convention of authentication libraries
7393	is the same for the webservice as it is for VRDE.
7394
7395	<note>
7396	Setting this property to @c null or empty string will restore the
7397	initial value.
7398	</note>
7399	</desc>
7400	</attribute>
7401
7402	<attribute name="defaultVRDELibrary" type="wstring">
7403	<desc>
7404	Default VRDE library.
7405
7406	The default value of this property is an empty string, which means that the
7407	VRDE is not available.
7408
7409	For details about VirtualBox Remote Desktop Extension and how to implement
7410	it, please refer to the VirtualBox SDK.
7411	</desc>
7412	</attribute>
7413
7414	<attribute name="LogHistoryCount" type="unsigned long">
7415	<desc>
7416	This value specifies how many old release log files are kept.
7417	</desc>
7418	</attribute>
7419
7420	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7421	<desc>This value hold the default audio driver for the current
7422	system.</desc>
7423	</attribute>
7424
7425	<method name="getMaxDevicesPerPortForStorageBus">
7426	<desc>Returns the maximum number of devices which can be attached to a port
7427	for the given storage bus.</desc>
7428
7429	<param name="bus" type="StorageBus" dir="in">
7430	<desc>The storage bus type to get the value for.</desc>
7431	</param>
7432
7433	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7434	<desc>The maximum number of devices which can eb attached to the port for the given
7435	storage bus.</desc>
7436	</param>
7437	</method>
7438
7439	<method name="getMinPortCountForStorageBus">
7440	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7441
7442	<param name="bus" type="StorageBus" dir="in">
7443	<desc>The storage bus type to get the value for.</desc>
7444	</param>
7445
7446	<param name="minPortCount" type="unsigned long" dir="return">
7447	<desc>The minimum number of ports for the given storage bus.</desc>
7448	</param>
7449	</method>
7450
7451	<method name="getMaxPortCountForStorageBus">
7452	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7453
7454	<param name="bus" type="StorageBus" dir="in">
7455	<desc>The storage bus type to get the value for.</desc>
7456	</param>
7457
7458	<param name="maxPortCount" type="unsigned long" dir="return">
7459	<desc>The maximum number of ports for the given storage bus.</desc>
7460	</param>
7461	</method>
7462
7463	<method name="getMaxInstancesOfStorageBus">
7464	<desc>Returns the maximum number of storage bus instances which
7465	can be configured for each VM. This corresponds to the number of
7466	storage controllers one can have. Value may depend on chipset type
7467	used.</desc>
7468
7469	<param name="chipset" type="ChipsetType" dir="in">
7470	<desc>The chipset type to get the value for.</desc>
7471	</param>
7472
7473	<param name="bus" type="StorageBus" dir="in">
7474	<desc>The storage bus type to get the value for.</desc>
7475	</param>
7476
7477	<param name="maxInstances" type="unsigned long" dir="return">
7478	<desc>The maximum number of instances for the given storage bus.</desc>
7479	</param>
7480	</method>
7481
7482	<method name="getDeviceTypesForStorageBus">
7483	<desc>Returns list of all the supported device types
7484	(<link to="DeviceType"/>) for the given type of storage
7485	bus.</desc>
7486
7487	<param name="bus" type="StorageBus" dir="in">
7488	<desc>The storage bus type to get the value for.</desc>
7489	</param>
7490
7491	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7492	<desc>The list of all supported device types for the given storage bus.</desc>
7493	</param>
7494	</method>
7495
7496	<method name="getDefaultIoCacheSettingForStorageController">
7497	<desc>Returns the default I/O cache setting for the
7498	given storage controller</desc>
7499
7500	<param name="controllerType" type="StorageControllerType" dir="in">
7501	<desc>The storage controller to the setting for.</desc>
7502	</param>
7503
7504	<param name="enabled" type="boolean" dir="return">
7505	<desc>Returned flag indicating the default value</desc>
7506	</param>
7507	</method>
7508	</interface>
7509
7510	<!--
7511	// IGuest
7512	/////////////////////////////////////////////////////////////////////////
7513	-->
7514
7515	<interface
7516	name="IGuestOSType" extends="$unknown"
7517	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7518	wsmap="struct"
7519	>
7520	<desc>
7521	</desc>
7522
7523	<attribute name="familyId" type="wstring" readonly="yes">
7524	<desc>Guest OS family identifier string.</desc>
7525	</attribute>
7526
7527	<attribute name="familyDescription" type="wstring" readonly="yes">
7528	<desc>Human readable description of the guest OS family.</desc>
7529	</attribute>
7530
7531	<attribute name="id" type="wstring" readonly="yes">
7532	<desc>Guest OS identifier string.</desc>
7533	</attribute>
7534
7535	<attribute name="description" type="wstring" readonly="yes">
7536	<desc>Human readable description of the guest OS.</desc>
7537	</attribute>
7538
7539	<attribute name="is64Bit" type="boolean" readonly="yes">
7540	<desc>Returns @c true if the given OS is 64-bit</desc>
7541	</attribute>
7542
7543	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7544	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7545	</attribute>
7546
7547	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7548	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7549	</attribute>
7550
7551	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7552	<desc>Recommended RAM size in Megabytes.</desc>
7553	</attribute>
7554
7555	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7556	<desc>Recommended video RAM size in Megabytes.</desc>
7557	</attribute>
7558
7559	<attribute name="recommendedHDD" type="long long" readonly="yes">
7560	<desc>Recommended hard disk size in bytes.</desc>
7561	</attribute>
7562
7563	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7564	<desc>Returns recommended network adapter for this OS type.</desc>
7565	</attribute>
7566
7567	<attribute name="recommendedPae" type="boolean" readonly="yes">
7568	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7569	</attribute>
7570
7571	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7572	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7573	</attribute>
7574
7575	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7576	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7577	</attribute>
7578
7579	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7580	<desc>Recommended storage controller type for HD drives.</desc>
7581	</attribute>
7582
7583	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7584	<desc>Recommended storage bus type for HD drives.</desc>
7585	</attribute>
7586
7587	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7588	<desc>Recommended firmware type.</desc>
7589	</attribute>
7590
7591	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7592	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7593	</attribute>
7594
7595	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7596	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7597	</attribute>
7598
7599	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7600	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7601	</attribute>
7602
7603	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7604	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7605	</attribute>
7606
7607	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7608	<desc>Recommended chipset type.</desc>
7609	</attribute>
7610
7611	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7612	<desc>Recommended audio type.</desc>
7613	</attribute>
7614
7615	</interface>
7616
7617	<enum
7618	name="AdditionsRunLevelType"
7619	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7620	>
7621	<desc>
7622	Guest Additions run level type.
7623	</desc>
7624
7625	<const name="None" value="0">
7626	<desc>Guest Additions are not loaded.</desc>
7627	</const>
7628	<const name="System" value="1">
7629	<desc>Guest drivers are loaded.</desc>
7630	</const>
7631	<const name="Userland" value="2">
7632	<desc>Common components (such as application services) are loaded.</desc>
7633	</const>
7634	<const name="Desktop" value="3">
7635	<desc>Per-user desktop components are loaded.</desc>
7636	</const>
7637	</enum>
7638
7639	<enum
7640	name="ExecuteProcessFlag"
7641	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7642	>
7643	<desc>
7644	Guest process execution flags.
7645	</desc>
7646
7647	<const name="None" value="0">
7648	<desc>No flag set.</desc>
7649	</const>
7650
7651	<const name="WaitForProcessStartOnly" value="1">
7652	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7653	process itself then uses an infinite timeout.</desc>
7654	</const>
7655
7656	<const name="IgnoreOrphanedProcesses" value="2">
7657	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7658	</const>
7659	</enum>
7660
7661	<enum
7662	name="ProcessInputFlag"
7663	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7664	>
7665	<desc>
7666	Guest process input flags.
7667	</desc>
7668
7669	<const name="None" value="0">
7670	<desc>No flag set.</desc>
7671	</const>
7672	<const name="EndOfFile" value="1">
7673	<desc>End of file (input) reached.</desc>
7674	</const>
7675	</enum>
7676
7677	<enum
7678	name="CopyFileFlag"
7679	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7680	>
7681	<desc>
7682	Host/Guest copy flags.
7683	</desc>
7684
7685	<const name="None" value="0">
7686	<desc>No flag set.</desc>
7687	</const>
7688
7689	<const name="Recursive" value="1">
7690	<desc>Copy directories recursively.</desc>
7691	</const>
7692
7693	<const name="Update" value="2">
7694	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7695	</const>
7696
7697	<const name="FollowLinks" value="4">
7698	<desc>Follow symbolic links.</desc>
7699	</const>
7700	</enum>
7701
7702	<enum
7703	name="CreateDirectoryFlag"
7704	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7705	>
7706	<desc>
7707	Directory creation flags.
7708	</desc>
7709
7710	<const name="None" value="0">
7711	<desc>No flag set.</desc>
7712	</const>
7713
7714	<const name="Parents" value="1">
7715	<desc>No error if existing, make parent directories as needed.</desc>
7716	</const>
7717	</enum>
7718
7719	<interface
7720	name="IGuest" extends="$unknown"
7721	uuid="1039b0cc-9bc1-4c6d-8d12-864aa48aa5b9"
7722	wsmap="managed"
7723	>
7724	<desc>
7725	The IGuest interface represents information about the operating system
7726	running inside the virtual machine. Used in
7727	<link to="IConsole::guest"/>.
7728
7729	IGuest provides information about the guest operating system, whether
7730	Guest Additions are installed and other OS-specific virtual machine
7731	properties.
7732	</desc>
7733
7734	<attribute name="OSTypeId" type="wstring" readonly="yes">
7735	<desc>
7736	Identifier of the Guest OS type as reported by the Guest
7737	Additions.
7738	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7739	an IGuestOSType object representing details about the given
7740	Guest OS type.
7741	<note>
7742	If Guest Additions are not installed, this value will be
7743	the same as <link to="IMachine::OSTypeId"/>.
7744	</note>
7745	</desc>
7746	</attribute>
7747
7748	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7749	<desc>
7750	Current run level of the Guest Additions.
7751	</desc>
7752	</attribute>
7753
7754	<attribute name="additionsVersion" type="wstring" readonly="yes">
7755	<desc>
7756	Version of the Guest Additions including the revision (3 decimal numbers
7757	separated by dots + revision number) installed on the guest or empty
7758	when the Additions are not installed.
7759	</desc>
7760	</attribute>
7761
7762	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7763	<desc>
7764	Flag whether seamless guest display rendering (seamless desktop
7765	integration) is supported.
7766	</desc>
7767	</attribute>
7768
7769	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7770	<desc>
7771	Flag whether the guest is in graphics mode. If it is not, then
7772	seamless rendering will not work, resize hints are not immediately
7773	acted on and guest display resizes are probably not initiated by
7774	the guest additions.
7775	</desc>
7776	</attribute>
7777
7778	<attribute name="memoryBalloonSize" type="unsigned long">
7779	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7780	</attribute>
7781
7782	<attribute name="statisticsUpdateInterval" type="unsigned long">
7783	<desc>Interval to update guest statistics in seconds.</desc>
7784	</attribute>
7785
7786	<method name="internalGetStatistics">
7787	<desc>
7788	Internal method; do not use as it might change at any time
7789	</desc>
7790	<param name="cpuUser" type="unsigned long" dir="out">
7791	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7792	</param>
7793	<param name="cpuKernel" type="unsigned long" dir="out">
7794	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7795	</param>
7796	<param name="cpuIdle" type="unsigned long" dir="out">
7797	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7798	</param>
7799	<param name="memTotal" type="unsigned long" dir="out">
7800	<desc>Total amount of physical guest RAM</desc>
7801	</param>
7802	<param name="memFree" type="unsigned long" dir="out">
7803	<desc>Free amount of physical guest RAM</desc>
7804	</param>
7805	<param name="memBalloon" type="unsigned long" dir="out">
7806	<desc>Amount of ballooned physical guest RAM</desc>
7807	</param>
7808	<param name="memShared" type="unsigned long" dir="out">
7809	<desc>Amount of shared physical guest RAM</desc>
7810	</param>
7811	<param name="memCache" type="unsigned long" dir="out">
7812	<desc>Total amount of guest (disk) cache memory</desc>
7813	</param>
7814	<param name="pagedTotal" type="unsigned long" dir="out">
7815	<desc>Total amount of space in the page file</desc>
7816	</param>
7817	<param name="memAllocTotal" type="unsigned long" dir="out">
7818	<desc>Total amount of memory allocated by the hypervisor</desc>
7819	</param>
7820	<param name="memFreeTotal" type="unsigned long" dir="out">
7821	<desc>Total amount of free memory available in the hypervisor</desc>
7822	</param>
7823	<param name="memBalloonTotal" type="unsigned long" dir="out">
7824	<desc>Total amount of memory ballooned by the hypervisor</desc>
7825	</param>
7826	<param name="memSharedTotal" type="unsigned long" dir="out">
7827	<desc>Total amount of shared memory in the hypervisor</desc>
7828	</param>
7829	</method>
7830
7831	<method name="getAdditionsStatus">
7832	<desc>
7833	Retrieve the current status of a certain Guest Additions run level.
7834
7835	<result name="VBOX_E_NOT_SUPPORTED">
7836	Wrong status level specified.
7837	</result>
7838
7839	</desc>
7840	<param name="level" type="AdditionsRunLevelType" dir="in">
7841	<desc>Status level to check</desc>
7842	</param>
7843	<param name="active" type="boolean" dir="return">
7844	<desc>Flag whether the status level has been reached or not</desc>
7845	</param>
7846	</method>
7847
7848	<method name="setCredentials">
7849	<desc>
7850	Store login credentials that can be queried by guest operating
7851	systems with Additions installed. The credentials are transient
7852	to the session and the guest may also choose to erase them. Note
7853	that the caller cannot determine whether the guest operating system
7854	has queried or made use of the credentials.
7855
7856	<result name="VBOX_E_VM_ERROR">
7857	VMM device is not available.
7858	</result>
7859
7860	</desc>
7861	<param name="userName" type="wstring" dir="in">
7862	<desc>User name string, can be empty</desc>
7863	</param>
7864	<param name="password" type="wstring" dir="in">
7865	<desc>Password string, can be empty</desc>
7866	</param>
7867	<param name="domain" type="wstring" dir="in">
7868	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7869	</param>
7870	<param name="allowInteractiveLogon" type="boolean" dir="in">
7871	<desc>
7872	Flag whether the guest should alternatively allow the user to
7873	interactively specify different credentials. This flag might
7874	not be supported by all versions of the Additions.
7875	</desc>
7876	</param>
7877	</method>
7878
7879	<method name="executeProcess">
7880	<desc>
7881	Executes an existing program inside the guest VM.
7882
7883	<result name="VBOX_E_IPRT_ERROR">
7884	Could not execute process.
7885	</result>
7886
7887	</desc>
7888	<param name="execName" type="wstring" dir="in">
7889	<desc>
7890	Full path name of the command to execute on the guest; the
7891	commands has to exists in the guest VM in order to be executed.
7892	</desc>
7893	</param>
7894	<param name="flags" type="unsigned long" dir="in">
7895	<desc>
7896	Execution flags - currently not supported and therefore
7897	has to be set to 0.
7898	</desc>
7899	</param>
7900	<param name="arguments" type="wstring" safearray="yes" dir="in">
7901	<desc>
7902	Array of arguments passed to the execution command.
7903	</desc>
7904	</param>
7905	<param name="environment" type="wstring" safearray="yes" dir="in">
7906	<desc>
7907	Environment variables that can be set while the command is being
7908	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7909	variable just set its name ("NAME") without a value.
7910	</desc>
7911	</param>
7912	<param name="userName" type="wstring" dir="in">
7913	<desc>
7914	User name under which the command will be executed; has to exist
7915	and have the appropriate rights to execute programs in the VM.
7916	</desc>
7917	</param>
7918	<param name="password" type="wstring" dir="in">
7919	<desc>
7920	Password of the user account specified.
7921	</desc>
7922	</param>
7923	<param name="timeoutMS" type="unsigned long" dir="in">
7924	<desc>
7925	The maximum timeout value (in msec) to wait for finished program
7926	execution. Pass 0 for an infinite timeout.
7927	</desc>
7928	</param>
7929	<param name="pid" type="unsigned long" dir="out">
7930	<desc>
7931	The PID (process ID) of the started command for later reference.
7932	</desc>
7933	</param>
7934	<param name="progress" type="IProgress" dir="return">
7935	<desc>Progress object to track the operation completion.</desc>
7936	</param>
7937	</method>
7938
7939	<method name="getProcessOutput">
7940	<desc>
7941	Retrieves output of a formerly started process.
7942
7943	<result name="VBOX_E_IPRT_ERROR">
7944	Could not retrieve output.
7945	</result>
7946
7947	</desc>
7948	<param name="pid" type="unsigned long" dir="in">
7949	<desc>
7950	Process id returned by earlier executeProcess() call.
7951	</desc>
7952	</param>
7953	<param name="flags" type="unsigned long" dir="in">
7954	<desc>
7955	Flags describing which output to retrieve.
7956	</desc>
7957	</param>
7958	<param name="timeoutMS" type="unsigned long" dir="in">
7959	<desc>
7960	The maximum timeout value (in msec) to wait for output
7961	data. Pass 0 for an infinite timeout.
7962	</desc>
7963	</param>
7964	<param name="size" type="long long" dir="in">
7965	<desc>
7966	Size in bytes to read in the buffer.
7967	</desc>
7968	</param>
7969	<param name="data" type="octet" dir="return" safearray="yes">
7970	<desc>
7971	Buffer for retrieving the actual output. A data size of 0 means end of file
7972	if the requested size was not 0. This is the unprocessed
7973	output data, i.e. the line ending style depends on the platform of
7974	the system the server is running on.
7975	</desc>
7976	</param>
7977	</method>
7978
7979	<method name="getProcessStatus">
7980	<desc>
7981	Retrieves status, exit code and the exit reason of a formerly started process.
7982
7983	<result name="VBOX_E_IPRT_ERROR">
7984	Process with specified PID was not found.
7985	</result>
7986
7987	</desc>
7988	<param name="pid" type="unsigned long" dir="in">
7989	<desc>
7990	Process id returned by earlier executeProcess() call.
7991	</desc>
7992	</param>
7993	<param name="exitcode" type="unsigned long" dir="out">
7994	<desc>
7995	The exit code (if available).
7996	</desc>
7997	</param>
7998	<param name="flags" type="unsigned long" dir="out">
7999	<desc>
8000	Additional flags of process status. Not used at the moment and
8001	must be set to 0.
8002	</desc>
8003	</param>
8004	<param name="reason" type="unsigned long" dir="return">
8005	<desc>
8006	The current process status.
8007	</desc>
8008	</param>
8009	</method>
8010
8011	<method name="copyToGuest">
8012	<desc>
8013	Copies files/directories from host to the guest.
8014
8015	<result name="VBOX_E_IPRT_ERROR">
8016	Error while copying.
8017	</result>
8018
8019	</desc>
8020	<param name="source" type="wstring" dir="in">
8021	<desc>
8022	Source file on the host to copy.
8023	</desc>
8024	</param>
8025	<param name="dest" type="wstring" dir="in">
8026	<desc>
8027	Destination path on the guest.
8028	</desc>
8029	</param>
8030	<param name="userName" type="wstring" dir="in">
8031	<desc>
8032	User name under which the copy command will be executed; the
8033	user has to exist and have the appropriate rights to write to
8034	the destination path.
8035	</desc>
8036	</param>
8037	<param name="password" type="wstring" dir="in">
8038	<desc>
8039	Password of the user account specified.
8040	</desc>
8041	</param>
8042	<param name="flags" type="unsigned long" dir="in">
8043	<desc>
8044	Copy flags.
8045	</desc>
8046	</param>
8047	<param name="progress" type="IProgress" dir="return">
8048	<desc>Progress object to track the operation completion.</desc>
8049	</param>
8050	</method>
8051
8052	<method name="createDirectory">
8053	<desc>
8054	Creates a directory on the guest.
8055
8056	<result name="VBOX_E_IPRT_ERROR">
8057	Error while creating directory.
8058	</result>
8059
8060	</desc>
8061	<param name="directory" type="wstring" dir="in">
8062	<desc>
8063	Directory to create.
8064	</desc>
8065	</param>
8066	<param name="userName" type="wstring" dir="in">
8067	<desc>
8068	User name under which the directory creation will be executed; the
8069	user has to exist and have the appropriate rights to create the
8070	desired directory.
8071	</desc>
8072	</param>
8073	<param name="password" type="wstring" dir="in">
8074	<desc>
8075	Password of the user account specified.
8076	</desc>
8077	</param>
8078	<param name="mode" type="unsigned long" dir="in">
8079	<desc>
8080	File mode.
8081	</desc>
8082	</param>
8083	<param name="flags" type="unsigned long" dir="in">
8084	<desc>
8085	Additional flags. Not used at the moment and must be set to 0.
8086	</desc>
8087	</param>
8088	<param name="progress" type="IProgress" dir="return">
8089	<desc>Progress object to track the operation completion.</desc>
8090	</param>
8091	</method>
8092
8093	<method name="setProcessInput">
8094	<desc>
8095	Sends input into a formerly started process.
8096
8097	<result name="VBOX_E_IPRT_ERROR">
8098	Could not send input.
8099	</result>
8100
8101	</desc>
8102	<param name="pid" type="unsigned long" dir="in">
8103	<desc>
8104	Process id returned by earlier executeProcess() call.
8105	</desc>
8106	</param>
8107	<param name="flags" type="unsigned long" dir="in">
8108	<desc>
8109	Not used, must be set to zero.
8110	</desc>
8111	</param>
8112	<param name="data" type="octet" dir="in" safearray="yes">
8113	<desc>
8114	Buffer of input data to send to the started process to.
8115	</desc>
8116	</param>
8117	<param name="written" type="unsigned long" dir="return">
8118	<desc>
8119	Number of bytes written.
8120	</desc>
8121	</param>
8122	</method>
8123
8124	<method name="updateGuestAdditions">
8125	<desc>
8126	Updates already installed Guest Additions in a VM
8127	(Windows guests only).
8128
8129	<result name="VBOX_E_IPRT_ERROR">
8130	Error while updating.
8131	</result>
8132
8133	</desc>
8134	<param name="source" type="wstring" dir="in">
8135	<desc>
8136	Path to the Guest Additions .ISO file to use for the upate.
8137	</desc>
8138	</param>
8139	<param name="flags" type="unsigned long" dir="in">
8140	<desc>
8141	Additional flags for update process. Not used at the moment and
8142	must be set to 0.
8143	</desc>
8144	</param>
8145	<param name="progress" type="IProgress" dir="return">
8146	<desc>Progress object to track the operation completion.</desc>
8147	</param>
8148	</method>
8149
8150	</interface>
8151
8152
8153	<!--
8154	// IProgress
8155	/////////////////////////////////////////////////////////////////////////
8156	-->
8157
8158	<interface
8159	name="IProgress" extends="$unknown"
8160	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8161	wsmap="managed"
8162	>
8163	<desc>
8164	The IProgress interface is used to track and control
8165	asynchronous tasks within VirtualBox.
8166
8167	An instance of this is returned every time VirtualBox starts
8168	an asynchronous task (in other words, a separate thread) which
8169	continues to run after a method call returns. For example,
8170	<link to="IConsole::saveState" />, which saves the state of
8171	a running virtual machine, can take a long time to complete.
8172	To be able to display a progress bar, a user interface such as
8173	the VirtualBox graphical user interface can use the IProgress
8174	object returned by that method.
8175
8176	Note that IProgress is a "read-only" interface in the sense
8177	that only the VirtualBox internals behind the Main API can
8178	create and manipulate progress objects, whereas client code
8179	can only use the IProgress object to monitor a task's
8180	progress and, if <link to="#cancelable" /> is @c true,
8181	cancel the task by calling <link to="#cancel" />.
8182
8183	A task represented by IProgress consists of either one or
8184	several sub-operations that run sequentially, one by one (see
8185	<link to="#operation" /> and <link to="#operationCount" />).
8186	Every operation is identified by a number (starting from 0)
8187	and has a separate description.
8188
8189	You can find the individual percentage of completion of the current
8190	operation in <link to="#operationPercent" /> and the
8191	percentage of completion of the task as a whole
8192	in <link to="#percent" />.
8193
8194	Similarly, you can wait for the completion of a particular
8195	operation via <link to="#waitForOperationCompletion" /> or
8196	for the completion of the whole task via
8197	<link to="#waitForCompletion" />.
8198	</desc>
8199
8200	<attribute name="id" type="uuid" mod="string" readonly="yes">
8201	<desc>ID of the task.</desc>
8202	</attribute>
8203
8204	<attribute name="description" type="wstring" readonly="yes">
8205	<desc>Description of the task.</desc>
8206	</attribute>
8207
8208	<attribute name="initiator" type="$unknown" readonly="yes">
8209	<desc>Initiator of the task.</desc>
8210	</attribute>
8211
8212	<attribute name="cancelable" type="boolean" readonly="yes">
8213	<desc>Whether the task can be interrupted.</desc>
8214	</attribute>
8215
8216	<attribute name="percent" type="unsigned long" readonly="yes">
8217	<desc>
8218	Current progress value of the task as a whole, in percent.
8219	This value depends on how many operations are already complete.
8220	Returns 100 if <link to="#completed" /> is @c true.
8221	</desc>
8222	</attribute>
8223
8224	<attribute name="timeRemaining" type="long" readonly="yes">
8225	<desc>
8226	Estimated remaining time until the task completes, in
8227	seconds. Returns 0 once the task has completed; returns -1
8228	if the remaining time cannot be computed, in particular if
8229	the current progress is 0.
8230
8231	Even if a value is returned, the estimate will be unreliable
8232	for low progress values. It will become more reliable as the
8233	task progresses; it is not recommended to display an ETA
8234	before at least 20% of a task have completed.
8235	</desc>
8236	</attribute>
8237
8238	<attribute name="completed" type="boolean" readonly="yes">
8239	<desc>Whether the task has been completed.</desc>
8240	</attribute>
8241
8242	<attribute name="canceled" type="boolean" readonly="yes">
8243	<desc>Whether the task has been canceled.</desc>
8244	</attribute>
8245
8246	<attribute name="resultCode" type="long" readonly="yes">
8247	<desc>
8248	Result code of the progress task.
8249	Valid only if <link to="#completed"/> is @c true.
8250	</desc>
8251	</attribute>
8252
8253	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8254	<desc>
8255	Extended information about the unsuccessful result of the
8256	progress operation. May be @c null if no extended information
8257	is available.
8258	Valid only if <link to="#completed"/> is @c true and
8259	<link to="#resultCode"/> indicates a failure.
8260	</desc>
8261	</attribute>
8262
8263	<attribute name="operationCount" type="unsigned long" readonly="yes">
8264	<desc>
8265	Number of sub-operations this task is divided into.
8266	Every task consists of at least one suboperation.
8267	</desc>
8268	</attribute>
8269
8270	<attribute name="operation" type="unsigned long" readonly="yes">
8271	<desc>Number of the sub-operation being currently executed.</desc>
8272	</attribute>
8273
8274	<attribute name="operationDescription" type="wstring" readonly="yes">
8275	<desc>
8276	Description of the sub-operation being currently executed.
8277	</desc>
8278	</attribute>
8279
8280	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8281	<desc>Progress value of the current sub-operation only, in percent.</desc>
8282	</attribute>
8283
8284	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8285	<desc>Weight value of the current sub-operation only.</desc>
8286	</attribute>
8287
8288	<attribute name="timeout" type="unsigned long">
8289	<desc>
8290	When non-zero, this specifies the number of milliseconds after which
8291	the operation will automatically be canceled. This can only be set on
8292	cancelable objects.
8293	</desc>
8294	</attribute>
8295
8296	<method name="setCurrentOperationProgress">
8297	<desc>Internal method, not to be called externally.</desc>
8298	<param name="percent" type="unsigned long" dir="in" />
8299	</method>
8300	<method name="setNextOperation">
8301	<desc>Internal method, not to be called externally.</desc>
8302	<param name="nextOperationDescription" type="wstring" dir="in" />
8303	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8304	</method>
8305
8306	<method name="waitForCompletion">
8307	<desc>
8308	Waits until the task is done (including all sub-operations)
8309	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8310
8311	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8312	thread are not processed while waiting. Neglecting event queues may
8313	have dire consequences (degrade performance, resource hogs,
8314	deadlocks, etc.), this is specially so for the main thread on
8315	platforms using XPCOM. Callers are adviced wait for short periods
8316	and service their event queues between calls, or to create a worker
8317	thread to do the waiting.
8318
8319	<result name="VBOX_E_IPRT_ERROR">
8320	Failed to wait for task completion.
8321	</result>
8322	</desc>
8323
8324	<param name="timeout" type="long" dir="in">
8325	<desc>
8326	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8327	</desc>
8328	</param>
8329	</method>
8330
8331	<method name="waitForOperationCompletion">
8332	<desc>
8333	Waits until the given operation is done with a given timeout in
8334	milliseconds; specify -1 for an indefinite wait.
8335
8336	See <link to="#waitForCompletion"> for event queue considerations.</link>
8337
8338	<result name="VBOX_E_IPRT_ERROR">
8339	Failed to wait for operation completion.
8340	</result>
8341
8342	</desc>
8343	<param name="operation" type="unsigned long" dir="in">
8344	<desc>
8345	Number of the operation to wait for.
8346	Must be less than <link to="#operationCount"/>.
8347	</desc>
8348	</param>
8349	<param name="timeout" type="long" dir="in">
8350	<desc>
8351	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8352	</desc>
8353	</param>
8354	</method>
8355
8356	<method name="cancel">
8357	<desc>
8358	Cancels the task.
8359	<note>
8360	If <link to="#cancelable"/> is @c false, then this method will fail.
8361	</note>
8362
8363	<result name="VBOX_E_INVALID_OBJECT_STATE">
8364	Operation cannot be canceled.
8365	</result>
8366
8367	</desc>
8368	</method>
8369
8370	</interface>
8371
8372	<!--
8373	// ISnapshot
8374	/////////////////////////////////////////////////////////////////////////
8375	-->
8376
8377	<interface
8378	name="ISnapshot" extends="$unknown"
8379	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8380	wsmap="managed"
8381	>
8382	<desc>
8383	The ISnapshot interface represents a snapshot of the virtual
8384	machine.
8385
8386	Together with the differencing media that are created
8387	when a snapshot is taken, a machine can be brought back to
8388	the exact state it was in when the snapshot was taken.
8389
8390	The ISnapshot interface has no methods, only attributes; snapshots
8391	are controlled through methods of the <link to="IConsole" /> interface
8392	which also manage the media associated with the snapshot.
8393	The following operations exist:
8394
8395	<ul>
8396	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8397	by creating new, empty differencing images for the machine's
8398	media and saving the VM settings and (if the VM is running)
8399	the current VM state in the snapshot.
8400
8401	The differencing images will then receive all data written to
8402	the machine's media, while their parent (base) images
8403	remain unmodified after the snapshot has been taken (see
8404	<link to="IMedium" /> for details about differencing images).
8405	This simplifies restoring a machine to the state of a snapshot:
8406	only the differencing images need to be deleted.
8407
8408	The current machine state is not changed by taking a snapshot.
8409	If the machine is running, it will resume execution after the
8410	snapshot has been taken. After calling this,
8411	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8412	just created.
8413	</li>
8414
8415	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8416	the state of a previous snapshot by deleting the differencing
8417	image of each of the machine's media and setting the machine's
8418	settings and state to the state that was saved in the snapshot (if any).
8419
8420	This destroys the machine's current state. After calling this,
8421	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8422	restored.
8423	</li>
8424
8425	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8426	without affecting the current machine state.
8427
8428	This does not change the current machine state, but instead frees the
8429	resources allocated when the snapshot was taken: the settings and machine
8430	state file are deleted (if any), and the snapshot's differencing image for
8431	each of the machine's media gets merged with its parent image.
8432
8433	Neither the current machine state nor other snapshots are affected
8434	by this operation, except that parent media will be modified
8435	to contain the disk data associated with the snapshot being deleted.
8436
8437	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8438	attribute is set to the current snapshot's parent or NULL if it
8439	has no parent. Otherwise the attribute is unchanged.
8440	</li>
8441	</ul>
8442
8443	Each snapshot contains the settings of the virtual machine (hardware
8444	configuration etc.). In addition, if the machine was running when the
8445	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8446	the current VM state is saved in the snapshot (similarly to what happens
8447	when a VM's state is saved). The snapshot is then said to
8448	be <i>online</i> because when restoring it, the VM will be running.
8449
8450	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8451	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8452
8453	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8454	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8455	it then contains a so-called "zero execution state", representing a
8456	machine that is powered off.
8457	</desc>
8458
8459	<attribute name="id" type="uuid" mod="string" readonly="yes">
8460	<desc>UUID of the snapshot.</desc>
8461	</attribute>
8462
8463	<attribute name="name" type="wstring">
8464	<desc>Short name of the snapshot.</desc>
8465	</attribute>
8466
8467	<attribute name="description" type="wstring">
8468	<desc>Optional description of the snapshot.</desc>
8469	</attribute>
8470
8471	<attribute name="timeStamp" type="long long" readonly="yes">
8472	<desc>
8473	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8474	</desc>
8475	</attribute>
8476
8477	<attribute name="online" type="boolean" readonly="yes">
8478	<desc>
8479	@c true if this snapshot is an online snapshot and @c false otherwise.
8480
8481	When this attribute is @c true, the
8482	<link to="IMachine::stateFilePath"/> attribute of the
8483	<link to="#machine"/> object associated with this snapshot
8484	will point to the saved state file. Otherwise, it will be
8485	an empty string.
8486	</desc>
8487	</attribute>
8488
8489	<attribute name="machine" type="IMachine" readonly="yes">
8490	<desc>
8491	Virtual machine this snapshot is taken on. This object
8492	stores all settings the machine had when taking this snapshot.
8493	<note>
8494	The returned machine object is immutable, i.e. no
8495	any settings can be changed.
8496	</note>
8497	</desc>
8498	</attribute>
8499
8500	<attribute name="parent" type="ISnapshot" readonly="yes">
8501	<desc>
8502	Parent snapshot (a snapshot this one is based on), or
8503	@c null if the snapshot has no parent (i.e. is the first snapshot).
8504	</desc>
8505	</attribute>
8506
8507	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8508	<desc>
8509	Child snapshots (all snapshots having this one as a parent).
8510	</desc>
8511	</attribute>
8512
8513	</interface>
8514
8515
8516	<!--
8517	// IMedium
8518	/////////////////////////////////////////////////////////////////////////
8519	-->
8520
8521	<enum
8522	name="MediumState"
8523	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8524	>
8525	<desc>
8526	Virtual medium state.
8527	<see>IMedium</see>
8528	</desc>
8529
8530	<const name="NotCreated" value="0">
8531	<desc>
8532	Associated medium storage does not exist (either was not created yet or
8533	was deleted).
8534	</desc>
8535	</const>
8536	<const name="Created" value="1">
8537	<desc>
8538	Associated storage exists and accessible; this gets set if the
8539	accessibility check performed by <link to="IMedium::refreshState" />
8540	was successful.
8541	</desc>
8542	</const>
8543	<const name="LockedRead" value="2">
8544	<desc>
8545	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8546	no data modification is possible.
8547	</desc>
8548	</const>
8549	<const name="LockedWrite" value="3">
8550	<desc>
8551	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8552	no concurrent data reading or modification is possible.
8553	</desc>
8554	</const>
8555	<const name="Inaccessible" value="4">
8556	<desc>
8557	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8558	not yet been performed, or else, associated medium storage is not
8559	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8560	is empty, in the second case, it describes the error that occurred.
8561	</desc>
8562	</const>
8563	<const name="Creating" value="5">
8564	<desc>
8565	Associated medium storage is being created.
8566	</desc>
8567	</const>
8568	<const name="Deleting" value="6">
8569	<desc>
8570	Associated medium storage is being deleted.
8571	</desc>
8572	</const>
8573	</enum>
8574
8575	<enum
8576	name="MediumType"
8577	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8578	>
8579	<desc>
8580	Virtual medium type.
8581	<see>IMedium</see>
8582	</desc>
8583
8584	<const name="Normal" value="0">
8585	<desc>
8586	Normal medium (attached directly or indirectly, preserved
8587	when taking snapshots).
8588	</desc>
8589	</const>
8590	<const name="Immutable" value="1">
8591	<desc>
8592	Immutable medium (attached indirectly, changes are wiped out
8593	the next time the virtual machine is started).
8594	</desc>
8595	</const>
8596	<const name="Writethrough" value="2">
8597	<desc>
8598	Write through medium (attached directly, ignored when
8599	taking snapshots).
8600	</desc>
8601	</const>
8602	<const name="Shareable" value="3">
8603	<desc>
8604	Allow using this medium concurrently by several machines.
8605	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8606	</desc>
8607	</const>
8608	<const name="Readonly" value="4">
8609	<desc>
8610	A readonly medium, which can of course be used by several machines.
8611	<note>Present and accepted since VirtualBox 4.0.</note>
8612	</desc>
8613	</const>
8614	</enum>
8615
8616	<enum
8617	name="MediumVariant"
8618	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8619	>
8620	<desc>
8621	Virtual medium image variant. More than one flag may be set.
8622	<see>IMedium</see>
8623	</desc>
8624
8625	<const name="Standard" value="0">
8626	<desc>
8627	No particular variant requested, results in using the backend default.
8628	</desc>
8629	</const>
8630	<const name="VmdkSplit2G" value="0x01">
8631	<desc>
8632	VMDK image split in chunks of less than 2GByte.
8633	</desc>
8634	</const>
8635	<const name="VmdkStreamOptimized" value="0x04">
8636	<desc>
8637	VMDK streamOptimized image. Special import/export format which is
8638	read-only/append-only.
8639	</desc>
8640	</const>
8641	<const name="VmdkESX" value="0x08">
8642	<desc>
8643	VMDK format variant used on ESX products.
8644	</desc>
8645	</const>
8646	<const name="Fixed" value="0x10000">
8647	<desc>
8648	Fixed image. Only allowed for base images.
8649	</desc>
8650	</const>
8651	<const name="Diff" value="0x20000">
8652	<desc>
8653	Differencing image. Only allowed for child images.
8654	</desc>
8655	</const>
8656	</enum>
8657
8658	<interface
8659	name="IMediumAttachment" extends="$unknown"
8660	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8661	wsmap="struct"
8662	>
8663	<desc>
8664	The IMediumAttachment interface links storage media to virtual machines.
8665	For each medium (<link to="IMedium"/>) which has been attached to a
8666	storage controller (<link to="IStorageController"/>) of a machine
8667	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8668	method, one instance of IMediumAttachment is added to the machine's
8669	<link to="IMachine::mediumAttachments"/> array attribute.
8670
8671	Each medium attachment specifies the storage controller as well as a
8672	port and device number and the IMedium instance representing a virtual
8673	hard disk or floppy or DVD image.
8674
8675	For removeable media (DVDs or floppies), there are two additional
8676	options. For one, the IMedium instance can be @c null to represent
8677	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8678	secondly, the medium can be one of the pseudo-media for host drives
8679	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8680	</desc>
8681
8682	<attribute name="medium" type="IMedium" readonly="yes">
8683	<desc>Medium object associated with this attachment; it
8684	can be @c null for removable devices.</desc>
8685	</attribute>
8686
8687	<attribute name="controller" type="wstring" readonly="yes">
8688	<desc>Name of the storage controller of this attachment; this
8689	refers to one of the controllers in <link to="IMachine::storageControllers" />
8690	by name.</desc>
8691	</attribute>
8692
8693	<attribute name="port" type="long" readonly="yes">
8694	<desc>Port number of this attachment.
8695	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8696	</desc>
8697	</attribute>
8698
8699	<attribute name="device" type="long" readonly="yes">
8700	<desc>Device slot number of this attachment.
8701	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8702	</desc>
8703	</attribute>
8704
8705	<attribute name="type" type="DeviceType" readonly="yes">
8706	<desc>Device type of this attachment.</desc>
8707	</attribute>
8708
8709	<attribute name="passthrough" type="boolean" readonly="yes">
8710	<desc>Pass I/O requests through to a device on the host.</desc>
8711	</attribute>
8712
8713	<attribute name="bandwidthLimit" type="unsigned long">
8714	<desc>
8715	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8716	A zero value means uncapped/unlimited.
8717	</desc>
8718	</attribute>
8719
8720	</interface>
8721
8722	<interface
8723	name="IMedium" extends="$unknown"
8724	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8725	wsmap="managed"
8726	>
8727	<desc>
8728	The IMedium interface represents virtual storage for a machine's
8729	hard disks, CD/DVD or floppy drives. It will typically represent
8730	a disk image on the host, for example a VDI or VMDK file representing
8731	a virtual hard disk, or an ISO or RAW file representing virtual
8732	removable media, but can also point to a network location (e.g.
8733	for iSCSI targets).
8734
8735	Instances of IMedium are connected to virtual machines by way of
8736	medium attachments (see <link to="IMediumAttachment" />), which link
8737	the storage medium to a particular device slot of a storage controller
8738	of the virtual machine.
8739	In the VirtualBox API, virtual storage is therefore always represented
8740	by the following chain of object links:
8741
8742	<ul>
8743	<li><link to="IMachine::storageControllers"/> contains an array of
8744	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8745	these are instances of <link to="IStorageController"/>).</li>
8746	<li><link to="IMachine::mediumAttachments"/> contains an array of
8747	medium attachments (instances of <link to="IMediumAttachment"/>),
8748	each containing a storage controller from the above array, a
8749	port/device specification, and an instance of IMedium representing
8750	the medium storage (image file).
8751
8752	For removable media, the storage medium is optional; a medium
8753	attachment with no medium represents a CD/DVD or floppy drive
8754	with no medium inserted. By contrast, hard disk attachments
8755	will always have an IMedium object attached.</li>
8756	<li>Each IMedium in turn points to a storage unit (such as a file
8757	on the host computer or a network resource) that holds actual
8758	data. This location is represented by the <link to="#location"/>
8759	attribute.</li>
8760	</ul>
8761
8762	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8763	new hard disk media can be created with the VirtualBox API using the
8764	<link to="IVirtualBox::createHardDisk"/> method.
8765
8766	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8767	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8768	type in a regular file.
8769
8770	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8771	drive; in that case the <link to="#id" /> attribute contains the UUID of
8772	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8773
8774	<h3>Known media</h3>
8775
8776	When an existing medium is opened and attached to a virtual machine, it
8777	is automatically added to a media registry. If the medium has first
8778	been attached to a machine which was created by VirtualBox 4.0 or later,
8779	it is added to that machine's media registry (in the machine XML settings
8780	file; this way all information about a machine's media attachments is
8781	contained in a single file). For older media attachments (i.e. if the
8782	medium was first attached to a machine which was created with a VirtualBox
8783	version before 4.0), media continue to be registered in the global
8784	VirtualBox settings file, for backwards compatibility.
8785
8786	See <link to="IVirtualBox::openMedium" /> for more information.
8787
8788	All known media can be enumerated using
8789	<link to="IVirtualBox::hardDisks"/>,
8790	<link to="IVirtualBox::DVDImages"/> and
8791	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8792	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8793
8794	Only known media can be attached to virtual machines.
8795
8796	Removing known media from the media registry is performed when the given
8797	medium is closed using the <link to="#close"/> method or when its
8798	associated storage unit is deleted.
8799
8800	<h3>Accessibility checks</h3>
8801
8802	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8803	method is called explicitly on a medium. This is done to make the VirtualBox object
8804	ready for serving requests as fast as possible and let the end-user
8805	application decide if it needs to check media accessibility right away or not.
8806
8807	As a result, when VirtualBox starts up (e.g. the VirtualBox
8808	object gets created for the first time), all known media are in the
8809	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8810	attribute is an empty string because no actual accessibility check has
8811	been made yet.
8812
8813	After calling <link to="#refreshState" />, a medium is considered
8814	<i>accessible</i> if its storage unit can be read. In that case, the
8815	<link to="#state"/> attribute has a value of "Created". If the storage
8816	unit cannot be read (for example, because it is located on a disconnected
8817	network resource, or was accidentally deleted outside VirtualBox),
8818	the medium is considered <i>inaccessible</i>, which is indicated by the
8819	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8820	obtained by reading the <link to="#lastAccessError"/> attribute.
8821
8822	<h3>Medium types</h3>
8823
8824	There are four types of medium behavior (see <link to="MediumType" />):
8825	"normal", "immutable", "writethrough" and "shareable", represented by the
8826	<link to="#type"/> attribute. The type of the medium defines how the
8827	medium is attached to a virtual machine and what happens when a
8828	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8829	attached medium is taken. At the moment DVD and floppy media are always
8830	of type "writethrough".
8831
8832	All media can be also divided in two groups: <i>base</i> media and
8833	<i>differencing</i> media. A base medium contains all sectors of the
8834	medium data in its own storage and therefore can be used independently.
8835	In contrast, a differencing medium is a "delta" to some other medium and
8836	contains only those sectors which differ from that other medium, which is
8837	then called a <i>parent</i>. The differencing medium is said to be
8838	<i>linked to</i> that parent. The parent may be itself a differencing
8839	medium, thus forming a chain of linked media. The last element in that
8840	chain must always be a base medium. Note that several differencing
8841	media may be linked to the same parent medium.
8842
8843	Differencing media can be distinguished from base media by querying the
8844	<link to="#parent"/> attribute: base media do not have parents they would
8845	depend on, so the value of this attribute is always @c null for them.
8846	Using this attribute, it is possible to walk up the medium tree (from the
8847	child medium to its parent). It is also possible to walk down the tree
8848	using the <link to="#children"/> attribute.
8849
8850	Note that the type of all differencing media is "normal"; all other
8851	values are meaningless for them. Base media may be of any type.
8852
8853	<h3>Creating hard disks</h3>
8854
8855	New base hard disks are created using
8856	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8857	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8858	disks are usually implicitly created by VirtualBox when needed but may
8859	also be created explicitly using <link to="#createDiffStorage"/>.
8860
8861	After the hard disk is successfully created (including the storage unit)
8862	or opened, it becomes a known hard disk (remembered in the internal media
8863	registry). Known hard disks can be attached to a virtual machine, accessed
8864	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8865	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8866
8867	The following methods, besides <link to="IMedium::close"/>,
8868	automatically remove the hard disk from the media registry:
8869	<ul>
8870	<li><link to="#deleteStorage"/></li>
8871	<li><link to="#mergeTo"/></li>
8872	</ul>
8873
8874	If the storage unit of the hard disk is a regular file in the host's
8875	file system then the rules stated in the description of the
8876	<link to="IMedium::location"/> attribute apply when setting its value.
8877
8878	<h4>Automatic composition of the file name part</h4>
8879
8880	Another extension to the <link to="IMedium::location"/> attribute is that
8881	there is a possibility to cause VirtualBox to compose a unique value for
8882	the file name part of the location using the UUID of the hard disk. This
8883	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8884	e.g. before the storage unit is created, and works as follows. You set the
8885	value of the <link to="IMedium::location"/> attribute to a location
8886	specification which only contains the path specification but not the file
8887	name part and ends with either a forward slash or a backslash character.
8888	In response, VirtualBox will generate a new UUID for the hard disk and
8889	compose the file name using the following pattern:
8890	<pre>
8891	<path>/{<uuid>}.<ext>
8892	</pre>
8893	where <tt><path></tt> is the supplied path specification,
8894	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8895	is the default extension for the storage format of this hard disk. After
8896	that, you may call any of the methods that create a new hard disk storage
8897	unit and they will use the generated UUID and file name.
8898
8899	<h3>Attaching Hard Disks</h3>
8900
8901	Hard disks are attached to virtual machines using the
8902	<link to="IMachine::attachDevice"/> method and detached using the
8903	<link to="IMachine::detachDevice"/> method. Depending on their
8904	<link to="#type"/>, hard disks are attached either
8905	<i>directly</i> or <i>indirectly</i>.
8906
8907	When a hard disk is being attached directly, it is associated with the
8908	virtual machine and used for hard disk operations when the machine is
8909	running. When a hard disk is being attached indirectly, a new differencing
8910	hard disk linked to it is implicitly created and this differencing hard
8911	disk is associated with the machine and used for hard disk operations.
8912	This also means that if <link to="IMachine::attachDevice"/> performs
8913	a direct attachment then the same hard disk will be returned in response
8914	to the subsequent <link to="IMachine::getMedium"/> call; however if
8915	an indirect attachment is performed then
8916	<link to="IMachine::getMedium"/> will return the implicitly created
8917	differencing hard disk, not the original one passed to <link
8918	to="IMachine::attachDevice"/>. In detail:
8919
8920	<ul>
8921	<li><b>Normal base</b> hard disks that do not have children (i.e.
8922	differencing hard disks linked to them) and that are not already
8923	attached to virtual machines in snapshots are attached <b>directly</b>.
8924	Otherwise, they are attached <b>indirectly</b> because having
8925	dependent children or being part of the snapshot makes it impossible
8926	to modify hard disk contents without breaking the integrity of the
8927	dependent party. The <link to="#readOnly"/> attribute allows to
8928	quickly determine the kind of the attachment for the given hard
8929	disk. Note that if a normal base hard disk is to be indirectly
8930	attached to a virtual machine with snapshots then a special
8931	procedure called <i>smart attachment</i> is performed (see below).</li>
8932	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8933	they are attached <b>directly</b> if they do not have children and are
8934	not attached to virtual machines in snapshots, and <b>indirectly</b>
8935	otherwise. Note that the smart attachment procedure is never performed
8936	for differencing hard disks.</li>
8937	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8938	they are designed to be non-writable. If an immutable hard disk is
8939	attached to a virtual machine with snapshots then a special
8940	procedure called smart attachment is performed (see below).</li>
8941	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8942	also as designed. This also means that writethrough hard disks cannot
8943	have other hard disks linked to them at all.</li>
8944	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8945	also as designed. This also means that shareable hard disks cannot
8946	have other hard disks linked to them at all. They behave almost
8947	like writethrough hard disks, except that shareable hard disks can
8948	be attached to several virtual machines which are running, allowing
8949	concurrent accesses. You need special cluster software running in
8950	the virtual machines to make use of such disks.</li>
8951	</ul>
8952
8953	Note that the same hard disk, regardless of its type, may be attached to
8954	more than one virtual machine at a time. In this case, the machine that is
8955	started first gains exclusive access to the hard disk and attempts to
8956	start other machines having this hard disk attached will fail until the
8957	first machine is powered down.
8958
8959	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8960	that the given hard disk remains associated with the given machine after a
8961	successful <link to="IMachine::detachDevice"/> call until
8962	<link to="IMachine::saveSettings"/> is called to save all changes to
8963	machine settings to disk. This deferring is necessary to guarantee that
8964	the hard disk configuration may be restored at any time by a call to
8965	<link to="IMachine::discardSettings"/> before the settings
8966	are saved (committed).
8967
8968	Note that if <link to="IMachine::discardSettings"/> is called after
8969	indirectly attaching some hard disks to the machine but before a call to
8970	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8971	all differencing hard disks implicitly created by
8972	<link to="IMachine::attachDevice"/> for these indirect attachments.
8973	Such implicitly created hard disks will also be immediately deleted when
8974	detached explicitly using the <link to="IMachine::detachDevice"/>
8975	call if it is made before <link to="IMachine::saveSettings"/>. This
8976	implicit deletion is safe because newly created differencing hard
8977	disks do not contain any user data.
8978
8979	However, keep in mind that detaching differencing hard disks that were
8980	implicitly created by <link to="IMachine::attachDevice"/>
8981	before the last <link to="IMachine::saveSettings"/> call will
8982	<b>not</b> implicitly delete them as they may already contain some data
8983	(for example, as a result of virtual machine execution). If these hard
8984	disks are no more necessary, the caller can always delete them explicitly
8985	using <link to="#deleteStorage"/> after they are actually de-associated
8986	from this machine by the <link to="IMachine::saveSettings"/> call.
8987
8988	<h3>Smart Attachment</h3>
8989
8990	When normal base or immutable hard disks are indirectly attached to a
8991	virtual machine then some additional steps are performed to make sure the
8992	virtual machine will have the most recent "view" of the hard disk being
8993	attached. These steps include walking through the machine's snapshots
8994	starting from the current one and going through ancestors up to the first
8995	snapshot. Hard disks attached to the virtual machine in all
8996	of the encountered snapshots are checked whether they are descendants of
8997	the given normal base or immutable hard disk. The first found child (which
8998	is the differencing hard disk) will be used instead of the normal base or
8999	immutable hard disk as a parent for creating a new differencing hard disk
9000	that will be actually attached to the machine. And only if no descendants
9001	are found or if the virtual machine does not have any snapshots then the
9002	normal base or immutable hard disk will be used itself as a parent for
9003	this differencing hard disk.
9004
9005	It is easier to explain what smart attachment does using the
9006	following example:
9007	<pre>
9008	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9009
9010	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9011	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9012	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9013	Snapshot 4 (none) Snapshot 4 (none)
9014	CurState (none) CurState (D3->D2.vdi)
9015
9016	NOT
9017	...
9018	CurState (D3->B.vdi)
9019	</pre>
9020	The first column is the virtual machine configuration before the base hard
9021	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9022	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9023	mean that the hard disk that is actually attached to the machine is a
9024	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9025	another hard disk, <tt>B.vdi</tt>.
9026
9027	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9028	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9029	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9030	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9031	it cannot be attached directly and needs an indirect attachment (i.e.
9032	implicit creation of a new differencing hard disk). Due to the smart
9033	attachment procedure, the new differencing hard disk
9034	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9035	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9036	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9037	machine.
9038
9039	Note that if there is more than one descendant hard disk of the given base
9040	hard disk found in a snapshot, and there is an exact device, channel and
9041	bus match, then this exact match will be used. Otherwise, the youngest
9042	descendant will be picked up.
9043
9044	There is one more important aspect of the smart attachment procedure which
9045	is not related to snapshots at all. Before walking through the snapshots
9046	as described above, the backup copy of the current list of hard disk
9047	attachment is searched for descendants. This backup copy is created when
9048	the hard disk configuration is changed for the first time after the last
9049	<link to="IMachine::saveSettings"/> call and used by
9050	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9051	changes. When such a descendant is found in this backup copy, it will be
9052	simply re-attached back, without creating a new differencing hard disk for
9053	it. This optimization is necessary to make it possible to re-attach the
9054	base or immutable hard disk to a different bus, channel or device slot
9055	without losing the contents of the differencing hard disk actually
9056	attached to the machine in place of it.
9057	</desc>
9058
9059	<attribute name="id" type="uuid" mod="string" readonly="yes">
9060	<desc>
9061	UUID of the medium. For a newly created medium, this value is a randomly
9062	generated UUID.
9063
9064	<note>
9065	For media in one of MediumState_NotCreated, MediumState_Creating or
9066	MediumState_Deleting states, the value of this property is undefined
9067	and will most likely be an empty UUID.
9068	</note>
9069	</desc>
9070	</attribute>
9071
9072	<attribute name="description" type="wstring">
9073	<desc>
9074	Optional description of the medium. For a newly created medium the value
9075	of this attribute is an empty string.
9076
9077	Medium types that don't support this attribute will return E_NOTIMPL in
9078	attempt to get or set this attribute's value.
9079
9080	<note>
9081	For some storage types, reading this attribute may return an outdated
9082	(last known) value when <link to="#state"/> is <link
9083	to="MediumState_Inaccessible"/> or <link
9084	to="MediumState_LockedWrite"/> because the value of this attribute is
9085	stored within the storage unit itself. Also note that changing the
9086	attribute value is not possible in such case, as well as when the
9087	medium is the <link to="MediumState_LockedRead"/> state.
9088	</note>
9089	</desc>
9090	</attribute>
9091
9092	<attribute name="state" type="MediumState" readonly="yes">
9093	<desc>
9094	Returns the current medium state, which is the last state set by
9095	the accessibility check performed by <link to="#refreshState"/>.
9096	If that method has not yet been called on the medium, the state
9097	is "Inaccessible"; as opposed to truly inaccessible media, the
9098	value of <link to="#lastAccessError"/> will be an empty string in
9099	that case.
9100
9101	<note>As of version 3.1, this no longer performs an accessibility check
9102	automatically; call <link to="#refreshState"/> for that.
9103	</note>
9104	</desc>
9105	</attribute>
9106
9107	<attribute name="variant" type="MediumVariant" readonly="yes">
9108	<desc>
9109	Returns the storage format variant information for this medium.
9110	Before <link to="#refreshState"/> is called this method returns
9111	an undefined value.
9112	</desc>
9113	</attribute>
9114
9115	<attribute name="location" type="wstring">
9116	<desc>
9117	Location of the storage unit holding medium data.
9118
9119	The format of the location string is medium type specific. For medium
9120	types using regular files in a host's file system, the location
9121	string is the full file name.
9122
9123	Some medium types may support changing the storage unit location by
9124	simply changing the value of this property. If this operation is not
9125	supported, the implementation will return E_NOTIMPL in attempt to set
9126	this attribute's value.
9127
9128	When setting a value of the location attribute which is a regular file
9129	in the host's file system, the given file name may be either relative to
9130	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9131	absolute. Note that if the given location specification does not contain
9132	the file extension part then a proper default extension will be
9133	automatically appended by the implementation depending on the medium type.
9134	</desc>
9135	</attribute>
9136
9137	<attribute name="name" type="wstring" readonly="yes">
9138	<desc>
9139	Name of the storage unit holding medium data.
9140
9141	The returned string is a short version of the <link to="#location"/>
9142	attribute that is suitable for representing the medium in situations
9143	where the full location specification is too long (such as lists
9144	and comboboxes in GUI frontends). This string is also used by frontends
9145	to sort the media list alphabetically when needed.
9146
9147	For example, for locations that are regular files in the host's file
9148	system, the value of this attribute is just the file name (+ extension),
9149	without the path specification.
9150
9151	Note that as opposed to the <link to="#location"/> attribute, the name
9152	attribute will not necessary be unique for a list of media of the
9153	given type and format.
9154	</desc>
9155	</attribute>
9156
9157	<attribute name="deviceType" type="DeviceType" readonly="yes">
9158	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9159	medium.</desc>
9160	</attribute>
9161
9162	<attribute name="hostDrive" type="boolean" readonly="yes">
9163	<desc>True if this corresponds to a drive on the host.</desc>
9164	</attribute>
9165
9166	<attribute name="size" type="long long" readonly="yes">
9167	<desc>
9168	Physical size of the storage unit used to hold medium data (in bytes).
9169
9170	<note>
9171	For media whose <link to="#state"/> is <link
9172	to="MediumState_Inaccessible"/>, the value of this property is the
9173	last known size. For <link to="MediumState_NotCreated"/> media,
9174	the returned value is zero.
9175	</note>
9176	</desc>
9177	</attribute>
9178
9179	<attribute name="format" type="wstring" readonly="yes">
9180	<desc>
9181	Storage format of this medium.
9182
9183	The value of this attribute is a string that specifies a backend used
9184	to store medium data. The storage format is defined when you create a
9185	new medium or automatically detected when you open an existing medium,
9186	and cannot be changed later.
9187
9188	The list of all storage formats supported by this VirtualBox
9189	installation can be obtained using
9190	<link to="ISystemProperties::mediumFormats"/>.
9191	</desc>
9192	</attribute>
9193
9194	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9195	<desc>
9196	Storage medium format object corresponding to this medium.
9197
9198	The value of this attribute is a reference to the medium format object
9199	that specifies the backend properties used to store medium data. The
9200	storage format is defined when you create a new medium or automatically
9201	detected when you open an existing medium, and cannot be changed later.
9202
9203	<note>@c null is returned if there is no associated medium format
9204	object. This can e.g. happen for medium objects representing host
9205	drives and other special medium objects.</note>
9206	</desc>
9207	</attribute>
9208
9209	<attribute name="type" type="MediumType">
9210	<desc>
9211	Type (role) of this medium.
9212
9213	The following constraints apply when changing the value of this
9214	attribute:
9215	<ul>
9216	<li>If a medium is attached to a virtual machine (either in the
9217	current state or in one of the snapshots), its type cannot be
9218	changed.
9219	</li>
9220	<li>As long as the medium has children, its type cannot be set
9221	to <link to="MediumType_Writethrough"/>.
9222	</li>
9223	<li>The type of all differencing media is
9224	<link to="MediumType_Normal"/> and cannot be changed.
9225	</li>
9226	</ul>
9227
9228	The type of a newly created or opened medium is set to
9229	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9230	which have a type of <link to="MediumType_Writethrough"/>.
9231	</desc>
9232	</attribute>
9233
9234	<attribute name="parent" type="IMedium" readonly="yes">
9235	<desc>
9236	Parent of this medium (the medium this medium is directly based
9237	on).
9238
9239	Only differencing media have parents. For base (non-differencing)
9240	media, @c null is returned.
9241	</desc>
9242	</attribute>
9243
9244	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9245	<desc>
9246	Children of this medium (all differencing media directly based
9247	on this medium). A @c null array is returned if this medium
9248	does not have any children.
9249	</desc>
9250	</attribute>
9251
9252	<attribute name="base" type="IMedium" readonly="yes">
9253	<desc>
9254	Base medium of this medium.
9255
9256	If this is a differencing medium, its base medium is the medium
9257	the given medium branch starts from. For all other types of media, this
9258	property returns the medium object itself (i.e. the same object this
9259	property is read on).
9260	</desc>
9261	</attribute>
9262
9263	<attribute name="readOnly" type="boolean" readonly="yes">
9264	<desc>
9265	Returns @c true if this medium is read-only and @c false otherwise.
9266
9267	A medium is considered to be read-only when its contents cannot be
9268	modified without breaking the integrity of other parties that depend on
9269	this medium such as its child media or snapshots of virtual machines
9270	where this medium is attached to these machines. If there are no
9271	children and no such snapshots then there is no dependency and the
9272	medium is not read-only.
9273
9274	The value of this attribute can be used to determine the kind of the
9275	attachment that will take place when attaching this medium to a
9276	virtual machine. If the value is @c false then the medium will
9277	be attached directly. If the value is @c true then the medium
9278	will be attached indirectly by creating a new differencing child
9279	medium for that. See the interface description for more information.
9280
9281	Note that all <link to="MediumType_Immutable">Immutable</link> media
9282	are always read-only while all
9283	<link to="MediumType_Writethrough">Writethrough</link> media are
9284	always not.
9285
9286	<note>
9287	The read-only condition represented by this attribute is related to
9288	the medium type and usage, not to the current
9289	<link to="IMedium::state">medium state</link> and not to the read-only
9290	state of the storage unit.
9291	</note>
9292	</desc>
9293	</attribute>
9294
9295	<attribute name="logicalSize" type="long long" readonly="yes">
9296	<desc>
9297	Logical size of this medium (in bytes), as reported to the
9298	guest OS running inside the virtual machine this medium is
9299	attached to. The logical size is defined when the medium is created
9300	and cannot be changed later.
9301
9302	<note>
9303	Reading this property on a differencing medium will return the size
9304	of its <link to="#base"/> medium.
9305	</note>
9306	<note>
9307	For media whose state is <link to="#state"/> is <link
9308	to="MediumState_Inaccessible"/>, the value of this property is the
9309	last known logical size. For <link to="MediumState_NotCreated"/>
9310	media, the returned value is zero.
9311	</note>
9312	</desc>
9313	</attribute>
9314
9315	<attribute name="autoReset" type="boolean">
9316	<desc>
9317	Whether this differencing medium will be automatically reset each
9318	time a virtual machine it is attached to is powered up. This
9319	attribute is automatically set to @c true for the last
9320	differencing image of an "immutable" medium (see
9321	<link to="MediumType" />).
9322
9323	See <link to="#reset"/> for more information about resetting
9324	differencing media.
9325
9326	<note>
9327	Reading this property on a base (non-differencing) medium will
9328	always @c false. Changing the value of this property in this
9329	case is not supported.
9330	</note>
9331
9332	<result name="VBOX_E_NOT_SUPPORTED">
9333	This is not a differencing medium (when changing the attribute
9334	value).
9335	</result>
9336	</desc>
9337	</attribute>
9338
9339	<attribute name="lastAccessError" type="wstring" readonly="yes">
9340	<desc>
9341	Text message that represents the result of the last accessibility
9342	check performed by <link to="#refreshState"/>.
9343
9344	An empty string is returned if the last accessibility check
9345	was successful or has not yet been called. As a result, if
9346	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9347	then <link to="#refreshState"/> has yet to be called; this is the
9348	default value of media after VirtualBox initialization.
9349	A non-empty string indicates a failure and should normally describe
9350	a reason of the failure (for example, a file read error).
9351	</desc>
9352	</attribute>
9353
9354	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9355	<desc>
9356	Array of UUIDs of all machines this medium is attached to.
9357
9358	A @c null array is returned if this medium is not attached to any
9359	machine or to any machine's snapshot.
9360
9361	<note>
9362	The returned array will include a machine even if this medium is not
9363	attached to that machine in the current state but attached to it in
9364	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9365	details.
9366	</note>
9367	</desc>
9368	</attribute>
9369
9370	<method name="setIDs">
9371	<desc>
9372	Changes the UUID and parent UUID for a hard disk medium.
9373	</desc>
9374	<param name="setImageId" type="boolean" dir="in">
9375	<desc>
9376	Select whether a new image UUID is set or not.
9377	</desc>
9378	</param>
9379	<param name="imageId" type="uuid" mod="string" dir="in">
9380	<desc>
9381	New UUID for the image. If an empty string is passed, then a new
9382	UUID is automatically created, provided that @a setImageId is @c true.
9383	Specifying a zero UUID is not allowed.
9384	</desc>
9385	</param>
9386	<param name="setParentId" type="boolean" dir="in">
9387	<desc>
9388	Select whether a new parent UUID is set or not.
9389	</desc>
9390	</param>
9391	<param name="parentId" type="uuid" mod="string" dir="in">
9392	<desc>
9393	New parent UUID for the image. If an empty string is passed, then a
9394	new UUID is automatically created, provided @a setParentId is
9395	@c true. A zero UUID is valid.
9396	</desc>
9397	</param>
9398	<result name="E_INVALIDARG">
9399	Invalid parameter combination.
9400	</result>
9401	<result name="VBOX_E_NOT_SUPPORTED">
9402	Medium is not a hard disk medium.
9403	</result>
9404	</method>
9405
9406	<method name="refreshState">
9407	<desc>
9408	If the current medium state (see <link to="MediumState"/>) is one of
9409	"Created", "Inaccessible" or "LockedRead", then this performs an
9410	accessibility check on the medium and sets the value of the <link to="#state"/>
9411	attribute accordingly; that value is also returned for convenience.
9412
9413	For all other state values, this does not perform a refresh but returns
9414	the state only.
9415
9416	The refresh, if performed, may take a long time (several seconds or even
9417	minutes, depending on the storage unit location and format) because it performs an
9418	accessibility check of the storage unit. This check may cause a significant
9419	delay if the storage unit of the given medium is, for example, a file located
9420	on a network share which is not currently accessible due to connectivity
9421	problems. In that case, the call will not return until a timeout
9422	interval defined by the host OS for this operation expires. For this reason,
9423	it is recommended to never read this attribute on the main UI thread to avoid
9424	making the UI unresponsive.
9425
9426	If the last known state of the medium is "Created" and the accessibility
9427	check fails, then the state would be set to "Inaccessible", and
9428	<link to="#lastAccessError"/> may be used to get more details about the
9429	failure. If the state of the medium is "LockedRead", then it remains the
9430	same, and a non-empty value of <link to="#lastAccessError"/> will
9431	indicate a failed accessibility check in this case.
9432
9433	Note that not all medium states are applicable to all medium types.
9434	</desc>
9435	<param name="state" type="MediumState" dir="return">
9436	<desc>
9437	New medium state.
9438	</desc>
9439	</param>
9440	</method>
9441
9442	<method name="getSnapshotIds">
9443	<desc>
9444	Returns an array of UUIDs of all snapshots of the given machine where
9445	this medium is attached to.
9446
9447	If the medium is attached to the machine in the current state, then the
9448	first element in the array will always be the ID of the queried machine
9449	(i.e. the value equal to the @c machineId argument), followed by
9450	snapshot IDs (if any).
9451
9452	If the medium is not attached to the machine in the current state, then
9453	the array will contain only snapshot IDs.
9454
9455	The returned array may be @c null if this medium is not attached
9456	to the given machine at all, neither in the current state nor in one of
9457	the snapshots.
9458	</desc>
9459	<param name="machineId" type="uuid" mod="string" dir="in">
9460	<desc>
9461	UUID of the machine to query.
9462	</desc>
9463	</param>
9464	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9465	<desc>
9466	Array of snapshot UUIDs of the given machine using this medium.
9467	</desc>
9468	</param>
9469	</method>
9470
9471	<method name="lockRead">
9472	<desc>
9473	Locks this medium for reading.
9474
9475	A read lock is shared: many clients can simultaneously lock the
9476	same medium for reading unless it is already locked for writing (see
9477	<link to="#lockWrite"/>) in which case an error is returned.
9478
9479	When the medium is locked for reading, it cannot be modified
9480	from within VirtualBox. This means that any method that changes
9481	the properties of this medium or contents of the storage unit
9482	will return an error (unless explicitly stated otherwise). That
9483	includes an attempt to start a virtual machine that wants to
9484	write to the the medium.
9485
9486	When the virtual machine is started up, it locks for reading all
9487	media it uses in read-only mode. If some medium cannot be locked
9488	for reading, the startup procedure will fail.
9489	A medium is typically locked for reading while it is used by a running
9490	virtual machine but has a depending differencing image that receives
9491	the actual write operations. This way one base medium can have
9492	multiple child differencing images which can be written to
9493	simultaneously. Read-only media such as DVD and floppy images are
9494	also locked for reading only (so they can be in use by multiple
9495	machines simultaneously).
9496
9497	A medium is also locked for reading when it is the source of a
9498	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9499
9500	The medium locked for reading must be unlocked using the <link
9501	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9502	can be nested and must be followed by the same number of paired
9503	<link to="#unlockRead"/> calls.
9504
9505	This method sets the medium state (see <link to="#state"/>) to
9506	"LockedRead" on success. The medium's previous state must be
9507	one of "Created", "Inaccessible" or "LockedRead".
9508
9509	Locking an inaccessible medium is not an error; this method performs
9510	a logical lock that prevents modifications of this medium through
9511	the VirtualBox API, not a physical file-system lock of the underlying
9512	storage unit.
9513
9514	This method returns the current state of the medium
9515	<i>before</i> the operation.
9516
9517	<result name="VBOX_E_INVALID_OBJECT_STATE">
9518	Invalid medium state (e.g. not created, locked, inaccessible,
9519	creating, deleting).
9520	</result>
9521
9522	</desc>
9523	<param name="state" type="MediumState" dir="return">
9524	<desc>
9525	State of the medium after the operation.
9526	</desc>
9527	</param>
9528	</method>
9529
9530	<method name="unlockRead">
9531	<desc>
9532	Cancels the read lock previously set by <link to="#lockRead"/>.
9533
9534	For both success and failure, this method returns the current state
9535	of the medium <i>after</i> the operation.
9536
9537	See <link to="#lockRead"/> for more details.
9538
9539	<result name="VBOX_E_INVALID_OBJECT_STATE">
9540	Medium not locked for reading.
9541	</result>
9542
9543	</desc>
9544	<param name="state" type="MediumState" dir="return">
9545	<desc>
9546	State of the medium after the operation.
9547	</desc>
9548	</param>
9549	</method>
9550
9551	<method name="lockWrite">
9552	<desc>
9553	Locks this medium for writing.
9554
9555	A write lock, as opposed to <link to="#lockRead"/>, is
9556	exclusive: there may be only one client holding a write lock,
9557	and there may be no read locks while the write lock is held.
9558	As a result, read-locking fails if a write lock is held, and
9559	write-locking fails if either a read or another write lock is held.
9560
9561	When a medium is locked for writing, it cannot be modified
9562	from within VirtualBox, and it is not guaranteed that the values
9563	of its properties are up-to-date. Any method that changes the
9564	properties of this medium or contents of the storage unit will
9565	return an error (unless explicitly stated otherwise).
9566
9567	When a virtual machine is started up, it locks for writing all
9568	media it uses to write data to. If any medium could not be locked
9569	for writing, the startup procedure will fail. If a medium has
9570	differencing images, then while the machine is running, only
9571	the last ("leaf") differencing image is locked for writing,
9572	whereas its parents are locked for reading only.
9573
9574	A medium is also locked for writing when it is the target of a
9575	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9576
9577	The medium locked for writing must be unlocked using the <link
9578	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9579
9580	This method sets the medium state (see <link to="#state"/>) to
9581	"LockedWrite" on success. The medium's previous state must be
9582	either "Created" or "Inaccessible".
9583
9584	Locking an inaccessible medium is not an error; this method performs
9585	a logical lock that prevents modifications of this medium through
9586	the VirtualBox API, not a physical file-system lock of the underlying
9587	storage unit.
9588
9589	For both, success and failure, this method returns the current
9590	state of the medium <i>before</i> the operation.
9591
9592	<result name="VBOX_E_INVALID_OBJECT_STATE">
9593	Invalid medium state (e.g. not created, locked, inaccessible,
9594	creating, deleting).
9595	</result>
9596
9597	</desc>
9598	<param name="state" type="MediumState" dir="return">
9599	<desc>
9600	State of the medium after the operation.
9601	</desc>
9602	</param>
9603	</method>
9604
9605	<method name="unlockWrite">
9606	<desc>
9607	Cancels the write lock previously set by <link to="#lockWrite"/>.
9608
9609	For both success and failure, this method returns the current
9610	state of the medium <i>after</i> the operation.
9611
9612	See <link to="#lockWrite"/> for more details.
9613
9614	<result name="VBOX_E_INVALID_OBJECT_STATE">
9615	Medium not locked for writing.
9616	</result>
9617
9618	</desc>
9619	<param name="state" type="MediumState" dir="return">
9620	<desc>
9621	State of the medium after the operation.
9622	</desc>
9623	</param>
9624	</method>
9625
9626	<method name="close">
9627	<desc>
9628	Closes this medium.
9629
9630	The medium must not be attached to any known virtual machine
9631	and must not have any known child media, otherwise the
9632	operation will fail.
9633
9634	When the medium is successfully closed, it is removed from
9635	the list of registered media, but its storage unit is not
9636	deleted. In particular, this means that this medium can
9637	later be opened again using the <link to="IVirtualBox::openMedium"/>
9638	call.
9639
9640	Note that after this method successfully returns, the given medium
9641	object becomes uninitialized. This means that any attempt
9642	to call any of its methods or attributes will fail with the
9643	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9644
9645	<result name="VBOX_E_INVALID_OBJECT_STATE">
9646	Invalid medium state (other than not created, created or
9647	inaccessible).
9648	</result>
9649	<result name="VBOX_E_OBJECT_IN_USE">
9650	Medium attached to virtual machine.
9651	</result>
9652	<result name="VBOX_E_FILE_ERROR">
9653	Settings file not accessible.
9654	</result>
9655	<result name="VBOX_E_XML_ERROR">
9656	Could not parse the settings file.
9657	</result>
9658
9659	</desc>
9660	</method>
9661
9662	<!-- storage methods -->
9663
9664	<method name="getProperty">
9665	<desc>
9666	Returns the value of the custom medium property with the given name.
9667
9668	The list of all properties supported by the given medium format can
9669	be obtained with <link to="IMediumFormat::describeProperties"/>.
9670
9671	Note that if this method returns an empty string in @a value, the
9672	requested property is supported but currently not assigned any value.
9673
9674	<result name="VBOX_E_OBJECT_NOT_FOUND">
9675	Requested property does not exist (not supported by the format).
9676	</result>
9677	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9678	</desc>
9679	<param name="name" type="wstring" dir="in">
9680	<desc>Name of the property to get.</desc>
9681	</param>
9682	<param name="value" type="wstring" dir="return">
9683	<desc>Current property value.</desc>
9684	</param>
9685	</method>
9686
9687	<method name="setProperty">
9688	<desc>
9689	Sets the value of the custom medium property with the given name.
9690
9691	The list of all properties supported by the given medium format can
9692	be obtained with <link to="IMediumFormat::describeProperties"/>.
9693
9694	Note that setting the property value to @c null or an empty string is
9695	equivalent to deleting the existing value. A default value (if it is
9696	defined for this property) will be used by the format backend in this
9697	case.
9698
9699	<result name="VBOX_E_OBJECT_NOT_FOUND">
9700	Requested property does not exist (not supported by the format).
9701	</result>
9702	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9703	</desc>
9704	<param name="name" type="wstring" dir="in">
9705	<desc>Name of the property to set.</desc>
9706	</param>
9707	<param name="value" type="wstring" dir="in">
9708	<desc>Property value to set.</desc>
9709	</param>
9710	</method>
9711
9712	<method name="getProperties">
9713	<desc>
9714	Returns values for a group of properties in one call.
9715
9716	The names of the properties to get are specified using the @a names
9717	argument which is a list of comma-separated property names or
9718	an empty string if all properties are to be returned. Note that currently
9719	the value of this argument is ignored and the method always returns all
9720	existing properties.
9721
9722	The list of all properties supported by the given medium format can
9723	be obtained with <link to="IMediumFormat::describeProperties"/>.
9724
9725	The method returns two arrays, the array of property names corresponding
9726	to the @a names argument and the current values of these properties.
9727	Both arrays have the same number of elements with each elemend at the
9728	given index in the first array corresponds to an element at the same
9729	index in the second array.
9730
9731	Note that for properties that do not have assigned values,
9732	an empty string is returned at the appropriate index in the
9733	@a returnValues array.
9734
9735	</desc>
9736	<param name="names" type="wstring" dir="in">
9737	<desc>
9738	Names of properties to get.
9739	</desc>
9740	</param>
9741	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9742	<desc>Names of returned properties.</desc>
9743	</param>
9744	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9745	<desc>Values of returned properties.</desc>
9746	</param>
9747	</method>
9748
9749	<method name="setProperties">
9750	<desc>
9751	Sets values for a group of properties in one call.
9752
9753	The names of the properties to set are passed in the @a names
9754	array along with the new values for them in the @a values array. Both
9755	arrays have the same number of elements with each elemend at the given
9756	index in the first array corresponding to an element at the same index
9757	in the second array.
9758
9759	If there is at least one property name in @a names that is not valid,
9760	the method will fail before changing the values of any other properties
9761	from the @a names array.
9762
9763	Using this method over <link to="#setProperty"/> is preferred if you
9764	need to set several properties at once since it will result into less
9765	IPC calls.
9766
9767	The list of all properties supported by the given medium format can
9768	be obtained with <link to="IMediumFormat::describeProperties"/>.
9769
9770	Note that setting the property value to @c null or an empty string is
9771	equivalent to deleting the existing value. A default value (if it is
9772	defined for this property) will be used by the format backend in this
9773	case.
9774	</desc>
9775	<param name="names" type="wstring" safearray="yes" dir="in">
9776	<desc>Names of properties to set.</desc>
9777	</param>
9778	<param name="values" type="wstring" safearray="yes" dir="in">
9779	<desc>Values of properties to set.</desc>
9780	</param>
9781	</method>
9782
9783	<!-- storage methods -->
9784
9785	<method name="createBaseStorage">
9786	<desc>
9787	Starts creating a hard disk storage unit (fixed/dynamic, according
9788	to the variant flags) in in the background. The previous storage unit
9789	created for this object, if any, must first be deleted using
9790	<link to="#deleteStorage"/>, otherwise the operation will fail.
9791
9792	Before the operation starts, the medium is placed in
9793	<link to="MediumState_Creating"/> state. If the create operation
9794	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9795	state.
9796
9797	After the returned progress object reports that the operation has
9798	successfully completed, the medium state will be set to <link
9799	to="MediumState_Created"/>, the medium will be remembered by this
9800	VirtualBox installation and may be attached to virtual machines.
9801
9802	<result name="VBOX_E_NOT_SUPPORTED">
9803	The variant of storage creation operation is not supported. See <link
9804	to="IMediumFormat::capabilities"/>.
9805	</result>
9806	</desc>
9807	<param name="logicalSize" type="long long" dir="in">
9808	<desc>Maximum logical size of the medium in bytes.</desc>
9809	</param>
9810	<param name="variant" type="MediumVariant" dir="in">
9811	<desc>Exact image variant which should be created.</desc>
9812	</param>
9813	<param name="progress" type="IProgress" dir="return">
9814	<desc>Progress object to track the operation completion.</desc>
9815	</param>
9816	</method>
9817
9818	<method name="deleteStorage">
9819	<desc>
9820	Starts deleting the storage unit of this medium.
9821
9822	The medium must not be attached to any known virtual machine and must
9823	not have any known child media, otherwise the operation will fail.
9824	It will also fail if there is no storage unit to delete or if deletion
9825	is already in progress, or if the medium is being in use (locked for
9826	read or for write) or inaccessible. Therefore, the only valid state for
9827	this operation to succeed is <link to="MediumState_Created"/>.
9828
9829	Before the operation starts, the medium is placed in
9830	<link to="MediumState_Deleting"/> state and gets removed from the list
9831	of remembered hard disks (media registry). If the delete operation
9832	fails, the medium will be remembered again and placed back to
9833	<link to="MediumState_Created"/> state.
9834
9835	After the returned progress object reports that the operation is
9836	complete, the medium state will be set to
9837	<link to="MediumState_NotCreated"/> and you will be able to use one of
9838	the storage creation methods to create it again.
9839
9840	<see>#close()</see>
9841
9842	<result name="VBOX_E_OBJECT_IN_USE">
9843	Medium is attached to a virtual machine.
9844	</result>
9845	<result name="VBOX_E_NOT_SUPPORTED">
9846	Storage deletion is not allowed because neither of storage creation
9847	operations are supported. See
9848	<link to="IMediumFormat::capabilities"/>.
9849	</result>
9850
9851	<note>
9852	If the deletion operation fails, it is not guaranteed that the storage
9853	unit still exists. You may check the <link to="IMedium::state"/> value
9854	to answer this question.
9855	</note>
9856	</desc>
9857	<param name="progress" type="IProgress" dir="return">
9858	<desc>Progress object to track the operation completion.</desc>
9859	</param>
9860	</method>
9861
9862	<!-- diff methods -->
9863
9864	<method name="createDiffStorage">
9865	<desc>
9866	Starts creating an empty differencing storage unit based on this
9867	medium in the format and at the location defined by the @a target
9868	argument.
9869
9870	The target medium must be in <link to="MediumState_NotCreated"/>
9871	state (i.e. must not have an existing storage unit). Upon successful
9872	completion, this operation will set the type of the target medium to
9873	<link to="MediumType_Normal"/> and create a storage unit necessary to
9874	represent the differencing medium data in the given format (according
9875	to the storage format of the target object).
9876
9877	After the returned progress object reports that the operation is
9878	successfully complete, the target medium gets remembered by this
9879	VirtualBox installation and may be attached to virtual machines.
9880
9881	<note>
9882	The medium will be set to <link to="MediumState_LockedRead"/>
9883	state for the duration of this operation.
9884	</note>
9885	<result name="VBOX_E_OBJECT_IN_USE">
9886	Medium not in @c NotCreated state.
9887	</result>
9888	</desc>
9889	<param name="target" type="IMedium" dir="in">
9890	<desc>Target medium.</desc>
9891	</param>
9892	<param name="variant" type="MediumVariant" dir="in">
9893	<desc>Exact image variant which should be created.</desc>
9894	</param>
9895	<param name="progress" type="IProgress" dir="return">
9896	<desc>Progress object to track the operation completion.</desc>
9897	</param>
9898	</method>
9899
9900	<method name="mergeTo">
9901	<desc>
9902	Starts merging the contents of this medium and all intermediate
9903	differencing media in the chain to the given target medium.
9904
9905	The target medium must be either a descendant of this medium or
9906	its ancestor (otherwise this method will immediately return a failure).
9907	It follows that there are two logical directions of the merge operation:
9908	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9909	ancestor (<i>backward merge</i>). Let us consider the following medium
9910	chain:
9911
9912	<pre>Base <- Diff_1 <- Diff_2</pre>
9913
9914	Here, calling this method on the <tt>Base</tt> medium object with
9915	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9916	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9917	merge. Note that in both cases the contents of the resulting medium
9918	will be the same, the only difference is the medium object that takes
9919	the result of the merge operation. In case of the forward merge in the
9920	above example, the result will be written to <tt>Diff_2</tt>; in case of
9921	the backward merge, the result will be written to <tt>Base</tt>. In
9922	other words, the result of the operation is always stored in the target
9923	medium.
9924
9925	Upon successful operation completion, the storage units of all media in
9926	the chain between this (source) medium and the target medium, including
9927	the source medium itself, will be automatically deleted and the
9928	relevant medium objects (including this medium) will become
9929	uninitialized. This means that any attempt to call any of
9930	their methods or attributes will fail with the
9931	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9932	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9933	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9934	Note that <tt>Diff_2</tt> in this case will become a base medium
9935	itself since it will no longer be based on any other medium.
9936
9937	Considering the above, all of the following conditions must be met in
9938	order for the merge operation to succeed:
9939	<ul>
9940	<li>
9941	Neither this (source) medium nor any intermediate
9942	differencing medium in the chain between it and the target
9943	medium is attached to any virtual machine.
9944	</li>
9945	<li>
9946	Neither the source medium nor the target medium is an
9947	<link to="MediumType_Immutable"/> medium.
9948	</li>
9949	<li>
9950	The part of the medium tree from the source medium to the
9951	target medium is a linear chain, i.e. all medium in this
9952	chain have exactly one child which is the next medium in this
9953	chain. The only exception from this rule is the target medium in
9954	the forward merge operation; it is allowed to have any number of
9955	child media because the merge operation will not change its
9956	logical contents (as it is seen by the guest OS or by children).
9957	</li>
9958	<li>
9959	None of the involved media are in
9960	<link to="MediumState_LockedRead"/> or
9961	<link to="MediumState_LockedWrite"/> state.
9962	</li>
9963	</ul>
9964
9965	<note>
9966	This (source) medium and all intermediates will be placed to <link
9967	to="MediumState_Deleting"/> state and the target medium will be
9968	placed to <link to="MediumState_LockedWrite"/> state and for the
9969	duration of this operation.
9970	</note>
9971	</desc>
9972	<param name="target" type="IMedium" dir="in">
9973	<desc>Target medium.</desc>
9974	</param>
9975	<param name="progress" type="IProgress" dir="return">
9976	<desc>Progress object to track the operation completion.</desc>
9977	</param>
9978	</method>
9979
9980	<!-- clone method -->
9981
9982	<method name="cloneTo">
9983	<desc>
9984	Starts creating a clone of this medium in the format and at the
9985	location defined by the @a target argument.
9986
9987	The target medium must be either in <link to="MediumState_NotCreated"/>
9988	state (i.e. must not have an existing storage unit) or in
9989	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9990	big enough to hold the data or else the copy will be partial). Upon
9991	successful completion, the cloned medium will contain exactly the
9992	same sector data as the medium being cloned, except that in the
9993	first case a new UUID for the clone will be randomly generated, and in
9994	the second case the UUID will remain unchanged.
9995
9996	The @a parent argument defines which medium will be the parent
9997	of the clone. Passing a @c null reference indicates that the clone will
9998	be a base image, i.e. completely independent. It is possible to specify
9999	an arbitrary medium for this parameter, including the parent of the
10000	medium which is being cloned. Even cloning to a child of the source
10001	medium is possible. Note that when cloning to an existing image, the
10002	@a parent irgument is ignored.
10003
10004	After the returned progress object reports that the operation is
10005	successfully complete, the target medium gets remembered by this
10006	VirtualBox installation and may be attached to virtual machines.
10007
10008	<note>
10009	This medium will be placed to <link to="MediumState_LockedRead"/>
10010	state for the duration of this operation.
10011	</note>
10012	<result name="E_NOTIMPL">
10013	The specified cloning variant is not supported at the moment.
10014	</result>
10015	</desc>
10016	<param name="target" type="IMedium" dir="in">
10017	<desc>Target medium.</desc>
10018	</param>
10019	<param name="variant" type="MediumVariant" dir="in">
10020	<desc>Exact image variant which should be created.</desc>
10021	</param>
10022	<param name="parent" type="IMedium" dir="in">
10023	<desc>Parent of the cloned medium.</desc>
10024	</param>
10025	<param name="progress" type="IProgress" dir="return">
10026	<desc>Progress object to track the operation completion.</desc>
10027	</param>
10028	</method>
10029
10030	<!-- other methods -->
10031
10032	<method name="compact">
10033	<desc>
10034	Starts compacting of this medium. This means that the medium is
10035	transformed into a possibly more compact storage representation.
10036	This potentially creates temporary images, which can require a
10037	substantial amount of additional disk space.
10038
10039	This medium will be placed to <link to="MediumState_LockedWrite"/>
10040	state and all its parent media (if any) will be placed to
10041	<link to="MediumState_LockedRead"/> state for the duration of this
10042	operation.
10043
10044	Please note that the results can be either returned straight away,
10045	or later as the result of the background operation via the object
10046	returned via the @a progress parameter.
10047
10048	<result name="VBOX_E_NOT_SUPPORTED">
10049	Medium format does not support compacting (but potentially
10050	needs it).
10051	</result>
10052	</desc>
10053	<param name="progress" type="IProgress" dir="return">
10054	<desc>Progress object to track the operation completion.</desc>
10055	</param>
10056	</method>
10057
10058	<method name="resize">
10059	<desc>
10060	Starts resizing this medium. This means that the nominal size of the
10061	medium is set to the new value. Both increasing and decreasing the
10062	size is possible, and there are no safety checks, since VirtualBox
10063	does not make any assumptions about the medium contents.
10064
10065	Resizing usually needs additional disk space, and possibly also
10066	some temporary disk space. Note that resize does not create a full
10067	temporary copy of the medium, so the additional disk space requirement
10068	is usually much lower than using the clone operation.
10069
10070	This medium will be placed to <link to="MediumState_LockedWrite"/>
10071	state for the duration of this operation.
10072
10073	Please note that the results can be either returned straight away,
10074	or later as the result of the background operation via the object
10075	returned via the @a progress parameter.
10076
10077	<result name="VBOX_E_NOT_SUPPORTED">
10078	Medium format does not support resizing.
10079	</result>
10080	</desc>
10081	<param name="logicalSize" type="long long" dir="in">
10082	<desc>New nominal capacity of the medium in bytes.</desc>
10083	</param>
10084	<param name="progress" type="IProgress" dir="return">
10085	<desc>Progress object to track the operation completion.</desc>
10086	</param>
10087	</method>
10088
10089	<method name="reset">
10090	<desc>
10091	Starts erasing the contents of this differencing medium.
10092
10093	This operation will reset the differencing medium to its initial
10094	state when it does not contain any sector data and any read operation is
10095	redirected to its parent medium. This automatically gets called
10096	during VM power-up for every medium whose <link to="#autoReset" />
10097	attribute is @c true.
10098
10099	The medium will be write-locked for the duration of this operation (see
10100	<link to="#lockWrite" />).
10101
10102	<result name="VBOX_E_NOT_SUPPORTED">
10103	This is not a differencing medium.
10104	</result>
10105	<result name="VBOX_E_INVALID_OBJECT_STATE">
10106	Medium is not in <link to="MediumState_Created"/> or
10107	<link to="MediumState_Inaccessible"/> state.
10108	</result>
10109	</desc>
10110	<param name="progress" type="IProgress" dir="return">
10111	<desc>Progress object to track the operation completion.</desc>
10112	</param>
10113	</method>
10114
10115	</interface>
10116
10117
10118	<!--
10119	// IMediumFormat
10120	/////////////////////////////////////////////////////////////////////////
10121	-->
10122
10123	<enum
10124	name="DataType"
10125	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10126	>
10127	<const name="Int32" value="0"/>
10128	<const name="Int8" value="1"/>
10129	<const name="String" value="2"/>
10130	</enum>
10131
10132	<enum
10133	name="DataFlags"
10134	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10135	>
10136	<const name="None" value="0x00"/>
10137	<const name="Mandatory" value="0x01"/>
10138	<const name="Expert" value="0x02"/>
10139	<const name="Array" value="0x04"/>
10140	<const name="FlagMask" value="0x07"/>
10141	</enum>
10142
10143	<enum
10144	name="MediumFormatCapabilities"
10145	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10146	>
10147	<desc>
10148	Medium format capability flags.
10149	</desc>
10150
10151	<const name="Uuid" value="0x01">
10152	<desc>
10153	Supports UUIDs as expected by VirtualBox code.
10154	</desc>
10155	</const>
10156
10157	<const name="CreateFixed" value="0x02">
10158	<desc>
10159	Supports creating fixed size images, allocating all space instantly.
10160	</desc>
10161	</const>
10162
10163	<const name="CreateDynamic" value="0x04">
10164	<desc>
10165	Supports creating dynamically growing images, allocating space on
10166	demand.
10167	</desc>
10168	</const>
10169
10170	<const name="CreateSplit2G" value="0x08">
10171	<desc>
10172	Supports creating images split in chunks of a bit less than 2 GBytes.
10173	</desc>
10174	</const>
10175
10176	<const name="Differencing" value="0x10">
10177	<desc>
10178	Supports being used as a format for differencing media (see <link
10179	to="IMedium::createDiffStorage"/>).
10180	</desc>
10181	</const>
10182
10183	<const name="Asynchronous" value="0x20">
10184	<desc>
10185	Supports asynchronous I/O operations for at least some configurations.
10186	</desc>
10187	</const>
10188
10189	<const name="File" value="0x40">
10190	<desc>
10191	The format backend operates on files (the <link to="IMedium::location"/>
10192	attribute of the medium specifies a file used to store medium
10193	data; for a list of supported file extensions see
10194	<link to="IMediumFormat::describeFileExtensions"/>).
10195	</desc>
10196	</const>
10197
10198	<const name="Properties" value="0x80">
10199	<desc>
10200	The format backend uses the property interface to configure the storage
10201	location and properties (the <link to="IMediumFormat::describeProperties"/>
10202	method is used to get access to properties supported by the given medium format).
10203	</desc>
10204	</const>
10205
10206	<const name="TcpNetworking" value="0x100">
10207	<desc>
10208	The format backend uses the TCP networking interface for network access.
10209	</desc>
10210	</const>
10211
10212	<const name="VFS" value="0x200">
10213	<desc>
10214	The format backend supports virtual filesystem functionality.
10215	</desc>
10216	</const>
10217
10218	<const name="CapabilityMask" value="0x3FF"/>
10219	</enum>
10220
10221	<interface
10222	name="IMediumFormat" extends="$unknown"
10223	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10224	wsmap="managed"
10225	>
10226	<desc>
10227	The IMediumFormat interface represents a medium format.
10228
10229	Each medium format has an associated backend which is used to handle
10230	media stored in this format. This interface provides information
10231	about the properties of the associated backend.
10232
10233	Each medium format is identified by a string represented by the
10234	<link to="#id"/> attribute. This string is used in calls like
10235	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10236	format.
10237
10238	The list of all supported medium formats can be obtained using
10239	<link to="ISystemProperties::mediumFormats"/>.
10240
10241	<see>IMedium</see>
10242	</desc>
10243
10244	<attribute name="id" type="wstring" readonly="yes">
10245	<desc>
10246	Identifier of this format.
10247
10248	The format identifier is a non-@c null non-empty ASCII string. Note that
10249	this string is case-insensitive. This means that, for example, all of
10250	the following strings:
10251	<pre>
10252	"VDI"
10253	"vdi"
10254	"VdI"</pre>
10255	refer to the same medium format.
10256
10257	This string is used in methods of other interfaces where it is necessary
10258	to specify a medium format, such as
10259	<link to="IVirtualBox::createHardDisk"/>.
10260	</desc>
10261	</attribute>
10262
10263	<attribute name="name" type="wstring" readonly="yes">
10264	<desc>
10265	Human readable description of this format.
10266
10267	Mainly for use in file open dialogs.
10268	</desc>
10269	</attribute>
10270
10271	<attribute name="capabilities" type="unsigned long" readonly="yes">
10272	<desc>
10273	Capabilities of the format as a set of bit flags.
10274
10275	For the meaning of individual capability flags see
10276	<link to="MediumFormatCapabilities"/>.
10277	</desc>
10278	</attribute>
10279
10280	<method name="describeFileExtensions">
10281	<desc>
10282	Returns two arrays describing the supported file extensions.
10283
10284	The first array contains the supported extensions and the seconds one
10285	the type each extension supports. Both have the same size.
10286
10287	Note that some backends do not work on files, so this array may be
10288	empty.
10289
10290	<see>IMediumFormat::capabilities</see>
10291	</desc>
10292	<param name="extensions" type="wstring" safearray="yes" dir="out">
10293	<desc>The array of supported extensions.</desc>
10294	</param>
10295	<param name="type" type="DeviceType" safearray="yes" dir="out">
10296	<desc>The array which indicates the device type for every given extension.</desc>
10297	</param>
10298	</method>
10299
10300	<method name="describeProperties">
10301	<desc>
10302	Returns several arrays describing the properties supported by this
10303	format.
10304
10305	An element with the given index in each array describes one
10306	property. Thus, the number of elements in each returned array is the
10307	same and corresponds to the number of supported properties.
10308
10309	The returned arrays are filled in only if the
10310	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10311	All arguments must be non-@c null.
10312
10313	<see>DataType</see>
10314	<see>DataFlags</see>
10315	</desc>
10316
10317	<param name="names" type="wstring" safearray="yes" dir="out">
10318	<desc>Array of property names.</desc>
10319	</param>
10320	<param name="description" type="wstring" safearray="yes" dir="out">
10321	<desc>Array of property descriptions.</desc>
10322	</param>
10323	<param name="types" type="DataType" safearray="yes" dir="out">
10324	<desc>Array of property types.</desc>
10325	</param>
10326	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10327	<desc>Array of property flags.</desc>
10328	</param>
10329	<param name="defaults" type="wstring" safearray="yes" dir="out">
10330	<desc>Array of default property values.</desc>
10331	</param>
10332	</method>
10333
10334	</interface>
10335
10336
10337	<!--
10338	// IKeyboard
10339	/////////////////////////////////////////////////////////////////////////
10340	-->
10341
10342	<interface
10343	name="IKeyboard" extends="$unknown"
10344	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10345	wsmap="managed"
10346	>
10347	<desc>
10348	The IKeyboard interface represents the virtual machine's keyboard. Used
10349	in <link to="IConsole::keyboard"/>.
10350
10351	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10352	to the virtual machine.
10353
10354	</desc>
10355	<method name="putScancode">
10356	<desc>Sends a scancode to the keyboard.
10357
10358	<result name="VBOX_E_IPRT_ERROR">
10359	Could not send scan code to virtual keyboard.
10360	</result>
10361
10362	</desc>
10363	<param name="scancode" type="long" dir="in"/>
10364	</method>
10365
10366	<method name="putScancodes">
10367	<desc>Sends an array of scancodes to the keyboard.
10368
10369	<result name="VBOX_E_IPRT_ERROR">
10370	Could not send all scan codes to virtual keyboard.
10371	</result>
10372
10373	</desc>
10374	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10375	<param name="codesStored" type="unsigned long" dir="return"/>
10376	</method>
10377
10378	<method name="putCAD">
10379	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10380	function is nothing special, it is just a convenience function
10381	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10382
10383	<result name="VBOX_E_IPRT_ERROR">
10384	Could not send all scan codes to virtual keyboard.
10385	</result>
10386
10387	</desc>
10388	</method>
10389
10390	<attribute name="eventSource" type="IEventSource" readonly="yes">
10391	<desc>
10392	Event source for keyboard events.
10393	</desc>
10394	</attribute>
10395
10396	</interface>
10397
10398
10399	<!--
10400	// IMouse
10401	/////////////////////////////////////////////////////////////////////////
10402	-->
10403
10404	<enum
10405	name="MouseButtonState"
10406	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10407	>
10408	<desc>
10409	Mouse button state.
10410	</desc>
10411
10412	<const name="LeftButton" value="0x01"/>
10413	<const name="RightButton" value="0x02"/>
10414	<const name="MiddleButton" value="0x04"/>
10415	<const name="WheelUp" value="0x08"/>
10416	<const name="WheelDown" value="0x10"/>
10417	<const name="XButton1" value="0x20"/>
10418	<const name="XButton2" value="0x40"/>
10419	<const name="MouseStateMask" value="0x7F"/>
10420	</enum>
10421
10422	<interface
10423	name="IMouse" extends="$unknown"
10424	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10425	wsmap="managed"
10426	>
10427	<desc>
10428	The IMouse interface represents the virtual machine's mouse. Used in
10429	<link to="IConsole::mouse"/>.
10430
10431	Through this interface, the virtual machine's virtual mouse can be
10432	controlled.
10433	</desc>
10434
10435	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10436	<desc>
10437	Whether the guest OS supports absolute mouse pointer positioning
10438	or not.
10439	<note>
10440	You can use the <link to="IMouseCapabilityChangedEvent"/>
10441	event to be instantly informed about changes of this attribute
10442	during virtual machine execution.
10443	</note>
10444	<see><link to="#putMouseEventAbsolute"/></see>
10445	</desc>
10446	</attribute>
10447
10448	<attribute name="relativeSupported" type="boolean" readonly="yes">
10449	<desc>
10450	Whether the guest OS supports relative mouse pointer positioning
10451	or not.
10452	<note>
10453	You can use the <link to="IMouseCapabilityChangedEvent"/>
10454	event to be instantly informed about changes of this attribute
10455	during virtual machine execution.
10456	</note>
10457	<see><link to="#putMouseEvent"/></see>
10458	</desc>
10459	</attribute>
10460
10461	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10462	<desc>
10463	Whether the guest OS can currently switch to drawing it's own mouse
10464	cursor on demand.
10465	<note>
10466	You can use the <link to="IMouseCapabilityChangedEvent"/>
10467	event to be instantly informed about changes of this attribute
10468	during virtual machine execution.
10469	</note>
10470	<see><link to="#putMouseEvent"/></see>
10471	</desc>
10472	</attribute>
10473
10474	<method name="putMouseEvent">
10475	<desc>
10476	Initiates a mouse event using relative pointer movements
10477	along x and y axis.
10478
10479	<result name="E_ACCESSDENIED">
10480	Console not powered up.
10481	</result>
10482	<result name="VBOX_E_IPRT_ERROR">
10483	Could not send mouse event to virtual mouse.
10484	</result>
10485
10486	</desc>
10487
10488	<param name="dx" type="long" dir="in">
10489	<desc>
10490	Amount of pixels the mouse should move to the right.
10491	Negative values move the mouse to the left.
10492	</desc>
10493	</param>
10494	<param name="dy" type="long" dir="in">
10495	<desc>
10496	Amount of pixels the mouse should move downwards.
10497	Negative values move the mouse upwards.
10498	</desc>
10499	</param>
10500	<param name="dz" type="long" dir="in">
10501	<desc>
10502	Amount of mouse wheel moves.
10503	Positive values describe clockwise wheel rotations,
10504	negative values describe counterclockwise rotations.
10505	</desc>
10506	</param>
10507	<param name="dw" type="long" dir="in">
10508	<desc>
10509	Amount of horizontal mouse wheel moves.
10510	Positive values describe a movement to the left,
10511	negative values describe a movement to the right.
10512	</desc>
10513	</param>
10514	<param name="buttonState" type="long" dir="in">
10515	<desc>
10516	The current state of mouse buttons. Every bit represents
10517	a mouse button as follows:
10518	<table>
10519	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10520	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10521	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10522	</table>
10523	A value of <tt>1</tt> means the corresponding button is pressed.
10524	otherwise it is released.
10525	</desc>
10526	</param>
10527	</method>
10528
10529	<method name="putMouseEventAbsolute">
10530	<desc>
10531	Positions the mouse pointer using absolute x and y coordinates.
10532	These coordinates are expressed in pixels and
10533	start from <tt>[1,1]</tt> which corresponds to the top left
10534	corner of the virtual display.
10535
10536	<result name="E_ACCESSDENIED">
10537	Console not powered up.
10538	</result>
10539	<result name="VBOX_E_IPRT_ERROR">
10540	Could not send mouse event to virtual mouse.
10541	</result>
10542
10543	<note>
10544	This method will have effect only if absolute mouse
10545	positioning is supported by the guest OS.
10546	</note>
10547
10548	<see><link to="#absoluteSupported"/></see>
10549	</desc>
10550
10551	<param name="x" type="long" dir="in">
10552	<desc>
10553	X coordinate of the pointer in pixels, starting from @c 1.
10554	</desc>
10555	</param>
10556	<param name="y" type="long" dir="in">
10557	<desc>
10558	Y coordinate of the pointer in pixels, starting from @c 1.
10559	</desc>
10560	</param>
10561	<param name="dz" type="long" dir="in">
10562	<desc>
10563	Amount of mouse wheel moves.
10564	Positive values describe clockwise wheel rotations,
10565	negative values describe counterclockwise rotations.
10566	</desc>
10567	</param>
10568	<param name="dw" type="long" dir="in">
10569	<desc>
10570	Amount of horizontal mouse wheel moves.
10571	Positive values describe a movement to the left,
10572	negative values describe a movement to the right.
10573	</desc>
10574	</param>
10575	<param name="buttonState" type="long" dir="in">
10576	<desc>
10577	The current state of mouse buttons. Every bit represents
10578	a mouse button as follows:
10579	<table>
10580	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10581	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10582	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10583	</table>
10584	A value of @c 1 means the corresponding button is pressed.
10585	otherwise it is released.
10586	</desc>
10587	</param>
10588	</method>
10589
10590	<attribute name="eventSource" type="IEventSource" readonly="yes">
10591	<desc>
10592	Event source for mouse events.
10593	</desc>
10594	</attribute>
10595
10596	</interface>
10597
10598	<!--
10599	// IDisplay
10600	/////////////////////////////////////////////////////////////////////////
10601	-->
10602
10603	<enum
10604	name="FramebufferPixelFormat"
10605	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10606	>
10607	<desc>
10608	Format of the video memory buffer. Constants represented by this enum can
10609	be used to test for particular values of <link
10610	to="IFramebuffer::pixelFormat"/>. See also <link
10611	to="IFramebuffer::requestResize"/>.
10612
10613	See also www.fourcc.org for more information about FOURCC pixel formats.
10614	</desc>
10615
10616	<const name="Opaque" value="0">
10617	<desc>
10618	Unknown buffer format (the user may not assume any particular format of
10619	the buffer).
10620	</desc>
10621	</const>
10622	<const name="FOURCC_RGB" value="0x32424752">
10623	<desc>
10624	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10625	bit layout).
10626	</desc>
10627	</const>
10628	</enum>
10629
10630	<interface
10631	name="IFramebuffer" extends="$unknown"
10632	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10633	wsmap="suppress"
10634	>
10635	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10636	<desc>Address of the start byte of the frame buffer.</desc>
10637	</attribute>
10638
10639	<attribute name="width" type="unsigned long" readonly="yes">
10640	<desc>Frame buffer width, in pixels.</desc>
10641	</attribute>
10642
10643	<attribute name="height" type="unsigned long" readonly="yes">
10644	<desc>Frame buffer height, in pixels.</desc>
10645	</attribute>
10646
10647	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10648	<desc>
10649	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10650	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10651	are: 8, 15, 16, 24 and 32.
10652	</desc>
10653	</attribute>
10654
10655	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10656	<desc>
10657	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10658	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10659	size of the scan line must be aligned to 32 bits.
10660	</desc>
10661	</attribute>
10662
10663	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10664	<desc>
10665	Frame buffer pixel format. It's either one of the values defined by <link
10666	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10667	<note>
10668	This attribute must never return <link
10669	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10670	<link to="#address"/> points to must be always known.
10671	</note>
10672	</desc>
10673	</attribute>
10674
10675	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10676	<desc>
10677	Defines whether this frame buffer uses the virtual video card's memory
10678	buffer (guest VRAM) directly or not. See <link
10679	to="IFramebuffer::requestResize"/> for more information.
10680	</desc>
10681	</attribute>
10682
10683	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10684	<desc>
10685	Hint from the frame buffer about how much of the standard
10686	screen height it wants to use for itself. This information is
10687	exposed to the guest through the VESA BIOS and VMMDev interface
10688	so that it can use it for determining its video mode table. It
10689	is not guaranteed that the guest respects the value.
10690	</desc>
10691	</attribute>
10692
10693	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10694	<desc>
10695	An alpha-blended overlay which is superposed over the frame buffer.
10696	The initial purpose is to allow the display of icons providing
10697	information about the VM state, including disk activity, in front
10698	ends which do not have other means of doing that. The overlay is
10699	designed to controlled exclusively by IDisplay. It has no locking
10700	of its own, and any changes made to it are not guaranteed to be
10701	visible until the affected portion of IFramebuffer is updated. The
10702	overlay can be created lazily the first time it is requested. This
10703	attribute can also return @c null to signal that the overlay is not
10704	implemented.
10705	</desc>
10706	</attribute>
10707
10708	<attribute name="winId" type="long long" readonly="yes">
10709	<desc>
10710	Platform-dependent identifier of the window where context of this
10711	frame buffer is drawn, or zero if there's no such window.
10712	</desc>
10713	</attribute>
10714
10715	<method name="lock">
10716	<desc>
10717	Locks the frame buffer.
10718	Gets called by the IDisplay object where this frame buffer is
10719	bound to.
10720	</desc>
10721	</method>
10722
10723	<method name="unlock">
10724	<desc>
10725	Unlocks the frame buffer.
10726	Gets called by the IDisplay object where this frame buffer is
10727	bound to.
10728	</desc>
10729	</method>
10730
10731	<method name="notifyUpdate">
10732	<desc>
10733	Informs about an update.
10734	Gets called by the display object where this buffer is
10735	registered.
10736	</desc>
10737	<param name="x" type="unsigned long" dir="in"/>
10738	<param name="y" type="unsigned long" dir="in"/>
10739	<param name="width" type="unsigned long" dir="in"/>
10740	<param name="height" type="unsigned long" dir="in"/>
10741	</method>
10742
10743	<method name="requestResize">
10744	<desc>
10745	Requests a size and pixel format change.
10746
10747	There are two modes of working with the video buffer of the virtual
10748	machine. The <i>indirect</i> mode implies that the IFramebuffer
10749	implementation allocates a memory buffer for the requested display mode
10750	and provides it to the virtual machine. In <i>direct</i> mode, the
10751	IFramebuffer implementation uses the memory buffer allocated and owned
10752	by the virtual machine. This buffer represents the video memory of the
10753	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10754	usually faster because the implementation gets a raw pointer to the
10755	guest VRAM buffer which it can directly use for visualizing the contents
10756	of the virtual display, as opposed to the indirect mode where the
10757	contents of guest VRAM are copied to the memory buffer provided by
10758	the implementation every time a display update occurs.
10759
10760	It is important to note that the direct mode is really fast only when
10761	the implementation uses the given guest VRAM buffer directly, for
10762	example, by blitting it to the window representing the virtual machine's
10763	display, which saves at least one copy operation comparing to the
10764	indirect mode. However, using the guest VRAM buffer directly is not
10765	always possible: the format and the color depth of this buffer may be
10766	not supported by the target window, or it may be unknown (opaque) as in
10767	case of text or non-linear multi-plane VGA video modes. In this case,
10768	the indirect mode (that is always available) should be used as a
10769	fallback: when the guest VRAM contents are copied to the
10770	implementation-provided memory buffer, color and format conversion is
10771	done automatically by the underlying code.
10772
10773	The @a pixelFormat parameter defines whether the direct mode is
10774	available or not. If @a pixelFormat is <link
10775	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10776	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10777	@a bytesPerLine parameters must be ignored and the implementation must use
10778	the indirect mode (where it provides its own buffer in one of the
10779	supported formats). In all other cases, @a pixelFormat together with
10780	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10781	buffer pointed to by the @a VRAM parameter and the implementation is
10782	free to choose which mode to use. To indicate that this frame buffer uses
10783	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10784	attribute must return @c true and <link to="#address"/> must
10785	return exactly the same address that is passed in the @a VRAM parameter
10786	of this method; otherwise it is assumed that the indirect strategy is
10787	chosen.
10788
10789	The @a width and @a height parameters represent the size of the
10790	requested display mode in both modes. In case of indirect mode, the
10791	provided memory buffer should be big enough to store data of the given
10792	display mode. In case of direct mode, it is guaranteed that the given
10793	@a VRAM buffer contains enough space to represent the display mode of the
10794	given size. Note that this frame buffer's <link to="#width"/> and <link
10795	to="#height"/> attributes must return exactly the same values as
10796	passed to this method after the resize is completed (see below).
10797
10798	The @a finished output parameter determines if the implementation has
10799	finished resizing the frame buffer or not. If, for some reason, the
10800	resize cannot be finished immediately during this call, @a finished
10801	must be set to @c false, and the implementation must call
10802	<link to="IDisplay::resizeCompleted"/> after it has returned from
10803	this method as soon as possible. If @a finished is @c false, the
10804	machine will not call any frame buffer methods until
10805	<link to="IDisplay::resizeCompleted"/> is called.
10806
10807	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10808	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10809	this frame buffer must return exactly the same values as specified in the
10810	parameters of this method, after the resize is completed. If the
10811	indirect mode is chosen, these attributes must return values describing
10812	the format of the implementation's own memory buffer <link
10813	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10814	value must always correlate with <link to="#pixelFormat"/>. Note that
10815	the <link to="#pixelFormat"/> attribute must never return <link
10816	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10817
10818	<note>
10819	This method is called by the IDisplay object under the
10820	<link to="#lock"/> provided by this IFramebuffer
10821	implementation. If this method returns @c false in @a finished, then
10822	this lock is not released until
10823	<link to="IDisplay::resizeCompleted"/> is called.
10824	</note>
10825	</desc>
10826	<param name="screenId" type="unsigned long" dir="in">
10827	<desc>
10828	Logical screen number. Must be used in the corresponding call to
10829	<link to="IDisplay::resizeCompleted"/> if this call is made.
10830	</desc>
10831	</param>
10832	<param name="pixelFormat" type="unsigned long" dir="in">
10833	<desc>
10834	Pixel format of the memory buffer pointed to by @a VRAM.
10835	See also <link to="FramebufferPixelFormat"/>.
10836	</desc>
10837	</param>
10838	<param name="VRAM" type="octet" mod="ptr" dir="in">
10839	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10840	</param>
10841	<param name="bitsPerPixel" type="unsigned long" dir="in">
10842	<desc>Color depth, bits per pixel.</desc>
10843	</param>
10844	<param name="bytesPerLine" type="unsigned long" dir="in">
10845	<desc>Size of one scan line, in bytes.</desc>
10846	</param>
10847	<param name="width" type="unsigned long" dir="in">
10848	<desc>Width of the guest display, in pixels.</desc>
10849	</param>
10850	<param name="height" type="unsigned long" dir="in">
10851	<desc>Height of the guest display, in pixels.</desc>
10852	</param>
10853	<param name="finished" type="boolean" dir="return">
10854	<desc>
10855	Can the VM start using the new frame buffer immediately
10856	after this method returns or it should wait for
10857	<link to="IDisplay::resizeCompleted"/>.
10858	</desc>
10859	</param>
10860	</method>
10861
10862	<method name="videoModeSupported">
10863	<desc>
10864	Returns whether the frame buffer implementation is willing to
10865	support a given video mode. In case it is not able to render
10866	the video mode (or for some reason not willing), it should
10867	return @c false. Usually this method is called when the guest
10868	asks the VMM device whether a given video mode is supported
10869	so the information returned is directly exposed to the guest.
10870	It is important that this method returns very quickly.
10871	</desc>
10872	<param name="width" type="unsigned long" dir="in"/>
10873	<param name="height" type="unsigned long" dir="in"/>
10874	<param name="bpp" type="unsigned long" dir="in"/>
10875	<param name="supported" type="boolean" dir="return"/>
10876	</method>
10877
10878	<method name="getVisibleRegion">
10879	<desc>
10880	Returns the visible region of this frame buffer.
10881
10882	If the @a rectangles parameter is @c null then the value of the
10883	@a count parameter is ignored and the number of elements necessary to
10884	describe the current visible region is returned in @a countCopied.
10885
10886	If @a rectangles is not @c null but @a count is less
10887	than the required number of elements to store region data, the method
10888	will report a failure. If @a count is equal or greater than the
10889	required number of elements, then the actual number of elements copied
10890	to the provided array will be returned in @a countCopied.
10891
10892	<note>
10893	The address of the provided array must be in the process space of
10894	this IFramebuffer object.
10895	</note>
10896	<note>
10897	Method not yet implemented.
10898	</note>
10899	</desc>
10900	<param name="rectangles" type="octet" mod="ptr" dir="in">
10901	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10902	</param>
10903	<param name="count" type="unsigned long" dir="in">
10904	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10905	</param>
10906	<param name="countCopied" type="unsigned long" dir="return">
10907	<desc>Number of elements copied to the @a rectangles array.</desc>
10908	</param>
10909	</method>
10910
10911	<method name="setVisibleRegion">
10912	<desc>
10913	Suggests a new visible region to this frame buffer. This region
10914	represents the area of the VM display which is a union of regions of
10915	all top-level windows of the guest operating system running inside the
10916	VM (if the Guest Additions for this system support this
10917	functionality). This information may be used by the frontends to
10918	implement the seamless desktop integration feature.
10919
10920	<note>
10921	The address of the provided array must be in the process space of
10922	this IFramebuffer object.
10923	</note>
10924	<note>
10925	The IFramebuffer implementation must make a copy of the provided
10926	array of rectangles.
10927	</note>
10928	<note>
10929	Method not yet implemented.
10930	</note>
10931	</desc>
10932	<param name="rectangles" type="octet" mod="ptr" dir="in">
10933	<desc>Pointer to the @c RTRECT array.</desc>
10934	</param>
10935	<param name="count" type="unsigned long" dir="in">
10936	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10937	</param>
10938	</method>
10939
10940	<method name="processVHWACommand">
10941	<desc>
10942	Posts a Video HW Acceleration Command to the frame buffer for processing.
10943	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
10944	are posted from quest to the host to be processed by the host hardware.
10945
10946	<note>
10947	The address of the provided command must be in the process space of
10948	this IFramebuffer object.
10949	</note>
10950	</desc>
10951
10952	<param name="command" type="octet" mod="ptr" dir="in">
10953	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10954	</param>
10955	</method>
10956
10957	</interface>
10958
10959	<interface
10960	name="IFramebufferOverlay" extends="IFramebuffer"
10961	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10962	wsmap="suppress"
10963	>
10964	<desc>
10965	The IFramebufferOverlay interface represents an alpha blended overlay
10966	for displaying status icons above an IFramebuffer. It is always created
10967	not visible, so that it must be explicitly shown. It only covers a
10968	portion of the IFramebuffer, determined by its width, height and
10969	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10970	that order) format, and may be written to directly. Do re-read the
10971	width though, after setting it, as it may be adjusted (increased) to
10972	make it more suitable for the front end.
10973	</desc>
10974	<attribute name="x" type="unsigned long" readonly="yes">
10975	<desc>X position of the overlay, relative to the frame buffer.</desc>
10976	</attribute>
10977
10978	<attribute name="y" type="unsigned long" readonly="yes">
10979	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10980	</attribute>
10981
10982	<attribute name="visible" type="boolean" readonly="no">
10983	<desc>
10984	Whether the overlay is currently visible.
10985	</desc>
10986	</attribute>
10987
10988	<attribute name="alpha" type="unsigned long" readonly="no">
10989	<desc>
10990	The global alpha value for the overlay. This may or may not be
10991	supported by a given front end.
10992	</desc>
10993	</attribute>
10994
10995	<method name="move">
10996	<desc>
10997	Changes the overlay's position relative to the IFramebuffer.
10998	</desc>
10999	<param name="x" type="unsigned long" dir="in"/>
11000	<param name="y" type="unsigned long" dir="in"/>
11001	</method>
11002
11003	</interface>
11004
11005	<interface
11006	name="IDisplay" extends="$unknown"
11007	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11008	wsmap="managed"
11009	>
11010	<desc>
11011	The IDisplay interface represents the virtual machine's display.
11012
11013	The object implementing this interface is contained in each
11014	<link to="IConsole::display"/> attribute and represents the visual
11015	output of the virtual machine.
11016
11017	The virtual display supports pluggable output targets represented by the
11018	IFramebuffer interface. Examples of the output target are a window on
11019	the host computer or an RDP session's display on a remote computer.
11020	</desc>
11021	<method name="getScreenResolution">
11022	<desc>Queries display width, height and color depth for given screen.</desc>
11023	<param name="screenId" type="unsigned long" dir="in"/>
11024	<param name="width" type="unsigned long" dir="out"/>
11025	<param name="height" type="unsigned long" dir="out"/>
11026	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11027	</method>
11028
11029	<method name="setFramebuffer">
11030	<desc>
11031	Sets the framebuffer for given screen.
11032	</desc>
11033	<param name="screenId" type="unsigned long" dir="in"/>
11034	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11035	</method>
11036
11037	<method name="getFramebuffer">
11038	<desc>
11039	Queries the framebuffer for given screen.
11040	</desc>
11041	<param name="screenId" type="unsigned long" dir="in"/>
11042	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11043	<param name="xOrigin" type="long" dir="out"/>
11044	<param name="yOrigin" type="long" dir="out"/>
11045	</method>
11046
11047	<method name="setVideoModeHint">
11048	<desc>
11049	Asks VirtualBox to request the given video mode from
11050	the guest. This is just a hint and it cannot be guaranteed
11051	that the requested resolution will be used. Guest Additions
11052	are required for the request to be seen by guests. The caller
11053	should issue the request and wait for a resolution change and
11054	after a timeout retry.
11055
11056	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11057	parameters means that the corresponding values should be taken from the
11058	current video mode (i.e. left unchanged).
11059
11060	If the guest OS supports multi-monitor configuration then the @a display
11061	parameter specifies the number of the guest display to send the hint to:
11062	@c 0 is the primary display, @c 1 is the first secondary and
11063	so on. If the multi-monitor configuration is not supported, @a display
11064	must be @c 0.
11065
11066	<result name="E_INVALIDARG">
11067	The @a display is not associated with any monitor.
11068	</result>
11069
11070	</desc>
11071	<param name="width" type="unsigned long" dir="in"/>
11072	<param name="height" type="unsigned long" dir="in"/>
11073	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11074	<param name="display" type="unsigned long" dir="in"/>
11075	</method>
11076
11077	<method name="setSeamlessMode">
11078	<desc>
11079	Enables or disables seamless guest display rendering (seamless desktop
11080	integration) mode.
11081	<note>
11082	Calling this method has no effect if <link
11083	to="IGuest::supportsSeamless"/> returns @c false.
11084	</note>
11085	</desc>
11086	<param name="enabled" type="boolean" dir="in"/>
11087	</method>
11088
11089	<method name="takeScreenShot">
11090	<desc>
11091	Takes a screen shot of the requested size and copies it to the
11092	32-bpp buffer allocated by the caller and pointed to by @a address.
11093	A pixel consists of 4 bytes in order: B, G, R, 0.
11094
11095	<note>This API can be used only by the COM/XPCOM C++ API as it
11096	requires pointer support. Use <link to="#takeScreenShotToArray" />
11097	with other language bindings.
11098	</note>
11099
11100	<result name="E_NOTIMPL">
11101	Feature not implemented.
11102	</result>
11103	<result name="VBOX_E_IPRT_ERROR">
11104	Could not take a screenshot.
11105	</result>
11106
11107	</desc>
11108	<param name="screenId" type="unsigned long" dir="in"/>
11109	<param name="address" type="octet" mod="ptr" dir="in"/>
11110	<param name="width" type="unsigned long" dir="in"/>
11111	<param name="height" type="unsigned long" dir="in"/>
11112	</method>
11113
11114	<method name="takeScreenShotToArray">
11115	<desc>
11116	Takes a guest screen shot of the requested size and returns it as
11117	an array of bytes in uncompressed 32-bit RGBA format.
11118	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11119
11120	This API is slow, but could be the only option to get guest screenshot
11121	for scriptable languages not allowed to manipulate with addresses
11122	directly.
11123
11124	<result name="E_NOTIMPL">
11125	Feature not implemented.
11126	</result>
11127	<result name="VBOX_E_IPRT_ERROR">
11128	Could not take a screenshot.
11129	</result>
11130	</desc>
11131	<param name="screenId" type="unsigned long" dir="in">
11132	<desc>
11133	Monitor to take screenshot from.
11134	</desc>
11135	</param>
11136	<param name="width" type="unsigned long" dir="in">
11137	<desc>
11138	Desired image width.
11139	</desc>
11140	</param>
11141	<param name="height" type="unsigned long" dir="in">
11142	<desc>
11143	Desired image height.
11144	</desc>
11145	</param>
11146	<param name="screenData" type="octet" dir="return" safearray="yes">
11147	<desc>
11148	Array with resulting screen data.
11149	</desc>
11150	</param>
11151	</method>
11152
11153	<method name="takeScreenShotPNGToArray">
11154	<desc>
11155	Takes a guest screen shot of the requested size and returns it as
11156	PNG image in array.
11157
11158	<result name="E_NOTIMPL">
11159	Feature not implemented.
11160	</result>
11161	<result name="VBOX_E_IPRT_ERROR">
11162	Could not take a screenshot.
11163	</result>
11164	</desc>
11165	<param name="screenId" type="unsigned long" dir="in">
11166	<desc>
11167	Monitor to take the screenshot from.
11168	</desc>
11169	</param>
11170	<param name="width" type="unsigned long" dir="in">
11171	<desc>
11172	Desired image width.
11173	</desc>
11174	</param>
11175	<param name="height" type="unsigned long" dir="in">
11176	<desc>
11177	Desired image height.
11178	</desc>
11179	</param>
11180	<param name="screenData" type="octet" dir="return" safearray="yes">
11181	<desc>
11182	Array with resulting screen data.
11183	</desc>
11184	</param>
11185	</method>
11186
11187	<method name="drawToScreen">
11188	<desc>
11189	Draws a 32-bpp image of the specified size from the given buffer
11190	to the given point on the VM display.
11191
11192	<result name="E_NOTIMPL">
11193	Feature not implemented.
11194	</result>
11195	<result name="VBOX_E_IPRT_ERROR">
11196	Could not draw to screen.
11197	</result>
11198
11199	</desc>
11200	<param name="screenId" type="unsigned long" dir="in">
11201	<desc>
11202	Monitor to take the screenshot from.
11203	</desc>
11204	</param>
11205	<param name="address" type="octet" mod="ptr" dir="in">
11206	<desc>
11207	Address to store the screenshot to
11208	</desc>
11209	</param>
11210	<param name="x" type="unsigned long" dir="in">
11211	<desc>
11212	Relative to the screen top left corner.
11213	</desc>
11214	</param>
11215	<param name="y" type="unsigned long" dir="in">
11216	<desc>
11217	Relative to the screen top left corner.
11218	</desc>
11219	</param>
11220	<param name="width" type="unsigned long" dir="in">
11221	<desc>
11222	Desired image width.
11223	</desc>
11224	</param>
11225	<param name="height" type="unsigned long" dir="in">
11226	<desc>
11227	Desired image height.
11228	</desc>
11229	</param>
11230	</method>
11231
11232	<method name="invalidateAndUpdate">
11233	<desc>
11234	Does a full invalidation of the VM display and instructs the VM
11235	to update it.
11236
11237	<result name="VBOX_E_IPRT_ERROR">
11238	Could not invalidate and update screen.
11239	</result>
11240
11241	</desc>
11242	</method>
11243
11244	<method name="resizeCompleted">
11245	<desc>
11246	Signals that a framebuffer has completed the resize operation.
11247
11248	<result name="VBOX_E_NOT_SUPPORTED">
11249	Operation only valid for external frame buffers.
11250	</result>
11251
11252	</desc>
11253	<param name="screenId" type="unsigned long" dir="in"/>
11254	</method>
11255
11256	<method name="completeVHWACommand">
11257	<desc>
11258	Signals that the Video HW Acceleration command has completed.
11259	</desc>
11260
11261	<param name="command" type="octet" mod="ptr" dir="in">
11262	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11263	</param>
11264	</method>
11265
11266	</interface>
11267
11268	<!--
11269	// INetworkAdapter
11270	/////////////////////////////////////////////////////////////////////////
11271	-->
11272
11273	<enum
11274	name="NetworkAttachmentType"
11275	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11276	>
11277	<desc>
11278	Network attachment type.
11279	</desc>
11280
11281	<const name="Null" value="0">
11282	<desc>Null value, also means "not attached".</desc>
11283	</const>
11284	<const name="NAT" value="1"/>
11285	<const name="Bridged" value="2"/>
11286	<const name="Internal" value="3"/>
11287	<const name="HostOnly" value="4"/>
11288	<const name="VDE" value="5"/>
11289	</enum>
11290
11291	<enum
11292	name="NetworkAdapterType"
11293	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11294	>
11295	<desc>
11296	Network adapter type.
11297	</desc>
11298
11299	<const name="Null" value="0">
11300	<desc>Null value (never used by the API).</desc>
11301	</const>
11302	<const name="Am79C970A" value="1">
11303	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11304	</const>
11305	<const name="Am79C973" value="2">
11306	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11307	</const>
11308	<const name="I82540EM" value="3">
11309	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11310	</const>
11311	<const name="I82543GC" value="4">
11312	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11313	</const>
11314	<const name="I82545EM" value="5">
11315	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11316	</const>
11317	<const name="Virtio" value="6">
11318	<desc>Virtio network device.</desc>
11319	</const>
11320	</enum>
11321
11322	<interface
11323	name="INetworkAdapter" extends="$unknown"
11324	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11325	wsmap="managed"
11326	>
11327	<desc>
11328	Represents a virtual network adapter that is attached to a virtual machine.
11329	Each virtual machine has a fixed number of network adapter slots with one
11330	instance of this attached to each of them. Call
11331	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11332	is attached to a given slot in a given machine.
11333
11334	Each network adapter can be in one of five attachment modes, which are
11335	represented by the <link to="NetworkAttachmentType" /> enumeration;
11336	see the <link to="#attachmentType" /> attribute.
11337	</desc>
11338
11339	<attribute name="adapterType" type="NetworkAdapterType">
11340	<desc>
11341	Type of the virtual network adapter. Depending on this value,
11342	VirtualBox will provide a different virtual network hardware
11343	to the guest.
11344	</desc>
11345	</attribute>
11346
11347	<attribute name="slot" type="unsigned long" readonly="yes">
11348	<desc>
11349	Slot number this adapter is plugged into. Corresponds to
11350	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11351	to obtain this instance.
11352	</desc>
11353	</attribute>
11354
11355	<attribute name="enabled" type="boolean">
11356	<desc>
11357	Flag whether the network adapter is present in the
11358	guest system. If disabled, the virtual guest hardware will
11359	not contain this network adapter. Can only be changed when
11360	the VM is not running.
11361	</desc>
11362	</attribute>
11363
11364	<attribute name="MACAddress" type="wstring">
11365	<desc>
11366	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11367	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11368	</desc>
11369	</attribute>
11370
11371	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11372
11373	<attribute name="hostInterface" type="wstring">
11374	<desc>
11375	Name of the host network interface the VM is attached to.
11376	</desc>
11377	</attribute>
11378
11379	<attribute name="internalNetwork" type="wstring">
11380	<desc>
11381	Name of the internal network the VM is attached to.
11382	</desc>
11383	</attribute>
11384
11385	<attribute name="NATNetwork" type="wstring">
11386	<desc>
11387	Name of the NAT network the VM is attached to.
11388	</desc>
11389	</attribute>
11390
11391	<attribute name="VDENetwork" type="wstring">
11392	<desc>
11393	Name of the VDE switch the VM is attached to.
11394	</desc>
11395	</attribute>
11396
11397	<attribute name="cableConnected" type="boolean">
11398	<desc>
11399	Flag whether the adapter reports the cable as connected or not.
11400	It can be used to report offline situations to a VM.
11401	</desc>
11402	</attribute>
11403
11404	<attribute name="lineSpeed" type="unsigned long">
11405	<desc>
11406	Line speed reported by custom drivers, in units of 1 kbps.
11407	</desc>
11408	</attribute>
11409
11410	<attribute name="traceEnabled" type="boolean">
11411	<desc>
11412	Flag whether network traffic from/to the network card should be traced.
11413	Can only be toggled when the VM is turned off.
11414	</desc>
11415	</attribute>
11416
11417	<attribute name="traceFile" type="wstring">
11418	<desc>
11419	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11420	will be used.
11421	</desc>
11422	</attribute>
11423
11424	<attribute name="natDriver" type="INATEngine" readonly="yes">
11425	<desc>
11426	Points to the NAT engine which handles the network address translation
11427	for this interface. This is active only when the interface actually uses
11428	NAT (see <link to="#attachToNAT" />).
11429	</desc>
11430	</attribute>
11431
11432	<attribute name="bootPriority" type="unsigned long">
11433	<desc>
11434	Network boot priority of the adapter. Priority 1 is highest. If not set,
11435	the priority is considered to be at the lowest possible setting.
11436	</desc>
11437	</attribute>
11438
11439	<attribute name="bandwidthLimit" type="unsigned long">
11440	<desc>
11441	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11442	A zero value means uncapped/unlimited.
11443	</desc>
11444	</attribute>
11445
11446	<method name="attachToNAT">
11447	<desc>
11448	Attach the network adapter to the Network Address Translation (NAT) interface.
11449	</desc>
11450	</method>
11451
11452	<method name="attachToBridgedInterface">
11453	<desc>
11454	Attach the network adapter to a bridged host interface.
11455	</desc>
11456	</method>
11457
11458	<method name="attachToInternalNetwork">
11459	<desc>
11460	Attach the network adapter to an internal network.
11461	</desc>
11462	</method>
11463
11464	<method name="attachToHostOnlyInterface">
11465	<desc>
11466	Attach the network adapter to the host-only network.
11467	</desc>
11468	</method>
11469
11470	<method name="attachToVDE">
11471	<desc>
11472	Attach the network adapter to a VDE network.
11473	</desc>
11474	</method>
11475
11476	<method name="detach">
11477	<desc>
11478	Detach the network adapter
11479	</desc>
11480	</method>
11481	</interface>
11482
11483
11484	<!--
11485	// ISerialPort
11486	/////////////////////////////////////////////////////////////////////////
11487	-->
11488
11489	<enum
11490	name="PortMode"
11491	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11492	>
11493	<desc>
11494	The PortMode enumeration represents possible communication modes for
11495	the virtual serial port device.
11496	</desc>
11497
11498	<const name="Disconnected" value="0">
11499	<desc>Virtual device is not attached to any real host device.</desc>
11500	</const>
11501	<const name="HostPipe" value="1">
11502	<desc>Virtual device is attached to a host pipe.</desc>
11503	</const>
11504	<const name="HostDevice" value="2">
11505	<desc>Virtual device is attached to a host device.</desc>
11506	</const>
11507	<const name="RawFile" value="3">
11508	<desc>Virtual device is attached to a raw file.</desc>
11509	</const>
11510	</enum>
11511
11512	<interface
11513	name="ISerialPort" extends="$unknown"
11514	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11515	wsmap="managed"
11516	>
11517
11518	<desc>
11519	The ISerialPort interface represents the virtual serial port device.
11520
11521	The virtual serial port device acts like an ordinary serial port
11522	inside the virtual machine. This device communicates to the real
11523	serial port hardware in one of two modes: host pipe or host device.
11524
11525	In host pipe mode, the #path attribute specifies the path to the pipe on
11526	the host computer that represents a serial port. The #server attribute
11527	determines if this pipe is created by the virtual machine process at
11528	machine startup or it must already exist before starting machine
11529	execution.
11530
11531	In host device mode, the #path attribute specifies the name of the
11532	serial port device on the host computer.
11533
11534	There is also a third communication mode: the disconnected mode. In this
11535	mode, the guest OS running inside the virtual machine will be able to
11536	detect the serial port, but all port write operations will be discarded
11537	and all port read operations will return no data.
11538
11539	<see>IMachine::getSerialPort</see>
11540	</desc>
11541
11542	<attribute name="slot" type="unsigned long" readonly="yes">
11543	<desc>
11544	Slot number this serial port is plugged into. Corresponds to
11545	the value you pass to <link to="IMachine::getSerialPort"/>
11546	to obtain this instance.
11547	</desc>
11548	</attribute>
11549
11550	<attribute name="enabled" type="boolean">
11551	<desc>
11552	Flag whether the serial port is enabled. If disabled,
11553	the serial port will not be reported to the guest OS.
11554	</desc>
11555	</attribute>
11556
11557	<attribute name="IOBase" type="unsigned long">
11558	<desc>Base I/O address of the serial port.</desc>
11559	</attribute>
11560
11561	<attribute name="IRQ" type="unsigned long">
11562	<desc>IRQ number of the serial port.</desc>
11563	</attribute>
11564
11565	<attribute name="hostMode" type="PortMode">
11566	<desc>
11567	How is this port connected to the host.
11568	<note>
11569	Changing this attribute may fail if the conditions for
11570	<link to="#path"/> are not met.
11571	</note>
11572	</desc>
11573	</attribute>
11574
11575	<attribute name="server" type="boolean">
11576	<desc>
11577	Flag whether this serial port acts as a server (creates a new pipe on
11578	the host) or as a client (uses the existing pipe). This attribute is
11579	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11580	</desc>
11581	</attribute>
11582
11583	<attribute name="path" type="wstring">
11584	<desc>
11585	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11586	PortMode_HostPipe, or the host serial device name when
11587	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11588	cases, setting a @c null or empty string as the attribute's value
11589	is an error. Otherwise, the value of this property is ignored.
11590	</desc>
11591	</attribute>
11592
11593	</interface>
11594
11595	<!--
11596	// IParallelPort
11597	/////////////////////////////////////////////////////////////////////////
11598	-->
11599
11600	<interface
11601	name="IParallelPort" extends="$unknown"
11602	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11603	wsmap="managed"
11604	>
11605
11606	<desc>
11607	The IParallelPort interface represents the virtual parallel port device.
11608
11609	The virtual parallel port device acts like an ordinary parallel port
11610	inside the virtual machine. This device communicates to the real
11611	parallel port hardware using the name of the parallel device on the host
11612	computer specified in the #path attribute.
11613
11614	Each virtual parallel port device is assigned a base I/O address and an
11615	IRQ number that will be reported to the guest operating system and used
11616	to operate the given parallel port from within the virtual machine.
11617
11618	<see>IMachine::getParallelPort</see>
11619	</desc>
11620
11621	<attribute name="slot" type="unsigned long" readonly="yes">
11622	<desc>
11623	Slot number this parallel port is plugged into. Corresponds to
11624	the value you pass to <link to="IMachine::getParallelPort"/>
11625	to obtain this instance.
11626	</desc>
11627	</attribute>
11628
11629	<attribute name="enabled" type="boolean">
11630	<desc>
11631	Flag whether the parallel port is enabled. If disabled,
11632	the parallel port will not be reported to the guest OS.
11633	</desc>
11634	</attribute>
11635
11636	<attribute name="IOBase" type="unsigned long">
11637	<desc>Base I/O address of the parallel port.</desc>
11638	</attribute>
11639
11640	<attribute name="IRQ" type="unsigned long">
11641	<desc>IRQ number of the parallel port.</desc>
11642	</attribute>
11643
11644	<attribute name="path" type="wstring">
11645	<desc>
11646	Host parallel device name. If this parallel port is enabled, setting a
11647	@c null or an empty string as this attribute's value will result into
11648	an error.
11649	</desc>
11650	</attribute>
11651
11652	</interface>
11653
11654
11655	<!--
11656	// IMachineDebugger
11657	/////////////////////////////////////////////////////////////////////////
11658	-->
11659
11660	<interface
11661	name="IMachineDebugger" extends="$unknown"
11662	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11663	wsmap="suppress"
11664	>
11665	<method name="resetStats">
11666	<desc>
11667	Reset VM statistics.
11668	</desc>
11669	<param name="pattern" type="wstring" dir="in">
11670	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11671	</param>
11672	</method>
11673
11674	<method name="dumpStats">
11675	<desc>
11676	Dumps VM statistics.
11677	</desc>
11678	<param name="pattern" type="wstring" dir="in">
11679	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11680	</param>
11681	</method>
11682
11683	<method name="getStats">
11684	<desc>
11685	Get the VM statistics in a XMLish format.
11686	</desc>
11687	<param name="pattern" type="wstring" dir="in">
11688	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11689	</param>
11690	<param name="withDescriptions" type="boolean" dir="in">
11691	<desc>Whether to include the descriptions.</desc>
11692	</param>
11693	<param name="stats" type="wstring" dir="out">
11694	<desc>The XML document containing the statistics.</desc>
11695	</param>
11696	</method>
11697
11698	<method name="injectNMI">
11699	<desc>
11700	Inject an NMI into a running VT-x/AMD-V VM.
11701	</desc>
11702	</method>
11703
11704	<attribute name="singlestep" type="boolean">
11705	<desc>Switch for enabling singlestepping.</desc>
11706	</attribute>
11707
11708	<attribute name="recompileUser" type="boolean">
11709	<desc>Switch for forcing code recompilation for user mode code.</desc>
11710	</attribute>
11711
11712	<attribute name="recompileSupervisor" type="boolean">
11713	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11714	</attribute>
11715
11716	<attribute name="PATMEnabled" type="boolean">
11717	<desc>Switch for enabling and disabling the PATM component.</desc>
11718	</attribute>
11719
11720	<attribute name="CSAMEnabled" type="boolean">
11721	<desc>Switch for enabling and disabling the CSAM component.</desc>
11722	</attribute>
11723
11724	<attribute name="logEnabled" type="boolean">
11725	<desc>Switch for enabling and disabling logging.</desc>
11726	</attribute>
11727
11728	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11729	<desc>
11730	Flag indicating whether the VM is currently making use of CPU hardware
11731	virtualization extensions.
11732	</desc>
11733	</attribute>
11734
11735	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11736	<desc>
11737	Flag indicating whether the VM is currently making use of the nested paging
11738	CPU hardware virtualization extension.
11739	</desc>
11740	</attribute>
11741
11742	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11743	<desc>
11744	Flag indicating whether the VM is currently making use of the VPID
11745	VT-x extension.
11746	</desc>
11747	</attribute>
11748
11749	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11750	<desc>
11751	Flag indicating whether the VM is currently making use of the Physical
11752	Address Extension CPU feature.
11753	</desc>
11754	</attribute>
11755
11756	<attribute name="virtualTimeRate" type="unsigned long">
11757	<desc>
11758	The rate at which the virtual time runs expressed as a percentage.
11759	The accepted range is 2% to 20000%.
11760	</desc>
11761	</attribute>
11762
11763	<!-- @todo method for setting log flags, groups and destination! -->
11764
11765	<attribute name="VM" type="long long" readonly="yes">
11766	<desc>
11767	Gets the VM handle. This is only for internal use while
11768	we carve the details of this interface.
11769	</desc>
11770	</attribute>
11771
11772	</interface>
11773
11774	<!--
11775	// IUSBController
11776	/////////////////////////////////////////////////////////////////////////
11777	-->
11778
11779	<interface
11780	name="IUSBController" extends="$unknown"
11781	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11782	wsmap="managed"
11783	>
11784	<attribute name="enabled" type="boolean">
11785	<desc>
11786	Flag whether the USB controller is present in the
11787	guest system. If disabled, the virtual guest hardware will
11788	not contain any USB controller. Can only be changed when
11789	the VM is powered off.
11790	</desc>
11791	</attribute>
11792
11793	<attribute name="enabledEhci" type="boolean">
11794	<desc>
11795	Flag whether the USB EHCI controller is present in the
11796	guest system. If disabled, the virtual guest hardware will
11797	not contain a USB EHCI controller. Can only be changed when
11798	the VM is powered off.
11799	</desc>
11800	</attribute>
11801
11802	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11803	<desc>
11804	Flag whether there is an USB proxy available.
11805	</desc>
11806	</attribute>
11807
11808	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11809	<desc>
11810	USB standard version which the controller implements.
11811	This is a BCD which means that the major version is in the
11812	high byte and minor version is in the low byte.
11813	</desc>
11814	</attribute>
11815
11816	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11817	<desc>
11818	List of USB device filters associated with the machine.
11819
11820	If the machine is currently running, these filters are activated
11821	every time a new (supported) USB device is attached to the host
11822	computer that was not ignored by global filters
11823	(<link to="IHost::USBDeviceFilters"/>).
11824
11825	These filters are also activated when the machine is powered up.
11826	They are run against a list of all currently available USB
11827	devices (in states
11828	<link to="USBDeviceState_Available"/>,
11829	<link to="USBDeviceState_Busy"/>,
11830	<link to="USBDeviceState_Held"/>) that were not previously
11831	ignored by global filters.
11832
11833	If at least one filter matches the USB device in question, this
11834	device is automatically captured (attached to) the virtual USB
11835	controller of this machine.
11836
11837	<see>IUSBDeviceFilter, ::IUSBController</see>
11838	</desc>
11839	</attribute>
11840
11841	<method name="createDeviceFilter">
11842	<desc>
11843	Creates a new USB device filter. All attributes except
11844	the filter name are set to empty (any match),
11845	<i>active</i> is @c false (the filter is not active).
11846
11847	The created filter can then be added to the list of filters using
11848	<link to="#insertDeviceFilter"/>.
11849
11850	<result name="VBOX_E_INVALID_VM_STATE">
11851	The virtual machine is not mutable.
11852	</result>
11853
11854	<see>#deviceFilters</see>
11855	</desc>
11856	<param name="name" type="wstring" dir="in">
11857	<desc>
11858	Filter name. See <link to="IUSBDeviceFilter::name"/>
11859	for more info.
11860	</desc>
11861	</param>
11862	<param name="filter" type="IUSBDeviceFilter" dir="return">
11863	<desc>Created filter object.</desc>
11864	</param>
11865	</method>
11866
11867	<method name="insertDeviceFilter">
11868	<desc>
11869	Inserts the given USB device to the specified position
11870	in the list of filters.
11871
11872	Positions are numbered starting from <tt>0</tt>. If the specified
11873	position is equal to or greater than the number of elements in
11874	the list, the filter is added to the end of the collection.
11875
11876	<note>
11877	Duplicates are not allowed, so an attempt to insert a
11878	filter that is already in the collection, will return an
11879	error.
11880	</note>
11881
11882	<result name="VBOX_E_INVALID_VM_STATE">
11883	Virtual machine is not mutable.
11884	</result>
11885	<result name="E_INVALIDARG">
11886	USB device filter not created within this VirtualBox instance.
11887	</result>
11888	<result name="VBOX_E_INVALID_OBJECT_STATE">
11889	USB device filter already in list.
11890	</result>
11891
11892	<see>#deviceFilters</see>
11893	</desc>
11894	<param name="position" type="unsigned long" dir="in">
11895	<desc>Position to insert the filter to.</desc>
11896	</param>
11897	<param name="filter" type="IUSBDeviceFilter" dir="in">
11898	<desc>USB device filter to insert.</desc>
11899	</param>
11900	</method>
11901
11902	<method name="removeDeviceFilter">
11903	<desc>
11904	Removes a USB device filter from the specified position in the
11905	list of filters.
11906
11907	Positions are numbered starting from <tt>0</tt>. Specifying a
11908	position equal to or greater than the number of elements in
11909	the list will produce an error.
11910
11911	<see>#deviceFilters</see>
11912
11913	<result name="VBOX_E_INVALID_VM_STATE">
11914	Virtual machine is not mutable.
11915	</result>
11916	<result name="E_INVALIDARG">
11917	USB device filter list empty or invalid @a position.
11918	</result>
11919
11920	</desc>
11921	<param name="position" type="unsigned long" dir="in">
11922	<desc>Position to remove the filter from.</desc>
11923	</param>
11924	<param name="filter" type="IUSBDeviceFilter" dir="return">
11925	<desc>Removed USB device filter.</desc>
11926	</param>
11927	</method>
11928
11929	</interface>
11930
11931
11932	<!--
11933	// IUSBDevice
11934	/////////////////////////////////////////////////////////////////////////
11935	-->
11936
11937	<interface
11938	name="IUSBDevice" extends="$unknown"
11939	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11940	wsmap="managed"
11941	>
11942	<desc>
11943	The IUSBDevice interface represents a virtual USB device attached to the
11944	virtual machine.
11945
11946	A collection of objects implementing this interface is stored in the
11947	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11948	attached to a running virtual machine's USB controller.
11949	</desc>
11950
11951	<attribute name="id" type="uuid" mod="string" readonly="yes">
11952	<desc>
11953	Unique USB device ID. This ID is built from #vendorId,
11954	#productId, #revision and #serialNumber.
11955	</desc>
11956	</attribute>
11957
11958	<attribute name="vendorId" type="unsigned short" readonly="yes">
11959	<desc>Vendor ID.</desc>
11960	</attribute>
11961
11962	<attribute name="productId" type="unsigned short" readonly="yes">
11963	<desc>Product ID.</desc>
11964	</attribute>
11965
11966	<attribute name="revision" type="unsigned short" readonly="yes">
11967	<desc>
11968	Product revision number. This is a packed BCD represented as
11969	unsigned short. The high byte is the integer part and the low
11970	byte is the decimal.
11971	</desc>
11972	</attribute>
11973
11974	<attribute name="manufacturer" type="wstring" readonly="yes">
11975	<desc>Manufacturer string.</desc>
11976	</attribute>
11977
11978	<attribute name="product" type="wstring" readonly="yes">
11979	<desc>Product string.</desc>
11980	</attribute>
11981
11982	<attribute name="serialNumber" type="wstring" readonly="yes">
11983	<desc>Serial number string.</desc>
11984	</attribute>
11985
11986	<attribute name="address" type="wstring" readonly="yes">
11987	<desc>Host specific address of the device.</desc>
11988	</attribute>
11989
11990	<attribute name="port" type="unsigned short" readonly="yes">
11991	<desc>
11992	Host USB port number the device is physically
11993	connected to.
11994	</desc>
11995	</attribute>
11996
11997	<attribute name="version" type="unsigned short" readonly="yes">
11998	<desc>
11999	The major USB version of the device - 1 or 2.
12000	</desc>
12001	</attribute>
12002
12003	<attribute name="portVersion" type="unsigned short" readonly="yes">
12004	<desc>
12005	The major USB version of the host USB port the device is
12006	physically connected to - 1 or 2. For devices not connected to
12007	anything this will have the same value as the version attribute.
12008	</desc>
12009	</attribute>
12010
12011	<attribute name="remote" type="boolean" readonly="yes">
12012	<desc>
12013	Whether the device is physically connected to a remote VRDE
12014	client or to a local host machine.
12015	</desc>
12016	</attribute>
12017
12018	</interface>
12019
12020
12021	<!--
12022	// IUSBDeviceFilter
12023	/////////////////////////////////////////////////////////////////////////
12024	-->
12025
12026	<interface
12027	name="IUSBDeviceFilter" extends="$unknown"
12028	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12029	wsmap="managed"
12030	>
12031	<desc>
12032	The IUSBDeviceFilter interface represents an USB device filter used
12033	to perform actions on a group of USB devices.
12034
12035	This type of filters is used by running virtual machines to
12036	automatically capture selected USB devices once they are physically
12037	attached to the host computer.
12038
12039	A USB device is matched to the given device filter if and only if all
12040	attributes of the device match the corresponding attributes of the
12041	filter (that is, attributes are joined together using the logical AND
12042	operation). On the other hand, all together, filters in the list of
12043	filters carry the semantics of the logical OR operation. So if it is
12044	desirable to create a match like "this vendor id OR this product id",
12045	one needs to create two filters and specify "any match" (see below)
12046	for unused attributes.
12047
12048	All filter attributes used for matching are strings. Each string
12049	is an expression representing a set of values of the corresponding
12050	device attribute, that will match the given filter. Currently, the
12051	following filtering expressions are supported:
12052
12053	<ul>
12054	<li><i>Interval filters</i>. Used to specify valid intervals for
12055	integer device attributes (Vendor ID, Product ID and Revision).
12056	The format of the string is:
12057
12058	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12059
12060	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12061	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12062	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12063	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12064	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12065	possible integer is assumed.
12066	</li>
12067	<li><i>Boolean filters</i>. Used to specify acceptable values for
12068	boolean device attributes. The format of the string is:
12069
12070	<tt>true\|false\|yes\|no\|0\|1</tt>
12071
12072	</li>
12073	<li><i>Exact match</i>. Used to specify a single value for the given
12074	device attribute. Any string that doesn't start with <tt>int:</tt>
12075	represents the exact match. String device attributes are compared to
12076	this string including case of symbols. Integer attributes are first
12077	converted to a string (see individual filter attributes) and then
12078	compared ignoring case.
12079
12080	</li>
12081	<li><i>Any match</i>. Any value of the corresponding device attribute
12082	will match the given filter. An empty or @c null string is
12083	used to construct this type of filtering expressions.
12084
12085	</li>
12086	</ul>
12087
12088	<note>
12089	On the Windows host platform, interval filters are not currently
12090	available. Also all string filter attributes
12091	(<link to="#manufacturer"/>, <link to="#product"/>,
12092	<link to="#serialNumber"/>) are ignored, so they behave as
12093	<i>any match</i> no matter what string expression is specified.
12094	</note>
12095
12096	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12097	</desc>
12098
12099	<attribute name="name" type="wstring">
12100	<desc>
12101	Visible name for this filter.
12102	This name is used to visually distinguish one filter from another,
12103	so it can neither be @c null nor an empty string.
12104	</desc>
12105	</attribute>
12106
12107	<attribute name="active" type="boolean">
12108	<desc>Whether this filter active or has been temporarily disabled.</desc>
12109	</attribute>
12110
12111	<attribute name="vendorId" type="wstring">
12112	<desc>
12113	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12114	The string representation for the <i>exact matching</i>
12115	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12116	(including leading zeroes).
12117	</desc>
12118	</attribute>
12119
12120	<attribute name="productId" type="wstring">
12121	<desc>
12122	<link to="IUSBDevice::productId">Product ID</link> filter.
12123	The string representation for the <i>exact matching</i>
12124	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12125	(including leading zeroes).
12126	</desc>
12127	</attribute>
12128
12129	<attribute name="revision" type="wstring">
12130	<desc>
12131	<link to="IUSBDevice::productId">Product revision number</link>
12132	filter. The string representation for the <i>exact matching</i>
12133	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12134	of the integer part of the revision, and <tt>F</tt> is the
12135	decimal digit of its fractional part (including leading and
12136	trailing zeros).
12137	Note that for interval filters, it's best to use the hexadecimal
12138	form, because the revision is stored as a 16 bit packed BCD value;
12139	so the expression <tt>int:0x0100-0x0199</tt> will match any
12140	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12141	</desc>
12142	</attribute>
12143
12144	<attribute name="manufacturer" type="wstring">
12145	<desc>
12146	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12147	</desc>
12148	</attribute>
12149
12150	<attribute name="product" type="wstring">
12151	<desc>
12152	<link to="IUSBDevice::product">Product</link> filter.
12153	</desc>
12154	</attribute>
12155
12156	<attribute name="serialNumber" type="wstring">
12157	<desc>
12158	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12159	</desc>
12160	</attribute>
12161
12162	<attribute name="port" type="wstring">
12163	<desc>
12164	<link to="IUSBDevice::port">Host USB port</link> filter.
12165	</desc>
12166	</attribute>
12167
12168	<attribute name="remote" type="wstring">
12169	<desc>
12170	<link to="IUSBDevice::remote">Remote state</link> filter.
12171	<note>
12172	This filter makes sense only for machine USB filters,
12173	i.e. it is ignored by IHostUSBDeviceFilter objects.
12174	</note>
12175	</desc>
12176	</attribute>
12177
12178	<attribute name="maskedInterfaces" type="unsigned long">
12179	<desc>
12180	This is an advanced option for hiding one or more USB interfaces
12181	from the guest. The value is a bit mask where the bits that are set
12182	means the corresponding USB interface should be hidden, masked off
12183	if you like.
12184	This feature only works on Linux hosts.
12185	</desc>
12186	</attribute>
12187
12188	</interface>
12189
12190
12191	<!--
12192	// IHostUSBDevice
12193	/////////////////////////////////////////////////////////////////////////
12194	-->
12195
12196	<enum
12197	name="USBDeviceState"
12198	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12199	>
12200	<desc>
12201	USB device state. This enumeration represents all possible states
12202	of the USB device physically attached to the host computer regarding
12203	its state on the host computer and availability to guest computers
12204	(all currently running virtual machines).
12205
12206	Once a supported USB device is attached to the host, global USB
12207	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12208	either ignore the device, or put it to USBDeviceState_Held state, or do
12209	nothing. Unless the device is ignored by global filters, filters of all
12210	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12211	activated that can put it to USBDeviceState_Captured state.
12212
12213	If the device was ignored by global filters, or didn't match
12214	any filters at all (including guest ones), it is handled by the host
12215	in a normal way. In this case, the device state is determined by
12216	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12217	or USBDeviceState_Available, depending on the current device usage.
12218
12219	Besides auto-capturing based on filters, the device can be manually
12220	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12221	state is USBDeviceState_Busy, USBDeviceState_Available or
12222	USBDeviceState_Held.
12223
12224	<note>
12225	Due to differences in USB stack implementations in Linux and Win32,
12226	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12227	only to the Linux version of the product. This also means that (<link
12228	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12229	device state is USBDeviceState_Held.
12230	</note>
12231
12232	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12233	</desc>
12234
12235	<const name="NotSupported" value="0">
12236	<desc>
12237	Not supported by the VirtualBox server, not available to guests.
12238	</desc>
12239	</const>
12240	<const name="Unavailable" value="1">
12241	<desc>
12242	Being used by the host computer exclusively,
12243	not available to guests.
12244	</desc>
12245	</const>
12246	<const name="Busy" value="2">
12247	<desc>
12248	Being used by the host computer, potentially available to guests.
12249	</desc>
12250	</const>
12251	<const name="Available" value="3">
12252	<desc>
12253	Not used by the host computer, available to guests (the host computer
12254	can also start using the device at any time).
12255	</desc>
12256	</const>
12257	<const name="Held" value="4">
12258	<desc>
12259	Held by the VirtualBox server (ignored by the host computer),
12260	available to guests.
12261	</desc>
12262	</const>
12263	<const name="Captured" value="5">
12264	<desc>
12265	Captured by one of the guest computers, not available
12266	to anybody else.
12267	</desc>
12268	</const>
12269	</enum>
12270
12271	<interface
12272	name="IHostUSBDevice" extends="IUSBDevice"
12273	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12274	wsmap="managed"
12275	>
12276	<desc>
12277	The IHostUSBDevice interface represents a physical USB device attached
12278	to the host computer.
12279
12280	Besides properties inherited from IUSBDevice, this interface adds the
12281	<link to="#state"/> property that holds the current state of the USB
12282	device.
12283
12284	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12285	</desc>
12286
12287	<attribute name="state" type="USBDeviceState" readonly="yes">
12288	<desc>
12289	Current state of the device.
12290	</desc>
12291	</attribute>
12292
12293	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12294
12295	</interface>
12296
12297
12298	<!--
12299	// IHostUSBDeviceFilter
12300	/////////////////////////////////////////////////////////////////////////
12301	-->
12302
12303	<enum
12304	name="USBDeviceFilterAction"
12305	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12306	>
12307	<desc>
12308	Actions for host USB device filters.
12309	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12310	</desc>
12311
12312	<const name="Null" value="0">
12313	<desc>Null value (never used by the API).</desc>
12314	</const>
12315	<const name="Ignore" value="1">
12316	<desc>Ignore the matched USB device.</desc>
12317	</const>
12318	<const name="Hold" value="2">
12319	<desc>Hold the matched USB device.</desc>
12320	</const>
12321	</enum>
12322
12323	<interface
12324	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12325	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12326	wsmap="managed"
12327	>
12328	<desc>
12329	The IHostUSBDeviceFilter interface represents a global filter for a
12330	physical USB device used by the host computer. Used indirectly in
12331	<link to="IHost::USBDeviceFilters"/>.
12332
12333	Using filters of this type, the host computer determines the initial
12334	state of the USB device after it is physically attached to the
12335	host's USB controller.
12336
12337	<note>
12338	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12339	filters, because it makes sense only for
12340	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12341	</note>
12342
12343	<see>IHost::USBDeviceFilters</see>
12344	</desc>
12345
12346	<attribute name="action" type="USBDeviceFilterAction">
12347	<desc>
12348	Action performed by the host when an attached USB device
12349	matches this filter.
12350	</desc>
12351	</attribute>
12352
12353	</interface>
12354
12355	<!--
12356	// IAudioAdapter
12357	/////////////////////////////////////////////////////////////////////////
12358	-->
12359
12360	<enum
12361	name="AudioDriverType"
12362	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12363	>
12364	<desc>
12365	Host audio driver type.
12366	</desc>
12367
12368	<const name="Null" value="0">
12369	<desc>Null value, also means "dummy audio driver".</desc>
12370	</const>
12371	<const name="WinMM" value="1">
12372	<desc>Windows multimedia (Windows hosts only).</desc>
12373	</const>
12374	<const name="OSS" value="2">
12375	<desc>Open Sound System (Linux hosts only).</desc>
12376	</const>
12377	<const name="ALSA" value="3">
12378	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12379	</const>
12380	<const name="DirectSound" value="4">
12381	<desc>DirectSound (Windows hosts only).</desc>
12382	</const>
12383	<const name="CoreAudio" value="5">
12384	<desc>CoreAudio (Mac hosts only).</desc>
12385	</const>
12386	<const name="MMPM" value="6">
12387	<desc>Reserved for historical reasons.</desc>
12388	</const>
12389	<const name="Pulse" value="7">
12390	<desc>PulseAudio (Linux hosts only).</desc>
12391	</const>
12392	<const name="SolAudio" value="8">
12393	<desc>Solaris audio (Solaris hosts only).</desc>
12394	</const>
12395	</enum>
12396
12397	<enum
12398	name="AudioControllerType"
12399	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12400	>
12401	<desc>
12402	Virtual audio controller type.
12403	</desc>
12404
12405	<const name="AC97" value="0"/>
12406	<const name="SB16" value="1"/>
12407	<const name="HDA" value="2"/>
12408	</enum>
12409
12410	<interface
12411	name="IAudioAdapter" extends="$unknown"
12412	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12413	wsmap="managed"
12414	>
12415	<desc>
12416	The IAudioAdapter interface represents the virtual audio adapter of
12417	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12418	</desc>
12419	<attribute name="enabled" type="boolean">
12420	<desc>
12421	Flag whether the audio adapter is present in the
12422	guest system. If disabled, the virtual guest hardware will
12423	not contain any audio adapter. Can only be changed when
12424	the VM is not running.
12425	</desc>
12426	</attribute>
12427	<attribute name="audioController" type="AudioControllerType">
12428	<desc>
12429	The audio hardware we emulate.
12430	</desc>
12431	</attribute>
12432	<attribute name="audioDriver" type="AudioDriverType">
12433	<desc>
12434	Audio driver the adapter is connected to. This setting
12435	can only be changed when the VM is not running.
12436	</desc>
12437	</attribute>
12438	</interface>
12439
12440	<enum
12441	name="AuthType"
12442	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12443	>
12444	<desc>
12445	VirtualBox authentication type.
12446	</desc>
12447
12448	<const name="Null" value="0">
12449	<desc>Null value, also means "no authentication".</desc>
12450	</const>
12451	<const name="External" value="1"/>
12452	<const name="Guest" value="2"/>
12453	</enum>
12454
12455	<!--
12456	// IVRDEServer
12457	/////////////////////////////////////////////////////////////////////////
12458	-->
12459
12460	<interface
12461	name="IVRDEServer" extends="$unknown"
12462	uuid="f68a6b34-6f09-4040-8de1-e8d746c4a9ea"
12463	wsmap="managed"
12464	>
12465	<attribute name="enabled" type="boolean">
12466	<desc>VRDE server status.</desc>
12467	</attribute>
12468
12469	<attribute name="authType" type="AuthType">
12470	<desc>VRDE authentication method.</desc>
12471	</attribute>
12472
12473	<attribute name="authTimeout" type="unsigned long">
12474	<desc>Timeout for guest authentication. Milliseconds.</desc>
12475	</attribute>
12476
12477	<attribute name="allowMultiConnection" type="boolean">
12478	<desc>
12479	Flag whether multiple simultaneous connections to the VM are permitted.
12480	Note that this will be replaced by a more powerful mechanism in the future.
12481	</desc>
12482	</attribute>
12483
12484	<attribute name="reuseSingleConnection" type="boolean">
12485	<desc>
12486	Flag whether the existing connection must be dropped and a new connection
12487	must be established by the VRDE server, when a new client connects in single
12488	connection mode.
12489	</desc>
12490	</attribute>
12491
12492	<attribute name="videoChannel" type="boolean">
12493	<desc>
12494	Flag whether video redirectiron channel is enabled.
12495	</desc>
12496	</attribute>
12497
12498	<attribute name="videoChannelQuality" type="unsigned long">
12499	<desc>
12500	Image quality in percents.
12501	</desc>
12502	</attribute>
12503
12504	<attribute name="VRDELibrary" type="wstring">
12505	<desc>
12506	VRDE library used by this VM. Overrides
12507	<link to="ISystemProperties::defaultVRDELibrary"/>.
12508	</desc>
12509	</attribute>
12510
12511	<method name="setVRDEProperty">
12512	<desc>
12513	Sets a VRDE specific property string.
12514
12515	If you pass @c null or empty string as a key @a value, the given @a key
12516	will be deleted.
12517
12518	</desc>
12519	<param name="key" type="wstring" dir="in">
12520	<desc>Name of the key to set.</desc>
12521	</param>
12522	<param name="value" type="wstring" dir="in">
12523	<desc>Value to assign to the key.</desc>
12524	</param>
12525	</method>
12526
12527	<method name="getVRDEProperty">
12528	<desc>
12529	Returns a VRDE specific property string.
12530
12531	If the requested data @a key does not exist, this function will
12532	succeed and return an empty string in the @a value argument.
12533
12534	</desc>
12535	<param name="key" type="wstring" dir="in">
12536	<desc>Name of the key to get.</desc>
12537	</param>
12538	<param name="value" type="wstring" dir="return">
12539	<desc>Value of the requested key.</desc>
12540	</param>
12541	</method>
12542
12543	</interface>
12544
12545
12546	<!--
12547	// ISharedFolder
12548	/////////////////////////////////////////////////////////////////////////
12549	-->
12550
12551	<interface
12552	name="ISharedFolder" extends="$unknown"
12553	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12554	wsmap="struct"
12555	>
12556	<desc>
12557	The ISharedFolder interface represents a folder in the host computer's
12558	file system accessible from the guest OS running inside a virtual
12559	machine using an associated logical name.
12560
12561	There are three types of shared folders:
12562	<ul>
12563	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12564	folders available to all virtual machines.</li>
12565	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12566	VM-specific shared folders available to the given virtual machine at
12567	startup.</li>
12568	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12569	VM-specific shared folders created in the session context (for
12570	example, when the virtual machine is running) and automatically
12571	discarded when the session is closed (the VM is powered off).</li>
12572	</ul>
12573
12574	Logical names of shared folders must be unique within the given scope
12575	(global, permanent or transient). However, they do not need to be unique
12576	across scopes. In this case, the definition of the shared folder in a
12577	more specific scope takes precedence over definitions in all other
12578	scopes. The order of precedence is (more specific to more general):
12579	<ol>
12580	<li>Transient definitions</li>
12581	<li>Permanent definitions</li>
12582	<li>Global definitions</li>
12583	</ol>
12584
12585	For example, if MyMachine has a shared folder named
12586	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12587	transient shared folder named <tt>C_DRIVE</tt> (that points
12588	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12589	of <tt>C_DRIVE</tt> in the guest OS so
12590	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12591	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12592	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12593	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12594	to <tt>C:\\</tt> if it still exists.
12595
12596	Note that permanent and transient shared folders of different machines
12597	are in different name spaces, so they don't overlap and don't need to
12598	have unique logical names.
12599
12600	<note>
12601	Global shared folders are not implemented in the current version of the
12602	product.
12603	</note>
12604	</desc>
12605
12606	<attribute name="name" type="wstring" readonly="yes">
12607	<desc>Logical name of the shared folder.</desc>
12608	</attribute>
12609
12610	<attribute name="hostPath" type="wstring" readonly="yes">
12611	<desc>Full path to the shared folder in the host file system.</desc>
12612	</attribute>
12613
12614	<attribute name="accessible" type="boolean" readonly="yes">
12615	<desc>
12616	Whether the folder defined by the host path is currently
12617	accessible or not.
12618	For example, the folder can be inaccessible if it is placed
12619	on the network share that is not available by the time
12620	this property is read.
12621	</desc>
12622	</attribute>
12623
12624	<attribute name="writable" type="boolean" readonly="yes">
12625	<desc>
12626	Whether the folder defined by the host path is writable or
12627	not.
12628	</desc>
12629	</attribute>
12630
12631	<attribute name="autoMount" type="boolean" readonly="yes">
12632	<desc>
12633	Whether the folder gets automatically mounted by the guest or not.
12634	</desc>
12635	</attribute>
12636
12637	<attribute name="lastAccessError" type="wstring" readonly="yes">
12638	<desc>
12639	Text message that represents the result of the last accessibility
12640	check.
12641
12642	Accessibility checks are performed each time the <link to="#accessible"/>
12643	attribute is read. An empty string is returned if the last
12644	accessibility check was successful. A non-empty string indicates a
12645	failure and should normally describe a reason of the failure (for
12646	example, a file read error).
12647	</desc>
12648	</attribute>
12649
12650	</interface>
12651
12652	<!--
12653	// ISession
12654	/////////////////////////////////////////////////////////////////////////
12655	-->
12656
12657	<interface
12658	name="IInternalSessionControl" extends="$unknown"
12659	uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
12660	internal="yes"
12661	wsmap="suppress"
12662	>
12663	<method name="getPID">
12664	<desc>PID of the process that has created this Session object.
12665	</desc>
12666	<param name="pid" type="unsigned long" dir="return"/>
12667	</method>
12668
12669	<method name="getRemoteConsole">
12670	<desc>
12671	Returns the console object suitable for remote control.
12672
12673	<result name="VBOX_E_INVALID_VM_STATE">
12674	Session state prevents operation.
12675	</result>
12676	<result name="VBOX_E_INVALID_OBJECT_STATE">
12677	Session type prevents operation.
12678	</result>
12679
12680	</desc>
12681	<param name="console" type="IConsole" dir="return"/>
12682	</method>
12683
12684	<method name="assignMachine">
12685	<desc>
12686	Assigns the machine object associated with this direct-type
12687	session or informs the session that it will be a remote one
12688	(if @a machine == @c null).
12689
12690	<result name="VBOX_E_INVALID_VM_STATE">
12691	Session state prevents operation.
12692	</result>
12693	<result name="VBOX_E_INVALID_OBJECT_STATE">
12694	Session type prevents operation.
12695	</result>
12696
12697	</desc>
12698	<param name="machine" type="IMachine" dir="in"/>
12699	</method>
12700
12701	<method name="assignRemoteMachine">
12702	<desc>
12703	Assigns the machine and the (remote) console object associated with
12704	this remote-type session.
12705
12706	<result name="VBOX_E_INVALID_VM_STATE">
12707	Session state prevents operation.
12708	</result>
12709
12710	</desc>
12711	<param name="machine" type="IMachine" dir="in"/>
12712	<param name="console" type="IConsole" dir="in"/>
12713	</method>
12714
12715	<method name="updateMachineState">
12716	<desc>
12717	Updates the machine state in the VM process.
12718	Must be called only in certain cases
12719	(see the method implementation).
12720
12721	<result name="VBOX_E_INVALID_VM_STATE">
12722	Session state prevents operation.
12723	</result>
12724	<result name="VBOX_E_INVALID_OBJECT_STATE">
12725	Session type prevents operation.
12726	</result>
12727
12728	</desc>
12729	<param name="aMachineState" type="MachineState" dir="in"/>
12730	</method>
12731
12732	<method name="uninitialize">
12733	<desc>
12734	Uninitializes (closes) this session. Used by VirtualBox to close
12735	the corresponding remote session when the direct session dies
12736	or gets closed.
12737
12738	<result name="VBOX_E_INVALID_VM_STATE">
12739	Session state prevents operation.
12740	</result>
12741
12742	</desc>
12743	</method>
12744
12745	<method name="onNetworkAdapterChange">
12746	<desc>
12747	Triggered when settings of a network adapter of the
12748	associated virtual machine have changed.
12749
12750	<result name="VBOX_E_INVALID_VM_STATE">
12751	Session state prevents operation.
12752	</result>
12753	<result name="VBOX_E_INVALID_OBJECT_STATE">
12754	Session type prevents operation.
12755	</result>
12756
12757	</desc>
12758	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12759	<param name="changeAdapter" type="boolean" dir="in"/>
12760	</method>
12761
12762	<method name="onNATRedirectRuleChange">
12763	<desc>
12764	Triggered on adding/removing of NAT Engine redirection rule of the
12765	associated virtual machine.
12766
12767	<result name="VBOX_E_INVALID_VM_STATE">
12768	Session state prevents operation.
12769	</result>
12770	<result name="VBOX_E_INVALID_OBJECT_STATE">
12771	Session type prevents operation.
12772	</result>
12773
12774	</desc>
12775	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12776	<param name="natRedirectRemove" type="boolean" dir="in"/>
12777	<param name="natRuleName" type="wstring" dir="in"/>
12778	<param name="natProto" type="NATProtocol" dir="in"/>
12779	<param name="natHostIp" type="wstring" dir="in"/>
12780	<param name="natHostPort" type="long" dir="in"/>
12781	<param name="natGuestIp" type="wstring" dir="in"/>
12782	<param name="natGuestPort" type="long" dir="in"/>
12783	</method>
12784
12785	<method name="onSerialPortChange">
12786	<desc>
12787	Triggered when settings of a serial port of the
12788	associated virtual machine have changed.
12789
12790	<result name="VBOX_E_INVALID_VM_STATE">
12791	Session state prevents operation.
12792	</result>
12793	<result name="VBOX_E_INVALID_OBJECT_STATE">
12794	Session type prevents operation.
12795	</result>
12796
12797	</desc>
12798	<param name="serialPort" type="ISerialPort" dir="in"/>
12799	</method>
12800
12801	<method name="onParallelPortChange">
12802	<desc>
12803	Triggered when settings of a parallel port of the
12804	associated virtual machine have changed.
12805
12806	<result name="VBOX_E_INVALID_VM_STATE">
12807	Session state prevents operation.
12808	</result>
12809	<result name="VBOX_E_INVALID_OBJECT_STATE">
12810	Session type prevents operation.
12811	</result>
12812
12813	</desc>
12814	<param name="parallelPort" type="IParallelPort" dir="in"/>
12815	</method>
12816
12817	<method name="onStorageControllerChange">
12818	<desc>
12819	Triggered when settings of a storage controller of the
12820	associated virtual machine have changed.
12821
12822	<result name="VBOX_E_INVALID_VM_STATE">
12823	Session state prevents operation.
12824	</result>
12825	<result name="VBOX_E_INVALID_OBJECT_STATE">
12826	Session type prevents operation.
12827	</result>
12828
12829	</desc>
12830	</method>
12831
12832	<method name="onMediumChange">
12833	<desc>
12834	Triggered when attached media of the
12835	associated virtual machine have changed.
12836
12837	<result name="VBOX_E_INVALID_VM_STATE">
12838	Session state prevents operation.
12839	</result>
12840	<result name="VBOX_E_INVALID_OBJECT_STATE">
12841	Session type prevents operation.
12842	</result>
12843
12844	</desc>
12845
12846	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12847	<param name="force" type="boolean" dir="in"/>
12848	</method>
12849
12850	<method name="onCPUChange">
12851	<desc>
12852	Notification when a CPU changes.
12853	</desc>
12854	<param name="cpu" type="unsigned long" dir="in">
12855	<desc>The CPU which changed</desc>
12856	</param>
12857	<param name="add" type="boolean" dir="in">
12858	<desc>Flag whether the CPU was added or removed</desc>
12859	</param>
12860	</method>
12861
12862	<method name="onCPUExecutionCapChange">
12863	<desc>
12864	Notification when the CPU execution cap changes.
12865	</desc>
12866	<param name="executionCap" type="unsigned long" dir="in">
12867	<desc>The new CPU execution cap value. (1-100)</desc>
12868	</param>
12869	</method>
12870
12871	<method name="onVRDEServerChange">
12872	<desc>
12873	Triggered when settings of the VRDE server object of the
12874	associated virtual machine have changed.
12875
12876	<result name="VBOX_E_INVALID_VM_STATE">
12877	Session state prevents operation.
12878	</result>
12879	<result name="VBOX_E_INVALID_OBJECT_STATE">
12880	Session type prevents operation.
12881	</result>
12882
12883	</desc>
12884	<param name="restart" type="boolean" dir="in">
12885	<desc>Flag whether the server must be restarted</desc>
12886	</param>
12887	</method>
12888
12889	<method name="onUSBControllerChange">
12890	<desc>
12891	Triggered when settings of the USB controller object of the
12892	associated virtual machine have changed.
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	</method>
12903
12904	<method name="onSharedFolderChange">
12905	<desc>
12906	Triggered when a permanent (global or machine) shared folder has been
12907	created or removed.
12908	<note>
12909	We don't pass shared folder parameters in this notification because
12910	the order in which parallel notifications are delivered is not defined,
12911	therefore it could happen that these parameters were outdated by the
12912	time of processing this notification.
12913	</note>
12914
12915	<result name="VBOX_E_INVALID_VM_STATE">
12916	Session state prevents operation.
12917	</result>
12918	<result name="VBOX_E_INVALID_OBJECT_STATE">
12919	Session type prevents operation.
12920	</result>
12921
12922	</desc>
12923	<param name="global" type="boolean" dir="in"/>
12924	</method>
12925
12926	<method name="onUSBDeviceAttach">
12927	<desc>
12928	Triggered when a request to capture a USB device (as a result
12929	of matched USB filters or direct call to
12930	<link to="IConsole::attachUSBDevice"/>) has completed.
12931	A @c null @a error object means success, otherwise it
12932	describes a failure.
12933
12934	<result name="VBOX_E_INVALID_VM_STATE">
12935	Session state prevents operation.
12936	</result>
12937	<result name="VBOX_E_INVALID_OBJECT_STATE">
12938	Session type prevents operation.
12939	</result>
12940
12941	</desc>
12942	<param name="device" type="IUSBDevice" dir="in"/>
12943	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12944	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12945	</method>
12946
12947	<method name="onUSBDeviceDetach">
12948	<desc>
12949	Triggered when a request to release the USB device (as a result
12950	of machine termination or direct call to
12951	<link to="IConsole::detachUSBDevice"/>) has completed.
12952	A @c null @a error object means success, otherwise it
12953	describes a failure.
12954
12955	<result name="VBOX_E_INVALID_VM_STATE">
12956	Session state prevents operation.
12957	</result>
12958	<result name="VBOX_E_INVALID_OBJECT_STATE">
12959	Session type prevents operation.
12960	</result>
12961
12962	</desc>
12963	<param name="id" type="uuid" mod="string" dir="in"/>
12964	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12965	</method>
12966
12967	<method name="onShowWindow">
12968	<desc>
12969	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12970	<link to="IMachine::showConsoleWindow"/> in order to notify
12971	console listeners
12972	<link to="ICanShowWindowEvent"/>
12973	and <link to="IShowWindowEvent"/>.
12974
12975	<result name="VBOX_E_INVALID_OBJECT_STATE">
12976	Session type prevents operation.
12977	</result>
12978
12979	</desc>
12980	<param name="check" type="boolean" dir="in"/>
12981	<param name="canShow" type="boolean" dir="out"/>
12982	<param name="winId" type="long long" dir="out"/>
12983	</method>
12984
12985	<method name="accessGuestProperty">
12986	<desc>
12987	Called by <link to="IMachine::getGuestProperty"/> and by
12988	<link to="IMachine::setGuestProperty"/> in order to read and
12989	modify guest properties.
12990
12991	<result name="VBOX_E_INVALID_VM_STATE">
12992	Machine session is not open.
12993	</result>
12994	<result name="VBOX_E_INVALID_OBJECT_STATE">
12995	Session type is not direct.
12996	</result>
12997
12998	</desc>
12999	<param name="name" type="wstring" dir="in"/>
13000	<param name="value" type="wstring" dir="in"/>
13001	<param name="flags" type="wstring" dir="in"/>
13002	<param name="isSetter" type="boolean" dir="in"/>
13003	<param name="retValue" type="wstring" dir="out"/>
13004	<param name="retTimestamp" type="long long" dir="out"/>
13005	<param name="retFlags" type="wstring" dir="out"/>
13006	</method>
13007
13008	<method name="enumerateGuestProperties">
13009	<desc>
13010	Return a list of the guest properties matching a set of patterns along
13011	with their values, time stamps and flags.
13012
13013	<result name="VBOX_E_INVALID_VM_STATE">
13014	Machine session is not open.
13015	</result>
13016	<result name="VBOX_E_INVALID_OBJECT_STATE">
13017	Session type is not direct.
13018	</result>
13019
13020	</desc>
13021	<param name="patterns" type="wstring" dir="in">
13022	<desc>
13023	The patterns to match the properties against as a comma-separated
13024	string. If this is empty, all properties currently set will be
13025	returned.
13026	</desc>
13027	</param>
13028	<param name="key" type="wstring" dir="out" safearray="yes">
13029	<desc>
13030	The key names of the properties returned.
13031	</desc>
13032	</param>
13033	<param name="value" type="wstring" dir="out" safearray="yes">
13034	<desc>
13035	The values of the properties returned. The array entries match the
13036	corresponding entries in the @a key array.
13037	</desc>
13038	</param>
13039	<param name="timestamp" type="long long" dir="out" safearray="yes">
13040	<desc>
13041	The time stamps of the properties returned. The array entries match
13042	the corresponding entries in the @a key array.
13043	</desc>
13044	</param>
13045	<param name="flags" type="wstring" dir="out" safearray="yes">
13046	<desc>
13047	The flags of the properties returned. The array entries match the
13048	corresponding entries in the @a key array.
13049	</desc>
13050	</param>
13051	</method>
13052
13053	<method name="onlineMergeMedium">
13054	<desc>
13055	Triggers online merging of a hard disk. Used internally when deleting
13056	a snapshot while a VM referring to the same hard disk chain is running.
13057
13058	<result name="VBOX_E_INVALID_VM_STATE">
13059	Machine session is not open.
13060	</result>
13061	<result name="VBOX_E_INVALID_OBJECT_STATE">
13062	Session type is not direct.
13063	</result>
13064
13065	</desc>
13066	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13067	<desc>The medium attachment to identify the medium chain.</desc>
13068	</param>
13069	<param name="sourceIdx" type="unsigned long" dir="in">
13070	<desc>The index of the source image in the chain.
13071	Redundant, but drastically reduces IPC.</desc>
13072	</param>
13073	<param name="targetIdx" type="unsigned long" dir="in">
13074	<desc>The index of the target image in the chain.
13075	Redundant, but drastically reduces IPC.</desc>
13076	</param>
13077	<param name="source" type="IMedium" dir="in">
13078	<desc>Merge source medium.</desc>
13079	</param>
13080	<param name="target" type="IMedium" dir="in">
13081	<desc>Merge target medium.</desc>
13082	</param>
13083	<param name="mergeForward" type="boolean" dir="in">
13084	<desc>Merge direction.</desc>
13085	</param>
13086	<param name="parentForTarget" type="IMedium" dir="in">
13087	<desc>For forward merges: new parent for target medium.</desc>
13088	</param>
13089	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13090	<desc>For backward merges: list of media which need their parent UUID
13091	updated.</desc>
13092	</param>
13093	<param name="progress" type="IProgress" dir="in">
13094	<desc>
13095	Progress object for this operation.
13096	</desc>
13097	</param>
13098	</method>
13099
13100	</interface>
13101
13102	<interface
13103	name="ISession" extends="$unknown"
13104	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13105	wsmap="managed"
13106	>
13107	<desc>
13108	The ISession interface represents a client process and allows for locking
13109	virtual machines (represented by IMachine objects) to prevent conflicting
13110	changes to the machine.
13111
13112	Any caller wishing to manipulate a virtual machine needs to create a session
13113	object first, which lives in its own process space. Such session objects are
13114	then associated with <link to="IMachine" /> objects living in the VirtualBox
13115	server process to coordinate such changes.
13116
13117	There are two typical scenarios in which sessions are used:
13118
13119	<ul>
13120	<li>To alter machine settings or control a running virtual machine, one
13121	needs to lock a machine for a given session (client process) by calling
13122	<link to="IMachine::lockMachine"/>.
13123
13124	Whereas multiple sessions may control a running virtual machine, only
13125	one process can obtain a write lock on the machine to prevent conflicting
13126	changes. A write lock is also needed if a process wants to actually run a
13127	virtual machine in its own context, such as the VirtualBox GUI or
13128	VBoxHeadless front-ends. They must also lock a machine for their own
13129	sessions before they are allowed to power up the virtual machine.
13130
13131	As a result, no machine settings can be altered while another process is
13132	already using it, either because that process is modifying machine settings
13133	or because the machine is running.
13134	</li>
13135	<li>
13136	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13137	VirtualBox GUI or VBoxHeadless), one would use
13138	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13139	as its first parameter. This session then identifies the caller and lets the
13140	caller control the started machine (for example, pause machine execution or
13141	power it down) as well as be notified about machine execution state changes.
13142	</li>
13143	</ul>
13144
13145	How sessions objects are created in a client process depends on whether you use
13146	the Main API via COM or via the webservice:
13147
13148	<ul>
13149	<li>When using the COM API directly, an object of the Session class from the
13150	VirtualBox type library needs to be created. In regular COM C++ client code,
13151	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13152	This object will then act as a local session object in further calls to open
13153	a session.
13154	</li>
13155
13156	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13157	a session object automatically whenever <link to="IWebsessionManager::logon" />
13158	is called. A managed object reference to that session object can be retrieved by
13159	calling <link to="IWebsessionManager::getSessionObject" />.
13160	</li>
13161	</ul>
13162	</desc>
13163
13164	<attribute name="state" type="SessionState" readonly="yes">
13165	<desc>Current state of this session.</desc>
13166	</attribute>
13167
13168	<attribute name="type" type="SessionType" readonly="yes">
13169	<desc>
13170	Type of this session. The value of this attribute is valid only
13171	if the session currently has a machine locked (i.e. its
13172	<link to="#state" /> is Locked), otherwise an error will be returned.
13173	</desc>
13174	</attribute>
13175
13176	<attribute name="machine" type="IMachine" readonly="yes">
13177	<desc>Machine object associated with this session.</desc>
13178	</attribute>
13179
13180	<attribute name="console" type="IConsole" readonly="yes">
13181	<desc>Console object associated with this session.</desc>
13182	</attribute>
13183
13184	<method name="unlockMachine">
13185	<desc>
13186	Unlocks a machine that was previously locked for the current session.
13187
13188	Calling this method is required every time a machine has been locked
13189	for a particular session using the <link to="IMachine::launchVMProcess" />
13190	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13191	the machine will be set to <link to="MachineState_Aborted" /> on the
13192	server, and changes made to the machine settings will be lost.
13193
13194	Generally, it is recommended to unlock all machines explicitly
13195	before terminating the application (regardless of the reason for
13196	the termination).
13197
13198	<note>
13199	Do not expect the session state (<link to="ISession::state" />
13200	to return to "Unlocked" immediately after you invoke this method,
13201	particularly if you have started a new VM process. The session
13202	state will automatically return to "Unlocked" once the VM is no
13203	longer executing, which can of course take a very long time.
13204	</note>
13205
13206	<result name="E_UNEXPECTED">
13207	Session is not locked.
13208	</result>
13209
13210	</desc>
13211	</method>
13212
13213	</interface>
13214
13215	<!--
13216	// IStorageController
13217	/////////////////////////////////////////////////////////////////////////
13218	-->
13219
13220	<enum
13221	name="StorageBus"
13222	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13223	>
13224	<desc>
13225	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13226	see <link to="IStorageController::bus" />.
13227	</desc>
13228	<const name="Null" value="0">
13229	<desc>@c null value. Never used by the API.</desc>
13230	</const>
13231	<const name="IDE" value="1"/>
13232	<const name="SATA" value="2"/>
13233	<const name="SCSI" value="3"/>
13234	<const name="Floppy" value="4"/>
13235	<const name="SAS" value="5"/>
13236	</enum>
13237
13238	<enum
13239	name="StorageControllerType"
13240	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13241	>
13242	<desc>
13243	The exact variant of storage controller hardware presented
13244	to the guest; see <link to="IStorageController::controllerType" />.
13245	</desc>
13246
13247	<const name="Null" value="0">
13248	<desc>@c null value. Never used by the API.</desc>
13249	</const>
13250	<const name="LsiLogic" value="1">
13251	<desc>A SCSI controller of the LsiLogic variant.</desc>
13252	</const>
13253	<const name="BusLogic" value="2">
13254	<desc>A SCSI controller of the BusLogic variant.</desc>
13255	</const>
13256	<const name="IntelAhci" value="3">
13257	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13258	</const>
13259	<const name="PIIX3" value="4">
13260	<desc>An IDE controller of the PIIX3 variant.</desc>
13261	</const>
13262	<const name="PIIX4" value="5">
13263	<desc>An IDE controller of the PIIX4 variant.</desc>
13264	</const>
13265	<const name="ICH6" value="6">
13266	<desc>An IDE controller of the ICH6 variant.</desc>
13267	</const>
13268	<const name="I82078" value="7">
13269	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13270	</const>
13271	<const name="LsiLogicSas" value="8">
13272	<desc>A variant of the LsiLogic controller using SAS.</desc>
13273	</const>
13274	</enum>
13275
13276	<enum
13277	name="ChipsetType"
13278	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13279	>
13280	<desc>
13281	Type of emulated chipset (mostly southbridge).
13282	</desc>
13283
13284	<const name="Null" value="0">
13285	<desc>@c null value. Never used by the API.</desc>
13286	</const>
13287	<const name="PIIX3" value="1">
13288	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13289	</const>
13290	<const name="ICH9" value="2">
13291	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13292	</const>
13293	</enum>
13294
13295	<interface
13296	name="IStorageController" extends="$unknown"
13297	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13298	wsmap="managed"
13299	>
13300	<desc>
13301	Represents a storage controller that is attached to a virtual machine
13302	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13303	attached to storage controllers in a real computer, virtual drives
13304	(represented by <link to="IMediumAttachment" />) are attached to virtual
13305	storage controllers, represented by this interface.
13306
13307	As opposed to physical hardware, VirtualBox has a very generic concept
13308	of a storage controller, and for purposes of the Main API, all virtual
13309	storage is attached to virtual machines via instances of this interface.
13310	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13311	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13312	is used, certain sub-types may be available and can be selected in
13313	<link to="#controllerType" />.
13314
13315	Depending on these settings, the guest operating system might see
13316	significantly different virtual hardware.
13317	</desc>
13318
13319	<attribute name="name" type="wstring" readonly="yes">
13320	<desc>
13321	Name of the storage controller, as originally specified with
13322	<link to="IMachine::addStorageController" />. This then uniquely
13323	identifies this controller with other method calls such as
13324	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13325	</desc>
13326	</attribute>
13327
13328	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13329	<desc>
13330	Maximum number of devices which can be attached to one port.
13331	</desc>
13332	</attribute>
13333
13334	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13335	<desc>
13336	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13337	</desc>
13338	</attribute>
13339
13340	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13341	<desc>
13342	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13343	</desc>
13344	</attribute>
13345
13346	<attribute name="instance" type="unsigned long">
13347	<desc>
13348	The instance number of the device in the running VM.
13349	</desc>
13350	</attribute>
13351
13352	<attribute name="portCount" type="unsigned long">
13353	<desc>
13354	The number of currently usable ports on the controller.
13355	The minimum and maximum number of ports for one controller are
13356	stored in <link to="IStorageController::minPortCount"/>
13357	and <link to="IStorageController::maxPortCount"/>.
13358	</desc>
13359	</attribute>
13360
13361	<attribute name="bus" type="StorageBus" readonly="yes">
13362	<desc>
13363	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13364	</desc>
13365	</attribute>
13366
13367	<attribute name="controllerType" type="StorageControllerType">
13368	<desc>
13369	The exact variant of storage controller hardware presented
13370	to the guest.
13371	Depending on this value, VirtualBox will provide a different
13372	virtual storage controller hardware to the guest.
13373	For SATA, SAS and floppy controllers, only one variant is
13374	available, but for IDE and SCSI, there are several.
13375
13376	For SCSI controllers, the default type is LsiLogic.
13377	</desc>
13378	</attribute>
13379
13380	<attribute name="useHostIOCache" type="boolean">
13381	<desc>
13382	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13383	caches and use synchronous file APIs on the host. This was the only option in the API before
13384	VirtualBox 3.2 and is still the default for IDE controllers.
13385
13386	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13387	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13388	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13389	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13390	virtual machines are running at the same time to prevent I/O cache related hangs.
13391	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13392	</desc>
13393	</attribute>
13394
13395	<method name="getIDEEmulationPort">
13396	<desc>
13397	Gets the corresponding port number which is emulated as an IDE device.
13398	Works only with SATA controllers.
13399
13400	<result name="E_INVALIDARG">
13401	The @a devicePosition is not in the range 0 to 3.
13402	</result>
13403	<result name="E_NOTIMPL">
13404	The storage controller type is not SATAIntelAhci.
13405	</result>
13406
13407	</desc>
13408	<param name="devicePosition" type="long" dir="in"/>
13409	<param name="portNumber" type="long" dir="return"/>
13410	</method>
13411
13412	<method name="setIDEEmulationPort">
13413	<desc>
13414	Sets the port number which is emulated as an IDE device.
13415	Works only with SATA controllers.
13416
13417	<result name="E_INVALIDARG">
13418	The @a devicePosition is not in the range 0 to 3 or the
13419	@a portNumber is not in the range 0 to 29.
13420	</result>
13421	<result name="E_NOTIMPL">
13422	The storage controller type is not SATAIntelAhci.
13423	</result>
13424
13425	</desc>
13426	<param name="devicePosition" type="long" dir="in"/>
13427	<param name="portNumber" type="long" dir="in"/>
13428	</method>
13429
13430	</interface>
13431
13432	<if target="wsdl">
13433
13434	<!--
13435	// IManagedObjectRef
13436	/////////////////////////////////////////////////////////////////////////
13437	-->
13438
13439	<interface
13440	name="IManagedObjectRef" extends="$unknown"
13441	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13442	internal="yes"
13443	wsmap="managed"
13444	wscpp="hardcoded"
13445	>
13446	<desc>
13447	Managed object reference.
13448
13449	Only within the webservice, a managed object reference (which is really
13450	an opaque number) allows a webservice client to address an object
13451	that lives in the address space of the webservice server.
13452
13453	Behind each managed object reference, there is a COM object that lives
13454	in the webservice server's address space. The COM object is not freed
13455	until the managed object reference is released, either by an explicit
13456	call to <link to="IManagedObjectRef::release" /> or by logging off from
13457	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13458	all objects created during the webservice session.
13459
13460	Whenever a method call of the VirtualBox API returns a COM object, the
13461	webservice representation of that method will instead return a
13462	managed object reference, which can then be used to invoke methods
13463	on that object.
13464	</desc>
13465
13466	<method name="getInterfaceName">
13467	<desc>
13468	Returns the name of the interface that this managed object represents,
13469	for example, "IMachine", as a string.
13470	</desc>
13471	<param name="return" type="wstring" dir="return"/>
13472	</method>
13473
13474	<method name="release">
13475	<desc>
13476	Releases this managed object reference and frees the resources that
13477	were allocated for it in the webservice server process. After calling
13478	this method, the identifier of the reference can no longer be used.
13479	</desc>
13480	</method>
13481
13482	</interface>
13483
13484	<!--
13485	// IWebsessionManager
13486	/////////////////////////////////////////////////////////////////////////
13487	-->
13488
13489	<interface
13490	name="IWebsessionManager" extends="$unknown"
13491	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13492	internal="yes"
13493	wsmap="global"
13494	wscpp="hardcoded"
13495	>
13496	<desc>
13497	Websession manager. This provides essential services
13498	to webservice clients.
13499	</desc>
13500	<method name="logon">
13501	<desc>
13502	Logs a new client onto the webservice and returns a managed object reference to
13503	the IVirtualBox instance, which the client can then use as a basis to further
13504	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13505	interface, in one way or the other.
13506	</desc>
13507	<param name="username" type="wstring" dir="in"/>
13508	<param name="password" type="wstring" dir="in"/>
13509	<param name="return" type="IVirtualBox" dir="return"/>
13510	</method>
13511
13512	<method name="getSessionObject">
13513	<desc>
13514	Returns a managed object reference to the internal ISession object that was created
13515	for this web service session when the client logged on.
13516
13517	<see>ISession</see>
13518	</desc>
13519	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13520	<param name="return" type="ISession" dir="return"/>
13521	</method>
13522
13523	<method name="logoff">
13524	<desc>
13525	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13526	and destroys all resources associated with the session (most importantly, all
13527	managed objects created in the server while the session was active).
13528	</desc>
13529	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13530	</method>
13531
13532	</interface>
13533
13534	</if>
13535
13536	<!--
13537	// IPerformanceCollector & friends
13538	/////////////////////////////////////////////////////////////////////////
13539	-->
13540
13541	<interface
13542	name="IPerformanceMetric" extends="$unknown"
13543	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13544	>
13545	<desc>
13546	The IPerformanceMetric interface represents parameters of the given
13547	performance metric.
13548	</desc>
13549
13550	<attribute name="metricName" type="wstring" readonly="yes">
13551	<desc>
13552	Name of the metric.
13553	</desc>
13554	</attribute>
13555
13556	<attribute name="object" type="$unknown" readonly="yes">
13557	<desc>
13558	Object this metric belongs to.
13559	</desc>
13560	</attribute>
13561
13562	<attribute name="description" type="wstring" readonly="yes">
13563	<desc>
13564	Textual description of the metric.
13565	</desc>
13566	</attribute>
13567
13568	<attribute name="period" type="unsigned long" readonly="yes">
13569	<desc>
13570	Time interval between samples, measured in seconds.
13571	</desc>
13572	</attribute>
13573
13574	<attribute name="count" type="unsigned long" readonly="yes">
13575	<desc>
13576	Number of recent samples retained by the performance collector for this
13577	metric.
13578
13579	When the collected sample count exceeds this number, older samples
13580	are discarded.
13581	</desc>
13582	</attribute>
13583
13584	<attribute name="unit" type="wstring" readonly="yes">
13585	<desc>
13586	Unit of measurement.
13587	</desc>
13588	</attribute>
13589
13590	<attribute name="minimumValue" type="long" readonly="yes">
13591	<desc>
13592	Minimum possible value of this metric.
13593	</desc>
13594	</attribute>
13595
13596	<attribute name="maximumValue" type="long" readonly="yes">
13597	<desc>
13598	Maximum possible value of this metric.
13599	</desc>
13600	</attribute>
13601	</interface>
13602
13603	<interface
13604	name="IPerformanceCollector" extends="$unknown"
13605	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13606	wsmap="managed"
13607	>
13608	<desc>
13609	The IPerformanceCollector interface represents a service that collects
13610	and stores performance metrics data.
13611
13612	Performance metrics are associated with objects of interfaces like IHost
13613	and IMachine. Each object has a distinct set of performance metrics. The
13614	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13615
13616	Metric data is collected at the specified intervals and is retained
13617	internally. The interval and the number of retained samples can be set
13618	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13619	and collection settings are not persistent, they are discarded as soon as
13620	VBoxSVC process terminates. Moreover, metric settings and data associated
13621	with a particular VM only exist while VM is running. They disappear as
13622	soon as VM shuts down. It is not possible to set up metrics for machines
13623	that are powered off. One needs to start VM first, then set up metric
13624	collection parameters.
13625
13626	Metrics are organized hierarchically, with each level separated by a
13627	slash (/) character. Generally, the scheme for metric names is like this:
13628
13629	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13630
13631	"Category/Metric" together form the base metric name. A base metric is
13632	the smallest unit for which a sampling interval and the number of
13633	retained samples can be set. Only base metrics can be enabled and
13634	disabled. All sub-metrics are collected when their base metric is
13635	collected. Collected values for any set of sub-metrics can be queried
13636	with <link to="IPerformanceCollector::queryMetricsData" />.
13637
13638	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13639	category, "Load" metric, "User" submetric, "average" aggregate. An
13640	aggregate function is computed over all retained data. Valid aggregate
13641	functions are:
13642
13643	<ul>
13644	<li>avg -- average</li>
13645	<li>min -- minimum</li>
13646	<li>max -- maximum</li>
13647	</ul>
13648
13649	When setting up metric parameters, querying metric data, enabling or
13650	disabling metrics wildcards can be used in metric names to specify a
13651	subset of metrics. For example, to select all CPU-related metrics
13652	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13653	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13654
13655	The valid names for base metrics are:
13656
13657	<ul>
13658	<li>CPU/Load</li>
13659	<li>CPU/MHz</li>
13660	<li>RAM/Usage</li>
13661	</ul>
13662
13663	The general sequence for collecting and retrieving the metrics is:
13664	<ul>
13665	<li>
13666	Obtain an instance of IPerformanceCollector with
13667	<link to="IVirtualBox::performanceCollector" />
13668	</li>
13669	<li>
13670	Allocate and populate an array with references to objects the metrics
13671	will be collected for. Use references to IHost and IMachine objects.
13672	</li>
13673	<li>
13674	Allocate and populate an array with base metric names the data will
13675	be collected for.
13676	</li>
13677	<li>
13678	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13679	the metric data will be collected and stored.
13680	</li>
13681	<li>
13682	Wait for the data to get collected.
13683	</li>
13684	<li>
13685	Allocate and populate an array with references to objects the metric
13686	values will be queried for. You can re-use the object array used for
13687	setting base metrics.
13688	</li>
13689	<li>
13690	Allocate and populate an array with metric names the data will be
13691	collected for. Note that metric names differ from base metric names.
13692	</li>
13693	<li>
13694	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13695	that have been collected so far are returned. Note that the values
13696	are still retained internally and data collection continues.
13697	</li>
13698	</ul>
13699
13700	For an example of usage refer to the following files in VirtualBox SDK:
13701	<ul>
13702	<li>
13703	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13704	</li>
13705	<li>
13706	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13707	</li>
13708	</ul>
13709	</desc>
13710
13711	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13712	<desc>
13713	Array of unique names of metrics.
13714
13715	This array represents all metrics supported by the performance
13716	collector. Individual objects do not necessarily support all of them.
13717	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13718	list of supported metrics for a particular object.
13719	</desc>
13720	</attribute>
13721
13722	<method name="getMetrics">
13723	<desc>
13724	Returns parameters of specified metrics for a set of objects.
13725	<note>
13726	@c Null metrics array means all metrics. @c Null object array means
13727	all existing objects.
13728	</note>
13729	</desc>
13730	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13731	<desc>
13732	Metric name filter. Currently, only a comma-separated list of metrics
13733	is supported.
13734	</desc>
13735	</param>
13736	<param name="objects" type="$unknown" dir="in" safearray="yes">
13737	<desc>
13738	Set of objects to return metric parameters for.
13739	</desc>
13740	</param>
13741	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13742	<desc>
13743	Array of returned metric parameters.
13744	</desc>
13745	</param>
13746	</method>
13747
13748	<method name="setupMetrics">
13749	<desc>
13750	Sets parameters of specified base metrics for a set of objects. Returns
13751	an array of <link to="IPerformanceMetric" /> describing the metrics
13752	have been affected.
13753	<note>
13754	@c Null or empty metric name array means all metrics. @c Null or
13755	empty object array means all existing objects. If metric name array
13756	contains a single element and object array contains many, the single
13757	metric name array element is applied to each object array element to
13758	form metric/object pairs.
13759	</note>
13760	</desc>
13761	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13762	<desc>
13763	Metric name filter. Comma-separated list of metrics with wildcard
13764	support.
13765	</desc>
13766	</param>
13767	<param name="objects" type="$unknown" dir="in" safearray="yes">
13768	<desc>
13769	Set of objects to setup metric parameters for.
13770	</desc>
13771	</param>
13772	<param name="period" type="unsigned long" dir="in">
13773	<desc>
13774	Time interval in seconds between two consecutive samples of
13775	performance data.
13776	</desc>
13777	</param>
13778	<param name="count" type="unsigned long" dir="in">
13779	<desc>
13780	Number of samples to retain in performance data history. Older
13781	samples get discarded.
13782	</desc>
13783	</param>
13784	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13785	<desc>
13786	Array of metrics that have been modified by the call to this method.
13787	</desc>
13788	</param>
13789	</method>
13790
13791	<method name="enableMetrics">
13792	<desc>
13793	Turns on collecting specified base metrics. Returns an array of
13794	<link to="IPerformanceMetric" /> describing the metrics have been
13795	affected.
13796	<note>
13797	@c Null or empty metric name array means all metrics. @c Null or
13798	empty object array means all existing objects. If metric name array
13799	contains a single element and object array contains many, the single
13800	metric name array element is applied to each object array element to
13801	form metric/object pairs.
13802	</note>
13803	</desc>
13804	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13805	<desc>
13806	Metric name filter. Comma-separated list of metrics with wildcard
13807	support.
13808	</desc>
13809	</param>
13810	<param name="objects" type="$unknown" dir="in" safearray="yes">
13811	<desc>
13812	Set of objects to enable metrics for.
13813	</desc>
13814	</param>
13815	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13816	<desc>
13817	Array of metrics that have been modified by the call to this method.
13818	</desc>
13819	</param>
13820	</method>
13821
13822	<method name="disableMetrics">
13823	<desc>
13824	Turns off collecting specified base metrics. Returns an array of
13825	<link to="IPerformanceMetric" /> describing the metrics have been
13826	affected.
13827	<note>
13828	@c Null or empty metric name array means all metrics. @c Null or
13829	empty object array means all existing objects. If metric name array
13830	contains a single element and object array contains many, the single
13831	metric name array element is applied to each object array element to
13832	form metric/object pairs.
13833	</note>
13834	</desc>
13835	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13836	<desc>
13837	Metric name filter. Comma-separated list of metrics with wildcard
13838	support.
13839	</desc>
13840	</param>
13841	<param name="objects" type="$unknown" dir="in" safearray="yes">
13842	<desc>
13843	Set of objects to disable metrics for.
13844	</desc>
13845	</param>
13846	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13847	<desc>
13848	Array of metrics that have been modified by the call to this method.
13849	</desc>
13850	</param>
13851	</method>
13852
13853	<method name="queryMetricsData">
13854	<desc>
13855	Queries collected metrics data for a set of objects.
13856
13857	The data itself and related metric information are returned in seven
13858	parallel and one flattened array of arrays. Elements of
13859	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13860	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13861	the same index describe one set of values corresponding to a single
13862	metric.
13863
13864	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13865	start and length of a sub-array is indicated by
13866	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13867	value for metric <tt>metricNames[i]</tt> is at
13868	<tt>returnData[returnIndices[i]]</tt>.
13869
13870	<note>
13871	@c Null or empty metric name array means all metrics. @c Null or
13872	empty object array means all existing objects. If metric name array
13873	contains a single element and object array contains many, the single
13874	metric name array element is applied to each object array element to
13875	form metric/object pairs.
13876	</note>
13877	<note>
13878	Data collection continues behind the scenes after call to @c
13879	queryMetricsData. The return data can be seen as the snapshot of the
13880	current state at the time of @c queryMetricsData call. The internally
13881	kept metric values are not cleared by the call. This makes possible
13882	querying different subsets of metrics or aggregates with subsequent
13883	calls. If periodic querying is needed it is highly suggested to query
13884	the values with @c interval*count period to avoid confusion. This way
13885	a completely new set of data values will be provided by each query.
13886	</note>
13887	</desc>
13888	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13889	<desc>
13890	Metric name filter. Comma-separated list of metrics with wildcard
13891	support.
13892	</desc>
13893	</param>
13894	<param name="objects" type="$unknown" dir="in" safearray="yes">
13895	<desc>
13896	Set of objects to query metrics for.
13897	</desc>
13898	</param>
13899	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13900	<desc>
13901	Names of metrics returned in @c returnData.
13902	</desc>
13903	</param>
13904	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13905	<desc>
13906	Objects associated with metrics returned in @c returnData.
13907	</desc>
13908	</param>
13909	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13910	<desc>
13911	Units of measurement for each returned metric.
13912	</desc>
13913	</param>
13914	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13915	<desc>
13916	Divisor that should be applied to return values in order to get
13917	floating point values. For example:
13918	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13919	will retrieve the floating point value of i-th sample of the first
13920	metric.
13921	</desc>
13922	</param>
13923	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13924	<desc>
13925	Sequence numbers of the first elements of value sequences of
13926	particular metrics returned in @c returnData. For aggregate metrics
13927	it is the sequence number of the sample the aggregate started
13928	calculation from.
13929	</desc>
13930	</param>
13931	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13932	<desc>
13933	Indices of the first elements of value sequences of particular
13934	metrics returned in @c returnData.
13935	</desc>
13936	</param>
13937	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13938	<desc>
13939	Lengths of value sequences of particular metrics.
13940	</desc>
13941	</param>
13942	<param name="returnData" type="long" dir="return" safearray="yes">
13943	<desc>
13944	Flattened array of all metric data containing sequences of values for
13945	each metric.
13946	</desc>
13947	</param>
13948	</method>
13949
13950	</interface>
13951	<enum
13952	name="NATAliasMode"
13953	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13954	<desc></desc>
13955	<const name="AliasLog" value="0x1">
13956	<desc></desc>
13957	</const>
13958	<const name="AliasProxyOnly" value="0x02">
13959	<desc></desc>
13960	</const>
13961	<const name="AliasUseSamePorts" value="0x04">
13962	<desc></desc>
13963	</const>
13964	</enum>
13965	<enum
13966	name="NATProtocol"
13967	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13968	>
13969	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13970	<const name="UDP" value="0">
13971	<desc>Port-forwarding uses UDP protocol.</desc>
13972	</const>
13973	<const name="TCP" value="1">
13974	<desc>Port-forwarding uses TCP protocol.</desc>
13975	</const>
13976	</enum>
13977
13978	<interface
13979	name="INATEngine" extends="$unknown"
13980	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13981	wsmap="managed"
13982	>
13983	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13984	allows for changing NAT behavior such as port-forwarding rules. This interface is
13985	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13986	<attribute name="network" type="wstring">
13987	<desc>The network attribute of the NAT engine (the same value is used with built-in
13988	DHCP server to fill corresponding fields of DHCP leases).</desc>
13989	</attribute>
13990	<attribute name="hostIP" type="wstring">
13991	<desc>IP of host interface to bind all opened sockets to.
13992	<note>Changing this does not change binding of port forwarding.</note>
13993	</desc>
13994	</attribute>
13995	<attribute name="tftpPrefix" type="wstring">
13996	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13997	the corresponding fields of DHCP leases.</desc>
13998	</attribute>
13999	<attribute name="tftpBootFile" type="wstring">
14000	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14001	the corresponding fields of DHCP leases.</desc>
14002	</attribute>
14003	<attribute name="tftpNextServer" type="wstring">
14004	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14005	the corresponding fields of DHCP leases.
14006	<note>The preferred form is IPv4 addresses.</note>
14007	</desc>
14008	</attribute>
14009	<attribute name="aliasMode" type="unsigned long">
14010	<desc></desc>
14011	</attribute>
14012	<attribute name="dnsPassDomain" type="boolean">
14013	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14014	</attribute>
14015	<attribute name="dnsProxy" type="boolean">
14016	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14017	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14018	</attribute>
14019	<attribute name="dnsUseHostResolver" type="boolean">
14020	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14021	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14022	</attribute>
14023	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14024	<desc>Array of NAT port-forwarding rules in string representation, in the following
14025	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14026	</attribute>
14027	<method name="setNetworkSettings">
14028	<desc>Sets network configuration of the NAT engine.</desc>
14029	<param name="mtu" type="unsigned long" dir="in">
14030	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14031	</param>
14032	<param name="sockSnd" type="unsigned long" dir="in">
14033	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14034	</param>
14035	<param name="sockRcv" type="unsigned long" dir="in">
14036	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14037	</param>
14038	<param name="TcpWndSnd" type="unsigned long" dir="in">
14039	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14040	establishing a new TCP connection.</desc>
14041	</param>
14042	<param name="TcpWndRcv" type="unsigned long" dir="in">
14043	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14044	establishing a new TCP connection.</desc>
14045	</param>
14046	</method>
14047	<method name="getNetworkSettings">
14048	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14049	for parameter descriptions.</desc>
14050	<param name="mtu" type="unsigned long" dir="out" />
14051	<param name="sockSnd" type="unsigned long" dir="out" />
14052	<param name="sockRcv" type="unsigned long" dir="out" />
14053	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14054	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14055	</method>
14056	<method name="addRedirect">
14057	<desc>Adds a new NAT port-forwarding rule.</desc>
14058	<param name="name" type="wstring" dir="in">
14059	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14060	auto-generates one using the other parameters.</desc>
14061	</param>
14062	<param name="proto" type="NATProtocol" dir="in">
14063	<desc>Protocol handled with the rule.</desc>
14064	</param>
14065	<param name="hostIp" type="wstring" dir="in">
14066	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14067	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14068	</param>
14069	<param name="hostPort" type="unsigned short" dir="in">
14070	<desc>The port number to listen on.</desc>
14071	</param>
14072	<param name="guestIp" type="wstring" dir="in">
14073	<desc>The IP address of the guest which the NAT engine will forward matching packets
14074	to. An empty IP address is acceptable, in which case the NAT engine will forward
14075	packets to the first DHCP lease (x.x.x.15).</desc>
14076	</param>
14077	<param name="guestPort" type="unsigned short" dir="in">
14078	<desc>The port number to forward.</desc>
14079	</param>
14080	</method>
14081	<method name="removeRedirect">
14082	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14083	<param name="name" type="wstring" dir="in">
14084	<desc>The name of the rule to delete.</desc>
14085	</param>
14086	</method>
14087	</interface>
14088
14089	<!--
14090	// IExtPackManager
14091	/////////////////////////////////////////////////////////////////////////
14092	-->
14093
14094	<interface
14095	name="IExtPack" extends="$unknown"
14096	uuid="ab26b24e-d46c-4d09-aa44-e5092d2fe9ae"
14097	wsmap="suppress"
14098	>
14099	<desc>
14100	Interface for querying interfaces and information relating to an
14101	extension pack. The extension pack specific interfaces can be queried
14102	via the IUnknown::QueryInterface method.
14103	</desc>
14104	<attribute name="name" type="wstring" readonly="yes">
14105	<desc>The extension pack name. This is unique.</desc>
14106	</attribute>
14107	<attribute name="description" type="wstring" readonly="yes">
14108	<desc>The extension pack description.</desc>
14109	</attribute>
14110	<attribute name="version" type="wstring" readonly="yes">
14111	<desc>
14112	The extension pack version string. This is on the same form as
14113	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14114	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14115	or "1.2.3_BETA1-r45678-OSE"
14116	</desc>
14117	</attribute>
14118	<attribute name="revision" type="unsigned long" readonly="yes">
14119	<desc>The extension pack internal revision number.</desc>
14120	</attribute>
14121	<attribute name="usable" type="boolean" readonly="yes">
14122	<desc>
14123	Indicates whether the extension pack is usable or not. An
14124	extension pack that is not compatible with the current VirtualBox
14125	version will be flagged as not usable.
14126	</desc>
14127	</attribute>
14128	<attribute name="whyUnusable" type="wstring" readonly="yes">
14129	<desc>
14130	String indicating why the extension pack is not usable. This is an
14131	empty string if usable and always a non-empty string if not usable.
14132	</desc>
14133	</attribute>
14134	</interface>
14135
14136	<interface
14137	name="IExtPackManager" extends="$unknown"
14138	uuid="ba1fbfca-53f1-471c-b5a1-416386f0f52b"
14139	wsmap="suppress"
14140	>
14141	<desc>
14142	Interface for managing VirtualBox Extension Packs.
14143
14144	TODO: Describe extension packs, how they are managed and how to create
14145	one.
14146	</desc>
14147
14148	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14149	<desc>
14150	List of the installed extension packs.
14151	</desc>
14152	</attribute>
14153
14154	<method name="find">
14155	<desc>
14156	Returns the extension pack with the specified name if found.
14157
14158	<result name="VBOX_E_OBJECT_NOT_FOUND">
14159	No extension pack matching @a name was found.
14160	</result>
14161	</desc>
14162	<param name="name" type="wstring" dir="in">
14163	<desc>The name of the extension pack to locate.</desc>
14164	</param>
14165	<param name="returnData" type="IExtPack" dir="return">
14166	<desc>The extension pack if found.</desc>
14167	</param>
14168	</method>
14169
14170	<method name="install">
14171	<param name="path" type="wstring" dir="in">
14172	<desc>The path of the extension pack tarball.</desc>
14173	</param>
14174	<param name="name" type="wstring" dir="out">
14175	<desc>The name of the installed extension pack.</desc>
14176	</param>
14177	</method>
14178
14179	<method name="uninstall">
14180	<desc>Uninstalls an extension pack, removing all related files.</desc>
14181	<param name="name" type="wstring" dir="in">
14182	<desc>The name of the extension pack to uninstall.</desc>
14183	</param>
14184	<param name="forcedRemoval" type="boolean" dir="in">
14185	<desc>
14186	Forced removal of the extension pack. This means that the uninstall
14187	hook will not be called.
14188	</desc>
14189	</param>
14190	</method>
14191	</interface>
14192
14193	<!--
14194	// Events
14195	/////////////////////////////////////////////////////////////////////////
14196	-->
14197	<enum
14198	name="VBoxEventType"
14199	uuid="e085d0b1-05e6-4f40-a709-b7266fbdb236">
14200
14201	<desc>
14202	Type of an event.
14203	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14204	</desc>
14205
14206	<const name="Invalid" value="0">
14207	<desc>
14208	Invalid event, must be first.
14209	</desc>
14210	</const>
14211
14212	<const name="Any" value="1">
14213	<desc>
14214	Wildcard for all events.
14215	Events of this type are never delivered, and only used in
14216	registerListener() call to simplify registration.
14217	</desc>
14218	</const>
14219
14220	<const name="Vetoable" value="2">
14221	<desc>
14222	Wildcard for all vetoable events. Events of this type are never delivered, and only
14223	used in registerListener() call to simplify registration.
14224	</desc>
14225	</const>
14226
14227	<const name="MachineEvent" value="3">
14228	<desc>
14229	Wildcard for all machine events. Events of this type are never delivered, and only used in
14230	registerListener() call to simplify registration.
14231	</desc>
14232	</const>
14233
14234	<const name="SnapshotEvent" value="4">
14235	<desc>
14236	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14237	registerListener() call to simplify registration.
14238	</desc>
14239	</const>
14240
14241	<const name="InputEvent" value="5">
14242	<desc>
14243	Wildcard for all input device (keyboard, mouse) events.
14244	Events of this type are never delivered, and only used in
14245	registerListener() call to simplify registration.
14246	</desc>
14247	</const>
14248
14249	<const name="LastWildcard" value="31">
14250	<desc>
14251	Last wildcard.
14252	</desc>
14253	</const>
14254
14255	<const name="OnMachineStateChanged" value="32">
14256	<desc>
14257	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14258	</desc>
14259	</const>
14260	<const name="OnMachineDataChanged" value="33">
14261	<desc>
14262	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14263	</desc>
14264	</const>
14265	<const name="OnExtraDataChanged" value="34">
14266	<desc>
14267	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14268	</desc>
14269	</const>
14270	<const name="OnExtraDataCanChange" value="35">
14271	<desc>
14272	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14273	</desc>
14274	</const>
14275	<const name="OnMediumRegistered" value="36">
14276	<desc>
14277	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14278	</desc>
14279	</const>
14280	<const name="OnMachineRegistered" value="37">
14281	<desc>
14282	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14283	</desc>
14284	</const>
14285	<const name="OnSessionStateChanged" value="38">
14286	<desc>
14287	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14288	</desc>
14289	</const>
14290	<const name="OnSnapshotTaken" value="39">
14291	<desc>
14292	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14293	</desc>
14294	</const>
14295	<const name="OnSnapshotDeleted" value="40">
14296	<desc>
14297	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14298	</desc>
14299	</const>
14300	<const name="OnSnapshotChanged" value="41">
14301	<desc>
14302	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14303	</desc>
14304	</const>
14305	<const name="OnGuestPropertyChanged" value="42">
14306	<desc>
14307	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14308	</desc>
14309	</const>
14310	<!-- Console events -->
14311	<const name="OnMousePointerShapeChanged" value="43">
14312	<desc>
14313	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14314	</desc>
14315	</const>
14316	<const name="OnMouseCapabilityChanged" value="44">
14317	<desc>
14318	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14319	</desc>
14320	</const>
14321	<const name="OnKeyboardLedsChanged" value="45">
14322	<desc>
14323	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14324	</desc>
14325	</const>
14326	<const name="OnStateChanged" value="46">
14327	<desc>
14328	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14329	</desc>
14330	</const>
14331	<const name="OnAdditionsStateChanged" value="47">
14332	<desc>
14333	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14334	</desc>
14335	</const>
14336	<const name="OnNetworkAdapterChanged" value="48">
14337	<desc>
14338	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14339	</desc>
14340	</const>
14341	<const name="OnSerialPortChanged" value="49">
14342	<desc>
14343	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14344	</desc>
14345	</const>
14346	<const name="OnParallelPortChanged" value="50">
14347	<desc>
14348	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14349	</desc>
14350	</const>
14351	<const name="OnStorageControllerChanged" value="51">
14352	<desc>
14353	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14354	</desc>
14355	</const>
14356	<const name="OnMediumChanged" value="52">
14357	<desc>
14358	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14359	</desc>
14360	</const>
14361	<const name="OnVRDEServerChanged" value="53">
14362	<desc>
14363	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14364	</desc>
14365	</const>
14366	<const name="OnUSBControllerChanged" value="54">
14367	<desc>
14368	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14369	</desc>
14370	</const>
14371	<const name="OnUSBDeviceStateChanged" value="55">
14372	<desc>
14373	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14374	</desc>
14375	</const>
14376	<const name="OnSharedFolderChanged" value="56">
14377	<desc>
14378	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14379	</desc>
14380	</const>
14381	<const name="OnRuntimeError" value="57">
14382	<desc>
14383	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14384	</desc>
14385	</const>
14386	<const name="OnCanShowWindow" value="58">
14387	<desc>
14388	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14389	</desc>
14390	</const>
14391	<const name="OnShowWindow" value="59">
14392	<desc>
14393	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14394	</desc>
14395	</const>
14396	<const name="OnCPUChanged" value="60">
14397	<desc>
14398	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14399	</desc>
14400	</const>
14401	<const name="OnVRDEServerInfoChanged" value="61">
14402	<desc>
14403	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14404	</desc>
14405	</const>
14406	<const name="OnEventSourceChanged" value="62">
14407	<desc>
14408	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14409	</desc>
14410	</const>
14411	<const name="OnCPUExecutionCapChanged" value="63">
14412	<desc>
14413	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14414	</desc>
14415	</const>
14416	<const name="OnGuestKeyboardEvent" value="64">
14417	<desc>
14418	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14419	</desc>
14420	</const>
14421	<const name="OnGuestMouseEvent" value="65">
14422	<desc>
14423	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14424	</desc>
14425	</const>
14426	<!-- Last event marker -->
14427	<const name="Last" value="66">
14428	<desc>
14429	Must be last event, used for iterations and structures relying on numerical event values.
14430	</desc>
14431	</const>
14432
14433	</enum>
14434
14435	<interface
14436	name="IEventSource" extends="$unknown"
14437	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14438	wsmap="managed"
14439	>
14440	<desc>
14441	Event source. Generally, any object which could generate events can be an event source,
14442	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14443	an event source can work with listeners in either active or passive mode. In active mode it is up to
14444	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14445	event source keeps track of pending events for each listener and returns available events on demand.
14446
14447	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14448	</desc>
14449
14450	<method name="createListener">
14451	<desc>
14452	Creates a new listener object, useful for passive mode.
14453	</desc>
14454	<param name="listener" type="IEventListener" dir="return"/>
14455	</method>
14456
14457	<method name="createAggregator">
14458	<desc>
14459	Creates a aggregator event source, collecting events from multiple sources.
14460	This way single listener can listen for events coming from multiple sources,
14461	using single blocking getEvent() of this aggregator.
14462	</desc>
14463	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14464	<desc>
14465	Subordinate event source this one aggregatres.
14466	</desc>
14467	</param>
14468	<param name="result" type="IEventSource" dir="return"/>
14469	</method>
14470
14471	<method name="registerListener">
14472	<desc>
14473	Register an event listener.
14474
14475	<note>
14476	To avoid system overload, the VirtualBox server process checks if passive event
14477	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14478	current implementation, if more than 500 pending events are detected for a passive
14479	event listener, it is forcefully unregistered by the system, and further
14480	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14481	</note>
14482	</desc>
14483	<param name="listener" type="IEventListener" dir="in">
14484	<desc>Listener to register.</desc>
14485	</param>
14486	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14487	<desc>
14488	Event types listener is interested in. One can use wildcards like -
14489	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14490	than one event.
14491	</desc>
14492	</param>
14493	<param name="active" type="boolean" dir="in">
14494	<desc>
14495	Which mode this listener is operating in.
14496	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14497	In passive mode, an internal event queue is created for this this IEventListener.
14498	For each event coming in, it is added to queues for all interested registered passive
14499	listeners. It is then up to the external code to call the listener's
14500	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14501	external code must call <link to="#eventProcessed" />.
14502	</desc>
14503	</param>
14504	</method>
14505
14506	<method name="unregisterListener">
14507	<desc>
14508	Unregister an event listener. If listener is passive, and some waitable events are still
14509	in queue they are marked as processed automatically.
14510	</desc>
14511	<param name="listener" type="IEventListener" dir="in">
14512	<desc>Listener to unregister.</desc>
14513	</param>
14514	</method>
14515
14516	<method name="fireEvent">
14517	<desc>
14518	Fire an event for this source.
14519	</desc>
14520	<param name="event" type="IEvent" dir="in">
14521	<desc>Event to deliver.</desc>
14522	</param>
14523	<param name="timeout" type="long" dir="in">
14524	<desc>
14525	Maximum time to wait for event processing (if event is waitable), in ms;
14526	0 = no wait, -1 = indefinite wait.
14527	</desc>
14528	</param>
14529	<param name="result" type="boolean" dir="return">
14530	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14531	</param>
14532	</method>
14533
14534	<method name="getEvent">
14535	<desc>
14536	Get events from this peer's event queue (for passive mode). Calling this method
14537	regularly is required for passive event listeners to avoid system overload;
14538	see <link to="IEventSource::registerListener" /> for details.
14539
14540	<result name="VBOX_E_OBJECT_NOT_FOUND">
14541	Listener is not registered, or autounregistered.
14542	</result>
14543	</desc>
14544	<param name="listener" type="IEventListener" dir="in">
14545	<desc>Which listener to get data for.</desc>
14546	</param>
14547	<param name="timeout" type="long" dir="in">
14548	<desc>
14549	Maximum time to wait for events, in ms;
14550	0 = no wait, -1 = indefinite wait.
14551	</desc>
14552	</param>
14553	<param name="event" type="IEvent" dir="return">
14554	<desc>Event retrieved, or null if none available.</desc>
14555	</param>
14556	</method>
14557
14558	<method name="eventProcessed">
14559	<desc>
14560	Must be called for waitable events after a particular listener finished its
14561	event processing. When all listeners of a particular event have called this
14562	method, the system will then call <link to="IEvent::setProcessed" />.
14563	</desc>
14564	<param name="listener" type="IEventListener" dir="in">
14565	<desc>Which listener processed event.</desc>
14566	</param>
14567	<param name="event" type="IEvent" dir="in">
14568	<desc>Which event.</desc>
14569	</param>
14570	</method>
14571
14572	</interface>
14573
14574	<interface
14575	name="IEventListener" extends="$unknown"
14576	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14577	wsmap="managed"
14578	>
14579	<desc>
14580	Event listener. An event listener can work in either active or passive mode, depending on the way
14581	it was registered.
14582	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14583	</desc>
14584
14585	<method name="handleEvent">
14586	<desc>
14587	Handle event callback (called directly by IEventSource in active mode, or could be
14588	called by event processor thread in passive mode).
14589	</desc>
14590	<param name="event" type="IEvent" dir="in">
14591	<desc>Event available.</desc>
14592	</param>
14593	</method>
14594
14595	</interface>
14596
14597	<interface
14598	name="IEvent" extends="$unknown"
14599	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14600	wsmap="managed"
14601	>
14602	<desc>
14603	Abstract parent interface for VirtualBox events. Actual events will typically implement
14604	a more specific interface which derives from this (see below).
14605
14606	<b>Introduction to VirtualBox events</b>
14607
14608	Generally speaking, an event (represented by this interface) signals that something
14609	happened, while an event listener (see <link to="IEventListener" />) represents an
14610	entity that is interested in certain events. In order for this to work with
14611	unidirectional protocols (i.e. web services), the concepts of passive and active
14612	listener are used.
14613
14614	Event consumers can register themselves as listeners, providing an array of
14615	events they are interested in (see <link to="IEventSource::registerListener" />).
14616	When an event triggers, the listener is notified about the event. The exact
14617	mechanism of the notification depends on whether the listener was registered as
14618	an active or passive listener:
14619
14620	<ul>
14621	<li>An active listener is very similar to a callback: it is a function invoked
14622	by the API. As opposed to the callbacks that were used in the API before
14623	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
14624	</li>
14625
14626	<li>Passive listeners are somewhat trickier to implement, but do not require
14627	a client function to be callable, which is not an option with scripting
14628	languages or web service clients. Internally the <link to="IEventSource" />
14629	implementation maintains an event queue for each passive listener, and
14630	newly arrived events are put in this queue. When the listener calls
14631	<link to="IEventSource::getEvent"/>, first element from its internal event
14632	queue is returned. When the client completes processing of an event,
14633	the <link to="IEventSource::eventProcessed" /> function must be called,
14634	acknowledging that the event was processed. It supports implementing
14635	waitable events. On passive listener unregistration, all events from its
14636	queue are auto-acknowledged.
14637	</li>
14638	</ul>
14639
14640	Waitable events are useful in situations where the event generator wants to track
14641	delivery or a party wants to wait until all listeners have completed the event. A
14642	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14643	listeners might veto a certain action, and thus the event producer has to make
14644	sure that all listeners have processed the event and not vetoed before taking
14645	the action.
14646
14647	A given event may have both passive and active listeners at the same time.
14648
14649	<b>Using events</b>
14650
14651	Any VirtualBox object capable of producing externally visible events provides an
14652	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14653	This event source object is notified by VirtualBox once something has happened, so
14654	consumers may register event listeners with this event source. To register a listener,
14655	an object implementing the <link to="IEventListener" /> interface must be provided.
14656	For active listeners, such an object is typically created by the consumer, while for
14657	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14658	note that a listener created with @c createListener() must not be used as an active listener.
14659
14660	Once created, the listener must be registered to listen for the desired events
14661	(see <link to="IEventSource::registerListener" />), providing an array of
14662	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14663	event IDs or wildcards matching multiple event IDs.
14664
14665	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14666	called automatically when the event is triggered, while passive listeners have to call
14667	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14668	an event processing loop.
14669
14670	The IEvent interface is an abstract parent interface for all such VirtualBox events
14671	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14672	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14673	then cast to the appropriate specific interface using @c QueryInterface().
14674	</desc>
14675
14676	<attribute name="type" readonly="yes" type="VBoxEventType">
14677	<desc>
14678	Event type.
14679	</desc>
14680	</attribute>
14681
14682	<attribute name="source" readonly="yes" type="IEventSource">
14683	<desc>
14684	Source of this event.
14685	</desc>
14686	</attribute>
14687
14688	<attribute name="waitable" readonly="yes" type="boolean">
14689	<desc>
14690	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14691	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14692	as no additional overhead associated with waitability imposed.
14693	Waitable events are needed when one need to be able to wait for particular event processed,
14694	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14695	until all consumers confirmed events.
14696	</desc>
14697	</attribute>
14698
14699	<method name="setProcessed">
14700	<desc>
14701	Internal method called by the system when all listeners of a particular event have called
14702	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14703	</desc>
14704	</method>
14705
14706	<method name="waitProcessed">
14707	<desc>
14708	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14709	described semantics, for non-waitable returns true immediately.
14710	</desc>
14711	<param name="timeout" type="long" dir="in">
14712	<desc>
14713	Maximum time to wait for event processeing, in ms;
14714	0 = no wait, -1 = indefinite wait.
14715	</desc>
14716	</param>
14717	<param name="result" type="boolean" dir="return">
14718	<desc>If this event was processed before timeout.</desc>
14719	</param>
14720	</method>
14721	</interface>
14722
14723
14724	<interface
14725	name="IReusableEvent" extends="IEvent"
14726	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14727	wsmap="managed"
14728	>
14729	<desc>Base abstract interface for all reusable events.</desc>
14730
14731	<attribute name="generation" readonly="yes" type="unsigned long">
14732	<desc>Current generation of event, incremented on reuse.</desc>
14733	</attribute>
14734
14735	<method name="reuse">
14736	<desc>
14737	Marks an event as reused, increments 'generation', fields shall no
14738	longer be considered valid.
14739	</desc>
14740	</method>
14741	</interface>
14742
14743	<interface
14744	name="IMachineEvent" extends="IEvent"
14745	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14746	wsmap="managed" id="MachineEvent"
14747	>
14748	<desc>Base abstract interface for all machine events.</desc>
14749
14750	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14751	<desc>ID of the machine this event relates to.</desc>
14752	</attribute>
14753
14754	</interface>
14755
14756	<interface
14757	name="IMachineStateChangedEvent" extends="IMachineEvent"
14758	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14759	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14760	>
14761	<desc>Machine state change event.</desc>
14762
14763	<attribute name="state" readonly="yes" type="MachineState">
14764	<desc>New execution state.</desc>
14765	</attribute>
14766	</interface>
14767
14768	<interface
14769	name="IMachineDataChangedEvent" extends="IMachineEvent"
14770	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14771	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14772	>
14773	<desc>
14774	Any of the settings of the given machine has changed.
14775	</desc>
14776	</interface>
14777
14778	<interface
14779	name="IMediumRegisteredEvent" extends="IEvent"
14780	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14781	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14782	>
14783	<desc>
14784	The given medium was registered or unregistered
14785	within this VirtualBox installation.
14786	</desc>
14787
14788	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14789	<desc>ID of the medium this event relates to.</desc>
14790	</attribute>
14791
14792	<attribute name="mediumType" readonly="yes" type="DeviceType">
14793	<desc>Type of the medium this event relates to.</desc>
14794	</attribute>
14795
14796	<attribute name="registered" type="boolean" readonly="yes">
14797	<desc>
14798	If @c true, the medium was registered, otherwise it was
14799	unregistered.
14800	</desc>
14801	</attribute>
14802	</interface>
14803
14804	<interface
14805	name="IMachineRegisteredEvent" extends="IMachineEvent"
14806	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14807	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14808	>
14809	<desc>
14810	The given machine was registered or unregistered
14811	within this VirtualBox installation.
14812	</desc>
14813
14814	<attribute name="registered" type="boolean" readonly="yes">
14815	<desc>
14816	If @c true, the machine was registered, otherwise it was
14817	unregistered.
14818	</desc>
14819	</attribute>
14820	</interface>
14821
14822	<interface
14823	name="ISessionStateChangedEvent" extends="IMachineEvent"
14824	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14825	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14826	>
14827	<desc>
14828	The state of the session for the given machine was changed.
14829	<see>IMachine::sessionState</see>
14830	</desc>
14831
14832	<attribute name="state" type="SessionState" readonly="yes">
14833	<desc>
14834	New session state.
14835	</desc>
14836	</attribute>
14837	</interface>
14838
14839	<interface
14840	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14841	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14842	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14843	>
14844	<desc>
14845	Notification when a guest property has changed.
14846	</desc>
14847
14848	<attribute name="name" readonly="yes" type="wstring">
14849	<desc>
14850	The name of the property that has changed.
14851	</desc>
14852	</attribute>
14853
14854	<attribute name="value" readonly="yes" type="wstring">
14855	<desc>
14856	The new property value.
14857	</desc>
14858	</attribute>
14859
14860	<attribute name="flags" readonly="yes" type="wstring">
14861	<desc>
14862	The new property flags.
14863	</desc>
14864	</attribute>
14865
14866	</interface>
14867
14868	<interface
14869	name="ISnapshotEvent" extends="IMachineEvent"
14870	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14871	wsmap="managed" id="SnapshotEvent"
14872	>
14873	<desc>Base interface for all snapshot events.</desc>
14874
14875	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14876	<desc>ID of the snapshot this event relates to.</desc>
14877	</attribute>
14878
14879	</interface>
14880
14881	<interface
14882	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14883	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14884	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14885	>
14886	<desc>
14887	A new snapshot of the machine has been taken.
14888	<see>ISnapshot</see>
14889	</desc>
14890	</interface>
14891
14892	<interface
14893	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14894	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14895	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14896	>
14897	<desc>
14898	Snapshot of the given machine has been deleted.
14899
14900	<note>
14901	This notification is delivered <b>after</b> the snapshot
14902	object has been uninitialized on the server (so that any
14903	attempt to call its methods will return an error).
14904	</note>
14905
14906	<see>ISnapshot</see>
14907	</desc>
14908	</interface>
14909
14910	<interface
14911	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14912	uuid="07541941-8079-447a-a33e-47a69c7980db"
14913	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14914	>
14915	<desc>
14916	Snapshot properties (name and/or description) have been changed.
14917	<see>ISnapshot</see>
14918	</desc>
14919	</interface>
14920
14921	<interface
14922	name="IMousePointerShapeChangedEvent" extends="IEvent"
14923	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14924	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14925	>
14926	<desc>
14927	Notification when the guest mouse pointer shape has
14928	changed. The new shape data is given.
14929	</desc>
14930
14931	<attribute name="visible" type="boolean" readonly="yes">
14932	<desc>
14933	Flag whether the pointer is visible.
14934	</desc>
14935	</attribute>
14936	<attribute name="alpha" type="boolean" readonly="yes">
14937	<desc>
14938	Flag whether the pointer has an alpha channel.
14939	</desc>
14940	</attribute>
14941	<attribute name="xhot" type="unsigned long" readonly="yes">
14942	<desc>
14943	The pointer hot spot X coordinate.
14944	</desc>
14945	</attribute>
14946	<attribute name="yhot" type="unsigned long" readonly="yes">
14947	<desc>
14948	The pointer hot spot Y coordinate.
14949	</desc>
14950	</attribute>
14951	<attribute name="width" type="unsigned long" readonly="yes">
14952	<desc>
14953	Width of the pointer shape in pixels.
14954	</desc>
14955	</attribute>
14956	<attribute name="height" type="unsigned long" readonly="yes">
14957	<desc>
14958	Height of the pointer shape in pixels.
14959	</desc>
14960	</attribute>
14961	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14962	<desc>
14963	Shape buffer arrays.
14964
14965	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14966	followed by a 32-bpp XOR (color) mask.
14967
14968	For pointers without alpha channel the XOR mask pixels are 32
14969	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14970	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14971
14972	An AND mask is used for pointers with alpha channel, so if the
14973	callback does not support alpha, the pointer could be
14974	displayed as a normal color pointer.
14975
14976	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14977	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14978	height</tt>. The padding bits at the end of each scanline are
14979	undefined.
14980
14981	The XOR mask follows the AND mask on the next 4-byte aligned
14982	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14983	Bytes in the gap between the AND and the XOR mask are undefined.
14984	The XOR mask scanlines have no gap between them and the size of
14985	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14986
14987	<note>
14988	If @a shape is 0, only the pointer visibility is changed.
14989	</note>
14990	</desc>
14991	</attribute>
14992	</interface>
14993
14994	<interface
14995	name="IMouseCapabilityChangedEvent" extends="IEvent"
14996	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14997	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14998	>
14999	<desc>
15000	Notification when the mouse capabilities reported by the
15001	guest have changed. The new capabilities are passed.
15002	</desc>
15003	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
15004	<desc>
15005	Supports absolute coordinates.
15006	</desc>
15007	</attribute>
15008	<attribute name="supportsRelative" type="boolean" readonly="yes">
15009	<desc>
15010	Supports relative coordinates.
15011	</desc>
15012	</attribute>
15013	<attribute name="needsHostCursor" type="boolean" readonly="yes">
15014	<desc>
15015	If host cursor is needed.
15016	</desc>
15017	</attribute>
15018	</interface>
15019
15020	<interface
15021	name="IKeyboardLedsChangedEvent" extends="IEvent"
15022	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
15023	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
15024	>
15025	<desc>
15026	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
15027	to alter the state of the keyboard LEDs.
15028	</desc>
15029	<attribute name="numLock" type="boolean" readonly="yes">
15030	<desc>
15031	NumLock status.
15032	</desc>
15033	</attribute>
15034	<attribute name="capsLock" type="boolean" readonly="yes">
15035	<desc>
15036	CapsLock status.
15037	</desc>
15038	</attribute>
15039	<attribute name="scrollLock" type="boolean" readonly="yes">
15040	<desc>
15041	ScrollLock status.
15042	</desc>
15043	</attribute>
15044	</interface>
15045
15046	<interface
15047	name="IStateChangedEvent" extends="IEvent"
15048	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
15049	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
15050	>
15051	<desc>
15052	Notification when the execution state of the machine has changed.
15053	The new state is given.
15054	</desc>
15055	<attribute name="state" type="MachineState" readonly="yes">
15056	<desc>
15057	New machine state.
15058	</desc>
15059	</attribute>
15060	</interface>
15061
15062	<interface
15063	name="IAdditionsStateChangedEvent" extends="IEvent"
15064	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
15065	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
15066	>
15067	<desc>
15068	Notification when a Guest Additions property changes.
15069	Interested callees should query IGuest attributes to
15070	find out what has changed.
15071	</desc>
15072	</interface>
15073
15074	<interface
15075	name="INetworkAdapterChangedEvent" extends="IEvent"
15076	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
15077	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
15078	>
15079	<desc>
15080	Notification when a property of one of the
15081	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
15082	changes. Interested callees should use INetworkAdapter methods and
15083	attributes to find out what has changed.
15084	</desc>
15085	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
15086	<desc>
15087	Network adapter that is subject to change.
15088	</desc>
15089	</attribute>
15090	</interface>
15091
15092	<interface
15093	name="ISerialPortChangedEvent" extends="IEvent"
15094	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
15095	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
15096	>
15097	<desc>
15098	Notification when a property of one of the
15099	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
15100	Interested callees should use ISerialPort methods and attributes
15101	to find out what has changed.
15102	</desc>
15103	<attribute name="serialPort" type="ISerialPort" readonly="yes">
15104	<desc>
15105	Serial port that is subject to change.
15106	</desc>
15107	</attribute>
15108	</interface>
15109
15110	<interface
15111	name="IParallelPortChangedEvent" extends="IEvent"
15112	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15113	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15114	>
15115	<desc>
15116	Notification when a property of one of the
15117	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15118	changes. Interested callees should use ISerialPort methods and
15119	attributes to find out what has changed.
15120	</desc>
15121	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15122	<desc>
15123	Parallel port that is subject to change.
15124	</desc>
15125	</attribute>
15126	</interface>
15127
15128	<interface
15129	name="IStorageControllerChangedEvent" extends="IEvent"
15130	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15131	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15132	>
15133	<desc>
15134	Notification when a
15135	<link to="IMachine::mediumAttachments">medium attachment</link>
15136	changes.
15137	</desc>
15138	</interface>
15139
15140	<interface
15141	name="IMediumChangedEvent" extends="IEvent"
15142	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15143	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15144	>
15145	<desc>
15146	Notification when a
15147	<link to="IMachine::mediumAttachments">medium attachment</link>
15148	changes.
15149	</desc>
15150	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15151	<desc>
15152	Medium attachment that is subject to change.
15153	</desc>
15154	</attribute>
15155	</interface>
15156
15157	<interface
15158	name="ICPUChangedEvent" extends="IEvent"
15159	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15160	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15161	>
15162	<desc>
15163	Notification when a CPU changes.
15164	</desc>
15165	<attribute name="cpu" type="unsigned long" readonly="yes">
15166	<desc>
15167	The CPU which changed.
15168	</desc>
15169	</attribute>
15170	<attribute name="add" type="boolean" readonly="yes">
15171	<desc>
15172	Flag whether the CPU was added or removed.
15173	</desc>
15174	</attribute>
15175	</interface>
15176
15177	<interface
15178	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15179	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15180	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15181	>
15182	<desc>
15183	Notification when the CPU execution cap changes.
15184	</desc>
15185	<attribute name="executionCap" type="unsigned long" readonly="yes">
15186	<desc>
15187	The new CPU execution cap value. (1-100)
15188	</desc>
15189	</attribute>
15190	</interface>
15191
15192	<interface
15193	name="IGuestKeyboardEvent" extends="IEvent"
15194	uuid="88394258-7006-40d4-b339-472ee3801844"
15195	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboardEvent"
15196	>
15197	<desc>
15198	Notification when guest keyboard event happens.
15199	</desc>
15200	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15201	<desc>
15202	Array of scancodes.
15203	</desc>
15204	</attribute>
15205	</interface>
15206
15207	<interface
15208	name="IGuestMouseEvent" extends="IReusableEvent"
15209	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15210	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouseEvent"
15211	>
15212	<desc>
15213	Notification when guest mouse event happens.
15214	</desc>
15215
15216	<attribute name="absolute" type="boolean" readonly="yes">
15217	<desc>
15218	If this event is relative or absolute.
15219	</desc>
15220	</attribute>
15221
15222	<attribute name="x" type="long" readonly="yes">
15223	<desc>
15224	New X position, or X delta.
15225	</desc>
15226	</attribute>
15227
15228	<attribute name="y" type="long" readonly="yes">
15229	<desc>
15230	New Y position, or Y delta.
15231	</desc>
15232	</attribute>
15233
15234	<attribute name="z" type="long" readonly="yes">
15235	<desc>
15236	Z delta.
15237	</desc>
15238	</attribute>
15239
15240	<attribute name="w" type="long" readonly="yes">
15241	<desc>
15242	W delta.
15243	</desc>
15244	</attribute>
15245
15246	<attribute name="buttons" type="long" readonly="yes">
15247	<desc>
15248	Button state bitmask.
15249	</desc>
15250	</attribute>
15251
15252	</interface>
15253
15254
15255	<interface
15256	name="IVRDEServerChangedEvent" extends="IEvent"
15257	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15258	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15259	>
15260	<desc>
15261	Notification when a property of the
15262	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15263	Interested callees should use IVRDEServer methods and attributes to
15264	find out what has changed.
15265	</desc>
15266	</interface>
15267
15268	<interface
15269	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15270	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15271	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15272	>
15273	<desc>
15274	Notification when the status of the VRDE server changes. Interested callees
15275	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15276	attributes to find out what is the current status.
15277	</desc>
15278	</interface>
15279
15280	<interface
15281	name="IUSBControllerChangedEvent" extends="IEvent"
15282	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15283	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15284	>
15285	<desc>
15286	Notification when a property of the virtual
15287	<link to="IMachine::USBController">USB controller</link> changes.
15288	Interested callees should use IUSBController methods and attributes to
15289	find out what has changed.
15290	</desc>
15291	</interface>
15292
15293	<interface
15294	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15295	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15296	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15297	>
15298	<desc>
15299	Notification when a USB device is attached to or detached from
15300	the virtual USB controller.
15301
15302	This notification is sent as a result of the indirect
15303	request to attach the device because it matches one of the
15304	machine USB filters, or as a result of the direct request
15305	issued by <link to="IConsole::attachUSBDevice"/> or
15306	<link to="IConsole::detachUSBDevice"/>.
15307
15308	This notification is sent in case of both a succeeded and a
15309	failed request completion. When the request succeeds, the
15310	@a error parameter is @c null, and the given device has been
15311	already added to (when @a attached is @c true) or removed from
15312	(when @a attached is @c false) the collection represented by
15313	<link to="IConsole::USBDevices"/>. On failure, the collection
15314	doesn't change and the @a error parameter represents the error
15315	message describing the failure.
15316	</desc>
15317	<attribute name="device" type="IUSBDevice" readonly="yes">
15318	<desc>
15319	Device that is subject to state change.
15320	</desc>
15321	</attribute>
15322	<attribute name="attached" type="boolean" readonly="yes">
15323	<desc>
15324	@c true if the device was attached and @c false otherwise.
15325	</desc>
15326	</attribute>
15327	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15328	<desc>
15329	@c null on success or an error message object on failure.
15330	</desc>
15331	</attribute>
15332	</interface>
15333
15334	<interface
15335	name="ISharedFolderChangedEvent" extends="IEvent"
15336	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15337	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15338	>
15339	<desc>
15340	Notification when a shared folder is added or removed.
15341	The @a scope argument defines one of three scopes:
15342	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15343	(<link to="Scope_Global">Global</link>),
15344	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15345	the machine (<link to="Scope_Machine">Machine</link>) or <link
15346	to="IConsole::sharedFolders">transient shared folders</link> of the
15347	machine (<link to="Scope_Session">Session</link>). Interested callees
15348	should use query the corresponding collections to find out what has
15349	changed.
15350	</desc>
15351	<attribute name="scope" type="Scope" readonly="yes">
15352	<desc>
15353	Scope of the notification.
15354	</desc>
15355	</attribute>
15356	</interface>
15357
15358	<interface
15359	name="IRuntimeErrorEvent" extends="IEvent"
15360	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15361	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15362	>
15363	<desc>
15364	Notification when an error happens during the virtual
15365	machine execution.
15366
15367	There are three kinds of runtime errors:
15368	<ul>
15369	<li><i>fatal</i></li>
15370	<li><i>non-fatal with retry</i></li>
15371	<li><i>non-fatal warnings</i></li>
15372	</ul>
15373
15374	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15375	to @c true. In case of fatal errors, the virtual machine
15376	execution is always paused before calling this notification, and
15377	the notification handler is supposed either to immediately save
15378	the virtual machine state using <link to="IConsole::saveState"/>
15379	or power it off using <link to="IConsole::powerDown"/>.
15380	Resuming the execution can lead to unpredictable results.
15381
15382	<b>Non-fatal</b> errors and warnings are indicated by the
15383	@a fatal parameter set to @c false. If the virtual machine
15384	is in the Paused state by the time the error notification is
15385	received, it means that the user can <i>try to resume</i> the machine
15386	execution after attempting to solve the problem that caused the
15387	error. In this case, the notification handler is supposed
15388	to show an appropriate message to the user (depending on the
15389	value of the @a id parameter) that offers several actions such
15390	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15391	wants to retry, the notification handler should continue
15392	the machine execution using the <link to="IConsole::resume"/>
15393	call. If the machine execution is not Paused during this
15394	notification, then it means this notification is a <i>warning</i>
15395	(for example, about a fatal condition that can happen very soon);
15396	no immediate action is required from the user, the machine
15397	continues its normal execution.
15398
15399	Note that in either case the notification handler
15400	<b>must not</b> perform any action directly on a thread
15401	where this notification is called. Everything it is allowed to
15402	do is to post a message to another thread that will then talk
15403	to the user and take the corresponding action.
15404
15405	Currently, the following error identifiers are known:
15406	<ul>
15407	<li><tt>"HostMemoryLow"</tt></li>
15408	<li><tt>"HostAudioNotResponding"</tt></li>
15409	<li><tt>"VDIStorageFull"</tt></li>
15410	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15411	</ul>
15412	</desc>
15413	<attribute name="fatal" type="boolean" readonly="yes">
15414	<desc>
15415	Whether the error is fatal or not.
15416	</desc>
15417	</attribute>
15418	<attribute name="id" type="wstring" readonly="yes">
15419	<desc>
15420	Error identifier.
15421	</desc>
15422	</attribute>
15423	<attribute name="message" type="wstring" readonly="yes">
15424	<desc>
15425	Optional error message.
15426	</desc>
15427	</attribute>
15428	</interface>
15429
15430
15431	<interface
15432	name="IEventSourceChangedEvent" extends="IEvent"
15433	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15434	waitable="yes"
15435	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15436	>
15437	<desc>
15438	Notification when an event source state changes (listener added or removed).
15439	</desc>
15440
15441	<attribute name="listener" type="IEventListener" readonly="yes">
15442	<desc>
15443	Event listener which has changed.
15444	</desc>
15445	</attribute>
15446
15447	<attribute name="add" type="boolean" readonly="yes">
15448	<desc>
15449	Flag whether listener was added or removed.
15450	</desc>
15451	</attribute>
15452	</interface>
15453
15454	<interface
15455	name="IExtraDataChangedEvent" extends="IEvent"
15456	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15457	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15458	>
15459	<desc>
15460	Notification when machine specific or global extra data
15461	has changed.
15462	</desc>
15463	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15464	<desc>
15465	ID of the machine this event relates to.
15466	Null for global extra data changes.
15467	</desc>
15468	</attribute>
15469	<attribute name="key" type="wstring" readonly="yes">
15470	<desc>
15471	Extra data key that has changed.
15472	</desc>
15473	</attribute>
15474	<attribute name="value" type="wstring" readonly="yes">
15475	<desc>
15476	Extra data value for the given key.
15477	</desc>
15478	</attribute>
15479	</interface>
15480
15481	<interface
15482	name="IVetoEvent" extends="IEvent"
15483	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15484	wsmap="managed"
15485	>
15486	<desc>Base abstract interface for veto events.</desc>
15487
15488	<method name="addVeto">
15489	<desc>
15490	Adds a veto on this event.
15491	</desc>
15492	<param name="reason" type="wstring" dir="in">
15493	<desc>
15494	Reason for veto, could be null or empty string.
15495	</desc>
15496	</param>
15497	</method>
15498
15499	<method name="isVetoed">
15500	<desc>
15501	If this event was vetoed.
15502	</desc>
15503	<param name="result" type="boolean" dir="return">
15504	<desc>
15505	Reason for veto.
15506	</desc>
15507	</param>
15508	</method>
15509
15510	<method name="getVetos">
15511	<desc>
15512	Current veto reason list, if size is 0 - no veto.
15513	</desc>
15514	<param name="result" type="wstring" dir="return" safearray="yes">
15515	<desc>
15516	Array of reasons for veto provided by different event handlers.
15517	</desc>
15518	</param>
15519	</method>
15520
15521	</interface>
15522
15523	<interface
15524	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15525	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15526	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15527	waitable="true"
15528	>
15529	<desc>
15530	Notification when someone tries to change extra data for
15531	either the given machine or (if @c null) global extra data.
15532	This gives the chance to veto against changes.
15533	</desc>
15534	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15535	<desc>
15536	ID of the machine this event relates to.
15537	Null for global extra data changes.
15538	</desc>
15539	</attribute>
15540	<attribute name="key" type="wstring" readonly="yes">
15541	<desc>
15542	Extra data key that has changed.
15543	</desc>
15544	</attribute>
15545	<attribute name="value" type="wstring" readonly="yes">
15546	<desc>
15547	Extra data value for the given key.
15548	</desc>
15549	</attribute>
15550	</interface>
15551
15552	<interface
15553	name="ICanShowWindowEvent" extends="IVetoEvent"
15554	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15555	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15556	waitable="true"
15557	>
15558	<desc>
15559	Notification when a call to
15560	<link to="IMachine::canShowConsoleWindow"/> is made by a
15561	front-end to check if a subsequent call to
15562	<link to="IMachine::showConsoleWindow"/> can succeed.
15563
15564	The callee should give an answer appropriate to the current
15565	machine state using event veto. This answer must
15566	remain valid at least until the next
15567	<link to="IConsole::state">machine state</link> change.
15568	</desc>
15569	</interface>
15570
15571	<interface
15572	name="IShowWindowEvent" extends="IEvent"
15573	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15574	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15575	waitable="true"
15576	>
15577	<desc>
15578	Notification when a call to
15579	<link to="IMachine::showConsoleWindow"/>
15580	requests the console window to be activated and brought to
15581	foreground on the desktop of the host PC.
15582
15583	This notification should cause the VM console process to
15584	perform the requested action as described above. If it is
15585	impossible to do it at a time of this notification, this
15586	method should return a failure.
15587
15588	Note that many modern window managers on many platforms
15589	implement some sort of focus stealing prevention logic, so
15590	that it may be impossible to activate a window without the
15591	help of the currently active application (which is supposedly
15592	an initiator of this notification). In this case, this method
15593	must return a non-zero identifier that represents the
15594	top-level window of the VM console process. The caller, if it
15595	represents a currently active process, is responsible to use
15596	this identifier (in a platform-dependent manner) to perform
15597	actual window activation.
15598
15599	This method must set @a winId to zero if it has performed all
15600	actions necessary to complete the request and the console
15601	window is now active and in foreground, to indicate that no
15602	further action is required on the caller's side.
15603	</desc>
15604	<attribute name="winId" type="long long">
15605	<desc>
15606	Platform-dependent identifier of the top-level VM console
15607	window, or zero if this method has performed all actions
15608	necessary to implement the <i>show window</i> semantics for
15609	the given platform and/or this VirtualBox front-end.
15610	</desc>
15611	</attribute>
15612	</interface>
15613
15614	<module name="VBoxSVC" context="LocalServer">
15615	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15616	namespace="virtualbox.org">
15617	<interface name="IVirtualBox" default="yes"/>
15618	</class>
15619	</module>
15620
15621	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15622	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15623	namespace="virtualbox.org">
15624	<interface name="ISession" default="yes"/>
15625	</class>
15626
15627	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15628	namespace="virtualbox.org">
15629	<interface name="IConsole" default="yes"/>
15630	</class>
15631	</module>
15632
15633	</library>
15634
15635	</idl>
15636
15637	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format