VirtualBox.xidl@ 24493

Last change on this file since 24493 was 24493, checked in by vboxsync, 15 years ago
API/Machine,Session: add a force mount parameter to MountMedium and the associated other places
Property svn:eol-style set to `native`
File size: 504.8 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4	* :tabSize=2:indentSize=2:noTabs=true:
5	* :folding=explicit:collapseFolds=1:
6	*
7	* Master declaration for VirtualBox's Main API, represented
8	* by COM/XPCOM and web service interfaces.
9	*
10	* From this document, the build system generates several files
11	* via XSLT that are then used during the build process.
12	*
13	* Below is the list of XSL templates that operate on this file and
14	* output files they generate. These XSL templates must be updated
15	* whenever the schema of this file changes:
16	*
17	* 1. src/VBox/Main/idl/midl.xsl =>
18	* out/<platform>/bin/sdk/idl/VirtualBox.idl
19	* (MS COM interface definition file for Main API)
20	*
21	* 2. src/VBox/Main/idl/xpidl.xsl =>
22	* out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
23	* (XPCOM interface definition file for Main API)
24	*
25	* 3. src/VBox/Main/idl/doxygen.xsl =>
26	* out/<platform>/obj/src/VBox/Main/VirtualBox.idl
27	* (pseudo-IDL for Doxygen to generate the official Main API
28	* documentation)
29	*
30	* 4. src/VBox/Main/webservice/*.xsl =>
31	* a bunch of WSDL and C++ files
32	* (VirtualBox web service sources and SOAP mappers;
33	* see src/VBox/Main/webservice/Makefile.kmk for details)
34	*
35	* 5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
36	* out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
37	* (smart Qt-based C++ wrapper classes for COM interfaces
38	* of the Main API)
39	*
40	* 6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
41	* out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
42	* (Main API TypeLib block for the WiX installer)
43	*
44	* 7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
45	* out/<platform>/obj/Runtime/errmsgvboxcomdata.h
46	* (<result> extraction for the %Rhrc format specifier)
47	*
48	Copyright (C) 2006-2009 Sun Microsystems, Inc.
49
50	This file is part of VirtualBox Open Source Edition (OSE), as
51	available from http://www.virtualbox.org. This file is free software;
52	you can redistribute it and/or modify it under the terms of the GNU
53	General Public License (GPL) as published by the Free Software
54	Foundation, in version 2 as it comes in the "COPYING" file of the
55	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
56	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
57
58	Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
59	Clara, CA 95054 USA or visit http://www.sun.com if you need
60	additional information or have any questions.
61	-->
62
63	<idl>
64
65	<desc>
66	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
67	describes the so-called <i>VirtualBox Main API</i> which comprises all public
68	COM interfaces and components provided by the VirtualBox server and by the
69	VirtualBox client library.
70
71	VirtualBox employs a client-server design, meaning that whenever any part of
72	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
73	interface or any virtual machine --, a dedicated server process named
74	VBoxSVC runs in the background. This allows multiple processes working with
75	VirtualBox to cooperate without conflicts. These processes communicate to each
76	other using inter-process communication facilities provided by the COM
77	implementation of the host computer.
78
79	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
80	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
81	implementation, is used.
82
83	All the parts that a typical VirtualBox user interacts with (the Qt GUI,
84	the VBoxManage command-line interface and the VBoxVRDP server) are technically
85	front-ends to the Main API and only use the interfaces that are documented
86	in this Main API documentation. This ensures that, with any given release
87	version of VirtualBox, all capabilities of the product that could be useful
88	to an external client program are always exposed by way of this API.
89
90	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
91	contains two public component classes:
92	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
93	implement IVirtualBox and ISession interfaces respectively. These two classes
94	are of supreme importance and will be needed in order for any front-end
95	program to do anything useful. It is recommended to read the documentation of
96	the mentioned interfaces first.
97
98	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
99	there can be only one object of this class on the local machine at any given
100	time. This object is a parent of many other objects in the VirtualBox COM
101	library and lives in the VBoxSVC process. In fact, when you create an instance
102	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
103	process is already running, starts it if not, and returns you a reference to
104	the <tt>VirtualBox</tt> object created in this process. When the last reference
105	to this object is released, the VBoxSVC process ends (with a 5 second delay to
106	protect from too frequent restarts).
107
108	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
109	as many <tt>Session</tt> objects as you need but all of them will live in a
110	process which issues the object instantiation call. <tt>Session</tt> objects
111	represent virtual machine sessions which are used to configure virtual
112	machines and control their execution.
113	</desc>
114
115	<if target="midl">
116	<cpp line="enum {"/>
117	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
118	<cpp line=" kTypeLibraryMinorVersion = 0"/>
119	<cpp line="};"/>
120	</if>
121
122	<if target="xpidl">
123	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
124	<cpp>
125	/* currently, nsISupportsImpl.h lacks the below-like macros */
126
127	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
128	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
129	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
130
131	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
132	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
133	NS_IMPL_THREADSAFE_ADDREF(_class) \
134	NS_IMPL_THREADSAFE_RELEASE(_class) \
135	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
136	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
137	#endif
138
139	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
140	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
141	NS_IMPL_THREADSAFE_ADDREF(_class) \
142	NS_IMPL_THREADSAFE_RELEASE(_class) \
143	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
144	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
145	#endif
146
147	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
148	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
149	NS_IMPL_THREADSAFE_ADDREF(_class) \
150	NS_IMPL_THREADSAFE_RELEASE(_class) \
151	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
152	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
153	#endif
154
155	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
156	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
157	NS_INTERFACE_MAP_BEGIN(_class) \
158	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
159	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
160	NS_IMPL_QUERY_CLASSINFO(_class) \
161	NS_INTERFACE_MAP_END
162	#endif
163
164	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
165	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
166	_i2, _ic2) \
167	NS_INTERFACE_MAP_BEGIN(_class) \
168	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
169	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
170	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
171	NS_IMPL_QUERY_CLASSINFO(_class) \
172	NS_INTERFACE_MAP_END
173	#endif
174
175	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
176	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
177	_i2, _ic2, _i3, _ic3) \
178	NS_INTERFACE_MAP_BEGIN(_class) \
179	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
180	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
183	NS_IMPL_QUERY_CLASSINFO(_class) \
184	NS_INTERFACE_MAP_END
185	#endif
186
187	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
188	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
189	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
190
191	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
192	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
193	NS_IMPL_THREADSAFE_ADDREF(_class) \
194	NS_IMPL_THREADSAFE_RELEASE(_class) \
195	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
196	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
197	#endif
198
199	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
200	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
201	_i2, _ic2) \
202	NS_IMPL_THREADSAFE_ADDREF(_class) \
203	NS_IMPL_THREADSAFE_RELEASE(_class) \
204	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
205	_i2, _ic2) \
206	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
207	#endif
208
209	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
210	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2, _i3, _ic3) \
212	NS_IMPL_THREADSAFE_ADDREF(_class) \
213	NS_IMPL_THREADSAFE_RELEASE(_class) \
214	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
215	_i2, _ic2, _i3, _ic3) \
216	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
217	#endif
218
219	</cpp>
220	</if>
221
222	<library
223	name="VirtualBox"
224	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
225	version="1.3"
226	desc="VirtualBox Type Library"
227	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
228	supportsErrorInfo="yes"
229	>
230
231
232	<!--
233	// COM result codes for VirtualBox
234	/////////////////////////////////////////////////////////////////////////
235	-->
236
237	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
238	<desc>
239	This section describes all VirtualBox-specific COM result codes that may
240	be returned by methods of VirtualBox COM interfaces in addition to
241	standard COM result codes.
242
243	Note that along with the result code, every VirtualBox method returns
244	extended error information through the IVirtualBoxErrorInfo interface on
245	failure. This interface is a preferred way to present the error to the end
246	user because it contains a human readable description of the error. Raw
247	result codes, both standard and described in this section, are intended to
248	be used by programs to analyze the reason of a failure and select an
249	appropriate course of action without involving the end user (for example,
250	retry the operation later or make a different call).
251
252	The standard COM result codes that may originate from our methods include:
253
254	<table>
255	<tr><td>E_INVALIDARG</td>
256	<td>
257	Returned when the value of the method's argument is not within the range
258	of valid values. This should not be confused with situations when the
259	value is within the range but simply doesn't suit the current object
260	state and there is a possibility that it will be accepted later (in such
261	cases VirtualBox-specific codes are returned, for example,
262	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
263	</td>
264	</tr>
265	<tr><td>E_POINTER</td>
266	<td>
267	Returned if a memory pointer for the output argument is invalid (for
268	example, @c null). Note that when pointers representing input
269	arguments (such as strings) are invalid, E_INVALIDARG is returned.
270	</td>
271	</tr>
272	<tr><td>E_ACCESSDENIED</td>
273	<td>
274	Returned when the called object is not ready. Since the lifetime of a
275	public COM object cannot be fully controlled by the implementation,
276	VirtualBox maintains the readiness state for all objects it creates and
277	returns this code in response to any method call on the object that was
278	deactivated by VirtualBox and is not functioning any more.
279	</td>
280	</tr>
281	<tr><td>E_OUTOFMEMORY</td>
282	<td>
283	Returned when a memory allocation operation fails.
284	</td>
285	</tr>
286	</table>
287	</desc>
288	</descGroup>
289
290	<!--
291	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
292	everything in <result>/<desc> after (and including) the first dot, so express
293	the matter of the error code in the first sentence and keep it short.
294	-->
295
296	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
297	<desc>
298	Object corresponding to the supplied arguments does not exist.
299	</desc>
300	</result>
301
302	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
303	<desc>
304	Current virtual machine state prevents the operation.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
309	<desc>
310	Virtual machine error occurred attempting the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
315	<desc>
316	File not accessible or erroneous file contents.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
321	<desc>
322	Runtime subsystem error.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
327	<desc>
328	Pluggable Device Manager error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
333	<desc>
334	Current object state prohibits operation.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
339	<desc>
340	Host operating system related error.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
345	<desc>
346	Requested operation is not supported.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
351	<desc>
352	Invalid XML found.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
357	<desc>
358	Current session state prohibits operation.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
363	<desc>
364	Object being in use prohibits operation.
365	</desc>
366	</result>
367
368	<!--
369	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
370	everything in <result>/<desc> after (and including) the first dot, so express
371	the matter of the error code in the first sentence and keep it short.
372	-->
373
374	<descGroup/>
375
376	<!--
377	// all common enums
378	/////////////////////////////////////////////////////////////////////////
379	-->
380
381	<enum name="SettingsVersion"
382	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
383	>
384	<desc>Settings version of VirtualBox settings files. This is written to
385	the "version" attribute of the root "VirtualBox" element in the settings
386	file XML and indicates which VirtualBox version wrote the file.
387	</desc>
388
389	<const name="Null" value="0">
390	<desc>Null value, indicates invalid version.</desc>
391	</const>
392	<const name="v1_0" value="1">
393	<desc>Legacy settings version, not currently supported.</desc>
394	</const>
395	<const name="v1_1" value="2">
396	<desc>Legacy settings version, not currently supported.</desc>
397	</const>
398	<const name="v1_2" value="3">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_3pre" value="4">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_3" value="5">
405	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
406	<!--
407	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
408	-->
409	</const>
410	<const name="v1_4" value="6">
411	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
412	<!--
413	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
414	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
415	-->
416	</const>
417	<const name="v1_5" value="7">
418	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
419	<!-- 2008-09-04: 2.0.0 released
420	2008-11-20: settings version 1.5 introduced
421	2008-12-17: 2.1.0 released
422	Machine changes:
423	guest OS identifiers changed;
424	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
425	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
426	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
427	-->
428	</const>
429	<const name="v1_6" value="8">
430	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
431	<!-- 2008-12-17: 2.1.0 released
432	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
433	2009-04-08: 2.2.0 released
434	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
435	-->
436	</const>
437	<const name="v1_7" value="9">
438	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
439	<!-- 2008-12-17: 2.1.0 released
440	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
441	2009-04-08: 2.2.0 released
442	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
443	Machine changes: HardDiskAttachments is now StorageControllers (done)
444	-->
445	</const>
446	<const name="v1_8" value="10">
447	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
448	<!-- Machine additions: Display/@accelerate2DVideo (done)
449	-->
450	</const>
451	<const name="v1_9" value="11">
452	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
453	<!-- The big storage controller / DVD / Floppy rework (done)
454	-->
455	</const>
456	<const name="Future" value="12">
457	<desc>Settings version greater than "1.9", written by a future VirtualBox version.</desc>
458	</const>
459	</enum>
460
461	<enum
462	name="AccessMode"
463	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
464	>
465	<desc>
466	Access mode for opening files.
467	</desc>
468
469	<const name="ReadOnly" value="1"/>
470	<const name="ReadWrite" value="2"/>
471	</enum>
472
473	<enum
474	name="MachineState"
475	uuid="36518cf6-cdf0-4d0d-ad2a-5ee9c60c7494"
476	>
477	<desc>
478	Virtual machine execution state.
479
480	This enumeration represents possible values of the <link
481	to="IMachine::state"/> attribute.
482
483	Below is the basic virtual machine state diagram. It shows how the state
484	changes during virtual machine execution. The text in square braces shows
485	a method of the IConsole interface that performs the given state
486	transition.
487
488	<pre>
489	+---------[powerDown()] <- Stuck <--[failure]-+
490	V \|
491	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
492	\| \| \| \| V \|
493	\| Aborted -----+ +--> Running --[pause()]--> Paused
494	\| \| ^ \| ^ \|
495	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
496	\| ^ \| \| \| \|
497	\| \| +-----------------------------------------+-\|-------------------+ +
498	\| \| \| \| \|
499	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
500	\| \| \| \|
501	\| +-------- Saving <--------[saveState()]<----------+---------------------+
502	\| \| \|
503	+-------------- Stopping -------[powerDown()]<----------+---------------------+
504	</pre>
505
506	Note that states to the right from PoweredOff, Aborted and Saved in the
507	above diagram are called <i>online VM states</i>. These states
508	represent the virtual machine which is being executed in a dedicated
509	process (usually with a GUI window attached to it where you can see the
510	activity of the virtual machine and interact with it). There are two
511	special pseudo-states, FirstOnline and LastOnline, that can be used in
512	relational expressions to detect if the given machine state is online or
513	not:
514
515	<pre>
516	if (machine.GetState() >= MachineState_FirstOnline &&
517	machine.GetState() <= MachineState_LastOnline)
518	{
519	...the machine is being executed...
520	}
521	</pre>
522
523	When the virtual machine is in one of the online VM states (that is, being
524	executed), only a few machine settings can be modified. Methods working
525	with such settings contain an explicit note about that. An attempt to
526	change any oter setting or perform a modifying operation during this time
527	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
528
529	All online states except Running, Paused and Stuck are transitional: they
530	represent temporary conditions of the virtual machine that will last as
531	long as the operation that initiated such a condition.
532
533	The Stuck state is a special case. It means that execution of the machine
534	has reached the "Guru Meditation" condition. This condition indicates an
535	internal VMM (virtual machine manager) failure which may happen as a
536	result of either an unhandled low-level virtual hardware exception or one
537	of the recompiler exceptions (such as the <i>too-many-traps</i>
538	condition).
539
540	Note also that any online VM state may transit to the Aborted state. This
541	happens if the process that is executing the virtual machine terminates
542	unexpectedly (for example, crashes). Other than that, the Aborted state is
543	equivalent to PoweredOff.
544
545	There are also a few additional state diagrams that do not deal with
546	virtual machine execution and therefore are shown separately. The states
547	shown on these diagrams are called <i>offline VM states</i> (this includes
548	PoweredOff, Aborted and Saved too).
549
550	The first diagram shows what happens when a lengthy setup operation is
551	being executed (such as <link to="IMachine::attachDevice"/>).
552
553	<pre>
554	+----------------------------------(same state as before the call)------+
555	\| \|
556	+-> PoweredOff --+ \|
557	\| \| \|
558	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
559	\| \|
560	+-> Saved -------+
561	</pre>
562
563	The next two diagrams demonstrate the process of taking a snapshot of a
564	powered off virtual machine and performing one of the "discard..."
565	operations, respectively.
566
567	<pre>
568	+----------------------------------(same state as before the call)------+
569	\| \|
570	+-> PoweredOff --+ \|
571	\| +-->[takeSnapshot()] -------------------> Saving ------+
572	+-> Aborted -----+
573
574	+-> PoweredOff --+
575	\| \|
576	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
577	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
578	+-> Saved -------+ \|
579	\| \|
580	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
581	</pre>
582
583	Note that the Saving state is present in both the offline state group and
584	online state group. Currently, the only way to determine what group is
585	assumed in a particular case is to remember the previous machine state: if
586	it was Running or Paused, then Saving is an online state, otherwise it is
587	an offline state. This inconsistency may be removed in one of the future
588	versions of VirtualBox by adding a new state.
589
590	<note internal="yes">
591	For whoever decides to touch this enum: In order to keep the
592	comparisons involving FirstOnline and LastOnline pseudo-states valid,
593	the numeric values of these states must be correspondingly updated if
594	needed: for any online VM state, the condition
595	<tt>FirstOnline <= state <= LastOnline</tt> must be
596	@c true. The same relates to transient states for which
597	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
598	@c true.
599	</note>
600	</desc>
601
602	<const name="Null" value="0">
603	<desc>Null value (never used by the API).</desc>
604	</const>
605	<const name="PoweredOff" value="1">
606	<desc>
607	The machine is not running and has no saved execution state; it has
608	either never been started or been shut down successfully.
609	</desc>
610	</const>
611	<const name="Saved" value="2">
612	<desc>
613	The machine is not currently running, but the execution state of the machine
614	has been saved to an external file when it was running, from where
615	it can be resumed.
616	</desc>
617	</const>
618	<const name="Teleported" value="3">
619	<desc>
620	The machine was teleported to a different host (or process) and then
621	powered off. Take care when powering it on again may corrupt resources
622	it shares with the teleportation target (e.g. disk and network).
623	</desc>
624	</const>
625	<const name="Aborted" value="4">
626	<desc>
627	The process running the machine has terminated abnormally. This may
628	indicate a crash of the VM process in host execution context, or
629	the VM process has been terminated externally.
630	</desc>
631	</const>
632	<const name="Running" value="5">
633	<desc>
634	The machine is currently being executed.
635	<note internal="yes">
636	For whoever decides to touch this enum: In order to keep the
637	comparisons in the old source code valid, this state must immediately
638	precede the Paused state.
639	TODO: Lift this spectacularly wonderful restriction.
640	</note>
641	</desc>
642	</const>
643	<const name="Paused" value="6">
644	<desc>
645	Execution of the machine has been paused.
646	<note internal="yes">
647	For whoever decides to touch this enum: In order to keep the
648	comparisons in the old source code valid, this state must immediately
649	follow the Running state.
650	TODO: Lift this spectacularly wonderful restriction.
651	</note>
652	</desc>
653	</const>
654	<const name="Stuck" value="7">
655	<desc>
656	Execution of the machine has reached the "Guru Meditation"
657	condition. This indicates a severe error in the hypervisor itself.
658	<note internal="yes">
659	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
660	"Guru", perhaps? Or are there some other VMM states that are
661	intended to be lumped in here as well?
662	</note>
663	</desc>
664	</const>
665	<const name="Teleporting" value="8">
666	<desc>
667	The machine is about to be teleported to a different host or process.
668	It is possible to pause a machine in this state, but it will go to the
669	<link to="MachineState::PausedTeleporting"/> state and it will not be
670	possible to resume it again unless the teleportation fails.
671	</desc>
672	</const>
673	<const name="LiveSnapshotting" value="9">
674	<desc>
675	A live snapshot is being taken. The machine is running normally, but
676	some of the runtime configuration options are inaccessible. Also, if
677	paused while in this state it will transition to
678	<link to="MachineState::Saving"/> and it will not be resume the
679	execution until the snapshot operation has completed.
680	</desc>
681	</const>
682	<const name="Starting" value="10">
683	<desc>
684	Machine is being started after powering it on from a
685	zero execution state.
686	</desc>
687	</const>
688	<const name="Stopping" value="11">
689	<desc>
690	Machine is being normally stopped powering it off, or after the guest OS
691	has initiated a shutdown sequence.
692	</desc>
693	</const>
694	<const name="Saving" value="12">
695	<desc>
696	Machine is saving its execution state to a file, or an online
697	snapshot of the machine is being taken.
698	</desc>
699	</const>
700	<const name="Restoring" value="13">
701	<desc>
702	Execution state of the machine is being restored from a file
703	after powering it on from the saved execution state.
704	</desc>
705	</const>
706	<const name="TeleportingPausedVM" value="14">
707	<desc>
708	The machine is being teleported to another host or process, but it is
709	not running. This is the paused variant of the
710	<link to="MachineState::Teleporting"/> state.
711	</desc>
712	</const>
713	<const name="TeleportingIn" value="15">
714	<desc>
715	Teleporting the machine state in from another host or process.
716	</desc>
717	</const>
718	<const name="RestoringSnapshot" value="16">
719	<desc>
720	A machine snapshot is being restored; this typically does not take long.
721	</desc>
722	</const>
723	<const name="DeletingSnapshot" value="17">
724	<desc>
725	A machine snapshot is being deleted; this can take a long time since this
726	may require merging differencing media.
727	</desc>
728	</const>
729	<const name="SettingUp" value="18">
730	<desc>
731	Lengthy setup operation is in progress.
732	</desc>
733	</const>
734
735	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
736	<desc>
737	Pseudo-state: first online state (for use in relational expressions).
738	</desc>
739	</const>
740	<const name="LastOnline" value="13" wsmap="suppress"> <!-- TeleportingIn -->
741	<desc>
742	Pseudo-state: last online state (for use in relational expressions).
743	</desc>
744	</const>
745
746	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
747	<desc>
748	Pseudo-state: first transient state (for use in relational expressions).
749	</desc>
750	</const>
751	<const name="LastTransient" value="18" wsmap="suppress"> <!-- SettingUp -->
752	<desc>
753	Pseudo-state: last transient state (for use in relational expressions).
754	</desc>
755	</const>
756
757	</enum>
758
759	<enum
760	name="SessionState"
761	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
762	>
763	<desc>
764	Session state. This enumeration represents possible values of
765	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
766	attributes. See individual enumerator descriptions for the meaning for
767	every value.
768	</desc>
769
770	<const name="Null" value="0">
771	<desc>Null value (never used by the API).</desc>
772	</const>
773	<const name="Closed" value="1">
774	<desc>
775	The machine has no open sessions (<link to="IMachine::sessionState"/>);
776	the session is closed (<link to="ISession::state"/>)
777	</desc>
778	</const>
779	<const name="Open" value="2">
780	<desc>
781	The machine has an open direct session (<link to="IMachine::sessionState"/>);
782	the session is open (<link to="ISession::state"/>)
783	</desc>
784	</const>
785	<const name="Spawning" value="3">
786	<desc>
787	A new (direct) session is being opened for the machine as a result of
788	<link to="IVirtualBox::openRemoteSession"/> call
789	(<link to="IMachine::sessionState"/> or <link to="ISession::state"/>).
790	This state also occurs as a short transient state when a new direct
791	session is opened by calling <link to="IVirtualBox::openSession"/>.
792	</desc>
793	</const>
794	<const name="Closing" value="4">
795	<desc>
796	The direct session is being closed (<link to="IMachine::sessionState"/>);
797	the session is being closed (<link to="ISession::state"/>)
798	</desc>
799	</const>
800	</enum>
801
802	<enum
803	name="CpuPropertyType"
804	uuid="af7bb668-eeb1-4404-b77f-a114b30c92d6"
805	>
806	<desc>
807	Virtual CPU property type. This enumeration represents possible values of the
808	IMachine get- and setCpuProperty methods.
809	</desc>
810	<const name="Null" value="0">
811	<desc>Null value (never used by the API).</desc>
812	</const>
813	<const name="PAE" value="1">
814	<desc>
815	This setting determines whether VirtualBox will expose the Physical Address
816	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
817	is not available, it will not be reported.
818	</desc>
819	</const>
820	<const name="Synthetic" value="2">
821	<desc>
822	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
823	teleporting between host systems that differ significantly.
824	</desc>
825	</const>
826	</enum>
827
828
829	<enum
830	name="HWVirtExPropertyType"
831	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
832	>
833	<desc>
834	Hardware virtualization property type. This enumeration represents possible values
835	for the <link to="IMachine::getHWVirtExProperty"/> and
836	<link to="IMachine::setHWVirtExProperty"/> methods.
837	</desc>
838	<const name="Null" value="0">
839	<desc>Null value (never used by the API).</desc>
840	</const>
841	<const name="Enabled" value="1">
842	<desc>
843	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
844	such extensions are not available, they will not be used.
845	</desc>
846	</const>
847	<const name="Exclusive" value="2">
848	<desc>
849	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
850	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
851	feature of the host. To share these with other hypervisors, you must disable this property.
852	</desc>
853	</const>
854	<const name="VPID" value="3">
855	<desc>
856	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
857	</desc>
858	</const>
859	<const name="NestedPaging" value="4">
860	<desc>
861	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
862	</desc>
863	</const>
864	</enum>
865
866	<enum
867	name="SessionType"
868	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
869	>
870	<desc>
871	Session type. This enumeration represents possible values of the
872	<link to="ISession::type"/> attribute.
873	</desc>
874
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="Direct" value="1">
879	<desc>
880	Direct session
881	(opened by <link to="IVirtualBox::openSession"/>)
882	</desc>
883	</const>
884	<const name="Remote" value="2">
885	<desc>
886	Remote session
887	(opened by <link to="IVirtualBox::openRemoteSession"/>)
888	</desc>
889	</const>
890	<const name="Existing" value="3">
891	<desc>
892	Existing session
893	(opened by <link to="IVirtualBox::openExistingSession"/>)
894	</desc>
895	</const>
896	</enum>
897
898	<enum
899	name="DeviceType"
900	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
901	>
902	<desc>
903	Device type.
904	</desc>
905	<const name="Null" value="0">
906	<desc>
907	Null value, may also mean "no device" (not allowed for
908	<link to="IConsole::getDeviceActivity"/>).
909	</desc>
910	</const>
911	<const name="Floppy" value="1">
912	<desc>Floppy device.</desc>
913	</const>
914	<const name="DVD" value="2">
915	<desc>CD/DVD-ROM device.</desc>
916	</const>
917	<const name="HardDisk" value="3">
918	<desc>Hard disk device.</desc>
919	</const>
920	<const name="Network" value="4">
921	<desc>Network device.</desc>
922	</const>
923	<const name="USB" value="5">
924	<desc>USB device.</desc>
925	</const>
926	<const name="SharedFolder" value="6">
927	<desc>Shared folder device.</desc>
928	</const>
929	</enum>
930
931	<enum
932	name="DeviceActivity"
933	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
934	>
935	<desc>
936	Device activity for <link to="IConsole::getDeviceActivity"/>.
937	</desc>
938
939	<const name="Null" value="0"/>
940	<const name="Idle" value="1"/>
941	<const name="Reading" value="2"/>
942	<const name="Writing" value="3"/>
943	</enum>
944
945	<enum
946	name="ClipboardMode"
947	uuid="33364716-4008-4701-8f14-be0fa3d62950"
948	>
949	<desc>
950	Host-Guest clipboard interchange mode.
951	</desc>
952
953	<const name="Disabled" value="0"/>
954	<const name="HostToGuest" value="1"/>
955	<const name="GuestToHost" value="2"/>
956	<const name="Bidirectional" value="3"/>
957	</enum>
958
959	<enum
960	name="Scope"
961	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
962	>
963	<desc>
964	Scope of the operation.
965
966	A generic enumeration used in various methods to define the action or
967	argument scope.
968	</desc>
969
970	<const name="Global" value="0"/>
971	<const name="Machine" value="1"/>
972	<const name="Session" value="2"/>
973	</enum>
974
975	<enum
976	name="GuestStatisticType"
977	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
978	>
979	<desc>
980	Statistics type for <link to="IGuest::getStatistic"/>.
981	</desc>
982
983	<const name="CPULoad_Idle" value="0">
984	<desc>
985	Idle CPU load (0-100%) for last interval.
986	</desc>
987	</const>
988	<const name="CPULoad_Kernel" value="1">
989	<desc>
990	Kernel CPU load (0-100%) for last interval.
991	</desc>
992	</const>
993	<const name="CPULoad_User" value="2">
994	<desc>
995	User CPU load (0-100%) for last interval.
996	</desc>
997	</const>
998	<const name="Threads" value="3">
999	<desc>
1000	Total number of threads in the system.
1001	</desc>
1002	</const>
1003	<const name="Processes" value="4">
1004	<desc>
1005	Total number of processes in the system.
1006	</desc>
1007	</const>
1008	<const name="Handles" value="5">
1009	<desc>
1010	Total number of handles in the system.
1011	</desc>
1012	</const>
1013	<const name="MemoryLoad" value="6">
1014	<desc>
1015	Memory load (0-100%).
1016	</desc>
1017	</const>
1018	<const name="PhysMemTotal" value="7">
1019	<desc>
1020	Total physical memory in megabytes.
1021	</desc>
1022	</const>
1023	<const name="PhysMemAvailable" value="8">
1024	<desc>
1025	Free physical memory in megabytes.
1026	</desc>
1027	</const>
1028	<const name="PhysMemBalloon" value="9">
1029	<desc>
1030	Ballooned physical memory in megabytes.
1031	</desc>
1032	</const>
1033	<const name="MemCommitTotal" value="10">
1034	<desc>
1035	Total amount of memory in the committed state in megabytes.
1036	</desc>
1037	</const>
1038	<const name="MemKernelTotal" value="11">
1039	<desc>
1040	Total amount of memory used by the guest OS's kernel in megabytes.
1041	</desc>
1042	</const>
1043	<const name="MemKernelPaged" value="12">
1044	<desc>
1045	Total amount of paged memory used by the guest OS's kernel in megabytes.
1046	</desc>
1047	</const>
1048	<const name="MemKernelNonpaged" value="13">
1049	<desc>
1050	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
1051	</desc>
1052	</const>
1053	<const name="MemSystemCache" value="14">
1054	<desc>
1055	Total amount of memory used by the guest OS's system cache in megabytes.
1056	</desc>
1057	</const>
1058	<const name="PageFileSize" value="15">
1059	<desc>
1060	Pagefile size in megabytes.
1061	</desc>
1062	</const>
1063	<const name="SampleNumber" value="16">
1064	<desc>
1065	Statistics sample number
1066	</desc>
1067	</const>
1068	<const name="MaxVal" value="17"/>
1069	</enum>
1070
1071	<enum
1072	name="BIOSBootMenuMode"
1073	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1074	>
1075	<desc>
1076	BIOS boot menu mode.
1077	</desc>
1078
1079	<const name="Disabled" value="0"/>
1080	<const name="MenuOnly" value="1"/>
1081	<const name="MessageAndMenu" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="ProcessorFeature"
1086	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1087	>
1088	<desc>
1089	CPU features.
1090	</desc>
1091
1092	<const name="HWVirtEx" value="0"/>
1093	<const name="PAE" value="1"/>
1094	<const name="LongMode" value="2"/>
1095	<const name="NestedPaging" value="3"/>
1096	</enum>
1097
1098	<enum
1099	name="FirmwareType"
1100	uuid="7ceea938-8b49-41e2-bb47-667219c0d586"
1101	>
1102	<desc>
1103	Firmware type.
1104	</desc>
1105	<const name="BIOS" value="1">
1106	<desc>BIOS Firmware.</desc>
1107	</const>
1108	<const name="EFI" value="2">
1109	<desc>Efi firmware.</desc>
1110	</const>
1111	</enum>
1112
1113	<!--
1114	// IVirtualBoxErrorInfo
1115	/////////////////////////////////////////////////////////////////////////
1116	-->
1117
1118	<interface
1119	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1120	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
1121	supportsErrorInfo="no"
1122	wsmap="managed"
1123	>
1124	<desc>
1125	The IVirtualBoxErrorInfo interface represents extended error information.
1126
1127	Extended error information can be set by VirtualBox components after
1128	unsuccessful or partially successful method invocation. This information
1129	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1130	and then shown to the client in addition to the plain 32-bit result code.
1131
1132	In MS COM, this interface extends the IErrorInfo interface,
1133	in XPCOM, it extends the nsIException interface. In both cases,
1134	it provides a set of common attributes to retrieve error
1135	information.
1136
1137	Sometimes invocation of some component's method may involve methods of
1138	other components that may also fail (independently of this method's
1139	failure), or a series of non-fatal errors may precede a fatal error that
1140	causes method failure. In cases like that, it may be desirable to preserve
1141	information about all errors happened during method invocation and deliver
1142	it to the caller. The <link to="#next"/> attribute is intended
1143	specifically for this purpose and allows to represent a chain of errors
1144	through a single IVirtualBoxErrorInfo object set after method invocation.
1145
1146	Note that errors are stored to a chain in the reverse order, i.e. the
1147	initial error object you query right after method invocation is the last
1148	error set by the callee, the object it points to in the @a next attribute
1149	is the previous error and so on, up to the first error (which is the last
1150	in the chain).
1151	</desc>
1152
1153	<attribute name="resultCode" type="long" readonly="yes">
1154	<desc>
1155	Result code of the error.
1156	Usually, it will be the same as the result code returned
1157	by the method that provided this error information, but not
1158	always. For example, on Win32, CoCreateInstance() will most
1159	likely return E_NOINTERFACE upon unsuccessful component
1160	instantiation attempt, but not the value the component factory
1161	returned. Value is typed 'long', not 'result',
1162	to make interface usable from scripting languages.
1163	<note>
1164	In MS COM, there is no equivalent.
1165	In XPCOM, it is the same as nsIException::result.
1166	</note>
1167	</desc>
1168	</attribute>
1169
1170	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1171	<desc>
1172	UUID of the interface that defined the error.
1173	<note>
1174	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1175	data type.
1176	In XPCOM, there is no equivalent.
1177	</note>
1178	</desc>
1179	</attribute>
1180
1181	<attribute name="component" type="wstring" readonly="yes">
1182	<desc>
1183	Name of the component that generated the error.
1184	<note>
1185	In MS COM, it is the same as IErrorInfo::GetSource.
1186	In XPCOM, there is no equivalent.
1187	</note>
1188	</desc>
1189	</attribute>
1190
1191	<attribute name="text" type="wstring" readonly="yes">
1192	<desc>
1193	Text description of the error.
1194	<note>
1195	In MS COM, it is the same as IErrorInfo::GetDescription.
1196	In XPCOM, it is the same as nsIException::message.
1197	</note>
1198	</desc>
1199	</attribute>
1200
1201	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1202	<desc>
1203	Next error object if there is any, or @c null otherwise.
1204	<note>
1205	In MS COM, there is no equivalent.
1206	In XPCOM, it is the same as nsIException::inner.
1207	</note>
1208	</desc>
1209	</attribute>
1210
1211	</interface>
1212
1213	<interface
1214	name="ILocalOwner" extends="$dispatched"
1215	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1216	>
1217	<desc>
1218	The ILocalOwner interface allows to register local objects
1219	(created without COM calls, but with new()).
1220	Once registered, calls to methods of such objects can be made
1221	from remote COM processes.
1222	The main usecase is the event callback implementation where
1223	API clients provide callback objects.
1224	</desc>
1225	<method name="setLocalObject">
1226	<desc>
1227	Set local object.
1228	</desc>
1229	<param name="object" type="$unknown" dir="in">
1230	<desc>Local object to forward requests to.
1231	If null, clears currently set local object.</desc>
1232	</param>
1233	</method>
1234	</interface>
1235
1236	<!--
1237	// IVirtualBox
1238	/////////////////////////////////////////////////////////////////////////
1239	-->
1240
1241	<interface
1242	name="IVirtualBoxCallback" extends="$unknown"
1243	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1244	wsmap="suppress"
1245	>
1246
1247	<method name="onMachineStateChange">
1248	<desc>
1249	The execution state of the given machine has changed.
1250	<see>IMachine::state</see>
1251	</desc>
1252	<param name="machineId" type="uuid" mod="string" dir="in">
1253	<desc>ID of the machine this event relates to.</desc>
1254	</param>
1255	<param name="state" type="MachineState" dir="in">
1256	<desc>New execution state.</desc>
1257	</param>
1258	</method>
1259
1260	<method name="onMachineDataChange">
1261	<desc>
1262	Any of the settings of the given machine has changed.
1263	</desc>
1264	<param name="machineId" type="uuid" mod="string" dir="in">
1265	<desc>ID of the machine this event relates to.</desc>
1266	</param>
1267	</method>
1268
1269	<method name="onExtraDataCanChange">
1270	<desc>
1271	Notification when someone tries to change extra data for
1272	either the given machine or (if @c null) global extra data.
1273	This gives the chance to veto against changes.
1274	</desc>
1275	<param name="machineId" type="uuid" mod="string" dir="in">
1276	<desc>
1277	ID of the machine this event relates to
1278	(@c null ID for global extra data change requests).
1279	</desc>
1280	</param>
1281	<param name="key" type="wstring" dir="in">
1282	<desc>
1283	Extra data key for the attempted write.
1284	</desc>
1285	</param>
1286	<param name="value" type="wstring" dir="in">
1287	<desc>
1288	Extra data value for the given key.
1289	</desc>
1290	</param>
1291	<param name="error" type="wstring" dir="out">
1292	<desc>
1293	Optional error message describing the reason of the
1294	veto (ignored if this notification returns @c true).
1295	</desc>
1296	</param>
1297	<param name="allowChange" type="boolean" dir="return">
1298	<desc>
1299	Flag to indicate whether the callee agrees (@c true)
1300	or vetoes against the change (@c false).
1301	</desc>
1302	</param>
1303	</method>
1304
1305	<method name="onExtraDataChange">
1306	<desc>
1307	Notification when machine specific or global extra data
1308	has changed.
1309	</desc>
1310	<param name="machineId" type="uuid" mod="string" dir="in">
1311	<desc>
1312	ID of the machine this event relates to.
1313	Null for global extra data changes.
1314	</desc>
1315	</param>
1316	<param name="key" type="wstring" dir="in">
1317	<desc>
1318	Extra data key that has changed.
1319	</desc>
1320	</param>
1321	<param name="value" type="wstring" dir="in">
1322	<desc>
1323	Extra data value for the given key.
1324	</desc>
1325	</param>
1326	</method>
1327
1328	<method name="onMediumRegistered">
1329	<desc>
1330	The given medium was registered or unregistered
1331	within this VirtualBox installation.
1332
1333	The @a mediumType parameter describes what type of
1334	medium the specified @a mediumId refers to. Possible
1335	values are:
1336
1337	<ul>
1338	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1339	that, if registered, can be obtained using the
1340	<link to="IVirtualBox::getHardDisk"/> call.</li>
1341	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1342	that, if registered, can be obtained using the
1343	<link to="IVirtualBox::getDVDImage"/> call.</li>
1344	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1345	that, if registered, can be obtained using the
1346	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1347	</ul>
1348
1349	Note that if this is a deregistration notification,
1350	there is no way to access the object representing the
1351	unregistered medium. It is supposed that the
1352	application will do required cleanup based on the
1353	@a mediumId value.
1354	</desc>
1355	<param name="mediumId" type="uuid" mod="string" dir="in">
1356	<desc>ID of the medium this event relates to.</desc>
1357	</param>
1358	<param name="mediumType" type="DeviceType" dir="in">
1359	<desc>Type of the medium this event relates to.</desc>
1360	</param>
1361	<param name="registered" type="boolean" dir="in">
1362	<desc>
1363	If @c true, the medium was registered, otherwise it was
1364	unregistered.
1365	</desc>
1366	</param>
1367	</method>
1368
1369	<method name="onMachineRegistered">
1370	<desc>
1371	The given machine was registered or unregistered
1372	within this VirtualBox installation.
1373	</desc>
1374	<param name="machineId" type="uuid" mod="string" dir="in">
1375	<desc>ID of the machine this event relates to.</desc>
1376	</param>
1377	<param name="registered" type="boolean" dir="in">
1378	<desc>
1379	If @c true, the machine was registered, otherwise it was
1380	unregistered.
1381	</desc>
1382	</param>
1383	</method>
1384
1385	<method name="onSessionStateChange">
1386	<desc>
1387	The state of the session for the given machine was changed.
1388	<see>IMachine::sessionState</see>
1389	</desc>
1390	<param name="machineId" type="uuid" mod="string" dir="in">
1391	<desc>ID of the machine this event relates to.</desc>
1392	</param>
1393	<param name="state" type="SessionState" dir="in">
1394	<desc>New session state.</desc>
1395	</param>
1396	</method>
1397
1398	<method name="onSnapshotTaken">
1399	<desc>
1400	A new snapshot of the machine has been taken.
1401	<see>ISnapshot</see>
1402	</desc>
1403	<param name="machineId" type="uuid" mod="string" dir="in">
1404	<desc>ID of the machine this event relates to.</desc>
1405	</param>
1406	<param name="snapshotId" type="uuid" mod="string" dir="in">
1407	<desc>ID of the new snapshot.</desc>
1408	</param>
1409	</method>
1410
1411	<method name="onSnapshotDiscarded">
1412	<desc>
1413	Snapshot of the given machine has been discarded.
1414
1415	<note>
1416	This notification is delivered <b>after</b> the snapshot
1417	object has been uninitialized on the server (so that any
1418	attempt to call its methods will return an error).
1419	</note>
1420
1421	<see>ISnapshot</see>
1422	</desc>
1423	<param name="machineId" type="uuid" mod="string" dir="in">
1424	<desc>ID of the machine this event relates to.</desc>
1425	</param>
1426	<param name="snapshotId" type="uuid" mod="string" dir="in">
1427	<desc>
1428	ID of the discarded snapshot. @c null means the current machine
1429	state has been discarded (restored from the current snapshot).
1430	</desc>
1431	</param>
1432	</method>
1433
1434	<method name="onSnapshotChange">
1435	<desc>
1436	Snapshot properties (name and/or description) have been changed.
1437	<see>ISnapshot</see>
1438	</desc>
1439	<param name="machineId" type="uuid" mod="string" dir="in">
1440	<desc>ID of the machine this event relates to.</desc>
1441	</param>
1442	<param name="snapshotId" type="uuid" mod="string" dir="in">
1443	<desc>ID of the changed snapshot.</desc>
1444	</param>
1445	</method>
1446
1447	<method name="onGuestPropertyChange">
1448	<desc>
1449	Notification when a guest property has changed.
1450	</desc>
1451	<param name="machineId" type="uuid" mod="string" dir="in">
1452	<desc>
1453	ID of the machine this event relates to.
1454	</desc>
1455	</param>
1456	<param name="name" type="wstring" dir="in">
1457	<desc>
1458	The name of the property that has changed.
1459	</desc>
1460	</param>
1461	<param name="value" type="wstring" dir="in">
1462	<desc>
1463	The new property value.
1464	</desc>
1465	</param>
1466	<param name="flags" type="wstring" dir="in">
1467	<desc>
1468	The new property flags.
1469	</desc>
1470	</param>
1471	</method>
1472
1473	</interface>
1474
1475	<interface
1476	name="IDHCPServer" extends="$unknown"
1477	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1478	wsmap="managed"
1479	>
1480	<desc>
1481	The IDHCPServer interface represents the vbox dhcp server configuration.
1482
1483	To enumerate all the dhcp servers on the host, use the
1484	<link to="IVirtualBox::DHCPServers"/> attribute.
1485	</desc>
1486
1487	<attribute name="enabled" type="boolean">
1488	<desc>
1489	specifies if the dhcp server is enabled
1490	</desc>
1491	</attribute>
1492
1493	<attribute name="IPAddress" type="wstring" readonly="yes">
1494	<desc>
1495	specifies server IP
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="networkMask" type="wstring" readonly="yes">
1500	<desc>
1501	specifies server network mask
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="networkName" type="wstring" readonly="yes">
1506	<desc>
1507	specifies internal network name the server is used for
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="lowerIP" type="wstring" readonly="yes">
1512	<desc>
1513	specifies from IP adrres in server address range
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="upperIP" type="wstring" readonly="yes">
1518	<desc>
1519	specifies to IP adrres in server address range
1520	</desc>
1521	</attribute>
1522
1523	<method name="setConfiguration">
1524	<desc>
1525	configures the server
1526	<result name="E_INVALIDARG">
1527	invalid configuration supplied
1528	</result>
1529	</desc>
1530	<param name="IPAddress" type="wstring" dir="in">
1531	<desc>
1532	server IP address
1533	</desc>
1534	</param>
1535	<param name="networkMask" type="wstring" dir="in">
1536	<desc>
1537	server network mask
1538	</desc>
1539	</param>
1540	<param name="FromIPAddress" type="wstring" dir="in">
1541	<desc>
1542	server From IP address for address range
1543	</desc>
1544	</param>
1545	<param name="ToIPAddress" type="wstring" dir="in">
1546	<desc>
1547	server To IP address for address range
1548	</desc>
1549	</param>
1550	</method>
1551
1552	<method name="start">
1553	<desc>
1554	Starts DHCP server process.
1555	<result name="E_FAIL">
1556	Failed to start the process.
1557	</result>
1558	</desc>
1559	<param name="networkName" type="wstring" dir="in">
1560	<desc>
1561	Name of internal network DHCP server should attach to.
1562	</desc>
1563	</param>
1564	<param name="trunkName" type="wstring" dir="in">
1565	<desc>
1566	Name of internal network trunk.
1567	</desc>
1568	</param>
1569	<param name="trunkType" type="wstring" dir="in">
1570	<desc>
1571	Type of internal network trunk.
1572	</desc>
1573	</param>
1574	</method>
1575
1576	<method name="stop">
1577	<desc>
1578	Stops DHCP server process.
1579	<result name="E_FAIL">
1580	Failed to stop the process.
1581	</result>
1582	</desc>
1583	</method>
1584	</interface>
1585
1586	<interface
1587	name="IVirtualBox" extends="$dispatched"
1588	uuid="c1b8d85d-8f44-4314-94fc-072332bdf852"
1589	wsmap="managed"
1590	>
1591	<desc>
1592	The IVirtualBox interface represents the main interface exposed by the
1593	product that provides virtual machine management.
1594
1595	An instance of IVirtualBox is required for the product to do anything
1596	useful. Even though the interface does not expose this, internally,
1597	IVirtualBox is implemented as a singleton and actually lives in the
1598	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1599	IVirtualBox can track the state of all virtual machines on a particular
1600	host, regardless of which frontend started them.
1601
1602	To enumerate all the virtual machines on the host, use the
1603	<link to="IVirtualBox::machines"/> attribute.
1604	</desc>
1605
1606	<attribute name="version" type="wstring" readonly="yes">
1607	<desc>
1608	A string representing the version number of the product. The
1609	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1610	last number represents the build number and will frequently change.
1611	</desc>
1612	</attribute>
1613
1614	<attribute name="revision" type="unsigned long" readonly="yes">
1615	<desc>
1616	The internal build revision number of the product.
1617	</desc>
1618	</attribute>
1619
1620	<attribute name="packageType" type="wstring" readonly="yes">
1621	<desc>
1622	A string representing the package type of this product. The
1623	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1624	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1625	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1626	this.
1627	</desc>
1628	</attribute>
1629
1630	<attribute name="homeFolder" type="wstring" readonly="yes">
1631	<desc>
1632	Full path to the directory where the global settings file,
1633	<tt>VirtualBox.xml</tt>, is stored.
1634
1635	In this version of VirtualBox, the value of this property is
1636	always <tt><user_dir>/.VirtualBox</tt> (where
1637	<tt><user_dir></tt> is the path to the user directory,
1638	as determined by the host OS), and cannot be changed.
1639
1640	This path is also used as the base to resolve relative paths in
1641	places where relative paths are allowed (unless otherwise
1642	expressly indicated).
1643	</desc>
1644	</attribute>
1645
1646	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1647	<desc>
1648	Full name of the global settings file.
1649	The value of this property corresponds to the value of
1650	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1651	</desc>
1652	</attribute>
1653
1654	<attribute name="host" type="IHost" readonly="yes">
1655	<desc>Associated host object.</desc>
1656	</attribute>
1657
1658	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1659	<desc>Associated system information object.</desc>
1660	</attribute>
1661
1662	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1663	<desc>
1664	Array of machine objects registered within this VirtualBox instance.
1665	</desc>
1666	</attribute>
1667
1668	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1669	<desc>
1670	Array of medium objects known to this VirtualBox installation.
1671
1672	This array contains only base media. All differencing
1673	media of the given base medium can be enumerated using
1674	<link to="IMedium::children"/>.
1675	</desc>
1676	</attribute>
1677
1678	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1679	<desc>
1680	Array of CD/DVD image objects registered with this VirtualBox instance.
1681	</desc>
1682	</attribute>
1683
1684	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1685	<desc>
1686	Array of floppy image objects registered with this VirtualBox instance.
1687	</desc>
1688	</attribute>
1689
1690	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1691
1692	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1693
1694	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1695	<desc>
1696	Collection of global shared folders. Global shared folders are
1697	available to all virtual machines.
1698
1699	New shared folders are added to the collection using
1700	<link to="#createSharedFolder"/>. Existing shared folders can be
1701	removed using <link to="#removeSharedFolder"/>.
1702
1703	<note>
1704	In the current version of the product, global shared folders are not
1705	implemented and therefore this collection is always empty.
1706	</note>
1707	</desc>
1708	</attribute>
1709
1710	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1711	<desc>
1712	Associated performance collector object.
1713	</desc>
1714	</attribute>
1715
1716	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1717	<desc>
1718	dhcp server settings.
1719	</desc>
1720	</attribute>
1721
1722	<method name="createMachine">
1723	<desc>
1724	Creates a new virtual machine.
1725
1726	The new machine is created unregistered, with the initial configuration
1727	set according to the specified guest OS type. A typical sequence of
1728	actions to create a new virtual machine is as follows:
1729
1730	<ol>
1731	<li>
1732	Call this method to have a new machine created. The returned machine
1733	object will be "mutable" allowing to change any machine property.
1734	</li>
1735
1736	<li>
1737	Configure the machine using the appropriate attributes and methods.
1738	</li>
1739
1740	<li>
1741	Call <link to="IMachine::saveSettings" /> to write the settings
1742	to the machine's XML settings file. The configuration of the newly
1743	created machine will not be saved to disk until this method is
1744	called.
1745	</li>
1746
1747	<li>
1748	Call <link to="#registerMachine" /> to add the machine to the list
1749	of machines known to VirtualBox.
1750	</li>
1751	</ol>
1752
1753	You should specify valid name for the newly created machine when calling
1754	this method. See the <link to="IMachine::name"/> attribute description
1755	for more details about the machine name.
1756
1757	The specified guest OS type identifier must match an ID of one of known
1758	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1759	array.
1760
1761	Every machine has a <i>settings file</i> that is used to store
1762	the machine configuration. This file is stored in a directory called the
1763	<i>machine settings subfolder</i>. Both the settings subfolder and file
1764	will have a name that corresponds to the name of the virtual machine.
1765	You can specify where to create the machine setting subfolder using the
1766	@a baseFolder argument. The base folder can be absolute (full path) or
1767	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1768	directory</link>.
1769
1770	If @a baseFolder is a @c null or empty string (which is recommended), the
1771	<link to="ISystemProperties::defaultMachineFolder">default machine
1772	settings folder</link> will be used as a base folder for the created
1773	machine. Otherwise the given base folder will be used. In either case,
1774	the full path to the resulting settings file has the following
1775	structure:
1776	<pre>
1777	<base_folder>/<machine_name>/<machine_name>.xml
1778	</pre>
1779
1780	Note that if the resulting settings file already exists, this method
1781	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1782
1783	Optionally, you may specify an UUID of to assign to the created machine.
1784	However, this is not recommended and you should normally pass an empty
1785	(@c null) UUID to this method so that a new UUID will be automatically
1786	generated for every created machine. You can use UUID
1787	00000000-0000-0000-0000-000000000000 as @c null value.
1788
1789	<note>
1790	There is no way to change the name of the settings file or
1791	subfolder of the created machine directly.
1792	</note>
1793
1794	<result name="VBOX_E_OBJECT_NOT_FOUND">
1795	@a osTypeId is invalid.
1796	</result>
1797	<result name="VBOX_E_FILE_ERROR">
1798	Resulting settings file name is invalid or the settings file already
1799	exists or could not be created due to an I/O error.
1800	</result>
1801	<result name="E_INVALIDARG">
1802	@a name is empty or @c null.
1803	</result>
1804	</desc>
1805
1806	<param name="name" type="wstring" dir="in">
1807	<desc>Machine name.</desc>
1808	</param>
1809	<param name="osTypeId" type="wstring" dir="in">
1810	<desc>Guest OS Type ID.</desc>
1811	</param>
1812	<param name="baseFolder" type="wstring" dir="in">
1813	<desc>Base machine folder (optional).</desc>
1814	</param>
1815	<param name="id" type="uuid" mod="string" dir="in">
1816	<desc>Machine UUID (optional).</desc>
1817	</param>
1818	<param name="machine" type="IMachine" dir="return">
1819	<desc>Created machine object.</desc>
1820	</param>
1821	</method>
1822
1823	<method name="createLegacyMachine">
1824	<desc>
1825	Creates a new virtual machine in "legacy" mode, using the specified
1826	settings file to store machine settings.
1827
1828	As opposed to machines created by <link to="#createMachine"/>,
1829	the settings file of the machine created in "legacy" mode is not
1830	automatically renamed when the machine name is changed -- it will always
1831	remain the same as specified in this method call.
1832
1833	The specified settings file name can be absolute (full path) or relative
1834	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1835	directory</link>. If the file name doesn't contain an extension, the
1836	default extension (.xml) will be appended.
1837
1838	Note that the configuration of the newly created machine is not
1839	saved to disk (and therefore no settings file is created)
1840	until <link to="IMachine::saveSettings"/> is called. If the
1841	specified settings file already exists, this method
1842	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1843
1844	See <link to="#createMachine"/> for more information.
1845
1846	@deprecated This method may be removed later. Use <link
1847	to="IVirtualBox::createMachine"/> instead.
1848
1849	<note>
1850	There is no way to change the name of the settings file
1851	of the machine created in "legacy" mode.
1852	</note>
1853
1854	<result name="VBOX_E_OBJECT_NOT_FOUND">
1855	@a osTypeId is invalid.
1856	</result>
1857	<result name="VBOX_E_FILE_ERROR">
1858	@a settingsFile is invalid or the settings file already exists or
1859	could not be created due to an I/O error.
1860	</result>
1861	<result name="E_INVALIDARG">
1862	@a name or @a settingsFile is empty or @c null.
1863	</result>
1864	</desc>
1865
1866	<param name="name" type="wstring" dir="in">
1867	<desc>Machine name.</desc>
1868	</param>
1869	<param name="osTypeId" type="wstring" dir="in">
1870	<desc>Machine OS Type ID.</desc>
1871	</param>
1872	<param name="settingsFile" type="wstring" dir="in">
1873	<desc>Name of the machine settings file.</desc>
1874	</param>
1875	<param name="id" type="uuid" mod="string" dir="in">
1876	<desc>Machine UUID (optional).</desc>
1877	</param>
1878	<param name="machine" type="IMachine" dir="return">
1879	<desc>Created machine object.</desc>
1880	</param>
1881	</method>
1882
1883	<method name="openMachine">
1884	<desc>
1885	Opens a virtual machine from the existing settings file.
1886	The opened machine remains unregistered until you call
1887	<link to="#registerMachine"/>.
1888
1889	The specified settings file name can be absolute
1890	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1891	VirtualBox home directory</link>. This file must exist
1892	and must be a valid machine settings file whose contents
1893	will be used to construct the machine object.
1894
1895	@deprecated Will be removed soon.
1896	<result name="VBOX_E_FILE_ERROR">
1897	Settings file name invalid, not found or sharing violation.
1898	</result>
1899	</desc>
1900	<param name="settingsFile" type="wstring" dir="in">
1901	<desc>
1902	Name of the machine settings file.
1903	</desc>
1904	</param>
1905	<param name="machine" type="IMachine" dir="return">
1906	<desc>Opened machine object.</desc>
1907	</param>
1908	<note>
1909	<link to="IMachine::settingsModified"/> will return
1910	@c false for the created machine, until any of machine settings
1911	are changed.
1912	</note>
1913	</method>
1914
1915	<method name="registerMachine">
1916	<desc>
1917
1918	Registers the machine previously created using
1919	<link to="#createMachine"/> or opened using
1920	<link to="#openMachine"/> within this VirtualBox installation. After
1921	successful method invocation, the
1922	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1923	to all registered callbacks.
1924
1925	<note>
1926	This method implicitly calls <link to="IMachine::saveSettings"/>
1927	to save all current machine settings before registering it.
1928	</note>
1929
1930	<result name="VBOX_E_OBJECT_NOT_FOUND">
1931	No matching virtual machine found.
1932	</result>
1933	<result name="VBOX_E_INVALID_OBJECT_STATE">
1934	Virtual machine was not created within this VirtualBox instance.
1935	</result>
1936
1937	</desc>
1938	<param name="machine" type="IMachine" dir="in"/>
1939	</method>
1940
1941	<method name="getMachine">
1942	<desc>
1943	Attempts to find a virtual machine given its UUID.
1944	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1945	instead.
1946
1947	<result name="VBOX_E_OBJECT_NOT_FOUND">
1948	Could not find registered machine matching @a id.
1949	</result>
1950
1951	</desc>
1952	<param name="id" type="uuid" mod="string" dir="in"/>
1953	<param name="machine" type="IMachine" dir="return"/>
1954	</method>
1955
1956	<method name="findMachine">
1957	<desc>
1958	Attempts to find a virtual machine given its name.
1959	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1960	instead.
1961
1962	<result name="VBOX_E_OBJECT_NOT_FOUND">
1963	Could not find registered machine matching @a name.
1964	</result>
1965
1966	</desc>
1967	<param name="name" type="wstring" dir="in"/>
1968	<param name="machine" type="IMachine" dir="return"/>
1969	</method>
1970
1971	<method name="unregisterMachine">
1972	<desc>
1973
1974	Unregisters the machine previously registered using
1975	<link to="#registerMachine"/>. After successful method invocation, the
1976	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1977	to all registered callbacks.
1978
1979	<note>
1980	The specified machine must not be in the Saved state, have an open
1981	(or a spawning) direct session associated with it, have snapshots or
1982	have any medium attached.
1983	</note>
1984
1985	<note>
1986	This method implicitly calls <link to="IMachine::saveSettings"/> to
1987	save all current machine settings before unregistering it.
1988	</note>
1989
1990	<note>
1991	If the given machine is inaccessible (see
1992	<link to="IMachine::accessible"/>), it will be unregistered and
1993	fully uninitialized right afterwards. As a result, the returned
1994	machine object will be unusable and an attempt to call
1995	<b>any</b> method will return the "Object not ready" error.
1996	</note>
1997
1998	<result name="VBOX_E_OBJECT_NOT_FOUND">
1999	Could not find registered machine matching @a id.
2000	</result>
2001	<result name="VBOX_E_INVALID_VM_STATE">
2002	Machine is in Saved state.
2003	</result>
2004	<result name="VBOX_E_INVALID_OBJECT_STATE">
2005	Machine has snapshot or open session or medium attached.
2006	</result>
2007
2008	</desc>
2009	<param name="id" type="uuid" mod="string" dir="in">
2010	<desc>UUID of the machine to unregister.</desc>
2011	</param>
2012	<param name="machine" type="IMachine" dir="return">
2013	<desc>Unregistered machine object.</desc>
2014	</param>
2015	</method>
2016
2017	<method name="createAppliance">
2018	<desc>
2019	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2020	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2021	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2022	</desc>
2023	<param name="appliance" type="IAppliance" dir="return">
2024	<desc>New appliance.</desc>
2025	</param>
2026	</method>
2027
2028	<method name="createHardDisk">
2029	<desc>
2030	Creates a new base medium object that will use the given storage
2031	format and location for medium data.
2032
2033	Note that the actual storage unit is not created by this method. In
2034	order to do it, and before you are able to attach the created medium
2035	to virtual machines, you must call one of the following methods to
2036	allocate a format-specific storage unit at the specified location:
2037	<ul>
2038	<li><link to="IMedium::createBaseStorage"/></li>
2039	<li><link to="IMedium::createDiffStorage"/></li>
2040	</ul>
2041
2042	Some medium attributes, such as <link to="IMedium::id"/>, may
2043	remain uninitialized until the medium storage unit is successfully
2044	created by one of the above methods.
2045
2046	After the storage unit is successfully created, the medium gets
2047	remembered by this VirtualBox installation and will be accessible
2048	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
2049	methods. Remembered base medium are also returned as part of
2050	the <link to="#hardDisks"/> array. See IMedium for more details.
2051
2052	The list of all storage formats supported by this VirtualBox
2053	installation can be obtained using
2054	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2055	attribute is empty or @c null then the default storage format
2056	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2057	be used for creating a storage unit of the medium.
2058
2059	Note that the format of the location string is storage format specific.
2060	See <link to="IMedium::location"/>, IMedium and
2061	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2062
2063	<result name="VBOX_E_OBJECT_NOT_FOUND">
2064	@a format identifier is invalid. See
2065	<link to="ISystemProperties::mediumFormats"/>.
2066	</result>
2067	<result name="VBOX_E_FILE_ERROR">
2068	@a location is a not valid file name (for file-based formats only).
2069	</result>
2070	</desc>
2071	<param name="format" type="wstring" dir="in">
2072	<desc>
2073	Identifier of the storage format to use for the new medium.
2074	</desc>
2075	</param>
2076	<param name="location" type="wstring" dir="in">
2077	<desc>
2078	Location of the storage unit for the new medium.
2079	</desc>
2080	</param>
2081	<param name="medium" type="IMedium" dir="return">
2082	<desc>Created medium object.</desc>
2083	</param>
2084	</method>
2085
2086	<method name="openHardDisk">
2087	<desc>
2088	Opens a medium from an existing location, optionally replacing
2089	the image UUID and/or parent UUID.
2090
2091	After the medium is successfully opened by this method, it gets
2092	remembered by (known to) this VirtualBox installation and will be
2093	accessible through <link to="#getHardDisk"/> and
2094	<link to="#findHardDisk"/> methods. Remembered base media
2095	are also returned as part of the <link to="#hardDisks"/> array and can
2096	be attached to virtual machines. See IMedium for more details.
2097
2098	If a differencing medium is to be opened by this method, the
2099	operation will succeed only if its parent medium and all ancestors,
2100	if any, are already known to this VirtualBox installation (for example,
2101	were opened by this method before).
2102
2103	This method tries to guess the storage format of the specified medium
2104	by reading medium data at the specified location.
2105
2106	If @a write is ReadWrite (which it should be), the image is opened for
2107	read/write access and must have according permissions, as VirtualBox
2108	may actually write status information into the disk's metadata sections.
2109
2110	Note that write access is required for all typical image usage in VirtualBox,
2111	since VirtualBox may need to write metadata such as a UUID into the image.
2112	The only exception is opening a source image temporarily for copying and
2113	cloning when the image will quickly be closed again.
2114
2115	Note that the format of the location string is storage format specific.
2116	See <link to="IMedium::location"/>, IMedium and
2117	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
2118
2119	<result name="VBOX_E_FILE_ERROR">
2120	Invalid medium storage file location or could not find the medium
2121	at the specified location.
2122	</result>
2123	<result name="VBOX_E_IPRT_ERROR">
2124	Could not get medium storage format.
2125	</result>
2126	<result name="E_INVALIDARG">
2127	Invalid medium storage format.
2128	</result>
2129
2130	</desc>
2131	<param name="location" type="wstring" dir="in">
2132	<desc>
2133	Location of the storage unit that contains medium data in one of
2134	the supported storage formats.
2135	</desc>
2136	</param>
2137	<param name="accessMode" type="AccessMode" dir="in">
2138	<desc>
2139	Determines whether to open the image in read/write or read-only mode.
2140	</desc>
2141	</param>
2142	<param name="setImageId" type="boolean" dir="in">
2143	<desc>
2144	Select whether a new image UUID is set or not.
2145	</desc>
2146	</param>
2147	<param name="imageId" type="uuid" mod="string" dir="in">
2148	<desc>
2149	New UUID for the image. If an empty string is passed, then a new
2150	UUID is automatically created. Specifying a zero UUIDs is not valid.
2151	</desc>
2152	</param>
2153	<param name="setParentId" type="boolean" dir="in">
2154	<desc>
2155	Select whether a new parent UUID is set or not.
2156	</desc>
2157	</param>
2158	<param name="parentId" type="uuid" mod="string" dir="in">
2159	<desc>
2160	New parent UUID for the image. If an empty string is passed, then a
2161	new UUID is automatically created, provided @a setParentId is
2162	@c true. A zero UUID is valid.
2163	</desc>
2164	</param>
2165	<param name="medium" type="IMedium" dir="return">
2166	<desc>Opened medium object.</desc>
2167	</param>
2168	</method>
2169
2170	<method name="getHardDisk" const="yes">
2171	<desc>
2172	Returns a medium with the given UUID.
2173
2174	The medium with the given UUID must be known to this VirtualBox
2175	installation, i.e. it must be previously created by
2176	<link to="#createHardDisk"/> or opened by <link
2177	to="#openHardDisk"/>, or attached to some known virtual machine.
2178
2179	<result name="VBOX_E_OBJECT_NOT_FOUND">
2180	No medium object matching @a id found.
2181	</result>
2182
2183	</desc>
2184	<param name="id" type="uuid" mod="string" dir="in">
2185	<desc>UUID of the medium to look for.</desc>
2186	</param>
2187	<param name="medium" type="IMedium" dir="return">
2188	<desc>Found medium object.</desc>
2189	</param>
2190	</method>
2191
2192	<method name="findHardDisk">
2193	<desc>
2194	Returns a medium that uses the given location to store medium data.
2195
2196	The given medium must be known to this VirtualBox installation, i.e.
2197	it must be previously created by
2198	<link to="#createHardDisk"/> or opened by <link
2199	to="#openHardDisk"/>, or attached to some known virtual machine.
2200
2201	The search is done by comparing the value of the @a location argument to
2202	the <link to="IMedium::location"/> attribute of each known medium.
2203
2204	For locations represented by file names in the host's file system, the
2205	requested location can be a path relative to the
2206	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2207	only a file name without any path is given, the
2208	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2209	folder</link> will be prepended to the file name before searching. Note
2210	that on case sensitive file systems, a case sensitive comparison is
2211	performed, otherwise the case of symbols in the file path is ignored.
2212
2213	<result name="VBOX_E_OBJECT_NOT_FOUND">
2214	No medium object matching @a location found.
2215	</result>
2216
2217	</desc>
2218	<param name="location" type="wstring" dir="in">
2219	<desc>Location string to search for.</desc>
2220	</param>
2221	<param name="medium" type="IMedium" dir="return">
2222	<desc>Found medium object.</desc>
2223	</param>
2224	</method>
2225
2226	<method name="openDVDImage">
2227	<desc>
2228	Opens a CD/DVD image contained in the specified file of the supported
2229	format and assigns it the given UUID.
2230
2231	After the image is successfully opened by this method, it gets
2232	remembered by (known to) this VirtualBox installation and will be
2233	accessible through <link to="#getDVDImage"/> and
2234	<link to="#findDVDImage"/> methods. Remembered images are also
2235	returned as part of the <link to="#DVDImages"/> array and can be mounted
2236	to virtual machines. See IMedium for more details.
2237
2238	See <link to="IMedium::location"/> to get more details about the format
2239	of the location string.
2240
2241	<note>
2242	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2243	</note>
2244
2245	<result name="VBOX_E_FILE_ERROR">
2246	Invalid CD/DVD image file location or could not find the CD/DVD
2247	image at the specified location.
2248	</result>
2249	<result name="VBOX_E_INVALID_OBJECT_STATE">
2250	CD/DVD image already exists in the media registry.
2251	</result>
2252
2253	</desc>
2254	<param name="location" type="wstring" dir="in">
2255	<desc>
2256	Full path to the file that contains a valid CD/DVD image.
2257	</desc>
2258	</param>
2259	<param name="id" type="uuid" mod="string" dir="in">
2260	<desc>
2261	UUID to assign to the given image within this VirtualBox installation.
2262	If an empty (@c null) UUID is specified, the system will randomly
2263	generate a new UUID.
2264	</desc>
2265	</param>
2266	<param name="image" type="IMedium" dir="return">
2267	<desc>Opened CD/DVD image object.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="getDVDImage">
2272	<desc>
2273	Returns a CD/DVD image with the given UUID.
2274
2275	The image with the given UUID must be known to this VirtualBox
2276	installation, i.e. it must be previously opened by <link
2277	to="#openDVDImage"/>, or mounted to some known virtual machine.
2278
2279	<result name="VBOX_E_OBJECT_NOT_FOUND">
2280	No matching DVD image found in the media registry.
2281	</result>
2282
2283	</desc>
2284	<param name="id" type="uuid" mod="string" dir="in">
2285	<desc>UUID of the image to look for.</desc>
2286	</param>
2287	<param name="image" type="IMedium" dir="return">
2288	<desc>Found CD/DVD image object.</desc>
2289	</param>
2290	</method>
2291
2292	<method name="findDVDImage">
2293	<desc>
2294	Returns a CD/DVD image with the given image location.
2295
2296	The image with the given UUID must be known to this VirtualBox
2297	installation, i.e. it must be previously opened by <link
2298	to="#openDVDImage"/>, or mounted to some known virtual machine.
2299
2300	The search is done by comparing the value of the @a location argument to
2301	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2302
2303	The requested location can be a path relative to the
2304	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2305	only a file name without any path is given, the
2306	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2307	folder</link> will be prepended to the file name before searching. Note
2308	that on case sensitive file systems, a case sensitive comparison is
2309	performed, otherwise the case in the file path is ignored.
2310
2311	<result name="VBOX_E_FILE_ERROR">
2312	Invalid image file location.
2313	</result>
2314	<result name="VBOX_E_OBJECT_NOT_FOUND">
2315	No matching DVD image found in the media registry.
2316	</result>
2317
2318	</desc>
2319	<param name="location" type="wstring" dir="in">
2320	<desc>CD/DVD image file path to look for.</desc>
2321	</param>
2322	<param name="image" type="IMedium" dir="return">
2323	<desc>Found CD/DVD image object.</desc>
2324	</param>
2325	</method>
2326
2327	<method name="openFloppyImage">
2328	<desc>
2329	Opens a floppy image contained in the specified file of the supported
2330	format and assigns it the given UUID.
2331
2332	After the image is successfully opened by this method, it gets
2333	remembered by (known to) this VirtualBox installation and will be
2334	accessible through <link to="#getFloppyImage"/> and
2335	<link to="#findFloppyImage"/> methods. Remembered images are also
2336	returned as part of the <link to="#floppyImages"/> array and can be
2337	mounted to virtual machines. See IMedium for more details.
2338
2339	See <link to="IMedium::location"/> to get more details about the format
2340	of the location string.
2341
2342	<result name="VBOX_E_FILE_ERROR">
2343	Invalid floppy image file location or could not find the floppy
2344	image at the specified location.
2345	</result>
2346	<result name="VBOX_E_INVALID_OBJECT_STATE">
2347	Floppy image already exists in the media registry.
2348	</result>
2349
2350	<note>
2351	Currently, only raw floppy images are supported by VirtualBox.
2352	</note>
2353	</desc>
2354	<param name="location" type="wstring" dir="in">
2355	<desc>
2356	Full path to the file that contains a valid floppy image.
2357	</desc>
2358	</param>
2359	<param name="id" type="uuid" mod="string" dir="in">
2360	<desc>
2361	UUID to assign to the given image file within this VirtualBox
2362	installation. If an empty (@c null) UUID is specified, the system will
2363	randomly generate a new UUID.
2364	</desc>
2365	</param>
2366	<param name="image" type="IMedium" dir="return">
2367	<desc>Opened floppy image object.</desc>
2368	</param>
2369	</method>
2370
2371	<method name="getFloppyImage">
2372	<desc>
2373	Returns a floppy image with the given UUID.
2374
2375	The image with the given UUID must be known to this VirtualBox
2376	installation, i.e. it must be previously opened by <link
2377	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2378
2379	<result name="VBOX_E_OBJECT_NOT_FOUND">
2380	No matching floppy image found in the media registry.
2381	</result>
2382
2383	</desc>
2384	<param name="id" type="uuid" mod="string" dir="in">
2385	<desc>UUID of the image to look for.</desc>
2386	</param>
2387	<param name="image" type="IMedium" dir="return">
2388	<desc>Found floppy image object.</desc>
2389	</param>
2390	</method>
2391
2392	<method name="findFloppyImage">
2393	<desc>
2394	Returns a floppy image with the given image location.
2395
2396	The image with the given UUID must be known to this VirtualBox
2397	installation, i.e. it must be previously opened by <link
2398	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2399
2400	The search is done by comparing the value of the @a location argument to
2401	the <link to="IMedium::location"/> attribute of each known floppy image.
2402
2403	The requested location can be a path relative to the
2404	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2405	only a file name without any path is given, the
2406	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2407	folder</link> will be prepended to the file name before searching. Note
2408	that on case sensitive file systems, a case sensitive comparison is
2409	performed, otherwise the case of symbols in the file path is ignored.
2410
2411	<result name="VBOX_E_FILE_ERROR">
2412	Invalid image file location.
2413	</result>
2414	<result name="VBOX_E_OBJECT_NOT_FOUND">
2415	No matching floppy image found in the media registry.
2416	</result>
2417
2418	</desc>
2419	<param name="location" type="wstring" dir="in">
2420	<desc>Floppy image file path to look for.</desc>
2421	</param>
2422	<param name="image" type="IMedium" dir="return">
2423	<desc>Found floppy image object.</desc>
2424	</param>
2425	</method>
2426
2427	<method name="getGuestOSType">
2428	<desc>
2429	Returns an object describing the specified guest OS type.
2430
2431	The requested guest OS type is specified using a string which is a
2432	mnemonic identifier of the guest operating system, such as
2433	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2434	particular virtual machine can be read or set using the
2435	<link to="IMachine::OSTypeId"/> attribute.
2436
2437	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2438	available guest OS type objects. Each object has an
2439	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2440	the guest OS this object describes.
2441
2442	<result name="E_INVALIDARG">
2443	@a id is not a valid Guest OS type.
2444	</result>
2445
2446	</desc>
2447	<param name="id" type="uuid" mod="string" dir="in">
2448	<desc>Guest OS type ID string.</desc>
2449	</param>
2450	<param name="type" type="IGuestOSType" dir="return">
2451	<desc>Guest OS type object.</desc>
2452	</param>
2453	</method>
2454
2455	<method name="createSharedFolder">
2456	<desc>
2457	Creates a new global shared folder by associating the given logical
2458	name with the given host path, adds it to the collection of shared
2459	folders and starts sharing it. Refer to the description of
2460	<link to="ISharedFolder"/> to read more about logical names.
2461	<note>
2462	In the current implementation, this operation is not
2463	implemented.
2464	</note>
2465	</desc>
2466	<param name="name" type="wstring" dir="in">
2467	<desc>Unique logical name of the shared folder.</desc>
2468	</param>
2469	<param name="hostPath" type="wstring" dir="in">
2470	<desc>Full path to the shared folder in the host file system.</desc>
2471	</param>
2472	<param name="writable" type="boolean" dir="in">
2473	<desc>Whether the share is writable or readonly</desc>
2474	</param>
2475	</method>
2476
2477	<method name="removeSharedFolder">
2478	<desc>
2479	Removes the global shared folder with the given name previously
2480	created by <link to="#createSharedFolder"/> from the collection of
2481	shared folders and stops sharing it.
2482	<note>
2483	In the current implementation, this operation is not
2484	implemented.
2485	</note>
2486	</desc>
2487	<param name="name" type="wstring" dir="in">
2488	<desc>Logical name of the shared folder to remove.</desc>
2489	</param>
2490	</method>
2491
2492	<method name="getExtraDataKeys">
2493	<desc>
2494	Returns an array representing the global extra data keys which currently
2495	have values defined.
2496	</desc>
2497	<param name="value" type="wstring" dir="return" safearray="yes">
2498	<desc>Array of extra data keys.</desc>
2499	</param>
2500	</method>
2501
2502	<method name="getExtraData">
2503	<desc>
2504	Returns associated global extra data.
2505
2506	If the requested data @a key does not exist, this function will
2507	succeed and return an empty string in the @a value argument.
2508
2509	<result name="VBOX_E_FILE_ERROR">
2510	Settings file not accessible.
2511	</result>
2512	<result name="VBOX_E_XML_ERROR">
2513	Could not parse the settings file.
2514	</result>
2515
2516	</desc>
2517	<param name="key" type="wstring" dir="in">
2518	<desc>Name of the data key to get.</desc>
2519	</param>
2520	<param name="value" type="wstring" dir="return">
2521	<desc>Value of the requested data key.</desc>
2522	</param>
2523	</method>
2524
2525	<method name="setExtraData">
2526	<desc>
2527	Sets associated global extra data.
2528
2529	If you pass @c null or empty string as a key @a value, the given @a key
2530	will be deleted.
2531
2532	<note>
2533	Before performing the actual data change, this method will ask all
2534	registered callbacks using the
2535	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2536	notification for a permission. If one of the callbacks refuses the
2537	new value, the change will not be performed.
2538	</note>
2539	<note>
2540	On success, the
2541	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2542	is called to inform all registered callbacks about a successful data
2543	change.
2544	</note>
2545
2546	<result name="VBOX_E_FILE_ERROR">
2547	Settings file not accessible.
2548	</result>
2549	<result name="VBOX_E_XML_ERROR">
2550	Could not parse the settings file.
2551	</result>
2552	<result name="E_ACCESSDENIED">
2553	Modification request refused.
2554	</result>
2555
2556	</desc>
2557	<param name="key" type="wstring" dir="in">
2558	<desc>Name of the data key to set.</desc>
2559	</param>
2560	<param name="value" type="wstring" dir="in">
2561	<desc>Value to assign to the key.</desc>
2562	</param>
2563	</method>
2564
2565	<method name="openSession">
2566	<desc>
2567	Opens a new direct session with the given virtual machine.
2568
2569	A direct session acts as a local lock on the given VM.
2570	There can be only one direct session open at a time for every
2571	virtual machine, protecting the VM from being manipulated by
2572	conflicting actions from different processes. Only after a
2573	direct session has been opened, one can change all VM settings
2574	and execute the VM in the process space of the session object.
2575
2576	Sessions therefore can be compared to mutex semaphores that
2577	lock a given VM for modification and execution.
2578	See <link to="ISession">ISession</link> for details.
2579
2580	<note>Unless you are writing a new VM frontend, you will not
2581	want to execute a VM in the current process. To spawn a new
2582	process that executes a VM, use
2583	<link to="IVirtualBox::openRemoteSession" />
2584	instead.</note>
2585
2586	Upon successful return, the session object can be used to
2587	get access to the machine and to the VM console.
2588
2589	In VirtualBox terminology, the machine becomes "mutable" after
2590	a session has been opened. Note that the "mutable" machine
2591	object, on which you may invoke IMachine methods to change its
2592	settings, will be a different object from the immutable IMachine
2593	objects returned by various IVirtualBox methods. To obtain a
2594	mutable IMachine object (upon which you can invoke settings methods),
2595	use the <link to="ISession::machine" /> attribute.
2596
2597	One must always call <link to="ISession::close" /> to release the
2598	lock on the machine, or the machine's state will eventually be
2599	set to "Aborted".
2600
2601	In other words, to change settings on a machine, the following
2602	sequence is typically performed:
2603
2604	<ol>
2605	<li>Call this method (openSession) to have a machine locked for
2606	the current session.</li>
2607
2608	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2609
2610	<li>Change the settings of the machine.</li>
2611
2612	<li>Call <link to="IMachine::saveSettings" />.</li>
2613
2614	<li>Close the session by calling <link to="ISession::close"/>.</li>
2615	</ol>
2616
2617	<result name="E_UNEXPECTED">
2618	Virtual machine not registered.
2619	</result>
2620	<result name="E_ACCESSDENIED">
2621	Process not started by OpenRemoteSession.
2622	</result>
2623	<result name="VBOX_E_OBJECT_NOT_FOUND">
2624	No matching virtual machine found.
2625	</result>
2626	<result name="VBOX_E_INVALID_OBJECT_STATE">
2627	Session already open or being opened.
2628	</result>
2629	<result name="VBOX_E_VM_ERROR">
2630	Failed to assign machine to session.
2631	</result>
2632
2633	</desc>
2634	<param name="session" type="ISession" dir="in">
2635	<desc>
2636	Session object that will represent the opened session after
2637	successful method invocation. This object must not represent
2638	the already open session.
2639	<note>
2640	This session will be automatically closed if the
2641	VirtualBox server is terminated for some reason.
2642	</note>
2643	</desc>
2644	</param>
2645	<param name="machineId" type="uuid" mod="string" dir="in">
2646	<desc>ID of the virtual machine to open a session with.</desc>
2647	</param>
2648	</method>
2649
2650	<method name="openRemoteSession">
2651	<desc>
2652	Spawns a new process that executes a virtual machine (called a
2653	"remote session").
2654
2655	Opening a remote session causes the VirtualBox server to start a new
2656	process that opens a direct session with the given VM. As a result, the
2657	VM is locked by that direct session in the new process, preventing
2658	conflicting changes from other processes. Since sessions act as locks
2659	that prevent conflicting changes, one cannot open a remote session
2660	for a VM that already has another open session (direct or remote), or
2661	is currently in the process of opening one (see <link
2662	to="IMachine::sessionState"/>).
2663
2664	While the remote session still provides some level of control over the
2665	VM execution to the caller (using the <link to="IConsole" /> interface),
2666	not all VM settings are available for modification within the remote
2667	session context.
2668
2669	This operation can take some time (a new VM is started in a new process,
2670	for which memory and other resources need to be set up). Because of this,
2671	an <link to="IProgress" /> is returned to allow the caller to wait for this
2672	asynchronous operation to be completed. Until then, the remote session
2673	object remains in the closed state, and accessing the machine or its
2674	console through it is invalid. It is recommended to use
2675	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2676	completion.
2677
2678	As with all <link to="ISession" /> objects, it is recommended to call
2679	<link to="ISession::close" /> on the local session object once openRemoteSession()
2680	has been called. However, the session's state (see <link to="ISession::state" />)
2681	will not return to "Closed" until the remote session has also closed (i.e.
2682	until the VM is no longer running). In that case, however, the state of
2683	the session will automatically change back to "Closed".
2684
2685	Currently supported session types (values of the @a type
2686	argument) are:
2687	<ul>
2688	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2689	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2690	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2691	</ul>
2692
2693	The @a environment argument is a string containing definitions of
2694	environment variables in the following format:
2695	@code
2696	NAME[=VALUE]\n
2697	NAME[=VALUE]\n
2698	...
2699	@endcode
2700	where <tt>\\n</tt> is the new line character. These environment
2701	variables will be appended to the environment of the VirtualBox server
2702	process. If an environment variable exists both in the server process
2703	and in this list, the value from this list takes precedence over the
2704	server's variable. If the value of the environment variable is
2705	omitted, this variable will be removed from the resulting environment.
2706	If the environment string is @c null or empty, the server environment
2707	is inherited by the started process as is.
2708
2709	<see>openExistingSession</see>
2710
2711	<result name="E_UNEXPECTED">
2712	Virtual machine not registered.
2713	</result>
2714	<result name="E_INVALIDARG">
2715	Invalid session type @a type.
2716	</result>
2717	<result name="VBOX_E_OBJECT_NOT_FOUND">
2718	No machine matching @a machineId found.
2719	</result>
2720	<result name="VBOX_E_INVALID_OBJECT_STATE">
2721	Session already open or being opened.
2722	</result>
2723	<result name="VBOX_E_IPRT_ERROR">
2724	Launching process for machine failed.
2725	</result>
2726	<result name="VBOX_E_VM_ERROR">
2727	Failed to assign machine to session.
2728	</result>
2729
2730	</desc>
2731	<param name="session" type="ISession" dir="in">
2732	<desc>
2733	Session object that will represent the opened remote session
2734	after successful method invocation (this object must not
2735	represent an already open session).
2736	</desc>
2737	</param>
2738	<param name="machineId" type="uuid" mod="string" dir="in">
2739	<desc>ID of the virtual machine to open a session with.</desc>
2740	</param>
2741	<param name="type" type="wstring" dir="in">
2742	<desc>
2743	Type of the remote session (case sensitive).
2744	</desc>
2745	</param>
2746	<param name="environment" type="wstring" dir="in">
2747	<desc>
2748	Environment to pass to the opened session.
2749	</desc>
2750	</param>
2751	<param name="progress" type="IProgress" dir="return">
2752	<desc>Progress object to track the operation completion.</desc>
2753	</param>
2754	</method>
2755
2756	<method name="openExistingSession">
2757	<desc>
2758	Opens a new remote session with the virtual machine for
2759	which a direct session is already open.
2760
2761	The remote session provides some level of control over the VM
2762	execution (using the IConsole interface) to the caller; however,
2763	within the remote session context, not all VM settings are available
2764	for modification.
2765
2766	As opposed to <link to="#openRemoteSession"/>, the number of
2767	remote sessions opened this way is not limited by the API
2768
2769	<note>
2770	It is an error to open a remote session with the machine that
2771	doesn't have an open direct session.
2772	</note>
2773
2774	<result name="E_UNEXPECTED">
2775	Virtual machine not registered.
2776	</result>
2777	<result name="VBOX_E_OBJECT_NOT_FOUND">
2778	No machine matching @a machineId found.
2779	</result>
2780	<result name="VBOX_E_INVALID_OBJECT_STATE">
2781	Session already open or being opened.
2782	</result>
2783	<result name="VBOX_E_INVALID_SESSION_STATE">
2784	Direct session state not Open.
2785	</result>
2786	<result name="VBOX_E_VM_ERROR">
2787	Failed to get console object from direct session or assign
2788	machine to session.
2789	</result>
2790
2791	<see>openRemoteSession</see>
2792	</desc>
2793	<param name="session" type="ISession" dir="in">
2794	<desc>
2795	Session object that will represent the open remote session
2796	after successful method invocation. This object must not
2797	represent an already open session.
2798	<note>
2799	This session will be automatically closed when the peer
2800	(direct) session dies or gets closed.
2801	</note>
2802	</desc>
2803	</param>
2804	<param name="machineId" type="uuid" mod="string" dir="in">
2805	<desc>ID of the virtual machine to open a session with.</desc>
2806	</param>
2807	</method>
2808
2809	<method name="registerCallback">
2810	<desc>
2811	Registers a new global VirtualBox callback. The methods of the given
2812	callback object will be called by VirtualBox when an appropriate
2813	event occurs.
2814
2815	<result name="E_INVALIDARG">
2816	A @c null callback cannot be registered.
2817	</result>
2818
2819	</desc>
2820	<param name="callback" type="IVirtualBoxCallback" dir="in">
2821	<desc>Callback object to register.</desc>
2822	</param>
2823	</method>
2824
2825	<method name="unregisterCallback">
2826	<desc>
2827	Unregisters the previously registered global VirtualBox callback.
2828
2829	<result name="E_INVALIDARG">
2830	Specified @a callback not registered.
2831	</result>
2832
2833	</desc>
2834	<param name="callback" type="IVirtualBoxCallback" dir="in">
2835	<desc>Callback object to unregister.</desc>
2836	</param>
2837	</method>
2838
2839	<method name="waitForPropertyChange">
2840	<desc>
2841	Blocks the caller until any of the properties represented by the
2842	@a what argument changes the value or until the given timeout interval
2843	expires.
2844
2845	The @a what argument is a comma separated list of property masks that
2846	describe properties the caller is interested in. The property mask is
2847	a string in the following format:
2848
2849	<pre>
2850	[[group.]subgroup.]name
2851	</pre>
2852
2853	where @c name is the property name and @c group, @c subgroup are zero
2854	or more property group specifiers. Each element (group or name) in
2855	the property mask may be either a Latin string or an asterisk symbol
2856	(@c "*") which is used to match any string for the given element. A
2857	property mask that doesn't contain asterisk symbols represents a
2858	single fully qualified property name.
2859
2860	Groups in the fully qualified property name go from more generic (the
2861	left-most part) to more specific (the right-most part). The first
2862	element is usually a name of the object the property belongs to. The
2863	second element may be either a property name, or a child object name,
2864	or an index if the preceding element names an object which is one of
2865	many objects of the same type. This way, property names form a
2866	hierarchy of properties. Here are some examples of property names:
2867
2868	<table>
2869	<tr>
2870	<td><tt>VirtualBox.version</tt></td>
2871	<td><link to="IVirtualBox::version"/> property</td>
2872	</tr>
2873	<tr>
2874	<td><tt>Machine.<UUID>.name</tt></td>
2875	<td><link to="IMachine::name"/> property of the machine with the
2876	given UUID</td>
2877	</tr>
2878	</table>
2879
2880	Most property names directly correspond to the properties of objects
2881	(components) provided by the VirtualBox library and may be used to
2882	track changes to these properties. However, there may be
2883	pseudo-property names that don't correspond to any existing object's
2884	property directly, as well as there may be object properties that
2885	don't have a corresponding property name that is understood by this
2886	method, and therefore changes to such properties cannot be
2887	tracked. See individual object's property descriptions to get a
2888	fully qualified property name that can be used with this method (if
2889	any).
2890
2891	There is a special property mask @c "*" (i.e. a string consisting of a
2892	single asterisk symbol) that can be used to match all properties.
2893	Below are more examples of property masks:
2894
2895	<table>
2896	<tr>
2897	<td><tt>VirtualBox.*</tt></td>
2898	<td>Track all properties of the VirtualBox object</td>
2899	</tr>
2900	<tr>
2901	<td><tt>Machine.*.name</tt></td>
2902	<td>Track changes to the <link to="IMachine::name"/> property of
2903	all registered virtual machines</td>
2904	</tr>
2905	</table>
2906
2907	<note>
2908	This function is not implemented in the current version of the
2909	product.
2910	</note>
2911	</desc>
2912	<param name="what" type="wstring" dir="in">
2913	<desc>Comma separated list of property masks.</desc>
2914	</param>
2915	<param name="timeout" type="unsigned long" dir="in">
2916	<desc>
2917	Wait timeout in milliseconds.
2918	Specify -1 for an indefinite wait.
2919	</desc>
2920	</param>
2921	<param name="changed" type="wstring" dir="out">
2922	<desc>
2923	Comma separated list of properties that have been changed and caused
2924	this method to return to the caller.
2925	</desc>
2926	</param>
2927	<param name="values" type="wstring" dir="out">
2928	<desc>Reserved, not currently used.</desc>
2929	</param>
2930	</method>
2931
2932	<!--method name="createDHCPServerForInterface">
2933	<desc>
2934	Creates a dhcp server settings to be used for the given interface
2935	<result name="E_INVALIDARG">
2936	Host network interface @a name already exists.
2937	</result>
2938	</desc>
2939	<param name="interface" type="IHostNetworkInterface" dir="in">
2940	<desc>Network Interface</desc>
2941	</param>
2942	<param name="server" type="IDHCPServer" dir="out">
2943	<desc>Dhcp server settings</desc>
2944	</param>
2945	</method-->
2946
2947	<method name="createDHCPServer">
2948	<desc>
2949	Creates a dhcp server settings to be used for the given internal network name
2950	<result name="E_INVALIDARG">
2951	Host network interface @a name already exists.
2952	</result>
2953	</desc>
2954	<param name="name" type="wstring" dir="in">
2955	<desc>server name</desc>
2956	</param>
2957	<param name="server" type="IDHCPServer" dir="return">
2958	<desc>Dhcp server settings</desc>
2959	</param>
2960	</method>
2961
2962	<method name="findDHCPServerByNetworkName">
2963	<desc>
2964	Searches a dhcp server settings to be used for the given internal network name
2965	<result name="E_INVALIDARG">
2966	Host network interface @a name already exists.
2967	</result>
2968
2969	</desc>
2970	<param name="name" type="wstring" dir="in">
2971	<desc>server name</desc>
2972	</param>
2973	<param name="server" type="IDHCPServer" dir="return">
2974	<desc>Dhcp server settings</desc>
2975	</param>
2976	</method>
2977
2978	<!--method name="findDHCPServerForInterface">
2979	<desc>
2980	Searches a dhcp server settings to be used for the given interface
2981	<result name="E_INVALIDARG">
2982	Host network interface @a name already exists.
2983	</result>
2984	</desc>
2985	<param name="interface" type="IHostNetworkInterface" dir="in">
2986	<desc>Network Interface</desc>
2987	</param>
2988	<param name="server" type="IDHCPServer" dir="out">
2989	<desc>Dhcp server settings</desc>
2990	</param>
2991	</method-->
2992
2993	<method name="removeDHCPServer">
2994	<desc>
2995	Removes the dhcp server settings
2996	<result name="E_INVALIDARG">
2997	Host network interface @a name already exists.
2998	</result>
2999	</desc>
3000	<param name="server" type="IDHCPServer" dir="in">
3001	<desc>Dhcp server settings to be removed</desc>
3002	</param>
3003	</method>
3004
3005	</interface>
3006
3007	<!--
3008	// IVFSExplorer
3009	/////////////////////////////////////////////////////////////////////////
3010	-->
3011
3012	<enum
3013	name="VFSType"
3014	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
3015	>
3016	<desc>
3017	Virtual file systems supported by VFSExplorer.
3018	</desc>
3019
3020	<const name="File" value="1" />
3021	<const name="Cloud" value="2" />
3022	<const name="S3" value="3" />
3023	<const name="WebDav" value="4" />
3024	</enum>
3025
3026	<enum
3027	name="VFSFileType"
3028	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
3029	>
3030	<desc>
3031	File types known by VFSExplorer.
3032	</desc>
3033
3034	<const name="Unknown" value="1" />
3035	<const name="Fifo" value="2" />
3036	<const name="DevChar" value="3" />
3037	<const name="Directory" value="4" />
3038	<const name="DevBlock" value="5" />
3039	<const name="File" value="6" />
3040	<const name="SymLink" value="7" />
3041	<const name="Socket" value="8" />
3042	<const name="WhiteOut" value="9" />
3043	</enum>
3044
3045	<interface
3046	name="IVFSExplorer" extends="$unknown"
3047	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
3048	wsmap="managed"
3049	>
3050	<desc>
3051	The VFSExplorer interface unifies access to different file system
3052	types. This includes local file systems as well remote file systems like
3053	S3. For a list of supported types see <link to="VFSType" />.
3054	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
3055	</desc>
3056
3057	<attribute name="path" type="wstring" readonly="yes">
3058	<desc>Returns the current path in the virtual file system.</desc>
3059	</attribute>
3060
3061	<attribute name="type" type="VFSType" readonly="yes">
3062	<desc>Returns the file system type which is currently in use.</desc>
3063	</attribute>
3064
3065	<method name="update">
3066	<desc>Updates the internal list of files/directories from the
3067	current directory level. Use <link to="#entryList" /> to get the full list
3068	after a call to this method.</desc>
3069
3070	<param name="aProgress" type="IProgress" dir="return">
3071	<desc>Progress object to track the operation completion.</desc>
3072	</param>
3073	</method>
3074
3075	<method name="cd">
3076	<desc>Change the current directory level.</desc>
3077
3078	<param name="aDir" type="wstring" dir="in">
3079	<desc>The name of the directory to go in.</desc>
3080	</param>
3081
3082	<param name="aProgress" type="IProgress" dir="return">
3083	<desc>Progress object to track the operation completion.</desc>
3084	</param>
3085	</method>
3086
3087	<method name="cdUp">
3088	<desc>Go one directory upwards from the current directory level.</desc>
3089
3090	<param name="aProgress" type="IProgress" dir="return">
3091	<desc>Progress object to track the operation completion.</desc>
3092	</param>
3093	</method>
3094
3095	<method name="entryList">
3096	<desc>Returns a list of files/directories after a call to <link
3097	to="#update" />. The user is responsible for keeping this internal
3098	list up do date.</desc>
3099
3100	<param name="aNames" type="wstring" safearray="yes" dir="out">
3101	<desc>The list of names for the entries.</desc>
3102	</param>
3103
3104	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
3105	<desc>The list of types for the entries.</desc>
3106	</param>
3107	</method>
3108
3109	<method name="exists">
3110	<desc>Checks if the given file list exists in the current directory
3111	level.</desc>
3112
3113	<param name="aNames" type="wstring" safearray="yes" dir="in">
3114	<desc>The names to check.</desc>
3115	</param>
3116
3117	<param name="aExists" type="wstring" safearray="yes" dir="return">
3118	<desc>The names which exist.</desc>
3119	</param>
3120	</method>
3121
3122	<method name="remove">
3123	<desc>Deletes the given files in the current directory level.</desc>
3124
3125	<param name="aNames" type="wstring" safearray="yes" dir="in">
3126	<desc>The names to remove.</desc>
3127	</param>
3128
3129	<param name="aProgress" type="IProgress" dir="return">
3130	<desc>Progress object to track the operation completion.</desc>
3131	</param>
3132	</method>
3133
3134	</interface>
3135
3136	<!--
3137	// IAppliance
3138	/////////////////////////////////////////////////////////////////////////
3139	-->
3140
3141	<interface
3142	name="IAppliance" extends="$unknown"
3143	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3144	wsmap="managed"
3145	>
3146	<desc>
3147	Represents a platform-independent appliance in OVF format. An instance of this is returned
3148	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3149	appliances with VirtualBox.
3150
3151	The OVF standard suggests two different physical file formats:
3152
3153	<ol>
3154	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3155	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3156	this descriptor file references other files, as OVF appliances distributed as a set of
3157	files most likely do, those files must be in the same directory as the descriptor file.</li>
3158
3159	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3160	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3161	files and optionally other files.
3162
3163	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3164	be added with a later version.</li>
3165	</ol>
3166
3167	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3168	<link to="IMachine" /> involves the following sequence of API calls:
3169
3170	<ol>
3171	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3172	</li>
3173
3174	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3175	would like to import. So long as this file is syntactically valid, this will succeed
3176	and return an instance of IAppliance that contains the parsed data from the OVF file.
3177	</li>
3178
3179	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3180	contents of the IAppliance attributes accordingly. These can be inspected by a
3181	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3182	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3183	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3184	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3185	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3186	The GUI can then give the user the option to confirm and/or change these suggestions.
3187	</li>
3188
3189	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3190	virtual system to override the suggestions made by the interpret() routine.
3191	</li>
3192
3193	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3194	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3195	virtual system descriptions.
3196	</li>
3197	</ol>
3198
3199	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3200
3201	<ol>
3202	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3203	an empty IAppliance object.
3204	</li>
3205
3206	<li>For each machine you would like to export, call <link to="IMachine::export" />
3207	with the IAppliance object you just created. This creates an instance of
3208	<link to="IVirtualSystemDescription" /> inside the appliance.
3209	</li>
3210
3211	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3212	virtual system to override the suggestions made by the export() routine.
3213	</li>
3214
3215	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3216	file written.</li>
3217	</ol>
3218
3219	</desc>
3220
3221	<attribute name="path" type="wstring" readonly="yes">
3222	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3223	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3224	<link to="#write" /> (for export).
3225	This attribute is empty until one of these methods has been called.
3226	</desc>
3227	</attribute>
3228
3229	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3230	<desc>
3231	Array of virtual disk definitions. One such description exists for each
3232	disk definition in the OVF; each string array item represents one such piece of
3233	disk information, with the information fields separated by tab (\\t) characters.
3234
3235	The caller should be prepared for additional fields being appended to
3236	this string in future versions of VirtualBox and therefore check for
3237	the number of tabs in the strings returned.
3238
3239	In the current version, the following eight fields are returned per string
3240	in the array:
3241
3242	<ol>
3243	<li>Disk ID (unique string identifier given to disk)</li>
3244
3245	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3246
3247	<li>Populated size (optional unsigned integer indicating the current size of the
3248	disk; can be approximate; -1 if unspecified)</li>
3249
3250	<li>Format (string identifying the disk format, typically
3251	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3252
3253	<li>Reference (where to find the disk image, typically a file name; if empty,
3254	then the disk should be created on import)</li>
3255
3256	<li>Image size (optional unsigned integer indicating the size of the image,
3257	which need not necessarily be the same as the values specified above, since
3258	the image may be compressed or sparse; -1 if not specified)</li>
3259
3260	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3261	presently unsupported and always -1)</li>
3262
3263	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3264	</ol>
3265	</desc>
3266	</attribute>
3267
3268	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3269	<desc> Array of virtual system descriptions. One such description is created
3270	for each virtual system found in the OVF.
3271	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3272	(for export) has been called.
3273	</desc>
3274	</attribute>
3275
3276	<method name="read">
3277	<desc>
3278	Reads an OVF file into the appliance object.
3279
3280	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3281	mere fact that this method returns successfully does not mean that VirtualBox supports all
3282	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3283	</desc>
3284	<param name="file" type="wstring" dir="in">
3285	<desc>
3286	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3287	on whether the appliance is distributed as a set of files or as a single file, respectively).
3288	</desc>
3289	</param>
3290	<param name="aProgress" type="IProgress" dir="return">
3291	<desc></desc>
3292	</param>
3293	</method>
3294
3295	<method name="interpret">
3296	<desc>
3297	Interprets the OVF data that was read when the appliance was constructed. After
3298	calling this method, one can inspect the
3299	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3300	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3301	the appliance.
3302
3303	Calling this method is the second step of importing an appliance into VirtualBox;
3304	see <link to="IAppliance" /> for an overview.
3305
3306	After calling this method, one should call <link to="#getWarnings" /> to find out
3307	if problems were encountered during the processing which might later lead to
3308	errors.
3309	</desc>
3310	</method>
3311
3312	<method name="importMachines">
3313	<desc>
3314	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3315	and other interfaces that match the information contained in the appliance as
3316	closely as possible, as represented by the import instructions in the
3317	<link to="#virtualSystemDescriptions" /> array.
3318
3319	Calling this method is the final step of importing an appliance into VirtualBox;
3320	see <link to="IAppliance" /> for an overview.
3321
3322	Since importing the appliance will most probably involve copying and converting
3323	disk images, which can take a long time, this method operates asynchronously and
3324	returns an IProgress object to allow the caller to monitor the progress.
3325	</desc>
3326
3327	<param name="aProgress" type="IProgress" dir="return">
3328	<desc></desc>
3329	</param>
3330	</method>
3331
3332	<method name="createVFSExplorer">
3333	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3334
3335	<param name="aUri" type="wstring" dir="in">
3336	<desc>The URI describing the file system to use.</desc>
3337	</param>
3338
3339	<param name="aExplorer" type="IVFSExplorer" dir="return">
3340	<desc></desc>
3341	</param>
3342	</method>
3343
3344	<method name="write">
3345	<desc>
3346	Writes the contents of the appliance exports into a new OVF file.
3347
3348	Calling this method is the final step of exporting an appliance from VirtualBox;
3349	see <link to="IAppliance" /> for an overview.
3350
3351	Since exporting the appliance will most probably involve copying and converting
3352	disk images, which can take a long time, this method operates asynchronously and
3353	returns an IProgress object to allow the caller to monitor the progress.
3354	</desc>
3355	<param name="format" type="wstring" dir="in">
3356	<desc>
3357	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3358	future versions of VirtualBox may support additional formats.
3359	</desc>
3360	</param>
3361	<param name="path" type="wstring" dir="in">
3362	<desc>
3363	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3364	on whether the appliance is distributed as a set of files or as a single file, respectively).
3365	</desc>
3366	</param>
3367	<param name="aProgress" type="IProgress" dir="return">
3368	<desc>Progress object to track the operation completion.</desc>
3369	</param>
3370	</method>
3371
3372	<method name="getWarnings">
3373	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3374
3375	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3376	<desc></desc>
3377	</param>
3378	</method>
3379
3380	</interface>
3381
3382	<enum
3383	name="VirtualSystemDescriptionType"
3384	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3385	>
3386	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3387	a configuration value.</desc>
3388
3389	<const name="Ignore" value="1" />
3390	<const name="OS" value="2" />
3391	<const name="Name" value="3" />
3392	<const name="Product" value="4" />
3393	<const name="Vendor" value="5" />
3394	<const name="Version" value="6" />
3395	<const name="ProductUrl" value="7" />
3396	<const name="VendorUrl" value="8" />
3397	<const name="Description" value="9" />
3398	<const name="License" value="10" />
3399	<const name="Miscellaneous" value="11" />
3400	<const name="CPU" value="12" />
3401	<const name="Memory" value="13" />
3402	<const name="HardDiskControllerIDE" value="14" />
3403	<const name="HardDiskControllerSATA" value="15" />
3404	<const name="HardDiskControllerSCSI" value="16" />
3405	<const name="HardDiskImage" value="17" />
3406	<const name="Floppy" value="18" />
3407	<const name="CDROM" value="19" />
3408	<const name="NetworkAdapter" value="20" />
3409	<const name="USBController" value="21" />
3410	<const name="SoundCard" value="22" />
3411
3412	</enum>
3413
3414	<enum
3415	name="VirtualSystemDescriptionValueType"
3416	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3417	>
3418	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3419	type to fetch.</desc>
3420
3421	<const name="Reference" value="1" />
3422	<const name="Original" value="2" />
3423	<const name="Auto" value="3" />
3424	<const name="ExtraConfig" value="4" />
3425
3426	</enum>
3427
3428	<interface
3429	name="IVirtualSystemDescription" extends="$unknown"
3430	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3431	wsmap="managed"
3432	>
3433
3434	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3435	After <link to="IAppliance::interpret" /> has been called, that array contains
3436	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3437	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3438	into VirtualBox.
3439	</desc>
3440
3441	<attribute name="count" type="unsigned long" readonly="yes">
3442	<desc>Return the number of virtual system description entries.</desc>
3443	</attribute>
3444
3445	<method name="getDescription">
3446	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3447	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3448
3449	The list below identifies the value sets that are possible depending on the
3450	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3451	the array item with the same index in aOvfValues[] will contain the original value as contained
3452	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3453	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3454	the aExtraConfigValues[] array item may also be used.
3455
3456	<ul>
3457	<li>
3458	"OS": the guest operating system type. There must be exactly one such array item on import. The
3459	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3460	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3461	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3462	</li>
3463	<li>
3464	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3465	if none is present on import, then an automatic name will be created from the operating system
3466	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3467	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3468	<link to="IMachine" /> name that does not exist yet.
3469	</li>
3470	<li>
3471	"Description": an arbitrary description.
3472	</li>
3473	<li>
3474	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3475	code to display such a license for agreement; the Main API does not enforce any such policy.
3476	</li>
3477	<li>
3478	Miscellaneous: reserved for future use.
3479	</li>
3480	<li>
3481	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3482	</li>
3483	<li>
3484	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3485	is present on import, then VirtualBox will set a meaningful default based on the operating system
3486	type.
3487	</li>
3488	<li>
3489	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3490	has no value in aOvfValues[] or aVBoxValues[].
3491	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3492	type can use to specify which hard disk controller a virtual disk should be connected to.
3493	</li>
3494	<li>
3495	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3496	has no value in aOvfValues[] or aVBoxValues[].
3497	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3498	</li>
3499	<li>
3500	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3501	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3502	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3503	</li>
3504	<li>
3505	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3506	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3507
3508	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3509	a path since the image file should be in the same location as the OVF file itself), whereas the
3510	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3511	hard disk image. This means that on import the image will be copied and converted from the
3512	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3513	On import, the target image will also be registered with VirtualBox.
3514
3515	The matching item in the aExtraConfigValues[] array must contain a string of the following
3516	format: "controller=<index>;channel=<c>"
3517	In this string, <index> must be an integer specifying the hard disk controller to connect
3518	the image to. That number must be the index of an array item with one of the hard disk controller
3519	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3520	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3521	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3522	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3523	</li>
3524	<li>
3525	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3526	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3527	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3528	</li>
3529	<li>
3530	"USBController": a USB controller. There can be at most one such item. If and only if such an
3531	item ispresent, USB support will be enabled for the new virtual machine.
3532	</li>
3533	<li>
3534	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3535	present, sound support will be enabled for the new virtual machine. Note that the virtual
3536	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3537	may be different from the virtual soundcard expected by the appliance.
3538	</li>
3539	</ul>
3540
3541	</desc>
3542
3543	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3544	<desc></desc>
3545	</param>
3546
3547	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3548	<desc></desc>
3549	</param>
3550
3551	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3552	<desc></desc>
3553	</param>
3554
3555	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3556	<desc></desc>
3557	</param>
3558
3559	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3560	<desc></desc>
3561	</param>
3562
3563	</method>
3564
3565	<method name="getDescriptionByType">
3566	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3567	should be returned.</desc>
3568
3569	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3570	<desc></desc>
3571	</param>
3572
3573	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3574	<desc></desc>
3575	</param>
3576
3577	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3578	<desc></desc>
3579	</param>
3580
3581	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3582	<desc></desc>
3583	</param>
3584
3585	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3586	<desc></desc>
3587	</param>
3588
3589	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3590	<desc></desc>
3591	</param>
3592
3593	</method>
3594
3595	<method name="getValuesByType">
3596	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3597	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3598	values.</desc>
3599
3600	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3601	<desc></desc>
3602	</param>
3603
3604	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3605	<desc></desc>
3606	</param>
3607
3608	<param name="aValues" type="wstring" dir="return" safearray="yes">
3609	<desc></desc>
3610	</param>
3611
3612	</method>
3613
3614	<method name="setFinalValues">
3615	<desc>
3616	This method allows the appliance's user to change the configuration for the virtual
3617	system descriptions. For each array item returned from <link to="#getDescription" />,
3618	you must pass in one boolean value and one configuration value.
3619
3620	Each item in the boolean array determines whether the particular configuration item
3621	should be enabled.
3622	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3623	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3624	and SoundCard.
3625
3626	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3627	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3628	the configuration remains unchanged. Please see the documentation for getDescription()
3629	for valid configuration values for the individual array item types. If the
3630	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3631	</desc>
3632
3633	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3634	<desc></desc>
3635	</param>
3636
3637	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3638	<desc></desc>
3639	</param>
3640
3641	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3642	<desc></desc>
3643	</param>
3644	</method>
3645
3646	<method name="addDescription">
3647	<desc>
3648	This method adds an additional description entry to the stack of already
3649	available descriptions for this virtual system. This is handy for writing
3650	values which aren't directly supported by VirtualBox. One example would
3651	be the License type of <link to="VirtualSystemDescriptionType" />.
3652	</desc>
3653
3654	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3655	<desc></desc>
3656	</param>
3657
3658	<param name="aVBoxValue" type="wstring" dir="in">
3659	<desc></desc>
3660	</param>
3661
3662	<param name="aExtraConfigValue" type="wstring" dir="in">
3663	<desc></desc>
3664	</param>
3665	</method>
3666	</interface>
3667
3668
3669	<!--
3670	// IMachine
3671	/////////////////////////////////////////////////////////////////////////
3672	-->
3673
3674	<interface
3675	name="IInternalMachineControl" extends="$unknown"
3676	uuid="4e2b8f0f-6575-49d2-bb19-5cd15a6ca2f0"
3677	internal="yes"
3678	wsmap="suppress"
3679	>
3680	<method name="setRemoveSavedState">
3681	<desc>
3682	Updates the flag whether saved state is removed on a machine state
3683	change from Saved to PoweredOff.
3684	</desc>
3685	<param name="aRemove" type="boolean" dir="in"/>
3686	</method>
3687
3688	<method name="updateState">
3689	<desc>
3690	Updates the VM state.
3691	<note>
3692	This operation will also update the settings file with
3693	the correct information about the saved state file
3694	and delete this file from disk when appropriate.
3695	</note>
3696	</desc>
3697	<param name="state" type="MachineState" dir="in"/>
3698	</method>
3699
3700	<method name="getIPCId">
3701	<param name="id" type="wstring" dir="return"/>
3702	</method>
3703
3704	<method name="runUSBDeviceFilters">
3705	<desc>
3706	Asks the server to run USB devices filters of the associated
3707	machine against the given USB device and tell if there is
3708	a match.
3709	<note>
3710	Intended to be used only for remote USB devices. Local
3711	ones don't require to call this method (this is done
3712	implicitly by the Host and USBProxyService).
3713	</note>
3714	</desc>
3715	<param name="device" type="IUSBDevice" dir="in"/>
3716	<param name="matched" type="boolean" dir="out"/>
3717	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3718	</method>
3719
3720	<method name="captureUSBDevice">
3721	<desc>
3722	Requests a capture of the given host USB device.
3723	When the request is completed, the VM process will
3724	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3725	notification.
3726	</desc>
3727	<param name="id" type="uuid" mod="string" dir="in"/>
3728	</method>
3729
3730	<method name="detachUSBDevice">
3731	<desc>
3732	Notification that a VM is going to detach (@a done = @c false) or has
3733	already detached (@a done = @c true) the given USB device.
3734	When the @a done = @c true request is completed, the VM process will
3735	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3736	notification.
3737	<note>
3738	In the @a done = @c true case, the server must run its own filters
3739	and filters of all VMs but this one on the detached device
3740	as if it were just attached to the host computer.
3741	</note>
3742	</desc>
3743	<param name="id" type="uuid" mod="string" dir="in"/>
3744	<param name="done" type="boolean" dir="in"/>
3745	</method>
3746
3747	<method name="autoCaptureUSBDevices">
3748	<desc>
3749	Requests a capture all matching USB devices attached to the host.
3750	When the request is completed, the VM process will
3751	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3752	notification per every captured device.
3753	</desc>
3754	</method>
3755
3756	<method name="detachAllUSBDevices">
3757	<desc>
3758	Notification that a VM that is being powered down. The done
3759	parameter indicates whether which stage of the power down
3760	we're at. When @a done = @c false the VM is announcing its
3761	intentions, while when @a done = @c true the VM is reporting
3762	what it has done.
3763	<note>
3764	In the @a done = @c true case, the server must run its own filters
3765	and filters of all VMs but this one on all detach devices as
3766	if they were just attached to the host computer.
3767	</note>
3768	</desc>
3769	<param name="done" type="boolean" dir="in"/>
3770	</method>
3771
3772	<method name="onSessionEnd">
3773	<desc>
3774	Triggered by the given session object when the session is about
3775	to close normally.
3776	</desc>
3777	<param name="session" type="ISession" dir="in">
3778	<desc>Session that is being closed</desc>
3779	</param>
3780	<param name="progress" type="IProgress" dir="return">
3781	<desc>
3782	Used to wait until the corresponding machine is actually
3783	dissociated from the given session on the server.
3784	Returned only when this session is a direct one.
3785	</desc>
3786	</param>
3787	</method>
3788
3789	<method name="beginSavingState">
3790	<desc>
3791	Called by the VM process to inform the server it wants to
3792	save the current state and stop the VM execution.
3793	</desc>
3794	<param name="progress" type="IProgress" dir="in">
3795	<desc>
3796	Progress object created by the VM process to wait until
3797	the state is saved.
3798	</desc>
3799	</param>
3800	<param name="stateFilePath" type="wstring" dir="out">
3801	<desc>
3802	File path the VM process must save the execution state to.
3803	</desc>
3804	</param>
3805	</method>
3806
3807	<method name="endSavingState">
3808	<desc>
3809	Called by the VM process to inform the server that saving
3810	the state previously requested by #beginSavingState is either
3811	successfully finished or there was a failure.
3812
3813	<result name="VBOX_E_FILE_ERROR">
3814	Settings file not accessible.
3815	</result>
3816	<result name="VBOX_E_XML_ERROR">
3817	Could not parse the settings file.
3818	</result>
3819
3820	</desc>
3821
3822	<param name="success" type="boolean" dir="in">
3823	<desc>@c true to indicate success and @c false otherwise.
3824	</desc>
3825	</param>
3826	</method>
3827
3828	<method name="adoptSavedState">
3829	<desc>
3830	Gets called by IConsole::adoptSavedState.
3831	<result name="VBOX_E_FILE_ERROR">
3832	Invalid saved state file path.
3833	</result>
3834	</desc>
3835	<param name="savedStateFile" type="wstring" dir="in">
3836	<desc>Path to the saved state file to adopt.</desc>
3837	</param>
3838	</method>
3839
3840	<method name="beginTakingSnapshot">
3841	<desc>
3842	Called from the VM process to request from the server to perform the
3843	server-side actions of creating a snapshot (creating differencing images
3844	and the snapshot object).
3845
3846	<result name="VBOX_E_FILE_ERROR">
3847	Settings file not accessible.
3848	</result>
3849	<result name="VBOX_E_XML_ERROR">
3850	Could not parse the settings file.
3851	</result>
3852	</desc>
3853	<param name="initiator" type="IConsole" dir="in">
3854	<desc>The console object that initiated this call.</desc>
3855	</param>
3856	<param name="name" type="wstring" dir="in">
3857	<desc>Snapshot name.</desc>
3858	</param>
3859	<param name="description" type="wstring" dir="in">
3860	<desc>Snapshot description.</desc>
3861	</param>
3862	<param name="consoleProgress" type="IProgress" dir="in">
3863	<desc>
3864	Progress object created by the VM process tracking the
3865	snapshot's progress. This has the following sub-operations:
3866	<ul>
3867	<li>setting up (weight 1);</li>
3868	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3869	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3870	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3871	<li>finishing up (weight 1)</li>
3872	</ul>
3873	</desc>
3874	</param>
3875	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3876	<desc>
3877	Whether this is an online snapshot (i.e. the machine is running).
3878	</desc>
3879	</param>
3880	<param name="stateFilePath" type="wstring" dir="out">
3881	<desc>
3882	File path the VM process must save the execution state to.
3883	</desc>
3884	</param>
3885	</method>
3886
3887	<method name="endTakingSnapshot">
3888	<desc>
3889	Called by the VM process to inform the server that the snapshot
3890	previously requested by #beginTakingSnapshot is either
3891	successfully taken or there was a failure.
3892	</desc>
3893
3894	<param name="success" type="boolean" dir="in">
3895	<desc>@c true to indicate success and @c false otherwise</desc>
3896	</param>
3897	</method>
3898
3899	<method name="deleteSnapshot">
3900	<desc>
3901	Gets called by IConsole::deleteSnapshot.
3902	<result name="VBOX_E_INVALID_OBJECT_STATE">
3903	Snapshot has more than one child snapshot.
3904	</result>
3905	</desc>
3906	<param name="initiator" type="IConsole" dir="in">
3907	<desc>The console object that initiated this call.</desc>
3908	</param>
3909	<param name="id" type="uuid" mod="string" dir="in">
3910	<desc>UUID of the snapshot to discard.</desc>
3911	</param>
3912	<param name="machineState" type="MachineState" dir="out">
3913	<desc>New machine state after this operation is started.</desc>
3914	</param>
3915	<param name="progress" type="IProgress" dir="return">
3916	<desc>Progress object to track the operation completion.</desc>
3917	</param>
3918	</method>
3919
3920	<method name="restoreSnapshot">
3921	<desc>
3922	Gets called by IConsole::RestoreSnapshot.
3923	</desc>
3924	<param name="initiator" type="IConsole" dir="in">
3925	<desc>The console object that initiated this call.</desc>
3926	</param>
3927	<param name="snapshot" type="ISnapshot" dir="in">
3928	<desc>The snapshot to restore the VM state from.</desc>
3929	</param>
3930	<param name="machineState" type="MachineState" dir="out">
3931	<desc>New machine state after this operation is started.</desc>
3932	</param>
3933	<param name="progress" type="IProgress" dir="return">
3934	<desc>Progress object to track the operation completion.</desc>
3935	</param>
3936	</method>
3937
3938	<method name="pullGuestProperties">
3939	<desc>
3940	Get the list of the guest properties matching a set of patterns along
3941	with their values, time stamps and flags and give responsibility for
3942	managing properties to the console.
3943	</desc>
3944	<param name="name" type="wstring" dir="out" safearray="yes">
3945	<desc>
3946	The names of the properties returned.
3947	</desc>
3948	</param>
3949	<param name="value" type="wstring" dir="out" safearray="yes">
3950	<desc>
3951	The values of the properties returned. The array entries match the
3952	corresponding entries in the @a name array.
3953	</desc>
3954	</param>
3955	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3956	<desc>
3957	The time stamps of the properties returned. The array entries match
3958	the corresponding entries in the @a name array.
3959	</desc>
3960	</param>
3961	<param name="flags" type="wstring" dir="out" safearray="yes">
3962	<desc>
3963	The flags of the properties returned. The array entries match the
3964	corresponding entries in the @a name array.
3965	</desc>
3966	</param>
3967	</method>
3968
3969	<method name="pushGuestProperties">
3970	<desc>
3971	Set the list of the guest properties matching a set of patterns along
3972	with their values, time stamps and flags and return responsibility for
3973	managing properties to IMachine.
3974	</desc>
3975	<param name="name" type="wstring" dir="in" safearray="yes">
3976	<desc>
3977	The names of the properties.
3978	</desc>
3979	</param>
3980	<param name="value" type="wstring" dir="in" safearray="yes">
3981	<desc>
3982	The values of the properties. The array entries match the
3983	corresponding entries in the @a name array.
3984	</desc>
3985	</param>
3986	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
3987	<desc>
3988	The time stamps of the properties. The array entries match
3989	the corresponding entries in the @a name array.
3990	</desc>
3991	</param>
3992	<param name="flags" type="wstring" dir="in" safearray="yes">
3993	<desc>
3994	The flags of the properties. The array entries match the
3995	corresponding entries in the @a name array.
3996	</desc>
3997	</param>
3998	</method>
3999	<method name="pushGuestProperty">
4000	<desc>
4001	Update a single guest property in IMachine.
4002	</desc>
4003	<param name="name" type="wstring" dir="in">
4004	<desc>
4005	The name of the property to be updated.
4006	</desc>
4007	</param>
4008	<param name="value" type="wstring" dir="in">
4009	<desc>
4010	The value of the property.
4011	</desc>
4012	</param>
4013	<param name="timestamp" type="unsigned long long" dir="in">
4014	<desc>
4015	The timestamp of the property.
4016	</desc>
4017	</param>
4018	<param name="flags" type="wstring" dir="in">
4019	<desc>
4020	The flags of the property.
4021	</desc>
4022	</param>
4023	</method>
4024
4025	<method name="lockMedia">
4026	<desc>
4027	Locks all media attached to the machine for writing and parents of
4028	attached differencing media (if any) for reading. This operation is
4029	atomic so that if it fails no media is actually locked.
4030
4031	This method is intended to be called when the machine is in Starting or
4032	Restoring state. The locked media will be automatically unlocked when
4033	the machine is powered off or crashed.
4034	</desc>
4035	</method>
4036	</interface>
4037
4038	<interface
4039	name="IBIOSSettings" extends="$unknown"
4040	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
4041	wsmap="managed"
4042	>
4043	<desc>
4044	The IBIOSSettings interface represents BIOS settings of the virtual
4045	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
4046	</desc>
4047	<attribute name="logoFadeIn" type="boolean">
4048	<desc>Fade in flag for BIOS logo animation.</desc>
4049	</attribute>
4050
4051	<attribute name="logoFadeOut" type="boolean">
4052	<desc>Fade out flag for BIOS logo animation.</desc>
4053	</attribute>
4054
4055	<attribute name="logoDisplayTime" type="unsigned long">
4056	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
4057	</attribute>
4058
4059	<attribute name="logoImagePath" type="wstring">
4060	<desc>Local file system path for external BIOS image.</desc>
4061	</attribute>
4062
4063	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
4064	<desc>Mode of the BIOS boot device menu.</desc>
4065	</attribute>
4066
4067	<attribute name="ACPIEnabled" type="boolean">
4068	<desc>ACPI support flag.</desc>
4069	</attribute>
4070
4071	<attribute name="IOAPICEnabled" type="boolean">
4072	<desc>
4073	IO APIC support flag. If set, VirtualBox will provide an IO APIC
4074	and support IRQs above 15.
4075	</desc>
4076	</attribute>
4077
4078	<attribute name="timeOffset" type="long long">
4079	<desc>
4080	Offset in milliseconds from the host system time. This allows for
4081	guests running with a different system date/time than the host.
4082	It is equivalent to setting the system date/time in the BIOS except
4083	it is not an absolute value but a relative one. Guest Additions
4084	time synchronization honors this offset.
4085	</desc>
4086	</attribute>
4087
4088	<attribute name="PXEDebugEnabled" type="boolean">
4089	<desc>
4090	PXE debug logging flag. If set, VirtualBox will write extensive
4091	PXE trace information to the release log.
4092	</desc>
4093	</attribute>
4094
4095	</interface>
4096
4097	<interface
4098	name="IMachine" extends="$unknown"
4099	uuid="c5669e1a-491a-4367-99c6-28110dd474c6"
4100	wsmap="managed"
4101	>
4102	<desc>
4103	The IMachine interface represents a virtual machine, or guest, created
4104	in VirtualBox.
4105
4106	This interface is used in two contexts. First of all, a collection of
4107	objects implementing this interface is stored in the
4108	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4109	machines that are currently registered with this VirtualBox
4110	installation. Also, once a session has been opened for the given virtual
4111	machine (e.g. the virtual machine is running), the machine object
4112	associated with the open session can be queried from the session object;
4113	see <link to="ISession"/> for details.
4114
4115	The main role of this interface is to expose the settings of the virtual
4116	machine and provide methods to change various aspects of the virtual
4117	machine's configuration. For machine objects stored in the
4118	<link to="IVirtualBox::machines"/> collection, all attributes are
4119	read-only unless explicitly stated otherwise in individual attribute
4120	and method descriptions. In order to change a machine setting, a session
4121	for this machine must be opened using one of
4122	<link to="IVirtualBox::openSession"/>,
4123	<link to="IVirtualBox::openRemoteSession"/> or
4124	<link to="IVirtualBox::openExistingSession"/> methods. After the
4125	session has been successfully opened, a mutable machine object needs to
4126	be queried from the session object and then the desired settings changes
4127	can be applied to the returned object using IMachine attributes and
4128	methods. See the <link to="ISession"/> interface description for more
4129	information about sessions.
4130
4131	Note that IMachine does not provide methods to control virtual machine
4132	execution (such as start the machine, or power it down) -- these methods
4133	are grouped in a separate interface called <link to="IConsole" />.
4134
4135	<see>ISession, IConsole</see>
4136	</desc>
4137
4138	<attribute name="parent" type="IVirtualBox" readonly="yes">
4139	<desc>Associated parent object.</desc>
4140	</attribute>
4141
4142	<attribute name="accessible" type="boolean" readonly="yes">
4143	<desc>
4144	Whether this virtual machine is currently accessible or not.
4145
4146	A machine is always deemed accessible unless it is registered <i>and</i>
4147	its settings file cannot be read or parsed (either because the file itself
4148	is unavailable or has invalid XML contents).
4149
4150	Every time this property is read, the accessibility state of
4151	this machine is re-evaluated. If the returned value is @c false,
4152	the <link to="#accessError"/> property may be used to get the
4153	detailed error information describing the reason of
4154	inaccessibility, including XML error messages.
4155
4156	When the machine is inaccessible, only the following properties
4157	can be used on it:
4158	<ul>
4159	<li><link to="#parent"/></li>
4160	<li><link to="#id"/></li>
4161	<li><link to="#settingsFilePath"/></li>
4162	<li><link to="#accessible"/></li>
4163	<li><link to="#accessError"/></li>
4164	</ul>
4165
4166	An attempt to access any other property or method will return
4167	an error.
4168
4169	The only possible action you can perform on an inaccessible
4170	machine is to unregister it using the
4171	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4172	for the accessibility state once more by querying this
4173	property).
4174
4175	<note>
4176	In the current implementation, once this property returns
4177	@c true, the machine will never become inaccessible
4178	later, even if its settings file cannot be successfully
4179	read/written any more (at least, until the VirtualBox
4180	server is restarted). This limitation may be removed in
4181	future releases.
4182	</note>
4183	</desc>
4184	</attribute>
4185
4186	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4187	<desc>
4188	Error information describing the reason of machine
4189	inaccessibility.
4190
4191	Reading this property is only valid after the last call to
4192	<link to="#accessible"/> returned @c false (i.e. the
4193	machine is currently unaccessible). Otherwise, a @c null
4194	IVirtualBoxErrorInfo object will be returned.
4195	</desc>
4196	</attribute>
4197
4198	<attribute name="name" type="wstring">
4199	<desc>
4200	Name of the virtual machine.
4201
4202	Besides being used for human-readable identification purposes
4203	everywhere in VirtualBox, the virtual machine name is also used
4204	as a name of the machine's settings file and as a name of the
4205	subdirectory this settings file resides in. Thus, every time you
4206	change the value of this property, the settings file will be
4207	renamed once you call <link to="#saveSettings"/> to confirm the
4208	change. The containing subdirectory will be also renamed, but
4209	only if it has exactly the same name as the settings file
4210	itself prior to changing this property (for backward compatibility
4211	with previous API releases). The above implies the following
4212	limitations:
4213	<ul>
4214	<li>The machine name cannot be empty.</li>
4215	<li>The machine name can contain only characters that are valid
4216	file name characters according to the rules of the file
4217	system used to store VirtualBox configuration.</li>
4218	<li>You cannot have two or more machines with the same name
4219	if they use the same subdirectory for storing the machine
4220	settings files.</li>
4221	<li>You cannot change the name of the machine if it is running,
4222	or if any file in the directory containing the settings file
4223	is being used by another running machine or by any other
4224	process in the host operating system at a time when
4225	<link to="#saveSettings"/> is called.
4226	</li>
4227	</ul>
4228	If any of the above limitations are hit, <link to="#saveSettings"/>
4229	will return an appropriate error message explaining the exact
4230	reason and the changes you made to this machine will not be
4231	saved.
4232	<note>
4233	For "legacy" machines created using the
4234	<link to="IVirtualBox::createLegacyMachine"/> call,
4235	the above naming limitations do not apply because the
4236	machine name does not affect the settings file name.
4237	The settings file name remains the same as it was specified
4238	during machine creation and never changes.
4239	</note>
4240	</desc>
4241	</attribute>
4242
4243	<attribute name="description" type="wstring">
4244	<desc>
4245	Description of the virtual machine.
4246
4247	The description attribute can contain any text and is
4248	typically used to describe the hardware and software
4249	configuration of the virtual machine in detail (i.e. network
4250	settings, versions of the installed software and so on).
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="id" type="uuid" mod="string" readonly="yes">
4255	<desc>UUID of the virtual machine.</desc>
4256	</attribute>
4257
4258	<attribute name="OSTypeId" type="wstring">
4259	<desc>
4260	User-defined identifier of the Guest OS type.
4261	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4262	an IGuestOSType object representing details about the given
4263	Guest OS type.
4264	<note>
4265	This value may differ from the value returned by
4266	<link to="IGuest::OSTypeId"/> if Guest Additions are
4267	installed to the guest OS.
4268	</note>
4269	</desc>
4270	</attribute>
4271
4272	<attribute name="HardwareVersion" type="wstring">
4273	<desc>Hardware version identifier. Internal use only for now.</desc>
4274	</attribute>
4275
4276	<attribute name="hardwareUUID" type="uuid" mod="string">
4277	<desc>
4278	The UUID presented to the guest via memory tables, hardware and guest
4279	properties. For most VMs this is the same as the @a id, but for VMs
4280	which have been cloned or teleported it may be the same as the source
4281	VM. This latter is because the guest shouldn't notice that it was
4282	cloned or teleported.
4283	</desc>
4284	</attribute>
4285
4286	<attribute name="CPUCount" type="unsigned long">
4287	<desc>Number of virtual CPUs in the VM.</desc>
4288	</attribute>
4289
4290	<attribute name="memorySize" type="unsigned long">
4291	<desc>System memory size in megabytes.</desc>
4292	</attribute>
4293
4294	<attribute name="memoryBalloonSize" type="unsigned long">
4295	<desc>Initial memory balloon size in megabytes.</desc>
4296	</attribute>
4297
4298	<attribute name="statisticsUpdateInterval" type="unsigned long">
4299	<desc>Initial interval to update guest statistics in seconds.</desc>
4300	</attribute>
4301
4302	<attribute name="VRAMSize" type="unsigned long">
4303	<desc>Video memory size in megabytes.</desc>
4304	</attribute>
4305
4306	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4307	<desc>
4308	This setting determines whether VirtualBox allows this machine to make
4309	use of the 3D graphics support available on the host.</desc>
4310	</attribute>
4311
4312	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4313	<desc>
4314	This setting determines whether VirtualBox allows this machine to make
4315	use of the 2D video acceleration support available on the host.</desc>
4316	</attribute>
4317
4318	<attribute name="monitorCount" type="unsigned long">
4319	<desc>
4320	Number of virtual monitors.
4321	<note>
4322	Only effective on Windows XP and later guests with
4323	Guest Additions installed.
4324	</note>
4325	</desc>
4326	</attribute>
4327
4328	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4329	<desc>Object containing all BIOS settings.</desc>
4330	</attribute>
4331
4332	<attribute name="firmwareType" type="FirmwareType">
4333	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4334	bootstrap in this VM.</desc>
4335	</attribute>
4336
4337	<attribute name="snapshotFolder" type="wstring">
4338	<desc>
4339	Full path to the directory used to store snapshot data
4340	(differencing media and saved state files) of this machine.
4341
4342	The initial value of this property is
4343	<tt><</tt><link to="#settingsFilePath">
4344	path_to_settings_file</link><tt>>/<</tt>
4345	<link to="#id">machine_uuid</link>
4346	<tt>></tt>.
4347
4348	Currently, it is an error to try to change this property on
4349	a machine that has snapshots (because this would require to
4350	move possibly large files to a different location).
4351	A separate method will be available for this purpose later.
4352
4353	<note>
4354	Setting this property to @c null or to an empty string will restore
4355	the initial value.
4356	</note>
4357	<note>
4358	When setting this property, the specified path can be
4359	absolute (full path) or relative to the directory where the
4360	<link to="#settingsFilePath">machine settings file</link>
4361	is located. When reading this property, a full path is
4362	always returned.
4363	</note>
4364	<note>
4365	The specified path may not exist, it will be created
4366	when necessary.
4367	</note>
4368	</desc>
4369	</attribute>
4370
4371	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4372	<desc>VRDP server object.</desc>
4373	</attribute>
4374
4375	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4376	<desc>Array of media attached to this machine.</desc>
4377	</attribute>
4378
4379	<attribute name="USBController" type="IUSBController" readonly="yes">
4380	<desc>
4381	Associated USB controller object.
4382
4383	<note>
4384	If USB functionality is not available in the given edition of
4385	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4386	</note>
4387	</desc>
4388	</attribute>
4389
4390	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4391	<desc>Associated audio adapter, always present.</desc>
4392	</attribute>
4393
4394	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4395	<desc>Array of storage controllers attached to this machine.</desc>
4396	</attribute>
4397
4398	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4399	<desc>
4400	Full name of the file containing machine settings data.
4401	</desc>
4402	</attribute>
4403
4404	<attribute name="settingsModified" type="boolean" readonly="yes">
4405	<desc>
4406	Whether the settings of this machine have been modified
4407	(but neither yet saved nor discarded).
4408	<note>
4409	Reading this property is only valid on instances returned
4410	by <link to="ISession::machine"/> and on new machines
4411	created by <link to="IVirtualBox::createMachine"/> or opened
4412	by <link to="IVirtualBox::openMachine"/> but not
4413	yet registered, or on unregistered machines after calling
4414	<link to="IVirtualBox::unregisterMachine"/>. For all other
4415	cases, the settings can never be modified.
4416	</note>
4417	<note>
4418	For newly created unregistered machines, the value of this
4419	property is always @c true until <link to="#saveSettings"/>
4420	is called (no matter if any machine settings have been
4421	changed after the creation or not). For opened machines
4422	the value is set to @c false (and then follows to normal rules).
4423	</note>
4424	</desc>
4425	</attribute>
4426
4427	<attribute name="sessionState" type="SessionState" readonly="yes">
4428	<desc>Current session state for this machine.</desc>
4429	</attribute>
4430
4431	<attribute name="sessionType" type="wstring" readonly="yes">
4432	<desc>
4433	Type of the session. If <link to="#sessionState"/> is
4434	SessionSpawning or SessionOpen, this attribute contains the
4435	same value as passed to the
4436	<link to="IVirtualBox::openRemoteSession"/> method in the
4437	@a type parameter. If the session was opened directly using
4438	<link to="IVirtualBox::openSession"/>, or if
4439	<link to="#sessionState"/> is SessionClosed, the value of this
4440	attribute is an empty string.
4441	</desc>
4442	</attribute>
4443
4444	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4445	<desc>
4446	Identifier of the session process. This attribute contains the
4447	platform-dependent identifier of the process that has opened a
4448	direct session for this machine using the
4449	<link to="IVirtualBox::openSession"/> call. The returned value
4450	is only valid if <link to="#sessionState"/> is SessionOpen or
4451	SessionClosing (i.e. a session is currently open or being
4452	closed) by the time this property is read.
4453	</desc>
4454	</attribute>
4455
4456	<attribute name="state" type="MachineState" readonly="yes">
4457	<desc>Current execution state of this machine.</desc>
4458	</attribute>
4459
4460	<attribute name="lastStateChange" type="long long" readonly="yes">
4461	<desc>
4462	Time stamp of the last execution state change,
4463	in milliseconds since 1970-01-01 UTC.
4464	</desc>
4465	</attribute>
4466
4467	<attribute name="stateFilePath" type="wstring" readonly="yes">
4468	<desc>
4469	Full path to the file that stores the execution state of
4470	the machine when it is in the <link to="MachineState_Saved"/> state.
4471	<note>
4472	When the machine is not in the Saved state, this attribute is
4473	an empty string.
4474	</note>
4475	</desc>
4476	</attribute>
4477
4478	<attribute name="logFolder" type="wstring" readonly="yes">
4479	<desc>
4480	Full path to the folder that stores a set of rotated log files
4481	recorded during machine execution. The most recent log file is
4482	named <tt>VBox.log</tt>, the previous log file is
4483	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4484	in the current version).
4485	</desc>
4486	</attribute>
4487
4488	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4489	<desc>
4490	Current snapshot of this machine. This is @c null if the machine
4491	currently has no snapshots. If it is not @c null, then it was
4492	set by one of <link to="Console::takeSnapshot" />,
4493	<link to="Console::deleteSnapshot" />
4494	or <link to="Console::restoreSnapshot" />, depending on which
4495	was called last. See <link to="ISnapshot"/> for details.
4496	</desc>
4497	</attribute>
4498
4499	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4500	<desc>
4501	Number of snapshots taken on this machine. Zero means the
4502	machine doesn't have any snapshots.
4503	</desc>
4504	</attribute>
4505
4506	<attribute name="currentStateModified" type="boolean" readonly="yes">
4507	<desc>
4508	Returns @c true if the current state of the machine is not
4509	identical to the state stored in the current snapshot.
4510
4511	The current state is identical to the current snapshot only
4512	directly after one of the following calls are made:
4513
4514	<ul>
4515	<li><link to="IConsole::restoreSnapshot"/>
4516	</li>
4517	<li><link to="IConsole::takeSnapshot"/> (issued on a
4518	"powered off" or "saved" machine, for which
4519	<link to="#settingsModified"/> returns @c false)
4520	</li>
4521	<li><link to="IMachine::setCurrentSnapshot"/>
4522	</li>
4523	</ul>
4524
4525	The current state remains identical until one of the following
4526	happens:
4527	<ul>
4528	<li>settings of the machine are changed</li>
4529	<li>the saved state is discarded</li>
4530	<li>the current snapshot is discarded</li>
4531	<li>an attempt to execute the machine is made</li>
4532	</ul>
4533
4534	<note>
4535	For machines that don't have snapshots, this property is
4536	always @c false.
4537	</note>
4538	</desc>
4539	</attribute>
4540
4541	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4542	<desc>
4543	Collection of shared folders for this machine (permanent shared
4544	folders). These folders are shared automatically at machine startup
4545	and available only to the guest OS installed within this machine.
4546
4547	New shared folders are added to the collection using
4548	<link to="#createSharedFolder"/>. Existing shared folders can be
4549	removed using <link to="#removeSharedFolder"/>.
4550	</desc>
4551	</attribute>
4552
4553	<attribute name="clipboardMode" type="ClipboardMode">
4554	<desc>
4555	Synchronization mode between the host OS clipboard
4556	and the guest OS clipboard.
4557	</desc>
4558	</attribute>
4559
4560	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4561	<desc>
4562	A comma-separated list of simple glob patterns. Changes to guest
4563	properties whose name matches one of the patterns will generate an
4564	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4565	</desc>
4566	</attribute>
4567
4568	<attribute name="teleporterEnabled" type="boolean">
4569	<desc>
4570	When set to @a true, the virtual machine becomes a target teleporter
4571	the next time it is powered on. This can only set to @a true when the
4572	VM is in the @a PoweredOff or @a Aborted state.
4573
4574	This property is automatically set to @a false when the VM is powered
4575	on.
4576	</desc>
4577	</attribute>
4578
4579	<attribute name="teleporterPort" type="unsigned long">
4580	<desc>
4581	The TCP port the target teleporter will listen for incoming
4582	teleportations on.
4583
4584	0 means the port is automatically selected upon power on. The actual
4585	value can be read from this property while the machine is waiting for
4586	incoming teleportations.
4587	</desc>
4588	</attribute>
4589
4590	<attribute name="teleporterAddress" type="wstring">
4591	<desc>
4592	The address the target teleporter will listen on. If set to an empty
4593	string, it will listen on all addresses.
4594	</desc>
4595	</attribute>
4596
4597	<attribute name="teleporterPassword" type="wstring">
4598	<desc>
4599	The password the to check for on the target teleporter. This is just a
4600	very basic measure to prevent simple hacks and operators accidentally
4601	beaming a virtual machine to the wrong place.
4602	</desc>
4603	</attribute>
4604
4605	<method name="setBootOrder">
4606	<desc>
4607	Puts the given device to the specified position in
4608	the boot order.
4609
4610	To indicate that no device is associated with the given position,
4611	<link to="DeviceType_Null"/> should be used.
4612
4613	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4614
4615	<result name="E_INVALIDARG">
4616	Boot @a position out of range.
4617	</result>
4618	<result name="E_NOTIMPL">
4619	Booting from USB @a device currently not supported.
4620	</result>
4621
4622	</desc>
4623	<param name="position" type="unsigned long" dir="in">
4624	<desc>
4625	Position in the boot order (@c 1 to the total number of
4626	devices the machine can boot from, as returned by
4627	<link to="ISystemProperties::maxBootPosition"/>).
4628	</desc>
4629	</param>
4630	<param name="device" type="DeviceType" dir="in">
4631	<desc>
4632	The type of the device used to boot at the given position.
4633	</desc>
4634	</param>
4635	</method>
4636
4637	<method name="getBootOrder" const="yes">
4638	<desc>
4639	Returns the device type that occupies the specified
4640	position in the boot order.
4641
4642	@todo [remove?]
4643	If the machine can have more than one device of the returned type
4644	(such as hard disks), then a separate method should be used to
4645	retrieve the individual device that occupies the given position.
4646
4647	If here are no devices at the given position, then
4648	<link to="DeviceType_Null"/> is returned.
4649
4650	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4651
4652	<result name="E_INVALIDARG">
4653	Boot @a position out of range.
4654	</result>
4655
4656	</desc>
4657	<param name="position" type="unsigned long" dir="in">
4658	<desc>
4659	Position in the boot order (@c 1 to the total number of
4660	devices the machine can boot from, as returned by
4661	<link to="ISystemProperties::maxBootPosition"/>).
4662	</desc>
4663	</param>
4664	<param name="device" type="DeviceType" dir="return">
4665	<desc>
4666	Device at the given position.
4667	</desc>
4668	</param>
4669	</method>
4670
4671	<method name="attachDevice">
4672	<desc>
4673	Attaches a device and optionally mounts a medium to the given storage
4674	controller (<link to="IStorageController" />, identified by @a name),
4675	at the indicated port and device.
4676
4677	This method is intended for managing storage devices in general (it works
4678	for both fixed and removable media). For storage devices supporting removable
4679	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4680	for changing the media while the machine is running.
4681
4682	For the IDE bus, the @a controllerPort parameter can be either
4683	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4684	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4685	to specify the master or the slave device, respectively. (In the
4686	default configuration of virtual machines, the secondary master is
4687	used for a CD/DVD drive.)
4688
4689	For an SATA controller, @a controllerPort must be a number ranging
4690	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4691	be a number ranging from @c 0 to @c 15.
4692
4693	For both SCSI and SATA, the @a device parameter is unused and must
4694	be @c 0.
4695
4696	For fixed media such as hard disks, the given medium identifier cannot
4697	be a zero UUID. It may be a zero UUID for removable media such as DVDs
4698	and floppies.
4699
4700	After calling this returns successfully, a new instance of
4701	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4702	attachments (<link to="IMachine::mediumAttachments"/>).
4703
4704	The specified device slot must not have a device attached to it,
4705	or this method will fail.
4706
4707	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4708	information about attaching media.
4709
4710	<note>
4711	You cannot attach a device to a running machine. Also, you cannot
4712	attach a device to a newly created machine until this machine's
4713	settings are saved to disk using <link to="#saveSettings"/>.
4714	</note>
4715	<note>
4716	If the medium is being attached indirectly, a new differencing medium
4717	will implicitly be created for it and attached instead. If the
4718	changes made to the machine settings (including this indirect
4719	attachment) are later cancelled using <link to="#discardSettings"/>,
4720	this implicitly created differencing medium will implicitly
4721	be deleted.
4722	</note>
4723
4724	<result name="E_INVALIDARG">
4725	SATA device, SATA port, IDE port or IDE slot out of range.
4726	</result>
4727	<result name="VBOX_E_INVALID_OBJECT_STATE">
4728	Attempt to attach medium to an unregistered virtual machine.
4729	</result>
4730	<result name="VBOX_E_INVALID_VM_STATE">
4731	Invalid machine state.
4732	</result>
4733	<result name="VBOX_E_OBJECT_IN_USE">
4734	Hard disk already attached to this or another virtual machine.
4735	</result>
4736
4737	</desc>
4738	<param name="name" type="wstring" dir="in">
4739	<desc>Name of the storage controller to attach the device to.</desc>
4740	</param>
4741	<param name="controllerPort" type="long" dir="in">
4742	<desc>Port to attach the device to.</desc>
4743	</param>
4744	<param name="device" type="long" dir="in">
4745	<desc>Device slot in the given port to attach the device to.</desc>
4746	</param>
4747	<param name="type" type="DeviceType" dir="in">
4748	<desc>Device type of the attached device.</desc>
4749	</param>
4750	<param name="id" type="uuid" mod="string" dir="in">
4751	<desc>UUID of the medium to mount. Zero UUID means do not mount any
4752	medium.</desc>
4753	</param>
4754	</method>
4755
4756	<method name="detachDevice">
4757	<desc>
4758	Detaches the device attached to a device slot of the specified bus.
4759
4760	Detaching the device from the virtual machine is deferred. This means
4761	that the medium remains associated with the machine when this method
4762	returns and gets actually de-associated only after a successful
4763	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4764	for more detailed information about attaching media.
4765
4766	<note>
4767	You cannot detach a device from a running machine.
4768	</note>
4769	<note>
4770	Detaching differencing media implicitly created by <link
4771	to="#attachDevice"/> for the indirect attachment using this
4772	method will <b>not</b> implicitly delete them. The
4773	<link to="IMedium::deleteStorage"/> operation should be
4774	explicitly performed by the caller after the medium is successfully
4775	detached and the settings are saved with
4776	<link to="#saveSettings"/>, if it is the desired action.
4777	</note>
4778
4779	<result name="VBOX_E_INVALID_VM_STATE">
4780	Attempt to detach medium from a running virtual machine.
4781	</result>
4782	<result name="VBOX_E_OBJECT_NOT_FOUND">
4783	No medium attached to given slot/bus.
4784	</result>
4785	<result name="VBOX_E_NOT_SUPPORTED">
4786	Medium format does not support storage deletion.
4787	</result>
4788
4789	</desc>
4790	<param name="name" type="wstring" dir="in">
4791	<desc>Name of the storage controller to detach the medium from.</desc>
4792	</param>
4793	<param name="controllerPort" type="long" dir="in">
4794	<desc>Port number to detach the medium from.</desc>
4795	</param>
4796	<param name="device" type="long" dir="in">
4797	<desc>Device slot number to detach the medium from.</desc>
4798	</param>
4799	</method>
4800
4801	<method name="passthroughDevice">
4802	<desc>
4803	Sets the passthrough mode of an existing DVD device. Changing the
4804	setting while the VM is running is forbidden. The setting is only used
4805	if at VM start the device is configured as a host DVD drive, in all
4806	other cases it is ignored. The device must already exist; see
4807	<link to="IMachine::attachDevice"/> for how to attach a new device.
4808
4809	The @a controllerPort and @a device parameters specify the device slot and
4810	have have the same meaning as with <link to="IMachine::attachDevice" />.
4811
4812	<result name="E_INVALIDARG">
4813	SATA device, SATA port, IDE port or IDE slot out of range.
4814	</result>
4815	<result name="VBOX_E_INVALID_OBJECT_STATE">
4816	Attempt to modify an unregistered virtual machine.
4817	</result>
4818	<result name="VBOX_E_INVALID_VM_STATE">
4819	Invalid machine state.
4820	</result>
4821
4822	</desc>
4823	<param name="name" type="wstring" dir="in">
4824	<desc>Name of the storage controller.</desc>
4825	</param>
4826	<param name="controllerPort" type="long" dir="in">
4827	<desc>Storage controller port.</desc>
4828	</param>
4829	<param name="device" type="long" dir="in">
4830	<desc>Device slot in the given port.</desc>
4831	</param>
4832	<param name="passthrough" type="boolean" dir="in">
4833	<desc>New value for the passthrough setting.</desc>
4834	</param>
4835	</method>
4836
4837	<method name="mountMedium">
4838	<desc>
4839	Mounts a medium (<link to="IMedium" />, identified
4840	by the given UUID @a id) to the given storage controller
4841	(<link to="IStorageController" />, identified by @a name),
4842	at the indicated port and device. The device must already exist;
4843	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4844
4845	This method is intended only for managing removable media, where the
4846	device is fixed but media is changeable at runtime (such as DVDs
4847	and floppies). It cannot be used for fixed media such as hard disks.
4848
4849	The @a controllerPort and @a device parameters specify the device slot and
4850	have have the same meaning as with <link to="IMachine::attachDevice" />.
4851
4852	The specified device slot can have a medium mounted, which will be
4853	unmounted first. Specifying a zero UUID (or an empty string) for
4854	@a medium does just an unmount.
4855
4856	See <link to="IMedium"/> for more detailed information about
4857	attaching media.
4858
4859	<result name="E_INVALIDARG">
4860	SATA device, SATA port, IDE port or IDE slot out of range.
4861	</result>
4862	<result name="VBOX_E_INVALID_OBJECT_STATE">
4863	Attempt to attach medium to an unregistered virtual machine.
4864	</result>
4865	<result name="VBOX_E_INVALID_VM_STATE">
4866	Invalid machine state.
4867	</result>
4868	<result name="VBOX_E_OBJECT_IN_USE">
4869	Medium already attached to this or another virtual machine.
4870	</result>
4871
4872	</desc>
4873	<param name="name" type="wstring" dir="in">
4874	<desc>Name of the storage controller to attach the medium to.</desc>
4875	</param>
4876	<param name="controllerPort" type="long" dir="in">
4877	<desc>Port to attach the medium to.</desc>
4878	</param>
4879	<param name="device" type="long" dir="in">
4880	<desc>Device slot in the given port to attach the medium to.</desc>
4881	</param>
4882	<param name="medium" type="uuid" mod="string" dir="in">
4883	<desc>UUID of the medium to attach. A zero UUID means unmount the
4884	currently mounted medium.</desc>
4885	</param>
4886	<param name="force" type="boolean" dir="in">
4887	<desc>Allows to force unmount/mount of a medium which is locked by
4888	theDevice slot in the given port to attach the medium to.</desc>
4889	</param>
4890	</method>
4891
4892	<method name="getMedium" const="yes">
4893	<desc>
4894	Returns the virtual medium attached to a device slot of the specified
4895	bus.
4896
4897	Note that if the medium was indirectly attached by
4898	<link to="#mountMedium"/> to the given device slot then this
4899	method will return not the same object as passed to the
4900	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4901	more detailed information about mounting a medium.
4902
4903	<result name="VBOX_E_OBJECT_NOT_FOUND">
4904	No medium attached to given slot/bus.
4905	</result>
4906
4907	</desc>
4908	<param name="name" type="wstring" dir="in">
4909	<desc>Name of the storage controller the medium is attached to.</desc>
4910	</param>
4911	<param name="controllerPort" type="long" dir="in">
4912	<desc>Port to query.</desc>
4913	</param>
4914	<param name="device" type="long" dir="in">
4915	<desc>Device slot in the given port to query.</desc>
4916	</param>
4917	<param name="medium" type="IMedium" dir="return">
4918	<desc>Attached medium object.</desc>
4919	</param>
4920	</method>
4921
4922	<method name="getMediumAttachmentsOfController" const="yes">
4923	<desc>
4924	Returns an array of medium attachments which are attached to the
4925	the controller with the given name.
4926
4927	<result name="VBOX_E_OBJECT_NOT_FOUND">
4928	A storage controller with given name doesn't exist.
4929	</result>
4930	</desc>
4931	<param name="name" type="wstring" dir="in"/>
4932	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4933	</method>
4934
4935	<method name="getMediumAttachment" const="yes">
4936	<desc>
4937	Returns a medium attachment which corresponds to the controller with
4938	the given name, on the given port and device slot.
4939
4940	<result name="VBOX_E_OBJECT_NOT_FOUND">
4941	No attachment exists for the given controller/port/device combination.
4942	</result>
4943	</desc>
4944	<param name="name" type="wstring" dir="in"/>
4945	<param name="controllerPort" type="long" dir="in"/>
4946	<param name="device" type="long" dir="in"/>
4947	<param name="attachment" type="IMediumAttachment" dir="return"/>
4948	</method>
4949
4950	<method name="getNetworkAdapter" const="yes">
4951	<desc>
4952	Returns the network adapter associated with the given slot.
4953	Slots are numbered sequentially, starting with zero. The total
4954	number of adapters per machine is defined by the
4955	<link to="ISystemProperties::networkAdapterCount"/> property,
4956	so the maximum slot number is one less than that property's value.
4957
4958	<result name="E_INVALIDARG">
4959	Invalid @a slot number.
4960	</result>
4961
4962	</desc>
4963	<param name="slot" type="unsigned long" dir="in"/>
4964	<param name="adapter" type="INetworkAdapter" dir="return"/>
4965	</method>
4966
4967	<method name="addStorageController">
4968	<desc>
4969	Adds a new storage controller (SCSI or SATA controller) to the
4970	machine and returns it as an instance of
4971	<link to="IStorageController" />.
4972
4973	@a name identifies the controller for subsequent calls such as
4974	<link to="#getStorageControllerByName" />,
4975	<link to="#getStorageControllerByInstance" />,
4976	<link to="#removeStorageController" />,
4977	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4978
4979	After the controller has been added, you can set its exact
4980	type by setting the <link to="IStorageController::controllerType" />.
4981
4982	<result name="VBOX_E_OBJECT_IN_USE">
4983	A storage controller with given name exists already.
4984	</result>
4985	<result name="E_INVALIDARG">
4986	Invalid @a controllerType.
4987	</result>
4988	</desc>
4989	<param name="name" type="wstring" dir="in"/>
4990	<param name="connectionType" type="StorageBus" dir="in"/>
4991	<param name="controller" type="IStorageController" dir="return"/>
4992	</method>
4993
4994	<method name="getStorageControllerByName" const="yes">
4995	<desc>
4996	Returns a storage controller with the given name.
4997
4998	<result name="VBOX_E_OBJECT_NOT_FOUND">
4999	A storage controller with given name doesn't exist.
5000	</result>
5001	</desc>
5002	<param name="name" type="wstring" dir="in"/>
5003	<param name="storageController" type="IStorageController" dir="return"/>
5004	</method>
5005
5006	<method name="getStorageControllerByInstance" const="yes">
5007	<desc>
5008	Returns a storage controller with the given instance number.
5009
5010	<result name="VBOX_E_OBJECT_NOT_FOUND">
5011	A storage controller with given instance number doesn't exist.
5012	</result>
5013	</desc>
5014	<param name="instance" type="unsigned long" dir="in"/>
5015	<param name="storageController" type="IStorageController" dir="return"/>
5016	</method>
5017
5018	<method name="removeStorageController">
5019	<desc>
5020	Removes a storage controller from the machine.
5021
5022	<result name="VBOX_E_OBJECT_NOT_FOUND">
5023	A storage controller with given name doesn't exist.
5024	</result>
5025	</desc>
5026	<param name="name" type="wstring" dir="in"/>
5027	</method>
5028
5029	<method name="getSerialPort" const="yes">
5030	<desc>
5031	Returns the serial port associated with the given slot.
5032	Slots are numbered sequentially, starting with zero. The total
5033	number of serial ports per machine is defined by the
5034	<link to="ISystemProperties::serialPortCount"/> property,
5035	so the maximum slot number is one less than that property's value.
5036
5037	<result name="E_INVALIDARG">
5038	Invalid @a slot number.
5039	</result>
5040
5041	</desc>
5042	<param name="slot" type="unsigned long" dir="in"/>
5043	<param name="port" type="ISerialPort" dir="return"/>
5044	</method>
5045
5046	<method name="getParallelPort" const="yes">
5047	<desc>
5048	Returns the parallel port associated with the given slot.
5049	Slots are numbered sequentially, starting with zero. The total
5050	number of parallel ports per machine is defined by the
5051	<link to="ISystemProperties::parallelPortCount"/> property,
5052	so the maximum slot number is one less than that property's value.
5053
5054	<result name="E_INVALIDARG">
5055	Invalid @a slot number.
5056	</result>
5057
5058	</desc>
5059	<param name="slot" type="unsigned long" dir="in"/>
5060	<param name="port" type="IParallelPort" dir="return"/>
5061	</method>
5062
5063	<method name="getExtraDataKeys">
5064	<desc>
5065	Returns an array representing the machine-specific extra data keys
5066	which currently have values defined.
5067	</desc>
5068	<param name="value" type="wstring" dir="return" safearray="yes">
5069	<desc>Array of extra data keys.</desc>
5070	</param>
5071	</method>
5072
5073	<method name="getExtraData">
5074	<desc>
5075	Returns associated machine-specific extra data.
5076
5077	If the requested data @a key does not exist, this function will
5078	succeed and return an empty string in the @a value argument.
5079
5080	<result name="VBOX_E_FILE_ERROR">
5081	Settings file not accessible.
5082	</result>
5083	<result name="VBOX_E_XML_ERROR">
5084	Could not parse the settings file.
5085	</result>
5086
5087	</desc>
5088	<param name="key" type="wstring" dir="in">
5089	<desc>Name of the data key to get.</desc>
5090	</param>
5091	<param name="value" type="wstring" dir="return">
5092	<desc>Value of the requested data key.</desc>
5093	</param>
5094	</method>
5095
5096	<method name="setExtraData">
5097	<desc>
5098	Sets associated machine-specific extra data.
5099
5100	If you pass @c null or an empty string as a key @a value, the given
5101	@a key will be deleted.
5102
5103	<note>
5104	Before performing the actual data change, this method will ask all
5105	registered callbacks using the
5106	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
5107	notification for a permission. If one of the callbacks refuses the
5108	new value, the change will not be performed.
5109	</note>
5110	<note>
5111	On success, the
5112	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
5113	is called to inform all registered callbacks about a successful data
5114	change.
5115	</note>
5116	<note>
5117	This method can be called outside the machine session and therefore
5118	it's a caller's responsibility to handle possible race conditions
5119	when several clients change the same key at the same time.
5120	</note>
5121
5122	<result name="VBOX_E_FILE_ERROR">
5123	Settings file not accessible.
5124	</result>
5125	<result name="VBOX_E_XML_ERROR">
5126	Could not parse the settings file.
5127	</result>
5128
5129	</desc>
5130	<param name="key" type="wstring" dir="in">
5131	<desc>Name of the data key to set.</desc>
5132	</param>
5133	<param name="value" type="wstring" dir="in">
5134	<desc>Value to assign to the key.</desc>
5135	</param>
5136	</method>
5137
5138	<method name="getCpuProperty" const="yes">
5139	<desc>
5140	Returns the virtual CPU boolean value of the specified property.
5141
5142	<result name="E_INVALIDARG">
5143	Invalid property.
5144	</result>
5145
5146	</desc>
5147	<param name="property" type="CpuPropertyType" dir="in">
5148	<desc>
5149	Property type to query.
5150	</desc>
5151	</param>
5152	<param name="value" type="boolean" dir="return">
5153	<desc>
5154	Property value.
5155	</desc>
5156	</param>
5157	</method>
5158
5159	<method name="setCpuProperty">
5160	<desc>
5161	Sets the virtual CPU boolean value of the specified property.
5162
5163	<result name="E_INVALIDARG">
5164	Invalid property.
5165	</result>
5166
5167	</desc>
5168	<param name="property" type="CpuPropertyType" dir="in">
5169	<desc>
5170	Property type to query.
5171	</desc>
5172	</param>
5173	<param name="value" type="boolean" dir="in">
5174	<desc>
5175	Property value.
5176	</desc>
5177	</param>
5178	</method>
5179
5180	<method name="getCpuIdLeaf" const="yes">
5181	<desc>
5182	Returns the virtual CPU cpuid information for the specified leaf.
5183
5184	Currently supported index values for cpuid:
5185	Standard CPUID leafs: 0 - 0xA
5186	Extended CPUID leafs: 0x80000000 - 0x8000000A
5187
5188	See the Intel and AMD programmer's manuals for detailed information
5189	about the cpuid instruction and its leafs.
5190	<result name="E_INVALIDARG">
5191	Invalid id.
5192	</result>
5193
5194	</desc>
5195	<param name="id" type="unsigned long" dir="in">
5196	<desc>
5197	Cpuid leaf index.
5198	</desc>
5199	</param>
5200	<param name="valEax" type="unsigned long" dir="out">
5201	<desc>
5202	Cpuid leaf value for register eax.
5203	</desc>
5204	</param>
5205	<param name="valEbx" type="unsigned long" dir="out">
5206	<desc>
5207	Cpuid leaf value for register ebx.
5208	</desc>
5209	</param>
5210	<param name="valEcx" type="unsigned long" dir="out">
5211	<desc>
5212	Cpuid leaf value for register ecx.
5213	</desc>
5214	</param>
5215	<param name="valEdx" type="unsigned long" dir="out">
5216	<desc>
5217	Cpuid leaf value for register edx.
5218	</desc>
5219	</param>
5220	</method>
5221
5222	<method name="setCpuIdLeaf" const="yes">
5223	<desc>
5224	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5225	are not passed unmodified. VirtualBox clears features that it doesn't support.
5226
5227	Currently supported index values for cpuid:
5228	Standard CPUID leafs: 0 - 0xA
5229	Extended CPUID leafs: 0x80000000 - 0x8000000A
5230
5231	See the Intel and AMD programmer's manuals for detailed information
5232	about the cpuid instruction and its leafs.
5233
5234	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5235	random crashes inside VMs.
5236	<result name="E_INVALIDARG">
5237	Invalid id.
5238	</result>
5239
5240	</desc>
5241	<param name="id" type="unsigned long" dir="in">
5242	<desc>
5243	Cpuid leaf index.
5244	</desc>
5245	</param>
5246	<param name="valEax" type="unsigned long" dir="in">
5247	<desc>
5248	Cpuid leaf value for register eax.
5249	</desc>
5250	</param>
5251	<param name="valEbx" type="unsigned long" dir="in">
5252	<desc>
5253	Cpuid leaf value for register ebx.
5254	</desc>
5255	</param>
5256	<param name="valEcx" type="unsigned long" dir="in">
5257	<desc>
5258	Cpuid leaf value for register ecx.
5259	</desc>
5260	</param>
5261	<param name="valEdx" type="unsigned long" dir="in">
5262	<desc>
5263	Cpuid leaf value for register edx.
5264	</desc>
5265	</param>
5266	</method>
5267
5268	<method name="removeCpuIdLeaf" const="yes">
5269	<desc>
5270	Removes the virtual CPU cpuid leaf for the specified index
5271
5272	<result name="E_INVALIDARG">
5273	Invalid id.
5274	</result>
5275
5276	</desc>
5277	<param name="id" type="unsigned long" dir="in">
5278	<desc>
5279	Cpuid leaf index.
5280	</desc>
5281	</param>
5282	</method>
5283
5284	<method name="removeAllCpuIdLeafs" const="yes">
5285	<desc>
5286	Removes all the virtual CPU cpuid leafs
5287	</desc>
5288	</method>
5289
5290	<method name="getHWVirtExProperty" const="yes">
5291	<desc>
5292	Returns the value of the specified hardware virtualization boolean property.
5293
5294	<result name="E_INVALIDARG">
5295	Invalid property.
5296	</result>
5297
5298	</desc>
5299	<param name="property" type="HWVirtExPropertyType" dir="in">
5300	<desc>
5301	Property type to query.
5302	</desc>
5303	</param>
5304	<param name="value" type="boolean" dir="return">
5305	<desc>
5306	Property value.
5307	</desc>
5308	</param>
5309	</method>
5310
5311	<method name="setHWVirtExProperty">
5312	<desc>
5313	Sets a new value for the specified hardware virtualization boolean property.
5314
5315	<result name="E_INVALIDARG">
5316	Invalid property.
5317	</result>
5318
5319	</desc>
5320	<param name="property" type="HWVirtExPropertyType" dir="in">
5321	<desc>
5322	Property type to set.
5323	</desc>
5324	</param>
5325	<param name="value" type="boolean" dir="in">
5326	<desc>
5327	New property value.
5328	</desc>
5329	</param>
5330	</method>
5331
5332	<method name="saveSettings">
5333	<desc>
5334	Saves any changes to machine settings made since the session
5335	has been opened or a new machine has been created, or since the
5336	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5337	For registered machines, new settings become visible to all
5338	other VirtualBox clients after successful invocation of this
5339	method.
5340	<note>
5341	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
5342	notification event after the configuration has been successfully
5343	saved (only for registered machines).
5344	</note>
5345	<note>
5346	Calling this method is only valid on instances returned
5347	by <link to="ISession::machine"/> and on new machines
5348	created by <link to="IVirtualBox::createMachine"/> but not
5349	yet registered, or on unregistered machines after calling
5350	<link to="IVirtualBox::unregisterMachine"/>.
5351	</note>
5352
5353	<result name="VBOX_E_FILE_ERROR">
5354	Settings file not accessible.
5355	</result>
5356	<result name="VBOX_E_XML_ERROR">
5357	Could not parse the settings file.
5358	</result>
5359	<result name="E_ACCESSDENIED">
5360	Modification request refused.
5361	</result>
5362
5363	</desc>
5364	</method>
5365
5366	<method name="discardSettings">
5367	<desc>
5368	Discards any changes to the machine settings made since the session
5369	has been opened or since the last call to <link to="#saveSettings"/>
5370	or <link to="#discardSettings"/>.
5371	<note>
5372	Calling this method is only valid on instances returned
5373	by <link to="ISession::machine"/> and on new machines
5374	created by <link to="IVirtualBox::createMachine"/> or
5375	opened by <link to="IVirtualBox::openMachine"/> but not
5376	yet registered, or on unregistered machines after calling
5377	<link to="IVirtualBox::unregisterMachine"/>.
5378	</note>
5379
5380	<result name="VBOX_E_INVALID_VM_STATE">
5381	Virtual machine is not mutable.
5382	</result>
5383
5384	</desc>
5385	</method>
5386
5387	<method name="deleteSettings">
5388	<desc>
5389	Deletes the settings file of this machine from disk.
5390	The machine must not be registered in order for this operation
5391	to succeed.
5392	<note>
5393	<link to="#settingsModified"/> will return @c true after this
5394	method successfully returns.
5395	</note>
5396	<note>
5397	Calling this method is only valid on instances returned
5398	by <link to="ISession::machine"/> and on new machines
5399	created by <link to="IVirtualBox::createMachine"/> or
5400	opened by <link to="IVirtualBox::openMachine"/> but not
5401	yet registered, or on unregistered machines after calling
5402	<link to="IVirtualBox::unregisterMachine"/>.
5403	</note>
5404	<note>
5405	The deleted machine settings file can be restored (saved again)
5406	by calling <link to="#saveSettings"/>.
5407	</note>
5408
5409	<result name="VBOX_E_INVALID_VM_STATE">
5410	Cannot delete settings of a registered machine or
5411	machine not mutable.
5412	</result>
5413	<result name="VBOX_E_IPRT_ERROR">
5414	Could not delete the settings file.
5415	</result>
5416
5417	</desc>
5418	</method>
5419
5420	<method name="export">
5421	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5422	steps required to export VirtualBox machines to OVF.
5423	</desc>
5424
5425	<param name="aAppliance" type="IAppliance" dir="in">
5426	<desc>Appliance to export this machine to.</desc>
5427	</param>
5428	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5429	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5430	</param>
5431	</method >
5432
5433	<method name="getSnapshot">
5434	<desc>
5435	Returns a snapshot of this machine with the given UUID.
5436	A @c null UUID can be used to obtain the first snapshot
5437	taken on this machine. This is useful if you want to traverse
5438	the whole tree of snapshots starting from the root.
5439
5440	<result name="VBOX_E_OBJECT_NOT_FOUND">
5441	Virtual machine has no snapshots or snapshot not found.
5442	</result>
5443
5444	</desc>
5445	<param name="id" type="uuid" mod="string" dir="in">
5446	<desc>UUID of the snapshot to get</desc>
5447	</param>
5448	<param name="snapshot" type="ISnapshot" dir="return">
5449	<desc>Snapshot object with the given UUID.</desc>
5450	</param>
5451	</method>
5452
5453	<method name="findSnapshot">
5454	<desc>
5455	Returns a snapshot of this machine with the given name.
5456
5457	<result name="VBOX_E_OBJECT_NOT_FOUND">
5458	Virtual machine has no snapshots or snapshot not found.
5459	</result>
5460
5461	</desc>
5462	<param name="name" type="wstring" dir="in">
5463	<desc>Name of the snapshot to find</desc>
5464	</param>
5465	<param name="snapshot" type="ISnapshot" dir="return">
5466	<desc>Snapshot object with the given name.</desc>
5467	</param>
5468	</method>
5469
5470	<method name="setCurrentSnapshot">
5471	<desc>
5472	Sets the current snapshot of this machine.
5473	<note>
5474	In the current implementation, this operation is not
5475	implemented.
5476	</note>
5477	</desc>
5478	<param name="id" type="uuid" mod="string" dir="in">
5479	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5480	</param>
5481	</method>
5482
5483	<method name="createSharedFolder">
5484	<desc>
5485	Creates a new permanent shared folder by associating the given logical
5486	name with the given host path, adds it to the collection of shared
5487	folders and starts sharing it. Refer to the description of
5488	<link to="ISharedFolder"/> to read more about logical names.
5489
5490	<result name="VBOX_E_OBJECT_IN_USE">
5491	Shared folder already exists.
5492	</result>
5493	<result name="VBOX_E_FILE_ERROR">
5494	Shared folder @a hostPath not accessible.
5495	</result>
5496
5497	</desc>
5498	<param name="name" type="wstring" dir="in">
5499	<desc>Unique logical name of the shared folder.</desc>
5500	</param>
5501	<param name="hostPath" type="wstring" dir="in">
5502	<desc>Full path to the shared folder in the host file system.</desc>
5503	</param>
5504	<param name="writable" type="boolean" dir="in">
5505	<desc>Whether the share is writable or readonly</desc>
5506	</param>
5507	</method>
5508
5509	<method name="removeSharedFolder">
5510	<desc>
5511	Removes the permanent shared folder with the given name previously
5512	created by <link to="#createSharedFolder"/> from the collection of
5513	shared folders and stops sharing it.
5514
5515	<result name="VBOX_E_INVALID_VM_STATE">
5516	Virtual machine is not mutable.
5517	</result>
5518	<result name="VBOX_E_OBJECT_NOT_FOUND">
5519	Shared folder @a name does not exist.
5520	</result>
5521
5522	</desc>
5523	<param name="name" type="wstring" dir="in">
5524	<desc>Logical name of the shared folder to remove.</desc>
5525	</param>
5526	</method>
5527
5528	<method name="canShowConsoleWindow">
5529	<desc>
5530	Returns @c true if the VM console process can activate the
5531	console window and bring it to foreground on the desktop of
5532	the host PC.
5533	<note>
5534	This method will fail if a session for this machine is not
5535	currently open.
5536	</note>
5537
5538	<result name="VBOX_E_INVALID_VM_STATE">
5539	Machine session is not open.
5540	</result>
5541
5542	</desc>
5543	<param name="canShow" type="boolean" dir="return">
5544	<desc>
5545	@c true if the console window can be shown and @c false otherwise.
5546	</desc>
5547	</param>
5548	</method>
5549
5550	<method name="showConsoleWindow">
5551	<desc>
5552	Activates the console window and brings it to foreground on
5553	the desktop of the host PC. Many modern window managers on
5554	many platforms implement some sort of focus stealing
5555	prevention logic, so that it may be impossible to activate
5556	a window without the help of the currently active
5557	application. In this case, this method will return a non-zero
5558	identifier that represents the top-level window of the VM
5559	console process. The caller, if it represents a currently
5560	active process, is responsible to use this identifier (in a
5561	platform-dependent manner) to perform actual window
5562	activation.
5563	<note>
5564	This method will fail if a session for this machine is not
5565	currently open.
5566	</note>
5567
5568	<result name="VBOX_E_INVALID_VM_STATE">
5569	Machine session is not open.
5570	</result>
5571
5572	</desc>
5573	<param name="winId" type="unsigned long long" dir="return">
5574	<desc>
5575	Platform-dependent identifier of the top-level VM console
5576	window, or zero if this method has performed all actions
5577	necessary to implement the <i>show window</i> semantics for
5578	the given platform and/or VirtualBox front-end.
5579	</desc>
5580	</param>
5581	</method>
5582
5583	<method name="getGuestProperty">
5584	<desc>
5585	Reads an entry from the machine's guest property store.
5586
5587	<result name="VBOX_E_INVALID_VM_STATE">
5588	Machine session is not open.
5589	</result>
5590
5591	</desc>
5592	<param name="name" type="wstring" dir="in">
5593	<desc>
5594	The name of the property to read.
5595	</desc>
5596	</param>
5597	<param name="value" type="wstring" dir="out">
5598	<desc>
5599	The value of the property. If the property does not exist then this
5600	will be empty.
5601	</desc>
5602	</param>
5603	<param name="timestamp" type="unsigned long long" dir="out">
5604	<desc>
5605	The time at which the property was last modified, as seen by the
5606	server process.
5607	</desc>
5608	</param>
5609	<param name="flags" type="wstring" dir="out">
5610	<desc>
5611	Additional property parameters, passed as a comma-separated list of
5612	"name=value" type entries.
5613	</desc>
5614	</param>
5615	</method>
5616
5617	<method name="getGuestPropertyValue">
5618	<desc>
5619	Reads a value from the machine's guest property store.
5620
5621	<result name="VBOX_E_INVALID_VM_STATE">
5622	Machine session is not open.
5623	</result>
5624
5625	</desc>
5626	<param name="property" type="wstring" dir="in">
5627	<desc>
5628	The name of the property to read.
5629	</desc>
5630	</param>
5631	<param name="value" type="wstring" dir="return">
5632	<desc>
5633	The value of the property. If the property does not exist then this
5634	will be empty.
5635	</desc>
5636	</param>
5637	</method>
5638
5639	<method name="getGuestPropertyTimestamp">
5640	<desc>
5641	Reads a property timestamp from the machine's guest property store.
5642
5643	<result name="VBOX_E_INVALID_VM_STATE">
5644	Machine session is not open.
5645	</result>
5646
5647	</desc>
5648	<param name="property" type="wstring" dir="in">
5649	<desc>
5650	The name of the property to read.
5651	</desc>
5652	</param>
5653	<param name="value" type="unsigned long long" dir="return">
5654	<desc>
5655	The timestamp. If the property does not exist then this will be
5656	empty.
5657	</desc>
5658	</param>
5659	</method>
5660
5661	<method name="setGuestProperty">
5662	<desc>
5663	Sets, changes or deletes an entry in the machine's guest property
5664	store.
5665
5666	<result name="E_ACCESSDENIED">
5667	Property cannot be changed.
5668	</result>
5669	<result name="E_INVALIDARG">
5670	Invalid @a flags.
5671	</result>
5672	<result name="VBOX_E_INVALID_VM_STATE">
5673	Virtual machine is not mutable or session not open.
5674	</result>
5675	<result name="VBOX_E_INVALID_OBJECT_STATE">
5676	Cannot set transient property when machine not running.
5677	</result>
5678
5679	</desc>
5680	<param name="property" type="wstring" dir="in">
5681	<desc>
5682	The name of the property to set, change or delete.
5683	</desc>
5684	</param>
5685	<param name="value" type="wstring" dir="in">
5686	<desc>
5687	The new value of the property to set, change or delete. If the
5688	property does not yet exist and value is non-empty, it will be
5689	created. If the value is @c null or empty, the property will be
5690	deleted if it exists.
5691	</desc>
5692	</param>
5693	<param name="flags" type="wstring" dir="in">
5694	<desc>
5695	Additional property parameters, passed as a comma-separated list of
5696	"name=value" type entries.
5697	</desc>
5698	</param>
5699	</method>
5700
5701	<method name="setGuestPropertyValue">
5702	<desc>
5703	Sets, changes or deletes a value in the machine's guest property
5704	store. The flags field will be left unchanged or created empty for a
5705	new property.
5706
5707	<result name="E_ACCESSDENIED">
5708	Property cannot be changed.
5709	</result>
5710	<result name="VBOX_E_INVALID_VM_STATE">
5711	Virtual machine is not mutable or session not open.
5712	</result>
5713	<result name="VBOX_E_INVALID_OBJECT_STATE">
5714	Cannot set transient property when machine not running.
5715	</result>
5716	</desc>
5717
5718	<param name="property" type="wstring" dir="in">
5719	<desc>
5720	The name of the property to set, change or delete.
5721	</desc>
5722	</param>
5723	<param name="value" type="wstring" dir="in">
5724	<desc>
5725	The new value of the property to set, change or delete. If the
5726	property does not yet exist and value is non-empty, it will be
5727	created. If the value is @c null or empty, the property will be
5728	deleted if it exists.
5729	</desc>
5730	</param>
5731	</method>
5732
5733	<method name="enumerateGuestProperties">
5734	<desc>
5735	Return a list of the guest properties matching a set of patterns along
5736	with their values, time stamps and flags.
5737	</desc>
5738	<param name="patterns" type="wstring" dir="in">
5739	<desc>
5740	The patterns to match the properties against, separated by '\|'
5741	characters. If this is empty or @c null, all properties will match.
5742	</desc>
5743	</param>
5744	<param name="name" type="wstring" dir="out" safearray="yes">
5745	<desc>
5746	The names of the properties returned.
5747	</desc>
5748	</param>
5749	<param name="value" type="wstring" dir="out" safearray="yes">
5750	<desc>
5751	The values of the properties returned. The array entries match the
5752	corresponding entries in the @a name array.
5753	</desc>
5754	</param>
5755	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5756	<desc>
5757	The time stamps of the properties returned. The array entries match
5758	the corresponding entries in the @a name array.
5759	</desc>
5760	</param>
5761	<param name="flags" type="wstring" dir="out" safearray="yes">
5762	<desc>
5763	The flags of the properties returned. The array entries match the
5764	corresponding entries in the @a name array.
5765	</desc>
5766	</param>
5767	</method>
5768
5769	<method name="querySavedThumbnailSize">
5770	<desc>
5771	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5772	</desc>
5773	<param name="size" type="unsigned long" dir="out">
5774	<desc>
5775	Size of buffer required to store the bitmap.
5776	</desc>
5777	</param>
5778	<param name="width" type="unsigned long" dir="out">
5779	<desc>
5780	Bitmap width.
5781	</desc>
5782	</param>
5783	<param name="height" type="unsigned long" dir="out">
5784	<desc>
5785	Bitmap height.
5786	</desc>
5787	</param>
5788	</method>
5789
5790	<method name="readSavedThumbnail">
5791	<desc>
5792	Reads a saved thumbnail bitmap from saved state.
5793	A pixel consists of 4 bytes in order: B, G, R, 0.
5794
5795	<note>This API can be used only by the COM/XPCOM C++ API as it
5796	requires pointer support. Use <link to="#readSavedThumbnailToArray" />
5797	with other language bindings.
5798	</note>
5799	</desc>
5800	<param name="address" type="octet" mod="ptr" dir="in">
5801	<desc>
5802	Buffer allocated by caller. Size must be at least equal
5803	to value returned by querySavedThumbnailSize.
5804	</desc>
5805	</param>
5806	<param name="size" type="unsigned long" dir="in">
5807	<desc>
5808	Size of buffer allocated by caller. If the buffer is too small,
5809	the method fails.
5810	</desc>
5811	</param>
5812	</method>
5813
5814	<method name="readSavedThumbnailToArray">
5815	<desc>
5816	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit RGBA format.
5817	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
5818
5819	This API is slow, but could be the only option to get image
5820	for scriptable languages not allowed to manipulate with addresses
5821	directly.
5822	</desc>
5823	<param name="width" type="unsigned long" dir="out">
5824	<desc>
5825	Bitmap width.
5826	</desc>
5827	</param>
5828	<param name="height" type="unsigned long" dir="out">
5829	<desc>
5830	Bitmap height.
5831	</desc>
5832	</param>
5833	<param name="data" type="octet" dir="return" safearray="yes">
5834	<desc>
5835	Array with resulting bitmap data.
5836	</desc>
5837	</param>
5838	</method>
5839
5840	<method name="querySavedScreenshotPNGSize">
5841	<desc>
5842	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5843	</desc>
5844	<param name="size" type="unsigned long" dir="out">
5845	<desc>
5846	Size of buffer required to store the PNG binary data.
5847	</desc>
5848	</param>
5849	<param name="width" type="unsigned long" dir="out">
5850	<desc>
5851	Image width.
5852	</desc>
5853	</param>
5854	<param name="height" type="unsigned long" dir="out">
5855	<desc>
5856	Image height.
5857	</desc>
5858	</param>
5859	</method>
5860
5861	<method name="readSavedScreenshotPNG">
5862	<desc>
5863	Reads a saved screenshot in PNG format from saved state.
5864
5865	<note>This API can be used only by the COM/XPCOM C++ API as it
5866	requires pointer support. Use <link to="#readSavedScreenshotPNGToArray" />
5867	with other language bindings.
5868	</note>
5869	</desc>
5870	<param name="address" type="octet" mod="ptr" dir="in">
5871	<desc>
5872	Buffer allocated by caller. Size must be at least equal
5873	to value returned by querySavedScreenshotPNGSize.
5874	</desc>
5875	</param>
5876	<param name="size" type="unsigned long" dir="in">
5877	<desc>
5878	Size of buffer allocated by caller. If the buffer is too small,
5879	the method fails.
5880	</desc>
5881	</param>
5882	</method>
5883
5884	<method name="readSavedScreenshotPNGToArray">
5885	<desc>
5886	Screenshot in PNG format is retrieved to an array of bytes.
5887
5888	This API is slow, but could be the only option to get image
5889	for scriptable languages not allowed to manipulate with addresses
5890	directly.
5891	</desc>
5892	<param name="width" type="unsigned long" dir="out">
5893	<desc>
5894	Image width.
5895	</desc>
5896	</param>
5897	<param name="height" type="unsigned long" dir="out">
5898	<desc>
5899	Image height.
5900	</desc>
5901	</param>
5902	<param name="data" type="octet" dir="return" safearray="yes">
5903	<desc>
5904	Array with resulting PNG data.
5905	</desc>
5906	</param>
5907	</method>
5908	</interface>
5909
5910	<!--
5911	// IConsole
5912	/////////////////////////////////////////////////////////////////////////
5913	-->
5914
5915	<interface
5916	name="IConsoleCallback" extends="$unknown"
5917	uuid="d6239535-bda2-4ef7-83f4-f4722e4a3b2c"
5918	wsmap="suppress"
5919	>
5920
5921	<desc>
5922	This interface is used by a client of the Main API that need to
5923	be notified of events. For example, a graphical user interface
5924	can use this to learn about machine state changes so they can
5925	update the list of virtual machines without having to rely
5926	on polling.
5927
5928	Whenever relevant events occur in VirtualBox, the callbacks in
5929	objects of this interface are called. In order for this to be
5930	useful, a client needs to create its own subclass that implements
5931	this interface in which the methods for the relevant callbacks
5932	are overridden. An instance of this subclass interface can then
5933	be passed to <link to="IConsole::registerCallback" />.
5934	</desc>
5935
5936	<method name="onMousePointerShapeChange">
5937	<desc>
5938	Notification when the guest mouse pointer shape has
5939	changed. The new shape data is given.
5940	</desc>
5941	<param name="visible" type="boolean" dir="in">
5942	<desc>
5943	Flag whether the pointer is visible.
5944	</desc>
5945	</param>
5946	<param name="alpha" type="boolean" dir="in">
5947	<desc>
5948	Flag whether the pointer has an alpha channel.
5949	</desc>
5950	</param>
5951	<param name="xHot" type="unsigned long" dir="in">
5952	<desc>
5953	The pointer hot spot x coordinate.
5954	</desc>
5955	</param>
5956	<param name="yHot" type="unsigned long" dir="in">
5957	<desc>
5958	The pointer hot spot y coordinate.
5959	</desc>
5960	</param>
5961	<param name="width" type="unsigned long" dir="in">
5962	<desc>
5963	Width of the pointer shape in pixels.
5964	</desc>
5965	</param>
5966	<param name="height" type="unsigned long" dir="in">
5967	<desc>
5968	Height of the pointer shape in pixels.
5969	</desc>
5970	</param>
5971	<param name="shape" type="octet" mod="ptr" dir="in">
5972	<desc>
5973	Address of the shape buffer.
5974
5975	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
5976	followed by a 32-bpp XOR (color) mask.
5977
5978	For pointers without alpha channel the XOR mask pixels are 32
5979	bit values: (lsb)BGR0(msb). For pointers with alpha channel
5980	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
5981
5982	An AND mask is used for pointers with alpha channel, so if the
5983	callback does not support alpha, the pointer could be
5984	displayed as a normal color pointer.
5985
5986	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
5987	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
5988	height</tt>. The padding bits at the end of each scanline are
5989	undefined.
5990
5991	The XOR mask follows the AND mask on the next 4-byte aligned
5992	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
5993	Bytes in the gap between the AND and the XOR mask are undefined.
5994	The XOR mask scanlines have no gap between them and the size of
5995	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
5996
5997	<note>
5998	If @a shape is 0, only the pointer visibility is changed.
5999	</note>
6000	</desc>
6001	</param>
6002	</method>
6003
6004	<method name="onMouseCapabilityChange">
6005	<desc>
6006	Notification when the mouse capabilities reported by the
6007	guest have changed. The new capabilities are passed.
6008	</desc>
6009	<param name="supportsAbsolute" type="boolean" dir="in"/>
6010	<param name="needsHostCursor" type="boolean" dir="in"/>
6011	</method>
6012
6013	<method name="onKeyboardLedsChange">
6014	<desc>
6015	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
6016	to alter the state of the keyboard LEDs.
6017	</desc>
6018	<param name="numLock" type="boolean" dir="in"/>
6019	<param name="capsLock" type="boolean" dir="in"/>
6020	<param name="scrollLock" type="boolean" dir="in"/>
6021	</method>
6022
6023	<method name="onStateChange">
6024	<desc>
6025	Notification when the execution state of the machine has changed.
6026	The new state will be given.
6027	</desc>
6028	<param name="state" type="MachineState" dir="in"/>
6029	</method>
6030
6031	<method name="onAdditionsStateChange">
6032	<desc>
6033	Notification when a Guest Additions property changes.
6034	Interested callees should query IGuest attributes to
6035	find out what has changed.
6036	</desc>
6037	</method>
6038
6039	<method name="onNetworkAdapterChange">
6040	<desc>
6041	Notification when a property of one of the
6042	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
6043	changes. Interested callees should use INetworkAdapter methods and
6044	attributes to find out what has changed.
6045	</desc>
6046	<param name="networkAdapter" type="INetworkAdapter" dir="in">
6047	<desc>Network adapter that is subject to change.</desc>
6048	</param>
6049	</method>
6050
6051	<method name="onSerialPortChange">
6052	<desc>
6053	Notification when a property of one of the
6054	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
6055	Interested callees should use ISerialPort methods and attributes
6056	to find out what has changed.
6057	</desc>
6058	<param name="serialPort" type="ISerialPort" dir="in">
6059	<desc>Serial port that is subject to change.</desc>
6060	</param>
6061	</method>
6062
6063	<method name="onParallelPortChange">
6064	<desc>
6065	Notification when a property of one of the
6066	virtual <link to="IMachine::getParallelPort">parallel ports</link>
6067	changes. Interested callees should use ISerialPort methods and
6068	attributes to find out what has changed.
6069	</desc>
6070	<param name="parallelPort" type="IParallelPort" dir="in">
6071	<desc>Parallel port that is subject to change.</desc>
6072	</param>
6073	</method>
6074
6075	<method name="onStorageControllerChange">
6076	<desc>
6077	Notification when a property of one of the
6078	virtual <link to="IMachine::storageControllers">storage controllers</link>
6079	changes. Interested callees should query the corresponding collections
6080	to find out what has changed.
6081	</desc>
6082	</method>
6083
6084	<method name="onMediumChange">
6085	<desc>
6086	Notification when a
6087	<link to="IMachine::mediumAttachments">medium attachment</link>
6088	changes.
6089	</desc>
6090	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
6091	<desc>Medium attachment that is subject to change.</desc>
6092	</param>
6093	</method>
6094
6095	<method name="onVRDPServerChange">
6096	<desc>
6097	Notification when a property of the
6098	<link to="IMachine::VRDPServer">VRDP server</link> changes.
6099	Interested callees should use IVRDPServer methods and attributes to
6100	find out what has changed.
6101	</desc>
6102	</method>
6103
6104	<method name="onRemoteDisplayInfoChange">
6105	<desc>
6106	Notification when the status of the VRDP server changes. Interested callees
6107	should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
6108	attributes to find out what is the current status.
6109	</desc>
6110	</method>
6111
6112	<method name="onUSBControllerChange">
6113	<desc>
6114	Notification when a property of the virtual
6115	<link to="IMachine::USBController">USB controller</link> changes.
6116	Interested callees should use IUSBController methods and attributes to
6117	find out what has changed.
6118	</desc>
6119	</method>
6120
6121	<method name="onUSBDeviceStateChange">
6122	<desc>
6123	Notification when a USB device is attached to or detached from
6124	the virtual USB controller.
6125
6126	This notification is sent as a result of the indirect
6127	request to attach the device because it matches one of the
6128	machine USB filters, or as a result of the direct request
6129	issued by <link to="IConsole::attachUSBDevice"/> or
6130	<link to="IConsole::detachUSBDevice"/>.
6131
6132	This notification is sent in case of both a succeeded and a
6133	failed request completion. When the request succeeds, the
6134	@a error parameter is @c null, and the given device has been
6135	already added to (when @a attached is @c true) or removed from
6136	(when @a attached is @c false) the collection represented by
6137	<link to="IConsole::USBDevices"/>. On failure, the collection
6138	doesn't change and the @a error parameter represents the error
6139	message describing the failure.
6140
6141	</desc>
6142	<param name="device" type="IUSBDevice" dir="in">
6143	<desc>Device that is subject to state change.</desc>
6144	</param>
6145	<param name="attached" type="boolean" dir="in">
6146	<desc>
6147	@c true if the device was attached and @c false otherwise.
6148	</desc>
6149	</param>
6150	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
6151	<desc>
6152	@c null on success or an error message object on failure.
6153	</desc>
6154	</param>
6155	</method>
6156
6157	<method name="onSharedFolderChange">
6158	<desc>
6159	Notification when a shared folder is added or removed.
6160	The @a scope argument defines one of three scopes:
6161	<link to="IVirtualBox::sharedFolders">global shared folders</link>
6162	(<link to="Scope_Global">Global</link>),
6163	<link to="IMachine::sharedFolders">permanent shared folders</link> of
6164	the machine (<link to="Scope_Machine">Machine</link>) or <link
6165	to="IConsole::sharedFolders">transient shared folders</link> of the
6166	machine (<link to="Scope_Session">Session</link>). Interested callees
6167	should use query the corresponding collections to find out what has
6168	changed.
6169	</desc>
6170	<param name="scope" type="Scope" dir="in">
6171	<desc>Scope of the notification.</desc>
6172	</param>
6173	</method>
6174
6175	<method name="onRuntimeError">
6176	<desc>
6177	Notification when an error happens during the virtual
6178	machine execution.
6179
6180	There are three kinds of runtime errors:
6181	<ul>
6182	<li><i>fatal</i></li>
6183	<li><i>non-fatal with retry</i></li>
6184	<li><i>non-fatal warnings</i></li>
6185	</ul>
6186
6187	<b>Fatal</b> errors are indicated by the @a fatal parameter set
6188	to @c true. In case of fatal errors, the virtual machine
6189	execution is always paused before calling this notification, and
6190	the notification handler is supposed either to immediately save
6191	the virtual machine state using <link to="IConsole::saveState"/>
6192	or power it off using <link to="IConsole::powerDown"/>.
6193	Resuming the execution can lead to unpredictable results.
6194
6195	<b>Non-fatal</b> errors and warnings are indicated by the
6196	@a fatal parameter set to @c false. If the virtual machine
6197	is in the Paused state by the time the error notification is
6198	received, it means that the user can <i>try to resume</i> the machine
6199	execution after attempting to solve the problem that caused the
6200	error. In this case, the notification handler is supposed
6201	to show an appropriate message to the user (depending on the
6202	value of the @a id parameter) that offers several actions such
6203	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
6204	wants to retry, the notification handler should continue
6205	the machine execution using the <link to="IConsole::resume"/>
6206	call. If the machine execution is not Paused during this
6207	notification, then it means this notification is a <i>warning</i>
6208	(for example, about a fatal condition that can happen very soon);
6209	no immediate action is required from the user, the machine
6210	continues its normal execution.
6211
6212	Note that in either case the notification handler
6213	<b>must not</b> perform any action directly on a thread
6214	where this notification is called. Everything it is allowed to
6215	do is to post a message to another thread that will then talk
6216	to the user and take the corresponding action.
6217
6218	Currently, the following error identifiers are known:
6219	<ul>
6220	<li><tt>"HostMemoryLow"</tt></li>
6221	<li><tt>"HostAudioNotResponding"</tt></li>
6222	<li><tt>"VDIStorageFull"</tt></li>
6223	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
6224	</ul>
6225
6226	<note>
6227	This notification is not designed to be implemented by
6228	more than one callback at a time. If you have multiple
6229	IConsoleCallback instances registered on the given
6230	IConsole object, make sure you simply do nothing but
6231	return @c S_OK from all but one of them that does actual
6232	user notification and performs necessary actions.
6233	</note>
6234
6235	</desc>
6236	<param name="fatal" type="boolean" dir="in">
6237	<desc>Whether the error is fatal or not</desc>
6238	</param>
6239	<param name="id" type="wstring" dir="in">
6240	<desc>Error identifier</desc>
6241	</param>
6242	<param name="message" type="wstring" dir="in">
6243	<desc>Optional error message</desc>
6244	</param>
6245	</method>
6246
6247	<method name="onCanShowWindow">
6248	<desc>
6249	Notification when a call to
6250	<link to="IMachine::canShowConsoleWindow"/> is made by a
6251	front-end to check if a subsequent call to
6252	<link to="IMachine::showConsoleWindow"/> can succeed.
6253
6254	The callee should give an answer appropriate to the current
6255	machine state in the @a canShow argument. This answer must
6256	remain valid at least until the next
6257	<link to="IConsole::state">machine state</link> change.
6258
6259	<note>
6260	This notification is not designed to be implemented by
6261	more than one callback at a time. If you have multiple
6262	IConsoleCallback instances registered on the given
6263	IConsole object, make sure you simply do nothing but
6264	return @c true and @c S_OK from all but one of them that
6265	actually manages console window activation.
6266	</note>
6267	</desc>
6268	<param name="canShow" type="boolean" dir="return">
6269	<desc>
6270	@c true if the console window can be shown and @c false otherwise.
6271	</desc>
6272	</param>
6273	</method>
6274
6275	<method name="onShowWindow">
6276	<desc>
6277	Notification when a call to
6278	<link to="IMachine::showConsoleWindow"/>
6279	requests the console window to be activated and brought to
6280	foreground on the desktop of the host PC.
6281
6282	This notification should cause the VM console process to
6283	perform the requested action as described above. If it is
6284	impossible to do it at a time of this notification, this
6285	method should return a failure.
6286
6287	Note that many modern window managers on many platforms
6288	implement some sort of focus stealing prevention logic, so
6289	that it may be impossible to activate a window without the
6290	help of the currently active application (which is supposedly
6291	an initiator of this notification). In this case, this method
6292	must return a non-zero identifier that represents the
6293	top-level window of the VM console process. The caller, if it
6294	represents a currently active process, is responsible to use
6295	this identifier (in a platform-dependent manner) to perform
6296	actual window activation.
6297
6298	This method must set @a winId to zero if it has performed all
6299	actions necessary to complete the request and the console
6300	window is now active and in foreground, to indicate that no
6301	further action is required on the caller's side.
6302
6303	<note>
6304	This notification is not designed to be implemented by
6305	more than one callback at a time. If you have multiple
6306	IConsoleCallback instances registered on the given
6307	IConsole object, make sure you simply do nothing but
6308	return @c S_OK from all but one of them that actually
6309	manages console window activation.
6310	</note>
6311	</desc>
6312	<param name="winId" type="unsigned long long" dir="return">
6313	<desc>
6314	Platform-dependent identifier of the top-level VM console
6315	window, or zero if this method has performed all actions
6316	necessary to implement the <i>show window</i> semantics for
6317	the given platform and/or this VirtualBox front-end.
6318	</desc>
6319	</param>
6320	</method>
6321
6322	</interface>
6323
6324	<interface
6325	name="IRemoteDisplayInfo" extends="$unknown"
6326	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
6327	wsmap="struct"
6328	>
6329	<desc>
6330	Contains information about the remote display (VRDP) capabilities and status.
6331	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
6332	</desc>
6333
6334	<attribute name="active" type="boolean" readonly="yes">
6335	<desc>
6336	Whether the remote display connection is active.
6337	</desc>
6338	</attribute>
6339
6340	<attribute name="port" type="long" readonly="yes">
6341	<desc>
6342	VRDP server port number. If this property is equal to <tt>0</tt>, then
6343	the VRDP server failed to start, usually because there are no free TCP
6344	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
6345	server has not yet been started.
6346	</desc>
6347	</attribute>
6348
6349	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6350	<desc>
6351	How many times a client connected.
6352	</desc>
6353	</attribute>
6354
6355	<attribute name="beginTime" type="long long" readonly="yes">
6356	<desc>
6357	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6358	</desc>
6359	</attribute>
6360
6361	<attribute name="endTime" type="long long" readonly="yes">
6362	<desc>
6363	When the last connection was terminated or the current time, if
6364	connection is still active, in milliseconds since 1970-01-01 UTC.
6365	</desc>
6366	</attribute>
6367
6368	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
6369	<desc>
6370	How many bytes were sent in last or current, if still active, connection.
6371	</desc>
6372	</attribute>
6373
6374	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
6375	<desc>
6376	How many bytes were sent in all connections.
6377	</desc>
6378	</attribute>
6379
6380	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
6381	<desc>
6382	How many bytes were received in last or current, if still active, connection.
6383	</desc>
6384	</attribute>
6385
6386	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
6387	<desc>
6388	How many bytes were received in all connections.
6389	</desc>
6390	</attribute>
6391
6392	<attribute name="user" type="wstring" readonly="yes">
6393	<desc>
6394	Login user name supplied by the client.
6395	</desc>
6396	</attribute>
6397
6398	<attribute name="domain" type="wstring" readonly="yes">
6399	<desc>
6400	Login domain name supplied by the client.
6401	</desc>
6402	</attribute>
6403
6404	<attribute name="clientName" type="wstring" readonly="yes">
6405	<desc>
6406	The client name supplied by the client.
6407	</desc>
6408	</attribute>
6409
6410	<attribute name="clientIP" type="wstring" readonly="yes">
6411	<desc>
6412	The IP address of the client.
6413	</desc>
6414	</attribute>
6415
6416	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6417	<desc>
6418	The client software version number.
6419	</desc>
6420	</attribute>
6421
6422	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6423	<desc>
6424	Public key exchange method used when connection was established.
6425	Values: 0 - RDP4 public key exchange scheme.
6426	1 - X509 certificates were sent to client.
6427	</desc>
6428	</attribute>
6429
6430	</interface>
6431
6432	<interface
6433	name="IConsole" extends="$unknown"
6434	uuid="55dd56a5-1d1d-4d81-b742-b082b9571be6"
6435	wsmap="managed"
6436	>
6437	<desc>
6438	The IConsole interface represents an interface to control virtual
6439	machine execution.
6440
6441	The console object that implements the IConsole interface is obtained
6442	from a session object after the session for the given machine has been
6443	opened using one of <link to="IVirtualBox::openSession"/>,
6444	<link to="IVirtualBox::openRemoteSession"/> or
6445	<link to="IVirtualBox::openExistingSession"/> methods.
6446
6447	Methods of the IConsole interface allow the caller to query the current
6448	virtual machine execution state, pause the machine or power it down, save
6449	the machine state or take a snapshot, attach and detach removable media
6450	and so on.
6451
6452	<see>ISession</see>
6453	</desc>
6454
6455	<attribute name="machine" type="IMachine" readonly="yes">
6456	<desc>
6457	Machine object this console is sessioned with.
6458	<note>
6459	This is a convenience property, it has the same value as
6460	<link to="ISession::machine"/> of the corresponding session
6461	object.
6462	</note>
6463	</desc>
6464	</attribute>
6465
6466	<attribute name="state" type="MachineState" readonly="yes">
6467	<desc>
6468	Current execution state of the machine.
6469	<note>
6470	This property always returns the same value as the corresponding
6471	property of the IMachine object this console is sessioned with.
6472	For the process that owns (executes) the VM, this is the
6473	preferable way of querying the VM state, because no IPC
6474	calls are made.
6475	</note>
6476	</desc>
6477	</attribute>
6478
6479	<attribute name="guest" type="IGuest" readonly="yes">
6480	<desc>Guest object.</desc>
6481	</attribute>
6482
6483	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6484	<desc>
6485	Virtual keyboard object.
6486	<note>
6487	If the machine is not running, any attempt to use
6488	the returned object will result in an error.
6489	</note>
6490	</desc>
6491	</attribute>
6492
6493	<attribute name="mouse" type="IMouse" readonly="yes">
6494	<desc>
6495	Virtual mouse object.
6496	<note>
6497	If the machine is not running, any attempt to use
6498	the returned object will result in an error.
6499	</note>
6500	</desc>
6501	</attribute>
6502
6503	<attribute name="display" type="IDisplay" readonly="yes">
6504	<desc>Virtual display object.
6505	<note>
6506	If the machine is not running, any attempt to use
6507	the returned object will result in an error.
6508	</note>
6509	</desc>
6510	</attribute>
6511
6512	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6513	<desc>Debugging interface.</desc>
6514	</attribute>
6515
6516	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6517	<desc>
6518	Collection of USB devices currently attached to the virtual
6519	USB controller.
6520	<note>
6521	The collection is empty if the machine is not running.
6522	</note>
6523	</desc>
6524	</attribute>
6525
6526	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6527	<desc>
6528	List of USB devices currently attached to the remote VRDP client.
6529	Once a new device is physically attached to the remote host computer,
6530	it appears in this list and remains there until detached.
6531	</desc>
6532	</attribute>
6533
6534	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6535	<desc>
6536	Collection of shared folders for the current session. These folders
6537	are called transient shared folders because they are available to the
6538	guest OS running inside the associated virtual machine only for the
6539	duration of the session (as opposed to
6540	<link to="IMachine::sharedFolders"/> which represent permanent shared
6541	folders). When the session is closed (e.g. the machine is powered down),
6542	these folders are automatically discarded.
6543
6544	New shared folders are added to the collection using
6545	<link to="#createSharedFolder"/>. Existing shared folders can be
6546	removed using <link to="#removeSharedFolder"/>.
6547	</desc>
6548	</attribute>
6549
6550	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6551	<desc>
6552	Interface that provides information on Remote Display (VRDP) connection.
6553	</desc>
6554	</attribute>
6555
6556	<method name="powerUp">
6557	<desc>
6558	Starts the virtual machine execution using the current machine
6559	state (that is, its current execution state, current settings and
6560	current storage devices).
6561
6562	If the machine is powered off or aborted, the execution will
6563	start from the beginning (as if the real hardware were just
6564	powered on).
6565
6566	If the machine is in the <link to="MachineState_Saved"/> state,
6567	it will continue its execution the point where the state has
6568	been saved.
6569
6570	<note>
6571	Unless you are trying to write a new VirtualBox front-end that
6572	performs direct machine execution (like the VirtualBox or VBoxSDL
6573	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6574	session opened by <link to="IVirtualBox::openSession"/> and use this
6575	session only to change virtual machine settings. If you simply want to
6576	start virtual machine execution using one of the existing front-ends
6577	(for example the VirtualBox GUI or headless server), simply use
6578	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6579	power up the machine automatically for you.
6580	</note>
6581
6582	<see>#saveState</see>
6583	<result name="VBOX_E_INVALID_VM_STATE">
6584	Virtual machine already running.
6585	</result>
6586	<result name="VBOX_E_HOST_ERROR">
6587	Host interface does not exist or name not set.
6588	</result>
6589	<result name="VBOX_E_FILE_ERROR">
6590	Invalid saved state file.
6591	</result>
6592	</desc>
6593	<param name="progress" type="IProgress" dir="return">
6594	<desc>Progress object to track the operation completion.</desc>
6595	</param>
6596	</method>
6597
6598	<method name="powerUpPaused">
6599	<desc>
6600	Identical to powerUp except that the VM will enter the
6601	<link to="MachineState_Paused"/> state, instead of
6602	<link to="MachineState_Running"/>.
6603
6604	<see>#powerUp</see>
6605	<result name="VBOX_E_INVALID_VM_STATE">
6606	Virtual machine already running.
6607	</result>
6608	<result name="VBOX_E_HOST_ERROR">
6609	Host interface does not exist or name not set.
6610	</result>
6611	<result name="VBOX_E_FILE_ERROR">
6612	Invalid saved state file.
6613	</result>
6614	</desc>
6615	<param name="progress" type="IProgress" dir="return">
6616	<desc>Progress object to track the operation completion.</desc>
6617	</param>
6618	</method>
6619
6620	<method name="powerDown">
6621	<desc>
6622	Initiates the power down procedure to stop the virtual machine
6623	execution.
6624
6625	The completion of the power down procedure is tracked using the returned
6626	IProgress object. After the operation is complete, the machine will go
6627	to the PoweredOff state.
6628	<result name="VBOX_E_INVALID_VM_STATE">
6629	Virtual machine must be Running, Paused or Stuck to be powered down.
6630	</result>
6631	</desc>
6632	<param name="progress" type="IProgress" dir="return">
6633	<desc>Progress object to track the operation completion.</desc>
6634	</param>
6635	</method>
6636
6637	<method name="reset">
6638	<desc>Resets the virtual machine.
6639	<result name="VBOX_E_INVALID_VM_STATE">
6640	Virtual machine not in Running state.
6641	</result>
6642	<result name="VBOX_E_VM_ERROR">
6643	Virtual machine error in reset operation.
6644	</result>
6645	</desc>
6646	</method>
6647
6648	<method name="pause">
6649	<desc>Pauses the virtual machine execution.
6650	<result name="VBOX_E_INVALID_VM_STATE">
6651	Virtual machine not in Running state.
6652	</result>
6653	<result name="VBOX_E_VM_ERROR">
6654	Virtual machine error in suspend operation.
6655	</result>
6656	</desc>
6657	</method>
6658
6659	<method name="resume">
6660	<desc>Resumes the virtual machine execution.
6661	<result name="VBOX_E_INVALID_VM_STATE">
6662	Virtual machine not in Paused state.
6663	</result>
6664	<result name="VBOX_E_VM_ERROR">
6665	Virtual machine error in resume operation.
6666	</result>
6667	</desc>
6668	</method>
6669
6670	<method name="powerButton">
6671	<desc>Sends the ACPI power button event to the guest.
6672	<result name="VBOX_E_INVALID_VM_STATE">
6673	Virtual machine not in Running state.
6674	</result>
6675	<result name="VBOX_E_PDM_ERROR">
6676	Controlled power off failed.
6677	</result>
6678	</desc>
6679	</method>
6680
6681	<method name="sleepButton">
6682	<desc>Sends the ACPI sleep button event to the guest.
6683	<result name="VBOX_E_INVALID_VM_STATE">
6684	Virtual machine not in Running state.
6685	</result>
6686	<result name="VBOX_E_PDM_ERROR">
6687	Sending sleep button event failed.
6688	</result>
6689	</desc>
6690	</method>
6691
6692	<method name="getPowerButtonHandled">
6693	<desc>Checks if the last power button event was handled by guest.
6694	<result name="VBOX_E_PDM_ERROR">
6695	Checking if the event was handled by the guest OS failed.
6696	</result>
6697	</desc>
6698	<param name="handled" type="boolean" dir="return"/>
6699	</method>
6700
6701	<method name="getGuestEnteredACPIMode">
6702	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6703	G1 (sleeping). If this method returns @c false, the guest will
6704	most likely not respond to external ACPI events.
6705	<result name="VBOX_E_INVALID_VM_STATE">
6706	Virtual machine not in Running state.
6707	</result>
6708	</desc>
6709	<param name="entered" type="boolean" dir="return"/>
6710	</method>
6711
6712	<method name="saveState">
6713	<desc>
6714	Saves the current execution state of a running virtual machine
6715	and stops its execution.
6716
6717	After this operation completes, the machine will go to the
6718	Saved state. Next time it is powered up, this state will
6719	be restored and the machine will continue its execution from
6720	the place where it was saved.
6721
6722	This operation differs from taking a snapshot to the effect
6723	that it doesn't create new differencing media. Also, once
6724	the machine is powered up from the state saved using this method,
6725	the saved state is deleted, so it will be impossible to return
6726	to this state later.
6727
6728	<note>
6729	On success, this method implicitly calls
6730	<link to="IMachine::saveSettings"/> to save all current machine
6731	settings (including runtime changes to the DVD medium, etc.).
6732	Together with the impossibility to change any VM settings when it is
6733	in the Saved state, this guarantees adequate hardware
6734	configuration of the machine when it is restored from the saved
6735	state file.
6736	</note>
6737
6738	<note>
6739	The machine must be in the Running or Paused state, otherwise
6740	the operation will fail.
6741	</note>
6742	<result name="VBOX_E_INVALID_VM_STATE">
6743	Virtual machine state neither Running nor Paused.
6744	</result>
6745	<result name="VBOX_E_FILE_ERROR">
6746	Failed to create directory for saved state file.
6747	</result>
6748
6749	<see><link to="#takeSnapshot"/></see>
6750	</desc>
6751	<param name="progress" type="IProgress" dir="return">
6752	<desc>Progress object to track the operation completion.</desc>
6753	</param>
6754	</method>
6755
6756	<method name="adoptSavedState">
6757	<desc>
6758	Associates the given saved state file to the virtual machine.
6759
6760	On success, the machine will go to the Saved state. Next time it is
6761	powered up, it will be restored from the adopted saved state and
6762	continue execution from the place where the saved state file was
6763	created.
6764
6765	The specified saved state file path may be absolute or relative to the
6766	folder the VM normally saves the state to (usually,
6767	<link to="IMachine::snapshotFolder"/>).
6768
6769	<note>
6770	It's a caller's responsibility to make sure the given saved state
6771	file is compatible with the settings of this virtual machine that
6772	represent its virtual hardware (memory size, storage disk configuration
6773	etc.). If there is a mismatch, the behavior of the virtual machine
6774	is undefined.
6775	</note>
6776	<result name="VBOX_E_INVALID_VM_STATE">
6777	Virtual machine state neither PoweredOff nor Aborted.
6778	</result>
6779	</desc>
6780	<param name="savedStateFile" type="wstring" dir="in">
6781	<desc>Path to the saved state file to adopt.</desc>
6782	</param>
6783	</method>
6784
6785	<method name="forgetSavedState">
6786	<desc>
6787	Forgets the saved state of the virtual machine previously created
6788	by <link to="#saveState"/>. Next time the machine is powered up, a
6789	clean boot will occur. If @a remove is @c true the saved state file
6790	is deleted.
6791	<note>
6792	This operation is equivalent to resetting or powering off
6793	the machine without doing a proper shutdown in the guest OS.
6794	</note>
6795	<result name="VBOX_E_INVALID_VM_STATE">
6796	Virtual machine not in state Saved.
6797	</result>
6798	</desc>
6799	<param name="remove" type="boolean" dir="in">
6800	<desc>If @c true remove the saved state file.</desc>
6801	</param>
6802	</method>
6803
6804	<method name="getDeviceActivity">
6805	<desc>
6806	Gets the current activity type of a given device or device group.
6807	<result name="E_INVALIDARG">
6808	Invalid device type.
6809	</result>
6810	</desc>
6811	<param name="type" type="DeviceType" dir="in"/>
6812	<param name="activity" type="DeviceActivity" dir="return"/>
6813	</method>
6814
6815	<method name="attachUSBDevice">
6816	<desc>
6817	Attaches a host USB device with the given UUID to the
6818	USB controller of the virtual machine.
6819
6820	The device needs to be in one of the following states:
6821	<link to="USBDeviceState_Busy"/>,
6822	<link to="USBDeviceState_Available"/> or
6823	<link to="USBDeviceState_Held"/>,
6824	otherwise an error is immediately returned.
6825
6826	When the device state is
6827	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6828	be returned if the host computer refuses to release it for some reason.
6829
6830	<see>IUSBController::deviceFilters, USBDeviceState</see>
6831	<result name="VBOX_E_INVALID_VM_STATE">
6832	Virtual machine state neither Running nor Paused.
6833	</result>
6834	<result name="VBOX_E_PDM_ERROR">
6835	Virtual machine does not have a USB controller.
6836	</result>
6837	</desc>
6838	<param name="id" type="uuid" mod="string" dir="in">
6839	<desc>UUID of the host USB device to attach.</desc>
6840	</param>
6841	</method>
6842
6843	<method name="detachUSBDevice">
6844	<desc>
6845	Detaches an USB device with the given UUID from the USB controller
6846	of the virtual machine.
6847
6848	After this method succeeds, the VirtualBox server re-initiates
6849	all USB filters as if the device were just physically attached
6850	to the host, but filters of this machine are ignored to avoid
6851	a possible automatic re-attachment.
6852
6853	<see>IUSBController::deviceFilters, USBDeviceState</see>
6854
6855	<result name="VBOX_E_PDM_ERROR">
6856	Virtual machine does not have a USB controller.
6857	</result>
6858	<result name="E_INVALIDARG">
6859	USB device not attached to this virtual machine.
6860	</result>
6861	</desc>
6862	<param name="id" type="uuid" mod="string" dir="in">
6863	<desc>UUID of the USB device to detach.</desc>
6864	</param>
6865	<param name="device" type="IUSBDevice" dir="return">
6866	<desc>Detached USB device.</desc>
6867	</param>
6868	</method>
6869
6870	<method name="findUSBDeviceByAddress">
6871	<desc>
6872	Searches for a USB device with the given host address.
6873
6874	<result name="VBOX_E_OBJECT_NOT_FOUND">
6875	Given @c name does not correspond to any USB device.
6876	</result>
6877
6878	<see>IUSBDevice::address</see>
6879	</desc>
6880	<param name="name" type="wstring" dir="in">
6881	<desc>
6882	Address of the USB device (as assigned by the host) to
6883	search for.
6884	</desc>
6885	</param>
6886	<param name="device" type="IUSBDevice" dir="return">
6887	<desc>Found USB device object.</desc>
6888	</param>
6889	</method>
6890
6891	<method name="findUSBDeviceById">
6892	<desc>
6893	Searches for a USB device with the given UUID.
6894
6895	<result name="VBOX_E_OBJECT_NOT_FOUND">
6896	Given @c id does not correspond to any USB device.
6897	</result>
6898
6899	<see>IUSBDevice::id</see>
6900	</desc>
6901	<param name="id" type="uuid" mod="string" dir="in">
6902	<desc>UUID of the USB device to search for.</desc>
6903	</param>
6904	<param name="device" type="IUSBDevice" dir="return">
6905	<desc>Found USB device object.</desc>
6906	</param>
6907	</method>
6908
6909	<method name="createSharedFolder">
6910	<desc>
6911	Creates a transient new shared folder by associating the given logical
6912	name with the given host path, adds it to the collection of shared
6913	folders and starts sharing it. Refer to the description of
6914	<link to="ISharedFolder"/> to read more about logical names.
6915
6916	<result name="VBOX_E_INVALID_VM_STATE">
6917	Virtual machine in Saved state or currently changing state.
6918	</result>
6919	<result name="VBOX_E_FILE_ERROR">
6920	Shared folder already exists or not accessible.
6921	</result>
6922	</desc>
6923	<param name="name" type="wstring" dir="in">
6924	<desc>Unique logical name of the shared folder.</desc>
6925	</param>
6926	<param name="hostPath" type="wstring" dir="in">
6927	<desc>Full path to the shared folder in the host file system.</desc>
6928	</param>
6929	<param name="writable" type="boolean" dir="in">
6930	<desc>Whether the share is writable or readonly</desc>
6931	</param>
6932	</method>
6933
6934	<method name="removeSharedFolder">
6935	<desc>
6936	Removes a transient shared folder with the given name previously
6937	created by <link to="#createSharedFolder"/> from the collection of
6938	shared folders and stops sharing it.
6939	<result name="VBOX_E_INVALID_VM_STATE">
6940	Virtual machine in Saved state or currently changing state.
6941	</result>
6942	<result name="VBOX_E_FILE_ERROR">
6943	Shared folder does not exists.
6944	</result>
6945	</desc>
6946	<param name="name" type="wstring" dir="in">
6947	<desc>Logical name of the shared folder to remove.</desc>
6948	</param>
6949	</method>
6950
6951	<method name="takeSnapshot">
6952	<desc>
6953	Saves the current execution state
6954	and all settings of the machine and creates differencing images
6955	for all normal (non-independent) media.
6956	See <link to="ISnapshot" /> for an introduction to snapshots.
6957
6958	This method can be called for a PoweredOff, Saved (see
6959	<link to="#saveState"/>), Running or
6960	Paused virtual machine. When the machine is PoweredOff, an
6961	offline snapshot is created. When the machine is Running a live
6962	snapshot is created, and an online snapshot is is created when Paused.
6963
6964	The taken snapshot is always based on the
6965	<link to="IMachine::currentSnapshot">current snapshot</link>
6966	of the associated virtual machine and becomes a new current snapshot.
6967
6968	<note>
6969	This method implicitly calls <link to="IMachine::saveSettings"/> to
6970	save all current machine settings before taking an offline snapshot.
6971	</note>
6972
6973	<result name="VBOX_E_INVALID_VM_STATE">
6974	Virtual machine currently changing state.
6975	</result>
6976	</desc>
6977	<param name="name" type="wstring" dir="in">
6978	<desc>Short name for the snapshot.</desc>
6979	</param>
6980	<param name="description" type="wstring" dir="in">
6981	<desc>Optional description of the snapshot.</desc>
6982	</param>
6983	<param name="progress" type="IProgress" dir="return">
6984	<desc>Progress object to track the operation completion.</desc>
6985	</param>
6986	</method>
6987
6988	<method name="deleteSnapshot">
6989	<desc>
6990	Starts discarding the specified snapshot asynchronously.
6991	See <link to="ISnapshot" /> for an introduction to snapshots.
6992
6993	The execution state and settings of the associated machine stored in
6994	the snapshot will be deleted. The contents of all differencing media of
6995	this snapshot will be merged with the contents of their dependent child
6996	media to keep the medium chain valid (in other words, all changes
6997	represented by media being discarded will be propagated to their child
6998	medium). After that, this snapshot's differencing medium will be
6999	deleted. The parent of this snapshot will become a new parent for all
7000	its child snapshots.
7001
7002	If the discarded snapshot is the current one, its parent
7003	snapshot will become a new current snapshot. The current machine
7004	state is not directly affected in this case, except that
7005	currently attached differencing media based on media
7006	of the discarded snapshot will be also merged as described
7007	above.
7008
7009	If the discarded snapshot is the first one (the root snapshot)
7010	and it has exactly one child snapshot, this child snapshot will
7011	become the first snapshot after discarding. If there are no
7012	children at all (i.e. the first snapshot is the only snapshot of
7013	the machine), both the current and the first snapshot of the
7014	machine will be set to @c null. In all other cases, the first
7015	snapshot cannot be discarded.
7016
7017	You cannot discard the snapshot if it
7018	stores <link to="MediumType_Normal">normal</link> (non-differencing)
7019	media that have differencing media based on them. Snapshots of
7020	such kind can be discarded only when every normal medium has either
7021	no children at all or exactly one child. In the former case, the normal
7022	medium simply becomes unused (i.e. not attached to any VM). In the
7023	latter case, it receives all the changes stored in the child medium,
7024	and then it replaces the child medium in the configuration of the
7025	corresponding snapshot or machine.
7026
7027	Also, you cannot discard the snapshot if it stores media
7028	(of any type) having differencing child media that belong
7029	to other machines. Such snapshots can be only discarded after
7030	you discard all snapshots of other machines containing "foreign"
7031	child media, or detach these "foreign" child media from machines
7032	they are attached to.
7033
7034	One particular example of the snapshot storing normal media
7035	is the first snapshot of a virtual machine that had normal media
7036	attached when taking the snapshot. Be careful when
7037	discarding such snapshots because this implicitly commits
7038	changes (made since the snapshot being discarded has been taken)
7039	to normal media (as described above), which may be not what
7040	you want.
7041
7042	The virtual machine is put to
7043	the <link to="MachineState_Discarding">Discarding</link> state until
7044	the discard operation is completed.
7045
7046	<note>
7047	The machine must not be running, otherwise the operation
7048	will fail.
7049	</note>
7050
7051	<note>
7052	Child media of all normal media of the discarded snapshot
7053	must be accessible (see <link to="IMedium::state"/>) for this
7054	operation to succeed. In particular, this means that all virtual
7055	machines, whose media are directly or indirectly based on the
7056	media of discarded snapshot, must be powered off.
7057	</note>
7058	<note>
7059	Merging medium contents can be very time and disk space
7060	consuming, if these media are big in size and have many
7061	children. However, if the snapshot being discarded is the last
7062	(head) snapshot on the branch, the operation will be rather
7063	quick.
7064	</note>
7065	<note>
7066	Note that discarding the current snapshot
7067	will implicitly call <link to="IMachine::saveSettings"/> to
7068	make all current machine settings permanent.
7069	</note>
7070	<result name="VBOX_E_INVALID_VM_STATE">
7071	Virtual machine is running.
7072	</result>
7073	</desc>
7074	<param name="id" type="uuid" mod="string" dir="in">
7075	<desc>UUID of the snapshot to discard.</desc>
7076	</param>
7077	<param name="progress" type="IProgress" dir="return">
7078	<desc>Progress object to track the operation completion.</desc>
7079	</param>
7080	</method>
7081
7082	<method name="restoreSnapshot">
7083	<desc>
7084	Starts resetting the machine's current state to the state contained
7085	in the given snapshot, asynchronously. All current settings of the
7086	machine will be reset and changes stored in differencing media
7087	will be lost.
7088	See <link to="ISnapshot" /> for an introduction to snapshots.
7089
7090	After this operation is successfully completed, new empty differencing
7091	media are created for all normal media of the machine.
7092
7093	If the given snapshot is an online snapshot, the machine will go to
7094	the <link to="MachineState_Saved"> saved state</link>, so that the
7095	next time it is powered on, the execution state will be restored
7096	from the state of the snapshot.
7097
7098	<note>
7099	The machine must not be running, otherwise the operation will fail.
7100	</note>
7101
7102	<note>
7103	If the machine state is <link to="MachineState_Saved">Saved</link>
7104	prior to this operation, the saved state file will be implicitly
7105	discarded (as if <link to="IConsole::forgetSavedState"/> were
7106	called).
7107	</note>
7108
7109	<result name="VBOX_E_INVALID_VM_STATE">
7110	Virtual machine is running.
7111	</result>
7112	</desc>
7113	<param name="snapshot" type="ISnapshot" dir="in">
7114	<desc>The snapshot to restore the VM state from.</desc>
7115	</param>
7116	<param name="progress" type="IProgress" dir="return">
7117	<desc>Progress object to track the operation completion.</desc>
7118	</param>
7119	</method>
7120
7121	<method name="teleport">
7122	<desc>
7123	Teleport the VM to a different host machine or process.
7124
7125	TODO explain the details.
7126
7127	<result name="VBOX_E_INVALID_VM_STATE">
7128	Virtual machine not running or paused.
7129	</result>
7130	</desc>
7131	<param name="hostname" type="wstring" dir="in">
7132	<desc>The name or IP of the host to teleport to.</desc>
7133	</param>
7134	<param name="tcpport" type="unsigned long" dir="in">
7135	<desc>The TCP port to connect to (1..65535).</desc>
7136	</param>
7137	<param name="password" type="wstring" dir="in">
7138	<desc>The password.</desc>
7139	</param>
7140	<param name="progress" type="IProgress" dir="return">
7141	<desc>Progress object to track the operation completion.</desc>
7142	</param>
7143	</method>
7144
7145	<method name="registerCallback">
7146	<desc>
7147	Registers a new console callback on this instance. The methods of the
7148	callback interface will be called by this instance when the appropriate
7149	event occurs.
7150	</desc>
7151	<param name="callback" type="IConsoleCallback" dir="in"/>
7152	</method>
7153
7154	<method name="unregisterCallback">
7155	<desc>
7156	Unregisters the console callback previously registered using
7157	<link to="#registerCallback"/>.
7158	<result name="E_INVALIDARG">
7159	Given @a callback handler is not registered.
7160	</result>
7161	</desc>
7162	<param name="callback" type="IConsoleCallback" dir="in"/>
7163	</method>
7164	</interface>
7165
7166	<!--
7167	// IHost
7168	/////////////////////////////////////////////////////////////////////////
7169	-->
7170
7171	<enum
7172	name="HostNetworkInterfaceMediumType"
7173	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7174	>
7175	<desc>
7176	Type of encapsulation. Ethernet encapsulation includes both wired and
7177	wireless Ethernet connections.
7178	<see>IHostNetworkInterface</see>
7179	</desc>
7180
7181	<const name="Unknown" value="0">
7182	<desc>
7183	The type of interface cannot be determined.
7184	</desc>
7185	</const>
7186	<const name="Ethernet" value="1">
7187	<desc>
7188	Ethernet frame encapsulation.
7189	</desc>
7190	</const>
7191	<const name="PPP" value="2">
7192	<desc>
7193	Point-to-point protocol encapsulation.
7194	</desc>
7195	</const>
7196	<const name="SLIP" value="3">
7197	<desc>
7198	Serial line IP encapsulation.
7199	</desc>
7200	</const>
7201	</enum>
7202
7203	<enum
7204	name="HostNetworkInterfaceStatus"
7205	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7206	>
7207	<desc>
7208	Current status of the interface.
7209	<see>IHostNetworkInterface</see>
7210	</desc>
7211
7212	<const name="Unknown" value="0">
7213	<desc>
7214	The state of interface cannot be determined.
7215	</desc>
7216	</const>
7217	<const name="Up" value="1">
7218	<desc>
7219	The interface is fully operational.
7220	</desc>
7221	</const>
7222	<const name="Down" value="2">
7223	<desc>
7224	The interface is not functioning.
7225	</desc>
7226	</const>
7227	</enum>
7228
7229	<enum
7230	name="HostNetworkInterfaceType"
7231	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7232	>
7233	<desc>
7234	Network interface type.
7235	</desc>
7236	<const name="Bridged" value="1"/>
7237	<const name="HostOnly" value="2"/>
7238	</enum>
7239
7240	<interface
7241	name="IHostNetworkInterface" extends="$unknown"
7242	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7243	wsmap="managed"
7244	>
7245	<desc>
7246	Represents one of host's network interfaces. IP V6 address and network
7247	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7248	separated by colons.
7249	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7250	</desc>
7251	<attribute name="name" type="wstring" readonly="yes">
7252	<desc>Returns the host network interface name.</desc>
7253	</attribute>
7254
7255	<attribute name="id" type="uuid" mod="string" readonly="yes">
7256	<desc>Returns the interface UUID.</desc>
7257	</attribute>
7258
7259	<attribute name="networkName" type="wstring" readonly="yes">
7260	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7261	</attribute>
7262
7263	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7264	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7265	</attribute>
7266
7267	<attribute name="IPAddress" type="wstring" readonly="yes">
7268	<desc>Returns the IP V4 address of the interface.</desc>
7269	</attribute>
7270
7271	<attribute name="networkMask" type="wstring" readonly="yes">
7272	<desc>Returns the network mask of the interface.</desc>
7273	</attribute>
7274
7275	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7276	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7277	</attribute>
7278
7279	<attribute name="IPV6Address" type="wstring" readonly="yes">
7280	<desc>Returns the IP V6 address of the interface.</desc>
7281	</attribute>
7282
7283	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7284	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7285	</attribute>
7286
7287	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7288	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7289	</attribute>
7290
7291	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7292	<desc>Type of protocol encapsulation used.</desc>
7293	</attribute>
7294
7295	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7296	<desc>Status of the interface.</desc>
7297	</attribute>
7298
7299	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7300	<desc>specifies the host interface type.</desc>
7301	</attribute>
7302
7303	<method name="enableStaticIpConfig">
7304	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7305	<param name="IPAddress" type="wstring" dir="in">
7306	<desc>
7307	IP address.
7308	</desc>
7309	</param>
7310	<param name="networkMask" type="wstring" dir="in">
7311	<desc>
7312	network mask.
7313	</desc>
7314	</param>
7315	</method>
7316
7317	<method name="enableStaticIpConfigV6">
7318	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7319	<param name="IPV6Address" type="wstring" dir="in">
7320	<desc>
7321	IP address.
7322	</desc>
7323	</param>
7324	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7325	<desc>
7326	network mask.
7327	</desc>
7328	</param>
7329	</method>
7330
7331	<method name="enableDynamicIpConfig">
7332	<desc>enables the dynamic IP configuration.</desc>
7333	</method>
7334
7335	<method name="dhcpRediscover">
7336	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7337	</method>
7338
7339	</interface>
7340
7341	<interface
7342	name="IHost" extends="$unknown"
7343	uuid="e380cbfc-ae65-4fa6-899e-45ded6b3132a"
7344	wsmap="managed"
7345	>
7346	<desc>
7347	The IHost interface represents the physical machine that this VirtualBox
7348	installation runs on.
7349
7350	An object implementing this interface is returned by the
7351	<link to="IVirtualBox::host" /> attribute. This interface contains
7352	read-only information about the host's physical hardware (such as what
7353	processors and disks are available, what the host operating system is,
7354	and so on) and also allows for manipulating some of the host's hardware,
7355	such as global USB device filters and host interface networking.
7356
7357	</desc>
7358	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7359	<desc>List of DVD drives available on the host.</desc>
7360	</attribute>
7361
7362	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7363	<desc>List of floppy drives available on the host.</desc>
7364	</attribute>
7365
7366	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7367	<desc>
7368	List of USB devices currently attached to the host.
7369	Once a new device is physically attached to the host computer,
7370	it appears in this list and remains there until detached.
7371
7372	<note>
7373	If USB functionality is not available in the given edition of
7374	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7375	</note>
7376	</desc>
7377	</attribute>
7378
7379	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7380	<desc>
7381	List of USB device filters in action.
7382	When a new device is physically attached to the host computer,
7383	filters from this list are applied to it (in order they are stored
7384	in the list). The first matched filter will determine the
7385	<link to="IHostUSBDeviceFilter::action">action</link>
7386	performed on the device.
7387
7388	Unless the device is ignored by these filters, filters of all
7389	currently running virtual machines
7390	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7391
7392	<note>
7393	If USB functionality is not available in the given edition of
7394	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7395	</note>
7396
7397	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7398	</desc>
7399	</attribute>
7400
7401	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7402	<desc>List of host network interfaces currently defined on the host.</desc>
7403	</attribute>
7404
7405	<attribute name="processorCount" type="unsigned long" readonly="yes">
7406	<desc>Number of (logical) CPUs installed in the host system.</desc>
7407	</attribute>
7408
7409	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7410	<desc>Number of (logical) CPUs online in the host system.</desc>
7411	</attribute>
7412
7413	<method name="getProcessorSpeed">
7414	<desc>Query the (approximate) maximum speed of a specified host CPU in
7415	Megahertz.
7416	</desc>
7417	<param name="cpuId" type="unsigned long" dir="in">
7418	<desc>
7419	Identifier of the CPU.
7420	</desc>
7421	</param>
7422	<param name="speed" type="unsigned long" dir="return">
7423	<desc>
7424	Speed value. 0 is returned if value is not known or @a cpuId is
7425	invalid.
7426	</desc>
7427	</param>
7428	</method>
7429
7430	<method name="getProcessorFeature">
7431	<desc>Query whether a CPU feature is supported or not.</desc>
7432	<param name="feature" type="ProcessorFeature" dir="in">
7433	<desc>
7434	CPU Feature identifier.
7435	</desc>
7436	</param>
7437	<param name="supported" type="boolean" dir="return">
7438	<desc>
7439	Feature is supported or not.
7440	</desc>
7441	</param>
7442	</method>
7443
7444	<method name="getProcessorDescription">
7445	<desc>Query the model string of a specified host CPU.
7446	</desc>
7447	<param name="cpuId" type="unsigned long" dir="in">
7448	<desc>
7449	Identifier of the CPU.
7450	<note>
7451	The current implementation might not necessarily return the
7452	description for this exact CPU.
7453	</note>
7454	</desc>
7455	</param>
7456	<param name="description" type="wstring" dir="return">
7457	<desc>
7458	Model string. An empty string is returned if value is not known or
7459	@a cpuId is invalid.
7460	</desc>
7461	</param>
7462	</method>
7463
7464	<method name="getProcessorCpuIdLeaf">
7465	<desc>
7466	Returns the CPU cpuid information for the specified leaf.
7467	</desc>
7468	<param name="cpuId" type="unsigned long" dir="in">
7469	<desc>
7470	Identifier of the CPU. The CPU most be online.
7471	<note>
7472	The current implementation might not necessarily return the
7473	description for this exact CPU.
7474	</note>
7475	</desc>
7476	</param>
7477	<param name="leaf" type="unsigned long" dir="in">
7478	<desc>
7479	Cpuid leaf index (eax).
7480	</desc>
7481	</param>
7482	<param name="subLeaf" type="unsigned long" dir="in">
7483	<desc>
7484	Cpuid leaf sub index (ecx). This currently only applies to cache
7485	information on Intel CPUs. Use 0 if retriving values for
7486	<link to="IMachine::setCpuIdLeaf"/>.
7487	</desc>
7488	</param>
7489	<param name="valEax" type="unsigned long" dir="out">
7490	<desc>
7491	Cpuid leaf value for register eax.
7492	</desc>
7493	</param>
7494	<param name="valEbx" type="unsigned long" dir="out">
7495	<desc>
7496	Cpuid leaf value for register ebx.
7497	</desc>
7498	</param>
7499	<param name="valEcx" type="unsigned long" dir="out">
7500	<desc>
7501	Cpuid leaf value for register ecx.
7502	</desc>
7503	</param>
7504	<param name="valEdx" type="unsigned long" dir="out">
7505	<desc>
7506	Cpuid leaf value for register edx.
7507	</desc>
7508	</param>
7509	</method>
7510
7511	<attribute name="memorySize" type="unsigned long" readonly="yes">
7512	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7513	</attribute>
7514
7515	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7516	<desc>Available system memory in the host system.</desc>
7517	</attribute>
7518
7519	<attribute name="operatingSystem" type="wstring" readonly="yes">
7520	<desc>Name of the host system's operating system.</desc>
7521	</attribute>
7522
7523	<attribute name="OSVersion" type="wstring" readonly="yes">
7524	<desc>Host operating system's version string.</desc>
7525	</attribute>
7526
7527	<attribute name="UTCTime" type="long long" readonly="yes">
7528	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7529	</attribute>
7530
7531	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7532	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7533	</attribute>
7534
7535	<method name="createHostOnlyNetworkInterface">
7536	<desc>
7537	Creates a new adapter for Host Only Networking.
7538	<result name="E_INVALIDARG">
7539	Host network interface @a name already exists.
7540	</result>
7541	</desc>
7542	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7543	<desc>
7544	Created host interface object.
7545	</desc>
7546	</param>
7547	<param name="progress" type="IProgress" dir="return">
7548	<desc>
7549	Progress object to track the operation completion.
7550	</desc>
7551	</param>
7552	</method>
7553
7554	<method name="removeHostOnlyNetworkInterface">
7555	<desc>
7556	Removes the given Host Only Networking interface.
7557	<result name="VBOX_E_OBJECT_NOT_FOUND">
7558	No host network interface matching @a id found.
7559	</result>
7560	</desc>
7561	<param name="id" type="uuid" mod="string" dir="in">
7562	<desc>
7563	Adapter GUID.
7564	</desc>
7565	</param>
7566	<param name="progress" type="IProgress" dir="return">
7567	<desc>
7568	Progress object to track the operation completion.
7569	</desc>
7570	</param>
7571	</method>
7572
7573	<method name="createUSBDeviceFilter">
7574	<desc>
7575	Creates a new USB device filter. All attributes except
7576	the filter name are set to empty (any match),
7577	<i>active</i> is @c false (the filter is not active).
7578
7579	The created filter can be added to the list of filters using
7580	<link to="#insertUSBDeviceFilter"/>.
7581
7582	<see>#USBDeviceFilters</see>
7583	</desc>
7584	<param name="name" type="wstring" dir="in">
7585	<desc>
7586	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7587	for more info.
7588	</desc>
7589	</param>
7590	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7591	<desc>Created filter object.</desc>
7592	</param>
7593	</method>
7594
7595	<method name="insertUSBDeviceFilter">
7596	<desc>
7597	Inserts the given USB device to the specified position
7598	in the list of filters.
7599
7600	Positions are numbered starting from @c 0. If the specified
7601	position is equal to or greater than the number of elements in
7602	the list, the filter is added at the end of the collection.
7603
7604	<note>
7605	Duplicates are not allowed, so an attempt to insert a
7606	filter already in the list is an error.
7607	</note>
7608	<note>
7609	If USB functionality is not available in the given edition of
7610	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7611	</note>
7612
7613	<see>#USBDeviceFilters</see>
7614
7615	<result name="VBOX_E_INVALID_OBJECT_STATE">
7616	USB device filter is not created within this VirtualBox instance.
7617	</result>
7618	<result name="E_INVALIDARG">
7619	USB device filter already in list.
7620	</result>
7621
7622	</desc>
7623	<param name="position" type="unsigned long" dir="in">
7624	<desc>Position to insert the filter to.</desc>
7625	</param>
7626	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7627	<desc>USB device filter to insert.</desc>
7628	</param>
7629	</method>
7630
7631	<method name="removeUSBDeviceFilter">
7632	<desc>
7633	Removes a USB device filter from the specified position in the
7634	list of filters.
7635
7636	Positions are numbered starting from @c 0. Specifying a
7637	position equal to or greater than the number of elements in
7638	the list will produce an error.
7639
7640	<note>
7641	If USB functionality is not available in the given edition of
7642	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7643	</note>
7644
7645	<see>#USBDeviceFilters</see>
7646
7647	<result name="E_INVALIDARG">
7648	USB device filter list empty or invalid @a position.
7649	</result>
7650
7651	</desc>
7652	<param name="position" type="unsigned long" dir="in">
7653	<desc>Position to remove the filter from.</desc>
7654	</param>
7655	</method>
7656
7657	<method name="findHostDVDDrive">
7658	<desc>
7659	Searches for a host DVD drive with the given @c name.
7660
7661	<result name="VBOX_E_OBJECT_NOT_FOUND">
7662	Given @c name does not correspond to any host drive.
7663	</result>
7664
7665	</desc>
7666	<param name="name" type="wstring" dir="in">
7667	<desc>Name of the host drive to search for</desc>
7668	</param>
7669	<param name="drive" type="IMedium" dir="return">
7670	<desc>Found host drive object</desc>
7671	</param>
7672	</method>
7673
7674	<method name="findHostFloppyDrive">
7675	<desc>
7676	Searches for a host floppy drive with the given @c name.
7677
7678	<result name="VBOX_E_OBJECT_NOT_FOUND">
7679	Given @c name does not correspond to any host floppy drive.
7680	</result>
7681
7682	</desc>
7683	<param name="name" type="wstring" dir="in">
7684	<desc>Name of the host floppy drive to search for</desc>
7685	</param>
7686	<param name="drive" type="IMedium" dir="return">
7687	<desc>Found host floppy drive object</desc>
7688	</param>
7689	</method>
7690
7691	<method name="findHostNetworkInterfaceByName">
7692	<desc>
7693	Searches through all host network interfaces for an interface with
7694	the given @c name.
7695	<note>
7696	The method returns an error if the given @c name does not
7697	correspond to any host network interface.
7698	</note>
7699	</desc>
7700	<param name="name" type="wstring" dir="in">
7701	<desc>Name of the host network interface to search for.</desc>
7702	</param>
7703	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7704	<desc>Found host network interface object.</desc>
7705	</param>
7706	</method>
7707	<method name="findHostNetworkInterfaceById">
7708	<desc>
7709	Searches through all host network interfaces for an interface with
7710	the given GUID.
7711	<note>
7712	The method returns an error if the given GUID does not
7713	correspond to any host network interface.
7714	</note>
7715	</desc>
7716	<param name="id" type="uuid" mod="string" dir="in">
7717	<desc>GUID of the host network interface to search for.</desc>
7718	</param>
7719	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7720	<desc>Found host network interface object.</desc>
7721	</param>
7722	</method>
7723	<method name="findHostNetworkInterfacesOfType">
7724	<desc>
7725	Searches through all host network interfaces and returns a list of interfaces of the specified type
7726	</desc>
7727	<param name="type" type="HostNetworkInterfaceType" dir="in">
7728	<desc>type of the host network interfaces to search for.</desc>
7729	</param>
7730	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7731	<desc>Found host network interface objects.</desc>
7732	</param>
7733	</method>
7734
7735	<method name="findUSBDeviceById">
7736	<desc>
7737	Searches for a USB device with the given UUID.
7738
7739	<result name="VBOX_E_OBJECT_NOT_FOUND">
7740	Given @c id does not correspond to any USB device.
7741	</result>
7742
7743	<see>IHostUSBDevice::id</see>
7744	</desc>
7745	<param name="id" type="uuid" mod="string" dir="in">
7746	<desc>UUID of the USB device to search for.</desc>
7747	</param>
7748	<param name="device" type="IHostUSBDevice" dir="return">
7749	<desc>Found USB device object.</desc>
7750	</param>
7751	</method>
7752
7753	<method name="findUSBDeviceByAddress">
7754	<desc>
7755	Searches for a USB device with the given host address.
7756
7757	<result name="VBOX_E_OBJECT_NOT_FOUND">
7758	Given @c name does not correspond to any USB device.
7759	</result>
7760
7761	<see>IHostUSBDevice::address</see>
7762	</desc>
7763	<param name="name" type="wstring" dir="in">
7764	<desc>
7765	Address of the USB device (as assigned by the host) to
7766	search for.
7767	</desc>
7768	</param>
7769	<param name="device" type="IHostUSBDevice" dir="return">
7770	<desc>Found USB device object.</desc>
7771	</param>
7772	</method>
7773
7774	</interface>
7775
7776	<!--
7777	// ISystemProperties
7778	/////////////////////////////////////////////////////////////////////////
7779	-->
7780
7781	<interface
7782	name="ISystemProperties"
7783	extends="$unknown"
7784	uuid="8030645c-8fef-4320-bb7b-c829f00069dc"
7785	wsmap="managed"
7786	>
7787	<desc>
7788	The ISystemProperties interface represents global properties of the given
7789	VirtualBox installation.
7790
7791	These properties define limits and default values for various attributes
7792	and parameters. Most of the properties are read-only, but some can be
7793	changed by a user.
7794	</desc>
7795
7796	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7797	<desc>Minimum guest system memory in Megabytes.</desc>
7798	</attribute>
7799
7800	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7801	<desc>Maximum guest system memory in Megabytes.</desc>
7802	</attribute>
7803
7804	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7805	<desc>Minimum guest video memory in Megabytes.</desc>
7806	</attribute>
7807
7808	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7809	<desc>Maximum guest video memory in Megabytes.</desc>
7810	</attribute>
7811
7812	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7813	<desc>Minimum CPU count.</desc>
7814	</attribute>
7815
7816	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7817	<desc>Maximum CPU count.</desc>
7818	</attribute>
7819
7820	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7821	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7822	</attribute>
7823
7824	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7825	<desc>
7826	Number of network adapters associated with every
7827	<link to="IMachine"/> instance.
7828	</desc>
7829	</attribute>
7830
7831	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7832	<desc>
7833	Number of serial ports associated with every
7834	<link to="IMachine"/> instance.
7835	</desc>
7836	</attribute>
7837
7838	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7839	<desc>
7840	Number of parallel ports associated with every
7841	<link to="IMachine"/> instance.
7842	</desc>
7843	</attribute>
7844
7845	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7846	<desc>
7847	Maximum device position in the boot order. This value corresponds
7848	to the total number of devices a machine can boot from, to make it
7849	possible to include all possible devices to the boot list.
7850	<see><link to="IMachine::setBootOrder"/></see>
7851	</desc>
7852	</attribute>
7853
7854	<attribute name="defaultMachineFolder" type="wstring">
7855	<desc>
7856	Full path to the default directory used to create new or open
7857	existing machines when a settings file name contains no
7858	path.
7859
7860	The initial value of this property is
7861	<tt><</tt><link to="IVirtualBox::homeFolder">
7862	VirtualBox_home</link><tt>>/Machines</tt>.
7863
7864	<note>
7865	Setting this property to @c null or an empty string will restore the
7866	initial value.
7867	</note>
7868	<note>
7869	When settings this property, the specified path can be
7870	absolute (full path) or relative
7871	to the <link to="IVirtualBox::homeFolder">
7872	VirtualBox home directory</link>.
7873	When reading this property, a full path is
7874	always returned.
7875	</note>
7876	<note>
7877	The specified path may not exist, it will be created
7878	when necessary.
7879	</note>
7880
7881	<see>
7882	<link to="IVirtualBox::createMachine"/>,
7883	<link to="IVirtualBox::openMachine"/>
7884	</see>
7885	</desc>
7886	</attribute>
7887
7888	<attribute name="defaultHardDiskFolder" type="wstring">
7889	<desc>
7890	Full path to the default directory used to create new or open existing
7891	virtual disks.
7892
7893	This path is used when the storage unit of a hard disk is a regular file
7894	in the host's file system and only a file name that contains no path is
7895	given.
7896
7897	The initial value of this property is
7898	<tt><</tt>
7899	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7900	<tt>>/HardDisks</tt>.
7901
7902	<note>
7903	Setting this property to @c null or empty string will restore the
7904	initial value.
7905	</note>
7906	<note>
7907	When settings this property, the specified path can be relative
7908	to the
7909	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7910	absolute. When reading this property, a full path is
7911	always returned.
7912	</note>
7913	<note>
7914	The specified path may not exist, it will be created
7915	when necessary.
7916	</note>
7917
7918	<see>
7919	IMedium,
7920	<link to="IVirtualBox::createHardDisk"/>,
7921	<link to="IVirtualBox::openHardDisk"/>,
7922	<link to="IMedium::location"/>
7923	</see>
7924	</desc>
7925	</attribute>
7926
7927	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7928	<desc>
7929	List of all medium storage formats supported by this VirtualBox
7930	installation.
7931
7932	Keep in mind that the medium format identifier
7933	(<link to="IMediumFormat::id"/>) used in other API calls like
7934	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7935	medium format is a case-insensitive string. This means that, for
7936	example, all of the following strings:
7937	<pre>
7938	"VDI"
7939	"vdi"
7940	"VdI"</pre>
7941	refer to the same medium format.
7942
7943	Note that the virtual medium framework is backend-based, therefore
7944	the list of supported formats depends on what backends are currently
7945	installed.
7946
7947	<see>
7948	<link to="IMediumFormat"/>,
7949	</see>
7950	</desc>
7951	</attribute>
7952
7953	<attribute name="defaultHardDiskFormat" type="wstring">
7954	<desc>
7955	Identifier of the default medium format used by VirtualBox.
7956
7957	The medium format set by this attribute is used by VirtualBox
7958	when the medium format was not specified explicitly. One example is
7959	<link to="IVirtualBox::createHardDisk"/> with the empty
7960	format argument. A more complex example is implicit creation of
7961	differencing media when taking a snapshot of a virtual machine:
7962	this operation will try to use a format of the parent medium first
7963	and if this format does not support differencing media the default
7964	format specified by this argument will be used.
7965
7966	The list of supported medium formats may be obtained by the
7967	<link to="#mediaFormats"/> call. Note that the default medium
7968	format must have a capability to create differencing media;
7969	otherwise operations that create media implicitly may fail
7970	unexpectedly.
7971
7972	The initial value of this property is <tt>"VDI"</tt> in the current
7973	version of the VirtualBox product, but may change in the future.
7974
7975	<note>
7976	Setting this property to @c null or empty string will restore the
7977	initial value.
7978	</note>
7979
7980	<see>
7981	<link to="#mediaFormats"/>,
7982	<link to="IMediumFormat::id"/>,
7983	<link to="IVirtualBox::createHardDisk"/>
7984	</see>
7985	</desc>
7986	</attribute>
7987
7988	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7989	<desc>
7990	Library that provides authentication for VRDP clients. The library
7991	is used if a virtual machine's authentication type is set to "external"
7992	in the VM RemoteDisplay configuration.
7993
7994	The system library extension (".DLL" or ".so") must be omitted.
7995	A full path can be specified; if not, then the library must reside on the
7996	system's default library path.
7997
7998	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7999	of that name in one of the default VirtualBox library directories.
8000
8001	For details about VirtualBox authentication libraries and how to implement
8002	them, please refer to the VirtualBox manual.
8003
8004	<note>
8005	Setting this property to @c null or empty string will restore the
8006	initial value.
8007	</note>
8008	</desc>
8009	</attribute>
8010
8011	<attribute name="webServiceAuthLibrary" type="wstring">
8012	<desc>
8013	Library that provides authentication for webservice clients. The library
8014	is used if a virtual machine's authentication type is set to "external"
8015	in the VM RemoteDisplay configuration and will be called from
8016	within the <link to="IWebsessionManager::logon" /> implementation.
8017
8018	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
8019	there is no per-VM setting for this, as the webservice is a global
8020	resource (if it is running). Only for this setting (for the webservice),
8021	setting this value to a literal <tt>"null"</tt> string disables authentication,
8022	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8023	no matter what user name and password are supplied.
8024
8025	The initial value of this property is <tt>"VRDPAuth"</tt>,
8026	meaning that the webservice will use the same authentication
8027	library that is used by default for VBoxVRDP (again, see
8028	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
8029	The format and calling convention of authentication libraries
8030	is the same for the webservice as it is for VBoxVRDP.
8031
8032	<note>
8033	Setting this property to @c null or empty string will restore the
8034	initial value.
8035	</note>
8036	</desc>
8037	</attribute>
8038
8039	<attribute name="LogHistoryCount" type="unsigned long">
8040	<desc>
8041	This value specifies how many old release log files are kept.
8042	</desc>
8043	</attribute>
8044
8045	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8046	<desc>This value hold the default audio driver for the current
8047	system.</desc>
8048	</attribute>
8049
8050	<method name="getMaxDevicesPerPortForStorageBus">
8051	<desc>Returns the maximum number of devices which can be attached to a port
8052	for the given storage bus.</desc>
8053
8054	<param name="bus" type="StorageBus" dir="in">
8055	<desc>The storage bus type to get the value for.</desc>
8056	</param>
8057
8058	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8059	<desc>The maximum number of devices which can eb attached to the port for the given
8060	storage bus.</desc>
8061	</param>
8062	</method>
8063
8064	<method name="getMinPortCountForStorageBus">
8065	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8066
8067	<param name="bus" type="StorageBus" dir="in">
8068	<desc>The storage bus type to get the value for.</desc>
8069	</param>
8070
8071	<param name="minPortCount" type="unsigned long" dir="return">
8072	<desc>The minimum number of ports for the given storage bus.</desc>
8073	</param>
8074	</method>
8075
8076	<method name="getMaxPortCountForStorageBus">
8077	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8078
8079	<param name="bus" type="StorageBus" dir="in">
8080	<desc>The storage bus type to get the value for.</desc>
8081	</param>
8082
8083	<param name="maxPortCount" type="unsigned long" dir="return">
8084	<desc>The maximum number of ports for the given storage bus.</desc>
8085	</param>
8086	</method>
8087
8088	<method name="getMaxInstancesOfStorageBus">
8089	<desc>Returns the maximum number of storage bus instances which
8090	can be configured for each VM. This corresponds to the number of
8091	storage controllers one can have.</desc>
8092
8093	<param name="bus" type="StorageBus" dir="in">
8094	<desc>The storage bus type to get the value for.</desc>
8095	</param>
8096
8097	<param name="maxInstances" type="unsigned long" dir="return">
8098	<desc>The maximum number of instances for the given storage bus.</desc>
8099	</param>
8100	</method>
8101
8102	<method name="getDeviceTypesForStorageBus">
8103	<desc>Returns list of all the supported device types
8104	(<link to="DeviceType"/>) for the given type of storage
8105	bus.</desc>
8106
8107	<param name="bus" type="StorageBus" dir="in">
8108	<desc>The storage bus type to get the value for.</desc>
8109	</param>
8110
8111	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8112	<desc>The list of all supported device types for the given storage bus.</desc>
8113	</param>
8114	</method>
8115	</interface>
8116
8117	<!--
8118	// IGuest
8119	/////////////////////////////////////////////////////////////////////////
8120	-->
8121
8122	<interface
8123	name="IGuestOSType" extends="$unknown"
8124	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
8125	wsmap="struct"
8126	>
8127	<desc>
8128	</desc>
8129
8130	<attribute name="familyId" type="wstring" readonly="yes">
8131	<desc>Guest OS family identifier string.</desc>
8132	</attribute>
8133
8134	<attribute name="familyDescription" type="wstring" readonly="yes">
8135	<desc>Human readable description of the guest OS family.</desc>
8136	</attribute>
8137
8138	<attribute name="id" type="wstring" readonly="yes">
8139	<desc>Guest OS identifier string.</desc>
8140	</attribute>
8141
8142	<attribute name="description" type="wstring" readonly="yes">
8143	<desc>Human readable description of the guest OS.</desc>
8144	</attribute>
8145
8146	<attribute name="is64Bit" type="boolean" readonly="yes">
8147	<desc>Returns @c true if the given OS is 64-bit</desc>
8148	</attribute>
8149
8150	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8151	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8152	</attribute>
8153
8154	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8155	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8156	</attribute>
8157
8158	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8159	<desc>Recommended RAM size in Megabytes.</desc>
8160	</attribute>
8161
8162	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8163	<desc>Recommended video RAM size in Megabytes.</desc>
8164	</attribute>
8165
8166	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
8167	<desc>Recommended hard disk size in Megabytes.</desc>
8168	</attribute>
8169
8170	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8171	<desc>Returns recommended network adapter for this OS type.</desc>
8172	</attribute>
8173	</interface>
8174
8175	<interface
8176	name="IGuest" extends="$unknown"
8177	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
8178	wsmap="managed"
8179	>
8180	<desc>
8181	The IGuest interface represents information about the operating system
8182	running inside the virtual machine. Used in
8183	<link to="IConsole::guest"/>.
8184
8185	IGuest provides information about the guest operating system, whether
8186	Guest Additions are installed and other OS-specific virtual machine
8187	properties.
8188	</desc>
8189
8190	<attribute name="OSTypeId" type="wstring" readonly="yes">
8191	<desc>
8192	Identifier of the Guest OS type as reported by the Guest
8193	Additions.
8194	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8195	an IGuestOSType object representing details about the given
8196	Guest OS type.
8197	<note>
8198	If Guest Additions are not installed, this value will be
8199	the same as <link to="IMachine::OSTypeId"/>.
8200	</note>
8201	</desc>
8202	</attribute>
8203
8204	<attribute name="additionsActive" type="boolean" readonly="yes">
8205	<desc>
8206	Flag whether the Guest Additions are installed and active
8207	in which case their version will be returned by the
8208	<link to="#additionsVersion"/> property.
8209	</desc>
8210	</attribute>
8211
8212	<attribute name="additionsVersion" type="wstring" readonly="yes">
8213	<desc>
8214	Version of the Guest Additions (3 decimal numbers separated
8215	by dots) or empty when the Additions are not installed. The
8216	Additions may also report a version but yet not be active as
8217	the version might be refused by VirtualBox (incompatible) or
8218	other failures occurred.
8219	</desc>
8220	</attribute>
8221
8222	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8223	<desc>
8224	Flag whether seamless guest display rendering (seamless desktop
8225	integration) is supported.
8226	</desc>
8227	</attribute>
8228
8229	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8230	<desc>
8231	Flag whether the guest is in graphics mode. If it is not, then
8232	seamless rendering will not work, resize hints are not immediately
8233	acted on and guest display resizes are probably not initiated by
8234	the guest additions.
8235	</desc>
8236	</attribute>
8237
8238	<attribute name="memoryBalloonSize" type="unsigned long">
8239	<desc>Guest system memory balloon size in megabytes.</desc>
8240	</attribute>
8241
8242	<attribute name="statisticsUpdateInterval" type="unsigned long">
8243	<desc>Interval to update guest statistics in seconds.</desc>
8244	</attribute>
8245
8246	<method name="setCredentials">
8247	<desc>
8248	Store login credentials that can be queried by guest operating
8249	systems with Additions installed. The credentials are transient
8250	to the session and the guest may also choose to erase them. Note
8251	that the caller cannot determine whether the guest operating system
8252	has queried or made use of the credentials.
8253
8254	<result name="VBOX_E_VM_ERROR">
8255	VMM device is not available.
8256	</result>
8257
8258	</desc>
8259	<param name="userName" type="wstring" dir="in">
8260	<desc>User name string, can be empty</desc>
8261	</param>
8262	<param name="password" type="wstring" dir="in">
8263	<desc>Password string, can be empty</desc>
8264	</param>
8265	<param name="domain" type="wstring" dir="in">
8266	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8267	</param>
8268	<param name="allowInteractiveLogon" type="boolean" dir="in">
8269	<desc>
8270	Flag whether the guest should alternatively allow the user to
8271	interactively specify different credentials. This flag might
8272	not be supported by all versions of the Additions.
8273	</desc>
8274	</param>
8275	</method>
8276
8277	<method name="getStatistic">
8278	<desc>
8279	Query specified guest statistics as reported by the VirtualBox Additions.
8280	</desc>
8281	<param name="cpuId" type="unsigned long" dir="in">
8282	<desc>Virtual CPU id; not relevant for all statistic types</desc>
8283	</param>
8284	<param name="statistic" type="GuestStatisticType" dir="in">
8285	<desc>Statistic type.</desc>
8286	</param>
8287	<param name="statVal" type="unsigned long" dir="return">
8288	<desc>Statistics value</desc>
8289	</param>
8290	</method>
8291
8292	</interface>
8293
8294
8295	<!--
8296	// IProgress
8297	/////////////////////////////////////////////////////////////////////////
8298	-->
8299
8300	<interface
8301	name="IProgress" extends="$unknown"
8302	uuid="62827ef1-c098-40eb-be96-36d0508489a6"
8303	wsmap="managed"
8304	>
8305	<desc>
8306	The IProgress interface is used to track and control
8307	asynchronous tasks within VirtualBox.
8308
8309	An instance of this is returned every time VirtualBox starts
8310	an asynchronous task (in other words, a separate thread) which
8311	continues to run after a method call returns. For example,
8312	<link to="IConsole::saveState" />, which saves the state of
8313	a running virtual machine, can take a long time to complete.
8314	To be able to display a progress bar, a user interface such as
8315	the VirtualBox graphical user interface can use the IProgress
8316	object returned by that method.
8317
8318	Note that IProgress is a "read-only" interface in the sense
8319	that only the VirtualBox internals behind the Main API can
8320	create and manipulate progress objects, whereas client code
8321	can only use the IProgress object to monitor a task's
8322	progress and, if <link to="#cancelable" /> is @c true,
8323	cancel the task by calling <link to="#cancel" />.
8324
8325	A task represented by IProgress consists of either one or
8326	several sub-operations that run sequentially, one by one (see
8327	<link to="#operation" /> and <link to="#operationCount" />).
8328	Every operation is identified by a number (starting from 0)
8329	and has a separate description.
8330
8331	You can find the individual percentage of completion of the current
8332	operation in <link to="#operationPercent" /> and the
8333	percentage of completion of the task as a whole
8334	in <link to="#percent" />.
8335
8336	Similarly, you can wait for the completion of a particular
8337	operation via <link to="#waitForOperationCompletion" /> or
8338	for the completion of the whole task via
8339	<link to="#waitForCompletion" />.
8340	</desc>
8341
8342	<attribute name="id" type="uuid" mod="string" readonly="yes">
8343	<desc>ID of the task.</desc>
8344	</attribute>
8345
8346	<attribute name="description" type="wstring" readonly="yes">
8347	<desc>Description of the task.</desc>
8348	</attribute>
8349
8350	<attribute name="initiator" type="$unknown" readonly="yes">
8351	<desc>Initiator of the task.</desc>
8352	</attribute>
8353
8354	<attribute name="cancelable" type="boolean" readonly="yes">
8355	<desc>Whether the task can be interrupted.</desc>
8356	</attribute>
8357
8358	<attribute name="percent" type="unsigned long" readonly="yes">
8359	<desc>
8360	Current progress value of the task as a whole, in percent.
8361	This value depends on how many operations are already complete.
8362	Returns 100 if <link to="#completed" /> is @c true.
8363	</desc>
8364	</attribute>
8365
8366	<attribute name="timeRemaining" type="long" readonly="yes">
8367	<desc>
8368	Estimated remaining time until the task completes, in
8369	seconds. Returns 0 once the task has completed; returns -1
8370	if the remaining time cannot be computed, in particular if
8371	the current progress is 0.
8372
8373	Even if a value is returned, the estimate will be unreliable
8374	for low progress values. It will become more reliable as the
8375	task progresses; it is not recommended to display an ETA
8376	before at least 20% of a task have completed.
8377	</desc>
8378	</attribute>
8379
8380	<attribute name="completed" type="boolean" readonly="yes">
8381	<desc>Whether the task has been completed.</desc>
8382	</attribute>
8383
8384	<attribute name="canceled" type="boolean" readonly="yes">
8385	<desc>Whether the task has been canceled.</desc>
8386	</attribute>
8387
8388	<attribute name="resultCode" type="long" readonly="yes">
8389	<desc>
8390	Result code of the progress task.
8391	Valid only if <link to="#completed"/> is @c true.
8392	</desc>
8393	</attribute>
8394
8395	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8396	<desc>
8397	Extended information about the unsuccessful result of the
8398	progress operation. May be @c null if no extended information
8399	is available.
8400	Valid only if <link to="#completed"/> is @c true and
8401	<link to="#resultCode"/> indicates a failure.
8402	</desc>
8403	</attribute>
8404
8405	<attribute name="operationCount" type="unsigned long" readonly="yes">
8406	<desc>
8407	Number of sub-operations this task is divided into.
8408	Every task consists of at least one suboperation.
8409	</desc>
8410	</attribute>
8411
8412	<attribute name="operation" type="unsigned long" readonly="yes">
8413	<desc>Number of the sub-operation being currently executed.</desc>
8414	</attribute>
8415
8416	<attribute name="operationDescription" type="wstring" readonly="yes">
8417	<desc>
8418	Description of the sub-operation being currently executed.
8419	</desc>
8420	</attribute>
8421
8422	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8423	<desc>Progress value of the current sub-operation only, in percent.</desc>
8424	</attribute>
8425
8426	<method name="setCurrentOperationProgress">
8427	<desc>Internal method, not to be called externally.</desc>
8428	<param name="percent" type="unsigned long" dir="in" />
8429	</method>
8430	<method name="setNextOperation">
8431	<desc>Internal method, not to be called externally.</desc>
8432	<param name="nextOperationDescription" type="wstring" dir="in" />
8433	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8434	</method>
8435
8436	<method name="waitForCompletion">
8437	<desc>
8438	Waits until the task is done (including all sub-operations)
8439	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8440
8441	<result name="VBOX_E_IPRT_ERROR">
8442	Failed to wait for task completion.
8443	</result>
8444	</desc>
8445
8446	<param name="timeout" type="long" dir="in">
8447	<desc>
8448	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8449	</desc>
8450	</param>
8451	</method>
8452
8453	<method name="waitForOperationCompletion">
8454	<desc>
8455	Waits until the given operation is done with a given timeout in
8456	milliseconds; specify -1 for an indefinite wait.
8457
8458	<result name="VBOX_E_IPRT_ERROR">
8459	Failed to wait for operation completion.
8460	</result>
8461
8462	</desc>
8463	<param name="operation" type="unsigned long" dir="in">
8464	<desc>
8465	Number of the operation to wait for.
8466	Must be less than <link to="#operationCount"/>.
8467	</desc>
8468	</param>
8469	<param name="timeout" type="long" dir="in">
8470	<desc>
8471	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8472	</desc>
8473	</param>
8474	</method>
8475
8476	<method name="cancel">
8477	<desc>
8478	Cancels the task.
8479	<note>
8480	If <link to="#cancelable"/> is @c false, then this method will fail.
8481	</note>
8482
8483	<result name="VBOX_E_INVALID_OBJECT_STATE">
8484	Operation cannot be canceled.
8485	</result>
8486
8487	</desc>
8488	</method>
8489
8490	</interface>
8491
8492
8493	<!--
8494	// ISnapshot
8495	/////////////////////////////////////////////////////////////////////////
8496	-->
8497
8498	<interface
8499	name="ISnapshot" extends="$unknown"
8500	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8501	wsmap="managed"
8502	>
8503	<desc>
8504	The ISnapshot interface represents a snapshot of the virtual
8505	machine.
8506
8507	Together with the differencing media that are created
8508	when a snapshot is taken, a machine can be brought back to
8509	the exact state it was in when the snapshot was taken.
8510
8511	The ISnapshot interface has no methods, only attributes; snapshots
8512	are controlled through methods of the <link to="IConsole" /> interface
8513	which also manage the media associated with the snapshot.
8514	The following operations exist:
8515
8516	<ul>
8517	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8518	by creating new, empty differencing images for the machine's
8519	media and saving the VM settings and (if the VM is running)
8520	the current VM state in the snapshot.
8521
8522	The differencing images will then receive all data written to
8523	the machine's media, while their parent (base) images
8524	remain unmodified after the snapshot has been taken (see
8525	<link to="IMedium" /> for details about differencing images).
8526	This simplifies restoring a machine to the state of a snapshot:
8527	only the differencing images need to be deleted.
8528
8529	The current machine state is not changed by taking a snapshot.
8530	If the machine is running, it will resume execution after the
8531	snapshot has been taken.
8532	</li>
8533
8534	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8535	a previous snapshot. This resets the machine's state to that of
8536	the previous snapshot by deleting the differencing image of each
8537	of the machine's media and setting the machine's settings
8538	and state to the state that was saved in the snapshot (if any).
8539
8540	This destroys the machine's current state.
8541	</li>
8542
8543	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8544	without affecting the current machine state.
8545
8546	This does not change the machine, but instead frees the resources
8547	allocated when the snapshot was taken: the settings and machine state
8548	is deleted (if any), and the snapshot's differencing image for each
8549	of the machine's media gets merged with its parent image.
8550
8551	Neither the current machine state nor other snapshots are affected
8552	by this operation, except that parent media will be modified
8553	to contain the disk data associated with the snapshot being deleted.
8554	</li>
8555	</ul>
8556
8557	Each snapshot contains the settings of the virtual machine (hardware
8558	configuration etc.). In addition, if the machine was running when the
8559	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8560	the current VM state is saved in the snapshot (similarly to what happens
8561	when a VM's state is saved). The snapshot is then said to
8562	be <i>online</i> because when restoring it, the VM will be running.
8563
8564	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8565	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8566
8567	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8568	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8569	it then contains a so-called "zero execution state", representing a
8570	machine that is powered off.
8571
8572	<h3>Snapshot branches and the "current" snapshot</h3>
8573
8574	Snapshots can be chained, whereby every next snapshot is based on the
8575	previous one. This chaining is related to medium branching
8576	(see the <link to="IMedium"/> description) in that every time
8577	a new snapshot is created, a new differencing medium is implicitly
8578	created for all normal media attached to the machine.
8579
8580	Each virtual machine has a "current snapshot", identified by
8581	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8582	to the last snapshot in the chain. In a future version of VirtualBox,
8583	it will be possible to reset a machine's current state to that of an
8584	earlier snapshot without discarding the current state so that it will be
8585	possible to create alternative snapshot paths in a snapshot tree.
8586
8587	In the current implementation, multiple snapshot branches within one
8588	virtual machine are not allowed. Every machine has a single branch,
8589	and <link to="IConsole::takeSnapshot"/> operation adds a new
8590	snapshot to the top of that branch.
8591	</desc>
8592
8593	<attribute name="id" type="uuid" mod="string" readonly="yes">
8594	<desc>UUID of the snapshot.</desc>
8595	</attribute>
8596
8597	<attribute name="name" type="wstring">
8598	<desc>Short name of the snapshot.</desc>
8599	</attribute>
8600
8601	<attribute name="description" type="wstring">
8602	<desc>Optional description of the snapshot.</desc>
8603	</attribute>
8604
8605	<attribute name="timeStamp" type="long long" readonly="yes">
8606	<desc>
8607	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8608	</desc>
8609	</attribute>
8610
8611	<attribute name="online" type="boolean" readonly="yes">
8612	<desc>
8613	@c true if this snapshot is an online snapshot and @c false otherwise.
8614
8615	When this attribute is @c true, the
8616	<link to="IMachine::stateFilePath"/> attribute of the
8617	<link to="#machine"/> object associated with this snapshot
8618	will point to the saved state file. Otherwise, it will be
8619	an empty string.
8620	</desc>
8621	</attribute>
8622
8623	<attribute name="machine" type="IMachine" readonly="yes">
8624	<desc>
8625	Virtual machine this snapshot is taken on. This object
8626	stores all settings the machine had when taking this snapshot.
8627	<note>
8628	The returned machine object is immutable, i.e. no
8629	any settings can be changed.
8630	</note>
8631	</desc>
8632	</attribute>
8633
8634	<attribute name="parent" type="ISnapshot" readonly="yes">
8635	<desc>
8636	Parent snapshot (a snapshot this one is based on), or
8637	@c null if the snapshot has no parent (i.e. is the first snapshot).
8638	</desc>
8639	</attribute>
8640
8641	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8642	<desc>
8643	Child snapshots (all snapshots having this one as a parent).
8644	</desc>
8645	</attribute>
8646
8647	</interface>
8648
8649
8650	<!--
8651	// IMedium
8652	/////////////////////////////////////////////////////////////////////////
8653	-->
8654
8655	<enum
8656	name="MediumState"
8657	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8658	>
8659	<desc>
8660	Virtual medium state.
8661	<see>IMedium</see>
8662	</desc>
8663
8664	<const name="NotCreated" value="0">
8665	<desc>
8666	Associated medium storage does not exist (either was not created yet or
8667	was deleted).
8668	</desc>
8669	</const>
8670	<const name="Created" value="1">
8671	<desc>
8672	Associated storage exists and accessible; this gets set if the
8673	accessibility check performed by <link to="IMedium::refreshState" />
8674	was successful.
8675	</desc>
8676	</const>
8677	<const name="LockedRead" value="2">
8678	<desc>
8679	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8680	no data modification is possible.
8681	</desc>
8682	</const>
8683	<const name="LockedWrite" value="3">
8684	<desc>
8685	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8686	no concurrent data reading or modification is possible.
8687	</desc>
8688	</const>
8689	<const name="Inaccessible" value="4">
8690	<desc>
8691	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8692	not yet been performed, or else, associated medium storage is not
8693	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8694	is empty, in the second case, it describes the error that occured.
8695	</desc>
8696	</const>
8697	<const name="Creating" value="5">
8698	<desc>
8699	Associated medium storage is being created.
8700	</desc>
8701	</const>
8702	<const name="Deleting" value="6">
8703	<desc>
8704	Associated medium storage is being deleted.
8705	</desc>
8706	</const>
8707	</enum>
8708
8709	<enum
8710	name="MediumType"
8711	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8712	>
8713	<desc>
8714	Virtual medium type.
8715	<see>IMedium</see>
8716	</desc>
8717
8718	<const name="Normal" value="0">
8719	<desc>
8720	Normal medium (attached directly or indirectly, preserved
8721	when taking snapshots).
8722	</desc>
8723	</const>
8724	<const name="Immutable" value="1">
8725	<desc>
8726	Immutable medium (attached indirectly, changes are wiped out
8727	the next time the virtual machine is started).
8728	</desc>
8729	</const>
8730	<const name="Writethrough" value="2">
8731	<desc>
8732	Write through medium (attached directly, ignored when
8733	taking snapshots).
8734	</desc>
8735	</const>
8736	</enum>
8737
8738	<enum
8739	name="MediumVariant"
8740	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8741	>
8742	<desc>
8743	Virtual medium image variant. More than one flag may be set.
8744	<see>IMedium</see>
8745	</desc>
8746
8747	<const name="Standard" value="0">
8748	<desc>
8749	No particular variant requested, results in using the backend default.
8750	</desc>
8751	</const>
8752	<const name="VmdkSplit2G" value="0x01">
8753	<desc>
8754	VMDK image split in chunks of less than 2GByte.
8755	</desc>
8756	</const>
8757	<const name="VmdkStreamOptimized" value="0x04">
8758	<desc>
8759	VMDK streamOptimized image. Special import/export format which is
8760	read-only/append-only.
8761	</desc>
8762	</const>
8763	<const name="VmdkESX" value="0x08">
8764	<desc>
8765	VMDK format variant used on ESX products.
8766	</desc>
8767	</const>
8768	<const name="Fixed" value="0x10000">
8769	<desc>
8770	Fixed image. Only allowed for base images.
8771	</desc>
8772	</const>
8773	<const name="Diff" value="0x20000">
8774	<desc>
8775	Fixed image. Only allowed for base images.
8776	</desc>
8777	</const>
8778	</enum>
8779
8780	<interface
8781	name="IMediumAttachment" extends="$unknown"
8782	uuid="7bb6ac41-8c03-4863-9eea-d9c76561b8d1"
8783	wsmap="struct"
8784	>
8785	<desc>
8786	The IMediumAttachment interface represents the attachment
8787	of a storage medium to a virtual machine. Each machine contains
8788	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8789
8790	Each medium attachment specifies a storage controller as well as a port
8791	and device number. Fixed media (hard disks) will always also specify
8792	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8793	medium. For removeable media, the IMedia instance is optional; it can be
8794	@c null if no media is mounted (see <link to="IMachine::mountMedium" />).
8795	</desc>
8796
8797	<attribute name="medium" type="IMedium" readonly="yes">
8798	<desc>Medium object associated with this attachment; it
8799	can be @c null for removable devices.</desc>
8800	</attribute>
8801
8802	<attribute name="controller" type="IStorageController" readonly="yes">
8803	<desc>Storage controller object to which this attachment belongs.</desc>
8804	</attribute>
8805
8806	<attribute name="port" type="long" readonly="yes">
8807	<desc>Port number of this attachment.</desc>
8808	</attribute>
8809
8810	<attribute name="device" type="long" readonly="yes">
8811	<desc>Device slot number of this attachment.</desc>
8812	</attribute>
8813
8814	<attribute name="type" type="DeviceType" readonly="yes">
8815	<desc>Device type of this attachment.</desc>
8816	</attribute>
8817
8818	<attribute name="passthrough" type="boolean" readonly="yes">
8819	<desc>Pass I/O requests through to a device on the host.</desc>
8820	</attribute>
8821
8822	</interface>
8823
8824	<interface
8825	name="IMedium" extends="$unknown"
8826	uuid="aa8167ba-df72-4738-b740-9b84377ba9f1"
8827	wsmap="managed"
8828	>
8829	<desc>
8830	The IMedium interface represents virtual storage for a machine's
8831	hard disks, CD/DVD or floppy drives. It will typically represent
8832	a disk image on the host, for example a VDI or VMDK file representing
8833	a virtual hard disk, or an ISO or RAW file representing virtual
8834	removable media, but can also point to a network location (e.g.
8835	for iSCSI targets).
8836
8837	Instances of IMedium are connected to virtual machines by way of
8838	medium attachments (see <link to="IMediumAttachment" />), which link
8839	the storage medium to a particular device slot of a storage controller
8840	of the virtual machine.
8841	In the VirtualBox API, virtual storage is therefore always represented
8842	by the following chain of object links:
8843
8844	<ul>
8845	<li><link to="IMachine::storageControllers"/> contains an array of
8846	storage controllers (IDE, SATA, SCSI or a floppy controller;
8847	these are instances of <link to="IStorageController"/>).</li>
8848	<li><link to="IMachine::mediumAttachments"/> contains an array of
8849	medium attachments (instances of <link to="IMediumAttachment"/>),
8850	each containing a storage controller from the above array, a
8851	port/device specification, and an instance of IMedium representing
8852	the medium storage (image file).
8853
8854	For removable media, the storage medium is optional; a medium
8855	attachment with no medium represents a CD/DVD or floppy drive
8856	with no medium inserted. By contrast, hard disk attachments
8857	will always have an IMedium object attached.</li>
8858	<li>Each IMedium in turn points to a storage unit (such as a file
8859	on the host computer or a network resource) that holds actual
8860	data. This location is represented by the <link to="#location"/>
8861	attribute.</li>
8862	</ul>
8863
8864	Existing media are opened using the following methods, depending on the
8865	media type:
8866	<ul>
8867	<li><link to="IVirtualBox::openHardDisk"/></li>
8868	<li><link to="IVirtualBox::openDVDImage"/></li>
8869	<li><link to="IVirtualBox::openFloppyImage"/></li>
8870	</ul>
8871
8872	New hard disk media can be created with the VirtualBox API using the
8873	<link to="IVirtualBox::createHardDisk"/> method.
8874
8875	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8876	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8877	type in a regular file.
8878
8879	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8880	drive; in that case the <link to="#id" /> attribute contains the UUID of
8881	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8882
8883	<h3>Known media</h3>
8884
8885	When an existing medium is opened for the first time, it is automatically
8886	remembered by the given VirtualBox installation or, in other words, becomes
8887	a <i>known medium</i>. Known media are stored in the media
8888	registry transparently maintained by VirtualBox and stored in settings
8889	files so that this registry is preserved when VirtualBox is not running.
8890
8891	Newly created virtual media are remembered only when the associated
8892	storage unit is actually created.
8893
8894	All known media can be enumerated using
8895	<link to="IVirtualBox::hardDisks"/>,
8896	<link to="IVirtualBox::DVDImages"/> and
8897	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8898	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8899	and similar methods or by location using
8900	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8901
8902	Only known media can be attached to virtual machines.
8903
8904	Removing known media from the media registry is performed when the given
8905	medium is closed using the <link to="#close"/> method or when its
8906	associated storage unit is deleted.
8907
8908	<h3>Accessibility checks</h3>
8909
8910	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8911	method is called explicitly on a medium. This is done to make the VirtualBox object
8912	ready for serving requests as fast as possible and let the end-user
8913	application decide if it needs to check media accessibility right away or not.
8914
8915	As a result, when VirtualBox starts up (e.g. the VirtualBox
8916	object gets created for the first time), all known media are in the
8917	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8918	attribute is an empty string because no actual accessibility check has
8919	been made yet.
8920
8921	After calling <link to="#refreshState" />, a medium is considered
8922	<i>accessible</i> if its storage unit can be read. In that case, the
8923	<link to="#state"/> attribute has a value of "Created". If the storage
8924	unit cannot be read (for example, because it is located on a disconnected
8925	network resource, or was accidentally deleted outside VirtualBox),
8926	the medium is considered <i>inaccessible</i>, which is indicated by the
8927	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8928	obtained by reading the <link to="#lastAccessError"/> attribute.
8929
8930	<h3>Medium types</h3>
8931
8932	There are three types of medium behavior (see <link to="MediumType" />):
8933	"normal", "immutable" and "writethrough", represented by the
8934	<link to="#type"/> attribute. The type of the medium defines how the
8935	medium is attached to a virtual machine and what happens when a
8936	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8937	attached medium is taken. At the moment DVD and floppy media are always
8938	of type "writethrough".
8939
8940	All media can be also divided in two groups: <i>base</i> media and
8941	<i>differencing</i> media. A base medium contains all sectors of the
8942	medium data in its own storage and therefore can be used independently.
8943	In contrast, a differencing mediun is a "delta" to some other medium and
8944	contains only those sectors which differ from that other medium, which is
8945	then called a <i>parent</i>. The differencing medium is said to be
8946	<i>linked to</i> that parent. The parent may be itself a differencing
8947	medium, thus forming a chain of linked media. The last element in that
8948	chain must always be a base medium. Note that several differencing
8949	media may be linked to the same parent medium.
8950
8951	Differencing media can be distinguished from base media by querying the
8952	<link to="#parent"/> attribute: base media do not have parents they would
8953	depend on, so the value of this attribute is always @c null for them.
8954	Using this attribute, it is possible to walk up the medium tree (from the
8955	child medium to its parent). It is also possible to walk down the tree
8956	using the <link to="#children"/> attribute.
8957
8958	Note that the type of all differencing media is
8959	<link to="MediumType_Normal" />; all other values are meaningless for
8960	them. Base media may be of any type.
8961
8962	<h3>Creating hard disks</h3>
8963
8964	New base hard disks are created using
8965	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8966	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8967	disks are usually implicitly created by VirtualBox when needed but may
8968	also be created explicitly using <link to="#createDiffStorage"/>.
8969
8970	After the hard disk is successfully created (including the storage unit)
8971	or opened, it becomes a known hard disk (remembered in the internal media
8972	registry). Known hard disks can be attached to a virtual machine, accessed
8973	through <link to="IVirtualBox::getHardDisk"/> and
8974	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8975	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8976
8977	The following methods, besides <link to="IMedium::close"/>,
8978	automatically remove the hard disk from the media registry:
8979	<ul>
8980	<li><link to="#deleteStorage"/></li>
8981	<li><link to="#mergeTo"/></li>
8982	</ul>
8983
8984	If the storage unit of the hard disk is a regular file in the host's
8985	file system then the rules stated in the description of the
8986	<link to="IMedium::location"/> attribute apply when setting its value. In
8987	addition, a plain file name without any path may be given, in which case
8988	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8989	folder</link> will be prepended to it.
8990
8991	<h4>Automatic composition of the file name part</h4>
8992
8993	Another extension to the <link to="IMedium::location"/> attribute is that
8994	there is a possibility to cause VirtualBox to compose a unique value for
8995	the file name part of the location using the UUID of the hard disk. This
8996	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8997	e.g. before the storage unit is created, and works as follows. You set the
8998	value of the <link to="IMedium::location"/> attribute to a location
8999	specification which only contains the path specification but not the file
9000	name part and ends with either a forward slash or a backslash character.
9001	In response, VirtualBox will generate a new UUID for the hard disk and
9002	compose the file name using the following pattern:
9003	<pre>
9004	<path>/{<uuid>}.<ext>
9005	</pre>
9006	where <tt><path></tt> is the supplied path specification,
9007	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9008	is the default extension for the storage format of this hard disk. After
9009	that, you may call any of the methods that create a new hard disk storage
9010	unit and they will use the generated UUID and file name.
9011
9012	<h3>Attaching Hard Disks</h3>
9013
9014	Hard disks are attached to virtual machines using the
9015	<link to="IMachine::attachDevice"/> method and detached using the
9016	<link to="IMachine::detachDevice"/> method. Depending on their
9017	<link to="#type"/>, hard disks are attached either
9018	<i>directly</i> or <i>indirectly</i>.
9019
9020	When a hard disk is being attached directly, it is associated with the
9021	virtual machine and used for hard disk operations when the machine is
9022	running. When a hard disk is being attached indirectly, a new differencing
9023	hard disk linked to it is implicitly created and this differencing hard
9024	disk is associated with the machine and used for hard disk operations.
9025	This also means that if <link to="IMachine::attachDevice"/> performs
9026	a direct attachment then the same hard disk will be returned in response
9027	to the subsequent <link to="IMachine::getMedium"/> call; however if
9028	an indirect attachment is performed then
9029	<link to="IMachine::getMedium"/> will return the implicitly created
9030	differencing hard disk, not the original one passed to <link
9031	to="IMachine::attachDevice"/>. In detail:
9032
9033	<ul>
9034	<li><b>Normal base</b> hard disks that do not have children (i.e.
9035	differencing hard disks linked to them) and that are not already
9036	attached to virtual machines in snapshots are attached <b>directly</b>.
9037	Otherwise, they are attached <b>indirectly</b> because having
9038	dependent children or being part of the snapshot makes it impossible
9039	to modify hard disk contents without breaking the integrity of the
9040	dependent party. The <link to="#readOnly"/> attribute allows to
9041	quickly determine the kind of the attachment for the given hard
9042	disk. Note that if a normal base hard disk is to be indirectly
9043	attached to a virtual machine with snapshots then a special
9044	procedure called <i>smart attachment</i> is performed (see below).</li>
9045	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9046	they are attached <b>directly</b> if they do not have children and are
9047	not attached to virtual machines in snapshots, and <b>indirectly</b>
9048	otherwise. Note that the smart attachment procedure is never performed
9049	for differencing hard disks.</li>
9050	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9051	they are designed to be non-writable. If an immutable hard disk is
9052	attached to a virtual machine with snapshots then a special
9053	procedure called smart attachment is performed (see below).</li>
9054	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9055	also as designed. This also means that writethrough hard disks cannot
9056	have other hard disks linked to them at all.</li>
9057	</ul>
9058
9059	Note that the same hard disk, regardless of its type, may be attached to
9060	more than one virtual machine at a time. In this case, the machine that is
9061	started first gains exclusive access to the hard disk and attempts to
9062	start other machines having this hard disk attached will fail until the
9063	first machine is powered down.
9064
9065	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9066	that the given hard disk remains associated with the given machine after a
9067	successful <link to="IMachine::detachDevice"/> call until
9068	<link to="IMachine::saveSettings"/> is called to save all changes to
9069	machine settings to disk. This deferring is necessary to guarantee that
9070	the hard disk configuration may be restored at any time by a call to
9071	<link to="IMachine::discardSettings"/> before the settings
9072	are saved (committed).
9073
9074	Note that if <link to="IMachine::discardSettings"/> is called after
9075	indirectly attaching some hard disks to the machine but before a call to
9076	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9077	all differencing hard disks implicitly created by
9078	<link to="IMachine::attachDevice"/> for these indirect attachments.
9079	Such implicitly created hard disks will also be immediately deleted when
9080	detached explicitly using the <link to="IMachine::detachDevice"/>
9081	call if it is made before <link to="IMachine::saveSettings"/>. This
9082	implicit deletion is safe because newly created differencing hard
9083	disks do not contain any user data.
9084
9085	However, keep in mind that detaching differencing hard disks that were
9086	implicitly created by <link to="IMachine::attachDevice"/>
9087	before the last <link to="IMachine::saveSettings"/> call will
9088	<b>not</b> implicitly delete them as they may already contain some data
9089	(for example, as a result of virtual machine execution). If these hard
9090	disks are no more necessary, the caller can always delete them explicitly
9091	using <link to="#deleteStorage"/> after they are actually de-associated
9092	from this machine by the <link to="IMachine::saveSettings"/> call.
9093
9094	<h3>Smart Attachment</h3>
9095
9096	When normal base or immutable hard disks are indirectly attached to a
9097	virtual machine then some additional steps are performed to make sure the
9098	virtual machine will have the most recent "view" of the hard disk being
9099	attached. These steps include walking through the machine's snapshots
9100	starting from the current one and going through ancestors up to the first
9101	snapshot. Hard disks attached to the virtual machine in all
9102	of the encountered snapshots are checked whether they are descendants of
9103	the given normal base or immutable hard disk. The first found child (which
9104	is the differencing hard disk) will be used instead of the normal base or
9105	immutable hard disk as a parent for creating a new differencing hard disk
9106	that will be actually attached to the machine. And only if no descendants
9107	are found or if the virtual machine does not have any snapshots then the
9108	normal base or immutable hard disk will be used itself as a parent for
9109	this differencing hard disk.
9110
9111	It is easier to explain what smart attachment does using the
9112	following example:
9113	<pre>
9114	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9115
9116	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9117	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9118	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9119	Snapshot 4 (none) Snapshot 4 (none)
9120	CurState (none) CurState (D3->D2.vdi)
9121
9122	NOT
9123	...
9124	CurState (D3->B.vdi)
9125	</pre>
9126	The first column is the virtual machine configuration before the base hard
9127	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9128	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9129	mean that the hard disk that is actually attached to the machine is a
9130	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9131	another hard disk, <tt>B.vdi</tt>.
9132
9133	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9134	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9135	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9136	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9137	it cannot be attached directly and needs an indirect attachment (i.e.
9138	implicit creation of a new differencing hard disk). Due to the smart
9139	attachment procedure, the new differencing hard disk
9140	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9141	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9142	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9143	machine.
9144
9145	Note that if there is more than one descendant hard disk of the given base
9146	hard disk found in a snapshot, and there is an exact device, channel and
9147	bus match, then this exact match will be used. Otherwise, the youngest
9148	descendant will be picked up.
9149
9150	There is one more important aspect of the smart attachment procedure which
9151	is not related to snapshots at all. Before walking through the snapshots
9152	as described above, the backup copy of the current list of hard disk
9153	attachment is searched for descendants. This backup copy is created when
9154	the hard disk configuration is changed for the first time after the last
9155	<link to="IMachine::saveSettings"/> call and used by
9156	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9157	changes. When such a descendant is found in this backup copy, it will be
9158	simply re-attached back, without creating a new differencing hard disk for
9159	it. This optimization is necessary to make it possible to re-attach the
9160	base or immutable hard disk to a different bus, channel or device slot
9161	without losing the contents of the differencing hard disk actually
9162	attached to the machine in place of it.
9163	</desc>
9164
9165	<attribute name="id" type="uuid" mod="string" readonly="yes">
9166	<desc>
9167	UUID of the medium. For a newly created medium, this value is a randomly
9168	generated UUID.
9169
9170	<note>
9171	For media in one of MediumState_NotCreated, MediumState_Creating or
9172	MediumState_Deleting states, the value of this property is undefined
9173	and will most likely be an empty UUID.
9174	</note>
9175	</desc>
9176	</attribute>
9177
9178	<attribute name="description" type="wstring">
9179	<desc>
9180	Optional description of the medium. For a newly created medium the value
9181	of this attribute is an empty string.
9182
9183	Medium types that don't support this attribute will return E_NOTIMPL in
9184	attempt to get or set this attribute's value.
9185
9186	<note>
9187	For some storage types, reading this attribute may return an outdated
9188	(last known) value when <link to="#state"/> is <link
9189	to="MediumState_Inaccessible"/> or <link
9190	to="MediumState_LockedWrite"/> because the value of this attribute is
9191	stored within the storage unit itself. Also note that changing the
9192	attribute value is not possible in such case, as well as when the
9193	medium is the <link to="MediumState_LockedRead"/> state.
9194	</note>
9195	</desc>
9196	</attribute>
9197
9198	<attribute name="state" type="MediumState" readonly="yes">
9199	<desc>
9200	Returns the current medium state, which is the last state set by
9201	the accessibility check performed by <link to="#refreshState"/>.
9202	If that method has not yet been called on the medium, the state
9203	is "Inaccessible"; as opposed to truly inaccessible media, the
9204	value of <link to="#lastAccessError"/> will be an empty string in
9205	that case.
9206
9207	<note>As of version 3.1, this no longer performs an accessibility check
9208	automatically; call <link to="#refreshState"/> for that.
9209	</note>
9210	</desc>
9211	</attribute>
9212
9213	<attribute name="location" type="wstring">
9214	<desc>
9215	Location of the storage unit holding medium data.
9216
9217	The format of the location string is medium type specific. For medium
9218	types using regular files in a host's file system, the location
9219	string is the full file name.
9220
9221	Some medium types may support changing the storage unit location by
9222	simply changing the value of this property. If this operation is not
9223	supported, the implementation will return E_NOTIMPL in attempt to set
9224	this attribute's value.
9225
9226	When setting a value of the location attribute which is a regular file
9227	in the host's file system, the given file name may be either relative to
9228	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9229	absolute. Note that if the given location specification does not contain
9230	the file extension part then a proper default extension will be
9231	automatically appended by the implementation depending on the medium type.
9232	</desc>
9233	</attribute>
9234
9235	<attribute name="name" type="wstring" readonly="yes">
9236	<desc>
9237	Name of the storage unit holding medium data.
9238
9239	The returned string is a short version of the <link to="#location"/>
9240	attribute that is suitable for representing the medium in situations
9241	where the full location specification is too long (such as lists
9242	and comboboxes in GUI frontends). This string is also used by frontends
9243	to sort the media list alphabetically when needed.
9244
9245	For example, for locations that are regular files in the host's file
9246	system, the value of this attribute is just the file name (+ extension),
9247	without the path specification.
9248
9249	Note that as opposed to the <link to="#location"/> attribute, the name
9250	attribute will not necessary be unique for a list of media of the
9251	given type and format.
9252	</desc>
9253	</attribute>
9254
9255	<attribute name="deviceType" type="DeviceType" readonly="yes">
9256	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9257	medium.</desc>
9258	</attribute>
9259
9260	<attribute name="hostDrive" type="boolean" readonly="yes">
9261	<desc>True if this corresponds to a drive on the host.</desc>
9262	</attribute>
9263
9264	<attribute name="size" type="unsigned long long" readonly="yes">
9265	<desc>
9266	Physical size of the storage unit used to hold medium data (in bytes).
9267
9268	<note>
9269	For media whose <link to="#state"/> is <link
9270	to="MediumState_Inaccessible"/>, the value of this property is the
9271	last known size. For <link to="MediumState_NotCreated"/> media,
9272	the returned value is zero.
9273	</note>
9274	</desc>
9275	</attribute>
9276
9277	<attribute name="format" type="wstring" readonly="yes">
9278	<desc>
9279	Storage format of this medium.
9280
9281	The value of this attribute is a string that specifies a backend used
9282	to store medium data. The storage format is defined when you create a
9283	new medium or automatically detected when you open an existing medium,
9284	and cannot be changed later.
9285
9286	The list of all storage formats supported by this VirtualBox
9287	installation can be obtained using
9288	<link to="ISystemProperties::mediumFormats"/>.
9289	</desc>
9290	</attribute>
9291
9292	<attribute name="type" type="MediumType">
9293	<desc>
9294	Type (role) of this medium.
9295
9296	The following constraints apply when changing the value of this
9297	attribute:
9298	<ul>
9299	<li>If a medium is attached to a virtual machine (either in the
9300	current state or in one of the snapshots), its type cannot be
9301	changed.
9302	</li>
9303	<li>As long as the medium has children, its type cannot be set
9304	to <link to="MediumType_Writethrough"/>.
9305	</li>
9306	<li>The type of all differencing media is
9307	<link to="MediumType_Normal"/> and cannot be changed.
9308	</li>
9309	</ul>
9310
9311	The type of a newly created or opened medium is set to
9312	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9313	which have a type of <link to="MediumType_Writethrough"/>.
9314	</desc>
9315	</attribute>
9316
9317	<attribute name="parent" type="IMedium" readonly="yes">
9318	<desc>
9319	Parent of this medium (the medium this medium is directly based
9320	on).
9321
9322	Only differencing media have parents. For base (non-differencing)
9323	media, @c null is returned.
9324	</desc>
9325	</attribute>
9326
9327	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9328	<desc>
9329	Children of this medium (all differencing media directly based
9330	on this medium). A @c null array is returned if this medium
9331	does not have any children.
9332	</desc>
9333	</attribute>
9334
9335	<attribute name="base" type="IMedium" readonly="yes">
9336	<desc>
9337	Base medium of this medium.
9338
9339	If this is a differencing medium, its base medium is the medium
9340	the given medium branch starts from. For all other types of media, this
9341	property returns the medium object itself (i.e. the same object this
9342	property is read on).
9343	</desc>
9344	</attribute>
9345
9346	<attribute name="readOnly" type="boolean" readonly="yes">
9347	<desc>
9348	Returns @c true if this medium is read-only and @c false otherwise.
9349
9350	A medium is considered to be read-only when its contents cannot be
9351	modified without breaking the integrity of other parties that depend on
9352	this medium such as its child media or snapshots of virtual machines
9353	where this medium is attached to these machines. If there are no
9354	children and no such snapshots then there is no dependency and the
9355	medium is not read-only.
9356
9357	The value of this attribute can be used to determine the kind of the
9358	attachment that will take place when attaching this medium to a
9359	virtual machine. If the value is @c false then the medium will
9360	be attached directly. If the value is @c true then the medium
9361	will be attached indirectly by creating a new differencing child
9362	medium for that. See the interface description for more information.
9363
9364	Note that all <link to="MediumType_Immutable">Immutable</link> media
9365	are always read-only while all
9366	<link to="MediumType_Writethrough">Writethrough</link> media are
9367	always not.
9368
9369	<note>
9370	The read-only condition represented by this attribute is related to
9371	the medium type and usage, not to the current
9372	<link to="IMedium::state">medium state</link> and not to the read-only
9373	state of the storage unit.
9374	</note>
9375	</desc>
9376	</attribute>
9377
9378	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9379	<desc>
9380	Logical size of this medium (in megabytes), as reported to the
9381	guest OS running inside the virtual machine this medium is
9382	attached to. The logical size is defined when the medium is created
9383	and cannot be changed later.
9384
9385	<note>
9386	Reading this property on a differencing medium will return the size
9387	of its <link to="#base"/> medium.
9388	</note>
9389	<note>
9390	For media whose state is <link to="#state"/> is <link
9391	to="MediumState_Inaccessible"/>, the value of this property is the
9392	last known logical size. For <link to="MediumaState_NotCreated"/>
9393	media, the returned value is zero.
9394	</note>
9395	</desc>
9396	</attribute>
9397
9398	<attribute name="autoReset" type="boolean">
9399	<desc>
9400	Whether this differencing medium will be automatically reset each
9401	time a virtual machine it is attached to is powered up.
9402
9403	See <link to="#reset()"/> for more information about resetting
9404	differencing media.
9405
9406	<note>
9407	Reading this property on a base (non-differencing) medium will
9408	always @c false. Changing the value of this property in this
9409	case is not supported.
9410	</note>
9411
9412	<result name="VBOX_E_NOT_SUPPORTED">
9413	This is not a differencing medium (when changing the attribute
9414	value).
9415	</result>
9416	</desc>
9417	</attribute>
9418
9419	<attribute name="lastAccessError" type="wstring" readonly="yes">
9420	<desc>
9421	Text message that represents the result of the last accessibility
9422	check performed by <link to="#refreshState"/>.
9423
9424	An empty string is returned if the last accessibility check
9425	was successful or has not yet been called. As a result, if
9426	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9427	then <link to="#refreshState"/> has yet to be called; this is the
9428	default value of media after VirtualBox initialization.
9429	A non-empty string indicates a failure and should normally describe
9430	a reason of the failure (for example, a file read error).
9431	</desc>
9432	</attribute>
9433
9434	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9435	<desc>
9436	Array of UUIDs of all machines this medium is attached to.
9437
9438	A @c null array is returned if this medium is not attached to any
9439	machine or to any machine's snapshot.
9440
9441	<note>
9442	The returned array will include a machine even if this medium is not
9443	attached to that machine in the current state but attached to it in
9444	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9445	details.
9446	</note>
9447	</desc>
9448	</attribute>
9449
9450	<method name="refreshState">
9451	<desc>
9452	If the current medium state (see <link to="MediumState"/>) is one of
9453	"Created", "Inaccessible" or "LockedRead", then this performs an
9454	accessibility check on the medium and sets the value of the <link to="#state"/>
9455	attribute accordingly; that value is also returned for convenience.
9456
9457	For all other state values, this does not perform a refresh but returns
9458	the state only.
9459
9460	The refresh, if performed, may take a long time (several seconds or even
9461	minutes, depending on the storage unit location and format) because it performs an
9462	accessibility check of the storage unit. This check may cause a significant
9463	delay if the storage unit of the given medium is, for example, a file located
9464	on a network share which is not currently accessible due to connectivity
9465	problems. In that case, the call will not return until a timeout
9466	interval defined by the host OS for this operation expires. For this reason,
9467	it is recommended to never read this attribute on the main UI thread to avoid
9468	making the UI unresponsive.
9469
9470	If the last known state of the medium is "Created" and the accessibility
9471	check fails, then the state would be set to "Inaccessible", and
9472	<link to="#lastAccessError"/> may be used to get more details about the
9473	failure. If the state of the medium is "LockedRead", then it remains the
9474	same, and a non-empty value of <link to="#lastAccessError"/> will
9475	indicate a failed accessibility check in this case.
9476
9477	Note that not all medium states are applicable to all medium types.
9478	</desc>
9479	<param name="state" type="MediumState" dir="return">
9480	<desc>
9481	New medium state.
9482	</desc>
9483	</param>
9484	</method>
9485
9486	<method name="getSnapshotIds">
9487	<desc>
9488	Returns an array of UUIDs of all snapshots of the given machine where
9489	this medium is attached to.
9490
9491	If the medium is attached to the machine in the current state, then the
9492	first element in the array will always be the ID of the queried machine
9493	(i.e. the value equal to the @c machineId argument), followed by
9494	snapshot IDs (if any).
9495
9496	If the medium is not attached to the machine in the current state, then
9497	the array will contain only snapshot IDs.
9498
9499	The returned array may be @c null if this medium is not attached
9500	to the given machine at all, neither in the current state nor in one of
9501	the snapshots.
9502	</desc>
9503	<param name="machineId" type="uuid" mod="string" dir="in">
9504	<desc>
9505	UUID of the machine to query.
9506	</desc>
9507	</param>
9508	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9509	<desc>
9510	Array of snapshot UUIDs of the given machine using this medium.
9511	</desc>
9512	</param>
9513	</method>
9514
9515	<method name="lockRead">
9516	<desc>
9517	Locks this medium for reading.
9518
9519	A read lock is shared: many clients can simultaneously lock the
9520	same medium for reading unless it is already locked for writing (see
9521	<link to="#lockWrite"/>) in which case an error is returned.
9522
9523	When the medium is locked for reading, it cannot be modified
9524	from within VirtualBox. This means that any method that changes
9525	the properties of this medium or contents of the storage unit
9526	will return an error (unless explicitly stated otherwise). That
9527	includes an attempt to start a virtual machine that wants to
9528	write to the the medium.
9529
9530	When the virtual machine is started up, it locks for reading all
9531	media it uses in read-only mode. If some medium cannot be locked
9532	for reading, the startup procedure will fail.
9533	A medium is typically locked for reading while it is used by a running
9534	virtual machine but has a depending differencing image that receives
9535	the actual write operations. This way one base medium can have
9536	multiple child differencing images which can be written to
9537	simultaneously. Read-only media such as DVD and floppy images are
9538	also locked for reading only (so they can be in use by multiple
9539	machines simultaneously).
9540
9541	A medium is also locked for reading when it is the source of a
9542	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9543
9544	The medium locked for reading must be unlocked using the <link
9545	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9546	can be nested and must be followed by the same number of paired
9547	<link to="#unlockRead"/> calls.
9548
9549	This method sets the medium state (see <link to="#state"/>) to
9550	"LockedRead" on success. The medium's previous state must be
9551	one of "Created", "Inaccessible" or "LockedRead".
9552
9553	Locking an inaccessible medium is not an error; this method performs
9554	a logical lock that prevents modifications of this medium through
9555	the VirtualBox API, not a physical file-system lock of the underlying
9556	storage unit.
9557
9558	This method returns the current state of the medium
9559	<i>before</i> the operation.
9560
9561	<result name="VBOX_E_INVALID_OBJECT_STATE">
9562	Invalid medium state (e.g. not created, locked, inaccessible,
9563	creating, deleting).
9564	</result>
9565
9566	</desc>
9567	<param name="state" type="MediumState" dir="return">
9568	<desc>
9569	State of the medium after the operation.
9570	</desc>
9571	</param>
9572	</method>
9573
9574	<method name="unlockRead">
9575	<desc>
9576	Cancels the read lock previously set by <link to="#lockRead"/>.
9577
9578	For both success and failure, this method returns the current state
9579	of the medium <i>after</i> the operation.
9580
9581	See <link to="#lockRead"/> for more details.
9582
9583	<result name="VBOX_E_INVALID_OBJECT_STATE">
9584	Medium not locked for reading.
9585	</result>
9586
9587	</desc>
9588	<param name="state" type="MediumState" dir="return">
9589	<desc>
9590	State of the medium after the operation.
9591	</desc>
9592	</param>
9593	</method>
9594
9595	<method name="lockWrite">
9596	<desc>
9597	Locks this medium for writing.
9598
9599	A write lock, as opposed to <link to="#lockRead"/>, is
9600	exclusive: there may be only one client holding a write lock,
9601	and there may be no read locks while the write lock is held.
9602	As a result, read-locking fails if a write lock is held, and
9603	write-locking fails if either a read or another write lock is held.
9604
9605	When a medium is locked for writing, it cannot be modified
9606	from within VirtualBox, and it is not guaranteed that the values
9607	of its properties are up-to-date. Any method that changes the
9608	properties of this medium or contents of the storage unit will
9609	return an error (unless explicitly stated otherwise).
9610
9611	When a virtual machine is started up, it locks for writing all
9612	media it uses to write data to. If any medium could not be locked
9613	for writing, the startup procedure will fail. If a medium has
9614	differencing images, then while the machine is running, only
9615	the last ("leaf") differencing image is locked for writing,
9616	whereas its parents are locked for reading only.
9617
9618	A medium is also locked for writing when it is the target of a
9619	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9620
9621	The medium locked for writing must be unlocked using the <link
9622	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9623
9624	This method sets the medium state (see <link to="#state"/>) to
9625	"LockedWrite" on success. The medium's previous state must be
9626	either "Created" or "Inaccessible".
9627
9628	Locking an inaccessible medium is not an error; this method performs
9629	a logical lock that prevents modifications of this medium through
9630	the VirtualBox API, not a physical file-system lock of the underlying
9631	storage unit.
9632
9633	For both, success and failure, this method returns the current
9634	state of the medium <i>before</i> the operation.
9635
9636	<result name="VBOX_E_INVALID_OBJECT_STATE">
9637	Invalid medium state (e.g. not created, locked, inaccessible,
9638	creating, deleting).
9639	</result>
9640
9641	</desc>
9642	<param name="state" type="MediumState" dir="return">
9643	<desc>
9644	State of the medium after the operation.
9645	</desc>
9646	</param>
9647	</method>
9648
9649	<method name="unlockWrite">
9650	<desc>
9651	Cancels the write lock previously set by <link to="#lockWrite"/>.
9652
9653	For both success and failure, this method returns the current
9654	state of the medium <i>after</i> the operation.
9655
9656	See <link to="#lockWrite"/> for more details.
9657
9658	<result name="VBOX_E_INVALID_OBJECT_STATE">
9659	Medium not locked for writing.
9660	</result>
9661
9662	</desc>
9663	<param name="state" type="MediumState" dir="return">
9664	<desc>
9665	State of the medium after the operation.
9666	</desc>
9667	</param>
9668	</method>
9669
9670	<method name="close">
9671	<desc>
9672	Closes this medium.
9673
9674	The medium must not be attached to any known virtual machine
9675	and must not have any known child media, otherwise the
9676	operation will fail.
9677
9678	When the medium is successfully closed, it gets removed from
9679	the list of remembered media, but its storage unit is not
9680	deleted. In particular, this means that this medium can be
9681	later opened again using the <link
9682	to="IVirtualBox::openHardDisk"/> call.
9683
9684	Note that after this method successfully returns, the given medium
9685	object becomes uninitialized. This means that any attempt
9686	to call any of its methods or attributes will fail with the
9687	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9688
9689	<result name="VBOX_E_INVALID_OBJECT_STATE">
9690	Invalid medium state (other than not created, created or
9691	inaccessible).
9692	</result>
9693	<result name="VBOX_E_OBJECT_IN_USE">
9694	Medium attached to virtual machine.
9695	</result>
9696	<result name="VBOX_E_FILE_ERROR">
9697	Settings file not accessible.
9698	</result>
9699	<result name="VBOX_E_XML_ERROR">
9700	Could not parse the settings file.
9701	</result>
9702
9703	</desc>
9704	</method>
9705
9706	<!-- storage methods -->
9707
9708	<method name="getProperty">
9709	<desc>
9710	Returns the value of the custom medium property with the given name.
9711
9712	The list of all properties supported by the given medium format can
9713	be obtained with <link to="IMediumFormat::describeProperties"/>.
9714
9715	Note that if this method returns an empty string in @a value, the
9716	requested property is supported but currently not assigned any value.
9717
9718	<result name="VBOX_E_OBJECT_NOT_FOUND">
9719	Requested property does not exist (not supported by the format).
9720	</result>
9721	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9722	</desc>
9723	<param name="name" type="wstring" dir="in">
9724	<desc>Name of the property to get.</desc>
9725	</param>
9726	<param name="value" type="wstring" dir="return">
9727	<desc>Current property value.</desc>
9728	</param>
9729	</method>
9730
9731	<method name="setProperty">
9732	<desc>
9733	Sets the value of the custom medium property with the given name.
9734
9735	The list of all properties supported by the given medium format can
9736	be obtained with <link to="IMediumFormat::describeProperties"/>.
9737
9738	Note that setting the property value to @c null or an empty string is
9739	equivalent to deleting the existing value. A default value (if it is
9740	defined for this property) will be used by the format backend in this
9741	case.
9742
9743	<result name="VBOX_E_OBJECT_NOT_FOUND">
9744	Requested property does not exist (not supported by the format).
9745	</result>
9746	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9747	</desc>
9748	<param name="name" type="wstring" dir="in">
9749	<desc>Name of the property to set.</desc>
9750	</param>
9751	<param name="value" type="wstring" dir="in">
9752	<desc>Property value to set.</desc>
9753	</param>
9754	</method>
9755
9756	<method name="getProperties">
9757	<desc>
9758	Returns values for a group of properties in one call.
9759
9760	The names of the properties to get are specified using the @a names
9761	argument which is a list of comma-separated property names or
9762	an empty string if all properties are to be returned. Note that currently
9763	the value of this argument is ignored and the method always returns all
9764	existing properties.
9765
9766	The list of all properties supported by the given medium format can
9767	be obtained with <link to="IMediumFormat::describeProperties"/>.
9768
9769	The method returns two arrays, the array of property names corresponding
9770	to the @a names argument and the current values of these properties.
9771	Both arrays have the same number of elements with each elemend at the
9772	given index in the first array corresponds to an element at the same
9773	index in the second array.
9774
9775	Note that for properties that do not have assigned values,
9776	an empty string is returned at the appropriate index in the
9777	@a returnValues array.
9778
9779	</desc>
9780	<param name="names" type="wstring" dir="in">
9781	<desc>
9782	Names of properties to get.
9783	</desc>
9784	</param>
9785	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9786	<desc>Names of returned properties.</desc>
9787	</param>
9788	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9789	<desc>Values of returned properties.</desc>
9790	</param>
9791	</method>
9792
9793	<method name="setProperties">
9794	<desc>
9795	Sets values for a group of properties in one call.
9796
9797	The names of the properties to set are passed in the @a names
9798	array along with the new values for them in the @a values array. Both
9799	arrays have the same number of elements with each elemend at the given
9800	index in the first array corresponding to an element at the same index
9801	in the second array.
9802
9803	If there is at least one property name in @a names that is not valid,
9804	the method will fail before changing the values of any other properties
9805	from the @a names array.
9806
9807	Using this method over <link to="#setProperty"/> is preferred if you
9808	need to set several properties at once since it will result into less
9809	IPC calls.
9810
9811	The list of all properties supported by the given medium format can
9812	be obtained with <link to="IMediumFormat::describeProperties"/>.
9813
9814	Note that setting the property value to @c null or an empty string is
9815	equivalent to deleting the existing value. A default value (if it is
9816	defined for this property) will be used by the format backend in this
9817	case.
9818	</desc>
9819	<param name="names" type="wstring" safearray="yes" dir="in">
9820	<desc>Names of properties to set.</desc>
9821	</param>
9822	<param name="values" type="wstring" safearray="yes" dir="in">
9823	<desc>Values of properties to set.</desc>
9824	</param>
9825	</method>
9826
9827	<!-- storage methods -->
9828
9829	<method name="createBaseStorage">
9830	<desc>
9831	Starts creating a hard disk storage unit (fixed/dynamic, according
9832	to the variant flags) in in the background. The previous storage unit
9833	created for this object, if any, must first be deleted using
9834	<link to="#deleteStorage"/>, otherwise the operation will fail.
9835
9836	Before the operation starts, the medium is placed in
9837	<link to="MediumState_Creating"/> state. If the create operation
9838	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9839	state.
9840
9841	After the returned progress object reports that the operation has
9842	successfully completed, the medium state will be set to <link
9843	to="MediumState_Created"/>, the medium will be remembered by this
9844	VirtualBox installation and may be attached to virtual machines.
9845
9846	<result name="VBOX_E_NOT_SUPPORTED">
9847	The variant of storage creation operation is not supported. See <link
9848	to="IMediumFormat::capabilities"/>.
9849	</result>
9850	</desc>
9851	<param name="logicalSize" type="unsigned long long" dir="in">
9852	<desc>Maximum logical size of the medium in megabytes.</desc>
9853	</param>
9854	<param name="variant" type="MediumVariant" dir="in">
9855	<desc>Exact image variant which should be created.</desc>
9856	</param>
9857	<param name="progress" type="IProgress" dir="return">
9858	<desc>Progress object to track the operation completion.</desc>
9859	</param>
9860	</method>
9861
9862	<method name="deleteStorage">
9863	<desc>
9864	Starts deleting the storage unit of this medium.
9865
9866	The medium must not be attached to any known virtual machine and must
9867	not have any known child media, otherwise the operation will fail.
9868	It will also fail if there is no storage unit to delete or if deletion
9869	is already in progress, or if the medium is being in use (locked for
9870	read or for write) or inaccessible. Therefore, the only valid state for
9871	this operation to succeed is <link to="MediumState_Created"/>.
9872
9873	Before the operation starts, the medium is placed in
9874	<link to="MediumState_Deleting"/> state and gets removed from the list
9875	of remembered hard disks (media registry). If the delete operation
9876	fails, the medium will be remembered again and placed back to
9877	<link to="MediumState_Created"/> state.
9878
9879	After the returned progress object reports that the operation is
9880	complete, the medium state will be set to
9881	<link to="MediumState_NotCreated"/> and you will be able to use one of
9882	the storage creation methods to create it again.
9883
9884	<see>#close()</see>
9885
9886	<result name="VBOX_E_OBJECT_IN_USE">
9887	Medium is attached to a virtual machine.
9888	</result>
9889	<result name="VBOX_E_NOT_SUPPORTED">
9890	Storage deletion is not allowed because neither of storage creation
9891	operations are supported. See
9892	<link to="IMediumFormat::capabilities"/>.
9893	</result>
9894
9895	<note>
9896	If the deletion operation fails, it is not guaranteed that the storage
9897	unit still exists. You may check the <link to="IMedium::state"/> value
9898	to answer this question.
9899	</note>
9900	</desc>
9901	<param name="progress" type="IProgress" dir="return">
9902	<desc>Progress object to track the operation completion.</desc>
9903	</param>
9904	</method>
9905
9906	<!-- diff methods -->
9907
9908	<method name="createDiffStorage">
9909	<desc>
9910	Starts creating an empty differencing storage unit based on this
9911	medium in the format and at the location defined by the @a target
9912	argument.
9913
9914	The target medium must be in <link to="MediumState_NotCreated"/>
9915	state (i.e. must not have an existing storage unit). Upon successful
9916	completion, this operation will set the type of the target medium to
9917	<link to="MediumType_Normal"/> and create a storage unit necessary to
9918	represent the differencing medium data in the given format (according
9919	to the storage format of the target object).
9920
9921	After the returned progress object reports that the operation is
9922	successfully complete, the target medium gets remembered by this
9923	VirtualBox installation and may be attached to virtual machines.
9924
9925	<note>
9926	The medium will be set to <link to="MediumState_LockedRead"/>
9927	state for the duration of this operation.
9928	</note>
9929	<result name="VBOX_E_OBJECT_IN_USE">
9930	Medium not in @c NotCreated state.
9931	</result>
9932	</desc>
9933	<param name="target" type="IMedium" dir="in">
9934	<desc>Target medium.</desc>
9935	</param>
9936	<param name="variant" type="MediumVariant" dir="in">
9937	<desc>Exact image variant which should be created.</desc>
9938	</param>
9939	<param name="progress" type="IProgress" dir="return">
9940	<desc>Progress object to track the operation completion.</desc>
9941	</param>
9942	</method>
9943
9944	<method name="mergeTo">
9945	<desc>
9946	Starts merging the contents of this medium and all intermediate
9947	differencing media in the chain to the given target medium.
9948
9949	The target medium must be either a descendant of this medium or
9950	its ancestor (otherwise this method will immediately return a failure).
9951	It follows that there are two logical directions of the merge operation:
9952	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9953	ancestor (<i>backward merge</i>). Let us consider the following medium
9954	chain:
9955
9956	<pre>Base <- Diff_1 <- Diff_2</pre>
9957
9958	Here, calling this method on the <tt>Base</tt> medium object with
9959	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9960	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9961	merge. Note that in both cases the contents of the resulting medium
9962	will be the same, the only difference is the medium object that takes
9963	the result of the merge operation. In case of the forward merge in the
9964	above example, the result will be written to <tt>Diff_2</tt>; in case of
9965	the backward merge, the result will be written to <tt>Base</tt>. In
9966	other words, the result of the operation is always stored in the target
9967	medium.
9968
9969	Upon successful operation completion, the storage units of all media in
9970	the chain between this (source) medium and the target medium, including
9971	the source medium itself, will be automatically deleted and the
9972	relevant medium objects (including this medium) will become
9973	uninitialized. This means that any attempt to call any of
9974	their methods or attributes will fail with the
9975	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9976	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9977	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9978	Note that <tt>Diff_2</tt> in this case will become a base medium
9979	itself since it will no longer be based on any other medium.
9980
9981	Considering the above, all of the following conditions must be met in
9982	order for the merge operation to succeed:
9983	<ul>
9984	<li>
9985	Neither this (source) medium nor any intermediate
9986	differencing medium in the chain between it and the target
9987	medium is attached to any virtual machine.
9988	</li>
9989	<li>
9990	Neither the source medium nor the target medium is an
9991	<link to="MediumType_Immutable"/> medium.
9992	</li>
9993	<li>
9994	The part of the medium tree from the source medium to the
9995	target medium is a linear chain, i.e. all medium in this
9996	chain have exactly one child which is the next medium in this
9997	chain. The only exception from this rule is the target medium in
9998	the forward merge operation; it is allowed to have any number of
9999	child media because the merge operation will not change its
10000	logical contents (as it is seen by the guest OS or by children).
10001	</li>
10002	<li>
10003	None of the involved media are in
10004	<link to="MediumState_LockedRead"/> or
10005	<link to="MediumState_LockedWrite"/> state.
10006	</li>
10007	</ul>
10008
10009	<note>
10010	This (source) medium and all intermediates will be placed to <link
10011	to="MediumState_Deleting"/> state and the target medium will be
10012	placed to <link to="MediumState_LockedWrite"/> state and for the
10013	duration of this operation.
10014	</note>
10015	</desc>
10016	<param name="targetId" type="uuid" mod="string" dir="in">
10017	<desc>UUID of the target ancestor or descendant medium.</desc>
10018	</param>
10019	<param name="progress" type="IProgress" dir="return">
10020	<desc>Progress object to track the operation completion.</desc>
10021	</param>
10022	</method>
10023
10024	<!-- clone method -->
10025
10026	<method name="cloneTo">
10027	<desc>
10028	Starts creating a clone of this medium in the format and at the
10029	location defined by the @a target argument.
10030
10031	The target medium must be either in <link to="MediumState_NotCreated"/>
10032	state (i.e. must not have an existing storage unit) or in
10033	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10034	big enough to hold the data or else the copy will be partial). Upon
10035	successful completion, the cloned medium will contain exactly the
10036	same sector data as the medium being cloned, except that in the
10037	first case a new UUID for the clone will be randomly generated, and in
10038	the second case the UUID will remain unchanged.
10039
10040	The @a parent argument defines which medium will be the parent
10041	of the clone. Passing a @c null reference indicates that the clone will
10042	be a base image, i.e. completely independent. It is possible to specify
10043	an arbitrary medium for this parameter, including the parent of the
10044	medium which is being cloned. Even cloning to a child of the source
10045	medium is possible. Note that when cloning to an existing image, the
10046	@a parent irgument is ignored.
10047
10048	After the returned progress object reports that the operation is
10049	successfully complete, the target medium gets remembered by this
10050	VirtualBox installation and may be attached to virtual machines.
10051
10052	<note>
10053	This medium will be placed to <link to="MediumState_LockedRead"/>
10054	state for the duration of this operation.
10055	</note>
10056	<result name="E_NOTIMPL">
10057	The specified cloning variant is not supported at the moment.
10058	</result>
10059	</desc>
10060	<param name="target" type="IMedium" dir="in">
10061	<desc>Target medium.</desc>
10062	</param>
10063	<param name="variant" type="MediumVariant" dir="in">
10064	<desc>Exact image variant which should be created.</desc>
10065	</param>
10066	<param name="parent" type="IMedium" dir="in">
10067	<desc>Parent of the cloned medium.</desc>
10068	</param>
10069	<param name="progress" type="IProgress" dir="return">
10070	<desc>Progress object to track the operation completion.</desc>
10071	</param>
10072	</method>
10073
10074	<!-- other methods -->
10075
10076	<method name="compact">
10077	<desc>
10078	Starts compacting of this medium. This means that the medium is
10079	transformed into a possibly more compact storage representation.
10080	This potentially creates temporary images, which can require a
10081	substantial amount of additional disk space.
10082
10083	This medium will be placed to <link to="MediumState_LockedWrite"/>
10084	state and all its parent media (if any) will be placed to
10085	<link to="MediumState_LockedRead"/> state for the duration of this
10086	operation.
10087
10088	Please note that the results can be either returned straight away,
10089	or later as the result of the background operation via the object
10090	returned via the @a progress parameter.
10091
10092	<result name="VBOX_E_NOT_SUPPORTED">
10093	Medium format does not support compacting (but potentially
10094	needs it).
10095	</result>
10096	</desc>
10097	<param name="progress" type="IProgress" dir="return">
10098	<desc>Progress object to track the operation completion.</desc>
10099	</param>
10100	</method>
10101
10102	<method name="resize">
10103	<desc>
10104	Starts resizing this medium. This means that the nominal size of the
10105	medium is set to the new value. Both increasing and decreasing the
10106	size is possible, and there are no safety checks, since VirtualBox
10107	does not make any assumptions about the medium contents.
10108
10109	Resizing usually needs additional disk space, and possibly also
10110	some temporary disk space. Note that resize does not create a full
10111	temporary copy of the medium, so the additional disk space requirement
10112	is usually much lower than using the clone operation.
10113
10114	This medium will be placed to <link to="MediumState_LockedWrite"/>
10115	state for the duration of this operation.
10116
10117	Please note that the results can be either returned straight away,
10118	or later as the result of the background operation via the object
10119	returned via the @a progress parameter.
10120
10121	<result name="VBOX_E_NOT_SUPPORTED">
10122	Medium format does not support resizing.
10123	</result>
10124	</desc>
10125	<param name="logicalSize" type="unsigned long long" dir="in">
10126	<desc>New nominal capacity of the medium in megabytes.</desc>
10127	</param>
10128	<param name="progress" type="IProgress" dir="return">
10129	<desc>Progress object to track the operation completion.</desc>
10130	</param>
10131	</method>
10132
10133	<method name="reset">
10134	<desc>
10135	Starts erasing the contents of this differencing medium.
10136
10137	This operation will reset the differencing medium to its initial
10138	state when it does not contain any sector data and any read operation is
10139	redirected to its parent medium.
10140
10141	This medium will be placed to <link to="MediumState_LockedWrite"/>
10142	for the duration of this operation.
10143
10144	<result name="VBOX_E_NOT_SUPPORTED">
10145	This is not a differencing medium.
10146	</result>
10147	<result name="VBOX_E_INVALID_OBJECT_STATE">
10148	Medium is not in <link to="MediumState_Created"/> or
10149	<link to="MediumState_Inaccessible"/> state.
10150	</result>
10151	</desc>
10152	<param name="progress" type="IProgress" dir="return">
10153	<desc>Progress object to track the operation completion.</desc>
10154	</param>
10155	</method>
10156
10157	</interface>
10158
10159
10160	<!--
10161	// IMediumFormat
10162	/////////////////////////////////////////////////////////////////////////
10163	-->
10164
10165	<enum
10166	name="DataType"
10167	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10168	>
10169	<const name="Int32" value="0"/>
10170	<const name="Int8" value="1"/>
10171	<const name="String" value="2"/>
10172	</enum>
10173
10174	<enum
10175	name="DataFlags"
10176	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10177	>
10178	<const name="None" value="0x00"/>
10179	<const name="Mandatory" value="0x01"/>
10180	<const name="Expert" value="0x02"/>
10181	<const name="Array" value="0x04"/>
10182	<const name="FlagMask" value="0x07"/>
10183	</enum>
10184
10185	<enum
10186	name="MediumFormatCapabilities"
10187	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
10188	>
10189	<desc>
10190	Medium format capability flags.
10191	</desc>
10192
10193	<const name="Uuid" value="0x01">
10194	<desc>
10195	Supports UUIDs as expected by VirtualBox code.
10196	</desc>
10197	</const>
10198
10199	<const name="CreateFixed" value="0x02">
10200	<desc>
10201	Supports creating fixed size images, allocating all space instantly.
10202	</desc>
10203	</const>
10204
10205	<const name="CreateDynamic" value="0x04">
10206	<desc>
10207	Supports creating dynamically growing images, allocating space on
10208	demand.
10209	</desc>
10210	</const>
10211
10212	<const name="CreateSplit2G" value="0x08">
10213	<desc>
10214	Supports creating images split in chunks of a bit less than 2 GBytes.
10215	</desc>
10216	</const>
10217
10218	<const name="Differencing" value="0x10">
10219	<desc>
10220	Supports being used as a format for differencing media (see <link
10221	to="IMedium::createDiffStorage"/>).
10222	</desc>
10223	</const>
10224
10225	<const name="Asynchronous" value="0x20">
10226	<desc>
10227	Supports asynchronous I/O operations for at least some configurations.
10228	</desc>
10229	</const>
10230
10231	<const name="File" value="0x40">
10232	<desc>
10233	The format backend operates on files (the <link to="IMedium::location"/>
10234	attribute of the medium specifies a file used to store medium
10235	data; for a list of supported file extensions see
10236	<link to="IMediumFormat::fileExtensions"/>).
10237	</desc>
10238	</const>
10239
10240	<const name="Properties" value="0x80">
10241	<desc>
10242	The format backend uses the property interface to configure the storage
10243	location and properties (the <link to="IMediumFormat::describeProperties"/>
10244	method is used to get access to properties supported by the given medium format).
10245	</desc>
10246	</const>
10247
10248	<const name="CapabilityMask" value="0xFF"/>
10249	</enum>
10250
10251	<interface
10252	name="IMediumFormat" extends="$unknown"
10253	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10254	wsmap="managed"
10255	>
10256	<desc>
10257	The IMediumFormat interface represents a medium format.
10258
10259	Each medium format has an associated backend which is used to handle
10260	media stored in this format. This interface provides information
10261	about the properties of the associated backend.
10262
10263	Each medium format is identified by a string represented by the
10264	<link to="#id"/> attribute. This string is used in calls like
10265	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10266	format.
10267
10268	The list of all supported medium formats can be obtained using
10269	<link to="ISystemProperties::mediaFormats"/>.
10270
10271	<see>IMedium</see>
10272	</desc>
10273
10274	<attribute name="id" type="wstring" readonly="yes">
10275	<desc>
10276	Identifier of this format.
10277
10278	The format identifier is a non-@c null non-empty ASCII string. Note that
10279	this string is case-insensitive. This means that, for example, all of
10280	the following strings:
10281	<pre>
10282	"VDI"
10283	"vdi"
10284	"VdI"</pre>
10285	refer to the same medium format.
10286
10287	This string is used in methods of other interfaces where it is necessary
10288	to specify a medium format, such as
10289	<link to="IVirtualBox::createHardDisk"/>.
10290	</desc>
10291	</attribute>
10292
10293	<attribute name="name" type="wstring" readonly="yes">
10294	<desc>
10295	Human readable description of this format.
10296
10297	Mainly for use in file open dialogs.
10298	</desc>
10299	</attribute>
10300
10301	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10302	<desc>
10303	Array of strings containing the supported file extensions.
10304
10305	The first extension in the array is the extension preferred by the
10306	backend. It is recommended to use this extension when specifying a
10307	location of the storage unit for a new medium.
10308
10309	Note that some backends do not work on files, so this array may be
10310	empty.
10311
10312	<see>IMediumFormat::capabilities</see>
10313	</desc>
10314	</attribute>
10315
10316	<attribute name="capabilities" type="unsigned long" readonly="yes">
10317	<desc>
10318	Capabilities of the format as a set of bit flags.
10319
10320	For the meaning of individual capability flags see
10321	<link to="MediumFormatCapabilities"/>.
10322	</desc>
10323	</attribute>
10324
10325	<method name="describeProperties">
10326	<desc>
10327	Returns several arrays describing the properties supported by this
10328	format.
10329
10330	An element with the given index in each array describes one
10331	property. Thus, the number of elements in each returned array is the
10332	same and corresponds to the number of supported properties.
10333
10334	The returned arrays are filled in only if the
10335	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10336	All arguments must be non-@c null.
10337
10338	<see>DataType</see>
10339	<see>DataFlags</see>
10340	</desc>
10341
10342	<param name="names" type="wstring" safearray="yes" dir="out">
10343	<desc>Array of property names.</desc>
10344	</param>
10345	<param name="description" type="wstring" safearray="yes" dir="out">
10346	<desc>Array of property descriptions.</desc>
10347	</param>
10348	<param name="types" type="DataType" safearray="yes" dir="out">
10349	<desc>Array of property types.</desc>
10350	</param>
10351	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10352	<desc>Array of property flags.</desc>
10353	</param>
10354	<param name="defaults" type="wstring" safearray="yes" dir="out">
10355	<desc>Array of default property values.</desc>
10356	</param>
10357	</method>
10358
10359	</interface>
10360
10361
10362	<!--
10363	// IKeyboard
10364	/////////////////////////////////////////////////////////////////////////
10365	-->
10366
10367	<interface
10368	name="IKeyboard" extends="$unknown"
10369	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10370	wsmap="managed"
10371	>
10372	<desc>
10373	The IKeyboard interface represents the virtual machine's keyboard. Used
10374	in <link to="IConsole::keyboard"/>.
10375
10376	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10377	to the virtual machine.
10378
10379	</desc>
10380	<method name="putScancode">
10381	<desc>Sends a scancode to the keyboard.
10382
10383	<result name="VBOX_E_IPRT_ERROR">
10384	Could not send scan code to virtual keyboard.
10385	</result>
10386
10387	</desc>
10388	<param name="scancode" type="long" dir="in"/>
10389	</method>
10390
10391	<method name="putScancodes">
10392	<desc>Sends an array of scancodes to the keyboard.
10393
10394	<result name="VBOX_E_IPRT_ERROR">
10395	Could not send all scan codes to virtual keyboard.
10396	</result>
10397
10398	</desc>
10399	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10400	<param name="codesStored" type="unsigned long" dir="return"/>
10401	</method>
10402
10403	<method name="putCAD">
10404	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10405	function is nothing special, it is just a convenience function
10406	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10407
10408	<result name="VBOX_E_IPRT_ERROR">
10409	Could not send all scan codes to virtual keyboard.
10410	</result>
10411
10412	</desc>
10413	</method>
10414
10415	</interface>
10416
10417
10418	<!--
10419	// IMouse
10420	/////////////////////////////////////////////////////////////////////////
10421	-->
10422
10423	<enum
10424	name="MouseButtonState"
10425	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10426	>
10427	<desc>
10428	Mouse button state.
10429	</desc>
10430
10431	<const name="LeftButton" value="0x01"/>
10432	<const name="RightButton" value="0x02"/>
10433	<const name="MiddleButton" value="0x04"/>
10434	<const name="WheelUp" value="0x08"/>
10435	<const name="WheelDown" value="0x10"/>
10436	<const name="XButton1" value="0x20"/>
10437	<const name="XButton2" value="0x40"/>
10438	<const name="MouseStateMask" value="0x7F"/>
10439	</enum>
10440
10441	<interface
10442	name="IMouse" extends="$unknown"
10443	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10444	wsmap="managed"
10445	>
10446	<desc>
10447	The IMouse interface represents the virtual machine's mouse. Used in
10448	<link to="IConsole::mouse"/>.
10449
10450	Through this interface, the virtual machine's virtual mouse can be
10451	controlled.
10452	</desc>
10453
10454	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10455	<desc>
10456	Whether the guest OS supports absolute mouse pointer positioning
10457	or not.
10458	<note>
10459	VirtualBox Guest Tools need to be installed to the guest OS
10460	in order to enable absolute mouse positioning support.
10461	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
10462	callback to be instantly informed about changes of this attribute
10463	during virtual machine execution.
10464	</note>
10465	<see><link to="#putMouseEventAbsolute"/></see>
10466	</desc>
10467	</attribute>
10468
10469	<method name="putMouseEvent">
10470	<desc>
10471	Initiates a mouse event using relative pointer movements
10472	along x and y axis.
10473
10474	<result name="E_ACCESSDENIED">
10475	Console not powered up.
10476	</result>
10477	<result name="VBOX_E_IPRT_ERROR">
10478	Could not send mouse event to virtual mouse.
10479	</result>
10480
10481	</desc>
10482
10483	<param name="dx" type="long" dir="in">
10484	<desc>
10485	Amount of pixels the mouse should move to the right.
10486	Negative values move the mouse to the left.
10487	</desc>
10488	</param>
10489	<param name="dy" type="long" dir="in">
10490	<desc>
10491	Amount of pixels the mouse should move downwards.
10492	Negative values move the mouse upwards.
10493	</desc>
10494	</param>
10495	<param name="dz" type="long" dir="in">
10496	<desc>
10497	Amount of mouse wheel moves.
10498	Positive values describe clockwise wheel rotations,
10499	negative values describe counterclockwise rotations.
10500	</desc>
10501	</param>
10502	<param name="dw" type="long" dir="in">
10503	<desc>
10504	Amount of horizontal mouse wheel moves.
10505	Positive values describe a movement to the left,
10506	negative values describe a movement to the right.
10507	</desc>
10508	</param>
10509	<param name="buttonState" type="long" dir="in">
10510	<desc>
10511	The current state of mouse buttons. Every bit represents
10512	a mouse button as follows:
10513	<table>
10514	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10515	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10516	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10517	</table>
10518	A value of <tt>1</tt> means the corresponding button is pressed.
10519	otherwise it is released.
10520	</desc>
10521	</param>
10522	</method>
10523
10524	<method name="putMouseEventAbsolute">
10525	<desc>
10526	Positions the mouse pointer using absolute x and y coordinates.
10527	These coordinates are expressed in pixels and
10528	start from <tt>[1,1]</tt> which corresponds to the top left
10529	corner of the virtual display.
10530
10531	<result name="E_ACCESSDENIED">
10532	Console not powered up.
10533	</result>
10534	<result name="VBOX_E_IPRT_ERROR">
10535	Could not send mouse event to virtual mouse.
10536	</result>
10537
10538	<note>
10539	This method will have effect only if absolute mouse
10540	positioning is supported by the guest OS.
10541	</note>
10542
10543	<see><link to="#absoluteSupported"/></see>
10544	</desc>
10545
10546	<param name="x" type="long" dir="in">
10547	<desc>
10548	X coordinate of the pointer in pixels, starting from @c 1.
10549	</desc>
10550	</param>
10551	<param name="y" type="long" dir="in">
10552	<desc>
10553	Y coordinate of the pointer in pixels, starting from @c 1.
10554	</desc>
10555	</param>
10556	<param name="dz" type="long" dir="in">
10557	<desc>
10558	Amount of mouse wheel moves.
10559	Positive values describe clockwise wheel rotations,
10560	negative values describe counterclockwise rotations.
10561	</desc>
10562	</param>
10563	<param name="dw" type="long" dir="in">
10564	<desc>
10565	Amount of horizontal mouse wheel moves.
10566	Positive values describe a movement to the left,
10567	negative values describe a movement to the right.
10568	</desc>
10569	</param>
10570	<param name="buttonState" type="long" dir="in">
10571	<desc>
10572	The current state of mouse buttons. Every bit represents
10573	a mouse button as follows:
10574	<table>
10575	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10576	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10577	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10578	</table>
10579	A value of @c 1 means the corresponding button is pressed.
10580	otherwise it is released.
10581	</desc>
10582	</param>
10583	</method>
10584
10585	</interface>
10586
10587	<!--
10588	// IDisplay
10589	/////////////////////////////////////////////////////////////////////////
10590	-->
10591
10592	<enum
10593	name="FramebufferPixelFormat"
10594	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10595	>
10596	<desc>
10597	Format of the video memory buffer. Constants represented by this enum can
10598	be used to test for particular values of <link
10599	to="IFramebuffer::pixelFormat"/>. See also <link
10600	to="IFramebuffer::requestResize"/>.
10601
10602	See also www.fourcc.org for more information about FOURCC pixel formats.
10603	</desc>
10604
10605	<const name="Opaque" value="0">
10606	<desc>
10607	Unknown buffer format (the user may not assume any particular format of
10608	the buffer).
10609	</desc>
10610	</const>
10611	<const name="FOURCC_RGB" value="0x32424752">
10612	<desc>
10613	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10614	bit layout).
10615	</desc>
10616	</const>
10617	</enum>
10618
10619	<interface
10620	name="IFramebuffer" extends="$unknown"
10621	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10622	wsmap="suppress"
10623	>
10624	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10625	<desc>Address of the start byte of the frame buffer.</desc>
10626	</attribute>
10627
10628	<attribute name="width" type="unsigned long" readonly="yes">
10629	<desc>Frame buffer width, in pixels.</desc>
10630	</attribute>
10631
10632	<attribute name="height" type="unsigned long" readonly="yes">
10633	<desc>Frame buffer height, in pixels.</desc>
10634	</attribute>
10635
10636	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10637	<desc>
10638	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10639	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10640	are: 8, 15, 16, 24 and 32.
10641	</desc>
10642	</attribute>
10643
10644	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10645	<desc>
10646	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10647	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10648	size of the scan line must be aligned to 32 bits.
10649	</desc>
10650	</attribute>
10651
10652	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10653	<desc>
10654	Frame buffer pixel format. It's either one of the values defined by <link
10655	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10656	<note>
10657	This attribute must never return <link
10658	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10659	<link to="#address"/> points to must be always known.
10660	</note>
10661	</desc>
10662	</attribute>
10663
10664	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10665	<desc>
10666	Defines whether this frame buffer uses the virtual video card's memory
10667	buffer (guest VRAM) directly or not. See <link
10668	to="IFramebuffer::requestResize"/> for more information.
10669	</desc>
10670	</attribute>
10671
10672	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10673	<desc>
10674	Hint from the frame buffer about how much of the standard
10675	screen height it wants to use for itself. This information is
10676	exposed to the guest through the VESA BIOS and VMMDev interface
10677	so that it can use it for determining its video mode table. It
10678	is not guaranteed that the guest respects the value.
10679	</desc>
10680	</attribute>
10681
10682	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10683	<desc>
10684	An alpha-blended overlay which is superposed over the frame buffer.
10685	The initial purpose is to allow the display of icons providing
10686	information about the VM state, including disk activity, in front
10687	ends which do not have other means of doing that. The overlay is
10688	designed to controlled exclusively by IDisplay. It has no locking
10689	of its own, and any changes made to it are not guaranteed to be
10690	visible until the affected portion of IFramebuffer is updated. The
10691	overlay can be created lazily the first time it is requested. This
10692	attribute can also return @c null to signal that the overlay is not
10693	implemented.
10694	</desc>
10695	</attribute>
10696
10697	<attribute name="winId" type="unsigned long long" readonly="yes">
10698	<desc>
10699	Platform-dependent identifier of the window where context of this
10700	frame buffer is drawn, or zero if there's no such window.
10701	</desc>
10702	</attribute>
10703
10704	<method name="lock">
10705	<desc>
10706	Locks the frame buffer.
10707	Gets called by the IDisplay object where this frame buffer is
10708	bound to.
10709	</desc>
10710	</method>
10711
10712	<method name="unlock">
10713	<desc>
10714	Unlocks the frame buffer.
10715	Gets called by the IDisplay object where this frame buffer is
10716	bound to.
10717	</desc>
10718	</method>
10719
10720	<method name="notifyUpdate">
10721	<desc>
10722	Informs about an update.
10723	Gets called by the display object where this buffer is
10724	registered.
10725	</desc>
10726	<param name="x" type="unsigned long" dir="in"/>
10727	<param name="y" type="unsigned long" dir="in"/>
10728	<param name="width" type="unsigned long" dir="in"/>
10729	<param name="height" type="unsigned long" dir="in"/>
10730	</method>
10731
10732	<method name="requestResize">
10733	<desc>
10734	Requests a size and pixel format change.
10735
10736	There are two modes of working with the video buffer of the virtual
10737	machine. The <i>indirect</i> mode implies that the IFramebuffer
10738	implementation allocates a memory buffer for the requested display mode
10739	and provides it to the virtual machine. In <i>direct</i> mode, the
10740	IFramebuffer implementation uses the memory buffer allocated and owned
10741	by the virtual machine. This buffer represents the video memory of the
10742	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10743	usually faster because the implementation gets a raw pointer to the
10744	guest VRAM buffer which it can directly use for visualizing the contents
10745	of the virtual display, as opposed to the indirect mode where the
10746	contents of guest VRAM are copied to the memory buffer provided by
10747	the implementation every time a display update occurs.
10748
10749	It is important to note that the direct mode is really fast only when
10750	the implementation uses the given guest VRAM buffer directly, for
10751	example, by blitting it to the window representing the virtual machine's
10752	display, which saves at least one copy operation comparing to the
10753	indirect mode. However, using the guest VRAM buffer directly is not
10754	always possible: the format and the color depth of this buffer may be
10755	not supported by the target window, or it may be unknown (opaque) as in
10756	case of text or non-linear multi-plane VGA video modes. In this case,
10757	the indirect mode (that is always available) should be used as a
10758	fallback: when the guest VRAM contents are copied to the
10759	implementation-provided memory buffer, color and format conversion is
10760	done automatically by the underlying code.
10761
10762	The @a pixelFormat parameter defines whether the direct mode is
10763	available or not. If @a pixelFormat is <link
10764	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10765	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10766	@a bytesPerLine parameters must be ignored and the implementation must use
10767	the indirect mode (where it provides its own buffer in one of the
10768	supported formats). In all other cases, @a pixelFormat together with
10769	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10770	buffer pointed to by the @a VRAM parameter and the implementation is
10771	free to choose which mode to use. To indicate that this frame buffer uses
10772	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10773	attribute must return @c true and <link to="#address"/> must
10774	return exactly the same address that is passed in the @a VRAM parameter
10775	of this method; otherwise it is assumed that the indirect strategy is
10776	chosen.
10777
10778	The @a width and @a height parameters represent the size of the
10779	requested display mode in both modes. In case of indirect mode, the
10780	provided memory buffer should be big enough to store data of the given
10781	display mode. In case of direct mode, it is guaranteed that the given
10782	@a VRAM buffer contains enough space to represent the display mode of the
10783	given size. Note that this frame buffer's <link to="#width"/> and <link
10784	to="#height"/> attributes must return exactly the same values as
10785	passed to this method after the resize is completed (see below).
10786
10787	The @a finished output parameter determines if the implementation has
10788	finished resizing the frame buffer or not. If, for some reason, the
10789	resize cannot be finished immediately during this call, @a finished
10790	must be set to @c false, and the implementation must call
10791	<link to="IDisplay::resizeCompleted"/> after it has returned from
10792	this method as soon as possible. If @a finished is @c false, the
10793	machine will not call any frame buffer methods until
10794	<link to="IDisplay::resizeCompleted"/> is called.
10795
10796	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10797	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10798	this frame buffer must return exactly the same values as specified in the
10799	parameters of this method, after the resize is completed. If the
10800	indirect mode is chosen, these attributes must return values describing
10801	the format of the implementation's own memory buffer <link
10802	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10803	value must always correlate with <link to="#pixelFormat"/>. Note that
10804	the <link to="#pixelFormat"/> attribute must never return <link
10805	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10806
10807	<note>
10808	This method is called by the IDisplay object under the
10809	<link to="#lock"/> provided by this IFramebuffer
10810	implementation. If this method returns @c false in @a finished, then
10811	this lock is not released until
10812	<link to="IDisplay::resizeCompleted"/> is called.
10813	</note>
10814	</desc>
10815	<param name="screenId" type="unsigned long" dir="in">
10816	<desc>
10817	Logical screen number. Must be used in the corresponding call to
10818	<link to="IDisplay::resizeCompleted"/> if this call is made.
10819	</desc>
10820	</param>
10821	<param name="pixelFormat" type="unsigned long" dir="in">
10822	<desc>
10823	Pixel format of the memory buffer pointed to by @a VRAM.
10824	See also <link to="FramebufferPixelFormat"/>.
10825	</desc>
10826	</param>
10827	<param name="VRAM" type="octet" mod="ptr" dir="in">
10828	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10829	</param>
10830	<param name="bitsPerPixel" type="unsigned long" dir="in">
10831	<desc>Color depth, bits per pixel.</desc>
10832	</param>
10833	<param name="bytesPerLine" type="unsigned long" dir="in">
10834	<desc>Size of one scan line, in bytes.</desc>
10835	</param>
10836	<param name="width" type="unsigned long" dir="in">
10837	<desc>Width of the guest display, in pixels.</desc>
10838	</param>
10839	<param name="height" type="unsigned long" dir="in">
10840	<desc>Height of the guest display, in pixels.</desc>
10841	</param>
10842	<param name="finished" type="boolean" dir="return">
10843	<desc>
10844	Can the VM start using the new frame buffer immediately
10845	after this method returns or it should wait for
10846	<link to="IDisplay::resizeCompleted"/>.
10847	</desc>
10848	</param>
10849	</method>
10850
10851	<method name="videoModeSupported">
10852	<desc>
10853	Returns whether the frame buffer implementation is willing to
10854	support a given video mode. In case it is not able to render
10855	the video mode (or for some reason not willing), it should
10856	return @c false. Usually this method is called when the guest
10857	asks the VMM device whether a given video mode is supported
10858	so the information returned is directly exposed to the guest.
10859	It is important that this method returns very quickly.
10860	</desc>
10861	<param name="width" type="unsigned long" dir="in"/>
10862	<param name="height" type="unsigned long" dir="in"/>
10863	<param name="bpp" type="unsigned long" dir="in"/>
10864	<param name="supported" type="boolean" dir="return"/>
10865	</method>
10866
10867	<method name="getVisibleRegion">
10868	<desc>
10869	Returns the visible region of this frame buffer.
10870
10871	If the @a rectangles parameter is @c null then the value of the
10872	@a count parameter is ignored and the number of elements necessary to
10873	describe the current visible region is returned in @a countCopied.
10874
10875	If @a rectangles is not @c null but @a count is less
10876	than the required number of elements to store region data, the method
10877	will report a failure. If @a count is equal or greater than the
10878	required number of elements, then the actual number of elements copied
10879	to the provided array will be returned in @a countCopied.
10880
10881	<note>
10882	The address of the provided array must be in the process space of
10883	this IFramebuffer object.
10884	</note>
10885	<note>
10886	Method not yet implemented.
10887	</note>
10888	</desc>
10889	<param name="rectangles" type="octet" mod="ptr" dir="in">
10890	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10891	</param>
10892	<param name="count" type="unsigned long" dir="in">
10893	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10894	</param>
10895	<param name="countCopied" type="unsigned long" dir="return">
10896	<desc>Number of elements copied to the @a rectangles array.</desc>
10897	</param>
10898	</method>
10899
10900	<method name="setVisibleRegion">
10901	<desc>
10902	Suggests a new visible region to this frame buffer. This region
10903	represents the area of the VM display which is a union of regions of
10904	all top-level windows of the guest operating system running inside the
10905	VM (if the Guest Additions for this system support this
10906	functionality). This information may be used by the frontends to
10907	implement the seamless desktop integration feature.
10908
10909	<note>
10910	The address of the provided array must be in the process space of
10911	this IFramebuffer object.
10912	</note>
10913	<note>
10914	The IFramebuffer implementation must make a copy of the provided
10915	array of rectangles.
10916	</note>
10917	<note>
10918	Method not yet implemented.
10919	</note>
10920	</desc>
10921	<param name="rectangles" type="octet" mod="ptr" dir="in">
10922	<desc>Pointer to the @c RTRECT array.</desc>
10923	</param>
10924	<param name="count" type="unsigned long" dir="in">
10925	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10926	</param>
10927	</method>
10928
10929	<method name="processVHWACommand">
10930	<desc>
10931	Posts a Video HW Acceleration Command to the frame buffer for processing.
10932	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10933	are posted from quest to the host to be processed by the host hardware.
10934
10935	<note>
10936	The address of the provided command must be in the process space of
10937	this IFramebuffer object.
10938	</note>
10939	</desc>
10940
10941	<param name="command" type="octet" mod="ptr" dir="in">
10942	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10943	</param>
10944	</method>
10945
10946	</interface>
10947
10948	<interface
10949	name="IFramebufferOverlay" extends="IFramebuffer"
10950	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10951	wsmap="suppress"
10952	>
10953	<desc>
10954	The IFramebufferOverlay interface represents an alpha blended overlay
10955	for displaying status icons above an IFramebuffer. It is always created
10956	not visible, so that it must be explicitly shown. It only covers a
10957	portion of the IFramebuffer, determined by its width, height and
10958	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10959	that order) format, and may be written to directly. Do re-read the
10960	width though, after setting it, as it may be adjusted (increased) to
10961	make it more suitable for the front end.
10962	</desc>
10963	<attribute name="x" type="unsigned long" readonly="yes">
10964	<desc>X position of the overlay, relative to the frame buffer.</desc>
10965	</attribute>
10966
10967	<attribute name="y" type="unsigned long" readonly="yes">
10968	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10969	</attribute>
10970
10971	<attribute name="visible" type="boolean" readonly="no">
10972	<desc>
10973	Whether the overlay is currently visible.
10974	</desc>
10975	</attribute>
10976
10977	<attribute name="alpha" type="unsigned long" readonly="no">
10978	<desc>
10979	The global alpha value for the overlay. This may or may not be
10980	supported by a given front end.
10981	</desc>
10982	</attribute>
10983
10984	<method name="move">
10985	<desc>
10986	Changes the overlay's position relative to the IFramebuffer.
10987	</desc>
10988	<param name="x" type="unsigned long" dir="in"/>
10989	<param name="y" type="unsigned long" dir="in"/>
10990	</method>
10991
10992	</interface>
10993
10994	<interface
10995	name="IDisplay" extends="$unknown"
10996	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
10997	wsmap="managed"
10998	>
10999	<desc>
11000	The IDisplay interface represents the virtual machine's display.
11001
11002	The object implementing this interface is contained in each
11003	<link to="IConsole::display"/> attribute and represents the visual
11004	output of the virtual machine.
11005
11006	The virtual display supports pluggable output targets represented by the
11007	IFramebuffer interface. Examples of the output target are a window on
11008	the host computer or an RDP session's display on a remote computer.
11009	</desc>
11010	<attribute name="width" type="unsigned long" readonly="yes">
11011	<desc>Current display width.</desc>
11012	</attribute>
11013
11014	<attribute name="height" type="unsigned long" readonly="yes">
11015	<desc>Current display height.</desc>
11016	</attribute>
11017
11018	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11019	<desc>
11020	Current guest display color depth. Note that this may differ
11021	from <link to="IFramebuffer::bitsPerPixel"/>.
11022	</desc>
11023	</attribute>
11024
11025	<method name="setFramebuffer">
11026	<desc>
11027	Sets the framebuffer for given screen.
11028	</desc>
11029	<param name="screenId" type="unsigned long" dir="in"/>
11030	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11031	</method>
11032
11033	<method name="getFramebuffer">
11034	<desc>
11035	Queries the framebuffer for given screen.
11036	</desc>
11037	<param name="screenId" type="unsigned long" dir="in"/>
11038	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11039	<param name="xOrigin" type="long" dir="out"/>
11040	<param name="yOrigin" type="long" dir="out"/>
11041	</method>
11042
11043	<method name="setVideoModeHint">
11044	<desc>
11045	Asks VirtualBox to request the given video mode from
11046	the guest. This is just a hint and it cannot be guaranteed
11047	that the requested resolution will be used. Guest Additions
11048	are required for the request to be seen by guests. The caller
11049	should issue the request and wait for a resolution change and
11050	after a timeout retry.
11051
11052	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11053	parameters means that the corresponding values should be taken from the
11054	current video mode (i.e. left unchanged).
11055
11056	If the guest OS supports multi-monitor configuration then the @a display
11057	parameter specifies the number of the guest display to send the hint to:
11058	@c 0 is the primary display, @c 1 is the first secondary and
11059	so on. If the multi-monitor configuration is not supported, @a display
11060	must be @c 0.
11061
11062	<result name="E_INVALIDARG">
11063	The @a display is not associated with any monitor.
11064	</result>
11065
11066	</desc>
11067	<param name="width" type="unsigned long" dir="in"/>
11068	<param name="height" type="unsigned long" dir="in"/>
11069	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11070	<param name="display" type="unsigned long" dir="in"/>
11071	</method>
11072
11073	<method name="setSeamlessMode">
11074	<desc>
11075	Enables or disables seamless guest display rendering (seamless desktop
11076	integration) mode.
11077	<note>
11078	Calling this method has no effect if <link
11079	to="IGuest::supportsSeamless"/> returns @c false.
11080	</note>
11081	</desc>
11082	<param name="enabled" type="boolean" dir="in"/>
11083	</method>
11084
11085	<method name="takeScreenShot">
11086	<desc>
11087	Takes a screen shot of the requested size and copies it to the
11088	32-bpp buffer allocated by the caller and pointed to by @a address.
11089	A pixel consists of 4 bytes in order: B, G, R, 0.
11090
11091	<note>This API can be used only by the COM/XPCOM C++ API as it
11092	requires pointer support. Use <link to="#takeScreenShotSlow" />
11093	with other language bindings.
11094	</note>
11095
11096	<result name="E_NOTIMPL">
11097	Feature not implemented.
11098	</result>
11099	<result name="VBOX_E_IPRT_ERROR">
11100	Could not take a screenshot.
11101	</result>
11102
11103	</desc>
11104	<param name="address" type="octet" mod="ptr" dir="in"/>
11105	<param name="width" type="unsigned long" dir="in"/>
11106	<param name="height" type="unsigned long" dir="in"/>
11107	</method>
11108
11109	<method name="takeScreenShotSlow">
11110	<desc>
11111	Takes a guest screen shot of the requested size and returns it as
11112	an array of bytes in uncompressed 32-bit RGBA format.
11113	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11114
11115	This API is slow, but could be the only option to get guest screenshot
11116	for scriptable languages not allowed to manipulate with addresses
11117	directly.
11118
11119	<result name="E_NOTIMPL">
11120	Feature not implemented.
11121	</result>
11122	<result name="VBOX_E_IPRT_ERROR">
11123	Could not take a screenshot.
11124	</result>
11125	</desc>
11126	<param name="width" type="unsigned long" dir="in">
11127	<desc>
11128	Desired image width.
11129	</desc>
11130	</param>
11131	<param name="height" type="unsigned long" dir="in">
11132	<desc>
11133	Desired image height.
11134	</desc>
11135	</param>
11136	<param name="screenData" type="octet" dir="return" safearray="yes">
11137	<desc>
11138	Array with resulting screen data.
11139	</desc>
11140	</param>
11141	</method>
11142
11143	<method name="drawToScreen">
11144	<desc>
11145	Draws a 32-bpp image of the specified size from the given buffer
11146	to the given point on the VM display.
11147
11148	<result name="E_NOTIMPL">
11149	Feature not implemented.
11150	</result>
11151	<result name="VBOX_E_IPRT_ERROR">
11152	Could not draw to screen.
11153	</result>
11154
11155	</desc>
11156	<param name="address" type="octet" mod="ptr" dir="in"/>
11157	<param name="x" type="unsigned long" dir="in"/>
11158	<param name="y" type="unsigned long" dir="in"/>
11159	<param name="width" type="unsigned long" dir="in"/>
11160	<param name="height" type="unsigned long" dir="in"/>
11161	</method>
11162
11163	<method name="invalidateAndUpdate">
11164	<desc>
11165	Does a full invalidation of the VM display and instructs the VM
11166	to update it.
11167
11168	<result name="VBOX_E_IPRT_ERROR">
11169	Could not invalidate and update screen.
11170	</result>
11171
11172	</desc>
11173	</method>
11174
11175	<method name="resizeCompleted">
11176	<desc>
11177	Signals that a framebuffer has completed the resize operation.
11178
11179	<result name="VBOX_E_NOT_SUPPORTED">
11180	Operation only valid for external frame buffers.
11181	</result>
11182
11183	</desc>
11184	<param name="screenId" type="unsigned long" dir="in"/>
11185	</method>
11186
11187	<method name="updateCompleted">
11188	<desc>
11189	Signals that a framebuffer has completed the update operation.
11190
11191	<result name="VBOX_E_NOT_SUPPORTED">
11192	Operation only valid for external frame buffers.
11193	</result>
11194
11195	</desc>
11196	</method>
11197
11198	<method name="completeVHWACommand">
11199	<desc>
11200	Signals that the Video HW Acceleration command has completed.
11201	</desc>
11202
11203	<param name="command" type="octet" mod="ptr" dir="in">
11204	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11205	</param>
11206	</method>
11207
11208	</interface>
11209
11210	<!--
11211	// INetworkAdapter
11212	/////////////////////////////////////////////////////////////////////////
11213	-->
11214
11215	<enum
11216	name="NetworkAttachmentType"
11217	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11218	>
11219	<desc>
11220	Network attachment type.
11221	</desc>
11222
11223	<const name="Null" value="0">
11224	<desc>Null value, also means "not attached".</desc>
11225	</const>
11226	<const name="NAT" value="1"/>
11227	<const name="Bridged" value="2"/>
11228	<const name="Internal" value="3"/>
11229	<const name="HostOnly" value="4"/>
11230	</enum>
11231
11232	<enum
11233	name="NetworkAdapterType"
11234	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11235	>
11236	<desc>
11237	Network adapter type.
11238	</desc>
11239
11240	<const name="Null" value="0">
11241	<desc>Null value (never used by the API).</desc>
11242	</const>
11243	<const name="Am79C970A" value="1">
11244	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11245	</const>
11246	<const name="Am79C973" value="2">
11247	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11248	</const>
11249	<const name="I82540EM" value="3">
11250	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11251	</const>
11252	<const name="I82543GC" value="4">
11253	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11254	</const>
11255	<const name="I82545EM" value="5">
11256	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11257	</const>
11258	<const name="Virtio" value="6">
11259	<desc>Virtio network device.</desc>
11260	</const>
11261	</enum>
11262
11263	<interface
11264	name="INetworkAdapter" extends="$unknown"
11265	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
11266	wsmap="managed"
11267	>
11268	<desc>
11269	Represents a virtual network adapter that is attached to a virtual machine.
11270	Each virtual machine has a fixed number of network adapter slots with one
11271	instance of this attached to each of them. Call
11272	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11273	is attached to a given slot in a given machine.
11274
11275	Each network adapter can be in one of five attachment modes, which are
11276	represented by the <link to="NetworkAttachmentType" /> enumeration;
11277	see the <link to="#attachmentType" /> attribute.
11278	</desc>
11279
11280	<attribute name="adapterType" type="NetworkAdapterType">
11281	<desc>
11282	Type of the virtual network adapter. Depending on this value,
11283	VirtualBox will provide a different virtual network hardware
11284	to the guest.
11285	</desc>
11286	</attribute>
11287
11288	<attribute name="slot" type="unsigned long" readonly="yes">
11289	<desc>
11290	Slot number this adapter is plugged into. Corresponds to
11291	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11292	to obtain this instance.
11293	</desc>
11294	</attribute>
11295
11296	<attribute name="enabled" type="boolean">
11297	<desc>
11298	Flag whether the network adapter is present in the
11299	guest system. If disabled, the virtual guest hardware will
11300	not contain this network adapter. Can only be changed when
11301	the VM is not running.
11302	</desc>
11303	</attribute>
11304
11305	<attribute name="MACAddress" type="wstring">
11306	<desc>
11307	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11308	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11309	</desc>
11310	</attribute>
11311
11312	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11313
11314	<attribute name="hostInterface" type="wstring">
11315	<desc>
11316	Name of the host network interface the VM is attached to.
11317	</desc>
11318	</attribute>
11319
11320	<attribute name="internalNetwork" type="wstring">
11321	<desc>
11322	Name of the internal network the VM is attached to.
11323	</desc>
11324	</attribute>
11325
11326	<attribute name="NATNetwork" type="wstring">
11327	<desc>
11328	Name of the NAT network the VM is attached to.
11329	</desc>
11330	</attribute>
11331
11332	<attribute name="cableConnected" type="boolean">
11333	<desc>
11334	Flag whether the adapter reports the cable as connected or not.
11335	It can be used to report offline situations to a VM.
11336	</desc>
11337	</attribute>
11338
11339	<attribute name="lineSpeed" type="unsigned long">
11340	<desc>
11341	Line speed reported by custom drivers, in units of 1 kbps.
11342	</desc>
11343	</attribute>
11344
11345	<attribute name="traceEnabled" type="boolean">
11346	<desc>
11347	Flag whether network traffic from/to the network card should be traced.
11348	Can only be toggled when the VM is turned off.
11349	</desc>
11350	</attribute>
11351
11352	<attribute name="traceFile" type="wstring">
11353	<desc>
11354	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11355	will be used.
11356	</desc>
11357	</attribute>
11358
11359	<method name="attachToNAT">
11360	<desc>
11361	Attach the network adapter to the Network Address Translation (NAT) interface.
11362	</desc>
11363	</method>
11364
11365	<method name="attachToBridgedInterface">
11366	<desc>
11367	Attach the network adapter to a bridged host interface.
11368	</desc>
11369	</method>
11370
11371	<method name="attachToInternalNetwork">
11372	<desc>
11373	Attach the network adapter to an internal network.
11374	</desc>
11375	</method>
11376
11377	<method name="attachToHostOnlyInterface">
11378	<desc>
11379	Attach the network adapter to the host-only network.
11380	</desc>
11381	</method>
11382
11383	<method name="detach">
11384	<desc>
11385	Detach the network adapter
11386	</desc>
11387	</method>
11388	</interface>
11389
11390
11391	<!--
11392	// ISerialPort
11393	/////////////////////////////////////////////////////////////////////////
11394	-->
11395
11396	<enum
11397	name="PortMode"
11398	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11399	>
11400	<desc>
11401	The PortMode enumeration represents possible communication modes for
11402	the virtual serial port device.
11403	</desc>
11404
11405	<const name="Disconnected" value="0">
11406	<desc>Virtual device is not attached to any real host device.</desc>
11407	</const>
11408	<const name="HostPipe" value="1">
11409	<desc>Virtual device is attached to a host pipe.</desc>
11410	</const>
11411	<const name="HostDevice" value="2">
11412	<desc>Virtual device is attached to a host device.</desc>
11413	</const>
11414	<const name="RawFile" value="3">
11415	<desc>Virtual device is attached to a raw file.</desc>
11416	</const>
11417	</enum>
11418
11419	<interface
11420	name="ISerialPort" extends="$unknown"
11421	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11422	wsmap="managed"
11423	>
11424
11425	<desc>
11426	The ISerialPort interface represents the virtual serial port device.
11427
11428	The virtual serial port device acts like an ordinary serial port
11429	inside the virtual machine. This device communicates to the real
11430	serial port hardware in one of two modes: host pipe or host device.
11431
11432	In host pipe mode, the #path attribute specifies the path to the pipe on
11433	the host computer that represents a serial port. The #server attribute
11434	determines if this pipe is created by the virtual machine process at
11435	machine startup or it must already exist before starting machine
11436	execution.
11437
11438	In host device mode, the #path attribute specifies the name of the
11439	serial port device on the host computer.
11440
11441	There is also a third communication mode: the disconnected mode. In this
11442	mode, the guest OS running inside the virtual machine will be able to
11443	detect the serial port, but all port write operations will be discarded
11444	and all port read operations will return no data.
11445
11446	<see>IMachine::getSerialPort</see>
11447	</desc>
11448
11449	<attribute name="slot" type="unsigned long" readonly="yes">
11450	<desc>
11451	Slot number this serial port is plugged into. Corresponds to
11452	the value you pass to <link to="IMachine::getSerialPort"/>
11453	to obtain this instance.
11454	</desc>
11455	</attribute>
11456
11457	<attribute name="enabled" type="boolean">
11458	<desc>
11459	Flag whether the serial port is enabled. If disabled,
11460	the serial port will not be reported to the guest OS.
11461	</desc>
11462	</attribute>
11463
11464	<attribute name="IOBase" type="unsigned long">
11465	<desc>Base I/O address of the serial port.</desc>
11466	</attribute>
11467
11468	<attribute name="IRQ" type="unsigned long">
11469	<desc>IRQ number of the serial port.</desc>
11470	</attribute>
11471
11472	<attribute name="hostMode" type="PortMode">
11473	<desc>
11474	How is this port connected to the host.
11475	<note>
11476	Changing this attribute may fail if the conditions for
11477	<link to="#path"/> are not met.
11478	</note>
11479	</desc>
11480	</attribute>
11481
11482	<attribute name="server" type="boolean">
11483	<desc>
11484	Flag whether this serial port acts as a server (creates a new pipe on
11485	the host) or as a client (uses the existing pipe). This attribute is
11486	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11487	</desc>
11488	</attribute>
11489
11490	<attribute name="path" type="wstring">
11491	<desc>
11492	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11493	PortMode_HostPipe, or the host serial device name when
11494	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11495	cases, setting a @c null or empty string as the attribute's value
11496	is an error. Otherwise, the value of this property is ignored.
11497	</desc>
11498	</attribute>
11499
11500	</interface>
11501
11502	<!--
11503	// IParallelPort
11504	/////////////////////////////////////////////////////////////////////////
11505	-->
11506
11507	<interface
11508	name="IParallelPort" extends="$unknown"
11509	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11510	wsmap="managed"
11511	>
11512
11513	<desc>
11514	The IParallelPort interface represents the virtual parallel port device.
11515
11516	The virtual parallel port device acts like an ordinary parallel port
11517	inside the virtual machine. This device communicates to the real
11518	parallel port hardware using the name of the parallel device on the host
11519	computer specified in the #path attribute.
11520
11521	Each virtual parallel port device is assigned a base I/O address and an
11522	IRQ number that will be reported to the guest operating system and used
11523	to operate the given parallel port from within the virtual machine.
11524
11525	<see>IMachine::getParallelPort</see>
11526	</desc>
11527
11528	<attribute name="slot" type="unsigned long" readonly="yes">
11529	<desc>
11530	Slot number this parallel port is plugged into. Corresponds to
11531	the value you pass to <link to="IMachine::getParallelPort"/>
11532	to obtain this instance.
11533	</desc>
11534	</attribute>
11535
11536	<attribute name="enabled" type="boolean">
11537	<desc>
11538	Flag whether the parallel port is enabled. If disabled,
11539	the parallel port will not be reported to the guest OS.
11540	</desc>
11541	</attribute>
11542
11543	<attribute name="IOBase" type="unsigned long">
11544	<desc>Base I/O address of the parallel port.</desc>
11545	</attribute>
11546
11547	<attribute name="IRQ" type="unsigned long">
11548	<desc>IRQ number of the parallel port.</desc>
11549	</attribute>
11550
11551	<attribute name="path" type="wstring">
11552	<desc>
11553	Host parallel device name. If this parallel port is enabled, setting a
11554	@c null or an empty string as this attribute's value will result into
11555	an error.
11556	</desc>
11557	</attribute>
11558
11559	</interface>
11560
11561
11562	<!--
11563	// IMachineDebugger
11564	/////////////////////////////////////////////////////////////////////////
11565	-->
11566
11567	<interface
11568	name="IMachineDebugger" extends="$unknown"
11569	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11570	wsmap="suppress"
11571	>
11572	<method name="resetStats">
11573	<desc>
11574	Reset VM statistics.
11575	</desc>
11576	<param name="pattern" type="wstring" dir="in">
11577	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11578	</param>
11579	</method>
11580
11581	<method name="dumpStats">
11582	<desc>
11583	Dumps VM statistics.
11584	</desc>
11585	<param name="pattern" type="wstring" dir="in">
11586	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11587	</param>
11588	</method>
11589
11590	<method name="getStats">
11591	<desc>
11592	Get the VM statistics in a XMLish format.
11593	</desc>
11594	<param name="pattern" type="wstring" dir="in">
11595	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11596	</param>
11597	<param name="withDescriptions" type="boolean" dir="in">
11598	<desc>Whether to include the descriptions.</desc>
11599	</param>
11600	<param name="stats" type="wstring" dir="out">
11601	<desc>The XML document containing the statistics.</desc>
11602	</param>
11603	</method>
11604
11605	<method name="injectNMI">
11606	<desc>
11607	Inject an NMI into a running VT-x/AMD-V VM.
11608	</desc>
11609	</method>
11610
11611	<attribute name="singlestep" type="boolean">
11612	<desc>Switch for enabling singlestepping.</desc>
11613	</attribute>
11614
11615	<attribute name="recompileUser" type="boolean">
11616	<desc>Switch for forcing code recompilation for user mode code.</desc>
11617	</attribute>
11618
11619	<attribute name="recompileSupervisor" type="boolean">
11620	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11621	</attribute>
11622
11623	<attribute name="PATMEnabled" type="boolean">
11624	<desc>Switch for enabling and disabling the PATM component.</desc>
11625	</attribute>
11626
11627	<attribute name="CSAMEnabled" type="boolean">
11628	<desc>Switch for enabling and disabling the CSAM component.</desc>
11629	</attribute>
11630
11631	<attribute name="logEnabled" type="boolean">
11632	<desc>Switch for enabling and disabling logging.</desc>
11633	</attribute>
11634
11635	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11636	<desc>
11637	Flag indicating whether the VM is currently making use of CPU hardware
11638	virtualization extensions.
11639	</desc>
11640	</attribute>
11641
11642	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11643	<desc>
11644	Flag indicating whether the VM is currently making use of the nested paging
11645	CPU hardware virtualization extension.
11646	</desc>
11647	</attribute>
11648
11649	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11650	<desc>
11651	Flag indicating whether the VM is currently making use of the VPID
11652	VT-x extension.
11653	</desc>
11654	</attribute>
11655
11656	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11657	<desc>
11658	Flag indicating whether the VM is currently making use of the Physical
11659	Address Extension CPU feature.
11660	</desc>
11661	</attribute>
11662
11663	<attribute name="virtualTimeRate" type="unsigned long">
11664	<desc>
11665	The rate at which the virtual time runs expressed as a percentage.
11666	The accepted range is 2% to 20000%.
11667	</desc>
11668	</attribute>
11669
11670	<!-- @todo method for setting log flags, groups and destination! -->
11671
11672	<attribute name="VM" type="unsigned long long" readonly="yes">
11673	<desc>
11674	Gets the VM handle. This is only for internal use while
11675	we carve the details of this interface.
11676	</desc>
11677	</attribute>
11678
11679	</interface>
11680
11681	<!--
11682	// IUSBController
11683	/////////////////////////////////////////////////////////////////////////
11684	-->
11685
11686	<interface
11687	name="IUSBController" extends="$unknown"
11688	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11689	wsmap="managed"
11690	>
11691	<attribute name="enabled" type="boolean">
11692	<desc>
11693	Flag whether the USB controller is present in the
11694	guest system. If disabled, the virtual guest hardware will
11695	not contain any USB controller. Can only be changed when
11696	the VM is powered off.
11697	</desc>
11698	</attribute>
11699
11700	<attribute name="enabledEhci" type="boolean">
11701	<desc>
11702	Flag whether the USB EHCI controller is present in the
11703	guest system. If disabled, the virtual guest hardware will
11704	not contain a USB EHCI controller. Can only be changed when
11705	the VM is powered off.
11706	</desc>
11707	</attribute>
11708
11709	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11710	<desc>
11711	USB standard version which the controller implements.
11712	This is a BCD which means that the major version is in the
11713	high byte and minor version is in the low byte.
11714	</desc>
11715	</attribute>
11716
11717	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11718	<desc>
11719	List of USB device filters associated with the machine.
11720
11721	If the machine is currently running, these filters are activated
11722	every time a new (supported) USB device is attached to the host
11723	computer that was not ignored by global filters
11724	(<link to="IHost::USBDeviceFilters"/>).
11725
11726	These filters are also activated when the machine is powered up.
11727	They are run against a list of all currently available USB
11728	devices (in states
11729	<link to="USBDeviceState_Available"/>,
11730	<link to="USBDeviceState_Busy"/>,
11731	<link to="USBDeviceState_Held"/>) that were not previously
11732	ignored by global filters.
11733
11734	If at least one filter matches the USB device in question, this
11735	device is automatically captured (attached to) the virtual USB
11736	controller of this machine.
11737
11738	<see>IUSBDeviceFilter, ::IUSBController</see>
11739	</desc>
11740	</attribute>
11741
11742	<method name="createDeviceFilter">
11743	<desc>
11744	Creates a new USB device filter. All attributes except
11745	the filter name are set to empty (any match),
11746	<i>active</i> is @c false (the filter is not active).
11747
11748	The created filter can then be added to the list of filters using
11749	<link to="#insertDeviceFilter"/>.
11750
11751	<result name="VBOX_E_INVALID_VM_STATE">
11752	The virtual machine is not mutable.
11753	</result>
11754
11755	<see>#deviceFilters</see>
11756	</desc>
11757	<param name="name" type="wstring" dir="in">
11758	<desc>
11759	Filter name. See <link to="IUSBDeviceFilter::name"/>
11760	for more info.
11761	</desc>
11762	</param>
11763	<param name="filter" type="IUSBDeviceFilter" dir="return">
11764	<desc>Created filter object.</desc>
11765	</param>
11766	</method>
11767
11768	<method name="insertDeviceFilter">
11769	<desc>
11770	Inserts the given USB device to the specified position
11771	in the list of filters.
11772
11773	Positions are numbered starting from <tt>0</tt>. If the specified
11774	position is equal to or greater than the number of elements in
11775	the list, the filter is added to the end of the collection.
11776
11777	<note>
11778	Duplicates are not allowed, so an attempt to insert a
11779	filter that is already in the collection, will return an
11780	error.
11781	</note>
11782
11783	<result name="VBOX_E_INVALID_VM_STATE">
11784	Virtual machine is not mutable.
11785	</result>
11786	<result name="E_INVALIDARG">
11787	USB device filter not created within this VirtualBox instance.
11788	</result>
11789	<result name="VBOX_E_INVALID_OBJECT_STATE">
11790	USB device filter already in list.
11791	</result>
11792
11793	<see>#deviceFilters</see>
11794	</desc>
11795	<param name="position" type="unsigned long" dir="in">
11796	<desc>Position to insert the filter to.</desc>
11797	</param>
11798	<param name="filter" type="IUSBDeviceFilter" dir="in">
11799	<desc>USB device filter to insert.</desc>
11800	</param>
11801	</method>
11802
11803	<method name="removeDeviceFilter">
11804	<desc>
11805	Removes a USB device filter from the specified position in the
11806	list of filters.
11807
11808	Positions are numbered starting from <tt>0</tt>. Specifying a
11809	position equal to or greater than the number of elements in
11810	the list will produce an error.
11811
11812	<see>#deviceFilters</see>
11813
11814	<result name="VBOX_E_INVALID_VM_STATE">
11815	Virtual machine is not mutable.
11816	</result>
11817	<result name="E_INVALIDARG">
11818	USB device filter list empty or invalid @a position.
11819	</result>
11820
11821	</desc>
11822	<param name="position" type="unsigned long" dir="in">
11823	<desc>Position to remove the filter from.</desc>
11824	</param>
11825	<param name="filter" type="IUSBDeviceFilter" dir="return">
11826	<desc>Removed USB device filter.</desc>
11827	</param>
11828	</method>
11829
11830	</interface>
11831
11832
11833	<!--
11834	// IUSBDevice
11835	/////////////////////////////////////////////////////////////////////////
11836	-->
11837
11838	<interface
11839	name="IUSBDevice" extends="$unknown"
11840	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11841	wsmap="managed"
11842	>
11843	<desc>
11844	The IUSBDevice interface represents a virtual USB device attached to the
11845	virtual machine.
11846
11847	A collection of objects implementing this interface is stored in the
11848	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11849	attached to a running virtual machine's USB controller.
11850	</desc>
11851
11852	<attribute name="id" type="uuid" mod="string" readonly="yes">
11853	<desc>
11854	Unique USB device ID. This ID is built from #vendorId,
11855	#productId, #revision and #serialNumber.
11856	</desc>
11857	</attribute>
11858
11859	<attribute name="vendorId" type="unsigned short" readonly="yes">
11860	<desc>Vendor ID.</desc>
11861	</attribute>
11862
11863	<attribute name="productId" type="unsigned short" readonly="yes">
11864	<desc>Product ID.</desc>
11865	</attribute>
11866
11867	<attribute name="revision" type="unsigned short" readonly="yes">
11868	<desc>
11869	Product revision number. This is a packed BCD represented as
11870	unsigned short. The high byte is the integer part and the low
11871	byte is the decimal.
11872	</desc>
11873	</attribute>
11874
11875	<attribute name="manufacturer" type="wstring" readonly="yes">
11876	<desc>Manufacturer string.</desc>
11877	</attribute>
11878
11879	<attribute name="product" type="wstring" readonly="yes">
11880	<desc>Product string.</desc>
11881	</attribute>
11882
11883	<attribute name="serialNumber" type="wstring" readonly="yes">
11884	<desc>Serial number string.</desc>
11885	</attribute>
11886
11887	<attribute name="address" type="wstring" readonly="yes">
11888	<desc>Host specific address of the device.</desc>
11889	</attribute>
11890
11891	<attribute name="port" type="unsigned short" readonly="yes">
11892	<desc>
11893	Host USB port number the device is physically
11894	connected to.
11895	</desc>
11896	</attribute>
11897
11898	<attribute name="version" type="unsigned short" readonly="yes">
11899	<desc>
11900	The major USB version of the device - 1 or 2.
11901	</desc>
11902	</attribute>
11903
11904	<attribute name="portVersion" type="unsigned short" readonly="yes">
11905	<desc>
11906	The major USB version of the host USB port the device is
11907	physically connected to - 1 or 2. For devices not connected to
11908	anything this will have the same value as the version attribute.
11909	</desc>
11910	</attribute>
11911
11912	<attribute name="remote" type="boolean" readonly="yes">
11913	<desc>
11914	Whether the device is physically connected to a remote VRDP
11915	client or to a local host machine.
11916	</desc>
11917	</attribute>
11918
11919	</interface>
11920
11921
11922	<!--
11923	// IUSBDeviceFilter
11924	/////////////////////////////////////////////////////////////////////////
11925	-->
11926
11927	<interface
11928	name="IUSBDeviceFilter" extends="$unknown"
11929	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11930	wsmap="managed"
11931	>
11932	<desc>
11933	The IUSBDeviceFilter interface represents an USB device filter used
11934	to perform actions on a group of USB devices.
11935
11936	This type of filters is used by running virtual machines to
11937	automatically capture selected USB devices once they are physically
11938	attached to the host computer.
11939
11940	A USB device is matched to the given device filter if and only if all
11941	attributes of the device match the corresponding attributes of the
11942	filter (that is, attributes are joined together using the logical AND
11943	operation). On the other hand, all together, filters in the list of
11944	filters carry the semantics of the logical OR operation. So if it is
11945	desirable to create a match like "this vendor id OR this product id",
11946	one needs to create two filters and specify "any match" (see below)
11947	for unused attributes.
11948
11949	All filter attributes used for matching are strings. Each string
11950	is an expression representing a set of values of the corresponding
11951	device attribute, that will match the given filter. Currently, the
11952	following filtering expressions are supported:
11953
11954	<ul>
11955	<li><i>Interval filters</i>. Used to specify valid intervals for
11956	integer device attributes (Vendor ID, Product ID and Revision).
11957	The format of the string is:
11958
11959	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11960
11961	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11962	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11963	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11964	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11965	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11966	possible integer is assumed.
11967	</li>
11968	<li><i>Boolean filters</i>. Used to specify acceptable values for
11969	boolean device attributes. The format of the string is:
11970
11971	<tt>true\|false\|yes\|no\|0\|1</tt>
11972
11973	</li>
11974	<li><i>Exact match</i>. Used to specify a single value for the given
11975	device attribute. Any string that doesn't start with <tt>int:</tt>
11976	represents the exact match. String device attributes are compared to
11977	this string including case of symbols. Integer attributes are first
11978	converted to a string (see individual filter attributes) and then
11979	compared ignoring case.
11980
11981	</li>
11982	<li><i>Any match</i>. Any value of the corresponding device attribute
11983	will match the given filter. An empty or @c null string is
11984	used to construct this type of filtering expressions.
11985
11986	</li>
11987	</ul>
11988
11989	<note>
11990	On the Windows host platform, interval filters are not currently
11991	available. Also all string filter attributes
11992	(<link to="#manufacturer"/>, <link to="#product"/>,
11993	<link to="#serialNumber"/>) are ignored, so they behave as
11994	<i>any match</i> no matter what string expression is specified.
11995	</note>
11996
11997	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11998	</desc>
11999
12000	<attribute name="name" type="wstring">
12001	<desc>
12002	Visible name for this filter.
12003	This name is used to visually distinguish one filter from another,
12004	so it can neither be @c null nor an empty string.
12005	</desc>
12006	</attribute>
12007
12008	<attribute name="active" type="boolean">
12009	<desc>Whether this filter active or has been temporarily disabled.</desc>
12010	</attribute>
12011
12012	<attribute name="vendorId" type="wstring">
12013	<desc>
12014	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12015	The string representation for the <i>exact matching</i>
12016	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12017	(including leading zeroes).
12018	</desc>
12019	</attribute>
12020
12021	<attribute name="productId" type="wstring">
12022	<desc>
12023	<link to="IUSBDevice::productId">Product ID</link> filter.
12024	The string representation for the <i>exact matching</i>
12025	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12026	(including leading zeroes).
12027	</desc>
12028	</attribute>
12029
12030	<attribute name="revision" type="wstring">
12031	<desc>
12032	<link to="IUSBDevice::productId">Product revision number</link>
12033	filter. The string representation for the <i>exact matching</i>
12034	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12035	of the integer part of the revision, and <tt>F</tt> is the
12036	decimal digit of its fractional part (including leading and
12037	trailing zeros).
12038	Note that for interval filters, it's best to use the hexadecimal
12039	form, because the revision is stored as a 16 bit packed BCD value;
12040	so the expression <tt>int:0x0100-0x0199</tt> will match any
12041	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12042	</desc>
12043	</attribute>
12044
12045	<attribute name="manufacturer" type="wstring">
12046	<desc>
12047	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12048	</desc>
12049	</attribute>
12050
12051	<attribute name="product" type="wstring">
12052	<desc>
12053	<link to="IUSBDevice::product">Product</link> filter.
12054	</desc>
12055	</attribute>
12056
12057	<attribute name="serialNumber" type="wstring">
12058	<desc>
12059	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12060	</desc>
12061	</attribute>
12062
12063	<attribute name="port" type="wstring">
12064	<desc>
12065	<link to="IUSBDevice::port">Host USB port</link> filter.
12066	</desc>
12067	</attribute>
12068
12069	<attribute name="remote" type="wstring">
12070	<desc>
12071	<link to="IUSBDevice::remote">Remote state</link> filter.
12072	<note>
12073	This filter makes sense only for machine USB filters,
12074	i.e. it is ignored by IHostUSBDeviceFilter objects.
12075	</note>
12076	</desc>
12077	</attribute>
12078
12079	<attribute name="maskedInterfaces" type="unsigned long">
12080	<desc>
12081	This is an advanced option for hiding one or more USB interfaces
12082	from the guest. The value is a bit mask where the bits that are set
12083	means the corresponding USB interface should be hidden, masked off
12084	if you like.
12085	This feature only works on Linux hosts.
12086	</desc>
12087	</attribute>
12088
12089	</interface>
12090
12091
12092	<!--
12093	// IHostUSBDevice
12094	/////////////////////////////////////////////////////////////////////////
12095	-->
12096
12097	<enum
12098	name="USBDeviceState"
12099	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12100	>
12101	<desc>
12102	USB device state. This enumeration represents all possible states
12103	of the USB device physically attached to the host computer regarding
12104	its state on the host computer and availability to guest computers
12105	(all currently running virtual machines).
12106
12107	Once a supported USB device is attached to the host, global USB
12108	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12109	either ignore the device, or put it to USBDeviceState_Held state, or do
12110	nothing. Unless the device is ignored by global filters, filters of all
12111	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12112	activated that can put it to USBDeviceState_Captured state.
12113
12114	If the device was ignored by global filters, or didn't match
12115	any filters at all (including guest ones), it is handled by the host
12116	in a normal way. In this case, the device state is determined by
12117	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12118	or USBDeviceState_Available, depending on the current device usage.
12119
12120	Besides auto-capturing based on filters, the device can be manually
12121	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12122	state is USBDeviceState_Busy, USBDeviceState_Available or
12123	USBDeviceState_Held.
12124
12125	<note>
12126	Due to differences in USB stack implementations in Linux and Win32,
12127	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12128	only to the Linux version of the product. This also means that (<link
12129	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12130	device state is USBDeviceState_Held.
12131	</note>
12132
12133	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12134	</desc>
12135
12136	<const name="NotSupported" value="0">
12137	<desc>
12138	Not supported by the VirtualBox server, not available to guests.
12139	</desc>
12140	</const>
12141	<const name="Unavailable" value="1">
12142	<desc>
12143	Being used by the host computer exclusively,
12144	not available to guests.
12145	</desc>
12146	</const>
12147	<const name="Busy" value="2">
12148	<desc>
12149	Being used by the host computer, potentially available to guests.
12150	</desc>
12151	</const>
12152	<const name="Available" value="3">
12153	<desc>
12154	Not used by the host computer, available to guests (the host computer
12155	can also start using the device at any time).
12156	</desc>
12157	</const>
12158	<const name="Held" value="4">
12159	<desc>
12160	Held by the VirtualBox server (ignored by the host computer),
12161	available to guests.
12162	</desc>
12163	</const>
12164	<const name="Captured" value="5">
12165	<desc>
12166	Captured by one of the guest computers, not available
12167	to anybody else.
12168	</desc>
12169	</const>
12170	</enum>
12171
12172	<interface
12173	name="IHostUSBDevice" extends="IUSBDevice"
12174	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12175	wsmap="managed"
12176	>
12177	<desc>
12178	The IHostUSBDevice interface represents a physical USB device attached
12179	to the host computer.
12180
12181	Besides properties inherited from IUSBDevice, this interface adds the
12182	<link to="#state"/> property that holds the current state of the USB
12183	device.
12184
12185	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12186	</desc>
12187
12188	<attribute name="state" type="USBDeviceState" readonly="yes">
12189	<desc>
12190	Current state of the device.
12191	</desc>
12192	</attribute>
12193
12194	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12195
12196	</interface>
12197
12198
12199	<!--
12200	// IHostUSBDeviceFilter
12201	/////////////////////////////////////////////////////////////////////////
12202	-->
12203
12204	<enum
12205	name="USBDeviceFilterAction"
12206	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12207	>
12208	<desc>
12209	Actions for host USB device filters.
12210	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12211	</desc>
12212
12213	<const name="Null" value="0">
12214	<desc>Null value (never used by the API).</desc>
12215	</const>
12216	<const name="Ignore" value="1">
12217	<desc>Ignore the matched USB device.</desc>
12218	</const>
12219	<const name="Hold" value="2">
12220	<desc>Hold the matched USB device.</desc>
12221	</const>
12222	</enum>
12223
12224	<interface
12225	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12226	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12227	wsmap="managed"
12228	>
12229	<desc>
12230	The IHostUSBDeviceFilter interface represents a global filter for a
12231	physical USB device used by the host computer. Used indirectly in
12232	<link to="IHost::USBDeviceFilters"/>.
12233
12234	Using filters of this type, the host computer determines the initial
12235	state of the USB device after it is physically attached to the
12236	host's USB controller.
12237
12238	<note>
12239	The <link to="#remote"/> attribute is ignored by this type of
12240	filters, because it makes sense only for
12241	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12242	</note>
12243
12244	<see>IHost::USBDeviceFilters</see>
12245	</desc>
12246
12247	<attribute name="action" type="USBDeviceFilterAction">
12248	<desc>
12249	Action performed by the host when an attached USB device
12250	matches this filter.
12251	</desc>
12252	</attribute>
12253
12254	</interface>
12255
12256	<!--
12257	// IAudioAdapter
12258	/////////////////////////////////////////////////////////////////////////
12259	-->
12260
12261	<enum
12262	name="AudioDriverType"
12263	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12264	>
12265	<desc>
12266	Host audio driver type.
12267	</desc>
12268
12269	<const name="Null" value="0">
12270	<desc>Null value, also means "dummy audio driver".</desc>
12271	</const>
12272	<const name="WinMM" value="1">
12273	<desc>Windows multimedia (Windows hosts only).</desc>
12274	</const>
12275	<const name="OSS" value="2">
12276	<desc>Open Sound System (Linux hosts only).</desc>
12277	</const>
12278	<const name="ALSA" value="3">
12279	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12280	</const>
12281	<const name="DirectSound" value="4">
12282	<desc>DirectSound (Windows hosts only).</desc>
12283	</const>
12284	<const name="CoreAudio" value="5">
12285	<desc>CoreAudio (Mac hosts only).</desc>
12286	</const>
12287	<const name="MMPM" value="6">
12288	<desc>Reserved for historical reasons.</desc>
12289	</const>
12290	<const name="Pulse" value="7">
12291	<desc>PulseAudio (Linux hosts only).</desc>
12292	</const>
12293	<const name="SolAudio" value="8">
12294	<desc>Solaris audio (Solaris hosts only).</desc>
12295	</const>
12296	</enum>
12297
12298	<enum
12299	name="AudioControllerType"
12300	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12301	>
12302	<desc>
12303	Virtual audio controller type.
12304	</desc>
12305
12306	<const name="AC97" value="0"/>
12307	<const name="SB16" value="1"/>
12308	</enum>
12309
12310	<interface
12311	name="IAudioAdapter" extends="$unknown"
12312	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12313	wsmap="managed"
12314	>
12315	<desc>
12316	The IAudioAdapter interface represents the virtual audio adapter of
12317	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12318	</desc>
12319	<attribute name="enabled" type="boolean">
12320	<desc>
12321	Flag whether the audio adapter is present in the
12322	guest system. If disabled, the virtual guest hardware will
12323	not contain any audio adapter. Can only be changed when
12324	the VM is not running.
12325	</desc>
12326	</attribute>
12327	<attribute name="audioController" type="AudioControllerType">
12328	<desc>
12329	The audio hardware we emulate.
12330	</desc>
12331	</attribute>
12332	<attribute name="audioDriver" type="AudioDriverType">
12333	<desc>
12334	Audio driver the adapter is connected to. This setting
12335	can only be changed when the VM is not running.
12336	</desc>
12337	</attribute>
12338	</interface>
12339
12340	<!--
12341	// IVRDPServer
12342	/////////////////////////////////////////////////////////////////////////
12343	-->
12344
12345	<enum
12346	name="VRDPAuthType"
12347	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12348	>
12349	<desc>
12350	VRDP authentication type.
12351	</desc>
12352
12353	<const name="Null" value="0">
12354	<desc>Null value, also means "no authentication".</desc>
12355	</const>
12356	<const name="External" value="1"/>
12357	<const name="Guest" value="2"/>
12358	</enum>
12359
12360	<interface
12361	name="IVRDPServer" extends="$unknown"
12362	uuid="72e671bc-1712-4052-ad6b-e45e76d9d3e4"
12363	wsmap="managed"
12364	>
12365	<attribute name="enabled" type="boolean">
12366	<desc>VRDP server status.</desc>
12367	</attribute>
12368
12369	<attribute name="ports" type="wstring">
12370	<desc>
12371	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12372	<note>
12373	This is a string of comma separated TCP port numbers or port number ranges.
12374	Example <tt>5000,5010-5012,5015</tt>
12375	</note>
12376	</desc>
12377	</attribute>
12378
12379	<attribute name="netAddress" type="wstring">
12380	<desc>VRDP server address.</desc>
12381	</attribute>
12382
12383	<attribute name="authType" type="VRDPAuthType">
12384	<desc>VRDP authentication method.</desc>
12385	</attribute>
12386
12387	<attribute name="authTimeout" type="unsigned long">
12388	<desc>Timeout for guest authentication. Milliseconds.</desc>
12389	</attribute>
12390
12391	<attribute name="allowMultiConnection" type="boolean">
12392	<desc>
12393	Flag whether multiple simultaneous connections to the VM are permitted.
12394	Note that this will be replaced by a more powerful mechanism in the future.
12395	</desc>
12396	</attribute>
12397
12398	<attribute name="reuseSingleConnection" type="boolean">
12399	<desc>
12400	Flag whether the existing connection must be dropped and a new connection
12401	must be established by the VRDP server, when a new client connects in single
12402	connection mode.
12403	</desc>
12404	</attribute>
12405
12406	</interface>
12407
12408
12409	<!--
12410	// ISharedFolder
12411	/////////////////////////////////////////////////////////////////////////
12412	-->
12413
12414	<interface
12415	name="ISharedFolder" extends="$unknown"
12416	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
12417	wsmap="struct"
12418	>
12419	<desc>
12420	The ISharedFolder interface represents a folder in the host computer's
12421	file system accessible from the guest OS running inside a virtual
12422	machine using an associated logical name.
12423
12424	There are three types of shared folders:
12425	<ul>
12426	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12427	folders available to all virtual machines.</li>
12428	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12429	VM-specific shared folders available to the given virtual machine at
12430	startup.</li>
12431	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12432	VM-specific shared folders created in the session context (for
12433	example, when the virtual machine is running) and automatically
12434	discarded when the session is closed (the VM is powered off).</li>
12435	</ul>
12436
12437	Logical names of shared folders must be unique within the given scope
12438	(global, permanent or transient). However, they do not need to be unique
12439	across scopes. In this case, the definition of the shared folder in a
12440	more specific scope takes precedence over definitions in all other
12441	scopes. The order of precedence is (more specific to more general):
12442	<ol>
12443	<li>Transient definitions</li>
12444	<li>Permanent definitions</li>
12445	<li>Global definitions</li>
12446	</ol>
12447
12448	For example, if MyMachine has a shared folder named
12449	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12450	transient shared folder named <tt>C_DRIVE</tt> (that points
12451	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12452	of <tt>C_DRIVE</tt> in the guest OS so
12453	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12454	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12455	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12456	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12457	to <tt>C:\\</tt> if it still exists.
12458
12459	Note that permanent and transient shared folders of different machines
12460	are in different name spaces, so they don't overlap and don't need to
12461	have unique logical names.
12462
12463	<note>
12464	Global shared folders are not implemented in the current version of the
12465	product.
12466	</note>
12467	</desc>
12468
12469	<attribute name="name" type="wstring" readonly="yes">
12470	<desc>Logical name of the shared folder.</desc>
12471	</attribute>
12472
12473	<attribute name="hostPath" type="wstring" readonly="yes">
12474	<desc>Full path to the shared folder in the host file system.</desc>
12475	</attribute>
12476
12477	<attribute name="accessible" type="boolean" readonly="yes">
12478	<desc>
12479	Whether the folder defined by the host path is currently
12480	accessible or not.
12481	For example, the folder can be unaccessible if it is placed
12482	on the network share that is not available by the time
12483	this property is read.
12484	</desc>
12485	</attribute>
12486
12487	<attribute name="writable" type="boolean" readonly="yes">
12488	<desc>
12489	Whether the folder defined by the host path is writable or
12490	not.
12491	</desc>
12492	</attribute>
12493
12494	<attribute name="lastAccessError" type="wstring" readonly="yes">
12495	<desc>
12496	Text message that represents the result of the last accessibility
12497	check.
12498
12499	Accessibility checks are performed each time the <link to="#accessible"/>
12500	attribute is read. An empty string is returned if the last
12501	accessibility check was successful. A non-empty string indicates a
12502	failure and should normally describe a reason of the failure (for
12503	example, a file read error).
12504	</desc>
12505	</attribute>
12506
12507	</interface>
12508
12509	<!--
12510	// ISession
12511	/////////////////////////////////////////////////////////////////////////
12512	-->
12513
12514	<interface
12515	name="IInternalSessionControl" extends="$unknown"
12516	uuid="f9aac6d0-41b3-46b7-bea4-6370b4036de6"
12517	internal="yes"
12518	wsmap="suppress"
12519	>
12520	<method name="getPID">
12521	<desc>PID of the process that has created this Session object.
12522	</desc>
12523	<param name="pid" type="unsigned long" dir="return"/>
12524	</method>
12525
12526	<method name="getRemoteConsole">
12527	<desc>
12528	Returns the console object suitable for remote control.
12529
12530	<result name="VBOX_E_INVALID_VM_STATE">
12531	Session state prevents operation.
12532	</result>
12533	<result name="VBOX_E_INVALID_OBJECT_STATE">
12534	Session type prevents operation.
12535	</result>
12536
12537	</desc>
12538	<param name="console" type="IConsole" dir="return"/>
12539	</method>
12540
12541	<method name="assignMachine">
12542	<desc>
12543	Assigns the machine object associated with this direct-type
12544	session or informs the session that it will be a remote one
12545	(if @a machine == @c null).
12546
12547	<result name="VBOX_E_INVALID_VM_STATE">
12548	Session state prevents operation.
12549	</result>
12550	<result name="VBOX_E_INVALID_OBJECT_STATE">
12551	Session type prevents operation.
12552	</result>
12553
12554	</desc>
12555	<param name="machine" type="IMachine" dir="in"/>
12556	</method>
12557
12558	<method name="assignRemoteMachine">
12559	<desc>
12560	Assigns the machine and the (remote) console object associated with
12561	this remote-type session.
12562
12563	<result name="VBOX_E_INVALID_VM_STATE">
12564	Session state prevents operation.
12565	</result>
12566
12567	</desc>
12568	<param name="machine" type="IMachine" dir="in"/>
12569	<param name="console" type="IConsole" dir="in"/>
12570	</method>
12571
12572	<method name="updateMachineState">
12573	<desc>
12574	Updates the machine state in the VM process.
12575	Must be called only in certain cases
12576	(see the method implementation).
12577
12578	<result name="VBOX_E_INVALID_VM_STATE">
12579	Session state prevents operation.
12580	</result>
12581	<result name="VBOX_E_INVALID_OBJECT_STATE">
12582	Session type prevents operation.
12583	</result>
12584
12585	</desc>
12586	<param name="aMachineState" type="MachineState" dir="in"/>
12587	</method>
12588
12589	<method name="uninitialize">
12590	<desc>
12591	Uninitializes (closes) this session. Used by VirtualBox to close
12592	the corresponding remote session when the direct session dies
12593	or gets closed.
12594
12595	<result name="VBOX_E_INVALID_VM_STATE">
12596	Session state prevents operation.
12597	</result>
12598
12599	</desc>
12600	</method>
12601
12602	<method name="onNetworkAdapterChange">
12603	<desc>
12604	Triggered when settings of a network adapter of the
12605	associated virtual machine have changed.
12606
12607	<result name="VBOX_E_INVALID_VM_STATE">
12608	Session state prevents operation.
12609	</result>
12610	<result name="VBOX_E_INVALID_OBJECT_STATE">
12611	Session type prevents operation.
12612	</result>
12613
12614	</desc>
12615	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12616	<param name="changeAdapter" type="boolean" dir="in"/>
12617	</method>
12618
12619	<method name="onSerialPortChange">
12620	<desc>
12621	Triggered when settings of a serial port of the
12622	associated virtual machine have changed.
12623
12624	<result name="VBOX_E_INVALID_VM_STATE">
12625	Session state prevents operation.
12626	</result>
12627	<result name="VBOX_E_INVALID_OBJECT_STATE">
12628	Session type prevents operation.
12629	</result>
12630
12631	</desc>
12632	<param name="serialPort" type="ISerialPort" dir="in"/>
12633	</method>
12634
12635	<method name="onParallelPortChange">
12636	<desc>
12637	Triggered when settings of a parallel port of the
12638	associated virtual machine have changed.
12639
12640	<result name="VBOX_E_INVALID_VM_STATE">
12641	Session state prevents operation.
12642	</result>
12643	<result name="VBOX_E_INVALID_OBJECT_STATE">
12644	Session type prevents operation.
12645	</result>
12646
12647	</desc>
12648	<param name="parallelPort" type="IParallelPort" dir="in"/>
12649	</method>
12650
12651	<method name="onStorageControllerChange">
12652	<desc>
12653	Triggered when settings of a storage controller of the
12654	associated virtual machine have changed.
12655
12656	<result name="VBOX_E_INVALID_VM_STATE">
12657	Session state prevents operation.
12658	</result>
12659	<result name="VBOX_E_INVALID_OBJECT_STATE">
12660	Session type prevents operation.
12661	</result>
12662
12663	</desc>
12664	</method>
12665
12666	<method name="onMediumChange">
12667	<desc>
12668	Triggered when attached media of the
12669	associated virtual machine have changed.
12670
12671	<result name="VBOX_E_INVALID_VM_STATE">
12672	Session state prevents operation.
12673	</result>
12674	<result name="VBOX_E_INVALID_OBJECT_STATE">
12675	Session type prevents operation.
12676	</result>
12677
12678	</desc>
12679
12680	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12681	<param name="force" type="boolean" dir="in"/>
12682	</method>
12683
12684	<method name="onVRDPServerChange">
12685	<desc>
12686	Triggered when settings of the VRDP server object of the
12687	associated virtual machine have changed.
12688
12689	<result name="VBOX_E_INVALID_VM_STATE">
12690	Session state prevents operation.
12691	</result>
12692	<result name="VBOX_E_INVALID_OBJECT_STATE">
12693	Session type prevents operation.
12694	</result>
12695
12696	</desc>
12697	</method>
12698
12699	<method name="onUSBControllerChange">
12700	<desc>
12701	Triggered when settings of the USB controller object of the
12702	associated virtual machine have changed.
12703
12704	<result name="VBOX_E_INVALID_VM_STATE">
12705	Session state prevents operation.
12706	</result>
12707	<result name="VBOX_E_INVALID_OBJECT_STATE">
12708	Session type prevents operation.
12709	</result>
12710
12711	</desc>
12712	</method>
12713
12714	<method name="onSharedFolderChange">
12715	<desc>
12716	Triggered when a permanent (global or machine) shared folder has been
12717	created or removed.
12718	<note>
12719	We don't pass shared folder parameters in this notification because
12720	the order in which parallel notifications are delivered is not defined,
12721	therefore it could happen that these parameters were outdated by the
12722	time of processing this notification.
12723	</note>
12724
12725	<result name="VBOX_E_INVALID_VM_STATE">
12726	Session state prevents operation.
12727	</result>
12728	<result name="VBOX_E_INVALID_OBJECT_STATE">
12729	Session type prevents operation.
12730	</result>
12731
12732	</desc>
12733	<param name="global" type="boolean" dir="in"/>
12734	</method>
12735
12736	<method name="onUSBDeviceAttach">
12737	<desc>
12738	Triggered when a request to capture a USB device (as a result
12739	of matched USB filters or direct call to
12740	<link to="IConsole::attachUSBDevice"/>) has completed.
12741	A @c null @a error object means success, otherwise it
12742	describes a failure.
12743
12744	<result name="VBOX_E_INVALID_VM_STATE">
12745	Session state prevents operation.
12746	</result>
12747	<result name="VBOX_E_INVALID_OBJECT_STATE">
12748	Session type prevents operation.
12749	</result>
12750
12751	</desc>
12752	<param name="device" type="IUSBDevice" dir="in"/>
12753	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12754	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12755	</method>
12756
12757	<method name="onUSBDeviceDetach">
12758	<desc>
12759	Triggered when a request to release the USB device (as a result
12760	of machine termination or direct call to
12761	<link to="IConsole::detachUSBDevice"/>) has completed.
12762	A @c null @a error object means success, otherwise it
12763	describes a failure.
12764
12765	<result name="VBOX_E_INVALID_VM_STATE">
12766	Session state prevents operation.
12767	</result>
12768	<result name="VBOX_E_INVALID_OBJECT_STATE">
12769	Session type prevents operation.
12770	</result>
12771
12772	</desc>
12773	<param name="id" type="uuid" mod="string" dir="in"/>
12774	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12775	</method>
12776
12777	<method name="onShowWindow">
12778	<desc>
12779	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12780	<link to="IMachine::showConsoleWindow"/> in order to notify
12781	console callbacks
12782	<link to="IConsoleCallback::onCanShowWindow"/>
12783	and <link to="IConsoleCallback::onShowWindow"/>.
12784
12785	<result name="VBOX_E_INVALID_OBJECT_STATE">
12786	Session type prevents operation.
12787	</result>
12788
12789	</desc>
12790	<param name="check" type="boolean" dir="in"/>
12791	<param name="canShow" type="boolean" dir="out"/>
12792	<param name="winId" type="unsigned long long" dir="out"/>
12793	</method>
12794
12795	<method name="accessGuestProperty">
12796	<desc>
12797	Called by <link to="IMachine::getGuestProperty"/> and by
12798	<link to="IMachine::setGuestProperty"/> in order to read and
12799	modify guest properties.
12800
12801	<result name="VBOX_E_INVALID_VM_STATE">
12802	Machine session is not open.
12803	</result>
12804	<result name="VBOX_E_INVALID_OBJECT_STATE">
12805	Session type is not direct.
12806	</result>
12807
12808	</desc>
12809	<param name="name" type="wstring" dir="in"/>
12810	<param name="value" type="wstring" dir="in"/>
12811	<param name="flags" type="wstring" dir="in"/>
12812	<param name="isSetter" type="boolean" dir="in"/>
12813	<param name="retValue" type="wstring" dir="out"/>
12814	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12815	<param name="retFlags" type="wstring" dir="out"/>
12816	</method>
12817
12818	<method name="enumerateGuestProperties">
12819	<desc>
12820	Return a list of the guest properties matching a set of patterns along
12821	with their values, time stamps and flags.
12822
12823	<result name="VBOX_E_INVALID_VM_STATE">
12824	Machine session is not open.
12825	</result>
12826	<result name="VBOX_E_INVALID_OBJECT_STATE">
12827	Session type is not direct.
12828	</result>
12829
12830	</desc>
12831	<param name="patterns" type="wstring" dir="in">
12832	<desc>
12833	The patterns to match the properties against as a comma-separated
12834	string. If this is empty, all properties currently set will be
12835	returned.
12836	</desc>
12837	</param>
12838	<param name="key" type="wstring" dir="out" safearray="yes">
12839	<desc>
12840	The key names of the properties returned.
12841	</desc>
12842	</param>
12843	<param name="value" type="wstring" dir="out" safearray="yes">
12844	<desc>
12845	The values of the properties returned. The array entries match the
12846	corresponding entries in the @a key array.
12847	</desc>
12848	</param>
12849	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12850	<desc>
12851	The time stamps of the properties returned. The array entries match
12852	the corresponding entries in the @a key array.
12853	</desc>
12854	</param>
12855	<param name="flags" type="wstring" dir="out" safearray="yes">
12856	<desc>
12857	The flags of the properties returned. The array entries match the
12858	corresponding entries in the @a key array.
12859	</desc>
12860	</param>
12861	</method>
12862
12863	</interface>
12864
12865	<interface
12866	name="ISession" extends="$dispatched"
12867	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12868	wsmap="managed"
12869	>
12870	<desc>
12871	The ISession interface represents a serialization primitive for virtual
12872	machines.
12873
12874	With VirtualBox, every time one wishes to manipulate a virtual machine
12875	(e.g. change its settings or start execution), a session object is
12876	required. Such an object must be passed to one of the session methods
12877	that open the given session, which then initiates the machine manipulation.
12878
12879	A session serves several purposes: it identifies to the inter-process VirtualBox
12880	code which process is currently working with the virtual machine, and it ensures
12881	that there are no incompatible requests from several processes for the
12882	same virtual machine. Session objects can therefore be thought of as mutex
12883	semaphores that lock virtual machines to prevent conflicting accesses from
12884	several processes.
12885
12886	How sessions objects are used depends on whether you use the Main API
12887	via COM or via the webservice:
12888
12889	<ul>
12890	<li>When using the COM API directly, an object of the Session class from the
12891	VirtualBox type library needs to be created. In regular COM C++ client code,
12892	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12893	This object will then act as a local session object in further calls to open
12894	a session.
12895	</li>
12896
12897	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12898	one session object automatically when <link to="IWebsessionManager::logon" />
12899	is called. A managed object reference to that session object can be retrieved by
12900	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12901	reference can then be used to open sessions.
12902	</li>
12903	</ul>
12904
12905	Sessions are mainly used in two variations:
12906
12907	<ul>
12908	<li>
12909	To start a virtual machine in a separate process, one would call
12910	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12911	object as its first parameter. This session then identifies the caller
12912	and lets him control the started machine (for example, pause machine
12913	execution or power it down) as well as be notified about machine
12914	execution state changes.
12915	</li>
12916
12917	<li>To alter machine settings, or to start machine execution within the
12918	current process, one needs to open a direct session for the machine first by
12919	calling <link to="IVirtualBox::openSession"/>. While a direct session
12920	is open within one process, no any other process may open another direct
12921	session for the same machine. This prevents the machine from being changed
12922	by other processes while it is running or while the machine is being configured.
12923	</li>
12924	</ul>
12925
12926	One also can attach to an existing direct session already opened by
12927	another process (for example, in order to send a control request to the
12928	virtual machine such as the pause or the reset request). This is done by
12929	calling <link to="IVirtualBox::openExistingSession"/>.
12930
12931	<note>
12932	Unless you are trying to write a new VirtualBox front-end that
12933	performs direct machine execution (like the VirtualBox or VBoxSDL
12934	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12935	session opened by <link to="IVirtualBox::openSession"/> and use this
12936	session only to change virtual machine settings. If you simply want to
12937	start virtual machine execution using one of the existing front-ends
12938	(for example the VirtualBox GUI or headless server), simply use
12939	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12940	will power up the machine automatically for you.
12941	</note>
12942	</desc>
12943
12944	<attribute name="state" type="SessionState" readonly="yes">
12945	<desc>Current state of this session.</desc>
12946	</attribute>
12947
12948	<attribute name="type" type="SessionType" readonly="yes">
12949	<desc>
12950	Type of this session. The value of this attribute is valid only
12951	if the session is currently open (i.e. its #state is
12952	SessionType_SessionOpen), otherwise an error will be returned.
12953	</desc>
12954	</attribute>
12955
12956	<attribute name="machine" type="IMachine" readonly="yes">
12957	<desc>Machine object associated with this session.</desc>
12958	</attribute>
12959
12960	<attribute name="console" type="IConsole" readonly="yes">
12961	<desc>Console object associated with this session.</desc>
12962	</attribute>
12963
12964	<method name="close">
12965	<desc>
12966	Closes a session that was previously opened.
12967
12968	It is recommended that every time an "open session" method (such as
12969	<link to="IVirtualBox::openRemoteSession" /> or
12970	<link to="IVirtualBox::openSession" />) has been called to
12971	manipulate a virtual machine, the caller invoke
12972	ISession::close() when it's done doing so. Since sessions are
12973	serialization primitives much like ordinary mutexes, they are
12974	best used the same way: for each "open" call, there should be
12975	a matching "close" call, even when errors occur.
12976
12977	Otherwise, if a direct session for a machine opened with
12978	<link to="IVirtualBox::openSession"/> is not explicitly closed
12979	when the application terminates, the state of the machine will
12980	be set to <link to="MachineState_Aborted" /> on the server.
12981
12982	Generally, it is recommended to close all open sessions explicitly
12983	before terminating the application (regardless of the reason for
12984	the termination).
12985
12986	<note>
12987	Do not expect the session state (<link to="ISession::state" />
12988	to return to "Closed" immediately after you invoke
12989	ISession::close(), particularly if you have started a remote
12990	session to execute the VM in a new process. The session state will
12991	automatically return to "Closed" once the VM is no longer executing,
12992	which can of course take a very long time.
12993	</note>
12994
12995	<result name="E_UNEXPECTED">
12996	Session is not open.
12997	</result>
12998
12999	</desc>
13000	</method>
13001
13002	</interface>
13003
13004	<!--
13005	// IStorageController
13006	/////////////////////////////////////////////////////////////////////////
13007	-->
13008
13009	<enum
13010	name="StorageBus"
13011	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13012	>
13013	<desc>
13014	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
13015	see <link to="IStorageController::bus" />.
13016	</desc>
13017	<const name="Null" value="0">
13018	<desc>@c null value. Never used by the API.</desc>
13019	</const>
13020	<const name="IDE" value="1"/>
13021	<const name="SATA" value="2"/>
13022	<const name="SCSI" value="3"/>
13023	<const name="Floppy" value="4"/>
13024	</enum>
13025
13026	<enum
13027	name="StorageControllerType"
13028	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13029	>
13030	<desc>
13031	The exact variant of storage controller hardware presented
13032	to the guest; see <link to="IStorageController::controllerType" />.
13033	</desc>
13034
13035	<const name="Null" value="0">
13036	<desc>@c null value. Never used by the API.</desc>
13037	</const>
13038	<const name="LsiLogic" value="1">
13039	<desc>A SCSI controller of the LsiLogic variant.</desc>
13040	</const>
13041	<const name="BusLogic" value="2">
13042	<desc>A SCSI controller of the BusLogic variant.</desc>
13043	</const>
13044	<const name="IntelAhci" value="3">
13045	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13046	</const>
13047	<const name="PIIX3" value="4">
13048	<desc>An IDE controller of the PIIX3 variant.</desc>
13049	</const>
13050	<const name="PIIX4" value="5">
13051	<desc>An IDE controller of the PIIX4 variant.</desc>
13052	</const>
13053	<const name="ICH6" value="6">
13054	<desc>An IDE controller of the ICH6 variant.</desc>
13055	</const>
13056	<const name="I82078" value="7">
13057	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13058	</const>
13059	</enum>
13060
13061	<interface
13062	name="IStorageController" extends="$unknown"
13063	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
13064	wsmap="managed"
13065	>
13066	<desc>
13067	Represents a storage controller that is attached to a virtual machine
13068	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13069	attached to storage controllers in a real computer, virtual drives
13070	(represented by <link to="IMediumAttachment" />) are attached to virtual
13071	storage controllers, represented by this interface.
13072
13073	As opposed to physical hardware, VirtualBox has a very generic concept
13074	of a storage controller, and for purposes of the Main API, all virtual
13075	storage is attached to virtual machines via instances of this interface.
13076	There are four types of such virtual storage controllers: IDE, SCSI, SATA
13077	and Floppy (see <link to="#bus" />). Depending on which of these four is
13078	used, certain sub-types may be available and can be selected in
13079	<link to="#controllerType" />.
13080
13081	Depending on these settings, the guest operating system might see
13082	significantly different virtual hardware.
13083	</desc>
13084
13085	<attribute name="name" type="wstring" readonly="yes">
13086	<desc>
13087	Name of the storage controller, as originally specified with
13088	<link to="IMachine::addStorageController" />. This then uniquely
13089	identifies this controller with other method calls such as
13090	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13091	</desc>
13092	</attribute>
13093
13094	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13095	<desc>
13096	Maximum number of devices which can be attached to one port.
13097	</desc>
13098	</attribute>
13099
13100	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13101	<desc>
13102	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13103	</desc>
13104	</attribute>
13105
13106	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13107	<desc>
13108	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13109	</desc>
13110	</attribute>
13111
13112	<attribute name="instance" type="unsigned long">
13113	<desc>
13114	The instance number of the device in the running VM.
13115	</desc>
13116	</attribute>
13117
13118	<attribute name="portCount" type="unsigned long">
13119	<desc>
13120	The number of currently usable ports on the controller.
13121	The minimum and maximum number of ports for one controller are
13122	stored in <link to="IStorageController::minPortCount"/>
13123	and <link to="IStorageController::maxPortCount"/>.
13124	</desc>
13125	</attribute>
13126
13127	<attribute name="bus" type="StorageBus" readonly="yes">
13128	<desc>
13129	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
13130	</desc>
13131	</attribute>
13132
13133	<attribute name="controllerType" type="StorageControllerType">
13134	<desc>
13135	The exact variant of storage controller hardware presented
13136	to the guest.
13137	Depending on this value, VirtualBox will provide a different
13138	virtual storage controller hardware to the guest.
13139	For SATA and floppy controllers, only one variant is available,
13140	but for IDE and SCSI, there are several.
13141
13142	For SCSI controllers, the default type is LsiLogic.
13143	</desc>
13144	</attribute>
13145
13146	<method name="GetIDEEmulationPort">
13147	<desc>
13148	Gets the corresponding port number which is emulated as an IDE device.
13149	Works only with SATA controllers.
13150
13151	<result name="E_INVALIDARG">
13152	The @a devicePosition is not in the range 0 to 3.
13153	</result>
13154	<result name="E_NOTIMPL">
13155	The storage controller type is not SATAIntelAhci.
13156	</result>
13157
13158	</desc>
13159	<param name="devicePosition" type="long" dir="in"/>
13160	<param name="portNumber" type="long" dir="return"/>
13161	</method>
13162
13163	<method name="SetIDEEmulationPort">
13164	<desc>
13165	Sets the port number which is emulated as an IDE device.
13166	Works only with SATA controllers.
13167
13168	<result name="E_INVALIDARG">
13169	The @a devicePosition is not in the range 0 to 3 or the
13170	@a portNumber is not in the range 0 to 29.
13171	</result>
13172	<result name="E_NOTIMPL">
13173	The storage controller type is not SATAIntelAhci.
13174	</result>
13175
13176	</desc>
13177	<param name="devicePosition" type="long" dir="in"/>
13178	<param name="portNumber" type="long" dir="in"/>
13179	</method>
13180
13181	</interface>
13182
13183	<if target="wsdl">
13184
13185	<!--
13186	// IManagedObjectRef
13187	/////////////////////////////////////////////////////////////////////////
13188	-->
13189
13190	<interface
13191	name="IManagedObjectRef" extends="$unknown"
13192	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13193	internal="yes"
13194	wsmap="managed"
13195	wscpp="hardcoded"
13196	>
13197	<desc>
13198	Managed object reference.
13199
13200	Only within the webservice, a managed object reference (which is really
13201	an opaque number) allows a webservice client to address an object
13202	that lives in the address space of the webservice server.
13203
13204	Behind each managed object reference, there is a COM object that lives
13205	in the webservice server's address space. The COM object is not freed
13206	until the managed object reference is released, either by an explicit
13207	call to <link to="IManagedObjectRef::release" /> or by logging off from
13208	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13209	all objects created during the webservice session.
13210
13211	Whenever a method call of the VirtualBox API returns a COM object, the
13212	webservice representation of that method will instead return a
13213	managed object reference, which can then be used to invoke methods
13214	on that object.
13215	</desc>
13216
13217	<method name="getInterfaceName">
13218	<desc>
13219	Returns the name of the interface that this managed object represents,
13220	for example, "IMachine", as a string.
13221	</desc>
13222	<param name="return" type="wstring" dir="return"/>
13223	</method>
13224
13225	<method name="release">
13226	<desc>
13227	Releases this managed object reference and frees the resources that
13228	were allocated for it in the webservice server process. After calling
13229	this method, the identifier of the reference can no longer be used.
13230	</desc>
13231	</method>
13232
13233	</interface>
13234
13235	<!--
13236	// IWebsessionManager
13237	/////////////////////////////////////////////////////////////////////////
13238	-->
13239
13240	<interface
13241	name="IWebsessionManager" extends="$unknown"
13242	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13243	internal="yes"
13244	wsmap="global"
13245	wscpp="hardcoded"
13246	>
13247	<desc>
13248	Websession manager. This provides essential services
13249	to webservice clients.
13250	</desc>
13251	<method name="logon">
13252	<desc>
13253	Logs a new client onto the webservice and returns a managed object reference to
13254	the IVirtualBox instance, which the client can then use as a basis to further
13255	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13256	interface, in one way or the other.
13257	</desc>
13258	<param name="username" type="wstring" dir="in"/>
13259	<param name="password" type="wstring" dir="in"/>
13260	<param name="return" type="IVirtualBox" dir="return"/>
13261	</method>
13262
13263	<method name="getSessionObject">
13264	<desc>
13265	Returns a managed object reference to the internal ISession object that was created
13266	for this web service session when the client logged on.
13267
13268	<see>ISession</see>
13269	</desc>
13270	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13271	<param name="return" type="ISession" dir="return"/>
13272	</method>
13273
13274	<method name="logoff">
13275	<desc>
13276	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13277	and destroys all resources associated with the session (most importantly, all
13278	managed objects created in the server while the session was active).
13279	</desc>
13280	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13281	</method>
13282
13283	</interface>
13284
13285	</if>
13286
13287	<!--
13288	// IPerformanceCollector & friends
13289	/////////////////////////////////////////////////////////////////////////
13290	-->
13291
13292	<interface
13293	name="IPerformanceMetric" extends="$unknown"
13294	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13295	>
13296	<desc>
13297	The IPerformanceMetric interface represents parameters of the given
13298	performance metric.
13299	</desc>
13300
13301	<attribute name="metricName" type="wstring" readonly="yes">
13302	<desc>
13303	Name of the metric.
13304	</desc>
13305	</attribute>
13306
13307	<attribute name="object" type="$unknown" readonly="yes">
13308	<desc>
13309	Object this metric belongs to.
13310	</desc>
13311	</attribute>
13312
13313	<attribute name="description" type="wstring" readonly="yes">
13314	<desc>
13315	Textual description of the metric.
13316	</desc>
13317	</attribute>
13318
13319	<attribute name="period" type="unsigned long" readonly="yes">
13320	<desc>
13321	Time interval between samples, measured in seconds.
13322	</desc>
13323	</attribute>
13324
13325	<attribute name="count" type="unsigned long" readonly="yes">
13326	<desc>
13327	Number of recent samples retained by the performance collector for this
13328	metric.
13329
13330	When the collected sample count exceeds this number, older samples
13331	are discarded.
13332	</desc>
13333	</attribute>
13334
13335	<attribute name="unit" type="wstring" readonly="yes">
13336	<desc>
13337	Unit of measurement.
13338	</desc>
13339	</attribute>
13340
13341	<attribute name="minimumValue" type="long" readonly="yes">
13342	<desc>
13343	Minimum possible value of this metric.
13344	</desc>
13345	</attribute>
13346
13347	<attribute name="maximumValue" type="long" readonly="yes">
13348	<desc>
13349	Maximum possible value of this metric.
13350	</desc>
13351	</attribute>
13352	</interface>
13353
13354	<interface
13355	name="IPerformanceCollector" extends="$unknown"
13356	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13357	wsmap="managed"
13358	>
13359	<desc>
13360	The IPerformanceCollector interface represents a service that collects and
13361	stores performance metrics data.
13362
13363	Performance metrics are associated with objects of interfaces like IHost and
13364	IMachine. Each object has a distinct set of performance metrics.
13365	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13366
13367	Metric data is collected at the specified intervals and is retained
13368	internally. The interval and the number of retained samples can be set
13369	with <link to="IPerformanceCollector::setupMetrics" />.
13370
13371	Metrics are organized hierarchically, with each level separated by a
13372	slash (/) character. Generally, the scheme for metric names is like this:
13373
13374	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13375
13376	"Category/Metric" together form the base metric name. A base metric is the
13377	smallest unit for which a sampling interval and the number of retained
13378	samples can be set. Only base metrics can be enabled and disabled. All
13379	sub-metrics are collected when their base metric is collected.
13380	Collected values for any set of sub-metrics can be queried with
13381	<link to="IPerformanceCollector::queryMetricsData" />.
13382
13383	For example "CPU/Load/User:avg"
13384	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
13385	"average" aggregate. An aggregate function is computed over all retained
13386	data. Valid aggregate functions are:
13387
13388	<ul>
13389	<li>avg -- average</li>
13390	<li>min -- minimum</li>
13391	<li>max -- maximum</li>
13392	</ul>
13393
13394	When setting up
13395	metric parameters, querying metric data, enabling or disabling metrics
13396	wildcards can be used in metric names to specify a subset of metrics. For
13397	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
13398	averages can be queried using <tt>*:avg</tt> and so on. To query metric
13399	values without aggregates <tt>*:</tt> can be used.
13400
13401	The valid names for base metrics are:
13402
13403	<ul>
13404	<li>CPU/Load</li>
13405	<li>CPU/MHz</li>
13406	<li>RAM/Usage</li>
13407	</ul>
13408
13409	The general sequence for collecting and retrieving the metrics is:
13410	<ul>
13411	<li>
13412	Obtain an instance of IPerformanceCollector with
13413	<link to="IVirtualBox::performanceCollector" />
13414	</li>
13415	<li>
13416	Allocate and populate an array with references to objects the metrics
13417	will be collected for. Use references to IHost and IMachine objects.
13418	</li>
13419	<li>
13420	Allocate and populate an array with base metric names the data will be
13421	collected for.
13422	</li>
13423	<li>
13424	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
13425	metric data will be collected and stored.
13426	</li>
13427	<li>
13428	Wait for the data to get collected.
13429	</li>
13430	<li>
13431	Allocate and populate an array with references to objects the metric
13432	values will be queried for. You can re-use the object array used for
13433	setting base metrics.
13434	</li>
13435	<li>
13436	Allocate and populate an array with metric names the data will be
13437	collected for. Note that metric names differ from base metric names.
13438	</li>
13439	<li>
13440	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
13441	have been collected so far are returned. Note that the values are still
13442	retained internally and data collection continues.
13443	</li>
13444	</ul>
13445
13446	For an example of usage refer to the following files in VirtualBox SDK:
13447	<ul>
13448	<li>
13449	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13450	</li>
13451	<li>
13452	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13453	</li>
13454	</ul>
13455	</desc>
13456
13457	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13458	<desc>
13459	Array of unique names of metrics.
13460
13461	This array represents all metrics supported by the performance
13462	collector. Individual objects do not necessarily support all of them.
13463	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13464	list of supported metrics for a particular object.
13465	</desc>
13466	</attribute>
13467
13468	<method name="getMetrics">
13469	<desc>
13470	Returns parameters of specified metrics for a set of objects.
13471	<note>
13472	@c Null metrics array means all metrics. @c Null object array means
13473	all existing objects.
13474	</note>
13475	</desc>
13476	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13477	<desc>
13478	Metric name filter. Currently, only a comma-separated list of metrics
13479	is supported.
13480	</desc>
13481	</param>
13482	<param name="objects" type="$unknown" dir="in" safearray="yes">
13483	<desc>
13484	Set of objects to return metric parameters for.
13485	</desc>
13486	</param>
13487	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13488	<desc>
13489	Array of returned metric parameters.
13490	</desc>
13491	</param>
13492	</method>
13493
13494	<method name="setupMetrics">
13495	<desc>
13496	Sets parameters of specified base metrics for a set of objects. Returns
13497	an array of <link to="IPerformanceMetric" /> describing the metrics have
13498	been affected.
13499	<note>
13500	@c Null or empty metric name array means all metrics. @c Null or empty
13501	object array means all existing objects. If metric name array contains
13502	a single element and object array contains many, the single metric
13503	name array element is applied to each object array element to form
13504	metric/object pairs.
13505	</note>
13506	</desc>
13507	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13508	<desc>
13509	Metric name filter. Comma-separated list of metrics with wildcard
13510	support.
13511	</desc>
13512	</param>
13513	<param name="objects" type="$unknown" dir="in" safearray="yes">
13514	<desc>
13515	Set of objects to setup metric parameters for.
13516	</desc>
13517	</param>
13518	<param name="period" type="unsigned long" dir="in">
13519	<desc>
13520	Time interval in seconds between two consecutive samples of performance
13521	data.
13522	</desc>
13523	</param>
13524	<param name="count" type="unsigned long" dir="in">
13525	<desc>
13526	Number of samples to retain in performance data history. Older samples
13527	get discarded.
13528	</desc>
13529	</param>
13530	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13531	<desc>
13532	Array of metrics that have been modified by the call to this method.
13533	</desc>
13534	</param>
13535	</method>
13536
13537	<method name="enableMetrics">
13538	<desc>
13539	Turns on collecting specified base metrics. Returns an array of
13540	<link to="IPerformanceMetric" /> describing the metrics have been
13541	affected.
13542	<note>
13543	@c Null or empty metric name array means all metrics. @c Null or empty
13544	object array means all existing objects. If metric name array contains
13545	a single element and object array contains many, the single metric
13546	name array element is applied to each object array element to form
13547	metric/object pairs.
13548	</note>
13549	</desc>
13550	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13551	<desc>
13552	Metric name filter. Comma-separated list of metrics with wildcard
13553	support.
13554	</desc>
13555	</param>
13556	<param name="objects" type="$unknown" dir="in" safearray="yes">
13557	<desc>
13558	Set of objects to enable metrics for.
13559	</desc>
13560	</param>
13561	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13562	<desc>
13563	Array of metrics that have been modified by the call to this method.
13564	</desc>
13565	</param>
13566	</method>
13567
13568	<method name="disableMetrics">
13569	<desc>
13570	Turns off collecting specified base metrics. Returns an array of
13571	<link to="IPerformanceMetric" /> describing the metrics have been
13572	affected.
13573	<note>
13574	@c Null or empty metric name array means all metrics. @c Null or empty
13575	object array means all existing objects. If metric name array contains
13576	a single element and object array contains many, the single metric
13577	name array element is applied to each object array element to form
13578	metric/object pairs.
13579	</note>
13580	</desc>
13581	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13582	<desc>
13583	Metric name filter. Comma-separated list of metrics with wildcard
13584	support.
13585	</desc>
13586	</param>
13587	<param name="objects" type="$unknown" dir="in" safearray="yes">
13588	<desc>
13589	Set of objects to disable metrics for.
13590	</desc>
13591	</param>
13592	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13593	<desc>
13594	Array of metrics that have been modified by the call to this method.
13595	</desc>
13596	</param>
13597	</method>
13598
13599	<method name="queryMetricsData">
13600	<desc>
13601	Queries collected metrics data for a set of objects.
13602
13603	The data itself and related metric information are returned in seven
13604	parallel and one flattened array of arrays. Elements of
13605	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13606	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13607	the same index describe one set of values corresponding to a single
13608	metric.
13609
13610	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13611	start and length of a sub-array is indicated by
13612	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13613	value for metric <tt>metricNames[i]</tt> is at
13614	<tt>returnData[returnIndices[i]]</tt>.
13615
13616	<note>
13617	@c Null or empty metric name array means all metrics. @c Null or empty
13618	object array means all existing objects. If metric name array contains
13619	a single element and object array contains many, the single metric
13620	name array element is applied to each object array element to form
13621	metric/object pairs.
13622	</note>
13623	<note>
13624	Data collection continues behind the scenes after call to
13625	@c queryMetricsData. The return data can be seen as the snapshot of
13626	the current state at the time of @c queryMetricsData call. The
13627	internally kept metric values are not cleared by the call. This makes
13628	possible querying different subsets of metrics or aggregates with
13629	subsequent calls. If periodic querying is needed it is highly
13630	suggested to query the values with @c interval*count period to avoid
13631	confusion. This way a completely new set of data values will be
13632	provided by each query.
13633	</note>
13634	</desc>
13635	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13636	<desc>
13637	Metric name filter. Comma-separated list of metrics with wildcard
13638	support.
13639	</desc>
13640	</param>
13641	<param name="objects" type="$unknown" dir="in" safearray="yes">
13642	<desc>
13643	Set of objects to query metrics for.
13644	</desc>
13645	</param>
13646	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13647	<desc>
13648	Names of metrics returned in @c returnData.
13649	</desc>
13650	</param>
13651	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13652	<desc>
13653	Objects associated with metrics returned in @c returnData.
13654	</desc>
13655	</param>
13656	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13657	<desc>
13658	Units of measurement for each returned metric.
13659	</desc>
13660	</param>
13661	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13662	<desc>
13663	Divisor that should be applied to return values in order to get
13664	floating point values. For example:
13665	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13666	will retrieve the floating point value of i-th sample of the first
13667	metric.
13668	</desc>
13669	</param>
13670	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13671	<desc>
13672	Sequence numbers of the first elements of value sequences of particular metrics
13673	returned in @c returnData. For aggregate metrics it is the sequence number of
13674	the sample the aggregate started calculation from.
13675	</desc>
13676	</param>
13677	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13678	<desc>
13679	Indices of the first elements of value sequences of particular metrics
13680	returned in @c returnData.
13681	</desc>
13682	</param>
13683	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13684	<desc>
13685	Lengths of value sequences of particular metrics.
13686	</desc>
13687	</param>
13688	<param name="returnData" type="long" dir="return" safearray="yes">
13689	<desc>
13690	Flattened array of all metric data containing sequences of values for
13691	each metric.
13692	</desc>
13693	</param>
13694	</method>
13695
13696	</interface>
13697
13698	<module name="VBoxSVC" context="LocalServer">
13699	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13700	namespace="virtualbox.org">
13701	<interface name="IVirtualBox" default="yes"/>
13702	</class>
13703	</module>
13704
13705	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13706	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13707	namespace="virtualbox.org">
13708	<interface name="ISession" default="yes"/>
13709	</class>
13710	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13711	namespace="virtualbox.org">
13712	<interface name="ILocalOwner" default="yes"/>
13713	<interface name="IVirtualBoxCallback"/>
13714	<interface name="IConsoleCallback"/>
13715	</class>
13716	</module>
13717
13718	</library>
13719
13720	</idl>
13721
13722	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format