VirtualBox.xidl@ 25672

Last change on this file since 25672 was 25672, checked in by vboxsync, 15 years ago
introduced VBoxManage modifyvm --rtcuseutc
Property svn:eol-style set to `native`
File size: 505.7 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	-->
460	</const>
461	<const name="Future" value="13">
462	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
463	</const>
464	</enum>
465
466	<enum
467	name="AccessMode"
468	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
469	>
470	<desc>
471	Access mode for opening files.
472	</desc>
473
474	<const name="ReadOnly" value="1"/>
475	<const name="ReadWrite" value="2"/>
476	</enum>
477
478	<enum
479	name="MachineState"
480	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
481	>
482	<desc>
483	Virtual machine execution state.
484
485	This enumeration represents possible values of the <link
486	to="IMachine::state"/> attribute.
487
488	Below is the basic virtual machine state diagram. It shows how the state
489	changes during virtual machine execution. The text in square braces shows
490	a method of the IConsole interface that performs the given state
491	transition.
492
493	<pre>
494	+---------[powerDown()] <- Stuck <--[failure]-+
495	V \|
496	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
497	\| \| \| \| V \|
498	\| Aborted -----+ +--> Running --[pause()]--> Paused
499	\| \| ^ \| ^ \|
500	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
501	\| ^ \| \| \| \|
502	\| \| +-----------------------------------------+-\|-------------------+ +
503	\| \| \| \| \|
504	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
505	\| \| \| \|
506	\| +-------- Saving <--------[saveState()]<----------+---------------------+
507	\| \| \|
508	+-------------- Stopping -------[powerDown()]<----------+---------------------+
509	</pre>
510
511	Note that states to the right from PoweredOff, Aborted and Saved in the
512	above diagram are called <i>online VM states</i>. These states
513	represent the virtual machine which is being executed in a dedicated
514	process (usually with a GUI window attached to it where you can see the
515	activity of the virtual machine and interact with it). There are two
516	special pseudo-states, FirstOnline and LastOnline, that can be used in
517	relational expressions to detect if the given machine state is online or
518	not:
519
520	<pre>
521	if (machine.GetState() >= MachineState_FirstOnline &&
522	machine.GetState() <= MachineState_LastOnline)
523	{
524	...the machine is being executed...
525	}
526	</pre>
527
528	When the virtual machine is in one of the online VM states (that is, being
529	executed), only a few machine settings can be modified. Methods working
530	with such settings contain an explicit note about that. An attempt to
531	change any oter setting or perform a modifying operation during this time
532	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
533
534	All online states except Running, Paused and Stuck are transitional: they
535	represent temporary conditions of the virtual machine that will last as
536	long as the operation that initiated such a condition.
537
538	The Stuck state is a special case. It means that execution of the machine
539	has reached the "Guru Meditation" condition. This condition indicates an
540	internal VMM (virtual machine manager) failure which may happen as a
541	result of either an unhandled low-level virtual hardware exception or one
542	of the recompiler exceptions (such as the <i>too-many-traps</i>
543	condition).
544
545	Note also that any online VM state may transit to the Aborted state. This
546	happens if the process that is executing the virtual machine terminates
547	unexpectedly (for example, crashes). Other than that, the Aborted state is
548	equivalent to PoweredOff.
549
550	There are also a few additional state diagrams that do not deal with
551	virtual machine execution and therefore are shown separately. The states
552	shown on these diagrams are called <i>offline VM states</i> (this includes
553	PoweredOff, Aborted and Saved too).
554
555	The first diagram shows what happens when a lengthy setup operation is
556	being executed (such as <link to="IMachine::attachDevice"/>).
557
558	<pre>
559	+----------------------------------(same state as before the call)------+
560	\| \|
561	+-> PoweredOff --+ \|
562	\| \| \|
563	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
564	\| \|
565	+-> Saved -------+
566	</pre>
567
568	The next two diagrams demonstrate the process of taking a snapshot of a
569	powered off virtual machine and performing one of the "discard..."
570	operations, respectively.
571
572	<pre>
573	+----------------------------------(same state as before the call)------+
574	\| \|
575	+-> PoweredOff --+ \|
576	\| +-->[takeSnapshot()] -------------------> Saving ------+
577	+-> Aborted -----+
578
579	+-> PoweredOff --+
580	\| \|
581	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
582	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
583	+-> Saved -------+ \|
584	\| \|
585	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
586	</pre>
587
588	Note that the Saving state is present in both the offline state group and
589	online state group. Currently, the only way to determine what group is
590	assumed in a particular case is to remember the previous machine state: if
591	it was Running or Paused, then Saving is an online state, otherwise it is
592	an offline state. This inconsistency may be removed in one of the future
593	versions of VirtualBox by adding a new state.
594
595	<note internal="yes">
596	For whoever decides to touch this enum: In order to keep the
597	comparisons involving FirstOnline and LastOnline pseudo-states valid,
598	the numeric values of these states must be correspondingly updated if
599	needed: for any online VM state, the condition
600	<tt>FirstOnline <= state <= LastOnline</tt> must be
601	@c true. The same relates to transient states for which
602	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
603	@c true.
604	</note>
605	</desc>
606
607	<const name="Null" value="0">
608	<desc>Null value (never used by the API).</desc>
609	</const>
610	<const name="PoweredOff" value="1">
611	<desc>
612	The machine is not running and has no saved execution state; it has
613	either never been started or been shut down successfully.
614	</desc>
615	</const>
616	<const name="Saved" value="2">
617	<desc>
618	The machine is not currently running, but the execution state of the machine
619	has been saved to an external file when it was running, from where
620	it can be resumed.
621	</desc>
622	</const>
623	<const name="Teleported" value="3">
624	<desc>
625	The machine was teleported to a different host (or process) and then
626	powered off. Take care when powering it on again may corrupt resources
627	it shares with the teleportation target (e.g. disk and network).
628	</desc>
629	</const>
630	<const name="Aborted" value="4">
631	<desc>
632	The process running the machine has terminated abnormally. This may
633	indicate a crash of the VM process in host execution context, or
634	the VM process has been terminated externally.
635	</desc>
636	</const>
637	<const name="Running" value="5">
638	<desc>
639	The machine is currently being executed.
640	<note internal="yes">
641	For whoever decides to touch this enum: In order to keep the
642	comparisons in the old source code valid, this state must immediately
643	precede the Paused state.
644	TODO: Lift this spectacularly wonderful restriction.
645	</note>
646	</desc>
647	</const>
648	<const name="Paused" value="6">
649	<desc>
650	Execution of the machine has been paused.
651	<note internal="yes">
652	For whoever decides to touch this enum: In order to keep the
653	comparisons in the old source code valid, this state must immediately
654	follow the Running state.
655	TODO: Lift this spectacularly wonderful restriction.
656	</note>
657	</desc>
658	</const>
659	<const name="Stuck" value="7">
660	<desc>
661	Execution of the machine has reached the "Guru Meditation"
662	condition. This indicates a severe error in the hypervisor itself.
663	<note internal="yes">
664	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
665	"Guru", perhaps? Or are there some other VMM states that are
666	intended to be lumped in here as well?
667	</note>
668	</desc>
669	</const>
670	<const name="Teleporting" value="8">
671	<desc>
672	The machine is about to be teleported to a different host or process.
673	It is possible to pause a machine in this state, but it will go to the
674	<link to="MachineState::PausedTeleporting"/> state and it will not be
675	possible to resume it again unless the teleportation fails.
676	</desc>
677	</const>
678	<const name="LiveSnapshotting" value="9">
679	<desc>
680	A live snapshot is being taken. The machine is running normally, but
681	some of the runtime configuration options are inaccessible. Also, if
682	paused while in this state it will transition to
683	<link to="MachineState::Saving"/> and it will not be resume the
684	execution until the snapshot operation has completed.
685	</desc>
686	</const>
687	<const name="Starting" value="10">
688	<desc>
689	Machine is being started after powering it on from a
690	zero execution state.
691	</desc>
692	</const>
693	<const name="Stopping" value="11">
694	<desc>
695	Machine is being normally stopped powering it off, or after the guest OS
696	has initiated a shutdown sequence.
697	</desc>
698	</const>
699	<const name="Saving" value="12">
700	<desc>
701	Machine is saving its execution state to a file, or an online
702	snapshot of the machine is being taken.
703	</desc>
704	</const>
705	<const name="Restoring" value="13">
706	<desc>
707	Execution state of the machine is being restored from a file
708	after powering it on from the saved execution state.
709	</desc>
710	</const>
711	<const name="TeleportingPausedVM" value="14">
712	<desc>
713	The machine is being teleported to another host or process, but it is
714	not running. This is the paused variant of the
715	<link to="MachineState::Teleporting"/> state.
716	</desc>
717	</const>
718	<const name="TeleportingIn" value="15">
719	<desc>
720	Teleporting the machine state in from another host or process.
721	</desc>
722	</const>
723	<const name="RestoringSnapshot" value="16">
724	<desc>
725	A machine snapshot is being restored; this typically does not take long.
726	</desc>
727	</const>
728	<const name="DeletingSnapshot" value="17">
729	<desc>
730	A machine snapshot is being deleted; this can take a long time since this
731	may require merging differencing media.
732	</desc>
733	</const>
734	<const name="SettingUp" value="18">
735	<desc>
736	Lengthy setup operation is in progress.
737	</desc>
738	</const>
739
740	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
741	<desc>
742	Pseudo-state: first online state (for use in relational expressions).
743	</desc>
744	</const>
745	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
746	<desc>
747	Pseudo-state: last online state (for use in relational expressions).
748	</desc>
749	</const>
750
751	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
752	<desc>
753	Pseudo-state: first transient state (for use in relational expressions).
754	</desc>
755	</const>
756	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
757	<desc>
758	Pseudo-state: last transient state (for use in relational expressions).
759	</desc>
760	</const>
761
762	</enum>
763
764	<enum
765	name="SessionState"
766	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
767	>
768	<desc>
769	Session state. This enumeration represents possible values of
770	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
771	attributes. See individual enumerator descriptions for the meaning for
772	every value.
773	</desc>
774
775	<const name="Null" value="0">
776	<desc>Null value (never used by the API).</desc>
777	</const>
778	<const name="Closed" value="1">
779	<desc>
780	The machine has no open sessions (<link to="IMachine::sessionState"/>);
781	the session is closed (<link to="ISession::state"/>)
782	</desc>
783	</const>
784	<const name="Open" value="2">
785	<desc>
786	The machine has an open direct session (<link to="IMachine::sessionState"/>);
787	the session is open (<link to="ISession::state"/>)
788	</desc>
789	</const>
790	<const name="Spawning" value="3">
791	<desc>
792	A new (direct) session is being opened for the machine as a result of
793	<link to="IVirtualBox::openRemoteSession"/> call
794	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
795	This state also occurs as a short transient state when a new direct
796	session is opened by calling <link to="IVirtualBox::openSession"/>.
797	</desc>
798	</const>
799	<const name="Closing" value="4">
800	<desc>
801	The direct session is being closed (<link to="IMachine::sessionState"/>);
802	the session is being closed (<link to="ISession::state"/>)
803	</desc>
804	</const>
805	</enum>
806
807	<enum
808	name="CpuPropertyType"
809	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
810	>
811	<desc>
812	Virtual CPU property type. This enumeration represents possible values of the
813	IMachine get- and setCpuProperty methods.
814	</desc>
815	<const name="Null" value="0">
816	<desc>Null value (never used by the API).</desc>
817	</const>
818	<const name="PAE" value="1">
819	<desc>
820	This setting determines whether VirtualBox will expose the Physical Address
821	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
822	is not available, it will not be reported.
823	</desc>
824	</const>
825	<const name="Synthetic" value="2">
826	<desc>
827	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
828	teleporting between host systems that differ significantly.
829	</desc>
830	</const>
831	</enum>
832
833
834	<enum
835	name="HWVirtExPropertyType"
836	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
837	>
838	<desc>
839	Hardware virtualization property type. This enumeration represents possible values
840	for the <link to="IMachine::getHWVirtExProperty"/> and
841	<link to="IMachine::setHWVirtExProperty"/> methods.
842	</desc>
843	<const name="Null" value="0">
844	<desc>Null value (never used by the API).</desc>
845	</const>
846	<const name="Enabled" value="1">
847	<desc>
848	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
849	such extensions are not available, they will not be used.
850	</desc>
851	</const>
852	<const name="Exclusive" value="2">
853	<desc>
854	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
855	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
856	feature of the host. To share these with other hypervisors, you must disable this property.
857	</desc>
858	</const>
859	<const name="VPID" value="3">
860	<desc>
861	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
862	</desc>
863	</const>
864	<const name="NestedPaging" value="4">
865	<desc>
866	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
867	</desc>
868	</const>
869	</enum>
870
871	<enum
872	name="SessionType"
873	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
874	>
875	<desc>
876	Session type. This enumeration represents possible values of the
877	<link to="ISession::type"/> attribute.
878	</desc>
879
880	<const name="Null" value="0">
881	<desc>Null value (never used by the API).</desc>
882	</const>
883	<const name="Direct" value="1">
884	<desc>
885	Direct session
886	(opened by <link to="IVirtualBox::openSession"/>)
887	</desc>
888	</const>
889	<const name="Remote" value="2">
890	<desc>
891	Remote session
892	(opened by <link to="IVirtualBox::openRemoteSession"/>)
893	</desc>
894	</const>
895	<const name="Existing" value="3">
896	<desc>
897	Existing session
898	(opened by <link to="IVirtualBox::openExistingSession"/>)
899	</desc>
900	</const>
901	</enum>
902
903	<enum
904	name="DeviceType"
905	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
906	>
907	<desc>
908	Device type.
909	</desc>
910	<const name="Null" value="0">
911	<desc>
912	Null value, may also mean "no device" (not allowed for
913	<link to="IConsole::getDeviceActivity"/>).
914	</desc>
915	</const>
916	<const name="Floppy" value="1">
917	<desc>Floppy device.</desc>
918	</const>
919	<const name="DVD" value="2">
920	<desc>CD/DVD-ROM device.</desc>
921	</const>
922	<const name="HardDisk" value="3">
923	<desc>Hard disk device.</desc>
924	</const>
925	<const name="Network" value="4">
926	<desc>Network device.</desc>
927	</const>
928	<const name="USB" value="5">
929	<desc>USB device.</desc>
930	</const>
931	<const name="SharedFolder" value="6">
932	<desc>Shared folder device.</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="DeviceActivity"
938	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
939	>
940	<desc>
941	Device activity for <link to="IConsole::getDeviceActivity"/>.
942	</desc>
943
944	<const name="Null" value="0"/>
945	<const name="Idle" value="1"/>
946	<const name="Reading" value="2"/>
947	<const name="Writing" value="3"/>
948	</enum>
949
950	<enum
951	name="ClipboardMode"
952	uuid="33364716-4008-4701-8f14-be0fa3d62950"
953	>
954	<desc>
955	Host-Guest clipboard interchange mode.
956	</desc>
957
958	<const name="Disabled" value="0"/>
959	<const name="HostToGuest" value="1"/>
960	<const name="GuestToHost" value="2"/>
961	<const name="Bidirectional" value="3"/>
962	</enum>
963
964	<enum
965	name="Scope"
966	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
967	>
968	<desc>
969	Scope of the operation.
970
971	A generic enumeration used in various methods to define the action or
972	argument scope.
973	</desc>
974
975	<const name="Global" value="0"/>
976	<const name="Machine" value="1"/>
977	<const name="Session" value="2"/>
978	</enum>
979
980	<enum
981	name="GuestStatisticType"
982	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
983	>
984	<desc>
985	Statistics type for <link to="IGuest::getStatistic"/>.
986	</desc>
987
988	<const name="CPULoad_Idle" value="0">
989	<desc>
990	Idle CPU load (0-100%) for last interval.
991	</desc>
992	</const>
993	<const name="CPULoad_Kernel" value="1">
994	<desc>
995	Kernel CPU load (0-100%) for last interval.
996	</desc>
997	</const>
998	<const name="CPULoad_User" value="2">
999	<desc>
1000	User CPU load (0-100%) for last interval.
1001	</desc>
1002	</const>
1003	<const name="Threads" value="3">
1004	<desc>
1005	Total number of threads in the system.
1006	</desc>
1007	</const>
1008	<const name="Processes" value="4">
1009	<desc>
1010	Total number of processes in the system.
1011	</desc>
1012	</const>
1013	<const name="Handles" value="5">
1014	<desc>
1015	Total number of handles in the system.
1016	</desc>
1017	</const>
1018	<const name="MemoryLoad" value="6">
1019	<desc>
1020	Memory load (0-100%).
1021	</desc>
1022	</const>
1023	<const name="PhysMemTotal" value="7">
1024	<desc>
1025	Total physical memory in megabytes.
1026	</desc>
1027	</const>
1028	<const name="PhysMemAvailable" value="8">
1029	<desc>
1030	Free physical memory in megabytes.
1031	</desc>
1032	</const>
1033	<const name="PhysMemBalloon" value="9">
1034	<desc>
1035	Ballooned physical memory in megabytes.
1036	</desc>
1037	</const>
1038	<const name="MemCommitTotal" value="10">
1039	<desc>
1040	Total amount of memory in the committed state in megabytes.
1041	</desc>
1042	</const>
1043	<const name="MemKernelTotal" value="11">
1044	<desc>
1045	Total amount of memory used by the guest OS's kernel in megabytes.
1046	</desc>
1047	</const>
1048	<const name="MemKernelPaged" value="12">
1049	<desc>
1050	Total amount of paged memory used by the guest OS's kernel in megabytes.
1051	</desc>
1052	</const>
1053	<const name="MemKernelNonpaged" value="13">
1054	<desc>
1055	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1056	</desc>
1057	</const>
1058	<const name="MemSystemCache" value="14">
1059	<desc>
1060	Total amount of memory used by the guest OS's system cache in megabytes.
1061	</desc>
1062	</const>
1063	<const name="PageFileSize" value="15">
1064	<desc>
1065	Pagefile size in megabytes.
1066	</desc>
1067	</const>
1068	<const name="SampleNumber" value="16">
1069	<desc>
1070	Statistics sample number
1071	</desc>
1072	</const>
1073	<const name="MaxVal" value="17"/>
1074	</enum>
1075
1076	<enum
1077	name="BIOSBootMenuMode"
1078	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1079	>
1080	<desc>
1081	BIOS boot menu mode.
1082	</desc>
1083
1084	<const name="Disabled" value="0"/>
1085	<const name="MenuOnly" value="1"/>
1086	<const name="MessageAndMenu" value="2"/>
1087	</enum>
1088
1089	<enum
1090	name="ProcessorFeature"
1091	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1092	>
1093	<desc>
1094	CPU features.
1095	</desc>
1096
1097	<const name="HWVirtEx" value="0"/>
1098	<const name="PAE" value="1"/>
1099	<const name="LongMode" value="2"/>
1100	<const name="NestedPaging" value="3"/>
1101	</enum>
1102
1103	<enum
1104	name="FirmwareType"
1105	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1106	>
1107	<desc>
1108	Firmware type.
1109	</desc>
1110	<const name="BIOS" value="1">
1111	<desc>BIOS Firmware.</desc>
1112	</const>
1113	<const name="EFI" value="2">
1114	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1115	</const>
1116	<const name="EFI32" value="3">
1117	<desc>Efi firmware, 32-bit.</desc>
1118	</const>
1119	<const name="EFI64" value="4">
1120	<desc>Efi firmware, 64-bit.</desc>
1121	</const>
1122	<const name="EFIDUAL" value="5">
1123	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1124	</const>
1125	</enum>
1126
1127	<!--
1128	// IVirtualBoxErrorInfo
1129	/////////////////////////////////////////////////////////////////////////
1130	-->
1131
1132	<interface
1133	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1134	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1135	supportsErrorInfo="no"
1136	wsmap="managed"
1137	>
1138	<desc>
1139	The IVirtualBoxErrorInfo interface represents extended error information.
1140
1141	Extended error information can be set by VirtualBox components after
1142	unsuccessful or partially successful method invocation. This information
1143	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1144	and then shown to the client in addition to the plain 32-bit result code.
1145
1146	In MS COM, this interface extends the IErrorInfo interface,
1147	in XPCOM, it extends the nsIException interface. In both cases,
1148	it provides a set of common attributes to retrieve error
1149	information.
1150
1151	Sometimes invocation of some component's method may involve methods of
1152	other components that may also fail (independently of this method's
1153	failure), or a series of non-fatal errors may precede a fatal error that
1154	causes method failure. In cases like that, it may be desirable to preserve
1155	information about all errors happened during method invocation and deliver
1156	it to the caller. The <link to="#next"/> attribute is intended
1157	specifically for this purpose and allows to represent a chain of errors
1158	through a single IVirtualBoxErrorInfo object set after method invocation.
1159
1160	Note that errors are stored to a chain in the reverse order, i.e. the
1161	initial error object you query right after method invocation is the last
1162	error set by the callee, the object it points to in the @a next attribute
1163	is the previous error and so on, up to the first error (which is the last
1164	in the chain).
1165	</desc>
1166
1167	<attribute name="resultCode" type="long" readonly="yes">
1168	<desc>
1169	Result code of the error.
1170	Usually, it will be the same as the result code returned
1171	by the method that provided this error information, but not
1172	always. For example, on Win32, CoCreateInstance() will most
1173	likely return E_NOINTERFACE upon unsuccessful component
1174	instantiation attempt, but not the value the component factory
1175	returned. Value is typed 'long', not 'result',
1176	to make interface usable from scripting languages.
1177	<note>
1178	In MS COM, there is no equivalent.
1179	In XPCOM, it is the same as nsIException::result.
1180	</note>
1181	</desc>
1182	</attribute>
1183
1184	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1185	<desc>
1186	UUID of the interface that defined the error.
1187	<note>
1188	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1189	data type.
1190	In XPCOM, there is no equivalent.
1191	</note>
1192	</desc>
1193	</attribute>
1194
1195	<attribute name="component" type="wstring" readonly="yes">
1196	<desc>
1197	Name of the component that generated the error.
1198	<note>
1199	In MS COM, it is the same as IErrorInfo::GetSource.
1200	In XPCOM, there is no equivalent.
1201	</note>
1202	</desc>
1203	</attribute>
1204
1205	<attribute name="text" type="wstring" readonly="yes">
1206	<desc>
1207	Text description of the error.
1208	<note>
1209	In MS COM, it is the same as IErrorInfo::GetDescription.
1210	In XPCOM, it is the same as nsIException::message.
1211	</note>
1212	</desc>
1213	</attribute>
1214
1215	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1216	<desc>
1217	Next error object if there is any, or @c null otherwise.
1218	<note>
1219	In MS COM, there is no equivalent.
1220	In XPCOM, it is the same as nsIException::inner.
1221	</note>
1222	</desc>
1223	</attribute>
1224
1225	</interface>
1226
1227	<interface
1228	name="ILocalOwner" extends="$dispatched"
1229	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1230	>
1231	<desc>
1232	The ILocalOwner interface allows to register local objects
1233	(created without COM calls, but with new()).
1234	Once registered, calls to methods of such objects can be made
1235	from remote COM processes.
1236	The main usecase is the event callback implementation where
1237	API clients provide callback objects.
1238	</desc>
1239	<method name="setLocalObject">
1240	<desc>
1241	Set local object.
1242	</desc>
1243	<param name="object" type="$unknown" dir="in">
1244	<desc>Local object to forward requests to.
1245	If null, clears currently set local object.</desc>
1246	</param>
1247	</method>
1248	</interface>
1249
1250	<!--
1251	// IVirtualBox
1252	/////////////////////////////////////////////////////////////////////////
1253	-->
1254
1255	<interface
1256	name="IVirtualBoxCallback" extends="$unknown"
1257	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1258	wsmap="suppress"
1259	>
1260
1261	<method name="onMachineStateChange">
1262	<desc>
1263	The execution state of the given machine has changed.
1264	<see>IMachine::state</see>
1265	</desc>
1266	<param name="machineId" type="uuid" mod="string" dir="in">
1267	<desc>ID of the machine this event relates to.</desc>
1268	</param>
1269	<param name="state" type="MachineState" dir="in">
1270	<desc>New execution state.</desc>
1271	</param>
1272	</method>
1273
1274	<method name="onMachineDataChange">
1275	<desc>
1276	Any of the settings of the given machine has changed.
1277	</desc>
1278	<param name="machineId" type="uuid" mod="string" dir="in">
1279	<desc>ID of the machine this event relates to.</desc>
1280	</param>
1281	</method>
1282
1283	<method name="onExtraDataCanChange">
1284	<desc>
1285	Notification when someone tries to change extra data for
1286	either the given machine or (if @c null) global extra data.
1287	This gives the chance to veto against changes.
1288	</desc>
1289	<param name="machineId" type="uuid" mod="string" dir="in">
1290	<desc>
1291	ID of the machine this event relates to
1292	(@c null ID for global extra data change requests).
1293	</desc>
1294	</param>
1295	<param name="key" type="wstring" dir="in">
1296	<desc>
1297	Extra data key for the attempted write.
1298	</desc>
1299	</param>
1300	<param name="value" type="wstring" dir="in">
1301	<desc>
1302	Extra data value for the given key.
1303	</desc>
1304	</param>
1305	<param name="error" type="wstring" dir="out">
1306	<desc>
1307	Optional error message describing the reason of the
1308	veto (ignored if this notification returns @c true).
1309	</desc>
1310	</param>
1311	<param name="allowChange" type="boolean" dir="return">
1312	<desc>
1313	Flag to indicate whether the callee agrees (@c true)
1314	or vetoes against the change (@c false).
1315	</desc>
1316	</param>
1317	</method>
1318
1319	<method name="onExtraDataChange">
1320	<desc>
1321	Notification when machine specific or global extra data
1322	has changed.
1323	</desc>
1324	<param name="machineId" type="uuid" mod="string" dir="in">
1325	<desc>
1326	ID of the machine this event relates to.
1327	Null for global extra data changes.
1328	</desc>
1329	</param>
1330	<param name="key" type="wstring" dir="in">
1331	<desc>
1332	Extra data key that has changed.
1333	</desc>
1334	</param>
1335	<param name="value" type="wstring" dir="in">
1336	<desc>
1337	Extra data value for the given key.
1338	</desc>
1339	</param>
1340	</method>
1341
1342	<method name="onMediumRegistered">
1343	<desc>
1344	The given medium was registered or unregistered
1345	within this VirtualBox installation.
1346
1347	The @a mediumType parameter describes what type of
1348	medium the specified @a mediumId refers to. Possible
1349	values are:
1350
1351	<ul>
1352	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1353	that, if registered, can be obtained using the
1354	<link to="IVirtualBox::getHardDisk"/> call.</li>
1355	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1356	that, if registered, can be obtained using the
1357	<link to="IVirtualBox::getDVDImage"/> call.</li>
1358	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1359	that, if registered, can be obtained using the
1360	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1361	</ul>
1362
1363	Note that if this is a deregistration notification,
1364	there is no way to access the object representing the
1365	unregistered medium. It is supposed that the
1366	application will do required cleanup based on the
1367	@a mediumId value.
1368	</desc>
1369	<param name="mediumId" type="uuid" mod="string" dir="in">
1370	<desc>ID of the medium this event relates to.</desc>
1371	</param>
1372	<param name="mediumType" type="DeviceType" dir="in">
1373	<desc>Type of the medium this event relates to.</desc>
1374	</param>
1375	<param name="registered" type="boolean" dir="in">
1376	<desc>
1377	If @c true, the medium was registered, otherwise it was
1378	unregistered.
1379	</desc>
1380	</param>
1381	</method>
1382
1383	<method name="onMachineRegistered">
1384	<desc>
1385	The given machine was registered or unregistered
1386	within this VirtualBox installation.
1387	</desc>
1388	<param name="machineId" type="uuid" mod="string" dir="in">
1389	<desc>ID of the machine this event relates to.</desc>
1390	</param>
1391	<param name="registered" type="boolean" dir="in">
1392	<desc>
1393	If @c true, the machine was registered, otherwise it was
1394	unregistered.
1395	</desc>
1396	</param>
1397	</method>
1398
1399	<method name="onSessionStateChange">
1400	<desc>
1401	The state of the session for the given machine was changed.
1402	<see>IMachine::sessionState</see>
1403	</desc>
1404	<param name="machineId" type="uuid" mod="string" dir="in">
1405	<desc>ID of the machine this event relates to.</desc>
1406	</param>
1407	<param name="state" type="SessionState" dir="in">
1408	<desc>New session state.</desc>
1409	</param>
1410	</method>
1411
1412	<method name="onSnapshotTaken">
1413	<desc>
1414	A new snapshot of the machine has been taken.
1415	<see>ISnapshot</see>
1416	</desc>
1417	<param name="machineId" type="uuid" mod="string" dir="in">
1418	<desc>ID of the machine this event relates to.</desc>
1419	</param>
1420	<param name="snapshotId" type="uuid" mod="string" dir="in">
1421	<desc>ID of the new snapshot.</desc>
1422	</param>
1423	</method>
1424
1425	<method name="onSnapshotDiscarded">
1426	<desc>
1427	Snapshot of the given machine has been discarded.
1428
1429	<note>
1430	This notification is delivered <b>after</b> the snapshot
1431	object has been uninitialized on the server (so that any
1432	attempt to call its methods will return an error).
1433	</note>
1434
1435	<see>ISnapshot</see>
1436	</desc>
1437	<param name="machineId" type="uuid" mod="string" dir="in">
1438	<desc>ID of the machine this event relates to.</desc>
1439	</param>
1440	<param name="snapshotId" type="uuid" mod="string" dir="in">
1441	<desc>
1442	ID of the discarded snapshot. @c null means the current machine
1443	state has been discarded (restored from the current snapshot).
1444	</desc>
1445	</param>
1446	</method>
1447
1448	<method name="onSnapshotChange">
1449	<desc>
1450	Snapshot properties (name and/or description) have been changed.
1451	<see>ISnapshot</see>
1452	</desc>
1453	<param name="machineId" type="uuid" mod="string" dir="in">
1454	<desc>ID of the machine this event relates to.</desc>
1455	</param>
1456	<param name="snapshotId" type="uuid" mod="string" dir="in">
1457	<desc>ID of the changed snapshot.</desc>
1458	</param>
1459	</method>
1460
1461	<method name="onGuestPropertyChange">
1462	<desc>
1463	Notification when a guest property has changed.
1464	</desc>
1465	<param name="machineId" type="uuid" mod="string" dir="in">
1466	<desc>
1467	ID of the machine this event relates to.
1468	</desc>
1469	</param>
1470	<param name="name" type="wstring" dir="in">
1471	<desc>
1472	The name of the property that has changed.
1473	</desc>
1474	</param>
1475	<param name="value" type="wstring" dir="in">
1476	<desc>
1477	The new property value.
1478	</desc>
1479	</param>
1480	<param name="flags" type="wstring" dir="in">
1481	<desc>
1482	The new property flags.
1483	</desc>
1484	</param>
1485	</method>
1486
1487	</interface>
1488
1489	<interface
1490	name="IDHCPServer" extends="$unknown"
1491	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1492	wsmap="managed"
1493	>
1494	<desc>
1495	The IDHCPServer interface represents the vbox dhcp server configuration.
1496
1497	To enumerate all the dhcp servers on the host, use the
1498	<link to="IVirtualBox::DHCPServers"/> attribute.
1499	</desc>
1500
1501	<attribute name="enabled" type="boolean">
1502	<desc>
1503	specifies if the dhcp server is enabled
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="IPAddress" type="wstring" readonly="yes">
1508	<desc>
1509	specifies server IP
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="networkMask" type="wstring" readonly="yes">
1514	<desc>
1515	specifies server network mask
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="networkName" type="wstring" readonly="yes">
1520	<desc>
1521	specifies internal network name the server is used for
1522	</desc>
1523	</attribute>
1524
1525	<attribute name="lowerIP" type="wstring" readonly="yes">
1526	<desc>
1527	specifies from IP adrres in server address range
1528	</desc>
1529	</attribute>
1530
1531	<attribute name="upperIP" type="wstring" readonly="yes">
1532	<desc>
1533	specifies to IP adrres in server address range
1534	</desc>
1535	</attribute>
1536
1537	<method name="setConfiguration">
1538	<desc>
1539	configures the server
1540	<result name="E_INVALIDARG">
1541	invalid configuration supplied
1542	</result>
1543	</desc>
1544	<param name="IPAddress" type="wstring" dir="in">
1545	<desc>
1546	server IP address
1547	</desc>
1548	</param>
1549	<param name="networkMask" type="wstring" dir="in">
1550	<desc>
1551	server network mask
1552	</desc>
1553	</param>
1554	<param name="FromIPAddress" type="wstring" dir="in">
1555	<desc>
1556	server From IP address for address range
1557	</desc>
1558	</param>
1559	<param name="ToIPAddress" type="wstring" dir="in">
1560	<desc>
1561	server To IP address for address range
1562	</desc>
1563	</param>
1564	</method>
1565
1566	<method name="start">
1567	<desc>
1568	Starts DHCP server process.
1569	<result name="E_FAIL">
1570	Failed to start the process.
1571	</result>
1572	</desc>
1573	<param name="networkName" type="wstring" dir="in">
1574	<desc>
1575	Name of internal network DHCP server should attach to.
1576	</desc>
1577	</param>
1578	<param name="trunkName" type="wstring" dir="in">
1579	<desc>
1580	Name of internal network trunk.
1581	</desc>
1582	</param>
1583	<param name="trunkType" type="wstring" dir="in">
1584	<desc>
1585	Type of internal network trunk.
1586	</desc>
1587	</param>
1588	</method>
1589
1590	<method name="stop">
1591	<desc>
1592	Stops DHCP server process.
1593	<result name="E_FAIL">
1594	Failed to stop the process.
1595	</result>
1596	</desc>
1597	</method>
1598	</interface>
1599
1600	<interface
1601	name="IVirtualBox" extends="$dispatched"
1602	uuid="2158464a-f706-414b-a8c4-fb589dfc6b62"
1603	wsmap="managed"
1604	>
1605	<desc>
1606	The IVirtualBox interface represents the main interface exposed by the
1607	product that provides virtual machine management.
1608
1609	An instance of IVirtualBox is required for the product to do anything
1610	useful. Even though the interface does not expose this, internally,
1611	IVirtualBox is implemented as a singleton and actually lives in the
1612	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1613	IVirtualBox can track the state of all virtual machines on a particular
1614	host, regardless of which frontend started them.
1615
1616	To enumerate all the virtual machines on the host, use the
1617	<link to="IVirtualBox::machines"/> attribute.
1618	</desc>
1619
1620	<attribute name="version" type="wstring" readonly="yes">
1621	<desc>
1622	A string representing the version number of the product. The
1623	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1624	last number represents the build number and will frequently change.
1625	</desc>
1626	</attribute>
1627
1628	<attribute name="revision" type="unsigned long" readonly="yes">
1629	<desc>
1630	The internal build revision number of the product.
1631	</desc>
1632	</attribute>
1633
1634	<attribute name="packageType" type="wstring" readonly="yes">
1635	<desc>
1636	A string representing the package type of this product. The
1637	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1638	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1639	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1640	this.
1641	</desc>
1642	</attribute>
1643
1644	<attribute name="homeFolder" type="wstring" readonly="yes">
1645	<desc>
1646	Full path to the directory where the global settings file,
1647	<tt>VirtualBox.xml</tt>, is stored.
1648
1649	In this version of VirtualBox, the value of this property is
1650	always <tt><user_dir>/.VirtualBox</tt> (where
1651	<tt><user_dir></tt> is the path to the user directory,
1652	as determined by the host OS), and cannot be changed.
1653
1654	This path is also used as the base to resolve relative paths in
1655	places where relative paths are allowed (unless otherwise
1656	expressly indicated).
1657	</desc>
1658	</attribute>
1659
1660	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1661	<desc>
1662	Full name of the global settings file.
1663	The value of this property corresponds to the value of
1664	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1665	</desc>
1666	</attribute>
1667
1668	<attribute name="host" type="IHost" readonly="yes">
1669	<desc>Associated host object.</desc>
1670	</attribute>
1671
1672	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1673	<desc>Associated system information object.</desc>
1674	</attribute>
1675
1676	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1677	<desc>
1678	Array of machine objects registered within this VirtualBox instance.
1679	</desc>
1680	</attribute>
1681
1682	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1683	<desc>
1684	Array of medium objects known to this VirtualBox installation.
1685
1686	This array contains only base media. All differencing
1687	media of the given base medium can be enumerated using
1688	<link to="IMedium::children"/>.
1689	</desc>
1690	</attribute>
1691
1692	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1693	<desc>
1694	Array of CD/DVD image objects registered with this VirtualBox instance.
1695	</desc>
1696	</attribute>
1697
1698	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1699	<desc>
1700	Array of floppy image objects registered with this VirtualBox instance.
1701	</desc>
1702	</attribute>
1703
1704	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1705
1706	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1707
1708	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1709	<desc>
1710	Collection of global shared folders. Global shared folders are
1711	available to all virtual machines.
1712
1713	New shared folders are added to the collection using
1714	<link to="#createSharedFolder"/>. Existing shared folders can be
1715	removed using <link to="#removeSharedFolder"/>.
1716
1717	<note>
1718	In the current version of the product, global shared folders are not
1719	implemented and therefore this collection is always empty.
1720	</note>
1721	</desc>
1722	</attribute>
1723
1724	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1725	<desc>
1726	Associated performance collector object.
1727	</desc>
1728	</attribute>
1729
1730	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1731	<desc>
1732	dhcp server settings.
1733	</desc>
1734	</attribute>
1735
1736	<method name="createMachine">
1737	<desc>
1738	Creates a new virtual machine.
1739
1740	The new machine is created unregistered, with the initial configuration
1741	set according to the specified guest OS type. A typical sequence of
1742	actions to create a new virtual machine is as follows:
1743
1744	<ol>
1745	<li>
1746	Call this method to have a new machine created. The returned machine
1747	object will be "mutable" allowing to change any machine property.
1748	</li>
1749
1750	<li>
1751	Configure the machine using the appropriate attributes and methods.
1752	</li>
1753
1754	<li>
1755	Call <link to="IMachine::saveSettings" /> to write the settings
1756	to the machine's XML settings file. The configuration of the newly
1757	created machine will not be saved to disk until this method is
1758	called.
1759	</li>
1760
1761	<li>
1762	Call <link to="#registerMachine" /> to add the machine to the list
1763	of machines known to VirtualBox.
1764	</li>
1765	</ol>
1766
1767	You should specify valid name for the newly created machine when calling
1768	this method. See the <link to="IMachine::name"/> attribute description
1769	for more details about the machine name.
1770
1771	The specified guest OS type identifier must match an ID of one of known
1772	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1773	array.
1774
1775	Every machine has a <i>settings file</i> that is used to store
1776	the machine configuration. This file is stored in a directory called the
1777	<i>machine settings subfolder</i>. Both the settings subfolder and file
1778	will have a name that corresponds to the name of the virtual machine.
1779	You can specify where to create the machine setting subfolder using the
1780	@a baseFolder argument. The base folder can be absolute (full path) or
1781	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1782	directory</link>.
1783
1784	If @a baseFolder is a @c null or empty string (which is recommended), the
1785	<link to="ISystemProperties::defaultMachineFolder">default machine
1786	settings folder</link> will be used as a base folder for the created
1787	machine. Otherwise the given base folder will be used. In either case,
1788	the full path to the resulting settings file has the following
1789	structure:
1790	<pre>
1791	<base_folder>/<machine_name>/<machine_name>.xml
1792	</pre>
1793
1794	Note that if the resulting settings file already exists, this method
1795	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1796
1797	Optionally, you may specify an UUID of to assign to the created machine.
1798	However, this is not recommended and you should normally pass an empty
1799	(@c null) UUID to this method so that a new UUID will be automatically
1800	generated for every created machine. You can use UUID
1801	00000000-0000-0000-0000-000000000000 as @c null value.
1802
1803	<note>
1804	There is no way to change the name of the settings file or
1805	subfolder of the created machine directly.
1806	</note>
1807
1808	<result name="VBOX_E_OBJECT_NOT_FOUND">
1809	@a osTypeId is invalid.
1810	</result>
1811	<result name="VBOX_E_FILE_ERROR">
1812	Resulting settings file name is invalid or the settings file already
1813	exists or could not be created due to an I/O error.
1814	</result>
1815	<result name="E_INVALIDARG">
1816	@a name is empty or @c null.
1817	</result>
1818	</desc>
1819
1820	<param name="name" type="wstring" dir="in">
1821	<desc>Machine name.</desc>
1822	</param>
1823	<param name="osTypeId" type="wstring" dir="in">
1824	<desc>Guest OS Type ID.</desc>
1825	</param>
1826	<param name="baseFolder" type="wstring" dir="in">
1827	<desc>Base machine folder (optional).</desc>
1828	</param>
1829	<param name="id" type="uuid" mod="string" dir="in">
1830	<desc>Machine UUID (optional).</desc>
1831	</param>
1832	<param name="machine" type="IMachine" dir="return">
1833	<desc>Created machine object.</desc>
1834	</param>
1835	</method>
1836
1837	<method name="createLegacyMachine">
1838	<desc>
1839	Creates a new virtual machine in "legacy" mode, using the specified
1840	settings file to store machine settings.
1841
1842	As opposed to machines created by <link to="#createMachine"/>,
1843	the settings file of the machine created in "legacy" mode is not
1844	automatically renamed when the machine name is changed -- it will always
1845	remain the same as specified in this method call.
1846
1847	The specified settings file name can be absolute (full path) or relative
1848	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1849	directory</link>. If the file name doesn't contain an extension, the
1850	default extension (.xml) will be appended.
1851
1852	Note that the configuration of the newly created machine is not
1853	saved to disk (and therefore no settings file is created)
1854	until <link to="IMachine::saveSettings"/> is called. If the
1855	specified settings file already exists, this method
1856	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1857
1858	See <link to="#createMachine"/> for more information.
1859
1860	@deprecated This method may be removed later. Use <link
1861	to="IVirtualBox::createMachine"/> instead.
1862
1863	<note>
1864	There is no way to change the name of the settings file
1865	of the machine created in "legacy" mode.
1866	</note>
1867
1868	<result name="VBOX_E_OBJECT_NOT_FOUND">
1869	@a osTypeId is invalid.
1870	</result>
1871	<result name="VBOX_E_FILE_ERROR">
1872	@a settingsFile is invalid or the settings file already exists or
1873	could not be created due to an I/O error.
1874	</result>
1875	<result name="E_INVALIDARG">
1876	@a name or @a settingsFile is empty or @c null.
1877	</result>
1878	</desc>
1879
1880	<param name="name" type="wstring" dir="in">
1881	<desc>Machine name.</desc>
1882	</param>
1883	<param name="osTypeId" type="wstring" dir="in">
1884	<desc>Machine OS Type ID.</desc>
1885	</param>
1886	<param name="settingsFile" type="wstring" dir="in">
1887	<desc>Name of the machine settings file.</desc>
1888	</param>
1889	<param name="id" type="uuid" mod="string" dir="in">
1890	<desc>Machine UUID (optional).</desc>
1891	</param>
1892	<param name="machine" type="IMachine" dir="return">
1893	<desc>Created machine object.</desc>
1894	</param>
1895	</method>
1896
1897	<method name="openMachine">
1898	<desc>
1899	Opens a virtual machine from the existing settings file.
1900	The opened machine remains unregistered until you call
1901	<link to="#registerMachine"/>.
1902
1903	The specified settings file name can be absolute
1904	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1905	VirtualBox home directory</link>. This file must exist
1906	and must be a valid machine settings file whose contents
1907	will be used to construct the machine object.
1908
1909	@deprecated Will be removed soon.
1910	<result name="VBOX_E_FILE_ERROR">
1911	Settings file name invalid, not found or sharing violation.
1912	</result>
1913	</desc>
1914	<param name="settingsFile" type="wstring" dir="in">
1915	<desc>
1916	Name of the machine settings file.
1917	</desc>
1918	</param>
1919	<param name="machine" type="IMachine" dir="return">
1920	<desc>Opened machine object.</desc>
1921	</param>
1922	<note>
1923	<link to="IMachine::settingsModified"/> will return
1924	@c false for the created machine, until any of machine settings
1925	are changed.
1926	</note>
1927	</method>
1928
1929	<method name="registerMachine">
1930	<desc>
1931
1932	Registers the machine previously created using
1933	<link to="#createMachine"/> or opened using
1934	<link to="#openMachine"/> within this VirtualBox installation. After
1935	successful method invocation, the
1936	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1937	to all registered callbacks.
1938
1939	<note>
1940	This method implicitly calls <link to="IMachine::saveSettings"/>
1941	to save all current machine settings before registering it.
1942	</note>
1943
1944	<result name="VBOX_E_OBJECT_NOT_FOUND">
1945	No matching virtual machine found.
1946	</result>
1947	<result name="VBOX_E_INVALID_OBJECT_STATE">
1948	Virtual machine was not created within this VirtualBox instance.
1949	</result>
1950
1951	</desc>
1952	<param name="machine" type="IMachine" dir="in"/>
1953	</method>
1954
1955	<method name="getMachine">
1956	<desc>
1957	Attempts to find a virtual machine given its UUID.
1958	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1959	instead.
1960
1961	<result name="VBOX_E_OBJECT_NOT_FOUND">
1962	Could not find registered machine matching @a id.
1963	</result>
1964
1965	</desc>
1966	<param name="id" type="uuid" mod="string" dir="in"/>
1967	<param name="machine" type="IMachine" dir="return"/>
1968	</method>
1969
1970	<method name="findMachine">
1971	<desc>
1972	Attempts to find a virtual machine given its name.
1973	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1974	instead.
1975
1976	<result name="VBOX_E_OBJECT_NOT_FOUND">
1977	Could not find registered machine matching @a name.
1978	</result>
1979
1980	</desc>
1981	<param name="name" type="wstring" dir="in"/>
1982	<param name="machine" type="IMachine" dir="return"/>
1983	</method>
1984
1985	<method name="unregisterMachine">
1986	<desc>
1987
1988	Unregisters the machine previously registered using
1989	<link to="#registerMachine"/>. After successful method invocation, the
1990	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1991	to all registered callbacks.
1992
1993	<note>
1994	The specified machine must not be in the Saved state, have an open
1995	(or a spawning) direct session associated with it, have snapshots or
1996	have any medium attached.
1997	</note>
1998
1999	<note>
2000	This method implicitly calls <link to="IMachine::saveSettings"/> to
2001	save all current machine settings before unregistering it.
2002	</note>
2003
2004	<note>
2005	If the given machine is inaccessible (see
2006	<link to="IMachine::accessible"/>), it will be unregistered and
2007	fully uninitialized right afterwards. As a result, the returned
2008	machine object will be unusable and an attempt to call
2009	<b>any</b> method will return the "Object not ready" error.
2010	</note>
2011
2012	<result name="VBOX_E_OBJECT_NOT_FOUND">
2013	Could not find registered machine matching @a id.
2014	</result>
2015	<result name="VBOX_E_INVALID_VM_STATE">
2016	Machine is in Saved state.
2017	</result>
2018	<result name="VBOX_E_INVALID_OBJECT_STATE">
2019	Machine has snapshot or open session or medium attached.
2020	</result>
2021
2022	</desc>
2023	<param name="id" type="uuid" mod="string" dir="in">
2024	<desc>UUID of the machine to unregister.</desc>
2025	</param>
2026	<param name="machine" type="IMachine" dir="return">
2027	<desc>Unregistered machine object.</desc>
2028	</param>
2029	</method>
2030
2031	<method name="createAppliance">
2032	<desc>
2033	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2034	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2035	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2036	</desc>
2037	<param name="appliance" type="IAppliance" dir="return">
2038	<desc>New appliance.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="createHardDisk">
2043	<desc>
2044	Creates a new base medium object that will use the given storage
2045	format and location for medium data.
2046
2047	Note that the actual storage unit is not created by this method. In
2048	order to do it, and before you are able to attach the created medium
2049	to virtual machines, you must call one of the following methods to
2050	allocate a format-specific storage unit at the specified location:
2051	<ul>
2052	<li><link to="IMedium::createBaseStorage"/></li>
2053	<li><link to="IMedium::createDiffStorage"/></li>
2054	</ul>
2055
2056	Some medium attributes, such as <link to="IMedium::id"/>, may
2057	remain uninitialized until the medium storage unit is successfully
2058	created by one of the above methods.
2059
2060	After the storage unit is successfully created, the medium gets
2061	remembered by this VirtualBox installation and will be accessible
2062	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2063	methods. Remembered base medium are also returned as part of
2064	the <link to="#hardDisks"/> array. See IMedium for more details.
2065
2066	The list of all storage formats supported by this VirtualBox
2067	installation can be obtained using
2068	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2069	attribute is empty or @c null then the default storage format
2070	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2071	be used for creating a storage unit of the medium.
2072
2073	Note that the format of the location string is storage format specific.
2074	See <link to="IMedium::location"/>, IMedium and
2075	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2076
2077	<result name="VBOX_E_OBJECT_NOT_FOUND">
2078	@a format identifier is invalid. See
2079	<link to="ISystemProperties::mediumFormats"/>.
2080	</result>
2081	<result name="VBOX_E_FILE_ERROR">
2082	@a location is a not valid file name (for file-based formats only).
2083	</result>
2084	</desc>
2085	<param name="format" type="wstring" dir="in">
2086	<desc>
2087	Identifier of the storage format to use for the new medium.
2088	</desc>
2089	</param>
2090	<param name="location" type="wstring" dir="in">
2091	<desc>
2092	Location of the storage unit for the new medium.
2093	</desc>
2094	</param>
2095	<param name="medium" type="IMedium" dir="return">
2096	<desc>Created medium object.</desc>
2097	</param>
2098	</method>
2099
2100	<method name="openHardDisk">
2101	<desc>
2102	Opens a medium from an existing location, optionally replacing
2103	the image UUID and/or parent UUID.
2104
2105	After the medium is successfully opened by this method, it gets
2106	remembered by (known to) this VirtualBox installation and will be
2107	accessible through <link to="#getHardDisk"/> and
2108	<link to="#findHardDisk"/> methods. Remembered base media
2109	are also returned as part of the <link to="#hardDisks"/> array and can
2110	be attached to virtual machines. See IMedium for more details.
2111
2112	If a differencing medium is to be opened by this method, the
2113	operation will succeed only if its parent medium and all ancestors,
2114	if any, are already known to this VirtualBox installation (for example,
2115	were opened by this method before).
2116
2117	This method tries to guess the storage format of the specified medium
2118	by reading medium data at the specified location.
2119
2120	If @a write is ReadWrite (which it should be), the image is opened for
2121	read/write access and must have according permissions, as VirtualBox
2122	may actually write status information into the disk's metadata sections.
2123
2124	Note that write access is required for all typical image usage in VirtualBox,
2125	since VirtualBox may need to write metadata such as a UUID into the image.
2126	The only exception is opening a source image temporarily for copying and
2127	cloning when the image will quickly be closed again.
2128
2129	Note that the format of the location string is storage format specific.
2130	See <link to="IMedium::location"/>, IMedium and
2131	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2132
2133	<result name="VBOX_E_FILE_ERROR">
2134	Invalid medium storage file location or could not find the medium
2135	at the specified location.
2136	</result>
2137	<result name="VBOX_E_IPRT_ERROR">
2138	Could not get medium storage format.
2139	</result>
2140	<result name="E_INVALIDARG">
2141	Invalid medium storage format.
2142	</result>
2143
2144	</desc>
2145	<param name="location" type="wstring" dir="in">
2146	<desc>
2147	Location of the storage unit that contains medium data in one of
2148	the supported storage formats.
2149	</desc>
2150	</param>
2151	<param name="accessMode" type="AccessMode" dir="in">
2152	<desc>
2153	Determines whether to open the image in read/write or read-only mode.
2154	</desc>
2155	</param>
2156	<param name="setImageId" type="boolean" dir="in">
2157	<desc>
2158	Select whether a new image UUID is set or not.
2159	</desc>
2160	</param>
2161	<param name="imageId" type="uuid" mod="string" dir="in">
2162	<desc>
2163	New UUID for the image. If an empty string is passed, then a new
2164	UUID is automatically created. Specifying a zero UUIDs is not valid.
2165	</desc>
2166	</param>
2167	<param name="setParentId" type="boolean" dir="in">
2168	<desc>
2169	Select whether a new parent UUID is set or not.
2170	</desc>
2171	</param>
2172	<param name="parentId" type="uuid" mod="string" dir="in">
2173	<desc>
2174	New parent UUID for the image. If an empty string is passed, then a
2175	new UUID is automatically created, provided @a setParentId is
2176	@c true. A zero UUID is valid.
2177	</desc>
2178	</param>
2179	<param name="medium" type="IMedium" dir="return">
2180	<desc>Opened medium object.</desc>
2181	</param>
2182	</method>
2183
2184	<method name="getHardDisk" const="yes">
2185	<desc>
2186	Returns a medium with the given UUID.
2187
2188	The medium with the given UUID must be known to this VirtualBox
2189	installation, i.e. it must be previously created by
2190	<link to="#createHardDisk"/> or opened by <link
2191	to="#openHardDisk"/>, or attached to some known virtual machine.
2192
2193	<result name="VBOX_E_OBJECT_NOT_FOUND">
2194	No medium object matching @a id found.
2195	</result>
2196
2197	</desc>
2198	<param name="id" type="uuid" mod="string" dir="in">
2199	<desc>UUID of the medium to look for.</desc>
2200	</param>
2201	<param name="medium" type="IMedium" dir="return">
2202	<desc>Found medium object.</desc>
2203	</param>
2204	</method>
2205
2206	<method name="findHardDisk">
2207	<desc>
2208	Returns a medium that uses the given location to store medium data.
2209
2210	The given medium must be known to this VirtualBox installation, i.e.
2211	it must be previously created by
2212	<link to="#createHardDisk"/> or opened by <link
2213	to="#openHardDisk"/>, or attached to some known virtual machine.
2214
2215	The search is done by comparing the value of the @a location argument to
2216	the <link to="IMedium::location"/> attribute of each known medium.
2217
2218	For locations represented by file names in the host's file system, the
2219	requested location can be a path relative to the
2220	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2221	only a file name without any path is given, the
2222	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2223	folder</link> will be prepended to the file name before searching. Note
2224	that on case sensitive file systems, a case sensitive comparison is
2225	performed, otherwise the case of symbols in the file path is ignored.
2226
2227	<result name="VBOX_E_OBJECT_NOT_FOUND">
2228	No medium object matching @a location found.
2229	</result>
2230
2231	</desc>
2232	<param name="location" type="wstring" dir="in">
2233	<desc>Location string to search for.</desc>
2234	</param>
2235	<param name="medium" type="IMedium" dir="return">
2236	<desc>Found medium object.</desc>
2237	</param>
2238	</method>
2239
2240	<method name="openDVDImage">
2241	<desc>
2242	Opens a CD/DVD image contained in the specified file of the supported
2243	format and assigns it the given UUID.
2244
2245	After the image is successfully opened by this method, it gets
2246	remembered by (known to) this VirtualBox installation and will be
2247	accessible through <link to="#getDVDImage"/> and
2248	<link to="#findDVDImage"/> methods. Remembered images are also
2249	returned as part of the <link to="#DVDImages"/> array and can be mounted
2250	to virtual machines. See IMedium for more details.
2251
2252	See <link to="IMedium::location"/> to get more details about the format
2253	of the location string.
2254
2255	<note>
2256	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2257	</note>
2258
2259	<result name="VBOX_E_FILE_ERROR">
2260	Invalid CD/DVD image file location or could not find the CD/DVD
2261	image at the specified location.
2262	</result>
2263	<result name="VBOX_E_INVALID_OBJECT_STATE">
2264	CD/DVD image already exists in the media registry.
2265	</result>
2266
2267	</desc>
2268	<param name="location" type="wstring" dir="in">
2269	<desc>
2270	Full path to the file that contains a valid CD/DVD image.
2271	</desc>
2272	</param>
2273	<param name="id" type="uuid" mod="string" dir="in">
2274	<desc>
2275	UUID to assign to the given image within this VirtualBox installation.
2276	If an empty (@c null) UUID is specified, the system will randomly
2277	generate a new UUID.
2278	</desc>
2279	</param>
2280	<param name="image" type="IMedium" dir="return">
2281	<desc>Opened CD/DVD image object.</desc>
2282	</param>
2283	</method>
2284
2285	<method name="getDVDImage">
2286	<desc>
2287	Returns a CD/DVD image with the given UUID.
2288
2289	The image with the given UUID must be known to this VirtualBox
2290	installation, i.e. it must be previously opened by <link
2291	to="#openDVDImage"/>, or mounted to some known virtual machine.
2292
2293	<result name="VBOX_E_OBJECT_NOT_FOUND">
2294	No matching DVD image found in the media registry.
2295	</result>
2296
2297	</desc>
2298	<param name="id" type="uuid" mod="string" dir="in">
2299	<desc>UUID of the image to look for.</desc>
2300	</param>
2301	<param name="image" type="IMedium" dir="return">
2302	<desc>Found CD/DVD image object.</desc>
2303	</param>
2304	</method>
2305
2306	<method name="findDVDImage">
2307	<desc>
2308	Returns a CD/DVD image with the given image location.
2309
2310	The image with the given UUID must be known to this VirtualBox
2311	installation, i.e. it must be previously opened by <link
2312	to="#openDVDImage"/>, or mounted to some known virtual machine.
2313
2314	The search is done by comparing the value of the @a location argument to
2315	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2316
2317	The requested location can be a path relative to the
2318	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2319	only a file name without any path is given, the
2320	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2321	folder</link> will be prepended to the file name before searching. Note
2322	that on case sensitive file systems, a case sensitive comparison is
2323	performed, otherwise the case in the file path is ignored.
2324
2325	<result name="VBOX_E_FILE_ERROR">
2326	Invalid image file location.
2327	</result>
2328	<result name="VBOX_E_OBJECT_NOT_FOUND">
2329	No matching DVD image found in the media registry.
2330	</result>
2331
2332	</desc>
2333	<param name="location" type="wstring" dir="in">
2334	<desc>CD/DVD image file path to look for.</desc>
2335	</param>
2336	<param name="image" type="IMedium" dir="return">
2337	<desc>Found CD/DVD image object.</desc>
2338	</param>
2339	</method>
2340
2341	<method name="openFloppyImage">
2342	<desc>
2343	Opens a floppy image contained in the specified file of the supported
2344	format and assigns it the given UUID.
2345
2346	After the image is successfully opened by this method, it gets
2347	remembered by (known to) this VirtualBox installation and will be
2348	accessible through <link to="#getFloppyImage"/> and
2349	<link to="#findFloppyImage"/> methods. Remembered images are also
2350	returned as part of the <link to="#floppyImages"/> array and can be
2351	mounted to virtual machines. See IMedium for more details.
2352
2353	See <link to="IMedium::location"/> to get more details about the format
2354	of the location string.
2355
2356	<result name="VBOX_E_FILE_ERROR">
2357	Invalid floppy image file location or could not find the floppy
2358	image at the specified location.
2359	</result>
2360	<result name="VBOX_E_INVALID_OBJECT_STATE">
2361	Floppy image already exists in the media registry.
2362	</result>
2363
2364	<note>
2365	Currently, only raw floppy images are supported by VirtualBox.
2366	</note>
2367	</desc>
2368	<param name="location" type="wstring" dir="in">
2369	<desc>
2370	Full path to the file that contains a valid floppy image.
2371	</desc>
2372	</param>
2373	<param name="id" type="uuid" mod="string" dir="in">
2374	<desc>
2375	UUID to assign to the given image file within this VirtualBox
2376	installation. If an empty (@c null) UUID is specified, the system will
2377	randomly generate a new UUID.
2378	</desc>
2379	</param>
2380	<param name="image" type="IMedium" dir="return">
2381	<desc>Opened floppy image object.</desc>
2382	</param>
2383	</method>
2384
2385	<method name="getFloppyImage">
2386	<desc>
2387	Returns a floppy image with the given UUID.
2388
2389	The image with the given UUID must be known to this VirtualBox
2390	installation, i.e. it must be previously opened by <link
2391	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2392
2393	<result name="VBOX_E_OBJECT_NOT_FOUND">
2394	No matching floppy image found in the media registry.
2395	</result>
2396
2397	</desc>
2398	<param name="id" type="uuid" mod="string" dir="in">
2399	<desc>UUID of the image to look for.</desc>
2400	</param>
2401	<param name="image" type="IMedium" dir="return">
2402	<desc>Found floppy image object.</desc>
2403	</param>
2404	</method>
2405
2406	<method name="findFloppyImage">
2407	<desc>
2408	Returns a floppy image with the given image location.
2409
2410	The image with the given UUID must be known to this VirtualBox
2411	installation, i.e. it must be previously opened by <link
2412	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2413
2414	The search is done by comparing the value of the @a location argument to
2415	the <link to="IMedium::location"/> attribute of each known floppy image.
2416
2417	The requested location can be a path relative to the
2418	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2419	only a file name without any path is given, the
2420	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2421	folder</link> will be prepended to the file name before searching. Note
2422	that on case sensitive file systems, a case sensitive comparison is
2423	performed, otherwise the case of symbols in the file path is ignored.
2424
2425	<result name="VBOX_E_FILE_ERROR">
2426	Invalid image file location.
2427	</result>
2428	<result name="VBOX_E_OBJECT_NOT_FOUND">
2429	No matching floppy image found in the media registry.
2430	</result>
2431
2432	</desc>
2433	<param name="location" type="wstring" dir="in">
2434	<desc>Floppy image file path to look for.</desc>
2435	</param>
2436	<param name="image" type="IMedium" dir="return">
2437	<desc>Found floppy image object.</desc>
2438	</param>
2439	</method>
2440
2441	<method name="getGuestOSType">
2442	<desc>
2443	Returns an object describing the specified guest OS type.
2444
2445	The requested guest OS type is specified using a string which is a
2446	mnemonic identifier of the guest operating system, such as
2447	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2448	particular virtual machine can be read or set using the
2449	<link to="IMachine::OSTypeId"/> attribute.
2450
2451	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2452	available guest OS type objects. Each object has an
2453	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2454	the guest OS this object describes.
2455
2456	<result name="E_INVALIDARG">
2457	@a id is not a valid Guest OS type.
2458	</result>
2459
2460	</desc>
2461	<param name="id" type="uuid" mod="string" dir="in">
2462	<desc>Guest OS type ID string.</desc>
2463	</param>
2464	<param name="type" type="IGuestOSType" dir="return">
2465	<desc>Guest OS type object.</desc>
2466	</param>
2467	</method>
2468
2469	<method name="createSharedFolder">
2470	<desc>
2471	Creates a new global shared folder by associating the given logical
2472	name with the given host path, adds it to the collection of shared
2473	folders and starts sharing it. Refer to the description of
2474	<link to="ISharedFolder"/> to read more about logical names.
2475	<note>
2476	In the current implementation, this operation is not
2477	implemented.
2478	</note>
2479	</desc>
2480	<param name="name" type="wstring" dir="in">
2481	<desc>Unique logical name of the shared folder.</desc>
2482	</param>
2483	<param name="hostPath" type="wstring" dir="in">
2484	<desc>Full path to the shared folder in the host file system.</desc>
2485	</param>
2486	<param name="writable" type="boolean" dir="in">
2487	<desc>Whether the share is writable or readonly</desc>
2488	</param>
2489	</method>
2490
2491	<method name="removeSharedFolder">
2492	<desc>
2493	Removes the global shared folder with the given name previously
2494	created by <link to="#createSharedFolder"/> from the collection of
2495	shared folders and stops sharing it.
2496	<note>
2497	In the current implementation, this operation is not
2498	implemented.
2499	</note>
2500	</desc>
2501	<param name="name" type="wstring" dir="in">
2502	<desc>Logical name of the shared folder to remove.</desc>
2503	</param>
2504	</method>
2505
2506	<method name="getExtraDataKeys">
2507	<desc>
2508	Returns an array representing the global extra data keys which currently
2509	have values defined.
2510	</desc>
2511	<param name="value" type="wstring" dir="return" safearray="yes">
2512	<desc>Array of extra data keys.</desc>
2513	</param>
2514	</method>
2515
2516	<method name="getExtraData">
2517	<desc>
2518	Returns associated global extra data.
2519
2520	If the requested data @a key does not exist, this function will
2521	succeed and return an empty string in the @a value argument.
2522
2523	<result name="VBOX_E_FILE_ERROR">
2524	Settings file not accessible.
2525	</result>
2526	<result name="VBOX_E_XML_ERROR">
2527	Could not parse the settings file.
2528	</result>
2529
2530	</desc>
2531	<param name="key" type="wstring" dir="in">
2532	<desc>Name of the data key to get.</desc>
2533	</param>
2534	<param name="value" type="wstring" dir="return">
2535	<desc>Value of the requested data key.</desc>
2536	</param>
2537	</method>
2538
2539	<method name="setExtraData">
2540	<desc>
2541	Sets associated global extra data.
2542
2543	If you pass @c null or empty string as a key @a value, the given @a key
2544	will be deleted.
2545
2546	<note>
2547	Before performing the actual data change, this method will ask all
2548	registered callbacks using the
2549	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2550	notification for a permission. If one of the callbacks refuses the
2551	new value, the change will not be performed.
2552	</note>
2553	<note>
2554	On success, the
2555	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2556	is called to inform all registered callbacks about a successful data
2557	change.
2558	</note>
2559
2560	<result name="VBOX_E_FILE_ERROR">
2561	Settings file not accessible.
2562	</result>
2563	<result name="VBOX_E_XML_ERROR">
2564	Could not parse the settings file.
2565	</result>
2566	<result name="E_ACCESSDENIED">
2567	Modification request refused.
2568	</result>
2569
2570	</desc>
2571	<param name="key" type="wstring" dir="in">
2572	<desc>Name of the data key to set.</desc>
2573	</param>
2574	<param name="value" type="wstring" dir="in">
2575	<desc>Value to assign to the key.</desc>
2576	</param>
2577	</method>
2578
2579	<method name="openSession">
2580	<desc>
2581	Opens a new direct session with the given virtual machine.
2582
2583	A direct session acts as a local lock on the given VM.
2584	There can be only one direct session open at a time for every
2585	virtual machine, protecting the VM from being manipulated by
2586	conflicting actions from different processes. Only after a
2587	direct session has been opened, one can change all VM settings
2588	and execute the VM in the process space of the session object.
2589
2590	Sessions therefore can be compared to mutex semaphores that
2591	lock a given VM for modification and execution.
2592	See <link to="ISession">ISession</link> for details.
2593
2594	<note>Unless you are writing a new VM frontend, you will not
2595	want to execute a VM in the current process. To spawn a new
2596	process that executes a VM, use
2597	<link to="IVirtualBox::openRemoteSession" />
2598	instead.</note>
2599
2600	Upon successful return, the session object can be used to
2601	get access to the machine and to the VM console.
2602
2603	In VirtualBox terminology, the machine becomes "mutable" after
2604	a session has been opened. Note that the "mutable" machine
2605	object, on which you may invoke IMachine methods to change its
2606	settings, will be a different object from the immutable IMachine
2607	objects returned by various IVirtualBox methods. To obtain a
2608	mutable IMachine object (upon which you can invoke settings methods),
2609	use the <link to="ISession::machine" /> attribute.
2610
2611	One must always call <link to="ISession::close" /> to release the
2612	lock on the machine, or the machine's state will eventually be
2613	set to "Aborted".
2614
2615	In other words, to change settings on a machine, the following
2616	sequence is typically performed:
2617
2618	<ol>
2619	<li>Call this method (openSession) to have a machine locked for
2620	the current session.</li>
2621
2622	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2623
2624	<li>Change the settings of the machine.</li>
2625
2626	<li>Call <link to="IMachine::saveSettings" />.</li>
2627
2628	<li>Close the session by calling <link to="ISession::close"/>.</li>
2629	</ol>
2630
2631	<result name="E_UNEXPECTED">
2632	Virtual machine not registered.
2633	</result>
2634	<result name="E_ACCESSDENIED">
2635	Process not started by OpenRemoteSession.
2636	</result>
2637	<result name="VBOX_E_OBJECT_NOT_FOUND">
2638	No matching virtual machine found.
2639	</result>
2640	<result name="VBOX_E_INVALID_OBJECT_STATE">
2641	Session already open or being opened.
2642	</result>
2643	<result name="VBOX_E_VM_ERROR">
2644	Failed to assign machine to session.
2645	</result>
2646
2647	</desc>
2648	<param name="session" type="ISession" dir="in">
2649	<desc>
2650	Session object that will represent the opened session after
2651	successful method invocation. This object must not represent
2652	the already open session.
2653	<note>
2654	This session will be automatically closed if the
2655	VirtualBox server is terminated for some reason.
2656	</note>
2657	</desc>
2658	</param>
2659	<param name="machineId" type="uuid" mod="string" dir="in">
2660	<desc>ID of the virtual machine to open a session with.</desc>
2661	</param>
2662	</method>
2663
2664	<method name="openRemoteSession">
2665	<desc>
2666	Spawns a new process that executes a virtual machine (called a
2667	"remote session").
2668
2669	Opening a remote session causes the VirtualBox server to start a new
2670	process that opens a direct session with the given VM. As a result, the
2671	VM is locked by that direct session in the new process, preventing
2672	conflicting changes from other processes. Since sessions act as locks
2673	that prevent conflicting changes, one cannot open a remote session
2674	for a VM that already has another open session (direct or remote), or
2675	is currently in the process of opening one (see <link
2676	to="IMachine::sessionState"/>).
2677
2678	While the remote session still provides some level of control over the
2679	VM execution to the caller (using the <link to="IConsole" /> interface),
2680	not all VM settings are available for modification within the remote
2681	session context.
2682
2683	This operation can take some time (a new VM is started in a new process,
2684	for which memory and other resources need to be set up). Because of this,
2685	an <link to="IProgress" /> is returned to allow the caller to wait for this
2686	asynchronous operation to be completed. Until then, the remote session
2687	object remains in the closed state, and accessing the machine or its
2688	console through it is invalid. It is recommended to use
2689	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2690	completion.
2691
2692	As with all <link to="ISession" /> objects, it is recommended to call
2693	<link to="ISession::close" /> on the local session object once openRemoteSession()
2694	has been called. However, the session's state (see <link to="ISession::state" />)
2695	will not return to "Closed" until the remote session has also closed (i.e.
2696	until the VM is no longer running). In that case, however, the state of
2697	the session will automatically change back to "Closed".
2698
2699	Currently supported session types (values of the @a type
2700	argument) are:
2701	<ul>
2702	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2703	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2704	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2705	</ul>
2706
2707	The @a environment argument is a string containing definitions of
2708	environment variables in the following format:
2709	@code
2710	NAME[=VALUE]\n
2711	NAME[=VALUE]\n
2712	...
2713	@endcode
2714	where <tt>\\n</tt> is the new line character. These environment
2715	variables will be appended to the environment of the VirtualBox server
2716	process. If an environment variable exists both in the server process
2717	and in this list, the value from this list takes precedence over the
2718	server's variable. If the value of the environment variable is
2719	omitted, this variable will be removed from the resulting environment.
2720	If the environment string is @c null or empty, the server environment
2721	is inherited by the started process as is.
2722
2723	<see>openExistingSession</see>
2724
2725	<result name="E_UNEXPECTED">
2726	Virtual machine not registered.
2727	</result>
2728	<result name="E_INVALIDARG">
2729	Invalid session type @a type.
2730	</result>
2731	<result name="VBOX_E_OBJECT_NOT_FOUND">
2732	No machine matching @a machineId found.
2733	</result>
2734	<result name="VBOX_E_INVALID_OBJECT_STATE">
2735	Session already open or being opened.
2736	</result>
2737	<result name="VBOX_E_IPRT_ERROR">
2738	Launching process for machine failed.
2739	</result>
2740	<result name="VBOX_E_VM_ERROR">
2741	Failed to assign machine to session.
2742	</result>
2743
2744	</desc>
2745	<param name="session" type="ISession" dir="in">
2746	<desc>
2747	Session object that will represent the opened remote session
2748	after successful method invocation (this object must not
2749	represent an already open session).
2750	</desc>
2751	</param>
2752	<param name="machineId" type="uuid" mod="string" dir="in">
2753	<desc>ID of the virtual machine to open a session with.</desc>
2754	</param>
2755	<param name="type" type="wstring" dir="in">
2756	<desc>
2757	Type of the remote session (case sensitive).
2758	</desc>
2759	</param>
2760	<param name="environment" type="wstring" dir="in">
2761	<desc>
2762	Environment to pass to the opened session.
2763	</desc>
2764	</param>
2765	<param name="progress" type="IProgress" dir="return">
2766	<desc>Progress object to track the operation completion.</desc>
2767	</param>
2768	</method>
2769
2770	<method name="openExistingSession">
2771	<desc>
2772	Opens a new remote session with the virtual machine for
2773	which a direct session is already open.
2774
2775	The remote session provides some level of control over the VM
2776	execution (using the IConsole interface) to the caller; however,
2777	within the remote session context, not all VM settings are available
2778	for modification.
2779
2780	As opposed to <link to="#openRemoteSession"/>, the number of
2781	remote sessions opened this way is not limited by the API
2782
2783	<note>
2784	It is an error to open a remote session with the machine that
2785	doesn't have an open direct session.
2786	</note>
2787
2788	<result name="E_UNEXPECTED">
2789	Virtual machine not registered.
2790	</result>
2791	<result name="VBOX_E_OBJECT_NOT_FOUND">
2792	No machine matching @a machineId found.
2793	</result>
2794	<result name="VBOX_E_INVALID_OBJECT_STATE">
2795	Session already open or being opened.
2796	</result>
2797	<result name="VBOX_E_INVALID_SESSION_STATE">
2798	Direct session state not Open.
2799	</result>
2800	<result name="VBOX_E_VM_ERROR">
2801	Failed to get console object from direct session or assign
2802	machine to session.
2803	</result>
2804
2805	<see>openRemoteSession</see>
2806	</desc>
2807	<param name="session" type="ISession" dir="in">
2808	<desc>
2809	Session object that will represent the open remote session
2810	after successful method invocation. This object must not
2811	represent an already open session.
2812	<note>
2813	This session will be automatically closed when the peer
2814	(direct) session dies or gets closed.
2815	</note>
2816	</desc>
2817	</param>
2818	<param name="machineId" type="uuid" mod="string" dir="in">
2819	<desc>ID of the virtual machine to open a session with.</desc>
2820	</param>
2821	</method>
2822
2823	<method name="registerCallback">
2824	<desc>
2825	Registers a new global VirtualBox callback. The methods of the given
2826	callback object will be called by VirtualBox when an appropriate
2827	event occurs.
2828
2829	<result name="E_INVALIDARG">
2830	A @c null callback cannot be registered.
2831	</result>
2832
2833	</desc>
2834	<param name="callback" type="IVirtualBoxCallback" dir="in">
2835	<desc>Callback object to register.</desc>
2836	</param>
2837	</method>
2838
2839	<method name="unregisterCallback">
2840	<desc>
2841	Unregisters the previously registered global VirtualBox callback.
2842
2843	<result name="E_INVALIDARG">
2844	Specified @a callback not registered.
2845	</result>
2846
2847	</desc>
2848	<param name="callback" type="IVirtualBoxCallback" dir="in">
2849	<desc>Callback object to unregister.</desc>
2850	</param>
2851	</method>
2852
2853	<method name="waitForPropertyChange">
2854	<desc>
2855	Blocks the caller until any of the properties represented by the
2856	@a what argument changes the value or until the given timeout interval
2857	expires.
2858
2859	The @a what argument is a comma separated list of property masks that
2860	describe properties the caller is interested in. The property mask is
2861	a string in the following format:
2862
2863	<pre>
2864	[[group.]subgroup.]name
2865	</pre>
2866
2867	where @c name is the property name and @c group, @c subgroup are zero
2868	or more property group specifiers. Each element (group or name) in
2869	the property mask may be either a Latin string or an asterisk symbol
2870	(@c "*") which is used to match any string for the given element. A
2871	property mask that doesn't contain asterisk symbols represents a
2872	single fully qualified property name.
2873
2874	Groups in the fully qualified property name go from more generic (the
2875	left-most part) to more specific (the right-most part). The first
2876	element is usually a name of the object the property belongs to. The
2877	second element may be either a property name, or a child object name,
2878	or an index if the preceding element names an object which is one of
2879	many objects of the same type. This way, property names form a
2880	hierarchy of properties. Here are some examples of property names:
2881
2882	<table>
2883	<tr>
2884	<td><tt>VirtualBox.version</tt></td>
2885	<td><link to="IVirtualBox::version"/> property</td>
2886	</tr>
2887	<tr>
2888	<td><tt>Machine.<UUID>.name</tt></td>
2889	<td><link to="IMachine::name"/> property of the machine with the
2890	given UUID</td>
2891	</tr>
2892	</table>
2893
2894	Most property names directly correspond to the properties of objects
2895	(components) provided by the VirtualBox library and may be used to
2896	track changes to these properties. However, there may be
2897	pseudo-property names that don't correspond to any existing object's
2898	property directly, as well as there may be object properties that
2899	don't have a corresponding property name that is understood by this
2900	method, and therefore changes to such properties cannot be
2901	tracked. See individual object's property descriptions to get a
2902	fully qualified property name that can be used with this method (if
2903	any).
2904
2905	There is a special property mask @c "*" (i.e. a string consisting of a
2906	single asterisk symbol) that can be used to match all properties.
2907	Below are more examples of property masks:
2908
2909	<table>
2910	<tr>
2911	<td><tt>VirtualBox.*</tt></td>
2912	<td>Track all properties of the VirtualBox object</td>
2913	</tr>
2914	<tr>
2915	<td><tt>Machine.*.name</tt></td>
2916	<td>Track changes to the <link to="IMachine::name"/> property of
2917	all registered virtual machines</td>
2918	</tr>
2919	</table>
2920
2921	<note>
2922	This function is not implemented in the current version of the
2923	product.
2924	</note>
2925	</desc>
2926	<param name="what" type="wstring" dir="in">
2927	<desc>Comma separated list of property masks.</desc>
2928	</param>
2929	<param name="timeout" type="unsigned long" dir="in">
2930	<desc>
2931	Wait timeout in milliseconds.
2932	Specify -1 for an indefinite wait.
2933	</desc>
2934	</param>
2935	<param name="changed" type="wstring" dir="out">
2936	<desc>
2937	Comma separated list of properties that have been changed and caused
2938	this method to return to the caller.
2939	</desc>
2940	</param>
2941	<param name="values" type="wstring" dir="out">
2942	<desc>Reserved, not currently used.</desc>
2943	</param>
2944	</method>
2945
2946	<!--method name="createDHCPServerForInterface">
2947	<desc>
2948	Creates a dhcp server settings to be used for the given interface
2949	<result name="E_INVALIDARG">
2950	Host network interface @a name already exists.
2951	</result>
2952	</desc>
2953	<param name="interface" type="IHostNetworkInterface" dir="in">
2954	<desc>Network Interface</desc>
2955	</param>
2956	<param name="server" type="IDHCPServer" dir="out">
2957	<desc>Dhcp server settings</desc>
2958	</param>
2959	</method-->
2960
2961	<method name="createDHCPServer">
2962	<desc>
2963	Creates a dhcp server settings to be used for the given internal network name
2964	<result name="E_INVALIDARG">
2965	Host network interface @a name already exists.
2966	</result>
2967	</desc>
2968	<param name="name" type="wstring" dir="in">
2969	<desc>server name</desc>
2970	</param>
2971	<param name="server" type="IDHCPServer" dir="return">
2972	<desc>Dhcp server settings</desc>
2973	</param>
2974	</method>
2975
2976	<method name="findDHCPServerByNetworkName">
2977	<desc>
2978	Searches a dhcp server settings to be used for the given internal network name
2979	<result name="E_INVALIDARG">
2980	Host network interface @a name already exists.
2981	</result>
2982
2983	</desc>
2984	<param name="name" type="wstring" dir="in">
2985	<desc>server name</desc>
2986	</param>
2987	<param name="server" type="IDHCPServer" dir="return">
2988	<desc>Dhcp server settings</desc>
2989	</param>
2990	</method>
2991
2992	<!--method name="findDHCPServerForInterface">
2993	<desc>
2994	Searches a dhcp server settings to be used for the given interface
2995	<result name="E_INVALIDARG">
2996	Host network interface @a name already exists.
2997	</result>
2998	</desc>
2999	<param name="interface" type="IHostNetworkInterface" dir="in">
3000	<desc>Network Interface</desc>
3001	</param>
3002	<param name="server" type="IDHCPServer" dir="out">
3003	<desc>Dhcp server settings</desc>
3004	</param>
3005	</method-->
3006
3007	<method name="removeDHCPServer">
3008	<desc>
3009	Removes the dhcp server settings
3010	<result name="E_INVALIDARG">
3011	Host network interface @a name already exists.
3012	</result>
3013	</desc>
3014	<param name="server" type="IDHCPServer" dir="in">
3015	<desc>Dhcp server settings to be removed</desc>
3016	</param>
3017	</method>
3018
3019
3020	<method name="checkFirmwarePresent">
3021	<desc>
3022	Check if this VirtualBox installation has a firmware
3023	of the given type available, either system-wide or per-user.
3024	Optionally, this may return a hint where this firmware can be
3025	downloaded from.
3026	</desc>
3027	<param name="firmwareType" type="FirmwareType" dir="in">
3028	<desc>
3029	Type of firmware to check.
3030	</desc>
3031	</param>
3032	<param name="version" type="wstring" dir="in">
3033	<desc>Expected version number, usually empty string (presently ignored).</desc>
3034	</param>
3035
3036	<param name="url" type="wstring" dir="out">
3037	<desc>
3038	Suggested URL to download this firmware from.
3039	</desc>
3040	</param>
3041
3042	<param name="file" type="wstring" dir="out">
3043	<desc>
3044	Filename of firmware, only valid if result == TRUE.
3045	</desc>
3046	</param>
3047
3048	<param name="result" type="boolean" dir="return">
3049	<desc>If firmware of this type and version is available.</desc>
3050	</param>
3051	</method>
3052
3053	</interface>
3054
3055	<!--
3056	// IVFSExplorer
3057	/////////////////////////////////////////////////////////////////////////
3058	-->
3059
3060	<enum
3061	name="VFSType"
3062	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3063	>
3064	<desc>
3065	Virtual file systems supported by VFSExplorer.
3066	</desc>
3067
3068	<const name="File" value="1" />
3069	<const name="Cloud" value="2" />
3070	<const name="S3" value="3" />
3071	<const name="WebDav" value="4" />
3072	</enum>
3073
3074	<enum
3075	name="VFSFileType"
3076	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3077	>
3078	<desc>
3079	File types known by VFSExplorer.
3080	</desc>
3081
3082	<const name="Unknown" value="1" />
3083	<const name="Fifo" value="2" />
3084	<const name="DevChar" value="3" />
3085	<const name="Directory" value="4" />
3086	<const name="DevBlock" value="5" />
3087	<const name="File" value="6" />
3088	<const name="SymLink" value="7" />
3089	<const name="Socket" value="8" />
3090	<const name="WhiteOut" value="9" />
3091	</enum>
3092
3093	<interface
3094	name="IVFSExplorer" extends="$unknown"
3095	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3096	wsmap="managed"
3097	>
3098	<desc>
3099	The VFSExplorer interface unifies access to different file system
3100	types. This includes local file systems as well remote file systems like
3101	S3. For a list of supported types see <link to="VFSType" />.
3102	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3103	</desc>
3104
3105	<attribute name="path" type="wstring" readonly="yes">
3106	<desc>Returns the current path in the virtual file system.</desc>
3107	</attribute>
3108
3109	<attribute name="type" type="VFSType" readonly="yes">
3110	<desc>Returns the file system type which is currently in use.</desc>
3111	</attribute>
3112
3113	<method name="update">
3114	<desc>Updates the internal list of files/directories from the
3115	current directory level. Use <link to="#entryList" /> to get the full list
3116	after a call to this method.</desc>
3117
3118	<param name="aProgress" type="IProgress" dir="return">
3119	<desc>Progress object to track the operation completion.</desc>
3120	</param>
3121	</method>
3122
3123	<method name="cd">
3124	<desc>Change the current directory level.</desc>
3125
3126	<param name="aDir" type="wstring" dir="in">
3127	<desc>The name of the directory to go in.</desc>
3128	</param>
3129
3130	<param name="aProgress" type="IProgress" dir="return">
3131	<desc>Progress object to track the operation completion.</desc>
3132	</param>
3133	</method>
3134
3135	<method name="cdUp">
3136	<desc>Go one directory upwards from the current directory level.</desc>
3137
3138	<param name="aProgress" type="IProgress" dir="return">
3139	<desc>Progress object to track the operation completion.</desc>
3140	</param>
3141	</method>
3142
3143	<method name="entryList">
3144	<desc>Returns a list of files/directories after a call to <link
3145	to="#update" />. The user is responsible for keeping this internal
3146	list up do date.</desc>
3147
3148	<param name="aNames" type="wstring" safearray="yes" dir="out">
3149	<desc>The list of names for the entries.</desc>
3150	</param>
3151
3152	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3153	<desc>The list of types for the entries.</desc>
3154	</param>
3155	</method>
3156
3157	<method name="exists">
3158	<desc>Checks if the given file list exists in the current directory
3159	level.</desc>
3160
3161	<param name="aNames" type="wstring" safearray="yes" dir="in">
3162	<desc>The names to check.</desc>
3163	</param>
3164
3165	<param name="aExists" type="wstring" safearray="yes" dir="return">
3166	<desc>The names which exist.</desc>
3167	</param>
3168	</method>
3169
3170	<method name="remove">
3171	<desc>Deletes the given files in the current directory level.</desc>
3172
3173	<param name="aNames" type="wstring" safearray="yes" dir="in">
3174	<desc>The names to remove.</desc>
3175	</param>
3176
3177	<param name="aProgress" type="IProgress" dir="return">
3178	<desc>Progress object to track the operation completion.</desc>
3179	</param>
3180	</method>
3181
3182	</interface>
3183
3184	<!--
3185	// IAppliance
3186	/////////////////////////////////////////////////////////////////////////
3187	-->
3188
3189	<interface
3190	name="IAppliance" extends="$unknown"
3191	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3192	wsmap="managed"
3193	>
3194	<desc>
3195	Represents a platform-independent appliance in OVF format. An instance of this is returned
3196	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3197	appliances with VirtualBox.
3198
3199	The OVF standard suggests two different physical file formats:
3200
3201	<ol>
3202	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3203	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3204	this descriptor file references other files, as OVF appliances distributed as a set of
3205	files most likely do, those files must be in the same directory as the descriptor file.</li>
3206
3207	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3208	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3209	files and optionally other files.
3210
3211	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3212	be added with a later version.</li>
3213	</ol>
3214
3215	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3216	<link to="IMachine" /> involves the following sequence of API calls:
3217
3218	<ol>
3219	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3220	</li>
3221
3222	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3223	would like to import. So long as this file is syntactically valid, this will succeed
3224	and return an instance of IAppliance that contains the parsed data from the OVF file.
3225	</li>
3226
3227	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3228	contents of the IAppliance attributes accordingly. These can be inspected by a
3229	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3230	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3231	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3232	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3233	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3234	The GUI can then give the user the option to confirm and/or change these suggestions.
3235	</li>
3236
3237	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3238	virtual system to override the suggestions made by the interpret() routine.
3239	</li>
3240
3241	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3242	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3243	virtual system descriptions.
3244	</li>
3245	</ol>
3246
3247	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3248
3249	<ol>
3250	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3251	an empty IAppliance object.
3252	</li>
3253
3254	<li>For each machine you would like to export, call <link to="IMachine::export" />
3255	with the IAppliance object you just created. This creates an instance of
3256	<link to="IVirtualSystemDescription" /> inside the appliance.
3257	</li>
3258
3259	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3260	virtual system to override the suggestions made by the export() routine.
3261	</li>
3262
3263	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3264	file written.</li>
3265	</ol>
3266
3267	</desc>
3268
3269	<attribute name="path" type="wstring" readonly="yes">
3270	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3271	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3272	<link to="#write" /> (for export).
3273	This attribute is empty until one of these methods has been called.
3274	</desc>
3275	</attribute>
3276
3277	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3278	<desc>
3279	Array of virtual disk definitions. One such description exists for each
3280	disk definition in the OVF; each string array item represents one such piece of
3281	disk information, with the information fields separated by tab (\\t) characters.
3282
3283	The caller should be prepared for additional fields being appended to
3284	this string in future versions of VirtualBox and therefore check for
3285	the number of tabs in the strings returned.
3286
3287	In the current version, the following eight fields are returned per string
3288	in the array:
3289
3290	<ol>
3291	<li>Disk ID (unique string identifier given to disk)</li>
3292
3293	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3294
3295	<li>Populated size (optional unsigned integer indicating the current size of the
3296	disk; can be approximate; -1 if unspecified)</li>
3297
3298	<li>Format (string identifying the disk format, typically
3299	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3300
3301	<li>Reference (where to find the disk image, typically a file name; if empty,
3302	then the disk should be created on import)</li>
3303
3304	<li>Image size (optional unsigned integer indicating the size of the image,
3305	which need not necessarily be the same as the values specified above, since
3306	the image may be compressed or sparse; -1 if not specified)</li>
3307
3308	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3309	presently unsupported and always -1)</li>
3310
3311	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3312	</ol>
3313	</desc>
3314	</attribute>
3315
3316	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3317	<desc> Array of virtual system descriptions. One such description is created
3318	for each virtual system found in the OVF.
3319	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3320	(for export) has been called.
3321	</desc>
3322	</attribute>
3323
3324	<method name="read">
3325	<desc>
3326	Reads an OVF file into the appliance object.
3327
3328	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3329	mere fact that this method returns successfully does not mean that VirtualBox supports all
3330	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3331	</desc>
3332	<param name="file" type="wstring" dir="in">
3333	<desc>
3334	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3335	on whether the appliance is distributed as a set of files or as a single file, respectively).
3336	</desc>
3337	</param>
3338	<param name="aProgress" type="IProgress" dir="return">
3339	<desc></desc>
3340	</param>
3341	</method>
3342
3343	<method name="interpret">
3344	<desc>
3345	Interprets the OVF data that was read when the appliance was constructed. After
3346	calling this method, one can inspect the
3347	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3348	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3349	the appliance.
3350
3351	Calling this method is the second step of importing an appliance into VirtualBox;
3352	see <link to="IAppliance" /> for an overview.
3353
3354	After calling this method, one should call <link to="#getWarnings" /> to find out
3355	if problems were encountered during the processing which might later lead to
3356	errors.
3357	</desc>
3358	</method>
3359
3360	<method name="importMachines">
3361	<desc>
3362	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3363	and other interfaces that match the information contained in the appliance as
3364	closely as possible, as represented by the import instructions in the
3365	<link to="#virtualSystemDescriptions" /> array.
3366
3367	Calling this method is the final step of importing an appliance into VirtualBox;
3368	see <link to="IAppliance" /> for an overview.
3369
3370	Since importing the appliance will most probably involve copying and converting
3371	disk images, which can take a long time, this method operates asynchronously and
3372	returns an IProgress object to allow the caller to monitor the progress.
3373	</desc>
3374
3375	<param name="aProgress" type="IProgress" dir="return">
3376	<desc></desc>
3377	</param>
3378	</method>
3379
3380	<method name="createVFSExplorer">
3381	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3382
3383	<param name="aUri" type="wstring" dir="in">
3384	<desc>The URI describing the file system to use.</desc>
3385	</param>
3386
3387	<param name="aExplorer" type="IVFSExplorer" dir="return">
3388	<desc></desc>
3389	</param>
3390	</method>
3391
3392	<method name="write">
3393	<desc>
3394	Writes the contents of the appliance exports into a new OVF file.
3395
3396	Calling this method is the final step of exporting an appliance from VirtualBox;
3397	see <link to="IAppliance" /> for an overview.
3398
3399	Since exporting the appliance will most probably involve copying and converting
3400	disk images, which can take a long time, this method operates asynchronously and
3401	returns an IProgress object to allow the caller to monitor the progress.
3402	</desc>
3403	<param name="format" type="wstring" dir="in">
3404	<desc>
3405	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3406	future versions of VirtualBox may support additional formats.
3407	</desc>
3408	</param>
3409	<param name="path" type="wstring" dir="in">
3410	<desc>
3411	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3412	on whether the appliance is distributed as a set of files or as a single file, respectively).
3413	</desc>
3414	</param>
3415	<param name="aProgress" type="IProgress" dir="return">
3416	<desc>Progress object to track the operation completion.</desc>
3417	</param>
3418	</method>
3419
3420	<method name="getWarnings">
3421	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3422
3423	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3424	<desc></desc>
3425	</param>
3426	</method>
3427
3428	</interface>
3429
3430	<enum
3431	name="VirtualSystemDescriptionType"
3432	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3433	>
3434	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3435	a configuration value.</desc>
3436
3437	<const name="Ignore" value="1" />
3438	<const name="OS" value="2" />
3439	<const name="Name" value="3" />
3440	<const name="Product" value="4" />
3441	<const name="Vendor" value="5" />
3442	<const name="Version" value="6" />
3443	<const name="ProductUrl" value="7" />
3444	<const name="VendorUrl" value="8" />
3445	<const name="Description" value="9" />
3446	<const name="License" value="10" />
3447	<const name="Miscellaneous" value="11" />
3448	<const name="CPU" value="12" />
3449	<const name="Memory" value="13" />
3450	<const name="HardDiskControllerIDE" value="14" />
3451	<const name="HardDiskControllerSATA" value="15" />
3452	<const name="HardDiskControllerSCSI" value="16" />
3453	<const name="HardDiskImage" value="17" />
3454	<const name="Floppy" value="18" />
3455	<const name="CDROM" value="19" />
3456	<const name="NetworkAdapter" value="20" />
3457	<const name="USBController" value="21" />
3458	<const name="SoundCard" value="22" />
3459
3460	</enum>
3461
3462	<enum
3463	name="VirtualSystemDescriptionValueType"
3464	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3465	>
3466	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3467	type to fetch.</desc>
3468
3469	<const name="Reference" value="1" />
3470	<const name="Original" value="2" />
3471	<const name="Auto" value="3" />
3472	<const name="ExtraConfig" value="4" />
3473
3474	</enum>
3475
3476	<interface
3477	name="IVirtualSystemDescription" extends="$unknown"
3478	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3479	wsmap="managed"
3480	>
3481
3482	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3483	After <link to="IAppliance::interpret" /> has been called, that array contains
3484	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3485	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3486	into VirtualBox.
3487	</desc>
3488
3489	<attribute name="count" type="unsigned long" readonly="yes">
3490	<desc>Return the number of virtual system description entries.</desc>
3491	</attribute>
3492
3493	<method name="getDescription">
3494	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3495	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3496
3497	The list below identifies the value sets that are possible depending on the
3498	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3499	the array item with the same index in aOvfValues[] will contain the original value as contained
3500	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3501	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3502	the aExtraConfigValues[] array item may also be used.
3503
3504	<ul>
3505	<li>
3506	"OS": the guest operating system type. There must be exactly one such array item on import. The
3507	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3508	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3509	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3510	</li>
3511	<li>
3512	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3513	if none is present on import, then an automatic name will be created from the operating system
3514	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3515	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3516	<link to="IMachine" /> name that does not exist yet.
3517	</li>
3518	<li>
3519	"Description": an arbitrary description.
3520	</li>
3521	<li>
3522	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3523	code to display such a license for agreement; the Main API does not enforce any such policy.
3524	</li>
3525	<li>
3526	Miscellaneous: reserved for future use.
3527	</li>
3528	<li>
3529	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3530	</li>
3531	<li>
3532	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3533	is present on import, then VirtualBox will set a meaningful default based on the operating system
3534	type.
3535	</li>
3536	<li>
3537	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3538	has no value in aOvfValues[] or aVBoxValues[].
3539	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3540	type can use to specify which hard disk controller a virtual disk should be connected to.
3541	</li>
3542	<li>
3543	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3544	has no value in aOvfValues[] or aVBoxValues[].
3545	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3546	</li>
3547	<li>
3548	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3549	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3550	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3551	</li>
3552	<li>
3553	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3554	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3555
3556	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3557	a path since the image file should be in the same location as the OVF file itself), whereas the
3558	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3559	hard disk image. This means that on import the image will be copied and converted from the
3560	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3561	On import, the target image will also be registered with VirtualBox.
3562
3563	The matching item in the aExtraConfigValues[] array must contain a string of the following
3564	format: "controller=<index>;channel=<c>"
3565	In this string, <index> must be an integer specifying the hard disk controller to connect
3566	the image to. That number must be the index of an array item with one of the hard disk controller
3567	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3568	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3569	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3570	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3571	</li>
3572	<li>
3573	"CDROM": a virtual CD-ROM drive. The matching item in aExtraConfigValue[] contains the same
3574	attachment information as with "HardDiskImage" items.
3575	</li>
3576	<li>
3577	"CDROM": a virtual floppy drive. The matching item in aExtraConfigValue[] contains the same
3578	attachment information as with "HardDiskImage" items.
3579	</li>
3580	<li>
3581	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3582	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3583	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3584	</li>
3585	<li>
3586	"USBController": a USB controller. There can be at most one such item. If and only if such an
3587	item ispresent, USB support will be enabled for the new virtual machine.
3588	</li>
3589	<li>
3590	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3591	present, sound support will be enabled for the new virtual machine. Note that the virtual
3592	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3593	may be different from the virtual soundcard expected by the appliance.
3594	</li>
3595	</ul>
3596
3597	</desc>
3598
3599	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3600	<desc></desc>
3601	</param>
3602
3603	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3604	<desc></desc>
3605	</param>
3606
3607	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3608	<desc></desc>
3609	</param>
3610
3611	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3612	<desc></desc>
3613	</param>
3614
3615	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3616	<desc></desc>
3617	</param>
3618
3619	</method>
3620
3621	<method name="getDescriptionByType">
3622	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3623	should be returned.</desc>
3624
3625	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3626	<desc></desc>
3627	</param>
3628
3629	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3630	<desc></desc>
3631	</param>
3632
3633	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3634	<desc></desc>
3635	</param>
3636
3637	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3638	<desc></desc>
3639	</param>
3640
3641	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3642	<desc></desc>
3643	</param>
3644
3645	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3646	<desc></desc>
3647	</param>
3648
3649	</method>
3650
3651	<method name="getValuesByType">
3652	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3653	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3654	values.</desc>
3655
3656	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3657	<desc></desc>
3658	</param>
3659
3660	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3661	<desc></desc>
3662	</param>
3663
3664	<param name="aValues" type="wstring" dir="return" safearray="yes">
3665	<desc></desc>
3666	</param>
3667
3668	</method>
3669
3670	<method name="setFinalValues">
3671	<desc>
3672	This method allows the appliance's user to change the configuration for the virtual
3673	system descriptions. For each array item returned from <link to="#getDescription" />,
3674	you must pass in one boolean value and one configuration value.
3675
3676	Each item in the boolean array determines whether the particular configuration item
3677	should be enabled.
3678	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3679	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3680	and SoundCard.
3681
3682	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3683	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3684	the configuration remains unchanged. Please see the documentation for getDescription()
3685	for valid configuration values for the individual array item types. If the
3686	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3687	</desc>
3688
3689	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3690	<desc></desc>
3691	</param>
3692
3693	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3694	<desc></desc>
3695	</param>
3696
3697	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3698	<desc></desc>
3699	</param>
3700	</method>
3701
3702	<method name="addDescription">
3703	<desc>
3704	This method adds an additional description entry to the stack of already
3705	available descriptions for this virtual system. This is handy for writing
3706	values which aren't directly supported by VirtualBox. One example would
3707	be the License type of <link to="VirtualSystemDescriptionType" />.
3708	</desc>
3709
3710	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3711	<desc></desc>
3712	</param>
3713
3714	<param name="aVBoxValue" type="wstring" dir="in">
3715	<desc></desc>
3716	</param>
3717
3718	<param name="aExtraConfigValue" type="wstring" dir="in">
3719	<desc></desc>
3720	</param>
3721	</method>
3722	</interface>
3723
3724
3725	<!--
3726	// IMachine
3727	/////////////////////////////////////////////////////////////////////////
3728	-->
3729
3730	<interface
3731	name="IInternalMachineControl" extends="$unknown"
3732	uuid="35d8d838-d066-447d-927a-fd93afdbec90"
3733	internal="yes"
3734	wsmap="suppress"
3735	>
3736	<method name="setRemoveSavedState">
3737	<desc>
3738	Updates the flag whether saved state is removed on a machine state
3739	change from Saved to PoweredOff.
3740	</desc>
3741	<param name="aRemove" type="boolean" dir="in"/>
3742	</method>
3743
3744	<method name="updateState">
3745	<desc>
3746	Updates the VM state.
3747	<note>
3748	This operation will also update the settings file with
3749	the correct information about the saved state file
3750	and delete this file from disk when appropriate.
3751	</note>
3752	</desc>
3753	<param name="state" type="MachineState" dir="in"/>
3754	</method>
3755
3756	<method name="getIPCId">
3757	<param name="id" type="wstring" dir="return"/>
3758	</method>
3759
3760	<method name="runUSBDeviceFilters">
3761	<desc>
3762	Asks the server to run USB devices filters of the associated
3763	machine against the given USB device and tell if there is
3764	a match.
3765	<note>
3766	Intended to be used only for remote USB devices. Local
3767	ones don't require to call this method (this is done
3768	implicitly by the Host and USBProxyService).
3769	</note>
3770	</desc>
3771	<param name="device" type="IUSBDevice" dir="in"/>
3772	<param name="matched" type="boolean" dir="out"/>
3773	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3774	</method>
3775
3776	<method name="captureUSBDevice">
3777	<desc>
3778	Requests a capture of the given host USB device.
3779	When the request is completed, the VM process will
3780	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3781	notification.
3782	</desc>
3783	<param name="id" type="uuid" mod="string" dir="in"/>
3784	</method>
3785
3786	<method name="detachUSBDevice">
3787	<desc>
3788	Notification that a VM is going to detach (@a done = @c false) or has
3789	already detached (@a done = @c true) the given USB device.
3790	When the @a done = @c true request is completed, the VM process will
3791	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3792	notification.
3793	<note>
3794	In the @a done = @c true case, the server must run its own filters
3795	and filters of all VMs but this one on the detached device
3796	as if it were just attached to the host computer.
3797	</note>
3798	</desc>
3799	<param name="id" type="uuid" mod="string" dir="in"/>
3800	<param name="done" type="boolean" dir="in"/>
3801	</method>
3802
3803	<method name="autoCaptureUSBDevices">
3804	<desc>
3805	Requests a capture all matching USB devices attached to the host.
3806	When the request is completed, the VM process will
3807	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3808	notification per every captured device.
3809	</desc>
3810	</method>
3811
3812	<method name="detachAllUSBDevices">
3813	<desc>
3814	Notification that a VM that is being powered down. The done
3815	parameter indicates whether which stage of the power down
3816	we're at. When @a done = @c false the VM is announcing its
3817	intentions, while when @a done = @c true the VM is reporting
3818	what it has done.
3819	<note>
3820	In the @a done = @c true case, the server must run its own filters
3821	and filters of all VMs but this one on all detach devices as
3822	if they were just attached to the host computer.
3823	</note>
3824	</desc>
3825	<param name="done" type="boolean" dir="in"/>
3826	</method>
3827
3828	<method name="onSessionEnd">
3829	<desc>
3830	Triggered by the given session object when the session is about
3831	to close normally.
3832	</desc>
3833	<param name="session" type="ISession" dir="in">
3834	<desc>Session that is being closed</desc>
3835	</param>
3836	<param name="progress" type="IProgress" dir="return">
3837	<desc>
3838	Used to wait until the corresponding machine is actually
3839	dissociated from the given session on the server.
3840	Returned only when this session is a direct one.
3841	</desc>
3842	</param>
3843	</method>
3844
3845	<method name="beginSavingState">
3846	<desc>
3847	Called by the VM process to inform the server it wants to
3848	save the current state and stop the VM execution.
3849	</desc>
3850	<param name="progress" type="IProgress" dir="in">
3851	<desc>
3852	Progress object created by the VM process to wait until
3853	the state is saved.
3854	</desc>
3855	</param>
3856	<param name="stateFilePath" type="wstring" dir="out">
3857	<desc>
3858	File path the VM process must save the execution state to.
3859	</desc>
3860	</param>
3861	</method>
3862
3863	<method name="endSavingState">
3864	<desc>
3865	Called by the VM process to inform the server that saving
3866	the state previously requested by #beginSavingState is either
3867	successfully finished or there was a failure.
3868
3869	<result name="VBOX_E_FILE_ERROR">
3870	Settings file not accessible.
3871	</result>
3872	<result name="VBOX_E_XML_ERROR">
3873	Could not parse the settings file.
3874	</result>
3875
3876	</desc>
3877
3878	<param name="success" type="boolean" dir="in">
3879	<desc>@c true to indicate success and @c false otherwise.
3880	</desc>
3881	</param>
3882	</method>
3883
3884	<method name="adoptSavedState">
3885	<desc>
3886	Gets called by IConsole::adoptSavedState.
3887	<result name="VBOX_E_FILE_ERROR">
3888	Invalid saved state file path.
3889	</result>
3890	</desc>
3891	<param name="savedStateFile" type="wstring" dir="in">
3892	<desc>Path to the saved state file to adopt.</desc>
3893	</param>
3894	</method>
3895
3896	<method name="beginTakingSnapshot">
3897	<desc>
3898	Called from the VM process to request from the server to perform the
3899	server-side actions of creating a snapshot (creating differencing images
3900	and the snapshot object).
3901
3902	<result name="VBOX_E_FILE_ERROR">
3903	Settings file not accessible.
3904	</result>
3905	<result name="VBOX_E_XML_ERROR">
3906	Could not parse the settings file.
3907	</result>
3908	</desc>
3909	<param name="initiator" type="IConsole" dir="in">
3910	<desc>The console object that initiated this call.</desc>
3911	</param>
3912	<param name="name" type="wstring" dir="in">
3913	<desc>Snapshot name.</desc>
3914	</param>
3915	<param name="description" type="wstring" dir="in">
3916	<desc>Snapshot description.</desc>
3917	</param>
3918	<param name="consoleProgress" type="IProgress" dir="in">
3919	<desc>
3920	Progress object created by the VM process tracking the
3921	snapshot's progress. This has the following sub-operations:
3922	<ul>
3923	<li>setting up (weight 1);</li>
3924	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3925	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3926	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3927	<li>finishing up (weight 1)</li>
3928	</ul>
3929	</desc>
3930	</param>
3931	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3932	<desc>
3933	Whether this is an online snapshot (i.e. the machine is running).
3934	</desc>
3935	</param>
3936	<param name="stateFilePath" type="wstring" dir="out">
3937	<desc>
3938	File path the VM process must save the execution state to.
3939	</desc>
3940	</param>
3941	</method>
3942
3943	<method name="endTakingSnapshot">
3944	<desc>
3945	Called by the VM process to inform the server that the snapshot
3946	previously requested by #beginTakingSnapshot is either
3947	successfully taken or there was a failure.
3948	</desc>
3949
3950	<param name="success" type="boolean" dir="in">
3951	<desc>@c true to indicate success and @c false otherwise</desc>
3952	</param>
3953	</method>
3954
3955	<method name="deleteSnapshot">
3956	<desc>
3957	Gets called by IConsole::deleteSnapshot.
3958	<result name="VBOX_E_INVALID_OBJECT_STATE">
3959	Snapshot has more than one child snapshot.
3960	</result>
3961	</desc>
3962	<param name="initiator" type="IConsole" dir="in">
3963	<desc>The console object that initiated this call.</desc>
3964	</param>
3965	<param name="id" type="uuid" mod="string" dir="in">
3966	<desc>UUID of the snapshot to discard.</desc>
3967	</param>
3968	<param name="machineState" type="MachineState" dir="out">
3969	<desc>New machine state after this operation is started.</desc>
3970	</param>
3971	<param name="progress" type="IProgress" dir="return">
3972	<desc>Progress object to track the operation completion.</desc>
3973	</param>
3974	</method>
3975
3976	<method name="restoreSnapshot">
3977	<desc>
3978	Gets called by IConsole::RestoreSnapshot.
3979	</desc>
3980	<param name="initiator" type="IConsole" dir="in">
3981	<desc>The console object that initiated this call.</desc>
3982	</param>
3983	<param name="snapshot" type="ISnapshot" dir="in">
3984	<desc>The snapshot to restore the VM state from.</desc>
3985	</param>
3986	<param name="machineState" type="MachineState" dir="out">
3987	<desc>New machine state after this operation is started.</desc>
3988	</param>
3989	<param name="progress" type="IProgress" dir="return">
3990	<desc>Progress object to track the operation completion.</desc>
3991	</param>
3992	</method>
3993
3994	<method name="pullGuestProperties">
3995	<desc>
3996	Get the list of the guest properties matching a set of patterns along
3997	with their values, time stamps and flags and give responsibility for
3998	managing properties to the console.
3999	</desc>
4000	<param name="name" type="wstring" dir="out" safearray="yes">
4001	<desc>
4002	The names of the properties returned.
4003	</desc>
4004	</param>
4005	<param name="value" type="wstring" dir="out" safearray="yes">
4006	<desc>
4007	The values of the properties returned. The array entries match the
4008	corresponding entries in the @a name array.
4009	</desc>
4010	</param>
4011	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4012	<desc>
4013	The time stamps of the properties returned. The array entries match
4014	the corresponding entries in the @a name array.
4015	</desc>
4016	</param>
4017	<param name="flags" type="wstring" dir="out" safearray="yes">
4018	<desc>
4019	The flags of the properties returned. The array entries match the
4020	corresponding entries in the @a name array.
4021	</desc>
4022	</param>
4023	</method>
4024
4025	<method name="pushGuestProperties">
4026	<desc>
4027	Set the list of the guest properties matching a set of patterns along
4028	with their values, time stamps and flags and return responsibility for
4029	managing properties to IMachine.
4030	</desc>
4031	<param name="name" type="wstring" dir="in" safearray="yes">
4032	<desc>
4033	The names of the properties.
4034	</desc>
4035	</param>
4036	<param name="value" type="wstring" dir="in" safearray="yes">
4037	<desc>
4038	The values of the properties. The array entries match the
4039	corresponding entries in the @a name array.
4040	</desc>
4041	</param>
4042	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
4043	<desc>
4044	The time stamps of the properties. The array entries match
4045	the corresponding entries in the @a name array.
4046	</desc>
4047	</param>
4048	<param name="flags" type="wstring" dir="in" safearray="yes">
4049	<desc>
4050	The flags of the properties. The array entries match the
4051	corresponding entries in the @a name array.
4052	</desc>
4053	</param>
4054	</method>
4055	<method name="pushGuestProperty">
4056	<desc>
4057	Update a single guest property in IMachine.
4058	</desc>
4059	<param name="name" type="wstring" dir="in">
4060	<desc>
4061	The name of the property to be updated.
4062	</desc>
4063	</param>
4064	<param name="value" type="wstring" dir="in">
4065	<desc>
4066	The value of the property.
4067	</desc>
4068	</param>
4069	<param name="timestamp" type="unsigned long long" dir="in">
4070	<desc>
4071	The timestamp of the property.
4072	</desc>
4073	</param>
4074	<param name="flags" type="wstring" dir="in">
4075	<desc>
4076	The flags of the property.
4077	</desc>
4078	</param>
4079	</method>
4080
4081	<method name="lockMedia">
4082	<desc>
4083	Locks all media attached to the machine for writing and parents of
4084	attached differencing media (if any) for reading. This operation is
4085	atomic so that if it fails no media is actually locked.
4086
4087	This method is intended to be called when the machine is in Starting or
4088	Restoring state. The locked media will be automatically unlocked when
4089	the machine is powered off or crashed.
4090	</desc>
4091	</method>
4092	<method name="unlockMedia">
4093	<desc>
4094	Unlocks all media previously locked using
4095	<link to="IInternalMachineControl::lockMedia"/>.
4096
4097	This method is intended to be used with teleportation so that it is
4098	possible to teleport between processes on the same machine.
4099	</desc>
4100	</method>
4101	</interface>
4102
4103	<interface
4104	name="IBIOSSettings" extends="$unknown"
4105	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4106	wsmap="managed"
4107	>
4108	<desc>
4109	The IBIOSSettings interface represents BIOS settings of the virtual
4110	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4111	</desc>
4112	<attribute name="logoFadeIn" type="boolean">
4113	<desc>Fade in flag for BIOS logo animation.</desc>
4114	</attribute>
4115
4116	<attribute name="logoFadeOut" type="boolean">
4117	<desc>Fade out flag for BIOS logo animation.</desc>
4118	</attribute>
4119
4120	<attribute name="logoDisplayTime" type="unsigned long">
4121	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4122	</attribute>
4123
4124	<attribute name="logoImagePath" type="wstring">
4125	<desc>
4126	Local file system path for external BIOS splash image. Empty string
4127	means the default image is shown on boot.
4128	</desc>
4129	</attribute>
4130
4131	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4132	<desc>Mode of the BIOS boot device menu.</desc>
4133	</attribute>
4134
4135	<attribute name="ACPIEnabled" type="boolean">
4136	<desc>ACPI support flag.</desc>
4137	</attribute>
4138
4139	<attribute name="IOAPICEnabled" type="boolean">
4140	<desc>
4141	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4142	and support IRQs above 15.
4143	</desc>
4144	</attribute>
4145
4146	<attribute name="timeOffset" type="long long">
4147	<desc>
4148	Offset in milliseconds from the host system time. This allows for
4149	guests running with a different system date/time than the host.
4150	It is equivalent to setting the system date/time in the BIOS except
4151	it is not an absolute value but a relative one. Guest Additions
4152	time synchronization honors this offset.
4153	</desc>
4154	</attribute>
4155
4156	<attribute name="PXEDebugEnabled" type="boolean">
4157	<desc>
4158	PXE debug logging flag. If set, VirtualBox will write extensive
4159	PXE trace information to the release log.
4160	</desc>
4161	</attribute>
4162
4163	</interface>
4164
4165	<interface
4166	name="IMachine" extends="$unknown"
4167	uuid="6d7f40fa-77be-4366-a053-f58e81453a6a"
4168	wsmap="managed"
4169	>
4170	<desc>
4171	The IMachine interface represents a virtual machine, or guest, created
4172	in VirtualBox.
4173
4174	This interface is used in two contexts. First of all, a collection of
4175	objects implementing this interface is stored in the
4176	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4177	machines that are currently registered with this VirtualBox
4178	installation. Also, once a session has been opened for the given virtual
4179	machine (e.g. the virtual machine is running), the machine object
4180	associated with the open session can be queried from the session object;
4181	see <link to="ISession"/> for details.
4182
4183	The main role of this interface is to expose the settings of the virtual
4184	machine and provide methods to change various aspects of the virtual
4185	machine's configuration. For machine objects stored in the
4186	<link to="IVirtualBox::machines"/> collection, all attributes are
4187	read-only unless explicitly stated otherwise in individual attribute
4188	and method descriptions. In order to change a machine setting, a session
4189	for this machine must be opened using one of
4190	<link to="IVirtualBox::openSession"/>,
4191	<link to="IVirtualBox::openRemoteSession"/> or
4192	<link to="IVirtualBox::openExistingSession"/> methods. After the
4193	session has been successfully opened, a mutable machine object needs to
4194	be queried from the session object and then the desired settings changes
4195	can be applied to the returned object using IMachine attributes and
4196	methods. See the <link to="ISession"/> interface description for more
4197	information about sessions.
4198
4199	Note that IMachine does not provide methods to control virtual machine
4200	execution (such as start the machine, or power it down) -- these methods
4201	are grouped in a separate interface called <link to="IConsole" />.
4202
4203	<see>ISession, IConsole</see>
4204	</desc>
4205
4206	<attribute name="parent" type="IVirtualBox" readonly="yes">
4207	<desc>Associated parent object.</desc>
4208	</attribute>
4209
4210	<attribute name="accessible" type="boolean" readonly="yes">
4211	<desc>
4212	Whether this virtual machine is currently accessible or not.
4213
4214	A machine is always deemed accessible unless it is registered <i>and</i>
4215	its settings file cannot be read or parsed (either because the file itself
4216	is unavailable or has invalid XML contents).
4217
4218	Every time this property is read, the accessibility state of
4219	this machine is re-evaluated. If the returned value is @c false,
4220	the <link to="#accessError"/> property may be used to get the
4221	detailed error information describing the reason of
4222	inaccessibility, including XML error messages.
4223
4224	When the machine is inaccessible, only the following properties
4225	can be used on it:
4226	<ul>
4227	<li><link to="#parent"/></li>
4228	<li><link to="#id"/></li>
4229	<li><link to="#settingsFilePath"/></li>
4230	<li><link to="#accessible"/></li>
4231	<li><link to="#accessError"/></li>
4232	</ul>
4233
4234	An attempt to access any other property or method will return
4235	an error.
4236
4237	The only possible action you can perform on an inaccessible
4238	machine is to unregister it using the
4239	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4240	for the accessibility state once more by querying this
4241	property).
4242
4243	<note>
4244	In the current implementation, once this property returns
4245	@c true, the machine will never become inaccessible
4246	later, even if its settings file cannot be successfully
4247	read/written any more (at least, until the VirtualBox
4248	server is restarted). This limitation may be removed in
4249	future releases.
4250	</note>
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4255	<desc>
4256	Error information describing the reason of machine
4257	inaccessibility.
4258
4259	Reading this property is only valid after the last call to
4260	<link to="#accessible"/> returned @c false (i.e. the
4261	machine is currently unaccessible). Otherwise, a @c null
4262	IVirtualBoxErrorInfo object will be returned.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="name" type="wstring">
4267	<desc>
4268	Name of the virtual machine.
4269
4270	Besides being used for human-readable identification purposes
4271	everywhere in VirtualBox, the virtual machine name is also used
4272	as a name of the machine's settings file and as a name of the
4273	subdirectory this settings file resides in. Thus, every time you
4274	change the value of this property, the settings file will be
4275	renamed once you call <link to="#saveSettings"/> to confirm the
4276	change. The containing subdirectory will be also renamed, but
4277	only if it has exactly the same name as the settings file
4278	itself prior to changing this property (for backward compatibility
4279	with previous API releases). The above implies the following
4280	limitations:
4281	<ul>
4282	<li>The machine name cannot be empty.</li>
4283	<li>The machine name can contain only characters that are valid
4284	file name characters according to the rules of the file
4285	system used to store VirtualBox configuration.</li>
4286	<li>You cannot have two or more machines with the same name
4287	if they use the same subdirectory for storing the machine
4288	settings files.</li>
4289	<li>You cannot change the name of the machine if it is running,
4290	or if any file in the directory containing the settings file
4291	is being used by another running machine or by any other
4292	process in the host operating system at a time when
4293	<link to="#saveSettings"/> is called.
4294	</li>
4295	</ul>
4296	If any of the above limitations are hit, <link to="#saveSettings"/>
4297	will return an appropriate error message explaining the exact
4298	reason and the changes you made to this machine will not be
4299	saved.
4300	<note>
4301	For "legacy" machines created using the
4302	<link to="IVirtualBox::createLegacyMachine"/> call,
4303	the above naming limitations do not apply because the
4304	machine name does not affect the settings file name.
4305	The settings file name remains the same as it was specified
4306	during machine creation and never changes.
4307	</note>
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="description" type="wstring">
4312	<desc>
4313	Description of the virtual machine.
4314
4315	The description attribute can contain any text and is
4316	typically used to describe the hardware and software
4317	configuration of the virtual machine in detail (i.e. network
4318	settings, versions of the installed software and so on).
4319	</desc>
4320	</attribute>
4321
4322	<attribute name="id" type="uuid" mod="string" readonly="yes">
4323	<desc>UUID of the virtual machine.</desc>
4324	</attribute>
4325
4326	<attribute name="OSTypeId" type="wstring">
4327	<desc>
4328	User-defined identifier of the Guest OS type.
4329	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4330	an IGuestOSType object representing details about the given
4331	Guest OS type.
4332	<note>
4333	This value may differ from the value returned by
4334	<link to="IGuest::OSTypeId"/> if Guest Additions are
4335	installed to the guest OS.
4336	</note>
4337	</desc>
4338	</attribute>
4339
4340	<attribute name="HardwareVersion" type="wstring">
4341	<desc>Hardware version identifier. Internal use only for now.</desc>
4342	</attribute>
4343
4344	<attribute name="hardwareUUID" type="uuid" mod="string">
4345	<desc>
4346	The UUID presented to the guest via memory tables, hardware and guest
4347	properties. For most VMs this is the same as the @a id, but for VMs
4348	which have been cloned or teleported it may be the same as the source
4349	VM. This latter is because the guest shouldn't notice that it was
4350	cloned or teleported.
4351	</desc>
4352	</attribute>
4353
4354	<attribute name="CPUCount" type="unsigned long">
4355	<desc>Number of virtual CPUs in the VM.</desc>
4356	</attribute>
4357
4358	<attribute name="memorySize" type="unsigned long">
4359	<desc>System memory size in megabytes.</desc>
4360	</attribute>
4361
4362	<attribute name="memoryBalloonSize" type="unsigned long">
4363	<desc>Initial memory balloon size in megabytes.</desc>
4364	</attribute>
4365
4366	<attribute name="statisticsUpdateInterval" type="unsigned long">
4367	<desc>Initial interval to update guest statistics in seconds.</desc>
4368	</attribute>
4369
4370	<attribute name="VRAMSize" type="unsigned long">
4371	<desc>Video memory size in megabytes.</desc>
4372	</attribute>
4373
4374	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4375	<desc>
4376	This setting determines whether VirtualBox allows this machine to make
4377	use of the 3D graphics support available on the host.</desc>
4378	</attribute>
4379
4380	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4381	<desc>
4382	This setting determines whether VirtualBox allows this machine to make
4383	use of the 2D video acceleration support available on the host.</desc>
4384	</attribute>
4385
4386	<attribute name="monitorCount" type="unsigned long">
4387	<desc>
4388	Number of virtual monitors.
4389	<note>
4390	Only effective on Windows XP and later guests with
4391	Guest Additions installed.
4392	</note>
4393	</desc>
4394	</attribute>
4395
4396	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4397	<desc>Object containing all BIOS settings.</desc>
4398	</attribute>
4399
4400	<attribute name="firmwareType" type="FirmwareType">
4401	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4402	bootstrap in this VM.</desc>
4403	</attribute>
4404
4405	<attribute name="snapshotFolder" type="wstring">
4406	<desc>
4407	Full path to the directory used to store snapshot data
4408	(differencing media and saved state files) of this machine.
4409
4410	The initial value of this property is
4411	<tt><</tt><link to="#settingsFilePath">
4412	path_to_settings_file</link><tt>>/<</tt>
4413	<link to="#id">machine_uuid</link>
4414	<tt>></tt>.
4415
4416	Currently, it is an error to try to change this property on
4417	a machine that has snapshots (because this would require to
4418	move possibly large files to a different location).
4419	A separate method will be available for this purpose later.
4420
4421	<note>
4422	Setting this property to @c null or to an empty string will restore
4423	the initial value.
4424	</note>
4425	<note>
4426	When setting this property, the specified path can be
4427	absolute (full path) or relative to the directory where the
4428	<link to="#settingsFilePath">machine settings file</link>
4429	is located. When reading this property, a full path is
4430	always returned.
4431	</note>
4432	<note>
4433	The specified path may not exist, it will be created
4434	when necessary.
4435	</note>
4436	</desc>
4437	</attribute>
4438
4439	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4440	<desc>VRDP server object.</desc>
4441	</attribute>
4442
4443	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4444	<desc>Array of media attached to this machine.</desc>
4445	</attribute>
4446
4447	<attribute name="USBController" type="IUSBController" readonly="yes">
4448	<desc>
4449	Associated USB controller object.
4450
4451	<note>
4452	If USB functionality is not available in the given edition of
4453	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4454	</note>
4455	</desc>
4456	</attribute>
4457
4458	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4459	<desc>Associated audio adapter, always present.</desc>
4460	</attribute>
4461
4462	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4463	<desc>Array of storage controllers attached to this machine.</desc>
4464	</attribute>
4465
4466	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4467	<desc>
4468	Full name of the file containing machine settings data.
4469	</desc>
4470	</attribute>
4471
4472	<attribute name="settingsModified" type="boolean" readonly="yes">
4473	<desc>
4474	Whether the settings of this machine have been modified
4475	(but neither yet saved nor discarded).
4476	<note>
4477	Reading this property is only valid on instances returned
4478	by <link to="ISession::machine"/> and on new machines
4479	created by <link to="IVirtualBox::createMachine"/> or opened
4480	by <link to="IVirtualBox::openMachine"/> but not
4481	yet registered, or on unregistered machines after calling
4482	<link to="IVirtualBox::unregisterMachine"/>. For all other
4483	cases, the settings can never be modified.
4484	</note>
4485	<note>
4486	For newly created unregistered machines, the value of this
4487	property is always @c true until <link to="#saveSettings"/>
4488	is called (no matter if any machine settings have been
4489	changed after the creation or not). For opened machines
4490	the value is set to @c false (and then follows to normal rules).
4491	</note>
4492	</desc>
4493	</attribute>
4494
4495	<attribute name="sessionState" type="SessionState" readonly="yes">
4496	<desc>Current session state for this machine.</desc>
4497	</attribute>
4498
4499	<attribute name="sessionType" type="wstring" readonly="yes">
4500	<desc>
4501	Type of the session. If <link to="#sessionState"/> is
4502	SessionSpawning or SessionOpen, this attribute contains the
4503	same value as passed to the
4504	<link to="IVirtualBox::openRemoteSession"/> method in the
4505	@a type parameter. If the session was opened directly using
4506	<link to="IVirtualBox::openSession"/>, or if
4507	<link to="#sessionState"/> is SessionClosed, the value of this
4508	attribute is an empty string.
4509	</desc>
4510	</attribute>
4511
4512	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4513	<desc>
4514	Identifier of the session process. This attribute contains the
4515	platform-dependent identifier of the process that has opened a
4516	direct session for this machine using the
4517	<link to="IVirtualBox::openSession"/> call. The returned value
4518	is only valid if <link to="#sessionState"/> is SessionOpen or
4519	SessionClosing (i.e. a session is currently open or being
4520	closed) by the time this property is read.
4521	</desc>
4522	</attribute>
4523
4524	<attribute name="state" type="MachineState" readonly="yes">
4525	<desc>Current execution state of this machine.</desc>
4526	</attribute>
4527
4528	<attribute name="lastStateChange" type="long long" readonly="yes">
4529	<desc>
4530	Time stamp of the last execution state change,
4531	in milliseconds since 1970-01-01 UTC.
4532	</desc>
4533	</attribute>
4534
4535	<attribute name="stateFilePath" type="wstring" readonly="yes">
4536	<desc>
4537	Full path to the file that stores the execution state of
4538	the machine when it is in the <link to="MachineState_Saved"/> state.
4539	<note>
4540	When the machine is not in the Saved state, this attribute is
4541	an empty string.
4542	</note>
4543	</desc>
4544	</attribute>
4545
4546	<attribute name="logFolder" type="wstring" readonly="yes">
4547	<desc>
4548	Full path to the folder that stores a set of rotated log files
4549	recorded during machine execution. The most recent log file is
4550	named <tt>VBox.log</tt>, the previous log file is
4551	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4552	in the current version).
4553	</desc>
4554	</attribute>
4555
4556	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4557	<desc>
4558	Current snapshot of this machine. This is @c null if the machine
4559	currently has no snapshots. If it is not @c null, then it was
4560	set by one of <link to="Console::takeSnapshot" />,
4561	<link to="Console::deleteSnapshot" />
4562	or <link to="Console::restoreSnapshot" />, depending on which
4563	was called last. See <link to="ISnapshot"/> for details.
4564	</desc>
4565	</attribute>
4566
4567	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4568	<desc>
4569	Number of snapshots taken on this machine. Zero means the
4570	machine doesn't have any snapshots.
4571	</desc>
4572	</attribute>
4573
4574	<attribute name="currentStateModified" type="boolean" readonly="yes">
4575	<desc>
4576	Returns @c true if the current state of the machine is not
4577	identical to the state stored in the current snapshot.
4578
4579	The current state is identical to the current snapshot only
4580	directly after one of the following calls are made:
4581
4582	<ul>
4583	<li><link to="IConsole::restoreSnapshot"/>
4584	</li>
4585	<li><link to="IConsole::takeSnapshot"/> (issued on a
4586	"powered off" or "saved" machine, for which
4587	<link to="#settingsModified"/> returns @c false)
4588	</li>
4589	<li><link to="IMachine::setCurrentSnapshot"/>
4590	</li>
4591	</ul>
4592
4593	The current state remains identical until one of the following
4594	happens:
4595	<ul>
4596	<li>settings of the machine are changed</li>
4597	<li>the saved state is discarded</li>
4598	<li>the current snapshot is discarded</li>
4599	<li>an attempt to execute the machine is made</li>
4600	</ul>
4601
4602	<note>
4603	For machines that don't have snapshots, this property is
4604	always @c false.
4605	</note>
4606	</desc>
4607	</attribute>
4608
4609	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4610	<desc>
4611	Collection of shared folders for this machine (permanent shared
4612	folders). These folders are shared automatically at machine startup
4613	and available only to the guest OS installed within this machine.
4614
4615	New shared folders are added to the collection using
4616	<link to="#createSharedFolder"/>. Existing shared folders can be
4617	removed using <link to="#removeSharedFolder"/>.
4618	</desc>
4619	</attribute>
4620
4621	<attribute name="clipboardMode" type="ClipboardMode">
4622	<desc>
4623	Synchronization mode between the host OS clipboard
4624	and the guest OS clipboard.
4625	</desc>
4626	</attribute>
4627
4628	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4629	<desc>
4630	A comma-separated list of simple glob patterns. Changes to guest
4631	properties whose name matches one of the patterns will generate an
4632	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4633	</desc>
4634	</attribute>
4635
4636	<attribute name="teleporterEnabled" type="boolean">
4637	<desc>
4638	When set to @a true, the virtual machine becomes a target teleporter
4639	the next time it is powered on. This can only set to @a true when the
4640	VM is in the @a PoweredOff or @a Aborted state.
4641
4642	<!-- This property is automatically set to @a false when the VM is powered
4643	on. (bird: This doesn't work yet ) -->
4644	</desc>
4645	</attribute>
4646
4647	<attribute name="teleporterPort" type="unsigned long">
4648	<desc>
4649	The TCP port the target teleporter will listen for incoming
4650	teleportations on.
4651
4652	0 means the port is automatically selected upon power on. The actual
4653	value can be read from this property while the machine is waiting for
4654	incoming teleportations.
4655	</desc>
4656	</attribute>
4657
4658	<attribute name="teleporterAddress" type="wstring">
4659	<desc>
4660	The address the target teleporter will listen on. If set to an empty
4661	string, it will listen on all addresses.
4662	</desc>
4663	</attribute>
4664
4665	<attribute name="teleporterPassword" type="wstring">
4666	<desc>
4667	The password the to check for on the target teleporter. This is just a
4668	very basic measure to prevent simple hacks and operators accidentally
4669	beaming a virtual machine to the wrong place.
4670	</desc>
4671	</attribute>
4672
4673	<attribute name="RTCUseUTC" type="boolean">
4674	<desc>
4675	When set to @a true, the RTC device of the virtual machine will run
4676	in UTC time, otherwise in local time. Especially Unix guests prefer
4677	the time in UTC.
4678	</desc>
4679	</attribute>
4680
4681	<method name="setBootOrder">
4682	<desc>
4683	Puts the given device to the specified position in
4684	the boot order.
4685
4686	To indicate that no device is associated with the given position,
4687	<link to="DeviceType_Null"/> should be used.
4688
4689	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4690
4691	<result name="E_INVALIDARG">
4692	Boot @a position out of range.
4693	</result>
4694	<result name="E_NOTIMPL">
4695	Booting from USB @a device currently not supported.
4696	</result>
4697
4698	</desc>
4699	<param name="position" type="unsigned long" dir="in">
4700	<desc>
4701	Position in the boot order (@c 1 to the total number of
4702	devices the machine can boot from, as returned by
4703	<link to="ISystemProperties::maxBootPosition"/>).
4704	</desc>
4705	</param>
4706	<param name="device" type="DeviceType" dir="in">
4707	<desc>
4708	The type of the device used to boot at the given position.
4709	</desc>
4710	</param>
4711	</method>
4712
4713	<method name="getBootOrder" const="yes">
4714	<desc>
4715	Returns the device type that occupies the specified
4716	position in the boot order.
4717
4718	@todo [remove?]
4719	If the machine can have more than one device of the returned type
4720	(such as hard disks), then a separate method should be used to
4721	retrieve the individual device that occupies the given position.
4722
4723	If here are no devices at the given position, then
4724	<link to="DeviceType_Null"/> is returned.
4725
4726	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4727
4728	<result name="E_INVALIDARG">
4729	Boot @a position out of range.
4730	</result>
4731
4732	</desc>
4733	<param name="position" type="unsigned long" dir="in">
4734	<desc>
4735	Position in the boot order (@c 1 to the total number of
4736	devices the machine can boot from, as returned by
4737	<link to="ISystemProperties::maxBootPosition"/>).
4738	</desc>
4739	</param>
4740	<param name="device" type="DeviceType" dir="return">
4741	<desc>
4742	Device at the given position.
4743	</desc>
4744	</param>
4745	</method>
4746
4747	<method name="attachDevice">
4748	<desc>
4749	Attaches a device and optionally mounts a medium to the given storage
4750	controller (<link to="IStorageController" />, identified by @a name),
4751	at the indicated port and device.
4752
4753	This method is intended for managing storage devices in general (it works
4754	for both fixed and removable media). For storage devices supporting removable
4755	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4756	for changing the media while the machine is running.
4757
4758	For the IDE bus, the @a controllerPort parameter can be either
4759	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4760	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4761	to specify the master or the slave device, respectively. (In the
4762	default configuration of virtual machines, the secondary master is
4763	used for a CD/DVD drive.)
4764
4765	For an SATA controller, @a controllerPort must be a number ranging
4766	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4767	be a number ranging from @c 0 to @c 15.
4768
4769	For both SCSI and SATA, the @a device parameter is unused and must
4770	be @c 0.
4771
4772	For fixed media such as hard disks, the given medium identifier cannot
4773	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4774	and floppies.
4775
4776	After calling this returns successfully, a new instance of
4777	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4778	attachments (<link to="IMachine::mediumAttachments"/>).
4779
4780	The specified device slot must not have a device attached to it,
4781	or this method will fail.
4782
4783	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4784	information about attaching media.
4785
4786	<note>
4787	You cannot attach a device to a running machine. Also, you cannot
4788	attach a device to a newly created machine until this machine's
4789	settings are saved to disk using <link to="#saveSettings"/>.
4790	</note>
4791	<note>
4792	If the medium is being attached indirectly, a new differencing medium
4793	will implicitly be created for it and attached instead. If the
4794	changes made to the machine settings (including this indirect
4795	attachment) are later cancelled using <link to="#discardSettings"/>,
4796	this implicitly created differencing medium will implicitly
4797	be deleted.
4798	</note>
4799
4800	<result name="E_INVALIDARG">
4801	SATA device, SATA port, IDE port or IDE slot out of range.
4802	</result>
4803	<result name="VBOX_E_INVALID_OBJECT_STATE">
4804	Attempt to attach medium to an unregistered virtual machine.
4805	</result>
4806	<result name="VBOX_E_INVALID_VM_STATE">
4807	Invalid machine state.
4808	</result>
4809	<result name="VBOX_E_OBJECT_IN_USE">
4810	Hard disk already attached to this or another virtual machine.
4811	</result>
4812
4813	</desc>
4814	<param name="name" type="wstring" dir="in">
4815	<desc>Name of the storage controller to attach the device to.</desc>
4816	</param>
4817	<param name="controllerPort" type="long" dir="in">
4818	<desc>Port to attach the device to.</desc>
4819	</param>
4820	<param name="device" type="long" dir="in">
4821	<desc>Device slot in the given port to attach the device to.</desc>
4822	</param>
4823	<param name="type" type="DeviceType" dir="in">
4824	<desc>Device type of the attached device.</desc>
4825	</param>
4826	<param name="id" type="uuid" mod="string" dir="in">
4827	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4828	medium.</desc>
4829	</param>
4830	</method>
4831
4832	<method name="detachDevice">
4833	<desc>
4834	Detaches the device attached to a device slot of the specified bus.
4835
4836	Detaching the device from the virtual machine is deferred. This means
4837	that the medium remains associated with the machine when this method
4838	returns and gets actually de-associated only after a successful
4839	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4840	for more detailed information about attaching media.
4841
4842	<note>
4843	You cannot detach a device from a running machine.
4844	</note>
4845	<note>
4846	Detaching differencing media implicitly created by <link
4847	to="#attachDevice"/> for the indirect attachment using this
4848	method will <b>not</b> implicitly delete them. The
4849	<link to="IMedium::deleteStorage"/> operation should be
4850	explicitly performed by the caller after the medium is successfully
4851	detached and the settings are saved with
4852	<link to="#saveSettings"/>, if it is the desired action.
4853	</note>
4854
4855	<result name="VBOX_E_INVALID_VM_STATE">
4856	Attempt to detach medium from a running virtual machine.
4857	</result>
4858	<result name="VBOX_E_OBJECT_NOT_FOUND">
4859	No medium attached to given slot/bus.
4860	</result>
4861	<result name="VBOX_E_NOT_SUPPORTED">
4862	Medium format does not support storage deletion.
4863	</result>
4864
4865	</desc>
4866	<param name="name" type="wstring" dir="in">
4867	<desc>Name of the storage controller to detach the medium from.</desc>
4868	</param>
4869	<param name="controllerPort" type="long" dir="in">
4870	<desc>Port number to detach the medium from.</desc>
4871	</param>
4872	<param name="device" type="long" dir="in">
4873	<desc>Device slot number to detach the medium from.</desc>
4874	</param>
4875	</method>
4876
4877	<method name="passthroughDevice">
4878	<desc>
4879	Sets the passthrough mode of an existing DVD device. Changing the
4880	setting while the VM is running is forbidden. The setting is only used
4881	if at VM start the device is configured as a host DVD drive, in all
4882	other cases it is ignored. The device must already exist; see
4883	<link to="IMachine::attachDevice"/> for how to attach a new device.
4884
4885	The @a controllerPort and @a device parameters specify the device slot and
4886	have have the same meaning as with <link to="IMachine::attachDevice" />.
4887
4888	<result name="E_INVALIDARG">
4889	SATA device, SATA port, IDE port or IDE slot out of range.
4890	</result>
4891	<result name="VBOX_E_INVALID_OBJECT_STATE">
4892	Attempt to modify an unregistered virtual machine.
4893	</result>
4894	<result name="VBOX_E_INVALID_VM_STATE">
4895	Invalid machine state.
4896	</result>
4897
4898	</desc>
4899	<param name="name" type="wstring" dir="in">
4900	<desc>Name of the storage controller.</desc>
4901	</param>
4902	<param name="controllerPort" type="long" dir="in">
4903	<desc>Storage controller port.</desc>
4904	</param>
4905	<param name="device" type="long" dir="in">
4906	<desc>Device slot in the given port.</desc>
4907	</param>
4908	<param name="passthrough" type="boolean" dir="in">
4909	<desc>New value for the passthrough setting.</desc>
4910	</param>
4911	</method>
4912
4913	<method name="mountMedium">
4914	<desc>
4915	Mounts a medium (<link to="IMedium" />, identified
4916	by the given UUID @a id) to the given storage controller
4917	(<link to="IStorageController" />, identified by @a name),
4918	at the indicated port and device. The device must already exist;
4919	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4920
4921	This method is intended only for managing removable media, where the
4922	device is fixed but media is changeable at runtime (such as DVDs
4923	and floppies). It cannot be used for fixed media such as hard disks.
4924
4925	The @a controllerPort and @a device parameters specify the device slot and
4926	have have the same meaning as with <link to="IMachine::attachDevice" />.
4927
4928	The specified device slot can have a medium mounted, which will be
4929	unmounted first. Specifying a zero UUID (or an empty string) for
4930	@a medium does just an unmount.
4931
4932	See <link to="IMedium"/> for more detailed information about
4933	attaching media.
4934
4935	<result name="E_INVALIDARG">
4936	SATA device, SATA port, IDE port or IDE slot out of range.
4937	</result>
4938	<result name="VBOX_E_INVALID_OBJECT_STATE">
4939	Attempt to attach medium to an unregistered virtual machine.
4940	</result>
4941	<result name="VBOX_E_INVALID_VM_STATE">
4942	Invalid machine state.
4943	</result>
4944	<result name="VBOX_E_OBJECT_IN_USE">
4945	Medium already attached to this or another virtual machine.
4946	</result>
4947
4948	</desc>
4949	<param name="name" type="wstring" dir="in">
4950	<desc>Name of the storage controller to attach the medium to.</desc>
4951	</param>
4952	<param name="controllerPort" type="long" dir="in">
4953	<desc>Port to attach the medium to.</desc>
4954	</param>
4955	<param name="device" type="long" dir="in">
4956	<desc>Device slot in the given port to attach the medium to.</desc>
4957	</param>
4958	<param name="medium" type="uuid" mod="string" dir="in">
4959	<desc>UUID of the medium to attach. A zero UUID means unmount the
4960	currently mounted medium.</desc>
4961	</param>
4962	<param name="force" type="boolean" dir="in">
4963	<desc>Allows to force unmount/mount of a medium which is locked by
4964	theDevice slot in the given port to attach the medium to.</desc>
4965	</param>
4966	</method>
4967
4968	<method name="getMedium" const="yes">
4969	<desc>
4970	Returns the virtual medium attached to a device slot of the specified
4971	bus.
4972
4973	Note that if the medium was indirectly attached by
4974	<link to="#mountMedium"/> to the given device slot then this
4975	method will return not the same object as passed to the
4976	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4977	more detailed information about mounting a medium.
4978
4979	<result name="VBOX_E_OBJECT_NOT_FOUND">
4980	No medium attached to given slot/bus.
4981	</result>
4982
4983	</desc>
4984	<param name="name" type="wstring" dir="in">
4985	<desc>Name of the storage controller the medium is attached to.</desc>
4986	</param>
4987	<param name="controllerPort" type="long" dir="in">
4988	<desc>Port to query.</desc>
4989	</param>
4990	<param name="device" type="long" dir="in">
4991	<desc>Device slot in the given port to query.</desc>
4992	</param>
4993	<param name="medium" type="IMedium" dir="return">
4994	<desc>Attached medium object.</desc>
4995	</param>
4996	</method>
4997
4998	<method name="getMediumAttachmentsOfController" const="yes">
4999	<desc>
5000	Returns an array of medium attachments which are attached to the
5001	the controller with the given name.
5002
5003	<result name="VBOX_E_OBJECT_NOT_FOUND">
5004	A storage controller with given name doesn't exist.
5005	</result>
5006	</desc>
5007	<param name="name" type="wstring" dir="in"/>
5008	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5009	</method>
5010
5011	<method name="getMediumAttachment" const="yes">
5012	<desc>
5013	Returns a medium attachment which corresponds to the controller with
5014	the given name, on the given port and device slot.
5015
5016	<result name="VBOX_E_OBJECT_NOT_FOUND">
5017	No attachment exists for the given controller/port/device combination.
5018	</result>
5019	</desc>
5020	<param name="name" type="wstring" dir="in"/>
5021	<param name="controllerPort" type="long" dir="in"/>
5022	<param name="device" type="long" dir="in"/>
5023	<param name="attachment" type="IMediumAttachment" dir="return"/>
5024	</method>
5025
5026	<method name="getNetworkAdapter" const="yes">
5027	<desc>
5028	Returns the network adapter associated with the given slot.
5029	Slots are numbered sequentially, starting with zero. The total
5030	number of adapters per machine is defined by the
5031	<link to="ISystemProperties::networkAdapterCount"/> property,
5032	so the maximum slot number is one less than that property's value.
5033
5034	<result name="E_INVALIDARG">
5035	Invalid @a slot number.
5036	</result>
5037
5038	</desc>
5039	<param name="slot" type="unsigned long" dir="in"/>
5040	<param name="adapter" type="INetworkAdapter" dir="return"/>
5041	</method>
5042
5043	<method name="addStorageController">
5044	<desc>
5045	Adds a new storage controller (SCSI or SATA controller) to the
5046	machine and returns it as an instance of
5047	<link to="IStorageController" />.
5048
5049	@a name identifies the controller for subsequent calls such as
5050	<link to="#getStorageControllerByName" />,
5051	<link to="#getStorageControllerByInstance" />,
5052	<link to="#removeStorageController" />,
5053	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5054
5055	After the controller has been added, you can set its exact
5056	type by setting the <link to="IStorageController::controllerType" />.
5057
5058	<result name="VBOX_E_OBJECT_IN_USE">
5059	A storage controller with given name exists already.
5060	</result>
5061	<result name="E_INVALIDARG">
5062	Invalid @a controllerType.
5063	</result>
5064	</desc>
5065	<param name="name" type="wstring" dir="in"/>
5066	<param name="connectionType" type="StorageBus" dir="in"/>
5067	<param name="controller" type="IStorageController" dir="return"/>
5068	</method>
5069
5070	<method name="getStorageControllerByName" const="yes">
5071	<desc>
5072	Returns a storage controller with the given name.
5073
5074	<result name="VBOX_E_OBJECT_NOT_FOUND">
5075	A storage controller with given name doesn't exist.
5076	</result>
5077	</desc>
5078	<param name="name" type="wstring" dir="in"/>
5079	<param name="storageController" type="IStorageController" dir="return"/>
5080	</method>
5081
5082	<method name="getStorageControllerByInstance" const="yes">
5083	<desc>
5084	Returns a storage controller with the given instance number.
5085
5086	<result name="VBOX_E_OBJECT_NOT_FOUND">
5087	A storage controller with given instance number doesn't exist.
5088	</result>
5089	</desc>
5090	<param name="instance" type="unsigned long" dir="in"/>
5091	<param name="storageController" type="IStorageController" dir="return"/>
5092	</method>
5093
5094	<method name="removeStorageController">
5095	<desc>
5096	Removes a storage controller from the machine.
5097
5098	<result name="VBOX_E_OBJECT_NOT_FOUND">
5099	A storage controller with given name doesn't exist.
5100	</result>
5101	</desc>
5102	<param name="name" type="wstring" dir="in"/>
5103	</method>
5104
5105	<method name="getSerialPort" const="yes">
5106	<desc>
5107	Returns the serial port associated with the given slot.
5108	Slots are numbered sequentially, starting with zero. The total
5109	number of serial ports per machine is defined by the
5110	<link to="ISystemProperties::serialPortCount"/> property,
5111	so the maximum slot number is one less than that property's value.
5112
5113	<result name="E_INVALIDARG">
5114	Invalid @a slot number.
5115	</result>
5116
5117	</desc>
5118	<param name="slot" type="unsigned long" dir="in"/>
5119	<param name="port" type="ISerialPort" dir="return"/>
5120	</method>
5121
5122	<method name="getParallelPort" const="yes">
5123	<desc>
5124	Returns the parallel port associated with the given slot.
5125	Slots are numbered sequentially, starting with zero. The total
5126	number of parallel ports per machine is defined by the
5127	<link to="ISystemProperties::parallelPortCount"/> property,
5128	so the maximum slot number is one less than that property's value.
5129
5130	<result name="E_INVALIDARG">
5131	Invalid @a slot number.
5132	</result>
5133
5134	</desc>
5135	<param name="slot" type="unsigned long" dir="in"/>
5136	<param name="port" type="IParallelPort" dir="return"/>
5137	</method>
5138
5139	<method name="getExtraDataKeys">
5140	<desc>
5141	Returns an array representing the machine-specific extra data keys
5142	which currently have values defined.
5143	</desc>
5144	<param name="value" type="wstring" dir="return" safearray="yes">
5145	<desc>Array of extra data keys.</desc>
5146	</param>
5147	</method>
5148
5149	<method name="getExtraData">
5150	<desc>
5151	Returns associated machine-specific extra data.
5152
5153	If the requested data @a key does not exist, this function will
5154	succeed and return an empty string in the @a value argument.
5155
5156	<result name="VBOX_E_FILE_ERROR">
5157	Settings file not accessible.
5158	</result>
5159	<result name="VBOX_E_XML_ERROR">
5160	Could not parse the settings file.
5161	</result>
5162
5163	</desc>
5164	<param name="key" type="wstring" dir="in">
5165	<desc>Name of the data key to get.</desc>
5166	</param>
5167	<param name="value" type="wstring" dir="return">
5168	<desc>Value of the requested data key.</desc>
5169	</param>
5170	</method>
5171
5172	<method name="setExtraData">
5173	<desc>
5174	Sets associated machine-specific extra data.
5175
5176	If you pass @c null or an empty string as a key @a value, the given
5177	@a key will be deleted.
5178
5179	<note>
5180	Before performing the actual data change, this method will ask all
5181	registered callbacks using the
5182	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5183	notification for a permission. If one of the callbacks refuses the
5184	new value, the change will not be performed.
5185	</note>
5186	<note>
5187	On success, the
5188	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5189	is called to inform all registered callbacks about a successful data
5190	change.
5191	</note>
5192	<note>
5193	This method can be called outside the machine session and therefore
5194	it's a caller's responsibility to handle possible race conditions
5195	when several clients change the same key at the same time.
5196	</note>
5197
5198	<result name="VBOX_E_FILE_ERROR">
5199	Settings file not accessible.
5200	</result>
5201	<result name="VBOX_E_XML_ERROR">
5202	Could not parse the settings file.
5203	</result>
5204
5205	</desc>
5206	<param name="key" type="wstring" dir="in">
5207	<desc>Name of the data key to set.</desc>
5208	</param>
5209	<param name="value" type="wstring" dir="in">
5210	<desc>Value to assign to the key.</desc>
5211	</param>
5212	</method>
5213
5214	<method name="getCpuProperty" const="yes">
5215	<desc>
5216	Returns the virtual CPU boolean value of the specified property.
5217
5218	<result name="E_INVALIDARG">
5219	Invalid property.
5220	</result>
5221
5222	</desc>
5223	<param name="property" type="CpuPropertyType" dir="in">
5224	<desc>
5225	Property type to query.
5226	</desc>
5227	</param>
5228	<param name="value" type="boolean" dir="return">
5229	<desc>
5230	Property value.
5231	</desc>
5232	</param>
5233	</method>
5234
5235	<method name="setCpuProperty">
5236	<desc>
5237	Sets the virtual CPU boolean value of the specified property.
5238
5239	<result name="E_INVALIDARG">
5240	Invalid property.
5241	</result>
5242
5243	</desc>
5244	<param name="property" type="CpuPropertyType" dir="in">
5245	<desc>
5246	Property type to query.
5247	</desc>
5248	</param>
5249	<param name="value" type="boolean" dir="in">
5250	<desc>
5251	Property value.
5252	</desc>
5253	</param>
5254	</method>
5255
5256	<method name="getCpuIdLeaf" const="yes">
5257	<desc>
5258	Returns the virtual CPU cpuid information for the specified leaf.
5259
5260	Currently supported index values for cpuid:
5261	Standard CPUID leafs: 0 - 0xA
5262	Extended CPUID leafs: 0x80000000 - 0x8000000A
5263
5264	See the Intel and AMD programmer's manuals for detailed information
5265	about the cpuid instruction and its leafs.
5266	<result name="E_INVALIDARG">
5267	Invalid id.
5268	</result>
5269
5270	</desc>
5271	<param name="id" type="unsigned long" dir="in">
5272	<desc>
5273	Cpuid leaf index.
5274	</desc>
5275	</param>
5276	<param name="valEax" type="unsigned long" dir="out">
5277	<desc>
5278	Cpuid leaf value for register eax.
5279	</desc>
5280	</param>
5281	<param name="valEbx" type="unsigned long" dir="out">
5282	<desc>
5283	Cpuid leaf value for register ebx.
5284	</desc>
5285	</param>
5286	<param name="valEcx" type="unsigned long" dir="out">
5287	<desc>
5288	Cpuid leaf value for register ecx.
5289	</desc>
5290	</param>
5291	<param name="valEdx" type="unsigned long" dir="out">
5292	<desc>
5293	Cpuid leaf value for register edx.
5294	</desc>
5295	</param>
5296	</method>
5297
5298	<method name="setCpuIdLeaf" const="yes">
5299	<desc>
5300	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5301	are not passed unmodified. VirtualBox clears features that it doesn't support.
5302
5303	Currently supported index values for cpuid:
5304	Standard CPUID leafs: 0 - 0xA
5305	Extended CPUID leafs: 0x80000000 - 0x8000000A
5306
5307	See the Intel and AMD programmer's manuals for detailed information
5308	about the cpuid instruction and its leafs.
5309
5310	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5311	random crashes inside VMs.
5312	<result name="E_INVALIDARG">
5313	Invalid id.
5314	</result>
5315
5316	</desc>
5317	<param name="id" type="unsigned long" dir="in">
5318	<desc>
5319	Cpuid leaf index.
5320	</desc>
5321	</param>
5322	<param name="valEax" type="unsigned long" dir="in">
5323	<desc>
5324	Cpuid leaf value for register eax.
5325	</desc>
5326	</param>
5327	<param name="valEbx" type="unsigned long" dir="in">
5328	<desc>
5329	Cpuid leaf value for register ebx.
5330	</desc>
5331	</param>
5332	<param name="valEcx" type="unsigned long" dir="in">
5333	<desc>
5334	Cpuid leaf value for register ecx.
5335	</desc>
5336	</param>
5337	<param name="valEdx" type="unsigned long" dir="in">
5338	<desc>
5339	Cpuid leaf value for register edx.
5340	</desc>
5341	</param>
5342	</method>
5343
5344	<method name="removeCpuIdLeaf" const="yes">
5345	<desc>
5346	Removes the virtual CPU cpuid leaf for the specified index
5347
5348	<result name="E_INVALIDARG">
5349	Invalid id.
5350	</result>
5351
5352	</desc>
5353	<param name="id" type="unsigned long" dir="in">
5354	<desc>
5355	Cpuid leaf index.
5356	</desc>
5357	</param>
5358	</method>
5359
5360	<method name="removeAllCpuIdLeafs" const="yes">
5361	<desc>
5362	Removes all the virtual CPU cpuid leafs
5363	</desc>
5364	</method>
5365
5366	<method name="getHWVirtExProperty" const="yes">
5367	<desc>
5368	Returns the value of the specified hardware virtualization boolean property.
5369
5370	<result name="E_INVALIDARG">
5371	Invalid property.
5372	</result>
5373
5374	</desc>
5375	<param name="property" type="HWVirtExPropertyType" dir="in">
5376	<desc>
5377	Property type to query.
5378	</desc>
5379	</param>
5380	<param name="value" type="boolean" dir="return">
5381	<desc>
5382	Property value.
5383	</desc>
5384	</param>
5385	</method>
5386
5387	<method name="setHWVirtExProperty">
5388	<desc>
5389	Sets a new value for the specified hardware virtualization boolean property.
5390
5391	<result name="E_INVALIDARG">
5392	Invalid property.
5393	</result>
5394
5395	</desc>
5396	<param name="property" type="HWVirtExPropertyType" dir="in">
5397	<desc>
5398	Property type to set.
5399	</desc>
5400	</param>
5401	<param name="value" type="boolean" dir="in">
5402	<desc>
5403	New property value.
5404	</desc>
5405	</param>
5406	</method>
5407
5408	<method name="saveSettings">
5409	<desc>
5410	Saves any changes to machine settings made since the session
5411	has been opened or a new machine has been created, or since the
5412	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5413	For registered machines, new settings become visible to all
5414	other VirtualBox clients after successful invocation of this
5415	method.
5416	<note>
5417	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5418	notification event after the configuration has been successfully
5419	saved (only for registered machines).
5420	</note>
5421	<note>
5422	Calling this method is only valid on instances returned
5423	by <link to="ISession::machine"/> and on new machines
5424	created by <link to="IVirtualBox::createMachine"/> but not
5425	yet registered, or on unregistered machines after calling
5426	<link to="IVirtualBox::unregisterMachine"/>.
5427	</note>
5428
5429	<result name="VBOX_E_FILE_ERROR">
5430	Settings file not accessible.
5431	</result>
5432	<result name="VBOX_E_XML_ERROR">
5433	Could not parse the settings file.
5434	</result>
5435	<result name="E_ACCESSDENIED">
5436	Modification request refused.
5437	</result>
5438
5439	</desc>
5440	</method>
5441
5442	<method name="discardSettings">
5443	<desc>
5444	Discards any changes to the machine settings made since the session
5445	has been opened or since the last call to <link to="#saveSettings"/>
5446	or <link to="#discardSettings"/>.
5447	<note>
5448	Calling this method is only valid on instances returned
5449	by <link to="ISession::machine"/> and on new machines
5450	created by <link to="IVirtualBox::createMachine"/> or
5451	opened by <link to="IVirtualBox::openMachine"/> but not
5452	yet registered, or on unregistered machines after calling
5453	<link to="IVirtualBox::unregisterMachine"/>.
5454	</note>
5455
5456	<result name="VBOX_E_INVALID_VM_STATE">
5457	Virtual machine is not mutable.
5458	</result>
5459
5460	</desc>
5461	</method>
5462
5463	<method name="deleteSettings">
5464	<desc>
5465	Deletes the settings file of this machine from disk.
5466	The machine must not be registered in order for this operation
5467	to succeed.
5468	<note>
5469	<link to="#settingsModified"/> will return @c true after this
5470	method successfully returns.
5471	</note>
5472	<note>
5473	Calling this method is only valid on instances returned
5474	by <link to="ISession::machine"/> and on new machines
5475	created by <link to="IVirtualBox::createMachine"/> or
5476	opened by <link to="IVirtualBox::openMachine"/> but not
5477	yet registered, or on unregistered machines after calling
5478	<link to="IVirtualBox::unregisterMachine"/>.
5479	</note>
5480	<note>
5481	The deleted machine settings file can be restored (saved again)
5482	by calling <link to="#saveSettings"/>.
5483	</note>
5484
5485	<result name="VBOX_E_INVALID_VM_STATE">
5486	Cannot delete settings of a registered machine or
5487	machine not mutable.
5488	</result>
5489	<result name="VBOX_E_IPRT_ERROR">
5490	Could not delete the settings file.
5491	</result>
5492
5493	</desc>
5494	</method>
5495
5496	<method name="export">
5497	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5498	steps required to export VirtualBox machines to OVF.
5499	</desc>
5500
5501	<param name="aAppliance" type="IAppliance" dir="in">
5502	<desc>Appliance to export this machine to.</desc>
5503	</param>
5504	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5505	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5506	</param>
5507	</method >
5508
5509	<method name="getSnapshot">
5510	<desc>
5511	Returns a snapshot of this machine with the given UUID.
5512	A @c null UUID can be used to obtain the first snapshot
5513	taken on this machine. This is useful if you want to traverse
5514	the whole tree of snapshots starting from the root.
5515
5516	<result name="VBOX_E_OBJECT_NOT_FOUND">
5517	Virtual machine has no snapshots or snapshot not found.
5518	</result>
5519
5520	</desc>
5521	<param name="id" type="uuid" mod="string" dir="in">
5522	<desc>UUID of the snapshot to get</desc>
5523	</param>
5524	<param name="snapshot" type="ISnapshot" dir="return">
5525	<desc>Snapshot object with the given UUID.</desc>
5526	</param>
5527	</method>
5528
5529	<method name="findSnapshot">
5530	<desc>
5531	Returns a snapshot of this machine with the given name.
5532
5533	<result name="VBOX_E_OBJECT_NOT_FOUND">
5534	Virtual machine has no snapshots or snapshot not found.
5535	</result>
5536
5537	</desc>
5538	<param name="name" type="wstring" dir="in">
5539	<desc>Name of the snapshot to find</desc>
5540	</param>
5541	<param name="snapshot" type="ISnapshot" dir="return">
5542	<desc>Snapshot object with the given name.</desc>
5543	</param>
5544	</method>
5545
5546	<method name="setCurrentSnapshot">
5547	<desc>
5548	Sets the current snapshot of this machine.
5549	<note>
5550	In the current implementation, this operation is not
5551	implemented.
5552	</note>
5553	</desc>
5554	<param name="id" type="uuid" mod="string" dir="in">
5555	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5556	</param>
5557	</method>
5558
5559	<method name="createSharedFolder">
5560	<desc>
5561	Creates a new permanent shared folder by associating the given logical
5562	name with the given host path, adds it to the collection of shared
5563	folders and starts sharing it. Refer to the description of
5564	<link to="ISharedFolder"/> to read more about logical names.
5565
5566	<result name="VBOX_E_OBJECT_IN_USE">
5567	Shared folder already exists.
5568	</result>
5569	<result name="VBOX_E_FILE_ERROR">
5570	Shared folder @a hostPath not accessible.
5571	</result>
5572
5573	</desc>
5574	<param name="name" type="wstring" dir="in">
5575	<desc>Unique logical name of the shared folder.</desc>
5576	</param>
5577	<param name="hostPath" type="wstring" dir="in">
5578	<desc>Full path to the shared folder in the host file system.</desc>
5579	</param>
5580	<param name="writable" type="boolean" dir="in">
5581	<desc>Whether the share is writable or readonly</desc>
5582	</param>
5583	</method>
5584
5585	<method name="removeSharedFolder">
5586	<desc>
5587	Removes the permanent shared folder with the given name previously
5588	created by <link to="#createSharedFolder"/> from the collection of
5589	shared folders and stops sharing it.
5590
5591	<result name="VBOX_E_INVALID_VM_STATE">
5592	Virtual machine is not mutable.
5593	</result>
5594	<result name="VBOX_E_OBJECT_NOT_FOUND">
5595	Shared folder @a name does not exist.
5596	</result>
5597
5598	</desc>
5599	<param name="name" type="wstring" dir="in">
5600	<desc>Logical name of the shared folder to remove.</desc>
5601	</param>
5602	</method>
5603
5604	<method name="canShowConsoleWindow">
5605	<desc>
5606	Returns @c true if the VM console process can activate the
5607	console window and bring it to foreground on the desktop of
5608	the host PC.
5609	<note>
5610	This method will fail if a session for this machine is not
5611	currently open.
5612	</note>
5613
5614	<result name="VBOX_E_INVALID_VM_STATE">
5615	Machine session is not open.
5616	</result>
5617
5618	</desc>
5619	<param name="canShow" type="boolean" dir="return">
5620	<desc>
5621	@c true if the console window can be shown and @c false otherwise.
5622	</desc>
5623	</param>
5624	</method>
5625
5626	<method name="showConsoleWindow">
5627	<desc>
5628	Activates the console window and brings it to foreground on
5629	the desktop of the host PC. Many modern window managers on
5630	many platforms implement some sort of focus stealing
5631	prevention logic, so that it may be impossible to activate
5632	a window without the help of the currently active
5633	application. In this case, this method will return a non-zero
5634	identifier that represents the top-level window of the VM
5635	console process. The caller, if it represents a currently
5636	active process, is responsible to use this identifier (in a
5637	platform-dependent manner) to perform actual window
5638	activation.
5639	<note>
5640	This method will fail if a session for this machine is not
5641	currently open.
5642	</note>
5643
5644	<result name="VBOX_E_INVALID_VM_STATE">
5645	Machine session is not open.
5646	</result>
5647
5648	</desc>
5649	<param name="winId" type="unsigned long long" dir="return">
5650	<desc>
5651	Platform-dependent identifier of the top-level VM console
5652	window, or zero if this method has performed all actions
5653	necessary to implement the <i>show window</i> semantics for
5654	the given platform and/or VirtualBox front-end.
5655	</desc>
5656	</param>
5657	</method>
5658
5659	<method name="getGuestProperty">
5660	<desc>
5661	Reads an entry from the machine's guest property store.
5662
5663	<result name="VBOX_E_INVALID_VM_STATE">
5664	Machine session is not open.
5665	</result>
5666
5667	</desc>
5668	<param name="name" type="wstring" dir="in">
5669	<desc>
5670	The name of the property to read.
5671	</desc>
5672	</param>
5673	<param name="value" type="wstring" dir="out">
5674	<desc>
5675	The value of the property. If the property does not exist then this
5676	will be empty.
5677	</desc>
5678	</param>
5679	<param name="timestamp" type="unsigned long long" dir="out">
5680	<desc>
5681	The time at which the property was last modified, as seen by the
5682	server process.
5683	</desc>
5684	</param>
5685	<param name="flags" type="wstring" dir="out">
5686	<desc>
5687	Additional property parameters, passed as a comma-separated list of
5688	"name=value" type entries.
5689	</desc>
5690	</param>
5691	</method>
5692
5693	<method name="getGuestPropertyValue">
5694	<desc>
5695	Reads a value from the machine's guest property store.
5696
5697	<result name="VBOX_E_INVALID_VM_STATE">
5698	Machine session is not open.
5699	</result>
5700
5701	</desc>
5702	<param name="property" type="wstring" dir="in">
5703	<desc>
5704	The name of the property to read.
5705	</desc>
5706	</param>
5707	<param name="value" type="wstring" dir="return">
5708	<desc>
5709	The value of the property. If the property does not exist then this
5710	will be empty.
5711	</desc>
5712	</param>
5713	</method>
5714
5715	<method name="getGuestPropertyTimestamp">
5716	<desc>
5717	Reads a property timestamp from the machine's guest property store.
5718
5719	<result name="VBOX_E_INVALID_VM_STATE">
5720	Machine session is not open.
5721	</result>
5722
5723	</desc>
5724	<param name="property" type="wstring" dir="in">
5725	<desc>
5726	The name of the property to read.
5727	</desc>
5728	</param>
5729	<param name="value" type="unsigned long long" dir="return">
5730	<desc>
5731	The timestamp. If the property does not exist then this will be
5732	empty.
5733	</desc>
5734	</param>
5735	</method>
5736
5737	<method name="setGuestProperty">
5738	<desc>
5739	Sets, changes or deletes an entry in the machine's guest property
5740	store.
5741
5742	<result name="E_ACCESSDENIED">
5743	Property cannot be changed.
5744	</result>
5745	<result name="E_INVALIDARG">
5746	Invalid @a flags.
5747	</result>
5748	<result name="VBOX_E_INVALID_VM_STATE">
5749	Virtual machine is not mutable or session not open.
5750	</result>
5751	<result name="VBOX_E_INVALID_OBJECT_STATE">
5752	Cannot set transient property when machine not running.
5753	</result>
5754
5755	</desc>
5756	<param name="property" type="wstring" dir="in">
5757	<desc>
5758	The name of the property to set, change or delete.
5759	</desc>
5760	</param>
5761	<param name="value" type="wstring" dir="in">
5762	<desc>
5763	The new value of the property to set, change or delete. If the
5764	property does not yet exist and value is non-empty, it will be
5765	created. If the value is @c null or empty, the property will be
5766	deleted if it exists.
5767	</desc>
5768	</param>
5769	<param name="flags" type="wstring" dir="in">
5770	<desc>
5771	Additional property parameters, passed as a comma-separated list of
5772	"name=value" type entries.
5773	</desc>
5774	</param>
5775	</method>
5776
5777	<method name="setGuestPropertyValue">
5778	<desc>
5779	Sets, changes or deletes a value in the machine's guest property
5780	store. The flags field will be left unchanged or created empty for a
5781	new property.
5782
5783	<result name="E_ACCESSDENIED">
5784	Property cannot be changed.
5785	</result>
5786	<result name="VBOX_E_INVALID_VM_STATE">
5787	Virtual machine is not mutable or session not open.
5788	</result>
5789	<result name="VBOX_E_INVALID_OBJECT_STATE">
5790	Cannot set transient property when machine not running.
5791	</result>
5792	</desc>
5793
5794	<param name="property" type="wstring" dir="in">
5795	<desc>
5796	The name of the property to set, change or delete.
5797	</desc>
5798	</param>
5799	<param name="value" type="wstring" dir="in">
5800	<desc>
5801	The new value of the property to set, change or delete. If the
5802	property does not yet exist and value is non-empty, it will be
5803	created. If the value is @c null or empty, the property will be
5804	deleted if it exists.
5805	</desc>
5806	</param>
5807	</method>
5808
5809	<method name="enumerateGuestProperties">
5810	<desc>
5811	Return a list of the guest properties matching a set of patterns along
5812	with their values, time stamps and flags.
5813	</desc>
5814	<param name="patterns" type="wstring" dir="in">
5815	<desc>
5816	The patterns to match the properties against, separated by '\|'
5817	characters. If this is empty or @c null, all properties will match.
5818	</desc>
5819	</param>
5820	<param name="name" type="wstring" dir="out" safearray="yes">
5821	<desc>
5822	The names of the properties returned.
5823	</desc>
5824	</param>
5825	<param name="value" type="wstring" dir="out" safearray="yes">
5826	<desc>
5827	The values of the properties returned. The array entries match the
5828	corresponding entries in the @a name array.
5829	</desc>
5830	</param>
5831	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5832	<desc>
5833	The time stamps of the properties returned. The array entries match
5834	the corresponding entries in the @a name array.
5835	</desc>
5836	</param>
5837	<param name="flags" type="wstring" dir="out" safearray="yes">
5838	<desc>
5839	The flags of the properties returned. The array entries match the
5840	corresponding entries in the @a name array.
5841	</desc>
5842	</param>
5843	</method>
5844
5845	<method name="querySavedThumbnailSize">
5846	<desc>
5847	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5848	</desc>
5849	<param name="size" type="unsigned long" dir="out">
5850	<desc>
5851	Size of buffer required to store the bitmap.
5852	</desc>
5853	</param>
5854	<param name="width" type="unsigned long" dir="out">
5855	<desc>
5856	Bitmap width.
5857	</desc>
5858	</param>
5859	<param name="height" type="unsigned long" dir="out">
5860	<desc>
5861	Bitmap height.
5862	</desc>
5863	</param>
5864	</method>
5865
5866	<method name="readSavedThumbnailToArray">
5867	<desc>
5868	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5869	</desc>
5870	<param name="BGR" type="boolean" dir="in">
5871	<desc>
5872	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5873	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5874	</desc>
5875	</param>
5876	<param name="width" type="unsigned long" dir="out">
5877	<desc>
5878	Bitmap width.
5879	</desc>
5880	</param>
5881	<param name="height" type="unsigned long" dir="out">
5882	<desc>
5883	Bitmap height.
5884	</desc>
5885	</param>
5886	<param name="data" type="octet" dir="return" safearray="yes">
5887	<desc>
5888	Array with resulting bitmap data.
5889	</desc>
5890	</param>
5891	</method>
5892
5893	<method name="querySavedScreenshotPNGSize">
5894	<desc>
5895	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5896	</desc>
5897	<param name="size" type="unsigned long" dir="out">
5898	<desc>
5899	Size of buffer required to store the PNG binary data.
5900	</desc>
5901	</param>
5902	<param name="width" type="unsigned long" dir="out">
5903	<desc>
5904	Image width.
5905	</desc>
5906	</param>
5907	<param name="height" type="unsigned long" dir="out">
5908	<desc>
5909	Image height.
5910	</desc>
5911	</param>
5912	</method>
5913
5914	<method name="readSavedScreenshotPNGToArray">
5915	<desc>
5916	Screenshot in PNG format is retrieved to an array of bytes.
5917	</desc>
5918	<param name="width" type="unsigned long" dir="out">
5919	<desc>
5920	Image width.
5921	</desc>
5922	</param>
5923	<param name="height" type="unsigned long" dir="out">
5924	<desc>
5925	Image height.
5926	</desc>
5927	</param>
5928	<param name="data" type="octet" dir="return" safearray="yes">
5929	<desc>
5930	Array with resulting PNG data.
5931	</desc>
5932	</param>
5933	</method>
5934	</interface>
5935
5936	<!--
5937	// IConsole
5938	/////////////////////////////////////////////////////////////////////////
5939	-->
5940
5941	<interface
5942	name="IConsoleCallback" extends="$unknown"
5943	uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
5944	wsmap="suppress"
5945	>
5946
5947	<desc>
5948	This interface is used by a client of the Main API that need to
5949	be notified of events. For example, a graphical user interface
5950	can use this to learn about machine state changes so they can
5951	update the list of virtual machines without having to rely
5952	on polling.
5953
5954	Whenever relevant events occur in VirtualBox, the callbacks in
5955	objects of this interface are called. In order for this to be
5956	useful, a client needs to create its own subclass that implements
5957	this interface in which the methods for the relevant callbacks
5958	are overridden. An instance of this subclass interface can then
5959	be passed to <link to="IConsole::registerCallback" />.
5960	</desc>
5961
5962	<method name="onMousePointerShapeChange">
5963	<desc>
5964	Notification when the guest mouse pointer shape has
5965	changed. The new shape data is given.
5966	</desc>
5967	<param name="visible" type="boolean" dir="in">
5968	<desc>
5969	Flag whether the pointer is visible.
5970	</desc>
5971	</param>
5972	<param name="alpha" type="boolean" dir="in">
5973	<desc>
5974	Flag whether the pointer has an alpha channel.
5975	</desc>
5976	</param>
5977	<param name="xHot" type="unsigned long" dir="in">
5978	<desc>
5979	The pointer hot spot x coordinate.
5980	</desc>
5981	</param>
5982	<param name="yHot" type="unsigned long" dir="in">
5983	<desc>
5984	The pointer hot spot y coordinate.
5985	</desc>
5986	</param>
5987	<param name="width" type="unsigned long" dir="in">
5988	<desc>
5989	Width of the pointer shape in pixels.
5990	</desc>
5991	</param>
5992	<param name="height" type="unsigned long" dir="in">
5993	<desc>
5994	Height of the pointer shape in pixels.
5995	</desc>
5996	</param>
5997	<param name="shape" type="octet" mod="ptr" dir="in">
5998	<desc>
5999	Address of the shape buffer.
6000
6001	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6002	followed by a 32-bpp XOR (color) mask.
6003
6004	For pointers without alpha channel the XOR mask pixels are 32
6005	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6006	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6007
6008	An AND mask is used for pointers with alpha channel, so if the
6009	callback does not support alpha, the pointer could be
6010	displayed as a normal color pointer.
6011
6012	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6013	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6014	height</tt>. The padding bits at the end of each scanline are
6015	undefined.
6016
6017	The XOR mask follows the AND mask on the next 4-byte aligned
6018	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6019	Bytes in the gap between the AND and the XOR mask are undefined.
6020	The XOR mask scanlines have no gap between them and the size of
6021	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6022
6023	<note>
6024	If @a shape is 0, only the pointer visibility is changed.
6025	</note>
6026	</desc>
6027	</param>
6028	</method>
6029
6030	<method name="onMouseCapabilityChange">
6031	<desc>
6032	Notification when the mouse capabilities reported by the
6033	guest have changed. The new capabilities are passed.
6034	</desc>
6035	<param name="supportsAbsolute" type="boolean" dir="in"/>
6036	<param name="needsHostCursor" type="boolean" dir="in"/>
6037	</method>
6038
6039	<method name="onKeyboardLedsChange">
6040	<desc>
6041	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6042	to alter the state of the keyboard LEDs.
6043	</desc>
6044	<param name="numLock" type="boolean" dir="in"/>
6045	<param name="capsLock" type="boolean" dir="in"/>
6046	<param name="scrollLock" type="boolean" dir="in"/>
6047	</method>
6048
6049	<method name="onStateChange">
6050	<desc>
6051	Notification when the execution state of the machine has changed.
6052	The new state will be given.
6053	</desc>
6054	<param name="state" type="MachineState" dir="in"/>
6055	</method>
6056
6057	<method name="onAdditionsStateChange">
6058	<desc>
6059	Notification when a Guest Additions property changes.
6060	Interested callees should query IGuest attributes to
6061	find out what has changed.
6062	</desc>
6063	</method>
6064
6065	<method name="onNetworkAdapterChange">
6066	<desc>
6067	Notification when a property of one of the
6068	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6069	changes. Interested callees should use INetworkAdapter methods and
6070	attributes to find out what has changed.
6071	</desc>
6072	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6073	<desc>Network adapter that is subject to change.</desc>
6074	</param>
6075	</method>
6076
6077	<method name="onSerialPortChange">
6078	<desc>
6079	Notification when a property of one of the
6080	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6081	Interested callees should use ISerialPort methods and attributes
6082	to find out what has changed.
6083	</desc>
6084	<param name="serialPort" type="ISerialPort" dir="in">
6085	<desc>Serial port that is subject to change.</desc>
6086	</param>
6087	</method>
6088
6089	<method name="onParallelPortChange">
6090	<desc>
6091	Notification when a property of one of the
6092	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6093	changes. Interested callees should use ISerialPort methods and
6094	attributes to find out what has changed.
6095	</desc>
6096	<param name="parallelPort" type="IParallelPort" dir="in">
6097	<desc>Parallel port that is subject to change.</desc>
6098	</param>
6099	</method>
6100
6101	<method name="onStorageControllerChange">
6102	<desc>
6103	Notification when a property of one of the
6104	virtual <link to="IMachine::storageControllers">storage controllers</link>
6105	changes. Interested callees should query the corresponding collections
6106	to find out what has changed.
6107	</desc>
6108	</method>
6109
6110	<method name="onMediumChange">
6111	<desc>
6112	Notification when a
6113	<link to="IMachine::mediumAttachments">medium attachment</link>
6114	changes.
6115	</desc>
6116	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6117	<desc>Medium attachment that is subject to change.</desc>
6118	</param>
6119	</method>
6120
6121	<method name="onVRDPServerChange">
6122	<desc>
6123	Notification when a property of the
6124	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6125	Interested callees should use IVRDPServer methods and attributes to
6126	find out what has changed.
6127	</desc>
6128	</method>
6129
6130	<method name="onRemoteDisplayInfoChange">
6131	<desc>
6132	Notification when the status of the VRDP server changes. Interested callees
6133	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6134	attributes to find out what is the current status.
6135	</desc>
6136	</method>
6137
6138	<method name="onUSBControllerChange">
6139	<desc>
6140	Notification when a property of the virtual
6141	<link to="IMachine::USBController">USB controller</link> changes.
6142	Interested callees should use IUSBController methods and attributes to
6143	find out what has changed.
6144	</desc>
6145	</method>
6146
6147	<method name="onUSBDeviceStateChange">
6148	<desc>
6149	Notification when a USB device is attached to or detached from
6150	the virtual USB controller.
6151
6152	This notification is sent as a result of the indirect
6153	request to attach the device because it matches one of the
6154	machine USB filters, or as a result of the direct request
6155	issued by <link to="IConsole::attachUSBDevice"/> or
6156	<link to="IConsole::detachUSBDevice"/>.
6157
6158	This notification is sent in case of both a succeeded and a
6159	failed request completion. When the request succeeds, the
6160	@a error parameter is @c null, and the given device has been
6161	already added to (when @a attached is @c true) or removed from
6162	(when @a attached is @c false) the collection represented by
6163	<link to="IConsole::USBDevices"/>. On failure, the collection
6164	doesn't change and the @a error parameter represents the error
6165	message describing the failure.
6166
6167	</desc>
6168	<param name="device" type="IUSBDevice" dir="in">
6169	<desc>Device that is subject to state change.</desc>
6170	</param>
6171	<param name="attached" type="boolean" dir="in">
6172	<desc>
6173	@c true if the device was attached and @c false otherwise.
6174	</desc>
6175	</param>
6176	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6177	<desc>
6178	@c null on success or an error message object on failure.
6179	</desc>
6180	</param>
6181	</method>
6182
6183	<method name="onSharedFolderChange">
6184	<desc>
6185	Notification when a shared folder is added or removed.
6186	The @a scope argument defines one of three scopes:
6187	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6188	(<link to="Scope_Global">Global</link>),
6189	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6190	the machine (<link to="Scope_Machine">Machine</link>) or <link
6191	to="IConsole::sharedFolders">transient shared folders</link> of the
6192	machine (<link to="Scope_Session">Session</link>). Interested callees
6193	should use query the corresponding collections to find out what has
6194	changed.
6195	</desc>
6196	<param name="scope" type="Scope" dir="in">
6197	<desc>Scope of the notification.</desc>
6198	</param>
6199	</method>
6200
6201	<method name="onRuntimeError">
6202	<desc>
6203	Notification when an error happens during the virtual
6204	machine execution.
6205
6206	There are three kinds of runtime errors:
6207	<ul>
6208	<li><i>fatal</i></li>
6209	<li><i>non-fatal with retry</i></li>
6210	<li><i>non-fatal warnings</i></li>
6211	</ul>
6212
6213	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6214	to @c true. In case of fatal errors, the virtual machine
6215	execution is always paused before calling this notification, and
6216	the notification handler is supposed either to immediately save
6217	the virtual machine state using <link to="IConsole::saveState"/>
6218	or power it off using <link to="IConsole::powerDown"/>.
6219	Resuming the execution can lead to unpredictable results.
6220
6221	<b>Non-fatal</b> errors and warnings are indicated by the
6222	@a fatal parameter set to @c false. If the virtual machine
6223	is in the Paused state by the time the error notification is
6224	received, it means that the user can <i>try to resume</i> the machine
6225	execution after attempting to solve the problem that caused the
6226	error. In this case, the notification handler is supposed
6227	to show an appropriate message to the user (depending on the
6228	value of the @a id parameter) that offers several actions such
6229	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6230	wants to retry, the notification handler should continue
6231	the machine execution using the <link to="IConsole::resume"/>
6232	call. If the machine execution is not Paused during this
6233	notification, then it means this notification is a <i>warning</i>
6234	(for example, about a fatal condition that can happen very soon);
6235	no immediate action is required from the user, the machine
6236	continues its normal execution.
6237
6238	Note that in either case the notification handler
6239	<b>must not</b> perform any action directly on a thread
6240	where this notification is called. Everything it is allowed to
6241	do is to post a message to another thread that will then talk
6242	to the user and take the corresponding action.
6243
6244	Currently, the following error identifiers are known:
6245	<ul>
6246	<li><tt>"HostMemoryLow"</tt></li>
6247	<li><tt>"HostAudioNotResponding"</tt></li>
6248	<li><tt>"VDIStorageFull"</tt></li>
6249	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6250	</ul>
6251
6252	<note>
6253	This notification is not designed to be implemented by
6254	more than one callback at a time. If you have multiple
6255	IConsoleCallback instances registered on the given
6256	IConsole object, make sure you simply do nothing but
6257	return @c S_OK from all but one of them that does actual
6258	user notification and performs necessary actions.
6259	</note>
6260
6261	</desc>
6262	<param name="fatal" type="boolean" dir="in">
6263	<desc>Whether the error is fatal or not</desc>
6264	</param>
6265	<param name="id" type="wstring" dir="in">
6266	<desc>Error identifier</desc>
6267	</param>
6268	<param name="message" type="wstring" dir="in">
6269	<desc>Optional error message</desc>
6270	</param>
6271	</method>
6272
6273	<method name="onCanShowWindow">
6274	<desc>
6275	Notification when a call to
6276	<link to="IMachine::canShowConsoleWindow"/> is made by a
6277	front-end to check if a subsequent call to
6278	<link to="IMachine::showConsoleWindow"/> can succeed.
6279
6280	The callee should give an answer appropriate to the current
6281	machine state in the @a canShow argument. This answer must
6282	remain valid at least until the next
6283	<link to="IConsole::state">machine state</link> change.
6284
6285	<note>
6286	This notification is not designed to be implemented by
6287	more than one callback at a time. If you have multiple
6288	IConsoleCallback instances registered on the given
6289	IConsole object, make sure you simply do nothing but
6290	return @c true and @c S_OK from all but one of them that
6291	actually manages console window activation.
6292	</note>
6293	</desc>
6294	<param name="canShow" type="boolean" dir="return">
6295	<desc>
6296	@c true if the console window can be shown and @c false otherwise.
6297	</desc>
6298	</param>
6299	</method>
6300
6301	<method name="onShowWindow">
6302	<desc>
6303	Notification when a call to
6304	<link to="IMachine::showConsoleWindow"/>
6305	requests the console window to be activated and brought to
6306	foreground on the desktop of the host PC.
6307
6308	This notification should cause the VM console process to
6309	perform the requested action as described above. If it is
6310	impossible to do it at a time of this notification, this
6311	method should return a failure.
6312
6313	Note that many modern window managers on many platforms
6314	implement some sort of focus stealing prevention logic, so
6315	that it may be impossible to activate a window without the
6316	help of the currently active application (which is supposedly
6317	an initiator of this notification). In this case, this method
6318	must return a non-zero identifier that represents the
6319	top-level window of the VM console process. The caller, if it
6320	represents a currently active process, is responsible to use
6321	this identifier (in a platform-dependent manner) to perform
6322	actual window activation.
6323
6324	This method must set @a winId to zero if it has performed all
6325	actions necessary to complete the request and the console
6326	window is now active and in foreground, to indicate that no
6327	further action is required on the caller's side.
6328
6329	<note>
6330	This notification is not designed to be implemented by
6331	more than one callback at a time. If you have multiple
6332	IConsoleCallback instances registered on the given
6333	IConsole object, make sure you simply do nothing but
6334	return @c S_OK from all but one of them that actually
6335	manages console window activation.
6336	</note>
6337	</desc>
6338	<param name="winId" type="unsigned long long" dir="return">
6339	<desc>
6340	Platform-dependent identifier of the top-level VM console
6341	window, or zero if this method has performed all actions
6342	necessary to implement the <i>show window</i> semantics for
6343	the given platform and/or this VirtualBox front-end.
6344	</desc>
6345	</param>
6346	</method>
6347
6348	</interface>
6349
6350	<interface
6351	name="IRemoteDisplayInfo" extends="$unknown"
6352	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6353	wsmap="struct"
6354	>
6355	<desc>
6356	Contains information about the remote display (VRDP) capabilities and status.
6357	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6358	</desc>
6359
6360	<attribute name="active" type="boolean" readonly="yes">
6361	<desc>
6362	Whether the remote display connection is active.
6363	</desc>
6364	</attribute>
6365
6366	<attribute name="port" type="long" readonly="yes">
6367	<desc>
6368	VRDP server port number. If this property is equal to <tt>0</tt>, then
6369	the VRDP server failed to start, usually because there are no free TCP
6370	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6371	server has not yet been started.
6372	</desc>
6373	</attribute>
6374
6375	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6376	<desc>
6377	How many times a client connected.
6378	</desc>
6379	</attribute>
6380
6381	<attribute name="beginTime" type="long long" readonly="yes">
6382	<desc>
6383	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6384	</desc>
6385	</attribute>
6386
6387	<attribute name="endTime" type="long long" readonly="yes">
6388	<desc>
6389	When the last connection was terminated or the current time, if
6390	connection is still active, in milliseconds since 1970-01-01 UTC.
6391	</desc>
6392	</attribute>
6393
6394	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6395	<desc>
6396	How many bytes were sent in last or current, if still active, connection.
6397	</desc>
6398	</attribute>
6399
6400	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6401	<desc>
6402	How many bytes were sent in all connections.
6403	</desc>
6404	</attribute>
6405
6406	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6407	<desc>
6408	How many bytes were received in last or current, if still active, connection.
6409	</desc>
6410	</attribute>
6411
6412	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6413	<desc>
6414	How many bytes were received in all connections.
6415	</desc>
6416	</attribute>
6417
6418	<attribute name="user" type="wstring" readonly="yes">
6419	<desc>
6420	Login user name supplied by the client.
6421	</desc>
6422	</attribute>
6423
6424	<attribute name="domain" type="wstring" readonly="yes">
6425	<desc>
6426	Login domain name supplied by the client.
6427	</desc>
6428	</attribute>
6429
6430	<attribute name="clientName" type="wstring" readonly="yes">
6431	<desc>
6432	The client name supplied by the client.
6433	</desc>
6434	</attribute>
6435
6436	<attribute name="clientIP" type="wstring" readonly="yes">
6437	<desc>
6438	The IP address of the client.
6439	</desc>
6440	</attribute>
6441
6442	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6443	<desc>
6444	The client software version number.
6445	</desc>
6446	</attribute>
6447
6448	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6449	<desc>
6450	Public key exchange method used when connection was established.
6451	Values: 0 - RDP4 public key exchange scheme.
6452	1 - X509 certificates were sent to client.
6453	</desc>
6454	</attribute>
6455
6456	</interface>
6457
6458	<interface
6459	name="IConsole" extends="$unknown"
6460	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6461	wsmap="managed"
6462	>
6463	<desc>
6464	The IConsole interface represents an interface to control virtual
6465	machine execution.
6466
6467	The console object that implements the IConsole interface is obtained
6468	from a session object after the session for the given machine has been
6469	opened using one of <link to="IVirtualBox::openSession"/>,
6470	<link to="IVirtualBox::openRemoteSession"/> or
6471	<link to="IVirtualBox::openExistingSession"/> methods.
6472
6473	Methods of the IConsole interface allow the caller to query the current
6474	virtual machine execution state, pause the machine or power it down, save
6475	the machine state or take a snapshot, attach and detach removable media
6476	and so on.
6477
6478	<see>ISession</see>
6479	</desc>
6480
6481	<attribute name="machine" type="IMachine" readonly="yes">
6482	<desc>
6483	Machine object this console is sessioned with.
6484	<note>
6485	This is a convenience property, it has the same value as
6486	<link to="ISession::machine"/> of the corresponding session
6487	object.
6488	</note>
6489	</desc>
6490	</attribute>
6491
6492	<attribute name="state" type="MachineState" readonly="yes">
6493	<desc>
6494	Current execution state of the machine.
6495	<note>
6496	This property always returns the same value as the corresponding
6497	property of the IMachine object this console is sessioned with.
6498	For the process that owns (executes) the VM, this is the
6499	preferable way of querying the VM state, because no IPC
6500	calls are made.
6501	</note>
6502	</desc>
6503	</attribute>
6504
6505	<attribute name="guest" type="IGuest" readonly="yes">
6506	<desc>Guest object.</desc>
6507	</attribute>
6508
6509	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6510	<desc>
6511	Virtual keyboard object.
6512	<note>
6513	If the machine is not running, any attempt to use
6514	the returned object will result in an error.
6515	</note>
6516	</desc>
6517	</attribute>
6518
6519	<attribute name="mouse" type="IMouse" readonly="yes">
6520	<desc>
6521	Virtual mouse object.
6522	<note>
6523	If the machine is not running, any attempt to use
6524	the returned object will result in an error.
6525	</note>
6526	</desc>
6527	</attribute>
6528
6529	<attribute name="display" type="IDisplay" readonly="yes">
6530	<desc>Virtual display object.
6531	<note>
6532	If the machine is not running, any attempt to use
6533	the returned object will result in an error.
6534	</note>
6535	</desc>
6536	</attribute>
6537
6538	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6539	<desc>Debugging interface.</desc>
6540	</attribute>
6541
6542	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6543	<desc>
6544	Collection of USB devices currently attached to the virtual
6545	USB controller.
6546	<note>
6547	The collection is empty if the machine is not running.
6548	</note>
6549	</desc>
6550	</attribute>
6551
6552	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6553	<desc>
6554	List of USB devices currently attached to the remote VRDP client.
6555	Once a new device is physically attached to the remote host computer,
6556	it appears in this list and remains there until detached.
6557	</desc>
6558	</attribute>
6559
6560	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6561	<desc>
6562	Collection of shared folders for the current session. These folders
6563	are called transient shared folders because they are available to the
6564	guest OS running inside the associated virtual machine only for the
6565	duration of the session (as opposed to
6566	<link to="IMachine::sharedFolders"/> which represent permanent shared
6567	folders). When the session is closed (e.g. the machine is powered down),
6568	these folders are automatically discarded.
6569
6570	New shared folders are added to the collection using
6571	<link to="#createSharedFolder"/>. Existing shared folders can be
6572	removed using <link to="#removeSharedFolder"/>.
6573	</desc>
6574	</attribute>
6575
6576	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6577	<desc>
6578	Interface that provides information on Remote Display (VRDP) connection.
6579	</desc>
6580	</attribute>
6581
6582	<method name="powerUp">
6583	<desc>
6584	Starts the virtual machine execution using the current machine
6585	state (that is, its current execution state, current settings and
6586	current storage devices).
6587
6588	If the machine is powered off or aborted, the execution will
6589	start from the beginning (as if the real hardware were just
6590	powered on).
6591
6592	If the machine is in the <link to="MachineState_Saved"/> state,
6593	it will continue its execution the point where the state has
6594	been saved.
6595
6596	<note>
6597	Unless you are trying to write a new VirtualBox front-end that
6598	performs direct machine execution (like the VirtualBox or VBoxSDL
6599	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6600	session opened by <link to="IVirtualBox::openSession"/> and use this
6601	session only to change virtual machine settings. If you simply want to
6602	start virtual machine execution using one of the existing front-ends
6603	(for example the VirtualBox GUI or headless server), simply use
6604	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6605	power up the machine automatically for you.
6606	</note>
6607
6608	<see>#saveState</see>
6609	<result name="VBOX_E_INVALID_VM_STATE">
6610	Virtual machine already running.
6611	</result>
6612	<result name="VBOX_E_HOST_ERROR">
6613	Host interface does not exist or name not set.
6614	</result>
6615	<result name="VBOX_E_FILE_ERROR">
6616	Invalid saved state file.
6617	</result>
6618	</desc>
6619	<param name="progress" type="IProgress" dir="return">
6620	<desc>Progress object to track the operation completion.</desc>
6621	</param>
6622	</method>
6623
6624	<method name="powerUpPaused">
6625	<desc>
6626	Identical to powerUp except that the VM will enter the
6627	<link to="MachineState_Paused"/> state, instead of
6628	<link to="MachineState_Running"/>.
6629
6630	<see>#powerUp</see>
6631	<result name="VBOX_E_INVALID_VM_STATE">
6632	Virtual machine already running.
6633	</result>
6634	<result name="VBOX_E_HOST_ERROR">
6635	Host interface does not exist or name not set.
6636	</result>
6637	<result name="VBOX_E_FILE_ERROR">
6638	Invalid saved state file.
6639	</result>
6640	</desc>
6641	<param name="progress" type="IProgress" dir="return">
6642	<desc>Progress object to track the operation completion.</desc>
6643	</param>
6644	</method>
6645
6646	<method name="powerDown">
6647	<desc>
6648	Initiates the power down procedure to stop the virtual machine
6649	execution.
6650
6651	The completion of the power down procedure is tracked using the returned
6652	IProgress object. After the operation is complete, the machine will go
6653	to the PoweredOff state.
6654	<result name="VBOX_E_INVALID_VM_STATE">
6655	Virtual machine must be Running, Paused or Stuck to be powered down.
6656	</result>
6657	</desc>
6658	<param name="progress" type="IProgress" dir="return">
6659	<desc>Progress object to track the operation completion.</desc>
6660	</param>
6661	</method>
6662
6663	<method name="reset">
6664	<desc>Resets the virtual machine.
6665	<result name="VBOX_E_INVALID_VM_STATE">
6666	Virtual machine not in Running state.
6667	</result>
6668	<result name="VBOX_E_VM_ERROR">
6669	Virtual machine error in reset operation.
6670	</result>
6671	</desc>
6672	</method>
6673
6674	<method name="pause">
6675	<desc>Pauses the virtual machine execution.
6676	<result name="VBOX_E_INVALID_VM_STATE">
6677	Virtual machine not in Running state.
6678	</result>
6679	<result name="VBOX_E_VM_ERROR">
6680	Virtual machine error in suspend operation.
6681	</result>
6682	</desc>
6683	</method>
6684
6685	<method name="resume">
6686	<desc>Resumes the virtual machine execution.
6687	<result name="VBOX_E_INVALID_VM_STATE">
6688	Virtual machine not in Paused state.
6689	</result>
6690	<result name="VBOX_E_VM_ERROR">
6691	Virtual machine error in resume operation.
6692	</result>
6693	</desc>
6694	</method>
6695
6696	<method name="powerButton">
6697	<desc>Sends the ACPI power button event to the guest.
6698	<result name="VBOX_E_INVALID_VM_STATE">
6699	Virtual machine not in Running state.
6700	</result>
6701	<result name="VBOX_E_PDM_ERROR">
6702	Controlled power off failed.
6703	</result>
6704	</desc>
6705	</method>
6706
6707	<method name="sleepButton">
6708	<desc>Sends the ACPI sleep button event to the guest.
6709	<result name="VBOX_E_INVALID_VM_STATE">
6710	Virtual machine not in Running state.
6711	</result>
6712	<result name="VBOX_E_PDM_ERROR">
6713	Sending sleep button event failed.
6714	</result>
6715	</desc>
6716	</method>
6717
6718	<method name="getPowerButtonHandled">
6719	<desc>Checks if the last power button event was handled by guest.
6720	<result name="VBOX_E_PDM_ERROR">
6721	Checking if the event was handled by the guest OS failed.
6722	</result>
6723	</desc>
6724	<param name="handled" type="boolean" dir="return"/>
6725	</method>
6726
6727	<method name="getGuestEnteredACPIMode">
6728	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6729	G1 (sleeping). If this method returns @c false, the guest will
6730	most likely not respond to external ACPI events.
6731	<result name="VBOX_E_INVALID_VM_STATE">
6732	Virtual machine not in Running state.
6733	</result>
6734	</desc>
6735	<param name="entered" type="boolean" dir="return"/>
6736	</method>
6737
6738	<method name="saveState">
6739	<desc>
6740	Saves the current execution state of a running virtual machine
6741	and stops its execution.
6742
6743	After this operation completes, the machine will go to the
6744	Saved state. Next time it is powered up, this state will
6745	be restored and the machine will continue its execution from
6746	the place where it was saved.
6747
6748	This operation differs from taking a snapshot to the effect
6749	that it doesn't create new differencing media. Also, once
6750	the machine is powered up from the state saved using this method,
6751	the saved state is deleted, so it will be impossible to return
6752	to this state later.
6753
6754	<note>
6755	On success, this method implicitly calls
6756	<link to="IMachine::saveSettings"/> to save all current machine
6757	settings (including runtime changes to the DVD medium, etc.).
6758	Together with the impossibility to change any VM settings when it is
6759	in the Saved state, this guarantees adequate hardware
6760	configuration of the machine when it is restored from the saved
6761	state file.
6762	</note>
6763
6764	<note>
6765	The machine must be in the Running or Paused state, otherwise
6766	the operation will fail.
6767	</note>
6768	<result name="VBOX_E_INVALID_VM_STATE">
6769	Virtual machine state neither Running nor Paused.
6770	</result>
6771	<result name="VBOX_E_FILE_ERROR">
6772	Failed to create directory for saved state file.
6773	</result>
6774
6775	<see><link to="#takeSnapshot"/></see>
6776	</desc>
6777	<param name="progress" type="IProgress" dir="return">
6778	<desc>Progress object to track the operation completion.</desc>
6779	</param>
6780	</method>
6781
6782	<method name="adoptSavedState">
6783	<desc>
6784	Associates the given saved state file to the virtual machine.
6785
6786	On success, the machine will go to the Saved state. Next time it is
6787	powered up, it will be restored from the adopted saved state and
6788	continue execution from the place where the saved state file was
6789	created.
6790
6791	The specified saved state file path may be absolute or relative to the
6792	folder the VM normally saves the state to (usually,
6793	<link to="IMachine::snapshotFolder"/>).
6794
6795	<note>
6796	It's a caller's responsibility to make sure the given saved state
6797	file is compatible with the settings of this virtual machine that
6798	represent its virtual hardware (memory size, storage disk configuration
6799	etc.). If there is a mismatch, the behavior of the virtual machine
6800	is undefined.
6801	</note>
6802	<result name="VBOX_E_INVALID_VM_STATE">
6803	Virtual machine state neither PoweredOff nor Aborted.
6804	</result>
6805	</desc>
6806	<param name="savedStateFile" type="wstring" dir="in">
6807	<desc>Path to the saved state file to adopt.</desc>
6808	</param>
6809	</method>
6810
6811	<method name="forgetSavedState">
6812	<desc>
6813	Forgets the saved state of the virtual machine previously created
6814	by <link to="#saveState"/>. Next time the machine is powered up, a
6815	clean boot will occur. If @a remove is @c true the saved state file
6816	is deleted.
6817	<note>
6818	This operation is equivalent to resetting or powering off
6819	the machine without doing a proper shutdown in the guest OS.
6820	</note>
6821	<result name="VBOX_E_INVALID_VM_STATE">
6822	Virtual machine not in state Saved.
6823	</result>
6824	</desc>
6825	<param name="remove" type="boolean" dir="in">
6826	<desc>If @c true remove the saved state file.</desc>
6827	</param>
6828	</method>
6829
6830	<method name="getDeviceActivity">
6831	<desc>
6832	Gets the current activity type of a given device or device group.
6833	<result name="E_INVALIDARG">
6834	Invalid device type.
6835	</result>
6836	</desc>
6837	<param name="type" type="DeviceType" dir="in"/>
6838	<param name="activity" type="DeviceActivity" dir="return"/>
6839	</method>
6840
6841	<method name="attachUSBDevice">
6842	<desc>
6843	Attaches a host USB device with the given UUID to the
6844	USB controller of the virtual machine.
6845
6846	The device needs to be in one of the following states:
6847	<link to="USBDeviceState_Busy"/>,
6848	<link to="USBDeviceState_Available"/> or
6849	<link to="USBDeviceState_Held"/>,
6850	otherwise an error is immediately returned.
6851
6852	When the device state is
6853	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6854	be returned if the host computer refuses to release it for some reason.
6855
6856	<see>IUSBController::deviceFilters, USBDeviceState</see>
6857	<result name="VBOX_E_INVALID_VM_STATE">
6858	Virtual machine state neither Running nor Paused.
6859	</result>
6860	<result name="VBOX_E_PDM_ERROR">
6861	Virtual machine does not have a USB controller.
6862	</result>
6863	</desc>
6864	<param name="id" type="uuid" mod="string" dir="in">
6865	<desc>UUID of the host USB device to attach.</desc>
6866	</param>
6867	</method>
6868
6869	<method name="detachUSBDevice">
6870	<desc>
6871	Detaches an USB device with the given UUID from the USB controller
6872	of the virtual machine.
6873
6874	After this method succeeds, the VirtualBox server re-initiates
6875	all USB filters as if the device were just physically attached
6876	to the host, but filters of this machine are ignored to avoid
6877	a possible automatic re-attachment.
6878
6879	<see>IUSBController::deviceFilters, USBDeviceState</see>
6880
6881	<result name="VBOX_E_PDM_ERROR">
6882	Virtual machine does not have a USB controller.
6883	</result>
6884	<result name="E_INVALIDARG">
6885	USB device not attached to this virtual machine.
6886	</result>
6887	</desc>
6888	<param name="id" type="uuid" mod="string" dir="in">
6889	<desc>UUID of the USB device to detach.</desc>
6890	</param>
6891	<param name="device" type="IUSBDevice" dir="return">
6892	<desc>Detached USB device.</desc>
6893	</param>
6894	</method>
6895
6896	<method name="findUSBDeviceByAddress">
6897	<desc>
6898	Searches for a USB device with the given host address.
6899
6900	<result name="VBOX_E_OBJECT_NOT_FOUND">
6901	Given @c name does not correspond to any USB device.
6902	</result>
6903
6904	<see>IUSBDevice::address</see>
6905	</desc>
6906	<param name="name" type="wstring" dir="in">
6907	<desc>
6908	Address of the USB device (as assigned by the host) to
6909	search for.
6910	</desc>
6911	</param>
6912	<param name="device" type="IUSBDevice" dir="return">
6913	<desc>Found USB device object.</desc>
6914	</param>
6915	</method>
6916
6917	<method name="findUSBDeviceById">
6918	<desc>
6919	Searches for a USB device with the given UUID.
6920
6921	<result name="VBOX_E_OBJECT_NOT_FOUND">
6922	Given @c id does not correspond to any USB device.
6923	</result>
6924
6925	<see>IUSBDevice::id</see>
6926	</desc>
6927	<param name="id" type="uuid" mod="string" dir="in">
6928	<desc>UUID of the USB device to search for.</desc>
6929	</param>
6930	<param name="device" type="IUSBDevice" dir="return">
6931	<desc>Found USB device object.</desc>
6932	</param>
6933	</method>
6934
6935	<method name="createSharedFolder">
6936	<desc>
6937	Creates a transient new shared folder by associating the given logical
6938	name with the given host path, adds it to the collection of shared
6939	folders and starts sharing it. Refer to the description of
6940	<link to="ISharedFolder"/> to read more about logical names.
6941
6942	<result name="VBOX_E_INVALID_VM_STATE">
6943	Virtual machine in Saved state or currently changing state.
6944	</result>
6945	<result name="VBOX_E_FILE_ERROR">
6946	Shared folder already exists or not accessible.
6947	</result>
6948	</desc>
6949	<param name="name" type="wstring" dir="in">
6950	<desc>Unique logical name of the shared folder.</desc>
6951	</param>
6952	<param name="hostPath" type="wstring" dir="in">
6953	<desc>Full path to the shared folder in the host file system.</desc>
6954	</param>
6955	<param name="writable" type="boolean" dir="in">
6956	<desc>Whether the share is writable or readonly</desc>
6957	</param>
6958	</method>
6959
6960	<method name="removeSharedFolder">
6961	<desc>
6962	Removes a transient shared folder with the given name previously
6963	created by <link to="#createSharedFolder"/> from the collection of
6964	shared folders and stops sharing it.
6965	<result name="VBOX_E_INVALID_VM_STATE">
6966	Virtual machine in Saved state or currently changing state.
6967	</result>
6968	<result name="VBOX_E_FILE_ERROR">
6969	Shared folder does not exists.
6970	</result>
6971	</desc>
6972	<param name="name" type="wstring" dir="in">
6973	<desc>Logical name of the shared folder to remove.</desc>
6974	</param>
6975	</method>
6976
6977	<method name="takeSnapshot">
6978	<desc>
6979	Saves the current execution state
6980	and all settings of the machine and creates differencing images
6981	for all normal (non-independent) media.
6982	See <link to="ISnapshot" /> for an introduction to snapshots.
6983
6984	This method can be called for a PoweredOff, Saved (see
6985	<link to="#saveState"/>), Running or
6986	Paused virtual machine. When the machine is PoweredOff, an
6987	offline snapshot is created. When the machine is Running a live
6988	snapshot is created, and an online snapshot is is created when Paused.
6989
6990	The taken snapshot is always based on the
6991	<link to="IMachine::currentSnapshot">current snapshot</link>
6992	of the associated virtual machine and becomes a new current snapshot.
6993
6994	<note>
6995	This method implicitly calls <link to="IMachine::saveSettings"/> to
6996	save all current machine settings before taking an offline snapshot.
6997	</note>
6998
6999	<result name="VBOX_E_INVALID_VM_STATE">
7000	Virtual machine currently changing state.
7001	</result>
7002	</desc>
7003	<param name="name" type="wstring" dir="in">
7004	<desc>Short name for the snapshot.</desc>
7005	</param>
7006	<param name="description" type="wstring" dir="in">
7007	<desc>Optional description of the snapshot.</desc>
7008	</param>
7009	<param name="progress" type="IProgress" dir="return">
7010	<desc>Progress object to track the operation completion.</desc>
7011	</param>
7012	</method>
7013
7014	<method name="deleteSnapshot">
7015	<desc>
7016	Starts deleting the specified snapshot asynchronously.
7017	See <link to="ISnapshot" /> for an introduction to snapshots.
7018
7019	The execution state and settings of the associated machine stored in
7020	the snapshot will be deleted. The contents of all differencing media of
7021	this snapshot will be merged with the contents of their dependent child
7022	media to keep the medium chain valid (in other words, all changes
7023	represented by media being discarded will be propagated to their child
7024	medium). After that, this snapshot's differencing medium will be
7025	deleted. The parent of this snapshot will become a new parent for all
7026	its child snapshots.
7027
7028	If the deleted snapshot is the current one, its parent snapshot will
7029	become a new current snapshot. The current machine state is not directly
7030	affected in this case, except that currently attached differencing
7031	media based on media of the discarded snapshot will be also merged as
7032	described above.
7033
7034	If the deleted snapshot is the first or current snapshot, then the
7035	respective IMachine attributes will be adjusted. Deleting the current
7036	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7037	to make all current machine settings permanent.
7038
7039	Deleting a snapshot has the following preconditions:
7040
7041	<ul>
7042	<li>Child media of all normal media of the discarded snapshot
7043	must be accessible (see <link to="IMedium::state"/>) for this
7044	operation to succeed. In particular, this means that all virtual
7045	machines, whose media are directly or indirectly based on the
7046	media of discarded snapshot, must be powered off.</li>
7047
7048	<li>You cannot delete the snapshot if a medium attached to it has
7049	more than once child medium (differencing images) because otherwise
7050	merging would be impossible. This might be the case if there is
7051	more than one child snapshot or differencing images were created
7052	for other reason (e.g. implicitly because of multiple machine
7053	attachments).</li>
7054	</ul>
7055
7056
7057	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7058	while this operation is in progress.
7059
7060	<note>
7061	Merging medium contents can be very time and disk space
7062	consuming, if these media are big in size and have many
7063	children. However, if the snapshot being discarded is the last
7064	(head) snapshot on the branch, the operation will be rather
7065	quick.
7066	</note>
7067	<result name="VBOX_E_INVALID_VM_STATE">
7068	Virtual machine is running.
7069	</result>
7070	</desc>
7071	<param name="id" type="uuid" mod="string" dir="in">
7072	<desc>UUID of the snapshot to discard.</desc>
7073	</param>
7074	<param name="progress" type="IProgress" dir="return">
7075	<desc>Progress object to track the operation completion.</desc>
7076	</param>
7077	</method>
7078
7079	<method name="restoreSnapshot">
7080	<desc>
7081	Starts resetting the machine's current state to the state contained
7082	in the given snapshot, asynchronously. All current settings of the
7083	machine will be reset and changes stored in differencing media
7084	will be lost.
7085	See <link to="ISnapshot" /> for an introduction to snapshots.
7086
7087	After this operation is successfully completed, new empty differencing
7088	media are created for all normal media of the machine.
7089
7090	If the given snapshot is an online snapshot, the machine will go to
7091	the <link to="MachineState_Saved"> saved state</link>, so that the
7092	next time it is powered on, the execution state will be restored
7093	from the state of the snapshot.
7094
7095	<note>
7096	The machine must not be running, otherwise the operation will fail.
7097	</note>
7098
7099	<note>
7100	If the machine state is <link to="MachineState_Saved">Saved</link>
7101	prior to this operation, the saved state file will be implicitly
7102	discarded (as if <link to="IConsole::forgetSavedState"/> were
7103	called).
7104	</note>
7105
7106	<result name="VBOX_E_INVALID_VM_STATE">
7107	Virtual machine is running.
7108	</result>
7109	</desc>
7110	<param name="snapshot" type="ISnapshot" dir="in">
7111	<desc>The snapshot to restore the VM state from.</desc>
7112	</param>
7113	<param name="progress" type="IProgress" dir="return">
7114	<desc>Progress object to track the operation completion.</desc>
7115	</param>
7116	</method>
7117
7118	<method name="teleport">
7119	<desc>
7120	Teleport the VM to a different host machine or process.
7121
7122	TODO explain the details.
7123
7124	<result name="VBOX_E_INVALID_VM_STATE">
7125	Virtual machine not running or paused.
7126	</result>
7127	</desc>
7128	<param name="hostname" type="wstring" dir="in">
7129	<desc>The name or IP of the host to teleport to.</desc>
7130	</param>
7131	<param name="tcpport" type="unsigned long" dir="in">
7132	<desc>The TCP port to connect to (1..65535).</desc>
7133	</param>
7134	<param name="password" type="wstring" dir="in">
7135	<desc>The password.</desc>
7136	</param>
7137	<param name="maxDowntime" type="unsigned long" dir="in">
7138	<desc>
7139	The maximum allowed downtime given as milliseconds. 0 is not a valid
7140	value. Recommended value: 250 ms.
7141
7142	The higher the value is, the greater the chance for a successful
7143	teleportation. A small value may easily result in the teleportation
7144	process taking hours and eventually fail.
7145
7146	<note>
7147	The current implementation treats this a guideline, not as an
7148	absolute rule.
7149	</note>
7150	</desc>
7151	</param>
7152	<param name="progress" type="IProgress" dir="return">
7153	<desc>Progress object to track the operation completion.</desc>
7154	</param>
7155	</method>
7156
7157	<method name="registerCallback">
7158	<desc>
7159	Registers a new console callback on this instance. The methods of the
7160	callback interface will be called by this instance when the appropriate
7161	event occurs.
7162	</desc>
7163	<param name="callback" type="IConsoleCallback" dir="in"/>
7164	</method>
7165
7166	<method name="unregisterCallback">
7167	<desc>
7168	Unregisters the console callback previously registered using
7169	<link to="#registerCallback"/>.
7170	<result name="E_INVALIDARG">
7171	Given @a callback handler is not registered.
7172	</result>
7173	</desc>
7174	<param name="callback" type="IConsoleCallback" dir="in"/>
7175	</method>
7176	</interface>
7177
7178	<!--
7179	// IHost
7180	/////////////////////////////////////////////////////////////////////////
7181	-->
7182
7183	<enum
7184	name="HostNetworkInterfaceMediumType"
7185	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7186	>
7187	<desc>
7188	Type of encapsulation. Ethernet encapsulation includes both wired and
7189	wireless Ethernet connections.
7190	<see>IHostNetworkInterface</see>
7191	</desc>
7192
7193	<const name="Unknown" value="0">
7194	<desc>
7195	The type of interface cannot be determined.
7196	</desc>
7197	</const>
7198	<const name="Ethernet" value="1">
7199	<desc>
7200	Ethernet frame encapsulation.
7201	</desc>
7202	</const>
7203	<const name="PPP" value="2">
7204	<desc>
7205	Point-to-point protocol encapsulation.
7206	</desc>
7207	</const>
7208	<const name="SLIP" value="3">
7209	<desc>
7210	Serial line IP encapsulation.
7211	</desc>
7212	</const>
7213	</enum>
7214
7215	<enum
7216	name="HostNetworkInterfaceStatus"
7217	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7218	>
7219	<desc>
7220	Current status of the interface.
7221	<see>IHostNetworkInterface</see>
7222	</desc>
7223
7224	<const name="Unknown" value="0">
7225	<desc>
7226	The state of interface cannot be determined.
7227	</desc>
7228	</const>
7229	<const name="Up" value="1">
7230	<desc>
7231	The interface is fully operational.
7232	</desc>
7233	</const>
7234	<const name="Down" value="2">
7235	<desc>
7236	The interface is not functioning.
7237	</desc>
7238	</const>
7239	</enum>
7240
7241	<enum
7242	name="HostNetworkInterfaceType"
7243	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7244	>
7245	<desc>
7246	Network interface type.
7247	</desc>
7248	<const name="Bridged" value="1"/>
7249	<const name="HostOnly" value="2"/>
7250	</enum>
7251
7252	<interface
7253	name="IHostNetworkInterface" extends="$unknown"
7254	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7255	wsmap="managed"
7256	>
7257	<desc>
7258	Represents one of host's network interfaces. IP V6 address and network
7259	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7260	separated by colons.
7261	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7262	</desc>
7263	<attribute name="name" type="wstring" readonly="yes">
7264	<desc>Returns the host network interface name.</desc>
7265	</attribute>
7266
7267	<attribute name="id" type="uuid" mod="string" readonly="yes">
7268	<desc>Returns the interface UUID.</desc>
7269	</attribute>
7270
7271	<attribute name="networkName" type="wstring" readonly="yes">
7272	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7273	</attribute>
7274
7275	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7276	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7277	</attribute>
7278
7279	<attribute name="IPAddress" type="wstring" readonly="yes">
7280	<desc>Returns the IP V4 address of the interface.</desc>
7281	</attribute>
7282
7283	<attribute name="networkMask" type="wstring" readonly="yes">
7284	<desc>Returns the network mask of the interface.</desc>
7285	</attribute>
7286
7287	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7288	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7289	</attribute>
7290
7291	<attribute name="IPV6Address" type="wstring" readonly="yes">
7292	<desc>Returns the IP V6 address of the interface.</desc>
7293	</attribute>
7294
7295	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7296	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7297	</attribute>
7298
7299	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7300	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7301	</attribute>
7302
7303	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7304	<desc>Type of protocol encapsulation used.</desc>
7305	</attribute>
7306
7307	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7308	<desc>Status of the interface.</desc>
7309	</attribute>
7310
7311	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7312	<desc>specifies the host interface type.</desc>
7313	</attribute>
7314
7315	<method name="enableStaticIpConfig">
7316	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7317	<param name="IPAddress" type="wstring" dir="in">
7318	<desc>
7319	IP address.
7320	</desc>
7321	</param>
7322	<param name="networkMask" type="wstring" dir="in">
7323	<desc>
7324	network mask.
7325	</desc>
7326	</param>
7327	</method>
7328
7329	<method name="enableStaticIpConfigV6">
7330	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7331	<param name="IPV6Address" type="wstring" dir="in">
7332	<desc>
7333	IP address.
7334	</desc>
7335	</param>
7336	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7337	<desc>
7338	network mask.
7339	</desc>
7340	</param>
7341	</method>
7342
7343	<method name="enableDynamicIpConfig">
7344	<desc>enables the dynamic IP configuration.</desc>
7345	</method>
7346
7347	<method name="dhcpRediscover">
7348	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7349	</method>
7350
7351	</interface>
7352
7353	<interface
7354	name="IHost" extends="$unknown"
7355	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7356	wsmap="managed"
7357	>
7358	<desc>
7359	The IHost interface represents the physical machine that this VirtualBox
7360	installation runs on.
7361
7362	An object implementing this interface is returned by the
7363	<link to="IVirtualBox::host" /> attribute. This interface contains
7364	read-only information about the host's physical hardware (such as what
7365	processors and disks are available, what the host operating system is,
7366	and so on) and also allows for manipulating some of the host's hardware,
7367	such as global USB device filters and host interface networking.
7368
7369	</desc>
7370	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7371	<desc>List of DVD drives available on the host.</desc>
7372	</attribute>
7373
7374	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7375	<desc>List of floppy drives available on the host.</desc>
7376	</attribute>
7377
7378	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7379	<desc>
7380	List of USB devices currently attached to the host.
7381	Once a new device is physically attached to the host computer,
7382	it appears in this list and remains there until detached.
7383
7384	<note>
7385	If USB functionality is not available in the given edition of
7386	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7387	</note>
7388	</desc>
7389	</attribute>
7390
7391	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7392	<desc>
7393	List of USB device filters in action.
7394	When a new device is physically attached to the host computer,
7395	filters from this list are applied to it (in order they are stored
7396	in the list). The first matched filter will determine the
7397	<link to="IHostUSBDeviceFilter::action">action</link>
7398	performed on the device.
7399
7400	Unless the device is ignored by these filters, filters of all
7401	currently running virtual machines
7402	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7403
7404	<note>
7405	If USB functionality is not available in the given edition of
7406	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7407	</note>
7408
7409	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7410	</desc>
7411	</attribute>
7412
7413	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7414	<desc>List of host network interfaces currently defined on the host.</desc>
7415	</attribute>
7416
7417	<attribute name="processorCount" type="unsigned long" readonly="yes">
7418	<desc>Number of (logical) CPUs installed in the host system.</desc>
7419	</attribute>
7420
7421	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7422	<desc>Number of (logical) CPUs online in the host system.</desc>
7423	</attribute>
7424
7425	<method name="getProcessorSpeed">
7426	<desc>Query the (approximate) maximum speed of a specified host CPU in
7427	Megahertz.
7428	</desc>
7429	<param name="cpuId" type="unsigned long" dir="in">
7430	<desc>
7431	Identifier of the CPU.
7432	</desc>
7433	</param>
7434	<param name="speed" type="unsigned long" dir="return">
7435	<desc>
7436	Speed value. 0 is returned if value is not known or @a cpuId is
7437	invalid.
7438	</desc>
7439	</param>
7440	</method>
7441
7442	<method name="getProcessorFeature">
7443	<desc>Query whether a CPU feature is supported or not.</desc>
7444	<param name="feature" type="ProcessorFeature" dir="in">
7445	<desc>
7446	CPU Feature identifier.
7447	</desc>
7448	</param>
7449	<param name="supported" type="boolean" dir="return">
7450	<desc>
7451	Feature is supported or not.
7452	</desc>
7453	</param>
7454	</method>
7455
7456	<method name="getProcessorDescription">
7457	<desc>Query the model string of a specified host CPU.
7458	</desc>
7459	<param name="cpuId" type="unsigned long" dir="in">
7460	<desc>
7461	Identifier of the CPU.
7462	<note>
7463	The current implementation might not necessarily return the
7464	description for this exact CPU.
7465	</note>
7466	</desc>
7467	</param>
7468	<param name="description" type="wstring" dir="return">
7469	<desc>
7470	Model string. An empty string is returned if value is not known or
7471	@a cpuId is invalid.
7472	</desc>
7473	</param>
7474	</method>
7475
7476	<method name="getProcessorCpuIdLeaf">
7477	<desc>
7478	Returns the CPU cpuid information for the specified leaf.
7479	</desc>
7480	<param name="cpuId" type="unsigned long" dir="in">
7481	<desc>
7482	Identifier of the CPU. The CPU most be online.
7483	<note>
7484	The current implementation might not necessarily return the
7485	description for this exact CPU.
7486	</note>
7487	</desc>
7488	</param>
7489	<param name="leaf" type="unsigned long" dir="in">
7490	<desc>
7491	Cpuid leaf index (eax).
7492	</desc>
7493	</param>
7494	<param name="subLeaf" type="unsigned long" dir="in">
7495	<desc>
7496	Cpuid leaf sub index (ecx). This currently only applies to cache
7497	information on Intel CPUs. Use 0 if retriving values for
7498	<link to="IMachine::setCpuIdLeaf"/>.
7499	</desc>
7500	</param>
7501	<param name="valEax" type="unsigned long" dir="out">
7502	<desc>
7503	Cpuid leaf value for register eax.
7504	</desc>
7505	</param>
7506	<param name="valEbx" type="unsigned long" dir="out">
7507	<desc>
7508	Cpuid leaf value for register ebx.
7509	</desc>
7510	</param>
7511	<param name="valEcx" type="unsigned long" dir="out">
7512	<desc>
7513	Cpuid leaf value for register ecx.
7514	</desc>
7515	</param>
7516	<param name="valEdx" type="unsigned long" dir="out">
7517	<desc>
7518	Cpuid leaf value for register edx.
7519	</desc>
7520	</param>
7521	</method>
7522
7523	<attribute name="memorySize" type="unsigned long" readonly="yes">
7524	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7525	</attribute>
7526
7527	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7528	<desc>Available system memory in the host system.</desc>
7529	</attribute>
7530
7531	<attribute name="operatingSystem" type="wstring" readonly="yes">
7532	<desc>Name of the host system's operating system.</desc>
7533	</attribute>
7534
7535	<attribute name="OSVersion" type="wstring" readonly="yes">
7536	<desc>Host operating system's version string.</desc>
7537	</attribute>
7538
7539	<attribute name="UTCTime" type="long long" readonly="yes">
7540	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7541	</attribute>
7542
7543	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7544	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7545	</attribute>
7546
7547	<method name="createHostOnlyNetworkInterface">
7548	<desc>
7549	Creates a new adapter for Host Only Networking.
7550	<result name="E_INVALIDARG">
7551	Host network interface @a name already exists.
7552	</result>
7553	</desc>
7554	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7555	<desc>
7556	Created host interface object.
7557	</desc>
7558	</param>
7559	<param name="progress" type="IProgress" dir="return">
7560	<desc>
7561	Progress object to track the operation completion.
7562	</desc>
7563	</param>
7564	</method>
7565
7566	<method name="removeHostOnlyNetworkInterface">
7567	<desc>
7568	Removes the given Host Only Networking interface.
7569	<result name="VBOX_E_OBJECT_NOT_FOUND">
7570	No host network interface matching @a id found.
7571	</result>
7572	</desc>
7573	<param name="id" type="uuid" mod="string" dir="in">
7574	<desc>
7575	Adapter GUID.
7576	</desc>
7577	</param>
7578	<param name="progress" type="IProgress" dir="return">
7579	<desc>
7580	Progress object to track the operation completion.
7581	</desc>
7582	</param>
7583	</method>
7584
7585	<method name="createUSBDeviceFilter">
7586	<desc>
7587	Creates a new USB device filter. All attributes except
7588	the filter name are set to empty (any match),
7589	<i>active</i> is @c false (the filter is not active).
7590
7591	The created filter can be added to the list of filters using
7592	<link to="#insertUSBDeviceFilter"/>.
7593
7594	<see>#USBDeviceFilters</see>
7595	</desc>
7596	<param name="name" type="wstring" dir="in">
7597	<desc>
7598	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7599	for more info.
7600	</desc>
7601	</param>
7602	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7603	<desc>Created filter object.</desc>
7604	</param>
7605	</method>
7606
7607	<method name="insertUSBDeviceFilter">
7608	<desc>
7609	Inserts the given USB device to the specified position
7610	in the list of filters.
7611
7612	Positions are numbered starting from @c 0. If the specified
7613	position is equal to or greater than the number of elements in
7614	the list, the filter is added at the end of the collection.
7615
7616	<note>
7617	Duplicates are not allowed, so an attempt to insert a
7618	filter already in the list is an error.
7619	</note>
7620	<note>
7621	If USB functionality is not available in the given edition of
7622	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7623	</note>
7624
7625	<see>#USBDeviceFilters</see>
7626
7627	<result name="VBOX_E_INVALID_OBJECT_STATE">
7628	USB device filter is not created within this VirtualBox instance.
7629	</result>
7630	<result name="E_INVALIDARG">
7631	USB device filter already in list.
7632	</result>
7633
7634	</desc>
7635	<param name="position" type="unsigned long" dir="in">
7636	<desc>Position to insert the filter to.</desc>
7637	</param>
7638	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7639	<desc>USB device filter to insert.</desc>
7640	</param>
7641	</method>
7642
7643	<method name="removeUSBDeviceFilter">
7644	<desc>
7645	Removes a USB device filter from the specified position in the
7646	list of filters.
7647
7648	Positions are numbered starting from @c 0. Specifying a
7649	position equal to or greater than the number of elements in
7650	the list will produce an error.
7651
7652	<note>
7653	If USB functionality is not available in the given edition of
7654	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7655	</note>
7656
7657	<see>#USBDeviceFilters</see>
7658
7659	<result name="E_INVALIDARG">
7660	USB device filter list empty or invalid @a position.
7661	</result>
7662
7663	</desc>
7664	<param name="position" type="unsigned long" dir="in">
7665	<desc>Position to remove the filter from.</desc>
7666	</param>
7667	</method>
7668
7669	<method name="findHostDVDDrive">
7670	<desc>
7671	Searches for a host DVD drive with the given @c name.
7672
7673	<result name="VBOX_E_OBJECT_NOT_FOUND">
7674	Given @c name does not correspond to any host drive.
7675	</result>
7676
7677	</desc>
7678	<param name="name" type="wstring" dir="in">
7679	<desc>Name of the host drive to search for</desc>
7680	</param>
7681	<param name="drive" type="IMedium" dir="return">
7682	<desc>Found host drive object</desc>
7683	</param>
7684	</method>
7685
7686	<method name="findHostFloppyDrive">
7687	<desc>
7688	Searches for a host floppy drive with the given @c name.
7689
7690	<result name="VBOX_E_OBJECT_NOT_FOUND">
7691	Given @c name does not correspond to any host floppy drive.
7692	</result>
7693
7694	</desc>
7695	<param name="name" type="wstring" dir="in">
7696	<desc>Name of the host floppy drive to search for</desc>
7697	</param>
7698	<param name="drive" type="IMedium" dir="return">
7699	<desc>Found host floppy drive object</desc>
7700	</param>
7701	</method>
7702
7703	<method name="findHostNetworkInterfaceByName">
7704	<desc>
7705	Searches through all host network interfaces for an interface with
7706	the given @c name.
7707	<note>
7708	The method returns an error if the given @c name does not
7709	correspond to any host network interface.
7710	</note>
7711	</desc>
7712	<param name="name" type="wstring" dir="in">
7713	<desc>Name of the host network interface to search for.</desc>
7714	</param>
7715	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7716	<desc>Found host network interface object.</desc>
7717	</param>
7718	</method>
7719	<method name="findHostNetworkInterfaceById">
7720	<desc>
7721	Searches through all host network interfaces for an interface with
7722	the given GUID.
7723	<note>
7724	The method returns an error if the given GUID does not
7725	correspond to any host network interface.
7726	</note>
7727	</desc>
7728	<param name="id" type="uuid" mod="string" dir="in">
7729	<desc>GUID of the host network interface to search for.</desc>
7730	</param>
7731	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7732	<desc>Found host network interface object.</desc>
7733	</param>
7734	</method>
7735	<method name="findHostNetworkInterfacesOfType">
7736	<desc>
7737	Searches through all host network interfaces and returns a list of interfaces of the specified type
7738	</desc>
7739	<param name="type" type="HostNetworkInterfaceType" dir="in">
7740	<desc>type of the host network interfaces to search for.</desc>
7741	</param>
7742	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7743	<desc>Found host network interface objects.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="findUSBDeviceById">
7748	<desc>
7749	Searches for a USB device with the given UUID.
7750
7751	<result name="VBOX_E_OBJECT_NOT_FOUND">
7752	Given @c id does not correspond to any USB device.
7753	</result>
7754
7755	<see>IHostUSBDevice::id</see>
7756	</desc>
7757	<param name="id" type="uuid" mod="string" dir="in">
7758	<desc>UUID of the USB device to search for.</desc>
7759	</param>
7760	<param name="device" type="IHostUSBDevice" dir="return">
7761	<desc>Found USB device object.</desc>
7762	</param>
7763	</method>
7764
7765	<method name="findUSBDeviceByAddress">
7766	<desc>
7767	Searches for a USB device with the given host address.
7768
7769	<result name="VBOX_E_OBJECT_NOT_FOUND">
7770	Given @c name does not correspond to any USB device.
7771	</result>
7772
7773	<see>IHostUSBDevice::address</see>
7774	</desc>
7775	<param name="name" type="wstring" dir="in">
7776	<desc>
7777	Address of the USB device (as assigned by the host) to
7778	search for.
7779	</desc>
7780	</param>
7781	<param name="device" type="IHostUSBDevice" dir="return">
7782	<desc>Found USB device object.</desc>
7783	</param>
7784	</method>
7785
7786	</interface>
7787
7788	<!--
7789	// ISystemProperties
7790	/////////////////////////////////////////////////////////////////////////
7791	-->
7792
7793	<interface
7794	name="ISystemProperties"
7795	extends="$unknown"
7796	uuid="8030645c-8fef-4320-bb7b-c829f00069dc"
7797	wsmap="managed"
7798	>
7799	<desc>
7800	The ISystemProperties interface represents global properties of the given
7801	VirtualBox installation.
7802
7803	These properties define limits and default values for various attributes
7804	and parameters. Most of the properties are read-only, but some can be
7805	changed by a user.
7806	</desc>
7807
7808	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7809	<desc>Minimum guest system memory in Megabytes.</desc>
7810	</attribute>
7811
7812	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7813	<desc>Maximum guest system memory in Megabytes.</desc>
7814	</attribute>
7815
7816	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7817	<desc>Minimum guest video memory in Megabytes.</desc>
7818	</attribute>
7819
7820	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7821	<desc>Maximum guest video memory in Megabytes.</desc>
7822	</attribute>
7823
7824	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7825	<desc>Minimum CPU count.</desc>
7826	</attribute>
7827
7828	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7829	<desc>Maximum CPU count.</desc>
7830	</attribute>
7831
7832	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7833	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7834	</attribute>
7835
7836	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7837	<desc>
7838	Number of network adapters associated with every
7839	<link to="IMachine"/> instance.
7840	</desc>
7841	</attribute>
7842
7843	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7844	<desc>
7845	Number of serial ports associated with every
7846	<link to="IMachine"/> instance.
7847	</desc>
7848	</attribute>
7849
7850	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7851	<desc>
7852	Number of parallel ports associated with every
7853	<link to="IMachine"/> instance.
7854	</desc>
7855	</attribute>
7856
7857	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7858	<desc>
7859	Maximum device position in the boot order. This value corresponds
7860	to the total number of devices a machine can boot from, to make it
7861	possible to include all possible devices to the boot list.
7862	<see><link to="IMachine::setBootOrder"/></see>
7863	</desc>
7864	</attribute>
7865
7866	<attribute name="defaultMachineFolder" type="wstring">
7867	<desc>
7868	Full path to the default directory used to create new or open
7869	existing machines when a settings file name contains no
7870	path.
7871
7872	The initial value of this property is
7873	<tt><</tt><link to="IVirtualBox::homeFolder">
7874	VirtualBox_home</link><tt>>/Machines</tt>.
7875
7876	<note>
7877	Setting this property to @c null or an empty string will restore the
7878	initial value.
7879	</note>
7880	<note>
7881	When settings this property, the specified path can be
7882	absolute (full path) or relative
7883	to the <link to="IVirtualBox::homeFolder">
7884	VirtualBox home directory</link>.
7885	When reading this property, a full path is
7886	always returned.
7887	</note>
7888	<note>
7889	The specified path may not exist, it will be created
7890	when necessary.
7891	</note>
7892
7893	<see>
7894	<link to="IVirtualBox::createMachine"/>,
7895	<link to="IVirtualBox::openMachine"/>
7896	</see>
7897	</desc>
7898	</attribute>
7899
7900	<attribute name="defaultHardDiskFolder" type="wstring">
7901	<desc>
7902	Full path to the default directory used to create new or open existing
7903	virtual disks.
7904
7905	This path is used when the storage unit of a hard disk is a regular file
7906	in the host's file system and only a file name that contains no path is
7907	given.
7908
7909	The initial value of this property is
7910	<tt><</tt>
7911	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7912	<tt>>/HardDisks</tt>.
7913
7914	<note>
7915	Setting this property to @c null or empty string will restore the
7916	initial value.
7917	</note>
7918	<note>
7919	When settings this property, the specified path can be relative
7920	to the
7921	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7922	absolute. When reading this property, a full path is
7923	always returned.
7924	</note>
7925	<note>
7926	The specified path may not exist, it will be created
7927	when necessary.
7928	</note>
7929
7930	<see>
7931	IMedium,
7932	<link to="IVirtualBox::createHardDisk"/>,
7933	<link to="IVirtualBox::openHardDisk"/>,
7934	<link to="IMedium::location"/>
7935	</see>
7936	</desc>
7937	</attribute>
7938
7939	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7940	<desc>
7941	List of all medium storage formats supported by this VirtualBox
7942	installation.
7943
7944	Keep in mind that the medium format identifier
7945	(<link to="IMediumFormat::id"/>) used in other API calls like
7946	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7947	medium format is a case-insensitive string. This means that, for
7948	example, all of the following strings:
7949	<pre>
7950	"VDI"
7951	"vdi"
7952	"VdI"</pre>
7953	refer to the same medium format.
7954
7955	Note that the virtual medium framework is backend-based, therefore
7956	the list of supported formats depends on what backends are currently
7957	installed.
7958
7959	<see>
7960	<link to="IMediumFormat"/>,
7961	</see>
7962	</desc>
7963	</attribute>
7964
7965	<attribute name="defaultHardDiskFormat" type="wstring">
7966	<desc>
7967	Identifier of the default medium format used by VirtualBox.
7968
7969	The medium format set by this attribute is used by VirtualBox
7970	when the medium format was not specified explicitly. One example is
7971	<link to="IVirtualBox::createHardDisk"/> with the empty
7972	format argument. A more complex example is implicit creation of
7973	differencing media when taking a snapshot of a virtual machine:
7974	this operation will try to use a format of the parent medium first
7975	and if this format does not support differencing media the default
7976	format specified by this argument will be used.
7977
7978	The list of supported medium formats may be obtained by the
7979	<link to="#mediaFormats"/> call. Note that the default medium
7980	format must have a capability to create differencing media;
7981	otherwise operations that create media implicitly may fail
7982	unexpectedly.
7983
7984	The initial value of this property is <tt>"VDI"</tt> in the current
7985	version of the VirtualBox product, but may change in the future.
7986
7987	<note>
7988	Setting this property to @c null or empty string will restore the
7989	initial value.
7990	</note>
7991
7992	<see>
7993	<link to="#mediaFormats"/>,
7994	<link to="IMediumFormat::id"/>,
7995	<link to="IVirtualBox::createHardDisk"/>
7996	</see>
7997	</desc>
7998	</attribute>
7999
8000	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8001	<desc>
8002	Library that provides authentication for VRDP clients. The library
8003	is used if a virtual machine's authentication type is set to "external"
8004	in the VM RemoteDisplay configuration.
8005
8006	The system library extension (".DLL" or ".so") must be omitted.
8007	A full path can be specified; if not, then the library must reside on the
8008	system's default library path.
8009
8010	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8011	of that name in one of the default VirtualBox library directories.
8012
8013	For details about VirtualBox authentication libraries and how to implement
8014	them, please refer to the VirtualBox manual.
8015
8016	<note>
8017	Setting this property to @c null or empty string will restore the
8018	initial value.
8019	</note>
8020	</desc>
8021	</attribute>
8022
8023	<attribute name="webServiceAuthLibrary" type="wstring">
8024	<desc>
8025	Library that provides authentication for webservice clients. The library
8026	is used if a virtual machine's authentication type is set to "external"
8027	in the VM RemoteDisplay configuration and will be called from
8028	within the <link to="IWebsessionManager::logon" /> implementation.
8029
8030	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8031	there is no per-VM setting for this, as the webservice is a global
8032	resource (if it is running). Only for this setting (for the webservice),
8033	setting this value to a literal <tt>"null"</tt> string disables authentication,
8034	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8035	no matter what user name and password are supplied.
8036
8037	The initial value of this property is <tt>"VRDPAuth"</tt>,
8038	meaning that the webservice will use the same authentication
8039	library that is used by default for VBoxVRDP (again, see
8040	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8041	The format and calling convention of authentication libraries
8042	is the same for the webservice as it is for VBoxVRDP.
8043
8044	<note>
8045	Setting this property to @c null or empty string will restore the
8046	initial value.
8047	</note>
8048	</desc>
8049	</attribute>
8050
8051	<attribute name="LogHistoryCount" type="unsigned long">
8052	<desc>
8053	This value specifies how many old release log files are kept.
8054	</desc>
8055	</attribute>
8056
8057	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8058	<desc>This value hold the default audio driver for the current
8059	system.</desc>
8060	</attribute>
8061
8062	<method name="getMaxDevicesPerPortForStorageBus">
8063	<desc>Returns the maximum number of devices which can be attached to a port
8064	for the given storage bus.</desc>
8065
8066	<param name="bus" type="StorageBus" dir="in">
8067	<desc>The storage bus type to get the value for.</desc>
8068	</param>
8069
8070	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8071	<desc>The maximum number of devices which can eb attached to the port for the given
8072	storage bus.</desc>
8073	</param>
8074	</method>
8075
8076	<method name="getMinPortCountForStorageBus">
8077	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8078
8079	<param name="bus" type="StorageBus" dir="in">
8080	<desc>The storage bus type to get the value for.</desc>
8081	</param>
8082
8083	<param name="minPortCount" type="unsigned long" dir="return">
8084	<desc>The minimum number of ports for the given storage bus.</desc>
8085	</param>
8086	</method>
8087
8088	<method name="getMaxPortCountForStorageBus">
8089	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8090
8091	<param name="bus" type="StorageBus" dir="in">
8092	<desc>The storage bus type to get the value for.</desc>
8093	</param>
8094
8095	<param name="maxPortCount" type="unsigned long" dir="return">
8096	<desc>The maximum number of ports for the given storage bus.</desc>
8097	</param>
8098	</method>
8099
8100	<method name="getMaxInstancesOfStorageBus">
8101	<desc>Returns the maximum number of storage bus instances which
8102	can be configured for each VM. This corresponds to the number of
8103	storage controllers one can have.</desc>
8104
8105	<param name="bus" type="StorageBus" dir="in">
8106	<desc>The storage bus type to get the value for.</desc>
8107	</param>
8108
8109	<param name="maxInstances" type="unsigned long" dir="return">
8110	<desc>The maximum number of instances for the given storage bus.</desc>
8111	</param>
8112	</method>
8113
8114	<method name="getDeviceTypesForStorageBus">
8115	<desc>Returns list of all the supported device types
8116	(<link to="DeviceType"/>) for the given type of storage
8117	bus.</desc>
8118
8119	<param name="bus" type="StorageBus" dir="in">
8120	<desc>The storage bus type to get the value for.</desc>
8121	</param>
8122
8123	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8124	<desc>The list of all supported device types for the given storage bus.</desc>
8125	</param>
8126	</method>
8127	</interface>
8128
8129	<!--
8130	// IGuest
8131	/////////////////////////////////////////////////////////////////////////
8132	-->
8133
8134	<interface
8135	name="IGuestOSType" extends="$unknown"
8136	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
8137	wsmap="struct"
8138	>
8139	<desc>
8140	</desc>
8141
8142	<attribute name="familyId" type="wstring" readonly="yes">
8143	<desc>Guest OS family identifier string.</desc>
8144	</attribute>
8145
8146	<attribute name="familyDescription" type="wstring" readonly="yes">
8147	<desc>Human readable description of the guest OS family.</desc>
8148	</attribute>
8149
8150	<attribute name="id" type="wstring" readonly="yes">
8151	<desc>Guest OS identifier string.</desc>
8152	</attribute>
8153
8154	<attribute name="description" type="wstring" readonly="yes">
8155	<desc>Human readable description of the guest OS.</desc>
8156	</attribute>
8157
8158	<attribute name="is64Bit" type="boolean" readonly="yes">
8159	<desc>Returns @c true if the given OS is 64-bit</desc>
8160	</attribute>
8161
8162	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8163	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8164	</attribute>
8165
8166	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8167	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8168	</attribute>
8169
8170	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8171	<desc>Recommended RAM size in Megabytes.</desc>
8172	</attribute>
8173
8174	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8175	<desc>Recommended video RAM size in Megabytes.</desc>
8176	</attribute>
8177
8178	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8179	<desc>Recommended hard disk size in Megabytes.</desc>
8180	</attribute>
8181
8182	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8183	<desc>Returns recommended network adapter for this OS type.</desc>
8184	</attribute>
8185	</interface>
8186
8187	<interface
8188	name="IGuest" extends="$unknown"
8189	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8190	wsmap="managed"
8191	>
8192	<desc>
8193	The IGuest interface represents information about the operating system
8194	running inside the virtual machine. Used in
8195	<link to="IConsole::guest"/>.
8196
8197	IGuest provides information about the guest operating system, whether
8198	Guest Additions are installed and other OS-specific virtual machine
8199	properties.
8200	</desc>
8201
8202	<attribute name="OSTypeId" type="wstring" readonly="yes">
8203	<desc>
8204	Identifier of the Guest OS type as reported by the Guest
8205	Additions.
8206	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8207	an IGuestOSType object representing details about the given
8208	Guest OS type.
8209	<note>
8210	If Guest Additions are not installed, this value will be
8211	the same as <link to="IMachine::OSTypeId"/>.
8212	</note>
8213	</desc>
8214	</attribute>
8215
8216	<attribute name="additionsActive" type="boolean" readonly="yes">
8217	<desc>
8218	Flag whether the Guest Additions are installed and active
8219	in which case their version will be returned by the
8220	<link to="#additionsVersion"/> property.
8221	</desc>
8222	</attribute>
8223
8224	<attribute name="additionsVersion" type="wstring" readonly="yes">
8225	<desc>
8226	Version of the Guest Additions (3 decimal numbers separated
8227	by dots) or empty when the Additions are not installed. The
8228	Additions may also report a version but yet not be active as
8229	the version might be refused by VirtualBox (incompatible) or
8230	other failures occurred.
8231	</desc>
8232	</attribute>
8233
8234	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8235	<desc>
8236	Flag whether seamless guest display rendering (seamless desktop
8237	integration) is supported.
8238	</desc>
8239	</attribute>
8240
8241	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8242	<desc>
8243	Flag whether the guest is in graphics mode. If it is not, then
8244	seamless rendering will not work, resize hints are not immediately
8245	acted on and guest display resizes are probably not initiated by
8246	the guest additions.
8247	</desc>
8248	</attribute>
8249
8250	<attribute name="memoryBalloonSize" type="unsigned long">
8251	<desc>Guest system memory balloon size in megabytes.</desc>
8252	</attribute>
8253
8254	<attribute name="statisticsUpdateInterval" type="unsigned long">
8255	<desc>Interval to update guest statistics in seconds.</desc>
8256	</attribute>
8257
8258	<method name="setCredentials">
8259	<desc>
8260	Store login credentials that can be queried by guest operating
8261	systems with Additions installed. The credentials are transient
8262	to the session and the guest may also choose to erase them. Note
8263	that the caller cannot determine whether the guest operating system
8264	has queried or made use of the credentials.
8265
8266	<result name="VBOX_E_VM_ERROR">
8267	VMM device is not available.
8268	</result>
8269
8270	</desc>
8271	<param name="userName" type="wstring" dir="in">
8272	<desc>User name string, can be empty</desc>
8273	</param>
8274	<param name="password" type="wstring" dir="in">
8275	<desc>Password string, can be empty</desc>
8276	</param>
8277	<param name="domain" type="wstring" dir="in">
8278	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8279	</param>
8280	<param name="allowInteractiveLogon" type="boolean" dir="in">
8281	<desc>
8282	Flag whether the guest should alternatively allow the user to
8283	interactively specify different credentials. This flag might
8284	not be supported by all versions of the Additions.
8285	</desc>
8286	</param>
8287	</method>
8288
8289	<method name="getStatistic">
8290	<desc>
8291	Query specified guest statistics as reported by the VirtualBox Additions.
8292	</desc>
8293	<param name="cpuId" type="unsigned long" dir="in">
8294	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8295	</param>
8296	<param name="statistic" type="GuestStatisticType" dir="in">
8297	<desc>Statistic type.</desc>
8298	</param>
8299	<param name="statVal" type="unsigned long" dir="return">
8300	<desc>Statistics value</desc>
8301	</param>
8302	</method>
8303
8304	</interface>
8305
8306
8307	<!--
8308	// IProgress
8309	/////////////////////////////////////////////////////////////////////////
8310	-->
8311
8312	<interface
8313	name="IProgress" extends="$unknown"
8314	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8315	wsmap="managed"
8316	>
8317	<desc>
8318	The IProgress interface is used to track and control
8319	asynchronous tasks within VirtualBox.
8320
8321	An instance of this is returned every time VirtualBox starts
8322	an asynchronous task (in other words, a separate thread) which
8323	continues to run after a method call returns. For example,
8324	<link to="IConsole::saveState" />, which saves the state of
8325	a running virtual machine, can take a long time to complete.
8326	To be able to display a progress bar, a user interface such as
8327	the VirtualBox graphical user interface can use the IProgress
8328	object returned by that method.
8329
8330	Note that IProgress is a "read-only" interface in the sense
8331	that only the VirtualBox internals behind the Main API can
8332	create and manipulate progress objects, whereas client code
8333	can only use the IProgress object to monitor a task's
8334	progress and, if <link to="#cancelable" /> is @c true,
8335	cancel the task by calling <link to="#cancel" />.
8336
8337	A task represented by IProgress consists of either one or
8338	several sub-operations that run sequentially, one by one (see
8339	<link to="#operation" /> and <link to="#operationCount" />).
8340	Every operation is identified by a number (starting from 0)
8341	and has a separate description.
8342
8343	You can find the individual percentage of completion of the current
8344	operation in <link to="#operationPercent" /> and the
8345	percentage of completion of the task as a whole
8346	in <link to="#percent" />.
8347
8348	Similarly, you can wait for the completion of a particular
8349	operation via <link to="#waitForOperationCompletion" /> or
8350	for the completion of the whole task via
8351	<link to="#waitForCompletion" />.
8352	</desc>
8353
8354	<attribute name="id" type="uuid" mod="string" readonly="yes">
8355	<desc>ID of the task.</desc>
8356	</attribute>
8357
8358	<attribute name="description" type="wstring" readonly="yes">
8359	<desc>Description of the task.</desc>
8360	</attribute>
8361
8362	<attribute name="initiator" type="$unknown" readonly="yes">
8363	<desc>Initiator of the task.</desc>
8364	</attribute>
8365
8366	<attribute name="cancelable" type="boolean" readonly="yes">
8367	<desc>Whether the task can be interrupted.</desc>
8368	</attribute>
8369
8370	<attribute name="percent" type="unsigned long" readonly="yes">
8371	<desc>
8372	Current progress value of the task as a whole, in percent.
8373	This value depends on how many operations are already complete.
8374	Returns 100 if <link to="#completed" /> is @c true.
8375	</desc>
8376	</attribute>
8377
8378	<attribute name="timeRemaining" type="long" readonly="yes">
8379	<desc>
8380	Estimated remaining time until the task completes, in
8381	seconds. Returns 0 once the task has completed; returns -1
8382	if the remaining time cannot be computed, in particular if
8383	the current progress is 0.
8384
8385	Even if a value is returned, the estimate will be unreliable
8386	for low progress values. It will become more reliable as the
8387	task progresses; it is not recommended to display an ETA
8388	before at least 20% of a task have completed.
8389	</desc>
8390	</attribute>
8391
8392	<attribute name="completed" type="boolean" readonly="yes">
8393	<desc>Whether the task has been completed.</desc>
8394	</attribute>
8395
8396	<attribute name="canceled" type="boolean" readonly="yes">
8397	<desc>Whether the task has been canceled.</desc>
8398	</attribute>
8399
8400	<attribute name="resultCode" type="long" readonly="yes">
8401	<desc>
8402	Result code of the progress task.
8403	Valid only if <link to="#completed"/> is @c true.
8404	</desc>
8405	</attribute>
8406
8407	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8408	<desc>
8409	Extended information about the unsuccessful result of the
8410	progress operation. May be @c null if no extended information
8411	is available.
8412	Valid only if <link to="#completed"/> is @c true and
8413	<link to="#resultCode"/> indicates a failure.
8414	</desc>
8415	</attribute>
8416
8417	<attribute name="operationCount" type="unsigned long" readonly="yes">
8418	<desc>
8419	Number of sub-operations this task is divided into.
8420	Every task consists of at least one suboperation.
8421	</desc>
8422	</attribute>
8423
8424	<attribute name="operation" type="unsigned long" readonly="yes">
8425	<desc>Number of the sub-operation being currently executed.</desc>
8426	</attribute>
8427
8428	<attribute name="operationDescription" type="wstring" readonly="yes">
8429	<desc>
8430	Description of the sub-operation being currently executed.
8431	</desc>
8432	</attribute>
8433
8434	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8435	<desc>Progress value of the current sub-operation only, in percent.</desc>
8436	</attribute>
8437
8438	<attribute name="timeout" type="unsigned long">
8439	<desc>
8440	When non-zero, this specifies the number of milliseconds after which
8441	the operation will automatically be canceled. This can only be set on
8442	cancelable objects.
8443	</desc>
8444	</attribute>
8445
8446	<method name="setCurrentOperationProgress">
8447	<desc>Internal method, not to be called externally.</desc>
8448	<param name="percent" type="unsigned long" dir="in" />
8449	</method>
8450	<method name="setNextOperation">
8451	<desc>Internal method, not to be called externally.</desc>
8452	<param name="nextOperationDescription" type="wstring" dir="in" />
8453	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8454	</method>
8455
8456	<method name="waitForCompletion">
8457	<desc>
8458	Waits until the task is done (including all sub-operations)
8459	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8460
8461	<result name="VBOX_E_IPRT_ERROR">
8462	Failed to wait for task completion.
8463	</result>
8464	</desc>
8465
8466	<param name="timeout" type="long" dir="in">
8467	<desc>
8468	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8469	</desc>
8470	</param>
8471	</method>
8472
8473	<method name="waitForOperationCompletion">
8474	<desc>
8475	Waits until the given operation is done with a given timeout in
8476	milliseconds; specify -1 for an indefinite wait.
8477
8478	<result name="VBOX_E_IPRT_ERROR">
8479	Failed to wait for operation completion.
8480	</result>
8481
8482	</desc>
8483	<param name="operation" type="unsigned long" dir="in">
8484	<desc>
8485	Number of the operation to wait for.
8486	Must be less than <link to="#operationCount"/>.
8487	</desc>
8488	</param>
8489	<param name="timeout" type="long" dir="in">
8490	<desc>
8491	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8492	</desc>
8493	</param>
8494	</method>
8495
8496	<method name="cancel">
8497	<desc>
8498	Cancels the task.
8499	<note>
8500	If <link to="#cancelable"/> is @c false, then this method will fail.
8501	</note>
8502
8503	<result name="VBOX_E_INVALID_OBJECT_STATE">
8504	Operation cannot be canceled.
8505	</result>
8506
8507	</desc>
8508	</method>
8509
8510	</interface>
8511
8512
8513	<!--
8514	// ISnapshot
8515	/////////////////////////////////////////////////////////////////////////
8516	-->
8517
8518	<interface
8519	name="ISnapshot" extends="$unknown"
8520	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8521	wsmap="managed"
8522	>
8523	<desc>
8524	The ISnapshot interface represents a snapshot of the virtual
8525	machine.
8526
8527	Together with the differencing media that are created
8528	when a snapshot is taken, a machine can be brought back to
8529	the exact state it was in when the snapshot was taken.
8530
8531	The ISnapshot interface has no methods, only attributes; snapshots
8532	are controlled through methods of the <link to="IConsole" /> interface
8533	which also manage the media associated with the snapshot.
8534	The following operations exist:
8535
8536	<ul>
8537	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8538	by creating new, empty differencing images for the machine's
8539	media and saving the VM settings and (if the VM is running)
8540	the current VM state in the snapshot.
8541
8542	The differencing images will then receive all data written to
8543	the machine's media, while their parent (base) images
8544	remain unmodified after the snapshot has been taken (see
8545	<link to="IMedium" /> for details about differencing images).
8546	This simplifies restoring a machine to the state of a snapshot:
8547	only the differencing images need to be deleted.
8548
8549	The current machine state is not changed by taking a snapshot.
8550	If the machine is running, it will resume execution after the
8551	snapshot has been taken.
8552	</li>
8553
8554	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8555	a previous snapshot. This resets the machine's state to that of
8556	the previous snapshot by deleting the differencing image of each
8557	of the machine's media and setting the machine's settings
8558	and state to the state that was saved in the snapshot (if any).
8559
8560	This destroys the machine's current state.
8561	</li>
8562
8563	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8564	without affecting the current machine state.
8565
8566	This does not change the machine, but instead frees the resources
8567	allocated when the snapshot was taken: the settings and machine state
8568	is deleted (if any), and the snapshot's differencing image for each
8569	of the machine's media gets merged with its parent image.
8570
8571	Neither the current machine state nor other snapshots are affected
8572	by this operation, except that parent media will be modified
8573	to contain the disk data associated with the snapshot being deleted.
8574	</li>
8575	</ul>
8576
8577	Each snapshot contains the settings of the virtual machine (hardware
8578	configuration etc.). In addition, if the machine was running when the
8579	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8580	the current VM state is saved in the snapshot (similarly to what happens
8581	when a VM's state is saved). The snapshot is then said to
8582	be <i>online</i> because when restoring it, the VM will be running.
8583
8584	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8585	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8586
8587	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8588	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8589	it then contains a so-called "zero execution state", representing a
8590	machine that is powered off.
8591
8592	<h3>Snapshot branches and the "current" snapshot</h3>
8593
8594	Snapshots can be chained, whereby every next snapshot is based on the
8595	previous one. This chaining is related to medium branching
8596	(see the <link to="IMedium"/> description) in that every time
8597	a new snapshot is created, a new differencing medium is implicitly
8598	created for all normal media attached to the machine.
8599
8600	Each virtual machine has a "current snapshot", identified by
8601	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8602	to the last snapshot in the chain. In a future version of VirtualBox,
8603	it will be possible to reset a machine's current state to that of an
8604	earlier snapshot without discarding the current state so that it will be
8605	possible to create alternative snapshot paths in a snapshot tree.
8606
8607	In the current implementation, multiple snapshot branches within one
8608	virtual machine are not allowed. Every machine has a single branch,
8609	and <link to="IConsole::takeSnapshot"/> operation adds a new
8610	snapshot to the top of that branch.
8611	</desc>
8612
8613	<attribute name="id" type="uuid" mod="string" readonly="yes">
8614	<desc>UUID of the snapshot.</desc>
8615	</attribute>
8616
8617	<attribute name="name" type="wstring">
8618	<desc>Short name of the snapshot.</desc>
8619	</attribute>
8620
8621	<attribute name="description" type="wstring">
8622	<desc>Optional description of the snapshot.</desc>
8623	</attribute>
8624
8625	<attribute name="timeStamp" type="long long" readonly="yes">
8626	<desc>
8627	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8628	</desc>
8629	</attribute>
8630
8631	<attribute name="online" type="boolean" readonly="yes">
8632	<desc>
8633	@c true if this snapshot is an online snapshot and @c false otherwise.
8634
8635	When this attribute is @c true, the
8636	<link to="IMachine::stateFilePath"/> attribute of the
8637	<link to="#machine"/> object associated with this snapshot
8638	will point to the saved state file. Otherwise, it will be
8639	an empty string.
8640	</desc>
8641	</attribute>
8642
8643	<attribute name="machine" type="IMachine" readonly="yes">
8644	<desc>
8645	Virtual machine this snapshot is taken on. This object
8646	stores all settings the machine had when taking this snapshot.
8647	<note>
8648	The returned machine object is immutable, i.e. no
8649	any settings can be changed.
8650	</note>
8651	</desc>
8652	</attribute>
8653
8654	<attribute name="parent" type="ISnapshot" readonly="yes">
8655	<desc>
8656	Parent snapshot (a snapshot this one is based on), or
8657	@c null if the snapshot has no parent (i.e. is the first snapshot).
8658	</desc>
8659	</attribute>
8660
8661	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8662	<desc>
8663	Child snapshots (all snapshots having this one as a parent).
8664	</desc>
8665	</attribute>
8666
8667	</interface>
8668
8669
8670	<!--
8671	// IMedium
8672	/////////////////////////////////////////////////////////////////////////
8673	-->
8674
8675	<enum
8676	name="MediumState"
8677	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8678	>
8679	<desc>
8680	Virtual medium state.
8681	<see>IMedium</see>
8682	</desc>
8683
8684	<const name="NotCreated" value="0">
8685	<desc>
8686	Associated medium storage does not exist (either was not created yet or
8687	was deleted).
8688	</desc>
8689	</const>
8690	<const name="Created" value="1">
8691	<desc>
8692	Associated storage exists and accessible; this gets set if the
8693	accessibility check performed by <link to="IMedium::refreshState" />
8694	was successful.
8695	</desc>
8696	</const>
8697	<const name="LockedRead" value="2">
8698	<desc>
8699	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8700	no data modification is possible.
8701	</desc>
8702	</const>
8703	<const name="LockedWrite" value="3">
8704	<desc>
8705	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8706	no concurrent data reading or modification is possible.
8707	</desc>
8708	</const>
8709	<const name="Inaccessible" value="4">
8710	<desc>
8711	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8712	not yet been performed, or else, associated medium storage is not
8713	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8714	is empty, in the second case, it describes the error that occured.
8715	</desc>
8716	</const>
8717	<const name="Creating" value="5">
8718	<desc>
8719	Associated medium storage is being created.
8720	</desc>
8721	</const>
8722	<const name="Deleting" value="6">
8723	<desc>
8724	Associated medium storage is being deleted.
8725	</desc>
8726	</const>
8727	</enum>
8728
8729	<enum
8730	name="MediumType"
8731	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8732	>
8733	<desc>
8734	Virtual medium type.
8735	<see>IMedium</see>
8736	</desc>
8737
8738	<const name="Normal" value="0">
8739	<desc>
8740	Normal medium (attached directly or indirectly, preserved
8741	when taking snapshots).
8742	</desc>
8743	</const>
8744	<const name="Immutable" value="1">
8745	<desc>
8746	Immutable medium (attached indirectly, changes are wiped out
8747	the next time the virtual machine is started).
8748	</desc>
8749	</const>
8750	<const name="Writethrough" value="2">
8751	<desc>
8752	Write through medium (attached directly, ignored when
8753	taking snapshots).
8754	</desc>
8755	</const>
8756	</enum>
8757
8758	<enum
8759	name="MediumVariant"
8760	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8761	>
8762	<desc>
8763	Virtual medium image variant. More than one flag may be set.
8764	<see>IMedium</see>
8765	</desc>
8766
8767	<const name="Standard" value="0">
8768	<desc>
8769	No particular variant requested, results in using the backend default.
8770	</desc>
8771	</const>
8772	<const name="VmdkSplit2G" value="0x01">
8773	<desc>
8774	VMDK image split in chunks of less than 2GByte.
8775	</desc>
8776	</const>
8777	<const name="VmdkStreamOptimized" value="0x04">
8778	<desc>
8779	VMDK streamOptimized image. Special import/export format which is
8780	read-only/append-only.
8781	</desc>
8782	</const>
8783	<const name="VmdkESX" value="0x08">
8784	<desc>
8785	VMDK format variant used on ESX products.
8786	</desc>
8787	</const>
8788	<const name="Fixed" value="0x10000">
8789	<desc>
8790	Fixed image. Only allowed for base images.
8791	</desc>
8792	</const>
8793	<const name="Diff" value="0x20000">
8794	<desc>
8795	Fixed image. Only allowed for base images.
8796	</desc>
8797	</const>
8798	</enum>
8799
8800	<interface
8801	name="IMediumAttachment" extends="$unknown"
8802	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
8803	wsmap="struct"
8804	>
8805	<desc>
8806	The IMediumAttachment interface represents the attachment
8807	of a storage medium to a virtual machine. Each machine contains
8808	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8809
8810	Each medium attachment specifies a storage controller as well as a port
8811	and device number. Fixed media (hard disks) will always also specify
8812	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8813	medium. For removeable media, the IMedia instance is optional; it can be
8814	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8815	</desc>
8816
8817	<attribute name="medium" type="IMedium" readonly="yes">
8818	<desc>Medium object associated with this attachment; it
8819	can be @c null for removable devices.</desc>
8820	</attribute>
8821
8822	<attribute name="controller" type="wstring" readonly="yes">
8823	<desc>Name of the storage controller of this attachment; this
8824	refers to one of the controllers in <link to="IMachine::storageControllers" />
8825	by name.</desc>
8826	</attribute>
8827
8828	<attribute name="port" type="long" readonly="yes">
8829	<desc>Port number of this attachment.</desc>
8830	</attribute>
8831
8832	<attribute name="device" type="long" readonly="yes">
8833	<desc>Device slot number of this attachment.</desc>
8834	</attribute>
8835
8836	<attribute name="type" type="DeviceType" readonly="yes">
8837	<desc>Device type of this attachment.</desc>
8838	</attribute>
8839
8840	<attribute name="passthrough" type="boolean" readonly="yes">
8841	<desc>Pass I/O requests through to a device on the host.</desc>
8842	</attribute>
8843
8844	</interface>
8845
8846	<interface
8847	name="IMedium" extends="$unknown"
8848	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
8849	wsmap="managed"
8850	>
8851	<desc>
8852	The IMedium interface represents virtual storage for a machine's
8853	hard disks, CD/DVD or floppy drives. It will typically represent
8854	a disk image on the host, for example a VDI or VMDK file representing
8855	a virtual hard disk, or an ISO or RAW file representing virtual
8856	removable media, but can also point to a network location (e.g.
8857	for iSCSI targets).
8858
8859	Instances of IMedium are connected to virtual machines by way of
8860	medium attachments (see <link to="IMediumAttachment" />), which link
8861	the storage medium to a particular device slot of a storage controller
8862	of the virtual machine.
8863	In the VirtualBox API, virtual storage is therefore always represented
8864	by the following chain of object links:
8865
8866	<ul>
8867	<li><link to="IMachine::storageControllers"/> contains an array of
8868	storage controllers (IDE, SATA, SCSI or a floppy controller;
8869	these are instances of <link to="IStorageController"/>).</li>
8870	<li><link to="IMachine::mediumAttachments"/> contains an array of
8871	medium attachments (instances of <link to="IMediumAttachment"/>),
8872	each containing a storage controller from the above array, a
8873	port/device specification, and an instance of IMedium representing
8874	the medium storage (image file).
8875
8876	For removable media, the storage medium is optional; a medium
8877	attachment with no medium represents a CD/DVD or floppy drive
8878	with no medium inserted. By contrast, hard disk attachments
8879	will always have an IMedium object attached.</li>
8880	<li>Each IMedium in turn points to a storage unit (such as a file
8881	on the host computer or a network resource) that holds actual
8882	data. This location is represented by the <link to="#location"/>
8883	attribute.</li>
8884	</ul>
8885
8886	Existing media are opened using the following methods, depending on the
8887	media type:
8888	<ul>
8889	<li><link to="IVirtualBox::openHardDisk"/></li>
8890	<li><link to="IVirtualBox::openDVDImage"/></li>
8891	<li><link to="IVirtualBox::openFloppyImage"/></li>
8892	</ul>
8893
8894	New hard disk media can be created with the VirtualBox API using the
8895	<link to="IVirtualBox::createHardDisk"/> method.
8896
8897	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8898	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8899	type in a regular file.
8900
8901	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8902	drive; in that case the <link to="#id" /> attribute contains the UUID of
8903	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8904
8905	<h3>Known media</h3>
8906
8907	When an existing medium is opened for the first time, it is automatically
8908	remembered by the given VirtualBox installation or, in other words, becomes
8909	a <i>known medium</i>. Known media are stored in the media
8910	registry transparently maintained by VirtualBox and stored in settings
8911	files so that this registry is preserved when VirtualBox is not running.
8912
8913	Newly created virtual media are remembered only when the associated
8914	storage unit is actually created.
8915
8916	All known media can be enumerated using
8917	<link to="IVirtualBox::hardDisks"/>,
8918	<link to="IVirtualBox::DVDImages"/> and
8919	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8920	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8921	and similar methods or by location using
8922	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8923
8924	Only known media can be attached to virtual machines.
8925
8926	Removing known media from the media registry is performed when the given
8927	medium is closed using the <link to="#close"/> method or when its
8928	associated storage unit is deleted.
8929
8930	<h3>Accessibility checks</h3>
8931
8932	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8933	method is called explicitly on a medium. This is done to make the VirtualBox object
8934	ready for serving requests as fast as possible and let the end-user
8935	application decide if it needs to check media accessibility right away or not.
8936
8937	As a result, when VirtualBox starts up (e.g. the VirtualBox
8938	object gets created for the first time), all known media are in the
8939	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8940	attribute is an empty string because no actual accessibility check has
8941	been made yet.
8942
8943	After calling <link to="#refreshState" />, a medium is considered
8944	<i>accessible</i> if its storage unit can be read. In that case, the
8945	<link to="#state"/> attribute has a value of "Created". If the storage
8946	unit cannot be read (for example, because it is located on a disconnected
8947	network resource, or was accidentally deleted outside VirtualBox),
8948	the medium is considered <i>inaccessible</i>, which is indicated by the
8949	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8950	obtained by reading the <link to="#lastAccessError"/> attribute.
8951
8952	<h3>Medium types</h3>
8953
8954	There are three types of medium behavior (see <link to="MediumType" />):
8955	"normal", "immutable" and "writethrough", represented by the
8956	<link to="#type"/> attribute. The type of the medium defines how the
8957	medium is attached to a virtual machine and what happens when a
8958	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8959	attached medium is taken. At the moment DVD and floppy media are always
8960	of type "writethrough".
8961
8962	All media can be also divided in two groups: <i>base</i> media and
8963	<i>differencing</i> media. A base medium contains all sectors of the
8964	medium data in its own storage and therefore can be used independently.
8965	In contrast, a differencing mediun is a "delta" to some other medium and
8966	contains only those sectors which differ from that other medium, which is
8967	then called a <i>parent</i>. The differencing medium is said to be
8968	<i>linked to</i> that parent. The parent may be itself a differencing
8969	medium, thus forming a chain of linked media. The last element in that
8970	chain must always be a base medium. Note that several differencing
8971	media may be linked to the same parent medium.
8972
8973	Differencing media can be distinguished from base media by querying the
8974	<link to="#parent"/> attribute: base media do not have parents they would
8975	depend on, so the value of this attribute is always @c null for them.
8976	Using this attribute, it is possible to walk up the medium tree (from the
8977	child medium to its parent). It is also possible to walk down the tree
8978	using the <link to="#children"/> attribute.
8979
8980	Note that the type of all differencing media is "Normal"; all other
8981	values are meaningless for them. Base media may be of any type.
8982
8983	<h3>Creating hard disks</h3>
8984
8985	New base hard disks are created using
8986	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8987	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8988	disks are usually implicitly created by VirtualBox when needed but may
8989	also be created explicitly using <link to="#createDiffStorage"/>.
8990
8991	After the hard disk is successfully created (including the storage unit)
8992	or opened, it becomes a known hard disk (remembered in the internal media
8993	registry). Known hard disks can be attached to a virtual machine, accessed
8994	through <link to="IVirtualBox::getHardDisk"/> and
8995	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8996	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8997
8998	The following methods, besides <link to="IMedium::close"/>,
8999	automatically remove the hard disk from the media registry:
9000	<ul>
9001	<li><link to="#deleteStorage"/></li>
9002	<li><link to="#mergeTo"/></li>
9003	</ul>
9004
9005	If the storage unit of the hard disk is a regular file in the host's
9006	file system then the rules stated in the description of the
9007	<link to="IMedium::location"/> attribute apply when setting its value. In
9008	addition, a plain file name without any path may be given, in which case
9009	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9010	folder</link> will be prepended to it.
9011
9012	<h4>Automatic composition of the file name part</h4>
9013
9014	Another extension to the <link to="IMedium::location"/> attribute is that
9015	there is a possibility to cause VirtualBox to compose a unique value for
9016	the file name part of the location using the UUID of the hard disk. This
9017	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9018	e.g. before the storage unit is created, and works as follows. You set the
9019	value of the <link to="IMedium::location"/> attribute to a location
9020	specification which only contains the path specification but not the file
9021	name part and ends with either a forward slash or a backslash character.
9022	In response, VirtualBox will generate a new UUID for the hard disk and
9023	compose the file name using the following pattern:
9024	<pre>
9025	<path>/{<uuid>}.<ext>
9026	</pre>
9027	where <tt><path></tt> is the supplied path specification,
9028	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9029	is the default extension for the storage format of this hard disk. After
9030	that, you may call any of the methods that create a new hard disk storage
9031	unit and they will use the generated UUID and file name.
9032
9033	<h3>Attaching Hard Disks</h3>
9034
9035	Hard disks are attached to virtual machines using the
9036	<link to="IMachine::attachDevice"/> method and detached using the
9037	<link to="IMachine::detachDevice"/> method. Depending on their
9038	<link to="#type"/>, hard disks are attached either
9039	<i>directly</i> or <i>indirectly</i>.
9040
9041	When a hard disk is being attached directly, it is associated with the
9042	virtual machine and used for hard disk operations when the machine is
9043	running. When a hard disk is being attached indirectly, a new differencing
9044	hard disk linked to it is implicitly created and this differencing hard
9045	disk is associated with the machine and used for hard disk operations.
9046	This also means that if <link to="IMachine::attachDevice"/> performs
9047	a direct attachment then the same hard disk will be returned in response
9048	to the subsequent <link to="IMachine::getMedium"/> call; however if
9049	an indirect attachment is performed then
9050	<link to="IMachine::getMedium"/> will return the implicitly created
9051	differencing hard disk, not the original one passed to <link
9052	to="IMachine::attachDevice"/>. In detail:
9053
9054	<ul>
9055	<li><b>Normal base</b> hard disks that do not have children (i.e.
9056	differencing hard disks linked to them) and that are not already
9057	attached to virtual machines in snapshots are attached <b>directly</b>.
9058	Otherwise, they are attached <b>indirectly</b> because having
9059	dependent children or being part of the snapshot makes it impossible
9060	to modify hard disk contents without breaking the integrity of the
9061	dependent party. The <link to="#readOnly"/> attribute allows to
9062	quickly determine the kind of the attachment for the given hard
9063	disk. Note that if a normal base hard disk is to be indirectly
9064	attached to a virtual machine with snapshots then a special
9065	procedure called <i>smart attachment</i> is performed (see below).</li>
9066	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9067	they are attached <b>directly</b> if they do not have children and are
9068	not attached to virtual machines in snapshots, and <b>indirectly</b>
9069	otherwise. Note that the smart attachment procedure is never performed
9070	for differencing hard disks.</li>
9071	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9072	they are designed to be non-writable. If an immutable hard disk is
9073	attached to a virtual machine with snapshots then a special
9074	procedure called smart attachment is performed (see below).</li>
9075	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9076	also as designed. This also means that writethrough hard disks cannot
9077	have other hard disks linked to them at all.</li>
9078	</ul>
9079
9080	Note that the same hard disk, regardless of its type, may be attached to
9081	more than one virtual machine at a time. In this case, the machine that is
9082	started first gains exclusive access to the hard disk and attempts to
9083	start other machines having this hard disk attached will fail until the
9084	first machine is powered down.
9085
9086	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9087	that the given hard disk remains associated with the given machine after a
9088	successful <link to="IMachine::detachDevice"/> call until
9089	<link to="IMachine::saveSettings"/> is called to save all changes to
9090	machine settings to disk. This deferring is necessary to guarantee that
9091	the hard disk configuration may be restored at any time by a call to
9092	<link to="IMachine::discardSettings"/> before the settings
9093	are saved (committed).
9094
9095	Note that if <link to="IMachine::discardSettings"/> is called after
9096	indirectly attaching some hard disks to the machine but before a call to
9097	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9098	all differencing hard disks implicitly created by
9099	<link to="IMachine::attachDevice"/> for these indirect attachments.
9100	Such implicitly created hard disks will also be immediately deleted when
9101	detached explicitly using the <link to="IMachine::detachDevice"/>
9102	call if it is made before <link to="IMachine::saveSettings"/>. This
9103	implicit deletion is safe because newly created differencing hard
9104	disks do not contain any user data.
9105
9106	However, keep in mind that detaching differencing hard disks that were
9107	implicitly created by <link to="IMachine::attachDevice"/>
9108	before the last <link to="IMachine::saveSettings"/> call will
9109	<b>not</b> implicitly delete them as they may already contain some data
9110	(for example, as a result of virtual machine execution). If these hard
9111	disks are no more necessary, the caller can always delete them explicitly
9112	using <link to="#deleteStorage"/> after they are actually de-associated
9113	from this machine by the <link to="IMachine::saveSettings"/> call.
9114
9115	<h3>Smart Attachment</h3>
9116
9117	When normal base or immutable hard disks are indirectly attached to a
9118	virtual machine then some additional steps are performed to make sure the
9119	virtual machine will have the most recent "view" of the hard disk being
9120	attached. These steps include walking through the machine's snapshots
9121	starting from the current one and going through ancestors up to the first
9122	snapshot. Hard disks attached to the virtual machine in all
9123	of the encountered snapshots are checked whether they are descendants of
9124	the given normal base or immutable hard disk. The first found child (which
9125	is the differencing hard disk) will be used instead of the normal base or
9126	immutable hard disk as a parent for creating a new differencing hard disk
9127	that will be actually attached to the machine. And only if no descendants
9128	are found or if the virtual machine does not have any snapshots then the
9129	normal base or immutable hard disk will be used itself as a parent for
9130	this differencing hard disk.
9131
9132	It is easier to explain what smart attachment does using the
9133	following example:
9134	<pre>
9135	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9136
9137	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9138	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9139	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9140	Snapshot 4 (none) Snapshot 4 (none)
9141	CurState (none) CurState (D3->D2.vdi)
9142
9143	NOT
9144	...
9145	CurState (D3->B.vdi)
9146	</pre>
9147	The first column is the virtual machine configuration before the base hard
9148	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9149	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9150	mean that the hard disk that is actually attached to the machine is a
9151	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9152	another hard disk, <tt>B.vdi</tt>.
9153
9154	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9155	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9156	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9157	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9158	it cannot be attached directly and needs an indirect attachment (i.e.
9159	implicit creation of a new differencing hard disk). Due to the smart
9160	attachment procedure, the new differencing hard disk
9161	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9162	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9163	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9164	machine.
9165
9166	Note that if there is more than one descendant hard disk of the given base
9167	hard disk found in a snapshot, and there is an exact device, channel and
9168	bus match, then this exact match will be used. Otherwise, the youngest
9169	descendant will be picked up.
9170
9171	There is one more important aspect of the smart attachment procedure which
9172	is not related to snapshots at all. Before walking through the snapshots
9173	as described above, the backup copy of the current list of hard disk
9174	attachment is searched for descendants. This backup copy is created when
9175	the hard disk configuration is changed for the first time after the last
9176	<link to="IMachine::saveSettings"/> call and used by
9177	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9178	changes. When such a descendant is found in this backup copy, it will be
9179	simply re-attached back, without creating a new differencing hard disk for
9180	it. This optimization is necessary to make it possible to re-attach the
9181	base or immutable hard disk to a different bus, channel or device slot
9182	without losing the contents of the differencing hard disk actually
9183	attached to the machine in place of it.
9184	</desc>
9185
9186	<attribute name="id" type="uuid" mod="string" readonly="yes">
9187	<desc>
9188	UUID of the medium. For a newly created medium, this value is a randomly
9189	generated UUID.
9190
9191	<note>
9192	For media in one of MediumState_NotCreated, MediumState_Creating or
9193	MediumState_Deleting states, the value of this property is undefined
9194	and will most likely be an empty UUID.
9195	</note>
9196	</desc>
9197	</attribute>
9198
9199	<attribute name="description" type="wstring">
9200	<desc>
9201	Optional description of the medium. For a newly created medium the value
9202	of this attribute is an empty string.
9203
9204	Medium types that don't support this attribute will return E_NOTIMPL in
9205	attempt to get or set this attribute's value.
9206
9207	<note>
9208	For some storage types, reading this attribute may return an outdated
9209	(last known) value when <link to="#state"/> is <link
9210	to="MediumState_Inaccessible"/> or <link
9211	to="MediumState_LockedWrite"/> because the value of this attribute is
9212	stored within the storage unit itself. Also note that changing the
9213	attribute value is not possible in such case, as well as when the
9214	medium is the <link to="MediumState_LockedRead"/> state.
9215	</note>
9216	</desc>
9217	</attribute>
9218
9219	<attribute name="state" type="MediumState" readonly="yes">
9220	<desc>
9221	Returns the current medium state, which is the last state set by
9222	the accessibility check performed by <link to="#refreshState"/>.
9223	If that method has not yet been called on the medium, the state
9224	is "Inaccessible"; as opposed to truly inaccessible media, the
9225	value of <link to="#lastAccessError"/> will be an empty string in
9226	that case.
9227
9228	<note>As of version 3.1, this no longer performs an accessibility check
9229	automatically; call <link to="#refreshState"/> for that.
9230	</note>
9231	</desc>
9232	</attribute>
9233
9234	<attribute name="location" type="wstring">
9235	<desc>
9236	Location of the storage unit holding medium data.
9237
9238	The format of the location string is medium type specific. For medium
9239	types using regular files in a host's file system, the location
9240	string is the full file name.
9241
9242	Some medium types may support changing the storage unit location by
9243	simply changing the value of this property. If this operation is not
9244	supported, the implementation will return E_NOTIMPL in attempt to set
9245	this attribute's value.
9246
9247	When setting a value of the location attribute which is a regular file
9248	in the host's file system, the given file name may be either relative to
9249	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9250	absolute. Note that if the given location specification does not contain
9251	the file extension part then a proper default extension will be
9252	automatically appended by the implementation depending on the medium type.
9253	</desc>
9254	</attribute>
9255
9256	<attribute name="name" type="wstring" readonly="yes">
9257	<desc>
9258	Name of the storage unit holding medium data.
9259
9260	The returned string is a short version of the <link to="#location"/>
9261	attribute that is suitable for representing the medium in situations
9262	where the full location specification is too long (such as lists
9263	and comboboxes in GUI frontends). This string is also used by frontends
9264	to sort the media list alphabetically when needed.
9265
9266	For example, for locations that are regular files in the host's file
9267	system, the value of this attribute is just the file name (+ extension),
9268	without the path specification.
9269
9270	Note that as opposed to the <link to="#location"/> attribute, the name
9271	attribute will not necessary be unique for a list of media of the
9272	given type and format.
9273	</desc>
9274	</attribute>
9275
9276	<attribute name="deviceType" type="DeviceType" readonly="yes">
9277	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9278	medium.</desc>
9279	</attribute>
9280
9281	<attribute name="hostDrive" type="boolean" readonly="yes">
9282	<desc>True if this corresponds to a drive on the host.</desc>
9283	</attribute>
9284
9285	<attribute name="size" type="unsigned long long" readonly="yes">
9286	<desc>
9287	Physical size of the storage unit used to hold medium data (in bytes).
9288
9289	<note>
9290	For media whose <link to="#state"/> is <link
9291	to="MediumState_Inaccessible"/>, the value of this property is the
9292	last known size. For <link to="MediumState_NotCreated"/> media,
9293	the returned value is zero.
9294	</note>
9295	</desc>
9296	</attribute>
9297
9298	<attribute name="format" type="wstring" readonly="yes">
9299	<desc>
9300	Storage format of this medium.
9301
9302	The value of this attribute is a string that specifies a backend used
9303	to store medium data. The storage format is defined when you create a
9304	new medium or automatically detected when you open an existing medium,
9305	and cannot be changed later.
9306
9307	The list of all storage formats supported by this VirtualBox
9308	installation can be obtained using
9309	<link to="ISystemProperties::mediumFormats"/>.
9310	</desc>
9311	</attribute>
9312
9313	<attribute name="type" type="MediumType">
9314	<desc>
9315	Type (role) of this medium.
9316
9317	The following constraints apply when changing the value of this
9318	attribute:
9319	<ul>
9320	<li>If a medium is attached to a virtual machine (either in the
9321	current state or in one of the snapshots), its type cannot be
9322	changed.
9323	</li>
9324	<li>As long as the medium has children, its type cannot be set
9325	to <link to="MediumType_Writethrough"/>.
9326	</li>
9327	<li>The type of all differencing media is
9328	<link to="MediumType_Normal"/> and cannot be changed.
9329	</li>
9330	</ul>
9331
9332	The type of a newly created or opened medium is set to
9333	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9334	which have a type of <link to="MediumType_Writethrough"/>.
9335	</desc>
9336	</attribute>
9337
9338	<attribute name="parent" type="IMedium" readonly="yes">
9339	<desc>
9340	Parent of this medium (the medium this medium is directly based
9341	on).
9342
9343	Only differencing media have parents. For base (non-differencing)
9344	media, @c null is returned.
9345	</desc>
9346	</attribute>
9347
9348	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9349	<desc>
9350	Children of this medium (all differencing media directly based
9351	on this medium). A @c null array is returned if this medium
9352	does not have any children.
9353	</desc>
9354	</attribute>
9355
9356	<attribute name="base" type="IMedium" readonly="yes">
9357	<desc>
9358	Base medium of this medium.
9359
9360	If this is a differencing medium, its base medium is the medium
9361	the given medium branch starts from. For all other types of media, this
9362	property returns the medium object itself (i.e. the same object this
9363	property is read on).
9364	</desc>
9365	</attribute>
9366
9367	<attribute name="readOnly" type="boolean" readonly="yes">
9368	<desc>
9369	Returns @c true if this medium is read-only and @c false otherwise.
9370
9371	A medium is considered to be read-only when its contents cannot be
9372	modified without breaking the integrity of other parties that depend on
9373	this medium such as its child media or snapshots of virtual machines
9374	where this medium is attached to these machines. If there are no
9375	children and no such snapshots then there is no dependency and the
9376	medium is not read-only.
9377
9378	The value of this attribute can be used to determine the kind of the
9379	attachment that will take place when attaching this medium to a
9380	virtual machine. If the value is @c false then the medium will
9381	be attached directly. If the value is @c true then the medium
9382	will be attached indirectly by creating a new differencing child
9383	medium for that. See the interface description for more information.
9384
9385	Note that all <link to="MediumType_Immutable">Immutable</link> media
9386	are always read-only while all
9387	<link to="MediumType_Writethrough">Writethrough</link> media are
9388	always not.
9389
9390	<note>
9391	The read-only condition represented by this attribute is related to
9392	the medium type and usage, not to the current
9393	<link to="IMedium::state">medium state</link> and not to the read-only
9394	state of the storage unit.
9395	</note>
9396	</desc>
9397	</attribute>
9398
9399	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9400	<desc>
9401	Logical size of this medium (in megabytes), as reported to the
9402	guest OS running inside the virtual machine this medium is
9403	attached to. The logical size is defined when the medium is created
9404	and cannot be changed later.
9405
9406	<note>
9407	Reading this property on a differencing medium will return the size
9408	of its <link to="#base"/> medium.
9409	</note>
9410	<note>
9411	For media whose state is <link to="#state"/> is <link
9412	to="MediumState_Inaccessible"/>, the value of this property is the
9413	last known logical size. For <link to="MediumaState_NotCreated"/>
9414	media, the returned value is zero.
9415	</note>
9416	</desc>
9417	</attribute>
9418
9419	<attribute name="autoReset" type="boolean">
9420	<desc>
9421	Whether this differencing medium will be automatically reset each
9422	time a virtual machine it is attached to is powered up. This
9423	attribute is automatically set to @c true for the last
9424	differencing image of an "immutable" medium (see
9425	<link to="MediumType" />).
9426
9427	See <link to="#reset"/> for more information about resetting
9428	differencing media.
9429
9430	<note>
9431	Reading this property on a base (non-differencing) medium will
9432	always @c false. Changing the value of this property in this
9433	case is not supported.
9434	</note>
9435
9436	<result name="VBOX_E_NOT_SUPPORTED">
9437	This is not a differencing medium (when changing the attribute
9438	value).
9439	</result>
9440	</desc>
9441	</attribute>
9442
9443	<attribute name="lastAccessError" type="wstring" readonly="yes">
9444	<desc>
9445	Text message that represents the result of the last accessibility
9446	check performed by <link to="#refreshState"/>.
9447
9448	An empty string is returned if the last accessibility check
9449	was successful or has not yet been called. As a result, if
9450	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9451	then <link to="#refreshState"/> has yet to be called; this is the
9452	default value of media after VirtualBox initialization.
9453	A non-empty string indicates a failure and should normally describe
9454	a reason of the failure (for example, a file read error).
9455	</desc>
9456	</attribute>
9457
9458	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9459	<desc>
9460	Array of UUIDs of all machines this medium is attached to.
9461
9462	A @c null array is returned if this medium is not attached to any
9463	machine or to any machine's snapshot.
9464
9465	<note>
9466	The returned array will include a machine even if this medium is not
9467	attached to that machine in the current state but attached to it in
9468	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9469	details.
9470	</note>
9471	</desc>
9472	</attribute>
9473
9474	<method name="refreshState">
9475	<desc>
9476	If the current medium state (see <link to="MediumState"/>) is one of
9477	"Created", "Inaccessible" or "LockedRead", then this performs an
9478	accessibility check on the medium and sets the value of the <link to="#state"/>
9479	attribute accordingly; that value is also returned for convenience.
9480
9481	For all other state values, this does not perform a refresh but returns
9482	the state only.
9483
9484	The refresh, if performed, may take a long time (several seconds or even
9485	minutes, depending on the storage unit location and format) because it performs an
9486	accessibility check of the storage unit. This check may cause a significant
9487	delay if the storage unit of the given medium is, for example, a file located
9488	on a network share which is not currently accessible due to connectivity
9489	problems. In that case, the call will not return until a timeout
9490	interval defined by the host OS for this operation expires. For this reason,
9491	it is recommended to never read this attribute on the main UI thread to avoid
9492	making the UI unresponsive.
9493
9494	If the last known state of the medium is "Created" and the accessibility
9495	check fails, then the state would be set to "Inaccessible", and
9496	<link to="#lastAccessError"/> may be used to get more details about the
9497	failure. If the state of the medium is "LockedRead", then it remains the
9498	same, and a non-empty value of <link to="#lastAccessError"/> will
9499	indicate a failed accessibility check in this case.
9500
9501	Note that not all medium states are applicable to all medium types.
9502	</desc>
9503	<param name="state" type="MediumState" dir="return">
9504	<desc>
9505	New medium state.
9506	</desc>
9507	</param>
9508	</method>
9509
9510	<method name="getSnapshotIds">
9511	<desc>
9512	Returns an array of UUIDs of all snapshots of the given machine where
9513	this medium is attached to.
9514
9515	If the medium is attached to the machine in the current state, then the
9516	first element in the array will always be the ID of the queried machine
9517	(i.e. the value equal to the @c machineId argument), followed by
9518	snapshot IDs (if any).
9519
9520	If the medium is not attached to the machine in the current state, then
9521	the array will contain only snapshot IDs.
9522
9523	The returned array may be @c null if this medium is not attached
9524	to the given machine at all, neither in the current state nor in one of
9525	the snapshots.
9526	</desc>
9527	<param name="machineId" type="uuid" mod="string" dir="in">
9528	<desc>
9529	UUID of the machine to query.
9530	</desc>
9531	</param>
9532	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9533	<desc>
9534	Array of snapshot UUIDs of the given machine using this medium.
9535	</desc>
9536	</param>
9537	</method>
9538
9539	<method name="lockRead">
9540	<desc>
9541	Locks this medium for reading.
9542
9543	A read lock is shared: many clients can simultaneously lock the
9544	same medium for reading unless it is already locked for writing (see
9545	<link to="#lockWrite"/>) in which case an error is returned.
9546
9547	When the medium is locked for reading, it cannot be modified
9548	from within VirtualBox. This means that any method that changes
9549	the properties of this medium or contents of the storage unit
9550	will return an error (unless explicitly stated otherwise). That
9551	includes an attempt to start a virtual machine that wants to
9552	write to the the medium.
9553
9554	When the virtual machine is started up, it locks for reading all
9555	media it uses in read-only mode. If some medium cannot be locked
9556	for reading, the startup procedure will fail.
9557	A medium is typically locked for reading while it is used by a running
9558	virtual machine but has a depending differencing image that receives
9559	the actual write operations. This way one base medium can have
9560	multiple child differencing images which can be written to
9561	simultaneously. Read-only media such as DVD and floppy images are
9562	also locked for reading only (so they can be in use by multiple
9563	machines simultaneously).
9564
9565	A medium is also locked for reading when it is the source of a
9566	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9567
9568	The medium locked for reading must be unlocked using the <link
9569	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9570	can be nested and must be followed by the same number of paired
9571	<link to="#unlockRead"/> calls.
9572
9573	This method sets the medium state (see <link to="#state"/>) to
9574	"LockedRead" on success. The medium's previous state must be
9575	one of "Created", "Inaccessible" or "LockedRead".
9576
9577	Locking an inaccessible medium is not an error; this method performs
9578	a logical lock that prevents modifications of this medium through
9579	the VirtualBox API, not a physical file-system lock of the underlying
9580	storage unit.
9581
9582	This method returns the current state of the medium
9583	<i>before</i> the operation.
9584
9585	<result name="VBOX_E_INVALID_OBJECT_STATE">
9586	Invalid medium state (e.g. not created, locked, inaccessible,
9587	creating, deleting).
9588	</result>
9589
9590	</desc>
9591	<param name="state" type="MediumState" dir="return">
9592	<desc>
9593	State of the medium after the operation.
9594	</desc>
9595	</param>
9596	</method>
9597
9598	<method name="unlockRead">
9599	<desc>
9600	Cancels the read lock previously set by <link to="#lockRead"/>.
9601
9602	For both success and failure, this method returns the current state
9603	of the medium <i>after</i> the operation.
9604
9605	See <link to="#lockRead"/> for more details.
9606
9607	<result name="VBOX_E_INVALID_OBJECT_STATE">
9608	Medium not locked for reading.
9609	</result>
9610
9611	</desc>
9612	<param name="state" type="MediumState" dir="return">
9613	<desc>
9614	State of the medium after the operation.
9615	</desc>
9616	</param>
9617	</method>
9618
9619	<method name="lockWrite">
9620	<desc>
9621	Locks this medium for writing.
9622
9623	A write lock, as opposed to <link to="#lockRead"/>, is
9624	exclusive: there may be only one client holding a write lock,
9625	and there may be no read locks while the write lock is held.
9626	As a result, read-locking fails if a write lock is held, and
9627	write-locking fails if either a read or another write lock is held.
9628
9629	When a medium is locked for writing, it cannot be modified
9630	from within VirtualBox, and it is not guaranteed that the values
9631	of its properties are up-to-date. Any method that changes the
9632	properties of this medium or contents of the storage unit will
9633	return an error (unless explicitly stated otherwise).
9634
9635	When a virtual machine is started up, it locks for writing all
9636	media it uses to write data to. If any medium could not be locked
9637	for writing, the startup procedure will fail. If a medium has
9638	differencing images, then while the machine is running, only
9639	the last ("leaf") differencing image is locked for writing,
9640	whereas its parents are locked for reading only.
9641
9642	A medium is also locked for writing when it is the target of a
9643	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9644
9645	The medium locked for writing must be unlocked using the <link
9646	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9647
9648	This method sets the medium state (see <link to="#state"/>) to
9649	"LockedWrite" on success. The medium's previous state must be
9650	either "Created" or "Inaccessible".
9651
9652	Locking an inaccessible medium is not an error; this method performs
9653	a logical lock that prevents modifications of this medium through
9654	the VirtualBox API, not a physical file-system lock of the underlying
9655	storage unit.
9656
9657	For both, success and failure, this method returns the current
9658	state of the medium <i>before</i> the operation.
9659
9660	<result name="VBOX_E_INVALID_OBJECT_STATE">
9661	Invalid medium state (e.g. not created, locked, inaccessible,
9662	creating, deleting).
9663	</result>
9664
9665	</desc>
9666	<param name="state" type="MediumState" dir="return">
9667	<desc>
9668	State of the medium after the operation.
9669	</desc>
9670	</param>
9671	</method>
9672
9673	<method name="unlockWrite">
9674	<desc>
9675	Cancels the write lock previously set by <link to="#lockWrite"/>.
9676
9677	For both success and failure, this method returns the current
9678	state of the medium <i>after</i> the operation.
9679
9680	See <link to="#lockWrite"/> for more details.
9681
9682	<result name="VBOX_E_INVALID_OBJECT_STATE">
9683	Medium not locked for writing.
9684	</result>
9685
9686	</desc>
9687	<param name="state" type="MediumState" dir="return">
9688	<desc>
9689	State of the medium after the operation.
9690	</desc>
9691	</param>
9692	</method>
9693
9694	<method name="close">
9695	<desc>
9696	Closes this medium.
9697
9698	The medium must not be attached to any known virtual machine
9699	and must not have any known child media, otherwise the
9700	operation will fail.
9701
9702	When the medium is successfully closed, it gets removed from
9703	the list of remembered media, but its storage unit is not
9704	deleted. In particular, this means that this medium can be
9705	later opened again using the <link
9706	to="IVirtualBox::openHardDisk"/> call.
9707
9708	Note that after this method successfully returns, the given medium
9709	object becomes uninitialized. This means that any attempt
9710	to call any of its methods or attributes will fail with the
9711	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9712
9713	<result name="VBOX_E_INVALID_OBJECT_STATE">
9714	Invalid medium state (other than not created, created or
9715	inaccessible).
9716	</result>
9717	<result name="VBOX_E_OBJECT_IN_USE">
9718	Medium attached to virtual machine.
9719	</result>
9720	<result name="VBOX_E_FILE_ERROR">
9721	Settings file not accessible.
9722	</result>
9723	<result name="VBOX_E_XML_ERROR">
9724	Could not parse the settings file.
9725	</result>
9726
9727	</desc>
9728	</method>
9729
9730	<!-- storage methods -->
9731
9732	<method name="getProperty">
9733	<desc>
9734	Returns the value of the custom medium property with the given name.
9735
9736	The list of all properties supported by the given medium format can
9737	be obtained with <link to="IMediumFormat::describeProperties"/>.
9738
9739	Note that if this method returns an empty string in @a value, the
9740	requested property is supported but currently not assigned any value.
9741
9742	<result name="VBOX_E_OBJECT_NOT_FOUND">
9743	Requested property does not exist (not supported by the format).
9744	</result>
9745	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9746	</desc>
9747	<param name="name" type="wstring" dir="in">
9748	<desc>Name of the property to get.</desc>
9749	</param>
9750	<param name="value" type="wstring" dir="return">
9751	<desc>Current property value.</desc>
9752	</param>
9753	</method>
9754
9755	<method name="setProperty">
9756	<desc>
9757	Sets the value of the custom medium property with the given name.
9758
9759	The list of all properties supported by the given medium format can
9760	be obtained with <link to="IMediumFormat::describeProperties"/>.
9761
9762	Note that setting the property value to @c null or an empty string is
9763	equivalent to deleting the existing value. A default value (if it is
9764	defined for this property) will be used by the format backend in this
9765	case.
9766
9767	<result name="VBOX_E_OBJECT_NOT_FOUND">
9768	Requested property does not exist (not supported by the format).
9769	</result>
9770	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9771	</desc>
9772	<param name="name" type="wstring" dir="in">
9773	<desc>Name of the property to set.</desc>
9774	</param>
9775	<param name="value" type="wstring" dir="in">
9776	<desc>Property value to set.</desc>
9777	</param>
9778	</method>
9779
9780	<method name="getProperties">
9781	<desc>
9782	Returns values for a group of properties in one call.
9783
9784	The names of the properties to get are specified using the @a names
9785	argument which is a list of comma-separated property names or
9786	an empty string if all properties are to be returned. Note that currently
9787	the value of this argument is ignored and the method always returns all
9788	existing properties.
9789
9790	The list of all properties supported by the given medium format can
9791	be obtained with <link to="IMediumFormat::describeProperties"/>.
9792
9793	The method returns two arrays, the array of property names corresponding
9794	to the @a names argument and the current values of these properties.
9795	Both arrays have the same number of elements with each elemend at the
9796	given index in the first array corresponds to an element at the same
9797	index in the second array.
9798
9799	Note that for properties that do not have assigned values,
9800	an empty string is returned at the appropriate index in the
9801	@a returnValues array.
9802
9803	</desc>
9804	<param name="names" type="wstring" dir="in">
9805	<desc>
9806	Names of properties to get.
9807	</desc>
9808	</param>
9809	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9810	<desc>Names of returned properties.</desc>
9811	</param>
9812	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9813	<desc>Values of returned properties.</desc>
9814	</param>
9815	</method>
9816
9817	<method name="setProperties">
9818	<desc>
9819	Sets values for a group of properties in one call.
9820
9821	The names of the properties to set are passed in the @a names
9822	array along with the new values for them in the @a values array. Both
9823	arrays have the same number of elements with each elemend at the given
9824	index in the first array corresponding to an element at the same index
9825	in the second array.
9826
9827	If there is at least one property name in @a names that is not valid,
9828	the method will fail before changing the values of any other properties
9829	from the @a names array.
9830
9831	Using this method over <link to="#setProperty"/> is preferred if you
9832	need to set several properties at once since it will result into less
9833	IPC calls.
9834
9835	The list of all properties supported by the given medium format can
9836	be obtained with <link to="IMediumFormat::describeProperties"/>.
9837
9838	Note that setting the property value to @c null or an empty string is
9839	equivalent to deleting the existing value. A default value (if it is
9840	defined for this property) will be used by the format backend in this
9841	case.
9842	</desc>
9843	<param name="names" type="wstring" safearray="yes" dir="in">
9844	<desc>Names of properties to set.</desc>
9845	</param>
9846	<param name="values" type="wstring" safearray="yes" dir="in">
9847	<desc>Values of properties to set.</desc>
9848	</param>
9849	</method>
9850
9851	<!-- storage methods -->
9852
9853	<method name="createBaseStorage">
9854	<desc>
9855	Starts creating a hard disk storage unit (fixed/dynamic, according
9856	to the variant flags) in in the background. The previous storage unit
9857	created for this object, if any, must first be deleted using
9858	<link to="#deleteStorage"/>, otherwise the operation will fail.
9859
9860	Before the operation starts, the medium is placed in
9861	<link to="MediumState_Creating"/> state. If the create operation
9862	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9863	state.
9864
9865	After the returned progress object reports that the operation has
9866	successfully completed, the medium state will be set to <link
9867	to="MediumState_Created"/>, the medium will be remembered by this
9868	VirtualBox installation and may be attached to virtual machines.
9869
9870	<result name="VBOX_E_NOT_SUPPORTED">
9871	The variant of storage creation operation is not supported. See <link
9872	to="IMediumFormat::capabilities"/>.
9873	</result>
9874	</desc>
9875	<param name="logicalSize" type="unsigned long long" dir="in">
9876	<desc>Maximum logical size of the medium in megabytes.</desc>
9877	</param>
9878	<param name="variant" type="MediumVariant" dir="in">
9879	<desc>Exact image variant which should be created.</desc>
9880	</param>
9881	<param name="progress" type="IProgress" dir="return">
9882	<desc>Progress object to track the operation completion.</desc>
9883	</param>
9884	</method>
9885
9886	<method name="deleteStorage">
9887	<desc>
9888	Starts deleting the storage unit of this medium.
9889
9890	The medium must not be attached to any known virtual machine and must
9891	not have any known child media, otherwise the operation will fail.
9892	It will also fail if there is no storage unit to delete or if deletion
9893	is already in progress, or if the medium is being in use (locked for
9894	read or for write) or inaccessible. Therefore, the only valid state for
9895	this operation to succeed is <link to="MediumState_Created"/>.
9896
9897	Before the operation starts, the medium is placed in
9898	<link to="MediumState_Deleting"/> state and gets removed from the list
9899	of remembered hard disks (media registry). If the delete operation
9900	fails, the medium will be remembered again and placed back to
9901	<link to="MediumState_Created"/> state.
9902
9903	After the returned progress object reports that the operation is
9904	complete, the medium state will be set to
9905	<link to="MediumState_NotCreated"/> and you will be able to use one of
9906	the storage creation methods to create it again.
9907
9908	<see>#close()</see>
9909
9910	<result name="VBOX_E_OBJECT_IN_USE">
9911	Medium is attached to a virtual machine.
9912	</result>
9913	<result name="VBOX_E_NOT_SUPPORTED">
9914	Storage deletion is not allowed because neither of storage creation
9915	operations are supported. See
9916	<link to="IMediumFormat::capabilities"/>.
9917	</result>
9918
9919	<note>
9920	If the deletion operation fails, it is not guaranteed that the storage
9921	unit still exists. You may check the <link to="IMedium::state"/> value
9922	to answer this question.
9923	</note>
9924	</desc>
9925	<param name="progress" type="IProgress" dir="return">
9926	<desc>Progress object to track the operation completion.</desc>
9927	</param>
9928	</method>
9929
9930	<!-- diff methods -->
9931
9932	<method name="createDiffStorage">
9933	<desc>
9934	Starts creating an empty differencing storage unit based on this
9935	medium in the format and at the location defined by the @a target
9936	argument.
9937
9938	The target medium must be in <link to="MediumState_NotCreated"/>
9939	state (i.e. must not have an existing storage unit). Upon successful
9940	completion, this operation will set the type of the target medium to
9941	<link to="MediumType_Normal"/> and create a storage unit necessary to
9942	represent the differencing medium data in the given format (according
9943	to the storage format of the target object).
9944
9945	After the returned progress object reports that the operation is
9946	successfully complete, the target medium gets remembered by this
9947	VirtualBox installation and may be attached to virtual machines.
9948
9949	<note>
9950	The medium will be set to <link to="MediumState_LockedRead"/>
9951	state for the duration of this operation.
9952	</note>
9953	<result name="VBOX_E_OBJECT_IN_USE">
9954	Medium not in @c NotCreated state.
9955	</result>
9956	</desc>
9957	<param name="target" type="IMedium" dir="in">
9958	<desc>Target medium.</desc>
9959	</param>
9960	<param name="variant" type="MediumVariant" dir="in">
9961	<desc>Exact image variant which should be created.</desc>
9962	</param>
9963	<param name="progress" type="IProgress" dir="return">
9964	<desc>Progress object to track the operation completion.</desc>
9965	</param>
9966	</method>
9967
9968	<method name="mergeTo">
9969	<desc>
9970	Starts merging the contents of this medium and all intermediate
9971	differencing media in the chain to the given target medium.
9972
9973	The target medium must be either a descendant of this medium or
9974	its ancestor (otherwise this method will immediately return a failure).
9975	It follows that there are two logical directions of the merge operation:
9976	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9977	ancestor (<i>backward merge</i>). Let us consider the following medium
9978	chain:
9979
9980	<pre>Base <- Diff_1 <- Diff_2</pre>
9981
9982	Here, calling this method on the <tt>Base</tt> medium object with
9983	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9984	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9985	merge. Note that in both cases the contents of the resulting medium
9986	will be the same, the only difference is the medium object that takes
9987	the result of the merge operation. In case of the forward merge in the
9988	above example, the result will be written to <tt>Diff_2</tt>; in case of
9989	the backward merge, the result will be written to <tt>Base</tt>. In
9990	other words, the result of the operation is always stored in the target
9991	medium.
9992
9993	Upon successful operation completion, the storage units of all media in
9994	the chain between this (source) medium and the target medium, including
9995	the source medium itself, will be automatically deleted and the
9996	relevant medium objects (including this medium) will become
9997	uninitialized. This means that any attempt to call any of
9998	their methods or attributes will fail with the
9999	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10000	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10001	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10002	Note that <tt>Diff_2</tt> in this case will become a base medium
10003	itself since it will no longer be based on any other medium.
10004
10005	Considering the above, all of the following conditions must be met in
10006	order for the merge operation to succeed:
10007	<ul>
10008	<li>
10009	Neither this (source) medium nor any intermediate
10010	differencing medium in the chain between it and the target
10011	medium is attached to any virtual machine.
10012	</li>
10013	<li>
10014	Neither the source medium nor the target medium is an
10015	<link to="MediumType_Immutable"/> medium.
10016	</li>
10017	<li>
10018	The part of the medium tree from the source medium to the
10019	target medium is a linear chain, i.e. all medium in this
10020	chain have exactly one child which is the next medium in this
10021	chain. The only exception from this rule is the target medium in
10022	the forward merge operation; it is allowed to have any number of
10023	child media because the merge operation will not change its
10024	logical contents (as it is seen by the guest OS or by children).
10025	</li>
10026	<li>
10027	None of the involved media are in
10028	<link to="MediumState_LockedRead"/> or
10029	<link to="MediumState_LockedWrite"/> state.
10030	</li>
10031	</ul>
10032
10033	<note>
10034	This (source) medium and all intermediates will be placed to <link
10035	to="MediumState_Deleting"/> state and the target medium will be
10036	placed to <link to="MediumState_LockedWrite"/> state and for the
10037	duration of this operation.
10038	</note>
10039	</desc>
10040	<param name="targetId" type="uuid" mod="string" dir="in">
10041	<desc>UUID of the target ancestor or descendant medium.</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	<!-- clone method -->
10049
10050	<method name="cloneTo">
10051	<desc>
10052	Starts creating a clone of this medium in the format and at the
10053	location defined by the @a target argument.
10054
10055	The target medium must be either in <link to="MediumState_NotCreated"/>
10056	state (i.e. must not have an existing storage unit) or in
10057	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10058	big enough to hold the data or else the copy will be partial). Upon
10059	successful completion, the cloned medium will contain exactly the
10060	same sector data as the medium being cloned, except that in the
10061	first case a new UUID for the clone will be randomly generated, and in
10062	the second case the UUID will remain unchanged.
10063
10064	The @a parent argument defines which medium will be the parent
10065	of the clone. Passing a @c null reference indicates that the clone will
10066	be a base image, i.e. completely independent. It is possible to specify
10067	an arbitrary medium for this parameter, including the parent of the
10068	medium which is being cloned. Even cloning to a child of the source
10069	medium is possible. Note that when cloning to an existing image, the
10070	@a parent irgument is ignored.
10071
10072	After the returned progress object reports that the operation is
10073	successfully complete, the target medium gets remembered by this
10074	VirtualBox installation and may be attached to virtual machines.
10075
10076	<note>
10077	This medium will be placed to <link to="MediumState_LockedRead"/>
10078	state for the duration of this operation.
10079	</note>
10080	<result name="E_NOTIMPL">
10081	The specified cloning variant is not supported at the moment.
10082	</result>
10083	</desc>
10084	<param name="target" type="IMedium" dir="in">
10085	<desc>Target medium.</desc>
10086	</param>
10087	<param name="variant" type="MediumVariant" dir="in">
10088	<desc>Exact image variant which should be created.</desc>
10089	</param>
10090	<param name="parent" type="IMedium" dir="in">
10091	<desc>Parent of the cloned medium.</desc>
10092	</param>
10093	<param name="progress" type="IProgress" dir="return">
10094	<desc>Progress object to track the operation completion.</desc>
10095	</param>
10096	</method>
10097
10098	<!-- other methods -->
10099
10100	<method name="compact">
10101	<desc>
10102	Starts compacting of this medium. This means that the medium is
10103	transformed into a possibly more compact storage representation.
10104	This potentially creates temporary images, which can require a
10105	substantial amount of additional disk space.
10106
10107	This medium will be placed to <link to="MediumState_LockedWrite"/>
10108	state and all its parent media (if any) will be placed to
10109	<link to="MediumState_LockedRead"/> state for the duration of this
10110	operation.
10111
10112	Please note that the results can be either returned straight away,
10113	or later as the result of the background operation via the object
10114	returned via the @a progress parameter.
10115
10116	<result name="VBOX_E_NOT_SUPPORTED">
10117	Medium format does not support compacting (but potentially
10118	needs it).
10119	</result>
10120	</desc>
10121	<param name="progress" type="IProgress" dir="return">
10122	<desc>Progress object to track the operation completion.</desc>
10123	</param>
10124	</method>
10125
10126	<method name="resize">
10127	<desc>
10128	Starts resizing this medium. This means that the nominal size of the
10129	medium is set to the new value. Both increasing and decreasing the
10130	size is possible, and there are no safety checks, since VirtualBox
10131	does not make any assumptions about the medium contents.
10132
10133	Resizing usually needs additional disk space, and possibly also
10134	some temporary disk space. Note that resize does not create a full
10135	temporary copy of the medium, so the additional disk space requirement
10136	is usually much lower than using the clone operation.
10137
10138	This medium will be placed to <link to="MediumState_LockedWrite"/>
10139	state for the duration of this operation.
10140
10141	Please note that the results can be either returned straight away,
10142	or later as the result of the background operation via the object
10143	returned via the @a progress parameter.
10144
10145	<result name="VBOX_E_NOT_SUPPORTED">
10146	Medium format does not support resizing.
10147	</result>
10148	</desc>
10149	<param name="logicalSize" type="unsigned long long" dir="in">
10150	<desc>New nominal capacity of the medium in megabytes.</desc>
10151	</param>
10152	<param name="progress" type="IProgress" dir="return">
10153	<desc>Progress object to track the operation completion.</desc>
10154	</param>
10155	</method>
10156
10157	<method name="reset">
10158	<desc>
10159	Starts erasing the contents of this differencing medium.
10160
10161	This operation will reset the differencing medium to its initial
10162	state when it does not contain any sector data and any read operation is
10163	redirected to its parent medium. This automatically gets called
10164	during VM power-up for every medium whose <link to="#autoReset" />
10165	attribute is @c true.
10166
10167	The medium will be write-locked for the duration of this operation (see
10168	<link to="#lockWrite" />).
10169
10170	<result name="VBOX_E_NOT_SUPPORTED">
10171	This is not a differencing medium.
10172	</result>
10173	<result name="VBOX_E_INVALID_OBJECT_STATE">
10174	Medium is not in <link to="MediumState_Created"/> or
10175	<link to="MediumState_Inaccessible"/> state.
10176	</result>
10177	</desc>
10178	<param name="progress" type="IProgress" dir="return">
10179	<desc>Progress object to track the operation completion.</desc>
10180	</param>
10181	</method>
10182
10183	</interface>
10184
10185
10186	<!--
10187	// IMediumFormat
10188	/////////////////////////////////////////////////////////////////////////
10189	-->
10190
10191	<enum
10192	name="DataType"
10193	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10194	>
10195	<const name="Int32" value="0"/>
10196	<const name="Int8" value="1"/>
10197	<const name="String" value="2"/>
10198	</enum>
10199
10200	<enum
10201	name="DataFlags"
10202	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10203	>
10204	<const name="None" value="0x00"/>
10205	<const name="Mandatory" value="0x01"/>
10206	<const name="Expert" value="0x02"/>
10207	<const name="Array" value="0x04"/>
10208	<const name="FlagMask" value="0x07"/>
10209	</enum>
10210
10211	<enum
10212	name="MediumFormatCapabilities"
10213	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10214	>
10215	<desc>
10216	Medium format capability flags.
10217	</desc>
10218
10219	<const name="Uuid" value="0x01">
10220	<desc>
10221	Supports UUIDs as expected by VirtualBox code.
10222	</desc>
10223	</const>
10224
10225	<const name="CreateFixed" value="0x02">
10226	<desc>
10227	Supports creating fixed size images, allocating all space instantly.
10228	</desc>
10229	</const>
10230
10231	<const name="CreateDynamic" value="0x04">
10232	<desc>
10233	Supports creating dynamically growing images, allocating space on
10234	demand.
10235	</desc>
10236	</const>
10237
10238	<const name="CreateSplit2G" value="0x08">
10239	<desc>
10240	Supports creating images split in chunks of a bit less than 2 GBytes.
10241	</desc>
10242	</const>
10243
10244	<const name="Differencing" value="0x10">
10245	<desc>
10246	Supports being used as a format for differencing media (see <link
10247	to="IMedium::createDiffStorage"/>).
10248	</desc>
10249	</const>
10250
10251	<const name="Asynchronous" value="0x20">
10252	<desc>
10253	Supports asynchronous I/O operations for at least some configurations.
10254	</desc>
10255	</const>
10256
10257	<const name="File" value="0x40">
10258	<desc>
10259	The format backend operates on files (the <link to="IMedium::location"/>
10260	attribute of the medium specifies a file used to store medium
10261	data; for a list of supported file extensions see
10262	<link to="IMediumFormat::fileExtensions"/>).
10263	</desc>
10264	</const>
10265
10266	<const name="Properties" value="0x80">
10267	<desc>
10268	The format backend uses the property interface to configure the storage
10269	location and properties (the <link to="IMediumFormat::describeProperties"/>
10270	method is used to get access to properties supported by the given medium format).
10271	</desc>
10272	</const>
10273
10274	<const name="CapabilityMask" value="0xFF"/>
10275	</enum>
10276
10277	<interface
10278	name="IMediumFormat" extends="$unknown"
10279	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10280	wsmap="managed"
10281	>
10282	<desc>
10283	The IMediumFormat interface represents a medium format.
10284
10285	Each medium format has an associated backend which is used to handle
10286	media stored in this format. This interface provides information
10287	about the properties of the associated backend.
10288
10289	Each medium format is identified by a string represented by the
10290	<link to="#id"/> attribute. This string is used in calls like
10291	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10292	format.
10293
10294	The list of all supported medium formats can be obtained using
10295	<link to="ISystemProperties::mediaFormats"/>.
10296
10297	<see>IMedium</see>
10298	</desc>
10299
10300	<attribute name="id" type="wstring" readonly="yes">
10301	<desc>
10302	Identifier of this format.
10303
10304	The format identifier is a non-@c null non-empty ASCII string. Note that
10305	this string is case-insensitive. This means that, for example, all of
10306	the following strings:
10307	<pre>
10308	"VDI"
10309	"vdi"
10310	"VdI"</pre>
10311	refer to the same medium format.
10312
10313	This string is used in methods of other interfaces where it is necessary
10314	to specify a medium format, such as
10315	<link to="IVirtualBox::createHardDisk"/>.
10316	</desc>
10317	</attribute>
10318
10319	<attribute name="name" type="wstring" readonly="yes">
10320	<desc>
10321	Human readable description of this format.
10322
10323	Mainly for use in file open dialogs.
10324	</desc>
10325	</attribute>
10326
10327	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10328	<desc>
10329	Array of strings containing the supported file extensions.
10330
10331	The first extension in the array is the extension preferred by the
10332	backend. It is recommended to use this extension when specifying a
10333	location of the storage unit for a new medium.
10334
10335	Note that some backends do not work on files, so this array may be
10336	empty.
10337
10338	<see>IMediumFormat::capabilities</see>
10339	</desc>
10340	</attribute>
10341
10342	<attribute name="capabilities" type="unsigned long" readonly="yes">
10343	<desc>
10344	Capabilities of the format as a set of bit flags.
10345
10346	For the meaning of individual capability flags see
10347	<link to="MediumFormatCapabilities"/>.
10348	</desc>
10349	</attribute>
10350
10351	<method name="describeProperties">
10352	<desc>
10353	Returns several arrays describing the properties supported by this
10354	format.
10355
10356	An element with the given index in each array describes one
10357	property. Thus, the number of elements in each returned array is the
10358	same and corresponds to the number of supported properties.
10359
10360	The returned arrays are filled in only if the
10361	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10362	All arguments must be non-@c null.
10363
10364	<see>DataType</see>
10365	<see>DataFlags</see>
10366	</desc>
10367
10368	<param name="names" type="wstring" safearray="yes" dir="out">
10369	<desc>Array of property names.</desc>
10370	</param>
10371	<param name="description" type="wstring" safearray="yes" dir="out">
10372	<desc>Array of property descriptions.</desc>
10373	</param>
10374	<param name="types" type="DataType" safearray="yes" dir="out">
10375	<desc>Array of property types.</desc>
10376	</param>
10377	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10378	<desc>Array of property flags.</desc>
10379	</param>
10380	<param name="defaults" type="wstring" safearray="yes" dir="out">
10381	<desc>Array of default property values.</desc>
10382	</param>
10383	</method>
10384
10385	</interface>
10386
10387
10388	<!--
10389	// IKeyboard
10390	/////////////////////////////////////////////////////////////////////////
10391	-->
10392
10393	<interface
10394	name="IKeyboard" extends="$unknown"
10395	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10396	wsmap="managed"
10397	>
10398	<desc>
10399	The IKeyboard interface represents the virtual machine's keyboard. Used
10400	in <link to="IConsole::keyboard"/>.
10401
10402	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10403	to the virtual machine.
10404
10405	</desc>
10406	<method name="putScancode">
10407	<desc>Sends a scancode to the keyboard.
10408
10409	<result name="VBOX_E_IPRT_ERROR">
10410	Could not send scan code to virtual keyboard.
10411	</result>
10412
10413	</desc>
10414	<param name="scancode" type="long" dir="in"/>
10415	</method>
10416
10417	<method name="putScancodes">
10418	<desc>Sends an array of scancodes to the keyboard.
10419
10420	<result name="VBOX_E_IPRT_ERROR">
10421	Could not send all scan codes to virtual keyboard.
10422	</result>
10423
10424	</desc>
10425	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10426	<param name="codesStored" type="unsigned long" dir="return"/>
10427	</method>
10428
10429	<method name="putCAD">
10430	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10431	function is nothing special, it is just a convenience function
10432	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10433
10434	<result name="VBOX_E_IPRT_ERROR">
10435	Could not send all scan codes to virtual keyboard.
10436	</result>
10437
10438	</desc>
10439	</method>
10440
10441	</interface>
10442
10443
10444	<!--
10445	// IMouse
10446	/////////////////////////////////////////////////////////////////////////
10447	-->
10448
10449	<enum
10450	name="MouseButtonState"
10451	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10452	>
10453	<desc>
10454	Mouse button state.
10455	</desc>
10456
10457	<const name="LeftButton" value="0x01"/>
10458	<const name="RightButton" value="0x02"/>
10459	<const name="MiddleButton" value="0x04"/>
10460	<const name="WheelUp" value="0x08"/>
10461	<const name="WheelDown" value="0x10"/>
10462	<const name="XButton1" value="0x20"/>
10463	<const name="XButton2" value="0x40"/>
10464	<const name="MouseStateMask" value="0x7F"/>
10465	</enum>
10466
10467	<interface
10468	name="IMouse" extends="$unknown"
10469	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10470	wsmap="managed"
10471	>
10472	<desc>
10473	The IMouse interface represents the virtual machine's mouse. Used in
10474	<link to="IConsole::mouse"/>.
10475
10476	Through this interface, the virtual machine's virtual mouse can be
10477	controlled.
10478	</desc>
10479
10480	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10481	<desc>
10482	Whether the guest OS supports absolute mouse pointer positioning
10483	or not.
10484	<note>
10485	VirtualBox Guest Tools need to be installed to the guest OS
10486	in order to enable absolute mouse positioning support.
10487	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10488	callback to be instantly informed about changes of this attribute
10489	during virtual machine execution.
10490	</note>
10491	<see><link to="#putMouseEventAbsolute"/></see>
10492	</desc>
10493	</attribute>
10494
10495	<method name="putMouseEvent">
10496	<desc>
10497	Initiates a mouse event using relative pointer movements
10498	along x and y axis.
10499
10500	<result name="E_ACCESSDENIED">
10501	Console not powered up.
10502	</result>
10503	<result name="VBOX_E_IPRT_ERROR">
10504	Could not send mouse event to virtual mouse.
10505	</result>
10506
10507	</desc>
10508
10509	<param name="dx" type="long" dir="in">
10510	<desc>
10511	Amount of pixels the mouse should move to the right.
10512	Negative values move the mouse to the left.
10513	</desc>
10514	</param>
10515	<param name="dy" type="long" dir="in">
10516	<desc>
10517	Amount of pixels the mouse should move downwards.
10518	Negative values move the mouse upwards.
10519	</desc>
10520	</param>
10521	<param name="dz" type="long" dir="in">
10522	<desc>
10523	Amount of mouse wheel moves.
10524	Positive values describe clockwise wheel rotations,
10525	negative values describe counterclockwise rotations.
10526	</desc>
10527	</param>
10528	<param name="dw" type="long" dir="in">
10529	<desc>
10530	Amount of horizontal mouse wheel moves.
10531	Positive values describe a movement to the left,
10532	negative values describe a movement to the right.
10533	</desc>
10534	</param>
10535	<param name="buttonState" type="long" dir="in">
10536	<desc>
10537	The current state of mouse buttons. Every bit represents
10538	a mouse button as follows:
10539	<table>
10540	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10541	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10542	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10543	</table>
10544	A value of <tt>1</tt> means the corresponding button is pressed.
10545	otherwise it is released.
10546	</desc>
10547	</param>
10548	</method>
10549
10550	<method name="putMouseEventAbsolute">
10551	<desc>
10552	Positions the mouse pointer using absolute x and y coordinates.
10553	These coordinates are expressed in pixels and
10554	start from <tt>[1,1]</tt> which corresponds to the top left
10555	corner of the virtual display.
10556
10557	<result name="E_ACCESSDENIED">
10558	Console not powered up.
10559	</result>
10560	<result name="VBOX_E_IPRT_ERROR">
10561	Could not send mouse event to virtual mouse.
10562	</result>
10563
10564	<note>
10565	This method will have effect only if absolute mouse
10566	positioning is supported by the guest OS.
10567	</note>
10568
10569	<see><link to="#absoluteSupported"/></see>
10570	</desc>
10571
10572	<param name="x" type="long" dir="in">
10573	<desc>
10574	X coordinate of the pointer in pixels, starting from @c 1.
10575	</desc>
10576	</param>
10577	<param name="y" type="long" dir="in">
10578	<desc>
10579	Y coordinate of the pointer in pixels, starting from @c 1.
10580	</desc>
10581	</param>
10582	<param name="dz" type="long" dir="in">
10583	<desc>
10584	Amount of mouse wheel moves.
10585	Positive values describe clockwise wheel rotations,
10586	negative values describe counterclockwise rotations.
10587	</desc>
10588	</param>
10589	<param name="dw" type="long" dir="in">
10590	<desc>
10591	Amount of horizontal mouse wheel moves.
10592	Positive values describe a movement to the left,
10593	negative values describe a movement to the right.
10594	</desc>
10595	</param>
10596	<param name="buttonState" type="long" dir="in">
10597	<desc>
10598	The current state of mouse buttons. Every bit represents
10599	a mouse button as follows:
10600	<table>
10601	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10602	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10603	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10604	</table>
10605	A value of @c 1 means the corresponding button is pressed.
10606	otherwise it is released.
10607	</desc>
10608	</param>
10609	</method>
10610
10611	</interface>
10612
10613	<!--
10614	// IDisplay
10615	/////////////////////////////////////////////////////////////////////////
10616	-->
10617
10618	<enum
10619	name="FramebufferPixelFormat"
10620	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10621	>
10622	<desc>
10623	Format of the video memory buffer. Constants represented by this enum can
10624	be used to test for particular values of <link
10625	to="IFramebuffer::pixelFormat"/>. See also <link
10626	to="IFramebuffer::requestResize"/>.
10627
10628	See also www.fourcc.org for more information about FOURCC pixel formats.
10629	</desc>
10630
10631	<const name="Opaque" value="0">
10632	<desc>
10633	Unknown buffer format (the user may not assume any particular format of
10634	the buffer).
10635	</desc>
10636	</const>
10637	<const name="FOURCC_RGB" value="0x32424752">
10638	<desc>
10639	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10640	bit layout).
10641	</desc>
10642	</const>
10643	</enum>
10644
10645	<interface
10646	name="IFramebuffer" extends="$unknown"
10647	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10648	wsmap="suppress"
10649	>
10650	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10651	<desc>Address of the start byte of the frame buffer.</desc>
10652	</attribute>
10653
10654	<attribute name="width" type="unsigned long" readonly="yes">
10655	<desc>Frame buffer width, in pixels.</desc>
10656	</attribute>
10657
10658	<attribute name="height" type="unsigned long" readonly="yes">
10659	<desc>Frame buffer height, in pixels.</desc>
10660	</attribute>
10661
10662	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10663	<desc>
10664	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10665	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10666	are: 8, 15, 16, 24 and 32.
10667	</desc>
10668	</attribute>
10669
10670	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10671	<desc>
10672	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10673	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10674	size of the scan line must be aligned to 32 bits.
10675	</desc>
10676	</attribute>
10677
10678	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10679	<desc>
10680	Frame buffer pixel format. It's either one of the values defined by <link
10681	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10682	<note>
10683	This attribute must never return <link
10684	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10685	<link to="#address"/> points to must be always known.
10686	</note>
10687	</desc>
10688	</attribute>
10689
10690	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10691	<desc>
10692	Defines whether this frame buffer uses the virtual video card's memory
10693	buffer (guest VRAM) directly or not. See <link
10694	to="IFramebuffer::requestResize"/> for more information.
10695	</desc>
10696	</attribute>
10697
10698	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10699	<desc>
10700	Hint from the frame buffer about how much of the standard
10701	screen height it wants to use for itself. This information is
10702	exposed to the guest through the VESA BIOS and VMMDev interface
10703	so that it can use it for determining its video mode table. It
10704	is not guaranteed that the guest respects the value.
10705	</desc>
10706	</attribute>
10707
10708	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10709	<desc>
10710	An alpha-blended overlay which is superposed over the frame buffer.
10711	The initial purpose is to allow the display of icons providing
10712	information about the VM state, including disk activity, in front
10713	ends which do not have other means of doing that. The overlay is
10714	designed to controlled exclusively by IDisplay. It has no locking
10715	of its own, and any changes made to it are not guaranteed to be
10716	visible until the affected portion of IFramebuffer is updated. The
10717	overlay can be created lazily the first time it is requested. This
10718	attribute can also return @c null to signal that the overlay is not
10719	implemented.
10720	</desc>
10721	</attribute>
10722
10723	<attribute name="winId" type="unsigned long long" readonly="yes">
10724	<desc>
10725	Platform-dependent identifier of the window where context of this
10726	frame buffer is drawn, or zero if there's no such window.
10727	</desc>
10728	</attribute>
10729
10730	<method name="lock">
10731	<desc>
10732	Locks the frame buffer.
10733	Gets called by the IDisplay object where this frame buffer is
10734	bound to.
10735	</desc>
10736	</method>
10737
10738	<method name="unlock">
10739	<desc>
10740	Unlocks the frame buffer.
10741	Gets called by the IDisplay object where this frame buffer is
10742	bound to.
10743	</desc>
10744	</method>
10745
10746	<method name="notifyUpdate">
10747	<desc>
10748	Informs about an update.
10749	Gets called by the display object where this buffer is
10750	registered.
10751	</desc>
10752	<param name="x" type="unsigned long" dir="in"/>
10753	<param name="y" type="unsigned long" dir="in"/>
10754	<param name="width" type="unsigned long" dir="in"/>
10755	<param name="height" type="unsigned long" dir="in"/>
10756	</method>
10757
10758	<method name="requestResize">
10759	<desc>
10760	Requests a size and pixel format change.
10761
10762	There are two modes of working with the video buffer of the virtual
10763	machine. The <i>indirect</i> mode implies that the IFramebuffer
10764	implementation allocates a memory buffer for the requested display mode
10765	and provides it to the virtual machine. In <i>direct</i> mode, the
10766	IFramebuffer implementation uses the memory buffer allocated and owned
10767	by the virtual machine. This buffer represents the video memory of the
10768	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10769	usually faster because the implementation gets a raw pointer to the
10770	guest VRAM buffer which it can directly use for visualizing the contents
10771	of the virtual display, as opposed to the indirect mode where the
10772	contents of guest VRAM are copied to the memory buffer provided by
10773	the implementation every time a display update occurs.
10774
10775	It is important to note that the direct mode is really fast only when
10776	the implementation uses the given guest VRAM buffer directly, for
10777	example, by blitting it to the window representing the virtual machine's
10778	display, which saves at least one copy operation comparing to the
10779	indirect mode. However, using the guest VRAM buffer directly is not
10780	always possible: the format and the color depth of this buffer may be
10781	not supported by the target window, or it may be unknown (opaque) as in
10782	case of text or non-linear multi-plane VGA video modes. In this case,
10783	the indirect mode (that is always available) should be used as a
10784	fallback: when the guest VRAM contents are copied to the
10785	implementation-provided memory buffer, color and format conversion is
10786	done automatically by the underlying code.
10787
10788	The @a pixelFormat parameter defines whether the direct mode is
10789	available or not. If @a pixelFormat is <link
10790	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10791	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10792	@a bytesPerLine parameters must be ignored and the implementation must use
10793	the indirect mode (where it provides its own buffer in one of the
10794	supported formats). In all other cases, @a pixelFormat together with
10795	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10796	buffer pointed to by the @a VRAM parameter and the implementation is
10797	free to choose which mode to use. To indicate that this frame buffer uses
10798	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10799	attribute must return @c true and <link to="#address"/> must
10800	return exactly the same address that is passed in the @a VRAM parameter
10801	of this method; otherwise it is assumed that the indirect strategy is
10802	chosen.
10803
10804	The @a width and @a height parameters represent the size of the
10805	requested display mode in both modes. In case of indirect mode, the
10806	provided memory buffer should be big enough to store data of the given
10807	display mode. In case of direct mode, it is guaranteed that the given
10808	@a VRAM buffer contains enough space to represent the display mode of the
10809	given size. Note that this frame buffer's <link to="#width"/> and <link
10810	to="#height"/> attributes must return exactly the same values as
10811	passed to this method after the resize is completed (see below).
10812
10813	The @a finished output parameter determines if the implementation has
10814	finished resizing the frame buffer or not. If, for some reason, the
10815	resize cannot be finished immediately during this call, @a finished
10816	must be set to @c false, and the implementation must call
10817	<link to="IDisplay::resizeCompleted"/> after it has returned from
10818	this method as soon as possible. If @a finished is @c false, the
10819	machine will not call any frame buffer methods until
10820	<link to="IDisplay::resizeCompleted"/> is called.
10821
10822	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10823	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10824	this frame buffer must return exactly the same values as specified in the
10825	parameters of this method, after the resize is completed. If the
10826	indirect mode is chosen, these attributes must return values describing
10827	the format of the implementation's own memory buffer <link
10828	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10829	value must always correlate with <link to="#pixelFormat"/>. Note that
10830	the <link to="#pixelFormat"/> attribute must never return <link
10831	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10832
10833	<note>
10834	This method is called by the IDisplay object under the
10835	<link to="#lock"/> provided by this IFramebuffer
10836	implementation. If this method returns @c false in @a finished, then
10837	this lock is not released until
10838	<link to="IDisplay::resizeCompleted"/> is called.
10839	</note>
10840	</desc>
10841	<param name="screenId" type="unsigned long" dir="in">
10842	<desc>
10843	Logical screen number. Must be used in the corresponding call to
10844	<link to="IDisplay::resizeCompleted"/> if this call is made.
10845	</desc>
10846	</param>
10847	<param name="pixelFormat" type="unsigned long" dir="in">
10848	<desc>
10849	Pixel format of the memory buffer pointed to by @a VRAM.
10850	See also <link to="FramebufferPixelFormat"/>.
10851	</desc>
10852	</param>
10853	<param name="VRAM" type="octet" mod="ptr" dir="in">
10854	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10855	</param>
10856	<param name="bitsPerPixel" type="unsigned long" dir="in">
10857	<desc>Color depth, bits per pixel.</desc>
10858	</param>
10859	<param name="bytesPerLine" type="unsigned long" dir="in">
10860	<desc>Size of one scan line, in bytes.</desc>
10861	</param>
10862	<param name="width" type="unsigned long" dir="in">
10863	<desc>Width of the guest display, in pixels.</desc>
10864	</param>
10865	<param name="height" type="unsigned long" dir="in">
10866	<desc>Height of the guest display, in pixels.</desc>
10867	</param>
10868	<param name="finished" type="boolean" dir="return">
10869	<desc>
10870	Can the VM start using the new frame buffer immediately
10871	after this method returns or it should wait for
10872	<link to="IDisplay::resizeCompleted"/>.
10873	</desc>
10874	</param>
10875	</method>
10876
10877	<method name="videoModeSupported">
10878	<desc>
10879	Returns whether the frame buffer implementation is willing to
10880	support a given video mode. In case it is not able to render
10881	the video mode (or for some reason not willing), it should
10882	return @c false. Usually this method is called when the guest
10883	asks the VMM device whether a given video mode is supported
10884	so the information returned is directly exposed to the guest.
10885	It is important that this method returns very quickly.
10886	</desc>
10887	<param name="width" type="unsigned long" dir="in"/>
10888	<param name="height" type="unsigned long" dir="in"/>
10889	<param name="bpp" type="unsigned long" dir="in"/>
10890	<param name="supported" type="boolean" dir="return"/>
10891	</method>
10892
10893	<method name="getVisibleRegion">
10894	<desc>
10895	Returns the visible region of this frame buffer.
10896
10897	If the @a rectangles parameter is @c null then the value of the
10898	@a count parameter is ignored and the number of elements necessary to
10899	describe the current visible region is returned in @a countCopied.
10900
10901	If @a rectangles is not @c null but @a count is less
10902	than the required number of elements to store region data, the method
10903	will report a failure. If @a count is equal or greater than the
10904	required number of elements, then the actual number of elements copied
10905	to the provided array will be returned in @a countCopied.
10906
10907	<note>
10908	The address of the provided array must be in the process space of
10909	this IFramebuffer object.
10910	</note>
10911	<note>
10912	Method not yet implemented.
10913	</note>
10914	</desc>
10915	<param name="rectangles" type="octet" mod="ptr" dir="in">
10916	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10917	</param>
10918	<param name="count" type="unsigned long" dir="in">
10919	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10920	</param>
10921	<param name="countCopied" type="unsigned long" dir="return">
10922	<desc>Number of elements copied to the @a rectangles array.</desc>
10923	</param>
10924	</method>
10925
10926	<method name="setVisibleRegion">
10927	<desc>
10928	Suggests a new visible region to this frame buffer. This region
10929	represents the area of the VM display which is a union of regions of
10930	all top-level windows of the guest operating system running inside the
10931	VM (if the Guest Additions for this system support this
10932	functionality). This information may be used by the frontends to
10933	implement the seamless desktop integration feature.
10934
10935	<note>
10936	The address of the provided array must be in the process space of
10937	this IFramebuffer object.
10938	</note>
10939	<note>
10940	The IFramebuffer implementation must make a copy of the provided
10941	array of rectangles.
10942	</note>
10943	<note>
10944	Method not yet implemented.
10945	</note>
10946	</desc>
10947	<param name="rectangles" type="octet" mod="ptr" dir="in">
10948	<desc>Pointer to the @c RTRECT array.</desc>
10949	</param>
10950	<param name="count" type="unsigned long" dir="in">
10951	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10952	</param>
10953	</method>
10954
10955	<method name="processVHWACommand">
10956	<desc>
10957	Posts a Video HW Acceleration Command to the frame buffer for processing.
10958	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10959	are posted from quest to the host to be processed by the host hardware.
10960
10961	<note>
10962	The address of the provided command must be in the process space of
10963	this IFramebuffer object.
10964	</note>
10965	</desc>
10966
10967	<param name="command" type="octet" mod="ptr" dir="in">
10968	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10969	</param>
10970	</method>
10971
10972	</interface>
10973
10974	<interface
10975	name="IFramebufferOverlay" extends="IFramebuffer"
10976	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10977	wsmap="suppress"
10978	>
10979	<desc>
10980	The IFramebufferOverlay interface represents an alpha blended overlay
10981	for displaying status icons above an IFramebuffer. It is always created
10982	not visible, so that it must be explicitly shown. It only covers a
10983	portion of the IFramebuffer, determined by its width, height and
10984	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10985	that order) format, and may be written to directly. Do re-read the
10986	width though, after setting it, as it may be adjusted (increased) to
10987	make it more suitable for the front end.
10988	</desc>
10989	<attribute name="x" type="unsigned long" readonly="yes">
10990	<desc>X position of the overlay, relative to the frame buffer.</desc>
10991	</attribute>
10992
10993	<attribute name="y" type="unsigned long" readonly="yes">
10994	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10995	</attribute>
10996
10997	<attribute name="visible" type="boolean" readonly="no">
10998	<desc>
10999	Whether the overlay is currently visible.
11000	</desc>
11001	</attribute>
11002
11003	<attribute name="alpha" type="unsigned long" readonly="no">
11004	<desc>
11005	The global alpha value for the overlay. This may or may not be
11006	supported by a given front end.
11007	</desc>
11008	</attribute>
11009
11010	<method name="move">
11011	<desc>
11012	Changes the overlay's position relative to the IFramebuffer.
11013	</desc>
11014	<param name="x" type="unsigned long" dir="in"/>
11015	<param name="y" type="unsigned long" dir="in"/>
11016	</method>
11017
11018	</interface>
11019
11020	<interface
11021	name="IDisplay" extends="$unknown"
11022	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
11023	wsmap="managed"
11024	>
11025	<desc>
11026	The IDisplay interface represents the virtual machine's display.
11027
11028	The object implementing this interface is contained in each
11029	<link to="IConsole::display"/> attribute and represents the visual
11030	output of the virtual machine.
11031
11032	The virtual display supports pluggable output targets represented by the
11033	IFramebuffer interface. Examples of the output target are a window on
11034	the host computer or an RDP session's display on a remote computer.
11035	</desc>
11036	<attribute name="width" type="unsigned long" readonly="yes">
11037	<desc>Current display width.</desc>
11038	</attribute>
11039
11040	<attribute name="height" type="unsigned long" readonly="yes">
11041	<desc>Current display height.</desc>
11042	</attribute>
11043
11044	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11045	<desc>
11046	Current guest display color depth. Note that this may differ
11047	from <link to="IFramebuffer::bitsPerPixel"/>.
11048	</desc>
11049	</attribute>
11050
11051	<method name="setFramebuffer">
11052	<desc>
11053	Sets the framebuffer for given screen.
11054	</desc>
11055	<param name="screenId" type="unsigned long" dir="in"/>
11056	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11057	</method>
11058
11059	<method name="getFramebuffer">
11060	<desc>
11061	Queries the framebuffer for given screen.
11062	</desc>
11063	<param name="screenId" type="unsigned long" dir="in"/>
11064	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11065	<param name="xOrigin" type="long" dir="out"/>
11066	<param name="yOrigin" type="long" dir="out"/>
11067	</method>
11068
11069	<method name="setVideoModeHint">
11070	<desc>
11071	Asks VirtualBox to request the given video mode from
11072	the guest. This is just a hint and it cannot be guaranteed
11073	that the requested resolution will be used. Guest Additions
11074	are required for the request to be seen by guests. The caller
11075	should issue the request and wait for a resolution change and
11076	after a timeout retry.
11077
11078	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11079	parameters means that the corresponding values should be taken from the
11080	current video mode (i.e. left unchanged).
11081
11082	If the guest OS supports multi-monitor configuration then the @a display
11083	parameter specifies the number of the guest display to send the hint to:
11084	@c 0 is the primary display, @c 1 is the first secondary and
11085	so on. If the multi-monitor configuration is not supported, @a display
11086	must be @c 0.
11087
11088	<result name="E_INVALIDARG">
11089	The @a display is not associated with any monitor.
11090	</result>
11091
11092	</desc>
11093	<param name="width" type="unsigned long" dir="in"/>
11094	<param name="height" type="unsigned long" dir="in"/>
11095	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11096	<param name="display" type="unsigned long" dir="in"/>
11097	</method>
11098
11099	<method name="setSeamlessMode">
11100	<desc>
11101	Enables or disables seamless guest display rendering (seamless desktop
11102	integration) mode.
11103	<note>
11104	Calling this method has no effect if <link
11105	to="IGuest::supportsSeamless"/> returns @c false.
11106	</note>
11107	</desc>
11108	<param name="enabled" type="boolean" dir="in"/>
11109	</method>
11110
11111	<method name="takeScreenShot">
11112	<desc>
11113	Takes a screen shot of the requested size and copies it to the
11114	32-bpp buffer allocated by the caller and pointed to by @a address.
11115	A pixel consists of 4 bytes in order: B, G, R, 0.
11116
11117	<note>This API can be used only by the COM/XPCOM C++ API as it
11118	requires pointer support. Use <link to="#takeScreenShotSlow" />
11119	with other language bindings.
11120	</note>
11121
11122	<result name="E_NOTIMPL">
11123	Feature not implemented.
11124	</result>
11125	<result name="VBOX_E_IPRT_ERROR">
11126	Could not take a screenshot.
11127	</result>
11128
11129	</desc>
11130	<param name="address" type="octet" mod="ptr" dir="in"/>
11131	<param name="width" type="unsigned long" dir="in"/>
11132	<param name="height" type="unsigned long" dir="in"/>
11133	</method>
11134
11135	<method name="takeScreenShotSlow">
11136	<desc>
11137	Takes a guest screen shot of the requested size and returns it as
11138	an array of bytes in uncompressed 32-bit RGBA format.
11139	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11140
11141	This API is slow, but could be the only option to get guest screenshot
11142	for scriptable languages not allowed to manipulate with addresses
11143	directly.
11144
11145	<result name="E_NOTIMPL">
11146	Feature not implemented.
11147	</result>
11148	<result name="VBOX_E_IPRT_ERROR">
11149	Could not take a screenshot.
11150	</result>
11151	</desc>
11152	<param name="width" type="unsigned long" dir="in">
11153	<desc>
11154	Desired image width.
11155	</desc>
11156	</param>
11157	<param name="height" type="unsigned long" dir="in">
11158	<desc>
11159	Desired image height.
11160	</desc>
11161	</param>
11162	<param name="screenData" type="octet" dir="return" safearray="yes">
11163	<desc>
11164	Array with resulting screen data.
11165	</desc>
11166	</param>
11167	</method>
11168
11169	<method name="drawToScreen">
11170	<desc>
11171	Draws a 32-bpp image of the specified size from the given buffer
11172	to the given point on the VM display.
11173
11174	<result name="E_NOTIMPL">
11175	Feature not implemented.
11176	</result>
11177	<result name="VBOX_E_IPRT_ERROR">
11178	Could not draw to screen.
11179	</result>
11180
11181	</desc>
11182	<param name="address" type="octet" mod="ptr" dir="in"/>
11183	<param name="x" type="unsigned long" dir="in"/>
11184	<param name="y" type="unsigned long" dir="in"/>
11185	<param name="width" type="unsigned long" dir="in"/>
11186	<param name="height" type="unsigned long" dir="in"/>
11187	</method>
11188
11189	<method name="invalidateAndUpdate">
11190	<desc>
11191	Does a full invalidation of the VM display and instructs the VM
11192	to update it.
11193
11194	<result name="VBOX_E_IPRT_ERROR">
11195	Could not invalidate and update screen.
11196	</result>
11197
11198	</desc>
11199	</method>
11200
11201	<method name="resizeCompleted">
11202	<desc>
11203	Signals that a framebuffer has completed the resize operation.
11204
11205	<result name="VBOX_E_NOT_SUPPORTED">
11206	Operation only valid for external frame buffers.
11207	</result>
11208
11209	</desc>
11210	<param name="screenId" type="unsigned long" dir="in"/>
11211	</method>
11212
11213	<method name="updateCompleted">
11214	<desc>
11215	Signals that a framebuffer has completed the update operation.
11216
11217	<result name="VBOX_E_NOT_SUPPORTED">
11218	Operation only valid for external frame buffers.
11219	</result>
11220
11221	</desc>
11222	</method>
11223
11224	<method name="completeVHWACommand">
11225	<desc>
11226	Signals that the Video HW Acceleration command has completed.
11227	</desc>
11228
11229	<param name="command" type="octet" mod="ptr" dir="in">
11230	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11231	</param>
11232	</method>
11233
11234	</interface>
11235
11236	<!--
11237	// INetworkAdapter
11238	/////////////////////////////////////////////////////////////////////////
11239	-->
11240
11241	<enum
11242	name="NetworkAttachmentType"
11243	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11244	>
11245	<desc>
11246	Network attachment type.
11247	</desc>
11248
11249	<const name="Null" value="0">
11250	<desc>Null value, also means "not attached".</desc>
11251	</const>
11252	<const name="NAT" value="1"/>
11253	<const name="Bridged" value="2"/>
11254	<const name="Internal" value="3"/>
11255	<const name="HostOnly" value="4"/>
11256	</enum>
11257
11258	<enum
11259	name="NetworkAdapterType"
11260	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11261	>
11262	<desc>
11263	Network adapter type.
11264	</desc>
11265
11266	<const name="Null" value="0">
11267	<desc>Null value (never used by the API).</desc>
11268	</const>
11269	<const name="Am79C970A" value="1">
11270	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11271	</const>
11272	<const name="Am79C973" value="2">
11273	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11274	</const>
11275	<const name="I82540EM" value="3">
11276	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11277	</const>
11278	<const name="I82543GC" value="4">
11279	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11280	</const>
11281	<const name="I82545EM" value="5">
11282	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11283	</const>
11284	<const name="Virtio" value="6">
11285	<desc>Virtio network device.</desc>
11286	</const>
11287	</enum>
11288
11289	<interface
11290	name="INetworkAdapter" extends="$unknown"
11291	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11292	wsmap="managed"
11293	>
11294	<desc>
11295	Represents a virtual network adapter that is attached to a virtual machine.
11296	Each virtual machine has a fixed number of network adapter slots with one
11297	instance of this attached to each of them. Call
11298	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11299	is attached to a given slot in a given machine.
11300
11301	Each network adapter can be in one of five attachment modes, which are
11302	represented by the <link to="NetworkAttachmentType" /> enumeration;
11303	see the <link to="#attachmentType" /> attribute.
11304	</desc>
11305
11306	<attribute name="adapterType" type="NetworkAdapterType">
11307	<desc>
11308	Type of the virtual network adapter. Depending on this value,
11309	VirtualBox will provide a different virtual network hardware
11310	to the guest.
11311	</desc>
11312	</attribute>
11313
11314	<attribute name="slot" type="unsigned long" readonly="yes">
11315	<desc>
11316	Slot number this adapter is plugged into. Corresponds to
11317	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11318	to obtain this instance.
11319	</desc>
11320	</attribute>
11321
11322	<attribute name="enabled" type="boolean">
11323	<desc>
11324	Flag whether the network adapter is present in the
11325	guest system. If disabled, the virtual guest hardware will
11326	not contain this network adapter. Can only be changed when
11327	the VM is not running.
11328	</desc>
11329	</attribute>
11330
11331	<attribute name="MACAddress" type="wstring">
11332	<desc>
11333	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11334	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11335	</desc>
11336	</attribute>
11337
11338	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11339
11340	<attribute name="hostInterface" type="wstring">
11341	<desc>
11342	Name of the host network interface the VM is attached to.
11343	</desc>
11344	</attribute>
11345
11346	<attribute name="internalNetwork" type="wstring">
11347	<desc>
11348	Name of the internal network the VM is attached to.
11349	</desc>
11350	</attribute>
11351
11352	<attribute name="NATNetwork" type="wstring">
11353	<desc>
11354	Name of the NAT network the VM is attached to.
11355	</desc>
11356	</attribute>
11357
11358	<attribute name="cableConnected" type="boolean">
11359	<desc>
11360	Flag whether the adapter reports the cable as connected or not.
11361	It can be used to report offline situations to a VM.
11362	</desc>
11363	</attribute>
11364
11365	<attribute name="lineSpeed" type="unsigned long">
11366	<desc>
11367	Line speed reported by custom drivers, in units of 1 kbps.
11368	</desc>
11369	</attribute>
11370
11371	<attribute name="traceEnabled" type="boolean">
11372	<desc>
11373	Flag whether network traffic from/to the network card should be traced.
11374	Can only be toggled when the VM is turned off.
11375	</desc>
11376	</attribute>
11377
11378	<attribute name="traceFile" type="wstring">
11379	<desc>
11380	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11381	will be used.
11382	</desc>
11383	</attribute>
11384
11385	<method name="attachToNAT">
11386	<desc>
11387	Attach the network adapter to the Network Address Translation (NAT) interface.
11388	</desc>
11389	</method>
11390
11391	<method name="attachToBridgedInterface">
11392	<desc>
11393	Attach the network adapter to a bridged host interface.
11394	</desc>
11395	</method>
11396
11397	<method name="attachToInternalNetwork">
11398	<desc>
11399	Attach the network adapter to an internal network.
11400	</desc>
11401	</method>
11402
11403	<method name="attachToHostOnlyInterface">
11404	<desc>
11405	Attach the network adapter to the host-only network.
11406	</desc>
11407	</method>
11408
11409	<method name="detach">
11410	<desc>
11411	Detach the network adapter
11412	</desc>
11413	</method>
11414	</interface>
11415
11416
11417	<!--
11418	// ISerialPort
11419	/////////////////////////////////////////////////////////////////////////
11420	-->
11421
11422	<enum
11423	name="PortMode"
11424	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11425	>
11426	<desc>
11427	The PortMode enumeration represents possible communication modes for
11428	the virtual serial port device.
11429	</desc>
11430
11431	<const name="Disconnected" value="0">
11432	<desc>Virtual device is not attached to any real host device.</desc>
11433	</const>
11434	<const name="HostPipe" value="1">
11435	<desc>Virtual device is attached to a host pipe.</desc>
11436	</const>
11437	<const name="HostDevice" value="2">
11438	<desc>Virtual device is attached to a host device.</desc>
11439	</const>
11440	<const name="RawFile" value="3">
11441	<desc>Virtual device is attached to a raw file.</desc>
11442	</const>
11443	</enum>
11444
11445	<interface
11446	name="ISerialPort" extends="$unknown"
11447	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11448	wsmap="managed"
11449	>
11450
11451	<desc>
11452	The ISerialPort interface represents the virtual serial port device.
11453
11454	The virtual serial port device acts like an ordinary serial port
11455	inside the virtual machine. This device communicates to the real
11456	serial port hardware in one of two modes: host pipe or host device.
11457
11458	In host pipe mode, the #path attribute specifies the path to the pipe on
11459	the host computer that represents a serial port. The #server attribute
11460	determines if this pipe is created by the virtual machine process at
11461	machine startup or it must already exist before starting machine
11462	execution.
11463
11464	In host device mode, the #path attribute specifies the name of the
11465	serial port device on the host computer.
11466
11467	There is also a third communication mode: the disconnected mode. In this
11468	mode, the guest OS running inside the virtual machine will be able to
11469	detect the serial port, but all port write operations will be discarded
11470	and all port read operations will return no data.
11471
11472	<see>IMachine::getSerialPort</see>
11473	</desc>
11474
11475	<attribute name="slot" type="unsigned long" readonly="yes">
11476	<desc>
11477	Slot number this serial port is plugged into. Corresponds to
11478	the value you pass to <link to="IMachine::getSerialPort"/>
11479	to obtain this instance.
11480	</desc>
11481	</attribute>
11482
11483	<attribute name="enabled" type="boolean">
11484	<desc>
11485	Flag whether the serial port is enabled. If disabled,
11486	the serial port will not be reported to the guest OS.
11487	</desc>
11488	</attribute>
11489
11490	<attribute name="IOBase" type="unsigned long">
11491	<desc>Base I/O address of the serial port.</desc>
11492	</attribute>
11493
11494	<attribute name="IRQ" type="unsigned long">
11495	<desc>IRQ number of the serial port.</desc>
11496	</attribute>
11497
11498	<attribute name="hostMode" type="PortMode">
11499	<desc>
11500	How is this port connected to the host.
11501	<note>
11502	Changing this attribute may fail if the conditions for
11503	<link to="#path"/> are not met.
11504	</note>
11505	</desc>
11506	</attribute>
11507
11508	<attribute name="server" type="boolean">
11509	<desc>
11510	Flag whether this serial port acts as a server (creates a new pipe on
11511	the host) or as a client (uses the existing pipe). This attribute is
11512	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11513	</desc>
11514	</attribute>
11515
11516	<attribute name="path" type="wstring">
11517	<desc>
11518	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11519	PortMode_HostPipe, or the host serial device name when
11520	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11521	cases, setting a @c null or empty string as the attribute's value
11522	is an error. Otherwise, the value of this property is ignored.
11523	</desc>
11524	</attribute>
11525
11526	</interface>
11527
11528	<!--
11529	// IParallelPort
11530	/////////////////////////////////////////////////////////////////////////
11531	-->
11532
11533	<interface
11534	name="IParallelPort" extends="$unknown"
11535	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11536	wsmap="managed"
11537	>
11538
11539	<desc>
11540	The IParallelPort interface represents the virtual parallel port device.
11541
11542	The virtual parallel port device acts like an ordinary parallel port
11543	inside the virtual machine. This device communicates to the real
11544	parallel port hardware using the name of the parallel device on the host
11545	computer specified in the #path attribute.
11546
11547	Each virtual parallel port device is assigned a base I/O address and an
11548	IRQ number that will be reported to the guest operating system and used
11549	to operate the given parallel port from within the virtual machine.
11550
11551	<see>IMachine::getParallelPort</see>
11552	</desc>
11553
11554	<attribute name="slot" type="unsigned long" readonly="yes">
11555	<desc>
11556	Slot number this parallel port is plugged into. Corresponds to
11557	the value you pass to <link to="IMachine::getParallelPort"/>
11558	to obtain this instance.
11559	</desc>
11560	</attribute>
11561
11562	<attribute name="enabled" type="boolean">
11563	<desc>
11564	Flag whether the parallel port is enabled. If disabled,
11565	the parallel port will not be reported to the guest OS.
11566	</desc>
11567	</attribute>
11568
11569	<attribute name="IOBase" type="unsigned long">
11570	<desc>Base I/O address of the parallel port.</desc>
11571	</attribute>
11572
11573	<attribute name="IRQ" type="unsigned long">
11574	<desc>IRQ number of the parallel port.</desc>
11575	</attribute>
11576
11577	<attribute name="path" type="wstring">
11578	<desc>
11579	Host parallel device name. If this parallel port is enabled, setting a
11580	@c null or an empty string as this attribute's value will result into
11581	an error.
11582	</desc>
11583	</attribute>
11584
11585	</interface>
11586
11587
11588	<!--
11589	// IMachineDebugger
11590	/////////////////////////////////////////////////////////////////////////
11591	-->
11592
11593	<interface
11594	name="IMachineDebugger" extends="$unknown"
11595	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11596	wsmap="suppress"
11597	>
11598	<method name="resetStats">
11599	<desc>
11600	Reset VM statistics.
11601	</desc>
11602	<param name="pattern" type="wstring" dir="in">
11603	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11604	</param>
11605	</method>
11606
11607	<method name="dumpStats">
11608	<desc>
11609	Dumps VM statistics.
11610	</desc>
11611	<param name="pattern" type="wstring" dir="in">
11612	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11613	</param>
11614	</method>
11615
11616	<method name="getStats">
11617	<desc>
11618	Get the VM statistics in a XMLish format.
11619	</desc>
11620	<param name="pattern" type="wstring" dir="in">
11621	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11622	</param>
11623	<param name="withDescriptions" type="boolean" dir="in">
11624	<desc>Whether to include the descriptions.</desc>
11625	</param>
11626	<param name="stats" type="wstring" dir="out">
11627	<desc>The XML document containing the statistics.</desc>
11628	</param>
11629	</method>
11630
11631	<method name="injectNMI">
11632	<desc>
11633	Inject an NMI into a running VT-x/AMD-V VM.
11634	</desc>
11635	</method>
11636
11637	<attribute name="singlestep" type="boolean">
11638	<desc>Switch for enabling singlestepping.</desc>
11639	</attribute>
11640
11641	<attribute name="recompileUser" type="boolean">
11642	<desc>Switch for forcing code recompilation for user mode code.</desc>
11643	</attribute>
11644
11645	<attribute name="recompileSupervisor" type="boolean">
11646	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11647	</attribute>
11648
11649	<attribute name="PATMEnabled" type="boolean">
11650	<desc>Switch for enabling and disabling the PATM component.</desc>
11651	</attribute>
11652
11653	<attribute name="CSAMEnabled" type="boolean">
11654	<desc>Switch for enabling and disabling the CSAM component.</desc>
11655	</attribute>
11656
11657	<attribute name="logEnabled" type="boolean">
11658	<desc>Switch for enabling and disabling logging.</desc>
11659	</attribute>
11660
11661	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11662	<desc>
11663	Flag indicating whether the VM is currently making use of CPU hardware
11664	virtualization extensions.
11665	</desc>
11666	</attribute>
11667
11668	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11669	<desc>
11670	Flag indicating whether the VM is currently making use of the nested paging
11671	CPU hardware virtualization extension.
11672	</desc>
11673	</attribute>
11674
11675	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11676	<desc>
11677	Flag indicating whether the VM is currently making use of the VPID
11678	VT-x extension.
11679	</desc>
11680	</attribute>
11681
11682	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11683	<desc>
11684	Flag indicating whether the VM is currently making use of the Physical
11685	Address Extension CPU feature.
11686	</desc>
11687	</attribute>
11688
11689	<attribute name="virtualTimeRate" type="unsigned long">
11690	<desc>
11691	The rate at which the virtual time runs expressed as a percentage.
11692	The accepted range is 2% to 20000%.
11693	</desc>
11694	</attribute>
11695
11696	<!-- @todo method for setting log flags, groups and destination! -->
11697
11698	<attribute name="VM" type="unsigned long long" readonly="yes">
11699	<desc>
11700	Gets the VM handle. This is only for internal use while
11701	we carve the details of this interface.
11702	</desc>
11703	</attribute>
11704
11705	</interface>
11706
11707	<!--
11708	// IUSBController
11709	/////////////////////////////////////////////////////////////////////////
11710	-->
11711
11712	<interface
11713	name="IUSBController" extends="$unknown"
11714	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11715	wsmap="managed"
11716	>
11717	<attribute name="enabled" type="boolean">
11718	<desc>
11719	Flag whether the USB controller is present in the
11720	guest system. If disabled, the virtual guest hardware will
11721	not contain any USB controller. Can only be changed when
11722	the VM is powered off.
11723	</desc>
11724	</attribute>
11725
11726	<attribute name="enabledEhci" type="boolean">
11727	<desc>
11728	Flag whether the USB EHCI controller is present in the
11729	guest system. If disabled, the virtual guest hardware will
11730	not contain a USB EHCI controller. Can only be changed when
11731	the VM is powered off.
11732	</desc>
11733	</attribute>
11734
11735	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11736	<desc>
11737	USB standard version which the controller implements.
11738	This is a BCD which means that the major version is in the
11739	high byte and minor version is in the low byte.
11740	</desc>
11741	</attribute>
11742
11743	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11744	<desc>
11745	List of USB device filters associated with the machine.
11746
11747	If the machine is currently running, these filters are activated
11748	every time a new (supported) USB device is attached to the host
11749	computer that was not ignored by global filters
11750	(<link to="IHost::USBDeviceFilters"/>).
11751
11752	These filters are also activated when the machine is powered up.
11753	They are run against a list of all currently available USB
11754	devices (in states
11755	<link to="USBDeviceState_Available"/>,
11756	<link to="USBDeviceState_Busy"/>,
11757	<link to="USBDeviceState_Held"/>) that were not previously
11758	ignored by global filters.
11759
11760	If at least one filter matches the USB device in question, this
11761	device is automatically captured (attached to) the virtual USB
11762	controller of this machine.
11763
11764	<see>IUSBDeviceFilter, ::IUSBController</see>
11765	</desc>
11766	</attribute>
11767
11768	<method name="createDeviceFilter">
11769	<desc>
11770	Creates a new USB device filter. All attributes except
11771	the filter name are set to empty (any match),
11772	<i>active</i> is @c false (the filter is not active).
11773
11774	The created filter can then be added to the list of filters using
11775	<link to="#insertDeviceFilter"/>.
11776
11777	<result name="VBOX_E_INVALID_VM_STATE">
11778	The virtual machine is not mutable.
11779	</result>
11780
11781	<see>#deviceFilters</see>
11782	</desc>
11783	<param name="name" type="wstring" dir="in">
11784	<desc>
11785	Filter name. See <link to="IUSBDeviceFilter::name"/>
11786	for more info.
11787	</desc>
11788	</param>
11789	<param name="filter" type="IUSBDeviceFilter" dir="return">
11790	<desc>Created filter object.</desc>
11791	</param>
11792	</method>
11793
11794	<method name="insertDeviceFilter">
11795	<desc>
11796	Inserts the given USB device to the specified position
11797	in the list of filters.
11798
11799	Positions are numbered starting from <tt>0</tt>. If the specified
11800	position is equal to or greater than the number of elements in
11801	the list, the filter is added to the end of the collection.
11802
11803	<note>
11804	Duplicates are not allowed, so an attempt to insert a
11805	filter that is already in the collection, will return an
11806	error.
11807	</note>
11808
11809	<result name="VBOX_E_INVALID_VM_STATE">
11810	Virtual machine is not mutable.
11811	</result>
11812	<result name="E_INVALIDARG">
11813	USB device filter not created within this VirtualBox instance.
11814	</result>
11815	<result name="VBOX_E_INVALID_OBJECT_STATE">
11816	USB device filter already in list.
11817	</result>
11818
11819	<see>#deviceFilters</see>
11820	</desc>
11821	<param name="position" type="unsigned long" dir="in">
11822	<desc>Position to insert the filter to.</desc>
11823	</param>
11824	<param name="filter" type="IUSBDeviceFilter" dir="in">
11825	<desc>USB device filter to insert.</desc>
11826	</param>
11827	</method>
11828
11829	<method name="removeDeviceFilter">
11830	<desc>
11831	Removes a USB device filter from the specified position in the
11832	list of filters.
11833
11834	Positions are numbered starting from <tt>0</tt>. Specifying a
11835	position equal to or greater than the number of elements in
11836	the list will produce an error.
11837
11838	<see>#deviceFilters</see>
11839
11840	<result name="VBOX_E_INVALID_VM_STATE">
11841	Virtual machine is not mutable.
11842	</result>
11843	<result name="E_INVALIDARG">
11844	USB device filter list empty or invalid @a position.
11845	</result>
11846
11847	</desc>
11848	<param name="position" type="unsigned long" dir="in">
11849	<desc>Position to remove the filter from.</desc>
11850	</param>
11851	<param name="filter" type="IUSBDeviceFilter" dir="return">
11852	<desc>Removed USB device filter.</desc>
11853	</param>
11854	</method>
11855
11856	</interface>
11857
11858
11859	<!--
11860	// IUSBDevice
11861	/////////////////////////////////////////////////////////////////////////
11862	-->
11863
11864	<interface
11865	name="IUSBDevice" extends="$unknown"
11866	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11867	wsmap="managed"
11868	>
11869	<desc>
11870	The IUSBDevice interface represents a virtual USB device attached to the
11871	virtual machine.
11872
11873	A collection of objects implementing this interface is stored in the
11874	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11875	attached to a running virtual machine's USB controller.
11876	</desc>
11877
11878	<attribute name="id" type="uuid" mod="string" readonly="yes">
11879	<desc>
11880	Unique USB device ID. This ID is built from #vendorId,
11881	#productId, #revision and #serialNumber.
11882	</desc>
11883	</attribute>
11884
11885	<attribute name="vendorId" type="unsigned short" readonly="yes">
11886	<desc>Vendor ID.</desc>
11887	</attribute>
11888
11889	<attribute name="productId" type="unsigned short" readonly="yes">
11890	<desc>Product ID.</desc>
11891	</attribute>
11892
11893	<attribute name="revision" type="unsigned short" readonly="yes">
11894	<desc>
11895	Product revision number. This is a packed BCD represented as
11896	unsigned short. The high byte is the integer part and the low
11897	byte is the decimal.
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="manufacturer" type="wstring" readonly="yes">
11902	<desc>Manufacturer string.</desc>
11903	</attribute>
11904
11905	<attribute name="product" type="wstring" readonly="yes">
11906	<desc>Product string.</desc>
11907	</attribute>
11908
11909	<attribute name="serialNumber" type="wstring" readonly="yes">
11910	<desc>Serial number string.</desc>
11911	</attribute>
11912
11913	<attribute name="address" type="wstring" readonly="yes">
11914	<desc>Host specific address of the device.</desc>
11915	</attribute>
11916
11917	<attribute name="port" type="unsigned short" readonly="yes">
11918	<desc>
11919	Host USB port number the device is physically
11920	connected to.
11921	</desc>
11922	</attribute>
11923
11924	<attribute name="version" type="unsigned short" readonly="yes">
11925	<desc>
11926	The major USB version of the device - 1 or 2.
11927	</desc>
11928	</attribute>
11929
11930	<attribute name="portVersion" type="unsigned short" readonly="yes">
11931	<desc>
11932	The major USB version of the host USB port the device is
11933	physically connected to - 1 or 2. For devices not connected to
11934	anything this will have the same value as the version attribute.
11935	</desc>
11936	</attribute>
11937
11938	<attribute name="remote" type="boolean" readonly="yes">
11939	<desc>
11940	Whether the device is physically connected to a remote VRDP
11941	client or to a local host machine.
11942	</desc>
11943	</attribute>
11944
11945	</interface>
11946
11947
11948	<!--
11949	// IUSBDeviceFilter
11950	/////////////////////////////////////////////////////////////////////////
11951	-->
11952
11953	<interface
11954	name="IUSBDeviceFilter" extends="$unknown"
11955	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11956	wsmap="managed"
11957	>
11958	<desc>
11959	The IUSBDeviceFilter interface represents an USB device filter used
11960	to perform actions on a group of USB devices.
11961
11962	This type of filters is used by running virtual machines to
11963	automatically capture selected USB devices once they are physically
11964	attached to the host computer.
11965
11966	A USB device is matched to the given device filter if and only if all
11967	attributes of the device match the corresponding attributes of the
11968	filter (that is, attributes are joined together using the logical AND
11969	operation). On the other hand, all together, filters in the list of
11970	filters carry the semantics of the logical OR operation. So if it is
11971	desirable to create a match like "this vendor id OR this product id",
11972	one needs to create two filters and specify "any match" (see below)
11973	for unused attributes.
11974
11975	All filter attributes used for matching are strings. Each string
11976	is an expression representing a set of values of the corresponding
11977	device attribute, that will match the given filter. Currently, the
11978	following filtering expressions are supported:
11979
11980	<ul>
11981	<li><i>Interval filters</i>. Used to specify valid intervals for
11982	integer device attributes (Vendor ID, Product ID and Revision).
11983	The format of the string is:
11984
11985	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11986
11987	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11988	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11989	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11990	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11991	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11992	possible integer is assumed.
11993	</li>
11994	<li><i>Boolean filters</i>. Used to specify acceptable values for
11995	boolean device attributes. The format of the string is:
11996
11997	<tt>true\|false\|yes\|no\|0\|1</tt>
11998
11999	</li>
12000	<li><i>Exact match</i>. Used to specify a single value for the given
12001	device attribute. Any string that doesn't start with <tt>int:</tt>
12002	represents the exact match. String device attributes are compared to
12003	this string including case of symbols. Integer attributes are first
12004	converted to a string (see individual filter attributes) and then
12005	compared ignoring case.
12006
12007	</li>
12008	<li><i>Any match</i>. Any value of the corresponding device attribute
12009	will match the given filter. An empty or @c null string is
12010	used to construct this type of filtering expressions.
12011
12012	</li>
12013	</ul>
12014
12015	<note>
12016	On the Windows host platform, interval filters are not currently
12017	available. Also all string filter attributes
12018	(<link to="#manufacturer"/>, <link to="#product"/>,
12019	<link to="#serialNumber"/>) are ignored, so they behave as
12020	<i>any match</i> no matter what string expression is specified.
12021	</note>
12022
12023	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12024	</desc>
12025
12026	<attribute name="name" type="wstring">
12027	<desc>
12028	Visible name for this filter.
12029	This name is used to visually distinguish one filter from another,
12030	so it can neither be @c null nor an empty string.
12031	</desc>
12032	</attribute>
12033
12034	<attribute name="active" type="boolean">
12035	<desc>Whether this filter active or has been temporarily disabled.</desc>
12036	</attribute>
12037
12038	<attribute name="vendorId" type="wstring">
12039	<desc>
12040	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12041	The string representation for the <i>exact matching</i>
12042	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12043	(including leading zeroes).
12044	</desc>
12045	</attribute>
12046
12047	<attribute name="productId" type="wstring">
12048	<desc>
12049	<link to="IUSBDevice::productId">Product ID</link> filter.
12050	The string representation for the <i>exact matching</i>
12051	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12052	(including leading zeroes).
12053	</desc>
12054	</attribute>
12055
12056	<attribute name="revision" type="wstring">
12057	<desc>
12058	<link to="IUSBDevice::productId">Product revision number</link>
12059	filter. The string representation for the <i>exact matching</i>
12060	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12061	of the integer part of the revision, and <tt>F</tt> is the
12062	decimal digit of its fractional part (including leading and
12063	trailing zeros).
12064	Note that for interval filters, it's best to use the hexadecimal
12065	form, because the revision is stored as a 16 bit packed BCD value;
12066	so the expression <tt>int:0x0100-0x0199</tt> will match any
12067	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12068	</desc>
12069	</attribute>
12070
12071	<attribute name="manufacturer" type="wstring">
12072	<desc>
12073	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12074	</desc>
12075	</attribute>
12076
12077	<attribute name="product" type="wstring">
12078	<desc>
12079	<link to="IUSBDevice::product">Product</link> filter.
12080	</desc>
12081	</attribute>
12082
12083	<attribute name="serialNumber" type="wstring">
12084	<desc>
12085	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12086	</desc>
12087	</attribute>
12088
12089	<attribute name="port" type="wstring">
12090	<desc>
12091	<link to="IUSBDevice::port">Host USB port</link> filter.
12092	</desc>
12093	</attribute>
12094
12095	<attribute name="remote" type="wstring">
12096	<desc>
12097	<link to="IUSBDevice::remote">Remote state</link> filter.
12098	<note>
12099	This filter makes sense only for machine USB filters,
12100	i.e. it is ignored by IHostUSBDeviceFilter objects.
12101	</note>
12102	</desc>
12103	</attribute>
12104
12105	<attribute name="maskedInterfaces" type="unsigned long">
12106	<desc>
12107	This is an advanced option for hiding one or more USB interfaces
12108	from the guest. The value is a bit mask where the bits that are set
12109	means the corresponding USB interface should be hidden, masked off
12110	if you like.
12111	This feature only works on Linux hosts.
12112	</desc>
12113	</attribute>
12114
12115	</interface>
12116
12117
12118	<!--
12119	// IHostUSBDevice
12120	/////////////////////////////////////////////////////////////////////////
12121	-->
12122
12123	<enum
12124	name="USBDeviceState"
12125	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12126	>
12127	<desc>
12128	USB device state. This enumeration represents all possible states
12129	of the USB device physically attached to the host computer regarding
12130	its state on the host computer and availability to guest computers
12131	(all currently running virtual machines).
12132
12133	Once a supported USB device is attached to the host, global USB
12134	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12135	either ignore the device, or put it to USBDeviceState_Held state, or do
12136	nothing. Unless the device is ignored by global filters, filters of all
12137	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12138	activated that can put it to USBDeviceState_Captured state.
12139
12140	If the device was ignored by global filters, or didn't match
12141	any filters at all (including guest ones), it is handled by the host
12142	in a normal way. In this case, the device state is determined by
12143	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12144	or USBDeviceState_Available, depending on the current device usage.
12145
12146	Besides auto-capturing based on filters, the device can be manually
12147	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12148	state is USBDeviceState_Busy, USBDeviceState_Available or
12149	USBDeviceState_Held.
12150
12151	<note>
12152	Due to differences in USB stack implementations in Linux and Win32,
12153	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12154	only to the Linux version of the product. This also means that (<link
12155	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12156	device state is USBDeviceState_Held.
12157	</note>
12158
12159	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12160	</desc>
12161
12162	<const name="NotSupported" value="0">
12163	<desc>
12164	Not supported by the VirtualBox server, not available to guests.
12165	</desc>
12166	</const>
12167	<const name="Unavailable" value="1">
12168	<desc>
12169	Being used by the host computer exclusively,
12170	not available to guests.
12171	</desc>
12172	</const>
12173	<const name="Busy" value="2">
12174	<desc>
12175	Being used by the host computer, potentially available to guests.
12176	</desc>
12177	</const>
12178	<const name="Available" value="3">
12179	<desc>
12180	Not used by the host computer, available to guests (the host computer
12181	can also start using the device at any time).
12182	</desc>
12183	</const>
12184	<const name="Held" value="4">
12185	<desc>
12186	Held by the VirtualBox server (ignored by the host computer),
12187	available to guests.
12188	</desc>
12189	</const>
12190	<const name="Captured" value="5">
12191	<desc>
12192	Captured by one of the guest computers, not available
12193	to anybody else.
12194	</desc>
12195	</const>
12196	</enum>
12197
12198	<interface
12199	name="IHostUSBDevice" extends="IUSBDevice"
12200	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12201	wsmap="managed"
12202	>
12203	<desc>
12204	The IHostUSBDevice interface represents a physical USB device attached
12205	to the host computer.
12206
12207	Besides properties inherited from IUSBDevice, this interface adds the
12208	<link to="#state"/> property that holds the current state of the USB
12209	device.
12210
12211	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12212	</desc>
12213
12214	<attribute name="state" type="USBDeviceState" readonly="yes">
12215	<desc>
12216	Current state of the device.
12217	</desc>
12218	</attribute>
12219
12220	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12221
12222	</interface>
12223
12224
12225	<!--
12226	// IHostUSBDeviceFilter
12227	/////////////////////////////////////////////////////////////////////////
12228	-->
12229
12230	<enum
12231	name="USBDeviceFilterAction"
12232	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12233	>
12234	<desc>
12235	Actions for host USB device filters.
12236	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12237	</desc>
12238
12239	<const name="Null" value="0">
12240	<desc>Null value (never used by the API).</desc>
12241	</const>
12242	<const name="Ignore" value="1">
12243	<desc>Ignore the matched USB device.</desc>
12244	</const>
12245	<const name="Hold" value="2">
12246	<desc>Hold the matched USB device.</desc>
12247	</const>
12248	</enum>
12249
12250	<interface
12251	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12252	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12253	wsmap="managed"
12254	>
12255	<desc>
12256	The IHostUSBDeviceFilter interface represents a global filter for a
12257	physical USB device used by the host computer. Used indirectly in
12258	<link to="IHost::USBDeviceFilters"/>.
12259
12260	Using filters of this type, the host computer determines the initial
12261	state of the USB device after it is physically attached to the
12262	host's USB controller.
12263
12264	<note>
12265	The <link to="#remote"/> attribute is ignored by this type of
12266	filters, because it makes sense only for
12267	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12268	</note>
12269
12270	<see>IHost::USBDeviceFilters</see>
12271	</desc>
12272
12273	<attribute name="action" type="USBDeviceFilterAction">
12274	<desc>
12275	Action performed by the host when an attached USB device
12276	matches this filter.
12277	</desc>
12278	</attribute>
12279
12280	</interface>
12281
12282	<!--
12283	// IAudioAdapter
12284	/////////////////////////////////////////////////////////////////////////
12285	-->
12286
12287	<enum
12288	name="AudioDriverType"
12289	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12290	>
12291	<desc>
12292	Host audio driver type.
12293	</desc>
12294
12295	<const name="Null" value="0">
12296	<desc>Null value, also means "dummy audio driver".</desc>
12297	</const>
12298	<const name="WinMM" value="1">
12299	<desc>Windows multimedia (Windows hosts only).</desc>
12300	</const>
12301	<const name="OSS" value="2">
12302	<desc>Open Sound System (Linux hosts only).</desc>
12303	</const>
12304	<const name="ALSA" value="3">
12305	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12306	</const>
12307	<const name="DirectSound" value="4">
12308	<desc>DirectSound (Windows hosts only).</desc>
12309	</const>
12310	<const name="CoreAudio" value="5">
12311	<desc>CoreAudio (Mac hosts only).</desc>
12312	</const>
12313	<const name="MMPM" value="6">
12314	<desc>Reserved for historical reasons.</desc>
12315	</const>
12316	<const name="Pulse" value="7">
12317	<desc>PulseAudio (Linux hosts only).</desc>
12318	</const>
12319	<const name="SolAudio" value="8">
12320	<desc>Solaris audio (Solaris hosts only).</desc>
12321	</const>
12322	</enum>
12323
12324	<enum
12325	name="AudioControllerType"
12326	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12327	>
12328	<desc>
12329	Virtual audio controller type.
12330	</desc>
12331
12332	<const name="AC97" value="0"/>
12333	<const name="SB16" value="1"/>
12334	</enum>
12335
12336	<interface
12337	name="IAudioAdapter" extends="$unknown"
12338	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12339	wsmap="managed"
12340	>
12341	<desc>
12342	The IAudioAdapter interface represents the virtual audio adapter of
12343	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12344	</desc>
12345	<attribute name="enabled" type="boolean">
12346	<desc>
12347	Flag whether the audio adapter is present in the
12348	guest system. If disabled, the virtual guest hardware will
12349	not contain any audio adapter. Can only be changed when
12350	the VM is not running.
12351	</desc>
12352	</attribute>
12353	<attribute name="audioController" type="AudioControllerType">
12354	<desc>
12355	The audio hardware we emulate.
12356	</desc>
12357	</attribute>
12358	<attribute name="audioDriver" type="AudioDriverType">
12359	<desc>
12360	Audio driver the adapter is connected to. This setting
12361	can only be changed when the VM is not running.
12362	</desc>
12363	</attribute>
12364	</interface>
12365
12366	<!--
12367	// IVRDPServer
12368	/////////////////////////////////////////////////////////////////////////
12369	-->
12370
12371	<enum
12372	name="VRDPAuthType"
12373	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12374	>
12375	<desc>
12376	VRDP authentication type.
12377	</desc>
12378
12379	<const name="Null" value="0">
12380	<desc>Null value, also means "no authentication".</desc>
12381	</const>
12382	<const name="External" value="1"/>
12383	<const name="Guest" value="2"/>
12384	</enum>
12385
12386	<interface
12387	name="IVRDPServer" extends="$unknown"
12388	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12389	wsmap="managed"
12390	>
12391	<attribute name="enabled" type="boolean">
12392	<desc>VRDP server status.</desc>
12393	</attribute>
12394
12395	<attribute name="ports" type="wstring">
12396	<desc>
12397	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12398	<note>
12399	This is a string of comma separated TCP port numbers or port number ranges.
12400	Example <tt>5000,5010-5012,5015</tt>
12401	</note>
12402	</desc>
12403	</attribute>
12404
12405	<attribute name="netAddress" type="wstring">
12406	<desc>VRDP server address.</desc>
12407	</attribute>
12408
12409	<attribute name="authType" type="VRDPAuthType">
12410	<desc>VRDP authentication method.</desc>
12411	</attribute>
12412
12413	<attribute name="authTimeout" type="unsigned long">
12414	<desc>Timeout for guest authentication. Milliseconds.</desc>
12415	</attribute>
12416
12417	<attribute name="allowMultiConnection" type="boolean">
12418	<desc>
12419	Flag whether multiple simultaneous connections to the VM are permitted.
12420	Note that this will be replaced by a more powerful mechanism in the future.
12421	</desc>
12422	</attribute>
12423
12424	<attribute name="reuseSingleConnection" type="boolean">
12425	<desc>
12426	Flag whether the existing connection must be dropped and a new connection
12427	must be established by the VRDP server, when a new client connects in single
12428	connection mode.
12429	</desc>
12430	</attribute>
12431
12432	</interface>
12433
12434
12435	<!--
12436	// ISharedFolder
12437	/////////////////////////////////////////////////////////////////////////
12438	-->
12439
12440	<interface
12441	name="ISharedFolder" extends="$unknown"
12442	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12443	wsmap="struct"
12444	>
12445	<desc>
12446	The ISharedFolder interface represents a folder in the host computer's
12447	file system accessible from the guest OS running inside a virtual
12448	machine using an associated logical name.
12449
12450	There are three types of shared folders:
12451	<ul>
12452	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12453	folders available to all virtual machines.</li>
12454	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12455	VM-specific shared folders available to the given virtual machine at
12456	startup.</li>
12457	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12458	VM-specific shared folders created in the session context (for
12459	example, when the virtual machine is running) and automatically
12460	discarded when the session is closed (the VM is powered off).</li>
12461	</ul>
12462
12463	Logical names of shared folders must be unique within the given scope
12464	(global, permanent or transient). However, they do not need to be unique
12465	across scopes. In this case, the definition of the shared folder in a
12466	more specific scope takes precedence over definitions in all other
12467	scopes. The order of precedence is (more specific to more general):
12468	<ol>
12469	<li>Transient definitions</li>
12470	<li>Permanent definitions</li>
12471	<li>Global definitions</li>
12472	</ol>
12473
12474	For example, if MyMachine has a shared folder named
12475	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12476	transient shared folder named <tt>C_DRIVE</tt> (that points
12477	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12478	of <tt>C_DRIVE</tt> in the guest OS so
12479	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12480	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12481	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12482	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12483	to <tt>C:\\</tt> if it still exists.
12484
12485	Note that permanent and transient shared folders of different machines
12486	are in different name spaces, so they don't overlap and don't need to
12487	have unique logical names.
12488
12489	<note>
12490	Global shared folders are not implemented in the current version of the
12491	product.
12492	</note>
12493	</desc>
12494
12495	<attribute name="name" type="wstring" readonly="yes">
12496	<desc>Logical name of the shared folder.</desc>
12497	</attribute>
12498
12499	<attribute name="hostPath" type="wstring" readonly="yes">
12500	<desc>Full path to the shared folder in the host file system.</desc>
12501	</attribute>
12502
12503	<attribute name="accessible" type="boolean" readonly="yes">
12504	<desc>
12505	Whether the folder defined by the host path is currently
12506	accessible or not.
12507	For example, the folder can be unaccessible if it is placed
12508	on the network share that is not available by the time
12509	this property is read.
12510	</desc>
12511	</attribute>
12512
12513	<attribute name="writable" type="boolean" readonly="yes">
12514	<desc>
12515	Whether the folder defined by the host path is writable or
12516	not.
12517	</desc>
12518	</attribute>
12519
12520	<attribute name="lastAccessError" type="wstring" readonly="yes">
12521	<desc>
12522	Text message that represents the result of the last accessibility
12523	check.
12524
12525	Accessibility checks are performed each time the <link to="#accessible"/>
12526	attribute is read. An empty string is returned if the last
12527	accessibility check was successful. A non-empty string indicates a
12528	failure and should normally describe a reason of the failure (for
12529	example, a file read error).
12530	</desc>
12531	</attribute>
12532
12533	</interface>
12534
12535	<!--
12536	// ISession
12537	/////////////////////////////////////////////////////////////////////////
12538	-->
12539
12540	<interface
12541	name="IInternalSessionControl" extends="$unknown"
12542	uuid="f9aac6d0-41b3-46b7-bea4-6370b4036de6"
12543	internal="yes"
12544	wsmap="suppress"
12545	>
12546	<method name="getPID">
12547	<desc>PID of the process that has created this Session object.
12548	</desc>
12549	<param name="pid" type="unsigned long" dir="return"/>
12550	</method>
12551
12552	<method name="getRemoteConsole">
12553	<desc>
12554	Returns the console object suitable for remote control.
12555
12556	<result name="VBOX_E_INVALID_VM_STATE">
12557	Session state prevents operation.
12558	</result>
12559	<result name="VBOX_E_INVALID_OBJECT_STATE">
12560	Session type prevents operation.
12561	</result>
12562
12563	</desc>
12564	<param name="console" type="IConsole" dir="return"/>
12565	</method>
12566
12567	<method name="assignMachine">
12568	<desc>
12569	Assigns the machine object associated with this direct-type
12570	session or informs the session that it will be a remote one
12571	(if @a machine == @c null).
12572
12573	<result name="VBOX_E_INVALID_VM_STATE">
12574	Session state prevents operation.
12575	</result>
12576	<result name="VBOX_E_INVALID_OBJECT_STATE">
12577	Session type prevents operation.
12578	</result>
12579
12580	</desc>
12581	<param name="machine" type="IMachine" dir="in"/>
12582	</method>
12583
12584	<method name="assignRemoteMachine">
12585	<desc>
12586	Assigns the machine and the (remote) console object associated with
12587	this remote-type session.
12588
12589	<result name="VBOX_E_INVALID_VM_STATE">
12590	Session state prevents operation.
12591	</result>
12592
12593	</desc>
12594	<param name="machine" type="IMachine" dir="in"/>
12595	<param name="console" type="IConsole" dir="in"/>
12596	</method>
12597
12598	<method name="updateMachineState">
12599	<desc>
12600	Updates the machine state in the VM process.
12601	Must be called only in certain cases
12602	(see the method implementation).
12603
12604	<result name="VBOX_E_INVALID_VM_STATE">
12605	Session state prevents operation.
12606	</result>
12607	<result name="VBOX_E_INVALID_OBJECT_STATE">
12608	Session type prevents operation.
12609	</result>
12610
12611	</desc>
12612	<param name="aMachineState" type="MachineState" dir="in"/>
12613	</method>
12614
12615	<method name="uninitialize">
12616	<desc>
12617	Uninitializes (closes) this session. Used by VirtualBox to close
12618	the corresponding remote session when the direct session dies
12619	or gets closed.
12620
12621	<result name="VBOX_E_INVALID_VM_STATE">
12622	Session state prevents operation.
12623	</result>
12624
12625	</desc>
12626	</method>
12627
12628	<method name="onNetworkAdapterChange">
12629	<desc>
12630	Triggered when settings of a network adapter of the
12631	associated virtual machine have changed.
12632
12633	<result name="VBOX_E_INVALID_VM_STATE">
12634	Session state prevents operation.
12635	</result>
12636	<result name="VBOX_E_INVALID_OBJECT_STATE">
12637	Session type prevents operation.
12638	</result>
12639
12640	</desc>
12641	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12642	<param name="changeAdapter" type="boolean" dir="in"/>
12643	</method>
12644
12645	<method name="onSerialPortChange">
12646	<desc>
12647	Triggered when settings of a serial port of the
12648	associated virtual machine have changed.
12649
12650	<result name="VBOX_E_INVALID_VM_STATE">
12651	Session state prevents operation.
12652	</result>
12653	<result name="VBOX_E_INVALID_OBJECT_STATE">
12654	Session type prevents operation.
12655	</result>
12656
12657	</desc>
12658	<param name="serialPort" type="ISerialPort" dir="in"/>
12659	</method>
12660
12661	<method name="onParallelPortChange">
12662	<desc>
12663	Triggered when settings of a parallel port of the
12664	associated virtual machine have changed.
12665
12666	<result name="VBOX_E_INVALID_VM_STATE">
12667	Session state prevents operation.
12668	</result>
12669	<result name="VBOX_E_INVALID_OBJECT_STATE">
12670	Session type prevents operation.
12671	</result>
12672
12673	</desc>
12674	<param name="parallelPort" type="IParallelPort" dir="in"/>
12675	</method>
12676
12677	<method name="onStorageControllerChange">
12678	<desc>
12679	Triggered when settings of a storage controller of the
12680	associated virtual machine have changed.
12681
12682	<result name="VBOX_E_INVALID_VM_STATE">
12683	Session state prevents operation.
12684	</result>
12685	<result name="VBOX_E_INVALID_OBJECT_STATE">
12686	Session type prevents operation.
12687	</result>
12688
12689	</desc>
12690	</method>
12691
12692	<method name="onMediumChange">
12693	<desc>
12694	Triggered when attached media of the
12695	associated virtual machine have changed.
12696
12697	<result name="VBOX_E_INVALID_VM_STATE">
12698	Session state prevents operation.
12699	</result>
12700	<result name="VBOX_E_INVALID_OBJECT_STATE">
12701	Session type prevents operation.
12702	</result>
12703
12704	</desc>
12705
12706	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12707	<param name="force" type="boolean" dir="in"/>
12708	</method>
12709
12710	<method name="onVRDPServerChange">
12711	<desc>
12712	Triggered when settings of the VRDP server object of the
12713	associated virtual machine have changed.
12714
12715	<result name="VBOX_E_INVALID_VM_STATE">
12716	Session state prevents operation.
12717	</result>
12718	<result name="VBOX_E_INVALID_OBJECT_STATE">
12719	Session type prevents operation.
12720	</result>
12721
12722	</desc>
12723	</method>
12724
12725	<method name="onUSBControllerChange">
12726	<desc>
12727	Triggered when settings of the USB controller object of the
12728	associated virtual machine have changed.
12729
12730	<result name="VBOX_E_INVALID_VM_STATE">
12731	Session state prevents operation.
12732	</result>
12733	<result name="VBOX_E_INVALID_OBJECT_STATE">
12734	Session type prevents operation.
12735	</result>
12736
12737	</desc>
12738	</method>
12739
12740	<method name="onSharedFolderChange">
12741	<desc>
12742	Triggered when a permanent (global or machine) shared folder has been
12743	created or removed.
12744	<note>
12745	We don't pass shared folder parameters in this notification because
12746	the order in which parallel notifications are delivered is not defined,
12747	therefore it could happen that these parameters were outdated by the
12748	time of processing this notification.
12749	</note>
12750
12751	<result name="VBOX_E_INVALID_VM_STATE">
12752	Session state prevents operation.
12753	</result>
12754	<result name="VBOX_E_INVALID_OBJECT_STATE">
12755	Session type prevents operation.
12756	</result>
12757
12758	</desc>
12759	<param name="global" type="boolean" dir="in"/>
12760	</method>
12761
12762	<method name="onUSBDeviceAttach">
12763	<desc>
12764	Triggered when a request to capture a USB device (as a result
12765	of matched USB filters or direct call to
12766	<link to="IConsole::attachUSBDevice"/>) has completed.
12767	A @c null @a error object means success, otherwise it
12768	describes a failure.
12769
12770	<result name="VBOX_E_INVALID_VM_STATE">
12771	Session state prevents operation.
12772	</result>
12773	<result name="VBOX_E_INVALID_OBJECT_STATE">
12774	Session type prevents operation.
12775	</result>
12776
12777	</desc>
12778	<param name="device" type="IUSBDevice" dir="in"/>
12779	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12780	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12781	</method>
12782
12783	<method name="onUSBDeviceDetach">
12784	<desc>
12785	Triggered when a request to release the USB device (as a result
12786	of machine termination or direct call to
12787	<link to="IConsole::detachUSBDevice"/>) has completed.
12788	A @c null @a error object means success, otherwise it
12789	describes a failure.
12790
12791	<result name="VBOX_E_INVALID_VM_STATE">
12792	Session state prevents operation.
12793	</result>
12794	<result name="VBOX_E_INVALID_OBJECT_STATE">
12795	Session type prevents operation.
12796	</result>
12797
12798	</desc>
12799	<param name="id" type="uuid" mod="string" dir="in"/>
12800	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12801	</method>
12802
12803	<method name="onShowWindow">
12804	<desc>
12805	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12806	<link to="IMachine::showConsoleWindow"/> in order to notify
12807	console callbacks
12808	<link to="IConsoleCallback::onCanShowWindow"/>
12809	and <link to="IConsoleCallback::onShowWindow"/>.
12810
12811	<result name="VBOX_E_INVALID_OBJECT_STATE">
12812	Session type prevents operation.
12813	</result>
12814
12815	</desc>
12816	<param name="check" type="boolean" dir="in"/>
12817	<param name="canShow" type="boolean" dir="out"/>
12818	<param name="winId" type="unsigned long long" dir="out"/>
12819	</method>
12820
12821	<method name="accessGuestProperty">
12822	<desc>
12823	Called by <link to="IMachine::getGuestProperty"/> and by
12824	<link to="IMachine::setGuestProperty"/> in order to read and
12825	modify guest properties.
12826
12827	<result name="VBOX_E_INVALID_VM_STATE">
12828	Machine session is not open.
12829	</result>
12830	<result name="VBOX_E_INVALID_OBJECT_STATE">
12831	Session type is not direct.
12832	</result>
12833
12834	</desc>
12835	<param name="name" type="wstring" dir="in"/>
12836	<param name="value" type="wstring" dir="in"/>
12837	<param name="flags" type="wstring" dir="in"/>
12838	<param name="isSetter" type="boolean" dir="in"/>
12839	<param name="retValue" type="wstring" dir="out"/>
12840	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12841	<param name="retFlags" type="wstring" dir="out"/>
12842	</method>
12843
12844	<method name="enumerateGuestProperties">
12845	<desc>
12846	Return a list of the guest properties matching a set of patterns along
12847	with their values, time stamps and flags.
12848
12849	<result name="VBOX_E_INVALID_VM_STATE">
12850	Machine session is not open.
12851	</result>
12852	<result name="VBOX_E_INVALID_OBJECT_STATE">
12853	Session type is not direct.
12854	</result>
12855
12856	</desc>
12857	<param name="patterns" type="wstring" dir="in">
12858	<desc>
12859	The patterns to match the properties against as a comma-separated
12860	string. If this is empty, all properties currently set will be
12861	returned.
12862	</desc>
12863	</param>
12864	<param name="key" type="wstring" dir="out" safearray="yes">
12865	<desc>
12866	The key names of the properties returned.
12867	</desc>
12868	</param>
12869	<param name="value" type="wstring" dir="out" safearray="yes">
12870	<desc>
12871	The values of the properties returned. The array entries match the
12872	corresponding entries in the @a key array.
12873	</desc>
12874	</param>
12875	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12876	<desc>
12877	The time stamps of the properties returned. The array entries match
12878	the corresponding entries in the @a key array.
12879	</desc>
12880	</param>
12881	<param name="flags" type="wstring" dir="out" safearray="yes">
12882	<desc>
12883	The flags of the properties returned. The array entries match the
12884	corresponding entries in the @a key array.
12885	</desc>
12886	</param>
12887	</method>
12888
12889	</interface>
12890
12891	<interface
12892	name="ISession" extends="$dispatched"
12893	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12894	wsmap="managed"
12895	>
12896	<desc>
12897	The ISession interface represents a serialization primitive for virtual
12898	machines.
12899
12900	With VirtualBox, every time one wishes to manipulate a virtual machine
12901	(e.g. change its settings or start execution), a session object is
12902	required. Such an object must be passed to one of the session methods
12903	that open the given session, which then initiates the machine manipulation.
12904
12905	A session serves several purposes: it identifies to the inter-process VirtualBox
12906	code which process is currently working with the virtual machine, and it ensures
12907	that there are no incompatible requests from several processes for the
12908	same virtual machine. Session objects can therefore be thought of as mutex
12909	semaphores that lock virtual machines to prevent conflicting accesses from
12910	several processes.
12911
12912	How sessions objects are used depends on whether you use the Main API
12913	via COM or via the webservice:
12914
12915	<ul>
12916	<li>When using the COM API directly, an object of the Session class from the
12917	VirtualBox type library needs to be created. In regular COM C++ client code,
12918	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12919	This object will then act as a local session object in further calls to open
12920	a session.
12921	</li>
12922
12923	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12924	one session object automatically when <link to="IWebsessionManager::logon" />
12925	is called. A managed object reference to that session object can be retrieved by
12926	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12927	reference can then be used to open sessions.
12928	</li>
12929	</ul>
12930
12931	Sessions are mainly used in two variations:
12932
12933	<ul>
12934	<li>
12935	To start a virtual machine in a separate process, one would call
12936	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12937	object as its first parameter. This session then identifies the caller
12938	and lets him control the started machine (for example, pause machine
12939	execution or power it down) as well as be notified about machine
12940	execution state changes.
12941	</li>
12942
12943	<li>To alter machine settings, or to start machine execution within the
12944	current process, one needs to open a direct session for the machine first by
12945	calling <link to="IVirtualBox::openSession"/>. While a direct session
12946	is open within one process, no any other process may open another direct
12947	session for the same machine. This prevents the machine from being changed
12948	by other processes while it is running or while the machine is being configured.
12949	</li>
12950	</ul>
12951
12952	One also can attach to an existing direct session already opened by
12953	another process (for example, in order to send a control request to the
12954	virtual machine such as the pause or the reset request). This is done by
12955	calling <link to="IVirtualBox::openExistingSession"/>.
12956
12957	<note>
12958	Unless you are trying to write a new VirtualBox front-end that
12959	performs direct machine execution (like the VirtualBox or VBoxSDL
12960	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12961	session opened by <link to="IVirtualBox::openSession"/> and use this
12962	session only to change virtual machine settings. If you simply want to
12963	start virtual machine execution using one of the existing front-ends
12964	(for example the VirtualBox GUI or headless server), simply use
12965	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12966	will power up the machine automatically for you.
12967	</note>
12968	</desc>
12969
12970	<attribute name="state" type="SessionState" readonly="yes">
12971	<desc>Current state of this session.</desc>
12972	</attribute>
12973
12974	<attribute name="type" type="SessionType" readonly="yes">
12975	<desc>
12976	Type of this session. The value of this attribute is valid only
12977	if the session is currently open (i.e. its #state is
12978	SessionType_SessionOpen), otherwise an error will be returned.
12979	</desc>
12980	</attribute>
12981
12982	<attribute name="machine" type="IMachine" readonly="yes">
12983	<desc>Machine object associated with this session.</desc>
12984	</attribute>
12985
12986	<attribute name="console" type="IConsole" readonly="yes">
12987	<desc>Console object associated with this session.</desc>
12988	</attribute>
12989
12990	<method name="close">
12991	<desc>
12992	Closes a session that was previously opened.
12993
12994	It is recommended that every time an "open session" method (such as
12995	<link to="IVirtualBox::openRemoteSession" /> or
12996	<link to="IVirtualBox::openSession" />) has been called to
12997	manipulate a virtual machine, the caller invoke
12998	ISession::close() when it's done doing so. Since sessions are
12999	serialization primitives much like ordinary mutexes, they are
13000	best used the same way: for each "open" call, there should be
13001	a matching "close" call, even when errors occur.
13002
13003	Otherwise, if a direct session for a machine opened with
13004	<link to="IVirtualBox::openSession"/> is not explicitly closed
13005	when the application terminates, the state of the machine will
13006	be set to <link to="MachineState_Aborted" /> on the server.
13007
13008	Generally, it is recommended to close all open sessions explicitly
13009	before terminating the application (regardless of the reason for
13010	the termination).
13011
13012	<note>
13013	Do not expect the session state (<link to="ISession::state" />
13014	to return to "Closed" immediately after you invoke
13015	ISession::close(), particularly if you have started a remote
13016	session to execute the VM in a new process. The session state will
13017	automatically return to "Closed" once the VM is no longer executing,
13018	which can of course take a very long time.
13019	</note>
13020
13021	<result name="E_UNEXPECTED">
13022	Session is not open.
13023	</result>
13024
13025	</desc>
13026	</method>
13027
13028	</interface>
13029
13030	<!--
13031	// IStorageController
13032	/////////////////////////////////////////////////////////////////////////
13033	-->
13034
13035	<enum
13036	name="StorageBus"
13037	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13038	>
13039	<desc>
13040	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
13041	see <link to="IStorageController::bus" />.
13042	</desc>
13043	<const name="Null" value="0">
13044	<desc>@c null value. Never used by the API.</desc>
13045	</const>
13046	<const name="IDE" value="1"/>
13047	<const name="SATA" value="2"/>
13048	<const name="SCSI" value="3"/>
13049	<const name="Floppy" value="4"/>
13050	<const name="SAS" value="5"/>
13051	</enum>
13052
13053	<enum
13054	name="StorageControllerType"
13055	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13056	>
13057	<desc>
13058	The exact variant of storage controller hardware presented
13059	to the guest; see <link to="IStorageController::controllerType" />.
13060	</desc>
13061
13062	<const name="Null" value="0">
13063	<desc>@c null value. Never used by the API.</desc>
13064	</const>
13065	<const name="LsiLogic" value="1">
13066	<desc>A SCSI controller of the LsiLogic variant.</desc>
13067	</const>
13068	<const name="BusLogic" value="2">
13069	<desc>A SCSI controller of the BusLogic variant.</desc>
13070	</const>
13071	<const name="IntelAhci" value="3">
13072	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13073	</const>
13074	<const name="PIIX3" value="4">
13075	<desc>An IDE controller of the PIIX3 variant.</desc>
13076	</const>
13077	<const name="PIIX4" value="5">
13078	<desc>An IDE controller of the PIIX4 variant.</desc>
13079	</const>
13080	<const name="ICH6" value="6">
13081	<desc>An IDE controller of the ICH6 variant.</desc>
13082	</const>
13083	<const name="I82078" value="7">
13084	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13085	</const>
13086	<const name="LsiLogicSas" value="8">
13087	<desc>A variant of the LsiLogic controller using SAS.</desc>
13088	</const>
13089	</enum>
13090
13091	<interface
13092	name="IStorageController" extends="$unknown"
13093	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
13094	wsmap="managed"
13095	>
13096	<desc>
13097	Represents a storage controller that is attached to a virtual machine
13098	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13099	attached to storage controllers in a real computer, virtual drives
13100	(represented by <link to="IMediumAttachment" />) are attached to virtual
13101	storage controllers, represented by this interface.
13102
13103	As opposed to physical hardware, VirtualBox has a very generic concept
13104	of a storage controller, and for purposes of the Main API, all virtual
13105	storage is attached to virtual machines via instances of this interface.
13106	There are four types of such virtual storage controllers: IDE, SCSI, SATA
13107	and Floppy (see <link to="#bus" />). Depending on which of these four is
13108	used, certain sub-types may be available and can be selected in
13109	<link to="#controllerType" />.
13110
13111	Depending on these settings, the guest operating system might see
13112	significantly different virtual hardware.
13113	</desc>
13114
13115	<attribute name="name" type="wstring" readonly="yes">
13116	<desc>
13117	Name of the storage controller, as originally specified with
13118	<link to="IMachine::addStorageController" />. This then uniquely
13119	identifies this controller with other method calls such as
13120	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13121	</desc>
13122	</attribute>
13123
13124	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13125	<desc>
13126	Maximum number of devices which can be attached to one port.
13127	</desc>
13128	</attribute>
13129
13130	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13131	<desc>
13132	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13133	</desc>
13134	</attribute>
13135
13136	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13137	<desc>
13138	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13139	</desc>
13140	</attribute>
13141
13142	<attribute name="instance" type="unsigned long">
13143	<desc>
13144	The instance number of the device in the running VM.
13145	</desc>
13146	</attribute>
13147
13148	<attribute name="portCount" type="unsigned long">
13149	<desc>
13150	The number of currently usable ports on the controller.
13151	The minimum and maximum number of ports for one controller are
13152	stored in <link to="IStorageController::minPortCount"/>
13153	and <link to="IStorageController::maxPortCount"/>.
13154	</desc>
13155	</attribute>
13156
13157	<attribute name="bus" type="StorageBus" readonly="yes">
13158	<desc>
13159	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
13160	</desc>
13161	</attribute>
13162
13163	<attribute name="controllerType" type="StorageControllerType">
13164	<desc>
13165	The exact variant of storage controller hardware presented
13166	to the guest.
13167	Depending on this value, VirtualBox will provide a different
13168	virtual storage controller hardware to the guest.
13169	For SATA and floppy controllers, only one variant is available,
13170	but for IDE and SCSI, there are several.
13171
13172	For SCSI controllers, the default type is LsiLogic.
13173	</desc>
13174	</attribute>
13175
13176	<method name="GetIDEEmulationPort">
13177	<desc>
13178	Gets the corresponding port number which is emulated as an IDE device.
13179	Works only with SATA controllers.
13180
13181	<result name="E_INVALIDARG">
13182	The @a devicePosition is not in the range 0 to 3.
13183	</result>
13184	<result name="E_NOTIMPL">
13185	The storage controller type is not SATAIntelAhci.
13186	</result>
13187
13188	</desc>
13189	<param name="devicePosition" type="long" dir="in"/>
13190	<param name="portNumber" type="long" dir="return"/>
13191	</method>
13192
13193	<method name="SetIDEEmulationPort">
13194	<desc>
13195	Sets the port number which is emulated as an IDE device.
13196	Works only with SATA controllers.
13197
13198	<result name="E_INVALIDARG">
13199	The @a devicePosition is not in the range 0 to 3 or the
13200	@a portNumber is not in the range 0 to 29.
13201	</result>
13202	<result name="E_NOTIMPL">
13203	The storage controller type is not SATAIntelAhci.
13204	</result>
13205
13206	</desc>
13207	<param name="devicePosition" type="long" dir="in"/>
13208	<param name="portNumber" type="long" dir="in"/>
13209	</method>
13210
13211	</interface>
13212
13213	<if target="wsdl">
13214
13215	<!--
13216	// IManagedObjectRef
13217	/////////////////////////////////////////////////////////////////////////
13218	-->
13219
13220	<interface
13221	name="IManagedObjectRef" extends="$unknown"
13222	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13223	internal="yes"
13224	wsmap="managed"
13225	wscpp="hardcoded"
13226	>
13227	<desc>
13228	Managed object reference.
13229
13230	Only within the webservice, a managed object reference (which is really
13231	an opaque number) allows a webservice client to address an object
13232	that lives in the address space of the webservice server.
13233
13234	Behind each managed object reference, there is a COM object that lives
13235	in the webservice server's address space. The COM object is not freed
13236	until the managed object reference is released, either by an explicit
13237	call to <link to="IManagedObjectRef::release" /> or by logging off from
13238	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13239	all objects created during the webservice session.
13240
13241	Whenever a method call of the VirtualBox API returns a COM object, the
13242	webservice representation of that method will instead return a
13243	managed object reference, which can then be used to invoke methods
13244	on that object.
13245	</desc>
13246
13247	<method name="getInterfaceName">
13248	<desc>
13249	Returns the name of the interface that this managed object represents,
13250	for example, "IMachine", as a string.
13251	</desc>
13252	<param name="return" type="wstring" dir="return"/>
13253	</method>
13254
13255	<method name="release">
13256	<desc>
13257	Releases this managed object reference and frees the resources that
13258	were allocated for it in the webservice server process. After calling
13259	this method, the identifier of the reference can no longer be used.
13260	</desc>
13261	</method>
13262
13263	</interface>
13264
13265	<!--
13266	// IWebsessionManager
13267	/////////////////////////////////////////////////////////////////////////
13268	-->
13269
13270	<interface
13271	name="IWebsessionManager" extends="$unknown"
13272	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13273	internal="yes"
13274	wsmap="global"
13275	wscpp="hardcoded"
13276	>
13277	<desc>
13278	Websession manager. This provides essential services
13279	to webservice clients.
13280	</desc>
13281	<method name="logon">
13282	<desc>
13283	Logs a new client onto the webservice and returns a managed object reference to
13284	the IVirtualBox instance, which the client can then use as a basis to further
13285	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13286	interface, in one way or the other.
13287	</desc>
13288	<param name="username" type="wstring" dir="in"/>
13289	<param name="password" type="wstring" dir="in"/>
13290	<param name="return" type="IVirtualBox" dir="return"/>
13291	</method>
13292
13293	<method name="getSessionObject">
13294	<desc>
13295	Returns a managed object reference to the internal ISession object that was created
13296	for this web service session when the client logged on.
13297
13298	<see>ISession</see>
13299	</desc>
13300	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13301	<param name="return" type="ISession" dir="return"/>
13302	</method>
13303
13304	<method name="logoff">
13305	<desc>
13306	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13307	and destroys all resources associated with the session (most importantly, all
13308	managed objects created in the server while the session was active).
13309	</desc>
13310	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13311	</method>
13312
13313	</interface>
13314
13315	</if>
13316
13317	<!--
13318	// IPerformanceCollector & friends
13319	/////////////////////////////////////////////////////////////////////////
13320	-->
13321
13322	<interface
13323	name="IPerformanceMetric" extends="$unknown"
13324	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13325	>
13326	<desc>
13327	The IPerformanceMetric interface represents parameters of the given
13328	performance metric.
13329	</desc>
13330
13331	<attribute name="metricName" type="wstring" readonly="yes">
13332	<desc>
13333	Name of the metric.
13334	</desc>
13335	</attribute>
13336
13337	<attribute name="object" type="$unknown" readonly="yes">
13338	<desc>
13339	Object this metric belongs to.
13340	</desc>
13341	</attribute>
13342
13343	<attribute name="description" type="wstring" readonly="yes">
13344	<desc>
13345	Textual description of the metric.
13346	</desc>
13347	</attribute>
13348
13349	<attribute name="period" type="unsigned long" readonly="yes">
13350	<desc>
13351	Time interval between samples, measured in seconds.
13352	</desc>
13353	</attribute>
13354
13355	<attribute name="count" type="unsigned long" readonly="yes">
13356	<desc>
13357	Number of recent samples retained by the performance collector for this
13358	metric.
13359
13360	When the collected sample count exceeds this number, older samples
13361	are discarded.
13362	</desc>
13363	</attribute>
13364
13365	<attribute name="unit" type="wstring" readonly="yes">
13366	<desc>
13367	Unit of measurement.
13368	</desc>
13369	</attribute>
13370
13371	<attribute name="minimumValue" type="long" readonly="yes">
13372	<desc>
13373	Minimum possible value of this metric.
13374	</desc>
13375	</attribute>
13376
13377	<attribute name="maximumValue" type="long" readonly="yes">
13378	<desc>
13379	Maximum possible value of this metric.
13380	</desc>
13381	</attribute>
13382	</interface>
13383
13384	<interface
13385	name="IPerformanceCollector" extends="$unknown"
13386	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13387	wsmap="managed"
13388	>
13389	<desc>
13390	The IPerformanceCollector interface represents a service that collects and
13391	stores performance metrics data.
13392
13393	Performance metrics are associated with objects of interfaces like IHost and
13394	IMachine. Each object has a distinct set of performance metrics.
13395	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13396
13397	Metric data is collected at the specified intervals and is retained
13398	internally. The interval and the number of retained samples can be set
13399	with <link to="IPerformanceCollector::setupMetrics" />.
13400
13401	Metrics are organized hierarchically, with each level separated by a
13402	slash (/) character. Generally, the scheme for metric names is like this:
13403
13404	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13405
13406	"Category/Metric" together form the base metric name. A base metric is the
13407	smallest unit for which a sampling interval and the number of retained
13408	samples can be set. Only base metrics can be enabled and disabled. All
13409	sub-metrics are collected when their base metric is collected.
13410	Collected values for any set of sub-metrics can be queried with
13411	<link to="IPerformanceCollector::queryMetricsData" />.
13412
13413	For example "CPU/Load/User:avg"
13414	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13415	"average" aggregate. An aggregate function is computed over all retained
13416	data. Valid aggregate functions are:
13417
13418	<ul>
13419	<li>avg -- average</li>
13420	<li>min -- minimum</li>
13421	<li>max -- maximum</li>
13422	</ul>
13423
13424	When setting up
13425	metric parameters, querying metric data, enabling or disabling metrics
13426	wildcards can be used in metric names to specify a subset of metrics. For
13427	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13428	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13429	values without aggregates <tt>*:</tt> can be used.
13430
13431	The valid names for base metrics are:
13432
13433	<ul>
13434	<li>CPU/Load</li>
13435	<li>CPU/MHz</li>
13436	<li>RAM/Usage</li>
13437	</ul>
13438
13439	The general sequence for collecting and retrieving the metrics is:
13440	<ul>
13441	<li>
13442	Obtain an instance of IPerformanceCollector with
13443	<link to="IVirtualBox::performanceCollector" />
13444	</li>
13445	<li>
13446	Allocate and populate an array with references to objects the metrics
13447	will be collected for. Use references to IHost and IMachine objects.
13448	</li>
13449	<li>
13450	Allocate and populate an array with base metric names the data will be
13451	collected for.
13452	</li>
13453	<li>
13454	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13455	metric data will be collected and stored.
13456	</li>
13457	<li>
13458	Wait for the data to get collected.
13459	</li>
13460	<li>
13461	Allocate and populate an array with references to objects the metric
13462	values will be queried for. You can re-use the object array used for
13463	setting base metrics.
13464	</li>
13465	<li>
13466	Allocate and populate an array with metric names the data will be
13467	collected for. Note that metric names differ from base metric names.
13468	</li>
13469	<li>
13470	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13471	have been collected so far are returned. Note that the values are still
13472	retained internally and data collection continues.
13473	</li>
13474	</ul>
13475
13476	For an example of usage refer to the following files in VirtualBox SDK:
13477	<ul>
13478	<li>
13479	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13480	</li>
13481	<li>
13482	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13483	</li>
13484	</ul>
13485	</desc>
13486
13487	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13488	<desc>
13489	Array of unique names of metrics.
13490
13491	This array represents all metrics supported by the performance
13492	collector. Individual objects do not necessarily support all of them.
13493	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13494	list of supported metrics for a particular object.
13495	</desc>
13496	</attribute>
13497
13498	<method name="getMetrics">
13499	<desc>
13500	Returns parameters of specified metrics for a set of objects.
13501	<note>
13502	@c Null metrics array means all metrics. @c Null object array means
13503	all existing objects.
13504	</note>
13505	</desc>
13506	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13507	<desc>
13508	Metric name filter. Currently, only a comma-separated list of metrics
13509	is supported.
13510	</desc>
13511	</param>
13512	<param name="objects" type="$unknown" dir="in" safearray="yes">
13513	<desc>
13514	Set of objects to return metric parameters for.
13515	</desc>
13516	</param>
13517	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13518	<desc>
13519	Array of returned metric parameters.
13520	</desc>
13521	</param>
13522	</method>
13523
13524	<method name="setupMetrics">
13525	<desc>
13526	Sets parameters of specified base metrics for a set of objects. Returns
13527	an array of <link to="IPerformanceMetric" /> describing the metrics have
13528	been affected.
13529	<note>
13530	@c Null or empty metric name array means all metrics. @c Null or empty
13531	object array means all existing objects. If metric name array contains
13532	a single element and object array contains many, the single metric
13533	name array element is applied to each object array element to form
13534	metric/object pairs.
13535	</note>
13536	</desc>
13537	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13538	<desc>
13539	Metric name filter. Comma-separated list of metrics with wildcard
13540	support.
13541	</desc>
13542	</param>
13543	<param name="objects" type="$unknown" dir="in" safearray="yes">
13544	<desc>
13545	Set of objects to setup metric parameters for.
13546	</desc>
13547	</param>
13548	<param name="period" type="unsigned long" dir="in">
13549	<desc>
13550	Time interval in seconds between two consecutive samples of performance
13551	data.
13552	</desc>
13553	</param>
13554	<param name="count" type="unsigned long" dir="in">
13555	<desc>
13556	Number of samples to retain in performance data history. Older samples
13557	get discarded.
13558	</desc>
13559	</param>
13560	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13561	<desc>
13562	Array of metrics that have been modified by the call to this method.
13563	</desc>
13564	</param>
13565	</method>
13566
13567	<method name="enableMetrics">
13568	<desc>
13569	Turns on collecting specified base metrics. Returns an array of
13570	<link to="IPerformanceMetric" /> describing the metrics have been
13571	affected.
13572	<note>
13573	@c Null or empty metric name array means all metrics. @c Null or empty
13574	object array means all existing objects. If metric name array contains
13575	a single element and object array contains many, the single metric
13576	name array element is applied to each object array element to form
13577	metric/object pairs.
13578	</note>
13579	</desc>
13580	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13581	<desc>
13582	Metric name filter. Comma-separated list of metrics with wildcard
13583	support.
13584	</desc>
13585	</param>
13586	<param name="objects" type="$unknown" dir="in" safearray="yes">
13587	<desc>
13588	Set of objects to enable metrics for.
13589	</desc>
13590	</param>
13591	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13592	<desc>
13593	Array of metrics that have been modified by the call to this method.
13594	</desc>
13595	</param>
13596	</method>
13597
13598	<method name="disableMetrics">
13599	<desc>
13600	Turns off collecting specified base metrics. Returns an array of
13601	<link to="IPerformanceMetric" /> describing the metrics have been
13602	affected.
13603	<note>
13604	@c Null or empty metric name array means all metrics. @c Null or empty
13605	object array means all existing objects. If metric name array contains
13606	a single element and object array contains many, the single metric
13607	name array element is applied to each object array element to form
13608	metric/object pairs.
13609	</note>
13610	</desc>
13611	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13612	<desc>
13613	Metric name filter. Comma-separated list of metrics with wildcard
13614	support.
13615	</desc>
13616	</param>
13617	<param name="objects" type="$unknown" dir="in" safearray="yes">
13618	<desc>
13619	Set of objects to disable metrics for.
13620	</desc>
13621	</param>
13622	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13623	<desc>
13624	Array of metrics that have been modified by the call to this method.
13625	</desc>
13626	</param>
13627	</method>
13628
13629	<method name="queryMetricsData">
13630	<desc>
13631	Queries collected metrics data for a set of objects.
13632
13633	The data itself and related metric information are returned in seven
13634	parallel and one flattened array of arrays. Elements of
13635	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13636	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13637	the same index describe one set of values corresponding to a single
13638	metric.
13639
13640	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13641	start and length of a sub-array is indicated by
13642	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13643	value for metric <tt>metricNames[i]</tt> is at
13644	<tt>returnData[returnIndices[i]]</tt>.
13645
13646	<note>
13647	@c Null or empty metric name array means all metrics. @c Null or empty
13648	object array means all existing objects. If metric name array contains
13649	a single element and object array contains many, the single metric
13650	name array element is applied to each object array element to form
13651	metric/object pairs.
13652	</note>
13653	<note>
13654	Data collection continues behind the scenes after call to
13655	@c queryMetricsData. The return data can be seen as the snapshot of
13656	the current state at the time of @c queryMetricsData call. The
13657	internally kept metric values are not cleared by the call. This makes
13658	possible querying different subsets of metrics or aggregates with
13659	subsequent calls. If periodic querying is needed it is highly
13660	suggested to query the values with @c interval*count period to avoid
13661	confusion. This way a completely new set of data values will be
13662	provided by each query.
13663	</note>
13664	</desc>
13665	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13666	<desc>
13667	Metric name filter. Comma-separated list of metrics with wildcard
13668	support.
13669	</desc>
13670	</param>
13671	<param name="objects" type="$unknown" dir="in" safearray="yes">
13672	<desc>
13673	Set of objects to query metrics for.
13674	</desc>
13675	</param>
13676	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13677	<desc>
13678	Names of metrics returned in @c returnData.
13679	</desc>
13680	</param>
13681	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13682	<desc>
13683	Objects associated with metrics returned in @c returnData.
13684	</desc>
13685	</param>
13686	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13687	<desc>
13688	Units of measurement for each returned metric.
13689	</desc>
13690	</param>
13691	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13692	<desc>
13693	Divisor that should be applied to return values in order to get
13694	floating point values. For example:
13695	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13696	will retrieve the floating point value of i-th sample of the first
13697	metric.
13698	</desc>
13699	</param>
13700	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13701	<desc>
13702	Sequence numbers of the first elements of value sequences of particular metrics
13703	returned in @c returnData. For aggregate metrics it is the sequence number of
13704	the sample the aggregate started calculation from.
13705	</desc>
13706	</param>
13707	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13708	<desc>
13709	Indices of the first elements of value sequences of particular metrics
13710	returned in @c returnData.
13711	</desc>
13712	</param>
13713	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13714	<desc>
13715	Lengths of value sequences of particular metrics.
13716	</desc>
13717	</param>
13718	<param name="returnData" type="long" dir="return" safearray="yes">
13719	<desc>
13720	Flattened array of all metric data containing sequences of values for
13721	each metric.
13722	</desc>
13723	</param>
13724	</method>
13725
13726	</interface>
13727
13728	<module name="VBoxSVC" context="LocalServer">
13729	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13730	namespace="virtualbox.org">
13731	<interface name="IVirtualBox" default="yes"/>
13732	</class>
13733	</module>
13734
13735	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13736	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13737	namespace="virtualbox.org">
13738	<interface name="ISession" default="yes"/>
13739	</class>
13740	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13741	namespace="virtualbox.org">
13742	<interface name="ILocalOwner" default="yes"/>
13743	<interface name="IVirtualBoxCallback"/>
13744	<interface name="IConsoleCallback"/>
13745	</class>
13746	</module>
13747
13748	</library>
13749
13750	</idl>
13751
13752	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format