VirtualBox.xidl@ 24464

Last change on this file since 24464 was 24464, checked in by vboxsync, 15 years ago
TakeScreenShotSlow corrected comment and API spec.
Property svn:eol-style set to `native`
File size: 500.3 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4	* :tabSize=2:indentSize=2:noTabs=true:
5	* :folding=explicit:collapseFolds=1:
6	*
7	* Master declaration for VirtualBox's Main API, represented
8	* by COM/XPCOM and web service interfaces.
9	*
10	* From this document, the build system generates several files
11	* via XSLT that are then used during the build process.
12	*
13	* Below is the list of XSL templates that operate on this file and
14	* output files they generate. These XSL templates must be updated
15	* whenever the schema of this file changes:
16	*
17	* 1. src/VBox/Main/idl/midl.xsl =>
18	* out/<platform>/bin/sdk/idl/VirtualBox.idl
19	* (MS COM interface definition file for Main API)
20	*
21	* 2. src/VBox/Main/idl/xpidl.xsl =>
22	* out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
23	* (XPCOM interface definition file for Main API)
24	*
25	* 3. src/VBox/Main/idl/doxygen.xsl =>
26	* out/<platform>/obj/src/VBox/Main/VirtualBox.idl
27	* (pseudo-IDL for Doxygen to generate the official Main API
28	* documentation)
29	*
30	* 4. src/VBox/Main/webservice/*.xsl =>
31	* a bunch of WSDL and C++ files
32	* (VirtualBox web service sources and SOAP mappers;
33	* see src/VBox/Main/webservice/Makefile.kmk for details)
34	*
35	* 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
36	* out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
37	* (smart Qt-based C++ wrapper classes for COM interfaces
38	* of the Main API)
39	*
40	* 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
41	* out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
42	* (Main API TypeLib block for the WiX installer)
43	*
44	* 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
45	* out/<platform>/obj/Runtime/errmsgvboxcomdata.h
46	* (<result> extraction for the %Rhrc format specifier)
47	*
48	Copyright (C) 2006-2009 Sun Microsystems, Inc.
49
50	This file is part of VirtualBox Open Source Edition (OSE), as
51	available from http://www.virtualbox.org. This file is free software;
52	you can redistribute it and/or modify it under the terms of the GNU
53	General Public License (GPL) as published by the Free Software
54	Foundation, in version 2 as it comes in the "COPYING" file of the
55	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
56	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
57
58	Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
59	Clara, CA 95054 USA or visit http://www.sun.com if you need
60	additional information or have any questions.
61	-->
62
63	<idl>
64
65	<desc>
66	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
67	describes the so-called <i>VirtualBox Main API</i> which comprises all public
68	COM interfaces and components provided by the VirtualBox server and by the
69	VirtualBox client library.
70
71	VirtualBox employs a client-server design, meaning that whenever any part of
72	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
73	interface or any virtual machine --, a dedicated server process named
74	VBoxSVC runs in the background. This allows multiple processes working with
75	VirtualBox to cooperate without conflicts. These processes communicate to each
76	other using inter-process communication facilities provided by the COM
77	implementation of the host computer.
78
79	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
80	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
81	implementation, is used.
82
83	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
84	the VBoxManage command-line interface and the VBoxVRDP server) are technically
85	front-ends to the Main API and only use the interfaces that are documented
86	in this Main API documentation. This ensures that, with any given release
87	version of VirtualBox, all capabilities of the product that could be useful
88	to an external client program are always exposed by way of this API.
89
90	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
91	contains two public component classes:
92	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
93	implement IVirtualBox and ISession interfaces respectively. These two classes
94	are of supreme importance and will be needed in order for any front-end
95	program to do anything useful. It is recommended to read the documentation of
96	the mentioned interfaces first.
97
98	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
99	there can be only one object of this class on the local machine at any given
100	time. This object is a parent of many other objects in the VirtualBox COM
101	library and lives in the VBoxSVC process. In fact, when you create an instance
102	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
103	process is already running, starts it if not, and returns you a reference to
104	the <tt>VirtualBox</tt> object created in this process. When the last reference
105	to this object is released, the VBoxSVC process ends (with a 5 second delay to
106	protect from too frequent restarts).
107
108	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
109	as many <tt>Session</tt> objects as you need but all of them will live in a
110	process which issues the object instantiation call. <tt>Session</tt> objects
111	represent virtual machine sessions which are used to configure virtual
112	machines and control their execution.
113	</desc>
114
115	<if target="midl">
116	<cpp line="enum {"/>
117	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
118	<cpp line=" kTypeLibraryMinorVersion = 0"/>
119	<cpp line="};"/>
120	</if>
121
122	<if target="xpidl">
123	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
124	<cpp>
125	/* currently, nsISupportsImpl.h lacks the below-like macros */
126
127	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
128	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
129	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
130
131	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
132	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
133	NS_IMPL_THREADSAFE_ADDREF(_class) \
134	NS_IMPL_THREADSAFE_RELEASE(_class) \
135	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
136	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
137	#endif
138
139	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
140	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
141	NS_IMPL_THREADSAFE_ADDREF(_class) \
142	NS_IMPL_THREADSAFE_RELEASE(_class) \
143	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
144	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
145	#endif
146
147	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
148	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
149	NS_IMPL_THREADSAFE_ADDREF(_class) \
150	NS_IMPL_THREADSAFE_RELEASE(_class) \
151	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
152	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
153	#endif
154
155	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
156	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
157	NS_INTERFACE_MAP_BEGIN(_class) \
158	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
159	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
160	NS_IMPL_QUERY_CLASSINFO(_class) \
161	NS_INTERFACE_MAP_END
162	#endif
163
164	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
165	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
166	_i2, _ic2) \
167	NS_INTERFACE_MAP_BEGIN(_class) \
168	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
169	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
170	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
171	NS_IMPL_QUERY_CLASSINFO(_class) \
172	NS_INTERFACE_MAP_END
173	#endif
174
175	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
176	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
177	_i2, _ic2, _i3, _ic3) \
178	NS_INTERFACE_MAP_BEGIN(_class) \
179	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
180	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
183	NS_IMPL_QUERY_CLASSINFO(_class) \
184	NS_INTERFACE_MAP_END
185	#endif
186
187	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
188	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
189	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
190
191	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
192	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
193	NS_IMPL_THREADSAFE_ADDREF(_class) \
194	NS_IMPL_THREADSAFE_RELEASE(_class) \
195	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
196	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
197	#endif
198
199	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
200	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_THREADSAFE_ADDREF(_class) \
203	NS_IMPL_THREADSAFE_RELEASE(_class) \
204	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
205	_i2, _ic2) \
206	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
207	#endif
208
209	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
210	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_THREADSAFE_ADDREF(_class) \
213	NS_IMPL_THREADSAFE_RELEASE(_class) \
214	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
215	_i2, _ic2, _i3, _ic3) \
216	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
217	#endif
218
219	</cpp>
220	</if>
221
222	<library
223	name="VirtualBox"
224	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
225	version="1.3"
226	desc="VirtualBox Type Library"
227	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
228	supportsErrorInfo="yes"
229	>
230
231
232	<!--
233	// COM result codes for VirtualBox
234	/////////////////////////////////////////////////////////////////////////
235	-->
236
237	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
238	<desc>
239	This section describes all VirtualBox-specific COM result codes that may
240	be returned by methods of VirtualBox COM interfaces in addition to
241	standard COM result codes.
242
243	Note that along with the result code, every VirtualBox method returns
244	extended error information through the IVirtualBoxErrorInfo interface on
245	failure. This interface is a preferred way to present the error to the end
246	user because it contains a human readable description of the error. Raw
247	result codes, both standard and described in this section, are intended to
248	be used by programs to analyze the reason of a failure and select an
249	appropriate course of action without involving the end user (for example,
250	retry the operation later or make a different call).
251
252	The standard COM result codes that may originate from our methods include:
253
254	<table>
255	<tr><td>E_INVALIDARG</td>
256	<td>
257	Returned when the value of the method's argument is not within the range
258	of valid values. This should not be confused with situations when the
259	value is within the range but simply doesn't suit the current object
260	state and there is a possibility that it will be accepted later (in such
261	cases VirtualBox-specific codes are returned, for example,
262	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
263	</td>
264	</tr>
265	<tr><td>E_POINTER</td>
266	<td>
267	Returned if a memory pointer for the output argument is invalid (for
268	example, @c null). Note that when pointers representing input
269	arguments (such as strings) are invalid, E_INVALIDARG is returned.
270	</td>
271	</tr>
272	<tr><td>E_ACCESSDENIED</td>
273	<td>
274	Returned when the called object is not ready. Since the lifetime of a
275	public COM object cannot be fully controlled by the implementation,
276	VirtualBox maintains the readiness state for all objects it creates and
277	returns this code in response to any method call on the object that was
278	deactivated by VirtualBox and is not functioning any more.
279	</td>
280	</tr>
281	<tr><td>E_OUTOFMEMORY</td>
282	<td>
283	Returned when a memory allocation operation fails.
284	</td>
285	</tr>
286	</table>
287	</desc>
288	</descGroup>
289
290	<!--
291	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
292	everything in <result>/<desc> after (and including) the first dot, so express
293	the matter of the error code in the first sentence and keep it short.
294	-->
295
296	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
297	<desc>
298	Object corresponding to the supplied arguments does not exist.
299	</desc>
300	</result>
301
302	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
303	<desc>
304	Current virtual machine state prevents the operation.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
309	<desc>
310	Virtual machine error occurred attempting the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
315	<desc>
316	File not accessible or erroneous file contents.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
321	<desc>
322	Runtime subsystem error.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
327	<desc>
328	Pluggable Device Manager error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
333	<desc>
334	Current object state prohibits operation.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
339	<desc>
340	Host operating system related error.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
345	<desc>
346	Requested operation is not supported.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
351	<desc>
352	Invalid XML found.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
357	<desc>
358	Current session state prohibits operation.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
363	<desc>
364	Object being in use prohibits operation.
365	</desc>
366	</result>
367
368	<!--
369	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
370	everything in <result>/<desc> after (and including) the first dot, so express
371	the matter of the error code in the first sentence and keep it short.
372	-->
373
374	<descGroup/>
375
376	<!--
377	// all common enums
378	/////////////////////////////////////////////////////////////////////////
379	-->
380
381	<enum name="SettingsVersion"
382	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
383	>
384	<desc>Settings version of VirtualBox settings files. This is written to
385	the "version" attribute of the root "VirtualBox" element in the settings
386	file XML and indicates which VirtualBox version wrote the file.
387	</desc>
388
389	<const name="Null" value="0">
390	<desc>Null value, indicates invalid version.</desc>
391	</const>
392	<const name="v1_0" value="1">
393	<desc>Legacy settings version, not currently supported.</desc>
394	</const>
395	<const name="v1_1" value="2">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_2" value="3">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_3pre" value="4">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3" value="5">
405	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
406	<!--
407	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
408	-->
409	</const>
410	<const name="v1_4" value="6">
411	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
412	<!--
413	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
414	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
415	-->
416	</const>
417	<const name="v1_5" value="7">
418	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
419	<!-- 2008-09-04: 2.0.0 released
420	2008-11-20: settings version 1.5 introduced
421	2008-12-17: 2.1.0 released
422	Machine changes:
423	guest OS identifiers changed;
424	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
425	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
426	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
427	-->
428	</const>
429	<const name="v1_6" value="8">
430	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
431	<!-- 2008-12-17: 2.1.0 released
432	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
433	2009-04-08: 2.2.0 released
434	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
435	-->
436	</const>
437	<const name="v1_7" value="9">
438	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
439	<!-- 2008-12-17: 2.1.0 released
440	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
441	2009-04-08: 2.2.0 released
442	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
443	Machine changes: HardDiskAttachments is now StorageControllers (done)
444	-->
445	</const>
446	<const name="v1_8" value="10">
447	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
448	<!-- Machine additions: Display/@accelerate2DVideo (done)
449	-->
450	</const>
451	<const name="v1_9" value="11">
452	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
453	<!-- The big storage controller / DVD / Floppy rework (done)
454	-->
455	</const>
456	<const name="Future" value="12">
457	<desc>Settings version greater than "1.9", written by a future VirtualBox version.</desc>
458	</const>
459	</enum>
460
461	<enum
462	name="AccessMode"
463	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
464	>
465	<desc>
466	Access mode for opening files.
467	</desc>
468
469	<const name="ReadOnly" value="1"/>
470	<const name="ReadWrite" value="2"/>
471	</enum>
472
473	<enum
474	name="MachineState"
475	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
476	>
477	<desc>
478	Virtual machine execution state.
479
480	This enumeration represents possible values of the <link
481	to="IMachine::state"/> attribute.
482
483	Below is the basic virtual machine state diagram. It shows how the state
484	changes during virtual machine execution. The text in square braces shows
485	a method of the IConsole interface that performs the given state
486	transition.
487
488	<pre>
489	+---------[powerDown()] <- Stuck <--[failure]-+
490	V \|
491	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
492	\| \| \| \| V \|
493	\| Aborted -----+ +--> Running --[pause()]--> Paused
494	\| \| ^ \| ^ \|
495	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
496	\| ^ \| \| \| \|
497	\| \| +-----------------------------------------+-\|-------------------+ +
498	\| \| \| \| \|
499	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
500	\| \| \| \|
501	\| +-------- Saving <--------[saveState()]<----------+---------------------+
502	\| \| \|
503	+-------------- Stopping -------[powerDown()]<----------+---------------------+
504	</pre>
505
506	Note that states to the right from PoweredOff, Aborted and Saved in the
507	above diagram are called <i>online VM states</i>. These states
508	represent the virtual machine which is being executed in a dedicated
509	process (usually with a GUI window attached to it where you can see the
510	activity of the virtual machine and interact with it). There are two
511	special pseudo-states, FirstOnline and LastOnline, that can be used in
512	relational expressions to detect if the given machine state is online or
513	not:
514
515	<pre>
516	if (machine.GetState() >= MachineState_FirstOnline &&
517	machine.GetState() <= MachineState_LastOnline)
518	{
519	...the machine is being executed...
520	}
521	</pre>
522
523	When the virtual machine is in one of the online VM states (that is, being
524	executed), only a few machine settings can be modified. Methods working
525	with such settings contain an explicit note about that. An attempt to
526	change any oter setting or perform a modifying operation during this time
527	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
528
529	All online states except Running, Paused and Stuck are transitional: they
530	represent temporary conditions of the virtual machine that will last as
531	long as the operation that initiated such a condition.
532
533	The Stuck state is a special case. It means that execution of the machine
534	has reached the "Guru Meditation" condition. This condition indicates an
535	internal VMM (virtual machine manager) failure which may happen as a
536	result of either an unhandled low-level virtual hardware exception or one
537	of the recompiler exceptions (such as the <i>too-many-traps</i>
538	condition).
539
540	Note also that any online VM state may transit to the Aborted state. This
541	happens if the process that is executing the virtual machine terminates
542	unexpectedly (for example, crashes). Other than that, the Aborted state is
543	equivalent to PoweredOff.
544
545	There are also a few additional state diagrams that do not deal with
546	virtual machine execution and therefore are shown separately. The states
547	shown on these diagrams are called <i>offline VM states</i> (this includes
548	PoweredOff, Aborted and Saved too).
549
550	The first diagram shows what happens when a lengthy setup operation is
551	being executed (such as <link to="IMachine::attachDevice"/>).
552
553	<pre>
554	+----------------------------------(same state as before the call)------+
555	\| \|
556	+-> PoweredOff --+ \|
557	\| \| \|
558	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
559	\| \|
560	+-> Saved -------+
561	</pre>
562
563	The next two diagrams demonstrate the process of taking a snapshot of a
564	powered off virtual machine and performing one of the "discard..."
565	operations, respectively.
566
567	<pre>
568	+----------------------------------(same state as before the call)------+
569	\| \|
570	+-> PoweredOff --+ \|
571	\| +-->[takeSnapshot()] -------------------> Saving ------+
572	+-> Aborted -----+
573
574	+-> PoweredOff --+
575	\| \|
576	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
577	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
578	+-> Saved -------+ \|
579	\| \|
580	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
581	</pre>
582
583	Note that the Saving state is present in both the offline state group and
584	online state group. Currently, the only way to determine what group is
585	assumed in a particular case is to remember the previous machine state: if
586	it was Running or Paused, then Saving is an online state, otherwise it is
587	an offline state. This inconsistency may be removed in one of the future
588	versions of VirtualBox by adding a new state.
589
590	<note internal="yes">
591	For whoever decides to touch this enum: In order to keep the
592	comparisons involving FirstOnline and LastOnline pseudo-states valid,
593	the numeric values of these states must be correspondingly updated if
594	needed: for any online VM state, the condition
595	<tt>FirstOnline <= state <= LastOnline</tt> must be
596	@c true. The same relates to transient states for which
597	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
598	@c true.
599	</note>
600	</desc>
601
602	<const name="Null" value="0">
603	<desc>Null value (never used by the API).</desc>
604	</const>
605	<const name="PoweredOff" value="1">
606	<desc>
607	The machine is not running and has no saved execution state; it has
608	either never been started or been shut down successfully.
609	</desc>
610	</const>
611	<const name="Saved" value="2">
612	<desc>
613	The machine is not currently running, but the execution state of the machine
614	has been saved to an external file when it was running, from where
615	it can be resumed.
616	</desc>
617	</const>
618	<const name="Teleported" value="3">
619	<desc>
620	The machine was teleported to a different host (or process) and then
621	powered off. Take care when powering it on again may corrupt resources
622	it shares with the teleportation target (e.g. disk and network).
623	</desc>
624	</const>
625	<const name="Aborted" value="4">
626	<desc>
627	The process running the machine has terminated abnormally. This may
628	indicate a crash of the VM process in host execution context, or
629	the VM process has been terminated externally.
630	</desc>
631	</const>
632	<const name="Running" value="5">
633	<desc>
634	The machine is currently being executed.
635	<note internal="yes">
636	For whoever decides to touch this enum: In order to keep the
637	comparisons in the old source code valid, this state must immediately
638	precede the Paused state.
639	TODO: Lift this spectacularly wonderful restriction.
640	</note>
641	</desc>
642	</const>
643	<const name="Paused" value="6">
644	<desc>
645	Execution of the machine has been paused.
646	<note internal="yes">
647	For whoever decides to touch this enum: In order to keep the
648	comparisons in the old source code valid, this state must immediately
649	follow the Running state.
650	TODO: Lift this spectacularly wonderful restriction.
651	</note>
652	</desc>
653	</const>
654	<const name="Stuck" value="7">
655	<desc>
656	Execution of the machine has reached the "Guru Meditation"
657	condition. This indicates a severe error in the hypervisor itself.
658	<note internal="yes">
659	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
660	"Guru", perhaps? Or are there some other VMM states that are
661	intended to be lumped in here as well?
662	</note>
663	</desc>
664	</const>
665	<const name="Teleporting" value="8">
666	<desc>
667	The machine is about to be teleported to a different host or process.
668	It is possible to pause a machine in this state, but it will go to the
669	<link to="MachineState::PausedTeleporting"/> state and it will not be
670	possible to resume it again unless the teleportation fails.
671	</desc>
672	</const>
673	<const name="LiveSnapshotting" value="9">
674	<desc>
675	A live snapshot is being taken. The machine is running normally, but
676	some of the runtime configuration options are inaccessible. Also, if
677	paused while in this state it will transition to
678	<link to="MachineState::Saving"/> and it will not be resume the
679	execution until the snapshot operation has completed.
680	</desc>
681	</const>
682	<const name="Starting" value="10">
683	<desc>
684	Machine is being started after powering it on from a
685	zero execution state.
686	</desc>
687	</const>
688	<const name="Stopping" value="11">
689	<desc>
690	Machine is being normally stopped powering it off, or after the guest OS
691	has initiated a shutdown sequence.
692	</desc>
693	</const>
694	<const name="Saving" value="12">
695	<desc>
696	Machine is saving its execution state to a file, or an online
697	snapshot of the machine is being taken.
698	</desc>
699	</const>
700	<const name="Restoring" value="13">
701	<desc>
702	Execution state of the machine is being restored from a file
703	after powering it on from the saved execution state.
704	</desc>
705	</const>
706	<const name="TeleportingPausedVM" value="14">
707	<desc>
708	The machine is being teleported to another host or process, but it is
709	not running. This is the paused variant of the
710	<link to="MachineState::Teleporting"/> state.
711	</desc>
712	</const>
713	<const name="TeleportingIn" value="15">
714	<desc>
715	Teleporting the machine state in from another host or process.
716	</desc>
717	</const>
718	<const name="RestoringSnapshot" value="16">
719	<desc>
720	A machine snapshot is being restored; this typically does not take long.
721	</desc>
722	</const>
723	<const name="DeletingSnapshot" value="17">
724	<desc>
725	A machine snapshot is being deleted; this can take a long time since this
726	may require merging differencing media.
727	</desc>
728	</const>
729	<const name="SettingUp" value="18">
730	<desc>
731	Lengthy setup operation is in progress.
732	</desc>
733	</const>
734
735	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
736	<desc>
737	Pseudo-state: first online state (for use in relational expressions).
738	</desc>
739	</const>
740	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
741	<desc>
742	Pseudo-state: last online state (for use in relational expressions).
743	</desc>
744	</const>
745
746	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
747	<desc>
748	Pseudo-state: first transient state (for use in relational expressions).
749	</desc>
750	</const>
751	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
752	<desc>
753	Pseudo-state: last transient state (for use in relational expressions).
754	</desc>
755	</const>
756
757	</enum>
758
759	<enum
760	name="SessionState"
761	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
762	>
763	<desc>
764	Session state. This enumeration represents possible values of
765	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
766	attributes. See individual enumerator descriptions for the meaning for
767	every value.
768	</desc>
769
770	<const name="Null" value="0">
771	<desc>Null value (never used by the API).</desc>
772	</const>
773	<const name="Closed" value="1">
774	<desc>
775	The machine has no open sessions (<link to="IMachine::sessionState"/>);
776	the session is closed (<link to="ISession::state"/>)
777	</desc>
778	</const>
779	<const name="Open" value="2">
780	<desc>
781	The machine has an open direct session (<link to="IMachine::sessionState"/>);
782	the session is open (<link to="ISession::state"/>)
783	</desc>
784	</const>
785	<const name="Spawning" value="3">
786	<desc>
787	A new (direct) session is being opened for the machine as a result of
788	<link to="IVirtualBox::openRemoteSession"/> call
789	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
790	This state also occurs as a short transient state when a new direct
791	session is opened by calling <link to="IVirtualBox::openSession"/>.
792	</desc>
793	</const>
794	<const name="Closing" value="4">
795	<desc>
796	The direct session is being closed (<link to="IMachine::sessionState"/>);
797	the session is being closed (<link to="ISession::state"/>)
798	</desc>
799	</const>
800	</enum>
801
802	<enum
803	name="CpuPropertyType"
804	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
805	>
806	<desc>
807	Virtual CPU property type. This enumeration represents possible values of the
808	IMachine get- and setCpuProperty methods.
809	</desc>
810	<const name="Null" value="0">
811	<desc>Null value (never used by the API).</desc>
812	</const>
813	<const name="PAE" value="1">
814	<desc>
815	This setting determines whether VirtualBox will expose the Physical Address
816	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
817	is not available, it will not be reported.
818	</desc>
819	</const>
820	<const name="Synthetic" value="2">
821	<desc>
822	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
823	teleporting between host systems that differ significantly.
824	</desc>
825	</const>
826	</enum>
827
828
829	<enum
830	name="HWVirtExPropertyType"
831	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
832	>
833	<desc>
834	Hardware virtualization property type. This enumeration represents possible values
835	for the <link to="IMachine::getHWVirtExProperty"/> and
836	<link to="IMachine::setHWVirtExProperty"/> methods.
837	</desc>
838	<const name="Null" value="0">
839	<desc>Null value (never used by the API).</desc>
840	</const>
841	<const name="Enabled" value="1">
842	<desc>
843	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
844	such extensions are not available, they will not be used.
845	</desc>
846	</const>
847	<const name="Exclusive" value="2">
848	<desc>
849	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
850	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
851	feature of the host. To share these with other hypervisors, you must disable this property.
852	</desc>
853	</const>
854	<const name="VPID" value="3">
855	<desc>
856	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
857	</desc>
858	</const>
859	<const name="NestedPaging" value="4">
860	<desc>
861	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
862	</desc>
863	</const>
864	</enum>
865
866	<enum
867	name="SessionType"
868	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
869	>
870	<desc>
871	Session type. This enumeration represents possible values of the
872	<link to="ISession::type"/> attribute.
873	</desc>
874
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="Direct" value="1">
879	<desc>
880	Direct session
881	(opened by <link to="IVirtualBox::openSession"/>)
882	</desc>
883	</const>
884	<const name="Remote" value="2">
885	<desc>
886	Remote session
887	(opened by <link to="IVirtualBox::openRemoteSession"/>)
888	</desc>
889	</const>
890	<const name="Existing" value="3">
891	<desc>
892	Existing session
893	(opened by <link to="IVirtualBox::openExistingSession"/>)
894	</desc>
895	</const>
896	</enum>
897
898	<enum
899	name="DeviceType"
900	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
901	>
902	<desc>
903	Device type.
904	</desc>
905	<const name="Null" value="0">
906	<desc>
907	Null value, may also mean "no device" (not allowed for
908	<link to="IConsole::getDeviceActivity"/>).
909	</desc>
910	</const>
911	<const name="Floppy" value="1">
912	<desc>Floppy device.</desc>
913	</const>
914	<const name="DVD" value="2">
915	<desc>CD/DVD-ROM device.</desc>
916	</const>
917	<const name="HardDisk" value="3">
918	<desc>Hard disk device.</desc>
919	</const>
920	<const name="Network" value="4">
921	<desc>Network device.</desc>
922	</const>
923	<const name="USB" value="5">
924	<desc>USB device.</desc>
925	</const>
926	<const name="SharedFolder" value="6">
927	<desc>Shared folder device.</desc>
928	</const>
929	</enum>
930
931	<enum
932	name="DeviceActivity"
933	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
934	>
935	<desc>
936	Device activity for <link to="IConsole::getDeviceActivity"/>.
937	</desc>
938
939	<const name="Null" value="0"/>
940	<const name="Idle" value="1"/>
941	<const name="Reading" value="2"/>
942	<const name="Writing" value="3"/>
943	</enum>
944
945	<enum
946	name="ClipboardMode"
947	uuid="33364716-4008-4701-8f14-be0fa3d62950"
948	>
949	<desc>
950	Host-Guest clipboard interchange mode.
951	</desc>
952
953	<const name="Disabled" value="0"/>
954	<const name="HostToGuest" value="1"/>
955	<const name="GuestToHost" value="2"/>
956	<const name="Bidirectional" value="3"/>
957	</enum>
958
959	<enum
960	name="Scope"
961	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
962	>
963	<desc>
964	Scope of the operation.
965
966	A generic enumeration used in various methods to define the action or
967	argument scope.
968	</desc>
969
970	<const name="Global" value="0"/>
971	<const name="Machine" value="1"/>
972	<const name="Session" value="2"/>
973	</enum>
974
975	<enum
976	name="GuestStatisticType"
977	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
978	>
979	<desc>
980	Statistics type for <link to="IGuest::getStatistic"/>.
981	</desc>
982
983	<const name="CPULoad_Idle" value="0">
984	<desc>
985	Idle CPU load (0-100%) for last interval.
986	</desc>
987	</const>
988	<const name="CPULoad_Kernel" value="1">
989	<desc>
990	Kernel CPU load (0-100%) for last interval.
991	</desc>
992	</const>
993	<const name="CPULoad_User" value="2">
994	<desc>
995	User CPU load (0-100%) for last interval.
996	</desc>
997	</const>
998	<const name="Threads" value="3">
999	<desc>
1000	Total number of threads in the system.
1001	</desc>
1002	</const>
1003	<const name="Processes" value="4">
1004	<desc>
1005	Total number of processes in the system.
1006	</desc>
1007	</const>
1008	<const name="Handles" value="5">
1009	<desc>
1010	Total number of handles in the system.
1011	</desc>
1012	</const>
1013	<const name="MemoryLoad" value="6">
1014	<desc>
1015	Memory load (0-100%).
1016	</desc>
1017	</const>
1018	<const name="PhysMemTotal" value="7">
1019	<desc>
1020	Total physical memory in megabytes.
1021	</desc>
1022	</const>
1023	<const name="PhysMemAvailable" value="8">
1024	<desc>
1025	Free physical memory in megabytes.
1026	</desc>
1027	</const>
1028	<const name="PhysMemBalloon" value="9">
1029	<desc>
1030	Ballooned physical memory in megabytes.
1031	</desc>
1032	</const>
1033	<const name="MemCommitTotal" value="10">
1034	<desc>
1035	Total amount of memory in the committed state in megabytes.
1036	</desc>
1037	</const>
1038	<const name="MemKernelTotal" value="11">
1039	<desc>
1040	Total amount of memory used by the guest OS's kernel in megabytes.
1041	</desc>
1042	</const>
1043	<const name="MemKernelPaged" value="12">
1044	<desc>
1045	Total amount of paged memory used by the guest OS's kernel in megabytes.
1046	</desc>
1047	</const>
1048	<const name="MemKernelNonpaged" value="13">
1049	<desc>
1050	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1051	</desc>
1052	</const>
1053	<const name="MemSystemCache" value="14">
1054	<desc>
1055	Total amount of memory used by the guest OS's system cache in megabytes.
1056	</desc>
1057	</const>
1058	<const name="PageFileSize" value="15">
1059	<desc>
1060	Pagefile size in megabytes.
1061	</desc>
1062	</const>
1063	<const name="SampleNumber" value="16">
1064	<desc>
1065	Statistics sample number
1066	</desc>
1067	</const>
1068	<const name="MaxVal" value="17"/>
1069	</enum>
1070
1071	<enum
1072	name="BIOSBootMenuMode"
1073	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1074	>
1075	<desc>
1076	BIOS boot menu mode.
1077	</desc>
1078
1079	<const name="Disabled" value="0"/>
1080	<const name="MenuOnly" value="1"/>
1081	<const name="MessageAndMenu" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="ProcessorFeature"
1086	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1087	>
1088	<desc>
1089	CPU features.
1090	</desc>
1091
1092	<const name="HWVirtEx" value="0"/>
1093	<const name="PAE" value="1"/>
1094	<const name="LongMode" value="2"/>
1095	<const name="NestedPaging" value="3"/>
1096	</enum>
1097
1098	<enum
1099	name="FirmwareType"
1100	uuid="7ceea938-8b49-41e2-bb47-667219c0d586"
1101	>
1102	<desc>
1103	Firmware type.
1104	</desc>
1105	<const name="BIOS" value="1">
1106	<desc>BIOS Firmware.</desc>
1107	</const>
1108	<const name="EFI" value="2">
1109	<desc>Efi firmware.</desc>
1110	</const>
1111	</enum>
1112
1113	<!--
1114	// IVirtualBoxErrorInfo
1115	/////////////////////////////////////////////////////////////////////////
1116	-->
1117
1118	<interface
1119	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1120	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1121	supportsErrorInfo="no"
1122	wsmap="managed"
1123	>
1124	<desc>
1125	The IVirtualBoxErrorInfo interface represents extended error information.
1126
1127	Extended error information can be set by VirtualBox components after
1128	unsuccessful or partially successful method invocation. This information
1129	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1130	and then shown to the client in addition to the plain 32-bit result code.
1131
1132	In MS COM, this interface extends the IErrorInfo interface,
1133	in XPCOM, it extends the nsIException interface. In both cases,
1134	it provides a set of common attributes to retrieve error
1135	information.
1136
1137	Sometimes invocation of some component's method may involve methods of
1138	other components that may also fail (independently of this method's
1139	failure), or a series of non-fatal errors may precede a fatal error that
1140	causes method failure. In cases like that, it may be desirable to preserve
1141	information about all errors happened during method invocation and deliver
1142	it to the caller. The <link to="#next"/> attribute is intended
1143	specifically for this purpose and allows to represent a chain of errors
1144	through a single IVirtualBoxErrorInfo object set after method invocation.
1145
1146	Note that errors are stored to a chain in the reverse order, i.e. the
1147	initial error object you query right after method invocation is the last
1148	error set by the callee, the object it points to in the @a next attribute
1149	is the previous error and so on, up to the first error (which is the last
1150	in the chain).
1151	</desc>
1152
1153	<attribute name="resultCode" type="long" readonly="yes">
1154	<desc>
1155	Result code of the error.
1156	Usually, it will be the same as the result code returned
1157	by the method that provided this error information, but not
1158	always. For example, on Win32, CoCreateInstance() will most
1159	likely return E_NOINTERFACE upon unsuccessful component
1160	instantiation attempt, but not the value the component factory
1161	returned. Value is typed 'long', not 'result',
1162	to make interface usable from scripting languages.
1163	<note>
1164	In MS COM, there is no equivalent.
1165	In XPCOM, it is the same as nsIException::result.
1166	</note>
1167	</desc>
1168	</attribute>
1169
1170	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1171	<desc>
1172	UUID of the interface that defined the error.
1173	<note>
1174	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1175	data type.
1176	In XPCOM, there is no equivalent.
1177	</note>
1178	</desc>
1179	</attribute>
1180
1181	<attribute name="component" type="wstring" readonly="yes">
1182	<desc>
1183	Name of the component that generated the error.
1184	<note>
1185	In MS COM, it is the same as IErrorInfo::GetSource.
1186	In XPCOM, there is no equivalent.
1187	</note>
1188	</desc>
1189	</attribute>
1190
1191	<attribute name="text" type="wstring" readonly="yes">
1192	<desc>
1193	Text description of the error.
1194	<note>
1195	In MS COM, it is the same as IErrorInfo::GetDescription.
1196	In XPCOM, it is the same as nsIException::message.
1197	</note>
1198	</desc>
1199	</attribute>
1200
1201	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1202	<desc>
1203	Next error object if there is any, or @c null otherwise.
1204	<note>
1205	In MS COM, there is no equivalent.
1206	In XPCOM, it is the same as nsIException::inner.
1207	</note>
1208	</desc>
1209	</attribute>
1210
1211	</interface>
1212
1213	<interface
1214	name="ILocalOwner" extends="$dispatched"
1215	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1216	>
1217	<desc>
1218	The ILocalOwner interface allows to register local objects
1219	(created without COM calls, but with new()).
1220	Once registered, calls to methods of such objects can be made
1221	from remote COM processes.
1222	The main usecase is the event callback implementation where
1223	API clients provide callback objects.
1224	</desc>
1225	<method name="setLocalObject">
1226	<desc>
1227	Set local object.
1228	</desc>
1229	<param name="object" type="$unknown" dir="in">
1230	<desc>Local object to forward requests to.
1231	If null, clears currently set local object.</desc>
1232	</param>
1233	</method>
1234	</interface>
1235
1236	<!--
1237	// IVirtualBox
1238	/////////////////////////////////////////////////////////////////////////
1239	-->
1240
1241	<interface
1242	name="IVirtualBoxCallback" extends="$unknown"
1243	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1244	wsmap="suppress"
1245	>
1246
1247	<method name="onMachineStateChange">
1248	<desc>
1249	The execution state of the given machine has changed.
1250	<see>IMachine::state</see>
1251	</desc>
1252	<param name="machineId" type="uuid" mod="string" dir="in">
1253	<desc>ID of the machine this event relates to.</desc>
1254	</param>
1255	<param name="state" type="MachineState" dir="in">
1256	<desc>New execution state.</desc>
1257	</param>
1258	</method>
1259
1260	<method name="onMachineDataChange">
1261	<desc>
1262	Any of the settings of the given machine has changed.
1263	</desc>
1264	<param name="machineId" type="uuid" mod="string" dir="in">
1265	<desc>ID of the machine this event relates to.</desc>
1266	</param>
1267	</method>
1268
1269	<method name="onExtraDataCanChange">
1270	<desc>
1271	Notification when someone tries to change extra data for
1272	either the given machine or (if @c null) global extra data.
1273	This gives the chance to veto against changes.
1274	</desc>
1275	<param name="machineId" type="uuid" mod="string" dir="in">
1276	<desc>
1277	ID of the machine this event relates to
1278	(@c null ID for global extra data change requests).
1279	</desc>
1280	</param>
1281	<param name="key" type="wstring" dir="in">
1282	<desc>
1283	Extra data key for the attempted write.
1284	</desc>
1285	</param>
1286	<param name="value" type="wstring" dir="in">
1287	<desc>
1288	Extra data value for the given key.
1289	</desc>
1290	</param>
1291	<param name="error" type="wstring" dir="out">
1292	<desc>
1293	Optional error message describing the reason of the
1294	veto (ignored if this notification returns @c true).
1295	</desc>
1296	</param>
1297	<param name="allowChange" type="boolean" dir="return">
1298	<desc>
1299	Flag to indicate whether the callee agrees (@c true)
1300	or vetoes against the change (@c false).
1301	</desc>
1302	</param>
1303	</method>
1304
1305	<method name="onExtraDataChange">
1306	<desc>
1307	Notification when machine specific or global extra data
1308	has changed.
1309	</desc>
1310	<param name="machineId" type="uuid" mod="string" dir="in">
1311	<desc>
1312	ID of the machine this event relates to.
1313	Null for global extra data changes.
1314	</desc>
1315	</param>
1316	<param name="key" type="wstring" dir="in">
1317	<desc>
1318	Extra data key that has changed.
1319	</desc>
1320	</param>
1321	<param name="value" type="wstring" dir="in">
1322	<desc>
1323	Extra data value for the given key.
1324	</desc>
1325	</param>
1326	</method>
1327
1328	<method name="onMediumRegistered">
1329	<desc>
1330	The given medium was registered or unregistered
1331	within this VirtualBox installation.
1332
1333	The @a mediumType parameter describes what type of
1334	medium the specified @a mediumId refers to. Possible
1335	values are:
1336
1337	<ul>
1338	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1339	that, if registered, can be obtained using the
1340	<link to="IVirtualBox::getHardDisk"/> call.</li>
1341	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1342	that, if registered, can be obtained using the
1343	<link to="IVirtualBox::getDVDImage"/> call.</li>
1344	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1345	that, if registered, can be obtained using the
1346	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1347	</ul>
1348
1349	Note that if this is a deregistration notification,
1350	there is no way to access the object representing the
1351	unregistered medium. It is supposed that the
1352	application will do required cleanup based on the
1353	@a mediumId value.
1354	</desc>
1355	<param name="mediumId" type="uuid" mod="string" dir="in">
1356	<desc>ID of the medium this event relates to.</desc>
1357	</param>
1358	<param name="mediumType" type="DeviceType" dir="in">
1359	<desc>Type of the medium this event relates to.</desc>
1360	</param>
1361	<param name="registered" type="boolean" dir="in">
1362	<desc>
1363	If @c true, the medium was registered, otherwise it was
1364	unregistered.
1365	</desc>
1366	</param>
1367	</method>
1368
1369	<method name="onMachineRegistered">
1370	<desc>
1371	The given machine was registered or unregistered
1372	within this VirtualBox installation.
1373	</desc>
1374	<param name="machineId" type="uuid" mod="string" dir="in">
1375	<desc>ID of the machine this event relates to.</desc>
1376	</param>
1377	<param name="registered" type="boolean" dir="in">
1378	<desc>
1379	If @c true, the machine was registered, otherwise it was
1380	unregistered.
1381	</desc>
1382	</param>
1383	</method>
1384
1385	<method name="onSessionStateChange">
1386	<desc>
1387	The state of the session for the given machine was changed.
1388	<see>IMachine::sessionState</see>
1389	</desc>
1390	<param name="machineId" type="uuid" mod="string" dir="in">
1391	<desc>ID of the machine this event relates to.</desc>
1392	</param>
1393	<param name="state" type="SessionState" dir="in">
1394	<desc>New session state.</desc>
1395	</param>
1396	</method>
1397
1398	<method name="onSnapshotTaken">
1399	<desc>
1400	A new snapshot of the machine has been taken.
1401	<see>ISnapshot</see>
1402	</desc>
1403	<param name="machineId" type="uuid" mod="string" dir="in">
1404	<desc>ID of the machine this event relates to.</desc>
1405	</param>
1406	<param name="snapshotId" type="uuid" mod="string" dir="in">
1407	<desc>ID of the new snapshot.</desc>
1408	</param>
1409	</method>
1410
1411	<method name="onSnapshotDiscarded">
1412	<desc>
1413	Snapshot of the given machine has been discarded.
1414
1415	<note>
1416	This notification is delivered <b>after</b> the snapshot
1417	object has been uninitialized on the server (so that any
1418	attempt to call its methods will return an error).
1419	</note>
1420
1421	<see>ISnapshot</see>
1422	</desc>
1423	<param name="machineId" type="uuid" mod="string" dir="in">
1424	<desc>ID of the machine this event relates to.</desc>
1425	</param>
1426	<param name="snapshotId" type="uuid" mod="string" dir="in">
1427	<desc>
1428	ID of the discarded snapshot. @c null means the current machine
1429	state has been discarded (restored from the current snapshot).
1430	</desc>
1431	</param>
1432	</method>
1433
1434	<method name="onSnapshotChange">
1435	<desc>
1436	Snapshot properties (name and/or description) have been changed.
1437	<see>ISnapshot</see>
1438	</desc>
1439	<param name="machineId" type="uuid" mod="string" dir="in">
1440	<desc>ID of the machine this event relates to.</desc>
1441	</param>
1442	<param name="snapshotId" type="uuid" mod="string" dir="in">
1443	<desc>ID of the changed snapshot.</desc>
1444	</param>
1445	</method>
1446
1447	<method name="onGuestPropertyChange">
1448	<desc>
1449	Notification when a guest property has changed.
1450	</desc>
1451	<param name="machineId" type="uuid" mod="string" dir="in">
1452	<desc>
1453	ID of the machine this event relates to.
1454	</desc>
1455	</param>
1456	<param name="name" type="wstring" dir="in">
1457	<desc>
1458	The name of the property that has changed.
1459	</desc>
1460	</param>
1461	<param name="value" type="wstring" dir="in">
1462	<desc>
1463	The new property value.
1464	</desc>
1465	</param>
1466	<param name="flags" type="wstring" dir="in">
1467	<desc>
1468	The new property flags.
1469	</desc>
1470	</param>
1471	</method>
1472
1473	</interface>
1474
1475	<interface
1476	name="IDHCPServer" extends="$unknown"
1477	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1478	wsmap="managed"
1479	>
1480	<desc>
1481	The IDHCPServer interface represents the vbox dhcp server configuration.
1482
1483	To enumerate all the dhcp servers on the host, use the
1484	<link to="IVirtualBox::DHCPServers"/> attribute.
1485	</desc>
1486
1487	<attribute name="enabled" type="boolean">
1488	<desc>
1489	specifies if the dhcp server is enabled
1490	</desc>
1491	</attribute>
1492
1493	<attribute name="IPAddress" type="wstring" readonly="yes">
1494	<desc>
1495	specifies server IP
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="networkMask" type="wstring" readonly="yes">
1500	<desc>
1501	specifies server network mask
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="networkName" type="wstring" readonly="yes">
1506	<desc>
1507	specifies internal network name the server is used for
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="lowerIP" type="wstring" readonly="yes">
1512	<desc>
1513	specifies from IP adrres in server address range
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="upperIP" type="wstring" readonly="yes">
1518	<desc>
1519	specifies to IP adrres in server address range
1520	</desc>
1521	</attribute>
1522
1523	<method name="setConfiguration">
1524	<desc>
1525	configures the server
1526	<result name="E_INVALIDARG">
1527	invalid configuration supplied
1528	</result>
1529	</desc>
1530	<param name="IPAddress" type="wstring" dir="in">
1531	<desc>
1532	server IP address
1533	</desc>
1534	</param>
1535	<param name="networkMask" type="wstring" dir="in">
1536	<desc>
1537	server network mask
1538	</desc>
1539	</param>
1540	<param name="FromIPAddress" type="wstring" dir="in">
1541	<desc>
1542	server From IP address for address range
1543	</desc>
1544	</param>
1545	<param name="ToIPAddress" type="wstring" dir="in">
1546	<desc>
1547	server To IP address for address range
1548	</desc>
1549	</param>
1550	</method>
1551
1552	<method name="start">
1553	<desc>
1554	Starts DHCP server process.
1555	<result name="E_FAIL">
1556	Failed to start the process.
1557	</result>
1558	</desc>
1559	<param name="networkName" type="wstring" dir="in">
1560	<desc>
1561	Name of internal network DHCP server should attach to.
1562	</desc>
1563	</param>
1564	<param name="trunkName" type="wstring" dir="in">
1565	<desc>
1566	Name of internal network trunk.
1567	</desc>
1568	</param>
1569	<param name="trunkType" type="wstring" dir="in">
1570	<desc>
1571	Type of internal network trunk.
1572	</desc>
1573	</param>
1574	</method>
1575
1576	<method name="stop">
1577	<desc>
1578	Stops DHCP server process.
1579	<result name="E_FAIL">
1580	Failed to stop the process.
1581	</result>
1582	</desc>
1583	</method>
1584	</interface>
1585
1586	<interface
1587	name="IVirtualBox" extends="$dispatched"
1588	uuid="c1b8d85d-8f44-4314-94fc-072332bdf852"
1589	wsmap="managed"
1590	>
1591	<desc>
1592	The IVirtualBox interface represents the main interface exposed by the
1593	product that provides virtual machine management.
1594
1595	An instance of IVirtualBox is required for the product to do anything
1596	useful. Even though the interface does not expose this, internally,
1597	IVirtualBox is implemented as a singleton and actually lives in the
1598	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1599	IVirtualBox can track the state of all virtual machines on a particular
1600	host, regardless of which frontend started them.
1601
1602	To enumerate all the virtual machines on the host, use the
1603	<link to="IVirtualBox::machines"/> attribute.
1604	</desc>
1605
1606	<attribute name="version" type="wstring" readonly="yes">
1607	<desc>
1608	A string representing the version number of the product. The
1609	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1610	last number represents the build number and will frequently change.
1611	</desc>
1612	</attribute>
1613
1614	<attribute name="revision" type="unsigned long" readonly="yes">
1615	<desc>
1616	The internal build revision number of the product.
1617	</desc>
1618	</attribute>
1619
1620	<attribute name="packageType" type="wstring" readonly="yes">
1621	<desc>
1622	A string representing the package type of this product. The
1623	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1624	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1625	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1626	this.
1627	</desc>
1628	</attribute>
1629
1630	<attribute name="homeFolder" type="wstring" readonly="yes">
1631	<desc>
1632	Full path to the directory where the global settings file,
1633	<tt>VirtualBox.xml</tt>, is stored.
1634
1635	In this version of VirtualBox, the value of this property is
1636	always <tt><user_dir>/.VirtualBox</tt> (where
1637	<tt><user_dir></tt> is the path to the user directory,
1638	as determined by the host OS), and cannot be changed.
1639
1640	This path is also used as the base to resolve relative paths in
1641	places where relative paths are allowed (unless otherwise
1642	expressly indicated).
1643	</desc>
1644	</attribute>
1645
1646	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1647	<desc>
1648	Full name of the global settings file.
1649	The value of this property corresponds to the value of
1650	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1651	</desc>
1652	</attribute>
1653
1654	<attribute name="host" type="IHost" readonly="yes">
1655	<desc>Associated host object.</desc>
1656	</attribute>
1657
1658	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1659	<desc>Associated system information object.</desc>
1660	</attribute>
1661
1662	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1663	<desc>
1664	Array of machine objects registered within this VirtualBox instance.
1665	</desc>
1666	</attribute>
1667
1668	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1669	<desc>
1670	Array of medium objects known to this VirtualBox installation.
1671
1672	This array contains only base media. All differencing
1673	media of the given base medium can be enumerated using
1674	<link to="IMedium::children"/>.
1675	</desc>
1676	</attribute>
1677
1678	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1679	<desc>
1680	Array of CD/DVD image objects registered with this VirtualBox instance.
1681	</desc>
1682	</attribute>
1683
1684	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1685	<desc>
1686	Array of floppy image objects registered with this VirtualBox instance.
1687	</desc>
1688	</attribute>
1689
1690	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1691
1692	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1693
1694	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1695	<desc>
1696	Collection of global shared folders. Global shared folders are
1697	available to all virtual machines.
1698
1699	New shared folders are added to the collection using
1700	<link to="#createSharedFolder"/>. Existing shared folders can be
1701	removed using <link to="#removeSharedFolder"/>.
1702
1703	<note>
1704	In the current version of the product, global shared folders are not
1705	implemented and therefore this collection is always empty.
1706	</note>
1707	</desc>
1708	</attribute>
1709
1710	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1711	<desc>
1712	Associated performance collector object.
1713	</desc>
1714	</attribute>
1715
1716	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1717	<desc>
1718	dhcp server settings.
1719	</desc>
1720	</attribute>
1721
1722	<method name="createMachine">
1723	<desc>
1724	Creates a new virtual machine.
1725
1726	The new machine is created unregistered, with the initial configuration
1727	set according to the specified guest OS type. A typical sequence of
1728	actions to create a new virtual machine is as follows:
1729
1730	<ol>
1731	<li>
1732	Call this method to have a new machine created. The returned machine
1733	object will be "mutable" allowing to change any machine property.
1734	</li>
1735
1736	<li>
1737	Configure the machine using the appropriate attributes and methods.
1738	</li>
1739
1740	<li>
1741	Call <link to="IMachine::saveSettings" /> to write the settings
1742	to the machine's XML settings file. The configuration of the newly
1743	created machine will not be saved to disk until this method is
1744	called.
1745	</li>
1746
1747	<li>
1748	Call <link to="#registerMachine" /> to add the machine to the list
1749	of machines known to VirtualBox.
1750	</li>
1751	</ol>
1752
1753	You should specify valid name for the newly created machine when calling
1754	this method. See the <link to="IMachine::name"/> attribute description
1755	for more details about the machine name.
1756
1757	The specified guest OS type identifier must match an ID of one of known
1758	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1759	array.
1760
1761	Every machine has a <i>settings file</i> that is used to store
1762	the machine configuration. This file is stored in a directory called the
1763	<i>machine settings subfolder</i>. Both the settings subfolder and file
1764	will have a name that corresponds to the name of the virtual machine.
1765	You can specify where to create the machine setting subfolder using the
1766	@a baseFolder argument. The base folder can be absolute (full path) or
1767	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1768	directory</link>.
1769
1770	If @a baseFolder is a @c null or empty string (which is recommended), the
1771	<link to="ISystemProperties::defaultMachineFolder">default machine
1772	settings folder</link> will be used as a base folder for the created
1773	machine. Otherwise the given base folder will be used. In either case,
1774	the full path to the resulting settings file has the following
1775	structure:
1776	<pre>
1777	<base_folder>/<machine_name>/<machine_name>.xml
1778	</pre>
1779
1780	Note that if the resulting settings file already exists, this method
1781	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1782
1783	Optionally, you may specify an UUID of to assign to the created machine.
1784	However, this is not recommended and you should normally pass an empty
1785	(@c null) UUID to this method so that a new UUID will be automatically
1786	generated for every created machine. You can use UUID
1787	00000000-0000-0000-0000-000000000000 as @c null value.
1788
1789	<note>
1790	There is no way to change the name of the settings file or
1791	subfolder of the created machine directly.
1792	</note>
1793
1794	<result name="VBOX_E_OBJECT_NOT_FOUND">
1795	@a osTypeId is invalid.
1796	</result>
1797	<result name="VBOX_E_FILE_ERROR">
1798	Resulting settings file name is invalid or the settings file already
1799	exists or could not be created due to an I/O error.
1800	</result>
1801	<result name="E_INVALIDARG">
1802	@a name is empty or @c null.
1803	</result>
1804	</desc>
1805
1806	<param name="name" type="wstring" dir="in">
1807	<desc>Machine name.</desc>
1808	</param>
1809	<param name="osTypeId" type="wstring" dir="in">
1810	<desc>Guest OS Type ID.</desc>
1811	</param>
1812	<param name="baseFolder" type="wstring" dir="in">
1813	<desc>Base machine folder (optional).</desc>
1814	</param>
1815	<param name="id" type="uuid" mod="string" dir="in">
1816	<desc>Machine UUID (optional).</desc>
1817	</param>
1818	<param name="machine" type="IMachine" dir="return">
1819	<desc>Created machine object.</desc>
1820	</param>
1821	</method>
1822
1823	<method name="createLegacyMachine">
1824	<desc>
1825	Creates a new virtual machine in "legacy" mode, using the specified
1826	settings file to store machine settings.
1827
1828	As opposed to machines created by <link to="#createMachine"/>,
1829	the settings file of the machine created in "legacy" mode is not
1830	automatically renamed when the machine name is changed -- it will always
1831	remain the same as specified in this method call.
1832
1833	The specified settings file name can be absolute (full path) or relative
1834	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1835	directory</link>. If the file name doesn't contain an extension, the
1836	default extension (.xml) will be appended.
1837
1838	Note that the configuration of the newly created machine is not
1839	saved to disk (and therefore no settings file is created)
1840	until <link to="IMachine::saveSettings"/> is called. If the
1841	specified settings file already exists, this method
1842	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1843
1844	See <link to="#createMachine"/> for more information.
1845
1846	@deprecated This method may be removed later. Use <link
1847	to="IVirtualBox::createMachine"/> instead.
1848
1849	<note>
1850	There is no way to change the name of the settings file
1851	of the machine created in "legacy" mode.
1852	</note>
1853
1854	<result name="VBOX_E_OBJECT_NOT_FOUND">
1855	@a osTypeId is invalid.
1856	</result>
1857	<result name="VBOX_E_FILE_ERROR">
1858	@a settingsFile is invalid or the settings file already exists or
1859	could not be created due to an I/O error.
1860	</result>
1861	<result name="E_INVALIDARG">
1862	@a name or @a settingsFile is empty or @c null.
1863	</result>
1864	</desc>
1865
1866	<param name="name" type="wstring" dir="in">
1867	<desc>Machine name.</desc>
1868	</param>
1869	<param name="osTypeId" type="wstring" dir="in">
1870	<desc>Machine OS Type ID.</desc>
1871	</param>
1872	<param name="settingsFile" type="wstring" dir="in">
1873	<desc>Name of the machine settings file.</desc>
1874	</param>
1875	<param name="id" type="uuid" mod="string" dir="in">
1876	<desc>Machine UUID (optional).</desc>
1877	</param>
1878	<param name="machine" type="IMachine" dir="return">
1879	<desc>Created machine object.</desc>
1880	</param>
1881	</method>
1882
1883	<method name="openMachine">
1884	<desc>
1885	Opens a virtual machine from the existing settings file.
1886	The opened machine remains unregistered until you call
1887	<link to="#registerMachine"/>.
1888
1889	The specified settings file name can be absolute
1890	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1891	VirtualBox home directory</link>. This file must exist
1892	and must be a valid machine settings file whose contents
1893	will be used to construct the machine object.
1894
1895	@deprecated Will be removed soon.
1896	<result name="VBOX_E_FILE_ERROR">
1897	Settings file name invalid, not found or sharing violation.
1898	</result>
1899	</desc>
1900	<param name="settingsFile" type="wstring" dir="in">
1901	<desc>
1902	Name of the machine settings file.
1903	</desc>
1904	</param>
1905	<param name="machine" type="IMachine" dir="return">
1906	<desc>Opened machine object.</desc>
1907	</param>
1908	<note>
1909	<link to="IMachine::settingsModified"/> will return
1910	@c false for the created machine, until any of machine settings
1911	are changed.
1912	</note>
1913	</method>
1914
1915	<method name="registerMachine">
1916	<desc>
1917
1918	Registers the machine previously created using
1919	<link to="#createMachine"/> or opened using
1920	<link to="#openMachine"/> within this VirtualBox installation. After
1921	successful method invocation, the
1922	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1923	to all registered callbacks.
1924
1925	<note>
1926	This method implicitly calls <link to="IMachine::saveSettings"/>
1927	to save all current machine settings before registering it.
1928	</note>
1929
1930	<result name="VBOX_E_OBJECT_NOT_FOUND">
1931	No matching virtual machine found.
1932	</result>
1933	<result name="VBOX_E_INVALID_OBJECT_STATE">
1934	Virtual machine was not created within this VirtualBox instance.
1935	</result>
1936
1937	</desc>
1938	<param name="machine" type="IMachine" dir="in"/>
1939	</method>
1940
1941	<method name="getMachine">
1942	<desc>
1943	Attempts to find a virtual machine given its UUID.
1944	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1945	instead.
1946
1947	<result name="VBOX_E_OBJECT_NOT_FOUND">
1948	Could not find registered machine matching @a id.
1949	</result>
1950
1951	</desc>
1952	<param name="id" type="uuid" mod="string" dir="in"/>
1953	<param name="machine" type="IMachine" dir="return"/>
1954	</method>
1955
1956	<method name="findMachine">
1957	<desc>
1958	Attempts to find a virtual machine given its name.
1959	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1960	instead.
1961
1962	<result name="VBOX_E_OBJECT_NOT_FOUND">
1963	Could not find registered machine matching @a name.
1964	</result>
1965
1966	</desc>
1967	<param name="name" type="wstring" dir="in"/>
1968	<param name="machine" type="IMachine" dir="return"/>
1969	</method>
1970
1971	<method name="unregisterMachine">
1972	<desc>
1973
1974	Unregisters the machine previously registered using
1975	<link to="#registerMachine"/>. After successful method invocation, the
1976	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1977	to all registered callbacks.
1978
1979	<note>
1980	The specified machine must not be in the Saved state, have an open
1981	(or a spawning) direct session associated with it, have snapshots or
1982	have any medium attached.
1983	</note>
1984
1985	<note>
1986	This method implicitly calls <link to="IMachine::saveSettings"/> to
1987	save all current machine settings before unregistering it.
1988	</note>
1989
1990	<note>
1991	If the given machine is inaccessible (see
1992	<link to="IMachine::accessible"/>), it will be unregistered and
1993	fully uninitialized right afterwards. As a result, the returned
1994	machine object will be unusable and an attempt to call
1995	<b>any</b> method will return the "Object not ready" error.
1996	</note>
1997
1998	<result name="VBOX_E_OBJECT_NOT_FOUND">
1999	Could not find registered machine matching @a id.
2000	</result>
2001	<result name="VBOX_E_INVALID_VM_STATE">
2002	Machine is in Saved state.
2003	</result>
2004	<result name="VBOX_E_INVALID_OBJECT_STATE">
2005	Machine has snapshot or open session or medium attached.
2006	</result>
2007
2008	</desc>
2009	<param name="id" type="uuid" mod="string" dir="in">
2010	<desc>UUID of the machine to unregister.</desc>
2011	</param>
2012	<param name="machine" type="IMachine" dir="return">
2013	<desc>Unregistered machine object.</desc>
2014	</param>
2015	</method>
2016
2017	<method name="createAppliance">
2018	<desc>
2019	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2020	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2021	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2022	</desc>
2023	<param name="appliance" type="IAppliance" dir="return">
2024	<desc>New appliance.</desc>
2025	</param>
2026	</method>
2027
2028	<method name="createHardDisk">
2029	<desc>
2030	Creates a new base medium object that will use the given storage
2031	format and location for medium data.
2032
2033	Note that the actual storage unit is not created by this method. In
2034	order to do it, and before you are able to attach the created medium
2035	to virtual machines, you must call one of the following methods to
2036	allocate a format-specific storage unit at the specified location:
2037	<ul>
2038	<li><link to="IMedium::createBaseStorage"/></li>
2039	<li><link to="IMedium::createDiffStorage"/></li>
2040	</ul>
2041
2042	Some medium attributes, such as <link to="IMedium::id"/>, may
2043	remain uninitialized until the medium storage unit is successfully
2044	created by one of the above methods.
2045
2046	After the storage unit is successfully created, the medium gets
2047	remembered by this VirtualBox installation and will be accessible
2048	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2049	methods. Remembered base medium are also returned as part of
2050	the <link to="#hardDisks"/> array. See IMedium for more details.
2051
2052	The list of all storage formats supported by this VirtualBox
2053	installation can be obtained using
2054	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2055	attribute is empty or @c null then the default storage format
2056	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2057	be used for creating a storage unit of the medium.
2058
2059	Note that the format of the location string is storage format specific.
2060	See <link to="IMedium::location"/>, IMedium and
2061	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2062
2063	<result name="VBOX_E_OBJECT_NOT_FOUND">
2064	@a format identifier is invalid. See
2065	<link to="ISystemProperties::mediumFormats"/>.
2066	</result>
2067	<result name="VBOX_E_FILE_ERROR">
2068	@a location is a not valid file name (for file-based formats only).
2069	</result>
2070	</desc>
2071	<param name="format" type="wstring" dir="in">
2072	<desc>
2073	Identifier of the storage format to use for the new medium.
2074	</desc>
2075	</param>
2076	<param name="location" type="wstring" dir="in">
2077	<desc>
2078	Location of the storage unit for the new medium.
2079	</desc>
2080	</param>
2081	<param name="medium" type="IMedium" dir="return">
2082	<desc>Created medium object.</desc>
2083	</param>
2084	</method>
2085
2086	<method name="openHardDisk">
2087	<desc>
2088	Opens a medium from an existing location, optionally replacing
2089	the image UUID and/or parent UUID.
2090
2091	After the medium is successfully opened by this method, it gets
2092	remembered by (known to) this VirtualBox installation and will be
2093	accessible through <link to="#getHardDisk"/> and
2094	<link to="#findHardDisk"/> methods. Remembered base media
2095	are also returned as part of the <link to="#hardDisks"/> array and can
2096	be attached to virtual machines. See IMedium for more details.
2097
2098	If a differencing medium is to be opened by this method, the
2099	operation will succeed only if its parent medium and all ancestors,
2100	if any, are already known to this VirtualBox installation (for example,
2101	were opened by this method before).
2102
2103	This method tries to guess the storage format of the specified medium
2104	by reading medium data at the specified location.
2105
2106	If @a write is ReadWrite (which it should be), the image is opened for
2107	read/write access and must have according permissions, as VirtualBox
2108	may actually write status information into the disk's metadata sections.
2109
2110	Note that write access is required for all typical image usage in VirtualBox,
2111	since VirtualBox may need to write metadata such as a UUID into the image.
2112	The only exception is opening a source image temporarily for copying and
2113	cloning when the image will quickly be closed again.
2114
2115	Note that the format of the location string is storage format specific.
2116	See <link to="IMedium::location"/>, IMedium and
2117	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2118
2119	<result name="VBOX_E_FILE_ERROR">
2120	Invalid medium storage file location or could not find the medium
2121	at the specified location.
2122	</result>
2123	<result name="VBOX_E_IPRT_ERROR">
2124	Could not get medium storage format.
2125	</result>
2126	<result name="E_INVALIDARG">
2127	Invalid medium storage format.
2128	</result>
2129
2130	</desc>
2131	<param name="location" type="wstring" dir="in">
2132	<desc>
2133	Location of the storage unit that contains medium data in one of
2134	the supported storage formats.
2135	</desc>
2136	</param>
2137	<param name="accessMode" type="AccessMode" dir="in">
2138	<desc>
2139	Determines whether to open the image in read/write or read-only mode.
2140	</desc>
2141	</param>
2142	<param name="setImageId" type="boolean" dir="in">
2143	<desc>
2144	Select whether a new image UUID is set or not.
2145	</desc>
2146	</param>
2147	<param name="imageId" type="uuid" mod="string" dir="in">
2148	<desc>
2149	New UUID for the image. If an empty string is passed, then a new
2150	UUID is automatically created. Specifying a zero UUIDs is not valid.
2151	</desc>
2152	</param>
2153	<param name="setParentId" type="boolean" dir="in">
2154	<desc>
2155	Select whether a new parent UUID is set or not.
2156	</desc>
2157	</param>
2158	<param name="parentId" type="uuid" mod="string" dir="in">
2159	<desc>
2160	New parent UUID for the image. If an empty string is passed, then a
2161	new UUID is automatically created, provided @a setParentId is
2162	@c true. A zero UUID is valid.
2163	</desc>
2164	</param>
2165	<param name="medium" type="IMedium" dir="return">
2166	<desc>Opened medium object.</desc>
2167	</param>
2168	</method>
2169
2170	<method name="getHardDisk" const="yes">
2171	<desc>
2172	Returns a medium with the given UUID.
2173
2174	The medium with the given UUID must be known to this VirtualBox
2175	installation, i.e. it must be previously created by
2176	<link to="#createHardDisk"/> or opened by <link
2177	to="#openHardDisk"/>, or attached to some known virtual machine.
2178
2179	<result name="VBOX_E_OBJECT_NOT_FOUND">
2180	No medium object matching @a id found.
2181	</result>
2182
2183	</desc>
2184	<param name="id" type="uuid" mod="string" dir="in">
2185	<desc>UUID of the medium to look for.</desc>
2186	</param>
2187	<param name="medium" type="IMedium" dir="return">
2188	<desc>Found medium object.</desc>
2189	</param>
2190	</method>
2191
2192	<method name="findHardDisk">
2193	<desc>
2194	Returns a medium that uses the given location to store medium data.
2195
2196	The given medium must be known to this VirtualBox installation, i.e.
2197	it must be previously created by
2198	<link to="#createHardDisk"/> or opened by <link
2199	to="#openHardDisk"/>, or attached to some known virtual machine.
2200
2201	The search is done by comparing the value of the @a location argument to
2202	the <link to="IMedium::location"/> attribute of each known medium.
2203
2204	For locations represented by file names in the host's file system, the
2205	requested location can be a path relative to the
2206	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2207	only a file name without any path is given, the
2208	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2209	folder</link> will be prepended to the file name before searching. Note
2210	that on case sensitive file systems, a case sensitive comparison is
2211	performed, otherwise the case of symbols in the file path is ignored.
2212
2213	<result name="VBOX_E_OBJECT_NOT_FOUND">
2214	No medium object matching @a location found.
2215	</result>
2216
2217	</desc>
2218	<param name="location" type="wstring" dir="in">
2219	<desc>Location string to search for.</desc>
2220	</param>
2221	<param name="medium" type="IMedium" dir="return">
2222	<desc>Found medium object.</desc>
2223	</param>
2224	</method>
2225
2226	<method name="openDVDImage">
2227	<desc>
2228	Opens a CD/DVD image contained in the specified file of the supported
2229	format and assigns it the given UUID.
2230
2231	After the image is successfully opened by this method, it gets
2232	remembered by (known to) this VirtualBox installation and will be
2233	accessible through <link to="#getDVDImage"/> and
2234	<link to="#findDVDImage"/> methods. Remembered images are also
2235	returned as part of the <link to="#DVDImages"/> array and can be mounted
2236	to virtual machines. See IMedium for more details.
2237
2238	See <link to="IMedium::location"/> to get more details about the format
2239	of the location string.
2240
2241	<note>
2242	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2243	</note>
2244
2245	<result name="VBOX_E_FILE_ERROR">
2246	Invalid CD/DVD image file location or could not find the CD/DVD
2247	image at the specified location.
2248	</result>
2249	<result name="VBOX_E_INVALID_OBJECT_STATE">
2250	CD/DVD image already exists in the media registry.
2251	</result>
2252
2253	</desc>
2254	<param name="location" type="wstring" dir="in">
2255	<desc>
2256	Full path to the file that contains a valid CD/DVD image.
2257	</desc>
2258	</param>
2259	<param name="id" type="uuid" mod="string" dir="in">
2260	<desc>
2261	UUID to assign to the given image within this VirtualBox installation.
2262	If an empty (@c null) UUID is specified, the system will randomly
2263	generate a new UUID.
2264	</desc>
2265	</param>
2266	<param name="image" type="IMedium" dir="return">
2267	<desc>Opened CD/DVD image object.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="getDVDImage">
2272	<desc>
2273	Returns a CD/DVD image with the given UUID.
2274
2275	The image with the given UUID must be known to this VirtualBox
2276	installation, i.e. it must be previously opened by <link
2277	to="#openDVDImage"/>, or mounted to some known virtual machine.
2278
2279	<result name="VBOX_E_OBJECT_NOT_FOUND">
2280	No matching DVD image found in the media registry.
2281	</result>
2282
2283	</desc>
2284	<param name="id" type="uuid" mod="string" dir="in">
2285	<desc>UUID of the image to look for.</desc>
2286	</param>
2287	<param name="image" type="IMedium" dir="return">
2288	<desc>Found CD/DVD image object.</desc>
2289	</param>
2290	</method>
2291
2292	<method name="findDVDImage">
2293	<desc>
2294	Returns a CD/DVD image with the given image location.
2295
2296	The image with the given UUID must be known to this VirtualBox
2297	installation, i.e. it must be previously opened by <link
2298	to="#openDVDImage"/>, or mounted to some known virtual machine.
2299
2300	The search is done by comparing the value of the @a location argument to
2301	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2302
2303	The requested location can be a path relative to the
2304	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2305	only a file name without any path is given, the
2306	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2307	folder</link> will be prepended to the file name before searching. Note
2308	that on case sensitive file systems, a case sensitive comparison is
2309	performed, otherwise the case in the file path is ignored.
2310
2311	<result name="VBOX_E_FILE_ERROR">
2312	Invalid image file location.
2313	</result>
2314	<result name="VBOX_E_OBJECT_NOT_FOUND">
2315	No matching DVD image found in the media registry.
2316	</result>
2317
2318	</desc>
2319	<param name="location" type="wstring" dir="in">
2320	<desc>CD/DVD image file path to look for.</desc>
2321	</param>
2322	<param name="image" type="IMedium" dir="return">
2323	<desc>Found CD/DVD image object.</desc>
2324	</param>
2325	</method>
2326
2327	<method name="openFloppyImage">
2328	<desc>
2329	Opens a floppy image contained in the specified file of the supported
2330	format and assigns it the given UUID.
2331
2332	After the image is successfully opened by this method, it gets
2333	remembered by (known to) this VirtualBox installation and will be
2334	accessible through <link to="#getFloppyImage"/> and
2335	<link to="#findFloppyImage"/> methods. Remembered images are also
2336	returned as part of the <link to="#floppyImages"/> array and can be
2337	mounted to virtual machines. See IMedium for more details.
2338
2339	See <link to="IMedium::location"/> to get more details about the format
2340	of the location string.
2341
2342	<result name="VBOX_E_FILE_ERROR">
2343	Invalid floppy image file location or could not find the floppy
2344	image at the specified location.
2345	</result>
2346	<result name="VBOX_E_INVALID_OBJECT_STATE">
2347	Floppy image already exists in the media registry.
2348	</result>
2349
2350	<note>
2351	Currently, only raw floppy images are supported by VirtualBox.
2352	</note>
2353	</desc>
2354	<param name="location" type="wstring" dir="in">
2355	<desc>
2356	Full path to the file that contains a valid floppy image.
2357	</desc>
2358	</param>
2359	<param name="id" type="uuid" mod="string" dir="in">
2360	<desc>
2361	UUID to assign to the given image file within this VirtualBox
2362	installation. If an empty (@c null) UUID is specified, the system will
2363	randomly generate a new UUID.
2364	</desc>
2365	</param>
2366	<param name="image" type="IMedium" dir="return">
2367	<desc>Opened floppy image object.</desc>
2368	</param>
2369	</method>
2370
2371	<method name="getFloppyImage">
2372	<desc>
2373	Returns a floppy image with the given UUID.
2374
2375	The image with the given UUID must be known to this VirtualBox
2376	installation, i.e. it must be previously opened by <link
2377	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2378
2379	<result name="VBOX_E_OBJECT_NOT_FOUND">
2380	No matching floppy image found in the media registry.
2381	</result>
2382
2383	</desc>
2384	<param name="id" type="uuid" mod="string" dir="in">
2385	<desc>UUID of the image to look for.</desc>
2386	</param>
2387	<param name="image" type="IMedium" dir="return">
2388	<desc>Found floppy image object.</desc>
2389	</param>
2390	</method>
2391
2392	<method name="findFloppyImage">
2393	<desc>
2394	Returns a floppy image with the given image location.
2395
2396	The image with the given UUID must be known to this VirtualBox
2397	installation, i.e. it must be previously opened by <link
2398	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2399
2400	The search is done by comparing the value of the @a location argument to
2401	the <link to="IMedium::location"/> attribute of each known floppy image.
2402
2403	The requested location can be a path relative to the
2404	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2405	only a file name without any path is given, the
2406	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2407	folder</link> will be prepended to the file name before searching. Note
2408	that on case sensitive file systems, a case sensitive comparison is
2409	performed, otherwise the case of symbols in the file path is ignored.
2410
2411	<result name="VBOX_E_FILE_ERROR">
2412	Invalid image file location.
2413	</result>
2414	<result name="VBOX_E_OBJECT_NOT_FOUND">
2415	No matching floppy image found in the media registry.
2416	</result>
2417
2418	</desc>
2419	<param name="location" type="wstring" dir="in">
2420	<desc>Floppy image file path to look for.</desc>
2421	</param>
2422	<param name="image" type="IMedium" dir="return">
2423	<desc>Found floppy image object.</desc>
2424	</param>
2425	</method>
2426
2427	<method name="getGuestOSType">
2428	<desc>
2429	Returns an object describing the specified guest OS type.
2430
2431	The requested guest OS type is specified using a string which is a
2432	mnemonic identifier of the guest operating system, such as
2433	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2434	particular virtual machine can be read or set using the
2435	<link to="IMachine::OSTypeId"/> attribute.
2436
2437	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2438	available guest OS type objects. Each object has an
2439	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2440	the guest OS this object describes.
2441
2442	<result name="E_INVALIDARG">
2443	@a id is not a valid Guest OS type.
2444	</result>
2445
2446	</desc>
2447	<param name="id" type="uuid" mod="string" dir="in">
2448	<desc>Guest OS type ID string.</desc>
2449	</param>
2450	<param name="type" type="IGuestOSType" dir="return">
2451	<desc>Guest OS type object.</desc>
2452	</param>
2453	</method>
2454
2455	<method name="createSharedFolder">
2456	<desc>
2457	Creates a new global shared folder by associating the given logical
2458	name with the given host path, adds it to the collection of shared
2459	folders and starts sharing it. Refer to the description of
2460	<link to="ISharedFolder"/> to read more about logical names.
2461	<note>
2462	In the current implementation, this operation is not
2463	implemented.
2464	</note>
2465	</desc>
2466	<param name="name" type="wstring" dir="in">
2467	<desc>Unique logical name of the shared folder.</desc>
2468	</param>
2469	<param name="hostPath" type="wstring" dir="in">
2470	<desc>Full path to the shared folder in the host file system.</desc>
2471	</param>
2472	<param name="writable" type="boolean" dir="in">
2473	<desc>Whether the share is writable or readonly</desc>
2474	</param>
2475	</method>
2476
2477	<method name="removeSharedFolder">
2478	<desc>
2479	Removes the global shared folder with the given name previously
2480	created by <link to="#createSharedFolder"/> from the collection of
2481	shared folders and stops sharing it.
2482	<note>
2483	In the current implementation, this operation is not
2484	implemented.
2485	</note>
2486	</desc>
2487	<param name="name" type="wstring" dir="in">
2488	<desc>Logical name of the shared folder to remove.</desc>
2489	</param>
2490	</method>
2491
2492	<method name="getExtraDataKeys">
2493	<desc>
2494	Returns an array representing the global extra data keys which currently
2495	have values defined.
2496	</desc>
2497	<param name="value" type="wstring" dir="return" safearray="yes">
2498	<desc>Array of extra data keys.</desc>
2499	</param>
2500	</method>
2501
2502	<method name="getExtraData">
2503	<desc>
2504	Returns associated global extra data.
2505
2506	If the requested data @a key does not exist, this function will
2507	succeed and return an empty string in the @a value argument.
2508
2509	<result name="VBOX_E_FILE_ERROR">
2510	Settings file not accessible.
2511	</result>
2512	<result name="VBOX_E_XML_ERROR">
2513	Could not parse the settings file.
2514	</result>
2515
2516	</desc>
2517	<param name="key" type="wstring" dir="in">
2518	<desc>Name of the data key to get.</desc>
2519	</param>
2520	<param name="value" type="wstring" dir="return">
2521	<desc>Value of the requested data key.</desc>
2522	</param>
2523	</method>
2524
2525	<method name="setExtraData">
2526	<desc>
2527	Sets associated global extra data.
2528
2529	If you pass @c null or empty string as a key @a value, the given @a key
2530	will be deleted.
2531
2532	<note>
2533	Before performing the actual data change, this method will ask all
2534	registered callbacks using the
2535	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2536	notification for a permission. If one of the callbacks refuses the
2537	new value, the change will not be performed.
2538	</note>
2539	<note>
2540	On success, the
2541	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2542	is called to inform all registered callbacks about a successful data
2543	change.
2544	</note>
2545
2546	<result name="VBOX_E_FILE_ERROR">
2547	Settings file not accessible.
2548	</result>
2549	<result name="VBOX_E_XML_ERROR">
2550	Could not parse the settings file.
2551	</result>
2552	<result name="E_ACCESSDENIED">
2553	Modification request refused.
2554	</result>
2555
2556	</desc>
2557	<param name="key" type="wstring" dir="in">
2558	<desc>Name of the data key to set.</desc>
2559	</param>
2560	<param name="value" type="wstring" dir="in">
2561	<desc>Value to assign to the key.</desc>
2562	</param>
2563	</method>
2564
2565	<method name="openSession">
2566	<desc>
2567	Opens a new direct session with the given virtual machine.
2568
2569	A direct session acts as a local lock on the given VM.
2570	There can be only one direct session open at a time for every
2571	virtual machine, protecting the VM from being manipulated by
2572	conflicting actions from different processes. Only after a
2573	direct session has been opened, one can change all VM settings
2574	and execute the VM in the process space of the session object.
2575
2576	Sessions therefore can be compared to mutex semaphores that
2577	lock a given VM for modification and execution.
2578	See <link to="ISession">ISession</link> for details.
2579
2580	<note>Unless you are writing a new VM frontend, you will not
2581	want to execute a VM in the current process. To spawn a new
2582	process that executes a VM, use
2583	<link to="IVirtualBox::openRemoteSession" />
2584	instead.</note>
2585
2586	Upon successful return, the session object can be used to
2587	get access to the machine and to the VM console.
2588
2589	In VirtualBox terminology, the machine becomes "mutable" after
2590	a session has been opened. Note that the "mutable" machine
2591	object, on which you may invoke IMachine methods to change its
2592	settings, will be a different object from the immutable IMachine
2593	objects returned by various IVirtualBox methods. To obtain a
2594	mutable IMachine object (upon which you can invoke settings methods),
2595	use the <link to="ISession::machine" /> attribute.
2596
2597	One must always call <link to="ISession::close" /> to release the
2598	lock on the machine, or the machine's state will eventually be
2599	set to "Aborted".
2600
2601	In other words, to change settings on a machine, the following
2602	sequence is typically performed:
2603
2604	<ol>
2605	<li>Call this method (openSession) to have a machine locked for
2606	the current session.</li>
2607
2608	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2609
2610	<li>Change the settings of the machine.</li>
2611
2612	<li>Call <link to="IMachine::saveSettings" />.</li>
2613
2614	<li>Close the session by calling <link to="ISession::close"/>.</li>
2615	</ol>
2616
2617	<result name="E_UNEXPECTED">
2618	Virtual machine not registered.
2619	</result>
2620	<result name="E_ACCESSDENIED">
2621	Process not started by OpenRemoteSession.
2622	</result>
2623	<result name="VBOX_E_OBJECT_NOT_FOUND">
2624	No matching virtual machine found.
2625	</result>
2626	<result name="VBOX_E_INVALID_OBJECT_STATE">
2627	Session already open or being opened.
2628	</result>
2629	<result name="VBOX_E_VM_ERROR">
2630	Failed to assign machine to session.
2631	</result>
2632
2633	</desc>
2634	<param name="session" type="ISession" dir="in">
2635	<desc>
2636	Session object that will represent the opened session after
2637	successful method invocation. This object must not represent
2638	the already open session.
2639	<note>
2640	This session will be automatically closed if the
2641	VirtualBox server is terminated for some reason.
2642	</note>
2643	</desc>
2644	</param>
2645	<param name="machineId" type="uuid" mod="string" dir="in">
2646	<desc>ID of the virtual machine to open a session with.</desc>
2647	</param>
2648	</method>
2649
2650	<method name="openRemoteSession">
2651	<desc>
2652	Spawns a new process that executes a virtual machine (called a
2653	"remote session").
2654
2655	Opening a remote session causes the VirtualBox server to start a new
2656	process that opens a direct session with the given VM. As a result, the
2657	VM is locked by that direct session in the new process, preventing
2658	conflicting changes from other processes. Since sessions act as locks
2659	that prevent conflicting changes, one cannot open a remote session
2660	for a VM that already has another open session (direct or remote), or
2661	is currently in the process of opening one (see <link
2662	to="IMachine::sessionState"/>).
2663
2664	While the remote session still provides some level of control over the
2665	VM execution to the caller (using the <link to="IConsole" /> interface),
2666	not all VM settings are available for modification within the remote
2667	session context.
2668
2669	This operation can take some time (a new VM is started in a new process,
2670	for which memory and other resources need to be set up). Because of this,
2671	an <link to="IProgress" /> is returned to allow the caller to wait for this
2672	asynchronous operation to be completed. Until then, the remote session
2673	object remains in the closed state, and accessing the machine or its
2674	console through it is invalid. It is recommended to use
2675	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2676	completion.
2677
2678	As with all <link to="ISession" /> objects, it is recommended to call
2679	<link to="ISession::close" /> on the local session object once openRemoteSession()
2680	has been called. However, the session's state (see <link to="ISession::state" />)
2681	will not return to "Closed" until the remote session has also closed (i.e.
2682	until the VM is no longer running). In that case, however, the state of
2683	the session will automatically change back to "Closed".
2684
2685	Currently supported session types (values of the @a type
2686	argument) are:
2687	<ul>
2688	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2689	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2690	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2691	</ul>
2692
2693	The @a environment argument is a string containing definitions of
2694	environment variables in the following format:
2695	@code
2696	NAME[=VALUE]\n
2697	NAME[=VALUE]\n
2698	...
2699	@endcode
2700	where <tt>\\n</tt> is the new line character. These environment
2701	variables will be appended to the environment of the VirtualBox server
2702	process. If an environment variable exists both in the server process
2703	and in this list, the value from this list takes precedence over the
2704	server's variable. If the value of the environment variable is
2705	omitted, this variable will be removed from the resulting environment.
2706	If the environment string is @c null or empty, the server environment
2707	is inherited by the started process as is.
2708
2709	<see>openExistingSession</see>
2710
2711	<result name="E_UNEXPECTED">
2712	Virtual machine not registered.
2713	</result>
2714	<result name="E_INVALIDARG">
2715	Invalid session type @a type.
2716	</result>
2717	<result name="VBOX_E_OBJECT_NOT_FOUND">
2718	No machine matching @a machineId found.
2719	</result>
2720	<result name="VBOX_E_INVALID_OBJECT_STATE">
2721	Session already open or being opened.
2722	</result>
2723	<result name="VBOX_E_IPRT_ERROR">
2724	Launching process for machine failed.
2725	</result>
2726	<result name="VBOX_E_VM_ERROR">
2727	Failed to assign machine to session.
2728	</result>
2729
2730	</desc>
2731	<param name="session" type="ISession" dir="in">
2732	<desc>
2733	Session object that will represent the opened remote session
2734	after successful method invocation (this object must not
2735	represent an already open session).
2736	</desc>
2737	</param>
2738	<param name="machineId" type="uuid" mod="string" dir="in">
2739	<desc>ID of the virtual machine to open a session with.</desc>
2740	</param>
2741	<param name="type" type="wstring" dir="in">
2742	<desc>
2743	Type of the remote session (case sensitive).
2744	</desc>
2745	</param>
2746	<param name="environment" type="wstring" dir="in">
2747	<desc>
2748	Environment to pass to the opened session.
2749	</desc>
2750	</param>
2751	<param name="progress" type="IProgress" dir="return">
2752	<desc>Progress object to track the operation completion.</desc>
2753	</param>
2754	</method>
2755
2756	<method name="openExistingSession">
2757	<desc>
2758	Opens a new remote session with the virtual machine for
2759	which a direct session is already open.
2760
2761	The remote session provides some level of control over the VM
2762	execution (using the IConsole interface) to the caller; however,
2763	within the remote session context, not all VM settings are available
2764	for modification.
2765
2766	As opposed to <link to="#openRemoteSession"/>, the number of
2767	remote sessions opened this way is not limited by the API
2768
2769	<note>
2770	It is an error to open a remote session with the machine that
2771	doesn't have an open direct session.
2772	</note>
2773
2774	<result name="E_UNEXPECTED">
2775	Virtual machine not registered.
2776	</result>
2777	<result name="VBOX_E_OBJECT_NOT_FOUND">
2778	No machine matching @a machineId found.
2779	</result>
2780	<result name="VBOX_E_INVALID_OBJECT_STATE">
2781	Session already open or being opened.
2782	</result>
2783	<result name="VBOX_E_INVALID_SESSION_STATE">
2784	Direct session state not Open.
2785	</result>
2786	<result name="VBOX_E_VM_ERROR">
2787	Failed to get console object from direct session or assign
2788	machine to session.
2789	</result>
2790
2791	<see>openRemoteSession</see>
2792	</desc>
2793	<param name="session" type="ISession" dir="in">
2794	<desc>
2795	Session object that will represent the open remote session
2796	after successful method invocation. This object must not
2797	represent an already open session.
2798	<note>
2799	This session will be automatically closed when the peer
2800	(direct) session dies or gets closed.
2801	</note>
2802	</desc>
2803	</param>
2804	<param name="machineId" type="uuid" mod="string" dir="in">
2805	<desc>ID of the virtual machine to open a session with.</desc>
2806	</param>
2807	</method>
2808
2809	<method name="registerCallback">
2810	<desc>
2811	Registers a new global VirtualBox callback. The methods of the given
2812	callback object will be called by VirtualBox when an appropriate
2813	event occurs.
2814
2815	<result name="E_INVALIDARG">
2816	A @c null callback cannot be registered.
2817	</result>
2818
2819	</desc>
2820	<param name="callback" type="IVirtualBoxCallback" dir="in">
2821	<desc>Callback object to register.</desc>
2822	</param>
2823	</method>
2824
2825	<method name="unregisterCallback">
2826	<desc>
2827	Unregisters the previously registered global VirtualBox callback.
2828
2829	<result name="E_INVALIDARG">
2830	Specified @a callback not registered.
2831	</result>
2832
2833	</desc>
2834	<param name="callback" type="IVirtualBoxCallback" dir="in">
2835	<desc>Callback object to unregister.</desc>
2836	</param>
2837	</method>
2838
2839	<method name="waitForPropertyChange">
2840	<desc>
2841	Blocks the caller until any of the properties represented by the
2842	@a what argument changes the value or until the given timeout interval
2843	expires.
2844
2845	The @a what argument is a comma separated list of property masks that
2846	describe properties the caller is interested in. The property mask is
2847	a string in the following format:
2848
2849	<pre>
2850	[[group.]subgroup.]name
2851	</pre>
2852
2853	where @c name is the property name and @c group, @c subgroup are zero
2854	or more property group specifiers. Each element (group or name) in
2855	the property mask may be either a Latin string or an asterisk symbol
2856	(@c "*") which is used to match any string for the given element. A
2857	property mask that doesn't contain asterisk symbols represents a
2858	single fully qualified property name.
2859
2860	Groups in the fully qualified property name go from more generic (the
2861	left-most part) to more specific (the right-most part). The first
2862	element is usually a name of the object the property belongs to. The
2863	second element may be either a property name, or a child object name,
2864	or an index if the preceding element names an object which is one of
2865	many objects of the same type. This way, property names form a
2866	hierarchy of properties. Here are some examples of property names:
2867
2868	<table>
2869	<tr>
2870	<td><tt>VirtualBox.version</tt></td>
2871	<td><link to="IVirtualBox::version"/> property</td>
2872	</tr>
2873	<tr>
2874	<td><tt>Machine.<UUID>.name</tt></td>
2875	<td><link to="IMachine::name"/> property of the machine with the
2876	given UUID</td>
2877	</tr>
2878	</table>
2879
2880	Most property names directly correspond to the properties of objects
2881	(components) provided by the VirtualBox library and may be used to
2882	track changes to these properties. However, there may be
2883	pseudo-property names that don't correspond to any existing object's
2884	property directly, as well as there may be object properties that
2885	don't have a corresponding property name that is understood by this
2886	method, and therefore changes to such properties cannot be
2887	tracked. See individual object's property descriptions to get a
2888	fully qualified property name that can be used with this method (if
2889	any).
2890
2891	There is a special property mask @c "*" (i.e. a string consisting of a
2892	single asterisk symbol) that can be used to match all properties.
2893	Below are more examples of property masks:
2894
2895	<table>
2896	<tr>
2897	<td><tt>VirtualBox.*</tt></td>
2898	<td>Track all properties of the VirtualBox object</td>
2899	</tr>
2900	<tr>
2901	<td><tt>Machine.*.name</tt></td>
2902	<td>Track changes to the <link to="IMachine::name"/> property of
2903	all registered virtual machines</td>
2904	</tr>
2905	</table>
2906
2907	<note>
2908	This function is not implemented in the current version of the
2909	product.
2910	</note>
2911	</desc>
2912	<param name="what" type="wstring" dir="in">
2913	<desc>Comma separated list of property masks.</desc>
2914	</param>
2915	<param name="timeout" type="unsigned long" dir="in">
2916	<desc>
2917	Wait timeout in milliseconds.
2918	Specify -1 for an indefinite wait.
2919	</desc>
2920	</param>
2921	<param name="changed" type="wstring" dir="out">
2922	<desc>
2923	Comma separated list of properties that have been changed and caused
2924	this method to return to the caller.
2925	</desc>
2926	</param>
2927	<param name="values" type="wstring" dir="out">
2928	<desc>Reserved, not currently used.</desc>
2929	</param>
2930	</method>
2931
2932	<!--method name="createDHCPServerForInterface">
2933	<desc>
2934	Creates a dhcp server settings to be used for the given interface
2935	<result name="E_INVALIDARG">
2936	Host network interface @a name already exists.
2937	</result>
2938	</desc>
2939	<param name="interface" type="IHostNetworkInterface" dir="in">
2940	<desc>Network Interface</desc>
2941	</param>
2942	<param name="server" type="IDHCPServer" dir="out">
2943	<desc>Dhcp server settings</desc>
2944	</param>
2945	</method-->
2946
2947	<method name="createDHCPServer">
2948	<desc>
2949	Creates a dhcp server settings to be used for the given internal network name
2950	<result name="E_INVALIDARG">
2951	Host network interface @a name already exists.
2952	</result>
2953	</desc>
2954	<param name="name" type="wstring" dir="in">
2955	<desc>server name</desc>
2956	</param>
2957	<param name="server" type="IDHCPServer" dir="return">
2958	<desc>Dhcp server settings</desc>
2959	</param>
2960	</method>
2961
2962	<method name="findDHCPServerByNetworkName">
2963	<desc>
2964	Searches a dhcp server settings to be used for the given internal network name
2965	<result name="E_INVALIDARG">
2966	Host network interface @a name already exists.
2967	</result>
2968
2969	</desc>
2970	<param name="name" type="wstring" dir="in">
2971	<desc>server name</desc>
2972	</param>
2973	<param name="server" type="IDHCPServer" dir="return">
2974	<desc>Dhcp server settings</desc>
2975	</param>
2976	</method>
2977
2978	<!--method name="findDHCPServerForInterface">
2979	<desc>
2980	Searches a dhcp server settings to be used for the given interface
2981	<result name="E_INVALIDARG">
2982	Host network interface @a name already exists.
2983	</result>
2984	</desc>
2985	<param name="interface" type="IHostNetworkInterface" dir="in">
2986	<desc>Network Interface</desc>
2987	</param>
2988	<param name="server" type="IDHCPServer" dir="out">
2989	<desc>Dhcp server settings</desc>
2990	</param>
2991	</method-->
2992
2993	<method name="removeDHCPServer">
2994	<desc>
2995	Removes the dhcp server settings
2996	<result name="E_INVALIDARG">
2997	Host network interface @a name already exists.
2998	</result>
2999	</desc>
3000	<param name="server" type="IDHCPServer" dir="in">
3001	<desc>Dhcp server settings to be removed</desc>
3002	</param>
3003	</method>
3004
3005	</interface>
3006
3007	<!--
3008	// IVFSExplorer
3009	/////////////////////////////////////////////////////////////////////////
3010	-->
3011
3012	<enum
3013	name="VFSType"
3014	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3015	>
3016	<desc>
3017	Virtual file systems supported by VFSExplorer.
3018	</desc>
3019
3020	<const name="File" value="1" />
3021	<const name="Cloud" value="2" />
3022	<const name="S3" value="3" />
3023	<const name="WebDav" value="4" />
3024	</enum>
3025
3026	<enum
3027	name="VFSFileType"
3028	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3029	>
3030	<desc>
3031	File types known by VFSExplorer.
3032	</desc>
3033
3034	<const name="Unknown" value="1" />
3035	<const name="Fifo" value="2" />
3036	<const name="DevChar" value="3" />
3037	<const name="Directory" value="4" />
3038	<const name="DevBlock" value="5" />
3039	<const name="File" value="6" />
3040	<const name="SymLink" value="7" />
3041	<const name="Socket" value="8" />
3042	<const name="WhiteOut" value="9" />
3043	</enum>
3044
3045	<interface
3046	name="IVFSExplorer" extends="$unknown"
3047	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3048	wsmap="managed"
3049	>
3050	<desc>
3051	The VFSExplorer interface unifies access to different file system
3052	types. This includes local file systems as well remote file systems like
3053	S3. For a list of supported types see <link to="VFSType" />.
3054	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3055	</desc>
3056
3057	<attribute name="path" type="wstring" readonly="yes">
3058	<desc>Returns the current path in the virtual file system.</desc>
3059	</attribute>
3060
3061	<attribute name="type" type="VFSType" readonly="yes">
3062	<desc>Returns the file system type which is currently in use.</desc>
3063	</attribute>
3064
3065	<method name="update">
3066	<desc>Updates the internal list of files/directories from the
3067	current directory level. Use <link to="#entryList" /> to get the full list
3068	after a call to this method.</desc>
3069
3070	<param name="aProgress" type="IProgress" dir="return">
3071	<desc>Progress object to track the operation completion.</desc>
3072	</param>
3073	</method>
3074
3075	<method name="cd">
3076	<desc>Change the current directory level.</desc>
3077
3078	<param name="aDir" type="wstring" dir="in">
3079	<desc>The name of the directory to go in.</desc>
3080	</param>
3081
3082	<param name="aProgress" type="IProgress" dir="return">
3083	<desc>Progress object to track the operation completion.</desc>
3084	</param>
3085	</method>
3086
3087	<method name="cdUp">
3088	<desc>Go one directory upwards from the current directory level.</desc>
3089
3090	<param name="aProgress" type="IProgress" dir="return">
3091	<desc>Progress object to track the operation completion.</desc>
3092	</param>
3093	</method>
3094
3095	<method name="entryList">
3096	<desc>Returns a list of files/directories after a call to <link
3097	to="#update" />. The user is responsible for keeping this internal
3098	list up do date.</desc>
3099
3100	<param name="aNames" type="wstring" safearray="yes" dir="out">
3101	<desc>The list of names for the entries.</desc>
3102	</param>
3103
3104	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3105	<desc>The list of types for the entries.</desc>
3106	</param>
3107	</method>
3108
3109	<method name="exists">
3110	<desc>Checks if the given file list exists in the current directory
3111	level.</desc>
3112
3113	<param name="aNames" type="wstring" safearray="yes" dir="in">
3114	<desc>The names to check.</desc>
3115	</param>
3116
3117	<param name="aExists" type="wstring" safearray="yes" dir="return">
3118	<desc>The names which exist.</desc>
3119	</param>
3120	</method>
3121
3122	<method name="remove">
3123	<desc>Deletes the given files in the current directory level.</desc>
3124
3125	<param name="aNames" type="wstring" safearray="yes" dir="in">
3126	<desc>The names to remove.</desc>
3127	</param>
3128
3129	<param name="aProgress" type="IProgress" dir="return">
3130	<desc>Progress object to track the operation completion.</desc>
3131	</param>
3132	</method>
3133
3134	</interface>
3135
3136	<!--
3137	// IAppliance
3138	/////////////////////////////////////////////////////////////////////////
3139	-->
3140
3141	<interface
3142	name="IAppliance" extends="$unknown"
3143	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3144	wsmap="managed"
3145	>
3146	<desc>
3147	Represents a platform-independent appliance in OVF format. An instance of this is returned
3148	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3149	appliances with VirtualBox.
3150
3151	The OVF standard suggests two different physical file formats:
3152
3153	<ol>
3154	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3155	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3156	this descriptor file references other files, as OVF appliances distributed as a set of
3157	files most likely do, those files must be in the same directory as the descriptor file.</li>
3158
3159	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3160	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3161	files and optionally other files.
3162
3163	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3164	be added with a later version.</li>
3165	</ol>
3166
3167	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3168	<link to="IMachine" /> involves the following sequence of API calls:
3169
3170	<ol>
3171	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3172	</li>
3173
3174	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3175	would like to import. So long as this file is syntactically valid, this will succeed
3176	and return an instance of IAppliance that contains the parsed data from the OVF file.
3177	</li>
3178
3179	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3180	contents of the IAppliance attributes accordingly. These can be inspected by a
3181	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3182	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3183	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3184	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3185	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3186	The GUI can then give the user the option to confirm and/or change these suggestions.
3187	</li>
3188
3189	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3190	virtual system to override the suggestions made by the interpret() routine.
3191	</li>
3192
3193	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3194	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3195	virtual system descriptions.
3196	</li>
3197	</ol>
3198
3199	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3200
3201	<ol>
3202	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3203	an empty IAppliance object.
3204	</li>
3205
3206	<li>For each machine you would like to export, call <link to="IMachine::export" />
3207	with the IAppliance object you just created. This creates an instance of
3208	<link to="IVirtualSystemDescription" /> inside the appliance.
3209	</li>
3210
3211	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3212	virtual system to override the suggestions made by the export() routine.
3213	</li>
3214
3215	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3216	file written.</li>
3217	</ol>
3218
3219	</desc>
3220
3221	<attribute name="path" type="wstring" readonly="yes">
3222	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3223	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3224	<link to="#write" /> (for export).
3225	This attribute is empty until one of these methods has been called.
3226	</desc>
3227	</attribute>
3228
3229	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3230	<desc>
3231	Array of virtual disk definitions. One such description exists for each
3232	disk definition in the OVF; each string array item represents one such piece of
3233	disk information, with the information fields separated by tab (\\t) characters.
3234
3235	The caller should be prepared for additional fields being appended to
3236	this string in future versions of VirtualBox and therefore check for
3237	the number of tabs in the strings returned.
3238
3239	In the current version, the following eight fields are returned per string
3240	in the array:
3241
3242	<ol>
3243	<li>Disk ID (unique string identifier given to disk)</li>
3244
3245	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3246
3247	<li>Populated size (optional unsigned integer indicating the current size of the
3248	disk; can be approximate; -1 if unspecified)</li>
3249
3250	<li>Format (string identifying the disk format, typically
3251	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3252
3253	<li>Reference (where to find the disk image, typically a file name; if empty,
3254	then the disk should be created on import)</li>
3255
3256	<li>Image size (optional unsigned integer indicating the size of the image,
3257	which need not necessarily be the same as the values specified above, since
3258	the image may be compressed or sparse; -1 if not specified)</li>
3259
3260	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3261	presently unsupported and always -1)</li>
3262
3263	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3264	</ol>
3265	</desc>
3266	</attribute>
3267
3268	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3269	<desc> Array of virtual system descriptions. One such description is created
3270	for each virtual system found in the OVF.
3271	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3272	(for export) has been called.
3273	</desc>
3274	</attribute>
3275
3276	<method name="read">
3277	<desc>
3278	Reads an OVF file into the appliance object.
3279
3280	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3281	mere fact that this method returns successfully does not mean that VirtualBox supports all
3282	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3283	</desc>
3284	<param name="file" type="wstring" dir="in">
3285	<desc>
3286	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3287	on whether the appliance is distributed as a set of files or as a single file, respectively).
3288	</desc>
3289	</param>
3290	<param name="aProgress" type="IProgress" dir="return">
3291	<desc></desc>
3292	</param>
3293	</method>
3294
3295	<method name="interpret">
3296	<desc>
3297	Interprets the OVF data that was read when the appliance was constructed. After
3298	calling this method, one can inspect the
3299	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3300	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3301	the appliance.
3302
3303	Calling this method is the second step of importing an appliance into VirtualBox;
3304	see <link to="IAppliance" /> for an overview.
3305
3306	After calling this method, one should call <link to="#getWarnings" /> to find out
3307	if problems were encountered during the processing which might later lead to
3308	errors.
3309	</desc>
3310	</method>
3311
3312	<method name="importMachines">
3313	<desc>
3314	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3315	and other interfaces that match the information contained in the appliance as
3316	closely as possible, as represented by the import instructions in the
3317	<link to="#virtualSystemDescriptions" /> array.
3318
3319	Calling this method is the final step of importing an appliance into VirtualBox;
3320	see <link to="IAppliance" /> for an overview.
3321
3322	Since importing the appliance will most probably involve copying and converting
3323	disk images, which can take a long time, this method operates asynchronously and
3324	returns an IProgress object to allow the caller to monitor the progress.
3325	</desc>
3326
3327	<param name="aProgress" type="IProgress" dir="return">
3328	<desc></desc>
3329	</param>
3330	</method>
3331
3332	<method name="createVFSExplorer">
3333	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3334
3335	<param name="aUri" type="wstring" dir="in">
3336	<desc>The URI describing the file system to use.</desc>
3337	</param>
3338
3339	<param name="aExplorer" type="IVFSExplorer" dir="return">
3340	<desc></desc>
3341	</param>
3342	</method>
3343
3344	<method name="write">
3345	<desc>
3346	Writes the contents of the appliance exports into a new OVF file.
3347
3348	Calling this method is the final step of exporting an appliance from VirtualBox;
3349	see <link to="IAppliance" /> for an overview.
3350
3351	Since exporting the appliance will most probably involve copying and converting
3352	disk images, which can take a long time, this method operates asynchronously and
3353	returns an IProgress object to allow the caller to monitor the progress.
3354	</desc>
3355	<param name="format" type="wstring" dir="in">
3356	<desc>
3357	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3358	future versions of VirtualBox may support additional formats.
3359	</desc>
3360	</param>
3361	<param name="path" type="wstring" dir="in">
3362	<desc>
3363	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3364	on whether the appliance is distributed as a set of files or as a single file, respectively).
3365	</desc>
3366	</param>
3367	<param name="aProgress" type="IProgress" dir="return">
3368	<desc>Progress object to track the operation completion.</desc>
3369	</param>
3370	</method>
3371
3372	<method name="getWarnings">
3373	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3374
3375	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3376	<desc></desc>
3377	</param>
3378	</method>
3379
3380	</interface>
3381
3382	<enum
3383	name="VirtualSystemDescriptionType"
3384	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3385	>
3386	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3387	a configuration value.</desc>
3388
3389	<const name="Ignore" value="1" />
3390	<const name="OS" value="2" />
3391	<const name="Name" value="3" />
3392	<const name="Product" value="4" />
3393	<const name="Vendor" value="5" />
3394	<const name="Version" value="6" />
3395	<const name="ProductUrl" value="7" />
3396	<const name="VendorUrl" value="8" />
3397	<const name="Description" value="9" />
3398	<const name="License" value="10" />
3399	<const name="Miscellaneous" value="11" />
3400	<const name="CPU" value="12" />
3401	<const name="Memory" value="13" />
3402	<const name="HardDiskControllerIDE" value="14" />
3403	<const name="HardDiskControllerSATA" value="15" />
3404	<const name="HardDiskControllerSCSI" value="16" />
3405	<const name="HardDiskImage" value="17" />
3406	<const name="Floppy" value="18" />
3407	<const name="CDROM" value="19" />
3408	<const name="NetworkAdapter" value="20" />
3409	<const name="USBController" value="21" />
3410	<const name="SoundCard" value="22" />
3411
3412	</enum>
3413
3414	<enum
3415	name="VirtualSystemDescriptionValueType"
3416	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3417	>
3418	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3419	type to fetch.</desc>
3420
3421	<const name="Reference" value="1" />
3422	<const name="Original" value="2" />
3423	<const name="Auto" value="3" />
3424	<const name="ExtraConfig" value="4" />
3425
3426	</enum>
3427
3428	<interface
3429	name="IVirtualSystemDescription" extends="$unknown"
3430	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3431	wsmap="managed"
3432	>
3433
3434	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3435	After <link to="IAppliance::interpret" /> has been called, that array contains
3436	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3437	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3438	into VirtualBox.
3439	</desc>
3440
3441	<attribute name="count" type="unsigned long" readonly="yes">
3442	<desc>Return the number of virtual system description entries.</desc>
3443	</attribute>
3444
3445	<method name="getDescription">
3446	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3447	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3448
3449	The list below identifies the value sets that are possible depending on the
3450	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3451	the array item with the same index in aOvfValues[] will contain the original value as contained
3452	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3453	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3454	the aExtraConfigValues[] array item may also be used.
3455
3456	<ul>
3457	<li>
3458	"OS": the guest operating system type. There must be exactly one such array item on import. The
3459	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3460	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3461	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3462	</li>
3463	<li>
3464	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3465	if none is present on import, then an automatic name will be created from the operating system
3466	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3467	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3468	<link to="IMachine" /> name that does not exist yet.
3469	</li>
3470	<li>
3471	"Description": an arbitrary description.
3472	</li>
3473	<li>
3474	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3475	code to display such a license for agreement; the Main API does not enforce any such policy.
3476	</li>
3477	<li>
3478	Miscellaneous: reserved for future use.
3479	</li>
3480	<li>
3481	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3482	</li>
3483	<li>
3484	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3485	is present on import, then VirtualBox will set a meaningful default based on the operating system
3486	type.
3487	</li>
3488	<li>
3489	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3490	has no value in aOvfValues[] or aVBoxValues[].
3491	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3492	type can use to specify which hard disk controller a virtual disk should be connected to.
3493	</li>
3494	<li>
3495	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3496	has no value in aOvfValues[] or aVBoxValues[].
3497	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3498	</li>
3499	<li>
3500	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3501	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3502	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3503	</li>
3504	<li>
3505	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3506	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3507
3508	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3509	a path since the image file should be in the same location as the OVF file itself), whereas the
3510	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3511	hard disk image. This means that on import the image will be copied and converted from the
3512	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3513	On import, the target image will also be registered with VirtualBox.
3514
3515	The matching item in the aExtraConfigValues[] array must contain a string of the following
3516	format: "controller=<index>;channel=<c>"
3517	In this string, <index> must be an integer specifying the hard disk controller to connect
3518	the image to. That number must be the index of an array item with one of the hard disk controller
3519	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3520	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3521	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3522	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3523	</li>
3524	<li>
3525	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3526	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3527	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3528	</li>
3529	<li>
3530	"USBController": a USB controller. There can be at most one such item. If and only if such an
3531	item ispresent, USB support will be enabled for the new virtual machine.
3532	</li>
3533	<li>
3534	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3535	present, sound support will be enabled for the new virtual machine. Note that the virtual
3536	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3537	may be different from the virtual soundcard expected by the appliance.
3538	</li>
3539	</ul>
3540
3541	</desc>
3542
3543	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3544	<desc></desc>
3545	</param>
3546
3547	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3548	<desc></desc>
3549	</param>
3550
3551	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3552	<desc></desc>
3553	</param>
3554
3555	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3556	<desc></desc>
3557	</param>
3558
3559	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3560	<desc></desc>
3561	</param>
3562
3563	</method>
3564
3565	<method name="getDescriptionByType">
3566	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3567	should be returned.</desc>
3568
3569	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3570	<desc></desc>
3571	</param>
3572
3573	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3574	<desc></desc>
3575	</param>
3576
3577	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3578	<desc></desc>
3579	</param>
3580
3581	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3582	<desc></desc>
3583	</param>
3584
3585	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3586	<desc></desc>
3587	</param>
3588
3589	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3590	<desc></desc>
3591	</param>
3592
3593	</method>
3594
3595	<method name="getValuesByType">
3596	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3597	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3598	values.</desc>
3599
3600	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3601	<desc></desc>
3602	</param>
3603
3604	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3605	<desc></desc>
3606	</param>
3607
3608	<param name="aValues" type="wstring" dir="return" safearray="yes">
3609	<desc></desc>
3610	</param>
3611
3612	</method>
3613
3614	<method name="setFinalValues">
3615	<desc>
3616	This method allows the appliance's user to change the configuration for the virtual
3617	system descriptions. For each array item returned from <link to="#getDescription" />,
3618	you must pass in one boolean value and one configuration value.
3619
3620	Each item in the boolean array determines whether the particular configuration item
3621	should be enabled.
3622	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3623	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3624	and SoundCard.
3625
3626	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3627	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3628	the configuration remains unchanged. Please see the documentation for getDescription()
3629	for valid configuration values for the individual array item types. If the
3630	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3631	</desc>
3632
3633	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3634	<desc></desc>
3635	</param>
3636
3637	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3638	<desc></desc>
3639	</param>
3640
3641	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3642	<desc></desc>
3643	</param>
3644	</method>
3645
3646	<method name="addDescription">
3647	<desc>
3648	This method adds an additional description entry to the stack of already
3649	available descriptions for this virtual system. This is handy for writing
3650	values which aren't directly supported by VirtualBox. One example would
3651	be the License type of <link to="VirtualSystemDescriptionType" />.
3652	</desc>
3653
3654	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3655	<desc></desc>
3656	</param>
3657
3658	<param name="aVBoxValue" type="wstring" dir="in">
3659	<desc></desc>
3660	</param>
3661
3662	<param name="aExtraConfigValue" type="wstring" dir="in">
3663	<desc></desc>
3664	</param>
3665	</method>
3666	</interface>
3667
3668
3669	<!--
3670	// IMachine
3671	/////////////////////////////////////////////////////////////////////////
3672	-->
3673
3674	<interface
3675	name="IInternalMachineControl" extends="$unknown"
3676	uuid="4e2b8f0f-6575-49d2-bb19-5cd15a6ca2f0"
3677	internal="yes"
3678	wsmap="suppress"
3679	>
3680	<method name="setRemoveSavedState">
3681	<desc>
3682	Updates the flag whether saved state is removed on a machine state
3683	change from Saved to PoweredOff.
3684	</desc>
3685	<param name="aRemove" type="boolean" dir="in"/>
3686	</method>
3687
3688	<method name="updateState">
3689	<desc>
3690	Updates the VM state.
3691	<note>
3692	This operation will also update the settings file with
3693	the correct information about the saved state file
3694	and delete this file from disk when appropriate.
3695	</note>
3696	</desc>
3697	<param name="state" type="MachineState" dir="in"/>
3698	</method>
3699
3700	<method name="getIPCId">
3701	<param name="id" type="wstring" dir="return"/>
3702	</method>
3703
3704	<method name="runUSBDeviceFilters">
3705	<desc>
3706	Asks the server to run USB devices filters of the associated
3707	machine against the given USB device and tell if there is
3708	a match.
3709	<note>
3710	Intended to be used only for remote USB devices. Local
3711	ones don't require to call this method (this is done
3712	implicitly by the Host and USBProxyService).
3713	</note>
3714	</desc>
3715	<param name="device" type="IUSBDevice" dir="in"/>
3716	<param name="matched" type="boolean" dir="out"/>
3717	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3718	</method>
3719
3720	<method name="captureUSBDevice">
3721	<desc>
3722	Requests a capture of the given host USB device.
3723	When the request is completed, the VM process will
3724	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3725	notification.
3726	</desc>
3727	<param name="id" type="uuid" mod="string" dir="in"/>
3728	</method>
3729
3730	<method name="detachUSBDevice">
3731	<desc>
3732	Notification that a VM is going to detach (@a done = @c false) or has
3733	already detached (@a done = @c true) the given USB device.
3734	When the @a done = @c true request is completed, the VM process will
3735	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3736	notification.
3737	<note>
3738	In the @a done = @c true case, the server must run its own filters
3739	and filters of all VMs but this one on the detached device
3740	as if it were just attached to the host computer.
3741	</note>
3742	</desc>
3743	<param name="id" type="uuid" mod="string" dir="in"/>
3744	<param name="done" type="boolean" dir="in"/>
3745	</method>
3746
3747	<method name="autoCaptureUSBDevices">
3748	<desc>
3749	Requests a capture all matching USB devices attached to the host.
3750	When the request is completed, the VM process will
3751	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3752	notification per every captured device.
3753	</desc>
3754	</method>
3755
3756	<method name="detachAllUSBDevices">
3757	<desc>
3758	Notification that a VM that is being powered down. The done
3759	parameter indicates whether which stage of the power down
3760	we're at. When @a done = @c false the VM is announcing its
3761	intentions, while when @a done = @c true the VM is reporting
3762	what it has done.
3763	<note>
3764	In the @a done = @c true case, the server must run its own filters
3765	and filters of all VMs but this one on all detach devices as
3766	if they were just attached to the host computer.
3767	</note>
3768	</desc>
3769	<param name="done" type="boolean" dir="in"/>
3770	</method>
3771
3772	<method name="onSessionEnd">
3773	<desc>
3774	Triggered by the given session object when the session is about
3775	to close normally.
3776	</desc>
3777	<param name="session" type="ISession" dir="in">
3778	<desc>Session that is being closed</desc>
3779	</param>
3780	<param name="progress" type="IProgress" dir="return">
3781	<desc>
3782	Used to wait until the corresponding machine is actually
3783	dissociated from the given session on the server.
3784	Returned only when this session is a direct one.
3785	</desc>
3786	</param>
3787	</method>
3788
3789	<method name="beginSavingState">
3790	<desc>
3791	Called by the VM process to inform the server it wants to
3792	save the current state and stop the VM execution.
3793	</desc>
3794	<param name="progress" type="IProgress" dir="in">
3795	<desc>
3796	Progress object created by the VM process to wait until
3797	the state is saved.
3798	</desc>
3799	</param>
3800	<param name="stateFilePath" type="wstring" dir="out">
3801	<desc>
3802	File path the VM process must save the execution state to.
3803	</desc>
3804	</param>
3805	</method>
3806
3807	<method name="endSavingState">
3808	<desc>
3809	Called by the VM process to inform the server that saving
3810	the state previously requested by #beginSavingState is either
3811	successfully finished or there was a failure.
3812
3813	<result name="VBOX_E_FILE_ERROR">
3814	Settings file not accessible.
3815	</result>
3816	<result name="VBOX_E_XML_ERROR">
3817	Could not parse the settings file.
3818	</result>
3819
3820	</desc>
3821
3822	<param name="success" type="boolean" dir="in">
3823	<desc>@c true to indicate success and @c false otherwise.
3824	</desc>
3825	</param>
3826	</method>
3827
3828	<method name="adoptSavedState">
3829	<desc>
3830	Gets called by IConsole::adoptSavedState.
3831	<result name="VBOX_E_FILE_ERROR">
3832	Invalid saved state file path.
3833	</result>
3834	</desc>
3835	<param name="savedStateFile" type="wstring" dir="in">
3836	<desc>Path to the saved state file to adopt.</desc>
3837	</param>
3838	</method>
3839
3840	<method name="beginTakingSnapshot">
3841	<desc>
3842	Called from the VM process to request from the server to perform the
3843	server-side actions of creating a snapshot (creating differencing images
3844	and the snapshot object).
3845
3846	<result name="VBOX_E_FILE_ERROR">
3847	Settings file not accessible.
3848	</result>
3849	<result name="VBOX_E_XML_ERROR">
3850	Could not parse the settings file.
3851	</result>
3852	</desc>
3853	<param name="initiator" type="IConsole" dir="in">
3854	<desc>The console object that initiated this call.</desc>
3855	</param>
3856	<param name="name" type="wstring" dir="in">
3857	<desc>Snapshot name.</desc>
3858	</param>
3859	<param name="description" type="wstring" dir="in">
3860	<desc>Snapshot description.</desc>
3861	</param>
3862	<param name="consoleProgress" type="IProgress" dir="in">
3863	<desc>
3864	Progress object created by the VM process tracking the
3865	snapshot's progress. This has the following sub-operations:
3866	<ul>
3867	<li>setting up (weight 1);</li>
3868	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3869	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3870	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3871	<li>finishing up (weight 1)</li>
3872	</ul>
3873	</desc>
3874	</param>
3875	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3876	<desc>
3877	Whether this is an online snapshot (i.e. the machine is running).
3878	</desc>
3879	</param>
3880	<param name="stateFilePath" type="wstring" dir="out">
3881	<desc>
3882	File path the VM process must save the execution state to.
3883	</desc>
3884	</param>
3885	</method>
3886
3887	<method name="endTakingSnapshot">
3888	<desc>
3889	Called by the VM process to inform the server that the snapshot
3890	previously requested by #beginTakingSnapshot is either
3891	successfully taken or there was a failure.
3892	</desc>
3893
3894	<param name="success" type="boolean" dir="in">
3895	<desc>@c true to indicate success and @c false otherwise</desc>
3896	</param>
3897	</method>
3898
3899	<method name="deleteSnapshot">
3900	<desc>
3901	Gets called by IConsole::deleteSnapshot.
3902	<result name="VBOX_E_INVALID_OBJECT_STATE">
3903	Snapshot has more than one child snapshot.
3904	</result>
3905	</desc>
3906	<param name="initiator" type="IConsole" dir="in">
3907	<desc>The console object that initiated this call.</desc>
3908	</param>
3909	<param name="id" type="uuid" mod="string" dir="in">
3910	<desc>UUID of the snapshot to discard.</desc>
3911	</param>
3912	<param name="machineState" type="MachineState" dir="out">
3913	<desc>New machine state after this operation is started.</desc>
3914	</param>
3915	<param name="progress" type="IProgress" dir="return">
3916	<desc>Progress object to track the operation completion.</desc>
3917	</param>
3918	</method>
3919
3920	<method name="restoreSnapshot">
3921	<desc>
3922	Gets called by IConsole::RestoreSnapshot.
3923	</desc>
3924	<param name="initiator" type="IConsole" dir="in">
3925	<desc>The console object that initiated this call.</desc>
3926	</param>
3927	<param name="snapshot" type="ISnapshot" dir="in">
3928	<desc>The snapshot to restore the VM state from.</desc>
3929	</param>
3930	<param name="machineState" type="MachineState" dir="out">
3931	<desc>New machine state after this operation is started.</desc>
3932	</param>
3933	<param name="progress" type="IProgress" dir="return">
3934	<desc>Progress object to track the operation completion.</desc>
3935	</param>
3936	</method>
3937
3938	<method name="pullGuestProperties">
3939	<desc>
3940	Get the list of the guest properties matching a set of patterns along
3941	with their values, time stamps and flags and give responsibility for
3942	managing properties to the console.
3943	</desc>
3944	<param name="name" type="wstring" dir="out" safearray="yes">
3945	<desc>
3946	The names of the properties returned.
3947	</desc>
3948	</param>
3949	<param name="value" type="wstring" dir="out" safearray="yes">
3950	<desc>
3951	The values of the properties returned. The array entries match the
3952	corresponding entries in the @a name array.
3953	</desc>
3954	</param>
3955	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3956	<desc>
3957	The time stamps of the properties returned. The array entries match
3958	the corresponding entries in the @a name array.
3959	</desc>
3960	</param>
3961	<param name="flags" type="wstring" dir="out" safearray="yes">
3962	<desc>
3963	The flags of the properties returned. The array entries match the
3964	corresponding entries in the @a name array.
3965	</desc>
3966	</param>
3967	</method>
3968
3969	<method name="pushGuestProperties">
3970	<desc>
3971	Set the list of the guest properties matching a set of patterns along
3972	with their values, time stamps and flags and return responsibility for
3973	managing properties to IMachine.
3974	</desc>
3975	<param name="name" type="wstring" dir="in" safearray="yes">
3976	<desc>
3977	The names of the properties.
3978	</desc>
3979	</param>
3980	<param name="value" type="wstring" dir="in" safearray="yes">
3981	<desc>
3982	The values of the properties. The array entries match the
3983	corresponding entries in the @a name array.
3984	</desc>
3985	</param>
3986	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
3987	<desc>
3988	The time stamps of the properties. The array entries match
3989	the corresponding entries in the @a name array.
3990	</desc>
3991	</param>
3992	<param name="flags" type="wstring" dir="in" safearray="yes">
3993	<desc>
3994	The flags of the properties. The array entries match the
3995	corresponding entries in the @a name array.
3996	</desc>
3997	</param>
3998	</method>
3999	<method name="pushGuestProperty">
4000	<desc>
4001	Update a single guest property in IMachine.
4002	</desc>
4003	<param name="name" type="wstring" dir="in">
4004	<desc>
4005	The name of the property to be updated.
4006	</desc>
4007	</param>
4008	<param name="value" type="wstring" dir="in">
4009	<desc>
4010	The value of the property.
4011	</desc>
4012	</param>
4013	<param name="timestamp" type="unsigned long long" dir="in">
4014	<desc>
4015	The timestamp of the property.
4016	</desc>
4017	</param>
4018	<param name="flags" type="wstring" dir="in">
4019	<desc>
4020	The flags of the property.
4021	</desc>
4022	</param>
4023	</method>
4024
4025	<method name="lockMedia">
4026	<desc>
4027	Locks all media attached to the machine for writing and parents of
4028	attached differencing media (if any) for reading. This operation is
4029	atomic so that if it fails no media is actually locked.
4030
4031	This method is intended to be called when the machine is in Starting or
4032	Restoring state. The locked media will be automatically unlocked when
4033	the machine is powered off or crashed.
4034	</desc>
4035	</method>
4036	</interface>
4037
4038	<interface
4039	name="IBIOSSettings" extends="$unknown"
4040	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4041	wsmap="managed"
4042	>
4043	<desc>
4044	The IBIOSSettings interface represents BIOS settings of the virtual
4045	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4046	</desc>
4047	<attribute name="logoFadeIn" type="boolean">
4048	<desc>Fade in flag for BIOS logo animation.</desc>
4049	</attribute>
4050
4051	<attribute name="logoFadeOut" type="boolean">
4052	<desc>Fade out flag for BIOS logo animation.</desc>
4053	</attribute>
4054
4055	<attribute name="logoDisplayTime" type="unsigned long">
4056	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4057	</attribute>
4058
4059	<attribute name="logoImagePath" type="wstring">
4060	<desc>Local file system path for external BIOS image.</desc>
4061	</attribute>
4062
4063	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4064	<desc>Mode of the BIOS boot device menu.</desc>
4065	</attribute>
4066
4067	<attribute name="ACPIEnabled" type="boolean">
4068	<desc>ACPI support flag.</desc>
4069	</attribute>
4070
4071	<attribute name="IOAPICEnabled" type="boolean">
4072	<desc>
4073	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4074	and support IRQs above 15.
4075	</desc>
4076	</attribute>
4077
4078	<attribute name="timeOffset" type="long long">
4079	<desc>
4080	Offset in milliseconds from the host system time. This allows for
4081	guests running with a different system date/time than the host.
4082	It is equivalent to setting the system date/time in the BIOS except
4083	it is not an absolute value but a relative one. Guest Additions
4084	time synchronization honors this offset.
4085	</desc>
4086	</attribute>
4087
4088	<attribute name="PXEDebugEnabled" type="boolean">
4089	<desc>
4090	PXE debug logging flag. If set, VirtualBox will write extensive
4091	PXE trace information to the release log.
4092	</desc>
4093	</attribute>
4094
4095	</interface>
4096
4097	<interface
4098	name="IMachine" extends="$unknown"
4099	uuid="e2e5bab4-16ff-4ef4-b9df-f0b4433c1d1b"
4100	wsmap="managed"
4101	>
4102	<desc>
4103	The IMachine interface represents a virtual machine, or guest, created
4104	in VirtualBox.
4105
4106	This interface is used in two contexts. First of all, a collection of
4107	objects implementing this interface is stored in the
4108	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4109	machines that are currently registered with this VirtualBox
4110	installation. Also, once a session has been opened for the given virtual
4111	machine (e.g. the virtual machine is running), the machine object
4112	associated with the open session can be queried from the session object;
4113	see <link to="ISession"/> for details.
4114
4115	The main role of this interface is to expose the settings of the virtual
4116	machine and provide methods to change various aspects of the virtual
4117	machine's configuration. For machine objects stored in the
4118	<link to="IVirtualBox::machines"/> collection, all attributes are
4119	read-only unless explicitly stated otherwise in individual attribute
4120	and method descriptions. In order to change a machine setting, a session
4121	for this machine must be opened using one of
4122	<link to="IVirtualBox::openSession"/>,
4123	<link to="IVirtualBox::openRemoteSession"/> or
4124	<link to="IVirtualBox::openExistingSession"/> methods. After the
4125	session has been successfully opened, a mutable machine object needs to
4126	be queried from the session object and then the desired settings changes
4127	can be applied to the returned object using IMachine attributes and
4128	methods. See the <link to="ISession"/> interface description for more
4129	information about sessions.
4130
4131	Note that IMachine does not provide methods to control virtual machine
4132	execution (such as start the machine, or power it down) -- these methods
4133	are grouped in a separate interface called <link to="IConsole" />.
4134
4135	<see>ISession, IConsole</see>
4136	</desc>
4137
4138	<attribute name="parent" type="IVirtualBox" readonly="yes">
4139	<desc>Associated parent object.</desc>
4140	</attribute>
4141
4142	<attribute name="accessible" type="boolean" readonly="yes">
4143	<desc>
4144	Whether this virtual machine is currently accessible or not.
4145
4146	A machine is always deemed accessible unless it is registered <i>and</i>
4147	its settings file cannot be read or parsed (either because the file itself
4148	is unavailable or has invalid XML contents).
4149
4150	Every time this property is read, the accessibility state of
4151	this machine is re-evaluated. If the returned value is @c false,
4152	the <link to="#accessError"/> property may be used to get the
4153	detailed error information describing the reason of
4154	inaccessibility, including XML error messages.
4155
4156	When the machine is inaccessible, only the following properties
4157	can be used on it:
4158	<ul>
4159	<li><link to="#parent"/></li>
4160	<li><link to="#id"/></li>
4161	<li><link to="#settingsFilePath"/></li>
4162	<li><link to="#accessible"/></li>
4163	<li><link to="#accessError"/></li>
4164	</ul>
4165
4166	An attempt to access any other property or method will return
4167	an error.
4168
4169	The only possible action you can perform on an inaccessible
4170	machine is to unregister it using the
4171	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4172	for the accessibility state once more by querying this
4173	property).
4174
4175	<note>
4176	In the current implementation, once this property returns
4177	@c true, the machine will never become inaccessible
4178	later, even if its settings file cannot be successfully
4179	read/written any more (at least, until the VirtualBox
4180	server is restarted). This limitation may be removed in
4181	future releases.
4182	</note>
4183	</desc>
4184	</attribute>
4185
4186	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4187	<desc>
4188	Error information describing the reason of machine
4189	inaccessibility.
4190
4191	Reading this property is only valid after the last call to
4192	<link to="#accessible"/> returned @c false (i.e. the
4193	machine is currently unaccessible). Otherwise, a @c null
4194	IVirtualBoxErrorInfo object will be returned.
4195	</desc>
4196	</attribute>
4197
4198	<attribute name="name" type="wstring">
4199	<desc>
4200	Name of the virtual machine.
4201
4202	Besides being used for human-readable identification purposes
4203	everywhere in VirtualBox, the virtual machine name is also used
4204	as a name of the machine's settings file and as a name of the
4205	subdirectory this settings file resides in. Thus, every time you
4206	change the value of this property, the settings file will be
4207	renamed once you call <link to="#saveSettings"/> to confirm the
4208	change. The containing subdirectory will be also renamed, but
4209	only if it has exactly the same name as the settings file
4210	itself prior to changing this property (for backward compatibility
4211	with previous API releases). The above implies the following
4212	limitations:
4213	<ul>
4214	<li>The machine name cannot be empty.</li>
4215	<li>The machine name can contain only characters that are valid
4216	file name characters according to the rules of the file
4217	system used to store VirtualBox configuration.</li>
4218	<li>You cannot have two or more machines with the same name
4219	if they use the same subdirectory for storing the machine
4220	settings files.</li>
4221	<li>You cannot change the name of the machine if it is running,
4222	or if any file in the directory containing the settings file
4223	is being used by another running machine or by any other
4224	process in the host operating system at a time when
4225	<link to="#saveSettings"/> is called.
4226	</li>
4227	</ul>
4228	If any of the above limitations are hit, <link to="#saveSettings"/>
4229	will return an appropriate error message explaining the exact
4230	reason and the changes you made to this machine will not be
4231	saved.
4232	<note>
4233	For "legacy" machines created using the
4234	<link to="IVirtualBox::createLegacyMachine"/> call,
4235	the above naming limitations do not apply because the
4236	machine name does not affect the settings file name.
4237	The settings file name remains the same as it was specified
4238	during machine creation and never changes.
4239	</note>
4240	</desc>
4241	</attribute>
4242
4243	<attribute name="description" type="wstring">
4244	<desc>
4245	Description of the virtual machine.
4246
4247	The description attribute can contain any text and is
4248	typically used to describe the hardware and software
4249	configuration of the virtual machine in detail (i.e. network
4250	settings, versions of the installed software and so on).
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="id" type="uuid" mod="string" readonly="yes">
4255	<desc>UUID of the virtual machine.</desc>
4256	</attribute>
4257
4258	<attribute name="OSTypeId" type="wstring">
4259	<desc>
4260	User-defined identifier of the Guest OS type.
4261	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4262	an IGuestOSType object representing details about the given
4263	Guest OS type.
4264	<note>
4265	This value may differ from the value returned by
4266	<link to="IGuest::OSTypeId"/> if Guest Additions are
4267	installed to the guest OS.
4268	</note>
4269	</desc>
4270	</attribute>
4271
4272	<attribute name="HardwareVersion" type="wstring">
4273	<desc>Hardware version identifier. Internal use only for now.</desc>
4274	</attribute>
4275
4276	<attribute name="hardwareUUID" type="uuid" mod="string">
4277	<desc>
4278	The UUID presented to the guest via memory tables, hardware and guest
4279	properties. For most VMs this is the same as the @a id, but for VMs
4280	which have been cloned or teleported it may be the same as the source
4281	VM. This latter is because the guest shouldn't notice that it was
4282	cloned or teleported.
4283	</desc>
4284	</attribute>
4285
4286	<attribute name="CPUCount" type="unsigned long">
4287	<desc>Number of virtual CPUs in the VM.</desc>
4288	</attribute>
4289
4290	<attribute name="memorySize" type="unsigned long">
4291	<desc>System memory size in megabytes.</desc>
4292	</attribute>
4293
4294	<attribute name="memoryBalloonSize" type="unsigned long">
4295	<desc>Initial memory balloon size in megabytes.</desc>
4296	</attribute>
4297
4298	<attribute name="statisticsUpdateInterval" type="unsigned long">
4299	<desc>Initial interval to update guest statistics in seconds.</desc>
4300	</attribute>
4301
4302	<attribute name="VRAMSize" type="unsigned long">
4303	<desc>Video memory size in megabytes.</desc>
4304	</attribute>
4305
4306	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4307	<desc>
4308	This setting determines whether VirtualBox allows this machine to make
4309	use of the 3D graphics support available on the host.</desc>
4310	</attribute>
4311
4312	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4313	<desc>
4314	This setting determines whether VirtualBox allows this machine to make
4315	use of the 2D video acceleration support available on the host.</desc>
4316	</attribute>
4317
4318	<attribute name="monitorCount" type="unsigned long">
4319	<desc>
4320	Number of virtual monitors.
4321	<note>
4322	Only effective on Windows XP and later guests with
4323	Guest Additions installed.
4324	</note>
4325	</desc>
4326	</attribute>
4327
4328	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4329	<desc>Object containing all BIOS settings.</desc>
4330	</attribute>
4331
4332	<attribute name="firmwareType" type="FirmwareType">
4333	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4334	bootstrap in this VM.</desc>
4335	</attribute>
4336
4337	<attribute name="snapshotFolder" type="wstring">
4338	<desc>
4339	Full path to the directory used to store snapshot data
4340	(differencing media and saved state files) of this machine.
4341
4342	The initial value of this property is
4343	<tt><</tt><link to="#settingsFilePath">
4344	path_to_settings_file</link><tt>>/<</tt>
4345	<link to="#id">machine_uuid</link>
4346	<tt>></tt>.
4347
4348	Currently, it is an error to try to change this property on
4349	a machine that has snapshots (because this would require to
4350	move possibly large files to a different location).
4351	A separate method will be available for this purpose later.
4352
4353	<note>
4354	Setting this property to @c null or to an empty string will restore
4355	the initial value.
4356	</note>
4357	<note>
4358	When setting this property, the specified path can be
4359	absolute (full path) or relative to the directory where the
4360	<link to="#settingsFilePath">machine settings file</link>
4361	is located. When reading this property, a full path is
4362	always returned.
4363	</note>
4364	<note>
4365	The specified path may not exist, it will be created
4366	when necessary.
4367	</note>
4368	</desc>
4369	</attribute>
4370
4371	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4372	<desc>VRDP server object.</desc>
4373	</attribute>
4374
4375	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4376	<desc>Array of media attached to this machine.</desc>
4377	</attribute>
4378
4379	<attribute name="USBController" type="IUSBController" readonly="yes">
4380	<desc>
4381	Associated USB controller object.
4382
4383	<note>
4384	If USB functionality is not available in the given edition of
4385	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4386	</note>
4387	</desc>
4388	</attribute>
4389
4390	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4391	<desc>Associated audio adapter, always present.</desc>
4392	</attribute>
4393
4394	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4395	<desc>Array of storage controllers attached to this machine.</desc>
4396	</attribute>
4397
4398	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4399	<desc>
4400	Full name of the file containing machine settings data.
4401	</desc>
4402	</attribute>
4403
4404	<attribute name="settingsModified" type="boolean" readonly="yes">
4405	<desc>
4406	Whether the settings of this machine have been modified
4407	(but neither yet saved nor discarded).
4408	<note>
4409	Reading this property is only valid on instances returned
4410	by <link to="ISession::machine"/> and on new machines
4411	created by <link to="IVirtualBox::createMachine"/> or opened
4412	by <link to="IVirtualBox::openMachine"/> but not
4413	yet registered, or on unregistered machines after calling
4414	<link to="IVirtualBox::unregisterMachine"/>. For all other
4415	cases, the settings can never be modified.
4416	</note>
4417	<note>
4418	For newly created unregistered machines, the value of this
4419	property is always @c true until <link to="#saveSettings"/>
4420	is called (no matter if any machine settings have been
4421	changed after the creation or not). For opened machines
4422	the value is set to @c false (and then follows to normal rules).
4423	</note>
4424	</desc>
4425	</attribute>
4426
4427	<attribute name="sessionState" type="SessionState" readonly="yes">
4428	<desc>Current session state for this machine.</desc>
4429	</attribute>
4430
4431	<attribute name="sessionType" type="wstring" readonly="yes">
4432	<desc>
4433	Type of the session. If <link to="#sessionState"/> is
4434	SessionSpawning or SessionOpen, this attribute contains the
4435	same value as passed to the
4436	<link to="IVirtualBox::openRemoteSession"/> method in the
4437	@a type parameter. If the session was opened directly using
4438	<link to="IVirtualBox::openSession"/>, or if
4439	<link to="#sessionState"/> is SessionClosed, the value of this
4440	attribute is an empty string.
4441	</desc>
4442	</attribute>
4443
4444	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4445	<desc>
4446	Identifier of the session process. This attribute contains the
4447	platform-dependent identifier of the process that has opened a
4448	direct session for this machine using the
4449	<link to="IVirtualBox::openSession"/> call. The returned value
4450	is only valid if <link to="#sessionState"/> is SessionOpen or
4451	SessionClosing (i.e. a session is currently open or being
4452	closed) by the time this property is read.
4453	</desc>
4454	</attribute>
4455
4456	<attribute name="state" type="MachineState" readonly="yes">
4457	<desc>Current execution state of this machine.</desc>
4458	</attribute>
4459
4460	<attribute name="lastStateChange" type="long long" readonly="yes">
4461	<desc>
4462	Time stamp of the last execution state change,
4463	in milliseconds since 1970-01-01 UTC.
4464	</desc>
4465	</attribute>
4466
4467	<attribute name="stateFilePath" type="wstring" readonly="yes">
4468	<desc>
4469	Full path to the file that stores the execution state of
4470	the machine when it is in the <link to="MachineState_Saved"/> state.
4471	<note>
4472	When the machine is not in the Saved state, this attribute is
4473	an empty string.
4474	</note>
4475	</desc>
4476	</attribute>
4477
4478	<attribute name="logFolder" type="wstring" readonly="yes">
4479	<desc>
4480	Full path to the folder that stores a set of rotated log files
4481	recorded during machine execution. The most recent log file is
4482	named <tt>VBox.log</tt>, the previous log file is
4483	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4484	in the current version).
4485	</desc>
4486	</attribute>
4487
4488	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4489	<desc>
4490	Current snapshot of this machine. This is @c null if the machine
4491	currently has no snapshots. If it is not @c null, then it was
4492	set by one of <link to="Console::takeSnapshot" />,
4493	<link to="Console::deleteSnapshot" />
4494	or <link to="Console::restoreSnapshot" />, depending on which
4495	was called last. See <link to="ISnapshot"/> for details.
4496	</desc>
4497	</attribute>
4498
4499	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4500	<desc>
4501	Number of snapshots taken on this machine. Zero means the
4502	machine doesn't have any snapshots.
4503	</desc>
4504	</attribute>
4505
4506	<attribute name="currentStateModified" type="boolean" readonly="yes">
4507	<desc>
4508	Returns @c true if the current state of the machine is not
4509	identical to the state stored in the current snapshot.
4510
4511	The current state is identical to the current snapshot only
4512	directly after one of the following calls are made:
4513
4514	<ul>
4515	<li><link to="IConsole::restoreSnapshot"/>
4516	</li>
4517	<li><link to="IConsole::takeSnapshot"/> (issued on a
4518	"powered off" or "saved" machine, for which
4519	<link to="#settingsModified"/> returns @c false)
4520	</li>
4521	<li><link to="IMachine::setCurrentSnapshot"/>
4522	</li>
4523	</ul>
4524
4525	The current state remains identical until one of the following
4526	happens:
4527	<ul>
4528	<li>settings of the machine are changed</li>
4529	<li>the saved state is discarded</li>
4530	<li>the current snapshot is discarded</li>
4531	<li>an attempt to execute the machine is made</li>
4532	</ul>
4533
4534	<note>
4535	For machines that don't have snapshots, this property is
4536	always @c false.
4537	</note>
4538	</desc>
4539	</attribute>
4540
4541	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4542	<desc>
4543	Collection of shared folders for this machine (permanent shared
4544	folders). These folders are shared automatically at machine startup
4545	and available only to the guest OS installed within this machine.
4546
4547	New shared folders are added to the collection using
4548	<link to="#createSharedFolder"/>. Existing shared folders can be
4549	removed using <link to="#removeSharedFolder"/>.
4550	</desc>
4551	</attribute>
4552
4553	<attribute name="clipboardMode" type="ClipboardMode">
4554	<desc>
4555	Synchronization mode between the host OS clipboard
4556	and the guest OS clipboard.
4557	</desc>
4558	</attribute>
4559
4560	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4561	<desc>
4562	A comma-separated list of simple glob patterns. Changes to guest
4563	properties whose name matches one of the patterns will generate an
4564	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4565	</desc>
4566	</attribute>
4567
4568	<attribute name="teleporterEnabled" type="boolean">
4569	<desc>
4570	When set to @a true, the virtual machine becomes a target teleporter
4571	the next time it is powered on. This can only set to @a true when the
4572	VM is in the @a PoweredOff or @a Aborted state.
4573
4574	This property is automatically set to @a false when the VM is powered
4575	on.
4576	</desc>
4577	</attribute>
4578
4579	<attribute name="teleporterPort" type="unsigned long">
4580	<desc>
4581	The TCP port the target teleporter will listen for incoming
4582	teleportations on.
4583
4584	0 means the port is automatically selected upon power on. The actual
4585	value can be read from this property while the machine is waiting for
4586	incoming teleportations.
4587	</desc>
4588	</attribute>
4589
4590	<attribute name="teleporterAddress" type="wstring">
4591	<desc>
4592	The address the target teleporter will listen on. If set to an empty
4593	string, it will listen on all addresses.
4594	</desc>
4595	</attribute>
4596
4597	<attribute name="teleporterPassword" type="wstring">
4598	<desc>
4599	The password the to check for on the target teleporter. This is just a
4600	very basic measure to prevent simple hacks and operators accidentally
4601	beaming a virtual machine to the wrong place.
4602	</desc>
4603	</attribute>
4604
4605	<method name="setBootOrder">
4606	<desc>
4607	Puts the given device to the specified position in
4608	the boot order.
4609
4610	To indicate that no device is associated with the given position,
4611	<link to="DeviceType_Null"/> should be used.
4612
4613	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4614
4615	<result name="E_INVALIDARG">
4616	Boot @a position out of range.
4617	</result>
4618	<result name="E_NOTIMPL">
4619	Booting from USB @a device currently not supported.
4620	</result>
4621
4622	</desc>
4623	<param name="position" type="unsigned long" dir="in">
4624	<desc>
4625	Position in the boot order (@c 1 to the total number of
4626	devices the machine can boot from, as returned by
4627	<link to="ISystemProperties::maxBootPosition"/>).
4628	</desc>
4629	</param>
4630	<param name="device" type="DeviceType" dir="in">
4631	<desc>
4632	The type of the device used to boot at the given position.
4633	</desc>
4634	</param>
4635	</method>
4636
4637	<method name="getBootOrder" const="yes">
4638	<desc>
4639	Returns the device type that occupies the specified
4640	position in the boot order.
4641
4642	@todo [remove?]
4643	If the machine can have more than one device of the returned type
4644	(such as hard disks), then a separate method should be used to
4645	retrieve the individual device that occupies the given position.
4646
4647	If here are no devices at the given position, then
4648	<link to="DeviceType_Null"/> is returned.
4649
4650	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4651
4652	<result name="E_INVALIDARG">
4653	Boot @a position out of range.
4654	</result>
4655
4656	</desc>
4657	<param name="position" type="unsigned long" dir="in">
4658	<desc>
4659	Position in the boot order (@c 1 to the total number of
4660	devices the machine can boot from, as returned by
4661	<link to="ISystemProperties::maxBootPosition"/>).
4662	</desc>
4663	</param>
4664	<param name="device" type="DeviceType" dir="return">
4665	<desc>
4666	Device at the given position.
4667	</desc>
4668	</param>
4669	</method>
4670
4671	<method name="attachDevice">
4672	<desc>
4673	Attaches a device and optionally mounts a medium to the given storage
4674	controller (<link to="IStorageController" />, identified by @a name),
4675	at the indicated port and device.
4676
4677	This method is intended for managing storage devices in general (it works
4678	for both fixed and removable media). For storage devices supporting removable
4679	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4680	for changing the media while the machine is running.
4681
4682	For the IDE bus, the @a controllerPort parameter can be either
4683	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4684	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4685	to specify the master or the slave device, respectively. (In the
4686	default configuration of virtual machines, the secondary master is
4687	used for a CD/DVD drive.)
4688
4689	For an SATA controller, @a controllerPort must be a number ranging
4690	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4691	be a number ranging from @c 0 to @c 15.
4692
4693	For both SCSI and SATA, the @a device parameter is unused and must
4694	be @c 0.
4695
4696	For fixed media such as hard disks, the given medium identifier cannot
4697	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4698	and floppies.
4699
4700	After calling this returns successfully, a new instance of
4701	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4702	attachments (<link to="IMachine::mediumAttachments"/>).
4703
4704	The specified device slot must not have a device attached to it,
4705	or this method will fail.
4706
4707	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4708	information about attaching media.
4709
4710	<note>
4711	You cannot attach a device to a running machine. Also, you cannot
4712	attach a device to a newly created machine until this machine's
4713	settings are saved to disk using <link to="#saveSettings"/>.
4714	</note>
4715	<note>
4716	If the medium is being attached indirectly, a new differencing medium
4717	will implicitly be created for it and attached instead. If the
4718	changes made to the machine settings (including this indirect
4719	attachment) are later cancelled using <link to="#discardSettings"/>,
4720	this implicitly created differencing medium will implicitly
4721	be deleted.
4722	</note>
4723
4724	<result name="E_INVALIDARG">
4725	SATA device, SATA port, IDE port or IDE slot out of range.
4726	</result>
4727	<result name="VBOX_E_INVALID_OBJECT_STATE">
4728	Attempt to attach medium to an unregistered virtual machine.
4729	</result>
4730	<result name="VBOX_E_INVALID_VM_STATE">
4731	Invalid machine state.
4732	</result>
4733	<result name="VBOX_E_OBJECT_IN_USE">
4734	Hard disk already attached to this or another virtual machine.
4735	</result>
4736
4737	</desc>
4738	<param name="name" type="wstring" dir="in">
4739	<desc>Name of the storage controller to attach the device to.</desc>
4740	</param>
4741	<param name="controllerPort" type="long" dir="in">
4742	<desc>Port to attach the device to.</desc>
4743	</param>
4744	<param name="device" type="long" dir="in">
4745	<desc>Device slot in the given port to attach the device to.</desc>
4746	</param>
4747	<param name="type" type="DeviceType" dir="in">
4748	<desc>Device type of the attached device.</desc>
4749	</param>
4750	<param name="id" type="uuid" mod="string" dir="in">
4751	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4752	medium.</desc>
4753	</param>
4754	</method>
4755
4756	<method name="detachDevice">
4757	<desc>
4758	Detaches the device attached to a device slot of the specified bus.
4759
4760	Detaching the device from the virtual machine is deferred. This means
4761	that the medium remains associated with the machine when this method
4762	returns and gets actually de-associated only after a successful
4763	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4764	for more detailed information about attaching media.
4765
4766	<note>
4767	You cannot detach a device from a running machine.
4768	</note>
4769	<note>
4770	Detaching differencing media implicitly created by <link
4771	to="#attachDevice"/> for the indirect attachment using this
4772	method will <b>not</b> implicitly delete them. The
4773	<link to="IMedium::deleteStorage"/> operation should be
4774	explicitly performed by the caller after the medium is successfully
4775	detached and the settings are saved with
4776	<link to="#saveSettings"/>, if it is the desired action.
4777	</note>
4778
4779	<result name="VBOX_E_INVALID_VM_STATE">
4780	Attempt to detach medium from a running virtual machine.
4781	</result>
4782	<result name="VBOX_E_OBJECT_NOT_FOUND">
4783	No medium attached to given slot/bus.
4784	</result>
4785	<result name="VBOX_E_NOT_SUPPORTED">
4786	Medium format does not support storage deletion.
4787	</result>
4788
4789	</desc>
4790	<param name="name" type="wstring" dir="in">
4791	<desc>Name of the storage controller to detach the medium from.</desc>
4792	</param>
4793	<param name="controllerPort" type="long" dir="in">
4794	<desc>Port number to detach the medium from.</desc>
4795	</param>
4796	<param name="device" type="long" dir="in">
4797	<desc>Device slot number to detach the medium from.</desc>
4798	</param>
4799	</method>
4800
4801	<method name="passthroughDevice">
4802	<desc>
4803	Sets the passthrough mode of an existing DVD device. Changing the
4804	setting while the VM is running is forbidden. The setting is only used
4805	if at VM start the device is configured as a host DVD drive, in all
4806	other cases it is ignored. The device must already exist; see
4807	<link to="IMachine::attachDevice"/> for how to attach a new device.
4808
4809	The @a controllerPort and @a device parameters specify the device slot and
4810	have have the same meaning as with <link to="IMachine::attachDevice" />.
4811
4812	<result name="E_INVALIDARG">
4813	SATA device, SATA port, IDE port or IDE slot out of range.
4814	</result>
4815	<result name="VBOX_E_INVALID_OBJECT_STATE">
4816	Attempt to modify an unregistered virtual machine.
4817	</result>
4818	<result name="VBOX_E_INVALID_VM_STATE">
4819	Invalid machine state.
4820	</result>
4821
4822	</desc>
4823	<param name="name" type="wstring" dir="in">
4824	<desc>Name of the storage controller.</desc>
4825	</param>
4826	<param name="controllerPort" type="long" dir="in">
4827	<desc>Storage controller port.</desc>
4828	</param>
4829	<param name="device" type="long" dir="in">
4830	<desc>Device slot in the given port.</desc>
4831	</param>
4832	<param name="passthrough" type="boolean" dir="in">
4833	<desc>New value for the passthrough setting.</desc>
4834	</param>
4835	</method>
4836
4837	<method name="mountMedium">
4838	<desc>
4839	Mounts a medium (<link to="IMedium" />, identified
4840	by the given UUID @a id) to the given storage controller
4841	(<link to="IStorageController" />, identified by @a name),
4842	at the indicated port and device. The device must already exist;
4843	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4844
4845	This method is intended only for managing removable media, where the
4846	device is fixed but media is changeable at runtime (such as DVDs
4847	and floppies). It cannot be used for fixed media such as hard disks.
4848
4849	The @a controllerPort and @a device parameters specify the device slot and
4850	have have the same meaning as with <link to="IMachine::attachDevice" />.
4851
4852	The specified device slot can have a medium mounted, which will be
4853	unmounted first. Specifying a zero UUID (or an empty string) for
4854	@a medium does just an unmount.
4855
4856	See <link to="IMedium"/> for more detailed information about
4857	attaching media.
4858
4859	<result name="E_INVALIDARG">
4860	SATA device, SATA port, IDE port or IDE slot out of range.
4861	</result>
4862	<result name="VBOX_E_INVALID_OBJECT_STATE">
4863	Attempt to attach medium to an unregistered virtual machine.
4864	</result>
4865	<result name="VBOX_E_INVALID_VM_STATE">
4866	Invalid machine state.
4867	</result>
4868	<result name="VBOX_E_OBJECT_IN_USE">
4869	Medium already attached to this or another virtual machine.
4870	</result>
4871
4872	</desc>
4873	<param name="name" type="wstring" dir="in">
4874	<desc>Name of the storage controller to attach the medium to.</desc>
4875	</param>
4876	<param name="controllerPort" type="long" dir="in">
4877	<desc>Port to attach the medium to.</desc>
4878	</param>
4879	<param name="device" type="long" dir="in">
4880	<desc>Device slot in the given port to attach the medium to.</desc>
4881	</param>
4882	<param name="medium" type="uuid" mod="string" dir="in">
4883	<desc>UUID of the medium to attach. A zero UUID means unmount the
4884	currently mounted medium.</desc>
4885	</param>
4886	</method>
4887
4888	<method name="getMedium" const="yes">
4889	<desc>
4890	Returns the virtual medium attached to a device slot of the specified
4891	bus.
4892
4893	Note that if the medium was indirectly attached by
4894	<link to="#mountMedium"/> to the given device slot then this
4895	method will return not the same object as passed to the
4896	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4897	more detailed information about mounting a medium.
4898
4899	<result name="VBOX_E_OBJECT_NOT_FOUND">
4900	No medium attached to given slot/bus.
4901	</result>
4902
4903	</desc>
4904	<param name="name" type="wstring" dir="in">
4905	<desc>Name of the storage controller the medium is attached to.</desc>
4906	</param>
4907	<param name="controllerPort" type="long" dir="in">
4908	<desc>Port to query.</desc>
4909	</param>
4910	<param name="device" type="long" dir="in">
4911	<desc>Device slot in the given port to query.</desc>
4912	</param>
4913	<param name="medium" type="IMedium" dir="return">
4914	<desc>Attached medium object.</desc>
4915	</param>
4916	</method>
4917
4918	<method name="getMediumAttachmentsOfController" const="yes">
4919	<desc>
4920	Returns an array of medium attachments which are attached to the
4921	the controller with the given name.
4922
4923	<result name="VBOX_E_OBJECT_NOT_FOUND">
4924	A storage controller with given name doesn't exist.
4925	</result>
4926	</desc>
4927	<param name="name" type="wstring" dir="in"/>
4928	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4929	</method>
4930
4931	<method name="getMediumAttachment" const="yes">
4932	<desc>
4933	Returns a medium attachment which corresponds to the controller with
4934	the given name, on the given port and device slot.
4935
4936	<result name="VBOX_E_OBJECT_NOT_FOUND">
4937	No attachment exists for the given controller/port/device combination.
4938	</result>
4939	</desc>
4940	<param name="name" type="wstring" dir="in"/>
4941	<param name="controllerPort" type="long" dir="in"/>
4942	<param name="device" type="long" dir="in"/>
4943	<param name="attachment" type="IMediumAttachment" dir="return"/>
4944	</method>
4945
4946	<method name="getNetworkAdapter" const="yes">
4947	<desc>
4948	Returns the network adapter associated with the given slot.
4949	Slots are numbered sequentially, starting with zero. The total
4950	number of adapters per machine is defined by the
4951	<link to="ISystemProperties::networkAdapterCount"/> property,
4952	so the maximum slot number is one less than that property's value.
4953
4954	<result name="E_INVALIDARG">
4955	Invalid @a slot number.
4956	</result>
4957
4958	</desc>
4959	<param name="slot" type="unsigned long" dir="in"/>
4960	<param name="adapter" type="INetworkAdapter" dir="return"/>
4961	</method>
4962
4963	<method name="addStorageController">
4964	<desc>
4965	Adds a new storage controller (SCSI or SATA controller) to the
4966	machine and returns it as an instance of
4967	<link to="IStorageController" />.
4968
4969	@a name identifies the controller for subsequent calls such as
4970	<link to="#getStorageControllerByName" />,
4971	<link to="#getStorageControllerByInstance" />,
4972	<link to="#removeStorageController" />,
4973	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4974
4975	After the controller has been added, you can set its exact
4976	type by setting the <link to="IStorageController::controllerType" />.
4977
4978	<result name="VBOX_E_OBJECT_IN_USE">
4979	A storage controller with given name exists already.
4980	</result>
4981	<result name="E_INVALIDARG">
4982	Invalid @a controllerType.
4983	</result>
4984	</desc>
4985	<param name="name" type="wstring" dir="in"/>
4986	<param name="connectionType" type="StorageBus" dir="in"/>
4987	<param name="controller" type="IStorageController" dir="return"/>
4988	</method>
4989
4990	<method name="getStorageControllerByName" const="yes">
4991	<desc>
4992	Returns a storage controller with the given name.
4993
4994	<result name="VBOX_E_OBJECT_NOT_FOUND">
4995	A storage controller with given name doesn't exist.
4996	</result>
4997	</desc>
4998	<param name="name" type="wstring" dir="in"/>
4999	<param name="storageController" type="IStorageController" dir="return"/>
5000	</method>
5001
5002	<method name="getStorageControllerByInstance" const="yes">
5003	<desc>
5004	Returns a storage controller with the given instance number.
5005
5006	<result name="VBOX_E_OBJECT_NOT_FOUND">
5007	A storage controller with given instance number doesn't exist.
5008	</result>
5009	</desc>
5010	<param name="instance" type="unsigned long" dir="in"/>
5011	<param name="storageController" type="IStorageController" dir="return"/>
5012	</method>
5013
5014	<method name="removeStorageController">
5015	<desc>
5016	Removes a storage controller from the machine.
5017
5018	<result name="VBOX_E_OBJECT_NOT_FOUND">
5019	A storage controller with given name doesn't exist.
5020	</result>
5021	</desc>
5022	<param name="name" type="wstring" dir="in"/>
5023	</method>
5024
5025	<method name="getSerialPort" const="yes">
5026	<desc>
5027	Returns the serial port associated with the given slot.
5028	Slots are numbered sequentially, starting with zero. The total
5029	number of serial ports per machine is defined by the
5030	<link to="ISystemProperties::serialPortCount"/> property,
5031	so the maximum slot number is one less than that property's value.
5032
5033	<result name="E_INVALIDARG">
5034	Invalid @a slot number.
5035	</result>
5036
5037	</desc>
5038	<param name="slot" type="unsigned long" dir="in"/>
5039	<param name="port" type="ISerialPort" dir="return"/>
5040	</method>
5041
5042	<method name="getParallelPort" const="yes">
5043	<desc>
5044	Returns the parallel port associated with the given slot.
5045	Slots are numbered sequentially, starting with zero. The total
5046	number of parallel ports per machine is defined by the
5047	<link to="ISystemProperties::parallelPortCount"/> property,
5048	so the maximum slot number is one less than that property's value.
5049
5050	<result name="E_INVALIDARG">
5051	Invalid @a slot number.
5052	</result>
5053
5054	</desc>
5055	<param name="slot" type="unsigned long" dir="in"/>
5056	<param name="port" type="IParallelPort" dir="return"/>
5057	</method>
5058
5059	<method name="getExtraDataKeys">
5060	<desc>
5061	Returns an array representing the machine-specific extra data keys
5062	which currently have values defined.
5063	</desc>
5064	<param name="value" type="wstring" dir="return" safearray="yes">
5065	<desc>Array of extra data keys.</desc>
5066	</param>
5067	</method>
5068
5069	<method name="getExtraData">
5070	<desc>
5071	Returns associated machine-specific extra data.
5072
5073	If the requested data @a key does not exist, this function will
5074	succeed and return an empty string in the @a value argument.
5075
5076	<result name="VBOX_E_FILE_ERROR">
5077	Settings file not accessible.
5078	</result>
5079	<result name="VBOX_E_XML_ERROR">
5080	Could not parse the settings file.
5081	</result>
5082
5083	</desc>
5084	<param name="key" type="wstring" dir="in">
5085	<desc>Name of the data key to get.</desc>
5086	</param>
5087	<param name="value" type="wstring" dir="return">
5088	<desc>Value of the requested data key.</desc>
5089	</param>
5090	</method>
5091
5092	<method name="setExtraData">
5093	<desc>
5094	Sets associated machine-specific extra data.
5095
5096	If you pass @c null or an empty string as a key @a value, the given
5097	@a key will be deleted.
5098
5099	<note>
5100	Before performing the actual data change, this method will ask all
5101	registered callbacks using the
5102	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5103	notification for a permission. If one of the callbacks refuses the
5104	new value, the change will not be performed.
5105	</note>
5106	<note>
5107	On success, the
5108	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5109	is called to inform all registered callbacks about a successful data
5110	change.
5111	</note>
5112	<note>
5113	This method can be called outside the machine session and therefore
5114	it's a caller's responsibility to handle possible race conditions
5115	when several clients change the same key at the same time.
5116	</note>
5117
5118	<result name="VBOX_E_FILE_ERROR">
5119	Settings file not accessible.
5120	</result>
5121	<result name="VBOX_E_XML_ERROR">
5122	Could not parse the settings file.
5123	</result>
5124
5125	</desc>
5126	<param name="key" type="wstring" dir="in">
5127	<desc>Name of the data key to set.</desc>
5128	</param>
5129	<param name="value" type="wstring" dir="in">
5130	<desc>Value to assign to the key.</desc>
5131	</param>
5132	</method>
5133
5134	<method name="getCpuProperty" const="yes">
5135	<desc>
5136	Returns the virtual CPU boolean value of the specified property.
5137
5138	<result name="E_INVALIDARG">
5139	Invalid property.
5140	</result>
5141
5142	</desc>
5143	<param name="property" type="CpuPropertyType" dir="in">
5144	<desc>
5145	Property type to query.
5146	</desc>
5147	</param>
5148	<param name="value" type="boolean" dir="return">
5149	<desc>
5150	Property value.
5151	</desc>
5152	</param>
5153	</method>
5154
5155	<method name="setCpuProperty">
5156	<desc>
5157	Sets the virtual CPU boolean value of the specified property.
5158
5159	<result name="E_INVALIDARG">
5160	Invalid property.
5161	</result>
5162
5163	</desc>
5164	<param name="property" type="CpuPropertyType" dir="in">
5165	<desc>
5166	Property type to query.
5167	</desc>
5168	</param>
5169	<param name="value" type="boolean" dir="in">
5170	<desc>
5171	Property value.
5172	</desc>
5173	</param>
5174	</method>
5175
5176	<method name="getCpuIdLeaf" const="yes">
5177	<desc>
5178	Returns the virtual CPU cpuid information for the specified leaf.
5179
5180	Currently supported index values for cpuid:
5181	Standard CPUID leafs: 0 - 0xA
5182	Extended CPUID leafs: 0x80000000 - 0x8000000A
5183
5184	See the Intel and AMD programmer's manuals for detailed information
5185	about the cpuid instruction and its leafs.
5186	<result name="E_INVALIDARG">
5187	Invalid id.
5188	</result>
5189
5190	</desc>
5191	<param name="id" type="unsigned long" dir="in">
5192	<desc>
5193	Cpuid leaf index.
5194	</desc>
5195	</param>
5196	<param name="valEax" type="unsigned long" dir="out">
5197	<desc>
5198	Cpuid leaf value for register eax.
5199	</desc>
5200	</param>
5201	<param name="valEbx" type="unsigned long" dir="out">
5202	<desc>
5203	Cpuid leaf value for register ebx.
5204	</desc>
5205	</param>
5206	<param name="valEcx" type="unsigned long" dir="out">
5207	<desc>
5208	Cpuid leaf value for register ecx.
5209	</desc>
5210	</param>
5211	<param name="valEdx" type="unsigned long" dir="out">
5212	<desc>
5213	Cpuid leaf value for register edx.
5214	</desc>
5215	</param>
5216	</method>
5217
5218	<method name="setCpuIdLeaf" const="yes">
5219	<desc>
5220	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5221	are not passed unmodified. VirtualBox clears features that it doesn't support.
5222
5223	Currently supported index values for cpuid:
5224	Standard CPUID leafs: 0 - 0xA
5225	Extended CPUID leafs: 0x80000000 - 0x8000000A
5226
5227	See the Intel and AMD programmer's manuals for detailed information
5228	about the cpuid instruction and its leafs.
5229
5230	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5231	random crashes inside VMs.
5232	<result name="E_INVALIDARG">
5233	Invalid id.
5234	</result>
5235
5236	</desc>
5237	<param name="id" type="unsigned long" dir="in">
5238	<desc>
5239	Cpuid leaf index.
5240	</desc>
5241	</param>
5242	<param name="valEax" type="unsigned long" dir="in">
5243	<desc>
5244	Cpuid leaf value for register eax.
5245	</desc>
5246	</param>
5247	<param name="valEbx" type="unsigned long" dir="in">
5248	<desc>
5249	Cpuid leaf value for register ebx.
5250	</desc>
5251	</param>
5252	<param name="valEcx" type="unsigned long" dir="in">
5253	<desc>
5254	Cpuid leaf value for register ecx.
5255	</desc>
5256	</param>
5257	<param name="valEdx" type="unsigned long" dir="in">
5258	<desc>
5259	Cpuid leaf value for register edx.
5260	</desc>
5261	</param>
5262	</method>
5263
5264	<method name="removeCpuIdLeaf" const="yes">
5265	<desc>
5266	Removes the virtual CPU cpuid leaf for the specified index
5267
5268	<result name="E_INVALIDARG">
5269	Invalid id.
5270	</result>
5271
5272	</desc>
5273	<param name="id" type="unsigned long" dir="in">
5274	<desc>
5275	Cpuid leaf index.
5276	</desc>
5277	</param>
5278	</method>
5279
5280	<method name="removeAllCpuIdLeafs" const="yes">
5281	<desc>
5282	Removes all the virtual CPU cpuid leafs
5283	</desc>
5284	</method>
5285
5286	<method name="getHWVirtExProperty" const="yes">
5287	<desc>
5288	Returns the value of the specified hardware virtualization boolean property.
5289
5290	<result name="E_INVALIDARG">
5291	Invalid property.
5292	</result>
5293
5294	</desc>
5295	<param name="property" type="HWVirtExPropertyType" dir="in">
5296	<desc>
5297	Property type to query.
5298	</desc>
5299	</param>
5300	<param name="value" type="boolean" dir="return">
5301	<desc>
5302	Property value.
5303	</desc>
5304	</param>
5305	</method>
5306
5307	<method name="setHWVirtExProperty">
5308	<desc>
5309	Sets a new value for the specified hardware virtualization boolean property.
5310
5311	<result name="E_INVALIDARG">
5312	Invalid property.
5313	</result>
5314
5315	</desc>
5316	<param name="property" type="HWVirtExPropertyType" dir="in">
5317	<desc>
5318	Property type to set.
5319	</desc>
5320	</param>
5321	<param name="value" type="boolean" dir="in">
5322	<desc>
5323	New property value.
5324	</desc>
5325	</param>
5326	</method>
5327
5328	<method name="saveSettings">
5329	<desc>
5330	Saves any changes to machine settings made since the session
5331	has been opened or a new machine has been created, or since the
5332	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5333	For registered machines, new settings become visible to all
5334	other VirtualBox clients after successful invocation of this
5335	method.
5336	<note>
5337	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5338	notification event after the configuration has been successfully
5339	saved (only for registered machines).
5340	</note>
5341	<note>
5342	Calling this method is only valid on instances returned
5343	by <link to="ISession::machine"/> and on new machines
5344	created by <link to="IVirtualBox::createMachine"/> but not
5345	yet registered, or on unregistered machines after calling
5346	<link to="IVirtualBox::unregisterMachine"/>.
5347	</note>
5348
5349	<result name="VBOX_E_FILE_ERROR">
5350	Settings file not accessible.
5351	</result>
5352	<result name="VBOX_E_XML_ERROR">
5353	Could not parse the settings file.
5354	</result>
5355	<result name="E_ACCESSDENIED">
5356	Modification request refused.
5357	</result>
5358
5359	</desc>
5360	</method>
5361
5362	<method name="discardSettings">
5363	<desc>
5364	Discards any changes to the machine settings made since the session
5365	has been opened or since the last call to <link to="#saveSettings"/>
5366	or <link to="#discardSettings"/>.
5367	<note>
5368	Calling this method is only valid on instances returned
5369	by <link to="ISession::machine"/> and on new machines
5370	created by <link to="IVirtualBox::createMachine"/> or
5371	opened by <link to="IVirtualBox::openMachine"/> but not
5372	yet registered, or on unregistered machines after calling
5373	<link to="IVirtualBox::unregisterMachine"/>.
5374	</note>
5375
5376	<result name="VBOX_E_INVALID_VM_STATE">
5377	Virtual machine is not mutable.
5378	</result>
5379
5380	</desc>
5381	</method>
5382
5383	<method name="deleteSettings">
5384	<desc>
5385	Deletes the settings file of this machine from disk.
5386	The machine must not be registered in order for this operation
5387	to succeed.
5388	<note>
5389	<link to="#settingsModified"/> will return @c true after this
5390	method successfully returns.
5391	</note>
5392	<note>
5393	Calling this method is only valid on instances returned
5394	by <link to="ISession::machine"/> and on new machines
5395	created by <link to="IVirtualBox::createMachine"/> or
5396	opened by <link to="IVirtualBox::openMachine"/> but not
5397	yet registered, or on unregistered machines after calling
5398	<link to="IVirtualBox::unregisterMachine"/>.
5399	</note>
5400	<note>
5401	The deleted machine settings file can be restored (saved again)
5402	by calling <link to="#saveSettings"/>.
5403	</note>
5404
5405	<result name="VBOX_E_INVALID_VM_STATE">
5406	Cannot delete settings of a registered machine or
5407	machine not mutable.
5408	</result>
5409	<result name="VBOX_E_IPRT_ERROR">
5410	Could not delete the settings file.
5411	</result>
5412
5413	</desc>
5414	</method>
5415
5416	<method name="export">
5417	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5418	steps required to export VirtualBox machines to OVF.
5419	</desc>
5420
5421	<param name="aAppliance" type="IAppliance" dir="in">
5422	<desc>Appliance to export this machine to.</desc>
5423	</param>
5424	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5425	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5426	</param>
5427	</method >
5428
5429	<method name="getSnapshot">
5430	<desc>
5431	Returns a snapshot of this machine with the given UUID.
5432	A @c null UUID can be used to obtain the first snapshot
5433	taken on this machine. This is useful if you want to traverse
5434	the whole tree of snapshots starting from the root.
5435
5436	<result name="VBOX_E_OBJECT_NOT_FOUND">
5437	Virtual machine has no snapshots or snapshot not found.
5438	</result>
5439
5440	</desc>
5441	<param name="id" type="uuid" mod="string" dir="in">
5442	<desc>UUID of the snapshot to get</desc>
5443	</param>
5444	<param name="snapshot" type="ISnapshot" dir="return">
5445	<desc>Snapshot object with the given UUID.</desc>
5446	</param>
5447	</method>
5448
5449	<method name="findSnapshot">
5450	<desc>
5451	Returns a snapshot of this machine with the given name.
5452
5453	<result name="VBOX_E_OBJECT_NOT_FOUND">
5454	Virtual machine has no snapshots or snapshot not found.
5455	</result>
5456
5457	</desc>
5458	<param name="name" type="wstring" dir="in">
5459	<desc>Name of the snapshot to find</desc>
5460	</param>
5461	<param name="snapshot" type="ISnapshot" dir="return">
5462	<desc>Snapshot object with the given name.</desc>
5463	</param>
5464	</method>
5465
5466	<method name="setCurrentSnapshot">
5467	<desc>
5468	Sets the current snapshot of this machine.
5469	<note>
5470	In the current implementation, this operation is not
5471	implemented.
5472	</note>
5473	</desc>
5474	<param name="id" type="uuid" mod="string" dir="in">
5475	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5476	</param>
5477	</method>
5478
5479	<method name="createSharedFolder">
5480	<desc>
5481	Creates a new permanent shared folder by associating the given logical
5482	name with the given host path, adds it to the collection of shared
5483	folders and starts sharing it. Refer to the description of
5484	<link to="ISharedFolder"/> to read more about logical names.
5485
5486	<result name="VBOX_E_OBJECT_IN_USE">
5487	Shared folder already exists.
5488	</result>
5489	<result name="VBOX_E_FILE_ERROR">
5490	Shared folder @a hostPath not accessible.
5491	</result>
5492
5493	</desc>
5494	<param name="name" type="wstring" dir="in">
5495	<desc>Unique logical name of the shared folder.</desc>
5496	</param>
5497	<param name="hostPath" type="wstring" dir="in">
5498	<desc>Full path to the shared folder in the host file system.</desc>
5499	</param>
5500	<param name="writable" type="boolean" dir="in">
5501	<desc>Whether the share is writable or readonly</desc>
5502	</param>
5503	</method>
5504
5505	<method name="removeSharedFolder">
5506	<desc>
5507	Removes the permanent shared folder with the given name previously
5508	created by <link to="#createSharedFolder"/> from the collection of
5509	shared folders and stops sharing it.
5510
5511	<result name="VBOX_E_INVALID_VM_STATE">
5512	Virtual machine is not mutable.
5513	</result>
5514	<result name="VBOX_E_OBJECT_NOT_FOUND">
5515	Shared folder @a name does not exist.
5516	</result>
5517
5518	</desc>
5519	<param name="name" type="wstring" dir="in">
5520	<desc>Logical name of the shared folder to remove.</desc>
5521	</param>
5522	</method>
5523
5524	<method name="canShowConsoleWindow">
5525	<desc>
5526	Returns @c true if the VM console process can activate the
5527	console window and bring it to foreground on the desktop of
5528	the host PC.
5529	<note>
5530	This method will fail if a session for this machine is not
5531	currently open.
5532	</note>
5533
5534	<result name="VBOX_E_INVALID_VM_STATE">
5535	Machine session is not open.
5536	</result>
5537
5538	</desc>
5539	<param name="canShow" type="boolean" dir="return">
5540	<desc>
5541	@c true if the console window can be shown and @c false otherwise.
5542	</desc>
5543	</param>
5544	</method>
5545
5546	<method name="showConsoleWindow">
5547	<desc>
5548	Activates the console window and brings it to foreground on
5549	the desktop of the host PC. Many modern window managers on
5550	many platforms implement some sort of focus stealing
5551	prevention logic, so that it may be impossible to activate
5552	a window without the help of the currently active
5553	application. In this case, this method will return a non-zero
5554	identifier that represents the top-level window of the VM
5555	console process. The caller, if it represents a currently
5556	active process, is responsible to use this identifier (in a
5557	platform-dependent manner) to perform actual window
5558	activation.
5559	<note>
5560	This method will fail if a session for this machine is not
5561	currently open.
5562	</note>
5563
5564	<result name="VBOX_E_INVALID_VM_STATE">
5565	Machine session is not open.
5566	</result>
5567
5568	</desc>
5569	<param name="winId" type="unsigned long long" dir="return">
5570	<desc>
5571	Platform-dependent identifier of the top-level VM console
5572	window, or zero if this method has performed all actions
5573	necessary to implement the <i>show window</i> semantics for
5574	the given platform and/or VirtualBox front-end.
5575	</desc>
5576	</param>
5577	</method>
5578
5579	<method name="getGuestProperty">
5580	<desc>
5581	Reads an entry from the machine's guest property store.
5582
5583	<result name="VBOX_E_INVALID_VM_STATE">
5584	Machine session is not open.
5585	</result>
5586
5587	</desc>
5588	<param name="name" type="wstring" dir="in">
5589	<desc>
5590	The name of the property to read.
5591	</desc>
5592	</param>
5593	<param name="value" type="wstring" dir="out">
5594	<desc>
5595	The value of the property. If the property does not exist then this
5596	will be empty.
5597	</desc>
5598	</param>
5599	<param name="timestamp" type="unsigned long long" dir="out">
5600	<desc>
5601	The time at which the property was last modified, as seen by the
5602	server process.
5603	</desc>
5604	</param>
5605	<param name="flags" type="wstring" dir="out">
5606	<desc>
5607	Additional property parameters, passed as a comma-separated list of
5608	"name=value" type entries.
5609	</desc>
5610	</param>
5611	</method>
5612
5613	<method name="getGuestPropertyValue">
5614	<desc>
5615	Reads a value from the machine's guest property store.
5616
5617	<result name="VBOX_E_INVALID_VM_STATE">
5618	Machine session is not open.
5619	</result>
5620
5621	</desc>
5622	<param name="property" type="wstring" dir="in">
5623	<desc>
5624	The name of the property to read.
5625	</desc>
5626	</param>
5627	<param name="value" type="wstring" dir="return">
5628	<desc>
5629	The value of the property. If the property does not exist then this
5630	will be empty.
5631	</desc>
5632	</param>
5633	</method>
5634
5635	<method name="getGuestPropertyTimestamp">
5636	<desc>
5637	Reads a property timestamp from the machine's guest property store.
5638
5639	<result name="VBOX_E_INVALID_VM_STATE">
5640	Machine session is not open.
5641	</result>
5642
5643	</desc>
5644	<param name="property" type="wstring" dir="in">
5645	<desc>
5646	The name of the property to read.
5647	</desc>
5648	</param>
5649	<param name="value" type="unsigned long long" dir="return">
5650	<desc>
5651	The timestamp. If the property does not exist then this will be
5652	empty.
5653	</desc>
5654	</param>
5655	</method>
5656
5657	<method name="setGuestProperty">
5658	<desc>
5659	Sets, changes or deletes an entry in the machine's guest property
5660	store.
5661
5662	<result name="E_ACCESSDENIED">
5663	Property cannot be changed.
5664	</result>
5665	<result name="E_INVALIDARG">
5666	Invalid @a flags.
5667	</result>
5668	<result name="VBOX_E_INVALID_VM_STATE">
5669	Virtual machine is not mutable or session not open.
5670	</result>
5671	<result name="VBOX_E_INVALID_OBJECT_STATE">
5672	Cannot set transient property when machine not running.
5673	</result>
5674
5675	</desc>
5676	<param name="property" type="wstring" dir="in">
5677	<desc>
5678	The name of the property to set, change or delete.
5679	</desc>
5680	</param>
5681	<param name="value" type="wstring" dir="in">
5682	<desc>
5683	The new value of the property to set, change or delete. If the
5684	property does not yet exist and value is non-empty, it will be
5685	created. If the value is @c null or empty, the property will be
5686	deleted if it exists.
5687	</desc>
5688	</param>
5689	<param name="flags" type="wstring" dir="in">
5690	<desc>
5691	Additional property parameters, passed as a comma-separated list of
5692	"name=value" type entries.
5693	</desc>
5694	</param>
5695	</method>
5696
5697	<method name="setGuestPropertyValue">
5698	<desc>
5699	Sets, changes or deletes a value in the machine's guest property
5700	store. The flags field will be left unchanged or created empty for a
5701	new property.
5702
5703	<result name="E_ACCESSDENIED">
5704	Property cannot be changed.
5705	</result>
5706	<result name="VBOX_E_INVALID_VM_STATE">
5707	Virtual machine is not mutable or session not open.
5708	</result>
5709	<result name="VBOX_E_INVALID_OBJECT_STATE">
5710	Cannot set transient property when machine not running.
5711	</result>
5712	</desc>
5713
5714	<param name="property" type="wstring" dir="in">
5715	<desc>
5716	The name of the property to set, change or delete.
5717	</desc>
5718	</param>
5719	<param name="value" type="wstring" dir="in">
5720	<desc>
5721	The new value of the property to set, change or delete. If the
5722	property does not yet exist and value is non-empty, it will be
5723	created. If the value is @c null or empty, the property will be
5724	deleted if it exists.
5725	</desc>
5726	</param>
5727	</method>
5728
5729	<method name="enumerateGuestProperties">
5730	<desc>
5731	Return a list of the guest properties matching a set of patterns along
5732	with their values, time stamps and flags.
5733	</desc>
5734	<param name="patterns" type="wstring" dir="in">
5735	<desc>
5736	The patterns to match the properties against, separated by '\|'
5737	characters. If this is empty or @c null, all properties will match.
5738	</desc>
5739	</param>
5740	<param name="name" type="wstring" dir="out" safearray="yes">
5741	<desc>
5742	The names of the properties returned.
5743	</desc>
5744	</param>
5745	<param name="value" type="wstring" dir="out" safearray="yes">
5746	<desc>
5747	The values of the properties returned. The array entries match the
5748	corresponding entries in the @a name array.
5749	</desc>
5750	</param>
5751	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5752	<desc>
5753	The time stamps of the properties returned. The array entries match
5754	the corresponding entries in the @a name array.
5755	</desc>
5756	</param>
5757	<param name="flags" type="wstring" dir="out" safearray="yes">
5758	<desc>
5759	The flags of the properties returned. The array entries match the
5760	corresponding entries in the @a name array.
5761	</desc>
5762	</param>
5763	</method>
5764	</interface>
5765
5766	<!--
5767	// IConsole
5768	/////////////////////////////////////////////////////////////////////////
5769	-->
5770
5771	<interface
5772	name="IConsoleCallback" extends="$unknown"
5773	uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
5774	wsmap="suppress"
5775	>
5776
5777	<desc>
5778	This interface is used by a client of the Main API that need to
5779	be notified of events. For example, a graphical user interface
5780	can use this to learn about machine state changes so they can
5781	update the list of virtual machines without having to rely
5782	on polling.
5783
5784	Whenever relevant events occur in VirtualBox, the callbacks in
5785	objects of this interface are called. In order for this to be
5786	useful, a client needs to create its own subclass that implements
5787	this interface in which the methods for the relevant callbacks
5788	are overridden. An instance of this subclass interface can then
5789	be passed to <link to="IConsole::registerCallback" />.
5790	</desc>
5791
5792	<method name="onMousePointerShapeChange">
5793	<desc>
5794	Notification when the guest mouse pointer shape has
5795	changed. The new shape data is given.
5796	</desc>
5797	<param name="visible" type="boolean" dir="in">
5798	<desc>
5799	Flag whether the pointer is visible.
5800	</desc>
5801	</param>
5802	<param name="alpha" type="boolean" dir="in">
5803	<desc>
5804	Flag whether the pointer has an alpha channel.
5805	</desc>
5806	</param>
5807	<param name="xHot" type="unsigned long" dir="in">
5808	<desc>
5809	The pointer hot spot x coordinate.
5810	</desc>
5811	</param>
5812	<param name="yHot" type="unsigned long" dir="in">
5813	<desc>
5814	The pointer hot spot y coordinate.
5815	</desc>
5816	</param>
5817	<param name="width" type="unsigned long" dir="in">
5818	<desc>
5819	Width of the pointer shape in pixels.
5820	</desc>
5821	</param>
5822	<param name="height" type="unsigned long" dir="in">
5823	<desc>
5824	Height of the pointer shape in pixels.
5825	</desc>
5826	</param>
5827	<param name="shape" type="octet" mod="ptr" dir="in">
5828	<desc>
5829	Address of the shape buffer.
5830
5831	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
5832	followed by a 32-bpp XOR (color) mask.
5833
5834	For pointers without alpha channel the XOR mask pixels are 32
5835	bit values: (lsb)BGR0(msb). For pointers with alpha channel
5836	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
5837
5838	An AND mask is used for pointers with alpha channel, so if the
5839	callback does not support alpha, the pointer could be
5840	displayed as a normal color pointer.
5841
5842	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
5843	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
5844	height</tt>. The padding bits at the end of each scanline are
5845	undefined.
5846
5847	The XOR mask follows the AND mask on the next 4-byte aligned
5848	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
5849	Bytes in the gap between the AND and the XOR mask are undefined.
5850	The XOR mask scanlines have no gap between them and the size of
5851	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
5852
5853	<note>
5854	If @a shape is 0, only the pointer visibility is changed.
5855	</note>
5856	</desc>
5857	</param>
5858	</method>
5859
5860	<method name="onMouseCapabilityChange">
5861	<desc>
5862	Notification when the mouse capabilities reported by the
5863	guest have changed. The new capabilities are passed.
5864	</desc>
5865	<param name="supportsAbsolute" type="boolean" dir="in"/>
5866	<param name="needsHostCursor" type="boolean" dir="in"/>
5867	</method>
5868
5869	<method name="onKeyboardLedsChange">
5870	<desc>
5871	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
5872	to alter the state of the keyboard LEDs.
5873	</desc>
5874	<param name="numLock" type="boolean" dir="in"/>
5875	<param name="capsLock" type="boolean" dir="in"/>
5876	<param name="scrollLock" type="boolean" dir="in"/>
5877	</method>
5878
5879	<method name="onStateChange">
5880	<desc>
5881	Notification when the execution state of the machine has changed.
5882	The new state will be given.
5883	</desc>
5884	<param name="state" type="MachineState" dir="in"/>
5885	</method>
5886
5887	<method name="onAdditionsStateChange">
5888	<desc>
5889	Notification when a Guest Additions property changes.
5890	Interested callees should query IGuest attributes to
5891	find out what has changed.
5892	</desc>
5893	</method>
5894
5895	<method name="onNetworkAdapterChange">
5896	<desc>
5897	Notification when a property of one of the
5898	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
5899	changes. Interested callees should use INetworkAdapter methods and
5900	attributes to find out what has changed.
5901	</desc>
5902	<param name="networkAdapter" type="INetworkAdapter" dir="in">
5903	<desc>Network adapter that is subject to change.</desc>
5904	</param>
5905	</method>
5906
5907	<method name="onSerialPortChange">
5908	<desc>
5909	Notification when a property of one of the
5910	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
5911	Interested callees should use ISerialPort methods and attributes
5912	to find out what has changed.
5913	</desc>
5914	<param name="serialPort" type="ISerialPort" dir="in">
5915	<desc>Serial port that is subject to change.</desc>
5916	</param>
5917	</method>
5918
5919	<method name="onParallelPortChange">
5920	<desc>
5921	Notification when a property of one of the
5922	virtual <link to="IMachine::getParallelPort">parallel ports</link>
5923	changes. Interested callees should use ISerialPort methods and
5924	attributes to find out what has changed.
5925	</desc>
5926	<param name="parallelPort" type="IParallelPort" dir="in">
5927	<desc>Parallel port that is subject to change.</desc>
5928	</param>
5929	</method>
5930
5931	<method name="onStorageControllerChange">
5932	<desc>
5933	Notification when a property of one of the
5934	virtual <link to="IMachine::storageControllers">storage controllers</link>
5935	changes. Interested callees should query the corresponding collections
5936	to find out what has changed.
5937	</desc>
5938	</method>
5939
5940	<method name="onMediumChange">
5941	<desc>
5942	Notification when a
5943	<link to="IMachine::mediumAttachments">medium attachment</link>
5944	changes.
5945	</desc>
5946	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
5947	<desc>Medium attachment that is subject to change.</desc>
5948	</param>
5949	</method>
5950
5951	<method name="onVRDPServerChange">
5952	<desc>
5953	Notification when a property of the
5954	<link to="IMachine::VRDPServer">VRDP server</link> changes.
5955	Interested callees should use IVRDPServer methods and attributes to
5956	find out what has changed.
5957	</desc>
5958	</method>
5959
5960	<method name="onRemoteDisplayInfoChange">
5961	<desc>
5962	Notification when the status of the VRDP server changes. Interested callees
5963	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
5964	attributes to find out what is the current status.
5965	</desc>
5966	</method>
5967
5968	<method name="onUSBControllerChange">
5969	<desc>
5970	Notification when a property of the virtual
5971	<link to="IMachine::USBController">USB controller</link> changes.
5972	Interested callees should use IUSBController methods and attributes to
5973	find out what has changed.
5974	</desc>
5975	</method>
5976
5977	<method name="onUSBDeviceStateChange">
5978	<desc>
5979	Notification when a USB device is attached to or detached from
5980	the virtual USB controller.
5981
5982	This notification is sent as a result of the indirect
5983	request to attach the device because it matches one of the
5984	machine USB filters, or as a result of the direct request
5985	issued by <link to="IConsole::attachUSBDevice"/> or
5986	<link to="IConsole::detachUSBDevice"/>.
5987
5988	This notification is sent in case of both a succeeded and a
5989	failed request completion. When the request succeeds, the
5990	@a error parameter is @c null, and the given device has been
5991	already added to (when @a attached is @c true) or removed from
5992	(when @a attached is @c false) the collection represented by
5993	<link to="IConsole::USBDevices"/>. On failure, the collection
5994	doesn't change and the @a error parameter represents the error
5995	message describing the failure.
5996
5997	</desc>
5998	<param name="device" type="IUSBDevice" dir="in">
5999	<desc>Device that is subject to state change.</desc>
6000	</param>
6001	<param name="attached" type="boolean" dir="in">
6002	<desc>
6003	@c true if the device was attached and @c false otherwise.
6004	</desc>
6005	</param>
6006	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6007	<desc>
6008	@c null on success or an error message object on failure.
6009	</desc>
6010	</param>
6011	</method>
6012
6013	<method name="onSharedFolderChange">
6014	<desc>
6015	Notification when a shared folder is added or removed.
6016	The @a scope argument defines one of three scopes:
6017	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6018	(<link to="Scope_Global">Global</link>),
6019	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6020	the machine (<link to="Scope_Machine">Machine</link>) or <link
6021	to="IConsole::sharedFolders">transient shared folders</link> of the
6022	machine (<link to="Scope_Session">Session</link>). Interested callees
6023	should use query the corresponding collections to find out what has
6024	changed.
6025	</desc>
6026	<param name="scope" type="Scope" dir="in">
6027	<desc>Scope of the notification.</desc>
6028	</param>
6029	</method>
6030
6031	<method name="onRuntimeError">
6032	<desc>
6033	Notification when an error happens during the virtual
6034	machine execution.
6035
6036	There are three kinds of runtime errors:
6037	<ul>
6038	<li><i>fatal</i></li>
6039	<li><i>non-fatal with retry</i></li>
6040	<li><i>non-fatal warnings</i></li>
6041	</ul>
6042
6043	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6044	to @c true. In case of fatal errors, the virtual machine
6045	execution is always paused before calling this notification, and
6046	the notification handler is supposed either to immediately save
6047	the virtual machine state using <link to="IConsole::saveState"/>
6048	or power it off using <link to="IConsole::powerDown"/>.
6049	Resuming the execution can lead to unpredictable results.
6050
6051	<b>Non-fatal</b> errors and warnings are indicated by the
6052	@a fatal parameter set to @c false. If the virtual machine
6053	is in the Paused state by the time the error notification is
6054	received, it means that the user can <i>try to resume</i> the machine
6055	execution after attempting to solve the problem that caused the
6056	error. In this case, the notification handler is supposed
6057	to show an appropriate message to the user (depending on the
6058	value of the @a id parameter) that offers several actions such
6059	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6060	wants to retry, the notification handler should continue
6061	the machine execution using the <link to="IConsole::resume"/>
6062	call. If the machine execution is not Paused during this
6063	notification, then it means this notification is a <i>warning</i>
6064	(for example, about a fatal condition that can happen very soon);
6065	no immediate action is required from the user, the machine
6066	continues its normal execution.
6067
6068	Note that in either case the notification handler
6069	<b>must not</b> perform any action directly on a thread
6070	where this notification is called. Everything it is allowed to
6071	do is to post a message to another thread that will then talk
6072	to the user and take the corresponding action.
6073
6074	Currently, the following error identifiers are known:
6075	<ul>
6076	<li><tt>"HostMemoryLow"</tt></li>
6077	<li><tt>"HostAudioNotResponding"</tt></li>
6078	<li><tt>"VDIStorageFull"</tt></li>
6079	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6080	</ul>
6081
6082	<note>
6083	This notification is not designed to be implemented by
6084	more than one callback at a time. If you have multiple
6085	IConsoleCallback instances registered on the given
6086	IConsole object, make sure you simply do nothing but
6087	return @c S_OK from all but one of them that does actual
6088	user notification and performs necessary actions.
6089	</note>
6090
6091	</desc>
6092	<param name="fatal" type="boolean" dir="in">
6093	<desc>Whether the error is fatal or not</desc>
6094	</param>
6095	<param name="id" type="wstring" dir="in">
6096	<desc>Error identifier</desc>
6097	</param>
6098	<param name="message" type="wstring" dir="in">
6099	<desc>Optional error message</desc>
6100	</param>
6101	</method>
6102
6103	<method name="onCanShowWindow">
6104	<desc>
6105	Notification when a call to
6106	<link to="IMachine::canShowConsoleWindow"/> is made by a
6107	front-end to check if a subsequent call to
6108	<link to="IMachine::showConsoleWindow"/> can succeed.
6109
6110	The callee should give an answer appropriate to the current
6111	machine state in the @a canShow argument. This answer must
6112	remain valid at least until the next
6113	<link to="IConsole::state">machine state</link> change.
6114
6115	<note>
6116	This notification is not designed to be implemented by
6117	more than one callback at a time. If you have multiple
6118	IConsoleCallback instances registered on the given
6119	IConsole object, make sure you simply do nothing but
6120	return @c true and @c S_OK from all but one of them that
6121	actually manages console window activation.
6122	</note>
6123	</desc>
6124	<param name="canShow" type="boolean" dir="return">
6125	<desc>
6126	@c true if the console window can be shown and @c false otherwise.
6127	</desc>
6128	</param>
6129	</method>
6130
6131	<method name="onShowWindow">
6132	<desc>
6133	Notification when a call to
6134	<link to="IMachine::showConsoleWindow"/>
6135	requests the console window to be activated and brought to
6136	foreground on the desktop of the host PC.
6137
6138	This notification should cause the VM console process to
6139	perform the requested action as described above. If it is
6140	impossible to do it at a time of this notification, this
6141	method should return a failure.
6142
6143	Note that many modern window managers on many platforms
6144	implement some sort of focus stealing prevention logic, so
6145	that it may be impossible to activate a window without the
6146	help of the currently active application (which is supposedly
6147	an initiator of this notification). In this case, this method
6148	must return a non-zero identifier that represents the
6149	top-level window of the VM console process. The caller, if it
6150	represents a currently active process, is responsible to use
6151	this identifier (in a platform-dependent manner) to perform
6152	actual window activation.
6153
6154	This method must set @a winId to zero if it has performed all
6155	actions necessary to complete the request and the console
6156	window is now active and in foreground, to indicate that no
6157	further action is required on the caller's side.
6158
6159	<note>
6160	This notification is not designed to be implemented by
6161	more than one callback at a time. If you have multiple
6162	IConsoleCallback instances registered on the given
6163	IConsole object, make sure you simply do nothing but
6164	return @c S_OK from all but one of them that actually
6165	manages console window activation.
6166	</note>
6167	</desc>
6168	<param name="winId" type="unsigned long long" dir="return">
6169	<desc>
6170	Platform-dependent identifier of the top-level VM console
6171	window, or zero if this method has performed all actions
6172	necessary to implement the <i>show window</i> semantics for
6173	the given platform and/or this VirtualBox front-end.
6174	</desc>
6175	</param>
6176	</method>
6177
6178	</interface>
6179
6180	<interface
6181	name="IRemoteDisplayInfo" extends="$unknown"
6182	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6183	wsmap="struct"
6184	>
6185	<desc>
6186	Contains information about the remote display (VRDP) capabilities and status.
6187	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6188	</desc>
6189
6190	<attribute name="active" type="boolean" readonly="yes">
6191	<desc>
6192	Whether the remote display connection is active.
6193	</desc>
6194	</attribute>
6195
6196	<attribute name="port" type="long" readonly="yes">
6197	<desc>
6198	VRDP server port number. If this property is equal to <tt>0</tt>, then
6199	the VRDP server failed to start, usually because there are no free TCP
6200	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6201	server has not yet been started.
6202	</desc>
6203	</attribute>
6204
6205	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6206	<desc>
6207	How many times a client connected.
6208	</desc>
6209	</attribute>
6210
6211	<attribute name="beginTime" type="long long" readonly="yes">
6212	<desc>
6213	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6214	</desc>
6215	</attribute>
6216
6217	<attribute name="endTime" type="long long" readonly="yes">
6218	<desc>
6219	When the last connection was terminated or the current time, if
6220	connection is still active, in milliseconds since 1970-01-01 UTC.
6221	</desc>
6222	</attribute>
6223
6224	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6225	<desc>
6226	How many bytes were sent in last or current, if still active, connection.
6227	</desc>
6228	</attribute>
6229
6230	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6231	<desc>
6232	How many bytes were sent in all connections.
6233	</desc>
6234	</attribute>
6235
6236	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6237	<desc>
6238	How many bytes were received in last or current, if still active, connection.
6239	</desc>
6240	</attribute>
6241
6242	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6243	<desc>
6244	How many bytes were received in all connections.
6245	</desc>
6246	</attribute>
6247
6248	<attribute name="user" type="wstring" readonly="yes">
6249	<desc>
6250	Login user name supplied by the client.
6251	</desc>
6252	</attribute>
6253
6254	<attribute name="domain" type="wstring" readonly="yes">
6255	<desc>
6256	Login domain name supplied by the client.
6257	</desc>
6258	</attribute>
6259
6260	<attribute name="clientName" type="wstring" readonly="yes">
6261	<desc>
6262	The client name supplied by the client.
6263	</desc>
6264	</attribute>
6265
6266	<attribute name="clientIP" type="wstring" readonly="yes">
6267	<desc>
6268	The IP address of the client.
6269	</desc>
6270	</attribute>
6271
6272	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6273	<desc>
6274	The client software version number.
6275	</desc>
6276	</attribute>
6277
6278	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6279	<desc>
6280	Public key exchange method used when connection was established.
6281	Values: 0 - RDP4 public key exchange scheme.
6282	1 - X509 certificates were sent to client.
6283	</desc>
6284	</attribute>
6285
6286	</interface>
6287
6288	<interface
6289	name="IConsole" extends="$unknown"
6290	uuid="55dd56a5-1d1d-4d81-b742-b082b9571be6"
6291	wsmap="managed"
6292	>
6293	<desc>
6294	The IConsole interface represents an interface to control virtual
6295	machine execution.
6296
6297	The console object that implements the IConsole interface is obtained
6298	from a session object after the session for the given machine has been
6299	opened using one of <link to="IVirtualBox::openSession"/>,
6300	<link to="IVirtualBox::openRemoteSession"/> or
6301	<link to="IVirtualBox::openExistingSession"/> methods.
6302
6303	Methods of the IConsole interface allow the caller to query the current
6304	virtual machine execution state, pause the machine or power it down, save
6305	the machine state or take a snapshot, attach and detach removable media
6306	and so on.
6307
6308	<see>ISession</see>
6309	</desc>
6310
6311	<attribute name="machine" type="IMachine" readonly="yes">
6312	<desc>
6313	Machine object this console is sessioned with.
6314	<note>
6315	This is a convenience property, it has the same value as
6316	<link to="ISession::machine"/> of the corresponding session
6317	object.
6318	</note>
6319	</desc>
6320	</attribute>
6321
6322	<attribute name="state" type="MachineState" readonly="yes">
6323	<desc>
6324	Current execution state of the machine.
6325	<note>
6326	This property always returns the same value as the corresponding
6327	property of the IMachine object this console is sessioned with.
6328	For the process that owns (executes) the VM, this is the
6329	preferable way of querying the VM state, because no IPC
6330	calls are made.
6331	</note>
6332	</desc>
6333	</attribute>
6334
6335	<attribute name="guest" type="IGuest" readonly="yes">
6336	<desc>Guest object.</desc>
6337	</attribute>
6338
6339	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6340	<desc>
6341	Virtual keyboard object.
6342	<note>
6343	If the machine is not running, any attempt to use
6344	the returned object will result in an error.
6345	</note>
6346	</desc>
6347	</attribute>
6348
6349	<attribute name="mouse" type="IMouse" readonly="yes">
6350	<desc>
6351	Virtual mouse object.
6352	<note>
6353	If the machine is not running, any attempt to use
6354	the returned object will result in an error.
6355	</note>
6356	</desc>
6357	</attribute>
6358
6359	<attribute name="display" type="IDisplay" readonly="yes">
6360	<desc>Virtual display object.
6361	<note>
6362	If the machine is not running, any attempt to use
6363	the returned object will result in an error.
6364	</note>
6365	</desc>
6366	</attribute>
6367
6368	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6369	<desc>Debugging interface.</desc>
6370	</attribute>
6371
6372	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6373	<desc>
6374	Collection of USB devices currently attached to the virtual
6375	USB controller.
6376	<note>
6377	The collection is empty if the machine is not running.
6378	</note>
6379	</desc>
6380	</attribute>
6381
6382	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6383	<desc>
6384	List of USB devices currently attached to the remote VRDP client.
6385	Once a new device is physically attached to the remote host computer,
6386	it appears in this list and remains there until detached.
6387	</desc>
6388	</attribute>
6389
6390	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6391	<desc>
6392	Collection of shared folders for the current session. These folders
6393	are called transient shared folders because they are available to the
6394	guest OS running inside the associated virtual machine only for the
6395	duration of the session (as opposed to
6396	<link to="IMachine::sharedFolders"/> which represent permanent shared
6397	folders). When the session is closed (e.g. the machine is powered down),
6398	these folders are automatically discarded.
6399
6400	New shared folders are added to the collection using
6401	<link to="#createSharedFolder"/>. Existing shared folders can be
6402	removed using <link to="#removeSharedFolder"/>.
6403	</desc>
6404	</attribute>
6405
6406	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6407	<desc>
6408	Interface that provides information on Remote Display (VRDP) connection.
6409	</desc>
6410	</attribute>
6411
6412	<method name="powerUp">
6413	<desc>
6414	Starts the virtual machine execution using the current machine
6415	state (that is, its current execution state, current settings and
6416	current storage devices).
6417
6418	If the machine is powered off or aborted, the execution will
6419	start from the beginning (as if the real hardware were just
6420	powered on).
6421
6422	If the machine is in the <link to="MachineState_Saved"/> state,
6423	it will continue its execution the point where the state has
6424	been saved.
6425
6426	<note>
6427	Unless you are trying to write a new VirtualBox front-end that
6428	performs direct machine execution (like the VirtualBox or VBoxSDL
6429	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6430	session opened by <link to="IVirtualBox::openSession"/> and use this
6431	session only to change virtual machine settings. If you simply want to
6432	start virtual machine execution using one of the existing front-ends
6433	(for example the VirtualBox GUI or headless server), simply use
6434	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6435	power up the machine automatically for you.
6436	</note>
6437
6438	<see>#saveState</see>
6439	<result name="VBOX_E_INVALID_VM_STATE">
6440	Virtual machine already running.
6441	</result>
6442	<result name="VBOX_E_HOST_ERROR">
6443	Host interface does not exist or name not set.
6444	</result>
6445	<result name="VBOX_E_FILE_ERROR">
6446	Invalid saved state file.
6447	</result>
6448	</desc>
6449	<param name="progress" type="IProgress" dir="return">
6450	<desc>Progress object to track the operation completion.</desc>
6451	</param>
6452	</method>
6453
6454	<method name="powerUpPaused">
6455	<desc>
6456	Identical to powerUp except that the VM will enter the
6457	<link to="MachineState_Paused"/> state, instead of
6458	<link to="MachineState_Running"/>.
6459
6460	<see>#powerUp</see>
6461	<result name="VBOX_E_INVALID_VM_STATE">
6462	Virtual machine already running.
6463	</result>
6464	<result name="VBOX_E_HOST_ERROR">
6465	Host interface does not exist or name not set.
6466	</result>
6467	<result name="VBOX_E_FILE_ERROR">
6468	Invalid saved state file.
6469	</result>
6470	</desc>
6471	<param name="progress" type="IProgress" dir="return">
6472	<desc>Progress object to track the operation completion.</desc>
6473	</param>
6474	</method>
6475
6476	<method name="powerDown">
6477	<desc>
6478	Initiates the power down procedure to stop the virtual machine
6479	execution.
6480
6481	The completion of the power down procedure is tracked using the returned
6482	IProgress object. After the operation is complete, the machine will go
6483	to the PoweredOff state.
6484	<result name="VBOX_E_INVALID_VM_STATE">
6485	Virtual machine must be Running, Paused or Stuck to be powered down.
6486	</result>
6487	</desc>
6488	<param name="progress" type="IProgress" dir="return">
6489	<desc>Progress object to track the operation completion.</desc>
6490	</param>
6491	</method>
6492
6493	<method name="reset">
6494	<desc>Resets the virtual machine.
6495	<result name="VBOX_E_INVALID_VM_STATE">
6496	Virtual machine not in Running state.
6497	</result>
6498	<result name="VBOX_E_VM_ERROR">
6499	Virtual machine error in reset operation.
6500	</result>
6501	</desc>
6502	</method>
6503
6504	<method name="pause">
6505	<desc>Pauses the virtual machine execution.
6506	<result name="VBOX_E_INVALID_VM_STATE">
6507	Virtual machine not in Running state.
6508	</result>
6509	<result name="VBOX_E_VM_ERROR">
6510	Virtual machine error in suspend operation.
6511	</result>
6512	</desc>
6513	</method>
6514
6515	<method name="resume">
6516	<desc>Resumes the virtual machine execution.
6517	<result name="VBOX_E_INVALID_VM_STATE">
6518	Virtual machine not in Paused state.
6519	</result>
6520	<result name="VBOX_E_VM_ERROR">
6521	Virtual machine error in resume operation.
6522	</result>
6523	</desc>
6524	</method>
6525
6526	<method name="powerButton">
6527	<desc>Sends the ACPI power button event to the guest.
6528	<result name="VBOX_E_INVALID_VM_STATE">
6529	Virtual machine not in Running state.
6530	</result>
6531	<result name="VBOX_E_PDM_ERROR">
6532	Controlled power off failed.
6533	</result>
6534	</desc>
6535	</method>
6536
6537	<method name="sleepButton">
6538	<desc>Sends the ACPI sleep button event to the guest.
6539	<result name="VBOX_E_INVALID_VM_STATE">
6540	Virtual machine not in Running state.
6541	</result>
6542	<result name="VBOX_E_PDM_ERROR">
6543	Sending sleep button event failed.
6544	</result>
6545	</desc>
6546	</method>
6547
6548	<method name="getPowerButtonHandled">
6549	<desc>Checks if the last power button event was handled by guest.
6550	<result name="VBOX_E_PDM_ERROR">
6551	Checking if the event was handled by the guest OS failed.
6552	</result>
6553	</desc>
6554	<param name="handled" type="boolean" dir="return"/>
6555	</method>
6556
6557	<method name="getGuestEnteredACPIMode">
6558	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6559	G1 (sleeping). If this method returns @c false, the guest will
6560	most likely not respond to external ACPI events.
6561	<result name="VBOX_E_INVALID_VM_STATE">
6562	Virtual machine not in Running state.
6563	</result>
6564	</desc>
6565	<param name="entered" type="boolean" dir="return"/>
6566	</method>
6567
6568	<method name="saveState">
6569	<desc>
6570	Saves the current execution state of a running virtual machine
6571	and stops its execution.
6572
6573	After this operation completes, the machine will go to the
6574	Saved state. Next time it is powered up, this state will
6575	be restored and the machine will continue its execution from
6576	the place where it was saved.
6577
6578	This operation differs from taking a snapshot to the effect
6579	that it doesn't create new differencing media. Also, once
6580	the machine is powered up from the state saved using this method,
6581	the saved state is deleted, so it will be impossible to return
6582	to this state later.
6583
6584	<note>
6585	On success, this method implicitly calls
6586	<link to="IMachine::saveSettings"/> to save all current machine
6587	settings (including runtime changes to the DVD medium, etc.).
6588	Together with the impossibility to change any VM settings when it is
6589	in the Saved state, this guarantees adequate hardware
6590	configuration of the machine when it is restored from the saved
6591	state file.
6592	</note>
6593
6594	<note>
6595	The machine must be in the Running or Paused state, otherwise
6596	the operation will fail.
6597	</note>
6598	<result name="VBOX_E_INVALID_VM_STATE">
6599	Virtual machine state neither Running nor Paused.
6600	</result>
6601	<result name="VBOX_E_FILE_ERROR">
6602	Failed to create directory for saved state file.
6603	</result>
6604
6605	<see><link to="#takeSnapshot"/></see>
6606	</desc>
6607	<param name="progress" type="IProgress" dir="return">
6608	<desc>Progress object to track the operation completion.</desc>
6609	</param>
6610	</method>
6611
6612	<method name="adoptSavedState">
6613	<desc>
6614	Associates the given saved state file to the virtual machine.
6615
6616	On success, the machine will go to the Saved state. Next time it is
6617	powered up, it will be restored from the adopted saved state and
6618	continue execution from the place where the saved state file was
6619	created.
6620
6621	The specified saved state file path may be absolute or relative to the
6622	folder the VM normally saves the state to (usually,
6623	<link to="IMachine::snapshotFolder"/>).
6624
6625	<note>
6626	It's a caller's responsibility to make sure the given saved state
6627	file is compatible with the settings of this virtual machine that
6628	represent its virtual hardware (memory size, storage disk configuration
6629	etc.). If there is a mismatch, the behavior of the virtual machine
6630	is undefined.
6631	</note>
6632	<result name="VBOX_E_INVALID_VM_STATE">
6633	Virtual machine state neither PoweredOff nor Aborted.
6634	</result>
6635	</desc>
6636	<param name="savedStateFile" type="wstring" dir="in">
6637	<desc>Path to the saved state file to adopt.</desc>
6638	</param>
6639	</method>
6640
6641	<method name="forgetSavedState">
6642	<desc>
6643	Forgets the saved state of the virtual machine previously created
6644	by <link to="#saveState"/>. Next time the machine is powered up, a
6645	clean boot will occur. If @a remove is @c true the saved state file
6646	is deleted.
6647	<note>
6648	This operation is equivalent to resetting or powering off
6649	the machine without doing a proper shutdown in the guest OS.
6650	</note>
6651	<result name="VBOX_E_INVALID_VM_STATE">
6652	Virtual machine not in state Saved.
6653	</result>
6654	</desc>
6655	<param name="remove" type="boolean" dir="in">
6656	<desc>If @c true remove the saved state file.</desc>
6657	</param>
6658	</method>
6659
6660	<method name="getDeviceActivity">
6661	<desc>
6662	Gets the current activity type of a given device or device group.
6663	<result name="E_INVALIDARG">
6664	Invalid device type.
6665	</result>
6666	</desc>
6667	<param name="type" type="DeviceType" dir="in"/>
6668	<param name="activity" type="DeviceActivity" dir="return"/>
6669	</method>
6670
6671	<method name="attachUSBDevice">
6672	<desc>
6673	Attaches a host USB device with the given UUID to the
6674	USB controller of the virtual machine.
6675
6676	The device needs to be in one of the following states:
6677	<link to="USBDeviceState_Busy"/>,
6678	<link to="USBDeviceState_Available"/> or
6679	<link to="USBDeviceState_Held"/>,
6680	otherwise an error is immediately returned.
6681
6682	When the device state is
6683	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6684	be returned if the host computer refuses to release it for some reason.
6685
6686	<see>IUSBController::deviceFilters, USBDeviceState</see>
6687	<result name="VBOX_E_INVALID_VM_STATE">
6688	Virtual machine state neither Running nor Paused.
6689	</result>
6690	<result name="VBOX_E_PDM_ERROR">
6691	Virtual machine does not have a USB controller.
6692	</result>
6693	</desc>
6694	<param name="id" type="uuid" mod="string" dir="in">
6695	<desc>UUID of the host USB device to attach.</desc>
6696	</param>
6697	</method>
6698
6699	<method name="detachUSBDevice">
6700	<desc>
6701	Detaches an USB device with the given UUID from the USB controller
6702	of the virtual machine.
6703
6704	After this method succeeds, the VirtualBox server re-initiates
6705	all USB filters as if the device were just physically attached
6706	to the host, but filters of this machine are ignored to avoid
6707	a possible automatic re-attachment.
6708
6709	<see>IUSBController::deviceFilters, USBDeviceState</see>
6710
6711	<result name="VBOX_E_PDM_ERROR">
6712	Virtual machine does not have a USB controller.
6713	</result>
6714	<result name="E_INVALIDARG">
6715	USB device not attached to this virtual machine.
6716	</result>
6717	</desc>
6718	<param name="id" type="uuid" mod="string" dir="in">
6719	<desc>UUID of the USB device to detach.</desc>
6720	</param>
6721	<param name="device" type="IUSBDevice" dir="return">
6722	<desc>Detached USB device.</desc>
6723	</param>
6724	</method>
6725
6726	<method name="findUSBDeviceByAddress">
6727	<desc>
6728	Searches for a USB device with the given host address.
6729
6730	<result name="VBOX_E_OBJECT_NOT_FOUND">
6731	Given @c name does not correspond to any USB device.
6732	</result>
6733
6734	<see>IUSBDevice::address</see>
6735	</desc>
6736	<param name="name" type="wstring" dir="in">
6737	<desc>
6738	Address of the USB device (as assigned by the host) to
6739	search for.
6740	</desc>
6741	</param>
6742	<param name="device" type="IUSBDevice" dir="return">
6743	<desc>Found USB device object.</desc>
6744	</param>
6745	</method>
6746
6747	<method name="findUSBDeviceById">
6748	<desc>
6749	Searches for a USB device with the given UUID.
6750
6751	<result name="VBOX_E_OBJECT_NOT_FOUND">
6752	Given @c id does not correspond to any USB device.
6753	</result>
6754
6755	<see>IUSBDevice::id</see>
6756	</desc>
6757	<param name="id" type="uuid" mod="string" dir="in">
6758	<desc>UUID of the USB device to search for.</desc>
6759	</param>
6760	<param name="device" type="IUSBDevice" dir="return">
6761	<desc>Found USB device object.</desc>
6762	</param>
6763	</method>
6764
6765	<method name="createSharedFolder">
6766	<desc>
6767	Creates a transient new shared folder by associating the given logical
6768	name with the given host path, adds it to the collection of shared
6769	folders and starts sharing it. Refer to the description of
6770	<link to="ISharedFolder"/> to read more about logical names.
6771
6772	<result name="VBOX_E_INVALID_VM_STATE">
6773	Virtual machine in Saved state or currently changing state.
6774	</result>
6775	<result name="VBOX_E_FILE_ERROR">
6776	Shared folder already exists or not accessible.
6777	</result>
6778	</desc>
6779	<param name="name" type="wstring" dir="in">
6780	<desc>Unique logical name of the shared folder.</desc>
6781	</param>
6782	<param name="hostPath" type="wstring" dir="in">
6783	<desc>Full path to the shared folder in the host file system.</desc>
6784	</param>
6785	<param name="writable" type="boolean" dir="in">
6786	<desc>Whether the share is writable or readonly</desc>
6787	</param>
6788	</method>
6789
6790	<method name="removeSharedFolder">
6791	<desc>
6792	Removes a transient shared folder with the given name previously
6793	created by <link to="#createSharedFolder"/> from the collection of
6794	shared folders and stops sharing it.
6795	<result name="VBOX_E_INVALID_VM_STATE">
6796	Virtual machine in Saved state or currently changing state.
6797	</result>
6798	<result name="VBOX_E_FILE_ERROR">
6799	Shared folder does not exists.
6800	</result>
6801	</desc>
6802	<param name="name" type="wstring" dir="in">
6803	<desc>Logical name of the shared folder to remove.</desc>
6804	</param>
6805	</method>
6806
6807	<method name="takeSnapshot">
6808	<desc>
6809	Saves the current execution state
6810	and all settings of the machine and creates differencing images
6811	for all normal (non-independent) media.
6812	See <link to="ISnapshot" /> for an introduction to snapshots.
6813
6814	This method can be called for a PoweredOff, Saved (see
6815	<link to="#saveState"/>), Running or
6816	Paused virtual machine. When the machine is PoweredOff, an
6817	offline snapshot is created. When the machine is Running a live
6818	snapshot is created, and an online snapshot is is created when Paused.
6819
6820	The taken snapshot is always based on the
6821	<link to="IMachine::currentSnapshot">current snapshot</link>
6822	of the associated virtual machine and becomes a new current snapshot.
6823
6824	<note>
6825	This method implicitly calls <link to="IMachine::saveSettings"/> to
6826	save all current machine settings before taking an offline snapshot.
6827	</note>
6828
6829	<result name="VBOX_E_INVALID_VM_STATE">
6830	Virtual machine currently changing state.
6831	</result>
6832	</desc>
6833	<param name="name" type="wstring" dir="in">
6834	<desc>Short name for the snapshot.</desc>
6835	</param>
6836	<param name="description" type="wstring" dir="in">
6837	<desc>Optional description of the snapshot.</desc>
6838	</param>
6839	<param name="progress" type="IProgress" dir="return">
6840	<desc>Progress object to track the operation completion.</desc>
6841	</param>
6842	</method>
6843
6844	<method name="deleteSnapshot">
6845	<desc>
6846	Starts discarding the specified snapshot asynchronously.
6847	See <link to="ISnapshot" /> for an introduction to snapshots.
6848
6849	The execution state and settings of the associated machine stored in
6850	the snapshot will be deleted. The contents of all differencing media of
6851	this snapshot will be merged with the contents of their dependent child
6852	media to keep the medium chain valid (in other words, all changes
6853	represented by media being discarded will be propagated to their child
6854	medium). After that, this snapshot's differencing medium will be
6855	deleted. The parent of this snapshot will become a new parent for all
6856	its child snapshots.
6857
6858	If the discarded snapshot is the current one, its parent
6859	snapshot will become a new current snapshot. The current machine
6860	state is not directly affected in this case, except that
6861	currently attached differencing media based on media
6862	of the discarded snapshot will be also merged as described
6863	above.
6864
6865	If the discarded snapshot is the first one (the root snapshot)
6866	and it has exactly one child snapshot, this child snapshot will
6867	become the first snapshot after discarding. If there are no
6868	children at all (i.e. the first snapshot is the only snapshot of
6869	the machine), both the current and the first snapshot of the
6870	machine will be set to @c null. In all other cases, the first
6871	snapshot cannot be discarded.
6872
6873	You cannot discard the snapshot if it
6874	stores <link to="MediumType_Normal">normal</link> (non-differencing)
6875	media that have differencing media based on them. Snapshots of
6876	such kind can be discarded only when every normal medium has either
6877	no children at all or exactly one child. In the former case, the normal
6878	medium simply becomes unused (i.e. not attached to any VM). In the
6879	latter case, it receives all the changes stored in the child medium,
6880	and then it replaces the child medium in the configuration of the
6881	corresponding snapshot or machine.
6882
6883	Also, you cannot discard the snapshot if it stores media
6884	(of any type) having differencing child media that belong
6885	to other machines. Such snapshots can be only discarded after
6886	you discard all snapshots of other machines containing "foreign"
6887	child media, or detach these "foreign" child media from machines
6888	they are attached to.
6889
6890	One particular example of the snapshot storing normal media
6891	is the first snapshot of a virtual machine that had normal media
6892	attached when taking the snapshot. Be careful when
6893	discarding such snapshots because this implicitly commits
6894	changes (made since the snapshot being discarded has been taken)
6895	to normal media (as described above), which may be not what
6896	you want.
6897
6898	The virtual machine is put to
6899	the <link to="MachineState_Discarding">Discarding</link> state until
6900	the discard operation is completed.
6901
6902	<note>
6903	The machine must not be running, otherwise the operation
6904	will fail.
6905	</note>
6906
6907	<note>
6908	Child media of all normal media of the discarded snapshot
6909	must be accessible (see <link to="IMedium::state"/>) for this
6910	operation to succeed. In particular, this means that all virtual
6911	machines, whose media are directly or indirectly based on the
6912	media of discarded snapshot, must be powered off.
6913	</note>
6914	<note>
6915	Merging medium contents can be very time and disk space
6916	consuming, if these media are big in size and have many
6917	children. However, if the snapshot being discarded is the last
6918	(head) snapshot on the branch, the operation will be rather
6919	quick.
6920	</note>
6921	<note>
6922	Note that discarding the current snapshot
6923	will implicitly call <link to="IMachine::saveSettings"/> to
6924	make all current machine settings permanent.
6925	</note>
6926	<result name="VBOX_E_INVALID_VM_STATE">
6927	Virtual machine is running.
6928	</result>
6929	</desc>
6930	<param name="id" type="uuid" mod="string" dir="in">
6931	<desc>UUID of the snapshot to discard.</desc>
6932	</param>
6933	<param name="progress" type="IProgress" dir="return">
6934	<desc>Progress object to track the operation completion.</desc>
6935	</param>
6936	</method>
6937
6938	<method name="restoreSnapshot">
6939	<desc>
6940	Starts resetting the machine's current state to the state contained
6941	in the given snapshot, asynchronously. All current settings of the
6942	machine will be reset and changes stored in differencing media
6943	will be lost.
6944	See <link to="ISnapshot" /> for an introduction to snapshots.
6945
6946	After this operation is successfully completed, new empty differencing
6947	media are created for all normal media of the machine.
6948
6949	If the given snapshot is an online snapshot, the machine will go to
6950	the <link to="MachineState_Saved"> saved state</link>, so that the
6951	next time it is powered on, the execution state will be restored
6952	from the state of the snapshot.
6953
6954	<note>
6955	The machine must not be running, otherwise the operation will fail.
6956	</note>
6957
6958	<note>
6959	If the machine state is <link to="MachineState_Saved">Saved</link>
6960	prior to this operation, the saved state file will be implicitly
6961	discarded (as if <link to="IConsole::forgetSavedState"/> were
6962	called).
6963	</note>
6964
6965	<result name="VBOX_E_INVALID_VM_STATE">
6966	Virtual machine is running.
6967	</result>
6968	</desc>
6969	<param name="snapshot" type="ISnapshot" dir="in">
6970	<desc>The snapshot to restore the VM state from.</desc>
6971	</param>
6972	<param name="progress" type="IProgress" dir="return">
6973	<desc>Progress object to track the operation completion.</desc>
6974	</param>
6975	</method>
6976
6977	<method name="teleport">
6978	<desc>
6979	Teleport the VM to a different host machine or process.
6980
6981	TODO explain the details.
6982
6983	<result name="VBOX_E_INVALID_VM_STATE">
6984	Virtual machine not running or paused.
6985	</result>
6986	</desc>
6987	<param name="hostname" type="wstring" dir="in">
6988	<desc>The name or IP of the host to teleport to.</desc>
6989	</param>
6990	<param name="tcpport" type="unsigned long" dir="in">
6991	<desc>The TCP port to connect to (1..65535).</desc>
6992	</param>
6993	<param name="password" type="wstring" dir="in">
6994	<desc>The password.</desc>
6995	</param>
6996	<param name="progress" type="IProgress" dir="return">
6997	<desc>Progress object to track the operation completion.</desc>
6998	</param>
6999	</method>
7000
7001	<method name="registerCallback">
7002	<desc>
7003	Registers a new console callback on this instance. The methods of the
7004	callback interface will be called by this instance when the appropriate
7005	event occurs.
7006	</desc>
7007	<param name="callback" type="IConsoleCallback" dir="in"/>
7008	</method>
7009
7010	<method name="unregisterCallback">
7011	<desc>
7012	Unregisters the console callback previously registered using
7013	<link to="#registerCallback"/>.
7014	<result name="E_INVALIDARG">
7015	Given @a callback handler is not registered.
7016	</result>
7017	</desc>
7018	<param name="callback" type="IConsoleCallback" dir="in"/>
7019	</method>
7020	</interface>
7021
7022	<!--
7023	// IHost
7024	/////////////////////////////////////////////////////////////////////////
7025	-->
7026
7027	<enum
7028	name="HostNetworkInterfaceMediumType"
7029	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7030	>
7031	<desc>
7032	Type of encapsulation. Ethernet encapsulation includes both wired and
7033	wireless Ethernet connections.
7034	<see>IHostNetworkInterface</see>
7035	</desc>
7036
7037	<const name="Unknown" value="0">
7038	<desc>
7039	The type of interface cannot be determined.
7040	</desc>
7041	</const>
7042	<const name="Ethernet" value="1">
7043	<desc>
7044	Ethernet frame encapsulation.
7045	</desc>
7046	</const>
7047	<const name="PPP" value="2">
7048	<desc>
7049	Point-to-point protocol encapsulation.
7050	</desc>
7051	</const>
7052	<const name="SLIP" value="3">
7053	<desc>
7054	Serial line IP encapsulation.
7055	</desc>
7056	</const>
7057	</enum>
7058
7059	<enum
7060	name="HostNetworkInterfaceStatus"
7061	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7062	>
7063	<desc>
7064	Current status of the interface.
7065	<see>IHostNetworkInterface</see>
7066	</desc>
7067
7068	<const name="Unknown" value="0">
7069	<desc>
7070	The state of interface cannot be determined.
7071	</desc>
7072	</const>
7073	<const name="Up" value="1">
7074	<desc>
7075	The interface is fully operational.
7076	</desc>
7077	</const>
7078	<const name="Down" value="2">
7079	<desc>
7080	The interface is not functioning.
7081	</desc>
7082	</const>
7083	</enum>
7084
7085	<enum
7086	name="HostNetworkInterfaceType"
7087	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7088	>
7089	<desc>
7090	Network interface type.
7091	</desc>
7092	<const name="Bridged" value="1"/>
7093	<const name="HostOnly" value="2"/>
7094	</enum>
7095
7096	<interface
7097	name="IHostNetworkInterface" extends="$unknown"
7098	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7099	wsmap="managed"
7100	>
7101	<desc>
7102	Represents one of host's network interfaces. IP V6 address and network
7103	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7104	separated by colons.
7105	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7106	</desc>
7107	<attribute name="name" type="wstring" readonly="yes">
7108	<desc>Returns the host network interface name.</desc>
7109	</attribute>
7110
7111	<attribute name="id" type="uuid" mod="string" readonly="yes">
7112	<desc>Returns the interface UUID.</desc>
7113	</attribute>
7114
7115	<attribute name="networkName" type="wstring" readonly="yes">
7116	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7117	</attribute>
7118
7119	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7120	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7121	</attribute>
7122
7123	<attribute name="IPAddress" type="wstring" readonly="yes">
7124	<desc>Returns the IP V4 address of the interface.</desc>
7125	</attribute>
7126
7127	<attribute name="networkMask" type="wstring" readonly="yes">
7128	<desc>Returns the network mask of the interface.</desc>
7129	</attribute>
7130
7131	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7132	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7133	</attribute>
7134
7135	<attribute name="IPV6Address" type="wstring" readonly="yes">
7136	<desc>Returns the IP V6 address of the interface.</desc>
7137	</attribute>
7138
7139	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7140	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7141	</attribute>
7142
7143	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7144	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7145	</attribute>
7146
7147	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7148	<desc>Type of protocol encapsulation used.</desc>
7149	</attribute>
7150
7151	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7152	<desc>Status of the interface.</desc>
7153	</attribute>
7154
7155	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7156	<desc>specifies the host interface type.</desc>
7157	</attribute>
7158
7159	<method name="enableStaticIpConfig">
7160	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7161	<param name="IPAddress" type="wstring" dir="in">
7162	<desc>
7163	IP address.
7164	</desc>
7165	</param>
7166	<param name="networkMask" type="wstring" dir="in">
7167	<desc>
7168	network mask.
7169	</desc>
7170	</param>
7171	</method>
7172
7173	<method name="enableStaticIpConfigV6">
7174	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7175	<param name="IPV6Address" type="wstring" dir="in">
7176	<desc>
7177	IP address.
7178	</desc>
7179	</param>
7180	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7181	<desc>
7182	network mask.
7183	</desc>
7184	</param>
7185	</method>
7186
7187	<method name="enableDynamicIpConfig">
7188	<desc>enables the dynamic IP configuration.</desc>
7189	</method>
7190
7191	<method name="dhcpRediscover">
7192	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7193	</method>
7194
7195	</interface>
7196
7197	<interface
7198	name="IHost" extends="$unknown"
7199	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7200	wsmap="managed"
7201	>
7202	<desc>
7203	The IHost interface represents the physical machine that this VirtualBox
7204	installation runs on.
7205
7206	An object implementing this interface is returned by the
7207	<link to="IVirtualBox::host" /> attribute. This interface contains
7208	read-only information about the host's physical hardware (such as what
7209	processors and disks are available, what the host operating system is,
7210	and so on) and also allows for manipulating some of the host's hardware,
7211	such as global USB device filters and host interface networking.
7212
7213	</desc>
7214	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7215	<desc>List of DVD drives available on the host.</desc>
7216	</attribute>
7217
7218	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7219	<desc>List of floppy drives available on the host.</desc>
7220	</attribute>
7221
7222	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7223	<desc>
7224	List of USB devices currently attached to the host.
7225	Once a new device is physically attached to the host computer,
7226	it appears in this list and remains there until detached.
7227
7228	<note>
7229	If USB functionality is not available in the given edition of
7230	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7231	</note>
7232	</desc>
7233	</attribute>
7234
7235	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7236	<desc>
7237	List of USB device filters in action.
7238	When a new device is physically attached to the host computer,
7239	filters from this list are applied to it (in order they are stored
7240	in the list). The first matched filter will determine the
7241	<link to="IHostUSBDeviceFilter::action">action</link>
7242	performed on the device.
7243
7244	Unless the device is ignored by these filters, filters of all
7245	currently running virtual machines
7246	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7247
7248	<note>
7249	If USB functionality is not available in the given edition of
7250	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7251	</note>
7252
7253	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7254	</desc>
7255	</attribute>
7256
7257	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7258	<desc>List of host network interfaces currently defined on the host.</desc>
7259	</attribute>
7260
7261	<attribute name="processorCount" type="unsigned long" readonly="yes">
7262	<desc>Number of (logical) CPUs installed in the host system.</desc>
7263	</attribute>
7264
7265	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7266	<desc>Number of (logical) CPUs online in the host system.</desc>
7267	</attribute>
7268
7269	<method name="getProcessorSpeed">
7270	<desc>Query the (approximate) maximum speed of a specified host CPU in
7271	Megahertz.
7272	</desc>
7273	<param name="cpuId" type="unsigned long" dir="in">
7274	<desc>
7275	Identifier of the CPU.
7276	</desc>
7277	</param>
7278	<param name="speed" type="unsigned long" dir="return">
7279	<desc>
7280	Speed value. 0 is returned if value is not known or @a cpuId is
7281	invalid.
7282	</desc>
7283	</param>
7284	</method>
7285
7286	<method name="getProcessorFeature">
7287	<desc>Query whether a CPU feature is supported or not.</desc>
7288	<param name="feature" type="ProcessorFeature" dir="in">
7289	<desc>
7290	CPU Feature identifier.
7291	</desc>
7292	</param>
7293	<param name="supported" type="boolean" dir="return">
7294	<desc>
7295	Feature is supported or not.
7296	</desc>
7297	</param>
7298	</method>
7299
7300	<method name="getProcessorDescription">
7301	<desc>Query the model string of a specified host CPU.
7302	</desc>
7303	<param name="cpuId" type="unsigned long" dir="in">
7304	<desc>
7305	Identifier of the CPU.
7306	<note>
7307	The current implementation might not necessarily return the
7308	description for this exact CPU.
7309	</note>
7310	</desc>
7311	</param>
7312	<param name="description" type="wstring" dir="return">
7313	<desc>
7314	Model string. An empty string is returned if value is not known or
7315	@a cpuId is invalid.
7316	</desc>
7317	</param>
7318	</method>
7319
7320	<method name="getProcessorCpuIdLeaf">
7321	<desc>
7322	Returns the CPU cpuid information for the specified leaf.
7323	</desc>
7324	<param name="cpuId" type="unsigned long" dir="in">
7325	<desc>
7326	Identifier of the CPU. The CPU most be online.
7327	<note>
7328	The current implementation might not necessarily return the
7329	description for this exact CPU.
7330	</note>
7331	</desc>
7332	</param>
7333	<param name="leaf" type="unsigned long" dir="in">
7334	<desc>
7335	Cpuid leaf index (eax).
7336	</desc>
7337	</param>
7338	<param name="subLeaf" type="unsigned long" dir="in">
7339	<desc>
7340	Cpuid leaf sub index (ecx). This currently only applies to cache
7341	information on Intel CPUs. Use 0 if retriving values for
7342	<link to="IMachine::setCpuIdLeaf"/>.
7343	</desc>
7344	</param>
7345	<param name="valEax" type="unsigned long" dir="out">
7346	<desc>
7347	Cpuid leaf value for register eax.
7348	</desc>
7349	</param>
7350	<param name="valEbx" type="unsigned long" dir="out">
7351	<desc>
7352	Cpuid leaf value for register ebx.
7353	</desc>
7354	</param>
7355	<param name="valEcx" type="unsigned long" dir="out">
7356	<desc>
7357	Cpuid leaf value for register ecx.
7358	</desc>
7359	</param>
7360	<param name="valEdx" type="unsigned long" dir="out">
7361	<desc>
7362	Cpuid leaf value for register edx.
7363	</desc>
7364	</param>
7365	</method>
7366
7367	<attribute name="memorySize" type="unsigned long" readonly="yes">
7368	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7369	</attribute>
7370
7371	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7372	<desc>Available system memory in the host system.</desc>
7373	</attribute>
7374
7375	<attribute name="operatingSystem" type="wstring" readonly="yes">
7376	<desc>Name of the host system's operating system.</desc>
7377	</attribute>
7378
7379	<attribute name="OSVersion" type="wstring" readonly="yes">
7380	<desc>Host operating system's version string.</desc>
7381	</attribute>
7382
7383	<attribute name="UTCTime" type="long long" readonly="yes">
7384	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7385	</attribute>
7386
7387	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7388	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7389	</attribute>
7390
7391	<method name="createHostOnlyNetworkInterface">
7392	<desc>
7393	Creates a new adapter for Host Only Networking.
7394	<result name="E_INVALIDARG">
7395	Host network interface @a name already exists.
7396	</result>
7397	</desc>
7398	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7399	<desc>
7400	Created host interface object.
7401	</desc>
7402	</param>
7403	<param name="progress" type="IProgress" dir="return">
7404	<desc>
7405	Progress object to track the operation completion.
7406	</desc>
7407	</param>
7408	</method>
7409
7410	<method name="removeHostOnlyNetworkInterface">
7411	<desc>
7412	Removes the given Host Only Networking interface.
7413	<result name="VBOX_E_OBJECT_NOT_FOUND">
7414	No host network interface matching @a id found.
7415	</result>
7416	</desc>
7417	<param name="id" type="uuid" mod="string" dir="in">
7418	<desc>
7419	Adapter GUID.
7420	</desc>
7421	</param>
7422	<param name="progress" type="IProgress" dir="return">
7423	<desc>
7424	Progress object to track the operation completion.
7425	</desc>
7426	</param>
7427	</method>
7428
7429	<method name="createUSBDeviceFilter">
7430	<desc>
7431	Creates a new USB device filter. All attributes except
7432	the filter name are set to empty (any match),
7433	<i>active</i> is @c false (the filter is not active).
7434
7435	The created filter can be added to the list of filters using
7436	<link to="#insertUSBDeviceFilter"/>.
7437
7438	<see>#USBDeviceFilters</see>
7439	</desc>
7440	<param name="name" type="wstring" dir="in">
7441	<desc>
7442	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7443	for more info.
7444	</desc>
7445	</param>
7446	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7447	<desc>Created filter object.</desc>
7448	</param>
7449	</method>
7450
7451	<method name="insertUSBDeviceFilter">
7452	<desc>
7453	Inserts the given USB device to the specified position
7454	in the list of filters.
7455
7456	Positions are numbered starting from @c 0. If the specified
7457	position is equal to or greater than the number of elements in
7458	the list, the filter is added at the end of the collection.
7459
7460	<note>
7461	Duplicates are not allowed, so an attempt to insert a
7462	filter already in the list is an error.
7463	</note>
7464	<note>
7465	If USB functionality is not available in the given edition of
7466	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7467	</note>
7468
7469	<see>#USBDeviceFilters</see>
7470
7471	<result name="VBOX_E_INVALID_OBJECT_STATE">
7472	USB device filter is not created within this VirtualBox instance.
7473	</result>
7474	<result name="E_INVALIDARG">
7475	USB device filter already in list.
7476	</result>
7477
7478	</desc>
7479	<param name="position" type="unsigned long" dir="in">
7480	<desc>Position to insert the filter to.</desc>
7481	</param>
7482	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7483	<desc>USB device filter to insert.</desc>
7484	</param>
7485	</method>
7486
7487	<method name="removeUSBDeviceFilter">
7488	<desc>
7489	Removes a USB device filter from the specified position in the
7490	list of filters.
7491
7492	Positions are numbered starting from @c 0. Specifying a
7493	position equal to or greater than the number of elements in
7494	the list will produce an error.
7495
7496	<note>
7497	If USB functionality is not available in the given edition of
7498	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7499	</note>
7500
7501	<see>#USBDeviceFilters</see>
7502
7503	<result name="E_INVALIDARG">
7504	USB device filter list empty or invalid @a position.
7505	</result>
7506
7507	</desc>
7508	<param name="position" type="unsigned long" dir="in">
7509	<desc>Position to remove the filter from.</desc>
7510	</param>
7511	</method>
7512
7513	<method name="findHostDVDDrive">
7514	<desc>
7515	Searches for a host DVD drive with the given @c name.
7516
7517	<result name="VBOX_E_OBJECT_NOT_FOUND">
7518	Given @c name does not correspond to any host drive.
7519	</result>
7520
7521	</desc>
7522	<param name="name" type="wstring" dir="in">
7523	<desc>Name of the host drive to search for</desc>
7524	</param>
7525	<param name="drive" type="IMedium" dir="return">
7526	<desc>Found host drive object</desc>
7527	</param>
7528	</method>
7529
7530	<method name="findHostFloppyDrive">
7531	<desc>
7532	Searches for a host floppy drive with the given @c name.
7533
7534	<result name="VBOX_E_OBJECT_NOT_FOUND">
7535	Given @c name does not correspond to any host floppy drive.
7536	</result>
7537
7538	</desc>
7539	<param name="name" type="wstring" dir="in">
7540	<desc>Name of the host floppy drive to search for</desc>
7541	</param>
7542	<param name="drive" type="IMedium" dir="return">
7543	<desc>Found host floppy drive object</desc>
7544	</param>
7545	</method>
7546
7547	<method name="findHostNetworkInterfaceByName">
7548	<desc>
7549	Searches through all host network interfaces for an interface with
7550	the given @c name.
7551	<note>
7552	The method returns an error if the given @c name does not
7553	correspond to any host network interface.
7554	</note>
7555	</desc>
7556	<param name="name" type="wstring" dir="in">
7557	<desc>Name of the host network interface to search for.</desc>
7558	</param>
7559	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7560	<desc>Found host network interface object.</desc>
7561	</param>
7562	</method>
7563	<method name="findHostNetworkInterfaceById">
7564	<desc>
7565	Searches through all host network interfaces for an interface with
7566	the given GUID.
7567	<note>
7568	The method returns an error if the given GUID does not
7569	correspond to any host network interface.
7570	</note>
7571	</desc>
7572	<param name="id" type="uuid" mod="string" dir="in">
7573	<desc>GUID of the host network interface to search for.</desc>
7574	</param>
7575	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7576	<desc>Found host network interface object.</desc>
7577	</param>
7578	</method>
7579	<method name="findHostNetworkInterfacesOfType">
7580	<desc>
7581	Searches through all host network interfaces and returns a list of interfaces of the specified type
7582	</desc>
7583	<param name="type" type="HostNetworkInterfaceType" dir="in">
7584	<desc>type of the host network interfaces to search for.</desc>
7585	</param>
7586	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7587	<desc>Found host network interface objects.</desc>
7588	</param>
7589	</method>
7590
7591	<method name="findUSBDeviceById">
7592	<desc>
7593	Searches for a USB device with the given UUID.
7594
7595	<result name="VBOX_E_OBJECT_NOT_FOUND">
7596	Given @c id does not correspond to any USB device.
7597	</result>
7598
7599	<see>IHostUSBDevice::id</see>
7600	</desc>
7601	<param name="id" type="uuid" mod="string" dir="in">
7602	<desc>UUID of the USB device to search for.</desc>
7603	</param>
7604	<param name="device" type="IHostUSBDevice" dir="return">
7605	<desc>Found USB device object.</desc>
7606	</param>
7607	</method>
7608
7609	<method name="findUSBDeviceByAddress">
7610	<desc>
7611	Searches for a USB device with the given host address.
7612
7613	<result name="VBOX_E_OBJECT_NOT_FOUND">
7614	Given @c name does not correspond to any USB device.
7615	</result>
7616
7617	<see>IHostUSBDevice::address</see>
7618	</desc>
7619	<param name="name" type="wstring" dir="in">
7620	<desc>
7621	Address of the USB device (as assigned by the host) to
7622	search for.
7623	</desc>
7624	</param>
7625	<param name="device" type="IHostUSBDevice" dir="return">
7626	<desc>Found USB device object.</desc>
7627	</param>
7628	</method>
7629
7630	</interface>
7631
7632	<!--
7633	// ISystemProperties
7634	/////////////////////////////////////////////////////////////////////////
7635	-->
7636
7637	<interface
7638	name="ISystemProperties"
7639	extends="$unknown"
7640	uuid="8030645c-8fef-4320-bb7b-c829f00069dc"
7641	wsmap="managed"
7642	>
7643	<desc>
7644	The ISystemProperties interface represents global properties of the given
7645	VirtualBox installation.
7646
7647	These properties define limits and default values for various attributes
7648	and parameters. Most of the properties are read-only, but some can be
7649	changed by a user.
7650	</desc>
7651
7652	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7653	<desc>Minimum guest system memory in Megabytes.</desc>
7654	</attribute>
7655
7656	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7657	<desc>Maximum guest system memory in Megabytes.</desc>
7658	</attribute>
7659
7660	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7661	<desc>Minimum guest video memory in Megabytes.</desc>
7662	</attribute>
7663
7664	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7665	<desc>Maximum guest video memory in Megabytes.</desc>
7666	</attribute>
7667
7668	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7669	<desc>Minimum CPU count.</desc>
7670	</attribute>
7671
7672	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7673	<desc>Maximum CPU count.</desc>
7674	</attribute>
7675
7676	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7677	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7678	</attribute>
7679
7680	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7681	<desc>
7682	Number of network adapters associated with every
7683	<link to="IMachine"/> instance.
7684	</desc>
7685	</attribute>
7686
7687	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7688	<desc>
7689	Number of serial ports associated with every
7690	<link to="IMachine"/> instance.
7691	</desc>
7692	</attribute>
7693
7694	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7695	<desc>
7696	Number of parallel ports associated with every
7697	<link to="IMachine"/> instance.
7698	</desc>
7699	</attribute>
7700
7701	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7702	<desc>
7703	Maximum device position in the boot order. This value corresponds
7704	to the total number of devices a machine can boot from, to make it
7705	possible to include all possible devices to the boot list.
7706	<see><link to="IMachine::setBootOrder"/></see>
7707	</desc>
7708	</attribute>
7709
7710	<attribute name="defaultMachineFolder" type="wstring">
7711	<desc>
7712	Full path to the default directory used to create new or open
7713	existing machines when a settings file name contains no
7714	path.
7715
7716	The initial value of this property is
7717	<tt><</tt><link to="IVirtualBox::homeFolder">
7718	VirtualBox_home</link><tt>>/Machines</tt>.
7719
7720	<note>
7721	Setting this property to @c null or an empty string will restore the
7722	initial value.
7723	</note>
7724	<note>
7725	When settings this property, the specified path can be
7726	absolute (full path) or relative
7727	to the <link to="IVirtualBox::homeFolder">
7728	VirtualBox home directory</link>.
7729	When reading this property, a full path is
7730	always returned.
7731	</note>
7732	<note>
7733	The specified path may not exist, it will be created
7734	when necessary.
7735	</note>
7736
7737	<see>
7738	<link to="IVirtualBox::createMachine"/>,
7739	<link to="IVirtualBox::openMachine"/>
7740	</see>
7741	</desc>
7742	</attribute>
7743
7744	<attribute name="defaultHardDiskFolder" type="wstring">
7745	<desc>
7746	Full path to the default directory used to create new or open existing
7747	virtual disks.
7748
7749	This path is used when the storage unit of a hard disk is a regular file
7750	in the host's file system and only a file name that contains no path is
7751	given.
7752
7753	The initial value of this property is
7754	<tt><</tt>
7755	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7756	<tt>>/HardDisks</tt>.
7757
7758	<note>
7759	Setting this property to @c null or empty string will restore the
7760	initial value.
7761	</note>
7762	<note>
7763	When settings this property, the specified path can be relative
7764	to the
7765	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7766	absolute. When reading this property, a full path is
7767	always returned.
7768	</note>
7769	<note>
7770	The specified path may not exist, it will be created
7771	when necessary.
7772	</note>
7773
7774	<see>
7775	IMedium,
7776	<link to="IVirtualBox::createHardDisk"/>,
7777	<link to="IVirtualBox::openHardDisk"/>,
7778	<link to="IMedium::location"/>
7779	</see>
7780	</desc>
7781	</attribute>
7782
7783	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7784	<desc>
7785	List of all medium storage formats supported by this VirtualBox
7786	installation.
7787
7788	Keep in mind that the medium format identifier
7789	(<link to="IMediumFormat::id"/>) used in other API calls like
7790	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7791	medium format is a case-insensitive string. This means that, for
7792	example, all of the following strings:
7793	<pre>
7794	"VDI"
7795	"vdi"
7796	"VdI"</pre>
7797	refer to the same medium format.
7798
7799	Note that the virtual medium framework is backend-based, therefore
7800	the list of supported formats depends on what backends are currently
7801	installed.
7802
7803	<see>
7804	<link to="IMediumFormat"/>,
7805	</see>
7806	</desc>
7807	</attribute>
7808
7809	<attribute name="defaultHardDiskFormat" type="wstring">
7810	<desc>
7811	Identifier of the default medium format used by VirtualBox.
7812
7813	The medium format set by this attribute is used by VirtualBox
7814	when the medium format was not specified explicitly. One example is
7815	<link to="IVirtualBox::createHardDisk"/> with the empty
7816	format argument. A more complex example is implicit creation of
7817	differencing media when taking a snapshot of a virtual machine:
7818	this operation will try to use a format of the parent medium first
7819	and if this format does not support differencing media the default
7820	format specified by this argument will be used.
7821
7822	The list of supported medium formats may be obtained by the
7823	<link to="#mediaFormats"/> call. Note that the default medium
7824	format must have a capability to create differencing media;
7825	otherwise operations that create media implicitly may fail
7826	unexpectedly.
7827
7828	The initial value of this property is <tt>"VDI"</tt> in the current
7829	version of the VirtualBox product, but may change in the future.
7830
7831	<note>
7832	Setting this property to @c null or empty string will restore the
7833	initial value.
7834	</note>
7835
7836	<see>
7837	<link to="#mediaFormats"/>,
7838	<link to="IMediumFormat::id"/>,
7839	<link to="IVirtualBox::createHardDisk"/>
7840	</see>
7841	</desc>
7842	</attribute>
7843
7844	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7845	<desc>
7846	Library that provides authentication for VRDP clients. The library
7847	is used if a virtual machine's authentication type is set to "external"
7848	in the VM RemoteDisplay configuration.
7849
7850	The system library extension (".DLL" or ".so") must be omitted.
7851	A full path can be specified; if not, then the library must reside on the
7852	system's default library path.
7853
7854	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7855	of that name in one of the default VirtualBox library directories.
7856
7857	For details about VirtualBox authentication libraries and how to implement
7858	them, please refer to the VirtualBox manual.
7859
7860	<note>
7861	Setting this property to @c null or empty string will restore the
7862	initial value.
7863	</note>
7864	</desc>
7865	</attribute>
7866
7867	<attribute name="webServiceAuthLibrary" type="wstring">
7868	<desc>
7869	Library that provides authentication for webservice clients. The library
7870	is used if a virtual machine's authentication type is set to "external"
7871	in the VM RemoteDisplay configuration and will be called from
7872	within the <link to="IWebsessionManager::logon" /> implementation.
7873
7874	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7875	there is no per-VM setting for this, as the webservice is a global
7876	resource (if it is running). Only for this setting (for the webservice),
7877	setting this value to a literal <tt>"null"</tt> string disables authentication,
7878	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7879	no matter what user name and password are supplied.
7880
7881	The initial value of this property is <tt>"VRDPAuth"</tt>,
7882	meaning that the webservice will use the same authentication
7883	library that is used by default for VBoxVRDP (again, see
7884	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7885	The format and calling convention of authentication libraries
7886	is the same for the webservice as it is for VBoxVRDP.
7887
7888	<note>
7889	Setting this property to @c null or empty string will restore the
7890	initial value.
7891	</note>
7892	</desc>
7893	</attribute>
7894
7895	<attribute name="LogHistoryCount" type="unsigned long">
7896	<desc>
7897	This value specifies how many old release log files are kept.
7898	</desc>
7899	</attribute>
7900
7901	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7902	<desc>This value hold the default audio driver for the current
7903	system.</desc>
7904	</attribute>
7905
7906	<method name="getMaxDevicesPerPortForStorageBus">
7907	<desc>Returns the maximum number of devices which can be attached to a port
7908	for the given storage bus.</desc>
7909
7910	<param name="bus" type="StorageBus" dir="in">
7911	<desc>The storage bus type to get the value for.</desc>
7912	</param>
7913
7914	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7915	<desc>The maximum number of devices which can eb attached to the port for the given
7916	storage bus.</desc>
7917	</param>
7918	</method>
7919
7920	<method name="getMinPortCountForStorageBus">
7921	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7922
7923	<param name="bus" type="StorageBus" dir="in">
7924	<desc>The storage bus type to get the value for.</desc>
7925	</param>
7926
7927	<param name="minPortCount" type="unsigned long" dir="return">
7928	<desc>The minimum number of ports for the given storage bus.</desc>
7929	</param>
7930	</method>
7931
7932	<method name="getMaxPortCountForStorageBus">
7933	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7934
7935	<param name="bus" type="StorageBus" dir="in">
7936	<desc>The storage bus type to get the value for.</desc>
7937	</param>
7938
7939	<param name="maxPortCount" type="unsigned long" dir="return">
7940	<desc>The maximum number of ports for the given storage bus.</desc>
7941	</param>
7942	</method>
7943
7944	<method name="getMaxInstancesOfStorageBus">
7945	<desc>Returns the maximum number of storage bus instances which
7946	can be configured for each VM. This corresponds to the number of
7947	storage controllers one can have.</desc>
7948
7949	<param name="bus" type="StorageBus" dir="in">
7950	<desc>The storage bus type to get the value for.</desc>
7951	</param>
7952
7953	<param name="maxInstances" type="unsigned long" dir="return">
7954	<desc>The maximum number of instances for the given storage bus.</desc>
7955	</param>
7956	</method>
7957
7958	<method name="getDeviceTypesForStorageBus">
7959	<desc>Returns list of all the supported device types
7960	(<link to="DeviceType"/>) for the given type of storage
7961	bus.</desc>
7962
7963	<param name="bus" type="StorageBus" dir="in">
7964	<desc>The storage bus type to get the value for.</desc>
7965	</param>
7966
7967	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7968	<desc>The list of all supported device types for the given storage bus.</desc>
7969	</param>
7970	</method>
7971	</interface>
7972
7973	<!--
7974	// IGuest
7975	/////////////////////////////////////////////////////////////////////////
7976	-->
7977
7978	<interface
7979	name="IGuestOSType" extends="$unknown"
7980	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
7981	wsmap="struct"
7982	>
7983	<desc>
7984	</desc>
7985
7986	<attribute name="familyId" type="wstring" readonly="yes">
7987	<desc>Guest OS family identifier string.</desc>
7988	</attribute>
7989
7990	<attribute name="familyDescription" type="wstring" readonly="yes">
7991	<desc>Human readable description of the guest OS family.</desc>
7992	</attribute>
7993
7994	<attribute name="id" type="wstring" readonly="yes">
7995	<desc>Guest OS identifier string.</desc>
7996	</attribute>
7997
7998	<attribute name="description" type="wstring" readonly="yes">
7999	<desc>Human readable description of the guest OS.</desc>
8000	</attribute>
8001
8002	<attribute name="is64Bit" type="boolean" readonly="yes">
8003	<desc>Returns @c true if the given OS is 64-bit</desc>
8004	</attribute>
8005
8006	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8007	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8008	</attribute>
8009
8010	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8011	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8012	</attribute>
8013
8014	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8015	<desc>Recommended RAM size in Megabytes.</desc>
8016	</attribute>
8017
8018	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8019	<desc>Recommended video RAM size in Megabytes.</desc>
8020	</attribute>
8021
8022	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8023	<desc>Recommended hard disk size in Megabytes.</desc>
8024	</attribute>
8025
8026	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8027	<desc>Returns recommended network adapter for this OS type.</desc>
8028	</attribute>
8029	</interface>
8030
8031	<interface
8032	name="IGuest" extends="$unknown"
8033	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8034	wsmap="managed"
8035	>
8036	<desc>
8037	The IGuest interface represents information about the operating system
8038	running inside the virtual machine. Used in
8039	<link to="IConsole::guest"/>.
8040
8041	IGuest provides information about the guest operating system, whether
8042	Guest Additions are installed and other OS-specific virtual machine
8043	properties.
8044	</desc>
8045
8046	<attribute name="OSTypeId" type="wstring" readonly="yes">
8047	<desc>
8048	Identifier of the Guest OS type as reported by the Guest
8049	Additions.
8050	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8051	an IGuestOSType object representing details about the given
8052	Guest OS type.
8053	<note>
8054	If Guest Additions are not installed, this value will be
8055	the same as <link to="IMachine::OSTypeId"/>.
8056	</note>
8057	</desc>
8058	</attribute>
8059
8060	<attribute name="additionsActive" type="boolean" readonly="yes">
8061	<desc>
8062	Flag whether the Guest Additions are installed and active
8063	in which case their version will be returned by the
8064	<link to="#additionsVersion"/> property.
8065	</desc>
8066	</attribute>
8067
8068	<attribute name="additionsVersion" type="wstring" readonly="yes">
8069	<desc>
8070	Version of the Guest Additions (3 decimal numbers separated
8071	by dots) or empty when the Additions are not installed. The
8072	Additions may also report a version but yet not be active as
8073	the version might be refused by VirtualBox (incompatible) or
8074	other failures occurred.
8075	</desc>
8076	</attribute>
8077
8078	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8079	<desc>
8080	Flag whether seamless guest display rendering (seamless desktop
8081	integration) is supported.
8082	</desc>
8083	</attribute>
8084
8085	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8086	<desc>
8087	Flag whether the guest is in graphics mode. If it is not, then
8088	seamless rendering will not work, resize hints are not immediately
8089	acted on and guest display resizes are probably not initiated by
8090	the guest additions.
8091	</desc>
8092	</attribute>
8093
8094	<attribute name="memoryBalloonSize" type="unsigned long">
8095	<desc>Guest system memory balloon size in megabytes.</desc>
8096	</attribute>
8097
8098	<attribute name="statisticsUpdateInterval" type="unsigned long">
8099	<desc>Interval to update guest statistics in seconds.</desc>
8100	</attribute>
8101
8102	<method name="setCredentials">
8103	<desc>
8104	Store login credentials that can be queried by guest operating
8105	systems with Additions installed. The credentials are transient
8106	to the session and the guest may also choose to erase them. Note
8107	that the caller cannot determine whether the guest operating system
8108	has queried or made use of the credentials.
8109
8110	<result name="VBOX_E_VM_ERROR">
8111	VMM device is not available.
8112	</result>
8113
8114	</desc>
8115	<param name="userName" type="wstring" dir="in">
8116	<desc>User name string, can be empty</desc>
8117	</param>
8118	<param name="password" type="wstring" dir="in">
8119	<desc>Password string, can be empty</desc>
8120	</param>
8121	<param name="domain" type="wstring" dir="in">
8122	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8123	</param>
8124	<param name="allowInteractiveLogon" type="boolean" dir="in">
8125	<desc>
8126	Flag whether the guest should alternatively allow the user to
8127	interactively specify different credentials. This flag might
8128	not be supported by all versions of the Additions.
8129	</desc>
8130	</param>
8131	</method>
8132
8133	<method name="getStatistic">
8134	<desc>
8135	Query specified guest statistics as reported by the VirtualBox Additions.
8136	</desc>
8137	<param name="cpuId" type="unsigned long" dir="in">
8138	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8139	</param>
8140	<param name="statistic" type="GuestStatisticType" dir="in">
8141	<desc>Statistic type.</desc>
8142	</param>
8143	<param name="statVal" type="unsigned long" dir="return">
8144	<desc>Statistics value</desc>
8145	</param>
8146	</method>
8147
8148	</interface>
8149
8150
8151	<!--
8152	// IProgress
8153	/////////////////////////////////////////////////////////////////////////
8154	-->
8155
8156	<interface
8157	name="IProgress" extends="$unknown"
8158	uuid="62827ef1-c098-40eb-be96-36d0508489a6"
8159	wsmap="managed"
8160	>
8161	<desc>
8162	The IProgress interface is used to track and control
8163	asynchronous tasks within VirtualBox.
8164
8165	An instance of this is returned every time VirtualBox starts
8166	an asynchronous task (in other words, a separate thread) which
8167	continues to run after a method call returns. For example,
8168	<link to="IConsole::saveState" />, which saves the state of
8169	a running virtual machine, can take a long time to complete.
8170	To be able to display a progress bar, a user interface such as
8171	the VirtualBox graphical user interface can use the IProgress
8172	object returned by that method.
8173
8174	Note that IProgress is a "read-only" interface in the sense
8175	that only the VirtualBox internals behind the Main API can
8176	create and manipulate progress objects, whereas client code
8177	can only use the IProgress object to monitor a task's
8178	progress and, if <link to="#cancelable" /> is @c true,
8179	cancel the task by calling <link to="#cancel" />.
8180
8181	A task represented by IProgress consists of either one or
8182	several sub-operations that run sequentially, one by one (see
8183	<link to="#operation" /> and <link to="#operationCount" />).
8184	Every operation is identified by a number (starting from 0)
8185	and has a separate description.
8186
8187	You can find the individual percentage of completion of the current
8188	operation in <link to="#operationPercent" /> and the
8189	percentage of completion of the task as a whole
8190	in <link to="#percent" />.
8191
8192	Similarly, you can wait for the completion of a particular
8193	operation via <link to="#waitForOperationCompletion" /> or
8194	for the completion of the whole task via
8195	<link to="#waitForCompletion" />.
8196	</desc>
8197
8198	<attribute name="id" type="uuid" mod="string" readonly="yes">
8199	<desc>ID of the task.</desc>
8200	</attribute>
8201
8202	<attribute name="description" type="wstring" readonly="yes">
8203	<desc>Description of the task.</desc>
8204	</attribute>
8205
8206	<attribute name="initiator" type="$unknown" readonly="yes">
8207	<desc>Initiator of the task.</desc>
8208	</attribute>
8209
8210	<attribute name="cancelable" type="boolean" readonly="yes">
8211	<desc>Whether the task can be interrupted.</desc>
8212	</attribute>
8213
8214	<attribute name="percent" type="unsigned long" readonly="yes">
8215	<desc>
8216	Current progress value of the task as a whole, in percent.
8217	This value depends on how many operations are already complete.
8218	Returns 100 if <link to="#completed" /> is @c true.
8219	</desc>
8220	</attribute>
8221
8222	<attribute name="timeRemaining" type="long" readonly="yes">
8223	<desc>
8224	Estimated remaining time until the task completes, in
8225	seconds. Returns 0 once the task has completed; returns -1
8226	if the remaining time cannot be computed, in particular if
8227	the current progress is 0.
8228
8229	Even if a value is returned, the estimate will be unreliable
8230	for low progress values. It will become more reliable as the
8231	task progresses; it is not recommended to display an ETA
8232	before at least 20% of a task have completed.
8233	</desc>
8234	</attribute>
8235
8236	<attribute name="completed" type="boolean" readonly="yes">
8237	<desc>Whether the task has been completed.</desc>
8238	</attribute>
8239
8240	<attribute name="canceled" type="boolean" readonly="yes">
8241	<desc>Whether the task has been canceled.</desc>
8242	</attribute>
8243
8244	<attribute name="resultCode" type="long" readonly="yes">
8245	<desc>
8246	Result code of the progress task.
8247	Valid only if <link to="#completed"/> is @c true.
8248	</desc>
8249	</attribute>
8250
8251	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8252	<desc>
8253	Extended information about the unsuccessful result of the
8254	progress operation. May be @c null if no extended information
8255	is available.
8256	Valid only if <link to="#completed"/> is @c true and
8257	<link to="#resultCode"/> indicates a failure.
8258	</desc>
8259	</attribute>
8260
8261	<attribute name="operationCount" type="unsigned long" readonly="yes">
8262	<desc>
8263	Number of sub-operations this task is divided into.
8264	Every task consists of at least one suboperation.
8265	</desc>
8266	</attribute>
8267
8268	<attribute name="operation" type="unsigned long" readonly="yes">
8269	<desc>Number of the sub-operation being currently executed.</desc>
8270	</attribute>
8271
8272	<attribute name="operationDescription" type="wstring" readonly="yes">
8273	<desc>
8274	Description of the sub-operation being currently executed.
8275	</desc>
8276	</attribute>
8277
8278	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8279	<desc>Progress value of the current sub-operation only, in percent.</desc>
8280	</attribute>
8281
8282	<method name="setCurrentOperationProgress">
8283	<desc>Internal method, not to be called externally.</desc>
8284	<param name="percent" type="unsigned long" dir="in" />
8285	</method>
8286	<method name="setNextOperation">
8287	<desc>Internal method, not to be called externally.</desc>
8288	<param name="nextOperationDescription" type="wstring" dir="in" />
8289	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8290	</method>
8291
8292	<method name="waitForCompletion">
8293	<desc>
8294	Waits until the task is done (including all sub-operations)
8295	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8296
8297	<result name="VBOX_E_IPRT_ERROR">
8298	Failed to wait for task completion.
8299	</result>
8300	</desc>
8301
8302	<param name="timeout" type="long" dir="in">
8303	<desc>
8304	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8305	</desc>
8306	</param>
8307	</method>
8308
8309	<method name="waitForOperationCompletion">
8310	<desc>
8311	Waits until the given operation is done with a given timeout in
8312	milliseconds; specify -1 for an indefinite wait.
8313
8314	<result name="VBOX_E_IPRT_ERROR">
8315	Failed to wait for operation completion.
8316	</result>
8317
8318	</desc>
8319	<param name="operation" type="unsigned long" dir="in">
8320	<desc>
8321	Number of the operation to wait for.
8322	Must be less than <link to="#operationCount"/>.
8323	</desc>
8324	</param>
8325	<param name="timeout" type="long" dir="in">
8326	<desc>
8327	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8328	</desc>
8329	</param>
8330	</method>
8331
8332	<method name="cancel">
8333	<desc>
8334	Cancels the task.
8335	<note>
8336	If <link to="#cancelable"/> is @c false, then this method will fail.
8337	</note>
8338
8339	<result name="VBOX_E_INVALID_OBJECT_STATE">
8340	Operation cannot be canceled.
8341	</result>
8342
8343	</desc>
8344	</method>
8345
8346	</interface>
8347
8348
8349	<!--
8350	// ISnapshot
8351	/////////////////////////////////////////////////////////////////////////
8352	-->
8353
8354	<interface
8355	name="ISnapshot" extends="$unknown"
8356	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8357	wsmap="managed"
8358	>
8359	<desc>
8360	The ISnapshot interface represents a snapshot of the virtual
8361	machine.
8362
8363	Together with the differencing media that are created
8364	when a snapshot is taken, a machine can be brought back to
8365	the exact state it was in when the snapshot was taken.
8366
8367	The ISnapshot interface has no methods, only attributes; snapshots
8368	are controlled through methods of the <link to="IConsole" /> interface
8369	which also manage the media associated with the snapshot.
8370	The following operations exist:
8371
8372	<ul>
8373	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8374	by creating new, empty differencing images for the machine's
8375	media and saving the VM settings and (if the VM is running)
8376	the current VM state in the snapshot.
8377
8378	The differencing images will then receive all data written to
8379	the machine's media, while their parent (base) images
8380	remain unmodified after the snapshot has been taken (see
8381	<link to="IMedium" /> for details about differencing images).
8382	This simplifies restoring a machine to the state of a snapshot:
8383	only the differencing images need to be deleted.
8384
8385	The current machine state is not changed by taking a snapshot.
8386	If the machine is running, it will resume execution after the
8387	snapshot has been taken.
8388	</li>
8389
8390	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8391	a previous snapshot. This resets the machine's state to that of
8392	the previous snapshot by deleting the differencing image of each
8393	of the machine's media and setting the machine's settings
8394	and state to the state that was saved in the snapshot (if any).
8395
8396	This destroys the machine's current state.
8397	</li>
8398
8399	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8400	without affecting the current machine state.
8401
8402	This does not change the machine, but instead frees the resources
8403	allocated when the snapshot was taken: the settings and machine state
8404	is deleted (if any), and the snapshot's differencing image for each
8405	of the machine's media gets merged with its parent image.
8406
8407	Neither the current machine state nor other snapshots are affected
8408	by this operation, except that parent media will be modified
8409	to contain the disk data associated with the snapshot being deleted.
8410	</li>
8411	</ul>
8412
8413	Each snapshot contains the settings of the virtual machine (hardware
8414	configuration etc.). In addition, if the machine was running when the
8415	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8416	the current VM state is saved in the snapshot (similarly to what happens
8417	when a VM's state is saved). The snapshot is then said to
8418	be <i>online</i> because when restoring it, the VM will be running.
8419
8420	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8421	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8422
8423	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8424	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8425	it then contains a so-called "zero execution state", representing a
8426	machine that is powered off.
8427
8428	<h3>Snapshot branches and the "current" snapshot</h3>
8429
8430	Snapshots can be chained, whereby every next snapshot is based on the
8431	previous one. This chaining is related to medium branching
8432	(see the <link to="IMedium"/> description) in that every time
8433	a new snapshot is created, a new differencing medium is implicitly
8434	created for all normal media attached to the machine.
8435
8436	Each virtual machine has a "current snapshot", identified by
8437	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8438	to the last snapshot in the chain. In a future version of VirtualBox,
8439	it will be possible to reset a machine's current state to that of an
8440	earlier snapshot without discarding the current state so that it will be
8441	possible to create alternative snapshot paths in a snapshot tree.
8442
8443	In the current implementation, multiple snapshot branches within one
8444	virtual machine are not allowed. Every machine has a single branch,
8445	and <link to="IConsole::takeSnapshot"/> operation adds a new
8446	snapshot to the top of that branch.
8447	</desc>
8448
8449	<attribute name="id" type="uuid" mod="string" readonly="yes">
8450	<desc>UUID of the snapshot.</desc>
8451	</attribute>
8452
8453	<attribute name="name" type="wstring">
8454	<desc>Short name of the snapshot.</desc>
8455	</attribute>
8456
8457	<attribute name="description" type="wstring">
8458	<desc>Optional description of the snapshot.</desc>
8459	</attribute>
8460
8461	<attribute name="timeStamp" type="long long" readonly="yes">
8462	<desc>
8463	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8464	</desc>
8465	</attribute>
8466
8467	<attribute name="online" type="boolean" readonly="yes">
8468	<desc>
8469	@c true if this snapshot is an online snapshot and @c false otherwise.
8470
8471	When this attribute is @c true, the
8472	<link to="IMachine::stateFilePath"/> attribute of the
8473	<link to="#machine"/> object associated with this snapshot
8474	will point to the saved state file. Otherwise, it will be
8475	an empty string.
8476	</desc>
8477	</attribute>
8478
8479	<attribute name="machine" type="IMachine" readonly="yes">
8480	<desc>
8481	Virtual machine this snapshot is taken on. This object
8482	stores all settings the machine had when taking this snapshot.
8483	<note>
8484	The returned machine object is immutable, i.e. no
8485	any settings can be changed.
8486	</note>
8487	</desc>
8488	</attribute>
8489
8490	<attribute name="parent" type="ISnapshot" readonly="yes">
8491	<desc>
8492	Parent snapshot (a snapshot this one is based on), or
8493	@c null if the snapshot has no parent (i.e. is the first snapshot).
8494	</desc>
8495	</attribute>
8496
8497	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8498	<desc>
8499	Child snapshots (all snapshots having this one as a parent).
8500	</desc>
8501	</attribute>
8502
8503	</interface>
8504
8505
8506	<!--
8507	// IMedium
8508	/////////////////////////////////////////////////////////////////////////
8509	-->
8510
8511	<enum
8512	name="MediumState"
8513	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8514	>
8515	<desc>
8516	Virtual medium state.
8517	<see>IMedium</see>
8518	</desc>
8519
8520	<const name="NotCreated" value="0">
8521	<desc>
8522	Associated medium storage does not exist (either was not created yet or
8523	was deleted).
8524	</desc>
8525	</const>
8526	<const name="Created" value="1">
8527	<desc>
8528	Associated storage exists and accessible; this gets set if the
8529	accessibility check performed by <link to="IMedium::refreshState" />
8530	was successful.
8531	</desc>
8532	</const>
8533	<const name="LockedRead" value="2">
8534	<desc>
8535	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8536	no data modification is possible.
8537	</desc>
8538	</const>
8539	<const name="LockedWrite" value="3">
8540	<desc>
8541	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8542	no concurrent data reading or modification is possible.
8543	</desc>
8544	</const>
8545	<const name="Inaccessible" value="4">
8546	<desc>
8547	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8548	not yet been performed, or else, associated medium storage is not
8549	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8550	is empty, in the second case, it describes the error that occured.
8551	</desc>
8552	</const>
8553	<const name="Creating" value="5">
8554	<desc>
8555	Associated medium storage is being created.
8556	</desc>
8557	</const>
8558	<const name="Deleting" value="6">
8559	<desc>
8560	Associated medium storage is being deleted.
8561	</desc>
8562	</const>
8563	</enum>
8564
8565	<enum
8566	name="MediumType"
8567	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8568	>
8569	<desc>
8570	Virtual medium type.
8571	<see>IMedium</see>
8572	</desc>
8573
8574	<const name="Normal" value="0">
8575	<desc>
8576	Normal medium (attached directly or indirectly, preserved
8577	when taking snapshots).
8578	</desc>
8579	</const>
8580	<const name="Immutable" value="1">
8581	<desc>
8582	Immutable medium (attached indirectly, changes are wiped out
8583	the next time the virtual machine is started).
8584	</desc>
8585	</const>
8586	<const name="Writethrough" value="2">
8587	<desc>
8588	Write through medium (attached directly, ignored when
8589	taking snapshots).
8590	</desc>
8591	</const>
8592	</enum>
8593
8594	<enum
8595	name="MediumVariant"
8596	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8597	>
8598	<desc>
8599	Virtual medium image variant. More than one flag may be set.
8600	<see>IMedium</see>
8601	</desc>
8602
8603	<const name="Standard" value="0">
8604	<desc>
8605	No particular variant requested, results in using the backend default.
8606	</desc>
8607	</const>
8608	<const name="VmdkSplit2G" value="0x01">
8609	<desc>
8610	VMDK image split in chunks of less than 2GByte.
8611	</desc>
8612	</const>
8613	<const name="VmdkStreamOptimized" value="0x04">
8614	<desc>
8615	VMDK streamOptimized image. Special import/export format which is
8616	read-only/append-only.
8617	</desc>
8618	</const>
8619	<const name="VmdkESX" value="0x08">
8620	<desc>
8621	VMDK format variant used on ESX products.
8622	</desc>
8623	</const>
8624	<const name="Fixed" value="0x10000">
8625	<desc>
8626	Fixed image. Only allowed for base images.
8627	</desc>
8628	</const>
8629	<const name="Diff" value="0x20000">
8630	<desc>
8631	Fixed image. Only allowed for base images.
8632	</desc>
8633	</const>
8634	</enum>
8635
8636	<interface
8637	name="IMediumAttachment" extends="$unknown"
8638	uuid="7bb6ac41-8c03-4863-9eea-d9c76561b8d1"
8639	wsmap="struct"
8640	>
8641	<desc>
8642	The IMediumAttachment interface represents the attachment
8643	of a storage medium to a virtual machine. Each machine contains
8644	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8645
8646	Each medium attachment specifies a storage controller as well as a port
8647	and device number. Fixed media (hard disks) will always also specify
8648	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8649	medium. For removeable media, the IMedia instance is optional; it can be
8650	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8651	</desc>
8652
8653	<attribute name="medium" type="IMedium" readonly="yes">
8654	<desc>Medium object associated with this attachment; it
8655	can be @c null for removable devices.</desc>
8656	</attribute>
8657
8658	<attribute name="controller" type="IStorageController" readonly="yes">
8659	<desc>Storage controller object to which this attachment belongs.</desc>
8660	</attribute>
8661
8662	<attribute name="port" type="long" readonly="yes">
8663	<desc>Port number of this attachment.</desc>
8664	</attribute>
8665
8666	<attribute name="device" type="long" readonly="yes">
8667	<desc>Device slot number of this attachment.</desc>
8668	</attribute>
8669
8670	<attribute name="type" type="DeviceType" readonly="yes">
8671	<desc>Device type of this attachment.</desc>
8672	</attribute>
8673
8674	<attribute name="passthrough" type="boolean" readonly="yes">
8675	<desc>Pass I/O requests through to a device on the host.</desc>
8676	</attribute>
8677
8678	</interface>
8679
8680	<interface
8681	name="IMedium" extends="$unknown"
8682	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
8683	wsmap="managed"
8684	>
8685	<desc>
8686	The IMedium interface represents virtual storage for a machine's
8687	hard disks, CD/DVD or floppy drives. It will typically represent
8688	a disk image on the host, for example a VDI or VMDK file representing
8689	a virtual hard disk, or an ISO or RAW file representing virtual
8690	removable media, but can also point to a network location (e.g.
8691	for iSCSI targets).
8692
8693	Instances of IMedium are connected to virtual machines by way of
8694	medium attachments (see <link to="IMediumAttachment" />), which link
8695	the storage medium to a particular device slot of a storage controller
8696	of the virtual machine.
8697	In the VirtualBox API, virtual storage is therefore always represented
8698	by the following chain of object links:
8699
8700	<ul>
8701	<li><link to="IMachine::storageControllers"/> contains an array of
8702	storage controllers (IDE, SATA, SCSI or a floppy controller;
8703	these are instances of <link to="IStorageController"/>).</li>
8704	<li><link to="IMachine::mediumAttachments"/> contains an array of
8705	medium attachments (instances of <link to="IMediumAttachment"/>),
8706	each containing a storage controller from the above array, a
8707	port/device specification, and an instance of IMedium representing
8708	the medium storage (image file).
8709
8710	For removable media, the storage medium is optional; a medium
8711	attachment with no medium represents a CD/DVD or floppy drive
8712	with no medium inserted. By contrast, hard disk attachments
8713	will always have an IMedium object attached.</li>
8714	<li>Each IMedium in turn points to a storage unit (such as a file
8715	on the host computer or a network resource) that holds actual
8716	data. This location is represented by the <link to="#location"/>
8717	attribute.</li>
8718	</ul>
8719
8720	Existing media are opened using the following methods, depending on the
8721	media type:
8722	<ul>
8723	<li><link to="IVirtualBox::openHardDisk"/></li>
8724	<li><link to="IVirtualBox::openDVDImage"/></li>
8725	<li><link to="IVirtualBox::openFloppyImage"/></li>
8726	</ul>
8727
8728	New hard disk media can be created with the VirtualBox API using the
8729	<link to="IVirtualBox::createHardDisk"/> method.
8730
8731	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8732	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8733	type in a regular file.
8734
8735	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8736	drive; in that case the <link to="#id" /> attribute contains the UUID of
8737	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8738
8739	<h3>Known media</h3>
8740
8741	When an existing medium is opened for the first time, it is automatically
8742	remembered by the given VirtualBox installation or, in other words, becomes
8743	a <i>known medium</i>. Known media are stored in the media
8744	registry transparently maintained by VirtualBox and stored in settings
8745	files so that this registry is preserved when VirtualBox is not running.
8746
8747	Newly created virtual media are remembered only when the associated
8748	storage unit is actually created.
8749
8750	All known media can be enumerated using
8751	<link to="IVirtualBox::hardDisks"/>,
8752	<link to="IVirtualBox::DVDImages"/> and
8753	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8754	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8755	and similar methods or by location using
8756	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8757
8758	Only known media can be attached to virtual machines.
8759
8760	Removing known media from the media registry is performed when the given
8761	medium is closed using the <link to="#close"/> method or when its
8762	associated storage unit is deleted.
8763
8764	<h3>Accessibility checks</h3>
8765
8766	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8767	method is called explicitly on a medium. This is done to make the VirtualBox object
8768	ready for serving requests as fast as possible and let the end-user
8769	application decide if it needs to check media accessibility right away or not.
8770
8771	As a result, when VirtualBox starts up (e.g. the VirtualBox
8772	object gets created for the first time), all known media are in the
8773	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8774	attribute is an empty string because no actual accessibility check has
8775	been made yet.
8776
8777	After calling <link to="#refreshState" />, a medium is considered
8778	<i>accessible</i> if its storage unit can be read. In that case, the
8779	<link to="#state"/> attribute has a value of "Created". If the storage
8780	unit cannot be read (for example, because it is located on a disconnected
8781	network resource, or was accidentally deleted outside VirtualBox),
8782	the medium is considered <i>inaccessible</i>, which is indicated by the
8783	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8784	obtained by reading the <link to="#lastAccessError"/> attribute.
8785
8786	<h3>Medium types</h3>
8787
8788	There are three types of medium behavior (see <link to="MediumType" />):
8789	"normal", "immutable" and "writethrough", represented by the
8790	<link to="#type"/> attribute. The type of the medium defines how the
8791	medium is attached to a virtual machine and what happens when a
8792	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8793	attached medium is taken. At the moment DVD and floppy media are always
8794	of type "writethrough".
8795
8796	All media can be also divided in two groups: <i>base</i> media and
8797	<i>differencing</i> media. A base medium contains all sectors of the
8798	medium data in its own storage and therefore can be used independently.
8799	In contrast, a differencing mediun is a "delta" to some other medium and
8800	contains only those sectors which differ from that other medium, which is
8801	then called a <i>parent</i>. The differencing medium is said to be
8802	<i>linked to</i> that parent. The parent may be itself a differencing
8803	medium, thus forming a chain of linked media. The last element in that
8804	chain must always be a base medium. Note that several differencing
8805	media may be linked to the same parent medium.
8806
8807	Differencing media can be distinguished from base media by querying the
8808	<link to="#parent"/> attribute: base media do not have parents they would
8809	depend on, so the value of this attribute is always @c null for them.
8810	Using this attribute, it is possible to walk up the medium tree (from the
8811	child medium to its parent). It is also possible to walk down the tree
8812	using the <link to="#children"/> attribute.
8813
8814	Note that the type of all differencing media is
8815	<link to="MediumType_Normal" />; all other values are meaningless for
8816	them. Base media may be of any type.
8817
8818	<h3>Creating hard disks</h3>
8819
8820	New base hard disks are created using
8821	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8822	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8823	disks are usually implicitly created by VirtualBox when needed but may
8824	also be created explicitly using <link to="#createDiffStorage"/>.
8825
8826	After the hard disk is successfully created (including the storage unit)
8827	or opened, it becomes a known hard disk (remembered in the internal media
8828	registry). Known hard disks can be attached to a virtual machine, accessed
8829	through <link to="IVirtualBox::getHardDisk"/> and
8830	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8831	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8832
8833	The following methods, besides <link to="IMedium::close"/>,
8834	automatically remove the hard disk from the media registry:
8835	<ul>
8836	<li><link to="#deleteStorage"/></li>
8837	<li><link to="#mergeTo"/></li>
8838	</ul>
8839
8840	If the storage unit of the hard disk is a regular file in the host's
8841	file system then the rules stated in the description of the
8842	<link to="IMedium::location"/> attribute apply when setting its value. In
8843	addition, a plain file name without any path may be given, in which case
8844	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8845	folder</link> will be prepended to it.
8846
8847	<h4>Automatic composition of the file name part</h4>
8848
8849	Another extension to the <link to="IMedium::location"/> attribute is that
8850	there is a possibility to cause VirtualBox to compose a unique value for
8851	the file name part of the location using the UUID of the hard disk. This
8852	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8853	e.g. before the storage unit is created, and works as follows. You set the
8854	value of the <link to="IMedium::location"/> attribute to a location
8855	specification which only contains the path specification but not the file
8856	name part and ends with either a forward slash or a backslash character.
8857	In response, VirtualBox will generate a new UUID for the hard disk and
8858	compose the file name using the following pattern:
8859	<pre>
8860	<path>/{<uuid>}.<ext>
8861	</pre>
8862	where <tt><path></tt> is the supplied path specification,
8863	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8864	is the default extension for the storage format of this hard disk. After
8865	that, you may call any of the methods that create a new hard disk storage
8866	unit and they will use the generated UUID and file name.
8867
8868	<h3>Attaching Hard Disks</h3>
8869
8870	Hard disks are attached to virtual machines using the
8871	<link to="IMachine::attachDevice"/> method and detached using the
8872	<link to="IMachine::detachDevice"/> method. Depending on their
8873	<link to="#type"/>, hard disks are attached either
8874	<i>directly</i> or <i>indirectly</i>.
8875
8876	When a hard disk is being attached directly, it is associated with the
8877	virtual machine and used for hard disk operations when the machine is
8878	running. When a hard disk is being attached indirectly, a new differencing
8879	hard disk linked to it is implicitly created and this differencing hard
8880	disk is associated with the machine and used for hard disk operations.
8881	This also means that if <link to="IMachine::attachDevice"/> performs
8882	a direct attachment then the same hard disk will be returned in response
8883	to the subsequent <link to="IMachine::getMedium"/> call; however if
8884	an indirect attachment is performed then
8885	<link to="IMachine::getMedium"/> will return the implicitly created
8886	differencing hard disk, not the original one passed to <link
8887	to="IMachine::attachDevice"/>. In detail:
8888
8889	<ul>
8890	<li><b>Normal base</b> hard disks that do not have children (i.e.
8891	differencing hard disks linked to them) and that are not already
8892	attached to virtual machines in snapshots are attached <b>directly</b>.
8893	Otherwise, they are attached <b>indirectly</b> because having
8894	dependent children or being part of the snapshot makes it impossible
8895	to modify hard disk contents without breaking the integrity of the
8896	dependent party. The <link to="#readOnly"/> attribute allows to
8897	quickly determine the kind of the attachment for the given hard
8898	disk. Note that if a normal base hard disk is to be indirectly
8899	attached to a virtual machine with snapshots then a special
8900	procedure called <i>smart attachment</i> is performed (see below).</li>
8901	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8902	they are attached <b>directly</b> if they do not have children and are
8903	not attached to virtual machines in snapshots, and <b>indirectly</b>
8904	otherwise. Note that the smart attachment procedure is never performed
8905	for differencing hard disks.</li>
8906	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8907	they are designed to be non-writable. If an immutable hard disk is
8908	attached to a virtual machine with snapshots then a special
8909	procedure called smart attachment is performed (see below).</li>
8910	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8911	also as designed. This also means that writethrough hard disks cannot
8912	have other hard disks linked to them at all.</li>
8913	</ul>
8914
8915	Note that the same hard disk, regardless of its type, may be attached to
8916	more than one virtual machine at a time. In this case, the machine that is
8917	started first gains exclusive access to the hard disk and attempts to
8918	start other machines having this hard disk attached will fail until the
8919	first machine is powered down.
8920
8921	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8922	that the given hard disk remains associated with the given machine after a
8923	successful <link to="IMachine::detachDevice"/> call until
8924	<link to="IMachine::saveSettings"/> is called to save all changes to
8925	machine settings to disk. This deferring is necessary to guarantee that
8926	the hard disk configuration may be restored at any time by a call to
8927	<link to="IMachine::discardSettings"/> before the settings
8928	are saved (committed).
8929
8930	Note that if <link to="IMachine::discardSettings"/> is called after
8931	indirectly attaching some hard disks to the machine but before a call to
8932	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8933	all differencing hard disks implicitly created by
8934	<link to="IMachine::attachDevice"/> for these indirect attachments.
8935	Such implicitly created hard disks will also be immediately deleted when
8936	detached explicitly using the <link to="IMachine::detachDevice"/>
8937	call if it is made before <link to="IMachine::saveSettings"/>. This
8938	implicit deletion is safe because newly created differencing hard
8939	disks do not contain any user data.
8940
8941	However, keep in mind that detaching differencing hard disks that were
8942	implicitly created by <link to="IMachine::attachDevice"/>
8943	before the last <link to="IMachine::saveSettings"/> call will
8944	<b>not</b> implicitly delete them as they may already contain some data
8945	(for example, as a result of virtual machine execution). If these hard
8946	disks are no more necessary, the caller can always delete them explicitly
8947	using <link to="#deleteStorage"/> after they are actually de-associated
8948	from this machine by the <link to="IMachine::saveSettings"/> call.
8949
8950	<h3>Smart Attachment</h3>
8951
8952	When normal base or immutable hard disks are indirectly attached to a
8953	virtual machine then some additional steps are performed to make sure the
8954	virtual machine will have the most recent "view" of the hard disk being
8955	attached. These steps include walking through the machine's snapshots
8956	starting from the current one and going through ancestors up to the first
8957	snapshot. Hard disks attached to the virtual machine in all
8958	of the encountered snapshots are checked whether they are descendants of
8959	the given normal base or immutable hard disk. The first found child (which
8960	is the differencing hard disk) will be used instead of the normal base or
8961	immutable hard disk as a parent for creating a new differencing hard disk
8962	that will be actually attached to the machine. And only if no descendants
8963	are found or if the virtual machine does not have any snapshots then the
8964	normal base or immutable hard disk will be used itself as a parent for
8965	this differencing hard disk.
8966
8967	It is easier to explain what smart attachment does using the
8968	following example:
8969	<pre>
8970	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8971
8972	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8973	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8974	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8975	Snapshot 4 (none) Snapshot 4 (none)
8976	CurState (none) CurState (D3->D2.vdi)
8977
8978	NOT
8979	...
8980	CurState (D3->B.vdi)
8981	</pre>
8982	The first column is the virtual machine configuration before the base hard
8983	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8984	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8985	mean that the hard disk that is actually attached to the machine is a
8986	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8987	another hard disk, <tt>B.vdi</tt>.
8988
8989	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8990	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8991	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8992	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8993	it cannot be attached directly and needs an indirect attachment (i.e.
8994	implicit creation of a new differencing hard disk). Due to the smart
8995	attachment procedure, the new differencing hard disk
8996	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8997	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8998	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8999	machine.
9000
9001	Note that if there is more than one descendant hard disk of the given base
9002	hard disk found in a snapshot, and there is an exact device, channel and
9003	bus match, then this exact match will be used. Otherwise, the youngest
9004	descendant will be picked up.
9005
9006	There is one more important aspect of the smart attachment procedure which
9007	is not related to snapshots at all. Before walking through the snapshots
9008	as described above, the backup copy of the current list of hard disk
9009	attachment is searched for descendants. This backup copy is created when
9010	the hard disk configuration is changed for the first time after the last
9011	<link to="IMachine::saveSettings"/> call and used by
9012	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9013	changes. When such a descendant is found in this backup copy, it will be
9014	simply re-attached back, without creating a new differencing hard disk for
9015	it. This optimization is necessary to make it possible to re-attach the
9016	base or immutable hard disk to a different bus, channel or device slot
9017	without losing the contents of the differencing hard disk actually
9018	attached to the machine in place of it.
9019	</desc>
9020
9021	<attribute name="id" type="uuid" mod="string" readonly="yes">
9022	<desc>
9023	UUID of the medium. For a newly created medium, this value is a randomly
9024	generated UUID.
9025
9026	<note>
9027	For media in one of MediumState_NotCreated, MediumState_Creating or
9028	MediumState_Deleting states, the value of this property is undefined
9029	and will most likely be an empty UUID.
9030	</note>
9031	</desc>
9032	</attribute>
9033
9034	<attribute name="description" type="wstring">
9035	<desc>
9036	Optional description of the medium. For a newly created medium the value
9037	of this attribute is an empty string.
9038
9039	Medium types that don't support this attribute will return E_NOTIMPL in
9040	attempt to get or set this attribute's value.
9041
9042	<note>
9043	For some storage types, reading this attribute may return an outdated
9044	(last known) value when <link to="#state"/> is <link
9045	to="MediumState_Inaccessible"/> or <link
9046	to="MediumState_LockedWrite"/> because the value of this attribute is
9047	stored within the storage unit itself. Also note that changing the
9048	attribute value is not possible in such case, as well as when the
9049	medium is the <link to="MediumState_LockedRead"/> state.
9050	</note>
9051	</desc>
9052	</attribute>
9053
9054	<attribute name="state" type="MediumState" readonly="yes">
9055	<desc>
9056	Returns the current medium state, which is the last state set by
9057	the accessibility check performed by <link to="#refreshState"/>.
9058	If that method has not yet been called on the medium, the state
9059	is "Inaccessible"; as opposed to truly inaccessible media, the
9060	value of <link to="#lastAccessError"/> will be an empty string in
9061	that case.
9062
9063	<note>As of version 3.1, this no longer performs an accessibility check
9064	automatically; call <link to="#refreshState"/> for that.
9065	</note>
9066	</desc>
9067	</attribute>
9068
9069	<attribute name="location" type="wstring">
9070	<desc>
9071	Location of the storage unit holding medium data.
9072
9073	The format of the location string is medium type specific. For medium
9074	types using regular files in a host's file system, the location
9075	string is the full file name.
9076
9077	Some medium types may support changing the storage unit location by
9078	simply changing the value of this property. If this operation is not
9079	supported, the implementation will return E_NOTIMPL in attempt to set
9080	this attribute's value.
9081
9082	When setting a value of the location attribute which is a regular file
9083	in the host's file system, the given file name may be either relative to
9084	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9085	absolute. Note that if the given location specification does not contain
9086	the file extension part then a proper default extension will be
9087	automatically appended by the implementation depending on the medium type.
9088	</desc>
9089	</attribute>
9090
9091	<attribute name="name" type="wstring" readonly="yes">
9092	<desc>
9093	Name of the storage unit holding medium data.
9094
9095	The returned string is a short version of the <link to="#location"/>
9096	attribute that is suitable for representing the medium in situations
9097	where the full location specification is too long (such as lists
9098	and comboboxes in GUI frontends). This string is also used by frontends
9099	to sort the media list alphabetically when needed.
9100
9101	For example, for locations that are regular files in the host's file
9102	system, the value of this attribute is just the file name (+ extension),
9103	without the path specification.
9104
9105	Note that as opposed to the <link to="#location"/> attribute, the name
9106	attribute will not necessary be unique for a list of media of the
9107	given type and format.
9108	</desc>
9109	</attribute>
9110
9111	<attribute name="deviceType" type="DeviceType" readonly="yes">
9112	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9113	medium.</desc>
9114	</attribute>
9115
9116	<attribute name="hostDrive" type="boolean" readonly="yes">
9117	<desc>True if this corresponds to a drive on the host.</desc>
9118	</attribute>
9119
9120	<attribute name="size" type="unsigned long long" readonly="yes">
9121	<desc>
9122	Physical size of the storage unit used to hold medium data (in bytes).
9123
9124	<note>
9125	For media whose <link to="#state"/> is <link
9126	to="MediumState_Inaccessible"/>, the value of this property is the
9127	last known size. For <link to="MediumState_NotCreated"/> media,
9128	the returned value is zero.
9129	</note>
9130	</desc>
9131	</attribute>
9132
9133	<attribute name="format" type="wstring" readonly="yes">
9134	<desc>
9135	Storage format of this medium.
9136
9137	The value of this attribute is a string that specifies a backend used
9138	to store medium data. The storage format is defined when you create a
9139	new medium or automatically detected when you open an existing medium,
9140	and cannot be changed later.
9141
9142	The list of all storage formats supported by this VirtualBox
9143	installation can be obtained using
9144	<link to="ISystemProperties::mediumFormats"/>.
9145	</desc>
9146	</attribute>
9147
9148	<attribute name="type" type="MediumType">
9149	<desc>
9150	Type (role) of this medium.
9151
9152	The following constraints apply when changing the value of this
9153	attribute:
9154	<ul>
9155	<li>If a medium is attached to a virtual machine (either in the
9156	current state or in one of the snapshots), its type cannot be
9157	changed.
9158	</li>
9159	<li>As long as the medium has children, its type cannot be set
9160	to <link to="MediumType_Writethrough"/>.
9161	</li>
9162	<li>The type of all differencing media is
9163	<link to="MediumType_Normal"/> and cannot be changed.
9164	</li>
9165	</ul>
9166
9167	The type of a newly created or opened medium is set to
9168	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9169	which have a type of <link to="MediumType_Writethrough"/>.
9170	</desc>
9171	</attribute>
9172
9173	<attribute name="parent" type="IMedium" readonly="yes">
9174	<desc>
9175	Parent of this medium (the medium this medium is directly based
9176	on).
9177
9178	Only differencing media have parents. For base (non-differencing)
9179	media, @c null is returned.
9180	</desc>
9181	</attribute>
9182
9183	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9184	<desc>
9185	Children of this medium (all differencing media directly based
9186	on this medium). A @c null array is returned if this medium
9187	does not have any children.
9188	</desc>
9189	</attribute>
9190
9191	<attribute name="base" type="IMedium" readonly="yes">
9192	<desc>
9193	Base medium of this medium.
9194
9195	If this is a differencing medium, its base medium is the medium
9196	the given medium branch starts from. For all other types of media, this
9197	property returns the medium object itself (i.e. the same object this
9198	property is read on).
9199	</desc>
9200	</attribute>
9201
9202	<attribute name="readOnly" type="boolean" readonly="yes">
9203	<desc>
9204	Returns @c true if this medium is read-only and @c false otherwise.
9205
9206	A medium is considered to be read-only when its contents cannot be
9207	modified without breaking the integrity of other parties that depend on
9208	this medium such as its child media or snapshots of virtual machines
9209	where this medium is attached to these machines. If there are no
9210	children and no such snapshots then there is no dependency and the
9211	medium is not read-only.
9212
9213	The value of this attribute can be used to determine the kind of the
9214	attachment that will take place when attaching this medium to a
9215	virtual machine. If the value is @c false then the medium will
9216	be attached directly. If the value is @c true then the medium
9217	will be attached indirectly by creating a new differencing child
9218	medium for that. See the interface description for more information.
9219
9220	Note that all <link to="MediumType_Immutable">Immutable</link> media
9221	are always read-only while all
9222	<link to="MediumType_Writethrough">Writethrough</link> media are
9223	always not.
9224
9225	<note>
9226	The read-only condition represented by this attribute is related to
9227	the medium type and usage, not to the current
9228	<link to="IMedium::state">medium state</link> and not to the read-only
9229	state of the storage unit.
9230	</note>
9231	</desc>
9232	</attribute>
9233
9234	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9235	<desc>
9236	Logical size of this medium (in megabytes), as reported to the
9237	guest OS running inside the virtual machine this medium is
9238	attached to. The logical size is defined when the medium is created
9239	and cannot be changed later.
9240
9241	<note>
9242	Reading this property on a differencing medium will return the size
9243	of its <link to="#base"/> medium.
9244	</note>
9245	<note>
9246	For media whose state is <link to="#state"/> is <link
9247	to="MediumState_Inaccessible"/>, the value of this property is the
9248	last known logical size. For <link to="MediumaState_NotCreated"/>
9249	media, the returned value is zero.
9250	</note>
9251	</desc>
9252	</attribute>
9253
9254	<attribute name="autoReset" type="boolean">
9255	<desc>
9256	Whether this differencing medium will be automatically reset each
9257	time a virtual machine it is attached to is powered up.
9258
9259	See <link to="#reset()"/> for more information about resetting
9260	differencing media.
9261
9262	<note>
9263	Reading this property on a base (non-differencing) medium will
9264	always @c false. Changing the value of this property in this
9265	case is not supported.
9266	</note>
9267
9268	<result name="VBOX_E_NOT_SUPPORTED">
9269	This is not a differencing medium (when changing the attribute
9270	value).
9271	</result>
9272	</desc>
9273	</attribute>
9274
9275	<attribute name="lastAccessError" type="wstring" readonly="yes">
9276	<desc>
9277	Text message that represents the result of the last accessibility
9278	check performed by <link to="#refreshState"/>.
9279
9280	An empty string is returned if the last accessibility check
9281	was successful or has not yet been called. As a result, if
9282	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9283	then <link to="#refreshState"/> has yet to be called; this is the
9284	default value of media after VirtualBox initialization.
9285	A non-empty string indicates a failure and should normally describe
9286	a reason of the failure (for example, a file read error).
9287	</desc>
9288	</attribute>
9289
9290	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9291	<desc>
9292	Array of UUIDs of all machines this medium is attached to.
9293
9294	A @c null array is returned if this medium is not attached to any
9295	machine or to any machine's snapshot.
9296
9297	<note>
9298	The returned array will include a machine even if this medium is not
9299	attached to that machine in the current state but attached to it in
9300	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9301	details.
9302	</note>
9303	</desc>
9304	</attribute>
9305
9306	<method name="refreshState">
9307	<desc>
9308	If the current medium state (see <link to="MediumState"/>) is one of
9309	"Created", "Inaccessible" or "LockedRead", then this performs an
9310	accessibility check on the medium and sets the value of the <link to="#state"/>
9311	attribute accordingly; that value is also returned for convenience.
9312
9313	For all other state values, this does not perform a refresh but returns
9314	the state only.
9315
9316	The refresh, if performed, may take a long time (several seconds or even
9317	minutes, depending on the storage unit location and format) because it performs an
9318	accessibility check of the storage unit. This check may cause a significant
9319	delay if the storage unit of the given medium is, for example, a file located
9320	on a network share which is not currently accessible due to connectivity
9321	problems. In that case, the call will not return until a timeout
9322	interval defined by the host OS for this operation expires. For this reason,
9323	it is recommended to never read this attribute on the main UI thread to avoid
9324	making the UI unresponsive.
9325
9326	If the last known state of the medium is "Created" and the accessibility
9327	check fails, then the state would be set to "Inaccessible", and
9328	<link to="#lastAccessError"/> may be used to get more details about the
9329	failure. If the state of the medium is "LockedRead", then it remains the
9330	same, and a non-empty value of <link to="#lastAccessError"/> will
9331	indicate a failed accessibility check in this case.
9332
9333	Note that not all medium states are applicable to all medium types.
9334	</desc>
9335	<param name="state" type="MediumState" dir="return">
9336	<desc>
9337	New medium state.
9338	</desc>
9339	</param>
9340	</method>
9341
9342	<method name="getSnapshotIds">
9343	<desc>
9344	Returns an array of UUIDs of all snapshots of the given machine where
9345	this medium is attached to.
9346
9347	If the medium is attached to the machine in the current state, then the
9348	first element in the array will always be the ID of the queried machine
9349	(i.e. the value equal to the @c machineId argument), followed by
9350	snapshot IDs (if any).
9351
9352	If the medium is not attached to the machine in the current state, then
9353	the array will contain only snapshot IDs.
9354
9355	The returned array may be @c null if this medium is not attached
9356	to the given machine at all, neither in the current state nor in one of
9357	the snapshots.
9358	</desc>
9359	<param name="machineId" type="uuid" mod="string" dir="in">
9360	<desc>
9361	UUID of the machine to query.
9362	</desc>
9363	</param>
9364	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9365	<desc>
9366	Array of snapshot UUIDs of the given machine using this medium.
9367	</desc>
9368	</param>
9369	</method>
9370
9371	<method name="lockRead">
9372	<desc>
9373	Locks this medium for reading.
9374
9375	A read lock is shared: many clients can simultaneously lock the
9376	same medium for reading unless it is already locked for writing (see
9377	<link to="#lockWrite"/>) in which case an error is returned.
9378
9379	When the medium is locked for reading, it cannot be modified
9380	from within VirtualBox. This means that any method that changes
9381	the properties of this medium or contents of the storage unit
9382	will return an error (unless explicitly stated otherwise). That
9383	includes an attempt to start a virtual machine that wants to
9384	write to the the medium.
9385
9386	When the virtual machine is started up, it locks for reading all
9387	media it uses in read-only mode. If some medium cannot be locked
9388	for reading, the startup procedure will fail.
9389	A medium is typically locked for reading while it is used by a running
9390	virtual machine but has a depending differencing image that receives
9391	the actual write operations. This way one base medium can have
9392	multiple child differencing images which can be written to
9393	simultaneously. Read-only media such as DVD and floppy images are
9394	also locked for reading only (so they can be in use by multiple
9395	machines simultaneously).
9396
9397	A medium is also locked for reading when it is the source of a
9398	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9399
9400	The medium locked for reading must be unlocked using the <link
9401	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9402	can be nested and must be followed by the same number of paired
9403	<link to="#unlockRead"/> calls.
9404
9405	This method sets the medium state (see <link to="#state"/>) to
9406	"LockedRead" on success. The medium's previous state must be
9407	one of "Created", "Inaccessible" or "LockedRead".
9408
9409	Locking an inaccessible medium is not an error; this method performs
9410	a logical lock that prevents modifications of this medium through
9411	the VirtualBox API, not a physical file-system lock of the underlying
9412	storage unit.
9413
9414	This method returns the current state of the medium
9415	<i>before</i> the operation.
9416
9417	<result name="VBOX_E_INVALID_OBJECT_STATE">
9418	Invalid medium state (e.g. not created, locked, inaccessible,
9419	creating, deleting).
9420	</result>
9421
9422	</desc>
9423	<param name="state" type="MediumState" dir="return">
9424	<desc>
9425	State of the medium after the operation.
9426	</desc>
9427	</param>
9428	</method>
9429
9430	<method name="unlockRead">
9431	<desc>
9432	Cancels the read lock previously set by <link to="#lockRead"/>.
9433
9434	For both success and failure, this method returns the current state
9435	of the medium <i>after</i> the operation.
9436
9437	See <link to="#lockRead"/> for more details.
9438
9439	<result name="VBOX_E_INVALID_OBJECT_STATE">
9440	Medium not locked for reading.
9441	</result>
9442
9443	</desc>
9444	<param name="state" type="MediumState" dir="return">
9445	<desc>
9446	State of the medium after the operation.
9447	</desc>
9448	</param>
9449	</method>
9450
9451	<method name="lockWrite">
9452	<desc>
9453	Locks this medium for writing.
9454
9455	A write lock, as opposed to <link to="#lockRead"/>, is
9456	exclusive: there may be only one client holding a write lock,
9457	and there may be no read locks while the write lock is held.
9458	As a result, read-locking fails if a write lock is held, and
9459	write-locking fails if either a read or another write lock is held.
9460
9461	When a medium is locked for writing, it cannot be modified
9462	from within VirtualBox, and it is not guaranteed that the values
9463	of its properties are up-to-date. Any method that changes the
9464	properties of this medium or contents of the storage unit will
9465	return an error (unless explicitly stated otherwise).
9466
9467	When a virtual machine is started up, it locks for writing all
9468	media it uses to write data to. If any medium could not be locked
9469	for writing, the startup procedure will fail. If a medium has
9470	differencing images, then while the machine is running, only
9471	the last ("leaf") differencing image is locked for writing,
9472	whereas its parents are locked for reading only.
9473
9474	A medium is also locked for writing when it is the target of a
9475	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9476
9477	The medium locked for writing must be unlocked using the <link
9478	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9479
9480	This method sets the medium state (see <link to="#state"/>) to
9481	"LockedWrite" on success. The medium's previous state must be
9482	either "Created" or "Inaccessible".
9483
9484	Locking an inaccessible medium is not an error; this method performs
9485	a logical lock that prevents modifications of this medium through
9486	the VirtualBox API, not a physical file-system lock of the underlying
9487	storage unit.
9488
9489	For both, success and failure, this method returns the current
9490	state of the medium <i>before</i> the operation.
9491
9492	<result name="VBOX_E_INVALID_OBJECT_STATE">
9493	Invalid medium state (e.g. not created, locked, inaccessible,
9494	creating, deleting).
9495	</result>
9496
9497	</desc>
9498	<param name="state" type="MediumState" dir="return">
9499	<desc>
9500	State of the medium after the operation.
9501	</desc>
9502	</param>
9503	</method>
9504
9505	<method name="unlockWrite">
9506	<desc>
9507	Cancels the write lock previously set by <link to="#lockWrite"/>.
9508
9509	For both success and failure, this method returns the current
9510	state of the medium <i>after</i> the operation.
9511
9512	See <link to="#lockWrite"/> for more details.
9513
9514	<result name="VBOX_E_INVALID_OBJECT_STATE">
9515	Medium not locked for writing.
9516	</result>
9517
9518	</desc>
9519	<param name="state" type="MediumState" dir="return">
9520	<desc>
9521	State of the medium after the operation.
9522	</desc>
9523	</param>
9524	</method>
9525
9526	<method name="close">
9527	<desc>
9528	Closes this medium.
9529
9530	The medium must not be attached to any known virtual machine
9531	and must not have any known child media, otherwise the
9532	operation will fail.
9533
9534	When the medium is successfully closed, it gets removed from
9535	the list of remembered media, but its storage unit is not
9536	deleted. In particular, this means that this medium can be
9537	later opened again using the <link
9538	to="IVirtualBox::openHardDisk"/> call.
9539
9540	Note that after this method successfully returns, the given medium
9541	object becomes uninitialized. This means that any attempt
9542	to call any of its methods or attributes will fail with the
9543	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9544
9545	<result name="VBOX_E_INVALID_OBJECT_STATE">
9546	Invalid medium state (other than not created, created or
9547	inaccessible).
9548	</result>
9549	<result name="VBOX_E_OBJECT_IN_USE">
9550	Medium attached to virtual machine.
9551	</result>
9552	<result name="VBOX_E_FILE_ERROR">
9553	Settings file not accessible.
9554	</result>
9555	<result name="VBOX_E_XML_ERROR">
9556	Could not parse the settings file.
9557	</result>
9558
9559	</desc>
9560	</method>
9561
9562	<!-- storage methods -->
9563
9564	<method name="getProperty">
9565	<desc>
9566	Returns the value of the custom medium property with the given name.
9567
9568	The list of all properties supported by the given medium format can
9569	be obtained with <link to="IMediumFormat::describeProperties"/>.
9570
9571	Note that if this method returns an empty string in @a value, the
9572	requested property is supported but currently not assigned any value.
9573
9574	<result name="VBOX_E_OBJECT_NOT_FOUND">
9575	Requested property does not exist (not supported by the format).
9576	</result>
9577	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9578	</desc>
9579	<param name="name" type="wstring" dir="in">
9580	<desc>Name of the property to get.</desc>
9581	</param>
9582	<param name="value" type="wstring" dir="return">
9583	<desc>Current property value.</desc>
9584	</param>
9585	</method>
9586
9587	<method name="setProperty">
9588	<desc>
9589	Sets the value of the custom medium property with the given name.
9590
9591	The list of all properties supported by the given medium format can
9592	be obtained with <link to="IMediumFormat::describeProperties"/>.
9593
9594	Note that setting the property value to @c null or an empty string is
9595	equivalent to deleting the existing value. A default value (if it is
9596	defined for this property) will be used by the format backend in this
9597	case.
9598
9599	<result name="VBOX_E_OBJECT_NOT_FOUND">
9600	Requested property does not exist (not supported by the format).
9601	</result>
9602	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9603	</desc>
9604	<param name="name" type="wstring" dir="in">
9605	<desc>Name of the property to set.</desc>
9606	</param>
9607	<param name="value" type="wstring" dir="in">
9608	<desc>Property value to set.</desc>
9609	</param>
9610	</method>
9611
9612	<method name="getProperties">
9613	<desc>
9614	Returns values for a group of properties in one call.
9615
9616	The names of the properties to get are specified using the @a names
9617	argument which is a list of comma-separated property names or
9618	an empty string if all properties are to be returned. Note that currently
9619	the value of this argument is ignored and the method always returns all
9620	existing properties.
9621
9622	The list of all properties supported by the given medium format can
9623	be obtained with <link to="IMediumFormat::describeProperties"/>.
9624
9625	The method returns two arrays, the array of property names corresponding
9626	to the @a names argument and the current values of these properties.
9627	Both arrays have the same number of elements with each elemend at the
9628	given index in the first array corresponds to an element at the same
9629	index in the second array.
9630
9631	Note that for properties that do not have assigned values,
9632	an empty string is returned at the appropriate index in the
9633	@a returnValues array.
9634
9635	</desc>
9636	<param name="names" type="wstring" dir="in">
9637	<desc>
9638	Names of properties to get.
9639	</desc>
9640	</param>
9641	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9642	<desc>Names of returned properties.</desc>
9643	</param>
9644	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9645	<desc>Values of returned properties.</desc>
9646	</param>
9647	</method>
9648
9649	<method name="setProperties">
9650	<desc>
9651	Sets values for a group of properties in one call.
9652
9653	The names of the properties to set are passed in the @a names
9654	array along with the new values for them in the @a values array. Both
9655	arrays have the same number of elements with each elemend at the given
9656	index in the first array corresponding to an element at the same index
9657	in the second array.
9658
9659	If there is at least one property name in @a names that is not valid,
9660	the method will fail before changing the values of any other properties
9661	from the @a names array.
9662
9663	Using this method over <link to="#setProperty"/> is preferred if you
9664	need to set several properties at once since it will result into less
9665	IPC calls.
9666
9667	The list of all properties supported by the given medium format can
9668	be obtained with <link to="IMediumFormat::describeProperties"/>.
9669
9670	Note that setting the property value to @c null or an empty string is
9671	equivalent to deleting the existing value. A default value (if it is
9672	defined for this property) will be used by the format backend in this
9673	case.
9674	</desc>
9675	<param name="names" type="wstring" safearray="yes" dir="in">
9676	<desc>Names of properties to set.</desc>
9677	</param>
9678	<param name="values" type="wstring" safearray="yes" dir="in">
9679	<desc>Values of properties to set.</desc>
9680	</param>
9681	</method>
9682
9683	<!-- storage methods -->
9684
9685	<method name="createBaseStorage">
9686	<desc>
9687	Starts creating a hard disk storage unit (fixed/dynamic, according
9688	to the variant flags) in in the background. The previous storage unit
9689	created for this object, if any, must first be deleted using
9690	<link to="#deleteStorage"/>, otherwise the operation will fail.
9691
9692	Before the operation starts, the medium is placed in
9693	<link to="MediumState_Creating"/> state. If the create operation
9694	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9695	state.
9696
9697	After the returned progress object reports that the operation has
9698	successfully completed, the medium state will be set to <link
9699	to="MediumState_Created"/>, the medium will be remembered by this
9700	VirtualBox installation and may be attached to virtual machines.
9701
9702	<result name="VBOX_E_NOT_SUPPORTED">
9703	The variant of storage creation operation is not supported. See <link
9704	to="IMediumFormat::capabilities"/>.
9705	</result>
9706	</desc>
9707	<param name="logicalSize" type="unsigned long long" dir="in">
9708	<desc>Maximum logical size of the medium in megabytes.</desc>
9709	</param>
9710	<param name="variant" type="MediumVariant" dir="in">
9711	<desc>Exact image variant which should be created.</desc>
9712	</param>
9713	<param name="progress" type="IProgress" dir="return">
9714	<desc>Progress object to track the operation completion.</desc>
9715	</param>
9716	</method>
9717
9718	<method name="deleteStorage">
9719	<desc>
9720	Starts deleting the storage unit of this medium.
9721
9722	The medium must not be attached to any known virtual machine and must
9723	not have any known child media, otherwise the operation will fail.
9724	It will also fail if there is no storage unit to delete or if deletion
9725	is already in progress, or if the medium is being in use (locked for
9726	read or for write) or inaccessible. Therefore, the only valid state for
9727	this operation to succeed is <link to="MediumState_Created"/>.
9728
9729	Before the operation starts, the medium is placed in
9730	<link to="MediumState_Deleting"/> state and gets removed from the list
9731	of remembered hard disks (media registry). If the delete operation
9732	fails, the medium will be remembered again and placed back to
9733	<link to="MediumState_Created"/> state.
9734
9735	After the returned progress object reports that the operation is
9736	complete, the medium state will be set to
9737	<link to="MediumState_NotCreated"/> and you will be able to use one of
9738	the storage creation methods to create it again.
9739
9740	<see>#close()</see>
9741
9742	<result name="VBOX_E_OBJECT_IN_USE">
9743	Medium is attached to a virtual machine.
9744	</result>
9745	<result name="VBOX_E_NOT_SUPPORTED">
9746	Storage deletion is not allowed because neither of storage creation
9747	operations are supported. See
9748	<link to="IMediumFormat::capabilities"/>.
9749	</result>
9750
9751	<note>
9752	If the deletion operation fails, it is not guaranteed that the storage
9753	unit still exists. You may check the <link to="IMedium::state"/> value
9754	to answer this question.
9755	</note>
9756	</desc>
9757	<param name="progress" type="IProgress" dir="return">
9758	<desc>Progress object to track the operation completion.</desc>
9759	</param>
9760	</method>
9761
9762	<!-- diff methods -->
9763
9764	<method name="createDiffStorage">
9765	<desc>
9766	Starts creating an empty differencing storage unit based on this
9767	medium in the format and at the location defined by the @a target
9768	argument.
9769
9770	The target medium must be in <link to="MediumState_NotCreated"/>
9771	state (i.e. must not have an existing storage unit). Upon successful
9772	completion, this operation will set the type of the target medium to
9773	<link to="MediumType_Normal"/> and create a storage unit necessary to
9774	represent the differencing medium data in the given format (according
9775	to the storage format of the target object).
9776
9777	After the returned progress object reports that the operation is
9778	successfully complete, the target medium gets remembered by this
9779	VirtualBox installation and may be attached to virtual machines.
9780
9781	<note>
9782	The medium will be set to <link to="MediumState_LockedRead"/>
9783	state for the duration of this operation.
9784	</note>
9785	<result name="VBOX_E_OBJECT_IN_USE">
9786	Medium not in @c NotCreated state.
9787	</result>
9788	</desc>
9789	<param name="target" type="IMedium" dir="in">
9790	<desc>Target medium.</desc>
9791	</param>
9792	<param name="variant" type="MediumVariant" dir="in">
9793	<desc>Exact image variant which should be created.</desc>
9794	</param>
9795	<param name="progress" type="IProgress" dir="return">
9796	<desc>Progress object to track the operation completion.</desc>
9797	</param>
9798	</method>
9799
9800	<method name="mergeTo">
9801	<desc>
9802	Starts merging the contents of this medium and all intermediate
9803	differencing media in the chain to the given target medium.
9804
9805	The target medium must be either a descendant of this medium or
9806	its ancestor (otherwise this method will immediately return a failure).
9807	It follows that there are two logical directions of the merge operation:
9808	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9809	ancestor (<i>backward merge</i>). Let us consider the following medium
9810	chain:
9811
9812	<pre>Base <- Diff_1 <- Diff_2</pre>
9813
9814	Here, calling this method on the <tt>Base</tt> medium object with
9815	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9816	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9817	merge. Note that in both cases the contents of the resulting medium
9818	will be the same, the only difference is the medium object that takes
9819	the result of the merge operation. In case of the forward merge in the
9820	above example, the result will be written to <tt>Diff_2</tt>; in case of
9821	the backward merge, the result will be written to <tt>Base</tt>. In
9822	other words, the result of the operation is always stored in the target
9823	medium.
9824
9825	Upon successful operation completion, the storage units of all media in
9826	the chain between this (source) medium and the target medium, including
9827	the source medium itself, will be automatically deleted and the
9828	relevant medium objects (including this medium) will become
9829	uninitialized. This means that any attempt to call any of
9830	their methods or attributes will fail with the
9831	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9832	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9833	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9834	Note that <tt>Diff_2</tt> in this case will become a base medium
9835	itself since it will no longer be based on any other medium.
9836
9837	Considering the above, all of the following conditions must be met in
9838	order for the merge operation to succeed:
9839	<ul>
9840	<li>
9841	Neither this (source) medium nor any intermediate
9842	differencing medium in the chain between it and the target
9843	medium is attached to any virtual machine.
9844	</li>
9845	<li>
9846	Neither the source medium nor the target medium is an
9847	<link to="MediumType_Immutable"/> medium.
9848	</li>
9849	<li>
9850	The part of the medium tree from the source medium to the
9851	target medium is a linear chain, i.e. all medium in this
9852	chain have exactly one child which is the next medium in this
9853	chain. The only exception from this rule is the target medium in
9854	the forward merge operation; it is allowed to have any number of
9855	child media because the merge operation will not change its
9856	logical contents (as it is seen by the guest OS or by children).
9857	</li>
9858	<li>
9859	None of the involved media are in
9860	<link to="MediumState_LockedRead"/> or
9861	<link to="MediumState_LockedWrite"/> state.
9862	</li>
9863	</ul>
9864
9865	<note>
9866	This (source) medium and all intermediates will be placed to <link
9867	to="MediumState_Deleting"/> state and the target medium will be
9868	placed to <link to="MediumState_LockedWrite"/> state and for the
9869	duration of this operation.
9870	</note>
9871	</desc>
9872	<param name="targetId" type="uuid" mod="string" dir="in">
9873	<desc>UUID of the target ancestor or descendant medium.</desc>
9874	</param>
9875	<param name="progress" type="IProgress" dir="return">
9876	<desc>Progress object to track the operation completion.</desc>
9877	</param>
9878	</method>
9879
9880	<!-- clone method -->
9881
9882	<method name="cloneTo">
9883	<desc>
9884	Starts creating a clone of this medium in the format and at the
9885	location defined by the @a target argument.
9886
9887	The target medium must be either in <link to="MediumState_NotCreated"/>
9888	state (i.e. must not have an existing storage unit) or in
9889	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9890	big enough to hold the data or else the copy will be partial). Upon
9891	successful completion, the cloned medium will contain exactly the
9892	same sector data as the medium being cloned, except that in the
9893	first case a new UUID for the clone will be randomly generated, and in
9894	the second case the UUID will remain unchanged.
9895
9896	The @a parent argument defines which medium will be the parent
9897	of the clone. Passing a @c null reference indicates that the clone will
9898	be a base image, i.e. completely independent. It is possible to specify
9899	an arbitrary medium for this parameter, including the parent of the
9900	medium which is being cloned. Even cloning to a child of the source
9901	medium is possible. Note that when cloning to an existing image, the
9902	@a parent irgument is ignored.
9903
9904	After the returned progress object reports that the operation is
9905	successfully complete, the target medium gets remembered by this
9906	VirtualBox installation and may be attached to virtual machines.
9907
9908	<note>
9909	This medium will be placed to <link to="MediumState_LockedRead"/>
9910	state for the duration of this operation.
9911	</note>
9912	<result name="E_NOTIMPL">
9913	The specified cloning variant is not supported at the moment.
9914	</result>
9915	</desc>
9916	<param name="target" type="IMedium" dir="in">
9917	<desc>Target medium.</desc>
9918	</param>
9919	<param name="variant" type="MediumVariant" dir="in">
9920	<desc>Exact image variant which should be created.</desc>
9921	</param>
9922	<param name="parent" type="IMedium" dir="in">
9923	<desc>Parent of the cloned medium.</desc>
9924	</param>
9925	<param name="progress" type="IProgress" dir="return">
9926	<desc>Progress object to track the operation completion.</desc>
9927	</param>
9928	</method>
9929
9930	<!-- other methods -->
9931
9932	<method name="compact">
9933	<desc>
9934	Starts compacting of this medium. This means that the medium is
9935	transformed into a possibly more compact storage representation.
9936	This potentially creates temporary images, which can require a
9937	substantial amount of additional disk space.
9938
9939	This medium will be placed to <link to="MediumState_LockedWrite"/>
9940	state and all its parent media (if any) will be placed to
9941	<link to="MediumState_LockedRead"/> state for the duration of this
9942	operation.
9943
9944	Please note that the results can be either returned straight away,
9945	or later as the result of the background operation via the object
9946	returned via the @a progress parameter.
9947
9948	<result name="VBOX_E_NOT_SUPPORTED">
9949	Medium format does not support compacting (but potentially
9950	needs it).
9951	</result>
9952	</desc>
9953	<param name="progress" type="IProgress" dir="return">
9954	<desc>Progress object to track the operation completion.</desc>
9955	</param>
9956	</method>
9957
9958	<method name="resize">
9959	<desc>
9960	Starts resizing this medium. This means that the nominal size of the
9961	medium is set to the new value. Both increasing and decreasing the
9962	size is possible, and there are no safety checks, since VirtualBox
9963	does not make any assumptions about the medium contents.
9964
9965	Resizing usually needs additional disk space, and possibly also
9966	some temporary disk space. Note that resize does not create a full
9967	temporary copy of the medium, so the additional disk space requirement
9968	is usually much lower than using the clone operation.
9969
9970	This medium will be placed to <link to="MediumState_LockedWrite"/>
9971	state for the duration of this operation.
9972
9973	Please note that the results can be either returned straight away,
9974	or later as the result of the background operation via the object
9975	returned via the @a progress parameter.
9976
9977	<result name="VBOX_E_NOT_SUPPORTED">
9978	Medium format does not support resizing.
9979	</result>
9980	</desc>
9981	<param name="logicalSize" type="unsigned long long" dir="in">
9982	<desc>New nominal capacity of the medium in megabytes.</desc>
9983	</param>
9984	<param name="progress" type="IProgress" dir="return">
9985	<desc>Progress object to track the operation completion.</desc>
9986	</param>
9987	</method>
9988
9989	<method name="reset">
9990	<desc>
9991	Starts erasing the contents of this differencing medium.
9992
9993	This operation will reset the differencing medium to its initial
9994	state when it does not contain any sector data and any read operation is
9995	redirected to its parent medium.
9996
9997	This medium will be placed to <link to="MediumState_LockedWrite"/>
9998	for the duration of this operation.
9999
10000	<result name="VBOX_E_NOT_SUPPORTED">
10001	This is not a differencing medium.
10002	</result>
10003	<result name="VBOX_E_INVALID_OBJECT_STATE">
10004	Medium is not in <link to="MediumState_Created"/> or
10005	<link to="MediumState_Inaccessible"/> state.
10006	</result>
10007	</desc>
10008	<param name="progress" type="IProgress" dir="return">
10009	<desc>Progress object to track the operation completion.</desc>
10010	</param>
10011	</method>
10012
10013	</interface>
10014
10015
10016	<!--
10017	// IMediumFormat
10018	/////////////////////////////////////////////////////////////////////////
10019	-->
10020
10021	<enum
10022	name="DataType"
10023	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10024	>
10025	<const name="Int32" value="0"/>
10026	<const name="Int8" value="1"/>
10027	<const name="String" value="2"/>
10028	</enum>
10029
10030	<enum
10031	name="DataFlags"
10032	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10033	>
10034	<const name="None" value="0x00"/>
10035	<const name="Mandatory" value="0x01"/>
10036	<const name="Expert" value="0x02"/>
10037	<const name="Array" value="0x04"/>
10038	<const name="FlagMask" value="0x07"/>
10039	</enum>
10040
10041	<enum
10042	name="MediumFormatCapabilities"
10043	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10044	>
10045	<desc>
10046	Medium format capability flags.
10047	</desc>
10048
10049	<const name="Uuid" value="0x01">
10050	<desc>
10051	Supports UUIDs as expected by VirtualBox code.
10052	</desc>
10053	</const>
10054
10055	<const name="CreateFixed" value="0x02">
10056	<desc>
10057	Supports creating fixed size images, allocating all space instantly.
10058	</desc>
10059	</const>
10060
10061	<const name="CreateDynamic" value="0x04">
10062	<desc>
10063	Supports creating dynamically growing images, allocating space on
10064	demand.
10065	</desc>
10066	</const>
10067
10068	<const name="CreateSplit2G" value="0x08">
10069	<desc>
10070	Supports creating images split in chunks of a bit less than 2 GBytes.
10071	</desc>
10072	</const>
10073
10074	<const name="Differencing" value="0x10">
10075	<desc>
10076	Supports being used as a format for differencing media (see <link
10077	to="IMedium::createDiffStorage"/>).
10078	</desc>
10079	</const>
10080
10081	<const name="Asynchronous" value="0x20">
10082	<desc>
10083	Supports asynchronous I/O operations for at least some configurations.
10084	</desc>
10085	</const>
10086
10087	<const name="File" value="0x40">
10088	<desc>
10089	The format backend operates on files (the <link to="IMedium::location"/>
10090	attribute of the medium specifies a file used to store medium
10091	data; for a list of supported file extensions see
10092	<link to="IMediumFormat::fileExtensions"/>).
10093	</desc>
10094	</const>
10095
10096	<const name="Properties" value="0x80">
10097	<desc>
10098	The format backend uses the property interface to configure the storage
10099	location and properties (the <link to="IMediumFormat::describeProperties"/>
10100	method is used to get access to properties supported by the given medium format).
10101	</desc>
10102	</const>
10103
10104	<const name="CapabilityMask" value="0xFF"/>
10105	</enum>
10106
10107	<interface
10108	name="IMediumFormat" extends="$unknown"
10109	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10110	wsmap="managed"
10111	>
10112	<desc>
10113	The IMediumFormat interface represents a medium format.
10114
10115	Each medium format has an associated backend which is used to handle
10116	media stored in this format. This interface provides information
10117	about the properties of the associated backend.
10118
10119	Each medium format is identified by a string represented by the
10120	<link to="#id"/> attribute. This string is used in calls like
10121	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10122	format.
10123
10124	The list of all supported medium formats can be obtained using
10125	<link to="ISystemProperties::mediaFormats"/>.
10126
10127	<see>IMedium</see>
10128	</desc>
10129
10130	<attribute name="id" type="wstring" readonly="yes">
10131	<desc>
10132	Identifier of this format.
10133
10134	The format identifier is a non-@c null non-empty ASCII string. Note that
10135	this string is case-insensitive. This means that, for example, all of
10136	the following strings:
10137	<pre>
10138	"VDI"
10139	"vdi"
10140	"VdI"</pre>
10141	refer to the same medium format.
10142
10143	This string is used in methods of other interfaces where it is necessary
10144	to specify a medium format, such as
10145	<link to="IVirtualBox::createHardDisk"/>.
10146	</desc>
10147	</attribute>
10148
10149	<attribute name="name" type="wstring" readonly="yes">
10150	<desc>
10151	Human readable description of this format.
10152
10153	Mainly for use in file open dialogs.
10154	</desc>
10155	</attribute>
10156
10157	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10158	<desc>
10159	Array of strings containing the supported file extensions.
10160
10161	The first extension in the array is the extension preferred by the
10162	backend. It is recommended to use this extension when specifying a
10163	location of the storage unit for a new medium.
10164
10165	Note that some backends do not work on files, so this array may be
10166	empty.
10167
10168	<see>IMediumFormat::capabilities</see>
10169	</desc>
10170	</attribute>
10171
10172	<attribute name="capabilities" type="unsigned long" readonly="yes">
10173	<desc>
10174	Capabilities of the format as a set of bit flags.
10175
10176	For the meaning of individual capability flags see
10177	<link to="MediumFormatCapabilities"/>.
10178	</desc>
10179	</attribute>
10180
10181	<method name="describeProperties">
10182	<desc>
10183	Returns several arrays describing the properties supported by this
10184	format.
10185
10186	An element with the given index in each array describes one
10187	property. Thus, the number of elements in each returned array is the
10188	same and corresponds to the number of supported properties.
10189
10190	The returned arrays are filled in only if the
10191	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10192	All arguments must be non-@c null.
10193
10194	<see>DataType</see>
10195	<see>DataFlags</see>
10196	</desc>
10197
10198	<param name="names" type="wstring" safearray="yes" dir="out">
10199	<desc>Array of property names.</desc>
10200	</param>
10201	<param name="description" type="wstring" safearray="yes" dir="out">
10202	<desc>Array of property descriptions.</desc>
10203	</param>
10204	<param name="types" type="DataType" safearray="yes" dir="out">
10205	<desc>Array of property types.</desc>
10206	</param>
10207	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10208	<desc>Array of property flags.</desc>
10209	</param>
10210	<param name="defaults" type="wstring" safearray="yes" dir="out">
10211	<desc>Array of default property values.</desc>
10212	</param>
10213	</method>
10214
10215	</interface>
10216
10217
10218	<!--
10219	// IKeyboard
10220	/////////////////////////////////////////////////////////////////////////
10221	-->
10222
10223	<interface
10224	name="IKeyboard" extends="$unknown"
10225	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10226	wsmap="managed"
10227	>
10228	<desc>
10229	The IKeyboard interface represents the virtual machine's keyboard. Used
10230	in <link to="IConsole::keyboard"/>.
10231
10232	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10233	to the virtual machine.
10234
10235	</desc>
10236	<method name="putScancode">
10237	<desc>Sends a scancode to the keyboard.
10238
10239	<result name="VBOX_E_IPRT_ERROR">
10240	Could not send scan code to virtual keyboard.
10241	</result>
10242
10243	</desc>
10244	<param name="scancode" type="long" dir="in"/>
10245	</method>
10246
10247	<method name="putScancodes">
10248	<desc>Sends an array of scancodes to the keyboard.
10249
10250	<result name="VBOX_E_IPRT_ERROR">
10251	Could not send all scan codes to virtual keyboard.
10252	</result>
10253
10254	</desc>
10255	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10256	<param name="codesStored" type="unsigned long" dir="return"/>
10257	</method>
10258
10259	<method name="putCAD">
10260	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10261	function is nothing special, it is just a convenience function
10262	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10263
10264	<result name="VBOX_E_IPRT_ERROR">
10265	Could not send all scan codes to virtual keyboard.
10266	</result>
10267
10268	</desc>
10269	</method>
10270
10271	</interface>
10272
10273
10274	<!--
10275	// IMouse
10276	/////////////////////////////////////////////////////////////////////////
10277	-->
10278
10279	<enum
10280	name="MouseButtonState"
10281	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10282	>
10283	<desc>
10284	Mouse button state.
10285	</desc>
10286
10287	<const name="LeftButton" value="0x01"/>
10288	<const name="RightButton" value="0x02"/>
10289	<const name="MiddleButton" value="0x04"/>
10290	<const name="WheelUp" value="0x08"/>
10291	<const name="WheelDown" value="0x10"/>
10292	<const name="XButton1" value="0x20"/>
10293	<const name="XButton2" value="0x40"/>
10294	<const name="MouseStateMask" value="0x7F"/>
10295	</enum>
10296
10297	<interface
10298	name="IMouse" extends="$unknown"
10299	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10300	wsmap="managed"
10301	>
10302	<desc>
10303	The IMouse interface represents the virtual machine's mouse. Used in
10304	<link to="IConsole::mouse"/>.
10305
10306	Through this interface, the virtual machine's virtual mouse can be
10307	controlled.
10308	</desc>
10309
10310	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10311	<desc>
10312	Whether the guest OS supports absolute mouse pointer positioning
10313	or not.
10314	<note>
10315	VirtualBox Guest Tools need to be installed to the guest OS
10316	in order to enable absolute mouse positioning support.
10317	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10318	callback to be instantly informed about changes of this attribute
10319	during virtual machine execution.
10320	</note>
10321	<see><link to="#putMouseEventAbsolute"/></see>
10322	</desc>
10323	</attribute>
10324
10325	<method name="putMouseEvent">
10326	<desc>
10327	Initiates a mouse event using relative pointer movements
10328	along x and y axis.
10329
10330	<result name="E_ACCESSDENIED">
10331	Console not powered up.
10332	</result>
10333	<result name="VBOX_E_IPRT_ERROR">
10334	Could not send mouse event to virtual mouse.
10335	</result>
10336
10337	</desc>
10338
10339	<param name="dx" type="long" dir="in">
10340	<desc>
10341	Amount of pixels the mouse should move to the right.
10342	Negative values move the mouse to the left.
10343	</desc>
10344	</param>
10345	<param name="dy" type="long" dir="in">
10346	<desc>
10347	Amount of pixels the mouse should move downwards.
10348	Negative values move the mouse upwards.
10349	</desc>
10350	</param>
10351	<param name="dz" type="long" dir="in">
10352	<desc>
10353	Amount of mouse wheel moves.
10354	Positive values describe clockwise wheel rotations,
10355	negative values describe counterclockwise rotations.
10356	</desc>
10357	</param>
10358	<param name="dw" type="long" dir="in">
10359	<desc>
10360	Amount of horizontal mouse wheel moves.
10361	Positive values describe a movement to the left,
10362	negative values describe a movement to the right.
10363	</desc>
10364	</param>
10365	<param name="buttonState" type="long" dir="in">
10366	<desc>
10367	The current state of mouse buttons. Every bit represents
10368	a mouse button as follows:
10369	<table>
10370	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10371	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10372	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10373	</table>
10374	A value of <tt>1</tt> means the corresponding button is pressed.
10375	otherwise it is released.
10376	</desc>
10377	</param>
10378	</method>
10379
10380	<method name="putMouseEventAbsolute">
10381	<desc>
10382	Positions the mouse pointer using absolute x and y coordinates.
10383	These coordinates are expressed in pixels and
10384	start from <tt>[1,1]</tt> which corresponds to the top left
10385	corner of the virtual display.
10386
10387	<result name="E_ACCESSDENIED">
10388	Console not powered up.
10389	</result>
10390	<result name="VBOX_E_IPRT_ERROR">
10391	Could not send mouse event to virtual mouse.
10392	</result>
10393
10394	<note>
10395	This method will have effect only if absolute mouse
10396	positioning is supported by the guest OS.
10397	</note>
10398
10399	<see><link to="#absoluteSupported"/></see>
10400	</desc>
10401
10402	<param name="x" type="long" dir="in">
10403	<desc>
10404	X coordinate of the pointer in pixels, starting from @c 1.
10405	</desc>
10406	</param>
10407	<param name="y" type="long" dir="in">
10408	<desc>
10409	Y coordinate of the pointer in pixels, starting from @c 1.
10410	</desc>
10411	</param>
10412	<param name="dz" type="long" dir="in">
10413	<desc>
10414	Amount of mouse wheel moves.
10415	Positive values describe clockwise wheel rotations,
10416	negative values describe counterclockwise rotations.
10417	</desc>
10418	</param>
10419	<param name="dw" type="long" dir="in">
10420	<desc>
10421	Amount of horizontal mouse wheel moves.
10422	Positive values describe a movement to the left,
10423	negative values describe a movement to the right.
10424	</desc>
10425	</param>
10426	<param name="buttonState" type="long" dir="in">
10427	<desc>
10428	The current state of mouse buttons. Every bit represents
10429	a mouse button as follows:
10430	<table>
10431	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10432	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10433	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10434	</table>
10435	A value of @c 1 means the corresponding button is pressed.
10436	otherwise it is released.
10437	</desc>
10438	</param>
10439	</method>
10440
10441	</interface>
10442
10443	<!--
10444	// IDisplay
10445	/////////////////////////////////////////////////////////////////////////
10446	-->
10447
10448	<enum
10449	name="FramebufferPixelFormat"
10450	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10451	>
10452	<desc>
10453	Format of the video memory buffer. Constants represented by this enum can
10454	be used to test for particular values of <link
10455	to="IFramebuffer::pixelFormat"/>. See also <link
10456	to="IFramebuffer::requestResize"/>.
10457
10458	See also www.fourcc.org for more information about FOURCC pixel formats.
10459	</desc>
10460
10461	<const name="Opaque" value="0">
10462	<desc>
10463	Unknown buffer format (the user may not assume any particular format of
10464	the buffer).
10465	</desc>
10466	</const>
10467	<const name="FOURCC_RGB" value="0x32424752">
10468	<desc>
10469	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10470	bit layout).
10471	</desc>
10472	</const>
10473	</enum>
10474
10475	<interface
10476	name="IFramebuffer" extends="$unknown"
10477	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10478	wsmap="suppress"
10479	>
10480	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10481	<desc>Address of the start byte of the frame buffer.</desc>
10482	</attribute>
10483
10484	<attribute name="width" type="unsigned long" readonly="yes">
10485	<desc>Frame buffer width, in pixels.</desc>
10486	</attribute>
10487
10488	<attribute name="height" type="unsigned long" readonly="yes">
10489	<desc>Frame buffer height, in pixels.</desc>
10490	</attribute>
10491
10492	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10493	<desc>
10494	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10495	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10496	are: 8, 15, 16, 24 and 32.
10497	</desc>
10498	</attribute>
10499
10500	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10501	<desc>
10502	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10503	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10504	size of the scan line must be aligned to 32 bits.
10505	</desc>
10506	</attribute>
10507
10508	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10509	<desc>
10510	Frame buffer pixel format. It's either one of the values defined by <link
10511	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10512	<note>
10513	This attribute must never return <link
10514	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10515	<link to="#address"/> points to must be always known.
10516	</note>
10517	</desc>
10518	</attribute>
10519
10520	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10521	<desc>
10522	Defines whether this frame buffer uses the virtual video card's memory
10523	buffer (guest VRAM) directly or not. See <link
10524	to="IFramebuffer::requestResize"/> for more information.
10525	</desc>
10526	</attribute>
10527
10528	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10529	<desc>
10530	Hint from the frame buffer about how much of the standard
10531	screen height it wants to use for itself. This information is
10532	exposed to the guest through the VESA BIOS and VMMDev interface
10533	so that it can use it for determining its video mode table. It
10534	is not guaranteed that the guest respects the value.
10535	</desc>
10536	</attribute>
10537
10538	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10539	<desc>
10540	An alpha-blended overlay which is superposed over the frame buffer.
10541	The initial purpose is to allow the display of icons providing
10542	information about the VM state, including disk activity, in front
10543	ends which do not have other means of doing that. The overlay is
10544	designed to controlled exclusively by IDisplay. It has no locking
10545	of its own, and any changes made to it are not guaranteed to be
10546	visible until the affected portion of IFramebuffer is updated. The
10547	overlay can be created lazily the first time it is requested. This
10548	attribute can also return @c null to signal that the overlay is not
10549	implemented.
10550	</desc>
10551	</attribute>
10552
10553	<attribute name="winId" type="unsigned long long" readonly="yes">
10554	<desc>
10555	Platform-dependent identifier of the window where context of this
10556	frame buffer is drawn, or zero if there's no such window.
10557	</desc>
10558	</attribute>
10559
10560	<method name="lock">
10561	<desc>
10562	Locks the frame buffer.
10563	Gets called by the IDisplay object where this frame buffer is
10564	bound to.
10565	</desc>
10566	</method>
10567
10568	<method name="unlock">
10569	<desc>
10570	Unlocks the frame buffer.
10571	Gets called by the IDisplay object where this frame buffer is
10572	bound to.
10573	</desc>
10574	</method>
10575
10576	<method name="notifyUpdate">
10577	<desc>
10578	Informs about an update.
10579	Gets called by the display object where this buffer is
10580	registered.
10581	</desc>
10582	<param name="x" type="unsigned long" dir="in"/>
10583	<param name="y" type="unsigned long" dir="in"/>
10584	<param name="width" type="unsigned long" dir="in"/>
10585	<param name="height" type="unsigned long" dir="in"/>
10586	</method>
10587
10588	<method name="requestResize">
10589	<desc>
10590	Requests a size and pixel format change.
10591
10592	There are two modes of working with the video buffer of the virtual
10593	machine. The <i>indirect</i> mode implies that the IFramebuffer
10594	implementation allocates a memory buffer for the requested display mode
10595	and provides it to the virtual machine. In <i>direct</i> mode, the
10596	IFramebuffer implementation uses the memory buffer allocated and owned
10597	by the virtual machine. This buffer represents the video memory of the
10598	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10599	usually faster because the implementation gets a raw pointer to the
10600	guest VRAM buffer which it can directly use for visualizing the contents
10601	of the virtual display, as opposed to the indirect mode where the
10602	contents of guest VRAM are copied to the memory buffer provided by
10603	the implementation every time a display update occurs.
10604
10605	It is important to note that the direct mode is really fast only when
10606	the implementation uses the given guest VRAM buffer directly, for
10607	example, by blitting it to the window representing the virtual machine's
10608	display, which saves at least one copy operation comparing to the
10609	indirect mode. However, using the guest VRAM buffer directly is not
10610	always possible: the format and the color depth of this buffer may be
10611	not supported by the target window, or it may be unknown (opaque) as in
10612	case of text or non-linear multi-plane VGA video modes. In this case,
10613	the indirect mode (that is always available) should be used as a
10614	fallback: when the guest VRAM contents are copied to the
10615	implementation-provided memory buffer, color and format conversion is
10616	done automatically by the underlying code.
10617
10618	The @a pixelFormat parameter defines whether the direct mode is
10619	available or not. If @a pixelFormat is <link
10620	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10621	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10622	@a bytesPerLine parameters must be ignored and the implementation must use
10623	the indirect mode (where it provides its own buffer in one of the
10624	supported formats). In all other cases, @a pixelFormat together with
10625	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10626	buffer pointed to by the @a VRAM parameter and the implementation is
10627	free to choose which mode to use. To indicate that this frame buffer uses
10628	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10629	attribute must return @c true and <link to="#address"/> must
10630	return exactly the same address that is passed in the @a VRAM parameter
10631	of this method; otherwise it is assumed that the indirect strategy is
10632	chosen.
10633
10634	The @a width and @a height parameters represent the size of the
10635	requested display mode in both modes. In case of indirect mode, the
10636	provided memory buffer should be big enough to store data of the given
10637	display mode. In case of direct mode, it is guaranteed that the given
10638	@a VRAM buffer contains enough space to represent the display mode of the
10639	given size. Note that this frame buffer's <link to="#width"/> and <link
10640	to="#height"/> attributes must return exactly the same values as
10641	passed to this method after the resize is completed (see below).
10642
10643	The @a finished output parameter determines if the implementation has
10644	finished resizing the frame buffer or not. If, for some reason, the
10645	resize cannot be finished immediately during this call, @a finished
10646	must be set to @c false, and the implementation must call
10647	<link to="IDisplay::resizeCompleted"/> after it has returned from
10648	this method as soon as possible. If @a finished is @c false, the
10649	machine will not call any frame buffer methods until
10650	<link to="IDisplay::resizeCompleted"/> is called.
10651
10652	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10653	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10654	this frame buffer must return exactly the same values as specified in the
10655	parameters of this method, after the resize is completed. If the
10656	indirect mode is chosen, these attributes must return values describing
10657	the format of the implementation's own memory buffer <link
10658	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10659	value must always correlate with <link to="#pixelFormat"/>. Note that
10660	the <link to="#pixelFormat"/> attribute must never return <link
10661	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10662
10663	<note>
10664	This method is called by the IDisplay object under the
10665	<link to="#lock"/> provided by this IFramebuffer
10666	implementation. If this method returns @c false in @a finished, then
10667	this lock is not released until
10668	<link to="IDisplay::resizeCompleted"/> is called.
10669	</note>
10670	</desc>
10671	<param name="screenId" type="unsigned long" dir="in">
10672	<desc>
10673	Logical screen number. Must be used in the corresponding call to
10674	<link to="IDisplay::resizeCompleted"/> if this call is made.
10675	</desc>
10676	</param>
10677	<param name="pixelFormat" type="unsigned long" dir="in">
10678	<desc>
10679	Pixel format of the memory buffer pointed to by @a VRAM.
10680	See also <link to="FramebufferPixelFormat"/>.
10681	</desc>
10682	</param>
10683	<param name="VRAM" type="octet" mod="ptr" dir="in">
10684	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10685	</param>
10686	<param name="bitsPerPixel" type="unsigned long" dir="in">
10687	<desc>Color depth, bits per pixel.</desc>
10688	</param>
10689	<param name="bytesPerLine" type="unsigned long" dir="in">
10690	<desc>Size of one scan line, in bytes.</desc>
10691	</param>
10692	<param name="width" type="unsigned long" dir="in">
10693	<desc>Width of the guest display, in pixels.</desc>
10694	</param>
10695	<param name="height" type="unsigned long" dir="in">
10696	<desc>Height of the guest display, in pixels.</desc>
10697	</param>
10698	<param name="finished" type="boolean" dir="return">
10699	<desc>
10700	Can the VM start using the new frame buffer immediately
10701	after this method returns or it should wait for
10702	<link to="IDisplay::resizeCompleted"/>.
10703	</desc>
10704	</param>
10705	</method>
10706
10707	<method name="videoModeSupported">
10708	<desc>
10709	Returns whether the frame buffer implementation is willing to
10710	support a given video mode. In case it is not able to render
10711	the video mode (or for some reason not willing), it should
10712	return @c false. Usually this method is called when the guest
10713	asks the VMM device whether a given video mode is supported
10714	so the information returned is directly exposed to the guest.
10715	It is important that this method returns very quickly.
10716	</desc>
10717	<param name="width" type="unsigned long" dir="in"/>
10718	<param name="height" type="unsigned long" dir="in"/>
10719	<param name="bpp" type="unsigned long" dir="in"/>
10720	<param name="supported" type="boolean" dir="return"/>
10721	</method>
10722
10723	<method name="getVisibleRegion">
10724	<desc>
10725	Returns the visible region of this frame buffer.
10726
10727	If the @a rectangles parameter is @c null then the value of the
10728	@a count parameter is ignored and the number of elements necessary to
10729	describe the current visible region is returned in @a countCopied.
10730
10731	If @a rectangles is not @c null but @a count is less
10732	than the required number of elements to store region data, the method
10733	will report a failure. If @a count is equal or greater than the
10734	required number of elements, then the actual number of elements copied
10735	to the provided array will be returned in @a countCopied.
10736
10737	<note>
10738	The address of the provided array must be in the process space of
10739	this IFramebuffer object.
10740	</note>
10741	<note>
10742	Method not yet implemented.
10743	</note>
10744	</desc>
10745	<param name="rectangles" type="octet" mod="ptr" dir="in">
10746	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10747	</param>
10748	<param name="count" type="unsigned long" dir="in">
10749	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10750	</param>
10751	<param name="countCopied" type="unsigned long" dir="return">
10752	<desc>Number of elements copied to the @a rectangles array.</desc>
10753	</param>
10754	</method>
10755
10756	<method name="setVisibleRegion">
10757	<desc>
10758	Suggests a new visible region to this frame buffer. This region
10759	represents the area of the VM display which is a union of regions of
10760	all top-level windows of the guest operating system running inside the
10761	VM (if the Guest Additions for this system support this
10762	functionality). This information may be used by the frontends to
10763	implement the seamless desktop integration feature.
10764
10765	<note>
10766	The address of the provided array must be in the process space of
10767	this IFramebuffer object.
10768	</note>
10769	<note>
10770	The IFramebuffer implementation must make a copy of the provided
10771	array of rectangles.
10772	</note>
10773	<note>
10774	Method not yet implemented.
10775	</note>
10776	</desc>
10777	<param name="rectangles" type="octet" mod="ptr" dir="in">
10778	<desc>Pointer to the @c RTRECT array.</desc>
10779	</param>
10780	<param name="count" type="unsigned long" dir="in">
10781	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10782	</param>
10783	</method>
10784
10785	<method name="processVHWACommand">
10786	<desc>
10787	Posts a Video HW Acceleration Command to the frame buffer for processing.
10788	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10789	are posted from quest to the host to be processed by the host hardware.
10790
10791	<note>
10792	The address of the provided command must be in the process space of
10793	this IFramebuffer object.
10794	</note>
10795	</desc>
10796
10797	<param name="command" type="octet" mod="ptr" dir="in">
10798	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10799	</param>
10800	</method>
10801
10802	</interface>
10803
10804	<interface
10805	name="IFramebufferOverlay" extends="IFramebuffer"
10806	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10807	wsmap="suppress"
10808	>
10809	<desc>
10810	The IFramebufferOverlay interface represents an alpha blended overlay
10811	for displaying status icons above an IFramebuffer. It is always created
10812	not visible, so that it must be explicitly shown. It only covers a
10813	portion of the IFramebuffer, determined by its width, height and
10814	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10815	that order) format, and may be written to directly. Do re-read the
10816	width though, after setting it, as it may be adjusted (increased) to
10817	make it more suitable for the front end.
10818	</desc>
10819	<attribute name="x" type="unsigned long" readonly="yes">
10820	<desc>X position of the overlay, relative to the frame buffer.</desc>
10821	</attribute>
10822
10823	<attribute name="y" type="unsigned long" readonly="yes">
10824	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10825	</attribute>
10826
10827	<attribute name="visible" type="boolean" readonly="no">
10828	<desc>
10829	Whether the overlay is currently visible.
10830	</desc>
10831	</attribute>
10832
10833	<attribute name="alpha" type="unsigned long" readonly="no">
10834	<desc>
10835	The global alpha value for the overlay. This may or may not be
10836	supported by a given front end.
10837	</desc>
10838	</attribute>
10839
10840	<method name="move">
10841	<desc>
10842	Changes the overlay's position relative to the IFramebuffer.
10843	</desc>
10844	<param name="x" type="unsigned long" dir="in"/>
10845	<param name="y" type="unsigned long" dir="in"/>
10846	</method>
10847
10848	</interface>
10849
10850	<interface
10851	name="IDisplay" extends="$unknown"
10852	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
10853	wsmap="managed"
10854	>
10855	<desc>
10856	The IDisplay interface represents the virtual machine's display.
10857
10858	The object implementing this interface is contained in each
10859	<link to="IConsole::display"/> attribute and represents the visual
10860	output of the virtual machine.
10861
10862	The virtual display supports pluggable output targets represented by the
10863	IFramebuffer interface. Examples of the output target are a window on
10864	the host computer or an RDP session's display on a remote computer.
10865	</desc>
10866	<attribute name="width" type="unsigned long" readonly="yes">
10867	<desc>Current display width.</desc>
10868	</attribute>
10869
10870	<attribute name="height" type="unsigned long" readonly="yes">
10871	<desc>Current display height.</desc>
10872	</attribute>
10873
10874	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10875	<desc>
10876	Current guest display color depth. Note that this may differ
10877	from <link to="IFramebuffer::bitsPerPixel"/>.
10878	</desc>
10879	</attribute>
10880
10881	<method name="setFramebuffer">
10882	<desc>
10883	Sets the framebuffer for given screen.
10884	</desc>
10885	<param name="screenId" type="unsigned long" dir="in"/>
10886	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10887	</method>
10888
10889	<method name="getFramebuffer">
10890	<desc>
10891	Queries the framebuffer for given screen.
10892	</desc>
10893	<param name="screenId" type="unsigned long" dir="in"/>
10894	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10895	<param name="xOrigin" type="long" dir="out"/>
10896	<param name="yOrigin" type="long" dir="out"/>
10897	</method>
10898
10899	<method name="setVideoModeHint">
10900	<desc>
10901	Asks VirtualBox to request the given video mode from
10902	the guest. This is just a hint and it cannot be guaranteed
10903	that the requested resolution will be used. Guest Additions
10904	are required for the request to be seen by guests. The caller
10905	should issue the request and wait for a resolution change and
10906	after a timeout retry.
10907
10908	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10909	parameters means that the corresponding values should be taken from the
10910	current video mode (i.e. left unchanged).
10911
10912	If the guest OS supports multi-monitor configuration then the @a display
10913	parameter specifies the number of the guest display to send the hint to:
10914	@c 0 is the primary display, @c 1 is the first secondary and
10915	so on. If the multi-monitor configuration is not supported, @a display
10916	must be @c 0.
10917
10918	<result name="E_INVALIDARG">
10919	The @a display is not associated with any monitor.
10920	</result>
10921
10922	</desc>
10923	<param name="width" type="unsigned long" dir="in"/>
10924	<param name="height" type="unsigned long" dir="in"/>
10925	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10926	<param name="display" type="unsigned long" dir="in"/>
10927	</method>
10928
10929	<method name="setSeamlessMode">
10930	<desc>
10931	Enables or disables seamless guest display rendering (seamless desktop
10932	integration) mode.
10933	<note>
10934	Calling this method has no effect if <link
10935	to="IGuest::supportsSeamless"/> returns @c false.
10936	</note>
10937	</desc>
10938	<param name="enabled" type="boolean" dir="in"/>
10939	</method>
10940
10941	<method name="takeScreenShot">
10942	<desc>
10943	Takes a screen shot of the requested size and copies it to the
10944	32-bpp buffer allocated by the caller and pointed to by @a address.
10945	A pixel consists of 4 bytes in order: B, G, R, 0.
10946
10947	<note>This API can be used only by the COM/XPCOM C++ API as it
10948	requires pointer support. Use <link to="#takeScreenShotSlow" />
10949	with other language bindings.
10950	</note>
10951
10952	<result name="E_NOTIMPL">
10953	Feature not implemented.
10954	</result>
10955	<result name="VBOX_E_IPRT_ERROR">
10956	Could not take a screenshot.
10957	</result>
10958
10959	</desc>
10960	<param name="address" type="octet" mod="ptr" dir="in"/>
10961	<param name="width" type="unsigned long" dir="in"/>
10962	<param name="height" type="unsigned long" dir="in"/>
10963	</method>
10964
10965	<method name="takeScreenShotSlow">
10966	<desc>
10967	Takes a guest screen shot of the requested size and returns it as
10968	an array of bytes in uncompressed 32-bit RGBA format.
10969	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
10970
10971	This API is slow, but could be the only option to get guest screenshot
10972	for scriptable languages not allowed to manipulate with addresses
10973	directly.
10974
10975	<result name="E_NOTIMPL">
10976	Feature not implemented.
10977	</result>
10978	<result name="VBOX_E_IPRT_ERROR">
10979	Could not take a screenshot.
10980	</result>
10981	</desc>
10982	<param name="width" type="unsigned long" dir="in">
10983	<desc>
10984	Desired image width.
10985	</desc>
10986	</param>
10987	<param name="height" type="unsigned long" dir="in">
10988	<desc>
10989	Desired image height.
10990	</desc>
10991	</param>
10992	<param name="screenData" type="octet" dir="return" safearray="yes">
10993	<desc>
10994	Array with resulting screen data.
10995	</desc>
10996	</param>
10997	</method>
10998
10999	<method name="drawToScreen">
11000	<desc>
11001	Draws a 32-bpp image of the specified size from the given buffer
11002	to the given point on the VM display.
11003
11004	<result name="E_NOTIMPL">
11005	Feature not implemented.
11006	</result>
11007	<result name="VBOX_E_IPRT_ERROR">
11008	Could not draw to screen.
11009	</result>
11010
11011	</desc>
11012	<param name="address" type="octet" mod="ptr" dir="in"/>
11013	<param name="x" type="unsigned long" dir="in"/>
11014	<param name="y" type="unsigned long" dir="in"/>
11015	<param name="width" type="unsigned long" dir="in"/>
11016	<param name="height" type="unsigned long" dir="in"/>
11017	</method>
11018
11019	<method name="invalidateAndUpdate">
11020	<desc>
11021	Does a full invalidation of the VM display and instructs the VM
11022	to update it.
11023
11024	<result name="VBOX_E_IPRT_ERROR">
11025	Could not invalidate and update screen.
11026	</result>
11027
11028	</desc>
11029	</method>
11030
11031	<method name="resizeCompleted">
11032	<desc>
11033	Signals that a framebuffer has completed the resize operation.
11034
11035	<result name="VBOX_E_NOT_SUPPORTED">
11036	Operation only valid for external frame buffers.
11037	</result>
11038
11039	</desc>
11040	<param name="screenId" type="unsigned long" dir="in"/>
11041	</method>
11042
11043	<method name="updateCompleted">
11044	<desc>
11045	Signals that a framebuffer has completed the update operation.
11046
11047	<result name="VBOX_E_NOT_SUPPORTED">
11048	Operation only valid for external frame buffers.
11049	</result>
11050
11051	</desc>
11052	</method>
11053
11054	<method name="completeVHWACommand">
11055	<desc>
11056	Signals that the Video HW Acceleration command has completed.
11057	</desc>
11058
11059	<param name="command" type="octet" mod="ptr" dir="in">
11060	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11061	</param>
11062	</method>
11063
11064	</interface>
11065
11066	<!--
11067	// INetworkAdapter
11068	/////////////////////////////////////////////////////////////////////////
11069	-->
11070
11071	<enum
11072	name="NetworkAttachmentType"
11073	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11074	>
11075	<desc>
11076	Network attachment type.
11077	</desc>
11078
11079	<const name="Null" value="0">
11080	<desc>Null value, also means "not attached".</desc>
11081	</const>
11082	<const name="NAT" value="1"/>
11083	<const name="Bridged" value="2"/>
11084	<const name="Internal" value="3"/>
11085	<const name="HostOnly" value="4"/>
11086	</enum>
11087
11088	<enum
11089	name="NetworkAdapterType"
11090	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11091	>
11092	<desc>
11093	Network adapter type.
11094	</desc>
11095
11096	<const name="Null" value="0">
11097	<desc>Null value (never used by the API).</desc>
11098	</const>
11099	<const name="Am79C970A" value="1">
11100	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11101	</const>
11102	<const name="Am79C973" value="2">
11103	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11104	</const>
11105	<const name="I82540EM" value="3">
11106	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11107	</const>
11108	<const name="I82543GC" value="4">
11109	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11110	</const>
11111	<const name="I82545EM" value="5">
11112	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11113	</const>
11114	<const name="Virtio" value="6">
11115	<desc>Virtio network device.</desc>
11116	</const>
11117	</enum>
11118
11119	<interface
11120	name="INetworkAdapter" extends="$unknown"
11121	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11122	wsmap="managed"
11123	>
11124	<desc>
11125	Represents a virtual network adapter that is attached to a virtual machine.
11126	Each virtual machine has a fixed number of network adapter slots with one
11127	instance of this attached to each of them. Call
11128	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11129	is attached to a given slot in a given machine.
11130
11131	Each network adapter can be in one of five attachment modes, which are
11132	represented by the <link to="NetworkAttachmentType" /> enumeration;
11133	see the <link to="#attachmentType" /> attribute.
11134	</desc>
11135
11136	<attribute name="adapterType" type="NetworkAdapterType">
11137	<desc>
11138	Type of the virtual network adapter. Depending on this value,
11139	VirtualBox will provide a different virtual network hardware
11140	to the guest.
11141	</desc>
11142	</attribute>
11143
11144	<attribute name="slot" type="unsigned long" readonly="yes">
11145	<desc>
11146	Slot number this adapter is plugged into. Corresponds to
11147	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11148	to obtain this instance.
11149	</desc>
11150	</attribute>
11151
11152	<attribute name="enabled" type="boolean">
11153	<desc>
11154	Flag whether the network adapter is present in the
11155	guest system. If disabled, the virtual guest hardware will
11156	not contain this network adapter. Can only be changed when
11157	the VM is not running.
11158	</desc>
11159	</attribute>
11160
11161	<attribute name="MACAddress" type="wstring">
11162	<desc>
11163	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11164	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11165	</desc>
11166	</attribute>
11167
11168	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11169
11170	<attribute name="hostInterface" type="wstring">
11171	<desc>
11172	Name of the host network interface the VM is attached to.
11173	</desc>
11174	</attribute>
11175
11176	<attribute name="internalNetwork" type="wstring">
11177	<desc>
11178	Name of the internal network the VM is attached to.
11179	</desc>
11180	</attribute>
11181
11182	<attribute name="NATNetwork" type="wstring">
11183	<desc>
11184	Name of the NAT network the VM is attached to.
11185	</desc>
11186	</attribute>
11187
11188	<attribute name="cableConnected" type="boolean">
11189	<desc>
11190	Flag whether the adapter reports the cable as connected or not.
11191	It can be used to report offline situations to a VM.
11192	</desc>
11193	</attribute>
11194
11195	<attribute name="lineSpeed" type="unsigned long">
11196	<desc>
11197	Line speed reported by custom drivers, in units of 1 kbps.
11198	</desc>
11199	</attribute>
11200
11201	<attribute name="traceEnabled" type="boolean">
11202	<desc>
11203	Flag whether network traffic from/to the network card should be traced.
11204	Can only be toggled when the VM is turned off.
11205	</desc>
11206	</attribute>
11207
11208	<attribute name="traceFile" type="wstring">
11209	<desc>
11210	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11211	will be used.
11212	</desc>
11213	</attribute>
11214
11215	<method name="attachToNAT">
11216	<desc>
11217	Attach the network adapter to the Network Address Translation (NAT) interface.
11218	</desc>
11219	</method>
11220
11221	<method name="attachToBridgedInterface">
11222	<desc>
11223	Attach the network adapter to a bridged host interface.
11224	</desc>
11225	</method>
11226
11227	<method name="attachToInternalNetwork">
11228	<desc>
11229	Attach the network adapter to an internal network.
11230	</desc>
11231	</method>
11232
11233	<method name="attachToHostOnlyInterface">
11234	<desc>
11235	Attach the network adapter to the host-only network.
11236	</desc>
11237	</method>
11238
11239	<method name="detach">
11240	<desc>
11241	Detach the network adapter
11242	</desc>
11243	</method>
11244	</interface>
11245
11246
11247	<!--
11248	// ISerialPort
11249	/////////////////////////////////////////////////////////////////////////
11250	-->
11251
11252	<enum
11253	name="PortMode"
11254	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11255	>
11256	<desc>
11257	The PortMode enumeration represents possible communication modes for
11258	the virtual serial port device.
11259	</desc>
11260
11261	<const name="Disconnected" value="0">
11262	<desc>Virtual device is not attached to any real host device.</desc>
11263	</const>
11264	<const name="HostPipe" value="1">
11265	<desc>Virtual device is attached to a host pipe.</desc>
11266	</const>
11267	<const name="HostDevice" value="2">
11268	<desc>Virtual device is attached to a host device.</desc>
11269	</const>
11270	<const name="RawFile" value="3">
11271	<desc>Virtual device is attached to a raw file.</desc>
11272	</const>
11273	</enum>
11274
11275	<interface
11276	name="ISerialPort" extends="$unknown"
11277	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11278	wsmap="managed"
11279	>
11280
11281	<desc>
11282	The ISerialPort interface represents the virtual serial port device.
11283
11284	The virtual serial port device acts like an ordinary serial port
11285	inside the virtual machine. This device communicates to the real
11286	serial port hardware in one of two modes: host pipe or host device.
11287
11288	In host pipe mode, the #path attribute specifies the path to the pipe on
11289	the host computer that represents a serial port. The #server attribute
11290	determines if this pipe is created by the virtual machine process at
11291	machine startup or it must already exist before starting machine
11292	execution.
11293
11294	In host device mode, the #path attribute specifies the name of the
11295	serial port device on the host computer.
11296
11297	There is also a third communication mode: the disconnected mode. In this
11298	mode, the guest OS running inside the virtual machine will be able to
11299	detect the serial port, but all port write operations will be discarded
11300	and all port read operations will return no data.
11301
11302	<see>IMachine::getSerialPort</see>
11303	</desc>
11304
11305	<attribute name="slot" type="unsigned long" readonly="yes">
11306	<desc>
11307	Slot number this serial port is plugged into. Corresponds to
11308	the value you pass to <link to="IMachine::getSerialPort"/>
11309	to obtain this instance.
11310	</desc>
11311	</attribute>
11312
11313	<attribute name="enabled" type="boolean">
11314	<desc>
11315	Flag whether the serial port is enabled. If disabled,
11316	the serial port will not be reported to the guest OS.
11317	</desc>
11318	</attribute>
11319
11320	<attribute name="IOBase" type="unsigned long">
11321	<desc>Base I/O address of the serial port.</desc>
11322	</attribute>
11323
11324	<attribute name="IRQ" type="unsigned long">
11325	<desc>IRQ number of the serial port.</desc>
11326	</attribute>
11327
11328	<attribute name="hostMode" type="PortMode">
11329	<desc>
11330	How is this port connected to the host.
11331	<note>
11332	Changing this attribute may fail if the conditions for
11333	<link to="#path"/> are not met.
11334	</note>
11335	</desc>
11336	</attribute>
11337
11338	<attribute name="server" type="boolean">
11339	<desc>
11340	Flag whether this serial port acts as a server (creates a new pipe on
11341	the host) or as a client (uses the existing pipe). This attribute is
11342	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11343	</desc>
11344	</attribute>
11345
11346	<attribute name="path" type="wstring">
11347	<desc>
11348	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11349	PortMode_HostPipe, or the host serial device name when
11350	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11351	cases, setting a @c null or empty string as the attribute's value
11352	is an error. Otherwise, the value of this property is ignored.
11353	</desc>
11354	</attribute>
11355
11356	</interface>
11357
11358	<!--
11359	// IParallelPort
11360	/////////////////////////////////////////////////////////////////////////
11361	-->
11362
11363	<interface
11364	name="IParallelPort" extends="$unknown"
11365	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11366	wsmap="managed"
11367	>
11368
11369	<desc>
11370	The IParallelPort interface represents the virtual parallel port device.
11371
11372	The virtual parallel port device acts like an ordinary parallel port
11373	inside the virtual machine. This device communicates to the real
11374	parallel port hardware using the name of the parallel device on the host
11375	computer specified in the #path attribute.
11376
11377	Each virtual parallel port device is assigned a base I/O address and an
11378	IRQ number that will be reported to the guest operating system and used
11379	to operate the given parallel port from within the virtual machine.
11380
11381	<see>IMachine::getParallelPort</see>
11382	</desc>
11383
11384	<attribute name="slot" type="unsigned long" readonly="yes">
11385	<desc>
11386	Slot number this parallel port is plugged into. Corresponds to
11387	the value you pass to <link to="IMachine::getParallelPort"/>
11388	to obtain this instance.
11389	</desc>
11390	</attribute>
11391
11392	<attribute name="enabled" type="boolean">
11393	<desc>
11394	Flag whether the parallel port is enabled. If disabled,
11395	the parallel port will not be reported to the guest OS.
11396	</desc>
11397	</attribute>
11398
11399	<attribute name="IOBase" type="unsigned long">
11400	<desc>Base I/O address of the parallel port.</desc>
11401	</attribute>
11402
11403	<attribute name="IRQ" type="unsigned long">
11404	<desc>IRQ number of the parallel port.</desc>
11405	</attribute>
11406
11407	<attribute name="path" type="wstring">
11408	<desc>
11409	Host parallel device name. If this parallel port is enabled, setting a
11410	@c null or an empty string as this attribute's value will result into
11411	an error.
11412	</desc>
11413	</attribute>
11414
11415	</interface>
11416
11417
11418	<!--
11419	// IMachineDebugger
11420	/////////////////////////////////////////////////////////////////////////
11421	-->
11422
11423	<interface
11424	name="IMachineDebugger" extends="$unknown"
11425	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11426	wsmap="suppress"
11427	>
11428	<method name="resetStats">
11429	<desc>
11430	Reset VM statistics.
11431	</desc>
11432	<param name="pattern" type="wstring" dir="in">
11433	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11434	</param>
11435	</method>
11436
11437	<method name="dumpStats">
11438	<desc>
11439	Dumps VM statistics.
11440	</desc>
11441	<param name="pattern" type="wstring" dir="in">
11442	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11443	</param>
11444	</method>
11445
11446	<method name="getStats">
11447	<desc>
11448	Get the VM statistics in a XMLish format.
11449	</desc>
11450	<param name="pattern" type="wstring" dir="in">
11451	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11452	</param>
11453	<param name="withDescriptions" type="boolean" dir="in">
11454	<desc>Whether to include the descriptions.</desc>
11455	</param>
11456	<param name="stats" type="wstring" dir="out">
11457	<desc>The XML document containing the statistics.</desc>
11458	</param>
11459	</method>
11460
11461	<method name="injectNMI">
11462	<desc>
11463	Inject an NMI into a running VT-x/AMD-V VM.
11464	</desc>
11465	</method>
11466
11467	<attribute name="singlestep" type="boolean">
11468	<desc>Switch for enabling singlestepping.</desc>
11469	</attribute>
11470
11471	<attribute name="recompileUser" type="boolean">
11472	<desc>Switch for forcing code recompilation for user mode code.</desc>
11473	</attribute>
11474
11475	<attribute name="recompileSupervisor" type="boolean">
11476	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11477	</attribute>
11478
11479	<attribute name="PATMEnabled" type="boolean">
11480	<desc>Switch for enabling and disabling the PATM component.</desc>
11481	</attribute>
11482
11483	<attribute name="CSAMEnabled" type="boolean">
11484	<desc>Switch for enabling and disabling the CSAM component.</desc>
11485	</attribute>
11486
11487	<attribute name="logEnabled" type="boolean">
11488	<desc>Switch for enabling and disabling logging.</desc>
11489	</attribute>
11490
11491	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11492	<desc>
11493	Flag indicating whether the VM is currently making use of CPU hardware
11494	virtualization extensions.
11495	</desc>
11496	</attribute>
11497
11498	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11499	<desc>
11500	Flag indicating whether the VM is currently making use of the nested paging
11501	CPU hardware virtualization extension.
11502	</desc>
11503	</attribute>
11504
11505	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11506	<desc>
11507	Flag indicating whether the VM is currently making use of the VPID
11508	VT-x extension.
11509	</desc>
11510	</attribute>
11511
11512	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11513	<desc>
11514	Flag indicating whether the VM is currently making use of the Physical
11515	Address Extension CPU feature.
11516	</desc>
11517	</attribute>
11518
11519	<attribute name="virtualTimeRate" type="unsigned long">
11520	<desc>
11521	The rate at which the virtual time runs expressed as a percentage.
11522	The accepted range is 2% to 20000%.
11523	</desc>
11524	</attribute>
11525
11526	<!-- @todo method for setting log flags, groups and destination! -->
11527
11528	<attribute name="VM" type="unsigned long long" readonly="yes">
11529	<desc>
11530	Gets the VM handle. This is only for internal use while
11531	we carve the details of this interface.
11532	</desc>
11533	</attribute>
11534
11535	</interface>
11536
11537	<!--
11538	// IUSBController
11539	/////////////////////////////////////////////////////////////////////////
11540	-->
11541
11542	<interface
11543	name="IUSBController" extends="$unknown"
11544	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11545	wsmap="managed"
11546	>
11547	<attribute name="enabled" type="boolean">
11548	<desc>
11549	Flag whether the USB controller is present in the
11550	guest system. If disabled, the virtual guest hardware will
11551	not contain any USB controller. Can only be changed when
11552	the VM is powered off.
11553	</desc>
11554	</attribute>
11555
11556	<attribute name="enabledEhci" type="boolean">
11557	<desc>
11558	Flag whether the USB EHCI controller is present in the
11559	guest system. If disabled, the virtual guest hardware will
11560	not contain a USB EHCI controller. Can only be changed when
11561	the VM is powered off.
11562	</desc>
11563	</attribute>
11564
11565	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11566	<desc>
11567	USB standard version which the controller implements.
11568	This is a BCD which means that the major version is in the
11569	high byte and minor version is in the low byte.
11570	</desc>
11571	</attribute>
11572
11573	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11574	<desc>
11575	List of USB device filters associated with the machine.
11576
11577	If the machine is currently running, these filters are activated
11578	every time a new (supported) USB device is attached to the host
11579	computer that was not ignored by global filters
11580	(<link to="IHost::USBDeviceFilters"/>).
11581
11582	These filters are also activated when the machine is powered up.
11583	They are run against a list of all currently available USB
11584	devices (in states
11585	<link to="USBDeviceState_Available"/>,
11586	<link to="USBDeviceState_Busy"/>,
11587	<link to="USBDeviceState_Held"/>) that were not previously
11588	ignored by global filters.
11589
11590	If at least one filter matches the USB device in question, this
11591	device is automatically captured (attached to) the virtual USB
11592	controller of this machine.
11593
11594	<see>IUSBDeviceFilter, ::IUSBController</see>
11595	</desc>
11596	</attribute>
11597
11598	<method name="createDeviceFilter">
11599	<desc>
11600	Creates a new USB device filter. All attributes except
11601	the filter name are set to empty (any match),
11602	<i>active</i> is @c false (the filter is not active).
11603
11604	The created filter can then be added to the list of filters using
11605	<link to="#insertDeviceFilter"/>.
11606
11607	<result name="VBOX_E_INVALID_VM_STATE">
11608	The virtual machine is not mutable.
11609	</result>
11610
11611	<see>#deviceFilters</see>
11612	</desc>
11613	<param name="name" type="wstring" dir="in">
11614	<desc>
11615	Filter name. See <link to="IUSBDeviceFilter::name"/>
11616	for more info.
11617	</desc>
11618	</param>
11619	<param name="filter" type="IUSBDeviceFilter" dir="return">
11620	<desc>Created filter object.</desc>
11621	</param>
11622	</method>
11623
11624	<method name="insertDeviceFilter">
11625	<desc>
11626	Inserts the given USB device to the specified position
11627	in the list of filters.
11628
11629	Positions are numbered starting from <tt>0</tt>. If the specified
11630	position is equal to or greater than the number of elements in
11631	the list, the filter is added to the end of the collection.
11632
11633	<note>
11634	Duplicates are not allowed, so an attempt to insert a
11635	filter that is already in the collection, will return an
11636	error.
11637	</note>
11638
11639	<result name="VBOX_E_INVALID_VM_STATE">
11640	Virtual machine is not mutable.
11641	</result>
11642	<result name="E_INVALIDARG">
11643	USB device filter not created within this VirtualBox instance.
11644	</result>
11645	<result name="VBOX_E_INVALID_OBJECT_STATE">
11646	USB device filter already in list.
11647	</result>
11648
11649	<see>#deviceFilters</see>
11650	</desc>
11651	<param name="position" type="unsigned long" dir="in">
11652	<desc>Position to insert the filter to.</desc>
11653	</param>
11654	<param name="filter" type="IUSBDeviceFilter" dir="in">
11655	<desc>USB device filter to insert.</desc>
11656	</param>
11657	</method>
11658
11659	<method name="removeDeviceFilter">
11660	<desc>
11661	Removes a USB device filter from the specified position in the
11662	list of filters.
11663
11664	Positions are numbered starting from <tt>0</tt>. Specifying a
11665	position equal to or greater than the number of elements in
11666	the list will produce an error.
11667
11668	<see>#deviceFilters</see>
11669
11670	<result name="VBOX_E_INVALID_VM_STATE">
11671	Virtual machine is not mutable.
11672	</result>
11673	<result name="E_INVALIDARG">
11674	USB device filter list empty or invalid @a position.
11675	</result>
11676
11677	</desc>
11678	<param name="position" type="unsigned long" dir="in">
11679	<desc>Position to remove the filter from.</desc>
11680	</param>
11681	<param name="filter" type="IUSBDeviceFilter" dir="return">
11682	<desc>Removed USB device filter.</desc>
11683	</param>
11684	</method>
11685
11686	</interface>
11687
11688
11689	<!--
11690	// IUSBDevice
11691	/////////////////////////////////////////////////////////////////////////
11692	-->
11693
11694	<interface
11695	name="IUSBDevice" extends="$unknown"
11696	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11697	wsmap="managed"
11698	>
11699	<desc>
11700	The IUSBDevice interface represents a virtual USB device attached to the
11701	virtual machine.
11702
11703	A collection of objects implementing this interface is stored in the
11704	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11705	attached to a running virtual machine's USB controller.
11706	</desc>
11707
11708	<attribute name="id" type="uuid" mod="string" readonly="yes">
11709	<desc>
11710	Unique USB device ID. This ID is built from #vendorId,
11711	#productId, #revision and #serialNumber.
11712	</desc>
11713	</attribute>
11714
11715	<attribute name="vendorId" type="unsigned short" readonly="yes">
11716	<desc>Vendor ID.</desc>
11717	</attribute>
11718
11719	<attribute name="productId" type="unsigned short" readonly="yes">
11720	<desc>Product ID.</desc>
11721	</attribute>
11722
11723	<attribute name="revision" type="unsigned short" readonly="yes">
11724	<desc>
11725	Product revision number. This is a packed BCD represented as
11726	unsigned short. The high byte is the integer part and the low
11727	byte is the decimal.
11728	</desc>
11729	</attribute>
11730
11731	<attribute name="manufacturer" type="wstring" readonly="yes">
11732	<desc>Manufacturer string.</desc>
11733	</attribute>
11734
11735	<attribute name="product" type="wstring" readonly="yes">
11736	<desc>Product string.</desc>
11737	</attribute>
11738
11739	<attribute name="serialNumber" type="wstring" readonly="yes">
11740	<desc>Serial number string.</desc>
11741	</attribute>
11742
11743	<attribute name="address" type="wstring" readonly="yes">
11744	<desc>Host specific address of the device.</desc>
11745	</attribute>
11746
11747	<attribute name="port" type="unsigned short" readonly="yes">
11748	<desc>
11749	Host USB port number the device is physically
11750	connected to.
11751	</desc>
11752	</attribute>
11753
11754	<attribute name="version" type="unsigned short" readonly="yes">
11755	<desc>
11756	The major USB version of the device - 1 or 2.
11757	</desc>
11758	</attribute>
11759
11760	<attribute name="portVersion" type="unsigned short" readonly="yes">
11761	<desc>
11762	The major USB version of the host USB port the device is
11763	physically connected to - 1 or 2. For devices not connected to
11764	anything this will have the same value as the version attribute.
11765	</desc>
11766	</attribute>
11767
11768	<attribute name="remote" type="boolean" readonly="yes">
11769	<desc>
11770	Whether the device is physically connected to a remote VRDP
11771	client or to a local host machine.
11772	</desc>
11773	</attribute>
11774
11775	</interface>
11776
11777
11778	<!--
11779	// IUSBDeviceFilter
11780	/////////////////////////////////////////////////////////////////////////
11781	-->
11782
11783	<interface
11784	name="IUSBDeviceFilter" extends="$unknown"
11785	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11786	wsmap="managed"
11787	>
11788	<desc>
11789	The IUSBDeviceFilter interface represents an USB device filter used
11790	to perform actions on a group of USB devices.
11791
11792	This type of filters is used by running virtual machines to
11793	automatically capture selected USB devices once they are physically
11794	attached to the host computer.
11795
11796	A USB device is matched to the given device filter if and only if all
11797	attributes of the device match the corresponding attributes of the
11798	filter (that is, attributes are joined together using the logical AND
11799	operation). On the other hand, all together, filters in the list of
11800	filters carry the semantics of the logical OR operation. So if it is
11801	desirable to create a match like "this vendor id OR this product id",
11802	one needs to create two filters and specify "any match" (see below)
11803	for unused attributes.
11804
11805	All filter attributes used for matching are strings. Each string
11806	is an expression representing a set of values of the corresponding
11807	device attribute, that will match the given filter. Currently, the
11808	following filtering expressions are supported:
11809
11810	<ul>
11811	<li><i>Interval filters</i>. Used to specify valid intervals for
11812	integer device attributes (Vendor ID, Product ID and Revision).
11813	The format of the string is:
11814
11815	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11816
11817	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11818	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11819	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11820	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11821	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11822	possible integer is assumed.
11823	</li>
11824	<li><i>Boolean filters</i>. Used to specify acceptable values for
11825	boolean device attributes. The format of the string is:
11826
11827	<tt>true\|false\|yes\|no\|0\|1</tt>
11828
11829	</li>
11830	<li><i>Exact match</i>. Used to specify a single value for the given
11831	device attribute. Any string that doesn't start with <tt>int:</tt>
11832	represents the exact match. String device attributes are compared to
11833	this string including case of symbols. Integer attributes are first
11834	converted to a string (see individual filter attributes) and then
11835	compared ignoring case.
11836
11837	</li>
11838	<li><i>Any match</i>. Any value of the corresponding device attribute
11839	will match the given filter. An empty or @c null string is
11840	used to construct this type of filtering expressions.
11841
11842	</li>
11843	</ul>
11844
11845	<note>
11846	On the Windows host platform, interval filters are not currently
11847	available. Also all string filter attributes
11848	(<link to="#manufacturer"/>, <link to="#product"/>,
11849	<link to="#serialNumber"/>) are ignored, so they behave as
11850	<i>any match</i> no matter what string expression is specified.
11851	</note>
11852
11853	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11854	</desc>
11855
11856	<attribute name="name" type="wstring">
11857	<desc>
11858	Visible name for this filter.
11859	This name is used to visually distinguish one filter from another,
11860	so it can neither be @c null nor an empty string.
11861	</desc>
11862	</attribute>
11863
11864	<attribute name="active" type="boolean">
11865	<desc>Whether this filter active or has been temporarily disabled.</desc>
11866	</attribute>
11867
11868	<attribute name="vendorId" type="wstring">
11869	<desc>
11870	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11871	The string representation for the <i>exact matching</i>
11872	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11873	(including leading zeroes).
11874	</desc>
11875	</attribute>
11876
11877	<attribute name="productId" type="wstring">
11878	<desc>
11879	<link to="IUSBDevice::productId">Product ID</link> filter.
11880	The string representation for the <i>exact matching</i>
11881	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11882	(including leading zeroes).
11883	</desc>
11884	</attribute>
11885
11886	<attribute name="revision" type="wstring">
11887	<desc>
11888	<link to="IUSBDevice::productId">Product revision number</link>
11889	filter. The string representation for the <i>exact matching</i>
11890	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11891	of the integer part of the revision, and <tt>F</tt> is the
11892	decimal digit of its fractional part (including leading and
11893	trailing zeros).
11894	Note that for interval filters, it's best to use the hexadecimal
11895	form, because the revision is stored as a 16 bit packed BCD value;
11896	so the expression <tt>int:0x0100-0x0199</tt> will match any
11897	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="manufacturer" type="wstring">
11902	<desc>
11903	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11904	</desc>
11905	</attribute>
11906
11907	<attribute name="product" type="wstring">
11908	<desc>
11909	<link to="IUSBDevice::product">Product</link> filter.
11910	</desc>
11911	</attribute>
11912
11913	<attribute name="serialNumber" type="wstring">
11914	<desc>
11915	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11916	</desc>
11917	</attribute>
11918
11919	<attribute name="port" type="wstring">
11920	<desc>
11921	<link to="IUSBDevice::port">Host USB port</link> filter.
11922	</desc>
11923	</attribute>
11924
11925	<attribute name="remote" type="wstring">
11926	<desc>
11927	<link to="IUSBDevice::remote">Remote state</link> filter.
11928	<note>
11929	This filter makes sense only for machine USB filters,
11930	i.e. it is ignored by IHostUSBDeviceFilter objects.
11931	</note>
11932	</desc>
11933	</attribute>
11934
11935	<attribute name="maskedInterfaces" type="unsigned long">
11936	<desc>
11937	This is an advanced option for hiding one or more USB interfaces
11938	from the guest. The value is a bit mask where the bits that are set
11939	means the corresponding USB interface should be hidden, masked off
11940	if you like.
11941	This feature only works on Linux hosts.
11942	</desc>
11943	</attribute>
11944
11945	</interface>
11946
11947
11948	<!--
11949	// IHostUSBDevice
11950	/////////////////////////////////////////////////////////////////////////
11951	-->
11952
11953	<enum
11954	name="USBDeviceState"
11955	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11956	>
11957	<desc>
11958	USB device state. This enumeration represents all possible states
11959	of the USB device physically attached to the host computer regarding
11960	its state on the host computer and availability to guest computers
11961	(all currently running virtual machines).
11962
11963	Once a supported USB device is attached to the host, global USB
11964	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11965	either ignore the device, or put it to USBDeviceState_Held state, or do
11966	nothing. Unless the device is ignored by global filters, filters of all
11967	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11968	activated that can put it to USBDeviceState_Captured state.
11969
11970	If the device was ignored by global filters, or didn't match
11971	any filters at all (including guest ones), it is handled by the host
11972	in a normal way. In this case, the device state is determined by
11973	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11974	or USBDeviceState_Available, depending on the current device usage.
11975
11976	Besides auto-capturing based on filters, the device can be manually
11977	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11978	state is USBDeviceState_Busy, USBDeviceState_Available or
11979	USBDeviceState_Held.
11980
11981	<note>
11982	Due to differences in USB stack implementations in Linux and Win32,
11983	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11984	only to the Linux version of the product. This also means that (<link
11985	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11986	device state is USBDeviceState_Held.
11987	</note>
11988
11989	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11990	</desc>
11991
11992	<const name="NotSupported" value="0">
11993	<desc>
11994	Not supported by the VirtualBox server, not available to guests.
11995	</desc>
11996	</const>
11997	<const name="Unavailable" value="1">
11998	<desc>
11999	Being used by the host computer exclusively,
12000	not available to guests.
12001	</desc>
12002	</const>
12003	<const name="Busy" value="2">
12004	<desc>
12005	Being used by the host computer, potentially available to guests.
12006	</desc>
12007	</const>
12008	<const name="Available" value="3">
12009	<desc>
12010	Not used by the host computer, available to guests (the host computer
12011	can also start using the device at any time).
12012	</desc>
12013	</const>
12014	<const name="Held" value="4">
12015	<desc>
12016	Held by the VirtualBox server (ignored by the host computer),
12017	available to guests.
12018	</desc>
12019	</const>
12020	<const name="Captured" value="5">
12021	<desc>
12022	Captured by one of the guest computers, not available
12023	to anybody else.
12024	</desc>
12025	</const>
12026	</enum>
12027
12028	<interface
12029	name="IHostUSBDevice" extends="IUSBDevice"
12030	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12031	wsmap="managed"
12032	>
12033	<desc>
12034	The IHostUSBDevice interface represents a physical USB device attached
12035	to the host computer.
12036
12037	Besides properties inherited from IUSBDevice, this interface adds the
12038	<link to="#state"/> property that holds the current state of the USB
12039	device.
12040
12041	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12042	</desc>
12043
12044	<attribute name="state" type="USBDeviceState" readonly="yes">
12045	<desc>
12046	Current state of the device.
12047	</desc>
12048	</attribute>
12049
12050	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12051
12052	</interface>
12053
12054
12055	<!--
12056	// IHostUSBDeviceFilter
12057	/////////////////////////////////////////////////////////////////////////
12058	-->
12059
12060	<enum
12061	name="USBDeviceFilterAction"
12062	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12063	>
12064	<desc>
12065	Actions for host USB device filters.
12066	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12067	</desc>
12068
12069	<const name="Null" value="0">
12070	<desc>Null value (never used by the API).</desc>
12071	</const>
12072	<const name="Ignore" value="1">
12073	<desc>Ignore the matched USB device.</desc>
12074	</const>
12075	<const name="Hold" value="2">
12076	<desc>Hold the matched USB device.</desc>
12077	</const>
12078	</enum>
12079
12080	<interface
12081	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12082	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12083	wsmap="managed"
12084	>
12085	<desc>
12086	The IHostUSBDeviceFilter interface represents a global filter for a
12087	physical USB device used by the host computer. Used indirectly in
12088	<link to="IHost::USBDeviceFilters"/>.
12089
12090	Using filters of this type, the host computer determines the initial
12091	state of the USB device after it is physically attached to the
12092	host's USB controller.
12093
12094	<note>
12095	The <link to="#remote"/> attribute is ignored by this type of
12096	filters, because it makes sense only for
12097	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12098	</note>
12099
12100	<see>IHost::USBDeviceFilters</see>
12101	</desc>
12102
12103	<attribute name="action" type="USBDeviceFilterAction">
12104	<desc>
12105	Action performed by the host when an attached USB device
12106	matches this filter.
12107	</desc>
12108	</attribute>
12109
12110	</interface>
12111
12112	<!--
12113	// IAudioAdapter
12114	/////////////////////////////////////////////////////////////////////////
12115	-->
12116
12117	<enum
12118	name="AudioDriverType"
12119	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12120	>
12121	<desc>
12122	Host audio driver type.
12123	</desc>
12124
12125	<const name="Null" value="0">
12126	<desc>Null value, also means "dummy audio driver".</desc>
12127	</const>
12128	<const name="WinMM" value="1">
12129	<desc>Windows multimedia (Windows hosts only).</desc>
12130	</const>
12131	<const name="OSS" value="2">
12132	<desc>Open Sound System (Linux hosts only).</desc>
12133	</const>
12134	<const name="ALSA" value="3">
12135	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12136	</const>
12137	<const name="DirectSound" value="4">
12138	<desc>DirectSound (Windows hosts only).</desc>
12139	</const>
12140	<const name="CoreAudio" value="5">
12141	<desc>CoreAudio (Mac hosts only).</desc>
12142	</const>
12143	<const name="MMPM" value="6">
12144	<desc>Reserved for historical reasons.</desc>
12145	</const>
12146	<const name="Pulse" value="7">
12147	<desc>PulseAudio (Linux hosts only).</desc>
12148	</const>
12149	<const name="SolAudio" value="8">
12150	<desc>Solaris audio (Solaris hosts only).</desc>
12151	</const>
12152	</enum>
12153
12154	<enum
12155	name="AudioControllerType"
12156	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12157	>
12158	<desc>
12159	Virtual audio controller type.
12160	</desc>
12161
12162	<const name="AC97" value="0"/>
12163	<const name="SB16" value="1"/>
12164	</enum>
12165
12166	<interface
12167	name="IAudioAdapter" extends="$unknown"
12168	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12169	wsmap="managed"
12170	>
12171	<desc>
12172	The IAudioAdapter interface represents the virtual audio adapter of
12173	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12174	</desc>
12175	<attribute name="enabled" type="boolean">
12176	<desc>
12177	Flag whether the audio adapter is present in the
12178	guest system. If disabled, the virtual guest hardware will
12179	not contain any audio adapter. Can only be changed when
12180	the VM is not running.
12181	</desc>
12182	</attribute>
12183	<attribute name="audioController" type="AudioControllerType">
12184	<desc>
12185	The audio hardware we emulate.
12186	</desc>
12187	</attribute>
12188	<attribute name="audioDriver" type="AudioDriverType">
12189	<desc>
12190	Audio driver the adapter is connected to. This setting
12191	can only be changed when the VM is not running.
12192	</desc>
12193	</attribute>
12194	</interface>
12195
12196	<!--
12197	// IVRDPServer
12198	/////////////////////////////////////////////////////////////////////////
12199	-->
12200
12201	<enum
12202	name="VRDPAuthType"
12203	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12204	>
12205	<desc>
12206	VRDP authentication type.
12207	</desc>
12208
12209	<const name="Null" value="0">
12210	<desc>Null value, also means "no authentication".</desc>
12211	</const>
12212	<const name="External" value="1"/>
12213	<const name="Guest" value="2"/>
12214	</enum>
12215
12216	<interface
12217	name="IVRDPServer" extends="$unknown"
12218	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12219	wsmap="managed"
12220	>
12221	<attribute name="enabled" type="boolean">
12222	<desc>VRDP server status.</desc>
12223	</attribute>
12224
12225	<attribute name="ports" type="wstring">
12226	<desc>
12227	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12228	<note>
12229	This is a string of comma separated TCP port numbers or port number ranges.
12230	Example <tt>5000,5010-5012,5015</tt>
12231	</note>
12232	</desc>
12233	</attribute>
12234
12235	<attribute name="netAddress" type="wstring">
12236	<desc>VRDP server address.</desc>
12237	</attribute>
12238
12239	<attribute name="authType" type="VRDPAuthType">
12240	<desc>VRDP authentication method.</desc>
12241	</attribute>
12242
12243	<attribute name="authTimeout" type="unsigned long">
12244	<desc>Timeout for guest authentication. Milliseconds.</desc>
12245	</attribute>
12246
12247	<attribute name="allowMultiConnection" type="boolean">
12248	<desc>
12249	Flag whether multiple simultaneous connections to the VM are permitted.
12250	Note that this will be replaced by a more powerful mechanism in the future.
12251	</desc>
12252	</attribute>
12253
12254	<attribute name="reuseSingleConnection" type="boolean">
12255	<desc>
12256	Flag whether the existing connection must be dropped and a new connection
12257	must be established by the VRDP server, when a new client connects in single
12258	connection mode.
12259	</desc>
12260	</attribute>
12261
12262	</interface>
12263
12264
12265	<!--
12266	// ISharedFolder
12267	/////////////////////////////////////////////////////////////////////////
12268	-->
12269
12270	<interface
12271	name="ISharedFolder" extends="$unknown"
12272	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12273	wsmap="struct"
12274	>
12275	<desc>
12276	The ISharedFolder interface represents a folder in the host computer's
12277	file system accessible from the guest OS running inside a virtual
12278	machine using an associated logical name.
12279
12280	There are three types of shared folders:
12281	<ul>
12282	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12283	folders available to all virtual machines.</li>
12284	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12285	VM-specific shared folders available to the given virtual machine at
12286	startup.</li>
12287	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12288	VM-specific shared folders created in the session context (for
12289	example, when the virtual machine is running) and automatically
12290	discarded when the session is closed (the VM is powered off).</li>
12291	</ul>
12292
12293	Logical names of shared folders must be unique within the given scope
12294	(global, permanent or transient). However, they do not need to be unique
12295	across scopes. In this case, the definition of the shared folder in a
12296	more specific scope takes precedence over definitions in all other
12297	scopes. The order of precedence is (more specific to more general):
12298	<ol>
12299	<li>Transient definitions</li>
12300	<li>Permanent definitions</li>
12301	<li>Global definitions</li>
12302	</ol>
12303
12304	For example, if MyMachine has a shared folder named
12305	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12306	transient shared folder named <tt>C_DRIVE</tt> (that points
12307	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12308	of <tt>C_DRIVE</tt> in the guest OS so
12309	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12310	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12311	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12312	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12313	to <tt>C:\\</tt> if it still exists.
12314
12315	Note that permanent and transient shared folders of different machines
12316	are in different name spaces, so they don't overlap and don't need to
12317	have unique logical names.
12318
12319	<note>
12320	Global shared folders are not implemented in the current version of the
12321	product.
12322	</note>
12323	</desc>
12324
12325	<attribute name="name" type="wstring" readonly="yes">
12326	<desc>Logical name of the shared folder.</desc>
12327	</attribute>
12328
12329	<attribute name="hostPath" type="wstring" readonly="yes">
12330	<desc>Full path to the shared folder in the host file system.</desc>
12331	</attribute>
12332
12333	<attribute name="accessible" type="boolean" readonly="yes">
12334	<desc>
12335	Whether the folder defined by the host path is currently
12336	accessible or not.
12337	For example, the folder can be unaccessible if it is placed
12338	on the network share that is not available by the time
12339	this property is read.
12340	</desc>
12341	</attribute>
12342
12343	<attribute name="writable" type="boolean" readonly="yes">
12344	<desc>
12345	Whether the folder defined by the host path is writable or
12346	not.
12347	</desc>
12348	</attribute>
12349
12350	<attribute name="lastAccessError" type="wstring" readonly="yes">
12351	<desc>
12352	Text message that represents the result of the last accessibility
12353	check.
12354
12355	Accessibility checks are performed each time the <link to="#accessible"/>
12356	attribute is read. An empty string is returned if the last
12357	accessibility check was successful. A non-empty string indicates a
12358	failure and should normally describe a reason of the failure (for
12359	example, a file read error).
12360	</desc>
12361	</attribute>
12362
12363	</interface>
12364
12365	<!--
12366	// ISession
12367	/////////////////////////////////////////////////////////////////////////
12368	-->
12369
12370	<interface
12371	name="IInternalSessionControl" extends="$unknown"
12372	uuid="989e2c33-8dfa-437a-9a15-5ad441d50dbf"
12373	internal="yes"
12374	wsmap="suppress"
12375	>
12376	<method name="getPID">
12377	<desc>PID of the process that has created this Session object.
12378	</desc>
12379	<param name="pid" type="unsigned long" dir="return"/>
12380	</method>
12381
12382	<method name="getRemoteConsole">
12383	<desc>
12384	Returns the console object suitable for remote control.
12385
12386	<result name="VBOX_E_INVALID_VM_STATE">
12387	Session state prevents operation.
12388	</result>
12389	<result name="VBOX_E_INVALID_OBJECT_STATE">
12390	Session type prevents operation.
12391	</result>
12392
12393	</desc>
12394	<param name="console" type="IConsole" dir="return"/>
12395	</method>
12396
12397	<method name="assignMachine">
12398	<desc>
12399	Assigns the machine object associated with this direct-type
12400	session or informs the session that it will be a remote one
12401	(if @a machine == @c null).
12402
12403	<result name="VBOX_E_INVALID_VM_STATE">
12404	Session state prevents operation.
12405	</result>
12406	<result name="VBOX_E_INVALID_OBJECT_STATE">
12407	Session type prevents operation.
12408	</result>
12409
12410	</desc>
12411	<param name="machine" type="IMachine" dir="in"/>
12412	</method>
12413
12414	<method name="assignRemoteMachine">
12415	<desc>
12416	Assigns the machine and the (remote) console object associated with
12417	this remote-type session.
12418
12419	<result name="VBOX_E_INVALID_VM_STATE">
12420	Session state prevents operation.
12421	</result>
12422
12423	</desc>
12424	<param name="machine" type="IMachine" dir="in"/>
12425	<param name="console" type="IConsole" dir="in"/>
12426	</method>
12427
12428	<method name="updateMachineState">
12429	<desc>
12430	Updates the machine state in the VM process.
12431	Must be called only in certain cases
12432	(see the method implementation).
12433
12434	<result name="VBOX_E_INVALID_VM_STATE">
12435	Session state prevents operation.
12436	</result>
12437	<result name="VBOX_E_INVALID_OBJECT_STATE">
12438	Session type prevents operation.
12439	</result>
12440
12441	</desc>
12442	<param name="aMachineState" type="MachineState" dir="in"/>
12443	</method>
12444
12445	<method name="uninitialize">
12446	<desc>
12447	Uninitializes (closes) this session. Used by VirtualBox to close
12448	the corresponding remote session when the direct session dies
12449	or gets closed.
12450
12451	<result name="VBOX_E_INVALID_VM_STATE">
12452	Session state prevents operation.
12453	</result>
12454
12455	</desc>
12456	</method>
12457
12458	<method name="onNetworkAdapterChange">
12459	<desc>
12460	Triggered when settings of a network adapter of the
12461	associated virtual machine have changed.
12462
12463	<result name="VBOX_E_INVALID_VM_STATE">
12464	Session state prevents operation.
12465	</result>
12466	<result name="VBOX_E_INVALID_OBJECT_STATE">
12467	Session type prevents operation.
12468	</result>
12469
12470	</desc>
12471	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12472	<param name="changeAdapter" type="boolean" dir="in"/>
12473	</method>
12474
12475	<method name="onSerialPortChange">
12476	<desc>
12477	Triggered when settings of a serial port of the
12478	associated virtual machine have changed.
12479
12480	<result name="VBOX_E_INVALID_VM_STATE">
12481	Session state prevents operation.
12482	</result>
12483	<result name="VBOX_E_INVALID_OBJECT_STATE">
12484	Session type prevents operation.
12485	</result>
12486
12487	</desc>
12488	<param name="serialPort" type="ISerialPort" dir="in"/>
12489	</method>
12490
12491	<method name="onParallelPortChange">
12492	<desc>
12493	Triggered when settings of a parallel port of the
12494	associated virtual machine have changed.
12495
12496	<result name="VBOX_E_INVALID_VM_STATE">
12497	Session state prevents operation.
12498	</result>
12499	<result name="VBOX_E_INVALID_OBJECT_STATE">
12500	Session type prevents operation.
12501	</result>
12502
12503	</desc>
12504	<param name="parallelPort" type="IParallelPort" dir="in"/>
12505	</method>
12506
12507	<method name="onStorageControllerChange">
12508	<desc>
12509	Triggered when settings of a storage controller of the
12510	associated virtual machine have changed.
12511
12512	<result name="VBOX_E_INVALID_VM_STATE">
12513	Session state prevents operation.
12514	</result>
12515	<result name="VBOX_E_INVALID_OBJECT_STATE">
12516	Session type prevents operation.
12517	</result>
12518
12519	</desc>
12520	</method>
12521
12522	<method name="onMediumChange">
12523	<desc>
12524	Triggered when attached media of the
12525	associated virtual machine have changed.
12526
12527	<result name="VBOX_E_INVALID_VM_STATE">
12528	Session state prevents operation.
12529	</result>
12530	<result name="VBOX_E_INVALID_OBJECT_STATE">
12531	Session type prevents operation.
12532	</result>
12533
12534	</desc>
12535
12536	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12537	</method>
12538
12539	<method name="onVRDPServerChange">
12540	<desc>
12541	Triggered when settings of the VRDP server object of the
12542	associated virtual machine have changed.
12543
12544	<result name="VBOX_E_INVALID_VM_STATE">
12545	Session state prevents operation.
12546	</result>
12547	<result name="VBOX_E_INVALID_OBJECT_STATE">
12548	Session type prevents operation.
12549	</result>
12550
12551	</desc>
12552	</method>
12553
12554	<method name="onUSBControllerChange">
12555	<desc>
12556	Triggered when settings of the USB controller object of the
12557	associated virtual machine have changed.
12558
12559	<result name="VBOX_E_INVALID_VM_STATE">
12560	Session state prevents operation.
12561	</result>
12562	<result name="VBOX_E_INVALID_OBJECT_STATE">
12563	Session type prevents operation.
12564	</result>
12565
12566	</desc>
12567	</method>
12568
12569	<method name="onSharedFolderChange">
12570	<desc>
12571	Triggered when a permanent (global or machine) shared folder has been
12572	created or removed.
12573	<note>
12574	We don't pass shared folder parameters in this notification because
12575	the order in which parallel notifications are delivered is not defined,
12576	therefore it could happen that these parameters were outdated by the
12577	time of processing this notification.
12578	</note>
12579
12580	<result name="VBOX_E_INVALID_VM_STATE">
12581	Session state prevents operation.
12582	</result>
12583	<result name="VBOX_E_INVALID_OBJECT_STATE">
12584	Session type prevents operation.
12585	</result>
12586
12587	</desc>
12588	<param name="global" type="boolean" dir="in"/>
12589	</method>
12590
12591	<method name="onUSBDeviceAttach">
12592	<desc>
12593	Triggered when a request to capture a USB device (as a result
12594	of matched USB filters or direct call to
12595	<link to="IConsole::attachUSBDevice"/>) has completed.
12596	A @c null @a error object means success, otherwise it
12597	describes a failure.
12598
12599	<result name="VBOX_E_INVALID_VM_STATE">
12600	Session state prevents operation.
12601	</result>
12602	<result name="VBOX_E_INVALID_OBJECT_STATE">
12603	Session type prevents operation.
12604	</result>
12605
12606	</desc>
12607	<param name="device" type="IUSBDevice" dir="in"/>
12608	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12609	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12610	</method>
12611
12612	<method name="onUSBDeviceDetach">
12613	<desc>
12614	Triggered when a request to release the USB device (as a result
12615	of machine termination or direct call to
12616	<link to="IConsole::detachUSBDevice"/>) has completed.
12617	A @c null @a error object means success, otherwise it
12618	describes a failure.
12619
12620	<result name="VBOX_E_INVALID_VM_STATE">
12621	Session state prevents operation.
12622	</result>
12623	<result name="VBOX_E_INVALID_OBJECT_STATE">
12624	Session type prevents operation.
12625	</result>
12626
12627	</desc>
12628	<param name="id" type="uuid" mod="string" dir="in"/>
12629	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12630	</method>
12631
12632	<method name="onShowWindow">
12633	<desc>
12634	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12635	<link to="IMachine::showConsoleWindow"/> in order to notify
12636	console callbacks
12637	<link to="IConsoleCallback::onCanShowWindow"/>
12638	and <link to="IConsoleCallback::onShowWindow"/>.
12639
12640	<result name="VBOX_E_INVALID_OBJECT_STATE">
12641	Session type prevents operation.
12642	</result>
12643
12644	</desc>
12645	<param name="check" type="boolean" dir="in"/>
12646	<param name="canShow" type="boolean" dir="out"/>
12647	<param name="winId" type="unsigned long long" dir="out"/>
12648	</method>
12649
12650	<method name="accessGuestProperty">
12651	<desc>
12652	Called by <link to="IMachine::getGuestProperty"/> and by
12653	<link to="IMachine::setGuestProperty"/> in order to read and
12654	modify guest properties.
12655
12656	<result name="VBOX_E_INVALID_VM_STATE">
12657	Machine session is not open.
12658	</result>
12659	<result name="VBOX_E_INVALID_OBJECT_STATE">
12660	Session type is not direct.
12661	</result>
12662
12663	</desc>
12664	<param name="name" type="wstring" dir="in"/>
12665	<param name="value" type="wstring" dir="in"/>
12666	<param name="flags" type="wstring" dir="in"/>
12667	<param name="isSetter" type="boolean" dir="in"/>
12668	<param name="retValue" type="wstring" dir="out"/>
12669	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12670	<param name="retFlags" type="wstring" dir="out"/>
12671	</method>
12672
12673	<method name="enumerateGuestProperties">
12674	<desc>
12675	Return a list of the guest properties matching a set of patterns along
12676	with their values, time stamps and flags.
12677
12678	<result name="VBOX_E_INVALID_VM_STATE">
12679	Machine session is not open.
12680	</result>
12681	<result name="VBOX_E_INVALID_OBJECT_STATE">
12682	Session type is not direct.
12683	</result>
12684
12685	</desc>
12686	<param name="patterns" type="wstring" dir="in">
12687	<desc>
12688	The patterns to match the properties against as a comma-separated
12689	string. If this is empty, all properties currently set will be
12690	returned.
12691	</desc>
12692	</param>
12693	<param name="key" type="wstring" dir="out" safearray="yes">
12694	<desc>
12695	The key names of the properties returned.
12696	</desc>
12697	</param>
12698	<param name="value" type="wstring" dir="out" safearray="yes">
12699	<desc>
12700	The values of the properties returned. The array entries match the
12701	corresponding entries in the @a key array.
12702	</desc>
12703	</param>
12704	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12705	<desc>
12706	The time stamps of the properties returned. The array entries match
12707	the corresponding entries in the @a key array.
12708	</desc>
12709	</param>
12710	<param name="flags" type="wstring" dir="out" safearray="yes">
12711	<desc>
12712	The flags of the properties returned. The array entries match the
12713	corresponding entries in the @a key array.
12714	</desc>
12715	</param>
12716	</method>
12717
12718	</interface>
12719
12720	<interface
12721	name="ISession" extends="$dispatched"
12722	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12723	wsmap="managed"
12724	>
12725	<desc>
12726	The ISession interface represents a serialization primitive for virtual
12727	machines.
12728
12729	With VirtualBox, every time one wishes to manipulate a virtual machine
12730	(e.g. change its settings or start execution), a session object is
12731	required. Such an object must be passed to one of the session methods
12732	that open the given session, which then initiates the machine manipulation.
12733
12734	A session serves several purposes: it identifies to the inter-process VirtualBox
12735	code which process is currently working with the virtual machine, and it ensures
12736	that there are no incompatible requests from several processes for the
12737	same virtual machine. Session objects can therefore be thought of as mutex
12738	semaphores that lock virtual machines to prevent conflicting accesses from
12739	several processes.
12740
12741	How sessions objects are used depends on whether you use the Main API
12742	via COM or via the webservice:
12743
12744	<ul>
12745	<li>When using the COM API directly, an object of the Session class from the
12746	VirtualBox type library needs to be created. In regular COM C++ client code,
12747	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12748	This object will then act as a local session object in further calls to open
12749	a session.
12750	</li>
12751
12752	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12753	one session object automatically when <link to="IWebsessionManager::logon" />
12754	is called. A managed object reference to that session object can be retrieved by
12755	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12756	reference can then be used to open sessions.
12757	</li>
12758	</ul>
12759
12760	Sessions are mainly used in two variations:
12761
12762	<ul>
12763	<li>
12764	To start a virtual machine in a separate process, one would call
12765	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12766	object as its first parameter. This session then identifies the caller
12767	and lets him control the started machine (for example, pause machine
12768	execution or power it down) as well as be notified about machine
12769	execution state changes.
12770	</li>
12771
12772	<li>To alter machine settings, or to start machine execution within the
12773	current process, one needs to open a direct session for the machine first by
12774	calling <link to="IVirtualBox::openSession"/>. While a direct session
12775	is open within one process, no any other process may open another direct
12776	session for the same machine. This prevents the machine from being changed
12777	by other processes while it is running or while the machine is being configured.
12778	</li>
12779	</ul>
12780
12781	One also can attach to an existing direct session already opened by
12782	another process (for example, in order to send a control request to the
12783	virtual machine such as the pause or the reset request). This is done by
12784	calling <link to="IVirtualBox::openExistingSession"/>.
12785
12786	<note>
12787	Unless you are trying to write a new VirtualBox front-end that
12788	performs direct machine execution (like the VirtualBox or VBoxSDL
12789	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12790	session opened by <link to="IVirtualBox::openSession"/> and use this
12791	session only to change virtual machine settings. If you simply want to
12792	start virtual machine execution using one of the existing front-ends
12793	(for example the VirtualBox GUI or headless server), simply use
12794	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12795	will power up the machine automatically for you.
12796	</note>
12797	</desc>
12798
12799	<attribute name="state" type="SessionState" readonly="yes">
12800	<desc>Current state of this session.</desc>
12801	</attribute>
12802
12803	<attribute name="type" type="SessionType" readonly="yes">
12804	<desc>
12805	Type of this session. The value of this attribute is valid only
12806	if the session is currently open (i.e. its #state is
12807	SessionType_SessionOpen), otherwise an error will be returned.
12808	</desc>
12809	</attribute>
12810
12811	<attribute name="machine" type="IMachine" readonly="yes">
12812	<desc>Machine object associated with this session.</desc>
12813	</attribute>
12814
12815	<attribute name="console" type="IConsole" readonly="yes">
12816	<desc>Console object associated with this session.</desc>
12817	</attribute>
12818
12819	<method name="close">
12820	<desc>
12821	Closes a session that was previously opened.
12822
12823	It is recommended that every time an "open session" method (such as
12824	<link to="IVirtualBox::openRemoteSession" /> or
12825	<link to="IVirtualBox::openSession" />) has been called to
12826	manipulate a virtual machine, the caller invoke
12827	ISession::close() when it's done doing so. Since sessions are
12828	serialization primitives much like ordinary mutexes, they are
12829	best used the same way: for each "open" call, there should be
12830	a matching "close" call, even when errors occur.
12831
12832	Otherwise, if a direct session for a machine opened with
12833	<link to="IVirtualBox::openSession"/> is not explicitly closed
12834	when the application terminates, the state of the machine will
12835	be set to <link to="MachineState_Aborted" /> on the server.
12836
12837	Generally, it is recommended to close all open sessions explicitly
12838	before terminating the application (regardless of the reason for
12839	the termination).
12840
12841	<note>
12842	Do not expect the session state (<link to="ISession::state" />
12843	to return to "Closed" immediately after you invoke
12844	ISession::close(), particularly if you have started a remote
12845	session to execute the VM in a new process. The session state will
12846	automatically return to "Closed" once the VM is no longer executing,
12847	which can of course take a very long time.
12848	</note>
12849
12850	<result name="E_UNEXPECTED">
12851	Session is not open.
12852	</result>
12853
12854	</desc>
12855	</method>
12856
12857	</interface>
12858
12859	<!--
12860	// IStorageController
12861	/////////////////////////////////////////////////////////////////////////
12862	-->
12863
12864	<enum
12865	name="StorageBus"
12866	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12867	>
12868	<desc>
12869	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
12870	see <link to="IStorageController::bus" />.
12871	</desc>
12872	<const name="Null" value="0">
12873	<desc>@c null value. Never used by the API.</desc>
12874	</const>
12875	<const name="IDE" value="1"/>
12876	<const name="SATA" value="2"/>
12877	<const name="SCSI" value="3"/>
12878	<const name="Floppy" value="4"/>
12879	</enum>
12880
12881	<enum
12882	name="StorageControllerType"
12883	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12884	>
12885	<desc>
12886	The exact variant of storage controller hardware presented
12887	to the guest; see <link to="IStorageController::controllerType" />.
12888	</desc>
12889
12890	<const name="Null" value="0">
12891	<desc>@c null value. Never used by the API.</desc>
12892	</const>
12893	<const name="LsiLogic" value="1">
12894	<desc>A SCSI controller of the LsiLogic variant.</desc>
12895	</const>
12896	<const name="BusLogic" value="2">
12897	<desc>A SCSI controller of the BusLogic variant.</desc>
12898	</const>
12899	<const name="IntelAhci" value="3">
12900	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12901	</const>
12902	<const name="PIIX3" value="4">
12903	<desc>An IDE controller of the PIIX3 variant.</desc>
12904	</const>
12905	<const name="PIIX4" value="5">
12906	<desc>An IDE controller of the PIIX4 variant.</desc>
12907	</const>
12908	<const name="ICH6" value="6">
12909	<desc>An IDE controller of the ICH6 variant.</desc>
12910	</const>
12911	<const name="I82078" value="7">
12912	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12913	</const>
12914	</enum>
12915
12916	<interface
12917	name="IStorageController" extends="$unknown"
12918	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
12919	wsmap="managed"
12920	>
12921	<desc>
12922	Represents a storage controller that is attached to a virtual machine
12923	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
12924	attached to storage controllers in a real computer, virtual drives
12925	(represented by <link to="IMediumAttachment" />) are attached to virtual
12926	storage controllers, represented by this interface.
12927
12928	As opposed to physical hardware, VirtualBox has a very generic concept
12929	of a storage controller, and for purposes of the Main API, all virtual
12930	storage is attached to virtual machines via instances of this interface.
12931	There are four types of such virtual storage controllers: IDE, SCSI, SATA
12932	and Floppy (see <link to="#bus" />). Depending on which of these four is
12933	used, certain sub-types may be available and can be selected in
12934	<link to="#controllerType" />.
12935
12936	Depending on these settings, the guest operating system might see
12937	significantly different virtual hardware.
12938	</desc>
12939
12940	<attribute name="name" type="wstring" readonly="yes">
12941	<desc>
12942	Name of the storage controller, as originally specified with
12943	<link to="IMachine::addStorageController" />. This then uniquely
12944	identifies this controller with other method calls such as
12945	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
12946	</desc>
12947	</attribute>
12948
12949	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
12950	<desc>
12951	Maximum number of devices which can be attached to one port.
12952	</desc>
12953	</attribute>
12954
12955	<attribute name="minPortCount" type="unsigned long" readonly="yes">
12956	<desc>
12957	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
12958	</desc>
12959	</attribute>
12960
12961	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
12962	<desc>
12963	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
12964	</desc>
12965	</attribute>
12966
12967	<attribute name="instance" type="unsigned long">
12968	<desc>
12969	The instance number of the device in the running VM.
12970	</desc>
12971	</attribute>
12972
12973	<attribute name="portCount" type="unsigned long">
12974	<desc>
12975	The number of currently usable ports on the controller.
12976	The minimum and maximum number of ports for one controller are
12977	stored in <link to="IStorageController::minPortCount"/>
12978	and <link to="IStorageController::maxPortCount"/>.
12979	</desc>
12980	</attribute>
12981
12982	<attribute name="bus" type="StorageBus" readonly="yes">
12983	<desc>
12984	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
12985	</desc>
12986	</attribute>
12987
12988	<attribute name="controllerType" type="StorageControllerType">
12989	<desc>
12990	The exact variant of storage controller hardware presented
12991	to the guest.
12992	Depending on this value, VirtualBox will provide a different
12993	virtual storage controller hardware to the guest.
12994	For SATA and floppy controllers, only one variant is available,
12995	but for IDE and SCSI, there are several.
12996
12997	For SCSI controllers, the default type is LsiLogic.
12998	</desc>
12999	</attribute>
13000
13001	<method name="GetIDEEmulationPort">
13002	<desc>
13003	Gets the corresponding port number which is emulated as an IDE device.
13004	Works only with SATA controllers.
13005
13006	<result name="E_INVALIDARG">
13007	The @a devicePosition is not in the range 0 to 3.
13008	</result>
13009	<result name="E_NOTIMPL">
13010	The storage controller type is not SATAIntelAhci.
13011	</result>
13012
13013	</desc>
13014	<param name="devicePosition" type="long" dir="in"/>
13015	<param name="portNumber" type="long" dir="return"/>
13016	</method>
13017
13018	<method name="SetIDEEmulationPort">
13019	<desc>
13020	Sets the port number which is emulated as an IDE device.
13021	Works only with SATA controllers.
13022
13023	<result name="E_INVALIDARG">
13024	The @a devicePosition is not in the range 0 to 3 or the
13025	@a portNumber is not in the range 0 to 29.
13026	</result>
13027	<result name="E_NOTIMPL">
13028	The storage controller type is not SATAIntelAhci.
13029	</result>
13030
13031	</desc>
13032	<param name="devicePosition" type="long" dir="in"/>
13033	<param name="portNumber" type="long" dir="in"/>
13034	</method>
13035
13036	</interface>
13037
13038	<if target="wsdl">
13039
13040	<!--
13041	// IManagedObjectRef
13042	/////////////////////////////////////////////////////////////////////////
13043	-->
13044
13045	<interface
13046	name="IManagedObjectRef" extends="$unknown"
13047	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13048	internal="yes"
13049	wsmap="managed"
13050	wscpp="hardcoded"
13051	>
13052	<desc>
13053	Managed object reference.
13054
13055	Only within the webservice, a managed object reference (which is really
13056	an opaque number) allows a webservice client to address an object
13057	that lives in the address space of the webservice server.
13058
13059	Behind each managed object reference, there is a COM object that lives
13060	in the webservice server's address space. The COM object is not freed
13061	until the managed object reference is released, either by an explicit
13062	call to <link to="IManagedObjectRef::release" /> or by logging off from
13063	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13064	all objects created during the webservice session.
13065
13066	Whenever a method call of the VirtualBox API returns a COM object, the
13067	webservice representation of that method will instead return a
13068	managed object reference, which can then be used to invoke methods
13069	on that object.
13070	</desc>
13071
13072	<method name="getInterfaceName">
13073	<desc>
13074	Returns the name of the interface that this managed object represents,
13075	for example, "IMachine", as a string.
13076	</desc>
13077	<param name="return" type="wstring" dir="return"/>
13078	</method>
13079
13080	<method name="release">
13081	<desc>
13082	Releases this managed object reference and frees the resources that
13083	were allocated for it in the webservice server process. After calling
13084	this method, the identifier of the reference can no longer be used.
13085	</desc>
13086	</method>
13087
13088	</interface>
13089
13090	<!--
13091	// IWebsessionManager
13092	/////////////////////////////////////////////////////////////////////////
13093	-->
13094
13095	<interface
13096	name="IWebsessionManager" extends="$unknown"
13097	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13098	internal="yes"
13099	wsmap="global"
13100	wscpp="hardcoded"
13101	>
13102	<desc>
13103	Websession manager. This provides essential services
13104	to webservice clients.
13105	</desc>
13106	<method name="logon">
13107	<desc>
13108	Logs a new client onto the webservice and returns a managed object reference to
13109	the IVirtualBox instance, which the client can then use as a basis to further
13110	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13111	interface, in one way or the other.
13112	</desc>
13113	<param name="username" type="wstring" dir="in"/>
13114	<param name="password" type="wstring" dir="in"/>
13115	<param name="return" type="IVirtualBox" dir="return"/>
13116	</method>
13117
13118	<method name="getSessionObject">
13119	<desc>
13120	Returns a managed object reference to the internal ISession object that was created
13121	for this web service session when the client logged on.
13122
13123	<see>ISession</see>
13124	</desc>
13125	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13126	<param name="return" type="ISession" dir="return"/>
13127	</method>
13128
13129	<method name="logoff">
13130	<desc>
13131	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13132	and destroys all resources associated with the session (most importantly, all
13133	managed objects created in the server while the session was active).
13134	</desc>
13135	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13136	</method>
13137
13138	</interface>
13139
13140	</if>
13141
13142	<!--
13143	// IPerformanceCollector & friends
13144	/////////////////////////////////////////////////////////////////////////
13145	-->
13146
13147	<interface
13148	name="IPerformanceMetric" extends="$unknown"
13149	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13150	>
13151	<desc>
13152	The IPerformanceMetric interface represents parameters of the given
13153	performance metric.
13154	</desc>
13155
13156	<attribute name="metricName" type="wstring" readonly="yes">
13157	<desc>
13158	Name of the metric.
13159	</desc>
13160	</attribute>
13161
13162	<attribute name="object" type="$unknown" readonly="yes">
13163	<desc>
13164	Object this metric belongs to.
13165	</desc>
13166	</attribute>
13167
13168	<attribute name="description" type="wstring" readonly="yes">
13169	<desc>
13170	Textual description of the metric.
13171	</desc>
13172	</attribute>
13173
13174	<attribute name="period" type="unsigned long" readonly="yes">
13175	<desc>
13176	Time interval between samples, measured in seconds.
13177	</desc>
13178	</attribute>
13179
13180	<attribute name="count" type="unsigned long" readonly="yes">
13181	<desc>
13182	Number of recent samples retained by the performance collector for this
13183	metric.
13184
13185	When the collected sample count exceeds this number, older samples
13186	are discarded.
13187	</desc>
13188	</attribute>
13189
13190	<attribute name="unit" type="wstring" readonly="yes">
13191	<desc>
13192	Unit of measurement.
13193	</desc>
13194	</attribute>
13195
13196	<attribute name="minimumValue" type="long" readonly="yes">
13197	<desc>
13198	Minimum possible value of this metric.
13199	</desc>
13200	</attribute>
13201
13202	<attribute name="maximumValue" type="long" readonly="yes">
13203	<desc>
13204	Maximum possible value of this metric.
13205	</desc>
13206	</attribute>
13207	</interface>
13208
13209	<interface
13210	name="IPerformanceCollector" extends="$unknown"
13211	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13212	wsmap="managed"
13213	>
13214	<desc>
13215	The IPerformanceCollector interface represents a service that collects and
13216	stores performance metrics data.
13217
13218	Performance metrics are associated with objects of interfaces like IHost and
13219	IMachine. Each object has a distinct set of performance metrics.
13220	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13221
13222	Metric data is collected at the specified intervals and is retained
13223	internally. The interval and the number of retained samples can be set
13224	with <link to="IPerformanceCollector::setupMetrics" />.
13225
13226	Metrics are organized hierarchically, with each level separated by a
13227	slash (/) character. Generally, the scheme for metric names is like this:
13228
13229	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13230
13231	"Category/Metric" together form the base metric name. A base metric is the
13232	smallest unit for which a sampling interval and the number of retained
13233	samples can be set. Only base metrics can be enabled and disabled. All
13234	sub-metrics are collected when their base metric is collected.
13235	Collected values for any set of sub-metrics can be queried with
13236	<link to="IPerformanceCollector::queryMetricsData" />.
13237
13238	For example "CPU/Load/User:avg"
13239	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13240	"average" aggregate. An aggregate function is computed over all retained
13241	data. Valid aggregate functions are:
13242
13243	<ul>
13244	<li>avg -- average</li>
13245	<li>min -- minimum</li>
13246	<li>max -- maximum</li>
13247	</ul>
13248
13249	When setting up
13250	metric parameters, querying metric data, enabling or disabling metrics
13251	wildcards can be used in metric names to specify a subset of metrics. For
13252	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13253	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13254	values without aggregates <tt>*:</tt> can be used.
13255
13256	The valid names for base metrics are:
13257
13258	<ul>
13259	<li>CPU/Load</li>
13260	<li>CPU/MHz</li>
13261	<li>RAM/Usage</li>
13262	</ul>
13263
13264	The general sequence for collecting and retrieving the metrics is:
13265	<ul>
13266	<li>
13267	Obtain an instance of IPerformanceCollector with
13268	<link to="IVirtualBox::performanceCollector" />
13269	</li>
13270	<li>
13271	Allocate and populate an array with references to objects the metrics
13272	will be collected for. Use references to IHost and IMachine objects.
13273	</li>
13274	<li>
13275	Allocate and populate an array with base metric names the data will be
13276	collected for.
13277	</li>
13278	<li>
13279	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13280	metric data will be collected and stored.
13281	</li>
13282	<li>
13283	Wait for the data to get collected.
13284	</li>
13285	<li>
13286	Allocate and populate an array with references to objects the metric
13287	values will be queried for. You can re-use the object array used for
13288	setting base metrics.
13289	</li>
13290	<li>
13291	Allocate and populate an array with metric names the data will be
13292	collected for. Note that metric names differ from base metric names.
13293	</li>
13294	<li>
13295	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13296	have been collected so far are returned. Note that the values are still
13297	retained internally and data collection continues.
13298	</li>
13299	</ul>
13300
13301	For an example of usage refer to the following files in VirtualBox SDK:
13302	<ul>
13303	<li>
13304	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13305	</li>
13306	<li>
13307	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13308	</li>
13309	</ul>
13310	</desc>
13311
13312	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13313	<desc>
13314	Array of unique names of metrics.
13315
13316	This array represents all metrics supported by the performance
13317	collector. Individual objects do not necessarily support all of them.
13318	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13319	list of supported metrics for a particular object.
13320	</desc>
13321	</attribute>
13322
13323	<method name="getMetrics">
13324	<desc>
13325	Returns parameters of specified metrics for a set of objects.
13326	<note>
13327	@c Null metrics array means all metrics. @c Null object array means
13328	all existing objects.
13329	</note>
13330	</desc>
13331	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13332	<desc>
13333	Metric name filter. Currently, only a comma-separated list of metrics
13334	is supported.
13335	</desc>
13336	</param>
13337	<param name="objects" type="$unknown" dir="in" safearray="yes">
13338	<desc>
13339	Set of objects to return metric parameters for.
13340	</desc>
13341	</param>
13342	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13343	<desc>
13344	Array of returned metric parameters.
13345	</desc>
13346	</param>
13347	</method>
13348
13349	<method name="setupMetrics">
13350	<desc>
13351	Sets parameters of specified base metrics for a set of objects. Returns
13352	an array of <link to="IPerformanceMetric" /> describing the metrics have
13353	been affected.
13354	<note>
13355	@c Null or empty metric name array means all metrics. @c Null or empty
13356	object array means all existing objects. If metric name array contains
13357	a single element and object array contains many, the single metric
13358	name array element is applied to each object array element to form
13359	metric/object pairs.
13360	</note>
13361	</desc>
13362	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13363	<desc>
13364	Metric name filter. Comma-separated list of metrics with wildcard
13365	support.
13366	</desc>
13367	</param>
13368	<param name="objects" type="$unknown" dir="in" safearray="yes">
13369	<desc>
13370	Set of objects to setup metric parameters for.
13371	</desc>
13372	</param>
13373	<param name="period" type="unsigned long" dir="in">
13374	<desc>
13375	Time interval in seconds between two consecutive samples of performance
13376	data.
13377	</desc>
13378	</param>
13379	<param name="count" type="unsigned long" dir="in">
13380	<desc>
13381	Number of samples to retain in performance data history. Older samples
13382	get discarded.
13383	</desc>
13384	</param>
13385	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13386	<desc>
13387	Array of metrics that have been modified by the call to this method.
13388	</desc>
13389	</param>
13390	</method>
13391
13392	<method name="enableMetrics">
13393	<desc>
13394	Turns on collecting specified base metrics. Returns an array of
13395	<link to="IPerformanceMetric" /> describing the metrics have been
13396	affected.
13397	<note>
13398	@c Null or empty metric name array means all metrics. @c Null or empty
13399	object array means all existing objects. If metric name array contains
13400	a single element and object array contains many, the single metric
13401	name array element is applied to each object array element to form
13402	metric/object pairs.
13403	</note>
13404	</desc>
13405	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13406	<desc>
13407	Metric name filter. Comma-separated list of metrics with wildcard
13408	support.
13409	</desc>
13410	</param>
13411	<param name="objects" type="$unknown" dir="in" safearray="yes">
13412	<desc>
13413	Set of objects to enable metrics for.
13414	</desc>
13415	</param>
13416	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13417	<desc>
13418	Array of metrics that have been modified by the call to this method.
13419	</desc>
13420	</param>
13421	</method>
13422
13423	<method name="disableMetrics">
13424	<desc>
13425	Turns off collecting specified base metrics. Returns an array of
13426	<link to="IPerformanceMetric" /> describing the metrics have been
13427	affected.
13428	<note>
13429	@c Null or empty metric name array means all metrics. @c Null or empty
13430	object array means all existing objects. If metric name array contains
13431	a single element and object array contains many, the single metric
13432	name array element is applied to each object array element to form
13433	metric/object pairs.
13434	</note>
13435	</desc>
13436	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13437	<desc>
13438	Metric name filter. Comma-separated list of metrics with wildcard
13439	support.
13440	</desc>
13441	</param>
13442	<param name="objects" type="$unknown" dir="in" safearray="yes">
13443	<desc>
13444	Set of objects to disable metrics for.
13445	</desc>
13446	</param>
13447	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13448	<desc>
13449	Array of metrics that have been modified by the call to this method.
13450	</desc>
13451	</param>
13452	</method>
13453
13454	<method name="queryMetricsData">
13455	<desc>
13456	Queries collected metrics data for a set of objects.
13457
13458	The data itself and related metric information are returned in seven
13459	parallel and one flattened array of arrays. Elements of
13460	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13461	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13462	the same index describe one set of values corresponding to a single
13463	metric.
13464
13465	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13466	start and length of a sub-array is indicated by
13467	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13468	value for metric <tt>metricNames[i]</tt> is at
13469	<tt>returnData[returnIndices[i]]</tt>.
13470
13471	<note>
13472	@c Null or empty metric name array means all metrics. @c Null or empty
13473	object array means all existing objects. If metric name array contains
13474	a single element and object array contains many, the single metric
13475	name array element is applied to each object array element to form
13476	metric/object pairs.
13477	</note>
13478	<note>
13479	Data collection continues behind the scenes after call to
13480	@c queryMetricsData. The return data can be seen as the snapshot of
13481	the current state at the time of @c queryMetricsData call. The
13482	internally kept metric values are not cleared by the call. This makes
13483	possible querying different subsets of metrics or aggregates with
13484	subsequent calls. If periodic querying is needed it is highly
13485	suggested to query the values with @c interval*count period to avoid
13486	confusion. This way a completely new set of data values will be
13487	provided by each query.
13488	</note>
13489	</desc>
13490	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13491	<desc>
13492	Metric name filter. Comma-separated list of metrics with wildcard
13493	support.
13494	</desc>
13495	</param>
13496	<param name="objects" type="$unknown" dir="in" safearray="yes">
13497	<desc>
13498	Set of objects to query metrics for.
13499	</desc>
13500	</param>
13501	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13502	<desc>
13503	Names of metrics returned in @c returnData.
13504	</desc>
13505	</param>
13506	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13507	<desc>
13508	Objects associated with metrics returned in @c returnData.
13509	</desc>
13510	</param>
13511	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13512	<desc>
13513	Units of measurement for each returned metric.
13514	</desc>
13515	</param>
13516	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13517	<desc>
13518	Divisor that should be applied to return values in order to get
13519	floating point values. For example:
13520	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13521	will retrieve the floating point value of i-th sample of the first
13522	metric.
13523	</desc>
13524	</param>
13525	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13526	<desc>
13527	Sequence numbers of the first elements of value sequences of particular metrics
13528	returned in @c returnData. For aggregate metrics it is the sequence number of
13529	the sample the aggregate started calculation from.
13530	</desc>
13531	</param>
13532	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13533	<desc>
13534	Indices of the first elements of value sequences of particular metrics
13535	returned in @c returnData.
13536	</desc>
13537	</param>
13538	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13539	<desc>
13540	Lengths of value sequences of particular metrics.
13541	</desc>
13542	</param>
13543	<param name="returnData" type="long" dir="return" safearray="yes">
13544	<desc>
13545	Flattened array of all metric data containing sequences of values for
13546	each metric.
13547	</desc>
13548	</param>
13549	</method>
13550
13551	</interface>
13552
13553	<module name="VBoxSVC" context="LocalServer">
13554	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13555	namespace="virtualbox.org">
13556	<interface name="IVirtualBox" default="yes"/>
13557	</class>
13558	</module>
13559
13560	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13561	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13562	namespace="virtualbox.org">
13563	<interface name="ISession" default="yes"/>
13564	</class>
13565	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13566	namespace="virtualbox.org">
13567	<interface name="ILocalOwner" default="yes"/>
13568	<interface name="IVirtualBoxCallback"/>
13569	<interface name="IConsoleCallback"/>
13570	</class>
13571	</module>
13572
13573	</library>
13574
13575	</idl>
13576
13577	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format