VirtualBox.xidl@ 25966

Last change on this file since 25966 was 25904, checked in by vboxsync, 15 years ago
Use settings version 1.10 for CPU hotplugging
Property svn:eol-style set to `native`
File size: 507.5 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4	* :tabSize=2:indentSize=2:noTabs=true:
5	* :folding=explicit:collapseFolds=1:
6	*
7	* Master declaration for VirtualBox's Main API, represented
8	* by COM/XPCOM and web service interfaces.
9	*
10	* From this document, the build system generates several files
11	* via XSLT that are then used during the build process.
12	*
13	* Below is the list of XSL templates that operate on this file and
14	* output files they generate. These XSL templates must be updated
15	* whenever the schema of this file changes:
16	*
17	* 1. src/VBox/Main/idl/midl.xsl =>
18	* out/<platform>/bin/sdk/idl/VirtualBox.idl
19	* (MS COM interface definition file for Main API)
20	*
21	* 2. src/VBox/Main/idl/xpidl.xsl =>
22	* out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
23	* (XPCOM interface definition file for Main API)
24	*
25	* 3. src/VBox/Main/idl/doxygen.xsl =>
26	* out/<platform>/obj/src/VBox/Main/VirtualBox.idl
27	* (pseudo-IDL for Doxygen to generate the official Main API
28	* documentation)
29	*
30	* 4. src/VBox/Main/webservice/*.xsl =>
31	* a bunch of WSDL and C++ files
32	* (VirtualBox web service sources and SOAP mappers;
33	* see src/VBox/Main/webservice/Makefile.kmk for details)
34	*
35	* 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
36	* out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
37	* (smart Qt-based C++ wrapper classes for COM interfaces
38	* of the Main API)
39	*
40	* 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
41	* out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
42	* (Main API TypeLib block for the WiX installer)
43	*
44	* 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
45	* out/<platform>/obj/Runtime/errmsgvboxcomdata.h
46	* (<result> extraction for the %Rhrc format specifier)
47	*
48	Copyright (C) 2006-2010 Sun Microsystems, Inc.
49
50	This file is part of VirtualBox Open Source Edition (OSE), as
51	available from http://www.virtualbox.org. This file is free software;
52	you can redistribute it and/or modify it under the terms of the GNU
53	General Public License (GPL) as published by the Free Software
54	Foundation, in version 2 as it comes in the "COPYING" file of the
55	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
56	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
57
58	Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
59	Clara, CA 95054 USA or visit http://www.sun.com if you need
60	additional information or have any questions.
61	-->
62
63	<idl>
64
65	<desc>
66	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
67	describes the so-called <i>VirtualBox Main API</i> which comprises all public
68	COM interfaces and components provided by the VirtualBox server and by the
69	VirtualBox client library.
70
71	VirtualBox employs a client-server design, meaning that whenever any part of
72	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
73	interface or any virtual machine --, a dedicated server process named
74	VBoxSVC runs in the background. This allows multiple processes working with
75	VirtualBox to cooperate without conflicts. These processes communicate to each
76	other using inter-process communication facilities provided by the COM
77	implementation of the host computer.
78
79	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
80	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
81	implementation, is used.
82
83	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
84	the VBoxManage command-line interface and the VBoxVRDP server) are technically
85	front-ends to the Main API and only use the interfaces that are documented
86	in this Main API documentation. This ensures that, with any given release
87	version of VirtualBox, all capabilities of the product that could be useful
88	to an external client program are always exposed by way of this API.
89
90	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
91	contains two public component classes:
92	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
93	implement IVirtualBox and ISession interfaces respectively. These two classes
94	are of supreme importance and will be needed in order for any front-end
95	program to do anything useful. It is recommended to read the documentation of
96	the mentioned interfaces first.
97
98	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
99	there can be only one object of this class on the local machine at any given
100	time. This object is a parent of many other objects in the VirtualBox COM
101	library and lives in the VBoxSVC process. In fact, when you create an instance
102	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
103	process is already running, starts it if not, and returns you a reference to
104	the <tt>VirtualBox</tt> object created in this process. When the last reference
105	to this object is released, the VBoxSVC process ends (with a 5 second delay to
106	protect from too frequent restarts).
107
108	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
109	as many <tt>Session</tt> objects as you need but all of them will live in a
110	process which issues the object instantiation call. <tt>Session</tt> objects
111	represent virtual machine sessions which are used to configure virtual
112	machines and control their execution.
113	</desc>
114
115	<if target="midl">
116	<cpp line="enum {"/>
117	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
118	<cpp line=" kTypeLibraryMinorVersion = 0"/>
119	<cpp line="};"/>
120	</if>
121
122	<if target="xpidl">
123	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
124	<cpp>
125	/* currently, nsISupportsImpl.h lacks the below-like macros */
126
127	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
128	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
129	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
130
131	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
132	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
133	NS_IMPL_THREADSAFE_ADDREF(_class) \
134	NS_IMPL_THREADSAFE_RELEASE(_class) \
135	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
136	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
137	#endif
138
139	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
140	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
141	NS_IMPL_THREADSAFE_ADDREF(_class) \
142	NS_IMPL_THREADSAFE_RELEASE(_class) \
143	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
144	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
145	#endif
146
147	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
148	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
149	NS_IMPL_THREADSAFE_ADDREF(_class) \
150	NS_IMPL_THREADSAFE_RELEASE(_class) \
151	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
152	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
153	#endif
154
155	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
156	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
157	NS_INTERFACE_MAP_BEGIN(_class) \
158	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
159	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
160	NS_IMPL_QUERY_CLASSINFO(_class) \
161	NS_INTERFACE_MAP_END
162	#endif
163
164	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
165	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
166	_i2, _ic2) \
167	NS_INTERFACE_MAP_BEGIN(_class) \
168	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
169	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
170	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
171	NS_IMPL_QUERY_CLASSINFO(_class) \
172	NS_INTERFACE_MAP_END
173	#endif
174
175	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
176	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
177	_i2, _ic2, _i3, _ic3) \
178	NS_INTERFACE_MAP_BEGIN(_class) \
179	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
180	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
183	NS_IMPL_QUERY_CLASSINFO(_class) \
184	NS_INTERFACE_MAP_END
185	#endif
186
187	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
188	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
189	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
190
191	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
192	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
193	NS_IMPL_THREADSAFE_ADDREF(_class) \
194	NS_IMPL_THREADSAFE_RELEASE(_class) \
195	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
196	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
197	#endif
198
199	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
200	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_THREADSAFE_ADDREF(_class) \
203	NS_IMPL_THREADSAFE_RELEASE(_class) \
204	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
205	_i2, _ic2) \
206	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
207	#endif
208
209	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
210	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_THREADSAFE_ADDREF(_class) \
213	NS_IMPL_THREADSAFE_RELEASE(_class) \
214	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
215	_i2, _ic2, _i3, _ic3) \
216	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
217	#endif
218
219	</cpp>
220	</if>
221
222	<library
223	name="VirtualBox"
224	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
225	version="1.3"
226	desc="VirtualBox Type Library"
227	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
228	supportsErrorInfo="yes"
229	>
230
231
232	<!--
233	// COM result codes for VirtualBox
234	/////////////////////////////////////////////////////////////////////////
235	-->
236
237	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
238	<desc>
239	This section describes all VirtualBox-specific COM result codes that may
240	be returned by methods of VirtualBox COM interfaces in addition to
241	standard COM result codes.
242
243	Note that along with the result code, every VirtualBox method returns
244	extended error information through the IVirtualBoxErrorInfo interface on
245	failure. This interface is a preferred way to present the error to the end
246	user because it contains a human readable description of the error. Raw
247	result codes, both standard and described in this section, are intended to
248	be used by programs to analyze the reason of a failure and select an
249	appropriate course of action without involving the end user (for example,
250	retry the operation later or make a different call).
251
252	The standard COM result codes that may originate from our methods include:
253
254	<table>
255	<tr><td>E_INVALIDARG</td>
256	<td>
257	Returned when the value of the method's argument is not within the range
258	of valid values. This should not be confused with situations when the
259	value is within the range but simply doesn't suit the current object
260	state and there is a possibility that it will be accepted later (in such
261	cases VirtualBox-specific codes are returned, for example,
262	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
263	</td>
264	</tr>
265	<tr><td>E_POINTER</td>
266	<td>
267	Returned if a memory pointer for the output argument is invalid (for
268	example, @c null). Note that when pointers representing input
269	arguments (such as strings) are invalid, E_INVALIDARG is returned.
270	</td>
271	</tr>
272	<tr><td>E_ACCESSDENIED</td>
273	<td>
274	Returned when the called object is not ready. Since the lifetime of a
275	public COM object cannot be fully controlled by the implementation,
276	VirtualBox maintains the readiness state for all objects it creates and
277	returns this code in response to any method call on the object that was
278	deactivated by VirtualBox and is not functioning any more.
279	</td>
280	</tr>
281	<tr><td>E_OUTOFMEMORY</td>
282	<td>
283	Returned when a memory allocation operation fails.
284	</td>
285	</tr>
286	</table>
287	</desc>
288	</descGroup>
289
290	<!--
291	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
292	everything in <result>/<desc> after (and including) the first dot, so express
293	the matter of the error code in the first sentence and keep it short.
294	-->
295
296	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
297	<desc>
298	Object corresponding to the supplied arguments does not exist.
299	</desc>
300	</result>
301
302	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
303	<desc>
304	Current virtual machine state prevents the operation.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
309	<desc>
310	Virtual machine error occurred attempting the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
315	<desc>
316	File not accessible or erroneous file contents.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
321	<desc>
322	Runtime subsystem error.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
327	<desc>
328	Pluggable Device Manager error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
333	<desc>
334	Current object state prohibits operation.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
339	<desc>
340	Host operating system related error.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
345	<desc>
346	Requested operation is not supported.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
351	<desc>
352	Invalid XML found.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
357	<desc>
358	Current session state prohibits operation.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
363	<desc>
364	Object being in use prohibits operation.
365	</desc>
366	</result>
367
368	<!--
369	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
370	everything in <result>/<desc> after (and including) the first dot, so express
371	the matter of the error code in the first sentence and keep it short.
372	-->
373
374	<descGroup/>
375
376	<!--
377	// all common enums
378	/////////////////////////////////////////////////////////////////////////
379	-->
380
381	<enum name="SettingsVersion"
382	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
383	>
384	<desc>Settings version of VirtualBox settings files. This is written to
385	the "version" attribute of the root "VirtualBox" element in the settings
386	file XML and indicates which VirtualBox version wrote the file.
387	</desc>
388
389	<const name="Null" value="0">
390	<desc>Null value, indicates invalid version.</desc>
391	</const>
392	<const name="v1_0" value="1">
393	<desc>Legacy settings version, not currently supported.</desc>
394	</const>
395	<const name="v1_1" value="2">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_2" value="3">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_3pre" value="4">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3" value="5">
405	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
406	<!--
407	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
408	-->
409	</const>
410	<const name="v1_4" value="6">
411	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
412	<!--
413	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
414	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
415	-->
416	</const>
417	<const name="v1_5" value="7">
418	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
419	<!-- 2008-09-04: 2.0.0 released
420	2008-11-20: settings version 1.5 introduced
421	2008-12-17: 2.1.0 released
422	Machine changes:
423	guest OS identifiers changed;
424	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
425	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
426	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
427	-->
428	</const>
429	<const name="v1_6" value="8">
430	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
431	<!-- 2008-12-17: 2.1.0 released
432	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
433	2009-04-08: 2.2.0 released
434	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
435	-->
436	</const>
437	<const name="v1_7" value="9">
438	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
439	<!-- 2008-12-17: 2.1.0 released
440	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
441	2009-04-08: 2.2.0 released
442	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
443	Machine changes: HardDiskAttachments is now StorageControllers (done)
444	-->
445	</const>
446	<const name="v1_8" value="10">
447	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
448	<!-- Machine additions: Display/@accelerate2DVideo (done)
449	-->
450	</const>
451	<const name="v1_9" value="11">
452	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
453	<!-- The big storage controller / DVD / Floppy rework (done)
454	-->
455	</const>
456	<const name="v1_10" value="12">
457	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
458	<!-- Machine changes: RTC localOrUTC (done)
459	CPU hot-plug support
460	-->
461	</const>
462	<const name="Future" value="13">
463	<desc>Settings version greater than "1.10", written by a future VirtualBox version.</desc>
464	</const>
465	</enum>
466
467	<enum
468	name="AccessMode"
469	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
470	>
471	<desc>
472	Access mode for opening files.
473	</desc>
474
475	<const name="ReadOnly" value="1"/>
476	<const name="ReadWrite" value="2"/>
477	</enum>
478
479	<enum
480	name="MachineState"
481	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
482	>
483	<desc>
484	Virtual machine execution state.
485
486	This enumeration represents possible values of the <link
487	to="IMachine::state"/> attribute.
488
489	Below is the basic virtual machine state diagram. It shows how the state
490	changes during virtual machine execution. The text in square braces shows
491	a method of the IConsole interface that performs the given state
492	transition.
493
494	<pre>
495	+---------[powerDown()] <- Stuck <--[failure]-+
496	V \|
497	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
498	\| \| \| \| V \|
499	\| Aborted -----+ +--> Running --[pause()]--> Paused
500	\| \| ^ \| ^ \|
501	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
502	\| ^ \| \| \| \|
503	\| \| +-----------------------------------------+-\|-------------------+ +
504	\| \| \| \| \|
505	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
506	\| \| \| \|
507	\| +-------- Saving <--------[saveState()]<----------+---------------------+
508	\| \| \|
509	+-------------- Stopping -------[powerDown()]<----------+---------------------+
510	</pre>
511
512	Note that states to the right from PoweredOff, Aborted and Saved in the
513	above diagram are called <i>online VM states</i>. These states
514	represent the virtual machine which is being executed in a dedicated
515	process (usually with a GUI window attached to it where you can see the
516	activity of the virtual machine and interact with it). There are two
517	special pseudo-states, FirstOnline and LastOnline, that can be used in
518	relational expressions to detect if the given machine state is online or
519	not:
520
521	<pre>
522	if (machine.GetState() >= MachineState_FirstOnline &&
523	machine.GetState() <= MachineState_LastOnline)
524	{
525	...the machine is being executed...
526	}
527	</pre>
528
529	When the virtual machine is in one of the online VM states (that is, being
530	executed), only a few machine settings can be modified. Methods working
531	with such settings contain an explicit note about that. An attempt to
532	change any oter setting or perform a modifying operation during this time
533	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
534
535	All online states except Running, Paused and Stuck are transitional: they
536	represent temporary conditions of the virtual machine that will last as
537	long as the operation that initiated such a condition.
538
539	The Stuck state is a special case. It means that execution of the machine
540	has reached the "Guru Meditation" condition. This condition indicates an
541	internal VMM (virtual machine manager) failure which may happen as a
542	result of either an unhandled low-level virtual hardware exception or one
543	of the recompiler exceptions (such as the <i>too-many-traps</i>
544	condition).
545
546	Note also that any online VM state may transit to the Aborted state. This
547	happens if the process that is executing the virtual machine terminates
548	unexpectedly (for example, crashes). Other than that, the Aborted state is
549	equivalent to PoweredOff.
550
551	There are also a few additional state diagrams that do not deal with
552	virtual machine execution and therefore are shown separately. The states
553	shown on these diagrams are called <i>offline VM states</i> (this includes
554	PoweredOff, Aborted and Saved too).
555
556	The first diagram shows what happens when a lengthy setup operation is
557	being executed (such as <link to="IMachine::attachDevice"/>).
558
559	<pre>
560	+----------------------------------(same state as before the call)------+
561	\| \|
562	+-> PoweredOff --+ \|
563	\| \| \|
564	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
565	\| \|
566	+-> Saved -------+
567	</pre>
568
569	The next two diagrams demonstrate the process of taking a snapshot of a
570	powered off virtual machine and performing one of the "discard..."
571	operations, respectively.
572
573	<pre>
574	+----------------------------------(same state as before the call)------+
575	\| \|
576	+-> PoweredOff --+ \|
577	\| +-->[takeSnapshot()] -------------------> Saving ------+
578	+-> Aborted -----+
579
580	+-> PoweredOff --+
581	\| \|
582	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
583	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
584	+-> Saved -------+ \|
585	\| \|
586	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
587	</pre>
588
589	Note that the Saving state is present in both the offline state group and
590	online state group. Currently, the only way to determine what group is
591	assumed in a particular case is to remember the previous machine state: if
592	it was Running or Paused, then Saving is an online state, otherwise it is
593	an offline state. This inconsistency may be removed in one of the future
594	versions of VirtualBox by adding a new state.
595
596	<note internal="yes">
597	For whoever decides to touch this enum: In order to keep the
598	comparisons involving FirstOnline and LastOnline pseudo-states valid,
599	the numeric values of these states must be correspondingly updated if
600	needed: for any online VM state, the condition
601	<tt>FirstOnline <= state <= LastOnline</tt> must be
602	@c true. The same relates to transient states for which
603	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
604	@c true.
605	</note>
606	</desc>
607
608	<const name="Null" value="0">
609	<desc>Null value (never used by the API).</desc>
610	</const>
611	<const name="PoweredOff" value="1">
612	<desc>
613	The machine is not running and has no saved execution state; it has
614	either never been started or been shut down successfully.
615	</desc>
616	</const>
617	<const name="Saved" value="2">
618	<desc>
619	The machine is not currently running, but the execution state of the machine
620	has been saved to an external file when it was running, from where
621	it can be resumed.
622	</desc>
623	</const>
624	<const name="Teleported" value="3">
625	<desc>
626	The machine was teleported to a different host (or process) and then
627	powered off. Take care when powering it on again may corrupt resources
628	it shares with the teleportation target (e.g. disk and network).
629	</desc>
630	</const>
631	<const name="Aborted" value="4">
632	<desc>
633	The process running the machine has terminated abnormally. This may
634	indicate a crash of the VM process in host execution context, or
635	the VM process has been terminated externally.
636	</desc>
637	</const>
638	<const name="Running" value="5">
639	<desc>
640	The machine is currently being executed.
641	<note internal="yes">
642	For whoever decides to touch this enum: In order to keep the
643	comparisons in the old source code valid, this state must immediately
644	precede the Paused state.
645	TODO: Lift this spectacularly wonderful restriction.
646	</note>
647	</desc>
648	</const>
649	<const name="Paused" value="6">
650	<desc>
651	Execution of the machine has been paused.
652	<note internal="yes">
653	For whoever decides to touch this enum: In order to keep the
654	comparisons in the old source code valid, this state must immediately
655	follow the Running state.
656	TODO: Lift this spectacularly wonderful restriction.
657	</note>
658	</desc>
659	</const>
660	<const name="Stuck" value="7">
661	<desc>
662	Execution of the machine has reached the "Guru Meditation"
663	condition. This indicates a severe error in the hypervisor itself.
664	<note internal="yes">
665	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
666	"Guru", perhaps? Or are there some other VMM states that are
667	intended to be lumped in here as well?
668	</note>
669	</desc>
670	</const>
671	<const name="Teleporting" value="8">
672	<desc>
673	The machine is about to be teleported to a different host or process.
674	It is possible to pause a machine in this state, but it will go to the
675	<link to="MachineState::PausedTeleporting"/> state and it will not be
676	possible to resume it again unless the teleportation fails.
677	</desc>
678	</const>
679	<const name="LiveSnapshotting" value="9">
680	<desc>
681	A live snapshot is being taken. The machine is running normally, but
682	some of the runtime configuration options are inaccessible. Also, if
683	paused while in this state it will transition to
684	<link to="MachineState::Saving"/> and it will not be resume the
685	execution until the snapshot operation has completed.
686	</desc>
687	</const>
688	<const name="Starting" value="10">
689	<desc>
690	Machine is being started after powering it on from a
691	zero execution state.
692	</desc>
693	</const>
694	<const name="Stopping" value="11">
695	<desc>
696	Machine is being normally stopped powering it off, or after the guest OS
697	has initiated a shutdown sequence.
698	</desc>
699	</const>
700	<const name="Saving" value="12">
701	<desc>
702	Machine is saving its execution state to a file, or an online
703	snapshot of the machine is being taken.
704	</desc>
705	</const>
706	<const name="Restoring" value="13">
707	<desc>
708	Execution state of the machine is being restored from a file
709	after powering it on from the saved execution state.
710	</desc>
711	</const>
712	<const name="TeleportingPausedVM" value="14">
713	<desc>
714	The machine is being teleported to another host or process, but it is
715	not running. This is the paused variant of the
716	<link to="MachineState::Teleporting"/> state.
717	</desc>
718	</const>
719	<const name="TeleportingIn" value="15">
720	<desc>
721	Teleporting the machine state in from another host or process.
722	</desc>
723	</const>
724	<const name="RestoringSnapshot" value="16">
725	<desc>
726	A machine snapshot is being restored; this typically does not take long.
727	</desc>
728	</const>
729	<const name="DeletingSnapshot" value="17">
730	<desc>
731	A machine snapshot is being deleted; this can take a long time since this
732	may require merging differencing media.
733	</desc>
734	</const>
735	<const name="SettingUp" value="18">
736	<desc>
737	Lengthy setup operation is in progress.
738	</desc>
739	</const>
740
741	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
742	<desc>
743	Pseudo-state: first online state (for use in relational expressions).
744	</desc>
745	</const>
746	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
747	<desc>
748	Pseudo-state: last online state (for use in relational expressions).
749	</desc>
750	</const>
751
752	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
753	<desc>
754	Pseudo-state: first transient state (for use in relational expressions).
755	</desc>
756	</const>
757	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
758	<desc>
759	Pseudo-state: last transient state (for use in relational expressions).
760	</desc>
761	</const>
762
763	</enum>
764
765	<enum
766	name="SessionState"
767	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
768	>
769	<desc>
770	Session state. This enumeration represents possible values of
771	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
772	attributes. See individual enumerator descriptions for the meaning for
773	every value.
774	</desc>
775
776	<const name="Null" value="0">
777	<desc>Null value (never used by the API).</desc>
778	</const>
779	<const name="Closed" value="1">
780	<desc>
781	The machine has no open sessions (<link to="IMachine::sessionState"/>);
782	the session is closed (<link to="ISession::state"/>)
783	</desc>
784	</const>
785	<const name="Open" value="2">
786	<desc>
787	The machine has an open direct session (<link to="IMachine::sessionState"/>);
788	the session is open (<link to="ISession::state"/>)
789	</desc>
790	</const>
791	<const name="Spawning" value="3">
792	<desc>
793	A new (direct) session is being opened for the machine as a result of
794	<link to="IVirtualBox::openRemoteSession"/> call
795	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
796	This state also occurs as a short transient state when a new direct
797	session is opened by calling <link to="IVirtualBox::openSession"/>.
798	</desc>
799	</const>
800	<const name="Closing" value="4">
801	<desc>
802	The direct session is being closed (<link to="IMachine::sessionState"/>);
803	the session is being closed (<link to="ISession::state"/>)
804	</desc>
805	</const>
806	</enum>
807
808	<enum
809	name="CpuPropertyType"
810	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
811	>
812	<desc>
813	Virtual CPU property type. This enumeration represents possible values of the
814	IMachine get- and setCpuProperty methods.
815	</desc>
816	<const name="Null" value="0">
817	<desc>Null value (never used by the API).</desc>
818	</const>
819	<const name="PAE" value="1">
820	<desc>
821	This setting determines whether VirtualBox will expose the Physical Address
822	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
823	is not available, it will not be reported.
824	</desc>
825	</const>
826	<const name="Synthetic" value="2">
827	<desc>
828	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
829	teleporting between host systems that differ significantly.
830	</desc>
831	</const>
832	</enum>
833
834
835	<enum
836	name="HWVirtExPropertyType"
837	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
838	>
839	<desc>
840	Hardware virtualization property type. This enumeration represents possible values
841	for the <link to="IMachine::getHWVirtExProperty"/> and
842	<link to="IMachine::setHWVirtExProperty"/> methods.
843	</desc>
844	<const name="Null" value="0">
845	<desc>Null value (never used by the API).</desc>
846	</const>
847	<const name="Enabled" value="1">
848	<desc>
849	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
850	such extensions are not available, they will not be used.
851	</desc>
852	</const>
853	<const name="Exclusive" value="2">
854	<desc>
855	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
856	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
857	feature of the host. To share these with other hypervisors, you must disable this property.
858	</desc>
859	</const>
860	<const name="VPID" value="3">
861	<desc>
862	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
863	</desc>
864	</const>
865	<const name="NestedPaging" value="4">
866	<desc>
867	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
868	</desc>
869	</const>
870	</enum>
871
872	<enum
873	name="SessionType"
874	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
875	>
876	<desc>
877	Session type. This enumeration represents possible values of the
878	<link to="ISession::type"/> attribute.
879	</desc>
880
881	<const name="Null" value="0">
882	<desc>Null value (never used by the API).</desc>
883	</const>
884	<const name="Direct" value="1">
885	<desc>
886	Direct session
887	(opened by <link to="IVirtualBox::openSession"/>)
888	</desc>
889	</const>
890	<const name="Remote" value="2">
891	<desc>
892	Remote session
893	(opened by <link to="IVirtualBox::openRemoteSession"/>)
894	</desc>
895	</const>
896	<const name="Existing" value="3">
897	<desc>
898	Existing session
899	(opened by <link to="IVirtualBox::openExistingSession"/>)
900	</desc>
901	</const>
902	</enum>
903
904	<enum
905	name="DeviceType"
906	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
907	>
908	<desc>
909	Device type.
910	</desc>
911	<const name="Null" value="0">
912	<desc>
913	Null value, may also mean "no device" (not allowed for
914	<link to="IConsole::getDeviceActivity"/>).
915	</desc>
916	</const>
917	<const name="Floppy" value="1">
918	<desc>Floppy device.</desc>
919	</const>
920	<const name="DVD" value="2">
921	<desc>CD/DVD-ROM device.</desc>
922	</const>
923	<const name="HardDisk" value="3">
924	<desc>Hard disk device.</desc>
925	</const>
926	<const name="Network" value="4">
927	<desc>Network device.</desc>
928	</const>
929	<const name="USB" value="5">
930	<desc>USB device.</desc>
931	</const>
932	<const name="SharedFolder" value="6">
933	<desc>Shared folder device.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="DeviceActivity"
939	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
940	>
941	<desc>
942	Device activity for <link to="IConsole::getDeviceActivity"/>.
943	</desc>
944
945	<const name="Null" value="0"/>
946	<const name="Idle" value="1"/>
947	<const name="Reading" value="2"/>
948	<const name="Writing" value="3"/>
949	</enum>
950
951	<enum
952	name="ClipboardMode"
953	uuid="33364716-4008-4701-8f14-be0fa3d62950"
954	>
955	<desc>
956	Host-Guest clipboard interchange mode.
957	</desc>
958
959	<const name="Disabled" value="0"/>
960	<const name="HostToGuest" value="1"/>
961	<const name="GuestToHost" value="2"/>
962	<const name="Bidirectional" value="3"/>
963	</enum>
964
965	<enum
966	name="Scope"
967	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
968	>
969	<desc>
970	Scope of the operation.
971
972	A generic enumeration used in various methods to define the action or
973	argument scope.
974	</desc>
975
976	<const name="Global" value="0"/>
977	<const name="Machine" value="1"/>
978	<const name="Session" value="2"/>
979	</enum>
980
981	<enum
982	name="GuestStatisticType"
983	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
984	>
985	<desc>
986	Statistics type for <link to="IGuest::getStatistic"/>.
987	</desc>
988
989	<const name="CPULoad_Idle" value="0">
990	<desc>
991	Idle CPU load (0-100%) for last interval.
992	</desc>
993	</const>
994	<const name="CPULoad_Kernel" value="1">
995	<desc>
996	Kernel CPU load (0-100%) for last interval.
997	</desc>
998	</const>
999	<const name="CPULoad_User" value="2">
1000	<desc>
1001	User CPU load (0-100%) for last interval.
1002	</desc>
1003	</const>
1004	<const name="Threads" value="3">
1005	<desc>
1006	Total number of threads in the system.
1007	</desc>
1008	</const>
1009	<const name="Processes" value="4">
1010	<desc>
1011	Total number of processes in the system.
1012	</desc>
1013	</const>
1014	<const name="Handles" value="5">
1015	<desc>
1016	Total number of handles in the system.
1017	</desc>
1018	</const>
1019	<const name="MemoryLoad" value="6">
1020	<desc>
1021	Memory load (0-100%).
1022	</desc>
1023	</const>
1024	<const name="PhysMemTotal" value="7">
1025	<desc>
1026	Total physical memory in megabytes.
1027	</desc>
1028	</const>
1029	<const name="PhysMemAvailable" value="8">
1030	<desc>
1031	Free physical memory in megabytes.
1032	</desc>
1033	</const>
1034	<const name="PhysMemBalloon" value="9">
1035	<desc>
1036	Ballooned physical memory in megabytes.
1037	</desc>
1038	</const>
1039	<const name="MemCommitTotal" value="10">
1040	<desc>
1041	Total amount of memory in the committed state in megabytes.
1042	</desc>
1043	</const>
1044	<const name="MemKernelTotal" value="11">
1045	<desc>
1046	Total amount of memory used by the guest OS's kernel in megabytes.
1047	</desc>
1048	</const>
1049	<const name="MemKernelPaged" value="12">
1050	<desc>
1051	Total amount of paged memory used by the guest OS's kernel in megabytes.
1052	</desc>
1053	</const>
1054	<const name="MemKernelNonpaged" value="13">
1055	<desc>
1056	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1057	</desc>
1058	</const>
1059	<const name="MemSystemCache" value="14">
1060	<desc>
1061	Total amount of memory used by the guest OS's system cache in megabytes.
1062	</desc>
1063	</const>
1064	<const name="PageFileSize" value="15">
1065	<desc>
1066	Pagefile size in megabytes.
1067	</desc>
1068	</const>
1069	<const name="SampleNumber" value="16">
1070	<desc>
1071	Statistics sample number
1072	</desc>
1073	</const>
1074	<const name="MaxVal" value="17"/>
1075	</enum>
1076
1077	<enum
1078	name="BIOSBootMenuMode"
1079	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1080	>
1081	<desc>
1082	BIOS boot menu mode.
1083	</desc>
1084
1085	<const name="Disabled" value="0"/>
1086	<const name="MenuOnly" value="1"/>
1087	<const name="MessageAndMenu" value="2"/>
1088	</enum>
1089
1090	<enum
1091	name="ProcessorFeature"
1092	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1093	>
1094	<desc>
1095	CPU features.
1096	</desc>
1097
1098	<const name="HWVirtEx" value="0"/>
1099	<const name="PAE" value="1"/>
1100	<const name="LongMode" value="2"/>
1101	<const name="NestedPaging" value="3"/>
1102	</enum>
1103
1104	<enum
1105	name="FirmwareType"
1106	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1107	>
1108	<desc>
1109	Firmware type.
1110	</desc>
1111	<const name="BIOS" value="1">
1112	<desc>BIOS Firmware.</desc>
1113	</const>
1114	<const name="EFI" value="2">
1115	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1116	</const>
1117	<const name="EFI32" value="3">
1118	<desc>Efi firmware, 32-bit.</desc>
1119	</const>
1120	<const name="EFI64" value="4">
1121	<desc>Efi firmware, 64-bit.</desc>
1122	</const>
1123	<const name="EFIDUAL" value="5">
1124	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1125	</const>
1126	</enum>
1127
1128	<!--
1129	// IVirtualBoxErrorInfo
1130	/////////////////////////////////////////////////////////////////////////
1131	-->
1132
1133	<interface
1134	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1135	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1136	supportsErrorInfo="no"
1137	wsmap="managed"
1138	>
1139	<desc>
1140	The IVirtualBoxErrorInfo interface represents extended error information.
1141
1142	Extended error information can be set by VirtualBox components after
1143	unsuccessful or partially successful method invocation. This information
1144	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1145	and then shown to the client in addition to the plain 32-bit result code.
1146
1147	In MS COM, this interface extends the IErrorInfo interface,
1148	in XPCOM, it extends the nsIException interface. In both cases,
1149	it provides a set of common attributes to retrieve error
1150	information.
1151
1152	Sometimes invocation of some component's method may involve methods of
1153	other components that may also fail (independently of this method's
1154	failure), or a series of non-fatal errors may precede a fatal error that
1155	causes method failure. In cases like that, it may be desirable to preserve
1156	information about all errors happened during method invocation and deliver
1157	it to the caller. The <link to="#next"/> attribute is intended
1158	specifically for this purpose and allows to represent a chain of errors
1159	through a single IVirtualBoxErrorInfo object set after method invocation.
1160
1161	Note that errors are stored to a chain in the reverse order, i.e. the
1162	initial error object you query right after method invocation is the last
1163	error set by the callee, the object it points to in the @a next attribute
1164	is the previous error and so on, up to the first error (which is the last
1165	in the chain).
1166	</desc>
1167
1168	<attribute name="resultCode" type="long" readonly="yes">
1169	<desc>
1170	Result code of the error.
1171	Usually, it will be the same as the result code returned
1172	by the method that provided this error information, but not
1173	always. For example, on Win32, CoCreateInstance() will most
1174	likely return E_NOINTERFACE upon unsuccessful component
1175	instantiation attempt, but not the value the component factory
1176	returned. Value is typed 'long', not 'result',
1177	to make interface usable from scripting languages.
1178	<note>
1179	In MS COM, there is no equivalent.
1180	In XPCOM, it is the same as nsIException::result.
1181	</note>
1182	</desc>
1183	</attribute>
1184
1185	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1186	<desc>
1187	UUID of the interface that defined the error.
1188	<note>
1189	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1190	data type.
1191	In XPCOM, there is no equivalent.
1192	</note>
1193	</desc>
1194	</attribute>
1195
1196	<attribute name="component" type="wstring" readonly="yes">
1197	<desc>
1198	Name of the component that generated the error.
1199	<note>
1200	In MS COM, it is the same as IErrorInfo::GetSource.
1201	In XPCOM, there is no equivalent.
1202	</note>
1203	</desc>
1204	</attribute>
1205
1206	<attribute name="text" type="wstring" readonly="yes">
1207	<desc>
1208	Text description of the error.
1209	<note>
1210	In MS COM, it is the same as IErrorInfo::GetDescription.
1211	In XPCOM, it is the same as nsIException::message.
1212	</note>
1213	</desc>
1214	</attribute>
1215
1216	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1217	<desc>
1218	Next error object if there is any, or @c null otherwise.
1219	<note>
1220	In MS COM, there is no equivalent.
1221	In XPCOM, it is the same as nsIException::inner.
1222	</note>
1223	</desc>
1224	</attribute>
1225
1226	</interface>
1227
1228	<interface
1229	name="ILocalOwner" extends="$dispatched"
1230	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1231	>
1232	<desc>
1233	The ILocalOwner interface allows to register local objects
1234	(created without COM calls, but with new()).
1235	Once registered, calls to methods of such objects can be made
1236	from remote COM processes.
1237	The main usecase is the event callback implementation where
1238	API clients provide callback objects.
1239	</desc>
1240	<method name="setLocalObject">
1241	<desc>
1242	Set local object.
1243	</desc>
1244	<param name="object" type="$unknown" dir="in">
1245	<desc>Local object to forward requests to.
1246	If null, clears currently set local object.</desc>
1247	</param>
1248	</method>
1249	</interface>
1250
1251	<!--
1252	// IVirtualBox
1253	/////////////////////////////////////////////////////////////////////////
1254	-->
1255
1256	<interface
1257	name="IVirtualBoxCallback" extends="$unknown"
1258	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1259	wsmap="suppress"
1260	>
1261
1262	<method name="onMachineStateChange">
1263	<desc>
1264	The execution state of the given machine has changed.
1265	<see>IMachine::state</see>
1266	</desc>
1267	<param name="machineId" type="uuid" mod="string" dir="in">
1268	<desc>ID of the machine this event relates to.</desc>
1269	</param>
1270	<param name="state" type="MachineState" dir="in">
1271	<desc>New execution state.</desc>
1272	</param>
1273	</method>
1274
1275	<method name="onMachineDataChange">
1276	<desc>
1277	Any of the settings of the given machine has changed.
1278	</desc>
1279	<param name="machineId" type="uuid" mod="string" dir="in">
1280	<desc>ID of the machine this event relates to.</desc>
1281	</param>
1282	</method>
1283
1284	<method name="onExtraDataCanChange">
1285	<desc>
1286	Notification when someone tries to change extra data for
1287	either the given machine or (if @c null) global extra data.
1288	This gives the chance to veto against changes.
1289	</desc>
1290	<param name="machineId" type="uuid" mod="string" dir="in">
1291	<desc>
1292	ID of the machine this event relates to
1293	(@c null ID for global extra data change requests).
1294	</desc>
1295	</param>
1296	<param name="key" type="wstring" dir="in">
1297	<desc>
1298	Extra data key for the attempted write.
1299	</desc>
1300	</param>
1301	<param name="value" type="wstring" dir="in">
1302	<desc>
1303	Extra data value for the given key.
1304	</desc>
1305	</param>
1306	<param name="error" type="wstring" dir="out">
1307	<desc>
1308	Optional error message describing the reason of the
1309	veto (ignored if this notification returns @c true).
1310	</desc>
1311	</param>
1312	<param name="allowChange" type="boolean" dir="return">
1313	<desc>
1314	Flag to indicate whether the callee agrees (@c true)
1315	or vetoes against the change (@c false).
1316	</desc>
1317	</param>
1318	</method>
1319
1320	<method name="onExtraDataChange">
1321	<desc>
1322	Notification when machine specific or global extra data
1323	has changed.
1324	</desc>
1325	<param name="machineId" type="uuid" mod="string" dir="in">
1326	<desc>
1327	ID of the machine this event relates to.
1328	Null for global extra data changes.
1329	</desc>
1330	</param>
1331	<param name="key" type="wstring" dir="in">
1332	<desc>
1333	Extra data key that has changed.
1334	</desc>
1335	</param>
1336	<param name="value" type="wstring" dir="in">
1337	<desc>
1338	Extra data value for the given key.
1339	</desc>
1340	</param>
1341	</method>
1342
1343	<method name="onMediumRegistered">
1344	<desc>
1345	The given medium was registered or unregistered
1346	within this VirtualBox installation.
1347
1348	The @a mediumType parameter describes what type of
1349	medium the specified @a mediumId refers to. Possible
1350	values are:
1351
1352	<ul>
1353	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1354	that, if registered, can be obtained using the
1355	<link to="IVirtualBox::getHardDisk"/> call.</li>
1356	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1357	that, if registered, can be obtained using the
1358	<link to="IVirtualBox::getDVDImage"/> call.</li>
1359	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1360	that, if registered, can be obtained using the
1361	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1362	</ul>
1363
1364	Note that if this is a deregistration notification,
1365	there is no way to access the object representing the
1366	unregistered medium. It is supposed that the
1367	application will do required cleanup based on the
1368	@a mediumId value.
1369	</desc>
1370	<param name="mediumId" type="uuid" mod="string" dir="in">
1371	<desc>ID of the medium this event relates to.</desc>
1372	</param>
1373	<param name="mediumType" type="DeviceType" dir="in">
1374	<desc>Type of the medium this event relates to.</desc>
1375	</param>
1376	<param name="registered" type="boolean" dir="in">
1377	<desc>
1378	If @c true, the medium was registered, otherwise it was
1379	unregistered.
1380	</desc>
1381	</param>
1382	</method>
1383
1384	<method name="onMachineRegistered">
1385	<desc>
1386	The given machine was registered or unregistered
1387	within this VirtualBox installation.
1388	</desc>
1389	<param name="machineId" type="uuid" mod="string" dir="in">
1390	<desc>ID of the machine this event relates to.</desc>
1391	</param>
1392	<param name="registered" type="boolean" dir="in">
1393	<desc>
1394	If @c true, the machine was registered, otherwise it was
1395	unregistered.
1396	</desc>
1397	</param>
1398	</method>
1399
1400	<method name="onSessionStateChange">
1401	<desc>
1402	The state of the session for the given machine was changed.
1403	<see>IMachine::sessionState</see>
1404	</desc>
1405	<param name="machineId" type="uuid" mod="string" dir="in">
1406	<desc>ID of the machine this event relates to.</desc>
1407	</param>
1408	<param name="state" type="SessionState" dir="in">
1409	<desc>New session state.</desc>
1410	</param>
1411	</method>
1412
1413	<method name="onSnapshotTaken">
1414	<desc>
1415	A new snapshot of the machine has been taken.
1416	<see>ISnapshot</see>
1417	</desc>
1418	<param name="machineId" type="uuid" mod="string" dir="in">
1419	<desc>ID of the machine this event relates to.</desc>
1420	</param>
1421	<param name="snapshotId" type="uuid" mod="string" dir="in">
1422	<desc>ID of the new snapshot.</desc>
1423	</param>
1424	</method>
1425
1426	<method name="onSnapshotDiscarded">
1427	<desc>
1428	Snapshot of the given machine has been discarded.
1429
1430	<note>
1431	This notification is delivered <b>after</b> the snapshot
1432	object has been uninitialized on the server (so that any
1433	attempt to call its methods will return an error).
1434	</note>
1435
1436	<see>ISnapshot</see>
1437	</desc>
1438	<param name="machineId" type="uuid" mod="string" dir="in">
1439	<desc>ID of the machine this event relates to.</desc>
1440	</param>
1441	<param name="snapshotId" type="uuid" mod="string" dir="in">
1442	<desc>
1443	ID of the discarded snapshot. @c null means the current machine
1444	state has been discarded (restored from the current snapshot).
1445	</desc>
1446	</param>
1447	</method>
1448
1449	<method name="onSnapshotChange">
1450	<desc>
1451	Snapshot properties (name and/or description) have been changed.
1452	<see>ISnapshot</see>
1453	</desc>
1454	<param name="machineId" type="uuid" mod="string" dir="in">
1455	<desc>ID of the machine this event relates to.</desc>
1456	</param>
1457	<param name="snapshotId" type="uuid" mod="string" dir="in">
1458	<desc>ID of the changed snapshot.</desc>
1459	</param>
1460	</method>
1461
1462	<method name="onGuestPropertyChange">
1463	<desc>
1464	Notification when a guest property has changed.
1465	</desc>
1466	<param name="machineId" type="uuid" mod="string" dir="in">
1467	<desc>
1468	ID of the machine this event relates to.
1469	</desc>
1470	</param>
1471	<param name="name" type="wstring" dir="in">
1472	<desc>
1473	The name of the property that has changed.
1474	</desc>
1475	</param>
1476	<param name="value" type="wstring" dir="in">
1477	<desc>
1478	The new property value.
1479	</desc>
1480	</param>
1481	<param name="flags" type="wstring" dir="in">
1482	<desc>
1483	The new property flags.
1484	</desc>
1485	</param>
1486	</method>
1487
1488	</interface>
1489
1490	<interface
1491	name="IDHCPServer" extends="$unknown"
1492	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1493	wsmap="managed"
1494	>
1495	<desc>
1496	The IDHCPServer interface represents the vbox dhcp server configuration.
1497
1498	To enumerate all the dhcp servers on the host, use the
1499	<link to="IVirtualBox::DHCPServers"/> attribute.
1500	</desc>
1501
1502	<attribute name="enabled" type="boolean">
1503	<desc>
1504	specifies if the dhcp server is enabled
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="IPAddress" type="wstring" readonly="yes">
1509	<desc>
1510	specifies server IP
1511	</desc>
1512	</attribute>
1513
1514	<attribute name="networkMask" type="wstring" readonly="yes">
1515	<desc>
1516	specifies server network mask
1517	</desc>
1518	</attribute>
1519
1520	<attribute name="networkName" type="wstring" readonly="yes">
1521	<desc>
1522	specifies internal network name the server is used for
1523	</desc>
1524	</attribute>
1525
1526	<attribute name="lowerIP" type="wstring" readonly="yes">
1527	<desc>
1528	specifies from IP adrres in server address range
1529	</desc>
1530	</attribute>
1531
1532	<attribute name="upperIP" type="wstring" readonly="yes">
1533	<desc>
1534	specifies to IP adrres in server address range
1535	</desc>
1536	</attribute>
1537
1538	<method name="setConfiguration">
1539	<desc>
1540	configures the server
1541	<result name="E_INVALIDARG">
1542	invalid configuration supplied
1543	</result>
1544	</desc>
1545	<param name="IPAddress" type="wstring" dir="in">
1546	<desc>
1547	server IP address
1548	</desc>
1549	</param>
1550	<param name="networkMask" type="wstring" dir="in">
1551	<desc>
1552	server network mask
1553	</desc>
1554	</param>
1555	<param name="FromIPAddress" type="wstring" dir="in">
1556	<desc>
1557	server From IP address for address range
1558	</desc>
1559	</param>
1560	<param name="ToIPAddress" type="wstring" dir="in">
1561	<desc>
1562	server To IP address for address range
1563	</desc>
1564	</param>
1565	</method>
1566
1567	<method name="start">
1568	<desc>
1569	Starts DHCP server process.
1570	<result name="E_FAIL">
1571	Failed to start the process.
1572	</result>
1573	</desc>
1574	<param name="networkName" type="wstring" dir="in">
1575	<desc>
1576	Name of internal network DHCP server should attach to.
1577	</desc>
1578	</param>
1579	<param name="trunkName" type="wstring" dir="in">
1580	<desc>
1581	Name of internal network trunk.
1582	</desc>
1583	</param>
1584	<param name="trunkType" type="wstring" dir="in">
1585	<desc>
1586	Type of internal network trunk.
1587	</desc>
1588	</param>
1589	</method>
1590
1591	<method name="stop">
1592	<desc>
1593	Stops DHCP server process.
1594	<result name="E_FAIL">
1595	Failed to stop the process.
1596	</result>
1597	</desc>
1598	</method>
1599	</interface>
1600
1601	<interface
1602	name="IVirtualBox" extends="$dispatched"
1603	uuid="2158464a-f706-414b-a8c4-fb589dfc6b62"
1604	wsmap="managed"
1605	>
1606	<desc>
1607	The IVirtualBox interface represents the main interface exposed by the
1608	product that provides virtual machine management.
1609
1610	An instance of IVirtualBox is required for the product to do anything
1611	useful. Even though the interface does not expose this, internally,
1612	IVirtualBox is implemented as a singleton and actually lives in the
1613	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1614	IVirtualBox can track the state of all virtual machines on a particular
1615	host, regardless of which frontend started them.
1616
1617	To enumerate all the virtual machines on the host, use the
1618	<link to="IVirtualBox::machines"/> attribute.
1619	</desc>
1620
1621	<attribute name="version" type="wstring" readonly="yes">
1622	<desc>
1623	A string representing the version number of the product. The
1624	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1625	last number represents the build number and will frequently change.
1626	</desc>
1627	</attribute>
1628
1629	<attribute name="revision" type="unsigned long" readonly="yes">
1630	<desc>
1631	The internal build revision number of the product.
1632	</desc>
1633	</attribute>
1634
1635	<attribute name="packageType" type="wstring" readonly="yes">
1636	<desc>
1637	A string representing the package type of this product. The
1638	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1639	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1640	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1641	this.
1642	</desc>
1643	</attribute>
1644
1645	<attribute name="homeFolder" type="wstring" readonly="yes">
1646	<desc>
1647	Full path to the directory where the global settings file,
1648	<tt>VirtualBox.xml</tt>, is stored.
1649
1650	In this version of VirtualBox, the value of this property is
1651	always <tt><user_dir>/.VirtualBox</tt> (where
1652	<tt><user_dir></tt> is the path to the user directory,
1653	as determined by the host OS), and cannot be changed.
1654
1655	This path is also used as the base to resolve relative paths in
1656	places where relative paths are allowed (unless otherwise
1657	expressly indicated).
1658	</desc>
1659	</attribute>
1660
1661	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1662	<desc>
1663	Full name of the global settings file.
1664	The value of this property corresponds to the value of
1665	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1666	</desc>
1667	</attribute>
1668
1669	<attribute name="host" type="IHost" readonly="yes">
1670	<desc>Associated host object.</desc>
1671	</attribute>
1672
1673	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1674	<desc>Associated system information object.</desc>
1675	</attribute>
1676
1677	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1678	<desc>
1679	Array of machine objects registered within this VirtualBox instance.
1680	</desc>
1681	</attribute>
1682
1683	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1684	<desc>
1685	Array of medium objects known to this VirtualBox installation.
1686
1687	This array contains only base media. All differencing
1688	media of the given base medium can be enumerated using
1689	<link to="IMedium::children"/>.
1690	</desc>
1691	</attribute>
1692
1693	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1694	<desc>
1695	Array of CD/DVD image objects registered with this VirtualBox instance.
1696	</desc>
1697	</attribute>
1698
1699	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1700	<desc>
1701	Array of floppy image objects registered with this VirtualBox instance.
1702	</desc>
1703	</attribute>
1704
1705	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1706
1707	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1708
1709	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1710	<desc>
1711	Collection of global shared folders. Global shared folders are
1712	available to all virtual machines.
1713
1714	New shared folders are added to the collection using
1715	<link to="#createSharedFolder"/>. Existing shared folders can be
1716	removed using <link to="#removeSharedFolder"/>.
1717
1718	<note>
1719	In the current version of the product, global shared folders are not
1720	implemented and therefore this collection is always empty.
1721	</note>
1722	</desc>
1723	</attribute>
1724
1725	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1726	<desc>
1727	Associated performance collector object.
1728	</desc>
1729	</attribute>
1730
1731	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1732	<desc>
1733	dhcp server settings.
1734	</desc>
1735	</attribute>
1736
1737	<method name="createMachine">
1738	<desc>
1739	Creates a new virtual machine.
1740
1741	The new machine is created unregistered, with the initial configuration
1742	set according to the specified guest OS type. A typical sequence of
1743	actions to create a new virtual machine is as follows:
1744
1745	<ol>
1746	<li>
1747	Call this method to have a new machine created. The returned machine
1748	object will be "mutable" allowing to change any machine property.
1749	</li>
1750
1751	<li>
1752	Configure the machine using the appropriate attributes and methods.
1753	</li>
1754
1755	<li>
1756	Call <link to="IMachine::saveSettings" /> to write the settings
1757	to the machine's XML settings file. The configuration of the newly
1758	created machine will not be saved to disk until this method is
1759	called.
1760	</li>
1761
1762	<li>
1763	Call <link to="#registerMachine" /> to add the machine to the list
1764	of machines known to VirtualBox.
1765	</li>
1766	</ol>
1767
1768	You should specify valid name for the newly created machine when calling
1769	this method. See the <link to="IMachine::name"/> attribute description
1770	for more details about the machine name.
1771
1772	The specified guest OS type identifier must match an ID of one of known
1773	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1774	array.
1775
1776	Every machine has a <i>settings file</i> that is used to store
1777	the machine configuration. This file is stored in a directory called the
1778	<i>machine settings subfolder</i>. Both the settings subfolder and file
1779	will have a name that corresponds to the name of the virtual machine.
1780	You can specify where to create the machine setting subfolder using the
1781	@a baseFolder argument. The base folder can be absolute (full path) or
1782	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1783	directory</link>.
1784
1785	If @a baseFolder is a @c null or empty string (which is recommended), the
1786	<link to="ISystemProperties::defaultMachineFolder">default machine
1787	settings folder</link> will be used as a base folder for the created
1788	machine. Otherwise the given base folder will be used. In either case,
1789	the full path to the resulting settings file has the following
1790	structure:
1791	<pre>
1792	<base_folder>/<machine_name>/<machine_name>.xml
1793	</pre>
1794
1795	Note that if the resulting settings file already exists, this method
1796	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1797
1798	Optionally, you may specify an UUID of to assign to the created machine.
1799	However, this is not recommended and you should normally pass an empty
1800	(@c null) UUID to this method so that a new UUID will be automatically
1801	generated for every created machine. You can use UUID
1802	00000000-0000-0000-0000-000000000000 as @c null value.
1803
1804	<note>
1805	There is no way to change the name of the settings file or
1806	subfolder of the created machine directly.
1807	</note>
1808
1809	<result name="VBOX_E_OBJECT_NOT_FOUND">
1810	@a osTypeId is invalid.
1811	</result>
1812	<result name="VBOX_E_FILE_ERROR">
1813	Resulting settings file name is invalid or the settings file already
1814	exists or could not be created due to an I/O error.
1815	</result>
1816	<result name="E_INVALIDARG">
1817	@a name is empty or @c null.
1818	</result>
1819	</desc>
1820
1821	<param name="name" type="wstring" dir="in">
1822	<desc>Machine name.</desc>
1823	</param>
1824	<param name="osTypeId" type="wstring" dir="in">
1825	<desc>Guest OS Type ID.</desc>
1826	</param>
1827	<param name="baseFolder" type="wstring" dir="in">
1828	<desc>Base machine folder (optional).</desc>
1829	</param>
1830	<param name="id" type="uuid" mod="string" dir="in">
1831	<desc>Machine UUID (optional).</desc>
1832	</param>
1833	<param name="machine" type="IMachine" dir="return">
1834	<desc>Created machine object.</desc>
1835	</param>
1836	</method>
1837
1838	<method name="createLegacyMachine">
1839	<desc>
1840	Creates a new virtual machine in "legacy" mode, using the specified
1841	settings file to store machine settings.
1842
1843	As opposed to machines created by <link to="#createMachine"/>,
1844	the settings file of the machine created in "legacy" mode is not
1845	automatically renamed when the machine name is changed -- it will always
1846	remain the same as specified in this method call.
1847
1848	The specified settings file name can be absolute (full path) or relative
1849	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1850	directory</link>. If the file name doesn't contain an extension, the
1851	default extension (.xml) will be appended.
1852
1853	Note that the configuration of the newly created machine is not
1854	saved to disk (and therefore no settings file is created)
1855	until <link to="IMachine::saveSettings"/> is called. If the
1856	specified settings file already exists, this method
1857	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1858
1859	See <link to="#createMachine"/> for more information.
1860
1861	@deprecated This method may be removed later. Use <link
1862	to="IVirtualBox::createMachine"/> instead.
1863
1864	<note>
1865	There is no way to change the name of the settings file
1866	of the machine created in "legacy" mode.
1867	</note>
1868
1869	<result name="VBOX_E_OBJECT_NOT_FOUND">
1870	@a osTypeId is invalid.
1871	</result>
1872	<result name="VBOX_E_FILE_ERROR">
1873	@a settingsFile is invalid or the settings file already exists or
1874	could not be created due to an I/O error.
1875	</result>
1876	<result name="E_INVALIDARG">
1877	@a name or @a settingsFile is empty or @c null.
1878	</result>
1879	</desc>
1880
1881	<param name="name" type="wstring" dir="in">
1882	<desc>Machine name.</desc>
1883	</param>
1884	<param name="osTypeId" type="wstring" dir="in">
1885	<desc>Machine OS Type ID.</desc>
1886	</param>
1887	<param name="settingsFile" type="wstring" dir="in">
1888	<desc>Name of the machine settings file.</desc>
1889	</param>
1890	<param name="id" type="uuid" mod="string" dir="in">
1891	<desc>Machine UUID (optional).</desc>
1892	</param>
1893	<param name="machine" type="IMachine" dir="return">
1894	<desc>Created machine object.</desc>
1895	</param>
1896	</method>
1897
1898	<method name="openMachine">
1899	<desc>
1900	Opens a virtual machine from the existing settings file.
1901	The opened machine remains unregistered until you call
1902	<link to="#registerMachine"/>.
1903
1904	The specified settings file name can be absolute
1905	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1906	VirtualBox home directory</link>. This file must exist
1907	and must be a valid machine settings file whose contents
1908	will be used to construct the machine object.
1909
1910	@deprecated Will be removed soon.
1911	<result name="VBOX_E_FILE_ERROR">
1912	Settings file name invalid, not found or sharing violation.
1913	</result>
1914	</desc>
1915	<param name="settingsFile" type="wstring" dir="in">
1916	<desc>
1917	Name of the machine settings file.
1918	</desc>
1919	</param>
1920	<param name="machine" type="IMachine" dir="return">
1921	<desc>Opened machine object.</desc>
1922	</param>
1923	<note>
1924	<link to="IMachine::settingsModified"/> will return
1925	@c false for the created machine, until any of machine settings
1926	are changed.
1927	</note>
1928	</method>
1929
1930	<method name="registerMachine">
1931	<desc>
1932
1933	Registers the machine previously created using
1934	<link to="#createMachine"/> or opened using
1935	<link to="#openMachine"/> within this VirtualBox installation. After
1936	successful method invocation, the
1937	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1938	to all registered callbacks.
1939
1940	<note>
1941	This method implicitly calls <link to="IMachine::saveSettings"/>
1942	to save all current machine settings before registering it.
1943	</note>
1944
1945	<result name="VBOX_E_OBJECT_NOT_FOUND">
1946	No matching virtual machine found.
1947	</result>
1948	<result name="VBOX_E_INVALID_OBJECT_STATE">
1949	Virtual machine was not created within this VirtualBox instance.
1950	</result>
1951
1952	</desc>
1953	<param name="machine" type="IMachine" dir="in"/>
1954	</method>
1955
1956	<method name="getMachine">
1957	<desc>
1958	Attempts to find a virtual machine given its UUID.
1959	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1960	instead.
1961
1962	<result name="VBOX_E_OBJECT_NOT_FOUND">
1963	Could not find registered machine matching @a id.
1964	</result>
1965
1966	</desc>
1967	<param name="id" type="uuid" mod="string" dir="in"/>
1968	<param name="machine" type="IMachine" dir="return"/>
1969	</method>
1970
1971	<method name="findMachine">
1972	<desc>
1973	Attempts to find a virtual machine given its name.
1974	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1975	instead.
1976
1977	<result name="VBOX_E_OBJECT_NOT_FOUND">
1978	Could not find registered machine matching @a name.
1979	</result>
1980
1981	</desc>
1982	<param name="name" type="wstring" dir="in"/>
1983	<param name="machine" type="IMachine" dir="return"/>
1984	</method>
1985
1986	<method name="unregisterMachine">
1987	<desc>
1988
1989	Unregisters the machine previously registered using
1990	<link to="#registerMachine"/>. After successful method invocation, the
1991	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1992	to all registered callbacks.
1993
1994	<note>
1995	The specified machine must not be in the Saved state, have an open
1996	(or a spawning) direct session associated with it, have snapshots or
1997	have any medium attached.
1998	</note>
1999
2000	<note>
2001	This method implicitly calls <link to="IMachine::saveSettings"/> to
2002	save all current machine settings before unregistering it.
2003	</note>
2004
2005	<note>
2006	If the given machine is inaccessible (see
2007	<link to="IMachine::accessible"/>), it will be unregistered and
2008	fully uninitialized right afterwards. As a result, the returned
2009	machine object will be unusable and an attempt to call
2010	<b>any</b> method will return the "Object not ready" error.
2011	</note>
2012
2013	<result name="VBOX_E_OBJECT_NOT_FOUND">
2014	Could not find registered machine matching @a id.
2015	</result>
2016	<result name="VBOX_E_INVALID_VM_STATE">
2017	Machine is in Saved state.
2018	</result>
2019	<result name="VBOX_E_INVALID_OBJECT_STATE">
2020	Machine has snapshot or open session or medium attached.
2021	</result>
2022
2023	</desc>
2024	<param name="id" type="uuid" mod="string" dir="in">
2025	<desc>UUID of the machine to unregister.</desc>
2026	</param>
2027	<param name="machine" type="IMachine" dir="return">
2028	<desc>Unregistered machine object.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="createAppliance">
2033	<desc>
2034	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2035	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2036	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2037	</desc>
2038	<param name="appliance" type="IAppliance" dir="return">
2039	<desc>New appliance.</desc>
2040	</param>
2041	</method>
2042
2043	<method name="createHardDisk">
2044	<desc>
2045	Creates a new base medium object that will use the given storage
2046	format and location for medium data.
2047
2048	Note that the actual storage unit is not created by this method. In
2049	order to do it, and before you are able to attach the created medium
2050	to virtual machines, you must call one of the following methods to
2051	allocate a format-specific storage unit at the specified location:
2052	<ul>
2053	<li><link to="IMedium::createBaseStorage"/></li>
2054	<li><link to="IMedium::createDiffStorage"/></li>
2055	</ul>
2056
2057	Some medium attributes, such as <link to="IMedium::id"/>, may
2058	remain uninitialized until the medium storage unit is successfully
2059	created by one of the above methods.
2060
2061	After the storage unit is successfully created, the medium gets
2062	remembered by this VirtualBox installation and will be accessible
2063	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2064	methods. Remembered base medium are also returned as part of
2065	the <link to="#hardDisks"/> array. See IMedium for more details.
2066
2067	The list of all storage formats supported by this VirtualBox
2068	installation can be obtained using
2069	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2070	attribute is empty or @c null then the default storage format
2071	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2072	be used for creating a storage unit of the medium.
2073
2074	Note that the format of the location string is storage format specific.
2075	See <link to="IMedium::location"/>, IMedium and
2076	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2077
2078	<result name="VBOX_E_OBJECT_NOT_FOUND">
2079	@a format identifier is invalid. See
2080	<link to="ISystemProperties::mediumFormats"/>.
2081	</result>
2082	<result name="VBOX_E_FILE_ERROR">
2083	@a location is a not valid file name (for file-based formats only).
2084	</result>
2085	</desc>
2086	<param name="format" type="wstring" dir="in">
2087	<desc>
2088	Identifier of the storage format to use for the new medium.
2089	</desc>
2090	</param>
2091	<param name="location" type="wstring" dir="in">
2092	<desc>
2093	Location of the storage unit for the new medium.
2094	</desc>
2095	</param>
2096	<param name="medium" type="IMedium" dir="return">
2097	<desc>Created medium object.</desc>
2098	</param>
2099	</method>
2100
2101	<method name="openHardDisk">
2102	<desc>
2103	Opens a medium from an existing location, optionally replacing
2104	the image UUID and/or parent UUID.
2105
2106	After the medium is successfully opened by this method, it gets
2107	remembered by (known to) this VirtualBox installation and will be
2108	accessible through <link to="#getHardDisk"/> and
2109	<link to="#findHardDisk"/> methods. Remembered base media
2110	are also returned as part of the <link to="#hardDisks"/> array and can
2111	be attached to virtual machines. See IMedium for more details.
2112
2113	If a differencing medium is to be opened by this method, the
2114	operation will succeed only if its parent medium and all ancestors,
2115	if any, are already known to this VirtualBox installation (for example,
2116	were opened by this method before).
2117
2118	This method tries to guess the storage format of the specified medium
2119	by reading medium data at the specified location.
2120
2121	If @a write is ReadWrite (which it should be), the image is opened for
2122	read/write access and must have according permissions, as VirtualBox
2123	may actually write status information into the disk's metadata sections.
2124
2125	Note that write access is required for all typical image usage in VirtualBox,
2126	since VirtualBox may need to write metadata such as a UUID into the image.
2127	The only exception is opening a source image temporarily for copying and
2128	cloning when the image will quickly be closed again.
2129
2130	Note that the format of the location string is storage format specific.
2131	See <link to="IMedium::location"/>, IMedium and
2132	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2133
2134	<result name="VBOX_E_FILE_ERROR">
2135	Invalid medium storage file location or could not find the medium
2136	at the specified location.
2137	</result>
2138	<result name="VBOX_E_IPRT_ERROR">
2139	Could not get medium storage format.
2140	</result>
2141	<result name="E_INVALIDARG">
2142	Invalid medium storage format.
2143	</result>
2144
2145	</desc>
2146	<param name="location" type="wstring" dir="in">
2147	<desc>
2148	Location of the storage unit that contains medium data in one of
2149	the supported storage formats.
2150	</desc>
2151	</param>
2152	<param name="accessMode" type="AccessMode" dir="in">
2153	<desc>
2154	Determines whether to open the image in read/write or read-only mode.
2155	</desc>
2156	</param>
2157	<param name="setImageId" type="boolean" dir="in">
2158	<desc>
2159	Select whether a new image UUID is set or not.
2160	</desc>
2161	</param>
2162	<param name="imageId" type="uuid" mod="string" dir="in">
2163	<desc>
2164	New UUID for the image. If an empty string is passed, then a new
2165	UUID is automatically created. Specifying a zero UUIDs is not valid.
2166	</desc>
2167	</param>
2168	<param name="setParentId" type="boolean" dir="in">
2169	<desc>
2170	Select whether a new parent UUID is set or not.
2171	</desc>
2172	</param>
2173	<param name="parentId" type="uuid" mod="string" dir="in">
2174	<desc>
2175	New parent UUID for the image. If an empty string is passed, then a
2176	new UUID is automatically created, provided @a setParentId is
2177	@c true. A zero UUID is valid.
2178	</desc>
2179	</param>
2180	<param name="medium" type="IMedium" dir="return">
2181	<desc>Opened medium object.</desc>
2182	</param>
2183	</method>
2184
2185	<method name="getHardDisk" const="yes">
2186	<desc>
2187	Returns a medium with the given UUID.
2188
2189	The medium with the given UUID must be known to this VirtualBox
2190	installation, i.e. it must be previously created by
2191	<link to="#createHardDisk"/> or opened by <link
2192	to="#openHardDisk"/>, or attached to some known virtual machine.
2193
2194	<result name="VBOX_E_OBJECT_NOT_FOUND">
2195	No medium object matching @a id found.
2196	</result>
2197
2198	</desc>
2199	<param name="id" type="uuid" mod="string" dir="in">
2200	<desc>UUID of the medium to look for.</desc>
2201	</param>
2202	<param name="medium" type="IMedium" dir="return">
2203	<desc>Found medium object.</desc>
2204	</param>
2205	</method>
2206
2207	<method name="findHardDisk">
2208	<desc>
2209	Returns a medium that uses the given location to store medium data.
2210
2211	The given medium must be known to this VirtualBox installation, i.e.
2212	it must be previously created by
2213	<link to="#createHardDisk"/> or opened by <link
2214	to="#openHardDisk"/>, or attached to some known virtual machine.
2215
2216	The search is done by comparing the value of the @a location argument to
2217	the <link to="IMedium::location"/> attribute of each known medium.
2218
2219	For locations represented by file names in the host's file system, the
2220	requested location can be a path relative to the
2221	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2222	only a file name without any path is given, the
2223	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2224	folder</link> will be prepended to the file name before searching. Note
2225	that on case sensitive file systems, a case sensitive comparison is
2226	performed, otherwise the case of symbols in the file path is ignored.
2227
2228	<result name="VBOX_E_OBJECT_NOT_FOUND">
2229	No medium object matching @a location found.
2230	</result>
2231
2232	</desc>
2233	<param name="location" type="wstring" dir="in">
2234	<desc>Location string to search for.</desc>
2235	</param>
2236	<param name="medium" type="IMedium" dir="return">
2237	<desc>Found medium object.</desc>
2238	</param>
2239	</method>
2240
2241	<method name="openDVDImage">
2242	<desc>
2243	Opens a CD/DVD image contained in the specified file of the supported
2244	format and assigns it the given UUID.
2245
2246	After the image is successfully opened by this method, it gets
2247	remembered by (known to) this VirtualBox installation and will be
2248	accessible through <link to="#getDVDImage"/> and
2249	<link to="#findDVDImage"/> methods. Remembered images are also
2250	returned as part of the <link to="#DVDImages"/> array and can be mounted
2251	to virtual machines. See IMedium for more details.
2252
2253	See <link to="IMedium::location"/> to get more details about the format
2254	of the location string.
2255
2256	<note>
2257	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2258	</note>
2259
2260	<result name="VBOX_E_FILE_ERROR">
2261	Invalid CD/DVD image file location or could not find the CD/DVD
2262	image at the specified location.
2263	</result>
2264	<result name="VBOX_E_INVALID_OBJECT_STATE">
2265	CD/DVD image already exists in the media registry.
2266	</result>
2267
2268	</desc>
2269	<param name="location" type="wstring" dir="in">
2270	<desc>
2271	Full path to the file that contains a valid CD/DVD image.
2272	</desc>
2273	</param>
2274	<param name="id" type="uuid" mod="string" dir="in">
2275	<desc>
2276	UUID to assign to the given image within this VirtualBox installation.
2277	If an empty (@c null) UUID is specified, the system will randomly
2278	generate a new UUID.
2279	</desc>
2280	</param>
2281	<param name="image" type="IMedium" dir="return">
2282	<desc>Opened CD/DVD image object.</desc>
2283	</param>
2284	</method>
2285
2286	<method name="getDVDImage">
2287	<desc>
2288	Returns a CD/DVD image with the given UUID.
2289
2290	The image with the given UUID must be known to this VirtualBox
2291	installation, i.e. it must be previously opened by <link
2292	to="#openDVDImage"/>, or mounted to some known virtual machine.
2293
2294	<result name="VBOX_E_OBJECT_NOT_FOUND">
2295	No matching DVD image found in the media registry.
2296	</result>
2297
2298	</desc>
2299	<param name="id" type="uuid" mod="string" dir="in">
2300	<desc>UUID of the image to look for.</desc>
2301	</param>
2302	<param name="image" type="IMedium" dir="return">
2303	<desc>Found CD/DVD image object.</desc>
2304	</param>
2305	</method>
2306
2307	<method name="findDVDImage">
2308	<desc>
2309	Returns a CD/DVD image with the given image location.
2310
2311	The image with the given UUID must be known to this VirtualBox
2312	installation, i.e. it must be previously opened by <link
2313	to="#openDVDImage"/>, or mounted to some known virtual machine.
2314
2315	The search is done by comparing the value of the @a location argument to
2316	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2317
2318	The requested location can be a path relative to the
2319	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2320	only a file name without any path is given, the
2321	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2322	folder</link> will be prepended to the file name before searching. Note
2323	that on case sensitive file systems, a case sensitive comparison is
2324	performed, otherwise the case in the file path is ignored.
2325
2326	<result name="VBOX_E_FILE_ERROR">
2327	Invalid image file location.
2328	</result>
2329	<result name="VBOX_E_OBJECT_NOT_FOUND">
2330	No matching DVD image found in the media registry.
2331	</result>
2332
2333	</desc>
2334	<param name="location" type="wstring" dir="in">
2335	<desc>CD/DVD image file path to look for.</desc>
2336	</param>
2337	<param name="image" type="IMedium" dir="return">
2338	<desc>Found CD/DVD image object.</desc>
2339	</param>
2340	</method>
2341
2342	<method name="openFloppyImage">
2343	<desc>
2344	Opens a floppy image contained in the specified file of the supported
2345	format and assigns it the given UUID.
2346
2347	After the image is successfully opened by this method, it gets
2348	remembered by (known to) this VirtualBox installation and will be
2349	accessible through <link to="#getFloppyImage"/> and
2350	<link to="#findFloppyImage"/> methods. Remembered images are also
2351	returned as part of the <link to="#floppyImages"/> array and can be
2352	mounted to virtual machines. See IMedium for more details.
2353
2354	See <link to="IMedium::location"/> to get more details about the format
2355	of the location string.
2356
2357	<result name="VBOX_E_FILE_ERROR">
2358	Invalid floppy image file location or could not find the floppy
2359	image at the specified location.
2360	</result>
2361	<result name="VBOX_E_INVALID_OBJECT_STATE">
2362	Floppy image already exists in the media registry.
2363	</result>
2364
2365	<note>
2366	Currently, only raw floppy images are supported by VirtualBox.
2367	</note>
2368	</desc>
2369	<param name="location" type="wstring" dir="in">
2370	<desc>
2371	Full path to the file that contains a valid floppy image.
2372	</desc>
2373	</param>
2374	<param name="id" type="uuid" mod="string" dir="in">
2375	<desc>
2376	UUID to assign to the given image file within this VirtualBox
2377	installation. If an empty (@c null) UUID is specified, the system will
2378	randomly generate a new UUID.
2379	</desc>
2380	</param>
2381	<param name="image" type="IMedium" dir="return">
2382	<desc>Opened floppy image object.</desc>
2383	</param>
2384	</method>
2385
2386	<method name="getFloppyImage">
2387	<desc>
2388	Returns a floppy image with the given UUID.
2389
2390	The image with the given UUID must be known to this VirtualBox
2391	installation, i.e. it must be previously opened by <link
2392	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2393
2394	<result name="VBOX_E_OBJECT_NOT_FOUND">
2395	No matching floppy image found in the media registry.
2396	</result>
2397
2398	</desc>
2399	<param name="id" type="uuid" mod="string" dir="in">
2400	<desc>UUID of the image to look for.</desc>
2401	</param>
2402	<param name="image" type="IMedium" dir="return">
2403	<desc>Found floppy image object.</desc>
2404	</param>
2405	</method>
2406
2407	<method name="findFloppyImage">
2408	<desc>
2409	Returns a floppy image with the given image location.
2410
2411	The image with the given UUID must be known to this VirtualBox
2412	installation, i.e. it must be previously opened by <link
2413	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2414
2415	The search is done by comparing the value of the @a location argument to
2416	the <link to="IMedium::location"/> attribute of each known floppy image.
2417
2418	The requested location can be a path relative to the
2419	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2420	only a file name without any path is given, the
2421	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2422	folder</link> will be prepended to the file name before searching. Note
2423	that on case sensitive file systems, a case sensitive comparison is
2424	performed, otherwise the case of symbols in the file path is ignored.
2425
2426	<result name="VBOX_E_FILE_ERROR">
2427	Invalid image file location.
2428	</result>
2429	<result name="VBOX_E_OBJECT_NOT_FOUND">
2430	No matching floppy image found in the media registry.
2431	</result>
2432
2433	</desc>
2434	<param name="location" type="wstring" dir="in">
2435	<desc>Floppy image file path to look for.</desc>
2436	</param>
2437	<param name="image" type="IMedium" dir="return">
2438	<desc>Found floppy image object.</desc>
2439	</param>
2440	</method>
2441
2442	<method name="getGuestOSType">
2443	<desc>
2444	Returns an object describing the specified guest OS type.
2445
2446	The requested guest OS type is specified using a string which is a
2447	mnemonic identifier of the guest operating system, such as
2448	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2449	particular virtual machine can be read or set using the
2450	<link to="IMachine::OSTypeId"/> attribute.
2451
2452	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2453	available guest OS type objects. Each object has an
2454	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2455	the guest OS this object describes.
2456
2457	<result name="E_INVALIDARG">
2458	@a id is not a valid Guest OS type.
2459	</result>
2460
2461	</desc>
2462	<param name="id" type="uuid" mod="string" dir="in">
2463	<desc>Guest OS type ID string.</desc>
2464	</param>
2465	<param name="type" type="IGuestOSType" dir="return">
2466	<desc>Guest OS type object.</desc>
2467	</param>
2468	</method>
2469
2470	<method name="createSharedFolder">
2471	<desc>
2472	Creates a new global shared folder by associating the given logical
2473	name with the given host path, adds it to the collection of shared
2474	folders and starts sharing it. Refer to the description of
2475	<link to="ISharedFolder"/> to read more about logical names.
2476	<note>
2477	In the current implementation, this operation is not
2478	implemented.
2479	</note>
2480	</desc>
2481	<param name="name" type="wstring" dir="in">
2482	<desc>Unique logical name of the shared folder.</desc>
2483	</param>
2484	<param name="hostPath" type="wstring" dir="in">
2485	<desc>Full path to the shared folder in the host file system.</desc>
2486	</param>
2487	<param name="writable" type="boolean" dir="in">
2488	<desc>Whether the share is writable or readonly</desc>
2489	</param>
2490	</method>
2491
2492	<method name="removeSharedFolder">
2493	<desc>
2494	Removes the global shared folder with the given name previously
2495	created by <link to="#createSharedFolder"/> from the collection of
2496	shared folders and stops sharing it.
2497	<note>
2498	In the current implementation, this operation is not
2499	implemented.
2500	</note>
2501	</desc>
2502	<param name="name" type="wstring" dir="in">
2503	<desc>Logical name of the shared folder to remove.</desc>
2504	</param>
2505	</method>
2506
2507	<method name="getExtraDataKeys">
2508	<desc>
2509	Returns an array representing the global extra data keys which currently
2510	have values defined.
2511	</desc>
2512	<param name="value" type="wstring" dir="return" safearray="yes">
2513	<desc>Array of extra data keys.</desc>
2514	</param>
2515	</method>
2516
2517	<method name="getExtraData">
2518	<desc>
2519	Returns associated global extra data.
2520
2521	If the requested data @a key does not exist, this function will
2522	succeed and return an empty string in the @a value argument.
2523
2524	<result name="VBOX_E_FILE_ERROR">
2525	Settings file not accessible.
2526	</result>
2527	<result name="VBOX_E_XML_ERROR">
2528	Could not parse the settings file.
2529	</result>
2530
2531	</desc>
2532	<param name="key" type="wstring" dir="in">
2533	<desc>Name of the data key to get.</desc>
2534	</param>
2535	<param name="value" type="wstring" dir="return">
2536	<desc>Value of the requested data key.</desc>
2537	</param>
2538	</method>
2539
2540	<method name="setExtraData">
2541	<desc>
2542	Sets associated global extra data.
2543
2544	If you pass @c null or empty string as a key @a value, the given @a key
2545	will be deleted.
2546
2547	<note>
2548	Before performing the actual data change, this method will ask all
2549	registered callbacks using the
2550	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2551	notification for a permission. If one of the callbacks refuses the
2552	new value, the change will not be performed.
2553	</note>
2554	<note>
2555	On success, the
2556	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2557	is called to inform all registered callbacks about a successful data
2558	change.
2559	</note>
2560
2561	<result name="VBOX_E_FILE_ERROR">
2562	Settings file not accessible.
2563	</result>
2564	<result name="VBOX_E_XML_ERROR">
2565	Could not parse the settings file.
2566	</result>
2567	<result name="E_ACCESSDENIED">
2568	Modification request refused.
2569	</result>
2570
2571	</desc>
2572	<param name="key" type="wstring" dir="in">
2573	<desc>Name of the data key to set.</desc>
2574	</param>
2575	<param name="value" type="wstring" dir="in">
2576	<desc>Value to assign to the key.</desc>
2577	</param>
2578	</method>
2579
2580	<method name="openSession">
2581	<desc>
2582	Opens a new direct session with the given virtual machine.
2583
2584	A direct session acts as a local lock on the given VM.
2585	There can be only one direct session open at a time for every
2586	virtual machine, protecting the VM from being manipulated by
2587	conflicting actions from different processes. Only after a
2588	direct session has been opened, one can change all VM settings
2589	and execute the VM in the process space of the session object.
2590
2591	Sessions therefore can be compared to mutex semaphores that
2592	lock a given VM for modification and execution.
2593	See <link to="ISession">ISession</link> for details.
2594
2595	<note>Unless you are writing a new VM frontend, you will not
2596	want to execute a VM in the current process. To spawn a new
2597	process that executes a VM, use
2598	<link to="IVirtualBox::openRemoteSession" />
2599	instead.</note>
2600
2601	Upon successful return, the session object can be used to
2602	get access to the machine and to the VM console.
2603
2604	In VirtualBox terminology, the machine becomes "mutable" after
2605	a session has been opened. Note that the "mutable" machine
2606	object, on which you may invoke IMachine methods to change its
2607	settings, will be a different object from the immutable IMachine
2608	objects returned by various IVirtualBox methods. To obtain a
2609	mutable IMachine object (upon which you can invoke settings methods),
2610	use the <link to="ISession::machine" /> attribute.
2611
2612	One must always call <link to="ISession::close" /> to release the
2613	lock on the machine, or the machine's state will eventually be
2614	set to "Aborted".
2615
2616	In other words, to change settings on a machine, the following
2617	sequence is typically performed:
2618
2619	<ol>
2620	<li>Call this method (openSession) to have a machine locked for
2621	the current session.</li>
2622
2623	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2624
2625	<li>Change the settings of the machine.</li>
2626
2627	<li>Call <link to="IMachine::saveSettings" />.</li>
2628
2629	<li>Close the session by calling <link to="ISession::close"/>.</li>
2630	</ol>
2631
2632	<result name="E_UNEXPECTED">
2633	Virtual machine not registered.
2634	</result>
2635	<result name="E_ACCESSDENIED">
2636	Process not started by OpenRemoteSession.
2637	</result>
2638	<result name="VBOX_E_OBJECT_NOT_FOUND">
2639	No matching virtual machine found.
2640	</result>
2641	<result name="VBOX_E_INVALID_OBJECT_STATE">
2642	Session already open or being opened.
2643	</result>
2644	<result name="VBOX_E_VM_ERROR">
2645	Failed to assign machine to session.
2646	</result>
2647
2648	</desc>
2649	<param name="session" type="ISession" dir="in">
2650	<desc>
2651	Session object that will represent the opened session after
2652	successful method invocation. This object must not represent
2653	the already open session.
2654	<note>
2655	This session will be automatically closed if the
2656	VirtualBox server is terminated for some reason.
2657	</note>
2658	</desc>
2659	</param>
2660	<param name="machineId" type="uuid" mod="string" dir="in">
2661	<desc>ID of the virtual machine to open a session with.</desc>
2662	</param>
2663	</method>
2664
2665	<method name="openRemoteSession">
2666	<desc>
2667	Spawns a new process that executes a virtual machine (called a
2668	"remote session").
2669
2670	Opening a remote session causes the VirtualBox server to start a new
2671	process that opens a direct session with the given VM. As a result, the
2672	VM is locked by that direct session in the new process, preventing
2673	conflicting changes from other processes. Since sessions act as locks
2674	that prevent conflicting changes, one cannot open a remote session
2675	for a VM that already has another open session (direct or remote), or
2676	is currently in the process of opening one (see <link
2677	to="IMachine::sessionState"/>).
2678
2679	While the remote session still provides some level of control over the
2680	VM execution to the caller (using the <link to="IConsole" /> interface),
2681	not all VM settings are available for modification within the remote
2682	session context.
2683
2684	This operation can take some time (a new VM is started in a new process,
2685	for which memory and other resources need to be set up). Because of this,
2686	an <link to="IProgress" /> is returned to allow the caller to wait for this
2687	asynchronous operation to be completed. Until then, the remote session
2688	object remains in the closed state, and accessing the machine or its
2689	console through it is invalid. It is recommended to use
2690	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2691	completion.
2692
2693	As with all <link to="ISession" /> objects, it is recommended to call
2694	<link to="ISession::close" /> on the local session object once openRemoteSession()
2695	has been called. However, the session's state (see <link to="ISession::state" />)
2696	will not return to "Closed" until the remote session has also closed (i.e.
2697	until the VM is no longer running). In that case, however, the state of
2698	the session will automatically change back to "Closed".
2699
2700	Currently supported session types (values of the @a type
2701	argument) are:
2702	<ul>
2703	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2704	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2705	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2706	</ul>
2707
2708	The @a environment argument is a string containing definitions of
2709	environment variables in the following format:
2710	@code
2711	NAME[=VALUE]\n
2712	NAME[=VALUE]\n
2713	...
2714	@endcode
2715	where <tt>\\n</tt> is the new line character. These environment
2716	variables will be appended to the environment of the VirtualBox server
2717	process. If an environment variable exists both in the server process
2718	and in this list, the value from this list takes precedence over the
2719	server's variable. If the value of the environment variable is
2720	omitted, this variable will be removed from the resulting environment.
2721	If the environment string is @c null or empty, the server environment
2722	is inherited by the started process as is.
2723
2724	<see>openExistingSession</see>
2725
2726	<result name="E_UNEXPECTED">
2727	Virtual machine not registered.
2728	</result>
2729	<result name="E_INVALIDARG">
2730	Invalid session type @a type.
2731	</result>
2732	<result name="VBOX_E_OBJECT_NOT_FOUND">
2733	No machine matching @a machineId found.
2734	</result>
2735	<result name="VBOX_E_INVALID_OBJECT_STATE">
2736	Session already open or being opened.
2737	</result>
2738	<result name="VBOX_E_IPRT_ERROR">
2739	Launching process for machine failed.
2740	</result>
2741	<result name="VBOX_E_VM_ERROR">
2742	Failed to assign machine to session.
2743	</result>
2744
2745	</desc>
2746	<param name="session" type="ISession" dir="in">
2747	<desc>
2748	Session object that will represent the opened remote session
2749	after successful method invocation (this object must not
2750	represent an already open session).
2751	</desc>
2752	</param>
2753	<param name="machineId" type="uuid" mod="string" dir="in">
2754	<desc>ID of the virtual machine to open a session with.</desc>
2755	</param>
2756	<param name="type" type="wstring" dir="in">
2757	<desc>
2758	Type of the remote session (case sensitive).
2759	</desc>
2760	</param>
2761	<param name="environment" type="wstring" dir="in">
2762	<desc>
2763	Environment to pass to the opened session.
2764	</desc>
2765	</param>
2766	<param name="progress" type="IProgress" dir="return">
2767	<desc>Progress object to track the operation completion.</desc>
2768	</param>
2769	</method>
2770
2771	<method name="openExistingSession">
2772	<desc>
2773	Opens a new remote session with the virtual machine for
2774	which a direct session is already open.
2775
2776	The remote session provides some level of control over the VM
2777	execution (using the IConsole interface) to the caller; however,
2778	within the remote session context, not all VM settings are available
2779	for modification.
2780
2781	As opposed to <link to="#openRemoteSession"/>, the number of
2782	remote sessions opened this way is not limited by the API
2783
2784	<note>
2785	It is an error to open a remote session with the machine that
2786	doesn't have an open direct session.
2787	</note>
2788
2789	<result name="E_UNEXPECTED">
2790	Virtual machine not registered.
2791	</result>
2792	<result name="VBOX_E_OBJECT_NOT_FOUND">
2793	No machine matching @a machineId found.
2794	</result>
2795	<result name="VBOX_E_INVALID_OBJECT_STATE">
2796	Session already open or being opened.
2797	</result>
2798	<result name="VBOX_E_INVALID_SESSION_STATE">
2799	Direct session state not Open.
2800	</result>
2801	<result name="VBOX_E_VM_ERROR">
2802	Failed to get console object from direct session or assign
2803	machine to session.
2804	</result>
2805
2806	<see>openRemoteSession</see>
2807	</desc>
2808	<param name="session" type="ISession" dir="in">
2809	<desc>
2810	Session object that will represent the open remote session
2811	after successful method invocation. This object must not
2812	represent an already open session.
2813	<note>
2814	This session will be automatically closed when the peer
2815	(direct) session dies or gets closed.
2816	</note>
2817	</desc>
2818	</param>
2819	<param name="machineId" type="uuid" mod="string" dir="in">
2820	<desc>ID of the virtual machine to open a session with.</desc>
2821	</param>
2822	</method>
2823
2824	<method name="registerCallback">
2825	<desc>
2826	Registers a new global VirtualBox callback. The methods of the given
2827	callback object will be called by VirtualBox when an appropriate
2828	event occurs.
2829
2830	<result name="E_INVALIDARG">
2831	A @c null callback cannot be registered.
2832	</result>
2833
2834	</desc>
2835	<param name="callback" type="IVirtualBoxCallback" dir="in">
2836	<desc>Callback object to register.</desc>
2837	</param>
2838	</method>
2839
2840	<method name="unregisterCallback">
2841	<desc>
2842	Unregisters the previously registered global VirtualBox callback.
2843
2844	<result name="E_INVALIDARG">
2845	Specified @a callback not registered.
2846	</result>
2847
2848	</desc>
2849	<param name="callback" type="IVirtualBoxCallback" dir="in">
2850	<desc>Callback object to unregister.</desc>
2851	</param>
2852	</method>
2853
2854	<method name="waitForPropertyChange">
2855	<desc>
2856	Blocks the caller until any of the properties represented by the
2857	@a what argument changes the value or until the given timeout interval
2858	expires.
2859
2860	The @a what argument is a comma separated list of property masks that
2861	describe properties the caller is interested in. The property mask is
2862	a string in the following format:
2863
2864	<pre>
2865	[[group.]subgroup.]name
2866	</pre>
2867
2868	where @c name is the property name and @c group, @c subgroup are zero
2869	or more property group specifiers. Each element (group or name) in
2870	the property mask may be either a Latin string or an asterisk symbol
2871	(@c "*") which is used to match any string for the given element. A
2872	property mask that doesn't contain asterisk symbols represents a
2873	single fully qualified property name.
2874
2875	Groups in the fully qualified property name go from more generic (the
2876	left-most part) to more specific (the right-most part). The first
2877	element is usually a name of the object the property belongs to. The
2878	second element may be either a property name, or a child object name,
2879	or an index if the preceding element names an object which is one of
2880	many objects of the same type. This way, property names form a
2881	hierarchy of properties. Here are some examples of property names:
2882
2883	<table>
2884	<tr>
2885	<td><tt>VirtualBox.version</tt></td>
2886	<td><link to="IVirtualBox::version"/> property</td>
2887	</tr>
2888	<tr>
2889	<td><tt>Machine.<UUID>.name</tt></td>
2890	<td><link to="IMachine::name"/> property of the machine with the
2891	given UUID</td>
2892	</tr>
2893	</table>
2894
2895	Most property names directly correspond to the properties of objects
2896	(components) provided by the VirtualBox library and may be used to
2897	track changes to these properties. However, there may be
2898	pseudo-property names that don't correspond to any existing object's
2899	property directly, as well as there may be object properties that
2900	don't have a corresponding property name that is understood by this
2901	method, and therefore changes to such properties cannot be
2902	tracked. See individual object's property descriptions to get a
2903	fully qualified property name that can be used with this method (if
2904	any).
2905
2906	There is a special property mask @c "*" (i.e. a string consisting of a
2907	single asterisk symbol) that can be used to match all properties.
2908	Below are more examples of property masks:
2909
2910	<table>
2911	<tr>
2912	<td><tt>VirtualBox.*</tt></td>
2913	<td>Track all properties of the VirtualBox object</td>
2914	</tr>
2915	<tr>
2916	<td><tt>Machine.*.name</tt></td>
2917	<td>Track changes to the <link to="IMachine::name"/> property of
2918	all registered virtual machines</td>
2919	</tr>
2920	</table>
2921
2922	<note>
2923	This function is not implemented in the current version of the
2924	product.
2925	</note>
2926	</desc>
2927	<param name="what" type="wstring" dir="in">
2928	<desc>Comma separated list of property masks.</desc>
2929	</param>
2930	<param name="timeout" type="unsigned long" dir="in">
2931	<desc>
2932	Wait timeout in milliseconds.
2933	Specify -1 for an indefinite wait.
2934	</desc>
2935	</param>
2936	<param name="changed" type="wstring" dir="out">
2937	<desc>
2938	Comma separated list of properties that have been changed and caused
2939	this method to return to the caller.
2940	</desc>
2941	</param>
2942	<param name="values" type="wstring" dir="out">
2943	<desc>Reserved, not currently used.</desc>
2944	</param>
2945	</method>
2946
2947	<!--method name="createDHCPServerForInterface">
2948	<desc>
2949	Creates a dhcp server settings to be used for the given interface
2950	<result name="E_INVALIDARG">
2951	Host network interface @a name already exists.
2952	</result>
2953	</desc>
2954	<param name="interface" type="IHostNetworkInterface" dir="in">
2955	<desc>Network Interface</desc>
2956	</param>
2957	<param name="server" type="IDHCPServer" dir="out">
2958	<desc>Dhcp server settings</desc>
2959	</param>
2960	</method-->
2961
2962	<method name="createDHCPServer">
2963	<desc>
2964	Creates a dhcp server settings to be used for the given internal network name
2965	<result name="E_INVALIDARG">
2966	Host network interface @a name already exists.
2967	</result>
2968	</desc>
2969	<param name="name" type="wstring" dir="in">
2970	<desc>server name</desc>
2971	</param>
2972	<param name="server" type="IDHCPServer" dir="return">
2973	<desc>Dhcp server settings</desc>
2974	</param>
2975	</method>
2976
2977	<method name="findDHCPServerByNetworkName">
2978	<desc>
2979	Searches a dhcp server settings to be used for the given internal network name
2980	<result name="E_INVALIDARG">
2981	Host network interface @a name already exists.
2982	</result>
2983
2984	</desc>
2985	<param name="name" type="wstring" dir="in">
2986	<desc>server name</desc>
2987	</param>
2988	<param name="server" type="IDHCPServer" dir="return">
2989	<desc>Dhcp server settings</desc>
2990	</param>
2991	</method>
2992
2993	<!--method name="findDHCPServerForInterface">
2994	<desc>
2995	Searches a dhcp server settings to be used for the given interface
2996	<result name="E_INVALIDARG">
2997	Host network interface @a name already exists.
2998	</result>
2999	</desc>
3000	<param name="interface" type="IHostNetworkInterface" dir="in">
3001	<desc>Network Interface</desc>
3002	</param>
3003	<param name="server" type="IDHCPServer" dir="out">
3004	<desc>Dhcp server settings</desc>
3005	</param>
3006	</method-->
3007
3008	<method name="removeDHCPServer">
3009	<desc>
3010	Removes the dhcp server settings
3011	<result name="E_INVALIDARG">
3012	Host network interface @a name already exists.
3013	</result>
3014	</desc>
3015	<param name="server" type="IDHCPServer" dir="in">
3016	<desc>Dhcp server settings to be removed</desc>
3017	</param>
3018	</method>
3019
3020
3021	<method name="checkFirmwarePresent">
3022	<desc>
3023	Check if this VirtualBox installation has a firmware
3024	of the given type available, either system-wide or per-user.
3025	Optionally, this may return a hint where this firmware can be
3026	downloaded from.
3027	</desc>
3028	<param name="firmwareType" type="FirmwareType" dir="in">
3029	<desc>
3030	Type of firmware to check.
3031	</desc>
3032	</param>
3033	<param name="version" type="wstring" dir="in">
3034	<desc>Expected version number, usually empty string (presently ignored).</desc>
3035	</param>
3036
3037	<param name="url" type="wstring" dir="out">
3038	<desc>
3039	Suggested URL to download this firmware from.
3040	</desc>
3041	</param>
3042
3043	<param name="file" type="wstring" dir="out">
3044	<desc>
3045	Filename of firmware, only valid if result == TRUE.
3046	</desc>
3047	</param>
3048
3049	<param name="result" type="boolean" dir="return">
3050	<desc>If firmware of this type and version is available.</desc>
3051	</param>
3052	</method>
3053
3054	</interface>
3055
3056	<!--
3057	// IVFSExplorer
3058	/////////////////////////////////////////////////////////////////////////
3059	-->
3060
3061	<enum
3062	name="VFSType"
3063	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3064	>
3065	<desc>
3066	Virtual file systems supported by VFSExplorer.
3067	</desc>
3068
3069	<const name="File" value="1" />
3070	<const name="Cloud" value="2" />
3071	<const name="S3" value="3" />
3072	<const name="WebDav" value="4" />
3073	</enum>
3074
3075	<enum
3076	name="VFSFileType"
3077	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3078	>
3079	<desc>
3080	File types known by VFSExplorer.
3081	</desc>
3082
3083	<const name="Unknown" value="1" />
3084	<const name="Fifo" value="2" />
3085	<const name="DevChar" value="3" />
3086	<const name="Directory" value="4" />
3087	<const name="DevBlock" value="5" />
3088	<const name="File" value="6" />
3089	<const name="SymLink" value="7" />
3090	<const name="Socket" value="8" />
3091	<const name="WhiteOut" value="9" />
3092	</enum>
3093
3094	<interface
3095	name="IVFSExplorer" extends="$unknown"
3096	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3097	wsmap="managed"
3098	>
3099	<desc>
3100	The VFSExplorer interface unifies access to different file system
3101	types. This includes local file systems as well remote file systems like
3102	S3. For a list of supported types see <link to="VFSType" />.
3103	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3104	</desc>
3105
3106	<attribute name="path" type="wstring" readonly="yes">
3107	<desc>Returns the current path in the virtual file system.</desc>
3108	</attribute>
3109
3110	<attribute name="type" type="VFSType" readonly="yes">
3111	<desc>Returns the file system type which is currently in use.</desc>
3112	</attribute>
3113
3114	<method name="update">
3115	<desc>Updates the internal list of files/directories from the
3116	current directory level. Use <link to="#entryList" /> to get the full list
3117	after a call to this method.</desc>
3118
3119	<param name="aProgress" type="IProgress" dir="return">
3120	<desc>Progress object to track the operation completion.</desc>
3121	</param>
3122	</method>
3123
3124	<method name="cd">
3125	<desc>Change the current directory level.</desc>
3126
3127	<param name="aDir" type="wstring" dir="in">
3128	<desc>The name of the directory to go in.</desc>
3129	</param>
3130
3131	<param name="aProgress" type="IProgress" dir="return">
3132	<desc>Progress object to track the operation completion.</desc>
3133	</param>
3134	</method>
3135
3136	<method name="cdUp">
3137	<desc>Go one directory upwards from the current directory level.</desc>
3138
3139	<param name="aProgress" type="IProgress" dir="return">
3140	<desc>Progress object to track the operation completion.</desc>
3141	</param>
3142	</method>
3143
3144	<method name="entryList">
3145	<desc>Returns a list of files/directories after a call to <link
3146	to="#update" />. The user is responsible for keeping this internal
3147	list up do date.</desc>
3148
3149	<param name="aNames" type="wstring" safearray="yes" dir="out">
3150	<desc>The list of names for the entries.</desc>
3151	</param>
3152
3153	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3154	<desc>The list of types for the entries.</desc>
3155	</param>
3156	</method>
3157
3158	<method name="exists">
3159	<desc>Checks if the given file list exists in the current directory
3160	level.</desc>
3161
3162	<param name="aNames" type="wstring" safearray="yes" dir="in">
3163	<desc>The names to check.</desc>
3164	</param>
3165
3166	<param name="aExists" type="wstring" safearray="yes" dir="return">
3167	<desc>The names which exist.</desc>
3168	</param>
3169	</method>
3170
3171	<method name="remove">
3172	<desc>Deletes the given files in the current directory level.</desc>
3173
3174	<param name="aNames" type="wstring" safearray="yes" dir="in">
3175	<desc>The names to remove.</desc>
3176	</param>
3177
3178	<param name="aProgress" type="IProgress" dir="return">
3179	<desc>Progress object to track the operation completion.</desc>
3180	</param>
3181	</method>
3182
3183	</interface>
3184
3185	<!--
3186	// IAppliance
3187	/////////////////////////////////////////////////////////////////////////
3188	-->
3189
3190	<interface
3191	name="IAppliance" extends="$unknown"
3192	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3193	wsmap="managed"
3194	>
3195	<desc>
3196	Represents a platform-independent appliance in OVF format. An instance of this is returned
3197	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3198	appliances with VirtualBox.
3199
3200	The OVF standard suggests two different physical file formats:
3201
3202	<ol>
3203	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3204	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3205	this descriptor file references other files, as OVF appliances distributed as a set of
3206	files most likely do, those files must be in the same directory as the descriptor file.</li>
3207
3208	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3209	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3210	files and optionally other files.
3211
3212	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3213	be added with a later version.</li>
3214	</ol>
3215
3216	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3217	<link to="IMachine" /> involves the following sequence of API calls:
3218
3219	<ol>
3220	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3221	</li>
3222
3223	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3224	would like to import. So long as this file is syntactically valid, this will succeed
3225	and return an instance of IAppliance that contains the parsed data from the OVF file.
3226	</li>
3227
3228	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3229	contents of the IAppliance attributes accordingly. These can be inspected by a
3230	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3231	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3232	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3233	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3234	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3235	The GUI can then give the user the option to confirm and/or change these suggestions.
3236	</li>
3237
3238	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3239	virtual system to override the suggestions made by the interpret() routine.
3240	</li>
3241
3242	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3243	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3244	virtual system descriptions.
3245	</li>
3246	</ol>
3247
3248	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3249
3250	<ol>
3251	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3252	an empty IAppliance object.
3253	</li>
3254
3255	<li>For each machine you would like to export, call <link to="IMachine::export" />
3256	with the IAppliance object you just created. This creates an instance of
3257	<link to="IVirtualSystemDescription" /> inside the appliance.
3258	</li>
3259
3260	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3261	virtual system to override the suggestions made by the export() routine.
3262	</li>
3263
3264	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3265	file written.</li>
3266	</ol>
3267
3268	</desc>
3269
3270	<attribute name="path" type="wstring" readonly="yes">
3271	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3272	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3273	<link to="#write" /> (for export).
3274	This attribute is empty until one of these methods has been called.
3275	</desc>
3276	</attribute>
3277
3278	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3279	<desc>
3280	Array of virtual disk definitions. One such description exists for each
3281	disk definition in the OVF; each string array item represents one such piece of
3282	disk information, with the information fields separated by tab (\\t) characters.
3283
3284	The caller should be prepared for additional fields being appended to
3285	this string in future versions of VirtualBox and therefore check for
3286	the number of tabs in the strings returned.
3287
3288	In the current version, the following eight fields are returned per string
3289	in the array:
3290
3291	<ol>
3292	<li>Disk ID (unique string identifier given to disk)</li>
3293
3294	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3295
3296	<li>Populated size (optional unsigned integer indicating the current size of the
3297	disk; can be approximate; -1 if unspecified)</li>
3298
3299	<li>Format (string identifying the disk format, typically
3300	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3301
3302	<li>Reference (where to find the disk image, typically a file name; if empty,
3303	then the disk should be created on import)</li>
3304
3305	<li>Image size (optional unsigned integer indicating the size of the image,
3306	which need not necessarily be the same as the values specified above, since
3307	the image may be compressed or sparse; -1 if not specified)</li>
3308
3309	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3310	presently unsupported and always -1)</li>
3311
3312	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3313	</ol>
3314	</desc>
3315	</attribute>
3316
3317	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3318	<desc> Array of virtual system descriptions. One such description is created
3319	for each virtual system found in the OVF.
3320	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3321	(for export) has been called.
3322	</desc>
3323	</attribute>
3324
3325	<method name="read">
3326	<desc>
3327	Reads an OVF file into the appliance object.
3328
3329	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3330	mere fact that this method returns successfully does not mean that VirtualBox supports all
3331	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3332	</desc>
3333	<param name="file" type="wstring" dir="in">
3334	<desc>
3335	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3336	on whether the appliance is distributed as a set of files or as a single file, respectively).
3337	</desc>
3338	</param>
3339	<param name="aProgress" type="IProgress" dir="return">
3340	<desc></desc>
3341	</param>
3342	</method>
3343
3344	<method name="interpret">
3345	<desc>
3346	Interprets the OVF data that was read when the appliance was constructed. After
3347	calling this method, one can inspect the
3348	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3349	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3350	the appliance.
3351
3352	Calling this method is the second step of importing an appliance into VirtualBox;
3353	see <link to="IAppliance" /> for an overview.
3354
3355	After calling this method, one should call <link to="#getWarnings" /> to find out
3356	if problems were encountered during the processing which might later lead to
3357	errors.
3358	</desc>
3359	</method>
3360
3361	<method name="importMachines">
3362	<desc>
3363	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3364	and other interfaces that match the information contained in the appliance as
3365	closely as possible, as represented by the import instructions in the
3366	<link to="#virtualSystemDescriptions" /> array.
3367
3368	Calling this method is the final step of importing an appliance into VirtualBox;
3369	see <link to="IAppliance" /> for an overview.
3370
3371	Since importing the appliance will most probably involve copying and converting
3372	disk images, which can take a long time, this method operates asynchronously and
3373	returns an IProgress object to allow the caller to monitor the progress.
3374	</desc>
3375
3376	<param name="aProgress" type="IProgress" dir="return">
3377	<desc></desc>
3378	</param>
3379	</method>
3380
3381	<method name="createVFSExplorer">
3382	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3383
3384	<param name="aUri" type="wstring" dir="in">
3385	<desc>The URI describing the file system to use.</desc>
3386	</param>
3387
3388	<param name="aExplorer" type="IVFSExplorer" dir="return">
3389	<desc></desc>
3390	</param>
3391	</method>
3392
3393	<method name="write">
3394	<desc>
3395	Writes the contents of the appliance exports into a new OVF file.
3396
3397	Calling this method is the final step of exporting an appliance from VirtualBox;
3398	see <link to="IAppliance" /> for an overview.
3399
3400	Since exporting the appliance will most probably involve copying and converting
3401	disk images, which can take a long time, this method operates asynchronously and
3402	returns an IProgress object to allow the caller to monitor the progress.
3403	</desc>
3404	<param name="format" type="wstring" dir="in">
3405	<desc>
3406	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3407	future versions of VirtualBox may support additional formats.
3408	</desc>
3409	</param>
3410	<param name="path" type="wstring" dir="in">
3411	<desc>
3412	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3413	on whether the appliance is distributed as a set of files or as a single file, respectively).
3414	</desc>
3415	</param>
3416	<param name="aProgress" type="IProgress" dir="return">
3417	<desc>Progress object to track the operation completion.</desc>
3418	</param>
3419	</method>
3420
3421	<method name="getWarnings">
3422	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3423
3424	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3425	<desc></desc>
3426	</param>
3427	</method>
3428
3429	</interface>
3430
3431	<enum
3432	name="VirtualSystemDescriptionType"
3433	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3434	>
3435	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3436	a configuration value.</desc>
3437
3438	<const name="Ignore" value="1" />
3439	<const name="OS" value="2" />
3440	<const name="Name" value="3" />
3441	<const name="Product" value="4" />
3442	<const name="Vendor" value="5" />
3443	<const name="Version" value="6" />
3444	<const name="ProductUrl" value="7" />
3445	<const name="VendorUrl" value="8" />
3446	<const name="Description" value="9" />
3447	<const name="License" value="10" />
3448	<const name="Miscellaneous" value="11" />
3449	<const name="CPU" value="12" />
3450	<const name="Memory" value="13" />
3451	<const name="HardDiskControllerIDE" value="14" />
3452	<const name="HardDiskControllerSATA" value="15" />
3453	<const name="HardDiskControllerSCSI" value="16" />
3454	<const name="HardDiskImage" value="17" />
3455	<const name="Floppy" value="18" />
3456	<const name="CDROM" value="19" />
3457	<const name="NetworkAdapter" value="20" />
3458	<const name="USBController" value="21" />
3459	<const name="SoundCard" value="22" />
3460
3461	</enum>
3462
3463	<enum
3464	name="VirtualSystemDescriptionValueType"
3465	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3466	>
3467	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3468	type to fetch.</desc>
3469
3470	<const name="Reference" value="1" />
3471	<const name="Original" value="2" />
3472	<const name="Auto" value="3" />
3473	<const name="ExtraConfig" value="4" />
3474
3475	</enum>
3476
3477	<interface
3478	name="IVirtualSystemDescription" extends="$unknown"
3479	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3480	wsmap="managed"
3481	>
3482
3483	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3484	After <link to="IAppliance::interpret" /> has been called, that array contains
3485	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3486	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3487	into VirtualBox.
3488	</desc>
3489
3490	<attribute name="count" type="unsigned long" readonly="yes">
3491	<desc>Return the number of virtual system description entries.</desc>
3492	</attribute>
3493
3494	<method name="getDescription">
3495	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3496	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3497
3498	The list below identifies the value sets that are possible depending on the
3499	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3500	the array item with the same index in aOvfValues[] will contain the original value as contained
3501	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3502	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3503	the aExtraConfigValues[] array item may also be used.
3504
3505	<ul>
3506	<li>
3507	"OS": the guest operating system type. There must be exactly one such array item on import. The
3508	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3509	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3510	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3511	</li>
3512	<li>
3513	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3514	if none is present on import, then an automatic name will be created from the operating system
3515	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3516	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3517	<link to="IMachine" /> name that does not exist yet.
3518	</li>
3519	<li>
3520	"Description": an arbitrary description.
3521	</li>
3522	<li>
3523	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3524	code to display such a license for agreement; the Main API does not enforce any such policy.
3525	</li>
3526	<li>
3527	Miscellaneous: reserved for future use.
3528	</li>
3529	<li>
3530	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3531	</li>
3532	<li>
3533	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3534	is present on import, then VirtualBox will set a meaningful default based on the operating system
3535	type.
3536	</li>
3537	<li>
3538	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3539	has no value in aOvfValues[] or aVBoxValues[].
3540	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3541	type can use to specify which hard disk controller a virtual disk should be connected to.
3542	</li>
3543	<li>
3544	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3545	has no value in aOvfValues[] or aVBoxValues[].
3546	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3547	</li>
3548	<li>
3549	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3550	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3551	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3552	</li>
3553	<li>
3554	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3555	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3556
3557	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3558	a path since the image file should be in the same location as the OVF file itself), whereas the
3559	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3560	hard disk image. This means that on import the image will be copied and converted from the
3561	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3562	On import, the target image will also be registered with VirtualBox.
3563
3564	The matching item in the aExtraConfigValues[] array must contain a string of the following
3565	format: "controller=<index>;channel=<c>"
3566	In this string, <index> must be an integer specifying the hard disk controller to connect
3567	the image to. That number must be the index of an array item with one of the hard disk controller
3568	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3569	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3570	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3571	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3572	</li>
3573	<li>
3574	"CDROM": a virtual CD-ROM drive. The matching item in aExtraConfigValue[] contains the same
3575	attachment information as with "HardDiskImage" items.
3576	</li>
3577	<li>
3578	"CDROM": a virtual floppy drive. The matching item in aExtraConfigValue[] contains the same
3579	attachment information as with "HardDiskImage" items.
3580	</li>
3581	<li>
3582	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3583	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3584	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3585	</li>
3586	<li>
3587	"USBController": a USB controller. There can be at most one such item. If and only if such an
3588	item ispresent, USB support will be enabled for the new virtual machine.
3589	</li>
3590	<li>
3591	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3592	present, sound support will be enabled for the new virtual machine. Note that the virtual
3593	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3594	may be different from the virtual soundcard expected by the appliance.
3595	</li>
3596	</ul>
3597
3598	</desc>
3599
3600	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3601	<desc></desc>
3602	</param>
3603
3604	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3605	<desc></desc>
3606	</param>
3607
3608	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3609	<desc></desc>
3610	</param>
3611
3612	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3613	<desc></desc>
3614	</param>
3615
3616	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3617	<desc></desc>
3618	</param>
3619
3620	</method>
3621
3622	<method name="getDescriptionByType">
3623	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3624	should be returned.</desc>
3625
3626	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3627	<desc></desc>
3628	</param>
3629
3630	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3631	<desc></desc>
3632	</param>
3633
3634	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3635	<desc></desc>
3636	</param>
3637
3638	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3639	<desc></desc>
3640	</param>
3641
3642	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3643	<desc></desc>
3644	</param>
3645
3646	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3647	<desc></desc>
3648	</param>
3649
3650	</method>
3651
3652	<method name="getValuesByType">
3653	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3654	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3655	values.</desc>
3656
3657	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3658	<desc></desc>
3659	</param>
3660
3661	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3662	<desc></desc>
3663	</param>
3664
3665	<param name="aValues" type="wstring" dir="return" safearray="yes">
3666	<desc></desc>
3667	</param>
3668
3669	</method>
3670
3671	<method name="setFinalValues">
3672	<desc>
3673	This method allows the appliance's user to change the configuration for the virtual
3674	system descriptions. For each array item returned from <link to="#getDescription" />,
3675	you must pass in one boolean value and one configuration value.
3676
3677	Each item in the boolean array determines whether the particular configuration item
3678	should be enabled.
3679	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3680	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3681	and SoundCard.
3682
3683	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3684	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3685	the configuration remains unchanged. Please see the documentation for getDescription()
3686	for valid configuration values for the individual array item types. If the
3687	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3688	</desc>
3689
3690	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3691	<desc></desc>
3692	</param>
3693
3694	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3695	<desc></desc>
3696	</param>
3697
3698	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3699	<desc></desc>
3700	</param>
3701	</method>
3702
3703	<method name="addDescription">
3704	<desc>
3705	This method adds an additional description entry to the stack of already
3706	available descriptions for this virtual system. This is handy for writing
3707	values which aren't directly supported by VirtualBox. One example would
3708	be the License type of <link to="VirtualSystemDescriptionType" />.
3709	</desc>
3710
3711	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3712	<desc></desc>
3713	</param>
3714
3715	<param name="aVBoxValue" type="wstring" dir="in">
3716	<desc></desc>
3717	</param>
3718
3719	<param name="aExtraConfigValue" type="wstring" dir="in">
3720	<desc></desc>
3721	</param>
3722	</method>
3723	</interface>
3724
3725
3726	<!--
3727	// IMachine
3728	/////////////////////////////////////////////////////////////////////////
3729	-->
3730
3731	<interface
3732	name="IInternalMachineControl" extends="$unknown"
3733	uuid="35d8d838-d066-447d-927a-fd93afdbec90"
3734	internal="yes"
3735	wsmap="suppress"
3736	>
3737	<method name="setRemoveSavedState">
3738	<desc>
3739	Updates the flag whether saved state is removed on a machine state
3740	change from Saved to PoweredOff.
3741	</desc>
3742	<param name="aRemove" type="boolean" dir="in"/>
3743	</method>
3744
3745	<method name="updateState">
3746	<desc>
3747	Updates the VM state.
3748	<note>
3749	This operation will also update the settings file with
3750	the correct information about the saved state file
3751	and delete this file from disk when appropriate.
3752	</note>
3753	</desc>
3754	<param name="state" type="MachineState" dir="in"/>
3755	</method>
3756
3757	<method name="getIPCId">
3758	<param name="id" type="wstring" dir="return"/>
3759	</method>
3760
3761	<method name="runUSBDeviceFilters">
3762	<desc>
3763	Asks the server to run USB devices filters of the associated
3764	machine against the given USB device and tell if there is
3765	a match.
3766	<note>
3767	Intended to be used only for remote USB devices. Local
3768	ones don't require to call this method (this is done
3769	implicitly by the Host and USBProxyService).
3770	</note>
3771	</desc>
3772	<param name="device" type="IUSBDevice" dir="in"/>
3773	<param name="matched" type="boolean" dir="out"/>
3774	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3775	</method>
3776
3777	<method name="captureUSBDevice">
3778	<desc>
3779	Requests a capture of the given host USB device.
3780	When the request is completed, the VM process will
3781	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3782	notification.
3783	</desc>
3784	<param name="id" type="uuid" mod="string" dir="in"/>
3785	</method>
3786
3787	<method name="detachUSBDevice">
3788	<desc>
3789	Notification that a VM is going to detach (@a done = @c false) or has
3790	already detached (@a done = @c true) the given USB device.
3791	When the @a done = @c true request is completed, the VM process will
3792	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3793	notification.
3794	<note>
3795	In the @a done = @c true case, the server must run its own filters
3796	and filters of all VMs but this one on the detached device
3797	as if it were just attached to the host computer.
3798	</note>
3799	</desc>
3800	<param name="id" type="uuid" mod="string" dir="in"/>
3801	<param name="done" type="boolean" dir="in"/>
3802	</method>
3803
3804	<method name="autoCaptureUSBDevices">
3805	<desc>
3806	Requests a capture all matching USB devices attached to the host.
3807	When the request is completed, the VM process will
3808	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3809	notification per every captured device.
3810	</desc>
3811	</method>
3812
3813	<method name="detachAllUSBDevices">
3814	<desc>
3815	Notification that a VM that is being powered down. The done
3816	parameter indicates whether which stage of the power down
3817	we're at. When @a done = @c false the VM is announcing its
3818	intentions, while when @a done = @c true the VM is reporting
3819	what it has done.
3820	<note>
3821	In the @a done = @c true case, the server must run its own filters
3822	and filters of all VMs but this one on all detach devices as
3823	if they were just attached to the host computer.
3824	</note>
3825	</desc>
3826	<param name="done" type="boolean" dir="in"/>
3827	</method>
3828
3829	<method name="onSessionEnd">
3830	<desc>
3831	Triggered by the given session object when the session is about
3832	to close normally.
3833	</desc>
3834	<param name="session" type="ISession" dir="in">
3835	<desc>Session that is being closed</desc>
3836	</param>
3837	<param name="progress" type="IProgress" dir="return">
3838	<desc>
3839	Used to wait until the corresponding machine is actually
3840	dissociated from the given session on the server.
3841	Returned only when this session is a direct one.
3842	</desc>
3843	</param>
3844	</method>
3845
3846	<method name="beginSavingState">
3847	<desc>
3848	Called by the VM process to inform the server it wants to
3849	save the current state and stop the VM execution.
3850	</desc>
3851	<param name="progress" type="IProgress" dir="in">
3852	<desc>
3853	Progress object created by the VM process to wait until
3854	the state is saved.
3855	</desc>
3856	</param>
3857	<param name="stateFilePath" type="wstring" dir="out">
3858	<desc>
3859	File path the VM process must save the execution state to.
3860	</desc>
3861	</param>
3862	</method>
3863
3864	<method name="endSavingState">
3865	<desc>
3866	Called by the VM process to inform the server that saving
3867	the state previously requested by #beginSavingState is either
3868	successfully finished or there was a failure.
3869
3870	<result name="VBOX_E_FILE_ERROR">
3871	Settings file not accessible.
3872	</result>
3873	<result name="VBOX_E_XML_ERROR">
3874	Could not parse the settings file.
3875	</result>
3876
3877	</desc>
3878
3879	<param name="success" type="boolean" dir="in">
3880	<desc>@c true to indicate success and @c false otherwise.
3881	</desc>
3882	</param>
3883	</method>
3884
3885	<method name="adoptSavedState">
3886	<desc>
3887	Gets called by IConsole::adoptSavedState.
3888	<result name="VBOX_E_FILE_ERROR">
3889	Invalid saved state file path.
3890	</result>
3891	</desc>
3892	<param name="savedStateFile" type="wstring" dir="in">
3893	<desc>Path to the saved state file to adopt.</desc>
3894	</param>
3895	</method>
3896
3897	<method name="beginTakingSnapshot">
3898	<desc>
3899	Called from the VM process to request from the server to perform the
3900	server-side actions of creating a snapshot (creating differencing images
3901	and the snapshot object).
3902
3903	<result name="VBOX_E_FILE_ERROR">
3904	Settings file not accessible.
3905	</result>
3906	<result name="VBOX_E_XML_ERROR">
3907	Could not parse the settings file.
3908	</result>
3909	</desc>
3910	<param name="initiator" type="IConsole" dir="in">
3911	<desc>The console object that initiated this call.</desc>
3912	</param>
3913	<param name="name" type="wstring" dir="in">
3914	<desc>Snapshot name.</desc>
3915	</param>
3916	<param name="description" type="wstring" dir="in">
3917	<desc>Snapshot description.</desc>
3918	</param>
3919	<param name="consoleProgress" type="IProgress" dir="in">
3920	<desc>
3921	Progress object created by the VM process tracking the
3922	snapshot's progress. This has the following sub-operations:
3923	<ul>
3924	<li>setting up (weight 1);</li>
3925	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3926	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3927	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3928	<li>finishing up (weight 1)</li>
3929	</ul>
3930	</desc>
3931	</param>
3932	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3933	<desc>
3934	Whether this is an online snapshot (i.e. the machine is running).
3935	</desc>
3936	</param>
3937	<param name="stateFilePath" type="wstring" dir="out">
3938	<desc>
3939	File path the VM process must save the execution state to.
3940	</desc>
3941	</param>
3942	</method>
3943
3944	<method name="endTakingSnapshot">
3945	<desc>
3946	Called by the VM process to inform the server that the snapshot
3947	previously requested by #beginTakingSnapshot is either
3948	successfully taken or there was a failure.
3949	</desc>
3950
3951	<param name="success" type="boolean" dir="in">
3952	<desc>@c true to indicate success and @c false otherwise</desc>
3953	</param>
3954	</method>
3955
3956	<method name="deleteSnapshot">
3957	<desc>
3958	Gets called by IConsole::deleteSnapshot.
3959	<result name="VBOX_E_INVALID_OBJECT_STATE">
3960	Snapshot has more than one child snapshot.
3961	</result>
3962	</desc>
3963	<param name="initiator" type="IConsole" dir="in">
3964	<desc>The console object that initiated this call.</desc>
3965	</param>
3966	<param name="id" type="uuid" mod="string" dir="in">
3967	<desc>UUID of the snapshot to discard.</desc>
3968	</param>
3969	<param name="machineState" type="MachineState" dir="out">
3970	<desc>New machine state after this operation is started.</desc>
3971	</param>
3972	<param name="progress" type="IProgress" dir="return">
3973	<desc>Progress object to track the operation completion.</desc>
3974	</param>
3975	</method>
3976
3977	<method name="restoreSnapshot">
3978	<desc>
3979	Gets called by IConsole::RestoreSnapshot.
3980	</desc>
3981	<param name="initiator" type="IConsole" dir="in">
3982	<desc>The console object that initiated this call.</desc>
3983	</param>
3984	<param name="snapshot" type="ISnapshot" dir="in">
3985	<desc>The snapshot to restore the VM state from.</desc>
3986	</param>
3987	<param name="machineState" type="MachineState" dir="out">
3988	<desc>New machine state after this operation is started.</desc>
3989	</param>
3990	<param name="progress" type="IProgress" dir="return">
3991	<desc>Progress object to track the operation completion.</desc>
3992	</param>
3993	</method>
3994
3995	<method name="pullGuestProperties">
3996	<desc>
3997	Get the list of the guest properties matching a set of patterns along
3998	with their values, time stamps and flags and give responsibility for
3999	managing properties to the console.
4000	</desc>
4001	<param name="name" type="wstring" dir="out" safearray="yes">
4002	<desc>
4003	The names of the properties returned.
4004	</desc>
4005	</param>
4006	<param name="value" type="wstring" dir="out" safearray="yes">
4007	<desc>
4008	The values of the properties returned. The array entries match the
4009	corresponding entries in the @a name array.
4010	</desc>
4011	</param>
4012	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
4013	<desc>
4014	The time stamps of the properties returned. The array entries match
4015	the corresponding entries in the @a name array.
4016	</desc>
4017	</param>
4018	<param name="flags" type="wstring" dir="out" safearray="yes">
4019	<desc>
4020	The flags of the properties returned. The array entries match the
4021	corresponding entries in the @a name array.
4022	</desc>
4023	</param>
4024	</method>
4025
4026	<method name="pushGuestProperties">
4027	<desc>
4028	Set the list of the guest properties matching a set of patterns along
4029	with their values, time stamps and flags and return responsibility for
4030	managing properties to IMachine.
4031	</desc>
4032	<param name="name" type="wstring" dir="in" safearray="yes">
4033	<desc>
4034	The names of the properties.
4035	</desc>
4036	</param>
4037	<param name="value" type="wstring" dir="in" safearray="yes">
4038	<desc>
4039	The values of the properties. The array entries match the
4040	corresponding entries in the @a name array.
4041	</desc>
4042	</param>
4043	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
4044	<desc>
4045	The time stamps of the properties. The array entries match
4046	the corresponding entries in the @a name array.
4047	</desc>
4048	</param>
4049	<param name="flags" type="wstring" dir="in" safearray="yes">
4050	<desc>
4051	The flags of the properties. The array entries match the
4052	corresponding entries in the @a name array.
4053	</desc>
4054	</param>
4055	</method>
4056	<method name="pushGuestProperty">
4057	<desc>
4058	Update a single guest property in IMachine.
4059	</desc>
4060	<param name="name" type="wstring" dir="in">
4061	<desc>
4062	The name of the property to be updated.
4063	</desc>
4064	</param>
4065	<param name="value" type="wstring" dir="in">
4066	<desc>
4067	The value of the property.
4068	</desc>
4069	</param>
4070	<param name="timestamp" type="unsigned long long" dir="in">
4071	<desc>
4072	The timestamp of the property.
4073	</desc>
4074	</param>
4075	<param name="flags" type="wstring" dir="in">
4076	<desc>
4077	The flags of the property.
4078	</desc>
4079	</param>
4080	</method>
4081
4082	<method name="lockMedia">
4083	<desc>
4084	Locks all media attached to the machine for writing and parents of
4085	attached differencing media (if any) for reading. This operation is
4086	atomic so that if it fails no media is actually locked.
4087
4088	This method is intended to be called when the machine is in Starting or
4089	Restoring state. The locked media will be automatically unlocked when
4090	the machine is powered off or crashed.
4091	</desc>
4092	</method>
4093	<method name="unlockMedia">
4094	<desc>
4095	Unlocks all media previously locked using
4096	<link to="IInternalMachineControl::lockMedia"/>.
4097
4098	This method is intended to be used with teleportation so that it is
4099	possible to teleport between processes on the same machine.
4100	</desc>
4101	</method>
4102	</interface>
4103
4104	<interface
4105	name="IBIOSSettings" extends="$unknown"
4106	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4107	wsmap="managed"
4108	>
4109	<desc>
4110	The IBIOSSettings interface represents BIOS settings of the virtual
4111	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4112	</desc>
4113	<attribute name="logoFadeIn" type="boolean">
4114	<desc>Fade in flag for BIOS logo animation.</desc>
4115	</attribute>
4116
4117	<attribute name="logoFadeOut" type="boolean">
4118	<desc>Fade out flag for BIOS logo animation.</desc>
4119	</attribute>
4120
4121	<attribute name="logoDisplayTime" type="unsigned long">
4122	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4123	</attribute>
4124
4125	<attribute name="logoImagePath" type="wstring">
4126	<desc>
4127	Local file system path for external BIOS splash image. Empty string
4128	means the default image is shown on boot.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4133	<desc>Mode of the BIOS boot device menu.</desc>
4134	</attribute>
4135
4136	<attribute name="ACPIEnabled" type="boolean">
4137	<desc>ACPI support flag.</desc>
4138	</attribute>
4139
4140	<attribute name="IOAPICEnabled" type="boolean">
4141	<desc>
4142	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4143	and support IRQs above 15.
4144	</desc>
4145	</attribute>
4146
4147	<attribute name="timeOffset" type="long long">
4148	<desc>
4149	Offset in milliseconds from the host system time. This allows for
4150	guests running with a different system date/time than the host.
4151	It is equivalent to setting the system date/time in the BIOS except
4152	it is not an absolute value but a relative one. Guest Additions
4153	time synchronization honors this offset.
4154	</desc>
4155	</attribute>
4156
4157	<attribute name="PXEDebugEnabled" type="boolean">
4158	<desc>
4159	PXE debug logging flag. If set, VirtualBox will write extensive
4160	PXE trace information to the release log.
4161	</desc>
4162	</attribute>
4163
4164	</interface>
4165
4166	<interface
4167	name="IMachine" extends="$unknown"
4168	uuid="6d7f40fa-77be-4366-a053-f58e81453a6a"
4169	wsmap="managed"
4170	>
4171	<desc>
4172	The IMachine interface represents a virtual machine, or guest, created
4173	in VirtualBox.
4174
4175	This interface is used in two contexts. First of all, a collection of
4176	objects implementing this interface is stored in the
4177	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4178	machines that are currently registered with this VirtualBox
4179	installation. Also, once a session has been opened for the given virtual
4180	machine (e.g. the virtual machine is running), the machine object
4181	associated with the open session can be queried from the session object;
4182	see <link to="ISession"/> for details.
4183
4184	The main role of this interface is to expose the settings of the virtual
4185	machine and provide methods to change various aspects of the virtual
4186	machine's configuration. For machine objects stored in the
4187	<link to="IVirtualBox::machines"/> collection, all attributes are
4188	read-only unless explicitly stated otherwise in individual attribute
4189	and method descriptions. In order to change a machine setting, a session
4190	for this machine must be opened using one of
4191	<link to="IVirtualBox::openSession"/>,
4192	<link to="IVirtualBox::openRemoteSession"/> or
4193	<link to="IVirtualBox::openExistingSession"/> methods. After the
4194	session has been successfully opened, a mutable machine object needs to
4195	be queried from the session object and then the desired settings changes
4196	can be applied to the returned object using IMachine attributes and
4197	methods. See the <link to="ISession"/> interface description for more
4198	information about sessions.
4199
4200	Note that IMachine does not provide methods to control virtual machine
4201	execution (such as start the machine, or power it down) -- these methods
4202	are grouped in a separate interface called <link to="IConsole" />.
4203
4204	<see>ISession, IConsole</see>
4205	</desc>
4206
4207	<attribute name="parent" type="IVirtualBox" readonly="yes">
4208	<desc>Associated parent object.</desc>
4209	</attribute>
4210
4211	<attribute name="accessible" type="boolean" readonly="yes">
4212	<desc>
4213	Whether this virtual machine is currently accessible or not.
4214
4215	A machine is always deemed accessible unless it is registered <i>and</i>
4216	its settings file cannot be read or parsed (either because the file itself
4217	is unavailable or has invalid XML contents).
4218
4219	Every time this property is read, the accessibility state of
4220	this machine is re-evaluated. If the returned value is @c false,
4221	the <link to="#accessError"/> property may be used to get the
4222	detailed error information describing the reason of
4223	inaccessibility, including XML error messages.
4224
4225	When the machine is inaccessible, only the following properties
4226	can be used on it:
4227	<ul>
4228	<li><link to="#parent"/></li>
4229	<li><link to="#id"/></li>
4230	<li><link to="#settingsFilePath"/></li>
4231	<li><link to="#accessible"/></li>
4232	<li><link to="#accessError"/></li>
4233	</ul>
4234
4235	An attempt to access any other property or method will return
4236	an error.
4237
4238	The only possible action you can perform on an inaccessible
4239	machine is to unregister it using the
4240	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4241	for the accessibility state once more by querying this
4242	property).
4243
4244	<note>
4245	In the current implementation, once this property returns
4246	@c true, the machine will never become inaccessible
4247	later, even if its settings file cannot be successfully
4248	read/written any more (at least, until the VirtualBox
4249	server is restarted). This limitation may be removed in
4250	future releases.
4251	</note>
4252	</desc>
4253	</attribute>
4254
4255	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4256	<desc>
4257	Error information describing the reason of machine
4258	inaccessibility.
4259
4260	Reading this property is only valid after the last call to
4261	<link to="#accessible"/> returned @c false (i.e. the
4262	machine is currently unaccessible). Otherwise, a @c null
4263	IVirtualBoxErrorInfo object will be returned.
4264	</desc>
4265	</attribute>
4266
4267	<attribute name="name" type="wstring">
4268	<desc>
4269	Name of the virtual machine.
4270
4271	Besides being used for human-readable identification purposes
4272	everywhere in VirtualBox, the virtual machine name is also used
4273	as a name of the machine's settings file and as a name of the
4274	subdirectory this settings file resides in. Thus, every time you
4275	change the value of this property, the settings file will be
4276	renamed once you call <link to="#saveSettings"/> to confirm the
4277	change. The containing subdirectory will be also renamed, but
4278	only if it has exactly the same name as the settings file
4279	itself prior to changing this property (for backward compatibility
4280	with previous API releases). The above implies the following
4281	limitations:
4282	<ul>
4283	<li>The machine name cannot be empty.</li>
4284	<li>The machine name can contain only characters that are valid
4285	file name characters according to the rules of the file
4286	system used to store VirtualBox configuration.</li>
4287	<li>You cannot have two or more machines with the same name
4288	if they use the same subdirectory for storing the machine
4289	settings files.</li>
4290	<li>You cannot change the name of the machine if it is running,
4291	or if any file in the directory containing the settings file
4292	is being used by another running machine or by any other
4293	process in the host operating system at a time when
4294	<link to="#saveSettings"/> is called.
4295	</li>
4296	</ul>
4297	If any of the above limitations are hit, <link to="#saveSettings"/>
4298	will return an appropriate error message explaining the exact
4299	reason and the changes you made to this machine will not be
4300	saved.
4301	<note>
4302	For "legacy" machines created using the
4303	<link to="IVirtualBox::createLegacyMachine"/> call,
4304	the above naming limitations do not apply because the
4305	machine name does not affect the settings file name.
4306	The settings file name remains the same as it was specified
4307	during machine creation and never changes.
4308	</note>
4309	</desc>
4310	</attribute>
4311
4312	<attribute name="description" type="wstring">
4313	<desc>
4314	Description of the virtual machine.
4315
4316	The description attribute can contain any text and is
4317	typically used to describe the hardware and software
4318	configuration of the virtual machine in detail (i.e. network
4319	settings, versions of the installed software and so on).
4320	</desc>
4321	</attribute>
4322
4323	<attribute name="id" type="uuid" mod="string" readonly="yes">
4324	<desc>UUID of the virtual machine.</desc>
4325	</attribute>
4326
4327	<attribute name="OSTypeId" type="wstring">
4328	<desc>
4329	User-defined identifier of the Guest OS type.
4330	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4331	an IGuestOSType object representing details about the given
4332	Guest OS type.
4333	<note>
4334	This value may differ from the value returned by
4335	<link to="IGuest::OSTypeId"/> if Guest Additions are
4336	installed to the guest OS.
4337	</note>
4338	</desc>
4339	</attribute>
4340
4341	<attribute name="HardwareVersion" type="wstring">
4342	<desc>Hardware version identifier. Internal use only for now.</desc>
4343	</attribute>
4344
4345	<attribute name="hardwareUUID" type="uuid" mod="string">
4346	<desc>
4347	The UUID presented to the guest via memory tables, hardware and guest
4348	properties. For most VMs this is the same as the @a id, but for VMs
4349	which have been cloned or teleported it may be the same as the source
4350	VM. This latter is because the guest shouldn't notice that it was
4351	cloned or teleported.
4352	</desc>
4353	</attribute>
4354
4355	<attribute name="CPUCount" type="unsigned long">
4356	<desc>Number of virtual CPUs in the VM.</desc>
4357	</attribute>
4358
4359	<attribute name="CPUHotPlugEnabled" type="boolean">
4360	<desc>
4361	This setting determines whether VirtualBox allows CPU
4362	hotplugging for this machine.</desc>
4363	</attribute>
4364
4365	<attribute name="memorySize" type="unsigned long">
4366	<desc>System memory size in megabytes.</desc>
4367	</attribute>
4368
4369	<attribute name="memoryBalloonSize" type="unsigned long">
4370	<desc>Initial memory balloon size in megabytes.</desc>
4371	</attribute>
4372
4373	<attribute name="statisticsUpdateInterval" type="unsigned long">
4374	<desc>Initial interval to update guest statistics in seconds.</desc>
4375	</attribute>
4376
4377	<attribute name="VRAMSize" type="unsigned long">
4378	<desc>Video memory size in megabytes.</desc>
4379	</attribute>
4380
4381	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4382	<desc>
4383	This setting determines whether VirtualBox allows this machine to make
4384	use of the 3D graphics support available on the host.</desc>
4385	</attribute>
4386
4387	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4388	<desc>
4389	This setting determines whether VirtualBox allows this machine to make
4390	use of the 2D video acceleration support available on the host.</desc>
4391	</attribute>
4392
4393	<attribute name="monitorCount" type="unsigned long">
4394	<desc>
4395	Number of virtual monitors.
4396	<note>
4397	Only effective on Windows XP and later guests with
4398	Guest Additions installed.
4399	</note>
4400	</desc>
4401	</attribute>
4402
4403	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4404	<desc>Object containing all BIOS settings.</desc>
4405	</attribute>
4406
4407	<attribute name="firmwareType" type="FirmwareType">
4408	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4409	bootstrap in this VM.</desc>
4410	</attribute>
4411
4412	<attribute name="snapshotFolder" type="wstring">
4413	<desc>
4414	Full path to the directory used to store snapshot data
4415	(differencing media and saved state files) of this machine.
4416
4417	The initial value of this property is
4418	<tt><</tt><link to="#settingsFilePath">
4419	path_to_settings_file</link><tt>>/<</tt>
4420	<link to="#id">machine_uuid</link>
4421	<tt>></tt>.
4422
4423	Currently, it is an error to try to change this property on
4424	a machine that has snapshots (because this would require to
4425	move possibly large files to a different location).
4426	A separate method will be available for this purpose later.
4427
4428	<note>
4429	Setting this property to @c null or to an empty string will restore
4430	the initial value.
4431	</note>
4432	<note>
4433	When setting this property, the specified path can be
4434	absolute (full path) or relative to the directory where the
4435	<link to="#settingsFilePath">machine settings file</link>
4436	is located. When reading this property, a full path is
4437	always returned.
4438	</note>
4439	<note>
4440	The specified path may not exist, it will be created
4441	when necessary.
4442	</note>
4443	</desc>
4444	</attribute>
4445
4446	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4447	<desc>VRDP server object.</desc>
4448	</attribute>
4449
4450	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4451	<desc>Array of media attached to this machine.</desc>
4452	</attribute>
4453
4454	<attribute name="USBController" type="IUSBController" readonly="yes">
4455	<desc>
4456	Associated USB controller object.
4457
4458	<note>
4459	If USB functionality is not available in the given edition of
4460	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4461	</note>
4462	</desc>
4463	</attribute>
4464
4465	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4466	<desc>Associated audio adapter, always present.</desc>
4467	</attribute>
4468
4469	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4470	<desc>Array of storage controllers attached to this machine.</desc>
4471	</attribute>
4472
4473	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4474	<desc>
4475	Full name of the file containing machine settings data.
4476	</desc>
4477	</attribute>
4478
4479	<attribute name="settingsModified" type="boolean" readonly="yes">
4480	<desc>
4481	Whether the settings of this machine have been modified
4482	(but neither yet saved nor discarded).
4483	<note>
4484	Reading this property is only valid on instances returned
4485	by <link to="ISession::machine"/> and on new machines
4486	created by <link to="IVirtualBox::createMachine"/> or opened
4487	by <link to="IVirtualBox::openMachine"/> but not
4488	yet registered, or on unregistered machines after calling
4489	<link to="IVirtualBox::unregisterMachine"/>. For all other
4490	cases, the settings can never be modified.
4491	</note>
4492	<note>
4493	For newly created unregistered machines, the value of this
4494	property is always @c true until <link to="#saveSettings"/>
4495	is called (no matter if any machine settings have been
4496	changed after the creation or not). For opened machines
4497	the value is set to @c false (and then follows to normal rules).
4498	</note>
4499	</desc>
4500	</attribute>
4501
4502	<attribute name="sessionState" type="SessionState" readonly="yes">
4503	<desc>Current session state for this machine.</desc>
4504	</attribute>
4505
4506	<attribute name="sessionType" type="wstring" readonly="yes">
4507	<desc>
4508	Type of the session. If <link to="#sessionState"/> is
4509	SessionSpawning or SessionOpen, this attribute contains the
4510	same value as passed to the
4511	<link to="IVirtualBox::openRemoteSession"/> method in the
4512	@a type parameter. If the session was opened directly using
4513	<link to="IVirtualBox::openSession"/>, or if
4514	<link to="#sessionState"/> is SessionClosed, the value of this
4515	attribute is an empty string.
4516	</desc>
4517	</attribute>
4518
4519	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4520	<desc>
4521	Identifier of the session process. This attribute contains the
4522	platform-dependent identifier of the process that has opened a
4523	direct session for this machine using the
4524	<link to="IVirtualBox::openSession"/> call. The returned value
4525	is only valid if <link to="#sessionState"/> is SessionOpen or
4526	SessionClosing (i.e. a session is currently open or being
4527	closed) by the time this property is read.
4528	</desc>
4529	</attribute>
4530
4531	<attribute name="state" type="MachineState" readonly="yes">
4532	<desc>Current execution state of this machine.</desc>
4533	</attribute>
4534
4535	<attribute name="lastStateChange" type="long long" readonly="yes">
4536	<desc>
4537	Time stamp of the last execution state change,
4538	in milliseconds since 1970-01-01 UTC.
4539	</desc>
4540	</attribute>
4541
4542	<attribute name="stateFilePath" type="wstring" readonly="yes">
4543	<desc>
4544	Full path to the file that stores the execution state of
4545	the machine when it is in the <link to="MachineState_Saved"/> state.
4546	<note>
4547	When the machine is not in the Saved state, this attribute is
4548	an empty string.
4549	</note>
4550	</desc>
4551	</attribute>
4552
4553	<attribute name="logFolder" type="wstring" readonly="yes">
4554	<desc>
4555	Full path to the folder that stores a set of rotated log files
4556	recorded during machine execution. The most recent log file is
4557	named <tt>VBox.log</tt>, the previous log file is
4558	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4559	in the current version).
4560	</desc>
4561	</attribute>
4562
4563	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4564	<desc>
4565	Current snapshot of this machine. This is @c null if the machine
4566	currently has no snapshots. If it is not @c null, then it was
4567	set by one of <link to="Console::takeSnapshot" />,
4568	<link to="Console::deleteSnapshot" />
4569	or <link to="Console::restoreSnapshot" />, depending on which
4570	was called last. See <link to="ISnapshot"/> for details.
4571	</desc>
4572	</attribute>
4573
4574	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4575	<desc>
4576	Number of snapshots taken on this machine. Zero means the
4577	machine doesn't have any snapshots.
4578	</desc>
4579	</attribute>
4580
4581	<attribute name="currentStateModified" type="boolean" readonly="yes">
4582	<desc>
4583	Returns @c true if the current state of the machine is not
4584	identical to the state stored in the current snapshot.
4585
4586	The current state is identical to the current snapshot only
4587	directly after one of the following calls are made:
4588
4589	<ul>
4590	<li><link to="IConsole::restoreSnapshot"/>
4591	</li>
4592	<li><link to="IConsole::takeSnapshot"/> (issued on a
4593	"powered off" or "saved" machine, for which
4594	<link to="#settingsModified"/> returns @c false)
4595	</li>
4596	<li><link to="IMachine::setCurrentSnapshot"/>
4597	</li>
4598	</ul>
4599
4600	The current state remains identical until one of the following
4601	happens:
4602	<ul>
4603	<li>settings of the machine are changed</li>
4604	<li>the saved state is discarded</li>
4605	<li>the current snapshot is discarded</li>
4606	<li>an attempt to execute the machine is made</li>
4607	</ul>
4608
4609	<note>
4610	For machines that don't have snapshots, this property is
4611	always @c false.
4612	</note>
4613	</desc>
4614	</attribute>
4615
4616	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4617	<desc>
4618	Collection of shared folders for this machine (permanent shared
4619	folders). These folders are shared automatically at machine startup
4620	and available only to the guest OS installed within this machine.
4621
4622	New shared folders are added to the collection using
4623	<link to="#createSharedFolder"/>. Existing shared folders can be
4624	removed using <link to="#removeSharedFolder"/>.
4625	</desc>
4626	</attribute>
4627
4628	<attribute name="clipboardMode" type="ClipboardMode">
4629	<desc>
4630	Synchronization mode between the host OS clipboard
4631	and the guest OS clipboard.
4632	</desc>
4633	</attribute>
4634
4635	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4636	<desc>
4637	A comma-separated list of simple glob patterns. Changes to guest
4638	properties whose name matches one of the patterns will generate an
4639	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4640	</desc>
4641	</attribute>
4642
4643	<attribute name="teleporterEnabled" type="boolean">
4644	<desc>
4645	When set to @a true, the virtual machine becomes a target teleporter
4646	the next time it is powered on. This can only set to @a true when the
4647	VM is in the @a PoweredOff or @a Aborted state.
4648
4649	<!-- This property is automatically set to @a false when the VM is powered
4650	on. (bird: This doesn't work yet ) -->
4651	</desc>
4652	</attribute>
4653
4654	<attribute name="teleporterPort" type="unsigned long">
4655	<desc>
4656	The TCP port the target teleporter will listen for incoming
4657	teleportations on.
4658
4659	0 means the port is automatically selected upon power on. The actual
4660	value can be read from this property while the machine is waiting for
4661	incoming teleportations.
4662	</desc>
4663	</attribute>
4664
4665	<attribute name="teleporterAddress" type="wstring">
4666	<desc>
4667	The address the target teleporter will listen on. If set to an empty
4668	string, it will listen on all addresses.
4669	</desc>
4670	</attribute>
4671
4672	<attribute name="teleporterPassword" type="wstring">
4673	<desc>
4674	The password the to check for on the target teleporter. This is just a
4675	very basic measure to prevent simple hacks and operators accidentally
4676	beaming a virtual machine to the wrong place.
4677	</desc>
4678	</attribute>
4679
4680	<attribute name="RTCUseUTC" type="boolean">
4681	<desc>
4682	When set to @a true, the RTC device of the virtual machine will run
4683	in UTC time, otherwise in local time. Especially Unix guests prefer
4684	the time in UTC.
4685	</desc>
4686	</attribute>
4687
4688	<method name="setBootOrder">
4689	<desc>
4690	Puts the given device to the specified position in
4691	the boot order.
4692
4693	To indicate that no device is associated with the given position,
4694	<link to="DeviceType_Null"/> should be used.
4695
4696	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4697
4698	<result name="E_INVALIDARG">
4699	Boot @a position out of range.
4700	</result>
4701	<result name="E_NOTIMPL">
4702	Booting from USB @a device currently not supported.
4703	</result>
4704
4705	</desc>
4706	<param name="position" type="unsigned long" dir="in">
4707	<desc>
4708	Position in the boot order (@c 1 to the total number of
4709	devices the machine can boot from, as returned by
4710	<link to="ISystemProperties::maxBootPosition"/>).
4711	</desc>
4712	</param>
4713	<param name="device" type="DeviceType" dir="in">
4714	<desc>
4715	The type of the device used to boot at the given position.
4716	</desc>
4717	</param>
4718	</method>
4719
4720	<method name="getBootOrder" const="yes">
4721	<desc>
4722	Returns the device type that occupies the specified
4723	position in the boot order.
4724
4725	@todo [remove?]
4726	If the machine can have more than one device of the returned type
4727	(such as hard disks), then a separate method should be used to
4728	retrieve the individual device that occupies the given position.
4729
4730	If here are no devices at the given position, then
4731	<link to="DeviceType_Null"/> is returned.
4732
4733	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4734
4735	<result name="E_INVALIDARG">
4736	Boot @a position out of range.
4737	</result>
4738
4739	</desc>
4740	<param name="position" type="unsigned long" dir="in">
4741	<desc>
4742	Position in the boot order (@c 1 to the total number of
4743	devices the machine can boot from, as returned by
4744	<link to="ISystemProperties::maxBootPosition"/>).
4745	</desc>
4746	</param>
4747	<param name="device" type="DeviceType" dir="return">
4748	<desc>
4749	Device at the given position.
4750	</desc>
4751	</param>
4752	</method>
4753
4754	<method name="attachDevice">
4755	<desc>
4756	Attaches a device and optionally mounts a medium to the given storage
4757	controller (<link to="IStorageController" />, identified by @a name),
4758	at the indicated port and device.
4759
4760	This method is intended for managing storage devices in general (it works
4761	for both fixed and removable media). For storage devices supporting removable
4762	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4763	for changing the media while the machine is running.
4764
4765	For the IDE bus, the @a controllerPort parameter can be either
4766	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4767	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4768	to specify the master or the slave device, respectively. (In the
4769	default configuration of virtual machines, the secondary master is
4770	used for a CD/DVD drive.)
4771
4772	For an SATA controller, @a controllerPort must be a number ranging
4773	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4774	be a number ranging from @c 0 to @c 15.
4775
4776	For both SCSI and SATA, the @a device parameter is unused and must
4777	be @c 0.
4778
4779	For fixed media such as hard disks, the given medium identifier cannot
4780	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4781	and floppies.
4782
4783	After calling this returns successfully, a new instance of
4784	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4785	attachments (<link to="IMachine::mediumAttachments"/>).
4786
4787	The specified device slot must not have a device attached to it,
4788	or this method will fail.
4789
4790	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4791	information about attaching media.
4792
4793	<note>
4794	You cannot attach a device to a running machine. Also, you cannot
4795	attach a device to a newly created machine until this machine's
4796	settings are saved to disk using <link to="#saveSettings"/>.
4797	</note>
4798	<note>
4799	If the medium is being attached indirectly, a new differencing medium
4800	will implicitly be created for it and attached instead. If the
4801	changes made to the machine settings (including this indirect
4802	attachment) are later cancelled using <link to="#discardSettings"/>,
4803	this implicitly created differencing medium will implicitly
4804	be deleted.
4805	</note>
4806
4807	<result name="E_INVALIDARG">
4808	SATA device, SATA port, IDE port or IDE slot out of range.
4809	</result>
4810	<result name="VBOX_E_INVALID_OBJECT_STATE">
4811	Attempt to attach medium to an unregistered virtual machine.
4812	</result>
4813	<result name="VBOX_E_INVALID_VM_STATE">
4814	Invalid machine state.
4815	</result>
4816	<result name="VBOX_E_OBJECT_IN_USE">
4817	Hard disk already attached to this or another virtual machine.
4818	</result>
4819
4820	</desc>
4821	<param name="name" type="wstring" dir="in">
4822	<desc>Name of the storage controller to attach the device to.</desc>
4823	</param>
4824	<param name="controllerPort" type="long" dir="in">
4825	<desc>Port to attach the device to.</desc>
4826	</param>
4827	<param name="device" type="long" dir="in">
4828	<desc>Device slot in the given port to attach the device to.</desc>
4829	</param>
4830	<param name="type" type="DeviceType" dir="in">
4831	<desc>Device type of the attached device.</desc>
4832	</param>
4833	<param name="id" type="uuid" mod="string" dir="in">
4834	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4835	medium.</desc>
4836	</param>
4837	</method>
4838
4839	<method name="detachDevice">
4840	<desc>
4841	Detaches the device attached to a device slot of the specified bus.
4842
4843	Detaching the device from the virtual machine is deferred. This means
4844	that the medium remains associated with the machine when this method
4845	returns and gets actually de-associated only after a successful
4846	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4847	for more detailed information about attaching media.
4848
4849	<note>
4850	You cannot detach a device from a running machine.
4851	</note>
4852	<note>
4853	Detaching differencing media implicitly created by <link
4854	to="#attachDevice"/> for the indirect attachment using this
4855	method will <b>not</b> implicitly delete them. The
4856	<link to="IMedium::deleteStorage"/> operation should be
4857	explicitly performed by the caller after the medium is successfully
4858	detached and the settings are saved with
4859	<link to="#saveSettings"/>, if it is the desired action.
4860	</note>
4861
4862	<result name="VBOX_E_INVALID_VM_STATE">
4863	Attempt to detach medium from a running virtual machine.
4864	</result>
4865	<result name="VBOX_E_OBJECT_NOT_FOUND">
4866	No medium attached to given slot/bus.
4867	</result>
4868	<result name="VBOX_E_NOT_SUPPORTED">
4869	Medium format does not support storage deletion.
4870	</result>
4871
4872	</desc>
4873	<param name="name" type="wstring" dir="in">
4874	<desc>Name of the storage controller to detach the medium from.</desc>
4875	</param>
4876	<param name="controllerPort" type="long" dir="in">
4877	<desc>Port number to detach the medium from.</desc>
4878	</param>
4879	<param name="device" type="long" dir="in">
4880	<desc>Device slot number to detach the medium from.</desc>
4881	</param>
4882	</method>
4883
4884	<method name="passthroughDevice">
4885	<desc>
4886	Sets the passthrough mode of an existing DVD device. Changing the
4887	setting while the VM is running is forbidden. The setting is only used
4888	if at VM start the device is configured as a host DVD drive, in all
4889	other cases it is ignored. The device must already exist; see
4890	<link to="IMachine::attachDevice"/> for how to attach a new device.
4891
4892	The @a controllerPort and @a device parameters specify the device slot and
4893	have have the same meaning as with <link to="IMachine::attachDevice" />.
4894
4895	<result name="E_INVALIDARG">
4896	SATA device, SATA port, IDE port or IDE slot out of range.
4897	</result>
4898	<result name="VBOX_E_INVALID_OBJECT_STATE">
4899	Attempt to modify an unregistered virtual machine.
4900	</result>
4901	<result name="VBOX_E_INVALID_VM_STATE">
4902	Invalid machine state.
4903	</result>
4904
4905	</desc>
4906	<param name="name" type="wstring" dir="in">
4907	<desc>Name of the storage controller.</desc>
4908	</param>
4909	<param name="controllerPort" type="long" dir="in">
4910	<desc>Storage controller port.</desc>
4911	</param>
4912	<param name="device" type="long" dir="in">
4913	<desc>Device slot in the given port.</desc>
4914	</param>
4915	<param name="passthrough" type="boolean" dir="in">
4916	<desc>New value for the passthrough setting.</desc>
4917	</param>
4918	</method>
4919
4920	<method name="mountMedium">
4921	<desc>
4922	Mounts a medium (<link to="IMedium" />, identified
4923	by the given UUID @a id) to the given storage controller
4924	(<link to="IStorageController" />, identified by @a name),
4925	at the indicated port and device. The device must already exist;
4926	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4927
4928	This method is intended only for managing removable media, where the
4929	device is fixed but media is changeable at runtime (such as DVDs
4930	and floppies). It cannot be used for fixed media such as hard disks.
4931
4932	The @a controllerPort and @a device parameters specify the device slot and
4933	have have the same meaning as with <link to="IMachine::attachDevice" />.
4934
4935	The specified device slot can have a medium mounted, which will be
4936	unmounted first. Specifying a zero UUID (or an empty string) for
4937	@a medium does just an unmount.
4938
4939	See <link to="IMedium"/> for more detailed information about
4940	attaching media.
4941
4942	<result name="E_INVALIDARG">
4943	SATA device, SATA port, IDE port or IDE slot out of range.
4944	</result>
4945	<result name="VBOX_E_INVALID_OBJECT_STATE">
4946	Attempt to attach medium to an unregistered virtual machine.
4947	</result>
4948	<result name="VBOX_E_INVALID_VM_STATE">
4949	Invalid machine state.
4950	</result>
4951	<result name="VBOX_E_OBJECT_IN_USE">
4952	Medium already attached to this or another virtual machine.
4953	</result>
4954
4955	</desc>
4956	<param name="name" type="wstring" dir="in">
4957	<desc>Name of the storage controller to attach the medium to.</desc>
4958	</param>
4959	<param name="controllerPort" type="long" dir="in">
4960	<desc>Port to attach the medium to.</desc>
4961	</param>
4962	<param name="device" type="long" dir="in">
4963	<desc>Device slot in the given port to attach the medium to.</desc>
4964	</param>
4965	<param name="medium" type="uuid" mod="string" dir="in">
4966	<desc>UUID of the medium to attach. A zero UUID means unmount the
4967	currently mounted medium.</desc>
4968	</param>
4969	<param name="force" type="boolean" dir="in">
4970	<desc>Allows to force unmount/mount of a medium which is locked by
4971	theDevice slot in the given port to attach the medium to.</desc>
4972	</param>
4973	</method>
4974
4975	<method name="getMedium" const="yes">
4976	<desc>
4977	Returns the virtual medium attached to a device slot of the specified
4978	bus.
4979
4980	Note that if the medium was indirectly attached by
4981	<link to="#mountMedium"/> to the given device slot then this
4982	method will return not the same object as passed to the
4983	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4984	more detailed information about mounting a medium.
4985
4986	<result name="VBOX_E_OBJECT_NOT_FOUND">
4987	No medium attached to given slot/bus.
4988	</result>
4989
4990	</desc>
4991	<param name="name" type="wstring" dir="in">
4992	<desc>Name of the storage controller the medium is attached to.</desc>
4993	</param>
4994	<param name="controllerPort" type="long" dir="in">
4995	<desc>Port to query.</desc>
4996	</param>
4997	<param name="device" type="long" dir="in">
4998	<desc>Device slot in the given port to query.</desc>
4999	</param>
5000	<param name="medium" type="IMedium" dir="return">
5001	<desc>Attached medium object.</desc>
5002	</param>
5003	</method>
5004
5005	<method name="getMediumAttachmentsOfController" const="yes">
5006	<desc>
5007	Returns an array of medium attachments which are attached to the
5008	the controller with the given name.
5009
5010	<result name="VBOX_E_OBJECT_NOT_FOUND">
5011	A storage controller with given name doesn't exist.
5012	</result>
5013	</desc>
5014	<param name="name" type="wstring" dir="in"/>
5015	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5016	</method>
5017
5018	<method name="getMediumAttachment" const="yes">
5019	<desc>
5020	Returns a medium attachment which corresponds to the controller with
5021	the given name, on the given port and device slot.
5022
5023	<result name="VBOX_E_OBJECT_NOT_FOUND">
5024	No attachment exists for the given controller/port/device combination.
5025	</result>
5026	</desc>
5027	<param name="name" type="wstring" dir="in"/>
5028	<param name="controllerPort" type="long" dir="in"/>
5029	<param name="device" type="long" dir="in"/>
5030	<param name="attachment" type="IMediumAttachment" dir="return"/>
5031	</method>
5032
5033	<method name="getNetworkAdapter" const="yes">
5034	<desc>
5035	Returns the network adapter associated with the given slot.
5036	Slots are numbered sequentially, starting with zero. The total
5037	number of adapters per machine is defined by the
5038	<link to="ISystemProperties::networkAdapterCount"/> property,
5039	so the maximum slot number is one less than that property's value.
5040
5041	<result name="E_INVALIDARG">
5042	Invalid @a slot number.
5043	</result>
5044
5045	</desc>
5046	<param name="slot" type="unsigned long" dir="in"/>
5047	<param name="adapter" type="INetworkAdapter" dir="return"/>
5048	</method>
5049
5050	<method name="addStorageController">
5051	<desc>
5052	Adds a new storage controller (SCSI or SATA controller) to the
5053	machine and returns it as an instance of
5054	<link to="IStorageController" />.
5055
5056	@a name identifies the controller for subsequent calls such as
5057	<link to="#getStorageControllerByName" />,
5058	<link to="#getStorageControllerByInstance" />,
5059	<link to="#removeStorageController" />,
5060	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5061
5062	After the controller has been added, you can set its exact
5063	type by setting the <link to="IStorageController::controllerType" />.
5064
5065	<result name="VBOX_E_OBJECT_IN_USE">
5066	A storage controller with given name exists already.
5067	</result>
5068	<result name="E_INVALIDARG">
5069	Invalid @a controllerType.
5070	</result>
5071	</desc>
5072	<param name="name" type="wstring" dir="in"/>
5073	<param name="connectionType" type="StorageBus" dir="in"/>
5074	<param name="controller" type="IStorageController" dir="return"/>
5075	</method>
5076
5077	<method name="getStorageControllerByName" const="yes">
5078	<desc>
5079	Returns a storage controller with the given name.
5080
5081	<result name="VBOX_E_OBJECT_NOT_FOUND">
5082	A storage controller with given name doesn't exist.
5083	</result>
5084	</desc>
5085	<param name="name" type="wstring" dir="in"/>
5086	<param name="storageController" type="IStorageController" dir="return"/>
5087	</method>
5088
5089	<method name="getStorageControllerByInstance" const="yes">
5090	<desc>
5091	Returns a storage controller with the given instance number.
5092
5093	<result name="VBOX_E_OBJECT_NOT_FOUND">
5094	A storage controller with given instance number doesn't exist.
5095	</result>
5096	</desc>
5097	<param name="instance" type="unsigned long" dir="in"/>
5098	<param name="storageController" type="IStorageController" dir="return"/>
5099	</method>
5100
5101	<method name="removeStorageController">
5102	<desc>
5103	Removes a storage controller from the machine.
5104
5105	<result name="VBOX_E_OBJECT_NOT_FOUND">
5106	A storage controller with given name doesn't exist.
5107	</result>
5108	</desc>
5109	<param name="name" type="wstring" dir="in"/>
5110	</method>
5111
5112	<method name="getSerialPort" const="yes">
5113	<desc>
5114	Returns the serial port associated with the given slot.
5115	Slots are numbered sequentially, starting with zero. The total
5116	number of serial ports per machine is defined by the
5117	<link to="ISystemProperties::serialPortCount"/> property,
5118	so the maximum slot number is one less than that property's value.
5119
5120	<result name="E_INVALIDARG">
5121	Invalid @a slot number.
5122	</result>
5123
5124	</desc>
5125	<param name="slot" type="unsigned long" dir="in"/>
5126	<param name="port" type="ISerialPort" dir="return"/>
5127	</method>
5128
5129	<method name="getParallelPort" const="yes">
5130	<desc>
5131	Returns the parallel port associated with the given slot.
5132	Slots are numbered sequentially, starting with zero. The total
5133	number of parallel ports per machine is defined by the
5134	<link to="ISystemProperties::parallelPortCount"/> property,
5135	so the maximum slot number is one less than that property's value.
5136
5137	<result name="E_INVALIDARG">
5138	Invalid @a slot number.
5139	</result>
5140
5141	</desc>
5142	<param name="slot" type="unsigned long" dir="in"/>
5143	<param name="port" type="IParallelPort" dir="return"/>
5144	</method>
5145
5146	<method name="getExtraDataKeys">
5147	<desc>
5148	Returns an array representing the machine-specific extra data keys
5149	which currently have values defined.
5150	</desc>
5151	<param name="value" type="wstring" dir="return" safearray="yes">
5152	<desc>Array of extra data keys.</desc>
5153	</param>
5154	</method>
5155
5156	<method name="getExtraData">
5157	<desc>
5158	Returns associated machine-specific extra data.
5159
5160	If the requested data @a key does not exist, this function will
5161	succeed and return an empty string in the @a value argument.
5162
5163	<result name="VBOX_E_FILE_ERROR">
5164	Settings file not accessible.
5165	</result>
5166	<result name="VBOX_E_XML_ERROR">
5167	Could not parse the settings file.
5168	</result>
5169
5170	</desc>
5171	<param name="key" type="wstring" dir="in">
5172	<desc>Name of the data key to get.</desc>
5173	</param>
5174	<param name="value" type="wstring" dir="return">
5175	<desc>Value of the requested data key.</desc>
5176	</param>
5177	</method>
5178
5179	<method name="setExtraData">
5180	<desc>
5181	Sets associated machine-specific extra data.
5182
5183	If you pass @c null or an empty string as a key @a value, the given
5184	@a key will be deleted.
5185
5186	<note>
5187	Before performing the actual data change, this method will ask all
5188	registered callbacks using the
5189	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5190	notification for a permission. If one of the callbacks refuses the
5191	new value, the change will not be performed.
5192	</note>
5193	<note>
5194	On success, the
5195	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5196	is called to inform all registered callbacks about a successful data
5197	change.
5198	</note>
5199	<note>
5200	This method can be called outside the machine session and therefore
5201	it's a caller's responsibility to handle possible race conditions
5202	when several clients change the same key at the same time.
5203	</note>
5204
5205	<result name="VBOX_E_FILE_ERROR">
5206	Settings file not accessible.
5207	</result>
5208	<result name="VBOX_E_XML_ERROR">
5209	Could not parse the settings file.
5210	</result>
5211
5212	</desc>
5213	<param name="key" type="wstring" dir="in">
5214	<desc>Name of the data key to set.</desc>
5215	</param>
5216	<param name="value" type="wstring" dir="in">
5217	<desc>Value to assign to the key.</desc>
5218	</param>
5219	</method>
5220
5221	<method name="getCpuProperty" const="yes">
5222	<desc>
5223	Returns the virtual CPU boolean value of the specified property.
5224
5225	<result name="E_INVALIDARG">
5226	Invalid property.
5227	</result>
5228
5229	</desc>
5230	<param name="property" type="CpuPropertyType" dir="in">
5231	<desc>
5232	Property type to query.
5233	</desc>
5234	</param>
5235	<param name="value" type="boolean" dir="return">
5236	<desc>
5237	Property value.
5238	</desc>
5239	</param>
5240	</method>
5241
5242	<method name="setCpuProperty">
5243	<desc>
5244	Sets the virtual CPU boolean value of the specified property.
5245
5246	<result name="E_INVALIDARG">
5247	Invalid property.
5248	</result>
5249
5250	</desc>
5251	<param name="property" type="CpuPropertyType" dir="in">
5252	<desc>
5253	Property type to query.
5254	</desc>
5255	</param>
5256	<param name="value" type="boolean" dir="in">
5257	<desc>
5258	Property value.
5259	</desc>
5260	</param>
5261	</method>
5262
5263	<method name="getCpuIdLeaf" const="yes">
5264	<desc>
5265	Returns the virtual CPU cpuid information for the specified leaf.
5266
5267	Currently supported index values for cpuid:
5268	Standard CPUID leafs: 0 - 0xA
5269	Extended CPUID leafs: 0x80000000 - 0x8000000A
5270
5271	See the Intel and AMD programmer's manuals for detailed information
5272	about the cpuid instruction and its leafs.
5273	<result name="E_INVALIDARG">
5274	Invalid id.
5275	</result>
5276
5277	</desc>
5278	<param name="id" type="unsigned long" dir="in">
5279	<desc>
5280	Cpuid leaf index.
5281	</desc>
5282	</param>
5283	<param name="valEax" type="unsigned long" dir="out">
5284	<desc>
5285	Cpuid leaf value for register eax.
5286	</desc>
5287	</param>
5288	<param name="valEbx" type="unsigned long" dir="out">
5289	<desc>
5290	Cpuid leaf value for register ebx.
5291	</desc>
5292	</param>
5293	<param name="valEcx" type="unsigned long" dir="out">
5294	<desc>
5295	Cpuid leaf value for register ecx.
5296	</desc>
5297	</param>
5298	<param name="valEdx" type="unsigned long" dir="out">
5299	<desc>
5300	Cpuid leaf value for register edx.
5301	</desc>
5302	</param>
5303	</method>
5304
5305	<method name="setCpuIdLeaf" const="yes">
5306	<desc>
5307	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5308	are not passed unmodified. VirtualBox clears features that it doesn't support.
5309
5310	Currently supported index values for cpuid:
5311	Standard CPUID leafs: 0 - 0xA
5312	Extended CPUID leafs: 0x80000000 - 0x8000000A
5313
5314	See the Intel and AMD programmer's manuals for detailed information
5315	about the cpuid instruction and its leafs.
5316
5317	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5318	random crashes inside VMs.
5319	<result name="E_INVALIDARG">
5320	Invalid id.
5321	</result>
5322
5323	</desc>
5324	<param name="id" type="unsigned long" dir="in">
5325	<desc>
5326	Cpuid leaf index.
5327	</desc>
5328	</param>
5329	<param name="valEax" type="unsigned long" dir="in">
5330	<desc>
5331	Cpuid leaf value for register eax.
5332	</desc>
5333	</param>
5334	<param name="valEbx" type="unsigned long" dir="in">
5335	<desc>
5336	Cpuid leaf value for register ebx.
5337	</desc>
5338	</param>
5339	<param name="valEcx" type="unsigned long" dir="in">
5340	<desc>
5341	Cpuid leaf value for register ecx.
5342	</desc>
5343	</param>
5344	<param name="valEdx" type="unsigned long" dir="in">
5345	<desc>
5346	Cpuid leaf value for register edx.
5347	</desc>
5348	</param>
5349	</method>
5350
5351	<method name="removeCpuIdLeaf" const="yes">
5352	<desc>
5353	Removes the virtual CPU cpuid leaf for the specified index
5354
5355	<result name="E_INVALIDARG">
5356	Invalid id.
5357	</result>
5358
5359	</desc>
5360	<param name="id" type="unsigned long" dir="in">
5361	<desc>
5362	Cpuid leaf index.
5363	</desc>
5364	</param>
5365	</method>
5366
5367	<method name="removeAllCpuIdLeafs" const="yes">
5368	<desc>
5369	Removes all the virtual CPU cpuid leafs
5370	</desc>
5371	</method>
5372
5373	<method name="getHWVirtExProperty" const="yes">
5374	<desc>
5375	Returns the value of the specified hardware virtualization boolean property.
5376
5377	<result name="E_INVALIDARG">
5378	Invalid property.
5379	</result>
5380
5381	</desc>
5382	<param name="property" type="HWVirtExPropertyType" dir="in">
5383	<desc>
5384	Property type to query.
5385	</desc>
5386	</param>
5387	<param name="value" type="boolean" dir="return">
5388	<desc>
5389	Property value.
5390	</desc>
5391	</param>
5392	</method>
5393
5394	<method name="setHWVirtExProperty">
5395	<desc>
5396	Sets a new value for the specified hardware virtualization boolean property.
5397
5398	<result name="E_INVALIDARG">
5399	Invalid property.
5400	</result>
5401
5402	</desc>
5403	<param name="property" type="HWVirtExPropertyType" dir="in">
5404	<desc>
5405	Property type to set.
5406	</desc>
5407	</param>
5408	<param name="value" type="boolean" dir="in">
5409	<desc>
5410	New property value.
5411	</desc>
5412	</param>
5413	</method>
5414
5415	<method name="saveSettings">
5416	<desc>
5417	Saves any changes to machine settings made since the session
5418	has been opened or a new machine has been created, or since the
5419	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5420	For registered machines, new settings become visible to all
5421	other VirtualBox clients after successful invocation of this
5422	method.
5423	<note>
5424	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5425	notification event after the configuration has been successfully
5426	saved (only for registered machines).
5427	</note>
5428	<note>
5429	Calling this method is only valid on instances returned
5430	by <link to="ISession::machine"/> and on new machines
5431	created by <link to="IVirtualBox::createMachine"/> but not
5432	yet registered, or on unregistered machines after calling
5433	<link to="IVirtualBox::unregisterMachine"/>.
5434	</note>
5435
5436	<result name="VBOX_E_FILE_ERROR">
5437	Settings file not accessible.
5438	</result>
5439	<result name="VBOX_E_XML_ERROR">
5440	Could not parse the settings file.
5441	</result>
5442	<result name="E_ACCESSDENIED">
5443	Modification request refused.
5444	</result>
5445
5446	</desc>
5447	</method>
5448
5449	<method name="discardSettings">
5450	<desc>
5451	Discards any changes to the machine settings made since the session
5452	has been opened or since the last call to <link to="#saveSettings"/>
5453	or <link to="#discardSettings"/>.
5454	<note>
5455	Calling this method is only valid on instances returned
5456	by <link to="ISession::machine"/> and on new machines
5457	created by <link to="IVirtualBox::createMachine"/> or
5458	opened by <link to="IVirtualBox::openMachine"/> but not
5459	yet registered, or on unregistered machines after calling
5460	<link to="IVirtualBox::unregisterMachine"/>.
5461	</note>
5462
5463	<result name="VBOX_E_INVALID_VM_STATE">
5464	Virtual machine is not mutable.
5465	</result>
5466
5467	</desc>
5468	</method>
5469
5470	<method name="deleteSettings">
5471	<desc>
5472	Deletes the settings file of this machine from disk.
5473	The machine must not be registered in order for this operation
5474	to succeed.
5475	<note>
5476	<link to="#settingsModified"/> will return @c true after this
5477	method successfully returns.
5478	</note>
5479	<note>
5480	Calling this method is only valid on instances returned
5481	by <link to="ISession::machine"/> and on new machines
5482	created by <link to="IVirtualBox::createMachine"/> or
5483	opened by <link to="IVirtualBox::openMachine"/> but not
5484	yet registered, or on unregistered machines after calling
5485	<link to="IVirtualBox::unregisterMachine"/>.
5486	</note>
5487	<note>
5488	The deleted machine settings file can be restored (saved again)
5489	by calling <link to="#saveSettings"/>.
5490	</note>
5491
5492	<result name="VBOX_E_INVALID_VM_STATE">
5493	Cannot delete settings of a registered machine or
5494	machine not mutable.
5495	</result>
5496	<result name="VBOX_E_IPRT_ERROR">
5497	Could not delete the settings file.
5498	</result>
5499
5500	</desc>
5501	</method>
5502
5503	<method name="export">
5504	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5505	steps required to export VirtualBox machines to OVF.
5506	</desc>
5507
5508	<param name="aAppliance" type="IAppliance" dir="in">
5509	<desc>Appliance to export this machine to.</desc>
5510	</param>
5511	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5512	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5513	</param>
5514	</method >
5515
5516	<method name="getSnapshot">
5517	<desc>
5518	Returns a snapshot of this machine with the given UUID.
5519	A @c null UUID can be used to obtain the first snapshot
5520	taken on this machine. This is useful if you want to traverse
5521	the whole tree of snapshots starting from the root.
5522
5523	<result name="VBOX_E_OBJECT_NOT_FOUND">
5524	Virtual machine has no snapshots or snapshot not found.
5525	</result>
5526
5527	</desc>
5528	<param name="id" type="uuid" mod="string" dir="in">
5529	<desc>UUID of the snapshot to get</desc>
5530	</param>
5531	<param name="snapshot" type="ISnapshot" dir="return">
5532	<desc>Snapshot object with the given UUID.</desc>
5533	</param>
5534	</method>
5535
5536	<method name="findSnapshot">
5537	<desc>
5538	Returns a snapshot of this machine with the given name.
5539
5540	<result name="VBOX_E_OBJECT_NOT_FOUND">
5541	Virtual machine has no snapshots or snapshot not found.
5542	</result>
5543
5544	</desc>
5545	<param name="name" type="wstring" dir="in">
5546	<desc>Name of the snapshot to find</desc>
5547	</param>
5548	<param name="snapshot" type="ISnapshot" dir="return">
5549	<desc>Snapshot object with the given name.</desc>
5550	</param>
5551	</method>
5552
5553	<method name="setCurrentSnapshot">
5554	<desc>
5555	Sets the current snapshot of this machine.
5556	<note>
5557	In the current implementation, this operation is not
5558	implemented.
5559	</note>
5560	</desc>
5561	<param name="id" type="uuid" mod="string" dir="in">
5562	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5563	</param>
5564	</method>
5565
5566	<method name="createSharedFolder">
5567	<desc>
5568	Creates a new permanent shared folder by associating the given logical
5569	name with the given host path, adds it to the collection of shared
5570	folders and starts sharing it. Refer to the description of
5571	<link to="ISharedFolder"/> to read more about logical names.
5572
5573	<result name="VBOX_E_OBJECT_IN_USE">
5574	Shared folder already exists.
5575	</result>
5576	<result name="VBOX_E_FILE_ERROR">
5577	Shared folder @a hostPath not accessible.
5578	</result>
5579
5580	</desc>
5581	<param name="name" type="wstring" dir="in">
5582	<desc>Unique logical name of the shared folder.</desc>
5583	</param>
5584	<param name="hostPath" type="wstring" dir="in">
5585	<desc>Full path to the shared folder in the host file system.</desc>
5586	</param>
5587	<param name="writable" type="boolean" dir="in">
5588	<desc>Whether the share is writable or readonly</desc>
5589	</param>
5590	</method>
5591
5592	<method name="removeSharedFolder">
5593	<desc>
5594	Removes the permanent shared folder with the given name previously
5595	created by <link to="#createSharedFolder"/> from the collection of
5596	shared folders and stops sharing it.
5597
5598	<result name="VBOX_E_INVALID_VM_STATE">
5599	Virtual machine is not mutable.
5600	</result>
5601	<result name="VBOX_E_OBJECT_NOT_FOUND">
5602	Shared folder @a name does not exist.
5603	</result>
5604
5605	</desc>
5606	<param name="name" type="wstring" dir="in">
5607	<desc>Logical name of the shared folder to remove.</desc>
5608	</param>
5609	</method>
5610
5611	<method name="canShowConsoleWindow">
5612	<desc>
5613	Returns @c true if the VM console process can activate the
5614	console window and bring it to foreground on the desktop of
5615	the host PC.
5616	<note>
5617	This method will fail if a session for this machine is not
5618	currently open.
5619	</note>
5620
5621	<result name="VBOX_E_INVALID_VM_STATE">
5622	Machine session is not open.
5623	</result>
5624
5625	</desc>
5626	<param name="canShow" type="boolean" dir="return">
5627	<desc>
5628	@c true if the console window can be shown and @c false otherwise.
5629	</desc>
5630	</param>
5631	</method>
5632
5633	<method name="showConsoleWindow">
5634	<desc>
5635	Activates the console window and brings it to foreground on
5636	the desktop of the host PC. Many modern window managers on
5637	many platforms implement some sort of focus stealing
5638	prevention logic, so that it may be impossible to activate
5639	a window without the help of the currently active
5640	application. In this case, this method will return a non-zero
5641	identifier that represents the top-level window of the VM
5642	console process. The caller, if it represents a currently
5643	active process, is responsible to use this identifier (in a
5644	platform-dependent manner) to perform actual window
5645	activation.
5646	<note>
5647	This method will fail if a session for this machine is not
5648	currently open.
5649	</note>
5650
5651	<result name="VBOX_E_INVALID_VM_STATE">
5652	Machine session is not open.
5653	</result>
5654
5655	</desc>
5656	<param name="winId" type="unsigned long long" dir="return">
5657	<desc>
5658	Platform-dependent identifier of the top-level VM console
5659	window, or zero if this method has performed all actions
5660	necessary to implement the <i>show window</i> semantics for
5661	the given platform and/or VirtualBox front-end.
5662	</desc>
5663	</param>
5664	</method>
5665
5666	<method name="getGuestProperty">
5667	<desc>
5668	Reads an entry from the machine's guest property store.
5669
5670	<result name="VBOX_E_INVALID_VM_STATE">
5671	Machine session is not open.
5672	</result>
5673
5674	</desc>
5675	<param name="name" type="wstring" dir="in">
5676	<desc>
5677	The name of the property to read.
5678	</desc>
5679	</param>
5680	<param name="value" type="wstring" dir="out">
5681	<desc>
5682	The value of the property. If the property does not exist then this
5683	will be empty.
5684	</desc>
5685	</param>
5686	<param name="timestamp" type="unsigned long long" dir="out">
5687	<desc>
5688	The time at which the property was last modified, as seen by the
5689	server process.
5690	</desc>
5691	</param>
5692	<param name="flags" type="wstring" dir="out">
5693	<desc>
5694	Additional property parameters, passed as a comma-separated list of
5695	"name=value" type entries.
5696	</desc>
5697	</param>
5698	</method>
5699
5700	<method name="getGuestPropertyValue">
5701	<desc>
5702	Reads a value from the machine's guest property store.
5703
5704	<result name="VBOX_E_INVALID_VM_STATE">
5705	Machine session is not open.
5706	</result>
5707
5708	</desc>
5709	<param name="property" type="wstring" dir="in">
5710	<desc>
5711	The name of the property to read.
5712	</desc>
5713	</param>
5714	<param name="value" type="wstring" dir="return">
5715	<desc>
5716	The value of the property. If the property does not exist then this
5717	will be empty.
5718	</desc>
5719	</param>
5720	</method>
5721
5722	<method name="getGuestPropertyTimestamp">
5723	<desc>
5724	Reads a property timestamp from the machine's guest property store.
5725
5726	<result name="VBOX_E_INVALID_VM_STATE">
5727	Machine session is not open.
5728	</result>
5729
5730	</desc>
5731	<param name="property" type="wstring" dir="in">
5732	<desc>
5733	The name of the property to read.
5734	</desc>
5735	</param>
5736	<param name="value" type="unsigned long long" dir="return">
5737	<desc>
5738	The timestamp. If the property does not exist then this will be
5739	empty.
5740	</desc>
5741	</param>
5742	</method>
5743
5744	<method name="setGuestProperty">
5745	<desc>
5746	Sets, changes or deletes an entry in the machine's guest property
5747	store.
5748
5749	<result name="E_ACCESSDENIED">
5750	Property cannot be changed.
5751	</result>
5752	<result name="E_INVALIDARG">
5753	Invalid @a flags.
5754	</result>
5755	<result name="VBOX_E_INVALID_VM_STATE">
5756	Virtual machine is not mutable or session not open.
5757	</result>
5758	<result name="VBOX_E_INVALID_OBJECT_STATE">
5759	Cannot set transient property when machine not running.
5760	</result>
5761
5762	</desc>
5763	<param name="property" type="wstring" dir="in">
5764	<desc>
5765	The name of the property to set, change or delete.
5766	</desc>
5767	</param>
5768	<param name="value" type="wstring" dir="in">
5769	<desc>
5770	The new value of the property to set, change or delete. If the
5771	property does not yet exist and value is non-empty, it will be
5772	created. If the value is @c null or empty, the property will be
5773	deleted if it exists.
5774	</desc>
5775	</param>
5776	<param name="flags" type="wstring" dir="in">
5777	<desc>
5778	Additional property parameters, passed as a comma-separated list of
5779	"name=value" type entries.
5780	</desc>
5781	</param>
5782	</method>
5783
5784	<method name="setGuestPropertyValue">
5785	<desc>
5786	Sets, changes or deletes a value in the machine's guest property
5787	store. The flags field will be left unchanged or created empty for a
5788	new property.
5789
5790	<result name="E_ACCESSDENIED">
5791	Property cannot be changed.
5792	</result>
5793	<result name="VBOX_E_INVALID_VM_STATE">
5794	Virtual machine is not mutable or session not open.
5795	</result>
5796	<result name="VBOX_E_INVALID_OBJECT_STATE">
5797	Cannot set transient property when machine not running.
5798	</result>
5799	</desc>
5800
5801	<param name="property" type="wstring" dir="in">
5802	<desc>
5803	The name of the property to set, change or delete.
5804	</desc>
5805	</param>
5806	<param name="value" type="wstring" dir="in">
5807	<desc>
5808	The new value of the property to set, change or delete. If the
5809	property does not yet exist and value is non-empty, it will be
5810	created. If the value is @c null or empty, the property will be
5811	deleted if it exists.
5812	</desc>
5813	</param>
5814	</method>
5815
5816	<method name="enumerateGuestProperties">
5817	<desc>
5818	Return a list of the guest properties matching a set of patterns along
5819	with their values, time stamps and flags.
5820	</desc>
5821	<param name="patterns" type="wstring" dir="in">
5822	<desc>
5823	The patterns to match the properties against, separated by '\|'
5824	characters. If this is empty or @c null, all properties will match.
5825	</desc>
5826	</param>
5827	<param name="name" type="wstring" dir="out" safearray="yes">
5828	<desc>
5829	The names of the properties returned.
5830	</desc>
5831	</param>
5832	<param name="value" type="wstring" dir="out" safearray="yes">
5833	<desc>
5834	The values of the properties returned. The array entries match the
5835	corresponding entries in the @a name array.
5836	</desc>
5837	</param>
5838	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5839	<desc>
5840	The time stamps of the properties returned. The array entries match
5841	the corresponding entries in the @a name array.
5842	</desc>
5843	</param>
5844	<param name="flags" type="wstring" dir="out" safearray="yes">
5845	<desc>
5846	The flags of the properties returned. The array entries match the
5847	corresponding entries in the @a name array.
5848	</desc>
5849	</param>
5850	</method>
5851
5852	<method name="querySavedThumbnailSize">
5853	<desc>
5854	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5855	</desc>
5856	<param name="size" type="unsigned long" dir="out">
5857	<desc>
5858	Size of buffer required to store the bitmap.
5859	</desc>
5860	</param>
5861	<param name="width" type="unsigned long" dir="out">
5862	<desc>
5863	Bitmap width.
5864	</desc>
5865	</param>
5866	<param name="height" type="unsigned long" dir="out">
5867	<desc>
5868	Bitmap height.
5869	</desc>
5870	</param>
5871	</method>
5872
5873	<method name="readSavedThumbnailToArray">
5874	<desc>
5875	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5876	</desc>
5877	<param name="BGR" type="boolean" dir="in">
5878	<desc>
5879	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5880	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5881	</desc>
5882	</param>
5883	<param name="width" type="unsigned long" dir="out">
5884	<desc>
5885	Bitmap width.
5886	</desc>
5887	</param>
5888	<param name="height" type="unsigned long" dir="out">
5889	<desc>
5890	Bitmap height.
5891	</desc>
5892	</param>
5893	<param name="data" type="octet" dir="return" safearray="yes">
5894	<desc>
5895	Array with resulting bitmap data.
5896	</desc>
5897	</param>
5898	</method>
5899
5900	<method name="querySavedScreenshotPNGSize">
5901	<desc>
5902	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5903	</desc>
5904	<param name="size" type="unsigned long" dir="out">
5905	<desc>
5906	Size of buffer required to store the PNG binary data.
5907	</desc>
5908	</param>
5909	<param name="width" type="unsigned long" dir="out">
5910	<desc>
5911	Image width.
5912	</desc>
5913	</param>
5914	<param name="height" type="unsigned long" dir="out">
5915	<desc>
5916	Image height.
5917	</desc>
5918	</param>
5919	</method>
5920
5921	<method name="readSavedScreenshotPNGToArray">
5922	<desc>
5923	Screenshot in PNG format is retrieved to an array of bytes.
5924	</desc>
5925	<param name="width" type="unsigned long" dir="out">
5926	<desc>
5927	Image width.
5928	</desc>
5929	</param>
5930	<param name="height" type="unsigned long" dir="out">
5931	<desc>
5932	Image height.
5933	</desc>
5934	</param>
5935	<param name="data" type="octet" dir="return" safearray="yes">
5936	<desc>
5937	Array with resulting PNG data.
5938	</desc>
5939	</param>
5940	</method>
5941
5942	<method name="HotPlugCPU">
5943	<desc>
5944	Plugs a CPU into the machine.
5945	</desc>
5946	<param name="cpu" type="unsigned long" dir="in">
5947	<desc>
5948	The CPU id to insert.
5949	</desc>
5950	</param>
5951	</method>
5952
5953	<method name="HotUnplugCPU">
5954	<desc>
5955	Removes a CPU from the machine.
5956	</desc>
5957	<param name="cpu" type="unsigned long" dir="in">
5958	<desc>
5959	The CPU id to remove.
5960	</desc>
5961	</param>
5962	</method>
5963
5964	<method name="GetCPUStatus">
5965	<desc>
5966	Plugs a CPU into the machine.
5967	</desc>
5968	<param name="cpu" type="unsigned long" dir="in">
5969	<desc>
5970	The CPU id to check for.
5971	</desc>
5972	</param>
5973	<param name="attached" type="boolean" dir="return">
5974	<desc>
5975	Status of the CPU.
5976	</desc>
5977	</param>
5978	</method>
5979	</interface>
5980
5981	<!--
5982	// IConsole
5983	/////////////////////////////////////////////////////////////////////////
5984	-->
5985
5986	<interface
5987	name="IConsoleCallback" extends="$unknown"
5988	uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
5989	wsmap="suppress"
5990	>
5991
5992	<desc>
5993	This interface is used by a client of the Main API that need to
5994	be notified of events. For example, a graphical user interface
5995	can use this to learn about machine state changes so they can
5996	update the list of virtual machines without having to rely
5997	on polling.
5998
5999	Whenever relevant events occur in VirtualBox, the callbacks in
6000	objects of this interface are called. In order for this to be
6001	useful, a client needs to create its own subclass that implements
6002	this interface in which the methods for the relevant callbacks
6003	are overridden. An instance of this subclass interface can then
6004	be passed to <link to="IConsole::registerCallback" />.
6005	</desc>
6006
6007	<method name="onMousePointerShapeChange">
6008	<desc>
6009	Notification when the guest mouse pointer shape has
6010	changed. The new shape data is given.
6011	</desc>
6012	<param name="visible" type="boolean" dir="in">
6013	<desc>
6014	Flag whether the pointer is visible.
6015	</desc>
6016	</param>
6017	<param name="alpha" type="boolean" dir="in">
6018	<desc>
6019	Flag whether the pointer has an alpha channel.
6020	</desc>
6021	</param>
6022	<param name="xHot" type="unsigned long" dir="in">
6023	<desc>
6024	The pointer hot spot x coordinate.
6025	</desc>
6026	</param>
6027	<param name="yHot" type="unsigned long" dir="in">
6028	<desc>
6029	The pointer hot spot y coordinate.
6030	</desc>
6031	</param>
6032	<param name="width" type="unsigned long" dir="in">
6033	<desc>
6034	Width of the pointer shape in pixels.
6035	</desc>
6036	</param>
6037	<param name="height" type="unsigned long" dir="in">
6038	<desc>
6039	Height of the pointer shape in pixels.
6040	</desc>
6041	</param>
6042	<param name="shape" type="octet" mod="ptr" dir="in">
6043	<desc>
6044	Address of the shape buffer.
6045
6046	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
6047	followed by a 32-bpp XOR (color) mask.
6048
6049	For pointers without alpha channel the XOR mask pixels are 32
6050	bit values: (lsb)BGR0(msb). For pointers with alpha channel
6051	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
6052
6053	An AND mask is used for pointers with alpha channel, so if the
6054	callback does not support alpha, the pointer could be
6055	displayed as a normal color pointer.
6056
6057	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
6058	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
6059	height</tt>. The padding bits at the end of each scanline are
6060	undefined.
6061
6062	The XOR mask follows the AND mask on the next 4-byte aligned
6063	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
6064	Bytes in the gap between the AND and the XOR mask are undefined.
6065	The XOR mask scanlines have no gap between them and the size of
6066	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
6067
6068	<note>
6069	If @a shape is 0, only the pointer visibility is changed.
6070	</note>
6071	</desc>
6072	</param>
6073	</method>
6074
6075	<method name="onMouseCapabilityChange">
6076	<desc>
6077	Notification when the mouse capabilities reported by the
6078	guest have changed. The new capabilities are passed.
6079	</desc>
6080	<param name="supportsAbsolute" type="boolean" dir="in"/>
6081	<param name="needsHostCursor" type="boolean" dir="in"/>
6082	</method>
6083
6084	<method name="onKeyboardLedsChange">
6085	<desc>
6086	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6087	to alter the state of the keyboard LEDs.
6088	</desc>
6089	<param name="numLock" type="boolean" dir="in"/>
6090	<param name="capsLock" type="boolean" dir="in"/>
6091	<param name="scrollLock" type="boolean" dir="in"/>
6092	</method>
6093
6094	<method name="onStateChange">
6095	<desc>
6096	Notification when the execution state of the machine has changed.
6097	The new state will be given.
6098	</desc>
6099	<param name="state" type="MachineState" dir="in"/>
6100	</method>
6101
6102	<method name="onAdditionsStateChange">
6103	<desc>
6104	Notification when a Guest Additions property changes.
6105	Interested callees should query IGuest attributes to
6106	find out what has changed.
6107	</desc>
6108	</method>
6109
6110	<method name="onNetworkAdapterChange">
6111	<desc>
6112	Notification when a property of one of the
6113	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6114	changes. Interested callees should use INetworkAdapter methods and
6115	attributes to find out what has changed.
6116	</desc>
6117	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6118	<desc>Network adapter that is subject to change.</desc>
6119	</param>
6120	</method>
6121
6122	<method name="onSerialPortChange">
6123	<desc>
6124	Notification when a property of one of the
6125	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6126	Interested callees should use ISerialPort methods and attributes
6127	to find out what has changed.
6128	</desc>
6129	<param name="serialPort" type="ISerialPort" dir="in">
6130	<desc>Serial port that is subject to change.</desc>
6131	</param>
6132	</method>
6133
6134	<method name="onParallelPortChange">
6135	<desc>
6136	Notification when a property of one of the
6137	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6138	changes. Interested callees should use ISerialPort methods and
6139	attributes to find out what has changed.
6140	</desc>
6141	<param name="parallelPort" type="IParallelPort" dir="in">
6142	<desc>Parallel port that is subject to change.</desc>
6143	</param>
6144	</method>
6145
6146	<method name="onStorageControllerChange">
6147	<desc>
6148	Notification when a property of one of the
6149	virtual <link to="IMachine::storageControllers">storage controllers</link>
6150	changes. Interested callees should query the corresponding collections
6151	to find out what has changed.
6152	</desc>
6153	</method>
6154
6155	<method name="onMediumChange">
6156	<desc>
6157	Notification when a
6158	<link to="IMachine::mediumAttachments">medium attachment</link>
6159	changes.
6160	</desc>
6161	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6162	<desc>Medium attachment that is subject to change.</desc>
6163	</param>
6164	</method>
6165
6166	<method name="onCPUChange">
6167	<desc>
6168	Notification when a CPU changes.
6169	</desc>
6170	<param name="cpu" type="unsigned long" dir="in">
6171	<desc>The CPU which changed</desc>
6172	</param>
6173	<param name="add" type="boolean" dir="in">
6174	<desc>Flag whether the CPU was added or removed</desc>
6175	</param>
6176	</method>
6177
6178	<method name="onVRDPServerChange">
6179	<desc>
6180	Notification when a property of the
6181	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6182	Interested callees should use IVRDPServer methods and attributes to
6183	find out what has changed.
6184	</desc>
6185	</method>
6186
6187	<method name="onRemoteDisplayInfoChange">
6188	<desc>
6189	Notification when the status of the VRDP server changes. Interested callees
6190	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6191	attributes to find out what is the current status.
6192	</desc>
6193	</method>
6194
6195	<method name="onUSBControllerChange">
6196	<desc>
6197	Notification when a property of the virtual
6198	<link to="IMachine::USBController">USB controller</link> changes.
6199	Interested callees should use IUSBController methods and attributes to
6200	find out what has changed.
6201	</desc>
6202	</method>
6203
6204	<method name="onUSBDeviceStateChange">
6205	<desc>
6206	Notification when a USB device is attached to or detached from
6207	the virtual USB controller.
6208
6209	This notification is sent as a result of the indirect
6210	request to attach the device because it matches one of the
6211	machine USB filters, or as a result of the direct request
6212	issued by <link to="IConsole::attachUSBDevice"/> or
6213	<link to="IConsole::detachUSBDevice"/>.
6214
6215	This notification is sent in case of both a succeeded and a
6216	failed request completion. When the request succeeds, the
6217	@a error parameter is @c null, and the given device has been
6218	already added to (when @a attached is @c true) or removed from
6219	(when @a attached is @c false) the collection represented by
6220	<link to="IConsole::USBDevices"/>. On failure, the collection
6221	doesn't change and the @a error parameter represents the error
6222	message describing the failure.
6223
6224	</desc>
6225	<param name="device" type="IUSBDevice" dir="in">
6226	<desc>Device that is subject to state change.</desc>
6227	</param>
6228	<param name="attached" type="boolean" dir="in">
6229	<desc>
6230	@c true if the device was attached and @c false otherwise.
6231	</desc>
6232	</param>
6233	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6234	<desc>
6235	@c null on success or an error message object on failure.
6236	</desc>
6237	</param>
6238	</method>
6239
6240	<method name="onSharedFolderChange">
6241	<desc>
6242	Notification when a shared folder is added or removed.
6243	The @a scope argument defines one of three scopes:
6244	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6245	(<link to="Scope_Global">Global</link>),
6246	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6247	the machine (<link to="Scope_Machine">Machine</link>) or <link
6248	to="IConsole::sharedFolders">transient shared folders</link> of the
6249	machine (<link to="Scope_Session">Session</link>). Interested callees
6250	should use query the corresponding collections to find out what has
6251	changed.
6252	</desc>
6253	<param name="scope" type="Scope" dir="in">
6254	<desc>Scope of the notification.</desc>
6255	</param>
6256	</method>
6257
6258	<method name="onRuntimeError">
6259	<desc>
6260	Notification when an error happens during the virtual
6261	machine execution.
6262
6263	There are three kinds of runtime errors:
6264	<ul>
6265	<li><i>fatal</i></li>
6266	<li><i>non-fatal with retry</i></li>
6267	<li><i>non-fatal warnings</i></li>
6268	</ul>
6269
6270	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6271	to @c true. In case of fatal errors, the virtual machine
6272	execution is always paused before calling this notification, and
6273	the notification handler is supposed either to immediately save
6274	the virtual machine state using <link to="IConsole::saveState"/>
6275	or power it off using <link to="IConsole::powerDown"/>.
6276	Resuming the execution can lead to unpredictable results.
6277
6278	<b>Non-fatal</b> errors and warnings are indicated by the
6279	@a fatal parameter set to @c false. If the virtual machine
6280	is in the Paused state by the time the error notification is
6281	received, it means that the user can <i>try to resume</i> the machine
6282	execution after attempting to solve the problem that caused the
6283	error. In this case, the notification handler is supposed
6284	to show an appropriate message to the user (depending on the
6285	value of the @a id parameter) that offers several actions such
6286	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6287	wants to retry, the notification handler should continue
6288	the machine execution using the <link to="IConsole::resume"/>
6289	call. If the machine execution is not Paused during this
6290	notification, then it means this notification is a <i>warning</i>
6291	(for example, about a fatal condition that can happen very soon);
6292	no immediate action is required from the user, the machine
6293	continues its normal execution.
6294
6295	Note that in either case the notification handler
6296	<b>must not</b> perform any action directly on a thread
6297	where this notification is called. Everything it is allowed to
6298	do is to post a message to another thread that will then talk
6299	to the user and take the corresponding action.
6300
6301	Currently, the following error identifiers are known:
6302	<ul>
6303	<li><tt>"HostMemoryLow"</tt></li>
6304	<li><tt>"HostAudioNotResponding"</tt></li>
6305	<li><tt>"VDIStorageFull"</tt></li>
6306	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6307	</ul>
6308
6309	<note>
6310	This notification is not designed to be implemented by
6311	more than one callback at a time. If you have multiple
6312	IConsoleCallback instances registered on the given
6313	IConsole object, make sure you simply do nothing but
6314	return @c S_OK from all but one of them that does actual
6315	user notification and performs necessary actions.
6316	</note>
6317
6318	</desc>
6319	<param name="fatal" type="boolean" dir="in">
6320	<desc>Whether the error is fatal or not</desc>
6321	</param>
6322	<param name="id" type="wstring" dir="in">
6323	<desc>Error identifier</desc>
6324	</param>
6325	<param name="message" type="wstring" dir="in">
6326	<desc>Optional error message</desc>
6327	</param>
6328	</method>
6329
6330	<method name="onCanShowWindow">
6331	<desc>
6332	Notification when a call to
6333	<link to="IMachine::canShowConsoleWindow"/> is made by a
6334	front-end to check if a subsequent call to
6335	<link to="IMachine::showConsoleWindow"/> can succeed.
6336
6337	The callee should give an answer appropriate to the current
6338	machine state in the @a canShow argument. This answer must
6339	remain valid at least until the next
6340	<link to="IConsole::state">machine state</link> change.
6341
6342	<note>
6343	This notification is not designed to be implemented by
6344	more than one callback at a time. If you have multiple
6345	IConsoleCallback instances registered on the given
6346	IConsole object, make sure you simply do nothing but
6347	return @c true and @c S_OK from all but one of them that
6348	actually manages console window activation.
6349	</note>
6350	</desc>
6351	<param name="canShow" type="boolean" dir="return">
6352	<desc>
6353	@c true if the console window can be shown and @c false otherwise.
6354	</desc>
6355	</param>
6356	</method>
6357
6358	<method name="onShowWindow">
6359	<desc>
6360	Notification when a call to
6361	<link to="IMachine::showConsoleWindow"/>
6362	requests the console window to be activated and brought to
6363	foreground on the desktop of the host PC.
6364
6365	This notification should cause the VM console process to
6366	perform the requested action as described above. If it is
6367	impossible to do it at a time of this notification, this
6368	method should return a failure.
6369
6370	Note that many modern window managers on many platforms
6371	implement some sort of focus stealing prevention logic, so
6372	that it may be impossible to activate a window without the
6373	help of the currently active application (which is supposedly
6374	an initiator of this notification). In this case, this method
6375	must return a non-zero identifier that represents the
6376	top-level window of the VM console process. The caller, if it
6377	represents a currently active process, is responsible to use
6378	this identifier (in a platform-dependent manner) to perform
6379	actual window activation.
6380
6381	This method must set @a winId to zero if it has performed all
6382	actions necessary to complete the request and the console
6383	window is now active and in foreground, to indicate that no
6384	further action is required on the caller's side.
6385
6386	<note>
6387	This notification is not designed to be implemented by
6388	more than one callback at a time. If you have multiple
6389	IConsoleCallback instances registered on the given
6390	IConsole object, make sure you simply do nothing but
6391	return @c S_OK from all but one of them that actually
6392	manages console window activation.
6393	</note>
6394	</desc>
6395	<param name="winId" type="unsigned long long" dir="return">
6396	<desc>
6397	Platform-dependent identifier of the top-level VM console
6398	window, or zero if this method has performed all actions
6399	necessary to implement the <i>show window</i> semantics for
6400	the given platform and/or this VirtualBox front-end.
6401	</desc>
6402	</param>
6403	</method>
6404
6405	</interface>
6406
6407	<interface
6408	name="IRemoteDisplayInfo" extends="$unknown"
6409	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6410	wsmap="struct"
6411	>
6412	<desc>
6413	Contains information about the remote display (VRDP) capabilities and status.
6414	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6415	</desc>
6416
6417	<attribute name="active" type="boolean" readonly="yes">
6418	<desc>
6419	Whether the remote display connection is active.
6420	</desc>
6421	</attribute>
6422
6423	<attribute name="port" type="long" readonly="yes">
6424	<desc>
6425	VRDP server port number. If this property is equal to <tt>0</tt>, then
6426	the VRDP server failed to start, usually because there are no free TCP
6427	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6428	server has not yet been started.
6429	</desc>
6430	</attribute>
6431
6432	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6433	<desc>
6434	How many times a client connected.
6435	</desc>
6436	</attribute>
6437
6438	<attribute name="beginTime" type="long long" readonly="yes">
6439	<desc>
6440	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6441	</desc>
6442	</attribute>
6443
6444	<attribute name="endTime" type="long long" readonly="yes">
6445	<desc>
6446	When the last connection was terminated or the current time, if
6447	connection is still active, in milliseconds since 1970-01-01 UTC.
6448	</desc>
6449	</attribute>
6450
6451	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6452	<desc>
6453	How many bytes were sent in last or current, if still active, connection.
6454	</desc>
6455	</attribute>
6456
6457	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6458	<desc>
6459	How many bytes were sent in all connections.
6460	</desc>
6461	</attribute>
6462
6463	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6464	<desc>
6465	How many bytes were received in last or current, if still active, connection.
6466	</desc>
6467	</attribute>
6468
6469	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6470	<desc>
6471	How many bytes were received in all connections.
6472	</desc>
6473	</attribute>
6474
6475	<attribute name="user" type="wstring" readonly="yes">
6476	<desc>
6477	Login user name supplied by the client.
6478	</desc>
6479	</attribute>
6480
6481	<attribute name="domain" type="wstring" readonly="yes">
6482	<desc>
6483	Login domain name supplied by the client.
6484	</desc>
6485	</attribute>
6486
6487	<attribute name="clientName" type="wstring" readonly="yes">
6488	<desc>
6489	The client name supplied by the client.
6490	</desc>
6491	</attribute>
6492
6493	<attribute name="clientIP" type="wstring" readonly="yes">
6494	<desc>
6495	The IP address of the client.
6496	</desc>
6497	</attribute>
6498
6499	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6500	<desc>
6501	The client software version number.
6502	</desc>
6503	</attribute>
6504
6505	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6506	<desc>
6507	Public key exchange method used when connection was established.
6508	Values: 0 - RDP4 public key exchange scheme.
6509	1 - X509 certificates were sent to client.
6510	</desc>
6511	</attribute>
6512
6513	</interface>
6514
6515	<interface
6516	name="IConsole" extends="$unknown"
6517	uuid="6375231a-c17c-464b-92cb-ae9e128d71c3"
6518	wsmap="managed"
6519	>
6520	<desc>
6521	The IConsole interface represents an interface to control virtual
6522	machine execution.
6523
6524	The console object that implements the IConsole interface is obtained
6525	from a session object after the session for the given machine has been
6526	opened using one of <link to="IVirtualBox::openSession"/>,
6527	<link to="IVirtualBox::openRemoteSession"/> or
6528	<link to="IVirtualBox::openExistingSession"/> methods.
6529
6530	Methods of the IConsole interface allow the caller to query the current
6531	virtual machine execution state, pause the machine or power it down, save
6532	the machine state or take a snapshot, attach and detach removable media
6533	and so on.
6534
6535	<see>ISession</see>
6536	</desc>
6537
6538	<attribute name="machine" type="IMachine" readonly="yes">
6539	<desc>
6540	Machine object this console is sessioned with.
6541	<note>
6542	This is a convenience property, it has the same value as
6543	<link to="ISession::machine"/> of the corresponding session
6544	object.
6545	</note>
6546	</desc>
6547	</attribute>
6548
6549	<attribute name="state" type="MachineState" readonly="yes">
6550	<desc>
6551	Current execution state of the machine.
6552	<note>
6553	This property always returns the same value as the corresponding
6554	property of the IMachine object this console is sessioned with.
6555	For the process that owns (executes) the VM, this is the
6556	preferable way of querying the VM state, because no IPC
6557	calls are made.
6558	</note>
6559	</desc>
6560	</attribute>
6561
6562	<attribute name="guest" type="IGuest" readonly="yes">
6563	<desc>Guest object.</desc>
6564	</attribute>
6565
6566	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6567	<desc>
6568	Virtual keyboard object.
6569	<note>
6570	If the machine is not running, any attempt to use
6571	the returned object will result in an error.
6572	</note>
6573	</desc>
6574	</attribute>
6575
6576	<attribute name="mouse" type="IMouse" readonly="yes">
6577	<desc>
6578	Virtual mouse object.
6579	<note>
6580	If the machine is not running, any attempt to use
6581	the returned object will result in an error.
6582	</note>
6583	</desc>
6584	</attribute>
6585
6586	<attribute name="display" type="IDisplay" readonly="yes">
6587	<desc>Virtual display object.
6588	<note>
6589	If the machine is not running, any attempt to use
6590	the returned object will result in an error.
6591	</note>
6592	</desc>
6593	</attribute>
6594
6595	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6596	<desc>Debugging interface.</desc>
6597	</attribute>
6598
6599	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6600	<desc>
6601	Collection of USB devices currently attached to the virtual
6602	USB controller.
6603	<note>
6604	The collection is empty if the machine is not running.
6605	</note>
6606	</desc>
6607	</attribute>
6608
6609	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6610	<desc>
6611	List of USB devices currently attached to the remote VRDP client.
6612	Once a new device is physically attached to the remote host computer,
6613	it appears in this list and remains there until detached.
6614	</desc>
6615	</attribute>
6616
6617	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6618	<desc>
6619	Collection of shared folders for the current session. These folders
6620	are called transient shared folders because they are available to the
6621	guest OS running inside the associated virtual machine only for the
6622	duration of the session (as opposed to
6623	<link to="IMachine::sharedFolders"/> which represent permanent shared
6624	folders). When the session is closed (e.g. the machine is powered down),
6625	these folders are automatically discarded.
6626
6627	New shared folders are added to the collection using
6628	<link to="#createSharedFolder"/>. Existing shared folders can be
6629	removed using <link to="#removeSharedFolder"/>.
6630	</desc>
6631	</attribute>
6632
6633	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6634	<desc>
6635	Interface that provides information on Remote Display (VRDP) connection.
6636	</desc>
6637	</attribute>
6638
6639	<method name="powerUp">
6640	<desc>
6641	Starts the virtual machine execution using the current machine
6642	state (that is, its current execution state, current settings and
6643	current storage devices).
6644
6645	If the machine is powered off or aborted, the execution will
6646	start from the beginning (as if the real hardware were just
6647	powered on).
6648
6649	If the machine is in the <link to="MachineState_Saved"/> state,
6650	it will continue its execution the point where the state has
6651	been saved.
6652
6653	<note>
6654	Unless you are trying to write a new VirtualBox front-end that
6655	performs direct machine execution (like the VirtualBox or VBoxSDL
6656	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6657	session opened by <link to="IVirtualBox::openSession"/> and use this
6658	session only to change virtual machine settings. If you simply want to
6659	start virtual machine execution using one of the existing front-ends
6660	(for example the VirtualBox GUI or headless server), simply use
6661	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6662	power up the machine automatically for you.
6663	</note>
6664
6665	<see>#saveState</see>
6666	<result name="VBOX_E_INVALID_VM_STATE">
6667	Virtual machine already running.
6668	</result>
6669	<result name="VBOX_E_HOST_ERROR">
6670	Host interface does not exist or name not set.
6671	</result>
6672	<result name="VBOX_E_FILE_ERROR">
6673	Invalid saved state file.
6674	</result>
6675	</desc>
6676	<param name="progress" type="IProgress" dir="return">
6677	<desc>Progress object to track the operation completion.</desc>
6678	</param>
6679	</method>
6680
6681	<method name="powerUpPaused">
6682	<desc>
6683	Identical to powerUp except that the VM will enter the
6684	<link to="MachineState_Paused"/> state, instead of
6685	<link to="MachineState_Running"/>.
6686
6687	<see>#powerUp</see>
6688	<result name="VBOX_E_INVALID_VM_STATE">
6689	Virtual machine already running.
6690	</result>
6691	<result name="VBOX_E_HOST_ERROR">
6692	Host interface does not exist or name not set.
6693	</result>
6694	<result name="VBOX_E_FILE_ERROR">
6695	Invalid saved state file.
6696	</result>
6697	</desc>
6698	<param name="progress" type="IProgress" dir="return">
6699	<desc>Progress object to track the operation completion.</desc>
6700	</param>
6701	</method>
6702
6703	<method name="powerDown">
6704	<desc>
6705	Initiates the power down procedure to stop the virtual machine
6706	execution.
6707
6708	The completion of the power down procedure is tracked using the returned
6709	IProgress object. After the operation is complete, the machine will go
6710	to the PoweredOff state.
6711	<result name="VBOX_E_INVALID_VM_STATE">
6712	Virtual machine must be Running, Paused or Stuck to be powered down.
6713	</result>
6714	</desc>
6715	<param name="progress" type="IProgress" dir="return">
6716	<desc>Progress object to track the operation completion.</desc>
6717	</param>
6718	</method>
6719
6720	<method name="reset">
6721	<desc>Resets the virtual machine.
6722	<result name="VBOX_E_INVALID_VM_STATE">
6723	Virtual machine not in Running state.
6724	</result>
6725	<result name="VBOX_E_VM_ERROR">
6726	Virtual machine error in reset operation.
6727	</result>
6728	</desc>
6729	</method>
6730
6731	<method name="pause">
6732	<desc>Pauses the virtual machine execution.
6733	<result name="VBOX_E_INVALID_VM_STATE">
6734	Virtual machine not in Running state.
6735	</result>
6736	<result name="VBOX_E_VM_ERROR">
6737	Virtual machine error in suspend operation.
6738	</result>
6739	</desc>
6740	</method>
6741
6742	<method name="resume">
6743	<desc>Resumes the virtual machine execution.
6744	<result name="VBOX_E_INVALID_VM_STATE">
6745	Virtual machine not in Paused state.
6746	</result>
6747	<result name="VBOX_E_VM_ERROR">
6748	Virtual machine error in resume operation.
6749	</result>
6750	</desc>
6751	</method>
6752
6753	<method name="powerButton">
6754	<desc>Sends the ACPI power button event to the guest.
6755	<result name="VBOX_E_INVALID_VM_STATE">
6756	Virtual machine not in Running state.
6757	</result>
6758	<result name="VBOX_E_PDM_ERROR">
6759	Controlled power off failed.
6760	</result>
6761	</desc>
6762	</method>
6763
6764	<method name="sleepButton">
6765	<desc>Sends the ACPI sleep button event to the guest.
6766	<result name="VBOX_E_INVALID_VM_STATE">
6767	Virtual machine not in Running state.
6768	</result>
6769	<result name="VBOX_E_PDM_ERROR">
6770	Sending sleep button event failed.
6771	</result>
6772	</desc>
6773	</method>
6774
6775	<method name="getPowerButtonHandled">
6776	<desc>Checks if the last power button event was handled by guest.
6777	<result name="VBOX_E_PDM_ERROR">
6778	Checking if the event was handled by the guest OS failed.
6779	</result>
6780	</desc>
6781	<param name="handled" type="boolean" dir="return"/>
6782	</method>
6783
6784	<method name="getGuestEnteredACPIMode">
6785	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6786	G1 (sleeping). If this method returns @c false, the guest will
6787	most likely not respond to external ACPI events.
6788	<result name="VBOX_E_INVALID_VM_STATE">
6789	Virtual machine not in Running state.
6790	</result>
6791	</desc>
6792	<param name="entered" type="boolean" dir="return"/>
6793	</method>
6794
6795	<method name="saveState">
6796	<desc>
6797	Saves the current execution state of a running virtual machine
6798	and stops its execution.
6799
6800	After this operation completes, the machine will go to the
6801	Saved state. Next time it is powered up, this state will
6802	be restored and the machine will continue its execution from
6803	the place where it was saved.
6804
6805	This operation differs from taking a snapshot to the effect
6806	that it doesn't create new differencing media. Also, once
6807	the machine is powered up from the state saved using this method,
6808	the saved state is deleted, so it will be impossible to return
6809	to this state later.
6810
6811	<note>
6812	On success, this method implicitly calls
6813	<link to="IMachine::saveSettings"/> to save all current machine
6814	settings (including runtime changes to the DVD medium, etc.).
6815	Together with the impossibility to change any VM settings when it is
6816	in the Saved state, this guarantees adequate hardware
6817	configuration of the machine when it is restored from the saved
6818	state file.
6819	</note>
6820
6821	<note>
6822	The machine must be in the Running or Paused state, otherwise
6823	the operation will fail.
6824	</note>
6825	<result name="VBOX_E_INVALID_VM_STATE">
6826	Virtual machine state neither Running nor Paused.
6827	</result>
6828	<result name="VBOX_E_FILE_ERROR">
6829	Failed to create directory for saved state file.
6830	</result>
6831
6832	<see><link to="#takeSnapshot"/></see>
6833	</desc>
6834	<param name="progress" type="IProgress" dir="return">
6835	<desc>Progress object to track the operation completion.</desc>
6836	</param>
6837	</method>
6838
6839	<method name="adoptSavedState">
6840	<desc>
6841	Associates the given saved state file to the virtual machine.
6842
6843	On success, the machine will go to the Saved state. Next time it is
6844	powered up, it will be restored from the adopted saved state and
6845	continue execution from the place where the saved state file was
6846	created.
6847
6848	The specified saved state file path may be absolute or relative to the
6849	folder the VM normally saves the state to (usually,
6850	<link to="IMachine::snapshotFolder"/>).
6851
6852	<note>
6853	It's a caller's responsibility to make sure the given saved state
6854	file is compatible with the settings of this virtual machine that
6855	represent its virtual hardware (memory size, storage disk configuration
6856	etc.). If there is a mismatch, the behavior of the virtual machine
6857	is undefined.
6858	</note>
6859	<result name="VBOX_E_INVALID_VM_STATE">
6860	Virtual machine state neither PoweredOff nor Aborted.
6861	</result>
6862	</desc>
6863	<param name="savedStateFile" type="wstring" dir="in">
6864	<desc>Path to the saved state file to adopt.</desc>
6865	</param>
6866	</method>
6867
6868	<method name="forgetSavedState">
6869	<desc>
6870	Forgets the saved state of the virtual machine previously created
6871	by <link to="#saveState"/>. Next time the machine is powered up, a
6872	clean boot will occur. If @a remove is @c true the saved state file
6873	is deleted.
6874	<note>
6875	This operation is equivalent to resetting or powering off
6876	the machine without doing a proper shutdown in the guest OS.
6877	</note>
6878	<result name="VBOX_E_INVALID_VM_STATE">
6879	Virtual machine not in state Saved.
6880	</result>
6881	</desc>
6882	<param name="remove" type="boolean" dir="in">
6883	<desc>If @c true remove the saved state file.</desc>
6884	</param>
6885	</method>
6886
6887	<method name="getDeviceActivity">
6888	<desc>
6889	Gets the current activity type of a given device or device group.
6890	<result name="E_INVALIDARG">
6891	Invalid device type.
6892	</result>
6893	</desc>
6894	<param name="type" type="DeviceType" dir="in"/>
6895	<param name="activity" type="DeviceActivity" dir="return"/>
6896	</method>
6897
6898	<method name="attachUSBDevice">
6899	<desc>
6900	Attaches a host USB device with the given UUID to the
6901	USB controller of the virtual machine.
6902
6903	The device needs to be in one of the following states:
6904	<link to="USBDeviceState_Busy"/>,
6905	<link to="USBDeviceState_Available"/> or
6906	<link to="USBDeviceState_Held"/>,
6907	otherwise an error is immediately returned.
6908
6909	When the device state is
6910	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6911	be returned if the host computer refuses to release it for some reason.
6912
6913	<see>IUSBController::deviceFilters, USBDeviceState</see>
6914	<result name="VBOX_E_INVALID_VM_STATE">
6915	Virtual machine state neither Running nor Paused.
6916	</result>
6917	<result name="VBOX_E_PDM_ERROR">
6918	Virtual machine does not have a USB controller.
6919	</result>
6920	</desc>
6921	<param name="id" type="uuid" mod="string" dir="in">
6922	<desc>UUID of the host USB device to attach.</desc>
6923	</param>
6924	</method>
6925
6926	<method name="detachUSBDevice">
6927	<desc>
6928	Detaches an USB device with the given UUID from the USB controller
6929	of the virtual machine.
6930
6931	After this method succeeds, the VirtualBox server re-initiates
6932	all USB filters as if the device were just physically attached
6933	to the host, but filters of this machine are ignored to avoid
6934	a possible automatic re-attachment.
6935
6936	<see>IUSBController::deviceFilters, USBDeviceState</see>
6937
6938	<result name="VBOX_E_PDM_ERROR">
6939	Virtual machine does not have a USB controller.
6940	</result>
6941	<result name="E_INVALIDARG">
6942	USB device not attached to this virtual machine.
6943	</result>
6944	</desc>
6945	<param name="id" type="uuid" mod="string" dir="in">
6946	<desc>UUID of the USB device to detach.</desc>
6947	</param>
6948	<param name="device" type="IUSBDevice" dir="return">
6949	<desc>Detached USB device.</desc>
6950	</param>
6951	</method>
6952
6953	<method name="findUSBDeviceByAddress">
6954	<desc>
6955	Searches for a USB device with the given host address.
6956
6957	<result name="VBOX_E_OBJECT_NOT_FOUND">
6958	Given @c name does not correspond to any USB device.
6959	</result>
6960
6961	<see>IUSBDevice::address</see>
6962	</desc>
6963	<param name="name" type="wstring" dir="in">
6964	<desc>
6965	Address of the USB device (as assigned by the host) to
6966	search for.
6967	</desc>
6968	</param>
6969	<param name="device" type="IUSBDevice" dir="return">
6970	<desc>Found USB device object.</desc>
6971	</param>
6972	</method>
6973
6974	<method name="findUSBDeviceById">
6975	<desc>
6976	Searches for a USB device with the given UUID.
6977
6978	<result name="VBOX_E_OBJECT_NOT_FOUND">
6979	Given @c id does not correspond to any USB device.
6980	</result>
6981
6982	<see>IUSBDevice::id</see>
6983	</desc>
6984	<param name="id" type="uuid" mod="string" dir="in">
6985	<desc>UUID of the USB device to search for.</desc>
6986	</param>
6987	<param name="device" type="IUSBDevice" dir="return">
6988	<desc>Found USB device object.</desc>
6989	</param>
6990	</method>
6991
6992	<method name="createSharedFolder">
6993	<desc>
6994	Creates a transient new shared folder by associating the given logical
6995	name with the given host path, adds it to the collection of shared
6996	folders and starts sharing it. Refer to the description of
6997	<link to="ISharedFolder"/> to read more about logical names.
6998
6999	<result name="VBOX_E_INVALID_VM_STATE">
7000	Virtual machine in Saved state or currently changing state.
7001	</result>
7002	<result name="VBOX_E_FILE_ERROR">
7003	Shared folder already exists or not accessible.
7004	</result>
7005	</desc>
7006	<param name="name" type="wstring" dir="in">
7007	<desc>Unique logical name of the shared folder.</desc>
7008	</param>
7009	<param name="hostPath" type="wstring" dir="in">
7010	<desc>Full path to the shared folder in the host file system.</desc>
7011	</param>
7012	<param name="writable" type="boolean" dir="in">
7013	<desc>Whether the share is writable or readonly</desc>
7014	</param>
7015	</method>
7016
7017	<method name="removeSharedFolder">
7018	<desc>
7019	Removes a transient shared folder with the given name previously
7020	created by <link to="#createSharedFolder"/> from the collection of
7021	shared folders and stops sharing it.
7022	<result name="VBOX_E_INVALID_VM_STATE">
7023	Virtual machine in Saved state or currently changing state.
7024	</result>
7025	<result name="VBOX_E_FILE_ERROR">
7026	Shared folder does not exists.
7027	</result>
7028	</desc>
7029	<param name="name" type="wstring" dir="in">
7030	<desc>Logical name of the shared folder to remove.</desc>
7031	</param>
7032	</method>
7033
7034	<method name="takeSnapshot">
7035	<desc>
7036	Saves the current execution state
7037	and all settings of the machine and creates differencing images
7038	for all normal (non-independent) media.
7039	See <link to="ISnapshot" /> for an introduction to snapshots.
7040
7041	This method can be called for a PoweredOff, Saved (see
7042	<link to="#saveState"/>), Running or
7043	Paused virtual machine. When the machine is PoweredOff, an
7044	offline snapshot is created. When the machine is Running a live
7045	snapshot is created, and an online snapshot is is created when Paused.
7046
7047	The taken snapshot is always based on the
7048	<link to="IMachine::currentSnapshot">current snapshot</link>
7049	of the associated virtual machine and becomes a new current snapshot.
7050
7051	<note>
7052	This method implicitly calls <link to="IMachine::saveSettings"/> to
7053	save all current machine settings before taking an offline snapshot.
7054	</note>
7055
7056	<result name="VBOX_E_INVALID_VM_STATE">
7057	Virtual machine currently changing state.
7058	</result>
7059	</desc>
7060	<param name="name" type="wstring" dir="in">
7061	<desc>Short name for the snapshot.</desc>
7062	</param>
7063	<param name="description" type="wstring" dir="in">
7064	<desc>Optional description of the snapshot.</desc>
7065	</param>
7066	<param name="progress" type="IProgress" dir="return">
7067	<desc>Progress object to track the operation completion.</desc>
7068	</param>
7069	</method>
7070
7071	<method name="deleteSnapshot">
7072	<desc>
7073	Starts deleting the specified snapshot asynchronously.
7074	See <link to="ISnapshot" /> for an introduction to snapshots.
7075
7076	The execution state and settings of the associated machine stored in
7077	the snapshot will be deleted. The contents of all differencing media of
7078	this snapshot will be merged with the contents of their dependent child
7079	media to keep the medium chain valid (in other words, all changes
7080	represented by media being discarded will be propagated to their child
7081	medium). After that, this snapshot's differencing medium will be
7082	deleted. The parent of this snapshot will become a new parent for all
7083	its child snapshots.
7084
7085	If the deleted snapshot is the current one, its parent snapshot will
7086	become a new current snapshot. The current machine state is not directly
7087	affected in this case, except that currently attached differencing
7088	media based on media of the discarded snapshot will be also merged as
7089	described above.
7090
7091	If the deleted snapshot is the first or current snapshot, then the
7092	respective IMachine attributes will be adjusted. Deleting the current
7093	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7094	to make all current machine settings permanent.
7095
7096	Deleting a snapshot has the following preconditions:
7097
7098	<ul>
7099	<li>Child media of all normal media of the discarded snapshot
7100	must be accessible (see <link to="IMedium::state"/>) for this
7101	operation to succeed. In particular, this means that all virtual
7102	machines, whose media are directly or indirectly based on the
7103	media of discarded snapshot, must be powered off.</li>
7104
7105	<li>You cannot delete the snapshot if a medium attached to it has
7106	more than once child medium (differencing images) because otherwise
7107	merging would be impossible. This might be the case if there is
7108	more than one child snapshot or differencing images were created
7109	for other reason (e.g. implicitly because of multiple machine
7110	attachments).</li>
7111	</ul>
7112
7113
7114	The virtual machine's <link to="IMachine::state">state</link> is changed to "DeletingSnapshot"
7115	while this operation is in progress.
7116
7117	<note>
7118	Merging medium contents can be very time and disk space
7119	consuming, if these media are big in size and have many
7120	children. However, if the snapshot being discarded is the last
7121	(head) snapshot on the branch, the operation will be rather
7122	quick.
7123	</note>
7124	<result name="VBOX_E_INVALID_VM_STATE">
7125	Virtual machine is running.
7126	</result>
7127	</desc>
7128	<param name="id" type="uuid" mod="string" dir="in">
7129	<desc>UUID of the snapshot to discard.</desc>
7130	</param>
7131	<param name="progress" type="IProgress" dir="return">
7132	<desc>Progress object to track the operation completion.</desc>
7133	</param>
7134	</method>
7135
7136	<method name="restoreSnapshot">
7137	<desc>
7138	Starts resetting the machine's current state to the state contained
7139	in the given snapshot, asynchronously. All current settings of the
7140	machine will be reset and changes stored in differencing media
7141	will be lost.
7142	See <link to="ISnapshot" /> for an introduction to snapshots.
7143
7144	After this operation is successfully completed, new empty differencing
7145	media are created for all normal media of the machine.
7146
7147	If the given snapshot is an online snapshot, the machine will go to
7148	the <link to="MachineState_Saved"> saved state</link>, so that the
7149	next time it is powered on, the execution state will be restored
7150	from the state of the snapshot.
7151
7152	<note>
7153	The machine must not be running, otherwise the operation will fail.
7154	</note>
7155
7156	<note>
7157	If the machine state is <link to="MachineState_Saved">Saved</link>
7158	prior to this operation, the saved state file will be implicitly
7159	discarded (as if <link to="IConsole::forgetSavedState"/> were
7160	called).
7161	</note>
7162
7163	<result name="VBOX_E_INVALID_VM_STATE">
7164	Virtual machine is running.
7165	</result>
7166	</desc>
7167	<param name="snapshot" type="ISnapshot" dir="in">
7168	<desc>The snapshot to restore the VM state from.</desc>
7169	</param>
7170	<param name="progress" type="IProgress" dir="return">
7171	<desc>Progress object to track the operation completion.</desc>
7172	</param>
7173	</method>
7174
7175	<method name="teleport">
7176	<desc>
7177	Teleport the VM to a different host machine or process.
7178
7179	TODO explain the details.
7180
7181	<result name="VBOX_E_INVALID_VM_STATE">
7182	Virtual machine not running or paused.
7183	</result>
7184	</desc>
7185	<param name="hostname" type="wstring" dir="in">
7186	<desc>The name or IP of the host to teleport to.</desc>
7187	</param>
7188	<param name="tcpport" type="unsigned long" dir="in">
7189	<desc>The TCP port to connect to (1..65535).</desc>
7190	</param>
7191	<param name="password" type="wstring" dir="in">
7192	<desc>The password.</desc>
7193	</param>
7194	<param name="maxDowntime" type="unsigned long" dir="in">
7195	<desc>
7196	The maximum allowed downtime given as milliseconds. 0 is not a valid
7197	value. Recommended value: 250 ms.
7198
7199	The higher the value is, the greater the chance for a successful
7200	teleportation. A small value may easily result in the teleportation
7201	process taking hours and eventually fail.
7202
7203	<note>
7204	The current implementation treats this a guideline, not as an
7205	absolute rule.
7206	</note>
7207	</desc>
7208	</param>
7209	<param name="progress" type="IProgress" dir="return">
7210	<desc>Progress object to track the operation completion.</desc>
7211	</param>
7212	</method>
7213
7214	<method name="registerCallback">
7215	<desc>
7216	Registers a new console callback on this instance. The methods of the
7217	callback interface will be called by this instance when the appropriate
7218	event occurs.
7219	</desc>
7220	<param name="callback" type="IConsoleCallback" dir="in"/>
7221	</method>
7222
7223	<method name="unregisterCallback">
7224	<desc>
7225	Unregisters the console callback previously registered using
7226	<link to="#registerCallback"/>.
7227	<result name="E_INVALIDARG">
7228	Given @a callback handler is not registered.
7229	</result>
7230	</desc>
7231	<param name="callback" type="IConsoleCallback" dir="in"/>
7232	</method>
7233	</interface>
7234
7235	<!--
7236	// IHost
7237	/////////////////////////////////////////////////////////////////////////
7238	-->
7239
7240	<enum
7241	name="HostNetworkInterfaceMediumType"
7242	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7243	>
7244	<desc>
7245	Type of encapsulation. Ethernet encapsulation includes both wired and
7246	wireless Ethernet connections.
7247	<see>IHostNetworkInterface</see>
7248	</desc>
7249
7250	<const name="Unknown" value="0">
7251	<desc>
7252	The type of interface cannot be determined.
7253	</desc>
7254	</const>
7255	<const name="Ethernet" value="1">
7256	<desc>
7257	Ethernet frame encapsulation.
7258	</desc>
7259	</const>
7260	<const name="PPP" value="2">
7261	<desc>
7262	Point-to-point protocol encapsulation.
7263	</desc>
7264	</const>
7265	<const name="SLIP" value="3">
7266	<desc>
7267	Serial line IP encapsulation.
7268	</desc>
7269	</const>
7270	</enum>
7271
7272	<enum
7273	name="HostNetworkInterfaceStatus"
7274	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7275	>
7276	<desc>
7277	Current status of the interface.
7278	<see>IHostNetworkInterface</see>
7279	</desc>
7280
7281	<const name="Unknown" value="0">
7282	<desc>
7283	The state of interface cannot be determined.
7284	</desc>
7285	</const>
7286	<const name="Up" value="1">
7287	<desc>
7288	The interface is fully operational.
7289	</desc>
7290	</const>
7291	<const name="Down" value="2">
7292	<desc>
7293	The interface is not functioning.
7294	</desc>
7295	</const>
7296	</enum>
7297
7298	<enum
7299	name="HostNetworkInterfaceType"
7300	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7301	>
7302	<desc>
7303	Network interface type.
7304	</desc>
7305	<const name="Bridged" value="1"/>
7306	<const name="HostOnly" value="2"/>
7307	</enum>
7308
7309	<interface
7310	name="IHostNetworkInterface" extends="$unknown"
7311	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7312	wsmap="managed"
7313	>
7314	<desc>
7315	Represents one of host's network interfaces. IP V6 address and network
7316	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7317	separated by colons.
7318	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7319	</desc>
7320	<attribute name="name" type="wstring" readonly="yes">
7321	<desc>Returns the host network interface name.</desc>
7322	</attribute>
7323
7324	<attribute name="id" type="uuid" mod="string" readonly="yes">
7325	<desc>Returns the interface UUID.</desc>
7326	</attribute>
7327
7328	<attribute name="networkName" type="wstring" readonly="yes">
7329	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7330	</attribute>
7331
7332	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7333	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7334	</attribute>
7335
7336	<attribute name="IPAddress" type="wstring" readonly="yes">
7337	<desc>Returns the IP V4 address of the interface.</desc>
7338	</attribute>
7339
7340	<attribute name="networkMask" type="wstring" readonly="yes">
7341	<desc>Returns the network mask of the interface.</desc>
7342	</attribute>
7343
7344	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7345	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7346	</attribute>
7347
7348	<attribute name="IPV6Address" type="wstring" readonly="yes">
7349	<desc>Returns the IP V6 address of the interface.</desc>
7350	</attribute>
7351
7352	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7353	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7354	</attribute>
7355
7356	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7357	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7358	</attribute>
7359
7360	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7361	<desc>Type of protocol encapsulation used.</desc>
7362	</attribute>
7363
7364	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7365	<desc>Status of the interface.</desc>
7366	</attribute>
7367
7368	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7369	<desc>specifies the host interface type.</desc>
7370	</attribute>
7371
7372	<method name="enableStaticIpConfig">
7373	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7374	<param name="IPAddress" type="wstring" dir="in">
7375	<desc>
7376	IP address.
7377	</desc>
7378	</param>
7379	<param name="networkMask" type="wstring" dir="in">
7380	<desc>
7381	network mask.
7382	</desc>
7383	</param>
7384	</method>
7385
7386	<method name="enableStaticIpConfigV6">
7387	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7388	<param name="IPV6Address" type="wstring" dir="in">
7389	<desc>
7390	IP address.
7391	</desc>
7392	</param>
7393	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7394	<desc>
7395	network mask.
7396	</desc>
7397	</param>
7398	</method>
7399
7400	<method name="enableDynamicIpConfig">
7401	<desc>enables the dynamic IP configuration.</desc>
7402	</method>
7403
7404	<method name="dhcpRediscover">
7405	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7406	</method>
7407
7408	</interface>
7409
7410	<interface
7411	name="IHost" extends="$unknown"
7412	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7413	wsmap="managed"
7414	>
7415	<desc>
7416	The IHost interface represents the physical machine that this VirtualBox
7417	installation runs on.
7418
7419	An object implementing this interface is returned by the
7420	<link to="IVirtualBox::host" /> attribute. This interface contains
7421	read-only information about the host's physical hardware (such as what
7422	processors and disks are available, what the host operating system is,
7423	and so on) and also allows for manipulating some of the host's hardware,
7424	such as global USB device filters and host interface networking.
7425
7426	</desc>
7427	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7428	<desc>List of DVD drives available on the host.</desc>
7429	</attribute>
7430
7431	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7432	<desc>List of floppy drives available on the host.</desc>
7433	</attribute>
7434
7435	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7436	<desc>
7437	List of USB devices currently attached to the host.
7438	Once a new device is physically attached to the host computer,
7439	it appears in this list and remains there until detached.
7440
7441	<note>
7442	If USB functionality is not available in the given edition of
7443	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7444	</note>
7445	</desc>
7446	</attribute>
7447
7448	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7449	<desc>
7450	List of USB device filters in action.
7451	When a new device is physically attached to the host computer,
7452	filters from this list are applied to it (in order they are stored
7453	in the list). The first matched filter will determine the
7454	<link to="IHostUSBDeviceFilter::action">action</link>
7455	performed on the device.
7456
7457	Unless the device is ignored by these filters, filters of all
7458	currently running virtual machines
7459	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7460
7461	<note>
7462	If USB functionality is not available in the given edition of
7463	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7464	</note>
7465
7466	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7467	</desc>
7468	</attribute>
7469
7470	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7471	<desc>List of host network interfaces currently defined on the host.</desc>
7472	</attribute>
7473
7474	<attribute name="processorCount" type="unsigned long" readonly="yes">
7475	<desc>Number of (logical) CPUs installed in the host system.</desc>
7476	</attribute>
7477
7478	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7479	<desc>Number of (logical) CPUs online in the host system.</desc>
7480	</attribute>
7481
7482	<method name="getProcessorSpeed">
7483	<desc>Query the (approximate) maximum speed of a specified host CPU in
7484	Megahertz.
7485	</desc>
7486	<param name="cpuId" type="unsigned long" dir="in">
7487	<desc>
7488	Identifier of the CPU.
7489	</desc>
7490	</param>
7491	<param name="speed" type="unsigned long" dir="return">
7492	<desc>
7493	Speed value. 0 is returned if value is not known or @a cpuId is
7494	invalid.
7495	</desc>
7496	</param>
7497	</method>
7498
7499	<method name="getProcessorFeature">
7500	<desc>Query whether a CPU feature is supported or not.</desc>
7501	<param name="feature" type="ProcessorFeature" dir="in">
7502	<desc>
7503	CPU Feature identifier.
7504	</desc>
7505	</param>
7506	<param name="supported" type="boolean" dir="return">
7507	<desc>
7508	Feature is supported or not.
7509	</desc>
7510	</param>
7511	</method>
7512
7513	<method name="getProcessorDescription">
7514	<desc>Query the model string of a specified host CPU.
7515	</desc>
7516	<param name="cpuId" type="unsigned long" dir="in">
7517	<desc>
7518	Identifier of the CPU.
7519	<note>
7520	The current implementation might not necessarily return the
7521	description for this exact CPU.
7522	</note>
7523	</desc>
7524	</param>
7525	<param name="description" type="wstring" dir="return">
7526	<desc>
7527	Model string. An empty string is returned if value is not known or
7528	@a cpuId is invalid.
7529	</desc>
7530	</param>
7531	</method>
7532
7533	<method name="getProcessorCpuIdLeaf">
7534	<desc>
7535	Returns the CPU cpuid information for the specified leaf.
7536	</desc>
7537	<param name="cpuId" type="unsigned long" dir="in">
7538	<desc>
7539	Identifier of the CPU. The CPU most be online.
7540	<note>
7541	The current implementation might not necessarily return the
7542	description for this exact CPU.
7543	</note>
7544	</desc>
7545	</param>
7546	<param name="leaf" type="unsigned long" dir="in">
7547	<desc>
7548	Cpuid leaf index (eax).
7549	</desc>
7550	</param>
7551	<param name="subLeaf" type="unsigned long" dir="in">
7552	<desc>
7553	Cpuid leaf sub index (ecx). This currently only applies to cache
7554	information on Intel CPUs. Use 0 if retriving values for
7555	<link to="IMachine::setCpuIdLeaf"/>.
7556	</desc>
7557	</param>
7558	<param name="valEax" type="unsigned long" dir="out">
7559	<desc>
7560	Cpuid leaf value for register eax.
7561	</desc>
7562	</param>
7563	<param name="valEbx" type="unsigned long" dir="out">
7564	<desc>
7565	Cpuid leaf value for register ebx.
7566	</desc>
7567	</param>
7568	<param name="valEcx" type="unsigned long" dir="out">
7569	<desc>
7570	Cpuid leaf value for register ecx.
7571	</desc>
7572	</param>
7573	<param name="valEdx" type="unsigned long" dir="out">
7574	<desc>
7575	Cpuid leaf value for register edx.
7576	</desc>
7577	</param>
7578	</method>
7579
7580	<attribute name="memorySize" type="unsigned long" readonly="yes">
7581	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7582	</attribute>
7583
7584	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7585	<desc>Available system memory in the host system.</desc>
7586	</attribute>
7587
7588	<attribute name="operatingSystem" type="wstring" readonly="yes">
7589	<desc>Name of the host system's operating system.</desc>
7590	</attribute>
7591
7592	<attribute name="OSVersion" type="wstring" readonly="yes">
7593	<desc>Host operating system's version string.</desc>
7594	</attribute>
7595
7596	<attribute name="UTCTime" type="long long" readonly="yes">
7597	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7598	</attribute>
7599
7600	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7601	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7602	</attribute>
7603
7604	<method name="createHostOnlyNetworkInterface">
7605	<desc>
7606	Creates a new adapter for Host Only Networking.
7607	<result name="E_INVALIDARG">
7608	Host network interface @a name already exists.
7609	</result>
7610	</desc>
7611	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7612	<desc>
7613	Created host interface object.
7614	</desc>
7615	</param>
7616	<param name="progress" type="IProgress" dir="return">
7617	<desc>
7618	Progress object to track the operation completion.
7619	</desc>
7620	</param>
7621	</method>
7622
7623	<method name="removeHostOnlyNetworkInterface">
7624	<desc>
7625	Removes the given Host Only Networking interface.
7626	<result name="VBOX_E_OBJECT_NOT_FOUND">
7627	No host network interface matching @a id found.
7628	</result>
7629	</desc>
7630	<param name="id" type="uuid" mod="string" dir="in">
7631	<desc>
7632	Adapter GUID.
7633	</desc>
7634	</param>
7635	<param name="progress" type="IProgress" dir="return">
7636	<desc>
7637	Progress object to track the operation completion.
7638	</desc>
7639	</param>
7640	</method>
7641
7642	<method name="createUSBDeviceFilter">
7643	<desc>
7644	Creates a new USB device filter. All attributes except
7645	the filter name are set to empty (any match),
7646	<i>active</i> is @c false (the filter is not active).
7647
7648	The created filter can be added to the list of filters using
7649	<link to="#insertUSBDeviceFilter"/>.
7650
7651	<see>#USBDeviceFilters</see>
7652	</desc>
7653	<param name="name" type="wstring" dir="in">
7654	<desc>
7655	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7656	for more info.
7657	</desc>
7658	</param>
7659	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7660	<desc>Created filter object.</desc>
7661	</param>
7662	</method>
7663
7664	<method name="insertUSBDeviceFilter">
7665	<desc>
7666	Inserts the given USB device to the specified position
7667	in the list of filters.
7668
7669	Positions are numbered starting from @c 0. If the specified
7670	position is equal to or greater than the number of elements in
7671	the list, the filter is added at the end of the collection.
7672
7673	<note>
7674	Duplicates are not allowed, so an attempt to insert a
7675	filter already in the list is an error.
7676	</note>
7677	<note>
7678	If USB functionality is not available in the given edition of
7679	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7680	</note>
7681
7682	<see>#USBDeviceFilters</see>
7683
7684	<result name="VBOX_E_INVALID_OBJECT_STATE">
7685	USB device filter is not created within this VirtualBox instance.
7686	</result>
7687	<result name="E_INVALIDARG">
7688	USB device filter already in list.
7689	</result>
7690
7691	</desc>
7692	<param name="position" type="unsigned long" dir="in">
7693	<desc>Position to insert the filter to.</desc>
7694	</param>
7695	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7696	<desc>USB device filter to insert.</desc>
7697	</param>
7698	</method>
7699
7700	<method name="removeUSBDeviceFilter">
7701	<desc>
7702	Removes a USB device filter from the specified position in the
7703	list of filters.
7704
7705	Positions are numbered starting from @c 0. Specifying a
7706	position equal to or greater than the number of elements in
7707	the list will produce an error.
7708
7709	<note>
7710	If USB functionality is not available in the given edition of
7711	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7712	</note>
7713
7714	<see>#USBDeviceFilters</see>
7715
7716	<result name="E_INVALIDARG">
7717	USB device filter list empty or invalid @a position.
7718	</result>
7719
7720	</desc>
7721	<param name="position" type="unsigned long" dir="in">
7722	<desc>Position to remove the filter from.</desc>
7723	</param>
7724	</method>
7725
7726	<method name="findHostDVDDrive">
7727	<desc>
7728	Searches for a host DVD drive with the given @c name.
7729
7730	<result name="VBOX_E_OBJECT_NOT_FOUND">
7731	Given @c name does not correspond to any host drive.
7732	</result>
7733
7734	</desc>
7735	<param name="name" type="wstring" dir="in">
7736	<desc>Name of the host drive to search for</desc>
7737	</param>
7738	<param name="drive" type="IMedium" dir="return">
7739	<desc>Found host drive object</desc>
7740	</param>
7741	</method>
7742
7743	<method name="findHostFloppyDrive">
7744	<desc>
7745	Searches for a host floppy drive with the given @c name.
7746
7747	<result name="VBOX_E_OBJECT_NOT_FOUND">
7748	Given @c name does not correspond to any host floppy drive.
7749	</result>
7750
7751	</desc>
7752	<param name="name" type="wstring" dir="in">
7753	<desc>Name of the host floppy drive to search for</desc>
7754	</param>
7755	<param name="drive" type="IMedium" dir="return">
7756	<desc>Found host floppy drive object</desc>
7757	</param>
7758	</method>
7759
7760	<method name="findHostNetworkInterfaceByName">
7761	<desc>
7762	Searches through all host network interfaces for an interface with
7763	the given @c name.
7764	<note>
7765	The method returns an error if the given @c name does not
7766	correspond to any host network interface.
7767	</note>
7768	</desc>
7769	<param name="name" type="wstring" dir="in">
7770	<desc>Name of the host network interface to search for.</desc>
7771	</param>
7772	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7773	<desc>Found host network interface object.</desc>
7774	</param>
7775	</method>
7776	<method name="findHostNetworkInterfaceById">
7777	<desc>
7778	Searches through all host network interfaces for an interface with
7779	the given GUID.
7780	<note>
7781	The method returns an error if the given GUID does not
7782	correspond to any host network interface.
7783	</note>
7784	</desc>
7785	<param name="id" type="uuid" mod="string" dir="in">
7786	<desc>GUID of the host network interface to search for.</desc>
7787	</param>
7788	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7789	<desc>Found host network interface object.</desc>
7790	</param>
7791	</method>
7792	<method name="findHostNetworkInterfacesOfType">
7793	<desc>
7794	Searches through all host network interfaces and returns a list of interfaces of the specified type
7795	</desc>
7796	<param name="type" type="HostNetworkInterfaceType" dir="in">
7797	<desc>type of the host network interfaces to search for.</desc>
7798	</param>
7799	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7800	<desc>Found host network interface objects.</desc>
7801	</param>
7802	</method>
7803
7804	<method name="findUSBDeviceById">
7805	<desc>
7806	Searches for a USB device with the given UUID.
7807
7808	<result name="VBOX_E_OBJECT_NOT_FOUND">
7809	Given @c id does not correspond to any USB device.
7810	</result>
7811
7812	<see>IHostUSBDevice::id</see>
7813	</desc>
7814	<param name="id" type="uuid" mod="string" dir="in">
7815	<desc>UUID of the USB device to search for.</desc>
7816	</param>
7817	<param name="device" type="IHostUSBDevice" dir="return">
7818	<desc>Found USB device object.</desc>
7819	</param>
7820	</method>
7821
7822	<method name="findUSBDeviceByAddress">
7823	<desc>
7824	Searches for a USB device with the given host address.
7825
7826	<result name="VBOX_E_OBJECT_NOT_FOUND">
7827	Given @c name does not correspond to any USB device.
7828	</result>
7829
7830	<see>IHostUSBDevice::address</see>
7831	</desc>
7832	<param name="name" type="wstring" dir="in">
7833	<desc>
7834	Address of the USB device (as assigned by the host) to
7835	search for.
7836	</desc>
7837	</param>
7838	<param name="device" type="IHostUSBDevice" dir="return">
7839	<desc>Found USB device object.</desc>
7840	</param>
7841	</method>
7842
7843	</interface>
7844
7845	<!--
7846	// ISystemProperties
7847	/////////////////////////////////////////////////////////////////////////
7848	-->
7849
7850	<interface
7851	name="ISystemProperties"
7852	extends="$unknown"
7853	uuid="8030645c-8fef-4320-bb7b-c829f00069dc"
7854	wsmap="managed"
7855	>
7856	<desc>
7857	The ISystemProperties interface represents global properties of the given
7858	VirtualBox installation.
7859
7860	These properties define limits and default values for various attributes
7861	and parameters. Most of the properties are read-only, but some can be
7862	changed by a user.
7863	</desc>
7864
7865	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7866	<desc>Minimum guest system memory in Megabytes.</desc>
7867	</attribute>
7868
7869	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7870	<desc>Maximum guest system memory in Megabytes.</desc>
7871	</attribute>
7872
7873	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7874	<desc>Minimum guest video memory in Megabytes.</desc>
7875	</attribute>
7876
7877	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7878	<desc>Maximum guest video memory in Megabytes.</desc>
7879	</attribute>
7880
7881	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7882	<desc>Minimum CPU count.</desc>
7883	</attribute>
7884
7885	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7886	<desc>Maximum CPU count.</desc>
7887	</attribute>
7888
7889	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7890	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7891	</attribute>
7892
7893	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7894	<desc>
7895	Number of network adapters associated with every
7896	<link to="IMachine"/> instance.
7897	</desc>
7898	</attribute>
7899
7900	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7901	<desc>
7902	Number of serial ports associated with every
7903	<link to="IMachine"/> instance.
7904	</desc>
7905	</attribute>
7906
7907	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7908	<desc>
7909	Number of parallel ports associated with every
7910	<link to="IMachine"/> instance.
7911	</desc>
7912	</attribute>
7913
7914	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7915	<desc>
7916	Maximum device position in the boot order. This value corresponds
7917	to the total number of devices a machine can boot from, to make it
7918	possible to include all possible devices to the boot list.
7919	<see><link to="IMachine::setBootOrder"/></see>
7920	</desc>
7921	</attribute>
7922
7923	<attribute name="defaultMachineFolder" type="wstring">
7924	<desc>
7925	Full path to the default directory used to create new or open
7926	existing machines when a settings file name contains no
7927	path.
7928
7929	The initial value of this property is
7930	<tt><</tt><link to="IVirtualBox::homeFolder">
7931	VirtualBox_home</link><tt>>/Machines</tt>.
7932
7933	<note>
7934	Setting this property to @c null or an empty string will restore the
7935	initial value.
7936	</note>
7937	<note>
7938	When settings this property, the specified path can be
7939	absolute (full path) or relative
7940	to the <link to="IVirtualBox::homeFolder">
7941	VirtualBox home directory</link>.
7942	When reading this property, a full path is
7943	always returned.
7944	</note>
7945	<note>
7946	The specified path may not exist, it will be created
7947	when necessary.
7948	</note>
7949
7950	<see>
7951	<link to="IVirtualBox::createMachine"/>,
7952	<link to="IVirtualBox::openMachine"/>
7953	</see>
7954	</desc>
7955	</attribute>
7956
7957	<attribute name="defaultHardDiskFolder" type="wstring">
7958	<desc>
7959	Full path to the default directory used to create new or open existing
7960	virtual disks.
7961
7962	This path is used when the storage unit of a hard disk is a regular file
7963	in the host's file system and only a file name that contains no path is
7964	given.
7965
7966	The initial value of this property is
7967	<tt><</tt>
7968	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7969	<tt>>/HardDisks</tt>.
7970
7971	<note>
7972	Setting this property to @c null or empty string will restore the
7973	initial value.
7974	</note>
7975	<note>
7976	When settings this property, the specified path can be relative
7977	to the
7978	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7979	absolute. When reading this property, a full path is
7980	always returned.
7981	</note>
7982	<note>
7983	The specified path may not exist, it will be created
7984	when necessary.
7985	</note>
7986
7987	<see>
7988	IMedium,
7989	<link to="IVirtualBox::createHardDisk"/>,
7990	<link to="IVirtualBox::openHardDisk"/>,
7991	<link to="IMedium::location"/>
7992	</see>
7993	</desc>
7994	</attribute>
7995
7996	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7997	<desc>
7998	List of all medium storage formats supported by this VirtualBox
7999	installation.
8000
8001	Keep in mind that the medium format identifier
8002	(<link to="IMediumFormat::id"/>) used in other API calls like
8003	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8004	medium format is a case-insensitive string. This means that, for
8005	example, all of the following strings:
8006	<pre>
8007	"VDI"
8008	"vdi"
8009	"VdI"</pre>
8010	refer to the same medium format.
8011
8012	Note that the virtual medium framework is backend-based, therefore
8013	the list of supported formats depends on what backends are currently
8014	installed.
8015
8016	<see>
8017	<link to="IMediumFormat"/>,
8018	</see>
8019	</desc>
8020	</attribute>
8021
8022	<attribute name="defaultHardDiskFormat" type="wstring">
8023	<desc>
8024	Identifier of the default medium format used by VirtualBox.
8025
8026	The medium format set by this attribute is used by VirtualBox
8027	when the medium format was not specified explicitly. One example is
8028	<link to="IVirtualBox::createHardDisk"/> with the empty
8029	format argument. A more complex example is implicit creation of
8030	differencing media when taking a snapshot of a virtual machine:
8031	this operation will try to use a format of the parent medium first
8032	and if this format does not support differencing media the default
8033	format specified by this argument will be used.
8034
8035	The list of supported medium formats may be obtained by the
8036	<link to="#mediaFormats"/> call. Note that the default medium
8037	format must have a capability to create differencing media;
8038	otherwise operations that create media implicitly may fail
8039	unexpectedly.
8040
8041	The initial value of this property is <tt>"VDI"</tt> in the current
8042	version of the VirtualBox product, but may change in the future.
8043
8044	<note>
8045	Setting this property to @c null or empty string will restore the
8046	initial value.
8047	</note>
8048
8049	<see>
8050	<link to="#mediaFormats"/>,
8051	<link to="IMediumFormat::id"/>,
8052	<link to="IVirtualBox::createHardDisk"/>
8053	</see>
8054	</desc>
8055	</attribute>
8056
8057	<attribute name="remoteDisplayAuthLibrary" type="wstring">
8058	<desc>
8059	Library that provides authentication for VRDP clients. The library
8060	is used if a virtual machine's authentication type is set to "external"
8061	in the VM RemoteDisplay configuration.
8062
8063	The system library extension (".DLL" or ".so") must be omitted.
8064	A full path can be specified; if not, then the library must reside on the
8065	system's default library path.
8066
8067	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
8068	of that name in one of the default VirtualBox library directories.
8069
8070	For details about VirtualBox authentication libraries and how to implement
8071	them, please refer to the VirtualBox manual.
8072
8073	<note>
8074	Setting this property to @c null or empty string will restore the
8075	initial value.
8076	</note>
8077	</desc>
8078	</attribute>
8079
8080	<attribute name="webServiceAuthLibrary" type="wstring">
8081	<desc>
8082	Library that provides authentication for webservice clients. The library
8083	is used if a virtual machine's authentication type is set to "external"
8084	in the VM RemoteDisplay configuration and will be called from
8085	within the <link to="IWebsessionManager::logon" /> implementation.
8086
8087	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8088	there is no per-VM setting for this, as the webservice is a global
8089	resource (if it is running). Only for this setting (for the webservice),
8090	setting this value to a literal <tt>"null"</tt> string disables authentication,
8091	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8092	no matter what user name and password are supplied.
8093
8094	The initial value of this property is <tt>"VRDPAuth"</tt>,
8095	meaning that the webservice will use the same authentication
8096	library that is used by default for VBoxVRDP (again, see
8097	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8098	The format and calling convention of authentication libraries
8099	is the same for the webservice as it is for VBoxVRDP.
8100
8101	<note>
8102	Setting this property to @c null or empty string will restore the
8103	initial value.
8104	</note>
8105	</desc>
8106	</attribute>
8107
8108	<attribute name="LogHistoryCount" type="unsigned long">
8109	<desc>
8110	This value specifies how many old release log files are kept.
8111	</desc>
8112	</attribute>
8113
8114	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8115	<desc>This value hold the default audio driver for the current
8116	system.</desc>
8117	</attribute>
8118
8119	<method name="getMaxDevicesPerPortForStorageBus">
8120	<desc>Returns the maximum number of devices which can be attached to a port
8121	for the given storage bus.</desc>
8122
8123	<param name="bus" type="StorageBus" dir="in">
8124	<desc>The storage bus type to get the value for.</desc>
8125	</param>
8126
8127	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8128	<desc>The maximum number of devices which can eb attached to the port for the given
8129	storage bus.</desc>
8130	</param>
8131	</method>
8132
8133	<method name="getMinPortCountForStorageBus">
8134	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8135
8136	<param name="bus" type="StorageBus" dir="in">
8137	<desc>The storage bus type to get the value for.</desc>
8138	</param>
8139
8140	<param name="minPortCount" type="unsigned long" dir="return">
8141	<desc>The minimum number of ports for the given storage bus.</desc>
8142	</param>
8143	</method>
8144
8145	<method name="getMaxPortCountForStorageBus">
8146	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8147
8148	<param name="bus" type="StorageBus" dir="in">
8149	<desc>The storage bus type to get the value for.</desc>
8150	</param>
8151
8152	<param name="maxPortCount" type="unsigned long" dir="return">
8153	<desc>The maximum number of ports for the given storage bus.</desc>
8154	</param>
8155	</method>
8156
8157	<method name="getMaxInstancesOfStorageBus">
8158	<desc>Returns the maximum number of storage bus instances which
8159	can be configured for each VM. This corresponds to the number of
8160	storage controllers one can have.</desc>
8161
8162	<param name="bus" type="StorageBus" dir="in">
8163	<desc>The storage bus type to get the value for.</desc>
8164	</param>
8165
8166	<param name="maxInstances" type="unsigned long" dir="return">
8167	<desc>The maximum number of instances for the given storage bus.</desc>
8168	</param>
8169	</method>
8170
8171	<method name="getDeviceTypesForStorageBus">
8172	<desc>Returns list of all the supported device types
8173	(<link to="DeviceType"/>) for the given type of storage
8174	bus.</desc>
8175
8176	<param name="bus" type="StorageBus" dir="in">
8177	<desc>The storage bus type to get the value for.</desc>
8178	</param>
8179
8180	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8181	<desc>The list of all supported device types for the given storage bus.</desc>
8182	</param>
8183	</method>
8184	</interface>
8185
8186	<!--
8187	// IGuest
8188	/////////////////////////////////////////////////////////////////////////
8189	-->
8190
8191	<interface
8192	name="IGuestOSType" extends="$unknown"
8193	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
8194	wsmap="struct"
8195	>
8196	<desc>
8197	</desc>
8198
8199	<attribute name="familyId" type="wstring" readonly="yes">
8200	<desc>Guest OS family identifier string.</desc>
8201	</attribute>
8202
8203	<attribute name="familyDescription" type="wstring" readonly="yes">
8204	<desc>Human readable description of the guest OS family.</desc>
8205	</attribute>
8206
8207	<attribute name="id" type="wstring" readonly="yes">
8208	<desc>Guest OS identifier string.</desc>
8209	</attribute>
8210
8211	<attribute name="description" type="wstring" readonly="yes">
8212	<desc>Human readable description of the guest OS.</desc>
8213	</attribute>
8214
8215	<attribute name="is64Bit" type="boolean" readonly="yes">
8216	<desc>Returns @c true if the given OS is 64-bit</desc>
8217	</attribute>
8218
8219	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8220	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8221	</attribute>
8222
8223	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8224	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8225	</attribute>
8226
8227	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8228	<desc>Recommended RAM size in Megabytes.</desc>
8229	</attribute>
8230
8231	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8232	<desc>Recommended video RAM size in Megabytes.</desc>
8233	</attribute>
8234
8235	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8236	<desc>Recommended hard disk size in Megabytes.</desc>
8237	</attribute>
8238
8239	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8240	<desc>Returns recommended network adapter for this OS type.</desc>
8241	</attribute>
8242	</interface>
8243
8244	<interface
8245	name="IGuest" extends="$unknown"
8246	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8247	wsmap="managed"
8248	>
8249	<desc>
8250	The IGuest interface represents information about the operating system
8251	running inside the virtual machine. Used in
8252	<link to="IConsole::guest"/>.
8253
8254	IGuest provides information about the guest operating system, whether
8255	Guest Additions are installed and other OS-specific virtual machine
8256	properties.
8257	</desc>
8258
8259	<attribute name="OSTypeId" type="wstring" readonly="yes">
8260	<desc>
8261	Identifier of the Guest OS type as reported by the Guest
8262	Additions.
8263	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8264	an IGuestOSType object representing details about the given
8265	Guest OS type.
8266	<note>
8267	If Guest Additions are not installed, this value will be
8268	the same as <link to="IMachine::OSTypeId"/>.
8269	</note>
8270	</desc>
8271	</attribute>
8272
8273	<attribute name="additionsActive" type="boolean" readonly="yes">
8274	<desc>
8275	Flag whether the Guest Additions are installed and active
8276	in which case their version will be returned by the
8277	<link to="#additionsVersion"/> property.
8278	</desc>
8279	</attribute>
8280
8281	<attribute name="additionsVersion" type="wstring" readonly="yes">
8282	<desc>
8283	Version of the Guest Additions (3 decimal numbers separated
8284	by dots) or empty when the Additions are not installed. The
8285	Additions may also report a version but yet not be active as
8286	the version might be refused by VirtualBox (incompatible) or
8287	other failures occurred.
8288	</desc>
8289	</attribute>
8290
8291	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8292	<desc>
8293	Flag whether seamless guest display rendering (seamless desktop
8294	integration) is supported.
8295	</desc>
8296	</attribute>
8297
8298	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8299	<desc>
8300	Flag whether the guest is in graphics mode. If it is not, then
8301	seamless rendering will not work, resize hints are not immediately
8302	acted on and guest display resizes are probably not initiated by
8303	the guest additions.
8304	</desc>
8305	</attribute>
8306
8307	<attribute name="memoryBalloonSize" type="unsigned long">
8308	<desc>Guest system memory balloon size in megabytes.</desc>
8309	</attribute>
8310
8311	<attribute name="statisticsUpdateInterval" type="unsigned long">
8312	<desc>Interval to update guest statistics in seconds.</desc>
8313	</attribute>
8314
8315	<method name="setCredentials">
8316	<desc>
8317	Store login credentials that can be queried by guest operating
8318	systems with Additions installed. The credentials are transient
8319	to the session and the guest may also choose to erase them. Note
8320	that the caller cannot determine whether the guest operating system
8321	has queried or made use of the credentials.
8322
8323	<result name="VBOX_E_VM_ERROR">
8324	VMM device is not available.
8325	</result>
8326
8327	</desc>
8328	<param name="userName" type="wstring" dir="in">
8329	<desc>User name string, can be empty</desc>
8330	</param>
8331	<param name="password" type="wstring" dir="in">
8332	<desc>Password string, can be empty</desc>
8333	</param>
8334	<param name="domain" type="wstring" dir="in">
8335	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8336	</param>
8337	<param name="allowInteractiveLogon" type="boolean" dir="in">
8338	<desc>
8339	Flag whether the guest should alternatively allow the user to
8340	interactively specify different credentials. This flag might
8341	not be supported by all versions of the Additions.
8342	</desc>
8343	</param>
8344	</method>
8345
8346	<method name="getStatistic">
8347	<desc>
8348	Query specified guest statistics as reported by the VirtualBox Additions.
8349	</desc>
8350	<param name="cpuId" type="unsigned long" dir="in">
8351	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8352	</param>
8353	<param name="statistic" type="GuestStatisticType" dir="in">
8354	<desc>Statistic type.</desc>
8355	</param>
8356	<param name="statVal" type="unsigned long" dir="return">
8357	<desc>Statistics value</desc>
8358	</param>
8359	</method>
8360
8361	</interface>
8362
8363
8364	<!--
8365	// IProgress
8366	/////////////////////////////////////////////////////////////////////////
8367	-->
8368
8369	<interface
8370	name="IProgress" extends="$unknown"
8371	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8372	wsmap="managed"
8373	>
8374	<desc>
8375	The IProgress interface is used to track and control
8376	asynchronous tasks within VirtualBox.
8377
8378	An instance of this is returned every time VirtualBox starts
8379	an asynchronous task (in other words, a separate thread) which
8380	continues to run after a method call returns. For example,
8381	<link to="IConsole::saveState" />, which saves the state of
8382	a running virtual machine, can take a long time to complete.
8383	To be able to display a progress bar, a user interface such as
8384	the VirtualBox graphical user interface can use the IProgress
8385	object returned by that method.
8386
8387	Note that IProgress is a "read-only" interface in the sense
8388	that only the VirtualBox internals behind the Main API can
8389	create and manipulate progress objects, whereas client code
8390	can only use the IProgress object to monitor a task's
8391	progress and, if <link to="#cancelable" /> is @c true,
8392	cancel the task by calling <link to="#cancel" />.
8393
8394	A task represented by IProgress consists of either one or
8395	several sub-operations that run sequentially, one by one (see
8396	<link to="#operation" /> and <link to="#operationCount" />).
8397	Every operation is identified by a number (starting from 0)
8398	and has a separate description.
8399
8400	You can find the individual percentage of completion of the current
8401	operation in <link to="#operationPercent" /> and the
8402	percentage of completion of the task as a whole
8403	in <link to="#percent" />.
8404
8405	Similarly, you can wait for the completion of a particular
8406	operation via <link to="#waitForOperationCompletion" /> or
8407	for the completion of the whole task via
8408	<link to="#waitForCompletion" />.
8409	</desc>
8410
8411	<attribute name="id" type="uuid" mod="string" readonly="yes">
8412	<desc>ID of the task.</desc>
8413	</attribute>
8414
8415	<attribute name="description" type="wstring" readonly="yes">
8416	<desc>Description of the task.</desc>
8417	</attribute>
8418
8419	<attribute name="initiator" type="$unknown" readonly="yes">
8420	<desc>Initiator of the task.</desc>
8421	</attribute>
8422
8423	<attribute name="cancelable" type="boolean" readonly="yes">
8424	<desc>Whether the task can be interrupted.</desc>
8425	</attribute>
8426
8427	<attribute name="percent" type="unsigned long" readonly="yes">
8428	<desc>
8429	Current progress value of the task as a whole, in percent.
8430	This value depends on how many operations are already complete.
8431	Returns 100 if <link to="#completed" /> is @c true.
8432	</desc>
8433	</attribute>
8434
8435	<attribute name="timeRemaining" type="long" readonly="yes">
8436	<desc>
8437	Estimated remaining time until the task completes, in
8438	seconds. Returns 0 once the task has completed; returns -1
8439	if the remaining time cannot be computed, in particular if
8440	the current progress is 0.
8441
8442	Even if a value is returned, the estimate will be unreliable
8443	for low progress values. It will become more reliable as the
8444	task progresses; it is not recommended to display an ETA
8445	before at least 20% of a task have completed.
8446	</desc>
8447	</attribute>
8448
8449	<attribute name="completed" type="boolean" readonly="yes">
8450	<desc>Whether the task has been completed.</desc>
8451	</attribute>
8452
8453	<attribute name="canceled" type="boolean" readonly="yes">
8454	<desc>Whether the task has been canceled.</desc>
8455	</attribute>
8456
8457	<attribute name="resultCode" type="long" readonly="yes">
8458	<desc>
8459	Result code of the progress task.
8460	Valid only if <link to="#completed"/> is @c true.
8461	</desc>
8462	</attribute>
8463
8464	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8465	<desc>
8466	Extended information about the unsuccessful result of the
8467	progress operation. May be @c null if no extended information
8468	is available.
8469	Valid only if <link to="#completed"/> is @c true and
8470	<link to="#resultCode"/> indicates a failure.
8471	</desc>
8472	</attribute>
8473
8474	<attribute name="operationCount" type="unsigned long" readonly="yes">
8475	<desc>
8476	Number of sub-operations this task is divided into.
8477	Every task consists of at least one suboperation.
8478	</desc>
8479	</attribute>
8480
8481	<attribute name="operation" type="unsigned long" readonly="yes">
8482	<desc>Number of the sub-operation being currently executed.</desc>
8483	</attribute>
8484
8485	<attribute name="operationDescription" type="wstring" readonly="yes">
8486	<desc>
8487	Description of the sub-operation being currently executed.
8488	</desc>
8489	</attribute>
8490
8491	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8492	<desc>Progress value of the current sub-operation only, in percent.</desc>
8493	</attribute>
8494
8495	<attribute name="timeout" type="unsigned long">
8496	<desc>
8497	When non-zero, this specifies the number of milliseconds after which
8498	the operation will automatically be canceled. This can only be set on
8499	cancelable objects.
8500	</desc>
8501	</attribute>
8502
8503	<method name="setCurrentOperationProgress">
8504	<desc>Internal method, not to be called externally.</desc>
8505	<param name="percent" type="unsigned long" dir="in" />
8506	</method>
8507	<method name="setNextOperation">
8508	<desc>Internal method, not to be called externally.</desc>
8509	<param name="nextOperationDescription" type="wstring" dir="in" />
8510	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8511	</method>
8512
8513	<method name="waitForCompletion">
8514	<desc>
8515	Waits until the task is done (including all sub-operations)
8516	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8517
8518	<result name="VBOX_E_IPRT_ERROR">
8519	Failed to wait for task completion.
8520	</result>
8521	</desc>
8522
8523	<param name="timeout" type="long" dir="in">
8524	<desc>
8525	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8526	</desc>
8527	</param>
8528	</method>
8529
8530	<method name="waitForOperationCompletion">
8531	<desc>
8532	Waits until the given operation is done with a given timeout in
8533	milliseconds; specify -1 for an indefinite wait.
8534
8535	<result name="VBOX_E_IPRT_ERROR">
8536	Failed to wait for operation completion.
8537	</result>
8538
8539	</desc>
8540	<param name="operation" type="unsigned long" dir="in">
8541	<desc>
8542	Number of the operation to wait for.
8543	Must be less than <link to="#operationCount"/>.
8544	</desc>
8545	</param>
8546	<param name="timeout" type="long" dir="in">
8547	<desc>
8548	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8549	</desc>
8550	</param>
8551	</method>
8552
8553	<method name="cancel">
8554	<desc>
8555	Cancels the task.
8556	<note>
8557	If <link to="#cancelable"/> is @c false, then this method will fail.
8558	</note>
8559
8560	<result name="VBOX_E_INVALID_OBJECT_STATE">
8561	Operation cannot be canceled.
8562	</result>
8563
8564	</desc>
8565	</method>
8566
8567	</interface>
8568
8569
8570	<!--
8571	// ISnapshot
8572	/////////////////////////////////////////////////////////////////////////
8573	-->
8574
8575	<interface
8576	name="ISnapshot" extends="$unknown"
8577	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8578	wsmap="managed"
8579	>
8580	<desc>
8581	The ISnapshot interface represents a snapshot of the virtual
8582	machine.
8583
8584	Together with the differencing media that are created
8585	when a snapshot is taken, a machine can be brought back to
8586	the exact state it was in when the snapshot was taken.
8587
8588	The ISnapshot interface has no methods, only attributes; snapshots
8589	are controlled through methods of the <link to="IConsole" /> interface
8590	which also manage the media associated with the snapshot.
8591	The following operations exist:
8592
8593	<ul>
8594	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8595	by creating new, empty differencing images for the machine's
8596	media and saving the VM settings and (if the VM is running)
8597	the current VM state in the snapshot.
8598
8599	The differencing images will then receive all data written to
8600	the machine's media, while their parent (base) images
8601	remain unmodified after the snapshot has been taken (see
8602	<link to="IMedium" /> for details about differencing images).
8603	This simplifies restoring a machine to the state of a snapshot:
8604	only the differencing images need to be deleted.
8605
8606	The current machine state is not changed by taking a snapshot.
8607	If the machine is running, it will resume execution after the
8608	snapshot has been taken.
8609	</li>
8610
8611	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8612	a previous snapshot. This resets the machine's state to that of
8613	the previous snapshot by deleting the differencing image of each
8614	of the machine's media and setting the machine's settings
8615	and state to the state that was saved in the snapshot (if any).
8616
8617	This destroys the machine's current state.
8618	</li>
8619
8620	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8621	without affecting the current machine state.
8622
8623	This does not change the machine, but instead frees the resources
8624	allocated when the snapshot was taken: the settings and machine state
8625	is deleted (if any), and the snapshot's differencing image for each
8626	of the machine's media gets merged with its parent image.
8627
8628	Neither the current machine state nor other snapshots are affected
8629	by this operation, except that parent media will be modified
8630	to contain the disk data associated with the snapshot being deleted.
8631	</li>
8632	</ul>
8633
8634	Each snapshot contains the settings of the virtual machine (hardware
8635	configuration etc.). In addition, if the machine was running when the
8636	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8637	the current VM state is saved in the snapshot (similarly to what happens
8638	when a VM's state is saved). The snapshot is then said to
8639	be <i>online</i> because when restoring it, the VM will be running.
8640
8641	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8642	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8643
8644	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8645	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8646	it then contains a so-called "zero execution state", representing a
8647	machine that is powered off.
8648
8649	<h3>Snapshot branches and the "current" snapshot</h3>
8650
8651	Snapshots can be chained, whereby every next snapshot is based on the
8652	previous one. This chaining is related to medium branching
8653	(see the <link to="IMedium"/> description) in that every time
8654	a new snapshot is created, a new differencing medium is implicitly
8655	created for all normal media attached to the machine.
8656
8657	Each virtual machine has a "current snapshot", identified by
8658	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8659	to the last snapshot in the chain. In a future version of VirtualBox,
8660	it will be possible to reset a machine's current state to that of an
8661	earlier snapshot without discarding the current state so that it will be
8662	possible to create alternative snapshot paths in a snapshot tree.
8663
8664	In the current implementation, multiple snapshot branches within one
8665	virtual machine are not allowed. Every machine has a single branch,
8666	and <link to="IConsole::takeSnapshot"/> operation adds a new
8667	snapshot to the top of that branch.
8668	</desc>
8669
8670	<attribute name="id" type="uuid" mod="string" readonly="yes">
8671	<desc>UUID of the snapshot.</desc>
8672	</attribute>
8673
8674	<attribute name="name" type="wstring">
8675	<desc>Short name of the snapshot.</desc>
8676	</attribute>
8677
8678	<attribute name="description" type="wstring">
8679	<desc>Optional description of the snapshot.</desc>
8680	</attribute>
8681
8682	<attribute name="timeStamp" type="long long" readonly="yes">
8683	<desc>
8684	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8685	</desc>
8686	</attribute>
8687
8688	<attribute name="online" type="boolean" readonly="yes">
8689	<desc>
8690	@c true if this snapshot is an online snapshot and @c false otherwise.
8691
8692	When this attribute is @c true, the
8693	<link to="IMachine::stateFilePath"/> attribute of the
8694	<link to="#machine"/> object associated with this snapshot
8695	will point to the saved state file. Otherwise, it will be
8696	an empty string.
8697	</desc>
8698	</attribute>
8699
8700	<attribute name="machine" type="IMachine" readonly="yes">
8701	<desc>
8702	Virtual machine this snapshot is taken on. This object
8703	stores all settings the machine had when taking this snapshot.
8704	<note>
8705	The returned machine object is immutable, i.e. no
8706	any settings can be changed.
8707	</note>
8708	</desc>
8709	</attribute>
8710
8711	<attribute name="parent" type="ISnapshot" readonly="yes">
8712	<desc>
8713	Parent snapshot (a snapshot this one is based on), or
8714	@c null if the snapshot has no parent (i.e. is the first snapshot).
8715	</desc>
8716	</attribute>
8717
8718	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8719	<desc>
8720	Child snapshots (all snapshots having this one as a parent).
8721	</desc>
8722	</attribute>
8723
8724	</interface>
8725
8726
8727	<!--
8728	// IMedium
8729	/////////////////////////////////////////////////////////////////////////
8730	-->
8731
8732	<enum
8733	name="MediumState"
8734	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8735	>
8736	<desc>
8737	Virtual medium state.
8738	<see>IMedium</see>
8739	</desc>
8740
8741	<const name="NotCreated" value="0">
8742	<desc>
8743	Associated medium storage does not exist (either was not created yet or
8744	was deleted).
8745	</desc>
8746	</const>
8747	<const name="Created" value="1">
8748	<desc>
8749	Associated storage exists and accessible; this gets set if the
8750	accessibility check performed by <link to="IMedium::refreshState" />
8751	was successful.
8752	</desc>
8753	</const>
8754	<const name="LockedRead" value="2">
8755	<desc>
8756	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8757	no data modification is possible.
8758	</desc>
8759	</const>
8760	<const name="LockedWrite" value="3">
8761	<desc>
8762	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8763	no concurrent data reading or modification is possible.
8764	</desc>
8765	</const>
8766	<const name="Inaccessible" value="4">
8767	<desc>
8768	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8769	not yet been performed, or else, associated medium storage is not
8770	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8771	is empty, in the second case, it describes the error that occured.
8772	</desc>
8773	</const>
8774	<const name="Creating" value="5">
8775	<desc>
8776	Associated medium storage is being created.
8777	</desc>
8778	</const>
8779	<const name="Deleting" value="6">
8780	<desc>
8781	Associated medium storage is being deleted.
8782	</desc>
8783	</const>
8784	</enum>
8785
8786	<enum
8787	name="MediumType"
8788	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8789	>
8790	<desc>
8791	Virtual medium type.
8792	<see>IMedium</see>
8793	</desc>
8794
8795	<const name="Normal" value="0">
8796	<desc>
8797	Normal medium (attached directly or indirectly, preserved
8798	when taking snapshots).
8799	</desc>
8800	</const>
8801	<const name="Immutable" value="1">
8802	<desc>
8803	Immutable medium (attached indirectly, changes are wiped out
8804	the next time the virtual machine is started).
8805	</desc>
8806	</const>
8807	<const name="Writethrough" value="2">
8808	<desc>
8809	Write through medium (attached directly, ignored when
8810	taking snapshots).
8811	</desc>
8812	</const>
8813	</enum>
8814
8815	<enum
8816	name="MediumVariant"
8817	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8818	>
8819	<desc>
8820	Virtual medium image variant. More than one flag may be set.
8821	<see>IMedium</see>
8822	</desc>
8823
8824	<const name="Standard" value="0">
8825	<desc>
8826	No particular variant requested, results in using the backend default.
8827	</desc>
8828	</const>
8829	<const name="VmdkSplit2G" value="0x01">
8830	<desc>
8831	VMDK image split in chunks of less than 2GByte.
8832	</desc>
8833	</const>
8834	<const name="VmdkStreamOptimized" value="0x04">
8835	<desc>
8836	VMDK streamOptimized image. Special import/export format which is
8837	read-only/append-only.
8838	</desc>
8839	</const>
8840	<const name="VmdkESX" value="0x08">
8841	<desc>
8842	VMDK format variant used on ESX products.
8843	</desc>
8844	</const>
8845	<const name="Fixed" value="0x10000">
8846	<desc>
8847	Fixed image. Only allowed for base images.
8848	</desc>
8849	</const>
8850	<const name="Diff" value="0x20000">
8851	<desc>
8852	Fixed image. Only allowed for base images.
8853	</desc>
8854	</const>
8855	</enum>
8856
8857	<interface
8858	name="IMediumAttachment" extends="$unknown"
8859	uuid="e58eb3eb-8627-428b-bdf8-34487c848de5"
8860	wsmap="struct"
8861	>
8862	<desc>
8863	The IMediumAttachment interface represents the attachment
8864	of a storage medium to a virtual machine. Each machine contains
8865	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8866
8867	Each medium attachment specifies a storage controller as well as a port
8868	and device number. Fixed media (hard disks) will always also specify
8869	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8870	medium. For removeable media, the IMedia instance is optional; it can be
8871	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8872	</desc>
8873
8874	<attribute name="medium" type="IMedium" readonly="yes">
8875	<desc>Medium object associated with this attachment; it
8876	can be @c null for removable devices.</desc>
8877	</attribute>
8878
8879	<attribute name="controller" type="wstring" readonly="yes">
8880	<desc>Name of the storage controller of this attachment; this
8881	refers to one of the controllers in <link to="IMachine::storageControllers" />
8882	by name.</desc>
8883	</attribute>
8884
8885	<attribute name="port" type="long" readonly="yes">
8886	<desc>Port number of this attachment.</desc>
8887	</attribute>
8888
8889	<attribute name="device" type="long" readonly="yes">
8890	<desc>Device slot number of this attachment.</desc>
8891	</attribute>
8892
8893	<attribute name="type" type="DeviceType" readonly="yes">
8894	<desc>Device type of this attachment.</desc>
8895	</attribute>
8896
8897	<attribute name="passthrough" type="boolean" readonly="yes">
8898	<desc>Pass I/O requests through to a device on the host.</desc>
8899	</attribute>
8900
8901	</interface>
8902
8903	<interface
8904	name="IMedium" extends="$unknown"
8905	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
8906	wsmap="managed"
8907	>
8908	<desc>
8909	The IMedium interface represents virtual storage for a machine's
8910	hard disks, CD/DVD or floppy drives. It will typically represent
8911	a disk image on the host, for example a VDI or VMDK file representing
8912	a virtual hard disk, or an ISO or RAW file representing virtual
8913	removable media, but can also point to a network location (e.g.
8914	for iSCSI targets).
8915
8916	Instances of IMedium are connected to virtual machines by way of
8917	medium attachments (see <link to="IMediumAttachment" />), which link
8918	the storage medium to a particular device slot of a storage controller
8919	of the virtual machine.
8920	In the VirtualBox API, virtual storage is therefore always represented
8921	by the following chain of object links:
8922
8923	<ul>
8924	<li><link to="IMachine::storageControllers"/> contains an array of
8925	storage controllers (IDE, SATA, SCSI or a floppy controller;
8926	these are instances of <link to="IStorageController"/>).</li>
8927	<li><link to="IMachine::mediumAttachments"/> contains an array of
8928	medium attachments (instances of <link to="IMediumAttachment"/>),
8929	each containing a storage controller from the above array, a
8930	port/device specification, and an instance of IMedium representing
8931	the medium storage (image file).
8932
8933	For removable media, the storage medium is optional; a medium
8934	attachment with no medium represents a CD/DVD or floppy drive
8935	with no medium inserted. By contrast, hard disk attachments
8936	will always have an IMedium object attached.</li>
8937	<li>Each IMedium in turn points to a storage unit (such as a file
8938	on the host computer or a network resource) that holds actual
8939	data. This location is represented by the <link to="#location"/>
8940	attribute.</li>
8941	</ul>
8942
8943	Existing media are opened using the following methods, depending on the
8944	media type:
8945	<ul>
8946	<li><link to="IVirtualBox::openHardDisk"/></li>
8947	<li><link to="IVirtualBox::openDVDImage"/></li>
8948	<li><link to="IVirtualBox::openFloppyImage"/></li>
8949	</ul>
8950
8951	New hard disk media can be created with the VirtualBox API using the
8952	<link to="IVirtualBox::createHardDisk"/> method.
8953
8954	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8955	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8956	type in a regular file.
8957
8958	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8959	drive; in that case the <link to="#id" /> attribute contains the UUID of
8960	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8961
8962	<h3>Known media</h3>
8963
8964	When an existing medium is opened for the first time, it is automatically
8965	remembered by the given VirtualBox installation or, in other words, becomes
8966	a <i>known medium</i>. Known media are stored in the media
8967	registry transparently maintained by VirtualBox and stored in settings
8968	files so that this registry is preserved when VirtualBox is not running.
8969
8970	Newly created virtual media are remembered only when the associated
8971	storage unit is actually created.
8972
8973	All known media can be enumerated using
8974	<link to="IVirtualBox::hardDisks"/>,
8975	<link to="IVirtualBox::DVDImages"/> and
8976	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8977	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8978	and similar methods or by location using
8979	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8980
8981	Only known media can be attached to virtual machines.
8982
8983	Removing known media from the media registry is performed when the given
8984	medium is closed using the <link to="#close"/> method or when its
8985	associated storage unit is deleted.
8986
8987	<h3>Accessibility checks</h3>
8988
8989	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8990	method is called explicitly on a medium. This is done to make the VirtualBox object
8991	ready for serving requests as fast as possible and let the end-user
8992	application decide if it needs to check media accessibility right away or not.
8993
8994	As a result, when VirtualBox starts up (e.g. the VirtualBox
8995	object gets created for the first time), all known media are in the
8996	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8997	attribute is an empty string because no actual accessibility check has
8998	been made yet.
8999
9000	After calling <link to="#refreshState" />, a medium is considered
9001	<i>accessible</i> if its storage unit can be read. In that case, the
9002	<link to="#state"/> attribute has a value of "Created". If the storage
9003	unit cannot be read (for example, because it is located on a disconnected
9004	network resource, or was accidentally deleted outside VirtualBox),
9005	the medium is considered <i>inaccessible</i>, which is indicated by the
9006	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9007	obtained by reading the <link to="#lastAccessError"/> attribute.
9008
9009	<h3>Medium types</h3>
9010
9011	There are three types of medium behavior (see <link to="MediumType" />):
9012	"normal", "immutable" and "writethrough", represented by the
9013	<link to="#type"/> attribute. The type of the medium defines how the
9014	medium is attached to a virtual machine and what happens when a
9015	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9016	attached medium is taken. At the moment DVD and floppy media are always
9017	of type "writethrough".
9018
9019	All media can be also divided in two groups: <i>base</i> media and
9020	<i>differencing</i> media. A base medium contains all sectors of the
9021	medium data in its own storage and therefore can be used independently.
9022	In contrast, a differencing mediun is a "delta" to some other medium and
9023	contains only those sectors which differ from that other medium, which is
9024	then called a <i>parent</i>. The differencing medium is said to be
9025	<i>linked to</i> that parent. The parent may be itself a differencing
9026	medium, thus forming a chain of linked media. The last element in that
9027	chain must always be a base medium. Note that several differencing
9028	media may be linked to the same parent medium.
9029
9030	Differencing media can be distinguished from base media by querying the
9031	<link to="#parent"/> attribute: base media do not have parents they would
9032	depend on, so the value of this attribute is always @c null for them.
9033	Using this attribute, it is possible to walk up the medium tree (from the
9034	child medium to its parent). It is also possible to walk down the tree
9035	using the <link to="#children"/> attribute.
9036
9037	Note that the type of all differencing media is "Normal"; all other
9038	values are meaningless for them. Base media may be of any type.
9039
9040	<h3>Creating hard disks</h3>
9041
9042	New base hard disks are created using
9043	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9044	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
9045	disks are usually implicitly created by VirtualBox when needed but may
9046	also be created explicitly using <link to="#createDiffStorage"/>.
9047
9048	After the hard disk is successfully created (including the storage unit)
9049	or opened, it becomes a known hard disk (remembered in the internal media
9050	registry). Known hard disks can be attached to a virtual machine, accessed
9051	through <link to="IVirtualBox::getHardDisk"/> and
9052	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
9053	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9054
9055	The following methods, besides <link to="IMedium::close"/>,
9056	automatically remove the hard disk from the media registry:
9057	<ul>
9058	<li><link to="#deleteStorage"/></li>
9059	<li><link to="#mergeTo"/></li>
9060	</ul>
9061
9062	If the storage unit of the hard disk is a regular file in the host's
9063	file system then the rules stated in the description of the
9064	<link to="IMedium::location"/> attribute apply when setting its value. In
9065	addition, a plain file name without any path may be given, in which case
9066	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
9067	folder</link> will be prepended to it.
9068
9069	<h4>Automatic composition of the file name part</h4>
9070
9071	Another extension to the <link to="IMedium::location"/> attribute is that
9072	there is a possibility to cause VirtualBox to compose a unique value for
9073	the file name part of the location using the UUID of the hard disk. This
9074	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9075	e.g. before the storage unit is created, and works as follows. You set the
9076	value of the <link to="IMedium::location"/> attribute to a location
9077	specification which only contains the path specification but not the file
9078	name part and ends with either a forward slash or a backslash character.
9079	In response, VirtualBox will generate a new UUID for the hard disk and
9080	compose the file name using the following pattern:
9081	<pre>
9082	<path>/{<uuid>}.<ext>
9083	</pre>
9084	where <tt><path></tt> is the supplied path specification,
9085	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9086	is the default extension for the storage format of this hard disk. After
9087	that, you may call any of the methods that create a new hard disk storage
9088	unit and they will use the generated UUID and file name.
9089
9090	<h3>Attaching Hard Disks</h3>
9091
9092	Hard disks are attached to virtual machines using the
9093	<link to="IMachine::attachDevice"/> method and detached using the
9094	<link to="IMachine::detachDevice"/> method. Depending on their
9095	<link to="#type"/>, hard disks are attached either
9096	<i>directly</i> or <i>indirectly</i>.
9097
9098	When a hard disk is being attached directly, it is associated with the
9099	virtual machine and used for hard disk operations when the machine is
9100	running. When a hard disk is being attached indirectly, a new differencing
9101	hard disk linked to it is implicitly created and this differencing hard
9102	disk is associated with the machine and used for hard disk operations.
9103	This also means that if <link to="IMachine::attachDevice"/> performs
9104	a direct attachment then the same hard disk will be returned in response
9105	to the subsequent <link to="IMachine::getMedium"/> call; however if
9106	an indirect attachment is performed then
9107	<link to="IMachine::getMedium"/> will return the implicitly created
9108	differencing hard disk, not the original one passed to <link
9109	to="IMachine::attachDevice"/>. In detail:
9110
9111	<ul>
9112	<li><b>Normal base</b> hard disks that do not have children (i.e.
9113	differencing hard disks linked to them) and that are not already
9114	attached to virtual machines in snapshots are attached <b>directly</b>.
9115	Otherwise, they are attached <b>indirectly</b> because having
9116	dependent children or being part of the snapshot makes it impossible
9117	to modify hard disk contents without breaking the integrity of the
9118	dependent party. The <link to="#readOnly"/> attribute allows to
9119	quickly determine the kind of the attachment for the given hard
9120	disk. Note that if a normal base hard disk is to be indirectly
9121	attached to a virtual machine with snapshots then a special
9122	procedure called <i>smart attachment</i> is performed (see below).</li>
9123	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9124	they are attached <b>directly</b> if they do not have children and are
9125	not attached to virtual machines in snapshots, and <b>indirectly</b>
9126	otherwise. Note that the smart attachment procedure is never performed
9127	for differencing hard disks.</li>
9128	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9129	they are designed to be non-writable. If an immutable hard disk is
9130	attached to a virtual machine with snapshots then a special
9131	procedure called smart attachment is performed (see below).</li>
9132	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9133	also as designed. This also means that writethrough hard disks cannot
9134	have other hard disks linked to them at all.</li>
9135	</ul>
9136
9137	Note that the same hard disk, regardless of its type, may be attached to
9138	more than one virtual machine at a time. In this case, the machine that is
9139	started first gains exclusive access to the hard disk and attempts to
9140	start other machines having this hard disk attached will fail until the
9141	first machine is powered down.
9142
9143	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9144	that the given hard disk remains associated with the given machine after a
9145	successful <link to="IMachine::detachDevice"/> call until
9146	<link to="IMachine::saveSettings"/> is called to save all changes to
9147	machine settings to disk. This deferring is necessary to guarantee that
9148	the hard disk configuration may be restored at any time by a call to
9149	<link to="IMachine::discardSettings"/> before the settings
9150	are saved (committed).
9151
9152	Note that if <link to="IMachine::discardSettings"/> is called after
9153	indirectly attaching some hard disks to the machine but before a call to
9154	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9155	all differencing hard disks implicitly created by
9156	<link to="IMachine::attachDevice"/> for these indirect attachments.
9157	Such implicitly created hard disks will also be immediately deleted when
9158	detached explicitly using the <link to="IMachine::detachDevice"/>
9159	call if it is made before <link to="IMachine::saveSettings"/>. This
9160	implicit deletion is safe because newly created differencing hard
9161	disks do not contain any user data.
9162
9163	However, keep in mind that detaching differencing hard disks that were
9164	implicitly created by <link to="IMachine::attachDevice"/>
9165	before the last <link to="IMachine::saveSettings"/> call will
9166	<b>not</b> implicitly delete them as they may already contain some data
9167	(for example, as a result of virtual machine execution). If these hard
9168	disks are no more necessary, the caller can always delete them explicitly
9169	using <link to="#deleteStorage"/> after they are actually de-associated
9170	from this machine by the <link to="IMachine::saveSettings"/> call.
9171
9172	<h3>Smart Attachment</h3>
9173
9174	When normal base or immutable hard disks are indirectly attached to a
9175	virtual machine then some additional steps are performed to make sure the
9176	virtual machine will have the most recent "view" of the hard disk being
9177	attached. These steps include walking through the machine's snapshots
9178	starting from the current one and going through ancestors up to the first
9179	snapshot. Hard disks attached to the virtual machine in all
9180	of the encountered snapshots are checked whether they are descendants of
9181	the given normal base or immutable hard disk. The first found child (which
9182	is the differencing hard disk) will be used instead of the normal base or
9183	immutable hard disk as a parent for creating a new differencing hard disk
9184	that will be actually attached to the machine. And only if no descendants
9185	are found or if the virtual machine does not have any snapshots then the
9186	normal base or immutable hard disk will be used itself as a parent for
9187	this differencing hard disk.
9188
9189	It is easier to explain what smart attachment does using the
9190	following example:
9191	<pre>
9192	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9193
9194	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9195	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9196	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9197	Snapshot 4 (none) Snapshot 4 (none)
9198	CurState (none) CurState (D3->D2.vdi)
9199
9200	NOT
9201	...
9202	CurState (D3->B.vdi)
9203	</pre>
9204	The first column is the virtual machine configuration before the base hard
9205	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9206	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9207	mean that the hard disk that is actually attached to the machine is a
9208	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9209	another hard disk, <tt>B.vdi</tt>.
9210
9211	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9212	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9213	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9214	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9215	it cannot be attached directly and needs an indirect attachment (i.e.
9216	implicit creation of a new differencing hard disk). Due to the smart
9217	attachment procedure, the new differencing hard disk
9218	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9219	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9220	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9221	machine.
9222
9223	Note that if there is more than one descendant hard disk of the given base
9224	hard disk found in a snapshot, and there is an exact device, channel and
9225	bus match, then this exact match will be used. Otherwise, the youngest
9226	descendant will be picked up.
9227
9228	There is one more important aspect of the smart attachment procedure which
9229	is not related to snapshots at all. Before walking through the snapshots
9230	as described above, the backup copy of the current list of hard disk
9231	attachment is searched for descendants. This backup copy is created when
9232	the hard disk configuration is changed for the first time after the last
9233	<link to="IMachine::saveSettings"/> call and used by
9234	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9235	changes. When such a descendant is found in this backup copy, it will be
9236	simply re-attached back, without creating a new differencing hard disk for
9237	it. This optimization is necessary to make it possible to re-attach the
9238	base or immutable hard disk to a different bus, channel or device slot
9239	without losing the contents of the differencing hard disk actually
9240	attached to the machine in place of it.
9241	</desc>
9242
9243	<attribute name="id" type="uuid" mod="string" readonly="yes">
9244	<desc>
9245	UUID of the medium. For a newly created medium, this value is a randomly
9246	generated UUID.
9247
9248	<note>
9249	For media in one of MediumState_NotCreated, MediumState_Creating or
9250	MediumState_Deleting states, the value of this property is undefined
9251	and will most likely be an empty UUID.
9252	</note>
9253	</desc>
9254	</attribute>
9255
9256	<attribute name="description" type="wstring">
9257	<desc>
9258	Optional description of the medium. For a newly created medium the value
9259	of this attribute is an empty string.
9260
9261	Medium types that don't support this attribute will return E_NOTIMPL in
9262	attempt to get or set this attribute's value.
9263
9264	<note>
9265	For some storage types, reading this attribute may return an outdated
9266	(last known) value when <link to="#state"/> is <link
9267	to="MediumState_Inaccessible"/> or <link
9268	to="MediumState_LockedWrite"/> because the value of this attribute is
9269	stored within the storage unit itself. Also note that changing the
9270	attribute value is not possible in such case, as well as when the
9271	medium is the <link to="MediumState_LockedRead"/> state.
9272	</note>
9273	</desc>
9274	</attribute>
9275
9276	<attribute name="state" type="MediumState" readonly="yes">
9277	<desc>
9278	Returns the current medium state, which is the last state set by
9279	the accessibility check performed by <link to="#refreshState"/>.
9280	If that method has not yet been called on the medium, the state
9281	is "Inaccessible"; as opposed to truly inaccessible media, the
9282	value of <link to="#lastAccessError"/> will be an empty string in
9283	that case.
9284
9285	<note>As of version 3.1, this no longer performs an accessibility check
9286	automatically; call <link to="#refreshState"/> for that.
9287	</note>
9288	</desc>
9289	</attribute>
9290
9291	<attribute name="location" type="wstring">
9292	<desc>
9293	Location of the storage unit holding medium data.
9294
9295	The format of the location string is medium type specific. For medium
9296	types using regular files in a host's file system, the location
9297	string is the full file name.
9298
9299	Some medium types may support changing the storage unit location by
9300	simply changing the value of this property. If this operation is not
9301	supported, the implementation will return E_NOTIMPL in attempt to set
9302	this attribute's value.
9303
9304	When setting a value of the location attribute which is a regular file
9305	in the host's file system, the given file name may be either relative to
9306	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9307	absolute. Note that if the given location specification does not contain
9308	the file extension part then a proper default extension will be
9309	automatically appended by the implementation depending on the medium type.
9310	</desc>
9311	</attribute>
9312
9313	<attribute name="name" type="wstring" readonly="yes">
9314	<desc>
9315	Name of the storage unit holding medium data.
9316
9317	The returned string is a short version of the <link to="#location"/>
9318	attribute that is suitable for representing the medium in situations
9319	where the full location specification is too long (such as lists
9320	and comboboxes in GUI frontends). This string is also used by frontends
9321	to sort the media list alphabetically when needed.
9322
9323	For example, for locations that are regular files in the host's file
9324	system, the value of this attribute is just the file name (+ extension),
9325	without the path specification.
9326
9327	Note that as opposed to the <link to="#location"/> attribute, the name
9328	attribute will not necessary be unique for a list of media of the
9329	given type and format.
9330	</desc>
9331	</attribute>
9332
9333	<attribute name="deviceType" type="DeviceType" readonly="yes">
9334	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9335	medium.</desc>
9336	</attribute>
9337
9338	<attribute name="hostDrive" type="boolean" readonly="yes">
9339	<desc>True if this corresponds to a drive on the host.</desc>
9340	</attribute>
9341
9342	<attribute name="size" type="unsigned long long" readonly="yes">
9343	<desc>
9344	Physical size of the storage unit used to hold medium data (in bytes).
9345
9346	<note>
9347	For media whose <link to="#state"/> is <link
9348	to="MediumState_Inaccessible"/>, the value of this property is the
9349	last known size. For <link to="MediumState_NotCreated"/> media,
9350	the returned value is zero.
9351	</note>
9352	</desc>
9353	</attribute>
9354
9355	<attribute name="format" type="wstring" readonly="yes">
9356	<desc>
9357	Storage format of this medium.
9358
9359	The value of this attribute is a string that specifies a backend used
9360	to store medium data. The storage format is defined when you create a
9361	new medium or automatically detected when you open an existing medium,
9362	and cannot be changed later.
9363
9364	The list of all storage formats supported by this VirtualBox
9365	installation can be obtained using
9366	<link to="ISystemProperties::mediumFormats"/>.
9367	</desc>
9368	</attribute>
9369
9370	<attribute name="type" type="MediumType">
9371	<desc>
9372	Type (role) of this medium.
9373
9374	The following constraints apply when changing the value of this
9375	attribute:
9376	<ul>
9377	<li>If a medium is attached to a virtual machine (either in the
9378	current state or in one of the snapshots), its type cannot be
9379	changed.
9380	</li>
9381	<li>As long as the medium has children, its type cannot be set
9382	to <link to="MediumType_Writethrough"/>.
9383	</li>
9384	<li>The type of all differencing media is
9385	<link to="MediumType_Normal"/> and cannot be changed.
9386	</li>
9387	</ul>
9388
9389	The type of a newly created or opened medium is set to
9390	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9391	which have a type of <link to="MediumType_Writethrough"/>.
9392	</desc>
9393	</attribute>
9394
9395	<attribute name="parent" type="IMedium" readonly="yes">
9396	<desc>
9397	Parent of this medium (the medium this medium is directly based
9398	on).
9399
9400	Only differencing media have parents. For base (non-differencing)
9401	media, @c null is returned.
9402	</desc>
9403	</attribute>
9404
9405	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9406	<desc>
9407	Children of this medium (all differencing media directly based
9408	on this medium). A @c null array is returned if this medium
9409	does not have any children.
9410	</desc>
9411	</attribute>
9412
9413	<attribute name="base" type="IMedium" readonly="yes">
9414	<desc>
9415	Base medium of this medium.
9416
9417	If this is a differencing medium, its base medium is the medium
9418	the given medium branch starts from. For all other types of media, this
9419	property returns the medium object itself (i.e. the same object this
9420	property is read on).
9421	</desc>
9422	</attribute>
9423
9424	<attribute name="readOnly" type="boolean" readonly="yes">
9425	<desc>
9426	Returns @c true if this medium is read-only and @c false otherwise.
9427
9428	A medium is considered to be read-only when its contents cannot be
9429	modified without breaking the integrity of other parties that depend on
9430	this medium such as its child media or snapshots of virtual machines
9431	where this medium is attached to these machines. If there are no
9432	children and no such snapshots then there is no dependency and the
9433	medium is not read-only.
9434
9435	The value of this attribute can be used to determine the kind of the
9436	attachment that will take place when attaching this medium to a
9437	virtual machine. If the value is @c false then the medium will
9438	be attached directly. If the value is @c true then the medium
9439	will be attached indirectly by creating a new differencing child
9440	medium for that. See the interface description for more information.
9441
9442	Note that all <link to="MediumType_Immutable">Immutable</link> media
9443	are always read-only while all
9444	<link to="MediumType_Writethrough">Writethrough</link> media are
9445	always not.
9446
9447	<note>
9448	The read-only condition represented by this attribute is related to
9449	the medium type and usage, not to the current
9450	<link to="IMedium::state">medium state</link> and not to the read-only
9451	state of the storage unit.
9452	</note>
9453	</desc>
9454	</attribute>
9455
9456	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9457	<desc>
9458	Logical size of this medium (in megabytes), as reported to the
9459	guest OS running inside the virtual machine this medium is
9460	attached to. The logical size is defined when the medium is created
9461	and cannot be changed later.
9462
9463	<note>
9464	Reading this property on a differencing medium will return the size
9465	of its <link to="#base"/> medium.
9466	</note>
9467	<note>
9468	For media whose state is <link to="#state"/> is <link
9469	to="MediumState_Inaccessible"/>, the value of this property is the
9470	last known logical size. For <link to="MediumaState_NotCreated"/>
9471	media, the returned value is zero.
9472	</note>
9473	</desc>
9474	</attribute>
9475
9476	<attribute name="autoReset" type="boolean">
9477	<desc>
9478	Whether this differencing medium will be automatically reset each
9479	time a virtual machine it is attached to is powered up. This
9480	attribute is automatically set to @c true for the last
9481	differencing image of an "immutable" medium (see
9482	<link to="MediumType" />).
9483
9484	See <link to="#reset"/> for more information about resetting
9485	differencing media.
9486
9487	<note>
9488	Reading this property on a base (non-differencing) medium will
9489	always @c false. Changing the value of this property in this
9490	case is not supported.
9491	</note>
9492
9493	<result name="VBOX_E_NOT_SUPPORTED">
9494	This is not a differencing medium (when changing the attribute
9495	value).
9496	</result>
9497	</desc>
9498	</attribute>
9499
9500	<attribute name="lastAccessError" type="wstring" readonly="yes">
9501	<desc>
9502	Text message that represents the result of the last accessibility
9503	check performed by <link to="#refreshState"/>.
9504
9505	An empty string is returned if the last accessibility check
9506	was successful or has not yet been called. As a result, if
9507	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9508	then <link to="#refreshState"/> has yet to be called; this is the
9509	default value of media after VirtualBox initialization.
9510	A non-empty string indicates a failure and should normally describe
9511	a reason of the failure (for example, a file read error).
9512	</desc>
9513	</attribute>
9514
9515	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9516	<desc>
9517	Array of UUIDs of all machines this medium is attached to.
9518
9519	A @c null array is returned if this medium is not attached to any
9520	machine or to any machine's snapshot.
9521
9522	<note>
9523	The returned array will include a machine even if this medium is not
9524	attached to that machine in the current state but attached to it in
9525	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9526	details.
9527	</note>
9528	</desc>
9529	</attribute>
9530
9531	<method name="refreshState">
9532	<desc>
9533	If the current medium state (see <link to="MediumState"/>) is one of
9534	"Created", "Inaccessible" or "LockedRead", then this performs an
9535	accessibility check on the medium and sets the value of the <link to="#state"/>
9536	attribute accordingly; that value is also returned for convenience.
9537
9538	For all other state values, this does not perform a refresh but returns
9539	the state only.
9540
9541	The refresh, if performed, may take a long time (several seconds or even
9542	minutes, depending on the storage unit location and format) because it performs an
9543	accessibility check of the storage unit. This check may cause a significant
9544	delay if the storage unit of the given medium is, for example, a file located
9545	on a network share which is not currently accessible due to connectivity
9546	problems. In that case, the call will not return until a timeout
9547	interval defined by the host OS for this operation expires. For this reason,
9548	it is recommended to never read this attribute on the main UI thread to avoid
9549	making the UI unresponsive.
9550
9551	If the last known state of the medium is "Created" and the accessibility
9552	check fails, then the state would be set to "Inaccessible", and
9553	<link to="#lastAccessError"/> may be used to get more details about the
9554	failure. If the state of the medium is "LockedRead", then it remains the
9555	same, and a non-empty value of <link to="#lastAccessError"/> will
9556	indicate a failed accessibility check in this case.
9557
9558	Note that not all medium states are applicable to all medium types.
9559	</desc>
9560	<param name="state" type="MediumState" dir="return">
9561	<desc>
9562	New medium state.
9563	</desc>
9564	</param>
9565	</method>
9566
9567	<method name="getSnapshotIds">
9568	<desc>
9569	Returns an array of UUIDs of all snapshots of the given machine where
9570	this medium is attached to.
9571
9572	If the medium is attached to the machine in the current state, then the
9573	first element in the array will always be the ID of the queried machine
9574	(i.e. the value equal to the @c machineId argument), followed by
9575	snapshot IDs (if any).
9576
9577	If the medium is not attached to the machine in the current state, then
9578	the array will contain only snapshot IDs.
9579
9580	The returned array may be @c null if this medium is not attached
9581	to the given machine at all, neither in the current state nor in one of
9582	the snapshots.
9583	</desc>
9584	<param name="machineId" type="uuid" mod="string" dir="in">
9585	<desc>
9586	UUID of the machine to query.
9587	</desc>
9588	</param>
9589	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9590	<desc>
9591	Array of snapshot UUIDs of the given machine using this medium.
9592	</desc>
9593	</param>
9594	</method>
9595
9596	<method name="lockRead">
9597	<desc>
9598	Locks this medium for reading.
9599
9600	A read lock is shared: many clients can simultaneously lock the
9601	same medium for reading unless it is already locked for writing (see
9602	<link to="#lockWrite"/>) in which case an error is returned.
9603
9604	When the medium is locked for reading, it cannot be modified
9605	from within VirtualBox. This means that any method that changes
9606	the properties of this medium or contents of the storage unit
9607	will return an error (unless explicitly stated otherwise). That
9608	includes an attempt to start a virtual machine that wants to
9609	write to the the medium.
9610
9611	When the virtual machine is started up, it locks for reading all
9612	media it uses in read-only mode. If some medium cannot be locked
9613	for reading, the startup procedure will fail.
9614	A medium is typically locked for reading while it is used by a running
9615	virtual machine but has a depending differencing image that receives
9616	the actual write operations. This way one base medium can have
9617	multiple child differencing images which can be written to
9618	simultaneously. Read-only media such as DVD and floppy images are
9619	also locked for reading only (so they can be in use by multiple
9620	machines simultaneously).
9621
9622	A medium is also locked for reading when it is the source of a
9623	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9624
9625	The medium locked for reading must be unlocked using the <link
9626	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9627	can be nested and must be followed by the same number of paired
9628	<link to="#unlockRead"/> calls.
9629
9630	This method sets the medium state (see <link to="#state"/>) to
9631	"LockedRead" on success. The medium's previous state must be
9632	one of "Created", "Inaccessible" or "LockedRead".
9633
9634	Locking an inaccessible medium is not an error; this method performs
9635	a logical lock that prevents modifications of this medium through
9636	the VirtualBox API, not a physical file-system lock of the underlying
9637	storage unit.
9638
9639	This method returns the current state of the medium
9640	<i>before</i> the operation.
9641
9642	<result name="VBOX_E_INVALID_OBJECT_STATE">
9643	Invalid medium state (e.g. not created, locked, inaccessible,
9644	creating, deleting).
9645	</result>
9646
9647	</desc>
9648	<param name="state" type="MediumState" dir="return">
9649	<desc>
9650	State of the medium after the operation.
9651	</desc>
9652	</param>
9653	</method>
9654
9655	<method name="unlockRead">
9656	<desc>
9657	Cancels the read lock previously set by <link to="#lockRead"/>.
9658
9659	For both success and failure, this method returns the current state
9660	of the medium <i>after</i> the operation.
9661
9662	See <link to="#lockRead"/> for more details.
9663
9664	<result name="VBOX_E_INVALID_OBJECT_STATE">
9665	Medium not locked for reading.
9666	</result>
9667
9668	</desc>
9669	<param name="state" type="MediumState" dir="return">
9670	<desc>
9671	State of the medium after the operation.
9672	</desc>
9673	</param>
9674	</method>
9675
9676	<method name="lockWrite">
9677	<desc>
9678	Locks this medium for writing.
9679
9680	A write lock, as opposed to <link to="#lockRead"/>, is
9681	exclusive: there may be only one client holding a write lock,
9682	and there may be no read locks while the write lock is held.
9683	As a result, read-locking fails if a write lock is held, and
9684	write-locking fails if either a read or another write lock is held.
9685
9686	When a medium is locked for writing, it cannot be modified
9687	from within VirtualBox, and it is not guaranteed that the values
9688	of its properties are up-to-date. Any method that changes the
9689	properties of this medium or contents of the storage unit will
9690	return an error (unless explicitly stated otherwise).
9691
9692	When a virtual machine is started up, it locks for writing all
9693	media it uses to write data to. If any medium could not be locked
9694	for writing, the startup procedure will fail. If a medium has
9695	differencing images, then while the machine is running, only
9696	the last ("leaf") differencing image is locked for writing,
9697	whereas its parents are locked for reading only.
9698
9699	A medium is also locked for writing when it is the target of a
9700	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9701
9702	The medium locked for writing must be unlocked using the <link
9703	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9704
9705	This method sets the medium state (see <link to="#state"/>) to
9706	"LockedWrite" on success. The medium's previous state must be
9707	either "Created" or "Inaccessible".
9708
9709	Locking an inaccessible medium is not an error; this method performs
9710	a logical lock that prevents modifications of this medium through
9711	the VirtualBox API, not a physical file-system lock of the underlying
9712	storage unit.
9713
9714	For both, success and failure, this method returns the current
9715	state of the medium <i>before</i> the operation.
9716
9717	<result name="VBOX_E_INVALID_OBJECT_STATE">
9718	Invalid medium state (e.g. not created, locked, inaccessible,
9719	creating, deleting).
9720	</result>
9721
9722	</desc>
9723	<param name="state" type="MediumState" dir="return">
9724	<desc>
9725	State of the medium after the operation.
9726	</desc>
9727	</param>
9728	</method>
9729
9730	<method name="unlockWrite">
9731	<desc>
9732	Cancels the write lock previously set by <link to="#lockWrite"/>.
9733
9734	For both success and failure, this method returns the current
9735	state of the medium <i>after</i> the operation.
9736
9737	See <link to="#lockWrite"/> for more details.
9738
9739	<result name="VBOX_E_INVALID_OBJECT_STATE">
9740	Medium not locked for writing.
9741	</result>
9742
9743	</desc>
9744	<param name="state" type="MediumState" dir="return">
9745	<desc>
9746	State of the medium after the operation.
9747	</desc>
9748	</param>
9749	</method>
9750
9751	<method name="close">
9752	<desc>
9753	Closes this medium.
9754
9755	The medium must not be attached to any known virtual machine
9756	and must not have any known child media, otherwise the
9757	operation will fail.
9758
9759	When the medium is successfully closed, it gets removed from
9760	the list of remembered media, but its storage unit is not
9761	deleted. In particular, this means that this medium can be
9762	later opened again using the <link
9763	to="IVirtualBox::openHardDisk"/> call.
9764
9765	Note that after this method successfully returns, the given medium
9766	object becomes uninitialized. This means that any attempt
9767	to call any of its methods or attributes will fail with the
9768	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9769
9770	<result name="VBOX_E_INVALID_OBJECT_STATE">
9771	Invalid medium state (other than not created, created or
9772	inaccessible).
9773	</result>
9774	<result name="VBOX_E_OBJECT_IN_USE">
9775	Medium attached to virtual machine.
9776	</result>
9777	<result name="VBOX_E_FILE_ERROR">
9778	Settings file not accessible.
9779	</result>
9780	<result name="VBOX_E_XML_ERROR">
9781	Could not parse the settings file.
9782	</result>
9783
9784	</desc>
9785	</method>
9786
9787	<!-- storage methods -->
9788
9789	<method name="getProperty">
9790	<desc>
9791	Returns the value of the custom medium property with the given name.
9792
9793	The list of all properties supported by the given medium format can
9794	be obtained with <link to="IMediumFormat::describeProperties"/>.
9795
9796	Note that if this method returns an empty string in @a value, the
9797	requested property is supported but currently not assigned any value.
9798
9799	<result name="VBOX_E_OBJECT_NOT_FOUND">
9800	Requested property does not exist (not supported by the format).
9801	</result>
9802	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9803	</desc>
9804	<param name="name" type="wstring" dir="in">
9805	<desc>Name of the property to get.</desc>
9806	</param>
9807	<param name="value" type="wstring" dir="return">
9808	<desc>Current property value.</desc>
9809	</param>
9810	</method>
9811
9812	<method name="setProperty">
9813	<desc>
9814	Sets the value of the custom medium property with the given name.
9815
9816	The list of all properties supported by the given medium format can
9817	be obtained with <link to="IMediumFormat::describeProperties"/>.
9818
9819	Note that setting the property value to @c null or an empty string is
9820	equivalent to deleting the existing value. A default value (if it is
9821	defined for this property) will be used by the format backend in this
9822	case.
9823
9824	<result name="VBOX_E_OBJECT_NOT_FOUND">
9825	Requested property does not exist (not supported by the format).
9826	</result>
9827	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9828	</desc>
9829	<param name="name" type="wstring" dir="in">
9830	<desc>Name of the property to set.</desc>
9831	</param>
9832	<param name="value" type="wstring" dir="in">
9833	<desc>Property value to set.</desc>
9834	</param>
9835	</method>
9836
9837	<method name="getProperties">
9838	<desc>
9839	Returns values for a group of properties in one call.
9840
9841	The names of the properties to get are specified using the @a names
9842	argument which is a list of comma-separated property names or
9843	an empty string if all properties are to be returned. Note that currently
9844	the value of this argument is ignored and the method always returns all
9845	existing properties.
9846
9847	The list of all properties supported by the given medium format can
9848	be obtained with <link to="IMediumFormat::describeProperties"/>.
9849
9850	The method returns two arrays, the array of property names corresponding
9851	to the @a names argument and the current values of these properties.
9852	Both arrays have the same number of elements with each elemend at the
9853	given index in the first array corresponds to an element at the same
9854	index in the second array.
9855
9856	Note that for properties that do not have assigned values,
9857	an empty string is returned at the appropriate index in the
9858	@a returnValues array.
9859
9860	</desc>
9861	<param name="names" type="wstring" dir="in">
9862	<desc>
9863	Names of properties to get.
9864	</desc>
9865	</param>
9866	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9867	<desc>Names of returned properties.</desc>
9868	</param>
9869	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9870	<desc>Values of returned properties.</desc>
9871	</param>
9872	</method>
9873
9874	<method name="setProperties">
9875	<desc>
9876	Sets values for a group of properties in one call.
9877
9878	The names of the properties to set are passed in the @a names
9879	array along with the new values for them in the @a values array. Both
9880	arrays have the same number of elements with each elemend at the given
9881	index in the first array corresponding to an element at the same index
9882	in the second array.
9883
9884	If there is at least one property name in @a names that is not valid,
9885	the method will fail before changing the values of any other properties
9886	from the @a names array.
9887
9888	Using this method over <link to="#setProperty"/> is preferred if you
9889	need to set several properties at once since it will result into less
9890	IPC calls.
9891
9892	The list of all properties supported by the given medium format can
9893	be obtained with <link to="IMediumFormat::describeProperties"/>.
9894
9895	Note that setting the property value to @c null or an empty string is
9896	equivalent to deleting the existing value. A default value (if it is
9897	defined for this property) will be used by the format backend in this
9898	case.
9899	</desc>
9900	<param name="names" type="wstring" safearray="yes" dir="in">
9901	<desc>Names of properties to set.</desc>
9902	</param>
9903	<param name="values" type="wstring" safearray="yes" dir="in">
9904	<desc>Values of properties to set.</desc>
9905	</param>
9906	</method>
9907
9908	<!-- storage methods -->
9909
9910	<method name="createBaseStorage">
9911	<desc>
9912	Starts creating a hard disk storage unit (fixed/dynamic, according
9913	to the variant flags) in in the background. The previous storage unit
9914	created for this object, if any, must first be deleted using
9915	<link to="#deleteStorage"/>, otherwise the operation will fail.
9916
9917	Before the operation starts, the medium is placed in
9918	<link to="MediumState_Creating"/> state. If the create operation
9919	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9920	state.
9921
9922	After the returned progress object reports that the operation has
9923	successfully completed, the medium state will be set to <link
9924	to="MediumState_Created"/>, the medium will be remembered by this
9925	VirtualBox installation and may be attached to virtual machines.
9926
9927	<result name="VBOX_E_NOT_SUPPORTED">
9928	The variant of storage creation operation is not supported. See <link
9929	to="IMediumFormat::capabilities"/>.
9930	</result>
9931	</desc>
9932	<param name="logicalSize" type="unsigned long long" dir="in">
9933	<desc>Maximum logical size of the medium in megabytes.</desc>
9934	</param>
9935	<param name="variant" type="MediumVariant" dir="in">
9936	<desc>Exact image variant which should be created.</desc>
9937	</param>
9938	<param name="progress" type="IProgress" dir="return">
9939	<desc>Progress object to track the operation completion.</desc>
9940	</param>
9941	</method>
9942
9943	<method name="deleteStorage">
9944	<desc>
9945	Starts deleting the storage unit of this medium.
9946
9947	The medium must not be attached to any known virtual machine and must
9948	not have any known child media, otherwise the operation will fail.
9949	It will also fail if there is no storage unit to delete or if deletion
9950	is already in progress, or if the medium is being in use (locked for
9951	read or for write) or inaccessible. Therefore, the only valid state for
9952	this operation to succeed is <link to="MediumState_Created"/>.
9953
9954	Before the operation starts, the medium is placed in
9955	<link to="MediumState_Deleting"/> state and gets removed from the list
9956	of remembered hard disks (media registry). If the delete operation
9957	fails, the medium will be remembered again and placed back to
9958	<link to="MediumState_Created"/> state.
9959
9960	After the returned progress object reports that the operation is
9961	complete, the medium state will be set to
9962	<link to="MediumState_NotCreated"/> and you will be able to use one of
9963	the storage creation methods to create it again.
9964
9965	<see>#close()</see>
9966
9967	<result name="VBOX_E_OBJECT_IN_USE">
9968	Medium is attached to a virtual machine.
9969	</result>
9970	<result name="VBOX_E_NOT_SUPPORTED">
9971	Storage deletion is not allowed because neither of storage creation
9972	operations are supported. See
9973	<link to="IMediumFormat::capabilities"/>.
9974	</result>
9975
9976	<note>
9977	If the deletion operation fails, it is not guaranteed that the storage
9978	unit still exists. You may check the <link to="IMedium::state"/> value
9979	to answer this question.
9980	</note>
9981	</desc>
9982	<param name="progress" type="IProgress" dir="return">
9983	<desc>Progress object to track the operation completion.</desc>
9984	</param>
9985	</method>
9986
9987	<!-- diff methods -->
9988
9989	<method name="createDiffStorage">
9990	<desc>
9991	Starts creating an empty differencing storage unit based on this
9992	medium in the format and at the location defined by the @a target
9993	argument.
9994
9995	The target medium must be in <link to="MediumState_NotCreated"/>
9996	state (i.e. must not have an existing storage unit). Upon successful
9997	completion, this operation will set the type of the target medium to
9998	<link to="MediumType_Normal"/> and create a storage unit necessary to
9999	represent the differencing medium data in the given format (according
10000	to the storage format of the target object).
10001
10002	After the returned progress object reports that the operation is
10003	successfully complete, the target medium gets remembered by this
10004	VirtualBox installation and may be attached to virtual machines.
10005
10006	<note>
10007	The medium will be set to <link to="MediumState_LockedRead"/>
10008	state for the duration of this operation.
10009	</note>
10010	<result name="VBOX_E_OBJECT_IN_USE">
10011	Medium not in @c NotCreated state.
10012	</result>
10013	</desc>
10014	<param name="target" type="IMedium" dir="in">
10015	<desc>Target medium.</desc>
10016	</param>
10017	<param name="variant" type="MediumVariant" dir="in">
10018	<desc>Exact image variant which should be created.</desc>
10019	</param>
10020	<param name="progress" type="IProgress" dir="return">
10021	<desc>Progress object to track the operation completion.</desc>
10022	</param>
10023	</method>
10024
10025	<method name="mergeTo">
10026	<desc>
10027	Starts merging the contents of this medium and all intermediate
10028	differencing media in the chain to the given target medium.
10029
10030	The target medium must be either a descendant of this medium or
10031	its ancestor (otherwise this method will immediately return a failure).
10032	It follows that there are two logical directions of the merge operation:
10033	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10034	ancestor (<i>backward merge</i>). Let us consider the following medium
10035	chain:
10036
10037	<pre>Base <- Diff_1 <- Diff_2</pre>
10038
10039	Here, calling this method on the <tt>Base</tt> medium object with
10040	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10041	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10042	merge. Note that in both cases the contents of the resulting medium
10043	will be the same, the only difference is the medium object that takes
10044	the result of the merge operation. In case of the forward merge in the
10045	above example, the result will be written to <tt>Diff_2</tt>; in case of
10046	the backward merge, the result will be written to <tt>Base</tt>. In
10047	other words, the result of the operation is always stored in the target
10048	medium.
10049
10050	Upon successful operation completion, the storage units of all media in
10051	the chain between this (source) medium and the target medium, including
10052	the source medium itself, will be automatically deleted and the
10053	relevant medium objects (including this medium) will become
10054	uninitialized. This means that any attempt to call any of
10055	their methods or attributes will fail with the
10056	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10057	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10058	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10059	Note that <tt>Diff_2</tt> in this case will become a base medium
10060	itself since it will no longer be based on any other medium.
10061
10062	Considering the above, all of the following conditions must be met in
10063	order for the merge operation to succeed:
10064	<ul>
10065	<li>
10066	Neither this (source) medium nor any intermediate
10067	differencing medium in the chain between it and the target
10068	medium is attached to any virtual machine.
10069	</li>
10070	<li>
10071	Neither the source medium nor the target medium is an
10072	<link to="MediumType_Immutable"/> medium.
10073	</li>
10074	<li>
10075	The part of the medium tree from the source medium to the
10076	target medium is a linear chain, i.e. all medium in this
10077	chain have exactly one child which is the next medium in this
10078	chain. The only exception from this rule is the target medium in
10079	the forward merge operation; it is allowed to have any number of
10080	child media because the merge operation will not change its
10081	logical contents (as it is seen by the guest OS or by children).
10082	</li>
10083	<li>
10084	None of the involved media are in
10085	<link to="MediumState_LockedRead"/> or
10086	<link to="MediumState_LockedWrite"/> state.
10087	</li>
10088	</ul>
10089
10090	<note>
10091	This (source) medium and all intermediates will be placed to <link
10092	to="MediumState_Deleting"/> state and the target medium will be
10093	placed to <link to="MediumState_LockedWrite"/> state and for the
10094	duration of this operation.
10095	</note>
10096	</desc>
10097	<param name="targetId" type="uuid" mod="string" dir="in">
10098	<desc>UUID of the target ancestor or descendant medium.</desc>
10099	</param>
10100	<param name="progress" type="IProgress" dir="return">
10101	<desc>Progress object to track the operation completion.</desc>
10102	</param>
10103	</method>
10104
10105	<!-- clone method -->
10106
10107	<method name="cloneTo">
10108	<desc>
10109	Starts creating a clone of this medium in the format and at the
10110	location defined by the @a target argument.
10111
10112	The target medium must be either in <link to="MediumState_NotCreated"/>
10113	state (i.e. must not have an existing storage unit) or in
10114	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10115	big enough to hold the data or else the copy will be partial). Upon
10116	successful completion, the cloned medium will contain exactly the
10117	same sector data as the medium being cloned, except that in the
10118	first case a new UUID for the clone will be randomly generated, and in
10119	the second case the UUID will remain unchanged.
10120
10121	The @a parent argument defines which medium will be the parent
10122	of the clone. Passing a @c null reference indicates that the clone will
10123	be a base image, i.e. completely independent. It is possible to specify
10124	an arbitrary medium for this parameter, including the parent of the
10125	medium which is being cloned. Even cloning to a child of the source
10126	medium is possible. Note that when cloning to an existing image, the
10127	@a parent irgument is ignored.
10128
10129	After the returned progress object reports that the operation is
10130	successfully complete, the target medium gets remembered by this
10131	VirtualBox installation and may be attached to virtual machines.
10132
10133	<note>
10134	This medium will be placed to <link to="MediumState_LockedRead"/>
10135	state for the duration of this operation.
10136	</note>
10137	<result name="E_NOTIMPL">
10138	The specified cloning variant is not supported at the moment.
10139	</result>
10140	</desc>
10141	<param name="target" type="IMedium" dir="in">
10142	<desc>Target medium.</desc>
10143	</param>
10144	<param name="variant" type="MediumVariant" dir="in">
10145	<desc>Exact image variant which should be created.</desc>
10146	</param>
10147	<param name="parent" type="IMedium" dir="in">
10148	<desc>Parent of the cloned medium.</desc>
10149	</param>
10150	<param name="progress" type="IProgress" dir="return">
10151	<desc>Progress object to track the operation completion.</desc>
10152	</param>
10153	</method>
10154
10155	<!-- other methods -->
10156
10157	<method name="compact">
10158	<desc>
10159	Starts compacting of this medium. This means that the medium is
10160	transformed into a possibly more compact storage representation.
10161	This potentially creates temporary images, which can require a
10162	substantial amount of additional disk space.
10163
10164	This medium will be placed to <link to="MediumState_LockedWrite"/>
10165	state and all its parent media (if any) will be placed to
10166	<link to="MediumState_LockedRead"/> state for the duration of this
10167	operation.
10168
10169	Please note that the results can be either returned straight away,
10170	or later as the result of the background operation via the object
10171	returned via the @a progress parameter.
10172
10173	<result name="VBOX_E_NOT_SUPPORTED">
10174	Medium format does not support compacting (but potentially
10175	needs it).
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	<method name="resize">
10184	<desc>
10185	Starts resizing this medium. This means that the nominal size of the
10186	medium is set to the new value. Both increasing and decreasing the
10187	size is possible, and there are no safety checks, since VirtualBox
10188	does not make any assumptions about the medium contents.
10189
10190	Resizing usually needs additional disk space, and possibly also
10191	some temporary disk space. Note that resize does not create a full
10192	temporary copy of the medium, so the additional disk space requirement
10193	is usually much lower than using the clone operation.
10194
10195	This medium will be placed to <link to="MediumState_LockedWrite"/>
10196	state for the duration of this operation.
10197
10198	Please note that the results can be either returned straight away,
10199	or later as the result of the background operation via the object
10200	returned via the @a progress parameter.
10201
10202	<result name="VBOX_E_NOT_SUPPORTED">
10203	Medium format does not support resizing.
10204	</result>
10205	</desc>
10206	<param name="logicalSize" type="unsigned long long" dir="in">
10207	<desc>New nominal capacity of the medium in megabytes.</desc>
10208	</param>
10209	<param name="progress" type="IProgress" dir="return">
10210	<desc>Progress object to track the operation completion.</desc>
10211	</param>
10212	</method>
10213
10214	<method name="reset">
10215	<desc>
10216	Starts erasing the contents of this differencing medium.
10217
10218	This operation will reset the differencing medium to its initial
10219	state when it does not contain any sector data and any read operation is
10220	redirected to its parent medium. This automatically gets called
10221	during VM power-up for every medium whose <link to="#autoReset" />
10222	attribute is @c true.
10223
10224	The medium will be write-locked for the duration of this operation (see
10225	<link to="#lockWrite" />).
10226
10227	<result name="VBOX_E_NOT_SUPPORTED">
10228	This is not a differencing medium.
10229	</result>
10230	<result name="VBOX_E_INVALID_OBJECT_STATE">
10231	Medium is not in <link to="MediumState_Created"/> or
10232	<link to="MediumState_Inaccessible"/> state.
10233	</result>
10234	</desc>
10235	<param name="progress" type="IProgress" dir="return">
10236	<desc>Progress object to track the operation completion.</desc>
10237	</param>
10238	</method>
10239
10240	</interface>
10241
10242
10243	<!--
10244	// IMediumFormat
10245	/////////////////////////////////////////////////////////////////////////
10246	-->
10247
10248	<enum
10249	name="DataType"
10250	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10251	>
10252	<const name="Int32" value="0"/>
10253	<const name="Int8" value="1"/>
10254	<const name="String" value="2"/>
10255	</enum>
10256
10257	<enum
10258	name="DataFlags"
10259	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10260	>
10261	<const name="None" value="0x00"/>
10262	<const name="Mandatory" value="0x01"/>
10263	<const name="Expert" value="0x02"/>
10264	<const name="Array" value="0x04"/>
10265	<const name="FlagMask" value="0x07"/>
10266	</enum>
10267
10268	<enum
10269	name="MediumFormatCapabilities"
10270	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10271	>
10272	<desc>
10273	Medium format capability flags.
10274	</desc>
10275
10276	<const name="Uuid" value="0x01">
10277	<desc>
10278	Supports UUIDs as expected by VirtualBox code.
10279	</desc>
10280	</const>
10281
10282	<const name="CreateFixed" value="0x02">
10283	<desc>
10284	Supports creating fixed size images, allocating all space instantly.
10285	</desc>
10286	</const>
10287
10288	<const name="CreateDynamic" value="0x04">
10289	<desc>
10290	Supports creating dynamically growing images, allocating space on
10291	demand.
10292	</desc>
10293	</const>
10294
10295	<const name="CreateSplit2G" value="0x08">
10296	<desc>
10297	Supports creating images split in chunks of a bit less than 2 GBytes.
10298	</desc>
10299	</const>
10300
10301	<const name="Differencing" value="0x10">
10302	<desc>
10303	Supports being used as a format for differencing media (see <link
10304	to="IMedium::createDiffStorage"/>).
10305	</desc>
10306	</const>
10307
10308	<const name="Asynchronous" value="0x20">
10309	<desc>
10310	Supports asynchronous I/O operations for at least some configurations.
10311	</desc>
10312	</const>
10313
10314	<const name="File" value="0x40">
10315	<desc>
10316	The format backend operates on files (the <link to="IMedium::location"/>
10317	attribute of the medium specifies a file used to store medium
10318	data; for a list of supported file extensions see
10319	<link to="IMediumFormat::fileExtensions"/>).
10320	</desc>
10321	</const>
10322
10323	<const name="Properties" value="0x80">
10324	<desc>
10325	The format backend uses the property interface to configure the storage
10326	location and properties (the <link to="IMediumFormat::describeProperties"/>
10327	method is used to get access to properties supported by the given medium format).
10328	</desc>
10329	</const>
10330
10331	<const name="CapabilityMask" value="0xFF"/>
10332	</enum>
10333
10334	<interface
10335	name="IMediumFormat" extends="$unknown"
10336	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10337	wsmap="managed"
10338	>
10339	<desc>
10340	The IMediumFormat interface represents a medium format.
10341
10342	Each medium format has an associated backend which is used to handle
10343	media stored in this format. This interface provides information
10344	about the properties of the associated backend.
10345
10346	Each medium format is identified by a string represented by the
10347	<link to="#id"/> attribute. This string is used in calls like
10348	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10349	format.
10350
10351	The list of all supported medium formats can be obtained using
10352	<link to="ISystemProperties::mediaFormats"/>.
10353
10354	<see>IMedium</see>
10355	</desc>
10356
10357	<attribute name="id" type="wstring" readonly="yes">
10358	<desc>
10359	Identifier of this format.
10360
10361	The format identifier is a non-@c null non-empty ASCII string. Note that
10362	this string is case-insensitive. This means that, for example, all of
10363	the following strings:
10364	<pre>
10365	"VDI"
10366	"vdi"
10367	"VdI"</pre>
10368	refer to the same medium format.
10369
10370	This string is used in methods of other interfaces where it is necessary
10371	to specify a medium format, such as
10372	<link to="IVirtualBox::createHardDisk"/>.
10373	</desc>
10374	</attribute>
10375
10376	<attribute name="name" type="wstring" readonly="yes">
10377	<desc>
10378	Human readable description of this format.
10379
10380	Mainly for use in file open dialogs.
10381	</desc>
10382	</attribute>
10383
10384	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10385	<desc>
10386	Array of strings containing the supported file extensions.
10387
10388	The first extension in the array is the extension preferred by the
10389	backend. It is recommended to use this extension when specifying a
10390	location of the storage unit for a new medium.
10391
10392	Note that some backends do not work on files, so this array may be
10393	empty.
10394
10395	<see>IMediumFormat::capabilities</see>
10396	</desc>
10397	</attribute>
10398
10399	<attribute name="capabilities" type="unsigned long" readonly="yes">
10400	<desc>
10401	Capabilities of the format as a set of bit flags.
10402
10403	For the meaning of individual capability flags see
10404	<link to="MediumFormatCapabilities"/>.
10405	</desc>
10406	</attribute>
10407
10408	<method name="describeProperties">
10409	<desc>
10410	Returns several arrays describing the properties supported by this
10411	format.
10412
10413	An element with the given index in each array describes one
10414	property. Thus, the number of elements in each returned array is the
10415	same and corresponds to the number of supported properties.
10416
10417	The returned arrays are filled in only if the
10418	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10419	All arguments must be non-@c null.
10420
10421	<see>DataType</see>
10422	<see>DataFlags</see>
10423	</desc>
10424
10425	<param name="names" type="wstring" safearray="yes" dir="out">
10426	<desc>Array of property names.</desc>
10427	</param>
10428	<param name="description" type="wstring" safearray="yes" dir="out">
10429	<desc>Array of property descriptions.</desc>
10430	</param>
10431	<param name="types" type="DataType" safearray="yes" dir="out">
10432	<desc>Array of property types.</desc>
10433	</param>
10434	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10435	<desc>Array of property flags.</desc>
10436	</param>
10437	<param name="defaults" type="wstring" safearray="yes" dir="out">
10438	<desc>Array of default property values.</desc>
10439	</param>
10440	</method>
10441
10442	</interface>
10443
10444
10445	<!--
10446	// IKeyboard
10447	/////////////////////////////////////////////////////////////////////////
10448	-->
10449
10450	<interface
10451	name="IKeyboard" extends="$unknown"
10452	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10453	wsmap="managed"
10454	>
10455	<desc>
10456	The IKeyboard interface represents the virtual machine's keyboard. Used
10457	in <link to="IConsole::keyboard"/>.
10458
10459	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10460	to the virtual machine.
10461
10462	</desc>
10463	<method name="putScancode">
10464	<desc>Sends a scancode to the keyboard.
10465
10466	<result name="VBOX_E_IPRT_ERROR">
10467	Could not send scan code to virtual keyboard.
10468	</result>
10469
10470	</desc>
10471	<param name="scancode" type="long" dir="in"/>
10472	</method>
10473
10474	<method name="putScancodes">
10475	<desc>Sends an array of scancodes to the keyboard.
10476
10477	<result name="VBOX_E_IPRT_ERROR">
10478	Could not send all scan codes to virtual keyboard.
10479	</result>
10480
10481	</desc>
10482	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10483	<param name="codesStored" type="unsigned long" dir="return"/>
10484	</method>
10485
10486	<method name="putCAD">
10487	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10488	function is nothing special, it is just a convenience function
10489	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10490
10491	<result name="VBOX_E_IPRT_ERROR">
10492	Could not send all scan codes to virtual keyboard.
10493	</result>
10494
10495	</desc>
10496	</method>
10497
10498	</interface>
10499
10500
10501	<!--
10502	// IMouse
10503	/////////////////////////////////////////////////////////////////////////
10504	-->
10505
10506	<enum
10507	name="MouseButtonState"
10508	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10509	>
10510	<desc>
10511	Mouse button state.
10512	</desc>
10513
10514	<const name="LeftButton" value="0x01"/>
10515	<const name="RightButton" value="0x02"/>
10516	<const name="MiddleButton" value="0x04"/>
10517	<const name="WheelUp" value="0x08"/>
10518	<const name="WheelDown" value="0x10"/>
10519	<const name="XButton1" value="0x20"/>
10520	<const name="XButton2" value="0x40"/>
10521	<const name="MouseStateMask" value="0x7F"/>
10522	</enum>
10523
10524	<interface
10525	name="IMouse" extends="$unknown"
10526	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10527	wsmap="managed"
10528	>
10529	<desc>
10530	The IMouse interface represents the virtual machine's mouse. Used in
10531	<link to="IConsole::mouse"/>.
10532
10533	Through this interface, the virtual machine's virtual mouse can be
10534	controlled.
10535	</desc>
10536
10537	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10538	<desc>
10539	Whether the guest OS supports absolute mouse pointer positioning
10540	or not.
10541	<note>
10542	VirtualBox Guest Tools need to be installed to the guest OS
10543	in order to enable absolute mouse positioning support.
10544	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10545	callback to be instantly informed about changes of this attribute
10546	during virtual machine execution.
10547	</note>
10548	<see><link to="#putMouseEventAbsolute"/></see>
10549	</desc>
10550	</attribute>
10551
10552	<method name="putMouseEvent">
10553	<desc>
10554	Initiates a mouse event using relative pointer movements
10555	along x and y axis.
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	</desc>
10565
10566	<param name="dx" type="long" dir="in">
10567	<desc>
10568	Amount of pixels the mouse should move to the right.
10569	Negative values move the mouse to the left.
10570	</desc>
10571	</param>
10572	<param name="dy" type="long" dir="in">
10573	<desc>
10574	Amount of pixels the mouse should move downwards.
10575	Negative values move the mouse upwards.
10576	</desc>
10577	</param>
10578	<param name="dz" type="long" dir="in">
10579	<desc>
10580	Amount of mouse wheel moves.
10581	Positive values describe clockwise wheel rotations,
10582	negative values describe counterclockwise rotations.
10583	</desc>
10584	</param>
10585	<param name="dw" type="long" dir="in">
10586	<desc>
10587	Amount of horizontal mouse wheel moves.
10588	Positive values describe a movement to the left,
10589	negative values describe a movement to the right.
10590	</desc>
10591	</param>
10592	<param name="buttonState" type="long" dir="in">
10593	<desc>
10594	The current state of mouse buttons. Every bit represents
10595	a mouse button as follows:
10596	<table>
10597	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10598	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10599	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10600	</table>
10601	A value of <tt>1</tt> means the corresponding button is pressed.
10602	otherwise it is released.
10603	</desc>
10604	</param>
10605	</method>
10606
10607	<method name="putMouseEventAbsolute">
10608	<desc>
10609	Positions the mouse pointer using absolute x and y coordinates.
10610	These coordinates are expressed in pixels and
10611	start from <tt>[1,1]</tt> which corresponds to the top left
10612	corner of the virtual display.
10613
10614	<result name="E_ACCESSDENIED">
10615	Console not powered up.
10616	</result>
10617	<result name="VBOX_E_IPRT_ERROR">
10618	Could not send mouse event to virtual mouse.
10619	</result>
10620
10621	<note>
10622	This method will have effect only if absolute mouse
10623	positioning is supported by the guest OS.
10624	</note>
10625
10626	<see><link to="#absoluteSupported"/></see>
10627	</desc>
10628
10629	<param name="x" type="long" dir="in">
10630	<desc>
10631	X coordinate of the pointer in pixels, starting from @c 1.
10632	</desc>
10633	</param>
10634	<param name="y" type="long" dir="in">
10635	<desc>
10636	Y coordinate of the pointer in pixels, starting from @c 1.
10637	</desc>
10638	</param>
10639	<param name="dz" type="long" dir="in">
10640	<desc>
10641	Amount of mouse wheel moves.
10642	Positive values describe clockwise wheel rotations,
10643	negative values describe counterclockwise rotations.
10644	</desc>
10645	</param>
10646	<param name="dw" type="long" dir="in">
10647	<desc>
10648	Amount of horizontal mouse wheel moves.
10649	Positive values describe a movement to the left,
10650	negative values describe a movement to the right.
10651	</desc>
10652	</param>
10653	<param name="buttonState" type="long" dir="in">
10654	<desc>
10655	The current state of mouse buttons. Every bit represents
10656	a mouse button as follows:
10657	<table>
10658	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10659	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10660	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10661	</table>
10662	A value of @c 1 means the corresponding button is pressed.
10663	otherwise it is released.
10664	</desc>
10665	</param>
10666	</method>
10667
10668	</interface>
10669
10670	<!--
10671	// IDisplay
10672	/////////////////////////////////////////////////////////////////////////
10673	-->
10674
10675	<enum
10676	name="FramebufferPixelFormat"
10677	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10678	>
10679	<desc>
10680	Format of the video memory buffer. Constants represented by this enum can
10681	be used to test for particular values of <link
10682	to="IFramebuffer::pixelFormat"/>. See also <link
10683	to="IFramebuffer::requestResize"/>.
10684
10685	See also www.fourcc.org for more information about FOURCC pixel formats.
10686	</desc>
10687
10688	<const name="Opaque" value="0">
10689	<desc>
10690	Unknown buffer format (the user may not assume any particular format of
10691	the buffer).
10692	</desc>
10693	</const>
10694	<const name="FOURCC_RGB" value="0x32424752">
10695	<desc>
10696	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10697	bit layout).
10698	</desc>
10699	</const>
10700	</enum>
10701
10702	<interface
10703	name="IFramebuffer" extends="$unknown"
10704	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10705	wsmap="suppress"
10706	>
10707	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10708	<desc>Address of the start byte of the frame buffer.</desc>
10709	</attribute>
10710
10711	<attribute name="width" type="unsigned long" readonly="yes">
10712	<desc>Frame buffer width, in pixels.</desc>
10713	</attribute>
10714
10715	<attribute name="height" type="unsigned long" readonly="yes">
10716	<desc>Frame buffer height, in pixels.</desc>
10717	</attribute>
10718
10719	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10720	<desc>
10721	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10722	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10723	are: 8, 15, 16, 24 and 32.
10724	</desc>
10725	</attribute>
10726
10727	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10728	<desc>
10729	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10730	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10731	size of the scan line must be aligned to 32 bits.
10732	</desc>
10733	</attribute>
10734
10735	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10736	<desc>
10737	Frame buffer pixel format. It's either one of the values defined by <link
10738	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10739	<note>
10740	This attribute must never return <link
10741	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10742	<link to="#address"/> points to must be always known.
10743	</note>
10744	</desc>
10745	</attribute>
10746
10747	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10748	<desc>
10749	Defines whether this frame buffer uses the virtual video card's memory
10750	buffer (guest VRAM) directly or not. See <link
10751	to="IFramebuffer::requestResize"/> for more information.
10752	</desc>
10753	</attribute>
10754
10755	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10756	<desc>
10757	Hint from the frame buffer about how much of the standard
10758	screen height it wants to use for itself. This information is
10759	exposed to the guest through the VESA BIOS and VMMDev interface
10760	so that it can use it for determining its video mode table. It
10761	is not guaranteed that the guest respects the value.
10762	</desc>
10763	</attribute>
10764
10765	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10766	<desc>
10767	An alpha-blended overlay which is superposed over the frame buffer.
10768	The initial purpose is to allow the display of icons providing
10769	information about the VM state, including disk activity, in front
10770	ends which do not have other means of doing that. The overlay is
10771	designed to controlled exclusively by IDisplay. It has no locking
10772	of its own, and any changes made to it are not guaranteed to be
10773	visible until the affected portion of IFramebuffer is updated. The
10774	overlay can be created lazily the first time it is requested. This
10775	attribute can also return @c null to signal that the overlay is not
10776	implemented.
10777	</desc>
10778	</attribute>
10779
10780	<attribute name="winId" type="unsigned long long" readonly="yes">
10781	<desc>
10782	Platform-dependent identifier of the window where context of this
10783	frame buffer is drawn, or zero if there's no such window.
10784	</desc>
10785	</attribute>
10786
10787	<method name="lock">
10788	<desc>
10789	Locks the frame buffer.
10790	Gets called by the IDisplay object where this frame buffer is
10791	bound to.
10792	</desc>
10793	</method>
10794
10795	<method name="unlock">
10796	<desc>
10797	Unlocks the frame buffer.
10798	Gets called by the IDisplay object where this frame buffer is
10799	bound to.
10800	</desc>
10801	</method>
10802
10803	<method name="notifyUpdate">
10804	<desc>
10805	Informs about an update.
10806	Gets called by the display object where this buffer is
10807	registered.
10808	</desc>
10809	<param name="x" type="unsigned long" dir="in"/>
10810	<param name="y" type="unsigned long" dir="in"/>
10811	<param name="width" type="unsigned long" dir="in"/>
10812	<param name="height" type="unsigned long" dir="in"/>
10813	</method>
10814
10815	<method name="requestResize">
10816	<desc>
10817	Requests a size and pixel format change.
10818
10819	There are two modes of working with the video buffer of the virtual
10820	machine. The <i>indirect</i> mode implies that the IFramebuffer
10821	implementation allocates a memory buffer for the requested display mode
10822	and provides it to the virtual machine. In <i>direct</i> mode, the
10823	IFramebuffer implementation uses the memory buffer allocated and owned
10824	by the virtual machine. This buffer represents the video memory of the
10825	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10826	usually faster because the implementation gets a raw pointer to the
10827	guest VRAM buffer which it can directly use for visualizing the contents
10828	of the virtual display, as opposed to the indirect mode where the
10829	contents of guest VRAM are copied to the memory buffer provided by
10830	the implementation every time a display update occurs.
10831
10832	It is important to note that the direct mode is really fast only when
10833	the implementation uses the given guest VRAM buffer directly, for
10834	example, by blitting it to the window representing the virtual machine's
10835	display, which saves at least one copy operation comparing to the
10836	indirect mode. However, using the guest VRAM buffer directly is not
10837	always possible: the format and the color depth of this buffer may be
10838	not supported by the target window, or it may be unknown (opaque) as in
10839	case of text or non-linear multi-plane VGA video modes. In this case,
10840	the indirect mode (that is always available) should be used as a
10841	fallback: when the guest VRAM contents are copied to the
10842	implementation-provided memory buffer, color and format conversion is
10843	done automatically by the underlying code.
10844
10845	The @a pixelFormat parameter defines whether the direct mode is
10846	available or not. If @a pixelFormat is <link
10847	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10848	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10849	@a bytesPerLine parameters must be ignored and the implementation must use
10850	the indirect mode (where it provides its own buffer in one of the
10851	supported formats). In all other cases, @a pixelFormat together with
10852	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10853	buffer pointed to by the @a VRAM parameter and the implementation is
10854	free to choose which mode to use. To indicate that this frame buffer uses
10855	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10856	attribute must return @c true and <link to="#address"/> must
10857	return exactly the same address that is passed in the @a VRAM parameter
10858	of this method; otherwise it is assumed that the indirect strategy is
10859	chosen.
10860
10861	The @a width and @a height parameters represent the size of the
10862	requested display mode in both modes. In case of indirect mode, the
10863	provided memory buffer should be big enough to store data of the given
10864	display mode. In case of direct mode, it is guaranteed that the given
10865	@a VRAM buffer contains enough space to represent the display mode of the
10866	given size. Note that this frame buffer's <link to="#width"/> and <link
10867	to="#height"/> attributes must return exactly the same values as
10868	passed to this method after the resize is completed (see below).
10869
10870	The @a finished output parameter determines if the implementation has
10871	finished resizing the frame buffer or not. If, for some reason, the
10872	resize cannot be finished immediately during this call, @a finished
10873	must be set to @c false, and the implementation must call
10874	<link to="IDisplay::resizeCompleted"/> after it has returned from
10875	this method as soon as possible. If @a finished is @c false, the
10876	machine will not call any frame buffer methods until
10877	<link to="IDisplay::resizeCompleted"/> is called.
10878
10879	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10880	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10881	this frame buffer must return exactly the same values as specified in the
10882	parameters of this method, after the resize is completed. If the
10883	indirect mode is chosen, these attributes must return values describing
10884	the format of the implementation's own memory buffer <link
10885	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10886	value must always correlate with <link to="#pixelFormat"/>. Note that
10887	the <link to="#pixelFormat"/> attribute must never return <link
10888	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10889
10890	<note>
10891	This method is called by the IDisplay object under the
10892	<link to="#lock"/> provided by this IFramebuffer
10893	implementation. If this method returns @c false in @a finished, then
10894	this lock is not released until
10895	<link to="IDisplay::resizeCompleted"/> is called.
10896	</note>
10897	</desc>
10898	<param name="screenId" type="unsigned long" dir="in">
10899	<desc>
10900	Logical screen number. Must be used in the corresponding call to
10901	<link to="IDisplay::resizeCompleted"/> if this call is made.
10902	</desc>
10903	</param>
10904	<param name="pixelFormat" type="unsigned long" dir="in">
10905	<desc>
10906	Pixel format of the memory buffer pointed to by @a VRAM.
10907	See also <link to="FramebufferPixelFormat"/>.
10908	</desc>
10909	</param>
10910	<param name="VRAM" type="octet" mod="ptr" dir="in">
10911	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10912	</param>
10913	<param name="bitsPerPixel" type="unsigned long" dir="in">
10914	<desc>Color depth, bits per pixel.</desc>
10915	</param>
10916	<param name="bytesPerLine" type="unsigned long" dir="in">
10917	<desc>Size of one scan line, in bytes.</desc>
10918	</param>
10919	<param name="width" type="unsigned long" dir="in">
10920	<desc>Width of the guest display, in pixels.</desc>
10921	</param>
10922	<param name="height" type="unsigned long" dir="in">
10923	<desc>Height of the guest display, in pixels.</desc>
10924	</param>
10925	<param name="finished" type="boolean" dir="return">
10926	<desc>
10927	Can the VM start using the new frame buffer immediately
10928	after this method returns or it should wait for
10929	<link to="IDisplay::resizeCompleted"/>.
10930	</desc>
10931	</param>
10932	</method>
10933
10934	<method name="videoModeSupported">
10935	<desc>
10936	Returns whether the frame buffer implementation is willing to
10937	support a given video mode. In case it is not able to render
10938	the video mode (or for some reason not willing), it should
10939	return @c false. Usually this method is called when the guest
10940	asks the VMM device whether a given video mode is supported
10941	so the information returned is directly exposed to the guest.
10942	It is important that this method returns very quickly.
10943	</desc>
10944	<param name="width" type="unsigned long" dir="in"/>
10945	<param name="height" type="unsigned long" dir="in"/>
10946	<param name="bpp" type="unsigned long" dir="in"/>
10947	<param name="supported" type="boolean" dir="return"/>
10948	</method>
10949
10950	<method name="getVisibleRegion">
10951	<desc>
10952	Returns the visible region of this frame buffer.
10953
10954	If the @a rectangles parameter is @c null then the value of the
10955	@a count parameter is ignored and the number of elements necessary to
10956	describe the current visible region is returned in @a countCopied.
10957
10958	If @a rectangles is not @c null but @a count is less
10959	than the required number of elements to store region data, the method
10960	will report a failure. If @a count is equal or greater than the
10961	required number of elements, then the actual number of elements copied
10962	to the provided array will be returned in @a countCopied.
10963
10964	<note>
10965	The address of the provided array must be in the process space of
10966	this IFramebuffer object.
10967	</note>
10968	<note>
10969	Method not yet implemented.
10970	</note>
10971	</desc>
10972	<param name="rectangles" type="octet" mod="ptr" dir="in">
10973	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10974	</param>
10975	<param name="count" type="unsigned long" dir="in">
10976	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10977	</param>
10978	<param name="countCopied" type="unsigned long" dir="return">
10979	<desc>Number of elements copied to the @a rectangles array.</desc>
10980	</param>
10981	</method>
10982
10983	<method name="setVisibleRegion">
10984	<desc>
10985	Suggests a new visible region to this frame buffer. This region
10986	represents the area of the VM display which is a union of regions of
10987	all top-level windows of the guest operating system running inside the
10988	VM (if the Guest Additions for this system support this
10989	functionality). This information may be used by the frontends to
10990	implement the seamless desktop integration feature.
10991
10992	<note>
10993	The address of the provided array must be in the process space of
10994	this IFramebuffer object.
10995	</note>
10996	<note>
10997	The IFramebuffer implementation must make a copy of the provided
10998	array of rectangles.
10999	</note>
11000	<note>
11001	Method not yet implemented.
11002	</note>
11003	</desc>
11004	<param name="rectangles" type="octet" mod="ptr" dir="in">
11005	<desc>Pointer to the @c RTRECT array.</desc>
11006	</param>
11007	<param name="count" type="unsigned long" dir="in">
11008	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11009	</param>
11010	</method>
11011
11012	<method name="processVHWACommand">
11013	<desc>
11014	Posts a Video HW Acceleration Command to the frame buffer for processing.
11015	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
11016	are posted from quest to the host to be processed by the host hardware.
11017
11018	<note>
11019	The address of the provided command must be in the process space of
11020	this IFramebuffer object.
11021	</note>
11022	</desc>
11023
11024	<param name="command" type="octet" mod="ptr" dir="in">
11025	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11026	</param>
11027	</method>
11028
11029	</interface>
11030
11031	<interface
11032	name="IFramebufferOverlay" extends="IFramebuffer"
11033	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11034	wsmap="suppress"
11035	>
11036	<desc>
11037	The IFramebufferOverlay interface represents an alpha blended overlay
11038	for displaying status icons above an IFramebuffer. It is always created
11039	not visible, so that it must be explicitly shown. It only covers a
11040	portion of the IFramebuffer, determined by its width, height and
11041	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11042	that order) format, and may be written to directly. Do re-read the
11043	width though, after setting it, as it may be adjusted (increased) to
11044	make it more suitable for the front end.
11045	</desc>
11046	<attribute name="x" type="unsigned long" readonly="yes">
11047	<desc>X position of the overlay, relative to the frame buffer.</desc>
11048	</attribute>
11049
11050	<attribute name="y" type="unsigned long" readonly="yes">
11051	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11052	</attribute>
11053
11054	<attribute name="visible" type="boolean" readonly="no">
11055	<desc>
11056	Whether the overlay is currently visible.
11057	</desc>
11058	</attribute>
11059
11060	<attribute name="alpha" type="unsigned long" readonly="no">
11061	<desc>
11062	The global alpha value for the overlay. This may or may not be
11063	supported by a given front end.
11064	</desc>
11065	</attribute>
11066
11067	<method name="move">
11068	<desc>
11069	Changes the overlay's position relative to the IFramebuffer.
11070	</desc>
11071	<param name="x" type="unsigned long" dir="in"/>
11072	<param name="y" type="unsigned long" dir="in"/>
11073	</method>
11074
11075	</interface>
11076
11077	<interface
11078	name="IDisplay" extends="$unknown"
11079	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
11080	wsmap="managed"
11081	>
11082	<desc>
11083	The IDisplay interface represents the virtual machine's display.
11084
11085	The object implementing this interface is contained in each
11086	<link to="IConsole::display"/> attribute and represents the visual
11087	output of the virtual machine.
11088
11089	The virtual display supports pluggable output targets represented by the
11090	IFramebuffer interface. Examples of the output target are a window on
11091	the host computer or an RDP session's display on a remote computer.
11092	</desc>
11093	<attribute name="width" type="unsigned long" readonly="yes">
11094	<desc>Current display width.</desc>
11095	</attribute>
11096
11097	<attribute name="height" type="unsigned long" readonly="yes">
11098	<desc>Current display height.</desc>
11099	</attribute>
11100
11101	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11102	<desc>
11103	Current guest display color depth. Note that this may differ
11104	from <link to="IFramebuffer::bitsPerPixel"/>.
11105	</desc>
11106	</attribute>
11107
11108	<method name="setFramebuffer">
11109	<desc>
11110	Sets the framebuffer for given screen.
11111	</desc>
11112	<param name="screenId" type="unsigned long" dir="in"/>
11113	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11114	</method>
11115
11116	<method name="getFramebuffer">
11117	<desc>
11118	Queries the framebuffer for given screen.
11119	</desc>
11120	<param name="screenId" type="unsigned long" dir="in"/>
11121	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11122	<param name="xOrigin" type="long" dir="out"/>
11123	<param name="yOrigin" type="long" dir="out"/>
11124	</method>
11125
11126	<method name="setVideoModeHint">
11127	<desc>
11128	Asks VirtualBox to request the given video mode from
11129	the guest. This is just a hint and it cannot be guaranteed
11130	that the requested resolution will be used. Guest Additions
11131	are required for the request to be seen by guests. The caller
11132	should issue the request and wait for a resolution change and
11133	after a timeout retry.
11134
11135	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11136	parameters means that the corresponding values should be taken from the
11137	current video mode (i.e. left unchanged).
11138
11139	If the guest OS supports multi-monitor configuration then the @a display
11140	parameter specifies the number of the guest display to send the hint to:
11141	@c 0 is the primary display, @c 1 is the first secondary and
11142	so on. If the multi-monitor configuration is not supported, @a display
11143	must be @c 0.
11144
11145	<result name="E_INVALIDARG">
11146	The @a display is not associated with any monitor.
11147	</result>
11148
11149	</desc>
11150	<param name="width" type="unsigned long" dir="in"/>
11151	<param name="height" type="unsigned long" dir="in"/>
11152	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11153	<param name="display" type="unsigned long" dir="in"/>
11154	</method>
11155
11156	<method name="setSeamlessMode">
11157	<desc>
11158	Enables or disables seamless guest display rendering (seamless desktop
11159	integration) mode.
11160	<note>
11161	Calling this method has no effect if <link
11162	to="IGuest::supportsSeamless"/> returns @c false.
11163	</note>
11164	</desc>
11165	<param name="enabled" type="boolean" dir="in"/>
11166	</method>
11167
11168	<method name="takeScreenShot">
11169	<desc>
11170	Takes a screen shot of the requested size and copies it to the
11171	32-bpp buffer allocated by the caller and pointed to by @a address.
11172	A pixel consists of 4 bytes in order: B, G, R, 0.
11173
11174	<note>This API can be used only by the COM/XPCOM C++ API as it
11175	requires pointer support. Use <link to="#takeScreenShotSlow" />
11176	with other language bindings.
11177	</note>
11178
11179	<result name="E_NOTIMPL">
11180	Feature not implemented.
11181	</result>
11182	<result name="VBOX_E_IPRT_ERROR">
11183	Could not take a screenshot.
11184	</result>
11185
11186	</desc>
11187	<param name="address" type="octet" mod="ptr" dir="in"/>
11188	<param name="width" type="unsigned long" dir="in"/>
11189	<param name="height" type="unsigned long" dir="in"/>
11190	</method>
11191
11192	<method name="takeScreenShotSlow">
11193	<desc>
11194	Takes a guest screen shot of the requested size and returns it as
11195	an array of bytes in uncompressed 32-bit RGBA format.
11196	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11197
11198	This API is slow, but could be the only option to get guest screenshot
11199	for scriptable languages not allowed to manipulate with addresses
11200	directly.
11201
11202	<result name="E_NOTIMPL">
11203	Feature not implemented.
11204	</result>
11205	<result name="VBOX_E_IPRT_ERROR">
11206	Could not take a screenshot.
11207	</result>
11208	</desc>
11209	<param name="width" type="unsigned long" dir="in">
11210	<desc>
11211	Desired image width.
11212	</desc>
11213	</param>
11214	<param name="height" type="unsigned long" dir="in">
11215	<desc>
11216	Desired image height.
11217	</desc>
11218	</param>
11219	<param name="screenData" type="octet" dir="return" safearray="yes">
11220	<desc>
11221	Array with resulting screen data.
11222	</desc>
11223	</param>
11224	</method>
11225
11226	<method name="drawToScreen">
11227	<desc>
11228	Draws a 32-bpp image of the specified size from the given buffer
11229	to the given point on the VM display.
11230
11231	<result name="E_NOTIMPL">
11232	Feature not implemented.
11233	</result>
11234	<result name="VBOX_E_IPRT_ERROR">
11235	Could not draw to screen.
11236	</result>
11237
11238	</desc>
11239	<param name="address" type="octet" mod="ptr" dir="in"/>
11240	<param name="x" type="unsigned long" dir="in"/>
11241	<param name="y" type="unsigned long" dir="in"/>
11242	<param name="width" type="unsigned long" dir="in"/>
11243	<param name="height" type="unsigned long" dir="in"/>
11244	</method>
11245
11246	<method name="invalidateAndUpdate">
11247	<desc>
11248	Does a full invalidation of the VM display and instructs the VM
11249	to update it.
11250
11251	<result name="VBOX_E_IPRT_ERROR">
11252	Could not invalidate and update screen.
11253	</result>
11254
11255	</desc>
11256	</method>
11257
11258	<method name="resizeCompleted">
11259	<desc>
11260	Signals that a framebuffer has completed the resize operation.
11261
11262	<result name="VBOX_E_NOT_SUPPORTED">
11263	Operation only valid for external frame buffers.
11264	</result>
11265
11266	</desc>
11267	<param name="screenId" type="unsigned long" dir="in"/>
11268	</method>
11269
11270	<method name="updateCompleted">
11271	<desc>
11272	Signals that a framebuffer has completed the update operation.
11273
11274	<result name="VBOX_E_NOT_SUPPORTED">
11275	Operation only valid for external frame buffers.
11276	</result>
11277
11278	</desc>
11279	</method>
11280
11281	<method name="completeVHWACommand">
11282	<desc>
11283	Signals that the Video HW Acceleration command has completed.
11284	</desc>
11285
11286	<param name="command" type="octet" mod="ptr" dir="in">
11287	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11288	</param>
11289	</method>
11290
11291	</interface>
11292
11293	<!--
11294	// INetworkAdapter
11295	/////////////////////////////////////////////////////////////////////////
11296	-->
11297
11298	<enum
11299	name="NetworkAttachmentType"
11300	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11301	>
11302	<desc>
11303	Network attachment type.
11304	</desc>
11305
11306	<const name="Null" value="0">
11307	<desc>Null value, also means "not attached".</desc>
11308	</const>
11309	<const name="NAT" value="1"/>
11310	<const name="Bridged" value="2"/>
11311	<const name="Internal" value="3"/>
11312	<const name="HostOnly" value="4"/>
11313	</enum>
11314
11315	<enum
11316	name="NetworkAdapterType"
11317	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11318	>
11319	<desc>
11320	Network adapter type.
11321	</desc>
11322
11323	<const name="Null" value="0">
11324	<desc>Null value (never used by the API).</desc>
11325	</const>
11326	<const name="Am79C970A" value="1">
11327	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11328	</const>
11329	<const name="Am79C973" value="2">
11330	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11331	</const>
11332	<const name="I82540EM" value="3">
11333	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11334	</const>
11335	<const name="I82543GC" value="4">
11336	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11337	</const>
11338	<const name="I82545EM" value="5">
11339	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11340	</const>
11341	<const name="Virtio" value="6">
11342	<desc>Virtio network device.</desc>
11343	</const>
11344	</enum>
11345
11346	<interface
11347	name="INetworkAdapter" extends="$unknown"
11348	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11349	wsmap="managed"
11350	>
11351	<desc>
11352	Represents a virtual network adapter that is attached to a virtual machine.
11353	Each virtual machine has a fixed number of network adapter slots with one
11354	instance of this attached to each of them. Call
11355	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11356	is attached to a given slot in a given machine.
11357
11358	Each network adapter can be in one of five attachment modes, which are
11359	represented by the <link to="NetworkAttachmentType" /> enumeration;
11360	see the <link to="#attachmentType" /> attribute.
11361	</desc>
11362
11363	<attribute name="adapterType" type="NetworkAdapterType">
11364	<desc>
11365	Type of the virtual network adapter. Depending on this value,
11366	VirtualBox will provide a different virtual network hardware
11367	to the guest.
11368	</desc>
11369	</attribute>
11370
11371	<attribute name="slot" type="unsigned long" readonly="yes">
11372	<desc>
11373	Slot number this adapter is plugged into. Corresponds to
11374	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11375	to obtain this instance.
11376	</desc>
11377	</attribute>
11378
11379	<attribute name="enabled" type="boolean">
11380	<desc>
11381	Flag whether the network adapter is present in the
11382	guest system. If disabled, the virtual guest hardware will
11383	not contain this network adapter. Can only be changed when
11384	the VM is not running.
11385	</desc>
11386	</attribute>
11387
11388	<attribute name="MACAddress" type="wstring">
11389	<desc>
11390	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11391	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11392	</desc>
11393	</attribute>
11394
11395	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11396
11397	<attribute name="hostInterface" type="wstring">
11398	<desc>
11399	Name of the host network interface the VM is attached to.
11400	</desc>
11401	</attribute>
11402
11403	<attribute name="internalNetwork" type="wstring">
11404	<desc>
11405	Name of the internal network the VM is attached to.
11406	</desc>
11407	</attribute>
11408
11409	<attribute name="NATNetwork" type="wstring">
11410	<desc>
11411	Name of the NAT network the VM is attached to.
11412	</desc>
11413	</attribute>
11414
11415	<attribute name="cableConnected" type="boolean">
11416	<desc>
11417	Flag whether the adapter reports the cable as connected or not.
11418	It can be used to report offline situations to a VM.
11419	</desc>
11420	</attribute>
11421
11422	<attribute name="lineSpeed" type="unsigned long">
11423	<desc>
11424	Line speed reported by custom drivers, in units of 1 kbps.
11425	</desc>
11426	</attribute>
11427
11428	<attribute name="traceEnabled" type="boolean">
11429	<desc>
11430	Flag whether network traffic from/to the network card should be traced.
11431	Can only be toggled when the VM is turned off.
11432	</desc>
11433	</attribute>
11434
11435	<attribute name="traceFile" type="wstring">
11436	<desc>
11437	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11438	will be used.
11439	</desc>
11440	</attribute>
11441
11442	<method name="attachToNAT">
11443	<desc>
11444	Attach the network adapter to the Network Address Translation (NAT) interface.
11445	</desc>
11446	</method>
11447
11448	<method name="attachToBridgedInterface">
11449	<desc>
11450	Attach the network adapter to a bridged host interface.
11451	</desc>
11452	</method>
11453
11454	<method name="attachToInternalNetwork">
11455	<desc>
11456	Attach the network adapter to an internal network.
11457	</desc>
11458	</method>
11459
11460	<method name="attachToHostOnlyInterface">
11461	<desc>
11462	Attach the network adapter to the host-only network.
11463	</desc>
11464	</method>
11465
11466	<method name="detach">
11467	<desc>
11468	Detach the network adapter
11469	</desc>
11470	</method>
11471	</interface>
11472
11473
11474	<!--
11475	// ISerialPort
11476	/////////////////////////////////////////////////////////////////////////
11477	-->
11478
11479	<enum
11480	name="PortMode"
11481	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11482	>
11483	<desc>
11484	The PortMode enumeration represents possible communication modes for
11485	the virtual serial port device.
11486	</desc>
11487
11488	<const name="Disconnected" value="0">
11489	<desc>Virtual device is not attached to any real host device.</desc>
11490	</const>
11491	<const name="HostPipe" value="1">
11492	<desc>Virtual device is attached to a host pipe.</desc>
11493	</const>
11494	<const name="HostDevice" value="2">
11495	<desc>Virtual device is attached to a host device.</desc>
11496	</const>
11497	<const name="RawFile" value="3">
11498	<desc>Virtual device is attached to a raw file.</desc>
11499	</const>
11500	</enum>
11501
11502	<interface
11503	name="ISerialPort" extends="$unknown"
11504	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11505	wsmap="managed"
11506	>
11507
11508	<desc>
11509	The ISerialPort interface represents the virtual serial port device.
11510
11511	The virtual serial port device acts like an ordinary serial port
11512	inside the virtual machine. This device communicates to the real
11513	serial port hardware in one of two modes: host pipe or host device.
11514
11515	In host pipe mode, the #path attribute specifies the path to the pipe on
11516	the host computer that represents a serial port. The #server attribute
11517	determines if this pipe is created by the virtual machine process at
11518	machine startup or it must already exist before starting machine
11519	execution.
11520
11521	In host device mode, the #path attribute specifies the name of the
11522	serial port device on the host computer.
11523
11524	There is also a third communication mode: the disconnected mode. In this
11525	mode, the guest OS running inside the virtual machine will be able to
11526	detect the serial port, but all port write operations will be discarded
11527	and all port read operations will return no data.
11528
11529	<see>IMachine::getSerialPort</see>
11530	</desc>
11531
11532	<attribute name="slot" type="unsigned long" readonly="yes">
11533	<desc>
11534	Slot number this serial port is plugged into. Corresponds to
11535	the value you pass to <link to="IMachine::getSerialPort"/>
11536	to obtain this instance.
11537	</desc>
11538	</attribute>
11539
11540	<attribute name="enabled" type="boolean">
11541	<desc>
11542	Flag whether the serial port is enabled. If disabled,
11543	the serial port will not be reported to the guest OS.
11544	</desc>
11545	</attribute>
11546
11547	<attribute name="IOBase" type="unsigned long">
11548	<desc>Base I/O address of the serial port.</desc>
11549	</attribute>
11550
11551	<attribute name="IRQ" type="unsigned long">
11552	<desc>IRQ number of the serial port.</desc>
11553	</attribute>
11554
11555	<attribute name="hostMode" type="PortMode">
11556	<desc>
11557	How is this port connected to the host.
11558	<note>
11559	Changing this attribute may fail if the conditions for
11560	<link to="#path"/> are not met.
11561	</note>
11562	</desc>
11563	</attribute>
11564
11565	<attribute name="server" type="boolean">
11566	<desc>
11567	Flag whether this serial port acts as a server (creates a new pipe on
11568	the host) or as a client (uses the existing pipe). This attribute is
11569	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11570	</desc>
11571	</attribute>
11572
11573	<attribute name="path" type="wstring">
11574	<desc>
11575	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11576	PortMode_HostPipe, or the host serial device name when
11577	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11578	cases, setting a @c null or empty string as the attribute's value
11579	is an error. Otherwise, the value of this property is ignored.
11580	</desc>
11581	</attribute>
11582
11583	</interface>
11584
11585	<!--
11586	// IParallelPort
11587	/////////////////////////////////////////////////////////////////////////
11588	-->
11589
11590	<interface
11591	name="IParallelPort" extends="$unknown"
11592	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11593	wsmap="managed"
11594	>
11595
11596	<desc>
11597	The IParallelPort interface represents the virtual parallel port device.
11598
11599	The virtual parallel port device acts like an ordinary parallel port
11600	inside the virtual machine. This device communicates to the real
11601	parallel port hardware using the name of the parallel device on the host
11602	computer specified in the #path attribute.
11603
11604	Each virtual parallel port device is assigned a base I/O address and an
11605	IRQ number that will be reported to the guest operating system and used
11606	to operate the given parallel port from within the virtual machine.
11607
11608	<see>IMachine::getParallelPort</see>
11609	</desc>
11610
11611	<attribute name="slot" type="unsigned long" readonly="yes">
11612	<desc>
11613	Slot number this parallel port is plugged into. Corresponds to
11614	the value you pass to <link to="IMachine::getParallelPort"/>
11615	to obtain this instance.
11616	</desc>
11617	</attribute>
11618
11619	<attribute name="enabled" type="boolean">
11620	<desc>
11621	Flag whether the parallel port is enabled. If disabled,
11622	the parallel port will not be reported to the guest OS.
11623	</desc>
11624	</attribute>
11625
11626	<attribute name="IOBase" type="unsigned long">
11627	<desc>Base I/O address of the parallel port.</desc>
11628	</attribute>
11629
11630	<attribute name="IRQ" type="unsigned long">
11631	<desc>IRQ number of the parallel port.</desc>
11632	</attribute>
11633
11634	<attribute name="path" type="wstring">
11635	<desc>
11636	Host parallel device name. If this parallel port is enabled, setting a
11637	@c null or an empty string as this attribute's value will result into
11638	an error.
11639	</desc>
11640	</attribute>
11641
11642	</interface>
11643
11644
11645	<!--
11646	// IMachineDebugger
11647	/////////////////////////////////////////////////////////////////////////
11648	-->
11649
11650	<interface
11651	name="IMachineDebugger" extends="$unknown"
11652	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11653	wsmap="suppress"
11654	>
11655	<method name="resetStats">
11656	<desc>
11657	Reset VM statistics.
11658	</desc>
11659	<param name="pattern" type="wstring" dir="in">
11660	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11661	</param>
11662	</method>
11663
11664	<method name="dumpStats">
11665	<desc>
11666	Dumps VM statistics.
11667	</desc>
11668	<param name="pattern" type="wstring" dir="in">
11669	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11670	</param>
11671	</method>
11672
11673	<method name="getStats">
11674	<desc>
11675	Get the VM statistics in a XMLish format.
11676	</desc>
11677	<param name="pattern" type="wstring" dir="in">
11678	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11679	</param>
11680	<param name="withDescriptions" type="boolean" dir="in">
11681	<desc>Whether to include the descriptions.</desc>
11682	</param>
11683	<param name="stats" type="wstring" dir="out">
11684	<desc>The XML document containing the statistics.</desc>
11685	</param>
11686	</method>
11687
11688	<method name="injectNMI">
11689	<desc>
11690	Inject an NMI into a running VT-x/AMD-V VM.
11691	</desc>
11692	</method>
11693
11694	<attribute name="singlestep" type="boolean">
11695	<desc>Switch for enabling singlestepping.</desc>
11696	</attribute>
11697
11698	<attribute name="recompileUser" type="boolean">
11699	<desc>Switch for forcing code recompilation for user mode code.</desc>
11700	</attribute>
11701
11702	<attribute name="recompileSupervisor" type="boolean">
11703	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11704	</attribute>
11705
11706	<attribute name="PATMEnabled" type="boolean">
11707	<desc>Switch for enabling and disabling the PATM component.</desc>
11708	</attribute>
11709
11710	<attribute name="CSAMEnabled" type="boolean">
11711	<desc>Switch for enabling and disabling the CSAM component.</desc>
11712	</attribute>
11713
11714	<attribute name="logEnabled" type="boolean">
11715	<desc>Switch for enabling and disabling logging.</desc>
11716	</attribute>
11717
11718	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11719	<desc>
11720	Flag indicating whether the VM is currently making use of CPU hardware
11721	virtualization extensions.
11722	</desc>
11723	</attribute>
11724
11725	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11726	<desc>
11727	Flag indicating whether the VM is currently making use of the nested paging
11728	CPU hardware virtualization extension.
11729	</desc>
11730	</attribute>
11731
11732	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11733	<desc>
11734	Flag indicating whether the VM is currently making use of the VPID
11735	VT-x extension.
11736	</desc>
11737	</attribute>
11738
11739	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11740	<desc>
11741	Flag indicating whether the VM is currently making use of the Physical
11742	Address Extension CPU feature.
11743	</desc>
11744	</attribute>
11745
11746	<attribute name="virtualTimeRate" type="unsigned long">
11747	<desc>
11748	The rate at which the virtual time runs expressed as a percentage.
11749	The accepted range is 2% to 20000%.
11750	</desc>
11751	</attribute>
11752
11753	<!-- @todo method for setting log flags, groups and destination! -->
11754
11755	<attribute name="VM" type="unsigned long long" readonly="yes">
11756	<desc>
11757	Gets the VM handle. This is only for internal use while
11758	we carve the details of this interface.
11759	</desc>
11760	</attribute>
11761
11762	</interface>
11763
11764	<!--
11765	// IUSBController
11766	/////////////////////////////////////////////////////////////////////////
11767	-->
11768
11769	<interface
11770	name="IUSBController" extends="$unknown"
11771	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11772	wsmap="managed"
11773	>
11774	<attribute name="enabled" type="boolean">
11775	<desc>
11776	Flag whether the USB controller is present in the
11777	guest system. If disabled, the virtual guest hardware will
11778	not contain any USB controller. Can only be changed when
11779	the VM is powered off.
11780	</desc>
11781	</attribute>
11782
11783	<attribute name="enabledEhci" type="boolean">
11784	<desc>
11785	Flag whether the USB EHCI controller is present in the
11786	guest system. If disabled, the virtual guest hardware will
11787	not contain a USB EHCI controller. Can only be changed when
11788	the VM is powered off.
11789	</desc>
11790	</attribute>
11791
11792	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11793	<desc>
11794	USB standard version which the controller implements.
11795	This is a BCD which means that the major version is in the
11796	high byte and minor version is in the low byte.
11797	</desc>
11798	</attribute>
11799
11800	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11801	<desc>
11802	List of USB device filters associated with the machine.
11803
11804	If the machine is currently running, these filters are activated
11805	every time a new (supported) USB device is attached to the host
11806	computer that was not ignored by global filters
11807	(<link to="IHost::USBDeviceFilters"/>).
11808
11809	These filters are also activated when the machine is powered up.
11810	They are run against a list of all currently available USB
11811	devices (in states
11812	<link to="USBDeviceState_Available"/>,
11813	<link to="USBDeviceState_Busy"/>,
11814	<link to="USBDeviceState_Held"/>) that were not previously
11815	ignored by global filters.
11816
11817	If at least one filter matches the USB device in question, this
11818	device is automatically captured (attached to) the virtual USB
11819	controller of this machine.
11820
11821	<see>IUSBDeviceFilter, ::IUSBController</see>
11822	</desc>
11823	</attribute>
11824
11825	<method name="createDeviceFilter">
11826	<desc>
11827	Creates a new USB device filter. All attributes except
11828	the filter name are set to empty (any match),
11829	<i>active</i> is @c false (the filter is not active).
11830
11831	The created filter can then be added to the list of filters using
11832	<link to="#insertDeviceFilter"/>.
11833
11834	<result name="VBOX_E_INVALID_VM_STATE">
11835	The virtual machine is not mutable.
11836	</result>
11837
11838	<see>#deviceFilters</see>
11839	</desc>
11840	<param name="name" type="wstring" dir="in">
11841	<desc>
11842	Filter name. See <link to="IUSBDeviceFilter::name"/>
11843	for more info.
11844	</desc>
11845	</param>
11846	<param name="filter" type="IUSBDeviceFilter" dir="return">
11847	<desc>Created filter object.</desc>
11848	</param>
11849	</method>
11850
11851	<method name="insertDeviceFilter">
11852	<desc>
11853	Inserts the given USB device to the specified position
11854	in the list of filters.
11855
11856	Positions are numbered starting from <tt>0</tt>. If the specified
11857	position is equal to or greater than the number of elements in
11858	the list, the filter is added to the end of the collection.
11859
11860	<note>
11861	Duplicates are not allowed, so an attempt to insert a
11862	filter that is already in the collection, will return an
11863	error.
11864	</note>
11865
11866	<result name="VBOX_E_INVALID_VM_STATE">
11867	Virtual machine is not mutable.
11868	</result>
11869	<result name="E_INVALIDARG">
11870	USB device filter not created within this VirtualBox instance.
11871	</result>
11872	<result name="VBOX_E_INVALID_OBJECT_STATE">
11873	USB device filter already in list.
11874	</result>
11875
11876	<see>#deviceFilters</see>
11877	</desc>
11878	<param name="position" type="unsigned long" dir="in">
11879	<desc>Position to insert the filter to.</desc>
11880	</param>
11881	<param name="filter" type="IUSBDeviceFilter" dir="in">
11882	<desc>USB device filter to insert.</desc>
11883	</param>
11884	</method>
11885
11886	<method name="removeDeviceFilter">
11887	<desc>
11888	Removes a USB device filter from the specified position in the
11889	list of filters.
11890
11891	Positions are numbered starting from <tt>0</tt>. Specifying a
11892	position equal to or greater than the number of elements in
11893	the list will produce an error.
11894
11895	<see>#deviceFilters</see>
11896
11897	<result name="VBOX_E_INVALID_VM_STATE">
11898	Virtual machine is not mutable.
11899	</result>
11900	<result name="E_INVALIDARG">
11901	USB device filter list empty or invalid @a position.
11902	</result>
11903
11904	</desc>
11905	<param name="position" type="unsigned long" dir="in">
11906	<desc>Position to remove the filter from.</desc>
11907	</param>
11908	<param name="filter" type="IUSBDeviceFilter" dir="return">
11909	<desc>Removed USB device filter.</desc>
11910	</param>
11911	</method>
11912
11913	</interface>
11914
11915
11916	<!--
11917	// IUSBDevice
11918	/////////////////////////////////////////////////////////////////////////
11919	-->
11920
11921	<interface
11922	name="IUSBDevice" extends="$unknown"
11923	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11924	wsmap="managed"
11925	>
11926	<desc>
11927	The IUSBDevice interface represents a virtual USB device attached to the
11928	virtual machine.
11929
11930	A collection of objects implementing this interface is stored in the
11931	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11932	attached to a running virtual machine's USB controller.
11933	</desc>
11934
11935	<attribute name="id" type="uuid" mod="string" readonly="yes">
11936	<desc>
11937	Unique USB device ID. This ID is built from #vendorId,
11938	#productId, #revision and #serialNumber.
11939	</desc>
11940	</attribute>
11941
11942	<attribute name="vendorId" type="unsigned short" readonly="yes">
11943	<desc>Vendor ID.</desc>
11944	</attribute>
11945
11946	<attribute name="productId" type="unsigned short" readonly="yes">
11947	<desc>Product ID.</desc>
11948	</attribute>
11949
11950	<attribute name="revision" type="unsigned short" readonly="yes">
11951	<desc>
11952	Product revision number. This is a packed BCD represented as
11953	unsigned short. The high byte is the integer part and the low
11954	byte is the decimal.
11955	</desc>
11956	</attribute>
11957
11958	<attribute name="manufacturer" type="wstring" readonly="yes">
11959	<desc>Manufacturer string.</desc>
11960	</attribute>
11961
11962	<attribute name="product" type="wstring" readonly="yes">
11963	<desc>Product string.</desc>
11964	</attribute>
11965
11966	<attribute name="serialNumber" type="wstring" readonly="yes">
11967	<desc>Serial number string.</desc>
11968	</attribute>
11969
11970	<attribute name="address" type="wstring" readonly="yes">
11971	<desc>Host specific address of the device.</desc>
11972	</attribute>
11973
11974	<attribute name="port" type="unsigned short" readonly="yes">
11975	<desc>
11976	Host USB port number the device is physically
11977	connected to.
11978	</desc>
11979	</attribute>
11980
11981	<attribute name="version" type="unsigned short" readonly="yes">
11982	<desc>
11983	The major USB version of the device - 1 or 2.
11984	</desc>
11985	</attribute>
11986
11987	<attribute name="portVersion" type="unsigned short" readonly="yes">
11988	<desc>
11989	The major USB version of the host USB port the device is
11990	physically connected to - 1 or 2. For devices not connected to
11991	anything this will have the same value as the version attribute.
11992	</desc>
11993	</attribute>
11994
11995	<attribute name="remote" type="boolean" readonly="yes">
11996	<desc>
11997	Whether the device is physically connected to a remote VRDP
11998	client or to a local host machine.
11999	</desc>
12000	</attribute>
12001
12002	</interface>
12003
12004
12005	<!--
12006	// IUSBDeviceFilter
12007	/////////////////////////////////////////////////////////////////////////
12008	-->
12009
12010	<interface
12011	name="IUSBDeviceFilter" extends="$unknown"
12012	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12013	wsmap="managed"
12014	>
12015	<desc>
12016	The IUSBDeviceFilter interface represents an USB device filter used
12017	to perform actions on a group of USB devices.
12018
12019	This type of filters is used by running virtual machines to
12020	automatically capture selected USB devices once they are physically
12021	attached to the host computer.
12022
12023	A USB device is matched to the given device filter if and only if all
12024	attributes of the device match the corresponding attributes of the
12025	filter (that is, attributes are joined together using the logical AND
12026	operation). On the other hand, all together, filters in the list of
12027	filters carry the semantics of the logical OR operation. So if it is
12028	desirable to create a match like "this vendor id OR this product id",
12029	one needs to create two filters and specify "any match" (see below)
12030	for unused attributes.
12031
12032	All filter attributes used for matching are strings. Each string
12033	is an expression representing a set of values of the corresponding
12034	device attribute, that will match the given filter. Currently, the
12035	following filtering expressions are supported:
12036
12037	<ul>
12038	<li><i>Interval filters</i>. Used to specify valid intervals for
12039	integer device attributes (Vendor ID, Product ID and Revision).
12040	The format of the string is:
12041
12042	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12043
12044	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12045	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12046	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12047	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12048	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12049	possible integer is assumed.
12050	</li>
12051	<li><i>Boolean filters</i>. Used to specify acceptable values for
12052	boolean device attributes. The format of the string is:
12053
12054	<tt>true\|false\|yes\|no\|0\|1</tt>
12055
12056	</li>
12057	<li><i>Exact match</i>. Used to specify a single value for the given
12058	device attribute. Any string that doesn't start with <tt>int:</tt>
12059	represents the exact match. String device attributes are compared to
12060	this string including case of symbols. Integer attributes are first
12061	converted to a string (see individual filter attributes) and then
12062	compared ignoring case.
12063
12064	</li>
12065	<li><i>Any match</i>. Any value of the corresponding device attribute
12066	will match the given filter. An empty or @c null string is
12067	used to construct this type of filtering expressions.
12068
12069	</li>
12070	</ul>
12071
12072	<note>
12073	On the Windows host platform, interval filters are not currently
12074	available. Also all string filter attributes
12075	(<link to="#manufacturer"/>, <link to="#product"/>,
12076	<link to="#serialNumber"/>) are ignored, so they behave as
12077	<i>any match</i> no matter what string expression is specified.
12078	</note>
12079
12080	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12081	</desc>
12082
12083	<attribute name="name" type="wstring">
12084	<desc>
12085	Visible name for this filter.
12086	This name is used to visually distinguish one filter from another,
12087	so it can neither be @c null nor an empty string.
12088	</desc>
12089	</attribute>
12090
12091	<attribute name="active" type="boolean">
12092	<desc>Whether this filter active or has been temporarily disabled.</desc>
12093	</attribute>
12094
12095	<attribute name="vendorId" type="wstring">
12096	<desc>
12097	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12098	The string representation for the <i>exact matching</i>
12099	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12100	(including leading zeroes).
12101	</desc>
12102	</attribute>
12103
12104	<attribute name="productId" type="wstring">
12105	<desc>
12106	<link to="IUSBDevice::productId">Product ID</link> filter.
12107	The string representation for the <i>exact matching</i>
12108	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12109	(including leading zeroes).
12110	</desc>
12111	</attribute>
12112
12113	<attribute name="revision" type="wstring">
12114	<desc>
12115	<link to="IUSBDevice::productId">Product revision number</link>
12116	filter. The string representation for the <i>exact matching</i>
12117	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12118	of the integer part of the revision, and <tt>F</tt> is the
12119	decimal digit of its fractional part (including leading and
12120	trailing zeros).
12121	Note that for interval filters, it's best to use the hexadecimal
12122	form, because the revision is stored as a 16 bit packed BCD value;
12123	so the expression <tt>int:0x0100-0x0199</tt> will match any
12124	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12125	</desc>
12126	</attribute>
12127
12128	<attribute name="manufacturer" type="wstring">
12129	<desc>
12130	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12131	</desc>
12132	</attribute>
12133
12134	<attribute name="product" type="wstring">
12135	<desc>
12136	<link to="IUSBDevice::product">Product</link> filter.
12137	</desc>
12138	</attribute>
12139
12140	<attribute name="serialNumber" type="wstring">
12141	<desc>
12142	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12143	</desc>
12144	</attribute>
12145
12146	<attribute name="port" type="wstring">
12147	<desc>
12148	<link to="IUSBDevice::port">Host USB port</link> filter.
12149	</desc>
12150	</attribute>
12151
12152	<attribute name="remote" type="wstring">
12153	<desc>
12154	<link to="IUSBDevice::remote">Remote state</link> filter.
12155	<note>
12156	This filter makes sense only for machine USB filters,
12157	i.e. it is ignored by IHostUSBDeviceFilter objects.
12158	</note>
12159	</desc>
12160	</attribute>
12161
12162	<attribute name="maskedInterfaces" type="unsigned long">
12163	<desc>
12164	This is an advanced option for hiding one or more USB interfaces
12165	from the guest. The value is a bit mask where the bits that are set
12166	means the corresponding USB interface should be hidden, masked off
12167	if you like.
12168	This feature only works on Linux hosts.
12169	</desc>
12170	</attribute>
12171
12172	</interface>
12173
12174
12175	<!--
12176	// IHostUSBDevice
12177	/////////////////////////////////////////////////////////////////////////
12178	-->
12179
12180	<enum
12181	name="USBDeviceState"
12182	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12183	>
12184	<desc>
12185	USB device state. This enumeration represents all possible states
12186	of the USB device physically attached to the host computer regarding
12187	its state on the host computer and availability to guest computers
12188	(all currently running virtual machines).
12189
12190	Once a supported USB device is attached to the host, global USB
12191	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12192	either ignore the device, or put it to USBDeviceState_Held state, or do
12193	nothing. Unless the device is ignored by global filters, filters of all
12194	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12195	activated that can put it to USBDeviceState_Captured state.
12196
12197	If the device was ignored by global filters, or didn't match
12198	any filters at all (including guest ones), it is handled by the host
12199	in a normal way. In this case, the device state is determined by
12200	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12201	or USBDeviceState_Available, depending on the current device usage.
12202
12203	Besides auto-capturing based on filters, the device can be manually
12204	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12205	state is USBDeviceState_Busy, USBDeviceState_Available or
12206	USBDeviceState_Held.
12207
12208	<note>
12209	Due to differences in USB stack implementations in Linux and Win32,
12210	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12211	only to the Linux version of the product. This also means that (<link
12212	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12213	device state is USBDeviceState_Held.
12214	</note>
12215
12216	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12217	</desc>
12218
12219	<const name="NotSupported" value="0">
12220	<desc>
12221	Not supported by the VirtualBox server, not available to guests.
12222	</desc>
12223	</const>
12224	<const name="Unavailable" value="1">
12225	<desc>
12226	Being used by the host computer exclusively,
12227	not available to guests.
12228	</desc>
12229	</const>
12230	<const name="Busy" value="2">
12231	<desc>
12232	Being used by the host computer, potentially available to guests.
12233	</desc>
12234	</const>
12235	<const name="Available" value="3">
12236	<desc>
12237	Not used by the host computer, available to guests (the host computer
12238	can also start using the device at any time).
12239	</desc>
12240	</const>
12241	<const name="Held" value="4">
12242	<desc>
12243	Held by the VirtualBox server (ignored by the host computer),
12244	available to guests.
12245	</desc>
12246	</const>
12247	<const name="Captured" value="5">
12248	<desc>
12249	Captured by one of the guest computers, not available
12250	to anybody else.
12251	</desc>
12252	</const>
12253	</enum>
12254
12255	<interface
12256	name="IHostUSBDevice" extends="IUSBDevice"
12257	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12258	wsmap="managed"
12259	>
12260	<desc>
12261	The IHostUSBDevice interface represents a physical USB device attached
12262	to the host computer.
12263
12264	Besides properties inherited from IUSBDevice, this interface adds the
12265	<link to="#state"/> property that holds the current state of the USB
12266	device.
12267
12268	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12269	</desc>
12270
12271	<attribute name="state" type="USBDeviceState" readonly="yes">
12272	<desc>
12273	Current state of the device.
12274	</desc>
12275	</attribute>
12276
12277	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12278
12279	</interface>
12280
12281
12282	<!--
12283	// IHostUSBDeviceFilter
12284	/////////////////////////////////////////////////////////////////////////
12285	-->
12286
12287	<enum
12288	name="USBDeviceFilterAction"
12289	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12290	>
12291	<desc>
12292	Actions for host USB device filters.
12293	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12294	</desc>
12295
12296	<const name="Null" value="0">
12297	<desc>Null value (never used by the API).</desc>
12298	</const>
12299	<const name="Ignore" value="1">
12300	<desc>Ignore the matched USB device.</desc>
12301	</const>
12302	<const name="Hold" value="2">
12303	<desc>Hold the matched USB device.</desc>
12304	</const>
12305	</enum>
12306
12307	<interface
12308	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12309	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12310	wsmap="managed"
12311	>
12312	<desc>
12313	The IHostUSBDeviceFilter interface represents a global filter for a
12314	physical USB device used by the host computer. Used indirectly in
12315	<link to="IHost::USBDeviceFilters"/>.
12316
12317	Using filters of this type, the host computer determines the initial
12318	state of the USB device after it is physically attached to the
12319	host's USB controller.
12320
12321	<note>
12322	The <link to="#remote"/> attribute is ignored by this type of
12323	filters, because it makes sense only for
12324	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12325	</note>
12326
12327	<see>IHost::USBDeviceFilters</see>
12328	</desc>
12329
12330	<attribute name="action" type="USBDeviceFilterAction">
12331	<desc>
12332	Action performed by the host when an attached USB device
12333	matches this filter.
12334	</desc>
12335	</attribute>
12336
12337	</interface>
12338
12339	<!--
12340	// IAudioAdapter
12341	/////////////////////////////////////////////////////////////////////////
12342	-->
12343
12344	<enum
12345	name="AudioDriverType"
12346	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12347	>
12348	<desc>
12349	Host audio driver type.
12350	</desc>
12351
12352	<const name="Null" value="0">
12353	<desc>Null value, also means "dummy audio driver".</desc>
12354	</const>
12355	<const name="WinMM" value="1">
12356	<desc>Windows multimedia (Windows hosts only).</desc>
12357	</const>
12358	<const name="OSS" value="2">
12359	<desc>Open Sound System (Linux hosts only).</desc>
12360	</const>
12361	<const name="ALSA" value="3">
12362	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12363	</const>
12364	<const name="DirectSound" value="4">
12365	<desc>DirectSound (Windows hosts only).</desc>
12366	</const>
12367	<const name="CoreAudio" value="5">
12368	<desc>CoreAudio (Mac hosts only).</desc>
12369	</const>
12370	<const name="MMPM" value="6">
12371	<desc>Reserved for historical reasons.</desc>
12372	</const>
12373	<const name="Pulse" value="7">
12374	<desc>PulseAudio (Linux hosts only).</desc>
12375	</const>
12376	<const name="SolAudio" value="8">
12377	<desc>Solaris audio (Solaris hosts only).</desc>
12378	</const>
12379	</enum>
12380
12381	<enum
12382	name="AudioControllerType"
12383	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12384	>
12385	<desc>
12386	Virtual audio controller type.
12387	</desc>
12388
12389	<const name="AC97" value="0"/>
12390	<const name="SB16" value="1"/>
12391	</enum>
12392
12393	<interface
12394	name="IAudioAdapter" extends="$unknown"
12395	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12396	wsmap="managed"
12397	>
12398	<desc>
12399	The IAudioAdapter interface represents the virtual audio adapter of
12400	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12401	</desc>
12402	<attribute name="enabled" type="boolean">
12403	<desc>
12404	Flag whether the audio adapter is present in the
12405	guest system. If disabled, the virtual guest hardware will
12406	not contain any audio adapter. Can only be changed when
12407	the VM is not running.
12408	</desc>
12409	</attribute>
12410	<attribute name="audioController" type="AudioControllerType">
12411	<desc>
12412	The audio hardware we emulate.
12413	</desc>
12414	</attribute>
12415	<attribute name="audioDriver" type="AudioDriverType">
12416	<desc>
12417	Audio driver the adapter is connected to. This setting
12418	can only be changed when the VM is not running.
12419	</desc>
12420	</attribute>
12421	</interface>
12422
12423	<!--
12424	// IVRDPServer
12425	/////////////////////////////////////////////////////////////////////////
12426	-->
12427
12428	<enum
12429	name="VRDPAuthType"
12430	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12431	>
12432	<desc>
12433	VRDP authentication type.
12434	</desc>
12435
12436	<const name="Null" value="0">
12437	<desc>Null value, also means "no authentication".</desc>
12438	</const>
12439	<const name="External" value="1"/>
12440	<const name="Guest" value="2"/>
12441	</enum>
12442
12443	<interface
12444	name="IVRDPServer" extends="$unknown"
12445	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12446	wsmap="managed"
12447	>
12448	<attribute name="enabled" type="boolean">
12449	<desc>VRDP server status.</desc>
12450	</attribute>
12451
12452	<attribute name="ports" type="wstring">
12453	<desc>
12454	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12455	<note>
12456	This is a string of comma separated TCP port numbers or port number ranges.
12457	Example <tt>5000,5010-5012,5015</tt>
12458	</note>
12459	</desc>
12460	</attribute>
12461
12462	<attribute name="netAddress" type="wstring">
12463	<desc>VRDP server address.</desc>
12464	</attribute>
12465
12466	<attribute name="authType" type="VRDPAuthType">
12467	<desc>VRDP authentication method.</desc>
12468	</attribute>
12469
12470	<attribute name="authTimeout" type="unsigned long">
12471	<desc>Timeout for guest authentication. Milliseconds.</desc>
12472	</attribute>
12473
12474	<attribute name="allowMultiConnection" type="boolean">
12475	<desc>
12476	Flag whether multiple simultaneous connections to the VM are permitted.
12477	Note that this will be replaced by a more powerful mechanism in the future.
12478	</desc>
12479	</attribute>
12480
12481	<attribute name="reuseSingleConnection" type="boolean">
12482	<desc>
12483	Flag whether the existing connection must be dropped and a new connection
12484	must be established by the VRDP server, when a new client connects in single
12485	connection mode.
12486	</desc>
12487	</attribute>
12488
12489	</interface>
12490
12491
12492	<!--
12493	// ISharedFolder
12494	/////////////////////////////////////////////////////////////////////////
12495	-->
12496
12497	<interface
12498	name="ISharedFolder" extends="$unknown"
12499	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12500	wsmap="struct"
12501	>
12502	<desc>
12503	The ISharedFolder interface represents a folder in the host computer's
12504	file system accessible from the guest OS running inside a virtual
12505	machine using an associated logical name.
12506
12507	There are three types of shared folders:
12508	<ul>
12509	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12510	folders available to all virtual machines.</li>
12511	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12512	VM-specific shared folders available to the given virtual machine at
12513	startup.</li>
12514	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12515	VM-specific shared folders created in the session context (for
12516	example, when the virtual machine is running) and automatically
12517	discarded when the session is closed (the VM is powered off).</li>
12518	</ul>
12519
12520	Logical names of shared folders must be unique within the given scope
12521	(global, permanent or transient). However, they do not need to be unique
12522	across scopes. In this case, the definition of the shared folder in a
12523	more specific scope takes precedence over definitions in all other
12524	scopes. The order of precedence is (more specific to more general):
12525	<ol>
12526	<li>Transient definitions</li>
12527	<li>Permanent definitions</li>
12528	<li>Global definitions</li>
12529	</ol>
12530
12531	For example, if MyMachine has a shared folder named
12532	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12533	transient shared folder named <tt>C_DRIVE</tt> (that points
12534	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12535	of <tt>C_DRIVE</tt> in the guest OS so
12536	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12537	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12538	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12539	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12540	to <tt>C:\\</tt> if it still exists.
12541
12542	Note that permanent and transient shared folders of different machines
12543	are in different name spaces, so they don't overlap and don't need to
12544	have unique logical names.
12545
12546	<note>
12547	Global shared folders are not implemented in the current version of the
12548	product.
12549	</note>
12550	</desc>
12551
12552	<attribute name="name" type="wstring" readonly="yes">
12553	<desc>Logical name of the shared folder.</desc>
12554	</attribute>
12555
12556	<attribute name="hostPath" type="wstring" readonly="yes">
12557	<desc>Full path to the shared folder in the host file system.</desc>
12558	</attribute>
12559
12560	<attribute name="accessible" type="boolean" readonly="yes">
12561	<desc>
12562	Whether the folder defined by the host path is currently
12563	accessible or not.
12564	For example, the folder can be unaccessible if it is placed
12565	on the network share that is not available by the time
12566	this property is read.
12567	</desc>
12568	</attribute>
12569
12570	<attribute name="writable" type="boolean" readonly="yes">
12571	<desc>
12572	Whether the folder defined by the host path is writable or
12573	not.
12574	</desc>
12575	</attribute>
12576
12577	<attribute name="lastAccessError" type="wstring" readonly="yes">
12578	<desc>
12579	Text message that represents the result of the last accessibility
12580	check.
12581
12582	Accessibility checks are performed each time the <link to="#accessible"/>
12583	attribute is read. An empty string is returned if the last
12584	accessibility check was successful. A non-empty string indicates a
12585	failure and should normally describe a reason of the failure (for
12586	example, a file read error).
12587	</desc>
12588	</attribute>
12589
12590	</interface>
12591
12592	<!--
12593	// ISession
12594	/////////////////////////////////////////////////////////////////////////
12595	-->
12596
12597	<interface
12598	name="IInternalSessionControl" extends="$unknown"
12599	uuid="f9aac6d0-41b3-46b7-bea4-6370b4036de6"
12600	internal="yes"
12601	wsmap="suppress"
12602	>
12603	<method name="getPID">
12604	<desc>PID of the process that has created this Session object.
12605	</desc>
12606	<param name="pid" type="unsigned long" dir="return"/>
12607	</method>
12608
12609	<method name="getRemoteConsole">
12610	<desc>
12611	Returns the console object suitable for remote control.
12612
12613	<result name="VBOX_E_INVALID_VM_STATE">
12614	Session state prevents operation.
12615	</result>
12616	<result name="VBOX_E_INVALID_OBJECT_STATE">
12617	Session type prevents operation.
12618	</result>
12619
12620	</desc>
12621	<param name="console" type="IConsole" dir="return"/>
12622	</method>
12623
12624	<method name="assignMachine">
12625	<desc>
12626	Assigns the machine object associated with this direct-type
12627	session or informs the session that it will be a remote one
12628	(if @a machine == @c null).
12629
12630	<result name="VBOX_E_INVALID_VM_STATE">
12631	Session state prevents operation.
12632	</result>
12633	<result name="VBOX_E_INVALID_OBJECT_STATE">
12634	Session type prevents operation.
12635	</result>
12636
12637	</desc>
12638	<param name="machine" type="IMachine" dir="in"/>
12639	</method>
12640
12641	<method name="assignRemoteMachine">
12642	<desc>
12643	Assigns the machine and the (remote) console object associated with
12644	this remote-type session.
12645
12646	<result name="VBOX_E_INVALID_VM_STATE">
12647	Session state prevents operation.
12648	</result>
12649
12650	</desc>
12651	<param name="machine" type="IMachine" dir="in"/>
12652	<param name="console" type="IConsole" dir="in"/>
12653	</method>
12654
12655	<method name="updateMachineState">
12656	<desc>
12657	Updates the machine state in the VM process.
12658	Must be called only in certain cases
12659	(see the method implementation).
12660
12661	<result name="VBOX_E_INVALID_VM_STATE">
12662	Session state prevents operation.
12663	</result>
12664	<result name="VBOX_E_INVALID_OBJECT_STATE">
12665	Session type prevents operation.
12666	</result>
12667
12668	</desc>
12669	<param name="aMachineState" type="MachineState" dir="in"/>
12670	</method>
12671
12672	<method name="uninitialize">
12673	<desc>
12674	Uninitializes (closes) this session. Used by VirtualBox to close
12675	the corresponding remote session when the direct session dies
12676	or gets closed.
12677
12678	<result name="VBOX_E_INVALID_VM_STATE">
12679	Session state prevents operation.
12680	</result>
12681
12682	</desc>
12683	</method>
12684
12685	<method name="onNetworkAdapterChange">
12686	<desc>
12687	Triggered when settings of a network adapter of the
12688	associated virtual machine have changed.
12689
12690	<result name="VBOX_E_INVALID_VM_STATE">
12691	Session state prevents operation.
12692	</result>
12693	<result name="VBOX_E_INVALID_OBJECT_STATE">
12694	Session type prevents operation.
12695	</result>
12696
12697	</desc>
12698	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12699	<param name="changeAdapter" type="boolean" dir="in"/>
12700	</method>
12701
12702	<method name="onSerialPortChange">
12703	<desc>
12704	Triggered when settings of a serial port of the
12705	associated virtual machine have changed.
12706
12707	<result name="VBOX_E_INVALID_VM_STATE">
12708	Session state prevents operation.
12709	</result>
12710	<result name="VBOX_E_INVALID_OBJECT_STATE">
12711	Session type prevents operation.
12712	</result>
12713
12714	</desc>
12715	<param name="serialPort" type="ISerialPort" dir="in"/>
12716	</method>
12717
12718	<method name="onParallelPortChange">
12719	<desc>
12720	Triggered when settings of a parallel port of the
12721	associated virtual machine have changed.
12722
12723	<result name="VBOX_E_INVALID_VM_STATE">
12724	Session state prevents operation.
12725	</result>
12726	<result name="VBOX_E_INVALID_OBJECT_STATE">
12727	Session type prevents operation.
12728	</result>
12729
12730	</desc>
12731	<param name="parallelPort" type="IParallelPort" dir="in"/>
12732	</method>
12733
12734	<method name="onStorageControllerChange">
12735	<desc>
12736	Triggered when settings of a storage controller of the
12737	associated virtual machine have changed.
12738
12739	<result name="VBOX_E_INVALID_VM_STATE">
12740	Session state prevents operation.
12741	</result>
12742	<result name="VBOX_E_INVALID_OBJECT_STATE">
12743	Session type prevents operation.
12744	</result>
12745
12746	</desc>
12747	</method>
12748
12749	<method name="onMediumChange">
12750	<desc>
12751	Triggered when attached media of the
12752	associated virtual machine have changed.
12753
12754	<result name="VBOX_E_INVALID_VM_STATE">
12755	Session state prevents operation.
12756	</result>
12757	<result name="VBOX_E_INVALID_OBJECT_STATE">
12758	Session type prevents operation.
12759	</result>
12760
12761	</desc>
12762
12763	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12764	<param name="force" type="boolean" dir="in"/>
12765	</method>
12766
12767	<method name="onCPUChange">
12768	<desc>
12769	Notification when a CPU changes.
12770	</desc>
12771	<param name="cpu" type="unsigned long" dir="in">
12772	<desc>The CPU which changed</desc>
12773	</param>
12774	<param name="add" type="boolean" dir="in">
12775	<desc>Flag whether the CPU was added or removed</desc>
12776	</param>
12777	</method>
12778
12779	<method name="onVRDPServerChange">
12780	<desc>
12781	Triggered when settings of the VRDP server object of the
12782	associated virtual machine have changed.
12783
12784	<result name="VBOX_E_INVALID_VM_STATE">
12785	Session state prevents operation.
12786	</result>
12787	<result name="VBOX_E_INVALID_OBJECT_STATE">
12788	Session type prevents operation.
12789	</result>
12790
12791	</desc>
12792	</method>
12793
12794	<method name="onUSBControllerChange">
12795	<desc>
12796	Triggered when settings of the USB controller object of the
12797	associated virtual machine have changed.
12798
12799	<result name="VBOX_E_INVALID_VM_STATE">
12800	Session state prevents operation.
12801	</result>
12802	<result name="VBOX_E_INVALID_OBJECT_STATE">
12803	Session type prevents operation.
12804	</result>
12805
12806	</desc>
12807	</method>
12808
12809	<method name="onSharedFolderChange">
12810	<desc>
12811	Triggered when a permanent (global or machine) shared folder has been
12812	created or removed.
12813	<note>
12814	We don't pass shared folder parameters in this notification because
12815	the order in which parallel notifications are delivered is not defined,
12816	therefore it could happen that these parameters were outdated by the
12817	time of processing this notification.
12818	</note>
12819
12820	<result name="VBOX_E_INVALID_VM_STATE">
12821	Session state prevents operation.
12822	</result>
12823	<result name="VBOX_E_INVALID_OBJECT_STATE">
12824	Session type prevents operation.
12825	</result>
12826
12827	</desc>
12828	<param name="global" type="boolean" dir="in"/>
12829	</method>
12830
12831	<method name="onUSBDeviceAttach">
12832	<desc>
12833	Triggered when a request to capture a USB device (as a result
12834	of matched USB filters or direct call to
12835	<link to="IConsole::attachUSBDevice"/>) has completed.
12836	A @c null @a error object means success, otherwise it
12837	describes a failure.
12838
12839	<result name="VBOX_E_INVALID_VM_STATE">
12840	Session state prevents operation.
12841	</result>
12842	<result name="VBOX_E_INVALID_OBJECT_STATE">
12843	Session type prevents operation.
12844	</result>
12845
12846	</desc>
12847	<param name="device" type="IUSBDevice" dir="in"/>
12848	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12849	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12850	</method>
12851
12852	<method name="onUSBDeviceDetach">
12853	<desc>
12854	Triggered when a request to release the USB device (as a result
12855	of machine termination or direct call to
12856	<link to="IConsole::detachUSBDevice"/>) has completed.
12857	A @c null @a error object means success, otherwise it
12858	describes a failure.
12859
12860	<result name="VBOX_E_INVALID_VM_STATE">
12861	Session state prevents operation.
12862	</result>
12863	<result name="VBOX_E_INVALID_OBJECT_STATE">
12864	Session type prevents operation.
12865	</result>
12866
12867	</desc>
12868	<param name="id" type="uuid" mod="string" dir="in"/>
12869	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12870	</method>
12871
12872	<method name="onShowWindow">
12873	<desc>
12874	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12875	<link to="IMachine::showConsoleWindow"/> in order to notify
12876	console callbacks
12877	<link to="IConsoleCallback::onCanShowWindow"/>
12878	and <link to="IConsoleCallback::onShowWindow"/>.
12879
12880	<result name="VBOX_E_INVALID_OBJECT_STATE">
12881	Session type prevents operation.
12882	</result>
12883
12884	</desc>
12885	<param name="check" type="boolean" dir="in"/>
12886	<param name="canShow" type="boolean" dir="out"/>
12887	<param name="winId" type="unsigned long long" dir="out"/>
12888	</method>
12889
12890	<method name="accessGuestProperty">
12891	<desc>
12892	Called by <link to="IMachine::getGuestProperty"/> and by
12893	<link to="IMachine::setGuestProperty"/> in order to read and
12894	modify guest properties.
12895
12896	<result name="VBOX_E_INVALID_VM_STATE">
12897	Machine session is not open.
12898	</result>
12899	<result name="VBOX_E_INVALID_OBJECT_STATE">
12900	Session type is not direct.
12901	</result>
12902
12903	</desc>
12904	<param name="name" type="wstring" dir="in"/>
12905	<param name="value" type="wstring" dir="in"/>
12906	<param name="flags" type="wstring" dir="in"/>
12907	<param name="isSetter" type="boolean" dir="in"/>
12908	<param name="retValue" type="wstring" dir="out"/>
12909	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12910	<param name="retFlags" type="wstring" dir="out"/>
12911	</method>
12912
12913	<method name="enumerateGuestProperties">
12914	<desc>
12915	Return a list of the guest properties matching a set of patterns along
12916	with their values, time stamps and flags.
12917
12918	<result name="VBOX_E_INVALID_VM_STATE">
12919	Machine session is not open.
12920	</result>
12921	<result name="VBOX_E_INVALID_OBJECT_STATE">
12922	Session type is not direct.
12923	</result>
12924
12925	</desc>
12926	<param name="patterns" type="wstring" dir="in">
12927	<desc>
12928	The patterns to match the properties against as a comma-separated
12929	string. If this is empty, all properties currently set will be
12930	returned.
12931	</desc>
12932	</param>
12933	<param name="key" type="wstring" dir="out" safearray="yes">
12934	<desc>
12935	The key names of the properties returned.
12936	</desc>
12937	</param>
12938	<param name="value" type="wstring" dir="out" safearray="yes">
12939	<desc>
12940	The values of the properties returned. The array entries match the
12941	corresponding entries in the @a key array.
12942	</desc>
12943	</param>
12944	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12945	<desc>
12946	The time stamps of the properties returned. The array entries match
12947	the corresponding entries in the @a key array.
12948	</desc>
12949	</param>
12950	<param name="flags" type="wstring" dir="out" safearray="yes">
12951	<desc>
12952	The flags of the properties returned. The array entries match the
12953	corresponding entries in the @a key array.
12954	</desc>
12955	</param>
12956	</method>
12957
12958	</interface>
12959
12960	<interface
12961	name="ISession" extends="$dispatched"
12962	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12963	wsmap="managed"
12964	>
12965	<desc>
12966	The ISession interface represents a serialization primitive for virtual
12967	machines.
12968
12969	With VirtualBox, every time one wishes to manipulate a virtual machine
12970	(e.g. change its settings or start execution), a session object is
12971	required. Such an object must be passed to one of the session methods
12972	that open the given session, which then initiates the machine manipulation.
12973
12974	A session serves several purposes: it identifies to the inter-process VirtualBox
12975	code which process is currently working with the virtual machine, and it ensures
12976	that there are no incompatible requests from several processes for the
12977	same virtual machine. Session objects can therefore be thought of as mutex
12978	semaphores that lock virtual machines to prevent conflicting accesses from
12979	several processes.
12980
12981	How sessions objects are used depends on whether you use the Main API
12982	via COM or via the webservice:
12983
12984	<ul>
12985	<li>When using the COM API directly, an object of the Session class from the
12986	VirtualBox type library needs to be created. In regular COM C++ client code,
12987	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12988	This object will then act as a local session object in further calls to open
12989	a session.
12990	</li>
12991
12992	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12993	one session object automatically when <link to="IWebsessionManager::logon" />
12994	is called. A managed object reference to that session object can be retrieved by
12995	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12996	reference can then be used to open sessions.
12997	</li>
12998	</ul>
12999
13000	Sessions are mainly used in two variations:
13001
13002	<ul>
13003	<li>
13004	To start a virtual machine in a separate process, one would call
13005	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
13006	object as its first parameter. This session then identifies the caller
13007	and lets him control the started machine (for example, pause machine
13008	execution or power it down) as well as be notified about machine
13009	execution state changes.
13010	</li>
13011
13012	<li>To alter machine settings, or to start machine execution within the
13013	current process, one needs to open a direct session for the machine first by
13014	calling <link to="IVirtualBox::openSession"/>. While a direct session
13015	is open within one process, no any other process may open another direct
13016	session for the same machine. This prevents the machine from being changed
13017	by other processes while it is running or while the machine is being configured.
13018	</li>
13019	</ul>
13020
13021	One also can attach to an existing direct session already opened by
13022	another process (for example, in order to send a control request to the
13023	virtual machine such as the pause or the reset request). This is done by
13024	calling <link to="IVirtualBox::openExistingSession"/>.
13025
13026	<note>
13027	Unless you are trying to write a new VirtualBox front-end that
13028	performs direct machine execution (like the VirtualBox or VBoxSDL
13029	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
13030	session opened by <link to="IVirtualBox::openSession"/> and use this
13031	session only to change virtual machine settings. If you simply want to
13032	start virtual machine execution using one of the existing front-ends
13033	(for example the VirtualBox GUI or headless server), simply use
13034	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
13035	will power up the machine automatically for you.
13036	</note>
13037	</desc>
13038
13039	<attribute name="state" type="SessionState" readonly="yes">
13040	<desc>Current state of this session.</desc>
13041	</attribute>
13042
13043	<attribute name="type" type="SessionType" readonly="yes">
13044	<desc>
13045	Type of this session. The value of this attribute is valid only
13046	if the session is currently open (i.e. its #state is
13047	SessionType_SessionOpen), otherwise an error will be returned.
13048	</desc>
13049	</attribute>
13050
13051	<attribute name="machine" type="IMachine" readonly="yes">
13052	<desc>Machine object associated with this session.</desc>
13053	</attribute>
13054
13055	<attribute name="console" type="IConsole" readonly="yes">
13056	<desc>Console object associated with this session.</desc>
13057	</attribute>
13058
13059	<method name="close">
13060	<desc>
13061	Closes a session that was previously opened.
13062
13063	It is recommended that every time an "open session" method (such as
13064	<link to="IVirtualBox::openRemoteSession" /> or
13065	<link to="IVirtualBox::openSession" />) has been called to
13066	manipulate a virtual machine, the caller invoke
13067	ISession::close() when it's done doing so. Since sessions are
13068	serialization primitives much like ordinary mutexes, they are
13069	best used the same way: for each "open" call, there should be
13070	a matching "close" call, even when errors occur.
13071
13072	Otherwise, if a direct session for a machine opened with
13073	<link to="IVirtualBox::openSession"/> is not explicitly closed
13074	when the application terminates, the state of the machine will
13075	be set to <link to="MachineState_Aborted" /> on the server.
13076
13077	Generally, it is recommended to close all open sessions explicitly
13078	before terminating the application (regardless of the reason for
13079	the termination).
13080
13081	<note>
13082	Do not expect the session state (<link to="ISession::state" />
13083	to return to "Closed" immediately after you invoke
13084	ISession::close(), particularly if you have started a remote
13085	session to execute the VM in a new process. The session state will
13086	automatically return to "Closed" once the VM is no longer executing,
13087	which can of course take a very long time.
13088	</note>
13089
13090	<result name="E_UNEXPECTED">
13091	Session is not open.
13092	</result>
13093
13094	</desc>
13095	</method>
13096
13097	</interface>
13098
13099	<!--
13100	// IStorageController
13101	/////////////////////////////////////////////////////////////////////////
13102	-->
13103
13104	<enum
13105	name="StorageBus"
13106	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13107	>
13108	<desc>
13109	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
13110	see <link to="IStorageController::bus" />.
13111	</desc>
13112	<const name="Null" value="0">
13113	<desc>@c null value. Never used by the API.</desc>
13114	</const>
13115	<const name="IDE" value="1"/>
13116	<const name="SATA" value="2"/>
13117	<const name="SCSI" value="3"/>
13118	<const name="Floppy" value="4"/>
13119	<const name="SAS" value="5"/>
13120	</enum>
13121
13122	<enum
13123	name="StorageControllerType"
13124	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13125	>
13126	<desc>
13127	The exact variant of storage controller hardware presented
13128	to the guest; see <link to="IStorageController::controllerType" />.
13129	</desc>
13130
13131	<const name="Null" value="0">
13132	<desc>@c null value. Never used by the API.</desc>
13133	</const>
13134	<const name="LsiLogic" value="1">
13135	<desc>A SCSI controller of the LsiLogic variant.</desc>
13136	</const>
13137	<const name="BusLogic" value="2">
13138	<desc>A SCSI controller of the BusLogic variant.</desc>
13139	</const>
13140	<const name="IntelAhci" value="3">
13141	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13142	</const>
13143	<const name="PIIX3" value="4">
13144	<desc>An IDE controller of the PIIX3 variant.</desc>
13145	</const>
13146	<const name="PIIX4" value="5">
13147	<desc>An IDE controller of the PIIX4 variant.</desc>
13148	</const>
13149	<const name="ICH6" value="6">
13150	<desc>An IDE controller of the ICH6 variant.</desc>
13151	</const>
13152	<const name="I82078" value="7">
13153	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13154	</const>
13155	<const name="LsiLogicSas" value="8">
13156	<desc>A variant of the LsiLogic controller using SAS.</desc>
13157	</const>
13158	</enum>
13159
13160	<interface
13161	name="IStorageController" extends="$unknown"
13162	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
13163	wsmap="managed"
13164	>
13165	<desc>
13166	Represents a storage controller that is attached to a virtual machine
13167	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13168	attached to storage controllers in a real computer, virtual drives
13169	(represented by <link to="IMediumAttachment" />) are attached to virtual
13170	storage controllers, represented by this interface.
13171
13172	As opposed to physical hardware, VirtualBox has a very generic concept
13173	of a storage controller, and for purposes of the Main API, all virtual
13174	storage is attached to virtual machines via instances of this interface.
13175	There are four types of such virtual storage controllers: IDE, SCSI, SATA
13176	and Floppy (see <link to="#bus" />). Depending on which of these four is
13177	used, certain sub-types may be available and can be selected in
13178	<link to="#controllerType" />.
13179
13180	Depending on these settings, the guest operating system might see
13181	significantly different virtual hardware.
13182	</desc>
13183
13184	<attribute name="name" type="wstring" readonly="yes">
13185	<desc>
13186	Name of the storage controller, as originally specified with
13187	<link to="IMachine::addStorageController" />. This then uniquely
13188	identifies this controller with other method calls such as
13189	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13190	</desc>
13191	</attribute>
13192
13193	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13194	<desc>
13195	Maximum number of devices which can be attached to one port.
13196	</desc>
13197	</attribute>
13198
13199	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13200	<desc>
13201	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13202	</desc>
13203	</attribute>
13204
13205	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13206	<desc>
13207	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13208	</desc>
13209	</attribute>
13210
13211	<attribute name="instance" type="unsigned long">
13212	<desc>
13213	The instance number of the device in the running VM.
13214	</desc>
13215	</attribute>
13216
13217	<attribute name="portCount" type="unsigned long">
13218	<desc>
13219	The number of currently usable ports on the controller.
13220	The minimum and maximum number of ports for one controller are
13221	stored in <link to="IStorageController::minPortCount"/>
13222	and <link to="IStorageController::maxPortCount"/>.
13223	</desc>
13224	</attribute>
13225
13226	<attribute name="bus" type="StorageBus" readonly="yes">
13227	<desc>
13228	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
13229	</desc>
13230	</attribute>
13231
13232	<attribute name="controllerType" type="StorageControllerType">
13233	<desc>
13234	The exact variant of storage controller hardware presented
13235	to the guest.
13236	Depending on this value, VirtualBox will provide a different
13237	virtual storage controller hardware to the guest.
13238	For SATA and floppy controllers, only one variant is available,
13239	but for IDE and SCSI, there are several.
13240
13241	For SCSI controllers, the default type is LsiLogic.
13242	</desc>
13243	</attribute>
13244
13245	<method name="GetIDEEmulationPort">
13246	<desc>
13247	Gets the corresponding port number which is emulated as an IDE device.
13248	Works only with SATA controllers.
13249
13250	<result name="E_INVALIDARG">
13251	The @a devicePosition is not in the range 0 to 3.
13252	</result>
13253	<result name="E_NOTIMPL">
13254	The storage controller type is not SATAIntelAhci.
13255	</result>
13256
13257	</desc>
13258	<param name="devicePosition" type="long" dir="in"/>
13259	<param name="portNumber" type="long" dir="return"/>
13260	</method>
13261
13262	<method name="SetIDEEmulationPort">
13263	<desc>
13264	Sets the port number which is emulated as an IDE device.
13265	Works only with SATA controllers.
13266
13267	<result name="E_INVALIDARG">
13268	The @a devicePosition is not in the range 0 to 3 or the
13269	@a portNumber is not in the range 0 to 29.
13270	</result>
13271	<result name="E_NOTIMPL">
13272	The storage controller type is not SATAIntelAhci.
13273	</result>
13274
13275	</desc>
13276	<param name="devicePosition" type="long" dir="in"/>
13277	<param name="portNumber" type="long" dir="in"/>
13278	</method>
13279
13280	</interface>
13281
13282	<if target="wsdl">
13283
13284	<!--
13285	// IManagedObjectRef
13286	/////////////////////////////////////////////////////////////////////////
13287	-->
13288
13289	<interface
13290	name="IManagedObjectRef" extends="$unknown"
13291	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13292	internal="yes"
13293	wsmap="managed"
13294	wscpp="hardcoded"
13295	>
13296	<desc>
13297	Managed object reference.
13298
13299	Only within the webservice, a managed object reference (which is really
13300	an opaque number) allows a webservice client to address an object
13301	that lives in the address space of the webservice server.
13302
13303	Behind each managed object reference, there is a COM object that lives
13304	in the webservice server's address space. The COM object is not freed
13305	until the managed object reference is released, either by an explicit
13306	call to <link to="IManagedObjectRef::release" /> or by logging off from
13307	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13308	all objects created during the webservice session.
13309
13310	Whenever a method call of the VirtualBox API returns a COM object, the
13311	webservice representation of that method will instead return a
13312	managed object reference, which can then be used to invoke methods
13313	on that object.
13314	</desc>
13315
13316	<method name="getInterfaceName">
13317	<desc>
13318	Returns the name of the interface that this managed object represents,
13319	for example, "IMachine", as a string.
13320	</desc>
13321	<param name="return" type="wstring" dir="return"/>
13322	</method>
13323
13324	<method name="release">
13325	<desc>
13326	Releases this managed object reference and frees the resources that
13327	were allocated for it in the webservice server process. After calling
13328	this method, the identifier of the reference can no longer be used.
13329	</desc>
13330	</method>
13331
13332	</interface>
13333
13334	<!--
13335	// IWebsessionManager
13336	/////////////////////////////////////////////////////////////////////////
13337	-->
13338
13339	<interface
13340	name="IWebsessionManager" extends="$unknown"
13341	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13342	internal="yes"
13343	wsmap="global"
13344	wscpp="hardcoded"
13345	>
13346	<desc>
13347	Websession manager. This provides essential services
13348	to webservice clients.
13349	</desc>
13350	<method name="logon">
13351	<desc>
13352	Logs a new client onto the webservice and returns a managed object reference to
13353	the IVirtualBox instance, which the client can then use as a basis to further
13354	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13355	interface, in one way or the other.
13356	</desc>
13357	<param name="username" type="wstring" dir="in"/>
13358	<param name="password" type="wstring" dir="in"/>
13359	<param name="return" type="IVirtualBox" dir="return"/>
13360	</method>
13361
13362	<method name="getSessionObject">
13363	<desc>
13364	Returns a managed object reference to the internal ISession object that was created
13365	for this web service session when the client logged on.
13366
13367	<see>ISession</see>
13368	</desc>
13369	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13370	<param name="return" type="ISession" dir="return"/>
13371	</method>
13372
13373	<method name="logoff">
13374	<desc>
13375	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13376	and destroys all resources associated with the session (most importantly, all
13377	managed objects created in the server while the session was active).
13378	</desc>
13379	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13380	</method>
13381
13382	</interface>
13383
13384	</if>
13385
13386	<!--
13387	// IPerformanceCollector & friends
13388	/////////////////////////////////////////////////////////////////////////
13389	-->
13390
13391	<interface
13392	name="IPerformanceMetric" extends="$unknown"
13393	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13394	>
13395	<desc>
13396	The IPerformanceMetric interface represents parameters of the given
13397	performance metric.
13398	</desc>
13399
13400	<attribute name="metricName" type="wstring" readonly="yes">
13401	<desc>
13402	Name of the metric.
13403	</desc>
13404	</attribute>
13405
13406	<attribute name="object" type="$unknown" readonly="yes">
13407	<desc>
13408	Object this metric belongs to.
13409	</desc>
13410	</attribute>
13411
13412	<attribute name="description" type="wstring" readonly="yes">
13413	<desc>
13414	Textual description of the metric.
13415	</desc>
13416	</attribute>
13417
13418	<attribute name="period" type="unsigned long" readonly="yes">
13419	<desc>
13420	Time interval between samples, measured in seconds.
13421	</desc>
13422	</attribute>
13423
13424	<attribute name="count" type="unsigned long" readonly="yes">
13425	<desc>
13426	Number of recent samples retained by the performance collector for this
13427	metric.
13428
13429	When the collected sample count exceeds this number, older samples
13430	are discarded.
13431	</desc>
13432	</attribute>
13433
13434	<attribute name="unit" type="wstring" readonly="yes">
13435	<desc>
13436	Unit of measurement.
13437	</desc>
13438	</attribute>
13439
13440	<attribute name="minimumValue" type="long" readonly="yes">
13441	<desc>
13442	Minimum possible value of this metric.
13443	</desc>
13444	</attribute>
13445
13446	<attribute name="maximumValue" type="long" readonly="yes">
13447	<desc>
13448	Maximum possible value of this metric.
13449	</desc>
13450	</attribute>
13451	</interface>
13452
13453	<interface
13454	name="IPerformanceCollector" extends="$unknown"
13455	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13456	wsmap="managed"
13457	>
13458	<desc>
13459	The IPerformanceCollector interface represents a service that collects and
13460	stores performance metrics data.
13461
13462	Performance metrics are associated with objects of interfaces like IHost and
13463	IMachine. Each object has a distinct set of performance metrics.
13464	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13465
13466	Metric data is collected at the specified intervals and is retained
13467	internally. The interval and the number of retained samples can be set
13468	with <link to="IPerformanceCollector::setupMetrics" />.
13469
13470	Metrics are organized hierarchically, with each level separated by a
13471	slash (/) character. Generally, the scheme for metric names is like this:
13472
13473	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13474
13475	"Category/Metric" together form the base metric name. A base metric is the
13476	smallest unit for which a sampling interval and the number of retained
13477	samples can be set. Only base metrics can be enabled and disabled. All
13478	sub-metrics are collected when their base metric is collected.
13479	Collected values for any set of sub-metrics can be queried with
13480	<link to="IPerformanceCollector::queryMetricsData" />.
13481
13482	For example "CPU/Load/User:avg"
13483	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13484	"average" aggregate. An aggregate function is computed over all retained
13485	data. Valid aggregate functions are:
13486
13487	<ul>
13488	<li>avg -- average</li>
13489	<li>min -- minimum</li>
13490	<li>max -- maximum</li>
13491	</ul>
13492
13493	When setting up
13494	metric parameters, querying metric data, enabling or disabling metrics
13495	wildcards can be used in metric names to specify a subset of metrics. For
13496	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13497	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13498	values without aggregates <tt>*:</tt> can be used.
13499
13500	The valid names for base metrics are:
13501
13502	<ul>
13503	<li>CPU/Load</li>
13504	<li>CPU/MHz</li>
13505	<li>RAM/Usage</li>
13506	</ul>
13507
13508	The general sequence for collecting and retrieving the metrics is:
13509	<ul>
13510	<li>
13511	Obtain an instance of IPerformanceCollector with
13512	<link to="IVirtualBox::performanceCollector" />
13513	</li>
13514	<li>
13515	Allocate and populate an array with references to objects the metrics
13516	will be collected for. Use references to IHost and IMachine objects.
13517	</li>
13518	<li>
13519	Allocate and populate an array with base metric names the data will be
13520	collected for.
13521	</li>
13522	<li>
13523	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13524	metric data will be collected and stored.
13525	</li>
13526	<li>
13527	Wait for the data to get collected.
13528	</li>
13529	<li>
13530	Allocate and populate an array with references to objects the metric
13531	values will be queried for. You can re-use the object array used for
13532	setting base metrics.
13533	</li>
13534	<li>
13535	Allocate and populate an array with metric names the data will be
13536	collected for. Note that metric names differ from base metric names.
13537	</li>
13538	<li>
13539	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13540	have been collected so far are returned. Note that the values are still
13541	retained internally and data collection continues.
13542	</li>
13543	</ul>
13544
13545	For an example of usage refer to the following files in VirtualBox SDK:
13546	<ul>
13547	<li>
13548	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13549	</li>
13550	<li>
13551	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13552	</li>
13553	</ul>
13554	</desc>
13555
13556	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13557	<desc>
13558	Array of unique names of metrics.
13559
13560	This array represents all metrics supported by the performance
13561	collector. Individual objects do not necessarily support all of them.
13562	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13563	list of supported metrics for a particular object.
13564	</desc>
13565	</attribute>
13566
13567	<method name="getMetrics">
13568	<desc>
13569	Returns parameters of specified metrics for a set of objects.
13570	<note>
13571	@c Null metrics array means all metrics. @c Null object array means
13572	all existing objects.
13573	</note>
13574	</desc>
13575	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13576	<desc>
13577	Metric name filter. Currently, only a comma-separated list of metrics
13578	is supported.
13579	</desc>
13580	</param>
13581	<param name="objects" type="$unknown" dir="in" safearray="yes">
13582	<desc>
13583	Set of objects to return metric parameters for.
13584	</desc>
13585	</param>
13586	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13587	<desc>
13588	Array of returned metric parameters.
13589	</desc>
13590	</param>
13591	</method>
13592
13593	<method name="setupMetrics">
13594	<desc>
13595	Sets parameters of specified base metrics for a set of objects. Returns
13596	an array of <link to="IPerformanceMetric" /> describing the metrics have
13597	been affected.
13598	<note>
13599	@c Null or empty metric name array means all metrics. @c Null or empty
13600	object array means all existing objects. If metric name array contains
13601	a single element and object array contains many, the single metric
13602	name array element is applied to each object array element to form
13603	metric/object pairs.
13604	</note>
13605	</desc>
13606	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13607	<desc>
13608	Metric name filter. Comma-separated list of metrics with wildcard
13609	support.
13610	</desc>
13611	</param>
13612	<param name="objects" type="$unknown" dir="in" safearray="yes">
13613	<desc>
13614	Set of objects to setup metric parameters for.
13615	</desc>
13616	</param>
13617	<param name="period" type="unsigned long" dir="in">
13618	<desc>
13619	Time interval in seconds between two consecutive samples of performance
13620	data.
13621	</desc>
13622	</param>
13623	<param name="count" type="unsigned long" dir="in">
13624	<desc>
13625	Number of samples to retain in performance data history. Older samples
13626	get discarded.
13627	</desc>
13628	</param>
13629	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13630	<desc>
13631	Array of metrics that have been modified by the call to this method.
13632	</desc>
13633	</param>
13634	</method>
13635
13636	<method name="enableMetrics">
13637	<desc>
13638	Turns on collecting specified base metrics. Returns an array of
13639	<link to="IPerformanceMetric" /> describing the metrics have been
13640	affected.
13641	<note>
13642	@c Null or empty metric name array means all metrics. @c Null or empty
13643	object array means all existing objects. If metric name array contains
13644	a single element and object array contains many, the single metric
13645	name array element is applied to each object array element to form
13646	metric/object pairs.
13647	</note>
13648	</desc>
13649	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13650	<desc>
13651	Metric name filter. Comma-separated list of metrics with wildcard
13652	support.
13653	</desc>
13654	</param>
13655	<param name="objects" type="$unknown" dir="in" safearray="yes">
13656	<desc>
13657	Set of objects to enable metrics for.
13658	</desc>
13659	</param>
13660	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13661	<desc>
13662	Array of metrics that have been modified by the call to this method.
13663	</desc>
13664	</param>
13665	</method>
13666
13667	<method name="disableMetrics">
13668	<desc>
13669	Turns off collecting specified base metrics. Returns an array of
13670	<link to="IPerformanceMetric" /> describing the metrics have been
13671	affected.
13672	<note>
13673	@c Null or empty metric name array means all metrics. @c Null or empty
13674	object array means all existing objects. If metric name array contains
13675	a single element and object array contains many, the single metric
13676	name array element is applied to each object array element to form
13677	metric/object pairs.
13678	</note>
13679	</desc>
13680	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13681	<desc>
13682	Metric name filter. Comma-separated list of metrics with wildcard
13683	support.
13684	</desc>
13685	</param>
13686	<param name="objects" type="$unknown" dir="in" safearray="yes">
13687	<desc>
13688	Set of objects to disable metrics for.
13689	</desc>
13690	</param>
13691	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13692	<desc>
13693	Array of metrics that have been modified by the call to this method.
13694	</desc>
13695	</param>
13696	</method>
13697
13698	<method name="queryMetricsData">
13699	<desc>
13700	Queries collected metrics data for a set of objects.
13701
13702	The data itself and related metric information are returned in seven
13703	parallel and one flattened array of arrays. Elements of
13704	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13705	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13706	the same index describe one set of values corresponding to a single
13707	metric.
13708
13709	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13710	start and length of a sub-array is indicated by
13711	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13712	value for metric <tt>metricNames[i]</tt> is at
13713	<tt>returnData[returnIndices[i]]</tt>.
13714
13715	<note>
13716	@c Null or empty metric name array means all metrics. @c Null or empty
13717	object array means all existing objects. If metric name array contains
13718	a single element and object array contains many, the single metric
13719	name array element is applied to each object array element to form
13720	metric/object pairs.
13721	</note>
13722	<note>
13723	Data collection continues behind the scenes after call to
13724	@c queryMetricsData. The return data can be seen as the snapshot of
13725	the current state at the time of @c queryMetricsData call. The
13726	internally kept metric values are not cleared by the call. This makes
13727	possible querying different subsets of metrics or aggregates with
13728	subsequent calls. If periodic querying is needed it is highly
13729	suggested to query the values with @c interval*count period to avoid
13730	confusion. This way a completely new set of data values will be
13731	provided by each query.
13732	</note>
13733	</desc>
13734	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13735	<desc>
13736	Metric name filter. Comma-separated list of metrics with wildcard
13737	support.
13738	</desc>
13739	</param>
13740	<param name="objects" type="$unknown" dir="in" safearray="yes">
13741	<desc>
13742	Set of objects to query metrics for.
13743	</desc>
13744	</param>
13745	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13746	<desc>
13747	Names of metrics returned in @c returnData.
13748	</desc>
13749	</param>
13750	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13751	<desc>
13752	Objects associated with metrics returned in @c returnData.
13753	</desc>
13754	</param>
13755	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13756	<desc>
13757	Units of measurement for each returned metric.
13758	</desc>
13759	</param>
13760	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13761	<desc>
13762	Divisor that should be applied to return values in order to get
13763	floating point values. For example:
13764	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13765	will retrieve the floating point value of i-th sample of the first
13766	metric.
13767	</desc>
13768	</param>
13769	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13770	<desc>
13771	Sequence numbers of the first elements of value sequences of particular metrics
13772	returned in @c returnData. For aggregate metrics it is the sequence number of
13773	the sample the aggregate started calculation from.
13774	</desc>
13775	</param>
13776	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13777	<desc>
13778	Indices of the first elements of value sequences of particular metrics
13779	returned in @c returnData.
13780	</desc>
13781	</param>
13782	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13783	<desc>
13784	Lengths of value sequences of particular metrics.
13785	</desc>
13786	</param>
13787	<param name="returnData" type="long" dir="return" safearray="yes">
13788	<desc>
13789	Flattened array of all metric data containing sequences of values for
13790	each metric.
13791	</desc>
13792	</param>
13793	</method>
13794
13795	</interface>
13796
13797	<module name="VBoxSVC" context="LocalServer">
13798	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13799	namespace="virtualbox.org">
13800	<interface name="IVirtualBox" default="yes"/>
13801	</class>
13802	</module>
13803
13804	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13805	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13806	namespace="virtualbox.org">
13807	<interface name="ISession" default="yes"/>
13808	</class>
13809	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13810	namespace="virtualbox.org">
13811	<interface name="ILocalOwner" default="yes"/>
13812	<interface name="IVirtualBoxCallback"/>
13813	<interface name="IConsoleCallback"/>
13814	</class>
13815	</module>
13816
13817	</library>
13818
13819	</idl>
13820
13821	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format