VirtualBox.xidl@ 23319

Last change on this file since 23319 was 23288, checked in by vboxsync, 15 years ago
Main: implement XML reader for settings versions 1.3, 1.4 and 1.5 for vbox 2.0.x support.
Property svn:eol-style set to `native`
File size: 483.8 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="73bf04d0-7c4f-4684-9abf-d65a9ad74343"
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 -----+-->[discardSnapshot() ]-------------> Discarding --+
577	\| \| [discardCurrentState()] \|
578	+-> Saved -------+ [discardCurrentSnapshotAndState()] \|
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="Aborted" value="3">
619	<desc>
620	The process running the machine has terminated abnormally. This may
621	indicate a crash of the VM process in host execution context, or
622	the VM process has been terminated externally.
623	</desc>
624	</const>
625	<const name="Running" value="4">
626	<desc>
627	The machine is currently being executed.
628	<note internal="yes">
629	For whoever decides to touch this enum: In order to keep the
630	comparisons in the old source code valid, this state must immediately
631	precede the Paused state.
632	</note>
633	</desc>
634	</const>
635	<const name="Paused" value="5">
636	<desc>
637	Execution of the machine has been paused.
638	<note internal="yes">
639	For whoever decides to touch this enum: In order to keep the
640	comparisons in the old source code valid, this state must immediately
641	follow the Running state.
642	</note>
643	</desc>
644	</const>
645	<const name="Stuck" value="6">
646	<desc>
647	Execution of the machine has reached the "Guru Meditation"
648	condition. This indicates a severe error in the hypervisor itself.
649	</desc>
650	</const>
651	<const name="Starting" value="7">
652	<desc>
653	Machine is being started after powering it on from a
654	zero execution state.
655	</desc>
656	</const>
657	<const name="Stopping" value="8">
658	<desc>
659	Machine is being normally stopped powering it off, or after the guest OS
660	has initiated a shutdown sequence.
661	</desc>
662	</const>
663	<const name="Saving" value="9">
664	<desc>
665	Machine is saving its execution state to a file, or an online
666	snapshot of the machine is being taken.
667	</desc>
668	</const>
669	<const name="Restoring" value="10">
670	<desc>
671	Execution state of the machine is being restored from a file
672	after powering it on from the saved execution state.
673	</desc>
674	</const>
675	<const name="Discarding" value="11">
676	<desc>
677	Snapshot of the machine is being discarded.
678	</desc>
679	</const>
680	<const name="SettingUp" value="12">
681	<desc>
682	Lengthy setup operation is in progress.
683	</desc>
684	</const>
685
686	<const name="FirstOnline" value="4" wsmap="suppress"> <!-- Running -->
687	<desc>
688	Pseudo-state: first online state (for use in relational expressions).
689	</desc>
690	</const>
691	<const name="LastOnline" value="10" wsmap="suppress"> <!-- Restoring -->
692	<desc>
693	Pseudo-state: last online state (for use in relational expressions).
694	</desc>
695	</const>
696
697	<const name="FirstTransient" value="7" wsmap="suppress"> <!-- Starting -->
698	<desc>
699	Pseudo-state: first transient state (for use in relational expressions).
700	</desc>
701	</const>
702	<const name="LastTransient" value="12" wsmap="suppress"> <!-- SettingUp -->
703	<desc>
704	Pseudo-state: last transient state (for use in relational expressions).
705	</desc>
706	</const>
707
708	</enum>
709
710	<enum
711	name="SessionState"
712	uuid="CF2700C0-EA4B-47ae-9725-7810114B94D8"
713	>
714	<desc>
715	Session state. This enumeration represents possible values of
716	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
717	attributes. See individual enumerator descriptions for the meaning for
718	every value.
719	</desc>
720
721	<const name="Null" value="0">
722	<desc>Null value (never used by the API).</desc>
723	</const>
724	<const name="Closed" value="1">
725	<desc>
726	The machine has no open sessions (<link to="IMachine::sessionState"/>);
727	the session is closed (<link to="ISession::state"/>)
728	</desc>
729	</const>
730	<const name="Open" value="2">
731	<desc>
732	The machine has an open direct session (<link to="IMachine::sessionState"/>);
733	the session is open (<link to="ISession::state"/>)
734	</desc>
735	</const>
736	<const name="Spawning" value="3">
737	<desc>
738	A new (direct) session is being opened for the machine
739	as a result of <link to="IVirtualBox::openRemoteSession"/>
740	call (<link to="IMachine::sessionState"/>);
741	the session is currently being opened
742	as a result of <link to="IVirtualBox::openRemoteSession"/>
743	call (<link to="ISession::state"/>)
744	</desc>
745	</const>
746	<const name="Closing" value="4">
747	<desc>
748	The direct session is being closed (<link to="IMachine::sessionState"/>);
749	the session is being closed (<link to="ISession::state"/>)
750	</desc>
751	</const>
752	</enum>
753
754	<enum
755	name="SessionType"
756	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
757	>
758	<desc>
759	Session type. This enumeration represents possible values of the
760	<link to="ISession::type"/> attribute.
761	</desc>
762
763	<const name="Null" value="0">
764	<desc>Null value (never used by the API).</desc>
765	</const>
766	<const name="Direct" value="1">
767	<desc>
768	Direct session
769	(opened by <link to="IVirtualBox::openSession"/>)
770	</desc>
771	</const>
772	<const name="Remote" value="2">
773	<desc>
774	Remote session
775	(opened by <link to="IVirtualBox::openRemoteSession"/>)
776	</desc>
777	</const>
778	<const name="Existing" value="3">
779	<desc>
780	Existing session
781	(opened by <link to="IVirtualBox::openExistingSession"/>)
782	</desc>
783	</const>
784	</enum>
785
786	<enum
787	name="DeviceType"
788	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
789	>
790	<desc>
791	Device type.
792	</desc>
793	<const name="Null" value="0">
794	<desc>
795	Null value, may also mean "no device" (not allowed for
796	<link to="IConsole::getDeviceActivity"/>).
797	</desc>
798	</const>
799	<const name="Floppy" value="1">
800	<desc>Floppy device.</desc>
801	</const>
802	<const name="DVD" value="2">
803	<desc>CD/DVD-ROM device.</desc>
804	</const>
805	<const name="HardDisk" value="3">
806	<desc>Hard disk device.</desc>
807	</const>
808	<const name="Network" value="4">
809	<desc>Network device.</desc>
810	</const>
811	<const name="USB" value="5">
812	<desc>USB device.</desc>
813	</const>
814	<const name="SharedFolder" value="6">
815	<desc>Shared folder device.</desc>
816	</const>
817	</enum>
818
819	<enum
820	name="DeviceActivity"
821	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
822	>
823	<desc>
824	Device activity for <link to="IConsole::getDeviceActivity"/>.
825	</desc>
826
827	<const name="Null" value="0"/>
828	<const name="Idle" value="1"/>
829	<const name="Reading" value="2"/>
830	<const name="Writing" value="3"/>
831	</enum>
832
833	<enum
834	name="ClipboardMode"
835	uuid="33364716-4008-4701-8f14-be0fa3d62950"
836	>
837	<desc>
838	Host-Guest clipboard interchange mode.
839	</desc>
840
841	<const name="Disabled" value="0"/>
842	<const name="HostToGuest" value="1"/>
843	<const name="GuestToHost" value="2"/>
844	<const name="Bidirectional" value="3"/>
845	</enum>
846
847	<enum
848	name="Scope"
849	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
850	>
851	<desc>
852	Scope of the operation.
853
854	A generic enumeration used in various methods to define the action or
855	argument scope.
856	</desc>
857
858	<const name="Global" value="0"/>
859	<const name="Machine" value="1"/>
860	<const name="Session" value="2"/>
861	</enum>
862
863	<enum
864	name="GuestStatisticType"
865	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
866	>
867	<desc>
868	Statistics type for <link to="IGuest::getStatistic"/>.
869	</desc>
870
871	<const name="CPULoad_Idle" value="0">
872	<desc>
873	Idle CPU load (0-100%) for last interval.
874	</desc>
875	</const>
876	<const name="CPULoad_Kernel" value="1">
877	<desc>
878	Kernel CPU load (0-100%) for last interval.
879	</desc>
880	</const>
881	<const name="CPULoad_User" value="2">
882	<desc>
883	User CPU load (0-100%) for last interval.
884	</desc>
885	</const>
886	<const name="Threads" value="3">
887	<desc>
888	Total number of threads in the system.
889	</desc>
890	</const>
891	<const name="Processes" value="4">
892	<desc>
893	Total number of processes in the system.
894	</desc>
895	</const>
896	<const name="Handles" value="5">
897	<desc>
898	Total number of handles in the system.
899	</desc>
900	</const>
901	<const name="MemoryLoad" value="6">
902	<desc>
903	Memory load (0-100%).
904	</desc>
905	</const>
906	<const name="PhysMemTotal" value="7">
907	<desc>
908	Total physical memory in megabytes.
909	</desc>
910	</const>
911	<const name="PhysMemAvailable" value="8">
912	<desc>
913	Free physical memory in megabytes.
914	</desc>
915	</const>
916	<const name="PhysMemBalloon" value="9">
917	<desc>
918	Ballooned physical memory in megabytes.
919	</desc>
920	</const>
921	<const name="MemCommitTotal" value="10">
922	<desc>
923	Total amount of memory in the committed state in megabytes.
924	</desc>
925	</const>
926	<const name="MemKernelTotal" value="11">
927	<desc>
928	Total amount of memory used by the guest OS's kernel in megabytes.
929	</desc>
930	</const>
931	<const name="MemKernelPaged" value="12">
932	<desc>
933	Total amount of paged memory used by the guest OS's kernel in megabytes.
934	</desc>
935	</const>
936	<const name="MemKernelNonpaged" value="13">
937	<desc>
938	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
939	</desc>
940	</const>
941	<const name="MemSystemCache" value="14">
942	<desc>
943	Total amount of memory used by the guest OS's system cache in megabytes.
944	</desc>
945	</const>
946	<const name="PageFileSize" value="15">
947	<desc>
948	Pagefile size in megabytes.
949	</desc>
950	</const>
951	<const name="SampleNumber" value="16">
952	<desc>
953	Statistics sample number
954	</desc>
955	</const>
956	<const name="MaxVal" value="17"/>
957	</enum>
958
959	<enum
960	name="BIOSBootMenuMode"
961	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
962	>
963	<desc>
964	BIOS boot menu mode.
965	</desc>
966
967	<const name="Disabled" value="0"/>
968	<const name="MenuOnly" value="1"/>
969	<const name="MessageAndMenu" value="2"/>
970	</enum>
971
972	<enum
973	name="ProcessorFeature"
974	uuid="b8353b35-705d-4796-9967-ebfb7ba54af4"
975	>
976	<desc>
977	CPU features.
978	</desc>
979
980	<const name="HWVirtEx" value="0"/>
981	<const name="PAE" value="1"/>
982	<const name="LongMode" value="2"/>
983	</enum>
984
985	<enum
986	name="FirmwareType"
987	uuid="7ceea938-8b49-41e2-bb47-667219c0d586"
988	>
989	<desc>
990	Firmware type.
991	</desc>
992	<const name="BIOS" value="1">
993	<desc>BIOS Firmware.</desc>
994	</const>
995	<const name="EFI" value="2">
996	<desc>Efi firmware.</desc>
997	</const>
998	</enum>
999
1000	<!--
1001	// IVirtualBoxErrorInfo
1002	/////////////////////////////////////////////////////////////////////////
1003	-->
1004
1005	<interface
1006	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1007	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1008	supportsErrorInfo="no"
1009	wsmap="managed"
1010	>
1011	<desc>
1012	The IVirtualBoxErrorInfo interface represents extended error information.
1013
1014	Extended error information can be set by VirtualBox components after
1015	unsuccessful or partially successful method invocation. This information
1016	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1017	and then shown to the client in addition to the plain 32-bit result code.
1018
1019	In MS COM, this interface extends the IErrorInfo interface,
1020	in XPCOM, it extends the nsIException interface. In both cases,
1021	it provides a set of common attributes to retrieve error
1022	information.
1023
1024	Sometimes invocation of some component's method may involve methods of
1025	other components that may also fail (independently of this method's
1026	failure), or a series of non-fatal errors may precede a fatal error that
1027	causes method failure. In cases like that, it may be desirable to preserve
1028	information about all errors happened during method invocation and deliver
1029	it to the caller. The <link to="#next"/> attribute is intended
1030	specifically for this purpose and allows to represent a chain of errors
1031	through a single IVirtualBoxErrorInfo object set after method invocation.
1032
1033	Note that errors are stored to a chain in the reverse order, i.e. the
1034	initial error object you query right after method invocation is the last
1035	error set by the callee, the object it points to in the @a next attribute
1036	is the previous error and so on, up to the first error (which is the last
1037	in the chain).
1038	</desc>
1039
1040	<attribute name="resultCode" type="long" readonly="yes">
1041	<desc>
1042	Result code of the error.
1043	Usually, it will be the same as the result code returned
1044	by the method that provided this error information, but not
1045	always. For example, on Win32, CoCreateInstance() will most
1046	likely return E_NOINTERFACE upon unsuccessful component
1047	instantiation attempt, but not the value the component factory
1048	returned. Value is typed 'long', not 'result',
1049	to make interface usable from scripting languages.
1050	<note>
1051	In MS COM, there is no equivalent.
1052	In XPCOM, it is the same as nsIException::result.
1053	</note>
1054	</desc>
1055	</attribute>
1056
1057	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1058	<desc>
1059	UUID of the interface that defined the error.
1060	<note>
1061	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1062	data type.
1063	In XPCOM, there is no equivalent.
1064	</note>
1065	</desc>
1066	</attribute>
1067
1068	<attribute name="component" type="wstring" readonly="yes">
1069	<desc>
1070	Name of the component that generated the error.
1071	<note>
1072	In MS COM, it is the same as IErrorInfo::GetSource.
1073	In XPCOM, there is no equivalent.
1074	</note>
1075	</desc>
1076	</attribute>
1077
1078	<attribute name="text" type="wstring" readonly="yes">
1079	<desc>
1080	Text description of the error.
1081	<note>
1082	In MS COM, it is the same as IErrorInfo::GetDescription.
1083	In XPCOM, it is the same as nsIException::message.
1084	</note>
1085	</desc>
1086	</attribute>
1087
1088	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1089	<desc>
1090	Next error object if there is any, or @c null otherwise.
1091	<note>
1092	In MS COM, there is no equivalent.
1093	In XPCOM, it is the same as nsIException::inner.
1094	</note>
1095	</desc>
1096	</attribute>
1097
1098	</interface>
1099
1100	<interface
1101	name="ILocalOwner" extends="$dispatched"
1102	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1103	>
1104	<desc>
1105	The ILocalOwner interface allows to register local objects
1106	(created without COM calls, but with new()).
1107	Once registered, calls to methods of such objects can be made
1108	from remote COM processes.
1109	The main usecase is the event callback implementation where
1110	API clients provide callback objects.
1111	</desc>
1112	<method name="setLocalObject">
1113	<desc>
1114	Set local object.
1115	</desc>
1116	<param name="object" type="$unknown" dir="in">
1117	<desc>Local object to forward requests to.
1118	If null, clears currently set local object.</desc>
1119	</param>
1120	</method>
1121	</interface>
1122
1123	<!--
1124	// IVirtualBox
1125	/////////////////////////////////////////////////////////////////////////
1126	-->
1127
1128	<interface
1129	name="IVirtualBoxCallback" extends="$unknown"
1130	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1131	wsmap="suppress"
1132	>
1133
1134	<method name="onMachineStateChange">
1135	<desc>
1136	The execution state of the given machine has changed.
1137	<see>IMachine::state</see>
1138	</desc>
1139	<param name="machineId" type="uuid" mod="string" dir="in">
1140	<desc>ID of the machine this event relates to.</desc>
1141	</param>
1142	<param name="state" type="MachineState" dir="in">
1143	<desc>New execution state.</desc>
1144	</param>
1145	</method>
1146
1147	<method name="onMachineDataChange">
1148	<desc>
1149	Any of the settings of the given machine has changed.
1150	</desc>
1151	<param name="machineId" type="uuid" mod="string" dir="in">
1152	<desc>ID of the machine this event relates to.</desc>
1153	</param>
1154	</method>
1155
1156	<method name="onExtraDataCanChange">
1157	<desc>
1158	Notification when someone tries to change extra data for
1159	either the given machine or (if @c null) global extra data.
1160	This gives the chance to veto against changes.
1161	</desc>
1162	<param name="machineId" type="uuid" mod="string" dir="in">
1163	<desc>
1164	ID of the machine this event relates to
1165	(@c null ID for global extra data change requests).
1166	</desc>
1167	</param>
1168	<param name="key" type="wstring" dir="in">
1169	<desc>
1170	Extra data key for the attempted write.
1171	</desc>
1172	</param>
1173	<param name="value" type="wstring" dir="in">
1174	<desc>
1175	Extra data value for the given key.
1176	</desc>
1177	</param>
1178	<param name="error" type="wstring" dir="out">
1179	<desc>
1180	Optional error message describing the reason of the
1181	veto (ignored if this notification returns @c true).
1182	</desc>
1183	</param>
1184	<param name="allowChange" type="boolean" dir="return">
1185	<desc>
1186	Flag to indicate whether the callee agrees (@c true)
1187	or vetoes against the change (@c false).
1188	</desc>
1189	</param>
1190	</method>
1191
1192	<method name="onExtraDataChange">
1193	<desc>
1194	Notification when machine specific or global extra data
1195	has changed.
1196	</desc>
1197	<param name="machineId" type="uuid" mod="string" dir="in">
1198	<desc>
1199	ID of the machine this event relates to.
1200	Null for global extra data changes.
1201	</desc>
1202	</param>
1203	<param name="key" type="wstring" dir="in">
1204	<desc>
1205	Extra data key that has changed.
1206	</desc>
1207	</param>
1208	<param name="value" type="wstring" dir="in">
1209	<desc>
1210	Extra data value for the given key.
1211	</desc>
1212	</param>
1213	</method>
1214
1215	<method name="onMediumRegistered">
1216	<desc>
1217	The given medium was registered or unregistered
1218	within this VirtualBox installation.
1219
1220	The @a mediumType parameter describes what type of
1221	medium the specified @a mediumId refers to. Possible
1222	values are:
1223
1224	<ul>
1225	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1226	that, if registered, can be obtained using the
1227	<link to="IVirtualBox::getHardDisk"/> call.</li>
1228	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1229	that, if registered, can be obtained using the
1230	<link to="IVirtualBox::getDVDImage"/> call.</li>
1231	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1232	that, if registered, can be obtained using the
1233	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1234	</ul>
1235
1236	Note that if this is a deregistration notification,
1237	there is no way to access the object representing the
1238	unregistered medium. It is supposed that the
1239	application will do required cleanup based on the
1240	@a mediumId value.
1241	</desc>
1242	<param name="mediumId" type="uuid" mod="string" dir="in">
1243	<desc>ID of the medium this event relates to.</desc>
1244	</param>
1245	<param name="mediumType" type="DeviceType" dir="in">
1246	<desc>Type of the medium this event relates to.</desc>
1247	</param>
1248	<param name="registered" type="boolean" dir="in">
1249	<desc>
1250	If @c true, the medium was registered, otherwise it was
1251	unregistered.
1252	</desc>
1253	</param>
1254	</method>
1255
1256	<method name="onMachineRegistered">
1257	<desc>
1258	The given machine was registered or unregistered
1259	within this VirtualBox installation.
1260	</desc>
1261	<param name="machineId" type="uuid" mod="string" dir="in">
1262	<desc>ID of the machine this event relates to.</desc>
1263	</param>
1264	<param name="registered" type="boolean" dir="in">
1265	<desc>
1266	If @c true, the machine was registered, otherwise it was
1267	unregistered.
1268	</desc>
1269	</param>
1270	</method>
1271
1272	<method name="onSessionStateChange">
1273	<desc>
1274	The state of the session for the given machine was changed.
1275	<see>IMachine::sessionState</see>
1276	</desc>
1277	<param name="machineId" type="uuid" mod="string" dir="in">
1278	<desc>ID of the machine this event relates to.</desc>
1279	</param>
1280	<param name="state" type="SessionState" dir="in">
1281	<desc>New session state.</desc>
1282	</param>
1283	</method>
1284
1285	<method name="onSnapshotTaken">
1286	<desc>
1287	A new snapshot of the machine has been taken.
1288	<see>ISnapshot</see>
1289	</desc>
1290	<param name="machineId" type="uuid" mod="string" dir="in">
1291	<desc>ID of the machine this event relates to.</desc>
1292	</param>
1293	<param name="snapshotId" type="uuid" mod="string" dir="in">
1294	<desc>ID of the new snapshot.</desc>
1295	</param>
1296	</method>
1297
1298	<method name="onSnapshotDiscarded">
1299	<desc>
1300	Snapshot of the given machine has been discarded.
1301
1302	<note>
1303	This notification is delivered <b>after</b> the snapshot
1304	object has been uninitialized on the server (so that any
1305	attempt to call its methods will return an error).
1306	</note>
1307
1308	<see>ISnapshot</see>
1309	</desc>
1310	<param name="machineId" type="uuid" mod="string" dir="in">
1311	<desc>ID of the machine this event relates to.</desc>
1312	</param>
1313	<param name="snapshotId" type="uuid" mod="string" dir="in">
1314	<desc>
1315	ID of the discarded snapshot. @c null means the current machine
1316	state has been discarded (restored from the current snapshot).
1317	</desc>
1318	</param>
1319	</method>
1320
1321	<method name="onSnapshotChange">
1322	<desc>
1323	Snapshot properties (name and/or description) have been changed.
1324	<see>ISnapshot</see>
1325	</desc>
1326	<param name="machineId" type="uuid" mod="string" dir="in">
1327	<desc>ID of the machine this event relates to.</desc>
1328	</param>
1329	<param name="snapshotId" type="uuid" mod="string" dir="in">
1330	<desc>ID of the changed snapshot.</desc>
1331	</param>
1332	</method>
1333
1334	<method name="onGuestPropertyChange">
1335	<desc>
1336	Notification when a guest property has changed.
1337	</desc>
1338	<param name="machineId" type="uuid" mod="string" dir="in">
1339	<desc>
1340	ID of the machine this event relates to.
1341	</desc>
1342	</param>
1343	<param name="name" type="wstring" dir="in">
1344	<desc>
1345	The name of the property that has changed.
1346	</desc>
1347	</param>
1348	<param name="value" type="wstring" dir="in">
1349	<desc>
1350	The new property value.
1351	</desc>
1352	</param>
1353	<param name="flags" type="wstring" dir="in">
1354	<desc>
1355	The new property flags.
1356	</desc>
1357	</param>
1358	</method>
1359
1360	</interface>
1361
1362	<interface
1363	name="IDHCPServer" extends="$unknown"
1364	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1365	wsmap="managed"
1366	>
1367	<desc>
1368	The IDHCPServer interface represents the vbox dhcp server configuration.
1369
1370	To enumerate all the dhcp servers on the host, use the
1371	<link to="IVirtualBox::DHCPServers"/> attribute.
1372	</desc>
1373
1374	<attribute name="enabled" type="boolean">
1375	<desc>
1376	specifies if the dhcp server is enabled
1377	</desc>
1378	</attribute>
1379
1380	<attribute name="IPAddress" type="wstring" readonly="yes">
1381	<desc>
1382	specifies server IP
1383	</desc>
1384	</attribute>
1385
1386	<attribute name="networkMask" type="wstring" readonly="yes">
1387	<desc>
1388	specifies server network mask
1389	</desc>
1390	</attribute>
1391
1392	<attribute name="networkName" type="wstring" readonly="yes">
1393	<desc>
1394	specifies internal network name the server is used for
1395	</desc>
1396	</attribute>
1397
1398	<attribute name="lowerIP" type="wstring" readonly="yes">
1399	<desc>
1400	specifies from IP adrres in server address range
1401	</desc>
1402	</attribute>
1403
1404	<attribute name="upperIP" type="wstring" readonly="yes">
1405	<desc>
1406	specifies to IP adrres in server address range
1407	</desc>
1408	</attribute>
1409
1410	<method name="setConfiguration">
1411	<desc>
1412	configures the server
1413	<result name="E_INVALIDARG">
1414	invalid configuration supplied
1415	</result>
1416	</desc>
1417	<param name="IPAddress" type="wstring" dir="in">
1418	<desc>
1419	server IP address
1420	</desc>
1421	</param>
1422	<param name="networkMask" type="wstring" dir="in">
1423	<desc>
1424	server network mask
1425	</desc>
1426	</param>
1427	<param name="FromIPAddress" type="wstring" dir="in">
1428	<desc>
1429	server From IP address for address range
1430	</desc>
1431	</param>
1432	<param name="ToIPAddress" type="wstring" dir="in">
1433	<desc>
1434	server To IP address for address range
1435	</desc>
1436	</param>
1437	</method>
1438
1439	<method name="start">
1440	<desc>
1441	Starts DHCP server process.
1442	<result name="E_FAIL">
1443	Failed to start the process.
1444	</result>
1445	</desc>
1446	<param name="networkName" type="wstring" dir="in">
1447	<desc>
1448	Name of internal network DHCP server should attach to.
1449	</desc>
1450	</param>
1451	<param name="trunkName" type="wstring" dir="in">
1452	<desc>
1453	Name of internal network trunk.
1454	</desc>
1455	</param>
1456	<param name="trunkType" type="wstring" dir="in">
1457	<desc>
1458	Type of internal network trunk.
1459	</desc>
1460	</param>
1461	</method>
1462
1463	<method name="stop">
1464	<desc>
1465	Stops DHCP server process.
1466	<result name="E_FAIL">
1467	Failed to stop the process.
1468	</result>
1469	</desc>
1470	</method>
1471	</interface>
1472
1473	<interface
1474	name="IVirtualBox" extends="$dispatched"
1475	uuid="c1b8d85d-8f44-4314-94fc-072332bdf852"
1476	wsmap="managed"
1477	>
1478	<desc>
1479	The IVirtualBox interface represents the main interface exposed by the
1480	product that provides virtual machine management.
1481
1482	An instance of IVirtualBox is required for the product to do anything
1483	useful. Even though the interface does not expose this, internally,
1484	IVirtualBox is implemented as a singleton and actually lives in the
1485	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1486	IVirtualBox can track the state of all virtual machines on a particular
1487	host, regardless of which frontend started them.
1488
1489	To enumerate all the virtual machines on the host, use the
1490	<link to="IVirtualBox::machines"/> attribute.
1491	</desc>
1492
1493	<attribute name="version" type="wstring" readonly="yes">
1494	<desc>
1495	A string representing the version number of the product. The
1496	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1497	last number represents the build number and will frequently change.
1498	</desc>
1499	</attribute>
1500
1501	<attribute name="revision" type="unsigned long" readonly="yes">
1502	<desc>
1503	The internal build revision number of the product.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="packageType" type="wstring" readonly="yes">
1508	<desc>
1509	A string representing the package type of this product. The
1510	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1511	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1512	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1513	this.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="homeFolder" type="wstring" readonly="yes">
1518	<desc>
1519	Full path to the directory where the global settings file,
1520	<tt>VirtualBox.xml</tt>, is stored.
1521
1522	In this version of VirtualBox, the value of this property is
1523	always <tt><user_dir>/.VirtualBox</tt> (where
1524	<tt><user_dir></tt> is the path to the user directory,
1525	as determined by the host OS), and cannot be changed.
1526
1527	This path is also used as the base to resolve relative paths in
1528	places where relative paths are allowed (unless otherwise
1529	expressly indicated).
1530	</desc>
1531	</attribute>
1532
1533	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1534	<desc>
1535	Full name of the global settings file.
1536	The value of this property corresponds to the value of
1537	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1538	</desc>
1539	</attribute>
1540
1541	<attribute name="host" type="IHost" readonly="yes">
1542	<desc>Associated host object.</desc>
1543	</attribute>
1544
1545	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1546	<desc>Associated system information object.</desc>
1547	</attribute>
1548
1549	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1550	<desc>
1551	Array of machine objects registered within this VirtualBox instance.
1552	</desc>
1553	</attribute>
1554
1555	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1556	<desc>
1557	Array of medium objects known to this VirtualBox installation.
1558
1559	This array contains only base media. All differencing
1560	media of the given base medium can be enumerated using
1561	<link to="IMedium::children"/>.
1562	</desc>
1563	</attribute>
1564
1565	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1566	<desc>
1567	Array of CD/DVD image objects registered with this VirtualBox instance.
1568	</desc>
1569	</attribute>
1570
1571	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1572	<desc>
1573	Array of floppy image objects registered with this VirtualBox instance.
1574	</desc>
1575	</attribute>
1576
1577	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1578
1579	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1580
1581	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1582	<desc>
1583	Collection of global shared folders. Global shared folders are
1584	available to all virtual machines.
1585
1586	New shared folders are added to the collection using
1587	<link to="#createSharedFolder"/>. Existing shared folders can be
1588	removed using <link to="#removeSharedFolder"/>.
1589
1590	<note>
1591	In the current version of the product, global shared folders are not
1592	implemented and therefore this collection is always empty.
1593	</note>
1594	</desc>
1595	</attribute>
1596
1597	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1598	<desc>
1599	Associated performance collector object.
1600	</desc>
1601	</attribute>
1602
1603	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1604	<desc>
1605	dhcp server settings.
1606	</desc>
1607	</attribute>
1608
1609	<method name="createMachine">
1610	<desc>
1611	Creates a new virtual machine.
1612
1613	The new machine is created unregistered, with the initial configuration
1614	set according to the specified guest OS type. A typical sequence of
1615	actions to create a new virtual machine is as follows:
1616
1617	<ol>
1618	<li>
1619	Call this method to have a new machine created. The returned machine
1620	object will be "mutable" allowing to change any machine property.
1621	</li>
1622
1623	<li>
1624	Configure the machine using the appropriate attributes and methods.
1625	</li>
1626
1627	<li>
1628	Call <link to="IMachine::saveSettings" /> to write the settings
1629	to the machine's XML settings file. The configuration of the newly
1630	created machine will not be saved to disk until this method is
1631	called.
1632	</li>
1633
1634	<li>
1635	Call <link to="#registerMachine" /> to add the machine to the list
1636	of machines known to VirtualBox.
1637	</li>
1638	</ol>
1639
1640	You should specify valid name for the newly created machine when calling
1641	this method. See the <link to="IMachine::name"/> attribute description
1642	for more details about the machine name.
1643
1644	The specified guest OS type identifier must match an ID of one of known
1645	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1646	array.
1647
1648	Every machine has a <i>settings file</i> that is used to store
1649	the machine configuration. This file is stored in a directory called the
1650	<i>machine settings subfolder</i>. Both the settings subfolder and file
1651	will have a name that corresponds to the name of the virtual machine.
1652	You can specify where to create the machine setting subfolder using the
1653	@a baseFolder argument. The base folder can be absolute (full path) or
1654	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1655	directory</link>.
1656
1657	If @a baseFolder is a @c null or empty string (which is recommended), the
1658	<link to="ISystemProperties::defaultMachineFolder">default machine
1659	settings folder</link> will be used as a base folder for the created
1660	machine. Otherwise the given base folder will be used. In either case,
1661	the full path to the resulting settings file has the following
1662	structure:
1663	<pre>
1664	<base_folder>/<machine_name>/<machine_name>.xml
1665	</pre>
1666
1667	Note that if the resulting settings file already exists, this method
1668	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="name" type="wstring" dir="in">
1694	<desc>Machine name.</desc>
1695	</param>
1696	<param name="osTypeId" type="wstring" dir="in">
1697	<desc>Guest OS Type ID.</desc>
1698	</param>
1699	<param name="baseFolder" type="wstring" dir="in">
1700	<desc>Base machine folder (optional).</desc>
1701	</param>
1702	<param name="id" type="uuid" mod="string" dir="in">
1703	<desc>Machine UUID (optional).</desc>
1704	</param>
1705	<param name="machine" type="IMachine" dir="return">
1706	<desc>Created machine object.</desc>
1707	</param>
1708	</method>
1709
1710	<method name="createLegacyMachine">
1711	<desc>
1712	Creates a new virtual machine in "legacy" mode, using the specified
1713	settings file to store machine settings.
1714
1715	As opposed to machines created by <link to="#createMachine"/>,
1716	the settings file of the machine created in "legacy" mode is not
1717	automatically renamed when the machine name is changed -- it will always
1718	remain the same as specified in this method call.
1719
1720	The specified settings file name can be absolute (full path) or relative
1721	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1722	directory</link>. If the file name doesn't contain an extension, the
1723	default extension (.xml) will be appended.
1724
1725	Note that the configuration of the newly created machine is not
1726	saved to disk (and therefore no settings file is created)
1727	until <link to="IMachine::saveSettings"/> is called. If the
1728	specified settings file already exists, this method
1729	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1730
1731	See <link to="#createMachine"/> for more information.
1732
1733	@deprecated This method may be removed later. Use <link
1734	to="IVirtualBox::createMachine"/> instead.
1735
1736	<note>
1737	There is no way to change the name of the settings file
1738	of the machine created in "legacy" mode.
1739	</note>
1740
1741	<result name="VBOX_E_OBJECT_NOT_FOUND">
1742	@a osTypeId is invalid.
1743	</result>
1744	<result name="VBOX_E_FILE_ERROR">
1745	@a settingsFile is invalid or the settings file already exists or
1746	could not be created due to an I/O error.
1747	</result>
1748	<result name="E_INVALIDARG">
1749	@a name or @a settingsFile is empty or @c null.
1750	</result>
1751	</desc>
1752
1753	<param name="name" type="wstring" dir="in">
1754	<desc>Machine name.</desc>
1755	</param>
1756	<param name="osTypeId" type="wstring" dir="in">
1757	<desc>Machine OS Type ID.</desc>
1758	</param>
1759	<param name="settingsFile" type="wstring" dir="in">
1760	<desc>Name of the machine settings file.</desc>
1761	</param>
1762	<param name="id" type="uuid" mod="string" dir="in">
1763	<desc>Machine UUID (optional).</desc>
1764	</param>
1765	<param name="machine" type="IMachine" dir="return">
1766	<desc>Created machine object.</desc>
1767	</param>
1768	</method>
1769
1770	<method name="openMachine">
1771	<desc>
1772	Opens a virtual machine from the existing settings file.
1773	The opened machine remains unregistered until you call
1774	<link to="#registerMachine"/>.
1775
1776	The specified settings file name can be absolute
1777	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1778	VirtualBox home directory</link>. This file must exist
1779	and must be a valid machine settings file whose contents
1780	will be used to construct the machine object.
1781
1782	@deprecated Will be removed soon.
1783	<result name="VBOX_E_FILE_ERROR">
1784	Settings file name invalid, not found or sharing violation.
1785	</result>
1786	</desc>
1787	<param name="settingsFile" type="wstring" dir="in">
1788	<desc>
1789	Name of the machine settings file.
1790	</desc>
1791	</param>
1792	<param name="machine" type="IMachine" dir="return">
1793	<desc>Opened machine object.</desc>
1794	</param>
1795	<note>
1796	<link to="IMachine::settingsModified"/> will return
1797	@c false for the created machine, until any of machine settings
1798	are changed.
1799	</note>
1800	</method>
1801
1802	<method name="registerMachine">
1803	<desc>
1804
1805	Registers the machine previously created using
1806	<link to="#createMachine"/> or opened using
1807	<link to="#openMachine"/> within this VirtualBox installation. After
1808	successful method invocation, the
1809	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1810	to all registered callbacks.
1811
1812	<note>
1813	This method implicitly calls <link to="IMachine::saveSettings"/>
1814	to save all current machine settings before registering it.
1815	</note>
1816
1817	<result name="VBOX_E_OBJECT_NOT_FOUND">
1818	No matching virtual machine found.
1819	</result>
1820	<result name="VBOX_E_INVALID_OBJECT_STATE">
1821	Virtual machine was not created within this VirtualBox instance.
1822	</result>
1823
1824	</desc>
1825	<param name="machine" type="IMachine" dir="in"/>
1826	</method>
1827
1828	<method name="getMachine">
1829	<desc>
1830	Attempts to find a virtual machine given its UUID.
1831	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1832	instead.
1833
1834	<result name="VBOX_E_OBJECT_NOT_FOUND">
1835	Could not find registered machine matching @a id.
1836	</result>
1837
1838	</desc>
1839	<param name="id" type="uuid" mod="string" dir="in"/>
1840	<param name="machine" type="IMachine" dir="return"/>
1841	</method>
1842
1843	<method name="findMachine">
1844	<desc>
1845	Attempts to find a virtual machine given its name.
1846	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1847	instead.
1848
1849	<result name="VBOX_E_OBJECT_NOT_FOUND">
1850	Could not find registered machine matching @a name.
1851	</result>
1852
1853	</desc>
1854	<param name="name" type="wstring" dir="in"/>
1855	<param name="machine" type="IMachine" dir="return"/>
1856	</method>
1857
1858	<method name="unregisterMachine">
1859	<desc>
1860
1861	Unregisters the machine previously registered using
1862	<link to="#registerMachine"/>. After successful method invocation, the
1863	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1864	to all registered callbacks.
1865
1866	<note>
1867	The specified machine must not be in the Saved state, have an open
1868	(or a spawning) direct session associated with it, have snapshots or
1869	have hard disks attached.
1870	</note>
1871
1872	<note>
1873	This method implicitly calls <link to="IMachine::saveSettings"/> to
1874	save all current machine settings before unregistering it.
1875	</note>
1876
1877	<note>
1878	If the given machine is inaccessible (see
1879	<link to="IMachine::accessible"/>), it will be unregistered and
1880	fully uninitialized right afterwards. As a result, the returned
1881	machine object will be unusable and an attempt to call
1882	<b>any</b> method will return the "Object not ready" error.
1883	</note>
1884
1885	<result name="VBOX_E_OBJECT_NOT_FOUND">
1886	Could not find registered machine matching @a id.
1887	</result>
1888	<result name="VBOX_E_INVALID_VM_STATE">
1889	Machine is in Saved state.
1890	</result>
1891	<result name="VBOX_E_INVALID_OBJECT_STATE">
1892	Machine has snapshot or open session or hard disk attached.
1893	</result>
1894
1895	</desc>
1896	<param name="id" type="uuid" mod="string" dir="in">
1897	<desc>UUID of the machine to unregister.</desc>
1898	</param>
1899	<param name="machine" type="IMachine" dir="return">
1900	<desc>Unregistered machine object.</desc>
1901	</param>
1902	</method>
1903
1904	<method name="createAppliance">
1905	<desc>
1906	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1907	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1908	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1909	</desc>
1910	<param name="appliance" type="IAppliance" dir="return">
1911	<desc>New appliance.</desc>
1912	</param>
1913	</method>
1914
1915	<method name="createHardDisk">
1916	<desc>
1917	Creates a new base medium object that will use the given storage
1918	format and location for medium data.
1919
1920	Note that the actual storage unit is not created by this method. In
1921	order to do it, and before you are able to attach the created medium
1922	to virtual machines, you must call one of the following methods to
1923	allocate a format-specific storage unit at the specified location:
1924	<ul>
1925	<li><link to="IMedium::createBaseStorage"/></li>
1926	<li><link to="IMedium::createDiffStorage"/></li>
1927	</ul>
1928
1929	Some medium attributes, such as <link to="IMedium::id"/>, may
1930	remain uninitialized until the medium storage unit is successfully
1931	created by one of the above methods.
1932
1933	After the storage unit is successfully created, the medium gets
1934	remembered by this VirtualBox installation and will be accessible
1935	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
1936	methods. Remembered base medium are also returned as part of
1937	the <link to="#hardDisks"/> array. See IMedium for more details.
1938
1939	The list of all storage formats supported by this VirtualBox
1940	installation can be obtained using
1941	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1942	attribute is empty or @c null then the default storage format
1943	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1944	be used for creating a storage unit of the medium.
1945
1946	Note that the format of the location string is storage format specific.
1947	See <link to="IMedium::location"/>, IMedium and
1948	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1949
1950	<result name="VBOX_E_OBJECT_NOT_FOUND">
1951	@a format identifier is invalid. See
1952	<link to="ISystemProperties::mediumFormats"/>.
1953	</result>
1954	<result name="VBOX_E_FILE_ERROR">
1955	@a location is a not valid file name (for file-based formats only).
1956	</result>
1957	</desc>
1958	<param name="format" type="wstring" dir="in">
1959	<desc>
1960	Identifier of the storage format to use for the new medium.
1961	</desc>
1962	</param>
1963	<param name="location" type="wstring" dir="in">
1964	<desc>
1965	Location of the storage unit for the new medium.
1966	</desc>
1967	</param>
1968	<param name="medium" type="IMedium" dir="return">
1969	<desc>Created medium object.</desc>
1970	</param>
1971	</method>
1972
1973	<method name="openHardDisk">
1974	<desc>
1975	Opens a medium from an existing location, optionally replacing
1976	the image UUID and/or parent UUID.
1977
1978	After the medium is successfully opened by this method, it gets
1979	remembered by (known to) this VirtualBox installation and will be
1980	accessible through <link to="#getHardDisk"/> and
1981	<link to="#findHardDisk"/> methods. Remembered base media
1982	are also returned as part of the <link to="#hardDisks"/> array and can
1983	be attached to virtual machines. See IMedium for more details.
1984
1985	If a differencing medium is to be opened by this method, the
1986	operation will succeed only if its parent medium and all ancestors,
1987	if any, are already known to this VirtualBox installation (for example,
1988	were opened by this method before).
1989
1990	This method tries to guess the storage format of the specified medium
1991	by reading medium data at the specified location.
1992
1993	If @a write is ReadWrite (which it should be), the image is opened for
1994	read/write access and must have according permissions, as VirtualBox
1995	may actually write status information into the disk's metadata sections.
1996
1997	Note that write access is required for all typical image usage in VirtualBox,
1998	since VirtualBox may need to write metadata such as a UUID into the image.
1999	The only exception is opening a source image temporarily for copying and
2000	cloning when the image will quickly be closed again.
2001
2002	Note that the format of the location string is storage format specific.
2003	See <link to="IMedium::location"/>, IMedium and
2004	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2005
2006	<result name="VBOX_E_FILE_ERROR">
2007	Invalid medium storage file location or could not find the medium
2008	at the specified location.
2009	</result>
2010	<result name="VBOX_E_IPRT_ERROR">
2011	Could not get medium storage format.
2012	</result>
2013	<result name="E_INVALIDARG">
2014	Invalid medium storage format.
2015	</result>
2016
2017	</desc>
2018	<param name="location" type="wstring" dir="in">
2019	<desc>
2020	Location of the storage unit that contains medium data in one of
2021	the supported storage formats.
2022	</desc>
2023	</param>
2024	<param name="accessMode" type="AccessMode" dir="in">
2025	<desc>
2026	Determines whether to open the image in read/write or read-only mode.
2027	</desc>
2028	</param>
2029	<param name="setImageId" type="boolean" dir="in">
2030	<desc>
2031	Select whether a new image UUID is set or not.
2032	</desc>
2033	</param>
2034	<param name="imageId" type="uuid" mod="string" dir="in">
2035	<desc>
2036	New UUID for the image. If an empty string is passed, then a new
2037	UUID is automatically created. Specifying a zero UUIDs is not valid.
2038	</desc>
2039	</param>
2040	<param name="setParentId" type="boolean" dir="in">
2041	<desc>
2042	Select whether a new parent UUID is set or not.
2043	</desc>
2044	</param>
2045	<param name="parentId" type="uuid" mod="string" dir="in">
2046	<desc>
2047	New parent UUID for the image. If an empty string is passed, then a
2048	new UUID is automatically created, provided @a setParentId is
2049	@c true. A zero UUID is valid.
2050	</desc>
2051	</param>
2052	<param name="medium" type="IMedium" dir="return">
2053	<desc>Opened medium object.</desc>
2054	</param>
2055	</method>
2056
2057	<method name="getHardDisk" const="yes">
2058	<desc>
2059	Returns a medium with the given UUID.
2060
2061	The medium with the given UUID must be known to this VirtualBox
2062	installation, i.e. it must be previously created by
2063	<link to="#createHardDisk"/> or opened by <link
2064	to="#openHardDisk"/>, or attached to some known virtual machine.
2065
2066	<result name="VBOX_E_OBJECT_NOT_FOUND">
2067	No medium object matching @a id found.
2068	</result>
2069
2070	</desc>
2071	<param name="id" type="uuid" mod="string" dir="in">
2072	<desc>UUID of the medium to look for.</desc>
2073	</param>
2074	<param name="medium" type="IMedium" dir="return">
2075	<desc>Found medium object.</desc>
2076	</param>
2077	</method>
2078
2079	<method name="findHardDisk">
2080	<desc>
2081	Returns a medium that uses the given location to store medium data.
2082
2083	The given medium must be known to this VirtualBox installation, i.e.
2084	it must be previously created by
2085	<link to="#createHardDisk"/> or opened by <link
2086	to="#openHardDisk"/>, or attached to some known virtual machine.
2087
2088	The search is done by comparing the value of the @a location argument to
2089	the <link to="IMedium::location"/> attribute of each known medium.
2090
2091	For locations represented by file names in the host's file system, the
2092	requested location can be a path relative to the
2093	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2094	only a file name without any path is given, the
2095	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2096	folder</link> will be prepended to the file name before searching. Note
2097	that on case sensitive file systems, a case sensitive comparison is
2098	performed, otherwise the case of symbols in the file path is ignored.
2099
2100	<result name="VBOX_E_OBJECT_NOT_FOUND">
2101	No medium object matching @a location found.
2102	</result>
2103
2104	</desc>
2105	<param name="location" type="wstring" dir="in">
2106	<desc>Location string to search for.</desc>
2107	</param>
2108	<param name="medium" type="IMedium" dir="return">
2109	<desc>Found medium object.</desc>
2110	</param>
2111	</method>
2112
2113	<method name="openDVDImage">
2114	<desc>
2115	Opens a CD/DVD image contained in the specified file of the supported
2116	format and assigns it the given UUID.
2117
2118	After the image is successfully opened by this method, it gets
2119	remembered by (known to) this VirtualBox installation and will be
2120	accessible through <link to="#getDVDImage"/> and
2121	<link to="#findDVDImage"/> methods. Remembered images are also
2122	returned as part of the <link to="#DVDImages"/> array and can be mounted
2123	to virtual machines. See IMedium for more details.
2124
2125	See <link to="IMedium::location"/> to get more details about the format
2126	of the location string.
2127
2128	<note>
2129	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2130	</note>
2131
2132	<result name="VBOX_E_FILE_ERROR">
2133	Invalid CD/DVD image file location or could not find the CD/DVD
2134	image at the specified location.
2135	</result>
2136	<result name="VBOX_E_INVALID_OBJECT_STATE">
2137	CD/DVD image already exists in the media registry.
2138	</result>
2139
2140	</desc>
2141	<param name="location" type="wstring" dir="in">
2142	<desc>
2143	Full path to the file that contains a valid CD/DVD image.
2144	</desc>
2145	</param>
2146	<param name="id" type="uuid" mod="string" dir="in">
2147	<desc>
2148	UUID to assign to the given image within this VirtualBox installation.
2149	If an empty (@c null) UUID is specified, the system will randomly
2150	generate a new UUID.
2151	</desc>
2152	</param>
2153	<param name="image" type="IMedium" dir="return">
2154	<desc>Opened CD/DVD image object.</desc>
2155	</param>
2156	</method>
2157
2158	<method name="getDVDImage">
2159	<desc>
2160	Returns a CD/DVD image with the given UUID.
2161
2162	The image with the given UUID must be known to this VirtualBox
2163	installation, i.e. it must be previously opened by <link
2164	to="#openDVDImage"/>, or mounted to some known virtual machine.
2165
2166	<result name="VBOX_E_OBJECT_NOT_FOUND">
2167	No matching DVD image found in the media registry.
2168	</result>
2169
2170	</desc>
2171	<param name="id" type="uuid" mod="string" dir="in">
2172	<desc>UUID of the image to look for.</desc>
2173	</param>
2174	<param name="image" type="IMedium" dir="return">
2175	<desc>Found CD/DVD image object.</desc>
2176	</param>
2177	</method>
2178
2179	<method name="findDVDImage">
2180	<desc>
2181	Returns a CD/DVD image with the given image location.
2182
2183	The image with the given UUID must be known to this VirtualBox
2184	installation, i.e. it must be previously opened by <link
2185	to="#openDVDImage"/>, or mounted to some known virtual machine.
2186
2187	The search is done by comparing the value of the @a location argument to
2188	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2189
2190	The requested location can be a path relative to the
2191	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2192	only a file name without any path is given, the
2193	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2194	folder</link> will be prepended to the file name before searching. Note
2195	that on case sensitive file systems, a case sensitive comparison is
2196	performed, otherwise the case in the file path is ignored.
2197
2198	<result name="VBOX_E_FILE_ERROR">
2199	Invalid image file location.
2200	</result>
2201	<result name="VBOX_E_OBJECT_NOT_FOUND">
2202	No matching DVD image found in the media registry.
2203	</result>
2204
2205	</desc>
2206	<param name="location" type="wstring" dir="in">
2207	<desc>CD/DVD image file path to look for.</desc>
2208	</param>
2209	<param name="image" type="IMedium" dir="return">
2210	<desc>Found CD/DVD image object.</desc>
2211	</param>
2212	</method>
2213
2214	<method name="openFloppyImage">
2215	<desc>
2216	Opens a floppy image contained in the specified file of the supported
2217	format and assigns it the given UUID.
2218
2219	After the image is successfully opened by this method, it gets
2220	remembered by (known to) this VirtualBox installation and will be
2221	accessible through <link to="#getFloppyImage"/> and
2222	<link to="#findFloppyImage"/> methods. Remembered images are also
2223	returned as part of the <link to="#floppyImages"/> array and can be
2224	mounted to virtual machines. See IMedium for more details.
2225
2226	See <link to="IMedium::location"/> to get more details about the format
2227	of the location string.
2228
2229	<result name="VBOX_E_FILE_ERROR">
2230	Invalid floppy image file location or could not find the floppy
2231	image at the specified location.
2232	</result>
2233	<result name="VBOX_E_INVALID_OBJECT_STATE">
2234	Floppy image already exists in the media registry.
2235	</result>
2236
2237	<note>
2238	Currently, only raw floppy images are supported by VirtualBox.
2239	</note>
2240	</desc>
2241	<param name="location" type="wstring" dir="in">
2242	<desc>
2243	Full path to the file that contains a valid floppy image.
2244	</desc>
2245	</param>
2246	<param name="id" type="uuid" mod="string" dir="in">
2247	<desc>
2248	UUID to assign to the given image file within this VirtualBox
2249	installation. If an empty (@c null) UUID is specified, the system will
2250	randomly generate a new UUID.
2251	</desc>
2252	</param>
2253	<param name="image" type="IMedium" dir="return">
2254	<desc>Opened floppy image object.</desc>
2255	</param>
2256	</method>
2257
2258	<method name="getFloppyImage">
2259	<desc>
2260	Returns a floppy image with the given UUID.
2261
2262	The image with the given UUID must be known to this VirtualBox
2263	installation, i.e. it must be previously opened by <link
2264	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2265
2266	<result name="VBOX_E_OBJECT_NOT_FOUND">
2267	No matching floppy image found in the media registry.
2268	</result>
2269
2270	</desc>
2271	<param name="id" type="uuid" mod="string" dir="in">
2272	<desc>UUID of the image to look for.</desc>
2273	</param>
2274	<param name="image" type="IMedium" dir="return">
2275	<desc>Found floppy image object.</desc>
2276	</param>
2277	</method>
2278
2279	<method name="findFloppyImage">
2280	<desc>
2281	Returns a floppy image with the given image location.
2282
2283	The image with the given UUID must be known to this VirtualBox
2284	installation, i.e. it must be previously opened by <link
2285	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2286
2287	The search is done by comparing the value of the @a location argument to
2288	the <link to="IMedium::location"/> attribute of each known floppy image.
2289
2290	The requested location can be a path relative to the
2291	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2292	only a file name without any path is given, the
2293	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2294	folder</link> will be prepended to the file name before searching. Note
2295	that on case sensitive file systems, a case sensitive comparison is
2296	performed, otherwise the case of symbols in the file path is ignored.
2297
2298	<result name="VBOX_E_FILE_ERROR">
2299	Invalid image file location.
2300	</result>
2301	<result name="VBOX_E_OBJECT_NOT_FOUND">
2302	No matching floppy image found in the media registry.
2303	</result>
2304
2305	</desc>
2306	<param name="location" type="wstring" dir="in">
2307	<desc>Floppy image file path to look for.</desc>
2308	</param>
2309	<param name="image" type="IMedium" dir="return">
2310	<desc>Found floppy image object.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="getGuestOSType">
2315	<desc>
2316	Returns an object describing the specified guest OS type.
2317
2318	The requested guest OS type is specified using a string which is a
2319	mnemonic identifier of the guest operating system, such as
2320	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2321	particular virtual machine can be read or set using the
2322	<link to="IMachine::OSTypeId"/> attribute.
2323
2324	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2325	available guest OS type objects. Each object has an
2326	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2327	the guest OS this object describes.
2328
2329	<result name="E_INVALIDARG">
2330	@a id is not a valid Guest OS type.
2331	</result>
2332
2333	</desc>
2334	<param name="id" type="uuid" mod="string" dir="in">
2335	<desc>Guest OS type ID string.</desc>
2336	</param>
2337	<param name="type" type="IGuestOSType" dir="return">
2338	<desc>Guest OS type object.</desc>
2339	</param>
2340	</method>
2341
2342	<method name="createSharedFolder">
2343	<desc>
2344	Creates a new global shared folder by associating the given logical
2345	name with the given host path, adds it to the collection of shared
2346	folders and starts sharing it. Refer to the description of
2347	<link to="ISharedFolder"/> to read more about logical names.
2348	<note>
2349	In the current implementation, this operation is not
2350	implemented.
2351	</note>
2352	</desc>
2353	<param name="name" type="wstring" dir="in">
2354	<desc>Unique logical name of the shared folder.</desc>
2355	</param>
2356	<param name="hostPath" type="wstring" dir="in">
2357	<desc>Full path to the shared folder in the host file system.</desc>
2358	</param>
2359	<param name="writable" type="boolean" dir="in">
2360	<desc>Whether the share is writable or readonly</desc>
2361	</param>
2362	</method>
2363
2364	<method name="removeSharedFolder">
2365	<desc>
2366	Removes the global shared folder with the given name previously
2367	created by <link to="#createSharedFolder"/> from the collection of
2368	shared folders and stops sharing it.
2369	<note>
2370	In the current implementation, this operation is not
2371	implemented.
2372	</note>
2373	</desc>
2374	<param name="name" type="wstring" dir="in">
2375	<desc>Logical name of the shared folder to remove.</desc>
2376	</param>
2377	</method>
2378
2379	<method name="getExtraDataKeys">
2380	<desc>
2381	Returns an array representing the global extra data keys which currently
2382	have values defined.
2383	</desc>
2384	<param name="value" type="wstring" dir="return" safearray="yes">
2385	<desc>Array of extra data keys.</desc>
2386	</param>
2387	</method>
2388
2389	<method name="getExtraData">
2390	<desc>
2391	Returns associated global extra data.
2392
2393	If the requested data @a key does not exist, this function will
2394	succeed and return an empty string in the @a value argument.
2395
2396	<result name="VBOX_E_FILE_ERROR">
2397	Settings file not accessible.
2398	</result>
2399	<result name="VBOX_E_XML_ERROR">
2400	Could not parse the settings file.
2401	</result>
2402
2403	</desc>
2404	<param name="key" type="wstring" dir="in">
2405	<desc>Name of the data key to get.</desc>
2406	</param>
2407	<param name="value" type="wstring" dir="return">
2408	<desc>Value of the requested data key.</desc>
2409	</param>
2410	</method>
2411
2412	<method name="setExtraData">
2413	<desc>
2414	Sets associated global extra data.
2415
2416	If you pass @c null or empty string as a key @a value, the given @a key
2417	will be deleted.
2418
2419	<note>
2420	Before performing the actual data change, this method will ask all
2421	registered callbacks using the
2422	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2423	notification for a permission. If one of the callbacks refuses the
2424	new value, the change will not be performed.
2425	</note>
2426	<note>
2427	On success, the
2428	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2429	is called to inform all registered callbacks about a successful data
2430	change.
2431	</note>
2432
2433	<result name="VBOX_E_FILE_ERROR">
2434	Settings file not accessible.
2435	</result>
2436	<result name="VBOX_E_XML_ERROR">
2437	Could not parse the settings file.
2438	</result>
2439	<result name="E_ACCESSDENIED">
2440	Modification request refused.
2441	</result>
2442
2443	</desc>
2444	<param name="key" type="wstring" dir="in">
2445	<desc>Name of the data key to set.</desc>
2446	</param>
2447	<param name="value" type="wstring" dir="in">
2448	<desc>Value to assign to the key.</desc>
2449	</param>
2450	</method>
2451
2452	<method name="openSession">
2453	<desc>
2454	Opens a new direct session with the given virtual machine.
2455
2456	A direct session acts as a local lock on the given VM.
2457	There can be only one direct session open at a time for every
2458	virtual machine, protecting the VM from being manipulated by
2459	conflicting actions from different processes. Only after a
2460	direct session has been opened, one can change all VM settings
2461	and execute the VM in the process space of the session object.
2462
2463	Sessions therefore can be compared to mutex semaphores that
2464	lock a given VM for modification and execution.
2465	See <link to="ISession">ISession</link> for details.
2466
2467	<note>Unless you are writing a new VM frontend, you will not
2468	want to execute a VM in the current process. To spawn a new
2469	process that executes a VM, use
2470	<link to="IVirtualBox::openRemoteSession" />
2471	instead.</note>
2472
2473	Upon successful return, the session object can be used to
2474	get access to the machine and to the VM console.
2475
2476	In VirtualBox terminology, the machine becomes "mutable" after
2477	a session has been opened. Note that the "mutable" machine
2478	object, on which you may invoke IMachine methods to change its
2479	settings, will be a different object from the immutable IMachine
2480	objects returned by various IVirtualBox methods. To obtain a
2481	mutable IMachine object (upon which you can invoke settings methods),
2482	use the <link to="ISession::machine" /> attribute.
2483
2484	One must always call <link to="ISession::close" /> to release the
2485	lock on the machine, or the machine's state will eventually be
2486	set to "Aborted".
2487
2488	In other words, to change settings on a machine, the following
2489	sequence is typically performed:
2490
2491	<ol>
2492	<li>Call this method (openSession) to have a machine locked for
2493	the current session.</li>
2494
2495	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2496
2497	<li>Change the settings of the machine.</li>
2498
2499	<li>Call <link to="IMachine::saveSettings" />.</li>
2500
2501	<li>Close the session by calling <link to="ISession::close"/>.</li>
2502	</ol>
2503
2504	<result name="E_UNEXPECTED">
2505	Virtual machine not registered.
2506	</result>
2507	<result name="E_ACCESSDENIED">
2508	Process not started by OpenRemoteSession.
2509	</result>
2510	<result name="VBOX_E_OBJECT_NOT_FOUND">
2511	No matching virtual machine found.
2512	</result>
2513	<result name="VBOX_E_INVALID_OBJECT_STATE">
2514	Session already open or being opened.
2515	</result>
2516	<result name="VBOX_E_VM_ERROR">
2517	Failed to assign machine to session.
2518	</result>
2519
2520	</desc>
2521	<param name="session" type="ISession" dir="in">
2522	<desc>
2523	Session object that will represent the opened session after
2524	successful method invocation. This object must not represent
2525	the already open session.
2526	<note>
2527	This session will be automatically closed if the
2528	VirtualBox server is terminated for some reason.
2529	</note>
2530	</desc>
2531	</param>
2532	<param name="machineId" type="uuid" mod="string" dir="in">
2533	<desc>ID of the virtual machine to open a session with.</desc>
2534	</param>
2535	</method>
2536
2537	<method name="openRemoteSession">
2538	<desc>
2539	Spawns a new process that executes a virtual machine (called a
2540	"remote session").
2541
2542	Opening a remote session causes the VirtualBox server to start a new
2543	process that opens a direct session with the given VM. As a result, the
2544	VM is locked by that direct session in the new process, preventing
2545	conflicting changes from other processes. Since sessions act as locks
2546	that prevent conflicting changes, one cannot open a remote session
2547	for a VM that already has another open session (direct or remote), or
2548	is currently in the process of opening one (see <link
2549	to="IMachine::sessionState"/>).
2550
2551	While the remote session still provides some level of control over the
2552	VM execution to the caller (using the <link to="IConsole" /> interface),
2553	not all VM settings are available for modification within the remote
2554	session context.
2555
2556	This operation can take some time (a new VM is started in a new process,
2557	for which memory and other resources need to be set up). Because of this,
2558	an <link to="IProgress" /> is returned to allow the caller to wait for this
2559	asynchronous operation to be completed. Until then, the remote session
2560	object remains in the closed state, and accessing the machine or its
2561	console through it is invalid. It is recommended to use
2562	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2563	completion.
2564
2565	As with all <link to="ISession" /> objects, it is recommended to call
2566	<link to="ISession::close" /> on the local session object once openRemoteSession()
2567	has been called. However, the session's state (see <link to="ISession::state" />)
2568	will not return to "Closed" until the remote session has also closed (i.e.
2569	until the VM is no longer running). In that case, however, the state of
2570	the session will automatically change back to "Closed".
2571
2572	Currently supported session types (values of the @a type
2573	argument) are:
2574	<ul>
2575	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2576	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2577	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2578	</ul>
2579
2580	The @a environment argument is a string containing definitions of
2581	environment variables in the following format:
2582	@code
2583	NAME[=VALUE]\n
2584	NAME[=VALUE]\n
2585	...
2586	@endcode
2587	where <tt>\\n</tt> is the new line character. These environment
2588	variables will be appended to the environment of the VirtualBox server
2589	process. If an environment variable exists both in the server process
2590	and in this list, the value from this list takes precedence over the
2591	server's variable. If the value of the environment variable is
2592	omitted, this variable will be removed from the resulting environment.
2593	If the environment string is @c null or empty, the server environment
2594	is inherited by the started process as is.
2595
2596	<see>openExistingSession</see>
2597
2598	<result name="E_UNEXPECTED">
2599	Virtual machine not registered.
2600	</result>
2601	<result name="E_INVALIDARG">
2602	Invalid session type @a type.
2603	</result>
2604	<result name="VBOX_E_OBJECT_NOT_FOUND">
2605	No machine matching @a machineId found.
2606	</result>
2607	<result name="VBOX_E_INVALID_OBJECT_STATE">
2608	Session already open or being opened.
2609	</result>
2610	<result name="VBOX_E_IPRT_ERROR">
2611	Launching process for machine failed.
2612	</result>
2613	<result name="VBOX_E_VM_ERROR">
2614	Failed to assign machine to session.
2615	</result>
2616
2617	</desc>
2618	<param name="session" type="ISession" dir="in">
2619	<desc>
2620	Session object that will represent the opened remote session
2621	after successful method invocation (this object must not
2622	represent an already open session).
2623	</desc>
2624	</param>
2625	<param name="machineId" type="uuid" mod="string" dir="in">
2626	<desc>ID of the virtual machine to open a session with.</desc>
2627	</param>
2628	<param name="type" type="wstring" dir="in">
2629	<desc>
2630	Type of the remote session (case sensitive).
2631	</desc>
2632	</param>
2633	<param name="environment" type="wstring" dir="in">
2634	<desc>
2635	Environment to pass to the opened session.
2636	</desc>
2637	</param>
2638	<param name="progress" type="IProgress" dir="return">
2639	<desc>Progress object to track the operation completion.</desc>
2640	</param>
2641	</method>
2642
2643	<method name="openExistingSession">
2644	<desc>
2645	Opens a new remote session with the virtual machine for
2646	which a direct session is already open.
2647
2648	The remote session provides some level of control over the VM
2649	execution (using the IConsole interface) to the caller; however,
2650	within the remote session context, not all VM settings are available
2651	for modification.
2652
2653	As opposed to <link to="#openRemoteSession"/>, the number of
2654	remote sessions opened this way is not limited by the API
2655
2656	<note>
2657	It is an error to open a remote session with the machine that
2658	doesn't have an open direct session.
2659	</note>
2660
2661	<result name="E_UNEXPECTED">
2662	Virtual machine not registered.
2663	</result>
2664	<result name="VBOX_E_OBJECT_NOT_FOUND">
2665	No machine matching @a machineId found.
2666	</result>
2667	<result name="VBOX_E_INVALID_OBJECT_STATE">
2668	Session already open or being opened.
2669	</result>
2670	<result name="VBOX_E_INVALID_SESSION_STATE">
2671	Direct session state not Open.
2672	</result>
2673	<result name="VBOX_E_VM_ERROR">
2674	Failed to get console object from direct session or assign
2675	machine to session.
2676	</result>
2677
2678	<see>openRemoteSession</see>
2679	</desc>
2680	<param name="session" type="ISession" dir="in">
2681	<desc>
2682	Session object that will represent the open remote session
2683	after successful method invocation. This object must not
2684	represent an already open session.
2685	<note>
2686	This session will be automatically closed when the peer
2687	(direct) session dies or gets closed.
2688	</note>
2689	</desc>
2690	</param>
2691	<param name="machineId" type="uuid" mod="string" dir="in">
2692	<desc>ID of the virtual machine to open a session with.</desc>
2693	</param>
2694	</method>
2695
2696	<method name="registerCallback">
2697	<desc>
2698	Registers a new global VirtualBox callback. The methods of the given
2699	callback object will be called by VirtualBox when an appropriate
2700	event occurs.
2701
2702	<result name="E_INVALIDARG">
2703	A @c null callback cannot be registered.
2704	</result>
2705
2706	</desc>
2707	<param name="callback" type="IVirtualBoxCallback" dir="in">
2708	<desc>Callback object to register.</desc>
2709	</param>
2710	</method>
2711
2712	<method name="unregisterCallback">
2713	<desc>
2714	Unregisters the previously registered global VirtualBox callback.
2715
2716	<result name="E_INVALIDARG">
2717	Specified @a callback not registered.
2718	</result>
2719
2720	</desc>
2721	<param name="callback" type="IVirtualBoxCallback" dir="in">
2722	<desc>Callback object to unregister.</desc>
2723	</param>
2724	</method>
2725
2726	<method name="waitForPropertyChange">
2727	<desc>
2728	Blocks the caller until any of the properties represented by the
2729	@a what argument changes the value or until the given timeout interval
2730	expires.
2731
2732	The @a what argument is a comma separated list of property masks that
2733	describe properties the caller is interested in. The property mask is
2734	a string in the following format:
2735
2736	<pre>
2737	[[group.]subgroup.]name
2738	</pre>
2739
2740	where @c name is the property name and @c group, @c subgroup are zero
2741	or more property group specifiers. Each element (group or name) in
2742	the property mask may be either a Latin string or an asterisk symbol
2743	(@c "*") which is used to match any string for the given element. A
2744	property mask that doesn't contain asterisk symbols represents a
2745	single fully qualified property name.
2746
2747	Groups in the fully qualified property name go from more generic (the
2748	left-most part) to more specific (the right-most part). The first
2749	element is usually a name of the object the property belongs to. The
2750	second element may be either a property name, or a child object name,
2751	or an index if the preceding element names an object which is one of
2752	many objects of the same type. This way, property names form a
2753	hierarchy of properties. Here are some examples of property names:
2754
2755	<table>
2756	<tr>
2757	<td><tt>VirtualBox.version</tt></td>
2758	<td><link to="IVirtualBox::version"/> property</td>
2759	</tr>
2760	<tr>
2761	<td><tt>Machine.<UUID>.name</tt></td>
2762	<td><link to="IMachine::name"/> property of the machine with the
2763	given UUID</td>
2764	</tr>
2765	</table>
2766
2767	Most property names directly correspond to the properties of objects
2768	(components) provided by the VirtualBox library and may be used to
2769	track changes to these properties. However, there may be
2770	pseudo-property names that don't correspond to any existing object's
2771	property directly, as well as there may be object properties that
2772	don't have a corresponding property name that is understood by this
2773	method, and therefore changes to such properties cannot be
2774	tracked. See individual object's property descriptions to get a
2775	fully qualified property name that can be used with this method (if
2776	any).
2777
2778	There is a special property mask @c "*" (i.e. a string consisting of a
2779	single asterisk symbol) that can be used to match all properties.
2780	Below are more examples of property masks:
2781
2782	<table>
2783	<tr>
2784	<td><tt>VirtualBox.*</tt></td>
2785	<td>Track all properties of the VirtualBox object</td>
2786	</tr>
2787	<tr>
2788	<td><tt>Machine.*.name</tt></td>
2789	<td>Track changes to the <link to="IMachine::name"/> property of
2790	all registered virtual machines</td>
2791	</tr>
2792	</table>
2793
2794	<note>
2795	This function is not implemented in the current version of the
2796	product.
2797	</note>
2798	</desc>
2799	<param name="what" type="wstring" dir="in">
2800	<desc>Comma separated list of property masks.</desc>
2801	</param>
2802	<param name="timeout" type="unsigned long" dir="in">
2803	<desc>
2804	Wait timeout in milliseconds.
2805	Specify -1 for an indefinite wait.
2806	</desc>
2807	</param>
2808	<param name="changed" type="wstring" dir="out">
2809	<desc>
2810	Comma separated list of properties that have been changed and caused
2811	this method to return to the caller.
2812	</desc>
2813	</param>
2814	<param name="values" type="wstring" dir="out">
2815	<desc>Reserved, not currently used.</desc>
2816	</param>
2817	</method>
2818
2819	<!--method name="createDHCPServerForInterface">
2820	<desc>
2821	Creates a dhcp server settings to be used for the given interface
2822	<result name="E_INVALIDARG">
2823	Host network interface @a name already exists.
2824	</result>
2825	</desc>
2826	<param name="interface" type="IHostNetworkInterface" dir="in">
2827	<desc>Network Interface</desc>
2828	</param>
2829	<param name="server" type="IDHCPServer" dir="out">
2830	<desc>Dhcp server settings</desc>
2831	</param>
2832	</method-->
2833
2834	<method name="createDHCPServer">
2835	<desc>
2836	Creates a dhcp server settings to be used for the given internal network name
2837	<result name="E_INVALIDARG">
2838	Host network interface @a name already exists.
2839	</result>
2840	</desc>
2841	<param name="name" type="wstring" dir="in">
2842	<desc>server name</desc>
2843	</param>
2844	<param name="server" type="IDHCPServer" dir="return">
2845	<desc>Dhcp server settings</desc>
2846	</param>
2847	</method>
2848
2849	<method name="findDHCPServerByNetworkName">
2850	<desc>
2851	Searches a dhcp server settings to be used for the given internal network name
2852	<result name="E_INVALIDARG">
2853	Host network interface @a name already exists.
2854	</result>
2855
2856	</desc>
2857	<param name="name" type="wstring" dir="in">
2858	<desc>server name</desc>
2859	</param>
2860	<param name="server" type="IDHCPServer" dir="return">
2861	<desc>Dhcp server settings</desc>
2862	</param>
2863	</method>
2864
2865	<!--method name="findDHCPServerForInterface">
2866	<desc>
2867	Searches a dhcp server settings to be used for the given interface
2868	<result name="E_INVALIDARG">
2869	Host network interface @a name already exists.
2870	</result>
2871	</desc>
2872	<param name="interface" type="IHostNetworkInterface" dir="in">
2873	<desc>Network Interface</desc>
2874	</param>
2875	<param name="server" type="IDHCPServer" dir="out">
2876	<desc>Dhcp server settings</desc>
2877	</param>
2878	</method-->
2879
2880	<method name="removeDHCPServer">
2881	<desc>
2882	Removes the dhcp server settings
2883	<result name="E_INVALIDARG">
2884	Host network interface @a name already exists.
2885	</result>
2886	</desc>
2887	<param name="server" type="IDHCPServer" dir="in">
2888	<desc>Dhcp server settings to be removed</desc>
2889	</param>
2890	</method>
2891
2892	</interface>
2893
2894	<!--
2895	// IVFSExplorer
2896	/////////////////////////////////////////////////////////////////////////
2897	-->
2898
2899	<enum
2900	name="VFSType"
2901	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2902	>
2903	<desc>
2904	Virtual file systems supported by VFSExplorer.
2905	</desc>
2906
2907	<const name="File" value="1" />
2908	<const name="Cloud" value="2" />
2909	<const name="S3" value="3" />
2910	<const name="WebDav" value="4" />
2911	</enum>
2912
2913	<enum
2914	name="VFSFileType"
2915	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2916	>
2917	<desc>
2918	File types known by VFSExplorer.
2919	</desc>
2920
2921	<const name="Unknown" value="1" />
2922	<const name="Fifo" value="2" />
2923	<const name="DevChar" value="3" />
2924	<const name="Directory" value="4" />
2925	<const name="DevBlock" value="5" />
2926	<const name="File" value="6" />
2927	<const name="SymLink" value="7" />
2928	<const name="Socket" value="8" />
2929	<const name="WhiteOut" value="9" />
2930	</enum>
2931
2932	<interface
2933	name="IVFSExplorer" extends="$unknown"
2934	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2935	wsmap="managed"
2936	>
2937	<desc>
2938	The VFSExplorer interface unifies access to different file system
2939	types. This includes local file systems as well remote file systems like
2940	S3. For a list of supported types see <link to="VFSType" />.
2941	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2942	</desc>
2943
2944	<attribute name="path" type="wstring" readonly="yes">
2945	<desc>Returns the current path in the virtual file system.</desc>
2946	</attribute>
2947
2948	<attribute name="type" type="VFSType" readonly="yes">
2949	<desc>Returns the file system type which is currently in use.</desc>
2950	</attribute>
2951
2952	<method name="update">
2953	<desc>Updates the internal list of files/directories from the
2954	current directory level. Use <link to="#entryList" /> to get the full list
2955	after a call to this method.</desc>
2956
2957	<param name="aProgress" type="IProgress" dir="return">
2958	<desc>Progress object to track the operation completion.</desc>
2959	</param>
2960	</method>
2961
2962	<method name="cd">
2963	<desc>Change the current directory level.</desc>
2964
2965	<param name="aDir" type="wstring" dir="in">
2966	<desc>The name of the directory to go in.</desc>
2967	</param>
2968
2969	<param name="aProgress" type="IProgress" dir="return">
2970	<desc>Progress object to track the operation completion.</desc>
2971	</param>
2972	</method>
2973
2974	<method name="cdUp">
2975	<desc>Go one directory upwards from the current directory level.</desc>
2976
2977	<param name="aProgress" type="IProgress" dir="return">
2978	<desc>Progress object to track the operation completion.</desc>
2979	</param>
2980	</method>
2981
2982	<method name="entryList">
2983	<desc>Returns a list of files/directories after a call to <link
2984	to="#update" />. The user is responsible for keeping this internal
2985	list up do date.</desc>
2986
2987	<param name="aNames" type="wstring" safearray="yes" dir="out">
2988	<desc>The list of names for the entries.</desc>
2989	</param>
2990
2991	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2992	<desc>The list of types for the entries.</desc>
2993	</param>
2994	</method>
2995
2996	<method name="exists">
2997	<desc>Checks if the given file list exists in the current directory
2998	level.</desc>
2999
3000	<param name="aNames" type="wstring" safearray="yes" dir="in">
3001	<desc>The names to check.</desc>
3002	</param>
3003
3004	<param name="aExists" type="wstring" safearray="yes" dir="return">
3005	<desc>The names which exist.</desc>
3006	</param>
3007	</method>
3008
3009	<method name="remove">
3010	<desc>Deletes the given files in the current directory level.</desc>
3011
3012	<param name="aNames" type="wstring" safearray="yes" dir="in">
3013	<desc>The names to remove.</desc>
3014	</param>
3015
3016	<param name="aProgress" type="IProgress" dir="return">
3017	<desc>Progress object to track the operation completion.</desc>
3018	</param>
3019	</method>
3020
3021	</interface>
3022
3023	<!--
3024	// IAppliance
3025	/////////////////////////////////////////////////////////////////////////
3026	-->
3027
3028	<interface
3029	name="IAppliance" extends="$unknown"
3030	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3031	wsmap="managed"
3032	>
3033	<desc>
3034	Represents a platform-independent appliance in OVF format. An instance of this is returned
3035	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3036	appliances with VirtualBox.
3037
3038	The OVF standard suggests two different physical file formats:
3039
3040	<ol>
3041	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3042	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3043	this descriptor file references other files, as OVF appliances distributed as a set of
3044	files most likely do, those files must be in the same directory as the descriptor file.</li>
3045
3046	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3047	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3048	files and optionally other files.
3049
3050	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3051	be added with a later version.</li>
3052	</ol>
3053
3054	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3055	<link to="IMachine" /> involves the following sequence of API calls:
3056
3057	<ol>
3058	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3059	</li>
3060
3061	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3062	would like to import. So long as this file is syntactically valid, this will succeed
3063	and return an instance of IAppliance that contains the parsed data from the OVF file.
3064	</li>
3065
3066	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3067	contents of the IAppliance attributes accordingly. These can be inspected by a
3068	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3069	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3070	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3071	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3072	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3073	The GUI can then give the user the option to confirm and/or change these suggestions.
3074	</li>
3075
3076	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3077	virtual system to override the suggestions made by the interpret() routine.
3078	</li>
3079
3080	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3081	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3082	virtual system descriptions.
3083	</li>
3084	</ol>
3085
3086	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3087
3088	<ol>
3089	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3090	an empty IAppliance object.
3091	</li>
3092
3093	<li>For each machine you would like to export, call <link to="IMachine::export" />
3094	with the IAppliance object you just created. This creates an instance of
3095	<link to="IVirtualSystemDescription" /> inside the appliance.
3096	</li>
3097
3098	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3099	virtual system to override the suggestions made by the export() routine.
3100	</li>
3101
3102	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3103	file written.</li>
3104	</ol>
3105
3106	</desc>
3107
3108	<attribute name="path" type="wstring" readonly="yes">
3109	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3110	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3111	<link to="#write" /> (for export).
3112	This attribute is empty until one of these methods has been called.
3113	</desc>
3114	</attribute>
3115
3116	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3117	<desc>
3118	Array of virtual disk definitions. One such description exists for each
3119	disk definition in the OVF; each string array item represents one such piece of
3120	disk information, with the information fields separated by tab (\\t) characters.
3121
3122	The caller should be prepared for additional fields being appended to
3123	this string in future versions of VirtualBox and therefore check for
3124	the number of tabs in the strings returned.
3125
3126	In the current version, the following eight fields are returned per string
3127	in the array:
3128
3129	<ol>
3130	<li>Disk ID (unique string identifier given to disk)</li>
3131
3132	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3133
3134	<li>Populated size (optional unsigned integer indicating the current size of the
3135	disk; can be approximate; -1 if unspecified)</li>
3136
3137	<li>Format (string identifying the disk format, typically
3138	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3139
3140	<li>Reference (where to find the disk image, typically a file name; if empty,
3141	then the disk should be created on import)</li>
3142
3143	<li>Image size (optional unsigned integer indicating the size of the image,
3144	which need not necessarily be the same as the values specified above, since
3145	the image may be compressed or sparse; -1 if not specified)</li>
3146
3147	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3148	presently unsupported and always -1)</li>
3149
3150	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3151	</ol>
3152	</desc>
3153	</attribute>
3154
3155	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3156	<desc> Array of virtual system descriptions. One such description is created
3157	for each virtual system found in the OVF.
3158	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3159	(for export) has been called.
3160	</desc>
3161	</attribute>
3162
3163	<method name="read">
3164	<desc>
3165	Reads an OVF file into the appliance object.
3166
3167	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3168	mere fact that this method returns successfully does not mean that VirtualBox supports all
3169	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3170	</desc>
3171	<param name="file" type="wstring" dir="in">
3172	<desc>
3173	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3174	on whether the appliance is distributed as a set of files or as a single file, respectively).
3175	</desc>
3176	</param>
3177	<param name="aProgress" type="IProgress" dir="return">
3178	<desc></desc>
3179	</param>
3180	</method>
3181
3182	<method name="interpret">
3183	<desc>
3184	Interprets the OVF data that was read when the appliance was constructed. After
3185	calling this method, one can inspect the
3186	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3187	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3188	the appliance.
3189
3190	Calling this method is the second step of importing an appliance into VirtualBox;
3191	see <link to="IAppliance" /> for an overview.
3192
3193	After calling this method, one should call <link to="#getWarnings" /> to find out
3194	if problems were encountered during the processing which might later lead to
3195	errors.
3196	</desc>
3197	</method>
3198
3199	<method name="importMachines">
3200	<desc>
3201	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3202	and other interfaces that match the information contained in the appliance as
3203	closely as possible, as represented by the import instructions in the
3204	<link to="#virtualSystemDescriptions" /> array.
3205
3206	Calling this method is the final step of importing an appliance into VirtualBox;
3207	see <link to="IAppliance" /> for an overview.
3208
3209	Since importing the appliance will most probably involve copying and converting
3210	disk images, which can take a long time, this method operates asynchronously and
3211	returns an IProgress object to allow the caller to monitor the progress.
3212	</desc>
3213
3214	<param name="aProgress" type="IProgress" dir="return">
3215	<desc></desc>
3216	</param>
3217	</method>
3218
3219	<method name="createVFSExplorer">
3220	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3221
3222	<param name="aUri" type="wstring" dir="in">
3223	<desc>The URI describing the file system to use.</desc>
3224	</param>
3225
3226	<param name="aExplorer" type="IVFSExplorer" dir="return">
3227	<desc></desc>
3228	</param>
3229	</method>
3230
3231	<method name="write">
3232	<desc>
3233	Writes the contents of the appliance exports into a new OVF file.
3234
3235	Calling this method is the final step of exporting an appliance from VirtualBox;
3236	see <link to="IAppliance" /> for an overview.
3237
3238	Since exporting the appliance will most probably involve copying and converting
3239	disk images, which can take a long time, this method operates asynchronously and
3240	returns an IProgress object to allow the caller to monitor the progress.
3241	</desc>
3242	<param name="format" type="wstring" dir="in">
3243	<desc>
3244	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3245	future versions of VirtualBox may support additional formats.
3246	</desc>
3247	</param>
3248	<param name="path" type="wstring" dir="in">
3249	<desc>
3250	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3251	on whether the appliance is distributed as a set of files or as a single file, respectively).
3252	</desc>
3253	</param>
3254	<param name="aProgress" type="IProgress" dir="return">
3255	<desc>Progress object to track the operation completion.</desc>
3256	</param>
3257	</method>
3258
3259	<method name="getWarnings">
3260	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3261
3262	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3263	<desc></desc>
3264	</param>
3265	</method>
3266
3267	</interface>
3268
3269	<enum
3270	name="VirtualSystemDescriptionType"
3271	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3272	>
3273	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3274	a configuration value.</desc>
3275
3276	<const name="Ignore" value="1" />
3277	<const name="OS" value="2" />
3278	<const name="Name" value="3" />
3279	<const name="Product" value="4" />
3280	<const name="Vendor" value="5" />
3281	<const name="Version" value="6" />
3282	<const name="ProductUrl" value="7" />
3283	<const name="VendorUrl" value="8" />
3284	<const name="Description" value="9" />
3285	<const name="License" value="10" />
3286	<const name="Miscellaneous" value="11" />
3287	<const name="CPU" value="12" />
3288	<const name="Memory" value="13" />
3289	<const name="HardDiskControllerIDE" value="14" />
3290	<const name="HardDiskControllerSATA" value="15" />
3291	<const name="HardDiskControllerSCSI" value="16" />
3292	<const name="HardDiskImage" value="17" />
3293	<const name="Floppy" value="18" />
3294	<const name="CDROM" value="19" />
3295	<const name="NetworkAdapter" value="20" />
3296	<const name="USBController" value="21" />
3297	<const name="SoundCard" value="22" />
3298
3299	</enum>
3300
3301	<enum
3302	name="VirtualSystemDescriptionValueType"
3303	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3304	>
3305	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3306	type to fetch.</desc>
3307
3308	<const name="Reference" value="1" />
3309	<const name="Original" value="2" />
3310	<const name="Auto" value="3" />
3311	<const name="ExtraConfig" value="4" />
3312
3313	</enum>
3314
3315	<interface
3316	name="IVirtualSystemDescription" extends="$unknown"
3317	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3318	wsmap="managed"
3319	>
3320
3321	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3322	After <link to="IAppliance::interpret" /> has been called, that array contains
3323	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3324	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3325	into VirtualBox.
3326	</desc>
3327
3328	<attribute name="count" type="unsigned long" readonly="yes">
3329	<desc>Return the number of virtual system description entries.</desc>
3330	</attribute>
3331
3332	<method name="getDescription">
3333	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3334	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3335
3336	The list below identifies the value sets that are possible depending on the
3337	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3338	the array item with the same index in aOvfValues[] will contain the original value as contained
3339	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3340	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3341	the aExtraConfigValues[] array item may also be used.
3342
3343	<ul>
3344	<li>
3345	"OS": the guest operating system type. There must be exactly one such array item on import. The
3346	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3347	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3348	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3349	</li>
3350	<li>
3351	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3352	if none is present on import, then an automatic name will be created from the operating system
3353	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3354	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3355	<link to="IMachine" /> name that does not exist yet.
3356	</li>
3357	<li>
3358	"Description": an arbitrary description.
3359	</li>
3360	<li>
3361	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3362	code to display such a license for agreement; the Main API does not enforce any such policy.
3363	</li>
3364	<li>
3365	Miscellaneous: reserved for future use.
3366	</li>
3367	<li>
3368	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3369	</li>
3370	<li>
3371	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3372	is present on import, then VirtualBox will set a meaningful default based on the operating system
3373	type.
3374	</li>
3375	<li>
3376	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3377	has no value in aOvfValues[] or aVBoxValues[].
3378	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3379	type can use to specify which hard disk controller a virtual disk should be connected to.
3380	</li>
3381	<li>
3382	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3383	has no value in aOvfValues[] or aVBoxValues[].
3384	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3385	</li>
3386	<li>
3387	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3388	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3389	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3390	</li>
3391	<li>
3392	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3393	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3394
3395	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3396	a path since the image file should be in the same location as the OVF file itself), whereas the
3397	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3398	hard disk image. This means that on import the image will be copied and converted from the
3399	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3400	On import, the target image will also be registered with VirtualBox.
3401
3402	The matching item in the aExtraConfigValues[] array must contain a string of the following
3403	format: "controller=<index>;channel=<c>"
3404	In this string, <index> must be an integer specifying the hard disk controller to connect
3405	the image to. That number must be the index of an array item with one of the hard disk controller
3406	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3407	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3408	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3409	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3410	</li>
3411	<li>
3412	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3413	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3414	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3415	</li>
3416	<li>
3417	"USBController": a USB controller. There can be at most one such item. If and only if such an
3418	item ispresent, USB support will be enabled for the new virtual machine.
3419	</li>
3420	<li>
3421	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3422	present, sound support will be enabled for the new virtual machine. Note that the virtual
3423	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3424	may be different from the virtual soundcard expected by the appliance.
3425	</li>
3426	</ul>
3427
3428	</desc>
3429
3430	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3431	<desc></desc>
3432	</param>
3433
3434	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3435	<desc></desc>
3436	</param>
3437
3438	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3439	<desc></desc>
3440	</param>
3441
3442	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3443	<desc></desc>
3444	</param>
3445
3446	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3447	<desc></desc>
3448	</param>
3449
3450	</method>
3451
3452	<method name="getDescriptionByType">
3453	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3454	should be returned.</desc>
3455
3456	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3457	<desc></desc>
3458	</param>
3459
3460	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3461	<desc></desc>
3462	</param>
3463
3464	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3465	<desc></desc>
3466	</param>
3467
3468	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3469	<desc></desc>
3470	</param>
3471
3472	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3473	<desc></desc>
3474	</param>
3475
3476	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3477	<desc></desc>
3478	</param>
3479
3480	</method>
3481
3482	<method name="getValuesByType">
3483	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3484	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3485	values.</desc>
3486
3487	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3488	<desc></desc>
3489	</param>
3490
3491	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3492	<desc></desc>
3493	</param>
3494
3495	<param name="aValues" type="wstring" dir="return" safearray="yes">
3496	<desc></desc>
3497	</param>
3498
3499	</method>
3500
3501	<method name="setFinalValues">
3502	<desc>
3503	This method allows the appliance's user to change the configuration for the virtual
3504	system descriptions. For each array item returned from <link to="#getDescription" />,
3505	you must pass in one boolean value and one configuration value.
3506
3507	Each item in the boolean array determines whether the particular configuration item
3508	should be enabled.
3509	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3510	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3511	and SoundCard.
3512
3513	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3514	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3515	the configuration remains unchanged. Please see the documentation for getDescription()
3516	for valid configuration values for the individual array item types. If the
3517	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3518	</desc>
3519
3520	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3521	<desc></desc>
3522	</param>
3523
3524	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3525	<desc></desc>
3526	</param>
3527
3528	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3529	<desc></desc>
3530	</param>
3531	</method>
3532
3533	<method name="addDescription">
3534	<desc>
3535	This method adds an additional description entry to the stack of already
3536	available descriptions for this virtual system. This is handy for writing
3537	values which aren't directly supported by VirtualBox. One example would
3538	be the License type of <link to="VirtualSystemDescriptionType" />.
3539	</desc>
3540
3541	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3542	<desc></desc>
3543	</param>
3544
3545	<param name="aVBoxValue" type="wstring" dir="in">
3546	<desc></desc>
3547	</param>
3548
3549	<param name="aExtraConfigValue" type="wstring" dir="in">
3550	<desc></desc>
3551	</param>
3552	</method>
3553	</interface>
3554
3555
3556	<!--
3557	// IMachine
3558	/////////////////////////////////////////////////////////////////////////
3559	-->
3560
3561	<interface
3562	name="IInternalMachineControl" extends="$unknown"
3563	uuid="6c08103e-b8e6-44fb-bc6c-36067153d4bd"
3564	internal="yes"
3565	wsmap="suppress"
3566	>
3567	<method name="setRemoveSavedState">
3568	<desc>
3569	Updates the flag whether saved state is removed on a machine state
3570	change from Saved to PoweredOff.
3571	</desc>
3572	<param name="aRemove" type="boolean" dir="in"/>
3573	</method>
3574
3575	<method name="updateState">
3576	<desc>
3577	Updates the VM state.
3578	<note>
3579	This operation will also update the settings file with
3580	the correct information about the saved state file
3581	and delete this file from disk when appropriate.
3582	</note>
3583	</desc>
3584	<param name="state" type="MachineState" dir="in"/>
3585	</method>
3586
3587	<method name="getIPCId">
3588	<param name="id" type="wstring" dir="return"/>
3589	</method>
3590
3591	<method name="runUSBDeviceFilters">
3592	<desc>
3593	Asks the server to run USB devices filters of the associated
3594	machine against the given USB device and tell if there is
3595	a match.
3596	<note>
3597	Intended to be used only for remote USB devices. Local
3598	ones don't require to call this method (this is done
3599	implicitly by the Host and USBProxyService).
3600	</note>
3601	</desc>
3602	<param name="device" type="IUSBDevice" dir="in"/>
3603	<param name="matched" type="boolean" dir="out"/>
3604	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3605	</method>
3606
3607	<method name="captureUSBDevice">
3608	<desc>
3609	Requests a capture of the given host USB device.
3610	When the request is completed, the VM process will
3611	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3612	notification.
3613	</desc>
3614	<param name="id" type="uuid" mod="string" dir="in"/>
3615	</method>
3616
3617	<method name="detachUSBDevice">
3618	<desc>
3619	Notification that a VM is going to detach (@a done = @c false) or has
3620	already detached (@a done = @c true) the given USB device.
3621	When the @a done = @c true request is completed, the VM process will
3622	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3623	notification.
3624	<note>
3625	In the @a done = @c true case, the server must run its own filters
3626	and filters of all VMs but this one on the detached device
3627	as if it were just attached to the host computer.
3628	</note>
3629	</desc>
3630	<param name="id" type="uuid" mod="string" dir="in"/>
3631	<param name="done" type="boolean" dir="in"/>
3632	</method>
3633
3634	<method name="autoCaptureUSBDevices">
3635	<desc>
3636	Requests a capture all matching USB devices attached to the host.
3637	When the request is completed, the VM process will
3638	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3639	notification per every captured device.
3640	</desc>
3641	</method>
3642
3643	<method name="detachAllUSBDevices">
3644	<desc>
3645	Notification that a VM that is being powered down. The done
3646	parameter indicates whether which stage of the power down
3647	we're at. When @a done = @c false the VM is announcing its
3648	intentions, while when @a done = @c true the VM is reporting
3649	what it has done.
3650	<note>
3651	In the @a done = @c true case, the server must run its own filters
3652	and filters of all VMs but this one on all detach devices as
3653	if they were just attached to the host computer.
3654	</note>
3655	</desc>
3656	<param name="done" type="boolean" dir="in"/>
3657	</method>
3658
3659	<method name="onSessionEnd">
3660	<desc>
3661	Triggered by the given session object when the session is about
3662	to close normally.
3663	</desc>
3664	<param name="session" type="ISession" dir="in">
3665	<desc>Session that is being closed</desc>
3666	</param>
3667	<param name="progress" type="IProgress" dir="return">
3668	<desc>
3669	Used to wait until the corresponding machine is actually
3670	dissociated from the given session on the server.
3671	Returned only when this session is a direct one.
3672	</desc>
3673	</param>
3674	</method>
3675
3676	<method name="beginSavingState">
3677	<desc>
3678	Called by the VM process to inform the server it wants to
3679	save the current state and stop the VM execution.
3680	</desc>
3681	<param name="progress" type="IProgress" dir="in">
3682	<desc>
3683	Progress object created by the VM process to wait until
3684	the state is saved.
3685	</desc>
3686	</param>
3687	<param name="stateFilePath" type="wstring" dir="out">
3688	<desc>
3689	File path the VM process must save the execution state to.
3690	</desc>
3691	</param>
3692	</method>
3693
3694	<method name="endSavingState">
3695	<desc>
3696	Called by the VM process to inform the server that saving
3697	the state previously requested by #beginSavingState is either
3698	successfully finished or there was a failure.
3699
3700	<result name="VBOX_E_FILE_ERROR">
3701	Settings file not accessible.
3702	</result>
3703	<result name="VBOX_E_XML_ERROR">
3704	Could not parse the settings file.
3705	</result>
3706
3707	</desc>
3708
3709	<param name="success" type="boolean" dir="in">
3710	<desc>@c true to indicate success and @c false otherwise.
3711	</desc>
3712	</param>
3713	</method>
3714
3715	<method name="adoptSavedState">
3716	<desc>
3717	Gets called by IConsole::adoptSavedState.
3718	<result name="VBOX_E_FILE_ERROR">
3719	Invalid saved state file path.
3720	</result>
3721	</desc>
3722	<param name="savedStateFile" type="wstring" dir="in">
3723	<desc>Path to the saved state file to adopt.</desc>
3724	</param>
3725	</method>
3726
3727	<method name="beginTakingSnapshot">
3728	<desc>
3729	Called from the VM process to request from the server to perform the
3730	server-side actions of creating a snapshot (creating differencing images
3731	and the snapshot object).
3732
3733	<result name="VBOX_E_FILE_ERROR">
3734	Settings file not accessible.
3735	</result>
3736	<result name="VBOX_E_XML_ERROR">
3737	Could not parse the settings file.
3738	</result>
3739	</desc>
3740	<param name="initiator" type="IConsole" dir="in">
3741	<desc>The console object that initiated this call.</desc>
3742	</param>
3743	<param name="name" type="wstring" dir="in">
3744	<desc>Snapshot name.</desc>
3745	</param>
3746	<param name="description" type="wstring" dir="in">
3747	<desc>Snapshot description.</desc>
3748	</param>
3749	<param name="consoleProgress" type="IProgress" dir="in">
3750	<desc>
3751	Progress object created by the VM process tracking the
3752	snapshot's progress. This has the following sub-operations:
3753	<ul>
3754	<li>setting up (weight 1);</li>
3755	<li>one for each hard disk attachment that needs a differencing image (weight 1 each);</li>
3756	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3757	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3758	<li>finishing up (weight 1)</li>
3759	</ul>
3760	</desc>
3761	</param>
3762	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3763	<desc>
3764	Whether this is an online snapshot (i.e. the machine is running).
3765	</desc>
3766	</param>
3767	<param name="stateFilePath" type="wstring" dir="out">
3768	<desc>
3769	File path the VM process must save the execution state to.
3770	</desc>
3771	</param>
3772	</method>
3773
3774	<method name="endTakingSnapshot">
3775	<desc>
3776	Called by the VM process to inform the server that the snapshot
3777	previously requested by #beginTakingSnapshot is either
3778	successfully taken or there was a failure.
3779	</desc>
3780
3781	<param name="success" type="boolean" dir="in">
3782	<desc>@c true to indicate success and @c false otherwise</desc>
3783	</param>
3784	</method>
3785
3786	<method name="discardSnapshot">
3787	<desc>
3788	Gets called by IConsole::discardSnapshot.
3789	<result name="VBOX_E_INVALID_OBJECT_STATE">
3790	Snapshot has more than one child snapshot.
3791	</result>
3792	</desc>
3793	<param name="initiator" type="IConsole" dir="in">
3794	<desc>The console object that initiated this call.</desc>
3795	</param>
3796	<param name="id" type="uuid" mod="string" dir="in">
3797	<desc>UUID of the snapshot to discard.</desc>
3798	</param>
3799	<param name="machineState" type="MachineState" dir="out">
3800	<desc>New machine state after this operation is started.</desc>
3801	</param>
3802	<param name="progress" type="IProgress" dir="return">
3803	<desc>Progress object to track the operation completion.</desc>
3804	</param>
3805	</method>
3806
3807	<method name="discardCurrentState">
3808	<desc>
3809	Gets called by IConsole::discardCurrentState.
3810	<result name="VBOX_E_INVALID_OBJECT_STATE">
3811	Virtual machine does not have any snapshot.
3812	</result>
3813	</desc>
3814	<param name="initiator" type="IConsole" dir="in">
3815	<desc>The console object that initiated this call.</desc>
3816	</param>
3817	<param name="machineState" type="MachineState" dir="out">
3818	<desc>New machine state after this operation is started.</desc>
3819	</param>
3820	<param name="progress" type="IProgress" dir="return">
3821	<desc>Progress object to track the operation completion.</desc>
3822	</param>
3823	</method>
3824
3825	<method name="discardCurrentSnapshotAndState">
3826	<desc>
3827	Gets called by IConsole::discardCurrentSnapshotAndState.
3828	<result name="VBOX_E_INVALID_OBJECT_STATE">
3829	Virtual machine does not have any snapshot.
3830	</result>
3831	</desc>
3832	<param name="initiator" type="IConsole" dir="in">
3833	<desc>The console object that initiated this call.</desc>
3834	</param>
3835	<param name="machineState" type="MachineState" dir="out">
3836	<desc>New machine state after this operation is started.</desc>
3837	</param>
3838	<param name="progress" type="IProgress" dir="return">
3839	<desc>Progress object to track the operation completion.</desc>
3840	</param>
3841	</method>
3842
3843	<method name="pullGuestProperties">
3844	<desc>
3845	Get the list of the guest properties matching a set of patterns along
3846	with their values, time stamps and flags and give responsibility for
3847	managing properties to the console.
3848	</desc>
3849	<param name="name" type="wstring" dir="out" safearray="yes">
3850	<desc>
3851	The names of the properties returned.
3852	</desc>
3853	</param>
3854	<param name="value" type="wstring" dir="out" safearray="yes">
3855	<desc>
3856	The values of the properties returned. The array entries match the
3857	corresponding entries in the @a name array.
3858	</desc>
3859	</param>
3860	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3861	<desc>
3862	The time stamps of the properties returned. The array entries match
3863	the corresponding entries in the @a name array.
3864	</desc>
3865	</param>
3866	<param name="flags" type="wstring" dir="out" safearray="yes">
3867	<desc>
3868	The flags of the properties returned. The array entries match the
3869	corresponding entries in the @a name array.
3870	</desc>
3871	</param>
3872	</method>
3873
3874	<method name="pushGuestProperties">
3875	<desc>
3876	Set the list of the guest properties matching a set of patterns along
3877	with their values, time stamps and flags and return responsibility for
3878	managing properties to IMachine.
3879	</desc>
3880	<param name="name" type="wstring" dir="in" safearray="yes">
3881	<desc>
3882	The names of the properties.
3883	</desc>
3884	</param>
3885	<param name="value" type="wstring" dir="in" safearray="yes">
3886	<desc>
3887	The values of the properties. The array entries match the
3888	corresponding entries in the @a name array.
3889	</desc>
3890	</param>
3891	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
3892	<desc>
3893	The time stamps of the properties. The array entries match
3894	the corresponding entries in the @a name array.
3895	</desc>
3896	</param>
3897	<param name="flags" type="wstring" dir="in" safearray="yes">
3898	<desc>
3899	The flags of the properties. The array entries match the
3900	corresponding entries in the @a name array.
3901	</desc>
3902	</param>
3903	</method>
3904	<method name="pushGuestProperty">
3905	<desc>
3906	Update a single guest property in IMachine.
3907	</desc>
3908	<param name="name" type="wstring" dir="in">
3909	<desc>
3910	The name of the property to be updated.
3911	</desc>
3912	</param>
3913	<param name="value" type="wstring" dir="in">
3914	<desc>
3915	The value of the property.
3916	</desc>
3917	</param>
3918	<param name="timestamp" type="unsigned long long" dir="in">
3919	<desc>
3920	The timestamp of the property.
3921	</desc>
3922	</param>
3923	<param name="flags" type="wstring" dir="in">
3924	<desc>
3925	The flags of the property.
3926	</desc>
3927	</param>
3928	</method>
3929
3930	<method name="lockMedia">
3931	<desc>
3932	Locks all media attached to the machine for writing and parents of
3933	attached differencing media (if any) for reading. This operation is
3934	atomic so that if it fails no media is actually locked.
3935
3936	This method is intended to be called when the machine is in Starting or
3937	Restoring state. The locked media will be automatically unlocked when
3938	the machine is powered off or crashed.
3939	</desc>
3940	</method>
3941	</interface>
3942
3943	<interface
3944	name="IBIOSSettings" extends="$unknown"
3945	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3946	wsmap="managed"
3947	>
3948	<desc>
3949	The IBIOSSettings interface represents BIOS settings of the virtual
3950	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3951	</desc>
3952	<attribute name="logoFadeIn" type="boolean">
3953	<desc>Fade in flag for BIOS logo animation.</desc>
3954	</attribute>
3955
3956	<attribute name="logoFadeOut" type="boolean">
3957	<desc>Fade out flag for BIOS logo animation.</desc>
3958	</attribute>
3959
3960	<attribute name="logoDisplayTime" type="unsigned long">
3961	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3962	</attribute>
3963
3964	<attribute name="logoImagePath" type="wstring">
3965	<desc>Local file system path for external BIOS image.</desc>
3966	</attribute>
3967
3968	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3969	<desc>Mode of the BIOS boot device menu.</desc>
3970	</attribute>
3971
3972	<attribute name="ACPIEnabled" type="boolean">
3973	<desc>ACPI support flag.</desc>
3974	</attribute>
3975
3976	<attribute name="IOAPICEnabled" type="boolean">
3977	<desc>
3978	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3979	and support IRQs above 15.
3980	</desc>
3981	</attribute>
3982
3983	<attribute name="timeOffset" type="long long">
3984	<desc>
3985	Offset in milliseconds from the host system time. This allows for
3986	guests running with a different system date/time than the host.
3987	It is equivalent to setting the system date/time in the BIOS except
3988	it is not an absolute value but a relative one. Guest Additions
3989	time synchronization honors this offset.
3990	</desc>
3991	</attribute>
3992
3993	<attribute name="PXEDebugEnabled" type="boolean">
3994	<desc>
3995	PXE debug logging flag. If set, VirtualBox will write extensive
3996	PXE trace information to the release log.
3997	</desc>
3998	</attribute>
3999
4000	</interface>
4001
4002	<interface
4003	name="IMachine" extends="$unknown"
4004	uuid="445ecfcc-8ebd-a2a5-459c-4d21ae0b206b"
4005	wsmap="managed"
4006	>
4007	<desc>
4008	The IMachine interface represents a virtual machine, or guest, created
4009	in VirtualBox.
4010
4011	This interface is used in two contexts. First of all, a collection of
4012	objects implementing this interface is stored in the
4013	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4014	machines that are currently registered with this VirtualBox
4015	installation. Also, once a session has been opened for the given virtual
4016	machine (e.g. the virtual machine is running), the machine object
4017	associated with the open session can be queried from the session object;
4018	see <link to="ISession"/> for details.
4019
4020	The main role of this interface is to expose the settings of the virtual
4021	machine and provide methods to change various aspects of the virtual
4022	machine's configuration. For machine objects stored in the
4023	<link to="IVirtualBox::machines"/> collection, all attributes are
4024	read-only unless explicitly stated otherwise in individual attribute
4025	and method descriptions. In order to change a machine setting, a session
4026	for this machine must be opened using one of
4027	<link to="IVirtualBox::openSession"/>,
4028	<link to="IVirtualBox::openRemoteSession"/> or
4029	<link to="IVirtualBox::openExistingSession"/> methods. After the
4030	session has been successfully opened, a mutable machine object needs to
4031	be queried from the session object and then the desired settings changes
4032	can be applied to the returned object using IMachine attributes and
4033	methods. See the <link to="ISession"/> interface description for more
4034	information about sessions.
4035
4036	Note that IMachine does not provide methods to control virtual machine
4037	execution (such as start the machine, or power it down) -- these methods
4038	are grouped in a separate interface called <link to="IConsole" />.
4039
4040	<see>ISession, IConsole</see>
4041	</desc>
4042
4043	<attribute name="parent" type="IVirtualBox" readonly="yes">
4044	<desc>Associated parent object.</desc>
4045	</attribute>
4046
4047	<attribute name="accessible" type="boolean" readonly="yes">
4048	<desc>
4049	Whether this virtual machine is currently accessible or not.
4050
4051	A machine is always deemed accessible unless it is registered <i>and</i>
4052	its settings file cannot be read or parsed (either because the file itself
4053	is unavailable or has invalid XML contents).
4054
4055	Every time this property is read, the accessibility state of
4056	this machine is re-evaluated. If the returned value is @c false,
4057	the <link to="#accessError"/> property may be used to get the
4058	detailed error information describing the reason of
4059	inaccessibility, including XML error messages.
4060
4061	When the machine is inaccessible, only the following properties
4062	can be used on it:
4063	<ul>
4064	<li><link to="#parent"/></li>
4065	<li><link to="#id"/></li>
4066	<li><link to="#settingsFilePath"/></li>
4067	<li><link to="#accessible"/></li>
4068	<li><link to="#accessError"/></li>
4069	</ul>
4070
4071	An attempt to access any other property or method will return
4072	an error.
4073
4074	The only possible action you can perform on an inaccessible
4075	machine is to unregister it using the
4076	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4077	for the accessibility state once more by querying this
4078	property).
4079
4080	<note>
4081	In the current implementation, once this property returns
4082	@c true, the machine will never become inaccessible
4083	later, even if its settings file cannot be successfully
4084	read/written any more (at least, until the VirtualBox
4085	server is restarted). This limitation may be removed in
4086	future releases.
4087	</note>
4088	</desc>
4089	</attribute>
4090
4091	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4092	<desc>
4093	Error information describing the reason of machine
4094	inaccessibility.
4095
4096	Reading this property is only valid after the last call to
4097	<link to="#accessible"/> returned @c false (i.e. the
4098	machine is currently unaccessible). Otherwise, a @c null
4099	IVirtualBoxErrorInfo object will be returned.
4100	</desc>
4101	</attribute>
4102
4103	<attribute name="name" type="wstring">
4104	<desc>
4105	Name of the virtual machine.
4106
4107	Besides being used for human-readable identification purposes
4108	everywhere in VirtualBox, the virtual machine name is also used
4109	as a name of the machine's settings file and as a name of the
4110	subdirectory this settings file resides in. Thus, every time you
4111	change the value of this property, the settings file will be
4112	renamed once you call <link to="#saveSettings"/> to confirm the
4113	change. The containing subdirectory will be also renamed, but
4114	only if it has exactly the same name as the settings file
4115	itself prior to changing this property (for backward compatibility
4116	with previous API releases). The above implies the following
4117	limitations:
4118	<ul>
4119	<li>The machine name cannot be empty.</li>
4120	<li>The machine name can contain only characters that are valid
4121	file name characters according to the rules of the file
4122	system used to store VirtualBox configuration.</li>
4123	<li>You cannot have two or more machines with the same name
4124	if they use the same subdirectory for storing the machine
4125	settings files.</li>
4126	<li>You cannot change the name of the machine if it is running,
4127	or if any file in the directory containing the settings file
4128	is being used by another running machine or by any other
4129	process in the host operating system at a time when
4130	<link to="#saveSettings"/> is called.
4131	</li>
4132	</ul>
4133	If any of the above limitations are hit, <link to="#saveSettings"/>
4134	will return an appropriate error message explaining the exact
4135	reason and the changes you made to this machine will not be
4136	saved.
4137	<note>
4138	For "legacy" machines created using the
4139	<link to="IVirtualBox::createLegacyMachine"/> call,
4140	the above naming limitations do not apply because the
4141	machine name does not affect the settings file name.
4142	The settings file name remains the same as it was specified
4143	during machine creation and never changes.
4144	</note>
4145	</desc>
4146	</attribute>
4147
4148	<attribute name="description" type="wstring">
4149	<desc>
4150	Description of the virtual machine.
4151
4152	The description attribute can contain any text and is
4153	typically used to describe the hardware and software
4154	configuration of the virtual machine in detail (i.e. network
4155	settings, versions of the installed software and so on).
4156	</desc>
4157	</attribute>
4158
4159	<attribute name="id" type="uuid" mod="string" readonly="yes">
4160	<desc>UUID of the virtual machine.</desc>
4161	</attribute>
4162
4163	<attribute name="OSTypeId" type="wstring">
4164	<desc>
4165	User-defined identifier of the Guest OS type.
4166	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4167	an IGuestOSType object representing details about the given
4168	Guest OS type.
4169	<note>
4170	This value may differ from the value returned by
4171	<link to="IGuest::OSTypeId"/> if Guest Additions are
4172	installed to the guest OS.
4173	</note>
4174	</desc>
4175	</attribute>
4176
4177	<attribute name="HardwareVersion" type="wstring">
4178	<desc>Hardware version identifier. Internal use only for now.</desc>
4179	</attribute>
4180
4181	<attribute name="CPUCount" type="unsigned long">
4182	<desc>Number of virtual CPUs in the VM.</desc>
4183	</attribute>
4184
4185	<attribute name="memorySize" type="unsigned long">
4186	<desc>System memory size in megabytes.</desc>
4187	</attribute>
4188
4189	<attribute name="memoryBalloonSize" type="unsigned long">
4190	<desc>Initial memory balloon size in megabytes.</desc>
4191	</attribute>
4192
4193	<attribute name="statisticsUpdateInterval" type="unsigned long">
4194	<desc>Initial interval to update guest statistics in seconds.</desc>
4195	</attribute>
4196
4197	<attribute name="VRAMSize" type="unsigned long">
4198	<desc>Video memory size in megabytes.</desc>
4199	</attribute>
4200
4201	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4202	<desc>
4203	This setting determines whether VirtualBox allows this machine to make
4204	use of the 3D graphics support available on the host.</desc>
4205	</attribute>
4206
4207	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4208	<desc>
4209	This setting determines whether VirtualBox allows this machine to make
4210	use of the 2D video acceleration support available on the host.</desc>
4211	</attribute>
4212
4213	<attribute name="monitorCount" type="unsigned long">
4214	<desc>
4215	Number of virtual monitors.
4216	<note>
4217	Only effective on Windows XP and later guests with
4218	Guest Additions installed.
4219	</note>
4220	</desc>
4221	</attribute>
4222
4223	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4224	<desc>Object containing all BIOS settings.</desc>
4225	</attribute>
4226
4227	<attribute name="firmwareType" type="FirmwareType">
4228	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4229	bootstrap in this VM.</desc>
4230	</attribute>
4231
4232	<attribute name="HWVirtExEnabled" type="boolean">
4233	<desc>
4234	This setting determines whether VirtualBox will try to make use of
4235	the host CPU's hardware virtualization extensions such as Intel VT-x
4236	and AMD-V. Note that in case such extensions are not available,
4237	they will not be used.
4238	</desc>
4239	</attribute>
4240
4241	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" default="false">
4242	<desc>
4243	This setting determines whether VirtualBox will try to make use of
4244	the nested paging extension of Intel VT-x and AMD-V. Note that in case
4245	such extensions are not available, they will not be used.
4246	</desc>
4247	</attribute>
4248
4249	<attribute name="HWVirtExVPIDEnabled" type="boolean" default="false">
4250	<desc>
4251	This setting determines whether VirtualBox will try to make use of
4252	the VPID extension of Intel VT-x. Note that in case such extensions are
4253	not available, they will not be used.
4254	</desc>
4255	</attribute>
4256
4257	<attribute name="PAEEnabled" type="boolean" default="false">
4258	<desc>
4259	This setting determines whether VirtualBox will expose the Physical Address
4260	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
4261	is not available, it will not be reported.
4262	</desc>
4263	</attribute>
4264
4265	<attribute name="snapshotFolder" type="wstring">
4266	<desc>
4267	Full path to the directory used to store snapshot data
4268	(differencing media and saved state files) of this machine.
4269
4270	The initial value of this property is
4271	<tt><</tt><link to="#settingsFilePath">
4272	path_to_settings_file</link><tt>>/<</tt>
4273	<link to="#id">machine_uuid</link>
4274	<tt>></tt>.
4275
4276	Currently, it is an error to try to change this property on
4277	a machine that has snapshots (because this would require to
4278	move possibly large files to a different location).
4279	A separate method will be available for this purpose later.
4280
4281	<note>
4282	Setting this property to @c null or to an empty string will restore
4283	the initial value.
4284	</note>
4285	<note>
4286	When setting this property, the specified path can be
4287	absolute (full path) or relative to the directory where the
4288	<link to="#settingsFilePath">machine settings file</link>
4289	is located. When reading this property, a full path is
4290	always returned.
4291	</note>
4292	<note>
4293	The specified path may not exist, it will be created
4294	when necessary.
4295	</note>
4296	</desc>
4297	</attribute>
4298
4299	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4300	<desc>VRDP server object.</desc>
4301	</attribute>
4302
4303	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4304	<desc>Array of media attached to this machine.</desc>
4305	</attribute>
4306
4307	<attribute name="USBController" type="IUSBController" readonly="yes">
4308	<desc>
4309	Associated USB controller object.
4310
4311	<note>
4312	If USB functionality is not available in the given edition of
4313	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4314	</note>
4315	</desc>
4316	</attribute>
4317
4318	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4319	<desc>Associated audio adapter, always present.</desc>
4320	</attribute>
4321
4322	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4323	<desc>Array of storage controllers attached to this machine.</desc>
4324	</attribute>
4325
4326	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4327	<desc>
4328	Full name of the file containing machine settings data.
4329	</desc>
4330	</attribute>
4331
4332	<attribute name="settingsModified" type="boolean" readonly="yes">
4333	<desc>
4334	Whether the settings of this machine have been modified
4335	(but neither yet saved nor discarded).
4336	<note>
4337	Reading this property is only valid on instances returned
4338	by <link to="ISession::machine"/> and on new machines
4339	created by <link to="IVirtualBox::createMachine"/> or opened
4340	by <link to="IVirtualBox::openMachine"/> but not
4341	yet registered, or on unregistered machines after calling
4342	<link to="IVirtualBox::unregisterMachine"/>. For all other
4343	cases, the settings can never be modified.
4344	</note>
4345	<note>
4346	For newly created unregistered machines, the value of this
4347	property is always @c true until <link to="#saveSettings"/>
4348	is called (no matter if any machine settings have been
4349	changed after the creation or not). For opened machines
4350	the value is set to @c false (and then follows to normal rules).
4351	</note>
4352	</desc>
4353	</attribute>
4354
4355	<attribute name="sessionState" type="SessionState" readonly="yes">
4356	<desc>Current session state for this machine.</desc>
4357	</attribute>
4358
4359	<attribute name="sessionType" type="wstring" readonly="yes">
4360	<desc>
4361	Type of the session. If <link to="#sessionState"/> is
4362	SessionSpawning or SessionOpen, this attribute contains the
4363	same value as passed to the
4364	<link to="IVirtualBox::openRemoteSession"/> method in the
4365	@a type parameter. If the session was opened directly using
4366	<link to="IVirtualBox::openSession"/>, or if
4367	<link to="#sessionState"/> is SessionClosed, the value of this
4368	attribute is an empty string.
4369	</desc>
4370	</attribute>
4371
4372	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4373	<desc>
4374	Identifier of the session process. This attribute contains the
4375	platform-dependent identifier of the process that has opened a
4376	direct session for this machine using the
4377	<link to="IVirtualBox::openSession"/> call. The returned value
4378	is only valid if <link to="#sessionState"/> is SessionOpen or
4379	SessionClosing (i.e. a session is currently open or being
4380	closed) by the time this property is read.
4381	</desc>
4382	</attribute>
4383
4384	<attribute name="state" type="MachineState" readonly="yes">
4385	<desc>Current execution state of this machine.</desc>
4386	</attribute>
4387
4388	<attribute name="lastStateChange" type="long long" readonly="yes">
4389	<desc>
4390	Time stamp of the last execution state change,
4391	in milliseconds since 1970-01-01 UTC.
4392	</desc>
4393	</attribute>
4394
4395	<attribute name="stateFilePath" type="wstring" readonly="yes">
4396	<desc>
4397	Full path to the file that stores the execution state of
4398	the machine when it is in the <link to="MachineState_Saved"/> state.
4399	<note>
4400	When the machine is not in the Saved state, this attribute is
4401	an empty string.
4402	</note>
4403	</desc>
4404	</attribute>
4405
4406	<attribute name="logFolder" type="wstring" readonly="yes">
4407	<desc>
4408	Full path to the folder that stores a set of rotated log files
4409	recorded during machine execution. The most recent log file is
4410	named <tt>VBox.log</tt>, the previous log file is
4411	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4412	in the current version).
4413	</desc>
4414	</attribute>
4415
4416	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4417	<desc>
4418	Current snapshot of this machine. This is @c null if the machine
4419	currently has no snapshots. Otherwise, this is always the last snapshot
4420	in the current implementation; see <link to="ISnapshot"/> for details.
4421	</desc>
4422	</attribute>
4423
4424	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4425	<desc>
4426	Number of snapshots taken on this machine. Zero means the
4427	machine doesn't have any snapshots.
4428	</desc>
4429	</attribute>
4430
4431	<attribute name="currentStateModified" type="boolean" readonly="yes">
4432	<desc>
4433	Returns @c true if the current state of the machine is not
4434	identical to the state stored in the current snapshot.
4435
4436	The current state is identical to the current snapshot right
4437	after one of the following calls are made:
4438	<ul>
4439	<li><link to="IConsole::discardCurrentState"/> or
4440	<link to="IConsole::discardCurrentSnapshotAndState"/>
4441	</li>
4442	<li><link to="IConsole::takeSnapshot"/> (issued on a
4443	powered off or saved machine, for which
4444	<link to="#settingsModified"/> returns @c false)
4445	</li>
4446	<li><link to="IMachine::setCurrentSnapshot"/>
4447	</li>
4448	</ul>
4449
4450	The current state remains identical until one of the following
4451	happens:
4452	<ul>
4453	<li>settings of the machine are changed</li>
4454	<li>the saved state is discarded</li>
4455	<li>the current snapshot is discarded</li>
4456	<li>an attempt to execute the machine is made</li>
4457	</ul>
4458
4459	<note>
4460	For machines that don't have snapshots, this property is
4461	always @c false.
4462	</note>
4463	</desc>
4464	</attribute>
4465
4466	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4467	<desc>
4468	Collection of shared folders for this machine (permanent shared
4469	folders). These folders are shared automatically at machine startup
4470	and available only to the guest OS installed within this machine.
4471
4472	New shared folders are added to the collection using
4473	<link to="#createSharedFolder"/>. Existing shared folders can be
4474	removed using <link to="#removeSharedFolder"/>.
4475	</desc>
4476	</attribute>
4477
4478	<attribute name="clipboardMode" type="ClipboardMode">
4479	<desc>
4480	Synchronization mode between the host OS clipboard
4481	and the guest OS clipboard.
4482	</desc>
4483	</attribute>
4484
4485	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4486	<desc>
4487	A comma-separated list of simple glob patterns. Changes to guest
4488	properties whose name matches one of the patterns will generate an
4489	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4490	</desc>
4491	</attribute>
4492
4493	<method name="setBootOrder">
4494	<desc>
4495	Puts the given device to the specified position in
4496	the boot order.
4497
4498	To indicate that no device is associated with the given position,
4499	<link to="DeviceType_Null"/> should be used.
4500
4501	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4502
4503	<result name="E_INVALIDARG">
4504	Boot @a position out of range.
4505	</result>
4506	<result name="E_NOTIMPL">
4507	Booting from USB @a device currently not supported.
4508	</result>
4509
4510	</desc>
4511	<param name="position" type="unsigned long" dir="in">
4512	<desc>
4513	Position in the boot order (@c 1 to the total number of
4514	devices the machine can boot from, as returned by
4515	<link to="ISystemProperties::maxBootPosition"/>).
4516	</desc>
4517	</param>
4518	<param name="device" type="DeviceType" dir="in">
4519	<desc>
4520	The type of the device used to boot at the given position.
4521	</desc>
4522	</param>
4523	</method>
4524
4525	<method name="getBootOrder" const="yes">
4526	<desc>
4527	Returns the device type that occupies the specified
4528	position in the boot order.
4529
4530	@todo [remove?]
4531	If the machine can have more than one device of the returned type
4532	(such as hard disks), then a separate method should be used to
4533	retrieve the individual device that occupies the given position.
4534
4535	If here are no devices at the given position, then
4536	<link to="DeviceType_Null"/> is returned.
4537
4538	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4539
4540	<result name="E_INVALIDARG">
4541	Boot @a position out of range.
4542	</result>
4543
4544	</desc>
4545	<param name="position" type="unsigned long" dir="in">
4546	<desc>
4547	Position in the boot order (@c 1 to the total number of
4548	devices the machine can boot from, as returned by
4549	<link to="ISystemProperties::maxBootPosition"/>).
4550	</desc>
4551	</param>
4552	<param name="device" type="DeviceType" dir="return">
4553	<desc>
4554	Device at the given position.
4555	</desc>
4556	</param>
4557	</method>
4558
4559	<method name="attachDevice">
4560	<desc>
4561	Attaches a device and optionally mounts a medium to the given storage
4562	controller (<link to="IStorageController" />, identified by @a name),
4563	at the indicated port and device.
4564
4565	This method is intended for managing storage devices in general (it works
4566	for both fixed and removable media). For storage devices supporting removable
4567	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4568	for changing the media while the machine is running.
4569
4570	For the IDE bus, the @a controllerPort parameter can be either
4571	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4572	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4573	to specify the master or the slave device, respectively. (In the
4574	default configuration of virtual machines, the secondary master is
4575	used for a CD/DVD drive.)
4576
4577	For an SATA controller, @a controllerPort must be a number ranging
4578	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4579	be a number ranging from @c 0 to @c 15.
4580
4581	For both SCSI and SATA, the @a device parameter is unused and must
4582	be @c 0.
4583
4584	For fixed media such as hard disks, the given medium cannot be NULL. It may
4585	be NULL for removable media such as DVDs and floppies.
4586
4587	After calling this returns successfully, a new instance of
4588	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4589	attachments (<link to="IMachine::mediumAttachments"/>).
4590
4591	The specified device slot must not have another disk attached to it, or
4592	this method will fail.
4593
4594	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4595	information about attaching media.
4596
4597	<note>
4598	You cannot attach a hard disk to a running machine. Also, you cannot
4599	attach a hard disk to a newly created machine until this machine's
4600	settings are saved to disk using <link to="#saveSettings"/>.
4601	</note>
4602	<note>
4603	If the medium is being attached indirectly, a new differencing medium
4604	will implicitly be created for it and attached instead. If the
4605	changes made to the machine settings (including this indirect
4606	attachment) are later cancelled using <link to="#discardSettings"/>,
4607	this implicitly created differencing medium will implicitly
4608	be deleted.
4609	</note>
4610
4611	<result name="E_INVALIDARG">
4612	SATA device, SATA port, IDE port or IDE slot out of range.
4613	</result>
4614	<result name="VBOX_E_INVALID_OBJECT_STATE">
4615	Attempt to attach medium to an unregistered virtual machine.
4616	</result>
4617	<result name="VBOX_E_INVALID_VM_STATE">
4618	Invalid machine state.
4619	</result>
4620	<result name="VBOX_E_OBJECT_IN_USE">
4621	Hard disk already attached to this or another virtual machine.
4622	</result>
4623
4624	</desc>
4625	<param name="name" type="wstring" dir="in">
4626	<desc>Name of the storage controller to attach the device to.</desc>
4627	</param>
4628	<param name="controllerPort" type="long" dir="in">
4629	<desc>Port to attach the device to.</desc>
4630	</param>
4631	<param name="device" type="long" dir="in">
4632	<desc>Device slot in the given port to attach the device to.</desc>
4633	</param>
4634	<param name="type" type="DeviceType" dir="in">
4635	<desc>Device type of the attached device.</desc>
4636	</param>
4637	<param name="id" type="uuid" mod="string" dir="in">
4638	<desc>UUID of the medium to mount. NULL UUID means do not mount any
4639	medium.</desc>
4640	</param>
4641	</method>
4642
4643	<method name="detachDevice">
4644	<desc>
4645	Detaches the device attached to a device slot of the specified bus.
4646
4647	Detaching the device from the virtual machine is deferred. This means
4648	that the medium remains associated with the machine when this method
4649	returns and gets actually de-associated only after a successful
4650	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4651	for more detailed information about attaching media.
4652
4653	<note>
4654	You cannot detach the hard disk from a running machine.
4655	</note>
4656	<note>
4657	Detaching differencing media implicitly created by <link
4658	to="#attachDevice"/> for the indirect attachment using this
4659	method will <b>not</b> implicitly delete them. The
4660	<link to="IMedium::deleteStorage"/> operation should be
4661	explicitly performed by the caller after the medium is successfully
4662	detached and the settings are saved with
4663	<link to="#saveSettings"/>, if it is the desired action.
4664	</note>
4665
4666	<result name="VBOX_E_INVALID_VM_STATE">
4667	Attempt to detach medium from a running virtual machine.
4668	</result>
4669	<result name="VBOX_E_OBJECT_NOT_FOUND">
4670	No medium attached to given slot/bus.
4671	</result>
4672	<result name="VBOX_E_NOT_SUPPORTED">
4673	Hard disk format does not support storage deletion.
4674	</result>
4675
4676	</desc>
4677	<param name="name" type="wstring" dir="in">
4678	<desc>Name of the storage controller to detach the medium from.</desc>
4679	</param>
4680	<param name="controllerPort" type="long" dir="in">
4681	<desc>Port number to detach the medium from.</desc>
4682	</param>
4683	<param name="device" type="long" dir="in">
4684	<desc>Device slot number to detach the medium from.</desc>
4685	</param>
4686	</method>
4687
4688	<method name="mountMedium">
4689	<desc>
4690	Mounts a medium (<link to="IMedium" />, identified
4691	by the given UUID @a id) to the given storage controller
4692	(<link to="IStorageController" />, identified by @a name),
4693	at the indicated port and device. The device must already exist;
4694	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4695
4696	This method is intended only for managing removable media, where the
4697	device is fixed but media is changeable at runtime (such as DVDs
4698	and floppies). It cannot be used for fixed media such as hard disks.
4699
4700	The @a controllerPort and @a device parameters specify the device slot and
4701	have have the same meaning as with <link to="IMachine::attachDevice" />.
4702
4703	The specified device slot can have a medium mounted, which will be
4704	unmounted first. Specifying a NULL medium does just an unmount.
4705
4706	See <link to="IMedium"/> for more detailed information about
4707	attaching media.
4708
4709	<result name="E_INVALIDARG">
4710	SATA device, SATA port, IDE port or IDE slot out of range.
4711	</result>
4712	<result name="VBOX_E_INVALID_OBJECT_STATE">
4713	Attempt to attach medium to an unregistered virtual machine.
4714	</result>
4715	<result name="VBOX_E_INVALID_VM_STATE">
4716	Invalid machine state.
4717	</result>
4718	<result name="VBOX_E_OBJECT_IN_USE">
4719	Medium already attached to this or another virtual machine.
4720	</result>
4721
4722	</desc>
4723	<param name="name" type="wstring" dir="in">
4724	<desc>Name of the storage controller to attach the medium to.</desc>
4725	</param>
4726	<param name="controllerPort" type="long" dir="in">
4727	<desc>Port to attach the medium to.</desc>
4728	</param>
4729	<param name="device" type="long" dir="in">
4730	<desc>Device slot in the given port to attach the medium to.</desc>
4731	</param>
4732	<param name="id" type="uuid" mod="string" dir="in">
4733	<desc>UUID of the medium to attach.</desc>
4734	</param>
4735	</method>
4736
4737	<method name="getMedium" const="yes">
4738	<desc>
4739	Returns the virtual medium attached to a device slot of the specified
4740	bus.
4741
4742	Note that if the medium was indirectly attached by
4743	<link to="#mountMedium"/> to the given device slot then this
4744	method will return not the same object as passed to the
4745	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4746	more detailed information about mounting a medium.
4747
4748	<result name="VBOX_E_OBJECT_NOT_FOUND">
4749	No medium attached to given slot/bus.
4750	</result>
4751
4752	</desc>
4753	<param name="name" type="wstring" dir="in">
4754	<desc>Name of the storage controller the medium is attached to.</desc>
4755	</param>
4756	<param name="controllerPort" type="long" dir="in">
4757	<desc>Port to query.</desc>
4758	</param>
4759	<param name="device" type="long" dir="in">
4760	<desc>Device slot in the given port to query.</desc>
4761	</param>
4762	<param name="medium" type="IMedium" dir="return">
4763	<desc>Attached medium object.</desc>
4764	</param>
4765	</method>
4766
4767	<method name="getMediumAttachmentsOfController" const="yes">
4768	<desc>
4769	Returns an array of medium attachments which are attached to the
4770	the controller with the given name.
4771
4772	<result name="VBOX_E_OBJECT_NOT_FOUND">
4773	A storage controller with given name doesn't exist.
4774	</result>
4775	</desc>
4776	<param name="name" type="wstring" dir="in"/>
4777	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4778	</method>
4779
4780	<method name="getMediumAttachment" const="yes">
4781	<desc>
4782	Returns a medium attachment which corresponds to the controller with
4783	the given name, on the given port and device slot.
4784
4785	<result name="VBOX_E_OBJECT_NOT_FOUND">
4786	No attachment exists for the given controller/port/device combination.
4787	</result>
4788	</desc>
4789	<param name="name" type="wstring" dir="in"/>
4790	<param name="controllerPort" type="long" dir="in"/>
4791	<param name="device" type="long" dir="in"/>
4792	<param name="attachment" type="IMediumAttachment" dir="return"/>
4793	</method>
4794
4795	<method name="getNetworkAdapter" const="yes">
4796	<desc>
4797	Returns the network adapter associated with the given slot.
4798	Slots are numbered sequentially, starting with zero. The total
4799	number of adapters per machine is defined by the
4800	<link to="ISystemProperties::networkAdapterCount"/> property,
4801	so the maximum slot number is one less than that property's value.
4802
4803	<result name="E_INVALIDARG">
4804	Invalid @a slot number.
4805	</result>
4806
4807	</desc>
4808	<param name="slot" type="unsigned long" dir="in"/>
4809	<param name="adapter" type="INetworkAdapter" dir="return"/>
4810	</method>
4811
4812	<method name="addStorageController">
4813	<desc>
4814	Adds a new storage controller (SCSI or SATA controller) to the
4815	machine and returns it as an instance of
4816	<link to="IStorageController" />.
4817
4818	@a name identifies the controller for subsequent calls such as
4819	<link to="#getStorageControllerByName" />,
4820	<link to="#removeStorageController" />,
4821	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4822
4823	After the controller has been added, you can set its exact
4824	type by setting the <link to="IStorageController::controllerType" />.
4825
4826	<result name="VBOX_E_OBJECT_IN_USE">
4827	A storage controller with given name exists already.
4828	</result>
4829	<result name="E_INVALIDARG">
4830	Invalid @a controllerType.
4831	</result>
4832	</desc>
4833	<param name="name" type="wstring" dir="in"/>
4834	<param name="connectionType" type="StorageBus" dir="in"/>
4835	<param name="controller" type="IStorageController" dir="return"/>
4836	</method>
4837
4838	<method name="getStorageControllerByName" const="yes">
4839	<desc>
4840	Returns a storage controller with the given name.
4841
4842	<result name="VBOX_E_OBJECT_NOT_FOUND">
4843	A storage controller with given name doesn't exist.
4844	</result>
4845	</desc>
4846	<param name="name" type="wstring" dir="in"/>
4847	<param name="storageController" type="IStorageController" dir="return"/>
4848	</method>
4849
4850	<method name="removeStorageController">
4851	<desc>
4852	Removes a storage controller from the machine.
4853
4854	<result name="VBOX_E_OBJECT_NOT_FOUND">
4855	A storage controller with given name doesn't exist.
4856	</result>
4857	</desc>
4858	<param name="name" type="wstring" dir="in"/>
4859	</method>
4860
4861	<method name="getSerialPort" const="yes">
4862	<desc>
4863	Returns the serial port associated with the given slot.
4864	Slots are numbered sequentially, starting with zero. The total
4865	number of serial ports per machine is defined by the
4866	<link to="ISystemProperties::serialPortCount"/> property,
4867	so the maximum slot number is one less than that property's value.
4868
4869	<result name="E_INVALIDARG">
4870	Invalid @a slot number.
4871	</result>
4872
4873	</desc>
4874	<param name="slot" type="unsigned long" dir="in"/>
4875	<param name="port" type="ISerialPort" dir="return"/>
4876	</method>
4877
4878	<method name="getParallelPort" const="yes">
4879	<desc>
4880	Returns the parallel port associated with the given slot.
4881	Slots are numbered sequentially, starting with zero. The total
4882	number of parallel ports per machine is defined by the
4883	<link to="ISystemProperties::parallelPortCount"/> property,
4884	so the maximum slot number is one less than that property's value.
4885
4886	<result name="E_INVALIDARG">
4887	Invalid @a slot number.
4888	</result>
4889
4890	</desc>
4891	<param name="slot" type="unsigned long" dir="in"/>
4892	<param name="port" type="IParallelPort" dir="return"/>
4893	</method>
4894
4895	<method name="getExtraDataKeys">
4896	<desc>
4897	Returns an array representing the machine-specific extra data keys
4898	which currently have values defined.
4899	</desc>
4900	<param name="value" type="wstring" dir="return" safearray="yes">
4901	<desc>Array of extra data keys.</desc>
4902	</param>
4903	</method>
4904
4905	<method name="getExtraData">
4906	<desc>
4907	Returns associated machine-specific extra data.
4908
4909	If the requested data @a key does not exist, this function will
4910	succeed and return an empty string in the @a value argument.
4911
4912	<result name="VBOX_E_FILE_ERROR">
4913	Settings file not accessible.
4914	</result>
4915	<result name="VBOX_E_XML_ERROR">
4916	Could not parse the settings file.
4917	</result>
4918
4919	</desc>
4920	<param name="key" type="wstring" dir="in">
4921	<desc>Name of the data key to get.</desc>
4922	</param>
4923	<param name="value" type="wstring" dir="return">
4924	<desc>Value of the requested data key.</desc>
4925	</param>
4926	</method>
4927
4928	<method name="setExtraData">
4929	<desc>
4930	Sets associated machine-specific extra data.
4931
4932	If you pass @c null or an empty string as a key @a value, the given
4933	@a key will be deleted.
4934
4935	<note>
4936	Before performing the actual data change, this method will ask all
4937	registered callbacks using the
4938	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
4939	notification for a permission. If one of the callbacks refuses the
4940	new value, the change will not be performed.
4941	</note>
4942	<note>
4943	On success, the
4944	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
4945	is called to inform all registered callbacks about a successful data
4946	change.
4947	</note>
4948	<note>
4949	This method can be called outside the machine session and therefore
4950	it's a caller's responsibility to handle possible race conditions
4951	when several clients change the same key at the same time.
4952	</note>
4953
4954	<result name="VBOX_E_FILE_ERROR">
4955	Settings file not accessible.
4956	</result>
4957	<result name="VBOX_E_XML_ERROR">
4958	Could not parse the settings file.
4959	</result>
4960
4961	</desc>
4962	<param name="key" type="wstring" dir="in">
4963	<desc>Name of the data key to set.</desc>
4964	</param>
4965	<param name="value" type="wstring" dir="in">
4966	<desc>Value to assign to the key.</desc>
4967	</param>
4968	</method>
4969
4970	<method name="saveSettings">
4971	<desc>
4972	Saves any changes to machine settings made since the session
4973	has been opened or a new machine has been created, or since the
4974	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4975	For registered machines, new settings become visible to all
4976	other VirtualBox clients after successful invocation of this
4977	method.
4978	<note>
4979	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
4980	notification event after the configuration has been successfully
4981	saved (only for registered machines).
4982	</note>
4983	<note>
4984	Calling this method is only valid on instances returned
4985	by <link to="ISession::machine"/> and on new machines
4986	created by <link to="IVirtualBox::createMachine"/> but not
4987	yet registered, or on unregistered machines after calling
4988	<link to="IVirtualBox::unregisterMachine"/>.
4989	</note>
4990
4991	<result name="VBOX_E_FILE_ERROR">
4992	Settings file not accessible.
4993	</result>
4994	<result name="VBOX_E_XML_ERROR">
4995	Could not parse the settings file.
4996	</result>
4997	<result name="E_ACCESSDENIED">
4998	Modification request refused.
4999	</result>
5000
5001	</desc>
5002	</method>
5003
5004	<method name="discardSettings">
5005	<desc>
5006	Discards any changes to the machine settings made since the session
5007	has been opened or since the last call to <link to="#saveSettings"/>
5008	or <link to="#discardSettings"/>.
5009	<note>
5010	Calling this method is only valid on instances returned
5011	by <link to="ISession::machine"/> and on new machines
5012	created by <link to="IVirtualBox::createMachine"/> or
5013	opened by <link to="IVirtualBox::openMachine"/> but not
5014	yet registered, or on unregistered machines after calling
5015	<link to="IVirtualBox::unregisterMachine"/>.
5016	</note>
5017
5018	<result name="VBOX_E_INVALID_VM_STATE">
5019	Virtual machine is not mutable.
5020	</result>
5021
5022	</desc>
5023	</method>
5024
5025	<method name="deleteSettings">
5026	<desc>
5027	Deletes the settings file of this machine from disk.
5028	The machine must not be registered in order for this operation
5029	to succeed.
5030	<note>
5031	<link to="#settingsModified"/> will return @c true after this
5032	method successfully returns.
5033	</note>
5034	<note>
5035	Calling this method is only valid on instances returned
5036	by <link to="ISession::machine"/> and on new machines
5037	created by <link to="IVirtualBox::createMachine"/> or
5038	opened by <link to="IVirtualBox::openMachine"/> but not
5039	yet registered, or on unregistered machines after calling
5040	<link to="IVirtualBox::unregisterMachine"/>.
5041	</note>
5042	<note>
5043	The deleted machine settings file can be restored (saved again)
5044	by calling <link to="#saveSettings"/>.
5045	</note>
5046
5047	<result name="VBOX_E_INVALID_VM_STATE">
5048	Cannot delete settings of a registered machine or
5049	machine not mutable.
5050	</result>
5051	<result name="VBOX_E_IPRT_ERROR">
5052	Could not delete the settings file.
5053	</result>
5054
5055	</desc>
5056	</method>
5057
5058	<method name="export">
5059	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5060	steps required to export VirtualBox machines to OVF.
5061	</desc>
5062
5063	<param name="aAppliance" type="IAppliance" dir="in">
5064	<desc>Appliance to export this machine to.</desc>
5065	</param>
5066	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5067	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5068	</param>
5069	</method >
5070
5071	<method name="getSnapshot">
5072	<desc>
5073	Returns a snapshot of this machine with the given UUID.
5074	A @c null UUID can be used to obtain the first snapshot
5075	taken on this machine. This is useful if you want to traverse
5076	the whole tree of snapshots starting from the root.
5077
5078	<result name="VBOX_E_OBJECT_NOT_FOUND">
5079	Virtual machine has no snapshots or snapshot not found.
5080	</result>
5081
5082	</desc>
5083	<param name="id" type="uuid" mod="string" dir="in">
5084	<desc>UUID of the snapshot to get</desc>
5085	</param>
5086	<param name="snapshot" type="ISnapshot" dir="return">
5087	<desc>Snapshot object with the given UUID.</desc>
5088	</param>
5089	</method>
5090
5091	<method name="findSnapshot">
5092	<desc>
5093	Returns a snapshot of this machine with the given name.
5094
5095	<result name="VBOX_E_OBJECT_NOT_FOUND">
5096	Virtual machine has no snapshots or snapshot not found.
5097	</result>
5098
5099	</desc>
5100	<param name="name" type="wstring" dir="in">
5101	<desc>Name of the snapshot to find</desc>
5102	</param>
5103	<param name="snapshot" type="ISnapshot" dir="return">
5104	<desc>Snapshot object with the given name.</desc>
5105	</param>
5106	</method>
5107
5108	<method name="setCurrentSnapshot">
5109	<desc>
5110	Sets the current snapshot of this machine.
5111	<note>
5112	In the current implementation, this operation is not
5113	implemented.
5114	</note>
5115	</desc>
5116	<param name="id" type="uuid" mod="string" dir="in">
5117	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5118	</param>
5119	</method>
5120
5121	<method name="createSharedFolder">
5122	<desc>
5123	Creates a new permanent shared folder by associating the given logical
5124	name with the given host path, adds it to the collection of shared
5125	folders and starts sharing it. Refer to the description of
5126	<link to="ISharedFolder"/> to read more about logical names.
5127
5128	<result name="VBOX_E_OBJECT_IN_USE">
5129	Shared folder already exists.
5130	</result>
5131	<result name="VBOX_E_FILE_ERROR">
5132	Shared folder @a hostPath not accessible.
5133	</result>
5134
5135	</desc>
5136	<param name="name" type="wstring" dir="in">
5137	<desc>Unique logical name of the shared folder.</desc>
5138	</param>
5139	<param name="hostPath" type="wstring" dir="in">
5140	<desc>Full path to the shared folder in the host file system.</desc>
5141	</param>
5142	<param name="writable" type="boolean" dir="in">
5143	<desc>Whether the share is writable or readonly</desc>
5144	</param>
5145	</method>
5146
5147	<method name="removeSharedFolder">
5148	<desc>
5149	Removes the permanent shared folder with the given name previously
5150	created by <link to="#createSharedFolder"/> from the collection of
5151	shared folders and stops sharing it.
5152
5153	<result name="VBOX_E_INVALID_VM_STATE">
5154	Virtual machine is not mutable.
5155	</result>
5156	<result name="VBOX_E_OBJECT_NOT_FOUND">
5157	Shared folder @a name does not exist.
5158	</result>
5159
5160	</desc>
5161	<param name="name" type="wstring" dir="in">
5162	<desc>Logical name of the shared folder to remove.</desc>
5163	</param>
5164	</method>
5165
5166	<method name="canShowConsoleWindow">
5167	<desc>
5168	Returns @c true if the VM console process can activate the
5169	console window and bring it to foreground on the desktop of
5170	the host PC.
5171	<note>
5172	This method will fail if a session for this machine is not
5173	currently open.
5174	</note>
5175
5176	<result name="VBOX_E_INVALID_VM_STATE">
5177	Machine session is not open.
5178	</result>
5179
5180	</desc>
5181	<param name="canShow" type="boolean" dir="return">
5182	<desc>
5183	@c true if the console window can be shown and @c false otherwise.
5184	</desc>
5185	</param>
5186	</method>
5187
5188	<method name="showConsoleWindow">
5189	<desc>
5190	Activates the console window and brings it to foreground on
5191	the desktop of the host PC. Many modern window managers on
5192	many platforms implement some sort of focus stealing
5193	prevention logic, so that it may be impossible to activate
5194	a window without the help of the currently active
5195	application. In this case, this method will return a non-zero
5196	identifier that represents the top-level window of the VM
5197	console process. The caller, if it represents a currently
5198	active process, is responsible to use this identifier (in a
5199	platform-dependent manner) to perform actual window
5200	activation.
5201	<note>
5202	This method will fail if a session for this machine is not
5203	currently open.
5204	</note>
5205
5206	<result name="VBOX_E_INVALID_VM_STATE">
5207	Machine session is not open.
5208	</result>
5209
5210	</desc>
5211	<param name="winId" type="unsigned long long" dir="return">
5212	<desc>
5213	Platform-dependent identifier of the top-level VM console
5214	window, or zero if this method has performed all actions
5215	necessary to implement the <i>show window</i> semantics for
5216	the given platform and/or VirtualBox front-end.
5217	</desc>
5218	</param>
5219	</method>
5220
5221	<method name="getGuestProperty">
5222	<desc>
5223	Reads an entry from the machine's guest property store.
5224
5225	<result name="VBOX_E_INVALID_VM_STATE">
5226	Machine session is not open.
5227	</result>
5228
5229	</desc>
5230	<param name="name" type="wstring" dir="in">
5231	<desc>
5232	The name of the property to read.
5233	</desc>
5234	</param>
5235	<param name="value" type="wstring" dir="out">
5236	<desc>
5237	The value of the property. If the property does not exist then this
5238	will be empty.
5239	</desc>
5240	</param>
5241	<param name="timestamp" type="unsigned long long" dir="out">
5242	<desc>
5243	The time at which the property was last modified, as seen by the
5244	server process.
5245	</desc>
5246	</param>
5247	<param name="flags" type="wstring" dir="out">
5248	<desc>
5249	Additional property parameters, passed as a comma-separated list of
5250	"name=value" type entries.
5251	</desc>
5252	</param>
5253	</method>
5254
5255	<method name="getGuestPropertyValue">
5256	<desc>
5257	Reads a value from the machine's guest property store.
5258
5259	<result name="VBOX_E_INVALID_VM_STATE">
5260	Machine session is not open.
5261	</result>
5262
5263	</desc>
5264	<param name="property" type="wstring" dir="in">
5265	<desc>
5266	The name of the property to read.
5267	</desc>
5268	</param>
5269	<param name="value" type="wstring" dir="return">
5270	<desc>
5271	The value of the property. If the property does not exist then this
5272	will be empty.
5273	</desc>
5274	</param>
5275	</method>
5276
5277	<method name="getGuestPropertyTimestamp">
5278	<desc>
5279	Reads a property timestamp from the machine's guest property store.
5280
5281	<result name="VBOX_E_INVALID_VM_STATE">
5282	Machine session is not open.
5283	</result>
5284
5285	</desc>
5286	<param name="property" type="wstring" dir="in">
5287	<desc>
5288	The name of the property to read.
5289	</desc>
5290	</param>
5291	<param name="value" type="unsigned long long" dir="return">
5292	<desc>
5293	The timestamp. If the property does not exist then this will be
5294	empty.
5295	</desc>
5296	</param>
5297	</method>
5298
5299	<method name="setGuestProperty">
5300	<desc>
5301	Sets, changes or deletes an entry in the machine's guest property
5302	store.
5303
5304	<result name="E_ACCESSDENIED">
5305	Property cannot be changed.
5306	</result>
5307	<result name="E_INVALIDARG">
5308	Invalid @a flags.
5309	</result>
5310	<result name="VBOX_E_INVALID_VM_STATE">
5311	Virtual machine is not mutable or session not open.
5312	</result>
5313	<result name="VBOX_E_INVALID_OBJECT_STATE">
5314	Cannot set transient property when machine not running.
5315	</result>
5316
5317	</desc>
5318	<param name="property" type="wstring" dir="in">
5319	<desc>
5320	The name of the property to set, change or delete.
5321	</desc>
5322	</param>
5323	<param name="value" type="wstring" dir="in">
5324	<desc>
5325	The new value of the property to set, change or delete. If the
5326	property does not yet exist and value is non-empty, it will be
5327	created. If the value is @c null or empty, the property will be
5328	deleted if it exists.
5329	</desc>
5330	</param>
5331	<param name="flags" type="wstring" dir="in">
5332	<desc>
5333	Additional property parameters, passed as a comma-separated list of
5334	"name=value" type entries.
5335	</desc>
5336	</param>
5337	</method>
5338
5339	<method name="setGuestPropertyValue">
5340	<desc>
5341	Sets, changes or deletes a value in the machine's guest property
5342	store. The flags field will be left unchanged or created empty for a
5343	new property.
5344
5345	<result name="E_ACCESSDENIED">
5346	Property cannot be changed.
5347	</result>
5348	<result name="VBOX_E_INVALID_VM_STATE">
5349	Virtual machine is not mutable or session not open.
5350	</result>
5351	<result name="VBOX_E_INVALID_OBJECT_STATE">
5352	Cannot set transient property when machine not running.
5353	</result>
5354	</desc>
5355
5356	<param name="property" type="wstring" dir="in">
5357	<desc>
5358	The name of the property to set, change or delete.
5359	</desc>
5360	</param>
5361	<param name="value" type="wstring" dir="in">
5362	<desc>
5363	The new value of the property to set, change or delete. If the
5364	property does not yet exist and value is non-empty, it will be
5365	created. If the value is @c null or empty, the property will be
5366	deleted if it exists.
5367	</desc>
5368	</param>
5369	</method>
5370
5371	<method name="enumerateGuestProperties">
5372	<desc>
5373	Return a list of the guest properties matching a set of patterns along
5374	with their values, time stamps and flags.
5375	</desc>
5376	<param name="patterns" type="wstring" dir="in">
5377	<desc>
5378	The patterns to match the properties against, separated by '\|'
5379	characters. If this is empty or @c null, all properties will match.
5380	</desc>
5381	</param>
5382	<param name="name" type="wstring" dir="out" safearray="yes">
5383	<desc>
5384	The names of the properties returned.
5385	</desc>
5386	</param>
5387	<param name="value" type="wstring" dir="out" safearray="yes">
5388	<desc>
5389	The values of the properties returned. The array entries match the
5390	corresponding entries in the @a name array.
5391	</desc>
5392	</param>
5393	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5394	<desc>
5395	The time stamps of the properties returned. The array entries match
5396	the corresponding entries in the @a name array.
5397	</desc>
5398	</param>
5399	<param name="flags" type="wstring" dir="out" safearray="yes">
5400	<desc>
5401	The flags of the properties returned. The array entries match the
5402	corresponding entries in the @a name array.
5403	</desc>
5404	</param>
5405	</method>
5406	</interface>
5407
5408	<!--
5409	// IConsole
5410	/////////////////////////////////////////////////////////////////////////
5411	-->
5412
5413	<interface
5414	name="IConsoleCallback" extends="$unknown"
5415	uuid="db67f6e5-799d-474c-8452-b10d7736a412"
5416	wsmap="suppress"
5417	>
5418
5419	<desc>
5420	This interface is used by a client of the Main API that need to
5421	be notified of events. For example, a graphical user interface
5422	can use this to learn about machine state changes so they can
5423	update the list of virtual machines without having to rely
5424	on polling.
5425
5426	Whenever relevant events occur in VirtualBox, the callbacks in
5427	objects of this interface are called. In order for this to be
5428	useful, a client needs to create its own subclass that implements
5429	this interface in which the methods for the relevant callbacks
5430	are overridden. An instance of this subclass interface can then
5431	be passed to <link to="IConsole::registerCallback" />.
5432	</desc>
5433
5434	<method name="onMousePointerShapeChange">
5435	<desc>
5436	Notification when the guest mouse pointer shape has
5437	changed. The new shape data is given.
5438	</desc>
5439	<param name="visible" type="boolean" dir="in">
5440	<desc>
5441	Flag whether the pointer is visible.
5442	</desc>
5443	</param>
5444	<param name="alpha" type="boolean" dir="in">
5445	<desc>
5446	Flag whether the pointer has an alpha channel.
5447	</desc>
5448	</param>
5449	<param name="xHot" type="unsigned long" dir="in">
5450	<desc>
5451	The pointer hot spot x coordinate.
5452	</desc>
5453	</param>
5454	<param name="yHot" type="unsigned long" dir="in">
5455	<desc>
5456	The pointer hot spot y coordinate.
5457	</desc>
5458	</param>
5459	<param name="width" type="unsigned long" dir="in">
5460	<desc>
5461	Width of the pointer shape in pixels.
5462	</desc>
5463	</param>
5464	<param name="height" type="unsigned long" dir="in">
5465	<desc>
5466	Height of the pointer shape in pixels.
5467	</desc>
5468	</param>
5469	<param name="shape" type="octet" mod="ptr" dir="in">
5470	<desc>
5471	Address of the shape buffer.
5472
5473	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
5474	followed by a 32-bpp XOR (color) mask.
5475
5476	For pointers without alpha channel the XOR mask pixels are 32
5477	bit values: (lsb)BGR0(msb). For pointers with alpha channel
5478	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
5479
5480	An AND mask is used for pointers with alpha channel, so if the
5481	callback does not support alpha, the pointer could be
5482	displayed as a normal color pointer.
5483
5484	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
5485	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
5486	height</tt>. The padding bits at the end of each scanline are
5487	undefined.
5488
5489	The XOR mask follows the AND mask on the next 4-byte aligned
5490	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
5491	Bytes in the gap between the AND and the XOR mask are undefined.
5492	The XOR mask scanlines have no gap between them and the size of
5493	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
5494
5495	<note>
5496	If @a shape is 0, only the pointer visibility is changed.
5497	</note>
5498	</desc>
5499	</param>
5500	</method>
5501
5502	<method name="onMouseCapabilityChange">
5503	<desc>
5504	Notification when the mouse capabilities reported by the
5505	guest have changed. The new capabilities are passed.
5506	</desc>
5507	<param name="supportsAbsolute" type="boolean" dir="in"/>
5508	<param name="needsHostCursor" type="boolean" dir="in"/>
5509	</method>
5510
5511	<method name="onKeyboardLedsChange">
5512	<desc>
5513	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
5514	to alter the state of the keyboard LEDs.
5515	</desc>
5516	<param name="numLock" type="boolean" dir="in"/>
5517	<param name="capsLock" type="boolean" dir="in"/>
5518	<param name="scrollLock" type="boolean" dir="in"/>
5519	</method>
5520
5521	<method name="onStateChange">
5522	<desc>
5523	Notification when the execution state of the machine has changed.
5524	The new state will be given.
5525	</desc>
5526	<param name="state" type="MachineState" dir="in"/>
5527	</method>
5528
5529	<method name="onAdditionsStateChange">
5530	<desc>
5531	Notification when a Guest Additions property changes.
5532	Interested callees should query IGuest attributes to
5533	find out what has changed.
5534	</desc>
5535	</method>
5536
5537	<method name="onNetworkAdapterChange">
5538	<desc>
5539	Notification when a property of one of the
5540	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
5541	changes. Interested callees should use INetworkAdapter methods and
5542	attributes to find out what has changed.
5543	</desc>
5544	<param name="networkAdapter" type="INetworkAdapter" dir="in">
5545	<desc>Network adapter that is subject to change.</desc>
5546	</param>
5547	</method>
5548
5549	<method name="onSerialPortChange">
5550	<desc>
5551	Notification when a property of one of the
5552	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
5553	Interested callees should use ISerialPort methods and attributes
5554	to find out what has changed.
5555	</desc>
5556	<param name="serialPort" type="ISerialPort" dir="in">
5557	<desc>Serial port that is subject to change.</desc>
5558	</param>
5559	</method>
5560
5561	<method name="onParallelPortChange">
5562	<desc>
5563	Notification when a property of one of the
5564	virtual <link to="IMachine::getParallelPort">parallel ports</link>
5565	changes. Interested callees should use ISerialPort methods and
5566	attributes to find out what has changed.
5567	</desc>
5568	<param name="parallelPort" type="IParallelPort" dir="in">
5569	<desc>Parallel port that is subject to change.</desc>
5570	</param>
5571	</method>
5572
5573	<method name="onStorageControllerChange">
5574	<desc>
5575	Notification when a property of one of the
5576	virtual <link to="IMachine::storageControllers">storage controllers</link>
5577	changes. Interested callees should query the corresponding collections
5578	to find out what has changed.
5579	</desc>
5580	</method>
5581
5582	<method name="onMediumChange">
5583	<desc>
5584	Notification when a
5585	<link to="IMachine::mediumAttachments">medium attachment</link>
5586	changes.
5587	</desc>
5588	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
5589	<desc>Medium attachment that is subject to change.</desc>
5590	</param>
5591	</method>
5592
5593	<method name="onVRDPServerChange">
5594	<desc>
5595	Notification when a property of the
5596	<link to="IMachine::VRDPServer">VRDP server</link> changes.
5597	Interested callees should use IVRDPServer methods and attributes to
5598	find out what has changed.
5599	</desc>
5600	</method>
5601
5602	<method name="onUSBControllerChange">
5603	<desc>
5604	Notification when a property of the virtual
5605	<link to="IMachine::USBController">USB controller</link> changes.
5606	Interested callees should use IUSBController methods and attributes to
5607	find out what has changed.
5608	</desc>
5609	</method>
5610
5611	<method name="onUSBDeviceStateChange">
5612	<desc>
5613	Notification when a USB device is attached to or detached from
5614	the virtual USB controller.
5615
5616	This notification is sent as a result of the indirect
5617	request to attach the device because it matches one of the
5618	machine USB filters, or as a result of the direct request
5619	issued by <link to="IConsole::attachUSBDevice"/> or
5620	<link to="IConsole::detachUSBDevice"/>.
5621
5622	This notification is sent in case of both a succeeded and a
5623	failed request completion. When the request succeeds, the
5624	@a error parameter is @c null, and the given device has been
5625	already added to (when @a attached is @c true) or removed from
5626	(when @a attached is @c false) the collection represented by
5627	<link to="IConsole::USBDevices"/>. On failure, the collection
5628	doesn't change and the @a error parameter represents the error
5629	message describing the failure.
5630
5631	</desc>
5632	<param name="device" type="IUSBDevice" dir="in">
5633	<desc>Device that is subject to state change.</desc>
5634	</param>
5635	<param name="attached" type="boolean" dir="in">
5636	<desc>
5637	@c true if the device was attached and @c false otherwise.
5638	</desc>
5639	</param>
5640	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
5641	<desc>
5642	@c null on success or an error message object on failure.
5643	</desc>
5644	</param>
5645	</method>
5646
5647	<method name="onSharedFolderChange">
5648	<desc>
5649	Notification when a shared folder is added or removed.
5650	The @a scope argument defines one of three scopes:
5651	<link to="IVirtualBox::sharedFolders">global shared folders</link>
5652	(<link to="Scope_Global">Global</link>),
5653	<link to="IMachine::sharedFolders">permanent shared folders</link> of
5654	the machine (<link to="Scope_Machine">Machine</link>) or <link
5655	to="IConsole::sharedFolders">transient shared folders</link> of the
5656	machine (<link to="Scope_Session">Session</link>). Interested callees
5657	should use query the corresponding collections to find out what has
5658	changed.
5659	</desc>
5660	<param name="scope" type="Scope" dir="in">
5661	<desc>Scope of the notification.</desc>
5662	</param>
5663	</method>
5664
5665	<method name="onRuntimeError">
5666	<desc>
5667	Notification when an error happens during the virtual
5668	machine execution.
5669
5670	There are three kinds of runtime errors:
5671	<ul>
5672	<li><i>fatal</i></li>
5673	<li><i>non-fatal with retry</i></li>
5674	<li><i>non-fatal warnings</i></li>
5675	</ul>
5676
5677	<b>Fatal</b> errors are indicated by the @a fatal parameter set
5678	to @c true. In case of fatal errors, the virtual machine
5679	execution is always paused before calling this notification, and
5680	the notification handler is supposed either to immediately save
5681	the virtual machine state using <link to="IConsole::saveState"/>
5682	or power it off using <link to="IConsole::powerDown"/>.
5683	Resuming the execution can lead to unpredictable results.
5684
5685	<b>Non-fatal</b> errors and warnings are indicated by the
5686	@a fatal parameter set to @c false. If the virtual machine
5687	is in the Paused state by the time the error notification is
5688	received, it means that the user can <i>try to resume</i> the machine
5689	execution after attempting to solve the problem that caused the
5690	error. In this case, the notification handler is supposed
5691	to show an appropriate message to the user (depending on the
5692	value of the @a id parameter) that offers several actions such
5693	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
5694	wants to retry, the notification handler should continue
5695	the machine execution using the <link to="IConsole::resume"/>
5696	call. If the machine execution is not Paused during this
5697	notification, then it means this notification is a <i>warning</i>
5698	(for example, about a fatal condition that can happen very soon);
5699	no immediate action is required from the user, the machine
5700	continues its normal execution.
5701
5702	Note that in either case the notification handler
5703	<b>must not</b> perform any action directly on a thread
5704	where this notification is called. Everything it is allowed to
5705	do is to post a message to another thread that will then talk
5706	to the user and take the corresponding action.
5707
5708	Currently, the following error identifiers are known:
5709	<ul>
5710	<li><tt>"HostMemoryLow"</tt></li>
5711	<li><tt>"HostAudioNotResponding"</tt></li>
5712	<li><tt>"VDIStorageFull"</tt></li>
5713	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
5714	</ul>
5715
5716	<note>
5717	This notification is not designed to be implemented by
5718	more than one callback at a time. If you have multiple
5719	IConsoleCallback instances registered on the given
5720	IConsole object, make sure you simply do nothing but
5721	return @c S_OK from all but one of them that does actual
5722	user notification and performs necessary actions.
5723	</note>
5724
5725	</desc>
5726	<param name="fatal" type="boolean" dir="in">
5727	<desc>Whether the error is fatal or not</desc>
5728	</param>
5729	<param name="id" type="wstring" dir="in">
5730	<desc>Error identifier</desc>
5731	</param>
5732	<param name="message" type="wstring" dir="in">
5733	<desc>Optional error message</desc>
5734	</param>
5735	</method>
5736
5737	<method name="onCanShowWindow">
5738	<desc>
5739	Notification when a call to
5740	<link to="IMachine::canShowConsoleWindow"/> is made by a
5741	front-end to check if a subsequent call to
5742	<link to="IMachine::showConsoleWindow"/> can succeed.
5743
5744	The callee should give an answer appropriate to the current
5745	machine state in the @a canShow argument. This answer must
5746	remain valid at least until the next
5747	<link to="IConsole::state">machine state</link> change.
5748
5749	<note>
5750	This notification is not designed to be implemented by
5751	more than one callback at a time. If you have multiple
5752	IConsoleCallback instances registered on the given
5753	IConsole object, make sure you simply do nothing but
5754	return @c true and @c S_OK from all but one of them that
5755	actually manages console window activation.
5756	</note>
5757	</desc>
5758	<param name="canShow" type="boolean" dir="return">
5759	<desc>
5760	@c true if the console window can be shown and @c false otherwise.
5761	</desc>
5762	</param>
5763	</method>
5764
5765	<method name="onShowWindow">
5766	<desc>
5767	Notification when a call to
5768	<link to="IMachine::showConsoleWindow"/>
5769	requests the console window to be activated and brought to
5770	foreground on the desktop of the host PC.
5771
5772	This notification should cause the VM console process to
5773	perform the requested action as described above. If it is
5774	impossible to do it at a time of this notification, this
5775	method should return a failure.
5776
5777	Note that many modern window managers on many platforms
5778	implement some sort of focus stealing prevention logic, so
5779	that it may be impossible to activate a window without the
5780	help of the currently active application (which is supposedly
5781	an initiator of this notification). In this case, this method
5782	must return a non-zero identifier that represents the
5783	top-level window of the VM console process. The caller, if it
5784	represents a currently active process, is responsible to use
5785	this identifier (in a platform-dependent manner) to perform
5786	actual window activation.
5787
5788	This method must set @a winId to zero if it has performed all
5789	actions necessary to complete the request and the console
5790	window is now active and in foreground, to indicate that no
5791	further action is required on the caller's side.
5792
5793	<note>
5794	This notification is not designed to be implemented by
5795	more than one callback at a time. If you have multiple
5796	IConsoleCallback instances registered on the given
5797	IConsole object, make sure you simply do nothing but
5798	return @c S_OK from all but one of them that actually
5799	manages console window activation.
5800	</note>
5801	</desc>
5802	<param name="winId" type="unsigned long long" dir="return">
5803	<desc>
5804	Platform-dependent identifier of the top-level VM console
5805	window, or zero if this method has performed all actions
5806	necessary to implement the <i>show window</i> semantics for
5807	the given platform and/or this VirtualBox front-end.
5808	</desc>
5809	</param>
5810	</method>
5811
5812	</interface>
5813
5814	<interface
5815	name="IRemoteDisplayInfo" extends="$unknown"
5816	uuid="550104cd-2dfd-4a6c-857d-f6f8e088e62c"
5817	wsmap="struct"
5818	>
5819	<desc>
5820	Contains information about the remote display (VRDP) capabilities and status.
5821	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5822	</desc>
5823
5824	<attribute name="active" type="boolean" readonly="yes">
5825	<desc>
5826	Whether the remote display connection is active.
5827	</desc>
5828	</attribute>
5829
5830	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5831	<desc>
5832	How many times a client connected.
5833	</desc>
5834	</attribute>
5835
5836	<attribute name="beginTime" type="long long" readonly="yes">
5837	<desc>
5838	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5839	</desc>
5840	</attribute>
5841
5842	<attribute name="endTime" type="long long" readonly="yes">
5843	<desc>
5844	When the last connection was terminated or the current time, if
5845	connection is still active, in milliseconds since 1970-01-01 UTC.
5846	</desc>
5847	</attribute>
5848
5849	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
5850	<desc>
5851	How many bytes were sent in last or current, if still active, connection.
5852	</desc>
5853	</attribute>
5854
5855	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
5856	<desc>
5857	How many bytes were sent in all connections.
5858	</desc>
5859	</attribute>
5860
5861	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
5862	<desc>
5863	How many bytes were received in last or current, if still active, connection.
5864	</desc>
5865	</attribute>
5866
5867	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
5868	<desc>
5869	How many bytes were received in all connections.
5870	</desc>
5871	</attribute>
5872
5873	<attribute name="user" type="wstring" readonly="yes">
5874	<desc>
5875	Login user name supplied by the client.
5876	</desc>
5877	</attribute>
5878
5879	<attribute name="domain" type="wstring" readonly="yes">
5880	<desc>
5881	Login domain name supplied by the client.
5882	</desc>
5883	</attribute>
5884
5885	<attribute name="clientName" type="wstring" readonly="yes">
5886	<desc>
5887	The client name supplied by the client.
5888	</desc>
5889	</attribute>
5890
5891	<attribute name="clientIP" type="wstring" readonly="yes">
5892	<desc>
5893	The IP address of the client.
5894	</desc>
5895	</attribute>
5896
5897	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5898	<desc>
5899	The client software version number.
5900	</desc>
5901	</attribute>
5902
5903	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5904	<desc>
5905	Public key exchange method used when connection was established.
5906	Values: 0 - RDP4 public key exchange scheme.
5907	1 - X509 certificates were sent to client.
5908	</desc>
5909	</attribute>
5910
5911	</interface>
5912
5913	<interface
5914	name="IConsole" extends="$unknown"
5915	uuid="0a51994b-cbc6-4686-94eb-d4e4023280e2"
5916	wsmap="managed"
5917	>
5918	<desc>
5919	The IConsole interface represents an interface to control virtual
5920	machine execution.
5921
5922	The console object that implements the IConsole interface is obtained
5923	from a session object after the session for the given machine has been
5924	opened using one of <link to="IVirtualBox::openSession"/>,
5925	<link to="IVirtualBox::openRemoteSession"/> or
5926	<link to="IVirtualBox::openExistingSession"/> methods.
5927
5928	Methods of the IConsole interface allow the caller to query the current
5929	virtual machine execution state, pause the machine or power it down, save
5930	the machine state or take a snapshot, attach and detach removable media
5931	and so on.
5932
5933	<see>ISession</see>
5934	</desc>
5935
5936	<attribute name="machine" type="IMachine" readonly="yes">
5937	<desc>
5938	Machine object this console is sessioned with.
5939	<note>
5940	This is a convenience property, it has the same value as
5941	<link to="ISession::machine"/> of the corresponding session
5942	object.
5943	</note>
5944	</desc>
5945	</attribute>
5946
5947	<attribute name="state" type="MachineState" readonly="yes">
5948	<desc>
5949	Current execution state of the machine.
5950	<note>
5951	This property always returns the same value as the corresponding
5952	property of the IMachine object this console is sessioned with.
5953	For the process that owns (executes) the VM, this is the
5954	preferable way of querying the VM state, because no IPC
5955	calls are made.
5956	</note>
5957	</desc>
5958	</attribute>
5959
5960	<attribute name="guest" type="IGuest" readonly="yes">
5961	<desc>Guest object.</desc>
5962	</attribute>
5963
5964	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5965	<desc>
5966	Virtual keyboard object.
5967	<note>
5968	If the machine is not running, any attempt to use
5969	the returned object will result in an error.
5970	</note>
5971	</desc>
5972	</attribute>
5973
5974	<attribute name="mouse" type="IMouse" readonly="yes">
5975	<desc>
5976	Virtual mouse object.
5977	<note>
5978	If the machine is not running, any attempt to use
5979	the returned object will result in an error.
5980	</note>
5981	</desc>
5982	</attribute>
5983
5984	<attribute name="display" type="IDisplay" readonly="yes">
5985	<desc>Virtual display object.
5986	<note>
5987	If the machine is not running, any attempt to use
5988	the returned object will result in an error.
5989	</note>
5990	</desc>
5991	</attribute>
5992
5993	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5994	<desc>Debugging interface.</desc>
5995	</attribute>
5996
5997	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5998	<desc>
5999	Collection of USB devices currently attached to the virtual
6000	USB controller.
6001	<note>
6002	The collection is empty if the machine is not running.
6003	</note>
6004	</desc>
6005	</attribute>
6006
6007	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6008	<desc>
6009	List of USB devices currently attached to the remote VRDP client.
6010	Once a new device is physically attached to the remote host computer,
6011	it appears in this list and remains there until detached.
6012	</desc>
6013	</attribute>
6014
6015	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6016	<desc>
6017	Collection of shared folders for the current session. These folders
6018	are called transient shared folders because they are available to the
6019	guest OS running inside the associated virtual machine only for the
6020	duration of the session (as opposed to
6021	<link to="IMachine::sharedFolders"/> which represent permanent shared
6022	folders). When the session is closed (e.g. the machine is powered down),
6023	these folders are automatically discarded.
6024
6025	New shared folders are added to the collection using
6026	<link to="#createSharedFolder"/>. Existing shared folders can be
6027	removed using <link to="#removeSharedFolder"/>.
6028	</desc>
6029	</attribute>
6030
6031	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6032	<desc>
6033	Interface that provides information on Remote Display (VRDP) connection.
6034	</desc>
6035	</attribute>
6036
6037	<method name="powerUp">
6038	<desc>
6039	Starts the virtual machine execution using the current machine
6040	state (that is, its current execution state, current settings and
6041	current hard disks).
6042
6043	If the machine is powered off or aborted, the execution will
6044	start from the beginning (as if the real hardware were just
6045	powered on).
6046
6047	If the machine is in the <link to="MachineState_Saved"/> state,
6048	it will continue its execution the point where the state has
6049	been saved.
6050
6051	<note>
6052	Unless you are trying to write a new VirtualBox front-end that
6053	performs direct machine execution (like the VirtualBox or VBoxSDL
6054	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6055	session opened by <link to="IVirtualBox::openSession"/> and use this
6056	session only to change virtual machine settings. If you simply want to
6057	start virtual machine execution using one of the existing front-ends
6058	(for example the VirtualBox GUI or headless server), simply use
6059	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6060	power up the machine automatically for you.
6061	</note>
6062
6063	<see>#saveState</see>
6064	<result name="VBOX_E_INVALID_VM_STATE">
6065	Virtual machine already running.
6066	</result>
6067	<result name="VBOX_E_HOST_ERROR">
6068	Host interface does not exist or name not set.
6069	</result>
6070	<result name="VBOX_E_FILE_ERROR">
6071	Invalid saved state file.
6072	</result>
6073	</desc>
6074	<param name="progress" type="IProgress" dir="return">
6075	<desc>Progress object to track the operation completion.</desc>
6076	</param>
6077	</method>
6078
6079	<method name="powerUpPaused">
6080	<desc>
6081	Identical to powerUp except that the VM will enter the
6082	<link to="MachineState_Paused"/> state, instead of
6083	<link to="MachineState_Running"/>.
6084
6085	<see>#powerUp</see>
6086	<result name="VBOX_E_INVALID_VM_STATE">
6087	Virtual machine already running.
6088	</result>
6089	<result name="VBOX_E_HOST_ERROR">
6090	Host interface does not exist or name not set.
6091	</result>
6092	<result name="VBOX_E_FILE_ERROR">
6093	Invalid saved state file.
6094	</result>
6095	</desc>
6096	<param name="progress" type="IProgress" dir="return">
6097	<desc>Progress object to track the operation completion.</desc>
6098	</param>
6099	</method>
6100
6101	<method name="powerDown">
6102	<desc>
6103	Initiates the power down procedure to stop the virtual machine
6104	execution.
6105
6106	The completion of the power down procedure is tracked using the returned
6107	IProgress object. After the operation is complete, the machine will go
6108	to the PoweredOff state.
6109	<result name="VBOX_E_INVALID_VM_STATE">
6110	Virtual machine must be Running, Paused or Stuck to be powered down.
6111	</result>
6112	</desc>
6113	<param name="progress" type="IProgress" dir="return">
6114	<desc>Progress object to track the operation completion.</desc>
6115	</param>
6116	</method>
6117
6118	<method name="reset">
6119	<desc>Resets the virtual machine.
6120	<result name="VBOX_E_INVALID_VM_STATE">
6121	Virtual machine not in Running state.
6122	</result>
6123	<result name="VBOX_E_VM_ERROR">
6124	Virtual machine error in reset operation.
6125	</result>
6126	</desc>
6127	</method>
6128
6129	<method name="pause">
6130	<desc>Pauses the virtual machine execution.
6131	<result name="VBOX_E_INVALID_VM_STATE">
6132	Virtual machine not in Running state.
6133	</result>
6134	<result name="VBOX_E_VM_ERROR">
6135	Virtual machine error in suspend operation.
6136	</result>
6137	</desc>
6138	</method>
6139
6140	<method name="resume">
6141	<desc>Resumes the virtual machine execution.
6142	<result name="VBOX_E_INVALID_VM_STATE">
6143	Virtual machine not in Paused state.
6144	</result>
6145	<result name="VBOX_E_VM_ERROR">
6146	Virtual machine error in resume operation.
6147	</result>
6148	</desc>
6149	</method>
6150
6151	<method name="powerButton">
6152	<desc>Sends the ACPI power button event to the guest.
6153	<result name="VBOX_E_INVALID_VM_STATE">
6154	Virtual machine not in Running state.
6155	</result>
6156	<result name="VBOX_E_PDM_ERROR">
6157	Controlled power off failed.
6158	</result>
6159	</desc>
6160	</method>
6161
6162	<method name="sleepButton">
6163	<desc>Sends the ACPI sleep button event to the guest.
6164	<result name="VBOX_E_INVALID_VM_STATE">
6165	Virtual machine not in Running state.
6166	</result>
6167	<result name="VBOX_E_PDM_ERROR">
6168	Sending sleep button event failed.
6169	</result>
6170	</desc>
6171	</method>
6172
6173	<method name="getPowerButtonHandled">
6174	<desc>Checks if the last power button event was handled by guest.
6175	<result name="VBOX_E_PDM_ERROR">
6176	Checking if the event was handled by the guest OS failed.
6177	</result>
6178	</desc>
6179	<param name="handled" type="boolean" dir="return"/>
6180	</method>
6181
6182	<method name="getGuestEnteredACPIMode">
6183	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6184	G1 (sleeping). If this method returns @c false, the guest will
6185	most likely not respond to external ACPI events.
6186	<result name="VBOX_E_INVALID_VM_STATE">
6187	Virtual machine not in Running state.
6188	</result>
6189	</desc>
6190	<param name="entered" type="boolean" dir="return"/>
6191	</method>
6192
6193	<method name="saveState">
6194	<desc>
6195	Saves the current execution state of a running virtual machine
6196	and stops its execution.
6197
6198	After this operation completes, the machine will go to the
6199	Saved state. Next time it is powered up, this state will
6200	be restored and the machine will continue its execution from
6201	the place where it was saved.
6202
6203	This operation differs from taking a snapshot to the effect
6204	that it doesn't create new differencing media. Also, once
6205	the machine is powered up from the state saved using this method,
6206	the saved state is deleted, so it will be impossible to return
6207	to this state later.
6208
6209	<note>
6210	On success, this method implicitly calls
6211	<link to="IMachine::saveSettings"/> to save all current machine
6212	settings (including runtime changes to the DVD medium, etc.).
6213	Together with the impossibility to change any VM settings when it is
6214	in the Saved state, this guarantees adequate hardware
6215	configuration of the machine when it is restored from the saved
6216	state file.
6217	</note>
6218
6219	<note>
6220	The machine must be in the Running or Paused state, otherwise
6221	the operation will fail.
6222	</note>
6223	<result name="VBOX_E_INVALID_VM_STATE">
6224	Virtual machine state neither Running nor Paused.
6225	</result>
6226	<result name="VBOX_E_FILE_ERROR">
6227	Failed to create directory for saved state file.
6228	</result>
6229
6230	<see><link to="#takeSnapshot"/></see>
6231	</desc>
6232	<param name="progress" type="IProgress" dir="return">
6233	<desc>Progress object to track the operation completion.</desc>
6234	</param>
6235	</method>
6236
6237	<method name="adoptSavedState">
6238	<desc>
6239	Associates the given saved state file to the virtual machine.
6240
6241	On success, the machine will go to the Saved state. Next time it is
6242	powered up, it will be restored from the adopted saved state and
6243	continue execution from the place where the saved state file was
6244	created.
6245
6246	The specified saved state file path may be absolute or relative to the
6247	folder the VM normally saves the state to (usually,
6248	<link to="IMachine::snapshotFolder"/>).
6249
6250	<note>
6251	It's a caller's responsibility to make sure the given saved state
6252	file is compatible with the settings of this virtual machine that
6253	represent its virtual hardware (memory size, hard disk configuration
6254	etc.). If there is a mismatch, the behavior of the virtual machine
6255	is undefined.
6256	</note>
6257	<result name="VBOX_E_INVALID_VM_STATE">
6258	Virtual machine state neither PoweredOff nor Aborted.
6259	</result>
6260	</desc>
6261	<param name="savedStateFile" type="wstring" dir="in">
6262	<desc>Path to the saved state file to adopt.</desc>
6263	</param>
6264	</method>
6265
6266	<method name="forgetSavedState">
6267	<desc>
6268	Forgets the saved state of the virtual machine previously created
6269	by <link to="#saveState"/>. Next time the machine is powered up, a
6270	clean boot will occur. If @a remove is @c true the saved state file
6271	is deleted.
6272	<note>
6273	This operation is equivalent to resetting or powering off
6274	the machine without doing a proper shutdown in the guest OS.
6275	</note>
6276	<result name="VBOX_E_INVALID_VM_STATE">
6277	Virtual machine not in state Saved.
6278	</result>
6279	</desc>
6280	<param name="remove" type="boolean" dir="in">
6281	<desc>If @c true remove the saved state file.</desc>
6282	</param>
6283	</method>
6284
6285	<method name="getDeviceActivity">
6286	<desc>
6287	Gets the current activity type of a given device or device group.
6288	<result name="E_INVALIDARG">
6289	Invalid device type.
6290	</result>
6291	</desc>
6292	<param name="type" type="DeviceType" dir="in"/>
6293	<param name="activity" type="DeviceActivity" dir="return"/>
6294	</method>
6295
6296	<method name="attachUSBDevice">
6297	<desc>
6298	Attaches a host USB device with the given UUID to the
6299	USB controller of the virtual machine.
6300
6301	The device needs to be in one of the following states:
6302	<link to="USBDeviceState_Busy"/>,
6303	<link to="USBDeviceState_Available"/> or
6304	<link to="USBDeviceState_Held"/>,
6305	otherwise an error is immediately returned.
6306
6307	When the device state is
6308	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6309	be returned if the host computer refuses to release it for some reason.
6310
6311	<see>IUSBController::deviceFilters, USBDeviceState</see>
6312	<result name="VBOX_E_INVALID_VM_STATE">
6313	Virtual machine state neither Running nor Paused.
6314	</result>
6315	<result name="VBOX_E_PDM_ERROR">
6316	Virtual machine does not have a USB controller.
6317	</result>
6318	</desc>
6319	<param name="id" type="uuid" mod="string" dir="in">
6320	<desc>UUID of the host USB device to attach.</desc>
6321	</param>
6322	</method>
6323
6324	<method name="detachUSBDevice">
6325	<desc>
6326	Detaches an USB device with the given UUID from the USB controller
6327	of the virtual machine.
6328
6329	After this method succeeds, the VirtualBox server re-initiates
6330	all USB filters as if the device were just physically attached
6331	to the host, but filters of this machine are ignored to avoid
6332	a possible automatic re-attachment.
6333
6334	<see>IUSBController::deviceFilters, USBDeviceState</see>
6335
6336	<result name="VBOX_E_PDM_ERROR">
6337	Virtual machine does not have a USB controller.
6338	</result>
6339	<result name="E_INVALIDARG">
6340	USB device not attached to this virtual machine.
6341	</result>
6342	</desc>
6343	<param name="id" type="uuid" mod="string" dir="in">
6344	<desc>UUID of the USB device to detach.</desc>
6345	</param>
6346	<param name="device" type="IUSBDevice" dir="return">
6347	<desc>Detached USB device.</desc>
6348	</param>
6349	</method>
6350
6351	<method name="findUSBDeviceByAddress">
6352	<desc>
6353	Searches for a USB device with the given host address.
6354
6355	<result name="VBOX_E_OBJECT_NOT_FOUND">
6356	Given @c name does not correspond to any USB device.
6357	</result>
6358
6359	<see>IUSBDevice::address</see>
6360	</desc>
6361	<param name="name" type="wstring" dir="in">
6362	<desc>
6363	Address of the USB device (as assigned by the host) to
6364	search for.
6365	</desc>
6366	</param>
6367	<param name="device" type="IUSBDevice" dir="return">
6368	<desc>Found USB device object.</desc>
6369	</param>
6370	</method>
6371
6372	<method name="findUSBDeviceById">
6373	<desc>
6374	Searches for a USB device with the given UUID.
6375
6376	<result name="VBOX_E_OBJECT_NOT_FOUND">
6377	Given @c id does not correspond to any USB device.
6378	</result>
6379
6380	<see>IUSBDevice::id</see>
6381	</desc>
6382	<param name="id" type="uuid" mod="string" dir="in">
6383	<desc>UUID of the USB device to search for.</desc>
6384	</param>
6385	<param name="device" type="IUSBDevice" dir="return">
6386	<desc>Found USB device object.</desc>
6387	</param>
6388	</method>
6389
6390	<method name="createSharedFolder">
6391	<desc>
6392	Creates a transient new shared folder by associating the given logical
6393	name with the given host path, adds it to the collection of shared
6394	folders and starts sharing it. Refer to the description of
6395	<link to="ISharedFolder"/> to read more about logical names.
6396
6397	<result name="VBOX_E_INVALID_VM_STATE">
6398	Virtual machine in Saved state or currently changing state.
6399	</result>
6400	<result name="VBOX_E_FILE_ERROR">
6401	Shared folder already exists or not accessible.
6402	</result>
6403	</desc>
6404	<param name="name" type="wstring" dir="in">
6405	<desc>Unique logical name of the shared folder.</desc>
6406	</param>
6407	<param name="hostPath" type="wstring" dir="in">
6408	<desc>Full path to the shared folder in the host file system.</desc>
6409	</param>
6410	<param name="writable" type="boolean" dir="in">
6411	<desc>Whether the share is writable or readonly</desc>
6412	</param>
6413	</method>
6414
6415	<method name="removeSharedFolder">
6416	<desc>
6417	Removes a transient shared folder with the given name previously
6418	created by <link to="#createSharedFolder"/> from the collection of
6419	shared folders and stops sharing it.
6420	<result name="VBOX_E_INVALID_VM_STATE">
6421	Virtual machine in Saved state or currently changing state.
6422	</result>
6423	<result name="VBOX_E_FILE_ERROR">
6424	Shared folder does not exists.
6425	</result>
6426	</desc>
6427	<param name="name" type="wstring" dir="in">
6428	<desc>Logical name of the shared folder to remove.</desc>
6429	</param>
6430	</method>
6431
6432	<method name="takeSnapshot">
6433	<desc>
6434	Saves the current execution state
6435	and all settings of the machine and creates differencing images
6436	for all normal (non-independent) media.
6437	See <link to="ISnapshot" /> for an introduction to snapshots.
6438
6439	This method can be called for a PoweredOff, Saved (see
6440	<link to="#saveState"/>), Running or
6441	Paused virtual machine. When the machine is PoweredOff, an
6442	offline snapshot is created, an online snapshot otherwise.
6443
6444	The taken snapshot is always based on the
6445	<link to="IMachine::currentSnapshot">current snapshot</link>
6446	of the associated virtual machine and becomes a new current snapshot.
6447
6448	<note>
6449	This method implicitly calls <link to="IMachine::saveSettings"/> to
6450	save all current machine settings before taking an offline snapshot.
6451	</note>
6452
6453	<result name="VBOX_E_INVALID_VM_STATE">
6454	Virtual machine currently changing state.
6455	</result>
6456	</desc>
6457	<param name="name" type="wstring" dir="in">
6458	<desc>Short name for the snapshot.</desc>
6459	</param>
6460	<param name="description" type="wstring" dir="in">
6461	<desc>Optional description of the snapshot.</desc>
6462	</param>
6463	<param name="progress" type="IProgress" dir="return">
6464	<desc>Progress object to track the operation completion.</desc>
6465	</param>
6466	</method>
6467
6468	<method name="discardSnapshot">
6469	<desc>
6470	Starts discarding the specified snapshot asynchronously.
6471	See <link to="ISnapshot" /> for an introduction to snapshots.
6472
6473	The execution state
6474	and settings of the associated machine stored in the snapshot
6475	will be deleted. The contents of all differencing media of
6476	this snapshot will be merged with the contents of their
6477	dependent child media to keep the disks valid (in other
6478	words, all changes represented by media being discarded
6479	will be propagated to their child medium). After that, this
6480	snapshot's differencing medium will be deleted. The parent
6481	of this snapshot will become a new parent for all its child
6482	snapshots.
6483
6484	If the discarded snapshot is the current one, its parent
6485	snapshot will become a new current snapshot. The current machine
6486	state is not directly affected in this case, except that
6487	currently attached differencing media based on media
6488	of the discarded snapshot will be also merged as described
6489	above.
6490
6491	If the discarded snapshot is the first one (the root snapshot)
6492	and it has exactly one child snapshot, this child snapshot will
6493	become the first snapshot after discarding. If there are no
6494	children at all (i.e. the first snapshot is the only snapshot of
6495	the machine), both the current and the first snapshot of the
6496	machine will be set to @c null. In all other cases, the first
6497	snapshot cannot be discarded.
6498
6499	You cannot discard the snapshot if it
6500	stores <link to="MediumType_Normal">normal</link> (non-differencing)
6501	media that have differencing media based on them. Snapshots of
6502	such kind can be discarded only when every normal medium has either
6503	no children at all or exactly one child. In the former case, the normal
6504	medium simply becomes unused (i.e. not attached to any VM). In the
6505	latter case, it receives all the changes stored in the child medium,
6506	and then it replaces the child medium in the configuration of the
6507	corresponding snapshot or machine.
6508
6509	Also, you cannot discard the snapshot if it stores media
6510	(of any type) having differencing child media that belong
6511	to other machines. Such snapshots can be only discarded after
6512	you discard all snapshots of other machines containing "foreign"
6513	child disks, or detach these "foreign" child disks from machines
6514	they are attached to.
6515
6516	One particular example of the snapshot storing normal media
6517	is the first snapshot of a virtual machine that had normal media
6518	attached when taking the snapshot. Be careful when
6519	discarding such snapshots because this implicitly commits
6520	changes (made since the snapshot being discarded has been taken)
6521	to normal media (as described above), which may be not what
6522	you want.
6523
6524	The virtual machine is put to
6525	the <link to="MachineState_Discarding">Discarding</link> state until
6526	the discard operation is completed.
6527
6528	<note>
6529	The machine must not be running, otherwise the operation
6530	will fail.
6531	</note>
6532
6533	<note>
6534	Child media of all normal media of the discarded snapshot
6535	must be accessible (see <link to="IMedium::state"/>) for this
6536	operation to succeed. In particular, this means that all virtual
6537	machines, whose media are directly or indirectly based on the
6538	media of discarded snapshot, must be powered off.
6539	</note>
6540	<note>
6541	Merging medium contents can be very time and disk space
6542	consuming, if these disks are big in size and have many
6543	children. However, if the snapshot being discarded is the last
6544	(head) snapshot on the branch, the operation will be rather
6545	quick.
6546	</note>
6547	<note>
6548	Note that discarding the current snapshot
6549	will implicitly call <link to="IMachine::saveSettings"/> to
6550	make all current machine settings permanent.
6551	</note>
6552	<result name="VBOX_E_INVALID_VM_STATE">
6553	Virtual machine is running.
6554	</result>
6555	</desc>
6556	<param name="id" type="uuid" mod="string" dir="in">
6557	<desc>UUID of the snapshot to discard.</desc>
6558	</param>
6559	<param name="progress" type="IProgress" dir="return">
6560	<desc>Progress object to track the operation completion.</desc>
6561	</param>
6562	</method>
6563
6564	<method name="discardCurrentState">
6565	<desc>
6566	Starts resetting the machine's current state to the state contained
6567	in the current snapshot, asynchronously. All current settings of the
6568	machine will be reset and changes stored in differencing media
6569	will be lost.
6570	See <link to="ISnapshot" /> for an introduction to snapshots.
6571
6572	After this operation is successfully completed, new empty differencing
6573	media are created for all normal media of the machine.
6574
6575	If the current snapshot of the machine is an online snapshot, the
6576	machine will go to the <link to="MachineState_Saved"> saved
6577	state</link>, so that the next time it is powered on, the execution
6578	state will be restored from the current snapshot.
6579
6580	<note>
6581	The machine must not be running, otherwise the operation will fail.
6582	</note>
6583
6584	<note>
6585	If the machine state is <link to="MachineState_Saved">Saved</link>
6586	prior to this operation, the saved state file will be implicitly
6587	discarded (as if <link to="IConsole::forgetSavedState"/> were
6588	called).
6589	</note>
6590
6591	<result name="VBOX_E_INVALID_VM_STATE">
6592	Virtual machine is running.
6593	</result>
6594	</desc>
6595	<param name="progress" type="IProgress" dir="return">
6596	<desc>Progress object to track the operation completion.</desc>
6597	</param>
6598	</method>
6599
6600	<method name="discardCurrentSnapshotAndState">
6601	<desc>
6602
6603	This method is equivalent to
6604	doing <link to="IConsole::discardSnapshot">discardSnapshot</link>
6605	(currentSnapshot.id(), progress) followed by
6606	<link to="IConsole::discardCurrentState"/>.
6607
6608	As a result, the machine will be fully restored from the
6609	snapshot preceding the current snapshot, while both the current
6610	snapshot and the current machine state will be discarded.
6611
6612	If the current snapshot is the first snapshot of the machine (i.e. it
6613	has the only snapshot), the current machine state will be
6614	discarded <b>before</b> discarding the snapshot. In other words, the
6615	machine will be restored from its last snapshot, before discarding
6616	it. This differs from performing a single
6617	<link to="IConsole::discardSnapshot"/> call (note that no
6618	<link to="IConsole::discardCurrentState"/> will be possible after it)
6619	to the effect that the latter will preserve the current state instead of
6620	discarding it.
6621
6622	Unless explicitly mentioned otherwise, all remarks and
6623	limitations of the above two methods also apply to this method.
6624
6625	<note>
6626	The machine must not be running, otherwise the operation
6627	will fail.
6628	</note>
6629
6630	<note>
6631	If the machine state is <link to="MachineState_Saved">Saved</link>
6632	prior to this operation, the saved state file will be implicitly
6633	discarded (as if <link to="#forgetSavedState"/> were
6634	called).
6635	</note>
6636
6637	<note>
6638	This method is more efficient than calling both of the above
6639	methods separately: it requires less IPC calls and provides
6640	a single progress object.
6641	</note>
6642
6643	<result name="VBOX_E_INVALID_VM_STATE">
6644	Virtual machine is running.
6645	</result>
6646	</desc>
6647	<param name="progress" type="IProgress" dir="return">
6648	<desc>Progress object to track the operation completion.</desc>
6649	</param>
6650	</method>
6651
6652	<method name="registerCallback">
6653	<desc>
6654	Registers a new console callback on this instance. The methods of the
6655	callback interface will be called by this instance when the appropriate
6656	event occurs.
6657	</desc>
6658	<param name="callback" type="IConsoleCallback" dir="in"/>
6659	</method>
6660
6661	<method name="unregisterCallback">
6662	<desc>
6663	Unregisters the console callback previously registered using
6664	<link to="#registerCallback"/>.
6665	<result name="E_INVALIDARG">
6666	Given @a callback handler is not registered.
6667	</result>
6668	</desc>
6669	<param name="callback" type="IConsoleCallback" dir="in"/>
6670	</method>
6671	</interface>
6672
6673	<!--
6674	// IHost
6675	/////////////////////////////////////////////////////////////////////////
6676	-->
6677
6678	<enum
6679	name="HostNetworkInterfaceMediumType"
6680	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6681	>
6682	<desc>
6683	Type of encapsulation. Ethernet encapsulation includes both wired and
6684	wireless Ethernet connections.
6685	<see>IHostNetworkInterface</see>
6686	</desc>
6687
6688	<const name="Unknown" value="0">
6689	<desc>
6690	The type of interface cannot be determined.
6691	</desc>
6692	</const>
6693	<const name="Ethernet" value="1">
6694	<desc>
6695	Ethernet frame encapsulation.
6696	</desc>
6697	</const>
6698	<const name="PPP" value="2">
6699	<desc>
6700	Point-to-point protocol encapsulation.
6701	</desc>
6702	</const>
6703	<const name="SLIP" value="3">
6704	<desc>
6705	Serial line IP encapsulation.
6706	</desc>
6707	</const>
6708	</enum>
6709
6710	<enum
6711	name="HostNetworkInterfaceStatus"
6712	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6713	>
6714	<desc>
6715	Current status of the interface.
6716	<see>IHostNetworkInterface</see>
6717	</desc>
6718
6719	<const name="Unknown" value="0">
6720	<desc>
6721	The state of interface cannot be determined.
6722	</desc>
6723	</const>
6724	<const name="Up" value="1">
6725	<desc>
6726	The interface is fully operational.
6727	</desc>
6728	</const>
6729	<const name="Down" value="2">
6730	<desc>
6731	The interface is not functioning.
6732	</desc>
6733	</const>
6734	</enum>
6735
6736	<enum
6737	name="HostNetworkInterfaceType"
6738	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6739	>
6740	<desc>
6741	Network interface type.
6742	</desc>
6743	<const name="Bridged" value="1"/>
6744	<const name="HostOnly" value="2"/>
6745	</enum>
6746
6747	<interface
6748	name="IHostNetworkInterface" extends="$unknown"
6749	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6750	wsmap="managed"
6751	>
6752	<desc>
6753	Represents one of host's network interfaces. IP V6 address and network
6754	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6755	separated by colons.
6756	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6757	</desc>
6758	<attribute name="name" type="wstring" readonly="yes">
6759	<desc>Returns the host network interface name.</desc>
6760	</attribute>
6761
6762	<attribute name="id" type="uuid" mod="string" readonly="yes">
6763	<desc>Returns the interface UUID.</desc>
6764	</attribute>
6765
6766	<attribute name="networkName" type="wstring" readonly="yes">
6767	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6768	</attribute>
6769
6770	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6771	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6772	</attribute>
6773
6774	<attribute name="IPAddress" type="wstring" readonly="yes">
6775	<desc>Returns the IP V4 address of the interface.</desc>
6776	</attribute>
6777
6778	<attribute name="networkMask" type="wstring" readonly="yes">
6779	<desc>Returns the network mask of the interface.</desc>
6780	</attribute>
6781
6782	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6783	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6784	</attribute>
6785
6786	<attribute name="IPV6Address" type="wstring" readonly="yes">
6787	<desc>Returns the IP V6 address of the interface.</desc>
6788	</attribute>
6789
6790	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6791	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6792	</attribute>
6793
6794	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6795	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6796	</attribute>
6797
6798	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6799	<desc>Type of protocol encapsulation used.</desc>
6800	</attribute>
6801
6802	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6803	<desc>Status of the interface.</desc>
6804	</attribute>
6805
6806	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6807	<desc>specifies the host interface type.</desc>
6808	</attribute>
6809
6810	<method name="enableStaticIpConfig">
6811	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6812	<param name="IPAddress" type="wstring" dir="in">
6813	<desc>
6814	IP address.
6815	</desc>
6816	</param>
6817	<param name="networkMask" type="wstring" dir="in">
6818	<desc>
6819	network mask.
6820	</desc>
6821	</param>
6822	</method>
6823
6824	<method name="enableStaticIpConfigV6">
6825	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6826	<param name="IPV6Address" type="wstring" dir="in">
6827	<desc>
6828	IP address.
6829	</desc>
6830	</param>
6831	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6832	<desc>
6833	network mask.
6834	</desc>
6835	</param>
6836	</method>
6837
6838	<method name="enableDynamicIpConfig">
6839	<desc>enables the dynamic IP configuration.</desc>
6840	</method>
6841
6842	<method name="dhcpRediscover">
6843	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6844	</method>
6845
6846	</interface>
6847
6848	<interface
6849	name="IHost" extends="$unknown"
6850	uuid="95522f11-1ecc-443b-9242-3af6b24d430c"
6851	wsmap="managed"
6852	>
6853	<desc>
6854	The IHost interface represents the physical machine that this VirtualBox
6855	installation runs on.
6856
6857	An object implementing this interface is returned by the
6858	<link to="IVirtualBox::host" /> attribute. This interface contains
6859	read-only information about the host's physical hardware (such as what
6860	processors and disks are available, what the host operating system is,
6861	and so on) and also allows for manipulating some of the host's hardware,
6862	such as global USB device filters and host interface networking.
6863
6864	</desc>
6865	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6866	<desc>List of DVD drives available on the host.</desc>
6867	</attribute>
6868
6869	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6870	<desc>List of floppy drives available on the host.</desc>
6871	</attribute>
6872
6873	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6874	<desc>
6875	List of USB devices currently attached to the host.
6876	Once a new device is physically attached to the host computer,
6877	it appears in this list and remains there until detached.
6878
6879	<note>
6880	If USB functionality is not available in the given edition of
6881	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6882	</note>
6883	</desc>
6884	</attribute>
6885
6886	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6887	<desc>
6888	List of USB device filters in action.
6889	When a new device is physically attached to the host computer,
6890	filters from this list are applied to it (in order they are stored
6891	in the list). The first matched filter will determine the
6892	<link to="IHostUSBDeviceFilter::action">action</link>
6893	performed on the device.
6894
6895	Unless the device is ignored by these filters, filters of all
6896	currently running virtual machines
6897	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6898
6899	<note>
6900	If USB functionality is not available in the given edition of
6901	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6902	</note>
6903
6904	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6905	</desc>
6906	</attribute>
6907
6908	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6909	<desc>List of host network interfaces currently defined on the host.</desc>
6910	</attribute>
6911
6912	<attribute name="processorCount" type="unsigned long" readonly="yes">
6913	<desc>Number of (logical) CPUs installed in the host system.</desc>
6914	</attribute>
6915
6916	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6917	<desc>Number of (logical) CPUs online in the host system.</desc>
6918	</attribute>
6919
6920	<method name="getProcessorSpeed">
6921	<desc>Query the (approximate) maximum speed of a specified host CPU in
6922	Megahertz.
6923	</desc>
6924	<param name="cpuId" type="unsigned long" dir="in">
6925	<desc>
6926	Identifier of the CPU.
6927	</desc>
6928	</param>
6929	<param name="speed" type="unsigned long" dir="return">
6930	<desc>
6931	Speed value. 0 is returned if value is not known or @a cpuId is
6932	invalid.
6933	</desc>
6934	</param>
6935	</method>
6936
6937	<method name="getProcessorFeature">
6938	<desc>Query whether a CPU feature is supported or not.</desc>
6939	<param name="feature" type="ProcessorFeature" dir="in">
6940	<desc>
6941	CPU Feature identifier.
6942	</desc>
6943	</param>
6944	<param name="supported" type="boolean" dir="return">
6945	<desc>
6946	Feature is supported or not.
6947	</desc>
6948	</param>
6949	</method>
6950
6951	<method name="getProcessorDescription">
6952	<desc>Query the model string of a specified host CPU.
6953	</desc>
6954	<param name="cpuId" type="unsigned long" dir="in">
6955	<desc>
6956	Identifier of the CPU.
6957	</desc>
6958	</param>
6959	<param name="description" type="wstring" dir="return">
6960	<desc>
6961	Model string. An empty string is returned if value is not known or
6962	@a cpuId is invalid.
6963	</desc>
6964	</param>
6965	</method>
6966
6967	<attribute name="memorySize" type="unsigned long" readonly="yes">
6968	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6969	</attribute>
6970
6971	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6972	<desc>Available system memory in the host system.</desc>
6973	</attribute>
6974
6975	<attribute name="operatingSystem" type="wstring" readonly="yes">
6976	<desc>Name of the host system's operating system.</desc>
6977	</attribute>
6978
6979	<attribute name="OSVersion" type="wstring" readonly="yes">
6980	<desc>Host operating system's version string.</desc>
6981	</attribute>
6982
6983	<attribute name="UTCTime" type="long long" readonly="yes">
6984	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6985	</attribute>
6986
6987	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6988	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6989	</attribute>
6990
6991	<method name="createHostOnlyNetworkInterface">
6992	<desc>
6993	Creates a new adapter for Host Only Networking.
6994	<result name="E_INVALIDARG">
6995	Host network interface @a name already exists.
6996	</result>
6997	</desc>
6998	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6999	<desc>
7000	Created host interface object.
7001	</desc>
7002	</param>
7003	<param name="progress" type="IProgress" dir="return">
7004	<desc>
7005	Progress object to track the operation completion.
7006	</desc>
7007	</param>
7008	</method>
7009
7010	<method name="removeHostOnlyNetworkInterface">
7011	<desc>
7012	Removes the given Host Only Networking interface.
7013	<result name="VBOX_E_OBJECT_NOT_FOUND">
7014	No host network interface matching @a id found.
7015	</result>
7016	</desc>
7017	<param name="id" type="uuid" mod="string" dir="in">
7018	<desc>
7019	Adapter GUID.
7020	</desc>
7021	</param>
7022	<param name="progress" type="IProgress" dir="return">
7023	<desc>
7024	Progress object to track the operation completion.
7025	</desc>
7026	</param>
7027	</method>
7028
7029	<method name="createUSBDeviceFilter">
7030	<desc>
7031	Creates a new USB device filter. All attributes except
7032	the filter name are set to empty (any match),
7033	<i>active</i> is @c false (the filter is not active).
7034
7035	The created filter can be added to the list of filters using
7036	<link to="#insertUSBDeviceFilter"/>.
7037
7038	<see>#USBDeviceFilters</see>
7039	</desc>
7040	<param name="name" type="wstring" dir="in">
7041	<desc>
7042	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7043	for more info.
7044	</desc>
7045	</param>
7046	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7047	<desc>Created filter object.</desc>
7048	</param>
7049	</method>
7050
7051	<method name="insertUSBDeviceFilter">
7052	<desc>
7053	Inserts the given USB device to the specified position
7054	in the list of filters.
7055
7056	Positions are numbered starting from @c 0. If the specified
7057	position is equal to or greater than the number of elements in
7058	the list, the filter is added at the end of the collection.
7059
7060	<note>
7061	Duplicates are not allowed, so an attempt to insert a
7062	filter already in the list is an error.
7063	</note>
7064	<note>
7065	If USB functionality is not available in the given edition of
7066	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7067	</note>
7068
7069	<see>#USBDeviceFilters</see>
7070
7071	<result name="VBOX_E_INVALID_OBJECT_STATE">
7072	USB device filter is not created within this VirtualBox instance.
7073	</result>
7074	<result name="E_INVALIDARG">
7075	USB device filter already in list.
7076	</result>
7077
7078	</desc>
7079	<param name="position" type="unsigned long" dir="in">
7080	<desc>Position to insert the filter to.</desc>
7081	</param>
7082	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7083	<desc>USB device filter to insert.</desc>
7084	</param>
7085	</method>
7086
7087	<method name="removeUSBDeviceFilter">
7088	<desc>
7089	Removes a USB device filter from the specified position in the
7090	list of filters.
7091
7092	Positions are numbered starting from @c 0. Specifying a
7093	position equal to or greater than the number of elements in
7094	the list will produce an error.
7095
7096	<note>
7097	If USB functionality is not available in the given edition of
7098	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7099	</note>
7100
7101	<see>#USBDeviceFilters</see>
7102
7103	<result name="E_INVALIDARG">
7104	USB device filter list empty or invalid @a position.
7105	</result>
7106
7107	</desc>
7108	<param name="position" type="unsigned long" dir="in">
7109	<desc>Position to remove the filter from.</desc>
7110	</param>
7111	</method>
7112
7113	<method name="findHostDVDDrive">
7114	<desc>
7115	Searches for a host DVD drive with the given @c name.
7116
7117	<result name="VBOX_E_OBJECT_NOT_FOUND">
7118	Given @c name does not correspond to any host drive.
7119	</result>
7120
7121	</desc>
7122	<param name="name" type="wstring" dir="in">
7123	<desc>Name of the host drive to search for</desc>
7124	</param>
7125	<param name="drive" type="IMedium" dir="return">
7126	<desc>Found host drive object</desc>
7127	</param>
7128	</method>
7129
7130	<method name="findHostFloppyDrive">
7131	<desc>
7132	Searches for a host floppy drive with the given @c name.
7133
7134	<result name="VBOX_E_OBJECT_NOT_FOUND">
7135	Given @c name does not correspond to any host floppy drive.
7136	</result>
7137
7138	</desc>
7139	<param name="name" type="wstring" dir="in">
7140	<desc>Name of the host floppy drive to search for</desc>
7141	</param>
7142	<param name="drive" type="IMedium" dir="return">
7143	<desc>Found host floppy drive object</desc>
7144	</param>
7145	</method>
7146
7147	<method name="findHostNetworkInterfaceByName">
7148	<desc>
7149	Searches through all host network interfaces for an interface with
7150	the given @c name.
7151	<note>
7152	The method returns an error if the given @c name does not
7153	correspond to any host network interface.
7154	</note>
7155	</desc>
7156	<param name="name" type="wstring" dir="in">
7157	<desc>Name of the host network interface to search for.</desc>
7158	</param>
7159	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7160	<desc>Found host network interface object.</desc>
7161	</param>
7162	</method>
7163	<method name="findHostNetworkInterfaceById">
7164	<desc>
7165	Searches through all host network interfaces for an interface with
7166	the given GUID.
7167	<note>
7168	The method returns an error if the given GUID does not
7169	correspond to any host network interface.
7170	</note>
7171	</desc>
7172	<param name="id" type="uuid" mod="string" dir="in">
7173	<desc>GUID of the host network interface to search for.</desc>
7174	</param>
7175	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7176	<desc>Found host network interface object.</desc>
7177	</param>
7178	</method>
7179	<method name="findHostNetworkInterfacesOfType">
7180	<desc>
7181	Searches through all host network interfaces and returns a list of interfaces of the specified type
7182	</desc>
7183	<param name="type" type="HostNetworkInterfaceType" dir="in">
7184	<desc>type of the host network interfaces to search for.</desc>
7185	</param>
7186	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7187	<desc>Found host network interface objects.</desc>
7188	</param>
7189	</method>
7190
7191	<method name="findUSBDeviceById">
7192	<desc>
7193	Searches for a USB device with the given UUID.
7194
7195	<result name="VBOX_E_OBJECT_NOT_FOUND">
7196	Given @c id does not correspond to any USB device.
7197	</result>
7198
7199	<see>IHostUSBDevice::id</see>
7200	</desc>
7201	<param name="id" type="uuid" mod="string" dir="in">
7202	<desc>UUID of the USB device to search for.</desc>
7203	</param>
7204	<param name="device" type="IHostUSBDevice" dir="return">
7205	<desc>Found USB device object.</desc>
7206	</param>
7207	</method>
7208
7209	<method name="findUSBDeviceByAddress">
7210	<desc>
7211	Searches for a USB device with the given host address.
7212
7213	<result name="VBOX_E_OBJECT_NOT_FOUND">
7214	Given @c name does not correspond to any USB device.
7215	</result>
7216
7217	<see>IHostUSBDevice::address</see>
7218	</desc>
7219	<param name="name" type="wstring" dir="in">
7220	<desc>
7221	Address of the USB device (as assigned by the host) to
7222	search for.
7223	</desc>
7224	</param>
7225	<param name="device" type="IHostUSBDevice" dir="return">
7226	<desc>Found USB device object.</desc>
7227	</param>
7228	</method>
7229
7230	</interface>
7231
7232	<!--
7233	// ISystemProperties
7234	/////////////////////////////////////////////////////////////////////////
7235	-->
7236
7237	<interface
7238	name="ISystemProperties"
7239	extends="$unknown"
7240	uuid="79a8bc4d-24a5-4258-a0a6-8c36f8a68a4b"
7241	wsmap="managed"
7242	>
7243	<desc>
7244	The ISystemProperties interface represents global properties of the given
7245	VirtualBox installation.
7246
7247	These properties define limits and default values for various attributes
7248	and parameters. Most of the properties are read-only, but some can be
7249	changed by a user.
7250	</desc>
7251
7252	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7253	<desc>Minimum guest system memory in Megabytes.</desc>
7254	</attribute>
7255
7256	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7257	<desc>Maximum guest system memory in Megabytes.</desc>
7258	</attribute>
7259
7260	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7261	<desc>Minimum guest video memory in Megabytes.</desc>
7262	</attribute>
7263
7264	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7265	<desc>Maximum guest video memory in Megabytes.</desc>
7266	</attribute>
7267
7268	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7269	<desc>Minimum CPU count.</desc>
7270	</attribute>
7271
7272	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7273	<desc>Maximum CPU count.</desc>
7274	</attribute>
7275
7276	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7277	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7278	</attribute>
7279
7280	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7281	<desc>
7282	Number of network adapters associated with every
7283	<link to="IMachine"/> instance.
7284	</desc>
7285	</attribute>
7286
7287	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7288	<desc>
7289	Number of serial ports associated with every
7290	<link to="IMachine"/> instance.
7291	</desc>
7292	</attribute>
7293
7294	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7295	<desc>
7296	Number of parallel ports associated with every
7297	<link to="IMachine"/> instance.
7298	</desc>
7299	</attribute>
7300
7301	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7302	<desc>
7303	Maximum device position in the boot order. This value corresponds
7304	to the total number of devices a machine can boot from, to make it
7305	possible to include all possible devices to the boot list.
7306	<see><link to="IMachine::setBootOrder"/></see>
7307	</desc>
7308	</attribute>
7309
7310	<attribute name="defaultMachineFolder" type="wstring">
7311	<desc>
7312	Full path to the default directory used to create new or open
7313	existing machines when a settings file name contains no
7314	path.
7315
7316	The initial value of this property is
7317	<tt><</tt><link to="IVirtualBox::homeFolder">
7318	VirtualBox_home</link><tt>>/Machines</tt>.
7319
7320	<note>
7321	Setting this property to @c null or an empty string will restore the
7322	initial value.
7323	</note>
7324	<note>
7325	When settings this property, the specified path can be
7326	absolute (full path) or relative
7327	to the <link to="IVirtualBox::homeFolder">
7328	VirtualBox home directory</link>.
7329	When reading this property, a full path is
7330	always returned.
7331	</note>
7332	<note>
7333	The specified path may not exist, it will be created
7334	when necessary.
7335	</note>
7336
7337	<see>
7338	<link to="IVirtualBox::createMachine"/>,
7339	<link to="IVirtualBox::openMachine"/>
7340	</see>
7341	</desc>
7342	</attribute>
7343
7344	<attribute name="defaultHardDiskFolder" type="wstring">
7345	<desc>
7346	Full path to the default directory used to create new or open existing
7347	virtual disks.
7348
7349	This path is used when the storage unit of a hard disk is a regular file
7350	in the host's file system and only a file name that contains no path is
7351	given.
7352
7353	The initial value of this property is
7354	<tt><</tt>
7355	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7356	<tt>>/HardDisks</tt>.
7357
7358	<note>
7359	Setting this property to @c null or empty string will restore the
7360	initial value.
7361	</note>
7362	<note>
7363	When settings this property, the specified path can be relative
7364	to the
7365	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7366	absolute. When reading this property, a full path is
7367	always returned.
7368	</note>
7369	<note>
7370	The specified path may not exist, it will be created
7371	when necessary.
7372	</note>
7373
7374	<see>
7375	IMedium,
7376	<link to="IVirtualBox::createHardDisk"/>,
7377	<link to="IVirtualBox::openHardDisk"/>,
7378	<link to="IMedium::location"/>
7379	</see>
7380	</desc>
7381	</attribute>
7382
7383	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7384	<desc>
7385	List of all medium storage formats supported by this VirtualBox
7386	installation.
7387
7388	Keep in mind that the medium format identifier
7389	(<link to="IMediumFormat::id"/>) used in other API calls like
7390	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7391	medium format is a case-insensitive string. This means that, for
7392	example, all of the following strings:
7393	<pre>
7394	"VDI"
7395	"vdi"
7396	"VdI"</pre>
7397	refer to the same medium format.
7398
7399	Note that the virtual medium framework is backend-based, therefore
7400	the list of supported formats depends on what backends are currently
7401	installed.
7402
7403	<see>
7404	<link to="IMediumFormat"/>,
7405	</see>
7406	</desc>
7407	</attribute>
7408
7409	<attribute name="defaultHardDiskFormat" type="wstring">
7410	<desc>
7411	Identifier of the default medium format used by VirtualBox.
7412
7413	The medium format set by this attribute is used by VirtualBox
7414	when the medium format was not specified explicitly. One example is
7415	<link to="IVirtualBox::createHardDisk"/> with the empty
7416	format argument. A more complex example is implicit creation of
7417	differencing media when taking a snapshot of a virtual machine:
7418	this operation will try to use a format of the parent medium first
7419	and if this format does not support differencing media the default
7420	format specified by this argument will be used.
7421
7422	The list of supported medium formats may be obtained by the
7423	<link to="#mediaFormats"/> call. Note that the default medium
7424	format must have a capability to create differencing media;
7425	otherwise operations that create media implicitly may fail
7426	unexpectedly.
7427
7428	The initial value of this property is <tt>"VDI"</tt> in the current
7429	version of the VirtualBox product, but may change in the future.
7430
7431	<note>
7432	Setting this property to @c null or empty string will restore the
7433	initial value.
7434	</note>
7435
7436	<see>
7437	<link to="#mediaFormats"/>,
7438	<link to="IMediumFormat::id"/>,
7439	<link to="IVirtualBox::createHardDisk"/>
7440	</see>
7441	</desc>
7442	</attribute>
7443
7444	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7445	<desc>
7446	Library that provides authentication for VRDP clients. The library
7447	is used if a virtual machine's authentication type is set to "external"
7448	in the VM RemoteDisplay configuration.
7449
7450	The system library extension (".DLL" or ".so") must be omitted.
7451	A full path can be specified; if not, then the library must reside on the
7452	system's default library path.
7453
7454	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7455	of that name in one of the default VirtualBox library directories.
7456
7457	For details about VirtualBox authentication libraries and how to implement
7458	them, please refer to the VirtualBox manual.
7459
7460	<note>
7461	Setting this property to @c null or empty string will restore the
7462	initial value.
7463	</note>
7464	</desc>
7465	</attribute>
7466
7467	<attribute name="webServiceAuthLibrary" type="wstring">
7468	<desc>
7469	Library that provides authentication for webservice clients. The library
7470	is used if a virtual machine's authentication type is set to "external"
7471	in the VM RemoteDisplay configuration and will be called from
7472	within the <link to="IWebsessionManager::logon" /> implementation.
7473
7474	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7475	there is no per-VM setting for this, as the webservice is a global
7476	resource (if it is running). Only for this setting (for the webservice),
7477	setting this value to a literal <tt>"null"</tt> string disables authentication,
7478	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7479	no matter what user name and password are supplied.
7480
7481	The initial value of this property is <tt>"VRDPAuth"</tt>,
7482	meaning that the webservice will use the same authentication
7483	library that is used by default for VBoxVRDP (again, see
7484	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7485	The format and calling convention of authentication libraries
7486	is the same for the webservice as it is for VBoxVRDP.
7487
7488	<note>
7489	Setting this property to @c null or empty string will restore the
7490	initial value.
7491	</note>
7492	</desc>
7493	</attribute>
7494
7495	<attribute name="LogHistoryCount" type="unsigned long">
7496	<desc>
7497	This value specifies how many old release log files are kept.
7498	</desc>
7499	</attribute>
7500
7501	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7502	<desc>This value hold the default audio driver for the current
7503	system.</desc>
7504	</attribute>
7505
7506	<method name="getMaxDevicesPerPortForStorageBus">
7507	<desc>Returns the maximum number of devices which can be attached to a port
7508	for the given storage bus.</desc>
7509
7510	<param name="bus" type="StorageBus" dir="in">
7511	<desc>The storage bus type to get the value for.</desc>
7512	</param>
7513
7514	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7515	<desc>The maximum number of devices which can eb attached to the port for the given
7516	storage bus.</desc>
7517	</param>
7518	</method>
7519
7520	<method name="getMinPortCountForStorageBus">
7521	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7522
7523	<param name="bus" type="StorageBus" dir="in">
7524	<desc>The storage bus type to get the value for.</desc>
7525	</param>
7526
7527	<param name="minPortCount" type="unsigned long" dir="return">
7528	<desc>The minimum number of ports for the given storage bus.</desc>
7529	</param>
7530	</method>
7531
7532	<method name="getMaxPortCountForStorageBus">
7533	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7534
7535	<param name="bus" type="StorageBus" dir="in">
7536	<desc>The storage bus type to get the value for.</desc>
7537	</param>
7538
7539	<param name="maxPortCount" type="unsigned long" dir="return">
7540	<desc>The maximum number of ports for the given storage bus.</desc>
7541	</param>
7542	</method>
7543	</interface>
7544
7545	<!--
7546	// IGuest
7547	/////////////////////////////////////////////////////////////////////////
7548	-->
7549
7550	<interface
7551	name="IGuestOSType" extends="$unknown"
7552	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
7553	wsmap="struct"
7554	>
7555	<desc>
7556	</desc>
7557
7558	<attribute name="familyId" type="wstring" readonly="yes">
7559	<desc>Guest OS family identifier string.</desc>
7560	</attribute>
7561
7562	<attribute name="familyDescription" type="wstring" readonly="yes">
7563	<desc>Human readable description of the guest OS family.</desc>
7564	</attribute>
7565
7566	<attribute name="id" type="wstring" readonly="yes">
7567	<desc>Guest OS identifier string.</desc>
7568	</attribute>
7569
7570	<attribute name="description" type="wstring" readonly="yes">
7571	<desc>Human readable description of the guest OS.</desc>
7572	</attribute>
7573
7574	<attribute name="is64Bit" type="boolean" readonly="yes">
7575	<desc>Returns @c true if the given OS is 64-bit</desc>
7576	</attribute>
7577
7578	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7579	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7580	</attribute>
7581
7582	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7583	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7584	</attribute>
7585
7586	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7587	<desc>Recommended RAM size in Megabytes.</desc>
7588	</attribute>
7589
7590	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7591	<desc>Recommended video RAM size in Megabytes.</desc>
7592	</attribute>
7593
7594	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7595	<desc>Recommended hard disk size in Megabytes.</desc>
7596	</attribute>
7597
7598	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7599	<desc>Returns recommended network adapter for this OS type.</desc>
7600	</attribute>
7601	</interface>
7602
7603	<interface
7604	name="IGuest" extends="$unknown"
7605	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
7606	wsmap="managed"
7607	>
7608	<desc>
7609	The IGuest interface represents information about the operating system
7610	running inside the virtual machine. Used in
7611	<link to="IConsole::guest"/>.
7612
7613	IGuest provides information about the guest operating system, whether
7614	Guest Additions are installed and other OS-specific virtual machine
7615	properties.
7616	</desc>
7617
7618	<attribute name="OSTypeId" type="wstring" readonly="yes">
7619	<desc>
7620	Identifier of the Guest OS type as reported by the Guest
7621	Additions.
7622	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7623	an IGuestOSType object representing details about the given
7624	Guest OS type.
7625	<note>
7626	If Guest Additions are not installed, this value will be
7627	the same as <link to="IMachine::OSTypeId"/>.
7628	</note>
7629	</desc>
7630	</attribute>
7631
7632	<attribute name="additionsActive" type="boolean" readonly="yes">
7633	<desc>
7634	Flag whether the Guest Additions are installed and active
7635	in which case their version will be returned by the
7636	<link to="#additionsVersion"/> property.
7637	</desc>
7638	</attribute>
7639
7640	<attribute name="additionsVersion" type="wstring" readonly="yes">
7641	<desc>
7642	Version of the Guest Additions (3 decimal numbers separated
7643	by dots) or empty when the Additions are not installed. The
7644	Additions may also report a version but yet not be active as
7645	the version might be refused by VirtualBox (incompatible) or
7646	other failures occurred.
7647	</desc>
7648	</attribute>
7649
7650	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7651	<desc>
7652	Flag whether seamless guest display rendering (seamless desktop
7653	integration) is supported.
7654	</desc>
7655	</attribute>
7656
7657	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7658	<desc>
7659	Flag whether the guest is in graphics mode. If it is not, then
7660	seamless rendering will not work, resize hints are not immediately
7661	acted on and guest display resizes are probably not initiated by
7662	the guest additions.
7663	</desc>
7664	</attribute>
7665
7666	<attribute name="memoryBalloonSize" type="unsigned long">
7667	<desc>Guest system memory balloon size in megabytes.</desc>
7668	</attribute>
7669
7670	<attribute name="statisticsUpdateInterval" type="unsigned long">
7671	<desc>Interval to update guest statistics in seconds.</desc>
7672	</attribute>
7673
7674	<method name="setCredentials">
7675	<desc>
7676	Store login credentials that can be queried by guest operating
7677	systems with Additions installed. The credentials are transient
7678	to the session and the guest may also choose to erase them. Note
7679	that the caller cannot determine whether the guest operating system
7680	has queried or made use of the credentials.
7681
7682	<result name="VBOX_E_VM_ERROR">
7683	VMM device is not available.
7684	</result>
7685
7686	</desc>
7687	<param name="userName" type="wstring" dir="in">
7688	<desc>User name string, can be empty</desc>
7689	</param>
7690	<param name="password" type="wstring" dir="in">
7691	<desc>Password string, can be empty</desc>
7692	</param>
7693	<param name="domain" type="wstring" dir="in">
7694	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7695	</param>
7696	<param name="allowInteractiveLogon" type="boolean" dir="in">
7697	<desc>
7698	Flag whether the guest should alternatively allow the user to
7699	interactively specify different credentials. This flag might
7700	not be supported by all versions of the Additions.
7701	</desc>
7702	</param>
7703	</method>
7704
7705	<method name="getStatistic">
7706	<desc>
7707	Query specified guest statistics as reported by the VirtualBox Additions.
7708	</desc>
7709	<param name="cpuId" type="unsigned long" dir="in">
7710	<desc>Virtual CPU id; not relevant for all statistic types</desc>
7711	</param>
7712	<param name="statistic" type="GuestStatisticType" dir="in">
7713	<desc>Statistic type.</desc>
7714	</param>
7715	<param name="statVal" type="unsigned long" dir="return">
7716	<desc>Statistics value</desc>
7717	</param>
7718	</method>
7719
7720	</interface>
7721
7722
7723	<!--
7724	// IProgress
7725	/////////////////////////////////////////////////////////////////////////
7726	-->
7727
7728	<interface
7729	name="IProgress" extends="$unknown"
7730	uuid="62827ef1-c098-40eb-be96-36d0508489a6"
7731	wsmap="managed"
7732	>
7733	<desc>
7734	The IProgress interface is used to track and control
7735	asynchronous tasks within VirtualBox.
7736
7737	An instance of this is returned every time VirtualBox starts
7738	an asynchronous task (in other words, a separate thread) which
7739	continues to run after a method call returns. For example,
7740	<link to="IConsole::saveState" />, which saves the state of
7741	a running virtual machine, can take a long time to complete.
7742	To be able to display a progress bar, a user interface such as
7743	the VirtualBox graphical user interface can use the IProgress
7744	object returned by that method.
7745
7746	Note that IProgress is a "read-only" interface in the sense
7747	that only the VirtualBox internals behind the Main API can
7748	create and manipulate progress objects, whereas client code
7749	can only use the IProgress object to monitor a task's
7750	progress and, if <link to="#cancelable" /> is @c true,
7751	cancel the task by calling <link to="#cancel" />.
7752
7753	A task represented by IProgress consists of either one or
7754	several sub-operations that run sequentially, one by one (see
7755	<link to="#operation" /> and <link to="#operationCount" />).
7756	Every operation is identified by a number (starting from 0)
7757	and has a separate description.
7758
7759	You can find the individual percentage of completion of the current
7760	operation in <link to="#operationPercent" /> and the
7761	percentage of completion of the task as a whole
7762	in <link to="#percent" />.
7763
7764	Similarly, you can wait for the completion of a particular
7765	operation via <link to="#waitForOperationCompletion" /> or
7766	for the completion of the whole task via
7767	<link to="#waitForCompletion" />.
7768	</desc>
7769
7770	<attribute name="id" type="uuid" mod="string" readonly="yes">
7771	<desc>ID of the task.</desc>
7772	</attribute>
7773
7774	<attribute name="description" type="wstring" readonly="yes">
7775	<desc>Description of the task.</desc>
7776	</attribute>
7777
7778	<attribute name="initiator" type="$unknown" readonly="yes">
7779	<desc>Initiator of the task.</desc>
7780	</attribute>
7781
7782	<attribute name="cancelable" type="boolean" readonly="yes">
7783	<desc>Whether the task can be interrupted.</desc>
7784	</attribute>
7785
7786	<attribute name="percent" type="unsigned long" readonly="yes">
7787	<desc>
7788	Current progress value of the task as a whole, in percent.
7789	This value depends on how many operations are already complete.
7790	Returns 100 if <link to="#completed" /> is @c true.
7791	</desc>
7792	</attribute>
7793
7794	<attribute name="timeRemaining" type="long" readonly="yes">
7795	<desc>
7796	Estimated remaining time until the task completes, in
7797	seconds. Returns 0 once the task has completed; returns -1
7798	if the remaining time cannot be computed, in particular if
7799	the current progress is 0.
7800
7801	Even if a value is returned, the estimate will be unreliable
7802	for low progress values. It will become more reliable as the
7803	task progresses; it is not recommended to display an ETA
7804	before at least 20% of a task have completed.
7805	</desc>
7806	</attribute>
7807
7808	<attribute name="completed" type="boolean" readonly="yes">
7809	<desc>Whether the task has been completed.</desc>
7810	</attribute>
7811
7812	<attribute name="canceled" type="boolean" readonly="yes">
7813	<desc>Whether the task has been canceled.</desc>
7814	</attribute>
7815
7816	<attribute name="resultCode" type="long" readonly="yes">
7817	<desc>
7818	Result code of the progress task.
7819	Valid only if <link to="#completed"/> is @c true.
7820	</desc>
7821	</attribute>
7822
7823	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
7824	<desc>
7825	Extended information about the unsuccessful result of the
7826	progress operation. May be @c null if no extended information
7827	is available.
7828	Valid only if <link to="#completed"/> is @c true and
7829	<link to="#resultCode"/> indicates a failure.
7830	</desc>
7831	</attribute>
7832
7833	<attribute name="operationCount" type="unsigned long" readonly="yes">
7834	<desc>
7835	Number of sub-operations this task is divided into.
7836	Every task consists of at least one suboperation.
7837	</desc>
7838	</attribute>
7839
7840	<attribute name="operation" type="unsigned long" readonly="yes">
7841	<desc>Number of the sub-operation being currently executed.</desc>
7842	</attribute>
7843
7844	<attribute name="operationDescription" type="wstring" readonly="yes">
7845	<desc>
7846	Description of the sub-operation being currently executed.
7847	</desc>
7848	</attribute>
7849
7850	<attribute name="operationPercent" type="unsigned long" readonly="yes">
7851	<desc>Progress value of the current sub-operation only, in percent.</desc>
7852	</attribute>
7853
7854	<method name="setCurrentOperationProgress">
7855	<desc>Internal method, not to be called externally.</desc>
7856	<param name="percent" type="unsigned long" dir="in" />
7857	</method>
7858	<method name="setNextOperation">
7859	<desc>Internal method, not to be called externally.</desc>
7860	<param name="nextOperationDescription" type="wstring" dir="in" />
7861	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
7862	</method>
7863
7864	<method name="waitForCompletion">
7865	<desc>
7866	Waits until the task is done (including all sub-operations)
7867	with a given timeout in milliseconds; specify -1 for an indefinite wait.
7868
7869	<result name="VBOX_E_IPRT_ERROR">
7870	Failed to wait for task completion.
7871	</result>
7872	</desc>
7873
7874	<param name="timeout" type="long" dir="in">
7875	<desc>
7876	Maximum time in milliseconds to wait or -1 to wait indefinitely.
7877	</desc>
7878	</param>
7879	</method>
7880
7881	<method name="waitForOperationCompletion">
7882	<desc>
7883	Waits until the given operation is done with a given timeout in
7884	milliseconds; specify -1 for an indefinite wait.
7885
7886	<result name="VBOX_E_IPRT_ERROR">
7887	Failed to wait for operation completion.
7888	</result>
7889
7890	</desc>
7891	<param name="operation" type="unsigned long" dir="in">
7892	<desc>
7893	Number of the operation to wait for.
7894	Must be less than <link to="#operationCount"/>.
7895	</desc>
7896	</param>
7897	<param name="timeout" type="long" dir="in">
7898	<desc>
7899	Maximum time in milliseconds to wait or -1 to wait indefinitely.
7900	</desc>
7901	</param>
7902	</method>
7903
7904	<method name="cancel">
7905	<desc>
7906	Cancels the task.
7907	<note>
7908	If <link to="#cancelable"/> is @c false, then this method will fail.
7909	</note>
7910
7911	<result name="VBOX_E_INVALID_OBJECT_STATE">
7912	Operation cannot be canceled.
7913	</result>
7914
7915	</desc>
7916	</method>
7917
7918	</interface>
7919
7920
7921	<!--
7922	// ISnapshot
7923	/////////////////////////////////////////////////////////////////////////
7924	-->
7925
7926	<interface
7927	name="ISnapshot" extends="$unknown"
7928	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
7929	wsmap="managed"
7930	>
7931	<desc>
7932	The ISnapshot interface represents a snapshot of the virtual
7933	machine.
7934
7935	Together with the differencing media that are created
7936	when a snapshot is taken, a machine can be brought back to
7937	the exact state it was in when the snapshot was taken.
7938
7939	The ISnapshot interface has no methods, only attributes; snapshots
7940	are controlled through methods of the <link to="IConsole" /> interface
7941	which also manage the media associated with the snapshot.
7942	The following operations exist:
7943
7944	<ul>
7945	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
7946	by creating new, empty differencing images for the machine's
7947	media and saving the VM settings and (if the VM is running)
7948	the current VM state in the snapshot.
7949
7950	The differencing images will then receive all data written to
7951	the machine's media, while their parent (base) images
7952	remain unmodified after the snapshot has been taken (see
7953	<link to="IMedium" /> for details about differencing images).
7954	This simplifies restoring a machine to the state of a snapshot:
7955	only the differencing images need to be deleted.
7956
7957	The current machine state is not changed by taking a snapshot.
7958	If the machine is running, it will resume execution after the
7959	snapshot has been taken.
7960	</li>
7961
7962	<li><link to="IConsole::discardCurrentState"/>: this goes back to
7963	a previous snapshot. This resets the machine's state to that of
7964	the previous snapshot by deleting the differencing image of each
7965	of the machine's media and setting the machine's settings
7966	and state to the state that was saved in the snapshot (if any).
7967
7968	This destroys the machine's current state.
7969	</li>
7970
7971	<li><link to="IConsole::discardSnapshot"/>: deletes a snapshot
7972	without affecting the current machine state.
7973
7974	This does not change the machine, but instead frees the resources
7975	allocated when the snapshot was taken: the settings and machine state
7976	is deleted (if any), and the snapshot's differencing image for each
7977	of the machine's media gets merged with its parent image.
7978
7979	Neither the current machine state nor other snapshots are affected
7980	by this operation, except that parent disk images will be modified
7981	to contain the disk data associated with the snapshot being deleted.
7982	</li>
7983
7984	<li><link to="IConsole::discardCurrentSnapshotAndState"/>:
7985	this completely reverts the virtual machine to the state it was in
7986	before the current snapshot has been taken. Effectively, this goes
7987	back to the state before the current snapshot, which might be
7988	an earlier snapshot.
7989
7990	The current state, as well as the current snapshot, are lost.
7991	</li>
7992	</ul>
7993
7994	Each snapshot contains the settings of the virtual machine (hardware
7995	configuration etc.). In addition, if the machine was running when the
7996	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
7997	the current VM state is saved in the snapshot (similarly to what happens
7998	when a VM's state is saved). The snapshot is then said to
7999	be <i>online</i> because when restoring it, the VM will be running.
8000
8001	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8002	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8003
8004	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8005	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8006	it then contains a so-called "zero execution state", representing a
8007	machine that is powered off.
8008
8009	<h3>Snapshot branches and the "current" snapshot</h3>
8010
8011	Snapshots can be chained, whereby every next snapshot is based on the
8012	previous one. This chaining is related to medium branching
8013	(see the <link to="IMedium"/> description) in that every time
8014	a new snapshot is created, a new differencing medium is implicitly
8015	created for all normal media attached to the machine.
8016
8017	Each virtual machine has a "current snapshot", identified by
8018	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8019	to the last snapshot in the chain. In a future version of VirtualBox,
8020	it will be possible to reset a machine's current state to that of an
8021	earlier snapshot without discarding the current state so that it will be
8022	possible to create alternative snapshot paths in a snapshot tree.
8023
8024	In the current implementation, multiple snapshot branches within one
8025	virtual machine are not allowed. Every machine has a single branch,
8026	and <link to="IConsole::takeSnapshot"/> operation adds a new
8027	snapshot to the top of that branch.
8028	</desc>
8029
8030	<attribute name="id" type="uuid" mod="string" readonly="yes">
8031	<desc>UUID of the snapshot.</desc>
8032	</attribute>
8033
8034	<attribute name="name" type="wstring">
8035	<desc>Short name of the snapshot.</desc>
8036	</attribute>
8037
8038	<attribute name="description" type="wstring">
8039	<desc>Optional description of the snapshot.</desc>
8040	</attribute>
8041
8042	<attribute name="timeStamp" type="long long" readonly="yes">
8043	<desc>
8044	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8045	</desc>
8046	</attribute>
8047
8048	<attribute name="online" type="boolean" readonly="yes">
8049	<desc>
8050	@c true if this snapshot is an online snapshot and @c false otherwise.
8051
8052	When this attribute is @c true, the
8053	<link to="IMachine::stateFilePath"/> attribute of the
8054	<link to="#machine"/> object associated with this snapshot
8055	will point to the saved state file. Otherwise, it will be
8056	an empty string.
8057	</desc>
8058	</attribute>
8059
8060	<attribute name="machine" type="IMachine" readonly="yes">
8061	<desc>
8062	Virtual machine this snapshot is taken on. This object
8063	stores all settings the machine had when taking this snapshot.
8064	<note>
8065	The returned machine object is immutable, i.e. no
8066	any settings can be changed.
8067	</note>
8068	</desc>
8069	</attribute>
8070
8071	<attribute name="parent" type="ISnapshot" readonly="yes">
8072	<desc>
8073	Parent snapshot (a snapshot this one is based on), or
8074	@c null if the snapshot has no parent.
8075	</desc>
8076	</attribute>
8077
8078	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8079	<desc>
8080	Child snapshots (all snapshots having this one as a parent).
8081	<note>
8082	In the current implementation, there can be only one
8083	child snapshot, or no children at all, meaning this is the
8084	last (head) snapshot.
8085	</note>
8086	</desc>
8087	</attribute>
8088
8089	</interface>
8090
8091
8092	<!--
8093	// IMedium
8094	/////////////////////////////////////////////////////////////////////////
8095	-->
8096
8097	<enum
8098	name="MediumState"
8099	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8100	>
8101	<desc>
8102	Virtual medium state.
8103	<see>IMedium</see>
8104	</desc>
8105
8106	<const name="NotCreated" value="0">
8107	<desc>
8108	Associated medium storage does not exist (either was not created yet or
8109	was deleted).
8110	</desc>
8111	</const>
8112	<const name="Created" value="1">
8113	<desc>
8114	Associated storage exists and accessible.
8115	</desc>
8116	</const>
8117	<const name="LockedRead" value="2">
8118	<desc>
8119	Medium is locked for reading, no data modification is possible.
8120	</desc>
8121	</const>
8122	<const name="LockedWrite" value="3">
8123	<desc>
8124	Medium is locked for writing, no concurrent data reading or modification
8125	is possible.
8126	</desc>
8127	</const>
8128	<const name="Inaccessible" value="4">
8129	<desc>
8130	Associated medium storage is not accessible.
8131	</desc>
8132	</const>
8133	<const name="Creating" value="5">
8134	<desc>
8135	Associated medium storage is being created.
8136	</desc>
8137	</const>
8138	<const name="Deleting" value="6">
8139	<desc>
8140	Associated medium storage is being deleted.
8141	</desc>
8142	</const>
8143	</enum>
8144
8145	<enum
8146	name="MediumType"
8147	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8148	>
8149	<desc>
8150	Virtual medium type.
8151	<see>IMedium</see>
8152	</desc>
8153
8154	<const name="Normal" value="0">
8155	<desc>
8156	Normal medium (attached directly or indirectly, preserved
8157	when taking snapshots).
8158	</desc>
8159	</const>
8160	<const name="Immutable" value="1">
8161	<desc>
8162	Immutable medium (attached indirectly, changes are wiped out
8163	after powering off the virtual machine).
8164	</desc>
8165	</const>
8166	<const name="Writethrough" value="2">
8167	<desc>
8168	Write through medium (attached directly, ignored when
8169	taking snapshots).
8170	</desc>
8171	</const>
8172	</enum>
8173
8174	<enum
8175	name="MediumVariant"
8176	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8177	>
8178	<desc>
8179	Virtual medium image variant. More than one flag may be set.
8180	<see>IMedium</see>
8181	</desc>
8182
8183	<const name="Standard" value="0">
8184	<desc>
8185	No particular variant requested, results in using the backend default.
8186	</desc>
8187	</const>
8188	<const name="VmdkSplit2G" value="0x01">
8189	<desc>
8190	VMDK image split in chunks of less than 2GByte.
8191	</desc>
8192	</const>
8193	<const name="VmdkStreamOptimized" value="0x04">
8194	<desc>
8195	VMDK streamOptimized image. Special import/export format which is
8196	read-only/append-only.
8197	</desc>
8198	</const>
8199	<const name="VmdkESX" value="0x08">
8200	<desc>
8201	VMDK format variant used on ESX products.
8202	</desc>
8203	</const>
8204	<const name="Fixed" value="0x10000">
8205	<desc>
8206	Fixed image. Only allowed for base images.
8207	</desc>
8208	</const>
8209	<const name="Diff" value="0x20000">
8210	<desc>
8211	Fixed image. Only allowed for base images.
8212	</desc>
8213	</const>
8214	</enum>
8215
8216	<interface
8217	name="IMediumAttachment" extends="$unknown"
8218	uuid="0dcf987b-a024-453f-bace-7eb9f885a413"
8219	wsmap="struct"
8220	>
8221	<desc>
8222	The IMediumAttachment interface represents the attachment
8223	of a storage medium to a virtual machine. Each machine contains
8224	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8225
8226	Each medium attachment specifies a storage controller as well as a port
8227	and device number. Fixed media (hard disks) will always also specify
8228	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8229	image or images that represent the virtual hard disk. For removeable media,
8230	the IMedia instance is optional; it can be NULL if no media is mounted (see
8231	<link to="IMachine::mountMedium" />).
8232	</desc>
8233
8234	<attribute name="medium" type="IMedium" readonly="yes">
8235	<desc>Medium object associated with this attachment; it
8236	can be NULL for removable devices.</desc>
8237	</attribute>
8238
8239	<attribute name="controller" type="wstring" readonly="yes">
8240	<desc>Name of the storage controller of this attachment; this
8241	refers to one of the controllers in <link to="IMachine::storageControllers" />
8242	by name.</desc>
8243	</attribute>
8244
8245	<attribute name="port" type="long" readonly="yes">
8246	<desc>Port number of this attachment.</desc>
8247	</attribute>
8248
8249	<attribute name="device" type="long" readonly="yes">
8250	<desc>Device slot number of this attachment.</desc>
8251	</attribute>
8252
8253	<attribute name="type" type="DeviceType" readonly="yes">
8254	<desc>Device type of this attachment.</desc>
8255	</attribute>
8256
8257	<attribute name="passthrough" type="boolean" readonly="no">
8258	<desc>Pass I/O requests through to a device on the host.</desc>
8259	</attribute>
8260
8261	</interface>
8262
8263	<interface
8264	name="IMedium" extends="$unknown"
8265	uuid="62551115-83b8-4d20-925f-79e9d3c00f96"
8266	wsmap="managed"
8267	>
8268	<desc>
8269	The IMedium interface represents virtual storage for a machine's
8270	hard disks, CD/DVD or floppy drives. It will typically represent
8271	a disk image on the host, for example a VDI or VMDK file representing
8272	a virtual hard disk, or an ISO or RAW file representing virtual
8273	removable media, but can also point to a network location (e.g.
8274	for iSCSI targets).
8275
8276	Instances of IMedium are connected to virtual machines by way of
8277	medium attachments (see <link to="IMediumAttachment" />), which link
8278	the storage medium to a particular device slot of a storage controller
8279	of the virtual machine.
8280	In the VirtualBox API, virtual storage is therefore always represented
8281	by the following chain of object links:
8282
8283	<ul>
8284	<li><link to="IMachine::storageControllers"/> contains an array of
8285	storage controllers (IDE, SATA, SCSI or a floppy controller;
8286	these are instances of <link to="IStorageController"/>).</li>
8287	<li><link to="IMachine::mediumAttachments"/> contains an array of
8288	medium attachments (instances of <link to="IMediumAttachment"/>),
8289	each containing the name of a storage controller from the above
8290	array, a port/device specification, and an instance of
8291	IMedium representing the medium storage (image file). For removable
8292	media, the storage medium is optional; a medium attachment with no
8293	medium represents a CD/DVD or floppy drive with no medium inserted.
8294	By contrast, hard disk attachments will always have an IMedium
8295	object attached.</li>
8296	<li>Each IMedium in turn points to a storage unit (such as a file on the host
8297	computer or a network resource) that holds actual data. The location of
8298	the storage unit is represented by the <link to="#location"/> attribute.
8299	The value of this attribute is medium type dependent.</li>
8300	</ul>
8301
8302	Existing media are opened using the following methods, depending on the
8303	media type:
8304	<ul>
8305	<li><link to="IVirtualBox::openHardDisk"/></li>
8306	<li><link to="IVirtualBox::openDVDImage"/></li>
8307	<li><link to="IVirtualBox::openFloppyImage"/></li>
8308	</ul>
8309
8310	New hard disk media can be created with the VirtualBox API using the
8311	<link to="IVirtualBox::createHardDisk"/> method.
8312
8313	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8314	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8315	type in a regular file.
8316
8317	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8318	drive; in that case the <link to="#id" /> attribute contains the UUID of
8319	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8320
8321	<h3>Known media</h3>
8322
8323	When an existing medium is opened for the first time, it is automatically
8324	remembered by the given VirtualBox installation or, in other words, becomes
8325	a <i>known medium</i>. Known media are stored in the media
8326	registry transparently maintained by VirtualBox and stored in settings
8327	files so that this registry is preserved when VirtualBox is not running.
8328
8329	Newly created virtual media are remembered only when the associated
8330	storage unit is actually created.
8331
8332	All known media can be enumerated using
8333	<link to="IVirtualBox::hardDisks"/>,
8334	<link to="IVirtualBox::DVDImages"/> and
8335	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8336	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8337	and similar methods or by location using
8338	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8339
8340	Only known media can be attached to virtual machines.
8341
8342	Removing known media from the media registry is performed when the given
8343	medium is closed using the <link to="#close"/> method or when its
8344	associated storage unit is deleted.
8345
8346	<h3>Accessibility checks</h3>
8347
8348	The given medium (with the created storage unit) is considered to be
8349	<i>accessible</i> when its storage unit can be read. In that case, the
8350	<link to="#state"/> attribute has a value of "Created".
8351	When the storage unit cannot be read (for example, because it is located on
8352	a disconnected network resource, or was accidentally deleted outside VirtualBox),
8353	the medium is considered to be <i>inaccessible</i>, which is indicated by the
8354	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8355	obtained by reading the <link to="#lastAccessError"/> attribute.
8356
8357	A new accessibility check is performed each time the <link to="#state"/>
8358	attribute is read. This check may take long time (several seconds or even
8359	minutes, depending on the storage unit location and format), and will
8360	block the calling thread until finished. For this reason, it is recommended
8361	to never read this attribute on the main UI thread to avoid making the UI
8362	unresponsive.
8363
8364	Note that when VirtualBox starts up (e.g. the VirtualBox object gets
8365	created for the first time), all known media are in the
8366	<link to="MediumState_Inaccessible"/> state but the value of the <link
8367	to="#lastAccessError"/> attribute is an empty string because no actual
8368	accessibility check is made on startup. This is done to make the
8369	VirtualBox object ready for serving requests as
8370	fast as possible and let the end-user application decide if it needs to
8371	check media accessibility right away or not.
8372
8373	<h3>Hard disk types</h3>
8374
8375	There are three types of hard disk images (see <link to="MediumType" />):
8376	"normal", "immutable" and "writethrough", represented by the
8377	<link to="#type"/> attribute. The type of the hard disk defines how the
8378	hard disk is attached to a virtual machine and what happens when a
8379	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8380	attached hard disk is taken.
8381
8382	All hard disks can be also divided in two groups: <i>base</i> hard
8383	disks and <i>differencing</i> hard disks. A base hard disk contains all
8384	sectors of the hard disk data in its own storage and therefore can be
8385	used independently. On the contrary, a differencing hard disk is a
8386	"delta" to some other disk and contains only those sectors which differ
8387	from that other disk, which is then called a <i>parent</i>. The differencing
8388	hard disk is said to be <i>linked to</i> that parent.
8389	The parent may be itself a differencing image, thus forming a chain of
8390	linked hard disks. The last element in that chain
8391	must always be a base medium. Note that several differencing
8392	hard disks may be linked to the same parent hard disk.
8393
8394	Differencing hard disks can be distinguished from base hard disks by
8395	querying the <link to="#parent"/> attribute: base hard disks do not have
8396	parents they would depend on, so the value of this attribute is always
8397	@c null for them. Using this attribute, it is possible to walk up
8398	the hard disk tree (from the child hard disk to its parent). It is also
8399	possible to walk down the tree using the <link to="#children"/>
8400	attribute.
8401
8402	Note that the type of all differencing hard disks is
8403	<link to="MediumType_Normal" />; all other values are
8404	meaningless for them. Base hard disks may be of any type.
8405
8406	<h3>Creating hard disks</h3>
8407
8408	New base hard disks are created using
8409	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8410	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8411	disks are usually implicitly created by VirtualBox when needed but may
8412	also be created explicitly using <link to="#createDiffStorage"/>.
8413
8414	After the hard disk is successfully created (including the storage unit)
8415	or opened, it becomes a known hard disk (remembered in the internal media
8416	registry). Known hard disks can be attached to a virtual machine, accessed
8417	through <link to="IVirtualBox::getHardDisk"/> and
8418	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8419	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8420
8421	The following methods, besides <link to="IMedium::close"/>,
8422	automatically remove the hard disk from the media registry:
8423	<ul>
8424	<li><link to="#deleteStorage"/></li>
8425	<li><link to="#mergeTo"/></li>
8426	</ul>
8427
8428	If the storage unit of the hard disk is a regular file in the host's
8429	file system then the rules stated in the description of the
8430	<link to="IMedium::location"/> attribute apply when setting its value. In
8431	addition, a plain file name without any path may be given, in which case
8432	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8433	folder</link> will be prepended to it.
8434
8435	<h4>Automatic composition of the file name part</h4>
8436
8437	Another extension to the <link to="IMedium::location"/> attribute is that
8438	there is a possibility to cause VirtualBox to compose a unique value for
8439	the file name part of the location using the UUID of the hard disk. This
8440	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8441	e.g. before the storage unit is created, and works as follows. You set the
8442	value of the <link to="IMedium::location"/> attribute to a location
8443	specification which only contains the path specification but not the file
8444	name part and ends with either a forward slash or a backslash character.
8445	In response, VirtualBox will generate a new UUID for the hard disk and
8446	compose the file name using the following pattern:
8447	<pre>
8448	<path>/{<uuid>}.<ext>
8449	</pre>
8450	where <tt><path></tt> is the supplied path specification,
8451	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8452	is the default extension for the storage format of this hard disk. After
8453	that, you may call any of the methods that create a new hard disk storage
8454	unit and they will use the generated UUID and file name.
8455
8456	<h3>Attaching Hard Disks</h3>
8457
8458	Hard disks are attached to virtual machines using the
8459	<link to="IMachine::attachDevice"/> method and detached using the
8460	<link to="IMachine::detachDevice"/> method. Depending on their
8461	<link to="#type"/>, hard disks are attached either
8462	<i>directly</i> or <i>indirectly</i>.
8463
8464	When a hard disk is being attached directly, it is associated with the
8465	virtual machine and used for hard disk operations when the machine is
8466	running. When a hard disk is being attached indirectly, a new differencing
8467	hard disk linked to it is implicitly created and this differencing hard
8468	disk is associated with the machine and used for hard disk operations.
8469	This also means that if <link to="IMachine::attachDevice"/> performs
8470	a direct attachment then the same hard disk will be returned in response
8471	to the subsequent <link to="IMachine::getMedium"/> call; however if
8472	an indirect attachment is performed then
8473	<link to="IMachine::getMedium"/> will return the implicitly created
8474	differencing hard disk, not the original one passed to <link
8475	to="IMachine::attachDevice"/>. In detail:
8476
8477	<ul>
8478	<li><b>Normal base</b> hard disks that do not have children (i.e.
8479	differencing hard disks linked to them) and that are not already
8480	attached to virtual machines in snapshots are attached <b>directly</b>.
8481	Otherwise, they are attached <b>indirectly</b> because having
8482	dependent children or being part of the snapshot makes it impossible
8483	to modify hard disk contents without breaking the integrity of the
8484	dependent party. The <link to="#readOnly"/> attribute allows to
8485	quickly determine the kind of the attachment for the given hard
8486	disk. Note that if a normal base hard disk is to be indirectly
8487	attached to a virtual machine with snapshots then a special
8488	procedure called <i>smart attachment</i> is performed (see below).</li>
8489	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8490	they are attached <b>directly</b> if they do not have children and are
8491	not attached to virtual machines in snapshots, and <b>indirectly</b>
8492	otherwise. Note that the smart attachment procedure is never performed
8493	for differencing hard disks.</li>
8494	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8495	they are designed to be non-writable. If an immutable hard disk is
8496	attached to a virtual machine with snapshots then a special
8497	procedure called smart attachment is performed (see below).</li>
8498	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8499	also as designed. This also means that writethrough hard disks cannot
8500	have other hard disks linked to them at all.</li>
8501	</ul>
8502
8503	Note that the same hard disk, regardless of its type, may be attached to
8504	more than one virtual machine at a time. In this case, the machine that is
8505	started first gains exclusive access to the hard disk and attempts to
8506	start other machines having this hard disk attached will fail until the
8507	first machine is powered down.
8508
8509	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8510	that the given hard disk remains associated with the given machine after a
8511	successful <link to="IMachine::detachDevice"/> call until
8512	<link to="IMachine::saveSettings"/> is called to save all changes to
8513	machine settings to disk. This deferring is necessary to guarantee that
8514	the hard disk configuration may be restored at any time by a call to
8515	<link to="IMachine::discardSettings"/> before the settings
8516	are saved (committed).
8517
8518	Note that if <link to="IMachine::discardSettings"/> is called after
8519	indirectly attaching some hard disks to the machine but before a call to
8520	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8521	all differencing hard disks implicitly created by
8522	<link to="IMachine::attachDevice"/> for these indirect attachments.
8523	Such implicitly created hard disks will also be immediately deleted when
8524	detached explicitly using the <link to="IMachine::detachDevice"/>
8525	call if it is made before <link to="IMachine::saveSettings"/>. This
8526	implicit deletion is safe because newly created differencing hard
8527	disks do not contain any user data.
8528
8529	However, keep in mind that detaching differencing hard disks that were
8530	implicitly created by <link to="IMachine::attachDevice"/>
8531	before the last <link to="IMachine::saveSettings"/> call will
8532	<b>not</b> implicitly delete them as they may already contain some data
8533	(for example, as a result of virtual machine execution). If these hard
8534	disks are no more necessary, the caller can always delete them explicitly
8535	using <link to="#deleteStorage"/> after they are actually de-associated
8536	from this machine by the <link to="IMachine::saveSettings"/> call.
8537
8538	<h3>Smart Attachment</h3>
8539
8540	When normal base or immutable hard disks are indirectly attached to a
8541	virtual machine then some additional steps are performed to make sure the
8542	virtual machine will have the most recent "view" of the hard disk being
8543	attached. These steps include walking through the machine's snapshots
8544	starting from the current one and going through ancestors up to the first
8545	snapshot. Hard disks attached to the virtual machine in all
8546	of the encountered snapshots are checked whether they are descendants of
8547	the given normal base or immutable hard disk. The first found child (which
8548	is the differencing hard disk) will be used instead of the normal base or
8549	immutable hard disk as a parent for creating a new differencing hard disk
8550	that will be actually attached to the machine. And only if no descendants
8551	are found or if the virtual machine does not have any snapshots then the
8552	normal base or immutable hard disk will be used itself as a parent for
8553	this differencing hard disk.
8554
8555	It is easier to explain what smart attachment does using the
8556	following example:
8557	<pre>
8558	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8559
8560	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8561	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8562	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8563	Snapshot 4 (none) Snapshot 4 (none)
8564	CurState (none) CurState (D3->D2.vdi)
8565
8566	NOT
8567	...
8568	CurState (D3->B.vdi)
8569	</pre>
8570	The first column is the virtual machine configuration before the base hard
8571	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8572	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8573	mean that the hard disk that is actually attached to the machine is a
8574	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8575	another hard disk, <tt>B.vdi</tt>.
8576
8577	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8578	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8579	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8580	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8581	it cannot be attached directly and needs an indirect attachment (i.e.
8582	implicit creation of a new differencing hard disk). Due to the smart
8583	attachment procedure, the new differencing hard disk
8584	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8585	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8586	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8587	machine.
8588
8589	Note that if there is more than one descendant hard disk of the given base
8590	hard disk found in a snapshot, and there is an exact device, channel and
8591	bus match, then this exact match will be used. Otherwise, the youngest
8592	descendant will be picked up.
8593
8594	There is one more important aspect of the smart attachment procedure which
8595	is not related to snapshots at all. Before walking through the snapshots
8596	as described above, the backup copy of the current list of hard disk
8597	attachment is searched for descendants. This backup copy is created when
8598	the hard disk configuration is changed for the first time after the last
8599	<link to="IMachine::saveSettings"/> call and used by
8600	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8601	changes. When such a descendant is found in this backup copy, it will be
8602	simply re-attached back, without creating a new differencing hard disk for
8603	it. This optimization is necessary to make it possible to re-attach the
8604	base or immutable hard disk to a different bus, channel or device slot
8605	without losing the contents of the differencing hard disk actually
8606	attached to the machine in place of it.
8607	</desc>
8608
8609	<attribute name="id" type="uuid" mod="string" readonly="yes">
8610	<desc>
8611	UUID of the medium. For a newly created medium, this value is a randomly
8612	generated UUID.
8613
8614	<note>
8615	For media in one of MediumState_NotCreated, MediumState_Creating or
8616	MediumState_Deleting states, the value of this property is undefined
8617	and will most likely be an empty UUID.
8618	</note>
8619	</desc>
8620	</attribute>
8621
8622	<attribute name="description" type="wstring">
8623	<desc>
8624	Optional description of the medium. For a newly created medium the value
8625	of this attribute is an empty string.
8626
8627	Medium types that don't support this attribute will return E_NOTIMPL in
8628	attempt to get or set this attribute's value.
8629
8630	<note>
8631	For some storage types, reading this attribute may return an outdated
8632	(last known) value when <link to="#state"/> is <link
8633	to="MediumState_Inaccessible"/> or <link
8634	to="MediumState_LockedWrite"/> because the value of this attribute is
8635	stored within the storage unit itself. Also note that changing the
8636	attribute value is not possible in such case, as well as when the
8637	medium is the <link to="MediumState_LockedRead"/> state.
8638	</note>
8639	</desc>
8640	</attribute>
8641
8642	<attribute name="state" type="MediumState" readonly="yes">
8643	<desc>
8644	Current medium state. Inspect <link to="MediumState"/> values for details.
8645
8646	Reading this attribute may take a long time because an accessibility
8647	check of the storage unit is performed each time the attribute is read.
8648	This check may cause a significant delay if the storage unit of the
8649	given medium is, for example, a file located on a network share which is
8650	not currently accessible due to connectivity problems -- the call will
8651	not return until a timeout interval defined by the host OS for this
8652	operation expires.
8653
8654	If the last known state of the medium is <link to="MediumState_Created"/>
8655	and the accessibility check fails then the state would be set to
8656	<link to="MediumState_Inaccessible"/> and <link to="#lastAccessError"/>
8657	may be used to get more details about the failure. If the state of the
8658	medium is <link to="MediumState_LockedRead"/> or
8659	<link to="MediumState_LockedWrite"/> then it remains the same, and a
8660	non-empty value of <link to="#lastAccessError"/> will indicate a failed
8661	accessibility check in this case.
8662
8663	Note that not all medium states are applicable to all medium types.
8664	</desc>
8665	</attribute>
8666
8667	<attribute name="location" type="wstring">
8668	<desc>
8669	Location of the storage unit holding medium data.
8670
8671	The format of the location string is medium type specific. For medium
8672	types using regular files in a host's file system, the location
8673	string is the full file name.
8674
8675	Some medium types may support changing the storage unit location by
8676	simply changing the value of this property. If this operation is not
8677	supported, the implementation will return E_NOTIMPL in attempt to set
8678	this attribute's value.
8679
8680	When setting a value of the location attribute which is a regular file
8681	in the host's file system, the given file name may be either relative to
8682	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
8683	absolute. Note that if the given location specification does not contain
8684	the file extension part then a proper default extension will be
8685	automatically appended by the implementation depending on the medium type.
8686	</desc>
8687	</attribute>
8688
8689	<attribute name="name" type="wstring" readonly="yes">
8690	<desc>
8691	Name of the storage unit holding medium data.
8692
8693	The returned string is a short version of the <link to="#location"/>
8694	attribute that is suitable for representing the medium in situations
8695	where the full location specification is too long (such as lists
8696	and comboboxes in GUI frontends). This string is also used by frontends
8697	to sort the media list alphabetically when needed.
8698
8699	For example, for locations that are regular files in the host's file
8700	system, the value of this attribute is just the file name (+ extension),
8701	without the path specification.
8702
8703	Note that as opposed to the <link to="#location"/> attribute, the name
8704	attribute will not necessary be unique for a list of media of the
8705	given type and format.
8706	</desc>
8707	</attribute>
8708
8709	<attribute name="hostDrive" type="boolean" readonly="yes">
8710	<desc>True if this corresponds to a drive on the host.</desc>
8711	</attribute>
8712
8713	<attribute name="size" type="unsigned long long" readonly="yes">
8714	<desc>
8715	Physical size of the storage unit used to hold medium data (in bytes).
8716
8717	<note>
8718	For media whose <link to="#state"/> is <link
8719	to="MediumState_Inaccessible"/>, the value of this property is the
8720	last known size. For <link to="MediumState_NotCreated"/> media,
8721	the returned value is zero.
8722	</note>
8723	</desc>
8724	</attribute>
8725
8726	<attribute name="format" type="wstring" readonly="yes">
8727	<desc>
8728	Storage format of this medium.
8729
8730	The value of this attribute is a string that specifies a backend used to
8731	store hard disk data. The storage format is defined when you create a
8732	new hard disk or automatically detected when you open an existing hard
8733	disk medium, and cannot be changed later.
8734
8735	The list of all storage formats supported by this VirtualBox
8736	installation can be obtained using
8737	<link to="ISystemProperties::mediumFormats"/>.
8738	</desc>
8739	</attribute>
8740
8741	<attribute name="type" type="MediumType">
8742	<desc>
8743	Type (role) of this hard disk.
8744
8745	The following constraints apply when changing the value of this
8746	attribute:
8747	<ul>
8748	<li>If a hard disk is attached to a virtual machine (either in the
8749	current state or in one of the snapshots), its type cannot be
8750	changed.
8751	</li>
8752	<li>As long as the hard disk has children, its type cannot be set
8753	to <link to="MediumType_Writethrough"/>.
8754	</li>
8755	<li>The type of all differencing hard disks is
8756	<link to="MediumType_Normal"/> and cannot be changed.
8757	</li>
8758	</ul>
8759
8760	The type of a newly created or opened hard disk is set to
8761	<link to="MediumType_Normal"/>.
8762	</desc>
8763	</attribute>
8764
8765	<attribute name="parent" type="IMedium" readonly="yes">
8766	<desc>
8767	Parent of this hard disk (a hard disk this hard disk is directly based
8768	on).
8769
8770	Only differencing hard disks have parents. For base (non-differencing)
8771	hard disks, @c null is returned.
8772	</desc>
8773	</attribute>
8774
8775	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
8776	<desc>
8777	Children of this hard disk (all differencing hard disks directly based
8778	on this hard disk). A @c null array is returned if this hard disk
8779	does not have any children.
8780	</desc>
8781	</attribute>
8782
8783	<attribute name="base" type="IMedium" readonly="yes">
8784	<desc>
8785	Base medium of this medium.
8786
8787	If this is a differencing medium, its base hard disk is the medium
8788	the given hard disk branch starts from. For all other types of hard
8789	disks, this property returns the hard disk object itself (i.e. the same
8790	object this property is read on).
8791	</desc>
8792	</attribute>
8793
8794	<attribute name="readOnly" type="boolean" readonly="yes">
8795	<desc>
8796	Returns @c true if this hard disk is read-only and @c false otherwise.
8797
8798	A hard disk is considered to be read-only when its contents cannot be
8799	modified without breaking the integrity of other parties that depend on
8800	this hard disk such as its child hard disks or snapshots of virtual
8801	machines where this hard disk is attached to these machines. If there
8802	are no children and no such snapshots then there is no dependency and
8803	the hard disk is not read-only.
8804
8805	The value of this attribute can be used to determine the kind of the
8806	attachment that will take place when attaching this hard disk to a
8807	virtual machine. If the value is @c false then the hard disk will
8808	be attached directly. If the value is @c true then the hard disk
8809	will be attached indirectly by creating a new differencing child hard
8810	disk for that. See the interface description for more information.
8811
8812	Note that all <link to="MediumType_Immutable">Immutable</link> hard
8813	disks are always read-only while all
8814	<link to="MediumType_Writethrough">Writethrough</link> hard disks are
8815	always not.
8816
8817	<note>
8818	The read-only condition represented by this attribute is related to
8819	the hard disk type and usage, not to the current
8820	<link to="IMedium::state">medium state</link> and not to the read-only
8821	state of the storage unit.
8822	</note>
8823	</desc>
8824	</attribute>
8825
8826	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
8827	<desc>
8828	Logical size of this hard disk (in megabytes), as reported to the
8829	guest OS running inside the virtual machine this disk is
8830	attached to. The logical size is defined when the hard disk is created
8831	and cannot be changed later.
8832
8833	<note>
8834	Reading this property on a differencing hard disk will return the size
8835	of its <link to="#base"/> medium.
8836	</note>
8837	<note>
8838	For hard disks whose state is <link to="#state"/> is <link
8839	to="MediumState_Inaccessible"/>, the value of this property is the
8840	last known logical size. For <link to="MediumaState_NotCreated"/> hard
8841	disks, the returned value is zero.
8842	</note>
8843	</desc>
8844	</attribute>
8845
8846	<attribute name="autoReset" type="boolean">
8847	<desc>
8848	Whether this differencing hard disk will be automatically reset each
8849	time a virtual machine it is attached to is powered up.
8850
8851	See <link to="#reset()"/> for more information about resetting
8852	differencing hard disks.
8853
8854	<note>
8855	Reading this property on a base (non-differencing) hard disk will
8856	always @c false. Changing the value of this property in this
8857	case is not supported.
8858	</note>
8859
8860	<result name="VBOX_E_NOT_SUPPORTED">
8861	This is not a differencing hard disk (when changing the attribute
8862	value).
8863	</result>
8864	</desc>
8865	</attribute>
8866
8867	<attribute name="lastAccessError" type="wstring" readonly="yes">
8868	<desc>
8869	Text message that represents the result of the last accessibility
8870	check.
8871
8872	Accessibility checks are performed each time the <link to="#state"/>
8873	attribute is read. An empty string is returned if the last
8874	accessibility check was successful. A non-empty string indicates a
8875	failure and should normally describe a reason of the failure (for
8876	example, a file read error).
8877	</desc>
8878	</attribute>
8879
8880	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
8881	<desc>
8882	Array of UUIDs of all machines this medium is attached to.
8883
8884	A @c null array is returned if this medium is not attached to any
8885	machine or to any machine's snapshot.
8886
8887	<note>
8888	The returned array will include a machine even if this medium is not
8889	attached to that machine in the current state but attached to it in
8890	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
8891	details.
8892	</note>
8893	</desc>
8894	</attribute>
8895
8896	<method name="getSnapshotIds">
8897	<desc>
8898	Returns an array of UUIDs of all snapshots of the given machine where
8899	this medium is attached to.
8900
8901	If the medium is attached to the machine in the current state, then the
8902	first element in the array will always be the ID of the queried machine
8903	(i.e. the value equal to the @c machineId argument), followed by
8904	snapshot IDs (if any).
8905
8906	If the medium is not attached to the machine in the current state, then
8907	the array will contain only snapshot IDs.
8908
8909	The returned array may be @c null if this medium is not attached
8910	to the given machine at all, neither in the current state nor in one of
8911	the snapshots.
8912	</desc>
8913	<param name="machineId" type="uuid" mod="string" dir="in">
8914	<desc>
8915	UUID of the machine to query.
8916	</desc>
8917	</param>
8918	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
8919	<desc>
8920	Array of snapshot UUIDs of the given machine using this medium.
8921	</desc>
8922	</param>
8923	</method>
8924
8925	<method name="lockRead">
8926	<desc>
8927	Locks this medium for reading.
8928
8929	The read lock is shared: many clients can simultaneously lock the
8930	same medium for reading unless it is already locked for writing (see
8931	<link to="#lockWrite"/>) in which case an error is returned.
8932
8933	When the medium is locked for reading, it cannot be modified
8934	from within VirtualBox. This means that any method that changes
8935	the properties of this medium or contents of the storage unit
8936	will return an error (unless explicitly stated otherwise) and
8937	that an attempt to start a virtual machine that wants to modify
8938	the medium will also fail.
8939
8940	When the virtual machine is started up, it locks for reading all
8941	media it uses in read-only mode. If some medium cannot be locked
8942	for reading, the startup procedure will fail.
8943
8944	The medium locked for reading must be unlocked using the <link
8945	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
8946	can be nested and must be followed by the same number of paired
8947	<link to="#unlockRead"/> calls.
8948
8949	This method sets the medium state to <link
8950	to="MediumState_LockedRead" /> on success. The state prior to
8951	this call must be <link to="MediumState_Created" />,
8952	<link to="MediumState_Inaccessible" /> or
8953	<link to="MediumState_LockedRead" />.
8954	As you can see, an inaccessible medium can be locked too. This is
8955	not an error; this method performs a logical lock that prevents
8956	modifications of this medium through the VirtualBox API, not a
8957	physical lock of the underlying storage unit.
8958
8959	This method returns the current state of the medium
8960	<b>before</b> the operation.
8961
8962	<result name="VBOX_E_INVALID_OBJECT_STATE">
8963	Invalid medium state (e.g. not created, locked, inaccessible,
8964	creating, deleting).
8965	</result>
8966
8967	</desc>
8968	<param name="state" type="MediumState" dir="return">
8969	<desc>
8970	State of the medium after the operation.
8971	</desc>
8972	</param>
8973	</method>
8974
8975	<method name="unlockRead">
8976	<desc>
8977	Cancels the read lock previously set by <link to="#lockRead"/>.
8978
8979	For both, success and failure, this method returns the current state
8980	of the medium <b>after</b> the operation.
8981
8982	See <link to="#lockRead"/> for more details.
8983
8984	<result name="VBOX_E_INVALID_OBJECT_STATE">
8985	Medium not locked for reading.
8986	</result>
8987
8988	</desc>
8989	<param name="state" type="MediumState" dir="return">
8990	<desc>
8991	State of the medium after the operation.
8992	</desc>
8993	</param>
8994	</method>
8995
8996	<method name="lockWrite">
8997	<desc>
8998	Locks this medium for writing.
8999
9000	The write lock, as opposed to <link to="#lockRead"/>, is
9001	exclusive: there may be only one client holding a write lock
9002	and there may be no read locks while the write lock is held.
9003
9004	When the medium is locked for writing, it cannot be modified
9005	from within VirtualBox and it is not guaranteed that the values
9006	of its properties are up-to-date. Any method that changes the
9007	properties of this medium or contents of the storage unit will
9008	return an error (unless explicitly stated otherwise) and an
9009	attempt to start a virtual machine wanting to modify or to
9010	read the medium will fail.
9011
9012	When the virtual machine is started up, it locks for writing all
9013	media it uses to write data to. If any medium could not be locked
9014	for writing, the startup procedure will fail.
9015
9016	The medium locked for writing must be unlocked using the <link
9017	to="#unlockWrite"/> method. Calls to <link to="#lockWrite"/>
9018	can <b>not</b> be nested and must be followed by a<link
9019	to="#unlockWrite"/> call before the next lockWrite call.
9020
9021	This method sets the medium state to <link to="MediumState_LockedWrite" />
9022	on success. The state prior to this call must be <link to="MediumState_Created"/>
9023	or <link to="MediumState_Inaccessible"/>. As you can see, an inaccessible
9024	medium can be locked too. This is not an error; this method
9025	performs a logical lock preventing modifications of this
9026	medium through the VirtualBox API, not a physical lock of the
9027	underlying storage unit.
9028
9029	For both, success and failure, this method returns the current
9030	state of the medium <b>before</b> the operation.
9031
9032	<result name="VBOX_E_INVALID_OBJECT_STATE">
9033	Invalid medium state (e.g. not created, locked, inaccessible,
9034	creating, deleting).
9035	</result>
9036
9037	</desc>
9038	<param name="state" type="MediumState" dir="return">
9039	<desc>
9040	State of the medium after the operation.
9041	</desc>
9042	</param>
9043	</method>
9044
9045	<method name="unlockWrite">
9046	<desc>
9047	Cancels the write lock previously set by <link to="#lockWrite"/>.
9048
9049	For both, success and failure, this method returns the current
9050	state of the medium <b>after</b> the operation.
9051
9052	See <link to="#lockWrite"/> for more details.
9053
9054	<result name="VBOX_E_INVALID_OBJECT_STATE">
9055	Medium not locked for writing.
9056	</result>
9057
9058	</desc>
9059	<param name="state" type="MediumState" dir="return">
9060	<desc>
9061	State of the medium after the operation.
9062	</desc>
9063	</param>
9064	</method>
9065
9066	<method name="close">
9067	<desc>
9068	Closes this medium.
9069
9070	The medium must not be attached to any known virtual machine
9071	and must not have any known child media, otherwise the
9072	operation will fail.
9073
9074	When the medium is successfully closed, it gets removed from
9075	the list of remembered media, but its storage unit is not
9076	deleted. In particular, this means that this medium can be
9077	later opened again using the <link
9078	to="IVirtualBox::openHardDisk"/> call.
9079
9080	Note that after this method successfully returns, the given medium
9081	object becomes uninitialized. This means that any attempt
9082	to call any of its methods or attributes will fail with the
9083	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9084
9085	<result name="VBOX_E_INVALID_OBJECT_STATE">
9086	Invalid medium state (other than not created, created or
9087	inaccessible).
9088	</result>
9089	<result name="VBOX_E_OBJECT_IN_USE">
9090	Medium attached to virtual machine.
9091	</result>
9092	<result name="VBOX_E_FILE_ERROR">
9093	Settings file not accessible.
9094	</result>
9095	<result name="VBOX_E_XML_ERROR">
9096	Could not parse the settings file.
9097	</result>
9098
9099	</desc>
9100	</method>
9101
9102	<!-- storage methods -->
9103
9104	<method name="getProperty">
9105	<desc>
9106	Returns the value of the custom hard disk property with the given name.
9107
9108	The list of all properties supported by the given hard disk format can
9109	be obtained with <link to="IMediumFormat::describeProperties"/>.
9110
9111	Note that if this method returns an empty string in @a value, the
9112	requested property is supported but currently not assigned any value.
9113
9114	<result name="VBOX_E_OBJECT_NOT_FOUND">
9115	Requested property does not exist (not supported by the format).
9116	</result>
9117	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9118	</desc>
9119	<param name="name" type="wstring" dir="in">
9120	<desc>Name of the property to get.</desc>
9121	</param>
9122	<param name="value" type="wstring" dir="return">
9123	<desc>Current property value.</desc>
9124	</param>
9125	</method>
9126
9127	<method name="setProperty">
9128	<desc>
9129	Sets the value of the custom hard disk property with the given name.
9130
9131	The list of all properties supported by the given hard disk format can
9132	be obtained with <link to="IMediumFormat::describeProperties"/>.
9133
9134	Note that setting the property value to @c null or an empty string is
9135	equivalent to deleting the existing value. A default value (if it is
9136	defined for this property) will be used by the format backend in this
9137	case.
9138
9139	<result name="VBOX_E_OBJECT_NOT_FOUND">
9140	Requested property does not exist (not supported by the format).
9141	</result>
9142	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9143	</desc>
9144	<param name="name" type="wstring" dir="in">
9145	<desc>Name of the property to set.</desc>
9146	</param>
9147	<param name="value" type="wstring" dir="in">
9148	<desc>Property value to set.</desc>
9149	</param>
9150	</method>
9151
9152	<method name="getProperties">
9153	<desc>
9154	Returns values for a group of properties in one call.
9155
9156	The names of the properties to get are specified using the @a names
9157	argument which is a list of comma-separated property names or
9158	an empty string if all properties are to be returned. Note that currently
9159	the value of this argument is ignored and the method always returns all
9160	existing properties.
9161
9162	The list of all properties supported by the given hard disk format can
9163	be obtained with <link to="IMediumFormat::describeProperties"/>.
9164
9165	The method returns two arrays, the array of property names corresponding
9166	to the @a names argument and the current values of these properties.
9167	Both arrays have the same number of elements with each elemend at the
9168	given index in the first array corresponds to an element at the same
9169	index in the second array.
9170
9171	Note that for properties that do not have assigned values,
9172	an empty string is returned at the appropriate index in the
9173	@a returnValues array.
9174
9175	</desc>
9176	<param name="names" type="wstring" dir="in">
9177	<desc>
9178	Names of properties to get.
9179	</desc>
9180	</param>
9181	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9182	<desc>Names of returned properties.</desc>
9183	</param>
9184	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9185	<desc>Values of returned properties.</desc>
9186	</param>
9187	</method>
9188
9189	<method name="setProperties">
9190	<desc>
9191	Sets values for a group of properties in one call.
9192
9193	The names of the properties to set are passed in the @a names
9194	array along with the new values for them in the @a values array. Both
9195	arrays have the same number of elements with each elemend at the given
9196	index in the first array corresponding to an element at the same index
9197	in the second array.
9198
9199	If there is at least one property name in @a names that is not valid,
9200	the method will fail before changing the values of any other properties
9201	from the @a names array.
9202
9203	Using this method over <link to="#setProperty"/> is preferred if you
9204	need to set several properties at once since it will result into less
9205	IPC calls.
9206
9207	The list of all properties supported by the given hard disk format can
9208	be obtained with <link to="IMediumFormat::describeProperties"/>.
9209
9210	Note that setting the property value to @c null or an empty string is
9211	equivalent to deleting the existing value. A default value (if it is
9212	defined for this property) will be used by the format backend in this
9213	case.
9214	</desc>
9215	<param name="names" type="wstring" safearray="yes" dir="in">
9216	<desc>Names of properties to set.</desc>
9217	</param>
9218	<param name="values" type="wstring" safearray="yes" dir="in">
9219	<desc>Values of properties to set.</desc>
9220	</param>
9221	</method>
9222
9223	<!-- storage methods -->
9224
9225	<method name="createBaseStorage">
9226	<desc>
9227	Starts creating a hard disk storage unit (fixed/dynamic, according
9228	to the variant flags) in in the background. The previous storage unit
9229	created for this object, if any, must first be deleted using
9230	<link to="#deleteStorage"/>, otherwise the operation will fail.
9231
9232	Before the operation starts, the hard disk is placed in
9233	<link to="MediumState_Creating"/> state. If the create operation
9234	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9235	state.
9236
9237	After the returned progress object reports that the operation has
9238	successfully completed, the medium state will be set to <link
9239	to="MediumState_Created"/>, the hard disk will be remembered by this
9240	VirtualBox installation and may be attached to virtual machines.
9241
9242	<result name="VBOX_E_NOT_SUPPORTED">
9243	The variant of storage creation operation is not supported. See <link
9244	to="IMediumFormat::capabilities"/>.
9245	</result>
9246	</desc>
9247	<param name="logicalSize" type="unsigned long long" dir="in">
9248	<desc>Maximum logical size of the hard disk in megabytes.</desc>
9249	</param>
9250	<param name="variant" type="MediumVariant" dir="in">
9251	<desc>Exact image variant which should be created.</desc>
9252	</param>
9253	<param name="progress" type="IProgress" dir="return">
9254	<desc>Progress object to track the operation completion.</desc>
9255	</param>
9256	</method>
9257
9258	<method name="deleteStorage">
9259	<desc>
9260	Starts deleting the storage unit of this hard disk.
9261
9262	The hard disk must not be attached to any known virtual machine and must
9263	not have any known child hard disks, otherwise the operation will fail.
9264	It will also fail if there is no storage unit to delete or if deletion
9265	is already in progress, or if the hard disk is being in use (locked for
9266	read or for write) or inaccessible. Therefore, the only valid state for
9267	this operation to succeed is <link to="MediumState_Created"/>.
9268
9269	Before the operation starts, the hard disk is placed to
9270	<link to="MediumState_Deleting"/> state and gets removed from the list
9271	of remembered hard disks (media registry). If the delete operation
9272	fails, the medium will be remembered again and placed back to
9273	<link to="MediumState_Created"/> state.
9274
9275	After the returned progress object reports that the operation is
9276	complete, the medium state will be set to
9277	<link to="MediumState_NotCreated"/> and you will be able to use one of
9278	the storage creation methods to create it again.
9279
9280	<see>#close()</see>
9281
9282	<result name="VBOX_E_OBJECT_IN_USE">
9283	Hard disk is attached to a virtual machine.
9284	</result>
9285	<result name="VBOX_E_NOT_SUPPORTED">
9286	Storage deletion is not allowed because neither of storage creation
9287	operations are supported. See
9288	<link to="IMediumFormat::capabilities"/>.
9289	</result>
9290
9291	<note>
9292	If the deletion operation fails, it is not guaranteed that the storage
9293	unit still exists. You may check the <link to="IMedium::state"/> value
9294	to answer this question.
9295	</note>
9296	</desc>
9297	<param name="progress" type="IProgress" dir="return">
9298	<desc>Progress object to track the operation completion.</desc>
9299	</param>
9300	</method>
9301
9302	<!-- diff methods -->
9303
9304	<method name="createDiffStorage">
9305	<desc>
9306	Starts creating an empty differencing storage unit based on this hard
9307	disk in the format and at the location defined by the @a target
9308	argument.
9309
9310	The target hard disk must be in <link to="MediumState_NotCreated"/>
9311	state (i.e. must not have an existing storage unit). Upon successful
9312	completion, this operation will set the type of the target hard disk to
9313	<link to="MediumType_Normal"/> and create a storage unit necessary to
9314	represent the differencing hard disk data in the given format (according
9315	to the storage format of the target object).
9316
9317	After the returned progress object reports that the operation is
9318	successfully complete, the target hard disk gets remembered by this
9319	VirtualBox installation and may be attached to virtual machines.
9320
9321	<note>
9322	The hard disk will be set to <link to="MediumState_LockedRead"/>
9323	state for the duration of this operation.
9324	</note>
9325	<result name="VBOX_E_OBJECT_IN_USE">
9326	Hard disk not in @c NotCreated state.
9327	</result>
9328	</desc>
9329	<param name="target" type="IMedium" dir="in">
9330	<desc>Target hard disk.</desc>
9331	</param>
9332	<param name="variant" type="MediumVariant" dir="in">
9333	<desc>Exact image variant which should be created.</desc>
9334	</param>
9335	<param name="progress" type="IProgress" dir="return">
9336	<desc>Progress object to track the operation completion.</desc>
9337	</param>
9338	</method>
9339
9340	<method name="mergeTo">
9341	<desc>
9342	Starts merging the contents of this hard disk and all intermediate
9343	differencing hard disks in the chain to the given target hard disk.
9344
9345	The target hard disk must be either a descendant of this hard disk or
9346	its ancestor (otherwise this method will immediately return a failure).
9347	It follows that there are two logical directions of the merge operation:
9348	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9349	ancestor (<i>backward merge</i>). Let us consider the following hard disk
9350	chain:
9351
9352	<pre>Base <- Diff_1 <- Diff_2</pre>
9353
9354	Here, calling this method on the <tt>Base</tt> hard disk object with
9355	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9356	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9357	merge. Note that in both cases the contents of the resulting hard disk
9358	will be the same, the only difference is the hard disk object that takes
9359	the result of the merge operation. In case of the forward merge in the
9360	above example, the result will be written to <tt>Diff_2</tt>; in case of
9361	the backward merge, the result will be written to <tt>Base</tt>. In
9362	other words, the result of the operation is always stored in the target
9363	hard disk.
9364
9365	Upon successful operation completion, the storage units of all hard
9366	disks in the chain between this (source) hard disk and the target hard
9367	disk, including the source hard disk itself, will be automatically
9368	deleted and the relevant hard disk objects (including this hard disk)
9369	will become uninitialized. This means that any attempt to call any of
9370	their methods or attributes will fail with the
9371	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9372	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9373	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> hard
9374	disks. Note that <tt>Diff_2</tt> in this case will become a base hard
9375	disk itself since it will no longer be based on any other hard disk.
9376
9377	Considering the above, all of the following conditions must be met in
9378	order for the merge operation to succeed:
9379	<ul>
9380	<li>
9381	Neither this (source) hard disk nor any intermediate
9382	differencing hard disk in the chain between it and the target
9383	hard disk is attached to any virtual machine.
9384	</li>
9385	<li>
9386	Neither the source hard disk nor the target hard disk is an
9387	<link to="MediumType_Immutable"/> hard disk.
9388	</li>
9389	<li>
9390	The part of the hard disk tree from the source hard disk to the
9391	target hard disk is a linear chain, i.e. all hard disks in this
9392	chain have exactly one child which is the next hard disk in this
9393	chain. The only exception from this rule is the target hard disk in
9394	the forward merge operation; it is allowed to have any number of
9395	child hard disks because the merge operation will hot change its
9396	logical contents (as it is seen by the guest OS or by children).
9397	</li>
9398	<li>
9399	None of the involved hard disks are in
9400	<link to="MediumState_LockedRead"/> or
9401	<link to="MediumState_LockedWrite"/> state.
9402	</li>
9403	</ul>
9404
9405	<note>
9406	This (source) hard disk and all intermediates will be placed to <link
9407	to="MediumState_Deleting"/> state and the target hard disk will be
9408	placed to <link to="MediumState_LockedWrite"/> state and for the
9409	duration of this operation.
9410	</note>
9411	</desc>
9412	<param name="targetId" type="uuid" mod="string" dir="in">
9413	<desc>UUID of the target ancestor or descendant hard disk.</desc>
9414	</param>
9415	<param name="progress" type="IProgress" dir="return">
9416	<desc>Progress object to track the operation completion.</desc>
9417	</param>
9418	</method>
9419
9420	<!-- clone method -->
9421
9422	<method name="cloneTo">
9423	<desc>
9424	Starts creating a clone of this hard disk in the format and at the
9425	location defined by the @a target argument.
9426
9427	The target hard disk must be either in <link to="MediumState_NotCreated"/>
9428	state (i.e. must not have an existing storage unit) or in
9429	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9430	big enough to hold the data or else the copy will be partial). Upon
9431	successful completion, the cloned hard disk will contain exactly the
9432	same sector data as the hard disk being cloned, except that in the
9433	first case a new UUID for the clone will be randomly generated, and in
9434	the second case the UUID will remain unchanged.
9435
9436	The @a parent argument defines which hard disk will be the parent
9437	of the clone. Passing a @c null reference indicates that the clone will
9438	be a base image, i.e. completely independent. It is possible to specify
9439	an arbitrary hard disk for this parameter, including the parent of the
9440	hard disk which is being cloned. Even cloning to a child of the source
9441	hard disk is possible. Note that when cloning to an existing image, the
9442	@a parent irgument is ignored.
9443
9444	After the returned progress object reports that the operation is
9445	successfully complete, the target hard disk gets remembered by this
9446	VirtualBox installation and may be attached to virtual machines.
9447
9448	<note>
9449	This hard disk will be placed to <link to="MediumState_LockedRead"/>
9450	state for the duration of this operation.
9451	</note>
9452	<result name="E_NOTIMPL">
9453	The specified cloning variant is not supported at the moment.
9454	</result>
9455	</desc>
9456	<param name="target" type="IMedium" dir="in">
9457	<desc>Target hard disk.</desc>
9458	</param>
9459	<param name="variant" type="MediumVariant" dir="in">
9460	<desc>Exact image variant which should be created.</desc>
9461	</param>
9462	<param name="parent" type="IMedium" dir="in">
9463	<desc>Parent of the cloned hard disk.</desc>
9464	</param>
9465	<param name="progress" type="IProgress" dir="return">
9466	<desc>Progress object to track the operation completion.</desc>
9467	</param>
9468	</method>
9469
9470	<!-- other methods -->
9471
9472	<method name="compact">
9473	<desc>
9474	Starts compacting of this hard disk. This means that the disk is
9475	transformed into a possibly more compact storage representation.
9476	This potentially creates temporary images, which can require a
9477	substantial amount of additional disk space.
9478
9479	This hard disk will be placed to <link to="MediumState_LockedWrite"/>
9480	state and all its parent hard disks (if any) will be placed to
9481	<link to="MediumState_LockedRead"/> state for the duration of this
9482	operation.
9483
9484	Please note that the results can be either returned straight away,
9485	or later as the result of the background operation via the object
9486	returned via the @a progress parameter.
9487
9488	<result name="VBOX_E_NOT_SUPPORTED">
9489	Hard disk format does not support compacting (but potentially
9490	needs it).
9491	</result>
9492	</desc>
9493	<param name="progress" type="IProgress" dir="return">
9494	<desc>Progress object to track the operation completion.</desc>
9495	</param>
9496	</method>
9497
9498	<method name="reset">
9499	<desc>
9500	Starts erasing the contents of this differencing hard disk.
9501
9502	This operation will reset the differencing hard disk to its initial
9503	state when it does not contain any sector data and any read operation is
9504	redirected to its parent hard disk.
9505
9506	This hard disk will be placed to <link to="MediumState_LockedWrite"/>
9507	for the duration of this operation.
9508
9509	<result name="VBOX_E_NOT_SUPPORTED">
9510	This is not a differencing hard disk.
9511	</result>
9512	<result name="VBOX_E_INVALID_OBJECT_STATE">
9513	Hard disk is not in <link to="MediumState_Created"/> or
9514	<link to="MediumState_Inaccessible"/> state.
9515	</result>
9516	</desc>
9517	<param name="progress" type="IProgress" dir="return">
9518	<desc>Progress object to track the operation completion.</desc>
9519	</param>
9520	</method>
9521
9522	</interface>
9523
9524
9525	<!--
9526	// IMediumFormat
9527	/////////////////////////////////////////////////////////////////////////
9528	-->
9529
9530	<enum
9531	name="DataType"
9532	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9533	>
9534	<const name="Int32" value="0"/>
9535	<const name="Int8" value="1"/>
9536	<const name="String" value="2"/>
9537	</enum>
9538
9539	<enum
9540	name="DataFlags"
9541	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9542	>
9543	<const name="None" value="0x00"/>
9544	<const name="Mandatory" value="0x01"/>
9545	<const name="Expert" value="0x02"/>
9546	<const name="Array" value="0x04"/>
9547	<const name="FlagMask" value="0x07"/>
9548	</enum>
9549
9550	<enum
9551	name="MediumFormatCapabilities"
9552	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
9553	>
9554	<desc>
9555	Hard disk format capability flags.
9556	</desc>
9557
9558	<const name="Uuid" value="0x01">
9559	<desc>
9560	Supports UUIDs as expected by VirtualBox code.
9561	</desc>
9562	</const>
9563
9564	<const name="CreateFixed" value="0x02">
9565	<desc>
9566	Supports creating fixed size images, allocating all space instantly.
9567	</desc>
9568	</const>
9569
9570	<const name="CreateDynamic" value="0x04">
9571	<desc>
9572	Supports creating dynamically growing images, allocating space on
9573	demand.
9574	</desc>
9575	</const>
9576
9577	<const name="CreateSplit2G" value="0x08">
9578	<desc>
9579	Supports creating images split in chunks of a bit less than 2 GBytes.
9580	</desc>
9581	</const>
9582
9583	<const name="Differencing" value="0x10">
9584	<desc>
9585	Supports being used as a format for differencing media (see <link
9586	to="IMedium::createDiffStorage"/>).
9587	</desc>
9588	</const>
9589
9590	<const name="Asynchronous" value="0x20">
9591	<desc>
9592	Supports asynchronous I/O operations for at least some configurations.
9593	</desc>
9594	</const>
9595
9596	<const name="File" value="0x40">
9597	<desc>
9598	The format backend operates on files (the <link to="IMedium::location"/>
9599	attribute of the medium specifies a file used to store medium
9600	data; for a list of supported file extensions see
9601	<link to="IMediumFormat::fileExtensions"/>).
9602	</desc>
9603	</const>
9604
9605	<const name="Properties" value="0x80">
9606	<desc>
9607	The format backend uses the property interface to configure the storage
9608	location and properties (the <link to="IMediumFormat::describeProperties"/>
9609	method is used to get access to properties supported by the given medium format).
9610	</desc>
9611	</const>
9612
9613	<const name="CapabilityMask" value="0xFF"/>
9614	</enum>
9615
9616	<interface
9617	name="IMediumFormat" extends="$unknown"
9618	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
9619	wsmap="managed"
9620	>
9621	<desc>
9622	The IMediumFormat interface represents a medium format.
9623
9624	Each medium format has an associated backend which is used to handle
9625	media stored in this format. This interface provides information
9626	about the properties of the associated backend.
9627
9628	Each medium format is identified by a string represented by the
9629	<link to="#id"/> attribute. This string is used in calls like
9630	<link to="IVirtualBox::createHardDisk"/> to specify the desired
9631	format.
9632
9633	The list of all supported medium formats can be obtained using
9634	<link to="ISystemProperties::mediaFormats"/>.
9635
9636	<see>IMedium</see>
9637	</desc>
9638
9639	<attribute name="id" type="wstring" readonly="yes">
9640	<desc>
9641	Identifier of this format.
9642
9643	The format identifier is a non-@c null non-empty ASCII string. Note that
9644	this string is case-insensitive. This means that, for example, all of
9645	the following strings:
9646	<pre>
9647	"VDI"
9648	"vdi"
9649	"VdI"</pre>
9650	refer to the same medium format.
9651
9652	This string is used in methods of other interfaces where it is necessary
9653	to specify a medium format, such as
9654	<link to="IVirtualBox::createHardDisk"/>.
9655	</desc>
9656	</attribute>
9657
9658	<attribute name="name" type="wstring" readonly="yes">
9659	<desc>
9660	Human readable description of this format.
9661
9662	Mainly for use in file open dialogs.
9663	</desc>
9664	</attribute>
9665
9666	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
9667	<desc>
9668	Array of strings containing the supported file extensions.
9669
9670	The first extension in the array is the extension preferred by the
9671	backend. It is recommended to use this extension when specifying a
9672	location of the storage unit for a new medium.
9673
9674	Note that some backends do not work on files, so this array may be
9675	empty.
9676
9677	<see>IMediumFormat::capabilities</see>
9678	</desc>
9679	</attribute>
9680
9681	<attribute name="capabilities" type="unsigned long" readonly="yes">
9682	<desc>
9683	Capabilities of the format as a set of bit flags.
9684
9685	For the meaning of individual capability flags see
9686	<link to="MediumFormatCapabilities"/>.
9687	</desc>
9688	</attribute>
9689
9690	<method name="describeProperties">
9691	<desc>
9692	Returns several arrays describing the properties supported by this
9693	format.
9694
9695	An element with the given index in each array describes one
9696	property. Thus, the number of elements in each returned array is the
9697	same and corresponds to the number of supported properties.
9698
9699	The returned arrays are filled in only if the
9700	<link to="MediumFormatCapabilities_Properties"/> flag is set.
9701	All arguments must be non-@c null.
9702
9703	<see>DataType</see>
9704	<see>DataFlags</see>
9705	</desc>
9706
9707	<param name="names" type="wstring" safearray="yes" dir="out">
9708	<desc>Array of property names.</desc>
9709	</param>
9710	<param name="description" type="wstring" safearray="yes" dir="out">
9711	<desc>Array of property descriptions.</desc>
9712	</param>
9713	<param name="types" type="DataType" safearray="yes" dir="out">
9714	<desc>Array of property types.</desc>
9715	</param>
9716	<param name="flags" type="unsigned long" safearray="yes" dir="out">
9717	<desc>Array of property flags.</desc>
9718	</param>
9719	<param name="defaults" type="wstring" safearray="yes" dir="out">
9720	<desc>Array of default property values.</desc>
9721	</param>
9722	</method>
9723
9724	</interface>
9725
9726
9727	<!--
9728	// IKeyboard
9729	/////////////////////////////////////////////////////////////////////////
9730	-->
9731
9732	<interface
9733	name="IKeyboard" extends="$unknown"
9734	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
9735	wsmap="managed"
9736	>
9737	<desc>
9738	The IKeyboard interface represents the virtual machine's keyboard. Used
9739	in <link to="IConsole::keyboard"/>.
9740
9741	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
9742	to the virtual machine.
9743
9744	</desc>
9745	<method name="putScancode">
9746	<desc>Sends a scancode to the keyboard.
9747
9748	<result name="VBOX_E_IPRT_ERROR">
9749	Could not send scan code to virtual keyboard.
9750	</result>
9751
9752	</desc>
9753	<param name="scancode" type="long" dir="in"/>
9754	</method>
9755
9756	<method name="putScancodes">
9757	<desc>Sends an array of scancodes to the keyboard.
9758
9759	<result name="VBOX_E_IPRT_ERROR">
9760	Could not send all scan codes to virtual keyboard.
9761	</result>
9762
9763	</desc>
9764	<param name="scancodes" type="long" dir="in" safearray="yes"/>
9765	<param name="codesStored" type="unsigned long" dir="return"/>
9766	</method>
9767
9768	<method name="putCAD">
9769	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
9770	function is nothing special, it is just a convenience function
9771	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
9772
9773	<result name="VBOX_E_IPRT_ERROR">
9774	Could not send all scan codes to virtual keyboard.
9775	</result>
9776
9777	</desc>
9778	</method>
9779
9780	</interface>
9781
9782
9783	<!--
9784	// IMouse
9785	/////////////////////////////////////////////////////////////////////////
9786	-->
9787
9788	<enum
9789	name="MouseButtonState"
9790	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
9791	>
9792	<desc>
9793	Mouse button state.
9794	</desc>
9795
9796	<const name="LeftButton" value="0x01"/>
9797	<const name="RightButton" value="0x02"/>
9798	<const name="MiddleButton" value="0x04"/>
9799	<const name="WheelUp" value="0x08"/>
9800	<const name="WheelDown" value="0x10"/>
9801	<const name="XButton1" value="0x20"/>
9802	<const name="XButton2" value="0x40"/>
9803	<const name="MouseStateMask" value="0x7F"/>
9804	</enum>
9805
9806	<interface
9807	name="IMouse" extends="$unknown"
9808	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
9809	wsmap="managed"
9810	>
9811	<desc>
9812	The IMouse interface represents the virtual machine's mouse. Used in
9813	<link to="IConsole::mouse"/>.
9814
9815	Through this interface, the virtual machine's virtual mouse can be
9816	controlled.
9817	</desc>
9818
9819	<attribute name="absoluteSupported" type="boolean" readonly="yes">
9820	<desc>
9821	Whether the guest OS supports absolute mouse pointer positioning
9822	or not.
9823	<note>
9824	VirtualBox Guest Tools need to be installed to the guest OS
9825	in order to enable absolute mouse positioning support.
9826	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
9827	callback to be instantly informed about changes of this attribute
9828	during virtual machine execution.
9829	</note>
9830	<see><link to="#putMouseEventAbsolute"/></see>
9831	</desc>
9832	</attribute>
9833
9834	<method name="putMouseEvent">
9835	<desc>
9836	Initiates a mouse event using relative pointer movements
9837	along x and y axis.
9838
9839	<result name="E_ACCESSDENIED">
9840	Console not powered up.
9841	</result>
9842	<result name="VBOX_E_IPRT_ERROR">
9843	Could not send mouse event to virtual mouse.
9844	</result>
9845
9846	</desc>
9847
9848	<param name="dx" type="long" dir="in">
9849	<desc>
9850	Amount of pixels the mouse should move to the right.
9851	Negative values move the mouse to the left.
9852	</desc>
9853	</param>
9854	<param name="dy" type="long" dir="in">
9855	<desc>
9856	Amount of pixels the mouse should move downwards.
9857	Negative values move the mouse upwards.
9858	</desc>
9859	</param>
9860	<param name="dz" type="long" dir="in">
9861	<desc>
9862	Amount of mouse wheel moves.
9863	Positive values describe clockwise wheel rotations,
9864	negative values describe counterclockwise rotations.
9865	</desc>
9866	</param>
9867	<param name="dw" type="long" dir="in">
9868	<desc>
9869	Amount of horizontal mouse wheel moves.
9870	Positive values describe a movement to the left,
9871	negative values describe a movement to the right.
9872	</desc>
9873	</param>
9874	<param name="buttonState" type="long" dir="in">
9875	<desc>
9876	The current state of mouse buttons. Every bit represents
9877	a mouse button as follows:
9878	<table>
9879	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9880	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9881	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9882	</table>
9883	A value of <tt>1</tt> means the corresponding button is pressed.
9884	otherwise it is released.
9885	</desc>
9886	</param>
9887	</method>
9888
9889	<method name="putMouseEventAbsolute">
9890	<desc>
9891	Positions the mouse pointer using absolute x and y coordinates.
9892	These coordinates are expressed in pixels and
9893	start from <tt>[1,1]</tt> which corresponds to the top left
9894	corner of the virtual display.
9895
9896	<result name="E_ACCESSDENIED">
9897	Console not powered up.
9898	</result>
9899	<result name="VBOX_E_IPRT_ERROR">
9900	Could not send mouse event to virtual mouse.
9901	</result>
9902
9903	<note>
9904	This method will have effect only if absolute mouse
9905	positioning is supported by the guest OS.
9906	</note>
9907
9908	<see><link to="#absoluteSupported"/></see>
9909	</desc>
9910
9911	<param name="x" type="long" dir="in">
9912	<desc>
9913	X coordinate of the pointer in pixels, starting from @c 1.
9914	</desc>
9915	</param>
9916	<param name="y" type="long" dir="in">
9917	<desc>
9918	Y coordinate of the pointer in pixels, starting from @c 1.
9919	</desc>
9920	</param>
9921	<param name="dz" type="long" dir="in">
9922	<desc>
9923	Amount of mouse wheel moves.
9924	Positive values describe clockwise wheel rotations,
9925	negative values describe counterclockwise rotations.
9926	</desc>
9927	</param>
9928	<param name="dw" type="long" dir="in">
9929	<desc>
9930	Amount of horizontal mouse wheel moves.
9931	Positive values describe a movement to the left,
9932	negative values describe a movement to the right.
9933	</desc>
9934	</param>
9935	<param name="buttonState" type="long" dir="in">
9936	<desc>
9937	The current state of mouse buttons. Every bit represents
9938	a mouse button as follows:
9939	<table>
9940	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9941	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9942	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9943	</table>
9944	A value of @c 1 means the corresponding button is pressed.
9945	otherwise it is released.
9946	</desc>
9947	</param>
9948	</method>
9949
9950	</interface>
9951
9952	<!--
9953	// IDisplay
9954	/////////////////////////////////////////////////////////////////////////
9955	-->
9956
9957	<enum
9958	name="FramebufferPixelFormat"
9959	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
9960	>
9961	<desc>
9962	Format of the video memory buffer. Constants represented by this enum can
9963	be used to test for particular values of <link
9964	to="IFramebuffer::pixelFormat"/>. See also <link
9965	to="IFramebuffer::requestResize"/>.
9966
9967	See also www.fourcc.org for more information about FOURCC pixel formats.
9968	</desc>
9969
9970	<const name="Opaque" value="0">
9971	<desc>
9972	Unknown buffer format (the user may not assume any particular format of
9973	the buffer).
9974	</desc>
9975	</const>
9976	<const name="FOURCC_RGB" value="0x32424752">
9977	<desc>
9978	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
9979	bit layout).
9980	</desc>
9981	</const>
9982	</enum>
9983
9984	<interface
9985	name="IFramebuffer" extends="$unknown"
9986	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
9987	wsmap="suppress"
9988	>
9989	<attribute name="address" type="octet" mod="ptr" readonly="yes">
9990	<desc>Address of the start byte of the frame buffer.</desc>
9991	</attribute>
9992
9993	<attribute name="width" type="unsigned long" readonly="yes">
9994	<desc>Frame buffer width, in pixels.</desc>
9995	</attribute>
9996
9997	<attribute name="height" type="unsigned long" readonly="yes">
9998	<desc>Frame buffer height, in pixels.</desc>
9999	</attribute>
10000
10001	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10002	<desc>
10003	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10004	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10005	are: 8, 15, 16, 24 and 32.
10006	</desc>
10007	</attribute>
10008
10009	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10010	<desc>
10011	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10012	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10013	size of the scan line must be aligned to 32 bits.
10014	</desc>
10015	</attribute>
10016
10017	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10018	<desc>
10019	Frame buffer pixel format. It's either one of the values defined by <link
10020	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10021	<note>
10022	This attribute must never return <link
10023	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10024	<link to="#address"/> points to must be always known.
10025	</note>
10026	</desc>
10027	</attribute>
10028
10029	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10030	<desc>
10031	Defines whether this frame buffer uses the virtual video card's memory
10032	buffer (guest VRAM) directly or not. See <link
10033	to="IFramebuffer::requestResize"/> for more information.
10034	</desc>
10035	</attribute>
10036
10037	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10038	<desc>
10039	Hint from the frame buffer about how much of the standard
10040	screen height it wants to use for itself. This information is
10041	exposed to the guest through the VESA BIOS and VMMDev interface
10042	so that it can use it for determining its video mode table. It
10043	is not guaranteed that the guest respects the value.
10044	</desc>
10045	</attribute>
10046
10047	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10048	<desc>
10049	An alpha-blended overlay which is superposed over the frame buffer.
10050	The initial purpose is to allow the display of icons providing
10051	information about the VM state, including disk activity, in front
10052	ends which do not have other means of doing that. The overlay is
10053	designed to controlled exclusively by IDisplay. It has no locking
10054	of its own, and any changes made to it are not guaranteed to be
10055	visible until the affected portion of IFramebuffer is updated. The
10056	overlay can be created lazily the first time it is requested. This
10057	attribute can also return @c null to signal that the overlay is not
10058	implemented.
10059	</desc>
10060	</attribute>
10061
10062	<attribute name="winId" type="unsigned long long" readonly="yes">
10063	<desc>
10064	Platform-dependent identifier of the window where context of this
10065	frame buffer is drawn, or zero if there's no such window.
10066	</desc>
10067	</attribute>
10068
10069	<method name="lock">
10070	<desc>
10071	Locks the frame buffer.
10072	Gets called by the IDisplay object where this frame buffer is
10073	bound to.
10074	</desc>
10075	</method>
10076
10077	<method name="unlock">
10078	<desc>
10079	Unlocks the frame buffer.
10080	Gets called by the IDisplay object where this frame buffer is
10081	bound to.
10082	</desc>
10083	</method>
10084
10085	<method name="notifyUpdate">
10086	<desc>
10087	Informs about an update.
10088	Gets called by the display object where this buffer is
10089	registered.
10090	</desc>
10091	<param name="x" type="unsigned long" dir="in"/>
10092	<param name="y" type="unsigned long" dir="in"/>
10093	<param name="width" type="unsigned long" dir="in"/>
10094	<param name="height" type="unsigned long" dir="in"/>
10095	</method>
10096
10097	<method name="requestResize">
10098	<desc>
10099	Requests a size and pixel format change.
10100
10101	There are two modes of working with the video buffer of the virtual
10102	machine. The <i>indirect</i> mode implies that the IFramebuffer
10103	implementation allocates a memory buffer for the requested display mode
10104	and provides it to the virtual machine. In <i>direct</i> mode, the
10105	IFramebuffer implementation uses the memory buffer allocated and owned
10106	by the virtual machine. This buffer represents the video memory of the
10107	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10108	usually faster because the implementation gets a raw pointer to the
10109	guest VRAM buffer which it can directly use for visualizing the contents
10110	of the virtual display, as opposed to the indirect mode where the
10111	contents of guest VRAM are copied to the memory buffer provided by
10112	the implementation every time a display update occurs.
10113
10114	It is important to note that the direct mode is really fast only when
10115	the implementation uses the given guest VRAM buffer directly, for
10116	example, by blitting it to the window representing the virtual machine's
10117	display, which saves at least one copy operation comparing to the
10118	indirect mode. However, using the guest VRAM buffer directly is not
10119	always possible: the format and the color depth of this buffer may be
10120	not supported by the target window, or it may be unknown (opaque) as in
10121	case of text or non-linear multi-plane VGA video modes. In this case,
10122	the indirect mode (that is always available) should be used as a
10123	fallback: when the guest VRAM contents are copied to the
10124	implementation-provided memory buffer, color and format conversion is
10125	done automatically by the underlying code.
10126
10127	The @a pixelFormat parameter defines whether the direct mode is
10128	available or not. If @a pixelFormat is <link
10129	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10130	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10131	@a bytesPerLine parameters must be ignored and the implementation must use
10132	the indirect mode (where it provides its own buffer in one of the
10133	supported formats). In all other cases, @a pixelFormat together with
10134	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10135	buffer pointed to by the @a VRAM parameter and the implementation is
10136	free to choose which mode to use. To indicate that this frame buffer uses
10137	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10138	attribute must return @c true and <link to="#address"/> must
10139	return exactly the same address that is passed in the @a VRAM parameter
10140	of this method; otherwise it is assumed that the indirect strategy is
10141	chosen.
10142
10143	The @a width and @a height parameters represent the size of the
10144	requested display mode in both modes. In case of indirect mode, the
10145	provided memory buffer should be big enough to store data of the given
10146	display mode. In case of direct mode, it is guaranteed that the given
10147	@a VRAM buffer contains enough space to represent the display mode of the
10148	given size. Note that this frame buffer's <link to="#width"/> and <link
10149	to="#height"/> attributes must return exactly the same values as
10150	passed to this method after the resize is completed (see below).
10151
10152	The @a finished output parameter determines if the implementation has
10153	finished resizing the frame buffer or not. If, for some reason, the
10154	resize cannot be finished immediately during this call, @a finished
10155	must be set to @c false, and the implementation must call
10156	<link to="IDisplay::resizeCompleted"/> after it has returned from
10157	this method as soon as possible. If @a finished is @c false, the
10158	machine will not call any frame buffer methods until
10159	<link to="IDisplay::resizeCompleted"/> is called.
10160
10161	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10162	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10163	this frame buffer must return exactly the same values as specified in the
10164	parameters of this method, after the resize is completed. If the
10165	indirect mode is chosen, these attributes must return values describing
10166	the format of the implementation's own memory buffer <link
10167	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10168	value must always correlate with <link to="#pixelFormat"/>. Note that
10169	the <link to="#pixelFormat"/> attribute must never return <link
10170	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10171
10172	<note>
10173	This method is called by the IDisplay object under the
10174	<link to="#lock"/> provided by this IFramebuffer
10175	implementation. If this method returns @c false in @a finished, then
10176	this lock is not released until
10177	<link to="IDisplay::resizeCompleted"/> is called.
10178	</note>
10179	</desc>
10180	<param name="screenId" type="unsigned long" dir="in">
10181	<desc>
10182	Logical screen number. Must be used in the corresponding call to
10183	<link to="IDisplay::resizeCompleted"/> if this call is made.
10184	</desc>
10185	</param>
10186	<param name="pixelFormat" type="unsigned long" dir="in">
10187	<desc>
10188	Pixel format of the memory buffer pointed to by @a VRAM.
10189	See also <link to="FramebufferPixelFormat"/>.
10190	</desc>
10191	</param>
10192	<param name="VRAM" type="octet" mod="ptr" dir="in">
10193	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10194	</param>
10195	<param name="bitsPerPixel" type="unsigned long" dir="in">
10196	<desc>Color depth, bits per pixel.</desc>
10197	</param>
10198	<param name="bytesPerLine" type="unsigned long" dir="in">
10199	<desc>Size of one scan line, in bytes.</desc>
10200	</param>
10201	<param name="width" type="unsigned long" dir="in">
10202	<desc>Width of the guest display, in pixels.</desc>
10203	</param>
10204	<param name="height" type="unsigned long" dir="in">
10205	<desc>Height of the guest display, in pixels.</desc>
10206	</param>
10207	<param name="finished" type="boolean" dir="return">
10208	<desc>
10209	Can the VM start using the new frame buffer immediately
10210	after this method returns or it should wait for
10211	<link to="IDisplay::resizeCompleted"/>.
10212	</desc>
10213	</param>
10214	</method>
10215
10216	<method name="videoModeSupported">
10217	<desc>
10218	Returns whether the frame buffer implementation is willing to
10219	support a given video mode. In case it is not able to render
10220	the video mode (or for some reason not willing), it should
10221	return @c false. Usually this method is called when the guest
10222	asks the VMM device whether a given video mode is supported
10223	so the information returned is directly exposed to the guest.
10224	It is important that this method returns very quickly.
10225	</desc>
10226	<param name="width" type="unsigned long" dir="in"/>
10227	<param name="height" type="unsigned long" dir="in"/>
10228	<param name="bpp" type="unsigned long" dir="in"/>
10229	<param name="supported" type="boolean" dir="return"/>
10230	</method>
10231
10232	<method name="getVisibleRegion">
10233	<desc>
10234	Returns the visible region of this frame buffer.
10235
10236	If the @a rectangles parameter is @c null then the value of the
10237	@a count parameter is ignored and the number of elements necessary to
10238	describe the current visible region is returned in @a countCopied.
10239
10240	If @a rectangles is not @c null but @a count is less
10241	than the required number of elements to store region data, the method
10242	will report a failure. If @a count is equal or greater than the
10243	required number of elements, then the actual number of elements copied
10244	to the provided array will be returned in @a countCopied.
10245
10246	<note>
10247	The address of the provided array must be in the process space of
10248	this IFramebuffer object.
10249	</note>
10250	<note>
10251	Method not yet implemented.
10252	</note>
10253	</desc>
10254	<param name="rectangles" type="octet" mod="ptr" dir="in">
10255	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10256	</param>
10257	<param name="count" type="unsigned long" dir="in">
10258	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10259	</param>
10260	<param name="countCopied" type="unsigned long" dir="return">
10261	<desc>Number of elements copied to the @a rectangles array.</desc>
10262	</param>
10263	</method>
10264
10265	<method name="setVisibleRegion">
10266	<desc>
10267	Suggests a new visible region to this frame buffer. This region
10268	represents the area of the VM display which is a union of regions of
10269	all top-level windows of the guest operating system running inside the
10270	VM (if the Guest Additions for this system support this
10271	functionality). This information may be used by the frontends to
10272	implement the seamless desktop integration feature.
10273
10274	<note>
10275	The address of the provided array must be in the process space of
10276	this IFramebuffer object.
10277	</note>
10278	<note>
10279	The IFramebuffer implementation must make a copy of the provided
10280	array of rectangles.
10281	</note>
10282	<note>
10283	Method not yet implemented.
10284	</note>
10285	</desc>
10286	<param name="rectangles" type="octet" mod="ptr" dir="in">
10287	<desc>Pointer to the @c RTRECT array.</desc>
10288	</param>
10289	<param name="count" type="unsigned long" dir="in">
10290	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10291	</param>
10292	</method>
10293
10294	<method name="processVHWACommand">
10295	<desc>
10296	Posts a Video HW Acceleration Command to the frame buffer for processing.
10297	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10298	are posted from quest to the host to be processed by the host hardware.
10299
10300	<note>
10301	The address of the provided command must be in the process space of
10302	this IFramebuffer object.
10303	</note>
10304	</desc>
10305
10306	<param name="command" type="octet" mod="ptr" dir="in">
10307	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10308	</param>
10309	</method>
10310
10311	</interface>
10312
10313	<interface
10314	name="IFramebufferOverlay" extends="IFramebuffer"
10315	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10316	wsmap="suppress"
10317	>
10318	<desc>
10319	The IFramebufferOverlay interface represents an alpha blended overlay
10320	for displaying status icons above an IFramebuffer. It is always created
10321	not visible, so that it must be explicitly shown. It only covers a
10322	portion of the IFramebuffer, determined by its width, height and
10323	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10324	that order) format, and may be written to directly. Do re-read the
10325	width though, after setting it, as it may be adjusted (increased) to
10326	make it more suitable for the front end.
10327	</desc>
10328	<attribute name="x" type="unsigned long" readonly="yes">
10329	<desc>X position of the overlay, relative to the frame buffer.</desc>
10330	</attribute>
10331
10332	<attribute name="y" type="unsigned long" readonly="yes">
10333	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10334	</attribute>
10335
10336	<attribute name="visible" type="boolean" readonly="no">
10337	<desc>
10338	Whether the overlay is currently visible.
10339	</desc>
10340	</attribute>
10341
10342	<attribute name="alpha" type="unsigned long" readonly="no">
10343	<desc>
10344	The global alpha value for the overlay. This may or may not be
10345	supported by a given front end.
10346	</desc>
10347	</attribute>
10348
10349	<method name="move">
10350	<desc>
10351	Changes the overlay's position relative to the IFramebuffer.
10352	</desc>
10353	<param name="x" type="unsigned long" dir="in"/>
10354	<param name="y" type="unsigned long" dir="in"/>
10355	</method>
10356
10357	</interface>
10358
10359	<interface
10360	name="IDisplay" extends="$unknown"
10361	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
10362	wsmap="managed"
10363	>
10364	<desc>
10365	The IDisplay interface represents the virtual machine's display.
10366
10367	The object implementing this interface is contained in each
10368	<link to="IConsole::display"/> attribute and represents the visual
10369	output of the virtual machine.
10370
10371	The virtual display supports pluggable output targets represented by the
10372	IFramebuffer interface. Examples of the output target are a window on
10373	the host computer or an RDP session's display on a remote computer.
10374	</desc>
10375	<attribute name="width" type="unsigned long" readonly="yes">
10376	<desc>Current display width.</desc>
10377	</attribute>
10378
10379	<attribute name="height" type="unsigned long" readonly="yes">
10380	<desc>Current display height.</desc>
10381	</attribute>
10382
10383	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10384	<desc>
10385	Current guest display color depth. Note that this may differ
10386	from <link to="IFramebuffer::bitsPerPixel"/>.
10387	</desc>
10388	</attribute>
10389
10390	<method name="setFramebuffer">
10391	<desc>
10392	Sets the framebuffer for given screen.
10393	</desc>
10394	<param name="screenId" type="unsigned long" dir="in"/>
10395	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10396	</method>
10397
10398	<method name="getFramebuffer">
10399	<desc>
10400	Queries the framebuffer for given screen.
10401	</desc>
10402	<param name="screenId" type="unsigned long" dir="in"/>
10403	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10404	<param name="xOrigin" type="long" dir="out"/>
10405	<param name="yOrigin" type="long" dir="out"/>
10406	</method>
10407
10408	<method name="setVideoModeHint">
10409	<desc>
10410	Asks VirtualBox to request the given video mode from
10411	the guest. This is just a hint and it cannot be guaranteed
10412	that the requested resolution will be used. Guest Additions
10413	are required for the request to be seen by guests. The caller
10414	should issue the request and wait for a resolution change and
10415	after a timeout retry.
10416
10417	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10418	parameters means that the corresponding values should be taken from the
10419	current video mode (i.e. left unchanged).
10420
10421	If the guest OS supports multi-monitor configuration then the @a display
10422	parameter specifies the number of the guest display to send the hint to:
10423	@c 0 is the primary display, @c 1 is the first secondary and
10424	so on. If the multi-monitor configuration is not supported, @a display
10425	must be @c 0.
10426
10427	<result name="E_INVALIDARG">
10428	The @a display is not associated with any monitor.
10429	</result>
10430
10431	</desc>
10432	<param name="width" type="unsigned long" dir="in"/>
10433	<param name="height" type="unsigned long" dir="in"/>
10434	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10435	<param name="display" type="unsigned long" dir="in"/>
10436	</method>
10437
10438	<method name="setSeamlessMode">
10439	<desc>
10440	Enables or disables seamless guest display rendering (seamless desktop
10441	integration) mode.
10442	<note>
10443	Calling this method has no effect if <link
10444	to="IGuest::supportsSeamless"/> returns @c false.
10445	</note>
10446	</desc>
10447	<param name="enabled" type="boolean" dir="in"/>
10448	</method>
10449
10450	<method name="takeScreenShot">
10451	<desc>
10452	Takes a screen shot of the requested size and copies it to the
10453	32-bpp buffer allocated by the caller and pointed to by @a address.
10454
10455	<note>This API can be used only by the COM/XPCOM C++ API as it
10456	requires pointer support. Use <link to="#takeScreenShotSlow" />
10457	with other language bindings.
10458	</note>
10459
10460	<result name="E_NOTIMPL">
10461	Feature not implemented.
10462	</result>
10463	<result name="VBOX_E_IPRT_ERROR">
10464	Could not take a screenshot.
10465	</result>
10466
10467	</desc>
10468	<param name="address" type="octet" mod="ptr" dir="in"/>
10469	<param name="width" type="unsigned long" dir="in"/>
10470	<param name="height" type="unsigned long" dir="in"/>
10471	</method>
10472
10473	<method name="takeScreenShotSlow">
10474	<desc>
10475	Takes a guest screen shot of the requested size and returns it as
10476	an array of bytes in uncompressed 32-bit ARGB format.
10477	This API is slow, but could be the only option to get guest screenshot
10478	for scriptable languages not allowed to manipulate with addresses
10479	directly.
10480
10481	<result name="E_NOTIMPL">
10482	Feature not implemented.
10483	</result>
10484	<result name="VBOX_E_IPRT_ERROR">
10485	Could not take a screenshot.
10486	</result>
10487	</desc>
10488	<param name="width" type="unsigned long" dir="in">
10489	<desc>
10490	Desired image width.
10491	</desc>
10492	</param>
10493	<param name="height" type="unsigned long" dir="in">
10494	<desc>
10495	Desired image height.
10496	</desc>
10497	</param>
10498	<param name="screenData" type="octet" dir="return" safearray="yes">
10499	<desc>
10500	Array with resulting screen data.
10501	</desc>
10502	</param>
10503	</method>
10504
10505	<method name="drawToScreen">
10506	<desc>
10507	Draws a 32-bpp image of the specified size from the given buffer
10508	to the given point on the VM display.
10509
10510	<result name="E_NOTIMPL">
10511	Feature not implemented.
10512	</result>
10513	<result name="VBOX_E_IPRT_ERROR">
10514	Could not draw to screen.
10515	</result>
10516
10517	</desc>
10518	<param name="address" type="octet" mod="ptr" dir="in"/>
10519	<param name="x" type="unsigned long" dir="in"/>
10520	<param name="y" type="unsigned long" dir="in"/>
10521	<param name="width" type="unsigned long" dir="in"/>
10522	<param name="height" type="unsigned long" dir="in"/>
10523	</method>
10524
10525	<method name="invalidateAndUpdate">
10526	<desc>
10527	Does a full invalidation of the VM display and instructs the VM
10528	to update it.
10529
10530	<result name="VBOX_E_IPRT_ERROR">
10531	Could not invalidate and update screen.
10532	</result>
10533
10534	</desc>
10535	</method>
10536
10537	<method name="resizeCompleted">
10538	<desc>
10539	Signals that a framebuffer has completed the resize operation.
10540
10541	<result name="VBOX_E_NOT_SUPPORTED">
10542	Operation only valid for external frame buffers.
10543	</result>
10544
10545	</desc>
10546	<param name="screenId" type="unsigned long" dir="in"/>
10547	</method>
10548
10549	<method name="updateCompleted">
10550	<desc>
10551	Signals that a framebuffer has completed the update operation.
10552
10553	<result name="VBOX_E_NOT_SUPPORTED">
10554	Operation only valid for external frame buffers.
10555	</result>
10556
10557	</desc>
10558	</method>
10559
10560	<method name="completeVHWACommand">
10561	<desc>
10562	Signals that the Video HW Acceleration command has completed.
10563	</desc>
10564
10565	<param name="command" type="octet" mod="ptr" dir="in">
10566	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
10567	</param>
10568	</method>
10569
10570	</interface>
10571
10572	<!--
10573	// INetworkAdapter
10574	/////////////////////////////////////////////////////////////////////////
10575	-->
10576
10577	<enum
10578	name="NetworkAttachmentType"
10579	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
10580	>
10581	<desc>
10582	Network attachment type.
10583	</desc>
10584
10585	<const name="Null" value="0">
10586	<desc>Null value, also means "not attached".</desc>
10587	</const>
10588	<const name="NAT" value="1"/>
10589	<const name="Bridged" value="2"/>
10590	<const name="Internal" value="3"/>
10591	<const name="HostOnly" value="4"/>
10592	</enum>
10593
10594	<enum
10595	name="NetworkAdapterType"
10596	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
10597	>
10598	<desc>
10599	Network adapter type.
10600	</desc>
10601
10602	<const name="Null" value="0">
10603	<desc>Null value (never used by the API).</desc>
10604	</const>
10605	<const name="Am79C970A" value="1">
10606	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
10607	</const>
10608	<const name="Am79C973" value="2">
10609	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
10610	</const>
10611	<const name="I82540EM" value="3">
10612	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
10613	</const>
10614	<const name="I82543GC" value="4">
10615	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
10616	</const>
10617	<const name="I82545EM" value="5">
10618	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
10619	</const>
10620	<const name="Virtio" value="6">
10621	<desc>Virtio network device.</desc>
10622	</const>
10623	</enum>
10624
10625	<interface
10626	name="INetworkAdapter" extends="$unknown"
10627	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
10628	wsmap="managed"
10629	>
10630	<desc>
10631	Represents a virtual network adapter that is attached to a virtual machine.
10632	Each virtual machine has a fixed number of network adapter slots with one
10633	instance of this attached to each of them. Call
10634	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
10635	is attached to a given slot in a given machine.
10636
10637	Each network adapter can be in one of five attachment modes, which are
10638	represented by the <link to="NetworkAttachmentType" /> enumeration;
10639	see the <link to="#attachmentType" /> attribute.
10640	</desc>
10641
10642	<attribute name="adapterType" type="NetworkAdapterType">
10643	<desc>
10644	Type of the virtual network adapter. Depending on this value,
10645	VirtualBox will provide a different virtual network hardware
10646	to the guest.
10647	</desc>
10648	</attribute>
10649
10650	<attribute name="slot" type="unsigned long" readonly="yes">
10651	<desc>
10652	Slot number this adapter is plugged into. Corresponds to
10653	the value you pass to <link to="IMachine::getNetworkAdapter"/>
10654	to obtain this instance.
10655	</desc>
10656	</attribute>
10657
10658	<attribute name="enabled" type="boolean">
10659	<desc>
10660	Flag whether the network adapter is present in the
10661	guest system. If disabled, the virtual guest hardware will
10662	not contain this network adapter. Can only be changed when
10663	the VM is not running.
10664	</desc>
10665	</attribute>
10666
10667	<attribute name="MACAddress" type="wstring">
10668	<desc>
10669	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
10670	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
10671	</desc>
10672	</attribute>
10673
10674	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
10675
10676	<attribute name="hostInterface" type="wstring">
10677	<desc>
10678	Name of the host network interface the VM is attached to.
10679	</desc>
10680	</attribute>
10681
10682	<attribute name="internalNetwork" type="wstring">
10683	<desc>
10684	Name of the internal network the VM is attached to.
10685	</desc>
10686	</attribute>
10687
10688	<attribute name="NATNetwork" type="wstring">
10689	<desc>
10690	Name of the NAT network the VM is attached to.
10691	</desc>
10692	</attribute>
10693
10694	<attribute name="cableConnected" type="boolean">
10695	<desc>
10696	Flag whether the adapter reports the cable as connected or not.
10697	It can be used to report offline situations to a VM.
10698	</desc>
10699	</attribute>
10700
10701	<attribute name="lineSpeed" type="unsigned long">
10702	<desc>
10703	Line speed reported by custom drivers, in units of 1 kbps.
10704	</desc>
10705	</attribute>
10706
10707	<attribute name="traceEnabled" type="boolean">
10708	<desc>
10709	Flag whether network traffic from/to the network card should be traced.
10710	Can only be toggled when the VM is turned off.
10711	</desc>
10712	</attribute>
10713
10714	<attribute name="traceFile" type="wstring">
10715	<desc>
10716	Filename where a network trace will be stored. If not set, VBox-pid.pcap
10717	will be used.
10718	</desc>
10719	</attribute>
10720
10721	<method name="attachToNAT">
10722	<desc>
10723	Attach the network adapter to the Network Address Translation (NAT) interface.
10724	</desc>
10725	</method>
10726
10727	<method name="attachToBridgedInterface">
10728	<desc>
10729	Attach the network adapter to a bridged host interface.
10730	</desc>
10731	</method>
10732
10733	<method name="attachToInternalNetwork">
10734	<desc>
10735	Attach the network adapter to an internal network.
10736	</desc>
10737	</method>
10738
10739	<method name="attachToHostOnlyInterface">
10740	<desc>
10741	Attach the network adapter to the host-only network.
10742	</desc>
10743	</method>
10744
10745	<method name="detach">
10746	<desc>
10747	Detach the network adapter
10748	</desc>
10749	</method>
10750	</interface>
10751
10752
10753	<!--
10754	// ISerialPort
10755	/////////////////////////////////////////////////////////////////////////
10756	-->
10757
10758	<enum
10759	name="PortMode"
10760	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
10761	>
10762	<desc>
10763	The PortMode enumeration represents possible communication modes for
10764	the virtual serial port device.
10765	</desc>
10766
10767	<const name="Disconnected" value="0">
10768	<desc>Virtual device is not attached to any real host device.</desc>
10769	</const>
10770	<const name="HostPipe" value="1">
10771	<desc>Virtual device is attached to a host pipe.</desc>
10772	</const>
10773	<const name="HostDevice" value="2">
10774	<desc>Virtual device is attached to a host device.</desc>
10775	</const>
10776	<const name="RawFile" value="3">
10777	<desc>Virtual device is attached to a raw file.</desc>
10778	</const>
10779	</enum>
10780
10781	<interface
10782	name="ISerialPort" extends="$unknown"
10783	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
10784	wsmap="managed"
10785	>
10786
10787	<desc>
10788	The ISerialPort interface represents the virtual serial port device.
10789
10790	The virtual serial port device acts like an ordinary serial port
10791	inside the virtual machine. This device communicates to the real
10792	serial port hardware in one of two modes: host pipe or host device.
10793
10794	In host pipe mode, the #path attribute specifies the path to the pipe on
10795	the host computer that represents a serial port. The #server attribute
10796	determines if this pipe is created by the virtual machine process at
10797	machine startup or it must already exist before starting machine
10798	execution.
10799
10800	In host device mode, the #path attribute specifies the name of the
10801	serial port device on the host computer.
10802
10803	There is also a third communication mode: the disconnected mode. In this
10804	mode, the guest OS running inside the virtual machine will be able to
10805	detect the serial port, but all port write operations will be discarded
10806	and all port read operations will return no data.
10807
10808	<see>IMachine::getSerialPort</see>
10809	</desc>
10810
10811	<attribute name="slot" type="unsigned long" readonly="yes">
10812	<desc>
10813	Slot number this serial port is plugged into. Corresponds to
10814	the value you pass to <link to="IMachine::getSerialPort"/>
10815	to obtain this instance.
10816	</desc>
10817	</attribute>
10818
10819	<attribute name="enabled" type="boolean">
10820	<desc>
10821	Flag whether the serial port is enabled. If disabled,
10822	the serial port will not be reported to the guest OS.
10823	</desc>
10824	</attribute>
10825
10826	<attribute name="IOBase" type="unsigned long">
10827	<desc>Base I/O address of the serial port.</desc>
10828	</attribute>
10829
10830	<attribute name="IRQ" type="unsigned long">
10831	<desc>IRQ number of the serial port.</desc>
10832	</attribute>
10833
10834	<attribute name="hostMode" type="PortMode">
10835	<desc>
10836	How is this port connected to the host.
10837	<note>
10838	Changing this attribute may fail if the conditions for
10839	<link to="#path"/> are not met.
10840	</note>
10841	</desc>
10842	</attribute>
10843
10844	<attribute name="server" type="boolean">
10845	<desc>
10846	Flag whether this serial port acts as a server (creates a new pipe on
10847	the host) or as a client (uses the existing pipe). This attribute is
10848	used only when <link to="#hostMode"/> is PortMode_HostPipe.
10849	</desc>
10850	</attribute>
10851
10852	<attribute name="path" type="wstring">
10853	<desc>
10854	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
10855	PortMode_HostPipe, or the host serial device name when
10856	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
10857	cases, setting a @c null or empty string as the attribute's value
10858	is an error. Otherwise, the value of this property is ignored.
10859	</desc>
10860	</attribute>
10861
10862	</interface>
10863
10864	<!--
10865	// IParallelPort
10866	/////////////////////////////////////////////////////////////////////////
10867	-->
10868
10869	<interface
10870	name="IParallelPort" extends="$unknown"
10871	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
10872	wsmap="managed"
10873	>
10874
10875	<desc>
10876	The IParallelPort interface represents the virtual parallel port device.
10877
10878	The virtual parallel port device acts like an ordinary parallel port
10879	inside the virtual machine. This device communicates to the real
10880	parallel port hardware using the name of the parallel device on the host
10881	computer specified in the #path attribute.
10882
10883	Each virtual parallel port device is assigned a base I/O address and an
10884	IRQ number that will be reported to the guest operating system and used
10885	to operate the given parallel port from within the virtual machine.
10886
10887	<see>IMachine::getParallelPort</see>
10888	</desc>
10889
10890	<attribute name="slot" type="unsigned long" readonly="yes">
10891	<desc>
10892	Slot number this parallel port is plugged into. Corresponds to
10893	the value you pass to <link to="IMachine::getParallelPort"/>
10894	to obtain this instance.
10895	</desc>
10896	</attribute>
10897
10898	<attribute name="enabled" type="boolean">
10899	<desc>
10900	Flag whether the parallel port is enabled. If disabled,
10901	the parallel port will not be reported to the guest OS.
10902	</desc>
10903	</attribute>
10904
10905	<attribute name="IOBase" type="unsigned long">
10906	<desc>Base I/O address of the parallel port.</desc>
10907	</attribute>
10908
10909	<attribute name="IRQ" type="unsigned long">
10910	<desc>IRQ number of the parallel port.</desc>
10911	</attribute>
10912
10913	<attribute name="path" type="wstring">
10914	<desc>
10915	Host parallel device name. If this parallel port is enabled, setting a
10916	@c null or an empty string as this attribute's value will result into
10917	an error.
10918	</desc>
10919	</attribute>
10920
10921	</interface>
10922
10923
10924	<!--
10925	// IMachineDebugger
10926	/////////////////////////////////////////////////////////////////////////
10927	-->
10928
10929	<interface
10930	name="IMachineDebugger" extends="$unknown"
10931	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
10932	wsmap="suppress"
10933	>
10934	<method name="resetStats">
10935	<desc>
10936	Reset VM statistics.
10937	</desc>
10938	<param name="pattern" type="wstring" dir="in">
10939	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10940	</param>
10941	</method>
10942
10943	<method name="dumpStats">
10944	<desc>
10945	Dumps VM statistics.
10946	</desc>
10947	<param name="pattern" type="wstring" dir="in">
10948	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10949	</param>
10950	</method>
10951
10952	<method name="getStats">
10953	<desc>
10954	Get the VM statistics in a XMLish format.
10955	</desc>
10956	<param name="pattern" type="wstring" dir="in">
10957	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10958	</param>
10959	<param name="withDescriptions" type="boolean" dir="in">
10960	<desc>Whether to include the descriptions.</desc>
10961	</param>
10962	<param name="stats" type="wstring" dir="out">
10963	<desc>The XML document containing the statistics.</desc>
10964	</param>
10965	</method>
10966
10967	<method name="injectNMI">
10968	<desc>
10969	Inject an NMI into a running VT-x/AMD-V VM.
10970	</desc>
10971	</method>
10972
10973	<attribute name="singlestep" type="boolean">
10974	<desc>Switch for enabling singlestepping.</desc>
10975	</attribute>
10976
10977	<attribute name="recompileUser" type="boolean">
10978	<desc>Switch for forcing code recompilation for user mode code.</desc>
10979	</attribute>
10980
10981	<attribute name="recompileSupervisor" type="boolean">
10982	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
10983	</attribute>
10984
10985	<attribute name="PATMEnabled" type="boolean">
10986	<desc>Switch for enabling and disabling the PATM component.</desc>
10987	</attribute>
10988
10989	<attribute name="CSAMEnabled" type="boolean">
10990	<desc>Switch for enabling and disabling the CSAM component.</desc>
10991	</attribute>
10992
10993	<attribute name="logEnabled" type="boolean">
10994	<desc>Switch for enabling and disabling logging.</desc>
10995	</attribute>
10996
10997	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
10998	<desc>
10999	Flag indicating whether the VM is currently making use of CPU hardware
11000	virtualization extensions.
11001	</desc>
11002	</attribute>
11003
11004	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11005	<desc>
11006	Flag indicating whether the VM is currently making use of the nested paging
11007	CPU hardware virtualization extension.
11008	</desc>
11009	</attribute>
11010
11011	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11012	<desc>
11013	Flag indicating whether the VM is currently making use of the VPID
11014	VT-x extension.
11015	</desc>
11016	</attribute>
11017
11018	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11019	<desc>
11020	Flag indicating whether the VM is currently making use of the Physical
11021	Address Extension CPU feature.
11022	</desc>
11023	</attribute>
11024
11025	<attribute name="virtualTimeRate" type="unsigned long">
11026	<desc>
11027	The rate at which the virtual time runs expressed as a percentage.
11028	The accepted range is 2% to 20000%.
11029	</desc>
11030	</attribute>
11031
11032	<!-- @todo method for setting log flags, groups and destination! -->
11033
11034	<attribute name="VM" type="unsigned long long" readonly="yes">
11035	<desc>
11036	Gets the VM handle. This is only for internal use while
11037	we carve the details of this interface.
11038	</desc>
11039	</attribute>
11040
11041	</interface>
11042
11043	<!--
11044	// IUSBController
11045	/////////////////////////////////////////////////////////////////////////
11046	-->
11047
11048	<interface
11049	name="IUSBController" extends="$unknown"
11050	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11051	wsmap="managed"
11052	>
11053	<attribute name="enabled" type="boolean">
11054	<desc>
11055	Flag whether the USB controller is present in the
11056	guest system. If disabled, the virtual guest hardware will
11057	not contain any USB controller. Can only be changed when
11058	the VM is powered off.
11059	</desc>
11060	</attribute>
11061
11062	<attribute name="enabledEhci" type="boolean">
11063	<desc>
11064	Flag whether the USB EHCI controller is present in the
11065	guest system. If disabled, the virtual guest hardware will
11066	not contain a USB EHCI controller. Can only be changed when
11067	the VM is powered off.
11068	</desc>
11069	</attribute>
11070
11071	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11072	<desc>
11073	USB standard version which the controller implements.
11074	This is a BCD which means that the major version is in the
11075	high byte and minor version is in the low byte.
11076	</desc>
11077	</attribute>
11078
11079	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11080	<desc>
11081	List of USB device filters associated with the machine.
11082
11083	If the machine is currently running, these filters are activated
11084	every time a new (supported) USB device is attached to the host
11085	computer that was not ignored by global filters
11086	(<link to="IHost::USBDeviceFilters"/>).
11087
11088	These filters are also activated when the machine is powered up.
11089	They are run against a list of all currently available USB
11090	devices (in states
11091	<link to="USBDeviceState_Available"/>,
11092	<link to="USBDeviceState_Busy"/>,
11093	<link to="USBDeviceState_Held"/>) that were not previously
11094	ignored by global filters.
11095
11096	If at least one filter matches the USB device in question, this
11097	device is automatically captured (attached to) the virtual USB
11098	controller of this machine.
11099
11100	<see>IUSBDeviceFilter, ::IUSBController</see>
11101	</desc>
11102	</attribute>
11103
11104	<method name="createDeviceFilter">
11105	<desc>
11106	Creates a new USB device filter. All attributes except
11107	the filter name are set to empty (any match),
11108	<i>active</i> is @c false (the filter is not active).
11109
11110	The created filter can then be added to the list of filters using
11111	<link to="#insertDeviceFilter"/>.
11112
11113	<result name="VBOX_E_INVALID_VM_STATE">
11114	The virtual machine is not mutable.
11115	</result>
11116
11117	<see>#deviceFilters</see>
11118	</desc>
11119	<param name="name" type="wstring" dir="in">
11120	<desc>
11121	Filter name. See <link to="IUSBDeviceFilter::name"/>
11122	for more info.
11123	</desc>
11124	</param>
11125	<param name="filter" type="IUSBDeviceFilter" dir="return">
11126	<desc>Created filter object.</desc>
11127	</param>
11128	</method>
11129
11130	<method name="insertDeviceFilter">
11131	<desc>
11132	Inserts the given USB device to the specified position
11133	in the list of filters.
11134
11135	Positions are numbered starting from <tt>0</tt>. If the specified
11136	position is equal to or greater than the number of elements in
11137	the list, the filter is added to the end of the collection.
11138
11139	<note>
11140	Duplicates are not allowed, so an attempt to insert a
11141	filter that is already in the collection, will return an
11142	error.
11143	</note>
11144
11145	<result name="VBOX_E_INVALID_VM_STATE">
11146	Virtual machine is not mutable.
11147	</result>
11148	<result name="E_INVALIDARG">
11149	USB device filter not created within this VirtualBox instance.
11150	</result>
11151	<result name="VBOX_E_INVALID_OBJECT_STATE">
11152	USB device filter already in list.
11153	</result>
11154
11155	<see>#deviceFilters</see>
11156	</desc>
11157	<param name="position" type="unsigned long" dir="in">
11158	<desc>Position to insert the filter to.</desc>
11159	</param>
11160	<param name="filter" type="IUSBDeviceFilter" dir="in">
11161	<desc>USB device filter to insert.</desc>
11162	</param>
11163	</method>
11164
11165	<method name="removeDeviceFilter">
11166	<desc>
11167	Removes a USB device filter from the specified position in the
11168	list of filters.
11169
11170	Positions are numbered starting from <tt>0</tt>. Specifying a
11171	position equal to or greater than the number of elements in
11172	the list will produce an error.
11173
11174	<see>#deviceFilters</see>
11175
11176	<result name="VBOX_E_INVALID_VM_STATE">
11177	Virtual machine is not mutable.
11178	</result>
11179	<result name="E_INVALIDARG">
11180	USB device filter list empty or invalid @a position.
11181	</result>
11182
11183	</desc>
11184	<param name="position" type="unsigned long" dir="in">
11185	<desc>Position to remove the filter from.</desc>
11186	</param>
11187	<param name="filter" type="IUSBDeviceFilter" dir="return">
11188	<desc>Removed USB device filter.</desc>
11189	</param>
11190	</method>
11191
11192	</interface>
11193
11194
11195	<!--
11196	// IUSBDevice
11197	/////////////////////////////////////////////////////////////////////////
11198	-->
11199
11200	<interface
11201	name="IUSBDevice" extends="$unknown"
11202	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11203	wsmap="managed"
11204	>
11205	<desc>
11206	The IUSBDevice interface represents a virtual USB device attached to the
11207	virtual machine.
11208
11209	A collection of objects implementing this interface is stored in the
11210	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11211	attached to a running virtual machine's USB controller.
11212	</desc>
11213
11214	<attribute name="id" type="uuid" mod="string" readonly="yes">
11215	<desc>
11216	Unique USB device ID. This ID is built from #vendorId,
11217	#productId, #revision and #serialNumber.
11218	</desc>
11219	</attribute>
11220
11221	<attribute name="vendorId" type="unsigned short" readonly="yes">
11222	<desc>Vendor ID.</desc>
11223	</attribute>
11224
11225	<attribute name="productId" type="unsigned short" readonly="yes">
11226	<desc>Product ID.</desc>
11227	</attribute>
11228
11229	<attribute name="revision" type="unsigned short" readonly="yes">
11230	<desc>
11231	Product revision number. This is a packed BCD represented as
11232	unsigned short. The high byte is the integer part and the low
11233	byte is the decimal.
11234	</desc>
11235	</attribute>
11236
11237	<attribute name="manufacturer" type="wstring" readonly="yes">
11238	<desc>Manufacturer string.</desc>
11239	</attribute>
11240
11241	<attribute name="product" type="wstring" readonly="yes">
11242	<desc>Product string.</desc>
11243	</attribute>
11244
11245	<attribute name="serialNumber" type="wstring" readonly="yes">
11246	<desc>Serial number string.</desc>
11247	</attribute>
11248
11249	<attribute name="address" type="wstring" readonly="yes">
11250	<desc>Host specific address of the device.</desc>
11251	</attribute>
11252
11253	<attribute name="port" type="unsigned short" readonly="yes">
11254	<desc>
11255	Host USB port number the device is physically
11256	connected to.
11257	</desc>
11258	</attribute>
11259
11260	<attribute name="version" type="unsigned short" readonly="yes">
11261	<desc>
11262	The major USB version of the device - 1 or 2.
11263	</desc>
11264	</attribute>
11265
11266	<attribute name="portVersion" type="unsigned short" readonly="yes">
11267	<desc>
11268	The major USB version of the host USB port the device is
11269	physically connected to - 1 or 2. For devices not connected to
11270	anything this will have the same value as the version attribute.
11271	</desc>
11272	</attribute>
11273
11274	<attribute name="remote" type="boolean" readonly="yes">
11275	<desc>
11276	Whether the device is physically connected to a remote VRDP
11277	client or to a local host machine.
11278	</desc>
11279	</attribute>
11280
11281	</interface>
11282
11283
11284	<!--
11285	// IUSBDeviceFilter
11286	/////////////////////////////////////////////////////////////////////////
11287	-->
11288
11289	<interface
11290	name="IUSBDeviceFilter" extends="$unknown"
11291	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11292	wsmap="managed"
11293	>
11294	<desc>
11295	The IUSBDeviceFilter interface represents an USB device filter used
11296	to perform actions on a group of USB devices.
11297
11298	This type of filters is used by running virtual machines to
11299	automatically capture selected USB devices once they are physically
11300	attached to the host computer.
11301
11302	A USB device is matched to the given device filter if and only if all
11303	attributes of the device match the corresponding attributes of the
11304	filter (that is, attributes are joined together using the logical AND
11305	operation). On the other hand, all together, filters in the list of
11306	filters carry the semantics of the logical OR operation. So if it is
11307	desirable to create a match like "this vendor id OR this product id",
11308	one needs to create two filters and specify "any match" (see below)
11309	for unused attributes.
11310
11311	All filter attributes used for matching are strings. Each string
11312	is an expression representing a set of values of the corresponding
11313	device attribute, that will match the given filter. Currently, the
11314	following filtering expressions are supported:
11315
11316	<ul>
11317	<li><i>Interval filters</i>. Used to specify valid intervals for
11318	integer device attributes (Vendor ID, Product ID and Revision).
11319	The format of the string is:
11320
11321	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11322
11323	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11324	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11325	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11326	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11327	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11328	possible integer is assumed.
11329	</li>
11330	<li><i>Boolean filters</i>. Used to specify acceptable values for
11331	boolean device attributes. The format of the string is:
11332
11333	<tt>true\|false\|yes\|no\|0\|1</tt>
11334
11335	</li>
11336	<li><i>Exact match</i>. Used to specify a single value for the given
11337	device attribute. Any string that doesn't start with <tt>int:</tt>
11338	represents the exact match. String device attributes are compared to
11339	this string including case of symbols. Integer attributes are first
11340	converted to a string (see individual filter attributes) and then
11341	compared ignoring case.
11342
11343	</li>
11344	<li><i>Any match</i>. Any value of the corresponding device attribute
11345	will match the given filter. An empty or @c null string is
11346	used to construct this type of filtering expressions.
11347
11348	</li>
11349	</ul>
11350
11351	<note>
11352	On the Windows host platform, interval filters are not currently
11353	available. Also all string filter attributes
11354	(<link to="#manufacturer"/>, <link to="#product"/>,
11355	<link to="#serialNumber"/>) are ignored, so they behave as
11356	<i>any match</i> no matter what string expression is specified.
11357	</note>
11358
11359	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11360	</desc>
11361
11362	<attribute name="name" type="wstring">
11363	<desc>
11364	Visible name for this filter.
11365	This name is used to visually distinguish one filter from another,
11366	so it can neither be @c null nor an empty string.
11367	</desc>
11368	</attribute>
11369
11370	<attribute name="active" type="boolean">
11371	<desc>Whether this filter active or has been temporarily disabled.</desc>
11372	</attribute>
11373
11374	<attribute name="vendorId" type="wstring">
11375	<desc>
11376	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11377	The string representation for the <i>exact matching</i>
11378	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11379	(including leading zeroes).
11380	</desc>
11381	</attribute>
11382
11383	<attribute name="productId" type="wstring">
11384	<desc>
11385	<link to="IUSBDevice::productId">Product ID</link> filter.
11386	The string representation for the <i>exact matching</i>
11387	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11388	(including leading zeroes).
11389	</desc>
11390	</attribute>
11391
11392	<attribute name="revision" type="wstring">
11393	<desc>
11394	<link to="IUSBDevice::productId">Product revision number</link>
11395	filter. The string representation for the <i>exact matching</i>
11396	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11397	of the integer part of the revision, and <tt>F</tt> is the
11398	decimal digit of its fractional part (including leading and
11399	trailing zeros).
11400	Note that for interval filters, it's best to use the hexadecimal
11401	form, because the revision is stored as a 16 bit packed BCD value;
11402	so the expression <tt>int:0x0100-0x0199</tt> will match any
11403	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11404	</desc>
11405	</attribute>
11406
11407	<attribute name="manufacturer" type="wstring">
11408	<desc>
11409	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11410	</desc>
11411	</attribute>
11412
11413	<attribute name="product" type="wstring">
11414	<desc>
11415	<link to="IUSBDevice::product">Product</link> filter.
11416	</desc>
11417	</attribute>
11418
11419	<attribute name="serialNumber" type="wstring">
11420	<desc>
11421	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11422	</desc>
11423	</attribute>
11424
11425	<attribute name="port" type="wstring">
11426	<desc>
11427	<link to="IUSBDevice::port">Host USB port</link> filter.
11428	</desc>
11429	</attribute>
11430
11431	<attribute name="remote" type="wstring">
11432	<desc>
11433	<link to="IUSBDevice::remote">Remote state</link> filter.
11434	<note>
11435	This filter makes sense only for machine USB filters,
11436	i.e. it is ignored by IHostUSBDeviceFilter objects.
11437	</note>
11438	</desc>
11439	</attribute>
11440
11441	<attribute name="maskedInterfaces" type="unsigned long">
11442	<desc>
11443	This is an advanced option for hiding one or more USB interfaces
11444	from the guest. The value is a bit mask where the bits that are set
11445	means the corresponding USB interface should be hidden, masked off
11446	if you like.
11447	This feature only works on Linux hosts.
11448	</desc>
11449	</attribute>
11450
11451	</interface>
11452
11453
11454	<!--
11455	// IHostUSBDevice
11456	/////////////////////////////////////////////////////////////////////////
11457	-->
11458
11459	<enum
11460	name="USBDeviceState"
11461	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11462	>
11463	<desc>
11464	USB device state. This enumeration represents all possible states
11465	of the USB device physically attached to the host computer regarding
11466	its state on the host computer and availability to guest computers
11467	(all currently running virtual machines).
11468
11469	Once a supported USB device is attached to the host, global USB
11470	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11471	either ignore the device, or put it to USBDeviceState_Held state, or do
11472	nothing. Unless the device is ignored by global filters, filters of all
11473	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11474	activated that can put it to USBDeviceState_Captured state.
11475
11476	If the device was ignored by global filters, or didn't match
11477	any filters at all (including guest ones), it is handled by the host
11478	in a normal way. In this case, the device state is determined by
11479	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11480	or USBDeviceState_Available, depending on the current device usage.
11481
11482	Besides auto-capturing based on filters, the device can be manually
11483	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11484	state is USBDeviceState_Busy, USBDeviceState_Available or
11485	USBDeviceState_Held.
11486
11487	<note>
11488	Due to differences in USB stack implementations in Linux and Win32,
11489	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11490	only to the Linux version of the product. This also means that (<link
11491	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11492	device state is USBDeviceState_Held.
11493	</note>
11494
11495	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11496	</desc>
11497
11498	<const name="NotSupported" value="0">
11499	<desc>
11500	Not supported by the VirtualBox server, not available to guests.
11501	</desc>
11502	</const>
11503	<const name="Unavailable" value="1">
11504	<desc>
11505	Being used by the host computer exclusively,
11506	not available to guests.
11507	</desc>
11508	</const>
11509	<const name="Busy" value="2">
11510	<desc>
11511	Being used by the host computer, potentially available to guests.
11512	</desc>
11513	</const>
11514	<const name="Available" value="3">
11515	<desc>
11516	Not used by the host computer, available to guests (the host computer
11517	can also start using the device at any time).
11518	</desc>
11519	</const>
11520	<const name="Held" value="4">
11521	<desc>
11522	Held by the VirtualBox server (ignored by the host computer),
11523	available to guests.
11524	</desc>
11525	</const>
11526	<const name="Captured" value="5">
11527	<desc>
11528	Captured by one of the guest computers, not available
11529	to anybody else.
11530	</desc>
11531	</const>
11532	</enum>
11533
11534	<interface
11535	name="IHostUSBDevice" extends="IUSBDevice"
11536	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
11537	wsmap="managed"
11538	>
11539	<desc>
11540	The IHostUSBDevice interface represents a physical USB device attached
11541	to the host computer.
11542
11543	Besides properties inherited from IUSBDevice, this interface adds the
11544	<link to="#state"/> property that holds the current state of the USB
11545	device.
11546
11547	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
11548	</desc>
11549
11550	<attribute name="state" type="USBDeviceState" readonly="yes">
11551	<desc>
11552	Current state of the device.
11553	</desc>
11554	</attribute>
11555
11556	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
11557
11558	</interface>
11559
11560
11561	<!--
11562	// IHostUSBDeviceFilter
11563	/////////////////////////////////////////////////////////////////////////
11564	-->
11565
11566	<enum
11567	name="USBDeviceFilterAction"
11568	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
11569	>
11570	<desc>
11571	Actions for host USB device filters.
11572	<see>IHostUSBDeviceFilter, USBDeviceState</see>
11573	</desc>
11574
11575	<const name="Null" value="0">
11576	<desc>Null value (never used by the API).</desc>
11577	</const>
11578	<const name="Ignore" value="1">
11579	<desc>Ignore the matched USB device.</desc>
11580	</const>
11581	<const name="Hold" value="2">
11582	<desc>Hold the matched USB device.</desc>
11583	</const>
11584	</enum>
11585
11586	<interface
11587	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
11588	uuid="4cc70246-d74a-400f-8222-3900489c0374"
11589	wsmap="managed"
11590	>
11591	<desc>
11592	The IHostUSBDeviceFilter interface represents a global filter for a
11593	physical USB device used by the host computer. Used indirectly in
11594	<link to="IHost::USBDeviceFilters"/>.
11595
11596	Using filters of this type, the host computer determines the initial
11597	state of the USB device after it is physically attached to the
11598	host's USB controller.
11599
11600	<note>
11601	The <link to="#remote"/> attribute is ignored by this type of
11602	filters, because it makes sense only for
11603	<link to="IUSBController::deviceFilters">machine USB filters</link>.
11604	</note>
11605
11606	<see>IHost::USBDeviceFilters</see>
11607	</desc>
11608
11609	<attribute name="action" type="USBDeviceFilterAction">
11610	<desc>
11611	Action performed by the host when an attached USB device
11612	matches this filter.
11613	</desc>
11614	</attribute>
11615
11616	</interface>
11617
11618	<!--
11619	// IAudioAdapter
11620	/////////////////////////////////////////////////////////////////////////
11621	-->
11622
11623	<enum
11624	name="AudioDriverType"
11625	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
11626	>
11627	<desc>
11628	Host audio driver type.
11629	</desc>
11630
11631	<const name="Null" value="0">
11632	<desc>Null value, also means "dummy audio driver".</desc>
11633	</const>
11634	<const name="WinMM" value="1">
11635	<desc>Windows multimedia (Windows hosts only).</desc>
11636	</const>
11637	<const name="OSS" value="2">
11638	<desc>Open Sound System (Linux hosts only).</desc>
11639	</const>
11640	<const name="ALSA" value="3">
11641	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
11642	</const>
11643	<const name="DirectSound" value="4">
11644	<desc>DirectSound (Windows hosts only).</desc>
11645	</const>
11646	<const name="CoreAudio" value="5">
11647	<desc>CoreAudio (Mac hosts only).</desc>
11648	</const>
11649	<const name="MMPM" value="6">
11650	<desc>Reserved for historical reasons.</desc>
11651	</const>
11652	<const name="Pulse" value="7">
11653	<desc>PulseAudio (Linux hosts only).</desc>
11654	</const>
11655	<const name="SolAudio" value="8">
11656	<desc>Solaris audio (Solaris hosts only).</desc>
11657	</const>
11658	</enum>
11659
11660	<enum
11661	name="AudioControllerType"
11662	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
11663	>
11664	<desc>
11665	Virtual audio controller type.
11666	</desc>
11667
11668	<const name="AC97" value="0"/>
11669	<const name="SB16" value="1"/>
11670	</enum>
11671
11672	<interface
11673	name="IAudioAdapter" extends="$unknown"
11674	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
11675	wsmap="managed"
11676	>
11677	<desc>
11678	The IAudioAdapter interface represents the virtual audio adapter of
11679	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
11680	</desc>
11681	<attribute name="enabled" type="boolean">
11682	<desc>
11683	Flag whether the audio adapter is present in the
11684	guest system. If disabled, the virtual guest hardware will
11685	not contain any audio adapter. Can only be changed when
11686	the VM is not running.
11687	</desc>
11688	</attribute>
11689	<attribute name="audioController" type="AudioControllerType">
11690	<desc>
11691	The audio hardware we emulate.
11692	</desc>
11693	</attribute>
11694	<attribute name="audioDriver" type="AudioDriverType">
11695	<desc>
11696	Audio driver the adapter is connected to. This setting
11697	can only be changed when the VM is not running.
11698	</desc>
11699	</attribute>
11700	</interface>
11701
11702	<!--
11703	// IVRDPServer
11704	/////////////////////////////////////////////////////////////////////////
11705	-->
11706
11707	<enum
11708	name="VRDPAuthType"
11709	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
11710	>
11711	<desc>
11712	VRDP authentication type.
11713	</desc>
11714
11715	<const name="Null" value="0">
11716	<desc>Null value, also means "no authentication".</desc>
11717	</const>
11718	<const name="External" value="1"/>
11719	<const name="Guest" value="2"/>
11720	</enum>
11721
11722	<interface
11723	name="IVRDPServer" extends="$unknown"
11724	uuid="f4584ae7-6bce-474b-83d6-17d235e6aa89"
11725	wsmap="managed"
11726	>
11727	<attribute name="enabled" type="boolean">
11728	<desc>VRDP server status.</desc>
11729	</attribute>
11730
11731	<attribute name="port" type="unsigned long">
11732	<desc>
11733	VRDP server port number.
11734	<note>
11735	Setting the value of this property to <tt>0</tt> will reset the port
11736	number to the default value which is
11737	currently <tt>3389</tt>. Reading this property will always return a
11738	real port number, even after it has been set to <tt>0</tt> (in which
11739	case the default port is returned).
11740	</note>
11741	</desc>
11742	</attribute>
11743
11744	<attribute name="netAddress" type="wstring">
11745	<desc>VRDP server address.</desc>
11746	</attribute>
11747
11748	<attribute name="authType" type="VRDPAuthType">
11749	<desc>VRDP authentication method.</desc>
11750	</attribute>
11751
11752	<attribute name="authTimeout" type="unsigned long">
11753	<desc>Timeout for guest authentication. Milliseconds.</desc>
11754	</attribute>
11755
11756	<attribute name="allowMultiConnection" type="boolean">
11757	<desc>
11758	Flag whether multiple simultaneous connections to the VM are permitted.
11759	Note that this will be replaced by a more powerful mechanism in the future.
11760	</desc>
11761	</attribute>
11762
11763	<attribute name="reuseSingleConnection" type="boolean">
11764	<desc>
11765	Flag whether the existing connection must be dropped and a new connection
11766	must be established by the VRDP server, when a new client connects in single
11767	connection mode.
11768	</desc>
11769	</attribute>
11770
11771	</interface>
11772
11773
11774	<!--
11775	// ISharedFolder
11776	/////////////////////////////////////////////////////////////////////////
11777	-->
11778
11779	<interface
11780	name="ISharedFolder" extends="$unknown"
11781	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
11782	wsmap="struct"
11783	>
11784	<desc>
11785	The ISharedFolder interface represents a folder in the host computer's
11786	file system accessible from the guest OS running inside a virtual
11787	machine using an associated logical name.
11788
11789	There are three types of shared folders:
11790	<ul>
11791	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
11792	folders available to all virtual machines.</li>
11793	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
11794	VM-specific shared folders available to the given virtual machine at
11795	startup.</li>
11796	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
11797	VM-specific shared folders created in the session context (for
11798	example, when the virtual machine is running) and automatically
11799	discarded when the session is closed (the VM is powered off).</li>
11800	</ul>
11801
11802	Logical names of shared folders must be unique within the given scope
11803	(global, permanent or transient). However, they do not need to be unique
11804	across scopes. In this case, the definition of the shared folder in a
11805	more specific scope takes precedence over definitions in all other
11806	scopes. The order of precedence is (more specific to more general):
11807	<ol>
11808	<li>Transient definitions</li>
11809	<li>Permanent definitions</li>
11810	<li>Global definitions</li>
11811	</ol>
11812
11813	For example, if MyMachine has a shared folder named
11814	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
11815	transient shared folder named <tt>C_DRIVE</tt> (that points
11816	to <tt>C:\\\\WINDOWS</tt>) will change the definition
11817	of <tt>C_DRIVE</tt> in the guest OS so
11818	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
11819	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
11820	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
11821	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
11822	to <tt>C:\\</tt> if it still exists.
11823
11824	Note that permanent and transient shared folders of different machines
11825	are in different name spaces, so they don't overlap and don't need to
11826	have unique logical names.
11827
11828	<note>
11829	Global shared folders are not implemented in the current version of the
11830	product.
11831	</note>
11832	</desc>
11833
11834	<attribute name="name" type="wstring" readonly="yes">
11835	<desc>Logical name of the shared folder.</desc>
11836	</attribute>
11837
11838	<attribute name="hostPath" type="wstring" readonly="yes">
11839	<desc>Full path to the shared folder in the host file system.</desc>
11840	</attribute>
11841
11842	<attribute name="accessible" type="boolean" readonly="yes">
11843	<desc>
11844	Whether the folder defined by the host path is currently
11845	accessible or not.
11846	For example, the folder can be unaccessible if it is placed
11847	on the network share that is not available by the time
11848	this property is read.
11849	</desc>
11850	</attribute>
11851
11852	<attribute name="writable" type="boolean" readonly="yes">
11853	<desc>
11854	Whether the folder defined by the host path is writable or
11855	not.
11856	</desc>
11857	</attribute>
11858
11859	<attribute name="lastAccessError" type="wstring" readonly="yes">
11860	<desc>
11861	Text message that represents the result of the last accessibility
11862	check.
11863
11864	Accessibility checks are performed each time the <link to="#accessible"/>
11865	attribute is read. An empty string is returned if the last
11866	accessibility check was successful. A non-empty string indicates a
11867	failure and should normally describe a reason of the failure (for
11868	example, a file read error).
11869	</desc>
11870	</attribute>
11871
11872	</interface>
11873
11874	<!--
11875	// ISession
11876	/////////////////////////////////////////////////////////////////////////
11877	-->
11878
11879	<interface
11880	name="IInternalSessionControl" extends="$unknown"
11881	uuid="989e2c33-8dfa-437a-9a15-5ad441d50dbf"
11882	internal="yes"
11883	wsmap="suppress"
11884	>
11885	<method name="getPID">
11886	<desc>PID of the process that has created this Session object.
11887	</desc>
11888	<param name="pid" type="unsigned long" dir="return"/>
11889	</method>
11890
11891	<method name="getRemoteConsole">
11892	<desc>
11893	Returns the console object suitable for remote control.
11894
11895	<result name="VBOX_E_INVALID_VM_STATE">
11896	Session state prevents operation.
11897	</result>
11898	<result name="VBOX_E_INVALID_OBJECT_STATE">
11899	Session type prevents operation.
11900	</result>
11901
11902	</desc>
11903	<param name="console" type="IConsole" dir="return"/>
11904	</method>
11905
11906	<method name="assignMachine">
11907	<desc>
11908	Assigns the machine object associated with this direct-type
11909	session or informs the session that it will be a remote one
11910	(if @a machine == @c null).
11911
11912	<result name="VBOX_E_INVALID_VM_STATE">
11913	Session state prevents operation.
11914	</result>
11915	<result name="VBOX_E_INVALID_OBJECT_STATE">
11916	Session type prevents operation.
11917	</result>
11918
11919	</desc>
11920	<param name="machine" type="IMachine" dir="in"/>
11921	</method>
11922
11923	<method name="assignRemoteMachine">
11924	<desc>
11925	Assigns the machine and the (remote) console object associated with
11926	this remote-type session.
11927
11928	<result name="VBOX_E_INVALID_VM_STATE">
11929	Session state prevents operation.
11930	</result>
11931
11932	</desc>
11933	<param name="machine" type="IMachine" dir="in"/>
11934	<param name="console" type="IConsole" dir="in"/>
11935	</method>
11936
11937	<method name="updateMachineState">
11938	<desc>
11939	Updates the machine state in the VM process.
11940	Must be called only in certain cases
11941	(see the method implementation).
11942
11943	<result name="VBOX_E_INVALID_VM_STATE">
11944	Session state prevents operation.
11945	</result>
11946	<result name="VBOX_E_INVALID_OBJECT_STATE">
11947	Session type prevents operation.
11948	</result>
11949
11950	</desc>
11951	<param name="aMachineState" type="MachineState" dir="in"/>
11952	</method>
11953
11954	<method name="uninitialize">
11955	<desc>
11956	Uninitializes (closes) this session. Used by VirtualBox to close
11957	the corresponding remote session when the direct session dies
11958	or gets closed.
11959
11960	<result name="VBOX_E_INVALID_VM_STATE">
11961	Session state prevents operation.
11962	</result>
11963
11964	</desc>
11965	</method>
11966
11967	<method name="onNetworkAdapterChange">
11968	<desc>
11969	Triggered when settings of a network adapter of the
11970	associated virtual machine have changed.
11971
11972	<result name="VBOX_E_INVALID_VM_STATE">
11973	Session state prevents operation.
11974	</result>
11975	<result name="VBOX_E_INVALID_OBJECT_STATE">
11976	Session type prevents operation.
11977	</result>
11978
11979	</desc>
11980	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
11981	<param name="changeAdapter" type="boolean" dir="in"/>
11982	</method>
11983
11984	<method name="onSerialPortChange">
11985	<desc>
11986	Triggered when settings of a serial port of the
11987	associated virtual machine have changed.
11988
11989	<result name="VBOX_E_INVALID_VM_STATE">
11990	Session state prevents operation.
11991	</result>
11992	<result name="VBOX_E_INVALID_OBJECT_STATE">
11993	Session type prevents operation.
11994	</result>
11995
11996	</desc>
11997	<param name="serialPort" type="ISerialPort" dir="in"/>
11998	</method>
11999
12000	<method name="onParallelPortChange">
12001	<desc>
12002	Triggered when settings of a parallel port of the
12003	associated virtual machine have changed.
12004
12005	<result name="VBOX_E_INVALID_VM_STATE">
12006	Session state prevents operation.
12007	</result>
12008	<result name="VBOX_E_INVALID_OBJECT_STATE">
12009	Session type prevents operation.
12010	</result>
12011
12012	</desc>
12013	<param name="parallelPort" type="IParallelPort" dir="in"/>
12014	</method>
12015
12016	<method name="onStorageControllerChange">
12017	<desc>
12018	Triggered when settings of a storage controller of the
12019	associated virtual machine have changed.
12020
12021	<result name="VBOX_E_INVALID_VM_STATE">
12022	Session state prevents operation.
12023	</result>
12024	<result name="VBOX_E_INVALID_OBJECT_STATE">
12025	Session type prevents operation.
12026	</result>
12027
12028	</desc>
12029	</method>
12030
12031	<method name="onMediumChange">
12032	<desc>
12033	Triggered when attached media of the
12034	associated virtual machine have changed.
12035
12036	<result name="VBOX_E_INVALID_VM_STATE">
12037	Session state prevents operation.
12038	</result>
12039	<result name="VBOX_E_INVALID_OBJECT_STATE">
12040	Session type prevents operation.
12041	</result>
12042
12043	</desc>
12044
12045	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12046	</method>
12047
12048	<method name="onVRDPServerChange">
12049	<desc>
12050	Triggered when settings of the VRDP server object of the
12051	associated virtual machine have changed.
12052
12053	<result name="VBOX_E_INVALID_VM_STATE">
12054	Session state prevents operation.
12055	</result>
12056	<result name="VBOX_E_INVALID_OBJECT_STATE">
12057	Session type prevents operation.
12058	</result>
12059
12060	</desc>
12061	</method>
12062
12063	<method name="onUSBControllerChange">
12064	<desc>
12065	Triggered when settings of the USB controller object of the
12066	associated virtual machine have changed.
12067
12068	<result name="VBOX_E_INVALID_VM_STATE">
12069	Session state prevents operation.
12070	</result>
12071	<result name="VBOX_E_INVALID_OBJECT_STATE">
12072	Session type prevents operation.
12073	</result>
12074
12075	</desc>
12076	</method>
12077
12078	<method name="onSharedFolderChange">
12079	<desc>
12080	Triggered when a permanent (global or machine) shared folder has been
12081	created or removed.
12082	<note>
12083	We don't pass shared folder parameters in this notification because
12084	the order in which parallel notifications are delivered is not defined,
12085	therefore it could happen that these parameters were outdated by the
12086	time of processing this notification.
12087	</note>
12088
12089	<result name="VBOX_E_INVALID_VM_STATE">
12090	Session state prevents operation.
12091	</result>
12092	<result name="VBOX_E_INVALID_OBJECT_STATE">
12093	Session type prevents operation.
12094	</result>
12095
12096	</desc>
12097	<param name="global" type="boolean" dir="in"/>
12098	</method>
12099
12100	<method name="onUSBDeviceAttach">
12101	<desc>
12102	Triggered when a request to capture a USB device (as a result
12103	of matched USB filters or direct call to
12104	<link to="IConsole::attachUSBDevice"/>) has completed.
12105	A @c null @a error object means success, otherwise it
12106	describes a failure.
12107
12108	<result name="VBOX_E_INVALID_VM_STATE">
12109	Session state prevents operation.
12110	</result>
12111	<result name="VBOX_E_INVALID_OBJECT_STATE">
12112	Session type prevents operation.
12113	</result>
12114
12115	</desc>
12116	<param name="device" type="IUSBDevice" dir="in"/>
12117	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12118	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12119	</method>
12120
12121	<method name="onUSBDeviceDetach">
12122	<desc>
12123	Triggered when a request to release the USB device (as a result
12124	of machine termination or direct call to
12125	<link to="IConsole::detachUSBDevice"/>) has completed.
12126	A @c null @a error object means success, otherwise it
12127	describes a failure.
12128
12129	<result name="VBOX_E_INVALID_VM_STATE">
12130	Session state prevents operation.
12131	</result>
12132	<result name="VBOX_E_INVALID_OBJECT_STATE">
12133	Session type prevents operation.
12134	</result>
12135
12136	</desc>
12137	<param name="id" type="uuid" mod="string" dir="in"/>
12138	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12139	</method>
12140
12141	<method name="onShowWindow">
12142	<desc>
12143	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12144	<link to="IMachine::showConsoleWindow"/> in order to notify
12145	console callbacks
12146	<link to="IConsoleCallback::onCanShowWindow"/>
12147	and <link to="IConsoleCallback::onShowWindow"/>.
12148
12149	<result name="VBOX_E_INVALID_OBJECT_STATE">
12150	Session type prevents operation.
12151	</result>
12152
12153	</desc>
12154	<param name="check" type="boolean" dir="in"/>
12155	<param name="canShow" type="boolean" dir="out"/>
12156	<param name="winId" type="unsigned long long" dir="out"/>
12157	</method>
12158
12159	<method name="accessGuestProperty">
12160	<desc>
12161	Called by <link to="IMachine::getGuestProperty"/> and by
12162	<link to="IMachine::setGuestProperty"/> in order to read and
12163	modify guest properties.
12164
12165	<result name="VBOX_E_INVALID_VM_STATE">
12166	Machine session is not open.
12167	</result>
12168	<result name="VBOX_E_INVALID_OBJECT_STATE">
12169	Session type is not direct.
12170	</result>
12171
12172	</desc>
12173	<param name="name" type="wstring" dir="in"/>
12174	<param name="value" type="wstring" dir="in"/>
12175	<param name="flags" type="wstring" dir="in"/>
12176	<param name="isSetter" type="boolean" dir="in"/>
12177	<param name="retValue" type="wstring" dir="out"/>
12178	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12179	<param name="retFlags" type="wstring" dir="out"/>
12180	</method>
12181
12182	<method name="enumerateGuestProperties">
12183	<desc>
12184	Return a list of the guest properties matching a set of patterns along
12185	with their values, time stamps and flags.
12186
12187	<result name="VBOX_E_INVALID_VM_STATE">
12188	Machine session is not open.
12189	</result>
12190	<result name="VBOX_E_INVALID_OBJECT_STATE">
12191	Session type is not direct.
12192	</result>
12193
12194	</desc>
12195	<param name="patterns" type="wstring" dir="in">
12196	<desc>
12197	The patterns to match the properties against as a comma-separated
12198	string. If this is empty, all properties currently set will be
12199	returned.
12200	</desc>
12201	</param>
12202	<param name="key" type="wstring" dir="out" safearray="yes">
12203	<desc>
12204	The key names of the properties returned.
12205	</desc>
12206	</param>
12207	<param name="value" type="wstring" dir="out" safearray="yes">
12208	<desc>
12209	The values of the properties returned. The array entries match the
12210	corresponding entries in the @a key array.
12211	</desc>
12212	</param>
12213	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12214	<desc>
12215	The time stamps of the properties returned. The array entries match
12216	the corresponding entries in the @a key array.
12217	</desc>
12218	</param>
12219	<param name="flags" type="wstring" dir="out" safearray="yes">
12220	<desc>
12221	The flags of the properties returned. The array entries match the
12222	corresponding entries in the @a key array.
12223	</desc>
12224	</param>
12225	</method>
12226
12227	</interface>
12228
12229	<interface
12230	name="ISession" extends="$dispatched"
12231	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12232	wsmap="managed"
12233	>
12234	<desc>
12235	The ISession interface represents a serialization primitive for virtual
12236	machines.
12237
12238	With VirtualBox, every time one wishes to manipulate a virtual machine
12239	(e.g. change its settings or start execution), a session object is
12240	required. Such an object must be passed to one of the session methods
12241	that open the given session, which then initiates the machine manipulation.
12242
12243	A session serves several purposes: it identifies to the inter-process VirtualBox
12244	code which process is currently working with the virtual machine, and it ensures
12245	that there are no incompatible requests from several processes for the
12246	same virtual machine. Session objects can therefore be thought of as mutex
12247	semaphores that lock virtual machines to prevent conflicting accesses from
12248	several processes.
12249
12250	How sessions objects are used depends on whether you use the Main API
12251	via COM or via the webservice:
12252
12253	<ul>
12254	<li>When using the COM API directly, an object of the Session class from the
12255	VirtualBox type library needs to be created. In regular COM C++ client code,
12256	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12257	This object will then act as a local session object in further calls to open
12258	a session.
12259	</li>
12260
12261	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12262	one session object automatically when <link to="IWebsessionManager::logon" />
12263	is called. A managed object reference to that session object can be retrieved by
12264	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12265	reference can then be used to open sessions.
12266	</li>
12267	</ul>
12268
12269	Sessions are mainly used in two variations:
12270
12271	<ul>
12272	<li>
12273	To start a virtual machine in a separate process, one would call
12274	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12275	object as its first parameter. This session then identifies the caller
12276	and lets him control the started machine (for example, pause machine
12277	execution or power it down) as well as be notified about machine
12278	execution state changes.
12279	</li>
12280
12281	<li>To alter machine settings, or to start machine execution within the
12282	current process, one needs to open a direct session for the machine first by
12283	calling <link to="IVirtualBox::openSession"/>. While a direct session
12284	is open within one process, no any other process may open another direct
12285	session for the same machine. This prevents the machine from being changed
12286	by other processes while it is running or while the machine is being configured.
12287	</li>
12288	</ul>
12289
12290	One also can attach to an existing direct session already opened by
12291	another process (for example, in order to send a control request to the
12292	virtual machine such as the pause or the reset request). This is done by
12293	calling <link to="IVirtualBox::openExistingSession"/>.
12294
12295	<note>
12296	Unless you are trying to write a new VirtualBox front-end that
12297	performs direct machine execution (like the VirtualBox or VBoxSDL
12298	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12299	session opened by <link to="IVirtualBox::openSession"/> and use this
12300	session only to change virtual machine settings. If you simply want to
12301	start virtual machine execution using one of the existing front-ends
12302	(for example the VirtualBox GUI or headless server), simply use
12303	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12304	will power up the machine automatically for you.
12305	</note>
12306	</desc>
12307
12308	<attribute name="state" type="SessionState" readonly="yes">
12309	<desc>Current state of this session.</desc>
12310	</attribute>
12311
12312	<attribute name="type" type="SessionType" readonly="yes">
12313	<desc>
12314	Type of this session. The value of this attribute is valid only
12315	if the session is currently open (i.e. its #state is
12316	SessionType_SessionOpen), otherwise an error will be returned.
12317	</desc>
12318	</attribute>
12319
12320	<attribute name="machine" type="IMachine" readonly="yes">
12321	<desc>Machine object associated with this session.</desc>
12322	</attribute>
12323
12324	<attribute name="console" type="IConsole" readonly="yes">
12325	<desc>Console object associated with this session.</desc>
12326	</attribute>
12327
12328	<method name="close">
12329	<desc>
12330	Closes a session that was previously opened.
12331
12332	It is recommended that every time an "open session" method (such as
12333	<link to="IVirtualBox::openRemoteSession" /> or
12334	<link to="IVirtualBox::openSession" />) has been called to
12335	manipulate a virtual machine, the caller invoke
12336	ISession::close() when it's done doing so. Since sessions are
12337	serialization primitives much like ordinary mutexes, they are
12338	best used the same way: for each "open" call, there should be
12339	a matching "close" call, even when errors occur.
12340
12341	Otherwise, if a direct session for a machine opened with
12342	<link to="IVirtualBox::openSession"/> is not explicitly closed
12343	when the application terminates, the state of the machine will
12344	be set to <link to="MachineState_Aborted" /> on the server.
12345
12346	Generally, it is recommended to close all open sessions explicitly
12347	before terminating the application (regardless of the reason for
12348	the termination).
12349
12350	<note>
12351	Do not expect the session state (<link to="ISession::state" />
12352	to return to "Closed" immediately after you invoke
12353	ISession::close(), particularly if you have started a remote
12354	session to execute the VM in a new process. The session state will
12355	automatically return to "Closed" once the VM is no longer executing,
12356	which can of course take a very long time.
12357	</note>
12358
12359	<result name="E_UNEXPECTED">
12360	Session is not open.
12361	</result>
12362
12363	</desc>
12364	</method>
12365
12366	</interface>
12367
12368	<!--
12369	// IStorageController
12370	/////////////////////////////////////////////////////////////////////////
12371	-->
12372
12373	<enum
12374	name="StorageBus"
12375	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12376	>
12377	<desc>
12378	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
12379	see <link to="IStorageController::bus" />.
12380	</desc>
12381	<const name="Null" value="0">
12382	<desc>@c null value. Never used by the API.</desc>
12383	</const>
12384	<const name="IDE" value="1"/>
12385	<const name="SATA" value="2"/>
12386	<const name="SCSI" value="3"/>
12387	<const name="Floppy" value="4"/>
12388	</enum>
12389
12390	<enum
12391	name="StorageControllerType"
12392	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12393	>
12394	<desc>
12395	The exact variant of storage controller hardware presented
12396	to the guest; see <link to="IStorageController::controllerType" />.
12397	</desc>
12398
12399	<const name="Null" value="0">
12400	<desc>@c null value. Never used by the API.</desc>
12401	</const>
12402	<const name="LsiLogic" value="1">
12403	<desc>A SCSI controller of the LsiLogic variant.</desc>
12404	</const>
12405	<const name="BusLogic" value="2">
12406	<desc>A SCSI controller of the BusLogic variant.</desc>
12407	</const>
12408	<const name="IntelAhci" value="3">
12409	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12410	</const>
12411	<const name="PIIX3" value="4">
12412	<desc>An IDE controller of the PIIX3 variant.</desc>
12413	</const>
12414	<const name="PIIX4" value="5">
12415	<desc>An IDE controller of the PIIX4 variant.</desc>
12416	</const>
12417	<const name="ICH6" value="6">
12418	<desc>An IDE controller of the ICH6 variant.</desc>
12419	</const>
12420	<const name="I82078" value="7">
12421	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12422	</const>
12423	</enum>
12424
12425	<interface
12426	name="IStorageController" extends="$unknown"
12427	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
12428	wsmap="managed"
12429	>
12430	<desc>
12431	Represents a storage controller that is attached to a virtual machine
12432	(<link to="IMachine" />). Just as disks (hard disks, DVDs, FDs) are
12433	attached to storage controllers in a real computer, virtual media
12434	(represented by <link to="IMedium" />) are attached to virtual
12435	storage controllers, represented by this interface.
12436
12437	As opposed to physical hardware, VirtualBox has a very generic concept
12438	of a storage controller, and for purposes of the Main API, all virtual
12439	storage is attached to virtual machines via instances of this interface.
12440	There are four types of such virtual storage controllers: IDE, SCSI, SATA
12441	and Floppy (see <link to="#bus" />). Depending on which of these four is
12442	used, certain sub-types may be available and can be selected in
12443	<link to="#controllerType" />.
12444
12445	Depending on these settings, the guest operating system might see
12446	significantly different virtual hardware.
12447	</desc>
12448
12449	<attribute name="name" type="wstring" readonly="yes">
12450	<desc>
12451	Name of the storage controller, as originally specified with
12452	<link to="IMachine::addStorageController" />. This then uniquely
12453	identifies this controller with other method calls such as
12454	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
12455	</desc>
12456	</attribute>
12457
12458	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
12459	<desc>
12460	Maximum number of devices which can be attached to one port.
12461	</desc>
12462	</attribute>
12463
12464	<attribute name="minPortCount" type="unsigned long" readonly="yes">
12465	<desc>
12466	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
12467	</desc>
12468	</attribute>
12469
12470	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
12471	<desc>
12472	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
12473	</desc>
12474	</attribute>
12475
12476	<attribute name="instance" type="unsigned long">
12477	<desc>
12478	The instance number of the device in the running VM.
12479	</desc>
12480	</attribute>
12481
12482	<attribute name="portCount" type="unsigned long">
12483	<desc>
12484	The number of currently usable ports on the controller.
12485	The minimum and maximum number of ports for one controller are
12486	stored in <link to="IStorageController::minPortCount"/>
12487	and <link to="IStorageController::maxPortCount"/>.
12488	</desc>
12489	</attribute>
12490
12491	<attribute name="bus" type="StorageBus" readonly="yes">
12492	<desc>
12493	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
12494	</desc>
12495	</attribute>
12496
12497	<attribute name="controllerType" type="StorageControllerType">
12498	<desc>
12499	The exact variant of storage controller hardware presented
12500	to the guest.
12501	Depending on this value, VirtualBox will provide a different
12502	virtual storage controller hardware to the guest.
12503	For SATA and floppy controllers, only one variant is available,
12504	but for IDE and SCSI, there are several.
12505
12506	For SCSI controllers, the default type is LsiLogic.
12507	</desc>
12508	</attribute>
12509
12510	<method name="GetIDEEmulationPort">
12511	<desc>
12512	Gets the corresponding port number which is emulated as an IDE device.
12513	Works only with SATA controllers.
12514
12515	<result name="E_INVALIDARG">
12516	The @a devicePosition is not in the range 0 to 3.
12517	</result>
12518	<result name="E_NOTIMPL">
12519	The storage controller type is not SATAIntelAhci.
12520	</result>
12521
12522	</desc>
12523	<param name="devicePosition" type="long" dir="in"/>
12524	<param name="portNumber" type="long" dir="return"/>
12525	</method>
12526
12527	<method name="SetIDEEmulationPort">
12528	<desc>
12529	Sets the port number which is emulated as an IDE device.
12530	Works only with SATA controllers.
12531
12532	<result name="E_INVALIDARG">
12533	The @a devicePosition is not in the range 0 to 3 or the
12534	@a portNumber is not in the range 0 to 29.
12535	</result>
12536	<result name="E_NOTIMPL">
12537	The storage controller type is not SATAIntelAhci.
12538	</result>
12539
12540	</desc>
12541	<param name="devicePosition" type="long" dir="in"/>
12542	<param name="portNumber" type="long" dir="in"/>
12543	</method>
12544
12545	</interface>
12546
12547	<if target="wsdl">
12548
12549	<!--
12550	// IManagedObjectRef
12551	/////////////////////////////////////////////////////////////////////////
12552	-->
12553
12554	<interface
12555	name="IManagedObjectRef" extends="$unknown"
12556	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
12557	internal="yes"
12558	wsmap="managed"
12559	wscpp="hardcoded"
12560	>
12561	<desc>
12562	Managed object reference.
12563
12564	Only within the webservice, a managed object reference (which is really
12565	an opaque number) allows a webservice client to address an object
12566	that lives in the address space of the webservice server.
12567
12568	Behind each managed object reference, there is a COM object that lives
12569	in the webservice server's address space. The COM object is not freed
12570	until the managed object reference is released, either by an explicit
12571	call to <link to="IManagedObjectRef::release" /> or by logging off from
12572	the webservice (<link to="IWebsessionManager::logoff" />), which releases
12573	all objects created during the webservice session.
12574
12575	Whenever a method call of the VirtualBox API returns a COM object, the
12576	webservice representation of that method will instead return a
12577	managed object reference, which can then be used to invoke methods
12578	on that object.
12579	</desc>
12580
12581	<method name="getInterfaceName">
12582	<desc>
12583	Returns the name of the interface that this managed object represents,
12584	for example, "IMachine", as a string.
12585	</desc>
12586	<param name="return" type="wstring" dir="return"/>
12587	</method>
12588
12589	<method name="release">
12590	<desc>
12591	Releases this managed object reference and frees the resources that
12592	were allocated for it in the webservice server process. After calling
12593	this method, the identifier of the reference can no longer be used.
12594	</desc>
12595	</method>
12596
12597	</interface>
12598
12599	<!--
12600	// IWebsessionManager
12601	/////////////////////////////////////////////////////////////////////////
12602	-->
12603
12604	<interface
12605	name="IWebsessionManager" extends="$unknown"
12606	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
12607	internal="yes"
12608	wsmap="global"
12609	wscpp="hardcoded"
12610	>
12611	<desc>
12612	Websession manager. This provides essential services
12613	to webservice clients.
12614	</desc>
12615	<method name="logon">
12616	<desc>
12617	Logs a new client onto the webservice and returns a managed object reference to
12618	the IVirtualBox instance, which the client can then use as a basis to further
12619	queries, since all calls to the VirtualBox API are based on the IVirtualBox
12620	interface, in one way or the other.
12621	</desc>
12622	<param name="username" type="wstring" dir="in"/>
12623	<param name="password" type="wstring" dir="in"/>
12624	<param name="return" type="IVirtualBox" dir="return"/>
12625	</method>
12626
12627	<method name="getSessionObject">
12628	<desc>
12629	Returns a managed object reference to the internal ISession object that was created
12630	for this web service session when the client logged on.
12631
12632	<see>ISession</see>
12633	</desc>
12634	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12635	<param name="return" type="ISession" dir="return"/>
12636	</method>
12637
12638	<method name="logoff">
12639	<desc>
12640	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
12641	and destroys all resources associated with the session (most importantly, all
12642	managed objects created in the server while the session was active).
12643	</desc>
12644	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12645	</method>
12646
12647	</interface>
12648
12649	</if>
12650
12651	<!--
12652	// IPerformanceCollector & friends
12653	/////////////////////////////////////////////////////////////////////////
12654	-->
12655
12656	<interface
12657	name="IPerformanceMetric" extends="$unknown"
12658	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
12659	>
12660	<desc>
12661	The IPerformanceMetric interface represents parameters of the given
12662	performance metric.
12663	</desc>
12664
12665	<attribute name="metricName" type="wstring" readonly="yes">
12666	<desc>
12667	Name of the metric.
12668	</desc>
12669	</attribute>
12670
12671	<attribute name="object" type="$unknown" readonly="yes">
12672	<desc>
12673	Object this metric belongs to.
12674	</desc>
12675	</attribute>
12676
12677	<attribute name="description" type="wstring" readonly="yes">
12678	<desc>
12679	Textual description of the metric.
12680	</desc>
12681	</attribute>
12682
12683	<attribute name="period" type="unsigned long" readonly="yes">
12684	<desc>
12685	Time interval between samples, measured in seconds.
12686	</desc>
12687	</attribute>
12688
12689	<attribute name="count" type="unsigned long" readonly="yes">
12690	<desc>
12691	Number of recent samples retained by the performance collector for this
12692	metric.
12693
12694	When the collected sample count exceeds this number, older samples
12695	are discarded.
12696	</desc>
12697	</attribute>
12698
12699	<attribute name="unit" type="wstring" readonly="yes">
12700	<desc>
12701	Unit of measurement.
12702	</desc>
12703	</attribute>
12704
12705	<attribute name="minimumValue" type="long" readonly="yes">
12706	<desc>
12707	Minimum possible value of this metric.
12708	</desc>
12709	</attribute>
12710
12711	<attribute name="maximumValue" type="long" readonly="yes">
12712	<desc>
12713	Maximum possible value of this metric.
12714	</desc>
12715	</attribute>
12716	</interface>
12717
12718	<interface
12719	name="IPerformanceCollector" extends="$unknown"
12720	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
12721	wsmap="managed"
12722	>
12723	<desc>
12724	The IPerformanceCollector interface represents a service that collects and
12725	stores performance metrics data.
12726
12727	Performance metrics are associated with objects of interfaces like IHost and
12728	IMachine. Each object has a distinct set of performance metrics.
12729	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
12730
12731	Metric data is collected at the specified intervals and is retained
12732	internally. The interval and the number of retained samples can be set
12733	with <link to="IPerformanceCollector::setupMetrics" />.
12734
12735	Metrics are organized hierarchically, with each level separated by a
12736	slash (/) character. Generally, the scheme for metric names is like this:
12737
12738	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
12739
12740	"Category/Metric" together form the base metric name. A base metric is the
12741	smallest unit for which a sampling interval and the number of retained
12742	samples can be set. Only base metrics can be enabled and disabled. All
12743	sub-metrics are collected when their base metric is collected.
12744	Collected values for any set of sub-metrics can be queried with
12745	<link to="IPerformanceCollector::queryMetricsData" />.
12746
12747	For example "CPU/Load/User:avg"
12748	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
12749	"average" aggregate. An aggregate function is computed over all retained
12750	data. Valid aggregate functions are:
12751
12752	<ul>
12753	<li>avg -- average</li>
12754	<li>min -- minimum</li>
12755	<li>max -- maximum</li>
12756	</ul>
12757
12758	When setting up
12759	metric parameters, querying metric data, enabling or disabling metrics
12760	wildcards can be used in metric names to specify a subset of metrics. For
12761	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
12762	averages can be queried using <tt>*:avg</tt> and so on. To query metric
12763	values without aggregates <tt>*:</tt> can be used.
12764
12765	The valid names for base metrics are:
12766
12767	<ul>
12768	<li>CPU/Load</li>
12769	<li>CPU/MHz</li>
12770	<li>RAM/Usage</li>
12771	</ul>
12772
12773	The general sequence for collecting and retrieving the metrics is:
12774	<ul>
12775	<li>
12776	Obtain an instance of IPerformanceCollector with
12777	<link to="IVirtualBox::performanceCollector" />
12778	</li>
12779	<li>
12780	Allocate and populate an array with references to objects the metrics
12781	will be collected for. Use references to IHost and IMachine objects.
12782	</li>
12783	<li>
12784	Allocate and populate an array with base metric names the data will be
12785	collected for.
12786	</li>
12787	<li>
12788	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
12789	metric data will be collected and stored.
12790	</li>
12791	<li>
12792	Wait for the data to get collected.
12793	</li>
12794	<li>
12795	Allocate and populate an array with references to objects the metric
12796	values will be queried for. You can re-use the object array used for
12797	setting base metrics.
12798	</li>
12799	<li>
12800	Allocate and populate an array with metric names the data will be
12801	collected for. Note that metric names differ from base metric names.
12802	</li>
12803	<li>
12804	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
12805	have been collected so far are returned. Note that the values are still
12806	retained internally and data collection continues.
12807	</li>
12808	</ul>
12809
12810	For an example of usage refer to the following files in VirtualBox SDK:
12811	<ul>
12812	<li>
12813	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
12814	</li>
12815	<li>
12816	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
12817	</li>
12818	</ul>
12819	</desc>
12820
12821	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
12822	<desc>
12823	Array of unique names of metrics.
12824
12825	This array represents all metrics supported by the performance
12826	collector. Individual objects do not necessarily support all of them.
12827	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
12828	list of supported metrics for a particular object.
12829	</desc>
12830	</attribute>
12831
12832	<method name="getMetrics">
12833	<desc>
12834	Returns parameters of specified metrics for a set of objects.
12835	<note>
12836	@c Null metrics array means all metrics. @c Null object array means
12837	all existing objects.
12838	</note>
12839	</desc>
12840	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12841	<desc>
12842	Metric name filter. Currently, only a comma-separated list of metrics
12843	is supported.
12844	</desc>
12845	</param>
12846	<param name="objects" type="$unknown" dir="in" safearray="yes">
12847	<desc>
12848	Set of objects to return metric parameters for.
12849	</desc>
12850	</param>
12851	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
12852	<desc>
12853	Array of returned metric parameters.
12854	</desc>
12855	</param>
12856	</method>
12857
12858	<method name="setupMetrics">
12859	<desc>
12860	Sets parameters of specified base metrics for a set of objects. Returns
12861	an array of <link to="IPerformanceMetric" /> describing the metrics have
12862	been affected.
12863	<note>
12864	@c Null or empty metric name array means all metrics. @c Null or empty
12865	object array means all existing objects. If metric name array contains
12866	a single element and object array contains many, the single metric
12867	name array element is applied to each object array element to form
12868	metric/object pairs.
12869	</note>
12870	</desc>
12871	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12872	<desc>
12873	Metric name filter. Comma-separated list of metrics with wildcard
12874	support.
12875	</desc>
12876	</param>
12877	<param name="objects" type="$unknown" dir="in" safearray="yes">
12878	<desc>
12879	Set of objects to setup metric parameters for.
12880	</desc>
12881	</param>
12882	<param name="period" type="unsigned long" dir="in">
12883	<desc>
12884	Time interval in seconds between two consecutive samples of performance
12885	data.
12886	</desc>
12887	</param>
12888	<param name="count" type="unsigned long" dir="in">
12889	<desc>
12890	Number of samples to retain in performance data history. Older samples
12891	get discarded.
12892	</desc>
12893	</param>
12894	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12895	<desc>
12896	Array of metrics that have been modified by the call to this method.
12897	</desc>
12898	</param>
12899	</method>
12900
12901	<method name="enableMetrics">
12902	<desc>
12903	Turns on collecting specified base metrics. Returns an array of
12904	<link to="IPerformanceMetric" /> describing the metrics have been
12905	affected.
12906	<note>
12907	@c Null or empty metric name array means all metrics. @c Null or empty
12908	object array means all existing objects. If metric name array contains
12909	a single element and object array contains many, the single metric
12910	name array element is applied to each object array element to form
12911	metric/object pairs.
12912	</note>
12913	</desc>
12914	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12915	<desc>
12916	Metric name filter. Comma-separated list of metrics with wildcard
12917	support.
12918	</desc>
12919	</param>
12920	<param name="objects" type="$unknown" dir="in" safearray="yes">
12921	<desc>
12922	Set of objects to enable metrics for.
12923	</desc>
12924	</param>
12925	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12926	<desc>
12927	Array of metrics that have been modified by the call to this method.
12928	</desc>
12929	</param>
12930	</method>
12931
12932	<method name="disableMetrics">
12933	<desc>
12934	Turns off collecting specified base metrics. Returns an array of
12935	<link to="IPerformanceMetric" /> describing the metrics have been
12936	affected.
12937	<note>
12938	@c Null or empty metric name array means all metrics. @c Null or empty
12939	object array means all existing objects. If metric name array contains
12940	a single element and object array contains many, the single metric
12941	name array element is applied to each object array element to form
12942	metric/object pairs.
12943	</note>
12944	</desc>
12945	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12946	<desc>
12947	Metric name filter. Comma-separated list of metrics with wildcard
12948	support.
12949	</desc>
12950	</param>
12951	<param name="objects" type="$unknown" dir="in" safearray="yes">
12952	<desc>
12953	Set of objects to disable metrics for.
12954	</desc>
12955	</param>
12956	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12957	<desc>
12958	Array of metrics that have been modified by the call to this method.
12959	</desc>
12960	</param>
12961	</method>
12962
12963	<method name="queryMetricsData">
12964	<desc>
12965	Queries collected metrics data for a set of objects.
12966
12967	The data itself and related metric information are returned in seven
12968	parallel and one flattened array of arrays. Elements of
12969	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
12970	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
12971	the same index describe one set of values corresponding to a single
12972	metric.
12973
12974	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
12975	start and length of a sub-array is indicated by
12976	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
12977	value for metric <tt>metricNames[i]</tt> is at
12978	<tt>returnData[returnIndices[i]]</tt>.
12979
12980	<note>
12981	@c Null or empty metric name array means all metrics. @c Null or empty
12982	object array means all existing objects. If metric name array contains
12983	a single element and object array contains many, the single metric
12984	name array element is applied to each object array element to form
12985	metric/object pairs.
12986	</note>
12987	<note>
12988	Data collection continues behind the scenes after call to
12989	@c queryMetricsData. The return data can be seen as the snapshot of
12990	the current state at the time of @c queryMetricsData call. The
12991	internally kept metric values are not cleared by the call. This makes
12992	possible querying different subsets of metrics or aggregates with
12993	subsequent calls. If periodic querying is needed it is highly
12994	suggested to query the values with @c interval*count period to avoid
12995	confusion. This way a completely new set of data values will be
12996	provided by each query.
12997	</note>
12998	</desc>
12999	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13000	<desc>
13001	Metric name filter. Comma-separated list of metrics with wildcard
13002	support.
13003	</desc>
13004	</param>
13005	<param name="objects" type="$unknown" dir="in" safearray="yes">
13006	<desc>
13007	Set of objects to query metrics for.
13008	</desc>
13009	</param>
13010	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13011	<desc>
13012	Names of metrics returned in @c returnData.
13013	</desc>
13014	</param>
13015	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13016	<desc>
13017	Objects associated with metrics returned in @c returnData.
13018	</desc>
13019	</param>
13020	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13021	<desc>
13022	Units of measurement for each returned metric.
13023	</desc>
13024	</param>
13025	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13026	<desc>
13027	Divisor that should be applied to return values in order to get
13028	floating point values. For example:
13029	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13030	will retrieve the floating point value of i-th sample of the first
13031	metric.
13032	</desc>
13033	</param>
13034	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13035	<desc>
13036	Sequence numbers of the first elements of value sequences of particular metrics
13037	returned in @c returnData. For aggregate metrics it is the sequence number of
13038	the sample the aggregate started calculation from.
13039	</desc>
13040	</param>
13041	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13042	<desc>
13043	Indices of the first elements of value sequences of particular metrics
13044	returned in @c returnData.
13045	</desc>
13046	</param>
13047	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13048	<desc>
13049	Lengths of value sequences of particular metrics.
13050	</desc>
13051	</param>
13052	<param name="returnData" type="long" dir="return" safearray="yes">
13053	<desc>
13054	Flattened array of all metric data containing sequences of values for
13055	each metric.
13056	</desc>
13057	</param>
13058	</method>
13059
13060	</interface>
13061
13062	<module name="VBoxSVC" context="LocalServer">
13063	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13064	namespace="virtualbox.org">
13065	<interface name="IVirtualBox" default="yes"/>
13066	</class>
13067	</module>
13068
13069	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13070	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13071	namespace="virtualbox.org">
13072	<interface name="ISession" default="yes"/>
13073	</class>
13074	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13075	namespace="virtualbox.org">
13076	<interface name="ILocalOwner" default="yes"/>
13077	<interface name="IVirtualBoxCallback"/>
13078	<interface name="IConsoleCallback"/>
13079	</class>
13080	</module>
13081
13082	</library>
13083
13084	</idl>
13085
13086	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format