VirtualBox.xidl@ 26624

Last change on this file since 26624 was 26548, checked in by vboxsync, 15 years ago
Main, FE: HPET review feedback
Property svn:eol-style set to `native`
File size: 511.4 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-2010 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="v1_10" value="12">
457	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
458	<!-- Machine changes: RTC localOrUTC (done)
459	CPU hot-plug support
460	-->
461	</const>
462	<const name="Future" value="13">
463	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
464	</const>
465	</enum>
466
467	<enum
468	name="AccessMode"
469	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
470	>
471	<desc>
472	Access mode for opening files.
473	</desc>
474
475	<const name="ReadOnly" value="1"/>
476	<const name="ReadWrite" value="2"/>
477	</enum>
478
479	<enum
480	name="MachineState"
481	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
482	>
483	<desc>
484	Virtual machine execution state.
485
486	This enumeration represents possible values of the <link
487	to="IMachine::state"/> attribute.
488
489	Below is the basic virtual machine state diagram. It shows how the state
490	changes during virtual machine execution. The text in square braces shows
491	a method of the IConsole interface that performs the given state
492	transition.
493
494	<pre>
495	+---------[powerDown()] <- Stuck <--[failure]-+
496	V \|
497	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
498	\| \| \| \| V \|
499	\| Aborted -----+ +--> Running --[pause()]--> Paused
500	\| \| ^ \| ^ \|
501	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
502	\| ^ \| \| \| \|
503	\| \| +-----------------------------------------+-\|-------------------+ +
504	\| \| \| \| \|
505	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
506	\| \| \| \|
507	\| +-------- Saving <--------[saveState()]<----------+---------------------+
508	\| \| \|
509	+-------------- Stopping -------[powerDown()]<----------+---------------------+
510	</pre>
511
512	Note that states to the right from PoweredOff, Aborted and Saved in the
513	above diagram are called <i>online VM states</i>. These states
514	represent the virtual machine which is being executed in a dedicated
515	process (usually with a GUI window attached to it where you can see the
516	activity of the virtual machine and interact with it). There are two
517	special pseudo-states, FirstOnline and LastOnline, that can be used in
518	relational expressions to detect if the given machine state is online or
519	not:
520
521	<pre>
522	if (machine.GetState() >= MachineState_FirstOnline &&
523	machine.GetState() <= MachineState_LastOnline)
524	{
525	...the machine is being executed...
526	}
527	</pre>
528
529	When the virtual machine is in one of the online VM states (that is, being
530	executed), only a few machine settings can be modified. Methods working
531	with such settings contain an explicit note about that. An attempt to
532	change any oter setting or perform a modifying operation during this time
533	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
534
535	All online states except Running, Paused and Stuck are transitional: they
536	represent temporary conditions of the virtual machine that will last as
537	long as the operation that initiated such a condition.
538
539	The Stuck state is a special case. It means that execution of the machine
540	has reached the "Guru Meditation" condition. This condition indicates an
541	internal VMM (virtual machine manager) failure which may happen as a
542	result of either an unhandled low-level virtual hardware exception or one
543	of the recompiler exceptions (such as the <i>too-many-traps</i>
544	condition).
545
546	Note also that any online VM state may transit to the Aborted state. This
547	happens if the process that is executing the virtual machine terminates
548	unexpectedly (for example, crashes). Other than that, the Aborted state is
549	equivalent to PoweredOff.
550
551	There are also a few additional state diagrams that do not deal with
552	virtual machine execution and therefore are shown separately. The states
553	shown on these diagrams are called <i>offline VM states</i> (this includes
554	PoweredOff, Aborted and Saved too).
555
556	The first diagram shows what happens when a lengthy setup operation is
557	being executed (such as <link to="IMachine::attachDevice"/>).
558
559	<pre>
560	+----------------------------------(same state as before the call)------+
561	\| \|
562	+-> PoweredOff --+ \|
563	\| \| \|
564	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
565	\| \|
566	+-> Saved -------+
567	</pre>
568
569	The next two diagrams demonstrate the process of taking a snapshot of a
570	powered off virtual machine and performing one of the "discard..."
571	operations, respectively.
572
573	<pre>
574	+----------------------------------(same state as before the call)------+
575	\| \|
576	+-> PoweredOff --+ \|
577	\| +-->[takeSnapshot()] -------------------> Saving ------+
578	+-> Aborted -----+
579
580	+-> PoweredOff --+
581	\| \|
582	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
583	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
584	+-> Saved -------+ \|
585	\| \|
586	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
587	</pre>
588
589	Note that the Saving state is present in both the offline state group and
590	online state group. Currently, the only way to determine what group is
591	assumed in a particular case is to remember the previous machine state: if
592	it was Running or Paused, then Saving is an online state, otherwise it is
593	an offline state. This inconsistency may be removed in one of the future
594	versions of VirtualBox by adding a new state.
595
596	<note internal="yes">
597	For whoever decides to touch this enum: In order to keep the
598	comparisons involving FirstOnline and LastOnline pseudo-states valid,
599	the numeric values of these states must be correspondingly updated if
600	needed: for any online VM state, the condition
601	<tt>FirstOnline <= state <= LastOnline</tt> must be
602	@c true. The same relates to transient states for which
603	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
604	@c true.
605	</note>
606	</desc>
607
608	<const name="Null" value="0">
609	<desc>Null value (never used by the API).</desc>
610	</const>
611	<const name="PoweredOff" value="1">
612	<desc>
613	The machine is not running and has no saved execution state; it has
614	either never been started or been shut down successfully.
615	</desc>
616	</const>
617	<const name="Saved" value="2">
618	<desc>
619	The machine is not currently running, but the execution state of the machine
620	has been saved to an external file when it was running, from where
621	it can be resumed.
622	</desc>
623	</const>
624	<const name="Teleported" value="3">
625	<desc>
626	The machine was teleported to a different host (or process) and then
627	powered off. Take care when powering it on again may corrupt resources
628	it shares with the teleportation target (e.g. disk and network).
629	</desc>
630	</const>
631	<const name="Aborted" value="4">
632	<desc>
633	The process running the machine has terminated abnormally. This may
634	indicate a crash of the VM process in host execution context, or
635	the VM process has been terminated externally.
636	</desc>
637	</const>
638	<const name="Running" value="5">
639	<desc>
640	The machine is currently being executed.
641	<note internal="yes">
642	For whoever decides to touch this enum: In order to keep the
643	comparisons in the old source code valid, this state must immediately
644	precede the Paused state.
645	TODO: Lift this spectacularly wonderful restriction.
646	</note>
647	</desc>
648	</const>
649	<const name="Paused" value="6">
650	<desc>
651	Execution of the machine has been paused.
652	<note internal="yes">
653	For whoever decides to touch this enum: In order to keep the
654	comparisons in the old source code valid, this state must immediately
655	follow the Running state.
656	TODO: Lift this spectacularly wonderful restriction.
657	</note>
658	</desc>
659	</const>
660	<const name="Stuck" value="7">
661	<desc>
662	Execution of the machine has reached the "Guru Meditation"
663	condition. This indicates a severe error in the hypervisor itself.
664	<note internal="yes">
665	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
666	"Guru", perhaps? Or are there some other VMM states that are
667	intended to be lumped in here as well?
668	</note>
669	</desc>
670	</const>
671	<const name="Teleporting" value="8">
672	<desc>
673	The machine is about to be teleported to a different host or process.
674	It is possible to pause a machine in this state, but it will go to the
675	<link to="MachineState::PausedTeleporting"/> state and it will not be
676	possible to resume it again unless the teleportation fails.
677	</desc>
678	</const>
679	<const name="LiveSnapshotting" value="9">
680	<desc>
681	A live snapshot is being taken. The machine is running normally, but
682	some of the runtime configuration options are inaccessible. Also, if
683	paused while in this state it will transition to
684	<link to="MachineState::Saving"/> and it will not be resume the
685	execution until the snapshot operation has completed.
686	</desc>
687	</const>
688	<const name="Starting" value="10">
689	<desc>
690	Machine is being started after powering it on from a
691	zero execution state.
692	</desc>
693	</const>
694	<const name="Stopping" value="11">
695	<desc>
696	Machine is being normally stopped powering it off, or after the guest OS
697	has initiated a shutdown sequence.
698	</desc>
699	</const>
700	<const name="Saving" value="12">
701	<desc>
702	Machine is saving its execution state to a file, or an online
703	snapshot of the machine is being taken.
704	</desc>
705	</const>
706	<const name="Restoring" value="13">
707	<desc>
708	Execution state of the machine is being restored from a file
709	after powering it on from the saved execution state.
710	</desc>
711	</const>
712	<const name="TeleportingPausedVM" value="14">
713	<desc>
714	The machine is being teleported to another host or process, but it is
715	not running. This is the paused variant of the
716	<link to="MachineState::Teleporting"/> state.
717	</desc>
718	</const>
719	<const name="TeleportingIn" value="15">
720	<desc>
721	Teleporting the machine state in from another host or process.
722	</desc>
723	</const>
724	<const name="RestoringSnapshot" value="16">
725	<desc>
726	A machine snapshot is being restored; this typically does not take long.
727	</desc>
728	</const>
729	<const name="DeletingSnapshot" value="17">
730	<desc>
731	A machine snapshot is being deleted; this can take a long time since this
732	may require merging differencing media.
733	</desc>
734	</const>
735	<const name="SettingUp" value="18">
736	<desc>
737	Lengthy setup operation is in progress.
738	</desc>
739	</const>
740
741	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
742	<desc>
743	Pseudo-state: first online state (for use in relational expressions).
744	</desc>
745	</const>
746	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
747	<desc>
748	Pseudo-state: last online state (for use in relational expressions).
749	</desc>
750	</const>
751
752	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
753	<desc>
754	Pseudo-state: first transient state (for use in relational expressions).
755	</desc>
756	</const>
757	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
758	<desc>
759	Pseudo-state: last transient state (for use in relational expressions).
760	</desc>
761	</const>
762
763	</enum>
764
765	<enum
766	name="SessionState"
767	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
768	>
769	<desc>
770	Session state. This enumeration represents possible values of
771	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
772	attributes. See individual enumerator descriptions for the meaning for
773	every value.
774	</desc>
775
776	<const name="Null" value="0">
777	<desc>Null value (never used by the API).</desc>
778	</const>
779	<const name="Closed" value="1">
780	<desc>
781	The machine has no open sessions (<link to="IMachine::sessionState"/>);
782	the session is closed (<link to="ISession::state"/>)
783	</desc>
784	</const>
785	<const name="Open" value="2">
786	<desc>
787	The machine has an open direct session (<link to="IMachine::sessionState"/>);
788	the session is open (<link to="ISession::state"/>)
789	</desc>
790	</const>
791	<const name="Spawning" value="3">
792	<desc>
793	A new (direct) session is being opened for the machine as a result of
794	<link to="IVirtualBox::openRemoteSession"/> call
795	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
796	This state also occurs as a short transient state when a new direct
797	session is opened by calling <link to="IVirtualBox::openSession"/>.
798	</desc>
799	</const>
800	<const name="Closing" value="4">
801	<desc>
802	The direct session is being closed (<link to="IMachine::sessionState"/>);
803	the session is being closed (<link to="ISession::state"/>)
804	</desc>
805	</const>
806	</enum>
807
808	<enum
809	name="CpuPropertyType"
810	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
811	>
812	<desc>
813	Virtual CPU property type. This enumeration represents possible values of the
814	IMachine get- and setCpuProperty methods.
815	</desc>
816	<const name="Null" value="0">
817	<desc>Null value (never used by the API).</desc>
818	</const>
819	<const name="PAE" value="1">
820	<desc>
821	This setting determines whether VirtualBox will expose the Physical Address
822	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
823	is not available, it will not be reported.
824	</desc>
825	</const>
826	<const name="Synthetic" value="2">
827	<desc>
828	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
829	teleporting between host systems that differ significantly.
830	</desc>
831	</const>
832	</enum>
833
834
835	<enum
836	name="HWVirtExPropertyType"
837	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
838	>
839	<desc>
840	Hardware virtualization property type. This enumeration represents possible values
841	for the <link to="IMachine::getHWVirtExProperty"/> and
842	<link to="IMachine::setHWVirtExProperty"/> methods.
843	</desc>
844	<const name="Null" value="0">
845	<desc>Null value (never used by the API).</desc>
846	</const>
847	<const name="Enabled" value="1">
848	<desc>
849	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
850	such extensions are not available, they will not be used.
851	</desc>
852	</const>
853	<const name="Exclusive" value="2">
854	<desc>
855	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
856	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
857	feature of the host. To share these with other hypervisors, you must disable this property.
858	</desc>
859	</const>
860	<const name="VPID" value="3">
861	<desc>
862	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
863	</desc>
864	</const>
865	<const name="NestedPaging" value="4">
866	<desc>
867	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
868	</desc>
869	</const>
870	</enum>
871
872	<enum
873	name="SessionType"
874	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
875	>
876	<desc>
877	Session type. This enumeration represents possible values of the
878	<link to="ISession::type"/> attribute.
879	</desc>
880
881	<const name="Null" value="0">
882	<desc>Null value (never used by the API).</desc>
883	</const>
884	<const name="Direct" value="1">
885	<desc>
886	Direct session
887	(opened by <link to="IVirtualBox::openSession"/>)
888	</desc>
889	</const>
890	<const name="Remote" value="2">
891	<desc>
892	Remote session
893	(opened by <link to="IVirtualBox::openRemoteSession"/>)
894	</desc>
895	</const>
896	<const name="Existing" value="3">
897	<desc>
898	Existing session
899	(opened by <link to="IVirtualBox::openExistingSession"/>)
900	</desc>
901	</const>
902	</enum>
903
904	<enum
905	name="DeviceType"
906	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
907	>
908	<desc>
909	Device type.
910	</desc>
911	<const name="Null" value="0">
912	<desc>
913	Null value, may also mean "no device" (not allowed for
914	<link to="IConsole::getDeviceActivity"/>).
915	</desc>
916	</const>
917	<const name="Floppy" value="1">
918	<desc>Floppy device.</desc>
919	</const>
920	<const name="DVD" value="2">
921	<desc>CD/DVD-ROM device.</desc>
922	</const>
923	<const name="HardDisk" value="3">
924	<desc>Hard disk device.</desc>
925	</const>
926	<const name="Network" value="4">
927	<desc>Network device.</desc>
928	</const>
929	<const name="USB" value="5">
930	<desc>USB device.</desc>
931	</const>
932	<const name="SharedFolder" value="6">
933	<desc>Shared folder device.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="DeviceActivity"
939	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
940	>
941	<desc>
942	Device activity for <link to="IConsole::getDeviceActivity"/>.
943	</desc>
944
945	<const name="Null" value="0"/>
946	<const name="Idle" value="1"/>
947	<const name="Reading" value="2"/>
948	<const name="Writing" value="3"/>
949	</enum>
950
951	<enum
952	name="ClipboardMode"
953	uuid="33364716-4008-4701-8f14-be0fa3d62950"
954	>
955	<desc>
956	Host-Guest clipboard interchange mode.
957	</desc>
958
959	<const name="Disabled" value="0"/>
960	<const name="HostToGuest" value="1"/>
961	<const name="GuestToHost" value="2"/>
962	<const name="Bidirectional" value="3"/>
963	</enum>
964
965	<enum
966	name="Scope"
967	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
968	>
969	<desc>
970	Scope of the operation.
971
972	A generic enumeration used in various methods to define the action or
973	argument scope.
974	</desc>
975
976	<const name="Global" value="0"/>
977	<const name="Machine" value="1"/>
978	<const name="Session" value="2"/>
979	</enum>
980
981	<enum
982	name="GuestStatisticType"
983	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
984	>
985	<desc>
986	Statistics type for <link to="IGuest::getStatistic"/>.
987	</desc>
988
989	<const name="CPULoad_Idle" value="0">
990	<desc>
991	Idle CPU load (0-100%) for last interval.
992	</desc>
993	</const>
994	<const name="CPULoad_Kernel" value="1">
995	<desc>
996	Kernel CPU load (0-100%) for last interval.
997	</desc>
998	</const>
999	<const name="CPULoad_User" value="2">
1000	<desc>
1001	User CPU load (0-100%) for last interval.
1002	</desc>
1003	</const>
1004	<const name="Threads" value="3">
1005	<desc>
1006	Total number of threads in the system.
1007	</desc>
1008	</const>
1009	<const name="Processes" value="4">
1010	<desc>
1011	Total number of processes in the system.
1012	</desc>
1013	</const>
1014	<const name="Handles" value="5">
1015	<desc>
1016	Total number of handles in the system.
1017	</desc>
1018	</const>
1019	<const name="MemoryLoad" value="6">
1020	<desc>
1021	Memory load (0-100%).
1022	</desc>
1023	</const>
1024	<const name="PhysMemTotal" value="7">
1025	<desc>
1026	Total physical memory in megabytes.
1027	</desc>
1028	</const>
1029	<const name="PhysMemAvailable" value="8">
1030	<desc>
1031	Free physical memory in megabytes.
1032	</desc>
1033	</const>
1034	<const name="PhysMemBalloon" value="9">
1035	<desc>
1036	Ballooned physical memory in megabytes.
1037	</desc>
1038	</const>
1039	<const name="MemCommitTotal" value="10">
1040	<desc>
1041	Total amount of memory in the committed state in megabytes.
1042	</desc>
1043	</const>
1044	<const name="MemKernelTotal" value="11">
1045	<desc>
1046	Total amount of memory used by the guest OS's kernel in megabytes.
1047	</desc>
1048	</const>
1049	<const name="MemKernelPaged" value="12">
1050	<desc>
1051	Total amount of paged memory used by the guest OS's kernel in megabytes.
1052	</desc>
1053	</const>
1054	<const name="MemKernelNonpaged" value="13">
1055	<desc>
1056	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1057	</desc>
1058	</const>
1059	<const name="MemSystemCache" value="14">
1060	<desc>
1061	Total amount of memory used by the guest OS's system cache in megabytes.
1062	</desc>
1063	</const>
1064	<const name="PageFileSize" value="15">
1065	<desc>
1066	Pagefile size in megabytes.
1067	</desc>
1068	</const>
1069	<const name="SampleNumber" value="16">
1070	<desc>
1071	Statistics sample number
1072	</desc>
1073	</const>
1074	<const name="MaxVal" value="17"/>
1075	</enum>
1076
1077	<enum
1078	name="BIOSBootMenuMode"
1079	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1080	>
1081	<desc>
1082	BIOS boot menu mode.
1083	</desc>
1084
1085	<const name="Disabled" value="0"/>
1086	<const name="MenuOnly" value="1"/>
1087	<const name="MessageAndMenu" value="2"/>
1088	</enum>
1089
1090	<enum
1091	name="ProcessorFeature"
1092	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1093	>
1094	<desc>
1095	CPU features.
1096	</desc>
1097
1098	<const name="HWVirtEx" value="0"/>
1099	<const name="PAE" value="1"/>
1100	<const name="LongMode" value="2"/>
1101	<const name="NestedPaging" value="3"/>
1102	</enum>
1103
1104	<enum
1105	name="FirmwareType"
1106	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1107	>
1108	<desc>
1109	Firmware type.
1110	</desc>
1111	<const name="BIOS" value="1">
1112	<desc>BIOS Firmware.</desc>
1113	</const>
1114	<const name="EFI" value="2">
1115	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1116	</const>
1117	<const name="EFI32" value="3">
1118	<desc>Efi firmware, 32-bit.</desc>
1119	</const>
1120	<const name="EFI64" value="4">
1121	<desc>Efi firmware, 64-bit.</desc>
1122	</const>
1123	<const name="EFIDUAL" value="5">
1124	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1125	</const>
1126	</enum>
1127
1128	<enum
1129	name="PointingHidType"
1130	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1131	>
1132	<desc>
1133	Type of pointing device used in a virtual machine.
1134	</desc>
1135	<const name="None" value="1">
1136	<desc>No mouse.</desc>
1137	</const>
1138	<const name="PS2Mouse" value="2">
1139	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1140	</const>
1141	<const name="USBMouse" value="3">
1142	<desc>USB mouse (relative pointer).</desc>
1143	</const>
1144	<const name="USBTablet" value="4">
1145	<desc>USB tablet (absolute pointer).</desc>
1146	</const>
1147	<const name="ComboMouse" value="5">
1148	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1149	Using of such device can have negative performance implications. </desc>
1150	</const>
1151	</enum>
1152
1153	<enum
1154	name="KeyboardHidType"
1155	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1156	>
1157	<desc>
1158	Type of keyboard device used in a virtual machine.
1159	</desc>
1160	<const name="None" value="1">
1161	<desc>No keyboard.</desc>
1162	</const>
1163	<const name="PS2Keyboard" value="2">
1164	<desc>PS/2 keyboard.</desc>
1165	</const>
1166	<const name="USBKeyboard" value="3">
1167	<desc>USB keyboard.</desc>
1168	</const>
1169	<const name="ComboKeyboard" value="4">
1170	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1171	Using of such device can have negative performance implications. </desc>
1172	</const>
1173	</enum>
1174
1175
1176
1177	<!--
1178	// IVirtualBoxErrorInfo
1179	/////////////////////////////////////////////////////////////////////////
1180	-->
1181
1182	<interface
1183	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1184	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1185	supportsErrorInfo="no"
1186	wsmap="managed"
1187	>
1188	<desc>
1189	The IVirtualBoxErrorInfo interface represents extended error information.
1190
1191	Extended error information can be set by VirtualBox components after
1192	unsuccessful or partially successful method invocation. This information
1193	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1194	and then shown to the client in addition to the plain 32-bit result code.
1195
1196	In MS COM, this interface extends the IErrorInfo interface,
1197	in XPCOM, it extends the nsIException interface. In both cases,
1198	it provides a set of common attributes to retrieve error
1199	information.
1200
1201	Sometimes invocation of some component's method may involve methods of
1202	other components that may also fail (independently of this method's
1203	failure), or a series of non-fatal errors may precede a fatal error that
1204	causes method failure. In cases like that, it may be desirable to preserve
1205	information about all errors happened during method invocation and deliver
1206	it to the caller. The <link to="#next"/> attribute is intended
1207	specifically for this purpose and allows to represent a chain of errors
1208	through a single IVirtualBoxErrorInfo object set after method invocation.
1209
1210	Note that errors are stored to a chain in the reverse order, i.e. the
1211	initial error object you query right after method invocation is the last
1212	error set by the callee, the object it points to in the @a next attribute
1213	is the previous error and so on, up to the first error (which is the last
1214	in the chain).
1215	</desc>
1216
1217	<attribute name="resultCode" type="long" readonly="yes">
1218	<desc>
1219	Result code of the error.
1220	Usually, it will be the same as the result code returned
1221	by the method that provided this error information, but not
1222	always. For example, on Win32, CoCreateInstance() will most
1223	likely return E_NOINTERFACE upon unsuccessful component
1224	instantiation attempt, but not the value the component factory
1225	returned. Value is typed 'long', not 'result',
1226	to make interface usable from scripting languages.
1227	<note>
1228	In MS COM, there is no equivalent.
1229	In XPCOM, it is the same as nsIException::result.
1230	</note>
1231	</desc>
1232	</attribute>
1233
1234	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1235	<desc>
1236	UUID of the interface that defined the error.
1237	<note>
1238	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1239	data type.
1240	In XPCOM, there is no equivalent.
1241	</note>
1242	</desc>
1243	</attribute>
1244
1245	<attribute name="component" type="wstring" readonly="yes">
1246	<desc>
1247	Name of the component that generated the error.
1248	<note>
1249	In MS COM, it is the same as IErrorInfo::GetSource.
1250	In XPCOM, there is no equivalent.
1251	</note>
1252	</desc>
1253	</attribute>
1254
1255	<attribute name="text" type="wstring" readonly="yes">
1256	<desc>
1257	Text description of the error.
1258	<note>
1259	In MS COM, it is the same as IErrorInfo::GetDescription.
1260	In XPCOM, it is the same as nsIException::message.
1261	</note>
1262	</desc>
1263	</attribute>
1264
1265	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1266	<desc>
1267	Next error object if there is any, or @c null otherwise.
1268	<note>
1269	In MS COM, there is no equivalent.
1270	In XPCOM, it is the same as nsIException::inner.
1271	</note>
1272	</desc>
1273	</attribute>
1274
1275	</interface>
1276
1277	<interface
1278	name="ILocalOwner" extends="$dispatched"
1279	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1280	>
1281	<desc>
1282	The ILocalOwner interface allows to register local objects
1283	(created without COM calls, but with new()).
1284	Once registered, calls to methods of such objects can be made
1285	from remote COM processes.
1286	The main usecase is the event callback implementation where
1287	API clients provide callback objects.
1288	</desc>
1289	<method name="setLocalObject">
1290	<desc>
1291	Set local object.
1292	</desc>
1293	<param name="object" type="$unknown" dir="in">
1294	<desc>Local object to forward requests to.
1295	If null, clears currently set local object.</desc>
1296	</param>
1297	</method>
1298	</interface>
1299
1300	<!--
1301	// IVirtualBox
1302	/////////////////////////////////////////////////////////////////////////
1303	-->
1304
1305	<interface
1306	name="IVirtualBoxCallback" extends="$unknown"
1307	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1308	wsmap="suppress"
1309	>
1310
1311	<method name="onMachineStateChange">
1312	<desc>
1313	The execution state of the given machine has changed.
1314	<see>IMachine::state</see>
1315	</desc>
1316	<param name="machineId" type="uuid" mod="string" dir="in">
1317	<desc>ID of the machine this event relates to.</desc>
1318	</param>
1319	<param name="state" type="MachineState" dir="in">
1320	<desc>New execution state.</desc>
1321	</param>
1322	</method>
1323
1324	<method name="onMachineDataChange">
1325	<desc>
1326	Any of the settings of the given machine has changed.
1327	</desc>
1328	<param name="machineId" type="uuid" mod="string" dir="in">
1329	<desc>ID of the machine this event relates to.</desc>
1330	</param>
1331	</method>
1332
1333	<method name="onExtraDataCanChange">
1334	<desc>
1335	Notification when someone tries to change extra data for
1336	either the given machine or (if @c null) global extra data.
1337	This gives the chance to veto against changes.
1338	</desc>
1339	<param name="machineId" type="uuid" mod="string" dir="in">
1340	<desc>
1341	ID of the machine this event relates to
1342	(@c null ID for global extra data change requests).
1343	</desc>
1344	</param>
1345	<param name="key" type="wstring" dir="in">
1346	<desc>
1347	Extra data key for the attempted write.
1348	</desc>
1349	</param>
1350	<param name="value" type="wstring" dir="in">
1351	<desc>
1352	Extra data value for the given key.
1353	</desc>
1354	</param>
1355	<param name="error" type="wstring" dir="out">
1356	<desc>
1357	Optional error message describing the reason of the
1358	veto (ignored if this notification returns @c true).
1359	</desc>
1360	</param>
1361	<param name="allowChange" type="boolean" dir="return">
1362	<desc>
1363	Flag to indicate whether the callee agrees (@c true)
1364	or vetoes against the change (@c false).
1365	</desc>
1366	</param>
1367	</method>
1368
1369	<method name="onExtraDataChange">
1370	<desc>
1371	Notification when machine specific or global extra data
1372	has changed.
1373	</desc>
1374	<param name="machineId" type="uuid" mod="string" dir="in">
1375	<desc>
1376	ID of the machine this event relates to.
1377	Null for global extra data changes.
1378	</desc>
1379	</param>
1380	<param name="key" type="wstring" dir="in">
1381	<desc>
1382	Extra data key that has changed.
1383	</desc>
1384	</param>
1385	<param name="value" type="wstring" dir="in">
1386	<desc>
1387	Extra data value for the given key.
1388	</desc>
1389	</param>
1390	</method>
1391
1392	<method name="onMediumRegistered">
1393	<desc>
1394	The given medium was registered or unregistered
1395	within this VirtualBox installation.
1396
1397	The @a mediumType parameter describes what type of
1398	medium the specified @a mediumId refers to. Possible
1399	values are:
1400
1401	<ul>
1402	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1403	that, if registered, can be obtained using the
1404	<link to="IVirtualBox::getHardDisk"/> call.</li>
1405	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1406	that, if registered, can be obtained using the
1407	<link to="IVirtualBox::getDVDImage"/> call.</li>
1408	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1409	that, if registered, can be obtained using the
1410	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1411	</ul>
1412
1413	Note that if this is a deregistration notification,
1414	there is no way to access the object representing the
1415	unregistered medium. It is supposed that the
1416	application will do required cleanup based on the
1417	@a mediumId value.
1418	</desc>
1419	<param name="mediumId" type="uuid" mod="string" dir="in">
1420	<desc>ID of the medium this event relates to.</desc>
1421	</param>
1422	<param name="mediumType" type="DeviceType" dir="in">
1423	<desc>Type of the medium this event relates to.</desc>
1424	</param>
1425	<param name="registered" type="boolean" dir="in">
1426	<desc>
1427	If @c true, the medium was registered, otherwise it was
1428	unregistered.
1429	</desc>
1430	</param>
1431	</method>
1432
1433	<method name="onMachineRegistered">
1434	<desc>
1435	The given machine was registered or unregistered
1436	within this VirtualBox installation.
1437	</desc>
1438	<param name="machineId" type="uuid" mod="string" dir="in">
1439	<desc>ID of the machine this event relates to.</desc>
1440	</param>
1441	<param name="registered" type="boolean" dir="in">
1442	<desc>
1443	If @c true, the machine was registered, otherwise it was
1444	unregistered.
1445	</desc>
1446	</param>
1447	</method>
1448
1449	<method name="onSessionStateChange">
1450	<desc>
1451	The state of the session for the given machine was changed.
1452	<see>IMachine::sessionState</see>
1453	</desc>
1454	<param name="machineId" type="uuid" mod="string" dir="in">
1455	<desc>ID of the machine this event relates to.</desc>
1456	</param>
1457	<param name="state" type="SessionState" dir="in">
1458	<desc>New session state.</desc>
1459	</param>
1460	</method>
1461
1462	<method name="onSnapshotTaken">
1463	<desc>
1464	A new snapshot of the machine has been taken.
1465	<see>ISnapshot</see>
1466	</desc>
1467	<param name="machineId" type="uuid" mod="string" dir="in">
1468	<desc>ID of the machine this event relates to.</desc>
1469	</param>
1470	<param name="snapshotId" type="uuid" mod="string" dir="in">
1471	<desc>ID of the new snapshot.</desc>
1472	</param>
1473	</method>
1474
1475	<method name="onSnapshotDiscarded">
1476	<desc>
1477	Snapshot of the given machine has been discarded.
1478
1479	<note>
1480	This notification is delivered <b>after</b> the snapshot
1481	object has been uninitialized on the server (so that any
1482	attempt to call its methods will return an error).
1483	</note>
1484
1485	<see>ISnapshot</see>
1486	</desc>
1487	<param name="machineId" type="uuid" mod="string" dir="in">
1488	<desc>ID of the machine this event relates to.</desc>
1489	</param>
1490	<param name="snapshotId" type="uuid" mod="string" dir="in">
1491	<desc>
1492	ID of the discarded snapshot. @c null means the current machine
1493	state has been discarded (restored from the current snapshot).
1494	</desc>
1495	</param>
1496	</method>
1497
1498	<method name="onSnapshotChange">
1499	<desc>
1500	Snapshot properties (name and/or description) have been changed.
1501	<see>ISnapshot</see>
1502	</desc>
1503	<param name="machineId" type="uuid" mod="string" dir="in">
1504	<desc>ID of the machine this event relates to.</desc>
1505	</param>
1506	<param name="snapshotId" type="uuid" mod="string" dir="in">
1507	<desc>ID of the changed snapshot.</desc>
1508	</param>
1509	</method>
1510
1511	<method name="onGuestPropertyChange">
1512	<desc>
1513	Notification when a guest property has changed.
1514	</desc>
1515	<param name="machineId" type="uuid" mod="string" dir="in">
1516	<desc>
1517	ID of the machine this event relates to.
1518	</desc>
1519	</param>
1520	<param name="name" type="wstring" dir="in">
1521	<desc>
1522	The name of the property that has changed.
1523	</desc>
1524	</param>
1525	<param name="value" type="wstring" dir="in">
1526	<desc>
1527	The new property value.
1528	</desc>
1529	</param>
1530	<param name="flags" type="wstring" dir="in">
1531	<desc>
1532	The new property flags.
1533	</desc>
1534	</param>
1535	</method>
1536
1537	</interface>
1538
1539	<interface
1540	name="IDHCPServer" extends="$unknown"
1541	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1542	wsmap="managed"
1543	>
1544	<desc>
1545	The IDHCPServer interface represents the vbox dhcp server configuration.
1546
1547	To enumerate all the dhcp servers on the host, use the
1548	<link to="IVirtualBox::DHCPServers"/> attribute.
1549	</desc>
1550
1551	<attribute name="enabled" type="boolean">
1552	<desc>
1553	specifies if the dhcp server is enabled
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="IPAddress" type="wstring" readonly="yes">
1558	<desc>
1559	specifies server IP
1560	</desc>
1561	</attribute>
1562
1563	<attribute name="networkMask" type="wstring" readonly="yes">
1564	<desc>
1565	specifies server network mask
1566	</desc>
1567	</attribute>
1568
1569	<attribute name="networkName" type="wstring" readonly="yes">
1570	<desc>
1571	specifies internal network name the server is used for
1572	</desc>
1573	</attribute>
1574
1575	<attribute name="lowerIP" type="wstring" readonly="yes">
1576	<desc>
1577	specifies from IP adrres in server address range
1578	</desc>
1579	</attribute>
1580
1581	<attribute name="upperIP" type="wstring" readonly="yes">
1582	<desc>
1583	specifies to IP adrres in server address range
1584	</desc>
1585	</attribute>
1586
1587	<method name="setConfiguration">
1588	<desc>
1589	configures the server
1590	<result name="E_INVALIDARG">
1591	invalid configuration supplied
1592	</result>
1593	</desc>
1594	<param name="IPAddress" type="wstring" dir="in">
1595	<desc>
1596	server IP address
1597	</desc>
1598	</param>
1599	<param name="networkMask" type="wstring" dir="in">
1600	<desc>
1601	server network mask
1602	</desc>
1603	</param>
1604	<param name="FromIPAddress" type="wstring" dir="in">
1605	<desc>
1606	server From IP address for address range
1607	</desc>
1608	</param>
1609	<param name="ToIPAddress" type="wstring" dir="in">
1610	<desc>
1611	server To IP address for address range
1612	</desc>
1613	</param>
1614	</method>
1615
1616	<method name="start">
1617	<desc>
1618	Starts DHCP server process.
1619	<result name="E_FAIL">
1620	Failed to start the process.
1621	</result>
1622	</desc>
1623	<param name="networkName" type="wstring" dir="in">
1624	<desc>
1625	Name of internal network DHCP server should attach to.
1626	</desc>
1627	</param>
1628	<param name="trunkName" type="wstring" dir="in">
1629	<desc>
1630	Name of internal network trunk.
1631	</desc>
1632	</param>
1633	<param name="trunkType" type="wstring" dir="in">
1634	<desc>
1635	Type of internal network trunk.
1636	</desc>
1637	</param>
1638	</method>
1639
1640	<method name="stop">
1641	<desc>
1642	Stops DHCP server process.
1643	<result name="E_FAIL">
1644	Failed to stop the process.
1645	</result>
1646	</desc>
1647	</method>
1648	</interface>
1649
1650	<interface
1651	name="IVirtualBox" extends="$dispatched"
1652	uuid="2158464a-f706-414b-a8c4-fb589dfc6b62"
1653	wsmap="managed"
1654	>
1655	<desc>
1656	The IVirtualBox interface represents the main interface exposed by the
1657	product that provides virtual machine management.
1658
1659	An instance of IVirtualBox is required for the product to do anything
1660	useful. Even though the interface does not expose this, internally,
1661	IVirtualBox is implemented as a singleton and actually lives in the
1662	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1663	IVirtualBox can track the state of all virtual machines on a particular
1664	host, regardless of which frontend started them.
1665
1666	To enumerate all the virtual machines on the host, use the
1667	<link to="IVirtualBox::machines"/> attribute.
1668	</desc>
1669
1670	<attribute name="version" type="wstring" readonly="yes">
1671	<desc>
1672	A string representing the version number of the product. The
1673	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1674	last number represents the build number and will frequently change.
1675	</desc>
1676	</attribute>
1677
1678	<attribute name="revision" type="unsigned long" readonly="yes">
1679	<desc>
1680	The internal build revision number of the product.
1681	</desc>
1682	</attribute>
1683
1684	<attribute name="packageType" type="wstring" readonly="yes">
1685	<desc>
1686	A string representing the package type of this product. The
1687	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1688	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1689	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1690	this.
1691	</desc>
1692	</attribute>
1693
1694	<attribute name="homeFolder" type="wstring" readonly="yes">
1695	<desc>
1696	Full path to the directory where the global settings file,
1697	<tt>VirtualBox.xml</tt>, is stored.
1698
1699	In this version of VirtualBox, the value of this property is
1700	always <tt><user_dir>/.VirtualBox</tt> (where
1701	<tt><user_dir></tt> is the path to the user directory,
1702	as determined by the host OS), and cannot be changed.
1703
1704	This path is also used as the base to resolve relative paths in
1705	places where relative paths are allowed (unless otherwise
1706	expressly indicated).
1707	</desc>
1708	</attribute>
1709
1710	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1711	<desc>
1712	Full name of the global settings file.
1713	The value of this property corresponds to the value of
1714	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1715	</desc>
1716	</attribute>
1717
1718	<attribute name="host" type="IHost" readonly="yes">
1719	<desc>Associated host object.</desc>
1720	</attribute>
1721
1722	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1723	<desc>Associated system information object.</desc>
1724	</attribute>
1725
1726	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1727	<desc>
1728	Array of machine objects registered within this VirtualBox instance.
1729	</desc>
1730	</attribute>
1731
1732	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1733	<desc>
1734	Array of medium objects known to this VirtualBox installation.
1735
1736	This array contains only base media. All differencing
1737	media of the given base medium can be enumerated using
1738	<link to="IMedium::children"/>.
1739	</desc>
1740	</attribute>
1741
1742	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1743	<desc>
1744	Array of CD/DVD image objects registered with this VirtualBox instance.
1745	</desc>
1746	</attribute>
1747
1748	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1749	<desc>
1750	Array of floppy image objects registered with this VirtualBox instance.
1751	</desc>
1752	</attribute>
1753
1754	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1755
1756	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1757
1758	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1759	<desc>
1760	Collection of global shared folders. Global shared folders are
1761	available to all virtual machines.
1762
1763	New shared folders are added to the collection using
1764	<link to="#createSharedFolder"/>. Existing shared folders can be
1765	removed using <link to="#removeSharedFolder"/>.
1766
1767	<note>
1768	In the current version of the product, global shared folders are not
1769	implemented and therefore this collection is always empty.
1770	</note>
1771	</desc>
1772	</attribute>
1773
1774	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1775	<desc>
1776	Associated performance collector object.
1777	</desc>
1778	</attribute>
1779
1780	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1781	<desc>
1782	dhcp server settings.
1783	</desc>
1784	</attribute>
1785
1786	<method name="createMachine">
1787	<desc>
1788	Creates a new virtual machine.
1789
1790	The new machine is created unregistered, with the initial configuration
1791	set according to the specified guest OS type. A typical sequence of
1792	actions to create a new virtual machine is as follows:
1793
1794	<ol>
1795	<li>
1796	Call this method to have a new machine created. The returned machine
1797	object will be "mutable" allowing to change any machine property.
1798	</li>
1799
1800	<li>
1801	Configure the machine using the appropriate attributes and methods.
1802	</li>
1803
1804	<li>
1805	Call <link to="IMachine::saveSettings" /> to write the settings
1806	to the machine's XML settings file. The configuration of the newly
1807	created machine will not be saved to disk until this method is
1808	called.
1809	</li>
1810
1811	<li>
1812	Call <link to="#registerMachine" /> to add the machine to the list
1813	of machines known to VirtualBox.
1814	</li>
1815	</ol>
1816
1817	You should specify valid name for the newly created machine when calling
1818	this method. See the <link to="IMachine::name"/> attribute description
1819	for more details about the machine name.
1820
1821	The specified guest OS type identifier must match an ID of one of known
1822	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1823	array.
1824
1825	Every machine has a <i>settings file</i> that is used to store
1826	the machine configuration. This file is stored in a directory called the
1827	<i>machine settings subfolder</i>. Both the settings subfolder and file
1828	will have a name that corresponds to the name of the virtual machine.
1829	You can specify where to create the machine setting subfolder using the
1830	@a baseFolder argument. The base folder can be absolute (full path) or
1831	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1832	directory</link>.
1833
1834	If @a baseFolder is a @c null or empty string (which is recommended), the
1835	<link to="ISystemProperties::defaultMachineFolder">default machine
1836	settings folder</link> will be used as a base folder for the created
1837	machine. Otherwise the given base folder will be used. In either case,
1838	the full path to the resulting settings file has the following
1839	structure:
1840	<pre>
1841	<base_folder>/<machine_name>/<machine_name>.xml
1842	</pre>
1843
1844	Note that if the resulting settings file already exists, this method
1845	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1846
1847	Optionally, you may specify an UUID of to assign to the created machine.
1848	However, this is not recommended and you should normally pass an empty
1849	(@c null) UUID to this method so that a new UUID will be automatically
1850	generated for every created machine. You can use UUID
1851	00000000-0000-0000-0000-000000000000 as @c null value.
1852
1853	<note>
1854	There is no way to change the name of the settings file or
1855	subfolder of the created machine directly.
1856	</note>
1857
1858	<result name="VBOX_E_OBJECT_NOT_FOUND">
1859	@a osTypeId is invalid.
1860	</result>
1861	<result name="VBOX_E_FILE_ERROR">
1862	Resulting settings file name is invalid or the settings file already
1863	exists or could not be created due to an I/O error.
1864	</result>
1865	<result name="E_INVALIDARG">
1866	@a name is empty or @c null.
1867	</result>
1868	</desc>
1869
1870	<param name="name" type="wstring" dir="in">
1871	<desc>Machine name.</desc>
1872	</param>
1873	<param name="osTypeId" type="wstring" dir="in">
1874	<desc>Guest OS Type ID.</desc>
1875	</param>
1876	<param name="baseFolder" type="wstring" dir="in">
1877	<desc>Base machine folder (optional).</desc>
1878	</param>
1879	<param name="id" type="uuid" mod="string" dir="in">
1880	<desc>Machine UUID (optional).</desc>
1881	</param>
1882	<param name="machine" type="IMachine" dir="return">
1883	<desc>Created machine object.</desc>
1884	</param>
1885	</method>
1886
1887	<method name="createLegacyMachine">
1888	<desc>
1889	Creates a new virtual machine in "legacy" mode, using the specified
1890	settings file to store machine settings.
1891
1892	As opposed to machines created by <link to="#createMachine"/>,
1893	the settings file of the machine created in "legacy" mode is not
1894	automatically renamed when the machine name is changed -- it will always
1895	remain the same as specified in this method call.
1896
1897	The specified settings file name can be absolute (full path) or relative
1898	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1899	directory</link>. If the file name doesn't contain an extension, the
1900	default extension (.xml) will be appended.
1901
1902	Note that the configuration of the newly created machine is not
1903	saved to disk (and therefore no settings file is created)
1904	until <link to="IMachine::saveSettings"/> is called. If the
1905	specified settings file already exists, this method
1906	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1907
1908	See <link to="#createMachine"/> for more information.
1909
1910	@deprecated This method may be removed later. Use <link
1911	to="IVirtualBox::createMachine"/> instead.
1912
1913	<note>
1914	There is no way to change the name of the settings file
1915	of the machine created in "legacy" mode.
1916	</note>
1917
1918	<result name="VBOX_E_OBJECT_NOT_FOUND">
1919	@a osTypeId is invalid.
1920	</result>
1921	<result name="VBOX_E_FILE_ERROR">
1922	@a settingsFile is invalid or the settings file already exists or
1923	could not be created due to an I/O error.
1924	</result>
1925	<result name="E_INVALIDARG">
1926	@a name or @a settingsFile is empty or @c null.
1927	</result>
1928	</desc>
1929
1930	<param name="name" type="wstring" dir="in">
1931	<desc>Machine name.</desc>
1932	</param>
1933	<param name="osTypeId" type="wstring" dir="in">
1934	<desc>Machine OS Type ID.</desc>
1935	</param>
1936	<param name="settingsFile" type="wstring" dir="in">
1937	<desc>Name of the machine settings file.</desc>
1938	</param>
1939	<param name="id" type="uuid" mod="string" dir="in">
1940	<desc>Machine UUID (optional).</desc>
1941	</param>
1942	<param name="machine" type="IMachine" dir="return">
1943	<desc>Created machine object.</desc>
1944	</param>
1945	</method>
1946
1947	<method name="openMachine">
1948	<desc>
1949	Opens a virtual machine from the existing settings file.
1950	The opened machine remains unregistered until you call
1951	<link to="#registerMachine"/>.
1952
1953	The specified settings file name can be absolute
1954	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1955	VirtualBox home directory</link>. This file must exist
1956	and must be a valid machine settings file whose contents
1957	will be used to construct the machine object.
1958
1959	@deprecated Will be removed soon.
1960	<result name="VBOX_E_FILE_ERROR">
1961	Settings file name invalid, not found or sharing violation.
1962	</result>
1963	</desc>
1964	<param name="settingsFile" type="wstring" dir="in">
1965	<desc>
1966	Name of the machine settings file.
1967	</desc>
1968	</param>
1969	<param name="machine" type="IMachine" dir="return">
1970	<desc>Opened machine object.</desc>
1971	</param>
1972	<note>
1973	<link to="IMachine::settingsModified"/> will return
1974	@c false for the created machine, until any of machine settings
1975	are changed.
1976	</note>
1977	</method>
1978
1979	<method name="registerMachine">
1980	<desc>
1981
1982	Registers the machine previously created using
1983	<link to="#createMachine"/> or opened using
1984	<link to="#openMachine"/> within this VirtualBox installation. After
1985	successful method invocation, the
1986	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1987	to all registered callbacks.
1988
1989	<note>
1990	This method implicitly calls <link to="IMachine::saveSettings"/>
1991	to save all current machine settings before registering it.
1992	</note>
1993
1994	<result name="VBOX_E_OBJECT_NOT_FOUND">
1995	No matching virtual machine found.
1996	</result>
1997	<result name="VBOX_E_INVALID_OBJECT_STATE">
1998	Virtual machine was not created within this VirtualBox instance.
1999	</result>
2000
2001	</desc>
2002	<param name="machine" type="IMachine" dir="in"/>
2003	</method>
2004
2005	<method name="getMachine">
2006	<desc>
2007	Attempts to find a virtual machine given its UUID.
2008	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
2009	instead.
2010
2011	<result name="VBOX_E_OBJECT_NOT_FOUND">
2012	Could not find registered machine matching @a id.
2013	</result>
2014
2015	</desc>
2016	<param name="id" type="uuid" mod="string" dir="in"/>
2017	<param name="machine" type="IMachine" dir="return"/>
2018	</method>
2019
2020	<method name="findMachine">
2021	<desc>
2022	Attempts to find a virtual machine given its name.
2023	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
2024	instead.
2025
2026	<result name="VBOX_E_OBJECT_NOT_FOUND">
2027	Could not find registered machine matching @a name.
2028	</result>
2029
2030	</desc>
2031	<param name="name" type="wstring" dir="in"/>
2032	<param name="machine" type="IMachine" dir="return"/>
2033	</method>
2034
2035	<method name="unregisterMachine">
2036	<desc>
2037
2038	Unregisters the machine previously registered using
2039	<link to="#registerMachine"/>. After successful method invocation, the
2040	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
2041	to all registered callbacks.
2042
2043	<note>
2044	The specified machine must not be in the Saved state, have an open
2045	(or a spawning) direct session associated with it, have snapshots or
2046	have any medium attached.
2047	</note>
2048
2049	<note>
2050	This method implicitly calls <link to="IMachine::saveSettings"/> to
2051	save all current machine settings before unregistering it.
2052	</note>
2053
2054	<note>
2055	If the given machine is inaccessible (see
2056	<link to="IMachine::accessible"/>), it will be unregistered and
2057	fully uninitialized right afterwards. As a result, the returned
2058	machine object will be unusable and an attempt to call
2059	<b>any</b> method will return the "Object not ready" error.
2060	</note>
2061
2062	<result name="VBOX_E_OBJECT_NOT_FOUND">
2063	Could not find registered machine matching @a id.
2064	</result>
2065	<result name="VBOX_E_INVALID_VM_STATE">
2066	Machine is in Saved state.
2067	</result>
2068	<result name="VBOX_E_INVALID_OBJECT_STATE">
2069	Machine has snapshot or open session or medium attached.
2070	</result>
2071
2072	</desc>
2073	<param name="id" type="uuid" mod="string" dir="in">
2074	<desc>UUID of the machine to unregister.</desc>
2075	</param>
2076	<param name="machine" type="IMachine" dir="return">
2077	<desc>Unregistered machine object.</desc>
2078	</param>
2079	</method>
2080
2081	<method name="createAppliance">
2082	<desc>
2083	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2084	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2085	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2086	</desc>
2087	<param name="appliance" type="IAppliance" dir="return">
2088	<desc>New appliance.</desc>
2089	</param>
2090	</method>
2091
2092	<method name="createHardDisk">
2093	<desc>
2094	Creates a new base medium object that will use the given storage
2095	format and location for medium data.
2096
2097	Note that the actual storage unit is not created by this method. In
2098	order to do it, and before you are able to attach the created medium
2099	to virtual machines, you must call one of the following methods to
2100	allocate a format-specific storage unit at the specified location:
2101	<ul>
2102	<li><link to="IMedium::createBaseStorage"/></li>
2103	<li><link to="IMedium::createDiffStorage"/></li>
2104	</ul>
2105
2106	Some medium attributes, such as <link to="IMedium::id"/>, may
2107	remain uninitialized until the medium storage unit is successfully
2108	created by one of the above methods.
2109
2110	After the storage unit is successfully created, the medium gets
2111	remembered by this VirtualBox installation and will be accessible
2112	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2113	methods. Remembered base medium are also returned as part of
2114	the <link to="#hardDisks"/> array. See IMedium for more details.
2115
2116	The list of all storage formats supported by this VirtualBox
2117	installation can be obtained using
2118	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2119	attribute is empty or @c null then the default storage format
2120	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2121	be used for creating a storage unit of the medium.
2122
2123	Note that the format of the location string is storage format specific.
2124	See <link to="IMedium::location"/>, IMedium and
2125	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2126
2127	<result name="VBOX_E_OBJECT_NOT_FOUND">
2128	@a format identifier is invalid. See
2129	<link to="ISystemProperties::mediumFormats"/>.
2130	</result>
2131	<result name="VBOX_E_FILE_ERROR">
2132	@a location is a not valid file name (for file-based formats only).
2133	</result>
2134	</desc>
2135	<param name="format" type="wstring" dir="in">
2136	<desc>
2137	Identifier of the storage format to use for the new medium.
2138	</desc>
2139	</param>
2140	<param name="location" type="wstring" dir="in">
2141	<desc>
2142	Location of the storage unit for the new medium.
2143	</desc>
2144	</param>
2145	<param name="medium" type="IMedium" dir="return">
2146	<desc>Created medium object.</desc>
2147	</param>
2148	</method>
2149
2150	<method name="openHardDisk">
2151	<desc>
2152	Opens a medium from an existing location, optionally replacing
2153	the image UUID and/or parent UUID.
2154
2155	After the medium is successfully opened by this method, it gets
2156	remembered by (known to) this VirtualBox installation and will be
2157	accessible through <link to="#getHardDisk"/> and
2158	<link to="#findHardDisk"/> methods. Remembered base media
2159	are also returned as part of the <link to="#hardDisks"/> array and can
2160	be attached to virtual machines. See IMedium for more details.
2161
2162	If a differencing medium is to be opened by this method, the
2163	operation will succeed only if its parent medium and all ancestors,
2164	if any, are already known to this VirtualBox installation (for example,
2165	were opened by this method before).
2166
2167	This method tries to guess the storage format of the specified medium
2168	by reading medium data at the specified location.
2169
2170	If @a write is ReadWrite (which it should be), the image is opened for
2171	read/write access and must have according permissions, as VirtualBox
2172	may actually write status information into the disk's metadata sections.
2173
2174	Note that write access is required for all typical image usage in VirtualBox,
2175	since VirtualBox may need to write metadata such as a UUID into the image.
2176	The only exception is opening a source image temporarily for copying and
2177	cloning when the image will quickly be closed again.
2178
2179	Note that the format of the location string is storage format specific.
2180	See <link to="IMedium::location"/>, IMedium and
2181	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2182
2183	<result name="VBOX_E_FILE_ERROR">
2184	Invalid medium storage file location or could not find the medium
2185	at the specified location.
2186	</result>
2187	<result name="VBOX_E_IPRT_ERROR">
2188	Could not get medium storage format.
2189	</result>
2190	<result name="E_INVALIDARG">
2191	Invalid medium storage format.
2192	</result>
2193
2194	</desc>
2195	<param name="location" type="wstring" dir="in">
2196	<desc>
2197	Location of the storage unit that contains medium data in one of
2198	the supported storage formats.
2199	</desc>
2200	</param>
2201	<param name="accessMode" type="AccessMode" dir="in">
2202	<desc>
2203	Determines whether to open the image in read/write or read-only mode.
2204	</desc>
2205	</param>
2206	<param name="setImageId" type="boolean" dir="in">
2207	<desc>
2208	Select whether a new image UUID is set or not.
2209	</desc>
2210	</param>
2211	<param name="imageId" type="uuid" mod="string" dir="in">
2212	<desc>
2213	New UUID for the image. If an empty string is passed, then a new
2214	UUID is automatically created. Specifying a zero UUIDs is not valid.
2215	</desc>
2216	</param>
2217	<param name="setParentId" type="boolean" dir="in">
2218	<desc>
2219	Select whether a new parent UUID is set or not.
2220	</desc>
2221	</param>
2222	<param name="parentId" type="uuid" mod="string" dir="in">
2223	<desc>
2224	New parent UUID for the image. If an empty string is passed, then a
2225	new UUID is automatically created, provided @a setParentId is
2226	@c true. A zero UUID is valid.
2227	</desc>
2228	</param>
2229	<param name="medium" type="IMedium" dir="return">
2230	<desc>Opened medium object.</desc>
2231	</param>
2232	</method>
2233
2234	<method name="getHardDisk" const="yes">
2235	<desc>
2236	Returns a medium with the given UUID.
2237
2238	The medium with the given UUID must be known to this VirtualBox
2239	installation, i.e. it must be previously created by
2240	<link to="#createHardDisk"/> or opened by <link
2241	to="#openHardDisk"/>, or attached to some known virtual machine.
2242
2243	<result name="VBOX_E_OBJECT_NOT_FOUND">
2244	No medium object matching @a id found.
2245	</result>
2246
2247	</desc>
2248	<param name="id" type="uuid" mod="string" dir="in">
2249	<desc>UUID of the medium to look for.</desc>
2250	</param>
2251	<param name="medium" type="IMedium" dir="return">
2252	<desc>Found medium object.</desc>
2253	</param>
2254	</method>
2255
2256	<method name="findHardDisk">
2257	<desc>
2258	Returns a medium that uses the given location to store medium data.
2259
2260	The given medium must be known to this VirtualBox installation, i.e.
2261	it must be previously created by
2262	<link to="#createHardDisk"/> or opened by <link
2263	to="#openHardDisk"/>, or attached to some known virtual machine.
2264
2265	The search is done by comparing the value of the @a location argument to
2266	the <link to="IMedium::location"/> attribute of each known medium.
2267
2268	For locations represented by file names in the host's file system, the
2269	requested location can be a path relative to the
2270	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2271	only a file name without any path is given, the
2272	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2273	folder</link> will be prepended to the file name before searching. Note
2274	that on case sensitive file systems, a case sensitive comparison is
2275	performed, otherwise the case of symbols in the file path is ignored.
2276
2277	<result name="VBOX_E_OBJECT_NOT_FOUND">
2278	No medium object matching @a location found.
2279	</result>
2280
2281	</desc>
2282	<param name="location" type="wstring" dir="in">
2283	<desc>Location string to search for.</desc>
2284	</param>
2285	<param name="medium" type="IMedium" dir="return">
2286	<desc>Found medium object.</desc>
2287	</param>
2288	</method>
2289
2290	<method name="openDVDImage">
2291	<desc>
2292	Opens a CD/DVD image contained in the specified file of the supported
2293	format and assigns it the given UUID.
2294
2295	After the image is successfully opened by this method, it gets
2296	remembered by (known to) this VirtualBox installation and will be
2297	accessible through <link to="#getDVDImage"/> and
2298	<link to="#findDVDImage"/> methods. Remembered images are also
2299	returned as part of the <link to="#DVDImages"/> array and can be mounted
2300	to virtual machines. See IMedium for more details.
2301
2302	See <link to="IMedium::location"/> to get more details about the format
2303	of the location string.
2304
2305	<note>
2306	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2307	</note>
2308
2309	<result name="VBOX_E_FILE_ERROR">
2310	Invalid CD/DVD image file location or could not find the CD/DVD
2311	image at the specified location.
2312	</result>
2313	<result name="VBOX_E_INVALID_OBJECT_STATE">
2314	CD/DVD image already exists in the media registry.
2315	</result>
2316
2317	</desc>
2318	<param name="location" type="wstring" dir="in">
2319	<desc>
2320	Full path to the file that contains a valid CD/DVD image.
2321	</desc>
2322	</param>
2323	<param name="id" type="uuid" mod="string" dir="in">
2324	<desc>
2325	UUID to assign to the given image within this VirtualBox installation.
2326	If an empty (@c null) UUID is specified, the system will randomly
2327	generate a new UUID.
2328	</desc>
2329	</param>
2330	<param name="image" type="IMedium" dir="return">
2331	<desc>Opened CD/DVD image object.</desc>
2332	</param>
2333	</method>
2334
2335	<method name="getDVDImage">
2336	<desc>
2337	Returns a CD/DVD image with the given UUID.
2338
2339	The image with the given UUID must be known to this VirtualBox
2340	installation, i.e. it must be previously opened by <link
2341	to="#openDVDImage"/>, or mounted to some known virtual machine.
2342
2343	<result name="VBOX_E_OBJECT_NOT_FOUND">
2344	No matching DVD image found in the media registry.
2345	</result>
2346
2347	</desc>
2348	<param name="id" type="uuid" mod="string" dir="in">
2349	<desc>UUID of the image to look for.</desc>
2350	</param>
2351	<param name="image" type="IMedium" dir="return">
2352	<desc>Found CD/DVD image object.</desc>
2353	</param>
2354	</method>
2355
2356	<method name="findDVDImage">
2357	<desc>
2358	Returns a CD/DVD image with the given image location.
2359
2360	The image with the given UUID must be known to this VirtualBox
2361	installation, i.e. it must be previously opened by <link
2362	to="#openDVDImage"/>, or mounted to some known virtual machine.
2363
2364	The search is done by comparing the value of the @a location argument to
2365	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2366
2367	The requested location can be a path relative to the
2368	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2369	only a file name without any path is given, the
2370	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2371	folder</link> will be prepended to the file name before searching. Note
2372	that on case sensitive file systems, a case sensitive comparison is
2373	performed, otherwise the case in the file path is ignored.
2374
2375	<result name="VBOX_E_FILE_ERROR">
2376	Invalid image file location.
2377	</result>
2378	<result name="VBOX_E_OBJECT_NOT_FOUND">
2379	No matching DVD image found in the media registry.
2380	</result>
2381
2382	</desc>
2383	<param name="location" type="wstring" dir="in">
2384	<desc>CD/DVD image file path to look for.</desc>
2385	</param>
2386	<param name="image" type="IMedium" dir="return">
2387	<desc>Found CD/DVD image object.</desc>
2388	</param>
2389	</method>
2390
2391	<method name="openFloppyImage">
2392	<desc>
2393	Opens a floppy image contained in the specified file of the supported
2394	format and assigns it the given UUID.
2395
2396	After the image is successfully opened by this method, it gets
2397	remembered by (known to) this VirtualBox installation and will be
2398	accessible through <link to="#getFloppyImage"/> and
2399	<link to="#findFloppyImage"/> methods. Remembered images are also
2400	returned as part of the <link to="#floppyImages"/> array and can be
2401	mounted to virtual machines. See IMedium for more details.
2402
2403	See <link to="IMedium::location"/> to get more details about the format
2404	of the location string.
2405
2406	<result name="VBOX_E_FILE_ERROR">
2407	Invalid floppy image file location or could not find the floppy
2408	image at the specified location.
2409	</result>
2410	<result name="VBOX_E_INVALID_OBJECT_STATE">
2411	Floppy image already exists in the media registry.
2412	</result>
2413
2414	<note>
2415	Currently, only raw floppy images are supported by VirtualBox.
2416	</note>
2417	</desc>
2418	<param name="location" type="wstring" dir="in">
2419	<desc>
2420	Full path to the file that contains a valid floppy image.
2421	</desc>
2422	</param>
2423	<param name="id" type="uuid" mod="string" dir="in">
2424	<desc>
2425	UUID to assign to the given image file within this VirtualBox
2426	installation. If an empty (@c null) UUID is specified, the system will
2427	randomly generate a new UUID.
2428	</desc>
2429	</param>
2430	<param name="image" type="IMedium" dir="return">
2431	<desc>Opened floppy image object.</desc>
2432	</param>
2433	</method>
2434
2435	<method name="getFloppyImage">
2436	<desc>
2437	Returns a floppy image with the given UUID.
2438
2439	The image with the given UUID must be known to this VirtualBox
2440	installation, i.e. it must be previously opened by <link
2441	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2442
2443	<result name="VBOX_E_OBJECT_NOT_FOUND">
2444	No matching floppy image found in the media registry.
2445	</result>
2446
2447	</desc>
2448	<param name="id" type="uuid" mod="string" dir="in">
2449	<desc>UUID of the image to look for.</desc>
2450	</param>
2451	<param name="image" type="IMedium" dir="return">
2452	<desc>Found floppy image object.</desc>
2453	</param>
2454	</method>
2455
2456	<method name="findFloppyImage">
2457	<desc>
2458	Returns a floppy image with the given image location.
2459
2460	The image with the given UUID must be known to this VirtualBox
2461	installation, i.e. it must be previously opened by <link
2462	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2463
2464	The search is done by comparing the value of the @a location argument to
2465	the <link to="IMedium::location"/> attribute of each known floppy image.
2466
2467	The requested location can be a path relative to the
2468	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2469	only a file name without any path is given, the
2470	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2471	folder</link> will be prepended to the file name before searching. Note
2472	that on case sensitive file systems, a case sensitive comparison is
2473	performed, otherwise the case of symbols in the file path is ignored.
2474
2475	<result name="VBOX_E_FILE_ERROR">
2476	Invalid image file location.
2477	</result>
2478	<result name="VBOX_E_OBJECT_NOT_FOUND">
2479	No matching floppy image found in the media registry.
2480	</result>
2481
2482	</desc>
2483	<param name="location" type="wstring" dir="in">
2484	<desc>Floppy image file path to look for.</desc>
2485	</param>
2486	<param name="image" type="IMedium" dir="return">
2487	<desc>Found floppy image object.</desc>
2488	</param>
2489	</method>
2490
2491	<method name="getGuestOSType">
2492	<desc>
2493	Returns an object describing the specified guest OS type.
2494
2495	The requested guest OS type is specified using a string which is a
2496	mnemonic identifier of the guest operating system, such as
2497	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2498	particular virtual machine can be read or set using the
2499	<link to="IMachine::OSTypeId"/> attribute.
2500
2501	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2502	available guest OS type objects. Each object has an
2503	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2504	the guest OS this object describes.
2505
2506	<result name="E_INVALIDARG">
2507	@a id is not a valid Guest OS type.
2508	</result>
2509
2510	</desc>
2511	<param name="id" type="uuid" mod="string" dir="in">
2512	<desc>Guest OS type ID string.</desc>
2513	</param>
2514	<param name="type" type="IGuestOSType" dir="return">
2515	<desc>Guest OS type object.</desc>
2516	</param>
2517	</method>
2518
2519	<method name="createSharedFolder">
2520	<desc>
2521	Creates a new global shared folder by associating the given logical
2522	name with the given host path, adds it to the collection of shared
2523	folders and starts sharing it. Refer to the description of
2524	<link to="ISharedFolder"/> to read more about logical names.
2525	<note>
2526	In the current implementation, this operation is not
2527	implemented.
2528	</note>
2529	</desc>
2530	<param name="name" type="wstring" dir="in">
2531	<desc>Unique logical name of the shared folder.</desc>
2532	</param>
2533	<param name="hostPath" type="wstring" dir="in">
2534	<desc>Full path to the shared folder in the host file system.</desc>
2535	</param>
2536	<param name="writable" type="boolean" dir="in">
2537	<desc>Whether the share is writable or readonly</desc>
2538	</param>
2539	</method>
2540
2541	<method name="removeSharedFolder">
2542	<desc>
2543	Removes the global shared folder with the given name previously
2544	created by <link to="#createSharedFolder"/> from the collection of
2545	shared folders and stops sharing it.
2546	<note>
2547	In the current implementation, this operation is not
2548	implemented.
2549	</note>
2550	</desc>
2551	<param name="name" type="wstring" dir="in">
2552	<desc>Logical name of the shared folder to remove.</desc>
2553	</param>
2554	</method>
2555
2556	<method name="getExtraDataKeys">
2557	<desc>
2558	Returns an array representing the global extra data keys which currently
2559	have values defined.
2560	</desc>
2561	<param name="value" type="wstring" dir="return" safearray="yes">
2562	<desc>Array of extra data keys.</desc>
2563	</param>
2564	</method>
2565
2566	<method name="getExtraData">
2567	<desc>
2568	Returns associated global extra data.
2569
2570	If the requested data @a key does not exist, this function will
2571	succeed and return an empty string in the @a value argument.
2572
2573	<result name="VBOX_E_FILE_ERROR">
2574	Settings file not accessible.
2575	</result>
2576	<result name="VBOX_E_XML_ERROR">
2577	Could not parse the settings file.
2578	</result>
2579
2580	</desc>
2581	<param name="key" type="wstring" dir="in">
2582	<desc>Name of the data key to get.</desc>
2583	</param>
2584	<param name="value" type="wstring" dir="return">
2585	<desc>Value of the requested data key.</desc>
2586	</param>
2587	</method>
2588
2589	<method name="setExtraData">
2590	<desc>
2591	Sets associated global extra data.
2592
2593	If you pass @c null or empty string as a key @a value, the given @a key
2594	will be deleted.
2595
2596	<note>
2597	Before performing the actual data change, this method will ask all
2598	registered callbacks using the
2599	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2600	notification for a permission. If one of the callbacks refuses the
2601	new value, the change will not be performed.
2602	</note>
2603	<note>
2604	On success, the
2605	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2606	is called to inform all registered callbacks about a successful data
2607	change.
2608	</note>
2609
2610	<result name="VBOX_E_FILE_ERROR">
2611	Settings file not accessible.
2612	</result>
2613	<result name="VBOX_E_XML_ERROR">
2614	Could not parse the settings file.
2615	</result>
2616	<result name="E_ACCESSDENIED">
2617	Modification request refused.
2618	</result>
2619
2620	</desc>
2621	<param name="key" type="wstring" dir="in">
2622	<desc>Name of the data key to set.</desc>
2623	</param>
2624	<param name="value" type="wstring" dir="in">
2625	<desc>Value to assign to the key.</desc>
2626	</param>
2627	</method>
2628
2629	<method name="openSession">
2630	<desc>
2631	Opens a new direct session with the given virtual machine.
2632
2633	A direct session acts as a local lock on the given VM.
2634	There can be only one direct session open at a time for every
2635	virtual machine, protecting the VM from being manipulated by
2636	conflicting actions from different processes. Only after a
2637	direct session has been opened, one can change all VM settings
2638	and execute the VM in the process space of the session object.
2639
2640	Sessions therefore can be compared to mutex semaphores that
2641	lock a given VM for modification and execution.
2642	See <link to="ISession">ISession</link> for details.
2643
2644	<note>Unless you are writing a new VM frontend, you will not
2645	want to execute a VM in the current process. To spawn a new
2646	process that executes a VM, use
2647	<link to="IVirtualBox::openRemoteSession" />
2648	instead.</note>
2649
2650	Upon successful return, the session object can be used to
2651	get access to the machine and to the VM console.
2652
2653	In VirtualBox terminology, the machine becomes "mutable" after
2654	a session has been opened. Note that the "mutable" machine
2655	object, on which you may invoke IMachine methods to change its
2656	settings, will be a different object from the immutable IMachine
2657	objects returned by various IVirtualBox methods. To obtain a
2658	mutable IMachine object (upon which you can invoke settings methods),
2659	use the <link to="ISession::machine" /> attribute.
2660
2661	One must always call <link to="ISession::close" /> to release the
2662	lock on the machine, or the machine's state will eventually be
2663	set to "Aborted".
2664
2665	In other words, to change settings on a machine, the following
2666	sequence is typically performed:
2667
2668	<ol>
2669	<li>Call this method (openSession) to have a machine locked for
2670	the current session.</li>
2671
2672	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2673
2674	<li>Change the settings of the machine.</li>
2675
2676	<li>Call <link to="IMachine::saveSettings" />.</li>
2677
2678	<li>Close the session by calling <link to="ISession::close"/>.</li>
2679	</ol>
2680
2681	<result name="E_UNEXPECTED">
2682	Virtual machine not registered.
2683	</result>
2684	<result name="E_ACCESSDENIED">
2685	Process not started by OpenRemoteSession.
2686	</result>
2687	<result name="VBOX_E_OBJECT_NOT_FOUND">
2688	No matching virtual machine found.
2689	</result>
2690	<result name="VBOX_E_INVALID_OBJECT_STATE">
2691	Session already open or being opened.
2692	</result>
2693	<result name="VBOX_E_VM_ERROR">
2694	Failed to assign machine to session.
2695	</result>
2696
2697	</desc>
2698	<param name="session" type="ISession" dir="in">
2699	<desc>
2700	Session object that will represent the opened session after
2701	successful method invocation. This object must not represent
2702	the already open session.
2703	<note>
2704	This session will be automatically closed if the
2705	VirtualBox server is terminated for some reason.
2706	</note>
2707	</desc>
2708	</param>
2709	<param name="machineId" type="uuid" mod="string" dir="in">
2710	<desc>ID of the virtual machine to open a session with.</desc>
2711	</param>
2712	</method>
2713
2714	<method name="openRemoteSession">
2715	<desc>
2716	Spawns a new process that executes a virtual machine (called a
2717	"remote session").
2718
2719	Opening a remote session causes the VirtualBox server to start a new
2720	process that opens a direct session with the given VM. As a result, the
2721	VM is locked by that direct session in the new process, preventing
2722	conflicting changes from other processes. Since sessions act as locks
2723	that prevent conflicting changes, one cannot open a remote session
2724	for a VM that already has another open session (direct or remote), or
2725	is currently in the process of opening one (see <link
2726	to="IMachine::sessionState"/>).
2727
2728	While the remote session still provides some level of control over the
2729	VM execution to the caller (using the <link to="IConsole" /> interface),
2730	not all VM settings are available for modification within the remote
2731	session context.
2732
2733	This operation can take some time (a new VM is started in a new process,
2734	for which memory and other resources need to be set up). Because of this,
2735	an <link to="IProgress" /> is returned to allow the caller to wait for this
2736	asynchronous operation to be completed. Until then, the remote session
2737	object remains in the closed state, and accessing the machine or its
2738	console through it is invalid. It is recommended to use
2739	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2740	completion. Completion is signalled when the VM is powered on. Error
2741	messages etc. can be queried via the progress object, if available.
2742
2743	As with all <link to="ISession" /> objects, it is recommended to call
2744	<link to="ISession::close" /> on the local session object once openRemoteSession()
2745	has been called. However, the session's state (see <link to="ISession::state" />)
2746	will not return to "Closed" until the remote session has also closed (i.e.
2747	until the VM is no longer running). In that case, however, the state of
2748	the session will automatically change back to "Closed".
2749
2750	Currently supported session types (values of the @a type
2751	argument) are:
2752	<ul>
2753	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2754	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2755	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2756	</ul>
2757
2758	The @a environment argument is a string containing definitions of
2759	environment variables in the following format:
2760	@code
2761	NAME[=VALUE]\n
2762	NAME[=VALUE]\n
2763	...
2764	@endcode
2765	where <tt>\\n</tt> is the new line character. These environment
2766	variables will be appended to the environment of the VirtualBox server
2767	process. If an environment variable exists both in the server process
2768	and in this list, the value from this list takes precedence over the
2769	server's variable. If the value of the environment variable is
2770	omitted, this variable will be removed from the resulting environment.
2771	If the environment string is @c null or empty, the server environment
2772	is inherited by the started process as is.
2773
2774	<see>openExistingSession</see>
2775
2776	<result name="E_UNEXPECTED">
2777	Virtual machine not registered.
2778	</result>
2779	<result name="E_INVALIDARG">
2780	Invalid session type @a type.
2781	</result>
2782	<result name="VBOX_E_OBJECT_NOT_FOUND">
2783	No machine matching @a machineId found.
2784	</result>
2785	<result name="VBOX_E_INVALID_OBJECT_STATE">
2786	Session already open or being opened.
2787	</result>
2788	<result name="VBOX_E_IPRT_ERROR">
2789	Launching process for machine failed.
2790	</result>
2791	<result name="VBOX_E_VM_ERROR">
2792	Failed to assign machine to session.
2793	</result>
2794
2795	</desc>
2796	<param name="session" type="ISession" dir="in">
2797	<desc>
2798	Session object that will represent the opened remote session
2799	after successful method invocation (this object must not
2800	represent an already open session).
2801	</desc>
2802	</param>
2803	<param name="machineId" type="uuid" mod="string" dir="in">
2804	<desc>ID of the virtual machine to open a session with.</desc>
2805	</param>
2806	<param name="type" type="wstring" dir="in">
2807	<desc>
2808	Type of the remote session (case sensitive).
2809	</desc>
2810	</param>
2811	<param name="environment" type="wstring" dir="in">
2812	<desc>
2813	Environment to pass to the opened session.
2814	</desc>
2815	</param>
2816	<param name="progress" type="IProgress" dir="return">
2817	<desc>Progress object to track the operation completion.</desc>
2818	</param>
2819	</method>
2820
2821	<method name="openExistingSession">
2822	<desc>
2823	Opens a new remote session with the virtual machine for
2824	which a direct session is already open.
2825
2826	The remote session provides some level of control over the VM
2827	execution (using the IConsole interface) to the caller; however,
2828	within the remote session context, not all VM settings are available
2829	for modification.
2830
2831	As opposed to <link to="#openRemoteSession"/>, the number of
2832	remote sessions opened this way is not limited by the API
2833
2834	<note>
2835	It is an error to open a remote session with the machine that
2836	doesn't have an open direct session.
2837	</note>
2838
2839	<result name="E_UNEXPECTED">
2840	Virtual machine not registered.
2841	</result>
2842	<result name="VBOX_E_OBJECT_NOT_FOUND">
2843	No machine matching @a machineId found.
2844	</result>
2845	<result name="VBOX_E_INVALID_OBJECT_STATE">
2846	Session already open or being opened.
2847	</result>
2848	<result name="VBOX_E_INVALID_SESSION_STATE">
2849	Direct session state not Open.
2850	</result>
2851	<result name="VBOX_E_VM_ERROR">
2852	Failed to get console object from direct session or assign
2853	machine to session.
2854	</result>
2855
2856	<see>openRemoteSession</see>
2857	</desc>
2858	<param name="session" type="ISession" dir="in">
2859	<desc>
2860	Session object that will represent the open remote session
2861	after successful method invocation. This object must not
2862	represent an already open session.
2863	<note>
2864	This session will be automatically closed when the peer
2865	(direct) session dies or gets closed.
2866	</note>
2867	</desc>
2868	</param>
2869	<param name="machineId" type="uuid" mod="string" dir="in">
2870	<desc>ID of the virtual machine to open a session with.</desc>
2871	</param>
2872	</method>
2873
2874	<method name="registerCallback">
2875	<desc>
2876	Registers a new global VirtualBox callback. The methods of the given
2877	callback object will be called by VirtualBox when an appropriate
2878	event occurs.
2879
2880	<result name="E_INVALIDARG">
2881	A @c null callback cannot be registered.
2882	</result>
2883
2884	</desc>
2885	<param name="callback" type="IVirtualBoxCallback" dir="in">
2886	<desc>Callback object to register.</desc>
2887	</param>
2888	</method>
2889
2890	<method name="unregisterCallback">
2891	<desc>
2892	Unregisters the previously registered global VirtualBox callback.
2893
2894	<result name="E_INVALIDARG">
2895	Specified @a callback not registered.
2896	</result>
2897
2898	</desc>
2899	<param name="callback" type="IVirtualBoxCallback" dir="in">
2900	<desc>Callback object to unregister.</desc>
2901	</param>
2902	</method>
2903
2904	<method name="waitForPropertyChange">
2905	<desc>
2906	Blocks the caller until any of the properties represented by the
2907	@a what argument changes the value or until the given timeout interval
2908	expires.
2909
2910	The @a what argument is a comma separated list of property masks that
2911	describe properties the caller is interested in. The property mask is
2912	a string in the following format:
2913
2914	<pre>
2915	[[group.]subgroup.]name
2916	</pre>
2917
2918	where @c name is the property name and @c group, @c subgroup are zero
2919	or more property group specifiers. Each element (group or name) in
2920	the property mask may be either a Latin string or an asterisk symbol
2921	(@c "*") which is used to match any string for the given element. A
2922	property mask that doesn't contain asterisk symbols represents a
2923	single fully qualified property name.
2924
2925	Groups in the fully qualified property name go from more generic (the
2926	left-most part) to more specific (the right-most part). The first
2927	element is usually a name of the object the property belongs to. The
2928	second element may be either a property name, or a child object name,
2929	or an index if the preceding element names an object which is one of
2930	many objects of the same type. This way, property names form a
2931	hierarchy of properties. Here are some examples of property names:
2932
2933	<table>
2934	<tr>
2935	<td><tt>VirtualBox.version</tt></td>
2936	<td><link to="IVirtualBox::version"/> property</td>
2937	</tr>
2938	<tr>
2939	<td><tt>Machine.<UUID>.name</tt></td>
2940	<td><link to="IMachine::name"/> property of the machine with the
2941	given UUID</td>
2942	</tr>
2943	</table>
2944
2945	Most property names directly correspond to the properties of objects
2946	(components) provided by the VirtualBox library and may be used to
2947	track changes to these properties. However, there may be
2948	pseudo-property names that don't correspond to any existing object's
2949	property directly, as well as there may be object properties that
2950	don't have a corresponding property name that is understood by this
2951	method, and therefore changes to such properties cannot be
2952	tracked. See individual object's property descriptions to get a
2953	fully qualified property name that can be used with this method (if
2954	any).
2955
2956	There is a special property mask @c "*" (i.e. a string consisting of a
2957	single asterisk symbol) that can be used to match all properties.
2958	Below are more examples of property masks:
2959
2960	<table>
2961	<tr>
2962	<td><tt>VirtualBox.*</tt></td>
2963	<td>Track all properties of the VirtualBox object</td>
2964	</tr>
2965	<tr>
2966	<td><tt>Machine.*.name</tt></td>
2967	<td>Track changes to the <link to="IMachine::name"/> property of
2968	all registered virtual machines</td>
2969	</tr>
2970	</table>
2971
2972	<note>
2973	This function is not implemented in the current version of the
2974	product.
2975	</note>
2976	</desc>
2977	<param name="what" type="wstring" dir="in">
2978	<desc>Comma separated list of property masks.</desc>
2979	</param>
2980	<param name="timeout" type="unsigned long" dir="in">
2981	<desc>
2982	Wait timeout in milliseconds.
2983	Specify -1 for an indefinite wait.
2984	</desc>
2985	</param>
2986	<param name="changed" type="wstring" dir="out">
2987	<desc>
2988	Comma separated list of properties that have been changed and caused
2989	this method to return to the caller.
2990	</desc>
2991	</param>
2992	<param name="values" type="wstring" dir="out">
2993	<desc>Reserved, not currently used.</desc>
2994	</param>
2995	</method>
2996
2997	<!--method name="createDHCPServerForInterface">
2998	<desc>
2999	Creates a dhcp server settings to be used for the given interface
3000	<result name="E_INVALIDARG">
3001	Host network interface @a name already exists.
3002	</result>
3003	</desc>
3004	<param name="interface" type="IHostNetworkInterface" dir="in">
3005	<desc>Network Interface</desc>
3006	</param>
3007	<param name="server" type="IDHCPServer" dir="out">
3008	<desc>Dhcp server settings</desc>
3009	</param>
3010	</method-->
3011
3012	<method name="createDHCPServer">
3013	<desc>
3014	Creates a dhcp server settings to be used for the given internal network name
3015	<result name="E_INVALIDARG">
3016	Host network interface @a name already exists.
3017	</result>
3018	</desc>
3019	<param name="name" type="wstring" dir="in">
3020	<desc>server name</desc>
3021	</param>
3022	<param name="server" type="IDHCPServer" dir="return">
3023	<desc>Dhcp server settings</desc>
3024	</param>
3025	</method>
3026
3027	<method name="findDHCPServerByNetworkName">
3028	<desc>
3029	Searches a dhcp server settings to be used for the given internal network name
3030	<result name="E_INVALIDARG">
3031	Host network interface @a name already exists.
3032	</result>
3033
3034	</desc>
3035	<param name="name" type="wstring" dir="in">
3036	<desc>server name</desc>
3037	</param>
3038	<param name="server" type="IDHCPServer" dir="return">
3039	<desc>Dhcp server settings</desc>
3040	</param>
3041	</method>
3042
3043	<!--method name="findDHCPServerForInterface">
3044	<desc>
3045	Searches a dhcp server settings to be used for the given interface
3046	<result name="E_INVALIDARG">
3047	Host network interface @a name already exists.
3048	</result>
3049	</desc>
3050	<param name="interface" type="IHostNetworkInterface" dir="in">
3051	<desc>Network Interface</desc>
3052	</param>
3053	<param name="server" type="IDHCPServer" dir="out">
3054	<desc>Dhcp server settings</desc>
3055	</param>
3056	</method-->
3057
3058	<method name="removeDHCPServer">
3059	<desc>
3060	Removes the dhcp server settings
3061	<result name="E_INVALIDARG">
3062	Host network interface @a name already exists.
3063	</result>
3064	</desc>
3065	<param name="server" type="IDHCPServer" dir="in">
3066	<desc>Dhcp server settings to be removed</desc>
3067	</param>
3068	</method>
3069
3070
3071	<method name="checkFirmwarePresent">
3072	<desc>
3073	Check if this VirtualBox installation has a firmware
3074	of the given type available, either system-wide or per-user.
3075	Optionally, this may return a hint where this firmware can be
3076	downloaded from.
3077	</desc>
3078	<param name="firmwareType" type="FirmwareType" dir="in">
3079	<desc>
3080	Type of firmware to check.
3081	</desc>
3082	</param>
3083	<param name="version" type="wstring" dir="in">
3084	<desc>Expected version number, usually empty string (presently ignored).</desc>
3085	</param>
3086
3087	<param name="url" type="wstring" dir="out">
3088	<desc>
3089	Suggested URL to download this firmware from.
3090	</desc>
3091	</param>
3092
3093	<param name="file" type="wstring" dir="out">
3094	<desc>
3095	Filename of firmware, only valid if result == TRUE.
3096	</desc>
3097	</param>
3098
3099	<param name="result" type="boolean" dir="return">
3100	<desc>If firmware of this type and version is available.</desc>
3101	</param>
3102	</method>
3103
3104	</interface>
3105
3106	<!--
3107	// IVFSExplorer
3108	/////////////////////////////////////////////////////////////////////////
3109	-->
3110
3111	<enum
3112	name="VFSType"
3113	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3114	>
3115	<desc>
3116	Virtual file systems supported by VFSExplorer.
3117	</desc>
3118
3119	<const name="File" value="1" />
3120	<const name="Cloud" value="2" />
3121	<const name="S3" value="3" />
3122	<const name="WebDav" value="4" />
3123	</enum>
3124
3125	<enum
3126	name="VFSFileType"
3127	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3128	>
3129	<desc>
3130	File types known by VFSExplorer.
3131	</desc>
3132
3133	<const name="Unknown" value="1" />
3134	<const name="Fifo" value="2" />
3135	<const name="DevChar" value="3" />
3136	<const name="Directory" value="4" />
3137	<const name="DevBlock" value="5" />
3138	<const name="File" value="6" />
3139	<const name="SymLink" value="7" />
3140	<const name="Socket" value="8" />
3141	<const name="WhiteOut" value="9" />
3142	</enum>
3143
3144	<interface
3145	name="IVFSExplorer" extends="$unknown"
3146	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3147	wsmap="managed"
3148	>
3149	<desc>
3150	The VFSExplorer interface unifies access to different file system
3151	types. This includes local file systems as well remote file systems like
3152	S3. For a list of supported types see <link to="VFSType" />.
3153	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3154	</desc>
3155
3156	<attribute name="path" type="wstring" readonly="yes">
3157	<desc>Returns the current path in the virtual file system.</desc>
3158	</attribute>
3159
3160	<attribute name="type" type="VFSType" readonly="yes">
3161	<desc>Returns the file system type which is currently in use.</desc>
3162	</attribute>
3163
3164	<method name="update">
3165	<desc>Updates the internal list of files/directories from the
3166	current directory level. Use <link to="#entryList" /> to get the full list
3167	after a call to this method.</desc>
3168
3169	<param name="aProgress" type="IProgress" dir="return">
3170	<desc>Progress object to track the operation completion.</desc>
3171	</param>
3172	</method>
3173
3174	<method name="cd">
3175	<desc>Change the current directory level.</desc>
3176
3177	<param name="aDir" type="wstring" dir="in">
3178	<desc>The name of the directory to go in.</desc>
3179	</param>
3180
3181	<param name="aProgress" type="IProgress" dir="return">
3182	<desc>Progress object to track the operation completion.</desc>
3183	</param>
3184	</method>
3185
3186	<method name="cdUp">
3187	<desc>Go one directory upwards from the current directory level.</desc>
3188
3189	<param name="aProgress" type="IProgress" dir="return">
3190	<desc>Progress object to track the operation completion.</desc>
3191	</param>
3192	</method>
3193
3194	<method name="entryList">
3195	<desc>Returns a list of files/directories after a call to <link
3196	to="#update" />. The user is responsible for keeping this internal
3197	list up do date.</desc>
3198
3199	<param name="aNames" type="wstring" safearray="yes" dir="out">
3200	<desc>The list of names for the entries.</desc>
3201	</param>
3202
3203	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3204	<desc>The list of types for the entries.</desc>
3205	</param>
3206	</method>
3207
3208	<method name="exists">
3209	<desc>Checks if the given file list exists in the current directory
3210	level.</desc>
3211
3212	<param name="aNames" type="wstring" safearray="yes" dir="in">
3213	<desc>The names to check.</desc>
3214	</param>
3215
3216	<param name="aExists" type="wstring" safearray="yes" dir="return">
3217	<desc>The names which exist.</desc>
3218	</param>
3219	</method>
3220
3221	<method name="remove">
3222	<desc>Deletes the given files in the current directory level.</desc>
3223
3224	<param name="aNames" type="wstring" safearray="yes" dir="in">
3225	<desc>The names to remove.</desc>
3226	</param>
3227
3228	<param name="aProgress" type="IProgress" dir="return">
3229	<desc>Progress object to track the operation completion.</desc>
3230	</param>
3231	</method>
3232
3233	</interface>
3234
3235	<!--
3236	// IAppliance
3237	/////////////////////////////////////////////////////////////////////////
3238	-->
3239
3240	<interface
3241	name="IAppliance" extends="$unknown"
3242	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3243	wsmap="managed"
3244	>
3245	<desc>
3246	Represents a platform-independent appliance in OVF format. An instance of this is returned
3247	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3248	appliances with VirtualBox.
3249
3250	The OVF standard suggests two different physical file formats:
3251
3252	<ol>
3253	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3254	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3255	this descriptor file references other files, as OVF appliances distributed as a set of
3256	files most likely do, those files must be in the same directory as the descriptor file.</li>
3257
3258	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3259	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3260	files and optionally other files.
3261
3262	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3263	be added with a later version.</li>
3264	</ol>
3265
3266	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3267	<link to="IMachine" /> involves the following sequence of API calls:
3268
3269	<ol>
3270	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3271	</li>
3272
3273	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3274	would like to import. So long as this file is syntactically valid, this will succeed
3275	and return an instance of IAppliance that contains the parsed data from the OVF file.
3276	</li>
3277
3278	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3279	contents of the IAppliance attributes accordingly. These can be inspected by a
3280	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3281	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3282	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3283	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3284	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3285	The GUI can then give the user the option to confirm and/or change these suggestions.
3286	</li>
3287
3288	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3289	virtual system to override the suggestions made by the interpret() routine.
3290	</li>
3291
3292	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3293	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3294	virtual system descriptions.
3295	</li>
3296	</ol>
3297
3298	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3299
3300	<ol>
3301	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3302	an empty IAppliance object.
3303	</li>
3304
3305	<li>For each machine you would like to export, call <link to="IMachine::export" />
3306	with the IAppliance object you just created. This creates an instance of
3307	<link to="IVirtualSystemDescription" /> inside the appliance.
3308	</li>
3309
3310	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3311	virtual system to override the suggestions made by the export() routine.
3312	</li>
3313
3314	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3315	file written.</li>
3316	</ol>
3317
3318	</desc>
3319
3320	<attribute name="path" type="wstring" readonly="yes">
3321	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3322	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3323	<link to="#write" /> (for export).
3324	This attribute is empty until one of these methods has been called.
3325	</desc>
3326	</attribute>
3327
3328	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3329	<desc>
3330	Array of virtual disk definitions. One such description exists for each
3331	disk definition in the OVF; each string array item represents one such piece of
3332	disk information, with the information fields separated by tab (\\t) characters.
3333
3334	The caller should be prepared for additional fields being appended to
3335	this string in future versions of VirtualBox and therefore check for
3336	the number of tabs in the strings returned.
3337
3338	In the current version, the following eight fields are returned per string
3339	in the array:
3340
3341	<ol>
3342	<li>Disk ID (unique string identifier given to disk)</li>
3343
3344	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3345
3346	<li>Populated size (optional unsigned integer indicating the current size of the
3347	disk; can be approximate; -1 if unspecified)</li>
3348
3349	<li>Format (string identifying the disk format, typically
3350	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3351
3352	<li>Reference (where to find the disk image, typically a file name; if empty,
3353	then the disk should be created on import)</li>
3354
3355	<li>Image size (optional unsigned integer indicating the size of the image,
3356	which need not necessarily be the same as the values specified above, since
3357	the image may be compressed or sparse; -1 if not specified)</li>
3358
3359	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3360	presently unsupported and always -1)</li>
3361
3362	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3363	</ol>
3364	</desc>
3365	</attribute>
3366
3367	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3368	<desc> Array of virtual system descriptions. One such description is created
3369	for each virtual system found in the OVF.
3370	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3371	(for export) has been called.
3372	</desc>
3373	</attribute>
3374
3375	<method name="read">
3376	<desc>
3377	Reads an OVF file into the appliance object.
3378
3379	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3380	mere fact that this method returns successfully does not mean that VirtualBox supports all
3381	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3382	</desc>
3383	<param name="file" type="wstring" dir="in">
3384	<desc>
3385	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3386	on whether the appliance is distributed as a set of files or as a single file, respectively).
3387	</desc>
3388	</param>
3389	<param name="aProgress" type="IProgress" dir="return">
3390	<desc></desc>
3391	</param>
3392	</method>
3393
3394	<method name="interpret">
3395	<desc>
3396	Interprets the OVF data that was read when the appliance was constructed. After
3397	calling this method, one can inspect the
3398	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3399	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3400	the appliance.
3401
3402	Calling this method is the second step of importing an appliance into VirtualBox;
3403	see <link to="IAppliance" /> for an overview.
3404
3405	After calling this method, one should call <link to="#getWarnings" /> to find out
3406	if problems were encountered during the processing which might later lead to
3407	errors.
3408	</desc>
3409	</method>
3410
3411	<method name="importMachines">
3412	<desc>
3413	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3414	and other interfaces that match the information contained in the appliance as
3415	closely as possible, as represented by the import instructions in the
3416	<link to="#virtualSystemDescriptions" /> array.
3417
3418	Calling this method is the final step of importing an appliance into VirtualBox;
3419	see <link to="IAppliance" /> for an overview.
3420
3421	Since importing the appliance will most probably involve copying and converting
3422	disk images, which can take a long time, this method operates asynchronously and
3423	returns an IProgress object to allow the caller to monitor the progress.
3424	</desc>
3425
3426	<param name="aProgress" type="IProgress" dir="return">
3427	<desc></desc>
3428	</param>
3429	</method>
3430
3431	<method name="createVFSExplorer">
3432	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3433
3434	<param name="aUri" type="wstring" dir="in">
3435	<desc>The URI describing the file system to use.</desc>
3436	</param>
3437
3438	<param name="aExplorer" type="IVFSExplorer" dir="return">
3439	<desc></desc>
3440	</param>
3441	</method>
3442
3443	<method name="write">
3444	<desc>
3445	Writes the contents of the appliance exports into a new OVF file.
3446
3447	Calling this method is the final step of exporting an appliance from VirtualBox;
3448	see <link to="IAppliance" /> for an overview.
3449
3450	Since exporting the appliance will most probably involve copying and converting
3451	disk images, which can take a long time, this method operates asynchronously and
3452	returns an IProgress object to allow the caller to monitor the progress.
3453	</desc>
3454	<param name="format" type="wstring" dir="in">
3455	<desc>
3456	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3457	future versions of VirtualBox may support additional formats.
3458	</desc>
3459	</param>
3460	<param name="path" type="wstring" dir="in">
3461	<desc>
3462	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3463	on whether the appliance is distributed as a set of files or as a single file, respectively).
3464	</desc>
3465	</param>
3466	<param name="aProgress" type="IProgress" dir="return">
3467	<desc>Progress object to track the operation completion.</desc>
3468	</param>
3469	</method>
3470
3471	<method name="getWarnings">
3472	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3473
3474	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3475	<desc></desc>
3476	</param>
3477	</method>
3478
3479	</interface>
3480
3481	<enum
3482	name="VirtualSystemDescriptionType"
3483	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3484	>
3485	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3486	a configuration value.</desc>
3487
3488	<const name="Ignore" value="1" />
3489	<const name="OS" value="2" />
3490	<const name="Name" value="3" />
3491	<const name="Product" value="4" />
3492	<const name="Vendor" value="5" />
3493	<const name="Version" value="6" />
3494	<const name="ProductUrl" value="7" />
3495	<const name="VendorUrl" value="8" />
3496	<const name="Description" value="9" />
3497	<const name="License" value="10" />
3498	<const name="Miscellaneous" value="11" />
3499	<const name="CPU" value="12" />
3500	<const name="Memory" value="13" />
3501	<const name="HardDiskControllerIDE" value="14" />
3502	<const name="HardDiskControllerSATA" value="15" />
3503	<const name="HardDiskControllerSCSI" value="16" />
3504	<const name="HardDiskImage" value="17" />
3505	<const name="Floppy" value="18" />
3506	<const name="CDROM" value="19" />
3507	<const name="NetworkAdapter" value="20" />
3508	<const name="USBController" value="21" />
3509	<const name="SoundCard" value="22" />
3510
3511	</enum>
3512
3513	<enum
3514	name="VirtualSystemDescriptionValueType"
3515	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3516	>
3517	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3518	type to fetch.</desc>
3519
3520	<const name="Reference" value="1" />
3521	<const name="Original" value="2" />
3522	<const name="Auto" value="3" />
3523	<const name="ExtraConfig" value="4" />
3524
3525	</enum>
3526
3527	<interface
3528	name="IVirtualSystemDescription" extends="$unknown"
3529	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3530	wsmap="managed"
3531	>
3532
3533	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3534	After <link to="IAppliance::interpret" /> has been called, that array contains
3535	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3536	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3537	into VirtualBox.
3538	</desc>
3539
3540	<attribute name="count" type="unsigned long" readonly="yes">
3541	<desc>Return the number of virtual system description entries.</desc>
3542	</attribute>
3543
3544	<method name="getDescription">
3545	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3546	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3547
3548	The list below identifies the value sets that are possible depending on the
3549	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3550	the array item with the same index in aOvfValues[] will contain the original value as contained
3551	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3552	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3553	the aExtraConfigValues[] array item may also be used.
3554
3555	<ul>
3556	<li>
3557	"OS": the guest operating system type. There must be exactly one such array item on import. The
3558	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3559	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3560	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3561	</li>
3562	<li>
3563	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3564	if none is present on import, then an automatic name will be created from the operating system
3565	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3566	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3567	<link to="IMachine" /> name that does not exist yet.
3568	</li>
3569	<li>
3570	"Description": an arbitrary description.
3571	</li>
3572	<li>
3573	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3574	code to display such a license for agreement; the Main API does not enforce any such policy.
3575	</li>
3576	<li>
3577	Miscellaneous: reserved for future use.
3578	</li>
3579	<li>
3580	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3581	</li>
3582	<li>
3583	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3584	is present on import, then VirtualBox will set a meaningful default based on the operating system
3585	type.
3586	</li>
3587	<li>
3588	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3589	has no value in aOvfValues[] or aVBoxValues[].
3590	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3591	type can use to specify which hard disk controller a virtual disk should be connected to.
3592	</li>
3593	<li>
3594	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3595	has no value in aOvfValues[] or aVBoxValues[].
3596	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3597	</li>
3598	<li>
3599	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3600	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3601	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3602	</li>
3603	<li>
3604	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3605	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3606
3607	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3608	a path since the image file should be in the same location as the OVF file itself), whereas the
3609	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3610	hard disk image. This means that on import the image will be copied and converted from the
3611	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3612	On import, the target image will also be registered with VirtualBox.
3613
3614	The matching item in the aExtraConfigValues[] array must contain a string of the following
3615	format: "controller=<index>;channel=<c>"
3616	In this string, <index> must be an integer specifying the hard disk controller to connect
3617	the image to. That number must be the index of an array item with one of the hard disk controller
3618	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3619	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3620	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3621	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3622	</li>
3623	<li>
3624	"CDROM": a virtual CD-ROM drive. The matching item in aExtraConfigValue[] contains the same
3625	attachment information as with "HardDiskImage" items.
3626	</li>
3627	<li>
3628	"CDROM": a virtual floppy drive. The matching item in aExtraConfigValue[] contains the same
3629	attachment information as with "HardDiskImage" items.
3630	</li>
3631	<li>
3632	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3633	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3634	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3635	</li>
3636	<li>
3637	"USBController": a USB controller. There can be at most one such item. If and only if such an
3638	item ispresent, USB support will be enabled for the new virtual machine.
3639	</li>
3640	<li>
3641	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3642	present, sound support will be enabled for the new virtual machine. Note that the virtual
3643	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3644	may be different from the virtual soundcard expected by the appliance.
3645	</li>
3646	</ul>
3647
3648	</desc>
3649
3650	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3651	<desc></desc>
3652	</param>
3653
3654	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3655	<desc></desc>
3656	</param>
3657
3658	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3659	<desc></desc>
3660	</param>
3661
3662	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3663	<desc></desc>
3664	</param>
3665
3666	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3667	<desc></desc>
3668	</param>
3669
3670	</method>
3671
3672	<method name="getDescriptionByType">
3673	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3674	should be returned.</desc>
3675
3676	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3677	<desc></desc>
3678	</param>
3679
3680	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3681	<desc></desc>
3682	</param>
3683
3684	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3685	<desc></desc>
3686	</param>
3687
3688	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3689	<desc></desc>
3690	</param>
3691
3692	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3693	<desc></desc>
3694	</param>
3695
3696	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3697	<desc></desc>
3698	</param>
3699
3700	</method>
3701
3702	<method name="getValuesByType">
3703	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3704	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3705	values.</desc>
3706
3707	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3708	<desc></desc>
3709	</param>
3710
3711	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3712	<desc></desc>
3713	</param>
3714
3715	<param name="aValues" type="wstring" dir="return" safearray="yes">
3716	<desc></desc>
3717	</param>
3718
3719	</method>
3720
3721	<method name="setFinalValues">
3722	<desc>
3723	This method allows the appliance's user to change the configuration for the virtual
3724	system descriptions. For each array item returned from <link to="#getDescription" />,
3725	you must pass in one boolean value and one configuration value.
3726
3727	Each item in the boolean array determines whether the particular configuration item
3728	should be enabled.
3729	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3730	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3731	and SoundCard.
3732
3733	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3734	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3735	the configuration remains unchanged. Please see the documentation for getDescription()
3736	for valid configuration values for the individual array item types. If the
3737	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3738	</desc>
3739
3740	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3741	<desc></desc>
3742	</param>
3743
3744	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3745	<desc></desc>
3746	</param>
3747
3748	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3749	<desc></desc>
3750	</param>
3751	</method>
3752
3753	<method name="addDescription">
3754	<desc>
3755	This method adds an additional description entry to the stack of already
3756	available descriptions for this virtual system. This is handy for writing
3757	values which aren't directly supported by VirtualBox. One example would
3758	be the License type of <link to="VirtualSystemDescriptionType" />.
3759	</desc>
3760
3761	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3762	<desc></desc>
3763	</param>
3764
3765	<param name="aVBoxValue" type="wstring" dir="in">
3766	<desc></desc>
3767	</param>
3768
3769	<param name="aExtraConfigValue" type="wstring" dir="in">
3770	<desc></desc>
3771	</param>
3772	</method>
3773	</interface>
3774
3775
3776	<!--
3777	// IMachine
3778	/////////////////////////////////////////////////////////////////////////
3779	-->
3780
3781	<interface
3782	name="IInternalMachineControl" extends="$unknown"
3783	uuid="35d8d838-d066-447d-927a-fd93afdbec90"
3784	internal="yes"
3785	wsmap="suppress"
3786	>
3787	<method name="setRemoveSavedState">
3788	<desc>
3789	Updates the flag whether saved state is removed on a machine state
3790	change from Saved to PoweredOff.
3791	</desc>
3792	<param name="aRemove" type="boolean" dir="in"/>
3793	</method>
3794
3795	<method name="updateState">
3796	<desc>
3797	Updates the VM state.
3798	<note>
3799	This operation will also update the settings file with
3800	the correct information about the saved state file
3801	and delete this file from disk when appropriate.
3802	</note>
3803	</desc>
3804	<param name="state" type="MachineState" dir="in"/>
3805	</method>
3806
3807	<method name="getIPCId">
3808	<param name="id" type="wstring" dir="return"/>
3809	</method>
3810
3811	<method name="setPowerUpInfo">
3812	<desc>
3813	Transfers success (@c null) or error information for this session.
3814	This method updates the progress object to signal completion of the
3815	<link to="IVirtualBox::openRemoteSession"/> method if appropriate,
3816	which means that the progress object returned by
3817	<link to="IConsole::powerUp"/>.
3818	</desc>
3819	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
3820	</method>
3821
3822	<method name="runUSBDeviceFilters">
3823	<desc>
3824	Asks the server to run USB devices filters of the associated
3825	machine against the given USB device and tell if there is
3826	a match.
3827	<note>
3828	Intended to be used only for remote USB devices. Local
3829	ones don't require to call this method (this is done
3830	implicitly by the Host and USBProxyService).
3831	</note>
3832	</desc>
3833	<param name="device" type="IUSBDevice" dir="in"/>
3834	<param name="matched" type="boolean" dir="out"/>
3835	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3836	</method>
3837
3838	<method name="captureUSBDevice">
3839	<desc>
3840	Requests a capture of the given host USB device.
3841	When the request is completed, the VM process will
3842	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3843	notification.
3844	</desc>
3845	<param name="id" type="uuid" mod="string" dir="in"/>
3846	</method>
3847
3848	<method name="detachUSBDevice">
3849	<desc>
3850	Notification that a VM is going to detach (@a done = @c false) or has
3851	already detached (@a done = @c true) the given USB device.
3852	When the @a done = @c true request is completed, the VM process will
3853	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3854	notification.
3855	<note>
3856	In the @a done = @c true case, the server must run its own filters
3857	and filters of all VMs but this one on the detached device
3858	as if it were just attached to the host computer.
3859	</note>
3860	</desc>
3861	<param name="id" type="uuid" mod="string" dir="in"/>
3862	<param name="done" type="boolean" dir="in"/>
3863	</method>
3864
3865	<method name="autoCaptureUSBDevices">
3866	<desc>
3867	Requests a capture all matching USB devices attached to the host.
3868	When the request is completed, the VM process will
3869	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3870	notification per every captured device.
3871	</desc>
3872	</method>
3873
3874	<method name="detachAllUSBDevices">
3875	<desc>
3876	Notification that a VM that is being powered down. The done
3877	parameter indicates whether which stage of the power down
3878	we're at. When @a done = @c false the VM is announcing its
3879	intentions, while when @a done = @c true the VM is reporting
3880	what it has done.
3881	<note>
3882	In the @a done = @c true case, the server must run its own filters
3883	and filters of all VMs but this one on all detach devices as
3884	if they were just attached to the host computer.
3885	</note>
3886	</desc>
3887	<param name="done" type="boolean" dir="in"/>
3888	</method>
3889
3890	<method name="onSessionEnd">
3891	<desc>
3892	Triggered by the given session object when the session is about
3893	to close normally.
3894	</desc>
3895	<param name="session" type="ISession" dir="in">
3896	<desc>Session that is being closed</desc>
3897	</param>
3898	<param name="progress" type="IProgress" dir="return">
3899	<desc>
3900	Used to wait until the corresponding machine is actually
3901	dissociated from the given session on the server.
3902	Returned only when this session is a direct one.
3903	</desc>
3904	</param>
3905	</method>
3906
3907	<method name="beginSavingState">
3908	<desc>
3909	Called by the VM process to inform the server it wants to
3910	save the current state and stop the VM execution.
3911	</desc>
3912	<param name="progress" type="IProgress" dir="in">
3913	<desc>
3914	Progress object created by the VM process to wait until
3915	the state is saved.
3916	</desc>
3917	</param>
3918	<param name="stateFilePath" type="wstring" dir="out">
3919	<desc>
3920	File path the VM process must save the execution state to.
3921	</desc>
3922	</param>
3923	</method>
3924
3925	<method name="endSavingState">
3926	<desc>
3927	Called by the VM process to inform the server that saving
3928	the state previously requested by #beginSavingState is either
3929	successfully finished or there was a failure.
3930
3931	<result name="VBOX_E_FILE_ERROR">
3932	Settings file not accessible.
3933	</result>
3934	<result name="VBOX_E_XML_ERROR">
3935	Could not parse the settings file.
3936	</result>
3937
3938	</desc>
3939
3940	<param name="success" type="boolean" dir="in">
3941	<desc>@c true to indicate success and @c false otherwise.
3942	</desc>
3943	</param>
3944	</method>
3945
3946	<method name="adoptSavedState">
3947	<desc>
3948	Gets called by IConsole::adoptSavedState.
3949	<result name="VBOX_E_FILE_ERROR">
3950	Invalid saved state file path.
3951	</result>
3952	</desc>
3953	<param name="savedStateFile" type="wstring" dir="in">
3954	<desc>Path to the saved state file to adopt.</desc>
3955	</param>
3956	</method>
3957
3958	<method name="beginTakingSnapshot">
3959	<desc>
3960	Called from the VM process to request from the server to perform the
3961	server-side actions of creating a snapshot (creating differencing images
3962	and the snapshot object).
3963
3964	<result name="VBOX_E_FILE_ERROR">
3965	Settings file not accessible.
3966	</result>
3967	<result name="VBOX_E_XML_ERROR">
3968	Could not parse the settings file.
3969	</result>
3970	</desc>
3971	<param name="initiator" type="IConsole" dir="in">
3972	<desc>The console object that initiated this call.</desc>
3973	</param>
3974	<param name="name" type="wstring" dir="in">
3975	<desc>Snapshot name.</desc>
3976	</param>
3977	<param name="description" type="wstring" dir="in">
3978	<desc>Snapshot description.</desc>
3979	</param>
3980	<param name="consoleProgress" type="IProgress" dir="in">
3981	<desc>
3982	Progress object created by the VM process tracking the
3983	snapshot's progress. This has the following sub-operations:
3984	<ul>
3985	<li>setting up (weight 1);</li>
3986	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3987	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3988	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3989	<li>finishing up (weight 1)</li>
3990	</ul>
3991	</desc>
3992	</param>
3993	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3994	<desc>
3995	Whether this is an online snapshot (i.e. the machine is running).
3996	</desc>
3997	</param>
3998	<param name="stateFilePath" type="wstring" dir="out">
3999	<desc>
4000	File path the VM process must save the execution state to.
4001	</desc>
4002	</param>
4003	</method>
4004
4005	<method name="endTakingSnapshot">
4006	<desc>
4007	Called by the VM process to inform the server that the snapshot
4008	previously requested by #beginTakingSnapshot is either
4009	successfully taken or there was a failure.
4010	</desc>
4011
4012	<param name="success" type="boolean" dir="in">
4013	<desc>@c true to indicate success and @c false otherwise</desc>
4014	</param>
4015	</method>
4016
4017	<method name="deleteSnapshot">
4018	<desc>
4019	Gets called by IConsole::deleteSnapshot.
4020	<result name="VBOX_E_INVALID_OBJECT_STATE">
4021	Snapshot has more than one child snapshot.
4022	</result>
4023	</desc>
4024	<param name="initiator" type="IConsole" dir="in">
4025	<desc>The console object that initiated this call.</desc>
4026	</param>
4027	<param name="id" type="uuid" mod="string" dir="in">
4028	<desc>UUID of the snapshot to discard.</desc>
4029	</param>
4030	<param name="machineState" type="MachineState" dir="out">
4031	<desc>New machine state after this operation is started.</desc>
4032	</param>
4033	<param name="progress" type="IProgress" dir="return">
4034	<desc>Progress object to track the operation completion.</desc>
4035	</param>
4036	</method>
4037
4038	<method name="restoreSnapshot">
4039	<desc>
4040	Gets called by IConsole::RestoreSnapshot.
4041	</desc>
4042	<param name="initiator" type="IConsole" dir="in">
4043	<desc>The console object that initiated this call.</desc>
4044	</param>
4045	<param name="snapshot" type="ISnapshot" dir="in">
4046	<desc>The snapshot to restore the VM state from.</desc>
4047	</param>
4048	<param name="machineState" type="MachineState" dir="out">
4049	<desc>New machine state after this operation is started.</desc>
4050	</param>
4051	<param name="progress" type="IProgress" dir="return">
4052	<desc>Progress object to track the operation completion.</desc>
4053	</param>
4054	</method>
4055
4056	<method name="pullGuestProperties">
4057	<desc>
4058	Get the list of the guest properties matching a set of patterns along
4059	with their values, time stamps and flags and give responsibility for
4060	managing properties to the console.
4061	</desc>
4062	<param name="name" type="wstring" dir="out" safearray="yes">
4063	<desc>
4064	The names of the properties returned.
4065	</desc>
4066	</param>
4067	<param name="value" type="wstring" dir="out" safearray="yes">
4068	<desc>
4069	The values of the properties returned. The array entries match the
4070	corresponding entries in the @a name array.
4071	</desc>
4072	</param>
4073	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4074	<desc>
4075	The time stamps of the properties returned. The array entries match
4076	the corresponding entries in the @a name array.
4077	</desc>
4078	</param>
4079	<param name="flags" type="wstring" dir="out" safearray="yes">
4080	<desc>
4081	The flags of the properties returned. The array entries match the
4082	corresponding entries in the @a name array.
4083	</desc>
4084	</param>
4085	</method>
4086
4087	<method name="pushGuestProperties">
4088	<desc>
4089	Set the list of the guest properties matching a set of patterns along
4090	with their values, time stamps and flags and return responsibility for
4091	managing properties to IMachine.
4092	</desc>
4093	<param name="name" type="wstring" dir="in" safearray="yes">
4094	<desc>
4095	The names of the properties.
4096	</desc>
4097	</param>
4098	<param name="value" type="wstring" dir="in" safearray="yes">
4099	<desc>
4100	The values of the properties. The array entries match the
4101	corresponding entries in the @a name array.
4102	</desc>
4103	</param>
4104	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
4105	<desc>
4106	The time stamps of the properties. The array entries match
4107	the corresponding entries in the @a name array.
4108	</desc>
4109	</param>
4110	<param name="flags" type="wstring" dir="in" safearray="yes">
4111	<desc>
4112	The flags of the properties. The array entries match the
4113	corresponding entries in the @a name array.
4114	</desc>
4115	</param>
4116	</method>
4117	<method name="pushGuestProperty">
4118	<desc>
4119	Update a single guest property in IMachine.
4120	</desc>
4121	<param name="name" type="wstring" dir="in">
4122	<desc>
4123	The name of the property to be updated.
4124	</desc>
4125	</param>
4126	<param name="value" type="wstring" dir="in">
4127	<desc>
4128	The value of the property.
4129	</desc>
4130	</param>
4131	<param name="timestamp" type="unsigned long long" dir="in">
4132	<desc>
4133	The timestamp of the property.
4134	</desc>
4135	</param>
4136	<param name="flags" type="wstring" dir="in">
4137	<desc>
4138	The flags of the property.
4139	</desc>
4140	</param>
4141	</method>
4142
4143	<method name="lockMedia">
4144	<desc>
4145	Locks all media attached to the machine for writing and parents of
4146	attached differencing media (if any) for reading. This operation is
4147	atomic so that if it fails no media is actually locked.
4148
4149	This method is intended to be called when the machine is in Starting or
4150	Restoring state. The locked media will be automatically unlocked when
4151	the machine is powered off or crashed.
4152	</desc>
4153	</method>
4154	<method name="unlockMedia">
4155	<desc>
4156	Unlocks all media previously locked using
4157	<link to="IInternalMachineControl::lockMedia"/>.
4158
4159	This method is intended to be used with teleportation so that it is
4160	possible to teleport between processes on the same machine.
4161	</desc>
4162	</method>
4163	</interface>
4164
4165	<interface
4166	name="IBIOSSettings" extends="$unknown"
4167	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4168	wsmap="managed"
4169	>
4170	<desc>
4171	The IBIOSSettings interface represents BIOS settings of the virtual
4172	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4173	</desc>
4174	<attribute name="logoFadeIn" type="boolean">
4175	<desc>Fade in flag for BIOS logo animation.</desc>
4176	</attribute>
4177
4178	<attribute name="logoFadeOut" type="boolean">
4179	<desc>Fade out flag for BIOS logo animation.</desc>
4180	</attribute>
4181
4182	<attribute name="logoDisplayTime" type="unsigned long">
4183	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4184	</attribute>
4185
4186	<attribute name="logoImagePath" type="wstring">
4187	<desc>
4188	Local file system path for external BIOS splash image. Empty string
4189	means the default image is shown on boot.
4190	</desc>
4191	</attribute>
4192
4193	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4194	<desc>Mode of the BIOS boot device menu.</desc>
4195	</attribute>
4196
4197	<attribute name="ACPIEnabled" type="boolean">
4198	<desc>ACPI support flag.</desc>
4199	</attribute>
4200
4201	<attribute name="IOAPICEnabled" type="boolean">
4202	<desc>
4203	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4204	and support IRQs above 15.
4205	</desc>
4206	</attribute>
4207
4208	<attribute name="timeOffset" type="long long">
4209	<desc>
4210	Offset in milliseconds from the host system time. This allows for
4211	guests running with a different system date/time than the host.
4212	It is equivalent to setting the system date/time in the BIOS except
4213	it is not an absolute value but a relative one. Guest Additions
4214	time synchronization honors this offset.
4215	</desc>
4216	</attribute>
4217
4218	<attribute name="PXEDebugEnabled" type="boolean">
4219	<desc>
4220	PXE debug logging flag. If set, VirtualBox will write extensive
4221	PXE trace information to the release log.
4222	</desc>
4223	</attribute>
4224
4225	</interface>
4226
4227	<interface
4228	name="IMachine" extends="$unknown"
4229	uuid="f2816298-7408-4c44-a117-0ed8ea09b9bc"
4230	wsmap="managed"
4231	>
4232	<desc>
4233	The IMachine interface represents a virtual machine, or guest, created
4234	in VirtualBox.
4235
4236	This interface is used in two contexts. First of all, a collection of
4237	objects implementing this interface is stored in the
4238	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4239	machines that are currently registered with this VirtualBox
4240	installation. Also, once a session has been opened for the given virtual
4241	machine (e.g. the virtual machine is running), the machine object
4242	associated with the open session can be queried from the session object;
4243	see <link to="ISession"/> for details.
4244
4245	The main role of this interface is to expose the settings of the virtual
4246	machine and provide methods to change various aspects of the virtual
4247	machine's configuration. For machine objects stored in the
4248	<link to="IVirtualBox::machines"/> collection, all attributes are
4249	read-only unless explicitly stated otherwise in individual attribute
4250	and method descriptions. In order to change a machine setting, a session
4251	for this machine must be opened using one of
4252	<link to="IVirtualBox::openSession"/>,
4253	<link to="IVirtualBox::openRemoteSession"/> or
4254	<link to="IVirtualBox::openExistingSession"/> methods. After the
4255	session has been successfully opened, a mutable machine object needs to
4256	be queried from the session object and then the desired settings changes
4257	can be applied to the returned object using IMachine attributes and
4258	methods. See the <link to="ISession"/> interface description for more
4259	information about sessions.
4260
4261	Note that IMachine does not provide methods to control virtual machine
4262	execution (such as start the machine, or power it down) -- these methods
4263	are grouped in a separate interface called <link to="IConsole" />.
4264
4265	<see>ISession, IConsole</see>
4266	</desc>
4267
4268	<attribute name="parent" type="IVirtualBox" readonly="yes">
4269	<desc>Associated parent object.</desc>
4270	</attribute>
4271
4272	<attribute name="accessible" type="boolean" readonly="yes">
4273	<desc>
4274	Whether this virtual machine is currently accessible or not.
4275
4276	A machine is always deemed accessible unless it is registered <i>and</i>
4277	its settings file cannot be read or parsed (either because the file itself
4278	is unavailable or has invalid XML contents).
4279
4280	Every time this property is read, the accessibility state of
4281	this machine is re-evaluated. If the returned value is @c false,
4282	the <link to="#accessError"/> property may be used to get the
4283	detailed error information describing the reason of
4284	inaccessibility, including XML error messages.
4285
4286	When the machine is inaccessible, only the following properties
4287	can be used on it:
4288	<ul>
4289	<li><link to="#parent"/></li>
4290	<li><link to="#id"/></li>
4291	<li><link to="#settingsFilePath"/></li>
4292	<li><link to="#accessible"/></li>
4293	<li><link to="#accessError"/></li>
4294	</ul>
4295
4296	An attempt to access any other property or method will return
4297	an error.
4298
4299	The only possible action you can perform on an inaccessible
4300	machine is to unregister it using the
4301	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4302	for the accessibility state once more by querying this
4303	property).
4304
4305	<note>
4306	In the current implementation, once this property returns
4307	@c true, the machine will never become inaccessible
4308	later, even if its settings file cannot be successfully
4309	read/written any more (at least, until the VirtualBox
4310	server is restarted). This limitation may be removed in
4311	future releases.
4312	</note>
4313	</desc>
4314	</attribute>
4315
4316	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4317	<desc>
4318	Error information describing the reason of machine
4319	inaccessibility.
4320
4321	Reading this property is only valid after the last call to
4322	<link to="#accessible"/> returned @c false (i.e. the
4323	machine is currently unaccessible). Otherwise, a @c null
4324	IVirtualBoxErrorInfo object will be returned.
4325	</desc>
4326	</attribute>
4327
4328	<attribute name="name" type="wstring">
4329	<desc>
4330	Name of the virtual machine.
4331
4332	Besides being used for human-readable identification purposes
4333	everywhere in VirtualBox, the virtual machine name is also used
4334	as a name of the machine's settings file and as a name of the
4335	subdirectory this settings file resides in. Thus, every time you
4336	change the value of this property, the settings file will be
4337	renamed once you call <link to="#saveSettings"/> to confirm the
4338	change. The containing subdirectory will be also renamed, but
4339	only if it has exactly the same name as the settings file
4340	itself prior to changing this property (for backward compatibility
4341	with previous API releases). The above implies the following
4342	limitations:
4343	<ul>
4344	<li>The machine name cannot be empty.</li>
4345	<li>The machine name can contain only characters that are valid
4346	file name characters according to the rules of the file
4347	system used to store VirtualBox configuration.</li>
4348	<li>You cannot have two or more machines with the same name
4349	if they use the same subdirectory for storing the machine
4350	settings files.</li>
4351	<li>You cannot change the name of the machine if it is running,
4352	or if any file in the directory containing the settings file
4353	is being used by another running machine or by any other
4354	process in the host operating system at a time when
4355	<link to="#saveSettings"/> is called.
4356	</li>
4357	</ul>
4358	If any of the above limitations are hit, <link to="#saveSettings"/>
4359	will return an appropriate error message explaining the exact
4360	reason and the changes you made to this machine will not be
4361	saved.
4362	<note>
4363	For "legacy" machines created using the
4364	<link to="IVirtualBox::createLegacyMachine"/> call,
4365	the above naming limitations do not apply because the
4366	machine name does not affect the settings file name.
4367	The settings file name remains the same as it was specified
4368	during machine creation and never changes.
4369	</note>
4370	</desc>
4371	</attribute>
4372
4373	<attribute name="description" type="wstring">
4374	<desc>
4375	Description of the virtual machine.
4376
4377	The description attribute can contain any text and is
4378	typically used to describe the hardware and software
4379	configuration of the virtual machine in detail (i.e. network
4380	settings, versions of the installed software and so on).
4381	</desc>
4382	</attribute>
4383
4384	<attribute name="id" type="uuid" mod="string" readonly="yes">
4385	<desc>UUID of the virtual machine.</desc>
4386	</attribute>
4387
4388	<attribute name="OSTypeId" type="wstring">
4389	<desc>
4390	User-defined identifier of the Guest OS type.
4391	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4392	an IGuestOSType object representing details about the given
4393	Guest OS type.
4394	<note>
4395	This value may differ from the value returned by
4396	<link to="IGuest::OSTypeId"/> if Guest Additions are
4397	installed to the guest OS.
4398	</note>
4399	</desc>
4400	</attribute>
4401
4402	<attribute name="HardwareVersion" type="wstring">
4403	<desc>Hardware version identifier. Internal use only for now.</desc>
4404	</attribute>
4405
4406	<attribute name="hardwareUUID" type="uuid" mod="string">
4407	<desc>
4408	The UUID presented to the guest via memory tables, hardware and guest
4409	properties. For most VMs this is the same as the @a id, but for VMs
4410	which have been cloned or teleported it may be the same as the source
4411	VM. This latter is because the guest shouldn't notice that it was
4412	cloned or teleported.
4413	</desc>
4414	</attribute>
4415
4416	<attribute name="CPUCount" type="unsigned long">
4417	<desc>Number of virtual CPUs in the VM.</desc>
4418	</attribute>
4419
4420	<attribute name="CPUHotPlugEnabled" type="boolean">
4421	<desc>
4422	This setting determines whether VirtualBox allows CPU
4423	hotplugging for this machine.</desc>
4424	</attribute>
4425
4426	<attribute name="memorySize" type="unsigned long">
4427	<desc>System memory size in megabytes.</desc>
4428	</attribute>
4429
4430	<attribute name="memoryBalloonSize" type="unsigned long">
4431	<desc>Initial memory balloon size in megabytes.</desc>
4432	</attribute>
4433
4434	<attribute name="statisticsUpdateInterval" type="unsigned long">
4435	<desc>Initial interval to update guest statistics in seconds.</desc>
4436	</attribute>
4437
4438	<attribute name="VRAMSize" type="unsigned long">
4439	<desc>Video memory size in megabytes.</desc>
4440	</attribute>
4441
4442	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4443	<desc>
4444	This setting determines whether VirtualBox allows this machine to make
4445	use of the 3D graphics support available on the host.</desc>
4446	</attribute>
4447
4448	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4449	<desc>
4450	This setting determines whether VirtualBox allows this machine to make
4451	use of the 2D video acceleration support available on the host.</desc>
4452	</attribute>
4453
4454	<attribute name="monitorCount" type="unsigned long">
4455	<desc>
4456	Number of virtual monitors.
4457	<note>
4458	Only effective on Windows XP and later guests with
4459	Guest Additions installed.
4460	</note>
4461	</desc>
4462	</attribute>
4463
4464	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4465	<desc>Object containing all BIOS settings.</desc>
4466	</attribute>
4467
4468	<attribute name="firmwareType" type="FirmwareType">
4469	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4470	bootstrap in this VM.</desc>
4471	</attribute>
4472
4473	<attribute name="pointingHidType" type="PointingHidType">
4474	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4475	The default is typically "PS2Mouse" but can vary depending on the
4476	requirements of the guest operating system.</desc>
4477	</attribute>
4478
4479	<attribute name="keyboardHidType" type="KeyboardHidType">
4480	<desc>Type of keyboard HID used in this VM.
4481	The default is typically "PS2Keyboard" but can vary depending on the
4482	requirements of the guest operating system.</desc>
4483	</attribute>
4484
4485	<attribute name="hpetEnabled" type="boolean">
4486	<desc>This attribute controls if High Precision Event Timer (HPET) is
4487	enabled in this VM. Use this property if you want to provide guests
4488	with additional time source, or if guest requires HPET to function correctly.
4489	Default is false.</desc>
4490	</attribute>
4491
4492	<attribute name="snapshotFolder" type="wstring">
4493	<desc>
4494	Full path to the directory used to store snapshot data
4495	(differencing media and saved state files) of this machine.
4496
4497	The initial value of this property is
4498	<tt><</tt><link to="#settingsFilePath">
4499	path_to_settings_file</link><tt>>/<</tt>
4500	<link to="#id">machine_uuid</link>
4501	<tt>></tt>.
4502
4503	Currently, it is an error to try to change this property on
4504	a machine that has snapshots (because this would require to
4505	move possibly large files to a different location).
4506	A separate method will be available for this purpose later.
4507
4508	<note>
4509	Setting this property to @c null or to an empty string will restore
4510	the initial value.
4511	</note>
4512	<note>
4513	When setting this property, the specified path can be
4514	absolute (full path) or relative to the directory where the
4515	<link to="#settingsFilePath">machine settings file</link>
4516	is located. When reading this property, a full path is
4517	always returned.
4518	</note>
4519	<note>
4520	The specified path may not exist, it will be created
4521	when necessary.
4522	</note>
4523	</desc>
4524	</attribute>
4525
4526	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4527	<desc>VRDP server object.</desc>
4528	</attribute>
4529
4530	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4531	<desc>Array of media attached to this machine.</desc>
4532	</attribute>
4533
4534	<attribute name="USBController" type="IUSBController" readonly="yes">
4535	<desc>
4536	Associated USB controller object.
4537
4538	<note>
4539	If USB functionality is not available in the given edition of
4540	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4541	</note>
4542	</desc>
4543	</attribute>
4544
4545	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4546	<desc>Associated audio adapter, always present.</desc>
4547	</attribute>
4548
4549	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4550	<desc>Array of storage controllers attached to this machine.</desc>
4551	</attribute>
4552
4553	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4554	<desc>
4555	Full name of the file containing machine settings data.
4556	</desc>
4557	</attribute>
4558
4559	<attribute name="settingsModified" type="boolean" readonly="yes">
4560	<desc>
4561	Whether the settings of this machine have been modified
4562	(but neither yet saved nor discarded).
4563	<note>
4564	Reading this property is only valid on instances returned
4565	by <link to="ISession::machine"/> and on new machines
4566	created by <link to="IVirtualBox::createMachine"/> or opened
4567	by <link to="IVirtualBox::openMachine"/> but not
4568	yet registered, or on unregistered machines after calling
4569	<link to="IVirtualBox::unregisterMachine"/>. For all other
4570	cases, the settings can never be modified.
4571	</note>
4572	<note>
4573	For newly created unregistered machines, the value of this
4574	property is always @c true until <link to="#saveSettings"/>
4575	is called (no matter if any machine settings have been
4576	changed after the creation or not). For opened machines
4577	the value is set to @c false (and then follows to normal rules).
4578	</note>
4579	</desc>
4580	</attribute>
4581
4582	<attribute name="sessionState" type="SessionState" readonly="yes">
4583	<desc>Current session state for this machine.</desc>
4584	</attribute>
4585
4586	<attribute name="sessionType" type="wstring" readonly="yes">
4587	<desc>
4588	Type of the session. If <link to="#sessionState"/> is
4589	SessionSpawning or SessionOpen, this attribute contains the
4590	same value as passed to the
4591	<link to="IVirtualBox::openRemoteSession"/> method in the
4592	@a type parameter. If the session was opened directly using
4593	<link to="IVirtualBox::openSession"/>, or if
4594	<link to="#sessionState"/> is SessionClosed, the value of this
4595	attribute is an empty string.
4596	</desc>
4597	</attribute>
4598
4599	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4600	<desc>
4601	Identifier of the session process. This attribute contains the
4602	platform-dependent identifier of the process that has opened a
4603	direct session for this machine using the
4604	<link to="IVirtualBox::openSession"/> call. The returned value
4605	is only valid if <link to="#sessionState"/> is SessionOpen or
4606	SessionClosing (i.e. a session is currently open or being
4607	closed) by the time this property is read.
4608	</desc>
4609	</attribute>
4610
4611	<attribute name="state" type="MachineState" readonly="yes">
4612	<desc>Current execution state of this machine.</desc>
4613	</attribute>
4614
4615	<attribute name="lastStateChange" type="long long" readonly="yes">
4616	<desc>
4617	Time stamp of the last execution state change,
4618	in milliseconds since 1970-01-01 UTC.
4619	</desc>
4620	</attribute>
4621
4622	<attribute name="stateFilePath" type="wstring" readonly="yes">
4623	<desc>
4624	Full path to the file that stores the execution state of
4625	the machine when it is in the <link to="MachineState_Saved"/> state.
4626	<note>
4627	When the machine is not in the Saved state, this attribute is
4628	an empty string.
4629	</note>
4630	</desc>
4631	</attribute>
4632
4633	<attribute name="logFolder" type="wstring" readonly="yes">
4634	<desc>
4635	Full path to the folder that stores a set of rotated log files
4636	recorded during machine execution. The most recent log file is
4637	named <tt>VBox.log</tt>, the previous log file is
4638	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4639	in the current version).
4640	</desc>
4641	</attribute>
4642
4643	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4644	<desc>
4645	Current snapshot of this machine. This is @c null if the machine
4646	currently has no snapshots. If it is not @c null, then it was
4647	set by one of <link to="Console::takeSnapshot" />,
4648	<link to="Console::deleteSnapshot" />
4649	or <link to="Console::restoreSnapshot" />, depending on which
4650	was called last. See <link to="ISnapshot"/> for details.
4651	</desc>
4652	</attribute>
4653
4654	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4655	<desc>
4656	Number of snapshots taken on this machine. Zero means the
4657	machine doesn't have any snapshots.
4658	</desc>
4659	</attribute>
4660
4661	<attribute name="currentStateModified" type="boolean" readonly="yes">
4662	<desc>
4663	Returns @c true if the current state of the machine is not
4664	identical to the state stored in the current snapshot.
4665
4666	The current state is identical to the current snapshot only
4667	directly after one of the following calls are made:
4668
4669	<ul>
4670	<li><link to="IConsole::restoreSnapshot"/>
4671	</li>
4672	<li><link to="IConsole::takeSnapshot"/> (issued on a
4673	"powered off" or "saved" machine, for which
4674	<link to="#settingsModified"/> returns @c false)
4675	</li>
4676	<li><link to="IMachine::setCurrentSnapshot"/>
4677	</li>
4678	</ul>
4679
4680	The current state remains identical until one of the following
4681	happens:
4682	<ul>
4683	<li>settings of the machine are changed</li>
4684	<li>the saved state is discarded</li>
4685	<li>the current snapshot is discarded</li>
4686	<li>an attempt to execute the machine is made</li>
4687	</ul>
4688
4689	<note>
4690	For machines that don't have snapshots, this property is
4691	always @c false.
4692	</note>
4693	</desc>
4694	</attribute>
4695
4696	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4697	<desc>
4698	Collection of shared folders for this machine (permanent shared
4699	folders). These folders are shared automatically at machine startup
4700	and available only to the guest OS installed within this machine.
4701
4702	New shared folders are added to the collection using
4703	<link to="#createSharedFolder"/>. Existing shared folders can be
4704	removed using <link to="#removeSharedFolder"/>.
4705	</desc>
4706	</attribute>
4707
4708	<attribute name="clipboardMode" type="ClipboardMode">
4709	<desc>
4710	Synchronization mode between the host OS clipboard
4711	and the guest OS clipboard.
4712	</desc>
4713	</attribute>
4714
4715	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4716	<desc>
4717	A comma-separated list of simple glob patterns. Changes to guest
4718	properties whose name matches one of the patterns will generate an
4719	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4720	</desc>
4721	</attribute>
4722
4723	<attribute name="teleporterEnabled" type="boolean">
4724	<desc>
4725	When set to @a true, the virtual machine becomes a target teleporter
4726	the next time it is powered on. This can only set to @a true when the
4727	VM is in the @a PoweredOff or @a Aborted state.
4728
4729	<!-- This property is automatically set to @a false when the VM is powered
4730	on. (bird: This doesn't work yet ) -->
4731	</desc>
4732	</attribute>
4733
4734	<attribute name="teleporterPort" type="unsigned long">
4735	<desc>
4736	The TCP port the target teleporter will listen for incoming
4737	teleportations on.
4738
4739	0 means the port is automatically selected upon power on. The actual
4740	value can be read from this property while the machine is waiting for
4741	incoming teleportations.
4742	</desc>
4743	</attribute>
4744
4745	<attribute name="teleporterAddress" type="wstring">
4746	<desc>
4747	The address the target teleporter will listen on. If set to an empty
4748	string, it will listen on all addresses.
4749	</desc>
4750	</attribute>
4751
4752	<attribute name="teleporterPassword" type="wstring">
4753	<desc>
4754	The password the to check for on the target teleporter. This is just a
4755	very basic measure to prevent simple hacks and operators accidentally
4756	beaming a virtual machine to the wrong place.
4757	</desc>
4758	</attribute>
4759
4760	<attribute name="RTCUseUTC" type="boolean">
4761	<desc>
4762	When set to @a true, the RTC device of the virtual machine will run
4763	in UTC time, otherwise in local time. Especially Unix guests prefer
4764	the time in UTC.
4765	</desc>
4766	</attribute>
4767
4768	<method name="setBootOrder">
4769	<desc>
4770	Puts the given device to the specified position in
4771	the boot order.
4772
4773	To indicate that no device is associated with the given position,
4774	<link to="DeviceType_Null"/> should be used.
4775
4776	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4777
4778	<result name="E_INVALIDARG">
4779	Boot @a position out of range.
4780	</result>
4781	<result name="E_NOTIMPL">
4782	Booting from USB @a device currently not supported.
4783	</result>
4784
4785	</desc>
4786	<param name="position" type="unsigned long" dir="in">
4787	<desc>
4788	Position in the boot order (@c 1 to the total number of
4789	devices the machine can boot from, as returned by
4790	<link to="ISystemProperties::maxBootPosition"/>).
4791	</desc>
4792	</param>
4793	<param name="device" type="DeviceType" dir="in">
4794	<desc>
4795	The type of the device used to boot at the given position.
4796	</desc>
4797	</param>
4798	</method>
4799
4800	<method name="getBootOrder" const="yes">
4801	<desc>
4802	Returns the device type that occupies the specified
4803	position in the boot order.
4804
4805	@todo [remove?]
4806	If the machine can have more than one device of the returned type
4807	(such as hard disks), then a separate method should be used to
4808	retrieve the individual device that occupies the given position.
4809
4810	If here are no devices at the given position, then
4811	<link to="DeviceType_Null"/> is returned.
4812
4813	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4814
4815	<result name="E_INVALIDARG">
4816	Boot @a position out of range.
4817	</result>
4818
4819	</desc>
4820	<param name="position" type="unsigned long" dir="in">
4821	<desc>
4822	Position in the boot order (@c 1 to the total number of
4823	devices the machine can boot from, as returned by
4824	<link to="ISystemProperties::maxBootPosition"/>).
4825	</desc>
4826	</param>
4827	<param name="device" type="DeviceType" dir="return">
4828	<desc>
4829	Device at the given position.
4830	</desc>
4831	</param>
4832	</method>
4833
4834	<method name="attachDevice">
4835	<desc>
4836	Attaches a device and optionally mounts a medium to the given storage
4837	controller (<link to="IStorageController" />, identified by @a name),
4838	at the indicated port and device.
4839
4840	This method is intended for managing storage devices in general (it works
4841	for both fixed and removable media). For storage devices supporting removable
4842	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4843	for changing the media while the machine is running.
4844
4845	For the IDE bus, the @a controllerPort parameter can be either
4846	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4847	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4848	to specify the master or the slave device, respectively. (In the
4849	default configuration of virtual machines, the secondary master is
4850	used for a CD/DVD drive.)
4851
4852	For an SATA controller, @a controllerPort must be a number ranging
4853	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4854	be a number ranging from @c 0 to @c 15.
4855
4856	For both SCSI and SATA, the @a device parameter is unused and must
4857	be @c 0.
4858
4859	For fixed media such as hard disks, the given medium identifier cannot
4860	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4861	and floppies.
4862
4863	After calling this returns successfully, a new instance of
4864	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4865	attachments (<link to="IMachine::mediumAttachments"/>).
4866
4867	The specified device slot must not have a device attached to it,
4868	or this method will fail.
4869
4870	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4871	information about attaching media.
4872
4873	<note>
4874	You cannot attach a device to a running machine. Also, you cannot
4875	attach a device to a newly created machine until this machine's
4876	settings are saved to disk using <link to="#saveSettings"/>.
4877	</note>
4878	<note>
4879	If the medium is being attached indirectly, a new differencing medium
4880	will implicitly be created for it and attached instead. If the
4881	changes made to the machine settings (including this indirect
4882	attachment) are later cancelled using <link to="#discardSettings"/>,
4883	this implicitly created differencing medium will implicitly
4884	be deleted.
4885	</note>
4886
4887	<result name="E_INVALIDARG">
4888	SATA device, SATA port, IDE port or IDE slot out of range.
4889	</result>
4890	<result name="VBOX_E_INVALID_OBJECT_STATE">
4891	Attempt to attach medium to an unregistered virtual machine.
4892	</result>
4893	<result name="VBOX_E_INVALID_VM_STATE">
4894	Invalid machine state.
4895	</result>
4896	<result name="VBOX_E_OBJECT_IN_USE">
4897	Hard disk already attached to this or another virtual machine.
4898	</result>
4899
4900	</desc>
4901	<param name="name" type="wstring" dir="in">
4902	<desc>Name of the storage controller to attach the device to.</desc>
4903	</param>
4904	<param name="controllerPort" type="long" dir="in">
4905	<desc>Port to attach the device to.</desc>
4906	</param>
4907	<param name="device" type="long" dir="in">
4908	<desc>Device slot in the given port to attach the device to.</desc>
4909	</param>
4910	<param name="type" type="DeviceType" dir="in">
4911	<desc>Device type of the attached device.</desc>
4912	</param>
4913	<param name="id" type="uuid" mod="string" dir="in">
4914	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4915	medium.</desc>
4916	</param>
4917	</method>
4918
4919	<method name="detachDevice">
4920	<desc>
4921	Detaches the device attached to a device slot of the specified bus.
4922
4923	Detaching the device from the virtual machine is deferred. This means
4924	that the medium remains associated with the machine when this method
4925	returns and gets actually de-associated only after a successful
4926	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4927	for more detailed information about attaching media.
4928
4929	<note>
4930	You cannot detach a device from a running machine.
4931	</note>
4932	<note>
4933	Detaching differencing media implicitly created by <link
4934	to="#attachDevice"/> for the indirect attachment using this
4935	method will <b>not</b> implicitly delete them. The
4936	<link to="IMedium::deleteStorage"/> operation should be
4937	explicitly performed by the caller after the medium is successfully
4938	detached and the settings are saved with
4939	<link to="#saveSettings"/>, if it is the desired action.
4940	</note>
4941
4942	<result name="VBOX_E_INVALID_VM_STATE">
4943	Attempt to detach medium from a running virtual machine.
4944	</result>
4945	<result name="VBOX_E_OBJECT_NOT_FOUND">
4946	No medium attached to given slot/bus.
4947	</result>
4948	<result name="VBOX_E_NOT_SUPPORTED">
4949	Medium format does not support storage deletion.
4950	</result>
4951
4952	</desc>
4953	<param name="name" type="wstring" dir="in">
4954	<desc>Name of the storage controller to detach the medium from.</desc>
4955	</param>
4956	<param name="controllerPort" type="long" dir="in">
4957	<desc>Port number to detach the medium from.</desc>
4958	</param>
4959	<param name="device" type="long" dir="in">
4960	<desc>Device slot number to detach the medium from.</desc>
4961	</param>
4962	</method>
4963
4964	<method name="passthroughDevice">
4965	<desc>
4966	Sets the passthrough mode of an existing DVD device. Changing the
4967	setting while the VM is running is forbidden. The setting is only used
4968	if at VM start the device is configured as a host DVD drive, in all
4969	other cases it is ignored. The device must already exist; see
4970	<link to="IMachine::attachDevice"/> for how to attach a new device.
4971
4972	The @a controllerPort and @a device parameters specify the device slot and
4973	have have the same meaning as with <link to="IMachine::attachDevice" />.
4974
4975	<result name="E_INVALIDARG">
4976	SATA device, SATA port, IDE port or IDE slot out of range.
4977	</result>
4978	<result name="VBOX_E_INVALID_OBJECT_STATE">
4979	Attempt to modify an unregistered virtual machine.
4980	</result>
4981	<result name="VBOX_E_INVALID_VM_STATE">
4982	Invalid machine state.
4983	</result>
4984
4985	</desc>
4986	<param name="name" type="wstring" dir="in">
4987	<desc>Name of the storage controller.</desc>
4988	</param>
4989	<param name="controllerPort" type="long" dir="in">
4990	<desc>Storage controller port.</desc>
4991	</param>
4992	<param name="device" type="long" dir="in">
4993	<desc>Device slot in the given port.</desc>
4994	</param>
4995	<param name="passthrough" type="boolean" dir="in">
4996	<desc>New value for the passthrough setting.</desc>
4997	</param>
4998	</method>
4999
5000	<method name="mountMedium">
5001	<desc>
5002	Mounts a medium (<link to="IMedium" />, identified
5003	by the given UUID @a id) to the given storage controller
5004	(<link to="IStorageController" />, identified by @a name),
5005	at the indicated port and device. The device must already exist;
5006	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5007
5008	This method is intended only for managing removable media, where the
5009	device is fixed but media is changeable at runtime (such as DVDs
5010	and floppies). It cannot be used for fixed media such as hard disks.
5011
5012	The @a controllerPort and @a device parameters specify the device slot and
5013	have have the same meaning as with <link to="IMachine::attachDevice" />.
5014
5015	The specified device slot can have a medium mounted, which will be
5016	unmounted first. Specifying a zero UUID (or an empty string) for
5017	@a medium does just an unmount.
5018
5019	See <link to="IMedium"/> for more detailed information about
5020	attaching media.
5021
5022	<result name="E_INVALIDARG">
5023	SATA device, SATA port, IDE port or IDE slot out of range.
5024	</result>
5025	<result name="VBOX_E_INVALID_OBJECT_STATE">
5026	Attempt to attach medium to an unregistered virtual machine.
5027	</result>
5028	<result name="VBOX_E_INVALID_VM_STATE">
5029	Invalid machine state.
5030	</result>
5031	<result name="VBOX_E_OBJECT_IN_USE">
5032	Medium already attached to this or another virtual machine.
5033	</result>
5034
5035	</desc>
5036	<param name="name" type="wstring" dir="in">
5037	<desc>Name of the storage controller to attach the medium to.</desc>
5038	</param>
5039	<param name="controllerPort" type="long" dir="in">
5040	<desc>Port to attach the medium to.</desc>
5041	</param>
5042	<param name="device" type="long" dir="in">
5043	<desc>Device slot in the given port to attach the medium to.</desc>
5044	</param>
5045	<param name="medium" type="uuid" mod="string" dir="in">
5046	<desc>UUID of the medium to attach. A zero UUID means unmount the
5047	currently mounted medium.</desc>
5048	</param>
5049	<param name="force" type="boolean" dir="in">
5050	<desc>Allows to force unmount/mount of a medium which is locked by
5051	theDevice slot in the given port to attach the medium to.</desc>
5052	</param>
5053	</method>
5054
5055	<method name="getMedium" const="yes">
5056	<desc>
5057	Returns the virtual medium attached to a device slot of the specified
5058	bus.
5059
5060	Note that if the medium was indirectly attached by
5061	<link to="#mountMedium"/> to the given device slot then this
5062	method will return not the same object as passed to the
5063	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5064	more detailed information about mounting a medium.
5065
5066	<result name="VBOX_E_OBJECT_NOT_FOUND">
5067	No medium attached to given slot/bus.
5068	</result>
5069
5070	</desc>
5071	<param name="name" type="wstring" dir="in">
5072	<desc>Name of the storage controller the medium is attached to.</desc>
5073	</param>
5074	<param name="controllerPort" type="long" dir="in">
5075	<desc>Port to query.</desc>
5076	</param>
5077	<param name="device" type="long" dir="in">
5078	<desc>Device slot in the given port to query.</desc>
5079	</param>
5080	<param name="medium" type="IMedium" dir="return">
5081	<desc>Attached medium object.</desc>
5082	</param>
5083	</method>
5084
5085	<method name="getMediumAttachmentsOfController" const="yes">
5086	<desc>
5087	Returns an array of medium attachments which are attached to the
5088	the controller with the given name.
5089
5090	<result name="VBOX_E_OBJECT_NOT_FOUND">
5091	A storage controller with given name doesn't exist.
5092	</result>
5093	</desc>
5094	<param name="name" type="wstring" dir="in"/>
5095	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5096	</method>
5097
5098	<method name="getMediumAttachment" const="yes">
5099	<desc>
5100	Returns a medium attachment which corresponds to the controller with
5101	the given name, on the given port and device slot.
5102
5103	<result name="VBOX_E_OBJECT_NOT_FOUND">
5104	No attachment exists for the given controller/port/device combination.
5105	</result>
5106	</desc>
5107	<param name="name" type="wstring" dir="in"/>
5108	<param name="controllerPort" type="long" dir="in"/>
5109	<param name="device" type="long" dir="in"/>
5110	<param name="attachment" type="IMediumAttachment" dir="return"/>
5111	</method>
5112
5113	<method name="getNetworkAdapter" const="yes">
5114	<desc>
5115	Returns the network adapter associated with the given slot.
5116	Slots are numbered sequentially, starting with zero. The total
5117	number of adapters per machine is defined by the
5118	<link to="ISystemProperties::networkAdapterCount"/> property,
5119	so the maximum slot number is one less than that property's value.
5120
5121	<result name="E_INVALIDARG">
5122	Invalid @a slot number.
5123	</result>
5124
5125	</desc>
5126	<param name="slot" type="unsigned long" dir="in"/>
5127	<param name="adapter" type="INetworkAdapter" dir="return"/>
5128	</method>
5129
5130	<method name="addStorageController">
5131	<desc>
5132	Adds a new storage controller (SCSI or SATA controller) to the
5133	machine and returns it as an instance of
5134	<link to="IStorageController" />.
5135
5136	@a name identifies the controller for subsequent calls such as
5137	<link to="#getStorageControllerByName" />,
5138	<link to="#getStorageControllerByInstance" />,
5139	<link to="#removeStorageController" />,
5140	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5141
5142	After the controller has been added, you can set its exact
5143	type by setting the <link to="IStorageController::controllerType" />.
5144
5145	<result name="VBOX_E_OBJECT_IN_USE">
5146	A storage controller with given name exists already.
5147	</result>
5148	<result name="E_INVALIDARG">
5149	Invalid @a controllerType.
5150	</result>
5151	</desc>
5152	<param name="name" type="wstring" dir="in"/>
5153	<param name="connectionType" type="StorageBus" dir="in"/>
5154	<param name="controller" type="IStorageController" dir="return"/>
5155	</method>
5156
5157	<method name="getStorageControllerByName" const="yes">
5158	<desc>
5159	Returns a storage controller with the given name.
5160
5161	<result name="VBOX_E_OBJECT_NOT_FOUND">
5162	A storage controller with given name doesn't exist.
5163	</result>
5164	</desc>
5165	<param name="name" type="wstring" dir="in"/>
5166	<param name="storageController" type="IStorageController" dir="return"/>
5167	</method>
5168
5169	<method name="getStorageControllerByInstance" const="yes">
5170	<desc>
5171	Returns a storage controller with the given instance number.
5172
5173	<result name="VBOX_E_OBJECT_NOT_FOUND">
5174	A storage controller with given instance number doesn't exist.
5175	</result>
5176	</desc>
5177	<param name="instance" type="unsigned long" dir="in"/>
5178	<param name="storageController" type="IStorageController" dir="return"/>
5179	</method>
5180
5181	<method name="removeStorageController">
5182	<desc>
5183	Removes a storage controller from the machine.
5184
5185	<result name="VBOX_E_OBJECT_NOT_FOUND">
5186	A storage controller with given name doesn't exist.
5187	</result>
5188	</desc>
5189	<param name="name" type="wstring" dir="in"/>
5190	</method>
5191
5192	<method name="getSerialPort" const="yes">
5193	<desc>
5194	Returns the serial port associated with the given slot.
5195	Slots are numbered sequentially, starting with zero. The total
5196	number of serial ports per machine is defined by the
5197	<link to="ISystemProperties::serialPortCount"/> property,
5198	so the maximum slot number is one less than that property's value.
5199
5200	<result name="E_INVALIDARG">
5201	Invalid @a slot number.
5202	</result>
5203
5204	</desc>
5205	<param name="slot" type="unsigned long" dir="in"/>
5206	<param name="port" type="ISerialPort" dir="return"/>
5207	</method>
5208
5209	<method name="getParallelPort" const="yes">
5210	<desc>
5211	Returns the parallel port associated with the given slot.
5212	Slots are numbered sequentially, starting with zero. The total
5213	number of parallel ports per machine is defined by the
5214	<link to="ISystemProperties::parallelPortCount"/> property,
5215	so the maximum slot number is one less than that property's value.
5216
5217	<result name="E_INVALIDARG">
5218	Invalid @a slot number.
5219	</result>
5220
5221	</desc>
5222	<param name="slot" type="unsigned long" dir="in"/>
5223	<param name="port" type="IParallelPort" dir="return"/>
5224	</method>
5225
5226	<method name="getExtraDataKeys">
5227	<desc>
5228	Returns an array representing the machine-specific extra data keys
5229	which currently have values defined.
5230	</desc>
5231	<param name="value" type="wstring" dir="return" safearray="yes">
5232	<desc>Array of extra data keys.</desc>
5233	</param>
5234	</method>
5235
5236	<method name="getExtraData">
5237	<desc>
5238	Returns associated machine-specific extra data.
5239
5240	If the requested data @a key does not exist, this function will
5241	succeed and return an empty string in the @a value argument.
5242
5243	<result name="VBOX_E_FILE_ERROR">
5244	Settings file not accessible.
5245	</result>
5246	<result name="VBOX_E_XML_ERROR">
5247	Could not parse the settings file.
5248	</result>
5249
5250	</desc>
5251	<param name="key" type="wstring" dir="in">
5252	<desc>Name of the data key to get.</desc>
5253	</param>
5254	<param name="value" type="wstring" dir="return">
5255	<desc>Value of the requested data key.</desc>
5256	</param>
5257	</method>
5258
5259	<method name="setExtraData">
5260	<desc>
5261	Sets associated machine-specific extra data.
5262
5263	If you pass @c null or an empty string as a key @a value, the given
5264	@a key will be deleted.
5265
5266	<note>
5267	Before performing the actual data change, this method will ask all
5268	registered callbacks using the
5269	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5270	notification for a permission. If one of the callbacks refuses the
5271	new value, the change will not be performed.
5272	</note>
5273	<note>
5274	On success, the
5275	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5276	is called to inform all registered callbacks about a successful data
5277	change.
5278	</note>
5279	<note>
5280	This method can be called outside the machine session and therefore
5281	it's a caller's responsibility to handle possible race conditions
5282	when several clients change the same key at the same time.
5283	</note>
5284
5285	<result name="VBOX_E_FILE_ERROR">
5286	Settings file not accessible.
5287	</result>
5288	<result name="VBOX_E_XML_ERROR">
5289	Could not parse the settings file.
5290	</result>
5291
5292	</desc>
5293	<param name="key" type="wstring" dir="in">
5294	<desc>Name of the data key to set.</desc>
5295	</param>
5296	<param name="value" type="wstring" dir="in">
5297	<desc>Value to assign to the key.</desc>
5298	</param>
5299	</method>
5300
5301	<method name="getCpuProperty" const="yes">
5302	<desc>
5303	Returns the virtual CPU boolean value of the specified property.
5304
5305	<result name="E_INVALIDARG">
5306	Invalid property.
5307	</result>
5308
5309	</desc>
5310	<param name="property" type="CpuPropertyType" dir="in">
5311	<desc>
5312	Property type to query.
5313	</desc>
5314	</param>
5315	<param name="value" type="boolean" dir="return">
5316	<desc>
5317	Property value.
5318	</desc>
5319	</param>
5320	</method>
5321
5322	<method name="setCpuProperty">
5323	<desc>
5324	Sets the virtual CPU boolean value of the specified property.
5325
5326	<result name="E_INVALIDARG">
5327	Invalid property.
5328	</result>
5329
5330	</desc>
5331	<param name="property" type="CpuPropertyType" dir="in">
5332	<desc>
5333	Property type to query.
5334	</desc>
5335	</param>
5336	<param name="value" type="boolean" dir="in">
5337	<desc>
5338	Property value.
5339	</desc>
5340	</param>
5341	</method>
5342
5343	<method name="getCpuIdLeaf" const="yes">
5344	<desc>
5345	Returns the virtual CPU cpuid information for the specified leaf.
5346
5347	Currently supported index values for cpuid:
5348	Standard CPUID leafs: 0 - 0xA
5349	Extended CPUID leafs: 0x80000000 - 0x8000000A
5350
5351	See the Intel and AMD programmer's manuals for detailed information
5352	about the cpuid instruction and its leafs.
5353	<result name="E_INVALIDARG">
5354	Invalid id.
5355	</result>
5356
5357	</desc>
5358	<param name="id" type="unsigned long" dir="in">
5359	<desc>
5360	Cpuid leaf index.
5361	</desc>
5362	</param>
5363	<param name="valEax" type="unsigned long" dir="out">
5364	<desc>
5365	Cpuid leaf value for register eax.
5366	</desc>
5367	</param>
5368	<param name="valEbx" type="unsigned long" dir="out">
5369	<desc>
5370	Cpuid leaf value for register ebx.
5371	</desc>
5372	</param>
5373	<param name="valEcx" type="unsigned long" dir="out">
5374	<desc>
5375	Cpuid leaf value for register ecx.
5376	</desc>
5377	</param>
5378	<param name="valEdx" type="unsigned long" dir="out">
5379	<desc>
5380	Cpuid leaf value for register edx.
5381	</desc>
5382	</param>
5383	</method>
5384
5385	<method name="setCpuIdLeaf" const="yes">
5386	<desc>
5387	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5388	are not passed unmodified. VirtualBox clears features that it doesn't support.
5389
5390	Currently supported index values for cpuid:
5391	Standard CPUID leafs: 0 - 0xA
5392	Extended CPUID leafs: 0x80000000 - 0x8000000A
5393
5394	See the Intel and AMD programmer's manuals for detailed information
5395	about the cpuid instruction and its leafs.
5396
5397	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5398	random crashes inside VMs.
5399	<result name="E_INVALIDARG">
5400	Invalid id.
5401	</result>
5402
5403	</desc>
5404	<param name="id" type="unsigned long" dir="in">
5405	<desc>
5406	Cpuid leaf index.
5407	</desc>
5408	</param>
5409	<param name="valEax" type="unsigned long" dir="in">
5410	<desc>
5411	Cpuid leaf value for register eax.
5412	</desc>
5413	</param>
5414	<param name="valEbx" type="unsigned long" dir="in">
5415	<desc>
5416	Cpuid leaf value for register ebx.
5417	</desc>
5418	</param>
5419	<param name="valEcx" type="unsigned long" dir="in">
5420	<desc>
5421	Cpuid leaf value for register ecx.
5422	</desc>
5423	</param>
5424	<param name="valEdx" type="unsigned long" dir="in">
5425	<desc>
5426	Cpuid leaf value for register edx.
5427	</desc>
5428	</param>
5429	</method>
5430
5431	<method name="removeCpuIdLeaf" const="yes">
5432	<desc>
5433	Removes the virtual CPU cpuid leaf for the specified index
5434
5435	<result name="E_INVALIDARG">
5436	Invalid id.
5437	</result>
5438
5439	</desc>
5440	<param name="id" type="unsigned long" dir="in">
5441	<desc>
5442	Cpuid leaf index.
5443	</desc>
5444	</param>
5445	</method>
5446
5447	<method name="removeAllCpuIdLeafs" const="yes">
5448	<desc>
5449	Removes all the virtual CPU cpuid leafs
5450	</desc>
5451	</method>
5452
5453	<method name="getHWVirtExProperty" const="yes">
5454	<desc>
5455	Returns the value of the specified hardware virtualization boolean property.
5456
5457	<result name="E_INVALIDARG">
5458	Invalid property.
5459	</result>
5460
5461	</desc>
5462	<param name="property" type="HWVirtExPropertyType" dir="in">
5463	<desc>
5464	Property type to query.
5465	</desc>
5466	</param>
5467	<param name="value" type="boolean" dir="return">
5468	<desc>
5469	Property value.
5470	</desc>
5471	</param>
5472	</method>
5473
5474	<method name="setHWVirtExProperty">
5475	<desc>
5476	Sets a new value for the specified hardware virtualization boolean property.
5477
5478	<result name="E_INVALIDARG">
5479	Invalid property.
5480	</result>
5481
5482	</desc>
5483	<param name="property" type="HWVirtExPropertyType" dir="in">
5484	<desc>
5485	Property type to set.
5486	</desc>
5487	</param>
5488	<param name="value" type="boolean" dir="in">
5489	<desc>
5490	New property value.
5491	</desc>
5492	</param>
5493	</method>
5494
5495	<method name="saveSettings">
5496	<desc>
5497	Saves any changes to machine settings made since the session
5498	has been opened or a new machine has been created, or since the
5499	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5500	For registered machines, new settings become visible to all
5501	other VirtualBox clients after successful invocation of this
5502	method.
5503	<note>
5504	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5505	notification event after the configuration has been successfully
5506	saved (only for registered machines).
5507	</note>
5508	<note>
5509	Calling this method is only valid on instances returned
5510	by <link to="ISession::machine"/> and on new machines
5511	created by <link to="IVirtualBox::createMachine"/> but not
5512	yet registered, or on unregistered machines after calling
5513	<link to="IVirtualBox::unregisterMachine"/>.
5514	</note>
5515
5516	<result name="VBOX_E_FILE_ERROR">
5517	Settings file not accessible.
5518	</result>
5519	<result name="VBOX_E_XML_ERROR">
5520	Could not parse the settings file.
5521	</result>
5522	<result name="E_ACCESSDENIED">
5523	Modification request refused.
5524	</result>
5525
5526	</desc>
5527	</method>
5528
5529	<method name="discardSettings">
5530	<desc>
5531	Discards any changes to the machine settings made since the session
5532	has been opened or since the last call to <link to="#saveSettings"/>
5533	or <link to="#discardSettings"/>.
5534	<note>
5535	Calling this method is only valid on instances returned
5536	by <link to="ISession::machine"/> and on new machines
5537	created by <link to="IVirtualBox::createMachine"/> or
5538	opened by <link to="IVirtualBox::openMachine"/> but not
5539	yet registered, or on unregistered machines after calling
5540	<link to="IVirtualBox::unregisterMachine"/>.
5541	</note>
5542
5543	<result name="VBOX_E_INVALID_VM_STATE">
5544	Virtual machine is not mutable.
5545	</result>
5546
5547	</desc>
5548	</method>
5549
5550	<method name="deleteSettings">
5551	<desc>
5552	Deletes the settings file of this machine from disk.
5553	The machine must not be registered in order for this operation
5554	to succeed.
5555	<note>
5556	<link to="#settingsModified"/> will return @c true after this
5557	method successfully returns.
5558	</note>
5559	<note>
5560	Calling this method is only valid on instances returned
5561	by <link to="ISession::machine"/> and on new machines
5562	created by <link to="IVirtualBox::createMachine"/> or
5563	opened by <link to="IVirtualBox::openMachine"/> but not
5564	yet registered, or on unregistered machines after calling
5565	<link to="IVirtualBox::unregisterMachine"/>.
5566	</note>
5567	<note>
5568	The deleted machine settings file can be restored (saved again)
5569	by calling <link to="#saveSettings"/>.
5570	</note>
5571
5572	<result name="VBOX_E_INVALID_VM_STATE">
5573	Cannot delete settings of a registered machine or
5574	machine not mutable.
5575	</result>
5576	<result name="VBOX_E_IPRT_ERROR">
5577	Could not delete the settings file.
5578	</result>
5579
5580	</desc>
5581	</method>
5582
5583	<method name="export">
5584	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5585	steps required to export VirtualBox machines to OVF.
5586	</desc>
5587
5588	<param name="aAppliance" type="IAppliance" dir="in">
5589	<desc>Appliance to export this machine to.</desc>
5590	</param>
5591	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5592	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5593	</param>
5594	</method >
5595
5596	<method name="getSnapshot">
5597	<desc>
5598	Returns a snapshot of this machine with the given UUID.
5599	A @c null UUID can be used to obtain the first snapshot
5600	taken on this machine. This is useful if you want to traverse
5601	the whole tree of snapshots starting from the root.
5602
5603	<result name="VBOX_E_OBJECT_NOT_FOUND">
5604	Virtual machine has no snapshots or snapshot not found.
5605	</result>
5606
5607	</desc>
5608	<param name="id" type="uuid" mod="string" dir="in">
5609	<desc>UUID of the snapshot to get</desc>
5610	</param>
5611	<param name="snapshot" type="ISnapshot" dir="return">
5612	<desc>Snapshot object with the given UUID.</desc>
5613	</param>
5614	</method>
5615
5616	<method name="findSnapshot">
5617	<desc>
5618	Returns a snapshot of this machine with the given name.
5619
5620	<result name="VBOX_E_OBJECT_NOT_FOUND">
5621	Virtual machine has no snapshots or snapshot not found.
5622	</result>
5623
5624	</desc>
5625	<param name="name" type="wstring" dir="in">
5626	<desc>Name of the snapshot to find</desc>
5627	</param>
5628	<param name="snapshot" type="ISnapshot" dir="return">
5629	<desc>Snapshot object with the given name.</desc>
5630	</param>
5631	</method>
5632
5633	<method name="setCurrentSnapshot">
5634	<desc>
5635	Sets the current snapshot of this machine.
5636	<note>
5637	In the current implementation, this operation is not
5638	implemented.
5639	</note>
5640	</desc>
5641	<param name="id" type="uuid" mod="string" dir="in">
5642	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5643	</param>
5644	</method>
5645
5646	<method name="createSharedFolder">
5647	<desc>
5648	Creates a new permanent shared folder by associating the given logical
5649	name with the given host path, adds it to the collection of shared
5650	folders and starts sharing it. Refer to the description of
5651	<link to="ISharedFolder"/> to read more about logical names.
5652
5653	<result name="VBOX_E_OBJECT_IN_USE">
5654	Shared folder already exists.
5655	</result>
5656	<result name="VBOX_E_FILE_ERROR">
5657	Shared folder @a hostPath not accessible.
5658	</result>
5659
5660	</desc>
5661	<param name="name" type="wstring" dir="in">
5662	<desc>Unique logical name of the shared folder.</desc>
5663	</param>
5664	<param name="hostPath" type="wstring" dir="in">
5665	<desc>Full path to the shared folder in the host file system.</desc>
5666	</param>
5667	<param name="writable" type="boolean" dir="in">
5668	<desc>Whether the share is writable or readonly</desc>
5669	</param>
5670	</method>
5671
5672	<method name="removeSharedFolder">
5673	<desc>
5674	Removes the permanent shared folder with the given name previously
5675	created by <link to="#createSharedFolder"/> from the collection of
5676	shared folders and stops sharing it.
5677
5678	<result name="VBOX_E_INVALID_VM_STATE">
5679	Virtual machine is not mutable.
5680	</result>
5681	<result name="VBOX_E_OBJECT_NOT_FOUND">
5682	Shared folder @a name does not exist.
5683	</result>
5684
5685	</desc>
5686	<param name="name" type="wstring" dir="in">
5687	<desc>Logical name of the shared folder to remove.</desc>
5688	</param>
5689	</method>
5690
5691	<method name="canShowConsoleWindow">
5692	<desc>
5693	Returns @c true if the VM console process can activate the
5694	console window and bring it to foreground on the desktop of
5695	the host PC.
5696	<note>
5697	This method will fail if a session for this machine is not
5698	currently open.
5699	</note>
5700
5701	<result name="VBOX_E_INVALID_VM_STATE">
5702	Machine session is not open.
5703	</result>
5704
5705	</desc>
5706	<param name="canShow" type="boolean" dir="return">
5707	<desc>
5708	@c true if the console window can be shown and @c false otherwise.
5709	</desc>
5710	</param>
5711	</method>
5712
5713	<method name="showConsoleWindow">
5714	<desc>
5715	Activates the console window and brings it to foreground on
5716	the desktop of the host PC. Many modern window managers on
5717	many platforms implement some sort of focus stealing
5718	prevention logic, so that it may be impossible to activate
5719	a window without the help of the currently active
5720	application. In this case, this method will return a non-zero
5721	identifier that represents the top-level window of the VM
5722	console process. The caller, if it represents a currently
5723	active process, is responsible to use this identifier (in a
5724	platform-dependent manner) to perform actual window
5725	activation.
5726	<note>
5727	This method will fail if a session for this machine is not
5728	currently open.
5729	</note>
5730
5731	<result name="VBOX_E_INVALID_VM_STATE">
5732	Machine session is not open.
5733	</result>
5734
5735	</desc>
5736	<param name="winId" type="unsigned long long" dir="return">
5737	<desc>
5738	Platform-dependent identifier of the top-level VM console
5739	window, or zero if this method has performed all actions
5740	necessary to implement the <i>show window</i> semantics for
5741	the given platform and/or VirtualBox front-end.
5742	</desc>
5743	</param>
5744	</method>
5745
5746	<method name="getGuestProperty">
5747	<desc>
5748	Reads an entry from the machine's guest property store.
5749
5750	<result name="VBOX_E_INVALID_VM_STATE">
5751	Machine session is not open.
5752	</result>
5753
5754	</desc>
5755	<param name="name" type="wstring" dir="in">
5756	<desc>
5757	The name of the property to read.
5758	</desc>
5759	</param>
5760	<param name="value" type="wstring" dir="out">
5761	<desc>
5762	The value of the property. If the property does not exist then this
5763	will be empty.
5764	</desc>
5765	</param>
5766	<param name="timestamp" type="unsigned long long" dir="out">
5767	<desc>
5768	The time at which the property was last modified, as seen by the
5769	server process.
5770	</desc>
5771	</param>
5772	<param name="flags" type="wstring" dir="out">
5773	<desc>
5774	Additional property parameters, passed as a comma-separated list of
5775	"name=value" type entries.
5776	</desc>
5777	</param>
5778	</method>
5779
5780	<method name="getGuestPropertyValue">
5781	<desc>
5782	Reads a value from the machine's guest property store.
5783
5784	<result name="VBOX_E_INVALID_VM_STATE">
5785	Machine session is not open.
5786	</result>
5787
5788	</desc>
5789	<param name="property" type="wstring" dir="in">
5790	<desc>
5791	The name of the property to read.
5792	</desc>
5793	</param>
5794	<param name="value" type="wstring" dir="return">
5795	<desc>
5796	The value of the property. If the property does not exist then this
5797	will be empty.
5798	</desc>
5799	</param>
5800	</method>
5801
5802	<method name="getGuestPropertyTimestamp">
5803	<desc>
5804	Reads a property timestamp from the machine's guest property store.
5805
5806	<result name="VBOX_E_INVALID_VM_STATE">
5807	Machine session is not open.
5808	</result>
5809
5810	</desc>
5811	<param name="property" type="wstring" dir="in">
5812	<desc>
5813	The name of the property to read.
5814	</desc>
5815	</param>
5816	<param name="value" type="unsigned long long" dir="return">
5817	<desc>
5818	The timestamp. If the property does not exist then this will be
5819	empty.
5820	</desc>
5821	</param>
5822	</method>
5823
5824	<method name="setGuestProperty">
5825	<desc>
5826	Sets, changes or deletes an entry in the machine's guest property
5827	store.
5828
5829	<result name="E_ACCESSDENIED">
5830	Property cannot be changed.
5831	</result>
5832	<result name="E_INVALIDARG">
5833	Invalid @a flags.
5834	</result>
5835	<result name="VBOX_E_INVALID_VM_STATE">
5836	Virtual machine is not mutable or session not open.
5837	</result>
5838	<result name="VBOX_E_INVALID_OBJECT_STATE">
5839	Cannot set transient property when machine not running.
5840	</result>
5841
5842	</desc>
5843	<param name="property" type="wstring" dir="in">
5844	<desc>
5845	The name of the property to set, change or delete.
5846	</desc>
5847	</param>
5848	<param name="value" type="wstring" dir="in">
5849	<desc>
5850	The new value of the property to set, change or delete. If the
5851	property does not yet exist and value is non-empty, it will be
5852	created. If the value is @c null or empty, the property will be
5853	deleted if it exists.
5854	</desc>
5855	</param>
5856	<param name="flags" type="wstring" dir="in">
5857	<desc>
5858	Additional property parameters, passed as a comma-separated list of
5859	"name=value" type entries.
5860	</desc>
5861	</param>
5862	</method>
5863
5864	<method name="setGuestPropertyValue">
5865	<desc>
5866	Sets, changes or deletes a value in the machine's guest property
5867	store. The flags field will be left unchanged or created empty for a
5868	new property.
5869
5870	<result name="E_ACCESSDENIED">
5871	Property cannot be changed.
5872	</result>
5873	<result name="VBOX_E_INVALID_VM_STATE">
5874	Virtual machine is not mutable or session not open.
5875	</result>
5876	<result name="VBOX_E_INVALID_OBJECT_STATE">
5877	Cannot set transient property when machine not running.
5878	</result>
5879	</desc>
5880
5881	<param name="property" type="wstring" dir="in">
5882	<desc>
5883	The name of the property to set, change or delete.
5884	</desc>
5885	</param>
5886	<param name="value" type="wstring" dir="in">
5887	<desc>
5888	The new value of the property to set, change or delete. If the
5889	property does not yet exist and value is non-empty, it will be
5890	created. If the value is @c null or empty, the property will be
5891	deleted if it exists.
5892	</desc>
5893	</param>
5894	</method>
5895
5896	<method name="enumerateGuestProperties">
5897	<desc>
5898	Return a list of the guest properties matching a set of patterns along
5899	with their values, time stamps and flags.
5900	</desc>
5901	<param name="patterns" type="wstring" dir="in">
5902	<desc>
5903	The patterns to match the properties against, separated by '\|'
5904	characters. If this is empty or @c null, all properties will match.
5905	</desc>
5906	</param>
5907	<param name="name" type="wstring" dir="out" safearray="yes">
5908	<desc>
5909	The names of the properties returned.
5910	</desc>
5911	</param>
5912	<param name="value" type="wstring" dir="out" safearray="yes">
5913	<desc>
5914	The values of the properties returned. The array entries match the
5915	corresponding entries in the @a name array.
5916	</desc>
5917	</param>
5918	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5919	<desc>
5920	The time stamps of the properties returned. The array entries match
5921	the corresponding entries in the @a name array.
5922	</desc>
5923	</param>
5924	<param name="flags" type="wstring" dir="out" safearray="yes">
5925	<desc>
5926	The flags of the properties returned. The array entries match the
5927	corresponding entries in the @a name array.
5928	</desc>
5929	</param>
5930	</method>
5931
5932	<method name="querySavedThumbnailSize">
5933	<desc>
5934	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5935	</desc>
5936	<param name="size" type="unsigned long" dir="out">
5937	<desc>
5938	Size of buffer required to store the bitmap.
5939	</desc>
5940	</param>
5941	<param name="width" type="unsigned long" dir="out">
5942	<desc>
5943	Bitmap width.
5944	</desc>
5945	</param>
5946	<param name="height" type="unsigned long" dir="out">
5947	<desc>
5948	Bitmap height.
5949	</desc>
5950	</param>
5951	</method>
5952
5953	<method name="readSavedThumbnailToArray">
5954	<desc>
5955	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5956	</desc>
5957	<param name="BGR" type="boolean" dir="in">
5958	<desc>
5959	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5960	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5961	</desc>
5962	</param>
5963	<param name="width" type="unsigned long" dir="out">
5964	<desc>
5965	Bitmap width.
5966	</desc>
5967	</param>
5968	<param name="height" type="unsigned long" dir="out">
5969	<desc>
5970	Bitmap height.
5971	</desc>
5972	</param>
5973	<param name="data" type="octet" dir="return" safearray="yes">
5974	<desc>
5975	Array with resulting bitmap data.
5976	</desc>
5977	</param>
5978	</method>
5979
5980	<method name="querySavedScreenshotPNGSize">
5981	<desc>
5982	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5983	</desc>
5984	<param name="size" type="unsigned long" dir="out">
5985	<desc>
5986	Size of buffer required to store the PNG binary data.
5987	</desc>
5988	</param>
5989	<param name="width" type="unsigned long" dir="out">
5990	<desc>
5991	Image width.
5992	</desc>
5993	</param>
5994	<param name="height" type="unsigned long" dir="out">
5995	<desc>
5996	Image height.
5997	</desc>
5998	</param>
5999	</method>
6000
6001	<method name="readSavedScreenshotPNGToArray">
6002	<desc>
6003	Screenshot in PNG format is retrieved to an array of bytes.
6004	</desc>
6005	<param name="width" type="unsigned long" dir="out">
6006	<desc>
6007	Image width.
6008	</desc>
6009	</param>
6010	<param name="height" type="unsigned long" dir="out">
6011	<desc>
6012	Image height.
6013	</desc>
6014	</param>
6015	<param name="data" type="octet" dir="return" safearray="yes">
6016	<desc>
6017	Array with resulting PNG data.
6018	</desc>
6019	</param>
6020	</method>
6021
6022	<method name="HotPlugCPU">
6023	<desc>
6024	Plugs a CPU into the machine.
6025	</desc>
6026	<param name="cpu" type="unsigned long" dir="in">
6027	<desc>
6028	The CPU id to insert.
6029	</desc>
6030	</param>
6031	</method>
6032
6033	<method name="HotUnplugCPU">
6034	<desc>
6035	Removes a CPU from the machine.
6036	</desc>
6037	<param name="cpu" type="unsigned long" dir="in">
6038	<desc>
6039	The CPU id to remove.
6040	</desc>
6041	</param>
6042	</method>
6043
6044	<method name="GetCPUStatus">
6045	<desc>
6046	Plugs a CPU into the machine.
6047	</desc>
6048	<param name="cpu" type="unsigned long" dir="in">
6049	<desc>
6050	The CPU id to check for.
6051	</desc>
6052	</param>
6053	<param name="attached" type="boolean" dir="return">
6054	<desc>
6055	Status of the CPU.
6056	</desc>
6057	</param>
6058	</method>
6059	</interface>
6060
6061	<!--
6062	// IConsole
6063	/////////////////////////////////////////////////////////////////////////
6064	-->
6065
6066	<interface
6067	name="IConsoleCallback" extends="$unknown"
6068	uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
6069	wsmap="suppress"
6070	>
6071
6072	<desc>
6073	This interface is used by a client of the Main API that need to
6074	be notified of events. For example, a graphical user interface
6075	can use this to learn about machine state changes so they can
6076	update the list of virtual machines without having to rely
6077	on polling.
6078
6079	Whenever relevant events occur in VirtualBox, the callbacks in
6080	objects of this interface are called. In order for this to be
6081	useful, a client needs to create its own subclass that implements
6082	this interface in which the methods for the relevant callbacks
6083	are overridden. An instance of this subclass interface can then
6084	be passed to <link to="IConsole::registerCallback" />.
6085	</desc>
6086
6087	<method name="onMousePointerShapeChange">
6088	<desc>
6089	Notification when the guest mouse pointer shape has
6090	changed. The new shape data is given.
6091	</desc>
6092	<param name="visible" type="boolean" dir="in">
6093	<desc>
6094	Flag whether the pointer is visible.
6095	</desc>
6096	</param>
6097	<param name="alpha" type="boolean" dir="in">
6098	<desc>
6099	Flag whether the pointer has an alpha channel.
6100	</desc>
6101	</param>
6102	<param name="xHot" type="unsigned long" dir="in">
6103	<desc>
6104	The pointer hot spot x coordinate.
6105	</desc>
6106	</param>
6107	<param name="yHot" type="unsigned long" dir="in">
6108	<desc>
6109	The pointer hot spot y coordinate.
6110	</desc>
6111	</param>
6112	<param name="width" type="unsigned long" dir="in">
6113	<desc>
6114	Width of the pointer shape in pixels.
6115	</desc>
6116	</param>
6117	<param name="height" type="unsigned long" dir="in">
6118	<desc>
6119	Height of the pointer shape in pixels.
6120	</desc>
6121	</param>
6122	<param name="shape" type="octet" mod="ptr" dir="in">
6123	<desc>
6124	Address of the shape buffer.
6125
6126	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6127	followed by a 32-bpp XOR (color) mask.
6128
6129	For pointers without alpha channel the XOR mask pixels are 32
6130	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6131	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6132
6133	An AND mask is used for pointers with alpha channel, so if the
6134	callback does not support alpha, the pointer could be
6135	displayed as a normal color pointer.
6136
6137	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6138	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6139	height</tt>. The padding bits at the end of each scanline are
6140	undefined.
6141
6142	The XOR mask follows the AND mask on the next 4-byte aligned
6143	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6144	Bytes in the gap between the AND and the XOR mask are undefined.
6145	The XOR mask scanlines have no gap between them and the size of
6146	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6147
6148	<note>
6149	If @a shape is 0, only the pointer visibility is changed.
6150	</note>
6151	</desc>
6152	</param>
6153	</method>
6154
6155	<method name="onMouseCapabilityChange">
6156	<desc>
6157	Notification when the mouse capabilities reported by the
6158	guest have changed. The new capabilities are passed.
6159	</desc>
6160	<param name="supportsAbsolute" type="boolean" dir="in"/>
6161	<param name="needsHostCursor" type="boolean" dir="in"/>
6162	</method>
6163
6164	<method name="onKeyboardLedsChange">
6165	<desc>
6166	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6167	to alter the state of the keyboard LEDs.
6168	</desc>
6169	<param name="numLock" type="boolean" dir="in"/>
6170	<param name="capsLock" type="boolean" dir="in"/>
6171	<param name="scrollLock" type="boolean" dir="in"/>
6172	</method>
6173
6174	<method name="onStateChange">
6175	<desc>
6176	Notification when the execution state of the machine has changed.
6177	The new state will be given.
6178	</desc>
6179	<param name="state" type="MachineState" dir="in"/>
6180	</method>
6181
6182	<method name="onAdditionsStateChange">
6183	<desc>
6184	Notification when a Guest Additions property changes.
6185	Interested callees should query IGuest attributes to
6186	find out what has changed.
6187	</desc>
6188	</method>
6189
6190	<method name="onNetworkAdapterChange">
6191	<desc>
6192	Notification when a property of one of the
6193	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6194	changes. Interested callees should use INetworkAdapter methods and
6195	attributes to find out what has changed.
6196	</desc>
6197	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6198	<desc>Network adapter that is subject to change.</desc>
6199	</param>
6200	</method>
6201
6202	<method name="onSerialPortChange">
6203	<desc>
6204	Notification when a property of one of the
6205	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6206	Interested callees should use ISerialPort methods and attributes
6207	to find out what has changed.
6208	</desc>
6209	<param name="serialPort" type="ISerialPort" dir="in">
6210	<desc>Serial port that is subject to change.</desc>
6211	</param>
6212	</method>
6213
6214	<method name="onParallelPortChange">
6215	<desc>
6216	Notification when a property of one of the
6217	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6218	changes. Interested callees should use ISerialPort methods and
6219	attributes to find out what has changed.
6220	</desc>
6221	<param name="parallelPort" type="IParallelPort" dir="in">
6222	<desc>Parallel port that is subject to change.</desc>
6223	</param>
6224	</method>
6225
6226	<method name="onStorageControllerChange">
6227	<desc>
6228	Notification when a property of one of the
6229	virtual <link to="IMachine::storageControllers">storage controllers</link>
6230	changes. Interested callees should query the corresponding collections
6231	to find out what has changed.
6232	</desc>
6233	</method>
6234
6235	<method name="onMediumChange">
6236	<desc>
6237	Notification when a
6238	<link to="IMachine::mediumAttachments">medium attachment</link>
6239	changes.
6240	</desc>
6241	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6242	<desc>Medium attachment that is subject to change.</desc>
6243	</param>
6244	</method>
6245
6246	<method name="onCPUChange">
6247	<desc>
6248	Notification when a CPU changes.
6249	</desc>
6250	<param name="cpu" type="unsigned long" dir="in">
6251	<desc>The CPU which changed</desc>
6252	</param>
6253	<param name="add" type="boolean" dir="in">
6254	<desc>Flag whether the CPU was added or removed</desc>
6255	</param>
6256	</method>
6257
6258	<method name="onVRDPServerChange">
6259	<desc>
6260	Notification when a property of the
6261	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6262	Interested callees should use IVRDPServer methods and attributes to
6263	find out what has changed.
6264	</desc>
6265	</method>
6266
6267	<method name="onRemoteDisplayInfoChange">
6268	<desc>
6269	Notification when the status of the VRDP server changes. Interested callees
6270	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6271	attributes to find out what is the current status.
6272	</desc>
6273	</method>
6274
6275	<method name="onUSBControllerChange">
6276	<desc>
6277	Notification when a property of the virtual
6278	<link to="IMachine::USBController">USB controller</link> changes.
6279	Interested callees should use IUSBController methods and attributes to
6280	find out what has changed.
6281	</desc>
6282	</method>
6283
6284	<method name="onUSBDeviceStateChange">
6285	<desc>
6286	Notification when a USB device is attached to or detached from
6287	the virtual USB controller.
6288
6289	This notification is sent as a result of the indirect
6290	request to attach the device because it matches one of the
6291	machine USB filters, or as a result of the direct request
6292	issued by <link to="IConsole::attachUSBDevice"/> or
6293	<link to="IConsole::detachUSBDevice"/>.
6294
6295	This notification is sent in case of both a succeeded and a
6296	failed request completion. When the request succeeds, the
6297	@a error parameter is @c null, and the given device has been
6298	already added to (when @a attached is @c true) or removed from
6299	(when @a attached is @c false) the collection represented by
6300	<link to="IConsole::USBDevices"/>. On failure, the collection
6301	doesn't change and the @a error parameter represents the error
6302	message describing the failure.
6303
6304	</desc>
6305	<param name="device" type="IUSBDevice" dir="in">
6306	<desc>Device that is subject to state change.</desc>
6307	</param>
6308	<param name="attached" type="boolean" dir="in">
6309	<desc>
6310	@c true if the device was attached and @c false otherwise.
6311	</desc>
6312	</param>
6313	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6314	<desc>
6315	@c null on success or an error message object on failure.
6316	</desc>
6317	</param>
6318	</method>
6319
6320	<method name="onSharedFolderChange">
6321	<desc>
6322	Notification when a shared folder is added or removed.
6323	The @a scope argument defines one of three scopes:
6324	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6325	(<link to="Scope_Global">Global</link>),
6326	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6327	the machine (<link to="Scope_Machine">Machine</link>) or <link
6328	to="IConsole::sharedFolders">transient shared folders</link> of the
6329	machine (<link to="Scope_Session">Session</link>). Interested callees
6330	should use query the corresponding collections to find out what has
6331	changed.
6332	</desc>
6333	<param name="scope" type="Scope" dir="in">
6334	<desc>Scope of the notification.</desc>
6335	</param>
6336	</method>
6337
6338	<method name="onRuntimeError">
6339	<desc>
6340	Notification when an error happens during the virtual
6341	machine execution.
6342
6343	There are three kinds of runtime errors:
6344	<ul>
6345	<li><i>fatal</i></li>
6346	<li><i>non-fatal with retry</i></li>
6347	<li><i>non-fatal warnings</i></li>
6348	</ul>
6349
6350	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6351	to @c true. In case of fatal errors, the virtual machine
6352	execution is always paused before calling this notification, and
6353	the notification handler is supposed either to immediately save
6354	the virtual machine state using <link to="IConsole::saveState"/>
6355	or power it off using <link to="IConsole::powerDown"/>.
6356	Resuming the execution can lead to unpredictable results.
6357
6358	<b>Non-fatal</b> errors and warnings are indicated by the
6359	@a fatal parameter set to @c false. If the virtual machine
6360	is in the Paused state by the time the error notification is
6361	received, it means that the user can <i>try to resume</i> the machine
6362	execution after attempting to solve the problem that caused the
6363	error. In this case, the notification handler is supposed
6364	to show an appropriate message to the user (depending on the
6365	value of the @a id parameter) that offers several actions such
6366	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6367	wants to retry, the notification handler should continue
6368	the machine execution using the <link to="IConsole::resume"/>
6369	call. If the machine execution is not Paused during this
6370	notification, then it means this notification is a <i>warning</i>
6371	(for example, about a fatal condition that can happen very soon);
6372	no immediate action is required from the user, the machine
6373	continues its normal execution.
6374
6375	Note that in either case the notification handler
6376	<b>must not</b> perform any action directly on a thread
6377	where this notification is called. Everything it is allowed to
6378	do is to post a message to another thread that will then talk
6379	to the user and take the corresponding action.
6380
6381	Currently, the following error identifiers are known:
6382	<ul>
6383	<li><tt>"HostMemoryLow"</tt></li>
6384	<li><tt>"HostAudioNotResponding"</tt></li>
6385	<li><tt>"VDIStorageFull"</tt></li>
6386	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6387	</ul>
6388
6389	<note>
6390	This notification is not designed to be implemented by
6391	more than one callback at a time. If you have multiple
6392	IConsoleCallback instances registered on the given
6393	IConsole object, make sure you simply do nothing but
6394	return @c S_OK from all but one of them that does actual
6395	user notification and performs necessary actions.
6396	</note>
6397
6398	</desc>
6399	<param name="fatal" type="boolean" dir="in">
6400	<desc>Whether the error is fatal or not</desc>
6401	</param>
6402	<param name="id" type="wstring" dir="in">
6403	<desc>Error identifier</desc>
6404	</param>
6405	<param name="message" type="wstring" dir="in">
6406	<desc>Optional error message</desc>
6407	</param>
6408	</method>
6409
6410	<method name="onCanShowWindow">
6411	<desc>
6412	Notification when a call to
6413	<link to="IMachine::canShowConsoleWindow"/> is made by a
6414	front-end to check if a subsequent call to
6415	<link to="IMachine::showConsoleWindow"/> can succeed.
6416
6417	The callee should give an answer appropriate to the current
6418	machine state in the @a canShow argument. This answer must
6419	remain valid at least until the next
6420	<link to="IConsole::state">machine state</link> change.
6421
6422	<note>
6423	This notification is not designed to be implemented by
6424	more than one callback at a time. If you have multiple
6425	IConsoleCallback instances registered on the given
6426	IConsole object, make sure you simply do nothing but
6427	return @c true and @c S_OK from all but one of them that
6428	actually manages console window activation.
6429	</note>
6430	</desc>
6431	<param name="canShow" type="boolean" dir="return">
6432	<desc>
6433	@c true if the console window can be shown and @c false otherwise.
6434	</desc>
6435	</param>
6436	</method>
6437
6438	<method name="onShowWindow">
6439	<desc>
6440	Notification when a call to
6441	<link to="IMachine::showConsoleWindow"/>
6442	requests the console window to be activated and brought to
6443	foreground on the desktop of the host PC.
6444
6445	This notification should cause the VM console process to
6446	perform the requested action as described above. If it is
6447	impossible to do it at a time of this notification, this
6448	method should return a failure.
6449
6450	Note that many modern window managers on many platforms
6451	implement some sort of focus stealing prevention logic, so
6452	that it may be impossible to activate a window without the
6453	help of the currently active application (which is supposedly
6454	an initiator of this notification). In this case, this method
6455	must return a non-zero identifier that represents the
6456	top-level window of the VM console process. The caller, if it
6457	represents a currently active process, is responsible to use
6458	this identifier (in a platform-dependent manner) to perform
6459	actual window activation.
6460
6461	This method must set @a winId to zero if it has performed all
6462	actions necessary to complete the request and the console
6463	window is now active and in foreground, to indicate that no
6464	further action is required on the caller's side.
6465
6466	<note>
6467	This notification is not designed to be implemented by
6468	more than one callback at a time. If you have multiple
6469	IConsoleCallback instances registered on the given
6470	IConsole object, make sure you simply do nothing but
6471	return @c S_OK from all but one of them that actually
6472	manages console window activation.
6473	</note>
6474	</desc>
6475	<param name="winId" type="unsigned long long" dir="return">
6476	<desc>
6477	Platform-dependent identifier of the top-level VM console
6478	window, or zero if this method has performed all actions
6479	necessary to implement the <i>show window</i> semantics for
6480	the given platform and/or this VirtualBox front-end.
6481	</desc>
6482	</param>
6483	</method>
6484
6485	</interface>
6486
6487	<interface
6488	name="IRemoteDisplayInfo" extends="$unknown"
6489	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6490	wsmap="struct"
6491	>
6492	<desc>
6493	Contains information about the remote display (VRDP) capabilities and status.
6494	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6495	</desc>
6496
6497	<attribute name="active" type="boolean" readonly="yes">
6498	<desc>
6499	Whether the remote display connection is active.
6500	</desc>
6501	</attribute>
6502
6503	<attribute name="port" type="long" readonly="yes">
6504	<desc>
6505	VRDP server port number. If this property is equal to <tt>0</tt>, then
6506	the VRDP server failed to start, usually because there are no free TCP
6507	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6508	server has not yet been started.
6509	</desc>
6510	</attribute>
6511
6512	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6513	<desc>
6514	How many times a client connected.
6515	</desc>
6516	</attribute>
6517
6518	<attribute name="beginTime" type="long long" readonly="yes">
6519	<desc>
6520	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6521	</desc>
6522	</attribute>
6523
6524	<attribute name="endTime" type="long long" readonly="yes">
6525	<desc>
6526	When the last connection was terminated or the current time, if
6527	connection is still active, in milliseconds since 1970-01-01 UTC.
6528	</desc>
6529	</attribute>
6530
6531	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6532	<desc>
6533	How many bytes were sent in last or current, if still active, connection.
6534	</desc>
6535	</attribute>
6536
6537	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6538	<desc>
6539	How many bytes were sent in all connections.
6540	</desc>
6541	</attribute>
6542
6543	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6544	<desc>
6545	How many bytes were received in last or current, if still active, connection.
6546	</desc>
6547	</attribute>
6548
6549	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6550	<desc>
6551	How many bytes were received in all connections.
6552	</desc>
6553	</attribute>
6554
6555	<attribute name="user" type="wstring" readonly="yes">
6556	<desc>
6557	Login user name supplied by the client.
6558	</desc>
6559	</attribute>
6560
6561	<attribute name="domain" type="wstring" readonly="yes">
6562	<desc>
6563	Login domain name supplied by the client.
6564	</desc>
6565	</attribute>
6566
6567	<attribute name="clientName" type="wstring" readonly="yes">
6568	<desc>
6569	The client name supplied by the client.
6570	</desc>
6571	</attribute>
6572
6573	<attribute name="clientIP" type="wstring" readonly="yes">
6574	<desc>
6575	The IP address of the client.
6576	</desc>
6577	</attribute>
6578
6579	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6580	<desc>
6581	The client software version number.
6582	</desc>
6583	</attribute>
6584
6585	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6586	<desc>
6587	Public key exchange method used when connection was established.
6588	Values: 0 - RDP4 public key exchange scheme.
6589	1 - X509 certificates were sent to client.
6590	</desc>
6591	</attribute>
6592
6593	</interface>
6594
6595	<interface
6596	name="IConsole" extends="$unknown"
6597	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6598	wsmap="managed"
6599	>
6600	<desc>
6601	The IConsole interface represents an interface to control virtual
6602	machine execution.
6603
6604	The console object that implements the IConsole interface is obtained
6605	from a session object after the session for the given machine has been
6606	opened using one of <link to="IVirtualBox::openSession"/>,
6607	<link to="IVirtualBox::openRemoteSession"/> or
6608	<link to="IVirtualBox::openExistingSession"/> methods.
6609
6610	Methods of the IConsole interface allow the caller to query the current
6611	virtual machine execution state, pause the machine or power it down, save
6612	the machine state or take a snapshot, attach and detach removable media
6613	and so on.
6614
6615	<see>ISession</see>
6616	</desc>
6617
6618	<attribute name="machine" type="IMachine" readonly="yes">
6619	<desc>
6620	Machine object this console is sessioned with.
6621	<note>
6622	This is a convenience property, it has the same value as
6623	<link to="ISession::machine"/> of the corresponding session
6624	object.
6625	</note>
6626	</desc>
6627	</attribute>
6628
6629	<attribute name="state" type="MachineState" readonly="yes">
6630	<desc>
6631	Current execution state of the machine.
6632	<note>
6633	This property always returns the same value as the corresponding
6634	property of the IMachine object this console is sessioned with.
6635	For the process that owns (executes) the VM, this is the
6636	preferable way of querying the VM state, because no IPC
6637	calls are made.
6638	</note>
6639	</desc>
6640	</attribute>
6641
6642	<attribute name="guest" type="IGuest" readonly="yes">
6643	<desc>Guest object.</desc>
6644	</attribute>
6645
6646	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6647	<desc>
6648	Virtual keyboard object.
6649	<note>
6650	If the machine is not running, any attempt to use
6651	the returned object will result in an error.
6652	</note>
6653	</desc>
6654	</attribute>
6655
6656	<attribute name="mouse" type="IMouse" readonly="yes">
6657	<desc>
6658	Virtual mouse object.
6659	<note>
6660	If the machine is not running, any attempt to use
6661	the returned object will result in an error.
6662	</note>
6663	</desc>
6664	</attribute>
6665
6666	<attribute name="display" type="IDisplay" readonly="yes">
6667	<desc>Virtual display object.
6668	<note>
6669	If the machine is not running, any attempt to use
6670	the returned object will result in an error.
6671	</note>
6672	</desc>
6673	</attribute>
6674
6675	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6676	<desc>Debugging interface.</desc>
6677	</attribute>
6678
6679	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6680	<desc>
6681	Collection of USB devices currently attached to the virtual
6682	USB controller.
6683	<note>
6684	The collection is empty if the machine is not running.
6685	</note>
6686	</desc>
6687	</attribute>
6688
6689	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6690	<desc>
6691	List of USB devices currently attached to the remote VRDP client.
6692	Once a new device is physically attached to the remote host computer,
6693	it appears in this list and remains there until detached.
6694	</desc>
6695	</attribute>
6696
6697	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6698	<desc>
6699	Collection of shared folders for the current session. These folders
6700	are called transient shared folders because they are available to the
6701	guest OS running inside the associated virtual machine only for the
6702	duration of the session (as opposed to
6703	<link to="IMachine::sharedFolders"/> which represent permanent shared
6704	folders). When the session is closed (e.g. the machine is powered down),
6705	these folders are automatically discarded.
6706
6707	New shared folders are added to the collection using
6708	<link to="#createSharedFolder"/>. Existing shared folders can be
6709	removed using <link to="#removeSharedFolder"/>.
6710	</desc>
6711	</attribute>
6712
6713	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6714	<desc>
6715	Interface that provides information on Remote Display (VRDP) connection.
6716	</desc>
6717	</attribute>
6718
6719	<method name="powerUp">
6720	<desc>
6721	Starts the virtual machine execution using the current machine
6722	state (that is, its current execution state, current settings and
6723	current storage devices).
6724
6725	If the machine is powered off or aborted, the execution will
6726	start from the beginning (as if the real hardware were just
6727	powered on).
6728
6729	If the machine is in the <link to="MachineState_Saved"/> state,
6730	it will continue its execution the point where the state has
6731	been saved.
6732
6733	<note>
6734	Unless you are trying to write a new VirtualBox front-end that
6735	performs direct machine execution (like the VirtualBox or VBoxSDL
6736	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6737	session opened by <link to="IVirtualBox::openSession"/> and use this
6738	session only to change virtual machine settings. If you simply want to
6739	start virtual machine execution using one of the existing front-ends
6740	(for example the VirtualBox GUI or headless server), simply use
6741	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6742	power up the machine automatically for you.
6743	</note>
6744
6745	<see>#saveState</see>
6746	<result name="VBOX_E_INVALID_VM_STATE">
6747	Virtual machine already running.
6748	</result>
6749	<result name="VBOX_E_HOST_ERROR">
6750	Host interface does not exist or name not set.
6751	</result>
6752	<result name="VBOX_E_FILE_ERROR">
6753	Invalid saved state file.
6754	</result>
6755	</desc>
6756	<param name="progress" type="IProgress" dir="return">
6757	<desc>Progress object to track the operation completion.</desc>
6758	</param>
6759	</method>
6760
6761	<method name="powerUpPaused">
6762	<desc>
6763	Identical to powerUp except that the VM will enter the
6764	<link to="MachineState_Paused"/> state, instead of
6765	<link to="MachineState_Running"/>.
6766
6767	<see>#powerUp</see>
6768	<result name="VBOX_E_INVALID_VM_STATE">
6769	Virtual machine already running.
6770	</result>
6771	<result name="VBOX_E_HOST_ERROR">
6772	Host interface does not exist or name not set.
6773	</result>
6774	<result name="VBOX_E_FILE_ERROR">
6775	Invalid saved state file.
6776	</result>
6777	</desc>
6778	<param name="progress" type="IProgress" dir="return">
6779	<desc>Progress object to track the operation completion.</desc>
6780	</param>
6781	</method>
6782
6783	<method name="powerDown">
6784	<desc>
6785	Initiates the power down procedure to stop the virtual machine
6786	execution.
6787
6788	The completion of the power down procedure is tracked using the returned
6789	IProgress object. After the operation is complete, the machine will go
6790	to the PoweredOff state.
6791	<result name="VBOX_E_INVALID_VM_STATE">
6792	Virtual machine must be Running, Paused or Stuck to be powered down.
6793	</result>
6794	</desc>
6795	<param name="progress" type="IProgress" dir="return">
6796	<desc>Progress object to track the operation completion.</desc>
6797	</param>
6798	</method>
6799
6800	<method name="reset">
6801	<desc>Resets the virtual machine.
6802	<result name="VBOX_E_INVALID_VM_STATE">
6803	Virtual machine not in Running state.
6804	</result>
6805	<result name="VBOX_E_VM_ERROR">
6806	Virtual machine error in reset operation.
6807	</result>
6808	</desc>
6809	</method>
6810
6811	<method name="pause">
6812	<desc>Pauses the virtual machine execution.
6813	<result name="VBOX_E_INVALID_VM_STATE">
6814	Virtual machine not in Running state.
6815	</result>
6816	<result name="VBOX_E_VM_ERROR">
6817	Virtual machine error in suspend operation.
6818	</result>
6819	</desc>
6820	</method>
6821
6822	<method name="resume">
6823	<desc>Resumes the virtual machine execution.
6824	<result name="VBOX_E_INVALID_VM_STATE">
6825	Virtual machine not in Paused state.
6826	</result>
6827	<result name="VBOX_E_VM_ERROR">
6828	Virtual machine error in resume operation.
6829	</result>
6830	</desc>
6831	</method>
6832
6833	<method name="powerButton">
6834	<desc>Sends the ACPI power button event to the guest.
6835	<result name="VBOX_E_INVALID_VM_STATE">
6836	Virtual machine not in Running state.
6837	</result>
6838	<result name="VBOX_E_PDM_ERROR">
6839	Controlled power off failed.
6840	</result>
6841	</desc>
6842	</method>
6843
6844	<method name="sleepButton">
6845	<desc>Sends the ACPI sleep button event to the guest.
6846	<result name="VBOX_E_INVALID_VM_STATE">
6847	Virtual machine not in Running state.
6848	</result>
6849	<result name="VBOX_E_PDM_ERROR">
6850	Sending sleep button event failed.
6851	</result>
6852	</desc>
6853	</method>
6854
6855	<method name="getPowerButtonHandled">
6856	<desc>Checks if the last power button event was handled by guest.
6857	<result name="VBOX_E_PDM_ERROR">
6858	Checking if the event was handled by the guest OS failed.
6859	</result>
6860	</desc>
6861	<param name="handled" type="boolean" dir="return"/>
6862	</method>
6863
6864	<method name="getGuestEnteredACPIMode">
6865	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6866	G1 (sleeping). If this method returns @c false, the guest will
6867	most likely not respond to external ACPI events.
6868	<result name="VBOX_E_INVALID_VM_STATE">
6869	Virtual machine not in Running state.
6870	</result>
6871	</desc>
6872	<param name="entered" type="boolean" dir="return"/>
6873	</method>
6874
6875	<method name="saveState">
6876	<desc>
6877	Saves the current execution state of a running virtual machine
6878	and stops its execution.
6879
6880	After this operation completes, the machine will go to the
6881	Saved state. Next time it is powered up, this state will
6882	be restored and the machine will continue its execution from
6883	the place where it was saved.
6884
6885	This operation differs from taking a snapshot to the effect
6886	that it doesn't create new differencing media. Also, once
6887	the machine is powered up from the state saved using this method,
6888	the saved state is deleted, so it will be impossible to return
6889	to this state later.
6890
6891	<note>
6892	On success, this method implicitly calls
6893	<link to="IMachine::saveSettings"/> to save all current machine
6894	settings (including runtime changes to the DVD medium, etc.).
6895	Together with the impossibility to change any VM settings when it is
6896	in the Saved state, this guarantees adequate hardware
6897	configuration of the machine when it is restored from the saved
6898	state file.
6899	</note>
6900
6901	<note>
6902	The machine must be in the Running or Paused state, otherwise
6903	the operation will fail.
6904	</note>
6905	<result name="VBOX_E_INVALID_VM_STATE">
6906	Virtual machine state neither Running nor Paused.
6907	</result>
6908	<result name="VBOX_E_FILE_ERROR">
6909	Failed to create directory for saved state file.
6910	</result>
6911
6912	<see><link to="#takeSnapshot"/></see>
6913	</desc>
6914	<param name="progress" type="IProgress" dir="return">
6915	<desc>Progress object to track the operation completion.</desc>
6916	</param>
6917	</method>
6918
6919	<method name="adoptSavedState">
6920	<desc>
6921	Associates the given saved state file to the virtual machine.
6922
6923	On success, the machine will go to the Saved state. Next time it is
6924	powered up, it will be restored from the adopted saved state and
6925	continue execution from the place where the saved state file was
6926	created.
6927
6928	The specified saved state file path may be absolute or relative to the
6929	folder the VM normally saves the state to (usually,
6930	<link to="IMachine::snapshotFolder"/>).
6931
6932	<note>
6933	It's a caller's responsibility to make sure the given saved state
6934	file is compatible with the settings of this virtual machine that
6935	represent its virtual hardware (memory size, storage disk configuration
6936	etc.). If there is a mismatch, the behavior of the virtual machine
6937	is undefined.
6938	</note>
6939	<result name="VBOX_E_INVALID_VM_STATE">
6940	Virtual machine state neither PoweredOff nor Aborted.
6941	</result>
6942	</desc>
6943	<param name="savedStateFile" type="wstring" dir="in">
6944	<desc>Path to the saved state file to adopt.</desc>
6945	</param>
6946	</method>
6947
6948	<method name="forgetSavedState">
6949	<desc>
6950	Forgets the saved state of the virtual machine previously created
6951	by <link to="#saveState"/>. Next time the machine is powered up, a
6952	clean boot will occur. If @a remove is @c true the saved state file
6953	is deleted.
6954	<note>
6955	This operation is equivalent to resetting or powering off
6956	the machine without doing a proper shutdown in the guest OS.
6957	</note>
6958	<result name="VBOX_E_INVALID_VM_STATE">
6959	Virtual machine not in state Saved.
6960	</result>
6961	</desc>
6962	<param name="remove" type="boolean" dir="in">
6963	<desc>If @c true remove the saved state file.</desc>
6964	</param>
6965	</method>
6966
6967	<method name="getDeviceActivity">
6968	<desc>
6969	Gets the current activity type of a given device or device group.
6970	<result name="E_INVALIDARG">
6971	Invalid device type.
6972	</result>
6973	</desc>
6974	<param name="type" type="DeviceType" dir="in"/>
6975	<param name="activity" type="DeviceActivity" dir="return"/>
6976	</method>
6977
6978	<method name="attachUSBDevice">
6979	<desc>
6980	Attaches a host USB device with the given UUID to the
6981	USB controller of the virtual machine.
6982
6983	The device needs to be in one of the following states:
6984	<link to="USBDeviceState_Busy"/>,
6985	<link to="USBDeviceState_Available"/> or
6986	<link to="USBDeviceState_Held"/>,
6987	otherwise an error is immediately returned.
6988
6989	When the device state is
6990	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6991	be returned if the host computer refuses to release it for some reason.
6992
6993	<see>IUSBController::deviceFilters, USBDeviceState</see>
6994	<result name="VBOX_E_INVALID_VM_STATE">
6995	Virtual machine state neither Running nor Paused.
6996	</result>
6997	<result name="VBOX_E_PDM_ERROR">
6998	Virtual machine does not have a USB controller.
6999	</result>
7000	</desc>
7001	<param name="id" type="uuid" mod="string" dir="in">
7002	<desc>UUID of the host USB device to attach.</desc>
7003	</param>
7004	</method>
7005
7006	<method name="detachUSBDevice">
7007	<desc>
7008	Detaches an USB device with the given UUID from the USB controller
7009	of the virtual machine.
7010
7011	After this method succeeds, the VirtualBox server re-initiates
7012	all USB filters as if the device were just physically attached
7013	to the host, but filters of this machine are ignored to avoid
7014	a possible automatic re-attachment.
7015
7016	<see>IUSBController::deviceFilters, USBDeviceState</see>
7017
7018	<result name="VBOX_E_PDM_ERROR">
7019	Virtual machine does not have a USB controller.
7020	</result>
7021	<result name="E_INVALIDARG">
7022	USB device not attached to this virtual machine.
7023	</result>
7024	</desc>
7025	<param name="id" type="uuid" mod="string" dir="in">
7026	<desc>UUID of the USB device to detach.</desc>
7027	</param>
7028	<param name="device" type="IUSBDevice" dir="return">
7029	<desc>Detached USB device.</desc>
7030	</param>
7031	</method>
7032
7033	<method name="findUSBDeviceByAddress">
7034	<desc>
7035	Searches for a USB device with the given host address.
7036
7037	<result name="VBOX_E_OBJECT_NOT_FOUND">
7038	Given @c name does not correspond to any USB device.
7039	</result>
7040
7041	<see>IUSBDevice::address</see>
7042	</desc>
7043	<param name="name" type="wstring" dir="in">
7044	<desc>
7045	Address of the USB device (as assigned by the host) to
7046	search for.
7047	</desc>
7048	</param>
7049	<param name="device" type="IUSBDevice" dir="return">
7050	<desc>Found USB device object.</desc>
7051	</param>
7052	</method>
7053
7054	<method name="findUSBDeviceById">
7055	<desc>
7056	Searches for a USB device with the given UUID.
7057
7058	<result name="VBOX_E_OBJECT_NOT_FOUND">
7059	Given @c id does not correspond to any USB device.
7060	</result>
7061
7062	<see>IUSBDevice::id</see>
7063	</desc>
7064	<param name="id" type="uuid" mod="string" dir="in">
7065	<desc>UUID of the USB device to search for.</desc>
7066	</param>
7067	<param name="device" type="IUSBDevice" dir="return">
7068	<desc>Found USB device object.</desc>
7069	</param>
7070	</method>
7071
7072	<method name="createSharedFolder">
7073	<desc>
7074	Creates a transient new shared folder by associating the given logical
7075	name with the given host path, adds it to the collection of shared
7076	folders and starts sharing it. Refer to the description of
7077	<link to="ISharedFolder"/> to read more about logical names.
7078
7079	<result name="VBOX_E_INVALID_VM_STATE">
7080	Virtual machine in Saved state or currently changing state.
7081	</result>
7082	<result name="VBOX_E_FILE_ERROR">
7083	Shared folder already exists or not accessible.
7084	</result>
7085	</desc>
7086	<param name="name" type="wstring" dir="in">
7087	<desc>Unique logical name of the shared folder.</desc>
7088	</param>
7089	<param name="hostPath" type="wstring" dir="in">
7090	<desc>Full path to the shared folder in the host file system.</desc>
7091	</param>
7092	<param name="writable" type="boolean" dir="in">
7093	<desc>Whether the share is writable or readonly</desc>
7094	</param>
7095	</method>
7096
7097	<method name="removeSharedFolder">
7098	<desc>
7099	Removes a transient shared folder with the given name previously
7100	created by <link to="#createSharedFolder"/> from the collection of
7101	shared folders and stops sharing it.
7102	<result name="VBOX_E_INVALID_VM_STATE">
7103	Virtual machine in Saved state or currently changing state.
7104	</result>
7105	<result name="VBOX_E_FILE_ERROR">
7106	Shared folder does not exists.
7107	</result>
7108	</desc>
7109	<param name="name" type="wstring" dir="in">
7110	<desc>Logical name of the shared folder to remove.</desc>
7111	</param>
7112	</method>
7113
7114	<method name="takeSnapshot">
7115	<desc>
7116	Saves the current execution state
7117	and all settings of the machine and creates differencing images
7118	for all normal (non-independent) media.
7119	See <link to="ISnapshot" /> for an introduction to snapshots.
7120
7121	This method can be called for a PoweredOff, Saved (see
7122	<link to="#saveState"/>), Running or
7123	Paused virtual machine. When the machine is PoweredOff, an
7124	offline snapshot is created. When the machine is Running a live
7125	snapshot is created, and an online snapshot is is created when Paused.
7126
7127	The taken snapshot is always based on the
7128	<link to="IMachine::currentSnapshot">current snapshot</link>
7129	of the associated virtual machine and becomes a new current snapshot.
7130
7131	<note>
7132	This method implicitly calls <link to="IMachine::saveSettings"/> to
7133	save all current machine settings before taking an offline snapshot.
7134	</note>
7135
7136	<result name="VBOX_E_INVALID_VM_STATE">
7137	Virtual machine currently changing state.
7138	</result>
7139	</desc>
7140	<param name="name" type="wstring" dir="in">
7141	<desc>Short name for the snapshot.</desc>
7142	</param>
7143	<param name="description" type="wstring" dir="in">
7144	<desc>Optional description of the snapshot.</desc>
7145	</param>
7146	<param name="progress" type="IProgress" dir="return">
7147	<desc>Progress object to track the operation completion.</desc>
7148	</param>
7149	</method>
7150
7151	<method name="deleteSnapshot">
7152	<desc>
7153	Starts deleting the specified snapshot asynchronously.
7154	See <link to="ISnapshot" /> for an introduction to snapshots.
7155
7156	The execution state and settings of the associated machine stored in
7157	the snapshot will be deleted. The contents of all differencing media of
7158	this snapshot will be merged with the contents of their dependent child
7159	media to keep the medium chain valid (in other words, all changes
7160	represented by media being discarded will be propagated to their child
7161	medium). After that, this snapshot's differencing medium will be
7162	deleted. The parent of this snapshot will become a new parent for all
7163	its child snapshots.
7164
7165	If the deleted snapshot is the current one, its parent snapshot will
7166	become a new current snapshot. The current machine state is not directly
7167	affected in this case, except that currently attached differencing
7168	media based on media of the discarded snapshot will be also merged as
7169	described above.
7170
7171	If the deleted snapshot is the first or current snapshot, then the
7172	respective IMachine attributes will be adjusted. Deleting the current
7173	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7174	to make all current machine settings permanent.
7175
7176	Deleting a snapshot has the following preconditions:
7177
7178	<ul>
7179	<li>Child media of all normal media of the discarded snapshot
7180	must be accessible (see <link to="IMedium::state"/>) for this
7181	operation to succeed. In particular, this means that all virtual
7182	machines, whose media are directly or indirectly based on the
7183	media of discarded snapshot, must be powered off.</li>
7184
7185	<li>You cannot delete the snapshot if a medium attached to it has
7186	more than once child medium (differencing images) because otherwise
7187	merging would be impossible. This might be the case if there is
7188	more than one child snapshot or differencing images were created
7189	for other reason (e.g. implicitly because of multiple machine
7190	attachments).</li>
7191	</ul>
7192
7193
7194	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7195	while this operation is in progress.
7196
7197	<note>
7198	Merging medium contents can be very time and disk space
7199	consuming, if these media are big in size and have many
7200	children. However, if the snapshot being discarded is the last
7201	(head) snapshot on the branch, the operation will be rather
7202	quick.
7203	</note>
7204	<result name="VBOX_E_INVALID_VM_STATE">
7205	Virtual machine is running.
7206	</result>
7207	</desc>
7208	<param name="id" type="uuid" mod="string" dir="in">
7209	<desc>UUID of the snapshot to discard.</desc>
7210	</param>
7211	<param name="progress" type="IProgress" dir="return">
7212	<desc>Progress object to track the operation completion.</desc>
7213	</param>
7214	</method>
7215
7216	<method name="restoreSnapshot">
7217	<desc>
7218	Starts resetting the machine's current state to the state contained
7219	in the given snapshot, asynchronously. All current settings of the
7220	machine will be reset and changes stored in differencing media
7221	will be lost.
7222	See <link to="ISnapshot" /> for an introduction to snapshots.
7223
7224	After this operation is successfully completed, new empty differencing
7225	media are created for all normal media of the machine.
7226
7227	If the given snapshot is an online snapshot, the machine will go to
7228	the <link to="MachineState_Saved"> saved state</link>, so that the
7229	next time it is powered on, the execution state will be restored
7230	from the state of the snapshot.
7231
7232	<note>
7233	The machine must not be running, otherwise the operation will fail.
7234	</note>
7235
7236	<note>
7237	If the machine state is <link to="MachineState_Saved">Saved</link>
7238	prior to this operation, the saved state file will be implicitly
7239	discarded (as if <link to="IConsole::forgetSavedState"/> were
7240	called).
7241	</note>
7242
7243	<result name="VBOX_E_INVALID_VM_STATE">
7244	Virtual machine is running.
7245	</result>
7246	</desc>
7247	<param name="snapshot" type="ISnapshot" dir="in">
7248	<desc>The snapshot to restore the VM state from.</desc>
7249	</param>
7250	<param name="progress" type="IProgress" dir="return">
7251	<desc>Progress object to track the operation completion.</desc>
7252	</param>
7253	</method>
7254
7255	<method name="teleport">
7256	<desc>
7257	Teleport the VM to a different host machine or process.
7258
7259	TODO explain the details.
7260
7261	<result name="VBOX_E_INVALID_VM_STATE">
7262	Virtual machine not running or paused.
7263	</result>
7264	</desc>
7265	<param name="hostname" type="wstring" dir="in">
7266	<desc>The name or IP of the host to teleport to.</desc>
7267	</param>
7268	<param name="tcpport" type="unsigned long" dir="in">
7269	<desc>The TCP port to connect to (1..65535).</desc>
7270	</param>
7271	<param name="password" type="wstring" dir="in">
7272	<desc>The password.</desc>
7273	</param>
7274	<param name="maxDowntime" type="unsigned long" dir="in">
7275	<desc>
7276	The maximum allowed downtime given as milliseconds. 0 is not a valid
7277	value. Recommended value: 250 ms.
7278
7279	The higher the value is, the greater the chance for a successful
7280	teleportation. A small value may easily result in the teleportation
7281	process taking hours and eventually fail.
7282
7283	<note>
7284	The current implementation treats this a guideline, not as an
7285	absolute rule.
7286	</note>
7287	</desc>
7288	</param>
7289	<param name="progress" type="IProgress" dir="return">
7290	<desc>Progress object to track the operation completion.</desc>
7291	</param>
7292	</method>
7293
7294	<method name="registerCallback">
7295	<desc>
7296	Registers a new console callback on this instance. The methods of the
7297	callback interface will be called by this instance when the appropriate
7298	event occurs.
7299	</desc>
7300	<param name="callback" type="IConsoleCallback" dir="in"/>
7301	</method>
7302
7303	<method name="unregisterCallback">
7304	<desc>
7305	Unregisters the console callback previously registered using
7306	<link to="#registerCallback"/>.
7307	<result name="E_INVALIDARG">
7308	Given @a callback handler is not registered.
7309	</result>
7310	</desc>
7311	<param name="callback" type="IConsoleCallback" dir="in"/>
7312	</method>
7313	</interface>
7314
7315	<!--
7316	// IHost
7317	/////////////////////////////////////////////////////////////////////////
7318	-->
7319
7320	<enum
7321	name="HostNetworkInterfaceMediumType"
7322	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7323	>
7324	<desc>
7325	Type of encapsulation. Ethernet encapsulation includes both wired and
7326	wireless Ethernet connections.
7327	<see>IHostNetworkInterface</see>
7328	</desc>
7329
7330	<const name="Unknown" value="0">
7331	<desc>
7332	The type of interface cannot be determined.
7333	</desc>
7334	</const>
7335	<const name="Ethernet" value="1">
7336	<desc>
7337	Ethernet frame encapsulation.
7338	</desc>
7339	</const>
7340	<const name="PPP" value="2">
7341	<desc>
7342	Point-to-point protocol encapsulation.
7343	</desc>
7344	</const>
7345	<const name="SLIP" value="3">
7346	<desc>
7347	Serial line IP encapsulation.
7348	</desc>
7349	</const>
7350	</enum>
7351
7352	<enum
7353	name="HostNetworkInterfaceStatus"
7354	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7355	>
7356	<desc>
7357	Current status of the interface.
7358	<see>IHostNetworkInterface</see>
7359	</desc>
7360
7361	<const name="Unknown" value="0">
7362	<desc>
7363	The state of interface cannot be determined.
7364	</desc>
7365	</const>
7366	<const name="Up" value="1">
7367	<desc>
7368	The interface is fully operational.
7369	</desc>
7370	</const>
7371	<const name="Down" value="2">
7372	<desc>
7373	The interface is not functioning.
7374	</desc>
7375	</const>
7376	</enum>
7377
7378	<enum
7379	name="HostNetworkInterfaceType"
7380	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7381	>
7382	<desc>
7383	Network interface type.
7384	</desc>
7385	<const name="Bridged" value="1"/>
7386	<const name="HostOnly" value="2"/>
7387	</enum>
7388
7389	<interface
7390	name="IHostNetworkInterface" extends="$unknown"
7391	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7392	wsmap="managed"
7393	>
7394	<desc>
7395	Represents one of host's network interfaces. IP V6 address and network
7396	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7397	separated by colons.
7398	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7399	</desc>
7400	<attribute name="name" type="wstring" readonly="yes">
7401	<desc>Returns the host network interface name.</desc>
7402	</attribute>
7403
7404	<attribute name="id" type="uuid" mod="string" readonly="yes">
7405	<desc>Returns the interface UUID.</desc>
7406	</attribute>
7407
7408	<attribute name="networkName" type="wstring" readonly="yes">
7409	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7410	</attribute>
7411
7412	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7413	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7414	</attribute>
7415
7416	<attribute name="IPAddress" type="wstring" readonly="yes">
7417	<desc>Returns the IP V4 address of the interface.</desc>
7418	</attribute>
7419
7420	<attribute name="networkMask" type="wstring" readonly="yes">
7421	<desc>Returns the network mask of the interface.</desc>
7422	</attribute>
7423
7424	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7425	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7426	</attribute>
7427
7428	<attribute name="IPV6Address" type="wstring" readonly="yes">
7429	<desc>Returns the IP V6 address of the interface.</desc>
7430	</attribute>
7431
7432	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7433	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7434	</attribute>
7435
7436	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7437	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7438	</attribute>
7439
7440	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7441	<desc>Type of protocol encapsulation used.</desc>
7442	</attribute>
7443
7444	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7445	<desc>Status of the interface.</desc>
7446	</attribute>
7447
7448	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7449	<desc>specifies the host interface type.</desc>
7450	</attribute>
7451
7452	<method name="enableStaticIpConfig">
7453	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7454	<param name="IPAddress" type="wstring" dir="in">
7455	<desc>
7456	IP address.
7457	</desc>
7458	</param>
7459	<param name="networkMask" type="wstring" dir="in">
7460	<desc>
7461	network mask.
7462	</desc>
7463	</param>
7464	</method>
7465
7466	<method name="enableStaticIpConfigV6">
7467	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7468	<param name="IPV6Address" type="wstring" dir="in">
7469	<desc>
7470	IP address.
7471	</desc>
7472	</param>
7473	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7474	<desc>
7475	network mask.
7476	</desc>
7477	</param>
7478	</method>
7479
7480	<method name="enableDynamicIpConfig">
7481	<desc>enables the dynamic IP configuration.</desc>
7482	</method>
7483
7484	<method name="dhcpRediscover">
7485	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7486	</method>
7487
7488	</interface>
7489
7490	<interface
7491	name="IHost" extends="$unknown"
7492	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7493	wsmap="managed"
7494	>
7495	<desc>
7496	The IHost interface represents the physical machine that this VirtualBox
7497	installation runs on.
7498
7499	An object implementing this interface is returned by the
7500	<link to="IVirtualBox::host" /> attribute. This interface contains
7501	read-only information about the host's physical hardware (such as what
7502	processors and disks are available, what the host operating system is,
7503	and so on) and also allows for manipulating some of the host's hardware,
7504	such as global USB device filters and host interface networking.
7505
7506	</desc>
7507	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7508	<desc>List of DVD drives available on the host.</desc>
7509	</attribute>
7510
7511	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7512	<desc>List of floppy drives available on the host.</desc>
7513	</attribute>
7514
7515	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7516	<desc>
7517	List of USB devices currently attached to the host.
7518	Once a new device is physically attached to the host computer,
7519	it appears in this list and remains there until detached.
7520
7521	<note>
7522	If USB functionality is not available in the given edition of
7523	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7524	</note>
7525	</desc>
7526	</attribute>
7527
7528	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7529	<desc>
7530	List of USB device filters in action.
7531	When a new device is physically attached to the host computer,
7532	filters from this list are applied to it (in order they are stored
7533	in the list). The first matched filter will determine the
7534	<link to="IHostUSBDeviceFilter::action">action</link>
7535	performed on the device.
7536
7537	Unless the device is ignored by these filters, filters of all
7538	currently running virtual machines
7539	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7540
7541	<note>
7542	If USB functionality is not available in the given edition of
7543	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7544	</note>
7545
7546	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7547	</desc>
7548	</attribute>
7549
7550	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7551	<desc>List of host network interfaces currently defined on the host.</desc>
7552	</attribute>
7553
7554	<attribute name="processorCount" type="unsigned long" readonly="yes">
7555	<desc>Number of (logical) CPUs installed in the host system.</desc>
7556	</attribute>
7557
7558	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7559	<desc>Number of (logical) CPUs online in the host system.</desc>
7560	</attribute>
7561
7562	<method name="getProcessorSpeed">
7563	<desc>Query the (approximate) maximum speed of a specified host CPU in
7564	Megahertz.
7565	</desc>
7566	<param name="cpuId" type="unsigned long" dir="in">
7567	<desc>
7568	Identifier of the CPU.
7569	</desc>
7570	</param>
7571	<param name="speed" type="unsigned long" dir="return">
7572	<desc>
7573	Speed value. 0 is returned if value is not known or @a cpuId is
7574	invalid.
7575	</desc>
7576	</param>
7577	</method>
7578
7579	<method name="getProcessorFeature">
7580	<desc>Query whether a CPU feature is supported or not.</desc>
7581	<param name="feature" type="ProcessorFeature" dir="in">
7582	<desc>
7583	CPU Feature identifier.
7584	</desc>
7585	</param>
7586	<param name="supported" type="boolean" dir="return">
7587	<desc>
7588	Feature is supported or not.
7589	</desc>
7590	</param>
7591	</method>
7592
7593	<method name="getProcessorDescription">
7594	<desc>Query the model string of a specified host CPU.
7595	</desc>
7596	<param name="cpuId" type="unsigned long" dir="in">
7597	<desc>
7598	Identifier of the CPU.
7599	<note>
7600	The current implementation might not necessarily return the
7601	description for this exact CPU.
7602	</note>
7603	</desc>
7604	</param>
7605	<param name="description" type="wstring" dir="return">
7606	<desc>
7607	Model string. An empty string is returned if value is not known or
7608	@a cpuId is invalid.
7609	</desc>
7610	</param>
7611	</method>
7612
7613	<method name="getProcessorCpuIdLeaf">
7614	<desc>
7615	Returns the CPU cpuid information for the specified leaf.
7616	</desc>
7617	<param name="cpuId" type="unsigned long" dir="in">
7618	<desc>
7619	Identifier of the CPU. The CPU most be online.
7620	<note>
7621	The current implementation might not necessarily return the
7622	description for this exact CPU.
7623	</note>
7624	</desc>
7625	</param>
7626	<param name="leaf" type="unsigned long" dir="in">
7627	<desc>
7628	Cpuid leaf index (eax).
7629	</desc>
7630	</param>
7631	<param name="subLeaf" type="unsigned long" dir="in">
7632	<desc>
7633	Cpuid leaf sub index (ecx). This currently only applies to cache
7634	information on Intel CPUs. Use 0 if retriving values for
7635	<link to="IMachine::setCpuIdLeaf"/>.
7636	</desc>
7637	</param>
7638	<param name="valEax" type="unsigned long" dir="out">
7639	<desc>
7640	Cpuid leaf value for register eax.
7641	</desc>
7642	</param>
7643	<param name="valEbx" type="unsigned long" dir="out">
7644	<desc>
7645	Cpuid leaf value for register ebx.
7646	</desc>
7647	</param>
7648	<param name="valEcx" type="unsigned long" dir="out">
7649	<desc>
7650	Cpuid leaf value for register ecx.
7651	</desc>
7652	</param>
7653	<param name="valEdx" type="unsigned long" dir="out">
7654	<desc>
7655	Cpuid leaf value for register edx.
7656	</desc>
7657	</param>
7658	</method>
7659
7660	<attribute name="memorySize" type="unsigned long" readonly="yes">
7661	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7662	</attribute>
7663
7664	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7665	<desc>Available system memory in the host system.</desc>
7666	</attribute>
7667
7668	<attribute name="operatingSystem" type="wstring" readonly="yes">
7669	<desc>Name of the host system's operating system.</desc>
7670	</attribute>
7671
7672	<attribute name="OSVersion" type="wstring" readonly="yes">
7673	<desc>Host operating system's version string.</desc>
7674	</attribute>
7675
7676	<attribute name="UTCTime" type="long long" readonly="yes">
7677	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7678	</attribute>
7679
7680	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7681	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7682	</attribute>
7683
7684	<method name="createHostOnlyNetworkInterface">
7685	<desc>
7686	Creates a new adapter for Host Only Networking.
7687	<result name="E_INVALIDARG">
7688	Host network interface @a name already exists.
7689	</result>
7690	</desc>
7691	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7692	<desc>
7693	Created host interface object.
7694	</desc>
7695	</param>
7696	<param name="progress" type="IProgress" dir="return">
7697	<desc>
7698	Progress object to track the operation completion.
7699	</desc>
7700	</param>
7701	</method>
7702
7703	<method name="removeHostOnlyNetworkInterface">
7704	<desc>
7705	Removes the given Host Only Networking interface.
7706	<result name="VBOX_E_OBJECT_NOT_FOUND">
7707	No host network interface matching @a id found.
7708	</result>
7709	</desc>
7710	<param name="id" type="uuid" mod="string" dir="in">
7711	<desc>
7712	Adapter GUID.
7713	</desc>
7714	</param>
7715	<param name="progress" type="IProgress" dir="return">
7716	<desc>
7717	Progress object to track the operation completion.
7718	</desc>
7719	</param>
7720	</method>
7721
7722	<method name="createUSBDeviceFilter">
7723	<desc>
7724	Creates a new USB device filter. All attributes except
7725	the filter name are set to empty (any match),
7726	<i>active</i> is @c false (the filter is not active).
7727
7728	The created filter can be added to the list of filters using
7729	<link to="#insertUSBDeviceFilter"/>.
7730
7731	<see>#USBDeviceFilters</see>
7732	</desc>
7733	<param name="name" type="wstring" dir="in">
7734	<desc>
7735	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7736	for more info.
7737	</desc>
7738	</param>
7739	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7740	<desc>Created filter object.</desc>
7741	</param>
7742	</method>
7743
7744	<method name="insertUSBDeviceFilter">
7745	<desc>
7746	Inserts the given USB device to the specified position
7747	in the list of filters.
7748
7749	Positions are numbered starting from @c 0. If the specified
7750	position is equal to or greater than the number of elements in
7751	the list, the filter is added at the end of the collection.
7752
7753	<note>
7754	Duplicates are not allowed, so an attempt to insert a
7755	filter already in the list is an error.
7756	</note>
7757	<note>
7758	If USB functionality is not available in the given edition of
7759	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7760	</note>
7761
7762	<see>#USBDeviceFilters</see>
7763
7764	<result name="VBOX_E_INVALID_OBJECT_STATE">
7765	USB device filter is not created within this VirtualBox instance.
7766	</result>
7767	<result name="E_INVALIDARG">
7768	USB device filter already in list.
7769	</result>
7770
7771	</desc>
7772	<param name="position" type="unsigned long" dir="in">
7773	<desc>Position to insert the filter to.</desc>
7774	</param>
7775	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7776	<desc>USB device filter to insert.</desc>
7777	</param>
7778	</method>
7779
7780	<method name="removeUSBDeviceFilter">
7781	<desc>
7782	Removes a USB device filter from the specified position in the
7783	list of filters.
7784
7785	Positions are numbered starting from @c 0. Specifying a
7786	position equal to or greater than the number of elements in
7787	the list will produce an error.
7788
7789	<note>
7790	If USB functionality is not available in the given edition of
7791	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7792	</note>
7793
7794	<see>#USBDeviceFilters</see>
7795
7796	<result name="E_INVALIDARG">
7797	USB device filter list empty or invalid @a position.
7798	</result>
7799
7800	</desc>
7801	<param name="position" type="unsigned long" dir="in">
7802	<desc>Position to remove the filter from.</desc>
7803	</param>
7804	</method>
7805
7806	<method name="findHostDVDDrive">
7807	<desc>
7808	Searches for a host DVD drive with the given @c name.
7809
7810	<result name="VBOX_E_OBJECT_NOT_FOUND">
7811	Given @c name does not correspond to any host drive.
7812	</result>
7813
7814	</desc>
7815	<param name="name" type="wstring" dir="in">
7816	<desc>Name of the host drive to search for</desc>
7817	</param>
7818	<param name="drive" type="IMedium" dir="return">
7819	<desc>Found host drive object</desc>
7820	</param>
7821	</method>
7822
7823	<method name="findHostFloppyDrive">
7824	<desc>
7825	Searches for a host floppy drive with the given @c name.
7826
7827	<result name="VBOX_E_OBJECT_NOT_FOUND">
7828	Given @c name does not correspond to any host floppy drive.
7829	</result>
7830
7831	</desc>
7832	<param name="name" type="wstring" dir="in">
7833	<desc>Name of the host floppy drive to search for</desc>
7834	</param>
7835	<param name="drive" type="IMedium" dir="return">
7836	<desc>Found host floppy drive object</desc>
7837	</param>
7838	</method>
7839
7840	<method name="findHostNetworkInterfaceByName">
7841	<desc>
7842	Searches through all host network interfaces for an interface with
7843	the given @c name.
7844	<note>
7845	The method returns an error if the given @c name does not
7846	correspond to any host network interface.
7847	</note>
7848	</desc>
7849	<param name="name" type="wstring" dir="in">
7850	<desc>Name of the host network interface to search for.</desc>
7851	</param>
7852	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7853	<desc>Found host network interface object.</desc>
7854	</param>
7855	</method>
7856	<method name="findHostNetworkInterfaceById">
7857	<desc>
7858	Searches through all host network interfaces for an interface with
7859	the given GUID.
7860	<note>
7861	The method returns an error if the given GUID does not
7862	correspond to any host network interface.
7863	</note>
7864	</desc>
7865	<param name="id" type="uuid" mod="string" dir="in">
7866	<desc>GUID of the host network interface to search for.</desc>
7867	</param>
7868	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7869	<desc>Found host network interface object.</desc>
7870	</param>
7871	</method>
7872	<method name="findHostNetworkInterfacesOfType">
7873	<desc>
7874	Searches through all host network interfaces and returns a list of interfaces of the specified type
7875	</desc>
7876	<param name="type" type="HostNetworkInterfaceType" dir="in">
7877	<desc>type of the host network interfaces to search for.</desc>
7878	</param>
7879	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7880	<desc>Found host network interface objects.</desc>
7881	</param>
7882	</method>
7883
7884	<method name="findUSBDeviceById">
7885	<desc>
7886	Searches for a USB device with the given UUID.
7887
7888	<result name="VBOX_E_OBJECT_NOT_FOUND">
7889	Given @c id does not correspond to any USB device.
7890	</result>
7891
7892	<see>IHostUSBDevice::id</see>
7893	</desc>
7894	<param name="id" type="uuid" mod="string" dir="in">
7895	<desc>UUID of the USB device to search for.</desc>
7896	</param>
7897	<param name="device" type="IHostUSBDevice" dir="return">
7898	<desc>Found USB device object.</desc>
7899	</param>
7900	</method>
7901
7902	<method name="findUSBDeviceByAddress">
7903	<desc>
7904	Searches for a USB device with the given host address.
7905
7906	<result name="VBOX_E_OBJECT_NOT_FOUND">
7907	Given @c name does not correspond to any USB device.
7908	</result>
7909
7910	<see>IHostUSBDevice::address</see>
7911	</desc>
7912	<param name="name" type="wstring" dir="in">
7913	<desc>
7914	Address of the USB device (as assigned by the host) to
7915	search for.
7916	</desc>
7917	</param>
7918	<param name="device" type="IHostUSBDevice" dir="return">
7919	<desc>Found USB device object.</desc>
7920	</param>
7921	</method>
7922
7923	</interface>
7924
7925	<!--
7926	// ISystemProperties
7927	/////////////////////////////////////////////////////////////////////////
7928	-->
7929
7930	<interface
7931	name="ISystemProperties"
7932	extends="$unknown"
7933	uuid="fca0d89c-d2ce-45c1-a7b9-e6e7d8501eb1"
7934	wsmap="managed"
7935	>
7936	<desc>
7937	The ISystemProperties interface represents global properties of the given
7938	VirtualBox installation.
7939
7940	These properties define limits and default values for various attributes
7941	and parameters. Most of the properties are read-only, but some can be
7942	changed by a user.
7943	</desc>
7944
7945	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7946	<desc>Minimum guest system memory in Megabytes.</desc>
7947	</attribute>
7948
7949	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7950	<desc>Maximum guest system memory in Megabytes.</desc>
7951	</attribute>
7952
7953	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7954	<desc>Minimum guest video memory in Megabytes.</desc>
7955	</attribute>
7956
7957	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7958	<desc>Maximum guest video memory in Megabytes.</desc>
7959	</attribute>
7960
7961	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7962	<desc>Minimum CPU count.</desc>
7963	</attribute>
7964
7965	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7966	<desc>Maximum CPU count.</desc>
7967	</attribute>
7968
7969	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7970	<desc>Maximum of monitors which could be connected.</desc>
7971	</attribute>
7972
7973	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7974	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7975	</attribute>
7976
7977	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7978	<desc>
7979	Number of network adapters associated with every
7980	<link to="IMachine"/> instance.
7981	</desc>
7982	</attribute>
7983
7984	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7985	<desc>
7986	Number of serial ports associated with every
7987	<link to="IMachine"/> instance.
7988	</desc>
7989	</attribute>
7990
7991	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7992	<desc>
7993	Number of parallel ports associated with every
7994	<link to="IMachine"/> instance.
7995	</desc>
7996	</attribute>
7997
7998	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7999	<desc>
8000	Maximum device position in the boot order. This value corresponds
8001	to the total number of devices a machine can boot from, to make it
8002	possible to include all possible devices to the boot list.
8003	<see><link to="IMachine::setBootOrder"/></see>
8004	</desc>
8005	</attribute>
8006
8007	<attribute name="defaultMachineFolder" type="wstring">
8008	<desc>
8009	Full path to the default directory used to create new or open
8010	existing machines when a settings file name contains no
8011	path.
8012
8013	The initial value of this property is
8014	<tt><</tt><link to="IVirtualBox::homeFolder">
8015	VirtualBox_home</link><tt>>/Machines</tt>.
8016
8017	<note>
8018	Setting this property to @c null or an empty string will restore the
8019	initial value.
8020	</note>
8021	<note>
8022	When settings this property, the specified path can be
8023	absolute (full path) or relative
8024	to the <link to="IVirtualBox::homeFolder">
8025	VirtualBox home directory</link>.
8026	When reading this property, a full path is
8027	always returned.
8028	</note>
8029	<note>
8030	The specified path may not exist, it will be created
8031	when necessary.
8032	</note>
8033
8034	<see>
8035	<link to="IVirtualBox::createMachine"/>,
8036	<link to="IVirtualBox::openMachine"/>
8037	</see>
8038	</desc>
8039	</attribute>
8040
8041	<attribute name="defaultHardDiskFolder" type="wstring">
8042	<desc>
8043	Full path to the default directory used to create new or open existing
8044	virtual disks.
8045
8046	This path is used when the storage unit of a hard disk is a regular file
8047	in the host's file system and only a file name that contains no path is
8048	given.
8049
8050	The initial value of this property is
8051	<tt><</tt>
8052	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
8053	<tt>>/HardDisks</tt>.
8054
8055	<note>
8056	Setting this property to @c null or empty string will restore the
8057	initial value.
8058	</note>
8059	<note>
8060	When settings this property, the specified path can be relative
8061	to the
8062	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
8063	absolute. When reading this property, a full path is
8064	always returned.
8065	</note>
8066	<note>
8067	The specified path may not exist, it will be created
8068	when necessary.
8069	</note>
8070
8071	<see>
8072	IMedium,
8073	<link to="IVirtualBox::createHardDisk"/>,
8074	<link to="IVirtualBox::openHardDisk"/>,
8075	<link to="IMedium::location"/>
8076	</see>
8077	</desc>
8078	</attribute>
8079
8080	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8081	<desc>
8082	List of all medium storage formats supported by this VirtualBox
8083	installation.
8084
8085	Keep in mind that the medium format identifier
8086	(<link to="IMediumFormat::id"/>) used in other API calls like
8087	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8088	medium format is a case-insensitive string. This means that, for
8089	example, all of the following strings:
8090	<pre>
8091	"VDI"
8092	"vdi"
8093	"VdI"</pre>
8094	refer to the same medium format.
8095
8096	Note that the virtual medium framework is backend-based, therefore
8097	the list of supported formats depends on what backends are currently
8098	installed.
8099
8100	<see>
8101	<link to="IMediumFormat"/>,
8102	</see>
8103	</desc>
8104	</attribute>
8105
8106	<attribute name="defaultHardDiskFormat" type="wstring">
8107	<desc>
8108	Identifier of the default medium format used by VirtualBox.
8109
8110	The medium format set by this attribute is used by VirtualBox
8111	when the medium format was not specified explicitly. One example is
8112	<link to="IVirtualBox::createHardDisk"/> with the empty
8113	format argument. A more complex example is implicit creation of
8114	differencing media when taking a snapshot of a virtual machine:
8115	this operation will try to use a format of the parent medium first
8116	and if this format does not support differencing media the default
8117	format specified by this argument will be used.
8118
8119	The list of supported medium formats may be obtained by the
8120	<link to="#mediaFormats"/> call. Note that the default medium
8121	format must have a capability to create differencing media;
8122	otherwise operations that create media implicitly may fail
8123	unexpectedly.
8124
8125	The initial value of this property is <tt>"VDI"</tt> in the current
8126	version of the VirtualBox product, but may change in the future.
8127
8128	<note>
8129	Setting this property to @c null or empty string will restore the
8130	initial value.
8131	</note>
8132
8133	<see>
8134	<link to="#mediaFormats"/>,
8135	<link to="IMediumFormat::id"/>,
8136	<link to="IVirtualBox::createHardDisk"/>
8137	</see>
8138	</desc>
8139	</attribute>
8140
8141	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8142	<desc>
8143	Library that provides authentication for VRDP clients. The library
8144	is used if a virtual machine's authentication type is set to "external"
8145	in the VM RemoteDisplay configuration.
8146
8147	The system library extension (".DLL" or ".so") must be omitted.
8148	A full path can be specified; if not, then the library must reside on the
8149	system's default library path.
8150
8151	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8152	of that name in one of the default VirtualBox library directories.
8153
8154	For details about VirtualBox authentication libraries and how to implement
8155	them, please refer to the VirtualBox manual.
8156
8157	<note>
8158	Setting this property to @c null or empty string will restore the
8159	initial value.
8160	</note>
8161	</desc>
8162	</attribute>
8163
8164	<attribute name="webServiceAuthLibrary" type="wstring">
8165	<desc>
8166	Library that provides authentication for webservice clients. The library
8167	is used if a virtual machine's authentication type is set to "external"
8168	in the VM RemoteDisplay configuration and will be called from
8169	within the <link to="IWebsessionManager::logon" /> implementation.
8170
8171	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8172	there is no per-VM setting for this, as the webservice is a global
8173	resource (if it is running). Only for this setting (for the webservice),
8174	setting this value to a literal <tt>"null"</tt> string disables authentication,
8175	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8176	no matter what user name and password are supplied.
8177
8178	The initial value of this property is <tt>"VRDPAuth"</tt>,
8179	meaning that the webservice will use the same authentication
8180	library that is used by default for VBoxVRDP (again, see
8181	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8182	The format and calling convention of authentication libraries
8183	is the same for the webservice as it is for VBoxVRDP.
8184
8185	<note>
8186	Setting this property to @c null or empty string will restore the
8187	initial value.
8188	</note>
8189	</desc>
8190	</attribute>
8191
8192	<attribute name="LogHistoryCount" type="unsigned long">
8193	<desc>
8194	This value specifies how many old release log files are kept.
8195	</desc>
8196	</attribute>
8197
8198	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8199	<desc>This value hold the default audio driver for the current
8200	system.</desc>
8201	</attribute>
8202
8203	<method name="getMaxDevicesPerPortForStorageBus">
8204	<desc>Returns the maximum number of devices which can be attached to a port
8205	for the given storage bus.</desc>
8206
8207	<param name="bus" type="StorageBus" dir="in">
8208	<desc>The storage bus type to get the value for.</desc>
8209	</param>
8210
8211	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8212	<desc>The maximum number of devices which can eb attached to the port for the given
8213	storage bus.</desc>
8214	</param>
8215	</method>
8216
8217	<method name="getMinPortCountForStorageBus">
8218	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8219
8220	<param name="bus" type="StorageBus" dir="in">
8221	<desc>The storage bus type to get the value for.</desc>
8222	</param>
8223
8224	<param name="minPortCount" type="unsigned long" dir="return">
8225	<desc>The minimum number of ports for the given storage bus.</desc>
8226	</param>
8227	</method>
8228
8229	<method name="getMaxPortCountForStorageBus">
8230	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8231
8232	<param name="bus" type="StorageBus" dir="in">
8233	<desc>The storage bus type to get the value for.</desc>
8234	</param>
8235
8236	<param name="maxPortCount" type="unsigned long" dir="return">
8237	<desc>The maximum number of ports for the given storage bus.</desc>
8238	</param>
8239	</method>
8240
8241	<method name="getMaxInstancesOfStorageBus">
8242	<desc>Returns the maximum number of storage bus instances which
8243	can be configured for each VM. This corresponds to the number of
8244	storage controllers one can have.</desc>
8245
8246	<param name="bus" type="StorageBus" dir="in">
8247	<desc>The storage bus type to get the value for.</desc>
8248	</param>
8249
8250	<param name="maxInstances" type="unsigned long" dir="return">
8251	<desc>The maximum number of instances for the given storage bus.</desc>
8252	</param>
8253	</method>
8254
8255	<method name="getDeviceTypesForStorageBus">
8256	<desc>Returns list of all the supported device types
8257	(<link to="DeviceType"/>) for the given type of storage
8258	bus.</desc>
8259
8260	<param name="bus" type="StorageBus" dir="in">
8261	<desc>The storage bus type to get the value for.</desc>
8262	</param>
8263
8264	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8265	<desc>The list of all supported device types for the given storage bus.</desc>
8266	</param>
8267	</method>
8268	</interface>
8269
8270	<!--
8271	// IGuest
8272	/////////////////////////////////////////////////////////////////////////
8273	-->
8274
8275	<interface
8276	name="IGuestOSType" extends="$unknown"
8277	uuid="5e02d197-dfa2-474d-bd1d-3243a1f24afb"
8278	wsmap="struct"
8279	>
8280	<desc>
8281	</desc>
8282
8283	<attribute name="familyId" type="wstring" readonly="yes">
8284	<desc>Guest OS family identifier string.</desc>
8285	</attribute>
8286
8287	<attribute name="familyDescription" type="wstring" readonly="yes">
8288	<desc>Human readable description of the guest OS family.</desc>
8289	</attribute>
8290
8291	<attribute name="id" type="wstring" readonly="yes">
8292	<desc>Guest OS identifier string.</desc>
8293	</attribute>
8294
8295	<attribute name="description" type="wstring" readonly="yes">
8296	<desc>Human readable description of the guest OS.</desc>
8297	</attribute>
8298
8299	<attribute name="is64Bit" type="boolean" readonly="yes">
8300	<desc>Returns @c true if the given OS is 64-bit</desc>
8301	</attribute>
8302
8303	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8304	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8305	</attribute>
8306
8307	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8308	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8309	</attribute>
8310
8311	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8312	<desc>Recommended RAM size in Megabytes.</desc>
8313	</attribute>
8314
8315	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8316	<desc>Recommended video RAM size in Megabytes.</desc>
8317	</attribute>
8318
8319	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8320	<desc>Recommended hard disk size in Megabytes.</desc>
8321	</attribute>
8322
8323	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8324	<desc>Returns recommended network adapter for this OS type.</desc>
8325	</attribute>
8326
8327	<attribute name="recommendedPae" type="boolean" readonly="yes">
8328	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8329	</attribute>
8330
8331	<attribute name="recommendedStorageController" type="StorageControllerType" readonly="yes">
8332	<desc>Recommended storage controller type.</desc>
8333	</attribute>
8334
8335	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8336	<desc>Recommended firmware type.</desc>
8337	</attribute>
8338
8339	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8340	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8341	</attribute>
8342
8343	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8344	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8345	</attribute>
8346
8347	</interface>
8348
8349	<interface
8350	name="IGuest" extends="$unknown"
8351	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8352	wsmap="managed"
8353	>
8354	<desc>
8355	The IGuest interface represents information about the operating system
8356	running inside the virtual machine. Used in
8357	<link to="IConsole::guest"/>.
8358
8359	IGuest provides information about the guest operating system, whether
8360	Guest Additions are installed and other OS-specific virtual machine
8361	properties.
8362	</desc>
8363
8364	<attribute name="OSTypeId" type="wstring" readonly="yes">
8365	<desc>
8366	Identifier of the Guest OS type as reported by the Guest
8367	Additions.
8368	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8369	an IGuestOSType object representing details about the given
8370	Guest OS type.
8371	<note>
8372	If Guest Additions are not installed, this value will be
8373	the same as <link to="IMachine::OSTypeId"/>.
8374	</note>
8375	</desc>
8376	</attribute>
8377
8378	<attribute name="additionsActive" type="boolean" readonly="yes">
8379	<desc>
8380	Flag whether the Guest Additions are installed and active
8381	in which case their version will be returned by the
8382	<link to="#additionsVersion"/> property.
8383	</desc>
8384	</attribute>
8385
8386	<attribute name="additionsVersion" type="wstring" readonly="yes">
8387	<desc>
8388	Version of the Guest Additions (3 decimal numbers separated
8389	by dots) or empty when the Additions are not installed. The
8390	Additions may also report a version but yet not be active as
8391	the version might be refused by VirtualBox (incompatible) or
8392	other failures occurred.
8393	</desc>
8394	</attribute>
8395
8396	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8397	<desc>
8398	Flag whether seamless guest display rendering (seamless desktop
8399	integration) is supported.
8400	</desc>
8401	</attribute>
8402
8403	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8404	<desc>
8405	Flag whether the guest is in graphics mode. If it is not, then
8406	seamless rendering will not work, resize hints are not immediately
8407	acted on and guest display resizes are probably not initiated by
8408	the guest additions.
8409	</desc>
8410	</attribute>
8411
8412	<attribute name="memoryBalloonSize" type="unsigned long">
8413	<desc>Guest system memory balloon size in megabytes.</desc>
8414	</attribute>
8415
8416	<attribute name="statisticsUpdateInterval" type="unsigned long">
8417	<desc>Interval to update guest statistics in seconds.</desc>
8418	</attribute>
8419
8420	<method name="setCredentials">
8421	<desc>
8422	Store login credentials that can be queried by guest operating
8423	systems with Additions installed. The credentials are transient
8424	to the session and the guest may also choose to erase them. Note
8425	that the caller cannot determine whether the guest operating system
8426	has queried or made use of the credentials.
8427
8428	<result name="VBOX_E_VM_ERROR">
8429	VMM device is not available.
8430	</result>
8431
8432	</desc>
8433	<param name="userName" type="wstring" dir="in">
8434	<desc>User name string, can be empty</desc>
8435	</param>
8436	<param name="password" type="wstring" dir="in">
8437	<desc>Password string, can be empty</desc>
8438	</param>
8439	<param name="domain" type="wstring" dir="in">
8440	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8441	</param>
8442	<param name="allowInteractiveLogon" type="boolean" dir="in">
8443	<desc>
8444	Flag whether the guest should alternatively allow the user to
8445	interactively specify different credentials. This flag might
8446	not be supported by all versions of the Additions.
8447	</desc>
8448	</param>
8449	</method>
8450
8451	<method name="getStatistic">
8452	<desc>
8453	Query specified guest statistics as reported by the VirtualBox Additions.
8454	</desc>
8455	<param name="cpuId" type="unsigned long" dir="in">
8456	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8457	</param>
8458	<param name="statistic" type="GuestStatisticType" dir="in">
8459	<desc>Statistic type.</desc>
8460	</param>
8461	<param name="statVal" type="unsigned long" dir="return">
8462	<desc>Statistics value</desc>
8463	</param>
8464	</method>
8465
8466	</interface>
8467
8468
8469	<!--
8470	// IProgress
8471	/////////////////////////////////////////////////////////////////////////
8472	-->
8473
8474	<interface
8475	name="IProgress" extends="$unknown"
8476	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8477	wsmap="managed"
8478	>
8479	<desc>
8480	The IProgress interface is used to track and control
8481	asynchronous tasks within VirtualBox.
8482
8483	An instance of this is returned every time VirtualBox starts
8484	an asynchronous task (in other words, a separate thread) which
8485	continues to run after a method call returns. For example,
8486	<link to="IConsole::saveState" />, which saves the state of
8487	a running virtual machine, can take a long time to complete.
8488	To be able to display a progress bar, a user interface such as
8489	the VirtualBox graphical user interface can use the IProgress
8490	object returned by that method.
8491
8492	Note that IProgress is a "read-only" interface in the sense
8493	that only the VirtualBox internals behind the Main API can
8494	create and manipulate progress objects, whereas client code
8495	can only use the IProgress object to monitor a task's
8496	progress and, if <link to="#cancelable" /> is @c true,
8497	cancel the task by calling <link to="#cancel" />.
8498
8499	A task represented by IProgress consists of either one or
8500	several sub-operations that run sequentially, one by one (see
8501	<link to="#operation" /> and <link to="#operationCount" />).
8502	Every operation is identified by a number (starting from 0)
8503	and has a separate description.
8504
8505	You can find the individual percentage of completion of the current
8506	operation in <link to="#operationPercent" /> and the
8507	percentage of completion of the task as a whole
8508	in <link to="#percent" />.
8509
8510	Similarly, you can wait for the completion of a particular
8511	operation via <link to="#waitForOperationCompletion" /> or
8512	for the completion of the whole task via
8513	<link to="#waitForCompletion" />.
8514	</desc>
8515
8516	<attribute name="id" type="uuid" mod="string" readonly="yes">
8517	<desc>ID of the task.</desc>
8518	</attribute>
8519
8520	<attribute name="description" type="wstring" readonly="yes">
8521	<desc>Description of the task.</desc>
8522	</attribute>
8523
8524	<attribute name="initiator" type="$unknown" readonly="yes">
8525	<desc>Initiator of the task.</desc>
8526	</attribute>
8527
8528	<attribute name="cancelable" type="boolean" readonly="yes">
8529	<desc>Whether the task can be interrupted.</desc>
8530	</attribute>
8531
8532	<attribute name="percent" type="unsigned long" readonly="yes">
8533	<desc>
8534	Current progress value of the task as a whole, in percent.
8535	This value depends on how many operations are already complete.
8536	Returns 100 if <link to="#completed" /> is @c true.
8537	</desc>
8538	</attribute>
8539
8540	<attribute name="timeRemaining" type="long" readonly="yes">
8541	<desc>
8542	Estimated remaining time until the task completes, in
8543	seconds. Returns 0 once the task has completed; returns -1
8544	if the remaining time cannot be computed, in particular if
8545	the current progress is 0.
8546
8547	Even if a value is returned, the estimate will be unreliable
8548	for low progress values. It will become more reliable as the
8549	task progresses; it is not recommended to display an ETA
8550	before at least 20% of a task have completed.
8551	</desc>
8552	</attribute>
8553
8554	<attribute name="completed" type="boolean" readonly="yes">
8555	<desc>Whether the task has been completed.</desc>
8556	</attribute>
8557
8558	<attribute name="canceled" type="boolean" readonly="yes">
8559	<desc>Whether the task has been canceled.</desc>
8560	</attribute>
8561
8562	<attribute name="resultCode" type="long" readonly="yes">
8563	<desc>
8564	Result code of the progress task.
8565	Valid only if <link to="#completed"/> is @c true.
8566	</desc>
8567	</attribute>
8568
8569	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8570	<desc>
8571	Extended information about the unsuccessful result of the
8572	progress operation. May be @c null if no extended information
8573	is available.
8574	Valid only if <link to="#completed"/> is @c true and
8575	<link to="#resultCode"/> indicates a failure.
8576	</desc>
8577	</attribute>
8578
8579	<attribute name="operationCount" type="unsigned long" readonly="yes">
8580	<desc>
8581	Number of sub-operations this task is divided into.
8582	Every task consists of at least one suboperation.
8583	</desc>
8584	</attribute>
8585
8586	<attribute name="operation" type="unsigned long" readonly="yes">
8587	<desc>Number of the sub-operation being currently executed.</desc>
8588	</attribute>
8589
8590	<attribute name="operationDescription" type="wstring" readonly="yes">
8591	<desc>
8592	Description of the sub-operation being currently executed.
8593	</desc>
8594	</attribute>
8595
8596	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8597	<desc>Progress value of the current sub-operation only, in percent.</desc>
8598	</attribute>
8599
8600	<attribute name="timeout" type="unsigned long">
8601	<desc>
8602	When non-zero, this specifies the number of milliseconds after which
8603	the operation will automatically be canceled. This can only be set on
8604	cancelable objects.
8605	</desc>
8606	</attribute>
8607
8608	<method name="setCurrentOperationProgress">
8609	<desc>Internal method, not to be called externally.</desc>
8610	<param name="percent" type="unsigned long" dir="in" />
8611	</method>
8612	<method name="setNextOperation">
8613	<desc>Internal method, not to be called externally.</desc>
8614	<param name="nextOperationDescription" type="wstring" dir="in" />
8615	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8616	</method>
8617
8618	<method name="waitForCompletion">
8619	<desc>
8620	Waits until the task is done (including all sub-operations)
8621	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8622
8623	<result name="VBOX_E_IPRT_ERROR">
8624	Failed to wait for task completion.
8625	</result>
8626	</desc>
8627
8628	<param name="timeout" type="long" dir="in">
8629	<desc>
8630	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8631	</desc>
8632	</param>
8633	</method>
8634
8635	<method name="waitForOperationCompletion">
8636	<desc>
8637	Waits until the given operation is done with a given timeout in
8638	milliseconds; specify -1 for an indefinite wait.
8639
8640	<result name="VBOX_E_IPRT_ERROR">
8641	Failed to wait for operation completion.
8642	</result>
8643
8644	</desc>
8645	<param name="operation" type="unsigned long" dir="in">
8646	<desc>
8647	Number of the operation to wait for.
8648	Must be less than <link to="#operationCount"/>.
8649	</desc>
8650	</param>
8651	<param name="timeout" type="long" dir="in">
8652	<desc>
8653	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8654	</desc>
8655	</param>
8656	</method>
8657
8658	<method name="cancel">
8659	<desc>
8660	Cancels the task.
8661	<note>
8662	If <link to="#cancelable"/> is @c false, then this method will fail.
8663	</note>
8664
8665	<result name="VBOX_E_INVALID_OBJECT_STATE">
8666	Operation cannot be canceled.
8667	</result>
8668
8669	</desc>
8670	</method>
8671
8672	</interface>
8673
8674
8675	<!--
8676	// ISnapshot
8677	/////////////////////////////////////////////////////////////////////////
8678	-->
8679
8680	<interface
8681	name="ISnapshot" extends="$unknown"
8682	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8683	wsmap="managed"
8684	>
8685	<desc>
8686	The ISnapshot interface represents a snapshot of the virtual
8687	machine.
8688
8689	Together with the differencing media that are created
8690	when a snapshot is taken, a machine can be brought back to
8691	the exact state it was in when the snapshot was taken.
8692
8693	The ISnapshot interface has no methods, only attributes; snapshots
8694	are controlled through methods of the <link to="IConsole" /> interface
8695	which also manage the media associated with the snapshot.
8696	The following operations exist:
8697
8698	<ul>
8699	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8700	by creating new, empty differencing images for the machine's
8701	media and saving the VM settings and (if the VM is running)
8702	the current VM state in the snapshot.
8703
8704	The differencing images will then receive all data written to
8705	the machine's media, while their parent (base) images
8706	remain unmodified after the snapshot has been taken (see
8707	<link to="IMedium" /> for details about differencing images).
8708	This simplifies restoring a machine to the state of a snapshot:
8709	only the differencing images need to be deleted.
8710
8711	The current machine state is not changed by taking a snapshot.
8712	If the machine is running, it will resume execution after the
8713	snapshot has been taken.
8714	</li>
8715
8716	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8717	a previous snapshot. This resets the machine's state to that of
8718	the previous snapshot by deleting the differencing image of each
8719	of the machine's media and setting the machine's settings
8720	and state to the state that was saved in the snapshot (if any).
8721
8722	This destroys the machine's current state.
8723	</li>
8724
8725	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8726	without affecting the current machine state.
8727
8728	This does not change the machine, but instead frees the resources
8729	allocated when the snapshot was taken: the settings and machine state
8730	is deleted (if any), and the snapshot's differencing image for each
8731	of the machine's media gets merged with its parent image.
8732
8733	Neither the current machine state nor other snapshots are affected
8734	by this operation, except that parent media will be modified
8735	to contain the disk data associated with the snapshot being deleted.
8736	</li>
8737	</ul>
8738
8739	Each snapshot contains the settings of the virtual machine (hardware
8740	configuration etc.). In addition, if the machine was running when the
8741	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8742	the current VM state is saved in the snapshot (similarly to what happens
8743	when a VM's state is saved). The snapshot is then said to
8744	be <i>online</i> because when restoring it, the VM will be running.
8745
8746	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8747	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8748
8749	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8750	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8751	it then contains a so-called "zero execution state", representing a
8752	machine that is powered off.
8753
8754	<h3>Snapshot branches and the "current" snapshot</h3>
8755
8756	Snapshots can be chained, whereby every next snapshot is based on the
8757	previous one. This chaining is related to medium branching
8758	(see the <link to="IMedium"/> description) in that every time
8759	a new snapshot is created, a new differencing medium is implicitly
8760	created for all normal media attached to the machine.
8761
8762	Each virtual machine has a "current snapshot", identified by
8763	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8764	to the last snapshot in the chain. In a future version of VirtualBox,
8765	it will be possible to reset a machine's current state to that of an
8766	earlier snapshot without discarding the current state so that it will be
8767	possible to create alternative snapshot paths in a snapshot tree.
8768
8769	In the current implementation, multiple snapshot branches within one
8770	virtual machine are not allowed. Every machine has a single branch,
8771	and <link to="IConsole::takeSnapshot"/> operation adds a new
8772	snapshot to the top of that branch.
8773	</desc>
8774
8775	<attribute name="id" type="uuid" mod="string" readonly="yes">
8776	<desc>UUID of the snapshot.</desc>
8777	</attribute>
8778
8779	<attribute name="name" type="wstring">
8780	<desc>Short name of the snapshot.</desc>
8781	</attribute>
8782
8783	<attribute name="description" type="wstring">
8784	<desc>Optional description of the snapshot.</desc>
8785	</attribute>
8786
8787	<attribute name="timeStamp" type="long long" readonly="yes">
8788	<desc>
8789	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8790	</desc>
8791	</attribute>
8792
8793	<attribute name="online" type="boolean" readonly="yes">
8794	<desc>
8795	@c true if this snapshot is an online snapshot and @c false otherwise.
8796
8797	When this attribute is @c true, the
8798	<link to="IMachine::stateFilePath"/> attribute of the
8799	<link to="#machine"/> object associated with this snapshot
8800	will point to the saved state file. Otherwise, it will be
8801	an empty string.
8802	</desc>
8803	</attribute>
8804
8805	<attribute name="machine" type="IMachine" readonly="yes">
8806	<desc>
8807	Virtual machine this snapshot is taken on. This object
8808	stores all settings the machine had when taking this snapshot.
8809	<note>
8810	The returned machine object is immutable, i.e. no
8811	any settings can be changed.
8812	</note>
8813	</desc>
8814	</attribute>
8815
8816	<attribute name="parent" type="ISnapshot" readonly="yes">
8817	<desc>
8818	Parent snapshot (a snapshot this one is based on), or
8819	@c null if the snapshot has no parent (i.e. is the first snapshot).
8820	</desc>
8821	</attribute>
8822
8823	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8824	<desc>
8825	Child snapshots (all snapshots having this one as a parent).
8826	</desc>
8827	</attribute>
8828
8829	</interface>
8830
8831
8832	<!--
8833	// IMedium
8834	/////////////////////////////////////////////////////////////////////////
8835	-->
8836
8837	<enum
8838	name="MediumState"
8839	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8840	>
8841	<desc>
8842	Virtual medium state.
8843	<see>IMedium</see>
8844	</desc>
8845
8846	<const name="NotCreated" value="0">
8847	<desc>
8848	Associated medium storage does not exist (either was not created yet or
8849	was deleted).
8850	</desc>
8851	</const>
8852	<const name="Created" value="1">
8853	<desc>
8854	Associated storage exists and accessible; this gets set if the
8855	accessibility check performed by <link to="IMedium::refreshState" />
8856	was successful.
8857	</desc>
8858	</const>
8859	<const name="LockedRead" value="2">
8860	<desc>
8861	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8862	no data modification is possible.
8863	</desc>
8864	</const>
8865	<const name="LockedWrite" value="3">
8866	<desc>
8867	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8868	no concurrent data reading or modification is possible.
8869	</desc>
8870	</const>
8871	<const name="Inaccessible" value="4">
8872	<desc>
8873	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8874	not yet been performed, or else, associated medium storage is not
8875	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8876	is empty, in the second case, it describes the error that occured.
8877	</desc>
8878	</const>
8879	<const name="Creating" value="5">
8880	<desc>
8881	Associated medium storage is being created.
8882	</desc>
8883	</const>
8884	<const name="Deleting" value="6">
8885	<desc>
8886	Associated medium storage is being deleted.
8887	</desc>
8888	</const>
8889	</enum>
8890
8891	<enum
8892	name="MediumType"
8893	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8894	>
8895	<desc>
8896	Virtual medium type.
8897	<see>IMedium</see>
8898	</desc>
8899
8900	<const name="Normal" value="0">
8901	<desc>
8902	Normal medium (attached directly or indirectly, preserved
8903	when taking snapshots).
8904	</desc>
8905	</const>
8906	<const name="Immutable" value="1">
8907	<desc>
8908	Immutable medium (attached indirectly, changes are wiped out
8909	the next time the virtual machine is started).
8910	</desc>
8911	</const>
8912	<const name="Writethrough" value="2">
8913	<desc>
8914	Write through medium (attached directly, ignored when
8915	taking snapshots).
8916	</desc>
8917	</const>
8918	</enum>
8919
8920	<enum
8921	name="MediumVariant"
8922	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8923	>
8924	<desc>
8925	Virtual medium image variant. More than one flag may be set.
8926	<see>IMedium</see>
8927	</desc>
8928
8929	<const name="Standard" value="0">
8930	<desc>
8931	No particular variant requested, results in using the backend default.
8932	</desc>
8933	</const>
8934	<const name="VmdkSplit2G" value="0x01">
8935	<desc>
8936	VMDK image split in chunks of less than 2GByte.
8937	</desc>
8938	</const>
8939	<const name="VmdkStreamOptimized" value="0x04">
8940	<desc>
8941	VMDK streamOptimized image. Special import/export format which is
8942	read-only/append-only.
8943	</desc>
8944	</const>
8945	<const name="VmdkESX" value="0x08">
8946	<desc>
8947	VMDK format variant used on ESX products.
8948	</desc>
8949	</const>
8950	<const name="Fixed" value="0x10000">
8951	<desc>
8952	Fixed image. Only allowed for base images.
8953	</desc>
8954	</const>
8955	<const name="Diff" value="0x20000">
8956	<desc>
8957	Fixed image. Only allowed for base images.
8958	</desc>
8959	</const>
8960	</enum>
8961
8962	<interface
8963	name="IMediumAttachment" extends="$unknown"
8964	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
8965	wsmap="struct"
8966	>
8967	<desc>
8968	The IMediumAttachment interface represents the attachment
8969	of a storage medium to a virtual machine. Each machine contains
8970	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8971
8972	Each medium attachment specifies a storage controller as well as a port
8973	and device number. Fixed media (hard disks) will always also specify
8974	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8975	medium. For removeable media, the IMedia instance is optional; it can be
8976	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8977	</desc>
8978
8979	<attribute name="medium" type="IMedium" readonly="yes">
8980	<desc>Medium object associated with this attachment; it
8981	can be @c null for removable devices.</desc>
8982	</attribute>
8983
8984	<attribute name="controller" type="wstring" readonly="yes">
8985	<desc>Name of the storage controller of this attachment; this
8986	refers to one of the controllers in <link to="IMachine::storageControllers" />
8987	by name.</desc>
8988	</attribute>
8989
8990	<attribute name="port" type="long" readonly="yes">
8991	<desc>Port number of this attachment.</desc>
8992	</attribute>
8993
8994	<attribute name="device" type="long" readonly="yes">
8995	<desc>Device slot number of this attachment.</desc>
8996	</attribute>
8997
8998	<attribute name="type" type="DeviceType" readonly="yes">
8999	<desc>Device type of this attachment.</desc>
9000	</attribute>
9001
9002	<attribute name="passthrough" type="boolean" readonly="yes">
9003	<desc>Pass I/O requests through to a device on the host.</desc>
9004	</attribute>
9005
9006	</interface>
9007
9008	<interface
9009	name="IMedium" extends="$unknown"
9010	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
9011	wsmap="managed"
9012	>
9013	<desc>
9014	The IMedium interface represents virtual storage for a machine's
9015	hard disks, CD/DVD or floppy drives. It will typically represent
9016	a disk image on the host, for example a VDI or VMDK file representing
9017	a virtual hard disk, or an ISO or RAW file representing virtual
9018	removable media, but can also point to a network location (e.g.
9019	for iSCSI targets).
9020
9021	Instances of IMedium are connected to virtual machines by way of
9022	medium attachments (see <link to="IMediumAttachment" />), which link
9023	the storage medium to a particular device slot of a storage controller
9024	of the virtual machine.
9025	In the VirtualBox API, virtual storage is therefore always represented
9026	by the following chain of object links:
9027
9028	<ul>
9029	<li><link to="IMachine::storageControllers"/> contains an array of
9030	storage controllers (IDE, SATA, SCSI or a floppy controller;
9031	these are instances of <link to="IStorageController"/>).</li>
9032	<li><link to="IMachine::mediumAttachments"/> contains an array of
9033	medium attachments (instances of <link to="IMediumAttachment"/>),
9034	each containing a storage controller from the above array, a
9035	port/device specification, and an instance of IMedium representing
9036	the medium storage (image file).
9037
9038	For removable media, the storage medium is optional; a medium
9039	attachment with no medium represents a CD/DVD or floppy drive
9040	with no medium inserted. By contrast, hard disk attachments
9041	will always have an IMedium object attached.</li>
9042	<li>Each IMedium in turn points to a storage unit (such as a file
9043	on the host computer or a network resource) that holds actual
9044	data. This location is represented by the <link to="#location"/>
9045	attribute.</li>
9046	</ul>
9047
9048	Existing media are opened using the following methods, depending on the
9049	media type:
9050	<ul>
9051	<li><link to="IVirtualBox::openHardDisk"/></li>
9052	<li><link to="IVirtualBox::openDVDImage"/></li>
9053	<li><link to="IVirtualBox::openFloppyImage"/></li>
9054	</ul>
9055
9056	New hard disk media can be created with the VirtualBox API using the
9057	<link to="IVirtualBox::createHardDisk"/> method.
9058
9059	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9060	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9061	type in a regular file.
9062
9063	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9064	drive; in that case the <link to="#id" /> attribute contains the UUID of
9065	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9066
9067	<h3>Known media</h3>
9068
9069	When an existing medium is opened for the first time, it is automatically
9070	remembered by the given VirtualBox installation or, in other words, becomes
9071	a <i>known medium</i>. Known media are stored in the media
9072	registry transparently maintained by VirtualBox and stored in settings
9073	files so that this registry is preserved when VirtualBox is not running.
9074
9075	Newly created virtual media are remembered only when the associated
9076	storage unit is actually created.
9077
9078	All known media can be enumerated using
9079	<link to="IVirtualBox::hardDisks"/>,
9080	<link to="IVirtualBox::DVDImages"/> and
9081	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9082	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
9083	and similar methods or by location using
9084	<link to="IVirtualBox::findHardDisk"/> and similar methods.
9085
9086	Only known media can be attached to virtual machines.
9087
9088	Removing known media from the media registry is performed when the given
9089	medium is closed using the <link to="#close"/> method or when its
9090	associated storage unit is deleted.
9091
9092	<h3>Accessibility checks</h3>
9093
9094	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9095	method is called explicitly on a medium. This is done to make the VirtualBox object
9096	ready for serving requests as fast as possible and let the end-user
9097	application decide if it needs to check media accessibility right away or not.
9098
9099	As a result, when VirtualBox starts up (e.g. the VirtualBox
9100	object gets created for the first time), all known media are in the
9101	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9102	attribute is an empty string because no actual accessibility check has
9103	been made yet.
9104
9105	After calling <link to="#refreshState" />, a medium is considered
9106	<i>accessible</i> if its storage unit can be read. In that case, the
9107	<link to="#state"/> attribute has a value of "Created". If the storage
9108	unit cannot be read (for example, because it is located on a disconnected
9109	network resource, or was accidentally deleted outside VirtualBox),
9110	the medium is considered <i>inaccessible</i>, which is indicated by the
9111	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9112	obtained by reading the <link to="#lastAccessError"/> attribute.
9113
9114	<h3>Medium types</h3>
9115
9116	There are three types of medium behavior (see <link to="MediumType" />):
9117	"normal", "immutable" and "writethrough", represented by the
9118	<link to="#type"/> attribute. The type of the medium defines how the
9119	medium is attached to a virtual machine and what happens when a
9120	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9121	attached medium is taken. At the moment DVD and floppy media are always
9122	of type "writethrough".
9123
9124	All media can be also divided in two groups: <i>base</i> media and
9125	<i>differencing</i> media. A base medium contains all sectors of the
9126	medium data in its own storage and therefore can be used independently.
9127	In contrast, a differencing mediun is a "delta" to some other medium and
9128	contains only those sectors which differ from that other medium, which is
9129	then called a <i>parent</i>. The differencing medium is said to be
9130	<i>linked to</i> that parent. The parent may be itself a differencing
9131	medium, thus forming a chain of linked media. The last element in that
9132	chain must always be a base medium. Note that several differencing
9133	media may be linked to the same parent medium.
9134
9135	Differencing media can be distinguished from base media by querying the
9136	<link to="#parent"/> attribute: base media do not have parents they would
9137	depend on, so the value of this attribute is always @c null for them.
9138	Using this attribute, it is possible to walk up the medium tree (from the
9139	child medium to its parent). It is also possible to walk down the tree
9140	using the <link to="#children"/> attribute.
9141
9142	Note that the type of all differencing media is "Normal"; all other
9143	values are meaningless for them. Base media may be of any type.
9144
9145	<h3>Creating hard disks</h3>
9146
9147	New base hard disks are created using
9148	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9149	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
9150	disks are usually implicitly created by VirtualBox when needed but may
9151	also be created explicitly using <link to="#createDiffStorage"/>.
9152
9153	After the hard disk is successfully created (including the storage unit)
9154	or opened, it becomes a known hard disk (remembered in the internal media
9155	registry). Known hard disks can be attached to a virtual machine, accessed
9156	through <link to="IVirtualBox::getHardDisk"/> and
9157	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
9158	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9159
9160	The following methods, besides <link to="IMedium::close"/>,
9161	automatically remove the hard disk from the media registry:
9162	<ul>
9163	<li><link to="#deleteStorage"/></li>
9164	<li><link to="#mergeTo"/></li>
9165	</ul>
9166
9167	If the storage unit of the hard disk is a regular file in the host's
9168	file system then the rules stated in the description of the
9169	<link to="IMedium::location"/> attribute apply when setting its value. In
9170	addition, a plain file name without any path may be given, in which case
9171	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9172	folder</link> will be prepended to it.
9173
9174	<h4>Automatic composition of the file name part</h4>
9175
9176	Another extension to the <link to="IMedium::location"/> attribute is that
9177	there is a possibility to cause VirtualBox to compose a unique value for
9178	the file name part of the location using the UUID of the hard disk. This
9179	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9180	e.g. before the storage unit is created, and works as follows. You set the
9181	value of the <link to="IMedium::location"/> attribute to a location
9182	specification which only contains the path specification but not the file
9183	name part and ends with either a forward slash or a backslash character.
9184	In response, VirtualBox will generate a new UUID for the hard disk and
9185	compose the file name using the following pattern:
9186	<pre>
9187	<path>/{<uuid>}.<ext>
9188	</pre>
9189	where <tt><path></tt> is the supplied path specification,
9190	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9191	is the default extension for the storage format of this hard disk. After
9192	that, you may call any of the methods that create a new hard disk storage
9193	unit and they will use the generated UUID and file name.
9194
9195	<h3>Attaching Hard Disks</h3>
9196
9197	Hard disks are attached to virtual machines using the
9198	<link to="IMachine::attachDevice"/> method and detached using the
9199	<link to="IMachine::detachDevice"/> method. Depending on their
9200	<link to="#type"/>, hard disks are attached either
9201	<i>directly</i> or <i>indirectly</i>.
9202
9203	When a hard disk is being attached directly, it is associated with the
9204	virtual machine and used for hard disk operations when the machine is
9205	running. When a hard disk is being attached indirectly, a new differencing
9206	hard disk linked to it is implicitly created and this differencing hard
9207	disk is associated with the machine and used for hard disk operations.
9208	This also means that if <link to="IMachine::attachDevice"/> performs
9209	a direct attachment then the same hard disk will be returned in response
9210	to the subsequent <link to="IMachine::getMedium"/> call; however if
9211	an indirect attachment is performed then
9212	<link to="IMachine::getMedium"/> will return the implicitly created
9213	differencing hard disk, not the original one passed to <link
9214	to="IMachine::attachDevice"/>. In detail:
9215
9216	<ul>
9217	<li><b>Normal base</b> hard disks that do not have children (i.e.
9218	differencing hard disks linked to them) and that are not already
9219	attached to virtual machines in snapshots are attached <b>directly</b>.
9220	Otherwise, they are attached <b>indirectly</b> because having
9221	dependent children or being part of the snapshot makes it impossible
9222	to modify hard disk contents without breaking the integrity of the
9223	dependent party. The <link to="#readOnly"/> attribute allows to
9224	quickly determine the kind of the attachment for the given hard
9225	disk. Note that if a normal base hard disk is to be indirectly
9226	attached to a virtual machine with snapshots then a special
9227	procedure called <i>smart attachment</i> is performed (see below).</li>
9228	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9229	they are attached <b>directly</b> if they do not have children and are
9230	not attached to virtual machines in snapshots, and <b>indirectly</b>
9231	otherwise. Note that the smart attachment procedure is never performed
9232	for differencing hard disks.</li>
9233	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9234	they are designed to be non-writable. If an immutable hard disk is
9235	attached to a virtual machine with snapshots then a special
9236	procedure called smart attachment is performed (see below).</li>
9237	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9238	also as designed. This also means that writethrough hard disks cannot
9239	have other hard disks linked to them at all.</li>
9240	</ul>
9241
9242	Note that the same hard disk, regardless of its type, may be attached to
9243	more than one virtual machine at a time. In this case, the machine that is
9244	started first gains exclusive access to the hard disk and attempts to
9245	start other machines having this hard disk attached will fail until the
9246	first machine is powered down.
9247
9248	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9249	that the given hard disk remains associated with the given machine after a
9250	successful <link to="IMachine::detachDevice"/> call until
9251	<link to="IMachine::saveSettings"/> is called to save all changes to
9252	machine settings to disk. This deferring is necessary to guarantee that
9253	the hard disk configuration may be restored at any time by a call to
9254	<link to="IMachine::discardSettings"/> before the settings
9255	are saved (committed).
9256
9257	Note that if <link to="IMachine::discardSettings"/> is called after
9258	indirectly attaching some hard disks to the machine but before a call to
9259	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9260	all differencing hard disks implicitly created by
9261	<link to="IMachine::attachDevice"/> for these indirect attachments.
9262	Such implicitly created hard disks will also be immediately deleted when
9263	detached explicitly using the <link to="IMachine::detachDevice"/>
9264	call if it is made before <link to="IMachine::saveSettings"/>. This
9265	implicit deletion is safe because newly created differencing hard
9266	disks do not contain any user data.
9267
9268	However, keep in mind that detaching differencing hard disks that were
9269	implicitly created by <link to="IMachine::attachDevice"/>
9270	before the last <link to="IMachine::saveSettings"/> call will
9271	<b>not</b> implicitly delete them as they may already contain some data
9272	(for example, as a result of virtual machine execution). If these hard
9273	disks are no more necessary, the caller can always delete them explicitly
9274	using <link to="#deleteStorage"/> after they are actually de-associated
9275	from this machine by the <link to="IMachine::saveSettings"/> call.
9276
9277	<h3>Smart Attachment</h3>
9278
9279	When normal base or immutable hard disks are indirectly attached to a
9280	virtual machine then some additional steps are performed to make sure the
9281	virtual machine will have the most recent "view" of the hard disk being
9282	attached. These steps include walking through the machine's snapshots
9283	starting from the current one and going through ancestors up to the first
9284	snapshot. Hard disks attached to the virtual machine in all
9285	of the encountered snapshots are checked whether they are descendants of
9286	the given normal base or immutable hard disk. The first found child (which
9287	is the differencing hard disk) will be used instead of the normal base or
9288	immutable hard disk as a parent for creating a new differencing hard disk
9289	that will be actually attached to the machine. And only if no descendants
9290	are found or if the virtual machine does not have any snapshots then the
9291	normal base or immutable hard disk will be used itself as a parent for
9292	this differencing hard disk.
9293
9294	It is easier to explain what smart attachment does using the
9295	following example:
9296	<pre>
9297	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9298
9299	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9300	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9301	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9302	Snapshot 4 (none) Snapshot 4 (none)
9303	CurState (none) CurState (D3->D2.vdi)
9304
9305	NOT
9306	...
9307	CurState (D3->B.vdi)
9308	</pre>
9309	The first column is the virtual machine configuration before the base hard
9310	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9311	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9312	mean that the hard disk that is actually attached to the machine is a
9313	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9314	another hard disk, <tt>B.vdi</tt>.
9315
9316	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9317	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9318	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9319	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9320	it cannot be attached directly and needs an indirect attachment (i.e.
9321	implicit creation of a new differencing hard disk). Due to the smart
9322	attachment procedure, the new differencing hard disk
9323	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9324	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9325	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9326	machine.
9327
9328	Note that if there is more than one descendant hard disk of the given base
9329	hard disk found in a snapshot, and there is an exact device, channel and
9330	bus match, then this exact match will be used. Otherwise, the youngest
9331	descendant will be picked up.
9332
9333	There is one more important aspect of the smart attachment procedure which
9334	is not related to snapshots at all. Before walking through the snapshots
9335	as described above, the backup copy of the current list of hard disk
9336	attachment is searched for descendants. This backup copy is created when
9337	the hard disk configuration is changed for the first time after the last
9338	<link to="IMachine::saveSettings"/> call and used by
9339	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9340	changes. When such a descendant is found in this backup copy, it will be
9341	simply re-attached back, without creating a new differencing hard disk for
9342	it. This optimization is necessary to make it possible to re-attach the
9343	base or immutable hard disk to a different bus, channel or device slot
9344	without losing the contents of the differencing hard disk actually
9345	attached to the machine in place of it.
9346	</desc>
9347
9348	<attribute name="id" type="uuid" mod="string" readonly="yes">
9349	<desc>
9350	UUID of the medium. For a newly created medium, this value is a randomly
9351	generated UUID.
9352
9353	<note>
9354	For media in one of MediumState_NotCreated, MediumState_Creating or
9355	MediumState_Deleting states, the value of this property is undefined
9356	and will most likely be an empty UUID.
9357	</note>
9358	</desc>
9359	</attribute>
9360
9361	<attribute name="description" type="wstring">
9362	<desc>
9363	Optional description of the medium. For a newly created medium the value
9364	of this attribute is an empty string.
9365
9366	Medium types that don't support this attribute will return E_NOTIMPL in
9367	attempt to get or set this attribute's value.
9368
9369	<note>
9370	For some storage types, reading this attribute may return an outdated
9371	(last known) value when <link to="#state"/> is <link
9372	to="MediumState_Inaccessible"/> or <link
9373	to="MediumState_LockedWrite"/> because the value of this attribute is
9374	stored within the storage unit itself. Also note that changing the
9375	attribute value is not possible in such case, as well as when the
9376	medium is the <link to="MediumState_LockedRead"/> state.
9377	</note>
9378	</desc>
9379	</attribute>
9380
9381	<attribute name="state" type="MediumState" readonly="yes">
9382	<desc>
9383	Returns the current medium state, which is the last state set by
9384	the accessibility check performed by <link to="#refreshState"/>.
9385	If that method has not yet been called on the medium, the state
9386	is "Inaccessible"; as opposed to truly inaccessible media, the
9387	value of <link to="#lastAccessError"/> will be an empty string in
9388	that case.
9389
9390	<note>As of version 3.1, this no longer performs an accessibility check
9391	automatically; call <link to="#refreshState"/> for that.
9392	</note>
9393	</desc>
9394	</attribute>
9395
9396	<attribute name="location" type="wstring">
9397	<desc>
9398	Location of the storage unit holding medium data.
9399
9400	The format of the location string is medium type specific. For medium
9401	types using regular files in a host's file system, the location
9402	string is the full file name.
9403
9404	Some medium types may support changing the storage unit location by
9405	simply changing the value of this property. If this operation is not
9406	supported, the implementation will return E_NOTIMPL in attempt to set
9407	this attribute's value.
9408
9409	When setting a value of the location attribute which is a regular file
9410	in the host's file system, the given file name may be either relative to
9411	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9412	absolute. Note that if the given location specification does not contain
9413	the file extension part then a proper default extension will be
9414	automatically appended by the implementation depending on the medium type.
9415	</desc>
9416	</attribute>
9417
9418	<attribute name="name" type="wstring" readonly="yes">
9419	<desc>
9420	Name of the storage unit holding medium data.
9421
9422	The returned string is a short version of the <link to="#location"/>
9423	attribute that is suitable for representing the medium in situations
9424	where the full location specification is too long (such as lists
9425	and comboboxes in GUI frontends). This string is also used by frontends
9426	to sort the media list alphabetically when needed.
9427
9428	For example, for locations that are regular files in the host's file
9429	system, the value of this attribute is just the file name (+ extension),
9430	without the path specification.
9431
9432	Note that as opposed to the <link to="#location"/> attribute, the name
9433	attribute will not necessary be unique for a list of media of the
9434	given type and format.
9435	</desc>
9436	</attribute>
9437
9438	<attribute name="deviceType" type="DeviceType" readonly="yes">
9439	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9440	medium.</desc>
9441	</attribute>
9442
9443	<attribute name="hostDrive" type="boolean" readonly="yes">
9444	<desc>True if this corresponds to a drive on the host.</desc>
9445	</attribute>
9446
9447	<attribute name="size" type="unsigned long long" readonly="yes">
9448	<desc>
9449	Physical size of the storage unit used to hold medium data (in bytes).
9450
9451	<note>
9452	For media whose <link to="#state"/> is <link
9453	to="MediumState_Inaccessible"/>, the value of this property is the
9454	last known size. For <link to="MediumState_NotCreated"/> media,
9455	the returned value is zero.
9456	</note>
9457	</desc>
9458	</attribute>
9459
9460	<attribute name="format" type="wstring" readonly="yes">
9461	<desc>
9462	Storage format of this medium.
9463
9464	The value of this attribute is a string that specifies a backend used
9465	to store medium data. The storage format is defined when you create a
9466	new medium or automatically detected when you open an existing medium,
9467	and cannot be changed later.
9468
9469	The list of all storage formats supported by this VirtualBox
9470	installation can be obtained using
9471	<link to="ISystemProperties::mediumFormats"/>.
9472	</desc>
9473	</attribute>
9474
9475	<attribute name="type" type="MediumType">
9476	<desc>
9477	Type (role) of this medium.
9478
9479	The following constraints apply when changing the value of this
9480	attribute:
9481	<ul>
9482	<li>If a medium is attached to a virtual machine (either in the
9483	current state or in one of the snapshots), its type cannot be
9484	changed.
9485	</li>
9486	<li>As long as the medium has children, its type cannot be set
9487	to <link to="MediumType_Writethrough"/>.
9488	</li>
9489	<li>The type of all differencing media is
9490	<link to="MediumType_Normal"/> and cannot be changed.
9491	</li>
9492	</ul>
9493
9494	The type of a newly created or opened medium is set to
9495	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9496	which have a type of <link to="MediumType_Writethrough"/>.
9497	</desc>
9498	</attribute>
9499
9500	<attribute name="parent" type="IMedium" readonly="yes">
9501	<desc>
9502	Parent of this medium (the medium this medium is directly based
9503	on).
9504
9505	Only differencing media have parents. For base (non-differencing)
9506	media, @c null is returned.
9507	</desc>
9508	</attribute>
9509
9510	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9511	<desc>
9512	Children of this medium (all differencing media directly based
9513	on this medium). A @c null array is returned if this medium
9514	does not have any children.
9515	</desc>
9516	</attribute>
9517
9518	<attribute name="base" type="IMedium" readonly="yes">
9519	<desc>
9520	Base medium of this medium.
9521
9522	If this is a differencing medium, its base medium is the medium
9523	the given medium branch starts from. For all other types of media, this
9524	property returns the medium object itself (i.e. the same object this
9525	property is read on).
9526	</desc>
9527	</attribute>
9528
9529	<attribute name="readOnly" type="boolean" readonly="yes">
9530	<desc>
9531	Returns @c true if this medium is read-only and @c false otherwise.
9532
9533	A medium is considered to be read-only when its contents cannot be
9534	modified without breaking the integrity of other parties that depend on
9535	this medium such as its child media or snapshots of virtual machines
9536	where this medium is attached to these machines. If there are no
9537	children and no such snapshots then there is no dependency and the
9538	medium is not read-only.
9539
9540	The value of this attribute can be used to determine the kind of the
9541	attachment that will take place when attaching this medium to a
9542	virtual machine. If the value is @c false then the medium will
9543	be attached directly. If the value is @c true then the medium
9544	will be attached indirectly by creating a new differencing child
9545	medium for that. See the interface description for more information.
9546
9547	Note that all <link to="MediumType_Immutable">Immutable</link> media
9548	are always read-only while all
9549	<link to="MediumType_Writethrough">Writethrough</link> media are
9550	always not.
9551
9552	<note>
9553	The read-only condition represented by this attribute is related to
9554	the medium type and usage, not to the current
9555	<link to="IMedium::state">medium state</link> and not to the read-only
9556	state of the storage unit.
9557	</note>
9558	</desc>
9559	</attribute>
9560
9561	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9562	<desc>
9563	Logical size of this medium (in megabytes), as reported to the
9564	guest OS running inside the virtual machine this medium is
9565	attached to. The logical size is defined when the medium is created
9566	and cannot be changed later.
9567
9568	<note>
9569	Reading this property on a differencing medium will return the size
9570	of its <link to="#base"/> medium.
9571	</note>
9572	<note>
9573	For media whose state is <link to="#state"/> is <link
9574	to="MediumState_Inaccessible"/>, the value of this property is the
9575	last known logical size. For <link to="MediumaState_NotCreated"/>
9576	media, the returned value is zero.
9577	</note>
9578	</desc>
9579	</attribute>
9580
9581	<attribute name="autoReset" type="boolean">
9582	<desc>
9583	Whether this differencing medium will be automatically reset each
9584	time a virtual machine it is attached to is powered up. This
9585	attribute is automatically set to @c true for the last
9586	differencing image of an "immutable" medium (see
9587	<link to="MediumType" />).
9588
9589	See <link to="#reset"/> for more information about resetting
9590	differencing media.
9591
9592	<note>
9593	Reading this property on a base (non-differencing) medium will
9594	always @c false. Changing the value of this property in this
9595	case is not supported.
9596	</note>
9597
9598	<result name="VBOX_E_NOT_SUPPORTED">
9599	This is not a differencing medium (when changing the attribute
9600	value).
9601	</result>
9602	</desc>
9603	</attribute>
9604
9605	<attribute name="lastAccessError" type="wstring" readonly="yes">
9606	<desc>
9607	Text message that represents the result of the last accessibility
9608	check performed by <link to="#refreshState"/>.
9609
9610	An empty string is returned if the last accessibility check
9611	was successful or has not yet been called. As a result, if
9612	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9613	then <link to="#refreshState"/> has yet to be called; this is the
9614	default value of media after VirtualBox initialization.
9615	A non-empty string indicates a failure and should normally describe
9616	a reason of the failure (for example, a file read error).
9617	</desc>
9618	</attribute>
9619
9620	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9621	<desc>
9622	Array of UUIDs of all machines this medium is attached to.
9623
9624	A @c null array is returned if this medium is not attached to any
9625	machine or to any machine's snapshot.
9626
9627	<note>
9628	The returned array will include a machine even if this medium is not
9629	attached to that machine in the current state but attached to it in
9630	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9631	details.
9632	</note>
9633	</desc>
9634	</attribute>
9635
9636	<method name="refreshState">
9637	<desc>
9638	If the current medium state (see <link to="MediumState"/>) is one of
9639	"Created", "Inaccessible" or "LockedRead", then this performs an
9640	accessibility check on the medium and sets the value of the <link to="#state"/>
9641	attribute accordingly; that value is also returned for convenience.
9642
9643	For all other state values, this does not perform a refresh but returns
9644	the state only.
9645
9646	The refresh, if performed, may take a long time (several seconds or even
9647	minutes, depending on the storage unit location and format) because it performs an
9648	accessibility check of the storage unit. This check may cause a significant
9649	delay if the storage unit of the given medium is, for example, a file located
9650	on a network share which is not currently accessible due to connectivity
9651	problems. In that case, the call will not return until a timeout
9652	interval defined by the host OS for this operation expires. For this reason,
9653	it is recommended to never read this attribute on the main UI thread to avoid
9654	making the UI unresponsive.
9655
9656	If the last known state of the medium is "Created" and the accessibility
9657	check fails, then the state would be set to "Inaccessible", and
9658	<link to="#lastAccessError"/> may be used to get more details about the
9659	failure. If the state of the medium is "LockedRead", then it remains the
9660	same, and a non-empty value of <link to="#lastAccessError"/> will
9661	indicate a failed accessibility check in this case.
9662
9663	Note that not all medium states are applicable to all medium types.
9664	</desc>
9665	<param name="state" type="MediumState" dir="return">
9666	<desc>
9667	New medium state.
9668	</desc>
9669	</param>
9670	</method>
9671
9672	<method name="getSnapshotIds">
9673	<desc>
9674	Returns an array of UUIDs of all snapshots of the given machine where
9675	this medium is attached to.
9676
9677	If the medium is attached to the machine in the current state, then the
9678	first element in the array will always be the ID of the queried machine
9679	(i.e. the value equal to the @c machineId argument), followed by
9680	snapshot IDs (if any).
9681
9682	If the medium is not attached to the machine in the current state, then
9683	the array will contain only snapshot IDs.
9684
9685	The returned array may be @c null if this medium is not attached
9686	to the given machine at all, neither in the current state nor in one of
9687	the snapshots.
9688	</desc>
9689	<param name="machineId" type="uuid" mod="string" dir="in">
9690	<desc>
9691	UUID of the machine to query.
9692	</desc>
9693	</param>
9694	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9695	<desc>
9696	Array of snapshot UUIDs of the given machine using this medium.
9697	</desc>
9698	</param>
9699	</method>
9700
9701	<method name="lockRead">
9702	<desc>
9703	Locks this medium for reading.
9704
9705	A read lock is shared: many clients can simultaneously lock the
9706	same medium for reading unless it is already locked for writing (see
9707	<link to="#lockWrite"/>) in which case an error is returned.
9708
9709	When the medium is locked for reading, it cannot be modified
9710	from within VirtualBox. This means that any method that changes
9711	the properties of this medium or contents of the storage unit
9712	will return an error (unless explicitly stated otherwise). That
9713	includes an attempt to start a virtual machine that wants to
9714	write to the the medium.
9715
9716	When the virtual machine is started up, it locks for reading all
9717	media it uses in read-only mode. If some medium cannot be locked
9718	for reading, the startup procedure will fail.
9719	A medium is typically locked for reading while it is used by a running
9720	virtual machine but has a depending differencing image that receives
9721	the actual write operations. This way one base medium can have
9722	multiple child differencing images which can be written to
9723	simultaneously. Read-only media such as DVD and floppy images are
9724	also locked for reading only (so they can be in use by multiple
9725	machines simultaneously).
9726
9727	A medium is also locked for reading when it is the source of a
9728	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9729
9730	The medium locked for reading must be unlocked using the <link
9731	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9732	can be nested and must be followed by the same number of paired
9733	<link to="#unlockRead"/> calls.
9734
9735	This method sets the medium state (see <link to="#state"/>) to
9736	"LockedRead" on success. The medium's previous state must be
9737	one of "Created", "Inaccessible" or "LockedRead".
9738
9739	Locking an inaccessible medium is not an error; this method performs
9740	a logical lock that prevents modifications of this medium through
9741	the VirtualBox API, not a physical file-system lock of the underlying
9742	storage unit.
9743
9744	This method returns the current state of the medium
9745	<i>before</i> the operation.
9746
9747	<result name="VBOX_E_INVALID_OBJECT_STATE">
9748	Invalid medium state (e.g. not created, locked, inaccessible,
9749	creating, deleting).
9750	</result>
9751
9752	</desc>
9753	<param name="state" type="MediumState" dir="return">
9754	<desc>
9755	State of the medium after the operation.
9756	</desc>
9757	</param>
9758	</method>
9759
9760	<method name="unlockRead">
9761	<desc>
9762	Cancels the read lock previously set by <link to="#lockRead"/>.
9763
9764	For both success and failure, this method returns the current state
9765	of the medium <i>after</i> the operation.
9766
9767	See <link to="#lockRead"/> for more details.
9768
9769	<result name="VBOX_E_INVALID_OBJECT_STATE">
9770	Medium not locked for reading.
9771	</result>
9772
9773	</desc>
9774	<param name="state" type="MediumState" dir="return">
9775	<desc>
9776	State of the medium after the operation.
9777	</desc>
9778	</param>
9779	</method>
9780
9781	<method name="lockWrite">
9782	<desc>
9783	Locks this medium for writing.
9784
9785	A write lock, as opposed to <link to="#lockRead"/>, is
9786	exclusive: there may be only one client holding a write lock,
9787	and there may be no read locks while the write lock is held.
9788	As a result, read-locking fails if a write lock is held, and
9789	write-locking fails if either a read or another write lock is held.
9790
9791	When a medium is locked for writing, it cannot be modified
9792	from within VirtualBox, and it is not guaranteed that the values
9793	of its properties are up-to-date. Any method that changes the
9794	properties of this medium or contents of the storage unit will
9795	return an error (unless explicitly stated otherwise).
9796
9797	When a virtual machine is started up, it locks for writing all
9798	media it uses to write data to. If any medium could not be locked
9799	for writing, the startup procedure will fail. If a medium has
9800	differencing images, then while the machine is running, only
9801	the last ("leaf") differencing image is locked for writing,
9802	whereas its parents are locked for reading only.
9803
9804	A medium is also locked for writing when it is the target of a
9805	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9806
9807	The medium locked for writing must be unlocked using the <link
9808	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9809
9810	This method sets the medium state (see <link to="#state"/>) to
9811	"LockedWrite" on success. The medium's previous state must be
9812	either "Created" or "Inaccessible".
9813
9814	Locking an inaccessible medium is not an error; this method performs
9815	a logical lock that prevents modifications of this medium through
9816	the VirtualBox API, not a physical file-system lock of the underlying
9817	storage unit.
9818
9819	For both, success and failure, this method returns the current
9820	state of the medium <i>before</i> the operation.
9821
9822	<result name="VBOX_E_INVALID_OBJECT_STATE">
9823	Invalid medium state (e.g. not created, locked, inaccessible,
9824	creating, deleting).
9825	</result>
9826
9827	</desc>
9828	<param name="state" type="MediumState" dir="return">
9829	<desc>
9830	State of the medium after the operation.
9831	</desc>
9832	</param>
9833	</method>
9834
9835	<method name="unlockWrite">
9836	<desc>
9837	Cancels the write lock previously set by <link to="#lockWrite"/>.
9838
9839	For both success and failure, this method returns the current
9840	state of the medium <i>after</i> the operation.
9841
9842	See <link to="#lockWrite"/> for more details.
9843
9844	<result name="VBOX_E_INVALID_OBJECT_STATE">
9845	Medium not locked for writing.
9846	</result>
9847
9848	</desc>
9849	<param name="state" type="MediumState" dir="return">
9850	<desc>
9851	State of the medium after the operation.
9852	</desc>
9853	</param>
9854	</method>
9855
9856	<method name="close">
9857	<desc>
9858	Closes this medium.
9859
9860	The medium must not be attached to any known virtual machine
9861	and must not have any known child media, otherwise the
9862	operation will fail.
9863
9864	When the medium is successfully closed, it gets removed from
9865	the list of remembered media, but its storage unit is not
9866	deleted. In particular, this means that this medium can be
9867	later opened again using the <link
9868	to="IVirtualBox::openHardDisk"/> call.
9869
9870	Note that after this method successfully returns, the given medium
9871	object becomes uninitialized. This means that any attempt
9872	to call any of its methods or attributes will fail with the
9873	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9874
9875	<result name="VBOX_E_INVALID_OBJECT_STATE">
9876	Invalid medium state (other than not created, created or
9877	inaccessible).
9878	</result>
9879	<result name="VBOX_E_OBJECT_IN_USE">
9880	Medium attached to virtual machine.
9881	</result>
9882	<result name="VBOX_E_FILE_ERROR">
9883	Settings file not accessible.
9884	</result>
9885	<result name="VBOX_E_XML_ERROR">
9886	Could not parse the settings file.
9887	</result>
9888
9889	</desc>
9890	</method>
9891
9892	<!-- storage methods -->
9893
9894	<method name="getProperty">
9895	<desc>
9896	Returns the value of the custom medium property with the given name.
9897
9898	The list of all properties supported by the given medium format can
9899	be obtained with <link to="IMediumFormat::describeProperties"/>.
9900
9901	Note that if this method returns an empty string in @a value, the
9902	requested property is supported but currently not assigned any value.
9903
9904	<result name="VBOX_E_OBJECT_NOT_FOUND">
9905	Requested property does not exist (not supported by the format).
9906	</result>
9907	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9908	</desc>
9909	<param name="name" type="wstring" dir="in">
9910	<desc>Name of the property to get.</desc>
9911	</param>
9912	<param name="value" type="wstring" dir="return">
9913	<desc>Current property value.</desc>
9914	</param>
9915	</method>
9916
9917	<method name="setProperty">
9918	<desc>
9919	Sets the value of the custom medium property with the given name.
9920
9921	The list of all properties supported by the given medium format can
9922	be obtained with <link to="IMediumFormat::describeProperties"/>.
9923
9924	Note that setting the property value to @c null or an empty string is
9925	equivalent to deleting the existing value. A default value (if it is
9926	defined for this property) will be used by the format backend in this
9927	case.
9928
9929	<result name="VBOX_E_OBJECT_NOT_FOUND">
9930	Requested property does not exist (not supported by the format).
9931	</result>
9932	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9933	</desc>
9934	<param name="name" type="wstring" dir="in">
9935	<desc>Name of the property to set.</desc>
9936	</param>
9937	<param name="value" type="wstring" dir="in">
9938	<desc>Property value to set.</desc>
9939	</param>
9940	</method>
9941
9942	<method name="getProperties">
9943	<desc>
9944	Returns values for a group of properties in one call.
9945
9946	The names of the properties to get are specified using the @a names
9947	argument which is a list of comma-separated property names or
9948	an empty string if all properties are to be returned. Note that currently
9949	the value of this argument is ignored and the method always returns all
9950	existing properties.
9951
9952	The list of all properties supported by the given medium format can
9953	be obtained with <link to="IMediumFormat::describeProperties"/>.
9954
9955	The method returns two arrays, the array of property names corresponding
9956	to the @a names argument and the current values of these properties.
9957	Both arrays have the same number of elements with each elemend at the
9958	given index in the first array corresponds to an element at the same
9959	index in the second array.
9960
9961	Note that for properties that do not have assigned values,
9962	an empty string is returned at the appropriate index in the
9963	@a returnValues array.
9964
9965	</desc>
9966	<param name="names" type="wstring" dir="in">
9967	<desc>
9968	Names of properties to get.
9969	</desc>
9970	</param>
9971	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9972	<desc>Names of returned properties.</desc>
9973	</param>
9974	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9975	<desc>Values of returned properties.</desc>
9976	</param>
9977	</method>
9978
9979	<method name="setProperties">
9980	<desc>
9981	Sets values for a group of properties in one call.
9982
9983	The names of the properties to set are passed in the @a names
9984	array along with the new values for them in the @a values array. Both
9985	arrays have the same number of elements with each elemend at the given
9986	index in the first array corresponding to an element at the same index
9987	in the second array.
9988
9989	If there is at least one property name in @a names that is not valid,
9990	the method will fail before changing the values of any other properties
9991	from the @a names array.
9992
9993	Using this method over <link to="#setProperty"/> is preferred if you
9994	need to set several properties at once since it will result into less
9995	IPC calls.
9996
9997	The list of all properties supported by the given medium format can
9998	be obtained with <link to="IMediumFormat::describeProperties"/>.
9999
10000	Note that setting the property value to @c null or an empty string is
10001	equivalent to deleting the existing value. A default value (if it is
10002	defined for this property) will be used by the format backend in this
10003	case.
10004	</desc>
10005	<param name="names" type="wstring" safearray="yes" dir="in">
10006	<desc>Names of properties to set.</desc>
10007	</param>
10008	<param name="values" type="wstring" safearray="yes" dir="in">
10009	<desc>Values of properties to set.</desc>
10010	</param>
10011	</method>
10012
10013	<!-- storage methods -->
10014
10015	<method name="createBaseStorage">
10016	<desc>
10017	Starts creating a hard disk storage unit (fixed/dynamic, according
10018	to the variant flags) in in the background. The previous storage unit
10019	created for this object, if any, must first be deleted using
10020	<link to="#deleteStorage"/>, otherwise the operation will fail.
10021
10022	Before the operation starts, the medium is placed in
10023	<link to="MediumState_Creating"/> state. If the create operation
10024	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10025	state.
10026
10027	After the returned progress object reports that the operation has
10028	successfully completed, the medium state will be set to <link
10029	to="MediumState_Created"/>, the medium will be remembered by this
10030	VirtualBox installation and may be attached to virtual machines.
10031
10032	<result name="VBOX_E_NOT_SUPPORTED">
10033	The variant of storage creation operation is not supported. See <link
10034	to="IMediumFormat::capabilities"/>.
10035	</result>
10036	</desc>
10037	<param name="logicalSize" type="unsigned long long" dir="in">
10038	<desc>Maximum logical size of the medium in megabytes.</desc>
10039	</param>
10040	<param name="variant" type="MediumVariant" dir="in">
10041	<desc>Exact image variant which should be created.</desc>
10042	</param>
10043	<param name="progress" type="IProgress" dir="return">
10044	<desc>Progress object to track the operation completion.</desc>
10045	</param>
10046	</method>
10047
10048	<method name="deleteStorage">
10049	<desc>
10050	Starts deleting the storage unit of this medium.
10051
10052	The medium must not be attached to any known virtual machine and must
10053	not have any known child media, otherwise the operation will fail.
10054	It will also fail if there is no storage unit to delete or if deletion
10055	is already in progress, or if the medium is being in use (locked for
10056	read or for write) or inaccessible. Therefore, the only valid state for
10057	this operation to succeed is <link to="MediumState_Created"/>.
10058
10059	Before the operation starts, the medium is placed in
10060	<link to="MediumState_Deleting"/> state and gets removed from the list
10061	of remembered hard disks (media registry). If the delete operation
10062	fails, the medium will be remembered again and placed back to
10063	<link to="MediumState_Created"/> state.
10064
10065	After the returned progress object reports that the operation is
10066	complete, the medium state will be set to
10067	<link to="MediumState_NotCreated"/> and you will be able to use one of
10068	the storage creation methods to create it again.
10069
10070	<see>#close()</see>
10071
10072	<result name="VBOX_E_OBJECT_IN_USE">
10073	Medium is attached to a virtual machine.
10074	</result>
10075	<result name="VBOX_E_NOT_SUPPORTED">
10076	Storage deletion is not allowed because neither of storage creation
10077	operations are supported. See
10078	<link to="IMediumFormat::capabilities"/>.
10079	</result>
10080
10081	<note>
10082	If the deletion operation fails, it is not guaranteed that the storage
10083	unit still exists. You may check the <link to="IMedium::state"/> value
10084	to answer this question.
10085	</note>
10086	</desc>
10087	<param name="progress" type="IProgress" dir="return">
10088	<desc>Progress object to track the operation completion.</desc>
10089	</param>
10090	</method>
10091
10092	<!-- diff methods -->
10093
10094	<method name="createDiffStorage">
10095	<desc>
10096	Starts creating an empty differencing storage unit based on this
10097	medium in the format and at the location defined by the @a target
10098	argument.
10099
10100	The target medium must be in <link to="MediumState_NotCreated"/>
10101	state (i.e. must not have an existing storage unit). Upon successful
10102	completion, this operation will set the type of the target medium to
10103	<link to="MediumType_Normal"/> and create a storage unit necessary to
10104	represent the differencing medium data in the given format (according
10105	to the storage format of the target object).
10106
10107	After the returned progress object reports that the operation is
10108	successfully complete, the target medium gets remembered by this
10109	VirtualBox installation and may be attached to virtual machines.
10110
10111	<note>
10112	The medium will be set to <link to="MediumState_LockedRead"/>
10113	state for the duration of this operation.
10114	</note>
10115	<result name="VBOX_E_OBJECT_IN_USE">
10116	Medium not in @c NotCreated state.
10117	</result>
10118	</desc>
10119	<param name="target" type="IMedium" dir="in">
10120	<desc>Target medium.</desc>
10121	</param>
10122	<param name="variant" type="MediumVariant" dir="in">
10123	<desc>Exact image variant which should be created.</desc>
10124	</param>
10125	<param name="progress" type="IProgress" dir="return">
10126	<desc>Progress object to track the operation completion.</desc>
10127	</param>
10128	</method>
10129
10130	<method name="mergeTo">
10131	<desc>
10132	Starts merging the contents of this medium and all intermediate
10133	differencing media in the chain to the given target medium.
10134
10135	The target medium must be either a descendant of this medium or
10136	its ancestor (otherwise this method will immediately return a failure).
10137	It follows that there are two logical directions of the merge operation:
10138	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10139	ancestor (<i>backward merge</i>). Let us consider the following medium
10140	chain:
10141
10142	<pre>Base <- Diff_1 <- Diff_2</pre>
10143
10144	Here, calling this method on the <tt>Base</tt> medium object with
10145	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10146	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10147	merge. Note that in both cases the contents of the resulting medium
10148	will be the same, the only difference is the medium object that takes
10149	the result of the merge operation. In case of the forward merge in the
10150	above example, the result will be written to <tt>Diff_2</tt>; in case of
10151	the backward merge, the result will be written to <tt>Base</tt>. In
10152	other words, the result of the operation is always stored in the target
10153	medium.
10154
10155	Upon successful operation completion, the storage units of all media in
10156	the chain between this (source) medium and the target medium, including
10157	the source medium itself, will be automatically deleted and the
10158	relevant medium objects (including this medium) will become
10159	uninitialized. This means that any attempt to call any of
10160	their methods or attributes will fail with the
10161	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10162	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10163	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10164	Note that <tt>Diff_2</tt> in this case will become a base medium
10165	itself since it will no longer be based on any other medium.
10166
10167	Considering the above, all of the following conditions must be met in
10168	order for the merge operation to succeed:
10169	<ul>
10170	<li>
10171	Neither this (source) medium nor any intermediate
10172	differencing medium in the chain between it and the target
10173	medium is attached to any virtual machine.
10174	</li>
10175	<li>
10176	Neither the source medium nor the target medium is an
10177	<link to="MediumType_Immutable"/> medium.
10178	</li>
10179	<li>
10180	The part of the medium tree from the source medium to the
10181	target medium is a linear chain, i.e. all medium in this
10182	chain have exactly one child which is the next medium in this
10183	chain. The only exception from this rule is the target medium in
10184	the forward merge operation; it is allowed to have any number of
10185	child media because the merge operation will not change its
10186	logical contents (as it is seen by the guest OS or by children).
10187	</li>
10188	<li>
10189	None of the involved media are in
10190	<link to="MediumState_LockedRead"/> or
10191	<link to="MediumState_LockedWrite"/> state.
10192	</li>
10193	</ul>
10194
10195	<note>
10196	This (source) medium and all intermediates will be placed to <link
10197	to="MediumState_Deleting"/> state and the target medium will be
10198	placed to <link to="MediumState_LockedWrite"/> state and for the
10199	duration of this operation.
10200	</note>
10201	</desc>
10202	<param name="targetId" type="uuid" mod="string" dir="in">
10203	<desc>UUID of the target ancestor or descendant medium.</desc>
10204	</param>
10205	<param name="progress" type="IProgress" dir="return">
10206	<desc>Progress object to track the operation completion.</desc>
10207	</param>
10208	</method>
10209
10210	<!-- clone method -->
10211
10212	<method name="cloneTo">
10213	<desc>
10214	Starts creating a clone of this medium in the format and at the
10215	location defined by the @a target argument.
10216
10217	The target medium must be either in <link to="MediumState_NotCreated"/>
10218	state (i.e. must not have an existing storage unit) or in
10219	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10220	big enough to hold the data or else the copy will be partial). Upon
10221	successful completion, the cloned medium will contain exactly the
10222	same sector data as the medium being cloned, except that in the
10223	first case a new UUID for the clone will be randomly generated, and in
10224	the second case the UUID will remain unchanged.
10225
10226	The @a parent argument defines which medium will be the parent
10227	of the clone. Passing a @c null reference indicates that the clone will
10228	be a base image, i.e. completely independent. It is possible to specify
10229	an arbitrary medium for this parameter, including the parent of the
10230	medium which is being cloned. Even cloning to a child of the source
10231	medium is possible. Note that when cloning to an existing image, the
10232	@a parent irgument is ignored.
10233
10234	After the returned progress object reports that the operation is
10235	successfully complete, the target medium gets remembered by this
10236	VirtualBox installation and may be attached to virtual machines.
10237
10238	<note>
10239	This medium will be placed to <link to="MediumState_LockedRead"/>
10240	state for the duration of this operation.
10241	</note>
10242	<result name="E_NOTIMPL">
10243	The specified cloning variant is not supported at the moment.
10244	</result>
10245	</desc>
10246	<param name="target" type="IMedium" dir="in">
10247	<desc>Target medium.</desc>
10248	</param>
10249	<param name="variant" type="MediumVariant" dir="in">
10250	<desc>Exact image variant which should be created.</desc>
10251	</param>
10252	<param name="parent" type="IMedium" dir="in">
10253	<desc>Parent of the cloned medium.</desc>
10254	</param>
10255	<param name="progress" type="IProgress" dir="return">
10256	<desc>Progress object to track the operation completion.</desc>
10257	</param>
10258	</method>
10259
10260	<!-- other methods -->
10261
10262	<method name="compact">
10263	<desc>
10264	Starts compacting of this medium. This means that the medium is
10265	transformed into a possibly more compact storage representation.
10266	This potentially creates temporary images, which can require a
10267	substantial amount of additional disk space.
10268
10269	This medium will be placed to <link to="MediumState_LockedWrite"/>
10270	state and all its parent media (if any) will be placed to
10271	<link to="MediumState_LockedRead"/> state for the duration of this
10272	operation.
10273
10274	Please note that the results can be either returned straight away,
10275	or later as the result of the background operation via the object
10276	returned via the @a progress parameter.
10277
10278	<result name="VBOX_E_NOT_SUPPORTED">
10279	Medium format does not support compacting (but potentially
10280	needs it).
10281	</result>
10282	</desc>
10283	<param name="progress" type="IProgress" dir="return">
10284	<desc>Progress object to track the operation completion.</desc>
10285	</param>
10286	</method>
10287
10288	<method name="resize">
10289	<desc>
10290	Starts resizing this medium. This means that the nominal size of the
10291	medium is set to the new value. Both increasing and decreasing the
10292	size is possible, and there are no safety checks, since VirtualBox
10293	does not make any assumptions about the medium contents.
10294
10295	Resizing usually needs additional disk space, and possibly also
10296	some temporary disk space. Note that resize does not create a full
10297	temporary copy of the medium, so the additional disk space requirement
10298	is usually much lower than using the clone operation.
10299
10300	This medium will be placed to <link to="MediumState_LockedWrite"/>
10301	state for the duration of this operation.
10302
10303	Please note that the results can be either returned straight away,
10304	or later as the result of the background operation via the object
10305	returned via the @a progress parameter.
10306
10307	<result name="VBOX_E_NOT_SUPPORTED">
10308	Medium format does not support resizing.
10309	</result>
10310	</desc>
10311	<param name="logicalSize" type="unsigned long long" dir="in">
10312	<desc>New nominal capacity of the medium in megabytes.</desc>
10313	</param>
10314	<param name="progress" type="IProgress" dir="return">
10315	<desc>Progress object to track the operation completion.</desc>
10316	</param>
10317	</method>
10318
10319	<method name="reset">
10320	<desc>
10321	Starts erasing the contents of this differencing medium.
10322
10323	This operation will reset the differencing medium to its initial
10324	state when it does not contain any sector data and any read operation is
10325	redirected to its parent medium. This automatically gets called
10326	during VM power-up for every medium whose <link to="#autoReset" />
10327	attribute is @c true.
10328
10329	The medium will be write-locked for the duration of this operation (see
10330	<link to="#lockWrite" />).
10331
10332	<result name="VBOX_E_NOT_SUPPORTED">
10333	This is not a differencing medium.
10334	</result>
10335	<result name="VBOX_E_INVALID_OBJECT_STATE">
10336	Medium is not in <link to="MediumState_Created"/> or
10337	<link to="MediumState_Inaccessible"/> state.
10338	</result>
10339	</desc>
10340	<param name="progress" type="IProgress" dir="return">
10341	<desc>Progress object to track the operation completion.</desc>
10342	</param>
10343	</method>
10344
10345	</interface>
10346
10347
10348	<!--
10349	// IMediumFormat
10350	/////////////////////////////////////////////////////////////////////////
10351	-->
10352
10353	<enum
10354	name="DataType"
10355	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10356	>
10357	<const name="Int32" value="0"/>
10358	<const name="Int8" value="1"/>
10359	<const name="String" value="2"/>
10360	</enum>
10361
10362	<enum
10363	name="DataFlags"
10364	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10365	>
10366	<const name="None" value="0x00"/>
10367	<const name="Mandatory" value="0x01"/>
10368	<const name="Expert" value="0x02"/>
10369	<const name="Array" value="0x04"/>
10370	<const name="FlagMask" value="0x07"/>
10371	</enum>
10372
10373	<enum
10374	name="MediumFormatCapabilities"
10375	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10376	>
10377	<desc>
10378	Medium format capability flags.
10379	</desc>
10380
10381	<const name="Uuid" value="0x01">
10382	<desc>
10383	Supports UUIDs as expected by VirtualBox code.
10384	</desc>
10385	</const>
10386
10387	<const name="CreateFixed" value="0x02">
10388	<desc>
10389	Supports creating fixed size images, allocating all space instantly.
10390	</desc>
10391	</const>
10392
10393	<const name="CreateDynamic" value="0x04">
10394	<desc>
10395	Supports creating dynamically growing images, allocating space on
10396	demand.
10397	</desc>
10398	</const>
10399
10400	<const name="CreateSplit2G" value="0x08">
10401	<desc>
10402	Supports creating images split in chunks of a bit less than 2 GBytes.
10403	</desc>
10404	</const>
10405
10406	<const name="Differencing" value="0x10">
10407	<desc>
10408	Supports being used as a format for differencing media (see <link
10409	to="IMedium::createDiffStorage"/>).
10410	</desc>
10411	</const>
10412
10413	<const name="Asynchronous" value="0x20">
10414	<desc>
10415	Supports asynchronous I/O operations for at least some configurations.
10416	</desc>
10417	</const>
10418
10419	<const name="File" value="0x40">
10420	<desc>
10421	The format backend operates on files (the <link to="IMedium::location"/>
10422	attribute of the medium specifies a file used to store medium
10423	data; for a list of supported file extensions see
10424	<link to="IMediumFormat::fileExtensions"/>).
10425	</desc>
10426	</const>
10427
10428	<const name="Properties" value="0x80">
10429	<desc>
10430	The format backend uses the property interface to configure the storage
10431	location and properties (the <link to="IMediumFormat::describeProperties"/>
10432	method is used to get access to properties supported by the given medium format).
10433	</desc>
10434	</const>
10435
10436	<const name="CapabilityMask" value="0xFF"/>
10437	</enum>
10438
10439	<interface
10440	name="IMediumFormat" extends="$unknown"
10441	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10442	wsmap="managed"
10443	>
10444	<desc>
10445	The IMediumFormat interface represents a medium format.
10446
10447	Each medium format has an associated backend which is used to handle
10448	media stored in this format. This interface provides information
10449	about the properties of the associated backend.
10450
10451	Each medium format is identified by a string represented by the
10452	<link to="#id"/> attribute. This string is used in calls like
10453	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10454	format.
10455
10456	The list of all supported medium formats can be obtained using
10457	<link to="ISystemProperties::mediaFormats"/>.
10458
10459	<see>IMedium</see>
10460	</desc>
10461
10462	<attribute name="id" type="wstring" readonly="yes">
10463	<desc>
10464	Identifier of this format.
10465
10466	The format identifier is a non-@c null non-empty ASCII string. Note that
10467	this string is case-insensitive. This means that, for example, all of
10468	the following strings:
10469	<pre>
10470	"VDI"
10471	"vdi"
10472	"VdI"</pre>
10473	refer to the same medium format.
10474
10475	This string is used in methods of other interfaces where it is necessary
10476	to specify a medium format, such as
10477	<link to="IVirtualBox::createHardDisk"/>.
10478	</desc>
10479	</attribute>
10480
10481	<attribute name="name" type="wstring" readonly="yes">
10482	<desc>
10483	Human readable description of this format.
10484
10485	Mainly for use in file open dialogs.
10486	</desc>
10487	</attribute>
10488
10489	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10490	<desc>
10491	Array of strings containing the supported file extensions.
10492
10493	The first extension in the array is the extension preferred by the
10494	backend. It is recommended to use this extension when specifying a
10495	location of the storage unit for a new medium.
10496
10497	Note that some backends do not work on files, so this array may be
10498	empty.
10499
10500	<see>IMediumFormat::capabilities</see>
10501	</desc>
10502	</attribute>
10503
10504	<attribute name="capabilities" type="unsigned long" readonly="yes">
10505	<desc>
10506	Capabilities of the format as a set of bit flags.
10507
10508	For the meaning of individual capability flags see
10509	<link to="MediumFormatCapabilities"/>.
10510	</desc>
10511	</attribute>
10512
10513	<method name="describeProperties">
10514	<desc>
10515	Returns several arrays describing the properties supported by this
10516	format.
10517
10518	An element with the given index in each array describes one
10519	property. Thus, the number of elements in each returned array is the
10520	same and corresponds to the number of supported properties.
10521
10522	The returned arrays are filled in only if the
10523	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10524	All arguments must be non-@c null.
10525
10526	<see>DataType</see>
10527	<see>DataFlags</see>
10528	</desc>
10529
10530	<param name="names" type="wstring" safearray="yes" dir="out">
10531	<desc>Array of property names.</desc>
10532	</param>
10533	<param name="description" type="wstring" safearray="yes" dir="out">
10534	<desc>Array of property descriptions.</desc>
10535	</param>
10536	<param name="types" type="DataType" safearray="yes" dir="out">
10537	<desc>Array of property types.</desc>
10538	</param>
10539	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10540	<desc>Array of property flags.</desc>
10541	</param>
10542	<param name="defaults" type="wstring" safearray="yes" dir="out">
10543	<desc>Array of default property values.</desc>
10544	</param>
10545	</method>
10546
10547	</interface>
10548
10549
10550	<!--
10551	// IKeyboard
10552	/////////////////////////////////////////////////////////////////////////
10553	-->
10554
10555	<interface
10556	name="IKeyboard" extends="$unknown"
10557	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10558	wsmap="managed"
10559	>
10560	<desc>
10561	The IKeyboard interface represents the virtual machine's keyboard. Used
10562	in <link to="IConsole::keyboard"/>.
10563
10564	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10565	to the virtual machine.
10566
10567	</desc>
10568	<method name="putScancode">
10569	<desc>Sends a scancode to the keyboard.
10570
10571	<result name="VBOX_E_IPRT_ERROR">
10572	Could not send scan code to virtual keyboard.
10573	</result>
10574
10575	</desc>
10576	<param name="scancode" type="long" dir="in"/>
10577	</method>
10578
10579	<method name="putScancodes">
10580	<desc>Sends an array of scancodes to the keyboard.
10581
10582	<result name="VBOX_E_IPRT_ERROR">
10583	Could not send all scan codes to virtual keyboard.
10584	</result>
10585
10586	</desc>
10587	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10588	<param name="codesStored" type="unsigned long" dir="return"/>
10589	</method>
10590
10591	<method name="putCAD">
10592	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10593	function is nothing special, it is just a convenience function
10594	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10595
10596	<result name="VBOX_E_IPRT_ERROR">
10597	Could not send all scan codes to virtual keyboard.
10598	</result>
10599
10600	</desc>
10601	</method>
10602
10603	</interface>
10604
10605
10606	<!--
10607	// IMouse
10608	/////////////////////////////////////////////////////////////////////////
10609	-->
10610
10611	<enum
10612	name="MouseButtonState"
10613	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10614	>
10615	<desc>
10616	Mouse button state.
10617	</desc>
10618
10619	<const name="LeftButton" value="0x01"/>
10620	<const name="RightButton" value="0x02"/>
10621	<const name="MiddleButton" value="0x04"/>
10622	<const name="WheelUp" value="0x08"/>
10623	<const name="WheelDown" value="0x10"/>
10624	<const name="XButton1" value="0x20"/>
10625	<const name="XButton2" value="0x40"/>
10626	<const name="MouseStateMask" value="0x7F"/>
10627	</enum>
10628
10629	<interface
10630	name="IMouse" extends="$unknown"
10631	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10632	wsmap="managed"
10633	>
10634	<desc>
10635	The IMouse interface represents the virtual machine's mouse. Used in
10636	<link to="IConsole::mouse"/>.
10637
10638	Through this interface, the virtual machine's virtual mouse can be
10639	controlled.
10640	</desc>
10641
10642	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10643	<desc>
10644	Whether the guest OS supports absolute mouse pointer positioning
10645	or not.
10646	<note>
10647	VirtualBox Guest Tools need to be installed to the guest OS
10648	in order to enable absolute mouse positioning support.
10649	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10650	callback to be instantly informed about changes of this attribute
10651	during virtual machine execution.
10652	</note>
10653	<see><link to="#putMouseEventAbsolute"/></see>
10654	</desc>
10655	</attribute>
10656
10657	<method name="putMouseEvent">
10658	<desc>
10659	Initiates a mouse event using relative pointer movements
10660	along x and y axis.
10661
10662	<result name="E_ACCESSDENIED">
10663	Console not powered up.
10664	</result>
10665	<result name="VBOX_E_IPRT_ERROR">
10666	Could not send mouse event to virtual mouse.
10667	</result>
10668
10669	</desc>
10670
10671	<param name="dx" type="long" dir="in">
10672	<desc>
10673	Amount of pixels the mouse should move to the right.
10674	Negative values move the mouse to the left.
10675	</desc>
10676	</param>
10677	<param name="dy" type="long" dir="in">
10678	<desc>
10679	Amount of pixels the mouse should move downwards.
10680	Negative values move the mouse upwards.
10681	</desc>
10682	</param>
10683	<param name="dz" type="long" dir="in">
10684	<desc>
10685	Amount of mouse wheel moves.
10686	Positive values describe clockwise wheel rotations,
10687	negative values describe counterclockwise rotations.
10688	</desc>
10689	</param>
10690	<param name="dw" type="long" dir="in">
10691	<desc>
10692	Amount of horizontal mouse wheel moves.
10693	Positive values describe a movement to the left,
10694	negative values describe a movement to the right.
10695	</desc>
10696	</param>
10697	<param name="buttonState" type="long" dir="in">
10698	<desc>
10699	The current state of mouse buttons. Every bit represents
10700	a mouse button as follows:
10701	<table>
10702	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10703	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10704	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10705	</table>
10706	A value of <tt>1</tt> means the corresponding button is pressed.
10707	otherwise it is released.
10708	</desc>
10709	</param>
10710	</method>
10711
10712	<method name="putMouseEventAbsolute">
10713	<desc>
10714	Positions the mouse pointer using absolute x and y coordinates.
10715	These coordinates are expressed in pixels and
10716	start from <tt>[1,1]</tt> which corresponds to the top left
10717	corner of the virtual display.
10718
10719	<result name="E_ACCESSDENIED">
10720	Console not powered up.
10721	</result>
10722	<result name="VBOX_E_IPRT_ERROR">
10723	Could not send mouse event to virtual mouse.
10724	</result>
10725
10726	<note>
10727	This method will have effect only if absolute mouse
10728	positioning is supported by the guest OS.
10729	</note>
10730
10731	<see><link to="#absoluteSupported"/></see>
10732	</desc>
10733
10734	<param name="x" type="long" dir="in">
10735	<desc>
10736	X coordinate of the pointer in pixels, starting from @c 1.
10737	</desc>
10738	</param>
10739	<param name="y" type="long" dir="in">
10740	<desc>
10741	Y coordinate of the pointer in pixels, starting from @c 1.
10742	</desc>
10743	</param>
10744	<param name="dz" type="long" dir="in">
10745	<desc>
10746	Amount of mouse wheel moves.
10747	Positive values describe clockwise wheel rotations,
10748	negative values describe counterclockwise rotations.
10749	</desc>
10750	</param>
10751	<param name="dw" type="long" dir="in">
10752	<desc>
10753	Amount of horizontal mouse wheel moves.
10754	Positive values describe a movement to the left,
10755	negative values describe a movement to the right.
10756	</desc>
10757	</param>
10758	<param name="buttonState" type="long" dir="in">
10759	<desc>
10760	The current state of mouse buttons. Every bit represents
10761	a mouse button as follows:
10762	<table>
10763	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10764	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10765	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10766	</table>
10767	A value of @c 1 means the corresponding button is pressed.
10768	otherwise it is released.
10769	</desc>
10770	</param>
10771	</method>
10772
10773	</interface>
10774
10775	<!--
10776	// IDisplay
10777	/////////////////////////////////////////////////////////////////////////
10778	-->
10779
10780	<enum
10781	name="FramebufferPixelFormat"
10782	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10783	>
10784	<desc>
10785	Format of the video memory buffer. Constants represented by this enum can
10786	be used to test for particular values of <link
10787	to="IFramebuffer::pixelFormat"/>. See also <link
10788	to="IFramebuffer::requestResize"/>.
10789
10790	See also www.fourcc.org for more information about FOURCC pixel formats.
10791	</desc>
10792
10793	<const name="Opaque" value="0">
10794	<desc>
10795	Unknown buffer format (the user may not assume any particular format of
10796	the buffer).
10797	</desc>
10798	</const>
10799	<const name="FOURCC_RGB" value="0x32424752">
10800	<desc>
10801	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10802	bit layout).
10803	</desc>
10804	</const>
10805	</enum>
10806
10807	<interface
10808	name="IFramebuffer" extends="$unknown"
10809	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10810	wsmap="suppress"
10811	>
10812	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10813	<desc>Address of the start byte of the frame buffer.</desc>
10814	</attribute>
10815
10816	<attribute name="width" type="unsigned long" readonly="yes">
10817	<desc>Frame buffer width, in pixels.</desc>
10818	</attribute>
10819
10820	<attribute name="height" type="unsigned long" readonly="yes">
10821	<desc>Frame buffer height, in pixels.</desc>
10822	</attribute>
10823
10824	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10825	<desc>
10826	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10827	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10828	are: 8, 15, 16, 24 and 32.
10829	</desc>
10830	</attribute>
10831
10832	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10833	<desc>
10834	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10835	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10836	size of the scan line must be aligned to 32 bits.
10837	</desc>
10838	</attribute>
10839
10840	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10841	<desc>
10842	Frame buffer pixel format. It's either one of the values defined by <link
10843	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10844	<note>
10845	This attribute must never return <link
10846	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10847	<link to="#address"/> points to must be always known.
10848	</note>
10849	</desc>
10850	</attribute>
10851
10852	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10853	<desc>
10854	Defines whether this frame buffer uses the virtual video card's memory
10855	buffer (guest VRAM) directly or not. See <link
10856	to="IFramebuffer::requestResize"/> for more information.
10857	</desc>
10858	</attribute>
10859
10860	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10861	<desc>
10862	Hint from the frame buffer about how much of the standard
10863	screen height it wants to use for itself. This information is
10864	exposed to the guest through the VESA BIOS and VMMDev interface
10865	so that it can use it for determining its video mode table. It
10866	is not guaranteed that the guest respects the value.
10867	</desc>
10868	</attribute>
10869
10870	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10871	<desc>
10872	An alpha-blended overlay which is superposed over the frame buffer.
10873	The initial purpose is to allow the display of icons providing
10874	information about the VM state, including disk activity, in front
10875	ends which do not have other means of doing that. The overlay is
10876	designed to controlled exclusively by IDisplay. It has no locking
10877	of its own, and any changes made to it are not guaranteed to be
10878	visible until the affected portion of IFramebuffer is updated. The
10879	overlay can be created lazily the first time it is requested. This
10880	attribute can also return @c null to signal that the overlay is not
10881	implemented.
10882	</desc>
10883	</attribute>
10884
10885	<attribute name="winId" type="unsigned long long" readonly="yes">
10886	<desc>
10887	Platform-dependent identifier of the window where context of this
10888	frame buffer is drawn, or zero if there's no such window.
10889	</desc>
10890	</attribute>
10891
10892	<method name="lock">
10893	<desc>
10894	Locks the frame buffer.
10895	Gets called by the IDisplay object where this frame buffer is
10896	bound to.
10897	</desc>
10898	</method>
10899
10900	<method name="unlock">
10901	<desc>
10902	Unlocks the frame buffer.
10903	Gets called by the IDisplay object where this frame buffer is
10904	bound to.
10905	</desc>
10906	</method>
10907
10908	<method name="notifyUpdate">
10909	<desc>
10910	Informs about an update.
10911	Gets called by the display object where this buffer is
10912	registered.
10913	</desc>
10914	<param name="x" type="unsigned long" dir="in"/>
10915	<param name="y" type="unsigned long" dir="in"/>
10916	<param name="width" type="unsigned long" dir="in"/>
10917	<param name="height" type="unsigned long" dir="in"/>
10918	</method>
10919
10920	<method name="requestResize">
10921	<desc>
10922	Requests a size and pixel format change.
10923
10924	There are two modes of working with the video buffer of the virtual
10925	machine. The <i>indirect</i> mode implies that the IFramebuffer
10926	implementation allocates a memory buffer for the requested display mode
10927	and provides it to the virtual machine. In <i>direct</i> mode, the
10928	IFramebuffer implementation uses the memory buffer allocated and owned
10929	by the virtual machine. This buffer represents the video memory of the
10930	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10931	usually faster because the implementation gets a raw pointer to the
10932	guest VRAM buffer which it can directly use for visualizing the contents
10933	of the virtual display, as opposed to the indirect mode where the
10934	contents of guest VRAM are copied to the memory buffer provided by
10935	the implementation every time a display update occurs.
10936
10937	It is important to note that the direct mode is really fast only when
10938	the implementation uses the given guest VRAM buffer directly, for
10939	example, by blitting it to the window representing the virtual machine's
10940	display, which saves at least one copy operation comparing to the
10941	indirect mode. However, using the guest VRAM buffer directly is not
10942	always possible: the format and the color depth of this buffer may be
10943	not supported by the target window, or it may be unknown (opaque) as in
10944	case of text or non-linear multi-plane VGA video modes. In this case,
10945	the indirect mode (that is always available) should be used as a
10946	fallback: when the guest VRAM contents are copied to the
10947	implementation-provided memory buffer, color and format conversion is
10948	done automatically by the underlying code.
10949
10950	The @a pixelFormat parameter defines whether the direct mode is
10951	available or not. If @a pixelFormat is <link
10952	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10953	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10954	@a bytesPerLine parameters must be ignored and the implementation must use
10955	the indirect mode (where it provides its own buffer in one of the
10956	supported formats). In all other cases, @a pixelFormat together with
10957	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10958	buffer pointed to by the @a VRAM parameter and the implementation is
10959	free to choose which mode to use. To indicate that this frame buffer uses
10960	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10961	attribute must return @c true and <link to="#address"/> must
10962	return exactly the same address that is passed in the @a VRAM parameter
10963	of this method; otherwise it is assumed that the indirect strategy is
10964	chosen.
10965
10966	The @a width and @a height parameters represent the size of the
10967	requested display mode in both modes. In case of indirect mode, the
10968	provided memory buffer should be big enough to store data of the given
10969	display mode. In case of direct mode, it is guaranteed that the given
10970	@a VRAM buffer contains enough space to represent the display mode of the
10971	given size. Note that this frame buffer's <link to="#width"/> and <link
10972	to="#height"/> attributes must return exactly the same values as
10973	passed to this method after the resize is completed (see below).
10974
10975	The @a finished output parameter determines if the implementation has
10976	finished resizing the frame buffer or not. If, for some reason, the
10977	resize cannot be finished immediately during this call, @a finished
10978	must be set to @c false, and the implementation must call
10979	<link to="IDisplay::resizeCompleted"/> after it has returned from
10980	this method as soon as possible. If @a finished is @c false, the
10981	machine will not call any frame buffer methods until
10982	<link to="IDisplay::resizeCompleted"/> is called.
10983
10984	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10985	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10986	this frame buffer must return exactly the same values as specified in the
10987	parameters of this method, after the resize is completed. If the
10988	indirect mode is chosen, these attributes must return values describing
10989	the format of the implementation's own memory buffer <link
10990	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10991	value must always correlate with <link to="#pixelFormat"/>. Note that
10992	the <link to="#pixelFormat"/> attribute must never return <link
10993	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10994
10995	<note>
10996	This method is called by the IDisplay object under the
10997	<link to="#lock"/> provided by this IFramebuffer
10998	implementation. If this method returns @c false in @a finished, then
10999	this lock is not released until
11000	<link to="IDisplay::resizeCompleted"/> is called.
11001	</note>
11002	</desc>
11003	<param name="screenId" type="unsigned long" dir="in">
11004	<desc>
11005	Logical screen number. Must be used in the corresponding call to
11006	<link to="IDisplay::resizeCompleted"/> if this call is made.
11007	</desc>
11008	</param>
11009	<param name="pixelFormat" type="unsigned long" dir="in">
11010	<desc>
11011	Pixel format of the memory buffer pointed to by @a VRAM.
11012	See also <link to="FramebufferPixelFormat"/>.
11013	</desc>
11014	</param>
11015	<param name="VRAM" type="octet" mod="ptr" dir="in">
11016	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11017	</param>
11018	<param name="bitsPerPixel" type="unsigned long" dir="in">
11019	<desc>Color depth, bits per pixel.</desc>
11020	</param>
11021	<param name="bytesPerLine" type="unsigned long" dir="in">
11022	<desc>Size of one scan line, in bytes.</desc>
11023	</param>
11024	<param name="width" type="unsigned long" dir="in">
11025	<desc>Width of the guest display, in pixels.</desc>
11026	</param>
11027	<param name="height" type="unsigned long" dir="in">
11028	<desc>Height of the guest display, in pixels.</desc>
11029	</param>
11030	<param name="finished" type="boolean" dir="return">
11031	<desc>
11032	Can the VM start using the new frame buffer immediately
11033	after this method returns or it should wait for
11034	<link to="IDisplay::resizeCompleted"/>.
11035	</desc>
11036	</param>
11037	</method>
11038
11039	<method name="videoModeSupported">
11040	<desc>
11041	Returns whether the frame buffer implementation is willing to
11042	support a given video mode. In case it is not able to render
11043	the video mode (or for some reason not willing), it should
11044	return @c false. Usually this method is called when the guest
11045	asks the VMM device whether a given video mode is supported
11046	so the information returned is directly exposed to the guest.
11047	It is important that this method returns very quickly.
11048	</desc>
11049	<param name="width" type="unsigned long" dir="in"/>
11050	<param name="height" type="unsigned long" dir="in"/>
11051	<param name="bpp" type="unsigned long" dir="in"/>
11052	<param name="supported" type="boolean" dir="return"/>
11053	</method>
11054
11055	<method name="getVisibleRegion">
11056	<desc>
11057	Returns the visible region of this frame buffer.
11058
11059	If the @a rectangles parameter is @c null then the value of the
11060	@a count parameter is ignored and the number of elements necessary to
11061	describe the current visible region is returned in @a countCopied.
11062
11063	If @a rectangles is not @c null but @a count is less
11064	than the required number of elements to store region data, the method
11065	will report a failure. If @a count is equal or greater than the
11066	required number of elements, then the actual number of elements copied
11067	to the provided array will be returned in @a countCopied.
11068
11069	<note>
11070	The address of the provided array must be in the process space of
11071	this IFramebuffer object.
11072	</note>
11073	<note>
11074	Method not yet implemented.
11075	</note>
11076	</desc>
11077	<param name="rectangles" type="octet" mod="ptr" dir="in">
11078	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11079	</param>
11080	<param name="count" type="unsigned long" dir="in">
11081	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11082	</param>
11083	<param name="countCopied" type="unsigned long" dir="return">
11084	<desc>Number of elements copied to the @a rectangles array.</desc>
11085	</param>
11086	</method>
11087
11088	<method name="setVisibleRegion">
11089	<desc>
11090	Suggests a new visible region to this frame buffer. This region
11091	represents the area of the VM display which is a union of regions of
11092	all top-level windows of the guest operating system running inside the
11093	VM (if the Guest Additions for this system support this
11094	functionality). This information may be used by the frontends to
11095	implement the seamless desktop integration feature.
11096
11097	<note>
11098	The address of the provided array must be in the process space of
11099	this IFramebuffer object.
11100	</note>
11101	<note>
11102	The IFramebuffer implementation must make a copy of the provided
11103	array of rectangles.
11104	</note>
11105	<note>
11106	Method not yet implemented.
11107	</note>
11108	</desc>
11109	<param name="rectangles" type="octet" mod="ptr" dir="in">
11110	<desc>Pointer to the @c RTRECT array.</desc>
11111	</param>
11112	<param name="count" type="unsigned long" dir="in">
11113	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11114	</param>
11115	</method>
11116
11117	<method name="processVHWACommand">
11118	<desc>
11119	Posts a Video HW Acceleration Command to the frame buffer for processing.
11120	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
11121	are posted from quest to the host to be processed by the host hardware.
11122
11123	<note>
11124	The address of the provided command must be in the process space of
11125	this IFramebuffer object.
11126	</note>
11127	</desc>
11128
11129	<param name="command" type="octet" mod="ptr" dir="in">
11130	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11131	</param>
11132	</method>
11133
11134	</interface>
11135
11136	<interface
11137	name="IFramebufferOverlay" extends="IFramebuffer"
11138	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11139	wsmap="suppress"
11140	>
11141	<desc>
11142	The IFramebufferOverlay interface represents an alpha blended overlay
11143	for displaying status icons above an IFramebuffer. It is always created
11144	not visible, so that it must be explicitly shown. It only covers a
11145	portion of the IFramebuffer, determined by its width, height and
11146	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11147	that order) format, and may be written to directly. Do re-read the
11148	width though, after setting it, as it may be adjusted (increased) to
11149	make it more suitable for the front end.
11150	</desc>
11151	<attribute name="x" type="unsigned long" readonly="yes">
11152	<desc>X position of the overlay, relative to the frame buffer.</desc>
11153	</attribute>
11154
11155	<attribute name="y" type="unsigned long" readonly="yes">
11156	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11157	</attribute>
11158
11159	<attribute name="visible" type="boolean" readonly="no">
11160	<desc>
11161	Whether the overlay is currently visible.
11162	</desc>
11163	</attribute>
11164
11165	<attribute name="alpha" type="unsigned long" readonly="no">
11166	<desc>
11167	The global alpha value for the overlay. This may or may not be
11168	supported by a given front end.
11169	</desc>
11170	</attribute>
11171
11172	<method name="move">
11173	<desc>
11174	Changes the overlay's position relative to the IFramebuffer.
11175	</desc>
11176	<param name="x" type="unsigned long" dir="in"/>
11177	<param name="y" type="unsigned long" dir="in"/>
11178	</method>
11179
11180	</interface>
11181
11182	<interface
11183	name="IDisplay" extends="$unknown"
11184	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
11185	wsmap="managed"
11186	>
11187	<desc>
11188	The IDisplay interface represents the virtual machine's display.
11189
11190	The object implementing this interface is contained in each
11191	<link to="IConsole::display"/> attribute and represents the visual
11192	output of the virtual machine.
11193
11194	The virtual display supports pluggable output targets represented by the
11195	IFramebuffer interface. Examples of the output target are a window on
11196	the host computer or an RDP session's display on a remote computer.
11197	</desc>
11198	<attribute name="width" type="unsigned long" readonly="yes">
11199	<desc>Current display width.</desc>
11200	</attribute>
11201
11202	<attribute name="height" type="unsigned long" readonly="yes">
11203	<desc>Current display height.</desc>
11204	</attribute>
11205
11206	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11207	<desc>
11208	Current guest display color depth. Note that this may differ
11209	from <link to="IFramebuffer::bitsPerPixel"/>.
11210	</desc>
11211	</attribute>
11212
11213	<method name="setFramebuffer">
11214	<desc>
11215	Sets the framebuffer for given screen.
11216	</desc>
11217	<param name="screenId" type="unsigned long" dir="in"/>
11218	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11219	</method>
11220
11221	<method name="getFramebuffer">
11222	<desc>
11223	Queries the framebuffer for given screen.
11224	</desc>
11225	<param name="screenId" type="unsigned long" dir="in"/>
11226	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11227	<param name="xOrigin" type="long" dir="out"/>
11228	<param name="yOrigin" type="long" dir="out"/>
11229	</method>
11230
11231	<method name="setVideoModeHint">
11232	<desc>
11233	Asks VirtualBox to request the given video mode from
11234	the guest. This is just a hint and it cannot be guaranteed
11235	that the requested resolution will be used. Guest Additions
11236	are required for the request to be seen by guests. The caller
11237	should issue the request and wait for a resolution change and
11238	after a timeout retry.
11239
11240	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11241	parameters means that the corresponding values should be taken from the
11242	current video mode (i.e. left unchanged).
11243
11244	If the guest OS supports multi-monitor configuration then the @a display
11245	parameter specifies the number of the guest display to send the hint to:
11246	@c 0 is the primary display, @c 1 is the first secondary and
11247	so on. If the multi-monitor configuration is not supported, @a display
11248	must be @c 0.
11249
11250	<result name="E_INVALIDARG">
11251	The @a display is not associated with any monitor.
11252	</result>
11253
11254	</desc>
11255	<param name="width" type="unsigned long" dir="in"/>
11256	<param name="height" type="unsigned long" dir="in"/>
11257	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11258	<param name="display" type="unsigned long" dir="in"/>
11259	</method>
11260
11261	<method name="setSeamlessMode">
11262	<desc>
11263	Enables or disables seamless guest display rendering (seamless desktop
11264	integration) mode.
11265	<note>
11266	Calling this method has no effect if <link
11267	to="IGuest::supportsSeamless"/> returns @c false.
11268	</note>
11269	</desc>
11270	<param name="enabled" type="boolean" dir="in"/>
11271	</method>
11272
11273	<method name="takeScreenShot">
11274	<desc>
11275	Takes a screen shot of the requested size and copies it to the
11276	32-bpp buffer allocated by the caller and pointed to by @a address.
11277	A pixel consists of 4 bytes in order: B, G, R, 0.
11278
11279	<note>This API can be used only by the COM/XPCOM C++ API as it
11280	requires pointer support. Use <link to="#takeScreenShotSlow" />
11281	with other language bindings.
11282	</note>
11283
11284	<result name="E_NOTIMPL">
11285	Feature not implemented.
11286	</result>
11287	<result name="VBOX_E_IPRT_ERROR">
11288	Could not take a screenshot.
11289	</result>
11290
11291	</desc>
11292	<param name="address" type="octet" mod="ptr" dir="in"/>
11293	<param name="width" type="unsigned long" dir="in"/>
11294	<param name="height" type="unsigned long" dir="in"/>
11295	</method>
11296
11297	<method name="takeScreenShotSlow">
11298	<desc>
11299	Takes a guest screen shot of the requested size and returns it as
11300	an array of bytes in uncompressed 32-bit RGBA format.
11301	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11302
11303	This API is slow, but could be the only option to get guest screenshot
11304	for scriptable languages not allowed to manipulate with addresses
11305	directly.
11306
11307	<result name="E_NOTIMPL">
11308	Feature not implemented.
11309	</result>
11310	<result name="VBOX_E_IPRT_ERROR">
11311	Could not take a screenshot.
11312	</result>
11313	</desc>
11314	<param name="width" type="unsigned long" dir="in">
11315	<desc>
11316	Desired image width.
11317	</desc>
11318	</param>
11319	<param name="height" type="unsigned long" dir="in">
11320	<desc>
11321	Desired image height.
11322	</desc>
11323	</param>
11324	<param name="screenData" type="octet" dir="return" safearray="yes">
11325	<desc>
11326	Array with resulting screen data.
11327	</desc>
11328	</param>
11329	</method>
11330
11331	<method name="drawToScreen">
11332	<desc>
11333	Draws a 32-bpp image of the specified size from the given buffer
11334	to the given point on the VM display.
11335
11336	<result name="E_NOTIMPL">
11337	Feature not implemented.
11338	</result>
11339	<result name="VBOX_E_IPRT_ERROR">
11340	Could not draw to screen.
11341	</result>
11342
11343	</desc>
11344	<param name="address" type="octet" mod="ptr" dir="in"/>
11345	<param name="x" type="unsigned long" dir="in"/>
11346	<param name="y" type="unsigned long" dir="in"/>
11347	<param name="width" type="unsigned long" dir="in"/>
11348	<param name="height" type="unsigned long" dir="in"/>
11349	</method>
11350
11351	<method name="invalidateAndUpdate">
11352	<desc>
11353	Does a full invalidation of the VM display and instructs the VM
11354	to update it.
11355
11356	<result name="VBOX_E_IPRT_ERROR">
11357	Could not invalidate and update screen.
11358	</result>
11359
11360	</desc>
11361	</method>
11362
11363	<method name="resizeCompleted">
11364	<desc>
11365	Signals that a framebuffer has completed the resize operation.
11366
11367	<result name="VBOX_E_NOT_SUPPORTED">
11368	Operation only valid for external frame buffers.
11369	</result>
11370
11371	</desc>
11372	<param name="screenId" type="unsigned long" dir="in"/>
11373	</method>
11374
11375	<method name="updateCompleted">
11376	<desc>
11377	Signals that a framebuffer has completed the update operation.
11378
11379	<result name="VBOX_E_NOT_SUPPORTED">
11380	Operation only valid for external frame buffers.
11381	</result>
11382
11383	</desc>
11384	</method>
11385
11386	<method name="completeVHWACommand">
11387	<desc>
11388	Signals that the Video HW Acceleration command has completed.
11389	</desc>
11390
11391	<param name="command" type="octet" mod="ptr" dir="in">
11392	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11393	</param>
11394	</method>
11395
11396	</interface>
11397
11398	<!--
11399	// INetworkAdapter
11400	/////////////////////////////////////////////////////////////////////////
11401	-->
11402
11403	<enum
11404	name="NetworkAttachmentType"
11405	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11406	>
11407	<desc>
11408	Network attachment type.
11409	</desc>
11410
11411	<const name="Null" value="0">
11412	<desc>Null value, also means "not attached".</desc>
11413	</const>
11414	<const name="NAT" value="1"/>
11415	<const name="Bridged" value="2"/>
11416	<const name="Internal" value="3"/>
11417	<const name="HostOnly" value="4"/>
11418	</enum>
11419
11420	<enum
11421	name="NetworkAdapterType"
11422	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11423	>
11424	<desc>
11425	Network adapter type.
11426	</desc>
11427
11428	<const name="Null" value="0">
11429	<desc>Null value (never used by the API).</desc>
11430	</const>
11431	<const name="Am79C970A" value="1">
11432	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11433	</const>
11434	<const name="Am79C973" value="2">
11435	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11436	</const>
11437	<const name="I82540EM" value="3">
11438	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11439	</const>
11440	<const name="I82543GC" value="4">
11441	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11442	</const>
11443	<const name="I82545EM" value="5">
11444	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11445	</const>
11446	<const name="Virtio" value="6">
11447	<desc>Virtio network device.</desc>
11448	</const>
11449	</enum>
11450
11451	<interface
11452	name="INetworkAdapter" extends="$unknown"
11453	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11454	wsmap="managed"
11455	>
11456	<desc>
11457	Represents a virtual network adapter that is attached to a virtual machine.
11458	Each virtual machine has a fixed number of network adapter slots with one
11459	instance of this attached to each of them. Call
11460	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11461	is attached to a given slot in a given machine.
11462
11463	Each network adapter can be in one of five attachment modes, which are
11464	represented by the <link to="NetworkAttachmentType" /> enumeration;
11465	see the <link to="#attachmentType" /> attribute.
11466	</desc>
11467
11468	<attribute name="adapterType" type="NetworkAdapterType">
11469	<desc>
11470	Type of the virtual network adapter. Depending on this value,
11471	VirtualBox will provide a different virtual network hardware
11472	to the guest.
11473	</desc>
11474	</attribute>
11475
11476	<attribute name="slot" type="unsigned long" readonly="yes">
11477	<desc>
11478	Slot number this adapter is plugged into. Corresponds to
11479	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11480	to obtain this instance.
11481	</desc>
11482	</attribute>
11483
11484	<attribute name="enabled" type="boolean">
11485	<desc>
11486	Flag whether the network adapter is present in the
11487	guest system. If disabled, the virtual guest hardware will
11488	not contain this network adapter. Can only be changed when
11489	the VM is not running.
11490	</desc>
11491	</attribute>
11492
11493	<attribute name="MACAddress" type="wstring">
11494	<desc>
11495	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11496	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11497	</desc>
11498	</attribute>
11499
11500	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11501
11502	<attribute name="hostInterface" type="wstring">
11503	<desc>
11504	Name of the host network interface the VM is attached to.
11505	</desc>
11506	</attribute>
11507
11508	<attribute name="internalNetwork" type="wstring">
11509	<desc>
11510	Name of the internal network the VM is attached to.
11511	</desc>
11512	</attribute>
11513
11514	<attribute name="NATNetwork" type="wstring">
11515	<desc>
11516	Name of the NAT network the VM is attached to.
11517	</desc>
11518	</attribute>
11519
11520	<attribute name="cableConnected" type="boolean">
11521	<desc>
11522	Flag whether the adapter reports the cable as connected or not.
11523	It can be used to report offline situations to a VM.
11524	</desc>
11525	</attribute>
11526
11527	<attribute name="lineSpeed" type="unsigned long">
11528	<desc>
11529	Line speed reported by custom drivers, in units of 1 kbps.
11530	</desc>
11531	</attribute>
11532
11533	<attribute name="traceEnabled" type="boolean">
11534	<desc>
11535	Flag whether network traffic from/to the network card should be traced.
11536	Can only be toggled when the VM is turned off.
11537	</desc>
11538	</attribute>
11539
11540	<attribute name="traceFile" type="wstring">
11541	<desc>
11542	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11543	will be used.
11544	</desc>
11545	</attribute>
11546
11547	<method name="attachToNAT">
11548	<desc>
11549	Attach the network adapter to the Network Address Translation (NAT) interface.
11550	</desc>
11551	</method>
11552
11553	<method name="attachToBridgedInterface">
11554	<desc>
11555	Attach the network adapter to a bridged host interface.
11556	</desc>
11557	</method>
11558
11559	<method name="attachToInternalNetwork">
11560	<desc>
11561	Attach the network adapter to an internal network.
11562	</desc>
11563	</method>
11564
11565	<method name="attachToHostOnlyInterface">
11566	<desc>
11567	Attach the network adapter to the host-only network.
11568	</desc>
11569	</method>
11570
11571	<method name="detach">
11572	<desc>
11573	Detach the network adapter
11574	</desc>
11575	</method>
11576	</interface>
11577
11578
11579	<!--
11580	// ISerialPort
11581	/////////////////////////////////////////////////////////////////////////
11582	-->
11583
11584	<enum
11585	name="PortMode"
11586	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11587	>
11588	<desc>
11589	The PortMode enumeration represents possible communication modes for
11590	the virtual serial port device.
11591	</desc>
11592
11593	<const name="Disconnected" value="0">
11594	<desc>Virtual device is not attached to any real host device.</desc>
11595	</const>
11596	<const name="HostPipe" value="1">
11597	<desc>Virtual device is attached to a host pipe.</desc>
11598	</const>
11599	<const name="HostDevice" value="2">
11600	<desc>Virtual device is attached to a host device.</desc>
11601	</const>
11602	<const name="RawFile" value="3">
11603	<desc>Virtual device is attached to a raw file.</desc>
11604	</const>
11605	</enum>
11606
11607	<interface
11608	name="ISerialPort" extends="$unknown"
11609	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11610	wsmap="managed"
11611	>
11612
11613	<desc>
11614	The ISerialPort interface represents the virtual serial port device.
11615
11616	The virtual serial port device acts like an ordinary serial port
11617	inside the virtual machine. This device communicates to the real
11618	serial port hardware in one of two modes: host pipe or host device.
11619
11620	In host pipe mode, the #path attribute specifies the path to the pipe on
11621	the host computer that represents a serial port. The #server attribute
11622	determines if this pipe is created by the virtual machine process at
11623	machine startup or it must already exist before starting machine
11624	execution.
11625
11626	In host device mode, the #path attribute specifies the name of the
11627	serial port device on the host computer.
11628
11629	There is also a third communication mode: the disconnected mode. In this
11630	mode, the guest OS running inside the virtual machine will be able to
11631	detect the serial port, but all port write operations will be discarded
11632	and all port read operations will return no data.
11633
11634	<see>IMachine::getSerialPort</see>
11635	</desc>
11636
11637	<attribute name="slot" type="unsigned long" readonly="yes">
11638	<desc>
11639	Slot number this serial port is plugged into. Corresponds to
11640	the value you pass to <link to="IMachine::getSerialPort"/>
11641	to obtain this instance.
11642	</desc>
11643	</attribute>
11644
11645	<attribute name="enabled" type="boolean">
11646	<desc>
11647	Flag whether the serial port is enabled. If disabled,
11648	the serial port will not be reported to the guest OS.
11649	</desc>
11650	</attribute>
11651
11652	<attribute name="IOBase" type="unsigned long">
11653	<desc>Base I/O address of the serial port.</desc>
11654	</attribute>
11655
11656	<attribute name="IRQ" type="unsigned long">
11657	<desc>IRQ number of the serial port.</desc>
11658	</attribute>
11659
11660	<attribute name="hostMode" type="PortMode">
11661	<desc>
11662	How is this port connected to the host.
11663	<note>
11664	Changing this attribute may fail if the conditions for
11665	<link to="#path"/> are not met.
11666	</note>
11667	</desc>
11668	</attribute>
11669
11670	<attribute name="server" type="boolean">
11671	<desc>
11672	Flag whether this serial port acts as a server (creates a new pipe on
11673	the host) or as a client (uses the existing pipe). This attribute is
11674	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11675	</desc>
11676	</attribute>
11677
11678	<attribute name="path" type="wstring">
11679	<desc>
11680	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11681	PortMode_HostPipe, or the host serial device name when
11682	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11683	cases, setting a @c null or empty string as the attribute's value
11684	is an error. Otherwise, the value of this property is ignored.
11685	</desc>
11686	</attribute>
11687
11688	</interface>
11689
11690	<!--
11691	// IParallelPort
11692	/////////////////////////////////////////////////////////////////////////
11693	-->
11694
11695	<interface
11696	name="IParallelPort" extends="$unknown"
11697	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11698	wsmap="managed"
11699	>
11700
11701	<desc>
11702	The IParallelPort interface represents the virtual parallel port device.
11703
11704	The virtual parallel port device acts like an ordinary parallel port
11705	inside the virtual machine. This device communicates to the real
11706	parallel port hardware using the name of the parallel device on the host
11707	computer specified in the #path attribute.
11708
11709	Each virtual parallel port device is assigned a base I/O address and an
11710	IRQ number that will be reported to the guest operating system and used
11711	to operate the given parallel port from within the virtual machine.
11712
11713	<see>IMachine::getParallelPort</see>
11714	</desc>
11715
11716	<attribute name="slot" type="unsigned long" readonly="yes">
11717	<desc>
11718	Slot number this parallel port is plugged into. Corresponds to
11719	the value you pass to <link to="IMachine::getParallelPort"/>
11720	to obtain this instance.
11721	</desc>
11722	</attribute>
11723
11724	<attribute name="enabled" type="boolean">
11725	<desc>
11726	Flag whether the parallel port is enabled. If disabled,
11727	the parallel port will not be reported to the guest OS.
11728	</desc>
11729	</attribute>
11730
11731	<attribute name="IOBase" type="unsigned long">
11732	<desc>Base I/O address of the parallel port.</desc>
11733	</attribute>
11734
11735	<attribute name="IRQ" type="unsigned long">
11736	<desc>IRQ number of the parallel port.</desc>
11737	</attribute>
11738
11739	<attribute name="path" type="wstring">
11740	<desc>
11741	Host parallel device name. If this parallel port is enabled, setting a
11742	@c null or an empty string as this attribute's value will result into
11743	an error.
11744	</desc>
11745	</attribute>
11746
11747	</interface>
11748
11749
11750	<!--
11751	// IMachineDebugger
11752	/////////////////////////////////////////////////////////////////////////
11753	-->
11754
11755	<interface
11756	name="IMachineDebugger" extends="$unknown"
11757	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11758	wsmap="suppress"
11759	>
11760	<method name="resetStats">
11761	<desc>
11762	Reset VM statistics.
11763	</desc>
11764	<param name="pattern" type="wstring" dir="in">
11765	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11766	</param>
11767	</method>
11768
11769	<method name="dumpStats">
11770	<desc>
11771	Dumps VM statistics.
11772	</desc>
11773	<param name="pattern" type="wstring" dir="in">
11774	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11775	</param>
11776	</method>
11777
11778	<method name="getStats">
11779	<desc>
11780	Get the VM statistics in a XMLish format.
11781	</desc>
11782	<param name="pattern" type="wstring" dir="in">
11783	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11784	</param>
11785	<param name="withDescriptions" type="boolean" dir="in">
11786	<desc>Whether to include the descriptions.</desc>
11787	</param>
11788	<param name="stats" type="wstring" dir="out">
11789	<desc>The XML document containing the statistics.</desc>
11790	</param>
11791	</method>
11792
11793	<method name="injectNMI">
11794	<desc>
11795	Inject an NMI into a running VT-x/AMD-V VM.
11796	</desc>
11797	</method>
11798
11799	<attribute name="singlestep" type="boolean">
11800	<desc>Switch for enabling singlestepping.</desc>
11801	</attribute>
11802
11803	<attribute name="recompileUser" type="boolean">
11804	<desc>Switch for forcing code recompilation for user mode code.</desc>
11805	</attribute>
11806
11807	<attribute name="recompileSupervisor" type="boolean">
11808	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11809	</attribute>
11810
11811	<attribute name="PATMEnabled" type="boolean">
11812	<desc>Switch for enabling and disabling the PATM component.</desc>
11813	</attribute>
11814
11815	<attribute name="CSAMEnabled" type="boolean">
11816	<desc>Switch for enabling and disabling the CSAM component.</desc>
11817	</attribute>
11818
11819	<attribute name="logEnabled" type="boolean">
11820	<desc>Switch for enabling and disabling logging.</desc>
11821	</attribute>
11822
11823	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11824	<desc>
11825	Flag indicating whether the VM is currently making use of CPU hardware
11826	virtualization extensions.
11827	</desc>
11828	</attribute>
11829
11830	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11831	<desc>
11832	Flag indicating whether the VM is currently making use of the nested paging
11833	CPU hardware virtualization extension.
11834	</desc>
11835	</attribute>
11836
11837	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11838	<desc>
11839	Flag indicating whether the VM is currently making use of the VPID
11840	VT-x extension.
11841	</desc>
11842	</attribute>
11843
11844	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11845	<desc>
11846	Flag indicating whether the VM is currently making use of the Physical
11847	Address Extension CPU feature.
11848	</desc>
11849	</attribute>
11850
11851	<attribute name="virtualTimeRate" type="unsigned long">
11852	<desc>
11853	The rate at which the virtual time runs expressed as a percentage.
11854	The accepted range is 2% to 20000%.
11855	</desc>
11856	</attribute>
11857
11858	<!-- @todo method for setting log flags, groups and destination! -->
11859
11860	<attribute name="VM" type="unsigned long long" readonly="yes">
11861	<desc>
11862	Gets the VM handle. This is only for internal use while
11863	we carve the details of this interface.
11864	</desc>
11865	</attribute>
11866
11867	</interface>
11868
11869	<!--
11870	// IUSBController
11871	/////////////////////////////////////////////////////////////////////////
11872	-->
11873
11874	<interface
11875	name="IUSBController" extends="$unknown"
11876	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11877	wsmap="managed"
11878	>
11879	<attribute name="enabled" type="boolean">
11880	<desc>
11881	Flag whether the USB controller is present in the
11882	guest system. If disabled, the virtual guest hardware will
11883	not contain any USB controller. Can only be changed when
11884	the VM is powered off.
11885	</desc>
11886	</attribute>
11887
11888	<attribute name="enabledEhci" type="boolean">
11889	<desc>
11890	Flag whether the USB EHCI controller is present in the
11891	guest system. If disabled, the virtual guest hardware will
11892	not contain a USB EHCI controller. Can only be changed when
11893	the VM is powered off.
11894	</desc>
11895	</attribute>
11896
11897	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11898	<desc>
11899	USB standard version which the controller implements.
11900	This is a BCD which means that the major version is in the
11901	high byte and minor version is in the low byte.
11902	</desc>
11903	</attribute>
11904
11905	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11906	<desc>
11907	List of USB device filters associated with the machine.
11908
11909	If the machine is currently running, these filters are activated
11910	every time a new (supported) USB device is attached to the host
11911	computer that was not ignored by global filters
11912	(<link to="IHost::USBDeviceFilters"/>).
11913
11914	These filters are also activated when the machine is powered up.
11915	They are run against a list of all currently available USB
11916	devices (in states
11917	<link to="USBDeviceState_Available"/>,
11918	<link to="USBDeviceState_Busy"/>,
11919	<link to="USBDeviceState_Held"/>) that were not previously
11920	ignored by global filters.
11921
11922	If at least one filter matches the USB device in question, this
11923	device is automatically captured (attached to) the virtual USB
11924	controller of this machine.
11925
11926	<see>IUSBDeviceFilter, ::IUSBController</see>
11927	</desc>
11928	</attribute>
11929
11930	<method name="createDeviceFilter">
11931	<desc>
11932	Creates a new USB device filter. All attributes except
11933	the filter name are set to empty (any match),
11934	<i>active</i> is @c false (the filter is not active).
11935
11936	The created filter can then be added to the list of filters using
11937	<link to="#insertDeviceFilter"/>.
11938
11939	<result name="VBOX_E_INVALID_VM_STATE">
11940	The virtual machine is not mutable.
11941	</result>
11942
11943	<see>#deviceFilters</see>
11944	</desc>
11945	<param name="name" type="wstring" dir="in">
11946	<desc>
11947	Filter name. See <link to="IUSBDeviceFilter::name"/>
11948	for more info.
11949	</desc>
11950	</param>
11951	<param name="filter" type="IUSBDeviceFilter" dir="return">
11952	<desc>Created filter object.</desc>
11953	</param>
11954	</method>
11955
11956	<method name="insertDeviceFilter">
11957	<desc>
11958	Inserts the given USB device to the specified position
11959	in the list of filters.
11960
11961	Positions are numbered starting from <tt>0</tt>. If the specified
11962	position is equal to or greater than the number of elements in
11963	the list, the filter is added to the end of the collection.
11964
11965	<note>
11966	Duplicates are not allowed, so an attempt to insert a
11967	filter that is already in the collection, will return an
11968	error.
11969	</note>
11970
11971	<result name="VBOX_E_INVALID_VM_STATE">
11972	Virtual machine is not mutable.
11973	</result>
11974	<result name="E_INVALIDARG">
11975	USB device filter not created within this VirtualBox instance.
11976	</result>
11977	<result name="VBOX_E_INVALID_OBJECT_STATE">
11978	USB device filter already in list.
11979	</result>
11980
11981	<see>#deviceFilters</see>
11982	</desc>
11983	<param name="position" type="unsigned long" dir="in">
11984	<desc>Position to insert the filter to.</desc>
11985	</param>
11986	<param name="filter" type="IUSBDeviceFilter" dir="in">
11987	<desc>USB device filter to insert.</desc>
11988	</param>
11989	</method>
11990
11991	<method name="removeDeviceFilter">
11992	<desc>
11993	Removes a USB device filter from the specified position in the
11994	list of filters.
11995
11996	Positions are numbered starting from <tt>0</tt>. Specifying a
11997	position equal to or greater than the number of elements in
11998	the list will produce an error.
11999
12000	<see>#deviceFilters</see>
12001
12002	<result name="VBOX_E_INVALID_VM_STATE">
12003	Virtual machine is not mutable.
12004	</result>
12005	<result name="E_INVALIDARG">
12006	USB device filter list empty or invalid @a position.
12007	</result>
12008
12009	</desc>
12010	<param name="position" type="unsigned long" dir="in">
12011	<desc>Position to remove the filter from.</desc>
12012	</param>
12013	<param name="filter" type="IUSBDeviceFilter" dir="return">
12014	<desc>Removed USB device filter.</desc>
12015	</param>
12016	</method>
12017
12018	</interface>
12019
12020
12021	<!--
12022	// IUSBDevice
12023	/////////////////////////////////////////////////////////////////////////
12024	-->
12025
12026	<interface
12027	name="IUSBDevice" extends="$unknown"
12028	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12029	wsmap="managed"
12030	>
12031	<desc>
12032	The IUSBDevice interface represents a virtual USB device attached to the
12033	virtual machine.
12034
12035	A collection of objects implementing this interface is stored in the
12036	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12037	attached to a running virtual machine's USB controller.
12038	</desc>
12039
12040	<attribute name="id" type="uuid" mod="string" readonly="yes">
12041	<desc>
12042	Unique USB device ID. This ID is built from #vendorId,
12043	#productId, #revision and #serialNumber.
12044	</desc>
12045	</attribute>
12046
12047	<attribute name="vendorId" type="unsigned short" readonly="yes">
12048	<desc>Vendor ID.</desc>
12049	</attribute>
12050
12051	<attribute name="productId" type="unsigned short" readonly="yes">
12052	<desc>Product ID.</desc>
12053	</attribute>
12054
12055	<attribute name="revision" type="unsigned short" readonly="yes">
12056	<desc>
12057	Product revision number. This is a packed BCD represented as
12058	unsigned short. The high byte is the integer part and the low
12059	byte is the decimal.
12060	</desc>
12061	</attribute>
12062
12063	<attribute name="manufacturer" type="wstring" readonly="yes">
12064	<desc>Manufacturer string.</desc>
12065	</attribute>
12066
12067	<attribute name="product" type="wstring" readonly="yes">
12068	<desc>Product string.</desc>
12069	</attribute>
12070
12071	<attribute name="serialNumber" type="wstring" readonly="yes">
12072	<desc>Serial number string.</desc>
12073	</attribute>
12074
12075	<attribute name="address" type="wstring" readonly="yes">
12076	<desc>Host specific address of the device.</desc>
12077	</attribute>
12078
12079	<attribute name="port" type="unsigned short" readonly="yes">
12080	<desc>
12081	Host USB port number the device is physically
12082	connected to.
12083	</desc>
12084	</attribute>
12085
12086	<attribute name="version" type="unsigned short" readonly="yes">
12087	<desc>
12088	The major USB version of the device - 1 or 2.
12089	</desc>
12090	</attribute>
12091
12092	<attribute name="portVersion" type="unsigned short" readonly="yes">
12093	<desc>
12094	The major USB version of the host USB port the device is
12095	physically connected to - 1 or 2. For devices not connected to
12096	anything this will have the same value as the version attribute.
12097	</desc>
12098	</attribute>
12099
12100	<attribute name="remote" type="boolean" readonly="yes">
12101	<desc>
12102	Whether the device is physically connected to a remote VRDP
12103	client or to a local host machine.
12104	</desc>
12105	</attribute>
12106
12107	</interface>
12108
12109
12110	<!--
12111	// IUSBDeviceFilter
12112	/////////////////////////////////////////////////////////////////////////
12113	-->
12114
12115	<interface
12116	name="IUSBDeviceFilter" extends="$unknown"
12117	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12118	wsmap="managed"
12119	>
12120	<desc>
12121	The IUSBDeviceFilter interface represents an USB device filter used
12122	to perform actions on a group of USB devices.
12123
12124	This type of filters is used by running virtual machines to
12125	automatically capture selected USB devices once they are physically
12126	attached to the host computer.
12127
12128	A USB device is matched to the given device filter if and only if all
12129	attributes of the device match the corresponding attributes of the
12130	filter (that is, attributes are joined together using the logical AND
12131	operation). On the other hand, all together, filters in the list of
12132	filters carry the semantics of the logical OR operation. So if it is
12133	desirable to create a match like "this vendor id OR this product id",
12134	one needs to create two filters and specify "any match" (see below)
12135	for unused attributes.
12136
12137	All filter attributes used for matching are strings. Each string
12138	is an expression representing a set of values of the corresponding
12139	device attribute, that will match the given filter. Currently, the
12140	following filtering expressions are supported:
12141
12142	<ul>
12143	<li><i>Interval filters</i>. Used to specify valid intervals for
12144	integer device attributes (Vendor ID, Product ID and Revision).
12145	The format of the string is:
12146
12147	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12148
12149	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12150	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12151	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12152	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12153	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12154	possible integer is assumed.
12155	</li>
12156	<li><i>Boolean filters</i>. Used to specify acceptable values for
12157	boolean device attributes. The format of the string is:
12158
12159	<tt>true\|false\|yes\|no\|0\|1</tt>
12160
12161	</li>
12162	<li><i>Exact match</i>. Used to specify a single value for the given
12163	device attribute. Any string that doesn't start with <tt>int:</tt>
12164	represents the exact match. String device attributes are compared to
12165	this string including case of symbols. Integer attributes are first
12166	converted to a string (see individual filter attributes) and then
12167	compared ignoring case.
12168
12169	</li>
12170	<li><i>Any match</i>. Any value of the corresponding device attribute
12171	will match the given filter. An empty or @c null string is
12172	used to construct this type of filtering expressions.
12173
12174	</li>
12175	</ul>
12176
12177	<note>
12178	On the Windows host platform, interval filters are not currently
12179	available. Also all string filter attributes
12180	(<link to="#manufacturer"/>, <link to="#product"/>,
12181	<link to="#serialNumber"/>) are ignored, so they behave as
12182	<i>any match</i> no matter what string expression is specified.
12183	</note>
12184
12185	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12186	</desc>
12187
12188	<attribute name="name" type="wstring">
12189	<desc>
12190	Visible name for this filter.
12191	This name is used to visually distinguish one filter from another,
12192	so it can neither be @c null nor an empty string.
12193	</desc>
12194	</attribute>
12195
12196	<attribute name="active" type="boolean">
12197	<desc>Whether this filter active or has been temporarily disabled.</desc>
12198	</attribute>
12199
12200	<attribute name="vendorId" type="wstring">
12201	<desc>
12202	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12203	The string representation for the <i>exact matching</i>
12204	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12205	(including leading zeroes).
12206	</desc>
12207	</attribute>
12208
12209	<attribute name="productId" type="wstring">
12210	<desc>
12211	<link to="IUSBDevice::productId">Product ID</link> filter.
12212	The string representation for the <i>exact matching</i>
12213	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12214	(including leading zeroes).
12215	</desc>
12216	</attribute>
12217
12218	<attribute name="revision" type="wstring">
12219	<desc>
12220	<link to="IUSBDevice::productId">Product revision number</link>
12221	filter. The string representation for the <i>exact matching</i>
12222	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12223	of the integer part of the revision, and <tt>F</tt> is the
12224	decimal digit of its fractional part (including leading and
12225	trailing zeros).
12226	Note that for interval filters, it's best to use the hexadecimal
12227	form, because the revision is stored as a 16 bit packed BCD value;
12228	so the expression <tt>int:0x0100-0x0199</tt> will match any
12229	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12230	</desc>
12231	</attribute>
12232
12233	<attribute name="manufacturer" type="wstring">
12234	<desc>
12235	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12236	</desc>
12237	</attribute>
12238
12239	<attribute name="product" type="wstring">
12240	<desc>
12241	<link to="IUSBDevice::product">Product</link> filter.
12242	</desc>
12243	</attribute>
12244
12245	<attribute name="serialNumber" type="wstring">
12246	<desc>
12247	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12248	</desc>
12249	</attribute>
12250
12251	<attribute name="port" type="wstring">
12252	<desc>
12253	<link to="IUSBDevice::port">Host USB port</link> filter.
12254	</desc>
12255	</attribute>
12256
12257	<attribute name="remote" type="wstring">
12258	<desc>
12259	<link to="IUSBDevice::remote">Remote state</link> filter.
12260	<note>
12261	This filter makes sense only for machine USB filters,
12262	i.e. it is ignored by IHostUSBDeviceFilter objects.
12263	</note>
12264	</desc>
12265	</attribute>
12266
12267	<attribute name="maskedInterfaces" type="unsigned long">
12268	<desc>
12269	This is an advanced option for hiding one or more USB interfaces
12270	from the guest. The value is a bit mask where the bits that are set
12271	means the corresponding USB interface should be hidden, masked off
12272	if you like.
12273	This feature only works on Linux hosts.
12274	</desc>
12275	</attribute>
12276
12277	</interface>
12278
12279
12280	<!--
12281	// IHostUSBDevice
12282	/////////////////////////////////////////////////////////////////////////
12283	-->
12284
12285	<enum
12286	name="USBDeviceState"
12287	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12288	>
12289	<desc>
12290	USB device state. This enumeration represents all possible states
12291	of the USB device physically attached to the host computer regarding
12292	its state on the host computer and availability to guest computers
12293	(all currently running virtual machines).
12294
12295	Once a supported USB device is attached to the host, global USB
12296	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12297	either ignore the device, or put it to USBDeviceState_Held state, or do
12298	nothing. Unless the device is ignored by global filters, filters of all
12299	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12300	activated that can put it to USBDeviceState_Captured state.
12301
12302	If the device was ignored by global filters, or didn't match
12303	any filters at all (including guest ones), it is handled by the host
12304	in a normal way. In this case, the device state is determined by
12305	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12306	or USBDeviceState_Available, depending on the current device usage.
12307
12308	Besides auto-capturing based on filters, the device can be manually
12309	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12310	state is USBDeviceState_Busy, USBDeviceState_Available or
12311	USBDeviceState_Held.
12312
12313	<note>
12314	Due to differences in USB stack implementations in Linux and Win32,
12315	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12316	only to the Linux version of the product. This also means that (<link
12317	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12318	device state is USBDeviceState_Held.
12319	</note>
12320
12321	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12322	</desc>
12323
12324	<const name="NotSupported" value="0">
12325	<desc>
12326	Not supported by the VirtualBox server, not available to guests.
12327	</desc>
12328	</const>
12329	<const name="Unavailable" value="1">
12330	<desc>
12331	Being used by the host computer exclusively,
12332	not available to guests.
12333	</desc>
12334	</const>
12335	<const name="Busy" value="2">
12336	<desc>
12337	Being used by the host computer, potentially available to guests.
12338	</desc>
12339	</const>
12340	<const name="Available" value="3">
12341	<desc>
12342	Not used by the host computer, available to guests (the host computer
12343	can also start using the device at any time).
12344	</desc>
12345	</const>
12346	<const name="Held" value="4">
12347	<desc>
12348	Held by the VirtualBox server (ignored by the host computer),
12349	available to guests.
12350	</desc>
12351	</const>
12352	<const name="Captured" value="5">
12353	<desc>
12354	Captured by one of the guest computers, not available
12355	to anybody else.
12356	</desc>
12357	</const>
12358	</enum>
12359
12360	<interface
12361	name="IHostUSBDevice" extends="IUSBDevice"
12362	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12363	wsmap="managed"
12364	>
12365	<desc>
12366	The IHostUSBDevice interface represents a physical USB device attached
12367	to the host computer.
12368
12369	Besides properties inherited from IUSBDevice, this interface adds the
12370	<link to="#state"/> property that holds the current state of the USB
12371	device.
12372
12373	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12374	</desc>
12375
12376	<attribute name="state" type="USBDeviceState" readonly="yes">
12377	<desc>
12378	Current state of the device.
12379	</desc>
12380	</attribute>
12381
12382	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12383
12384	</interface>
12385
12386
12387	<!--
12388	// IHostUSBDeviceFilter
12389	/////////////////////////////////////////////////////////////////////////
12390	-->
12391
12392	<enum
12393	name="USBDeviceFilterAction"
12394	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12395	>
12396	<desc>
12397	Actions for host USB device filters.
12398	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12399	</desc>
12400
12401	<const name="Null" value="0">
12402	<desc>Null value (never used by the API).</desc>
12403	</const>
12404	<const name="Ignore" value="1">
12405	<desc>Ignore the matched USB device.</desc>
12406	</const>
12407	<const name="Hold" value="2">
12408	<desc>Hold the matched USB device.</desc>
12409	</const>
12410	</enum>
12411
12412	<interface
12413	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12414	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12415	wsmap="managed"
12416	>
12417	<desc>
12418	The IHostUSBDeviceFilter interface represents a global filter for a
12419	physical USB device used by the host computer. Used indirectly in
12420	<link to="IHost::USBDeviceFilters"/>.
12421
12422	Using filters of this type, the host computer determines the initial
12423	state of the USB device after it is physically attached to the
12424	host's USB controller.
12425
12426	<note>
12427	The <link to="#remote"/> attribute is ignored by this type of
12428	filters, because it makes sense only for
12429	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12430	</note>
12431
12432	<see>IHost::USBDeviceFilters</see>
12433	</desc>
12434
12435	<attribute name="action" type="USBDeviceFilterAction">
12436	<desc>
12437	Action performed by the host when an attached USB device
12438	matches this filter.
12439	</desc>
12440	</attribute>
12441
12442	</interface>
12443
12444	<!--
12445	// IAudioAdapter
12446	/////////////////////////////////////////////////////////////////////////
12447	-->
12448
12449	<enum
12450	name="AudioDriverType"
12451	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12452	>
12453	<desc>
12454	Host audio driver type.
12455	</desc>
12456
12457	<const name="Null" value="0">
12458	<desc>Null value, also means "dummy audio driver".</desc>
12459	</const>
12460	<const name="WinMM" value="1">
12461	<desc>Windows multimedia (Windows hosts only).</desc>
12462	</const>
12463	<const name="OSS" value="2">
12464	<desc>Open Sound System (Linux hosts only).</desc>
12465	</const>
12466	<const name="ALSA" value="3">
12467	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12468	</const>
12469	<const name="DirectSound" value="4">
12470	<desc>DirectSound (Windows hosts only).</desc>
12471	</const>
12472	<const name="CoreAudio" value="5">
12473	<desc>CoreAudio (Mac hosts only).</desc>
12474	</const>
12475	<const name="MMPM" value="6">
12476	<desc>Reserved for historical reasons.</desc>
12477	</const>
12478	<const name="Pulse" value="7">
12479	<desc>PulseAudio (Linux hosts only).</desc>
12480	</const>
12481	<const name="SolAudio" value="8">
12482	<desc>Solaris audio (Solaris hosts only).</desc>
12483	</const>
12484	</enum>
12485
12486	<enum
12487	name="AudioControllerType"
12488	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12489	>
12490	<desc>
12491	Virtual audio controller type.
12492	</desc>
12493
12494	<const name="AC97" value="0"/>
12495	<const name="SB16" value="1"/>
12496	</enum>
12497
12498	<interface
12499	name="IAudioAdapter" extends="$unknown"
12500	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12501	wsmap="managed"
12502	>
12503	<desc>
12504	The IAudioAdapter interface represents the virtual audio adapter of
12505	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12506	</desc>
12507	<attribute name="enabled" type="boolean">
12508	<desc>
12509	Flag whether the audio adapter is present in the
12510	guest system. If disabled, the virtual guest hardware will
12511	not contain any audio adapter. Can only be changed when
12512	the VM is not running.
12513	</desc>
12514	</attribute>
12515	<attribute name="audioController" type="AudioControllerType">
12516	<desc>
12517	The audio hardware we emulate.
12518	</desc>
12519	</attribute>
12520	<attribute name="audioDriver" type="AudioDriverType">
12521	<desc>
12522	Audio driver the adapter is connected to. This setting
12523	can only be changed when the VM is not running.
12524	</desc>
12525	</attribute>
12526	</interface>
12527
12528	<!--
12529	// IVRDPServer
12530	/////////////////////////////////////////////////////////////////////////
12531	-->
12532
12533	<enum
12534	name="VRDPAuthType"
12535	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12536	>
12537	<desc>
12538	VRDP authentication type.
12539	</desc>
12540
12541	<const name="Null" value="0">
12542	<desc>Null value, also means "no authentication".</desc>
12543	</const>
12544	<const name="External" value="1"/>
12545	<const name="Guest" value="2"/>
12546	</enum>
12547
12548	<interface
12549	name="IVRDPServer" extends="$unknown"
12550	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12551	wsmap="managed"
12552	>
12553	<attribute name="enabled" type="boolean">
12554	<desc>VRDP server status.</desc>
12555	</attribute>
12556
12557	<attribute name="ports" type="wstring">
12558	<desc>
12559	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12560	<note>
12561	This is a string of comma separated TCP port numbers or port number ranges.
12562	Example <tt>5000,5010-5012,5015</tt>
12563	</note>
12564	</desc>
12565	</attribute>
12566
12567	<attribute name="netAddress" type="wstring">
12568	<desc>VRDP server address.</desc>
12569	</attribute>
12570
12571	<attribute name="authType" type="VRDPAuthType">
12572	<desc>VRDP authentication method.</desc>
12573	</attribute>
12574
12575	<attribute name="authTimeout" type="unsigned long">
12576	<desc>Timeout for guest authentication. Milliseconds.</desc>
12577	</attribute>
12578
12579	<attribute name="allowMultiConnection" type="boolean">
12580	<desc>
12581	Flag whether multiple simultaneous connections to the VM are permitted.
12582	Note that this will be replaced by a more powerful mechanism in the future.
12583	</desc>
12584	</attribute>
12585
12586	<attribute name="reuseSingleConnection" type="boolean">
12587	<desc>
12588	Flag whether the existing connection must be dropped and a new connection
12589	must be established by the VRDP server, when a new client connects in single
12590	connection mode.
12591	</desc>
12592	</attribute>
12593
12594	</interface>
12595
12596
12597	<!--
12598	// ISharedFolder
12599	/////////////////////////////////////////////////////////////////////////
12600	-->
12601
12602	<interface
12603	name="ISharedFolder" extends="$unknown"
12604	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12605	wsmap="struct"
12606	>
12607	<desc>
12608	The ISharedFolder interface represents a folder in the host computer's
12609	file system accessible from the guest OS running inside a virtual
12610	machine using an associated logical name.
12611
12612	There are three types of shared folders:
12613	<ul>
12614	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12615	folders available to all virtual machines.</li>
12616	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12617	VM-specific shared folders available to the given virtual machine at
12618	startup.</li>
12619	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12620	VM-specific shared folders created in the session context (for
12621	example, when the virtual machine is running) and automatically
12622	discarded when the session is closed (the VM is powered off).</li>
12623	</ul>
12624
12625	Logical names of shared folders must be unique within the given scope
12626	(global, permanent or transient). However, they do not need to be unique
12627	across scopes. In this case, the definition of the shared folder in a
12628	more specific scope takes precedence over definitions in all other
12629	scopes. The order of precedence is (more specific to more general):
12630	<ol>
12631	<li>Transient definitions</li>
12632	<li>Permanent definitions</li>
12633	<li>Global definitions</li>
12634	</ol>
12635
12636	For example, if MyMachine has a shared folder named
12637	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12638	transient shared folder named <tt>C_DRIVE</tt> (that points
12639	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12640	of <tt>C_DRIVE</tt> in the guest OS so
12641	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12642	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12643	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12644	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12645	to <tt>C:\\</tt> if it still exists.
12646
12647	Note that permanent and transient shared folders of different machines
12648	are in different name spaces, so they don't overlap and don't need to
12649	have unique logical names.
12650
12651	<note>
12652	Global shared folders are not implemented in the current version of the
12653	product.
12654	</note>
12655	</desc>
12656
12657	<attribute name="name" type="wstring" readonly="yes">
12658	<desc>Logical name of the shared folder.</desc>
12659	</attribute>
12660
12661	<attribute name="hostPath" type="wstring" readonly="yes">
12662	<desc>Full path to the shared folder in the host file system.</desc>
12663	</attribute>
12664
12665	<attribute name="accessible" type="boolean" readonly="yes">
12666	<desc>
12667	Whether the folder defined by the host path is currently
12668	accessible or not.
12669	For example, the folder can be unaccessible if it is placed
12670	on the network share that is not available by the time
12671	this property is read.
12672	</desc>
12673	</attribute>
12674
12675	<attribute name="writable" type="boolean" readonly="yes">
12676	<desc>
12677	Whether the folder defined by the host path is writable or
12678	not.
12679	</desc>
12680	</attribute>
12681
12682	<attribute name="lastAccessError" type="wstring" readonly="yes">
12683	<desc>
12684	Text message that represents the result of the last accessibility
12685	check.
12686
12687	Accessibility checks are performed each time the <link to="#accessible"/>
12688	attribute is read. An empty string is returned if the last
12689	accessibility check was successful. A non-empty string indicates a
12690	failure and should normally describe a reason of the failure (for
12691	example, a file read error).
12692	</desc>
12693	</attribute>
12694
12695	</interface>
12696
12697	<!--
12698	// ISession
12699	/////////////////////////////////////////////////////////////////////////
12700	-->
12701
12702	<interface
12703	name="IInternalSessionControl" extends="$unknown"
12704	uuid="f9aac6d0-41b3-46b7-bea4-6370b4036de6"
12705	internal="yes"
12706	wsmap="suppress"
12707	>
12708	<method name="getPID">
12709	<desc>PID of the process that has created this Session object.
12710	</desc>
12711	<param name="pid" type="unsigned long" dir="return"/>
12712	</method>
12713
12714	<method name="getRemoteConsole">
12715	<desc>
12716	Returns the console object suitable for remote control.
12717
12718	<result name="VBOX_E_INVALID_VM_STATE">
12719	Session state prevents operation.
12720	</result>
12721	<result name="VBOX_E_INVALID_OBJECT_STATE">
12722	Session type prevents operation.
12723	</result>
12724
12725	</desc>
12726	<param name="console" type="IConsole" dir="return"/>
12727	</method>
12728
12729	<method name="assignMachine">
12730	<desc>
12731	Assigns the machine object associated with this direct-type
12732	session or informs the session that it will be a remote one
12733	(if @a machine == @c null).
12734
12735	<result name="VBOX_E_INVALID_VM_STATE">
12736	Session state prevents operation.
12737	</result>
12738	<result name="VBOX_E_INVALID_OBJECT_STATE">
12739	Session type prevents operation.
12740	</result>
12741
12742	</desc>
12743	<param name="machine" type="IMachine" dir="in"/>
12744	</method>
12745
12746	<method name="assignRemoteMachine">
12747	<desc>
12748	Assigns the machine and the (remote) console object associated with
12749	this remote-type session.
12750
12751	<result name="VBOX_E_INVALID_VM_STATE">
12752	Session state prevents operation.
12753	</result>
12754
12755	</desc>
12756	<param name="machine" type="IMachine" dir="in"/>
12757	<param name="console" type="IConsole" dir="in"/>
12758	</method>
12759
12760	<method name="updateMachineState">
12761	<desc>
12762	Updates the machine state in the VM process.
12763	Must be called only in certain cases
12764	(see the method implementation).
12765
12766	<result name="VBOX_E_INVALID_VM_STATE">
12767	Session state prevents operation.
12768	</result>
12769	<result name="VBOX_E_INVALID_OBJECT_STATE">
12770	Session type prevents operation.
12771	</result>
12772
12773	</desc>
12774	<param name="aMachineState" type="MachineState" dir="in"/>
12775	</method>
12776
12777	<method name="uninitialize">
12778	<desc>
12779	Uninitializes (closes) this session. Used by VirtualBox to close
12780	the corresponding remote session when the direct session dies
12781	or gets closed.
12782
12783	<result name="VBOX_E_INVALID_VM_STATE">
12784	Session state prevents operation.
12785	</result>
12786
12787	</desc>
12788	</method>
12789
12790	<method name="onNetworkAdapterChange">
12791	<desc>
12792	Triggered when settings of a network adapter of the
12793	associated virtual machine have changed.
12794
12795	<result name="VBOX_E_INVALID_VM_STATE">
12796	Session state prevents operation.
12797	</result>
12798	<result name="VBOX_E_INVALID_OBJECT_STATE">
12799	Session type prevents operation.
12800	</result>
12801
12802	</desc>
12803	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12804	<param name="changeAdapter" type="boolean" dir="in"/>
12805	</method>
12806
12807	<method name="onSerialPortChange">
12808	<desc>
12809	Triggered when settings of a serial port of the
12810	associated virtual machine have changed.
12811
12812	<result name="VBOX_E_INVALID_VM_STATE">
12813	Session state prevents operation.
12814	</result>
12815	<result name="VBOX_E_INVALID_OBJECT_STATE">
12816	Session type prevents operation.
12817	</result>
12818
12819	</desc>
12820	<param name="serialPort" type="ISerialPort" dir="in"/>
12821	</method>
12822
12823	<method name="onParallelPortChange">
12824	<desc>
12825	Triggered when settings of a parallel port of the
12826	associated virtual machine have changed.
12827
12828	<result name="VBOX_E_INVALID_VM_STATE">
12829	Session state prevents operation.
12830	</result>
12831	<result name="VBOX_E_INVALID_OBJECT_STATE">
12832	Session type prevents operation.
12833	</result>
12834
12835	</desc>
12836	<param name="parallelPort" type="IParallelPort" dir="in"/>
12837	</method>
12838
12839	<method name="onStorageControllerChange">
12840	<desc>
12841	Triggered when settings of a storage controller of the
12842	associated virtual machine have changed.
12843
12844	<result name="VBOX_E_INVALID_VM_STATE">
12845	Session state prevents operation.
12846	</result>
12847	<result name="VBOX_E_INVALID_OBJECT_STATE">
12848	Session type prevents operation.
12849	</result>
12850
12851	</desc>
12852	</method>
12853
12854	<method name="onMediumChange">
12855	<desc>
12856	Triggered when attached media of the
12857	associated virtual machine have changed.
12858
12859	<result name="VBOX_E_INVALID_VM_STATE">
12860	Session state prevents operation.
12861	</result>
12862	<result name="VBOX_E_INVALID_OBJECT_STATE">
12863	Session type prevents operation.
12864	</result>
12865
12866	</desc>
12867
12868	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12869	<param name="force" type="boolean" dir="in"/>
12870	</method>
12871
12872	<method name="onCPUChange">
12873	<desc>
12874	Notification when a CPU changes.
12875	</desc>
12876	<param name="cpu" type="unsigned long" dir="in">
12877	<desc>The CPU which changed</desc>
12878	</param>
12879	<param name="add" type="boolean" dir="in">
12880	<desc>Flag whether the CPU was added or removed</desc>
12881	</param>
12882	</method>
12883
12884	<method name="onVRDPServerChange">
12885	<desc>
12886	Triggered when settings of the VRDP server object of the
12887	associated virtual machine have changed.
12888
12889	<result name="VBOX_E_INVALID_VM_STATE">
12890	Session state prevents operation.
12891	</result>
12892	<result name="VBOX_E_INVALID_OBJECT_STATE">
12893	Session type prevents operation.
12894	</result>
12895
12896	</desc>
12897	</method>
12898
12899	<method name="onUSBControllerChange">
12900	<desc>
12901	Triggered when settings of the USB controller object of the
12902	associated virtual machine have changed.
12903
12904	<result name="VBOX_E_INVALID_VM_STATE">
12905	Session state prevents operation.
12906	</result>
12907	<result name="VBOX_E_INVALID_OBJECT_STATE">
12908	Session type prevents operation.
12909	</result>
12910
12911	</desc>
12912	</method>
12913
12914	<method name="onSharedFolderChange">
12915	<desc>
12916	Triggered when a permanent (global or machine) shared folder has been
12917	created or removed.
12918	<note>
12919	We don't pass shared folder parameters in this notification because
12920	the order in which parallel notifications are delivered is not defined,
12921	therefore it could happen that these parameters were outdated by the
12922	time of processing this notification.
12923	</note>
12924
12925	<result name="VBOX_E_INVALID_VM_STATE">
12926	Session state prevents operation.
12927	</result>
12928	<result name="VBOX_E_INVALID_OBJECT_STATE">
12929	Session type prevents operation.
12930	</result>
12931
12932	</desc>
12933	<param name="global" type="boolean" dir="in"/>
12934	</method>
12935
12936	<method name="onUSBDeviceAttach">
12937	<desc>
12938	Triggered when a request to capture a USB device (as a result
12939	of matched USB filters or direct call to
12940	<link to="IConsole::attachUSBDevice"/>) has completed.
12941	A @c null @a error object means success, otherwise it
12942	describes a failure.
12943
12944	<result name="VBOX_E_INVALID_VM_STATE">
12945	Session state prevents operation.
12946	</result>
12947	<result name="VBOX_E_INVALID_OBJECT_STATE">
12948	Session type prevents operation.
12949	</result>
12950
12951	</desc>
12952	<param name="device" type="IUSBDevice" dir="in"/>
12953	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12954	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12955	</method>
12956
12957	<method name="onUSBDeviceDetach">
12958	<desc>
12959	Triggered when a request to release the USB device (as a result
12960	of machine termination or direct call to
12961	<link to="IConsole::detachUSBDevice"/>) has completed.
12962	A @c null @a error object means success, otherwise it
12963	describes a failure.
12964
12965	<result name="VBOX_E_INVALID_VM_STATE">
12966	Session state prevents operation.
12967	</result>
12968	<result name="VBOX_E_INVALID_OBJECT_STATE">
12969	Session type prevents operation.
12970	</result>
12971
12972	</desc>
12973	<param name="id" type="uuid" mod="string" dir="in"/>
12974	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12975	</method>
12976
12977	<method name="onShowWindow">
12978	<desc>
12979	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12980	<link to="IMachine::showConsoleWindow"/> in order to notify
12981	console callbacks
12982	<link to="IConsoleCallback::onCanShowWindow"/>
12983	and <link to="IConsoleCallback::onShowWindow"/>.
12984
12985	<result name="VBOX_E_INVALID_OBJECT_STATE">
12986	Session type prevents operation.
12987	</result>
12988
12989	</desc>
12990	<param name="check" type="boolean" dir="in"/>
12991	<param name="canShow" type="boolean" dir="out"/>
12992	<param name="winId" type="unsigned long long" dir="out"/>
12993	</method>
12994
12995	<method name="accessGuestProperty">
12996	<desc>
12997	Called by <link to="IMachine::getGuestProperty"/> and by
12998	<link to="IMachine::setGuestProperty"/> in order to read and
12999	modify guest properties.
13000
13001	<result name="VBOX_E_INVALID_VM_STATE">
13002	Machine session is not open.
13003	</result>
13004	<result name="VBOX_E_INVALID_OBJECT_STATE">
13005	Session type is not direct.
13006	</result>
13007
13008	</desc>
13009	<param name="name" type="wstring" dir="in"/>
13010	<param name="value" type="wstring" dir="in"/>
13011	<param name="flags" type="wstring" dir="in"/>
13012	<param name="isSetter" type="boolean" dir="in"/>
13013	<param name="retValue" type="wstring" dir="out"/>
13014	<param name="retTimestamp" type="unsigned long long" dir="out"/>
13015	<param name="retFlags" type="wstring" dir="out"/>
13016	</method>
13017
13018	<method name="enumerateGuestProperties">
13019	<desc>
13020	Return a list of the guest properties matching a set of patterns along
13021	with their values, time stamps and flags.
13022
13023	<result name="VBOX_E_INVALID_VM_STATE">
13024	Machine session is not open.
13025	</result>
13026	<result name="VBOX_E_INVALID_OBJECT_STATE">
13027	Session type is not direct.
13028	</result>
13029
13030	</desc>
13031	<param name="patterns" type="wstring" dir="in">
13032	<desc>
13033	The patterns to match the properties against as a comma-separated
13034	string. If this is empty, all properties currently set will be
13035	returned.
13036	</desc>
13037	</param>
13038	<param name="key" type="wstring" dir="out" safearray="yes">
13039	<desc>
13040	The key names of the properties returned.
13041	</desc>
13042	</param>
13043	<param name="value" type="wstring" dir="out" safearray="yes">
13044	<desc>
13045	The values of the properties returned. The array entries match the
13046	corresponding entries in the @a key array.
13047	</desc>
13048	</param>
13049	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
13050	<desc>
13051	The time stamps of the properties returned. The array entries match
13052	the corresponding entries in the @a key array.
13053	</desc>
13054	</param>
13055	<param name="flags" type="wstring" dir="out" safearray="yes">
13056	<desc>
13057	The flags of the properties returned. The array entries match the
13058	corresponding entries in the @a key array.
13059	</desc>
13060	</param>
13061	</method>
13062
13063	</interface>
13064
13065	<interface
13066	name="ISession" extends="$dispatched"
13067	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13068	wsmap="managed"
13069	>
13070	<desc>
13071	The ISession interface represents a serialization primitive for virtual
13072	machines.
13073
13074	With VirtualBox, every time one wishes to manipulate a virtual machine
13075	(e.g. change its settings or start execution), a session object is
13076	required. Such an object must be passed to one of the session methods
13077	that open the given session, which then initiates the machine manipulation.
13078
13079	A session serves several purposes: it identifies to the inter-process VirtualBox
13080	code which process is currently working with the virtual machine, and it ensures
13081	that there are no incompatible requests from several processes for the
13082	same virtual machine. Session objects can therefore be thought of as mutex
13083	semaphores that lock virtual machines to prevent conflicting accesses from
13084	several processes.
13085
13086	How sessions objects are used depends on whether you use the Main API
13087	via COM or via the webservice:
13088
13089	<ul>
13090	<li>When using the COM API directly, an object of the Session class from the
13091	VirtualBox type library needs to be created. In regular COM C++ client code,
13092	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13093	This object will then act as a local session object in further calls to open
13094	a session.
13095	</li>
13096
13097	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13098	one session object automatically when <link to="IWebsessionManager::logon" />
13099	is called. A managed object reference to that session object can be retrieved by
13100	calling <link to="IWebsessionManager::getSessionObject" />. This session object
13101	reference can then be used to open sessions.
13102	</li>
13103	</ul>
13104
13105	Sessions are mainly used in two variations:
13106
13107	<ul>
13108	<li>
13109	To start a virtual machine in a separate process, one would call
13110	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
13111	object as its first parameter. This session then identifies the caller
13112	and lets him control the started machine (for example, pause machine
13113	execution or power it down) as well as be notified about machine
13114	execution state changes.
13115	</li>
13116
13117	<li>To alter machine settings, or to start machine execution within the
13118	current process, one needs to open a direct session for the machine first by
13119	calling <link to="IVirtualBox::openSession"/>. While a direct session
13120	is open within one process, no any other process may open another direct
13121	session for the same machine. This prevents the machine from being changed
13122	by other processes while it is running or while the machine is being configured.
13123	</li>
13124	</ul>
13125
13126	One also can attach to an existing direct session already opened by
13127	another process (for example, in order to send a control request to the
13128	virtual machine such as the pause or the reset request). This is done by
13129	calling <link to="IVirtualBox::openExistingSession"/>.
13130
13131	<note>
13132	Unless you are trying to write a new VirtualBox front-end that
13133	performs direct machine execution (like the VirtualBox or VBoxSDL
13134	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
13135	session opened by <link to="IVirtualBox::openSession"/> and use this
13136	session only to change virtual machine settings. If you simply want to
13137	start virtual machine execution using one of the existing front-ends
13138	(for example the VirtualBox GUI or headless server), simply use
13139	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
13140	will power up the machine automatically for you.
13141	</note>
13142	</desc>
13143
13144	<attribute name="state" type="SessionState" readonly="yes">
13145	<desc>Current state of this session.</desc>
13146	</attribute>
13147
13148	<attribute name="type" type="SessionType" readonly="yes">
13149	<desc>
13150	Type of this session. The value of this attribute is valid only
13151	if the session is currently open (i.e. its #state is
13152	SessionType_SessionOpen), otherwise an error will be returned.
13153	</desc>
13154	</attribute>
13155
13156	<attribute name="machine" type="IMachine" readonly="yes">
13157	<desc>Machine object associated with this session.</desc>
13158	</attribute>
13159
13160	<attribute name="console" type="IConsole" readonly="yes">
13161	<desc>Console object associated with this session.</desc>
13162	</attribute>
13163
13164	<method name="close">
13165	<desc>
13166	Closes a session that was previously opened.
13167
13168	It is recommended that every time an "open session" method (such as
13169	<link to="IVirtualBox::openRemoteSession" /> or
13170	<link to="IVirtualBox::openSession" />) has been called to
13171	manipulate a virtual machine, the caller invoke
13172	ISession::close() when it's done doing so. Since sessions are
13173	serialization primitives much like ordinary mutexes, they are
13174	best used the same way: for each "open" call, there should be
13175	a matching "close" call, even when errors occur.
13176
13177	Otherwise, if a direct session for a machine opened with
13178	<link to="IVirtualBox::openSession"/> is not explicitly closed
13179	when the application terminates, the state of the machine will
13180	be set to <link to="MachineState_Aborted" /> on the server.
13181
13182	Generally, it is recommended to close all open sessions explicitly
13183	before terminating the application (regardless of the reason for
13184	the termination).
13185
13186	<note>
13187	Do not expect the session state (<link to="ISession::state" />
13188	to return to "Closed" immediately after you invoke
13189	ISession::close(), particularly if you have started a remote
13190	session to execute the VM in a new process. The session state will
13191	automatically return to "Closed" once the VM is no longer executing,
13192	which can of course take a very long time.
13193	</note>
13194
13195	<result name="E_UNEXPECTED">
13196	Session is not open.
13197	</result>
13198
13199	</desc>
13200	</method>
13201
13202	</interface>
13203
13204	<!--
13205	// IStorageController
13206	/////////////////////////////////////////////////////////////////////////
13207	-->
13208
13209	<enum
13210	name="StorageBus"
13211	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13212	>
13213	<desc>
13214	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
13215	see <link to="IStorageController::bus" />.
13216	</desc>
13217	<const name="Null" value="0">
13218	<desc>@c null value. Never used by the API.</desc>
13219	</const>
13220	<const name="IDE" value="1"/>
13221	<const name="SATA" value="2"/>
13222	<const name="SCSI" value="3"/>
13223	<const name="Floppy" value="4"/>
13224	<const name="SAS" value="5"/>
13225	</enum>
13226
13227	<enum
13228	name="StorageControllerType"
13229	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13230	>
13231	<desc>
13232	The exact variant of storage controller hardware presented
13233	to the guest; see <link to="IStorageController::controllerType" />.
13234	</desc>
13235
13236	<const name="Null" value="0">
13237	<desc>@c null value. Never used by the API.</desc>
13238	</const>
13239	<const name="LsiLogic" value="1">
13240	<desc>A SCSI controller of the LsiLogic variant.</desc>
13241	</const>
13242	<const name="BusLogic" value="2">
13243	<desc>A SCSI controller of the BusLogic variant.</desc>
13244	</const>
13245	<const name="IntelAhci" value="3">
13246	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13247	</const>
13248	<const name="PIIX3" value="4">
13249	<desc>An IDE controller of the PIIX3 variant.</desc>
13250	</const>
13251	<const name="PIIX4" value="5">
13252	<desc>An IDE controller of the PIIX4 variant.</desc>
13253	</const>
13254	<const name="ICH6" value="6">
13255	<desc>An IDE controller of the ICH6 variant.</desc>
13256	</const>
13257	<const name="I82078" value="7">
13258	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13259	</const>
13260	<const name="LsiLogicSas" value="8">
13261	<desc>A variant of the LsiLogic controller using SAS.</desc>
13262	</const>
13263	</enum>
13264
13265	<interface
13266	name="IStorageController" extends="$unknown"
13267	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
13268	wsmap="managed"
13269	>
13270	<desc>
13271	Represents a storage controller that is attached to a virtual machine
13272	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13273	attached to storage controllers in a real computer, virtual drives
13274	(represented by <link to="IMediumAttachment" />) are attached to virtual
13275	storage controllers, represented by this interface.
13276
13277	As opposed to physical hardware, VirtualBox has a very generic concept
13278	of a storage controller, and for purposes of the Main API, all virtual
13279	storage is attached to virtual machines via instances of this interface.
13280	There are four types of such virtual storage controllers: IDE, SCSI, SATA
13281	and Floppy (see <link to="#bus" />). Depending on which of these four is
13282	used, certain sub-types may be available and can be selected in
13283	<link to="#controllerType" />.
13284
13285	Depending on these settings, the guest operating system might see
13286	significantly different virtual hardware.
13287	</desc>
13288
13289	<attribute name="name" type="wstring" readonly="yes">
13290	<desc>
13291	Name of the storage controller, as originally specified with
13292	<link to="IMachine::addStorageController" />. This then uniquely
13293	identifies this controller with other method calls such as
13294	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13295	</desc>
13296	</attribute>
13297
13298	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13299	<desc>
13300	Maximum number of devices which can be attached to one port.
13301	</desc>
13302	</attribute>
13303
13304	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13305	<desc>
13306	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13307	</desc>
13308	</attribute>
13309
13310	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13311	<desc>
13312	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13313	</desc>
13314	</attribute>
13315
13316	<attribute name="instance" type="unsigned long">
13317	<desc>
13318	The instance number of the device in the running VM.
13319	</desc>
13320	</attribute>
13321
13322	<attribute name="portCount" type="unsigned long">
13323	<desc>
13324	The number of currently usable ports on the controller.
13325	The minimum and maximum number of ports for one controller are
13326	stored in <link to="IStorageController::minPortCount"/>
13327	and <link to="IStorageController::maxPortCount"/>.
13328	</desc>
13329	</attribute>
13330
13331	<attribute name="bus" type="StorageBus" readonly="yes">
13332	<desc>
13333	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
13334	</desc>
13335	</attribute>
13336
13337	<attribute name="controllerType" type="StorageControllerType">
13338	<desc>
13339	The exact variant of storage controller hardware presented
13340	to the guest.
13341	Depending on this value, VirtualBox will provide a different
13342	virtual storage controller hardware to the guest.
13343	For SATA and floppy controllers, only one variant is available,
13344	but for IDE and SCSI, there are several.
13345
13346	For SCSI controllers, the default type is LsiLogic.
13347	</desc>
13348	</attribute>
13349
13350	<method name="GetIDEEmulationPort">
13351	<desc>
13352	Gets the corresponding port number which is emulated as an IDE device.
13353	Works only with SATA controllers.
13354
13355	<result name="E_INVALIDARG">
13356	The @a devicePosition is not in the range 0 to 3.
13357	</result>
13358	<result name="E_NOTIMPL">
13359	The storage controller type is not SATAIntelAhci.
13360	</result>
13361
13362	</desc>
13363	<param name="devicePosition" type="long" dir="in"/>
13364	<param name="portNumber" type="long" dir="return"/>
13365	</method>
13366
13367	<method name="SetIDEEmulationPort">
13368	<desc>
13369	Sets the port number which is emulated as an IDE device.
13370	Works only with SATA controllers.
13371
13372	<result name="E_INVALIDARG">
13373	The @a devicePosition is not in the range 0 to 3 or the
13374	@a portNumber is not in the range 0 to 29.
13375	</result>
13376	<result name="E_NOTIMPL">
13377	The storage controller type is not SATAIntelAhci.
13378	</result>
13379
13380	</desc>
13381	<param name="devicePosition" type="long" dir="in"/>
13382	<param name="portNumber" type="long" dir="in"/>
13383	</method>
13384
13385	</interface>
13386
13387	<if target="wsdl">
13388
13389	<!--
13390	// IManagedObjectRef
13391	/////////////////////////////////////////////////////////////////////////
13392	-->
13393
13394	<interface
13395	name="IManagedObjectRef" extends="$unknown"
13396	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13397	internal="yes"
13398	wsmap="managed"
13399	wscpp="hardcoded"
13400	>
13401	<desc>
13402	Managed object reference.
13403
13404	Only within the webservice, a managed object reference (which is really
13405	an opaque number) allows a webservice client to address an object
13406	that lives in the address space of the webservice server.
13407
13408	Behind each managed object reference, there is a COM object that lives
13409	in the webservice server's address space. The COM object is not freed
13410	until the managed object reference is released, either by an explicit
13411	call to <link to="IManagedObjectRef::release" /> or by logging off from
13412	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13413	all objects created during the webservice session.
13414
13415	Whenever a method call of the VirtualBox API returns a COM object, the
13416	webservice representation of that method will instead return a
13417	managed object reference, which can then be used to invoke methods
13418	on that object.
13419	</desc>
13420
13421	<method name="getInterfaceName">
13422	<desc>
13423	Returns the name of the interface that this managed object represents,
13424	for example, "IMachine", as a string.
13425	</desc>
13426	<param name="return" type="wstring" dir="return"/>
13427	</method>
13428
13429	<method name="release">
13430	<desc>
13431	Releases this managed object reference and frees the resources that
13432	were allocated for it in the webservice server process. After calling
13433	this method, the identifier of the reference can no longer be used.
13434	</desc>
13435	</method>
13436
13437	</interface>
13438
13439	<!--
13440	// IWebsessionManager
13441	/////////////////////////////////////////////////////////////////////////
13442	-->
13443
13444	<interface
13445	name="IWebsessionManager" extends="$unknown"
13446	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13447	internal="yes"
13448	wsmap="global"
13449	wscpp="hardcoded"
13450	>
13451	<desc>
13452	Websession manager. This provides essential services
13453	to webservice clients.
13454	</desc>
13455	<method name="logon">
13456	<desc>
13457	Logs a new client onto the webservice and returns a managed object reference to
13458	the IVirtualBox instance, which the client can then use as a basis to further
13459	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13460	interface, in one way or the other.
13461	</desc>
13462	<param name="username" type="wstring" dir="in"/>
13463	<param name="password" type="wstring" dir="in"/>
13464	<param name="return" type="IVirtualBox" dir="return"/>
13465	</method>
13466
13467	<method name="getSessionObject">
13468	<desc>
13469	Returns a managed object reference to the internal ISession object that was created
13470	for this web service session when the client logged on.
13471
13472	<see>ISession</see>
13473	</desc>
13474	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13475	<param name="return" type="ISession" dir="return"/>
13476	</method>
13477
13478	<method name="logoff">
13479	<desc>
13480	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13481	and destroys all resources associated with the session (most importantly, all
13482	managed objects created in the server while the session was active).
13483	</desc>
13484	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13485	</method>
13486
13487	</interface>
13488
13489	</if>
13490
13491	<!--
13492	// IPerformanceCollector & friends
13493	/////////////////////////////////////////////////////////////////////////
13494	-->
13495
13496	<interface
13497	name="IPerformanceMetric" extends="$unknown"
13498	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13499	>
13500	<desc>
13501	The IPerformanceMetric interface represents parameters of the given
13502	performance metric.
13503	</desc>
13504
13505	<attribute name="metricName" type="wstring" readonly="yes">
13506	<desc>
13507	Name of the metric.
13508	</desc>
13509	</attribute>
13510
13511	<attribute name="object" type="$unknown" readonly="yes">
13512	<desc>
13513	Object this metric belongs to.
13514	</desc>
13515	</attribute>
13516
13517	<attribute name="description" type="wstring" readonly="yes">
13518	<desc>
13519	Textual description of the metric.
13520	</desc>
13521	</attribute>
13522
13523	<attribute name="period" type="unsigned long" readonly="yes">
13524	<desc>
13525	Time interval between samples, measured in seconds.
13526	</desc>
13527	</attribute>
13528
13529	<attribute name="count" type="unsigned long" readonly="yes">
13530	<desc>
13531	Number of recent samples retained by the performance collector for this
13532	metric.
13533
13534	When the collected sample count exceeds this number, older samples
13535	are discarded.
13536	</desc>
13537	</attribute>
13538
13539	<attribute name="unit" type="wstring" readonly="yes">
13540	<desc>
13541	Unit of measurement.
13542	</desc>
13543	</attribute>
13544
13545	<attribute name="minimumValue" type="long" readonly="yes">
13546	<desc>
13547	Minimum possible value of this metric.
13548	</desc>
13549	</attribute>
13550
13551	<attribute name="maximumValue" type="long" readonly="yes">
13552	<desc>
13553	Maximum possible value of this metric.
13554	</desc>
13555	</attribute>
13556	</interface>
13557
13558	<interface
13559	name="IPerformanceCollector" extends="$unknown"
13560	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13561	wsmap="managed"
13562	>
13563	<desc>
13564	The IPerformanceCollector interface represents a service that collects and
13565	stores performance metrics data.
13566
13567	Performance metrics are associated with objects of interfaces like IHost and
13568	IMachine. Each object has a distinct set of performance metrics.
13569	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13570
13571	Metric data is collected at the specified intervals and is retained
13572	internally. The interval and the number of retained samples can be set
13573	with <link to="IPerformanceCollector::setupMetrics" />.
13574
13575	Metrics are organized hierarchically, with each level separated by a
13576	slash (/) character. Generally, the scheme for metric names is like this:
13577
13578	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13579
13580	"Category/Metric" together form the base metric name. A base metric is the
13581	smallest unit for which a sampling interval and the number of retained
13582	samples can be set. Only base metrics can be enabled and disabled. All
13583	sub-metrics are collected when their base metric is collected.
13584	Collected values for any set of sub-metrics can be queried with
13585	<link to="IPerformanceCollector::queryMetricsData" />.
13586
13587	For example "CPU/Load/User:avg"
13588	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13589	"average" aggregate. An aggregate function is computed over all retained
13590	data. Valid aggregate functions are:
13591
13592	<ul>
13593	<li>avg -- average</li>
13594	<li>min -- minimum</li>
13595	<li>max -- maximum</li>
13596	</ul>
13597
13598	When setting up
13599	metric parameters, querying metric data, enabling or disabling metrics
13600	wildcards can be used in metric names to specify a subset of metrics. For
13601	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13602	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13603	values without aggregates <tt>*:</tt> can be used.
13604
13605	The valid names for base metrics are:
13606
13607	<ul>
13608	<li>CPU/Load</li>
13609	<li>CPU/MHz</li>
13610	<li>RAM/Usage</li>
13611	</ul>
13612
13613	The general sequence for collecting and retrieving the metrics is:
13614	<ul>
13615	<li>
13616	Obtain an instance of IPerformanceCollector with
13617	<link to="IVirtualBox::performanceCollector" />
13618	</li>
13619	<li>
13620	Allocate and populate an array with references to objects the metrics
13621	will be collected for. Use references to IHost and IMachine objects.
13622	</li>
13623	<li>
13624	Allocate and populate an array with base metric names the data will be
13625	collected for.
13626	</li>
13627	<li>
13628	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13629	metric data will be collected and stored.
13630	</li>
13631	<li>
13632	Wait for the data to get collected.
13633	</li>
13634	<li>
13635	Allocate and populate an array with references to objects the metric
13636	values will be queried for. You can re-use the object array used for
13637	setting base metrics.
13638	</li>
13639	<li>
13640	Allocate and populate an array with metric names the data will be
13641	collected for. Note that metric names differ from base metric names.
13642	</li>
13643	<li>
13644	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13645	have been collected so far are returned. Note that the values are still
13646	retained internally and data collection continues.
13647	</li>
13648	</ul>
13649
13650	For an example of usage refer to the following files in VirtualBox SDK:
13651	<ul>
13652	<li>
13653	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13654	</li>
13655	<li>
13656	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13657	</li>
13658	</ul>
13659	</desc>
13660
13661	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13662	<desc>
13663	Array of unique names of metrics.
13664
13665	This array represents all metrics supported by the performance
13666	collector. Individual objects do not necessarily support all of them.
13667	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13668	list of supported metrics for a particular object.
13669	</desc>
13670	</attribute>
13671
13672	<method name="getMetrics">
13673	<desc>
13674	Returns parameters of specified metrics for a set of objects.
13675	<note>
13676	@c Null metrics array means all metrics. @c Null object array means
13677	all existing objects.
13678	</note>
13679	</desc>
13680	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13681	<desc>
13682	Metric name filter. Currently, only a comma-separated list of metrics
13683	is supported.
13684	</desc>
13685	</param>
13686	<param name="objects" type="$unknown" dir="in" safearray="yes">
13687	<desc>
13688	Set of objects to return metric parameters for.
13689	</desc>
13690	</param>
13691	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13692	<desc>
13693	Array of returned metric parameters.
13694	</desc>
13695	</param>
13696	</method>
13697
13698	<method name="setupMetrics">
13699	<desc>
13700	Sets parameters of specified base metrics for a set of objects. Returns
13701	an array of <link to="IPerformanceMetric" /> describing the metrics have
13702	been affected.
13703	<note>
13704	@c Null or empty metric name array means all metrics. @c Null or empty
13705	object array means all existing objects. If metric name array contains
13706	a single element and object array contains many, the single metric
13707	name array element is applied to each object array element to form
13708	metric/object pairs.
13709	</note>
13710	</desc>
13711	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13712	<desc>
13713	Metric name filter. Comma-separated list of metrics with wildcard
13714	support.
13715	</desc>
13716	</param>
13717	<param name="objects" type="$unknown" dir="in" safearray="yes">
13718	<desc>
13719	Set of objects to setup metric parameters for.
13720	</desc>
13721	</param>
13722	<param name="period" type="unsigned long" dir="in">
13723	<desc>
13724	Time interval in seconds between two consecutive samples of performance
13725	data.
13726	</desc>
13727	</param>
13728	<param name="count" type="unsigned long" dir="in">
13729	<desc>
13730	Number of samples to retain in performance data history. Older samples
13731	get discarded.
13732	</desc>
13733	</param>
13734	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13735	<desc>
13736	Array of metrics that have been modified by the call to this method.
13737	</desc>
13738	</param>
13739	</method>
13740
13741	<method name="enableMetrics">
13742	<desc>
13743	Turns on collecting specified base metrics. Returns an array of
13744	<link to="IPerformanceMetric" /> describing the metrics have been
13745	affected.
13746	<note>
13747	@c Null or empty metric name array means all metrics. @c Null or empty
13748	object array means all existing objects. If metric name array contains
13749	a single element and object array contains many, the single metric
13750	name array element is applied to each object array element to form
13751	metric/object pairs.
13752	</note>
13753	</desc>
13754	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13755	<desc>
13756	Metric name filter. Comma-separated list of metrics with wildcard
13757	support.
13758	</desc>
13759	</param>
13760	<param name="objects" type="$unknown" dir="in" safearray="yes">
13761	<desc>
13762	Set of objects to enable metrics for.
13763	</desc>
13764	</param>
13765	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13766	<desc>
13767	Array of metrics that have been modified by the call to this method.
13768	</desc>
13769	</param>
13770	</method>
13771
13772	<method name="disableMetrics">
13773	<desc>
13774	Turns off collecting specified base metrics. Returns an array of
13775	<link to="IPerformanceMetric" /> describing the metrics have been
13776	affected.
13777	<note>
13778	@c Null or empty metric name array means all metrics. @c Null or empty
13779	object array means all existing objects. If metric name array contains
13780	a single element and object array contains many, the single metric
13781	name array element is applied to each object array element to form
13782	metric/object pairs.
13783	</note>
13784	</desc>
13785	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13786	<desc>
13787	Metric name filter. Comma-separated list of metrics with wildcard
13788	support.
13789	</desc>
13790	</param>
13791	<param name="objects" type="$unknown" dir="in" safearray="yes">
13792	<desc>
13793	Set of objects to disable metrics for.
13794	</desc>
13795	</param>
13796	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13797	<desc>
13798	Array of metrics that have been modified by the call to this method.
13799	</desc>
13800	</param>
13801	</method>
13802
13803	<method name="queryMetricsData">
13804	<desc>
13805	Queries collected metrics data for a set of objects.
13806
13807	The data itself and related metric information are returned in seven
13808	parallel and one flattened array of arrays. Elements of
13809	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13810	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13811	the same index describe one set of values corresponding to a single
13812	metric.
13813
13814	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13815	start and length of a sub-array is indicated by
13816	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13817	value for metric <tt>metricNames[i]</tt> is at
13818	<tt>returnData[returnIndices[i]]</tt>.
13819
13820	<note>
13821	@c Null or empty metric name array means all metrics. @c Null or empty
13822	object array means all existing objects. If metric name array contains
13823	a single element and object array contains many, the single metric
13824	name array element is applied to each object array element to form
13825	metric/object pairs.
13826	</note>
13827	<note>
13828	Data collection continues behind the scenes after call to
13829	@c queryMetricsData. The return data can be seen as the snapshot of
13830	the current state at the time of @c queryMetricsData call. The
13831	internally kept metric values are not cleared by the call. This makes
13832	possible querying different subsets of metrics or aggregates with
13833	subsequent calls. If periodic querying is needed it is highly
13834	suggested to query the values with @c interval*count period to avoid
13835	confusion. This way a completely new set of data values will be
13836	provided by each query.
13837	</note>
13838	</desc>
13839	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13840	<desc>
13841	Metric name filter. Comma-separated list of metrics with wildcard
13842	support.
13843	</desc>
13844	</param>
13845	<param name="objects" type="$unknown" dir="in" safearray="yes">
13846	<desc>
13847	Set of objects to query metrics for.
13848	</desc>
13849	</param>
13850	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13851	<desc>
13852	Names of metrics returned in @c returnData.
13853	</desc>
13854	</param>
13855	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13856	<desc>
13857	Objects associated with metrics returned in @c returnData.
13858	</desc>
13859	</param>
13860	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13861	<desc>
13862	Units of measurement for each returned metric.
13863	</desc>
13864	</param>
13865	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13866	<desc>
13867	Divisor that should be applied to return values in order to get
13868	floating point values. For example:
13869	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13870	will retrieve the floating point value of i-th sample of the first
13871	metric.
13872	</desc>
13873	</param>
13874	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13875	<desc>
13876	Sequence numbers of the first elements of value sequences of particular metrics
13877	returned in @c returnData. For aggregate metrics it is the sequence number of
13878	the sample the aggregate started calculation from.
13879	</desc>
13880	</param>
13881	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13882	<desc>
13883	Indices of the first elements of value sequences of particular metrics
13884	returned in @c returnData.
13885	</desc>
13886	</param>
13887	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13888	<desc>
13889	Lengths of value sequences of particular metrics.
13890	</desc>
13891	</param>
13892	<param name="returnData" type="long" dir="return" safearray="yes">
13893	<desc>
13894	Flattened array of all metric data containing sequences of values for
13895	each metric.
13896	</desc>
13897	</param>
13898	</method>
13899
13900	</interface>
13901
13902	<module name="VBoxSVC" context="LocalServer">
13903	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13904	namespace="virtualbox.org">
13905	<interface name="IVirtualBox" default="yes"/>
13906	</class>
13907	</module>
13908
13909	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13910	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13911	namespace="virtualbox.org">
13912	<interface name="ISession" default="yes"/>
13913	</class>
13914	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13915	namespace="virtualbox.org">
13916	<interface name="ILocalOwner" default="yes"/>
13917	<interface name="IVirtualBoxCallback"/>
13918	<interface name="IConsoleCallback"/>
13919	</class>
13920	</module>
13921
13922	</library>
13923
13924	</idl>
13925
13926	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format