VirtualBox.xidl@ 23280

Last change on this file since 23280 was 23280, checked in by vboxsync, 15 years ago
Main: avoid full recompile if only comments in VirtualBox.xidl are changed
Property svn:eol-style set to `native`
File size: 483.2 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>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_4" value="6">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_5" value="7">
411	<desc>Legacy settings version, not currently supported.</desc>
412	<!-- 2008-09-04: 2.0.0 released
413	2008-11-20: settings version 1.5 introduced
414	2008-12-17: 2.1.0 released
415	(todo)
416	-->
417	</const>
418	<const name="v1_6" value="8">
419	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
420	<!-- 2008-12-17: 2.1.0 released
421	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
422	2009-04-08: 2.2.0 released
423	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
424	-->
425	</const>
426	<const name="v1_7" value="9">
427	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
428	<!-- 2008-12-17: 2.1.0 released
429	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
430	2009-04-08: 2.2.0 released
431	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
432	Machine changes: HardDiskAttachments is now StorageControllers (done)
433	-->
434	</const>
435	<const name="v1_8" value="10">
436	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
437	<!-- Machine additions: Display/@accelerate2DVideo (done)
438	-->
439	</const>
440	<const name="v1_9" value="11">
441	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
442	<!-- The big storage controller / DVD / Floppy rework (done)
443	-->
444	</const>
445	<const name="Future" value="12">
446	<desc>Settings version greater than "1.9", written by a future VirtualBox version.</desc>
447	</const>
448	</enum>
449
450	<enum
451	name="AccessMode"
452	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
453	>
454	<desc>
455	Access mode for opening files.
456	</desc>
457
458	<const name="ReadOnly" value="1"/>
459	<const name="ReadWrite" value="2"/>
460	</enum>
461
462	<enum
463	name="MachineState"
464	uuid="73bf04d0-7c4f-4684-9abf-d65a9ad74343"
465	>
466	<desc>
467	Virtual machine execution state.
468
469	This enumeration represents possible values of the <link
470	to="IMachine::state"/> attribute.
471
472	Below is the basic virtual machine state diagram. It shows how the state
473	changes during virtual machine execution. The text in square braces shows
474	a method of the IConsole interface that performs the given state
475	transition.
476
477	<pre>
478	+---------[powerDown()] <- Stuck <--[failure]-+
479	V \|
480	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
481	\| \| \| \| V \|
482	\| Aborted -----+ +--> Running --[pause()]--> Paused
483	\| \| ^ \| ^ \|
484	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
485	\| ^ \| \| \| \|
486	\| \| +-----------------------------------------+-\|-------------------+ +
487	\| \| \| \| \|
488	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
489	\| \| \| \|
490	\| +-------- Saving <--------[saveState()]<----------+---------------------+
491	\| \| \|
492	+-------------- Stopping -------[powerDown()]<----------+---------------------+
493	</pre>
494
495	Note that states to the right from PoweredOff, Aborted and Saved in the
496	above diagram are called <i>online VM states</i>. These states
497	represent the virtual machine which is being executed in a dedicated
498	process (usually with a GUI window attached to it where you can see the
499	activity of the virtual machine and interact with it). There are two
500	special pseudo-states, FirstOnline and LastOnline, that can be used in
501	relational expressions to detect if the given machine state is online or
502	not:
503
504	<pre>
505	if (machine.GetState() >= MachineState_FirstOnline &&
506	machine.GetState() <= MachineState_LastOnline)
507	{
508	...the machine is being executed...
509	}
510	</pre>
511
512	When the virtual machine is in one of the online VM states (that is, being
513	executed), only a few machine settings can be modified. Methods working
514	with such settings contain an explicit note about that. An attempt to
515	change any oter setting or perform a modifying operation during this time
516	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
517
518	All online states except Running, Paused and Stuck are transitional: they
519	represent temporary conditions of the virtual machine that will last as
520	long as the operation that initiated such a condition.
521
522	The Stuck state is a special case. It means that execution of the machine
523	has reached the "Guru Meditation" condition. This condition indicates an
524	internal VMM (virtual machine manager) failure which may happen as a
525	result of either an unhandled low-level virtual hardware exception or one
526	of the recompiler exceptions (such as the <i>too-many-traps</i>
527	condition).
528
529	Note also that any online VM state may transit to the Aborted state. This
530	happens if the process that is executing the virtual machine terminates
531	unexpectedly (for example, crashes). Other than that, the Aborted state is
532	equivalent to PoweredOff.
533
534	There are also a few additional state diagrams that do not deal with
535	virtual machine execution and therefore are shown separately. The states
536	shown on these diagrams are called <i>offline VM states</i> (this includes
537	PoweredOff, Aborted and Saved too).
538
539	The first diagram shows what happens when a lengthy setup operation is
540	being executed (such as <link to="IMachine::attachDevice"/>).
541
542	<pre>
543	+----------------------------------(same state as before the call)------+
544	\| \|
545	+-> PoweredOff --+ \|
546	\| \| \|
547	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
548	\| \|
549	+-> Saved -------+
550	</pre>
551
552	The next two diagrams demonstrate the process of taking a snapshot of a
553	powered off virtual machine and performing one of the "discard..."
554	operations, respectively.
555
556	<pre>
557	+----------------------------------(same state as before the call)------+
558	\| \|
559	+-> PoweredOff --+ \|
560	\| +-->[takeSnapshot()] -------------------> Saving ------+
561	+-> Aborted -----+
562
563	+-> PoweredOff --+
564	\| \|
565	\| Aborted -----+-->[discardSnapshot() ]-------------> Discarding --+
566	\| \| [discardCurrentState()] \|
567	+-> Saved -------+ [discardCurrentSnapshotAndState()] \|
568	\| \|
569	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
570	</pre>
571
572	Note that the Saving state is present in both the offline state group and
573	online state group. Currently, the only way to determine what group is
574	assumed in a particular case is to remember the previous machine state: if
575	it was Running or Paused, then Saving is an online state, otherwise it is
576	an offline state. This inconsistency may be removed in one of the future
577	versions of VirtualBox by adding a new state.
578
579	<note internal="yes">
580	For whoever decides to touch this enum: In order to keep the
581	comparisons involving FirstOnline and LastOnline pseudo-states valid,
582	the numeric values of these states must be correspondingly updated if
583	needed: for any online VM state, the condition
584	<tt>FirstOnline <= state <= LastOnline</tt> must be
585	@c true. The same relates to transient states for which
586	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
587	@c true.
588	</note>
589	</desc>
590
591	<const name="Null" value="0">
592	<desc>Null value (never used by the API).</desc>
593	</const>
594	<const name="PoweredOff" value="1">
595	<desc>
596	The machine is not running and has no saved execution state; it has
597	either never been started or been shut down successfully.
598	</desc>
599	</const>
600	<const name="Saved" value="2">
601	<desc>
602	The machine is not currently running, but the execution state of the machine
603	has been saved to an external file when it was running, from where
604	it can be resumed.
605	</desc>
606	</const>
607	<const name="Aborted" value="3">
608	<desc>
609	The process running the machine has terminated abnormally. This may
610	indicate a crash of the VM process in host execution context, or
611	the VM process has been terminated externally.
612	</desc>
613	</const>
614	<const name="Running" value="4">
615	<desc>
616	The machine is currently being executed.
617	<note internal="yes">
618	For whoever decides to touch this enum: In order to keep the
619	comparisons in the old source code valid, this state must immediately
620	precede the Paused state.
621	</note>
622	</desc>
623	</const>
624	<const name="Paused" value="5">
625	<desc>
626	Execution of the machine has been paused.
627	<note internal="yes">
628	For whoever decides to touch this enum: In order to keep the
629	comparisons in the old source code valid, this state must immediately
630	follow the Running state.
631	</note>
632	</desc>
633	</const>
634	<const name="Stuck" value="6">
635	<desc>
636	Execution of the machine has reached the "Guru Meditation"
637	condition. This indicates a severe error in the hypervisor itself.
638	</desc>
639	</const>
640	<const name="Starting" value="7">
641	<desc>
642	Machine is being started after powering it on from a
643	zero execution state.
644	</desc>
645	</const>
646	<const name="Stopping" value="8">
647	<desc>
648	Machine is being normally stopped powering it off, or after the guest OS
649	has initiated a shutdown sequence.
650	</desc>
651	</const>
652	<const name="Saving" value="9">
653	<desc>
654	Machine is saving its execution state to a file, or an online
655	snapshot of the machine is being taken.
656	</desc>
657	</const>
658	<const name="Restoring" value="10">
659	<desc>
660	Execution state of the machine is being restored from a file
661	after powering it on from the saved execution state.
662	</desc>
663	</const>
664	<const name="Discarding" value="11">
665	<desc>
666	Snapshot of the machine is being discarded.
667	</desc>
668	</const>
669	<const name="SettingUp" value="12">
670	<desc>
671	Lengthy setup operation is in progress.
672	</desc>
673	</const>
674
675	<const name="FirstOnline" value="4" wsmap="suppress"> <!-- Running -->
676	<desc>
677	Pseudo-state: first online state (for use in relational expressions).
678	</desc>
679	</const>
680	<const name="LastOnline" value="10" wsmap="suppress"> <!-- Restoring -->
681	<desc>
682	Pseudo-state: last online state (for use in relational expressions).
683	</desc>
684	</const>
685
686	<const name="FirstTransient" value="7" wsmap="suppress"> <!-- Starting -->
687	<desc>
688	Pseudo-state: first transient state (for use in relational expressions).
689	</desc>
690	</const>
691	<const name="LastTransient" value="12" wsmap="suppress"> <!-- SettingUp -->
692	<desc>
693	Pseudo-state: last transient state (for use in relational expressions).
694	</desc>
695	</const>
696
697	</enum>
698
699	<enum
700	name="SessionState"
701	uuid="CF2700C0-EA4B-47ae-9725-7810114B94D8"
702	>
703	<desc>
704	Session state. This enumeration represents possible values of
705	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
706	attributes. See individual enumerator descriptions for the meaning for
707	every value.
708	</desc>
709
710	<const name="Null" value="0">
711	<desc>Null value (never used by the API).</desc>
712	</const>
713	<const name="Closed" value="1">
714	<desc>
715	The machine has no open sessions (<link to="IMachine::sessionState"/>);
716	the session is closed (<link to="ISession::state"/>)
717	</desc>
718	</const>
719	<const name="Open" value="2">
720	<desc>
721	The machine has an open direct session (<link to="IMachine::sessionState"/>);
722	the session is open (<link to="ISession::state"/>)
723	</desc>
724	</const>
725	<const name="Spawning" value="3">
726	<desc>
727	A new (direct) session is being opened for the machine
728	as a result of <link to="IVirtualBox::openRemoteSession"/>
729	call (<link to="IMachine::sessionState"/>);
730	the session is currently being opened
731	as a result of <link to="IVirtualBox::openRemoteSession"/>
732	call (<link to="ISession::state"/>)
733	</desc>
734	</const>
735	<const name="Closing" value="4">
736	<desc>
737	The direct session is being closed (<link to="IMachine::sessionState"/>);
738	the session is being closed (<link to="ISession::state"/>)
739	</desc>
740	</const>
741	</enum>
742
743	<enum
744	name="SessionType"
745	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
746	>
747	<desc>
748	Session type. This enumeration represents possible values of the
749	<link to="ISession::type"/> attribute.
750	</desc>
751
752	<const name="Null" value="0">
753	<desc>Null value (never used by the API).</desc>
754	</const>
755	<const name="Direct" value="1">
756	<desc>
757	Direct session
758	(opened by <link to="IVirtualBox::openSession"/>)
759	</desc>
760	</const>
761	<const name="Remote" value="2">
762	<desc>
763	Remote session
764	(opened by <link to="IVirtualBox::openRemoteSession"/>)
765	</desc>
766	</const>
767	<const name="Existing" value="3">
768	<desc>
769	Existing session
770	(opened by <link to="IVirtualBox::openExistingSession"/>)
771	</desc>
772	</const>
773	</enum>
774
775	<enum
776	name="DeviceType"
777	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
778	>
779	<desc>
780	Device type.
781	</desc>
782	<const name="Null" value="0">
783	<desc>
784	Null value, may also mean "no device" (not allowed for
785	<link to="IConsole::getDeviceActivity"/>).
786	</desc>
787	</const>
788	<const name="Floppy" value="1">
789	<desc>Floppy device.</desc>
790	</const>
791	<const name="DVD" value="2">
792	<desc>CD/DVD-ROM device.</desc>
793	</const>
794	<const name="HardDisk" value="3">
795	<desc>Hard disk device.</desc>
796	</const>
797	<const name="Network" value="4">
798	<desc>Network device.</desc>
799	</const>
800	<const name="USB" value="5">
801	<desc>USB device.</desc>
802	</const>
803	<const name="SharedFolder" value="6">
804	<desc>Shared folder device.</desc>
805	</const>
806	</enum>
807
808	<enum
809	name="DeviceActivity"
810	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
811	>
812	<desc>
813	Device activity for <link to="IConsole::getDeviceActivity"/>.
814	</desc>
815
816	<const name="Null" value="0"/>
817	<const name="Idle" value="1"/>
818	<const name="Reading" value="2"/>
819	<const name="Writing" value="3"/>
820	</enum>
821
822	<enum
823	name="ClipboardMode"
824	uuid="33364716-4008-4701-8f14-be0fa3d62950"
825	>
826	<desc>
827	Host-Guest clipboard interchange mode.
828	</desc>
829
830	<const name="Disabled" value="0"/>
831	<const name="HostToGuest" value="1"/>
832	<const name="GuestToHost" value="2"/>
833	<const name="Bidirectional" value="3"/>
834	</enum>
835
836	<enum
837	name="Scope"
838	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
839	>
840	<desc>
841	Scope of the operation.
842
843	A generic enumeration used in various methods to define the action or
844	argument scope.
845	</desc>
846
847	<const name="Global" value="0"/>
848	<const name="Machine" value="1"/>
849	<const name="Session" value="2"/>
850	</enum>
851
852	<enum
853	name="GuestStatisticType"
854	uuid="aa7c1d71-aafe-47a8-9608-27d2d337cf55"
855	>
856	<desc>
857	Statistics type for <link to="IGuest::getStatistic"/>.
858	</desc>
859
860	<const name="CPULoad_Idle" value="0">
861	<desc>
862	Idle CPU load (0-100%) for last interval.
863	</desc>
864	</const>
865	<const name="CPULoad_Kernel" value="1">
866	<desc>
867	Kernel CPU load (0-100%) for last interval.
868	</desc>
869	</const>
870	<const name="CPULoad_User" value="2">
871	<desc>
872	User CPU load (0-100%) for last interval.
873	</desc>
874	</const>
875	<const name="Threads" value="3">
876	<desc>
877	Total number of threads in the system.
878	</desc>
879	</const>
880	<const name="Processes" value="4">
881	<desc>
882	Total number of processes in the system.
883	</desc>
884	</const>
885	<const name="Handles" value="5">
886	<desc>
887	Total number of handles in the system.
888	</desc>
889	</const>
890	<const name="MemoryLoad" value="6">
891	<desc>
892	Memory load (0-100%).
893	</desc>
894	</const>
895	<const name="PhysMemTotal" value="7">
896	<desc>
897	Total physical memory in megabytes.
898	</desc>
899	</const>
900	<const name="PhysMemAvailable" value="8">
901	<desc>
902	Free physical memory in megabytes.
903	</desc>
904	</const>
905	<const name="PhysMemBalloon" value="9">
906	<desc>
907	Ballooned physical memory in megabytes.
908	</desc>
909	</const>
910	<const name="MemCommitTotal" value="10">
911	<desc>
912	Total amount of memory in the committed state in megabytes.
913	</desc>
914	</const>
915	<const name="MemKernelTotal" value="11">
916	<desc>
917	Total amount of memory used by the guest OS's kernel in megabytes.
918	</desc>
919	</const>
920	<const name="MemKernelPaged" value="12">
921	<desc>
922	Total amount of paged memory used by the guest OS's kernel in megabytes.
923	</desc>
924	</const>
925	<const name="MemKernelNonpaged" value="13">
926	<desc>
927	Total amount of non-paged memory used by the guest OS's kernel in megabytes.
928	</desc>
929	</const>
930	<const name="MemSystemCache" value="14">
931	<desc>
932	Total amount of memory used by the guest OS's system cache in megabytes.
933	</desc>
934	</const>
935	<const name="PageFileSize" value="15">
936	<desc>
937	Pagefile size in megabytes.
938	</desc>
939	</const>
940	<const name="SampleNumber" value="16">
941	<desc>
942	Statistics sample number
943	</desc>
944	</const>
945	<const name="MaxVal" value="17"/>
946	</enum>
947
948	<enum
949	name="BIOSBootMenuMode"
950	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
951	>
952	<desc>
953	BIOS boot menu mode.
954	</desc>
955
956	<const name="Disabled" value="0"/>
957	<const name="MenuOnly" value="1"/>
958	<const name="MessageAndMenu" value="2"/>
959	</enum>
960
961	<enum
962	name="ProcessorFeature"
963	uuid="b8353b35-705d-4796-9967-ebfb7ba54af4"
964	>
965	<desc>
966	CPU features.
967	</desc>
968
969	<const name="HWVirtEx" value="0"/>
970	<const name="PAE" value="1"/>
971	<const name="LongMode" value="2"/>
972	</enum>
973
974	<enum
975	name="FirmwareType"
976	uuid="7ceea938-8b49-41e2-bb47-667219c0d586"
977	>
978	<desc>
979	Firmware type.
980	</desc>
981	<const name="BIOS" value="1">
982	<desc>BIOS Firmware.</desc>
983	</const>
984	<const name="EFI" value="2">
985	<desc>Efi firmware.</desc>
986	</const>
987	</enum>
988
989	<!--
990	// IVirtualBoxErrorInfo
991	/////////////////////////////////////////////////////////////////////////
992	-->
993
994	<interface
995	name="IVirtualBoxErrorInfo" extends="$errorinfo"
996	uuid="4b86d186-407e-4f9e-8be8-e50061be8725"
997	supportsErrorInfo="no"
998	wsmap="managed"
999	>
1000	<desc>
1001	The IVirtualBoxErrorInfo interface represents extended error information.
1002
1003	Extended error information can be set by VirtualBox components after
1004	unsuccessful or partially successful method invocation. This information
1005	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1006	and then shown to the client in addition to the plain 32-bit result code.
1007
1008	In MS COM, this interface extends the IErrorInfo interface,
1009	in XPCOM, it extends the nsIException interface. In both cases,
1010	it provides a set of common attributes to retrieve error
1011	information.
1012
1013	Sometimes invocation of some component's method may involve methods of
1014	other components that may also fail (independently of this method's
1015	failure), or a series of non-fatal errors may precede a fatal error that
1016	causes method failure. In cases like that, it may be desirable to preserve
1017	information about all errors happened during method invocation and deliver
1018	it to the caller. The <link to="#next"/> attribute is intended
1019	specifically for this purpose and allows to represent a chain of errors
1020	through a single IVirtualBoxErrorInfo object set after method invocation.
1021
1022	Note that errors are stored to a chain in the reverse order, i.e. the
1023	initial error object you query right after method invocation is the last
1024	error set by the callee, the object it points to in the @a next attribute
1025	is the previous error and so on, up to the first error (which is the last
1026	in the chain).
1027	</desc>
1028
1029	<attribute name="resultCode" type="long" readonly="yes">
1030	<desc>
1031	Result code of the error.
1032	Usually, it will be the same as the result code returned
1033	by the method that provided this error information, but not
1034	always. For example, on Win32, CoCreateInstance() will most
1035	likely return E_NOINTERFACE upon unsuccessful component
1036	instantiation attempt, but not the value the component factory
1037	returned. Value is typed 'long', not 'result',
1038	to make interface usable from scripting languages.
1039	<note>
1040	In MS COM, there is no equivalent.
1041	In XPCOM, it is the same as nsIException::result.
1042	</note>
1043	</desc>
1044	</attribute>
1045
1046	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1047	<desc>
1048	UUID of the interface that defined the error.
1049	<note>
1050	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1051	data type.
1052	In XPCOM, there is no equivalent.
1053	</note>
1054	</desc>
1055	</attribute>
1056
1057	<attribute name="component" type="wstring" readonly="yes">
1058	<desc>
1059	Name of the component that generated the error.
1060	<note>
1061	In MS COM, it is the same as IErrorInfo::GetSource.
1062	In XPCOM, there is no equivalent.
1063	</note>
1064	</desc>
1065	</attribute>
1066
1067	<attribute name="text" type="wstring" readonly="yes">
1068	<desc>
1069	Text description of the error.
1070	<note>
1071	In MS COM, it is the same as IErrorInfo::GetDescription.
1072	In XPCOM, it is the same as nsIException::message.
1073	</note>
1074	</desc>
1075	</attribute>
1076
1077	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1078	<desc>
1079	Next error object if there is any, or @c null otherwise.
1080	<note>
1081	In MS COM, there is no equivalent.
1082	In XPCOM, it is the same as nsIException::inner.
1083	</note>
1084	</desc>
1085	</attribute>
1086
1087	</interface>
1088
1089	<interface
1090	name="ILocalOwner" extends="$dispatched"
1091	uuid="308FF42A-DC45-49D4-A950-B1EEE5E00BB5" wsmap="suppress"
1092	>
1093	<desc>
1094	The ILocalOwner interface allows to register local objects
1095	(created without COM calls, but with new()).
1096	Once registered, calls to methods of such objects can be made
1097	from remote COM processes.
1098	The main usecase is the event callback implementation where
1099	API clients provide callback objects.
1100	</desc>
1101	<method name="setLocalObject">
1102	<desc>
1103	Set local object.
1104	</desc>
1105	<param name="object" type="$unknown" dir="in">
1106	<desc>Local object to forward requests to.
1107	If null, clears currently set local object.</desc>
1108	</param>
1109	</method>
1110	</interface>
1111
1112	<!--
1113	// IVirtualBox
1114	/////////////////////////////////////////////////////////////////////////
1115	-->
1116
1117	<interface
1118	name="IVirtualBoxCallback" extends="$unknown"
1119	uuid="9a65adf2-3ee6-406b-bca2-2b1fa05f0d0b"
1120	wsmap="suppress"
1121	>
1122
1123	<method name="onMachineStateChange">
1124	<desc>
1125	The execution state of the given machine has changed.
1126	<see>IMachine::state</see>
1127	</desc>
1128	<param name="machineId" type="uuid" mod="string" dir="in">
1129	<desc>ID of the machine this event relates to.</desc>
1130	</param>
1131	<param name="state" type="MachineState" dir="in">
1132	<desc>New execution state.</desc>
1133	</param>
1134	</method>
1135
1136	<method name="onMachineDataChange">
1137	<desc>
1138	Any of the settings of the given machine has changed.
1139	</desc>
1140	<param name="machineId" type="uuid" mod="string" dir="in">
1141	<desc>ID of the machine this event relates to.</desc>
1142	</param>
1143	</method>
1144
1145	<method name="onExtraDataCanChange">
1146	<desc>
1147	Notification when someone tries to change extra data for
1148	either the given machine or (if @c null) global extra data.
1149	This gives the chance to veto against changes.
1150	</desc>
1151	<param name="machineId" type="uuid" mod="string" dir="in">
1152	<desc>
1153	ID of the machine this event relates to
1154	(@c null ID for global extra data change requests).
1155	</desc>
1156	</param>
1157	<param name="key" type="wstring" dir="in">
1158	<desc>
1159	Extra data key for the attempted write.
1160	</desc>
1161	</param>
1162	<param name="value" type="wstring" dir="in">
1163	<desc>
1164	Extra data value for the given key.
1165	</desc>
1166	</param>
1167	<param name="error" type="wstring" dir="out">
1168	<desc>
1169	Optional error message describing the reason of the
1170	veto (ignored if this notification returns @c true).
1171	</desc>
1172	</param>
1173	<param name="allowChange" type="boolean" dir="return">
1174	<desc>
1175	Flag to indicate whether the callee agrees (@c true)
1176	or vetoes against the change (@c false).
1177	</desc>
1178	</param>
1179	</method>
1180
1181	<method name="onExtraDataChange">
1182	<desc>
1183	Notification when machine specific or global extra data
1184	has changed.
1185	</desc>
1186	<param name="machineId" type="uuid" mod="string" dir="in">
1187	<desc>
1188	ID of the machine this event relates to.
1189	Null for global extra data changes.
1190	</desc>
1191	</param>
1192	<param name="key" type="wstring" dir="in">
1193	<desc>
1194	Extra data key that has changed.
1195	</desc>
1196	</param>
1197	<param name="value" type="wstring" dir="in">
1198	<desc>
1199	Extra data value for the given key.
1200	</desc>
1201	</param>
1202	</method>
1203
1204	<method name="onMediumRegistered">
1205	<desc>
1206	The given medium was registered or unregistered
1207	within this VirtualBox installation.
1208
1209	The @a mediumType parameter describes what type of
1210	medium the specified @a mediumId refers to. Possible
1211	values are:
1212
1213	<ul>
1214	<li><link to="DeviceType_HardDisk"/>: the medium is a hard disk
1215	that, if registered, can be obtained using the
1216	<link to="IVirtualBox::getHardDisk"/> call.</li>
1217	<li><link to="DeviceType_DVD"/>: the medium is a CD/DVD image
1218	that, if registered, can be obtained using the
1219	<link to="IVirtualBox::getDVDImage"/> call.</li>
1220	<li><link to="DeviceType_Floppy"/>: the medium is a Floppy image
1221	that, if registered, can be obtained using the
1222	<link to="IVirtualBox::getFloppyImage"/> call.</li>
1223	</ul>
1224
1225	Note that if this is a deregistration notification,
1226	there is no way to access the object representing the
1227	unregistered medium. It is supposed that the
1228	application will do required cleanup based on the
1229	@a mediumId value.
1230	</desc>
1231	<param name="mediumId" type="uuid" mod="string" dir="in">
1232	<desc>ID of the medium this event relates to.</desc>
1233	</param>
1234	<param name="mediumType" type="DeviceType" dir="in">
1235	<desc>Type of the medium this event relates to.</desc>
1236	</param>
1237	<param name="registered" type="boolean" dir="in">
1238	<desc>
1239	If @c true, the medium was registered, otherwise it was
1240	unregistered.
1241	</desc>
1242	</param>
1243	</method>
1244
1245	<method name="onMachineRegistered">
1246	<desc>
1247	The given machine was registered or unregistered
1248	within this VirtualBox installation.
1249	</desc>
1250	<param name="machineId" type="uuid" mod="string" dir="in">
1251	<desc>ID of the machine this event relates to.</desc>
1252	</param>
1253	<param name="registered" type="boolean" dir="in">
1254	<desc>
1255	If @c true, the machine was registered, otherwise it was
1256	unregistered.
1257	</desc>
1258	</param>
1259	</method>
1260
1261	<method name="onSessionStateChange">
1262	<desc>
1263	The state of the session for the given machine was changed.
1264	<see>IMachine::sessionState</see>
1265	</desc>
1266	<param name="machineId" type="uuid" mod="string" dir="in">
1267	<desc>ID of the machine this event relates to.</desc>
1268	</param>
1269	<param name="state" type="SessionState" dir="in">
1270	<desc>New session state.</desc>
1271	</param>
1272	</method>
1273
1274	<method name="onSnapshotTaken">
1275	<desc>
1276	A new snapshot of the machine has been taken.
1277	<see>ISnapshot</see>
1278	</desc>
1279	<param name="machineId" type="uuid" mod="string" dir="in">
1280	<desc>ID of the machine this event relates to.</desc>
1281	</param>
1282	<param name="snapshotId" type="uuid" mod="string" dir="in">
1283	<desc>ID of the new snapshot.</desc>
1284	</param>
1285	</method>
1286
1287	<method name="onSnapshotDiscarded">
1288	<desc>
1289	Snapshot of the given machine has been discarded.
1290
1291	<note>
1292	This notification is delivered <b>after</b> the snapshot
1293	object has been uninitialized on the server (so that any
1294	attempt to call its methods will return an error).
1295	</note>
1296
1297	<see>ISnapshot</see>
1298	</desc>
1299	<param name="machineId" type="uuid" mod="string" dir="in">
1300	<desc>ID of the machine this event relates to.</desc>
1301	</param>
1302	<param name="snapshotId" type="uuid" mod="string" dir="in">
1303	<desc>
1304	ID of the discarded snapshot. @c null means the current machine
1305	state has been discarded (restored from the current snapshot).
1306	</desc>
1307	</param>
1308	</method>
1309
1310	<method name="onSnapshotChange">
1311	<desc>
1312	Snapshot properties (name and/or description) have been changed.
1313	<see>ISnapshot</see>
1314	</desc>
1315	<param name="machineId" type="uuid" mod="string" dir="in">
1316	<desc>ID of the machine this event relates to.</desc>
1317	</param>
1318	<param name="snapshotId" type="uuid" mod="string" dir="in">
1319	<desc>ID of the changed snapshot.</desc>
1320	</param>
1321	</method>
1322
1323	<method name="onGuestPropertyChange">
1324	<desc>
1325	Notification when a guest property has changed.
1326	</desc>
1327	<param name="machineId" type="uuid" mod="string" dir="in">
1328	<desc>
1329	ID of the machine this event relates to.
1330	</desc>
1331	</param>
1332	<param name="name" type="wstring" dir="in">
1333	<desc>
1334	The name of the property that has changed.
1335	</desc>
1336	</param>
1337	<param name="value" type="wstring" dir="in">
1338	<desc>
1339	The new property value.
1340	</desc>
1341	</param>
1342	<param name="flags" type="wstring" dir="in">
1343	<desc>
1344	The new property flags.
1345	</desc>
1346	</param>
1347	</method>
1348
1349	</interface>
1350
1351	<interface
1352	name="IDHCPServer" extends="$unknown"
1353	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1354	wsmap="managed"
1355	>
1356	<desc>
1357	The IDHCPServer interface represents the vbox dhcp server configuration.
1358
1359	To enumerate all the dhcp servers on the host, use the
1360	<link to="IVirtualBox::DHCPServers"/> attribute.
1361	</desc>
1362
1363	<attribute name="enabled" type="boolean">
1364	<desc>
1365	specifies if the dhcp server is enabled
1366	</desc>
1367	</attribute>
1368
1369	<attribute name="IPAddress" type="wstring" readonly="yes">
1370	<desc>
1371	specifies server IP
1372	</desc>
1373	</attribute>
1374
1375	<attribute name="networkMask" type="wstring" readonly="yes">
1376	<desc>
1377	specifies server network mask
1378	</desc>
1379	</attribute>
1380
1381	<attribute name="networkName" type="wstring" readonly="yes">
1382	<desc>
1383	specifies internal network name the server is used for
1384	</desc>
1385	</attribute>
1386
1387	<attribute name="lowerIP" type="wstring" readonly="yes">
1388	<desc>
1389	specifies from IP adrres in server address range
1390	</desc>
1391	</attribute>
1392
1393	<attribute name="upperIP" type="wstring" readonly="yes">
1394	<desc>
1395	specifies to IP adrres in server address range
1396	</desc>
1397	</attribute>
1398
1399	<method name="setConfiguration">
1400	<desc>
1401	configures the server
1402	<result name="E_INVALIDARG">
1403	invalid configuration supplied
1404	</result>
1405	</desc>
1406	<param name="IPAddress" type="wstring" dir="in">
1407	<desc>
1408	server IP address
1409	</desc>
1410	</param>
1411	<param name="networkMask" type="wstring" dir="in">
1412	<desc>
1413	server network mask
1414	</desc>
1415	</param>
1416	<param name="FromIPAddress" type="wstring" dir="in">
1417	<desc>
1418	server From IP address for address range
1419	</desc>
1420	</param>
1421	<param name="ToIPAddress" type="wstring" dir="in">
1422	<desc>
1423	server To IP address for address range
1424	</desc>
1425	</param>
1426	</method>
1427
1428	<method name="start">
1429	<desc>
1430	Starts DHCP server process.
1431	<result name="E_FAIL">
1432	Failed to start the process.
1433	</result>
1434	</desc>
1435	<param name="networkName" type="wstring" dir="in">
1436	<desc>
1437	Name of internal network DHCP server should attach to.
1438	</desc>
1439	</param>
1440	<param name="trunkName" type="wstring" dir="in">
1441	<desc>
1442	Name of internal network trunk.
1443	</desc>
1444	</param>
1445	<param name="trunkType" type="wstring" dir="in">
1446	<desc>
1447	Type of internal network trunk.
1448	</desc>
1449	</param>
1450	</method>
1451
1452	<method name="stop">
1453	<desc>
1454	Stops DHCP server process.
1455	<result name="E_FAIL">
1456	Failed to stop the process.
1457	</result>
1458	</desc>
1459	</method>
1460	</interface>
1461
1462	<interface
1463	name="IVirtualBox" extends="$dispatched"
1464	uuid="c1b8d85d-8f44-4314-94fc-072332bdf852"
1465	wsmap="managed"
1466	>
1467	<desc>
1468	The IVirtualBox interface represents the main interface exposed by the
1469	product that provides virtual machine management.
1470
1471	An instance of IVirtualBox is required for the product to do anything
1472	useful. Even though the interface does not expose this, internally,
1473	IVirtualBox is implemented as a singleton and actually lives in the
1474	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1475	IVirtualBox can track the state of all virtual machines on a particular
1476	host, regardless of which frontend started them.
1477
1478	To enumerate all the virtual machines on the host, use the
1479	<link to="IVirtualBox::machines"/> attribute.
1480	</desc>
1481
1482	<attribute name="version" type="wstring" readonly="yes">
1483	<desc>
1484	A string representing the version number of the product. The
1485	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1486	last number represents the build number and will frequently change.
1487	</desc>
1488	</attribute>
1489
1490	<attribute name="revision" type="unsigned long" readonly="yes">
1491	<desc>
1492	The internal build revision number of the product.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="packageType" type="wstring" readonly="yes">
1497	<desc>
1498	A string representing the package type of this product. The
1499	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1500	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1501	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1502	this.
1503	</desc>
1504	</attribute>
1505
1506	<attribute name="homeFolder" type="wstring" readonly="yes">
1507	<desc>
1508	Full path to the directory where the global settings file,
1509	<tt>VirtualBox.xml</tt>, is stored.
1510
1511	In this version of VirtualBox, the value of this property is
1512	always <tt><user_dir>/.VirtualBox</tt> (where
1513	<tt><user_dir></tt> is the path to the user directory,
1514	as determined by the host OS), and cannot be changed.
1515
1516	This path is also used as the base to resolve relative paths in
1517	places where relative paths are allowed (unless otherwise
1518	expressly indicated).
1519	</desc>
1520	</attribute>
1521
1522	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1523	<desc>
1524	Full name of the global settings file.
1525	The value of this property corresponds to the value of
1526	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1527	</desc>
1528	</attribute>
1529
1530	<attribute name="host" type="IHost" readonly="yes">
1531	<desc>Associated host object.</desc>
1532	</attribute>
1533
1534	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1535	<desc>Associated system information object.</desc>
1536	</attribute>
1537
1538	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1539	<desc>
1540	Array of machine objects registered within this VirtualBox instance.
1541	</desc>
1542	</attribute>
1543
1544	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1545	<desc>
1546	Array of medium objects known to this VirtualBox installation.
1547
1548	This array contains only base media. All differencing
1549	media of the given base medium can be enumerated using
1550	<link to="IMedium::children"/>.
1551	</desc>
1552	</attribute>
1553
1554	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1555	<desc>
1556	Array of CD/DVD image objects registered with this VirtualBox instance.
1557	</desc>
1558	</attribute>
1559
1560	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1561	<desc>
1562	Array of floppy image objects registered with this VirtualBox instance.
1563	</desc>
1564	</attribute>
1565
1566	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1567
1568	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1569
1570	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1571	<desc>
1572	Collection of global shared folders. Global shared folders are
1573	available to all virtual machines.
1574
1575	New shared folders are added to the collection using
1576	<link to="#createSharedFolder"/>. Existing shared folders can be
1577	removed using <link to="#removeSharedFolder"/>.
1578
1579	<note>
1580	In the current version of the product, global shared folders are not
1581	implemented and therefore this collection is always empty.
1582	</note>
1583	</desc>
1584	</attribute>
1585
1586	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1587	<desc>
1588	Associated performance collector object.
1589	</desc>
1590	</attribute>
1591
1592	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1593	<desc>
1594	dhcp server settings.
1595	</desc>
1596	</attribute>
1597
1598	<method name="createMachine">
1599	<desc>
1600	Creates a new virtual machine.
1601
1602	The new machine is created unregistered, with the initial configuration
1603	set according to the specified guest OS type. A typical sequence of
1604	actions to create a new virtual machine is as follows:
1605
1606	<ol>
1607	<li>
1608	Call this method to have a new machine created. The returned machine
1609	object will be "mutable" allowing to change any machine property.
1610	</li>
1611
1612	<li>
1613	Configure the machine using the appropriate attributes and methods.
1614	</li>
1615
1616	<li>
1617	Call <link to="IMachine::saveSettings" /> to write the settings
1618	to the machine's XML settings file. The configuration of the newly
1619	created machine will not be saved to disk until this method is
1620	called.
1621	</li>
1622
1623	<li>
1624	Call <link to="#registerMachine" /> to add the machine to the list
1625	of machines known to VirtualBox.
1626	</li>
1627	</ol>
1628
1629	You should specify valid name for the newly created machine when calling
1630	this method. See the <link to="IMachine::name"/> attribute description
1631	for more details about the machine name.
1632
1633	The specified guest OS type identifier must match an ID of one of known
1634	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1635	array.
1636
1637	Every machine has a <i>settings file</i> that is used to store
1638	the machine configuration. This file is stored in a directory called the
1639	<i>machine settings subfolder</i>. Both the settings subfolder and file
1640	will have a name that corresponds to the name of the virtual machine.
1641	You can specify where to create the machine setting subfolder using the
1642	@a baseFolder argument. The base folder can be absolute (full path) or
1643	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1644	directory</link>.
1645
1646	If @a baseFolder is a @c null or empty string (which is recommended), the
1647	<link to="ISystemProperties::defaultMachineFolder">default machine
1648	settings folder</link> will be used as a base folder for the created
1649	machine. Otherwise the given base folder will be used. In either case,
1650	the full path to the resulting settings file has the following
1651	structure:
1652	<pre>
1653	<base_folder>/<machine_name>/<machine_name>.xml
1654	</pre>
1655
1656	Note that if the resulting settings file already exists, this method
1657	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1658
1659	Optionally, you may specify an UUID of to assign to the created machine.
1660	However, this is not recommended and you should normally pass an empty
1661	(@c null) UUID to this method so that a new UUID will be automatically
1662	generated for every created machine. You can use UUID
1663	00000000-0000-0000-0000-000000000000 as @c null value.
1664
1665	<note>
1666	There is no way to change the name of the settings file or
1667	subfolder of the created machine directly.
1668	</note>
1669
1670	<result name="VBOX_E_OBJECT_NOT_FOUND">
1671	@a osTypeId is invalid.
1672	</result>
1673	<result name="VBOX_E_FILE_ERROR">
1674	Resulting settings file name is invalid or the settings file already
1675	exists or could not be created due to an I/O error.
1676	</result>
1677	<result name="E_INVALIDARG">
1678	@a name is empty or @c null.
1679	</result>
1680	</desc>
1681
1682	<param name="name" type="wstring" dir="in">
1683	<desc>Machine name.</desc>
1684	</param>
1685	<param name="osTypeId" type="wstring" dir="in">
1686	<desc>Guest OS Type ID.</desc>
1687	</param>
1688	<param name="baseFolder" type="wstring" dir="in">
1689	<desc>Base machine folder (optional).</desc>
1690	</param>
1691	<param name="id" type="uuid" mod="string" dir="in">
1692	<desc>Machine UUID (optional).</desc>
1693	</param>
1694	<param name="machine" type="IMachine" dir="return">
1695	<desc>Created machine object.</desc>
1696	</param>
1697	</method>
1698
1699	<method name="createLegacyMachine">
1700	<desc>
1701	Creates a new virtual machine in "legacy" mode, using the specified
1702	settings file to store machine settings.
1703
1704	As opposed to machines created by <link to="#createMachine"/>,
1705	the settings file of the machine created in "legacy" mode is not
1706	automatically renamed when the machine name is changed -- it will always
1707	remain the same as specified in this method call.
1708
1709	The specified settings file name can be absolute (full path) or relative
1710	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1711	directory</link>. If the file name doesn't contain an extension, the
1712	default extension (.xml) will be appended.
1713
1714	Note that the configuration of the newly created machine is not
1715	saved to disk (and therefore no settings file is created)
1716	until <link to="IMachine::saveSettings"/> is called. If the
1717	specified settings file already exists, this method
1718	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1719
1720	See <link to="#createMachine"/> for more information.
1721
1722	@deprecated This method may be removed later. Use <link
1723	to="IVirtualBox::createMachine"/> instead.
1724
1725	<note>
1726	There is no way to change the name of the settings file
1727	of the machine created in "legacy" mode.
1728	</note>
1729
1730	<result name="VBOX_E_OBJECT_NOT_FOUND">
1731	@a osTypeId is invalid.
1732	</result>
1733	<result name="VBOX_E_FILE_ERROR">
1734	@a settingsFile is invalid or the settings file already exists or
1735	could not be created due to an I/O error.
1736	</result>
1737	<result name="E_INVALIDARG">
1738	@a name or @a settingsFile is empty or @c null.
1739	</result>
1740	</desc>
1741
1742	<param name="name" type="wstring" dir="in">
1743	<desc>Machine name.</desc>
1744	</param>
1745	<param name="osTypeId" type="wstring" dir="in">
1746	<desc>Machine OS Type ID.</desc>
1747	</param>
1748	<param name="settingsFile" type="wstring" dir="in">
1749	<desc>Name of the machine settings file.</desc>
1750	</param>
1751	<param name="id" type="uuid" mod="string" dir="in">
1752	<desc>Machine UUID (optional).</desc>
1753	</param>
1754	<param name="machine" type="IMachine" dir="return">
1755	<desc>Created machine object.</desc>
1756	</param>
1757	</method>
1758
1759	<method name="openMachine">
1760	<desc>
1761	Opens a virtual machine from the existing settings file.
1762	The opened machine remains unregistered until you call
1763	<link to="#registerMachine"/>.
1764
1765	The specified settings file name can be absolute
1766	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1767	VirtualBox home directory</link>. This file must exist
1768	and must be a valid machine settings file whose contents
1769	will be used to construct the machine object.
1770
1771	@deprecated Will be removed soon.
1772	<result name="VBOX_E_FILE_ERROR">
1773	Settings file name invalid, not found or sharing violation.
1774	</result>
1775	</desc>
1776	<param name="settingsFile" type="wstring" dir="in">
1777	<desc>
1778	Name of the machine settings file.
1779	</desc>
1780	</param>
1781	<param name="machine" type="IMachine" dir="return">
1782	<desc>Opened machine object.</desc>
1783	</param>
1784	<note>
1785	<link to="IMachine::settingsModified"/> will return
1786	@c false for the created machine, until any of machine settings
1787	are changed.
1788	</note>
1789	</method>
1790
1791	<method name="registerMachine">
1792	<desc>
1793
1794	Registers the machine previously created using
1795	<link to="#createMachine"/> or opened using
1796	<link to="#openMachine"/> within this VirtualBox installation. After
1797	successful method invocation, the
1798	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1799	to all registered callbacks.
1800
1801	<note>
1802	This method implicitly calls <link to="IMachine::saveSettings"/>
1803	to save all current machine settings before registering it.
1804	</note>
1805
1806	<result name="VBOX_E_OBJECT_NOT_FOUND">
1807	No matching virtual machine found.
1808	</result>
1809	<result name="VBOX_E_INVALID_OBJECT_STATE">
1810	Virtual machine was not created within this VirtualBox instance.
1811	</result>
1812
1813	</desc>
1814	<param name="machine" type="IMachine" dir="in"/>
1815	</method>
1816
1817	<method name="getMachine">
1818	<desc>
1819	Attempts to find a virtual machine given its UUID.
1820	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1821	instead.
1822
1823	<result name="VBOX_E_OBJECT_NOT_FOUND">
1824	Could not find registered machine matching @a id.
1825	</result>
1826
1827	</desc>
1828	<param name="id" type="uuid" mod="string" dir="in"/>
1829	<param name="machine" type="IMachine" dir="return"/>
1830	</method>
1831
1832	<method name="findMachine">
1833	<desc>
1834	Attempts to find a virtual machine given its name.
1835	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1836	instead.
1837
1838	<result name="VBOX_E_OBJECT_NOT_FOUND">
1839	Could not find registered machine matching @a name.
1840	</result>
1841
1842	</desc>
1843	<param name="name" type="wstring" dir="in"/>
1844	<param name="machine" type="IMachine" dir="return"/>
1845	</method>
1846
1847	<method name="unregisterMachine">
1848	<desc>
1849
1850	Unregisters the machine previously registered using
1851	<link to="#registerMachine"/>. After successful method invocation, the
1852	<link to="IVirtualBoxCallback::onMachineRegistered"/> signal is sent
1853	to all registered callbacks.
1854
1855	<note>
1856	The specified machine must not be in the Saved state, have an open
1857	(or a spawning) direct session associated with it, have snapshots or
1858	have hard disks attached.
1859	</note>
1860
1861	<note>
1862	This method implicitly calls <link to="IMachine::saveSettings"/> to
1863	save all current machine settings before unregistering it.
1864	</note>
1865
1866	<note>
1867	If the given machine is inaccessible (see
1868	<link to="IMachine::accessible"/>), it will be unregistered and
1869	fully uninitialized right afterwards. As a result, the returned
1870	machine object will be unusable and an attempt to call
1871	<b>any</b> method will return the "Object not ready" error.
1872	</note>
1873
1874	<result name="VBOX_E_OBJECT_NOT_FOUND">
1875	Could not find registered machine matching @a id.
1876	</result>
1877	<result name="VBOX_E_INVALID_VM_STATE">
1878	Machine is in Saved state.
1879	</result>
1880	<result name="VBOX_E_INVALID_OBJECT_STATE">
1881	Machine has snapshot or open session or hard disk attached.
1882	</result>
1883
1884	</desc>
1885	<param name="id" type="uuid" mod="string" dir="in">
1886	<desc>UUID of the machine to unregister.</desc>
1887	</param>
1888	<param name="machine" type="IMachine" dir="return">
1889	<desc>Unregistered machine object.</desc>
1890	</param>
1891	</method>
1892
1893	<method name="createAppliance">
1894	<desc>
1895	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1896	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1897	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1898	</desc>
1899	<param name="appliance" type="IAppliance" dir="return">
1900	<desc>New appliance.</desc>
1901	</param>
1902	</method>
1903
1904	<method name="createHardDisk">
1905	<desc>
1906	Creates a new base medium object that will use the given storage
1907	format and location for medium data.
1908
1909	Note that the actual storage unit is not created by this method. In
1910	order to do it, and before you are able to attach the created medium
1911	to virtual machines, you must call one of the following methods to
1912	allocate a format-specific storage unit at the specified location:
1913	<ul>
1914	<li><link to="IMedium::createBaseStorage"/></li>
1915	<li><link to="IMedium::createDiffStorage"/></li>
1916	</ul>
1917
1918	Some medium attributes, such as <link to="IMedium::id"/>, may
1919	remain uninitialized until the medium storage unit is successfully
1920	created by one of the above methods.
1921
1922	After the storage unit is successfully created, the medium gets
1923	remembered by this VirtualBox installation and will be accessible
1924	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
1925	methods. Remembered base medium are also returned as part of
1926	the <link to="#hardDisks"/> array. See IMedium for more details.
1927
1928	The list of all storage formats supported by this VirtualBox
1929	installation can be obtained using
1930	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1931	attribute is empty or @c null then the default storage format
1932	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1933	be used for creating a storage unit of the medium.
1934
1935	Note that the format of the location string is storage format specific.
1936	See <link to="IMedium::location"/>, IMedium and
1937	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1938
1939	<result name="VBOX_E_OBJECT_NOT_FOUND">
1940	@a format identifier is invalid. See
1941	<link to="ISystemProperties::mediumFormats"/>.
1942	</result>
1943	<result name="VBOX_E_FILE_ERROR">
1944	@a location is a not valid file name (for file-based formats only).
1945	</result>
1946	</desc>
1947	<param name="format" type="wstring" dir="in">
1948	<desc>
1949	Identifier of the storage format to use for the new medium.
1950	</desc>
1951	</param>
1952	<param name="location" type="wstring" dir="in">
1953	<desc>
1954	Location of the storage unit for the new medium.
1955	</desc>
1956	</param>
1957	<param name="medium" type="IMedium" dir="return">
1958	<desc>Created medium object.</desc>
1959	</param>
1960	</method>
1961
1962	<method name="openHardDisk">
1963	<desc>
1964	Opens a medium from an existing location, optionally replacing
1965	the image UUID and/or parent UUID.
1966
1967	After the medium is successfully opened by this method, it gets
1968	remembered by (known to) this VirtualBox installation and will be
1969	accessible through <link to="#getHardDisk"/> and
1970	<link to="#findHardDisk"/> methods. Remembered base media
1971	are also returned as part of the <link to="#hardDisks"/> array and can
1972	be attached to virtual machines. See IMedium for more details.
1973
1974	If a differencing medium is to be opened by this method, the
1975	operation will succeed only if its parent medium and all ancestors,
1976	if any, are already known to this VirtualBox installation (for example,
1977	were opened by this method before).
1978
1979	This method tries to guess the storage format of the specified medium
1980	by reading medium data at the specified location.
1981
1982	If @a write is ReadWrite (which it should be), the image is opened for
1983	read/write access and must have according permissions, as VirtualBox
1984	may actually write status information into the disk's metadata sections.
1985
1986	Note that write access is required for all typical image usage in VirtualBox,
1987	since VirtualBox may need to write metadata such as a UUID into the image.
1988	The only exception is opening a source image temporarily for copying and
1989	cloning when the image will quickly be closed again.
1990
1991	Note that the format of the location string is storage format specific.
1992	See <link to="IMedium::location"/>, IMedium and
1993	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1994
1995	<result name="VBOX_E_FILE_ERROR">
1996	Invalid medium storage file location or could not find the medium
1997	at the specified location.
1998	</result>
1999	<result name="VBOX_E_IPRT_ERROR">
2000	Could not get medium storage format.
2001	</result>
2002	<result name="E_INVALIDARG">
2003	Invalid medium storage format.
2004	</result>
2005
2006	</desc>
2007	<param name="location" type="wstring" dir="in">
2008	<desc>
2009	Location of the storage unit that contains medium data in one of
2010	the supported storage formats.
2011	</desc>
2012	</param>
2013	<param name="accessMode" type="AccessMode" dir="in">
2014	<desc>
2015	Determines whether to open the image in read/write or read-only mode.
2016	</desc>
2017	</param>
2018	<param name="setImageId" type="boolean" dir="in">
2019	<desc>
2020	Select whether a new image UUID is set or not.
2021	</desc>
2022	</param>
2023	<param name="imageId" type="uuid" mod="string" dir="in">
2024	<desc>
2025	New UUID for the image. If an empty string is passed, then a new
2026	UUID is automatically created. Specifying a zero UUIDs is not valid.
2027	</desc>
2028	</param>
2029	<param name="setParentId" type="boolean" dir="in">
2030	<desc>
2031	Select whether a new parent UUID is set or not.
2032	</desc>
2033	</param>
2034	<param name="parentId" type="uuid" mod="string" dir="in">
2035	<desc>
2036	New parent UUID for the image. If an empty string is passed, then a
2037	new UUID is automatically created, provided @a setParentId is
2038	@c true. A zero UUID is valid.
2039	</desc>
2040	</param>
2041	<param name="medium" type="IMedium" dir="return">
2042	<desc>Opened medium object.</desc>
2043	</param>
2044	</method>
2045
2046	<method name="getHardDisk" const="yes">
2047	<desc>
2048	Returns a medium with the given UUID.
2049
2050	The medium with the given UUID must be known to this VirtualBox
2051	installation, i.e. it must be previously created by
2052	<link to="#createHardDisk"/> or opened by <link
2053	to="#openHardDisk"/>, or attached to some known virtual machine.
2054
2055	<result name="VBOX_E_OBJECT_NOT_FOUND">
2056	No medium object matching @a id found.
2057	</result>
2058
2059	</desc>
2060	<param name="id" type="uuid" mod="string" dir="in">
2061	<desc>UUID of the medium to look for.</desc>
2062	</param>
2063	<param name="medium" type="IMedium" dir="return">
2064	<desc>Found medium object.</desc>
2065	</param>
2066	</method>
2067
2068	<method name="findHardDisk">
2069	<desc>
2070	Returns a medium that uses the given location to store medium data.
2071
2072	The given medium must be known to this VirtualBox installation, i.e.
2073	it must be previously created by
2074	<link to="#createHardDisk"/> or opened by <link
2075	to="#openHardDisk"/>, or attached to some known virtual machine.
2076
2077	The search is done by comparing the value of the @a location argument to
2078	the <link to="IMedium::location"/> attribute of each known medium.
2079
2080	For locations represented by file names in the host's file system, the
2081	requested location can be a path relative to the
2082	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2083	only a file name without any path is given, the
2084	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
2085	folder</link> will be prepended to the file name before searching. Note
2086	that on case sensitive file systems, a case sensitive comparison is
2087	performed, otherwise the case of symbols in the file path is ignored.
2088
2089	<result name="VBOX_E_OBJECT_NOT_FOUND">
2090	No medium object matching @a location found.
2091	</result>
2092
2093	</desc>
2094	<param name="location" type="wstring" dir="in">
2095	<desc>Location string to search for.</desc>
2096	</param>
2097	<param name="medium" type="IMedium" dir="return">
2098	<desc>Found medium object.</desc>
2099	</param>
2100	</method>
2101
2102	<method name="openDVDImage">
2103	<desc>
2104	Opens a CD/DVD image contained in the specified file of the supported
2105	format and assigns it the given UUID.
2106
2107	After the image is successfully opened by this method, it gets
2108	remembered by (known to) this VirtualBox installation and will be
2109	accessible through <link to="#getDVDImage"/> and
2110	<link to="#findDVDImage"/> methods. Remembered images are also
2111	returned as part of the <link to="#DVDImages"/> array and can be mounted
2112	to virtual machines. See IMedium for more details.
2113
2114	See <link to="IMedium::location"/> to get more details about the format
2115	of the location string.
2116
2117	<note>
2118	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
2119	</note>
2120
2121	<result name="VBOX_E_FILE_ERROR">
2122	Invalid CD/DVD image file location or could not find the CD/DVD
2123	image at the specified location.
2124	</result>
2125	<result name="VBOX_E_INVALID_OBJECT_STATE">
2126	CD/DVD image already exists in the media registry.
2127	</result>
2128
2129	</desc>
2130	<param name="location" type="wstring" dir="in">
2131	<desc>
2132	Full path to the file that contains a valid CD/DVD image.
2133	</desc>
2134	</param>
2135	<param name="id" type="uuid" mod="string" dir="in">
2136	<desc>
2137	UUID to assign to the given image within this VirtualBox installation.
2138	If an empty (@c null) UUID is specified, the system will randomly
2139	generate a new UUID.
2140	</desc>
2141	</param>
2142	<param name="image" type="IMedium" dir="return">
2143	<desc>Opened CD/DVD image object.</desc>
2144	</param>
2145	</method>
2146
2147	<method name="getDVDImage">
2148	<desc>
2149	Returns a CD/DVD image with the given UUID.
2150
2151	The image with the given UUID must be known to this VirtualBox
2152	installation, i.e. it must be previously opened by <link
2153	to="#openDVDImage"/>, or mounted to some known virtual machine.
2154
2155	<result name="VBOX_E_OBJECT_NOT_FOUND">
2156	No matching DVD image found in the media registry.
2157	</result>
2158
2159	</desc>
2160	<param name="id" type="uuid" mod="string" dir="in">
2161	<desc>UUID of the image to look for.</desc>
2162	</param>
2163	<param name="image" type="IMedium" dir="return">
2164	<desc>Found CD/DVD image object.</desc>
2165	</param>
2166	</method>
2167
2168	<method name="findDVDImage">
2169	<desc>
2170	Returns a CD/DVD image with the given image location.
2171
2172	The image with the given UUID must be known to this VirtualBox
2173	installation, i.e. it must be previously opened by <link
2174	to="#openDVDImage"/>, or mounted to some known virtual machine.
2175
2176	The search is done by comparing the value of the @a location argument to
2177	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2178
2179	The requested location can be a path relative to the
2180	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2181	only a file name without any path is given, the
2182	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2183	folder</link> will be prepended to the file name before searching. Note
2184	that on case sensitive file systems, a case sensitive comparison is
2185	performed, otherwise the case in the file path is ignored.
2186
2187	<result name="VBOX_E_FILE_ERROR">
2188	Invalid image file location.
2189	</result>
2190	<result name="VBOX_E_OBJECT_NOT_FOUND">
2191	No matching DVD image found in the media registry.
2192	</result>
2193
2194	</desc>
2195	<param name="location" type="wstring" dir="in">
2196	<desc>CD/DVD image file path to look for.</desc>
2197	</param>
2198	<param name="image" type="IMedium" dir="return">
2199	<desc>Found CD/DVD image object.</desc>
2200	</param>
2201	</method>
2202
2203	<method name="openFloppyImage">
2204	<desc>
2205	Opens a floppy image contained in the specified file of the supported
2206	format and assigns it the given UUID.
2207
2208	After the image is successfully opened by this method, it gets
2209	remembered by (known to) this VirtualBox installation and will be
2210	accessible through <link to="#getFloppyImage"/> and
2211	<link to="#findFloppyImage"/> methods. Remembered images are also
2212	returned as part of the <link to="#floppyImages"/> array and can be
2213	mounted to virtual machines. See IMedium for more details.
2214
2215	See <link to="IMedium::location"/> to get more details about the format
2216	of the location string.
2217
2218	<result name="VBOX_E_FILE_ERROR">
2219	Invalid floppy image file location or could not find the floppy
2220	image at the specified location.
2221	</result>
2222	<result name="VBOX_E_INVALID_OBJECT_STATE">
2223	Floppy image already exists in the media registry.
2224	</result>
2225
2226	<note>
2227	Currently, only raw floppy images are supported by VirtualBox.
2228	</note>
2229	</desc>
2230	<param name="location" type="wstring" dir="in">
2231	<desc>
2232	Full path to the file that contains a valid floppy image.
2233	</desc>
2234	</param>
2235	<param name="id" type="uuid" mod="string" dir="in">
2236	<desc>
2237	UUID to assign to the given image file within this VirtualBox
2238	installation. If an empty (@c null) UUID is specified, the system will
2239	randomly generate a new UUID.
2240	</desc>
2241	</param>
2242	<param name="image" type="IMedium" dir="return">
2243	<desc>Opened floppy image object.</desc>
2244	</param>
2245	</method>
2246
2247	<method name="getFloppyImage">
2248	<desc>
2249	Returns a floppy image with the given UUID.
2250
2251	The image with the given UUID must be known to this VirtualBox
2252	installation, i.e. it must be previously opened by <link
2253	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2254
2255	<result name="VBOX_E_OBJECT_NOT_FOUND">
2256	No matching floppy image found in the media registry.
2257	</result>
2258
2259	</desc>
2260	<param name="id" type="uuid" mod="string" dir="in">
2261	<desc>UUID of the image to look for.</desc>
2262	</param>
2263	<param name="image" type="IMedium" dir="return">
2264	<desc>Found floppy image object.</desc>
2265	</param>
2266	</method>
2267
2268	<method name="findFloppyImage">
2269	<desc>
2270	Returns a floppy image with the given image location.
2271
2272	The image with the given UUID must be known to this VirtualBox
2273	installation, i.e. it must be previously opened by <link
2274	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2275
2276	The search is done by comparing the value of the @a location argument to
2277	the <link to="IMedium::location"/> attribute of each known floppy image.
2278
2279	The requested location can be a path relative to the
2280	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2281	only a file name without any path is given, the
2282	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2283	folder</link> will be prepended to the file name before searching. Note
2284	that on case sensitive file systems, a case sensitive comparison is
2285	performed, otherwise the case of symbols in the file path is ignored.
2286
2287	<result name="VBOX_E_FILE_ERROR">
2288	Invalid image file location.
2289	</result>
2290	<result name="VBOX_E_OBJECT_NOT_FOUND">
2291	No matching floppy image found in the media registry.
2292	</result>
2293
2294	</desc>
2295	<param name="location" type="wstring" dir="in">
2296	<desc>Floppy image file path to look for.</desc>
2297	</param>
2298	<param name="image" type="IMedium" dir="return">
2299	<desc>Found floppy image object.</desc>
2300	</param>
2301	</method>
2302
2303	<method name="getGuestOSType">
2304	<desc>
2305	Returns an object describing the specified guest OS type.
2306
2307	The requested guest OS type is specified using a string which is a
2308	mnemonic identifier of the guest operating system, such as
2309	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2310	particular virtual machine can be read or set using the
2311	<link to="IMachine::OSTypeId"/> attribute.
2312
2313	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2314	available guest OS type objects. Each object has an
2315	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2316	the guest OS this object describes.
2317
2318	<result name="E_INVALIDARG">
2319	@a id is not a valid Guest OS type.
2320	</result>
2321
2322	</desc>
2323	<param name="id" type="uuid" mod="string" dir="in">
2324	<desc>Guest OS type ID string.</desc>
2325	</param>
2326	<param name="type" type="IGuestOSType" dir="return">
2327	<desc>Guest OS type object.</desc>
2328	</param>
2329	</method>
2330
2331	<method name="createSharedFolder">
2332	<desc>
2333	Creates a new global shared folder by associating the given logical
2334	name with the given host path, adds it to the collection of shared
2335	folders and starts sharing it. Refer to the description of
2336	<link to="ISharedFolder"/> to read more about logical names.
2337	<note>
2338	In the current implementation, this operation is not
2339	implemented.
2340	</note>
2341	</desc>
2342	<param name="name" type="wstring" dir="in">
2343	<desc>Unique logical name of the shared folder.</desc>
2344	</param>
2345	<param name="hostPath" type="wstring" dir="in">
2346	<desc>Full path to the shared folder in the host file system.</desc>
2347	</param>
2348	<param name="writable" type="boolean" dir="in">
2349	<desc>Whether the share is writable or readonly</desc>
2350	</param>
2351	</method>
2352
2353	<method name="removeSharedFolder">
2354	<desc>
2355	Removes the global shared folder with the given name previously
2356	created by <link to="#createSharedFolder"/> from the collection of
2357	shared folders and stops sharing it.
2358	<note>
2359	In the current implementation, this operation is not
2360	implemented.
2361	</note>
2362	</desc>
2363	<param name="name" type="wstring" dir="in">
2364	<desc>Logical name of the shared folder to remove.</desc>
2365	</param>
2366	</method>
2367
2368	<method name="getExtraDataKeys">
2369	<desc>
2370	Returns an array representing the global extra data keys which currently
2371	have values defined.
2372	</desc>
2373	<param name="value" type="wstring" dir="return" safearray="yes">
2374	<desc>Array of extra data keys.</desc>
2375	</param>
2376	</method>
2377
2378	<method name="getExtraData">
2379	<desc>
2380	Returns associated global extra data.
2381
2382	If the requested data @a key does not exist, this function will
2383	succeed and return an empty string in the @a value argument.
2384
2385	<result name="VBOX_E_FILE_ERROR">
2386	Settings file not accessible.
2387	</result>
2388	<result name="VBOX_E_XML_ERROR">
2389	Could not parse the settings file.
2390	</result>
2391
2392	</desc>
2393	<param name="key" type="wstring" dir="in">
2394	<desc>Name of the data key to get.</desc>
2395	</param>
2396	<param name="value" type="wstring" dir="return">
2397	<desc>Value of the requested data key.</desc>
2398	</param>
2399	</method>
2400
2401	<method name="setExtraData">
2402	<desc>
2403	Sets associated global extra data.
2404
2405	If you pass @c null or empty string as a key @a value, the given @a key
2406	will be deleted.
2407
2408	<note>
2409	Before performing the actual data change, this method will ask all
2410	registered callbacks using the
2411	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
2412	notification for a permission. If one of the callbacks refuses the
2413	new value, the change will not be performed.
2414	</note>
2415	<note>
2416	On success, the
2417	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
2418	is called to inform all registered callbacks about a successful data
2419	change.
2420	</note>
2421
2422	<result name="VBOX_E_FILE_ERROR">
2423	Settings file not accessible.
2424	</result>
2425	<result name="VBOX_E_XML_ERROR">
2426	Could not parse the settings file.
2427	</result>
2428	<result name="E_ACCESSDENIED">
2429	Modification request refused.
2430	</result>
2431
2432	</desc>
2433	<param name="key" type="wstring" dir="in">
2434	<desc>Name of the data key to set.</desc>
2435	</param>
2436	<param name="value" type="wstring" dir="in">
2437	<desc>Value to assign to the key.</desc>
2438	</param>
2439	</method>
2440
2441	<method name="openSession">
2442	<desc>
2443	Opens a new direct session with the given virtual machine.
2444
2445	A direct session acts as a local lock on the given VM.
2446	There can be only one direct session open at a time for every
2447	virtual machine, protecting the VM from being manipulated by
2448	conflicting actions from different processes. Only after a
2449	direct session has been opened, one can change all VM settings
2450	and execute the VM in the process space of the session object.
2451
2452	Sessions therefore can be compared to mutex semaphores that
2453	lock a given VM for modification and execution.
2454	See <link to="ISession">ISession</link> for details.
2455
2456	<note>Unless you are writing a new VM frontend, you will not
2457	want to execute a VM in the current process. To spawn a new
2458	process that executes a VM, use
2459	<link to="IVirtualBox::openRemoteSession" />
2460	instead.</note>
2461
2462	Upon successful return, the session object can be used to
2463	get access to the machine and to the VM console.
2464
2465	In VirtualBox terminology, the machine becomes "mutable" after
2466	a session has been opened. Note that the "mutable" machine
2467	object, on which you may invoke IMachine methods to change its
2468	settings, will be a different object from the immutable IMachine
2469	objects returned by various IVirtualBox methods. To obtain a
2470	mutable IMachine object (upon which you can invoke settings methods),
2471	use the <link to="ISession::machine" /> attribute.
2472
2473	One must always call <link to="ISession::close" /> to release the
2474	lock on the machine, or the machine's state will eventually be
2475	set to "Aborted".
2476
2477	In other words, to change settings on a machine, the following
2478	sequence is typically performed:
2479
2480	<ol>
2481	<li>Call this method (openSession) to have a machine locked for
2482	the current session.</li>
2483
2484	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
2485
2486	<li>Change the settings of the machine.</li>
2487
2488	<li>Call <link to="IMachine::saveSettings" />.</li>
2489
2490	<li>Close the session by calling <link to="ISession::close"/>.</li>
2491	</ol>
2492
2493	<result name="E_UNEXPECTED">
2494	Virtual machine not registered.
2495	</result>
2496	<result name="E_ACCESSDENIED">
2497	Process not started by OpenRemoteSession.
2498	</result>
2499	<result name="VBOX_E_OBJECT_NOT_FOUND">
2500	No matching virtual machine found.
2501	</result>
2502	<result name="VBOX_E_INVALID_OBJECT_STATE">
2503	Session already open or being opened.
2504	</result>
2505	<result name="VBOX_E_VM_ERROR">
2506	Failed to assign machine to session.
2507	</result>
2508
2509	</desc>
2510	<param name="session" type="ISession" dir="in">
2511	<desc>
2512	Session object that will represent the opened session after
2513	successful method invocation. This object must not represent
2514	the already open session.
2515	<note>
2516	This session will be automatically closed if the
2517	VirtualBox server is terminated for some reason.
2518	</note>
2519	</desc>
2520	</param>
2521	<param name="machineId" type="uuid" mod="string" dir="in">
2522	<desc>ID of the virtual machine to open a session with.</desc>
2523	</param>
2524	</method>
2525
2526	<method name="openRemoteSession">
2527	<desc>
2528	Spawns a new process that executes a virtual machine (called a
2529	"remote session").
2530
2531	Opening a remote session causes the VirtualBox server to start a new
2532	process that opens a direct session with the given VM. As a result, the
2533	VM is locked by that direct session in the new process, preventing
2534	conflicting changes from other processes. Since sessions act as locks
2535	that prevent conflicting changes, one cannot open a remote session
2536	for a VM that already has another open session (direct or remote), or
2537	is currently in the process of opening one (see <link
2538	to="IMachine::sessionState"/>).
2539
2540	While the remote session still provides some level of control over the
2541	VM execution to the caller (using the <link to="IConsole" /> interface),
2542	not all VM settings are available for modification within the remote
2543	session context.
2544
2545	This operation can take some time (a new VM is started in a new process,
2546	for which memory and other resources need to be set up). Because of this,
2547	an <link to="IProgress" /> is returned to allow the caller to wait for this
2548	asynchronous operation to be completed. Until then, the remote session
2549	object remains in the closed state, and accessing the machine or its
2550	console through it is invalid. It is recommended to use
2551	<link to="IProgress::waitForCompletion" /> or similar calls to wait for
2552	completion.
2553
2554	As with all <link to="ISession" /> objects, it is recommended to call
2555	<link to="ISession::close" /> on the local session object once openRemoteSession()
2556	has been called. However, the session's state (see <link to="ISession::state" />)
2557	will not return to "Closed" until the remote session has also closed (i.e.
2558	until the VM is no longer running). In that case, however, the state of
2559	the session will automatically change back to "Closed".
2560
2561	Currently supported session types (values of the @a type
2562	argument) are:
2563	<ul>
2564	<li><tt>"gui"</tt>: VirtualBox Qt GUI session</li>
2565	<li><tt>"vrdp"</tt>: VirtualBox VRDP Server session</li>
2566	<li><tt>"sdl"</tt>: VirtualBox SDL GUI session</li>
2567	</ul>
2568
2569	The @a environment argument is a string containing definitions of
2570	environment variables in the following format:
2571	@code
2572	NAME[=VALUE]\n
2573	NAME[=VALUE]\n
2574	...
2575	@endcode
2576	where <tt>\\n</tt> is the new line character. These environment
2577	variables will be appended to the environment of the VirtualBox server
2578	process. If an environment variable exists both in the server process
2579	and in this list, the value from this list takes precedence over the
2580	server's variable. If the value of the environment variable is
2581	omitted, this variable will be removed from the resulting environment.
2582	If the environment string is @c null or empty, the server environment
2583	is inherited by the started process as is.
2584
2585	<see>openExistingSession</see>
2586
2587	<result name="E_UNEXPECTED">
2588	Virtual machine not registered.
2589	</result>
2590	<result name="E_INVALIDARG">
2591	Invalid session type @a type.
2592	</result>
2593	<result name="VBOX_E_OBJECT_NOT_FOUND">
2594	No machine matching @a machineId found.
2595	</result>
2596	<result name="VBOX_E_INVALID_OBJECT_STATE">
2597	Session already open or being opened.
2598	</result>
2599	<result name="VBOX_E_IPRT_ERROR">
2600	Launching process for machine failed.
2601	</result>
2602	<result name="VBOX_E_VM_ERROR">
2603	Failed to assign machine to session.
2604	</result>
2605
2606	</desc>
2607	<param name="session" type="ISession" dir="in">
2608	<desc>
2609	Session object that will represent the opened remote session
2610	after successful method invocation (this object must not
2611	represent an already open session).
2612	</desc>
2613	</param>
2614	<param name="machineId" type="uuid" mod="string" dir="in">
2615	<desc>ID of the virtual machine to open a session with.</desc>
2616	</param>
2617	<param name="type" type="wstring" dir="in">
2618	<desc>
2619	Type of the remote session (case sensitive).
2620	</desc>
2621	</param>
2622	<param name="environment" type="wstring" dir="in">
2623	<desc>
2624	Environment to pass to the opened session.
2625	</desc>
2626	</param>
2627	<param name="progress" type="IProgress" dir="return">
2628	<desc>Progress object to track the operation completion.</desc>
2629	</param>
2630	</method>
2631
2632	<method name="openExistingSession">
2633	<desc>
2634	Opens a new remote session with the virtual machine for
2635	which a direct session is already open.
2636
2637	The remote session provides some level of control over the VM
2638	execution (using the IConsole interface) to the caller; however,
2639	within the remote session context, not all VM settings are available
2640	for modification.
2641
2642	As opposed to <link to="#openRemoteSession"/>, the number of
2643	remote sessions opened this way is not limited by the API
2644
2645	<note>
2646	It is an error to open a remote session with the machine that
2647	doesn't have an open direct session.
2648	</note>
2649
2650	<result name="E_UNEXPECTED">
2651	Virtual machine not registered.
2652	</result>
2653	<result name="VBOX_E_OBJECT_NOT_FOUND">
2654	No machine matching @a machineId found.
2655	</result>
2656	<result name="VBOX_E_INVALID_OBJECT_STATE">
2657	Session already open or being opened.
2658	</result>
2659	<result name="VBOX_E_INVALID_SESSION_STATE">
2660	Direct session state not Open.
2661	</result>
2662	<result name="VBOX_E_VM_ERROR">
2663	Failed to get console object from direct session or assign
2664	machine to session.
2665	</result>
2666
2667	<see>openRemoteSession</see>
2668	</desc>
2669	<param name="session" type="ISession" dir="in">
2670	<desc>
2671	Session object that will represent the open remote session
2672	after successful method invocation. This object must not
2673	represent an already open session.
2674	<note>
2675	This session will be automatically closed when the peer
2676	(direct) session dies or gets closed.
2677	</note>
2678	</desc>
2679	</param>
2680	<param name="machineId" type="uuid" mod="string" dir="in">
2681	<desc>ID of the virtual machine to open a session with.</desc>
2682	</param>
2683	</method>
2684
2685	<method name="registerCallback">
2686	<desc>
2687	Registers a new global VirtualBox callback. The methods of the given
2688	callback object will be called by VirtualBox when an appropriate
2689	event occurs.
2690
2691	<result name="E_INVALIDARG">
2692	A @c null callback cannot be registered.
2693	</result>
2694
2695	</desc>
2696	<param name="callback" type="IVirtualBoxCallback" dir="in">
2697	<desc>Callback object to register.</desc>
2698	</param>
2699	</method>
2700
2701	<method name="unregisterCallback">
2702	<desc>
2703	Unregisters the previously registered global VirtualBox callback.
2704
2705	<result name="E_INVALIDARG">
2706	Specified @a callback not registered.
2707	</result>
2708
2709	</desc>
2710	<param name="callback" type="IVirtualBoxCallback" dir="in">
2711	<desc>Callback object to unregister.</desc>
2712	</param>
2713	</method>
2714
2715	<method name="waitForPropertyChange">
2716	<desc>
2717	Blocks the caller until any of the properties represented by the
2718	@a what argument changes the value or until the given timeout interval
2719	expires.
2720
2721	The @a what argument is a comma separated list of property masks that
2722	describe properties the caller is interested in. The property mask is
2723	a string in the following format:
2724
2725	<pre>
2726	[[group.]subgroup.]name
2727	</pre>
2728
2729	where @c name is the property name and @c group, @c subgroup are zero
2730	or more property group specifiers. Each element (group or name) in
2731	the property mask may be either a Latin string or an asterisk symbol
2732	(@c "*") which is used to match any string for the given element. A
2733	property mask that doesn't contain asterisk symbols represents a
2734	single fully qualified property name.
2735
2736	Groups in the fully qualified property name go from more generic (the
2737	left-most part) to more specific (the right-most part). The first
2738	element is usually a name of the object the property belongs to. The
2739	second element may be either a property name, or a child object name,
2740	or an index if the preceding element names an object which is one of
2741	many objects of the same type. This way, property names form a
2742	hierarchy of properties. Here are some examples of property names:
2743
2744	<table>
2745	<tr>
2746	<td><tt>VirtualBox.version</tt></td>
2747	<td><link to="IVirtualBox::version"/> property</td>
2748	</tr>
2749	<tr>
2750	<td><tt>Machine.<UUID>.name</tt></td>
2751	<td><link to="IMachine::name"/> property of the machine with the
2752	given UUID</td>
2753	</tr>
2754	</table>
2755
2756	Most property names directly correspond to the properties of objects
2757	(components) provided by the VirtualBox library and may be used to
2758	track changes to these properties. However, there may be
2759	pseudo-property names that don't correspond to any existing object's
2760	property directly, as well as there may be object properties that
2761	don't have a corresponding property name that is understood by this
2762	method, and therefore changes to such properties cannot be
2763	tracked. See individual object's property descriptions to get a
2764	fully qualified property name that can be used with this method (if
2765	any).
2766
2767	There is a special property mask @c "*" (i.e. a string consisting of a
2768	single asterisk symbol) that can be used to match all properties.
2769	Below are more examples of property masks:
2770
2771	<table>
2772	<tr>
2773	<td><tt>VirtualBox.*</tt></td>
2774	<td>Track all properties of the VirtualBox object</td>
2775	</tr>
2776	<tr>
2777	<td><tt>Machine.*.name</tt></td>
2778	<td>Track changes to the <link to="IMachine::name"/> property of
2779	all registered virtual machines</td>
2780	</tr>
2781	</table>
2782
2783	<note>
2784	This function is not implemented in the current version of the
2785	product.
2786	</note>
2787	</desc>
2788	<param name="what" type="wstring" dir="in">
2789	<desc>Comma separated list of property masks.</desc>
2790	</param>
2791	<param name="timeout" type="unsigned long" dir="in">
2792	<desc>
2793	Wait timeout in milliseconds.
2794	Specify -1 for an indefinite wait.
2795	</desc>
2796	</param>
2797	<param name="changed" type="wstring" dir="out">
2798	<desc>
2799	Comma separated list of properties that have been changed and caused
2800	this method to return to the caller.
2801	</desc>
2802	</param>
2803	<param name="values" type="wstring" dir="out">
2804	<desc>Reserved, not currently used.</desc>
2805	</param>
2806	</method>
2807
2808	<!--method name="createDHCPServerForInterface">
2809	<desc>
2810	Creates a dhcp server settings to be used for the given interface
2811	<result name="E_INVALIDARG">
2812	Host network interface @a name already exists.
2813	</result>
2814	</desc>
2815	<param name="interface" type="IHostNetworkInterface" dir="in">
2816	<desc>Network Interface</desc>
2817	</param>
2818	<param name="server" type="IDHCPServer" dir="out">
2819	<desc>Dhcp server settings</desc>
2820	</param>
2821	</method-->
2822
2823	<method name="createDHCPServer">
2824	<desc>
2825	Creates a dhcp server settings to be used for the given internal network name
2826	<result name="E_INVALIDARG">
2827	Host network interface @a name already exists.
2828	</result>
2829	</desc>
2830	<param name="name" type="wstring" dir="in">
2831	<desc>server name</desc>
2832	</param>
2833	<param name="server" type="IDHCPServer" dir="return">
2834	<desc>Dhcp server settings</desc>
2835	</param>
2836	</method>
2837
2838	<method name="findDHCPServerByNetworkName">
2839	<desc>
2840	Searches a dhcp server settings to be used for the given internal network name
2841	<result name="E_INVALIDARG">
2842	Host network interface @a name already exists.
2843	</result>
2844
2845	</desc>
2846	<param name="name" type="wstring" dir="in">
2847	<desc>server name</desc>
2848	</param>
2849	<param name="server" type="IDHCPServer" dir="return">
2850	<desc>Dhcp server settings</desc>
2851	</param>
2852	</method>
2853
2854	<!--method name="findDHCPServerForInterface">
2855	<desc>
2856	Searches a dhcp server settings to be used for the given interface
2857	<result name="E_INVALIDARG">
2858	Host network interface @a name already exists.
2859	</result>
2860	</desc>
2861	<param name="interface" type="IHostNetworkInterface" dir="in">
2862	<desc>Network Interface</desc>
2863	</param>
2864	<param name="server" type="IDHCPServer" dir="out">
2865	<desc>Dhcp server settings</desc>
2866	</param>
2867	</method-->
2868
2869	<method name="removeDHCPServer">
2870	<desc>
2871	Removes the dhcp server settings
2872	<result name="E_INVALIDARG">
2873	Host network interface @a name already exists.
2874	</result>
2875	</desc>
2876	<param name="server" type="IDHCPServer" dir="in">
2877	<desc>Dhcp server settings to be removed</desc>
2878	</param>
2879	</method>
2880
2881	</interface>
2882
2883	<!--
2884	// IVFSExplorer
2885	/////////////////////////////////////////////////////////////////////////
2886	-->
2887
2888	<enum
2889	name="VFSType"
2890	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2891	>
2892	<desc>
2893	Virtual file systems supported by VFSExplorer.
2894	</desc>
2895
2896	<const name="File" value="1" />
2897	<const name="Cloud" value="2" />
2898	<const name="S3" value="3" />
2899	<const name="WebDav" value="4" />
2900	</enum>
2901
2902	<enum
2903	name="VFSFileType"
2904	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2905	>
2906	<desc>
2907	File types known by VFSExplorer.
2908	</desc>
2909
2910	<const name="Unknown" value="1" />
2911	<const name="Fifo" value="2" />
2912	<const name="DevChar" value="3" />
2913	<const name="Directory" value="4" />
2914	<const name="DevBlock" value="5" />
2915	<const name="File" value="6" />
2916	<const name="SymLink" value="7" />
2917	<const name="Socket" value="8" />
2918	<const name="WhiteOut" value="9" />
2919	</enum>
2920
2921	<interface
2922	name="IVFSExplorer" extends="$unknown"
2923	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2924	wsmap="managed"
2925	>
2926	<desc>
2927	The VFSExplorer interface unifies access to different file system
2928	types. This includes local file systems as well remote file systems like
2929	S3. For a list of supported types see <link to="VFSType" />.
2930	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2931	</desc>
2932
2933	<attribute name="path" type="wstring" readonly="yes">
2934	<desc>Returns the current path in the virtual file system.</desc>
2935	</attribute>
2936
2937	<attribute name="type" type="VFSType" readonly="yes">
2938	<desc>Returns the file system type which is currently in use.</desc>
2939	</attribute>
2940
2941	<method name="update">
2942	<desc>Updates the internal list of files/directories from the
2943	current directory level. Use <link to="#entryList" /> to get the full list
2944	after a call to this method.</desc>
2945
2946	<param name="aProgress" type="IProgress" dir="return">
2947	<desc>Progress object to track the operation completion.</desc>
2948	</param>
2949	</method>
2950
2951	<method name="cd">
2952	<desc>Change the current directory level.</desc>
2953
2954	<param name="aDir" type="wstring" dir="in">
2955	<desc>The name of the directory to go in.</desc>
2956	</param>
2957
2958	<param name="aProgress" type="IProgress" dir="return">
2959	<desc>Progress object to track the operation completion.</desc>
2960	</param>
2961	</method>
2962
2963	<method name="cdUp">
2964	<desc>Go one directory upwards from the current directory level.</desc>
2965
2966	<param name="aProgress" type="IProgress" dir="return">
2967	<desc>Progress object to track the operation completion.</desc>
2968	</param>
2969	</method>
2970
2971	<method name="entryList">
2972	<desc>Returns a list of files/directories after a call to <link
2973	to="#update" />. The user is responsible for keeping this internal
2974	list up do date.</desc>
2975
2976	<param name="aNames" type="wstring" safearray="yes" dir="out">
2977	<desc>The list of names for the entries.</desc>
2978	</param>
2979
2980	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2981	<desc>The list of types for the entries.</desc>
2982	</param>
2983	</method>
2984
2985	<method name="exists">
2986	<desc>Checks if the given file list exists in the current directory
2987	level.</desc>
2988
2989	<param name="aNames" type="wstring" safearray="yes" dir="in">
2990	<desc>The names to check.</desc>
2991	</param>
2992
2993	<param name="aExists" type="wstring" safearray="yes" dir="return">
2994	<desc>The names which exist.</desc>
2995	</param>
2996	</method>
2997
2998	<method name="remove">
2999	<desc>Deletes the given files in the current directory level.</desc>
3000
3001	<param name="aNames" type="wstring" safearray="yes" dir="in">
3002	<desc>The names to remove.</desc>
3003	</param>
3004
3005	<param name="aProgress" type="IProgress" dir="return">
3006	<desc>Progress object to track the operation completion.</desc>
3007	</param>
3008	</method>
3009
3010	</interface>
3011
3012	<!--
3013	// IAppliance
3014	/////////////////////////////////////////////////////////////////////////
3015	-->
3016
3017	<interface
3018	name="IAppliance" extends="$unknown"
3019	uuid="e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
3020	wsmap="managed"
3021	>
3022	<desc>
3023	Represents a platform-independent appliance in OVF format. An instance of this is returned
3024	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
3025	appliances with VirtualBox.
3026
3027	The OVF standard suggests two different physical file formats:
3028
3029	<ol>
3030	<li>If the OVF is distributed as a set of files, then @a file must be a fully qualified
3031	path name to an existing OVF descriptor file with an <tt>.ovf</tt> file extension. If
3032	this descriptor file references other files, as OVF appliances distributed as a set of
3033	files most likely do, those files must be in the same directory as the descriptor file.</li>
3034
3035	<li>If the OVF is distributed as a single file, it must be in TAR format and have the
3036	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
3037	files and optionally other files.
3038
3039	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
3040	be added with a later version.</li>
3041	</ol>
3042
3043	<b>Importing</b> an OVF appliance into VirtualBox as instances of
3044	<link to="IMachine" /> involves the following sequence of API calls:
3045
3046	<ol>
3047	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
3048	</li>
3049
3050	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
3051	would like to import. So long as this file is syntactically valid, this will succeed
3052	and return an instance of IAppliance that contains the parsed data from the OVF file.
3053	</li>
3054
3055	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
3056	contents of the IAppliance attributes accordingly. These can be inspected by a
3057	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
3058	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
3059	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
3060	systems in the OVF, which in turn describe the virtual hardware prescribed by the
3061	OVF (network and hardware adapters, virtual disk images, memory size and so on).
3062	The GUI can then give the user the option to confirm and/or change these suggestions.
3063	</li>
3064
3065	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3066	virtual system to override the suggestions made by the interpret() routine.
3067	</li>
3068
3069	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
3070	VirtualBox as instances of <link to="IMachine" /> that match the information in the
3071	virtual system descriptions.
3072	</li>
3073	</ol>
3074
3075	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
3076
3077	<ol>
3078	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
3079	an empty IAppliance object.
3080	</li>
3081
3082	<li>For each machine you would like to export, call <link to="IMachine::export" />
3083	with the IAppliance object you just created. This creates an instance of
3084	<link to="IVirtualSystemDescription" /> inside the appliance.
3085	</li>
3086
3087	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
3088	virtual system to override the suggestions made by the export() routine.
3089	</li>
3090
3091	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
3092	file written.</li>
3093	</ol>
3094
3095	</desc>
3096
3097	<attribute name="path" type="wstring" readonly="yes">
3098	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
3099	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
3100	<link to="#write" /> (for export).
3101	This attribute is empty until one of these methods has been called.
3102	</desc>
3103	</attribute>
3104
3105	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
3106	<desc>
3107	Array of virtual disk definitions. One such description exists for each
3108	disk definition in the OVF; each string array item represents one such piece of
3109	disk information, with the information fields separated by tab (\\t) characters.
3110
3111	The caller should be prepared for additional fields being appended to
3112	this string in future versions of VirtualBox and therefore check for
3113	the number of tabs in the strings returned.
3114
3115	In the current version, the following eight fields are returned per string
3116	in the array:
3117
3118	<ol>
3119	<li>Disk ID (unique string identifier given to disk)</li>
3120
3121	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
3122
3123	<li>Populated size (optional unsigned integer indicating the current size of the
3124	disk; can be approximate; -1 if unspecified)</li>
3125
3126	<li>Format (string identifying the disk format, typically
3127	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
3128
3129	<li>Reference (where to find the disk image, typically a file name; if empty,
3130	then the disk should be created on import)</li>
3131
3132	<li>Image size (optional unsigned integer indicating the size of the image,
3133	which need not necessarily be the same as the values specified above, since
3134	the image may be compressed or sparse; -1 if not specified)</li>
3135
3136	<li>Chunk size (optional unsigned integer if the image is split into chunks;
3137	presently unsupported and always -1)</li>
3138
3139	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
3140	</ol>
3141	</desc>
3142	</attribute>
3143
3144	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
3145	<desc> Array of virtual system descriptions. One such description is created
3146	for each virtual system found in the OVF.
3147	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
3148	(for export) has been called.
3149	</desc>
3150	</attribute>
3151
3152	<method name="read">
3153	<desc>
3154	Reads an OVF file into the appliance object.
3155
3156	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
3157	mere fact that this method returns successfully does not mean that VirtualBox supports all
3158	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
3159	</desc>
3160	<param name="file" type="wstring" dir="in">
3161	<desc>
3162	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3163	on whether the appliance is distributed as a set of files or as a single file, respectively).
3164	</desc>
3165	</param>
3166	<param name="aProgress" type="IProgress" dir="return">
3167	<desc></desc>
3168	</param>
3169	</method>
3170
3171	<method name="interpret">
3172	<desc>
3173	Interprets the OVF data that was read when the appliance was constructed. After
3174	calling this method, one can inspect the
3175	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
3176	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
3177	the appliance.
3178
3179	Calling this method is the second step of importing an appliance into VirtualBox;
3180	see <link to="IAppliance" /> for an overview.
3181
3182	After calling this method, one should call <link to="#getWarnings" /> to find out
3183	if problems were encountered during the processing which might later lead to
3184	errors.
3185	</desc>
3186	</method>
3187
3188	<method name="importMachines">
3189	<desc>
3190	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
3191	and other interfaces that match the information contained in the appliance as
3192	closely as possible, as represented by the import instructions in the
3193	<link to="#virtualSystemDescriptions" /> array.
3194
3195	Calling this method is the final step of importing an appliance into VirtualBox;
3196	see <link to="IAppliance" /> for an overview.
3197
3198	Since importing the appliance will most probably involve copying and converting
3199	disk images, which can take a long time, this method operates asynchronously and
3200	returns an IProgress object to allow the caller to monitor the progress.
3201	</desc>
3202
3203	<param name="aProgress" type="IProgress" dir="return">
3204	<desc></desc>
3205	</param>
3206	</method>
3207
3208	<method name="createVFSExplorer">
3209	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
3210
3211	<param name="aUri" type="wstring" dir="in">
3212	<desc>The URI describing the file system to use.</desc>
3213	</param>
3214
3215	<param name="aExplorer" type="IVFSExplorer" dir="return">
3216	<desc></desc>
3217	</param>
3218	</method>
3219
3220	<method name="write">
3221	<desc>
3222	Writes the contents of the appliance exports into a new OVF file.
3223
3224	Calling this method is the final step of exporting an appliance from VirtualBox;
3225	see <link to="IAppliance" /> for an overview.
3226
3227	Since exporting the appliance will most probably involve copying and converting
3228	disk images, which can take a long time, this method operates asynchronously and
3229	returns an IProgress object to allow the caller to monitor the progress.
3230	</desc>
3231	<param name="format" type="wstring" dir="in">
3232	<desc>
3233	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
3234	future versions of VirtualBox may support additional formats.
3235	</desc>
3236	</param>
3237	<param name="path" type="wstring" dir="in">
3238	<desc>
3239	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
3240	on whether the appliance is distributed as a set of files or as a single file, respectively).
3241	</desc>
3242	</param>
3243	<param name="aProgress" type="IProgress" dir="return">
3244	<desc>Progress object to track the operation completion.</desc>
3245	</param>
3246	</method>
3247
3248	<method name="getWarnings">
3249	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
3250
3251	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
3252	<desc></desc>
3253	</param>
3254	</method>
3255
3256	</interface>
3257
3258	<enum
3259	name="VirtualSystemDescriptionType"
3260	uuid="aacc58de-5b45-4f82-ae2e-dd9a824fc3b5"
3261	>
3262	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
3263	a configuration value.</desc>
3264
3265	<const name="Ignore" value="1" />
3266	<const name="OS" value="2" />
3267	<const name="Name" value="3" />
3268	<const name="Product" value="4" />
3269	<const name="Vendor" value="5" />
3270	<const name="Version" value="6" />
3271	<const name="ProductUrl" value="7" />
3272	<const name="VendorUrl" value="8" />
3273	<const name="Description" value="9" />
3274	<const name="License" value="10" />
3275	<const name="Miscellaneous" value="11" />
3276	<const name="CPU" value="12" />
3277	<const name="Memory" value="13" />
3278	<const name="HardDiskControllerIDE" value="14" />
3279	<const name="HardDiskControllerSATA" value="15" />
3280	<const name="HardDiskControllerSCSI" value="16" />
3281	<const name="HardDiskImage" value="17" />
3282	<const name="Floppy" value="18" />
3283	<const name="CDROM" value="19" />
3284	<const name="NetworkAdapter" value="20" />
3285	<const name="USBController" value="21" />
3286	<const name="SoundCard" value="22" />
3287
3288	</enum>
3289
3290	<enum
3291	name="VirtualSystemDescriptionValueType"
3292	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
3293	>
3294	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
3295	type to fetch.</desc>
3296
3297	<const name="Reference" value="1" />
3298	<const name="Original" value="2" />
3299	<const name="Auto" value="3" />
3300	<const name="ExtraConfig" value="4" />
3301
3302	</enum>
3303
3304	<interface
3305	name="IVirtualSystemDescription" extends="$unknown"
3306	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
3307	wsmap="managed"
3308	>
3309
3310	<desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
3311	After <link to="IAppliance::interpret" /> has been called, that array contains
3312	information about how the virtual systems described in the OVF should best be imported into VirtualBox
3313	virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
3314	into VirtualBox.
3315	</desc>
3316
3317	<attribute name="count" type="unsigned long" readonly="yes">
3318	<desc>Return the number of virtual system description entries.</desc>
3319	</attribute>
3320
3321	<method name="getDescription">
3322	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
3323	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
3324
3325	The list below identifies the value sets that are possible depending on the
3326	<link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
3327	the array item with the same index in aOvfValues[] will contain the original value as contained
3328	in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[]
3329	will contain a suggested value to be used for VirtualBox. Depending on the description type,
3330	the aExtraConfigValues[] array item may also be used.
3331
3332	<ul>
3333	<li>
3334	"OS": the guest operating system type. There must be exactly one such array item on import. The
3335	corresponding item in aVBoxValues[] contains the suggested guest operating system for VirtualBox.
3336	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
3337	item in aOvfValues[] will contain a numerical value that described the operating system in the OVF.
3338	</li>
3339	<li>
3340	"Name": the name to give to the new virtual machine. There can be at most one such array item;
3341	if none is present on import, then an automatic name will be created from the operating system
3342	type. The correponding item im aOvfValues[] will contain the suggested virtual machine name
3343	from the OVF file, and aVBoxValues[] will contain a suggestion for a unique VirtualBox
3344	<link to="IMachine" /> name that does not exist yet.
3345	</li>
3346	<li>
3347	"Description": an arbitrary description.
3348	</li>
3349	<li>
3350	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3351	code to display such a license for agreement; the Main API does not enforce any such policy.
3352	</li>
3353	<li>
3354	Miscellaneous: reserved for future use.
3355	</li>
3356	<li>
3357	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3358	</li>
3359	<li>
3360	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3361	is present on import, then VirtualBox will set a meaningful default based on the operating system
3362	type.
3363	</li>
3364	<li>
3365	"HarddiskControllerIDE": an IDE hard disk controller. There can be at most one such item. This
3366	has no value in aOvfValues[] or aVBoxValues[].
3367	The matching item in the aRefs[] array will contain an integer that items of the "Harddisk"
3368	type can use to specify which hard disk controller a virtual disk should be connected to.
3369	</li>
3370	<li>
3371	"HarddiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3372	has no value in aOvfValues[] or aVBoxValues[].
3373	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3374	</li>
3375	<li>
3376	"HarddiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3377	The items in aOvfValues[] and aVBoxValues[] will either be "LsiLogic" or "BusLogic".
3378	The matching item in the aRefs[] array will be used as with IDE controllers (see above).
3379	</li>
3380	<li>
3381	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3382	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3383
3384	The array item in aOvfValues[] will contain the file specification from the OVF file (without
3385	a path since the image file should be in the same location as the OVF file itself), whereas the
3386	item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3387	hard disk image. This means that on import the image will be copied and converted from the
3388	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3389	On import, the target image will also be registered with VirtualBox.
3390
3391	The matching item in the aExtraConfigValues[] array must contain a string of the following
3392	format: "controller=<index>;channel=<c>"
3393	In this string, <index> must be an integer specifying the hard disk controller to connect
3394	the image to. That number must be the index of an array item with one of the hard disk controller
3395	types (HarddiskControllerSCSI, HarddiskControllerSATA, HarddiskControllerIDE).
3396	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3397	this can range from 0-3 (which VirtualBox will interpret as primary master, primary slave, secondary master and
3398	secondary slave. For SATA and SCSI controllers, the channel can range from 0-29.
3399	</li>
3400	<li>
3401	"NetworkAdapter": a network adapter. The array item in aVBoxValues[] will specify the hardware
3402	for the network adapter, whereas the array item in aExtraConfigValues[] will have a string
3403	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3404	</li>
3405	<li>
3406	"USBController": a USB controller. There can be at most one such item. If and only if such an
3407	item ispresent, USB support will be enabled for the new virtual machine.
3408	</li>
3409	<li>
3410	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3411	present, sound support will be enabled for the new virtual machine. Note that the virtual
3412	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3413	may be different from the virtual soundcard expected by the appliance.
3414	</li>
3415	</ul>
3416
3417	</desc>
3418
3419	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3420	<desc></desc>
3421	</param>
3422
3423	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3424	<desc></desc>
3425	</param>
3426
3427	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3428	<desc></desc>
3429	</param>
3430
3431	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3432	<desc></desc>
3433	</param>
3434
3435	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3436	<desc></desc>
3437	</param>
3438
3439	</method>
3440
3441	<method name="getDescriptionByType">
3442	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3443	should be returned.</desc>
3444
3445	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3446	<desc></desc>
3447	</param>
3448
3449	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3450	<desc></desc>
3451	</param>
3452
3453	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3454	<desc></desc>
3455	</param>
3456
3457	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3458	<desc></desc>
3459	</param>
3460
3461	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3462	<desc></desc>
3463	</param>
3464
3465	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3466	<desc></desc>
3467	</param>
3468
3469	</method>
3470
3471	<method name="getValuesByType">
3472	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3473	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3474	values.</desc>
3475
3476	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3477	<desc></desc>
3478	</param>
3479
3480	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3481	<desc></desc>
3482	</param>
3483
3484	<param name="aValues" type="wstring" dir="return" safearray="yes">
3485	<desc></desc>
3486	</param>
3487
3488	</method>
3489
3490	<method name="setFinalValues">
3491	<desc>
3492	This method allows the appliance's user to change the configuration for the virtual
3493	system descriptions. For each array item returned from <link to="#getDescription" />,
3494	you must pass in one boolean value and one configuration value.
3495
3496	Each item in the boolean array determines whether the particular configuration item
3497	should be enabled.
3498	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3499	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3500	and SoundCard.
3501
3502	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3503	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3504	the configuration remains unchanged. Please see the documentation for getDescription()
3505	for valid configuration values for the individual array item types. If the
3506	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3507	</desc>
3508
3509	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3510	<desc></desc>
3511	</param>
3512
3513	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3514	<desc></desc>
3515	</param>
3516
3517	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3518	<desc></desc>
3519	</param>
3520	</method>
3521
3522	<method name="addDescription">
3523	<desc>
3524	This method adds an additional description entry to the stack of already
3525	available descriptions for this virtual system. This is handy for writing
3526	values which aren't directly supported by VirtualBox. One example would
3527	be the License type of <link to="VirtualSystemDescriptionType" />.
3528	</desc>
3529
3530	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3531	<desc></desc>
3532	</param>
3533
3534	<param name="aVBoxValue" type="wstring" dir="in">
3535	<desc></desc>
3536	</param>
3537
3538	<param name="aExtraConfigValue" type="wstring" dir="in">
3539	<desc></desc>
3540	</param>
3541	</method>
3542	</interface>
3543
3544
3545	<!--
3546	// IMachine
3547	/////////////////////////////////////////////////////////////////////////
3548	-->
3549
3550	<interface
3551	name="IInternalMachineControl" extends="$unknown"
3552	uuid="6c08103e-b8e6-44fb-bc6c-36067153d4bd"
3553	internal="yes"
3554	wsmap="suppress"
3555	>
3556	<method name="setRemoveSavedState">
3557	<desc>
3558	Updates the flag whether saved state is removed on a machine state
3559	change from Saved to PoweredOff.
3560	</desc>
3561	<param name="aRemove" type="boolean" dir="in"/>
3562	</method>
3563
3564	<method name="updateState">
3565	<desc>
3566	Updates the VM state.
3567	<note>
3568	This operation will also update the settings file with
3569	the correct information about the saved state file
3570	and delete this file from disk when appropriate.
3571	</note>
3572	</desc>
3573	<param name="state" type="MachineState" dir="in"/>
3574	</method>
3575
3576	<method name="getIPCId">
3577	<param name="id" type="wstring" dir="return"/>
3578	</method>
3579
3580	<method name="runUSBDeviceFilters">
3581	<desc>
3582	Asks the server to run USB devices filters of the associated
3583	machine against the given USB device and tell if there is
3584	a match.
3585	<note>
3586	Intended to be used only for remote USB devices. Local
3587	ones don't require to call this method (this is done
3588	implicitly by the Host and USBProxyService).
3589	</note>
3590	</desc>
3591	<param name="device" type="IUSBDevice" dir="in"/>
3592	<param name="matched" type="boolean" dir="out"/>
3593	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3594	</method>
3595
3596	<method name="captureUSBDevice">
3597	<desc>
3598	Requests a capture of the given host USB device.
3599	When the request is completed, the VM process will
3600	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3601	notification.
3602	</desc>
3603	<param name="id" type="uuid" mod="string" dir="in"/>
3604	</method>
3605
3606	<method name="detachUSBDevice">
3607	<desc>
3608	Notification that a VM is going to detach (@a done = @c false) or has
3609	already detached (@a done = @c true) the given USB device.
3610	When the @a done = @c true request is completed, the VM process will
3611	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3612	notification.
3613	<note>
3614	In the @a done = @c true case, the server must run its own filters
3615	and filters of all VMs but this one on the detached device
3616	as if it were just attached to the host computer.
3617	</note>
3618	</desc>
3619	<param name="id" type="uuid" mod="string" dir="in"/>
3620	<param name="done" type="boolean" dir="in"/>
3621	</method>
3622
3623	<method name="autoCaptureUSBDevices">
3624	<desc>
3625	Requests a capture all matching USB devices attached to the host.
3626	When the request is completed, the VM process will
3627	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3628	notification per every captured device.
3629	</desc>
3630	</method>
3631
3632	<method name="detachAllUSBDevices">
3633	<desc>
3634	Notification that a VM that is being powered down. The done
3635	parameter indicates whether which stage of the power down
3636	we're at. When @a done = @c false the VM is announcing its
3637	intentions, while when @a done = @c true the VM is reporting
3638	what it has done.
3639	<note>
3640	In the @a done = @c true case, the server must run its own filters
3641	and filters of all VMs but this one on all detach devices as
3642	if they were just attached to the host computer.
3643	</note>
3644	</desc>
3645	<param name="done" type="boolean" dir="in"/>
3646	</method>
3647
3648	<method name="onSessionEnd">
3649	<desc>
3650	Triggered by the given session object when the session is about
3651	to close normally.
3652	</desc>
3653	<param name="session" type="ISession" dir="in">
3654	<desc>Session that is being closed</desc>
3655	</param>
3656	<param name="progress" type="IProgress" dir="return">
3657	<desc>
3658	Used to wait until the corresponding machine is actually
3659	dissociated from the given session on the server.
3660	Returned only when this session is a direct one.
3661	</desc>
3662	</param>
3663	</method>
3664
3665	<method name="beginSavingState">
3666	<desc>
3667	Called by the VM process to inform the server it wants to
3668	save the current state and stop the VM execution.
3669	</desc>
3670	<param name="progress" type="IProgress" dir="in">
3671	<desc>
3672	Progress object created by the VM process to wait until
3673	the state is saved.
3674	</desc>
3675	</param>
3676	<param name="stateFilePath" type="wstring" dir="out">
3677	<desc>
3678	File path the VM process must save the execution state to.
3679	</desc>
3680	</param>
3681	</method>
3682
3683	<method name="endSavingState">
3684	<desc>
3685	Called by the VM process to inform the server that saving
3686	the state previously requested by #beginSavingState is either
3687	successfully finished or there was a failure.
3688
3689	<result name="VBOX_E_FILE_ERROR">
3690	Settings file not accessible.
3691	</result>
3692	<result name="VBOX_E_XML_ERROR">
3693	Could not parse the settings file.
3694	</result>
3695
3696	</desc>
3697
3698	<param name="success" type="boolean" dir="in">
3699	<desc>@c true to indicate success and @c false otherwise.
3700	</desc>
3701	</param>
3702	</method>
3703
3704	<method name="adoptSavedState">
3705	<desc>
3706	Gets called by IConsole::adoptSavedState.
3707	<result name="VBOX_E_FILE_ERROR">
3708	Invalid saved state file path.
3709	</result>
3710	</desc>
3711	<param name="savedStateFile" type="wstring" dir="in">
3712	<desc>Path to the saved state file to adopt.</desc>
3713	</param>
3714	</method>
3715
3716	<method name="beginTakingSnapshot">
3717	<desc>
3718	Called from the VM process to request from the server to perform the
3719	server-side actions of creating a snapshot (creating differencing images
3720	and the snapshot object).
3721
3722	<result name="VBOX_E_FILE_ERROR">
3723	Settings file not accessible.
3724	</result>
3725	<result name="VBOX_E_XML_ERROR">
3726	Could not parse the settings file.
3727	</result>
3728	</desc>
3729	<param name="initiator" type="IConsole" dir="in">
3730	<desc>The console object that initiated this call.</desc>
3731	</param>
3732	<param name="name" type="wstring" dir="in">
3733	<desc>Snapshot name.</desc>
3734	</param>
3735	<param name="description" type="wstring" dir="in">
3736	<desc>Snapshot description.</desc>
3737	</param>
3738	<param name="consoleProgress" type="IProgress" dir="in">
3739	<desc>
3740	Progress object created by the VM process tracking the
3741	snapshot's progress. This has the following sub-operations:
3742	<ul>
3743	<li>setting up (weight 1);</li>
3744	<li>one for each hard disk attachment that needs a differencing image (weight 1 each);</li>
3745	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3746	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3747	<li>finishing up (weight 1)</li>
3748	</ul>
3749	</desc>
3750	</param>
3751	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3752	<desc>
3753	Whether this is an online snapshot (i.e. the machine is running).
3754	</desc>
3755	</param>
3756	<param name="stateFilePath" type="wstring" dir="out">
3757	<desc>
3758	File path the VM process must save the execution state to.
3759	</desc>
3760	</param>
3761	</method>
3762
3763	<method name="endTakingSnapshot">
3764	<desc>
3765	Called by the VM process to inform the server that the snapshot
3766	previously requested by #beginTakingSnapshot is either
3767	successfully taken or there was a failure.
3768	</desc>
3769
3770	<param name="success" type="boolean" dir="in">
3771	<desc>@c true to indicate success and @c false otherwise</desc>
3772	</param>
3773	</method>
3774
3775	<method name="discardSnapshot">
3776	<desc>
3777	Gets called by IConsole::discardSnapshot.
3778	<result name="VBOX_E_INVALID_OBJECT_STATE">
3779	Snapshot has more than one child snapshot.
3780	</result>
3781	</desc>
3782	<param name="initiator" type="IConsole" dir="in">
3783	<desc>The console object that initiated this call.</desc>
3784	</param>
3785	<param name="id" type="uuid" mod="string" dir="in">
3786	<desc>UUID of the snapshot to discard.</desc>
3787	</param>
3788	<param name="machineState" type="MachineState" dir="out">
3789	<desc>New machine state after this operation is started.</desc>
3790	</param>
3791	<param name="progress" type="IProgress" dir="return">
3792	<desc>Progress object to track the operation completion.</desc>
3793	</param>
3794	</method>
3795
3796	<method name="discardCurrentState">
3797	<desc>
3798	Gets called by IConsole::discardCurrentState.
3799	<result name="VBOX_E_INVALID_OBJECT_STATE">
3800	Virtual machine does not have any snapshot.
3801	</result>
3802	</desc>
3803	<param name="initiator" type="IConsole" dir="in">
3804	<desc>The console object that initiated this call.</desc>
3805	</param>
3806	<param name="machineState" type="MachineState" dir="out">
3807	<desc>New machine state after this operation is started.</desc>
3808	</param>
3809	<param name="progress" type="IProgress" dir="return">
3810	<desc>Progress object to track the operation completion.</desc>
3811	</param>
3812	</method>
3813
3814	<method name="discardCurrentSnapshotAndState">
3815	<desc>
3816	Gets called by IConsole::discardCurrentSnapshotAndState.
3817	<result name="VBOX_E_INVALID_OBJECT_STATE">
3818	Virtual machine does not have any snapshot.
3819	</result>
3820	</desc>
3821	<param name="initiator" type="IConsole" dir="in">
3822	<desc>The console object that initiated this call.</desc>
3823	</param>
3824	<param name="machineState" type="MachineState" dir="out">
3825	<desc>New machine state after this operation is started.</desc>
3826	</param>
3827	<param name="progress" type="IProgress" dir="return">
3828	<desc>Progress object to track the operation completion.</desc>
3829	</param>
3830	</method>
3831
3832	<method name="pullGuestProperties">
3833	<desc>
3834	Get the list of the guest properties matching a set of patterns along
3835	with their values, time stamps and flags and give responsibility for
3836	managing properties to the console.
3837	</desc>
3838	<param name="name" type="wstring" dir="out" safearray="yes">
3839	<desc>
3840	The names of the properties returned.
3841	</desc>
3842	</param>
3843	<param name="value" type="wstring" dir="out" safearray="yes">
3844	<desc>
3845	The values of the properties returned. The array entries match the
3846	corresponding entries in the @a name array.
3847	</desc>
3848	</param>
3849	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3850	<desc>
3851	The time stamps of the properties returned. The array entries match
3852	the corresponding entries in the @a name array.
3853	</desc>
3854	</param>
3855	<param name="flags" type="wstring" dir="out" safearray="yes">
3856	<desc>
3857	The flags of the properties returned. The array entries match the
3858	corresponding entries in the @a name array.
3859	</desc>
3860	</param>
3861	</method>
3862
3863	<method name="pushGuestProperties">
3864	<desc>
3865	Set the list of the guest properties matching a set of patterns along
3866	with their values, time stamps and flags and return responsibility for
3867	managing properties to IMachine.
3868	</desc>
3869	<param name="name" type="wstring" dir="in" safearray="yes">
3870	<desc>
3871	The names of the properties.
3872	</desc>
3873	</param>
3874	<param name="value" type="wstring" dir="in" safearray="yes">
3875	<desc>
3876	The values of the properties. The array entries match the
3877	corresponding entries in the @a name array.
3878	</desc>
3879	</param>
3880	<param name="timestamp" type="unsigned long long" dir="in" safearray="yes">
3881	<desc>
3882	The time stamps of the properties. The array entries match
3883	the corresponding entries in the @a name array.
3884	</desc>
3885	</param>
3886	<param name="flags" type="wstring" dir="in" safearray="yes">
3887	<desc>
3888	The flags of the properties. The array entries match the
3889	corresponding entries in the @a name array.
3890	</desc>
3891	</param>
3892	</method>
3893	<method name="pushGuestProperty">
3894	<desc>
3895	Update a single guest property in IMachine.
3896	</desc>
3897	<param name="name" type="wstring" dir="in">
3898	<desc>
3899	The name of the property to be updated.
3900	</desc>
3901	</param>
3902	<param name="value" type="wstring" dir="in">
3903	<desc>
3904	The value of the property.
3905	</desc>
3906	</param>
3907	<param name="timestamp" type="unsigned long long" dir="in">
3908	<desc>
3909	The timestamp of the property.
3910	</desc>
3911	</param>
3912	<param name="flags" type="wstring" dir="in">
3913	<desc>
3914	The flags of the property.
3915	</desc>
3916	</param>
3917	</method>
3918
3919	<method name="lockMedia">
3920	<desc>
3921	Locks all media attached to the machine for writing and parents of
3922	attached differencing media (if any) for reading. This operation is
3923	atomic so that if it fails no media is actually locked.
3924
3925	This method is intended to be called when the machine is in Starting or
3926	Restoring state. The locked media will be automatically unlocked when
3927	the machine is powered off or crashed.
3928	</desc>
3929	</method>
3930	</interface>
3931
3932	<interface
3933	name="IBIOSSettings" extends="$unknown"
3934	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3935	wsmap="managed"
3936	>
3937	<desc>
3938	The IBIOSSettings interface represents BIOS settings of the virtual
3939	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3940	</desc>
3941	<attribute name="logoFadeIn" type="boolean">
3942	<desc>Fade in flag for BIOS logo animation.</desc>
3943	</attribute>
3944
3945	<attribute name="logoFadeOut" type="boolean">
3946	<desc>Fade out flag for BIOS logo animation.</desc>
3947	</attribute>
3948
3949	<attribute name="logoDisplayTime" type="unsigned long">
3950	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3951	</attribute>
3952
3953	<attribute name="logoImagePath" type="wstring">
3954	<desc>Local file system path for external BIOS image.</desc>
3955	</attribute>
3956
3957	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3958	<desc>Mode of the BIOS boot device menu.</desc>
3959	</attribute>
3960
3961	<attribute name="ACPIEnabled" type="boolean">
3962	<desc>ACPI support flag.</desc>
3963	</attribute>
3964
3965	<attribute name="IOAPICEnabled" type="boolean">
3966	<desc>
3967	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3968	and support IRQs above 15.
3969	</desc>
3970	</attribute>
3971
3972	<attribute name="timeOffset" type="long long">
3973	<desc>
3974	Offset in milliseconds from the host system time. This allows for
3975	guests running with a different system date/time than the host.
3976	It is equivalent to setting the system date/time in the BIOS except
3977	it is not an absolute value but a relative one. Guest Additions
3978	time synchronization honors this offset.
3979	</desc>
3980	</attribute>
3981
3982	<attribute name="PXEDebugEnabled" type="boolean">
3983	<desc>
3984	PXE debug logging flag. If set, VirtualBox will write extensive
3985	PXE trace information to the release log.
3986	</desc>
3987	</attribute>
3988
3989	</interface>
3990
3991	<interface
3992	name="IMachine" extends="$unknown"
3993	uuid="445ecfcc-8ebd-a2a5-459c-4d21ae0b206b"
3994	wsmap="managed"
3995	>
3996	<desc>
3997	The IMachine interface represents a virtual machine, or guest, created
3998	in VirtualBox.
3999
4000	This interface is used in two contexts. First of all, a collection of
4001	objects implementing this interface is stored in the
4002	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4003	machines that are currently registered with this VirtualBox
4004	installation. Also, once a session has been opened for the given virtual
4005	machine (e.g. the virtual machine is running), the machine object
4006	associated with the open session can be queried from the session object;
4007	see <link to="ISession"/> for details.
4008
4009	The main role of this interface is to expose the settings of the virtual
4010	machine and provide methods to change various aspects of the virtual
4011	machine's configuration. For machine objects stored in the
4012	<link to="IVirtualBox::machines"/> collection, all attributes are
4013	read-only unless explicitly stated otherwise in individual attribute
4014	and method descriptions. In order to change a machine setting, a session
4015	for this machine must be opened using one of
4016	<link to="IVirtualBox::openSession"/>,
4017	<link to="IVirtualBox::openRemoteSession"/> or
4018	<link to="IVirtualBox::openExistingSession"/> methods. After the
4019	session has been successfully opened, a mutable machine object needs to
4020	be queried from the session object and then the desired settings changes
4021	can be applied to the returned object using IMachine attributes and
4022	methods. See the <link to="ISession"/> interface description for more
4023	information about sessions.
4024
4025	Note that IMachine does not provide methods to control virtual machine
4026	execution (such as start the machine, or power it down) -- these methods
4027	are grouped in a separate interface called <link to="IConsole" />.
4028
4029	<see>ISession, IConsole</see>
4030	</desc>
4031
4032	<attribute name="parent" type="IVirtualBox" readonly="yes">
4033	<desc>Associated parent object.</desc>
4034	</attribute>
4035
4036	<attribute name="accessible" type="boolean" readonly="yes">
4037	<desc>
4038	Whether this virtual machine is currently accessible or not.
4039
4040	A machine is always deemed accessible unless it is registered <i>and</i>
4041	its settings file cannot be read or parsed (either because the file itself
4042	is unavailable or has invalid XML contents).
4043
4044	Every time this property is read, the accessibility state of
4045	this machine is re-evaluated. If the returned value is @c false,
4046	the <link to="#accessError"/> property may be used to get the
4047	detailed error information describing the reason of
4048	inaccessibility, including XML error messages.
4049
4050	When the machine is inaccessible, only the following properties
4051	can be used on it:
4052	<ul>
4053	<li><link to="#parent"/></li>
4054	<li><link to="#id"/></li>
4055	<li><link to="#settingsFilePath"/></li>
4056	<li><link to="#accessible"/></li>
4057	<li><link to="#accessError"/></li>
4058	</ul>
4059
4060	An attempt to access any other property or method will return
4061	an error.
4062
4063	The only possible action you can perform on an inaccessible
4064	machine is to unregister it using the
4065	<link to="IVirtualBox::unregisterMachine"/> call (or, to check
4066	for the accessibility state once more by querying this
4067	property).
4068
4069	<note>
4070	In the current implementation, once this property returns
4071	@c true, the machine will never become inaccessible
4072	later, even if its settings file cannot be successfully
4073	read/written any more (at least, until the VirtualBox
4074	server is restarted). This limitation may be removed in
4075	future releases.
4076	</note>
4077	</desc>
4078	</attribute>
4079
4080	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4081	<desc>
4082	Error information describing the reason of machine
4083	inaccessibility.
4084
4085	Reading this property is only valid after the last call to
4086	<link to="#accessible"/> returned @c false (i.e. the
4087	machine is currently unaccessible). Otherwise, a @c null
4088	IVirtualBoxErrorInfo object will be returned.
4089	</desc>
4090	</attribute>
4091
4092	<attribute name="name" type="wstring">
4093	<desc>
4094	Name of the virtual machine.
4095
4096	Besides being used for human-readable identification purposes
4097	everywhere in VirtualBox, the virtual machine name is also used
4098	as a name of the machine's settings file and as a name of the
4099	subdirectory this settings file resides in. Thus, every time you
4100	change the value of this property, the settings file will be
4101	renamed once you call <link to="#saveSettings"/> to confirm the
4102	change. The containing subdirectory will be also renamed, but
4103	only if it has exactly the same name as the settings file
4104	itself prior to changing this property (for backward compatibility
4105	with previous API releases). The above implies the following
4106	limitations:
4107	<ul>
4108	<li>The machine name cannot be empty.</li>
4109	<li>The machine name can contain only characters that are valid
4110	file name characters according to the rules of the file
4111	system used to store VirtualBox configuration.</li>
4112	<li>You cannot have two or more machines with the same name
4113	if they use the same subdirectory for storing the machine
4114	settings files.</li>
4115	<li>You cannot change the name of the machine if it is running,
4116	or if any file in the directory containing the settings file
4117	is being used by another running machine or by any other
4118	process in the host operating system at a time when
4119	<link to="#saveSettings"/> is called.
4120	</li>
4121	</ul>
4122	If any of the above limitations are hit, <link to="#saveSettings"/>
4123	will return an appropriate error message explaining the exact
4124	reason and the changes you made to this machine will not be
4125	saved.
4126	<note>
4127	For "legacy" machines created using the
4128	<link to="IVirtualBox::createLegacyMachine"/> call,
4129	the above naming limitations do not apply because the
4130	machine name does not affect the settings file name.
4131	The settings file name remains the same as it was specified
4132	during machine creation and never changes.
4133	</note>
4134	</desc>
4135	</attribute>
4136
4137	<attribute name="description" type="wstring">
4138	<desc>
4139	Description of the virtual machine.
4140
4141	The description attribute can contain any text and is
4142	typically used to describe the hardware and software
4143	configuration of the virtual machine in detail (i.e. network
4144	settings, versions of the installed software and so on).
4145	</desc>
4146	</attribute>
4147
4148	<attribute name="id" type="uuid" mod="string" readonly="yes">
4149	<desc>UUID of the virtual machine.</desc>
4150	</attribute>
4151
4152	<attribute name="OSTypeId" type="wstring">
4153	<desc>
4154	User-defined identifier of the Guest OS type.
4155	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4156	an IGuestOSType object representing details about the given
4157	Guest OS type.
4158	<note>
4159	This value may differ from the value returned by
4160	<link to="IGuest::OSTypeId"/> if Guest Additions are
4161	installed to the guest OS.
4162	</note>
4163	</desc>
4164	</attribute>
4165
4166	<attribute name="HardwareVersion" type="wstring">
4167	<desc>Hardware version identifier. Internal use only for now.</desc>
4168	</attribute>
4169
4170	<attribute name="CPUCount" type="unsigned long">
4171	<desc>Number of virtual CPUs in the VM.</desc>
4172	</attribute>
4173
4174	<attribute name="memorySize" type="unsigned long">
4175	<desc>System memory size in megabytes.</desc>
4176	</attribute>
4177
4178	<attribute name="memoryBalloonSize" type="unsigned long">
4179	<desc>Initial memory balloon size in megabytes.</desc>
4180	</attribute>
4181
4182	<attribute name="statisticsUpdateInterval" type="unsigned long">
4183	<desc>Initial interval to update guest statistics in seconds.</desc>
4184	</attribute>
4185
4186	<attribute name="VRAMSize" type="unsigned long">
4187	<desc>Video memory size in megabytes.</desc>
4188	</attribute>
4189
4190	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4191	<desc>
4192	This setting determines whether VirtualBox allows this machine to make
4193	use of the 3D graphics support available on the host.</desc>
4194	</attribute>
4195
4196	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4197	<desc>
4198	This setting determines whether VirtualBox allows this machine to make
4199	use of the 2D video acceleration support available on the host.</desc>
4200	</attribute>
4201
4202	<attribute name="monitorCount" type="unsigned long">
4203	<desc>
4204	Number of virtual monitors.
4205	<note>
4206	Only effective on Windows XP and later guests with
4207	Guest Additions installed.
4208	</note>
4209	</desc>
4210	</attribute>
4211
4212	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4213	<desc>Object containing all BIOS settings.</desc>
4214	</attribute>
4215
4216	<attribute name="firmwareType" type="FirmwareType">
4217	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4218	bootstrap in this VM.</desc>
4219	</attribute>
4220
4221	<attribute name="HWVirtExEnabled" type="boolean">
4222	<desc>
4223	This setting determines whether VirtualBox will try to make use of
4224	the host CPU's hardware virtualization extensions such as Intel VT-x
4225	and AMD-V. Note that in case such extensions are not available,
4226	they will not be used.
4227	</desc>
4228	</attribute>
4229
4230	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" default="false">
4231	<desc>
4232	This setting determines whether VirtualBox will try to make use of
4233	the nested paging extension of Intel VT-x and AMD-V. Note that in case
4234	such extensions are not available, they will not be used.
4235	</desc>
4236	</attribute>
4237
4238	<attribute name="HWVirtExVPIDEnabled" type="boolean" default="false">
4239	<desc>
4240	This setting determines whether VirtualBox will try to make use of
4241	the VPID extension of Intel VT-x. Note that in case such extensions are
4242	not available, they will not be used.
4243	</desc>
4244	</attribute>
4245
4246	<attribute name="PAEEnabled" type="boolean" default="false">
4247	<desc>
4248	This setting determines whether VirtualBox will expose the Physical Address
4249	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
4250	is not available, it will not be reported.
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="snapshotFolder" type="wstring">
4255	<desc>
4256	Full path to the directory used to store snapshot data
4257	(differencing media and saved state files) of this machine.
4258
4259	The initial value of this property is
4260	<tt><</tt><link to="#settingsFilePath">
4261	path_to_settings_file</link><tt>>/<</tt>
4262	<link to="#id">machine_uuid</link>
4263	<tt>></tt>.
4264
4265	Currently, it is an error to try to change this property on
4266	a machine that has snapshots (because this would require to
4267	move possibly large files to a different location).
4268	A separate method will be available for this purpose later.
4269
4270	<note>
4271	Setting this property to @c null or to an empty string will restore
4272	the initial value.
4273	</note>
4274	<note>
4275	When setting this property, the specified path can be
4276	absolute (full path) or relative to the directory where the
4277	<link to="#settingsFilePath">machine settings file</link>
4278	is located. When reading this property, a full path is
4279	always returned.
4280	</note>
4281	<note>
4282	The specified path may not exist, it will be created
4283	when necessary.
4284	</note>
4285	</desc>
4286	</attribute>
4287
4288	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
4289	<desc>VRDP server object.</desc>
4290	</attribute>
4291
4292	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4293	<desc>Array of media attached to this machine.</desc>
4294	</attribute>
4295
4296	<attribute name="USBController" type="IUSBController" readonly="yes">
4297	<desc>
4298	Associated USB controller object.
4299
4300	<note>
4301	If USB functionality is not available in the given edition of
4302	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4303	</note>
4304	</desc>
4305	</attribute>
4306
4307	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4308	<desc>Associated audio adapter, always present.</desc>
4309	</attribute>
4310
4311	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4312	<desc>Array of storage controllers attached to this machine.</desc>
4313	</attribute>
4314
4315	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4316	<desc>
4317	Full name of the file containing machine settings data.
4318	</desc>
4319	</attribute>
4320
4321	<attribute name="settingsModified" type="boolean" readonly="yes">
4322	<desc>
4323	Whether the settings of this machine have been modified
4324	(but neither yet saved nor discarded).
4325	<note>
4326	Reading this property is only valid on instances returned
4327	by <link to="ISession::machine"/> and on new machines
4328	created by <link to="IVirtualBox::createMachine"/> or opened
4329	by <link to="IVirtualBox::openMachine"/> but not
4330	yet registered, or on unregistered machines after calling
4331	<link to="IVirtualBox::unregisterMachine"/>. For all other
4332	cases, the settings can never be modified.
4333	</note>
4334	<note>
4335	For newly created unregistered machines, the value of this
4336	property is always @c true until <link to="#saveSettings"/>
4337	is called (no matter if any machine settings have been
4338	changed after the creation or not). For opened machines
4339	the value is set to @c false (and then follows to normal rules).
4340	</note>
4341	</desc>
4342	</attribute>
4343
4344	<attribute name="sessionState" type="SessionState" readonly="yes">
4345	<desc>Current session state for this machine.</desc>
4346	</attribute>
4347
4348	<attribute name="sessionType" type="wstring" readonly="yes">
4349	<desc>
4350	Type of the session. If <link to="#sessionState"/> is
4351	SessionSpawning or SessionOpen, this attribute contains the
4352	same value as passed to the
4353	<link to="IVirtualBox::openRemoteSession"/> method in the
4354	@a type parameter. If the session was opened directly using
4355	<link to="IVirtualBox::openSession"/>, or if
4356	<link to="#sessionState"/> is SessionClosed, the value of this
4357	attribute is an empty string.
4358	</desc>
4359	</attribute>
4360
4361	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4362	<desc>
4363	Identifier of the session process. This attribute contains the
4364	platform-dependent identifier of the process that has opened a
4365	direct session for this machine using the
4366	<link to="IVirtualBox::openSession"/> call. The returned value
4367	is only valid if <link to="#sessionState"/> is SessionOpen or
4368	SessionClosing (i.e. a session is currently open or being
4369	closed) by the time this property is read.
4370	</desc>
4371	</attribute>
4372
4373	<attribute name="state" type="MachineState" readonly="yes">
4374	<desc>Current execution state of this machine.</desc>
4375	</attribute>
4376
4377	<attribute name="lastStateChange" type="long long" readonly="yes">
4378	<desc>
4379	Time stamp of the last execution state change,
4380	in milliseconds since 1970-01-01 UTC.
4381	</desc>
4382	</attribute>
4383
4384	<attribute name="stateFilePath" type="wstring" readonly="yes">
4385	<desc>
4386	Full path to the file that stores the execution state of
4387	the machine when it is in the <link to="MachineState_Saved"/> state.
4388	<note>
4389	When the machine is not in the Saved state, this attribute is
4390	an empty string.
4391	</note>
4392	</desc>
4393	</attribute>
4394
4395	<attribute name="logFolder" type="wstring" readonly="yes">
4396	<desc>
4397	Full path to the folder that stores a set of rotated log files
4398	recorded during machine execution. The most recent log file is
4399	named <tt>VBox.log</tt>, the previous log file is
4400	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4401	in the current version).
4402	</desc>
4403	</attribute>
4404
4405	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4406	<desc>
4407	Current snapshot of this machine. This is @c null if the machine
4408	currently has no snapshots. Otherwise, this is always the last snapshot
4409	in the current implementation; see <link to="ISnapshot"/> for details.
4410	</desc>
4411	</attribute>
4412
4413	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4414	<desc>
4415	Number of snapshots taken on this machine. Zero means the
4416	machine doesn't have any snapshots.
4417	</desc>
4418	</attribute>
4419
4420	<attribute name="currentStateModified" type="boolean" readonly="yes">
4421	<desc>
4422	Returns @c true if the current state of the machine is not
4423	identical to the state stored in the current snapshot.
4424
4425	The current state is identical to the current snapshot right
4426	after one of the following calls are made:
4427	<ul>
4428	<li><link to="IConsole::discardCurrentState"/> or
4429	<link to="IConsole::discardCurrentSnapshotAndState"/>
4430	</li>
4431	<li><link to="IConsole::takeSnapshot"/> (issued on a
4432	powered off or saved machine, for which
4433	<link to="#settingsModified"/> returns @c false)
4434	</li>
4435	<li><link to="IMachine::setCurrentSnapshot"/>
4436	</li>
4437	</ul>
4438
4439	The current state remains identical until one of the following
4440	happens:
4441	<ul>
4442	<li>settings of the machine are changed</li>
4443	<li>the saved state is discarded</li>
4444	<li>the current snapshot is discarded</li>
4445	<li>an attempt to execute the machine is made</li>
4446	</ul>
4447
4448	<note>
4449	For machines that don't have snapshots, this property is
4450	always @c false.
4451	</note>
4452	</desc>
4453	</attribute>
4454
4455	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4456	<desc>
4457	Collection of shared folders for this machine (permanent shared
4458	folders). These folders are shared automatically at machine startup
4459	and available only to the guest OS installed within this machine.
4460
4461	New shared folders are added to the collection using
4462	<link to="#createSharedFolder"/>. Existing shared folders can be
4463	removed using <link to="#removeSharedFolder"/>.
4464	</desc>
4465	</attribute>
4466
4467	<attribute name="clipboardMode" type="ClipboardMode">
4468	<desc>
4469	Synchronization mode between the host OS clipboard
4470	and the guest OS clipboard.
4471	</desc>
4472	</attribute>
4473
4474	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4475	<desc>
4476	A comma-separated list of simple glob patterns. Changes to guest
4477	properties whose name matches one of the patterns will generate an
4478	<link to="IVirtualBoxCallback::onGuestPropertyChange"/> signal.
4479	</desc>
4480	</attribute>
4481
4482	<method name="setBootOrder">
4483	<desc>
4484	Puts the given device to the specified position in
4485	the boot order.
4486
4487	To indicate that no device is associated with the given position,
4488	<link to="DeviceType_Null"/> should be used.
4489
4490	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4491
4492	<result name="E_INVALIDARG">
4493	Boot @a position out of range.
4494	</result>
4495	<result name="E_NOTIMPL">
4496	Booting from USB @a device currently not supported.
4497	</result>
4498
4499	</desc>
4500	<param name="position" type="unsigned long" dir="in">
4501	<desc>
4502	Position in the boot order (@c 1 to the total number of
4503	devices the machine can boot from, as returned by
4504	<link to="ISystemProperties::maxBootPosition"/>).
4505	</desc>
4506	</param>
4507	<param name="device" type="DeviceType" dir="in">
4508	<desc>
4509	The type of the device used to boot at the given position.
4510	</desc>
4511	</param>
4512	</method>
4513
4514	<method name="getBootOrder" const="yes">
4515	<desc>
4516	Returns the device type that occupies the specified
4517	position in the boot order.
4518
4519	@todo [remove?]
4520	If the machine can have more than one device of the returned type
4521	(such as hard disks), then a separate method should be used to
4522	retrieve the individual device that occupies the given position.
4523
4524	If here are no devices at the given position, then
4525	<link to="DeviceType_Null"/> is returned.
4526
4527	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4528
4529	<result name="E_INVALIDARG">
4530	Boot @a position out of range.
4531	</result>
4532
4533	</desc>
4534	<param name="position" type="unsigned long" dir="in">
4535	<desc>
4536	Position in the boot order (@c 1 to the total number of
4537	devices the machine can boot from, as returned by
4538	<link to="ISystemProperties::maxBootPosition"/>).
4539	</desc>
4540	</param>
4541	<param name="device" type="DeviceType" dir="return">
4542	<desc>
4543	Device at the given position.
4544	</desc>
4545	</param>
4546	</method>
4547
4548	<method name="attachDevice">
4549	<desc>
4550	Attaches a device and optionally mounts a medium to the given storage
4551	controller (<link to="IStorageController" />, identified by @a name),
4552	at the indicated port and device.
4553
4554	This method is intended for managing storage devices in general (it works
4555	for both fixed and removable media). For storage devices supporting removable
4556	media (such as DVDs and floppies), you can also use <link to="IMedium::mountMedium"/>
4557	for changing the media while the machine is running.
4558
4559	For the IDE bus, the @a controllerPort parameter can be either
4560	@c 0 or @c 1, to specify the primary or secondary IDE controller,
4561	respectively. For each of these, @a device can then be either @c 0 or @c 1,
4562	to specify the master or the slave device, respectively. (In the
4563	default configuration of virtual machines, the secondary master is
4564	used for a CD/DVD drive.)
4565
4566	For an SATA controller, @a controllerPort must be a number ranging
4567	from @c 0 to @c 29. For a SCSI controller, @a controllerPort must
4568	be a number ranging from @c 0 to @c 15.
4569
4570	For both SCSI and SATA, the @a device parameter is unused and must
4571	be @c 0.
4572
4573	For fixed media such as hard disks, the given medium cannot be NULL. It may
4574	be NULL for removable media such as DVDs and floppies.
4575
4576	After calling this returns successfully, a new instance of
4577	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4578	attachments (<link to="IMachine::mediumAttachments"/>).
4579
4580	The specified device slot must not have another disk attached to it, or
4581	this method will fail.
4582
4583	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4584	information about attaching media.
4585
4586	<note>
4587	You cannot attach a hard disk to a running machine. Also, you cannot
4588	attach a hard disk to a newly created machine until this machine's
4589	settings are saved to disk using <link to="#saveSettings"/>.
4590	</note>
4591	<note>
4592	If the medium is being attached indirectly, a new differencing medium
4593	will implicitly be created for it and attached instead. If the
4594	changes made to the machine settings (including this indirect
4595	attachment) are later cancelled using <link to="#discardSettings"/>,
4596	this implicitly created differencing medium will implicitly
4597	be deleted.
4598	</note>
4599
4600	<result name="E_INVALIDARG">
4601	SATA device, SATA port, IDE port or IDE slot out of range.
4602	</result>
4603	<result name="VBOX_E_INVALID_OBJECT_STATE">
4604	Attempt to attach medium to an unregistered virtual machine.
4605	</result>
4606	<result name="VBOX_E_INVALID_VM_STATE">
4607	Invalid machine state.
4608	</result>
4609	<result name="VBOX_E_OBJECT_IN_USE">
4610	Hard disk already attached to this or another virtual machine.
4611	</result>
4612
4613	</desc>
4614	<param name="name" type="wstring" dir="in">
4615	<desc>Name of the storage controller to attach the device to.</desc>
4616	</param>
4617	<param name="controllerPort" type="long" dir="in">
4618	<desc>Port to attach the device to.</desc>
4619	</param>
4620	<param name="device" type="long" dir="in">
4621	<desc>Device slot in the given port to attach the device to.</desc>
4622	</param>
4623	<param name="type" type="DeviceType" dir="in">
4624	<desc>Device type of the attached device.</desc>
4625	</param>
4626	<param name="id" type="uuid" mod="string" dir="in">
4627	<desc>UUID of the medium to mount. NULL UUID means do not mount any
4628	medium.</desc>
4629	</param>
4630	</method>
4631
4632	<method name="detachDevice">
4633	<desc>
4634	Detaches the device attached to a device slot of the specified bus.
4635
4636	Detaching the device from the virtual machine is deferred. This means
4637	that the medium remains associated with the machine when this method
4638	returns and gets actually de-associated only after a successful
4639	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4640	for more detailed information about attaching media.
4641
4642	<note>
4643	You cannot detach the hard disk from a running machine.
4644	</note>
4645	<note>
4646	Detaching differencing media implicitly created by <link
4647	to="#attachDevice"/> for the indirect attachment using this
4648	method will <b>not</b> implicitly delete them. The
4649	<link to="IMedium::deleteStorage"/> operation should be
4650	explicitly performed by the caller after the medium is successfully
4651	detached and the settings are saved with
4652	<link to="#saveSettings"/>, if it is the desired action.
4653	</note>
4654
4655	<result name="VBOX_E_INVALID_VM_STATE">
4656	Attempt to detach medium from a running virtual machine.
4657	</result>
4658	<result name="VBOX_E_OBJECT_NOT_FOUND">
4659	No medium attached to given slot/bus.
4660	</result>
4661	<result name="VBOX_E_NOT_SUPPORTED">
4662	Hard disk format does not support storage deletion.
4663	</result>
4664
4665	</desc>
4666	<param name="name" type="wstring" dir="in">
4667	<desc>Name of the storage controller to detach the medium from.</desc>
4668	</param>
4669	<param name="controllerPort" type="long" dir="in">
4670	<desc>Port number to detach the medium from.</desc>
4671	</param>
4672	<param name="device" type="long" dir="in">
4673	<desc>Device slot number to detach the medium from.</desc>
4674	</param>
4675	</method>
4676
4677	<method name="mountMedium">
4678	<desc>
4679	Mounts a medium (<link to="IMedium" />, identified
4680	by the given UUID @a id) to the given storage controller
4681	(<link to="IStorageController" />, identified by @a name),
4682	at the indicated port and device. The device must already exist;
4683	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4684
4685	This method is intended only for managing removable media, where the
4686	device is fixed but media is changeable at runtime (such as DVDs
4687	and floppies). It cannot be used for fixed media such as hard disks.
4688
4689	The @a controllerPort and @a device parameters specify the device slot and
4690	have have the same meaning as with <link to="IMachine::attachDevice" />.
4691
4692	The specified device slot can have a medium mounted, which will be
4693	unmounted first. Specifying a NULL medium does just an unmount.
4694
4695	See <link to="IMedium"/> for more detailed information about
4696	attaching media.
4697
4698	<result name="E_INVALIDARG">
4699	SATA device, SATA port, IDE port or IDE slot out of range.
4700	</result>
4701	<result name="VBOX_E_INVALID_OBJECT_STATE">
4702	Attempt to attach medium to an unregistered virtual machine.
4703	</result>
4704	<result name="VBOX_E_INVALID_VM_STATE">
4705	Invalid machine state.
4706	</result>
4707	<result name="VBOX_E_OBJECT_IN_USE">
4708	Medium already attached to this or another virtual machine.
4709	</result>
4710
4711	</desc>
4712	<param name="name" type="wstring" dir="in">
4713	<desc>Name of the storage controller to attach the medium to.</desc>
4714	</param>
4715	<param name="controllerPort" type="long" dir="in">
4716	<desc>Port to attach the medium to.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port to attach the medium to.</desc>
4720	</param>
4721	<param name="id" type="uuid" mod="string" dir="in">
4722	<desc>UUID of the medium to attach.</desc>
4723	</param>
4724	</method>
4725
4726	<method name="getMedium" const="yes">
4727	<desc>
4728	Returns the virtual medium attached to a device slot of the specified
4729	bus.
4730
4731	Note that if the medium was indirectly attached by
4732	<link to="#mountMedium"/> to the given device slot then this
4733	method will return not the same object as passed to the
4734	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4735	more detailed information about mounting a medium.
4736
4737	<result name="VBOX_E_OBJECT_NOT_FOUND">
4738	No medium attached to given slot/bus.
4739	</result>
4740
4741	</desc>
4742	<param name="name" type="wstring" dir="in">
4743	<desc>Name of the storage controller the medium is attached to.</desc>
4744	</param>
4745	<param name="controllerPort" type="long" dir="in">
4746	<desc>Port to query.</desc>
4747	</param>
4748	<param name="device" type="long" dir="in">
4749	<desc>Device slot in the given port to query.</desc>
4750	</param>
4751	<param name="medium" type="IMedium" dir="return">
4752	<desc>Attached medium object.</desc>
4753	</param>
4754	</method>
4755
4756	<method name="getMediumAttachmentsOfController" const="yes">
4757	<desc>
4758	Returns an array of medium attachments which are attached to the
4759	the controller with the given name.
4760
4761	<result name="VBOX_E_OBJECT_NOT_FOUND">
4762	A storage controller with given name doesn't exist.
4763	</result>
4764	</desc>
4765	<param name="name" type="wstring" dir="in"/>
4766	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4767	</method>
4768
4769	<method name="getMediumAttachment" const="yes">
4770	<desc>
4771	Returns a medium attachment which corresponds to the controller with
4772	the given name, on the given port and device slot.
4773
4774	<result name="VBOX_E_OBJECT_NOT_FOUND">
4775	No attachment exists for the given controller/port/device combination.
4776	</result>
4777	</desc>
4778	<param name="name" type="wstring" dir="in"/>
4779	<param name="controllerPort" type="long" dir="in"/>
4780	<param name="device" type="long" dir="in"/>
4781	<param name="attachment" type="IMediumAttachment" dir="return"/>
4782	</method>
4783
4784	<method name="getNetworkAdapter" const="yes">
4785	<desc>
4786	Returns the network adapter associated with the given slot.
4787	Slots are numbered sequentially, starting with zero. The total
4788	number of adapters per machine is defined by the
4789	<link to="ISystemProperties::networkAdapterCount"/> property,
4790	so the maximum slot number is one less than that property's value.
4791
4792	<result name="E_INVALIDARG">
4793	Invalid @a slot number.
4794	</result>
4795
4796	</desc>
4797	<param name="slot" type="unsigned long" dir="in"/>
4798	<param name="adapter" type="INetworkAdapter" dir="return"/>
4799	</method>
4800
4801	<method name="addStorageController">
4802	<desc>
4803	Adds a new storage controller (SCSI or SATA controller) to the
4804	machine and returns it as an instance of
4805	<link to="IStorageController" />.
4806
4807	@a name identifies the controller for subsequent calls such as
4808	<link to="#getStorageControllerByName" />,
4809	<link to="#removeStorageController" />,
4810	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4811
4812	After the controller has been added, you can set its exact
4813	type by setting the <link to="IStorageController::controllerType" />.
4814
4815	<result name="VBOX_E_OBJECT_IN_USE">
4816	A storage controller with given name exists already.
4817	</result>
4818	<result name="E_INVALIDARG">
4819	Invalid @a controllerType.
4820	</result>
4821	</desc>
4822	<param name="name" type="wstring" dir="in"/>
4823	<param name="connectionType" type="StorageBus" dir="in"/>
4824	<param name="controller" type="IStorageController" dir="return"/>
4825	</method>
4826
4827	<method name="getStorageControllerByName" const="yes">
4828	<desc>
4829	Returns a storage controller with the given name.
4830
4831	<result name="VBOX_E_OBJECT_NOT_FOUND">
4832	A storage controller with given name doesn't exist.
4833	</result>
4834	</desc>
4835	<param name="name" type="wstring" dir="in"/>
4836	<param name="storageController" type="IStorageController" dir="return"/>
4837	</method>
4838
4839	<method name="removeStorageController">
4840	<desc>
4841	Removes a storage controller from the machine.
4842
4843	<result name="VBOX_E_OBJECT_NOT_FOUND">
4844	A storage controller with given name doesn't exist.
4845	</result>
4846	</desc>
4847	<param name="name" type="wstring" dir="in"/>
4848	</method>
4849
4850	<method name="getSerialPort" const="yes">
4851	<desc>
4852	Returns the serial port associated with the given slot.
4853	Slots are numbered sequentially, starting with zero. The total
4854	number of serial ports per machine is defined by the
4855	<link to="ISystemProperties::serialPortCount"/> property,
4856	so the maximum slot number is one less than that property's value.
4857
4858	<result name="E_INVALIDARG">
4859	Invalid @a slot number.
4860	</result>
4861
4862	</desc>
4863	<param name="slot" type="unsigned long" dir="in"/>
4864	<param name="port" type="ISerialPort" dir="return"/>
4865	</method>
4866
4867	<method name="getParallelPort" const="yes">
4868	<desc>
4869	Returns the parallel port associated with the given slot.
4870	Slots are numbered sequentially, starting with zero. The total
4871	number of parallel ports per machine is defined by the
4872	<link to="ISystemProperties::parallelPortCount"/> property,
4873	so the maximum slot number is one less than that property's value.
4874
4875	<result name="E_INVALIDARG">
4876	Invalid @a slot number.
4877	</result>
4878
4879	</desc>
4880	<param name="slot" type="unsigned long" dir="in"/>
4881	<param name="port" type="IParallelPort" dir="return"/>
4882	</method>
4883
4884	<method name="getExtraDataKeys">
4885	<desc>
4886	Returns an array representing the machine-specific extra data keys
4887	which currently have values defined.
4888	</desc>
4889	<param name="value" type="wstring" dir="return" safearray="yes">
4890	<desc>Array of extra data keys.</desc>
4891	</param>
4892	</method>
4893
4894	<method name="getExtraData">
4895	<desc>
4896	Returns associated machine-specific extra data.
4897
4898	If the requested data @a key does not exist, this function will
4899	succeed and return an empty string in the @a value argument.
4900
4901	<result name="VBOX_E_FILE_ERROR">
4902	Settings file not accessible.
4903	</result>
4904	<result name="VBOX_E_XML_ERROR">
4905	Could not parse the settings file.
4906	</result>
4907
4908	</desc>
4909	<param name="key" type="wstring" dir="in">
4910	<desc>Name of the data key to get.</desc>
4911	</param>
4912	<param name="value" type="wstring" dir="return">
4913	<desc>Value of the requested data key.</desc>
4914	</param>
4915	</method>
4916
4917	<method name="setExtraData">
4918	<desc>
4919	Sets associated machine-specific extra data.
4920
4921	If you pass @c null or an empty string as a key @a value, the given
4922	@a key will be deleted.
4923
4924	<note>
4925	Before performing the actual data change, this method will ask all
4926	registered callbacks using the
4927	<link to="IVirtualBoxCallback::onExtraDataCanChange"/>
4928	notification for a permission. If one of the callbacks refuses the
4929	new value, the change will not be performed.
4930	</note>
4931	<note>
4932	On success, the
4933	<link to="IVirtualBoxCallback::onExtraDataChange"/> notification
4934	is called to inform all registered callbacks about a successful data
4935	change.
4936	</note>
4937	<note>
4938	This method can be called outside the machine session and therefore
4939	it's a caller's responsibility to handle possible race conditions
4940	when several clients change the same key at the same time.
4941	</note>
4942
4943	<result name="VBOX_E_FILE_ERROR">
4944	Settings file not accessible.
4945	</result>
4946	<result name="VBOX_E_XML_ERROR">
4947	Could not parse the settings file.
4948	</result>
4949
4950	</desc>
4951	<param name="key" type="wstring" dir="in">
4952	<desc>Name of the data key to set.</desc>
4953	</param>
4954	<param name="value" type="wstring" dir="in">
4955	<desc>Value to assign to the key.</desc>
4956	</param>
4957	</method>
4958
4959	<method name="saveSettings">
4960	<desc>
4961	Saves any changes to machine settings made since the session
4962	has been opened or a new machine has been created, or since the
4963	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4964	For registered machines, new settings become visible to all
4965	other VirtualBox clients after successful invocation of this
4966	method.
4967	<note>
4968	The method sends <link to="IVirtualBoxCallback::onMachineDataChange"/>
4969	notification event after the configuration has been successfully
4970	saved (only for registered machines).
4971	</note>
4972	<note>
4973	Calling this method is only valid on instances returned
4974	by <link to="ISession::machine"/> and on new machines
4975	created by <link to="IVirtualBox::createMachine"/> but not
4976	yet registered, or on unregistered machines after calling
4977	<link to="IVirtualBox::unregisterMachine"/>.
4978	</note>
4979
4980	<result name="VBOX_E_FILE_ERROR">
4981	Settings file not accessible.
4982	</result>
4983	<result name="VBOX_E_XML_ERROR">
4984	Could not parse the settings file.
4985	</result>
4986	<result name="E_ACCESSDENIED">
4987	Modification request refused.
4988	</result>
4989
4990	</desc>
4991	</method>
4992
4993	<method name="discardSettings">
4994	<desc>
4995	Discards any changes to the machine settings made since the session
4996	has been opened or since the last call to <link to="#saveSettings"/>
4997	or <link to="#discardSettings"/>.
4998	<note>
4999	Calling this method is only valid on instances returned
5000	by <link to="ISession::machine"/> and on new machines
5001	created by <link to="IVirtualBox::createMachine"/> or
5002	opened by <link to="IVirtualBox::openMachine"/> but not
5003	yet registered, or on unregistered machines after calling
5004	<link to="IVirtualBox::unregisterMachine"/>.
5005	</note>
5006
5007	<result name="VBOX_E_INVALID_VM_STATE">
5008	Virtual machine is not mutable.
5009	</result>
5010
5011	</desc>
5012	</method>
5013
5014	<method name="deleteSettings">
5015	<desc>
5016	Deletes the settings file of this machine from disk.
5017	The machine must not be registered in order for this operation
5018	to succeed.
5019	<note>
5020	<link to="#settingsModified"/> will return @c true after this
5021	method successfully returns.
5022	</note>
5023	<note>
5024	Calling this method is only valid on instances returned
5025	by <link to="ISession::machine"/> and on new machines
5026	created by <link to="IVirtualBox::createMachine"/> or
5027	opened by <link to="IVirtualBox::openMachine"/> but not
5028	yet registered, or on unregistered machines after calling
5029	<link to="IVirtualBox::unregisterMachine"/>.
5030	</note>
5031	<note>
5032	The deleted machine settings file can be restored (saved again)
5033	by calling <link to="#saveSettings"/>.
5034	</note>
5035
5036	<result name="VBOX_E_INVALID_VM_STATE">
5037	Cannot delete settings of a registered machine or
5038	machine not mutable.
5039	</result>
5040	<result name="VBOX_E_IPRT_ERROR">
5041	Could not delete the settings file.
5042	</result>
5043
5044	</desc>
5045	</method>
5046
5047	<method name="export">
5048	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5049	steps required to export VirtualBox machines to OVF.
5050	</desc>
5051
5052	<param name="aAppliance" type="IAppliance" dir="in">
5053	<desc>Appliance to export this machine to.</desc>
5054	</param>
5055	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5056	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5057	</param>
5058	</method >
5059
5060	<method name="getSnapshot">
5061	<desc>
5062	Returns a snapshot of this machine with the given UUID.
5063	A @c null UUID can be used to obtain the first snapshot
5064	taken on this machine. This is useful if you want to traverse
5065	the whole tree of snapshots starting from the root.
5066
5067	<result name="VBOX_E_OBJECT_NOT_FOUND">
5068	Virtual machine has no snapshots or snapshot not found.
5069	</result>
5070
5071	</desc>
5072	<param name="id" type="uuid" mod="string" dir="in">
5073	<desc>UUID of the snapshot to get</desc>
5074	</param>
5075	<param name="snapshot" type="ISnapshot" dir="return">
5076	<desc>Snapshot object with the given UUID.</desc>
5077	</param>
5078	</method>
5079
5080	<method name="findSnapshot">
5081	<desc>
5082	Returns a snapshot of this machine with the given name.
5083
5084	<result name="VBOX_E_OBJECT_NOT_FOUND">
5085	Virtual machine has no snapshots or snapshot not found.
5086	</result>
5087
5088	</desc>
5089	<param name="name" type="wstring" dir="in">
5090	<desc>Name of the snapshot to find</desc>
5091	</param>
5092	<param name="snapshot" type="ISnapshot" dir="return">
5093	<desc>Snapshot object with the given name.</desc>
5094	</param>
5095	</method>
5096
5097	<method name="setCurrentSnapshot">
5098	<desc>
5099	Sets the current snapshot of this machine.
5100	<note>
5101	In the current implementation, this operation is not
5102	implemented.
5103	</note>
5104	</desc>
5105	<param name="id" type="uuid" mod="string" dir="in">
5106	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5107	</param>
5108	</method>
5109
5110	<method name="createSharedFolder">
5111	<desc>
5112	Creates a new permanent shared folder by associating the given logical
5113	name with the given host path, adds it to the collection of shared
5114	folders and starts sharing it. Refer to the description of
5115	<link to="ISharedFolder"/> to read more about logical names.
5116
5117	<result name="VBOX_E_OBJECT_IN_USE">
5118	Shared folder already exists.
5119	</result>
5120	<result name="VBOX_E_FILE_ERROR">
5121	Shared folder @a hostPath not accessible.
5122	</result>
5123
5124	</desc>
5125	<param name="name" type="wstring" dir="in">
5126	<desc>Unique logical name of the shared folder.</desc>
5127	</param>
5128	<param name="hostPath" type="wstring" dir="in">
5129	<desc>Full path to the shared folder in the host file system.</desc>
5130	</param>
5131	<param name="writable" type="boolean" dir="in">
5132	<desc>Whether the share is writable or readonly</desc>
5133	</param>
5134	</method>
5135
5136	<method name="removeSharedFolder">
5137	<desc>
5138	Removes the permanent shared folder with the given name previously
5139	created by <link to="#createSharedFolder"/> from the collection of
5140	shared folders and stops sharing it.
5141
5142	<result name="VBOX_E_INVALID_VM_STATE">
5143	Virtual machine is not mutable.
5144	</result>
5145	<result name="VBOX_E_OBJECT_NOT_FOUND">
5146	Shared folder @a name does not exist.
5147	</result>
5148
5149	</desc>
5150	<param name="name" type="wstring" dir="in">
5151	<desc>Logical name of the shared folder to remove.</desc>
5152	</param>
5153	</method>
5154
5155	<method name="canShowConsoleWindow">
5156	<desc>
5157	Returns @c true if the VM console process can activate the
5158	console window and bring it to foreground on the desktop of
5159	the host PC.
5160	<note>
5161	This method will fail if a session for this machine is not
5162	currently open.
5163	</note>
5164
5165	<result name="VBOX_E_INVALID_VM_STATE">
5166	Machine session is not open.
5167	</result>
5168
5169	</desc>
5170	<param name="canShow" type="boolean" dir="return">
5171	<desc>
5172	@c true if the console window can be shown and @c false otherwise.
5173	</desc>
5174	</param>
5175	</method>
5176
5177	<method name="showConsoleWindow">
5178	<desc>
5179	Activates the console window and brings it to foreground on
5180	the desktop of the host PC. Many modern window managers on
5181	many platforms implement some sort of focus stealing
5182	prevention logic, so that it may be impossible to activate
5183	a window without the help of the currently active
5184	application. In this case, this method will return a non-zero
5185	identifier that represents the top-level window of the VM
5186	console process. The caller, if it represents a currently
5187	active process, is responsible to use this identifier (in a
5188	platform-dependent manner) to perform actual window
5189	activation.
5190	<note>
5191	This method will fail if a session for this machine is not
5192	currently open.
5193	</note>
5194
5195	<result name="VBOX_E_INVALID_VM_STATE">
5196	Machine session is not open.
5197	</result>
5198
5199	</desc>
5200	<param name="winId" type="unsigned long long" dir="return">
5201	<desc>
5202	Platform-dependent identifier of the top-level VM console
5203	window, or zero if this method has performed all actions
5204	necessary to implement the <i>show window</i> semantics for
5205	the given platform and/or VirtualBox front-end.
5206	</desc>
5207	</param>
5208	</method>
5209
5210	<method name="getGuestProperty">
5211	<desc>
5212	Reads an entry from the machine's guest property store.
5213
5214	<result name="VBOX_E_INVALID_VM_STATE">
5215	Machine session is not open.
5216	</result>
5217
5218	</desc>
5219	<param name="name" type="wstring" dir="in">
5220	<desc>
5221	The name of the property to read.
5222	</desc>
5223	</param>
5224	<param name="value" type="wstring" dir="out">
5225	<desc>
5226	The value of the property. If the property does not exist then this
5227	will be empty.
5228	</desc>
5229	</param>
5230	<param name="timestamp" type="unsigned long long" dir="out">
5231	<desc>
5232	The time at which the property was last modified, as seen by the
5233	server process.
5234	</desc>
5235	</param>
5236	<param name="flags" type="wstring" dir="out">
5237	<desc>
5238	Additional property parameters, passed as a comma-separated list of
5239	"name=value" type entries.
5240	</desc>
5241	</param>
5242	</method>
5243
5244	<method name="getGuestPropertyValue">
5245	<desc>
5246	Reads a value from the machine's guest property store.
5247
5248	<result name="VBOX_E_INVALID_VM_STATE">
5249	Machine session is not open.
5250	</result>
5251
5252	</desc>
5253	<param name="property" type="wstring" dir="in">
5254	<desc>
5255	The name of the property to read.
5256	</desc>
5257	</param>
5258	<param name="value" type="wstring" dir="return">
5259	<desc>
5260	The value of the property. If the property does not exist then this
5261	will be empty.
5262	</desc>
5263	</param>
5264	</method>
5265
5266	<method name="getGuestPropertyTimestamp">
5267	<desc>
5268	Reads a property timestamp from the machine's guest property store.
5269
5270	<result name="VBOX_E_INVALID_VM_STATE">
5271	Machine session is not open.
5272	</result>
5273
5274	</desc>
5275	<param name="property" type="wstring" dir="in">
5276	<desc>
5277	The name of the property to read.
5278	</desc>
5279	</param>
5280	<param name="value" type="unsigned long long" dir="return">
5281	<desc>
5282	The timestamp. If the property does not exist then this will be
5283	empty.
5284	</desc>
5285	</param>
5286	</method>
5287
5288	<method name="setGuestProperty">
5289	<desc>
5290	Sets, changes or deletes an entry in the machine's guest property
5291	store.
5292
5293	<result name="E_ACCESSDENIED">
5294	Property cannot be changed.
5295	</result>
5296	<result name="E_INVALIDARG">
5297	Invalid @a flags.
5298	</result>
5299	<result name="VBOX_E_INVALID_VM_STATE">
5300	Virtual machine is not mutable or session not open.
5301	</result>
5302	<result name="VBOX_E_INVALID_OBJECT_STATE">
5303	Cannot set transient property when machine not running.
5304	</result>
5305
5306	</desc>
5307	<param name="property" type="wstring" dir="in">
5308	<desc>
5309	The name of the property to set, change or delete.
5310	</desc>
5311	</param>
5312	<param name="value" type="wstring" dir="in">
5313	<desc>
5314	The new value of the property to set, change or delete. If the
5315	property does not yet exist and value is non-empty, it will be
5316	created. If the value is @c null or empty, the property will be
5317	deleted if it exists.
5318	</desc>
5319	</param>
5320	<param name="flags" type="wstring" dir="in">
5321	<desc>
5322	Additional property parameters, passed as a comma-separated list of
5323	"name=value" type entries.
5324	</desc>
5325	</param>
5326	</method>
5327
5328	<method name="setGuestPropertyValue">
5329	<desc>
5330	Sets, changes or deletes a value in the machine's guest property
5331	store. The flags field will be left unchanged or created empty for a
5332	new property.
5333
5334	<result name="E_ACCESSDENIED">
5335	Property cannot be changed.
5336	</result>
5337	<result name="VBOX_E_INVALID_VM_STATE">
5338	Virtual machine is not mutable or session not open.
5339	</result>
5340	<result name="VBOX_E_INVALID_OBJECT_STATE">
5341	Cannot set transient property when machine not running.
5342	</result>
5343	</desc>
5344
5345	<param name="property" type="wstring" dir="in">
5346	<desc>
5347	The name of the property to set, change or delete.
5348	</desc>
5349	</param>
5350	<param name="value" type="wstring" dir="in">
5351	<desc>
5352	The new value of the property to set, change or delete. If the
5353	property does not yet exist and value is non-empty, it will be
5354	created. If the value is @c null or empty, the property will be
5355	deleted if it exists.
5356	</desc>
5357	</param>
5358	</method>
5359
5360	<method name="enumerateGuestProperties">
5361	<desc>
5362	Return a list of the guest properties matching a set of patterns along
5363	with their values, time stamps and flags.
5364	</desc>
5365	<param name="patterns" type="wstring" dir="in">
5366	<desc>
5367	The patterns to match the properties against, separated by '\|'
5368	characters. If this is empty or @c null, all properties will match.
5369	</desc>
5370	</param>
5371	<param name="name" type="wstring" dir="out" safearray="yes">
5372	<desc>
5373	The names of the properties returned.
5374	</desc>
5375	</param>
5376	<param name="value" type="wstring" dir="out" safearray="yes">
5377	<desc>
5378	The values of the properties returned. The array entries match the
5379	corresponding entries in the @a name array.
5380	</desc>
5381	</param>
5382	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5383	<desc>
5384	The time stamps of the properties returned. The array entries match
5385	the corresponding entries in the @a name array.
5386	</desc>
5387	</param>
5388	<param name="flags" type="wstring" dir="out" safearray="yes">
5389	<desc>
5390	The flags of the properties returned. The array entries match the
5391	corresponding entries in the @a name array.
5392	</desc>
5393	</param>
5394	</method>
5395	</interface>
5396
5397	<!--
5398	// IConsole
5399	/////////////////////////////////////////////////////////////////////////
5400	-->
5401
5402	<interface
5403	name="IConsoleCallback" extends="$unknown"
5404	uuid="db67f6e5-799d-474c-8452-b10d7736a412"
5405	wsmap="suppress"
5406	>
5407
5408	<desc>
5409	This interface is used by a client of the Main API that need to
5410	be notified of events. For example, a graphical user interface
5411	can use this to learn about machine state changes so they can
5412	update the list of virtual machines without having to rely
5413	on polling.
5414
5415	Whenever relevant events occur in VirtualBox, the callbacks in
5416	objects of this interface are called. In order for this to be
5417	useful, a client needs to create its own subclass that implements
5418	this interface in which the methods for the relevant callbacks
5419	are overridden. An instance of this subclass interface can then
5420	be passed to <link to="IConsole::registerCallback" />.
5421	</desc>
5422
5423	<method name="onMousePointerShapeChange">
5424	<desc>
5425	Notification when the guest mouse pointer shape has
5426	changed. The new shape data is given.
5427	</desc>
5428	<param name="visible" type="boolean" dir="in">
5429	<desc>
5430	Flag whether the pointer is visible.
5431	</desc>
5432	</param>
5433	<param name="alpha" type="boolean" dir="in">
5434	<desc>
5435	Flag whether the pointer has an alpha channel.
5436	</desc>
5437	</param>
5438	<param name="xHot" type="unsigned long" dir="in">
5439	<desc>
5440	The pointer hot spot x coordinate.
5441	</desc>
5442	</param>
5443	<param name="yHot" type="unsigned long" dir="in">
5444	<desc>
5445	The pointer hot spot y coordinate.
5446	</desc>
5447	</param>
5448	<param name="width" type="unsigned long" dir="in">
5449	<desc>
5450	Width of the pointer shape in pixels.
5451	</desc>
5452	</param>
5453	<param name="height" type="unsigned long" dir="in">
5454	<desc>
5455	Height of the pointer shape in pixels.
5456	</desc>
5457	</param>
5458	<param name="shape" type="octet" mod="ptr" dir="in">
5459	<desc>
5460	Address of the shape buffer.
5461
5462	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
5463	followed by a 32-bpp XOR (color) mask.
5464
5465	For pointers without alpha channel the XOR mask pixels are 32
5466	bit values: (lsb)BGR0(msb). For pointers with alpha channel
5467	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
5468
5469	An AND mask is used for pointers with alpha channel, so if the
5470	callback does not support alpha, the pointer could be
5471	displayed as a normal color pointer.
5472
5473	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
5474	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
5475	height</tt>. The padding bits at the end of each scanline are
5476	undefined.
5477
5478	The XOR mask follows the AND mask on the next 4-byte aligned
5479	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
5480	Bytes in the gap between the AND and the XOR mask are undefined.
5481	The XOR mask scanlines have no gap between them and the size of
5482	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
5483
5484	<note>
5485	If @a shape is 0, only the pointer visibility is changed.
5486	</note>
5487	</desc>
5488	</param>
5489	</method>
5490
5491	<method name="onMouseCapabilityChange">
5492	<desc>
5493	Notification when the mouse capabilities reported by the
5494	guest have changed. The new capabilities are passed.
5495	</desc>
5496	<param name="supportsAbsolute" type="boolean" dir="in"/>
5497	<param name="needsHostCursor" type="boolean" dir="in"/>
5498	</method>
5499
5500	<method name="onKeyboardLedsChange">
5501	<desc>
5502	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
5503	to alter the state of the keyboard LEDs.
5504	</desc>
5505	<param name="numLock" type="boolean" dir="in"/>
5506	<param name="capsLock" type="boolean" dir="in"/>
5507	<param name="scrollLock" type="boolean" dir="in"/>
5508	</method>
5509
5510	<method name="onStateChange">
5511	<desc>
5512	Notification when the execution state of the machine has changed.
5513	The new state will be given.
5514	</desc>
5515	<param name="state" type="MachineState" dir="in"/>
5516	</method>
5517
5518	<method name="onAdditionsStateChange">
5519	<desc>
5520	Notification when a Guest Additions property changes.
5521	Interested callees should query IGuest attributes to
5522	find out what has changed.
5523	</desc>
5524	</method>
5525
5526	<method name="onNetworkAdapterChange">
5527	<desc>
5528	Notification when a property of one of the
5529	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
5530	changes. Interested callees should use INetworkAdapter methods and
5531	attributes to find out what has changed.
5532	</desc>
5533	<param name="networkAdapter" type="INetworkAdapter" dir="in">
5534	<desc>Network adapter that is subject to change.</desc>
5535	</param>
5536	</method>
5537
5538	<method name="onSerialPortChange">
5539	<desc>
5540	Notification when a property of one of the
5541	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
5542	Interested callees should use ISerialPort methods and attributes
5543	to find out what has changed.
5544	</desc>
5545	<param name="serialPort" type="ISerialPort" dir="in">
5546	<desc>Serial port that is subject to change.</desc>
5547	</param>
5548	</method>
5549
5550	<method name="onParallelPortChange">
5551	<desc>
5552	Notification when a property of one of the
5553	virtual <link to="IMachine::getParallelPort">parallel ports</link>
5554	changes. Interested callees should use ISerialPort methods and
5555	attributes to find out what has changed.
5556	</desc>
5557	<param name="parallelPort" type="IParallelPort" dir="in">
5558	<desc>Parallel port that is subject to change.</desc>
5559	</param>
5560	</method>
5561
5562	<method name="onStorageControllerChange">
5563	<desc>
5564	Notification when a property of one of the
5565	virtual <link to="IMachine::storageControllers">storage controllers</link>
5566	changes. Interested callees should query the corresponding collections
5567	to find out what has changed.
5568	</desc>
5569	</method>
5570
5571	<method name="onMediumChange">
5572	<desc>
5573	Notification when a
5574	<link to="IMachine::mediumAttachments">medium attachment</link>
5575	changes.
5576	</desc>
5577	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
5578	<desc>Medium attachment that is subject to change.</desc>
5579	</param>
5580	</method>
5581
5582	<method name="onVRDPServerChange">
5583	<desc>
5584	Notification when a property of the
5585	<link to="IMachine::VRDPServer">VRDP server</link> changes.
5586	Interested callees should use IVRDPServer methods and attributes to
5587	find out what has changed.
5588	</desc>
5589	</method>
5590
5591	<method name="onUSBControllerChange">
5592	<desc>
5593	Notification when a property of the virtual
5594	<link to="IMachine::USBController">USB controller</link> changes.
5595	Interested callees should use IUSBController methods and attributes to
5596	find out what has changed.
5597	</desc>
5598	</method>
5599
5600	<method name="onUSBDeviceStateChange">
5601	<desc>
5602	Notification when a USB device is attached to or detached from
5603	the virtual USB controller.
5604
5605	This notification is sent as a result of the indirect
5606	request to attach the device because it matches one of the
5607	machine USB filters, or as a result of the direct request
5608	issued by <link to="IConsole::attachUSBDevice"/> or
5609	<link to="IConsole::detachUSBDevice"/>.
5610
5611	This notification is sent in case of both a succeeded and a
5612	failed request completion. When the request succeeds, the
5613	@a error parameter is @c null, and the given device has been
5614	already added to (when @a attached is @c true) or removed from
5615	(when @a attached is @c false) the collection represented by
5616	<link to="IConsole::USBDevices"/>. On failure, the collection
5617	doesn't change and the @a error parameter represents the error
5618	message describing the failure.
5619
5620	</desc>
5621	<param name="device" type="IUSBDevice" dir="in">
5622	<desc>Device that is subject to state change.</desc>
5623	</param>
5624	<param name="attached" type="boolean" dir="in">
5625	<desc>
5626	@c true if the device was attached and @c false otherwise.
5627	</desc>
5628	</param>
5629	<param name="error" type="IVirtualBoxErrorInfo" dir="in">
5630	<desc>
5631	@c null on success or an error message object on failure.
5632	</desc>
5633	</param>
5634	</method>
5635
5636	<method name="onSharedFolderChange">
5637	<desc>
5638	Notification when a shared folder is added or removed.
5639	The @a scope argument defines one of three scopes:
5640	<link to="IVirtualBox::sharedFolders">global shared folders</link>
5641	(<link to="Scope_Global">Global</link>),
5642	<link to="IMachine::sharedFolders">permanent shared folders</link> of
5643	the machine (<link to="Scope_Machine">Machine</link>) or <link
5644	to="IConsole::sharedFolders">transient shared folders</link> of the
5645	machine (<link to="Scope_Session">Session</link>). Interested callees
5646	should use query the corresponding collections to find out what has
5647	changed.
5648	</desc>
5649	<param name="scope" type="Scope" dir="in">
5650	<desc>Scope of the notification.</desc>
5651	</param>
5652	</method>
5653
5654	<method name="onRuntimeError">
5655	<desc>
5656	Notification when an error happens during the virtual
5657	machine execution.
5658
5659	There are three kinds of runtime errors:
5660	<ul>
5661	<li><i>fatal</i></li>
5662	<li><i>non-fatal with retry</i></li>
5663	<li><i>non-fatal warnings</i></li>
5664	</ul>
5665
5666	<b>Fatal</b> errors are indicated by the @a fatal parameter set
5667	to @c true. In case of fatal errors, the virtual machine
5668	execution is always paused before calling this notification, and
5669	the notification handler is supposed either to immediately save
5670	the virtual machine state using <link to="IConsole::saveState"/>
5671	or power it off using <link to="IConsole::powerDown"/>.
5672	Resuming the execution can lead to unpredictable results.
5673
5674	<b>Non-fatal</b> errors and warnings are indicated by the
5675	@a fatal parameter set to @c false. If the virtual machine
5676	is in the Paused state by the time the error notification is
5677	received, it means that the user can <i>try to resume</i> the machine
5678	execution after attempting to solve the problem that caused the
5679	error. In this case, the notification handler is supposed
5680	to show an appropriate message to the user (depending on the
5681	value of the @a id parameter) that offers several actions such
5682	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
5683	wants to retry, the notification handler should continue
5684	the machine execution using the <link to="IConsole::resume"/>
5685	call. If the machine execution is not Paused during this
5686	notification, then it means this notification is a <i>warning</i>
5687	(for example, about a fatal condition that can happen very soon);
5688	no immediate action is required from the user, the machine
5689	continues its normal execution.
5690
5691	Note that in either case the notification handler
5692	<b>must not</b> perform any action directly on a thread
5693	where this notification is called. Everything it is allowed to
5694	do is to post a message to another thread that will then talk
5695	to the user and take the corresponding action.
5696
5697	Currently, the following error identifiers are known:
5698	<ul>
5699	<li><tt>"HostMemoryLow"</tt></li>
5700	<li><tt>"HostAudioNotResponding"</tt></li>
5701	<li><tt>"VDIStorageFull"</tt></li>
5702	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
5703	</ul>
5704
5705	<note>
5706	This notification is not designed to be implemented by
5707	more than one callback at a time. If you have multiple
5708	IConsoleCallback instances registered on the given
5709	IConsole object, make sure you simply do nothing but
5710	return @c S_OK from all but one of them that does actual
5711	user notification and performs necessary actions.
5712	</note>
5713
5714	</desc>
5715	<param name="fatal" type="boolean" dir="in">
5716	<desc>Whether the error is fatal or not</desc>
5717	</param>
5718	<param name="id" type="wstring" dir="in">
5719	<desc>Error identifier</desc>
5720	</param>
5721	<param name="message" type="wstring" dir="in">
5722	<desc>Optional error message</desc>
5723	</param>
5724	</method>
5725
5726	<method name="onCanShowWindow">
5727	<desc>
5728	Notification when a call to
5729	<link to="IMachine::canShowConsoleWindow"/> is made by a
5730	front-end to check if a subsequent call to
5731	<link to="IMachine::showConsoleWindow"/> can succeed.
5732
5733	The callee should give an answer appropriate to the current
5734	machine state in the @a canShow argument. This answer must
5735	remain valid at least until the next
5736	<link to="IConsole::state">machine state</link> change.
5737
5738	<note>
5739	This notification is not designed to be implemented by
5740	more than one callback at a time. If you have multiple
5741	IConsoleCallback instances registered on the given
5742	IConsole object, make sure you simply do nothing but
5743	return @c true and @c S_OK from all but one of them that
5744	actually manages console window activation.
5745	</note>
5746	</desc>
5747	<param name="canShow" type="boolean" dir="return">
5748	<desc>
5749	@c true if the console window can be shown and @c false otherwise.
5750	</desc>
5751	</param>
5752	</method>
5753
5754	<method name="onShowWindow">
5755	<desc>
5756	Notification when a call to
5757	<link to="IMachine::showConsoleWindow"/>
5758	requests the console window to be activated and brought to
5759	foreground on the desktop of the host PC.
5760
5761	This notification should cause the VM console process to
5762	perform the requested action as described above. If it is
5763	impossible to do it at a time of this notification, this
5764	method should return a failure.
5765
5766	Note that many modern window managers on many platforms
5767	implement some sort of focus stealing prevention logic, so
5768	that it may be impossible to activate a window without the
5769	help of the currently active application (which is supposedly
5770	an initiator of this notification). In this case, this method
5771	must return a non-zero identifier that represents the
5772	top-level window of the VM console process. The caller, if it
5773	represents a currently active process, is responsible to use
5774	this identifier (in a platform-dependent manner) to perform
5775	actual window activation.
5776
5777	This method must set @a winId to zero if it has performed all
5778	actions necessary to complete the request and the console
5779	window is now active and in foreground, to indicate that no
5780	further action is required on the caller's side.
5781
5782	<note>
5783	This notification is not designed to be implemented by
5784	more than one callback at a time. If you have multiple
5785	IConsoleCallback instances registered on the given
5786	IConsole object, make sure you simply do nothing but
5787	return @c S_OK from all but one of them that actually
5788	manages console window activation.
5789	</note>
5790	</desc>
5791	<param name="winId" type="unsigned long long" dir="return">
5792	<desc>
5793	Platform-dependent identifier of the top-level VM console
5794	window, or zero if this method has performed all actions
5795	necessary to implement the <i>show window</i> semantics for
5796	the given platform and/or this VirtualBox front-end.
5797	</desc>
5798	</param>
5799	</method>
5800
5801	</interface>
5802
5803	<interface
5804	name="IRemoteDisplayInfo" extends="$unknown"
5805	uuid="550104cd-2dfd-4a6c-857d-f6f8e088e62c"
5806	wsmap="struct"
5807	>
5808	<desc>
5809	Contains information about the remote display (VRDP) capabilities and status.
5810	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5811	</desc>
5812
5813	<attribute name="active" type="boolean" readonly="yes">
5814	<desc>
5815	Whether the remote display connection is active.
5816	</desc>
5817	</attribute>
5818
5819	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5820	<desc>
5821	How many times a client connected.
5822	</desc>
5823	</attribute>
5824
5825	<attribute name="beginTime" type="long long" readonly="yes">
5826	<desc>
5827	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5828	</desc>
5829	</attribute>
5830
5831	<attribute name="endTime" type="long long" readonly="yes">
5832	<desc>
5833	When the last connection was terminated or the current time, if
5834	connection is still active, in milliseconds since 1970-01-01 UTC.
5835	</desc>
5836	</attribute>
5837
5838	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
5839	<desc>
5840	How many bytes were sent in last or current, if still active, connection.
5841	</desc>
5842	</attribute>
5843
5844	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
5845	<desc>
5846	How many bytes were sent in all connections.
5847	</desc>
5848	</attribute>
5849
5850	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
5851	<desc>
5852	How many bytes were received in last or current, if still active, connection.
5853	</desc>
5854	</attribute>
5855
5856	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
5857	<desc>
5858	How many bytes were received in all connections.
5859	</desc>
5860	</attribute>
5861
5862	<attribute name="user" type="wstring" readonly="yes">
5863	<desc>
5864	Login user name supplied by the client.
5865	</desc>
5866	</attribute>
5867
5868	<attribute name="domain" type="wstring" readonly="yes">
5869	<desc>
5870	Login domain name supplied by the client.
5871	</desc>
5872	</attribute>
5873
5874	<attribute name="clientName" type="wstring" readonly="yes">
5875	<desc>
5876	The client name supplied by the client.
5877	</desc>
5878	</attribute>
5879
5880	<attribute name="clientIP" type="wstring" readonly="yes">
5881	<desc>
5882	The IP address of the client.
5883	</desc>
5884	</attribute>
5885
5886	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5887	<desc>
5888	The client software version number.
5889	</desc>
5890	</attribute>
5891
5892	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5893	<desc>
5894	Public key exchange method used when connection was established.
5895	Values: 0 - RDP4 public key exchange scheme.
5896	1 - X509 certificates were sent to client.
5897	</desc>
5898	</attribute>
5899
5900	</interface>
5901
5902	<interface
5903	name="IConsole" extends="$unknown"
5904	uuid="0a51994b-cbc6-4686-94eb-d4e4023280e2"
5905	wsmap="managed"
5906	>
5907	<desc>
5908	The IConsole interface represents an interface to control virtual
5909	machine execution.
5910
5911	The console object that implements the IConsole interface is obtained
5912	from a session object after the session for the given machine has been
5913	opened using one of <link to="IVirtualBox::openSession"/>,
5914	<link to="IVirtualBox::openRemoteSession"/> or
5915	<link to="IVirtualBox::openExistingSession"/> methods.
5916
5917	Methods of the IConsole interface allow the caller to query the current
5918	virtual machine execution state, pause the machine or power it down, save
5919	the machine state or take a snapshot, attach and detach removable media
5920	and so on.
5921
5922	<see>ISession</see>
5923	</desc>
5924
5925	<attribute name="machine" type="IMachine" readonly="yes">
5926	<desc>
5927	Machine object this console is sessioned with.
5928	<note>
5929	This is a convenience property, it has the same value as
5930	<link to="ISession::machine"/> of the corresponding session
5931	object.
5932	</note>
5933	</desc>
5934	</attribute>
5935
5936	<attribute name="state" type="MachineState" readonly="yes">
5937	<desc>
5938	Current execution state of the machine.
5939	<note>
5940	This property always returns the same value as the corresponding
5941	property of the IMachine object this console is sessioned with.
5942	For the process that owns (executes) the VM, this is the
5943	preferable way of querying the VM state, because no IPC
5944	calls are made.
5945	</note>
5946	</desc>
5947	</attribute>
5948
5949	<attribute name="guest" type="IGuest" readonly="yes">
5950	<desc>Guest object.</desc>
5951	</attribute>
5952
5953	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5954	<desc>
5955	Virtual keyboard object.
5956	<note>
5957	If the machine is not running, any attempt to use
5958	the returned object will result in an error.
5959	</note>
5960	</desc>
5961	</attribute>
5962
5963	<attribute name="mouse" type="IMouse" readonly="yes">
5964	<desc>
5965	Virtual mouse object.
5966	<note>
5967	If the machine is not running, any attempt to use
5968	the returned object will result in an error.
5969	</note>
5970	</desc>
5971	</attribute>
5972
5973	<attribute name="display" type="IDisplay" readonly="yes">
5974	<desc>Virtual display object.
5975	<note>
5976	If the machine is not running, any attempt to use
5977	the returned object will result in an error.
5978	</note>
5979	</desc>
5980	</attribute>
5981
5982	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5983	<desc>Debugging interface.</desc>
5984	</attribute>
5985
5986	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5987	<desc>
5988	Collection of USB devices currently attached to the virtual
5989	USB controller.
5990	<note>
5991	The collection is empty if the machine is not running.
5992	</note>
5993	</desc>
5994	</attribute>
5995
5996	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5997	<desc>
5998	List of USB devices currently attached to the remote VRDP client.
5999	Once a new device is physically attached to the remote host computer,
6000	it appears in this list and remains there until detached.
6001	</desc>
6002	</attribute>
6003
6004	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6005	<desc>
6006	Collection of shared folders for the current session. These folders
6007	are called transient shared folders because they are available to the
6008	guest OS running inside the associated virtual machine only for the
6009	duration of the session (as opposed to
6010	<link to="IMachine::sharedFolders"/> which represent permanent shared
6011	folders). When the session is closed (e.g. the machine is powered down),
6012	these folders are automatically discarded.
6013
6014	New shared folders are added to the collection using
6015	<link to="#createSharedFolder"/>. Existing shared folders can be
6016	removed using <link to="#removeSharedFolder"/>.
6017	</desc>
6018	</attribute>
6019
6020	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6021	<desc>
6022	Interface that provides information on Remote Display (VRDP) connection.
6023	</desc>
6024	</attribute>
6025
6026	<method name="powerUp">
6027	<desc>
6028	Starts the virtual machine execution using the current machine
6029	state (that is, its current execution state, current settings and
6030	current hard disks).
6031
6032	If the machine is powered off or aborted, the execution will
6033	start from the beginning (as if the real hardware were just
6034	powered on).
6035
6036	If the machine is in the <link to="MachineState_Saved"/> state,
6037	it will continue its execution the point where the state has
6038	been saved.
6039
6040	<note>
6041	Unless you are trying to write a new VirtualBox front-end that
6042	performs direct machine execution (like the VirtualBox or VBoxSDL
6043	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
6044	session opened by <link to="IVirtualBox::openSession"/> and use this
6045	session only to change virtual machine settings. If you simply want to
6046	start virtual machine execution using one of the existing front-ends
6047	(for example the VirtualBox GUI or headless server), simply use
6048	<link to="IVirtualBox::openRemoteSession"/>; these front-ends will
6049	power up the machine automatically for you.
6050	</note>
6051
6052	<see>#saveState</see>
6053	<result name="VBOX_E_INVALID_VM_STATE">
6054	Virtual machine already running.
6055	</result>
6056	<result name="VBOX_E_HOST_ERROR">
6057	Host interface does not exist or name not set.
6058	</result>
6059	<result name="VBOX_E_FILE_ERROR">
6060	Invalid saved state file.
6061	</result>
6062	</desc>
6063	<param name="progress" type="IProgress" dir="return">
6064	<desc>Progress object to track the operation completion.</desc>
6065	</param>
6066	</method>
6067
6068	<method name="powerUpPaused">
6069	<desc>
6070	Identical to powerUp except that the VM will enter the
6071	<link to="MachineState_Paused"/> state, instead of
6072	<link to="MachineState_Running"/>.
6073
6074	<see>#powerUp</see>
6075	<result name="VBOX_E_INVALID_VM_STATE">
6076	Virtual machine already running.
6077	</result>
6078	<result name="VBOX_E_HOST_ERROR">
6079	Host interface does not exist or name not set.
6080	</result>
6081	<result name="VBOX_E_FILE_ERROR">
6082	Invalid saved state file.
6083	</result>
6084	</desc>
6085	<param name="progress" type="IProgress" dir="return">
6086	<desc>Progress object to track the operation completion.</desc>
6087	</param>
6088	</method>
6089
6090	<method name="powerDown">
6091	<desc>
6092	Initiates the power down procedure to stop the virtual machine
6093	execution.
6094
6095	The completion of the power down procedure is tracked using the returned
6096	IProgress object. After the operation is complete, the machine will go
6097	to the PoweredOff state.
6098	<result name="VBOX_E_INVALID_VM_STATE">
6099	Virtual machine must be Running, Paused or Stuck to be powered down.
6100	</result>
6101	</desc>
6102	<param name="progress" type="IProgress" dir="return">
6103	<desc>Progress object to track the operation completion.</desc>
6104	</param>
6105	</method>
6106
6107	<method name="reset">
6108	<desc>Resets the virtual machine.
6109	<result name="VBOX_E_INVALID_VM_STATE">
6110	Virtual machine not in Running state.
6111	</result>
6112	<result name="VBOX_E_VM_ERROR">
6113	Virtual machine error in reset operation.
6114	</result>
6115	</desc>
6116	</method>
6117
6118	<method name="pause">
6119	<desc>Pauses the virtual machine execution.
6120	<result name="VBOX_E_INVALID_VM_STATE">
6121	Virtual machine not in Running state.
6122	</result>
6123	<result name="VBOX_E_VM_ERROR">
6124	Virtual machine error in suspend operation.
6125	</result>
6126	</desc>
6127	</method>
6128
6129	<method name="resume">
6130	<desc>Resumes the virtual machine execution.
6131	<result name="VBOX_E_INVALID_VM_STATE">
6132	Virtual machine not in Paused state.
6133	</result>
6134	<result name="VBOX_E_VM_ERROR">
6135	Virtual machine error in resume operation.
6136	</result>
6137	</desc>
6138	</method>
6139
6140	<method name="powerButton">
6141	<desc>Sends the ACPI power button event to the guest.
6142	<result name="VBOX_E_INVALID_VM_STATE">
6143	Virtual machine not in Running state.
6144	</result>
6145	<result name="VBOX_E_PDM_ERROR">
6146	Controlled power off failed.
6147	</result>
6148	</desc>
6149	</method>
6150
6151	<method name="sleepButton">
6152	<desc>Sends the ACPI sleep button event to the guest.
6153	<result name="VBOX_E_INVALID_VM_STATE">
6154	Virtual machine not in Running state.
6155	</result>
6156	<result name="VBOX_E_PDM_ERROR">
6157	Sending sleep button event failed.
6158	</result>
6159	</desc>
6160	</method>
6161
6162	<method name="getPowerButtonHandled">
6163	<desc>Checks if the last power button event was handled by guest.
6164	<result name="VBOX_E_PDM_ERROR">
6165	Checking if the event was handled by the guest OS failed.
6166	</result>
6167	</desc>
6168	<param name="handled" type="boolean" dir="return"/>
6169	</method>
6170
6171	<method name="getGuestEnteredACPIMode">
6172	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6173	G1 (sleeping). If this method returns @c false, the guest will
6174	most likely not respond to external ACPI events.
6175	<result name="VBOX_E_INVALID_VM_STATE">
6176	Virtual machine not in Running state.
6177	</result>
6178	</desc>
6179	<param name="entered" type="boolean" dir="return"/>
6180	</method>
6181
6182	<method name="saveState">
6183	<desc>
6184	Saves the current execution state of a running virtual machine
6185	and stops its execution.
6186
6187	After this operation completes, the machine will go to the
6188	Saved state. Next time it is powered up, this state will
6189	be restored and the machine will continue its execution from
6190	the place where it was saved.
6191
6192	This operation differs from taking a snapshot to the effect
6193	that it doesn't create new differencing media. Also, once
6194	the machine is powered up from the state saved using this method,
6195	the saved state is deleted, so it will be impossible to return
6196	to this state later.
6197
6198	<note>
6199	On success, this method implicitly calls
6200	<link to="IMachine::saveSettings"/> to save all current machine
6201	settings (including runtime changes to the DVD medium, etc.).
6202	Together with the impossibility to change any VM settings when it is
6203	in the Saved state, this guarantees adequate hardware
6204	configuration of the machine when it is restored from the saved
6205	state file.
6206	</note>
6207
6208	<note>
6209	The machine must be in the Running or Paused state, otherwise
6210	the operation will fail.
6211	</note>
6212	<result name="VBOX_E_INVALID_VM_STATE">
6213	Virtual machine state neither Running nor Paused.
6214	</result>
6215	<result name="VBOX_E_FILE_ERROR">
6216	Failed to create directory for saved state file.
6217	</result>
6218
6219	<see><link to="#takeSnapshot"/></see>
6220	</desc>
6221	<param name="progress" type="IProgress" dir="return">
6222	<desc>Progress object to track the operation completion.</desc>
6223	</param>
6224	</method>
6225
6226	<method name="adoptSavedState">
6227	<desc>
6228	Associates the given saved state file to the virtual machine.
6229
6230	On success, the machine will go to the Saved state. Next time it is
6231	powered up, it will be restored from the adopted saved state and
6232	continue execution from the place where the saved state file was
6233	created.
6234
6235	The specified saved state file path may be absolute or relative to the
6236	folder the VM normally saves the state to (usually,
6237	<link to="IMachine::snapshotFolder"/>).
6238
6239	<note>
6240	It's a caller's responsibility to make sure the given saved state
6241	file is compatible with the settings of this virtual machine that
6242	represent its virtual hardware (memory size, hard disk configuration
6243	etc.). If there is a mismatch, the behavior of the virtual machine
6244	is undefined.
6245	</note>
6246	<result name="VBOX_E_INVALID_VM_STATE">
6247	Virtual machine state neither PoweredOff nor Aborted.
6248	</result>
6249	</desc>
6250	<param name="savedStateFile" type="wstring" dir="in">
6251	<desc>Path to the saved state file to adopt.</desc>
6252	</param>
6253	</method>
6254
6255	<method name="forgetSavedState">
6256	<desc>
6257	Forgets the saved state of the virtual machine previously created
6258	by <link to="#saveState"/>. Next time the machine is powered up, a
6259	clean boot will occur. If @a remove is @c true the saved state file
6260	is deleted.
6261	<note>
6262	This operation is equivalent to resetting or powering off
6263	the machine without doing a proper shutdown in the guest OS.
6264	</note>
6265	<result name="VBOX_E_INVALID_VM_STATE">
6266	Virtual machine not in state Saved.
6267	</result>
6268	</desc>
6269	<param name="remove" type="boolean" dir="in">
6270	<desc>If @c true remove the saved state file.</desc>
6271	</param>
6272	</method>
6273
6274	<method name="getDeviceActivity">
6275	<desc>
6276	Gets the current activity type of a given device or device group.
6277	<result name="E_INVALIDARG">
6278	Invalid device type.
6279	</result>
6280	</desc>
6281	<param name="type" type="DeviceType" dir="in"/>
6282	<param name="activity" type="DeviceActivity" dir="return"/>
6283	</method>
6284
6285	<method name="attachUSBDevice">
6286	<desc>
6287	Attaches a host USB device with the given UUID to the
6288	USB controller of the virtual machine.
6289
6290	The device needs to be in one of the following states:
6291	<link to="USBDeviceState_Busy"/>,
6292	<link to="USBDeviceState_Available"/> or
6293	<link to="USBDeviceState_Held"/>,
6294	otherwise an error is immediately returned.
6295
6296	When the device state is
6297	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6298	be returned if the host computer refuses to release it for some reason.
6299
6300	<see>IUSBController::deviceFilters, USBDeviceState</see>
6301	<result name="VBOX_E_INVALID_VM_STATE">
6302	Virtual machine state neither Running nor Paused.
6303	</result>
6304	<result name="VBOX_E_PDM_ERROR">
6305	Virtual machine does not have a USB controller.
6306	</result>
6307	</desc>
6308	<param name="id" type="uuid" mod="string" dir="in">
6309	<desc>UUID of the host USB device to attach.</desc>
6310	</param>
6311	</method>
6312
6313	<method name="detachUSBDevice">
6314	<desc>
6315	Detaches an USB device with the given UUID from the USB controller
6316	of the virtual machine.
6317
6318	After this method succeeds, the VirtualBox server re-initiates
6319	all USB filters as if the device were just physically attached
6320	to the host, but filters of this machine are ignored to avoid
6321	a possible automatic re-attachment.
6322
6323	<see>IUSBController::deviceFilters, USBDeviceState</see>
6324
6325	<result name="VBOX_E_PDM_ERROR">
6326	Virtual machine does not have a USB controller.
6327	</result>
6328	<result name="E_INVALIDARG">
6329	USB device not attached to this virtual machine.
6330	</result>
6331	</desc>
6332	<param name="id" type="uuid" mod="string" dir="in">
6333	<desc>UUID of the USB device to detach.</desc>
6334	</param>
6335	<param name="device" type="IUSBDevice" dir="return">
6336	<desc>Detached USB device.</desc>
6337	</param>
6338	</method>
6339
6340	<method name="findUSBDeviceByAddress">
6341	<desc>
6342	Searches for a USB device with the given host address.
6343
6344	<result name="VBOX_E_OBJECT_NOT_FOUND">
6345	Given @c name does not correspond to any USB device.
6346	</result>
6347
6348	<see>IUSBDevice::address</see>
6349	</desc>
6350	<param name="name" type="wstring" dir="in">
6351	<desc>
6352	Address of the USB device (as assigned by the host) to
6353	search for.
6354	</desc>
6355	</param>
6356	<param name="device" type="IUSBDevice" dir="return">
6357	<desc>Found USB device object.</desc>
6358	</param>
6359	</method>
6360
6361	<method name="findUSBDeviceById">
6362	<desc>
6363	Searches for a USB device with the given UUID.
6364
6365	<result name="VBOX_E_OBJECT_NOT_FOUND">
6366	Given @c id does not correspond to any USB device.
6367	</result>
6368
6369	<see>IUSBDevice::id</see>
6370	</desc>
6371	<param name="id" type="uuid" mod="string" dir="in">
6372	<desc>UUID of the USB device to search for.</desc>
6373	</param>
6374	<param name="device" type="IUSBDevice" dir="return">
6375	<desc>Found USB device object.</desc>
6376	</param>
6377	</method>
6378
6379	<method name="createSharedFolder">
6380	<desc>
6381	Creates a transient new shared folder by associating the given logical
6382	name with the given host path, adds it to the collection of shared
6383	folders and starts sharing it. Refer to the description of
6384	<link to="ISharedFolder"/> to read more about logical names.
6385
6386	<result name="VBOX_E_INVALID_VM_STATE">
6387	Virtual machine in Saved state or currently changing state.
6388	</result>
6389	<result name="VBOX_E_FILE_ERROR">
6390	Shared folder already exists or not accessible.
6391	</result>
6392	</desc>
6393	<param name="name" type="wstring" dir="in">
6394	<desc>Unique logical name of the shared folder.</desc>
6395	</param>
6396	<param name="hostPath" type="wstring" dir="in">
6397	<desc>Full path to the shared folder in the host file system.</desc>
6398	</param>
6399	<param name="writable" type="boolean" dir="in">
6400	<desc>Whether the share is writable or readonly</desc>
6401	</param>
6402	</method>
6403
6404	<method name="removeSharedFolder">
6405	<desc>
6406	Removes a transient shared folder with the given name previously
6407	created by <link to="#createSharedFolder"/> from the collection of
6408	shared folders and stops sharing it.
6409	<result name="VBOX_E_INVALID_VM_STATE">
6410	Virtual machine in Saved state or currently changing state.
6411	</result>
6412	<result name="VBOX_E_FILE_ERROR">
6413	Shared folder does not exists.
6414	</result>
6415	</desc>
6416	<param name="name" type="wstring" dir="in">
6417	<desc>Logical name of the shared folder to remove.</desc>
6418	</param>
6419	</method>
6420
6421	<method name="takeSnapshot">
6422	<desc>
6423	Saves the current execution state
6424	and all settings of the machine and creates differencing images
6425	for all normal (non-independent) media.
6426	See <link to="ISnapshot" /> for an introduction to snapshots.
6427
6428	This method can be called for a PoweredOff, Saved (see
6429	<link to="#saveState"/>), Running or
6430	Paused virtual machine. When the machine is PoweredOff, an
6431	offline snapshot is created, an online snapshot otherwise.
6432
6433	The taken snapshot is always based on the
6434	<link to="IMachine::currentSnapshot">current snapshot</link>
6435	of the associated virtual machine and becomes a new current snapshot.
6436
6437	<note>
6438	This method implicitly calls <link to="IMachine::saveSettings"/> to
6439	save all current machine settings before taking an offline snapshot.
6440	</note>
6441
6442	<result name="VBOX_E_INVALID_VM_STATE">
6443	Virtual machine currently changing state.
6444	</result>
6445	</desc>
6446	<param name="name" type="wstring" dir="in">
6447	<desc>Short name for the snapshot.</desc>
6448	</param>
6449	<param name="description" type="wstring" dir="in">
6450	<desc>Optional description of the snapshot.</desc>
6451	</param>
6452	<param name="progress" type="IProgress" dir="return">
6453	<desc>Progress object to track the operation completion.</desc>
6454	</param>
6455	</method>
6456
6457	<method name="discardSnapshot">
6458	<desc>
6459	Starts discarding the specified snapshot asynchronously.
6460	See <link to="ISnapshot" /> for an introduction to snapshots.
6461
6462	The execution state
6463	and settings of the associated machine stored in the snapshot
6464	will be deleted. The contents of all differencing media of
6465	this snapshot will be merged with the contents of their
6466	dependent child media to keep the disks valid (in other
6467	words, all changes represented by media being discarded
6468	will be propagated to their child medium). After that, this
6469	snapshot's differencing medium will be deleted. The parent
6470	of this snapshot will become a new parent for all its child
6471	snapshots.
6472
6473	If the discarded snapshot is the current one, its parent
6474	snapshot will become a new current snapshot. The current machine
6475	state is not directly affected in this case, except that
6476	currently attached differencing media based on media
6477	of the discarded snapshot will be also merged as described
6478	above.
6479
6480	If the discarded snapshot is the first one (the root snapshot)
6481	and it has exactly one child snapshot, this child snapshot will
6482	become the first snapshot after discarding. If there are no
6483	children at all (i.e. the first snapshot is the only snapshot of
6484	the machine), both the current and the first snapshot of the
6485	machine will be set to @c null. In all other cases, the first
6486	snapshot cannot be discarded.
6487
6488	You cannot discard the snapshot if it
6489	stores <link to="MediumType_Normal">normal</link> (non-differencing)
6490	media that have differencing media based on them. Snapshots of
6491	such kind can be discarded only when every normal medium has either
6492	no children at all or exactly one child. In the former case, the normal
6493	medium simply becomes unused (i.e. not attached to any VM). In the
6494	latter case, it receives all the changes stored in the child medium,
6495	and then it replaces the child medium in the configuration of the
6496	corresponding snapshot or machine.
6497
6498	Also, you cannot discard the snapshot if it stores media
6499	(of any type) having differencing child media that belong
6500	to other machines. Such snapshots can be only discarded after
6501	you discard all snapshots of other machines containing "foreign"
6502	child disks, or detach these "foreign" child disks from machines
6503	they are attached to.
6504
6505	One particular example of the snapshot storing normal media
6506	is the first snapshot of a virtual machine that had normal media
6507	attached when taking the snapshot. Be careful when
6508	discarding such snapshots because this implicitly commits
6509	changes (made since the snapshot being discarded has been taken)
6510	to normal media (as described above), which may be not what
6511	you want.
6512
6513	The virtual machine is put to
6514	the <link to="MachineState_Discarding">Discarding</link> state until
6515	the discard operation is completed.
6516
6517	<note>
6518	The machine must not be running, otherwise the operation
6519	will fail.
6520	</note>
6521
6522	<note>
6523	Child media of all normal media of the discarded snapshot
6524	must be accessible (see <link to="IMedium::state"/>) for this
6525	operation to succeed. In particular, this means that all virtual
6526	machines, whose media are directly or indirectly based on the
6527	media of discarded snapshot, must be powered off.
6528	</note>
6529	<note>
6530	Merging medium contents can be very time and disk space
6531	consuming, if these disks are big in size and have many
6532	children. However, if the snapshot being discarded is the last
6533	(head) snapshot on the branch, the operation will be rather
6534	quick.
6535	</note>
6536	<note>
6537	Note that discarding the current snapshot
6538	will implicitly call <link to="IMachine::saveSettings"/> to
6539	make all current machine settings permanent.
6540	</note>
6541	<result name="VBOX_E_INVALID_VM_STATE">
6542	Virtual machine is running.
6543	</result>
6544	</desc>
6545	<param name="id" type="uuid" mod="string" dir="in">
6546	<desc>UUID of the snapshot to discard.</desc>
6547	</param>
6548	<param name="progress" type="IProgress" dir="return">
6549	<desc>Progress object to track the operation completion.</desc>
6550	</param>
6551	</method>
6552
6553	<method name="discardCurrentState">
6554	<desc>
6555	Starts resetting the machine's current state to the state contained
6556	in the current snapshot, asynchronously. All current settings of the
6557	machine will be reset and changes stored in differencing media
6558	will be lost.
6559	See <link to="ISnapshot" /> for an introduction to snapshots.
6560
6561	After this operation is successfully completed, new empty differencing
6562	media are created for all normal media of the machine.
6563
6564	If the current snapshot of the machine is an online snapshot, the
6565	machine will go to the <link to="MachineState_Saved"> saved
6566	state</link>, so that the next time it is powered on, the execution
6567	state will be restored from the current snapshot.
6568
6569	<note>
6570	The machine must not be running, otherwise the operation will fail.
6571	</note>
6572
6573	<note>
6574	If the machine state is <link to="MachineState_Saved">Saved</link>
6575	prior to this operation, the saved state file will be implicitly
6576	discarded (as if <link to="IConsole::forgetSavedState"/> were
6577	called).
6578	</note>
6579
6580	<result name="VBOX_E_INVALID_VM_STATE">
6581	Virtual machine is running.
6582	</result>
6583	</desc>
6584	<param name="progress" type="IProgress" dir="return">
6585	<desc>Progress object to track the operation completion.</desc>
6586	</param>
6587	</method>
6588
6589	<method name="discardCurrentSnapshotAndState">
6590	<desc>
6591
6592	This method is equivalent to
6593	doing <link to="IConsole::discardSnapshot">discardSnapshot</link>
6594	(currentSnapshot.id(), progress) followed by
6595	<link to="IConsole::discardCurrentState"/>.
6596
6597	As a result, the machine will be fully restored from the
6598	snapshot preceding the current snapshot, while both the current
6599	snapshot and the current machine state will be discarded.
6600
6601	If the current snapshot is the first snapshot of the machine (i.e. it
6602	has the only snapshot), the current machine state will be
6603	discarded <b>before</b> discarding the snapshot. In other words, the
6604	machine will be restored from its last snapshot, before discarding
6605	it. This differs from performing a single
6606	<link to="IConsole::discardSnapshot"/> call (note that no
6607	<link to="IConsole::discardCurrentState"/> will be possible after it)
6608	to the effect that the latter will preserve the current state instead of
6609	discarding it.
6610
6611	Unless explicitly mentioned otherwise, all remarks and
6612	limitations of the above two methods also apply to this method.
6613
6614	<note>
6615	The machine must not be running, otherwise the operation
6616	will fail.
6617	</note>
6618
6619	<note>
6620	If the machine state is <link to="MachineState_Saved">Saved</link>
6621	prior to this operation, the saved state file will be implicitly
6622	discarded (as if <link to="#forgetSavedState"/> were
6623	called).
6624	</note>
6625
6626	<note>
6627	This method is more efficient than calling both of the above
6628	methods separately: it requires less IPC calls and provides
6629	a single progress object.
6630	</note>
6631
6632	<result name="VBOX_E_INVALID_VM_STATE">
6633	Virtual machine is running.
6634	</result>
6635	</desc>
6636	<param name="progress" type="IProgress" dir="return">
6637	<desc>Progress object to track the operation completion.</desc>
6638	</param>
6639	</method>
6640
6641	<method name="registerCallback">
6642	<desc>
6643	Registers a new console callback on this instance. The methods of the
6644	callback interface will be called by this instance when the appropriate
6645	event occurs.
6646	</desc>
6647	<param name="callback" type="IConsoleCallback" dir="in"/>
6648	</method>
6649
6650	<method name="unregisterCallback">
6651	<desc>
6652	Unregisters the console callback previously registered using
6653	<link to="#registerCallback"/>.
6654	<result name="E_INVALIDARG">
6655	Given @a callback handler is not registered.
6656	</result>
6657	</desc>
6658	<param name="callback" type="IConsoleCallback" dir="in"/>
6659	</method>
6660	</interface>
6661
6662	<!--
6663	// IHost
6664	/////////////////////////////////////////////////////////////////////////
6665	-->
6666
6667	<enum
6668	name="HostNetworkInterfaceMediumType"
6669	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6670	>
6671	<desc>
6672	Type of encapsulation. Ethernet encapsulation includes both wired and
6673	wireless Ethernet connections.
6674	<see>IHostNetworkInterface</see>
6675	</desc>
6676
6677	<const name="Unknown" value="0">
6678	<desc>
6679	The type of interface cannot be determined.
6680	</desc>
6681	</const>
6682	<const name="Ethernet" value="1">
6683	<desc>
6684	Ethernet frame encapsulation.
6685	</desc>
6686	</const>
6687	<const name="PPP" value="2">
6688	<desc>
6689	Point-to-point protocol encapsulation.
6690	</desc>
6691	</const>
6692	<const name="SLIP" value="3">
6693	<desc>
6694	Serial line IP encapsulation.
6695	</desc>
6696	</const>
6697	</enum>
6698
6699	<enum
6700	name="HostNetworkInterfaceStatus"
6701	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6702	>
6703	<desc>
6704	Current status of the interface.
6705	<see>IHostNetworkInterface</see>
6706	</desc>
6707
6708	<const name="Unknown" value="0">
6709	<desc>
6710	The state of interface cannot be determined.
6711	</desc>
6712	</const>
6713	<const name="Up" value="1">
6714	<desc>
6715	The interface is fully operational.
6716	</desc>
6717	</const>
6718	<const name="Down" value="2">
6719	<desc>
6720	The interface is not functioning.
6721	</desc>
6722	</const>
6723	</enum>
6724
6725	<enum
6726	name="HostNetworkInterfaceType"
6727	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6728	>
6729	<desc>
6730	Network interface type.
6731	</desc>
6732	<const name="Bridged" value="1"/>
6733	<const name="HostOnly" value="2"/>
6734	</enum>
6735
6736	<interface
6737	name="IHostNetworkInterface" extends="$unknown"
6738	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6739	wsmap="managed"
6740	>
6741	<desc>
6742	Represents one of host's network interfaces. IP V6 address and network
6743	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6744	separated by colons.
6745	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6746	</desc>
6747	<attribute name="name" type="wstring" readonly="yes">
6748	<desc>Returns the host network interface name.</desc>
6749	</attribute>
6750
6751	<attribute name="id" type="uuid" mod="string" readonly="yes">
6752	<desc>Returns the interface UUID.</desc>
6753	</attribute>
6754
6755	<attribute name="networkName" type="wstring" readonly="yes">
6756	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6757	</attribute>
6758
6759	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6760	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6761	</attribute>
6762
6763	<attribute name="IPAddress" type="wstring" readonly="yes">
6764	<desc>Returns the IP V4 address of the interface.</desc>
6765	</attribute>
6766
6767	<attribute name="networkMask" type="wstring" readonly="yes">
6768	<desc>Returns the network mask of the interface.</desc>
6769	</attribute>
6770
6771	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6772	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6773	</attribute>
6774
6775	<attribute name="IPV6Address" type="wstring" readonly="yes">
6776	<desc>Returns the IP V6 address of the interface.</desc>
6777	</attribute>
6778
6779	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6780	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6781	</attribute>
6782
6783	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6784	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6785	</attribute>
6786
6787	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6788	<desc>Type of protocol encapsulation used.</desc>
6789	</attribute>
6790
6791	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6792	<desc>Status of the interface.</desc>
6793	</attribute>
6794
6795	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6796	<desc>specifies the host interface type.</desc>
6797	</attribute>
6798
6799	<method name="enableStaticIpConfig">
6800	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6801	<param name="IPAddress" type="wstring" dir="in">
6802	<desc>
6803	IP address.
6804	</desc>
6805	</param>
6806	<param name="networkMask" type="wstring" dir="in">
6807	<desc>
6808	network mask.
6809	</desc>
6810	</param>
6811	</method>
6812
6813	<method name="enableStaticIpConfigV6">
6814	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6815	<param name="IPV6Address" type="wstring" dir="in">
6816	<desc>
6817	IP address.
6818	</desc>
6819	</param>
6820	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6821	<desc>
6822	network mask.
6823	</desc>
6824	</param>
6825	</method>
6826
6827	<method name="enableDynamicIpConfig">
6828	<desc>enables the dynamic IP configuration.</desc>
6829	</method>
6830
6831	<method name="dhcpRediscover">
6832	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6833	</method>
6834
6835	</interface>
6836
6837	<interface
6838	name="IHost" extends="$unknown"
6839	uuid="95522f11-1ecc-443b-9242-3af6b24d430c"
6840	wsmap="managed"
6841	>
6842	<desc>
6843	The IHost interface represents the physical machine that this VirtualBox
6844	installation runs on.
6845
6846	An object implementing this interface is returned by the
6847	<link to="IVirtualBox::host" /> attribute. This interface contains
6848	read-only information about the host's physical hardware (such as what
6849	processors and disks are available, what the host operating system is,
6850	and so on) and also allows for manipulating some of the host's hardware,
6851	such as global USB device filters and host interface networking.
6852
6853	</desc>
6854	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6855	<desc>List of DVD drives available on the host.</desc>
6856	</attribute>
6857
6858	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6859	<desc>List of floppy drives available on the host.</desc>
6860	</attribute>
6861
6862	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6863	<desc>
6864	List of USB devices currently attached to the host.
6865	Once a new device is physically attached to the host computer,
6866	it appears in this list and remains there until detached.
6867
6868	<note>
6869	If USB functionality is not available in the given edition of
6870	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6871	</note>
6872	</desc>
6873	</attribute>
6874
6875	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6876	<desc>
6877	List of USB device filters in action.
6878	When a new device is physically attached to the host computer,
6879	filters from this list are applied to it (in order they are stored
6880	in the list). The first matched filter will determine the
6881	<link to="IHostUSBDeviceFilter::action">action</link>
6882	performed on the device.
6883
6884	Unless the device is ignored by these filters, filters of all
6885	currently running virtual machines
6886	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6887
6888	<note>
6889	If USB functionality is not available in the given edition of
6890	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6891	</note>
6892
6893	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6894	</desc>
6895	</attribute>
6896
6897	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6898	<desc>List of host network interfaces currently defined on the host.</desc>
6899	</attribute>
6900
6901	<attribute name="processorCount" type="unsigned long" readonly="yes">
6902	<desc>Number of (logical) CPUs installed in the host system.</desc>
6903	</attribute>
6904
6905	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6906	<desc>Number of (logical) CPUs online in the host system.</desc>
6907	</attribute>
6908
6909	<method name="getProcessorSpeed">
6910	<desc>Query the (approximate) maximum speed of a specified host CPU in
6911	Megahertz.
6912	</desc>
6913	<param name="cpuId" type="unsigned long" dir="in">
6914	<desc>
6915	Identifier of the CPU.
6916	</desc>
6917	</param>
6918	<param name="speed" type="unsigned long" dir="return">
6919	<desc>
6920	Speed value. 0 is returned if value is not known or @a cpuId is
6921	invalid.
6922	</desc>
6923	</param>
6924	</method>
6925
6926	<method name="getProcessorFeature">
6927	<desc>Query whether a CPU feature is supported or not.</desc>
6928	<param name="feature" type="ProcessorFeature" dir="in">
6929	<desc>
6930	CPU Feature identifier.
6931	</desc>
6932	</param>
6933	<param name="supported" type="boolean" dir="return">
6934	<desc>
6935	Feature is supported or not.
6936	</desc>
6937	</param>
6938	</method>
6939
6940	<method name="getProcessorDescription">
6941	<desc>Query the model string of a specified host CPU.
6942	</desc>
6943	<param name="cpuId" type="unsigned long" dir="in">
6944	<desc>
6945	Identifier of the CPU.
6946	</desc>
6947	</param>
6948	<param name="description" type="wstring" dir="return">
6949	<desc>
6950	Model string. An empty string is returned if value is not known or
6951	@a cpuId is invalid.
6952	</desc>
6953	</param>
6954	</method>
6955
6956	<attribute name="memorySize" type="unsigned long" readonly="yes">
6957	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6958	</attribute>
6959
6960	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6961	<desc>Available system memory in the host system.</desc>
6962	</attribute>
6963
6964	<attribute name="operatingSystem" type="wstring" readonly="yes">
6965	<desc>Name of the host system's operating system.</desc>
6966	</attribute>
6967
6968	<attribute name="OSVersion" type="wstring" readonly="yes">
6969	<desc>Host operating system's version string.</desc>
6970	</attribute>
6971
6972	<attribute name="UTCTime" type="long long" readonly="yes">
6973	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6974	</attribute>
6975
6976	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6977	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6978	</attribute>
6979
6980	<method name="createHostOnlyNetworkInterface">
6981	<desc>
6982	Creates a new adapter for Host Only Networking.
6983	<result name="E_INVALIDARG">
6984	Host network interface @a name already exists.
6985	</result>
6986	</desc>
6987	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6988	<desc>
6989	Created host interface object.
6990	</desc>
6991	</param>
6992	<param name="progress" type="IProgress" dir="return">
6993	<desc>
6994	Progress object to track the operation completion.
6995	</desc>
6996	</param>
6997	</method>
6998
6999	<method name="removeHostOnlyNetworkInterface">
7000	<desc>
7001	Removes the given Host Only Networking interface.
7002	<result name="VBOX_E_OBJECT_NOT_FOUND">
7003	No host network interface matching @a id found.
7004	</result>
7005	</desc>
7006	<param name="id" type="uuid" mod="string" dir="in">
7007	<desc>
7008	Adapter GUID.
7009	</desc>
7010	</param>
7011	<param name="progress" type="IProgress" dir="return">
7012	<desc>
7013	Progress object to track the operation completion.
7014	</desc>
7015	</param>
7016	</method>
7017
7018	<method name="createUSBDeviceFilter">
7019	<desc>
7020	Creates a new USB device filter. All attributes except
7021	the filter name are set to empty (any match),
7022	<i>active</i> is @c false (the filter is not active).
7023
7024	The created filter can be added to the list of filters using
7025	<link to="#insertUSBDeviceFilter"/>.
7026
7027	<see>#USBDeviceFilters</see>
7028	</desc>
7029	<param name="name" type="wstring" dir="in">
7030	<desc>
7031	Filter name. See <link to="IHostUSBDeviceFilter::name"/>
7032	for more info.
7033	</desc>
7034	</param>
7035	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7036	<desc>Created filter object.</desc>
7037	</param>
7038	</method>
7039
7040	<method name="insertUSBDeviceFilter">
7041	<desc>
7042	Inserts the given USB device to the specified position
7043	in the list of filters.
7044
7045	Positions are numbered starting from @c 0. If the specified
7046	position is equal to or greater than the number of elements in
7047	the list, the filter is added at the end of the collection.
7048
7049	<note>
7050	Duplicates are not allowed, so an attempt to insert a
7051	filter already in the list is an error.
7052	</note>
7053	<note>
7054	If USB functionality is not available in the given edition of
7055	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7056	</note>
7057
7058	<see>#USBDeviceFilters</see>
7059
7060	<result name="VBOX_E_INVALID_OBJECT_STATE">
7061	USB device filter is not created within this VirtualBox instance.
7062	</result>
7063	<result name="E_INVALIDARG">
7064	USB device filter already in list.
7065	</result>
7066
7067	</desc>
7068	<param name="position" type="unsigned long" dir="in">
7069	<desc>Position to insert the filter to.</desc>
7070	</param>
7071	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7072	<desc>USB device filter to insert.</desc>
7073	</param>
7074	</method>
7075
7076	<method name="removeUSBDeviceFilter">
7077	<desc>
7078	Removes a USB device filter from the specified position in the
7079	list of filters.
7080
7081	Positions are numbered starting from @c 0. Specifying a
7082	position equal to or greater than the number of elements in
7083	the list will produce an error.
7084
7085	<note>
7086	If USB functionality is not available in the given edition of
7087	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7088	</note>
7089
7090	<see>#USBDeviceFilters</see>
7091
7092	<result name="E_INVALIDARG">
7093	USB device filter list empty or invalid @a position.
7094	</result>
7095
7096	</desc>
7097	<param name="position" type="unsigned long" dir="in">
7098	<desc>Position to remove the filter from.</desc>
7099	</param>
7100	</method>
7101
7102	<method name="findHostDVDDrive">
7103	<desc>
7104	Searches for a host DVD drive with the given @c name.
7105
7106	<result name="VBOX_E_OBJECT_NOT_FOUND">
7107	Given @c name does not correspond to any host drive.
7108	</result>
7109
7110	</desc>
7111	<param name="name" type="wstring" dir="in">
7112	<desc>Name of the host drive to search for</desc>
7113	</param>
7114	<param name="drive" type="IMedium" dir="return">
7115	<desc>Found host drive object</desc>
7116	</param>
7117	</method>
7118
7119	<method name="findHostFloppyDrive">
7120	<desc>
7121	Searches for a host floppy drive with the given @c name.
7122
7123	<result name="VBOX_E_OBJECT_NOT_FOUND">
7124	Given @c name does not correspond to any host floppy drive.
7125	</result>
7126
7127	</desc>
7128	<param name="name" type="wstring" dir="in">
7129	<desc>Name of the host floppy drive to search for</desc>
7130	</param>
7131	<param name="drive" type="IMedium" dir="return">
7132	<desc>Found host floppy drive object</desc>
7133	</param>
7134	</method>
7135
7136	<method name="findHostNetworkInterfaceByName">
7137	<desc>
7138	Searches through all host network interfaces for an interface with
7139	the given @c name.
7140	<note>
7141	The method returns an error if the given @c name does not
7142	correspond to any host network interface.
7143	</note>
7144	</desc>
7145	<param name="name" type="wstring" dir="in">
7146	<desc>Name of the host network interface to search for.</desc>
7147	</param>
7148	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7149	<desc>Found host network interface object.</desc>
7150	</param>
7151	</method>
7152	<method name="findHostNetworkInterfaceById">
7153	<desc>
7154	Searches through all host network interfaces for an interface with
7155	the given GUID.
7156	<note>
7157	The method returns an error if the given GUID does not
7158	correspond to any host network interface.
7159	</note>
7160	</desc>
7161	<param name="id" type="uuid" mod="string" dir="in">
7162	<desc>GUID of the host network interface to search for.</desc>
7163	</param>
7164	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7165	<desc>Found host network interface object.</desc>
7166	</param>
7167	</method>
7168	<method name="findHostNetworkInterfacesOfType">
7169	<desc>
7170	Searches through all host network interfaces and returns a list of interfaces of the specified type
7171	</desc>
7172	<param name="type" type="HostNetworkInterfaceType" dir="in">
7173	<desc>type of the host network interfaces to search for.</desc>
7174	</param>
7175	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7176	<desc>Found host network interface objects.</desc>
7177	</param>
7178	</method>
7179
7180	<method name="findUSBDeviceById">
7181	<desc>
7182	Searches for a USB device with the given UUID.
7183
7184	<result name="VBOX_E_OBJECT_NOT_FOUND">
7185	Given @c id does not correspond to any USB device.
7186	</result>
7187
7188	<see>IHostUSBDevice::id</see>
7189	</desc>
7190	<param name="id" type="uuid" mod="string" dir="in">
7191	<desc>UUID of the USB device to search for.</desc>
7192	</param>
7193	<param name="device" type="IHostUSBDevice" dir="return">
7194	<desc>Found USB device object.</desc>
7195	</param>
7196	</method>
7197
7198	<method name="findUSBDeviceByAddress">
7199	<desc>
7200	Searches for a USB device with the given host address.
7201
7202	<result name="VBOX_E_OBJECT_NOT_FOUND">
7203	Given @c name does not correspond to any USB device.
7204	</result>
7205
7206	<see>IHostUSBDevice::address</see>
7207	</desc>
7208	<param name="name" type="wstring" dir="in">
7209	<desc>
7210	Address of the USB device (as assigned by the host) to
7211	search for.
7212	</desc>
7213	</param>
7214	<param name="device" type="IHostUSBDevice" dir="return">
7215	<desc>Found USB device object.</desc>
7216	</param>
7217	</method>
7218
7219	</interface>
7220
7221	<!--
7222	// ISystemProperties
7223	/////////////////////////////////////////////////////////////////////////
7224	-->
7225
7226	<interface
7227	name="ISystemProperties"
7228	extends="$unknown"
7229	uuid="79a8bc4d-24a5-4258-a0a6-8c36f8a68a4b"
7230	wsmap="managed"
7231	>
7232	<desc>
7233	The ISystemProperties interface represents global properties of the given
7234	VirtualBox installation.
7235
7236	These properties define limits and default values for various attributes
7237	and parameters. Most of the properties are read-only, but some can be
7238	changed by a user.
7239	</desc>
7240
7241	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7242	<desc>Minimum guest system memory in Megabytes.</desc>
7243	</attribute>
7244
7245	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7246	<desc>Maximum guest system memory in Megabytes.</desc>
7247	</attribute>
7248
7249	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7250	<desc>Minimum guest video memory in Megabytes.</desc>
7251	</attribute>
7252
7253	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7254	<desc>Maximum guest video memory in Megabytes.</desc>
7255	</attribute>
7256
7257	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7258	<desc>Minimum CPU count.</desc>
7259	</attribute>
7260
7261	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7262	<desc>Maximum CPU count.</desc>
7263	</attribute>
7264
7265	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7266	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7267	</attribute>
7268
7269	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7270	<desc>
7271	Number of network adapters associated with every
7272	<link to="IMachine"/> instance.
7273	</desc>
7274	</attribute>
7275
7276	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7277	<desc>
7278	Number of serial ports associated with every
7279	<link to="IMachine"/> instance.
7280	</desc>
7281	</attribute>
7282
7283	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7284	<desc>
7285	Number of parallel ports associated with every
7286	<link to="IMachine"/> instance.
7287	</desc>
7288	</attribute>
7289
7290	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7291	<desc>
7292	Maximum device position in the boot order. This value corresponds
7293	to the total number of devices a machine can boot from, to make it
7294	possible to include all possible devices to the boot list.
7295	<see><link to="IMachine::setBootOrder"/></see>
7296	</desc>
7297	</attribute>
7298
7299	<attribute name="defaultMachineFolder" type="wstring">
7300	<desc>
7301	Full path to the default directory used to create new or open
7302	existing machines when a settings file name contains no
7303	path.
7304
7305	The initial value of this property is
7306	<tt><</tt><link to="IVirtualBox::homeFolder">
7307	VirtualBox_home</link><tt>>/Machines</tt>.
7308
7309	<note>
7310	Setting this property to @c null or an empty string will restore the
7311	initial value.
7312	</note>
7313	<note>
7314	When settings this property, the specified path can be
7315	absolute (full path) or relative
7316	to the <link to="IVirtualBox::homeFolder">
7317	VirtualBox home directory</link>.
7318	When reading this property, a full path is
7319	always returned.
7320	</note>
7321	<note>
7322	The specified path may not exist, it will be created
7323	when necessary.
7324	</note>
7325
7326	<see>
7327	<link to="IVirtualBox::createMachine"/>,
7328	<link to="IVirtualBox::openMachine"/>
7329	</see>
7330	</desc>
7331	</attribute>
7332
7333	<attribute name="defaultHardDiskFolder" type="wstring">
7334	<desc>
7335	Full path to the default directory used to create new or open existing
7336	virtual disks.
7337
7338	This path is used when the storage unit of a hard disk is a regular file
7339	in the host's file system and only a file name that contains no path is
7340	given.
7341
7342	The initial value of this property is
7343	<tt><</tt>
7344	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7345	<tt>>/HardDisks</tt>.
7346
7347	<note>
7348	Setting this property to @c null or empty string will restore the
7349	initial value.
7350	</note>
7351	<note>
7352	When settings this property, the specified path can be relative
7353	to the
7354	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7355	absolute. When reading this property, a full path is
7356	always returned.
7357	</note>
7358	<note>
7359	The specified path may not exist, it will be created
7360	when necessary.
7361	</note>
7362
7363	<see>
7364	IMedium,
7365	<link to="IVirtualBox::createHardDisk"/>,
7366	<link to="IVirtualBox::openHardDisk"/>,
7367	<link to="IMedium::location"/>
7368	</see>
7369	</desc>
7370	</attribute>
7371
7372	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7373	<desc>
7374	List of all medium storage formats supported by this VirtualBox
7375	installation.
7376
7377	Keep in mind that the medium format identifier
7378	(<link to="IMediumFormat::id"/>) used in other API calls like
7379	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7380	medium format is a case-insensitive string. This means that, for
7381	example, all of the following strings:
7382	<pre>
7383	"VDI"
7384	"vdi"
7385	"VdI"</pre>
7386	refer to the same medium format.
7387
7388	Note that the virtual medium framework is backend-based, therefore
7389	the list of supported formats depends on what backends are currently
7390	installed.
7391
7392	<see>
7393	<link to="IMediumFormat"/>,
7394	</see>
7395	</desc>
7396	</attribute>
7397
7398	<attribute name="defaultHardDiskFormat" type="wstring">
7399	<desc>
7400	Identifier of the default medium format used by VirtualBox.
7401
7402	The medium format set by this attribute is used by VirtualBox
7403	when the medium format was not specified explicitly. One example is
7404	<link to="IVirtualBox::createHardDisk"/> with the empty
7405	format argument. A more complex example is implicit creation of
7406	differencing media when taking a snapshot of a virtual machine:
7407	this operation will try to use a format of the parent medium first
7408	and if this format does not support differencing media the default
7409	format specified by this argument will be used.
7410
7411	The list of supported medium formats may be obtained by the
7412	<link to="#mediaFormats"/> call. Note that the default medium
7413	format must have a capability to create differencing media;
7414	otherwise operations that create media implicitly may fail
7415	unexpectedly.
7416
7417	The initial value of this property is <tt>"VDI"</tt> in the current
7418	version of the VirtualBox product, but may change in the future.
7419
7420	<note>
7421	Setting this property to @c null or empty string will restore the
7422	initial value.
7423	</note>
7424
7425	<see>
7426	<link to="#mediaFormats"/>,
7427	<link to="IMediumFormat::id"/>,
7428	<link to="IVirtualBox::createHardDisk"/>
7429	</see>
7430	</desc>
7431	</attribute>
7432
7433	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7434	<desc>
7435	Library that provides authentication for VRDP clients. The library
7436	is used if a virtual machine's authentication type is set to "external"
7437	in the VM RemoteDisplay configuration.
7438
7439	The system library extension (".DLL" or ".so") must be omitted.
7440	A full path can be specified; if not, then the library must reside on the
7441	system's default library path.
7442
7443	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7444	of that name in one of the default VirtualBox library directories.
7445
7446	For details about VirtualBox authentication libraries and how to implement
7447	them, please refer to the VirtualBox manual.
7448
7449	<note>
7450	Setting this property to @c null or empty string will restore the
7451	initial value.
7452	</note>
7453	</desc>
7454	</attribute>
7455
7456	<attribute name="webServiceAuthLibrary" type="wstring">
7457	<desc>
7458	Library that provides authentication for webservice clients. The library
7459	is used if a virtual machine's authentication type is set to "external"
7460	in the VM RemoteDisplay configuration and will be called from
7461	within the <link to="IWebsessionManager::logon" /> implementation.
7462
7463	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7464	there is no per-VM setting for this, as the webservice is a global
7465	resource (if it is running). Only for this setting (for the webservice),
7466	setting this value to a literal <tt>"null"</tt> string disables authentication,
7467	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7468	no matter what user name and password are supplied.
7469
7470	The initial value of this property is <tt>"VRDPAuth"</tt>,
7471	meaning that the webservice will use the same authentication
7472	library that is used by default for VBoxVRDP (again, see
7473	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7474	The format and calling convention of authentication libraries
7475	is the same for the webservice as it is for VBoxVRDP.
7476
7477	<note>
7478	Setting this property to @c null or empty string will restore the
7479	initial value.
7480	</note>
7481	</desc>
7482	</attribute>
7483
7484	<attribute name="LogHistoryCount" type="unsigned long">
7485	<desc>
7486	This value specifies how many old release log files are kept.
7487	</desc>
7488	</attribute>
7489
7490	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7491	<desc>This value hold the default audio driver for the current
7492	system.</desc>
7493	</attribute>
7494
7495	<method name="getMaxDevicesPerPortForStorageBus">
7496	<desc>Returns the maximum number of devices which can be attached to a port
7497	for the given storage bus.</desc>
7498
7499	<param name="bus" type="StorageBus" dir="in">
7500	<desc>The storage bus type to get the value for.</desc>
7501	</param>
7502
7503	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7504	<desc>The maximum number of devices which can eb attached to the port for the given
7505	storage bus.</desc>
7506	</param>
7507	</method>
7508
7509	<method name="getMinPortCountForStorageBus">
7510	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7511
7512	<param name="bus" type="StorageBus" dir="in">
7513	<desc>The storage bus type to get the value for.</desc>
7514	</param>
7515
7516	<param name="minPortCount" type="unsigned long" dir="return">
7517	<desc>The minimum number of ports for the given storage bus.</desc>
7518	</param>
7519	</method>
7520
7521	<method name="getMaxPortCountForStorageBus">
7522	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7523
7524	<param name="bus" type="StorageBus" dir="in">
7525	<desc>The storage bus type to get the value for.</desc>
7526	</param>
7527
7528	<param name="maxPortCount" type="unsigned long" dir="return">
7529	<desc>The maximum number of ports for the given storage bus.</desc>
7530	</param>
7531	</method>
7532	</interface>
7533
7534	<!--
7535	// IGuest
7536	/////////////////////////////////////////////////////////////////////////
7537	-->
7538
7539	<interface
7540	name="IGuestOSType" extends="$unknown"
7541	uuid="cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
7542	wsmap="struct"
7543	>
7544	<desc>
7545	</desc>
7546
7547	<attribute name="familyId" type="wstring" readonly="yes">
7548	<desc>Guest OS family identifier string.</desc>
7549	</attribute>
7550
7551	<attribute name="familyDescription" type="wstring" readonly="yes">
7552	<desc>Human readable description of the guest OS family.</desc>
7553	</attribute>
7554
7555	<attribute name="id" type="wstring" readonly="yes">
7556	<desc>Guest OS identifier string.</desc>
7557	</attribute>
7558
7559	<attribute name="description" type="wstring" readonly="yes">
7560	<desc>Human readable description of the guest OS.</desc>
7561	</attribute>
7562
7563	<attribute name="is64Bit" type="boolean" readonly="yes">
7564	<desc>Returns @c true if the given OS is 64-bit</desc>
7565	</attribute>
7566
7567	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7568	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7569	</attribute>
7570
7571	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7572	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7573	</attribute>
7574
7575	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7576	<desc>Recommended RAM size in Megabytes.</desc>
7577	</attribute>
7578
7579	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7580	<desc>Recommended video RAM size in Megabytes.</desc>
7581	</attribute>
7582
7583	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7584	<desc>Recommended hard disk size in Megabytes.</desc>
7585	</attribute>
7586
7587	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7588	<desc>Returns recommended network adapter for this OS type.</desc>
7589	</attribute>
7590	</interface>
7591
7592	<interface
7593	name="IGuest" extends="$unknown"
7594	uuid="d8556fca-81bc-12af-fca3-365528fa38ca"
7595	wsmap="managed"
7596	>
7597	<desc>
7598	The IGuest interface represents information about the operating system
7599	running inside the virtual machine. Used in
7600	<link to="IConsole::guest"/>.
7601
7602	IGuest provides information about the guest operating system, whether
7603	Guest Additions are installed and other OS-specific virtual machine
7604	properties.
7605	</desc>
7606
7607	<attribute name="OSTypeId" type="wstring" readonly="yes">
7608	<desc>
7609	Identifier of the Guest OS type as reported by the Guest
7610	Additions.
7611	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7612	an IGuestOSType object representing details about the given
7613	Guest OS type.
7614	<note>
7615	If Guest Additions are not installed, this value will be
7616	the same as <link to="IMachine::OSTypeId"/>.
7617	</note>
7618	</desc>
7619	</attribute>
7620
7621	<attribute name="additionsActive" type="boolean" readonly="yes">
7622	<desc>
7623	Flag whether the Guest Additions are installed and active
7624	in which case their version will be returned by the
7625	<link to="#additionsVersion"/> property.
7626	</desc>
7627	</attribute>
7628
7629	<attribute name="additionsVersion" type="wstring" readonly="yes">
7630	<desc>
7631	Version of the Guest Additions (3 decimal numbers separated
7632	by dots) or empty when the Additions are not installed. The
7633	Additions may also report a version but yet not be active as
7634	the version might be refused by VirtualBox (incompatible) or
7635	other failures occurred.
7636	</desc>
7637	</attribute>
7638
7639	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7640	<desc>
7641	Flag whether seamless guest display rendering (seamless desktop
7642	integration) is supported.
7643	</desc>
7644	</attribute>
7645
7646	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7647	<desc>
7648	Flag whether the guest is in graphics mode. If it is not, then
7649	seamless rendering will not work, resize hints are not immediately
7650	acted on and guest display resizes are probably not initiated by
7651	the guest additions.
7652	</desc>
7653	</attribute>
7654
7655	<attribute name="memoryBalloonSize" type="unsigned long">
7656	<desc>Guest system memory balloon size in megabytes.</desc>
7657	</attribute>
7658
7659	<attribute name="statisticsUpdateInterval" type="unsigned long">
7660	<desc>Interval to update guest statistics in seconds.</desc>
7661	</attribute>
7662
7663	<method name="setCredentials">
7664	<desc>
7665	Store login credentials that can be queried by guest operating
7666	systems with Additions installed. The credentials are transient
7667	to the session and the guest may also choose to erase them. Note
7668	that the caller cannot determine whether the guest operating system
7669	has queried or made use of the credentials.
7670
7671	<result name="VBOX_E_VM_ERROR">
7672	VMM device is not available.
7673	</result>
7674
7675	</desc>
7676	<param name="userName" type="wstring" dir="in">
7677	<desc>User name string, can be empty</desc>
7678	</param>
7679	<param name="password" type="wstring" dir="in">
7680	<desc>Password string, can be empty</desc>
7681	</param>
7682	<param name="domain" type="wstring" dir="in">
7683	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7684	</param>
7685	<param name="allowInteractiveLogon" type="boolean" dir="in">
7686	<desc>
7687	Flag whether the guest should alternatively allow the user to
7688	interactively specify different credentials. This flag might
7689	not be supported by all versions of the Additions.
7690	</desc>
7691	</param>
7692	</method>
7693
7694	<method name="getStatistic">
7695	<desc>
7696	Query specified guest statistics as reported by the VirtualBox Additions.
7697	</desc>
7698	<param name="cpuId" type="unsigned long" dir="in">
7699	<desc>Virtual CPU id; not relevant for all statistic types</desc>
7700	</param>
7701	<param name="statistic" type="GuestStatisticType" dir="in">
7702	<desc>Statistic type.</desc>
7703	</param>
7704	<param name="statVal" type="unsigned long" dir="return">
7705	<desc>Statistics value</desc>
7706	</param>
7707	</method>
7708
7709	</interface>
7710
7711
7712	<!--
7713	// IProgress
7714	/////////////////////////////////////////////////////////////////////////
7715	-->
7716
7717	<interface
7718	name="IProgress" extends="$unknown"
7719	uuid="62827ef1-c098-40eb-be96-36d0508489a6"
7720	wsmap="managed"
7721	>
7722	<desc>
7723	The IProgress interface is used to track and control
7724	asynchronous tasks within VirtualBox.
7725
7726	An instance of this is returned every time VirtualBox starts
7727	an asynchronous task (in other words, a separate thread) which
7728	continues to run after a method call returns. For example,
7729	<link to="IConsole::saveState" />, which saves the state of
7730	a running virtual machine, can take a long time to complete.
7731	To be able to display a progress bar, a user interface such as
7732	the VirtualBox graphical user interface can use the IProgress
7733	object returned by that method.
7734
7735	Note that IProgress is a "read-only" interface in the sense
7736	that only the VirtualBox internals behind the Main API can
7737	create and manipulate progress objects, whereas client code
7738	can only use the IProgress object to monitor a task's
7739	progress and, if <link to="#cancelable" /> is @c true,
7740	cancel the task by calling <link to="#cancel" />.
7741
7742	A task represented by IProgress consists of either one or
7743	several sub-operations that run sequentially, one by one (see
7744	<link to="#operation" /> and <link to="#operationCount" />).
7745	Every operation is identified by a number (starting from 0)
7746	and has a separate description.
7747
7748	You can find the individual percentage of completion of the current
7749	operation in <link to="#operationPercent" /> and the
7750	percentage of completion of the task as a whole
7751	in <link to="#percent" />.
7752
7753	Similarly, you can wait for the completion of a particular
7754	operation via <link to="#waitForOperationCompletion" /> or
7755	for the completion of the whole task via
7756	<link to="#waitForCompletion" />.
7757	</desc>
7758
7759	<attribute name="id" type="uuid" mod="string" readonly="yes">
7760	<desc>ID of the task.</desc>
7761	</attribute>
7762
7763	<attribute name="description" type="wstring" readonly="yes">
7764	<desc>Description of the task.</desc>
7765	</attribute>
7766
7767	<attribute name="initiator" type="$unknown" readonly="yes">
7768	<desc>Initiator of the task.</desc>
7769	</attribute>
7770
7771	<attribute name="cancelable" type="boolean" readonly="yes">
7772	<desc>Whether the task can be interrupted.</desc>
7773	</attribute>
7774
7775	<attribute name="percent" type="unsigned long" readonly="yes">
7776	<desc>
7777	Current progress value of the task as a whole, in percent.
7778	This value depends on how many operations are already complete.
7779	Returns 100 if <link to="#completed" /> is @c true.
7780	</desc>
7781	</attribute>
7782
7783	<attribute name="timeRemaining" type="long" readonly="yes">
7784	<desc>
7785	Estimated remaining time until the task completes, in
7786	seconds. Returns 0 once the task has completed; returns -1
7787	if the remaining time cannot be computed, in particular if
7788	the current progress is 0.
7789
7790	Even if a value is returned, the estimate will be unreliable
7791	for low progress values. It will become more reliable as the
7792	task progresses; it is not recommended to display an ETA
7793	before at least 20% of a task have completed.
7794	</desc>
7795	</attribute>
7796
7797	<attribute name="completed" type="boolean" readonly="yes">
7798	<desc>Whether the task has been completed.</desc>
7799	</attribute>
7800
7801	<attribute name="canceled" type="boolean" readonly="yes">
7802	<desc>Whether the task has been canceled.</desc>
7803	</attribute>
7804
7805	<attribute name="resultCode" type="long" readonly="yes">
7806	<desc>
7807	Result code of the progress task.
7808	Valid only if <link to="#completed"/> is @c true.
7809	</desc>
7810	</attribute>
7811
7812	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
7813	<desc>
7814	Extended information about the unsuccessful result of the
7815	progress operation. May be @c null if no extended information
7816	is available.
7817	Valid only if <link to="#completed"/> is @c true and
7818	<link to="#resultCode"/> indicates a failure.
7819	</desc>
7820	</attribute>
7821
7822	<attribute name="operationCount" type="unsigned long" readonly="yes">
7823	<desc>
7824	Number of sub-operations this task is divided into.
7825	Every task consists of at least one suboperation.
7826	</desc>
7827	</attribute>
7828
7829	<attribute name="operation" type="unsigned long" readonly="yes">
7830	<desc>Number of the sub-operation being currently executed.</desc>
7831	</attribute>
7832
7833	<attribute name="operationDescription" type="wstring" readonly="yes">
7834	<desc>
7835	Description of the sub-operation being currently executed.
7836	</desc>
7837	</attribute>
7838
7839	<attribute name="operationPercent" type="unsigned long" readonly="yes">
7840	<desc>Progress value of the current sub-operation only, in percent.</desc>
7841	</attribute>
7842
7843	<method name="setCurrentOperationProgress">
7844	<desc>Internal method, not to be called externally.</desc>
7845	<param name="percent" type="unsigned long" dir="in" />
7846	</method>
7847	<method name="setNextOperation">
7848	<desc>Internal method, not to be called externally.</desc>
7849	<param name="nextOperationDescription" type="wstring" dir="in" />
7850	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
7851	</method>
7852
7853	<method name="waitForCompletion">
7854	<desc>
7855	Waits until the task is done (including all sub-operations)
7856	with a given timeout in milliseconds; specify -1 for an indefinite wait.
7857
7858	<result name="VBOX_E_IPRT_ERROR">
7859	Failed to wait for task completion.
7860	</result>
7861	</desc>
7862
7863	<param name="timeout" type="long" dir="in">
7864	<desc>
7865	Maximum time in milliseconds to wait or -1 to wait indefinitely.
7866	</desc>
7867	</param>
7868	</method>
7869
7870	<method name="waitForOperationCompletion">
7871	<desc>
7872	Waits until the given operation is done with a given timeout in
7873	milliseconds; specify -1 for an indefinite wait.
7874
7875	<result name="VBOX_E_IPRT_ERROR">
7876	Failed to wait for operation completion.
7877	</result>
7878
7879	</desc>
7880	<param name="operation" type="unsigned long" dir="in">
7881	<desc>
7882	Number of the operation to wait for.
7883	Must be less than <link to="#operationCount"/>.
7884	</desc>
7885	</param>
7886	<param name="timeout" type="long" dir="in">
7887	<desc>
7888	Maximum time in milliseconds to wait or -1 to wait indefinitely.
7889	</desc>
7890	</param>
7891	</method>
7892
7893	<method name="cancel">
7894	<desc>
7895	Cancels the task.
7896	<note>
7897	If <link to="#cancelable"/> is @c false, then this method will fail.
7898	</note>
7899
7900	<result name="VBOX_E_INVALID_OBJECT_STATE">
7901	Operation cannot be canceled.
7902	</result>
7903
7904	</desc>
7905	</method>
7906
7907	</interface>
7908
7909
7910	<!--
7911	// ISnapshot
7912	/////////////////////////////////////////////////////////////////////////
7913	-->
7914
7915	<interface
7916	name="ISnapshot" extends="$unknown"
7917	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
7918	wsmap="managed"
7919	>
7920	<desc>
7921	The ISnapshot interface represents a snapshot of the virtual
7922	machine.
7923
7924	Together with the differencing media that are created
7925	when a snapshot is taken, a machine can be brought back to
7926	the exact state it was in when the snapshot was taken.
7927
7928	The ISnapshot interface has no methods, only attributes; snapshots
7929	are controlled through methods of the <link to="IConsole" /> interface
7930	which also manage the media associated with the snapshot.
7931	The following operations exist:
7932
7933	<ul>
7934	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
7935	by creating new, empty differencing images for the machine's
7936	media and saving the VM settings and (if the VM is running)
7937	the current VM state in the snapshot.
7938
7939	The differencing images will then receive all data written to
7940	the machine's media, while their parent (base) images
7941	remain unmodified after the snapshot has been taken (see
7942	<link to="IMedium" /> for details about differencing images).
7943	This simplifies restoring a machine to the state of a snapshot:
7944	only the differencing images need to be deleted.
7945
7946	The current machine state is not changed by taking a snapshot.
7947	If the machine is running, it will resume execution after the
7948	snapshot has been taken.
7949	</li>
7950
7951	<li><link to="IConsole::discardCurrentState"/>: this goes back to
7952	a previous snapshot. This resets the machine's state to that of
7953	the previous snapshot by deleting the differencing image of each
7954	of the machine's media and setting the machine's settings
7955	and state to the state that was saved in the snapshot (if any).
7956
7957	This destroys the machine's current state.
7958	</li>
7959
7960	<li><link to="IConsole::discardSnapshot"/>: deletes a snapshot
7961	without affecting the current machine state.
7962
7963	This does not change the machine, but instead frees the resources
7964	allocated when the snapshot was taken: the settings and machine state
7965	is deleted (if any), and the snapshot's differencing image for each
7966	of the machine's media gets merged with its parent image.
7967
7968	Neither the current machine state nor other snapshots are affected
7969	by this operation, except that parent disk images will be modified
7970	to contain the disk data associated with the snapshot being deleted.
7971	</li>
7972
7973	<li><link to="IConsole::discardCurrentSnapshotAndState"/>:
7974	this completely reverts the virtual machine to the state it was in
7975	before the current snapshot has been taken. Effectively, this goes
7976	back to the state before the current snapshot, which might be
7977	an earlier snapshot.
7978
7979	The current state, as well as the current snapshot, are lost.
7980	</li>
7981	</ul>
7982
7983	Each snapshot contains the settings of the virtual machine (hardware
7984	configuration etc.). In addition, if the machine was running when the
7985	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
7986	the current VM state is saved in the snapshot (similarly to what happens
7987	when a VM's state is saved). The snapshot is then said to
7988	be <i>online</i> because when restoring it, the VM will be running.
7989
7990	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
7991	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
7992
7993	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
7994	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
7995	it then contains a so-called "zero execution state", representing a
7996	machine that is powered off.
7997
7998	<h3>Snapshot branches and the "current" snapshot</h3>
7999
8000	Snapshots can be chained, whereby every next snapshot is based on the
8001	previous one. This chaining is related to medium branching
8002	(see the <link to="IMedium"/> description) in that every time
8003	a new snapshot is created, a new differencing medium is implicitly
8004	created for all normal media attached to the machine.
8005
8006	Each virtual machine has a "current snapshot", identified by
8007	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8008	to the last snapshot in the chain. In a future version of VirtualBox,
8009	it will be possible to reset a machine's current state to that of an
8010	earlier snapshot without discarding the current state so that it will be
8011	possible to create alternative snapshot paths in a snapshot tree.
8012
8013	In the current implementation, multiple snapshot branches within one
8014	virtual machine are not allowed. Every machine has a single branch,
8015	and <link to="IConsole::takeSnapshot"/> operation adds a new
8016	snapshot to the top of that branch.
8017	</desc>
8018
8019	<attribute name="id" type="uuid" mod="string" readonly="yes">
8020	<desc>UUID of the snapshot.</desc>
8021	</attribute>
8022
8023	<attribute name="name" type="wstring">
8024	<desc>Short name of the snapshot.</desc>
8025	</attribute>
8026
8027	<attribute name="description" type="wstring">
8028	<desc>Optional description of the snapshot.</desc>
8029	</attribute>
8030
8031	<attribute name="timeStamp" type="long long" readonly="yes">
8032	<desc>
8033	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8034	</desc>
8035	</attribute>
8036
8037	<attribute name="online" type="boolean" readonly="yes">
8038	<desc>
8039	@c true if this snapshot is an online snapshot and @c false otherwise.
8040
8041	When this attribute is @c true, the
8042	<link to="IMachine::stateFilePath"/> attribute of the
8043	<link to="#machine"/> object associated with this snapshot
8044	will point to the saved state file. Otherwise, it will be
8045	an empty string.
8046	</desc>
8047	</attribute>
8048
8049	<attribute name="machine" type="IMachine" readonly="yes">
8050	<desc>
8051	Virtual machine this snapshot is taken on. This object
8052	stores all settings the machine had when taking this snapshot.
8053	<note>
8054	The returned machine object is immutable, i.e. no
8055	any settings can be changed.
8056	</note>
8057	</desc>
8058	</attribute>
8059
8060	<attribute name="parent" type="ISnapshot" readonly="yes">
8061	<desc>
8062	Parent snapshot (a snapshot this one is based on), or
8063	@c null if the snapshot has no parent.
8064	</desc>
8065	</attribute>
8066
8067	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8068	<desc>
8069	Child snapshots (all snapshots having this one as a parent).
8070	<note>
8071	In the current implementation, there can be only one
8072	child snapshot, or no children at all, meaning this is the
8073	last (head) snapshot.
8074	</note>
8075	</desc>
8076	</attribute>
8077
8078	</interface>
8079
8080
8081	<!--
8082	// IMedium
8083	/////////////////////////////////////////////////////////////////////////
8084	-->
8085
8086	<enum
8087	name="MediumState"
8088	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8089	>
8090	<desc>
8091	Virtual medium state.
8092	<see>IMedium</see>
8093	</desc>
8094
8095	<const name="NotCreated" value="0">
8096	<desc>
8097	Associated medium storage does not exist (either was not created yet or
8098	was deleted).
8099	</desc>
8100	</const>
8101	<const name="Created" value="1">
8102	<desc>
8103	Associated storage exists and accessible.
8104	</desc>
8105	</const>
8106	<const name="LockedRead" value="2">
8107	<desc>
8108	Medium is locked for reading, no data modification is possible.
8109	</desc>
8110	</const>
8111	<const name="LockedWrite" value="3">
8112	<desc>
8113	Medium is locked for writing, no concurrent data reading or modification
8114	is possible.
8115	</desc>
8116	</const>
8117	<const name="Inaccessible" value="4">
8118	<desc>
8119	Associated medium storage is not accessible.
8120	</desc>
8121	</const>
8122	<const name="Creating" value="5">
8123	<desc>
8124	Associated medium storage is being created.
8125	</desc>
8126	</const>
8127	<const name="Deleting" value="6">
8128	<desc>
8129	Associated medium storage is being deleted.
8130	</desc>
8131	</const>
8132	</enum>
8133
8134	<enum
8135	name="MediumType"
8136	uuid="11f6f7a5-0327-409a-9d42-7db6a0cec578"
8137	>
8138	<desc>
8139	Virtual medium type.
8140	<see>IMedium</see>
8141	</desc>
8142
8143	<const name="Normal" value="0">
8144	<desc>
8145	Normal medium (attached directly or indirectly, preserved
8146	when taking snapshots).
8147	</desc>
8148	</const>
8149	<const name="Immutable" value="1">
8150	<desc>
8151	Immutable medium (attached indirectly, changes are wiped out
8152	after powering off the virtual machine).
8153	</desc>
8154	</const>
8155	<const name="Writethrough" value="2">
8156	<desc>
8157	Write through medium (attached directly, ignored when
8158	taking snapshots).
8159	</desc>
8160	</const>
8161	</enum>
8162
8163	<enum
8164	name="MediumVariant"
8165	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8166	>
8167	<desc>
8168	Virtual medium image variant. More than one flag may be set.
8169	<see>IMedium</see>
8170	</desc>
8171
8172	<const name="Standard" value="0">
8173	<desc>
8174	No particular variant requested, results in using the backend default.
8175	</desc>
8176	</const>
8177	<const name="VmdkSplit2G" value="0x01">
8178	<desc>
8179	VMDK image split in chunks of less than 2GByte.
8180	</desc>
8181	</const>
8182	<const name="VmdkStreamOptimized" value="0x04">
8183	<desc>
8184	VMDK streamOptimized image. Special import/export format which is
8185	read-only/append-only.
8186	</desc>
8187	</const>
8188	<const name="VmdkESX" value="0x08">
8189	<desc>
8190	VMDK format variant used on ESX products.
8191	</desc>
8192	</const>
8193	<const name="Fixed" value="0x10000">
8194	<desc>
8195	Fixed image. Only allowed for base images.
8196	</desc>
8197	</const>
8198	<const name="Diff" value="0x20000">
8199	<desc>
8200	Fixed image. Only allowed for base images.
8201	</desc>
8202	</const>
8203	</enum>
8204
8205	<interface
8206	name="IMediumAttachment" extends="$unknown"
8207	uuid="0dcf987b-a024-453f-bace-7eb9f885a413"
8208	wsmap="struct"
8209	>
8210	<desc>
8211	The IMediumAttachment interface represents the attachment
8212	of a storage medium to a virtual machine. Each machine contains
8213	an array of its medium attachments in <link to="IMachine::mediumAttachments"/>.
8214
8215	Each medium attachment specifies a storage controller as well as a port
8216	and device number. Fixed media (hard disks) will always also specify
8217	an instance of IMedium in <link to="#medium" />, referring to the hard disk
8218	image or images that represent the virtual hard disk. For removeable media,
8219	the IMedia instance is optional; it can be NULL if no media is mounted (see
8220	<link to="IMachine::mountMedium" />).
8221	</desc>
8222
8223	<attribute name="medium" type="IMedium" readonly="yes">
8224	<desc>Medium object associated with this attachment; it
8225	can be NULL for removable devices.</desc>
8226	</attribute>
8227
8228	<attribute name="controller" type="wstring" readonly="yes">
8229	<desc>Name of the storage controller of this attachment; this
8230	refers to one of the controllers in <link to="IMachine::storageControllers" />
8231	by name.</desc>
8232	</attribute>
8233
8234	<attribute name="port" type="long" readonly="yes">
8235	<desc>Port number of this attachment.</desc>
8236	</attribute>
8237
8238	<attribute name="device" type="long" readonly="yes">
8239	<desc>Device slot number of this attachment.</desc>
8240	</attribute>
8241
8242	<attribute name="type" type="DeviceType" readonly="yes">
8243	<desc>Device type of this attachment.</desc>
8244	</attribute>
8245
8246	<attribute name="passthrough" type="boolean" readonly="no">
8247	<desc>Pass I/O requests through to a device on the host.</desc>
8248	</attribute>
8249
8250	</interface>
8251
8252	<interface
8253	name="IMedium" extends="$unknown"
8254	uuid="62551115-83b8-4d20-925f-79e9d3c00f96"
8255	wsmap="managed"
8256	>
8257	<desc>
8258	The IMedium interface represents virtual storage for a machine's
8259	hard disks, CD/DVD or floppy drives. It will typically represent
8260	a disk image on the host, for example a VDI or VMDK file representing
8261	a virtual hard disk, or an ISO or RAW file representing virtual
8262	removable media, but can also point to a network location (e.g.
8263	for iSCSI targets).
8264
8265	Instances of IMedium are connected to virtual machines by way of
8266	medium attachments (see <link to="IMediumAttachment" />), which link
8267	the storage medium to a particular device slot of a storage controller
8268	of the virtual machine.
8269	In the VirtualBox API, virtual storage is therefore always represented
8270	by the following chain of object links:
8271
8272	<ul>
8273	<li><link to="IMachine::storageControllers"/> contains an array of
8274	storage controllers (IDE, SATA, SCSI or a floppy controller;
8275	these are instances of <link to="IStorageController"/>).</li>
8276	<li><link to="IMachine::mediumAttachments"/> contains an array of
8277	medium attachments (instances of <link to="IMediumAttachment"/>),
8278	each containing the name of a storage controller from the above
8279	array, a port/device specification, and an instance of
8280	IMedium representing the medium storage (image file). For removable
8281	media, the storage medium is optional; a medium attachment with no
8282	medium represents a CD/DVD or floppy drive with no medium inserted.
8283	By contrast, hard disk attachments will always have an IMedium
8284	object attached.</li>
8285	<li>Each IMedium in turn points to a storage unit (such as a file on the host
8286	computer or a network resource) that holds actual data. The location of
8287	the storage unit is represented by the <link to="#location"/> attribute.
8288	The value of this attribute is medium type dependent.</li>
8289	</ul>
8290
8291	Existing media are opened using the following methods, depending on the
8292	media type:
8293	<ul>
8294	<li><link to="IVirtualBox::openHardDisk"/></li>
8295	<li><link to="IVirtualBox::openDVDImage"/></li>
8296	<li><link to="IVirtualBox::openFloppyImage"/></li>
8297	</ul>
8298
8299	New hard disk media can be created with the VirtualBox API using the
8300	<link to="IVirtualBox::createHardDisk"/> method.
8301
8302	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8303	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8304	type in a regular file.
8305
8306	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8307	drive; in that case the <link to="#id" /> attribute contains the UUID of
8308	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8309
8310	<h3>Known media</h3>
8311
8312	When an existing medium is opened for the first time, it is automatically
8313	remembered by the given VirtualBox installation or, in other words, becomes
8314	a <i>known medium</i>. Known media are stored in the media
8315	registry transparently maintained by VirtualBox and stored in settings
8316	files so that this registry is preserved when VirtualBox is not running.
8317
8318	Newly created virtual media are remembered only when the associated
8319	storage unit is actually created.
8320
8321	All known media can be enumerated using
8322	<link to="IVirtualBox::hardDisks"/>,
8323	<link to="IVirtualBox::DVDImages"/> and
8324	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8325	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8326	and similar methods or by location using
8327	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8328
8329	Only known media can be attached to virtual machines.
8330
8331	Removing known media from the media registry is performed when the given
8332	medium is closed using the <link to="#close"/> method or when its
8333	associated storage unit is deleted.
8334
8335	<h3>Accessibility checks</h3>
8336
8337	The given medium (with the created storage unit) is considered to be
8338	<i>accessible</i> when its storage unit can be read. In that case, the
8339	<link to="#state"/> attribute has a value of "Created".
8340	When the storage unit cannot be read (for example, because it is located on
8341	a disconnected network resource, or was accidentally deleted outside VirtualBox),
8342	the medium is considered to be <i>inaccessible</i>, which is indicated by the
8343	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8344	obtained by reading the <link to="#lastAccessError"/> attribute.
8345
8346	A new accessibility check is performed each time the <link to="#state"/>
8347	attribute is read. This check may take long time (several seconds or even
8348	minutes, depending on the storage unit location and format), and will
8349	block the calling thread until finished. For this reason, it is recommended
8350	to never read this attribute on the main UI thread to avoid making the UI
8351	unresponsive.
8352
8353	Note that when VirtualBox starts up (e.g. the VirtualBox object gets
8354	created for the first time), all known media are in the
8355	<link to="MediumState_Inaccessible"/> state but the value of the <link
8356	to="#lastAccessError"/> attribute is an empty string because no actual
8357	accessibility check is made on startup. This is done to make the
8358	VirtualBox object ready for serving requests as
8359	fast as possible and let the end-user application decide if it needs to
8360	check media accessibility right away or not.
8361
8362	<h3>Hard disk types</h3>
8363
8364	There are three types of hard disk images (see <link to="MediumType" />):
8365	"normal", "immutable" and "writethrough", represented by the
8366	<link to="#type"/> attribute. The type of the hard disk defines how the
8367	hard disk is attached to a virtual machine and what happens when a
8368	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8369	attached hard disk is taken.
8370
8371	All hard disks can be also divided in two groups: <i>base</i> hard
8372	disks and <i>differencing</i> hard disks. A base hard disk contains all
8373	sectors of the hard disk data in its own storage and therefore can be
8374	used independently. On the contrary, a differencing hard disk is a
8375	"delta" to some other disk and contains only those sectors which differ
8376	from that other disk, which is then called a <i>parent</i>. The differencing
8377	hard disk is said to be <i>linked to</i> that parent.
8378	The parent may be itself a differencing image, thus forming a chain of
8379	linked hard disks. The last element in that chain
8380	must always be a base medium. Note that several differencing
8381	hard disks may be linked to the same parent hard disk.
8382
8383	Differencing hard disks can be distinguished from base hard disks by
8384	querying the <link to="#parent"/> attribute: base hard disks do not have
8385	parents they would depend on, so the value of this attribute is always
8386	@c null for them. Using this attribute, it is possible to walk up
8387	the hard disk tree (from the child hard disk to its parent). It is also
8388	possible to walk down the tree using the <link to="#children"/>
8389	attribute.
8390
8391	Note that the type of all differencing hard disks is
8392	<link to="MediumType_Normal" />; all other values are
8393	meaningless for them. Base hard disks may be of any type.
8394
8395	<h3>Creating hard disks</h3>
8396
8397	New base hard disks are created using
8398	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8399	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8400	disks are usually implicitly created by VirtualBox when needed but may
8401	also be created explicitly using <link to="#createDiffStorage"/>.
8402
8403	After the hard disk is successfully created (including the storage unit)
8404	or opened, it becomes a known hard disk (remembered in the internal media
8405	registry). Known hard disks can be attached to a virtual machine, accessed
8406	through <link to="IVirtualBox::getHardDisk"/> and
8407	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8408	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8409
8410	The following methods, besides <link to="IMedium::close"/>,
8411	automatically remove the hard disk from the media registry:
8412	<ul>
8413	<li><link to="#deleteStorage"/></li>
8414	<li><link to="#mergeTo"/></li>
8415	</ul>
8416
8417	If the storage unit of the hard disk is a regular file in the host's
8418	file system then the rules stated in the description of the
8419	<link to="IMedium::location"/> attribute apply when setting its value. In
8420	addition, a plain file name without any path may be given, in which case
8421	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8422	folder</link> will be prepended to it.
8423
8424	<h4>Automatic composition of the file name part</h4>
8425
8426	Another extension to the <link to="IMedium::location"/> attribute is that
8427	there is a possibility to cause VirtualBox to compose a unique value for
8428	the file name part of the location using the UUID of the hard disk. This
8429	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8430	e.g. before the storage unit is created, and works as follows. You set the
8431	value of the <link to="IMedium::location"/> attribute to a location
8432	specification which only contains the path specification but not the file
8433	name part and ends with either a forward slash or a backslash character.
8434	In response, VirtualBox will generate a new UUID for the hard disk and
8435	compose the file name using the following pattern:
8436	<pre>
8437	<path>/{<uuid>}.<ext>
8438	</pre>
8439	where <tt><path></tt> is the supplied path specification,
8440	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8441	is the default extension for the storage format of this hard disk. After
8442	that, you may call any of the methods that create a new hard disk storage
8443	unit and they will use the generated UUID and file name.
8444
8445	<h3>Attaching Hard Disks</h3>
8446
8447	Hard disks are attached to virtual machines using the
8448	<link to="IMachine::attachDevice"/> method and detached using the
8449	<link to="IMachine::detachDevice"/> method. Depending on their
8450	<link to="#type"/>, hard disks are attached either
8451	<i>directly</i> or <i>indirectly</i>.
8452
8453	When a hard disk is being attached directly, it is associated with the
8454	virtual machine and used for hard disk operations when the machine is
8455	running. When a hard disk is being attached indirectly, a new differencing
8456	hard disk linked to it is implicitly created and this differencing hard
8457	disk is associated with the machine and used for hard disk operations.
8458	This also means that if <link to="IMachine::attachDevice"/> performs
8459	a direct attachment then the same hard disk will be returned in response
8460	to the subsequent <link to="IMachine::getMedium"/> call; however if
8461	an indirect attachment is performed then
8462	<link to="IMachine::getMedium"/> will return the implicitly created
8463	differencing hard disk, not the original one passed to <link
8464	to="IMachine::attachDevice"/>. In detail:
8465
8466	<ul>
8467	<li><b>Normal base</b> hard disks that do not have children (i.e.
8468	differencing hard disks linked to them) and that are not already
8469	attached to virtual machines in snapshots are attached <b>directly</b>.
8470	Otherwise, they are attached <b>indirectly</b> because having
8471	dependent children or being part of the snapshot makes it impossible
8472	to modify hard disk contents without breaking the integrity of the
8473	dependent party. The <link to="#readOnly"/> attribute allows to
8474	quickly determine the kind of the attachment for the given hard
8475	disk. Note that if a normal base hard disk is to be indirectly
8476	attached to a virtual machine with snapshots then a special
8477	procedure called <i>smart attachment</i> is performed (see below).</li>
8478	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8479	they are attached <b>directly</b> if they do not have children and are
8480	not attached to virtual machines in snapshots, and <b>indirectly</b>
8481	otherwise. Note that the smart attachment procedure is never performed
8482	for differencing hard disks.</li>
8483	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8484	they are designed to be non-writable. If an immutable hard disk is
8485	attached to a virtual machine with snapshots then a special
8486	procedure called smart attachment is performed (see below).</li>
8487	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8488	also as designed. This also means that writethrough hard disks cannot
8489	have other hard disks linked to them at all.</li>
8490	</ul>
8491
8492	Note that the same hard disk, regardless of its type, may be attached to
8493	more than one virtual machine at a time. In this case, the machine that is
8494	started first gains exclusive access to the hard disk and attempts to
8495	start other machines having this hard disk attached will fail until the
8496	first machine is powered down.
8497
8498	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8499	that the given hard disk remains associated with the given machine after a
8500	successful <link to="IMachine::detachDevice"/> call until
8501	<link to="IMachine::saveSettings"/> is called to save all changes to
8502	machine settings to disk. This deferring is necessary to guarantee that
8503	the hard disk configuration may be restored at any time by a call to
8504	<link to="IMachine::discardSettings"/> before the settings
8505	are saved (committed).
8506
8507	Note that if <link to="IMachine::discardSettings"/> is called after
8508	indirectly attaching some hard disks to the machine but before a call to
8509	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8510	all differencing hard disks implicitly created by
8511	<link to="IMachine::attachDevice"/> for these indirect attachments.
8512	Such implicitly created hard disks will also be immediately deleted when
8513	detached explicitly using the <link to="IMachine::detachDevice"/>
8514	call if it is made before <link to="IMachine::saveSettings"/>. This
8515	implicit deletion is safe because newly created differencing hard
8516	disks do not contain any user data.
8517
8518	However, keep in mind that detaching differencing hard disks that were
8519	implicitly created by <link to="IMachine::attachDevice"/>
8520	before the last <link to="IMachine::saveSettings"/> call will
8521	<b>not</b> implicitly delete them as they may already contain some data
8522	(for example, as a result of virtual machine execution). If these hard
8523	disks are no more necessary, the caller can always delete them explicitly
8524	using <link to="#deleteStorage"/> after they are actually de-associated
8525	from this machine by the <link to="IMachine::saveSettings"/> call.
8526
8527	<h3>Smart Attachment</h3>
8528
8529	When normal base or immutable hard disks are indirectly attached to a
8530	virtual machine then some additional steps are performed to make sure the
8531	virtual machine will have the most recent "view" of the hard disk being
8532	attached. These steps include walking through the machine's snapshots
8533	starting from the current one and going through ancestors up to the first
8534	snapshot. Hard disks attached to the virtual machine in all
8535	of the encountered snapshots are checked whether they are descendants of
8536	the given normal base or immutable hard disk. The first found child (which
8537	is the differencing hard disk) will be used instead of the normal base or
8538	immutable hard disk as a parent for creating a new differencing hard disk
8539	that will be actually attached to the machine. And only if no descendants
8540	are found or if the virtual machine does not have any snapshots then the
8541	normal base or immutable hard disk will be used itself as a parent for
8542	this differencing hard disk.
8543
8544	It is easier to explain what smart attachment does using the
8545	following example:
8546	<pre>
8547	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8548
8549	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8550	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8551	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8552	Snapshot 4 (none) Snapshot 4 (none)
8553	CurState (none) CurState (D3->D2.vdi)
8554
8555	NOT
8556	...
8557	CurState (D3->B.vdi)
8558	</pre>
8559	The first column is the virtual machine configuration before the base hard
8560	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8561	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8562	mean that the hard disk that is actually attached to the machine is a
8563	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8564	another hard disk, <tt>B.vdi</tt>.
8565
8566	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8567	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8568	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8569	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8570	it cannot be attached directly and needs an indirect attachment (i.e.
8571	implicit creation of a new differencing hard disk). Due to the smart
8572	attachment procedure, the new differencing hard disk
8573	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8574	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8575	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8576	machine.
8577
8578	Note that if there is more than one descendant hard disk of the given base
8579	hard disk found in a snapshot, and there is an exact device, channel and
8580	bus match, then this exact match will be used. Otherwise, the youngest
8581	descendant will be picked up.
8582
8583	There is one more important aspect of the smart attachment procedure which
8584	is not related to snapshots at all. Before walking through the snapshots
8585	as described above, the backup copy of the current list of hard disk
8586	attachment is searched for descendants. This backup copy is created when
8587	the hard disk configuration is changed for the first time after the last
8588	<link to="IMachine::saveSettings"/> call and used by
8589	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8590	changes. When such a descendant is found in this backup copy, it will be
8591	simply re-attached back, without creating a new differencing hard disk for
8592	it. This optimization is necessary to make it possible to re-attach the
8593	base or immutable hard disk to a different bus, channel or device slot
8594	without losing the contents of the differencing hard disk actually
8595	attached to the machine in place of it.
8596	</desc>
8597
8598	<attribute name="id" type="uuid" mod="string" readonly="yes">
8599	<desc>
8600	UUID of the medium. For a newly created medium, this value is a randomly
8601	generated UUID.
8602
8603	<note>
8604	For media in one of MediumState_NotCreated, MediumState_Creating or
8605	MediumState_Deleting states, the value of this property is undefined
8606	and will most likely be an empty UUID.
8607	</note>
8608	</desc>
8609	</attribute>
8610
8611	<attribute name="description" type="wstring">
8612	<desc>
8613	Optional description of the medium. For a newly created medium the value
8614	of this attribute is an empty string.
8615
8616	Medium types that don't support this attribute will return E_NOTIMPL in
8617	attempt to get or set this attribute's value.
8618
8619	<note>
8620	For some storage types, reading this attribute may return an outdated
8621	(last known) value when <link to="#state"/> is <link
8622	to="MediumState_Inaccessible"/> or <link
8623	to="MediumState_LockedWrite"/> because the value of this attribute is
8624	stored within the storage unit itself. Also note that changing the
8625	attribute value is not possible in such case, as well as when the
8626	medium is the <link to="MediumState_LockedRead"/> state.
8627	</note>
8628	</desc>
8629	</attribute>
8630
8631	<attribute name="state" type="MediumState" readonly="yes">
8632	<desc>
8633	Current medium state. Inspect <link to="MediumState"/> values for details.
8634
8635	Reading this attribute may take a long time because an accessibility
8636	check of the storage unit is performed each time the attribute is read.
8637	This check may cause a significant delay if the storage unit of the
8638	given medium is, for example, a file located on a network share which is
8639	not currently accessible due to connectivity problems -- the call will
8640	not return until a timeout interval defined by the host OS for this
8641	operation expires.
8642
8643	If the last known state of the medium is <link to="MediumState_Created"/>
8644	and the accessibility check fails then the state would be set to
8645	<link to="MediumState_Inaccessible"/> and <link to="#lastAccessError"/>
8646	may be used to get more details about the failure. If the state of the
8647	medium is <link to="MediumState_LockedRead"/> or
8648	<link to="MediumState_LockedWrite"/> then it remains the same, and a
8649	non-empty value of <link to="#lastAccessError"/> will indicate a failed
8650	accessibility check in this case.
8651
8652	Note that not all medium states are applicable to all medium types.
8653	</desc>
8654	</attribute>
8655
8656	<attribute name="location" type="wstring">
8657	<desc>
8658	Location of the storage unit holding medium data.
8659
8660	The format of the location string is medium type specific. For medium
8661	types using regular files in a host's file system, the location
8662	string is the full file name.
8663
8664	Some medium types may support changing the storage unit location by
8665	simply changing the value of this property. If this operation is not
8666	supported, the implementation will return E_NOTIMPL in attempt to set
8667	this attribute's value.
8668
8669	When setting a value of the location attribute which is a regular file
8670	in the host's file system, the given file name may be either relative to
8671	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
8672	absolute. Note that if the given location specification does not contain
8673	the file extension part then a proper default extension will be
8674	automatically appended by the implementation depending on the medium type.
8675	</desc>
8676	</attribute>
8677
8678	<attribute name="name" type="wstring" readonly="yes">
8679	<desc>
8680	Name of the storage unit holding medium data.
8681
8682	The returned string is a short version of the <link to="#location"/>
8683	attribute that is suitable for representing the medium in situations
8684	where the full location specification is too long (such as lists
8685	and comboboxes in GUI frontends). This string is also used by frontends
8686	to sort the media list alphabetically when needed.
8687
8688	For example, for locations that are regular files in the host's file
8689	system, the value of this attribute is just the file name (+ extension),
8690	without the path specification.
8691
8692	Note that as opposed to the <link to="#location"/> attribute, the name
8693	attribute will not necessary be unique for a list of media of the
8694	given type and format.
8695	</desc>
8696	</attribute>
8697
8698	<attribute name="hostDrive" type="boolean" readonly="yes">
8699	<desc>True if this corresponds to a drive on the host.</desc>
8700	</attribute>
8701
8702	<attribute name="size" type="unsigned long long" readonly="yes">
8703	<desc>
8704	Physical size of the storage unit used to hold medium data (in bytes).
8705
8706	<note>
8707	For media whose <link to="#state"/> is <link
8708	to="MediumState_Inaccessible"/>, the value of this property is the
8709	last known size. For <link to="MediumState_NotCreated"/> media,
8710	the returned value is zero.
8711	</note>
8712	</desc>
8713	</attribute>
8714
8715	<attribute name="format" type="wstring" readonly="yes">
8716	<desc>
8717	Storage format of this medium.
8718
8719	The value of this attribute is a string that specifies a backend used to
8720	store hard disk data. The storage format is defined when you create a
8721	new hard disk or automatically detected when you open an existing hard
8722	disk medium, and cannot be changed later.
8723
8724	The list of all storage formats supported by this VirtualBox
8725	installation can be obtained using
8726	<link to="ISystemProperties::mediumFormats"/>.
8727	</desc>
8728	</attribute>
8729
8730	<attribute name="type" type="MediumType">
8731	<desc>
8732	Type (role) of this hard disk.
8733
8734	The following constraints apply when changing the value of this
8735	attribute:
8736	<ul>
8737	<li>If a hard disk is attached to a virtual machine (either in the
8738	current state or in one of the snapshots), its type cannot be
8739	changed.
8740	</li>
8741	<li>As long as the hard disk has children, its type cannot be set
8742	to <link to="MediumType_Writethrough"/>.
8743	</li>
8744	<li>The type of all differencing hard disks is
8745	<link to="MediumType_Normal"/> and cannot be changed.
8746	</li>
8747	</ul>
8748
8749	The type of a newly created or opened hard disk is set to
8750	<link to="MediumType_Normal"/>.
8751	</desc>
8752	</attribute>
8753
8754	<attribute name="parent" type="IMedium" readonly="yes">
8755	<desc>
8756	Parent of this hard disk (a hard disk this hard disk is directly based
8757	on).
8758
8759	Only differencing hard disks have parents. For base (non-differencing)
8760	hard disks, @c null is returned.
8761	</desc>
8762	</attribute>
8763
8764	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
8765	<desc>
8766	Children of this hard disk (all differencing hard disks directly based
8767	on this hard disk). A @c null array is returned if this hard disk
8768	does not have any children.
8769	</desc>
8770	</attribute>
8771
8772	<attribute name="base" type="IMedium" readonly="yes">
8773	<desc>
8774	Base medium of this medium.
8775
8776	If this is a differencing medium, its base hard disk is the medium
8777	the given hard disk branch starts from. For all other types of hard
8778	disks, this property returns the hard disk object itself (i.e. the same
8779	object this property is read on).
8780	</desc>
8781	</attribute>
8782
8783	<attribute name="readOnly" type="boolean" readonly="yes">
8784	<desc>
8785	Returns @c true if this hard disk is read-only and @c false otherwise.
8786
8787	A hard disk is considered to be read-only when its contents cannot be
8788	modified without breaking the integrity of other parties that depend on
8789	this hard disk such as its child hard disks or snapshots of virtual
8790	machines where this hard disk is attached to these machines. If there
8791	are no children and no such snapshots then there is no dependency and
8792	the hard disk is not read-only.
8793
8794	The value of this attribute can be used to determine the kind of the
8795	attachment that will take place when attaching this hard disk to a
8796	virtual machine. If the value is @c false then the hard disk will
8797	be attached directly. If the value is @c true then the hard disk
8798	will be attached indirectly by creating a new differencing child hard
8799	disk for that. See the interface description for more information.
8800
8801	Note that all <link to="MediumType_Immutable">Immutable</link> hard
8802	disks are always read-only while all
8803	<link to="MediumType_Writethrough">Writethrough</link> hard disks are
8804	always not.
8805
8806	<note>
8807	The read-only condition represented by this attribute is related to
8808	the hard disk type and usage, not to the current
8809	<link to="IMedium::state">medium state</link> and not to the read-only
8810	state of the storage unit.
8811	</note>
8812	</desc>
8813	</attribute>
8814
8815	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
8816	<desc>
8817	Logical size of this hard disk (in megabytes), as reported to the
8818	guest OS running inside the virtual machine this disk is
8819	attached to. The logical size is defined when the hard disk is created
8820	and cannot be changed later.
8821
8822	<note>
8823	Reading this property on a differencing hard disk will return the size
8824	of its <link to="#base"/> medium.
8825	</note>
8826	<note>
8827	For hard disks whose state is <link to="#state"/> is <link
8828	to="MediumState_Inaccessible"/>, the value of this property is the
8829	last known logical size. For <link to="MediumaState_NotCreated"/> hard
8830	disks, the returned value is zero.
8831	</note>
8832	</desc>
8833	</attribute>
8834
8835	<attribute name="autoReset" type="boolean">
8836	<desc>
8837	Whether this differencing hard disk will be automatically reset each
8838	time a virtual machine it is attached to is powered up.
8839
8840	See <link to="#reset()"/> for more information about resetting
8841	differencing hard disks.
8842
8843	<note>
8844	Reading this property on a base (non-differencing) hard disk will
8845	always @c false. Changing the value of this property in this
8846	case is not supported.
8847	</note>
8848
8849	<result name="VBOX_E_NOT_SUPPORTED">
8850	This is not a differencing hard disk (when changing the attribute
8851	value).
8852	</result>
8853	</desc>
8854	</attribute>
8855
8856	<attribute name="lastAccessError" type="wstring" readonly="yes">
8857	<desc>
8858	Text message that represents the result of the last accessibility
8859	check.
8860
8861	Accessibility checks are performed each time the <link to="#state"/>
8862	attribute is read. An empty string is returned if the last
8863	accessibility check was successful. A non-empty string indicates a
8864	failure and should normally describe a reason of the failure (for
8865	example, a file read error).
8866	</desc>
8867	</attribute>
8868
8869	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
8870	<desc>
8871	Array of UUIDs of all machines this medium is attached to.
8872
8873	A @c null array is returned if this medium is not attached to any
8874	machine or to any machine's snapshot.
8875
8876	<note>
8877	The returned array will include a machine even if this medium is not
8878	attached to that machine in the current state but attached to it in
8879	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
8880	details.
8881	</note>
8882	</desc>
8883	</attribute>
8884
8885	<method name="getSnapshotIds">
8886	<desc>
8887	Returns an array of UUIDs of all snapshots of the given machine where
8888	this medium is attached to.
8889
8890	If the medium is attached to the machine in the current state, then the
8891	first element in the array will always be the ID of the queried machine
8892	(i.e. the value equal to the @c machineId argument), followed by
8893	snapshot IDs (if any).
8894
8895	If the medium is not attached to the machine in the current state, then
8896	the array will contain only snapshot IDs.
8897
8898	The returned array may be @c null if this medium is not attached
8899	to the given machine at all, neither in the current state nor in one of
8900	the snapshots.
8901	</desc>
8902	<param name="machineId" type="uuid" mod="string" dir="in">
8903	<desc>
8904	UUID of the machine to query.
8905	</desc>
8906	</param>
8907	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
8908	<desc>
8909	Array of snapshot UUIDs of the given machine using this medium.
8910	</desc>
8911	</param>
8912	</method>
8913
8914	<method name="lockRead">
8915	<desc>
8916	Locks this medium for reading.
8917
8918	The read lock is shared: many clients can simultaneously lock the
8919	same medium for reading unless it is already locked for writing (see
8920	<link to="#lockWrite"/>) in which case an error is returned.
8921
8922	When the medium is locked for reading, it cannot be modified
8923	from within VirtualBox. This means that any method that changes
8924	the properties of this medium or contents of the storage unit
8925	will return an error (unless explicitly stated otherwise) and
8926	that an attempt to start a virtual machine that wants to modify
8927	the medium will also fail.
8928
8929	When the virtual machine is started up, it locks for reading all
8930	media it uses in read-only mode. If some medium cannot be locked
8931	for reading, the startup procedure will fail.
8932
8933	The medium locked for reading must be unlocked using the <link
8934	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
8935	can be nested and must be followed by the same number of paired
8936	<link to="#unlockRead"/> calls.
8937
8938	This method sets the medium state to <link
8939	to="MediumState_LockedRead" /> on success. The state prior to
8940	this call must be <link to="MediumState_Created" />,
8941	<link to="MediumState_Inaccessible" /> or
8942	<link to="MediumState_LockedRead" />.
8943	As you can see, an inaccessible medium can be locked too. This is
8944	not an error; this method performs a logical lock that prevents
8945	modifications of this medium through the VirtualBox API, not a
8946	physical lock of the underlying storage unit.
8947
8948	This method returns the current state of the medium
8949	<b>before</b> the operation.
8950
8951	<result name="VBOX_E_INVALID_OBJECT_STATE">
8952	Invalid medium state (e.g. not created, locked, inaccessible,
8953	creating, deleting).
8954	</result>
8955
8956	</desc>
8957	<param name="state" type="MediumState" dir="return">
8958	<desc>
8959	State of the medium after the operation.
8960	</desc>
8961	</param>
8962	</method>
8963
8964	<method name="unlockRead">
8965	<desc>
8966	Cancels the read lock previously set by <link to="#lockRead"/>.
8967
8968	For both, success and failure, this method returns the current state
8969	of the medium <b>after</b> the operation.
8970
8971	See <link to="#lockRead"/> for more details.
8972
8973	<result name="VBOX_E_INVALID_OBJECT_STATE">
8974	Medium not locked for reading.
8975	</result>
8976
8977	</desc>
8978	<param name="state" type="MediumState" dir="return">
8979	<desc>
8980	State of the medium after the operation.
8981	</desc>
8982	</param>
8983	</method>
8984
8985	<method name="lockWrite">
8986	<desc>
8987	Locks this medium for writing.
8988
8989	The write lock, as opposed to <link to="#lockRead"/>, is
8990	exclusive: there may be only one client holding a write lock
8991	and there may be no read locks while the write lock is held.
8992
8993	When the medium is locked for writing, it cannot be modified
8994	from within VirtualBox and it is not guaranteed that the values
8995	of its properties are up-to-date. Any method that changes the
8996	properties of this medium or contents of the storage unit will
8997	return an error (unless explicitly stated otherwise) and an
8998	attempt to start a virtual machine wanting to modify or to
8999	read the medium will fail.
9000
9001	When the virtual machine is started up, it locks for writing all
9002	media it uses to write data to. If any medium could not be locked
9003	for writing, the startup procedure will fail.
9004
9005	The medium locked for writing must be unlocked using the <link
9006	to="#unlockWrite"/> method. Calls to <link to="#lockWrite"/>
9007	can <b>not</b> be nested and must be followed by a<link
9008	to="#unlockWrite"/> call before the next lockWrite call.
9009
9010	This method sets the medium state to <link to="MediumState_LockedWrite" />
9011	on success. The state prior to this call must be <link to="MediumState_Created"/>
9012	or <link to="MediumState_Inaccessible"/>. As you can see, an inaccessible
9013	medium can be locked too. This is not an error; this method
9014	performs a logical lock preventing modifications of this
9015	medium through the VirtualBox API, not a physical lock of the
9016	underlying storage unit.
9017
9018	For both, success and failure, this method returns the current
9019	state of the medium <b>before</b> the operation.
9020
9021	<result name="VBOX_E_INVALID_OBJECT_STATE">
9022	Invalid medium state (e.g. not created, locked, inaccessible,
9023	creating, deleting).
9024	</result>
9025
9026	</desc>
9027	<param name="state" type="MediumState" dir="return">
9028	<desc>
9029	State of the medium after the operation.
9030	</desc>
9031	</param>
9032	</method>
9033
9034	<method name="unlockWrite">
9035	<desc>
9036	Cancels the write lock previously set by <link to="#lockWrite"/>.
9037
9038	For both, success and failure, this method returns the current
9039	state of the medium <b>after</b> the operation.
9040
9041	See <link to="#lockWrite"/> for more details.
9042
9043	<result name="VBOX_E_INVALID_OBJECT_STATE">
9044	Medium not locked for writing.
9045	</result>
9046
9047	</desc>
9048	<param name="state" type="MediumState" dir="return">
9049	<desc>
9050	State of the medium after the operation.
9051	</desc>
9052	</param>
9053	</method>
9054
9055	<method name="close">
9056	<desc>
9057	Closes this medium.
9058
9059	The medium must not be attached to any known virtual machine
9060	and must not have any known child media, otherwise the
9061	operation will fail.
9062
9063	When the medium is successfully closed, it gets removed from
9064	the list of remembered media, but its storage unit is not
9065	deleted. In particular, this means that this medium can be
9066	later opened again using the <link
9067	to="IVirtualBox::openHardDisk"/> call.
9068
9069	Note that after this method successfully returns, the given medium
9070	object becomes uninitialized. This means that any attempt
9071	to call any of its methods or attributes will fail with the
9072	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9073
9074	<result name="VBOX_E_INVALID_OBJECT_STATE">
9075	Invalid medium state (other than not created, created or
9076	inaccessible).
9077	</result>
9078	<result name="VBOX_E_OBJECT_IN_USE">
9079	Medium attached to virtual machine.
9080	</result>
9081	<result name="VBOX_E_FILE_ERROR">
9082	Settings file not accessible.
9083	</result>
9084	<result name="VBOX_E_XML_ERROR">
9085	Could not parse the settings file.
9086	</result>
9087
9088	</desc>
9089	</method>
9090
9091	<!-- storage methods -->
9092
9093	<method name="getProperty">
9094	<desc>
9095	Returns the value of the custom hard disk property with the given name.
9096
9097	The list of all properties supported by the given hard disk format can
9098	be obtained with <link to="IMediumFormat::describeProperties"/>.
9099
9100	Note that if this method returns an empty string in @a value, the
9101	requested property is supported but currently not assigned any value.
9102
9103	<result name="VBOX_E_OBJECT_NOT_FOUND">
9104	Requested property does not exist (not supported by the format).
9105	</result>
9106	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9107	</desc>
9108	<param name="name" type="wstring" dir="in">
9109	<desc>Name of the property to get.</desc>
9110	</param>
9111	<param name="value" type="wstring" dir="return">
9112	<desc>Current property value.</desc>
9113	</param>
9114	</method>
9115
9116	<method name="setProperty">
9117	<desc>
9118	Sets the value of the custom hard disk property with the given name.
9119
9120	The list of all properties supported by the given hard disk format can
9121	be obtained with <link to="IMediumFormat::describeProperties"/>.
9122
9123	Note that setting the property value to @c null or an empty string is
9124	equivalent to deleting the existing value. A default value (if it is
9125	defined for this property) will be used by the format backend in this
9126	case.
9127
9128	<result name="VBOX_E_OBJECT_NOT_FOUND">
9129	Requested property does not exist (not supported by the format).
9130	</result>
9131	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9132	</desc>
9133	<param name="name" type="wstring" dir="in">
9134	<desc>Name of the property to set.</desc>
9135	</param>
9136	<param name="value" type="wstring" dir="in">
9137	<desc>Property value to set.</desc>
9138	</param>
9139	</method>
9140
9141	<method name="getProperties">
9142	<desc>
9143	Returns values for a group of properties in one call.
9144
9145	The names of the properties to get are specified using the @a names
9146	argument which is a list of comma-separated property names or
9147	an empty string if all properties are to be returned. Note that currently
9148	the value of this argument is ignored and the method always returns all
9149	existing properties.
9150
9151	The list of all properties supported by the given hard disk format can
9152	be obtained with <link to="IMediumFormat::describeProperties"/>.
9153
9154	The method returns two arrays, the array of property names corresponding
9155	to the @a names argument and the current values of these properties.
9156	Both arrays have the same number of elements with each elemend at the
9157	given index in the first array corresponds to an element at the same
9158	index in the second array.
9159
9160	Note that for properties that do not have assigned values,
9161	an empty string is returned at the appropriate index in the
9162	@a returnValues array.
9163
9164	</desc>
9165	<param name="names" type="wstring" dir="in">
9166	<desc>
9167	Names of properties to get.
9168	</desc>
9169	</param>
9170	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9171	<desc>Names of returned properties.</desc>
9172	</param>
9173	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9174	<desc>Values of returned properties.</desc>
9175	</param>
9176	</method>
9177
9178	<method name="setProperties">
9179	<desc>
9180	Sets values for a group of properties in one call.
9181
9182	The names of the properties to set are passed in the @a names
9183	array along with the new values for them in the @a values array. Both
9184	arrays have the same number of elements with each elemend at the given
9185	index in the first array corresponding to an element at the same index
9186	in the second array.
9187
9188	If there is at least one property name in @a names that is not valid,
9189	the method will fail before changing the values of any other properties
9190	from the @a names array.
9191
9192	Using this method over <link to="#setProperty"/> is preferred if you
9193	need to set several properties at once since it will result into less
9194	IPC calls.
9195
9196	The list of all properties supported by the given hard disk format can
9197	be obtained with <link to="IMediumFormat::describeProperties"/>.
9198
9199	Note that setting the property value to @c null or an empty string is
9200	equivalent to deleting the existing value. A default value (if it is
9201	defined for this property) will be used by the format backend in this
9202	case.
9203	</desc>
9204	<param name="names" type="wstring" safearray="yes" dir="in">
9205	<desc>Names of properties to set.</desc>
9206	</param>
9207	<param name="values" type="wstring" safearray="yes" dir="in">
9208	<desc>Values of properties to set.</desc>
9209	</param>
9210	</method>
9211
9212	<!-- storage methods -->
9213
9214	<method name="createBaseStorage">
9215	<desc>
9216	Starts creating a hard disk storage unit (fixed/dynamic, according
9217	to the variant flags) in in the background. The previous storage unit
9218	created for this object, if any, must first be deleted using
9219	<link to="#deleteStorage"/>, otherwise the operation will fail.
9220
9221	Before the operation starts, the hard disk is placed in
9222	<link to="MediumState_Creating"/> state. If the create operation
9223	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9224	state.
9225
9226	After the returned progress object reports that the operation has
9227	successfully completed, the medium state will be set to <link
9228	to="MediumState_Created"/>, the hard disk will be remembered by this
9229	VirtualBox installation and may be attached to virtual machines.
9230
9231	<result name="VBOX_E_NOT_SUPPORTED">
9232	The variant of storage creation operation is not supported. See <link
9233	to="IMediumFormat::capabilities"/>.
9234	</result>
9235	</desc>
9236	<param name="logicalSize" type="unsigned long long" dir="in">
9237	<desc>Maximum logical size of the hard disk in megabytes.</desc>
9238	</param>
9239	<param name="variant" type="MediumVariant" dir="in">
9240	<desc>Exact image variant which should be created.</desc>
9241	</param>
9242	<param name="progress" type="IProgress" dir="return">
9243	<desc>Progress object to track the operation completion.</desc>
9244	</param>
9245	</method>
9246
9247	<method name="deleteStorage">
9248	<desc>
9249	Starts deleting the storage unit of this hard disk.
9250
9251	The hard disk must not be attached to any known virtual machine and must
9252	not have any known child hard disks, otherwise the operation will fail.
9253	It will also fail if there is no storage unit to delete or if deletion
9254	is already in progress, or if the hard disk is being in use (locked for
9255	read or for write) or inaccessible. Therefore, the only valid state for
9256	this operation to succeed is <link to="MediumState_Created"/>.
9257
9258	Before the operation starts, the hard disk is placed to
9259	<link to="MediumState_Deleting"/> state and gets removed from the list
9260	of remembered hard disks (media registry). If the delete operation
9261	fails, the medium will be remembered again and placed back to
9262	<link to="MediumState_Created"/> state.
9263
9264	After the returned progress object reports that the operation is
9265	complete, the medium state will be set to
9266	<link to="MediumState_NotCreated"/> and you will be able to use one of
9267	the storage creation methods to create it again.
9268
9269	<see>#close()</see>
9270
9271	<result name="VBOX_E_OBJECT_IN_USE">
9272	Hard disk is attached to a virtual machine.
9273	</result>
9274	<result name="VBOX_E_NOT_SUPPORTED">
9275	Storage deletion is not allowed because neither of storage creation
9276	operations are supported. See
9277	<link to="IMediumFormat::capabilities"/>.
9278	</result>
9279
9280	<note>
9281	If the deletion operation fails, it is not guaranteed that the storage
9282	unit still exists. You may check the <link to="IMedium::state"/> value
9283	to answer this question.
9284	</note>
9285	</desc>
9286	<param name="progress" type="IProgress" dir="return">
9287	<desc>Progress object to track the operation completion.</desc>
9288	</param>
9289	</method>
9290
9291	<!-- diff methods -->
9292
9293	<method name="createDiffStorage">
9294	<desc>
9295	Starts creating an empty differencing storage unit based on this hard
9296	disk in the format and at the location defined by the @a target
9297	argument.
9298
9299	The target hard disk must be in <link to="MediumState_NotCreated"/>
9300	state (i.e. must not have an existing storage unit). Upon successful
9301	completion, this operation will set the type of the target hard disk to
9302	<link to="MediumType_Normal"/> and create a storage unit necessary to
9303	represent the differencing hard disk data in the given format (according
9304	to the storage format of the target object).
9305
9306	After the returned progress object reports that the operation is
9307	successfully complete, the target hard disk gets remembered by this
9308	VirtualBox installation and may be attached to virtual machines.
9309
9310	<note>
9311	The hard disk will be set to <link to="MediumState_LockedRead"/>
9312	state for the duration of this operation.
9313	</note>
9314	<result name="VBOX_E_OBJECT_IN_USE">
9315	Hard disk not in @c NotCreated state.
9316	</result>
9317	</desc>
9318	<param name="target" type="IMedium" dir="in">
9319	<desc>Target hard disk.</desc>
9320	</param>
9321	<param name="variant" type="MediumVariant" dir="in">
9322	<desc>Exact image variant which should be created.</desc>
9323	</param>
9324	<param name="progress" type="IProgress" dir="return">
9325	<desc>Progress object to track the operation completion.</desc>
9326	</param>
9327	</method>
9328
9329	<method name="mergeTo">
9330	<desc>
9331	Starts merging the contents of this hard disk and all intermediate
9332	differencing hard disks in the chain to the given target hard disk.
9333
9334	The target hard disk must be either a descendant of this hard disk or
9335	its ancestor (otherwise this method will immediately return a failure).
9336	It follows that there are two logical directions of the merge operation:
9337	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9338	ancestor (<i>backward merge</i>). Let us consider the following hard disk
9339	chain:
9340
9341	<pre>Base <- Diff_1 <- Diff_2</pre>
9342
9343	Here, calling this method on the <tt>Base</tt> hard disk object with
9344	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9345	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9346	merge. Note that in both cases the contents of the resulting hard disk
9347	will be the same, the only difference is the hard disk object that takes
9348	the result of the merge operation. In case of the forward merge in the
9349	above example, the result will be written to <tt>Diff_2</tt>; in case of
9350	the backward merge, the result will be written to <tt>Base</tt>. In
9351	other words, the result of the operation is always stored in the target
9352	hard disk.
9353
9354	Upon successful operation completion, the storage units of all hard
9355	disks in the chain between this (source) hard disk and the target hard
9356	disk, including the source hard disk itself, will be automatically
9357	deleted and the relevant hard disk objects (including this hard disk)
9358	will become uninitialized. This means that any attempt to call any of
9359	their methods or attributes will fail with the
9360	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9361	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9362	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> hard
9363	disks. Note that <tt>Diff_2</tt> in this case will become a base hard
9364	disk itself since it will no longer be based on any other hard disk.
9365
9366	Considering the above, all of the following conditions must be met in
9367	order for the merge operation to succeed:
9368	<ul>
9369	<li>
9370	Neither this (source) hard disk nor any intermediate
9371	differencing hard disk in the chain between it and the target
9372	hard disk is attached to any virtual machine.
9373	</li>
9374	<li>
9375	Neither the source hard disk nor the target hard disk is an
9376	<link to="MediumType_Immutable"/> hard disk.
9377	</li>
9378	<li>
9379	The part of the hard disk tree from the source hard disk to the
9380	target hard disk is a linear chain, i.e. all hard disks in this
9381	chain have exactly one child which is the next hard disk in this
9382	chain. The only exception from this rule is the target hard disk in
9383	the forward merge operation; it is allowed to have any number of
9384	child hard disks because the merge operation will hot change its
9385	logical contents (as it is seen by the guest OS or by children).
9386	</li>
9387	<li>
9388	None of the involved hard disks are in
9389	<link to="MediumState_LockedRead"/> or
9390	<link to="MediumState_LockedWrite"/> state.
9391	</li>
9392	</ul>
9393
9394	<note>
9395	This (source) hard disk and all intermediates will be placed to <link
9396	to="MediumState_Deleting"/> state and the target hard disk will be
9397	placed to <link to="MediumState_LockedWrite"/> state and for the
9398	duration of this operation.
9399	</note>
9400	</desc>
9401	<param name="targetId" type="uuid" mod="string" dir="in">
9402	<desc>UUID of the target ancestor or descendant hard disk.</desc>
9403	</param>
9404	<param name="progress" type="IProgress" dir="return">
9405	<desc>Progress object to track the operation completion.</desc>
9406	</param>
9407	</method>
9408
9409	<!-- clone method -->
9410
9411	<method name="cloneTo">
9412	<desc>
9413	Starts creating a clone of this hard disk in the format and at the
9414	location defined by the @a target argument.
9415
9416	The target hard disk must be either in <link to="MediumState_NotCreated"/>
9417	state (i.e. must not have an existing storage unit) or in
9418	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9419	big enough to hold the data or else the copy will be partial). Upon
9420	successful completion, the cloned hard disk will contain exactly the
9421	same sector data as the hard disk being cloned, except that in the
9422	first case a new UUID for the clone will be randomly generated, and in
9423	the second case the UUID will remain unchanged.
9424
9425	The @a parent argument defines which hard disk will be the parent
9426	of the clone. Passing a @c null reference indicates that the clone will
9427	be a base image, i.e. completely independent. It is possible to specify
9428	an arbitrary hard disk for this parameter, including the parent of the
9429	hard disk which is being cloned. Even cloning to a child of the source
9430	hard disk is possible. Note that when cloning to an existing image, the
9431	@a parent irgument is ignored.
9432
9433	After the returned progress object reports that the operation is
9434	successfully complete, the target hard disk gets remembered by this
9435	VirtualBox installation and may be attached to virtual machines.
9436
9437	<note>
9438	This hard disk will be placed to <link to="MediumState_LockedRead"/>
9439	state for the duration of this operation.
9440	</note>
9441	<result name="E_NOTIMPL">
9442	The specified cloning variant is not supported at the moment.
9443	</result>
9444	</desc>
9445	<param name="target" type="IMedium" dir="in">
9446	<desc>Target hard disk.</desc>
9447	</param>
9448	<param name="variant" type="MediumVariant" dir="in">
9449	<desc>Exact image variant which should be created.</desc>
9450	</param>
9451	<param name="parent" type="IMedium" dir="in">
9452	<desc>Parent of the cloned hard disk.</desc>
9453	</param>
9454	<param name="progress" type="IProgress" dir="return">
9455	<desc>Progress object to track the operation completion.</desc>
9456	</param>
9457	</method>
9458
9459	<!-- other methods -->
9460
9461	<method name="compact">
9462	<desc>
9463	Starts compacting of this hard disk. This means that the disk is
9464	transformed into a possibly more compact storage representation.
9465	This potentially creates temporary images, which can require a
9466	substantial amount of additional disk space.
9467
9468	This hard disk will be placed to <link to="MediumState_LockedWrite"/>
9469	state and all its parent hard disks (if any) will be placed to
9470	<link to="MediumState_LockedRead"/> state for the duration of this
9471	operation.
9472
9473	Please note that the results can be either returned straight away,
9474	or later as the result of the background operation via the object
9475	returned via the @a progress parameter.
9476
9477	<result name="VBOX_E_NOT_SUPPORTED">
9478	Hard disk format does not support compacting (but potentially
9479	needs it).
9480	</result>
9481	</desc>
9482	<param name="progress" type="IProgress" dir="return">
9483	<desc>Progress object to track the operation completion.</desc>
9484	</param>
9485	</method>
9486
9487	<method name="reset">
9488	<desc>
9489	Starts erasing the contents of this differencing hard disk.
9490
9491	This operation will reset the differencing hard disk to its initial
9492	state when it does not contain any sector data and any read operation is
9493	redirected to its parent hard disk.
9494
9495	This hard disk will be placed to <link to="MediumState_LockedWrite"/>
9496	for the duration of this operation.
9497
9498	<result name="VBOX_E_NOT_SUPPORTED">
9499	This is not a differencing hard disk.
9500	</result>
9501	<result name="VBOX_E_INVALID_OBJECT_STATE">
9502	Hard disk is not in <link to="MediumState_Created"/> or
9503	<link to="MediumState_Inaccessible"/> state.
9504	</result>
9505	</desc>
9506	<param name="progress" type="IProgress" dir="return">
9507	<desc>Progress object to track the operation completion.</desc>
9508	</param>
9509	</method>
9510
9511	</interface>
9512
9513
9514	<!--
9515	// IMediumFormat
9516	/////////////////////////////////////////////////////////////////////////
9517	-->
9518
9519	<enum
9520	name="DataType"
9521	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9522	>
9523	<const name="Int32" value="0"/>
9524	<const name="Int8" value="1"/>
9525	<const name="String" value="2"/>
9526	</enum>
9527
9528	<enum
9529	name="DataFlags"
9530	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9531	>
9532	<const name="None" value="0x00"/>
9533	<const name="Mandatory" value="0x01"/>
9534	<const name="Expert" value="0x02"/>
9535	<const name="Array" value="0x04"/>
9536	<const name="FlagMask" value="0x07"/>
9537	</enum>
9538
9539	<enum
9540	name="MediumFormatCapabilities"
9541	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
9542	>
9543	<desc>
9544	Hard disk format capability flags.
9545	</desc>
9546
9547	<const name="Uuid" value="0x01">
9548	<desc>
9549	Supports UUIDs as expected by VirtualBox code.
9550	</desc>
9551	</const>
9552
9553	<const name="CreateFixed" value="0x02">
9554	<desc>
9555	Supports creating fixed size images, allocating all space instantly.
9556	</desc>
9557	</const>
9558
9559	<const name="CreateDynamic" value="0x04">
9560	<desc>
9561	Supports creating dynamically growing images, allocating space on
9562	demand.
9563	</desc>
9564	</const>
9565
9566	<const name="CreateSplit2G" value="0x08">
9567	<desc>
9568	Supports creating images split in chunks of a bit less than 2 GBytes.
9569	</desc>
9570	</const>
9571
9572	<const name="Differencing" value="0x10">
9573	<desc>
9574	Supports being used as a format for differencing media (see <link
9575	to="IMedium::createDiffStorage"/>).
9576	</desc>
9577	</const>
9578
9579	<const name="Asynchronous" value="0x20">
9580	<desc>
9581	Supports asynchronous I/O operations for at least some configurations.
9582	</desc>
9583	</const>
9584
9585	<const name="File" value="0x40">
9586	<desc>
9587	The format backend operates on files (the <link to="IMedium::location"/>
9588	attribute of the medium specifies a file used to store medium
9589	data; for a list of supported file extensions see
9590	<link to="IMediumFormat::fileExtensions"/>).
9591	</desc>
9592	</const>
9593
9594	<const name="Properties" value="0x80">
9595	<desc>
9596	The format backend uses the property interface to configure the storage
9597	location and properties (the <link to="IMediumFormat::describeProperties"/>
9598	method is used to get access to properties supported by the given medium format).
9599	</desc>
9600	</const>
9601
9602	<const name="CapabilityMask" value="0xFF"/>
9603	</enum>
9604
9605	<interface
9606	name="IMediumFormat" extends="$unknown"
9607	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
9608	wsmap="managed"
9609	>
9610	<desc>
9611	The IMediumFormat interface represents a medium format.
9612
9613	Each medium format has an associated backend which is used to handle
9614	media stored in this format. This interface provides information
9615	about the properties of the associated backend.
9616
9617	Each medium format is identified by a string represented by the
9618	<link to="#id"/> attribute. This string is used in calls like
9619	<link to="IVirtualBox::createHardDisk"/> to specify the desired
9620	format.
9621
9622	The list of all supported medium formats can be obtained using
9623	<link to="ISystemProperties::mediaFormats"/>.
9624
9625	<see>IMedium</see>
9626	</desc>
9627
9628	<attribute name="id" type="wstring" readonly="yes">
9629	<desc>
9630	Identifier of this format.
9631
9632	The format identifier is a non-@c null non-empty ASCII string. Note that
9633	this string is case-insensitive. This means that, for example, all of
9634	the following strings:
9635	<pre>
9636	"VDI"
9637	"vdi"
9638	"VdI"</pre>
9639	refer to the same medium format.
9640
9641	This string is used in methods of other interfaces where it is necessary
9642	to specify a medium format, such as
9643	<link to="IVirtualBox::createHardDisk"/>.
9644	</desc>
9645	</attribute>
9646
9647	<attribute name="name" type="wstring" readonly="yes">
9648	<desc>
9649	Human readable description of this format.
9650
9651	Mainly for use in file open dialogs.
9652	</desc>
9653	</attribute>
9654
9655	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
9656	<desc>
9657	Array of strings containing the supported file extensions.
9658
9659	The first extension in the array is the extension preferred by the
9660	backend. It is recommended to use this extension when specifying a
9661	location of the storage unit for a new medium.
9662
9663	Note that some backends do not work on files, so this array may be
9664	empty.
9665
9666	<see>IMediumFormat::capabilities</see>
9667	</desc>
9668	</attribute>
9669
9670	<attribute name="capabilities" type="unsigned long" readonly="yes">
9671	<desc>
9672	Capabilities of the format as a set of bit flags.
9673
9674	For the meaning of individual capability flags see
9675	<link to="MediumFormatCapabilities"/>.
9676	</desc>
9677	</attribute>
9678
9679	<method name="describeProperties">
9680	<desc>
9681	Returns several arrays describing the properties supported by this
9682	format.
9683
9684	An element with the given index in each array describes one
9685	property. Thus, the number of elements in each returned array is the
9686	same and corresponds to the number of supported properties.
9687
9688	The returned arrays are filled in only if the
9689	<link to="MediumFormatCapabilities_Properties"/> flag is set.
9690	All arguments must be non-@c null.
9691
9692	<see>DataType</see>
9693	<see>DataFlags</see>
9694	</desc>
9695
9696	<param name="names" type="wstring" safearray="yes" dir="out">
9697	<desc>Array of property names.</desc>
9698	</param>
9699	<param name="description" type="wstring" safearray="yes" dir="out">
9700	<desc>Array of property descriptions.</desc>
9701	</param>
9702	<param name="types" type="DataType" safearray="yes" dir="out">
9703	<desc>Array of property types.</desc>
9704	</param>
9705	<param name="flags" type="unsigned long" safearray="yes" dir="out">
9706	<desc>Array of property flags.</desc>
9707	</param>
9708	<param name="defaults" type="wstring" safearray="yes" dir="out">
9709	<desc>Array of default property values.</desc>
9710	</param>
9711	</method>
9712
9713	</interface>
9714
9715
9716	<!--
9717	// IKeyboard
9718	/////////////////////////////////////////////////////////////////////////
9719	-->
9720
9721	<interface
9722	name="IKeyboard" extends="$unknown"
9723	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
9724	wsmap="managed"
9725	>
9726	<desc>
9727	The IKeyboard interface represents the virtual machine's keyboard. Used
9728	in <link to="IConsole::keyboard"/>.
9729
9730	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
9731	to the virtual machine.
9732
9733	</desc>
9734	<method name="putScancode">
9735	<desc>Sends a scancode to the keyboard.
9736
9737	<result name="VBOX_E_IPRT_ERROR">
9738	Could not send scan code to virtual keyboard.
9739	</result>
9740
9741	</desc>
9742	<param name="scancode" type="long" dir="in"/>
9743	</method>
9744
9745	<method name="putScancodes">
9746	<desc>Sends an array of scancodes to the keyboard.
9747
9748	<result name="VBOX_E_IPRT_ERROR">
9749	Could not send all scan codes to virtual keyboard.
9750	</result>
9751
9752	</desc>
9753	<param name="scancodes" type="long" dir="in" safearray="yes"/>
9754	<param name="codesStored" type="unsigned long" dir="return"/>
9755	</method>
9756
9757	<method name="putCAD">
9758	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
9759	function is nothing special, it is just a convenience function
9760	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
9761
9762	<result name="VBOX_E_IPRT_ERROR">
9763	Could not send all scan codes to virtual keyboard.
9764	</result>
9765
9766	</desc>
9767	</method>
9768
9769	</interface>
9770
9771
9772	<!--
9773	// IMouse
9774	/////////////////////////////////////////////////////////////////////////
9775	-->
9776
9777	<enum
9778	name="MouseButtonState"
9779	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
9780	>
9781	<desc>
9782	Mouse button state.
9783	</desc>
9784
9785	<const name="LeftButton" value="0x01"/>
9786	<const name="RightButton" value="0x02"/>
9787	<const name="MiddleButton" value="0x04"/>
9788	<const name="WheelUp" value="0x08"/>
9789	<const name="WheelDown" value="0x10"/>
9790	<const name="XButton1" value="0x20"/>
9791	<const name="XButton2" value="0x40"/>
9792	<const name="MouseStateMask" value="0x7F"/>
9793	</enum>
9794
9795	<interface
9796	name="IMouse" extends="$unknown"
9797	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
9798	wsmap="managed"
9799	>
9800	<desc>
9801	The IMouse interface represents the virtual machine's mouse. Used in
9802	<link to="IConsole::mouse"/>.
9803
9804	Through this interface, the virtual machine's virtual mouse can be
9805	controlled.
9806	</desc>
9807
9808	<attribute name="absoluteSupported" type="boolean" readonly="yes">
9809	<desc>
9810	Whether the guest OS supports absolute mouse pointer positioning
9811	or not.
9812	<note>
9813	VirtualBox Guest Tools need to be installed to the guest OS
9814	in order to enable absolute mouse positioning support.
9815	You can use the <link to="IConsoleCallback::onMouseCapabilityChange"/>
9816	callback to be instantly informed about changes of this attribute
9817	during virtual machine execution.
9818	</note>
9819	<see><link to="#putMouseEventAbsolute"/></see>
9820	</desc>
9821	</attribute>
9822
9823	<method name="putMouseEvent">
9824	<desc>
9825	Initiates a mouse event using relative pointer movements
9826	along x and y axis.
9827
9828	<result name="E_ACCESSDENIED">
9829	Console not powered up.
9830	</result>
9831	<result name="VBOX_E_IPRT_ERROR">
9832	Could not send mouse event to virtual mouse.
9833	</result>
9834
9835	</desc>
9836
9837	<param name="dx" type="long" dir="in">
9838	<desc>
9839	Amount of pixels the mouse should move to the right.
9840	Negative values move the mouse to the left.
9841	</desc>
9842	</param>
9843	<param name="dy" type="long" dir="in">
9844	<desc>
9845	Amount of pixels the mouse should move downwards.
9846	Negative values move the mouse upwards.
9847	</desc>
9848	</param>
9849	<param name="dz" type="long" dir="in">
9850	<desc>
9851	Amount of mouse wheel moves.
9852	Positive values describe clockwise wheel rotations,
9853	negative values describe counterclockwise rotations.
9854	</desc>
9855	</param>
9856	<param name="dw" type="long" dir="in">
9857	<desc>
9858	Amount of horizontal mouse wheel moves.
9859	Positive values describe a movement to the left,
9860	negative values describe a movement to the right.
9861	</desc>
9862	</param>
9863	<param name="buttonState" type="long" dir="in">
9864	<desc>
9865	The current state of mouse buttons. Every bit represents
9866	a mouse button as follows:
9867	<table>
9868	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9869	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9870	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9871	</table>
9872	A value of <tt>1</tt> means the corresponding button is pressed.
9873	otherwise it is released.
9874	</desc>
9875	</param>
9876	</method>
9877
9878	<method name="putMouseEventAbsolute">
9879	<desc>
9880	Positions the mouse pointer using absolute x and y coordinates.
9881	These coordinates are expressed in pixels and
9882	start from <tt>[1,1]</tt> which corresponds to the top left
9883	corner of the virtual display.
9884
9885	<result name="E_ACCESSDENIED">
9886	Console not powered up.
9887	</result>
9888	<result name="VBOX_E_IPRT_ERROR">
9889	Could not send mouse event to virtual mouse.
9890	</result>
9891
9892	<note>
9893	This method will have effect only if absolute mouse
9894	positioning is supported by the guest OS.
9895	</note>
9896
9897	<see><link to="#absoluteSupported"/></see>
9898	</desc>
9899
9900	<param name="x" type="long" dir="in">
9901	<desc>
9902	X coordinate of the pointer in pixels, starting from @c 1.
9903	</desc>
9904	</param>
9905	<param name="y" type="long" dir="in">
9906	<desc>
9907	Y coordinate of the pointer in pixels, starting from @c 1.
9908	</desc>
9909	</param>
9910	<param name="dz" type="long" dir="in">
9911	<desc>
9912	Amount of mouse wheel moves.
9913	Positive values describe clockwise wheel rotations,
9914	negative values describe counterclockwise rotations.
9915	</desc>
9916	</param>
9917	<param name="dw" type="long" dir="in">
9918	<desc>
9919	Amount of horizontal mouse wheel moves.
9920	Positive values describe a movement to the left,
9921	negative values describe a movement to the right.
9922	</desc>
9923	</param>
9924	<param name="buttonState" type="long" dir="in">
9925	<desc>
9926	The current state of mouse buttons. Every bit represents
9927	a mouse button as follows:
9928	<table>
9929	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
9930	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
9931	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
9932	</table>
9933	A value of @c 1 means the corresponding button is pressed.
9934	otherwise it is released.
9935	</desc>
9936	</param>
9937	</method>
9938
9939	</interface>
9940
9941	<!--
9942	// IDisplay
9943	/////////////////////////////////////////////////////////////////////////
9944	-->
9945
9946	<enum
9947	name="FramebufferPixelFormat"
9948	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
9949	>
9950	<desc>
9951	Format of the video memory buffer. Constants represented by this enum can
9952	be used to test for particular values of <link
9953	to="IFramebuffer::pixelFormat"/>. See also <link
9954	to="IFramebuffer::requestResize"/>.
9955
9956	See also www.fourcc.org for more information about FOURCC pixel formats.
9957	</desc>
9958
9959	<const name="Opaque" value="0">
9960	<desc>
9961	Unknown buffer format (the user may not assume any particular format of
9962	the buffer).
9963	</desc>
9964	</const>
9965	<const name="FOURCC_RGB" value="0x32424752">
9966	<desc>
9967	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
9968	bit layout).
9969	</desc>
9970	</const>
9971	</enum>
9972
9973	<interface
9974	name="IFramebuffer" extends="$unknown"
9975	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
9976	wsmap="suppress"
9977	>
9978	<attribute name="address" type="octet" mod="ptr" readonly="yes">
9979	<desc>Address of the start byte of the frame buffer.</desc>
9980	</attribute>
9981
9982	<attribute name="width" type="unsigned long" readonly="yes">
9983	<desc>Frame buffer width, in pixels.</desc>
9984	</attribute>
9985
9986	<attribute name="height" type="unsigned long" readonly="yes">
9987	<desc>Frame buffer height, in pixels.</desc>
9988	</attribute>
9989
9990	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
9991	<desc>
9992	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
9993	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
9994	are: 8, 15, 16, 24 and 32.
9995	</desc>
9996	</attribute>
9997
9998	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
9999	<desc>
10000	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10001	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10002	size of the scan line must be aligned to 32 bits.
10003	</desc>
10004	</attribute>
10005
10006	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10007	<desc>
10008	Frame buffer pixel format. It's either one of the values defined by <link
10009	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10010	<note>
10011	This attribute must never return <link
10012	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10013	<link to="#address"/> points to must be always known.
10014	</note>
10015	</desc>
10016	</attribute>
10017
10018	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10019	<desc>
10020	Defines whether this frame buffer uses the virtual video card's memory
10021	buffer (guest VRAM) directly or not. See <link
10022	to="IFramebuffer::requestResize"/> for more information.
10023	</desc>
10024	</attribute>
10025
10026	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10027	<desc>
10028	Hint from the frame buffer about how much of the standard
10029	screen height it wants to use for itself. This information is
10030	exposed to the guest through the VESA BIOS and VMMDev interface
10031	so that it can use it for determining its video mode table. It
10032	is not guaranteed that the guest respects the value.
10033	</desc>
10034	</attribute>
10035
10036	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10037	<desc>
10038	An alpha-blended overlay which is superposed over the frame buffer.
10039	The initial purpose is to allow the display of icons providing
10040	information about the VM state, including disk activity, in front
10041	ends which do not have other means of doing that. The overlay is
10042	designed to controlled exclusively by IDisplay. It has no locking
10043	of its own, and any changes made to it are not guaranteed to be
10044	visible until the affected portion of IFramebuffer is updated. The
10045	overlay can be created lazily the first time it is requested. This
10046	attribute can also return @c null to signal that the overlay is not
10047	implemented.
10048	</desc>
10049	</attribute>
10050
10051	<attribute name="winId" type="unsigned long long" readonly="yes">
10052	<desc>
10053	Platform-dependent identifier of the window where context of this
10054	frame buffer is drawn, or zero if there's no such window.
10055	</desc>
10056	</attribute>
10057
10058	<method name="lock">
10059	<desc>
10060	Locks the frame buffer.
10061	Gets called by the IDisplay object where this frame buffer is
10062	bound to.
10063	</desc>
10064	</method>
10065
10066	<method name="unlock">
10067	<desc>
10068	Unlocks the frame buffer.
10069	Gets called by the IDisplay object where this frame buffer is
10070	bound to.
10071	</desc>
10072	</method>
10073
10074	<method name="notifyUpdate">
10075	<desc>
10076	Informs about an update.
10077	Gets called by the display object where this buffer is
10078	registered.
10079	</desc>
10080	<param name="x" type="unsigned long" dir="in"/>
10081	<param name="y" type="unsigned long" dir="in"/>
10082	<param name="width" type="unsigned long" dir="in"/>
10083	<param name="height" type="unsigned long" dir="in"/>
10084	</method>
10085
10086	<method name="requestResize">
10087	<desc>
10088	Requests a size and pixel format change.
10089
10090	There are two modes of working with the video buffer of the virtual
10091	machine. The <i>indirect</i> mode implies that the IFramebuffer
10092	implementation allocates a memory buffer for the requested display mode
10093	and provides it to the virtual machine. In <i>direct</i> mode, the
10094	IFramebuffer implementation uses the memory buffer allocated and owned
10095	by the virtual machine. This buffer represents the video memory of the
10096	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10097	usually faster because the implementation gets a raw pointer to the
10098	guest VRAM buffer which it can directly use for visualizing the contents
10099	of the virtual display, as opposed to the indirect mode where the
10100	contents of guest VRAM are copied to the memory buffer provided by
10101	the implementation every time a display update occurs.
10102
10103	It is important to note that the direct mode is really fast only when
10104	the implementation uses the given guest VRAM buffer directly, for
10105	example, by blitting it to the window representing the virtual machine's
10106	display, which saves at least one copy operation comparing to the
10107	indirect mode. However, using the guest VRAM buffer directly is not
10108	always possible: the format and the color depth of this buffer may be
10109	not supported by the target window, or it may be unknown (opaque) as in
10110	case of text or non-linear multi-plane VGA video modes. In this case,
10111	the indirect mode (that is always available) should be used as a
10112	fallback: when the guest VRAM contents are copied to the
10113	implementation-provided memory buffer, color and format conversion is
10114	done automatically by the underlying code.
10115
10116	The @a pixelFormat parameter defines whether the direct mode is
10117	available or not. If @a pixelFormat is <link
10118	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10119	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10120	@a bytesPerLine parameters must be ignored and the implementation must use
10121	the indirect mode (where it provides its own buffer in one of the
10122	supported formats). In all other cases, @a pixelFormat together with
10123	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10124	buffer pointed to by the @a VRAM parameter and the implementation is
10125	free to choose which mode to use. To indicate that this frame buffer uses
10126	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10127	attribute must return @c true and <link to="#address"/> must
10128	return exactly the same address that is passed in the @a VRAM parameter
10129	of this method; otherwise it is assumed that the indirect strategy is
10130	chosen.
10131
10132	The @a width and @a height parameters represent the size of the
10133	requested display mode in both modes. In case of indirect mode, the
10134	provided memory buffer should be big enough to store data of the given
10135	display mode. In case of direct mode, it is guaranteed that the given
10136	@a VRAM buffer contains enough space to represent the display mode of the
10137	given size. Note that this frame buffer's <link to="#width"/> and <link
10138	to="#height"/> attributes must return exactly the same values as
10139	passed to this method after the resize is completed (see below).
10140
10141	The @a finished output parameter determines if the implementation has
10142	finished resizing the frame buffer or not. If, for some reason, the
10143	resize cannot be finished immediately during this call, @a finished
10144	must be set to @c false, and the implementation must call
10145	<link to="IDisplay::resizeCompleted"/> after it has returned from
10146	this method as soon as possible. If @a finished is @c false, the
10147	machine will not call any frame buffer methods until
10148	<link to="IDisplay::resizeCompleted"/> is called.
10149
10150	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10151	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10152	this frame buffer must return exactly the same values as specified in the
10153	parameters of this method, after the resize is completed. If the
10154	indirect mode is chosen, these attributes must return values describing
10155	the format of the implementation's own memory buffer <link
10156	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10157	value must always correlate with <link to="#pixelFormat"/>. Note that
10158	the <link to="#pixelFormat"/> attribute must never return <link
10159	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10160
10161	<note>
10162	This method is called by the IDisplay object under the
10163	<link to="#lock"/> provided by this IFramebuffer
10164	implementation. If this method returns @c false in @a finished, then
10165	this lock is not released until
10166	<link to="IDisplay::resizeCompleted"/> is called.
10167	</note>
10168	</desc>
10169	<param name="screenId" type="unsigned long" dir="in">
10170	<desc>
10171	Logical screen number. Must be used in the corresponding call to
10172	<link to="IDisplay::resizeCompleted"/> if this call is made.
10173	</desc>
10174	</param>
10175	<param name="pixelFormat" type="unsigned long" dir="in">
10176	<desc>
10177	Pixel format of the memory buffer pointed to by @a VRAM.
10178	See also <link to="FramebufferPixelFormat"/>.
10179	</desc>
10180	</param>
10181	<param name="VRAM" type="octet" mod="ptr" dir="in">
10182	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10183	</param>
10184	<param name="bitsPerPixel" type="unsigned long" dir="in">
10185	<desc>Color depth, bits per pixel.</desc>
10186	</param>
10187	<param name="bytesPerLine" type="unsigned long" dir="in">
10188	<desc>Size of one scan line, in bytes.</desc>
10189	</param>
10190	<param name="width" type="unsigned long" dir="in">
10191	<desc>Width of the guest display, in pixels.</desc>
10192	</param>
10193	<param name="height" type="unsigned long" dir="in">
10194	<desc>Height of the guest display, in pixels.</desc>
10195	</param>
10196	<param name="finished" type="boolean" dir="return">
10197	<desc>
10198	Can the VM start using the new frame buffer immediately
10199	after this method returns or it should wait for
10200	<link to="IDisplay::resizeCompleted"/>.
10201	</desc>
10202	</param>
10203	</method>
10204
10205	<method name="videoModeSupported">
10206	<desc>
10207	Returns whether the frame buffer implementation is willing to
10208	support a given video mode. In case it is not able to render
10209	the video mode (or for some reason not willing), it should
10210	return @c false. Usually this method is called when the guest
10211	asks the VMM device whether a given video mode is supported
10212	so the information returned is directly exposed to the guest.
10213	It is important that this method returns very quickly.
10214	</desc>
10215	<param name="width" type="unsigned long" dir="in"/>
10216	<param name="height" type="unsigned long" dir="in"/>
10217	<param name="bpp" type="unsigned long" dir="in"/>
10218	<param name="supported" type="boolean" dir="return"/>
10219	</method>
10220
10221	<method name="getVisibleRegion">
10222	<desc>
10223	Returns the visible region of this frame buffer.
10224
10225	If the @a rectangles parameter is @c null then the value of the
10226	@a count parameter is ignored and the number of elements necessary to
10227	describe the current visible region is returned in @a countCopied.
10228
10229	If @a rectangles is not @c null but @a count is less
10230	than the required number of elements to store region data, the method
10231	will report a failure. If @a count is equal or greater than the
10232	required number of elements, then the actual number of elements copied
10233	to the provided array will be returned in @a countCopied.
10234
10235	<note>
10236	The address of the provided array must be in the process space of
10237	this IFramebuffer object.
10238	</note>
10239	<note>
10240	Method not yet implemented.
10241	</note>
10242	</desc>
10243	<param name="rectangles" type="octet" mod="ptr" dir="in">
10244	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10245	</param>
10246	<param name="count" type="unsigned long" dir="in">
10247	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10248	</param>
10249	<param name="countCopied" type="unsigned long" dir="return">
10250	<desc>Number of elements copied to the @a rectangles array.</desc>
10251	</param>
10252	</method>
10253
10254	<method name="setVisibleRegion">
10255	<desc>
10256	Suggests a new visible region to this frame buffer. This region
10257	represents the area of the VM display which is a union of regions of
10258	all top-level windows of the guest operating system running inside the
10259	VM (if the Guest Additions for this system support this
10260	functionality). This information may be used by the frontends to
10261	implement the seamless desktop integration feature.
10262
10263	<note>
10264	The address of the provided array must be in the process space of
10265	this IFramebuffer object.
10266	</note>
10267	<note>
10268	The IFramebuffer implementation must make a copy of the provided
10269	array of rectangles.
10270	</note>
10271	<note>
10272	Method not yet implemented.
10273	</note>
10274	</desc>
10275	<param name="rectangles" type="octet" mod="ptr" dir="in">
10276	<desc>Pointer to the @c RTRECT array.</desc>
10277	</param>
10278	<param name="count" type="unsigned long" dir="in">
10279	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10280	</param>
10281	</method>
10282
10283	<method name="processVHWACommand">
10284	<desc>
10285	Posts a Video HW Acceleration Command to the frame buffer for processing.
10286	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10287	are posted from quest to the host to be processed by the host hardware.
10288
10289	<note>
10290	The address of the provided command must be in the process space of
10291	this IFramebuffer object.
10292	</note>
10293	</desc>
10294
10295	<param name="command" type="octet" mod="ptr" dir="in">
10296	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10297	</param>
10298	</method>
10299
10300	</interface>
10301
10302	<interface
10303	name="IFramebufferOverlay" extends="IFramebuffer"
10304	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10305	wsmap="suppress"
10306	>
10307	<desc>
10308	The IFramebufferOverlay interface represents an alpha blended overlay
10309	for displaying status icons above an IFramebuffer. It is always created
10310	not visible, so that it must be explicitly shown. It only covers a
10311	portion of the IFramebuffer, determined by its width, height and
10312	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10313	that order) format, and may be written to directly. Do re-read the
10314	width though, after setting it, as it may be adjusted (increased) to
10315	make it more suitable for the front end.
10316	</desc>
10317	<attribute name="x" type="unsigned long" readonly="yes">
10318	<desc>X position of the overlay, relative to the frame buffer.</desc>
10319	</attribute>
10320
10321	<attribute name="y" type="unsigned long" readonly="yes">
10322	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10323	</attribute>
10324
10325	<attribute name="visible" type="boolean" readonly="no">
10326	<desc>
10327	Whether the overlay is currently visible.
10328	</desc>
10329	</attribute>
10330
10331	<attribute name="alpha" type="unsigned long" readonly="no">
10332	<desc>
10333	The global alpha value for the overlay. This may or may not be
10334	supported by a given front end.
10335	</desc>
10336	</attribute>
10337
10338	<method name="move">
10339	<desc>
10340	Changes the overlay's position relative to the IFramebuffer.
10341	</desc>
10342	<param name="x" type="unsigned long" dir="in"/>
10343	<param name="y" type="unsigned long" dir="in"/>
10344	</method>
10345
10346	</interface>
10347
10348	<interface
10349	name="IDisplay" extends="$unknown"
10350	uuid="e2a38ebc-d854-4a3e-bc2e-fdf5ac4a0000"
10351	wsmap="managed"
10352	>
10353	<desc>
10354	The IDisplay interface represents the virtual machine's display.
10355
10356	The object implementing this interface is contained in each
10357	<link to="IConsole::display"/> attribute and represents the visual
10358	output of the virtual machine.
10359
10360	The virtual display supports pluggable output targets represented by the
10361	IFramebuffer interface. Examples of the output target are a window on
10362	the host computer or an RDP session's display on a remote computer.
10363	</desc>
10364	<attribute name="width" type="unsigned long" readonly="yes">
10365	<desc>Current display width.</desc>
10366	</attribute>
10367
10368	<attribute name="height" type="unsigned long" readonly="yes">
10369	<desc>Current display height.</desc>
10370	</attribute>
10371
10372	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10373	<desc>
10374	Current guest display color depth. Note that this may differ
10375	from <link to="IFramebuffer::bitsPerPixel"/>.
10376	</desc>
10377	</attribute>
10378
10379	<method name="setFramebuffer">
10380	<desc>
10381	Sets the framebuffer for given screen.
10382	</desc>
10383	<param name="screenId" type="unsigned long" dir="in"/>
10384	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10385	</method>
10386
10387	<method name="getFramebuffer">
10388	<desc>
10389	Queries the framebuffer for given screen.
10390	</desc>
10391	<param name="screenId" type="unsigned long" dir="in"/>
10392	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10393	<param name="xOrigin" type="long" dir="out"/>
10394	<param name="yOrigin" type="long" dir="out"/>
10395	</method>
10396
10397	<method name="setVideoModeHint">
10398	<desc>
10399	Asks VirtualBox to request the given video mode from
10400	the guest. This is just a hint and it cannot be guaranteed
10401	that the requested resolution will be used. Guest Additions
10402	are required for the request to be seen by guests. The caller
10403	should issue the request and wait for a resolution change and
10404	after a timeout retry.
10405
10406	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10407	parameters means that the corresponding values should be taken from the
10408	current video mode (i.e. left unchanged).
10409
10410	If the guest OS supports multi-monitor configuration then the @a display
10411	parameter specifies the number of the guest display to send the hint to:
10412	@c 0 is the primary display, @c 1 is the first secondary and
10413	so on. If the multi-monitor configuration is not supported, @a display
10414	must be @c 0.
10415
10416	<result name="E_INVALIDARG">
10417	The @a display is not associated with any monitor.
10418	</result>
10419
10420	</desc>
10421	<param name="width" type="unsigned long" dir="in"/>
10422	<param name="height" type="unsigned long" dir="in"/>
10423	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10424	<param name="display" type="unsigned long" dir="in"/>
10425	</method>
10426
10427	<method name="setSeamlessMode">
10428	<desc>
10429	Enables or disables seamless guest display rendering (seamless desktop
10430	integration) mode.
10431	<note>
10432	Calling this method has no effect if <link
10433	to="IGuest::supportsSeamless"/> returns @c false.
10434	</note>
10435	</desc>
10436	<param name="enabled" type="boolean" dir="in"/>
10437	</method>
10438
10439	<method name="takeScreenShot">
10440	<desc>
10441	Takes a screen shot of the requested size and copies it to the
10442	32-bpp buffer allocated by the caller and pointed to by @a address.
10443
10444	<note>This API can be used only by the COM/XPCOM C++ API as it
10445	requires pointer support. Use <link to="#takeScreenShotSlow" />
10446	with other language bindings.
10447	</note>
10448
10449	<result name="E_NOTIMPL">
10450	Feature not implemented.
10451	</result>
10452	<result name="VBOX_E_IPRT_ERROR">
10453	Could not take a screenshot.
10454	</result>
10455
10456	</desc>
10457	<param name="address" type="octet" mod="ptr" dir="in"/>
10458	<param name="width" type="unsigned long" dir="in"/>
10459	<param name="height" type="unsigned long" dir="in"/>
10460	</method>
10461
10462	<method name="takeScreenShotSlow">
10463	<desc>
10464	Takes a guest screen shot of the requested size and returns it as
10465	an array of bytes in uncompressed 32-bit ARGB format.
10466	This API is slow, but could be the only option to get guest screenshot
10467	for scriptable languages not allowed to manipulate with addresses
10468	directly.
10469
10470	<result name="E_NOTIMPL">
10471	Feature not implemented.
10472	</result>
10473	<result name="VBOX_E_IPRT_ERROR">
10474	Could not take a screenshot.
10475	</result>
10476	</desc>
10477	<param name="width" type="unsigned long" dir="in">
10478	<desc>
10479	Desired image width.
10480	</desc>
10481	</param>
10482	<param name="height" type="unsigned long" dir="in">
10483	<desc>
10484	Desired image height.
10485	</desc>
10486	</param>
10487	<param name="screenData" type="octet" dir="return" safearray="yes">
10488	<desc>
10489	Array with resulting screen data.
10490	</desc>
10491	</param>
10492	</method>
10493
10494	<method name="drawToScreen">
10495	<desc>
10496	Draws a 32-bpp image of the specified size from the given buffer
10497	to the given point on the VM display.
10498
10499	<result name="E_NOTIMPL">
10500	Feature not implemented.
10501	</result>
10502	<result name="VBOX_E_IPRT_ERROR">
10503	Could not draw to screen.
10504	</result>
10505
10506	</desc>
10507	<param name="address" type="octet" mod="ptr" dir="in"/>
10508	<param name="x" type="unsigned long" dir="in"/>
10509	<param name="y" type="unsigned long" dir="in"/>
10510	<param name="width" type="unsigned long" dir="in"/>
10511	<param name="height" type="unsigned long" dir="in"/>
10512	</method>
10513
10514	<method name="invalidateAndUpdate">
10515	<desc>
10516	Does a full invalidation of the VM display and instructs the VM
10517	to update it.
10518
10519	<result name="VBOX_E_IPRT_ERROR">
10520	Could not invalidate and update screen.
10521	</result>
10522
10523	</desc>
10524	</method>
10525
10526	<method name="resizeCompleted">
10527	<desc>
10528	Signals that a framebuffer has completed the resize operation.
10529
10530	<result name="VBOX_E_NOT_SUPPORTED">
10531	Operation only valid for external frame buffers.
10532	</result>
10533
10534	</desc>
10535	<param name="screenId" type="unsigned long" dir="in"/>
10536	</method>
10537
10538	<method name="updateCompleted">
10539	<desc>
10540	Signals that a framebuffer has completed the update operation.
10541
10542	<result name="VBOX_E_NOT_SUPPORTED">
10543	Operation only valid for external frame buffers.
10544	</result>
10545
10546	</desc>
10547	</method>
10548
10549	<method name="completeVHWACommand">
10550	<desc>
10551	Signals that the Video HW Acceleration command has completed.
10552	</desc>
10553
10554	<param name="command" type="octet" mod="ptr" dir="in">
10555	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
10556	</param>
10557	</method>
10558
10559	</interface>
10560
10561	<!--
10562	// INetworkAdapter
10563	/////////////////////////////////////////////////////////////////////////
10564	-->
10565
10566	<enum
10567	name="NetworkAttachmentType"
10568	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
10569	>
10570	<desc>
10571	Network attachment type.
10572	</desc>
10573
10574	<const name="Null" value="0">
10575	<desc>Null value, also means "not attached".</desc>
10576	</const>
10577	<const name="NAT" value="1"/>
10578	<const name="Bridged" value="2"/>
10579	<const name="Internal" value="3"/>
10580	<const name="HostOnly" value="4"/>
10581	</enum>
10582
10583	<enum
10584	name="NetworkAdapterType"
10585	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
10586	>
10587	<desc>
10588	Network adapter type.
10589	</desc>
10590
10591	<const name="Null" value="0">
10592	<desc>Null value (never used by the API).</desc>
10593	</const>
10594	<const name="Am79C970A" value="1">
10595	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
10596	</const>
10597	<const name="Am79C973" value="2">
10598	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
10599	</const>
10600	<const name="I82540EM" value="3">
10601	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
10602	</const>
10603	<const name="I82543GC" value="4">
10604	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
10605	</const>
10606	<const name="I82545EM" value="5">
10607	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
10608	</const>
10609	<const name="Virtio" value="6">
10610	<desc>Virtio network device.</desc>
10611	</const>
10612	</enum>
10613
10614	<interface
10615	name="INetworkAdapter" extends="$unknown"
10616	uuid="65607a27-2b73-4d43-b4cc-0ba2c817fbde"
10617	wsmap="managed"
10618	>
10619	<desc>
10620	Represents a virtual network adapter that is attached to a virtual machine.
10621	Each virtual machine has a fixed number of network adapter slots with one
10622	instance of this attached to each of them. Call
10623	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
10624	is attached to a given slot in a given machine.
10625
10626	Each network adapter can be in one of five attachment modes, which are
10627	represented by the <link to="NetworkAttachmentType" /> enumeration;
10628	see the <link to="#attachmentType" /> attribute.
10629	</desc>
10630
10631	<attribute name="adapterType" type="NetworkAdapterType">
10632	<desc>
10633	Type of the virtual network adapter. Depending on this value,
10634	VirtualBox will provide a different virtual network hardware
10635	to the guest.
10636	</desc>
10637	</attribute>
10638
10639	<attribute name="slot" type="unsigned long" readonly="yes">
10640	<desc>
10641	Slot number this adapter is plugged into. Corresponds to
10642	the value you pass to <link to="IMachine::getNetworkAdapter"/>
10643	to obtain this instance.
10644	</desc>
10645	</attribute>
10646
10647	<attribute name="enabled" type="boolean">
10648	<desc>
10649	Flag whether the network adapter is present in the
10650	guest system. If disabled, the virtual guest hardware will
10651	not contain this network adapter. Can only be changed when
10652	the VM is not running.
10653	</desc>
10654	</attribute>
10655
10656	<attribute name="MACAddress" type="wstring">
10657	<desc>
10658	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
10659	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
10660	</desc>
10661	</attribute>
10662
10663	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
10664
10665	<attribute name="hostInterface" type="wstring">
10666	<desc>
10667	Name of the host network interface the VM is attached to.
10668	</desc>
10669	</attribute>
10670
10671	<attribute name="internalNetwork" type="wstring">
10672	<desc>
10673	Name of the internal network the VM is attached to.
10674	</desc>
10675	</attribute>
10676
10677	<attribute name="NATNetwork" type="wstring">
10678	<desc>
10679	Name of the NAT network the VM is attached to.
10680	</desc>
10681	</attribute>
10682
10683	<attribute name="cableConnected" type="boolean">
10684	<desc>
10685	Flag whether the adapter reports the cable as connected or not.
10686	It can be used to report offline situations to a VM.
10687	</desc>
10688	</attribute>
10689
10690	<attribute name="lineSpeed" type="unsigned long">
10691	<desc>
10692	Line speed reported by custom drivers, in units of 1 kbps.
10693	</desc>
10694	</attribute>
10695
10696	<attribute name="traceEnabled" type="boolean">
10697	<desc>
10698	Flag whether network traffic from/to the network card should be traced.
10699	Can only be toggled when the VM is turned off.
10700	</desc>
10701	</attribute>
10702
10703	<attribute name="traceFile" type="wstring">
10704	<desc>
10705	Filename where a network trace will be stored. If not set, VBox-pid.pcap
10706	will be used.
10707	</desc>
10708	</attribute>
10709
10710	<method name="attachToNAT">
10711	<desc>
10712	Attach the network adapter to the Network Address Translation (NAT) interface.
10713	</desc>
10714	</method>
10715
10716	<method name="attachToBridgedInterface">
10717	<desc>
10718	Attach the network adapter to a bridged host interface.
10719	</desc>
10720	</method>
10721
10722	<method name="attachToInternalNetwork">
10723	<desc>
10724	Attach the network adapter to an internal network.
10725	</desc>
10726	</method>
10727
10728	<method name="attachToHostOnlyInterface">
10729	<desc>
10730	Attach the network adapter to the host-only network.
10731	</desc>
10732	</method>
10733
10734	<method name="detach">
10735	<desc>
10736	Detach the network adapter
10737	</desc>
10738	</method>
10739	</interface>
10740
10741
10742	<!--
10743	// ISerialPort
10744	/////////////////////////////////////////////////////////////////////////
10745	-->
10746
10747	<enum
10748	name="PortMode"
10749	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
10750	>
10751	<desc>
10752	The PortMode enumeration represents possible communication modes for
10753	the virtual serial port device.
10754	</desc>
10755
10756	<const name="Disconnected" value="0">
10757	<desc>Virtual device is not attached to any real host device.</desc>
10758	</const>
10759	<const name="HostPipe" value="1">
10760	<desc>Virtual device is attached to a host pipe.</desc>
10761	</const>
10762	<const name="HostDevice" value="2">
10763	<desc>Virtual device is attached to a host device.</desc>
10764	</const>
10765	<const name="RawFile" value="3">
10766	<desc>Virtual device is attached to a raw file.</desc>
10767	</const>
10768	</enum>
10769
10770	<interface
10771	name="ISerialPort" extends="$unknown"
10772	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
10773	wsmap="managed"
10774	>
10775
10776	<desc>
10777	The ISerialPort interface represents the virtual serial port device.
10778
10779	The virtual serial port device acts like an ordinary serial port
10780	inside the virtual machine. This device communicates to the real
10781	serial port hardware in one of two modes: host pipe or host device.
10782
10783	In host pipe mode, the #path attribute specifies the path to the pipe on
10784	the host computer that represents a serial port. The #server attribute
10785	determines if this pipe is created by the virtual machine process at
10786	machine startup or it must already exist before starting machine
10787	execution.
10788
10789	In host device mode, the #path attribute specifies the name of the
10790	serial port device on the host computer.
10791
10792	There is also a third communication mode: the disconnected mode. In this
10793	mode, the guest OS running inside the virtual machine will be able to
10794	detect the serial port, but all port write operations will be discarded
10795	and all port read operations will return no data.
10796
10797	<see>IMachine::getSerialPort</see>
10798	</desc>
10799
10800	<attribute name="slot" type="unsigned long" readonly="yes">
10801	<desc>
10802	Slot number this serial port is plugged into. Corresponds to
10803	the value you pass to <link to="IMachine::getSerialPort"/>
10804	to obtain this instance.
10805	</desc>
10806	</attribute>
10807
10808	<attribute name="enabled" type="boolean">
10809	<desc>
10810	Flag whether the serial port is enabled. If disabled,
10811	the serial port will not be reported to the guest OS.
10812	</desc>
10813	</attribute>
10814
10815	<attribute name="IOBase" type="unsigned long">
10816	<desc>Base I/O address of the serial port.</desc>
10817	</attribute>
10818
10819	<attribute name="IRQ" type="unsigned long">
10820	<desc>IRQ number of the serial port.</desc>
10821	</attribute>
10822
10823	<attribute name="hostMode" type="PortMode">
10824	<desc>
10825	How is this port connected to the host.
10826	<note>
10827	Changing this attribute may fail if the conditions for
10828	<link to="#path"/> are not met.
10829	</note>
10830	</desc>
10831	</attribute>
10832
10833	<attribute name="server" type="boolean">
10834	<desc>
10835	Flag whether this serial port acts as a server (creates a new pipe on
10836	the host) or as a client (uses the existing pipe). This attribute is
10837	used only when <link to="#hostMode"/> is PortMode_HostPipe.
10838	</desc>
10839	</attribute>
10840
10841	<attribute name="path" type="wstring">
10842	<desc>
10843	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
10844	PortMode_HostPipe, or the host serial device name when
10845	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
10846	cases, setting a @c null or empty string as the attribute's value
10847	is an error. Otherwise, the value of this property is ignored.
10848	</desc>
10849	</attribute>
10850
10851	</interface>
10852
10853	<!--
10854	// IParallelPort
10855	/////////////////////////////////////////////////////////////////////////
10856	-->
10857
10858	<interface
10859	name="IParallelPort" extends="$unknown"
10860	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
10861	wsmap="managed"
10862	>
10863
10864	<desc>
10865	The IParallelPort interface represents the virtual parallel port device.
10866
10867	The virtual parallel port device acts like an ordinary parallel port
10868	inside the virtual machine. This device communicates to the real
10869	parallel port hardware using the name of the parallel device on the host
10870	computer specified in the #path attribute.
10871
10872	Each virtual parallel port device is assigned a base I/O address and an
10873	IRQ number that will be reported to the guest operating system and used
10874	to operate the given parallel port from within the virtual machine.
10875
10876	<see>IMachine::getParallelPort</see>
10877	</desc>
10878
10879	<attribute name="slot" type="unsigned long" readonly="yes">
10880	<desc>
10881	Slot number this parallel port is plugged into. Corresponds to
10882	the value you pass to <link to="IMachine::getParallelPort"/>
10883	to obtain this instance.
10884	</desc>
10885	</attribute>
10886
10887	<attribute name="enabled" type="boolean">
10888	<desc>
10889	Flag whether the parallel port is enabled. If disabled,
10890	the parallel port will not be reported to the guest OS.
10891	</desc>
10892	</attribute>
10893
10894	<attribute name="IOBase" type="unsigned long">
10895	<desc>Base I/O address of the parallel port.</desc>
10896	</attribute>
10897
10898	<attribute name="IRQ" type="unsigned long">
10899	<desc>IRQ number of the parallel port.</desc>
10900	</attribute>
10901
10902	<attribute name="path" type="wstring">
10903	<desc>
10904	Host parallel device name. If this parallel port is enabled, setting a
10905	@c null or an empty string as this attribute's value will result into
10906	an error.
10907	</desc>
10908	</attribute>
10909
10910	</interface>
10911
10912
10913	<!--
10914	// IMachineDebugger
10915	/////////////////////////////////////////////////////////////////////////
10916	-->
10917
10918	<interface
10919	name="IMachineDebugger" extends="$unknown"
10920	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
10921	wsmap="suppress"
10922	>
10923	<method name="resetStats">
10924	<desc>
10925	Reset VM statistics.
10926	</desc>
10927	<param name="pattern" type="wstring" dir="in">
10928	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10929	</param>
10930	</method>
10931
10932	<method name="dumpStats">
10933	<desc>
10934	Dumps VM statistics.
10935	</desc>
10936	<param name="pattern" type="wstring" dir="in">
10937	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10938	</param>
10939	</method>
10940
10941	<method name="getStats">
10942	<desc>
10943	Get the VM statistics in a XMLish format.
10944	</desc>
10945	<param name="pattern" type="wstring" dir="in">
10946	<desc>The selection pattern. A bit similar to filename globbing.</desc>
10947	</param>
10948	<param name="withDescriptions" type="boolean" dir="in">
10949	<desc>Whether to include the descriptions.</desc>
10950	</param>
10951	<param name="stats" type="wstring" dir="out">
10952	<desc>The XML document containing the statistics.</desc>
10953	</param>
10954	</method>
10955
10956	<method name="injectNMI">
10957	<desc>
10958	Inject an NMI into a running VT-x/AMD-V VM.
10959	</desc>
10960	</method>
10961
10962	<attribute name="singlestep" type="boolean">
10963	<desc>Switch for enabling singlestepping.</desc>
10964	</attribute>
10965
10966	<attribute name="recompileUser" type="boolean">
10967	<desc>Switch for forcing code recompilation for user mode code.</desc>
10968	</attribute>
10969
10970	<attribute name="recompileSupervisor" type="boolean">
10971	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
10972	</attribute>
10973
10974	<attribute name="PATMEnabled" type="boolean">
10975	<desc>Switch for enabling and disabling the PATM component.</desc>
10976	</attribute>
10977
10978	<attribute name="CSAMEnabled" type="boolean">
10979	<desc>Switch for enabling and disabling the CSAM component.</desc>
10980	</attribute>
10981
10982	<attribute name="logEnabled" type="boolean">
10983	<desc>Switch for enabling and disabling logging.</desc>
10984	</attribute>
10985
10986	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
10987	<desc>
10988	Flag indicating whether the VM is currently making use of CPU hardware
10989	virtualization extensions.
10990	</desc>
10991	</attribute>
10992
10993	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
10994	<desc>
10995	Flag indicating whether the VM is currently making use of the nested paging
10996	CPU hardware virtualization extension.
10997	</desc>
10998	</attribute>
10999
11000	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11001	<desc>
11002	Flag indicating whether the VM is currently making use of the VPID
11003	VT-x extension.
11004	</desc>
11005	</attribute>
11006
11007	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11008	<desc>
11009	Flag indicating whether the VM is currently making use of the Physical
11010	Address Extension CPU feature.
11011	</desc>
11012	</attribute>
11013
11014	<attribute name="virtualTimeRate" type="unsigned long">
11015	<desc>
11016	The rate at which the virtual time runs expressed as a percentage.
11017	The accepted range is 2% to 20000%.
11018	</desc>
11019	</attribute>
11020
11021	<!-- @todo method for setting log flags, groups and destination! -->
11022
11023	<attribute name="VM" type="unsigned long long" readonly="yes">
11024	<desc>
11025	Gets the VM handle. This is only for internal use while
11026	we carve the details of this interface.
11027	</desc>
11028	</attribute>
11029
11030	</interface>
11031
11032	<!--
11033	// IUSBController
11034	/////////////////////////////////////////////////////////////////////////
11035	-->
11036
11037	<interface
11038	name="IUSBController" extends="$unknown"
11039	uuid="238540fa-4b73-435a-a38e-4e1d9eab5c17"
11040	wsmap="managed"
11041	>
11042	<attribute name="enabled" type="boolean">
11043	<desc>
11044	Flag whether the USB controller is present in the
11045	guest system. If disabled, the virtual guest hardware will
11046	not contain any USB controller. Can only be changed when
11047	the VM is powered off.
11048	</desc>
11049	</attribute>
11050
11051	<attribute name="enabledEhci" type="boolean">
11052	<desc>
11053	Flag whether the USB EHCI controller is present in the
11054	guest system. If disabled, the virtual guest hardware will
11055	not contain a USB EHCI controller. Can only be changed when
11056	the VM is powered off.
11057	</desc>
11058	</attribute>
11059
11060	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11061	<desc>
11062	USB standard version which the controller implements.
11063	This is a BCD which means that the major version is in the
11064	high byte and minor version is in the low byte.
11065	</desc>
11066	</attribute>
11067
11068	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11069	<desc>
11070	List of USB device filters associated with the machine.
11071
11072	If the machine is currently running, these filters are activated
11073	every time a new (supported) USB device is attached to the host
11074	computer that was not ignored by global filters
11075	(<link to="IHost::USBDeviceFilters"/>).
11076
11077	These filters are also activated when the machine is powered up.
11078	They are run against a list of all currently available USB
11079	devices (in states
11080	<link to="USBDeviceState_Available"/>,
11081	<link to="USBDeviceState_Busy"/>,
11082	<link to="USBDeviceState_Held"/>) that were not previously
11083	ignored by global filters.
11084
11085	If at least one filter matches the USB device in question, this
11086	device is automatically captured (attached to) the virtual USB
11087	controller of this machine.
11088
11089	<see>IUSBDeviceFilter, ::IUSBController</see>
11090	</desc>
11091	</attribute>
11092
11093	<method name="createDeviceFilter">
11094	<desc>
11095	Creates a new USB device filter. All attributes except
11096	the filter name are set to empty (any match),
11097	<i>active</i> is @c false (the filter is not active).
11098
11099	The created filter can then be added to the list of filters using
11100	<link to="#insertDeviceFilter"/>.
11101
11102	<result name="VBOX_E_INVALID_VM_STATE">
11103	The virtual machine is not mutable.
11104	</result>
11105
11106	<see>#deviceFilters</see>
11107	</desc>
11108	<param name="name" type="wstring" dir="in">
11109	<desc>
11110	Filter name. See <link to="IUSBDeviceFilter::name"/>
11111	for more info.
11112	</desc>
11113	</param>
11114	<param name="filter" type="IUSBDeviceFilter" dir="return">
11115	<desc>Created filter object.</desc>
11116	</param>
11117	</method>
11118
11119	<method name="insertDeviceFilter">
11120	<desc>
11121	Inserts the given USB device to the specified position
11122	in the list of filters.
11123
11124	Positions are numbered starting from <tt>0</tt>. If the specified
11125	position is equal to or greater than the number of elements in
11126	the list, the filter is added to the end of the collection.
11127
11128	<note>
11129	Duplicates are not allowed, so an attempt to insert a
11130	filter that is already in the collection, will return an
11131	error.
11132	</note>
11133
11134	<result name="VBOX_E_INVALID_VM_STATE">
11135	Virtual machine is not mutable.
11136	</result>
11137	<result name="E_INVALIDARG">
11138	USB device filter not created within this VirtualBox instance.
11139	</result>
11140	<result name="VBOX_E_INVALID_OBJECT_STATE">
11141	USB device filter already in list.
11142	</result>
11143
11144	<see>#deviceFilters</see>
11145	</desc>
11146	<param name="position" type="unsigned long" dir="in">
11147	<desc>Position to insert the filter to.</desc>
11148	</param>
11149	<param name="filter" type="IUSBDeviceFilter" dir="in">
11150	<desc>USB device filter to insert.</desc>
11151	</param>
11152	</method>
11153
11154	<method name="removeDeviceFilter">
11155	<desc>
11156	Removes a USB device filter from the specified position in the
11157	list of filters.
11158
11159	Positions are numbered starting from <tt>0</tt>. Specifying a
11160	position equal to or greater than the number of elements in
11161	the list will produce an error.
11162
11163	<see>#deviceFilters</see>
11164
11165	<result name="VBOX_E_INVALID_VM_STATE">
11166	Virtual machine is not mutable.
11167	</result>
11168	<result name="E_INVALIDARG">
11169	USB device filter list empty or invalid @a position.
11170	</result>
11171
11172	</desc>
11173	<param name="position" type="unsigned long" dir="in">
11174	<desc>Position to remove the filter from.</desc>
11175	</param>
11176	<param name="filter" type="IUSBDeviceFilter" dir="return">
11177	<desc>Removed USB device filter.</desc>
11178	</param>
11179	</method>
11180
11181	</interface>
11182
11183
11184	<!--
11185	// IUSBDevice
11186	/////////////////////////////////////////////////////////////////////////
11187	-->
11188
11189	<interface
11190	name="IUSBDevice" extends="$unknown"
11191	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11192	wsmap="managed"
11193	>
11194	<desc>
11195	The IUSBDevice interface represents a virtual USB device attached to the
11196	virtual machine.
11197
11198	A collection of objects implementing this interface is stored in the
11199	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11200	attached to a running virtual machine's USB controller.
11201	</desc>
11202
11203	<attribute name="id" type="uuid" mod="string" readonly="yes">
11204	<desc>
11205	Unique USB device ID. This ID is built from #vendorId,
11206	#productId, #revision and #serialNumber.
11207	</desc>
11208	</attribute>
11209
11210	<attribute name="vendorId" type="unsigned short" readonly="yes">
11211	<desc>Vendor ID.</desc>
11212	</attribute>
11213
11214	<attribute name="productId" type="unsigned short" readonly="yes">
11215	<desc>Product ID.</desc>
11216	</attribute>
11217
11218	<attribute name="revision" type="unsigned short" readonly="yes">
11219	<desc>
11220	Product revision number. This is a packed BCD represented as
11221	unsigned short. The high byte is the integer part and the low
11222	byte is the decimal.
11223	</desc>
11224	</attribute>
11225
11226	<attribute name="manufacturer" type="wstring" readonly="yes">
11227	<desc>Manufacturer string.</desc>
11228	</attribute>
11229
11230	<attribute name="product" type="wstring" readonly="yes">
11231	<desc>Product string.</desc>
11232	</attribute>
11233
11234	<attribute name="serialNumber" type="wstring" readonly="yes">
11235	<desc>Serial number string.</desc>
11236	</attribute>
11237
11238	<attribute name="address" type="wstring" readonly="yes">
11239	<desc>Host specific address of the device.</desc>
11240	</attribute>
11241
11242	<attribute name="port" type="unsigned short" readonly="yes">
11243	<desc>
11244	Host USB port number the device is physically
11245	connected to.
11246	</desc>
11247	</attribute>
11248
11249	<attribute name="version" type="unsigned short" readonly="yes">
11250	<desc>
11251	The major USB version of the device - 1 or 2.
11252	</desc>
11253	</attribute>
11254
11255	<attribute name="portVersion" type="unsigned short" readonly="yes">
11256	<desc>
11257	The major USB version of the host USB port the device is
11258	physically connected to - 1 or 2. For devices not connected to
11259	anything this will have the same value as the version attribute.
11260	</desc>
11261	</attribute>
11262
11263	<attribute name="remote" type="boolean" readonly="yes">
11264	<desc>
11265	Whether the device is physically connected to a remote VRDP
11266	client or to a local host machine.
11267	</desc>
11268	</attribute>
11269
11270	</interface>
11271
11272
11273	<!--
11274	// IUSBDeviceFilter
11275	/////////////////////////////////////////////////////////////////////////
11276	-->
11277
11278	<interface
11279	name="IUSBDeviceFilter" extends="$unknown"
11280	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11281	wsmap="managed"
11282	>
11283	<desc>
11284	The IUSBDeviceFilter interface represents an USB device filter used
11285	to perform actions on a group of USB devices.
11286
11287	This type of filters is used by running virtual machines to
11288	automatically capture selected USB devices once they are physically
11289	attached to the host computer.
11290
11291	A USB device is matched to the given device filter if and only if all
11292	attributes of the device match the corresponding attributes of the
11293	filter (that is, attributes are joined together using the logical AND
11294	operation). On the other hand, all together, filters in the list of
11295	filters carry the semantics of the logical OR operation. So if it is
11296	desirable to create a match like "this vendor id OR this product id",
11297	one needs to create two filters and specify "any match" (see below)
11298	for unused attributes.
11299
11300	All filter attributes used for matching are strings. Each string
11301	is an expression representing a set of values of the corresponding
11302	device attribute, that will match the given filter. Currently, the
11303	following filtering expressions are supported:
11304
11305	<ul>
11306	<li><i>Interval filters</i>. Used to specify valid intervals for
11307	integer device attributes (Vendor ID, Product ID and Revision).
11308	The format of the string is:
11309
11310	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11311
11312	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11313	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11314	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11315	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11316	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11317	possible integer is assumed.
11318	</li>
11319	<li><i>Boolean filters</i>. Used to specify acceptable values for
11320	boolean device attributes. The format of the string is:
11321
11322	<tt>true\|false\|yes\|no\|0\|1</tt>
11323
11324	</li>
11325	<li><i>Exact match</i>. Used to specify a single value for the given
11326	device attribute. Any string that doesn't start with <tt>int:</tt>
11327	represents the exact match. String device attributes are compared to
11328	this string including case of symbols. Integer attributes are first
11329	converted to a string (see individual filter attributes) and then
11330	compared ignoring case.
11331
11332	</li>
11333	<li><i>Any match</i>. Any value of the corresponding device attribute
11334	will match the given filter. An empty or @c null string is
11335	used to construct this type of filtering expressions.
11336
11337	</li>
11338	</ul>
11339
11340	<note>
11341	On the Windows host platform, interval filters are not currently
11342	available. Also all string filter attributes
11343	(<link to="#manufacturer"/>, <link to="#product"/>,
11344	<link to="#serialNumber"/>) are ignored, so they behave as
11345	<i>any match</i> no matter what string expression is specified.
11346	</note>
11347
11348	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11349	</desc>
11350
11351	<attribute name="name" type="wstring">
11352	<desc>
11353	Visible name for this filter.
11354	This name is used to visually distinguish one filter from another,
11355	so it can neither be @c null nor an empty string.
11356	</desc>
11357	</attribute>
11358
11359	<attribute name="active" type="boolean">
11360	<desc>Whether this filter active or has been temporarily disabled.</desc>
11361	</attribute>
11362
11363	<attribute name="vendorId" type="wstring">
11364	<desc>
11365	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11366	The string representation for the <i>exact matching</i>
11367	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11368	(including leading zeroes).
11369	</desc>
11370	</attribute>
11371
11372	<attribute name="productId" type="wstring">
11373	<desc>
11374	<link to="IUSBDevice::productId">Product ID</link> filter.
11375	The string representation for the <i>exact matching</i>
11376	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11377	(including leading zeroes).
11378	</desc>
11379	</attribute>
11380
11381	<attribute name="revision" type="wstring">
11382	<desc>
11383	<link to="IUSBDevice::productId">Product revision number</link>
11384	filter. The string representation for the <i>exact matching</i>
11385	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11386	of the integer part of the revision, and <tt>F</tt> is the
11387	decimal digit of its fractional part (including leading and
11388	trailing zeros).
11389	Note that for interval filters, it's best to use the hexadecimal
11390	form, because the revision is stored as a 16 bit packed BCD value;
11391	so the expression <tt>int:0x0100-0x0199</tt> will match any
11392	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11393	</desc>
11394	</attribute>
11395
11396	<attribute name="manufacturer" type="wstring">
11397	<desc>
11398	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11399	</desc>
11400	</attribute>
11401
11402	<attribute name="product" type="wstring">
11403	<desc>
11404	<link to="IUSBDevice::product">Product</link> filter.
11405	</desc>
11406	</attribute>
11407
11408	<attribute name="serialNumber" type="wstring">
11409	<desc>
11410	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11411	</desc>
11412	</attribute>
11413
11414	<attribute name="port" type="wstring">
11415	<desc>
11416	<link to="IUSBDevice::port">Host USB port</link> filter.
11417	</desc>
11418	</attribute>
11419
11420	<attribute name="remote" type="wstring">
11421	<desc>
11422	<link to="IUSBDevice::remote">Remote state</link> filter.
11423	<note>
11424	This filter makes sense only for machine USB filters,
11425	i.e. it is ignored by IHostUSBDeviceFilter objects.
11426	</note>
11427	</desc>
11428	</attribute>
11429
11430	<attribute name="maskedInterfaces" type="unsigned long">
11431	<desc>
11432	This is an advanced option for hiding one or more USB interfaces
11433	from the guest. The value is a bit mask where the bits that are set
11434	means the corresponding USB interface should be hidden, masked off
11435	if you like.
11436	This feature only works on Linux hosts.
11437	</desc>
11438	</attribute>
11439
11440	</interface>
11441
11442
11443	<!--
11444	// IHostUSBDevice
11445	/////////////////////////////////////////////////////////////////////////
11446	-->
11447
11448	<enum
11449	name="USBDeviceState"
11450	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11451	>
11452	<desc>
11453	USB device state. This enumeration represents all possible states
11454	of the USB device physically attached to the host computer regarding
11455	its state on the host computer and availability to guest computers
11456	(all currently running virtual machines).
11457
11458	Once a supported USB device is attached to the host, global USB
11459	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11460	either ignore the device, or put it to USBDeviceState_Held state, or do
11461	nothing. Unless the device is ignored by global filters, filters of all
11462	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11463	activated that can put it to USBDeviceState_Captured state.
11464
11465	If the device was ignored by global filters, or didn't match
11466	any filters at all (including guest ones), it is handled by the host
11467	in a normal way. In this case, the device state is determined by
11468	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11469	or USBDeviceState_Available, depending on the current device usage.
11470
11471	Besides auto-capturing based on filters, the device can be manually
11472	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11473	state is USBDeviceState_Busy, USBDeviceState_Available or
11474	USBDeviceState_Held.
11475
11476	<note>
11477	Due to differences in USB stack implementations in Linux and Win32,
11478	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11479	only to the Linux version of the product. This also means that (<link
11480	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11481	device state is USBDeviceState_Held.
11482	</note>
11483
11484	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11485	</desc>
11486
11487	<const name="NotSupported" value="0">
11488	<desc>
11489	Not supported by the VirtualBox server, not available to guests.
11490	</desc>
11491	</const>
11492	<const name="Unavailable" value="1">
11493	<desc>
11494	Being used by the host computer exclusively,
11495	not available to guests.
11496	</desc>
11497	</const>
11498	<const name="Busy" value="2">
11499	<desc>
11500	Being used by the host computer, potentially available to guests.
11501	</desc>
11502	</const>
11503	<const name="Available" value="3">
11504	<desc>
11505	Not used by the host computer, available to guests (the host computer
11506	can also start using the device at any time).
11507	</desc>
11508	</const>
11509	<const name="Held" value="4">
11510	<desc>
11511	Held by the VirtualBox server (ignored by the host computer),
11512	available to guests.
11513	</desc>
11514	</const>
11515	<const name="Captured" value="5">
11516	<desc>
11517	Captured by one of the guest computers, not available
11518	to anybody else.
11519	</desc>
11520	</const>
11521	</enum>
11522
11523	<interface
11524	name="IHostUSBDevice" extends="IUSBDevice"
11525	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
11526	wsmap="managed"
11527	>
11528	<desc>
11529	The IHostUSBDevice interface represents a physical USB device attached
11530	to the host computer.
11531
11532	Besides properties inherited from IUSBDevice, this interface adds the
11533	<link to="#state"/> property that holds the current state of the USB
11534	device.
11535
11536	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
11537	</desc>
11538
11539	<attribute name="state" type="USBDeviceState" readonly="yes">
11540	<desc>
11541	Current state of the device.
11542	</desc>
11543	</attribute>
11544
11545	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
11546
11547	</interface>
11548
11549
11550	<!--
11551	// IHostUSBDeviceFilter
11552	/////////////////////////////////////////////////////////////////////////
11553	-->
11554
11555	<enum
11556	name="USBDeviceFilterAction"
11557	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
11558	>
11559	<desc>
11560	Actions for host USB device filters.
11561	<see>IHostUSBDeviceFilter, USBDeviceState</see>
11562	</desc>
11563
11564	<const name="Null" value="0">
11565	<desc>Null value (never used by the API).</desc>
11566	</const>
11567	<const name="Ignore" value="1">
11568	<desc>Ignore the matched USB device.</desc>
11569	</const>
11570	<const name="Hold" value="2">
11571	<desc>Hold the matched USB device.</desc>
11572	</const>
11573	</enum>
11574
11575	<interface
11576	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
11577	uuid="4cc70246-d74a-400f-8222-3900489c0374"
11578	wsmap="managed"
11579	>
11580	<desc>
11581	The IHostUSBDeviceFilter interface represents a global filter for a
11582	physical USB device used by the host computer. Used indirectly in
11583	<link to="IHost::USBDeviceFilters"/>.
11584
11585	Using filters of this type, the host computer determines the initial
11586	state of the USB device after it is physically attached to the
11587	host's USB controller.
11588
11589	<note>
11590	The <link to="#remote"/> attribute is ignored by this type of
11591	filters, because it makes sense only for
11592	<link to="IUSBController::deviceFilters">machine USB filters</link>.
11593	</note>
11594
11595	<see>IHost::USBDeviceFilters</see>
11596	</desc>
11597
11598	<attribute name="action" type="USBDeviceFilterAction">
11599	<desc>
11600	Action performed by the host when an attached USB device
11601	matches this filter.
11602	</desc>
11603	</attribute>
11604
11605	</interface>
11606
11607	<!--
11608	// IAudioAdapter
11609	/////////////////////////////////////////////////////////////////////////
11610	-->
11611
11612	<enum
11613	name="AudioDriverType"
11614	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
11615	>
11616	<desc>
11617	Host audio driver type.
11618	</desc>
11619
11620	<const name="Null" value="0">
11621	<desc>Null value, also means "dummy audio driver".</desc>
11622	</const>
11623	<const name="WinMM" value="1">
11624	<desc>Windows multimedia (Windows hosts only).</desc>
11625	</const>
11626	<const name="OSS" value="2">
11627	<desc>Open Sound System (Linux hosts only).</desc>
11628	</const>
11629	<const name="ALSA" value="3">
11630	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
11631	</const>
11632	<const name="DirectSound" value="4">
11633	<desc>DirectSound (Windows hosts only).</desc>
11634	</const>
11635	<const name="CoreAudio" value="5">
11636	<desc>CoreAudio (Mac hosts only).</desc>
11637	</const>
11638	<const name="MMPM" value="6">
11639	<desc>Reserved for historical reasons.</desc>
11640	</const>
11641	<const name="Pulse" value="7">
11642	<desc>PulseAudio (Linux hosts only).</desc>
11643	</const>
11644	<const name="SolAudio" value="8">
11645	<desc>Solaris audio (Solaris hosts only).</desc>
11646	</const>
11647	</enum>
11648
11649	<enum
11650	name="AudioControllerType"
11651	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
11652	>
11653	<desc>
11654	Virtual audio controller type.
11655	</desc>
11656
11657	<const name="AC97" value="0"/>
11658	<const name="SB16" value="1"/>
11659	</enum>
11660
11661	<interface
11662	name="IAudioAdapter" extends="$unknown"
11663	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
11664	wsmap="managed"
11665	>
11666	<desc>
11667	The IAudioAdapter interface represents the virtual audio adapter of
11668	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
11669	</desc>
11670	<attribute name="enabled" type="boolean">
11671	<desc>
11672	Flag whether the audio adapter is present in the
11673	guest system. If disabled, the virtual guest hardware will
11674	not contain any audio adapter. Can only be changed when
11675	the VM is not running.
11676	</desc>
11677	</attribute>
11678	<attribute name="audioController" type="AudioControllerType">
11679	<desc>
11680	The audio hardware we emulate.
11681	</desc>
11682	</attribute>
11683	<attribute name="audioDriver" type="AudioDriverType">
11684	<desc>
11685	Audio driver the adapter is connected to. This setting
11686	can only be changed when the VM is not running.
11687	</desc>
11688	</attribute>
11689	</interface>
11690
11691	<!--
11692	// IVRDPServer
11693	/////////////////////////////////////////////////////////////////////////
11694	-->
11695
11696	<enum
11697	name="VRDPAuthType"
11698	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
11699	>
11700	<desc>
11701	VRDP authentication type.
11702	</desc>
11703
11704	<const name="Null" value="0">
11705	<desc>Null value, also means "no authentication".</desc>
11706	</const>
11707	<const name="External" value="1"/>
11708	<const name="Guest" value="2"/>
11709	</enum>
11710
11711	<interface
11712	name="IVRDPServer" extends="$unknown"
11713	uuid="f4584ae7-6bce-474b-83d6-17d235e6aa89"
11714	wsmap="managed"
11715	>
11716	<attribute name="enabled" type="boolean">
11717	<desc>VRDP server status.</desc>
11718	</attribute>
11719
11720	<attribute name="port" type="unsigned long">
11721	<desc>
11722	VRDP server port number.
11723	<note>
11724	Setting the value of this property to <tt>0</tt> will reset the port
11725	number to the default value which is
11726	currently <tt>3389</tt>. Reading this property will always return a
11727	real port number, even after it has been set to <tt>0</tt> (in which
11728	case the default port is returned).
11729	</note>
11730	</desc>
11731	</attribute>
11732
11733	<attribute name="netAddress" type="wstring">
11734	<desc>VRDP server address.</desc>
11735	</attribute>
11736
11737	<attribute name="authType" type="VRDPAuthType">
11738	<desc>VRDP authentication method.</desc>
11739	</attribute>
11740
11741	<attribute name="authTimeout" type="unsigned long">
11742	<desc>Timeout for guest authentication. Milliseconds.</desc>
11743	</attribute>
11744
11745	<attribute name="allowMultiConnection" type="boolean">
11746	<desc>
11747	Flag whether multiple simultaneous connections to the VM are permitted.
11748	Note that this will be replaced by a more powerful mechanism in the future.
11749	</desc>
11750	</attribute>
11751
11752	<attribute name="reuseSingleConnection" type="boolean">
11753	<desc>
11754	Flag whether the existing connection must be dropped and a new connection
11755	must be established by the VRDP server, when a new client connects in single
11756	connection mode.
11757	</desc>
11758	</attribute>
11759
11760	</interface>
11761
11762
11763	<!--
11764	// ISharedFolder
11765	/////////////////////////////////////////////////////////////////////////
11766	-->
11767
11768	<interface
11769	name="ISharedFolder" extends="$unknown"
11770	uuid="64637bb2-9e17-471c-b8f3-f8968dd9884e"
11771	wsmap="struct"
11772	>
11773	<desc>
11774	The ISharedFolder interface represents a folder in the host computer's
11775	file system accessible from the guest OS running inside a virtual
11776	machine using an associated logical name.
11777
11778	There are three types of shared folders:
11779	<ul>
11780	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
11781	folders available to all virtual machines.</li>
11782	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
11783	VM-specific shared folders available to the given virtual machine at
11784	startup.</li>
11785	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
11786	VM-specific shared folders created in the session context (for
11787	example, when the virtual machine is running) and automatically
11788	discarded when the session is closed (the VM is powered off).</li>
11789	</ul>
11790
11791	Logical names of shared folders must be unique within the given scope
11792	(global, permanent or transient). However, they do not need to be unique
11793	across scopes. In this case, the definition of the shared folder in a
11794	more specific scope takes precedence over definitions in all other
11795	scopes. The order of precedence is (more specific to more general):
11796	<ol>
11797	<li>Transient definitions</li>
11798	<li>Permanent definitions</li>
11799	<li>Global definitions</li>
11800	</ol>
11801
11802	For example, if MyMachine has a shared folder named
11803	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
11804	transient shared folder named <tt>C_DRIVE</tt> (that points
11805	to <tt>C:\\\\WINDOWS</tt>) will change the definition
11806	of <tt>C_DRIVE</tt> in the guest OS so
11807	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
11808	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
11809	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
11810	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
11811	to <tt>C:\\</tt> if it still exists.
11812
11813	Note that permanent and transient shared folders of different machines
11814	are in different name spaces, so they don't overlap and don't need to
11815	have unique logical names.
11816
11817	<note>
11818	Global shared folders are not implemented in the current version of the
11819	product.
11820	</note>
11821	</desc>
11822
11823	<attribute name="name" type="wstring" readonly="yes">
11824	<desc>Logical name of the shared folder.</desc>
11825	</attribute>
11826
11827	<attribute name="hostPath" type="wstring" readonly="yes">
11828	<desc>Full path to the shared folder in the host file system.</desc>
11829	</attribute>
11830
11831	<attribute name="accessible" type="boolean" readonly="yes">
11832	<desc>
11833	Whether the folder defined by the host path is currently
11834	accessible or not.
11835	For example, the folder can be unaccessible if it is placed
11836	on the network share that is not available by the time
11837	this property is read.
11838	</desc>
11839	</attribute>
11840
11841	<attribute name="writable" type="boolean" readonly="yes">
11842	<desc>
11843	Whether the folder defined by the host path is writable or
11844	not.
11845	</desc>
11846	</attribute>
11847
11848	<attribute name="lastAccessError" type="wstring" readonly="yes">
11849	<desc>
11850	Text message that represents the result of the last accessibility
11851	check.
11852
11853	Accessibility checks are performed each time the <link to="#accessible"/>
11854	attribute is read. An empty string is returned if the last
11855	accessibility check was successful. A non-empty string indicates a
11856	failure and should normally describe a reason of the failure (for
11857	example, a file read error).
11858	</desc>
11859	</attribute>
11860
11861	</interface>
11862
11863	<!--
11864	// ISession
11865	/////////////////////////////////////////////////////////////////////////
11866	-->
11867
11868	<interface
11869	name="IInternalSessionControl" extends="$unknown"
11870	uuid="989e2c33-8dfa-437a-9a15-5ad441d50dbf"
11871	internal="yes"
11872	wsmap="suppress"
11873	>
11874	<method name="getPID">
11875	<desc>PID of the process that has created this Session object.
11876	</desc>
11877	<param name="pid" type="unsigned long" dir="return"/>
11878	</method>
11879
11880	<method name="getRemoteConsole">
11881	<desc>
11882	Returns the console object suitable for remote control.
11883
11884	<result name="VBOX_E_INVALID_VM_STATE">
11885	Session state prevents operation.
11886	</result>
11887	<result name="VBOX_E_INVALID_OBJECT_STATE">
11888	Session type prevents operation.
11889	</result>
11890
11891	</desc>
11892	<param name="console" type="IConsole" dir="return"/>
11893	</method>
11894
11895	<method name="assignMachine">
11896	<desc>
11897	Assigns the machine object associated with this direct-type
11898	session or informs the session that it will be a remote one
11899	(if @a machine == @c null).
11900
11901	<result name="VBOX_E_INVALID_VM_STATE">
11902	Session state prevents operation.
11903	</result>
11904	<result name="VBOX_E_INVALID_OBJECT_STATE">
11905	Session type prevents operation.
11906	</result>
11907
11908	</desc>
11909	<param name="machine" type="IMachine" dir="in"/>
11910	</method>
11911
11912	<method name="assignRemoteMachine">
11913	<desc>
11914	Assigns the machine and the (remote) console object associated with
11915	this remote-type session.
11916
11917	<result name="VBOX_E_INVALID_VM_STATE">
11918	Session state prevents operation.
11919	</result>
11920
11921	</desc>
11922	<param name="machine" type="IMachine" dir="in"/>
11923	<param name="console" type="IConsole" dir="in"/>
11924	</method>
11925
11926	<method name="updateMachineState">
11927	<desc>
11928	Updates the machine state in the VM process.
11929	Must be called only in certain cases
11930	(see the method implementation).
11931
11932	<result name="VBOX_E_INVALID_VM_STATE">
11933	Session state prevents operation.
11934	</result>
11935	<result name="VBOX_E_INVALID_OBJECT_STATE">
11936	Session type prevents operation.
11937	</result>
11938
11939	</desc>
11940	<param name="aMachineState" type="MachineState" dir="in"/>
11941	</method>
11942
11943	<method name="uninitialize">
11944	<desc>
11945	Uninitializes (closes) this session. Used by VirtualBox to close
11946	the corresponding remote session when the direct session dies
11947	or gets closed.
11948
11949	<result name="VBOX_E_INVALID_VM_STATE">
11950	Session state prevents operation.
11951	</result>
11952
11953	</desc>
11954	</method>
11955
11956	<method name="onNetworkAdapterChange">
11957	<desc>
11958	Triggered when settings of a network adapter of the
11959	associated virtual machine have changed.
11960
11961	<result name="VBOX_E_INVALID_VM_STATE">
11962	Session state prevents operation.
11963	</result>
11964	<result name="VBOX_E_INVALID_OBJECT_STATE">
11965	Session type prevents operation.
11966	</result>
11967
11968	</desc>
11969	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
11970	<param name="changeAdapter" type="boolean" dir="in"/>
11971	</method>
11972
11973	<method name="onSerialPortChange">
11974	<desc>
11975	Triggered when settings of a serial port of the
11976	associated virtual machine have changed.
11977
11978	<result name="VBOX_E_INVALID_VM_STATE">
11979	Session state prevents operation.
11980	</result>
11981	<result name="VBOX_E_INVALID_OBJECT_STATE">
11982	Session type prevents operation.
11983	</result>
11984
11985	</desc>
11986	<param name="serialPort" type="ISerialPort" dir="in"/>
11987	</method>
11988
11989	<method name="onParallelPortChange">
11990	<desc>
11991	Triggered when settings of a parallel port of the
11992	associated virtual machine have changed.
11993
11994	<result name="VBOX_E_INVALID_VM_STATE">
11995	Session state prevents operation.
11996	</result>
11997	<result name="VBOX_E_INVALID_OBJECT_STATE">
11998	Session type prevents operation.
11999	</result>
12000
12001	</desc>
12002	<param name="parallelPort" type="IParallelPort" dir="in"/>
12003	</method>
12004
12005	<method name="onStorageControllerChange">
12006	<desc>
12007	Triggered when settings of a storage controller of the
12008	associated virtual machine have changed.
12009
12010	<result name="VBOX_E_INVALID_VM_STATE">
12011	Session state prevents operation.
12012	</result>
12013	<result name="VBOX_E_INVALID_OBJECT_STATE">
12014	Session type prevents operation.
12015	</result>
12016
12017	</desc>
12018	</method>
12019
12020	<method name="onMediumChange">
12021	<desc>
12022	Triggered when attached media of the
12023	associated virtual machine have changed.
12024
12025	<result name="VBOX_E_INVALID_VM_STATE">
12026	Session state prevents operation.
12027	</result>
12028	<result name="VBOX_E_INVALID_OBJECT_STATE">
12029	Session type prevents operation.
12030	</result>
12031
12032	</desc>
12033
12034	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12035	</method>
12036
12037	<method name="onVRDPServerChange">
12038	<desc>
12039	Triggered when settings of the VRDP server object of the
12040	associated virtual machine have changed.
12041
12042	<result name="VBOX_E_INVALID_VM_STATE">
12043	Session state prevents operation.
12044	</result>
12045	<result name="VBOX_E_INVALID_OBJECT_STATE">
12046	Session type prevents operation.
12047	</result>
12048
12049	</desc>
12050	</method>
12051
12052	<method name="onUSBControllerChange">
12053	<desc>
12054	Triggered when settings of the USB controller object of the
12055	associated virtual machine have changed.
12056
12057	<result name="VBOX_E_INVALID_VM_STATE">
12058	Session state prevents operation.
12059	</result>
12060	<result name="VBOX_E_INVALID_OBJECT_STATE">
12061	Session type prevents operation.
12062	</result>
12063
12064	</desc>
12065	</method>
12066
12067	<method name="onSharedFolderChange">
12068	<desc>
12069	Triggered when a permanent (global or machine) shared folder has been
12070	created or removed.
12071	<note>
12072	We don't pass shared folder parameters in this notification because
12073	the order in which parallel notifications are delivered is not defined,
12074	therefore it could happen that these parameters were outdated by the
12075	time of processing this notification.
12076	</note>
12077
12078	<result name="VBOX_E_INVALID_VM_STATE">
12079	Session state prevents operation.
12080	</result>
12081	<result name="VBOX_E_INVALID_OBJECT_STATE">
12082	Session type prevents operation.
12083	</result>
12084
12085	</desc>
12086	<param name="global" type="boolean" dir="in"/>
12087	</method>
12088
12089	<method name="onUSBDeviceAttach">
12090	<desc>
12091	Triggered when a request to capture a USB device (as a result
12092	of matched USB filters or direct call to
12093	<link to="IConsole::attachUSBDevice"/>) has completed.
12094	A @c null @a error object means success, otherwise it
12095	describes a failure.
12096
12097	<result name="VBOX_E_INVALID_VM_STATE">
12098	Session state prevents operation.
12099	</result>
12100	<result name="VBOX_E_INVALID_OBJECT_STATE">
12101	Session type prevents operation.
12102	</result>
12103
12104	</desc>
12105	<param name="device" type="IUSBDevice" dir="in"/>
12106	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12107	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12108	</method>
12109
12110	<method name="onUSBDeviceDetach">
12111	<desc>
12112	Triggered when a request to release the USB device (as a result
12113	of machine termination or direct call to
12114	<link to="IConsole::detachUSBDevice"/>) has completed.
12115	A @c null @a error object means success, otherwise it
12116	describes a failure.
12117
12118	<result name="VBOX_E_INVALID_VM_STATE">
12119	Session state prevents operation.
12120	</result>
12121	<result name="VBOX_E_INVALID_OBJECT_STATE">
12122	Session type prevents operation.
12123	</result>
12124
12125	</desc>
12126	<param name="id" type="uuid" mod="string" dir="in"/>
12127	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12128	</method>
12129
12130	<method name="onShowWindow">
12131	<desc>
12132	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12133	<link to="IMachine::showConsoleWindow"/> in order to notify
12134	console callbacks
12135	<link to="IConsoleCallback::onCanShowWindow"/>
12136	and <link to="IConsoleCallback::onShowWindow"/>.
12137
12138	<result name="VBOX_E_INVALID_OBJECT_STATE">
12139	Session type prevents operation.
12140	</result>
12141
12142	</desc>
12143	<param name="check" type="boolean" dir="in"/>
12144	<param name="canShow" type="boolean" dir="out"/>
12145	<param name="winId" type="unsigned long long" dir="out"/>
12146	</method>
12147
12148	<method name="accessGuestProperty">
12149	<desc>
12150	Called by <link to="IMachine::getGuestProperty"/> and by
12151	<link to="IMachine::setGuestProperty"/> in order to read and
12152	modify guest properties.
12153
12154	<result name="VBOX_E_INVALID_VM_STATE">
12155	Machine session is not open.
12156	</result>
12157	<result name="VBOX_E_INVALID_OBJECT_STATE">
12158	Session type is not direct.
12159	</result>
12160
12161	</desc>
12162	<param name="name" type="wstring" dir="in"/>
12163	<param name="value" type="wstring" dir="in"/>
12164	<param name="flags" type="wstring" dir="in"/>
12165	<param name="isSetter" type="boolean" dir="in"/>
12166	<param name="retValue" type="wstring" dir="out"/>
12167	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12168	<param name="retFlags" type="wstring" dir="out"/>
12169	</method>
12170
12171	<method name="enumerateGuestProperties">
12172	<desc>
12173	Return a list of the guest properties matching a set of patterns along
12174	with their values, time stamps and flags.
12175
12176	<result name="VBOX_E_INVALID_VM_STATE">
12177	Machine session is not open.
12178	</result>
12179	<result name="VBOX_E_INVALID_OBJECT_STATE">
12180	Session type is not direct.
12181	</result>
12182
12183	</desc>
12184	<param name="patterns" type="wstring" dir="in">
12185	<desc>
12186	The patterns to match the properties against as a comma-separated
12187	string. If this is empty, all properties currently set will be
12188	returned.
12189	</desc>
12190	</param>
12191	<param name="key" type="wstring" dir="out" safearray="yes">
12192	<desc>
12193	The key names of the properties returned.
12194	</desc>
12195	</param>
12196	<param name="value" type="wstring" dir="out" safearray="yes">
12197	<desc>
12198	The values of the properties returned. The array entries match the
12199	corresponding entries in the @a key array.
12200	</desc>
12201	</param>
12202	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12203	<desc>
12204	The time stamps of the properties returned. The array entries match
12205	the corresponding entries in the @a key array.
12206	</desc>
12207	</param>
12208	<param name="flags" type="wstring" dir="out" safearray="yes">
12209	<desc>
12210	The flags of the properties returned. The array entries match the
12211	corresponding entries in the @a key array.
12212	</desc>
12213	</param>
12214	</method>
12215
12216	</interface>
12217
12218	<interface
12219	name="ISession" extends="$dispatched"
12220	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12221	wsmap="managed"
12222	>
12223	<desc>
12224	The ISession interface represents a serialization primitive for virtual
12225	machines.
12226
12227	With VirtualBox, every time one wishes to manipulate a virtual machine
12228	(e.g. change its settings or start execution), a session object is
12229	required. Such an object must be passed to one of the session methods
12230	that open the given session, which then initiates the machine manipulation.
12231
12232	A session serves several purposes: it identifies to the inter-process VirtualBox
12233	code which process is currently working with the virtual machine, and it ensures
12234	that there are no incompatible requests from several processes for the
12235	same virtual machine. Session objects can therefore be thought of as mutex
12236	semaphores that lock virtual machines to prevent conflicting accesses from
12237	several processes.
12238
12239	How sessions objects are used depends on whether you use the Main API
12240	via COM or via the webservice:
12241
12242	<ul>
12243	<li>When using the COM API directly, an object of the Session class from the
12244	VirtualBox type library needs to be created. In regular COM C++ client code,
12245	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12246	This object will then act as a local session object in further calls to open
12247	a session.
12248	</li>
12249
12250	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12251	one session object automatically when <link to="IWebsessionManager::logon" />
12252	is called. A managed object reference to that session object can be retrieved by
12253	calling <link to="IWebsessionManager::getSessionObject" />. This session object
12254	reference can then be used to open sessions.
12255	</li>
12256	</ul>
12257
12258	Sessions are mainly used in two variations:
12259
12260	<ul>
12261	<li>
12262	To start a virtual machine in a separate process, one would call
12263	<link to="IVirtualBox::openRemoteSession"/>, which requires a session
12264	object as its first parameter. This session then identifies the caller
12265	and lets him control the started machine (for example, pause machine
12266	execution or power it down) as well as be notified about machine
12267	execution state changes.
12268	</li>
12269
12270	<li>To alter machine settings, or to start machine execution within the
12271	current process, one needs to open a direct session for the machine first by
12272	calling <link to="IVirtualBox::openSession"/>. While a direct session
12273	is open within one process, no any other process may open another direct
12274	session for the same machine. This prevents the machine from being changed
12275	by other processes while it is running or while the machine is being configured.
12276	</li>
12277	</ul>
12278
12279	One also can attach to an existing direct session already opened by
12280	another process (for example, in order to send a control request to the
12281	virtual machine such as the pause or the reset request). This is done by
12282	calling <link to="IVirtualBox::openExistingSession"/>.
12283
12284	<note>
12285	Unless you are trying to write a new VirtualBox front-end that
12286	performs direct machine execution (like the VirtualBox or VBoxSDL
12287	front-ends), don't call <link to="IConsole::powerUp"/> in a direct
12288	session opened by <link to="IVirtualBox::openSession"/> and use this
12289	session only to change virtual machine settings. If you simply want to
12290	start virtual machine execution using one of the existing front-ends
12291	(for example the VirtualBox GUI or headless server), simply use
12292	<link to="IVirtualBox::openRemoteSession"/>; these front-ends
12293	will power up the machine automatically for you.
12294	</note>
12295	</desc>
12296
12297	<attribute name="state" type="SessionState" readonly="yes">
12298	<desc>Current state of this session.</desc>
12299	</attribute>
12300
12301	<attribute name="type" type="SessionType" readonly="yes">
12302	<desc>
12303	Type of this session. The value of this attribute is valid only
12304	if the session is currently open (i.e. its #state is
12305	SessionType_SessionOpen), otherwise an error will be returned.
12306	</desc>
12307	</attribute>
12308
12309	<attribute name="machine" type="IMachine" readonly="yes">
12310	<desc>Machine object associated with this session.</desc>
12311	</attribute>
12312
12313	<attribute name="console" type="IConsole" readonly="yes">
12314	<desc>Console object associated with this session.</desc>
12315	</attribute>
12316
12317	<method name="close">
12318	<desc>
12319	Closes a session that was previously opened.
12320
12321	It is recommended that every time an "open session" method (such as
12322	<link to="IVirtualBox::openRemoteSession" /> or
12323	<link to="IVirtualBox::openSession" />) has been called to
12324	manipulate a virtual machine, the caller invoke
12325	ISession::close() when it's done doing so. Since sessions are
12326	serialization primitives much like ordinary mutexes, they are
12327	best used the same way: for each "open" call, there should be
12328	a matching "close" call, even when errors occur.
12329
12330	Otherwise, if a direct session for a machine opened with
12331	<link to="IVirtualBox::openSession"/> is not explicitly closed
12332	when the application terminates, the state of the machine will
12333	be set to <link to="MachineState_Aborted" /> on the server.
12334
12335	Generally, it is recommended to close all open sessions explicitly
12336	before terminating the application (regardless of the reason for
12337	the termination).
12338
12339	<note>
12340	Do not expect the session state (<link to="ISession::state" />
12341	to return to "Closed" immediately after you invoke
12342	ISession::close(), particularly if you have started a remote
12343	session to execute the VM in a new process. The session state will
12344	automatically return to "Closed" once the VM is no longer executing,
12345	which can of course take a very long time.
12346	</note>
12347
12348	<result name="E_UNEXPECTED">
12349	Session is not open.
12350	</result>
12351
12352	</desc>
12353	</method>
12354
12355	</interface>
12356
12357	<!--
12358	// IStorageController
12359	/////////////////////////////////////////////////////////////////////////
12360	-->
12361
12362	<enum
12363	name="StorageBus"
12364	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12365	>
12366	<desc>
12367	The bus type of the storage controller (IDE, SATA, SCSI or Floppy);
12368	see <link to="IStorageController::bus" />.
12369	</desc>
12370	<const name="Null" value="0">
12371	<desc>@c null value. Never used by the API.</desc>
12372	</const>
12373	<const name="IDE" value="1"/>
12374	<const name="SATA" value="2"/>
12375	<const name="SCSI" value="3"/>
12376	<const name="Floppy" value="4"/>
12377	</enum>
12378
12379	<enum
12380	name="StorageControllerType"
12381	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12382	>
12383	<desc>
12384	The exact variant of storage controller hardware presented
12385	to the guest; see <link to="IStorageController::controllerType" />.
12386	</desc>
12387
12388	<const name="Null" value="0">
12389	<desc>@c null value. Never used by the API.</desc>
12390	</const>
12391	<const name="LsiLogic" value="1">
12392	<desc>A SCSI controller of the LsiLogic variant.</desc>
12393	</const>
12394	<const name="BusLogic" value="2">
12395	<desc>A SCSI controller of the BusLogic variant.</desc>
12396	</const>
12397	<const name="IntelAhci" value="3">
12398	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12399	</const>
12400	<const name="PIIX3" value="4">
12401	<desc>An IDE controller of the PIIX3 variant.</desc>
12402	</const>
12403	<const name="PIIX4" value="5">
12404	<desc>An IDE controller of the PIIX4 variant.</desc>
12405	</const>
12406	<const name="ICH6" value="6">
12407	<desc>An IDE controller of the ICH6 variant.</desc>
12408	</const>
12409	<const name="I82078" value="7">
12410	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12411	</const>
12412	</enum>
12413
12414	<interface
12415	name="IStorageController" extends="$unknown"
12416	uuid="6bf8335b-d14a-44a5-9b45-ddc49ce7d5b2"
12417	wsmap="managed"
12418	>
12419	<desc>
12420	Represents a storage controller that is attached to a virtual machine
12421	(<link to="IMachine" />). Just as disks (hard disks, DVDs, FDs) are
12422	attached to storage controllers in a real computer, virtual media
12423	(represented by <link to="IMedium" />) are attached to virtual
12424	storage controllers, represented by this interface.
12425
12426	As opposed to physical hardware, VirtualBox has a very generic concept
12427	of a storage controller, and for purposes of the Main API, all virtual
12428	storage is attached to virtual machines via instances of this interface.
12429	There are four types of such virtual storage controllers: IDE, SCSI, SATA
12430	and Floppy (see <link to="#bus" />). Depending on which of these four is
12431	used, certain sub-types may be available and can be selected in
12432	<link to="#controllerType" />.
12433
12434	Depending on these settings, the guest operating system might see
12435	significantly different virtual hardware.
12436	</desc>
12437
12438	<attribute name="name" type="wstring" readonly="yes">
12439	<desc>
12440	Name of the storage controller, as originally specified with
12441	<link to="IMachine::addStorageController" />. This then uniquely
12442	identifies this controller with other method calls such as
12443	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
12444	</desc>
12445	</attribute>
12446
12447	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
12448	<desc>
12449	Maximum number of devices which can be attached to one port.
12450	</desc>
12451	</attribute>
12452
12453	<attribute name="minPortCount" type="unsigned long" readonly="yes">
12454	<desc>
12455	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
12456	</desc>
12457	</attribute>
12458
12459	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
12460	<desc>
12461	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
12462	</desc>
12463	</attribute>
12464
12465	<attribute name="instance" type="unsigned long">
12466	<desc>
12467	The instance number of the device in the running VM.
12468	</desc>
12469	</attribute>
12470
12471	<attribute name="portCount" type="unsigned long">
12472	<desc>
12473	The number of currently usable ports on the controller.
12474	The minimum and maximum number of ports for one controller are
12475	stored in <link to="IStorageController::minPortCount"/>
12476	and <link to="IStorageController::maxPortCount"/>.
12477	</desc>
12478	</attribute>
12479
12480	<attribute name="bus" type="StorageBus" readonly="yes">
12481	<desc>
12482	The bus type of the storage controller (IDE, SATA, SCSI or Floppy).
12483	</desc>
12484	</attribute>
12485
12486	<attribute name="controllerType" type="StorageControllerType">
12487	<desc>
12488	The exact variant of storage controller hardware presented
12489	to the guest.
12490	Depending on this value, VirtualBox will provide a different
12491	virtual storage controller hardware to the guest.
12492	For SATA and floppy controllers, only one variant is available,
12493	but for IDE and SCSI, there are several.
12494
12495	For SCSI controllers, the default type is LsiLogic.
12496	</desc>
12497	</attribute>
12498
12499	<method name="GetIDEEmulationPort">
12500	<desc>
12501	Gets the corresponding port number which is emulated as an IDE device.
12502	Works only with SATA controllers.
12503
12504	<result name="E_INVALIDARG">
12505	The @a devicePosition is not in the range 0 to 3.
12506	</result>
12507	<result name="E_NOTIMPL">
12508	The storage controller type is not SATAIntelAhci.
12509	</result>
12510
12511	</desc>
12512	<param name="devicePosition" type="long" dir="in"/>
12513	<param name="portNumber" type="long" dir="return"/>
12514	</method>
12515
12516	<method name="SetIDEEmulationPort">
12517	<desc>
12518	Sets the port number which is emulated as an IDE device.
12519	Works only with SATA controllers.
12520
12521	<result name="E_INVALIDARG">
12522	The @a devicePosition is not in the range 0 to 3 or the
12523	@a portNumber is not in the range 0 to 29.
12524	</result>
12525	<result name="E_NOTIMPL">
12526	The storage controller type is not SATAIntelAhci.
12527	</result>
12528
12529	</desc>
12530	<param name="devicePosition" type="long" dir="in"/>
12531	<param name="portNumber" type="long" dir="in"/>
12532	</method>
12533
12534	</interface>
12535
12536	<if target="wsdl">
12537
12538	<!--
12539	// IManagedObjectRef
12540	/////////////////////////////////////////////////////////////////////////
12541	-->
12542
12543	<interface
12544	name="IManagedObjectRef" extends="$unknown"
12545	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
12546	internal="yes"
12547	wsmap="managed"
12548	wscpp="hardcoded"
12549	>
12550	<desc>
12551	Managed object reference.
12552
12553	Only within the webservice, a managed object reference (which is really
12554	an opaque number) allows a webservice client to address an object
12555	that lives in the address space of the webservice server.
12556
12557	Behind each managed object reference, there is a COM object that lives
12558	in the webservice server's address space. The COM object is not freed
12559	until the managed object reference is released, either by an explicit
12560	call to <link to="IManagedObjectRef::release" /> or by logging off from
12561	the webservice (<link to="IWebsessionManager::logoff" />), which releases
12562	all objects created during the webservice session.
12563
12564	Whenever a method call of the VirtualBox API returns a COM object, the
12565	webservice representation of that method will instead return a
12566	managed object reference, which can then be used to invoke methods
12567	on that object.
12568	</desc>
12569
12570	<method name="getInterfaceName">
12571	<desc>
12572	Returns the name of the interface that this managed object represents,
12573	for example, "IMachine", as a string.
12574	</desc>
12575	<param name="return" type="wstring" dir="return"/>
12576	</method>
12577
12578	<method name="release">
12579	<desc>
12580	Releases this managed object reference and frees the resources that
12581	were allocated for it in the webservice server process. After calling
12582	this method, the identifier of the reference can no longer be used.
12583	</desc>
12584	</method>
12585
12586	</interface>
12587
12588	<!--
12589	// IWebsessionManager
12590	/////////////////////////////////////////////////////////////////////////
12591	-->
12592
12593	<interface
12594	name="IWebsessionManager" extends="$unknown"
12595	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
12596	internal="yes"
12597	wsmap="global"
12598	wscpp="hardcoded"
12599	>
12600	<desc>
12601	Websession manager. This provides essential services
12602	to webservice clients.
12603	</desc>
12604	<method name="logon">
12605	<desc>
12606	Logs a new client onto the webservice and returns a managed object reference to
12607	the IVirtualBox instance, which the client can then use as a basis to further
12608	queries, since all calls to the VirtualBox API are based on the IVirtualBox
12609	interface, in one way or the other.
12610	</desc>
12611	<param name="username" type="wstring" dir="in"/>
12612	<param name="password" type="wstring" dir="in"/>
12613	<param name="return" type="IVirtualBox" dir="return"/>
12614	</method>
12615
12616	<method name="getSessionObject">
12617	<desc>
12618	Returns a managed object reference to the internal ISession object that was created
12619	for this web service session when the client logged on.
12620
12621	<see>ISession</see>
12622	</desc>
12623	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12624	<param name="return" type="ISession" dir="return"/>
12625	</method>
12626
12627	<method name="logoff">
12628	<desc>
12629	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
12630	and destroys all resources associated with the session (most importantly, all
12631	managed objects created in the server while the session was active).
12632	</desc>
12633	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
12634	</method>
12635
12636	</interface>
12637
12638	</if>
12639
12640	<!--
12641	// IPerformanceCollector & friends
12642	/////////////////////////////////////////////////////////////////////////
12643	-->
12644
12645	<interface
12646	name="IPerformanceMetric" extends="$unknown"
12647	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
12648	>
12649	<desc>
12650	The IPerformanceMetric interface represents parameters of the given
12651	performance metric.
12652	</desc>
12653
12654	<attribute name="metricName" type="wstring" readonly="yes">
12655	<desc>
12656	Name of the metric.
12657	</desc>
12658	</attribute>
12659
12660	<attribute name="object" type="$unknown" readonly="yes">
12661	<desc>
12662	Object this metric belongs to.
12663	</desc>
12664	</attribute>
12665
12666	<attribute name="description" type="wstring" readonly="yes">
12667	<desc>
12668	Textual description of the metric.
12669	</desc>
12670	</attribute>
12671
12672	<attribute name="period" type="unsigned long" readonly="yes">
12673	<desc>
12674	Time interval between samples, measured in seconds.
12675	</desc>
12676	</attribute>
12677
12678	<attribute name="count" type="unsigned long" readonly="yes">
12679	<desc>
12680	Number of recent samples retained by the performance collector for this
12681	metric.
12682
12683	When the collected sample count exceeds this number, older samples
12684	are discarded.
12685	</desc>
12686	</attribute>
12687
12688	<attribute name="unit" type="wstring" readonly="yes">
12689	<desc>
12690	Unit of measurement.
12691	</desc>
12692	</attribute>
12693
12694	<attribute name="minimumValue" type="long" readonly="yes">
12695	<desc>
12696	Minimum possible value of this metric.
12697	</desc>
12698	</attribute>
12699
12700	<attribute name="maximumValue" type="long" readonly="yes">
12701	<desc>
12702	Maximum possible value of this metric.
12703	</desc>
12704	</attribute>
12705	</interface>
12706
12707	<interface
12708	name="IPerformanceCollector" extends="$unknown"
12709	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
12710	wsmap="managed"
12711	>
12712	<desc>
12713	The IPerformanceCollector interface represents a service that collects and
12714	stores performance metrics data.
12715
12716	Performance metrics are associated with objects of interfaces like IHost and
12717	IMachine. Each object has a distinct set of performance metrics.
12718	The set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
12719
12720	Metric data is collected at the specified intervals and is retained
12721	internally. The interval and the number of retained samples can be set
12722	with <link to="IPerformanceCollector::setupMetrics" />.
12723
12724	Metrics are organized hierarchically, with each level separated by a
12725	slash (/) character. Generally, the scheme for metric names is like this:
12726
12727	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
12728
12729	"Category/Metric" together form the base metric name. A base metric is the
12730	smallest unit for which a sampling interval and the number of retained
12731	samples can be set. Only base metrics can be enabled and disabled. All
12732	sub-metrics are collected when their base metric is collected.
12733	Collected values for any set of sub-metrics can be queried with
12734	<link to="IPerformanceCollector::queryMetricsData" />.
12735
12736	For example "CPU/Load/User:avg"
12737	metric name stands for the "CPU" category, "Load" metric, "User" submetric,
12738	"average" aggregate. An aggregate function is computed over all retained
12739	data. Valid aggregate functions are:
12740
12741	<ul>
12742	<li>avg -- average</li>
12743	<li>min -- minimum</li>
12744	<li>max -- maximum</li>
12745	</ul>
12746
12747	When setting up
12748	metric parameters, querying metric data, enabling or disabling metrics
12749	wildcards can be used in metric names to specify a subset of metrics. For
12750	example, to select all CPU-related metrics use <tt>CPU/*</tt>, all
12751	averages can be queried using <tt>*:avg</tt> and so on. To query metric
12752	values without aggregates <tt>*:</tt> can be used.
12753
12754	The valid names for base metrics are:
12755
12756	<ul>
12757	<li>CPU/Load</li>
12758	<li>CPU/MHz</li>
12759	<li>RAM/Usage</li>
12760	</ul>
12761
12762	The general sequence for collecting and retrieving the metrics is:
12763	<ul>
12764	<li>
12765	Obtain an instance of IPerformanceCollector with
12766	<link to="IVirtualBox::performanceCollector" />
12767	</li>
12768	<li>
12769	Allocate and populate an array with references to objects the metrics
12770	will be collected for. Use references to IHost and IMachine objects.
12771	</li>
12772	<li>
12773	Allocate and populate an array with base metric names the data will be
12774	collected for.
12775	</li>
12776	<li>
12777	Call <link to="IPerformanceCollector::setupMetrics" />. From now on the
12778	metric data will be collected and stored.
12779	</li>
12780	<li>
12781	Wait for the data to get collected.
12782	</li>
12783	<li>
12784	Allocate and populate an array with references to objects the metric
12785	values will be queried for. You can re-use the object array used for
12786	setting base metrics.
12787	</li>
12788	<li>
12789	Allocate and populate an array with metric names the data will be
12790	collected for. Note that metric names differ from base metric names.
12791	</li>
12792	<li>
12793	Call <link to="IPerformanceCollector::queryMetricsData" />. The data that
12794	have been collected so far are returned. Note that the values are still
12795	retained internally and data collection continues.
12796	</li>
12797	</ul>
12798
12799	For an example of usage refer to the following files in VirtualBox SDK:
12800	<ul>
12801	<li>
12802	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
12803	</li>
12804	<li>
12805	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
12806	</li>
12807	</ul>
12808	</desc>
12809
12810	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
12811	<desc>
12812	Array of unique names of metrics.
12813
12814	This array represents all metrics supported by the performance
12815	collector. Individual objects do not necessarily support all of them.
12816	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
12817	list of supported metrics for a particular object.
12818	</desc>
12819	</attribute>
12820
12821	<method name="getMetrics">
12822	<desc>
12823	Returns parameters of specified metrics for a set of objects.
12824	<note>
12825	@c Null metrics array means all metrics. @c Null object array means
12826	all existing objects.
12827	</note>
12828	</desc>
12829	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12830	<desc>
12831	Metric name filter. Currently, only a comma-separated list of metrics
12832	is supported.
12833	</desc>
12834	</param>
12835	<param name="objects" type="$unknown" dir="in" safearray="yes">
12836	<desc>
12837	Set of objects to return metric parameters for.
12838	</desc>
12839	</param>
12840	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
12841	<desc>
12842	Array of returned metric parameters.
12843	</desc>
12844	</param>
12845	</method>
12846
12847	<method name="setupMetrics">
12848	<desc>
12849	Sets parameters of specified base metrics for a set of objects. Returns
12850	an array of <link to="IPerformanceMetric" /> describing the metrics have
12851	been affected.
12852	<note>
12853	@c Null or empty metric name array means all metrics. @c Null or empty
12854	object array means all existing objects. If metric name array contains
12855	a single element and object array contains many, the single metric
12856	name array element is applied to each object array element to form
12857	metric/object pairs.
12858	</note>
12859	</desc>
12860	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12861	<desc>
12862	Metric name filter. Comma-separated list of metrics with wildcard
12863	support.
12864	</desc>
12865	</param>
12866	<param name="objects" type="$unknown" dir="in" safearray="yes">
12867	<desc>
12868	Set of objects to setup metric parameters for.
12869	</desc>
12870	</param>
12871	<param name="period" type="unsigned long" dir="in">
12872	<desc>
12873	Time interval in seconds between two consecutive samples of performance
12874	data.
12875	</desc>
12876	</param>
12877	<param name="count" type="unsigned long" dir="in">
12878	<desc>
12879	Number of samples to retain in performance data history. Older samples
12880	get discarded.
12881	</desc>
12882	</param>
12883	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12884	<desc>
12885	Array of metrics that have been modified by the call to this method.
12886	</desc>
12887	</param>
12888	</method>
12889
12890	<method name="enableMetrics">
12891	<desc>
12892	Turns on collecting specified base metrics. Returns an array of
12893	<link to="IPerformanceMetric" /> describing the metrics have been
12894	affected.
12895	<note>
12896	@c Null or empty metric name array means all metrics. @c Null or empty
12897	object array means all existing objects. If metric name array contains
12898	a single element and object array contains many, the single metric
12899	name array element is applied to each object array element to form
12900	metric/object pairs.
12901	</note>
12902	</desc>
12903	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12904	<desc>
12905	Metric name filter. Comma-separated list of metrics with wildcard
12906	support.
12907	</desc>
12908	</param>
12909	<param name="objects" type="$unknown" dir="in" safearray="yes">
12910	<desc>
12911	Set of objects to enable metrics for.
12912	</desc>
12913	</param>
12914	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12915	<desc>
12916	Array of metrics that have been modified by the call to this method.
12917	</desc>
12918	</param>
12919	</method>
12920
12921	<method name="disableMetrics">
12922	<desc>
12923	Turns off collecting specified base metrics. Returns an array of
12924	<link to="IPerformanceMetric" /> describing the metrics have been
12925	affected.
12926	<note>
12927	@c Null or empty metric name array means all metrics. @c Null or empty
12928	object array means all existing objects. If metric name array contains
12929	a single element and object array contains many, the single metric
12930	name array element is applied to each object array element to form
12931	metric/object pairs.
12932	</note>
12933	</desc>
12934	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12935	<desc>
12936	Metric name filter. Comma-separated list of metrics with wildcard
12937	support.
12938	</desc>
12939	</param>
12940	<param name="objects" type="$unknown" dir="in" safearray="yes">
12941	<desc>
12942	Set of objects to disable metrics for.
12943	</desc>
12944	</param>
12945	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
12946	<desc>
12947	Array of metrics that have been modified by the call to this method.
12948	</desc>
12949	</param>
12950	</method>
12951
12952	<method name="queryMetricsData">
12953	<desc>
12954	Queries collected metrics data for a set of objects.
12955
12956	The data itself and related metric information are returned in seven
12957	parallel and one flattened array of arrays. Elements of
12958	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
12959	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
12960	the same index describe one set of values corresponding to a single
12961	metric.
12962
12963	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
12964	start and length of a sub-array is indicated by
12965	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
12966	value for metric <tt>metricNames[i]</tt> is at
12967	<tt>returnData[returnIndices[i]]</tt>.
12968
12969	<note>
12970	@c Null or empty metric name array means all metrics. @c Null or empty
12971	object array means all existing objects. If metric name array contains
12972	a single element and object array contains many, the single metric
12973	name array element is applied to each object array element to form
12974	metric/object pairs.
12975	</note>
12976	<note>
12977	Data collection continues behind the scenes after call to
12978	@c queryMetricsData. The return data can be seen as the snapshot of
12979	the current state at the time of @c queryMetricsData call. The
12980	internally kept metric values are not cleared by the call. This makes
12981	possible querying different subsets of metrics or aggregates with
12982	subsequent calls. If periodic querying is needed it is highly
12983	suggested to query the values with @c interval*count period to avoid
12984	confusion. This way a completely new set of data values will be
12985	provided by each query.
12986	</note>
12987	</desc>
12988	<param name="metricNames" type="wstring" dir="in" safearray="yes">
12989	<desc>
12990	Metric name filter. Comma-separated list of metrics with wildcard
12991	support.
12992	</desc>
12993	</param>
12994	<param name="objects" type="$unknown" dir="in" safearray="yes">
12995	<desc>
12996	Set of objects to query metrics for.
12997	</desc>
12998	</param>
12999	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13000	<desc>
13001	Names of metrics returned in @c returnData.
13002	</desc>
13003	</param>
13004	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13005	<desc>
13006	Objects associated with metrics returned in @c returnData.
13007	</desc>
13008	</param>
13009	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13010	<desc>
13011	Units of measurement for each returned metric.
13012	</desc>
13013	</param>
13014	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13015	<desc>
13016	Divisor that should be applied to return values in order to get
13017	floating point values. For example:
13018	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13019	will retrieve the floating point value of i-th sample of the first
13020	metric.
13021	</desc>
13022	</param>
13023	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13024	<desc>
13025	Sequence numbers of the first elements of value sequences of particular metrics
13026	returned in @c returnData. For aggregate metrics it is the sequence number of
13027	the sample the aggregate started calculation from.
13028	</desc>
13029	</param>
13030	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13031	<desc>
13032	Indices of the first elements of value sequences of particular metrics
13033	returned in @c returnData.
13034	</desc>
13035	</param>
13036	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13037	<desc>
13038	Lengths of value sequences of particular metrics.
13039	</desc>
13040	</param>
13041	<param name="returnData" type="long" dir="return" safearray="yes">
13042	<desc>
13043	Flattened array of all metric data containing sequences of values for
13044	each metric.
13045	</desc>
13046	</param>
13047	</method>
13048
13049	</interface>
13050
13051	<module name="VBoxSVC" context="LocalServer">
13052	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
13053	namespace="virtualbox.org">
13054	<interface name="IVirtualBox" default="yes"/>
13055	</class>
13056	</module>
13057
13058	<module name="VBoxC" context="InprocServer" threadingModel="Free">
13059	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
13060	namespace="virtualbox.org">
13061	<interface name="ISession" default="yes"/>
13062	</class>
13063	<class name="CallbackWrapper" uuid="49EE8561-5563-4715-B18C-A4B1A490DAFE"
13064	namespace="virtualbox.org">
13065	<interface name="ILocalOwner" default="yes"/>
13066	<interface name="IVirtualBoxCallback"/>
13067	<interface name="IConsoleCallback"/>
13068	</class>
13069	</module>
13070
13071	</library>
13072
13073	</idl>
13074
13075	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format