VirtualBox.xidl@ 43994

Last change on this file since 43994 was 43908, checked in by vboxsync, 12 years ago
Main/Metrics: VM network rate metrics (#6345)
Property svn:eol-style set to `native`
File size: 724.0 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109
110	The naming of methods and attributes is very clearly defined: they all start
111	with a lowercase letter (except if they start with an acronym), and are using
112	CamelCase style otherwise. This naming only applies to the IDL description,
113	and is modified by the various language bindings (some convert the first
114	character to upper case, some not). See the SDK reference for more details
115	about how to call a method or attribute from a specific programming language.
116	</desc>
117
118	<if target="midl">
119	<cpp line="enum {"/>
120	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
121	<cpp line=" kTypeLibraryMinorVersion = 0"/>
122	<cpp line="};"/>
123	</if>
124
125	<if target="xpidl">
126	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127	<cpp>
128	/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134
135
136	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
137	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
138	NS_IMPL_THREADSAFE_ADDREF(_class) \
139	NS_IMPL_THREADSAFE_RELEASE(_class) \
140	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
141	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
142	#endif
143
144	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
145	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
146	NS_IMPL_THREADSAFE_ADDREF(_class) \
147	NS_IMPL_THREADSAFE_RELEASE(_class) \
148	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
149	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
150	#endif
151
152	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
153	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
154	NS_IMPL_THREADSAFE_ADDREF(_class) \
155	NS_IMPL_THREADSAFE_RELEASE(_class) \
156	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
157	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
158	#endif
159
160	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
161	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
162	NS_IMPL_THREADSAFE_ADDREF(_class) \
163	NS_IMPL_THREADSAFE_RELEASE(_class) \
164	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
165	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
166	#endif
167
168	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
169	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
170	NS_INTERFACE_MAP_BEGIN(_class) \
171	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
172	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
173	NS_IMPL_QUERY_CLASSINFO(_class) \
174	NS_INTERFACE_MAP_END
175	#endif
176
177	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
178	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
179	_i2, _ic2) \
180	NS_INTERFACE_MAP_BEGIN(_class) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
183	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
184	NS_IMPL_QUERY_CLASSINFO(_class) \
185	NS_INTERFACE_MAP_END
186	#endif
187
188	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
189	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
190	_i2, _ic2, _i3, _ic3) \
191	NS_INTERFACE_MAP_BEGIN(_class) \
192	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
193	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
194	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
195	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
196	NS_IMPL_QUERY_CLASSINFO(_class) \
197	NS_INTERFACE_MAP_END
198	#endif
199
200	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
201	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
202	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
203
204	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
205	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
206	NS_IMPL_THREADSAFE_ADDREF(_class) \
207	NS_IMPL_THREADSAFE_RELEASE(_class) \
208	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
209	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
210	#endif
211
212	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
213	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
214	_i2, _ic2) \
215	NS_IMPL_THREADSAFE_ADDREF(_class) \
216	NS_IMPL_THREADSAFE_RELEASE(_class) \
217	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
218	_i2, _ic2) \
219	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
220	#endif
221
222	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
223	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
224	_i2, _ic2, _i3, _ic3) \
225	NS_IMPL_THREADSAFE_ADDREF(_class) \
226	NS_IMPL_THREADSAFE_RELEASE(_class) \
227	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
228	_i2, _ic2, _i3, _ic3) \
229	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
230	#endif
231
232	</cpp>
233	</if>
234
235	<library
236	name="VirtualBox"
237	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
238	version="1.3"
239	desc="VirtualBox Type Library"
240	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
241	supportsErrorInfo="yes"
242	>
243
244
245	<!--
246	// COM result codes for VirtualBox
247	/////////////////////////////////////////////////////////////////////////
248	-->
249
250	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
251	<desc>
252	This section describes all VirtualBox-specific COM result codes that may
253	be returned by methods of VirtualBox COM interfaces in addition to
254	standard COM result codes.
255
256	Note that along with the result code, every VirtualBox method returns
257	extended error information through the IVirtualBoxErrorInfo interface on
258	failure. This interface is a preferred way to present the error to the end
259	user because it contains a human readable description of the error. Raw
260	result codes, both standard and described in this section, are intended to
261	be used by programs to analyze the reason of a failure and select an
262	appropriate course of action without involving the end user (for example,
263	retry the operation later or make a different call).
264
265	The standard COM result codes that may originate from our methods include:
266
267	<table>
268	<tr><td>E_INVALIDARG</td>
269	<td>
270	Returned when the value of the method's argument is not within the range
271	of valid values. This should not be confused with situations when the
272	value is within the range but simply doesn't suit the current object
273	state and there is a possibility that it will be accepted later (in such
274	cases VirtualBox-specific codes are returned, for example,
275	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
276	</td>
277	</tr>
278	<tr><td>E_POINTER</td>
279	<td>
280	Returned if a memory pointer for the output argument is invalid (for
281	example, @c null). When pointers representing input arguments (such
282	as strings) are invalid, E_INVALIDARG is returned.
283	</td>
284	</tr>
285	<tr><td>E_ACCESSDENIED</td>
286	<td>
287	Returned when the called object is not ready. Since the lifetime of a
288	public COM object cannot be fully controlled by the implementation,
289	VirtualBox maintains the readiness state for all objects it creates and
290	returns this code in response to any method call on the object that was
291	deactivated by VirtualBox and is not functioning any more.
292	</td>
293	</tr>
294	<tr><td>E_OUTOFMEMORY</td>
295	<td>
296	Returned when a memory allocation operation fails.
297	</td>
298	</tr>
299	</table>
300	</desc>
301	</descGroup>
302
303	<!--
304	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
305	everything in <result>/<desc> after (and including) the first dot, so express
306	the matter of the error code in the first sentence and keep it short.
307	-->
308
309	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
310	<desc>
311	Object corresponding to the supplied arguments does not exist.
312	</desc>
313	</result>
314
315	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
316	<desc>
317	Current virtual machine state prevents the operation.
318	</desc>
319	</result>
320
321	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
322	<desc>
323	Virtual machine error occurred attempting the operation.
324	</desc>
325	</result>
326
327	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
328	<desc>
329	File not accessible or erroneous file contents.
330	</desc>
331	</result>
332
333	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
334	<desc>
335	Runtime subsystem error.
336	</desc>
337	</result>
338
339	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
340	<desc>
341	Pluggable Device Manager error.
342	</desc>
343	</result>
344
345	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
346	<desc>
347	Current object state prohibits operation.
348	</desc>
349	</result>
350
351	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
352	<desc>
353	Host operating system related error.
354	</desc>
355	</result>
356
357	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
358	<desc>
359	Requested operation is not supported.
360	</desc>
361	</result>
362
363	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
364	<desc>
365	Invalid XML found.
366	</desc>
367	</result>
368
369	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
370	<desc>
371	Current session state prohibits operation.
372	</desc>
373	</result>
374
375	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
376	<desc>
377	Object being in use prohibits operation.
378	</desc>
379	</result>
380
381	<!--
382	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
383	everything in <result>/<desc> after (and including) the first dot, so express
384	the matter of the error code in the first sentence and keep it short.
385	-->
386
387	<descGroup/>
388
389	<!--
390	// all common enums
391	/////////////////////////////////////////////////////////////////////////
392	-->
393
394	<enum
395	name="SettingsVersion"
396	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
397	>
398	<desc>
399	Settings version of VirtualBox settings files. This is written to
400	the "version" attribute of the root "VirtualBox" element in the settings
401	file XML and indicates which VirtualBox version wrote the file.
402	</desc>
403
404	<const name="Null" value="0">
405	<desc>Null value, indicates invalid version.</desc>
406	</const>
407	<const name="v1_0" value="1">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_1" value="2">
411	<desc>Legacy settings version, not currently supported.</desc>
412	</const>
413	<const name="v1_2" value="3">
414	<desc>Legacy settings version, not currently supported.</desc>
415	</const>
416	<const name="v1_3pre" value="4">
417	<desc>Legacy settings version, not currently supported.</desc>
418	</const>
419	<const name="v1_3" value="5">
420	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
421	<!--
422	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
423	-->
424	</const>
425	<const name="v1_4" value="6">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
429	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
430	-->
431	</const>
432	<const name="v1_5" value="7">
433	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
434	<!--
435	2008-09-04: 2.0.0 released
436	2008-11-20: settings version 1.5 introduced
437	2008-12-17: 2.1.0 released
438	Machine changes:
439	guest OS identifiers changed;
440	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
441	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
442	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
443	-->
444	</const>
445	<const name="v1_6" value="8">
446	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
447	<!--
448	2008-12-17: 2.1.0 released
449	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
450	2009-04-08: 2.2.0 released
451	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
452	-->
453	</const>
454	<const name="v1_7" value="9">
455	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
456	<!--
457	2008-12-17: 2.1.0 released
458	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
459	2009-04-08: 2.2.0 released
460	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
461	Machine changes: HardDiskAttachments is now StorageControllers (done)
462	-->
463	</const>
464	<const name="v1_8" value="10">
465	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
466	<!--
467	Machine additions: Display/@accelerate2DVideo (done)
468	-->
469	</const>
470	<const name="v1_9" value="11">
471	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
472	<!--
473	The big storage controller / DVD / Floppy rework (done)
474	-->
475	</const>
476	<const name="v1_10" value="12">
477	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
478	<!--
479	Machine changes: RTC localOrUTC (done)
480	CPU hot-plug support
481	-->
482	</const>
483	<const name="v1_11" value="13">
484	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
485	<!--
486	Machine changes: HD Audio controller, per-machine disk registries,
487	/@format attribute for DVD and floppy images.
488	-->
489	</const>
490	<const name="v1_12" value="14">
491	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
492	<!--
493	Machine changes: raw PCI device attachment;
494	NetworkAdapter changes: bandwidth group.
495	-->
496	</const>
497	<const name="v1_13" value="15">
498	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
499	<!--
500	Machine changes: tracing config, groups, autostart;
501	NetworkAdapter changes: unit for bandwidth group limits.
502	-->
503	</const>
504
505	<const name="Future" value="99999">
506	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
507	</const>
508	</enum>
509
510	<enum
511	name="AccessMode"
512	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
513	>
514	<desc>
515	Access mode for opening files.
516	</desc>
517
518	<const name="ReadOnly" value="1"/>
519	<const name="ReadWrite" value="2"/>
520	</enum>
521
522	<enum
523	name="MachineState"
524	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
525	>
526	<desc>
527	Virtual machine execution state.
528
529	This enumeration represents possible values of the <link
530	to="IMachine::state"/> attribute.
531
532	Below is the basic virtual machine state diagram. It shows how the state
533	changes during virtual machine execution. The text in square braces shows
534	a method of the IConsole interface that performs the given state
535	transition.
536
537	<pre>
538	+---------[powerDown()] <- Stuck <--[failure]-+
539	V \|
540	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
541	\| \| \| \| V \|
542	\| Aborted -----+ +--> Running --[pause()]--> Paused
543	\| \| ^ \| ^ \|
544	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
545	\| ^ \| \| \| \|
546	\| \| +-----------------------------------------+-\|-------------------+ +
547	\| \| \| \| \|
548	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
549	\| \| \| \|
550	\| +-------- Saving <--------[saveState()]<----------+---------------------+
551	\| \| \|
552	+-------------- Stopping -------[powerDown()]<----------+---------------------+
553	</pre>
554
555	Note that states to the right from PoweredOff, Aborted and Saved in the
556	above diagram are called <i>online VM states</i>. These states
557	represent the virtual machine which is being executed in a dedicated
558	process (usually with a GUI window attached to it where you can see the
559	activity of the virtual machine and interact with it). There are two
560	special pseudo-states, FirstOnline and LastOnline, that can be used in
561	relational expressions to detect if the given machine state is online or
562	not:
563
564	<pre>
565	if (machine.GetState() >= MachineState_FirstOnline &&
566	machine.GetState() <= MachineState_LastOnline)
567	{
568	...the machine is being executed...
569	}
570	</pre>
571
572	When the virtual machine is in one of the online VM states (that is, being
573	executed), only a few machine settings can be modified. Methods working
574	with such settings contain an explicit note about that. An attempt to
575	change any other setting or perform a modifying operation during this time
576	will result in the @c VBOX_E_INVALID_VM_STATE error.
577
578	All online states except Running, Paused and Stuck are transitional: they
579	represent temporary conditions of the virtual machine that will last as
580	long as the operation that initiated such a condition.
581
582	The Stuck state is a special case. It means that execution of the machine
583	has reached the "Guru Meditation" condition. This condition indicates an
584	internal VMM (virtual machine manager) failure which may happen as a
585	result of either an unhandled low-level virtual hardware exception or one
586	of the recompiler exceptions (such as the <i>too-many-traps</i>
587	condition).
588
589	Note also that any online VM state may transit to the Aborted state. This
590	happens if the process that is executing the virtual machine terminates
591	unexpectedly (for example, crashes). Other than that, the Aborted state is
592	equivalent to PoweredOff.
593
594	There are also a few additional state diagrams that do not deal with
595	virtual machine execution and therefore are shown separately. The states
596	shown on these diagrams are called <i>offline VM states</i> (this includes
597	PoweredOff, Aborted and Saved too).
598
599	The first diagram shows what happens when a lengthy setup operation is
600	being executed (such as <link to="IMachine::attachDevice"/>).
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| \| \|
607	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
608	\| \|
609	+-> Saved -------+
610	</pre>
611
612	The next two diagrams demonstrate the process of taking a snapshot of a
613	powered off virtual machine, restoring the state to that as of a snapshot
614	or deleting a snapshot, respectively.
615
616	<pre>
617	+----------------------------------(same state as before the call)------+
618	\| \|
619	+-> PoweredOff --+ \|
620	\| +-->[takeSnapshot()] -------------------> Saving ------+
621	+-> Aborted -----+
622
623	+-> PoweredOff --+
624	\| \|
625	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
626	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
627	+-> Saved -------+ \|
628	\| \|
629	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
630	</pre>
631
632	Note that the Saving state is present in both the offline state group and
633	online state group. Currently, the only way to determine what group is
634	assumed in a particular case is to remember the previous machine state: if
635	it was Running or Paused, then Saving is an online state, otherwise it is
636	an offline state. This inconsistency may be removed in one of the future
637	versions of VirtualBox by adding a new state.
638
639	<note internal="yes">
640	For whoever decides to touch this enum: In order to keep the
641	comparisons involving FirstOnline and LastOnline pseudo-states valid,
642	the numeric values of these states must be correspondingly updated if
643	needed: for any online VM state, the condition
644	<tt>FirstOnline <= state <= LastOnline</tt> must be
645	@c true. The same relates to transient states for which
646	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
647	@c true.
648	</note>
649	</desc>
650
651	<const name="Null" value="0">
652	<desc>Null value (never used by the API).</desc>
653	</const>
654	<const name="PoweredOff" value="1">
655	<desc>
656	The machine is not running and has no saved execution state; it has
657	either never been started or been shut down successfully.
658	</desc>
659	</const>
660	<const name="Saved" value="2">
661	<desc>
662	The machine is not currently running, but the execution state of the machine
663	has been saved to an external file when it was running, from where
664	it can be resumed.
665	</desc>
666	</const>
667	<const name="Teleported" value="3">
668	<desc>
669	The machine was teleported to a different host (or process) and then
670	powered off. Take care when powering it on again may corrupt resources
671	it shares with the teleportation target (e.g. disk and network).
672	</desc>
673	</const>
674	<const name="Aborted" value="4">
675	<desc>
676	The process running the machine has terminated abnormally. This may
677	indicate a crash of the VM process in host execution context, or
678	the VM process has been terminated externally.
679	</desc>
680	</const>
681	<const name="Running" value="5">
682	<desc>
683	The machine is currently being executed.
684	<note internal="yes">
685	For whoever decides to touch this enum: In order to keep the
686	comparisons in the old source code valid, this state must immediately
687	precede the Paused state.
688	TODO: Lift this spectacularly wonderful restriction.
689	</note>
690	</desc>
691	</const>
692	<const name="Paused" value="6">
693	<desc>
694	Execution of the machine has been paused.
695	<note internal="yes">
696	For whoever decides to touch this enum: In order to keep the
697	comparisons in the old source code valid, this state must immediately
698	follow the Running state.
699	TODO: Lift this spectacularly wonderful restriction.
700	</note>
701	</desc>
702	</const>
703	<const name="Stuck" value="7">
704	<desc>
705	Execution of the machine has reached the "Guru Meditation"
706	condition. This indicates a severe error in the hypervisor itself.
707	<note internal="yes">
708	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
709	"Guru", perhaps? Or are there some other VMM states that are
710	intended to be lumped in here as well?
711	</note>
712	</desc>
713	</const>
714	<const name="Teleporting" value="8">
715	<desc>
716	The machine is about to be teleported to a different host or process.
717	It is possible to pause a machine in this state, but it will go to the
718	@c TeleportingPausedVM state and it will not be
719	possible to resume it again unless the teleportation fails.
720	</desc>
721	</const>
722	<const name="LiveSnapshotting" value="9">
723	<desc>
724	A live snapshot is being taken. The machine is running normally, but
725	some of the runtime configuration options are inaccessible. Also, if
726	paused while in this state it will transition to
727	@c Saving and it will not be resume the
728	execution until the snapshot operation has completed.
729	</desc>
730	</const>
731	<const name="Starting" value="10">
732	<desc>
733	Machine is being started after powering it on from a
734	zero execution state.
735	</desc>
736	</const>
737	<const name="Stopping" value="11">
738	<desc>
739	Machine is being normally stopped powering it off, or after the guest OS
740	has initiated a shutdown sequence.
741	</desc>
742	</const>
743	<const name="Saving" value="12">
744	<desc>
745	Machine is saving its execution state to a file, or an online
746	snapshot of the machine is being taken.
747	</desc>
748	</const>
749	<const name="Restoring" value="13">
750	<desc>
751	Execution state of the machine is being restored from a file
752	after powering it on from the saved execution state.
753	</desc>
754	</const>
755	<const name="TeleportingPausedVM" value="14">
756	<desc>
757	The machine is being teleported to another host or process, but it is
758	not running. This is the paused variant of the
759	@c state.
760	</desc>
761	</const>
762	<const name="TeleportingIn" value="15">
763	<desc>
764	Teleporting the machine state in from another host or process.
765	</desc>
766	</const>
767	<const name="FaultTolerantSyncing" value="16">
768	<desc>
769	The machine is being synced with a fault tolerant VM running elsewhere.
770	</desc>
771	</const>
772	<const name="DeletingSnapshotOnline" value="17">
773	<desc>
774	Like @c DeletingSnapshot, but the merging of media is ongoing in
775	the background while the machine is running.
776	</desc>
777	</const>
778	<const name="DeletingSnapshotPaused" value="18">
779	<desc>
780	Like @c DeletingSnapshotOnline, but the machine was paused when the
781	merging of differencing media was started.
782	</desc>
783	</const>
784	<const name="RestoringSnapshot" value="19">
785	<desc>
786	A machine snapshot is being restored; this typically does not take long.
787	</desc>
788	</const>
789	<const name="DeletingSnapshot" value="20">
790	<desc>
791	A machine snapshot is being deleted; this can take a long time since this
792	may require merging differencing media. This value indicates that the
793	machine is not running while the snapshot is being deleted.
794	</desc>
795	</const>
796	<const name="SettingUp" value="21">
797	<desc>
798	Lengthy setup operation is in progress.
799	</desc>
800	</const>
801
802	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
803	<desc>
804	Pseudo-state: first online state (for use in relational expressions).
805	</desc>
806	</const>
807	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
808	<desc>
809	Pseudo-state: last online state (for use in relational expressions).
810	</desc>
811	</const>
812
813	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
814	<desc>
815	Pseudo-state: first transient state (for use in relational expressions).
816	</desc>
817	</const>
818	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
819	<desc>
820	Pseudo-state: last transient state (for use in relational expressions).
821	</desc>
822	</const>
823
824	</enum>
825
826	<enum
827	name="SessionState"
828	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
829	>
830	<desc>
831	Session state. This enumeration represents possible values of
832	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
833	attributes.
834	</desc>
835
836	<const name="Null" value="0">
837	<desc>Null value (never used by the API).</desc>
838	</const>
839	<const name="Unlocked" value="1">
840	<desc>
841	In <link to="IMachine::sessionState"/>, this means that the machine
842	is not locked for any sessions.
843
844	In <link to="ISession::state"/>, this means that no machine is
845	currently locked for this session.
846	</desc>
847	</const>
848	<const name="Locked" value="2">
849	<desc>
850	In <link to="IMachine::sessionState"/>, this means that the machine
851	is currently locked for a session, whose process identifier can
852	then be found in the <link to="IMachine::sessionPID" /> attribute.
853
854	In <link to="ISession::state"/>, this means that a machine is
855	currently locked for this session, and the mutable machine object
856	can be found in the <link to="ISession::machine"/> attribute
857	(see <link to="IMachine::lockMachine" /> for details).
858	</desc>
859	</const>
860	<const name="Spawning" value="3">
861	<desc>
862	A new process is being spawned for the machine as a result of
863	<link to="IMachine::launchVMProcess"/> call. This state also occurs
864	as a short transient state during an <link to="IMachine::lockMachine"/>
865	call.
866	</desc>
867	</const>
868	<const name="Unlocking" value="4">
869	<desc>
870	The session is being unlocked.
871	</desc>
872	</const>
873	</enum>
874
875	<enum
876	name="CPUPropertyType"
877	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
878	>
879	<desc>
880	Virtual CPU property type. This enumeration represents possible values of the
881	IMachine get- and setCPUProperty methods.
882	</desc>
883	<const name="Null" value="0">
884	<desc>Null value (never used by the API).</desc>
885	</const>
886	<const name="PAE" value="1">
887	<desc>
888	This setting determines whether VirtualBox will expose the Physical Address
889	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
890	is not available, it will not be reported.
891	</desc>
892	</const>
893	<const name="Synthetic" value="2">
894	<desc>
895	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
896	teleporting between host systems that differ significantly.
897	</desc>
898	</const>
899	</enum>
900
901
902	<enum
903	name="HWVirtExPropertyType"
904	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
905	>
906	<desc>
907	Hardware virtualization property type. This enumeration represents possible values
908	for the <link to="IMachine::getHWVirtExProperty"/> and
909	<link to="IMachine::setHWVirtExProperty"/> methods.
910	</desc>
911	<const name="Null" value="0">
912	<desc>Null value (never used by the API).</desc>
913	</const>
914	<const name="Enabled" value="1">
915	<desc>
916	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
917	such extensions are not available, they will not be used.
918	</desc>
919	</const>
920	<const name="Exclusive" value="2">
921	<desc>
922	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
923	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
924	feature of the host. To share these with other hypervisors, you must disable this property.
925	</desc>
926	</const>
927	<const name="VPID" value="3">
928	<desc>
929	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
930	</desc>
931	</const>
932	<const name="NestedPaging" value="4">
933	<desc>
934	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
935	</desc>
936	</const>
937	<const name="LargePages" value="5">
938	<desc>
939	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
940	</desc>
941	</const>
942	<const name="Force" value="6">
943	<desc>
944	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
945	not set, there will be an automatic fallback to software virtualization.
946	</desc>
947	</const>
948	</enum>
949
950	<enum
951	name="FaultToleranceState"
952	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
953	>
954	<desc>
955	Used with <link to="IMachine::faultToleranceState" />.
956	</desc>
957	<const name="Inactive" value="1">
958	<desc>No fault tolerance enabled.</desc>
959	</const>
960	<const name="Master" value="2">
961	<desc>Fault tolerant master VM.</desc>
962	</const>
963	<const name="Standby" value="3">
964	<desc>Fault tolerant standby VM.</desc>
965	</const>
966	</enum>
967
968	<enum
969	name="LockType"
970	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
971	>
972	<desc>
973	Used with <link to="IMachine::lockMachine" />.
974	</desc>
975	<const name="Write" value="2">
976	<desc>Lock the machine for writing.</desc>
977	</const>
978	<const name="Shared" value="1">
979	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
980	</const>
981	<const name="VM" value="3">
982	<desc>Lock the machine for writing, and create objects necessary for
983	running a VM in this process.</desc>
984	</const>
985	</enum>
986
987	<enum
988	name="SessionType"
989	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
990	>
991	<desc>
992	Session type. This enumeration represents possible values of the
993	<link to="ISession::type"/> attribute.
994	</desc>
995
996	<const name="Null" value="0">
997	<desc>Null value (never used by the API).</desc>
998	</const>
999	<const name="WriteLock" value="1">
1000	<desc>
1001	Session has acquired an exclusive write lock on a machine
1002	using <link to="IMachine::lockMachine"/>.
1003	</desc>
1004	</const>
1005	<const name="Remote" value="2">
1006	<desc>
1007	Session has launched a VM process using
1008	<link to="IMachine::launchVMProcess"/>
1009	</desc>
1010	</const>
1011	<const name="Shared" value="3">
1012	<desc>
1013	Session has obtained a link to another session using
1014	<link to="IMachine::lockMachine"/>
1015	</desc>
1016	</const>
1017	</enum>
1018
1019	<enum
1020	name="DeviceType"
1021	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1022	>
1023	<desc>
1024	Device type.
1025	</desc>
1026	<const name="Null" value="0">
1027	<desc>
1028	Null value, may also mean "no device" (not allowed for
1029	<link to="IConsole::getDeviceActivity"/>).
1030	</desc>
1031	</const>
1032	<const name="Floppy" value="1">
1033	<desc>Floppy device.</desc>
1034	</const>
1035	<const name="DVD" value="2">
1036	<desc>CD/DVD-ROM device.</desc>
1037	</const>
1038	<const name="HardDisk" value="3">
1039	<desc>Hard disk device.</desc>
1040	</const>
1041	<const name="Network" value="4">
1042	<desc>Network device.</desc>
1043	</const>
1044	<const name="USB" value="5">
1045	<desc>USB device.</desc>
1046	</const>
1047	<const name="SharedFolder" value="6">
1048	<desc>Shared folder device.</desc>
1049	</const>
1050	</enum>
1051
1052	<enum
1053	name="DeviceActivity"
1054	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1055	>
1056	<desc>
1057	Device activity for <link to="IConsole::getDeviceActivity"/>.
1058	</desc>
1059
1060	<const name="Null" value="0"/>
1061	<const name="Idle" value="1"/>
1062	<const name="Reading" value="2"/>
1063	<const name="Writing" value="3"/>
1064	</enum>
1065
1066	<enum
1067	name="ClipboardMode"
1068	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1069	>
1070	<desc>
1071	Host-Guest clipboard interchange mode.
1072	</desc>
1073
1074	<const name="Disabled" value="0"/>
1075	<const name="HostToGuest" value="1"/>
1076	<const name="GuestToHost" value="2"/>
1077	<const name="Bidirectional" value="3"/>
1078	</enum>
1079
1080	<enum
1081	name="DragAndDropMode"
1082	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1083	>
1084	<desc>
1085	Drag'n'Drop interchange mode.
1086	</desc>
1087
1088	<const name="Disabled" value="0"/>
1089	<const name="HostToGuest" value="1"/>
1090	<const name="GuestToHost" value="2"/>
1091	<const name="Bidirectional" value="3"/>
1092	</enum>
1093
1094	<enum
1095	name="Scope"
1096	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1097	>
1098	<desc>
1099	Scope of the operation.
1100
1101	A generic enumeration used in various methods to define the action or
1102	argument scope.
1103	</desc>
1104
1105	<const name="Global" value="0"/>
1106	<const name="Machine" value="1"/>
1107	<const name="Session" value="2"/>
1108	</enum>
1109
1110	<enum
1111	name="BIOSBootMenuMode"
1112	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1113	>
1114	<desc>
1115	BIOS boot menu mode.
1116	</desc>
1117
1118	<const name="Disabled" value="0"/>
1119	<const name="MenuOnly" value="1"/>
1120	<const name="MessageAndMenu" value="2"/>
1121	</enum>
1122
1123	<enum
1124	name="ProcessorFeature"
1125	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1126	>
1127	<desc>
1128	CPU features.
1129	</desc>
1130
1131	<const name="HWVirtEx" value="0"/>
1132	<const name="PAE" value="1"/>
1133	<const name="LongMode" value="2"/>
1134	<const name="NestedPaging" value="3"/>
1135	</enum>
1136
1137	<enum
1138	name="FirmwareType"
1139	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1140	>
1141	<desc>
1142	Firmware type.
1143	</desc>
1144	<const name="BIOS" value="1">
1145	<desc>BIOS Firmware.</desc>
1146	</const>
1147	<const name="EFI" value="2">
1148	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1149	</const>
1150	<const name="EFI32" value="3">
1151	<desc>Efi firmware, 32-bit.</desc>
1152	</const>
1153	<const name="EFI64" value="4">
1154	<desc>Efi firmware, 64-bit.</desc>
1155	</const>
1156	<const name="EFIDUAL" value="5">
1157	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1158	</const>
1159	</enum>
1160
1161	<enum
1162	name="PointingHIDType"
1163	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1164	>
1165	<desc>
1166	Type of pointing device used in a virtual machine.
1167	</desc>
1168	<const name="None" value="1">
1169	<desc>No mouse.</desc>
1170	</const>
1171	<const name="PS2Mouse" value="2">
1172	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1173	</const>
1174	<const name="USBMouse" value="3">
1175	<desc>USB mouse (relative pointer).</desc>
1176	</const>
1177	<const name="USBTablet" value="4">
1178	<desc>USB tablet (absolute pointer).</desc>
1179	</const>
1180	<const name="ComboMouse" value="5">
1181	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1182	Using of such device can have negative performance implications. </desc>
1183	</const>
1184	</enum>
1185
1186	<enum
1187	name="KeyboardHIDType"
1188	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1189	>
1190	<desc>
1191	Type of keyboard device used in a virtual machine.
1192	</desc>
1193	<const name="None" value="1">
1194	<desc>No keyboard.</desc>
1195	</const>
1196	<const name="PS2Keyboard" value="2">
1197	<desc>PS/2 keyboard.</desc>
1198	</const>
1199	<const name="USBKeyboard" value="3">
1200	<desc>USB keyboard.</desc>
1201	</const>
1202	<const name="ComboKeyboard" value="4">
1203	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1204	Using of such device can have negative performance implications. </desc>
1205	</const>
1206	</enum>
1207
1208	<!--
1209	// IVirtualBoxErrorInfo
1210	/////////////////////////////////////////////////////////////////////////
1211	-->
1212
1213	<interface
1214	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1215	uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1216	supportsErrorInfo="no"
1217	wsmap="managed"
1218	>
1219	<desc>
1220	The IVirtualBoxErrorInfo interface represents extended error information.
1221
1222	Extended error information can be set by VirtualBox components after
1223	unsuccessful or partially successful method invocation. This information
1224	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1225	and then shown to the client in addition to the plain 32-bit result code.
1226
1227	In MS COM, this interface extends the IErrorInfo interface,
1228	in XPCOM, it extends the nsIException interface. In both cases,
1229	it provides a set of common attributes to retrieve error
1230	information.
1231
1232	Sometimes invocation of some component's method may involve methods of
1233	other components that may also fail (independently of this method's
1234	failure), or a series of non-fatal errors may precede a fatal error that
1235	causes method failure. In cases like that, it may be desirable to preserve
1236	information about all errors happened during method invocation and deliver
1237	it to the caller. The <link to="#next"/> attribute is intended
1238	specifically for this purpose and allows to represent a chain of errors
1239	through a single IVirtualBoxErrorInfo object set after method invocation.
1240
1241	<note>errors are stored to a chain in the reverse order, i.e. the
1242	initial error object you query right after method invocation is the last
1243	error set by the callee, the object it points to in the @a next attribute
1244	is the previous error and so on, up to the first error (which is the last
1245	in the chain).</note>
1246	</desc>
1247
1248	<attribute name="resultCode" type="long" readonly="yes">
1249	<desc>
1250	Result code of the error.
1251	Usually, it will be the same as the result code returned
1252	by the method that provided this error information, but not
1253	always. For example, on Win32, CoCreateInstance() will most
1254	likely return E_NOINTERFACE upon unsuccessful component
1255	instantiation attempt, but not the value the component factory
1256	returned. Value is typed 'long', not 'result',
1257	to make interface usable from scripting languages.
1258	<note>
1259	In MS COM, there is no equivalent.
1260	In XPCOM, it is the same as nsIException::result.
1261	</note>
1262	</desc>
1263	</attribute>
1264
1265	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1266	<desc>
1267	UUID of the interface that defined the error.
1268	<note>
1269	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1270	data type.
1271	In XPCOM, there is no equivalent.
1272	</note>
1273	</desc>
1274	</attribute>
1275
1276	<attribute name="component" type="wstring" readonly="yes">
1277	<desc>
1278	Name of the component that generated the error.
1279	<note>
1280	In MS COM, it is the same as IErrorInfo::GetSource.
1281	In XPCOM, there is no equivalent.
1282	</note>
1283	</desc>
1284	</attribute>
1285
1286	<attribute name="text" type="wstring" readonly="yes">
1287	<desc>
1288	Text description of the error.
1289	<note>
1290	In MS COM, it is the same as IErrorInfo::GetDescription.
1291	In XPCOM, it is the same as nsIException::message.
1292	</note>
1293	</desc>
1294	</attribute>
1295
1296	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1297	<desc>
1298	Next error object if there is any, or @c null otherwise.
1299	<note>
1300	In MS COM, there is no equivalent.
1301	In XPCOM, it is the same as nsIException::inner.
1302	</note>
1303	</desc>
1304	</attribute>
1305
1306	</interface>
1307
1308	<!--
1309	// IVirtualBox
1310	/////////////////////////////////////////////////////////////////////////
1311	-->
1312
1313	<interface
1314	name="IDHCPServer" extends="$unknown"
1315	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1316	wsmap="managed"
1317	>
1318	<desc>
1319	The IDHCPServer interface represents the vbox DHCP server configuration.
1320
1321	To enumerate all the DHCP servers on the host, use the
1322	<link to="IVirtualBox::DHCPServers"/> attribute.
1323	</desc>
1324
1325	<attribute name="enabled" type="boolean">
1326	<desc>
1327	specifies if the DHCP server is enabled
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="IPAddress" type="wstring" readonly="yes">
1332	<desc>
1333	specifies server IP
1334	</desc>
1335	</attribute>
1336
1337	<attribute name="networkMask" type="wstring" readonly="yes">
1338	<desc>
1339	specifies server network mask
1340	</desc>
1341	</attribute>
1342
1343	<attribute name="networkName" type="wstring" readonly="yes">
1344	<desc>
1345	specifies internal network name the server is used for
1346	</desc>
1347	</attribute>
1348
1349	<attribute name="lowerIP" type="wstring" readonly="yes">
1350	<desc>
1351	specifies from IP address in server address range
1352	</desc>
1353	</attribute>
1354
1355	<attribute name="upperIP" type="wstring" readonly="yes">
1356	<desc>
1357	specifies to IP address in server address range
1358	</desc>
1359	</attribute>
1360
1361	<method name="setConfiguration">
1362	<desc>
1363	configures the server
1364	<result name="E_INVALIDARG">
1365	invalid configuration supplied
1366	</result>
1367	</desc>
1368	<param name="IPAddress" type="wstring" dir="in">
1369	<desc>
1370	server IP address
1371	</desc>
1372	</param>
1373	<param name="networkMask" type="wstring" dir="in">
1374	<desc>
1375	server network mask
1376	</desc>
1377	</param>
1378	<param name="FromIPAddress" type="wstring" dir="in">
1379	<desc>
1380	server From IP address for address range
1381	</desc>
1382	</param>
1383	<param name="ToIPAddress" type="wstring" dir="in">
1384	<desc>
1385	server To IP address for address range
1386	</desc>
1387	</param>
1388	</method>
1389
1390	<method name="start">
1391	<desc>
1392	Starts DHCP server process.
1393	<result name="E_FAIL">
1394	Failed to start the process.
1395	</result>
1396	</desc>
1397	<param name="networkName" type="wstring" dir="in">
1398	<desc>
1399	Name of internal network DHCP server should attach to.
1400	</desc>
1401	</param>
1402	<param name="trunkName" type="wstring" dir="in">
1403	<desc>
1404	Name of internal network trunk.
1405	</desc>
1406	</param>
1407	<param name="trunkType" type="wstring" dir="in">
1408	<desc>
1409	Type of internal network trunk.
1410	</desc>
1411	</param>
1412	</method>
1413
1414	<method name="stop">
1415	<desc>
1416	Stops DHCP server process.
1417	<result name="E_FAIL">
1418	Failed to stop the process.
1419	</result>
1420	</desc>
1421	</method>
1422	</interface>
1423
1424	<interface
1425	name="IVirtualBox" extends="$unknown"
1426	uuid="3b2f08eb-b810-4715-bee0-bb06b9880ad2"
1427	wsmap="managed"
1428	>
1429	<desc>
1430	The IVirtualBox interface represents the main interface exposed by the
1431	product that provides virtual machine management.
1432
1433	An instance of IVirtualBox is required for the product to do anything
1434	useful. Even though the interface does not expose this, internally,
1435	IVirtualBox is implemented as a singleton and actually lives in the
1436	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1437	IVirtualBox can track the state of all virtual machines on a particular
1438	host, regardless of which frontend started them.
1439
1440	To enumerate all the virtual machines on the host, use the
1441	<link to="IVirtualBox::machines"/> attribute.
1442	</desc>
1443
1444	<attribute name="version" type="wstring" readonly="yes">
1445	<desc>
1446	A string representing the version number of the product. The
1447	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1448	last number represents the build number and will frequently change.
1449
1450	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1451	in prerelease builds. Non-Oracle builds may (/shall) also have a
1452	publisher tag, at the end. The publisher tag starts with an underscore
1453	just like the prerelease build type tag.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="versionNormalized" type="wstring" readonly="yes">
1458	<desc>
1459	A string representing the version number of the product,
1460	without the publisher information (but still with other tags).
1461	See <link to="#version" />.
1462	</desc>
1463	</attribute>
1464
1465	<attribute name="revision" type="unsigned long" readonly="yes">
1466	<desc>
1467	The internal build revision number of the product.
1468	</desc>
1469	</attribute>
1470
1471	<attribute name="packageType" type="wstring" readonly="yes">
1472	<desc>
1473	A string representing the package type of this product. The
1474	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1475	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1476	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1477	this.
1478	</desc>
1479	</attribute>
1480
1481	<attribute name="APIVersion" type="wstring" readonly="yes">
1482	<desc>
1483	A string representing the VirtualBox API version number. The format is
1484	2 integer numbers divided by an underscore (e.g. 1_0). After the
1485	first public release of packages with a particular API version the
1486	API will not be changed in an incompatible way. Note that this
1487	guarantee does not apply to development builds, and also there is no
1488	guarantee that this version is identical to the first two integer
1489	numbers of the package version.
1490	</desc>
1491	</attribute>
1492
1493	<attribute name="homeFolder" type="wstring" readonly="yes">
1494	<desc>
1495	Full path to the directory where the global settings file,
1496	<tt>VirtualBox.xml</tt>, is stored.
1497
1498	In this version of VirtualBox, the value of this property is
1499	always <tt><user_dir>/.VirtualBox</tt> (where
1500	<tt><user_dir></tt> is the path to the user directory,
1501	as determined by the host OS), and cannot be changed.
1502
1503	This path is also used as the base to resolve relative paths in
1504	places where relative paths are allowed (unless otherwise
1505	expressly indicated).
1506	</desc>
1507	</attribute>
1508
1509	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1510	<desc>
1511	Full name of the global settings file.
1512	The value of this property corresponds to the value of
1513	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="host" type="IHost" readonly="yes">
1518	<desc>Associated host object.</desc>
1519	</attribute>
1520
1521	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1522	<desc>Associated system information object.</desc>
1523	</attribute>
1524
1525	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1526	<desc>
1527	Array of machine objects registered within this VirtualBox instance.
1528	</desc>
1529	</attribute>
1530
1531	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1532	<desc>
1533	Array of all machine group names which are used by the machines which
1534	are accessible. Each group is only listed once, however they are listed
1535	in no particular order and there is no guarantee that there are no gaps
1536	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1537	is a valid result).
1538	</desc>
1539	</attribute>
1540
1541	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1542	<desc>
1543	Array of medium objects known to this VirtualBox installation.
1544
1545	This array contains only base media. All differencing
1546	media of the given base medium can be enumerated using
1547	<link to="IMedium::children"/>.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1552	<desc>
1553	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1558	<desc>
1559	Array of floppy image objects currently in use by this VirtualBox instance.
1560	</desc>
1561	</attribute>
1562
1563	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1564
1565	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1566
1567	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1568	<desc>
1569	Collection of global shared folders. Global shared folders are
1570	available to all virtual machines.
1571
1572	New shared folders are added to the collection using
1573	<link to="#createSharedFolder"/>. Existing shared folders can be
1574	removed using <link to="#removeSharedFolder"/>.
1575
1576	<note>
1577	In the current version of the product, global shared folders are not
1578	implemented and therefore this collection is always empty.
1579	</note>
1580	</desc>
1581	</attribute>
1582
1583	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1584	<desc>
1585	Associated performance collector object.
1586	</desc>
1587	</attribute>
1588
1589	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1590	<desc>
1591	DHCP servers.
1592	</desc>
1593	</attribute>
1594
1595	<attribute name="eventSource" type="IEventSource" readonly="yes">
1596	<desc>
1597	Event source for VirtualBox events.
1598	</desc>
1599	</attribute>
1600
1601	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1602	<desc>
1603	The extension pack manager.
1604	</desc>
1605	</attribute>
1606
1607
1608	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1609	<desc>
1610	Names of all internal networks.
1611	</desc>
1612	</attribute>
1613
1614	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1615	<desc>
1616	Names of all generic network drivers.
1617	</desc>
1618	</attribute>
1619
1620	<method name="composeMachineFilename">
1621	<desc>
1622	Returns a recommended full path of the settings file name for a new virtual
1623	machine.
1624
1625	This API serves two purposes:
1626
1627	<ul>
1628	<li>It gets called by <link to="#createMachine" /> if @c null or
1629	empty string (which is recommended) is specified for the
1630	@a settingsFile argument there, which means that API should use
1631	a recommended default file name.</li>
1632
1633	<li>It can be called manually by a client software before creating a machine,
1634	e.g. if that client wants to pre-create the machine directory to create
1635	virtual hard disks in that directory together with the new machine
1636	settings file. In that case, the file name should be stripped from the
1637	full settings file path returned by this function to obtain the
1638	machine directory.</li>
1639	</ul>
1640
1641	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1642	details about the machine name.
1643
1644	@a groupName defines which additional subdirectory levels should be
1645	included. It must be either a valid group name or @c null or empty
1646	string which designates that the machine will not be related to a
1647	machine group.
1648
1649	If @a baseFolder is a @c null or empty string (which is recommended), the
1650	default machine settings folder
1651	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1652	a base folder for the created machine, resulting in a file name like
1653	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1654	will be used.
1655
1656	This method does not access the host disks. In particular, it does not check
1657	for whether a machine with this name already exists.
1658	</desc>
1659	<param name="name" type="wstring" dir="in">
1660	<desc>Suggested machine name.</desc>
1661	</param>
1662	<param name="group" type="wstring" dir="in">
1663	<desc>Machine group name for the new machine or machine group. It is
1664	used to determine the right subdirectory.</desc>
1665	</param>
1666	<param name="createFlags" type="wstring" dir="in">
1667	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1668	</param>
1669	<param name="baseFolder" type="wstring" dir="in">
1670	<desc>Base machine folder (optional).</desc>
1671	</param>
1672	<param name="file" type="wstring" dir="return">
1673	<desc>Fully qualified path where the machine would be created.</desc>
1674	</param>
1675	</method>
1676
1677	<method name="createMachine">
1678	<desc>
1679	Creates a new virtual machine by creating a machine settings file at
1680	the given location.
1681
1682	VirtualBox machine settings files use a custom XML dialect. Starting
1683	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1684	and machine files can be created at arbitrary locations.
1685
1686	However, it is recommended that machines are created in the default
1687	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1688	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1689	@c null or empty string (which is recommended) for the @a settingsFile
1690	argument, <link to="#composeMachineFilename" /> is called automatically
1691	to have such a recommended name composed based on the machine name
1692	given in the @a name argument and the primary group.
1693
1694	If the resulting settings file already exists, this method will fail,
1695	unless the forceOverwrite flag is set.
1696
1697	The new machine is created unregistered, with the initial configuration
1698	set according to the specified guest OS type. A typical sequence of
1699	actions to create a new virtual machine is as follows:
1700
1701	<ol>
1702	<li>
1703	Call this method to have a new machine created. The returned machine
1704	object will be "mutable" allowing to change any machine property.
1705	</li>
1706
1707	<li>
1708	Configure the machine using the appropriate attributes and methods.
1709	</li>
1710
1711	<li>
1712	Call <link to="IMachine::saveSettings" /> to write the settings
1713	to the machine's XML settings file. The configuration of the newly
1714	created machine will not be saved to disk until this method is
1715	called.
1716	</li>
1717
1718	<li>
1719	Call <link to="#registerMachine" /> to add the machine to the list
1720	of machines known to VirtualBox.
1721	</li>
1722	</ol>
1723
1724	The specified guest OS type identifier must match an ID of one of known
1725	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1726	array.
1727
1728	<note>
1729	There is no way to change the name of the settings file or
1730	subfolder of the created machine directly.
1731	</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	@a osTypeId is invalid.
1735	</result>
1736	<result name="VBOX_E_FILE_ERROR">
1737	Resulting settings file name is invalid or the settings file already
1738	exists or could not be created due to an I/O error.
1739	</result>
1740	<result name="E_INVALIDARG">
1741	@a name is empty or @c null.
1742	</result>
1743	</desc>
1744
1745	<param name="settingsFile" type="wstring" dir="in">
1746	<desc>Fully qualified path where the settings file should be created,
1747	empty string or @c null for a default folder and file based on the
1748	@a name argument and the primary group.
1749	(see <link to="#composeMachineFilename" />).</desc>
1750	</param>
1751	<param name="name" type="wstring" dir="in">
1752	<desc>Machine name.</desc>
1753	</param>
1754	<param name="groups" type="wstring" safearray="yes" dir="in">
1755	<desc>Array of group names. @c null or an empty array have the same
1756	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1757	create a machine without group association.</desc>
1758	</param>
1759	<param name="osTypeId" type="wstring" dir="in">
1760	<desc>Guest OS Type ID.</desc>
1761	</param>
1762	<param name="flags" type="wstring" dir="in">
1763	<desc>
1764	Additional property parameters, passed as a comma-separated list of
1765	"name=value" type entries. The following ones are recognized:
1766	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1767	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1768	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1769	naming scheme which should not be used unless necessary.
1770	</desc>
1771	</param>
1772	<param name="machine" type="IMachine" dir="return">
1773	<desc>Created machine object.</desc>
1774	</param>
1775	</method>
1776
1777	<method name="openMachine">
1778	<desc>
1779	Opens a virtual machine from the existing settings file.
1780	The opened machine remains unregistered until you call
1781	<link to="#registerMachine"/>.
1782
1783	The specified settings file name must be fully qualified.
1784	The file must exist and be a valid machine XML settings file
1785	whose contents will be used to construct the machine object.
1786
1787	<result name="VBOX_E_FILE_ERROR">
1788	Settings file name invalid, not found or sharing violation.
1789	</result>
1790	</desc>
1791	<param name="settingsFile" type="wstring" dir="in">
1792	<desc>
1793	Name of the machine settings file.
1794	</desc>
1795	</param>
1796	<param name="machine" type="IMachine" dir="return">
1797	<desc>Opened machine object.</desc>
1798	</param>
1799	<note>
1800	<link to="IMachine::settingsModified"/> will return
1801	@c false for the created machine, until any of machine settings
1802	are changed.
1803	</note>
1804	</method>
1805
1806	<method name="registerMachine">
1807	<desc>
1808
1809	Registers the machine previously created using
1810	<link to="#createMachine"/> or opened using
1811	<link to="#openMachine"/> within this VirtualBox installation. After
1812	successful method invocation, the
1813	<link to="IMachineRegisteredEvent"/> event is fired.
1814
1815	<note>
1816	This method implicitly calls <link to="IMachine::saveSettings"/>
1817	to save all current machine settings before registering it.
1818	</note>
1819
1820	<result name="VBOX_E_OBJECT_NOT_FOUND">
1821	No matching virtual machine found.
1822	</result>
1823	<result name="VBOX_E_INVALID_OBJECT_STATE">
1824	Virtual machine was not created within this VirtualBox instance.
1825	</result>
1826
1827	</desc>
1828	<param name="machine" type="IMachine" dir="in"/>
1829	</method>
1830
1831	<method name="findMachine">
1832	<desc>
1833	Attempts to find a virtual machine given its name or UUID.
1834
1835	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1836	cannot safely be determined.</note>
1837
1838	<result name="VBOX_E_OBJECT_NOT_FOUND">
1839	Could not find registered machine matching @a nameOrId.
1840	</result>
1841
1842	</desc>
1843	<param name="nameOrId" type="wstring" dir="in">
1844	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1845	</param>
1846	<param name="machine" type="IMachine" dir="return">
1847	<desc>Machine object, if found.</desc>
1848	</param>
1849	</method>
1850
1851	<method name="getMachinesByGroups">
1852	<desc>
1853	Gets all machine references which are in one of the specified groups.
1854	</desc>
1855	<param name="groups" type="wstring" dir="in" safearray="yes">
1856	<desc>What groups to match. The usual group list rules apply, i.e.
1857	passing an empty list will match VMs in the toplevel group, likewise
1858	the empty string.</desc>
1859	</param>
1860	<param name="machines" type="IMachine" dir="return" safearray="yes">
1861	<desc>All machines which matched.</desc>
1862	</param>
1863	</method>
1864
1865	<method name="getMachineStates">
1866	<desc>
1867	Gets the state of several machines in a single operation.
1868	</desc>
1869	<param name="machines" type="IMachine" dir="in" safearray="yes">
1870	<desc>Array with the machine references.</desc>
1871	</param>
1872	<param name="states" type="MachineState" dir="return" safearray="yes">
1873	<desc>Machine states, corresponding to the machines.</desc>
1874	</param>
1875	</method>
1876
1877	<method name="createAppliance">
1878	<desc>
1879	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1880	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1881	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1882	</desc>
1883	<param name="appliance" type="IAppliance" dir="return">
1884	<desc>New appliance.</desc>
1885	</param>
1886	</method>
1887
1888	<method name="createHardDisk">
1889	<desc>
1890	Creates a new base medium object that will use the given storage
1891	format and location for medium data.
1892
1893	The actual storage unit is not created by this method. In order to
1894	do it, and before you are able to attach the created medium to
1895	virtual machines, you must call one of the following methods to
1896	allocate a format-specific storage unit at the specified location:
1897	<ul>
1898	<li><link to="IMedium::createBaseStorage"/></li>
1899	<li><link to="IMedium::createDiffStorage"/></li>
1900	</ul>
1901
1902	Some medium attributes, such as <link to="IMedium::id"/>, may
1903	remain uninitialized until the medium storage unit is successfully
1904	created by one of the above methods.
1905
1906	After the storage unit is successfully created, it will be
1907	accessible through the <link to="#openMedium"/> method and can
1908	be found in the <link to="#hardDisks"/> array.
1909
1910	The list of all storage formats supported by this VirtualBox
1911	installation can be obtained using
1912	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1913	attribute is empty or @c null then the default storage format
1914	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1915	be used for creating a storage unit of the medium.
1916
1917	Note that the format of the location string is storage format specific.
1918	See <link to="IMedium::location"/> and IMedium for more details.
1919
1920	<result name="VBOX_E_OBJECT_NOT_FOUND">
1921	@a format identifier is invalid. See
1922	<link to="ISystemProperties::mediumFormats"/>.
1923	</result>
1924	<result name="VBOX_E_FILE_ERROR">
1925	@a location is a not valid file name (for file-based formats only).
1926	</result>
1927	</desc>
1928	<param name="format" type="wstring" dir="in">
1929	<desc>
1930	Identifier of the storage format to use for the new medium.
1931	</desc>
1932	</param>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>
1935	Location of the storage unit for the new medium.
1936	</desc>
1937	</param>
1938	<param name="medium" type="IMedium" dir="return">
1939	<desc>Created medium object.</desc>
1940	</param>
1941	</method>
1942
1943	<method name="openMedium">
1944	<desc>
1945	Finds existing media or opens a medium from an existing storage location.
1946
1947	Once a medium has been opened, it can be passed to other VirtualBox
1948	methods, in particular to <link to="IMachine::attachDevice" />.
1949
1950	Depending on the given device type, the file at the storage location
1951	must be in one of the media formats understood by VirtualBox:
1952
1953	<ul>
1954	<li>With a "HardDisk" device type, the file must be a hard disk image
1955	in one of the formats supported by VirtualBox (see
1956	<link to="ISystemProperties::mediumFormats" />).
1957	After this method succeeds, if the medium is a base medium, it
1958	will be added to the <link to="#hardDisks"/> array attribute. </li>
1959	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1960	After this method succeeds, the medium will be added to the
1961	<link to="#DVDImages"/> array attribute.</li>
1962	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1963	After this method succeeds, the medium will be added to the
1964	<link to="#floppyImages"/> array attribute.</li>
1965	</ul>
1966
1967	After having been opened, the medium can be re-found by this method
1968	and can be attached to virtual machines. See <link to="IMedium" /> for
1969	more details.
1970
1971	The UUID of the newly opened medium will either be retrieved from the
1972	storage location, if the format supports it (e.g. for hard disk images),
1973	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1974	If for some reason you need to change the medium's UUID, use
1975	<link to="IMedium::setIds" />.
1976
1977	If a differencing hard disk medium is to be opened by this method, the
1978	operation will succeed only if its parent medium and all ancestors,
1979	if any, are already known to this VirtualBox installation (for example,
1980	were opened by this method before).
1981
1982	This method attempts to guess the storage format of the specified medium
1983	by reading medium data at the specified location.
1984
1985	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1986	the image is opened for read/write access and must have according permissions,
1987	as VirtualBox may actually write status information into the disk's metadata
1988	sections.
1989
1990	Note that write access is required for all typical hard disk usage in VirtualBox,
1991	since VirtualBox may need to write metadata such as a UUID into the image.
1992	The only exception is opening a source image temporarily for copying and
1993	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1994	again soon.
1995
1996	The format of the location string is storage format specific. See
1997	<link to="IMedium::location"/> and IMedium for more details.
1998
1999	<result name="VBOX_E_FILE_ERROR">
2000	Invalid medium storage file location or could not find the medium
2001	at the specified location.
2002	</result>
2003	<result name="VBOX_E_IPRT_ERROR">
2004	Could not get medium storage format.
2005	</result>
2006	<result name="E_INVALIDARG">
2007	Invalid medium storage format.
2008	</result>
2009	<result name="VBOX_E_INVALID_OBJECT_STATE">
2010	Medium has already been added to a media registry.
2011	</result>
2012	</desc>
2013	<param name="location" type="wstring" dir="in">
2014	<desc>
2015	Location of the storage unit that contains medium data in one of
2016	the supported storage formats.
2017	</desc>
2018	</param>
2019	<param name="deviceType" type="DeviceType" dir="in">
2020	<desc>
2021	Must be one of "HardDisk", "DVD" or "Floppy".
2022	</desc>
2023	</param>
2024	<param name="accessMode" type="AccessMode" dir="in">
2025	<desc>Whether to open the image in read/write or read-only mode. For
2026	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2027	</param>
2028	<param name="forceNewUuid" type="boolean" dir="in">
2029	<desc>Allows the caller to request a completely new medium UUID for
2030	the image which is to be opened. Useful if one intends to open an exact
2031	copy of a previously opened image, as this would normally fail due to
2032	the duplicate UUID.</desc>
2033	</param>
2034	<param name="medium" type="IMedium" dir="return">
2035	<desc>Opened medium object.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="getGuestOSType">
2040	<desc>
2041	Returns an object describing the specified guest OS type.
2042
2043	The requested guest OS type is specified using a string which is a
2044	mnemonic identifier of the guest operating system, such as
2045	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2046	particular virtual machine can be read or set using the
2047	<link to="IMachine::OSTypeId"/> attribute.
2048
2049	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2050	available guest OS type objects. Each object has an
2051	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2052	the guest OS this object describes.
2053
2054	<result name="E_INVALIDARG">
2055	@a id is not a valid Guest OS type.
2056	</result>
2057
2058	</desc>
2059	<param name="id" type="uuid" mod="string" dir="in">
2060	<desc>Guest OS type ID string.</desc>
2061	</param>
2062	<param name="type" type="IGuestOSType" dir="return">
2063	<desc>Guest OS type object.</desc>
2064	</param>
2065	</method>
2066
2067	<method name="createSharedFolder">
2068	<desc>
2069	Creates a new global shared folder by associating the given logical
2070	name with the given host path, adds it to the collection of shared
2071	folders and starts sharing it. Refer to the description of
2072	<link to="ISharedFolder"/> to read more about logical names.
2073	<note>
2074	In the current implementation, this operation is not
2075	implemented.
2076	</note>
2077	</desc>
2078	<param name="name" type="wstring" dir="in">
2079	<desc>Unique logical name of the shared folder.</desc>
2080	</param>
2081	<param name="hostPath" type="wstring" dir="in">
2082	<desc>Full path to the shared folder in the host file system.</desc>
2083	</param>
2084	<param name="writable" type="boolean" dir="in">
2085	<desc>Whether the share is writable or readonly</desc>
2086	</param>
2087	<param name="automount" type="boolean" dir="in">
2088	<desc>Whether the share gets automatically mounted by the guest
2089	or not.</desc>
2090	</param>
2091	</method>
2092
2093	<method name="removeSharedFolder">
2094	<desc>
2095	Removes the global shared folder with the given name previously
2096	created by <link to="#createSharedFolder"/> from the collection of
2097	shared folders and stops sharing it.
2098	<note>
2099	In the current implementation, this operation is not
2100	implemented.
2101	</note>
2102	</desc>
2103	<param name="name" type="wstring" dir="in">
2104	<desc>Logical name of the shared folder to remove.</desc>
2105	</param>
2106	</method>
2107
2108	<method name="getExtraDataKeys">
2109	<desc>
2110	Returns an array representing the global extra data keys which currently
2111	have values defined.
2112	</desc>
2113	<param name="value" type="wstring" dir="return" safearray="yes">
2114	<desc>Array of extra data keys.</desc>
2115	</param>
2116	</method>
2117
2118	<method name="getExtraData">
2119	<desc>
2120	Returns associated global extra data.
2121
2122	If the requested data @a key does not exist, this function will
2123	succeed and return an empty string in the @a value argument.
2124
2125	<result name="VBOX_E_FILE_ERROR">
2126	Settings file not accessible.
2127	</result>
2128	<result name="VBOX_E_XML_ERROR">
2129	Could not parse the settings file.
2130	</result>
2131
2132	</desc>
2133	<param name="key" type="wstring" dir="in">
2134	<desc>Name of the data key to get.</desc>
2135	</param>
2136	<param name="value" type="wstring" dir="return">
2137	<desc>Value of the requested data key.</desc>
2138	</param>
2139	</method>
2140
2141	<method name="setExtraData">
2142	<desc>
2143	Sets associated global extra data.
2144
2145	If you pass @c null or empty string as a key @a value, the given @a key
2146	will be deleted.
2147
2148	<note>
2149	Before performing the actual data change, this method will ask all
2150	registered event listener using the
2151	<link to="IExtraDataCanChangeEvent"/>
2152	notification for a permission. If one of the listeners refuses the
2153	new value, the change will not be performed.
2154	</note>
2155	<note>
2156	On success, the
2157	<link to="IExtraDataChangedEvent"/> notification
2158	is called to inform all registered listeners about a successful data
2159	change.
2160	</note>
2161
2162	<result name="VBOX_E_FILE_ERROR">
2163	Settings file not accessible.
2164	</result>
2165	<result name="VBOX_E_XML_ERROR">
2166	Could not parse the settings file.
2167	</result>
2168	<result name="E_ACCESSDENIED">
2169	Modification request refused.
2170	</result>
2171
2172	</desc>
2173	<param name="key" type="wstring" dir="in">
2174	<desc>Name of the data key to set.</desc>
2175	</param>
2176	<param name="value" type="wstring" dir="in">
2177	<desc>Value to assign to the key.</desc>
2178	</param>
2179	</method>
2180
2181	<method name="setSettingsSecret">
2182	<desc>
2183	Unlocks the secret data by passing the unlock password to the
2184	server. The server will cache the password for that machine.
2185
2186	<result name="VBOX_E_INVALID_VM_STATE">
2187	Virtual machine is not mutable.
2188	</result>
2189
2190	</desc>
2191	<param name="password" type="wstring" dir="in">
2192	<desc>
2193	The cipher key.
2194	</desc>
2195	</param>
2196	</method>
2197
2198	<!--method name="createDHCPServerForInterface">
2199	<desc>
2200	Creates a DHCP server settings to be used for the given interface
2201	<result name="E_INVALIDARG">
2202	Host network interface @a name already exists.
2203	</result>
2204	</desc>
2205	<param name="interface" type="IHostNetworkInterface" dir="in">
2206	<desc>Network Interface</desc>
2207	</param>
2208	<param name="server" type="IDHCPServer" dir="out">
2209	<desc>DHCP server settings</desc>
2210	</param>
2211	</method-->
2212
2213	<method name="createDHCPServer">
2214	<desc>
2215	Creates a DHCP server settings to be used for the given internal network name
2216	<result name="E_INVALIDARG">
2217	Host network interface @a name already exists.
2218	</result>
2219	</desc>
2220	<param name="name" type="wstring" dir="in">
2221	<desc>server name</desc>
2222	</param>
2223	<param name="server" type="IDHCPServer" dir="return">
2224	<desc>DHCP server settings</desc>
2225	</param>
2226	</method>
2227
2228	<method name="findDHCPServerByNetworkName">
2229	<desc>
2230	Searches a DHCP server settings to be used for the given internal network name
2231	<result name="E_INVALIDARG">
2232	Host network interface @a name already exists.
2233	</result>
2234
2235	</desc>
2236	<param name="name" type="wstring" dir="in">
2237	<desc>server name</desc>
2238	</param>
2239	<param name="server" type="IDHCPServer" dir="return">
2240	<desc>DHCP server settings</desc>
2241	</param>
2242	</method>
2243
2244	<!--method name="findDHCPServerForInterface">
2245	<desc>
2246	Searches a DHCP server settings to be used for the given interface
2247	<result name="E_INVALIDARG">
2248	Host network interface @a name already exists.
2249	</result>
2250	</desc>
2251	<param name="interface" type="IHostNetworkInterface" dir="in">
2252	<desc>Network Interface</desc>
2253	</param>
2254	<param name="server" type="IDHCPServer" dir="out">
2255	<desc>DHCP server settings</desc>
2256	</param>
2257	</method-->
2258
2259	<method name="removeDHCPServer">
2260	<desc>
2261	Removes the DHCP server settings
2262	<result name="E_INVALIDARG">
2263	Host network interface @a name already exists.
2264	</result>
2265	</desc>
2266	<param name="server" type="IDHCPServer" dir="in">
2267	<desc>DHCP server settings to be removed</desc>
2268	</param>
2269	</method>
2270
2271
2272	<method name="checkFirmwarePresent">
2273	<desc>
2274	Check if this VirtualBox installation has a firmware
2275	of the given type available, either system-wide or per-user.
2276	Optionally, this may return a hint where this firmware can be
2277	downloaded from.
2278	</desc>
2279	<param name="firmwareType" type="FirmwareType" dir="in">
2280	<desc>
2281	Type of firmware to check.
2282	</desc>
2283	</param>
2284	<param name="version" type="wstring" dir="in">
2285	<desc>Expected version number, usually empty string (presently ignored).</desc>
2286	</param>
2287
2288	<param name="url" type="wstring" dir="out">
2289	<desc>
2290	Suggested URL to download this firmware from.
2291	</desc>
2292	</param>
2293
2294	<param name="file" type="wstring" dir="out">
2295	<desc>
2296	Filename of firmware, only valid if result == TRUE.
2297	</desc>
2298	</param>
2299
2300	<param name="result" type="boolean" dir="return">
2301	<desc>If firmware of this type and version is available.</desc>
2302	</param>
2303	</method>
2304
2305	</interface>
2306
2307	<!--
2308	// IVFSExplorer
2309	/////////////////////////////////////////////////////////////////////////
2310	-->
2311
2312	<enum
2313	name="VFSType"
2314	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2315	>
2316	<desc>
2317	Virtual file systems supported by VFSExplorer.
2318	</desc>
2319
2320	<const name="File" value="1" />
2321	<const name="Cloud" value="2" />
2322	<const name="S3" value="3" />
2323	<const name="WebDav" value="4" />
2324	</enum>
2325
2326	<enum
2327	name="VFSFileType"
2328	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2329	>
2330	<desc>
2331	File types known by VFSExplorer.
2332	</desc>
2333
2334	<const name="Unknown" value="1" />
2335	<const name="Fifo" value="2" />
2336	<const name="DevChar" value="3" />
2337	<const name="Directory" value="4" />
2338	<const name="DevBlock" value="5" />
2339	<const name="File" value="6" />
2340	<const name="SymLink" value="7" />
2341	<const name="Socket" value="8" />
2342	<const name="WhiteOut" value="9" />
2343	</enum>
2344
2345	<interface
2346	name="IVFSExplorer" extends="$unknown"
2347	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2348	wsmap="managed"
2349	>
2350	<desc>
2351	The VFSExplorer interface unifies access to different file system
2352	types. This includes local file systems as well remote file systems like
2353	S3. For a list of supported types see <link to="VFSType" />.
2354	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2355	</desc>
2356
2357	<attribute name="path" type="wstring" readonly="yes">
2358	<desc>Returns the current path in the virtual file system.</desc>
2359	</attribute>
2360
2361	<attribute name="type" type="VFSType" readonly="yes">
2362	<desc>Returns the file system type which is currently in use.</desc>
2363	</attribute>
2364
2365	<method name="update">
2366	<desc>Updates the internal list of files/directories from the
2367	current directory level. Use <link to="#entryList" /> to get the full list
2368	after a call to this method.</desc>
2369
2370	<param name="aProgress" type="IProgress" dir="return">
2371	<desc>Progress object to track the operation completion.</desc>
2372	</param>
2373	</method>
2374
2375	<method name="cd">
2376	<desc>Change the current directory level.</desc>
2377
2378	<param name="aDir" type="wstring" dir="in">
2379	<desc>The name of the directory to go in.</desc>
2380	</param>
2381
2382	<param name="aProgress" type="IProgress" dir="return">
2383	<desc>Progress object to track the operation completion.</desc>
2384	</param>
2385	</method>
2386
2387	<method name="cdUp">
2388	<desc>Go one directory upwards from the current directory level.</desc>
2389
2390	<param name="aProgress" type="IProgress" dir="return">
2391	<desc>Progress object to track the operation completion.</desc>
2392	</param>
2393	</method>
2394
2395	<method name="entryList">
2396	<desc>Returns a list of files/directories after a call to <link
2397	to="#update" />. The user is responsible for keeping this internal
2398	list up do date.</desc>
2399
2400	<param name="aNames" type="wstring" safearray="yes" dir="out">
2401	<desc>The list of names for the entries.</desc>
2402	</param>
2403
2404	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2405	<desc>The list of types for the entries.</desc>
2406	</param>
2407
2408	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2409	<desc>The list of sizes (in bytes) for the entries.</desc>
2410	</param>
2411
2412	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2413	<desc>The list of file modes (in octal form) for the entries.</desc>
2414	</param>
2415	</method>
2416
2417	<method name="exists">
2418	<desc>Checks if the given file list exists in the current directory
2419	level.</desc>
2420
2421	<param name="aNames" type="wstring" safearray="yes" dir="in">
2422	<desc>The names to check.</desc>
2423	</param>
2424
2425	<param name="aExists" type="wstring" safearray="yes" dir="return">
2426	<desc>The names which exist.</desc>
2427	</param>
2428	</method>
2429
2430	<method name="remove">
2431	<desc>Deletes the given files in the current directory level.</desc>
2432
2433	<param name="aNames" type="wstring" safearray="yes" dir="in">
2434	<desc>The names to remove.</desc>
2435	</param>
2436
2437	<param name="aProgress" type="IProgress" dir="return">
2438	<desc>Progress object to track the operation completion.</desc>
2439	</param>
2440	</method>
2441
2442	</interface>
2443
2444	<enum
2445	name="ImportOptions" extends="$unknown"
2446	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2447	>
2448
2449	<desc>
2450	Import options, used with <link to="IAppliance::importMachines" />.
2451	</desc>
2452
2453	<const name="KeepAllMACs" value="1">
2454	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2455	</const>
2456	<const name="KeepNATMACs" value="2">
2457	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2458	</const>
2459
2460	</enum>
2461
2462
2463	<!--
2464	// IAppliance
2465	/////////////////////////////////////////////////////////////////////////
2466	-->
2467
2468	<interface
2469	name="IAppliance" extends="$unknown"
2470	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2471	wsmap="managed"
2472	>
2473	<desc>
2474	Represents a platform-independent appliance in OVF format. An instance of this is returned
2475	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2476	virtual machines within an appliance with VirtualBox.
2477
2478	The OVF standard suggests two different physical file formats:
2479
2480	<ol>
2481	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2482	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2483	this descriptor file references other files such as disk images, as OVF appliances typically
2484	do, those additional files must be in the same directory as the descriptor file.</li>
2485
2486	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2487	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2488	files and optionally other files.
2489
2490	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2491	be added with a later version.</li>
2492	</ol>
2493
2494	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2495	<link to="IMachine" /> involves the following sequence of API calls:
2496
2497	<ol>
2498	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2499	</li>
2500
2501	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2502	would like to import. So long as this file is syntactically valid, this will succeed
2503	and fill the appliance object with the parsed data from the OVF file.
2504	</li>
2505
2506	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2507	contents of the IAppliance attributes accordingly. These can be inspected by a
2508	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2509	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2510	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2511	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2512	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2513	The GUI can then give the user the option to confirm and/or change these suggestions.
2514	</li>
2515
2516	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2517	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2518	</li>
2519
2520	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2521	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2522	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2523	can be found in the <link to="#machines" /> array attribute.
2524	</li>
2525	</ol>
2526
2527	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2528
2529	<ol>
2530	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2531	an empty IAppliance object.
2532	</li>
2533
2534	<li>For each machine you would like to export, call <link to="IMachine::export" />
2535	with the IAppliance object you just created. Each such call creates one instance of
2536	<link to="IVirtualSystemDescription" /> inside the appliance.
2537	</li>
2538
2539	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2540	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2541	</li>
2542
2543	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2544	file written.</li>
2545	</ol>
2546
2547	</desc>
2548
2549	<attribute name="path" type="wstring" readonly="yes">
2550	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2551	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2552	<link to="#write" /> (for export).
2553	This attribute is empty until one of these methods has been called.
2554	</desc>
2555	</attribute>
2556
2557	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2558	<desc>
2559	Array of virtual disk definitions. One such description exists for each
2560	disk definition in the OVF; each string array item represents one such piece of
2561	disk information, with the information fields separated by tab (\\t) characters.
2562
2563	The caller should be prepared for additional fields being appended to
2564	this string in future versions of VirtualBox and therefore check for
2565	the number of tabs in the strings returned.
2566
2567	In the current version, the following eight fields are returned per string
2568	in the array:
2569
2570	<ol>
2571	<li>Disk ID (unique string identifier given to disk)</li>
2572
2573	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2574
2575	<li>Populated size (optional unsigned integer indicating the current size of the
2576	disk; can be approximate; -1 if unspecified)</li>
2577
2578	<li>Format (string identifying the disk format, typically
2579	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2580
2581	<li>Reference (where to find the disk image, typically a file name; if empty,
2582	then the disk should be created on import)</li>
2583
2584	<li>Image size (optional unsigned integer indicating the size of the image,
2585	which need not necessarily be the same as the values specified above, since
2586	the image may be compressed or sparse; -1 if not specified)</li>
2587
2588	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2589	presently unsupported and always -1)</li>
2590
2591	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2592	</ol>
2593	</desc>
2594	</attribute>
2595
2596	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2597	<desc> Array of virtual system descriptions. One such description is created
2598	for each virtual system (machine) found in the OVF.
2599	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2600	(for export) has been called.
2601	</desc>
2602	</attribute>
2603
2604	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2605	<desc>
2606	Contains the UUIDs of the machines created from the information in this appliances. This is only
2607	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2608	succeeded.
2609	</desc>
2610	</attribute>
2611
2612	<method name="read">
2613	<desc>
2614	Reads an OVF file into the appliance object.
2615
2616	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2617	mere fact that this method returns successfully does not mean that VirtualBox supports all
2618	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2619	</desc>
2620	<param name="file" type="wstring" dir="in">
2621	<desc>
2622	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2623	on whether the appliance is distributed as a set of files or as a single file, respectively).
2624	</desc>
2625	</param>
2626	<param name="aProgress" type="IProgress" dir="return">
2627	<desc>Progress object to track the operation completion.</desc>
2628	</param>
2629	</method>
2630
2631	<method name="interpret">
2632	<desc>
2633	Interprets the OVF data that was read when the appliance was constructed. After
2634	calling this method, one can inspect the
2635	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2636	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2637	the appliance.
2638
2639	Calling this method is the second step of importing an appliance into VirtualBox;
2640	see <link to="IAppliance" /> for an overview.
2641
2642	After calling this method, one should call <link to="#getWarnings" /> to find out
2643	if problems were encountered during the processing which might later lead to
2644	errors.
2645	</desc>
2646	</method>
2647
2648	<method name="importMachines">
2649	<desc>
2650	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2651	and other interfaces that match the information contained in the appliance as
2652	closely as possible, as represented by the import instructions in the
2653	<link to="#virtualSystemDescriptions" /> array.
2654
2655	Calling this method is the final step of importing an appliance into VirtualBox;
2656	see <link to="IAppliance" /> for an overview.
2657
2658	Since importing the appliance will most probably involve copying and converting
2659	disk images, which can take a long time, this method operates asynchronously and
2660	returns an IProgress object to allow the caller to monitor the progress.
2661
2662	After the import succeeded, the UUIDs of the IMachine instances created can be
2663	retrieved from the <link to="#machines" /> array attribute.
2664	</desc>
2665
2666	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2667	<desc>Options for the importing operation.</desc>
2668	</param>
2669
2670	<param name="aProgress" type="IProgress" dir="return">
2671	<desc>Progress object to track the operation completion.</desc>
2672	</param>
2673	</method>
2674
2675	<method name="createVFSExplorer">
2676	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2677
2678	<param name="aUri" type="wstring" dir="in">
2679	<desc>The URI describing the file system to use.</desc>
2680	</param>
2681
2682	<param name="aExplorer" type="IVFSExplorer" dir="return">
2683	<desc></desc>
2684	</param>
2685	</method>
2686
2687	<method name="write">
2688	<desc>
2689	Writes the contents of the appliance exports into a new OVF file.
2690
2691	Calling this method is the final step of exporting an appliance from VirtualBox;
2692	see <link to="IAppliance" /> for an overview.
2693
2694	Since exporting the appliance will most probably involve copying and converting
2695	disk images, which can take a long time, this method operates asynchronously and
2696	returns an IProgress object to allow the caller to monitor the progress.
2697	</desc>
2698	<param name="format" type="wstring" dir="in">
2699	<desc>
2700	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2701	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2702	</desc>
2703	</param>
2704	<param name="manifest" type="boolean" dir="in">
2705	<desc>
2706	Indicate if the optional manifest file (.mf) should be written. The manifest file
2707	is used for integrity checks prior import.
2708	</desc>
2709	</param>
2710	<param name="path" type="wstring" dir="in">
2711	<desc>
2712	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2713	on whether the appliance is distributed as a set of files or as a single file, respectively).
2714	</desc>
2715	</param>
2716	<param name="progress" type="IProgress" dir="return">
2717	<desc>Progress object to track the operation completion.</desc>
2718	</param>
2719	</method>
2720
2721	<method name="getWarnings">
2722	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2723
2724	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2725	<desc></desc>
2726	</param>
2727	</method>
2728
2729	</interface>
2730
2731	<enum
2732	name="VirtualSystemDescriptionType"
2733	uuid="303c0900-a746-4612-8c67-79003e91f459"
2734	>
2735	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2736	a configuration value.</desc>
2737
2738	<const name="Ignore" value="1" />
2739	<const name="OS" value="2" />
2740	<const name="Name" value="3" />
2741	<const name="Product" value="4" />
2742	<const name="Vendor" value="5" />
2743	<const name="Version" value="6" />
2744	<const name="ProductUrl" value="7" />
2745	<const name="VendorUrl" value="8" />
2746	<const name="Description" value="9" />
2747	<const name="License" value="10" />
2748	<const name="Miscellaneous" value="11" />
2749	<const name="CPU" value="12" />
2750	<const name="Memory" value="13" />
2751	<const name="HardDiskControllerIDE" value="14" />
2752	<const name="HardDiskControllerSATA" value="15" />
2753	<const name="HardDiskControllerSCSI" value="16" />
2754	<const name="HardDiskControllerSAS" value="17" />
2755	<const name="HardDiskImage" value="18" />
2756	<const name="Floppy" value="19" />
2757	<const name="CDROM" value="20" />
2758	<const name="NetworkAdapter" value="21" />
2759	<const name="USBController" value="22" />
2760	<const name="SoundCard" value="23" />
2761	<const name="SettingsFile" value="24">
2762	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2763	</const>
2764	</enum>
2765
2766	<enum
2767	name="VirtualSystemDescriptionValueType"
2768	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2769	>
2770	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2771	type to fetch.</desc>
2772
2773	<const name="Reference" value="1" />
2774	<const name="Original" value="2" />
2775	<const name="Auto" value="3" />
2776	<const name="ExtraConfig" value="4" />
2777
2778	</enum>
2779
2780	<interface
2781	name="IVirtualSystemDescription" extends="$unknown"
2782	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2783	wsmap="managed"
2784	>
2785
2786	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2787	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2788	<link to="IAppliance::interpret" /> has been called, that array contains information
2789	about how the virtual systems described in the OVF should best be imported into
2790	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2791	import an OVF into VirtualBox.
2792	</desc>
2793
2794	<attribute name="count" type="unsigned long" readonly="yes">
2795	<desc>Return the number of virtual system description entries.</desc>
2796	</attribute>
2797
2798	<method name="getDescription">
2799	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2800	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2801
2802	The list below identifies the value sets that are possible depending on the
2803	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2804	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2805	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2806	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2807	the @a aExtraConfigValues[] array item may also be used.
2808
2809	<ul>
2810	<li>
2811	"OS": the guest operating system type. There must be exactly one such array item on import. The
2812	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2813	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2814	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2815	</li>
2816	<li>
2817	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2818	if none is present on import, then an automatic name will be created from the operating system
2819	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2820	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2821	<link to="IMachine" /> name that does not exist yet.
2822	</li>
2823	<li>
2824	"Description": an arbitrary description.
2825	</li>
2826	<li>
2827	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2828	code to display such a license for agreement; the Main API does not enforce any such policy.
2829	</li>
2830	<li>
2831	Miscellaneous: reserved for future use.
2832	</li>
2833	<li>
2834	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2835	</li>
2836	<li>
2837	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2838	is present on import, then VirtualBox will set a meaningful default based on the operating system
2839	type.
2840	</li>
2841	<li>
2842	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2843	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2844	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2845	writes into the OVF.
2846	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2847	type can use to specify which hard disk controller a virtual disk should be connected to.
2848	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2849	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2850	its virtual machines supports four channels (primary master, primary slave, secondary master,
2851	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2852	</li>
2853	<li>
2854	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2855	has no value in @a aOvfValues[] or @a aVBoxValues[].
2856	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2857	</li>
2858	<li>
2859	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2860	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2861	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2862	whereas VirtualBox considers it a class of storage controllers of its own; see
2863	<link to="StorageControllerType" />).
2864	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2865	</li>
2866	<li>
2867	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2868	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2869
2870	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2871	a path since the image file should be in the same location as the OVF file itself), whereas the
2872	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2873	hard disk image. This means that on import the image will be copied and converted from the
2874	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2875
2876	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2877	format: "controller=<index>;channel=<c>"
2878	In this string, <index> must be an integer specifying the hard disk controller to connect
2879	the image to. That number must be the index of an array item with one of the hard disk controller
2880	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2881	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2882	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2883	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2884	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2885	</li>
2886	<li>
2887	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2888	attachment information as with "HardDiskImage" items.
2889	</li>
2890	<li>
2891	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2892	attachment information as with "HardDiskImage" items.
2893	</li>
2894	<li>
2895	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2896	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2897	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2898	</li>
2899	<li>
2900	"USBController": a USB controller. There can be at most one such item. If and only if such an
2901	item ispresent, USB support will be enabled for the new virtual machine.
2902	</li>
2903	<li>
2904	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2905	present, sound support will be enabled for the new virtual machine. Note that the virtual
2906	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2907	may be different from the virtual soundcard expected by the appliance.
2908	</li>
2909	</ul>
2910
2911	</desc>
2912
2913	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2914	<desc></desc>
2915	</param>
2916
2917	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2918	<desc></desc>
2919	</param>
2920
2921	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2922	<desc></desc>
2923	</param>
2924
2925	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2926	<desc></desc>
2927	</param>
2928
2929	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2930	<desc></desc>
2931	</param>
2932
2933	</method>
2934
2935	<method name="getDescriptionByType">
2936	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2937	should be returned.</desc>
2938
2939	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2940	<desc></desc>
2941	</param>
2942
2943	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2944	<desc></desc>
2945	</param>
2946
2947	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2948	<desc></desc>
2949	</param>
2950
2951	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2952	<desc></desc>
2953	</param>
2954
2955	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2956	<desc></desc>
2957	</param>
2958
2959	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2960	<desc></desc>
2961	</param>
2962
2963	</method>
2964
2965	<method name="getValuesByType">
2966	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2967	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2968	values.</desc>
2969
2970	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2971	<desc></desc>
2972	</param>
2973
2974	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2975	<desc></desc>
2976	</param>
2977
2978	<param name="aValues" type="wstring" dir="return" safearray="yes">
2979	<desc></desc>
2980	</param>
2981
2982	</method>
2983
2984	<method name="setFinalValues">
2985	<desc>
2986	This method allows the appliance's user to change the configuration for the virtual
2987	system descriptions. For each array item returned from <link to="#getDescription" />,
2988	you must pass in one boolean value and one configuration value.
2989
2990	Each item in the boolean array determines whether the particular configuration item
2991	should be enabled.
2992	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2993	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2994	and SoundCard.
2995
2996	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2997	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2998	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2999	for valid configuration values for the individual array item types. If the
3000	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3001	</desc>
3002
3003	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3004	<desc></desc>
3005	</param>
3006
3007	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3008	<desc></desc>
3009	</param>
3010
3011	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3012	<desc></desc>
3013	</param>
3014	</method>
3015
3016	<method name="addDescription">
3017	<desc>
3018	This method adds an additional description entry to the stack of already
3019	available descriptions for this virtual system. This is handy for writing
3020	values which aren't directly supported by VirtualBox. One example would
3021	be the License type of <link to="VirtualSystemDescriptionType" />.
3022	</desc>
3023
3024	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3025	<desc></desc>
3026	</param>
3027
3028	<param name="aVBoxValue" type="wstring" dir="in">
3029	<desc></desc>
3030	</param>
3031
3032	<param name="aExtraConfigValue" type="wstring" dir="in">
3033	<desc></desc>
3034	</param>
3035	</method>
3036	</interface>
3037
3038
3039	<!--
3040	// IMachine
3041	/////////////////////////////////////////////////////////////////////////
3042	-->
3043
3044	<interface
3045	name="IInternalMachineControl" extends="$unknown"
3046	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3047	internal="yes"
3048	wsmap="suppress"
3049	>
3050	<method name="setRemoveSavedStateFile">
3051	<desc>
3052	Updates the flag whether the saved state file is removed on a
3053	machine state change from Saved to PoweredOff.
3054	</desc>
3055	<param name="aRemove" type="boolean" dir="in"/>
3056	</method>
3057
3058	<method name="updateState">
3059	<desc>
3060	Updates the VM state.
3061	<note>
3062	This operation will also update the settings file with the correct
3063	information about the saved state file and delete this file from disk
3064	when appropriate.
3065	</note>
3066	</desc>
3067	<param name="state" type="MachineState" dir="in"/>
3068	</method>
3069
3070	<method name="getIPCId">
3071	<param name="id" type="wstring" dir="return"/>
3072	</method>
3073
3074	<method name="beginPowerUp">
3075	<desc>
3076	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3077	gives it the progress object that should be part of any pending
3078	<link to="IMachine::launchVMProcess"/> operations. The progress
3079	object may be called back to reflect an early cancelation, so some care
3080	have to be taken with respect to any cancelation callbacks. The console
3081	object will call <link to="IInternalMachineControl::endPowerUp"/>
3082	to signal the completion of the progress object.
3083	</desc>
3084	<param name="aProgress" type="IProgress" dir="in" />
3085	</method>
3086
3087	<method name="endPowerUp">
3088	<desc>
3089	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3090	This method may query status information from the progress object it
3091	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3092	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3093	call in order to complete that progress object.
3094	</desc>
3095	<param name="result" type="long" dir="in"/>
3096	</method>
3097
3098	<method name="beginPoweringDown">
3099	<desc>
3100	Called by the VM process to inform the server it wants to
3101	stop the VM execution and power down.
3102	</desc>
3103	<param name="progress" type="IProgress" dir="out">
3104	<desc>
3105	Progress object created by VBoxSVC to wait until
3106	the VM is powered down.
3107	</desc>
3108	</param>
3109	</method>
3110
3111	<method name="endPoweringDown">
3112	<desc>
3113	Called by the VM process to inform the server that powering
3114	down previously requested by #beginPoweringDown is either
3115	successfully finished or there was a failure.
3116
3117	<result name="VBOX_E_FILE_ERROR">
3118	Settings file not accessible.
3119	</result>
3120	<result name="VBOX_E_XML_ERROR">
3121	Could not parse the settings file.
3122	</result>
3123
3124	</desc>
3125
3126	<param name="result" type="long" dir="in">
3127	<desc>@c S_OK to indicate success.
3128	</desc>
3129	</param>
3130	<param name="errMsg" type="wstring" dir="in">
3131	<desc>@c human readable error message in case of failure.
3132	</desc>
3133	</param>
3134	</method>
3135
3136	<method name="runUSBDeviceFilters">
3137	<desc>
3138	Asks the server to run USB devices filters of the associated
3139	machine against the given USB device and tell if there is
3140	a match.
3141	<note>
3142	Intended to be used only for remote USB devices. Local
3143	ones don't require to call this method (this is done
3144	implicitly by the Host and USBProxyService).
3145	</note>
3146	</desc>
3147	<param name="device" type="IUSBDevice" dir="in"/>
3148	<param name="matched" type="boolean" dir="out"/>
3149	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3150	</method>
3151
3152	<method name="captureUSBDevice">
3153	<desc>
3154	Requests a capture of the given host USB device.
3155	When the request is completed, the VM process will
3156	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3157	notification.
3158	</desc>
3159	<param name="id" type="uuid" mod="string" dir="in"/>
3160	</method>
3161
3162	<method name="detachUSBDevice">
3163	<desc>
3164	Notification that a VM is going to detach (@a done = @c false) or has
3165	already detached (@a done = @c true) the given USB device.
3166	When the @a done = @c true request is completed, the VM process will
3167	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3168	notification.
3169	<note>
3170	In the @a done = @c true case, the server must run its own filters
3171	and filters of all VMs but this one on the detached device
3172	as if it were just attached to the host computer.
3173	</note>
3174	</desc>
3175	<param name="id" type="uuid" mod="string" dir="in"/>
3176	<param name="done" type="boolean" dir="in"/>
3177	</method>
3178
3179	<method name="autoCaptureUSBDevices">
3180	<desc>
3181	Requests a capture all matching USB devices attached to the host.
3182	When the request is completed, the VM process will
3183	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3184	notification per every captured device.
3185	</desc>
3186	</method>
3187
3188	<method name="detachAllUSBDevices">
3189	<desc>
3190	Notification that a VM that is being powered down. The done
3191	parameter indicates whether which stage of the power down
3192	we're at. When @a done = @c false the VM is announcing its
3193	intentions, while when @a done = @c true the VM is reporting
3194	what it has done.
3195	<note>
3196	In the @a done = @c true case, the server must run its own filters
3197	and filters of all VMs but this one on all detach devices as
3198	if they were just attached to the host computer.
3199	</note>
3200	</desc>
3201	<param name="done" type="boolean" dir="in"/>
3202	</method>
3203
3204	<method name="onSessionEnd">
3205	<desc>
3206	Triggered by the given session object when the session is about
3207	to close normally.
3208	</desc>
3209	<param name="session" type="ISession" dir="in">
3210	<desc>Session that is being closed</desc>
3211	</param>
3212	<param name="progress" type="IProgress" dir="return">
3213	<desc>
3214	Used to wait until the corresponding machine is actually
3215	dissociated from the given session on the server.
3216	Returned only when this session is a direct one.
3217	</desc>
3218	</param>
3219	</method>
3220
3221	<method name="beginSavingState">
3222	<desc>
3223	Called by the VM process to inform the server it wants to
3224	save the current state and stop the VM execution.
3225	</desc>
3226	<param name="progress" type="IProgress" dir="out">
3227	<desc>
3228	Progress object created by VBoxSVC to wait until
3229	the state is saved.
3230	</desc>
3231	</param>
3232	<param name="stateFilePath" type="wstring" dir="out">
3233	<desc>
3234	File path the VM process must save the execution state to.
3235	</desc>
3236	</param>
3237	</method>
3238
3239	<method name="endSavingState">
3240	<desc>
3241	Called by the VM process to inform the server that saving
3242	the state previously requested by #beginSavingState is either
3243	successfully finished or there was a failure.
3244
3245	<result name="VBOX_E_FILE_ERROR">
3246	Settings file not accessible.
3247	</result>
3248	<result name="VBOX_E_XML_ERROR">
3249	Could not parse the settings file.
3250	</result>
3251
3252	</desc>
3253
3254	<param name="result" type="long" dir="in">
3255	<desc>@c S_OK to indicate success.
3256	</desc>
3257	</param>
3258	<param name="errMsg" type="wstring" dir="in">
3259	<desc>@c human readable error message in case of failure.
3260	</desc>
3261	</param>
3262	</method>
3263
3264	<method name="adoptSavedState">
3265	<desc>
3266	Gets called by <link to="IConsole::adoptSavedState"/>.
3267	<result name="VBOX_E_FILE_ERROR">
3268	Invalid saved state file path.
3269	</result>
3270	</desc>
3271	<param name="savedStateFile" type="wstring" dir="in">
3272	<desc>Path to the saved state file to adopt.</desc>
3273	</param>
3274	</method>
3275
3276	<method name="beginTakingSnapshot">
3277	<desc>
3278	Called from the VM process to request from the server to perform the
3279	server-side actions of creating a snapshot (creating differencing images
3280	and the snapshot object).
3281
3282	<result name="VBOX_E_FILE_ERROR">
3283	Settings file not accessible.
3284	</result>
3285	<result name="VBOX_E_XML_ERROR">
3286	Could not parse the settings file.
3287	</result>
3288	</desc>
3289	<param name="initiator" type="IConsole" dir="in">
3290	<desc>The console object that initiated this call.</desc>
3291	</param>
3292	<param name="name" type="wstring" dir="in">
3293	<desc>Snapshot name.</desc>
3294	</param>
3295	<param name="description" type="wstring" dir="in">
3296	<desc>Snapshot description.</desc>
3297	</param>
3298	<param name="consoleProgress" type="IProgress" dir="in">
3299	<desc>
3300	Progress object created by the VM process tracking the
3301	snapshot's progress. This has the following sub-operations:
3302	<ul>
3303	<li>setting up (weight 1);</li>
3304	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3305	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3306	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3307	<li>finishing up (weight 1)</li>
3308	</ul>
3309	</desc>
3310	</param>
3311	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3312	<desc>
3313	Whether this is an online snapshot (i.e. the machine is running).
3314	</desc>
3315	</param>
3316	<param name="stateFilePath" type="wstring" dir="out">
3317	<desc>
3318	File path the VM process must save the execution state to.
3319	</desc>
3320	</param>
3321	</method>
3322
3323	<method name="endTakingSnapshot">
3324	<desc>
3325	Called by the VM process to inform the server that the snapshot
3326	previously requested by #beginTakingSnapshot is either
3327	successfully taken or there was a failure.
3328	</desc>
3329
3330	<param name="success" type="boolean" dir="in">
3331	<desc>@c true to indicate success and @c false otherwise</desc>
3332	</param>
3333	</method>
3334
3335	<method name="deleteSnapshot">
3336	<desc>
3337	Gets called by <link to="IConsole::deleteSnapshot"/>,
3338	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3339	<link to="IConsole::deleteSnapshotRange"/>.
3340	<result name="VBOX_E_INVALID_OBJECT_STATE">
3341	Snapshot has more than one child snapshot. Only possible if the
3342	delete operation does not delete all children or the range does
3343	not meet the linearity condition.
3344	</result>
3345	</desc>
3346	<param name="initiator" type="IConsole" dir="in">
3347	<desc>The console object that initiated this call.</desc>
3348	</param>
3349	<param name="startId" type="uuid" mod="string" dir="in">
3350	<desc>UUID of the first snapshot to delete.</desc>
3351	</param>
3352	<param name="endId" type="uuid" mod="string" dir="in">
3353	<desc>UUID of the last snapshot to delete.</desc>
3354	</param>
3355	<param name="deleteAllChildren" type="boolean" dir="in">
3356	<desc>Whether all children should be deleted.</desc>
3357	</param>
3358	<param name="machineState" type="MachineState" dir="out">
3359	<desc>New machine state after this operation is started.</desc>
3360	</param>
3361	<param name="progress" type="IProgress" dir="return">
3362	<desc>Progress object to track the operation completion.</desc>
3363	</param>
3364	</method>
3365
3366	<method name="finishOnlineMergeMedium">
3367	<desc>
3368	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3369	</desc>
3370	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3371	<desc>The medium attachment which needs to be cleaned up.</desc>
3372	</param>
3373	<param name="source" type="IMedium" dir="in">
3374	<desc>Merge source medium.</desc>
3375	</param>
3376	<param name="target" type="IMedium" dir="in">
3377	<desc>Merge target medium.</desc>
3378	</param>
3379	<param name="mergeForward" type="boolean" dir="in">
3380	<desc>Merge direction.</desc>
3381	</param>
3382	<param name="parentForTarget" type="IMedium" dir="in">
3383	<desc>For forward merges: new parent for target medium.</desc>
3384	</param>
3385	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3386	<desc>For backward merges: list of media which need their parent UUID
3387	updated.</desc>
3388	</param>
3389	</method>
3390
3391	<method name="restoreSnapshot">
3392	<desc>
3393	Gets called by <link to="IConsole::restoreSnapshot"/>.
3394	</desc>
3395	<param name="initiator" type="IConsole" dir="in">
3396	<desc>The console object that initiated this call.</desc>
3397	</param>
3398	<param name="snapshot" type="ISnapshot" dir="in">
3399	<desc>The snapshot to restore the VM state from.</desc>
3400	</param>
3401	<param name="machineState" type="MachineState" dir="out">
3402	<desc>New machine state after this operation is started.</desc>
3403	</param>
3404	<param name="progress" type="IProgress" dir="return">
3405	<desc>Progress object to track the operation completion.</desc>
3406	</param>
3407	</method>
3408
3409	<method name="pullGuestProperties">
3410	<desc>
3411	Get the list of the guest properties matching a set of patterns along
3412	with their values, time stamps and flags and give responsibility for
3413	managing properties to the console.
3414	</desc>
3415	<param name="name" type="wstring" dir="out" safearray="yes">
3416	<desc>
3417	The names of the properties returned.
3418	</desc>
3419	</param>
3420	<param name="value" type="wstring" dir="out" safearray="yes">
3421	<desc>
3422	The values of the properties returned. The array entries match the
3423	corresponding entries in the @a name array.
3424	</desc>
3425	</param>
3426	<param name="timestamp" type="long long" dir="out" safearray="yes">
3427	<desc>
3428	The time stamps of the properties returned. The array entries match
3429	the corresponding entries in the @a name array.
3430	</desc>
3431	</param>
3432	<param name="flags" type="wstring" dir="out" safearray="yes">
3433	<desc>
3434	The flags of the properties returned. The array entries match the
3435	corresponding entries in the @a name array.
3436	</desc>
3437	</param>
3438	</method>
3439
3440	<method name="pushGuestProperty">
3441	<desc>
3442	Update a single guest property in IMachine.
3443	</desc>
3444	<param name="name" type="wstring" dir="in">
3445	<desc>
3446	The name of the property to be updated.
3447	</desc>
3448	</param>
3449	<param name="value" type="wstring" dir="in">
3450	<desc>
3451	The value of the property.
3452	</desc>
3453	</param>
3454	<param name="timestamp" type="long long" dir="in">
3455	<desc>
3456	The timestamp of the property.
3457	</desc>
3458	</param>
3459	<param name="flags" type="wstring" dir="in">
3460	<desc>
3461	The flags of the property.
3462	</desc>
3463	</param>
3464	</method>
3465
3466	<method name="lockMedia">
3467	<desc>
3468	Locks all media attached to the machine for writing and parents of
3469	attached differencing media (if any) for reading. This operation is
3470	atomic so that if it fails no media is actually locked.
3471
3472	This method is intended to be called when the machine is in Starting or
3473	Restoring state. The locked media will be automatically unlocked when
3474	the machine is powered off or crashed.
3475	</desc>
3476	</method>
3477	<method name="unlockMedia">
3478	<desc>
3479	Unlocks all media previously locked using
3480	<link to="IInternalMachineControl::lockMedia"/>.
3481
3482	This method is intended to be used with teleportation so that it is
3483	possible to teleport between processes on the same machine.
3484	</desc>
3485	</method>
3486
3487	<method name="ejectMedium">
3488	<desc>
3489	Tells VBoxSVC that the guest has ejected the medium associated with
3490	the medium attachment.
3491	</desc>
3492	<param name="attachment" type="IMediumAttachment" dir="in">
3493	<desc>
3494	The medium attachment where the eject happened.
3495	</desc>
3496	</param>
3497	<param name="newAttachment" type="IMediumAttachment" dir="return">
3498	<desc>
3499	A new reference to the medium attachment, as the config change can
3500	result in the creation of a new instance.
3501	</desc>
3502	</param>
3503	</method>
3504
3505	<method name="reportVmStatistics">
3506	<desc>
3507	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3508	</desc>
3509	<param name="validStats" type="unsigned long" dir="in">
3510	<desc>
3511	Mask defining which parameters are valid. For example: 0x11 means
3512	that cpuIdle and XXX are valid. Other parameters should be ignored.
3513	</desc>
3514	</param>
3515	<param name="cpuUser" type="unsigned long" dir="in">
3516	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3517	</param>
3518	<param name="cpuKernel" type="unsigned long" dir="in">
3519	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3520	</param>
3521	<param name="cpuIdle" type="unsigned long" dir="in">
3522	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3523	</param>
3524	<param name="memTotal" type="unsigned long" dir="in">
3525	<desc>Total amount of physical guest RAM.</desc>
3526	</param>
3527	<param name="memFree" type="unsigned long" dir="in">
3528	<desc>Free amount of physical guest RAM.</desc>
3529	</param>
3530	<param name="memBalloon" type="unsigned long" dir="in">
3531	<desc>Amount of ballooned physical guest RAM.</desc>
3532	</param>
3533	<param name="memShared" type="unsigned long" dir="in">
3534	<desc>Amount of shared physical guest RAM.</desc>
3535	</param>
3536	<param name="memCache" type="unsigned long" dir="in">
3537	<desc>Total amount of guest (disk) cache memory.</desc>
3538	</param>
3539	<param name="pagedTotal" type="unsigned long" dir="in">
3540	<desc>Total amount of space in the page file.</desc>
3541	</param>
3542	<param name="memAllocTotal" type="unsigned long" dir="in">
3543	<desc>Total amount of memory allocated by the hypervisor.</desc>
3544	</param>
3545	<param name="memFreeTotal" type="unsigned long" dir="in">
3546	<desc>Total amount of free memory available in the hypervisor.</desc>
3547	</param>
3548	<param name="memBalloonTotal" type="unsigned long" dir="in">
3549	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3550	</param>
3551	<param name="memSharedTotal" type="unsigned long" dir="in">
3552	<desc>Total amount of shared memory in the hypervisor.</desc>
3553	</param>
3554	<param name="vmNetRx" type="unsigned long" dir="in">
3555	<desc>Network receive rate for VM.</desc>
3556	</param>
3557	<param name="vmNetTx" type="unsigned long" dir="in">
3558	<desc>Network transmit rate for VM.</desc>
3559	</param>
3560	</method>
3561	</interface>
3562
3563	<interface
3564	name="IBIOSSettings" extends="$unknown"
3565	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3566	wsmap="managed"
3567	>
3568	<desc>
3569	The IBIOSSettings interface represents BIOS settings of the virtual
3570	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3571	</desc>
3572	<attribute name="logoFadeIn" type="boolean">
3573	<desc>Fade in flag for BIOS logo animation.</desc>
3574	</attribute>
3575
3576	<attribute name="logoFadeOut" type="boolean">
3577	<desc>Fade out flag for BIOS logo animation.</desc>
3578	</attribute>
3579
3580	<attribute name="logoDisplayTime" type="unsigned long">
3581	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3582	</attribute>
3583
3584	<attribute name="logoImagePath" type="wstring">
3585	<desc>
3586	Local file system path for external BIOS splash image. Empty string
3587	means the default image is shown on boot.
3588	</desc>
3589	</attribute>
3590
3591	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3592	<desc>Mode of the BIOS boot device menu.</desc>
3593	</attribute>
3594
3595	<attribute name="ACPIEnabled" type="boolean">
3596	<desc>ACPI support flag.</desc>
3597	</attribute>
3598
3599	<attribute name="IOAPICEnabled" type="boolean">
3600	<desc>
3601	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3602	and support IRQs above 15.
3603	</desc>
3604	</attribute>
3605
3606	<attribute name="timeOffset" type="long long">
3607	<desc>
3608	Offset in milliseconds from the host system time. This allows for
3609	guests running with a different system date/time than the host.
3610	It is equivalent to setting the system date/time in the BIOS except
3611	it is not an absolute value but a relative one. Guest Additions
3612	time synchronization honors this offset.
3613	</desc>
3614	</attribute>
3615
3616	<attribute name="PXEDebugEnabled" type="boolean">
3617	<desc>
3618	PXE debug logging flag. If set, VirtualBox will write extensive
3619	PXE trace information to the release log.
3620	</desc>
3621	</attribute>
3622	</interface>
3623
3624	<enum
3625	name="CleanupMode"
3626	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3627	>
3628	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3629	</desc>
3630	<const name="UnregisterOnly" value="1">
3631	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3632	</const>
3633	<const name="DetachAllReturnNone" value="2">
3634	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3635	</const>
3636	<const name="DetachAllReturnHardDisksOnly" value="3">
3637	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3638	</const>
3639	<const name="Full" value="4">
3640	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3641	</const>
3642	</enum>
3643
3644	<interface
3645	name="IPCIAddress" extends="$unknown"
3646	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3647	wsmap="struct"
3648	>
3649
3650	<desc>
3651	Address on the PCI bus.
3652	</desc>
3653
3654	<attribute name="bus" type="short">
3655	<desc>
3656	Bus number.
3657	</desc>
3658	</attribute>
3659
3660	<attribute name="device" type="short">
3661	<desc>
3662	Device number.
3663	</desc>
3664	</attribute>
3665
3666	<attribute name="devFunction" type="short">
3667	<desc>
3668	Device function number.
3669	</desc>
3670	</attribute>
3671
3672	<method name="asLong">
3673	<desc>
3674	Convert PCI address into long.
3675	</desc>
3676	<param name="result" type="long" dir="return" />
3677	</method>
3678
3679	<method name="fromLong">
3680	<desc>
3681	Make PCI address from long.
3682	</desc>
3683	<param name="number" type="long" dir="in" />
3684	</method>
3685	</interface>
3686
3687	<interface
3688	name="IPCIDeviceAttachment" extends="$unknown"
3689	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3690	wsmap="struct"
3691	>
3692
3693	<desc>
3694	Information about PCI attachments.
3695	</desc>
3696
3697	<attribute name="name" type="wstring" readonly="yes">
3698	<desc>
3699	Device name.
3700	</desc>
3701	</attribute>
3702
3703	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3704	<desc>
3705	If this is physical or virtual device.
3706	</desc>
3707	</attribute>
3708
3709	<attribute name="hostAddress" type="long" readonly="yes">
3710	<desc>
3711	Address of device on the host, applicable only to host devices.
3712	</desc>
3713	</attribute>
3714
3715	<attribute name="guestAddress" type="long" readonly="yes">
3716	<desc>
3717	Address of device on the guest.
3718	</desc>
3719	</attribute>
3720
3721	</interface>
3722
3723	<enum
3724	name="CloneMode" extends="$unknown"
3725	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3726	>
3727
3728	<desc>
3729	Clone mode, used with <link to="IMachine::cloneTo" />.
3730	</desc>
3731
3732	<const name="MachineState" value="1">
3733	<desc>Clone the state of the selected machine.</desc>
3734	</const>
3735	<const name="MachineAndChildStates" value="2">
3736	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3737	</const>
3738	<const name="AllStates" value="3">
3739	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3740	</const>
3741
3742	</enum>
3743
3744	<enum
3745	name="CloneOptions" extends="$unknown"
3746	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3747	>
3748
3749	<desc>
3750	Clone options, used with <link to="IMachine::cloneTo" />.
3751	</desc>
3752
3753	<const name="Link" value="1">
3754	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3755	</const>
3756	<const name="KeepAllMACs" value="2">
3757	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3758	</const>
3759	<const name="KeepNATMACs" value="3">
3760	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3761	</const>
3762	<const name="KeepDiskNames" value="4">
3763	<desc>Don't change the disk names.</desc>
3764	</const>
3765
3766	</enum>
3767
3768	<enum
3769	name="AutostopType" extends="$unknown"
3770	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3771	>
3772
3773	<desc>
3774	Autostop types, used with <link to="IMachine::autostopType" />.
3775	</desc>
3776
3777	<const name="Disabled" value="1">
3778	<desc>Stopping the VM during system shutdown is disabled.</desc>
3779	</const>
3780	<const name="SaveState" value="2">
3781	<desc>The state of the VM will be saved when the system shuts down.</desc>
3782	</const>
3783	<const name="PowerOff" value="3">
3784	<desc>The VM is powered off when the system shuts down.</desc>
3785	</const>
3786	<const name="AcpiShutdown" value="4">
3787	<desc>An ACPI shutdown event is generated.</desc>
3788	</const>
3789
3790	</enum>
3791
3792
3793	<interface
3794	name="IMachine" extends="$unknown"
3795	uuid="22781af3-1c96-4126-9edf-67a020e0e858"
3796	wsmap="managed"
3797	>
3798	<desc>
3799	The IMachine interface represents a virtual machine, or guest, created
3800	in VirtualBox.
3801
3802	This interface is used in two contexts. First of all, a collection of
3803	objects implementing this interface is stored in the
3804	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3805	machines that are currently registered with this VirtualBox
3806	installation. Also, once a session has been opened for the given virtual
3807	machine (e.g. the virtual machine is running), the machine object
3808	associated with the open session can be queried from the session object;
3809	see <link to="ISession"/> for details.
3810
3811	The main role of this interface is to expose the settings of the virtual
3812	machine and provide methods to change various aspects of the virtual
3813	machine's configuration. For machine objects stored in the
3814	<link to="IVirtualBox::machines"/> collection, all attributes are
3815	read-only unless explicitly stated otherwise in individual attribute
3816	and method descriptions.
3817
3818	In order to change a machine setting, a session for this machine must be
3819	opened using one of the <link to="IMachine::lockMachine" /> or
3820	<link to="IMachine::launchVMProcess"/> methods. After the
3821	machine has been successfully locked for a session, a mutable machine object
3822	needs to be queried from the session object and then the desired settings
3823	changes can be applied to the returned object using IMachine attributes and
3824	methods. See the <link to="ISession"/> interface description for more
3825	information about sessions.
3826
3827	Note that IMachine does not provide methods to control virtual machine
3828	execution (such as start the machine, or power it down) -- these methods
3829	are grouped in a separate interface called <link to="IConsole" />.
3830
3831	<see><link to="ISession"/>, <link to="IConsole"/></see>
3832	</desc>
3833
3834	<attribute name="parent" type="IVirtualBox" readonly="yes">
3835	<desc>Associated parent object.</desc>
3836	</attribute>
3837
3838	<attribute name="accessible" type="boolean" readonly="yes">
3839	<desc>
3840	Whether this virtual machine is currently accessible or not.
3841
3842	A machine is always deemed accessible unless it is registered <i>and</i>
3843	its settings file cannot be read or parsed (either because the file itself
3844	is unavailable or has invalid XML contents).
3845
3846	Every time this property is read, the accessibility state of
3847	this machine is re-evaluated. If the returned value is @c false,
3848	the <link to="#accessError"/> property may be used to get the
3849	detailed error information describing the reason of
3850	inaccessibility, including XML error messages.
3851
3852	When the machine is inaccessible, only the following properties
3853	can be used on it:
3854	<ul>
3855	<li><link to="#parent"/></li>
3856	<li><link to="#id"/></li>
3857	<li><link to="#settingsFilePath"/></li>
3858	<li><link to="#accessible"/></li>
3859	<li><link to="#accessError"/></li>
3860	</ul>
3861
3862	An attempt to access any other property or method will return
3863	an error.
3864
3865	The only possible action you can perform on an inaccessible
3866	machine is to unregister it using the
3867	<link to="IMachine::unregister"/> call (or, to check
3868	for the accessibility state once more by querying this
3869	property).
3870
3871	<note>
3872	In the current implementation, once this property returns
3873	@c true, the machine will never become inaccessible
3874	later, even if its settings file cannot be successfully
3875	read/written any more (at least, until the VirtualBox
3876	server is restarted). This limitation may be removed in
3877	future releases.
3878	</note>
3879	</desc>
3880	</attribute>
3881
3882	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3883	<desc>
3884	Error information describing the reason of machine
3885	inaccessibility.
3886
3887	Reading this property is only valid after the last call to
3888	<link to="#accessible"/> returned @c false (i.e. the
3889	machine is currently inaccessible). Otherwise, a @c null
3890	IVirtualBoxErrorInfo object will be returned.
3891	</desc>
3892	</attribute>
3893
3894	<attribute name="name" type="wstring">
3895	<desc>
3896	Name of the virtual machine.
3897
3898	Besides being used for human-readable identification purposes
3899	everywhere in VirtualBox, the virtual machine name is also used
3900	as a name of the machine's settings file and as a name of the
3901	subdirectory this settings file resides in. Thus, every time you
3902	change the value of this property, the settings file will be
3903	renamed once you call <link to="#saveSettings"/> to confirm the
3904	change. The containing subdirectory will be also renamed, but
3905	only if it has exactly the same name as the settings file
3906	itself prior to changing this property (for backward compatibility
3907	with previous API releases). The above implies the following
3908	limitations:
3909	<ul>
3910	<li>The machine name cannot be empty.</li>
3911	<li>The machine name can contain only characters that are valid
3912	file name characters according to the rules of the file
3913	system used to store VirtualBox configuration.</li>
3914	<li>You cannot have two or more machines with the same name
3915	if they use the same subdirectory for storing the machine
3916	settings files.</li>
3917	<li>You cannot change the name of the machine if it is running,
3918	or if any file in the directory containing the settings file
3919	is being used by another running machine or by any other
3920	process in the host operating system at a time when
3921	<link to="#saveSettings"/> is called.
3922	</li>
3923	</ul>
3924	If any of the above limitations are hit, <link to="#saveSettings"/>
3925	will return an appropriate error message explaining the exact
3926	reason and the changes you made to this machine will not be saved.
3927
3928	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3929	file is recommended, but not enforced. (Previous versions always
3930	used a generic ".xml" extension.)
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="description" type="wstring">
3935	<desc>
3936	Description of the virtual machine.
3937
3938	The description attribute can contain any text and is
3939	typically used to describe the hardware and software
3940	configuration of the virtual machine in detail (i.e. network
3941	settings, versions of the installed software and so on).
3942	</desc>
3943	</attribute>
3944
3945	<attribute name="id" type="uuid" mod="string" readonly="yes">
3946	<desc>UUID of the virtual machine.</desc>
3947	</attribute>
3948
3949	<attribute name="groups" type="wstring" safearray="yes">
3950	<desc>
3951	Array of machine group names of which this machine is a member.
3952	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
3953	group is only listed once, however they are listed in no particular
3954	order and there is no guarantee that there are no gaps in the group
3955	hierarchy (i.e. <tt>"/group"</tt>,
3956	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
3957	</desc>
3958	</attribute>
3959
3960	<attribute name="OSTypeId" type="wstring">
3961	<desc>
3962	User-defined identifier of the Guest OS type.
3963	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3964	an IGuestOSType object representing details about the given
3965	Guest OS type.
3966	<note>
3967	This value may differ from the value returned by
3968	<link to="IGuest::OSTypeId"/> if Guest Additions are
3969	installed to the guest OS.
3970	</note>
3971	</desc>
3972	</attribute>
3973
3974	<attribute name="hardwareVersion" type="wstring">
3975	<desc>Hardware version identifier. Internal use only for now.</desc>
3976	</attribute>
3977
3978	<attribute name="hardwareUUID" type="uuid" mod="string">
3979	<desc>
3980	The UUID presented to the guest via memory tables, hardware and guest
3981	properties. For most VMs this is the same as the @a id, but for VMs
3982	which have been cloned or teleported it may be the same as the source
3983	VM. The latter is because the guest shouldn't notice that it was
3984	cloned or teleported.
3985	</desc>
3986	</attribute>
3987
3988	<attribute name="CPUCount" type="unsigned long">
3989	<desc>Number of virtual CPUs in the VM.</desc>
3990	</attribute>
3991
3992	<attribute name="CPUHotPlugEnabled" type="boolean">
3993	<desc>
3994	This setting determines whether VirtualBox allows CPU
3995	hotplugging for this machine.</desc>
3996	</attribute>
3997
3998	<attribute name="CPUExecutionCap" type="unsigned long">
3999	<desc>
4000	Means to limit the number of CPU cycles a guest can use. The unit
4001	is percentage of host CPU cycles per second. The valid range
4002	is 1 - 100. 100 (the default) implies no limit.
4003	</desc>
4004	</attribute>
4005
4006	<attribute name="memorySize" type="unsigned long">
4007	<desc>System memory size in megabytes.</desc>
4008	</attribute>
4009
4010	<attribute name="memoryBalloonSize" type="unsigned long">
4011	<desc>Memory balloon size in megabytes.</desc>
4012	</attribute>
4013
4014	<attribute name="pageFusionEnabled" type="boolean">
4015	<desc>
4016	This setting determines whether VirtualBox allows page
4017	fusion for this machine (64 bits host only).
4018	</desc>
4019	</attribute>
4020
4021	<attribute name="VRAMSize" type="unsigned long">
4022	<desc>Video memory size in megabytes.</desc>
4023	</attribute>
4024
4025	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4026	<desc>
4027	This setting determines whether VirtualBox allows this machine to make
4028	use of the 3D graphics support available on the host.</desc>
4029	</attribute>
4030
4031	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4032	<desc>
4033	This setting determines whether VirtualBox allows this machine to make
4034	use of the 2D video acceleration support available on the host.</desc>
4035	</attribute>
4036
4037	<attribute name="monitorCount" type="unsigned long">
4038	<desc>
4039	Number of virtual monitors.
4040	<note>
4041	Only effective on Windows XP and later guests with
4042	Guest Additions installed.
4043	</note>
4044	</desc>
4045	</attribute>
4046
4047	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4048	<desc>
4049	This setting determines whether VirtualBox uses video recording to
4050	record VM session.</desc>
4051	</attribute>
4052
4053	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4054	<desc>
4055	This setting determines what filename VirtualBox uses to save
4056	the recorded content.</desc>
4057	</attribute>
4058
4059	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4060	<desc>
4061	This setting determines what should be the horizontal resolution of
4062	recorded video.</desc>
4063	</attribute>
4064
4065	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4066	<desc>
4067	This setting determines what should be the vertical resolution
4068	of recorded video.</desc>
4069	</attribute>
4070
4071	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4072	<desc>Object containing all BIOS settings.</desc>
4073	</attribute>
4074
4075	<attribute name="firmwareType" type="FirmwareType">
4076	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4077	bootstrap in this VM.</desc>
4078	</attribute>
4079
4080	<attribute name="pointingHIDType" type="PointingHIDType">
4081	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4082	The default is typically "PS2Mouse" but can vary depending on the
4083	requirements of the guest operating system.</desc>
4084	</attribute>
4085
4086	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4087	<desc>Type of keyboard HID used in this VM.
4088	The default is typically "PS2Keyboard" but can vary depending on the
4089	requirements of the guest operating system.</desc>
4090	</attribute>
4091
4092	<attribute name="HPETEnabled" type="boolean">
4093	<desc>This attribute controls if High Precision Event Timer (HPET) is
4094	enabled in this VM. Use this property if you want to provide guests
4095	with additional time source, or if guest requires HPET to function correctly.
4096	Default is false.</desc>
4097	</attribute>
4098
4099	<attribute name="chipsetType" type="ChipsetType">
4100	<desc>Chipset type used in this VM.</desc>
4101	</attribute>
4102
4103	<attribute name="snapshotFolder" type="wstring">
4104	<desc>
4105	Full path to the directory used to store snapshot data
4106	(differencing media and saved state files) of this machine.
4107
4108	The initial value of this property is
4109	<tt><</tt><link to="#settingsFilePath">
4110	path_to_settings_file</link><tt>>/<</tt>
4111	<link to="#id">machine_uuid</link>
4112	<tt>></tt>.
4113
4114	Currently, it is an error to try to change this property on
4115	a machine that has snapshots (because this would require to
4116	move possibly large files to a different location).
4117	A separate method will be available for this purpose later.
4118
4119	<note>
4120	Setting this property to @c null or to an empty string will restore
4121	the initial value.
4122	</note>
4123	<note>
4124	When setting this property, the specified path can be
4125	absolute (full path) or relative to the directory where the
4126	<link to="#settingsFilePath">machine settings file</link>
4127	is located. When reading this property, a full path is
4128	always returned.
4129	</note>
4130	<note>
4131	The specified path may not exist, it will be created
4132	when necessary.
4133	</note>
4134	</desc>
4135	</attribute>
4136
4137	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4138	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4139	</attribute>
4140
4141	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4142	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4143
4144	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4145	<desc>Array of media attached to this machine.</desc>
4146	</attribute>
4147
4148	<attribute name="USBController" type="IUSBController" readonly="yes">
4149	<desc>
4150	Associated USB controller object.
4151
4152	<note>
4153	If USB functionality is not available in the given edition of
4154	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4155	</note>
4156	</desc>
4157	</attribute>
4158
4159	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4160	<desc>Associated audio adapter, always present.</desc>
4161	</attribute>
4162
4163	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4164	<desc>Array of storage controllers attached to this machine.</desc>
4165	</attribute>
4166
4167	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4168	<desc>
4169	Full name of the file containing machine settings data.
4170	</desc>
4171	</attribute>
4172
4173	<attribute name="settingsModified" type="boolean" readonly="yes">
4174	<desc>
4175	Whether the settings of this machine have been modified
4176	(but neither yet saved nor discarded).
4177	<note>
4178	Reading this property is only valid on instances returned
4179	by <link to="ISession::machine"/> and on new machines
4180	created by <link to="IVirtualBox::createMachine"/> or opened
4181	by <link to="IVirtualBox::openMachine"/> but not
4182	yet registered, or on unregistered machines after calling
4183	<link to="IMachine::unregister"/>. For all other
4184	cases, the settings can never be modified.
4185	</note>
4186	<note>
4187	For newly created unregistered machines, the value of this
4188	property is always @c true until <link to="#saveSettings"/>
4189	is called (no matter if any machine settings have been
4190	changed after the creation or not). For opened machines
4191	the value is set to @c false (and then follows to normal rules).
4192	</note>
4193	</desc>
4194	</attribute>
4195
4196	<attribute name="sessionState" type="SessionState" readonly="yes">
4197	<desc>Current session state for this machine.</desc>
4198	</attribute>
4199
4200	<attribute name="sessionType" type="wstring" readonly="yes">
4201	<desc>
4202	Type of the session. If <link to="#sessionState"/> is
4203	Spawning or Locked, this attribute contains the
4204	same value as passed to the
4205	<link to="IMachine::launchVMProcess"/> method in the
4206	@a type parameter. If the session was used with
4207	<link to="IMachine::lockMachine" />, or if
4208	<link to="#sessionState"/> is SessionClosed, the value of this
4209	attribute is an empty string.
4210	</desc>
4211	</attribute>
4212
4213	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4214	<desc>
4215	Identifier of the session process. This attribute contains the
4216	platform-dependent identifier of the process whose session was
4217	used with <link to="IMachine::lockMachine" /> call. The returned
4218	value is only valid if <link to="#sessionState"/> is Locked or
4219	Unlocking by the time this property is read.
4220	</desc>
4221	</attribute>
4222
4223	<attribute name="state" type="MachineState" readonly="yes">
4224	<desc>Current execution state of this machine.</desc>
4225	</attribute>
4226
4227	<attribute name="lastStateChange" type="long long" readonly="yes">
4228	<desc>
4229	Time stamp of the last execution state change,
4230	in milliseconds since 1970-01-01 UTC.
4231	</desc>
4232	</attribute>
4233
4234	<attribute name="stateFilePath" type="wstring" readonly="yes">
4235	<desc>
4236	Full path to the file that stores the execution state of
4237	the machine when it is in the <link to="MachineState_Saved"/> state.
4238	<note>
4239	When the machine is not in the Saved state, this attribute is
4240	an empty string.
4241	</note>
4242	</desc>
4243	</attribute>
4244
4245	<attribute name="logFolder" type="wstring" readonly="yes">
4246	<desc>
4247	Full path to the folder that stores a set of rotated log files
4248	recorded during machine execution. The most recent log file is
4249	named <tt>VBox.log</tt>, the previous log file is
4250	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4251	in the current version).
4252	</desc>
4253	</attribute>
4254
4255	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4256	<desc>
4257	Current snapshot of this machine. This is @c null if the machine
4258	currently has no snapshots. If it is not @c null, then it was
4259	set by one of <link to="IConsole::takeSnapshot" />,
4260	<link to="IConsole::deleteSnapshot" />
4261	or <link to="IConsole::restoreSnapshot" />, depending on which
4262	was called last. See <link to="ISnapshot"/> for details.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4267	<desc>
4268	Number of snapshots taken on this machine. Zero means the
4269	machine doesn't have any snapshots.
4270	</desc>
4271	</attribute>
4272
4273	<attribute name="currentStateModified" type="boolean" readonly="yes">
4274	<desc>
4275	Returns @c true if the current state of the machine is not
4276	identical to the state stored in the current snapshot.
4277
4278	The current state is identical to the current snapshot only
4279	directly after one of the following calls are made:
4280
4281	<ul>
4282	<li><link to="IConsole::restoreSnapshot"/>
4283	</li>
4284	<li><link to="IConsole::takeSnapshot"/> (issued on a
4285	"powered off" or "saved" machine, for which
4286	<link to="#settingsModified"/> returns @c false)
4287	</li>
4288	</ul>
4289
4290	The current state remains identical until one of the following
4291	happens:
4292	<ul>
4293	<li>settings of the machine are changed</li>
4294	<li>the saved state is deleted</li>
4295	<li>the current snapshot is deleted</li>
4296	<li>an attempt to execute the machine is made</li>
4297	</ul>
4298
4299	<note>
4300	For machines that don't have snapshots, this property is
4301	always @c false.
4302	</note>
4303	</desc>
4304	</attribute>
4305
4306	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4307	<desc>
4308	Collection of shared folders for this machine (permanent shared
4309	folders). These folders are shared automatically at machine startup
4310	and available only to the guest OS installed within this machine.
4311
4312	New shared folders are added to the collection using
4313	<link to="#createSharedFolder"/>. Existing shared folders can be
4314	removed using <link to="#removeSharedFolder"/>.
4315	</desc>
4316	</attribute>
4317
4318	<attribute name="clipboardMode" type="ClipboardMode">
4319	<desc>
4320	Synchronization mode between the host OS clipboard
4321	and the guest OS clipboard.
4322	</desc>
4323	</attribute>
4324
4325	<attribute name="dragAndDropMode" type="DragAndDropMode">
4326	<desc>
4327	Which mode is allowed for drag'n'drop.
4328	</desc>
4329	</attribute>
4330
4331	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4332	<desc>
4333	A comma-separated list of simple glob patterns. Changes to guest
4334	properties whose name matches one of the patterns will generate an
4335	<link to="IGuestPropertyChangedEvent"/> signal.
4336	</desc>
4337	</attribute>
4338
4339	<attribute name="teleporterEnabled" type="boolean">
4340	<desc>
4341	When set to @a true, the virtual machine becomes a target teleporter
4342	the next time it is powered on. This can only set to @a true when the
4343	VM is in the @a PoweredOff or @a Aborted state.
4344
4345	<!-- This property is automatically set to @a false when the VM is powered
4346	on. (bird: This doesn't work yet ) -->
4347	</desc>
4348	</attribute>
4349
4350	<attribute name="teleporterPort" type="unsigned long">
4351	<desc>
4352	The TCP port the target teleporter will listen for incoming
4353	teleportations on.
4354
4355	0 means the port is automatically selected upon power on. The actual
4356	value can be read from this property while the machine is waiting for
4357	incoming teleportations.
4358	</desc>
4359	</attribute>
4360
4361	<attribute name="teleporterAddress" type="wstring">
4362	<desc>
4363	The address the target teleporter will listen on. If set to an empty
4364	string, it will listen on all addresses.
4365	</desc>
4366	</attribute>
4367
4368	<attribute name="teleporterPassword" type="wstring">
4369	<desc>
4370	The password to check for on the target teleporter. This is just a
4371	very basic measure to prevent simple hacks and operators accidentally
4372	beaming a virtual machine to the wrong place.
4373
4374	Note that you SET a plain text password while reading back a HASHED
4375	password. Setting a hashed password is currently not supported.
4376	</desc>
4377	</attribute>
4378
4379	<attribute name="faultToleranceState" type="FaultToleranceState">
4380	<desc>
4381	Fault tolerance state; disabled, source or target.
4382	This property can be changed at any time. If you change it for a running
4383	VM, then the fault tolerance address and port must be set beforehand.
4384	</desc>
4385	</attribute>
4386
4387	<attribute name="faultTolerancePort" type="unsigned long">
4388	<desc>
4389	The TCP port the fault tolerance source or target will use for
4390	communication.
4391	</desc>
4392	</attribute>
4393
4394	<attribute name="faultToleranceAddress" type="wstring">
4395	<desc>
4396	The address the fault tolerance source or target.
4397	</desc>
4398	</attribute>
4399
4400	<attribute name="faultTolerancePassword" type="wstring">
4401	<desc>
4402	The password to check for on the standby VM. This is just a
4403	very basic measure to prevent simple hacks and operators accidentally
4404	choosing the wrong standby VM.
4405	</desc>
4406	</attribute>
4407
4408	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4409	<desc>
4410	The interval in ms used for syncing the state between source and target.
4411	</desc>
4412	</attribute>
4413
4414	<attribute name="RTCUseUTC" type="boolean">
4415	<desc>
4416	When set to @a true, the RTC device of the virtual machine will run
4417	in UTC time, otherwise in local time. Especially Unix guests prefer
4418	the time in UTC.
4419	</desc>
4420	</attribute>
4421
4422	<attribute name="IOCacheEnabled" type="boolean">
4423	<desc>
4424	When set to @a true, the builtin I/O cache of the virtual machine
4425	will be enabled.
4426	</desc>
4427	</attribute>
4428
4429	<attribute name="IOCacheSize" type="unsigned long">
4430	<desc>
4431	Maximum size of the I/O cache in MB.
4432	</desc>
4433	</attribute>
4434
4435	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4436	<desc>Array of PCI devices assigned to this machine, to get list of all
4437	PCI devices attached to the machine use
4438	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4439	is intended to list only devices additional to what described in
4440	virtual hardware config. Usually, this list keeps host's physical
4441	devices assigned to the particular machine.
4442	</desc>
4443	</attribute>
4444
4445	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4446	<desc>
4447	Bandwidth control manager.
4448	</desc>
4449	</attribute>
4450
4451	<attribute name="tracingEnabled" type="boolean">
4452	<desc>
4453	Enables the tracing facility in the VMM (including PDM devices +
4454	drivers). The VMM will consume about 0.5MB of more memory when
4455	enabled and there may be some extra overhead from tracepoints that are
4456	always enabled.
4457	</desc>
4458	</attribute>
4459
4460	<attribute name="tracingConfig" type="wstring">
4461	<desc>
4462	Tracepoint configuration to apply at startup when
4463	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4464	a space separated of tracepoint group names to enable. The special
4465	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4466	more details on available tracepoint groups and such.
4467
4468	Note that on hosts supporting DTrace (or similar), a lot of the
4469	tracepoints may be implemented exclusivly as DTrace probes. So, the
4470	effect of the same config may differ between Solaris and Windows for
4471	example.
4472	</desc>
4473	</attribute>
4474
4475	<attribute name="allowTracingToAccessVM" type="boolean">
4476	<desc>
4477	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4478	structures when firing off trace points. This is especially useful
4479	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4480	pointer to obtain useful information such as guest register state.
4481
4482	This is disabled by default because devices and drivers normally has no
4483	business accessing the VMCPU or VM structures, and are therefore unable
4484	to get any pointers to these.
4485	</desc>
4486	</attribute>
4487
4488	<attribute name="autostartEnabled" type="boolean">
4489	<desc>
4490	Enables autostart of the VM during system boot.
4491	</desc>
4492	</attribute>
4493
4494	<attribute name="autostartDelay" type="unsigned long">
4495	<desc>
4496	Number of seconds to wait until the VM should be started during system boot.
4497	</desc>
4498	</attribute>
4499
4500	<attribute name="autostopType" type="AutostopType">
4501	<desc>
4502	Action type to do when the system is shutting down.
4503	</desc>
4504	</attribute>
4505
4506	<method name="lockMachine">
4507	<desc>
4508	Locks the machine for the given session to enable the caller
4509	to make changes to the machine or start the VM or control
4510	VM execution.
4511
4512	There are two ways to lock a machine for such uses:
4513
4514	<ul>
4515	<li>If you want to make changes to the machine settings,
4516	you must obtain an exclusive write lock on the machine
4517	by setting @a lockType to @c Write.
4518
4519	This will only succeed if no other process has locked
4520	the machine to prevent conflicting changes. Only after
4521	an exclusive write lock has been obtained using this method, one
4522	can change all VM settings or execute the VM in the process
4523	space of the session object. (Note that the latter is only of
4524	interest if you actually want to write a new front-end for
4525	virtual machines; but this API gets called internally by
4526	the existing front-ends such as VBoxHeadless and the VirtualBox
4527	GUI to acquire a write lock on the machine that they are running.)
4528
4529	On success, write-locking the machine for a session creates
4530	a second copy of the IMachine object. It is this second object
4531	upon which changes can be made; in VirtualBox terminology, the
4532	second copy is "mutable". It is only this second, mutable machine
4533	object upon which you can call methods that change the
4534	machine state. After having called this method, you can
4535	obtain this second, mutable machine object using the
4536	<link to="ISession::machine" /> attribute.
4537	</li>
4538	<li>If you only want to check the machine state or control
4539	machine execution without actually changing machine
4540	settings (e.g. to get access to VM statistics or take
4541	a snapshot or save the machine state), then set the
4542	@a lockType argument to @c Shared.
4543
4544	If no other session has obtained a lock, you will obtain an
4545	exclusive write lock as described above. However, if another
4546	session has already obtained such a lock, then a link to that
4547	existing session will be established which allows you
4548	to control that existing session.
4549
4550	To find out which type of lock was obtained, you can
4551	inspect <link to="ISession::type" />, which will have been
4552	set to either @c WriteLock or @c Shared.
4553	</li>
4554	</ul>
4555
4556	In either case, you can get access to the <link to="IConsole" />
4557	object which controls VM execution.
4558
4559	Also in all of the above cases, one must always call
4560	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4561	the machine's state will eventually be set to "Aborted".
4562
4563	To change settings on a machine, the following sequence is typically
4564	performed:
4565
4566	<ol>
4567	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4568
4569	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4570
4571	<li>Change the settings of the machine by invoking IMachine methods.</li>
4572
4573	<li>Call <link to="IMachine::saveSettings" />.</li>
4574
4575	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4576	</ol>
4577
4578	<result name="E_UNEXPECTED">
4579	Virtual machine not registered.
4580	</result>
4581	<result name="E_ACCESSDENIED">
4582	Process not started by OpenRemoteSession.
4583	</result>
4584	<result name="VBOX_E_INVALID_OBJECT_STATE">
4585	Session already open or being opened.
4586	</result>
4587	<result name="VBOX_E_VM_ERROR">
4588	Failed to assign machine to session.
4589	</result>
4590	</desc>
4591	<param name="session" type="ISession" dir="in">
4592	<desc>
4593	Session object for which the machine will be locked.
4594	</desc>
4595	</param>
4596	<param name="lockType" type="LockType" dir="in">
4597	<desc>
4598	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4599	If set to @c Shared, then either acquire an exclusive write lock or establish
4600	a link to an existing session.
4601	</desc>
4602	</param>
4603	</method>
4604
4605	<method name="launchVMProcess">
4606	<desc>
4607	Spawns a new process that will execute the virtual machine and obtains a shared
4608	lock on the machine for the calling session.
4609
4610	If launching the VM succeeds, the new VM process will create its own session
4611	and write-lock the machine for it, preventing conflicting changes from other
4612	processes. If the machine is already locked (because it is already running or
4613	because another session has a write lock), launching the VM process will therefore
4614	fail. Reversely, future attempts to obtain a write lock will also fail while the
4615	machine is running.
4616
4617	The caller's session object remains separate from the session opened by the new
4618	VM process. It receives its own <link to="IConsole" /> object which can be used
4619	to control machine execution, but it cannot be used to change all VM settings
4620	which would be available after a <link to="#lockMachine" /> call.
4621
4622	The caller must eventually release the session's shared lock by calling
4623	<link to="ISession::unlockMachine" /> on the local session object once this call
4624	has returned. However, the session's state (see <link to="ISession::state" />)
4625	will not return to "Unlocked" until the remote session has also unlocked
4626	the machine (i.e. the machine has stopped running).
4627
4628	Launching a VM process can take some time (a new VM is started in a new process,
4629	for which memory and other resources need to be set up). Because of this,
4630	an <link to="IProgress" /> object is returned to allow the caller to wait
4631	for this asynchronous operation to be completed. Until then, the caller's
4632	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4633	and <link to="ISession::console" /> attributes cannot be accessed.
4634	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4635	similar calls to wait for completion. Completion is signalled when the VM
4636	is powered on. If launching the VM fails, error messages can be queried
4637	via the progress object, if available.
4638
4639	The progress object will have at least 2 sub-operations. The first
4640	operation covers the period up to the new VM process calls powerUp.
4641	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4642	progress object. Because <link to="IConsole::powerUp"/> may require
4643	some extra sub-operations, the <link to="IProgress::operationCount"/>
4644	may change at the completion of operation.
4645
4646	For details on the teleportation progress operation, see
4647	<link to="IConsole::powerUp"/>.
4648
4649	The @a environment argument is a string containing definitions of
4650	environment variables in the following format:
4651	<pre>
4652	NAME[=VALUE]\n
4653	NAME[=VALUE]\n
4654	...
4655	</pre>
4656	where <tt>\\n</tt> is the new line character. These environment
4657	variables will be appended to the environment of the VirtualBox server
4658	process. If an environment variable exists both in the server process
4659	and in this list, the value from this list takes precedence over the
4660	server's variable. If the value of the environment variable is
4661	omitted, this variable will be removed from the resulting environment.
4662	If the environment string is @c null or empty, the server environment
4663	is inherited by the started process as is.
4664
4665	<result name="E_UNEXPECTED">
4666	Virtual machine not registered.
4667	</result>
4668	<result name="E_INVALIDARG">
4669	Invalid session type @a type.
4670	</result>
4671	<result name="VBOX_E_OBJECT_NOT_FOUND">
4672	No machine matching @a machineId found.
4673	</result>
4674	<result name="VBOX_E_INVALID_OBJECT_STATE">
4675	Session already open or being opened.
4676	</result>
4677	<result name="VBOX_E_IPRT_ERROR">
4678	Launching process for machine failed.
4679	</result>
4680	<result name="VBOX_E_VM_ERROR">
4681	Failed to assign machine to session.
4682	</result>
4683	</desc>
4684	<param name="session" type="ISession" dir="in">
4685	<desc>
4686	Client session object to which the VM process will be connected (this
4687	must be in "Unlocked" state).
4688	</desc>
4689	</param>
4690	<param name="type" type="wstring" dir="in">
4691	<desc>
4692	Front-end to use for the new VM process. The following are currently supported:
4693	<ul>
4694	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4695	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4696	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4697	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4698	the currently running VM or session owner. In this case the
4699	@a session parameter may be @c null (if it is non-null it isn't
4700	used in any way), and the @a progress return value will be always
4701	@c null. The operation completes immediately.</li>
4702	</ul>
4703	</desc>
4704	</param>
4705	<param name="environment" type="wstring" dir="in">
4706	<desc>
4707	Environment to pass to the VM process.
4708	</desc>
4709	</param>
4710	<param name="progress" type="IProgress" dir="return">
4711	<desc>Progress object to track the operation completion.</desc>
4712	</param>
4713	</method>
4714
4715	<method name="setBootOrder">
4716	<desc>
4717	Puts the given device to the specified position in
4718	the boot order.
4719
4720	To indicate that no device is associated with the given position,
4721	<link to="DeviceType_Null"/> should be used.
4722
4723	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4724
4725	<result name="E_INVALIDARG">
4726	Boot @a position out of range.
4727	</result>
4728	<result name="E_NOTIMPL">
4729	Booting from USB @a device currently not supported.
4730	</result>
4731
4732	</desc>
4733	<param name="position" type="unsigned long" dir="in">
4734	<desc>
4735	Position in the boot order (@c 1 to the total number of
4736	devices the machine can boot from, as returned by
4737	<link to="ISystemProperties::maxBootPosition"/>).
4738	</desc>
4739	</param>
4740	<param name="device" type="DeviceType" dir="in">
4741	<desc>
4742	The type of the device used to boot at the given position.
4743	</desc>
4744	</param>
4745	</method>
4746
4747	<method name="getBootOrder" const="yes">
4748	<desc>
4749	Returns the device type that occupies the specified
4750	position in the boot order.
4751
4752	@todo [remove?]
4753	If the machine can have more than one device of the returned type
4754	(such as hard disks), then a separate method should be used to
4755	retrieve the individual device that occupies the given position.
4756
4757	If here are no devices at the given position, then
4758	<link to="DeviceType_Null"/> is returned.
4759
4760	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4761
4762	<result name="E_INVALIDARG">
4763	Boot @a position out of range.
4764	</result>
4765
4766	</desc>
4767	<param name="position" type="unsigned long" dir="in">
4768	<desc>
4769	Position in the boot order (@c 1 to the total number of
4770	devices the machine can boot from, as returned by
4771	<link to="ISystemProperties::maxBootPosition"/>).
4772	</desc>
4773	</param>
4774	<param name="device" type="DeviceType" dir="return">
4775	<desc>
4776	Device at the given position.
4777	</desc>
4778	</param>
4779	</method>
4780
4781	<method name="attachDevice">
4782	<desc>
4783	Attaches a device and optionally mounts a medium to the given storage
4784	controller (<link to="IStorageController" />, identified by @a name),
4785	at the indicated port and device.
4786
4787	This method is intended for managing storage devices in general while a
4788	machine is powered off. It can be used to attach and detach fixed
4789	and removable media. The following kind of media can be attached
4790	to a machine:
4791
4792	<ul>
4793	<li>For fixed and removable media, you can pass in a medium that was
4794	previously opened using <link to="IVirtualBox::openMedium" />.
4795	</li>
4796
4797	<li>Only for storage devices supporting removable media (such as
4798	DVDs and floppies), you can also specify a null pointer to
4799	indicate an empty drive or one of the medium objects listed
4800	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4801	arrays to indicate a host drive.
4802	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4803	to change the media while the machine is running.
4804	</li>
4805	</ul>
4806
4807	In a VM's default configuration of virtual machines, the secondary
4808	master of the IDE controller is used for a CD/DVD drive.
4809
4810	After calling this returns successfully, a new instance of
4811	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4812	attachments (see <link to="IMachine::mediumAttachments"/>).
4813
4814	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4815	information about attaching media.
4816
4817	The specified device slot must not have a device attached to it,
4818	or this method will fail.
4819
4820	<note>
4821	You cannot attach a device to a newly created machine until
4822	this machine's settings are saved to disk using
4823	<link to="#saveSettings"/>.
4824	</note>
4825	<note>
4826	If the medium is being attached indirectly, a new differencing medium
4827	will implicitly be created for it and attached instead. If the
4828	changes made to the machine settings (including this indirect
4829	attachment) are later cancelled using <link to="#discardSettings"/>,
4830	this implicitly created differencing medium will implicitly
4831	be deleted.
4832	</note>
4833
4834	<result name="E_INVALIDARG">
4835	SATA device, SATA port, IDE port or IDE slot out of range, or
4836	file or UUID not found.
4837	</result>
4838	<result name="VBOX_E_INVALID_OBJECT_STATE">
4839	Machine must be registered before media can be attached.
4840	</result>
4841	<result name="VBOX_E_INVALID_VM_STATE">
4842	Invalid machine state.
4843	</result>
4844	<result name="VBOX_E_OBJECT_IN_USE">
4845	A medium is already attached to this or another virtual machine.
4846	</result>
4847
4848	</desc>
4849	<param name="name" type="wstring" dir="in">
4850	<desc>Name of the storage controller to attach the device to.</desc>
4851	</param>
4852	<param name="controllerPort" type="long" dir="in">
4853	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4854	the primary controller and 1 specifies the secondary controller.
4855	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4856	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4857	</param>
4858	<param name="device" type="long" dir="in">
4859	<desc>Device slot in the given port to attach the device to. This is only
4860	relevant for IDE controllers, for which 0 specifies the master device and
4861	1 specifies the slave device. For all other controller types, this must
4862	be 0.</desc>
4863	</param>
4864	<param name="type" type="DeviceType" dir="in">
4865	<desc>Device type of the attached device. For media opened by
4866	<link to="IVirtualBox::openMedium" />, this must match the device type
4867	specified there.</desc>
4868	</param>
4869	<param name="medium" type="IMedium" dir="in">
4870	<desc>Medium to mount or @c null for an empty drive.</desc>
4871	</param>
4872	</method>
4873
4874	<method name="attachDeviceWithoutMedium">
4875	<desc>
4876	Attaches a device and optionally mounts a medium to the given storage
4877	controller (<link to="IStorageController" />, identified by @a name),
4878	at the indicated port and device.
4879
4880	This method is intended for managing storage devices in general while a
4881	machine is powered off. It can be used to attach and detach fixed
4882	and removable media. The following kind of media can be attached
4883	to a machine:
4884	<ul>
4885	<li>
4886	For fixed and removable media, you can pass in a medium that was
4887	previously opened using <link to="IVirtualBox::openMedium" />.
4888	</li>
4889
4890	<li>Only for storage devices supporting removable media (such as
4891	DVDs and floppies) with an empty drive or one of the medium objects listed
4892	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4893	arrays to indicate a host drive.
4894	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4895	to change the media while the machine is running.
4896	</li>
4897	</ul>
4898
4899	In a VM's default configuration of virtual machines, the secondary
4900	master of the IDE controller is used for a CD/DVD drive.
4901	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4902	attachments (see <link to="IMachine::mediumAttachments"/>).
4903
4904	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4905	information about attaching media.
4906
4907	The specified device slot must not have a device attached to it,
4908	or this method will fail.
4909	<note>
4910	You cannot attach a device to a newly created machine until
4911	this machine's settings are saved to disk using
4912	<link to="#saveSettings"/>.
4913	</note>
4914	<note>
4915	If the medium is being attached indirectly, a new differencing medium
4916	will implicitly be created for it and attached instead. If the
4917	changes made to the machine settings (including this indirect
4918	attachment) are later cancelled using <link to="#discardSettings"/>,
4919	this implicitly created differencing medium will implicitly
4920	be deleted.
4921	</note>
4922
4923	<result name="E_INVALIDARG">
4924	SATA device, SATA port, IDE port or IDE slot out of range, or
4925	file or UUID not found.
4926	</result>
4927	<result name="VBOX_E_INVALID_OBJECT_STATE">
4928	Machine must be registered before media can be attached.
4929	</result>
4930	<result name="VBOX_E_INVALID_VM_STATE">
4931	Invalid machine state.
4932	</result>
4933	<result name="VBOX_E_OBJECT_IN_USE">
4934	A medium is already attached to this or another virtual machine.
4935	</result>
4936	</desc>
4937	<param name="name" type="wstring" dir="in">
4938	<desc>Name of the storage controller to attach the device to.</desc>
4939	</param>
4940	<param name="controllerPort" type="long" dir="in">
4941	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4942	the primary controller and 1 specifies the secondary controller.
4943	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4944	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4945	</param>
4946	<param name="device" type="long" dir="in">
4947	<desc>Device slot in the given port to attach the device to. This is only
4948	relevant for IDE controllers, for which 0 specifies the master device and
4949	1 specifies the slave device. For all other controller types, this must
4950	be 0.</desc>
4951	</param>
4952	<param name="type" type="DeviceType" dir="in">
4953	<desc>Device type of the attached device. For media opened by
4954	<link to="IVirtualBox::openMedium" />, this must match the device type
4955	specified there.</desc>
4956	</param>
4957	</method>
4958
4959	<method name="detachDevice">
4960	<desc>
4961	Detaches the device attached to a device slot of the specified bus.
4962
4963	Detaching the device from the virtual machine is deferred. This means
4964	that the medium remains associated with the machine when this method
4965	returns and gets actually de-associated only after a successful
4966	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4967	for more detailed information about attaching media.
4968
4969	<note>
4970	You cannot detach a device from a running machine.
4971	</note>
4972	<note>
4973	Detaching differencing media implicitly created by <link
4974	to="#attachDevice"/> for the indirect attachment using this
4975	method will <b>not</b> implicitly delete them. The
4976	<link to="IMedium::deleteStorage"/> operation should be
4977	explicitly performed by the caller after the medium is successfully
4978	detached and the settings are saved with
4979	<link to="#saveSettings"/>, if it is the desired action.
4980	</note>
4981
4982	<result name="VBOX_E_INVALID_VM_STATE">
4983	Attempt to detach medium from a running virtual machine.
4984	</result>
4985	<result name="VBOX_E_OBJECT_NOT_FOUND">
4986	No medium attached to given slot/bus.
4987	</result>
4988	<result name="VBOX_E_NOT_SUPPORTED">
4989	Medium format does not support storage deletion (only for implicitly
4990	created differencing media, should not happen).
4991	</result>
4992
4993	</desc>
4994	<param name="name" type="wstring" dir="in">
4995	<desc>Name of the storage controller to detach the medium from.</desc>
4996	</param>
4997	<param name="controllerPort" type="long" dir="in">
4998	<desc>Port number to detach the medium from.</desc>
4999	</param>
5000	<param name="device" type="long" dir="in">
5001	<desc>Device slot number to detach the medium from.</desc>
5002	</param>
5003	</method>
5004
5005	<method name="passthroughDevice">
5006	<desc>
5007	Sets the passthrough mode of an existing DVD device. Changing the
5008	setting while the VM is running is forbidden. The setting is only used
5009	if at VM start the device is configured as a host DVD drive, in all
5010	other cases it is ignored. The device must already exist; see
5011	<link to="IMachine::attachDevice"/> for how to attach a new device.
5012
5013	The @a controllerPort and @a device parameters specify the device slot and
5014	have have the same meaning as with <link to="IMachine::attachDevice" />.
5015
5016	<result name="E_INVALIDARG">
5017	SATA device, SATA port, IDE port or IDE slot out of range.
5018	</result>
5019	<result name="VBOX_E_INVALID_OBJECT_STATE">
5020	Attempt to modify an unregistered virtual machine.
5021	</result>
5022	<result name="VBOX_E_INVALID_VM_STATE">
5023	Invalid machine state.
5024	</result>
5025
5026	</desc>
5027	<param name="name" type="wstring" dir="in">
5028	<desc>Name of the storage controller.</desc>
5029	</param>
5030	<param name="controllerPort" type="long" dir="in">
5031	<desc>Storage controller port.</desc>
5032	</param>
5033	<param name="device" type="long" dir="in">
5034	<desc>Device slot in the given port.</desc>
5035	</param>
5036	<param name="passthrough" type="boolean" dir="in">
5037	<desc>New value for the passthrough setting.</desc>
5038	</param>
5039	</method>
5040
5041	<method name="temporaryEjectDevice">
5042	<desc>
5043	Sets the behavior for guest-triggered medium eject. In some situations
5044	it is desirable that such ejects update the VM configuration, and in
5045	others the eject should keep the VM configuration. The device must
5046	already exist; see <link to="IMachine::attachDevice"/> for how to
5047	attach a new device.
5048
5049	The @a controllerPort and @a device parameters specify the device slot and
5050	have have the same meaning as with <link to="IMachine::attachDevice" />.
5051
5052	<result name="E_INVALIDARG">
5053	SATA device, SATA port, IDE port or IDE slot out of range.
5054	</result>
5055	<result name="VBOX_E_INVALID_OBJECT_STATE">
5056	Attempt to modify an unregistered virtual machine.
5057	</result>
5058	<result name="VBOX_E_INVALID_VM_STATE">
5059	Invalid machine state.
5060	</result>
5061
5062	</desc>
5063	<param name="name" type="wstring" dir="in">
5064	<desc>Name of the storage controller.</desc>
5065	</param>
5066	<param name="controllerPort" type="long" dir="in">
5067	<desc>Storage controller port.</desc>
5068	</param>
5069	<param name="device" type="long" dir="in">
5070	<desc>Device slot in the given port.</desc>
5071	</param>
5072	<param name="temporaryEject" type="boolean" dir="in">
5073	<desc>New value for the eject behavior.</desc>
5074	</param>
5075	</method>
5076
5077	<method name="nonRotationalDevice">
5078	<desc>
5079	Sets a flag in the device information which indicates that the medium
5080	is not based on rotational technology, i.e. that the access times are
5081	more or less independent of the position on the medium. This may or may
5082	not be supported by a particular drive, and is silently ignored in the
5083	latter case. At the moment only hard disks (which is a misnomer in this
5084	context) accept this setting. Changing the setting while the VM is
5085	running is forbidden. The device must already exist; see
5086	<link to="IMachine::attachDevice"/> for how to attach a new device.
5087
5088	The @a controllerPort and @a device parameters specify the device slot and
5089	have have the same meaning as with <link to="IMachine::attachDevice" />.
5090
5091	<result name="E_INVALIDARG">
5092	SATA device, SATA port, IDE port or IDE slot out of range.
5093	</result>
5094	<result name="VBOX_E_INVALID_OBJECT_STATE">
5095	Attempt to modify an unregistered virtual machine.
5096	</result>
5097	<result name="VBOX_E_INVALID_VM_STATE">
5098	Invalid machine state.
5099	</result>
5100
5101	</desc>
5102	<param name="name" type="wstring" dir="in">
5103	<desc>Name of the storage controller.</desc>
5104	</param>
5105	<param name="controllerPort" type="long" dir="in">
5106	<desc>Storage controller port.</desc>
5107	</param>
5108	<param name="device" type="long" dir="in">
5109	<desc>Device slot in the given port.</desc>
5110	</param>
5111	<param name="nonRotational" type="boolean" dir="in">
5112	<desc>New value for the non-rotational device flag.</desc>
5113	</param>
5114	</method>
5115
5116	<method name="setAutoDiscardForDevice">
5117	<desc>
5118	Sets a flag in the device information which indicates that the medium
5119	supports discarding unsused blocks (called trimming for SATA or unmap
5120	for SCSI devices) .This may or may not be supported by a particular drive,
5121	and is silently ignored in the latter case. At the moment only hard disks
5122	(which is a misnomer in this context) accept this setting. Changing the
5123	setting while the VM is running is forbidden. The device must already
5124	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5125	device.
5126
5127	The @a controllerPort and @a device parameters specify the device slot and
5128	have have the same meaning as with <link to="IMachine::attachDevice" />.
5129
5130	<result name="E_INVALIDARG">
5131	SATA device, SATA port, SCSI port out of range.
5132	</result>
5133	<result name="VBOX_E_INVALID_OBJECT_STATE">
5134	Attempt to modify an unregistered virtual machine.
5135	</result>
5136	<result name="VBOX_E_INVALID_VM_STATE">
5137	Invalid machine state.
5138	</result>
5139
5140	</desc>
5141	<param name="name" type="wstring" dir="in">
5142	<desc>Name of the storage controller.</desc>
5143	</param>
5144	<param name="controllerPort" type="long" dir="in">
5145	<desc>Storage controller port.</desc>
5146	</param>
5147	<param name="device" type="long" dir="in">
5148	<desc>Device slot in the given port.</desc>
5149	</param>
5150	<param name="discard" type="boolean" dir="in">
5151	<desc>New value for the discard device flag.</desc>
5152	</param>
5153	</method>
5154
5155	<method name="setBandwidthGroupForDevice">
5156	<desc>
5157	Sets the bandwidth group of an existing storage device.
5158	The device must already exist; see <link to="IMachine::attachDevice"/>
5159	for how to attach a new device.
5160
5161	The @a controllerPort and @a device parameters specify the device slot and
5162	have have the same meaning as with <link to="IMachine::attachDevice" />.
5163
5164	<result name="E_INVALIDARG">
5165	SATA device, SATA port, IDE port or IDE slot out of range.
5166	</result>
5167	<result name="VBOX_E_INVALID_OBJECT_STATE">
5168	Attempt to modify an unregistered virtual machine.
5169	</result>
5170	<result name="VBOX_E_INVALID_VM_STATE">
5171	Invalid machine state.
5172	</result>
5173
5174	</desc>
5175	<param name="name" type="wstring" dir="in">
5176	<desc>Name of the storage controller.</desc>
5177	</param>
5178	<param name="controllerPort" type="long" dir="in">
5179	<desc>Storage controller port.</desc>
5180	</param>
5181	<param name="device" type="long" dir="in">
5182	<desc>Device slot in the given port.</desc>
5183	</param>
5184	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5185	<desc>New value for the bandwidth group or @c null for no group.</desc>
5186	</param>
5187	</method>
5188
5189	<method name="setNoBandwidthGroupForDevice">
5190	<desc>
5191	Sets no bandwidth group for an existing storage device.
5192	The device must already exist; see <link to="IMachine::attachDevice"/>
5193	for how to attach a new device.
5194	The @a controllerPort and @a device parameters specify the device slot and
5195	have have the same meaning as with <link to="IMachine::attachDevice" />.
5196	<result name="E_INVALIDARG">
5197	SATA device, SATA port, IDE port or IDE slot out of range.
5198	</result>
5199	<result name="VBOX_E_INVALID_OBJECT_STATE">
5200	Attempt to modify an unregistered virtual machine.
5201	</result>
5202	<result name="VBOX_E_INVALID_VM_STATE">
5203	Invalid machine state.
5204	</result>
5205
5206	</desc>
5207	<param name="name" type="wstring" dir="in">
5208	<desc>Name of the storage controller.</desc>
5209	</param>
5210	<param name="controllerPort" type="long" dir="in">
5211	<desc>Storage controller port.</desc>
5212	</param>
5213	<param name="device" type="long" dir="in">
5214	<desc>Device slot in the given port.</desc>
5215	</param>
5216	</method>
5217
5218
5219	<method name="unmountMedium">
5220	<desc>
5221	Unmounts any currently mounted medium (<link to="IMedium" />,
5222	identified by the given UUID @a id) to the given storage controller
5223	(<link to="IStorageController" />, identified by @a name),
5224	at the indicated port and device. The device must already exist;
5225
5226	This method is intended only for managing removable media, where the
5227	device is fixed but media is changeable at runtime (such as DVDs
5228	and floppies). It cannot be used for fixed media such as hard disks.
5229
5230	The @a controllerPort and @a device parameters specify the device slot
5231	and have have the same meaning as with
5232	<link to="IMachine::attachDevice" />.
5233
5234	The specified device slot must have a medium mounted, which will be
5235	unmounted. If there is no mounted medium it will do nothing.
5236	See <link to="IMedium"/> for more detailed information about
5237	attaching/unmounting media.
5238
5239	<result name="E_INVALIDARG">
5240	SATA device, SATA port, IDE port or IDE slot out of range.
5241	</result>
5242	<result name="VBOX_E_INVALID_OBJECT_STATE">
5243	Attempt to unmount medium that is not removeable - not dvd or floppy.
5244	</result>
5245	<result name="VBOX_E_INVALID_VM_STATE">
5246	Invalid machine state.
5247	</result>
5248	<result name="VBOX_E_OBJECT_IN_USE">
5249	Medium already attached to this or another virtual machine.
5250	</result>
5251	<result name="VBOX_E_OBJECT_NOT_FOUND">
5252	Medium not attached to specified port, device, controller.
5253	</result>
5254
5255	</desc>
5256	<param name="name" type="wstring" dir="in">
5257	<desc>Name of the storage controller to unmount the medium from.</desc>
5258	</param>
5259	<param name="controllerPort" type="long" dir="in">
5260	<desc>Port to unmount the medium from.</desc>
5261	</param>
5262	<param name="device" type="long" dir="in">
5263	<desc>Device slot in the given port to unmount the medium from.</desc>
5264	</param>
5265	<param name="force" type="boolean" dir="in">
5266	<desc>Allows to force unmount of a medium which is locked by
5267	the device slot in the given port medium is attached to.</desc>
5268	</param>
5269	</method>
5270
5271	<method name="mountMedium">
5272	<desc>
5273	Mounts a medium (<link to="IMedium" />, identified
5274	by the given UUID @a id) to the given storage controller
5275	(<link to="IStorageController" />, identified by @a name),
5276	at the indicated port and device. The device must already exist;
5277	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5278
5279	This method is intended only for managing removable media, where the
5280	device is fixed but media is changeable at runtime (such as DVDs
5281	and floppies). It cannot be used for fixed media such as hard disks.
5282
5283	The @a controllerPort and @a device parameters specify the device slot and
5284	have have the same meaning as with <link to="IMachine::attachDevice" />.
5285
5286	The specified device slot can have a medium mounted, which will be
5287	unmounted first. Specifying a zero UUID (or an empty string) for
5288	@a medium does just an unmount.
5289
5290	See <link to="IMedium"/> for more detailed information about
5291	attaching media.
5292
5293	<result name="E_INVALIDARG">
5294	SATA device, SATA port, IDE port or IDE slot out of range.
5295	</result>
5296	<result name="VBOX_E_INVALID_OBJECT_STATE">
5297	Attempt to attach medium to an unregistered virtual machine.
5298	</result>
5299	<result name="VBOX_E_INVALID_VM_STATE">
5300	Invalid machine state.
5301	</result>
5302	<result name="VBOX_E_OBJECT_IN_USE">
5303	Medium already attached to this or another virtual machine.
5304	</result>
5305
5306	</desc>
5307	<param name="name" type="wstring" dir="in">
5308	<desc>Name of the storage controller to attach the medium to.</desc>
5309	</param>
5310	<param name="controllerPort" type="long" dir="in">
5311	<desc>Port to attach the medium to.</desc>
5312	</param>
5313	<param name="device" type="long" dir="in">
5314	<desc>Device slot in the given port to attach the medium to.</desc>
5315	</param>
5316	<param name="medium" type="IMedium" dir="in">
5317	<desc>Medium to mount or @c null for an empty drive.</desc>
5318	</param>
5319	<param name="force" type="boolean" dir="in">
5320	<desc>Allows to force unmount/mount of a medium which is locked by
5321	the device slot in the given port to attach the medium to.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="getMedium" const="yes">
5326	<desc>
5327	Returns the virtual medium attached to a device slot of the specified
5328	bus.
5329
5330	Note that if the medium was indirectly attached by
5331	<link to="#mountMedium"/> to the given device slot then this
5332	method will return not the same object as passed to the
5333	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5334	more detailed information about mounting a medium.
5335
5336	<result name="VBOX_E_OBJECT_NOT_FOUND">
5337	No medium attached to given slot/bus.
5338	</result>
5339
5340	</desc>
5341	<param name="name" type="wstring" dir="in">
5342	<desc>Name of the storage controller the medium is attached to.</desc>
5343	</param>
5344	<param name="controllerPort" type="long" dir="in">
5345	<desc>Port to query.</desc>
5346	</param>
5347	<param name="device" type="long" dir="in">
5348	<desc>Device slot in the given port to query.</desc>
5349	</param>
5350	<param name="medium" type="IMedium" dir="return">
5351	<desc>Attached medium object.</desc>
5352	</param>
5353	</method>
5354
5355	<method name="getMediumAttachmentsOfController" const="yes">
5356	<desc>
5357	Returns an array of medium attachments which are attached to the
5358	the controller with the given name.
5359
5360	<result name="VBOX_E_OBJECT_NOT_FOUND">
5361	A storage controller with given name doesn't exist.
5362	</result>
5363	</desc>
5364	<param name="name" type="wstring" dir="in"/>
5365	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5366	</method>
5367
5368	<method name="getMediumAttachment" const="yes">
5369	<desc>
5370	Returns a medium attachment which corresponds to the controller with
5371	the given name, on the given port and device slot.
5372
5373	<result name="VBOX_E_OBJECT_NOT_FOUND">
5374	No attachment exists for the given controller/port/device combination.
5375	</result>
5376	</desc>
5377	<param name="name" type="wstring" dir="in"/>
5378	<param name="controllerPort" type="long" dir="in"/>
5379	<param name="device" type="long" dir="in"/>
5380	<param name="attachment" type="IMediumAttachment" dir="return"/>
5381	</method>
5382
5383	<method name="attachHostPCIDevice">
5384	<desc>
5385	Attaches host PCI device with the given (host) PCI address to the
5386	PCI bus of the virtual machine. Please note, that this operation
5387	is two phase, as real attachment will happen when VM will start,
5388	and most information will be delivered as IHostPCIDevicePlugEvent
5389	on IVirtualBox event source.
5390
5391	<see><link to="IHostPCIDevicePlugEvent"/></see>
5392
5393	<result name="VBOX_E_INVALID_VM_STATE">
5394	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5395	</result>
5396	<result name="VBOX_E_PDM_ERROR">
5397	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5398	</result>
5399	<result name="VBOX_E_NOT_SUPPORTED">
5400	Hardware or host OS doesn't allow PCI device passthrought.
5401	</result>
5402	</desc>
5403	<param name="hostAddress" type="long" dir="in">
5404	<desc>Address of the host PCI device.</desc>
5405	</param>
5406	<param name="desiredGuestAddress" type="long" dir="in">
5407	<desc>Desired position of this device on guest PCI bus.</desc>
5408	</param>
5409	<param name="tryToUnbind" type="boolean" dir="in">
5410	<desc>If VMM shall try to unbind existing drivers from the
5411	device before attaching it to the guest.</desc>
5412	</param>
5413	</method>
5414
5415	<method name="detachHostPCIDevice">
5416	<desc>
5417	Detach host PCI device from the virtual machine.
5418	Also HostPCIDevicePlugEvent on IVirtualBox event source
5419	will be delivered. As currently we don't support hot device
5420	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5421
5422	<see><link to="IHostPCIDevicePlugEvent"/></see>
5423
5424	<result name="VBOX_E_INVALID_VM_STATE">
5425	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5426	</result>
5427	<result name="VBOX_E_OBJECT_NOT_FOUND">
5428	This host device is not attached to this machine.
5429	</result>
5430	<result name="VBOX_E_PDM_ERROR">
5431	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5432	</result>
5433	<result name="VBOX_E_NOT_SUPPORTED">
5434	Hardware or host OS doesn't allow PCI device passthrought.
5435	</result>
5436	</desc>
5437	<param name="hostAddress" type="long" dir="in">
5438	<desc>Address of the host PCI device.</desc>
5439	</param>
5440	</method>
5441
5442	<method name="getNetworkAdapter" const="yes">
5443	<desc>
5444	Returns the network adapter associated with the given slot.
5445	Slots are numbered sequentially, starting with zero. The total
5446	number of adapters per machine is defined by the
5447	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5448	so the maximum slot number is one less than that property's value.
5449
5450	<result name="E_INVALIDARG">
5451	Invalid @a slot number.
5452	</result>
5453
5454	</desc>
5455	<param name="slot" type="unsigned long" dir="in"/>
5456	<param name="adapter" type="INetworkAdapter" dir="return"/>
5457	</method>
5458
5459	<method name="addStorageController">
5460	<desc>
5461	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5462	machine and returns it as an instance of
5463	<link to="IStorageController" />.
5464
5465	@a name identifies the controller for subsequent calls such as
5466	<link to="#getStorageControllerByName" />,
5467	<link to="#getStorageControllerByInstance" />,
5468	<link to="#removeStorageController" />,
5469	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5470
5471	After the controller has been added, you can set its exact
5472	type by setting the <link to="IStorageController::controllerType" />.
5473
5474	<result name="VBOX_E_OBJECT_IN_USE">
5475	A storage controller with given name exists already.
5476	</result>
5477	<result name="E_INVALIDARG">
5478	Invalid @a controllerType.
5479	</result>
5480	</desc>
5481	<param name="name" type="wstring" dir="in"/>
5482	<param name="connectionType" type="StorageBus" dir="in"/>
5483	<param name="controller" type="IStorageController" dir="return"/>
5484	</method>
5485
5486	<method name="getStorageControllerByName" const="yes">
5487	<desc>
5488	Returns a storage controller with the given name.
5489
5490	<result name="VBOX_E_OBJECT_NOT_FOUND">
5491	A storage controller with given name doesn't exist.
5492	</result>
5493	</desc>
5494	<param name="name" type="wstring" dir="in"/>
5495	<param name="storageController" type="IStorageController" dir="return"/>
5496	</method>
5497
5498	<method name="getStorageControllerByInstance" const="yes">
5499	<desc>
5500	Returns a storage controller with the given instance number.
5501
5502	<result name="VBOX_E_OBJECT_NOT_FOUND">
5503	A storage controller with given instance number doesn't exist.
5504	</result>
5505	</desc>
5506	<param name="instance" type="unsigned long" dir="in"/>
5507	<param name="storageController" type="IStorageController" dir="return"/>
5508	</method>
5509
5510	<method name="removeStorageController">
5511	<desc>
5512	Removes a storage controller from the machine with all devices attached to it.
5513
5514	<result name="VBOX_E_OBJECT_NOT_FOUND">
5515	A storage controller with given name doesn't exist.
5516	</result>
5517	<result name="VBOX_E_NOT_SUPPORTED">
5518	Medium format does not support storage deletion (only for implicitly
5519	created differencing media, should not happen).
5520	</result>
5521	</desc>
5522	<param name="name" type="wstring" dir="in"/>
5523	</method>
5524
5525	<method name="setStorageControllerBootable">
5526	<desc>
5527	Sets the bootable flag of the storage controller with the given name.
5528
5529	<result name="VBOX_E_OBJECT_NOT_FOUND">
5530	A storage controller with given name doesn't exist.
5531	</result>
5532	<result name="VBOX_E_OBJECT_IN_USE">
5533	Another storage controller is marked as bootable already.
5534	</result>
5535	</desc>
5536	<param name="name" type="wstring" dir="in"/>
5537	<param name="bootable" type="boolean" dir="in"/>
5538	</method>
5539
5540	<method name="getSerialPort" const="yes">
5541	<desc>
5542	Returns the serial port associated with the given slot.
5543	Slots are numbered sequentially, starting with zero. The total
5544	number of serial ports per machine is defined by the
5545	<link to="ISystemProperties::serialPortCount"/> property,
5546	so the maximum slot number is one less than that property's value.
5547
5548	<result name="E_INVALIDARG">
5549	Invalid @a slot number.
5550	</result>
5551
5552	</desc>
5553	<param name="slot" type="unsigned long" dir="in"/>
5554	<param name="port" type="ISerialPort" dir="return"/>
5555	</method>
5556
5557	<method name="getParallelPort" const="yes">
5558	<desc>
5559	Returns the parallel port associated with the given slot.
5560	Slots are numbered sequentially, starting with zero. The total
5561	number of parallel ports per machine is defined by the
5562	<link to="ISystemProperties::parallelPortCount"/> property,
5563	so the maximum slot number is one less than that property's value.
5564
5565	<result name="E_INVALIDARG">
5566	Invalid @a slot number.
5567	</result>
5568
5569	</desc>
5570	<param name="slot" type="unsigned long" dir="in"/>
5571	<param name="port" type="IParallelPort" dir="return"/>
5572	</method>
5573
5574	<method name="getExtraDataKeys">
5575	<desc>
5576	Returns an array representing the machine-specific extra data keys
5577	which currently have values defined.
5578	</desc>
5579	<param name="value" type="wstring" dir="return" safearray="yes">
5580	<desc>Array of extra data keys.</desc>
5581	</param>
5582	</method>
5583
5584	<method name="getExtraData">
5585	<desc>
5586	Returns associated machine-specific extra data.
5587
5588	If the requested data @a key does not exist, this function will
5589	succeed and return an empty string in the @a value argument.
5590
5591	<result name="VBOX_E_FILE_ERROR">
5592	Settings file not accessible.
5593	</result>
5594	<result name="VBOX_E_XML_ERROR">
5595	Could not parse the settings file.
5596	</result>
5597
5598	</desc>
5599	<param name="key" type="wstring" dir="in">
5600	<desc>Name of the data key to get.</desc>
5601	</param>
5602	<param name="value" type="wstring" dir="return">
5603	<desc>Value of the requested data key.</desc>
5604	</param>
5605	</method>
5606
5607	<method name="setExtraData">
5608	<desc>
5609	Sets associated machine-specific extra data.
5610
5611	If you pass @c null or an empty string as a key @a value, the given
5612	@a key will be deleted.
5613
5614	<note>
5615	Before performing the actual data change, this method will ask all
5616	registered listeners using the
5617	<link to="IExtraDataCanChangeEvent"/>
5618	notification for a permission. If one of the listeners refuses the
5619	new value, the change will not be performed.
5620	</note>
5621	<note>
5622	On success, the
5623	<link to="IExtraDataChangedEvent"/> notification
5624	is called to inform all registered listeners about a successful data
5625	change.
5626	</note>
5627	<note>
5628	This method can be called outside the machine session and therefore
5629	it's a caller's responsibility to handle possible race conditions
5630	when several clients change the same key at the same time.
5631	</note>
5632
5633	<result name="VBOX_E_FILE_ERROR">
5634	Settings file not accessible.
5635	</result>
5636	<result name="VBOX_E_XML_ERROR">
5637	Could not parse the settings file.
5638	</result>
5639
5640	</desc>
5641	<param name="key" type="wstring" dir="in">
5642	<desc>Name of the data key to set.</desc>
5643	</param>
5644	<param name="value" type="wstring" dir="in">
5645	<desc>Value to assign to the key.</desc>
5646	</param>
5647	</method>
5648
5649	<method name="getCPUProperty" const="yes">
5650	<desc>
5651	Returns the virtual CPU boolean value of the specified property.
5652
5653	<result name="E_INVALIDARG">
5654	Invalid property.
5655	</result>
5656
5657	</desc>
5658	<param name="property" type="CPUPropertyType" dir="in">
5659	<desc>
5660	Property type to query.
5661	</desc>
5662	</param>
5663	<param name="value" type="boolean" dir="return">
5664	<desc>
5665	Property value.
5666	</desc>
5667	</param>
5668	</method>
5669
5670	<method name="setCPUProperty">
5671	<desc>
5672	Sets the virtual CPU boolean value of the specified property.
5673
5674	<result name="E_INVALIDARG">
5675	Invalid property.
5676	</result>
5677
5678	</desc>
5679	<param name="property" type="CPUPropertyType" dir="in">
5680	<desc>
5681	Property type to query.
5682	</desc>
5683	</param>
5684	<param name="value" type="boolean" dir="in">
5685	<desc>
5686	Property value.
5687	</desc>
5688	</param>
5689	</method>
5690
5691	<method name="getCPUIDLeaf" const="yes">
5692	<desc>
5693	Returns the virtual CPU cpuid information for the specified leaf.
5694
5695	Currently supported index values for cpuid:
5696	Standard CPUID leafs: 0 - 0xA
5697	Extended CPUID leafs: 0x80000000 - 0x8000000A
5698
5699	See the Intel and AMD programmer's manuals for detailed information
5700	about the cpuid instruction and its leafs.
5701	<result name="E_INVALIDARG">
5702	Invalid id.
5703	</result>
5704
5705	</desc>
5706	<param name="id" type="unsigned long" dir="in">
5707	<desc>
5708	CPUID leaf index.
5709	</desc>
5710	</param>
5711	<param name="valEax" type="unsigned long" dir="out">
5712	<desc>
5713	CPUID leaf value for register eax.
5714	</desc>
5715	</param>
5716	<param name="valEbx" type="unsigned long" dir="out">
5717	<desc>
5718	CPUID leaf value for register ebx.
5719	</desc>
5720	</param>
5721	<param name="valEcx" type="unsigned long" dir="out">
5722	<desc>
5723	CPUID leaf value for register ecx.
5724	</desc>
5725	</param>
5726	<param name="valEdx" type="unsigned long" dir="out">
5727	<desc>
5728	CPUID leaf value for register edx.
5729	</desc>
5730	</param>
5731	</method>
5732
5733	<method name="setCPUIDLeaf">
5734	<desc>
5735	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5736	are not passed unmodified. VirtualBox clears features that it doesn't support.
5737
5738	Currently supported index values for cpuid:
5739	Standard CPUID leafs: 0 - 0xA
5740	Extended CPUID leafs: 0x80000000 - 0x8000000A
5741
5742	See the Intel and AMD programmer's manuals for detailed information
5743	about the cpuid instruction and its leafs.
5744
5745	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5746	random crashes inside VMs.
5747	<result name="E_INVALIDARG">
5748	Invalid id.
5749	</result>
5750
5751	</desc>
5752	<param name="id" type="unsigned long" dir="in">
5753	<desc>
5754	CPUID leaf index.
5755	</desc>
5756	</param>
5757	<param name="valEax" type="unsigned long" dir="in">
5758	<desc>
5759	CPUID leaf value for register eax.
5760	</desc>
5761	</param>
5762	<param name="valEbx" type="unsigned long" dir="in">
5763	<desc>
5764	CPUID leaf value for register ebx.
5765	</desc>
5766	</param>
5767	<param name="valEcx" type="unsigned long" dir="in">
5768	<desc>
5769	CPUID leaf value for register ecx.
5770	</desc>
5771	</param>
5772	<param name="valEdx" type="unsigned long" dir="in">
5773	<desc>
5774	CPUID leaf value for register edx.
5775	</desc>
5776	</param>
5777	</method>
5778
5779	<method name="removeCPUIDLeaf">
5780	<desc>
5781	Removes the virtual CPU cpuid leaf for the specified index
5782
5783	<result name="E_INVALIDARG">
5784	Invalid id.
5785	</result>
5786
5787	</desc>
5788	<param name="id" type="unsigned long" dir="in">
5789	<desc>
5790	CPUID leaf index.
5791	</desc>
5792	</param>
5793	</method>
5794
5795	<method name="removeAllCPUIDLeaves">
5796	<desc>
5797	Removes all the virtual CPU cpuid leaves
5798	</desc>
5799	</method>
5800
5801	<method name="getHWVirtExProperty" const="yes">
5802	<desc>
5803	Returns the value of the specified hardware virtualization boolean property.
5804
5805	<result name="E_INVALIDARG">
5806	Invalid property.
5807	</result>
5808
5809	</desc>
5810	<param name="property" type="HWVirtExPropertyType" dir="in">
5811	<desc>
5812	Property type to query.
5813	</desc>
5814	</param>
5815	<param name="value" type="boolean" dir="return">
5816	<desc>
5817	Property value.
5818	</desc>
5819	</param>
5820	</method>
5821
5822	<method name="setHWVirtExProperty">
5823	<desc>
5824	Sets a new value for the specified hardware virtualization boolean property.
5825
5826	<result name="E_INVALIDARG">
5827	Invalid property.
5828	</result>
5829
5830	</desc>
5831	<param name="property" type="HWVirtExPropertyType" dir="in">
5832	<desc>
5833	Property type to set.
5834	</desc>
5835	</param>
5836	<param name="value" type="boolean" dir="in">
5837	<desc>
5838	New property value.
5839	</desc>
5840	</param>
5841	</method>
5842
5843	<method name="saveSettings">
5844	<desc>
5845	Saves any changes to machine settings made since the session
5846	has been opened or a new machine has been created, or since the
5847	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5848	For registered machines, new settings become visible to all
5849	other VirtualBox clients after successful invocation of this
5850	method.
5851	<note>
5852	The method sends <link to="IMachineDataChangedEvent"/>
5853	notification event after the configuration has been successfully
5854	saved (only for registered machines).
5855	</note>
5856	<note>
5857	Calling this method is only valid on instances returned
5858	by <link to="ISession::machine"/> and on new machines
5859	created by <link to="IVirtualBox::createMachine"/> but not
5860	yet registered, or on unregistered machines after calling
5861	<link to="IMachine::unregister"/>.
5862	</note>
5863
5864	<result name="VBOX_E_FILE_ERROR">
5865	Settings file not accessible.
5866	</result>
5867	<result name="VBOX_E_XML_ERROR">
5868	Could not parse the settings file.
5869	</result>
5870	<result name="E_ACCESSDENIED">
5871	Modification request refused.
5872	</result>
5873
5874	</desc>
5875	</method>
5876
5877	<method name="discardSettings">
5878	<desc>
5879	Discards any changes to the machine settings made since the session
5880	has been opened or since the last call to <link to="#saveSettings"/>
5881	or <link to="#discardSettings"/>.
5882	<note>
5883	Calling this method is only valid on instances returned
5884	by <link to="ISession::machine"/> and on new machines
5885	created by <link to="IVirtualBox::createMachine"/> or
5886	opened by <link to="IVirtualBox::openMachine"/> but not
5887	yet registered, or on unregistered machines after calling
5888	<link to="IMachine::unregister"/>.
5889	</note>
5890
5891	<result name="VBOX_E_INVALID_VM_STATE">
5892	Virtual machine is not mutable.
5893	</result>
5894
5895	</desc>
5896	</method>
5897
5898	<method name="unregister">
5899	<desc>
5900	Unregisters a machine previously registered with
5901	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5902	cleanup before the machine is unregistered.
5903
5904	This method does not delete any files. It only changes the machine configuration and
5905	the list of registered machines in the VirtualBox object. To delete the files which
5906	belonged to the machine, including the XML file of the machine itself, call
5907	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5908	from this method.
5909
5910	How thoroughly this method cleans up the machine configuration before unregistering
5911	the machine depends on the @a cleanupMode argument.
5912
5913	<ul>
5914	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5915	cleanup will be performed. The call will fail if the machine is in "Saved" state
5916	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5917	It is the responsibility of the caller to delete all such configuration in this mode.
5918	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5919	which it replaces.</li>
5920	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5921	state or if it has snapshots or media attached. All media attached to the current machine
5922	state or in snapshots will be detached. No medium objects will be returned;
5923	all of the machine's media will remain open.</li>
5924	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5925	except that all the hard disk medium objects which were detached from the machine will
5926	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5927	API for closing and deletion.</li>
5928	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5929	that all media will be returned in the array, including removable media like DVDs and
5930	floppies. This might be useful if the user wants to inspect in detail which media were
5931	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5932	in that case because users will typically want to preserve ISO and RAW image files.</li>
5933	</ul>
5934
5935	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5936	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5937	deleted with all its saved states and hard disk images, but images for removable
5938	drives (such as ISO and RAW files) will remain on disk.
5939
5940	This API does not verify whether the media files returned in the array are still
5941	attached to other machines (i.e. shared between several machines). If such a shared
5942	image is passed to <link to="#delete" /> however, closing the image will fail there
5943	and the image will be silently skipped.
5944
5945	This API may, however, move media from this machine's media registry to other media
5946	registries (see <link to="IMedium" /> for details on media registries). For machines
5947	created with VirtualBox 4.0 or later, if media from this machine's media registry
5948	are also attached to another machine (shared attachments), each such medium will be
5949	moved to another machine's registry. This is because without this machine's media
5950	registry, the other machine cannot find its media any more and would become inaccessible.
5951
5952	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5953	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5954	if media are moved to other machines' media registries.
5955
5956	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5957	is fired.
5958
5959	The call will fail if the machine is currently locked (see <link to="ISession" />).
5960
5961	<note>
5962	If the given machine is inaccessible (see <link to="#accessible"/>), it
5963	will be unregistered and fully uninitialized right afterwards. As a result,
5964	the returned machine object will be unusable and an attempt to call
5965	<b>any</b> method will return the "Object not ready" error.
5966	</note>
5967
5968	<result name="VBOX_E_INVALID_OBJECT_STATE">
5969	Machine is currently locked for a session.
5970	</result>
5971	</desc>
5972
5973	<param name="cleanupMode" type="CleanupMode" dir="in">
5974	<desc>How to clean up after the machine has been unregistered.</desc>
5975	</param>
5976	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5977	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5978	</param>
5979	</method>
5980
5981	<method name="delete">
5982	<desc>
5983	Deletes the files associated with this machine from disk. If medium objects are passed
5984	in with the @a aMedia argument, they are closed and, if closing was successful, their
5985	storage files are deleted as well. For convenience, this array of media files can be
5986	the same as the one returned from a previous <link to="#unregister" /> call.
5987
5988	This method must only be called on machines which are either write-locked (i.e. on instances
5989	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5990	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5991	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5992
5993	The following files will be deleted by this method:
5994	<ul>
5995	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5996	argument other than "UnregisterOnly", this will delete all saved state files that
5997	the machine had in use; possibly one if the machine was in "Saved" state and one
5998	for each online snapshot that the machine had.</li>
5999	<li>On each medium object passed in the @a aMedia array, this will call
6000	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6001	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6002	in use, e.g. because it is still attached to a second machine; in that case the
6003	storage will not be deleted.</li>
6004	<li>Finally, the machine's own XML file will be deleted.</li>
6005	</ul>
6006
6007	Since deleting large disk image files can be a time-consuming I/O operation, this
6008	method operates asynchronously and returns an IProgress object to allow the caller
6009	to monitor the progress. There will be one sub-operation for each file that is
6010	being deleted (saved state or medium storage file).
6011
6012	<note>
6013	<link to="#settingsModified"/> will return @c true after this
6014	method successfully returns.
6015	</note>
6016
6017	<result name="VBOX_E_INVALID_VM_STATE">
6018	Machine is registered but not write-locked.
6019	</result>
6020	<result name="VBOX_E_IPRT_ERROR">
6021	Could not delete the settings file.
6022	</result>
6023	</desc>
6024	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
6025	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6026	</param>
6027	<param name="aProgress" type="IProgress" dir="return">
6028	<desc>Progress object to track the operation completion.</desc>
6029	</param>
6030	</method>
6031
6032	<method name="export">
6033	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6034	steps required to export VirtualBox machines to OVF.
6035	</desc>
6036
6037	<param name="aAppliance" type="IAppliance" dir="in">
6038	<desc>Appliance to export this machine to.</desc>
6039	</param>
6040	<param name="location" type="wstring" dir="in">
6041	<desc>The target location.</desc>
6042	</param>
6043	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
6044	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6045	</param>
6046	</method >
6047
6048	<method name="findSnapshot">
6049	<desc>
6050	Returns a snapshot of this machine with the given name or UUID.
6051
6052	Returns a snapshot of this machine with the given UUID.
6053	A @c null argument can be used to obtain the first snapshot
6054	taken on this machine. To traverse the whole tree of snapshots
6055	starting from the root, inspect the root snapshot's
6056	<link to="ISnapshot::children" /> attribute and recurse over those children.
6057
6058	<result name="VBOX_E_OBJECT_NOT_FOUND">
6059	Virtual machine has no snapshots or snapshot not found.
6060	</result>
6061
6062	</desc>
6063	<param name="nameOrId" type="wstring" dir="in">
6064	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6065	</param>
6066	<param name="snapshot" type="ISnapshot" dir="return">
6067	<desc>Snapshot object with the given name.</desc>
6068	</param>
6069	</method>
6070
6071	<method name="createSharedFolder">
6072	<desc>
6073	Creates a new permanent shared folder by associating the given logical
6074	name with the given host path, adds it to the collection of shared
6075	folders and starts sharing it. Refer to the description of
6076	<link to="ISharedFolder"/> to read more about logical names.
6077
6078	<result name="VBOX_E_OBJECT_IN_USE">
6079	Shared folder already exists.
6080	</result>
6081	<result name="VBOX_E_FILE_ERROR">
6082	Shared folder @a hostPath not accessible.
6083	</result>
6084
6085	</desc>
6086	<param name="name" type="wstring" dir="in">
6087	<desc>Unique logical name of the shared folder.</desc>
6088	</param>
6089	<param name="hostPath" type="wstring" dir="in">
6090	<desc>Full path to the shared folder in the host file system.</desc>
6091	</param>
6092	<param name="writable" type="boolean" dir="in">
6093	<desc>Whether the share is writable or readonly.</desc>
6094	</param>
6095	<param name="automount" type="boolean" dir="in">
6096	<desc>Whether the share gets automatically mounted by the guest
6097	or not.</desc>
6098	</param>
6099	</method>
6100
6101	<method name="removeSharedFolder">
6102	<desc>
6103	Removes the permanent shared folder with the given name previously
6104	created by <link to="#createSharedFolder"/> from the collection of
6105	shared folders and stops sharing it.
6106
6107	<result name="VBOX_E_INVALID_VM_STATE">
6108	Virtual machine is not mutable.
6109	</result>
6110	<result name="VBOX_E_OBJECT_NOT_FOUND">
6111	Shared folder @a name does not exist.
6112	</result>
6113
6114	</desc>
6115	<param name="name" type="wstring" dir="in">
6116	<desc>Logical name of the shared folder to remove.</desc>
6117	</param>
6118	</method>
6119
6120	<method name="canShowConsoleWindow">
6121	<desc>
6122	Returns @c true if the VM console process can activate the
6123	console window and bring it to foreground on the desktop of
6124	the host PC.
6125	<note>
6126	This method will fail if a session for this machine is not
6127	currently open.
6128	</note>
6129
6130	<result name="VBOX_E_INVALID_VM_STATE">
6131	Machine session is not open.
6132	</result>
6133
6134	</desc>
6135	<param name="canShow" type="boolean" dir="return">
6136	<desc>
6137	@c true if the console window can be shown and @c false otherwise.
6138	</desc>
6139	</param>
6140	</method>
6141
6142	<method name="showConsoleWindow">
6143	<desc>
6144	Activates the console window and brings it to foreground on
6145	the desktop of the host PC. Many modern window managers on
6146	many platforms implement some sort of focus stealing
6147	prevention logic, so that it may be impossible to activate
6148	a window without the help of the currently active
6149	application. In this case, this method will return a non-zero
6150	identifier that represents the top-level window of the VM
6151	console process. The caller, if it represents a currently
6152	active process, is responsible to use this identifier (in a
6153	platform-dependent manner) to perform actual window
6154	activation.
6155	<note>
6156	This method will fail if a session for this machine is not
6157	currently open.
6158	</note>
6159
6160	<result name="VBOX_E_INVALID_VM_STATE">
6161	Machine session is not open.
6162	</result>
6163
6164	</desc>
6165	<param name="winId" type="long long" dir="return">
6166	<desc>
6167	Platform-dependent identifier of the top-level VM console
6168	window, or zero if this method has performed all actions
6169	necessary to implement the <i>show window</i> semantics for
6170	the given platform and/or VirtualBox front-end.
6171	</desc>
6172	</param>
6173	</method>
6174
6175	<method name="getGuestProperty" const="yes">
6176	<desc>
6177	Reads an entry from the machine's guest property store.
6178
6179	<result name="VBOX_E_INVALID_VM_STATE">
6180	Machine session is not open.
6181	</result>
6182
6183	</desc>
6184	<param name="name" type="wstring" dir="in">
6185	<desc>
6186	The name of the property to read.
6187	</desc>
6188	</param>
6189	<param name="value" type="wstring" dir="out">
6190	<desc>
6191	The value of the property. If the property does not exist then this
6192	will be empty.
6193	</desc>
6194	</param>
6195	<param name="timestamp" type="long long" dir="out">
6196	<desc>
6197	The time at which the property was last modified, as seen by the
6198	server process.
6199	</desc>
6200	</param>
6201	<param name="flags" type="wstring" dir="out">
6202	<desc>
6203	Additional property parameters, passed as a comma-separated list of
6204	"name=value" type entries.
6205	</desc>
6206	</param>
6207	</method>
6208
6209	<method name="getGuestPropertyValue" const="yes">
6210	<desc>
6211	Reads a value from the machine's guest property store.
6212
6213	<result name="VBOX_E_INVALID_VM_STATE">
6214	Machine session is not open.
6215	</result>
6216
6217	</desc>
6218	<param name="property" type="wstring" dir="in">
6219	<desc>
6220	The name of the property to read.
6221	</desc>
6222	</param>
6223	<param name="value" type="wstring" dir="return">
6224	<desc>
6225	The value of the property. If the property does not exist then this
6226	will be empty.
6227	</desc>
6228	</param>
6229	</method>
6230
6231	<method name="getGuestPropertyTimestamp" const="yes">
6232	<desc>
6233	Reads a property timestamp from the machine's guest property store.
6234
6235	<result name="VBOX_E_INVALID_VM_STATE">
6236	Machine session is not open.
6237	</result>
6238
6239	</desc>
6240	<param name="property" type="wstring" dir="in">
6241	<desc>
6242	The name of the property to read.
6243	</desc>
6244	</param>
6245	<param name="value" type="long long" dir="return">
6246	<desc>
6247	The timestamp. If the property does not exist then this will be
6248	empty.
6249	</desc>
6250	</param>
6251	</method>
6252
6253	<method name="setGuestProperty">
6254	<desc>
6255	Sets, changes or deletes an entry in the machine's guest property
6256	store.
6257
6258	<result name="E_ACCESSDENIED">
6259	Property cannot be changed.
6260	</result>
6261	<result name="E_INVALIDARG">
6262	Invalid @a flags.
6263	</result>
6264	<result name="VBOX_E_INVALID_VM_STATE">
6265	Virtual machine is not mutable or session not open.
6266	</result>
6267	<result name="VBOX_E_INVALID_OBJECT_STATE">
6268	Cannot set transient property when machine not running.
6269	</result>
6270
6271	</desc>
6272	<param name="property" type="wstring" dir="in">
6273	<desc>
6274	The name of the property to set, change or delete.
6275	</desc>
6276	</param>
6277	<param name="value" type="wstring" dir="in">
6278	<desc>
6279	The new value of the property to set, change or delete. If the
6280	property does not yet exist and value is non-empty, it will be
6281	created. If the value is @c null or empty, the property will be
6282	deleted if it exists.
6283	</desc>
6284	</param>
6285	<param name="flags" type="wstring" dir="in">
6286	<desc>
6287	Additional property parameters, passed as a comma-separated list of
6288	"name=value" type entries.
6289	</desc>
6290	</param>
6291	</method>
6292
6293	<method name="setGuestPropertyValue">
6294	<desc>
6295	Sets, changes or deletes a value in the machine's guest property
6296	store. The flags field will be left unchanged or created empty for a
6297	new property.
6298
6299	<result name="E_ACCESSDENIED">
6300	Property cannot be changed.
6301	</result>
6302	<result name="VBOX_E_INVALID_VM_STATE">
6303	Virtual machine is not mutable or session not open.
6304	</result>
6305	<result name="VBOX_E_INVALID_OBJECT_STATE">
6306	Cannot set transient property when machine not running.
6307	</result>
6308	</desc>
6309
6310	<param name="property" type="wstring" dir="in">
6311	<desc>
6312	The name of the property to set, change or delete.
6313	</desc>
6314	</param>
6315	<param name="value" type="wstring" dir="in">
6316	<desc>
6317	The new value of the property to set, change or delete. If the
6318	property does not yet exist and value is non-empty, it will be
6319	created. If the value is @c null or empty, the property will be
6320	deleted if it exists.
6321	</desc>
6322	</param>
6323	</method>
6324
6325	<method name="deleteGuestProperty" const="yes">
6326	<desc>
6327	Deletes an entry from the machine's guest property store.
6328
6329	<result name="VBOX_E_INVALID_VM_STATE">
6330	Machine session is not open.
6331	</result>
6332
6333	</desc>
6334	<param name="name" type="wstring" dir="in">
6335	<desc>
6336	The name of the property to delete.
6337	</desc>
6338	</param>
6339	</method>
6340
6341	<method name="enumerateGuestProperties" const="yes">
6342	<desc>
6343	Return a list of the guest properties matching a set of patterns along
6344	with their values, time stamps and flags.
6345	</desc>
6346	<param name="patterns" type="wstring" dir="in">
6347	<desc>
6348	The patterns to match the properties against, separated by '\|'
6349	characters. If this is empty or @c null, all properties will match.
6350	</desc>
6351	</param>
6352	<param name="name" type="wstring" dir="out" safearray="yes">
6353	<desc>
6354	The names of the properties returned.
6355	</desc>
6356	</param>
6357	<param name="value" type="wstring" dir="out" safearray="yes">
6358	<desc>
6359	The values of the properties returned. The array entries match the
6360	corresponding entries in the @a name array.
6361	</desc>
6362	</param>
6363	<param name="timestamp" type="long long" dir="out" safearray="yes">
6364	<desc>
6365	The time stamps of the properties returned. The array entries match
6366	the corresponding entries in the @a name array.
6367	</desc>
6368	</param>
6369	<param name="flags" type="wstring" dir="out" safearray="yes">
6370	<desc>
6371	The flags of the properties returned. The array entries match the
6372	corresponding entries in the @a name array.
6373	</desc>
6374	</param>
6375	</method>
6376
6377	<method name="querySavedGuestScreenInfo" const="yes">
6378	<desc>
6379	Returns the guest dimensions from the saved state.
6380	</desc>
6381	<param name="screenId" type="unsigned long" dir="in">
6382	<desc>
6383	Saved guest screen to query info from.
6384	</desc>
6385	</param>
6386	<param name="originX" type="unsigned long" dir="out">
6387	<desc>
6388	The X position of the guest monitor top left corner.
6389	</desc>
6390	</param>
6391	<param name="originY" type="unsigned long" dir="out">
6392	<desc>
6393	The Y position of the guest monitor top left corner.
6394	</desc>
6395	</param>
6396	<param name="width" type="unsigned long" dir="out">
6397	<desc>
6398	Guest width at the time of the saved state was taken.
6399	</desc>
6400	</param>
6401	<param name="height" type="unsigned long" dir="out">
6402	<desc>
6403	Guest height at the time of the saved state was taken.
6404	</desc>
6405	</param>
6406	<param name="enabled" type="boolean" dir="out">
6407	<desc>
6408	Whether the monitor is enabled in the guest.
6409	</desc>
6410	</param>
6411	</method>
6412
6413	<method name="querySavedThumbnailSize">
6414	<desc>
6415	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6416	</desc>
6417	<param name="screenId" type="unsigned long" dir="in">
6418	<desc>
6419	Saved guest screen to query info from.
6420	</desc>
6421	</param>
6422	<param name="size" type="unsigned long" dir="out">
6423	<desc>
6424	Size of buffer required to store the bitmap.
6425	</desc>
6426	</param>
6427	<param name="width" type="unsigned long" dir="out">
6428	<desc>
6429	Bitmap width.
6430	</desc>
6431	</param>
6432	<param name="height" type="unsigned long" dir="out">
6433	<desc>
6434	Bitmap height.
6435	</desc>
6436	</param>
6437	</method>
6438
6439	<method name="readSavedThumbnailToArray">
6440	<desc>
6441	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6442	</desc>
6443	<param name="screenId" type="unsigned long" dir="in">
6444	<desc>
6445	Saved guest screen to read from.
6446	</desc>
6447	</param>
6448	<param name="BGR" type="boolean" dir="in">
6449	<desc>
6450	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6451	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6452	</desc>
6453	</param>
6454	<param name="width" type="unsigned long" dir="out">
6455	<desc>
6456	Bitmap width.
6457	</desc>
6458	</param>
6459	<param name="height" type="unsigned long" dir="out">
6460	<desc>
6461	Bitmap height.
6462	</desc>
6463	</param>
6464	<param name="data" type="octet" safearray="yes" dir="return">
6465	<desc>
6466	Array with resulting bitmap data.
6467	</desc>
6468	</param>
6469	</method>
6470
6471	<method name="readSavedThumbnailPNGToArray">
6472	<desc>
6473	Thumbnail in PNG format is retrieved to an array of bytes.
6474	</desc>
6475	<param name="screenId" type="unsigned long" dir="in">
6476	<desc>
6477	Saved guest screen to read from.
6478	</desc>
6479	</param>
6480	<param name="width" type="unsigned long" dir="out">
6481	<desc>
6482	Image width.
6483	</desc>
6484	</param>
6485	<param name="height" type="unsigned long" dir="out">
6486	<desc>
6487	Image height.
6488	</desc>
6489	</param>
6490	<param name="data" type="octet" dir="return" safearray="yes">
6491	<desc>
6492	Array with resulting PNG data.
6493	</desc>
6494	</param>
6495	</method>
6496
6497	<method name="querySavedScreenshotPNGSize">
6498	<desc>
6499	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6500	</desc>
6501	<param name="screenId" type="unsigned long" dir="in">
6502	<desc>
6503	Saved guest screen to query info from.
6504	</desc>
6505	</param>
6506	<param name="size" type="unsigned long" dir="out">
6507	<desc>
6508	Size of buffer required to store the PNG binary data.
6509	</desc>
6510	</param>
6511	<param name="width" type="unsigned long" dir="out">
6512	<desc>
6513	Image width.
6514	</desc>
6515	</param>
6516	<param name="height" type="unsigned long" dir="out">
6517	<desc>
6518	Image height.
6519	</desc>
6520	</param>
6521	</method>
6522
6523	<method name="readSavedScreenshotPNGToArray">
6524	<desc>
6525	Screenshot in PNG format is retrieved to an array of bytes.
6526	</desc>
6527	<param name="screenId" type="unsigned long" dir="in">
6528	<desc>
6529	Saved guest screen to read from.
6530	</desc>
6531	</param>
6532	<param name="width" type="unsigned long" dir="out">
6533	<desc>
6534	Image width.
6535	</desc>
6536	</param>
6537	<param name="height" type="unsigned long" dir="out">
6538	<desc>
6539	Image height.
6540	</desc>
6541	</param>
6542	<param name="data" type="octet" dir="return" safearray="yes">
6543	<desc>
6544	Array with resulting PNG data.
6545	</desc>
6546	</param>
6547	</method>
6548
6549	<method name="hotPlugCPU">
6550	<desc>
6551	Plugs a CPU into the machine.
6552	</desc>
6553	<param name="cpu" type="unsigned long" dir="in">
6554	<desc>
6555	The CPU id to insert.
6556	</desc>
6557	</param>
6558	</method>
6559
6560	<method name="hotUnplugCPU">
6561	<desc>
6562	Removes a CPU from the machine.
6563	</desc>
6564	<param name="cpu" type="unsigned long" dir="in">
6565	<desc>
6566	The CPU id to remove.
6567	</desc>
6568	</param>
6569	</method>
6570
6571	<method name="getCPUStatus">
6572	<desc>
6573	Returns the current status of the given CPU.
6574	</desc>
6575	<param name="cpu" type="unsigned long" dir="in">
6576	<desc>
6577	The CPU id to check for.
6578	</desc>
6579	</param>
6580	<param name="attached" type="boolean" dir="return">
6581	<desc>
6582	Status of the CPU.
6583	</desc>
6584	</param>
6585	</method>
6586
6587	<method name="queryLogFilename">
6588	<desc>
6589	Queries for the VM log file name of an given index. Returns an empty
6590	string if a log file with that index doesn't exists.
6591	</desc>
6592	<param name="idx" type="unsigned long" dir="in">
6593	<desc>
6594	Which log file name to query. 0=current log file.
6595	</desc>
6596	</param>
6597	<param name="filename" type="wstring" dir="return">
6598	<desc>
6599	On return the full path to the log file or an empty string on error.
6600	</desc>
6601	</param>
6602	</method>
6603
6604	<method name="readLog">
6605	<desc>
6606	Reads the VM log file. The chunk size is limited, so even if you
6607	ask for a big piece there might be less data returned.
6608	</desc>
6609	<param name="idx" type="unsigned long" dir="in">
6610	<desc>
6611	Which log file to read. 0=current log file.
6612	</desc>
6613	</param>
6614	<param name="offset" type="long long" dir="in">
6615	<desc>
6616	Offset in the log file.
6617	</desc>
6618	</param>
6619	<param name="size" type="long long" dir="in">
6620	<desc>
6621	Chunk size to read in the log file.
6622	</desc>
6623	</param>
6624	<param name="data" type="octet" dir="return" safearray="yes">
6625	<desc>
6626	Data read from the log file. A data size of 0 means end of file
6627	if the requested chunk size was not 0. This is the unprocessed
6628	file data, i.e. the line ending style depends on the platform of
6629	the system the server is running on.
6630	</desc>
6631	</param>
6632	</method>
6633
6634	<method name="cloneTo">
6635	<desc>
6636	Creates a clone of this machine, either as a full clone (which means
6637	creating independent copies of the hard disk media, save states and so
6638	on), or as a linked clone (which uses its own differencing media,
6639	sharing the parent media with the source machine).
6640
6641	The target machine object must have been created previously with <link
6642	to="IVirtualBox::createMachine"/>, and all the settings will be
6643	transferred except the VM name and the hardware UUID. You can set the
6644	VM name and the new hardware UUID when creating the target machine. The
6645	network MAC addresses are newly created for all newtwork adapters. You
6646	can change that behaviour with the options parameter. The operation is
6647	performed asynchronously, so the machine object will be not be usable
6648	until the @a progress object signals completion.
6649
6650	<result name="E_INVALIDARG">
6651	@a target is @c null.
6652	</result>
6653	</desc>
6654
6655	<param name="target" type="IMachine" dir="in">
6656	<desc>Target machine object.</desc>
6657	</param>
6658	<param name="mode" type="CloneMode" dir="in">
6659	<desc>Which states should be cloned.</desc>
6660	</param>
6661	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6662	<desc>Options for the cloning operation.</desc>
6663	</param>
6664	<param name="progress" type="IProgress" dir="return">
6665	<desc>Progress object to track the operation completion.</desc>
6666	</param>
6667	</method>
6668
6669	</interface>
6670
6671	<!--
6672	// IConsole
6673	/////////////////////////////////////////////////////////////////////////
6674	-->
6675
6676	<interface
6677	name="IVRDEServerInfo" extends="$unknown"
6678	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6679	wsmap="struct"
6680	>
6681	<desc>
6682	Contains information about the remote desktop (VRDE) server capabilities and status.
6683	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6684	</desc>
6685
6686	<attribute name="active" type="boolean" readonly="yes">
6687	<desc>
6688	Whether the remote desktop connection is active.
6689	</desc>
6690	</attribute>
6691
6692	<attribute name="port" type="long" readonly="yes">
6693	<desc>
6694	VRDE server port number. If this property is equal to <tt>0</tt>, then
6695	the VRDE server failed to start, usually because there are no free IP
6696	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6697	server has not yet been started.
6698	</desc>
6699	</attribute>
6700
6701	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6702	<desc>
6703	How many times a client connected.
6704	</desc>
6705	</attribute>
6706
6707	<attribute name="beginTime" type="long long" readonly="yes">
6708	<desc>
6709	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6710	</desc>
6711	</attribute>
6712
6713	<attribute name="endTime" type="long long" readonly="yes">
6714	<desc>
6715	When the last connection was terminated or the current time, if
6716	connection is still active, in milliseconds since 1970-01-01 UTC.
6717	</desc>
6718	</attribute>
6719
6720	<attribute name="bytesSent" type="long long" readonly="yes">
6721	<desc>
6722	How many bytes were sent in last or current, if still active, connection.
6723	</desc>
6724	</attribute>
6725
6726	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6727	<desc>
6728	How many bytes were sent in all connections.
6729	</desc>
6730	</attribute>
6731
6732	<attribute name="bytesReceived" type="long long" readonly="yes">
6733	<desc>
6734	How many bytes were received in last or current, if still active, connection.
6735	</desc>
6736	</attribute>
6737
6738	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6739	<desc>
6740	How many bytes were received in all connections.
6741	</desc>
6742	</attribute>
6743
6744	<attribute name="user" type="wstring" readonly="yes">
6745	<desc>
6746	Login user name supplied by the client.
6747	</desc>
6748	</attribute>
6749
6750	<attribute name="domain" type="wstring" readonly="yes">
6751	<desc>
6752	Login domain name supplied by the client.
6753	</desc>
6754	</attribute>
6755
6756	<attribute name="clientName" type="wstring" readonly="yes">
6757	<desc>
6758	The client name supplied by the client.
6759	</desc>
6760	</attribute>
6761
6762	<attribute name="clientIP" type="wstring" readonly="yes">
6763	<desc>
6764	The IP address of the client.
6765	</desc>
6766	</attribute>
6767
6768	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6769	<desc>
6770	The client software version number.
6771	</desc>
6772	</attribute>
6773
6774	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6775	<desc>
6776	Public key exchange method used when connection was established.
6777	Values: 0 - RDP4 public key exchange scheme.
6778	1 - X509 certificates were sent to client.
6779	</desc>
6780	</attribute>
6781
6782	</interface>
6783
6784	<interface
6785	name="IConsole" extends="$unknown"
6786	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6787	wsmap="managed"
6788	>
6789	<desc>
6790	The IConsole interface represents an interface to control virtual
6791	machine execution.
6792
6793	A console object gets created when a machine has been locked for a
6794	particular session (client process) using <link to="IMachine::lockMachine" />
6795	or <link to="IMachine::launchVMProcess"/>. The console object can
6796	then be found in the session's <link to="ISession::console" /> attribute.
6797
6798	Methods of the IConsole interface allow the caller to query the current
6799	virtual machine execution state, pause the machine or power it down, save
6800	the machine state or take a snapshot, attach and detach removable media
6801	and so on.
6802
6803	<see><link to="ISession"/></see>
6804	</desc>
6805
6806	<attribute name="machine" type="IMachine" readonly="yes">
6807	<desc>
6808	Machine object for this console session.
6809	<note>
6810	This is a convenience property, it has the same value as
6811	<link to="ISession::machine"/> of the corresponding session
6812	object.
6813	</note>
6814	</desc>
6815	</attribute>
6816
6817	<attribute name="state" type="MachineState" readonly="yes">
6818	<desc>
6819	Current execution state of the machine.
6820	<note>
6821	This property always returns the same value as the corresponding
6822	property of the IMachine object for this console session.
6823	For the process that owns (executes) the VM, this is the
6824	preferable way of querying the VM state, because no IPC
6825	calls are made.
6826	</note>
6827	</desc>
6828	</attribute>
6829
6830	<attribute name="guest" type="IGuest" readonly="yes">
6831	<desc>Guest object.</desc>
6832	</attribute>
6833
6834	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6835	<desc>
6836	Virtual keyboard object.
6837	<note>
6838	If the machine is not running, any attempt to use
6839	the returned object will result in an error.
6840	</note>
6841	</desc>
6842	</attribute>
6843
6844	<attribute name="mouse" type="IMouse" readonly="yes">
6845	<desc>
6846	Virtual mouse object.
6847	<note>
6848	If the machine is not running, any attempt to use
6849	the returned object will result in an error.
6850	</note>
6851	</desc>
6852	</attribute>
6853
6854	<attribute name="display" type="IDisplay" readonly="yes">
6855	<desc>Virtual display object.
6856	<note>
6857	If the machine is not running, any attempt to use
6858	the returned object will result in an error.
6859	</note>
6860	</desc>
6861	</attribute>
6862
6863	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6864	<desc>Debugging interface.</desc>
6865	</attribute>
6866
6867	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6868	<desc>
6869	Collection of USB devices currently attached to the virtual
6870	USB controller.
6871	<note>
6872	The collection is empty if the machine is not running.
6873	</note>
6874	</desc>
6875	</attribute>
6876
6877	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6878	<desc>
6879	List of USB devices currently attached to the remote VRDE client.
6880	Once a new device is physically attached to the remote host computer,
6881	it appears in this list and remains there until detached.
6882	</desc>
6883	</attribute>
6884
6885	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6886	<desc>
6887	Collection of shared folders for the current session. These folders
6888	are called transient shared folders because they are available to the
6889	guest OS running inside the associated virtual machine only for the
6890	duration of the session (as opposed to
6891	<link to="IMachine::sharedFolders"/> which represent permanent shared
6892	folders). When the session is closed (e.g. the machine is powered down),
6893	these folders are automatically discarded.
6894
6895	New shared folders are added to the collection using
6896	<link to="#createSharedFolder"/>. Existing shared folders can be
6897	removed using <link to="#removeSharedFolder"/>.
6898	</desc>
6899	</attribute>
6900
6901	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6902	<desc>
6903	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6904	</desc>
6905	</attribute>
6906
6907	<attribute name="eventSource" type="IEventSource" readonly="yes">
6908	<desc>
6909	Event source for console events.
6910	</desc>
6911	</attribute>
6912
6913	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
6914	<desc>Array of PCI devices attached to this machine.</desc>
6915	</attribute>
6916
6917	<attribute name="useHostClipboard" type="boolean">
6918	<desc>
6919	Whether the guest clipboard should be connected to the host one or
6920	whether it should only be allowed access to the VRDE clipboard. This
6921	setting may not affect existing guest clipboard connections which
6922	are already connected to the host clipboard.
6923	</desc>
6924	</attribute>
6925
6926	<method name="powerUp">
6927	<desc>
6928	Starts the virtual machine execution using the current machine
6929	state (that is, its current execution state, current settings and
6930	current storage devices).
6931
6932	<note>
6933	This method is only useful for front-ends that want to actually
6934	execute virtual machines in their own process (like the VirtualBox
6935	or VBoxSDL front-ends). Unless you are intending to write such a
6936	front-end, do not call this method. If you simply want to
6937	start virtual machine execution using one of the existing front-ends
6938	(for example the VirtualBox GUI or headless server), use
6939	<link to="IMachine::launchVMProcess"/> instead; these
6940	front-ends will power up the machine automatically for you.
6941	</note>
6942
6943	If the machine is powered off or aborted, the execution will
6944	start from the beginning (as if the real hardware were just
6945	powered on).
6946
6947	If the machine is in the <link to="MachineState_Saved"/> state,
6948	it will continue its execution the point where the state has
6949	been saved.
6950
6951	If the machine <link to="IMachine::teleporterEnabled"/> property is
6952	enabled on the machine being powered up, the machine will wait for an
6953	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6954	state. The returned progress object will have at least three
6955	operations where the last three are defined as: (1) powering up and
6956	starting TCP server, (2) waiting for incoming teleportations, and
6957	(3) perform teleportation. These operations will be reflected as the
6958	last three operations of the progress objected returned by
6959	<link to="IMachine::launchVMProcess"/> as well.
6960
6961	<see><link to="#saveState"/></see>
6962
6963	<result name="VBOX_E_INVALID_VM_STATE">
6964	Virtual machine already running.
6965	</result>
6966	<result name="VBOX_E_HOST_ERROR">
6967	Host interface does not exist or name not set.
6968	</result>
6969	<result name="VBOX_E_FILE_ERROR">
6970	Invalid saved state file.
6971	</result>
6972	</desc>
6973	<param name="progress" type="IProgress" dir="return">
6974	<desc>Progress object to track the operation completion.</desc>
6975	</param>
6976	</method>
6977
6978	<method name="powerUpPaused">
6979	<desc>
6980	Identical to powerUp except that the VM will enter the
6981	<link to="MachineState_Paused"/> state, instead of
6982	<link to="MachineState_Running"/>.
6983
6984	<see><link to="#powerUp"/></see>
6985	<result name="VBOX_E_INVALID_VM_STATE">
6986	Virtual machine already running.
6987	</result>
6988	<result name="VBOX_E_HOST_ERROR">
6989	Host interface does not exist or name not set.
6990	</result>
6991	<result name="VBOX_E_FILE_ERROR">
6992	Invalid saved state file.
6993	</result>
6994	</desc>
6995	<param name="progress" type="IProgress" dir="return">
6996	<desc>Progress object to track the operation completion.</desc>
6997	</param>
6998	</method>
6999
7000	<method name="powerDown">
7001	<desc>
7002	Initiates the power down procedure to stop the virtual machine
7003	execution.
7004
7005	The completion of the power down procedure is tracked using the returned
7006	IProgress object. After the operation is complete, the machine will go
7007	to the PoweredOff state.
7008	<result name="VBOX_E_INVALID_VM_STATE">
7009	Virtual machine must be Running, Paused or Stuck to be powered down.
7010	</result>
7011	</desc>
7012	<param name="progress" type="IProgress" dir="return">
7013	<desc>Progress object to track the operation completion.</desc>
7014	</param>
7015	</method>
7016
7017	<method name="reset">
7018	<desc>Resets the virtual machine.
7019	<result name="VBOX_E_INVALID_VM_STATE">
7020	Virtual machine not in Running state.
7021	</result>
7022	<result name="VBOX_E_VM_ERROR">
7023	Virtual machine error in reset operation.
7024	</result>
7025	</desc>
7026	</method>
7027
7028	<method name="pause">
7029	<desc>Pauses the virtual machine execution.
7030	<result name="VBOX_E_INVALID_VM_STATE">
7031	Virtual machine not in Running state.
7032	</result>
7033	<result name="VBOX_E_VM_ERROR">
7034	Virtual machine error in suspend operation.
7035	</result>
7036	</desc>
7037	</method>
7038
7039	<method name="resume">
7040	<desc>Resumes the virtual machine execution.
7041	<result name="VBOX_E_INVALID_VM_STATE">
7042	Virtual machine not in Paused state.
7043	</result>
7044	<result name="VBOX_E_VM_ERROR">
7045	Virtual machine error in resume operation.
7046	</result>
7047	</desc>
7048	</method>
7049
7050	<method name="powerButton">
7051	<desc>Sends the ACPI power button event to the guest.
7052	<result name="VBOX_E_INVALID_VM_STATE">
7053	Virtual machine not in Running state.
7054	</result>
7055	<result name="VBOX_E_PDM_ERROR">
7056	Controlled power off failed.
7057	</result>
7058	</desc>
7059	</method>
7060
7061	<method name="sleepButton">
7062	<desc>Sends the ACPI sleep button event to the guest.
7063	<result name="VBOX_E_INVALID_VM_STATE">
7064	Virtual machine not in Running state.
7065	</result>
7066	<result name="VBOX_E_PDM_ERROR">
7067	Sending sleep button event failed.
7068	</result>
7069	</desc>
7070	</method>
7071
7072	<method name="getPowerButtonHandled">
7073	<desc>Checks if the last power button event was handled by guest.
7074	<result name="VBOX_E_PDM_ERROR">
7075	Checking if the event was handled by the guest OS failed.
7076	</result>
7077	</desc>
7078	<param name="handled" type="boolean" dir="return"/>
7079	</method>
7080
7081	<method name="getGuestEnteredACPIMode">
7082	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7083	G1 (sleeping). If this method returns @c false, the guest will
7084	most likely not respond to external ACPI events.
7085	<result name="VBOX_E_INVALID_VM_STATE">
7086	Virtual machine not in Running state.
7087	</result>
7088	</desc>
7089	<param name="entered" type="boolean" dir="return"/>
7090	</method>
7091
7092	<method name="saveState">
7093	<desc>
7094	Saves the current execution state of a running virtual machine
7095	and stops its execution.
7096
7097	After this operation completes, the machine will go to the
7098	Saved state. Next time it is powered up, this state will
7099	be restored and the machine will continue its execution from
7100	the place where it was saved.
7101
7102	This operation differs from taking a snapshot to the effect
7103	that it doesn't create new differencing media. Also, once
7104	the machine is powered up from the state saved using this method,
7105	the saved state is deleted, so it will be impossible to return
7106	to this state later.
7107
7108	<note>
7109	On success, this method implicitly calls
7110	<link to="IMachine::saveSettings"/> to save all current machine
7111	settings (including runtime changes to the DVD medium, etc.).
7112	Together with the impossibility to change any VM settings when it is
7113	in the Saved state, this guarantees adequate hardware
7114	configuration of the machine when it is restored from the saved
7115	state file.
7116	</note>
7117
7118	<note>
7119	The machine must be in the Running or Paused state, otherwise
7120	the operation will fail.
7121	</note>
7122	<result name="VBOX_E_INVALID_VM_STATE">
7123	Virtual machine state neither Running nor Paused.
7124	</result>
7125	<result name="VBOX_E_FILE_ERROR">
7126	Failed to create directory for saved state file.
7127	</result>
7128
7129	<see><link to="#takeSnapshot"/></see>
7130	</desc>
7131	<param name="progress" type="IProgress" dir="return">
7132	<desc>Progress object to track the operation completion.</desc>
7133	</param>
7134	</method>
7135
7136	<method name="adoptSavedState">
7137	<desc>
7138	Associates the given saved state file to the virtual machine.
7139
7140	On success, the machine will go to the Saved state. Next time it is
7141	powered up, it will be restored from the adopted saved state and
7142	continue execution from the place where the saved state file was
7143	created.
7144
7145	The specified saved state file path may be absolute or relative to the
7146	folder the VM normally saves the state to (usually,
7147	<link to="IMachine::snapshotFolder"/>).
7148
7149	<note>
7150	It's a caller's responsibility to make sure the given saved state
7151	file is compatible with the settings of this virtual machine that
7152	represent its virtual hardware (memory size, storage disk configuration
7153	etc.). If there is a mismatch, the behavior of the virtual machine
7154	is undefined.
7155	</note>
7156	<result name="VBOX_E_INVALID_VM_STATE">
7157	Virtual machine state neither PoweredOff nor Aborted.
7158	</result>
7159	</desc>
7160	<param name="savedStateFile" type="wstring" dir="in">
7161	<desc>Path to the saved state file to adopt.</desc>
7162	</param>
7163	</method>
7164
7165	<method name="discardSavedState">
7166	<desc>
7167	Forcibly resets the machine to "Powered Off" state if it is
7168	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7169	Next time the machine is powered up, a clean boot will occur.
7170	<note>
7171	This operation is equivalent to resetting or powering off
7172	the machine without doing a proper shutdown of the guest
7173	operating system; as with resetting a running phyiscal
7174	computer, it can can lead to data loss.
7175	</note>
7176	If @a fRemoveFile is @c true, the file in the machine directory
7177	into which the machine state was saved is also deleted. If
7178	this is @c false, then the state can be recovered and later
7179	re-inserted into a machine using <link to="#adoptSavedState" />.
7180	The location of the file can be found in the
7181	<link to="IMachine::stateFilePath" /> attribute.
7182	<result name="VBOX_E_INVALID_VM_STATE">
7183	Virtual machine not in state Saved.
7184	</result>
7185	</desc>
7186	<param name="fRemoveFile" type="boolean" dir="in" >
7187	<desc>Whether to also remove the saved state file.</desc>
7188	</param>
7189	</method>
7190
7191	<method name="getDeviceActivity">
7192	<desc>
7193	Gets the current activity type of a given device or device group.
7194	<result name="E_INVALIDARG">
7195	Invalid device type.
7196	</result>
7197	</desc>
7198	<param name="type" type="DeviceType" dir="in"/>
7199	<param name="activity" type="DeviceActivity" dir="return"/>
7200	</method>
7201
7202	<method name="attachUSBDevice">
7203	<desc>
7204	Attaches a host USB device with the given UUID to the
7205	USB controller of the virtual machine.
7206
7207	The device needs to be in one of the following states:
7208	<link to="USBDeviceState_Busy"/>,
7209	<link to="USBDeviceState_Available"/> or
7210	<link to="USBDeviceState_Held"/>,
7211	otherwise an error is immediately returned.
7212
7213	When the device state is
7214	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7215	be returned if the host computer refuses to release it for some reason.
7216
7217	<see><link to="IUSBController::deviceFilters"/>,
7218	<link to="USBDeviceState"/></see>
7219	<result name="VBOX_E_INVALID_VM_STATE">
7220	Virtual machine state neither Running nor Paused.
7221	</result>
7222	<result name="VBOX_E_PDM_ERROR">
7223	Virtual machine does not have a USB controller.
7224	</result>
7225	</desc>
7226	<param name="id" type="uuid" mod="string" dir="in">
7227	<desc>UUID of the host USB device to attach.</desc>
7228	</param>
7229	</method>
7230
7231	<method name="detachUSBDevice">
7232	<desc>
7233	Detaches an USB device with the given UUID from the USB controller
7234	of the virtual machine.
7235
7236	After this method succeeds, the VirtualBox server re-initiates
7237	all USB filters as if the device were just physically attached
7238	to the host, but filters of this machine are ignored to avoid
7239	a possible automatic re-attachment.
7240
7241	<see><link to="IUSBController::deviceFilters"/>,
7242	<link to="USBDeviceState"/></see>
7243
7244	<result name="VBOX_E_PDM_ERROR">
7245	Virtual machine does not have a USB controller.
7246	</result>
7247	<result name="E_INVALIDARG">
7248	USB device not attached to this virtual machine.
7249	</result>
7250	</desc>
7251	<param name="id" type="uuid" mod="string" dir="in">
7252	<desc>UUID of the USB device to detach.</desc>
7253	</param>
7254	<param name="device" type="IUSBDevice" dir="return">
7255	<desc>Detached USB device.</desc>
7256	</param>
7257	</method>
7258
7259	<method name="findUSBDeviceByAddress">
7260	<desc>
7261	Searches for a USB device with the given host address.
7262
7263	<result name="VBOX_E_OBJECT_NOT_FOUND">
7264	Given @c name does not correspond to any USB device.
7265	</result>
7266
7267	<see><link to="IUSBDevice::address"/></see>
7268	</desc>
7269	<param name="name" type="wstring" dir="in">
7270	<desc>
7271	Address of the USB device (as assigned by the host) to
7272	search for.
7273	</desc>
7274	</param>
7275	<param name="device" type="IUSBDevice" dir="return">
7276	<desc>Found USB device object.</desc>
7277	</param>
7278	</method>
7279
7280	<method name="findUSBDeviceById">
7281	<desc>
7282	Searches for a USB device with the given UUID.
7283
7284	<result name="VBOX_E_OBJECT_NOT_FOUND">
7285	Given @c id does not correspond to any USB device.
7286	</result>
7287
7288	<see><link to="IUSBDevice::id"/></see>
7289	</desc>
7290	<param name="id" type="uuid" mod="string" dir="in">
7291	<desc>UUID of the USB device to search for.</desc>
7292	</param>
7293	<param name="device" type="IUSBDevice" dir="return">
7294	<desc>Found USB device object.</desc>
7295	</param>
7296	</method>
7297
7298	<method name="createSharedFolder">
7299	<desc>
7300	Creates a transient new shared folder by associating the given logical
7301	name with the given host path, adds it to the collection of shared
7302	folders and starts sharing it. Refer to the description of
7303	<link to="ISharedFolder"/> to read more about logical names.
7304
7305	<result name="VBOX_E_INVALID_VM_STATE">
7306	Virtual machine in Saved state or currently changing state.
7307	</result>
7308	<result name="VBOX_E_FILE_ERROR">
7309	Shared folder already exists or not accessible.
7310	</result>
7311	</desc>
7312	<param name="name" type="wstring" dir="in">
7313	<desc>Unique logical name of the shared folder.</desc>
7314	</param>
7315	<param name="hostPath" type="wstring" dir="in">
7316	<desc>Full path to the shared folder in the host file system.</desc>
7317	</param>
7318	<param name="writable" type="boolean" dir="in">
7319	<desc>Whether the share is writable or readonly</desc>
7320	</param>
7321	<param name="automount" type="boolean" dir="in">
7322	<desc>Whether the share gets automatically mounted by the guest
7323	or not.</desc>
7324	</param>
7325	</method>
7326
7327	<method name="removeSharedFolder">
7328	<desc>
7329	Removes a transient shared folder with the given name previously
7330	created by <link to="#createSharedFolder"/> from the collection of
7331	shared folders and stops sharing it.
7332	<result name="VBOX_E_INVALID_VM_STATE">
7333	Virtual machine in Saved state or currently changing state.
7334	</result>
7335	<result name="VBOX_E_FILE_ERROR">
7336	Shared folder does not exists.
7337	</result>
7338	</desc>
7339	<param name="name" type="wstring" dir="in">
7340	<desc>Logical name of the shared folder to remove.</desc>
7341	</param>
7342	</method>
7343
7344	<method name="takeSnapshot">
7345	<desc>
7346	Saves the current execution state
7347	and all settings of the machine and creates differencing images
7348	for all normal (non-independent) media.
7349	See <link to="ISnapshot" /> for an introduction to snapshots.
7350
7351	This method can be called for a PoweredOff, Saved (see
7352	<link to="#saveState"/>), Running or
7353	Paused virtual machine. When the machine is PoweredOff, an
7354	offline snapshot is created. When the machine is Running a live
7355	snapshot is created, and an online snapshot is created when Paused.
7356
7357	The taken snapshot is always based on the
7358	<link to="IMachine::currentSnapshot">current snapshot</link>
7359	of the associated virtual machine and becomes a new current snapshot.
7360
7361	<note>
7362	This method implicitly calls <link to="IMachine::saveSettings"/> to
7363	save all current machine settings before taking an offline snapshot.
7364	</note>
7365
7366	<result name="VBOX_E_INVALID_VM_STATE">
7367	Virtual machine currently changing state.
7368	</result>
7369	</desc>
7370	<param name="name" type="wstring" dir="in">
7371	<desc>Short name for the snapshot.</desc>
7372	</param>
7373	<param name="description" type="wstring" dir="in">
7374	<desc>Optional description of the snapshot.</desc>
7375	</param>
7376	<param name="progress" type="IProgress" dir="return">
7377	<desc>Progress object to track the operation completion.</desc>
7378	</param>
7379	</method>
7380
7381	<method name="deleteSnapshot">
7382	<desc>
7383	Starts deleting the specified snapshot asynchronously.
7384	See <link to="ISnapshot" /> for an introduction to snapshots.
7385
7386	The execution state and settings of the associated machine stored in
7387	the snapshot will be deleted. The contents of all differencing media of
7388	this snapshot will be merged with the contents of their dependent child
7389	media to keep the medium chain valid (in other words, all changes
7390	represented by media being deleted will be propagated to their child
7391	medium). After that, this snapshot's differencing medium will be
7392	deleted. The parent of this snapshot will become a new parent for all
7393	its child snapshots.
7394
7395	If the deleted snapshot is the current one, its parent snapshot will
7396	become a new current snapshot. The current machine state is not directly
7397	affected in this case, except that currently attached differencing
7398	media based on media of the deleted snapshot will be also merged as
7399	described above.
7400
7401	If the deleted snapshot is the first or current snapshot, then the
7402	respective IMachine attributes will be adjusted. Deleting the current
7403	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7404	to make all current machine settings permanent.
7405
7406	Deleting a snapshot has the following preconditions:
7407
7408	<ul>
7409	<li>Child media of all normal media of the deleted snapshot
7410	must be accessible (see <link to="IMedium::state"/>) for this
7411	operation to succeed. If only one running VM refers to all images
7412	which participates in merging the operation can be performed while
7413	the VM is running. Otherwise all virtual machines whose media are
7414	directly or indirectly based on the media of deleted snapshot must
7415	be powered off. In any case, online snapshot deleting usually is
7416	slower than the same operation without any running VM.</li>
7417
7418	<li>You cannot delete the snapshot if a medium attached to it has
7419	more than one child medium (differencing images) because otherwise
7420	merging would be impossible. This might be the case if there is
7421	more than one child snapshot or differencing images were created
7422	for other reason (e.g. implicitly because of multiple machine
7423	attachments).</li>
7424	</ul>
7425
7426	The virtual machine's <link to="IMachine::state">state</link> is
7427	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7428	"DeletingSnapshotPaused" while this operation is in progress.
7429
7430	<note>
7431	Merging medium contents can be very time and disk space
7432	consuming, if these media are big in size and have many
7433	children. However, if the snapshot being deleted is the last
7434	(head) snapshot on the branch, the operation will be rather
7435	quick.
7436	</note>
7437	<result name="VBOX_E_INVALID_VM_STATE">
7438	The running virtual machine prevents deleting this snapshot. This
7439	happens only in very specific situations, usually snapshots can be
7440	deleted without trouble while a VM is running. The error message
7441	text explains the reason for the failure.
7442	</result>
7443	</desc>
7444	<param name="id" type="uuid" mod="string" dir="in">
7445	<desc>UUID of the snapshot to delete.</desc>
7446	</param>
7447	<param name="progress" type="IProgress" dir="return">
7448	<desc>Progress object to track the operation completion.</desc>
7449	</param>
7450	</method>
7451
7452	<method name="deleteSnapshotAndAllChildren">
7453	<desc>
7454	Starts deleting the specified snapshot and all its children
7455	asynchronously. See <link to="ISnapshot" /> for an introduction to
7456	snapshots. The conditions and many details are the same as with
7457	<link to="#deleteSnapshot"/>.
7458
7459	This operation is very fast if the snapshot subtree does not include
7460	the current state. It is still significantly faster than deleting the
7461	snapshots one by one if the current state is in the subtree and there
7462	are more than one snapshots from current state to the snapshot which
7463	marks the subtree, since it eliminates the incremental image merging.
7464
7465	<note>This API method is right now not implemented!</note>
7466
7467	<result name="VBOX_E_INVALID_VM_STATE">
7468	The running virtual machine prevents deleting this snapshot. This
7469	happens only in very specific situations, usually snapshots can be
7470	deleted without trouble while a VM is running. The error message
7471	text explains the reason for the failure.
7472	</result>
7473	<result name="E_NOTIMPL">
7474	The method is not implemented yet.
7475	</result>
7476	</desc>
7477	<param name="id" type="uuid" mod="string" dir="in">
7478	<desc>UUID of the snapshot to delete, including all its children.</desc>
7479	</param>
7480	<param name="progress" type="IProgress" dir="return">
7481	<desc>Progress object to track the operation completion.</desc>
7482	</param>
7483	</method>
7484
7485	<method name="deleteSnapshotRange">
7486	<desc>
7487	Starts deleting the specified snapshot range. This is limited to
7488	linear snapshot lists, which means there may not be any other child
7489	snapshots other than the direct sequence between the start and end
7490	snapshot. If the start and end snapshot point to the same snapshot this
7491	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7492	<link to="ISnapshot" /> for an introduction to snapshots. The
7493	conditions and many details are the same as with
7494	<link to="#deleteSnapshot"/>.
7495
7496	This operation is generally faster than deleting snapshots one by one
7497	and often also needs less extra disk space before freeing up disk space
7498	by deleting the removed disk images corresponding to the snapshot.
7499
7500	<note>This API method is right now not implemented!</note>
7501
7502	<result name="VBOX_E_INVALID_VM_STATE">
7503	The running virtual machine prevents deleting this snapshot. This
7504	happens only in very specific situations, usually snapshots can be
7505	deleted without trouble while a VM is running. The error message
7506	text explains the reason for the failure.
7507	</result>
7508	<result name="E_NOTIMPL">
7509	The method is not implemented yet.
7510	</result>
7511	</desc>
7512	<param name="startId" type="uuid" mod="string" dir="in">
7513	<desc>UUID of the first snapshot to delete.</desc>
7514	</param>
7515	<param name="endId" type="uuid" mod="string" dir="in">
7516	<desc>UUID of the last snapshot to delete.</desc>
7517	</param>
7518	<param name="progress" type="IProgress" dir="return">
7519	<desc>Progress object to track the operation completion.</desc>
7520	</param>
7521	</method>
7522
7523	<method name="restoreSnapshot">
7524	<desc>
7525	Starts resetting the machine's current state to the state contained
7526	in the given snapshot, asynchronously. All current settings of the
7527	machine will be reset and changes stored in differencing media
7528	will be lost.
7529	See <link to="ISnapshot" /> for an introduction to snapshots.
7530
7531	After this operation is successfully completed, new empty differencing
7532	media are created for all normal media of the machine.
7533
7534	If the given snapshot is an online snapshot, the machine will go to
7535	the <link to="MachineState_Saved"> saved state</link>, so that the
7536	next time it is powered on, the execution state will be restored
7537	from the state of the snapshot.
7538
7539	<note>
7540	The machine must not be running, otherwise the operation will fail.
7541	</note>
7542
7543	<note>
7544	If the machine state is <link to="MachineState_Saved">Saved</link>
7545	prior to this operation, the saved state file will be implicitly
7546	deleted (as if <link to="IConsole::discardSavedState"/> were
7547	called).
7548	</note>
7549
7550	<result name="VBOX_E_INVALID_VM_STATE">
7551	Virtual machine is running.
7552	</result>
7553	</desc>
7554	<param name="snapshot" type="ISnapshot" dir="in">
7555	<desc>The snapshot to restore the VM state from.</desc>
7556	</param>
7557	<param name="progress" type="IProgress" dir="return">
7558	<desc>Progress object to track the operation completion.</desc>
7559	</param>
7560	</method>
7561
7562	<method name="teleport">
7563	<desc>
7564	Teleport the VM to a different host machine or process.
7565
7566	TODO explain the details.
7567
7568	<result name="VBOX_E_INVALID_VM_STATE">
7569	Virtual machine not running or paused.
7570	</result>
7571	</desc>
7572	<param name="hostname" type="wstring" dir="in">
7573	<desc>The name or IP of the host to teleport to.</desc>
7574	</param>
7575	<param name="tcpport" type="unsigned long" dir="in">
7576	<desc>The TCP port to connect to (1..65535).</desc>
7577	</param>
7578	<param name="password" type="wstring" dir="in">
7579	<desc>The password.</desc>
7580	</param>
7581	<param name="maxDowntime" type="unsigned long" dir="in">
7582	<desc>
7583	The maximum allowed downtime given as milliseconds. 0 is not a valid
7584	value. Recommended value: 250 ms.
7585
7586	The higher the value is, the greater the chance for a successful
7587	teleportation. A small value may easily result in the teleportation
7588	process taking hours and eventually fail.
7589
7590	<note>
7591	The current implementation treats this a guideline, not as an
7592	absolute rule.
7593	</note>
7594	</desc>
7595	</param>
7596	<param name="progress" type="IProgress" dir="return">
7597	<desc>Progress object to track the operation completion.</desc>
7598	</param>
7599	</method>
7600
7601	</interface>
7602
7603	<!--
7604	// IHost
7605	/////////////////////////////////////////////////////////////////////////
7606	-->
7607
7608	<enum
7609	name="HostNetworkInterfaceMediumType"
7610	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7611	>
7612	<desc>
7613	Type of encapsulation. Ethernet encapsulation includes both wired and
7614	wireless Ethernet connections.
7615	<see><link to="IHostNetworkInterface"/></see>
7616	</desc>
7617
7618	<const name="Unknown" value="0">
7619	<desc>
7620	The type of interface cannot be determined.
7621	</desc>
7622	</const>
7623	<const name="Ethernet" value="1">
7624	<desc>
7625	Ethernet frame encapsulation.
7626	</desc>
7627	</const>
7628	<const name="PPP" value="2">
7629	<desc>
7630	Point-to-point protocol encapsulation.
7631	</desc>
7632	</const>
7633	<const name="SLIP" value="3">
7634	<desc>
7635	Serial line IP encapsulation.
7636	</desc>
7637	</const>
7638	</enum>
7639
7640	<enum
7641	name="HostNetworkInterfaceStatus"
7642	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7643	>
7644	<desc>
7645	Current status of the interface.
7646	<see><link to="IHostNetworkInterface"/></see>
7647	</desc>
7648
7649	<const name="Unknown" value="0">
7650	<desc>
7651	The state of interface cannot be determined.
7652	</desc>
7653	</const>
7654	<const name="Up" value="1">
7655	<desc>
7656	The interface is fully operational.
7657	</desc>
7658	</const>
7659	<const name="Down" value="2">
7660	<desc>
7661	The interface is not functioning.
7662	</desc>
7663	</const>
7664	</enum>
7665
7666	<enum
7667	name="HostNetworkInterfaceType"
7668	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7669	>
7670	<desc>
7671	Network interface type.
7672	</desc>
7673	<const name="Bridged" value="1"/>
7674	<const name="HostOnly" value="2"/>
7675	</enum>
7676
7677	<interface
7678	name="IHostNetworkInterface" extends="$unknown"
7679	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7680	wsmap="managed"
7681	>
7682	<desc>
7683	Represents one of host's network interfaces. IP V6 address and network
7684	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7685	separated by colons.
7686	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7687	</desc>
7688	<attribute name="name" type="wstring" readonly="yes">
7689	<desc>Returns the host network interface name.</desc>
7690	</attribute>
7691
7692	<attribute name="id" type="uuid" mod="string" readonly="yes">
7693	<desc>Returns the interface UUID.</desc>
7694	</attribute>
7695
7696	<attribute name="networkName" type="wstring" readonly="yes">
7697	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7698	</attribute>
7699
7700	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7701	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7702	</attribute>
7703
7704	<attribute name="IPAddress" type="wstring" readonly="yes">
7705	<desc>Returns the IP V4 address of the interface.</desc>
7706	</attribute>
7707
7708	<attribute name="networkMask" type="wstring" readonly="yes">
7709	<desc>Returns the network mask of the interface.</desc>
7710	</attribute>
7711
7712	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7713	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7714	</attribute>
7715
7716	<attribute name="IPV6Address" type="wstring" readonly="yes">
7717	<desc>Returns the IP V6 address of the interface.</desc>
7718	</attribute>
7719
7720	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7721	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7722	</attribute>
7723
7724	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7725	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7726	</attribute>
7727
7728	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7729	<desc>Type of protocol encapsulation used.</desc>
7730	</attribute>
7731
7732	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7733	<desc>Status of the interface.</desc>
7734	</attribute>
7735
7736	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7737	<desc>specifies the host interface type.</desc>
7738	</attribute>
7739
7740	<method name="enableStaticIPConfig">
7741	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7742	<param name="IPAddress" type="wstring" dir="in">
7743	<desc>
7744	IP address.
7745	</desc>
7746	</param>
7747	<param name="networkMask" type="wstring" dir="in">
7748	<desc>
7749	network mask.
7750	</desc>
7751	</param>
7752	</method>
7753
7754	<method name="enableStaticIPConfigV6">
7755	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7756	<param name="IPV6Address" type="wstring" dir="in">
7757	<desc>
7758	IP address.
7759	</desc>
7760	</param>
7761	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7762	<desc>
7763	network mask.
7764	</desc>
7765	</param>
7766	</method>
7767
7768	<method name="enableDynamicIPConfig">
7769	<desc>enables the dynamic IP configuration.</desc>
7770	</method>
7771
7772	<method name="DHCPRediscover">
7773	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7774	</method>
7775
7776	</interface>
7777
7778	<interface
7779	name="IHost" extends="$unknown"
7780	uuid="30678943-32df-4830-b413-931b25ac86a0"
7781	wsmap="managed"
7782	>
7783	<desc>
7784	The IHost interface represents the physical machine that this VirtualBox
7785	installation runs on.
7786
7787	An object implementing this interface is returned by the
7788	<link to="IVirtualBox::host" /> attribute. This interface contains
7789	read-only information about the host's physical hardware (such as what
7790	processors and disks are available, what the host operating system is,
7791	and so on) and also allows for manipulating some of the host's hardware,
7792	such as global USB device filters and host interface networking.
7793
7794	</desc>
7795	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7796	<desc>List of DVD drives available on the host.</desc>
7797	</attribute>
7798
7799	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7800	<desc>List of floppy drives available on the host.</desc>
7801	</attribute>
7802
7803	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7804	<desc>
7805	List of USB devices currently attached to the host.
7806	Once a new device is physically attached to the host computer,
7807	it appears in this list and remains there until detached.
7808
7809	<note>
7810	If USB functionality is not available in the given edition of
7811	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7812	</note>
7813	</desc>
7814	</attribute>
7815
7816	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7817	<desc>
7818	List of USB device filters in action.
7819	When a new device is physically attached to the host computer,
7820	filters from this list are applied to it (in order they are stored
7821	in the list). The first matched filter will determine the
7822	<link to="IHostUSBDeviceFilter::action">action</link>
7823	performed on the device.
7824
7825	Unless the device is ignored by these filters, filters of all
7826	currently running virtual machines
7827	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7828
7829	<note>
7830	If USB functionality is not available in the given edition of
7831	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7832	</note>
7833
7834	<see><link to="IHostUSBDeviceFilter"/>,
7835	<link to="USBDeviceState"/></see>
7836	</desc>
7837	</attribute>
7838
7839	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7840	<desc>List of host network interfaces currently defined on the host.</desc>
7841	</attribute>
7842
7843	<attribute name="processorCount" type="unsigned long" readonly="yes">
7844	<desc>Number of (logical) CPUs installed in the host system.</desc>
7845	</attribute>
7846
7847	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7848	<desc>Number of (logical) CPUs online in the host system.</desc>
7849	</attribute>
7850
7851	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7852	<desc>Number of physical processor cores installed in the host system.</desc>
7853	</attribute>
7854
7855	<method name="getProcessorSpeed">
7856	<desc>Query the (approximate) maximum speed of a specified host CPU in
7857	Megahertz.
7858	</desc>
7859	<param name="cpuId" type="unsigned long" dir="in">
7860	<desc>
7861	Identifier of the CPU.
7862	</desc>
7863	</param>
7864	<param name="speed" type="unsigned long" dir="return">
7865	<desc>
7866	Speed value. 0 is returned if value is not known or @a cpuId is
7867	invalid.
7868	</desc>
7869	</param>
7870	</method>
7871
7872	<method name="getProcessorFeature">
7873	<desc>Query whether a CPU feature is supported or not.</desc>
7874	<param name="feature" type="ProcessorFeature" dir="in">
7875	<desc>
7876	CPU Feature identifier.
7877	</desc>
7878	</param>
7879	<param name="supported" type="boolean" dir="return">
7880	<desc>
7881	Feature is supported or not.
7882	</desc>
7883	</param>
7884	</method>
7885
7886	<method name="getProcessorDescription">
7887	<desc>Query the model string of a specified host CPU.
7888	</desc>
7889	<param name="cpuId" type="unsigned long" dir="in">
7890	<desc>
7891	Identifier of the CPU.
7892	<note>
7893	The current implementation might not necessarily return the
7894	description for this exact CPU.
7895	</note>
7896	</desc>
7897	</param>
7898	<param name="description" type="wstring" dir="return">
7899	<desc>
7900	Model string. An empty string is returned if value is not known or
7901	@a cpuId is invalid.
7902	</desc>
7903	</param>
7904	</method>
7905
7906	<method name="getProcessorCPUIDLeaf">
7907	<desc>
7908	Returns the CPU cpuid information for the specified leaf.
7909	</desc>
7910	<param name="cpuId" type="unsigned long" dir="in">
7911	<desc>
7912	Identifier of the CPU. The CPU most be online.
7913	<note>
7914	The current implementation might not necessarily return the
7915	description for this exact CPU.
7916	</note>
7917	</desc>
7918	</param>
7919	<param name="leaf" type="unsigned long" dir="in">
7920	<desc>
7921	CPUID leaf index (eax).
7922	</desc>
7923	</param>
7924	<param name="subLeaf" type="unsigned long" dir="in">
7925	<desc>
7926	CPUID leaf sub index (ecx). This currently only applies to cache
7927	information on Intel CPUs. Use 0 if retrieving values for
7928	<link to="IMachine::setCPUIDLeaf"/>.
7929	</desc>
7930	</param>
7931	<param name="valEax" type="unsigned long" dir="out">
7932	<desc>
7933	CPUID leaf value for register eax.
7934	</desc>
7935	</param>
7936	<param name="valEbx" type="unsigned long" dir="out">
7937	<desc>
7938	CPUID leaf value for register ebx.
7939	</desc>
7940	</param>
7941	<param name="valEcx" type="unsigned long" dir="out">
7942	<desc>
7943	CPUID leaf value for register ecx.
7944	</desc>
7945	</param>
7946	<param name="valEdx" type="unsigned long" dir="out">
7947	<desc>
7948	CPUID leaf value for register edx.
7949	</desc>
7950	</param>
7951	</method>
7952
7953	<attribute name="memorySize" type="unsigned long" readonly="yes">
7954	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7955	</attribute>
7956
7957	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7958	<desc>Available system memory in the host system.</desc>
7959	</attribute>
7960
7961	<attribute name="operatingSystem" type="wstring" readonly="yes">
7962	<desc>Name of the host system's operating system.</desc>
7963	</attribute>
7964
7965	<attribute name="OSVersion" type="wstring" readonly="yes">
7966	<desc>Host operating system's version string.</desc>
7967	</attribute>
7968
7969	<attribute name="UTCTime" type="long long" readonly="yes">
7970	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7971	</attribute>
7972
7973	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
7974	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7975	</attribute>
7976
7977	<method name="createHostOnlyNetworkInterface">
7978	<desc>
7979	Creates a new adapter for Host Only Networking.
7980	<result name="E_INVALIDARG">
7981	Host network interface @a name already exists.
7982	</result>
7983	</desc>
7984	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7985	<desc>
7986	Created host interface object.
7987	</desc>
7988	</param>
7989	<param name="progress" type="IProgress" dir="return">
7990	<desc>
7991	Progress object to track the operation completion.
7992	</desc>
7993	</param>
7994	</method>
7995
7996	<method name="removeHostOnlyNetworkInterface">
7997	<desc>
7998	Removes the given Host Only Networking interface.
7999	<result name="VBOX_E_OBJECT_NOT_FOUND">
8000	No host network interface matching @a id found.
8001	</result>
8002	</desc>
8003	<param name="id" type="uuid" mod="string" dir="in">
8004	<desc>
8005	Adapter GUID.
8006	</desc>
8007	</param>
8008	<param name="progress" type="IProgress" dir="return">
8009	<desc>
8010	Progress object to track the operation completion.
8011	</desc>
8012	</param>
8013	</method>
8014
8015	<method name="createUSBDeviceFilter">
8016	<desc>
8017	Creates a new USB device filter. All attributes except
8018	the filter name are set to empty (any match),
8019	<i>active</i> is @c false (the filter is not active).
8020
8021	The created filter can be added to the list of filters using
8022	<link to="#insertUSBDeviceFilter"/>.
8023
8024	<see><link to="#USBDeviceFilters"/></see>
8025	</desc>
8026	<param name="name" type="wstring" dir="in">
8027	<desc>
8028	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8029	</desc>
8030	</param>
8031	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8032	<desc>Created filter object.</desc>
8033	</param>
8034	</method>
8035
8036	<method name="insertUSBDeviceFilter">
8037	<desc>
8038	Inserts the given USB device to the specified position
8039	in the list of filters.
8040
8041	Positions are numbered starting from @c 0. If the specified
8042	position is equal to or greater than the number of elements in
8043	the list, the filter is added at the end of the collection.
8044
8045	<note>
8046	Duplicates are not allowed, so an attempt to insert a
8047	filter already in the list is an error.
8048	</note>
8049	<note>
8050	If USB functionality is not available in the given edition of
8051	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8052	</note>
8053
8054	<see><link to="#USBDeviceFilters"/></see>
8055
8056	<result name="VBOX_E_INVALID_OBJECT_STATE">
8057	USB device filter is not created within this VirtualBox instance.
8058	</result>
8059	<result name="E_INVALIDARG">
8060	USB device filter already in list.
8061	</result>
8062
8063	</desc>
8064	<param name="position" type="unsigned long" dir="in">
8065	<desc>Position to insert the filter to.</desc>
8066	</param>
8067	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8068	<desc>USB device filter to insert.</desc>
8069	</param>
8070	</method>
8071
8072	<method name="removeUSBDeviceFilter">
8073	<desc>
8074	Removes a USB device filter from the specified position in the
8075	list of filters.
8076
8077	Positions are numbered starting from @c 0. Specifying a
8078	position equal to or greater than the number of elements in
8079	the list will produce an error.
8080
8081	<note>
8082	If USB functionality is not available in the given edition of
8083	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8084	</note>
8085
8086	<see><link to="#USBDeviceFilters"/></see>
8087
8088	<result name="E_INVALIDARG">
8089	USB device filter list empty or invalid @a position.
8090	</result>
8091
8092	</desc>
8093	<param name="position" type="unsigned long" dir="in">
8094	<desc>Position to remove the filter from.</desc>
8095	</param>
8096	</method>
8097
8098	<method name="findHostDVDDrive">
8099	<desc>
8100	Searches for a host DVD drive with the given @c name.
8101
8102	<result name="VBOX_E_OBJECT_NOT_FOUND">
8103	Given @c name does not correspond to any host drive.
8104	</result>
8105
8106	</desc>
8107	<param name="name" type="wstring" dir="in">
8108	<desc>Name of the host drive to search for</desc>
8109	</param>
8110	<param name="drive" type="IMedium" dir="return">
8111	<desc>Found host drive object</desc>
8112	</param>
8113	</method>
8114
8115	<method name="findHostFloppyDrive">
8116	<desc>
8117	Searches for a host floppy drive with the given @c name.
8118
8119	<result name="VBOX_E_OBJECT_NOT_FOUND">
8120	Given @c name does not correspond to any host floppy drive.
8121	</result>
8122
8123	</desc>
8124	<param name="name" type="wstring" dir="in">
8125	<desc>Name of the host floppy drive to search for</desc>
8126	</param>
8127	<param name="drive" type="IMedium" dir="return">
8128	<desc>Found host floppy drive object</desc>
8129	</param>
8130	</method>
8131
8132	<method name="findHostNetworkInterfaceByName">
8133	<desc>
8134	Searches through all host network interfaces for an interface with
8135	the given @c name.
8136	<note>
8137	The method returns an error if the given @c name does not
8138	correspond to any host network interface.
8139	</note>
8140	</desc>
8141	<param name="name" type="wstring" dir="in">
8142	<desc>Name of the host network interface to search for.</desc>
8143	</param>
8144	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8145	<desc>Found host network interface object.</desc>
8146	</param>
8147	</method>
8148	<method name="findHostNetworkInterfaceById">
8149	<desc>
8150	Searches through all host network interfaces for an interface with
8151	the given GUID.
8152	<note>
8153	The method returns an error if the given GUID does not
8154	correspond to any host network interface.
8155	</note>
8156	</desc>
8157	<param name="id" type="uuid" mod="string" dir="in">
8158	<desc>GUID of the host network interface to search for.</desc>
8159	</param>
8160	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8161	<desc>Found host network interface object.</desc>
8162	</param>
8163	</method>
8164	<method name="findHostNetworkInterfacesOfType">
8165	<desc>
8166	Searches through all host network interfaces and returns a list of interfaces of the specified type
8167	</desc>
8168	<param name="type" type="HostNetworkInterfaceType" dir="in">
8169	<desc>type of the host network interfaces to search for.</desc>
8170	</param>
8171	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8172	<desc>Found host network interface objects.</desc>
8173	</param>
8174	</method>
8175
8176	<method name="findUSBDeviceById">
8177	<desc>
8178	Searches for a USB device with the given UUID.
8179
8180	<result name="VBOX_E_OBJECT_NOT_FOUND">
8181	Given @c id does not correspond to any USB device.
8182	</result>
8183
8184	<see><link to="IUSBDevice::id"/></see>
8185	</desc>
8186	<param name="id" type="uuid" mod="string" dir="in">
8187	<desc>UUID of the USB device to search for.</desc>
8188	</param>
8189	<param name="device" type="IHostUSBDevice" dir="return">
8190	<desc>Found USB device object.</desc>
8191	</param>
8192	</method>
8193
8194	<method name="findUSBDeviceByAddress">
8195	<desc>
8196	Searches for a USB device with the given host address.
8197
8198	<result name="VBOX_E_OBJECT_NOT_FOUND">
8199	Given @c name does not correspond to any USB device.
8200	</result>
8201
8202	<see><link to="IUSBDevice::address"/></see>
8203	</desc>
8204	<param name="name" type="wstring" dir="in">
8205	<desc>
8206	Address of the USB device (as assigned by the host) to
8207	search for.
8208	</desc>
8209	</param>
8210	<param name="device" type="IHostUSBDevice" dir="return">
8211	<desc>Found USB device object.</desc>
8212	</param>
8213	</method>
8214
8215	<method name="generateMACAddress">
8216	<desc>
8217	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8218	</desc>
8219	<param name="address" type="wstring" dir="return">
8220	<desc>New Ethernet MAC address.</desc>
8221	</param>
8222	</method>
8223
8224	</interface>
8225
8226	<!--
8227	// ISystemProperties
8228	/////////////////////////////////////////////////////////////////////////
8229	-->
8230
8231	<interface
8232	name="ISystemProperties"
8233	extends="$unknown"
8234	uuid="1d7aca29-97f0-4287-9874-a60ec4f80ea6"
8235	wsmap="managed"
8236	>
8237	<desc>
8238	The ISystemProperties interface represents global properties of the given
8239	VirtualBox installation.
8240
8241	These properties define limits and default values for various attributes
8242	and parameters. Most of the properties are read-only, but some can be
8243	changed by a user.
8244	</desc>
8245
8246	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8247	<desc>Minimum guest system memory in Megabytes.</desc>
8248	</attribute>
8249
8250	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8251	<desc>Maximum guest system memory in Megabytes.</desc>
8252	</attribute>
8253
8254	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8255	<desc>Minimum guest video memory in Megabytes.</desc>
8256	</attribute>
8257
8258	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8259	<desc>Maximum guest video memory in Megabytes.</desc>
8260	</attribute>
8261
8262	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8263	<desc>Minimum CPU count.</desc>
8264	</attribute>
8265
8266	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8267	<desc>Maximum CPU count.</desc>
8268	</attribute>
8269
8270	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8271	<desc>Maximum of monitors which could be connected.</desc>
8272	</attribute>
8273
8274	<attribute name="infoVDSize" type="long long" readonly="yes">
8275	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8276	does not reflect the limits of any virtual disk image format.</desc>
8277	</attribute>
8278
8279	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8280	<desc>
8281	Maximum number of serial ports associated with every
8282	<link to="IMachine"/> instance.
8283	</desc>
8284	</attribute>
8285
8286	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8287	<desc>
8288	Maximum number of parallel ports associated with every
8289	<link to="IMachine"/> instance.
8290	</desc>
8291	</attribute>
8292
8293	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8294	<desc>
8295	Maximum device position in the boot order. This value corresponds
8296	to the total number of devices a machine can boot from, to make it
8297	possible to include all possible devices to the boot list.
8298	<see><link to="IMachine::setBootOrder"/></see>
8299	</desc>
8300	</attribute>
8301
8302	<attribute name="defaultMachineFolder" type="wstring">
8303	<desc>
8304	Full path to the default directory used to create new or open
8305	existing machines when a machine settings file name contains no
8306	path.
8307
8308	Starting with VirtualBox 4.0, by default, this attribute contains
8309	the full path of folder named "VirtualBox VMs" in the user's
8310	home directory, which depends on the host platform.
8311
8312	When setting this attribute, a full path must be specified.
8313	Setting this property to @c null or an empty string or the
8314	special value "Machines" (for compatibility reasons) will restore
8315	that default value.
8316
8317	If the folder specified herein does not exist, it will be created
8318	automatically as needed.
8319
8320	<see>
8321	<link to="IVirtualBox::createMachine"/>,
8322	<link to="IVirtualBox::openMachine"/>
8323	</see>
8324	</desc>
8325	</attribute>
8326
8327	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8328	<desc>
8329	List of all medium storage formats supported by this VirtualBox
8330	installation.
8331
8332	Keep in mind that the medium format identifier
8333	(<link to="IMediumFormat::id"/>) used in other API calls like
8334	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8335	medium format is a case-insensitive string. This means that, for
8336	example, all of the following strings:
8337	<pre>
8338	"VDI"
8339	"vdi"
8340	"VdI"</pre>
8341	refer to the same medium format.
8342
8343	Note that the virtual medium framework is backend-based, therefore
8344	the list of supported formats depends on what backends are currently
8345	installed.
8346
8347	<see><link to="IMediumFormat"/></see>
8348	</desc>
8349	</attribute>
8350
8351	<attribute name="defaultHardDiskFormat" type="wstring">
8352	<desc>
8353	Identifier of the default medium format used by VirtualBox.
8354
8355	The medium format set by this attribute is used by VirtualBox
8356	when the medium format was not specified explicitly. One example is
8357	<link to="IVirtualBox::createHardDisk"/> with the empty
8358	format argument. A more complex example is implicit creation of
8359	differencing media when taking a snapshot of a virtual machine:
8360	this operation will try to use a format of the parent medium first
8361	and if this format does not support differencing media the default
8362	format specified by this argument will be used.
8363
8364	The list of supported medium formats may be obtained by the
8365	<link to="#mediumFormats"/> call. Note that the default medium
8366	format must have a capability to create differencing media;
8367	otherwise operations that create media implicitly may fail
8368	unexpectedly.
8369
8370	The initial value of this property is <tt>"VDI"</tt> in the current
8371	version of the VirtualBox product, but may change in the future.
8372
8373	<note>
8374	Setting this property to @c null or empty string will restore the
8375	initial value.
8376	</note>
8377
8378	<see>
8379	<link to="#mediumFormats"/>,
8380	<link to="IMediumFormat::id"/>,
8381	<link to="IVirtualBox::createHardDisk"/>
8382	</see>
8383	</desc>
8384	</attribute>
8385
8386	<attribute name="freeDiskSpaceWarning" type="long long">
8387	<desc>Issue a warning if the free disk space is below (or in some disk
8388	intensive operation is expected to go below) the given size in
8389	bytes.</desc>
8390	</attribute>
8391
8392	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8393	<desc>Issue a warning if the free disk space is below (or in some disk
8394	intensive operation is expected to go below) the given percentage.</desc>
8395	</attribute>
8396
8397	<attribute name="freeDiskSpaceError" type="long long">
8398	<desc>Issue an error if the free disk space is below (or in some disk
8399	intensive operation is expected to go below) the given size in
8400	bytes.</desc>
8401	</attribute>
8402
8403	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8404	<desc>Issue an error if the free disk space is below (or in some disk
8405	intensive operation is expected to go below) the given percentage.</desc>
8406	</attribute>
8407
8408	<attribute name="VRDEAuthLibrary" type="wstring">
8409	<desc>
8410	Library that provides authentication for Remote Desktop clients. The library
8411	is used if a virtual machine's authentication type is set to "external"
8412	in the VM RemoteDisplay configuration.
8413
8414	The system library extension (".DLL" or ".so") must be omitted.
8415	A full path can be specified; if not, then the library must reside on the
8416	system's default library path.
8417
8418	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8419	of that name in one of the default VirtualBox library directories.
8420
8421	For details about VirtualBox authentication libraries and how to implement
8422	them, please refer to the VirtualBox manual.
8423
8424	<note>
8425	Setting this property to @c null or empty string will restore the
8426	initial value.
8427	</note>
8428	</desc>
8429	</attribute>
8430
8431	<attribute name="webServiceAuthLibrary" type="wstring">
8432	<desc>
8433	Library that provides authentication for webservice clients. The library
8434	is used if a virtual machine's authentication type is set to "external"
8435	in the VM RemoteDisplay configuration and will be called from
8436	within the <link to="IWebsessionManager::logon" /> implementation.
8437
8438	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8439	there is no per-VM setting for this, as the webservice is a global
8440	resource (if it is running). Only for this setting (for the webservice),
8441	setting this value to a literal <tt>"null"</tt> string disables authentication,
8442	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8443	no matter what user name and password are supplied.
8444
8445	The initial value of this property is <tt>"VBoxAuth"</tt>,
8446	meaning that the webservice will use the same authentication
8447	library that is used by default for VRDE (again, see
8448	<link to="ISystemProperties::VRDEAuthLibrary" />).
8449	The format and calling convention of authentication libraries
8450	is the same for the webservice as it is for VRDE.
8451
8452	<note>
8453	Setting this property to @c null or empty string will restore the
8454	initial value.
8455	</note>
8456	</desc>
8457	</attribute>
8458
8459	<attribute name="defaultVRDEExtPack" type="wstring">
8460	<desc>
8461	The name of the extension pack providing the default VRDE.
8462
8463	This attribute is for choosing between multiple extension packs
8464	providing VRDE. If only one is installed, it will automatically be the
8465	default one. The attribute value can be empty if no VRDE extension
8466	pack is installed.
8467
8468	For details about VirtualBox Remote Desktop Extension and how to
8469	implement one, please refer to the VirtualBox SDK.
8470	</desc>
8471	</attribute>
8472
8473	<attribute name="logHistoryCount" type="unsigned long">
8474	<desc>
8475	This value specifies how many old release log files are kept.
8476	</desc>
8477	</attribute>
8478
8479	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8480	<desc>This value hold the default audio driver for the current
8481	system.</desc>
8482	</attribute>
8483
8484	<attribute name="autostartDatabasePath" type="wstring">
8485	<desc>
8486	The path to the autostart database. Depending on the host this might
8487	be a filesystem path or something else.
8488	</desc>
8489	</attribute>
8490
8491	<attribute name="defaultAdditionsISO" type="wstring">
8492	<desc>
8493	The path to the default Guest Additions ISO image. Can be empty if
8494	the location is not known in this installation.
8495	</desc>
8496	</attribute>
8497
8498	<method name="getMaxNetworkAdapters">
8499	<desc>
8500	Maximum total number of network adapters associated with every
8501	<link to="IMachine"/> instance.
8502	</desc>
8503
8504	<param name="chipset" type="ChipsetType" dir="in">
8505	<desc>The chipset type to get the value for.</desc>
8506	</param>
8507
8508
8509	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8510	<desc>The maximum total number of network adapters allowed.</desc>
8511	</param>
8512
8513	</method>
8514
8515	<method name="getMaxNetworkAdaptersOfType">
8516	<desc>
8517	Maximum number of network adapters of a given attachment type,
8518	associated with every <link to="IMachine"/> instance.
8519	</desc>
8520
8521	<param name="chipset" type="ChipsetType" dir="in">
8522	<desc>The chipset type to get the value for.</desc>
8523	</param>
8524
8525	<param name="type" type="NetworkAttachmentType" dir="in">
8526	<desc>Type of attachment.</desc>
8527	</param>
8528
8529	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8530	<desc>The maximum number of network adapters allowed for
8531	particular chipset and attachment type.</desc>
8532	</param>
8533
8534	</method>
8535
8536
8537	<method name="getMaxDevicesPerPortForStorageBus">
8538	<desc>Returns the maximum number of devices which can be attached to a port
8539	for the given storage bus.</desc>
8540
8541	<param name="bus" type="StorageBus" dir="in">
8542	<desc>The storage bus type to get the value for.</desc>
8543	</param>
8544
8545	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8546	<desc>The maximum number of devices which can be attached to the port for the given
8547	storage bus.</desc>
8548	</param>
8549	</method>
8550
8551	<method name="getMinPortCountForStorageBus">
8552	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8553
8554	<param name="bus" type="StorageBus" dir="in">
8555	<desc>The storage bus type to get the value for.</desc>
8556	</param>
8557
8558	<param name="minPortCount" type="unsigned long" dir="return">
8559	<desc>The minimum number of ports for the given storage bus.</desc>
8560	</param>
8561	</method>
8562
8563	<method name="getMaxPortCountForStorageBus">
8564	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8565
8566	<param name="bus" type="StorageBus" dir="in">
8567	<desc>The storage bus type to get the value for.</desc>
8568	</param>
8569
8570	<param name="maxPortCount" type="unsigned long" dir="return">
8571	<desc>The maximum number of ports for the given storage bus.</desc>
8572	</param>
8573	</method>
8574
8575	<method name="getMaxInstancesOfStorageBus">
8576	<desc>Returns the maximum number of storage bus instances which
8577	can be configured for each VM. This corresponds to the number of
8578	storage controllers one can have. Value may depend on chipset type
8579	used.</desc>
8580
8581	<param name="chipset" type="ChipsetType" dir="in">
8582	<desc>The chipset type to get the value for.</desc>
8583	</param>
8584
8585	<param name="bus" type="StorageBus" dir="in">
8586	<desc>The storage bus type to get the value for.</desc>
8587	</param>
8588
8589	<param name="maxInstances" type="unsigned long" dir="return">
8590	<desc>The maximum number of instances for the given storage bus.</desc>
8591	</param>
8592	</method>
8593
8594	<method name="getDeviceTypesForStorageBus">
8595	<desc>Returns list of all the supported device types
8596	(<link to="DeviceType"/>) for the given type of storage
8597	bus.</desc>
8598
8599	<param name="bus" type="StorageBus" dir="in">
8600	<desc>The storage bus type to get the value for.</desc>
8601	</param>
8602
8603	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8604	<desc>The list of all supported device types for the given storage bus.</desc>
8605	</param>
8606	</method>
8607
8608	<method name="getDefaultIoCacheSettingForStorageController">
8609	<desc>Returns the default I/O cache setting for the
8610	given storage controller</desc>
8611
8612	<param name="controllerType" type="StorageControllerType" dir="in">
8613	<desc>The storage controller to the setting for.</desc>
8614	</param>
8615
8616	<param name="enabled" type="boolean" dir="return">
8617	<desc>Returned flag indicating the default value</desc>
8618	</param>
8619	</method>
8620	</interface>
8621
8622	<!--
8623	// IGuest
8624	/////////////////////////////////////////////////////////////////////////
8625	-->
8626
8627	<interface
8628	name="IGuestOSType" extends="$unknown"
8629	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8630	wsmap="struct"
8631	>
8632	<desc>
8633	</desc>
8634
8635	<attribute name="familyId" type="wstring" readonly="yes">
8636	<desc>Guest OS family identifier string.</desc>
8637	</attribute>
8638
8639	<attribute name="familyDescription" type="wstring" readonly="yes">
8640	<desc>Human readable description of the guest OS family.</desc>
8641	</attribute>
8642
8643	<attribute name="id" type="wstring" readonly="yes">
8644	<desc>Guest OS identifier string.</desc>
8645	</attribute>
8646
8647	<attribute name="description" type="wstring" readonly="yes">
8648	<desc>Human readable description of the guest OS.</desc>
8649	</attribute>
8650
8651	<attribute name="is64Bit" type="boolean" readonly="yes">
8652	<desc>Returns @c true if the given OS is 64-bit</desc>
8653	</attribute>
8654
8655	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8656	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8657	</attribute>
8658
8659	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8660	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8661	</attribute>
8662
8663	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8664	<desc>Recommended RAM size in Megabytes.</desc>
8665	</attribute>
8666
8667	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8668	<desc>Recommended video RAM size in Megabytes.</desc>
8669	</attribute>
8670
8671	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8672	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8673	</attribute>
8674
8675	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8676	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8677	</attribute>
8678
8679	<attribute name="recommendedHDD" type="long long" readonly="yes">
8680	<desc>Recommended hard disk size in bytes.</desc>
8681	</attribute>
8682
8683	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8684	<desc>Returns recommended network adapter for this OS type.</desc>
8685	</attribute>
8686
8687	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8688	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8689	</attribute>
8690
8691	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8692	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8693	</attribute>
8694
8695	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8696	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8697	</attribute>
8698
8699	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8700	<desc>Recommended storage controller type for HD drives.</desc>
8701	</attribute>
8702
8703	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8704	<desc>Recommended storage bus type for HD drives.</desc>
8705	</attribute>
8706
8707	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8708	<desc>Recommended firmware type.</desc>
8709	</attribute>
8710
8711	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8712	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8713	</attribute>
8714
8715	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8716	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8717	</attribute>
8718
8719	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8720	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8721	</attribute>
8722
8723	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8724	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8725	</attribute>
8726
8727	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8728	<desc>Recommended chipset type.</desc>
8729	</attribute>
8730
8731	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8732	<desc>Recommended audio type.</desc>
8733	</attribute>
8734
8735	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8736	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8737	</attribute>
8738
8739	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8740	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8741	</attribute>
8742
8743	</interface>
8744
8745	<enum
8746	name="AdditionsFacilityType"
8747	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8748	>
8749	<desc>
8750	Guest Additions facility IDs.
8751	</desc>
8752
8753	<const name="None" value="0">
8754	<desc>No/invalid facility.</desc>
8755	</const>
8756	<const name="VBoxGuestDriver" value="20">
8757	<desc>VirtualBox base driver (VBoxGuest).</desc>
8758	</const>
8759	<const name="AutoLogon" value="90">
8760	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8761	</const>
8762	<const name="VBoxService" value="100">
8763	<desc>VirtualBox system service (VBoxService).</desc>
8764	</const>
8765	<const name="VBoxTrayClient" value="101">
8766	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8767	</const>
8768	<const name="Seamless" value="1000">
8769	<desc>Seamless guest desktop integration.</desc>
8770	</const>
8771	<const name="Graphics" value="1100">
8772	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8773	are not immediately acted on and guest display resizes are probably not initiated by
8774	the guest additions.
8775	</desc>
8776	</const>
8777	<const name="All" value="2147483646">
8778	<desc>All facilities selected.</desc>
8779	</const>
8780	</enum>
8781
8782	<enum
8783	name="AdditionsFacilityClass"
8784	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8785	>
8786	<desc>
8787	Guest Additions facility classes.
8788	</desc>
8789
8790	<const name="None" value="0">
8791	<desc>No/invalid class.</desc>
8792	</const>
8793	<const name="Driver" value="10">
8794	<desc>Driver.</desc>
8795	</const>
8796	<const name="Service" value="30">
8797	<desc>System service.</desc>
8798	</const>
8799	<const name="Program" value="50">
8800	<desc>Program.</desc>
8801	</const>
8802	<const name="Feature" value="100">
8803	<desc>Feature.</desc>
8804	</const>
8805	<const name="ThirdParty" value="999">
8806	<desc>Third party.</desc>
8807	</const>
8808	<const name="All" value="2147483646">
8809	<desc>All facility classes selected.</desc>
8810	</const>
8811	</enum>
8812
8813	<enum
8814	name="AdditionsFacilityStatus"
8815	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8816	>
8817	<desc>
8818	Guest Additions facility states.
8819	</desc>
8820
8821	<const name="Inactive" value="0">
8822	<desc>Facility is not active.</desc>
8823	</const>
8824	<const name="Paused" value="1">
8825	<desc>Facility has been paused.</desc>
8826	</const>
8827	<const name="PreInit" value="20">
8828	<desc>Facility is preparing to initialize.</desc>
8829	</const>
8830	<const name="Init" value="30">
8831	<desc>Facility is initializing.</desc>
8832	</const>
8833	<const name="Active" value="50">
8834	<desc>Facility is up and running.</desc>
8835	</const>
8836	<const name="Terminating" value="100">
8837	<desc>Facility is shutting down.</desc>
8838	</const>
8839	<const name="Terminated" value="101">
8840	<desc>Facility successfully shut down.</desc>
8841	</const>
8842	<const name="Failed" value="800">
8843	<desc>Facility failed to start.</desc>
8844	</const>
8845	<const name="Unknown" value="999">
8846	<desc>Facility status is unknown.</desc>
8847	</const>
8848	</enum>
8849
8850	<interface
8851	name="IAdditionsFacility" extends="$unknown"
8852	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8853	wsmap="struct"
8854	>
8855	<desc>
8856	Structure representing a Guest Additions facility.
8857	</desc>
8858
8859	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8860	<desc>The class this facility is part of.</desc>
8861	</attribute>
8862
8863	<attribute name="lastUpdated" type="long long" readonly="yes">
8864	<desc>
8865	Time stamp of the last status update,
8866	in milliseconds since 1970-01-01 UTC.
8867	</desc>
8868	</attribute>
8869
8870	<attribute name="name" type="wstring" readonly="yes">
8871	<desc>The facility's friendly name.</desc>
8872	</attribute>
8873
8874	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8875	<desc>The current status.</desc>
8876	</attribute>
8877
8878	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8879	<desc>The facility's type ID.</desc>
8880	</attribute>
8881	</interface>
8882
8883	<enum
8884	name="AdditionsRunLevelType"
8885	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8886	>
8887	<desc>
8888	Guest Additions run level type.
8889	</desc>
8890
8891	<const name="None" value="0">
8892	<desc>Guest Additions are not loaded.</desc>
8893	</const>
8894	<const name="System" value="1">
8895	<desc>Guest drivers are loaded.</desc>
8896	</const>
8897	<const name="Userland" value="2">
8898	<desc>Common components (such as application services) are loaded.</desc>
8899	</const>
8900	<const name="Desktop" value="3">
8901	<desc>Per-user desktop components are loaded.</desc>
8902	</const>
8903	</enum>
8904
8905	<enum
8906	name="AdditionsUpdateFlag"
8907	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8908	>
8909	<desc>
8910	Guest Additions update flags.
8911	</desc>
8912
8913	<const name="None" value="0">
8914	<desc>No flag set.</desc>
8915	</const>
8916	<const name="WaitForUpdateStartOnly" value="1">
8917	<desc>Starts the regular updating process and waits until the
8918	actual Guest Additions update inside the guest was started.
8919	This can be necessary due to needed interaction with the guest
8920	OS during the installation phase.</desc>
8921	</const>
8922	</enum>
8923
8924	<enum
8925	name="FileSeekType"
8926	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8927	>
8928	<desc>
8929	File seeking types.
8930	</desc>
8931
8932	<const name="Set" value="0">
8933	<desc>Seek from the start of the file.</desc>
8934	</const>
8935	<const name="Current" value="1">
8936	<desc>Seek from the current file position.</desc>
8937	</const>
8938	</enum>
8939
8940	<enum
8941	name="ProcessInputFlag"
8942	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8943	>
8944	<desc>
8945	Guest process input flags.
8946	</desc>
8947	<const name="None" value="0">
8948	<desc>No flag set.</desc>
8949	</const>
8950	<const name="EndOfFile" value="1">
8951	<desc>End of file (input) reached.</desc>
8952	</const>
8953	</enum>
8954
8955	<enum
8956	name="ProcessOutputFlag"
8957	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8958	>
8959	<desc>
8960	Guest process output flags for specifying which
8961	type of output to retrieve.
8962	</desc>
8963	<const name="None" value="0">
8964	<desc>No flags set. Get output from stdout.</desc>
8965	</const>
8966	<const name="StdErr" value="1">
8967	<desc>Get output from stderr.</desc>
8968	</const>
8969	</enum>
8970
8971	<enum
8972	name="ProcessWaitForFlag"
8973	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
8974	>
8975	<desc>
8976	Process waiting flags. Multiple flags can be combined.
8977	</desc>
8978
8979	<const name="None" value="0">
8980	<desc>No waiting flags specified. Do not use this.</desc>
8981	</const>
8982	<const name="Start" value="1">
8983	<desc>Wait for the process being started.</desc>
8984	</const>
8985	<const name="Terminate" value="2">
8986	<desc>Wait for the process being terminated.</desc>
8987	</const>
8988	<const name="StdIn" value="4">
8989	<desc>Wait for stdin becoming available.</desc>
8990	</const>
8991	<const name="StdOut" value="8">
8992	<desc>Wait for data becoming available on stdout.</desc>
8993	</const>
8994	<const name="StdErr" value="16">
8995	<desc>Wait for data becoming available on stderr.</desc>
8996	</const>
8997	</enum>
8998
8999	<enum
9000	name="ProcessWaitResult"
9001	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9002	>
9003	<desc>
9004	Process waiting results. Depending on the process waiting flags (for
9005	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9006	can vary based on the processes' current status.
9007
9008	To wait for a gust process to terminate after it has been
9009	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9010	one would specify ProcessWaitResult_Terminate.
9011
9012	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9013	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9014	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9015	ProcessWaitResult_StdErr.
9016	</desc>
9017
9018	<const name="None" value="0">
9019	<desc>No result was returned. Not being used.</desc>
9020	</const>
9021	<const name="Start" value="1">
9022	<desc>The process has been started.</desc>
9023	</const>
9024	<const name="Terminate" value="2">
9025	<desc>The process has been terminated.</desc>
9026	</const>
9027	<const name="Status" value="3">
9028	<desc>
9029	The process has changed its status. The status then can
9030	be retrieved via <link to="IProcess::status"/>.
9031	</desc>
9032	</const>
9033	<const name="Error" value="4">
9034	<desc>Error while executing the process.</desc>
9035	</const>
9036	<const name="Timeout" value="5">
9037	<desc>
9038	The waiting operation timed out. This also will happen
9039	when no event has been occured matching the
9040	current waiting flags in a <link to="IProcess::waitFor"/> call.
9041	</desc>
9042	</const>
9043	<const name="StdIn" value="6">
9044	<desc>
9045	The process signalled that stdin became available for writing
9046	and that the process awaits input now.</desc>
9047	</const>
9048	<const name="StdOut" value="7">
9049	<desc>Data on stdout became available for reading.</desc>
9050	</const>
9051	<const name="StdErr" value="8">
9052	<desc>Data on stderr became available for reading.</desc>
9053	</const>
9054	<const name="WaitFlagNotSupported" value="9">
9055	<desc>
9056	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9057	is not supported by the guest.
9058	</desc>
9059	</const>
9060	</enum>
9061
9062	<enum
9063	name="CopyFileFlag"
9064	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9065	>
9066	<desc>
9067	File copying flags.
9068	</desc>
9069	<const name="None" value="0">
9070	<desc>No flag set.</desc>
9071	</const>
9072	<const name="Recursive" value="1">
9073	<desc>Copy directories recursively.</desc>
9074	</const>
9075	<const name="Update" value="2">
9076	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9077	</const>
9078	<const name="FollowLinks" value="4">
9079	<desc>Follow symbolic links.</desc>
9080	</const>
9081	</enum>
9082
9083	<enum
9084	name="DirectoryCreateFlag"
9085	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9086	>
9087	<desc>
9088	Directory creation flags.
9089	</desc>
9090	<const name="None" value="0">
9091	<desc>No flag set.</desc>
9092	</const>
9093	<const name="Parents" value="1">
9094	<desc>No error if existing, make parent directories as needed.</desc>
9095	</const>
9096	</enum>
9097
9098	<enum
9099	name="DirectoryRemoveRecFlag"
9100	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9101	>
9102	<desc>
9103	Directory recursive removement flags.
9104	</desc>
9105
9106	<const name="None" value="0">
9107	<desc>No flag set.</desc>
9108	</const>
9109	<const name="ContentAndDir" value="1">
9110	<desc>Delete the content of the directory and the directory itself.</desc>
9111	</const>
9112	<const name="ContentOnly" value="2">
9113	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9114	</const>
9115	</enum>
9116
9117	<enum
9118	name="PathRenameFlag"
9119	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9120	>
9121	<desc>
9122	Path renaming flags.
9123	</desc>
9124
9125	<const name="None" value="0">
9126	<desc>No flag set.</desc>
9127	</const>
9128	<const name="NoReplace" value="1">
9129	<desc>Do not replace anything.</desc>
9130	</const>
9131	<const name="Replace" value="2">
9132	<desc>This will replace attempt any target which isn't a directory.</desc>
9133	</const>
9134	<const name="NoSymlinks" value="4">
9135	<desc>Don't allow symbolic links as part of the path.</desc>
9136	</const>
9137	</enum>
9138
9139	<enum
9140	name="ProcessCreateFlag"
9141	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9142	>
9143	<desc>
9144	Guest process execution flags.
9145	</desc>
9146
9147	<const name="None" value="0">
9148	<desc>No flag set.</desc>
9149	</const>
9150	<const name="WaitForProcessStartOnly" value="1">
9151	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9152	process itself then uses an infinite timeout.</desc>
9153	</const>
9154	<const name="IgnoreOrphanedProcesses" value="2">
9155	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9156	</const>
9157	<const name="Hidden" value="4">
9158	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9159	</const>
9160	<const name="NoProfile" value="8">
9161	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9162	</const>
9163	<const name="WaitForStdOut" value="16">
9164	<desc>The guest process waits until all data from stdout is read out.</desc>
9165	</const>
9166	<const name="WaitForStdErr" value="32">
9167	<desc>The guest process waits until all data from stderr is read out.</desc>
9168	</const>
9169	<const name="ExpandArguments" value="64">
9170	<desc>Expands environment variables in process arguments.</desc>
9171	</const>
9172	</enum>
9173
9174	<enum
9175	name="ProcessPriority"
9176	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9177	>
9178	<desc>
9179	Process priorities.
9180	</desc>
9181
9182	<const name="Invalid" value="0">
9183	<desc>Invalid priority, do not use.</desc>
9184	</const>
9185	<const name="Default" value="1">
9186	<desc>Default process priority determined by the OS.</desc>
9187	</const>
9188	</enum>
9189
9190	<enum
9191	name="SymlinkType"
9192	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9193	>
9194	<desc>
9195	Symbolic link types.
9196	</desc>
9197
9198	<const name="Unknown" value="0">
9199	<desc>It is not known what is being targeted.</desc>
9200	</const>
9201	<const name="Directory" value="1">
9202	<desc>The link targets a directory.</desc>
9203	</const>
9204	<const name="File" value="2">
9205	<desc>The link targets a file (or whatever else).</desc>
9206	</const>
9207	</enum>
9208
9209	<enum
9210	name="SymlinkReadFlag"
9211	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9212	>
9213	<desc>
9214	Symbolic link reading flags.
9215	</desc>
9216
9217	<const name="None" value="0">
9218	<desc>No flags set.</desc>
9219	</const>
9220	<const name="NoSymlinks" value="1">
9221	<desc>Don't allow symbolic links as part of the path.</desc>
9222	</const>
9223	</enum>
9224
9225	<enum
9226	name="ProcessStatus"
9227	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9228	>
9229	<desc>
9230	Process execution statuses.
9231	</desc>
9232	<const name="Undefined" value="0">
9233	<desc>Process is in an undefined state.</desc>
9234	</const>
9235
9236	<const name="Starting" value="10">
9237	<desc>Process is being started.</desc>
9238	</const>
9239	<const name="Started" value="100">
9240	<desc>Process has been started.</desc>
9241	</const>
9242	<const name="Paused" value="110">
9243	<desc>Process has been paused.</desc>
9244	</const>
9245	<const name="Terminating" value="480">
9246	<desc>Process is being terminated.</desc>
9247	</const>
9248	<const name="TerminatedNormally" value="500">
9249	<desc>Process terminated normally.</desc>
9250	</const>
9251	<const name="TerminatedSignal" value="510">
9252	<desc>Process terminated via signal.</desc>
9253	</const>
9254	<const name="TerminatedAbnormally" value="511">
9255	<desc>Process terminated abnormally.</desc>
9256	</const>
9257	<const name="TimedOutKilled" value="512">
9258	<desc>Process timed out and was killed.</desc>
9259	</const>
9260	<const name="TimedOutAbnormally" value="513">
9261	<desc>Process timed out and was not killed successfully.</desc>
9262	</const>
9263	<const name="Down" value="600">
9264	<desc>Service/OS is stopping, process was killed.</desc>
9265	</const>
9266	<const name="Error" value="800">
9267	<desc>Something went wrong.</desc>
9268	</const>
9269	</enum>
9270
9271	<enum
9272	name="FsObjType"
9273	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9274	>
9275	<desc>
9276	File system object type.
9277	</desc>
9278
9279	<const name="Undefined" value="0">
9280	<desc>Type is undefined / unknown.</desc>
9281	</const>
9282	<const name="FIFO" value="1">
9283	<desc>Named pipe.</desc>
9284	</const>
9285	<const name="DevChar" value="10">
9286	<desc>Character device.</desc>
9287	</const>
9288	<const name="DevBlock" value="11">
9289	<desc>Block device.</desc>
9290	</const>
9291	<const name="Directory" value="50">
9292	<desc>Directory.</desc>
9293	</const>
9294	<const name="File" value="80">
9295	<desc>File.</desc>
9296	</const>
9297	<const name="Symlink" value="100">
9298	<desc>Symlink.</desc>
9299	</const>
9300	<const name="Socket" value="200">
9301	<desc>Socket.</desc>
9302	</const>
9303	<const name="Whiteout" value="400">
9304	<desc>Whiteout.</desc>
9305	</const>
9306	</enum>
9307
9308	<enum
9309	name="DragAndDropAction"
9310	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9311	>
9312	<desc>
9313	Possible actions within an Drag and Drop operation.
9314	</desc>
9315
9316	<const name="Ignore" value="0">
9317	<desc>Do nothing.</desc>
9318	</const>
9319
9320	<const name="Copy" value="1">
9321	<desc>Copy the item to the target.</desc>
9322	</const>
9323
9324	<const name="Move" value="2">
9325	<desc>Move the item to the target.</desc>
9326	</const>
9327
9328	<const name="Link" value="3">
9329	<desc>Link the item from within the target.</desc>
9330	</const>
9331	</enum>
9332
9333	<enum
9334	name="DirectoryOpenFlag"
9335	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9336	>
9337	<desc>
9338	Directory open flags.
9339	</desc>
9340	<const name="None" value="0">
9341	<desc>No flag set.</desc>
9342	</const>
9343	<const name="NoSymlinks" value="1">
9344	<desc>Don't allow symbolic links as part of the path.</desc>
9345	</const>
9346	</enum>
9347
9348	<interface
9349	name="IGuestSession" extends="$unknown"
9350	uuid="57eb82a8-822b-42c1-9d1c-5c54bc3d3250"
9351	wsmap="managed"
9352	>
9353	<desc>
9354	A guest session represents one impersonated user account on the guest, so
9355	every operation will use the same credentials specified when creating
9356	the session object via <link to="IGuest::createSession"/>.
9357
9358	There can be a maximum of 32 sessions at once per VM. Each session keeps
9359	track of its started guest processes, opened guest files or guest directories.
9360	To work on guest files or directories a guest session offers methods to open
9361	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9362	<link to="IGuestSession::directoryOpen"/> for example).
9363
9364	When done with either of these objects, including the guest session itself,
9365	use the appropriate close() method to let the object do its cleanup work.
9366
9367	Every guest session has its own environment variable block which gets
9368	automatically applied when starting a new guest process via
9369	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9370	To override (or unset) certain environment variables already set by the
9371	guest session, one can specify a per-process environment block when using
9372	one of the both above mentioned process creation calls.
9373	</desc>
9374
9375	<attribute name="user" type="wstring" readonly="yes">
9376	<desc>Returns the user name used by this session to impersonate
9377	users on the guest.
9378	</desc>
9379	</attribute>
9380
9381	<attribute name="domain" type="wstring" readonly="yes">
9382	<desc>Returns the domain name used by this session to impersonate
9383	users on the guest.
9384	</desc>
9385	</attribute>
9386
9387	<attribute name="name" type="wstring" readonly="yes">
9388	<desc>Returns the session's friendly name.</desc>
9389	</attribute>
9390
9391	<attribute name="id" type="unsigned long" readonly="yes">
9392	<desc>Returns the internal session ID.</desc>
9393	</attribute>
9394
9395	<attribute name="timeout" type="unsigned long" readonly="no">
9396	<desc>
9397	Returns the session timeout (in ms).
9398	<result name="E_NOTIMPL">
9399	The method is not implemented yet.
9400	</result>
9401	</desc>
9402	</attribute>
9403
9404	<attribute name="environment" type="wstring" safearray="yes">
9405	<desc>
9406	Returns the current session environment.
9407	</desc>
9408	</attribute>
9409
9410	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9411	<desc>
9412	Returns all current guest processes.
9413	</desc>
9414	</attribute>
9415
9416	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9417	<desc>
9418	Returns all currently opened guest directories.
9419	</desc>
9420	</attribute>
9421
9422	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9423	<desc>
9424	Returns all currently opened guest files.
9425	</desc>
9426	</attribute>
9427
9428	<method name="close">
9429	<desc>
9430	Closes this session. All opened guest directories, files and
9431	processes which are not referenced by clients anymore will be
9432	uninitialized.
9433	</desc>
9434	</method>
9435
9436	<method name="copyFrom">
9437	<desc>
9438	Copies a file from guest to the host.
9439
9440	<result name="VBOX_E_IPRT_ERROR">
9441	Error starting the copy operation.
9442	</result>
9443	</desc>
9444	<param name="source" type="wstring" dir="in">
9445	<desc>Source file on the guest to copy to the host.</desc>
9446	</param>
9447	<param name="dest" type="wstring" dir="in">
9448	<desc>Destination file name on the host.</desc>
9449	</param>
9450	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9451	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9452	</param>
9453	<param name="progress" type="IProgress" dir="return">
9454	<desc>Progress object to track the operation completion.</desc>
9455	</param>
9456	</method>
9457
9458	<method name="copyTo">
9459	<desc>
9460	Copies a file from host to the guest.
9461
9462	<result name="VBOX_E_IPRT_ERROR">
9463	Error starting the copy operation.
9464	</result>
9465	</desc>
9466	<param name="source" type="wstring" dir="in">
9467	<desc>Source file on the host to copy to the guest.</desc>
9468	</param>
9469	<param name="dest" type="wstring" dir="in">
9470	<desc>Destination file name on the guest.</desc>
9471	</param>
9472	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9473	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9474	</param>
9475	<param name="progress" type="IProgress" dir="return">
9476	<desc>Progress object to track the operation completion.</desc>
9477	</param>
9478	</method>
9479
9480	<method name="directoryCreate">
9481	<desc>
9482	Create a directory on the guest.
9483
9484	<result name="VBOX_E_IPRT_ERROR">
9485	Error while creating the directory.
9486	</result>
9487	</desc>
9488	<param name="path" type="wstring" dir="in">
9489	<desc>Full path of directory to create.</desc>
9490	</param>
9491	<param name="mode" type="unsigned long" dir="in">
9492	<desc>File creation mode.</desc>
9493	</param>
9494	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9495	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9496	</param>
9497	</method>
9498
9499	<method name="directoryCreateTemp">
9500	<desc>
9501	Create a temporary directory on the guest.
9502
9503	<result name="VBOX_E_NOT_SUPPORTED">
9504	The operation is not possible as requested on this particular
9505	guest type.
9506	</result>
9507	<result name="E_INVALIDARG">
9508	Invalid argument. This includes an incorrectly formatted template,
9509	or a non-absolute path.
9510	</result>
9511	<result name="VBOX_E_IPRT_ERROR">
9512	The temporary directory could not be created. Possible reasons
9513	include a non-existing path or an insecure path when the secure
9514	option was requested.
9515	</result>
9516	</desc>
9517	<param name="templateName" type="wstring" dir="in">
9518	<desc>Template for the name of the directory to create. This must
9519	contain at least one 'X' character. The first group of consecutive
9520	'X' characters in the template will be replaced by a random
9521	alphanumeric string to produce a unique name.</desc>
9522	</param>
9523	<param name="mode" type="unsigned long" dir="in">
9524	<desc>The mode of the directory to create. Use 0700 unless there are
9525	reasons not to. This parameter is ignored if "secure" is specified.
9526	</desc>
9527	</param>
9528	<param name="path" type="wstring" dir="in">
9529	<desc>The absolute path to create the temporary directory in.</desc>
9530	</param>
9531	<param name="secure" type="boolean" dir="in">
9532	<desc>Whether to fail if the directory can not be securely created.
9533	Currently this means that another unprivileged user cannot
9534	manipulate the path specified or remove the temporary directory
9535	after it has been created. Also causes the mode specified to be
9536	ignored. May not be supported on all guest types.</desc>
9537	</param>
9538	<param name="directory" type="wstring" dir="return">
9539	<desc>On success this will contain the name of the directory created
9540	with full path.</desc>
9541	</param>
9542	</method>
9543
9544	<method name="directoryExists">
9545	<desc>
9546	Checks whether a directory exists on the guest or not.
9547
9548	<result name="VBOX_E_IPRT_ERROR">
9549	Error while checking existence of the directory specified.
9550	</result>
9551	</desc>
9552	<param name="path" type="wstring" dir="in">
9553	<desc>Directory to check existence for.</desc>
9554	</param>
9555	<param name="exists" type="boolean" dir="return">
9556	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9557	</param>
9558	</method>
9559
9560	<method name="directoryOpen">
9561	<desc>
9562	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9563	can be used for further operations.
9564
9565	<result name="VBOX_E_OBJECT_NOT_FOUND">
9566	Directory to open was not found.
9567	</result>
9568	<result name="VBOX_E_IPRT_ERROR">
9569	Error while opening the directory.
9570	</result>
9571	</desc>
9572	<param name="path" type="wstring" dir="in">
9573	<desc>Full path to file to open.</desc>
9574	</param>
9575	<param name="filter" type="wstring" dir="in">
9576	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9577	</param>
9578	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9579	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9580	</param>
9581	<param name="directory" type="IGuestDirectory" dir="return">
9582	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9583	</param>
9584	</method>
9585
9586	<method name="directoryQueryInfo">
9587	<desc>
9588	Queries information of a directory on the guest.
9589
9590	<result name="VBOX_E_OBJECT_NOT_FOUND">
9591	Directory to query information for was not found.
9592	</result>
9593	<result name="VBOX_E_IPRT_ERROR">
9594	Error querying information.
9595	</result>
9596	</desc>
9597	<param name="path" type="wstring" dir="in">
9598	<desc>Directory to query information for.</desc>
9599	</param>
9600	<param name="info" type="IGuestFsObjInfo" dir="return">
9601	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9602	</param>
9603	</method>
9604
9605	<method name="directoryRemove">
9606	<desc>
9607	Removes a guest directory if not empty.
9608
9609	<result name="E_NOTIMPL">
9610	The method is not implemented yet.
9611	</result>
9612	</desc>
9613	<param name="path" type="wstring" dir="in">
9614	<desc>Full path of directory to remove.</desc>
9615	</param>
9616	</method>
9617
9618	<method name="directoryRemoveRecursive">
9619	<desc>
9620	Removes a guest directory recursively.
9621
9622	<result name="E_NOTIMPL">
9623	The method is not implemented yet.
9624	</result>
9625	</desc>
9626	<param name="path" type="wstring" dir="in">
9627	<desc>Full path of directory to remove recursively.</desc>
9628	</param>
9629	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9630	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
9631	</param>
9632	<param name="progress" type="IProgress" dir="return">
9633	<desc>Progress object to track the operation completion.</desc>
9634	</param>
9635	</method>
9636
9637	<method name="directoryRename">
9638	<desc>
9639	Renames a directory on the guest.
9640
9641	<result name="E_NOTIMPL">
9642	The method is not implemented yet.
9643	</result>
9644	</desc>
9645	<param name="source" type="wstring" dir="in">
9646	<desc>Source directory to rename.</desc>
9647	</param>
9648	<param name="dest" type="wstring" dir="in">
9649	<desc>Destination directory to rename the source to.</desc>
9650	</param>
9651	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9652	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9653	</param>
9654	</method>
9655
9656	<method name="directorySetACL">
9657	<desc>
9658	Sets the ACL (Access Control List) of a guest directory.
9659
9660	<result name="E_NOTIMPL">
9661	The method is not implemented yet.
9662	</result>
9663	</desc>
9664	<param name="path" type="wstring" dir="in">
9665	<desc>Full path of directory to set the ACL for.</desc>
9666	</param>
9667	<param name="acl" type="wstring" dir="in">
9668	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9669	</param>
9670	</method>
9671
9672	<method name="environmentClear">
9673	<desc>
9674	Clears (deletes) all session environment variables.
9675
9676	<result name="VBOX_E_IPRT_ERROR">
9677	Error while clearing the session environment variables.
9678	</result>
9679	</desc>
9680	</method>
9681
9682	<method name="environmentGet">
9683	<desc>
9684	Gets the value of a session environment variable.
9685
9686	<result name="VBOX_E_IPRT_ERROR">
9687	Error while getting the value of the session environment variable.
9688	</result>
9689	</desc>
9690	<param name="name" type="wstring" dir="in">
9691	<desc>Name of session environment variable to get the value for.</desc>
9692	</param>
9693	<param name="value" type="wstring" dir="return">
9694	<desc>
9695	Value of the session environment variable specified. If this variable
9696	does not exist and empty value will be returned.
9697	</desc>
9698	</param>
9699	</method>
9700
9701	<method name="environmentSet">
9702	<desc>
9703	Sets a session environment variable.
9704
9705	<result name="VBOX_E_IPRT_ERROR">
9706	Error while setting the session environment variable.
9707	</result>
9708	</desc>
9709	<param name="name" type="wstring" dir="in">
9710	<desc>Name of session environment variable to set.</desc>
9711	</param>
9712	<param name="value" type="wstring" dir="in">
9713	<desc>Value to set the session environment variable to.</desc>
9714	</param>
9715	</method>
9716
9717	<method name="environmentUnset">
9718	<desc>
9719	Unsets session environment variable.
9720
9721	<result name="VBOX_E_IPRT_ERROR">
9722	Error while unsetting the session environment variable.
9723	</result>
9724	</desc>
9725	<param name="name" type="wstring" dir="in">
9726	<desc>Name of session environment variable to unset (clear).</desc>
9727	</param>
9728	</method>
9729
9730	<method name="fileCreateTemp">
9731	<desc>
9732	Creates a temporary file on the guest.
9733
9734	<result name="VBOX_E_NOT_SUPPORTED">
9735	The operation is not possible as requested on this particular
9736	guest type.
9737	</result>
9738	<result name="E_INVALIDARG">
9739	Invalid argument. This includes an incorrectly formatted template,
9740	or a non-absolute path.
9741	</result>
9742	<result name="VBOX_E_IPRT_ERROR">
9743	The temporary file could not be created. Possible reasons include
9744	a non-existing path or an insecure path when the secure
9745	option was requested.
9746	</result>
9747	</desc>
9748	<param name="templateName" type="wstring" dir="in">
9749	<desc>Template for the name of the file to create. This must contain
9750	at least one 'X' character. The first group of consecutive 'X'
9751	characters in the template will be replaced by a random
9752	alphanumeric string to produce a unique name.
9753	</desc>
9754	</param>
9755	<param name="mode" type="unsigned long" dir="in">
9756	<desc>The mode of the file to create. Use 0700 unless there are
9757	reasons not to. This parameter is ignored if "secure" is specified.
9758	</desc>
9759	</param>
9760	<param name="path" type="wstring" dir="in">
9761	<desc>The absolute path to create the temporary file in.</desc>
9762	</param>
9763	<param name="secure" type="boolean" dir="in">
9764	<desc>Whether to fail if the file can not be securely created.
9765	Currently this means that another unprivileged user cannot
9766	manipulate the path specified or remove the temporary file after
9767	it has been created. Also causes the mode specified to be ignored.
9768	May not be supported on all guest types.</desc>
9769	</param>
9770	<param name="file" type="IGuestFile" dir="return">
9771	<desc>On success this will contain an open file object for the new
9772	temporary file.
9773	</desc>
9774	</param>
9775	</method>
9776
9777	<method name="fileExists">
9778	<desc>
9779	Checks whether a file exists on the guest or not.
9780
9781	<result name="VBOX_E_IPRT_ERROR">
9782	Error while checking existence of the file specified.
9783	</result>
9784	</desc>
9785	<param name="path" type="wstring" dir="in">
9786	<desc>File to check existence for.</desc>
9787	</param>
9788	<param name="exists" type="boolean" dir="return">
9789	<desc>Returns @c true if the file exists, @c false if not.</desc>
9790	</param>
9791	</method>
9792
9793	<method name="fileRemove">
9794	<desc>
9795	Removes a single file on the guest.
9796
9797	<result name="VBOX_E_OBJECT_NOT_FOUND">
9798	File to remove was not found.
9799	</result>
9800	<result name="VBOX_E_IPRT_ERROR">
9801	Error while removing the file.
9802	</result>
9803	</desc>
9804	<param name="path" type="wstring" dir="in">
9805	<desc>Path to the file to remove.</desc>
9806	</param>
9807	</method>
9808
9809	<method name="fileOpen">
9810	<desc>
9811	Opens a file and creates a <link to="IGuestFile"/> object that
9812	can be used for further operations.
9813
9814	<result name="VBOX_E_OBJECT_NOT_FOUND">
9815	File to open was not found.
9816	</result>
9817	<result name="VBOX_E_IPRT_ERROR">
9818	Error while opening the file.
9819	</result>
9820	</desc>
9821	<param name="path" type="wstring" dir="in">
9822	<desc>Full path to file to open.</desc>
9823	</param>
9824	<param name="openMode" type="wstring" dir="in">
9825	<desc>The file open mode.</desc>
9826	</param>
9827	<param name="disposition" type="wstring" dir="in">
9828	<desc>The file disposition.</desc>
9829	</param>
9830	<param name="creationMode" type="unsigned long" dir="in">
9831	<desc>The file creation mode.</desc>
9832	</param>
9833	<param name="offset" type="long long" dir="in">
9834	<desc>The initial read/write offset.</desc>
9835	</param>
9836	<param name="file" type="IGuestFile" dir="return">
9837	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
9838	</param>
9839	</method>
9840
9841	<method name="fileQueryInfo">
9842	<desc>
9843	Queries information of a file on the guest.
9844
9845	<result name="VBOX_E_OBJECT_NOT_FOUND">
9846	File to query information for was not found.
9847	</result>
9848	<result name="VBOX_E_IPRT_ERROR">
9849	Error querying information.
9850	</result>
9851	</desc>
9852	<param name="path" type="wstring" dir="in">
9853	<desc>File to query information for.</desc>
9854	</param>
9855	<param name="info" type="IGuestFsObjInfo" dir="return">
9856	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9857	</param>
9858	</method>
9859
9860	<method name="fileQuerySize">
9861	<desc>
9862	Queries the size of a file on the guest.
9863
9864	<result name="VBOX_E_OBJECT_NOT_FOUND">
9865	File to rename was not found.
9866	</result>
9867	<result name="VBOX_E_IPRT_ERROR">
9868	Error querying file size.
9869	</result>
9870	</desc>
9871	<param name="path" type="wstring" dir="in">
9872	<desc>File to query the size for.</desc>
9873	</param>
9874	<param name="size" type="long long" dir="return">
9875	<desc>Queried file size.</desc>
9876	</param>
9877	</method>
9878
9879	<method name="fileRename">
9880	<desc>
9881	Renames a file on the guest.
9882
9883	<result name="E_NOTIMPL">
9884	The method is not implemented yet.
9885	</result>
9886	</desc>
9887	<param name="source" type="wstring" dir="in">
9888	<desc>Source file to rename.</desc>
9889	</param>
9890	<param name="dest" type="wstring" dir="in">
9891	<desc>Destination file to rename the source to.</desc>
9892	</param>
9893	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9894	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9895	</param>
9896	</method>
9897
9898	<method name="fileSetACL">
9899	<desc>
9900	Sets the ACL (Access Control List) of a file on the guest.
9901
9902	<result name="E_NOTIMPL">
9903	The method is not implemented yet.
9904	</result>
9905	</desc>
9906	<param name="file" type="wstring" dir="in">
9907	<desc>Full path of file to set the ACL for.</desc>
9908	</param>
9909	<param name="acl" type="wstring" dir="in">
9910	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9911	</param>
9912	</method>
9913
9914	<method name="processCreate">
9915	<desc>
9916	Executes an existing program inside the guest VM.
9917
9918	<note>
9919	Starting at VirtualBox 4.2 guest process execution by default is limited
9920	to serve up to 255 guest processes at a time. If all 255 guest processes
9921	are still active and running, starting a new guest process will result in an
9922	appropriate error message.
9923
9924	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9925	is / are set, the guest process will not exit until all data from the specified
9926	stream(s) is / are read out.
9927
9928	To raise or lower the guest process execution limit, either the guest property
9929	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9930	command line by specifying "--control-procs-max-kept" needs to be modified.
9931	A restart of the guest OS is required afterwards. To serve unlimited guest
9932	processes, a value of "0" needs to be set (not recommended).
9933	</note>
9934
9935	<result name="VBOX_E_IPRT_ERROR">
9936	Could not create process.
9937	</result>
9938	</desc>
9939	<param name="command" type="wstring" dir="in">
9940	<desc>
9941	Full path name of the command to execute on the guest; the
9942	commands has to exists in the guest VM in order to be executed.
9943	</desc>
9944	</param>
9945	<param name="arguments" type="wstring" dir="in" safearray="yes">
9946	<desc>Array of arguments passed to the execution command.</desc>
9947	</param>
9948	<param name="environment" type="wstring" dir="in" safearray="yes">
9949	<desc>
9950	Environment variables that can be set while the command is being
9951	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9952	variable just set its name ("NAME") without a value.
9953
9954	This parameter can be used to override environment variables set by
9955	the guest session, which will be applied to the newly started process
9956	in any case.
9957	</desc>
9958	</param>
9959	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9960	<desc>
9961	Process creation flags;
9962	see <link to="ProcessCreateFlag"/> for more information.
9963	</desc>
9964	</param>
9965	<param name="timeoutMS" type="unsigned long" dir="in">
9966	<desc>
9967	Timeout (in ms) to wait for the operation to complete.
9968	Pass 0 for an infinite timeout.
9969	</desc>
9970	</param>
9971	<param name="guestProcess" type="IGuestProcess" dir="return">
9972	<desc>Guest process object of the newly created process.</desc>
9973	</param>
9974	</method>
9975
9976	<method name="processCreateEx">
9977	<desc>
9978	Executes an existing program inside the guest VM. Extended version for
9979	also setting the process priority and affinity.
9980
9981	<note>
9982	Starting at VirtualBox 4.2 guest process execution by default is limited
9983	to serve up to 255 guest processes at a time. If all 255 guest processes
9984	are still active and running, starting a new guest process will result in an
9985	appropriate error message.
9986
9987	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9988	is / are set, the guest process will not exit until all data from the specified
9989	stream(s) is / are read out.
9990
9991	To raise or lower the guest process execution limit, either the guest property
9992	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9993	command line by specifying "--control-procs-max-kept" needs to be modified.
9994	A restart of the guest OS is required afterwards. To serve unlimited guest
9995	processes, a value of "0" needs to be set (not recommended).
9996	</note>
9997
9998	<result name="VBOX_E_IPRT_ERROR">
9999	Could not create process.
10000	</result>
10001	</desc>
10002	<param name="command" type="wstring" dir="in">
10003	<desc>
10004	Full path name of the command to execute on the guest; the
10005	commands has to exists in the guest VM in order to be executed.
10006	</desc>
10007	</param>
10008	<param name="arguments" type="wstring" dir="in" safearray="yes">
10009	<desc>Array of arguments passed to the execution command.</desc>
10010	</param>
10011	<param name="environment" type="wstring" dir="in" safearray="yes">
10012	<desc>
10013	Environment variables that can be set while the command is being
10014	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10015	variable just set its name ("NAME") without a value.
10016
10017	This parameter can be used to override environment variables set by
10018	the guest session, which will be applied to the newly started process
10019	in any case.
10020	</desc>
10021	</param>
10022	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10023	<desc>
10024	Process creation flags;
10025	see <link to="ProcessCreateFlag"/> for more information.
10026	</desc>
10027	</param>
10028	<param name="timeoutMS" type="unsigned long" dir="in">
10029	<desc>
10030	Timeout (in ms) to wait for the operation to complete.
10031	Pass 0 for an infinite timeout.
10032	</desc>
10033	</param>
10034	<param name="priority" type="ProcessPriority" dir="in">
10035	<desc>
10036	Process priority to use for execution;
10037	see see <link to="ProcessPriority"/> for more information.</desc>
10038	</param>
10039	<param name="affinity" type="long" dir="in" safearray="yes">
10040	<desc>
10041	Process affinity to use for execution. This parameter
10042	is not implemented yet.
10043	</desc>
10044	</param>
10045	<param name="guestProcess" type="IGuestProcess" dir="return">
10046	<desc>Guest process object of the newly created process.</desc>
10047	</param>
10048	</method>
10049
10050	<method name="processGet">
10051	<desc>
10052	Gets a certain guest process by its process ID (PID).
10053	</desc>
10054	<param name="pid" type="unsigned long" dir="in">
10055	<desc>Process ID (PID) to get guest process for.</desc>
10056	</param>
10057	<param name="guestProcess" type="IGuestProcess" dir="return">
10058	<desc>Guest process of specified process ID (PID).</desc>
10059	</param>
10060	</method>
10061
10062	<method name="symlinkCreate">
10063	<desc>
10064	Creates a symbolic link on the guest.
10065
10066	<result name="E_NOTIMPL">
10067	The method is not implemented yet.
10068	</result>
10069	</desc>
10070	<param name="source" type="wstring" dir="in">
10071	<desc>The name of the symbolic link.</desc>
10072	</param>
10073	<param name="target" type="wstring" dir="in">
10074	<desc>The path to the symbolic link target.</desc>
10075	</param>
10076	<param name="type" type="SymlinkType" dir="in">
10077	<desc>
10078	The symbolic link type;
10079	see <link to="SymlinkReadFlag"/> for more information.
10080	</desc>
10081	</param>
10082	</method>
10083
10084	<method name="symlinkExists">
10085	<desc>
10086	Checks whether a symbolic link exists on the guest or not.
10087
10088	<result name="E_NOTIMPL">
10089	The method is not implemented yet.
10090	</result>
10091	</desc>
10092	<param name="symlink" type="wstring" dir="in">
10093	<desc>Symbolic link to check existence for.</desc>
10094	</param>
10095	<param name="exists" type="boolean" dir="return">
10096	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10097	</param>
10098	</method>
10099
10100	<method name="symlinkRead">
10101	<desc>
10102	Reads a symbolic link on the guest.
10103
10104	<result name="E_NOTIMPL">
10105	The method is not implemented yet.
10106	</result>
10107	</desc>
10108	<param name="symlink" type="wstring" dir="in">
10109	<desc>Full path to symbolic link to read.</desc>
10110	</param>
10111	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10112	<desc>
10113	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10114	</desc>
10115	</param>
10116	<param name="target" type="wstring" dir="return">
10117	<desc>
10118	Target of the symbolic link pointing to, if found.
10119	</desc>
10120	</param>
10121	</method>
10122
10123	<method name="symlinkRemoveDirectory">
10124	<desc>
10125	Removes a symbolic link on the guest if it's a directory.
10126
10127	<result name="E_NOTIMPL">
10128	The method is not implemented yet.
10129	</result>
10130	</desc>
10131	<param name="path" type="wstring" dir="in">
10132	<desc>Symbolic link to remove.</desc>
10133	</param>
10134	</method>
10135
10136	<method name="symlinkRemoveFile">
10137	<desc>
10138	Removes a symbolic link on the guest if it's a file.
10139
10140	<result name="E_NOTIMPL">
10141	The method is not implemented yet.
10142	</result>
10143	</desc>
10144	<param name="file" type="wstring" dir="in">
10145	<desc>Symbolic link to remove.</desc>
10146	</param>
10147	</method>
10148
10149	</interface>
10150
10151	<interface
10152	name="IProcess" extends="$unknown"
10153	uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10154	wsmap="managed"
10155	>
10156	<desc>
10157	Abstract parent interface for processes handled by VirtualBox.
10158	</desc>
10159	<attribute name="PID" type="unsigned long" readonly="yes">
10160	<desc>
10161	The process ID (PID).
10162	</desc>
10163	</attribute>
10164	<attribute name="status" type="ProcessStatus" readonly="yes">
10165	<desc>
10166	The current process status; see <link to="ProcessStatus"/>
10167	for more information.
10168	</desc>
10169	</attribute>
10170	<attribute name="exitCode" type="long" readonly="yes">
10171	<desc>
10172	The exit code. Only available when the process has been
10173	terminated normally.
10174	</desc>
10175	</attribute>
10176	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10177	<desc>
10178	The environment block this process is using during execution.
10179	</desc>
10180	</attribute>
10181	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10182	<desc>
10183	The arguments this process is using for execution.
10184	</desc>
10185	</attribute>
10186	<attribute name="executablePath" type="wstring" readonly="yes">
10187	<desc>Full path of the actual executable image.</desc>
10188	</attribute>
10189	<attribute name="name" type="wstring" readonly="yes">
10190	<desc>The friendly name of this process.</desc>
10191	</attribute>
10192
10193	<method name="waitFor">
10194	<desc>
10195	Waits for one more events to happen.
10196	</desc>
10197	<param name="waitFor" type="unsigned long" dir="in">
10198	<desc>
10199	Specifies what to wait for;
10200	see <link to="ProcessWaitForFlag"/> for more information.
10201	</desc>
10202	</param>
10203	<param name="timeoutMS" type="unsigned long" dir="in">
10204	<desc>
10205	Timeout (in ms) to wait for the operation to complete.
10206	Pass 0 for an infinite timeout.
10207	</desc>
10208	</param>
10209	<param name="reason" type="ProcessWaitResult" dir="return">
10210	<desc>
10211	The overall wait result;
10212	see <link to="ProcessWaitResult"/> for more information.
10213	</desc>
10214	</param>
10215	</method>
10216
10217	<method name="waitForArray">
10218	<desc>
10219	Waits for one more events to happen.
10220	Scriptable version of <link to="#waitFor" />.
10221	</desc>
10222	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10223	<desc>
10224	Specifies what to wait for;
10225	see <link to="ProcessWaitForFlag"/> for more information.
10226	</desc>
10227	</param>
10228	<param name="timeoutMS" type="unsigned long" dir="in">
10229	<desc>
10230	Timeout (in ms) to wait for the operation to complete.
10231	Pass 0 for an infinite timeout.
10232	</desc>
10233	</param>
10234	<param name="reason" type="ProcessWaitResult" dir="return">
10235	<desc>
10236	The overall wait result;
10237	see <link to="ProcessWaitResult"/> for more information.
10238	</desc>
10239	</param>
10240	</method>
10241
10242	<method name="read">
10243	<desc>
10244	Reads data from a running process.
10245	</desc>
10246	<param name="handle" type="unsigned long" dir="in">
10247	<desc>Handle to read from. Usually 0 is stdin.</desc>
10248	</param>
10249	<param name="toRead" type="unsigned long" dir="in">
10250	<desc>Number of bytes to read.</desc>
10251	</param>
10252	<param name="timeoutMS" type="unsigned long" dir="in">
10253	<desc>
10254	Timeout (in ms) to wait for the operation to complete.
10255	Pass 0 for an infinite timeout.
10256	</desc>
10257	</param>
10258	<param name="data" type="octet" dir="return" safearray="yes">
10259	<desc>Array of data read.</desc>
10260	</param>
10261	</method>
10262
10263	<method name="write">
10264	<desc>
10265	Writes data to a running process.
10266	</desc>
10267	<param name="handle" type="unsigned long" dir="in">
10268	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10269	</param>
10270	<param name="flags" type="unsigned long" dir="in">
10271	<desc>
10272	A combination of <link to="ProcessInputFlag"/> flags.
10273	</desc>
10274	</param>
10275	<param name="data" type="octet" dir="in" safearray="yes">
10276	<desc>
10277	Array of bytes to write. The size of the array also specifies
10278	how much to write.
10279	</desc>
10280	</param>
10281	<param name="timeoutMS" type="unsigned long" dir="in">
10282	<desc>
10283	Timeout (in ms) to wait for the operation to complete.
10284	Pass 0 for an infinite timeout.
10285	</desc>
10286	</param>
10287	<param name="written" type="unsigned long" dir="return">
10288	<desc>How much bytes were written.</desc>
10289	</param>
10290	</method>
10291
10292	<method name="writeArray">
10293	<desc>
10294	Writes data to a running process.
10295	Scriptable version of <link to="#write" />.
10296	</desc>
10297	<param name="handle" type="unsigned long" dir="in">
10298	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10299	</param>
10300	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10301	<desc>
10302	A combination of <link to="ProcessInputFlag"/> flags.
10303	</desc>
10304	</param>
10305	<param name="data" type="octet" dir="in" safearray="yes">
10306	<desc>
10307	Array of bytes to write. The size of the array also specifies
10308	how much to write.
10309	</desc>
10310	</param>
10311	<param name="timeoutMS" type="unsigned long" dir="in">
10312	<desc>
10313	Timeout (in ms) to wait for the operation to complete.
10314	Pass 0 for an infinite timeout.
10315	</desc>
10316	</param>
10317	<param name="written" type="unsigned long" dir="return">
10318	<desc>How much bytes were written.</desc>
10319	</param>
10320	</method>
10321
10322	<method name="terminate">
10323	<desc>
10324	Terminates (kills) a running process.
10325	</desc>
10326	</method>
10327	</interface>
10328
10329	<interface
10330	name="IGuestProcess" extends="IProcess"
10331	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10332	wsmap="managed"
10333	>
10334	<desc>
10335	Implementation of the <link to="IProcess" /> object
10336	for processes on the guest.
10337	</desc>
10338	</interface>
10339
10340	<interface
10341	name="IDirectory" extends="$unknown"
10342	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10343	wsmap="managed"
10344	>
10345	<desc>
10346	Abstract parent interface for directories handled by VirtualBox.
10347	</desc>
10348
10349	<attribute name="directoryName" type="wstring" readonly="yes">
10350	<desc>
10351	Full path of directory.
10352	</desc>
10353	</attribute>
10354
10355	<attribute name="filter" type="wstring" readonly="yes">
10356	<desc>
10357	The open filter.
10358	</desc>
10359	</attribute>
10360
10361	<method name="close">
10362	<desc>
10363	Closes this directory. After closing operations like reading the next
10364	directory entry will not be possible anymore.
10365	</desc>
10366	</method>
10367
10368	<method name="read">
10369	<desc>
10370	Reads the next directory entry of this directory.
10371	<result name="VBOX_E_OBJECT_NOT_FOUND">
10372	No more directory entries to read.
10373	</result>
10374	</desc>
10375	<param name="objInfo" type="IFsObjInfo" dir="return">
10376	<desc>Object information of the current directory entry read. Also see <link to="IFsObjInfo"/>.</desc>
10377	</param>
10378	</method>
10379	</interface>
10380
10381	<interface
10382	name="IGuestDirectory" extends="IDirectory"
10383	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10384	wsmap="managed"
10385	>
10386	<desc>
10387	Implementation of the <link to="IDirectory" /> object
10388	for directories on the guest.
10389	</desc>
10390	</interface>
10391
10392	<interface
10393	name="IFile" extends="$unknown"
10394	uuid="b702a560-6139-4a8e-a892-bbf14b97bf97"
10395	wsmap="managed"
10396	>
10397	<desc>
10398	Abstract parent interface for files handled by VirtualBox.
10399	</desc>
10400	<attribute name="creationMode" type="unsigned long" readonly="yes">
10401	<desc>
10402	The creation mode.
10403	</desc>
10404	</attribute>
10405	<attribute name="disposition" type="unsigned long" readonly="yes">
10406	<desc>
10407	The disposition mode.
10408	</desc>
10409	</attribute>
10410	<attribute name="fileName" type="wstring" readonly="yes">
10411	<desc>
10412	Full path of the actual file name of this file.
10413	</desc>
10414	</attribute>
10415	<attribute name="initialSize" type="long long" readonly="yes">
10416	<desc>
10417	The initial size in bytes when opened.
10418	</desc>
10419	</attribute>
10420	<attribute name="openMode" type="unsigned long" readonly="yes">
10421	<desc>
10422	The open mode.
10423	</desc>
10424	</attribute>
10425	<attribute name="offset" type="long long" readonly="yes">
10426	<desc>
10427	Current read/write offset in bytes.
10428	</desc>
10429	</attribute>
10430
10431	<method name="close">
10432	<desc>
10433	Closes this file. After closing operations like reading data,
10434	writing data or querying information will not be possible anymore.
10435	</desc>
10436	</method>
10437
10438	<method name="queryInfo">
10439	<desc>
10440	Queries information about this file.
10441
10442	<result name="E_NOTIMPL">
10443	The method is not implemented yet.
10444	</result>
10445	</desc>
10446	<param name="objInfo" type="IFsObjInfo" dir="return">
10447	<desc>Object information of this file. Also see <link to="IFsObjInfo"/>.</desc>
10448	</param>
10449	</method>
10450
10451	<method name="read">
10452	<desc>
10453	Reads data from this file.
10454
10455	<result name="E_NOTIMPL">
10456	The method is not implemented yet.
10457	</result>
10458	</desc>
10459	<param name="toRead" type="unsigned long" dir="in">
10460	<desc>Number of bytes to read.</desc>
10461	</param>
10462	<param name="timeoutMS" type="unsigned long" dir="in">
10463	<desc>
10464	Timeout (in ms) to wait for the operation to complete.
10465	Pass 0 for an infinite timeout.
10466	</desc>
10467	</param>
10468	<param name="data" type="octet" dir="return" safearray="yes">
10469	<desc>Array of data read.</desc>
10470	</param>
10471	</method>
10472
10473	<method name="readAt">
10474	<desc>
10475	Reads data from an offset of this file.
10476
10477	<result name="E_NOTIMPL">
10478	The method is not implemented yet.
10479	</result>
10480	</desc>
10481	<param name="offset" type="long long" dir="in">
10482	<desc>Offset in bytes to start reading.</desc>
10483	</param>
10484	<param name="toRead" type="unsigned long" dir="in">
10485	<desc>Number of bytes to read.</desc>
10486	</param>
10487	<param name="timeoutMS" type="unsigned long" dir="in">
10488	<desc>
10489	Timeout (in ms) to wait for the operation to complete.
10490	Pass 0 for an infinite timeout.
10491	</desc>
10492	</param>
10493	<param name="data" type="octet" dir="return" safearray="yes">
10494	<desc>Array of data read.</desc>
10495	</param>
10496	</method>
10497
10498	<method name="seek">
10499	<desc>
10500	Changes the read and write position of this file.
10501
10502	<result name="E_NOTIMPL">
10503	The method is not implemented yet.
10504	</result>
10505	</desc>
10506	<param name="offset" type="long long" dir="in">
10507	<desc>Offset to seek.</desc>
10508	</param>
10509	<param name="whence" type="FileSeekType" dir="in">
10510	<desc>
10511	Seek mode; see <link to="FileSeekType"/> for more information.
10512	</desc>
10513	</param>
10514	</method>
10515
10516	<method name="setACL">
10517	<desc>
10518	Sets the ACL of this file.
10519
10520	<result name="E_NOTIMPL">
10521	The method is not implemented yet.
10522	</result>
10523	</desc>
10524	<param name="acl" type="wstring" dir="in">
10525	<desc>ACL string to set.</desc>
10526	</param>
10527	</method>
10528
10529	<method name="write">
10530	<desc>
10531	Writes bytes to this file.
10532	</desc>
10533	<param name="data" type="octet" dir="in" safearray="yes">
10534	<desc>
10535	Array of bytes to write. The size of the array also specifies
10536	how much to write.
10537	</desc>
10538	</param>
10539	<param name="timeoutMS" type="unsigned long" dir="in">
10540	<desc>
10541	Timeout (in ms) to wait for the operation to complete.
10542	Pass 0 for an infinite timeout.
10543	</desc>
10544	</param>
10545	<param name="written" type="unsigned long" dir="return">
10546	<desc>How much bytes were written.</desc>
10547	</param>
10548	</method>
10549
10550	<method name="writeAt">
10551	<desc>
10552	Writes bytes at a certain offset to this file.
10553
10554	<result name="E_NOTIMPL">
10555	The method is not implemented yet.
10556	</result>
10557	</desc>
10558	<param name="offset" type="long long" dir="in">
10559	<desc>Offset in bytes to start writing.</desc>
10560	</param>
10561	<param name="data" type="octet" dir="in" safearray="yes">
10562	<desc>
10563	Array of bytes to write. The size of the array also specifies
10564	how much to write.
10565	</desc>
10566	</param>
10567	<param name="timeoutMS" type="unsigned long" dir="in">
10568	<desc>
10569	Timeout (in ms) to wait for the operation to complete.
10570	Pass 0 for an infinite timeout.
10571	</desc>
10572	</param>
10573	<param name="written" type="unsigned long" dir="return">
10574	<desc>How much bytes were written.</desc>
10575	</param>
10576	</method>
10577
10578	</interface>
10579
10580	<interface
10581	name="IGuestFile" extends="IFile"
10582	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10583	wsmap="managed"
10584	>
10585	<desc>
10586	Implementation of the <link to="IFile" /> object
10587	for files on the guest.
10588	</desc>
10589	</interface>
10590
10591	<interface
10592	name="IFsObjInfo" extends="$unknown"
10593	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10594	wsmap="managed"
10595	>
10596	<desc>
10597	Abstract parent interface for VirtualBox file system object information.
10598	This can be information about a file or a directory, for example.
10599	</desc>
10600
10601	<attribute name="accessTime" type="long long" readonly="yes">
10602	<desc>
10603	Time of last access (st_atime).
10604	</desc>
10605	</attribute>
10606	<attribute name="allocatedSize" type="long long" readonly="yes">
10607	<desc>
10608	Disk allocation size (st_blocks * DEV_BSIZE).
10609	</desc>
10610	</attribute>
10611	<attribute name="birthTime" type="long long" readonly="yes">
10612	<desc>
10613	Time of file birth (st_birthtime).
10614	</desc>
10615	</attribute>
10616	<attribute name="changeTime" type="long long" readonly="yes">
10617	<desc>
10618	Time of last status change (st_ctime).
10619	</desc>
10620	</attribute>
10621	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10622	<desc>
10623	The device number of a character or block device type object (st_rdev).
10624	</desc>
10625	</attribute>
10626	<attribute name="fileAttributes" type="wstring" readonly="yes">
10627	<desc>
10628	File attributes. Not implemented yet.
10629	</desc>
10630	</attribute>
10631	<attribute name="generationId" type="unsigned long" readonly="yes">
10632	<desc>
10633	The current generation number (st_gen).
10634	</desc>
10635	</attribute>
10636	<attribute name="GID" type="unsigned long" readonly="yes">
10637	<desc>
10638	The group the filesystem object is assigned (st_gid).
10639	</desc>
10640	</attribute>
10641	<attribute name="groupName" type="wstring" readonly="yes">
10642	<desc>
10643	The group name.
10644	</desc>
10645	</attribute>
10646	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10647	<desc>
10648	Number of hard links to this filesystem object (st_nlink).
10649	</desc>
10650	</attribute>
10651	<attribute name="modificationTime" type="long long" readonly="yes">
10652	<desc>
10653	Time of last data modification (st_mtime).
10654	</desc>
10655	</attribute>
10656	<attribute name="name" type="wstring" readonly="yes">
10657	<desc>
10658	The object's name.
10659	</desc>
10660	</attribute>
10661	<attribute name="nodeId" type="long long" readonly="yes">
10662	<desc>
10663	The unique identifier (within the filesystem) of this filesystem object (st_ino).
10664	</desc>
10665	</attribute>
10666	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10667	<desc>
10668	The device number of the device which this filesystem object resides on (st_dev).
10669	</desc>
10670	</attribute>
10671	<attribute name="objectSize" type="long long" readonly="yes">
10672	<desc>
10673	The logical size (st_size). For normal files this is the size of the file.
10674	For symbolic links, this is the length of the path name contained in the
10675	symbolic link. For other objects this fields needs to be specified.
10676	</desc>
10677	</attribute>
10678	<attribute name="type" type="FsObjType" readonly="yes">
10679	<desc>
10680	The object type. See <link to="FsObjType" /> for more.
10681	</desc>
10682	</attribute>
10683	<attribute name="UID" type="unsigned long" readonly="yes">
10684	<desc>
10685	The user owning the filesystem object (st_uid).
10686	</desc>
10687	</attribute>
10688	<attribute name="userFlags" type="unsigned long" readonly="yes">
10689	<desc>
10690	User flags (st_flags).
10691	</desc>
10692	</attribute>
10693	<attribute name="userName" type="wstring" readonly="yes">
10694	<desc>
10695	The user name.
10696	</desc>
10697	</attribute>
10698
10699	</interface>
10700
10701	<interface
10702	name="IGuestFsObjInfo" extends="IFsObjInfo"
10703	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10704	wsmap="managed"
10705	>
10706	<desc>
10707	Represents the guest implementation of the
10708	<link to="IFsObjInfo" /> object.
10709	</desc>
10710	</interface>
10711
10712	<interface
10713	name="IGuest" extends="$unknown"
10714	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
10715	wsmap="managed"
10716	>
10717	<desc>
10718	The IGuest interface represents information about the operating system
10719	running inside the virtual machine. Used in
10720	<link to="IConsole::guest"/>.
10721
10722	IGuest provides information about the guest operating system, whether
10723	Guest Additions are installed and other OS-specific virtual machine
10724	properties.
10725	</desc>
10726
10727	<attribute name="OSTypeId" type="wstring" readonly="yes">
10728	<desc>
10729	Identifier of the Guest OS type as reported by the Guest
10730	Additions.
10731	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10732	an IGuestOSType object representing details about the given
10733	Guest OS type.
10734	<note>
10735	If Guest Additions are not installed, this value will be
10736	the same as <link to="IMachine::OSTypeId"/>.
10737	</note>
10738	</desc>
10739	</attribute>
10740
10741	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10742	<desc>
10743	Current run level of the Guest Additions.
10744	</desc>
10745	</attribute>
10746
10747	<attribute name="additionsVersion" type="wstring" readonly="yes">
10748	<desc>
10749	Version of the Guest Additions in the same format as
10750	<link to="IVirtualBox::version"/>.
10751	</desc>
10752	</attribute>
10753
10754	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
10755	<desc>
10756	The internal build revision number of the additions.
10757
10758	See also <link to="IVirtualBox::revision"/>.
10759	</desc>
10760	</attribute>
10761
10762	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10763	<desc>
10764	Array of current known facilities. Only returns facilities where a status is known,
10765	e.g. facilities with an unknown status will not be returned.
10766	</desc>
10767	</attribute>
10768
10769	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10770	<desc>Returns a collection of all opened guest sessions.</desc>
10771	</attribute>
10772
10773	<attribute name="memoryBalloonSize" type="unsigned long">
10774	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
10775	</attribute>
10776
10777	<attribute name="statisticsUpdateInterval" type="unsigned long">
10778	<desc>Interval to update guest statistics in seconds.</desc>
10779	</attribute>
10780
10781	<method name="internalGetStatistics">
10782	<desc>
10783	Internal method; do not use as it might change at any time.
10784	</desc>
10785	<param name="cpuUser" type="unsigned long" dir="out">
10786	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10787	</param>
10788	<param name="cpuKernel" type="unsigned long" dir="out">
10789	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10790	</param>
10791	<param name="cpuIdle" type="unsigned long" dir="out">
10792	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
10793	</param>
10794	<param name="memTotal" type="unsigned long" dir="out">
10795	<desc>Total amount of physical guest RAM.</desc>
10796	</param>
10797	<param name="memFree" type="unsigned long" dir="out">
10798	<desc>Free amount of physical guest RAM.</desc>
10799	</param>
10800	<param name="memBalloon" type="unsigned long" dir="out">
10801	<desc>Amount of ballooned physical guest RAM.</desc>
10802	</param>
10803	<param name="memShared" type="unsigned long" dir="out">
10804	<desc>Amount of shared physical guest RAM.</desc>
10805	</param>
10806	<param name="memCache" type="unsigned long" dir="out">
10807	<desc>Total amount of guest (disk) cache memory.</desc>
10808	</param>
10809	<param name="pagedTotal" type="unsigned long" dir="out">
10810	<desc>Total amount of space in the page file.</desc>
10811	</param>
10812	<param name="memAllocTotal" type="unsigned long" dir="out">
10813	<desc>Total amount of memory allocated by the hypervisor.</desc>
10814	</param>
10815	<param name="memFreeTotal" type="unsigned long" dir="out">
10816	<desc>Total amount of free memory available in the hypervisor.</desc>
10817	</param>
10818	<param name="memBalloonTotal" type="unsigned long" dir="out">
10819	<desc>Total amount of memory ballooned by the hypervisor.</desc>
10820	</param>
10821	<param name="memSharedTotal" type="unsigned long" dir="out">
10822	<desc>Total amount of shared memory in the hypervisor.</desc>
10823	</param>
10824	</method>
10825
10826	<method name="getFacilityStatus">
10827	<desc>
10828	Get the current status of a Guest Additions facility.
10829	</desc>
10830	<param name="facility" type="AdditionsFacilityType" dir="in">
10831	<desc>Facility to check status for.</desc>
10832	</param>
10833	<param name="timestamp" type="long long" dir="out">
10834	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
10835	</param>
10836	<param name="status" type="AdditionsFacilityStatus" dir="return">
10837	<desc>The current (latest) facility status.</desc>
10838	</param>
10839	</method>
10840
10841	<method name="getAdditionsStatus">
10842	<desc>
10843	Retrieve the current status of a certain Guest Additions run level.
10844
10845	<result name="VBOX_E_NOT_SUPPORTED">
10846	Wrong status level specified.
10847	</result>
10848
10849	</desc>
10850	<param name="level" type="AdditionsRunLevelType" dir="in">
10851	<desc>Status level to check</desc>
10852	</param>
10853	<param name="active" type="boolean" dir="return">
10854	<desc>Flag whether the status level has been reached or not</desc>
10855	</param>
10856	</method>
10857
10858	<method name="setCredentials">
10859	<desc>
10860	Store login credentials that can be queried by guest operating
10861	systems with Additions installed. The credentials are transient
10862	to the session and the guest may also choose to erase them. Note
10863	that the caller cannot determine whether the guest operating system
10864	has queried or made use of the credentials.
10865
10866	<result name="VBOX_E_VM_ERROR">
10867	VMM device is not available.
10868	</result>
10869
10870	</desc>
10871	<param name="userName" type="wstring" dir="in">
10872	<desc>User name string, can be empty</desc>
10873	</param>
10874	<param name="password" type="wstring" dir="in">
10875	<desc>Password string, can be empty</desc>
10876	</param>
10877	<param name="domain" type="wstring" dir="in">
10878	<desc>Domain name (guest logon scheme specific), can be empty</desc>
10879	</param>
10880	<param name="allowInteractiveLogon" type="boolean" dir="in">
10881	<desc>
10882	Flag whether the guest should alternatively allow the user to
10883	interactively specify different credentials. This flag might
10884	not be supported by all versions of the Additions.
10885	</desc>
10886	</param>
10887	</method>
10888
10889	<method name="dragHGEnter">
10890	<desc>
10891	Informs the guest about a Drag and Drop enter event.
10892
10893	This is used in Host - Guest direction.
10894
10895	<result name="VBOX_E_VM_ERROR">
10896	VMM device is not available.
10897	</result>
10898
10899	</desc>
10900	<param name="screenId" type="unsigned long" dir="in">
10901	<desc>The screen id where the Drag and Drop event occured.</desc>
10902	</param>
10903	<param name="y" type="unsigned long" dir="in">
10904	<desc>y-position of the event.</desc>
10905	</param>
10906	<param name="x" type="unsigned long" dir="in">
10907	<desc>x-position of the event.</desc>
10908	</param>
10909	<param name="defaultAction" type="DragAndDropAction" dir="in">
10910	<desc>The default action to use.</desc>
10911	</param>
10912	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10913	<desc>The actions which are allowed.</desc>
10914	</param>
10915	<param name="formats" type="wstring" dir="in" safearray="yes">
10916	<desc>The supported mime types.</desc>
10917	</param>
10918	<param name="resultAction" type="DragAndDropAction" dir="return">
10919	<desc>The resulting action of this event.</desc>
10920	</param>
10921	</method>
10922
10923	<method name="dragHGMove">
10924	<desc>
10925	Informs the guest about a Drag and Drop move event.
10926
10927	This is used in Host - Guest direction.
10928
10929	<result name="VBOX_E_VM_ERROR">
10930	VMM device is not available.
10931	</result>
10932
10933	</desc>
10934	<param name="screenId" type="unsigned long" dir="in">
10935	<desc>The screen id where the Drag and Drop event occured.</desc>
10936	</param>
10937	<param name="x" type="unsigned long" dir="in">
10938	<desc>x-position of the event.</desc>
10939	</param>
10940	<param name="y" type="unsigned long" dir="in">
10941	<desc>y-position of the event.</desc>
10942	</param>
10943	<param name="defaultAction" type="DragAndDropAction" dir="in">
10944	<desc>The default action to use.</desc>
10945	</param>
10946	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10947	<desc>The actions which are allowed.</desc>
10948	</param>
10949	<param name="formats" type="wstring" dir="in" safearray="yes">
10950	<desc>The supported mime types.</desc>
10951	</param>
10952	<param name="resultAction" type="DragAndDropAction" dir="return">
10953	<desc>The resulting action of this event.</desc>
10954	</param>
10955	</method>
10956
10957	<method name="dragHGLeave">
10958	<desc>
10959	Informs the guest about a Drag and Drop leave event.
10960
10961	This is used in Host - Guest direction.
10962
10963	<result name="VBOX_E_VM_ERROR">
10964	VMM device is not available.
10965	</result>
10966
10967	</desc>
10968	<param name="screenId" type="unsigned long" dir="in">
10969	<desc>The screen id where the Drag and Drop event occured.</desc>
10970	</param>
10971	</method>
10972
10973	<method name="dragHGDrop">
10974	<desc>
10975	Informs the guest about a drop event.
10976
10977	This is used in Host - Guest direction.
10978
10979	<result name="VBOX_E_VM_ERROR">
10980	VMM device is not available.
10981	</result>
10982
10983	</desc>
10984	<param name="screenId" type="unsigned long" dir="in">
10985	<desc>The screen id where the Drag and Drop event occured.</desc>
10986	</param>
10987	<param name="x" type="unsigned long" dir="in">
10988	<desc>x-position of the event.</desc>
10989	</param>
10990	<param name="y" type="unsigned long" dir="in">
10991	<desc>y-position of the event.</desc>
10992	</param>
10993	<param name="defaultAction" type="DragAndDropAction" dir="in">
10994	<desc>The default action to use.</desc>
10995	</param>
10996	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10997	<desc>The actions which are allowed.</desc>
10998	</param>
10999	<param name="formats" type="wstring" dir="in" safearray="yes">
11000	<desc>The supported mime types.</desc>
11001	</param>
11002	<param name="format" type="wstring" dir="out">
11003	<desc>The resulting format of this event.</desc>
11004	</param>
11005	<param name="resultAction" type="DragAndDropAction" dir="return">
11006	<desc>The resulting action of this event.</desc>
11007	</param>
11008	</method>
11009
11010	<method name="dragHGPutData">
11011	<desc>
11012	Informs the guest about a drop data event.
11013
11014	This is used in Host - Guest direction.
11015
11016	<result name="VBOX_E_VM_ERROR">
11017	VMM device is not available.
11018	</result>
11019
11020	</desc>
11021	<param name="screenId" type="unsigned long" dir="in">
11022	<desc>The screen id where the Drag and Drop event occured.</desc>
11023	</param>
11024	<param name="format" type="wstring" dir="in">
11025	<desc>The mime type the data is in.</desc>
11026	</param>
11027	<param name="data" type="octet" dir="in" safearray="yes">
11028	<desc>The actual data.</desc>
11029	</param>
11030	<param name="progress" type="IProgress" dir="return">
11031	<desc>Progress object to track the operation completion.</desc>
11032	</param>
11033	</method>
11034
11035	<method name="dragGHPending">
11036	<desc>
11037	Ask the guest if there is any Drag and Drop operation pending in the guest.
11038
11039	If no Drag and Drop operation is pending currently, Ignore is returned.
11040
11041	This is used in Guest - Host direction.
11042
11043	<result name="VBOX_E_VM_ERROR">
11044	VMM device is not available.
11045	</result>
11046
11047	</desc>
11048	<param name="screenId" type="unsigned long" dir="in">
11049	<desc>The screen id where the Drag and Drop event occured.</desc>
11050	</param>
11051	<param name="format" type="wstring" dir="out" safearray="yes">
11052	<desc>On return the supported mime types.</desc>
11053	</param>
11054	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11055	<desc>On return the actions which are allowed.</desc>
11056	</param>
11057	<param name="defaultAction" type="DragAndDropAction" dir="return">
11058	<desc>On return the default action to use.</desc>
11059	</param>
11060	</method>
11061
11062	<method name="dragGHDropped">
11063	<desc>
11064	Informs the guest that a drop event occured for a pending Drag and Drop event.
11065
11066	This is used in Guest - Host direction.
11067
11068	<result name="VBOX_E_VM_ERROR">
11069	VMM device is not available.
11070	</result>
11071
11072	</desc>
11073
11074	<param name="format" type="wstring" dir="in">
11075	<desc>The mime type the data must be in.</desc>
11076	</param>
11077	<param name="action" type="DragAndDropAction" dir="in">
11078	<desc>The action to use.</desc>
11079	</param>
11080	<param name="progress" type="IProgress" dir="return">
11081	<desc>Progress object to track the operation completion.</desc>
11082	</param>
11083	</method>
11084
11085	<method name="dragGHGetData">
11086	<desc>
11087	Fetch the data of a previously Drag and Drop event from the guest.
11088
11089	This is used in Guest - Host direction.
11090
11091	<result name="VBOX_E_VM_ERROR">
11092	VMM device is not available.
11093	</result>
11094
11095	</desc>
11096
11097	<param name="data" type="octet" safearray="yes" dir="return">
11098	<desc>The actual data.</desc>
11099	</param>
11100	</method>
11101
11102	<method name="createSession">
11103	<desc>
11104	Creates a new guest session for controlling the guest.
11105
11106	A guest session represents one impersonated user account on the guest, so
11107	every operation will use the same credentials specified when creating
11108	the session object via <link to="IGuest::createSession"/>. Anonymous
11109	sessions, that is, sessions without specifying a valid
11110	user account on the guest are not allowed due to security reasons.
11111
11112	There can be a maximum of 32 sessions at once per VM. Each session keeps
11113	track of its started guest processes, opened guest files or guest directories.
11114	To work on guest files or directories a guest session offers methods to open
11115	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11116	<link to="IGuestSession::directoryOpen"/> for example).
11117
11118	When done with either of these objects, including the guest session itself,
11119	use the appropriate close() method to let the object do its cleanup work.
11120
11121	Every guest session has its own environment variable block which gets
11122	automatically applied when starting a new guest process via
11123	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11124	To override (or unset) certain environment variables already set by the
11125	guest session, one can specify a per-process environment block when using
11126	one of the both above mentioned process creation calls.
11127
11128	Closing a session via <link to="IGuestSession::close" /> will try to close
11129	all the mentioned objects above unless these objects are still used by
11130	a client.
11131	</desc>
11132	<param name="user" type="wstring" dir="in">
11133	<desc>
11134	User name this session will be using to control the guest; has to exist
11135	and have the appropriate rights to execute programs in the VM. Must not
11136	be empty.
11137	</desc>
11138	</param>
11139	<param name="password" type="wstring" dir="in">
11140	<desc>
11141	Password of the user account to be used. Empty passwords are allowed.
11142	</desc>
11143	</param>
11144	<param name="domain" type="wstring" dir="in">
11145	<desc>
11146	Domain name of the user account to be used if the guest is part of
11147	a domain. Optional. This feature is not implemented yet.
11148	</desc>
11149	</param>
11150	<param name="sessionName" type="wstring" dir="in">
11151	<desc>
11152	The session's friendly name. Optional, can be empty.
11153	</desc>
11154	</param>
11155	<param name="guestSession" type="IGuestSession" dir="return">
11156	<desc>
11157	The newly created session object.
11158	</desc>
11159	</param>
11160	</method>
11161
11162	<method name="findSession">
11163	<desc>
11164	Finds guest sessions by their friendly name and returns an interface
11165	array with all found guest sessions.
11166	</desc>
11167	<param name="sessionName" type="wstring" dir="in">
11168	<desc>
11169	The session's friendly name to find. Wildcards like ? and * are allowed.
11170	</desc>
11171	</param>
11172	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11173	<desc>
11174	Array with all guest sessions found matching the name specified.
11175	</desc>
11176	</param>
11177	</method>
11178
11179	<method name="updateGuestAdditions">
11180	<desc>
11181	Automatically updates already installed Guest Additions in a VM.
11182
11183	At the moment only Windows guests are supported.
11184
11185	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11186	yet there might be warning dialogs during the actual Guest Additions
11187	update. These need to be confirmed manually in order to continue the
11188	installation process. This applies to Windows 2000 and Windows XP guests
11189	and therefore these guests can't be updated in a fully automated fashion
11190	without user interaction. However, to start a Guest Additions update for
11191	the mentioned Windows versions anyway, the flag
11192	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11193	<link to="AdditionsUpdateFlag"/> for more information.
11194
11195	<result name="VBOX_E_NOT_SUPPORTED">
11196	Guest OS is not supported for automated Guest Additions updates or the
11197	already installed Guest Additions are not ready yet.
11198	</result>
11199
11200	<result name="VBOX_E_IPRT_ERROR">
11201	Error while updating.
11202	</result>
11203
11204	</desc>
11205	<param name="source" type="wstring" dir="in">
11206	<desc>
11207	Path to the Guest Additions .ISO file to use for the upate.
11208	</desc>
11209	</param>
11210	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11211	<desc>
11212	<link to="AdditionsUpdateFlag"/> flags.
11213	</desc>
11214	</param>
11215	<param name="progress" type="IProgress" dir="return">
11216	<desc>Progress object to track the operation completion.</desc>
11217	</param>
11218	</method>
11219
11220	</interface>
11221
11222
11223	<!--
11224	// IProgress
11225	/////////////////////////////////////////////////////////////////////////
11226	-->
11227
11228	<interface
11229	name="IProgress" extends="$unknown"
11230	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11231	wsmap="managed"
11232	>
11233	<desc>
11234	The IProgress interface is used to track and control
11235	asynchronous tasks within VirtualBox.
11236
11237	An instance of this is returned every time VirtualBox starts
11238	an asynchronous task (in other words, a separate thread) which
11239	continues to run after a method call returns. For example,
11240	<link to="IConsole::saveState" />, which saves the state of
11241	a running virtual machine, can take a long time to complete.
11242	To be able to display a progress bar, a user interface such as
11243	the VirtualBox graphical user interface can use the IProgress
11244	object returned by that method.
11245
11246	Note that IProgress is a "read-only" interface in the sense
11247	that only the VirtualBox internals behind the Main API can
11248	create and manipulate progress objects, whereas client code
11249	can only use the IProgress object to monitor a task's
11250	progress and, if <link to="#cancelable" /> is @c true,
11251	cancel the task by calling <link to="#cancel" />.
11252
11253	A task represented by IProgress consists of either one or
11254	several sub-operations that run sequentially, one by one (see
11255	<link to="#operation" /> and <link to="#operationCount" />).
11256	Every operation is identified by a number (starting from 0)
11257	and has a separate description.
11258
11259	You can find the individual percentage of completion of the current
11260	operation in <link to="#operationPercent" /> and the
11261	percentage of completion of the task as a whole
11262	in <link to="#percent" />.
11263
11264	Similarly, you can wait for the completion of a particular
11265	operation via <link to="#waitForOperationCompletion" /> or
11266	for the completion of the whole task via
11267	<link to="#waitForCompletion" />.
11268	</desc>
11269
11270	<attribute name="id" type="uuid" mod="string" readonly="yes">
11271	<desc>ID of the task.</desc>
11272	</attribute>
11273
11274	<attribute name="description" type="wstring" readonly="yes">
11275	<desc>Description of the task.</desc>
11276	</attribute>
11277
11278	<attribute name="initiator" type="$unknown" readonly="yes">
11279	<desc>Initiator of the task.</desc>
11280	</attribute>
11281
11282	<attribute name="cancelable" type="boolean" readonly="yes">
11283	<desc>Whether the task can be interrupted.</desc>
11284	</attribute>
11285
11286	<attribute name="percent" type="unsigned long" readonly="yes">
11287	<desc>
11288	Current progress value of the task as a whole, in percent.
11289	This value depends on how many operations are already complete.
11290	Returns 100 if <link to="#completed" /> is @c true.
11291	</desc>
11292	</attribute>
11293
11294	<attribute name="timeRemaining" type="long" readonly="yes">
11295	<desc>
11296	Estimated remaining time until the task completes, in
11297	seconds. Returns 0 once the task has completed; returns -1
11298	if the remaining time cannot be computed, in particular if
11299	the current progress is 0.
11300
11301	Even if a value is returned, the estimate will be unreliable
11302	for low progress values. It will become more reliable as the
11303	task progresses; it is not recommended to display an ETA
11304	before at least 20% of a task have completed.
11305	</desc>
11306	</attribute>
11307
11308	<attribute name="completed" type="boolean" readonly="yes">
11309	<desc>Whether the task has been completed.</desc>
11310	</attribute>
11311
11312	<attribute name="canceled" type="boolean" readonly="yes">
11313	<desc>Whether the task has been canceled.</desc>
11314	</attribute>
11315
11316	<attribute name="resultCode" type="long" readonly="yes">
11317	<desc>
11318	Result code of the progress task.
11319	Valid only if <link to="#completed"/> is @c true.
11320	</desc>
11321	</attribute>
11322
11323	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11324	<desc>
11325	Extended information about the unsuccessful result of the
11326	progress operation. May be @c null if no extended information
11327	is available.
11328	Valid only if <link to="#completed"/> is @c true and
11329	<link to="#resultCode"/> indicates a failure.
11330	</desc>
11331	</attribute>
11332
11333	<attribute name="operationCount" type="unsigned long" readonly="yes">
11334	<desc>
11335	Number of sub-operations this task is divided into.
11336	Every task consists of at least one suboperation.
11337	</desc>
11338	</attribute>
11339
11340	<attribute name="operation" type="unsigned long" readonly="yes">
11341	<desc>Number of the sub-operation being currently executed.</desc>
11342	</attribute>
11343
11344	<attribute name="operationDescription" type="wstring" readonly="yes">
11345	<desc>
11346	Description of the sub-operation being currently executed.
11347	</desc>
11348	</attribute>
11349
11350	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11351	<desc>Progress value of the current sub-operation only, in percent.</desc>
11352	</attribute>
11353
11354	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11355	<desc>Weight value of the current sub-operation only.</desc>
11356	</attribute>
11357
11358	<attribute name="timeout" type="unsigned long">
11359	<desc>
11360	When non-zero, this specifies the number of milliseconds after which
11361	the operation will automatically be canceled. This can only be set on
11362	cancelable objects.
11363	</desc>
11364	</attribute>
11365
11366	<method name="setCurrentOperationProgress">
11367	<desc>Internal method, not to be called externally.</desc>
11368	<param name="percent" type="unsigned long" dir="in" />
11369	</method>
11370	<method name="setNextOperation">
11371	<desc>Internal method, not to be called externally.</desc>
11372	<param name="nextOperationDescription" type="wstring" dir="in" />
11373	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11374	</method>
11375
11376	<method name="waitForCompletion">
11377	<desc>
11378	Waits until the task is done (including all sub-operations)
11379	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11380
11381	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11382	thread are not processed while waiting. Neglecting event queues may
11383	have dire consequences (degrade performance, resource hogs,
11384	deadlocks, etc.), this is specially so for the main thread on
11385	platforms using XPCOM. Callers are adviced wait for short periods
11386	and service their event queues between calls, or to create a worker
11387	thread to do the waiting.
11388
11389	<result name="VBOX_E_IPRT_ERROR">
11390	Failed to wait for task completion.
11391	</result>
11392	</desc>
11393
11394	<param name="timeout" type="long" dir="in">
11395	<desc>
11396	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11397	</desc>
11398	</param>
11399	</method>
11400
11401	<method name="waitForOperationCompletion">
11402	<desc>
11403	Waits until the given operation is done with a given timeout in
11404	milliseconds; specify -1 for an indefinite wait.
11405
11406	See <link to="#waitForCompletion"> for event queue considerations.</link>
11407
11408	<result name="VBOX_E_IPRT_ERROR">
11409	Failed to wait for operation completion.
11410	</result>
11411
11412	</desc>
11413	<param name="operation" type="unsigned long" dir="in">
11414	<desc>
11415	Number of the operation to wait for.
11416	Must be less than <link to="#operationCount"/>.
11417	</desc>
11418	</param>
11419	<param name="timeout" type="long" dir="in">
11420	<desc>
11421	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11422	</desc>
11423	</param>
11424	</method>
11425
11426	<method name="waitForAsyncProgressCompletion">
11427	<desc>
11428	Waits until the other task is completed (including all
11429	sub-operations) and forward all changes from the other progress to
11430	this progress. This means sub-operation number, description, percent
11431	and so on.
11432
11433	You have to take care on setting up at least the same count on
11434	sub-operations in this progress object like there are in the other
11435	progress object.
11436
11437	If the other progress object supports cancel and this object gets any
11438	cancel request (when here enabled as well), it will be forwarded to
11439	the other progress object.
11440
11441	If there is an error in the other progress, this error isn't
11442	automatically transfered to this progress object. So you have to
11443	check any operation error within the other progress object, after
11444	this method returns.
11445	</desc>
11446
11447	<param name="pProgressAsync" type="IProgress" dir="in">
11448	<desc>
11449	The progress object of the asynchrony process.
11450	</desc>
11451	</param>
11452	</method>
11453
11454	<method name="cancel">
11455	<desc>
11456	Cancels the task.
11457	<note>
11458	If <link to="#cancelable"/> is @c false, then this method will fail.
11459	</note>
11460
11461	<result name="VBOX_E_INVALID_OBJECT_STATE">
11462	Operation cannot be canceled.
11463	</result>
11464
11465	</desc>
11466	</method>
11467
11468	</interface>
11469
11470	<!--
11471	// ISnapshot
11472	/////////////////////////////////////////////////////////////////////////
11473	-->
11474
11475	<interface
11476	name="ISnapshot" extends="$unknown"
11477	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11478	wsmap="managed"
11479	>
11480	<desc>
11481	The ISnapshot interface represents a snapshot of the virtual
11482	machine.
11483
11484	Together with the differencing media that are created
11485	when a snapshot is taken, a machine can be brought back to
11486	the exact state it was in when the snapshot was taken.
11487
11488	The ISnapshot interface has no methods, only attributes; snapshots
11489	are controlled through methods of the <link to="IConsole" /> interface
11490	which also manage the media associated with the snapshot.
11491	The following operations exist:
11492
11493	<ul>
11494	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11495	by creating new, empty differencing images for the machine's
11496	media and saving the VM settings and (if the VM is running)
11497	the current VM state in the snapshot.
11498
11499	The differencing images will then receive all data written to
11500	the machine's media, while their parent (base) images
11501	remain unmodified after the snapshot has been taken (see
11502	<link to="IMedium" /> for details about differencing images).
11503	This simplifies restoring a machine to the state of a snapshot:
11504	only the differencing images need to be deleted.
11505
11506	The current machine state is not changed by taking a snapshot
11507	except that <link to="IMachine::currentSnapshot" /> is set to
11508	the newly created snapshot, which is also added to the machine's
11509	snapshots tree.
11510	</li>
11511
11512	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11513	the state of a previous snapshot by deleting the differencing
11514	image of each of the machine's media and setting the machine's
11515	settings and state to the state that was saved in the snapshot (if any).
11516
11517	This destroys the machine's current state. After calling this,
11518	<link to="IMachine::currentSnapshot" /> points to the snapshot
11519	that was restored.
11520	</li>
11521
11522	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11523	without affecting the current machine state.
11524
11525	This does not change the current machine state, but instead frees the
11526	resources allocated when the snapshot was taken: the settings and machine
11527	state file are deleted (if any), and the snapshot's differencing image for
11528	each of the machine's media gets merged with its parent image.
11529
11530	Neither the current machine state nor other snapshots are affected
11531	by this operation, except that parent media will be modified
11532	to contain the disk data associated with the snapshot being deleted.
11533
11534	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11535	attribute is set to the current snapshot's parent or @c null if it
11536	has no parent. Otherwise the attribute is unchanged.
11537	</li>
11538	</ul>
11539
11540	Each snapshot contains a copy of virtual machine's settings (hardware
11541	configuration etc.). This copy is contained in an immutable (read-only)
11542	instance of <link to="IMachine" /> which is available from the snapshot's
11543	<link to="#machine" /> attribute. When restoring the snapshot, these
11544	settings are copied back to the original machine.
11545
11546	In addition, if the machine was running when the
11547	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11548	the current VM state is saved in the snapshot (similarly to what happens
11549	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11550	because when restoring it, the VM will be running.
11551
11552	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11553	the snapshot receives a copy of the execution state file
11554	(<link to="IMachine::stateFilePath"/>).
11555
11556	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11557	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11558	it then contains a so-called "zero execution state", representing a
11559	machine that is powered off.
11560	</desc>
11561
11562	<attribute name="id" type="uuid" mod="string" readonly="yes">
11563	<desc>UUID of the snapshot.</desc>
11564	</attribute>
11565
11566	<attribute name="name" type="wstring">
11567	<desc>Short name of the snapshot.
11568	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11569	be called implicitly.</note>
11570	</desc>
11571	</attribute>
11572
11573	<attribute name="description" type="wstring">
11574	<desc>Optional description of the snapshot.
11575	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11576	be called implicitly.</note>
11577	</desc>
11578	</attribute>
11579
11580	<attribute name="timeStamp" type="long long" readonly="yes">
11581	<desc>
11582	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
11583	</desc>
11584	</attribute>
11585
11586	<attribute name="online" type="boolean" readonly="yes">
11587	<desc>
11588	@c true if this snapshot is an online snapshot and @c false otherwise.
11589
11590	When this attribute is @c true, the
11591	<link to="IMachine::stateFilePath"/> attribute of the
11592	<link to="#machine"/> object associated with this snapshot
11593	will point to the saved state file. Otherwise, it will be
11594	an empty string.
11595	</desc>
11596	</attribute>
11597
11598	<attribute name="machine" type="IMachine" readonly="yes">
11599	<desc>
11600	Virtual machine this snapshot is taken on. This object
11601	stores all settings the machine had when taking this snapshot.
11602	<note>
11603	The returned machine object is immutable, i.e. no
11604	any settings can be changed.
11605	</note>
11606	</desc>
11607	</attribute>
11608
11609	<attribute name="parent" type="ISnapshot" readonly="yes">
11610	<desc>
11611	Parent snapshot (a snapshot this one is based on), or
11612	@c null if the snapshot has no parent (i.e. is the first snapshot).
11613	</desc>
11614	</attribute>
11615
11616	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
11617	<desc>
11618	Child snapshots (all snapshots having this one as a parent).
11619	By inspecting this attribute starting with a machine's root snapshot
11620	(which can be obtained by calling <link to="IMachine::findSnapshot" />
11621	with a @c null UUID), a machine's snapshots tree can be iterated over.
11622	</desc>
11623	</attribute>
11624
11625	<method name="getChildrenCount" const="yes">
11626	<desc>
11627	Returns the number of direct childrens of this snapshot.
11628	</desc>
11629	<param name="childrenCount" type="unsigned long" dir="return">
11630	<desc>
11631	</desc>
11632	</param>
11633	</method>
11634
11635	</interface>
11636
11637
11638	<!--
11639	// IMedium
11640	/////////////////////////////////////////////////////////////////////////
11641	-->
11642
11643	<enum
11644	name="MediumState"
11645	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
11646	>
11647	<desc>
11648	Virtual medium state.
11649	<see><link to="IMedium"/></see>
11650	</desc>
11651
11652	<const name="NotCreated" value="0">
11653	<desc>
11654	Associated medium storage does not exist (either was not created yet or
11655	was deleted).
11656	</desc>
11657	</const>
11658	<const name="Created" value="1">
11659	<desc>
11660	Associated storage exists and accessible; this gets set if the
11661	accessibility check performed by <link to="IMedium::refreshState" />
11662	was successful.
11663	</desc>
11664	</const>
11665	<const name="LockedRead" value="2">
11666	<desc>
11667	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
11668	no data modification is possible.
11669	</desc>
11670	</const>
11671	<const name="LockedWrite" value="3">
11672	<desc>
11673	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
11674	no concurrent data reading or modification is possible.
11675	</desc>
11676	</const>
11677	<const name="Inaccessible" value="4">
11678	<desc>
11679	Medium accessibility check (see <link to="IMedium::refreshState" />) has
11680	not yet been performed, or else, associated medium storage is not
11681	accessible. In the first case, <link to="IMedium::lastAccessError"/>
11682	is empty, in the second case, it describes the error that occurred.
11683	</desc>
11684	</const>
11685	<const name="Creating" value="5">
11686	<desc>
11687	Associated medium storage is being created.
11688	</desc>
11689	</const>
11690	<const name="Deleting" value="6">
11691	<desc>
11692	Associated medium storage is being deleted.
11693	</desc>
11694	</const>
11695	</enum>
11696
11697	<enum
11698	name="MediumType"
11699	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
11700	>
11701	<desc>
11702	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
11703	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
11704	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
11705	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
11706	</desc>
11707
11708	<const name="Normal" value="0">
11709	<desc>
11710	Normal medium (attached directly or indirectly, preserved
11711	when taking snapshots).
11712	</desc>
11713	</const>
11714	<const name="Immutable" value="1">
11715	<desc>
11716	Immutable medium (attached indirectly, changes are wiped out
11717	the next time the virtual machine is started).
11718	</desc>
11719	</const>
11720	<const name="Writethrough" value="2">
11721	<desc>
11722	Write through medium (attached directly, ignored when
11723	taking snapshots).
11724	</desc>
11725	</const>
11726	<const name="Shareable" value="3">
11727	<desc>
11728	Allow using this medium concurrently by several machines.
11729	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
11730	</desc>
11731	</const>
11732	<const name="Readonly" value="4">
11733	<desc>
11734	A readonly medium, which can of course be used by several machines.
11735	<note>Present and accepted since VirtualBox 4.0.</note>
11736	</desc>
11737	</const>
11738	<const name="MultiAttach" value="5">
11739	<desc>
11740	A medium which is indirectly attached, so that one base medium can
11741	be used for several VMs which have their own differencing medium to
11742	store their modifications. In some sense a variant of Immutable
11743	with unset AutoReset flag in each differencing medium.
11744	<note>Present and accepted since VirtualBox 4.0.</note>
11745	</desc>
11746	</const>
11747	</enum>
11748
11749	<enum
11750	name="MediumVariant"
11751	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
11752	>
11753	<desc>
11754	Virtual medium image variant. More than one flag may be set.
11755	<see><link to="IMedium"/></see>
11756	</desc>
11757
11758	<const name="Standard" value="0">
11759	<desc>
11760	No particular variant requested, results in using the backend default.
11761	</desc>
11762	</const>
11763	<const name="VmdkSplit2G" value="0x01">
11764	<desc>
11765	VMDK image split in chunks of less than 2GByte.
11766	</desc>
11767	</const>
11768	<const name="VmdkRawDisk" value="0x02">
11769	<desc>
11770	VMDK image representing a raw disk.
11771	</desc>
11772	</const>
11773	<const name="VmdkStreamOptimized" value="0x04">
11774	<desc>
11775	VMDK streamOptimized image. Special import/export format which is
11776	read-only/append-only.
11777	</desc>
11778	</const>
11779	<const name="VmdkESX" value="0x08">
11780	<desc>
11781	VMDK format variant used on ESX products.
11782	</desc>
11783	</const>
11784	<const name="Fixed" value="0x10000">
11785	<desc>
11786	Fixed image. Only allowed for base images.
11787	</desc>
11788	</const>
11789	<const name="Diff" value="0x20000">
11790	<desc>
11791	Differencing image. Only allowed for child images.
11792	</desc>
11793	</const>
11794	<const name="NoCreateDir" value="0x40000000">
11795	<desc>
11796	Special flag which suppresses automatic creation of the subdirectory.
11797	Only used when passing the medium variant as an input parameter.
11798	</desc>
11799	</const>
11800	</enum>
11801
11802	<interface
11803	name="IMediumAttachment" extends="$unknown"
11804	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
11805	wsmap="struct"
11806	>
11807	<desc>
11808	The IMediumAttachment interface links storage media to virtual machines.
11809	For each medium (<link to="IMedium"/>) which has been attached to a
11810	storage controller (<link to="IStorageController"/>) of a machine
11811	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
11812	method, one instance of IMediumAttachment is added to the machine's
11813	<link to="IMachine::mediumAttachments"/> array attribute.
11814
11815	Each medium attachment specifies the storage controller as well as a
11816	port and device number and the IMedium instance representing a virtual
11817	hard disk or floppy or DVD image.
11818
11819	For removable media (DVDs or floppies), there are two additional
11820	options. For one, the IMedium instance can be @c null to represent
11821	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
11822	secondly, the medium can be one of the pseudo-media for host drives
11823	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
11824
11825	<h3>Attaching Hard Disks</h3>
11826
11827	Hard disks are attached to virtual machines using the
11828	<link to="IMachine::attachDevice"/> method and detached using the
11829	<link to="IMachine::detachDevice"/> method. Depending on a medium's
11830	type (see <link to="IMedium::type" />), hard disks are attached either
11831	<i>directly</i> or <i>indirectly</i>.
11832
11833	When a hard disk is being attached directly, it is associated with the
11834	virtual machine and used for hard disk operations when the machine is
11835	running. When a hard disk is being attached indirectly, a new differencing
11836	hard disk linked to it is implicitly created and this differencing hard
11837	disk is associated with the machine and used for hard disk operations.
11838	This also means that if <link to="IMachine::attachDevice"/> performs
11839	a direct attachment then the same hard disk will be returned in response
11840	to the subsequent <link to="IMachine::getMedium"/> call; however if
11841	an indirect attachment is performed then
11842	<link to="IMachine::getMedium"/> will return the implicitly created
11843	differencing hard disk, not the original one passed to <link
11844	to="IMachine::attachDevice"/>. In detail:
11845
11846	<ul>
11847	<li><b>Normal base</b> hard disks that do not have children (i.e.
11848	differencing hard disks linked to them) and that are not already
11849	attached to virtual machines in snapshots are attached <b>directly</b>.
11850	Otherwise, they are attached <b>indirectly</b> because having
11851	dependent children or being part of the snapshot makes it impossible
11852	to modify hard disk contents without breaking the integrity of the
11853	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
11854	quickly determine the kind of the attachment for the given hard
11855	disk. Note that if a normal base hard disk is to be indirectly
11856	attached to a virtual machine with snapshots then a special
11857	procedure called <i>smart attachment</i> is performed (see below).</li>
11858	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
11859	they are attached <b>directly</b> if they do not have children and are
11860	not attached to virtual machines in snapshots, and <b>indirectly</b>
11861	otherwise. Note that the smart attachment procedure is never performed
11862	for differencing hard disks.</li>
11863	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
11864	they are designed to be non-writable. If an immutable hard disk is
11865	attached to a virtual machine with snapshots then a special
11866	procedure called smart attachment is performed (see below).</li>
11867	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
11868	also as designed. This also means that writethrough hard disks cannot
11869	have other hard disks linked to them at all.</li>
11870	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
11871	also as designed. This also means that shareable hard disks cannot
11872	have other hard disks linked to them at all. They behave almost
11873	like writethrough hard disks, except that shareable hard disks can
11874	be attached to several virtual machines which are running, allowing
11875	concurrent accesses. You need special cluster software running in
11876	the virtual machines to make use of such disks.</li>
11877	</ul>
11878
11879	Note that the same hard disk, regardless of its type, may be attached to
11880	more than one virtual machine at a time. In this case, the machine that is
11881	started first gains exclusive access to the hard disk and attempts to
11882	start other machines having this hard disk attached will fail until the
11883	first machine is powered down.
11884
11885	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
11886	that the given hard disk remains associated with the given machine after a
11887	successful <link to="IMachine::detachDevice"/> call until
11888	<link to="IMachine::saveSettings"/> is called to save all changes to
11889	machine settings to disk. This deferring is necessary to guarantee that
11890	the hard disk configuration may be restored at any time by a call to
11891	<link to="IMachine::discardSettings"/> before the settings
11892	are saved (committed).
11893
11894	Note that if <link to="IMachine::discardSettings"/> is called after
11895	indirectly attaching some hard disks to the machine but before a call to
11896	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
11897	all differencing hard disks implicitly created by
11898	<link to="IMachine::attachDevice"/> for these indirect attachments.
11899	Such implicitly created hard disks will also be immediately deleted when
11900	detached explicitly using the <link to="IMachine::detachDevice"/>
11901	call if it is made before <link to="IMachine::saveSettings"/>. This
11902	implicit deletion is safe because newly created differencing hard
11903	disks do not contain any user data.
11904
11905	However, keep in mind that detaching differencing hard disks that were
11906	implicitly created by <link to="IMachine::attachDevice"/>
11907	before the last <link to="IMachine::saveSettings"/> call will
11908	<b>not</b> implicitly delete them as they may already contain some data
11909	(for example, as a result of virtual machine execution). If these hard
11910	disks are no more necessary, the caller can always delete them explicitly
11911	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
11912	from this machine by the <link to="IMachine::saveSettings"/> call.
11913
11914	<h3>Smart Attachment</h3>
11915
11916	When normal base or immutable hard disks are indirectly attached to a
11917	virtual machine then some additional steps are performed to make sure the
11918	virtual machine will have the most recent "view" of the hard disk being
11919	attached. These steps include walking through the machine's snapshots
11920	starting from the current one and going through ancestors up to the first
11921	snapshot. Hard disks attached to the virtual machine in all
11922	of the encountered snapshots are checked whether they are descendants of
11923	the given normal base or immutable hard disk. The first found child (which
11924	is the differencing hard disk) will be used instead of the normal base or
11925	immutable hard disk as a parent for creating a new differencing hard disk
11926	that will be actually attached to the machine. And only if no descendants
11927	are found or if the virtual machine does not have any snapshots then the
11928	normal base or immutable hard disk will be used itself as a parent for
11929	this differencing hard disk.
11930
11931	It is easier to explain what smart attachment does using the
11932	following example:
11933	<pre>
11934	BEFORE attaching B.vdi: AFTER attaching B.vdi:
11935
11936	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
11937	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
11938	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
11939	Snapshot 4 (none) Snapshot 4 (none)
11940	CurState (none) CurState (D3->D2.vdi)
11941
11942	NOT
11943	...
11944	CurState (D3->B.vdi)
11945	</pre>
11946	The first column is the virtual machine configuration before the base hard
11947	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
11948	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
11949	mean that the hard disk that is actually attached to the machine is a
11950	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
11951	another hard disk, <tt>B.vdi</tt>.
11952
11953	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
11954	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
11955	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
11956	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
11957	it cannot be attached directly and needs an indirect attachment (i.e.
11958	implicit creation of a new differencing hard disk). Due to the smart
11959	attachment procedure, the new differencing hard disk
11960	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
11961	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
11962	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
11963	machine.
11964
11965	Note that if there is more than one descendant hard disk of the given base
11966	hard disk found in a snapshot, and there is an exact device, channel and
11967	bus match, then this exact match will be used. Otherwise, the youngest
11968	descendant will be picked up.
11969
11970	There is one more important aspect of the smart attachment procedure which
11971	is not related to snapshots at all. Before walking through the snapshots
11972	as described above, the backup copy of the current list of hard disk
11973	attachment is searched for descendants. This backup copy is created when
11974	the hard disk configuration is changed for the first time after the last
11975	<link to="IMachine::saveSettings"/> call and used by
11976	<link to="IMachine::discardSettings"/> to undo the recent hard disk
11977	changes. When such a descendant is found in this backup copy, it will be
11978	simply re-attached back, without creating a new differencing hard disk for
11979	it. This optimization is necessary to make it possible to re-attach the
11980	base or immutable hard disk to a different bus, channel or device slot
11981	without losing the contents of the differencing hard disk actually
11982	attached to the machine in place of it.
11983
11984	</desc>
11985
11986	<attribute name="medium" type="IMedium" readonly="yes">
11987	<desc>Medium object associated with this attachment; it
11988	can be @c null for removable devices.</desc>
11989	</attribute>
11990
11991	<attribute name="controller" type="wstring" readonly="yes">
11992	<desc>Name of the storage controller of this attachment; this
11993	refers to one of the controllers in <link to="IMachine::storageControllers" />
11994	by name.</desc>
11995	</attribute>
11996
11997	<attribute name="port" type="long" readonly="yes">
11998	<desc>Port number of this attachment.
11999	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12000	</desc>
12001	</attribute>
12002
12003	<attribute name="device" type="long" readonly="yes">
12004	<desc>Device slot number of this attachment.
12005	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12006	</desc>
12007	</attribute>
12008
12009	<attribute name="type" type="DeviceType" readonly="yes">
12010	<desc>Device type of this attachment.</desc>
12011	</attribute>
12012
12013	<attribute name="passthrough" type="boolean" readonly="yes">
12014	<desc>Pass I/O requests through to a device on the host.</desc>
12015	</attribute>
12016
12017	<attribute name="temporaryEject" type="boolean" readonly="yes">
12018	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12019	</attribute>
12020
12021	<attribute name="isEjected" type="boolean" readonly="yes">
12022	<desc>Signals that the removable medium has been ejected. This is not
12023	necessarily equivalent to having a @c null medium association.</desc>
12024	</attribute>
12025
12026	<attribute name="nonRotational" type="boolean" readonly="yes">
12027	<desc>Whether the associated medium is non-rotational.</desc>
12028	</attribute>
12029
12030	<attribute name="discard" type="boolean" readonly="yes">
12031	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12032	</attribute>
12033
12034	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12035	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12036	</attribute>
12037
12038	</interface>
12039
12040	<interface
12041	name="IMedium" extends="$unknown"
12042	uuid="29989373-b111-4654-8493-2e1176cba890"
12043	wsmap="managed"
12044	>
12045	<desc>
12046	The IMedium interface represents virtual storage for a machine's
12047	hard disks, CD/DVD or floppy drives. It will typically represent
12048	a disk image on the host, for example a VDI or VMDK file representing
12049	a virtual hard disk, or an ISO or RAW file representing virtual
12050	removable media, but can also point to a network location (e.g.
12051	for iSCSI targets).
12052
12053	Instances of IMedium are connected to virtual machines by way of medium
12054	attachments, which link the storage medium to a particular device slot
12055	of a storage controller of the virtual machine.
12056	In the VirtualBox API, virtual storage is therefore always represented
12057	by the following chain of object links:
12058
12059	<ul>
12060	<li><link to="IMachine::storageControllers"/> contains an array of
12061	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12062	these are instances of <link to="IStorageController"/>).</li>
12063	<li><link to="IMachine::mediumAttachments"/> contains an array of
12064	medium attachments (instances of <link to="IMediumAttachment"/>
12065	created by <link to="IMachine::attachDevice" />),
12066	each containing a storage controller from the above array, a
12067	port/device specification, and an instance of IMedium representing
12068	the medium storage (image file).
12069
12070	For removable media, the storage medium is optional; a medium
12071	attachment with no medium represents a CD/DVD or floppy drive
12072	with no medium inserted. By contrast, hard disk attachments
12073	will always have an IMedium object attached.</li>
12074	<li>Each IMedium in turn points to a storage unit (such as a file
12075	on the host computer or a network resource) that holds actual
12076	data. This location is represented by the <link to="#location"/>
12077	attribute.</li>
12078	</ul>
12079
12080	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12081	new hard disk media can be created with the VirtualBox API using the
12082	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12083	disks (see below) are usually implicitly created by VirtualBox as
12084	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12085	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12086	should be created with external tools and then opened from within VirtualBox.
12087
12088	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12089	drive. In that case the <link to="#id" /> attribute contains the UUID of
12090	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12091
12092	<h3>Media registries</h3>
12093
12094	When a medium has been opened or created using one of the aforementioned
12095	APIs, it becomes "known" to VirtualBox. Known media can be attached
12096	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12097	They also appear in the global
12098	<link to="IVirtualBox::hardDisks" />,
12099	<link to="IVirtualBox::DVDImages" /> and
12100	<link to="IVirtualBox::floppyImages" /> arrays.
12101
12102	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12103	in the VirtualBox.xml file, which was shared between all machines and made
12104	transporting machines and their media from one host to another difficult.
12105
12106	Starting with VirtualBox 4.0, media are only added to a registry when they are
12107	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12108	backwards compatibility, which registry a medium is added to depends on which
12109	VirtualBox version created a machine:
12110
12111	<ul>
12112	<li>If the medium has first been attached to a machine which was created by
12113	VirtualBox 4.0 or later, it is added to that machine's media registry in
12114	the machine XML settings file. This way all information about a machine's
12115	media attachments is contained in a single file and can be transported
12116	easily.</li>
12117	<li>For older media attachments (i.e. if the medium was first attached to a
12118	machine which was created with a VirtualBox version before 4.0), media
12119	continue to be registered in the global VirtualBox settings file, for
12120	backwards compatibility.</li>
12121	</ul>
12122
12123	See <link to="IVirtualBox::openMedium" /> for more information.
12124
12125	Media are removed from media registries by the <link to="IMedium::close"/>,
12126	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12127
12128	<h3>Accessibility checks</h3>
12129
12130	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12131	method is called explicitly on a medium. This is done to make the VirtualBox object
12132	ready for serving requests as fast as possible and let the end-user
12133	application decide if it needs to check media accessibility right away or not.
12134
12135	As a result, when VirtualBox starts up (e.g. the VirtualBox
12136	object gets created for the first time), all known media are in the
12137	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12138	attribute is an empty string because no actual accessibility check has
12139	been made yet.
12140
12141	After calling <link to="#refreshState" />, a medium is considered
12142	<i>accessible</i> if its storage unit can be read. In that case, the
12143	<link to="#state"/> attribute has a value of "Created". If the storage
12144	unit cannot be read (for example, because it is located on a disconnected
12145	network resource, or was accidentally deleted outside VirtualBox),
12146	the medium is considered <i>inaccessible</i>, which is indicated by the
12147	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12148	obtained by reading the <link to="#lastAccessError"/> attribute.
12149
12150	<h3>Medium types</h3>
12151
12152	There are five types of medium behavior which are stored in the
12153	<link to="#type"/> attribute (see <link to="MediumType" />) and
12154	which define the medium's behavior with attachments and snapshots.
12155
12156	All media can be also divided in two groups: <i>base</i> media and
12157	<i>differencing</i> media. A base medium contains all sectors of the
12158	medium data in its own storage and therefore can be used independently.
12159	In contrast, a differencing medium is a "delta" to some other medium and
12160	contains only those sectors which differ from that other medium, which is
12161	then called a <i>parent</i>. The differencing medium is said to be
12162	<i>linked to</i> that parent. The parent may be itself a differencing
12163	medium, thus forming a chain of linked media. The last element in that
12164	chain must always be a base medium. Note that several differencing
12165	media may be linked to the same parent medium.
12166
12167	Differencing media can be distinguished from base media by querying the
12168	<link to="#parent"/> attribute: base media do not have parents they would
12169	depend on, so the value of this attribute is always @c null for them.
12170	Using this attribute, it is possible to walk up the medium tree (from the
12171	child medium to its parent). It is also possible to walk down the tree
12172	using the <link to="#children"/> attribute.
12173
12174	Note that the type of all differencing media is "normal"; all other
12175	values are meaningless for them. Base media may be of any type.
12176
12177	<h3>Automatic composition of the file name part</h3>
12178
12179	Another extension to the <link to="IMedium::location"/> attribute is that
12180	there is a possibility to cause VirtualBox to compose a unique value for
12181	the file name part of the location using the UUID of the hard disk. This
12182	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12183	e.g. before the storage unit is created, and works as follows. You set the
12184	value of the <link to="IMedium::location"/> attribute to a location
12185	specification which only contains the path specification but not the file
12186	name part and ends with either a forward slash or a backslash character.
12187	In response, VirtualBox will generate a new UUID for the hard disk and
12188	compose the file name using the following pattern:
12189	<pre>
12190	<path>/{<uuid>}.<ext>
12191	</pre>
12192	where <tt><path></tt> is the supplied path specification,
12193	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12194	is the default extension for the storage format of this hard disk. After
12195	that, you may call any of the methods that create a new hard disk storage
12196	unit and they will use the generated UUID and file name.
12197	</desc>
12198
12199	<attribute name="id" type="uuid" mod="string" readonly="yes">
12200	<desc>
12201	UUID of the medium. For a newly created medium, this value is a randomly
12202	generated UUID.
12203
12204	<note>
12205	For media in one of MediumState_NotCreated, MediumState_Creating or
12206	MediumState_Deleting states, the value of this property is undefined
12207	and will most likely be an empty UUID.
12208	</note>
12209	</desc>
12210	</attribute>
12211
12212	<attribute name="description" type="wstring">
12213	<desc>
12214	Optional description of the medium. For a newly created medium the value
12215	of this attribute is an empty string.
12216
12217	Medium types that don't support this attribute will return E_NOTIMPL in
12218	attempt to get or set this attribute's value.
12219
12220	<note>
12221	For some storage types, reading this attribute may return an outdated
12222	(last known) value when <link to="#state"/> is <link
12223	to="MediumState_Inaccessible"/> or <link
12224	to="MediumState_LockedWrite"/> because the value of this attribute is
12225	stored within the storage unit itself. Also note that changing the
12226	attribute value is not possible in such case, as well as when the
12227	medium is the <link to="MediumState_LockedRead"/> state.
12228	</note>
12229	</desc>
12230	</attribute>
12231
12232	<attribute name="state" type="MediumState" readonly="yes">
12233	<desc>
12234	Returns the current medium state, which is the last state set by
12235	the accessibility check performed by <link to="#refreshState"/>.
12236	If that method has not yet been called on the medium, the state
12237	is "Inaccessible"; as opposed to truly inaccessible media, the
12238	value of <link to="#lastAccessError"/> will be an empty string in
12239	that case.
12240
12241	<note>As of version 3.1, this no longer performs an accessibility check
12242	automatically; call <link to="#refreshState"/> for that.
12243	</note>
12244	</desc>
12245	</attribute>
12246
12247	<attribute name="variant" type="unsigned long" readonly="yes">
12248	<desc>
12249	Returns the storage format variant information for this medium
12250	as a combination of the flags described at <link to="MediumVariant" />.
12251	Before <link to="#refreshState"/> is called this method returns
12252	an undefined value.
12253	</desc>
12254	</attribute>
12255
12256	<attribute name="location" type="wstring">
12257	<desc>
12258	Location of the storage unit holding medium data.
12259
12260	The format of the location string is medium type specific. For medium
12261	types using regular files in a host's file system, the location
12262	string is the full file name.
12263
12264	Some medium types may support changing the storage unit location by
12265	simply changing the value of this property. If this operation is not
12266	supported, the implementation will return E_NOTIMPL in attempt to set
12267	this attribute's value.
12268
12269	When setting a value of the location attribute which is a regular file
12270	in the host's file system, the given file name may be either relative to
12271	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12272	absolute. Note that if the given location specification does not contain
12273	the file extension part then a proper default extension will be
12274	automatically appended by the implementation depending on the medium type.
12275	</desc>
12276	</attribute>
12277
12278	<attribute name="name" type="wstring" readonly="yes">
12279	<desc>
12280	Name of the storage unit holding medium data.
12281
12282	The returned string is a short version of the <link to="#location"/>
12283	attribute that is suitable for representing the medium in situations
12284	where the full location specification is too long (such as lists
12285	and comboboxes in GUI frontends). This string is also used by frontends
12286	to sort the media list alphabetically when needed.
12287
12288	For example, for locations that are regular files in the host's file
12289	system, the value of this attribute is just the file name (+ extension),
12290	without the path specification.
12291
12292	Note that as opposed to the <link to="#location"/> attribute, the name
12293	attribute will not necessary be unique for a list of media of the
12294	given type and format.
12295	</desc>
12296	</attribute>
12297
12298	<attribute name="deviceType" type="DeviceType" readonly="yes">
12299	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12300	medium.</desc>
12301	</attribute>
12302
12303	<attribute name="hostDrive" type="boolean" readonly="yes">
12304	<desc>True if this corresponds to a drive on the host.</desc>
12305	</attribute>
12306
12307	<attribute name="size" type="long long" readonly="yes">
12308	<desc>
12309	Physical size of the storage unit used to hold medium data (in bytes).
12310
12311	<note>
12312	For media whose <link to="#state"/> is <link
12313	to="MediumState_Inaccessible"/>, the value of this property is the
12314	last known size. For <link to="MediumState_NotCreated"/> media,
12315	the returned value is zero.
12316	</note>
12317	</desc>
12318	</attribute>
12319
12320	<attribute name="format" type="wstring" readonly="yes">
12321	<desc>
12322	Storage format of this medium.
12323
12324	The value of this attribute is a string that specifies a backend used
12325	to store medium data. The storage format is defined when you create a
12326	new medium or automatically detected when you open an existing medium,
12327	and cannot be changed later.
12328
12329	The list of all storage formats supported by this VirtualBox
12330	installation can be obtained using
12331	<link to="ISystemProperties::mediumFormats"/>.
12332	</desc>
12333	</attribute>
12334
12335	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12336	<desc>
12337	Storage medium format object corresponding to this medium.
12338
12339	The value of this attribute is a reference to the medium format object
12340	that specifies the backend properties used to store medium data. The
12341	storage format is defined when you create a new medium or automatically
12342	detected when you open an existing medium, and cannot be changed later.
12343
12344	<note>@c null is returned if there is no associated medium format
12345	object. This can e.g. happen for medium objects representing host
12346	drives and other special medium objects.</note>
12347	</desc>
12348	</attribute>
12349
12350	<attribute name="type" type="MediumType">
12351	<desc>
12352	Type (role) of this medium.
12353
12354	The following constraints apply when changing the value of this
12355	attribute:
12356	<ul>
12357	<li>If a medium is attached to a virtual machine (either in the
12358	current state or in one of the snapshots), its type cannot be
12359	changed.
12360	</li>
12361	<li>As long as the medium has children, its type cannot be set
12362	to <link to="MediumType_Writethrough"/>.
12363	</li>
12364	<li>The type of all differencing media is
12365	<link to="MediumType_Normal"/> and cannot be changed.
12366	</li>
12367	</ul>
12368
12369	The type of a newly created or opened medium is set to
12370	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12371	which have a type of <link to="MediumType_Writethrough"/>.
12372	</desc>
12373	</attribute>
12374
12375	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12376	<desc>
12377	Returns which medium types can selected for this medium.
12378
12379	<result name="E_NOTIMPL">
12380	This attribute is not implemented at the moment.
12381	</result>
12382	</desc>
12383	</attribute>
12384
12385	<attribute name="parent" type="IMedium" readonly="yes">
12386	<desc>
12387	Parent of this medium (the medium this medium is directly based
12388	on).
12389
12390	Only differencing media have parents. For base (non-differencing)
12391	media, @c null is returned.
12392	</desc>
12393	</attribute>
12394
12395	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12396	<desc>
12397	Children of this medium (all differencing media directly based
12398	on this medium). A @c null array is returned if this medium
12399	does not have any children.
12400	</desc>
12401	</attribute>
12402
12403	<attribute name="base" type="IMedium" readonly="yes">
12404	<desc>
12405	Base medium of this medium.
12406
12407	If this is a differencing medium, its base medium is the medium
12408	the given medium branch starts from. For all other types of media, this
12409	property returns the medium object itself (i.e. the same object this
12410	property is read on).
12411	</desc>
12412	</attribute>
12413
12414	<attribute name="readOnly" type="boolean" readonly="yes">
12415	<desc>
12416	Returns @c true if this medium is read-only and @c false otherwise.
12417
12418	A medium is considered to be read-only when its contents cannot be
12419	modified without breaking the integrity of other parties that depend on
12420	this medium such as its child media or snapshots of virtual machines
12421	where this medium is attached to these machines. If there are no
12422	children and no such snapshots then there is no dependency and the
12423	medium is not read-only.
12424
12425	The value of this attribute can be used to determine the kind of the
12426	attachment that will take place when attaching this medium to a
12427	virtual machine. If the value is @c false then the medium will
12428	be attached directly. If the value is @c true then the medium
12429	will be attached indirectly by creating a new differencing child
12430	medium for that. See the interface description for more information.
12431
12432	Note that all <link to="MediumType_Immutable">Immutable</link> media
12433	are always read-only while all
12434	<link to="MediumType_Writethrough">Writethrough</link> media are
12435	always not.
12436
12437	<note>
12438	The read-only condition represented by this attribute is related to
12439	the medium type and usage, not to the current
12440	<link to="IMedium::state">medium state</link> and not to the read-only
12441	state of the storage unit.
12442	</note>
12443	</desc>
12444	</attribute>
12445
12446	<attribute name="logicalSize" type="long long" readonly="yes">
12447	<desc>
12448	Logical size of this medium (in bytes), as reported to the
12449	guest OS running inside the virtual machine this medium is
12450	attached to. The logical size is defined when the medium is created
12451	and cannot be changed later.
12452
12453	<note>
12454	Reading this property on a differencing medium will return the size
12455	of its <link to="#base"/> medium.
12456	</note>
12457	<note>
12458	For media whose state is <link to="#state"/> is <link
12459	to="MediumState_Inaccessible"/>, the value of this property is the
12460	last known logical size. For <link to="MediumState_NotCreated"/>
12461	media, the returned value is zero.
12462	</note>
12463	</desc>
12464	</attribute>
12465
12466	<attribute name="autoReset" type="boolean">
12467	<desc>
12468	Whether this differencing medium will be automatically reset each
12469	time a virtual machine it is attached to is powered up. This
12470	attribute is automatically set to @c true for the last
12471	differencing image of an "immutable" medium (see
12472	<link to="MediumType" />).
12473
12474	See <link to="#reset"/> for more information about resetting
12475	differencing media.
12476
12477	<note>
12478	Reading this property on a base (non-differencing) medium will
12479	always @c false. Changing the value of this property in this
12480	case is not supported.
12481	</note>
12482
12483	<result name="VBOX_E_NOT_SUPPORTED">
12484	This is not a differencing medium (when changing the attribute
12485	value).
12486	</result>
12487	</desc>
12488	</attribute>
12489
12490	<attribute name="lastAccessError" type="wstring" readonly="yes">
12491	<desc>
12492	Text message that represents the result of the last accessibility
12493	check performed by <link to="#refreshState"/>.
12494
12495	An empty string is returned if the last accessibility check
12496	was successful or has not yet been called. As a result, if
12497	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12498	then <link to="#refreshState"/> has yet to be called; this is the
12499	default value of media after VirtualBox initialization.
12500	A non-empty string indicates a failure and should normally describe
12501	a reason of the failure (for example, a file read error).
12502	</desc>
12503	</attribute>
12504
12505	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12506	<desc>
12507	Array of UUIDs of all machines this medium is attached to.
12508
12509	A @c null array is returned if this medium is not attached to any
12510	machine or to any machine's snapshot.
12511
12512	<note>
12513	The returned array will include a machine even if this medium is not
12514	attached to that machine in the current state but attached to it in
12515	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12516	details.
12517	</note>
12518	</desc>
12519	</attribute>
12520
12521	<method name="setIds">
12522	<desc>
12523	Changes the UUID and parent UUID for a hard disk medium.
12524	</desc>
12525	<param name="setImageId" type="boolean" dir="in">
12526	<desc>
12527	Select whether a new image UUID is set or not.
12528	</desc>
12529	</param>
12530	<param name="imageId" type="uuid" mod="string" dir="in">
12531	<desc>
12532	New UUID for the image. If an empty string is passed, then a new
12533	UUID is automatically created, provided that @a setImageId is @c true.
12534	Specifying a zero UUID is not allowed.
12535	</desc>
12536	</param>
12537	<param name="setParentId" type="boolean" dir="in">
12538	<desc>
12539	Select whether a new parent UUID is set or not.
12540	</desc>
12541	</param>
12542	<param name="parentId" type="uuid" mod="string" dir="in">
12543	<desc>
12544	New parent UUID for the image. If an empty string is passed, then a
12545	new UUID is automatically created, provided @a setParentId is
12546	@c true. A zero UUID is valid.
12547	</desc>
12548	</param>
12549	<result name="E_INVALIDARG">
12550	Invalid parameter combination.
12551	</result>
12552	<result name="VBOX_E_NOT_SUPPORTED">
12553	Medium is not a hard disk medium.
12554	</result>
12555	</method>
12556
12557	<method name="refreshState">
12558	<desc>
12559	If the current medium state (see <link to="MediumState"/>) is one of
12560	"Created", "Inaccessible" or "LockedRead", then this performs an
12561	accessibility check on the medium and sets the value of the <link to="#state"/>
12562	attribute accordingly; that value is also returned for convenience.
12563
12564	For all other state values, this does not perform a refresh but returns
12565	the state only.
12566
12567	The refresh, if performed, may take a long time (several seconds or even
12568	minutes, depending on the storage unit location and format) because it performs an
12569	accessibility check of the storage unit. This check may cause a significant
12570	delay if the storage unit of the given medium is, for example, a file located
12571	on a network share which is not currently accessible due to connectivity
12572	problems. In that case, the call will not return until a timeout
12573	interval defined by the host OS for this operation expires. For this reason,
12574	it is recommended to never read this attribute on the main UI thread to avoid
12575	making the UI unresponsive.
12576
12577	If the last known state of the medium is "Created" and the accessibility
12578	check fails, then the state would be set to "Inaccessible", and
12579	<link to="#lastAccessError"/> may be used to get more details about the
12580	failure. If the state of the medium is "LockedRead", then it remains the
12581	same, and a non-empty value of <link to="#lastAccessError"/> will
12582	indicate a failed accessibility check in this case.
12583
12584	Note that not all medium states are applicable to all medium types.
12585	</desc>
12586	<param name="state" type="MediumState" dir="return">
12587	<desc>
12588	New medium state.
12589	</desc>
12590	</param>
12591	</method>
12592
12593	<method name="getSnapshotIds">
12594	<desc>
12595	Returns an array of UUIDs of all snapshots of the given machine where
12596	this medium is attached to.
12597
12598	If the medium is attached to the machine in the current state, then the
12599	first element in the array will always be the ID of the queried machine
12600	(i.e. the value equal to the @c machineId argument), followed by
12601	snapshot IDs (if any).
12602
12603	If the medium is not attached to the machine in the current state, then
12604	the array will contain only snapshot IDs.
12605
12606	The returned array may be @c null if this medium is not attached
12607	to the given machine at all, neither in the current state nor in one of
12608	the snapshots.
12609	</desc>
12610	<param name="machineId" type="uuid" mod="string" dir="in">
12611	<desc>
12612	UUID of the machine to query.
12613	</desc>
12614	</param>
12615	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
12616	<desc>
12617	Array of snapshot UUIDs of the given machine using this medium.
12618	</desc>
12619	</param>
12620	</method>
12621
12622	<method name="lockRead">
12623	<desc>
12624	Locks this medium for reading.
12625
12626	A read lock is shared: many clients can simultaneously lock the
12627	same medium for reading unless it is already locked for writing (see
12628	<link to="#lockWrite"/>) in which case an error is returned.
12629
12630	When the medium is locked for reading, it cannot be modified
12631	from within VirtualBox. This means that any method that changes
12632	the properties of this medium or contents of the storage unit
12633	will return an error (unless explicitly stated otherwise). That
12634	includes an attempt to start a virtual machine that wants to
12635	write to the the medium.
12636
12637	When the virtual machine is started up, it locks for reading all
12638	media it uses in read-only mode. If some medium cannot be locked
12639	for reading, the startup procedure will fail.
12640	A medium is typically locked for reading while it is used by a running
12641	virtual machine but has a depending differencing image that receives
12642	the actual write operations. This way one base medium can have
12643	multiple child differencing images which can be written to
12644	simultaneously. Read-only media such as DVD and floppy images are
12645	also locked for reading only (so they can be in use by multiple
12646	machines simultaneously).
12647
12648	A medium is also locked for reading when it is the source of a
12649	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12650
12651	The medium locked for reading must be unlocked using the <link
12652	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
12653	can be nested and must be followed by the same number of paired
12654	<link to="#unlockRead"/> calls.
12655
12656	This method sets the medium state (see <link to="#state"/>) to
12657	"LockedRead" on success. The medium's previous state must be
12658	one of "Created", "Inaccessible" or "LockedRead".
12659
12660	Locking an inaccessible medium is not an error; this method performs
12661	a logical lock that prevents modifications of this medium through
12662	the VirtualBox API, not a physical file-system lock of the underlying
12663	storage unit.
12664
12665	This method returns the current state of the medium
12666	<i>before</i> the operation.
12667
12668	<result name="VBOX_E_INVALID_OBJECT_STATE">
12669	Invalid medium state (e.g. not created, locked, inaccessible,
12670	creating, deleting).
12671	</result>
12672
12673	</desc>
12674	<param name="state" type="MediumState" dir="return">
12675	<desc>
12676	State of the medium after the operation.
12677	</desc>
12678	</param>
12679	</method>
12680
12681	<method name="unlockRead">
12682	<desc>
12683	Cancels the read lock previously set by <link to="#lockRead"/>.
12684
12685	For both success and failure, this method returns the current state
12686	of the medium <i>after</i> the operation.
12687
12688	See <link to="#lockRead"/> for more details.
12689
12690	<result name="VBOX_E_INVALID_OBJECT_STATE">
12691	Medium not locked for reading.
12692	</result>
12693
12694	</desc>
12695	<param name="state" type="MediumState" dir="return">
12696	<desc>
12697	State of the medium after the operation.
12698	</desc>
12699	</param>
12700	</method>
12701
12702	<method name="lockWrite">
12703	<desc>
12704	Locks this medium for writing.
12705
12706	A write lock, as opposed to <link to="#lockRead"/>, is
12707	exclusive: there may be only one client holding a write lock,
12708	and there may be no read locks while the write lock is held.
12709	As a result, read-locking fails if a write lock is held, and
12710	write-locking fails if either a read or another write lock is held.
12711
12712	When a medium is locked for writing, it cannot be modified
12713	from within VirtualBox, and it is not guaranteed that the values
12714	of its properties are up-to-date. Any method that changes the
12715	properties of this medium or contents of the storage unit will
12716	return an error (unless explicitly stated otherwise).
12717
12718	When a virtual machine is started up, it locks for writing all
12719	media it uses to write data to. If any medium could not be locked
12720	for writing, the startup procedure will fail. If a medium has
12721	differencing images, then while the machine is running, only
12722	the last ("leaf") differencing image is locked for writing,
12723	whereas its parents are locked for reading only.
12724
12725	A medium is also locked for writing when it is the target of a
12726	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12727
12728	The medium locked for writing must be unlocked using the <link
12729	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
12730
12731	This method sets the medium state (see <link to="#state"/>) to
12732	"LockedWrite" on success. The medium's previous state must be
12733	either "Created" or "Inaccessible".
12734
12735	Locking an inaccessible medium is not an error; this method performs
12736	a logical lock that prevents modifications of this medium through
12737	the VirtualBox API, not a physical file-system lock of the underlying
12738	storage unit.
12739
12740	For both, success and failure, this method returns the current
12741	state of the medium <i>before</i> the operation.
12742
12743	<result name="VBOX_E_INVALID_OBJECT_STATE">
12744	Invalid medium state (e.g. not created, locked, inaccessible,
12745	creating, deleting).
12746	</result>
12747
12748	</desc>
12749	<param name="state" type="MediumState" dir="return">
12750	<desc>
12751	State of the medium after the operation.
12752	</desc>
12753	</param>
12754	</method>
12755
12756	<method name="unlockWrite">
12757	<desc>
12758	Cancels the write lock previously set by <link to="#lockWrite"/>.
12759
12760	For both success and failure, this method returns the current
12761	state of the medium <i>after</i> the operation.
12762
12763	See <link to="#lockWrite"/> for more details.
12764
12765	<result name="VBOX_E_INVALID_OBJECT_STATE">
12766	Medium not locked for writing.
12767	</result>
12768
12769	</desc>
12770	<param name="state" type="MediumState" dir="return">
12771	<desc>
12772	State of the medium after the operation.
12773	</desc>
12774	</param>
12775	</method>
12776
12777	<method name="close">
12778	<desc>
12779	Closes this medium.
12780
12781	The medium must not be attached to any known virtual machine
12782	and must not have any known child media, otherwise the
12783	operation will fail.
12784
12785	When the medium is successfully closed, it is removed from
12786	the list of registered media, but its storage unit is not
12787	deleted. In particular, this means that this medium can
12788	later be opened again using the <link to="IVirtualBox::openMedium"/>
12789	call.
12790
12791	Note that after this method successfully returns, the given medium
12792	object becomes uninitialized. This means that any attempt
12793	to call any of its methods or attributes will fail with the
12794	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
12795
12796	<result name="VBOX_E_INVALID_OBJECT_STATE">
12797	Invalid medium state (other than not created, created or
12798	inaccessible).
12799	</result>
12800	<result name="VBOX_E_OBJECT_IN_USE">
12801	Medium attached to virtual machine.
12802	</result>
12803	<result name="VBOX_E_FILE_ERROR">
12804	Settings file not accessible.
12805	</result>
12806	<result name="VBOX_E_XML_ERROR">
12807	Could not parse the settings file.
12808	</result>
12809
12810	</desc>
12811	</method>
12812
12813	<!-- property methods -->
12814
12815	<method name="getProperty" const="yes">
12816	<desc>
12817	Returns the value of the custom medium property with the given name.
12818
12819	The list of all properties supported by the given medium format can
12820	be obtained with <link to="IMediumFormat::describeProperties"/>.
12821
12822	<note>If this method returns an empty string in @a value, the requested
12823	property is supported but currently not assigned any value.</note>
12824
12825	<result name="VBOX_E_OBJECT_NOT_FOUND">
12826	Requested property does not exist (not supported by the format).
12827	</result>
12828	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12829	</desc>
12830	<param name="name" type="wstring" dir="in">
12831	<desc>Name of the property to get.</desc>
12832	</param>
12833	<param name="value" type="wstring" dir="return">
12834	<desc>Current property value.</desc>
12835	</param>
12836	</method>
12837
12838	<method name="setProperty">
12839	<desc>
12840	Sets the value of the custom medium property with the given name.
12841
12842	The list of all properties supported by the given medium format can
12843	be obtained with <link to="IMediumFormat::describeProperties"/>.
12844
12845	<note>Setting the property value to @c null or an empty string is
12846	equivalent to deleting the existing value. A default value (if it is
12847	defined for this property) will be used by the format backend in this
12848	case.</note>
12849
12850	<result name="VBOX_E_OBJECT_NOT_FOUND">
12851	Requested property does not exist (not supported by the format).
12852	</result>
12853	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12854	</desc>
12855	<param name="name" type="wstring" dir="in">
12856	<desc>Name of the property to set.</desc>
12857	</param>
12858	<param name="value" type="wstring" dir="in">
12859	<desc>Property value to set.</desc>
12860	</param>
12861	</method>
12862
12863	<method name="getProperties" const="yes">
12864	<desc>
12865	Returns values for a group of properties in one call.
12866
12867	The names of the properties to get are specified using the @a names
12868	argument which is a list of comma-separated property names or
12869	an empty string if all properties are to be returned.
12870	<note>Currently the value of this argument is ignored and the method
12871	always returns all existing properties.</note>
12872
12873	The list of all properties supported by the given medium format can
12874	be obtained with <link to="IMediumFormat::describeProperties"/>.
12875
12876	The method returns two arrays, the array of property names corresponding
12877	to the @a names argument and the current values of these properties.
12878	Both arrays have the same number of elements with each element at the
12879	given index in the first array corresponds to an element at the same
12880	index in the second array.
12881
12882	For properties that do not have assigned values, an empty string is
12883	returned at the appropriate index in the @a returnValues array.
12884
12885	</desc>
12886	<param name="names" type="wstring" dir="in">
12887	<desc>
12888	Names of properties to get.
12889	</desc>
12890	</param>
12891	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12892	<desc>Names of returned properties.</desc>
12893	</param>
12894	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12895	<desc>Values of returned properties.</desc>
12896	</param>
12897	</method>
12898
12899	<method name="setProperties">
12900	<desc>
12901	Sets values for a group of properties in one call.
12902
12903	The names of the properties to set are passed in the @a names
12904	array along with the new values for them in the @a values array. Both
12905	arrays have the same number of elements with each element at the given
12906	index in the first array corresponding to an element at the same index
12907	in the second array.
12908
12909	If there is at least one property name in @a names that is not valid,
12910	the method will fail before changing the values of any other properties
12911	from the @a names array.
12912
12913	Using this method over <link to="#setProperty"/> is preferred if you
12914	need to set several properties at once since it is more efficient.
12915
12916	The list of all properties supported by the given medium format can
12917	be obtained with <link to="IMediumFormat::describeProperties"/>.
12918
12919	Setting the property value to @c null or an empty string is equivalent
12920	to deleting the existing value. A default value (if it is defined for
12921	this property) will be used by the format backend in this case.
12922	</desc>
12923	<param name="names" type="wstring" safearray="yes" dir="in">
12924	<desc>Names of properties to set.</desc>
12925	</param>
12926	<param name="values" type="wstring" safearray="yes" dir="in">
12927	<desc>Values of properties to set.</desc>
12928	</param>
12929	</method>
12930
12931	<!-- storage methods -->
12932
12933	<method name="createBaseStorage">
12934	<desc>
12935	Starts creating a hard disk storage unit (fixed/dynamic, according
12936	to the variant flags) in in the background. The previous storage unit
12937	created for this object, if any, must first be deleted using
12938	<link to="#deleteStorage"/>, otherwise the operation will fail.
12939
12940	Before the operation starts, the medium is placed in
12941	<link to="MediumState_Creating"/> state. If the create operation
12942	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
12943	state.
12944
12945	After the returned progress object reports that the operation has
12946	successfully completed, the medium state will be set to <link
12947	to="MediumState_Created"/>, the medium will be remembered by this
12948	VirtualBox installation and may be attached to virtual machines.
12949
12950	<result name="VBOX_E_NOT_SUPPORTED">
12951	The variant of storage creation operation is not supported. See <link
12952	to="IMediumFormat::capabilities"/>.
12953	</result>
12954	</desc>
12955	<param name="logicalSize" type="long long" dir="in">
12956	<desc>Maximum logical size of the medium in bytes.</desc>
12957	</param>
12958	<param name="variant" type="unsigned long" dir="in">
12959	<desc>Exact image variant which should be created (as a combination of
12960	<link to="MediumVariant" /> flags).</desc>
12961	</param>
12962	<param name="progress" type="IProgress" dir="return">
12963	<desc>Progress object to track the operation completion.</desc>
12964	</param>
12965	</method>
12966
12967	<method name="deleteStorage">
12968	<desc>
12969	Starts deleting the storage unit of this medium.
12970
12971	The medium must not be attached to any known virtual machine and must
12972	not have any known child media, otherwise the operation will fail.
12973	It will also fail if there is no storage unit to delete or if deletion
12974	is already in progress, or if the medium is being in use (locked for
12975	read or for write) or inaccessible. Therefore, the only valid state for
12976	this operation to succeed is <link to="MediumState_Created"/>.
12977
12978	Before the operation starts, the medium is placed in
12979	<link to="MediumState_Deleting"/> state and gets removed from the list
12980	of remembered hard disks (media registry). If the delete operation
12981	fails, the medium will be remembered again and placed back to
12982	<link to="MediumState_Created"/> state.
12983
12984	After the returned progress object reports that the operation is
12985	complete, the medium state will be set to
12986	<link to="MediumState_NotCreated"/> and you will be able to use one of
12987	the storage creation methods to create it again.
12988
12989	<see><link to="#close"/></see>
12990
12991	<result name="VBOX_E_OBJECT_IN_USE">
12992	Medium is attached to a virtual machine.
12993	</result>
12994	<result name="VBOX_E_NOT_SUPPORTED">
12995	Storage deletion is not allowed because neither of storage creation
12996	operations are supported. See
12997	<link to="IMediumFormat::capabilities"/>.
12998	</result>
12999
13000	<note>
13001	If the deletion operation fails, it is not guaranteed that the storage
13002	unit still exists. You may check the <link to="IMedium::state"/> value
13003	to answer this question.
13004	</note>
13005	</desc>
13006	<param name="progress" type="IProgress" dir="return">
13007	<desc>Progress object to track the operation completion.</desc>
13008	</param>
13009	</method>
13010
13011	<!-- diff methods -->
13012
13013	<method name="createDiffStorage">
13014	<desc>
13015	Starts creating an empty differencing storage unit based on this
13016	medium in the format and at the location defined by the @a target
13017	argument.
13018
13019	The target medium must be in <link to="MediumState_NotCreated"/>
13020	state (i.e. must not have an existing storage unit). Upon successful
13021	completion, this operation will set the type of the target medium to
13022	<link to="MediumType_Normal"/> and create a storage unit necessary to
13023	represent the differencing medium data in the given format (according
13024	to the storage format of the target object).
13025
13026	After the returned progress object reports that the operation is
13027	successfully complete, the target medium gets remembered by this
13028	VirtualBox installation and may be attached to virtual machines.
13029
13030	<note>
13031	The medium will be set to <link to="MediumState_LockedRead"/>
13032	state for the duration of this operation.
13033	</note>
13034	<result name="VBOX_E_OBJECT_IN_USE">
13035	Medium not in @c NotCreated state.
13036	</result>
13037	</desc>
13038	<param name="target" type="IMedium" dir="in">
13039	<desc>Target medium.</desc>
13040	</param>
13041	<param name="variant" type="unsigned long" dir="in">
13042	<desc>Exact image variant which should be created (as a combination of
13043	<link to="MediumVariant" /> flags).</desc>
13044	</param>
13045	<param name="progress" type="IProgress" dir="return">
13046	<desc>Progress object to track the operation completion.</desc>
13047	</param>
13048	</method>
13049
13050	<method name="mergeTo">
13051	<desc>
13052	Starts merging the contents of this medium and all intermediate
13053	differencing media in the chain to the given target medium.
13054
13055	The target medium must be either a descendant of this medium or
13056	its ancestor (otherwise this method will immediately return a failure).
13057	It follows that there are two logical directions of the merge operation:
13058	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13059	ancestor (<i>backward merge</i>). Let us consider the following medium
13060	chain:
13061
13062	<pre>Base <- Diff_1 <- Diff_2</pre>
13063
13064	Here, calling this method on the <tt>Base</tt> medium object with
13065	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13066	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13067	merge. Note that in both cases the contents of the resulting medium
13068	will be the same, the only difference is the medium object that takes
13069	the result of the merge operation. In case of the forward merge in the
13070	above example, the result will be written to <tt>Diff_2</tt>; in case of
13071	the backward merge, the result will be written to <tt>Base</tt>. In
13072	other words, the result of the operation is always stored in the target
13073	medium.
13074
13075	Upon successful operation completion, the storage units of all media in
13076	the chain between this (source) medium and the target medium, including
13077	the source medium itself, will be automatically deleted and the
13078	relevant medium objects (including this medium) will become
13079	uninitialized. This means that any attempt to call any of
13080	their methods or attributes will fail with the
13081	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13082	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13083	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13084	Note that <tt>Diff_2</tt> in this case will become a base medium
13085	itself since it will no longer be based on any other medium.
13086
13087	Considering the above, all of the following conditions must be met in
13088	order for the merge operation to succeed:
13089	<ul>
13090	<li>
13091	Neither this (source) medium nor any intermediate
13092	differencing medium in the chain between it and the target
13093	medium is attached to any virtual machine.
13094	</li>
13095	<li>
13096	Neither the source medium nor the target medium is an
13097	<link to="MediumType_Immutable"/> medium.
13098	</li>
13099	<li>
13100	The part of the medium tree from the source medium to the
13101	target medium is a linear chain, i.e. all medium in this
13102	chain have exactly one child which is the next medium in this
13103	chain. The only exception from this rule is the target medium in
13104	the forward merge operation; it is allowed to have any number of
13105	child media because the merge operation will not change its
13106	logical contents (as it is seen by the guest OS or by children).
13107	</li>
13108	<li>
13109	None of the involved media are in
13110	<link to="MediumState_LockedRead"/> or
13111	<link to="MediumState_LockedWrite"/> state.
13112	</li>
13113	</ul>
13114
13115	<note>
13116	This (source) medium and all intermediates will be placed to <link
13117	to="MediumState_Deleting"/> state and the target medium will be
13118	placed to <link to="MediumState_LockedWrite"/> state and for the
13119	duration of this operation.
13120	</note>
13121	</desc>
13122	<param name="target" type="IMedium" dir="in">
13123	<desc>Target medium.</desc>
13124	</param>
13125	<param name="progress" type="IProgress" dir="return">
13126	<desc>Progress object to track the operation completion.</desc>
13127	</param>
13128	</method>
13129
13130	<!-- clone method -->
13131
13132	<method name="cloneTo">
13133	<desc>
13134	Starts creating a clone of this medium in the format and at the
13135	location defined by the @a target argument.
13136
13137	The target medium must be either in <link to="MediumState_NotCreated"/>
13138	state (i.e. must not have an existing storage unit) or in
13139	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13140	big enough to hold the data or else the copy will be partial). Upon
13141	successful completion, the cloned medium will contain exactly the
13142	same sector data as the medium being cloned, except that in the
13143	first case a new UUID for the clone will be randomly generated, and in
13144	the second case the UUID will remain unchanged.
13145
13146	The @a parent argument defines which medium will be the parent
13147	of the clone. Passing a @c null reference indicates that the clone will
13148	be a base image, i.e. completely independent. It is possible to specify
13149	an arbitrary medium for this parameter, including the parent of the
13150	medium which is being cloned. Even cloning to a child of the source
13151	medium is possible. Note that when cloning to an existing image, the
13152	@a parent argument is ignored.
13153
13154	After the returned progress object reports that the operation is
13155	successfully complete, the target medium gets remembered by this
13156	VirtualBox installation and may be attached to virtual machines.
13157
13158	<note>
13159	This medium will be placed to <link to="MediumState_LockedRead"/>
13160	state for the duration of this operation.
13161	</note>
13162	<result name="E_NOTIMPL">
13163	The specified cloning variant is not supported at the moment.
13164	</result>
13165	</desc>
13166	<param name="target" type="IMedium" dir="in">
13167	<desc>Target medium.</desc>
13168	</param>
13169	<param name="variant" type="unsigned long" dir="in">
13170	<desc>Exact image variant which should be created (as a combination of
13171	<link to="MediumVariant" /> flags).</desc>
13172	</param>
13173	<param name="parent" type="IMedium" dir="in">
13174	<desc>Parent of the cloned medium.</desc>
13175	</param>
13176	<param name="progress" type="IProgress" dir="return">
13177	<desc>Progress object to track the operation completion.</desc>
13178	</param>
13179	</method>
13180
13181	<method name="cloneToBase">
13182	<desc>
13183	Starts creating a clone of this medium in the format and at the
13184	location defined by the @a target argument.
13185
13186	The target medium must be either in <link to="MediumState_NotCreated"/>
13187	state (i.e. must not have an existing storage unit) or in
13188	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13189	big enough to hold the data or else the copy will be partial). Upon
13190	successful completion, the cloned medium will contain exactly the
13191	same sector data as the medium being cloned, except that in the
13192	first case a new UUID for the clone will be randomly generated, and in
13193	the second case the UUID will remain unchanged.
13194
13195	The @a parent argument defines which medium will be the parent
13196	of the clone. In this case the clone will be a base image, i.e.
13197	completely independent. It is possible to specify an arbitrary
13198	medium for this parameter, including the parent of the
13199	medium which is being cloned. Even cloning to a child of the source
13200	medium is possible. Note that when cloning to an existing image, the
13201	@a parent argument is ignored.
13202
13203	After the returned progress object reports that the operation is
13204	successfully complete, the target medium gets remembered by this
13205	VirtualBox installation and may be attached to virtual machines.
13206
13207	<note>
13208	This medium will be placed to <link to="MediumState_LockedRead"/>
13209	state for the duration of this operation.
13210	</note>
13211	<result name="E_NOTIMPL">
13212	The specified cloning variant is not supported at the moment.
13213	</result>
13214	</desc>
13215	<param name="target" type="IMedium" dir="in">
13216	<desc>Target medium.</desc>
13217	</param>
13218	<param name="variant" type="unsigned long" dir="in">
13219	<desc>Exact image variant which should be created (as a combination of
13220	<link to="MediumVariant" /> flags).</desc>
13221	</param>
13222	<param name="progress" type="IProgress" dir="return">
13223	<desc>Progress object to track the operation completion.</desc>
13224	</param>
13225	</method>
13226
13227	<!-- other methods -->
13228
13229	<method name="compact">
13230	<desc>
13231	Starts compacting of this medium. This means that the medium is
13232	transformed into a possibly more compact storage representation.
13233	This potentially creates temporary images, which can require a
13234	substantial amount of additional disk space.
13235
13236	This medium will be placed to <link to="MediumState_LockedWrite"/>
13237	state and all its parent media (if any) will be placed to
13238	<link to="MediumState_LockedRead"/> state for the duration of this
13239	operation.
13240
13241	Please note that the results can be either returned straight away,
13242	or later as the result of the background operation via the object
13243	returned via the @a progress parameter.
13244
13245	<result name="VBOX_E_NOT_SUPPORTED">
13246	Medium format does not support compacting (but potentially
13247	needs it).
13248	</result>
13249	</desc>
13250	<param name="progress" type="IProgress" dir="return">
13251	<desc>Progress object to track the operation completion.</desc>
13252	</param>
13253	</method>
13254
13255	<method name="resize">
13256	<desc>
13257	Starts resizing this medium. This means that the nominal size of the
13258	medium is set to the new value. Both increasing and decreasing the
13259	size is possible, and there are no safety checks, since VirtualBox
13260	does not make any assumptions about the medium contents.
13261
13262	Resizing usually needs additional disk space, and possibly also
13263	some temporary disk space. Note that resize does not create a full
13264	temporary copy of the medium, so the additional disk space requirement
13265	is usually much lower than using the clone operation.
13266
13267	This medium will be placed to <link to="MediumState_LockedWrite"/>
13268	state for the duration of this operation.
13269
13270	Please note that the results can be either returned straight away,
13271	or later as the result of the background operation via the object
13272	returned via the @a progress parameter.
13273
13274	<result name="VBOX_E_NOT_SUPPORTED">
13275	Medium format does not support resizing.
13276	</result>
13277	</desc>
13278	<param name="logicalSize" type="long long" dir="in">
13279	<desc>New nominal capacity of the medium in bytes.</desc>
13280	</param>
13281	<param name="progress" type="IProgress" dir="return">
13282	<desc>Progress object to track the operation completion.</desc>
13283	</param>
13284	</method>
13285
13286	<method name="reset">
13287	<desc>
13288	Starts erasing the contents of this differencing medium.
13289
13290	This operation will reset the differencing medium to its initial
13291	state when it does not contain any sector data and any read operation is
13292	redirected to its parent medium. This automatically gets called
13293	during VM power-up for every medium whose <link to="#autoReset" />
13294	attribute is @c true.
13295
13296	The medium will be write-locked for the duration of this operation (see
13297	<link to="#lockWrite" />).
13298
13299	<result name="VBOX_E_NOT_SUPPORTED">
13300	This is not a differencing medium.
13301	</result>
13302	<result name="VBOX_E_INVALID_OBJECT_STATE">
13303	Medium is not in <link to="MediumState_Created"/> or
13304	<link to="MediumState_Inaccessible"/> state.
13305	</result>
13306	</desc>
13307	<param name="progress" type="IProgress" dir="return">
13308	<desc>Progress object to track the operation completion.</desc>
13309	</param>
13310	</method>
13311
13312	</interface>
13313
13314
13315	<!--
13316	// IMediumFormat
13317	/////////////////////////////////////////////////////////////////////////
13318	-->
13319
13320	<enum
13321	name="DataType"
13322	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13323	>
13324	<const name="Int32" value="0"/>
13325	<const name="Int8" value="1"/>
13326	<const name="String" value="2"/>
13327	</enum>
13328
13329	<enum
13330	name="DataFlags"
13331	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13332	>
13333	<const name="None" value="0x00"/>
13334	<const name="Mandatory" value="0x01"/>
13335	<const name="Expert" value="0x02"/>
13336	<const name="Array" value="0x04"/>
13337	<const name="FlagMask" value="0x07"/>
13338	</enum>
13339
13340	<enum
13341	name="MediumFormatCapabilities"
13342	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13343	>
13344	<desc>
13345	Medium format capability flags.
13346	</desc>
13347
13348	<const name="Uuid" value="0x01">
13349	<desc>
13350	Supports UUIDs as expected by VirtualBox code.
13351	</desc>
13352	</const>
13353
13354	<const name="CreateFixed" value="0x02">
13355	<desc>
13356	Supports creating fixed size images, allocating all space instantly.
13357	</desc>
13358	</const>
13359
13360	<const name="CreateDynamic" value="0x04">
13361	<desc>
13362	Supports creating dynamically growing images, allocating space on
13363	demand.
13364	</desc>
13365	</const>
13366
13367	<const name="CreateSplit2G" value="0x08">
13368	<desc>
13369	Supports creating images split in chunks of a bit less than 2 GBytes.
13370	</desc>
13371	</const>
13372
13373	<const name="Differencing" value="0x10">
13374	<desc>
13375	Supports being used as a format for differencing media (see <link
13376	to="IMedium::createDiffStorage"/>).
13377	</desc>
13378	</const>
13379
13380	<const name="Asynchronous" value="0x20">
13381	<desc>
13382	Supports asynchronous I/O operations for at least some configurations.
13383	</desc>
13384	</const>
13385
13386	<const name="File" value="0x40">
13387	<desc>
13388	The format backend operates on files (the <link to="IMedium::location"/>
13389	attribute of the medium specifies a file used to store medium
13390	data; for a list of supported file extensions see
13391	<link to="IMediumFormat::describeFileExtensions"/>).
13392	</desc>
13393	</const>
13394
13395	<const name="Properties" value="0x80">
13396	<desc>
13397	The format backend uses the property interface to configure the storage
13398	location and properties (the <link to="IMediumFormat::describeProperties"/>
13399	method is used to get access to properties supported by the given medium format).
13400	</desc>
13401	</const>
13402
13403	<const name="TcpNetworking" value="0x100">
13404	<desc>
13405	The format backend uses the TCP networking interface for network access.
13406	</desc>
13407	</const>
13408
13409	<const name="VFS" value="0x200">
13410	<desc>
13411	The format backend supports virtual filesystem functionality.
13412	</desc>
13413	</const>
13414
13415	<const name="CapabilityMask" value="0x3FF"/>
13416	</enum>
13417
13418	<interface
13419	name="IMediumFormat" extends="$unknown"
13420	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13421	wsmap="managed"
13422	>
13423	<desc>
13424	The IMediumFormat interface represents a medium format.
13425
13426	Each medium format has an associated backend which is used to handle
13427	media stored in this format. This interface provides information
13428	about the properties of the associated backend.
13429
13430	Each medium format is identified by a string represented by the
13431	<link to="#id"/> attribute. This string is used in calls like
13432	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13433	format.
13434
13435	The list of all supported medium formats can be obtained using
13436	<link to="ISystemProperties::mediumFormats"/>.
13437
13438	<see><link to="IMedium"/></see>
13439	</desc>
13440
13441	<attribute name="id" type="wstring" readonly="yes">
13442	<desc>
13443	Identifier of this format.
13444
13445	The format identifier is a non-@c null non-empty ASCII string. Note that
13446	this string is case-insensitive. This means that, for example, all of
13447	the following strings:
13448	<pre>
13449	"VDI"
13450	"vdi"
13451	"VdI"</pre>
13452	refer to the same medium format.
13453
13454	This string is used in methods of other interfaces where it is necessary
13455	to specify a medium format, such as
13456	<link to="IVirtualBox::createHardDisk"/>.
13457	</desc>
13458	</attribute>
13459
13460	<attribute name="name" type="wstring" readonly="yes">
13461	<desc>
13462	Human readable description of this format.
13463
13464	Mainly for use in file open dialogs.
13465	</desc>
13466	</attribute>
13467
13468	<attribute name="capabilities" type="unsigned long" readonly="yes">
13469	<desc>
13470	Capabilities of the format as a set of bit flags.
13471
13472	For the meaning of individual capability flags see
13473	<link to="MediumFormatCapabilities"/>.
13474	</desc>
13475	</attribute>
13476
13477	<method name="describeFileExtensions">
13478	<desc>
13479	Returns two arrays describing the supported file extensions.
13480
13481	The first array contains the supported extensions and the seconds one
13482	the type each extension supports. Both have the same size.
13483
13484	Note that some backends do not work on files, so this array may be
13485	empty.
13486
13487	<see><link to="IMediumFormat::capabilities"/></see>
13488	</desc>
13489	<param name="extensions" type="wstring" safearray="yes" dir="out">
13490	<desc>The array of supported extensions.</desc>
13491	</param>
13492	<param name="type" type="DeviceType" safearray="yes" dir="out">
13493	<desc>The array which indicates the device type for every given extension.</desc>
13494	</param>
13495	</method>
13496
13497	<method name="describeProperties" const="yes">
13498	<desc>
13499	Returns several arrays describing the properties supported by this
13500	format.
13501
13502	An element with the given index in each array describes one
13503	property. Thus, the number of elements in each returned array is the
13504	same and corresponds to the number of supported properties.
13505
13506	The returned arrays are filled in only if the
13507	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13508	All arguments must be non-@c null.
13509
13510	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13511	</desc>
13512
13513	<param name="names" type="wstring" safearray="yes" dir="out">
13514	<desc>Array of property names.</desc>
13515	</param>
13516	<param name="description" type="wstring" safearray="yes" dir="out">
13517	<desc>Array of property descriptions.</desc>
13518	</param>
13519	<param name="types" type="DataType" safearray="yes" dir="out">
13520	<desc>Array of property types.</desc>
13521	</param>
13522	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13523	<desc>Array of property flags.</desc>
13524	</param>
13525	<param name="defaults" type="wstring" safearray="yes" dir="out">
13526	<desc>Array of default property values.</desc>
13527	</param>
13528	</method>
13529
13530	</interface>
13531
13532
13533	<!--
13534	// IKeyboard
13535	/////////////////////////////////////////////////////////////////////////
13536	-->
13537
13538	<interface
13539	name="IKeyboard" extends="$unknown"
13540	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13541	wsmap="managed"
13542	>
13543	<desc>
13544	The IKeyboard interface represents the virtual machine's keyboard. Used
13545	in <link to="IConsole::keyboard"/>.
13546
13547	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13548	to the virtual machine.
13549
13550	</desc>
13551	<method name="putScancode">
13552	<desc>Sends a scancode to the keyboard.
13553
13554	<result name="VBOX_E_IPRT_ERROR">
13555	Could not send scan code to virtual keyboard.
13556	</result>
13557
13558	</desc>
13559	<param name="scancode" type="long" dir="in"/>
13560	</method>
13561
13562	<method name="putScancodes">
13563	<desc>Sends an array of scancodes to the keyboard.
13564
13565	<result name="VBOX_E_IPRT_ERROR">
13566	Could not send all scan codes to virtual keyboard.
13567	</result>
13568
13569	</desc>
13570	<param name="scancodes" type="long" dir="in" safearray="yes"/>
13571	<param name="codesStored" type="unsigned long" dir="return"/>
13572	</method>
13573
13574	<method name="putCAD">
13575	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
13576	function is nothing special, it is just a convenience function
13577	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
13578
13579	<result name="VBOX_E_IPRT_ERROR">
13580	Could not send all scan codes to virtual keyboard.
13581	</result>
13582
13583	</desc>
13584	</method>
13585
13586	<attribute name="eventSource" type="IEventSource" readonly="yes">
13587	<desc>
13588	Event source for keyboard events.
13589	</desc>
13590	</attribute>
13591
13592	</interface>
13593
13594
13595	<!--
13596	// IMouse
13597	/////////////////////////////////////////////////////////////////////////
13598	-->
13599
13600	<enum
13601	name="MouseButtonState"
13602	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
13603	>
13604	<desc>
13605	Mouse button state.
13606	</desc>
13607
13608	<const name="LeftButton" value="0x01"/>
13609	<const name="RightButton" value="0x02"/>
13610	<const name="MiddleButton" value="0x04"/>
13611	<const name="WheelUp" value="0x08"/>
13612	<const name="WheelDown" value="0x10"/>
13613	<const name="XButton1" value="0x20"/>
13614	<const name="XButton2" value="0x40"/>
13615	<const name="MouseStateMask" value="0x7F"/>
13616	</enum>
13617
13618	<interface
13619	name="IMouse" extends="$unknown"
13620	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
13621	wsmap="managed"
13622	>
13623	<desc>
13624	The IMouse interface represents the virtual machine's mouse. Used in
13625	<link to="IConsole::mouse"/>.
13626
13627	Through this interface, the virtual machine's virtual mouse can be
13628	controlled.
13629	</desc>
13630
13631	<attribute name="absoluteSupported" type="boolean" readonly="yes">
13632	<desc>
13633	Whether the guest OS supports absolute mouse pointer positioning
13634	or not.
13635	<note>
13636	You can use the <link to="IMouseCapabilityChangedEvent"/>
13637	event to be instantly informed about changes of this attribute
13638	during virtual machine execution.
13639	</note>
13640	<see><link to="#putMouseEventAbsolute"/></see>
13641	</desc>
13642	</attribute>
13643
13644	<attribute name="relativeSupported" type="boolean" readonly="yes">
13645	<desc>
13646	Whether the guest OS supports relative mouse pointer positioning
13647	or not.
13648	<note>
13649	You can use the <link to="IMouseCapabilityChangedEvent"/>
13650	event to be instantly informed about changes of this attribute
13651	during virtual machine execution.
13652	</note>
13653	<see><link to="#putMouseEvent"/></see>
13654	</desc>
13655	</attribute>
13656
13657	<attribute name="needsHostCursor" type="boolean" readonly="yes">
13658	<desc>
13659	Whether the guest OS can currently switch to drawing it's own mouse
13660	cursor on demand.
13661	<note>
13662	You can use the <link to="IMouseCapabilityChangedEvent"/>
13663	event to be instantly informed about changes of this attribute
13664	during virtual machine execution.
13665	</note>
13666	<see><link to="#putMouseEvent"/></see>
13667	</desc>
13668	</attribute>
13669
13670	<method name="putMouseEvent">
13671	<desc>
13672	Initiates a mouse event using relative pointer movements
13673	along x and y axis.
13674
13675	<result name="E_ACCESSDENIED">
13676	Console not powered up.
13677	</result>
13678	<result name="VBOX_E_IPRT_ERROR">
13679	Could not send mouse event to virtual mouse.
13680	</result>
13681
13682	</desc>
13683
13684	<param name="dx" type="long" dir="in">
13685	<desc>
13686	Amount of pixels the mouse should move to the right.
13687	Negative values move the mouse to the left.
13688	</desc>
13689	</param>
13690	<param name="dy" type="long" dir="in">
13691	<desc>
13692	Amount of pixels the mouse should move downwards.
13693	Negative values move the mouse upwards.
13694	</desc>
13695	</param>
13696	<param name="dz" type="long" dir="in">
13697	<desc>
13698	Amount of mouse wheel moves.
13699	Positive values describe clockwise wheel rotations,
13700	negative values describe counterclockwise rotations.
13701	</desc>
13702	</param>
13703	<param name="dw" type="long" dir="in">
13704	<desc>
13705	Amount of horizontal mouse wheel moves.
13706	Positive values describe a movement to the left,
13707	negative values describe a movement to the right.
13708	</desc>
13709	</param>
13710	<param name="buttonState" type="long" dir="in">
13711	<desc>
13712	The current state of mouse buttons. Every bit represents
13713	a mouse button as follows:
13714	<table>
13715	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13716	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13717	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13718	</table>
13719	A value of <tt>1</tt> means the corresponding button is pressed.
13720	otherwise it is released.
13721	</desc>
13722	</param>
13723	</method>
13724
13725	<method name="putMouseEventAbsolute">
13726	<desc>
13727	Positions the mouse pointer using absolute x and y coordinates.
13728	These coordinates are expressed in pixels and
13729	start from <tt>[1,1]</tt> which corresponds to the top left
13730	corner of the virtual display.
13731
13732	<result name="E_ACCESSDENIED">
13733	Console not powered up.
13734	</result>
13735	<result name="VBOX_E_IPRT_ERROR">
13736	Could not send mouse event to virtual mouse.
13737	</result>
13738
13739	<note>
13740	This method will have effect only if absolute mouse
13741	positioning is supported by the guest OS.
13742	</note>
13743
13744	<see><link to="#absoluteSupported"/></see>
13745	</desc>
13746
13747	<param name="x" type="long" dir="in">
13748	<desc>
13749	X coordinate of the pointer in pixels, starting from @c 1.
13750	</desc>
13751	</param>
13752	<param name="y" type="long" dir="in">
13753	<desc>
13754	Y coordinate of the pointer in pixels, starting from @c 1.
13755	</desc>
13756	</param>
13757	<param name="dz" type="long" dir="in">
13758	<desc>
13759	Amount of mouse wheel moves.
13760	Positive values describe clockwise wheel rotations,
13761	negative values describe counterclockwise rotations.
13762	</desc>
13763	</param>
13764	<param name="dw" type="long" dir="in">
13765	<desc>
13766	Amount of horizontal mouse wheel moves.
13767	Positive values describe a movement to the left,
13768	negative values describe a movement to the right.
13769	</desc>
13770	</param>
13771	<param name="buttonState" type="long" dir="in">
13772	<desc>
13773	The current state of mouse buttons. Every bit represents
13774	a mouse button as follows:
13775	<table>
13776	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13777	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13778	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13779	</table>
13780	A value of @c 1 means the corresponding button is pressed.
13781	otherwise it is released.
13782	</desc>
13783	</param>
13784	</method>
13785
13786	<attribute name="eventSource" type="IEventSource" readonly="yes">
13787	<desc>
13788	Event source for mouse events.
13789	</desc>
13790	</attribute>
13791
13792	</interface>
13793
13794	<!--
13795	// IDisplay
13796	/////////////////////////////////////////////////////////////////////////
13797	-->
13798
13799	<enum
13800	name="FramebufferPixelFormat"
13801	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
13802	>
13803	<desc>
13804	Format of the video memory buffer. Constants represented by this enum can
13805	be used to test for particular values of <link
13806	to="IFramebuffer::pixelFormat"/>. See also <link
13807	to="IFramebuffer::requestResize"/>.
13808
13809	See also www.fourcc.org for more information about FOURCC pixel formats.
13810	</desc>
13811
13812	<const name="Opaque" value="0">
13813	<desc>
13814	Unknown buffer format (the user may not assume any particular format of
13815	the buffer).
13816	</desc>
13817	</const>
13818	<const name="FOURCC_RGB" value="0x32424752">
13819	<desc>
13820	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
13821	bit layout).
13822	</desc>
13823	</const>
13824	</enum>
13825
13826	<interface
13827	name="IFramebuffer" extends="$unknown"
13828	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
13829	wsmap="suppress"
13830	>
13831	<attribute name="address" type="octet" mod="ptr" readonly="yes">
13832	<desc>Address of the start byte of the frame buffer.</desc>
13833	</attribute>
13834
13835	<attribute name="width" type="unsigned long" readonly="yes">
13836	<desc>Frame buffer width, in pixels.</desc>
13837	</attribute>
13838
13839	<attribute name="height" type="unsigned long" readonly="yes">
13840	<desc>Frame buffer height, in pixels.</desc>
13841	</attribute>
13842
13843	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
13844	<desc>
13845	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
13846	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
13847	are: 8, 15, 16, 24 and 32.
13848	</desc>
13849	</attribute>
13850
13851	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
13852	<desc>
13853	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
13854	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
13855	size of the scan line must be aligned to 32 bits.
13856	</desc>
13857	</attribute>
13858
13859	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
13860	<desc>
13861	Frame buffer pixel format. It's either one of the values defined by <link
13862	to="FramebufferPixelFormat"/> or a raw FOURCC code.
13863	<note>
13864	This attribute must never return <link
13865	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
13866	<link to="#address"/> points to must be always known.
13867	</note>
13868	</desc>
13869	</attribute>
13870
13871	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
13872	<desc>
13873	Defines whether this frame buffer uses the virtual video card's memory
13874	buffer (guest VRAM) directly or not. See <link
13875	to="IFramebuffer::requestResize"/> for more information.
13876	</desc>
13877	</attribute>
13878
13879	<attribute name="heightReduction" type="unsigned long" readonly="yes">
13880	<desc>
13881	Hint from the frame buffer about how much of the standard
13882	screen height it wants to use for itself. This information is
13883	exposed to the guest through the VESA BIOS and VMMDev interface
13884	so that it can use it for determining its video mode table. It
13885	is not guaranteed that the guest respects the value.
13886	</desc>
13887	</attribute>
13888
13889	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
13890	<desc>
13891	An alpha-blended overlay which is superposed over the frame buffer.
13892	The initial purpose is to allow the display of icons providing
13893	information about the VM state, including disk activity, in front
13894	ends which do not have other means of doing that. The overlay is
13895	designed to controlled exclusively by IDisplay. It has no locking
13896	of its own, and any changes made to it are not guaranteed to be
13897	visible until the affected portion of IFramebuffer is updated. The
13898	overlay can be created lazily the first time it is requested. This
13899	attribute can also return @c null to signal that the overlay is not
13900	implemented.
13901	</desc>
13902	</attribute>
13903
13904	<attribute name="winId" type="long long" readonly="yes">
13905	<desc>
13906	Platform-dependent identifier of the window where context of this
13907	frame buffer is drawn, or zero if there's no such window.
13908	</desc>
13909	</attribute>
13910
13911	<method name="lock">
13912	<desc>
13913	Locks the frame buffer.
13914	Gets called by the IDisplay object where this frame buffer is
13915	bound to.
13916	</desc>
13917	</method>
13918
13919	<method name="unlock">
13920	<desc>
13921	Unlocks the frame buffer.
13922	Gets called by the IDisplay object where this frame buffer is
13923	bound to.
13924	</desc>
13925	</method>
13926
13927	<method name="notifyUpdate">
13928	<desc>
13929	Informs about an update.
13930	Gets called by the display object where this buffer is
13931	registered.
13932	</desc>
13933	<param name="x" type="unsigned long" dir="in"/>
13934	<param name="y" type="unsigned long" dir="in"/>
13935	<param name="width" type="unsigned long" dir="in"/>
13936	<param name="height" type="unsigned long" dir="in"/>
13937	</method>
13938
13939	<method name="requestResize">
13940	<desc>
13941	Requests a size and pixel format change.
13942
13943	There are two modes of working with the video buffer of the virtual
13944	machine. The <i>indirect</i> mode implies that the IFramebuffer
13945	implementation allocates a memory buffer for the requested display mode
13946	and provides it to the virtual machine. In <i>direct</i> mode, the
13947	IFramebuffer implementation uses the memory buffer allocated and owned
13948	by the virtual machine. This buffer represents the video memory of the
13949	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
13950	usually faster because the implementation gets a raw pointer to the
13951	guest VRAM buffer which it can directly use for visualizing the contents
13952	of the virtual display, as opposed to the indirect mode where the
13953	contents of guest VRAM are copied to the memory buffer provided by
13954	the implementation every time a display update occurs.
13955
13956	It is important to note that the direct mode is really fast only when
13957	the implementation uses the given guest VRAM buffer directly, for
13958	example, by blitting it to the window representing the virtual machine's
13959	display, which saves at least one copy operation comparing to the
13960	indirect mode. However, using the guest VRAM buffer directly is not
13961	always possible: the format and the color depth of this buffer may be
13962	not supported by the target window, or it may be unknown (opaque) as in
13963	case of text or non-linear multi-plane VGA video modes. In this case,
13964	the indirect mode (that is always available) should be used as a
13965	fallback: when the guest VRAM contents are copied to the
13966	implementation-provided memory buffer, color and format conversion is
13967	done automatically by the underlying code.
13968
13969	The @a pixelFormat parameter defines whether the direct mode is
13970	available or not. If @a pixelFormat is <link
13971	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
13972	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
13973	@a bytesPerLine parameters must be ignored and the implementation must use
13974	the indirect mode (where it provides its own buffer in one of the
13975	supported formats). In all other cases, @a pixelFormat together with
13976	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
13977	buffer pointed to by the @a VRAM parameter and the implementation is
13978	free to choose which mode to use. To indicate that this frame buffer uses
13979	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
13980	attribute must return @c true and <link to="#address"/> must
13981	return exactly the same address that is passed in the @a VRAM parameter
13982	of this method; otherwise it is assumed that the indirect strategy is
13983	chosen.
13984
13985	The @a width and @a height parameters represent the size of the
13986	requested display mode in both modes. In case of indirect mode, the
13987	provided memory buffer should be big enough to store data of the given
13988	display mode. In case of direct mode, it is guaranteed that the given
13989	@a VRAM buffer contains enough space to represent the display mode of the
13990	given size. Note that this frame buffer's <link to="#width"/> and <link
13991	to="#height"/> attributes must return exactly the same values as
13992	passed to this method after the resize is completed (see below).
13993
13994	The @a finished output parameter determines if the implementation has
13995	finished resizing the frame buffer or not. If, for some reason, the
13996	resize cannot be finished immediately during this call, @a finished
13997	must be set to @c false, and the implementation must call
13998	<link to="IDisplay::resizeCompleted"/> after it has returned from
13999	this method as soon as possible. If @a finished is @c false, the
14000	machine will not call any frame buffer methods until
14001	<link to="IDisplay::resizeCompleted"/> is called.
14002
14003	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14004	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14005	this frame buffer must return exactly the same values as specified in the
14006	parameters of this method, after the resize is completed. If the
14007	indirect mode is chosen, these attributes must return values describing
14008	the format of the implementation's own memory buffer <link
14009	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14010	value must always correlate with <link to="#pixelFormat"/>. Note that
14011	the <link to="#pixelFormat"/> attribute must never return <link
14012	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14013
14014	<note>
14015	This method is called by the IDisplay object under the
14016	<link to="#lock"/> provided by this IFramebuffer
14017	implementation. If this method returns @c false in @a finished, then
14018	this lock is not released until
14019	<link to="IDisplay::resizeCompleted"/> is called.
14020	</note>
14021	</desc>
14022	<param name="screenId" type="unsigned long" dir="in">
14023	<desc>
14024	Logical screen number. Must be used in the corresponding call to
14025	<link to="IDisplay::resizeCompleted"/> if this call is made.
14026	</desc>
14027	</param>
14028	<param name="pixelFormat" type="unsigned long" dir="in">
14029	<desc>
14030	Pixel format of the memory buffer pointed to by @a VRAM.
14031	See also <link to="FramebufferPixelFormat"/>.
14032	</desc>
14033	</param>
14034	<param name="VRAM" type="octet" mod="ptr" dir="in">
14035	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14036	</param>
14037	<param name="bitsPerPixel" type="unsigned long" dir="in">
14038	<desc>Color depth, bits per pixel.</desc>
14039	</param>
14040	<param name="bytesPerLine" type="unsigned long" dir="in">
14041	<desc>Size of one scan line, in bytes.</desc>
14042	</param>
14043	<param name="width" type="unsigned long" dir="in">
14044	<desc>Width of the guest display, in pixels.</desc>
14045	</param>
14046	<param name="height" type="unsigned long" dir="in">
14047	<desc>Height of the guest display, in pixels.</desc>
14048	</param>
14049	<param name="finished" type="boolean" dir="return">
14050	<desc>
14051	Can the VM start using the new frame buffer immediately
14052	after this method returns or it should wait for
14053	<link to="IDisplay::resizeCompleted"/>.
14054	</desc>
14055	</param>
14056	</method>
14057
14058	<method name="videoModeSupported">
14059	<desc>
14060	Returns whether the frame buffer implementation is willing to
14061	support a given video mode. In case it is not able to render
14062	the video mode (or for some reason not willing), it should
14063	return @c false. Usually this method is called when the guest
14064	asks the VMM device whether a given video mode is supported
14065	so the information returned is directly exposed to the guest.
14066	It is important that this method returns very quickly.
14067	</desc>
14068	<param name="width" type="unsigned long" dir="in"/>
14069	<param name="height" type="unsigned long" dir="in"/>
14070	<param name="bpp" type="unsigned long" dir="in"/>
14071	<param name="supported" type="boolean" dir="return"/>
14072	</method>
14073
14074	<method name="getVisibleRegion">
14075	<desc>
14076	Returns the visible region of this frame buffer.
14077
14078	If the @a rectangles parameter is @c null then the value of the
14079	@a count parameter is ignored and the number of elements necessary to
14080	describe the current visible region is returned in @a countCopied.
14081
14082	If @a rectangles is not @c null but @a count is less
14083	than the required number of elements to store region data, the method
14084	will report a failure. If @a count is equal or greater than the
14085	required number of elements, then the actual number of elements copied
14086	to the provided array will be returned in @a countCopied.
14087
14088	<note>
14089	The address of the provided array must be in the process space of
14090	this IFramebuffer object.
14091	</note>
14092	<note>
14093	Method not yet implemented.
14094	</note>
14095	</desc>
14096	<param name="rectangles" type="octet" mod="ptr" dir="in">
14097	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14098	</param>
14099	<param name="count" type="unsigned long" dir="in">
14100	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14101	</param>
14102	<param name="countCopied" type="unsigned long" dir="return">
14103	<desc>Number of elements copied to the @a rectangles array.</desc>
14104	</param>
14105	</method>
14106
14107	<method name="setVisibleRegion">
14108	<desc>
14109	Suggests a new visible region to this frame buffer. This region
14110	represents the area of the VM display which is a union of regions of
14111	all top-level windows of the guest operating system running inside the
14112	VM (if the Guest Additions for this system support this
14113	functionality). This information may be used by the frontends to
14114	implement the seamless desktop integration feature.
14115
14116	<note>
14117	The address of the provided array must be in the process space of
14118	this IFramebuffer object.
14119	</note>
14120	<note>
14121	The IFramebuffer implementation must make a copy of the provided
14122	array of rectangles.
14123	</note>
14124	<note>
14125	Method not yet implemented.
14126	</note>
14127	</desc>
14128	<param name="rectangles" type="octet" mod="ptr" dir="in">
14129	<desc>Pointer to the @c RTRECT array.</desc>
14130	</param>
14131	<param name="count" type="unsigned long" dir="in">
14132	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14133	</param>
14134	</method>
14135
14136	<method name="processVHWACommand">
14137	<desc>
14138	Posts a Video HW Acceleration Command to the frame buffer for processing.
14139	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14140	are posted from quest to the host to be processed by the host hardware.
14141
14142	<note>
14143	The address of the provided command must be in the process space of
14144	this IFramebuffer object.
14145	</note>
14146	</desc>
14147
14148	<param name="command" type="octet" mod="ptr" dir="in">
14149	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14150	</param>
14151	</method>
14152
14153	</interface>
14154
14155	<interface
14156	name="IFramebufferOverlay" extends="IFramebuffer"
14157	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14158	wsmap="suppress"
14159	>
14160	<desc>
14161	The IFramebufferOverlay interface represents an alpha blended overlay
14162	for displaying status icons above an IFramebuffer. It is always created
14163	not visible, so that it must be explicitly shown. It only covers a
14164	portion of the IFramebuffer, determined by its width, height and
14165	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14166	that order) format, and may be written to directly. Do re-read the
14167	width though, after setting it, as it may be adjusted (increased) to
14168	make it more suitable for the front end.
14169	</desc>
14170	<attribute name="x" type="unsigned long" readonly="yes">
14171	<desc>X position of the overlay, relative to the frame buffer.</desc>
14172	</attribute>
14173
14174	<attribute name="y" type="unsigned long" readonly="yes">
14175	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14176	</attribute>
14177
14178	<attribute name="visible" type="boolean" readonly="no">
14179	<desc>
14180	Whether the overlay is currently visible.
14181	</desc>
14182	</attribute>
14183
14184	<attribute name="alpha" type="unsigned long" readonly="no">
14185	<desc>
14186	The global alpha value for the overlay. This may or may not be
14187	supported by a given front end.
14188	</desc>
14189	</attribute>
14190
14191	<method name="move">
14192	<desc>
14193	Changes the overlay's position relative to the IFramebuffer.
14194	</desc>
14195	<param name="x" type="unsigned long" dir="in"/>
14196	<param name="y" type="unsigned long" dir="in"/>
14197	</method>
14198
14199	</interface>
14200
14201	<interface
14202	name="IDisplay" extends="$unknown"
14203	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14204	wsmap="managed"
14205	>
14206	<desc>
14207	The IDisplay interface represents the virtual machine's display.
14208
14209	The object implementing this interface is contained in each
14210	<link to="IConsole::display"/> attribute and represents the visual
14211	output of the virtual machine.
14212
14213	The virtual display supports pluggable output targets represented by the
14214	IFramebuffer interface. Examples of the output target are a window on
14215	the host computer or an RDP session's display on a remote computer.
14216	</desc>
14217	<method name="getScreenResolution">
14218	<desc>Queries display width, height and color depth for given screen.</desc>
14219	<param name="screenId" type="unsigned long" dir="in"/>
14220	<param name="width" type="unsigned long" dir="out"/>
14221	<param name="height" type="unsigned long" dir="out"/>
14222	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14223	</method>
14224
14225	<method name="setFramebuffer">
14226	<desc>
14227	Sets the framebuffer for given screen.
14228	</desc>
14229	<param name="screenId" type="unsigned long" dir="in"/>
14230	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14231	</method>
14232
14233	<method name="getFramebuffer">
14234	<desc>
14235	Queries the framebuffer for given screen.
14236	</desc>
14237	<param name="screenId" type="unsigned long" dir="in"/>
14238	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14239	<param name="xOrigin" type="long" dir="out"/>
14240	<param name="yOrigin" type="long" dir="out"/>
14241	</method>
14242
14243	<method name="setVideoModeHint">
14244	<desc>
14245	Asks VirtualBox to request the given video mode from
14246	the guest. This is just a hint and it cannot be guaranteed
14247	that the requested resolution will be used. Guest Additions
14248	are required for the request to be seen by guests. The caller
14249	should issue the request and wait for a resolution change and
14250	after a timeout retry.
14251
14252	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14253	parameters means that the corresponding values should be taken from the
14254	current video mode (i.e. left unchanged).
14255
14256	If the guest OS supports multi-monitor configuration then the @a display
14257	parameter specifies the number of the guest display to send the hint to:
14258	@c 0 is the primary display, @c 1 is the first secondary and
14259	so on. If the multi-monitor configuration is not supported, @a display
14260	must be @c 0.
14261
14262	<result name="E_INVALIDARG">
14263	The @a display is not associated with any monitor.
14264	</result>
14265
14266	</desc>
14267	<param name="display" type="unsigned long" dir="in">
14268	<desc>
14269	The number of the guest display to send the hint to.
14270	</desc>
14271	</param>
14272	<param name="enabled" type="boolean" dir="in">
14273	<desc>
14274	@c True, if this guest screen is enabled,
14275	@c False otherwise.
14276	</desc>
14277	</param>
14278	<param name="changeOrigin" type="boolean" dir="in">
14279	<desc>
14280	@c True, if the origin of the guest screen should be changed,
14281	@c False otherwise.
14282	</desc>
14283	</param>
14284	<param name="originX" type="long" dir="in">
14285	<desc>
14286	The X origin of the guest screen.
14287	</desc>
14288	</param>
14289	<param name="originY" type="long" dir="in">
14290	<desc>
14291	The Y origin of the guest screen.
14292	</desc>
14293	</param>
14294	<param name="width" type="unsigned long" dir="in"/>
14295	<param name="height" type="unsigned long" dir="in"/>
14296	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14297	</method>
14298
14299	<method name="setSeamlessMode">
14300	<desc>
14301	Enables or disables seamless guest display rendering (seamless desktop
14302	integration) mode.
14303	<note>
14304	Calling this method has no effect if <link
14305	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14306	does not return @c Active.
14307	</note>
14308	</desc>
14309	<param name="enabled" type="boolean" dir="in"/>
14310	</method>
14311
14312	<method name="takeScreenShot">
14313	<desc>
14314	Takes a screen shot of the requested size and copies it to the
14315	32-bpp buffer allocated by the caller and pointed to by @a address.
14316	A pixel consists of 4 bytes in order: B, G, R, 0.
14317
14318	<note>This API can be used only locally by a VM process through the
14319	COM/XPCOM C++ API as it requires pointer support. It is not
14320	available for scripting langages, Java or any webservice clients.
14321	Unless you are writing a new VM frontend use
14322	<link to="#takeScreenShotToArray" />.
14323	</note>
14324
14325	<result name="E_NOTIMPL">
14326	Feature not implemented.
14327	</result>
14328	<result name="VBOX_E_IPRT_ERROR">
14329	Could not take a screenshot.
14330	</result>
14331
14332	</desc>
14333	<param name="screenId" type="unsigned long" dir="in"/>
14334	<param name="address" type="octet" mod="ptr" dir="in"/>
14335	<param name="width" type="unsigned long" dir="in"/>
14336	<param name="height" type="unsigned long" dir="in"/>
14337	</method>
14338
14339	<method name="takeScreenShotToArray">
14340	<desc>
14341	Takes a guest screen shot of the requested size and returns it as
14342	an array of bytes in uncompressed 32-bit RGBA format.
14343	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14344
14345	This API is slow, but could be the only option to get guest screenshot
14346	for scriptable languages not allowed to manipulate with addresses
14347	directly.
14348
14349	<result name="E_NOTIMPL">
14350	Feature not implemented.
14351	</result>
14352	<result name="VBOX_E_IPRT_ERROR">
14353	Could not take a screenshot.
14354	</result>
14355	</desc>
14356	<param name="screenId" type="unsigned long" dir="in">
14357	<desc>
14358	Monitor to take screenshot from.
14359	</desc>
14360	</param>
14361	<param name="width" type="unsigned long" dir="in">
14362	<desc>
14363	Desired image width.
14364	</desc>
14365	</param>
14366	<param name="height" type="unsigned long" dir="in">
14367	<desc>
14368	Desired image height.
14369	</desc>
14370	</param>
14371	<param name="screenData" type="octet" dir="return" safearray="yes">
14372	<desc>
14373	Array with resulting screen data.
14374	</desc>
14375	</param>
14376	</method>
14377
14378	<method name="takeScreenShotPNGToArray">
14379	<desc>
14380	Takes a guest screen shot of the requested size and returns it as
14381	PNG image in array.
14382
14383	<result name="E_NOTIMPL">
14384	Feature not implemented.
14385	</result>
14386	<result name="VBOX_E_IPRT_ERROR">
14387	Could not take a screenshot.
14388	</result>
14389	</desc>
14390	<param name="screenId" type="unsigned long" dir="in">
14391	<desc>
14392	Monitor to take the screenshot from.
14393	</desc>
14394	</param>
14395	<param name="width" type="unsigned long" dir="in">
14396	<desc>
14397	Desired image width.
14398	</desc>
14399	</param>
14400	<param name="height" type="unsigned long" dir="in">
14401	<desc>
14402	Desired image height.
14403	</desc>
14404	</param>
14405	<param name="screenData" type="octet" dir="return" safearray="yes">
14406	<desc>
14407	Array with resulting screen data.
14408	</desc>
14409	</param>
14410	</method>
14411
14412	<method name="drawToScreen">
14413	<desc>
14414	Draws a 32-bpp image of the specified size from the given buffer
14415	to the given point on the VM display.
14416
14417	<result name="E_NOTIMPL">
14418	Feature not implemented.
14419	</result>
14420	<result name="VBOX_E_IPRT_ERROR">
14421	Could not draw to screen.
14422	</result>
14423
14424	</desc>
14425	<param name="screenId" type="unsigned long" dir="in">
14426	<desc>
14427	Monitor to take the screenshot from.
14428	</desc>
14429	</param>
14430	<param name="address" type="octet" mod="ptr" dir="in">
14431	<desc>
14432	Address to store the screenshot to
14433	</desc>
14434	</param>
14435	<param name="x" type="unsigned long" dir="in">
14436	<desc>
14437	Relative to the screen top left corner.
14438	</desc>
14439	</param>
14440	<param name="y" type="unsigned long" dir="in">
14441	<desc>
14442	Relative to the screen top left corner.
14443	</desc>
14444	</param>
14445	<param name="width" type="unsigned long" dir="in">
14446	<desc>
14447	Desired image width.
14448	</desc>
14449	</param>
14450	<param name="height" type="unsigned long" dir="in">
14451	<desc>
14452	Desired image height.
14453	</desc>
14454	</param>
14455	</method>
14456
14457	<method name="invalidateAndUpdate">
14458	<desc>
14459	Does a full invalidation of the VM display and instructs the VM
14460	to update it.
14461
14462	<result name="VBOX_E_IPRT_ERROR">
14463	Could not invalidate and update screen.
14464	</result>
14465
14466	</desc>
14467	</method>
14468
14469	<method name="resizeCompleted">
14470	<desc>
14471	Signals that a framebuffer has completed the resize operation.
14472
14473	<result name="VBOX_E_NOT_SUPPORTED">
14474	Operation only valid for external frame buffers.
14475	</result>
14476
14477	</desc>
14478	<param name="screenId" type="unsigned long" dir="in"/>
14479	</method>
14480
14481	<method name="completeVHWACommand">
14482	<desc>
14483	Signals that the Video HW Acceleration command has completed.
14484	</desc>
14485
14486	<param name="command" type="octet" mod="ptr" dir="in">
14487	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14488	</param>
14489	</method>
14490
14491	<method name="viewportChanged">
14492	<desc>
14493	Signals that framebuffer window viewport has changed.
14494
14495	<result name="E_INVALIDARG">
14496	The specified viewport data is invalid.
14497	</result>
14498
14499	</desc>
14500
14501	<param name="screenId" type="unsigned long" dir="in">
14502	<desc>
14503	Monitor to take the screenshot from.
14504	</desc>
14505	</param>
14506	<param name="x" type="unsigned long" dir="in">
14507	<desc>
14508	Framebuffer x offset.
14509	</desc>
14510	</param>
14511	<param name="y" type="unsigned long" dir="in">
14512	<desc>
14513	Framebuffer y offset.
14514	</desc>
14515	</param>
14516	<param name="width" type="unsigned long" dir="in">
14517	<desc>
14518	Viewport width.
14519	</desc>
14520	</param>
14521	<param name="height" type="unsigned long" dir="in">
14522	<desc>
14523	Viewport height.
14524	</desc>
14525	</param>
14526	</method>
14527	</interface>
14528
14529	<!--
14530	// INetworkAdapter
14531	/////////////////////////////////////////////////////////////////////////
14532	-->
14533
14534	<enum
14535	name="NetworkAttachmentType"
14536	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14537	>
14538	<desc>
14539	Network attachment type.
14540	</desc>
14541
14542	<const name="Null" value="0">
14543	<desc>Null value, also means "not attached".</desc>
14544	</const>
14545	<const name="NAT" value="1"/>
14546	<const name="Bridged" value="2"/>
14547	<const name="Internal" value="3"/>
14548	<const name="HostOnly" value="4"/>
14549	<const name="Generic" value="5"/>
14550	</enum>
14551
14552	<enum
14553	name="NetworkAdapterType"
14554	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14555	>
14556	<desc>
14557	Network adapter type.
14558	</desc>
14559
14560	<const name="Null" value="0">
14561	<desc>Null value (never used by the API).</desc>
14562	</const>
14563	<const name="Am79C970A" value="1">
14564	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14565	</const>
14566	<const name="Am79C973" value="2">
14567	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
14568	</const>
14569	<const name="I82540EM" value="3">
14570	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
14571	</const>
14572	<const name="I82543GC" value="4">
14573	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
14574	</const>
14575	<const name="I82545EM" value="5">
14576	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
14577	</const>
14578	<const name="Virtio" value="6">
14579	<desc>Virtio network device.</desc>
14580	</const>
14581	</enum>
14582
14583	<enum
14584	name="NetworkAdapterPromiscModePolicy"
14585	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
14586	>
14587	<desc>
14588	The promiscuous mode policy of an interface.
14589	</desc>
14590
14591	<const name="Deny" value="1">
14592	<desc>Deny promiscuous mode requests.</desc>
14593	</const>
14594	<const name="AllowNetwork" value="2">
14595	<desc>
14596	Allow promicuous mode, but restrict the scope it to the internal
14597	network so that it only applies to other VMs.
14598	</desc>
14599	</const>
14600	<const name="AllowAll" value="3">
14601	<desc>
14602	Allow promicuous mode, include unrelated traffic going over the wire
14603	and internally on the host.
14604	</desc>
14605	</const>
14606	</enum>
14607
14608	<interface
14609	name="INetworkAdapter" extends="$unknown"
14610	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
14611	wsmap="managed"
14612	>
14613	<desc>
14614	Represents a virtual network adapter that is attached to a virtual machine.
14615	Each virtual machine has a fixed number of network adapter slots with one
14616	instance of this attached to each of them. Call
14617	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
14618	is attached to a given slot in a given machine.
14619
14620	Each network adapter can be in one of five attachment modes, which are
14621	represented by the <link to="NetworkAttachmentType" /> enumeration;
14622	see the <link to="#attachmentType" /> attribute.
14623	</desc>
14624
14625	<attribute name="adapterType" type="NetworkAdapterType">
14626	<desc>
14627	Type of the virtual network adapter. Depending on this value,
14628	VirtualBox will provide a different virtual network hardware
14629	to the guest.
14630	</desc>
14631	</attribute>
14632
14633	<attribute name="slot" type="unsigned long" readonly="yes">
14634	<desc>
14635	Slot number this adapter is plugged into. Corresponds to
14636	the value you pass to <link to="IMachine::getNetworkAdapter"/>
14637	to obtain this instance.
14638	</desc>
14639	</attribute>
14640
14641	<attribute name="enabled" type="boolean">
14642	<desc>
14643	Flag whether the network adapter is present in the
14644	guest system. If disabled, the virtual guest hardware will
14645	not contain this network adapter. Can only be changed when
14646	the VM is not running.
14647	</desc>
14648	</attribute>
14649
14650	<attribute name="MACAddress" type="wstring">
14651	<desc>
14652	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
14653	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
14654	</desc>
14655	</attribute>
14656
14657	<attribute name="attachmentType" type="NetworkAttachmentType">
14658	<desc>
14659	Sets/Gets network attachment type of this network adapter.
14660	</desc>
14661	</attribute>
14662
14663	<attribute name="bridgedInterface" type="wstring">
14664	<desc>
14665	Name of the network interface the VM should be bridged to.
14666	</desc>
14667	</attribute>
14668
14669	<attribute name="hostOnlyInterface" type="wstring">
14670	<desc>
14671	Name of the host only network interface the VM is attached to.
14672	</desc>
14673	</attribute>
14674
14675	<attribute name="internalNetwork" type="wstring">
14676	<desc>
14677	Name of the internal network the VM is attached to.
14678	</desc>
14679	</attribute>
14680
14681	<attribute name="NATNetwork" type="wstring">
14682	<desc>
14683	Name of the NAT network the VM is attached to.
14684	</desc>
14685	</attribute>
14686
14687	<attribute name="genericDriver" type="wstring">
14688	<desc>
14689	Name of the driver to use for the "Generic" network attachment type.
14690	</desc>
14691	</attribute>
14692
14693	<attribute name="cableConnected" type="boolean">
14694	<desc>
14695	Flag whether the adapter reports the cable as connected or not.
14696	It can be used to report offline situations to a VM.
14697	</desc>
14698	</attribute>
14699
14700	<attribute name="lineSpeed" type="unsigned long">
14701	<desc>
14702	Line speed reported by custom drivers, in units of 1 kbps.
14703	</desc>
14704	</attribute>
14705
14706	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
14707	<desc>
14708	The promiscuous mode policy of the network adapter when attached to an
14709	internal network, host only network or a bridge.
14710	</desc>
14711	</attribute>
14712
14713	<attribute name="traceEnabled" type="boolean">
14714	<desc>
14715	Flag whether network traffic from/to the network card should be traced.
14716	Can only be toggled when the VM is turned off.
14717	</desc>
14718	</attribute>
14719
14720	<attribute name="traceFile" type="wstring">
14721	<desc>
14722	Filename where a network trace will be stored. If not set, VBox-pid.pcap
14723	will be used.
14724	</desc>
14725	</attribute>
14726
14727	<attribute name="NATEngine" type="INATEngine" readonly="yes">
14728	<desc>
14729	Points to the NAT engine which handles the network address translation
14730	for this interface. This is active only when the interface actually uses
14731	NAT.
14732	</desc>
14733	</attribute>
14734
14735	<attribute name="bootPriority" type="unsigned long">
14736	<desc>
14737	Network boot priority of the adapter. Priority 1 is highest. If not set,
14738	the priority is considered to be at the lowest possible setting.
14739	</desc>
14740	</attribute>
14741
14742	<attribute name="bandwidthGroup" type="IBandwidthGroup">
14743	<desc>The bandwidth group this network adapter is assigned to.</desc>
14744	</attribute>
14745
14746	<!-- property methods -->
14747
14748	<method name="getProperty" const="yes">
14749	<desc>
14750	Returns the value of the network attachment property with the given name.
14751
14752	If the requested data @a key does not exist, this function will
14753	succeed and return an empty string in the @a value argument.
14754
14755	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14756	</desc>
14757	<param name="key" type="wstring" dir="in">
14758	<desc>Name of the property to get.</desc>
14759	</param>
14760	<param name="value" type="wstring" dir="return">
14761	<desc>Current property value.</desc>
14762	</param>
14763	</method>
14764
14765	<method name="setProperty">
14766	<desc>
14767	Sets the value of the network attachment property with the given name.
14768
14769	Setting the property value to @c null or an empty string is equivalent
14770	to deleting the existing value.
14771
14772	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14773	</desc>
14774	<param name="key" type="wstring" dir="in">
14775	<desc>Name of the property to set.</desc>
14776	</param>
14777	<param name="value" type="wstring" dir="in">
14778	<desc>Property value to set.</desc>
14779	</param>
14780	</method>
14781
14782	<method name="getProperties" const="yes">
14783	<desc>
14784	Returns values for a group of properties in one call.
14785
14786	The names of the properties to get are specified using the @a names
14787	argument which is a list of comma-separated property names or
14788	an empty string if all properties are to be returned.
14789	<note>Currently the value of this argument is ignored and the method
14790	always returns all existing properties.</note>
14791
14792	The method returns two arrays, the array of property names corresponding
14793	to the @a names argument and the current values of these properties.
14794	Both arrays have the same number of elements with each element at the
14795	given index in the first array corresponds to an element at the same
14796	index in the second array.
14797	</desc>
14798	<param name="names" type="wstring" dir="in">
14799	<desc>
14800	Names of properties to get.
14801	</desc>
14802	</param>
14803	<param name="returnNames" type="wstring" safearray="yes" dir="out">
14804	<desc>Names of returned properties.</desc>
14805	</param>
14806	<param name="returnValues" type="wstring" safearray="yes" dir="return">
14807	<desc>Values of returned properties.</desc>
14808	</param>
14809	</method>
14810
14811	</interface>
14812
14813
14814	<!--
14815	// ISerialPort
14816	/////////////////////////////////////////////////////////////////////////
14817	-->
14818
14819	<enum
14820	name="PortMode"
14821	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
14822	>
14823	<desc>
14824	The PortMode enumeration represents possible communication modes for
14825	the virtual serial port device.
14826	</desc>
14827
14828	<const name="Disconnected" value="0">
14829	<desc>Virtual device is not attached to any real host device.</desc>
14830	</const>
14831	<const name="HostPipe" value="1">
14832	<desc>Virtual device is attached to a host pipe.</desc>
14833	</const>
14834	<const name="HostDevice" value="2">
14835	<desc>Virtual device is attached to a host device.</desc>
14836	</const>
14837	<const name="RawFile" value="3">
14838	<desc>Virtual device is attached to a raw file.</desc>
14839	</const>
14840	</enum>
14841
14842	<interface
14843	name="ISerialPort" extends="$unknown"
14844	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
14845	wsmap="managed"
14846	>
14847
14848	<desc>
14849	The ISerialPort interface represents the virtual serial port device.
14850
14851	The virtual serial port device acts like an ordinary serial port
14852	inside the virtual machine. This device communicates to the real
14853	serial port hardware in one of two modes: host pipe or host device.
14854
14855	In host pipe mode, the #path attribute specifies the path to the pipe on
14856	the host computer that represents a serial port. The #server attribute
14857	determines if this pipe is created by the virtual machine process at
14858	machine startup or it must already exist before starting machine
14859	execution.
14860
14861	In host device mode, the #path attribute specifies the name of the
14862	serial port device on the host computer.
14863
14864	There is also a third communication mode: the disconnected mode. In this
14865	mode, the guest OS running inside the virtual machine will be able to
14866	detect the serial port, but all port write operations will be discarded
14867	and all port read operations will return no data.
14868
14869	<see><link to="IMachine::getSerialPort"/></see>
14870	</desc>
14871
14872	<attribute name="slot" type="unsigned long" readonly="yes">
14873	<desc>
14874	Slot number this serial port is plugged into. Corresponds to
14875	the value you pass to <link to="IMachine::getSerialPort"/>
14876	to obtain this instance.
14877	</desc>
14878	</attribute>
14879
14880	<attribute name="enabled" type="boolean">
14881	<desc>
14882	Flag whether the serial port is enabled. If disabled,
14883	the serial port will not be reported to the guest OS.
14884	</desc>
14885	</attribute>
14886
14887	<attribute name="IOBase" type="unsigned long">
14888	<desc>Base I/O address of the serial port.</desc>
14889	</attribute>
14890
14891	<attribute name="IRQ" type="unsigned long">
14892	<desc>IRQ number of the serial port.</desc>
14893	</attribute>
14894
14895	<attribute name="hostMode" type="PortMode">
14896	<desc>
14897	How is this port connected to the host.
14898	<note>
14899	Changing this attribute may fail if the conditions for
14900	<link to="#path"/> are not met.
14901	</note>
14902	</desc>
14903	</attribute>
14904
14905	<attribute name="server" type="boolean">
14906	<desc>
14907	Flag whether this serial port acts as a server (creates a new pipe on
14908	the host) or as a client (uses the existing pipe). This attribute is
14909	used only when <link to="#hostMode"/> is PortMode_HostPipe.
14910	</desc>
14911	</attribute>
14912
14913	<attribute name="path" type="wstring">
14914	<desc>
14915	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
14916	PortMode_HostPipe, or the host serial device name when
14917	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
14918	cases, setting a @c null or empty string as the attribute's value
14919	is an error. Otherwise, the value of this property is ignored.
14920	</desc>
14921	</attribute>
14922
14923	</interface>
14924
14925	<!--
14926	// IParallelPort
14927	/////////////////////////////////////////////////////////////////////////
14928	-->
14929
14930	<interface
14931	name="IParallelPort" extends="$unknown"
14932	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
14933	wsmap="managed"
14934	>
14935
14936	<desc>
14937	The IParallelPort interface represents the virtual parallel port device.
14938
14939	The virtual parallel port device acts like an ordinary parallel port
14940	inside the virtual machine. This device communicates to the real
14941	parallel port hardware using the name of the parallel device on the host
14942	computer specified in the #path attribute.
14943
14944	Each virtual parallel port device is assigned a base I/O address and an
14945	IRQ number that will be reported to the guest operating system and used
14946	to operate the given parallel port from within the virtual machine.
14947
14948	<see><link to="IMachine::getParallelPort"/></see>
14949	</desc>
14950
14951	<attribute name="slot" type="unsigned long" readonly="yes">
14952	<desc>
14953	Slot number this parallel port is plugged into. Corresponds to
14954	the value you pass to <link to="IMachine::getParallelPort"/>
14955	to obtain this instance.
14956	</desc>
14957	</attribute>
14958
14959	<attribute name="enabled" type="boolean">
14960	<desc>
14961	Flag whether the parallel port is enabled. If disabled,
14962	the parallel port will not be reported to the guest OS.
14963	</desc>
14964	</attribute>
14965
14966	<attribute name="IOBase" type="unsigned long">
14967	<desc>Base I/O address of the parallel port.</desc>
14968	</attribute>
14969
14970	<attribute name="IRQ" type="unsigned long">
14971	<desc>IRQ number of the parallel port.</desc>
14972	</attribute>
14973
14974	<attribute name="path" type="wstring">
14975	<desc>
14976	Host parallel device name. If this parallel port is enabled, setting a
14977	@c null or an empty string as this attribute's value will result in
14978	an error.
14979	</desc>
14980	</attribute>
14981
14982	</interface>
14983
14984
14985	<!--
14986	// IMachineDebugger
14987	/////////////////////////////////////////////////////////////////////////
14988	-->
14989
14990	<interface
14991	name="IMachineDebugger" extends="$unknown"
14992	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
14993	wsmap="managed"
14994	>
14995	<method name="dumpGuestCore">
14996	<desc>
14997	Takes a core dump of the guest.
14998
14999	See include/VBox/dbgfcorefmt.h for details on the file format.
15000	</desc>
15001	<param name="filename" type="wstring" dir="in">
15002	<desc>
15003	The name of the output file. The file must not exist.
15004	</desc>
15005	</param>
15006	<param name="compression" type="wstring" dir="in">
15007	<desc>
15008	Reserved for future compression method indicator.
15009	</desc>
15010	</param>
15011	</method>
15012
15013	<method name="dumpHostProcessCore">
15014	<desc>
15015	Takes a core dump of the VM process on the host.
15016
15017	This feature is not implemented in the 4.0.0 release but it may show up
15018	in a dot release.
15019	</desc>
15020	<param name="filename" type="wstring" dir="in">
15021	<desc>
15022	The name of the output file. The file must not exist.
15023	</desc>
15024	</param>
15025	<param name="compression" type="wstring" dir="in">
15026	<desc>
15027	Reserved for future compression method indicator.
15028	</desc>
15029	</param>
15030	</method>
15031
15032	<method name="info">
15033	<desc>
15034	Interfaces with the info dumpers (DBGFInfo).
15035
15036	This feature is not implemented in the 4.0.0 release but it may show up
15037	in a dot release.
15038	</desc>
15039	<param name="name" type="wstring" dir="in">
15040	<desc>
15041	The name of the info item.
15042	</desc>
15043	</param>
15044	<param name="args" type="wstring" dir="in">
15045	<desc>
15046	Arguments to the info dumper.
15047	</desc>
15048	</param>
15049	<param name="info" type="wstring" dir="return">
15050	<desc>
15051	The into string.
15052	</desc>
15053	</param>
15054	</method>
15055
15056	<method name="injectNMI">
15057	<desc>
15058	Inject an NMI into a running VT-x/AMD-V VM.
15059	</desc>
15060	</method>
15061
15062	<method name="modifyLogGroups">
15063	<desc>
15064	Modifies the group settings of the debug or release logger.
15065	</desc>
15066	<param name="settings" type="wstring" dir="in">
15067	<desc>
15068	The group settings string. See iprt/log.h for details. To target the
15069	release logger, prefix the string with "release:".
15070	</desc>
15071	</param>
15072	</method>
15073
15074	<method name="modifyLogFlags">
15075	<desc>
15076	Modifies the debug or release logger flags.
15077	</desc>
15078	<param name="settings" type="wstring" dir="in">
15079	<desc>
15080	The flags settings string. See iprt/log.h for details. To target the
15081	release logger, prefix the string with "release:".
15082	</desc>
15083	</param>
15084	</method>
15085
15086	<method name="modifyLogDestinations">
15087	<desc>
15088	Modifies the debug or release logger destinations.
15089	</desc>
15090	<param name="settings" type="wstring" dir="in">
15091	<desc>
15092	The destination settings string. See iprt/log.h for details. To target the
15093	release logger, prefix the string with "release:".
15094	</desc>
15095	</param>
15096	</method>
15097
15098	<method name="readPhysicalMemory">
15099	<desc>
15100	Reads guest physical memory, no side effects (MMIO++).
15101
15102	This feature is not implemented in the 4.0.0 release but may show up
15103	in a dot release.
15104	</desc>
15105	<param name="address" type="long long" dir="in">
15106	<desc>The guest physical address.</desc>
15107	</param>
15108	<param name="size" type="unsigned long" dir="in">
15109	<desc>The number of bytes to read.</desc>
15110	</param>
15111	<param name="bytes" type="octet" safearray="yes" dir="return">
15112	<desc>The bytes read.</desc>
15113	</param>
15114	</method>
15115
15116	<method name="writePhysicalMemory">
15117	<desc>
15118	Writes guest physical memory, access handles (MMIO++) are ignored.
15119
15120	This feature is not implemented in the 4.0.0 release but may show up
15121	in a dot release.
15122	</desc>
15123	<param name="address" type="long long" dir="in">
15124	<desc>The guest physical address.</desc>
15125	</param>
15126	<param name="size" type="unsigned long" dir="in">
15127	<desc>The number of bytes to read.</desc>
15128	</param>
15129	<param name="bytes" type="octet" safearray="yes" dir="in">
15130	<desc>The bytes to write.</desc>
15131	</param>
15132	</method>
15133
15134	<method name="readVirtualMemory">
15135	<desc>
15136	Reads guest virtual memory, no side effects (MMIO++).
15137
15138	This feature is not implemented in the 4.0.0 release but may show up
15139	in a dot release.
15140	</desc>
15141	<param name="cpuId" type="unsigned long" dir="in">
15142	<desc>The identifier of the Virtual CPU.</desc>
15143	</param>
15144	<param name="address" type="long long" dir="in">
15145	<desc>The guest virtual address.</desc>
15146	</param>
15147	<param name="size" type="unsigned long" dir="in">
15148	<desc>The number of bytes to read.</desc>
15149	</param>
15150	<param name="bytes" type="octet" safearray="yes" dir="return">
15151	<desc>The bytes read.</desc>
15152	</param>
15153	</method>
15154
15155	<method name="writeVirtualMemory">
15156	<desc>
15157	Writes guest virtual memory, access handles (MMIO++) are ignored.
15158
15159	This feature is not implemented in the 4.0.0 release but may show up
15160	in a dot release.
15161	</desc>
15162	<param name="cpuId" type="unsigned long" dir="in">
15163	<desc>The identifier of the Virtual CPU.</desc>
15164	</param>
15165	<param name="address" type="long long" dir="in">
15166	<desc>The guest virtual address.</desc>
15167	</param>
15168	<param name="size" type="unsigned long" dir="in">
15169	<desc>The number of bytes to read.</desc>
15170	</param>
15171	<param name="bytes" type="octet" safearray="yes" dir="in">
15172	<desc>The bytes to write.</desc>
15173	</param>
15174	</method>
15175
15176	<method name="detectOS">
15177	<desc>
15178	Tries to (re-)detect the guest OS kernel.
15179
15180	This feature is not implemented in the 4.0.0 release but may show up
15181	in a dot release.
15182	</desc>
15183	<param name="os" type="wstring" dir="return">
15184	<desc>
15185	The detected OS kernel on success.
15186	</desc>
15187	</param>
15188	</method>
15189
15190	<method name="getRegister">
15191	<desc>
15192	Gets one register.
15193
15194	This feature is not implemented in the 4.0.0 release but may show up
15195	in a dot release.
15196	</desc>
15197	<param name="cpuId" type="unsigned long" dir="in">
15198	<desc>The identifier of the Virtual CPU.</desc>
15199	</param>
15200	<param name="name" type="wstring" dir="in">
15201	<desc>The register name, case is ignored.</desc>
15202	</param>
15203	<param name="value" type="wstring" dir="return">
15204	<desc>
15205	The register value. This is usually a hex value (always 0x prefixed)
15206	but other format may be used for floating point registers (TBD).
15207	</desc>
15208	</param>
15209	</method>
15210
15211	<method name="getRegisters">
15212	<desc>
15213	Gets all the registers for the given CPU.
15214
15215	This feature is not implemented in the 4.0.0 release but may show up
15216	in a dot release.
15217	</desc>
15218	<param name="cpuId" type="unsigned long" dir="in">
15219	<desc>The identifier of the Virtual CPU.</desc>
15220	</param>
15221	<param name="names" type="wstring" dir="out" safearray="yes">
15222	<desc>Array containing the lowercase register names.</desc>
15223	</param>
15224	<param name="values" type="wstring" dir="out" safearray="yes">
15225	<desc>
15226	Array paralell to the names holding the register values as if the
15227	register was returned by <link to="IMachineDebugger::getRegister"/>.
15228	</desc>
15229	</param>
15230	</method>
15231
15232	<method name="setRegister">
15233	<desc>
15234	Gets one register.
15235
15236	This feature is not implemented in the 4.0.0 release but may show up
15237	in a dot release.
15238	</desc>
15239	<param name="cpuId" type="unsigned long" dir="in">
15240	<desc>The identifier of the Virtual CPU.</desc>
15241	</param>
15242	<param name="name" type="wstring" dir="in">
15243	<desc>The register name, case is ignored.</desc>
15244	</param>
15245	<param name="value" type="wstring" dir="in">
15246	<desc>
15247	The new register value. Hexadecimal, decimal and octal formattings
15248	are supported in addition to any special formattings returned by
15249	the getters.
15250	</desc>
15251	</param>
15252	</method>
15253
15254	<method name="setRegisters">
15255	<desc>
15256	Sets zero or more registers atomically.
15257
15258	This feature is not implemented in the 4.0.0 release but may show up
15259	in a dot release.
15260	</desc>
15261	<param name="cpuId" type="unsigned long" dir="in">
15262	<desc>The identifier of the Virtual CPU.</desc>
15263	</param>
15264	<param name="names" type="wstring" dir="in" safearray="yes">
15265	<desc>Array containing the register names, case ignored.</desc>
15266	</param>
15267	<param name="values" type="wstring" dir="in" safearray="yes">
15268	<desc>
15269	Array paralell to the names holding the register values. See
15270	<link to="IMachineDebugger::setRegister"/> for formatting
15271	guidelines.
15272	</desc>
15273	</param>
15274	</method>
15275
15276	<method name="dumpGuestStack">
15277	<desc>
15278	Produce a simple stack dump using the current guest state.
15279
15280	This feature is not implemented in the 4.0.0 release but may show up
15281	in a dot release.
15282	</desc>
15283	<param name="cpuId" type="unsigned long" dir="in">
15284	<desc>The identifier of the Virtual CPU.</desc>
15285	</param>
15286	<param name="stack" type="wstring" dir="return">
15287	<desc>String containing the formatted stack dump.</desc>
15288	</param>
15289	</method>
15290
15291	<method name="resetStats">
15292	<desc>
15293	Reset VM statistics.
15294	</desc>
15295	<param name="pattern" type="wstring" dir="in">
15296	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15297	</param>
15298	</method>
15299
15300	<method name="dumpStats">
15301	<desc>
15302	Dumps VM statistics.
15303	</desc>
15304	<param name="pattern" type="wstring" dir="in">
15305	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15306	</param>
15307	</method>
15308
15309	<method name="getStats">
15310	<desc>
15311	Get the VM statistics in a XMLish format.
15312	</desc>
15313	<param name="pattern" type="wstring" dir="in">
15314	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15315	</param>
15316	<param name="withDescriptions" type="boolean" dir="in">
15317	<desc>Whether to include the descriptions.</desc>
15318	</param>
15319	<param name="stats" type="wstring" dir="return">
15320	<desc>The XML document containing the statistics.</desc>
15321	</param>
15322	</method>
15323
15324	<attribute name="singleStep" type="boolean">
15325	<desc>Switch for enabling single-stepping.</desc>
15326	</attribute>
15327
15328	<attribute name="recompileUser" type="boolean">
15329	<desc>Switch for forcing code recompilation for user mode code.</desc>
15330	</attribute>
15331
15332	<attribute name="recompileSupervisor" type="boolean">
15333	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15334	</attribute>
15335
15336	<attribute name="PATMEnabled" type="boolean">
15337	<desc>Switch for enabling and disabling the PATM component.</desc>
15338	</attribute>
15339
15340	<attribute name="CSAMEnabled" type="boolean">
15341	<desc>Switch for enabling and disabling the CSAM component.</desc>
15342	</attribute>
15343
15344	<attribute name="logEnabled" type="boolean">
15345	<desc>Switch for enabling and disabling the debug logger.</desc>
15346	</attribute>
15347
15348	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15349	<desc>The debug logger flags.</desc>
15350	</attribute>
15351
15352	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15353	<desc>The debug logger's group settings.</desc>
15354	</attribute>
15355
15356	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15357	<desc>The debug logger's destination settings.</desc>
15358	</attribute>
15359
15360	<attribute name="logRelFlags" type="wstring" readonly="yes">
15361	<desc>The release logger flags.</desc>
15362	</attribute>
15363
15364	<attribute name="logRelGroups" type="wstring" readonly="yes">
15365	<desc>The release logger's group settings.</desc>
15366	</attribute>
15367
15368	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15369	<desc>The relase logger's destination settings.</desc>
15370	</attribute>
15371
15372	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15373	<desc>
15374	Flag indicating whether the VM is currently making use of CPU hardware
15375	virtualization extensions.
15376	</desc>
15377	</attribute>
15378
15379	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15380	<desc>
15381	Flag indicating whether the VM is currently making use of the nested paging
15382	CPU hardware virtualization extension.
15383	</desc>
15384	</attribute>
15385
15386	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15387	<desc>
15388	Flag indicating whether the VM is currently making use of the VPID
15389	VT-x extension.
15390	</desc>
15391	</attribute>
15392
15393	<attribute name="OSName" type="wstring" readonly="yes">
15394	<desc>
15395	Query the guest OS kernel name as detected by the DBGF.
15396
15397	This feature is not implemented in the 4.0.0 release but may show up
15398	in a dot release.
15399	</desc>
15400	</attribute>
15401
15402	<attribute name="OSVersion" type="wstring" readonly="yes">
15403	<desc>
15404	Query the guest OS kernel version string as detected by the DBGF.
15405
15406	This feature is not implemented in the 4.0.0 release but may show up
15407	in a dot release.
15408	</desc>
15409	</attribute>
15410
15411	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15412	<desc>
15413	Flag indicating whether the VM is currently making use of the Physical
15414	Address Extension CPU feature.
15415	</desc>
15416	</attribute>
15417
15418	<attribute name="virtualTimeRate" type="unsigned long">
15419	<desc>
15420	The rate at which the virtual time runs expressed as a percentage.
15421	The accepted range is 2% to 20000%.
15422	</desc>
15423	</attribute>
15424
15425	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15426	<desc>
15427	Gets the VM handle. This is only for internal use while
15428	we carve the details of this interface.
15429	</desc>
15430	</attribute>
15431
15432	</interface>
15433
15434	<!--
15435	// IUSBController
15436	/////////////////////////////////////////////////////////////////////////
15437	-->
15438
15439	<interface
15440	name="IUSBController" extends="$unknown"
15441	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15442	wsmap="managed"
15443	>
15444	<attribute name="enabled" type="boolean">
15445	<desc>
15446	Flag whether the USB controller is present in the
15447	guest system. If disabled, the virtual guest hardware will
15448	not contain any USB controller. Can only be changed when
15449	the VM is powered off.
15450	</desc>
15451	</attribute>
15452
15453	<attribute name="enabledEHCI" type="boolean">
15454	<desc>
15455	Flag whether the USB EHCI controller is present in the
15456	guest system. If disabled, the virtual guest hardware will
15457	not contain a USB EHCI controller. Can only be changed when
15458	the VM is powered off.
15459	</desc>
15460	</attribute>
15461
15462	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15463	<desc>
15464	Flag whether there is an USB proxy available.
15465	</desc>
15466	</attribute>
15467
15468	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15469	<desc>
15470	USB standard version which the controller implements.
15471	This is a BCD which means that the major version is in the
15472	high byte and minor version is in the low byte.
15473	</desc>
15474	</attribute>
15475
15476	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15477	<desc>
15478	List of USB device filters associated with the machine.
15479
15480	If the machine is currently running, these filters are activated
15481	every time a new (supported) USB device is attached to the host
15482	computer that was not ignored by global filters
15483	(<link to="IHost::USBDeviceFilters"/>).
15484
15485	These filters are also activated when the machine is powered up.
15486	They are run against a list of all currently available USB
15487	devices (in states
15488	<link to="USBDeviceState_Available"/>,
15489	<link to="USBDeviceState_Busy"/>,
15490	<link to="USBDeviceState_Held"/>) that were not previously
15491	ignored by global filters.
15492
15493	If at least one filter matches the USB device in question, this
15494	device is automatically captured (attached to) the virtual USB
15495	controller of this machine.
15496
15497	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15498	</desc>
15499	</attribute>
15500
15501	<method name="createDeviceFilter">
15502	<desc>
15503	Creates a new USB device filter. All attributes except
15504	the filter name are set to empty (any match),
15505	<i>active</i> is @c false (the filter is not active).
15506
15507	The created filter can then be added to the list of filters using
15508	<link to="#insertDeviceFilter"/>.
15509
15510	<result name="VBOX_E_INVALID_VM_STATE">
15511	The virtual machine is not mutable.
15512	</result>
15513
15514	<see><link to="#deviceFilters"/></see>
15515	</desc>
15516	<param name="name" type="wstring" dir="in">
15517	<desc>
15518	Filter name. See <link to="IUSBDeviceFilter::name"/>
15519	for more info.
15520	</desc>
15521	</param>
15522	<param name="filter" type="IUSBDeviceFilter" dir="return">
15523	<desc>Created filter object.</desc>
15524	</param>
15525	</method>
15526
15527	<method name="insertDeviceFilter">
15528	<desc>
15529	Inserts the given USB device to the specified position
15530	in the list of filters.
15531
15532	Positions are numbered starting from <tt>0</tt>. If the specified
15533	position is equal to or greater than the number of elements in
15534	the list, the filter is added to the end of the collection.
15535
15536	<note>
15537	Duplicates are not allowed, so an attempt to insert a
15538	filter that is already in the collection, will return an
15539	error.
15540	</note>
15541
15542	<result name="VBOX_E_INVALID_VM_STATE">
15543	Virtual machine is not mutable.
15544	</result>
15545	<result name="E_INVALIDARG">
15546	USB device filter not created within this VirtualBox instance.
15547	</result>
15548	<result name="VBOX_E_INVALID_OBJECT_STATE">
15549	USB device filter already in list.
15550	</result>
15551
15552	<see><link to="#deviceFilters"/></see>
15553	</desc>
15554	<param name="position" type="unsigned long" dir="in">
15555	<desc>Position to insert the filter to.</desc>
15556	</param>
15557	<param name="filter" type="IUSBDeviceFilter" dir="in">
15558	<desc>USB device filter to insert.</desc>
15559	</param>
15560	</method>
15561
15562	<method name="removeDeviceFilter">
15563	<desc>
15564	Removes a USB device filter from the specified position in the
15565	list of filters.
15566
15567	Positions are numbered starting from <tt>0</tt>. Specifying a
15568	position equal to or greater than the number of elements in
15569	the list will produce an error.
15570
15571	<see><link to="#deviceFilters"/></see>
15572
15573	<result name="VBOX_E_INVALID_VM_STATE">
15574	Virtual machine is not mutable.
15575	</result>
15576	<result name="E_INVALIDARG">
15577	USB device filter list empty or invalid @a position.
15578	</result>
15579
15580	</desc>
15581	<param name="position" type="unsigned long" dir="in">
15582	<desc>Position to remove the filter from.</desc>
15583	</param>
15584	<param name="filter" type="IUSBDeviceFilter" dir="return">
15585	<desc>Removed USB device filter.</desc>
15586	</param>
15587	</method>
15588
15589	</interface>
15590
15591
15592	<!--
15593	// IUSBDevice
15594	/////////////////////////////////////////////////////////////////////////
15595	-->
15596
15597	<interface
15598	name="IUSBDevice" extends="$unknown"
15599	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
15600	wsmap="managed"
15601	>
15602	<desc>
15603	The IUSBDevice interface represents a virtual USB device attached to the
15604	virtual machine.
15605
15606	A collection of objects implementing this interface is stored in the
15607	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
15608	attached to a running virtual machine's USB controller.
15609	</desc>
15610
15611	<attribute name="id" type="uuid" mod="string" readonly="yes">
15612	<desc>
15613	Unique USB device ID. This ID is built from #vendorId,
15614	#productId, #revision and #serialNumber.
15615	</desc>
15616	</attribute>
15617
15618	<attribute name="vendorId" type="unsigned short" readonly="yes">
15619	<desc>Vendor ID.</desc>
15620	</attribute>
15621
15622	<attribute name="productId" type="unsigned short" readonly="yes">
15623	<desc>Product ID.</desc>
15624	</attribute>
15625
15626	<attribute name="revision" type="unsigned short" readonly="yes">
15627	<desc>
15628	Product revision number. This is a packed BCD represented as
15629	unsigned short. The high byte is the integer part and the low
15630	byte is the decimal.
15631	</desc>
15632	</attribute>
15633
15634	<attribute name="manufacturer" type="wstring" readonly="yes">
15635	<desc>Manufacturer string.</desc>
15636	</attribute>
15637
15638	<attribute name="product" type="wstring" readonly="yes">
15639	<desc>Product string.</desc>
15640	</attribute>
15641
15642	<attribute name="serialNumber" type="wstring" readonly="yes">
15643	<desc>Serial number string.</desc>
15644	</attribute>
15645
15646	<attribute name="address" type="wstring" readonly="yes">
15647	<desc>Host specific address of the device.</desc>
15648	</attribute>
15649
15650	<attribute name="port" type="unsigned short" readonly="yes">
15651	<desc>
15652	Host USB port number the device is physically
15653	connected to.
15654	</desc>
15655	</attribute>
15656
15657	<attribute name="version" type="unsigned short" readonly="yes">
15658	<desc>
15659	The major USB version of the device - 1 or 2.
15660	</desc>
15661	</attribute>
15662
15663	<attribute name="portVersion" type="unsigned short" readonly="yes">
15664	<desc>
15665	The major USB version of the host USB port the device is
15666	physically connected to - 1 or 2. For devices not connected to
15667	anything this will have the same value as the version attribute.
15668	</desc>
15669	</attribute>
15670
15671	<attribute name="remote" type="boolean" readonly="yes">
15672	<desc>
15673	Whether the device is physically connected to a remote VRDE
15674	client or to a local host machine.
15675	</desc>
15676	</attribute>
15677
15678	</interface>
15679
15680
15681	<!--
15682	// IUSBDeviceFilter
15683	/////////////////////////////////////////////////////////////////////////
15684	-->
15685
15686	<interface
15687	name="IUSBDeviceFilter" extends="$unknown"
15688	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
15689	wsmap="managed"
15690	>
15691	<desc>
15692	The IUSBDeviceFilter interface represents an USB device filter used
15693	to perform actions on a group of USB devices.
15694
15695	This type of filters is used by running virtual machines to
15696	automatically capture selected USB devices once they are physically
15697	attached to the host computer.
15698
15699	A USB device is matched to the given device filter if and only if all
15700	attributes of the device match the corresponding attributes of the
15701	filter (that is, attributes are joined together using the logical AND
15702	operation). On the other hand, all together, filters in the list of
15703	filters carry the semantics of the logical OR operation. So if it is
15704	desirable to create a match like "this vendor id OR this product id",
15705	one needs to create two filters and specify "any match" (see below)
15706	for unused attributes.
15707
15708	All filter attributes used for matching are strings. Each string
15709	is an expression representing a set of values of the corresponding
15710	device attribute, that will match the given filter. Currently, the
15711	following filtering expressions are supported:
15712
15713	<ul>
15714	<li><i>Interval filters</i>. Used to specify valid intervals for
15715	integer device attributes (Vendor ID, Product ID and Revision).
15716	The format of the string is:
15717
15718	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
15719
15720	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
15721	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
15722	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
15723	is omitted before a dash (<tt>-</tt>), the minimum possible integer
15724	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
15725	possible integer is assumed.
15726	</li>
15727	<li><i>Boolean filters</i>. Used to specify acceptable values for
15728	boolean device attributes. The format of the string is:
15729
15730	<tt>true\|false\|yes\|no\|0\|1</tt>
15731
15732	</li>
15733	<li><i>Exact match</i>. Used to specify a single value for the given
15734	device attribute. Any string that doesn't start with <tt>int:</tt>
15735	represents the exact match. String device attributes are compared to
15736	this string including case of symbols. Integer attributes are first
15737	converted to a string (see individual filter attributes) and then
15738	compared ignoring case.
15739
15740	</li>
15741	<li><i>Any match</i>. Any value of the corresponding device attribute
15742	will match the given filter. An empty or @c null string is
15743	used to construct this type of filtering expressions.
15744
15745	</li>
15746	</ul>
15747
15748	<note>
15749	On the Windows host platform, interval filters are not currently
15750	available. Also all string filter attributes
15751	(<link to="#manufacturer"/>, <link to="#product"/>,
15752	<link to="#serialNumber"/>) are ignored, so they behave as
15753	<i>any match</i> no matter what string expression is specified.
15754	</note>
15755
15756	<see><link to="IUSBController::deviceFilters"/>,
15757	<link to="IHostUSBDeviceFilter"/></see>
15758	</desc>
15759
15760	<attribute name="name" type="wstring">
15761	<desc>
15762	Visible name for this filter.
15763	This name is used to visually distinguish one filter from another,
15764	so it can neither be @c null nor an empty string.
15765	</desc>
15766	</attribute>
15767
15768	<attribute name="active" type="boolean">
15769	<desc>Whether this filter active or has been temporarily disabled.</desc>
15770	</attribute>
15771
15772	<attribute name="vendorId" type="wstring">
15773	<desc>
15774	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
15775	The string representation for the <i>exact matching</i>
15776	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15777	(including leading zeroes).
15778	</desc>
15779	</attribute>
15780
15781	<attribute name="productId" type="wstring">
15782	<desc>
15783	<link to="IUSBDevice::productId">Product ID</link> filter.
15784	The string representation for the <i>exact matching</i>
15785	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15786	(including leading zeroes).
15787	</desc>
15788	</attribute>
15789
15790	<attribute name="revision" type="wstring">
15791	<desc>
15792	<link to="IUSBDevice::productId">Product revision number</link>
15793	filter. The string representation for the <i>exact matching</i>
15794	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
15795	of the integer part of the revision, and <tt>F</tt> is the
15796	decimal digit of its fractional part (including leading and
15797	trailing zeros).
15798	Note that for interval filters, it's best to use the hexadecimal
15799	form, because the revision is stored as a 16 bit packed BCD value;
15800	so the expression <tt>int:0x0100-0x0199</tt> will match any
15801	revision from <tt>1.0</tt> to <tt>1.99</tt>.
15802	</desc>
15803	</attribute>
15804
15805	<attribute name="manufacturer" type="wstring">
15806	<desc>
15807	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
15808	</desc>
15809	</attribute>
15810
15811	<attribute name="product" type="wstring">
15812	<desc>
15813	<link to="IUSBDevice::product">Product</link> filter.
15814	</desc>
15815	</attribute>
15816
15817	<attribute name="serialNumber" type="wstring">
15818	<desc>
15819	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
15820	</desc>
15821	</attribute>
15822
15823	<attribute name="port" type="wstring">
15824	<desc>
15825	<link to="IUSBDevice::port">Host USB port</link> filter.
15826	</desc>
15827	</attribute>
15828
15829	<attribute name="remote" type="wstring">
15830	<desc>
15831	<link to="IUSBDevice::remote">Remote state</link> filter.
15832	<note>
15833	This filter makes sense only for machine USB filters,
15834	i.e. it is ignored by IHostUSBDeviceFilter objects.
15835	</note>
15836	</desc>
15837	</attribute>
15838
15839	<attribute name="maskedInterfaces" type="unsigned long">
15840	<desc>
15841	This is an advanced option for hiding one or more USB interfaces
15842	from the guest. The value is a bit mask where the bits that are set
15843	means the corresponding USB interface should be hidden, masked off
15844	if you like.
15845	This feature only works on Linux hosts.
15846	</desc>
15847	</attribute>
15848
15849	</interface>
15850
15851
15852	<!--
15853	// IHostUSBDevice
15854	/////////////////////////////////////////////////////////////////////////
15855	-->
15856
15857	<enum
15858	name="USBDeviceState"
15859	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
15860	>
15861	<desc>
15862	USB device state. This enumeration represents all possible states
15863	of the USB device physically attached to the host computer regarding
15864	its state on the host computer and availability to guest computers
15865	(all currently running virtual machines).
15866
15867	Once a supported USB device is attached to the host, global USB
15868	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
15869	either ignore the device, or put it to USBDeviceState_Held state, or do
15870	nothing. Unless the device is ignored by global filters, filters of all
15871	currently running guests (<link to="IUSBController::deviceFilters"/>) are
15872	activated that can put it to USBDeviceState_Captured state.
15873
15874	If the device was ignored by global filters, or didn't match
15875	any filters at all (including guest ones), it is handled by the host
15876	in a normal way. In this case, the device state is determined by
15877	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
15878	or USBDeviceState_Available, depending on the current device usage.
15879
15880	Besides auto-capturing based on filters, the device can be manually
15881	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
15882	state is USBDeviceState_Busy, USBDeviceState_Available or
15883	USBDeviceState_Held.
15884
15885	<note>
15886	Due to differences in USB stack implementations in Linux and Win32,
15887	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
15888	only to the Linux version of the product. This also means that (<link
15889	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
15890	device state is USBDeviceState_Held.
15891	</note>
15892
15893	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
15894	</desc>
15895
15896	<const name="NotSupported" value="0">
15897	<desc>
15898	Not supported by the VirtualBox server, not available to guests.
15899	</desc>
15900	</const>
15901	<const name="Unavailable" value="1">
15902	<desc>
15903	Being used by the host computer exclusively,
15904	not available to guests.
15905	</desc>
15906	</const>
15907	<const name="Busy" value="2">
15908	<desc>
15909	Being used by the host computer, potentially available to guests.
15910	</desc>
15911	</const>
15912	<const name="Available" value="3">
15913	<desc>
15914	Not used by the host computer, available to guests (the host computer
15915	can also start using the device at any time).
15916	</desc>
15917	</const>
15918	<const name="Held" value="4">
15919	<desc>
15920	Held by the VirtualBox server (ignored by the host computer),
15921	available to guests.
15922	</desc>
15923	</const>
15924	<const name="Captured" value="5">
15925	<desc>
15926	Captured by one of the guest computers, not available
15927	to anybody else.
15928	</desc>
15929	</const>
15930	</enum>
15931
15932	<interface
15933	name="IHostUSBDevice" extends="IUSBDevice"
15934	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
15935	wsmap="managed"
15936	>
15937	<desc>
15938	The IHostUSBDevice interface represents a physical USB device attached
15939	to the host computer.
15940
15941	Besides properties inherited from IUSBDevice, this interface adds the
15942	<link to="#state"/> property that holds the current state of the USB
15943	device.
15944
15945	<see><link to="IHost::USBDevices"/>,
15946	<link to="IHost::USBDeviceFilters"/></see>
15947	</desc>
15948
15949	<attribute name="state" type="USBDeviceState" readonly="yes">
15950	<desc>
15951	Current state of the device.
15952	</desc>
15953	</attribute>
15954
15955	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
15956
15957	</interface>
15958
15959
15960	<!--
15961	// IHostUSBDeviceFilter
15962	/////////////////////////////////////////////////////////////////////////
15963	-->
15964
15965	<enum
15966	name="USBDeviceFilterAction"
15967	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
15968	>
15969	<desc>
15970	Actions for host USB device filters.
15971	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
15972	</desc>
15973
15974	<const name="Null" value="0">
15975	<desc>Null value (never used by the API).</desc>
15976	</const>
15977	<const name="Ignore" value="1">
15978	<desc>Ignore the matched USB device.</desc>
15979	</const>
15980	<const name="Hold" value="2">
15981	<desc>Hold the matched USB device.</desc>
15982	</const>
15983	</enum>
15984
15985	<interface
15986	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
15987	uuid="4cc70246-d74a-400f-8222-3900489c0374"
15988	wsmap="managed"
15989	>
15990	<desc>
15991	The IHostUSBDeviceFilter interface represents a global filter for a
15992	physical USB device used by the host computer. Used indirectly in
15993	<link to="IHost::USBDeviceFilters"/>.
15994
15995	Using filters of this type, the host computer determines the initial
15996	state of the USB device after it is physically attached to the
15997	host's USB controller.
15998
15999	<note>
16000	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16001	filters, because it makes sense only for
16002	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16003	</note>
16004
16005	<see><link to="IHost::USBDeviceFilters"/></see>
16006	</desc>
16007
16008	<attribute name="action" type="USBDeviceFilterAction">
16009	<desc>
16010	Action performed by the host when an attached USB device
16011	matches this filter.
16012	</desc>
16013	</attribute>
16014
16015	</interface>
16016
16017	<!--
16018	// IAudioAdapter
16019	/////////////////////////////////////////////////////////////////////////
16020	-->
16021
16022	<enum
16023	name="AudioDriverType"
16024	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16025	>
16026	<desc>
16027	Host audio driver type.
16028	</desc>
16029
16030	<const name="Null" value="0">
16031	<desc>Null value, also means "dummy audio driver".</desc>
16032	</const>
16033	<const name="WinMM" value="1">
16034	<desc>Windows multimedia (Windows hosts only).</desc>
16035	</const>
16036	<const name="OSS" value="2">
16037	<desc>Open Sound System (Linux hosts only).</desc>
16038	</const>
16039	<const name="ALSA" value="3">
16040	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16041	</const>
16042	<const name="DirectSound" value="4">
16043	<desc>DirectSound (Windows hosts only).</desc>
16044	</const>
16045	<const name="CoreAudio" value="5">
16046	<desc>CoreAudio (Mac hosts only).</desc>
16047	</const>
16048	<const name="MMPM" value="6">
16049	<desc>Reserved for historical reasons.</desc>
16050	</const>
16051	<const name="Pulse" value="7">
16052	<desc>PulseAudio (Linux hosts only).</desc>
16053	</const>
16054	<const name="SolAudio" value="8">
16055	<desc>Solaris audio (Solaris hosts only).</desc>
16056	</const>
16057	</enum>
16058
16059	<enum
16060	name="AudioControllerType"
16061	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16062	>
16063	<desc>
16064	Virtual audio controller type.
16065	</desc>
16066
16067	<const name="AC97" value="0"/>
16068	<const name="SB16" value="1"/>
16069	<const name="HDA" value="2"/>
16070	</enum>
16071
16072	<interface
16073	name="IAudioAdapter" extends="$unknown"
16074	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16075	wsmap="managed"
16076	>
16077	<desc>
16078	The IAudioAdapter interface represents the virtual audio adapter of
16079	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16080	</desc>
16081	<attribute name="enabled" type="boolean">
16082	<desc>
16083	Flag whether the audio adapter is present in the
16084	guest system. If disabled, the virtual guest hardware will
16085	not contain any audio adapter. Can only be changed when
16086	the VM is not running.
16087	</desc>
16088	</attribute>
16089	<attribute name="audioController" type="AudioControllerType">
16090	<desc>
16091	The audio hardware we emulate.
16092	</desc>
16093	</attribute>
16094	<attribute name="audioDriver" type="AudioDriverType">
16095	<desc>
16096	Audio driver the adapter is connected to. This setting
16097	can only be changed when the VM is not running.
16098	</desc>
16099	</attribute>
16100	</interface>
16101
16102	<enum
16103	name="AuthType"
16104	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16105	>
16106	<desc>
16107	VirtualBox authentication type.
16108	</desc>
16109
16110	<const name="Null" value="0">
16111	<desc>Null value, also means "no authentication".</desc>
16112	</const>
16113	<const name="External" value="1"/>
16114	<const name="Guest" value="2"/>
16115	</enum>
16116
16117	<!--
16118	// IVRDEServer
16119	/////////////////////////////////////////////////////////////////////////
16120	-->
16121
16122	<interface
16123	name="IVRDEServer" extends="$unknown"
16124	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16125	wsmap="managed"
16126	>
16127	<attribute name="enabled" type="boolean">
16128	<desc>VRDE server status.</desc>
16129	</attribute>
16130
16131	<attribute name="authType" type="AuthType">
16132	<desc>VRDE authentication method.</desc>
16133	</attribute>
16134
16135	<attribute name="authTimeout" type="unsigned long">
16136	<desc>Timeout for guest authentication. Milliseconds.</desc>
16137	</attribute>
16138
16139	<attribute name="allowMultiConnection" type="boolean">
16140	<desc>
16141	Flag whether multiple simultaneous connections to the VM are permitted.
16142	Note that this will be replaced by a more powerful mechanism in the future.
16143	</desc>
16144	</attribute>
16145
16146	<attribute name="reuseSingleConnection" type="boolean">
16147	<desc>
16148	Flag whether the existing connection must be dropped and a new connection
16149	must be established by the VRDE server, when a new client connects in single
16150	connection mode.
16151	</desc>
16152	</attribute>
16153
16154	<attribute name="VRDEExtPack" type="wstring">
16155	<desc>
16156	The name of Extension Pack providing VRDE for this VM. Overrides
16157	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16158	</desc>
16159	</attribute>
16160
16161	<attribute name="authLibrary" type="wstring">
16162	<desc>
16163	Library used for authentication of RDP clients by this VM. Overrides
16164	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16165	</desc>
16166	</attribute>
16167
16168	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16169	<desc>
16170	Array of names of properties, which are supported by this VRDE server.
16171	</desc>
16172	</attribute>
16173
16174	<method name="setVRDEProperty">
16175	<desc>
16176	Sets a VRDE specific property string.
16177
16178	If you pass @c null or empty string as a key @a value, the given @a key
16179	will be deleted.
16180
16181	</desc>
16182	<param name="key" type="wstring" dir="in">
16183	<desc>Name of the key to set.</desc>
16184	</param>
16185	<param name="value" type="wstring" dir="in">
16186	<desc>Value to assign to the key.</desc>
16187	</param>
16188	</method>
16189
16190	<method name="getVRDEProperty" const="yes">
16191	<desc>
16192	Returns a VRDE specific property string.
16193
16194	If the requested data @a key does not exist, this function will
16195	succeed and return an empty string in the @a value argument.
16196
16197	</desc>
16198	<param name="key" type="wstring" dir="in">
16199	<desc>Name of the key to get.</desc>
16200	</param>
16201	<param name="value" type="wstring" dir="return">
16202	<desc>Value of the requested key.</desc>
16203	</param>
16204	</method>
16205
16206	</interface>
16207
16208
16209	<!--
16210	// ISharedFolder
16211	/////////////////////////////////////////////////////////////////////////
16212	-->
16213
16214	<interface
16215	name="ISharedFolder" extends="$unknown"
16216	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16217	wsmap="struct"
16218	>
16219	<desc>
16220	The ISharedFolder interface represents a folder in the host computer's
16221	file system accessible from the guest OS running inside a virtual
16222	machine using an associated logical name.
16223
16224	There are three types of shared folders:
16225	<ul>
16226	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16227	folders available to all virtual machines.</li>
16228	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16229	VM-specific shared folders available to the given virtual machine at
16230	startup.</li>
16231	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16232	VM-specific shared folders created in the session context (for
16233	example, when the virtual machine is running) and automatically
16234	discarded when the session is closed (the VM is powered off).</li>
16235	</ul>
16236
16237	Logical names of shared folders must be unique within the given scope
16238	(global, permanent or transient). However, they do not need to be unique
16239	across scopes. In this case, the definition of the shared folder in a
16240	more specific scope takes precedence over definitions in all other
16241	scopes. The order of precedence is (more specific to more general):
16242	<ol>
16243	<li>Transient definitions</li>
16244	<li>Permanent definitions</li>
16245	<li>Global definitions</li>
16246	</ol>
16247
16248	For example, if MyMachine has a shared folder named
16249	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16250	transient shared folder named <tt>C_DRIVE</tt> (that points
16251	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16252	of <tt>C_DRIVE</tt> in the guest OS so
16253	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16254	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16255	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16256	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16257	to <tt>C:\\</tt> if it still exists.
16258
16259	Note that permanent and transient shared folders of different machines
16260	are in different name spaces, so they don't overlap and don't need to
16261	have unique logical names.
16262
16263	<note>
16264	Global shared folders are not implemented in the current version of the
16265	product.
16266	</note>
16267	</desc>
16268
16269	<attribute name="name" type="wstring" readonly="yes">
16270	<desc>Logical name of the shared folder.</desc>
16271	</attribute>
16272
16273	<attribute name="hostPath" type="wstring" readonly="yes">
16274	<desc>Full path to the shared folder in the host file system.</desc>
16275	</attribute>
16276
16277	<attribute name="accessible" type="boolean" readonly="yes">
16278	<desc>
16279	Whether the folder defined by the host path is currently
16280	accessible or not.
16281	For example, the folder can be inaccessible if it is placed
16282	on the network share that is not available by the time
16283	this property is read.
16284	</desc>
16285	</attribute>
16286
16287	<attribute name="writable" type="boolean" readonly="yes">
16288	<desc>
16289	Whether the folder defined by the host path is writable or
16290	not.
16291	</desc>
16292	</attribute>
16293
16294	<attribute name="autoMount" type="boolean" readonly="yes">
16295	<desc>
16296	Whether the folder gets automatically mounted by the guest or not.
16297	</desc>
16298	</attribute>
16299
16300	<attribute name="lastAccessError" type="wstring" readonly="yes">
16301	<desc>
16302	Text message that represents the result of the last accessibility
16303	check.
16304
16305	Accessibility checks are performed each time the <link to="#accessible"/>
16306	attribute is read. An empty string is returned if the last
16307	accessibility check was successful. A non-empty string indicates a
16308	failure and should normally describe a reason of the failure (for
16309	example, a file read error).
16310	</desc>
16311	</attribute>
16312
16313	</interface>
16314
16315	<!--
16316	// ISession
16317	/////////////////////////////////////////////////////////////////////////
16318	-->
16319
16320	<interface
16321	name="IInternalSessionControl" extends="$unknown"
16322	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16323	internal="yes"
16324	wsmap="suppress"
16325	>
16326	<method name="getPID">
16327	<desc>PID of the process that has created this Session object.
16328	</desc>
16329	<param name="pid" type="unsigned long" dir="return"/>
16330	</method>
16331
16332	<method name="getRemoteConsole">
16333	<desc>
16334	Returns the console object suitable for remote control.
16335
16336	<result name="VBOX_E_INVALID_VM_STATE">
16337	Session state prevents operation.
16338	</result>
16339	<result name="VBOX_E_INVALID_OBJECT_STATE">
16340	Session type prevents operation.
16341	</result>
16342
16343	</desc>
16344	<param name="console" type="IConsole" dir="return"/>
16345	</method>
16346
16347	<method name="assignMachine">
16348	<desc>
16349	Assigns the machine object associated with this direct-type
16350	session or informs the session that it will be a remote one
16351	(if @a machine == @c null).
16352
16353	<result name="VBOX_E_INVALID_VM_STATE">
16354	Session state prevents operation.
16355	</result>
16356	<result name="VBOX_E_INVALID_OBJECT_STATE">
16357	Session type prevents operation.
16358	</result>
16359
16360	</desc>
16361	<param name="machine" type="IMachine" dir="in"/>
16362	<param name="lockType" type="LockType" dir="in"/>
16363	</method>
16364
16365	<method name="assignRemoteMachine">
16366	<desc>
16367	Assigns the machine and the (remote) console object associated with
16368	this remote-type session.
16369
16370	<result name="VBOX_E_INVALID_VM_STATE">
16371	Session state prevents operation.
16372	</result>
16373
16374	</desc>
16375	<param name="machine" type="IMachine" dir="in"/>
16376	<param name="console" type="IConsole" dir="in"/>
16377	</method>
16378
16379	<method name="updateMachineState">
16380	<desc>
16381	Updates the machine state in the VM process.
16382	Must be called only in certain cases
16383	(see the method implementation).
16384
16385	<result name="VBOX_E_INVALID_VM_STATE">
16386	Session state prevents operation.
16387	</result>
16388	<result name="VBOX_E_INVALID_OBJECT_STATE">
16389	Session type prevents operation.
16390	</result>
16391
16392	</desc>
16393	<param name="aMachineState" type="MachineState" dir="in"/>
16394	</method>
16395
16396	<method name="uninitialize">
16397	<desc>
16398	Uninitializes (closes) this session. Used by VirtualBox to close
16399	the corresponding remote session when the direct session dies
16400	or gets closed.
16401
16402	<result name="VBOX_E_INVALID_VM_STATE">
16403	Session state prevents operation.
16404	</result>
16405
16406	</desc>
16407	</method>
16408
16409	<method name="onNetworkAdapterChange">
16410	<desc>
16411	Triggered when settings of a network adapter of the
16412	associated virtual machine have changed.
16413
16414	<result name="VBOX_E_INVALID_VM_STATE">
16415	Session state prevents operation.
16416	</result>
16417	<result name="VBOX_E_INVALID_OBJECT_STATE">
16418	Session type prevents operation.
16419	</result>
16420
16421	</desc>
16422	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16423	<param name="changeAdapter" type="boolean" dir="in"/>
16424	</method>
16425
16426	<method name="onSerialPortChange">
16427	<desc>
16428	Triggered when settings of a serial port of the
16429	associated virtual machine have changed.
16430
16431	<result name="VBOX_E_INVALID_VM_STATE">
16432	Session state prevents operation.
16433	</result>
16434	<result name="VBOX_E_INVALID_OBJECT_STATE">
16435	Session type prevents operation.
16436	</result>
16437
16438	</desc>
16439	<param name="serialPort" type="ISerialPort" dir="in"/>
16440	</method>
16441
16442	<method name="onParallelPortChange">
16443	<desc>
16444	Triggered when settings of a parallel port of the
16445	associated virtual machine have changed.
16446
16447	<result name="VBOX_E_INVALID_VM_STATE">
16448	Session state prevents operation.
16449	</result>
16450	<result name="VBOX_E_INVALID_OBJECT_STATE">
16451	Session type prevents operation.
16452	</result>
16453
16454	</desc>
16455	<param name="parallelPort" type="IParallelPort" dir="in"/>
16456	</method>
16457
16458	<method name="onStorageControllerChange">
16459	<desc>
16460	Triggered when settings of a storage controller of the
16461	associated virtual machine have changed.
16462
16463	<result name="VBOX_E_INVALID_VM_STATE">
16464	Session state prevents operation.
16465	</result>
16466	<result name="VBOX_E_INVALID_OBJECT_STATE">
16467	Session type prevents operation.
16468	</result>
16469
16470	</desc>
16471	</method>
16472
16473	<method name="onMediumChange">
16474	<desc>
16475	Triggered when attached media of the
16476	associated virtual machine have changed.
16477
16478	<result name="VBOX_E_INVALID_VM_STATE">
16479	Session state prevents operation.
16480	</result>
16481	<result name="VBOX_E_INVALID_OBJECT_STATE">
16482	Session type prevents operation.
16483	</result>
16484
16485	</desc>
16486
16487	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16488	<desc>The medium attachment which changed.</desc>
16489	</param>
16490	<param name="force" type="boolean" dir="in">
16491	<desc>If the medium change was forced.</desc>
16492	</param>
16493	</method>
16494
16495	<method name="onStorageDeviceChange">
16496	<desc>
16497	Triggered when attached storage devices of the
16498	associated virtual machine have changed.
16499
16500	<result name="VBOX_E_INVALID_VM_STATE">
16501	Session state prevents operation.
16502	</result>
16503	<result name="VBOX_E_INVALID_OBJECT_STATE">
16504	Session type prevents operation.
16505	</result>
16506
16507	</desc>
16508
16509	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16510	<desc>The medium attachment which changed.</desc>
16511	</param>
16512	<param name="remove" type="boolean" dir="in">
16513	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16514	</param>
16515	</method>
16516
16517	<method name="onClipboardModeChange">
16518	<desc>
16519	Notification when the shared clipboard mode changes.
16520	</desc>
16521	<param name="clipboardMode" type="ClipboardMode" dir="in">
16522	<desc>The new shared clipboard mode.</desc>
16523	</param>
16524	</method>
16525
16526	<method name="onDragAndDropModeChange">
16527	<desc>
16528	Notification when the drag'n'drop mode changes.
16529	</desc>
16530	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16531	<desc>The new mode for drag'n'drop.</desc>
16532	</param>
16533	</method>
16534
16535	<method name="onCPUChange">
16536	<desc>
16537	Notification when a CPU changes.
16538	</desc>
16539	<param name="cpu" type="unsigned long" dir="in">
16540	<desc>The CPU which changed</desc>
16541	</param>
16542	<param name="add" type="boolean" dir="in">
16543	<desc>Flag whether the CPU was added or removed</desc>
16544	</param>
16545	</method>
16546
16547	<method name="onCPUExecutionCapChange">
16548	<desc>
16549	Notification when the CPU execution cap changes.
16550	</desc>
16551	<param name="executionCap" type="unsigned long" dir="in">
16552	<desc>The new CPU execution cap value. (1-100)</desc>
16553	</param>
16554	</method>
16555
16556	<method name="onVRDEServerChange">
16557	<desc>
16558	Triggered when settings of the VRDE server object of the
16559	associated virtual machine have changed.
16560
16561	<result name="VBOX_E_INVALID_VM_STATE">
16562	Session state prevents operation.
16563	</result>
16564	<result name="VBOX_E_INVALID_OBJECT_STATE">
16565	Session type prevents operation.
16566	</result>
16567
16568	</desc>
16569	<param name="restart" type="boolean" dir="in">
16570	<desc>Flag whether the server must be restarted</desc>
16571	</param>
16572	</method>
16573
16574	<method name="onUSBControllerChange">
16575	<desc>
16576	Triggered when settings of the USB controller object of the
16577	associated virtual machine have changed.
16578
16579	<result name="VBOX_E_INVALID_VM_STATE">
16580	Session state prevents operation.
16581	</result>
16582	<result name="VBOX_E_INVALID_OBJECT_STATE">
16583	Session type prevents operation.
16584	</result>
16585
16586	</desc>
16587	</method>
16588
16589	<method name="onSharedFolderChange">
16590	<desc>
16591	Triggered when a permanent (global or machine) shared folder has been
16592	created or removed.
16593	<note>
16594	We don't pass shared folder parameters in this notification because
16595	the order in which parallel notifications are delivered is not defined,
16596	therefore it could happen that these parameters were outdated by the
16597	time of processing this notification.
16598	</note>
16599
16600	<result name="VBOX_E_INVALID_VM_STATE">
16601	Session state prevents operation.
16602	</result>
16603	<result name="VBOX_E_INVALID_OBJECT_STATE">
16604	Session type prevents operation.
16605	</result>
16606
16607	</desc>
16608	<param name="global" type="boolean" dir="in"/>
16609	</method>
16610
16611	<method name="onUSBDeviceAttach">
16612	<desc>
16613	Triggered when a request to capture a USB device (as a result
16614	of matched USB filters or direct call to
16615	<link to="IConsole::attachUSBDevice"/>) has completed.
16616	A @c null @a error object means success, otherwise it
16617	describes a failure.
16618
16619	<result name="VBOX_E_INVALID_VM_STATE">
16620	Session state prevents operation.
16621	</result>
16622	<result name="VBOX_E_INVALID_OBJECT_STATE">
16623	Session type prevents operation.
16624	</result>
16625
16626	</desc>
16627	<param name="device" type="IUSBDevice" dir="in"/>
16628	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16629	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
16630	</method>
16631
16632	<method name="onUSBDeviceDetach">
16633	<desc>
16634	Triggered when a request to release the USB device (as a result
16635	of machine termination or direct call to
16636	<link to="IConsole::detachUSBDevice"/>) has completed.
16637	A @c null @a error object means success, otherwise it
16638	describes a failure.
16639
16640	<result name="VBOX_E_INVALID_VM_STATE">
16641	Session state prevents operation.
16642	</result>
16643	<result name="VBOX_E_INVALID_OBJECT_STATE">
16644	Session type prevents operation.
16645	</result>
16646
16647	</desc>
16648	<param name="id" type="uuid" mod="string" dir="in"/>
16649	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16650	</method>
16651
16652	<method name="onShowWindow">
16653	<desc>
16654	Called by <link to="IMachine::canShowConsoleWindow"/> and by
16655	<link to="IMachine::showConsoleWindow"/> in order to notify
16656	console listeners
16657	<link to="ICanShowWindowEvent"/>
16658	and <link to="IShowWindowEvent"/>.
16659
16660	<result name="VBOX_E_INVALID_OBJECT_STATE">
16661	Session type prevents operation.
16662	</result>
16663
16664	</desc>
16665	<param name="check" type="boolean" dir="in"/>
16666	<param name="canShow" type="boolean" dir="out"/>
16667	<param name="winId" type="long long" dir="out"/>
16668	</method>
16669
16670	<method name="onBandwidthGroupChange">
16671	<desc>
16672	Notification when one of the bandwidth groups change.
16673	</desc>
16674	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
16675	<desc>The bandwidth group which changed.</desc>
16676	</param>
16677	</method>
16678
16679	<method name="accessGuestProperty">
16680	<desc>
16681	Called by <link to="IMachine::getGuestProperty"/> and by
16682	<link to="IMachine::setGuestProperty"/> in order to read and
16683	modify guest properties.
16684
16685	<result name="VBOX_E_INVALID_VM_STATE">
16686	Machine session is not open.
16687	</result>
16688	<result name="VBOX_E_INVALID_OBJECT_STATE">
16689	Session type is not direct.
16690	</result>
16691
16692	</desc>
16693	<param name="name" type="wstring" dir="in"/>
16694	<param name="value" type="wstring" dir="in"/>
16695	<param name="flags" type="wstring" dir="in"/>
16696	<param name="isSetter" type="boolean" dir="in"/>
16697	<param name="retValue" type="wstring" dir="out"/>
16698	<param name="retTimestamp" type="long long" dir="out"/>
16699	<param name="retFlags" type="wstring" dir="out"/>
16700	</method>
16701
16702	<method name="enumerateGuestProperties" const="yes">
16703	<desc>
16704	Return a list of the guest properties matching a set of patterns along
16705	with their values, time stamps and flags.
16706
16707	<result name="VBOX_E_INVALID_VM_STATE">
16708	Machine session is not open.
16709	</result>
16710	<result name="VBOX_E_INVALID_OBJECT_STATE">
16711	Session type is not direct.
16712	</result>
16713
16714	</desc>
16715	<param name="patterns" type="wstring" dir="in">
16716	<desc>
16717	The patterns to match the properties against as a comma-separated
16718	string. If this is empty, all properties currently set will be
16719	returned.
16720	</desc>
16721	</param>
16722	<param name="key" type="wstring" dir="out" safearray="yes">
16723	<desc>
16724	The key names of the properties returned.
16725	</desc>
16726	</param>
16727	<param name="value" type="wstring" dir="out" safearray="yes">
16728	<desc>
16729	The values of the properties returned. The array entries match the
16730	corresponding entries in the @a key array.
16731	</desc>
16732	</param>
16733	<param name="timestamp" type="long long" dir="out" safearray="yes">
16734	<desc>
16735	The time stamps of the properties returned. The array entries match
16736	the corresponding entries in the @a key array.
16737	</desc>
16738	</param>
16739	<param name="flags" type="wstring" dir="out" safearray="yes">
16740	<desc>
16741	The flags of the properties returned. The array entries match the
16742	corresponding entries in the @a key array.
16743	</desc>
16744	</param>
16745	</method>
16746
16747	<method name="onlineMergeMedium">
16748	<desc>
16749	Triggers online merging of a hard disk. Used internally when deleting
16750	a snapshot while a VM referring to the same hard disk chain is running.
16751
16752	<result name="VBOX_E_INVALID_VM_STATE">
16753	Machine session is not open.
16754	</result>
16755	<result name="VBOX_E_INVALID_OBJECT_STATE">
16756	Session type is not direct.
16757	</result>
16758
16759	</desc>
16760	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16761	<desc>The medium attachment to identify the medium chain.</desc>
16762	</param>
16763	<param name="sourceIdx" type="unsigned long" dir="in">
16764	<desc>The index of the source image in the chain.
16765	Redundant, but drastically reduces IPC.</desc>
16766	</param>
16767	<param name="targetIdx" type="unsigned long" dir="in">
16768	<desc>The index of the target image in the chain.
16769	Redundant, but drastically reduces IPC.</desc>
16770	</param>
16771	<param name="source" type="IMedium" dir="in">
16772	<desc>Merge source medium.</desc>
16773	</param>
16774	<param name="target" type="IMedium" dir="in">
16775	<desc>Merge target medium.</desc>
16776	</param>
16777	<param name="mergeForward" type="boolean" dir="in">
16778	<desc>Merge direction.</desc>
16779	</param>
16780	<param name="parentForTarget" type="IMedium" dir="in">
16781	<desc>For forward merges: new parent for target medium.</desc>
16782	</param>
16783	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
16784	<desc>For backward merges: list of media which need their parent UUID
16785	updated.</desc>
16786	</param>
16787	<param name="progress" type="IProgress" dir="in">
16788	<desc>
16789	Progress object for this operation.
16790	</desc>
16791	</param>
16792	</method>
16793
16794	<method name="enableVMMStatistics">
16795	<desc>
16796	Enables or disables collection of VMM RAM statistics.
16797
16798	<result name="VBOX_E_INVALID_VM_STATE">
16799	Machine session is not open.
16800	</result>
16801	<result name="VBOX_E_INVALID_OBJECT_STATE">
16802	Session type is not direct.
16803	</result>
16804
16805	</desc>
16806	<param name="enable" type="boolean" dir="in">
16807	<desc>True enables statistics collection.</desc>
16808	</param>
16809	</method>
16810
16811	</interface>
16812
16813	<interface
16814	name="ISession" extends="$unknown"
16815	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
16816	wsmap="managed"
16817	>
16818	<desc>
16819	The ISession interface represents a client process and allows for locking
16820	virtual machines (represented by IMachine objects) to prevent conflicting
16821	changes to the machine.
16822
16823	Any caller wishing to manipulate a virtual machine needs to create a session
16824	object first, which lives in its own process space. Such session objects are
16825	then associated with <link to="IMachine" /> objects living in the VirtualBox
16826	server process to coordinate such changes.
16827
16828	There are two typical scenarios in which sessions are used:
16829
16830	<ul>
16831	<li>To alter machine settings or control a running virtual machine, one
16832	needs to lock a machine for a given session (client process) by calling
16833	<link to="IMachine::lockMachine"/>.
16834
16835	Whereas multiple sessions may control a running virtual machine, only
16836	one process can obtain a write lock on the machine to prevent conflicting
16837	changes. A write lock is also needed if a process wants to actually run a
16838	virtual machine in its own context, such as the VirtualBox GUI or
16839	VBoxHeadless front-ends. They must also lock a machine for their own
16840	sessions before they are allowed to power up the virtual machine.
16841
16842	As a result, no machine settings can be altered while another process is
16843	already using it, either because that process is modifying machine settings
16844	or because the machine is running.
16845	</li>
16846	<li>
16847	To start a VM using one of the existing VirtualBox front-ends (e.g. the
16848	VirtualBox GUI or VBoxHeadless), one would use
16849	<link to="IMachine::launchVMProcess"/>, which also takes a session object
16850	as its first parameter. This session then identifies the caller and lets the
16851	caller control the started machine (for example, pause machine execution or
16852	power it down) as well as be notified about machine execution state changes.
16853	</li>
16854	</ul>
16855
16856	How sessions objects are created in a client process depends on whether you use
16857	the Main API via COM or via the webservice:
16858
16859	<ul>
16860	<li>When using the COM API directly, an object of the Session class from the
16861	VirtualBox type library needs to be created. In regular COM C++ client code,
16862	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
16863	This object will then act as a local session object in further calls to open
16864	a session.
16865	</li>
16866
16867	<li>In the webservice, the session manager (IWebsessionManager) instead creates
16868	a session object automatically whenever <link to="IWebsessionManager::logon" />
16869	is called. A managed object reference to that session object can be retrieved by
16870	calling <link to="IWebsessionManager::getSessionObject" />.
16871	</li>
16872	</ul>
16873	</desc>
16874
16875	<attribute name="state" type="SessionState" readonly="yes">
16876	<desc>Current state of this session.</desc>
16877	</attribute>
16878
16879	<attribute name="type" type="SessionType" readonly="yes">
16880	<desc>
16881	Type of this session. The value of this attribute is valid only
16882	if the session currently has a machine locked (i.e. its
16883	<link to="#state" /> is Locked), otherwise an error will be returned.
16884	</desc>
16885	</attribute>
16886
16887	<attribute name="machine" type="IMachine" readonly="yes">
16888	<desc>Machine object associated with this session.</desc>
16889	</attribute>
16890
16891	<attribute name="console" type="IConsole" readonly="yes">
16892	<desc>Console object associated with this session.</desc>
16893	</attribute>
16894
16895	<method name="unlockMachine">
16896	<desc>
16897	Unlocks a machine that was previously locked for the current session.
16898
16899	Calling this method is required every time a machine has been locked
16900	for a particular session using the <link to="IMachine::launchVMProcess" />
16901	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
16902	the machine will be set to <link to="MachineState_Aborted" /> on the
16903	server, and changes made to the machine settings will be lost.
16904
16905	Generally, it is recommended to unlock all machines explicitly
16906	before terminating the application (regardless of the reason for
16907	the termination).
16908
16909	<note>
16910	Do not expect the session state (<link to="ISession::state" />
16911	to return to "Unlocked" immediately after you invoke this method,
16912	particularly if you have started a new VM process. The session
16913	state will automatically return to "Unlocked" once the VM is no
16914	longer executing, which can of course take a very long time.
16915	</note>
16916
16917	<result name="E_UNEXPECTED">
16918	Session is not locked.
16919	</result>
16920
16921	</desc>
16922	</method>
16923
16924	</interface>
16925
16926	<!--
16927	// IStorageController
16928	/////////////////////////////////////////////////////////////////////////
16929	-->
16930
16931	<enum
16932	name="StorageBus"
16933	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
16934	>
16935	<desc>
16936	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
16937	see <link to="IStorageController::bus" />.
16938	</desc>
16939	<const name="Null" value="0">
16940	<desc>@c null value. Never used by the API.</desc>
16941	</const>
16942	<const name="IDE" value="1"/>
16943	<const name="SATA" value="2"/>
16944	<const name="SCSI" value="3"/>
16945	<const name="Floppy" value="4"/>
16946	<const name="SAS" value="5"/>
16947	</enum>
16948
16949	<enum
16950	name="StorageControllerType"
16951	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
16952	>
16953	<desc>
16954	The exact variant of storage controller hardware presented
16955	to the guest; see <link to="IStorageController::controllerType" />.
16956	</desc>
16957
16958	<const name="Null" value="0">
16959	<desc>@c null value. Never used by the API.</desc>
16960	</const>
16961	<const name="LsiLogic" value="1">
16962	<desc>A SCSI controller of the LsiLogic variant.</desc>
16963	</const>
16964	<const name="BusLogic" value="2">
16965	<desc>A SCSI controller of the BusLogic variant.</desc>
16966	</const>
16967	<const name="IntelAhci" value="3">
16968	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
16969	</const>
16970	<const name="PIIX3" value="4">
16971	<desc>An IDE controller of the PIIX3 variant.</desc>
16972	</const>
16973	<const name="PIIX4" value="5">
16974	<desc>An IDE controller of the PIIX4 variant.</desc>
16975	</const>
16976	<const name="ICH6" value="6">
16977	<desc>An IDE controller of the ICH6 variant.</desc>
16978	</const>
16979	<const name="I82078" value="7">
16980	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
16981	</const>
16982	<const name="LsiLogicSas" value="8">
16983	<desc>A variant of the LsiLogic controller using SAS.</desc>
16984	</const>
16985	</enum>
16986
16987	<enum
16988	name="ChipsetType"
16989	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
16990	>
16991	<desc>
16992	Type of emulated chipset (mostly southbridge).
16993	</desc>
16994
16995	<const name="Null" value="0">
16996	<desc>@c null value. Never used by the API.</desc>
16997	</const>
16998	<const name="PIIX3" value="1">
16999	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17000	</const>
17001	<const name="ICH9" value="2">
17002	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17003	</const>
17004	</enum>
17005
17006	<interface
17007	name="IStorageController" extends="$unknown"
17008	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17009	wsmap="managed"
17010	>
17011	<desc>
17012	Represents a storage controller that is attached to a virtual machine
17013	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17014	attached to storage controllers in a real computer, virtual drives
17015	(represented by <link to="IMediumAttachment" />) are attached to virtual
17016	storage controllers, represented by this interface.
17017
17018	As opposed to physical hardware, VirtualBox has a very generic concept
17019	of a storage controller, and for purposes of the Main API, all virtual
17020	storage is attached to virtual machines via instances of this interface.
17021	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17022	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17023	is used, certain sub-types may be available and can be selected in
17024	<link to="#controllerType" />.
17025
17026	Depending on these settings, the guest operating system might see
17027	significantly different virtual hardware.
17028	</desc>
17029
17030	<attribute name="name" type="wstring" readonly="yes">
17031	<desc>
17032	Name of the storage controller, as originally specified with
17033	<link to="IMachine::addStorageController" />. This then uniquely
17034	identifies this controller with other method calls such as
17035	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17036	</desc>
17037	</attribute>
17038
17039	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17040	<desc>
17041	Maximum number of devices which can be attached to one port.
17042	</desc>
17043	</attribute>
17044
17045	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17046	<desc>
17047	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17048	</desc>
17049	</attribute>
17050
17051	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17052	<desc>
17053	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17054	</desc>
17055	</attribute>
17056
17057	<attribute name="instance" type="unsigned long">
17058	<desc>
17059	The instance number of the device in the running VM.
17060	</desc>
17061	</attribute>
17062
17063	<attribute name="portCount" type="unsigned long">
17064	<desc>
17065	The number of currently usable ports on the controller.
17066	The minimum and maximum number of ports for one controller are
17067	stored in <link to="IStorageController::minPortCount"/>
17068	and <link to="IStorageController::maxPortCount"/>.
17069	</desc>
17070	</attribute>
17071
17072	<attribute name="bus" type="StorageBus" readonly="yes">
17073	<desc>
17074	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17075	</desc>
17076	</attribute>
17077
17078	<attribute name="controllerType" type="StorageControllerType">
17079	<desc>
17080	The exact variant of storage controller hardware presented
17081	to the guest.
17082	Depending on this value, VirtualBox will provide a different
17083	virtual storage controller hardware to the guest.
17084	For SATA, SAS and floppy controllers, only one variant is
17085	available, but for IDE and SCSI, there are several.
17086
17087	For SCSI controllers, the default type is LsiLogic.
17088	</desc>
17089	</attribute>
17090
17091	<attribute name="useHostIOCache" type="boolean">
17092	<desc>
17093	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17094	caches and use synchronous file APIs on the host. This was the only option in the API before
17095	VirtualBox 3.2 and is still the default for IDE controllers.
17096
17097	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17098	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17099	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17100	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17101	virtual machines are running at the same time to prevent I/O cache related hangs.
17102	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17103	</desc>
17104	</attribute>
17105
17106	<attribute name="bootable" type="boolean" readonly="yes">
17107	<desc>
17108	Returns whether it is possible to boot from disks attached to this controller.
17109	</desc>
17110	</attribute>
17111	</interface>
17112
17113	<if target="wsdl">
17114
17115	<!--
17116	// IManagedObjectRef
17117	/////////////////////////////////////////////////////////////////////////
17118	-->
17119
17120	<interface
17121	name="IManagedObjectRef" extends="$unknown"
17122	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17123	internal="yes"
17124	wsmap="managed"
17125	wscpp="hardcoded"
17126	>
17127	<desc>
17128	Managed object reference.
17129
17130	Only within the webservice, a managed object reference (which is really
17131	an opaque number) allows a webservice client to address an object
17132	that lives in the address space of the webservice server.
17133
17134	Behind each managed object reference, there is a COM object that lives
17135	in the webservice server's address space. The COM object is not freed
17136	until the managed object reference is released, either by an explicit
17137	call to <link to="IManagedObjectRef::release" /> or by logging off from
17138	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17139	all objects created during the webservice session.
17140
17141	Whenever a method call of the VirtualBox API returns a COM object, the
17142	webservice representation of that method will instead return a
17143	managed object reference, which can then be used to invoke methods
17144	on that object.
17145	</desc>
17146
17147	<method name="getInterfaceName">
17148	<desc>
17149	Returns the name of the interface that this managed object represents,
17150	for example, "IMachine", as a string.
17151	</desc>
17152	<param name="return" type="wstring" dir="return"/>
17153	</method>
17154
17155	<method name="release">
17156	<desc>
17157	Releases this managed object reference and frees the resources that
17158	were allocated for it in the webservice server process. After calling
17159	this method, the identifier of the reference can no longer be used.
17160	</desc>
17161	</method>
17162
17163	</interface>
17164
17165	<!--
17166	// IWebsessionManager
17167	/////////////////////////////////////////////////////////////////////////
17168	-->
17169
17170	<interface
17171	name="IWebsessionManager" extends="$unknown"
17172	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17173	internal="yes"
17174	wsmap="global"
17175	wscpp="hardcoded"
17176	>
17177	<desc>
17178	Websession manager. This provides essential services
17179	to webservice clients.
17180	</desc>
17181	<method name="logon">
17182	<desc>
17183	Logs a new client onto the webservice and returns a managed object reference to
17184	the IVirtualBox instance, which the client can then use as a basis to further
17185	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17186	interface, in one way or the other.
17187	</desc>
17188	<param name="username" type="wstring" dir="in"/>
17189	<param name="password" type="wstring" dir="in"/>
17190	<param name="return" type="IVirtualBox" dir="return"/>
17191	</method>
17192
17193	<method name="getSessionObject">
17194	<desc>
17195	Returns a managed object reference to the internal ISession object that was created
17196	for this web service session when the client logged on.
17197
17198	<see><link to="ISession"/></see>
17199	</desc>
17200	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17201	<param name="return" type="ISession" dir="return"/>
17202	</method>
17203
17204	<method name="logoff">
17205	<desc>
17206	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17207	and destroys all resources associated with the session (most importantly, all
17208	managed objects created in the server while the session was active).
17209	</desc>
17210	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17211	</method>
17212
17213	</interface>
17214
17215	</if>
17216
17217	<!--
17218	// IPerformanceCollector & friends
17219	/////////////////////////////////////////////////////////////////////////
17220	-->
17221
17222	<interface
17223	name="IPerformanceMetric" extends="$unknown"
17224	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17225	>
17226	<desc>
17227	The IPerformanceMetric interface represents parameters of the given
17228	performance metric.
17229	</desc>
17230
17231	<attribute name="metricName" type="wstring" readonly="yes">
17232	<desc>
17233	Name of the metric.
17234	</desc>
17235	</attribute>
17236
17237	<attribute name="object" type="$unknown" readonly="yes">
17238	<desc>
17239	Object this metric belongs to.
17240	</desc>
17241	</attribute>
17242
17243	<attribute name="description" type="wstring" readonly="yes">
17244	<desc>
17245	Textual description of the metric.
17246	</desc>
17247	</attribute>
17248
17249	<attribute name="period" type="unsigned long" readonly="yes">
17250	<desc>
17251	Time interval between samples, measured in seconds.
17252	</desc>
17253	</attribute>
17254
17255	<attribute name="count" type="unsigned long" readonly="yes">
17256	<desc>
17257	Number of recent samples retained by the performance collector for this
17258	metric.
17259
17260	When the collected sample count exceeds this number, older samples
17261	are discarded.
17262	</desc>
17263	</attribute>
17264
17265	<attribute name="unit" type="wstring" readonly="yes">
17266	<desc>
17267	Unit of measurement.
17268	</desc>
17269	</attribute>
17270
17271	<attribute name="minimumValue" type="long" readonly="yes">
17272	<desc>
17273	Minimum possible value of this metric.
17274	</desc>
17275	</attribute>
17276
17277	<attribute name="maximumValue" type="long" readonly="yes">
17278	<desc>
17279	Maximum possible value of this metric.
17280	</desc>
17281	</attribute>
17282	</interface>
17283
17284	<interface
17285	name="IPerformanceCollector" extends="$unknown"
17286	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17287	wsmap="managed"
17288	>
17289	<desc>
17290	The IPerformanceCollector interface represents a service that collects
17291	and stores performance metrics data.
17292
17293	Performance metrics are associated with objects of interfaces like IHost
17294	and IMachine. Each object has a distinct set of performance metrics. The
17295	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17296
17297	Metric data is collected at the specified intervals and is retained
17298	internally. The interval and the number of retained samples can be set
17299	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17300	and collection settings are not persistent, they are discarded as soon as
17301	VBoxSVC process terminates. Moreover, metric settings and data associated
17302	with a particular VM only exist while VM is running. They disappear as
17303	soon as VM shuts down. It is not possible to set up metrics for machines
17304	that are powered off. One needs to start VM first, then set up metric
17305	collection parameters.
17306
17307	Metrics are organized hierarchically, with each level separated by a
17308	slash (/) character. Generally, the scheme for metric names is like this:
17309
17310	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17311
17312	"Category/Metric" together form the base metric name. A base metric is
17313	the smallest unit for which a sampling interval and the number of
17314	retained samples can be set. Only base metrics can be enabled and
17315	disabled. All sub-metrics are collected when their base metric is
17316	collected. Collected values for any set of sub-metrics can be queried
17317	with <link to="IPerformanceCollector::queryMetricsData" />.
17318
17319	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17320	category, "Load" metric, "User" submetric, "average" aggregate. An
17321	aggregate function is computed over all retained data. Valid aggregate
17322	functions are:
17323
17324	<ul>
17325	<li>avg -- average</li>
17326	<li>min -- minimum</li>
17327	<li>max -- maximum</li>
17328	</ul>
17329
17330	When setting up metric parameters, querying metric data, enabling or
17331	disabling metrics wildcards can be used in metric names to specify a
17332	subset of metrics. For example, to select all CPU-related metrics
17333	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17334	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17335
17336	The valid names for base metrics are:
17337
17338	<ul>
17339	<li>CPU/Load</li>
17340	<li>CPU/MHz</li>
17341	<li>RAM/Usage</li>
17342	<li>RAM/VMM</li>
17343	</ul>
17344
17345	The general sequence for collecting and retrieving the metrics is:
17346	<ul>
17347	<li>
17348	Obtain an instance of IPerformanceCollector with
17349	<link to="IVirtualBox::performanceCollector" />
17350	</li>
17351	<li>
17352	Allocate and populate an array with references to objects the metrics
17353	will be collected for. Use references to IHost and IMachine objects.
17354	</li>
17355	<li>
17356	Allocate and populate an array with base metric names the data will
17357	be collected for.
17358	</li>
17359	<li>
17360	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17361	the metric data will be collected and stored.
17362	</li>
17363	<li>
17364	Wait for the data to get collected.
17365	</li>
17366	<li>
17367	Allocate and populate an array with references to objects the metric
17368	values will be queried for. You can re-use the object array used for
17369	setting base metrics.
17370	</li>
17371	<li>
17372	Allocate and populate an array with metric names the data will be
17373	collected for. Note that metric names differ from base metric names.
17374	</li>
17375	<li>
17376	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17377	that have been collected so far are returned. Note that the values
17378	are still retained internally and data collection continues.
17379	</li>
17380	</ul>
17381
17382	For an example of usage refer to the following files in VirtualBox SDK:
17383	<ul>
17384	<li>
17385	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17386	</li>
17387	<li>
17388	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17389	</li>
17390	</ul>
17391	</desc>
17392
17393	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17394	<desc>
17395	Array of unique names of metrics.
17396
17397	This array represents all metrics supported by the performance
17398	collector. Individual objects do not necessarily support all of them.
17399	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17400	list of supported metrics for a particular object.
17401	</desc>
17402	</attribute>
17403
17404	<method name="getMetrics">
17405	<desc>
17406	Returns parameters of specified metrics for a set of objects.
17407	<note>
17408	@c Null metrics array means all metrics. @c Null object array means
17409	all existing objects.
17410	</note>
17411	</desc>
17412	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17413	<desc>
17414	Metric name filter. Currently, only a comma-separated list of metrics
17415	is supported.
17416	</desc>
17417	</param>
17418	<param name="objects" type="$unknown" dir="in" safearray="yes">
17419	<desc>
17420	Set of objects to return metric parameters for.
17421	</desc>
17422	</param>
17423	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17424	<desc>
17425	Array of returned metric parameters.
17426	</desc>
17427	</param>
17428	</method>
17429
17430	<method name="setupMetrics">
17431	<desc>
17432	Sets parameters of specified base metrics for a set of objects. Returns
17433	an array of <link to="IPerformanceMetric" /> describing the metrics
17434	have been affected.
17435	<note>
17436	@c Null or empty metric name array means all metrics. @c Null or
17437	empty object array means all existing objects. If metric name array
17438	contains a single element and object array contains many, the single
17439	metric name array element is applied to each object array element to
17440	form metric/object pairs.
17441	</note>
17442	</desc>
17443	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17444	<desc>
17445	Metric name filter. Comma-separated list of metrics with wildcard
17446	support.
17447	</desc>
17448	</param>
17449	<param name="objects" type="$unknown" dir="in" safearray="yes">
17450	<desc>
17451	Set of objects to setup metric parameters for.
17452	</desc>
17453	</param>
17454	<param name="period" type="unsigned long" dir="in">
17455	<desc>
17456	Time interval in seconds between two consecutive samples of
17457	performance data.
17458	</desc>
17459	</param>
17460	<param name="count" type="unsigned long" dir="in">
17461	<desc>
17462	Number of samples to retain in performance data history. Older
17463	samples get discarded.
17464	</desc>
17465	</param>
17466	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17467	<desc>
17468	Array of metrics that have been modified by the call to this method.
17469	</desc>
17470	</param>
17471	</method>
17472
17473	<method name="enableMetrics">
17474	<desc>
17475	Turns on collecting specified base metrics. Returns an array of
17476	<link to="IPerformanceMetric" /> describing the metrics have been
17477	affected.
17478	<note>
17479	@c Null or empty metric name array means all metrics. @c Null or
17480	empty object array means all existing objects. If metric name array
17481	contains a single element and object array contains many, the single
17482	metric name array element is applied to each object array element to
17483	form metric/object pairs.
17484	</note>
17485	</desc>
17486	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17487	<desc>
17488	Metric name filter. Comma-separated list of metrics with wildcard
17489	support.
17490	</desc>
17491	</param>
17492	<param name="objects" type="$unknown" dir="in" safearray="yes">
17493	<desc>
17494	Set of objects to enable metrics for.
17495	</desc>
17496	</param>
17497	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17498	<desc>
17499	Array of metrics that have been modified by the call to this method.
17500	</desc>
17501	</param>
17502	</method>
17503
17504	<method name="disableMetrics">
17505	<desc>
17506	Turns off collecting specified base metrics. Returns an array of
17507	<link to="IPerformanceMetric" /> describing the metrics have been
17508	affected.
17509	<note>
17510	@c Null or empty metric name array means all metrics. @c Null or
17511	empty object array means all existing objects. If metric name array
17512	contains a single element and object array contains many, the single
17513	metric name array element is applied to each object array element to
17514	form metric/object pairs.
17515	</note>
17516	</desc>
17517	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17518	<desc>
17519	Metric name filter. Comma-separated list of metrics with wildcard
17520	support.
17521	</desc>
17522	</param>
17523	<param name="objects" type="$unknown" dir="in" safearray="yes">
17524	<desc>
17525	Set of objects to disable metrics for.
17526	</desc>
17527	</param>
17528	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17529	<desc>
17530	Array of metrics that have been modified by the call to this method.
17531	</desc>
17532	</param>
17533	</method>
17534
17535	<method name="queryMetricsData">
17536	<desc>
17537	Queries collected metrics data for a set of objects.
17538
17539	The data itself and related metric information are returned in seven
17540	parallel and one flattened array of arrays. Elements of
17541	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17542	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17543	the same index describe one set of values corresponding to a single
17544	metric.
17545
17546	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17547	start and length of a sub-array is indicated by
17548	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17549	value for metric <tt>metricNames[i]</tt> is at
17550	<tt>returnData[returnIndices[i]]</tt>.
17551
17552	<note>
17553	@c Null or empty metric name array means all metrics. @c Null or
17554	empty object array means all existing objects. If metric name array
17555	contains a single element and object array contains many, the single
17556	metric name array element is applied to each object array element to
17557	form metric/object pairs.
17558	</note>
17559	<note>
17560	Data collection continues behind the scenes after call to @c
17561	queryMetricsData. The return data can be seen as the snapshot of the
17562	current state at the time of @c queryMetricsData call. The internally
17563	kept metric values are not cleared by the call. This makes possible
17564	querying different subsets of metrics or aggregates with subsequent
17565	calls. If periodic querying is needed it is highly suggested to query
17566	the values with @c interval*count period to avoid confusion. This way
17567	a completely new set of data values will be provided by each query.
17568	</note>
17569	</desc>
17570	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17571	<desc>
17572	Metric name filter. Comma-separated list of metrics with wildcard
17573	support.
17574	</desc>
17575	</param>
17576	<param name="objects" type="$unknown" dir="in" safearray="yes">
17577	<desc>
17578	Set of objects to query metrics for.
17579	</desc>
17580	</param>
17581	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
17582	<desc>
17583	Names of metrics returned in @c returnData.
17584	</desc>
17585	</param>
17586	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
17587	<desc>
17588	Objects associated with metrics returned in @c returnData.
17589	</desc>
17590	</param>
17591	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
17592	<desc>
17593	Units of measurement for each returned metric.
17594	</desc>
17595	</param>
17596	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
17597	<desc>
17598	Divisor that should be applied to return values in order to get
17599	floating point values. For example:
17600	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
17601	will retrieve the floating point value of i-th sample of the first
17602	metric.
17603	</desc>
17604	</param>
17605	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
17606	<desc>
17607	Sequence numbers of the first elements of value sequences of
17608	particular metrics returned in @c returnData. For aggregate metrics
17609	it is the sequence number of the sample the aggregate started
17610	calculation from.
17611	</desc>
17612	</param>
17613	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
17614	<desc>
17615	Indices of the first elements of value sequences of particular
17616	metrics returned in @c returnData.
17617	</desc>
17618	</param>
17619	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
17620	<desc>
17621	Lengths of value sequences of particular metrics.
17622	</desc>
17623	</param>
17624	<param name="returnData" type="long" dir="return" safearray="yes">
17625	<desc>
17626	Flattened array of all metric data containing sequences of values for
17627	each metric.
17628	</desc>
17629	</param>
17630	</method>
17631
17632	</interface>
17633
17634	<enum
17635	name="NATAliasMode"
17636	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
17637	>
17638	<desc></desc>
17639	<const name="AliasLog" value="0x1">
17640	<desc></desc>
17641	</const>
17642	<const name="AliasProxyOnly" value="0x02">
17643	<desc></desc>
17644	</const>
17645	<const name="AliasUseSamePorts" value="0x04">
17646	<desc></desc>
17647	</const>
17648	</enum>
17649
17650	<enum
17651	name="NATProtocol"
17652	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
17653	>
17654	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
17655	<const name="UDP" value="0">
17656	<desc>Port-forwarding uses UDP protocol.</desc>
17657	</const>
17658	<const name="TCP" value="1">
17659	<desc>Port-forwarding uses TCP protocol.</desc>
17660	</const>
17661	</enum>
17662
17663	<interface
17664	name="INATEngine" extends="$unknown"
17665	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
17666	wsmap="managed"
17667	>
17668	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
17669	allows for changing NAT behavior such as port-forwarding rules. This interface is
17670	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
17671	<attribute name="network" type="wstring">
17672	<desc>The network attribute of the NAT engine (the same value is used with built-in
17673	DHCP server to fill corresponding fields of DHCP leases).</desc>
17674	</attribute>
17675	<attribute name="hostIP" type="wstring">
17676	<desc>IP of host interface to bind all opened sockets to.
17677	<note>Changing this does not change binding of port forwarding.</note>
17678	</desc>
17679	</attribute>
17680	<attribute name="TFTPPrefix" type="wstring">
17681	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
17682	the corresponding fields of DHCP leases.</desc>
17683	</attribute>
17684	<attribute name="TFTPBootFile" type="wstring">
17685	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
17686	the corresponding fields of DHCP leases.</desc>
17687	</attribute>
17688	<attribute name="TFTPNextServer" type="wstring">
17689	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
17690	the corresponding fields of DHCP leases.
17691	<note>The preferred form is IPv4 addresses.</note>
17692	</desc>
17693	</attribute>
17694	<attribute name="aliasMode" type="unsigned long">
17695	<desc></desc>
17696	</attribute>
17697	<attribute name="DNSPassDomain" type="boolean">
17698	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
17699	</attribute>
17700	<attribute name="DNSProxy" type="boolean">
17701	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17702	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
17703	</attribute>
17704	<attribute name="DNSUseHostResolver" type="boolean">
17705	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17706	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
17707	</attribute>
17708	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
17709	<desc>Array of NAT port-forwarding rules in string representation, in the following
17710	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
17711	</attribute>
17712	<method name="setNetworkSettings">
17713	<desc>Sets network configuration of the NAT engine.</desc>
17714	<param name="mtu" type="unsigned long" dir="in">
17715	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
17716	</param>
17717	<param name="sockSnd" type="unsigned long" dir="in">
17718	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
17719	</param>
17720	<param name="sockRcv" type="unsigned long" dir="in">
17721	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
17722	</param>
17723	<param name="TcpWndSnd" type="unsigned long" dir="in">
17724	<desc>Initial size of the NAT engine's sending TCP window in bytes when
17725	establishing a new TCP connection.</desc>
17726	</param>
17727	<param name="TcpWndRcv" type="unsigned long" dir="in">
17728	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
17729	establishing a new TCP connection.</desc>
17730	</param>
17731	</method>
17732	<method name="getNetworkSettings">
17733	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
17734	for parameter descriptions.</desc>
17735	<param name="mtu" type="unsigned long" dir="out" />
17736	<param name="sockSnd" type="unsigned long" dir="out" />
17737	<param name="sockRcv" type="unsigned long" dir="out" />
17738	<param name="TcpWndSnd" type="unsigned long" dir="out" />
17739	<param name="TcpWndRcv" type="unsigned long" dir="out" />
17740	</method>
17741	<method name="addRedirect">
17742	<desc>Adds a new NAT port-forwarding rule.</desc>
17743	<param name="name" type="wstring" dir="in">
17744	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
17745	auto-generates one using the other parameters.</desc>
17746	</param>
17747	<param name="proto" type="NATProtocol" dir="in">
17748	<desc>Protocol handled with the rule.</desc>
17749	</param>
17750	<param name="hostIP" type="wstring" dir="in">
17751	<desc>IP of the host interface to which the rule should apply. An empty ip address is
17752	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
17753	</param>
17754	<param name="hostPort" type="unsigned short" dir="in">
17755	<desc>The port number to listen on.</desc>
17756	</param>
17757	<param name="guestIP" type="wstring" dir="in">
17758	<desc>The IP address of the guest which the NAT engine will forward matching packets
17759	to. An empty IP address is acceptable, in which case the NAT engine will forward
17760	packets to the first DHCP lease (x.x.x.15).</desc>
17761	</param>
17762	<param name="guestPort" type="unsigned short" dir="in">
17763	<desc>The port number to forward.</desc>
17764	</param>
17765	</method>
17766	<method name="removeRedirect">
17767	<desc>Removes a port-forwarding rule that was previously registered.</desc>
17768	<param name="name" type="wstring" dir="in">
17769	<desc>The name of the rule to delete.</desc>
17770	</param>
17771	</method>
17772	</interface>
17773
17774	<!--
17775	// IExtPackManager
17776	/////////////////////////////////////////////////////////////////////////
17777	-->
17778
17779	<interface
17780	name="IExtPackPlugIn" extends="$unknown"
17781	uuid="58000040-e718-4746-bbce-4b86d96da461"
17782	wsmap="suppress"
17783	>
17784	<desc>
17785	Interface for keeping information about a plug-in that ships with an
17786	extension pack.
17787	</desc>
17788	<attribute name="name" type="wstring" readonly="yes">
17789	<desc>The plug-in name.</desc>
17790	</attribute>
17791	<attribute name="description" type="wstring" readonly="yes">
17792	<desc>The plug-in description.</desc>
17793	</attribute>
17794	<attribute name="frontend" type="wstring" readonly="yes">
17795	<desc>
17796	The name of the frontend or component name this plug-in plugs into.
17797	</desc>
17798	</attribute>
17799	<attribute name="modulePath" type="wstring" readonly="yes">
17800	<desc> The module path. </desc>
17801	</attribute>
17802	</interface>
17803
17804	<interface
17805	name="IExtPackBase" extends="$unknown"
17806	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
17807	wsmap="suppress"
17808	>
17809	<desc>
17810	Interface for querying information about an extension pack as well as
17811	accessing COM objects within it.
17812	</desc>
17813	<attribute name="name" type="wstring" readonly="yes">
17814	<desc>The extension pack name. This is unique.</desc>
17815	</attribute>
17816	<attribute name="description" type="wstring" readonly="yes">
17817	<desc>The extension pack description.</desc>
17818	</attribute>
17819	<attribute name="version" type="wstring" readonly="yes">
17820	<desc>
17821	The extension pack version string. This is restricted to the dotted
17822	version number and optionally a build indicator. No tree revision or
17823	tag will be included in the string as those things are available as
17824	separate properties. An optional publisher tag may be present like for
17825	<link to="IVirtualBox::version"/>.
17826
17827	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
17828	</desc>
17829	</attribute>
17830	<attribute name="revision" type="unsigned long" readonly="yes">
17831	<desc>The extension pack internal revision number.</desc>
17832	</attribute>
17833	<attribute name="edition" type="wstring" readonly="yes">
17834	<desc>
17835	Edition indicator. This is usually empty.
17836
17837	Can for instance be used to help distinguishing between two editions
17838	of the same extension pack where only the license, service contract or
17839	something differs.
17840	</desc>
17841	</attribute>
17842	<attribute name="VRDEModule" type="wstring" readonly="yes">
17843	<desc>The name of the VRDE module if the extension pack sports one.</desc>
17844	</attribute>
17845	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
17846	<desc>Plug-ins provided by this extension pack.</desc>
17847	</attribute>
17848	<attribute name="usable" type="boolean" readonly="yes">
17849	<desc>
17850	Indicates whether the extension pack is usable or not.
17851
17852	There are a number of reasons why an extension pack might be unusable,
17853	typical examples would be broken installation/file or that it is
17854	incompatible with the current VirtualBox version.
17855	</desc>
17856	</attribute>
17857	<attribute name="whyUnusable" type="wstring" readonly="yes">
17858	<desc>
17859	String indicating why the extension pack is not usable. This is an
17860	empty string if usable and always a non-empty string if not usable.
17861	</desc>
17862	</attribute>
17863	<attribute name="showLicense" type="boolean" readonly="yes">
17864	<desc>Whether to show the license before installation</desc>
17865	</attribute>
17866	<attribute name="license" type="wstring" readonly="yes">
17867	<desc>
17868	The default HTML license text for the extension pack. Same as
17869	calling <link to="#queryLicense">queryLicense</link> with
17870	preferredLocale and preferredLanguage as empty strings and format set
17871	to html.
17872	</desc>
17873	</attribute>
17874
17875	<method name="queryLicense">
17876	<desc>
17877	Full feature version of the license attribute.
17878	</desc>
17879	<param name="preferredLocale" type="wstring" dir="in">
17880	<desc>
17881	The preferred license locale. Pass an empty string to get the default
17882	license.
17883	</desc>
17884	</param>
17885	<param name="preferredLanguage" type="wstring" dir="in">
17886	<desc>
17887	The preferred license language. Pass an empty string to get the
17888	default language for the locale.
17889	</desc>
17890	</param>
17891	<param name="format" type="wstring" dir="in">
17892	<desc>
17893	The license format: html, rtf or txt. If a license is present there
17894	will always be an HTML of it, the rich text format (RTF) and plain
17895	text (txt) versions are optional. If
17896	</desc>
17897	</param>
17898	<param name="licenseText" type="wstring" dir="return">
17899	<desc>The license text.</desc>
17900	</param>
17901	</method>
17902
17903	</interface>
17904
17905	<interface
17906	name="IExtPack" extends="IExtPackBase"
17907	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
17908	wsmap="suppress"
17909	>
17910	<desc>
17911	Interface for querying information about an extension pack as well as
17912	accessing COM objects within it.
17913	</desc>
17914	<method name="queryObject">
17915	<desc>
17916	Queries the IUnknown interface to an object in the extension pack
17917	main module. This allows plug-ins and others to talk directly to an
17918	extension pack.
17919	</desc>
17920	<param name="objUuid" type="wstring" dir="in">
17921	<desc>The object ID. What exactly this is </desc>
17922	</param>
17923	<param name="returnInterface" type="$unknown" dir="return">
17924	<desc>The queried interface.</desc>
17925	</param>
17926	</method>
17927	</interface>
17928
17929	<interface
17930	name="IExtPackFile" extends="IExtPackBase"
17931	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
17932	wsmap="suppress"
17933	>
17934	<desc>
17935	Extension pack file (aka tarball, .vbox-extpack) representation returned
17936	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
17937	extension pack information with the addition of the file name.
17938	</desc>
17939	<attribute name="filePath" type="wstring" readonly="yes">
17940	<desc>
17941	The path to the extension pack file.
17942	</desc>
17943	</attribute>
17944
17945	<method name="install">
17946	<desc>
17947	Install the extension pack.
17948	</desc>
17949	<param name="replace" type="boolean" dir="in">
17950	<desc>
17951	Set this to automatically uninstall any existing extension pack with
17952	the same name as the one being installed.
17953	</desc>
17954	</param>
17955	<param name="displayInfo" type="wstring" dir="in">
17956	<desc>
17957	Platform specific display information. Reserved for future hacks.
17958	</desc>
17959	</param>
17960	<param name="progess" type="IProgress" dir="return">
17961	<desc>
17962	Progress object for the operation.
17963	</desc>
17964	</param>
17965	</method>
17966	</interface>
17967
17968	<interface
17969	name="IExtPackManager" extends="$unknown"
17970	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
17971	wsmap="suppress"
17972	>
17973	<desc>
17974	Interface for managing VirtualBox Extension Packs.
17975
17976	TODO: Describe extension packs, how they are managed and how to create
17977	one.
17978	</desc>
17979
17980	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
17981	<desc>
17982	List of the installed extension packs.
17983	</desc>
17984	</attribute>
17985
17986	<method name="find">
17987	<desc>
17988	Returns the extension pack with the specified name if found.
17989
17990	<result name="VBOX_E_OBJECT_NOT_FOUND">
17991	No extension pack matching @a name was found.
17992	</result>
17993	</desc>
17994	<param name="name" type="wstring" dir="in">
17995	<desc>The name of the extension pack to locate.</desc>
17996	</param>
17997	<param name="returnData" type="IExtPack" dir="return">
17998	<desc>The extension pack if found.</desc>
17999	</param>
18000	</method>
18001
18002	<method name="openExtPackFile">
18003	<desc>
18004	Attempts to open an extension pack file in preparation for
18005	installation.
18006	</desc>
18007	<param name="path" type="wstring" dir="in">
18008	<desc>The path of the extension pack tarball. This can optionally be
18009	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18010	</param>
18011	<param name="file" type="IExtPackFile" dir="return">
18012	<desc>The interface of the extension pack file object.</desc>
18013	</param>
18014	</method>
18015
18016	<method name="uninstall">
18017	<desc>Uninstalls an extension pack, removing all related files.</desc>
18018	<param name="name" type="wstring" dir="in">
18019	<desc>The name of the extension pack to uninstall.</desc>
18020	</param>
18021	<param name="forcedRemoval" type="boolean" dir="in">
18022	<desc>
18023	Forced removal of the extension pack. This means that the uninstall
18024	hook will not be called.
18025	</desc>
18026	</param>
18027	<param name="displayInfo" type="wstring" dir="in">
18028	<desc>
18029	Platform specific display information. Reserved for future hacks.
18030	</desc>
18031	</param>
18032	<param name="progess" type="IProgress" dir="return">
18033	<desc>
18034	Progress object for the operation.
18035	</desc>
18036	</param>
18037	</method>
18038
18039	<method name="cleanup">
18040	<desc>Cleans up failed installs and uninstalls</desc>
18041	</method>
18042
18043	<method name="queryAllPlugInsForFrontend">
18044	<desc>
18045	Gets the path to all the plug-in modules for a given frontend.
18046
18047	This is a convenience method that is intended to simplify the plug-in
18048	loading process for a frontend.
18049	</desc>
18050	<param name="frontendName" type="wstring" dir="in">
18051	<desc>The name of the frontend or component.</desc>
18052	</param>
18053	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18054	<desc>Array containing the plug-in modules (full paths).</desc>
18055	</param>
18056	</method>
18057
18058	<method name="isExtPackUsable">
18059	<desc>Check if the given extension pack is loaded and usable.</desc>
18060	<param name="name" type="wstring" dir="in">
18061	<desc>The name of the extension pack to check for.</desc>
18062	</param>
18063	<param name="usable" type="boolean" dir="return">
18064	<desc>Is the given extension pack loaded and usable.</desc>
18065	</param>
18066	</method>
18067
18068	</interface>
18069
18070	<!--
18071	// BandwidthGroupType
18072	/////////////////////////////////////////////////////////////////////////
18073	-->
18074	<enum
18075	name="BandwidthGroupType"
18076	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18077
18078	<desc>
18079	Type of a bandwidth control group.
18080	</desc>
18081
18082	<const name="Null" value="0">
18083	<desc>
18084	Null type, must be first.
18085	</desc>
18086	</const>
18087
18088	<const name="Disk" value="1">
18089	<desc>
18090	The bandwidth group controls disk I/O.
18091	</desc>
18092	</const>
18093
18094	<const name="Network" value="2">
18095	<desc>
18096	The bandwidth group controls network I/O.
18097	</desc>
18098	</const>
18099
18100	</enum>
18101
18102	<!--
18103	// IBandwidthGroup
18104	/////////////////////////////////////////////////////////////////////////
18105	-->
18106	<interface
18107	name="IBandwidthGroup" extends="$unknown"
18108	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18109	wsmap="managed"
18110	>
18111	<desc>Represents one bandwidth group.</desc>
18112
18113	<attribute name="name" type="wstring" readonly="yes">
18114	<desc>Name of the group.</desc>
18115	</attribute>
18116
18117	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18118	<desc>Type of the group.</desc>
18119	</attribute>
18120
18121	<attribute name="reference" type="unsigned long" readonly="yes">
18122	<desc>How many devices/medium attachements use this group.</desc>
18123	</attribute>
18124
18125	<attribute name="maxBytesPerSec" type="long long">
18126	<desc>The maximum number of bytes which can be transfered by all
18127	entities attached to this group during one second.</desc>
18128	</attribute>
18129
18130	</interface>
18131
18132	<!--
18133	// IBandwidthControl
18134	/////////////////////////////////////////////////////////////////////////
18135	-->
18136	<interface
18137	name="IBandwidthControl" extends="$unknown"
18138	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18139	wsmap="managed"
18140	>
18141	<desc>
18142	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18143	This includes network and disk I/O.
18144	</desc>
18145
18146	<attribute name="numGroups" type="unsigned long" readonly="yes">
18147	<desc>
18148	The current number of existing bandwidth groups managed.
18149	</desc>
18150	</attribute>
18151
18152	<method name="createBandwidthGroup">
18153	<desc>
18154	Creates a new bandwidth group.
18155	</desc>
18156
18157	<param name="name" type="wstring" dir="in">
18158	<desc>Name of the bandwidth group.</desc>
18159	</param>
18160	<param name="type" type="BandwidthGroupType" dir="in">
18161	<desc>The type of the bandwidth group (network or disk).</desc>
18162	</param>
18163	<param name="maxBytesPerSec" type="long long" dir="in">
18164	<desc>The maximum number of bytes which can be transfered by all
18165	entities attached to this group during one second.</desc>
18166	</param>
18167	</method>
18168
18169	<method name="deleteBandwidthGroup">
18170	<desc>
18171	Deletes a new bandwidth group.
18172	</desc>
18173
18174	<param name="name" type="wstring" dir="in">
18175	<desc>Name of the bandwidth group to delete.</desc>
18176	</param>
18177	</method>
18178
18179	<method name="getBandwidthGroup" const="yes">
18180	<desc>
18181	Get a bandwidth group by name.
18182	</desc>
18183
18184	<param name="name" type="wstring" dir="in">
18185	<desc>Name of the bandwidth group to get.</desc>
18186	</param>
18187	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18188	<desc>Where to store the bandwidth group on success.</desc>
18189	</param>
18190	</method>
18191
18192	<method name="getAllBandwidthGroups" const="yes">
18193	<desc>
18194	Get all managed bandwidth groups.
18195	</desc>
18196
18197	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18198	<desc>The array of managed bandwidth groups.</desc>
18199	</param>
18200	</method>
18201	</interface>
18202
18203	<!--
18204	// IVirtualBoxClient
18205	/////////////////////////////////////////////////////////////////////////
18206	-->
18207
18208	<interface
18209	name="IVirtualBoxClient" extends="$unknown"
18210	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18211	wsmap="suppress"
18212	>
18213	<desc>
18214	Convenience interface for client applications. Treat this as a
18215	singleton, i.e. never create more than one instance of this interface.
18216
18217	At the moment only available for clients of the local API (not usable
18218	via the webservice). Once the session logic is redesigned this might
18219	change.
18220	</desc>
18221
18222	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18223	<desc>
18224	Reference to the server-side API root object.
18225	</desc>
18226	</attribute>
18227
18228	<attribute name="session" type="ISession" readonly="yes">
18229	<desc>
18230	Create a new session object and return the reference to it.
18231	</desc>
18232	</attribute>
18233
18234	<attribute name="eventSource" type="IEventSource" readonly="yes">
18235	<desc>
18236	Event source for VirtualBoxClient events.
18237	</desc>
18238	</attribute>
18239
18240	</interface>
18241
18242	<!--
18243	// Events
18244	/////////////////////////////////////////////////////////////////////////
18245	-->
18246	<enum
18247	name="VBoxEventType"
18248	uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18249	>
18250
18251	<desc>
18252	Type of an event.
18253	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18254	</desc>
18255
18256	<const name="Invalid" value="0">
18257	<desc>
18258	Invalid event, must be first.
18259	</desc>
18260	</const>
18261
18262	<const name="Any" value="1">
18263	<desc>
18264	Wildcard for all events.
18265	Events of this type are never delivered, and only used in
18266	<link to="IEventSource::registerListener"/> call to simplify registration.
18267	</desc>
18268	</const>
18269
18270	<const name="Vetoable" value="2">
18271	<desc>
18272	Wildcard for all vetoable events. Events of this type are never delivered, and only
18273	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18274	</desc>
18275	</const>
18276
18277	<const name="MachineEvent" value="3">
18278	<desc>
18279	Wildcard for all machine events. Events of this type are never delivered, and only used in
18280	<link to="IEventSource::registerListener"/> call to simplify registration.
18281	</desc>
18282	</const>
18283
18284	<const name="SnapshotEvent" value="4">
18285	<desc>
18286	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18287	<link to="IEventSource::registerListener"/> call to simplify registration.
18288	</desc>
18289	</const>
18290
18291	<const name="InputEvent" value="5">
18292	<desc>
18293	Wildcard for all input device (keyboard, mouse) events.
18294	Events of this type are never delivered, and only used in
18295	<link to="IEventSource::registerListener"/> call to simplify registration.
18296	</desc>
18297	</const>
18298
18299	<const name="LastWildcard" value="31">
18300	<desc>
18301	Last wildcard.
18302	</desc>
18303	</const>
18304
18305	<const name="OnMachineStateChanged" value="32">
18306	<desc>
18307	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18308	</desc>
18309	</const>
18310	<const name="OnMachineDataChanged" value="33">
18311	<desc>
18312	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18313	</desc>
18314	</const>
18315	<const name="OnExtraDataChanged" value="34">
18316	<desc>
18317	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18318	</desc>
18319	</const>
18320	<const name="OnExtraDataCanChange" value="35">
18321	<desc>
18322	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18323	</desc>
18324	</const>
18325	<const name="OnMediumRegistered" value="36">
18326	<desc>
18327	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18328	</desc>
18329	</const>
18330	<const name="OnMachineRegistered" value="37">
18331	<desc>
18332	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18333	</desc>
18334	</const>
18335	<const name="OnSessionStateChanged" value="38">
18336	<desc>
18337	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18338	</desc>
18339	</const>
18340	<const name="OnSnapshotTaken" value="39">
18341	<desc>
18342	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18343	</desc>
18344	</const>
18345	<const name="OnSnapshotDeleted" value="40">
18346	<desc>
18347	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18348	</desc>
18349	</const>
18350	<const name="OnSnapshotChanged" value="41">
18351	<desc>
18352	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18353	</desc>
18354	</const>
18355	<const name="OnGuestPropertyChanged" value="42">
18356	<desc>
18357	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18358	</desc>
18359	</const>
18360	<!-- Console events -->
18361	<const name="OnMousePointerShapeChanged" value="43">
18362	<desc>
18363	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18364	</desc>
18365	</const>
18366	<const name="OnMouseCapabilityChanged" value="44">
18367	<desc>
18368	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18369	</desc>
18370	</const>
18371	<const name="OnKeyboardLedsChanged" value="45">
18372	<desc>
18373	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18374	</desc>
18375	</const>
18376	<const name="OnStateChanged" value="46">
18377	<desc>
18378	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18379	</desc>
18380	</const>
18381	<const name="OnAdditionsStateChanged" value="47">
18382	<desc>
18383	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18384	</desc>
18385	</const>
18386	<const name="OnNetworkAdapterChanged" value="48">
18387	<desc>
18388	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18389	</desc>
18390	</const>
18391	<const name="OnSerialPortChanged" value="49">
18392	<desc>
18393	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18394	</desc>
18395	</const>
18396	<const name="OnParallelPortChanged" value="50">
18397	<desc>
18398	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18399	</desc>
18400	</const>
18401	<const name="OnStorageControllerChanged" value="51">
18402	<desc>
18403	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18404	</desc>
18405	</const>
18406	<const name="OnMediumChanged" value="52">
18407	<desc>
18408	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18409	</desc>
18410	</const>
18411	<const name="OnVRDEServerChanged" value="53">
18412	<desc>
18413	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18414	</desc>
18415	</const>
18416	<const name="OnUSBControllerChanged" value="54">
18417	<desc>
18418	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18419	</desc>
18420	</const>
18421	<const name="OnUSBDeviceStateChanged" value="55">
18422	<desc>
18423	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18424	</desc>
18425	</const>
18426	<const name="OnSharedFolderChanged" value="56">
18427	<desc>
18428	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18429	</desc>
18430	</const>
18431	<const name="OnRuntimeError" value="57">
18432	<desc>
18433	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18434	</desc>
18435	</const>
18436	<const name="OnCanShowWindow" value="58">
18437	<desc>
18438	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18439	</desc>
18440	</const>
18441	<const name="OnShowWindow" value="59">
18442	<desc>
18443	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18444	</desc>
18445	</const>
18446	<const name="OnCPUChanged" value="60">
18447	<desc>
18448	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18449	</desc>
18450	</const>
18451	<const name="OnVRDEServerInfoChanged" value="61">
18452	<desc>
18453	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18454	</desc>
18455	</const>
18456	<const name="OnEventSourceChanged" value="62">
18457	<desc>
18458	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18459	</desc>
18460	</const>
18461	<const name="OnCPUExecutionCapChanged" value="63">
18462	<desc>
18463	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18464	</desc>
18465	</const>
18466	<const name="OnGuestKeyboard" value="64">
18467	<desc>
18468	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18469	</desc>
18470	</const>
18471	<const name="OnGuestMouse" value="65">
18472	<desc>
18473	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18474	</desc>
18475	</const>
18476	<const name="OnNATRedirect" value="66">
18477	<desc>
18478	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18479	</desc>
18480	</const>
18481	<const name="OnHostPCIDevicePlug" value="67">
18482	<desc>
18483	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18484	</desc>
18485	</const>
18486	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18487	<desc>
18488	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18489	</desc>
18490	</const>
18491	<const name="OnBandwidthGroupChanged" value="69">
18492	<desc>
18493	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18494	</desc>
18495	</const>
18496	<const name="OnGuestMonitorChanged" value="70">
18497	<desc>
18498	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18499	</desc>
18500	</const>
18501	<const name="OnStorageDeviceChanged" value="71">
18502	<desc>
18503	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18504	</desc>
18505	</const>
18506	<const name="OnClipboardModeChanged" value="72">
18507	<desc>
18508	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18509	</desc>
18510	</const>
18511	<const name="OnDragAndDropModeChanged" value="73">
18512	<desc>
18513	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18514	</desc>
18515	</const>
18516
18517	<!-- Last event marker -->
18518	<const name="Last" value="74">
18519	<desc>
18520	Must be last event, used for iterations and structures relying on numerical event values.
18521	</desc>
18522	</const>
18523
18524	</enum>
18525
18526	<interface
18527	name="IEventSource" extends="$unknown"
18528	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
18529	wsmap="managed"
18530	>
18531	<desc>
18532	Event source. Generally, any object which could generate events can be an event source,
18533	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
18534	an event source can work with listeners in either active or passive mode. In active mode it is up to
18535	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
18536	event source keeps track of pending events for each listener and returns available events on demand.
18537
18538	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18539	</desc>
18540
18541	<method name="createListener">
18542	<desc>
18543	Creates a new listener object, useful for passive mode.
18544	</desc>
18545	<param name="listener" type="IEventListener" dir="return"/>
18546	</method>
18547
18548	<method name="createAggregator">
18549	<desc>
18550	Creates an aggregator event source, collecting events from multiple sources.
18551	This way a single listener can listen for events coming from multiple sources,
18552	using a single blocking <link to="#getEvent"/> on the returned aggregator.
18553	</desc>
18554	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
18555	<desc>
18556	Subordinate event source this one aggregatres.
18557	</desc>
18558	</param>
18559	<param name="result" type="IEventSource" dir="return">
18560	<desc>
18561	Event source aggregating passed sources.
18562	</desc>
18563	</param>
18564	</method>
18565
18566	<method name="registerListener">
18567	<desc>
18568	Register an event listener.
18569
18570	<note>
18571	To avoid system overload, the VirtualBox server process checks if passive event
18572	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
18573	current implementation, if more than 500 pending events are detected for a passive
18574	event listener, it is forcefully unregistered by the system, and further
18575	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
18576	</note>
18577	</desc>
18578	<param name="listener" type="IEventListener" dir="in">
18579	<desc>Listener to register.</desc>
18580	</param>
18581	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
18582	<desc>
18583	Event types listener is interested in. One can use wildcards like -
18584	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
18585	than one event.
18586	</desc>
18587	</param>
18588	<param name="active" type="boolean" dir="in">
18589	<desc>
18590	Which mode this listener is operating in.
18591	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
18592	In passive mode, an internal event queue is created for this this IEventListener.
18593	For each event coming in, it is added to queues for all interested registered passive
18594	listeners. It is then up to the external code to call the listener's
18595	<link to="IEventListener::handleEvent" /> method. When done with an event, the
18596	external code must call <link to="#eventProcessed" />.
18597	</desc>
18598	</param>
18599	</method>
18600
18601	<method name="unregisterListener">
18602	<desc>
18603	Unregister an event listener. If listener is passive, and some waitable events are still
18604	in queue they are marked as processed automatically.
18605	</desc>
18606	<param name="listener" type="IEventListener" dir="in">
18607	<desc>Listener to unregister.</desc>
18608	</param>
18609	</method>
18610
18611	<method name="fireEvent">
18612	<desc>
18613	Fire an event for this source.
18614	</desc>
18615	<param name="event" type="IEvent" dir="in">
18616	<desc>Event to deliver.</desc>
18617	</param>
18618	<param name="timeout" type="long" dir="in">
18619	<desc>
18620	Maximum time to wait for event processing (if event is waitable), in ms;
18621	0 = no wait, -1 = indefinite wait.
18622	</desc>
18623	</param>
18624	<param name="result" type="boolean" dir="return">
18625	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
18626	</param>
18627	</method>
18628
18629	<method name="getEvent">
18630	<desc>
18631	Get events from this peer's event queue (for passive mode). Calling this method
18632	regularly is required for passive event listeners to avoid system overload;
18633	see <link to="IEventSource::registerListener" /> for details.
18634
18635	<result name="VBOX_E_OBJECT_NOT_FOUND">
18636	Listener is not registered, or autounregistered.
18637	</result>
18638	</desc>
18639	<param name="listener" type="IEventListener" dir="in">
18640	<desc>Which listener to get data for.</desc>
18641	</param>
18642	<param name="timeout" type="long" dir="in">
18643	<desc>
18644	Maximum time to wait for events, in ms;
18645	0 = no wait, -1 = indefinite wait.
18646	</desc>
18647	</param>
18648	<param name="event" type="IEvent" dir="return">
18649	<desc>Event retrieved, or null if none available.</desc>
18650	</param>
18651	</method>
18652
18653	<method name="eventProcessed">
18654	<desc>
18655	Must be called for waitable events after a particular listener finished its
18656	event processing. When all listeners of a particular event have called this
18657	method, the system will then call <link to="IEvent::setProcessed" />.
18658	</desc>
18659	<param name="listener" type="IEventListener" dir="in">
18660	<desc>Which listener processed event.</desc>
18661	</param>
18662	<param name="event" type="IEvent" dir="in">
18663	<desc>Which event.</desc>
18664	</param>
18665	</method>
18666
18667	</interface>
18668
18669	<interface
18670	name="IEventListener" extends="$unknown"
18671	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
18672	wsmap="managed"
18673	>
18674	<desc>
18675	Event listener. An event listener can work in either active or passive mode, depending on the way
18676	it was registered.
18677	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18678	</desc>
18679
18680	<method name="handleEvent">
18681	<desc>
18682	Handle event callback for active listeners. It is not called for
18683	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
18684	and having received acknowledgement from all passive listeners via
18685	<link to="IEventSource::eventProcessed"/>, the event is marked as
18686	processed and <link to="IEvent::waitProcessed"/> will return
18687	immediately.
18688	</desc>
18689	<param name="event" type="IEvent" dir="in">
18690	<desc>Event available.</desc>
18691	</param>
18692	</method>
18693
18694	</interface>
18695
18696	<interface
18697	name="IEvent" extends="$unknown"
18698	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
18699	wsmap="managed"
18700	>
18701	<desc>
18702	Abstract parent interface for VirtualBox events. Actual events will typically implement
18703	a more specific interface which derives from this (see below).
18704
18705	<b>Introduction to VirtualBox events</b>
18706
18707	Generally speaking, an event (represented by this interface) signals that something
18708	happened, while an event listener (see <link to="IEventListener" />) represents an
18709	entity that is interested in certain events. In order for this to work with
18710	unidirectional protocols (i.e. web services), the concepts of passive and active
18711	listener are used.
18712
18713	Event consumers can register themselves as listeners, providing an array of
18714	events they are interested in (see <link to="IEventSource::registerListener" />).
18715	When an event triggers, the listener is notified about the event. The exact
18716	mechanism of the notification depends on whether the listener was registered as
18717	an active or passive listener:
18718
18719	<ul>
18720	<li>An active listener is very similar to a callback: it is a function invoked
18721	by the API. As opposed to the callbacks that were used in the API before
18722	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
18723	</li>
18724
18725	<li>Passive listeners are somewhat trickier to implement, but do not require
18726	a client function to be callable, which is not an option with scripting
18727	languages or web service clients. Internally the <link to="IEventSource" />
18728	implementation maintains an event queue for each passive listener, and
18729	newly arrived events are put in this queue. When the listener calls
18730	<link to="IEventSource::getEvent"/>, first element from its internal event
18731	queue is returned. When the client completes processing of an event,
18732	the <link to="IEventSource::eventProcessed" /> function must be called,
18733	acknowledging that the event was processed. It supports implementing
18734	waitable events. On passive listener unregistration, all events from its
18735	queue are auto-acknowledged.
18736	</li>
18737	</ul>
18738
18739	Waitable events are useful in situations where the event generator wants to track
18740	delivery or a party wants to wait until all listeners have completed the event. A
18741	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
18742	listeners might veto a certain action, and thus the event producer has to make
18743	sure that all listeners have processed the event and not vetoed before taking
18744	the action.
18745
18746	A given event may have both passive and active listeners at the same time.
18747
18748	<b>Using events</b>
18749
18750	Any VirtualBox object capable of producing externally visible events provides an
18751	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
18752	This event source object is notified by VirtualBox once something has happened, so
18753	consumers may register event listeners with this event source. To register a listener,
18754	an object implementing the <link to="IEventListener" /> interface must be provided.
18755	For active listeners, such an object is typically created by the consumer, while for
18756	passive listeners <link to="IEventSource::createListener" /> should be used. Please
18757	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
18758
18759	Once created, the listener must be registered to listen for the desired events
18760	(see <link to="IEventSource::registerListener" />), providing an array of
18761	<link to="VBoxEventType" /> enums. Those elements can either be the individual
18762	event IDs or wildcards matching multiple event IDs.
18763
18764	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
18765	called automatically when the event is triggered, while passive listeners have to call
18766	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
18767	an event processing loop.
18768
18769	The IEvent interface is an abstract parent interface for all such VirtualBox events
18770	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
18771	or the event processing loop is to check the <link to="#type" /> attribute of the event and
18772	then cast to the appropriate specific interface using @c QueryInterface().
18773	</desc>
18774
18775	<attribute name="type" readonly="yes" type="VBoxEventType">
18776	<desc>
18777	Event type.
18778	</desc>
18779	</attribute>
18780
18781	<attribute name="source" readonly="yes" type="IEventSource">
18782	<desc>
18783	Source of this event.
18784	</desc>
18785	</attribute>
18786
18787	<attribute name="waitable" readonly="yes" type="boolean">
18788	<desc>
18789	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
18790	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
18791	as no additional overhead associated with waitability imposed.
18792	Waitable events are needed when one need to be able to wait for particular event processed,
18793	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
18794	until all consumers confirmed events.
18795	</desc>
18796	</attribute>
18797
18798	<method name="setProcessed">
18799	<desc>
18800	Internal method called by the system when all listeners of a particular event have called
18801	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
18802	</desc>
18803	</method>
18804
18805	<method name="waitProcessed">
18806	<desc>
18807	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
18808	described semantics, for non-waitable returns true immediately.
18809	</desc>
18810	<param name="timeout" type="long" dir="in">
18811	<desc>
18812	Maximum time to wait for event processeing, in ms;
18813	0 = no wait, -1 = indefinite wait.
18814	</desc>
18815	</param>
18816	<param name="result" type="boolean" dir="return">
18817	<desc>If this event was processed before timeout.</desc>
18818	</param>
18819	</method>
18820	</interface>
18821
18822
18823	<interface
18824	name="IReusableEvent" extends="IEvent"
18825	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
18826	wsmap="managed"
18827	>
18828	<desc>Base abstract interface for all reusable events.</desc>
18829
18830	<attribute name="generation" readonly="yes" type="unsigned long">
18831	<desc>Current generation of event, incremented on reuse.</desc>
18832	</attribute>
18833
18834	<method name="reuse">
18835	<desc>
18836	Marks an event as reused, increments 'generation', fields shall no
18837	longer be considered valid.
18838	</desc>
18839	</method>
18840	</interface>
18841
18842	<interface
18843	name="IMachineEvent" extends="IEvent"
18844	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
18845	wsmap="managed" id="MachineEvent"
18846	>
18847	<desc>Base abstract interface for all machine events.</desc>
18848
18849	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
18850	<desc>ID of the machine this event relates to.</desc>
18851	</attribute>
18852
18853	</interface>
18854
18855	<interface
18856	name="IMachineStateChangedEvent" extends="IMachineEvent"
18857	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
18858	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
18859	>
18860	<desc>Machine state change event.</desc>
18861
18862	<attribute name="state" readonly="yes" type="MachineState">
18863	<desc>New execution state.</desc>
18864	</attribute>
18865	</interface>
18866
18867	<interface
18868	name="IMachineDataChangedEvent" extends="IMachineEvent"
18869	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
18870	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
18871	>
18872	<desc>
18873	Any of the settings of the given machine has changed.
18874	</desc>
18875
18876	<attribute name="temporary" readonly="yes" type="boolean">
18877	<desc>@c true if the settings change is temporary. All permanent
18878	settings changes will trigger an event, and only temporary settings
18879	changes for running VMs will trigger an event. Note: sending events
18880	for temporary changes is NOT IMPLEMENTED.</desc>
18881	</attribute>
18882	</interface>
18883
18884	<interface
18885	name="IMediumRegisteredEvent" extends="IEvent"
18886	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
18887	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
18888	>
18889	<desc>
18890	The given medium was registered or unregistered
18891	within this VirtualBox installation.
18892	</desc>
18893
18894	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
18895	<desc>ID of the medium this event relates to.</desc>
18896	</attribute>
18897
18898	<attribute name="mediumType" readonly="yes" type="DeviceType">
18899	<desc>Type of the medium this event relates to.</desc>
18900	</attribute>
18901
18902	<attribute name="registered" type="boolean" readonly="yes">
18903	<desc>
18904	If @c true, the medium was registered, otherwise it was
18905	unregistered.
18906	</desc>
18907	</attribute>
18908	</interface>
18909
18910	<interface
18911	name="IMachineRegisteredEvent" extends="IMachineEvent"
18912	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
18913	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
18914	>
18915	<desc>
18916	The given machine was registered or unregistered
18917	within this VirtualBox installation.
18918	</desc>
18919
18920	<attribute name="registered" type="boolean" readonly="yes">
18921	<desc>
18922	If @c true, the machine was registered, otherwise it was
18923	unregistered.
18924	</desc>
18925	</attribute>
18926	</interface>
18927
18928	<interface
18929	name="ISessionStateChangedEvent" extends="IMachineEvent"
18930	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
18931	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
18932	>
18933	<desc>
18934	The state of the session for the given machine was changed.
18935	<see><link to="IMachine::sessionState"/></see>
18936	</desc>
18937
18938	<attribute name="state" type="SessionState" readonly="yes">
18939	<desc>
18940	New session state.
18941	</desc>
18942	</attribute>
18943	</interface>
18944
18945	<interface
18946	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
18947	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
18948	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
18949	>
18950	<desc>
18951	Notification when a guest property has changed.
18952	</desc>
18953
18954	<attribute name="name" readonly="yes" type="wstring">
18955	<desc>
18956	The name of the property that has changed.
18957	</desc>
18958	</attribute>
18959
18960	<attribute name="value" readonly="yes" type="wstring">
18961	<desc>
18962	The new property value.
18963	</desc>
18964	</attribute>
18965
18966	<attribute name="flags" readonly="yes" type="wstring">
18967	<desc>
18968	The new property flags.
18969	</desc>
18970	</attribute>
18971
18972	</interface>
18973
18974	<interface
18975	name="ISnapshotEvent" extends="IMachineEvent"
18976	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
18977	wsmap="managed" id="SnapshotEvent"
18978	>
18979	<desc>Base interface for all snapshot events.</desc>
18980
18981	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
18982	<desc>ID of the snapshot this event relates to.</desc>
18983	</attribute>
18984
18985	</interface>
18986
18987	<interface
18988	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
18989	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
18990	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
18991	>
18992	<desc>
18993	A new snapshot of the machine has been taken.
18994	<see><link to="ISnapshot"/></see>
18995	</desc>
18996	</interface>
18997
18998	<interface
18999	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19000	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19001	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19002	>
19003	<desc>
19004	Snapshot of the given machine has been deleted.
19005
19006	<note>
19007	This notification is delivered <b>after</b> the snapshot
19008	object has been uninitialized on the server (so that any
19009	attempt to call its methods will return an error).
19010	</note>
19011
19012	<see><link to="ISnapshot"/></see>
19013	</desc>
19014	</interface>
19015
19016	<interface
19017	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19018	uuid="07541941-8079-447a-a33e-47a69c7980db"
19019	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19020	>
19021	<desc>
19022	Snapshot properties (name and/or description) have been changed.
19023	<see><link to="ISnapshot"/></see>
19024	</desc>
19025	</interface>
19026
19027	<interface
19028	name="IMousePointerShapeChangedEvent" extends="IEvent"
19029	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19030	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19031	>
19032	<desc>
19033	Notification when the guest mouse pointer shape has
19034	changed. The new shape data is given.
19035	</desc>
19036
19037	<attribute name="visible" type="boolean" readonly="yes">
19038	<desc>
19039	Flag whether the pointer is visible.
19040	</desc>
19041	</attribute>
19042	<attribute name="alpha" type="boolean" readonly="yes">
19043	<desc>
19044	Flag whether the pointer has an alpha channel.
19045	</desc>
19046	</attribute>
19047	<attribute name="xhot" type="unsigned long" readonly="yes">
19048	<desc>
19049	The pointer hot spot X coordinate.
19050	</desc>
19051	</attribute>
19052	<attribute name="yhot" type="unsigned long" readonly="yes">
19053	<desc>
19054	The pointer hot spot Y coordinate.
19055	</desc>
19056	</attribute>
19057	<attribute name="width" type="unsigned long" readonly="yes">
19058	<desc>
19059	Width of the pointer shape in pixels.
19060	</desc>
19061	</attribute>
19062	<attribute name="height" type="unsigned long" readonly="yes">
19063	<desc>
19064	Height of the pointer shape in pixels.
19065	</desc>
19066	</attribute>
19067	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19068	<desc>
19069	Shape buffer arrays.
19070
19071	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19072	followed by a 32-bpp XOR (color) mask.
19073
19074	For pointers without alpha channel the XOR mask pixels are 32
19075	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19076	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19077
19078	An AND mask is used for pointers with alpha channel, so if the
19079	callback does not support alpha, the pointer could be
19080	displayed as a normal color pointer.
19081
19082	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19083	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19084	height</tt>. The padding bits at the end of each scanline are
19085	undefined.
19086
19087	The XOR mask follows the AND mask on the next 4-byte aligned
19088	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19089	Bytes in the gap between the AND and the XOR mask are undefined.
19090	The XOR mask scanlines have no gap between them and the size of
19091	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19092
19093	<note>
19094	If @a shape is 0, only the pointer visibility is changed.
19095	</note>
19096	</desc>
19097	</attribute>
19098	</interface>
19099
19100	<interface
19101	name="IMouseCapabilityChangedEvent" extends="IEvent"
19102	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19103	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19104	>
19105	<desc>
19106	Notification when the mouse capabilities reported by the
19107	guest have changed. The new capabilities are passed.
19108	</desc>
19109	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19110	<desc>
19111	Supports absolute coordinates.
19112	</desc>
19113	</attribute>
19114	<attribute name="supportsRelative" type="boolean" readonly="yes">
19115	<desc>
19116	Supports relative coordinates.
19117	</desc>
19118	</attribute>
19119	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19120	<desc>
19121	If host cursor is needed.
19122	</desc>
19123	</attribute>
19124	</interface>
19125
19126	<interface
19127	name="IKeyboardLedsChangedEvent" extends="IEvent"
19128	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19129	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19130	>
19131	<desc>
19132	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19133	to alter the state of the keyboard LEDs.
19134	</desc>
19135	<attribute name="numLock" type="boolean" readonly="yes">
19136	<desc>
19137	NumLock status.
19138	</desc>
19139	</attribute>
19140	<attribute name="capsLock" type="boolean" readonly="yes">
19141	<desc>
19142	CapsLock status.
19143	</desc>
19144	</attribute>
19145	<attribute name="scrollLock" type="boolean" readonly="yes">
19146	<desc>
19147	ScrollLock status.
19148	</desc>
19149	</attribute>
19150	</interface>
19151
19152	<interface
19153	name="IStateChangedEvent" extends="IEvent"
19154	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19155	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19156	>
19157	<desc>
19158	Notification when the execution state of the machine has changed.
19159	The new state is given.
19160	</desc>
19161	<attribute name="state" type="MachineState" readonly="yes">
19162	<desc>
19163	New machine state.
19164	</desc>
19165	</attribute>
19166	</interface>
19167
19168	<interface
19169	name="IAdditionsStateChangedEvent" extends="IEvent"
19170	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19171	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19172	>
19173	<desc>
19174	Notification when a Guest Additions property changes.
19175	Interested callees should query IGuest attributes to
19176	find out what has changed.
19177	</desc>
19178	</interface>
19179
19180	<interface
19181	name="INetworkAdapterChangedEvent" extends="IEvent"
19182	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19183	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19184	>
19185	<desc>
19186	Notification when a property of one of the
19187	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19188	changes. Interested callees should use INetworkAdapter methods and
19189	attributes to find out what has changed.
19190	</desc>
19191	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19192	<desc>
19193	Network adapter that is subject to change.
19194	</desc>
19195	</attribute>
19196	</interface>
19197
19198	<interface
19199	name="ISerialPortChangedEvent" extends="IEvent"
19200	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19201	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19202	>
19203	<desc>
19204	Notification when a property of one of the
19205	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19206	Interested callees should use ISerialPort methods and attributes
19207	to find out what has changed.
19208	</desc>
19209	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19210	<desc>
19211	Serial port that is subject to change.
19212	</desc>
19213	</attribute>
19214	</interface>
19215
19216	<interface
19217	name="IParallelPortChangedEvent" extends="IEvent"
19218	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19219	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19220	>
19221	<desc>
19222	Notification when a property of one of the
19223	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19224	changes. Interested callees should use ISerialPort methods and
19225	attributes to find out what has changed.
19226	</desc>
19227	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19228	<desc>
19229	Parallel port that is subject to change.
19230	</desc>
19231	</attribute>
19232	</interface>
19233
19234	<interface
19235	name="IStorageControllerChangedEvent" extends="IEvent"
19236	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19237	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19238	>
19239	<desc>
19240	Notification when a
19241	<link to="IMachine::mediumAttachments">medium attachment</link>
19242	changes.
19243	</desc>
19244	</interface>
19245
19246	<interface
19247	name="IMediumChangedEvent" extends="IEvent"
19248	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19249	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19250	>
19251	<desc>
19252	Notification when a
19253	<link to="IMachine::mediumAttachments">medium attachment</link>
19254	changes.
19255	</desc>
19256	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19257	<desc>
19258	Medium attachment that is subject to change.
19259	</desc>
19260	</attribute>
19261	</interface>
19262
19263	<interface
19264	name="IClipboardModeChangedEvent" extends="IEvent"
19265	uuid="cac21692-7997-4595-a731-3a509db604e5"
19266	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19267	>
19268	<desc>
19269	Notification when the shared clipboard mode changes.
19270	</desc>
19271	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19272	<desc>
19273	The new clipboard mode.
19274	</desc>
19275	</attribute>
19276	</interface>
19277
19278	<interface
19279	name="IDragAndDropModeChangedEvent" extends="IEvent"
19280	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19281	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19282	>
19283	<desc>
19284	Notification when the drag'n'drop mode changes.
19285	</desc>
19286	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19287	<desc>
19288	The new drag'n'drop mode.
19289	</desc>
19290	</attribute>
19291	</interface>
19292
19293	<interface
19294	name="ICPUChangedEvent" extends="IEvent"
19295	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19296	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19297	>
19298	<desc>
19299	Notification when a CPU changes.
19300	</desc>
19301	<attribute name="CPU" type="unsigned long" readonly="yes">
19302	<desc>
19303	The CPU which changed.
19304	</desc>
19305	</attribute>
19306	<attribute name="add" type="boolean" readonly="yes">
19307	<desc>
19308	Flag whether the CPU was added or removed.
19309	</desc>
19310	</attribute>
19311	</interface>
19312
19313	<interface
19314	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19315	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19316	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19317	>
19318	<desc>
19319	Notification when the CPU execution cap changes.
19320	</desc>
19321	<attribute name="executionCap" type="unsigned long" readonly="yes">
19322	<desc>
19323	The new CPU execution cap value. (1-100)
19324	</desc>
19325	</attribute>
19326	</interface>
19327
19328	<interface
19329	name="IGuestKeyboardEvent" extends="IEvent"
19330	uuid="88394258-7006-40d4-b339-472ee3801844"
19331	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19332	>
19333	<desc>
19334	Notification when guest keyboard event happens.
19335	</desc>
19336	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19337	<desc>
19338	Array of scancodes.
19339	</desc>
19340	</attribute>
19341	</interface>
19342
19343	<interface
19344	name="IGuestMouseEvent" extends="IReusableEvent"
19345	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19346	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19347	>
19348	<desc>
19349	Notification when guest mouse event happens.
19350	</desc>
19351
19352	<attribute name="absolute" type="boolean" readonly="yes">
19353	<desc>
19354	If this event is relative or absolute.
19355	</desc>
19356	</attribute>
19357
19358	<attribute name="x" type="long" readonly="yes">
19359	<desc>
19360	New X position, or X delta.
19361	</desc>
19362	</attribute>
19363
19364	<attribute name="y" type="long" readonly="yes">
19365	<desc>
19366	New Y position, or Y delta.
19367	</desc>
19368	</attribute>
19369
19370	<attribute name="z" type="long" readonly="yes">
19371	<desc>
19372	Z delta.
19373	</desc>
19374	</attribute>
19375
19376	<attribute name="w" type="long" readonly="yes">
19377	<desc>
19378	W delta.
19379	</desc>
19380	</attribute>
19381
19382	<attribute name="buttons" type="long" readonly="yes">
19383	<desc>
19384	Button state bitmask.
19385	</desc>
19386	</attribute>
19387
19388	</interface>
19389
19390
19391	<interface
19392	name="IVRDEServerChangedEvent" extends="IEvent"
19393	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19394	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19395	>
19396	<desc>
19397	Notification when a property of the
19398	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19399	Interested callees should use IVRDEServer methods and attributes to
19400	find out what has changed.
19401	</desc>
19402	</interface>
19403
19404	<interface
19405	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19406	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19407	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19408	>
19409	<desc>
19410	Notification when the status of the VRDE server changes. Interested callees
19411	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19412	attributes to find out what is the current status.
19413	</desc>
19414	</interface>
19415
19416	<interface
19417	name="IUSBControllerChangedEvent" extends="IEvent"
19418	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19419	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19420	>
19421	<desc>
19422	Notification when a property of the virtual
19423	<link to="IMachine::USBController">USB controller</link> changes.
19424	Interested callees should use IUSBController methods and attributes to
19425	find out what has changed.
19426	</desc>
19427	</interface>
19428
19429	<interface
19430	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19431	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19432	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19433	>
19434	<desc>
19435	Notification when a USB device is attached to or detached from
19436	the virtual USB controller.
19437
19438	This notification is sent as a result of the indirect
19439	request to attach the device because it matches one of the
19440	machine USB filters, or as a result of the direct request
19441	issued by <link to="IConsole::attachUSBDevice"/> or
19442	<link to="IConsole::detachUSBDevice"/>.
19443
19444	This notification is sent in case of both a succeeded and a
19445	failed request completion. When the request succeeds, the
19446	@a error parameter is @c null, and the given device has been
19447	already added to (when @a attached is @c true) or removed from
19448	(when @a attached is @c false) the collection represented by
19449	<link to="IConsole::USBDevices"/>. On failure, the collection
19450	doesn't change and the @a error parameter represents the error
19451	message describing the failure.
19452	</desc>
19453	<attribute name="device" type="IUSBDevice" readonly="yes">
19454	<desc>
19455	Device that is subject to state change.
19456	</desc>
19457	</attribute>
19458	<attribute name="attached" type="boolean" readonly="yes">
19459	<desc>
19460	@c true if the device was attached and @c false otherwise.
19461	</desc>
19462	</attribute>
19463	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19464	<desc>
19465	@c null on success or an error message object on failure.
19466	</desc>
19467	</attribute>
19468	</interface>
19469
19470	<interface
19471	name="ISharedFolderChangedEvent" extends="IEvent"
19472	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19473	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19474	>
19475	<desc>
19476	Notification when a shared folder is added or removed.
19477	The @a scope argument defines one of three scopes:
19478	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19479	(<link to="Scope_Global">Global</link>),
19480	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19481	the machine (<link to="Scope_Machine">Machine</link>) or <link
19482	to="IConsole::sharedFolders">transient shared folders</link> of the
19483	machine (<link to="Scope_Session">Session</link>). Interested callees
19484	should use query the corresponding collections to find out what has
19485	changed.
19486	</desc>
19487	<attribute name="scope" type="Scope" readonly="yes">
19488	<desc>
19489	Scope of the notification.
19490	</desc>
19491	</attribute>
19492	</interface>
19493
19494	<interface
19495	name="IRuntimeErrorEvent" extends="IEvent"
19496	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19497	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19498	>
19499	<desc>
19500	Notification when an error happens during the virtual
19501	machine execution.
19502
19503	There are three kinds of runtime errors:
19504	<ul>
19505	<li><i>fatal</i></li>
19506	<li><i>non-fatal with retry</i></li>
19507	<li><i>non-fatal warnings</i></li>
19508	</ul>
19509
19510	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19511	to @c true. In case of fatal errors, the virtual machine
19512	execution is always paused before calling this notification, and
19513	the notification handler is supposed either to immediately save
19514	the virtual machine state using <link to="IConsole::saveState"/>
19515	or power it off using <link to="IConsole::powerDown"/>.
19516	Resuming the execution can lead to unpredictable results.
19517
19518	<b>Non-fatal</b> errors and warnings are indicated by the
19519	@a fatal parameter set to @c false. If the virtual machine
19520	is in the Paused state by the time the error notification is
19521	received, it means that the user can <i>try to resume</i> the machine
19522	execution after attempting to solve the problem that caused the
19523	error. In this case, the notification handler is supposed
19524	to show an appropriate message to the user (depending on the
19525	value of the @a id parameter) that offers several actions such
19526	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
19527	wants to retry, the notification handler should continue
19528	the machine execution using the <link to="IConsole::resume"/>
19529	call. If the machine execution is not Paused during this
19530	notification, then it means this notification is a <i>warning</i>
19531	(for example, about a fatal condition that can happen very soon);
19532	no immediate action is required from the user, the machine
19533	continues its normal execution.
19534
19535	Note that in either case the notification handler
19536	<b>must not</b> perform any action directly on a thread
19537	where this notification is called. Everything it is allowed to
19538	do is to post a message to another thread that will then talk
19539	to the user and take the corresponding action.
19540
19541	Currently, the following error identifiers are known:
19542	<ul>
19543	<li><tt>"HostMemoryLow"</tt></li>
19544	<li><tt>"HostAudioNotResponding"</tt></li>
19545	<li><tt>"VDIStorageFull"</tt></li>
19546	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
19547	</ul>
19548	</desc>
19549	<attribute name="fatal" type="boolean" readonly="yes">
19550	<desc>
19551	Whether the error is fatal or not.
19552	</desc>
19553	</attribute>
19554	<attribute name="id" type="wstring" readonly="yes">
19555	<desc>
19556	Error identifier.
19557	</desc>
19558	</attribute>
19559	<attribute name="message" type="wstring" readonly="yes">
19560	<desc>
19561	Optional error message.
19562	</desc>
19563	</attribute>
19564	</interface>
19565
19566
19567	<interface
19568	name="IEventSourceChangedEvent" extends="IEvent"
19569	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
19570	waitable="yes"
19571	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
19572	>
19573	<desc>
19574	Notification when an event source state changes (listener added or removed).
19575	</desc>
19576
19577	<attribute name="listener" type="IEventListener" readonly="yes">
19578	<desc>
19579	Event listener which has changed.
19580	</desc>
19581	</attribute>
19582
19583	<attribute name="add" type="boolean" readonly="yes">
19584	<desc>
19585	Flag whether listener was added or removed.
19586	</desc>
19587	</attribute>
19588	</interface>
19589
19590	<interface
19591	name="IExtraDataChangedEvent" extends="IEvent"
19592	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
19593	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
19594	>
19595	<desc>
19596	Notification when machine specific or global extra data
19597	has changed.
19598	</desc>
19599	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19600	<desc>
19601	ID of the machine this event relates to.
19602	Null for global extra data changes.
19603	</desc>
19604	</attribute>
19605	<attribute name="key" type="wstring" readonly="yes">
19606	<desc>
19607	Extra data key that has changed.
19608	</desc>
19609	</attribute>
19610	<attribute name="value" type="wstring" readonly="yes">
19611	<desc>
19612	Extra data value for the given key.
19613	</desc>
19614	</attribute>
19615	</interface>
19616
19617	<interface
19618	name="IVetoEvent" extends="IEvent"
19619	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
19620	wsmap="managed"
19621	>
19622	<desc>Base abstract interface for veto events.</desc>
19623
19624	<method name="addVeto">
19625	<desc>
19626	Adds a veto on this event.
19627	</desc>
19628	<param name="reason" type="wstring" dir="in">
19629	<desc>
19630	Reason for veto, could be null or empty string.
19631	</desc>
19632	</param>
19633	</method>
19634
19635	<method name="isVetoed">
19636	<desc>
19637	If this event was vetoed.
19638	</desc>
19639	<param name="result" type="boolean" dir="return">
19640	<desc>
19641	Reason for veto.
19642	</desc>
19643	</param>
19644	</method>
19645
19646	<method name="getVetos">
19647	<desc>
19648	Current veto reason list, if size is 0 - no veto.
19649	</desc>
19650	<param name="result" type="wstring" dir="return" safearray="yes">
19651	<desc>
19652	Array of reasons for veto provided by different event handlers.
19653	</desc>
19654	</param>
19655	</method>
19656
19657	</interface>
19658
19659	<interface
19660	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
19661	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
19662	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
19663	waitable="true"
19664	>
19665	<desc>
19666	Notification when someone tries to change extra data for
19667	either the given machine or (if @c null) global extra data.
19668	This gives the chance to veto against changes.
19669	</desc>
19670	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19671	<desc>
19672	ID of the machine this event relates to.
19673	Null for global extra data changes.
19674	</desc>
19675	</attribute>
19676	<attribute name="key" type="wstring" readonly="yes">
19677	<desc>
19678	Extra data key that has changed.
19679	</desc>
19680	</attribute>
19681	<attribute name="value" type="wstring" readonly="yes">
19682	<desc>
19683	Extra data value for the given key.
19684	</desc>
19685	</attribute>
19686	</interface>
19687
19688	<interface
19689	name="ICanShowWindowEvent" extends="IVetoEvent"
19690	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
19691	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
19692	waitable="true"
19693	>
19694	<desc>
19695	Notification when a call to
19696	<link to="IMachine::canShowConsoleWindow"/> is made by a
19697	front-end to check if a subsequent call to
19698	<link to="IMachine::showConsoleWindow"/> can succeed.
19699
19700	The callee should give an answer appropriate to the current
19701	machine state using event veto. This answer must
19702	remain valid at least until the next
19703	<link to="IConsole::state">machine state</link> change.
19704	</desc>
19705	</interface>
19706
19707	<interface
19708	name="IShowWindowEvent" extends="IEvent"
19709	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
19710	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
19711	waitable="true"
19712	>
19713	<desc>
19714	Notification when a call to
19715	<link to="IMachine::showConsoleWindow"/>
19716	requests the console window to be activated and brought to
19717	foreground on the desktop of the host PC.
19718
19719	This notification should cause the VM console process to
19720	perform the requested action as described above. If it is
19721	impossible to do it at a time of this notification, this
19722	method should return a failure.
19723
19724	Note that many modern window managers on many platforms
19725	implement some sort of focus stealing prevention logic, so
19726	that it may be impossible to activate a window without the
19727	help of the currently active application (which is supposedly
19728	an initiator of this notification). In this case, this method
19729	must return a non-zero identifier that represents the
19730	top-level window of the VM console process. The caller, if it
19731	represents a currently active process, is responsible to use
19732	this identifier (in a platform-dependent manner) to perform
19733	actual window activation.
19734
19735	This method must set @a winId to zero if it has performed all
19736	actions necessary to complete the request and the console
19737	window is now active and in foreground, to indicate that no
19738	further action is required on the caller's side.
19739	</desc>
19740	<attribute name="winId" type="long long">
19741	<desc>
19742	Platform-dependent identifier of the top-level VM console
19743	window, or zero if this method has performed all actions
19744	necessary to implement the <i>show window</i> semantics for
19745	the given platform and/or this VirtualBox front-end.
19746	</desc>
19747	</attribute>
19748	</interface>
19749
19750	<interface
19751	name="INATRedirectEvent" extends="IMachineEvent"
19752	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
19753	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
19754	>
19755	<desc>
19756	Notification when NAT redirect rule added or removed.
19757	</desc>
19758	<attribute name="slot" type="unsigned long" readonly="yes">
19759	<desc>
19760	Adapter which NAT attached to.
19761	</desc>
19762	</attribute>
19763	<attribute name="remove" type="boolean" readonly="yes">
19764	<desc>
19765	Whether rule remove or add.
19766	</desc>
19767	</attribute>
19768	<attribute name="name" type="wstring" readonly="yes">
19769	<desc>
19770	Name of the rule.
19771	</desc>
19772	</attribute>
19773	<attribute name="proto" type="NATProtocol" readonly="yes">
19774	<desc>
19775	Protocol (TCP or UDP) of the redirect rule.
19776	</desc>
19777	</attribute>
19778	<attribute name="hostIP" type="wstring" readonly="yes">
19779	<desc>
19780	Host ip address to bind socket on.
19781	</desc>
19782	</attribute>
19783	<attribute name="hostPort" type="long" readonly="yes">
19784	<desc>
19785	Host port to bind socket on.
19786	</desc>
19787	</attribute>
19788	<attribute name="guestIP" type="wstring" readonly="yes">
19789	<desc>
19790	Guest ip address to redirect to.
19791	</desc>
19792	</attribute>
19793	<attribute name="guestPort" type="long" readonly="yes">
19794	<desc>
19795	Guest port to redirect to.
19796	</desc>
19797	</attribute>
19798	</interface>
19799
19800	<interface
19801	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
19802	waitable="yes"
19803	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
19804	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
19805	>
19806	<desc>
19807	Notification when host PCI device is plugged/unplugged. Plugging
19808	usually takes place on VM startup, unplug - when
19809	<link to="IMachine::detachHostPCIDevice"/> is called.
19810
19811	<see><link to="IMachine::detachHostPCIDevice"/></see>
19812
19813	</desc>
19814
19815	<attribute name="plugged" type="boolean" readonly="yes">
19816	<desc>
19817	If device successfully plugged or unplugged.
19818	</desc>
19819	</attribute>
19820
19821	<attribute name="success" type="boolean" readonly="yes">
19822	<desc>
19823	If operation was successful, if false - 'message' attribute
19824	may be of interest.
19825	</desc>
19826	</attribute>
19827
19828	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
19829	<desc>
19830	Attachment info for this device.
19831	</desc>
19832	</attribute>
19833
19834	<attribute name="message" type="wstring" readonly="yes">
19835	<desc>
19836	Optional error message.
19837	</desc>
19838	</attribute>
19839
19840	</interface>
19841
19842	<interface
19843	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
19844	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
19845	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
19846	>
19847	<desc>
19848	Notification when VBoxSVC becomes unavailable (due to a crash or similar
19849	unexpected circumstances) or available again.
19850	</desc>
19851
19852	<attribute name="available" type="boolean" readonly="yes">
19853	<desc>
19854	Whether VBoxSVC is available now.
19855	</desc>
19856	</attribute>
19857	</interface>
19858
19859	<interface
19860	name="IBandwidthGroupChangedEvent" extends="IEvent"
19861	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
19862	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
19863	>
19864	<desc>
19865	Notification when one of the bandwidth groups changed
19866	</desc>
19867	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
19868	<desc>
19869	The changed bandwidth group.
19870	</desc>
19871	</attribute>
19872	</interface>
19873
19874	<enum
19875	name="GuestMonitorChangedEventType"
19876	uuid="ef172985-7e36-4297-95be-e46396968d66"
19877	>
19878
19879	<desc>
19880	How the guest monitor has been changed.
19881	</desc>
19882
19883	<const name="Enabled" value="0">
19884	<desc>
19885	The guest monitor has been enabled by the guest.
19886	</desc>
19887	</const>
19888
19889	<const name="Disabled" value="1">
19890	<desc>
19891	The guest monitor has been disabled by the guest.
19892	</desc>
19893	</const>
19894
19895	<const name="NewOrigin" value="2">
19896	<desc>
19897	The guest monitor origin has changed in the guest.
19898	</desc>
19899	</const>
19900	</enum>
19901
19902	<interface
19903	name="IGuestMonitorChangedEvent" extends="IEvent"
19904	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
19905	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
19906	>
19907	<desc>
19908	Notification when the guest enables one of its monitors.
19909	</desc>
19910
19911	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
19912	<desc>
19913	What was changed for this guest monitor.
19914	</desc>
19915	</attribute>
19916
19917	<attribute name="screenId" type="unsigned long" readonly="yes">
19918	<desc>
19919	The monitor which was changed.
19920	</desc>
19921	</attribute>
19922
19923	<attribute name="originX" type="unsigned long" readonly="yes">
19924	<desc>
19925	Physical X origin relative to the primary screen.
19926	Valid for Enabled and NewOrigin.
19927	</desc>
19928	</attribute>
19929
19930	<attribute name="originY" type="unsigned long" readonly="yes">
19931	<desc>
19932	Physical Y origin relative to the primary screen.
19933	Valid for Enabled and NewOrigin.
19934	</desc>
19935	</attribute>
19936
19937	<attribute name="width" type="unsigned long" readonly="yes">
19938	<desc>
19939	Width of the screen.
19940	Valid for Enabled.
19941	</desc>
19942	</attribute>
19943
19944	<attribute name="height" type="unsigned long" readonly="yes">
19945	<desc>
19946	Height of the screen.
19947	Valid for Enabled.
19948	</desc>
19949	</attribute>
19950
19951	</interface>
19952
19953	<interface
19954	name="IStorageDeviceChangedEvent" extends="IEvent"
19955	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
19956	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
19957	>
19958	<desc>
19959	Notification when a
19960	<link to="IMachine::mediumAttachments">storage device</link>
19961	is attached or removed.
19962	</desc>
19963	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
19964	<desc>
19965	Storage device that is subject to change.
19966	</desc>
19967	</attribute>
19968	<attribute name="removed" type="boolean" readonly="yes">
19969	<desc>
19970	Flag whether the device was removed or added to the VM.
19971	</desc>
19972	</attribute>
19973	</interface>
19974
19975	<module name="VBoxSVC" context="LocalServer">
19976	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
19977	namespace="virtualbox.org">
19978	<interface name="IVirtualBox" default="yes"/>
19979	</class>
19980	</module>
19981
19982	<module name="VBoxC" context="InprocServer" threadingModel="Free">
19983	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
19984	namespace="virtualbox.org">
19985	<interface name="IVirtualBoxClient" default="yes"/>
19986	</class>
19987
19988	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
19989	namespace="virtualbox.org">
19990	<interface name="ISession" default="yes"/>
19991	</class>
19992	</module>
19993
19994	</library>
19995
19996	</idl>
19997
19998	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format