VirtualBox.xidl@ 42084

Last change on this file since 42084 was 42084, checked in by vboxsync, 13 years ago
Guest Control 2.0: Hacking in progress.
Property svn:eol-style set to `native`
File size: 701.5 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	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490	<const name="v1_13" value="15">
491	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
492	<!--
493	Machine changes: tracing config;
494	-->
495	</const>
496
497	<const name="Future" value="99999">
498	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
499	</const>
500	</enum>
501
502	<enum
503	name="AccessMode"
504	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
505	>
506	<desc>
507	Access mode for opening files.
508	</desc>
509
510	<const name="ReadOnly" value="1"/>
511	<const name="ReadWrite" value="2"/>
512	</enum>
513
514	<enum
515	name="MachineState"
516	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
517	>
518	<desc>
519	Virtual machine execution state.
520
521	This enumeration represents possible values of the <link
522	to="IMachine::state"/> attribute.
523
524	Below is the basic virtual machine state diagram. It shows how the state
525	changes during virtual machine execution. The text in square braces shows
526	a method of the IConsole interface that performs the given state
527	transition.
528
529	<pre>
530	+---------[powerDown()] <- Stuck <--[failure]-+
531	V \|
532	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
533	\| \| \| \| V \|
534	\| Aborted -----+ +--> Running --[pause()]--> Paused
535	\| \| ^ \| ^ \|
536	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
537	\| ^ \| \| \| \|
538	\| \| +-----------------------------------------+-\|-------------------+ +
539	\| \| \| \| \|
540	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
541	\| \| \| \|
542	\| +-------- Saving <--------[saveState()]<----------+---------------------+
543	\| \| \|
544	+-------------- Stopping -------[powerDown()]<----------+---------------------+
545	</pre>
546
547	Note that states to the right from PoweredOff, Aborted and Saved in the
548	above diagram are called <i>online VM states</i>. These states
549	represent the virtual machine which is being executed in a dedicated
550	process (usually with a GUI window attached to it where you can see the
551	activity of the virtual machine and interact with it). There are two
552	special pseudo-states, FirstOnline and LastOnline, that can be used in
553	relational expressions to detect if the given machine state is online or
554	not:
555
556	<pre>
557	if (machine.GetState() >= MachineState_FirstOnline &&
558	machine.GetState() <= MachineState_LastOnline)
559	{
560	...the machine is being executed...
561	}
562	</pre>
563
564	When the virtual machine is in one of the online VM states (that is, being
565	executed), only a few machine settings can be modified. Methods working
566	with such settings contain an explicit note about that. An attempt to
567	change any other setting or perform a modifying operation during this time
568	will result in the @c VBOX_E_INVALID_VM_STATE error.
569
570	All online states except Running, Paused and Stuck are transitional: they
571	represent temporary conditions of the virtual machine that will last as
572	long as the operation that initiated such a condition.
573
574	The Stuck state is a special case. It means that execution of the machine
575	has reached the "Guru Meditation" condition. This condition indicates an
576	internal VMM (virtual machine manager) failure which may happen as a
577	result of either an unhandled low-level virtual hardware exception or one
578	of the recompiler exceptions (such as the <i>too-many-traps</i>
579	condition).
580
581	Note also that any online VM state may transit to the Aborted state. This
582	happens if the process that is executing the virtual machine terminates
583	unexpectedly (for example, crashes). Other than that, the Aborted state is
584	equivalent to PoweredOff.
585
586	There are also a few additional state diagrams that do not deal with
587	virtual machine execution and therefore are shown separately. The states
588	shown on these diagrams are called <i>offline VM states</i> (this includes
589	PoweredOff, Aborted and Saved too).
590
591	The first diagram shows what happens when a lengthy setup operation is
592	being executed (such as <link to="IMachine::attachDevice"/>).
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| \| \|
599	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
600	\| \|
601	+-> Saved -------+
602	</pre>
603
604	The next two diagrams demonstrate the process of taking a snapshot of a
605	powered off virtual machine, restoring the state to that as of a snapshot
606	or deleting a snapshot, respectively.
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| +-->[takeSnapshot()] -------------------> Saving ------+
613	+-> Aborted -----+
614
615	+-> PoweredOff --+
616	\| \|
617	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
618	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
619	+-> Saved -------+ \|
620	\| \|
621	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
622	</pre>
623
624	Note that the Saving state is present in both the offline state group and
625	online state group. Currently, the only way to determine what group is
626	assumed in a particular case is to remember the previous machine state: if
627	it was Running or Paused, then Saving is an online state, otherwise it is
628	an offline state. This inconsistency may be removed in one of the future
629	versions of VirtualBox by adding a new state.
630
631	<note internal="yes">
632	For whoever decides to touch this enum: In order to keep the
633	comparisons involving FirstOnline and LastOnline pseudo-states valid,
634	the numeric values of these states must be correspondingly updated if
635	needed: for any online VM state, the condition
636	<tt>FirstOnline <= state <= LastOnline</tt> must be
637	@c true. The same relates to transient states for which
638	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
639	@c true.
640	</note>
641	</desc>
642
643	<const name="Null" value="0">
644	<desc>Null value (never used by the API).</desc>
645	</const>
646	<const name="PoweredOff" value="1">
647	<desc>
648	The machine is not running and has no saved execution state; it has
649	either never been started or been shut down successfully.
650	</desc>
651	</const>
652	<const name="Saved" value="2">
653	<desc>
654	The machine is not currently running, but the execution state of the machine
655	has been saved to an external file when it was running, from where
656	it can be resumed.
657	</desc>
658	</const>
659	<const name="Teleported" value="3">
660	<desc>
661	The machine was teleported to a different host (or process) and then
662	powered off. Take care when powering it on again may corrupt resources
663	it shares with the teleportation target (e.g. disk and network).
664	</desc>
665	</const>
666	<const name="Aborted" value="4">
667	<desc>
668	The process running the machine has terminated abnormally. This may
669	indicate a crash of the VM process in host execution context, or
670	the VM process has been terminated externally.
671	</desc>
672	</const>
673	<const name="Running" value="5">
674	<desc>
675	The machine is currently being executed.
676	<note internal="yes">
677	For whoever decides to touch this enum: In order to keep the
678	comparisons in the old source code valid, this state must immediately
679	precede the Paused state.
680	TODO: Lift this spectacularly wonderful restriction.
681	</note>
682	</desc>
683	</const>
684	<const name="Paused" value="6">
685	<desc>
686	Execution of the machine has been paused.
687	<note internal="yes">
688	For whoever decides to touch this enum: In order to keep the
689	comparisons in the old source code valid, this state must immediately
690	follow the Running state.
691	TODO: Lift this spectacularly wonderful restriction.
692	</note>
693	</desc>
694	</const>
695	<const name="Stuck" value="7">
696	<desc>
697	Execution of the machine has reached the "Guru Meditation"
698	condition. This indicates a severe error in the hypervisor itself.
699	<note internal="yes">
700	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
701	"Guru", perhaps? Or are there some other VMM states that are
702	intended to be lumped in here as well?
703	</note>
704	</desc>
705	</const>
706	<const name="Teleporting" value="8">
707	<desc>
708	The machine is about to be teleported to a different host or process.
709	It is possible to pause a machine in this state, but it will go to the
710	@c TeleportingPausedVM state and it will not be
711	possible to resume it again unless the teleportation fails.
712	</desc>
713	</const>
714	<const name="LiveSnapshotting" value="9">
715	<desc>
716	A live snapshot is being taken. The machine is running normally, but
717	some of the runtime configuration options are inaccessible. Also, if
718	paused while in this state it will transition to
719	@c Saving and it will not be resume the
720	execution until the snapshot operation has completed.
721	</desc>
722	</const>
723	<const name="Starting" value="10">
724	<desc>
725	Machine is being started after powering it on from a
726	zero execution state.
727	</desc>
728	</const>
729	<const name="Stopping" value="11">
730	<desc>
731	Machine is being normally stopped powering it off, or after the guest OS
732	has initiated a shutdown sequence.
733	</desc>
734	</const>
735	<const name="Saving" value="12">
736	<desc>
737	Machine is saving its execution state to a file, or an online
738	snapshot of the machine is being taken.
739	</desc>
740	</const>
741	<const name="Restoring" value="13">
742	<desc>
743	Execution state of the machine is being restored from a file
744	after powering it on from the saved execution state.
745	</desc>
746	</const>
747	<const name="TeleportingPausedVM" value="14">
748	<desc>
749	The machine is being teleported to another host or process, but it is
750	not running. This is the paused variant of the
751	@c state.
752	</desc>
753	</const>
754	<const name="TeleportingIn" value="15">
755	<desc>
756	Teleporting the machine state in from another host or process.
757	</desc>
758	</const>
759	<const name="FaultTolerantSyncing" value="16">
760	<desc>
761	The machine is being synced with a fault tolerant VM running elsewhere.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotOnline" value="17">
765	<desc>
766	Like @c DeletingSnapshot, but the merging of media is ongoing in
767	the background while the machine is running.
768	</desc>
769	</const>
770	<const name="DeletingSnapshotPaused" value="18">
771	<desc>
772	Like @c DeletingSnapshotOnline, but the machine was paused when the
773	merging of differencing media was started.
774	</desc>
775	</const>
776	<const name="RestoringSnapshot" value="19">
777	<desc>
778	A machine snapshot is being restored; this typically does not take long.
779	</desc>
780	</const>
781	<const name="DeletingSnapshot" value="20">
782	<desc>
783	A machine snapshot is being deleted; this can take a long time since this
784	may require merging differencing media. This value indicates that the
785	machine is not running while the snapshot is being deleted.
786	</desc>
787	</const>
788	<const name="SettingUp" value="21">
789	<desc>
790	Lengthy setup operation is in progress.
791	</desc>
792	</const>
793
794	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
795	<desc>
796	Pseudo-state: first online state (for use in relational expressions).
797	</desc>
798	</const>
799	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
800	<desc>
801	Pseudo-state: last online state (for use in relational expressions).
802	</desc>
803	</const>
804
805	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
806	<desc>
807	Pseudo-state: first transient state (for use in relational expressions).
808	</desc>
809	</const>
810	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
811	<desc>
812	Pseudo-state: last transient state (for use in relational expressions).
813	</desc>
814	</const>
815
816	</enum>
817
818	<enum
819	name="SessionState"
820	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
821	>
822	<desc>
823	Session state. This enumeration represents possible values of
824	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
825	attributes.
826	</desc>
827
828	<const name="Null" value="0">
829	<desc>Null value (never used by the API).</desc>
830	</const>
831	<const name="Unlocked" value="1">
832	<desc>
833	In <link to="IMachine::sessionState"/>, this means that the machine
834	is not locked for any sessions.
835
836	In <link to="ISession::state"/>, this means that no machine is
837	currently locked for this session.
838	</desc>
839	</const>
840	<const name="Locked" value="2">
841	<desc>
842	In <link to="IMachine::sessionState"/>, this means that the machine
843	is currently locked for a session, whose process identifier can
844	then be found in the <link to="IMachine::sessionPid" /> attribute.
845
846	In <link to="ISession::state"/>, this means that a machine is
847	currently locked for this session, and the mutable machine object
848	can be found in the <link to="ISession::machine"/> attribute
849	(see <link to="IMachine::lockMachine" /> for details).
850	</desc>
851	</const>
852	<const name="Spawning" value="3">
853	<desc>
854	A new process is being spawned for the machine as a result of
855	<link to="IMachine::launchVMProcess"/> call. This state also occurs
856	as a short transient state during an <link to="IMachine::lockMachine"/>
857	call.
858	</desc>
859	</const>
860	<const name="Unlocking" value="4">
861	<desc>
862	The session is being unlocked.
863	</desc>
864	</const>
865	</enum>
866
867	<enum
868	name="CPUPropertyType"
869	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
870	>
871	<desc>
872	Virtual CPU property type. This enumeration represents possible values of the
873	IMachine get- and setCPUProperty methods.
874	</desc>
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="PAE" value="1">
879	<desc>
880	This setting determines whether VirtualBox will expose the Physical Address
881	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
882	is not available, it will not be reported.
883	</desc>
884	</const>
885	<const name="Synthetic" value="2">
886	<desc>
887	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
888	teleporting between host systems that differ significantly.
889	</desc>
890	</const>
891	</enum>
892
893
894	<enum
895	name="HWVirtExPropertyType"
896	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
897	>
898	<desc>
899	Hardware virtualization property type. This enumeration represents possible values
900	for the <link to="IMachine::getHWVirtExProperty"/> and
901	<link to="IMachine::setHWVirtExProperty"/> methods.
902	</desc>
903	<const name="Null" value="0">
904	<desc>Null value (never used by the API).</desc>
905	</const>
906	<const name="Enabled" value="1">
907	<desc>
908	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
909	such extensions are not available, they will not be used.
910	</desc>
911	</const>
912	<const name="Exclusive" value="2">
913	<desc>
914	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
915	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
916	feature of the host. To share these with other hypervisors, you must disable this property.
917	</desc>
918	</const>
919	<const name="VPID" value="3">
920	<desc>
921	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
922	</desc>
923	</const>
924	<const name="NestedPaging" value="4">
925	<desc>
926	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
927	</desc>
928	</const>
929	<const name="LargePages" value="5">
930	<desc>
931	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
932	</desc>
933	</const>
934	<const name="Force" value="6">
935	<desc>
936	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
937	not set, there will be an automatic fallback to software virtualization.
938	</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="FaultToleranceState"
944	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
945	>
946	<desc>
947	Used with <link to="IMachine::faultToleranceState" />.
948	</desc>
949	<const name="Inactive" value="1">
950	<desc>No fault tolerance enabled.</desc>
951	</const>
952	<const name="Master" value="2">
953	<desc>Fault tolerant master VM.</desc>
954	</const>
955	<const name="Standby" value="3">
956	<desc>Fault tolerant standby VM.</desc>
957	</const>
958	</enum>
959
960	<enum
961	name="LockType"
962	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
963	>
964	<desc>
965	Used with <link to="IMachine::lockMachine" />.
966	</desc>
967	<const name="Write" value="2">
968	<desc>Lock the machine for writing.</desc>
969	</const>
970	<const name="Shared" value="1">
971	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
972	</const>
973	</enum>
974
975	<enum
976	name="SessionType"
977	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
978	>
979	<desc>
980	Session type. This enumeration represents possible values of the
981	<link to="ISession::type"/> attribute.
982	</desc>
983
984	<const name="Null" value="0">
985	<desc>Null value (never used by the API).</desc>
986	</const>
987	<const name="WriteLock" value="1">
988	<desc>
989	Session has acquired an exclusive write lock on a machine
990	using <link to="IMachine::lockMachine"/>.
991	</desc>
992	</const>
993	<const name="Remote" value="2">
994	<desc>
995	Session has launched a VM process using
996	<link to="IMachine::launchVMProcess"/>
997	</desc>
998	</const>
999	<const name="Shared" value="3">
1000	<desc>
1001	Session has obtained a link to another session using
1002	<link to="IMachine::lockMachine"/>
1003	</desc>
1004	</const>
1005	</enum>
1006
1007	<enum
1008	name="DeviceType"
1009	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1010	>
1011	<desc>
1012	Device type.
1013	</desc>
1014	<const name="Null" value="0">
1015	<desc>
1016	Null value, may also mean "no device" (not allowed for
1017	<link to="IConsole::getDeviceActivity"/>).
1018	</desc>
1019	</const>
1020	<const name="Floppy" value="1">
1021	<desc>Floppy device.</desc>
1022	</const>
1023	<const name="DVD" value="2">
1024	<desc>CD/DVD-ROM device.</desc>
1025	</const>
1026	<const name="HardDisk" value="3">
1027	<desc>Hard disk device.</desc>
1028	</const>
1029	<const name="Network" value="4">
1030	<desc>Network device.</desc>
1031	</const>
1032	<const name="USB" value="5">
1033	<desc>USB device.</desc>
1034	</const>
1035	<const name="SharedFolder" value="6">
1036	<desc>Shared folder device.</desc>
1037	</const>
1038	</enum>
1039
1040	<enum
1041	name="DeviceActivity"
1042	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1043	>
1044	<desc>
1045	Device activity for <link to="IConsole::getDeviceActivity"/>.
1046	</desc>
1047
1048	<const name="Null" value="0"/>
1049	<const name="Idle" value="1"/>
1050	<const name="Reading" value="2"/>
1051	<const name="Writing" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="ClipboardMode"
1056	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1057	>
1058	<desc>
1059	Host-Guest clipboard interchange mode.
1060	</desc>
1061
1062	<const name="Disabled" value="0"/>
1063	<const name="HostToGuest" value="1"/>
1064	<const name="GuestToHost" value="2"/>
1065	<const name="Bidirectional" value="3"/>
1066	</enum>
1067
1068	<enum
1069	name="Scope"
1070	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1071	>
1072	<desc>
1073	Scope of the operation.
1074
1075	A generic enumeration used in various methods to define the action or
1076	argument scope.
1077	</desc>
1078
1079	<const name="Global" value="0"/>
1080	<const name="Machine" value="1"/>
1081	<const name="Session" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="BIOSBootMenuMode"
1086	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1087	>
1088	<desc>
1089	BIOS boot menu mode.
1090	</desc>
1091
1092	<const name="Disabled" value="0"/>
1093	<const name="MenuOnly" value="1"/>
1094	<const name="MessageAndMenu" value="2"/>
1095	</enum>
1096
1097	<enum
1098	name="ProcessorFeature"
1099	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1100	>
1101	<desc>
1102	CPU features.
1103	</desc>
1104
1105	<const name="HWVirtEx" value="0"/>
1106	<const name="PAE" value="1"/>
1107	<const name="LongMode" value="2"/>
1108	<const name="NestedPaging" value="3"/>
1109	</enum>
1110
1111	<enum
1112	name="FirmwareType"
1113	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1114	>
1115	<desc>
1116	Firmware type.
1117	</desc>
1118	<const name="BIOS" value="1">
1119	<desc>BIOS Firmware.</desc>
1120	</const>
1121	<const name="EFI" value="2">
1122	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1123	</const>
1124	<const name="EFI32" value="3">
1125	<desc>Efi firmware, 32-bit.</desc>
1126	</const>
1127	<const name="EFI64" value="4">
1128	<desc>Efi firmware, 64-bit.</desc>
1129	</const>
1130	<const name="EFIDUAL" value="5">
1131	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1132	</const>
1133	</enum>
1134
1135	<enum
1136	name="PointingHidType"
1137	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1138	>
1139	<desc>
1140	Type of pointing device used in a virtual machine.
1141	</desc>
1142	<const name="None" value="1">
1143	<desc>No mouse.</desc>
1144	</const>
1145	<const name="PS2Mouse" value="2">
1146	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1147	</const>
1148	<const name="USBMouse" value="3">
1149	<desc>USB mouse (relative pointer).</desc>
1150	</const>
1151	<const name="USBTablet" value="4">
1152	<desc>USB tablet (absolute pointer).</desc>
1153	</const>
1154	<const name="ComboMouse" value="5">
1155	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1156	Using of such device can have negative performance implications. </desc>
1157	</const>
1158	</enum>
1159
1160	<enum
1161	name="KeyboardHidType"
1162	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1163	>
1164	<desc>
1165	Type of keyboard device used in a virtual machine.
1166	</desc>
1167	<const name="None" value="1">
1168	<desc>No keyboard.</desc>
1169	</const>
1170	<const name="PS2Keyboard" value="2">
1171	<desc>PS/2 keyboard.</desc>
1172	</const>
1173	<const name="USBKeyboard" value="3">
1174	<desc>USB keyboard.</desc>
1175	</const>
1176	<const name="ComboKeyboard" value="4">
1177	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1178	Using of such device can have negative performance implications. </desc>
1179	</const>
1180	</enum>
1181
1182	<!--
1183	// IVirtualBoxErrorInfo
1184	/////////////////////////////////////////////////////////////////////////
1185	-->
1186
1187	<interface
1188	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1189	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1190	supportsErrorInfo="no"
1191	wsmap="managed"
1192	>
1193	<desc>
1194	The IVirtualBoxErrorInfo interface represents extended error information.
1195
1196	Extended error information can be set by VirtualBox components after
1197	unsuccessful or partially successful method invocation. This information
1198	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1199	and then shown to the client in addition to the plain 32-bit result code.
1200
1201	In MS COM, this interface extends the IErrorInfo interface,
1202	in XPCOM, it extends the nsIException interface. In both cases,
1203	it provides a set of common attributes to retrieve error
1204	information.
1205
1206	Sometimes invocation of some component's method may involve methods of
1207	other components that may also fail (independently of this method's
1208	failure), or a series of non-fatal errors may precede a fatal error that
1209	causes method failure. In cases like that, it may be desirable to preserve
1210	information about all errors happened during method invocation and deliver
1211	it to the caller. The <link to="#next"/> attribute is intended
1212	specifically for this purpose and allows to represent a chain of errors
1213	through a single IVirtualBoxErrorInfo object set after method invocation.
1214
1215	<note>errors are stored to a chain in the reverse order, i.e. the
1216	initial error object you query right after method invocation is the last
1217	error set by the callee, the object it points to in the @a next attribute
1218	is the previous error and so on, up to the first error (which is the last
1219	in the chain).</note>
1220	</desc>
1221
1222	<attribute name="resultCode" type="long" readonly="yes">
1223	<desc>
1224	Result code of the error.
1225	Usually, it will be the same as the result code returned
1226	by the method that provided this error information, but not
1227	always. For example, on Win32, CoCreateInstance() will most
1228	likely return E_NOINTERFACE upon unsuccessful component
1229	instantiation attempt, but not the value the component factory
1230	returned. Value is typed 'long', not 'result',
1231	to make interface usable from scripting languages.
1232	<note>
1233	In MS COM, there is no equivalent.
1234	In XPCOM, it is the same as nsIException::result.
1235	</note>
1236	</desc>
1237	</attribute>
1238
1239	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1240	<desc>
1241	UUID of the interface that defined the error.
1242	<note>
1243	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1244	data type.
1245	In XPCOM, there is no equivalent.
1246	</note>
1247	</desc>
1248	</attribute>
1249
1250	<attribute name="component" type="wstring" readonly="yes">
1251	<desc>
1252	Name of the component that generated the error.
1253	<note>
1254	In MS COM, it is the same as IErrorInfo::GetSource.
1255	In XPCOM, there is no equivalent.
1256	</note>
1257	</desc>
1258	</attribute>
1259
1260	<attribute name="text" type="wstring" readonly="yes">
1261	<desc>
1262	Text description of the error.
1263	<note>
1264	In MS COM, it is the same as IErrorInfo::GetDescription.
1265	In XPCOM, it is the same as nsIException::message.
1266	</note>
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1271	<desc>
1272	Next error object if there is any, or @c null otherwise.
1273	<note>
1274	In MS COM, there is no equivalent.
1275	In XPCOM, it is the same as nsIException::inner.
1276	</note>
1277	</desc>
1278	</attribute>
1279
1280	</interface>
1281
1282	<!--
1283	// IVirtualBox
1284	/////////////////////////////////////////////////////////////////////////
1285	-->
1286
1287	<interface
1288	name="IDHCPServer" extends="$unknown"
1289	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1290	wsmap="managed"
1291	>
1292	<desc>
1293	The IDHCPServer interface represents the vbox dhcp server configuration.
1294
1295	To enumerate all the dhcp servers on the host, use the
1296	<link to="IVirtualBox::DHCPServers"/> attribute.
1297	</desc>
1298
1299	<attribute name="enabled" type="boolean">
1300	<desc>
1301	specifies if the dhcp server is enabled
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="IPAddress" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server IP
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkMask" type="wstring" readonly="yes">
1312	<desc>
1313	specifies server network mask
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="networkName" type="wstring" readonly="yes">
1318	<desc>
1319	specifies internal network name the server is used for
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="lowerIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies from IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<attribute name="upperIP" type="wstring" readonly="yes">
1330	<desc>
1331	specifies to IP address in server address range
1332	</desc>
1333	</attribute>
1334
1335	<method name="setConfiguration">
1336	<desc>
1337	configures the server
1338	<result name="E_INVALIDARG">
1339	invalid configuration supplied
1340	</result>
1341	</desc>
1342	<param name="IPAddress" type="wstring" dir="in">
1343	<desc>
1344	server IP address
1345	</desc>
1346	</param>
1347	<param name="networkMask" type="wstring" dir="in">
1348	<desc>
1349	server network mask
1350	</desc>
1351	</param>
1352	<param name="FromIPAddress" type="wstring" dir="in">
1353	<desc>
1354	server From IP address for address range
1355	</desc>
1356	</param>
1357	<param name="ToIPAddress" type="wstring" dir="in">
1358	<desc>
1359	server To IP address for address range
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="start">
1365	<desc>
1366	Starts DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to start the process.
1369	</result>
1370	</desc>
1371	<param name="networkName" type="wstring" dir="in">
1372	<desc>
1373	Name of internal network DHCP server should attach to.
1374	</desc>
1375	</param>
1376	<param name="trunkName" type="wstring" dir="in">
1377	<desc>
1378	Name of internal network trunk.
1379	</desc>
1380	</param>
1381	<param name="trunkType" type="wstring" dir="in">
1382	<desc>
1383	Type of internal network trunk.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="stop">
1389	<desc>
1390	Stops DHCP server process.
1391	<result name="E_FAIL">
1392	Failed to stop the process.
1393	</result>
1394	</desc>
1395	</method>
1396	</interface>
1397
1398	<interface
1399	name="IVirtualBox" extends="$unknown"
1400	uuid="867664ba-41ce-4099-a10d-b7a8e34057c7"
1401	wsmap="managed"
1402	>
1403	<desc>
1404	The IVirtualBox interface represents the main interface exposed by the
1405	product that provides virtual machine management.
1406
1407	An instance of IVirtualBox is required for the product to do anything
1408	useful. Even though the interface does not expose this, internally,
1409	IVirtualBox is implemented as a singleton and actually lives in the
1410	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1411	IVirtualBox can track the state of all virtual machines on a particular
1412	host, regardless of which frontend started them.
1413
1414	To enumerate all the virtual machines on the host, use the
1415	<link to="IVirtualBox::machines"/> attribute.
1416	</desc>
1417
1418	<attribute name="version" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the version number of the product. The
1421	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1422	last number represents the build number and will frequently change.
1423
1424	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1425	in prerelease builds. Non-Oracle builds may (/shall) also have a
1426	publisher tag, at the end. The publisher tag starts with an underscore
1427	just like the prerelease build type tag.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="revision" type="unsigned long" readonly="yes">
1432	<desc>
1433	The internal build revision number of the product.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="packageType" type="wstring" readonly="yes">
1438	<desc>
1439	A string representing the package type of this product. The
1440	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1441	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1442	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1443	this.
1444	</desc>
1445	</attribute>
1446
1447	<attribute name="APIVersion" type="wstring" readonly="yes">
1448	<desc>
1449	A string representing the VirtualBox API version number. The format is
1450	2 integer numbers divided by an underscore (e.g. 1_0). After the
1451	first public release of packages with a particular API version the
1452	API will not be changed in an incompatible way. Note that this
1453	guarantee does not apply to development builds, and also there is no
1454	guarantee that this version is identical to the first two integer
1455	numbers of the package version.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="homeFolder" type="wstring" readonly="yes">
1460	<desc>
1461	Full path to the directory where the global settings file,
1462	<tt>VirtualBox.xml</tt>, is stored.
1463
1464	In this version of VirtualBox, the value of this property is
1465	always <tt><user_dir>/.VirtualBox</tt> (where
1466	<tt><user_dir></tt> is the path to the user directory,
1467	as determined by the host OS), and cannot be changed.
1468
1469	This path is also used as the base to resolve relative paths in
1470	places where relative paths are allowed (unless otherwise
1471	expressly indicated).
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1476	<desc>
1477	Full name of the global settings file.
1478	The value of this property corresponds to the value of
1479	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="host" type="IHost" readonly="yes">
1484	<desc>Associated host object.</desc>
1485	</attribute>
1486
1487	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1488	<desc>Associated system information object.</desc>
1489	</attribute>
1490
1491	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of machine objects registered within this VirtualBox instance.
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1498	<desc>
1499	Array of medium objects known to this VirtualBox installation.
1500
1501	This array contains only base media. All differencing
1502	media of the given base medium can be enumerated using
1503	<link to="IMedium::children"/>.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1514	<desc>
1515	Array of floppy image objects currently in use by this VirtualBox instance.
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1520
1521	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1522
1523	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1524	<desc>
1525	Collection of global shared folders. Global shared folders are
1526	available to all virtual machines.
1527
1528	New shared folders are added to the collection using
1529	<link to="#createSharedFolder"/>. Existing shared folders can be
1530	removed using <link to="#removeSharedFolder"/>.
1531
1532	<note>
1533	In the current version of the product, global shared folders are not
1534	implemented and therefore this collection is always empty.
1535	</note>
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1540	<desc>
1541	Associated performance collector object.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1546	<desc>
1547	DHCP servers.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="eventSource" type="IEventSource" readonly="yes">
1552	<desc>
1553	Event source for VirtualBox events.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1558	<desc>
1559	The extension pack manager.
1560	</desc>
1561	</attribute>
1562
1563
1564	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all internal networks.
1567	</desc>
1568	</attribute>
1569
1570	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1571	<desc>
1572	Names of all generic network drivers.
1573	</desc>
1574	</attribute>
1575
1576	<method name="composeMachineFilename">
1577	<desc>
1578	Returns a recommended full path of the settings file name for a new virtual
1579	machine.
1580
1581	This API serves two purposes:
1582
1583	<ul>
1584	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1585	for the @a settingsFile argument there, which means that API should use
1586	a recommended default file name.</li>
1587
1588	<li>It can be called manually by a client software before creating a machine,
1589	e.g. if that client wants to pre-create the machine directory to create
1590	virtual hard disks in that directory together with the new machine
1591	settings file. In that case, the file name should be stripped from the
1592	full settings file path returned by this function to obtain the
1593	machine directory.</li>
1594	</ul>
1595
1596	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1597	details about the machine name.
1598
1599	If @a baseFolder is a @c null or empty string (which is recommended), the
1600	default machine settings folder
1601	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1602	a base folder for the created machine, resulting in a file name like
1603	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1604	will be used.
1605
1606	This method does not access the host disks. In particular, it does not check
1607	for whether a machine of this name already exists.
1608	</desc>
1609	<param name="name" type="wstring" dir="in">
1610	<desc>Suggested machine name.</desc>
1611	</param>
1612	<param name="baseFolder" type="wstring" dir="in">
1613	<desc>Base machine folder (optional).</desc>
1614	</param>
1615	<param name="file" type="wstring" dir="return">
1616	<desc>Fully qualified path where the machine would be created.</desc>
1617	</param>
1618	</method>
1619
1620	<method name="createMachine">
1621	<desc>
1622	Creates a new virtual machine by creating a machine settings file at
1623	the given location.
1624
1625	VirtualBox machine settings files use a custom XML dialect. Starting
1626	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1627	and machine files can be created at arbitrary locations.
1628
1629	However, it is is recommended that machines be created in the default
1630	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1631	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1632	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1633	is called automatically to have such a recommended name composed based
1634	on the machine name given in the @a name argument.
1635
1636	If the resulting settings file already exists, this method will fail,
1637	unless @a forceOverwrite is set.
1638
1639	The new machine is created unregistered, with the initial configuration
1640	set according to the specified guest OS type. A typical sequence of
1641	actions to create a new virtual machine is as follows:
1642
1643	<ol>
1644	<li>
1645	Call this method to have a new machine created. The returned machine
1646	object will be "mutable" allowing to change any machine property.
1647	</li>
1648
1649	<li>
1650	Configure the machine using the appropriate attributes and methods.
1651	</li>
1652
1653	<li>
1654	Call <link to="IMachine::saveSettings" /> to write the settings
1655	to the machine's XML settings file. The configuration of the newly
1656	created machine will not be saved to disk until this method is
1657	called.
1658	</li>
1659
1660	<li>
1661	Call <link to="#registerMachine" /> to add the machine to the list
1662	of machines known to VirtualBox.
1663	</li>
1664	</ol>
1665
1666	The specified guest OS type identifier must match an ID of one of known
1667	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1668	array.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>Fully qualified path where the settings file should be created,
1695	or NULL for a default folder and file based on the @a name argument
1696	(see <link to="#composeMachineFilename" />).</desc>
1697	</param>
1698	<param name="name" type="wstring" dir="in">
1699	<desc>Machine name.</desc>
1700	</param>
1701	<param name="osTypeId" type="wstring" dir="in">
1702	<desc>Guest OS Type ID.</desc>
1703	</param>
1704	<param name="id" type="uuid" mod="string" dir="in">
1705	<desc>Machine UUID (optional).</desc>
1706	</param>
1707	<param name="forceOverwrite" type="boolean" dir="in">
1708	<desc>If true, an existing machine settings file will be overwritten.</desc>
1709	</param>
1710	<param name="machine" type="IMachine" dir="return">
1711	<desc>Created machine object.</desc>
1712	</param>
1713	</method>
1714
1715	<method name="openMachine">
1716	<desc>
1717	Opens a virtual machine from the existing settings file.
1718	The opened machine remains unregistered until you call
1719	<link to="#registerMachine"/>.
1720
1721	The specified settings file name must be fully qualified.
1722	The file must exist and be a valid machine XML settings file
1723	whose contents will be used to construct the machine object.
1724
1725	<result name="VBOX_E_FILE_ERROR">
1726	Settings file name invalid, not found or sharing violation.
1727	</result>
1728	</desc>
1729	<param name="settingsFile" type="wstring" dir="in">
1730	<desc>
1731	Name of the machine settings file.
1732	</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Opened machine object.</desc>
1736	</param>
1737	<note>
1738	<link to="IMachine::settingsModified"/> will return
1739	@c false for the created machine, until any of machine settings
1740	are changed.
1741	</note>
1742	</method>
1743
1744	<method name="registerMachine">
1745	<desc>
1746
1747	Registers the machine previously created using
1748	<link to="#createMachine"/> or opened using
1749	<link to="#openMachine"/> within this VirtualBox installation. After
1750	successful method invocation, the
1751	<link to="IMachineRegisteredEvent"/> event is fired.
1752
1753	<note>
1754	This method implicitly calls <link to="IMachine::saveSettings"/>
1755	to save all current machine settings before registering it.
1756	</note>
1757
1758	<result name="VBOX_E_OBJECT_NOT_FOUND">
1759	No matching virtual machine found.
1760	</result>
1761	<result name="VBOX_E_INVALID_OBJECT_STATE">
1762	Virtual machine was not created within this VirtualBox instance.
1763	</result>
1764
1765	</desc>
1766	<param name="machine" type="IMachine" dir="in"/>
1767	</method>
1768
1769	<method name="findMachine">
1770	<desc>
1771	Attempts to find a virtual machine given its name or UUID.
1772
1773	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1774	cannot safely be determined.</note>
1775
1776	<result name="VBOX_E_OBJECT_NOT_FOUND">
1777	Could not find registered machine matching @a nameOrId.
1778	</result>
1779
1780	</desc>
1781	<param name="nameOrId" type="wstring" dir="in">
1782	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1783	</param>
1784	<param name="machine" type="IMachine" dir="return">
1785	<desc>Machine object, if found.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="getMachineStates">
1790	<desc>
1791	Gets the state of several machines in a single operation.
1792	</desc>
1793	<param name="machines" type="IMachine" dir="in" safearray="yes">
1794	<desc>Array with the machine references.</desc>
1795	</param>
1796	<param name="states" type="MachineState" dir="return" safearray="yes">
1797	<desc>Machine states, corresponding to the machines.</desc>
1798	</param>
1799	</method>
1800
1801	<method name="createAppliance">
1802	<desc>
1803	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1804	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1805	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1806	</desc>
1807	<param name="appliance" type="IAppliance" dir="return">
1808	<desc>New appliance.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="createHardDisk">
1813	<desc>
1814	Creates a new base medium object that will use the given storage
1815	format and location for medium data.
1816
1817	The actual storage unit is not created by this method. In order to
1818	do it, and before you are able to attach the created medium to
1819	virtual machines, you must call one of the following methods to
1820	allocate a format-specific storage unit at the specified location:
1821	<ul>
1822	<li><link to="IMedium::createBaseStorage"/></li>
1823	<li><link to="IMedium::createDiffStorage"/></li>
1824	</ul>
1825
1826	Some medium attributes, such as <link to="IMedium::id"/>, may
1827	remain uninitialized until the medium storage unit is successfully
1828	created by one of the above methods.
1829
1830	After the storage unit is successfully created, it will be
1831	accessible through the <link to="#openMedium"/> method and can
1832	be found in the <link to="#hardDisks"/> array.
1833
1834	The list of all storage formats supported by this VirtualBox
1835	installation can be obtained using
1836	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1837	attribute is empty or @c null then the default storage format
1838	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1839	be used for creating a storage unit of the medium.
1840
1841	Note that the format of the location string is storage format specific.
1842	See <link to="IMedium::location"/> and IMedium for more details.
1843
1844	<result name="VBOX_E_OBJECT_NOT_FOUND">
1845	@a format identifier is invalid. See
1846	<link to="ISystemProperties::mediumFormats"/>.
1847	</result>
1848	<result name="VBOX_E_FILE_ERROR">
1849	@a location is a not valid file name (for file-based formats only).
1850	</result>
1851	</desc>
1852	<param name="format" type="wstring" dir="in">
1853	<desc>
1854	Identifier of the storage format to use for the new medium.
1855	</desc>
1856	</param>
1857	<param name="location" type="wstring" dir="in">
1858	<desc>
1859	Location of the storage unit for the new medium.
1860	</desc>
1861	</param>
1862	<param name="medium" type="IMedium" dir="return">
1863	<desc>Created medium object.</desc>
1864	</param>
1865	</method>
1866
1867	<method name="openMedium">
1868	<desc>
1869	Finds existing media or opens a medium from an existing storage location.
1870
1871	Once a medium has been opened, it can be passed to other VirtualBox
1872	methods, in particular to <link to="IMachine::attachDevice" />.
1873
1874	Depending on the given device type, the file at the storage location
1875	must be in one of the media formats understood by VirtualBox:
1876
1877	<ul>
1878	<li>With a "HardDisk" device type, the file must be a hard disk image
1879	in one of the formats supported by VirtualBox (see
1880	<link to="ISystemProperties::mediumFormats" />).
1881	After this method succeeds, if the medium is a base medium, it
1882	will be added to the <link to="#hardDisks"/> array attribute. </li>
1883	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1884	After this method succeeds, the medium will be added to the
1885	<link to="#DVDImages"/> array attribute.</li>
1886	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1887	After this method succeeds, the medium will be added to the
1888	<link to="#floppyImages"/> array attribute.</li>
1889	</ul>
1890
1891	After having been opened, the medium can be re-found by this method
1892	and can be attached to virtual machines. See <link to="IMedium" /> for
1893	more details.
1894
1895	The UUID of the newly opened medium will either be retrieved from the
1896	storage location, if the format supports it (e.g. for hard disk images),
1897	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1898	If for some reason you need to change the medium's UUID, use
1899	<link to="IMedium::setIDs" />.
1900
1901	If a differencing hard disk medium is to be opened by this method, the
1902	operation will succeed only if its parent medium and all ancestors,
1903	if any, are already known to this VirtualBox installation (for example,
1904	were opened by this method before).
1905
1906	This method attempts to guess the storage format of the specified medium
1907	by reading medium data at the specified location.
1908
1909	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1910	the image is opened for read/write access and must have according permissions,
1911	as VirtualBox may actually write status information into the disk's metadata
1912	sections.
1913
1914	Note that write access is required for all typical hard disk usage in VirtualBox,
1915	since VirtualBox may need to write metadata such as a UUID into the image.
1916	The only exception is opening a source image temporarily for copying and
1917	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1918	again soon.
1919
1920	The format of the location string is storage format specific. See
1921	<link to="IMedium::location"/> and IMedium for more details.
1922
1923	<result name="VBOX_E_FILE_ERROR">
1924	Invalid medium storage file location or could not find the medium
1925	at the specified location.
1926	</result>
1927	<result name="VBOX_E_IPRT_ERROR">
1928	Could not get medium storage format.
1929	</result>
1930	<result name="E_INVALIDARG">
1931	Invalid medium storage format.
1932	</result>
1933	<result name="VBOX_E_INVALID_OBJECT_STATE">
1934	Medium has already been added to a media registry.
1935	</result>
1936	</desc>
1937	<param name="location" type="wstring" dir="in">
1938	<desc>
1939	Location of the storage unit that contains medium data in one of
1940	the supported storage formats.
1941	</desc>
1942	</param>
1943	<param name="deviceType" type="DeviceType" dir="in">
1944	<desc>
1945	Must be one of "HardDisk", "DVD" or "Floppy".
1946	</desc>
1947	</param>
1948	<param name="accessMode" type="AccessMode" dir="in">
1949	<desc>Whether to open the image in read/write or read-only mode. For
1950	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1951	</param>
1952	<param name="forceNewUuid" type="boolean" dir="in">
1953	<desc>Allows the caller to request a completely new medium UUID for
1954	the image which is to be opened. Useful if one intends to open an exact
1955	copy of a previously opened image, as this would normally fail due to
1956	the duplicate UUID.</desc>
1957	</param>
1958	<param name="medium" type="IMedium" dir="return">
1959	<desc>Opened medium object.</desc>
1960	</param>
1961	</method>
1962
1963	<method name="getGuestOSType">
1964	<desc>
1965	Returns an object describing the specified guest OS type.
1966
1967	The requested guest OS type is specified using a string which is a
1968	mnemonic identifier of the guest operating system, such as
1969	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1970	particular virtual machine can be read or set using the
1971	<link to="IMachine::OSTypeId"/> attribute.
1972
1973	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1974	available guest OS type objects. Each object has an
1975	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1976	the guest OS this object describes.
1977
1978	<result name="E_INVALIDARG">
1979	@a id is not a valid Guest OS type.
1980	</result>
1981
1982	</desc>
1983	<param name="id" type="uuid" mod="string" dir="in">
1984	<desc>Guest OS type ID string.</desc>
1985	</param>
1986	<param name="type" type="IGuestOSType" dir="return">
1987	<desc>Guest OS type object.</desc>
1988	</param>
1989	</method>
1990
1991	<method name="createSharedFolder">
1992	<desc>
1993	Creates a new global shared folder by associating the given logical
1994	name with the given host path, adds it to the collection of shared
1995	folders and starts sharing it. Refer to the description of
1996	<link to="ISharedFolder"/> to read more about logical names.
1997	<note>
1998	In the current implementation, this operation is not
1999	implemented.
2000	</note>
2001	</desc>
2002	<param name="name" type="wstring" dir="in">
2003	<desc>Unique logical name of the shared folder.</desc>
2004	</param>
2005	<param name="hostPath" type="wstring" dir="in">
2006	<desc>Full path to the shared folder in the host file system.</desc>
2007	</param>
2008	<param name="writable" type="boolean" dir="in">
2009	<desc>Whether the share is writable or readonly</desc>
2010	</param>
2011	<param name="automount" type="boolean" dir="in">
2012	<desc>Whether the share gets automatically mounted by the guest
2013	or not.</desc>
2014	</param>
2015	</method>
2016
2017	<method name="removeSharedFolder">
2018	<desc>
2019	Removes the global shared folder with the given name previously
2020	created by <link to="#createSharedFolder"/> from the collection of
2021	shared folders and stops sharing it.
2022	<note>
2023	In the current implementation, this operation is not
2024	implemented.
2025	</note>
2026	</desc>
2027	<param name="name" type="wstring" dir="in">
2028	<desc>Logical name of the shared folder to remove.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="getExtraDataKeys">
2033	<desc>
2034	Returns an array representing the global extra data keys which currently
2035	have values defined.
2036	</desc>
2037	<param name="value" type="wstring" dir="return" safearray="yes">
2038	<desc>Array of extra data keys.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="getExtraData">
2043	<desc>
2044	Returns associated global extra data.
2045
2046	If the requested data @a key does not exist, this function will
2047	succeed and return an empty string in the @a value argument.
2048
2049	<result name="VBOX_E_FILE_ERROR">
2050	Settings file not accessible.
2051	</result>
2052	<result name="VBOX_E_XML_ERROR">
2053	Could not parse the settings file.
2054	</result>
2055
2056	</desc>
2057	<param name="key" type="wstring" dir="in">
2058	<desc>Name of the data key to get.</desc>
2059	</param>
2060	<param name="value" type="wstring" dir="return">
2061	<desc>Value of the requested data key.</desc>
2062	</param>
2063	</method>
2064
2065	<method name="setExtraData">
2066	<desc>
2067	Sets associated global extra data.
2068
2069	If you pass @c null or empty string as a key @a value, the given @a key
2070	will be deleted.
2071
2072	<note>
2073	Before performing the actual data change, this method will ask all
2074	registered event listener using the
2075	<link to="IExtraDataCanChangeEvent"/>
2076	notification for a permission. If one of the listeners refuses the
2077	new value, the change will not be performed.
2078	</note>
2079	<note>
2080	On success, the
2081	<link to="IExtraDataChangedEvent"/> notification
2082	is called to inform all registered listeners about a successful data
2083	change.
2084	</note>
2085
2086	<result name="VBOX_E_FILE_ERROR">
2087	Settings file not accessible.
2088	</result>
2089	<result name="VBOX_E_XML_ERROR">
2090	Could not parse the settings file.
2091	</result>
2092	<result name="E_ACCESSDENIED">
2093	Modification request refused.
2094	</result>
2095
2096	</desc>
2097	<param name="key" type="wstring" dir="in">
2098	<desc>Name of the data key to set.</desc>
2099	</param>
2100	<param name="value" type="wstring" dir="in">
2101	<desc>Value to assign to the key.</desc>
2102	</param>
2103	</method>
2104
2105	<!--method name="createDHCPServerForInterface">
2106	<desc>
2107	Creates a dhcp server settings to be used for the given interface
2108	<result name="E_INVALIDARG">
2109	Host network interface @a name already exists.
2110	</result>
2111	</desc>
2112	<param name="interface" type="IHostNetworkInterface" dir="in">
2113	<desc>Network Interface</desc>
2114	</param>
2115	<param name="server" type="IDHCPServer" dir="out">
2116	<desc>Dhcp server settings</desc>
2117	</param>
2118	</method-->
2119
2120	<method name="createDHCPServer">
2121	<desc>
2122	Creates a dhcp server settings to be used for the given internal network name
2123	<result name="E_INVALIDARG">
2124	Host network interface @a name already exists.
2125	</result>
2126	</desc>
2127	<param name="name" type="wstring" dir="in">
2128	<desc>server name</desc>
2129	</param>
2130	<param name="server" type="IDHCPServer" dir="return">
2131	<desc>Dhcp server settings</desc>
2132	</param>
2133	</method>
2134
2135	<method name="findDHCPServerByNetworkName">
2136	<desc>
2137	Searches a dhcp server settings to be used for the given internal network name
2138	<result name="E_INVALIDARG">
2139	Host network interface @a name already exists.
2140	</result>
2141
2142	</desc>
2143	<param name="name" type="wstring" dir="in">
2144	<desc>server name</desc>
2145	</param>
2146	<param name="server" type="IDHCPServer" dir="return">
2147	<desc>Dhcp server settings</desc>
2148	</param>
2149	</method>
2150
2151	<!--method name="findDHCPServerForInterface">
2152	<desc>
2153	Searches a dhcp server settings to be used for the given interface
2154	<result name="E_INVALIDARG">
2155	Host network interface @a name already exists.
2156	</result>
2157	</desc>
2158	<param name="interface" type="IHostNetworkInterface" dir="in">
2159	<desc>Network Interface</desc>
2160	</param>
2161	<param name="server" type="IDHCPServer" dir="out">
2162	<desc>Dhcp server settings</desc>
2163	</param>
2164	</method-->
2165
2166	<method name="removeDHCPServer">
2167	<desc>
2168	Removes the dhcp server settings
2169	<result name="E_INVALIDARG">
2170	Host network interface @a name already exists.
2171	</result>
2172	</desc>
2173	<param name="server" type="IDHCPServer" dir="in">
2174	<desc>Dhcp server settings to be removed</desc>
2175	</param>
2176	</method>
2177
2178
2179	<method name="checkFirmwarePresent">
2180	<desc>
2181	Check if this VirtualBox installation has a firmware
2182	of the given type available, either system-wide or per-user.
2183	Optionally, this may return a hint where this firmware can be
2184	downloaded from.
2185	</desc>
2186	<param name="firmwareType" type="FirmwareType" dir="in">
2187	<desc>
2188	Type of firmware to check.
2189	</desc>
2190	</param>
2191	<param name="version" type="wstring" dir="in">
2192	<desc>Expected version number, usually empty string (presently ignored).</desc>
2193	</param>
2194
2195	<param name="url" type="wstring" dir="out">
2196	<desc>
2197	Suggested URL to download this firmware from.
2198	</desc>
2199	</param>
2200
2201	<param name="file" type="wstring" dir="out">
2202	<desc>
2203	Filename of firmware, only valid if result == TRUE.
2204	</desc>
2205	</param>
2206
2207	<param name="result" type="boolean" dir="return">
2208	<desc>If firmware of this type and version is available.</desc>
2209	</param>
2210	</method>
2211
2212	</interface>
2213
2214	<!--
2215	// IVFSExplorer
2216	/////////////////////////////////////////////////////////////////////////
2217	-->
2218
2219	<enum
2220	name="VFSType"
2221	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2222	>
2223	<desc>
2224	Virtual file systems supported by VFSExplorer.
2225	</desc>
2226
2227	<const name="File" value="1" />
2228	<const name="Cloud" value="2" />
2229	<const name="S3" value="3" />
2230	<const name="WebDav" value="4" />
2231	</enum>
2232
2233	<enum
2234	name="VFSFileType"
2235	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2236	>
2237	<desc>
2238	File types known by VFSExplorer.
2239	</desc>
2240
2241	<const name="Unknown" value="1" />
2242	<const name="Fifo" value="2" />
2243	<const name="DevChar" value="3" />
2244	<const name="Directory" value="4" />
2245	<const name="DevBlock" value="5" />
2246	<const name="File" value="6" />
2247	<const name="SymLink" value="7" />
2248	<const name="Socket" value="8" />
2249	<const name="WhiteOut" value="9" />
2250	</enum>
2251
2252	<interface
2253	name="IVFSExplorer" extends="$unknown"
2254	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2255	wsmap="managed"
2256	>
2257	<desc>
2258	The VFSExplorer interface unifies access to different file system
2259	types. This includes local file systems as well remote file systems like
2260	S3. For a list of supported types see <link to="VFSType" />.
2261	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2262	</desc>
2263
2264	<attribute name="path" type="wstring" readonly="yes">
2265	<desc>Returns the current path in the virtual file system.</desc>
2266	</attribute>
2267
2268	<attribute name="type" type="VFSType" readonly="yes">
2269	<desc>Returns the file system type which is currently in use.</desc>
2270	</attribute>
2271
2272	<method name="update">
2273	<desc>Updates the internal list of files/directories from the
2274	current directory level. Use <link to="#entryList" /> to get the full list
2275	after a call to this method.</desc>
2276
2277	<param name="aProgress" type="IProgress" dir="return">
2278	<desc>Progress object to track the operation completion.</desc>
2279	</param>
2280	</method>
2281
2282	<method name="cd">
2283	<desc>Change the current directory level.</desc>
2284
2285	<param name="aDir" type="wstring" dir="in">
2286	<desc>The name of the directory to go in.</desc>
2287	</param>
2288
2289	<param name="aProgress" type="IProgress" dir="return">
2290	<desc>Progress object to track the operation completion.</desc>
2291	</param>
2292	</method>
2293
2294	<method name="cdUp">
2295	<desc>Go one directory upwards from the current directory level.</desc>
2296
2297	<param name="aProgress" type="IProgress" dir="return">
2298	<desc>Progress object to track the operation completion.</desc>
2299	</param>
2300	</method>
2301
2302	<method name="entryList">
2303	<desc>Returns a list of files/directories after a call to <link
2304	to="#update" />. The user is responsible for keeping this internal
2305	list up do date.</desc>
2306
2307	<param name="aNames" type="wstring" safearray="yes" dir="out">
2308	<desc>The list of names for the entries.</desc>
2309	</param>
2310
2311	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2312	<desc>The list of types for the entries.</desc>
2313	</param>
2314
2315	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2316	<desc>The list of sizes (in bytes) for the entries.</desc>
2317	</param>
2318
2319	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2320	<desc>The list of file modes (in octal form) for the entries.</desc>
2321	</param>
2322	</method>
2323
2324	<method name="exists">
2325	<desc>Checks if the given file list exists in the current directory
2326	level.</desc>
2327
2328	<param name="aNames" type="wstring" safearray="yes" dir="in">
2329	<desc>The names to check.</desc>
2330	</param>
2331
2332	<param name="aExists" type="wstring" safearray="yes" dir="return">
2333	<desc>The names which exist.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="remove">
2338	<desc>Deletes the given files in the current directory level.</desc>
2339
2340	<param name="aNames" type="wstring" safearray="yes" dir="in">
2341	<desc>The names to remove.</desc>
2342	</param>
2343
2344	<param name="aProgress" type="IProgress" dir="return">
2345	<desc>Progress object to track the operation completion.</desc>
2346	</param>
2347	</method>
2348
2349	</interface>
2350
2351	<enum
2352	name="ImportOptions" extends="$unknown"
2353	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2354	>
2355
2356	<desc>
2357	Import options, used with <link to="IAppliance::importMachines" />.
2358	</desc>
2359
2360	<const name="KeepAllMACs" value="1">
2361	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2362	</const>
2363	<const name="KeepNATMACs" value="2">
2364	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2365	</const>
2366
2367	</enum>
2368
2369
2370	<!--
2371	// IAppliance
2372	/////////////////////////////////////////////////////////////////////////
2373	-->
2374
2375	<interface
2376	name="IAppliance" extends="$unknown"
2377	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2378	wsmap="managed"
2379	>
2380	<desc>
2381	Represents a platform-independent appliance in OVF format. An instance of this is returned
2382	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2383	virtual machines within an appliance with VirtualBox.
2384
2385	The OVF standard suggests two different physical file formats:
2386
2387	<ol>
2388	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2389	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2390	this descriptor file references other files such as disk images, as OVF appliances typically
2391	do, those additional files must be in the same directory as the descriptor file.</li>
2392
2393	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2394	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2395	files and optionally other files.
2396
2397	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2398	be added with a later version.</li>
2399	</ol>
2400
2401	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2402	<link to="IMachine" /> involves the following sequence of API calls:
2403
2404	<ol>
2405	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2406	</li>
2407
2408	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2409	would like to import. So long as this file is syntactically valid, this will succeed
2410	and fill the appliance object with the parsed data from the OVF file.
2411	</li>
2412
2413	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2414	contents of the IAppliance attributes accordingly. These can be inspected by a
2415	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2416	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2417	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2418	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2419	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2420	The GUI can then give the user the option to confirm and/or change these suggestions.
2421	</li>
2422
2423	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2424	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2425	</li>
2426
2427	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2428	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2429	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2430	can be found in the <link to="#machines" /> array attribute.
2431	</li>
2432	</ol>
2433
2434	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2435
2436	<ol>
2437	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2438	an empty IAppliance object.
2439	</li>
2440
2441	<li>For each machine you would like to export, call <link to="IMachine::export" />
2442	with the IAppliance object you just created. Each such call creates one instance of
2443	<link to="IVirtualSystemDescription" /> inside the appliance.
2444	</li>
2445
2446	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2447	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2448	</li>
2449
2450	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2451	file written.</li>
2452	</ol>
2453
2454	</desc>
2455
2456	<attribute name="path" type="wstring" readonly="yes">
2457	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2458	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2459	<link to="#write" /> (for export).
2460	This attribute is empty until one of these methods has been called.
2461	</desc>
2462	</attribute>
2463
2464	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2465	<desc>
2466	Array of virtual disk definitions. One such description exists for each
2467	disk definition in the OVF; each string array item represents one such piece of
2468	disk information, with the information fields separated by tab (\\t) characters.
2469
2470	The caller should be prepared for additional fields being appended to
2471	this string in future versions of VirtualBox and therefore check for
2472	the number of tabs in the strings returned.
2473
2474	In the current version, the following eight fields are returned per string
2475	in the array:
2476
2477	<ol>
2478	<li>Disk ID (unique string identifier given to disk)</li>
2479
2480	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2481
2482	<li>Populated size (optional unsigned integer indicating the current size of the
2483	disk; can be approximate; -1 if unspecified)</li>
2484
2485	<li>Format (string identifying the disk format, typically
2486	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2487
2488	<li>Reference (where to find the disk image, typically a file name; if empty,
2489	then the disk should be created on import)</li>
2490
2491	<li>Image size (optional unsigned integer indicating the size of the image,
2492	which need not necessarily be the same as the values specified above, since
2493	the image may be compressed or sparse; -1 if not specified)</li>
2494
2495	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2496	presently unsupported and always -1)</li>
2497
2498	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2499	</ol>
2500	</desc>
2501	</attribute>
2502
2503	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2504	<desc> Array of virtual system descriptions. One such description is created
2505	for each virtual system (machine) found in the OVF.
2506	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2507	(for export) has been called.
2508	</desc>
2509	</attribute>
2510
2511	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2512	<desc>
2513	Contains the UUIDs of the machines created from the information in this appliances. This is only
2514	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2515	succeeded.
2516	</desc>
2517	</attribute>
2518
2519	<method name="read">
2520	<desc>
2521	Reads an OVF file into the appliance object.
2522
2523	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2524	mere fact that this method returns successfully does not mean that VirtualBox supports all
2525	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2526	</desc>
2527	<param name="file" type="wstring" dir="in">
2528	<desc>
2529	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2530	on whether the appliance is distributed as a set of files or as a single file, respectively).
2531	</desc>
2532	</param>
2533	<param name="aProgress" type="IProgress" dir="return">
2534	<desc>Progress object to track the operation completion.</desc>
2535	</param>
2536	</method>
2537
2538	<method name="interpret">
2539	<desc>
2540	Interprets the OVF data that was read when the appliance was constructed. After
2541	calling this method, one can inspect the
2542	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2543	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2544	the appliance.
2545
2546	Calling this method is the second step of importing an appliance into VirtualBox;
2547	see <link to="IAppliance" /> for an overview.
2548
2549	After calling this method, one should call <link to="#getWarnings" /> to find out
2550	if problems were encountered during the processing which might later lead to
2551	errors.
2552	</desc>
2553	</method>
2554
2555	<method name="importMachines">
2556	<desc>
2557	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2558	and other interfaces that match the information contained in the appliance as
2559	closely as possible, as represented by the import instructions in the
2560	<link to="#virtualSystemDescriptions" /> array.
2561
2562	Calling this method is the final step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	Since importing the appliance will most probably involve copying and converting
2566	disk images, which can take a long time, this method operates asynchronously and
2567	returns an IProgress object to allow the caller to monitor the progress.
2568
2569	After the import succeeded, the UUIDs of the IMachine instances created can be
2570	retrieved from the <link to="#machines" /> array attribute.
2571	</desc>
2572
2573	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2574	<desc>Options for the importing operation.</desc>
2575	</param>
2576
2577	<param name="aProgress" type="IProgress" dir="return">
2578	<desc>Progress object to track the operation completion.</desc>
2579	</param>
2580	</method>
2581
2582	<method name="createVFSExplorer">
2583	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2584
2585	<param name="aUri" type="wstring" dir="in">
2586	<desc>The URI describing the file system to use.</desc>
2587	</param>
2588
2589	<param name="aExplorer" type="IVFSExplorer" dir="return">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	<method name="write">
2595	<desc>
2596	Writes the contents of the appliance exports into a new OVF file.
2597
2598	Calling this method is the final step of exporting an appliance from VirtualBox;
2599	see <link to="IAppliance" /> for an overview.
2600
2601	Since exporting the appliance will most probably involve copying and converting
2602	disk images, which can take a long time, this method operates asynchronously and
2603	returns an IProgress object to allow the caller to monitor the progress.
2604	</desc>
2605	<param name="format" type="wstring" dir="in">
2606	<desc>
2607	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2608	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2609	</desc>
2610	</param>
2611	<param name="manifest" type="boolean" dir="in">
2612	<desc>
2613	Indicate if the optional manifest file (.mf) should be written. The manifest file
2614	is used for integrity checks prior import.
2615	</desc>
2616	</param>
2617	<param name="path" type="wstring" dir="in">
2618	<desc>
2619	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2620	on whether the appliance is distributed as a set of files or as a single file, respectively).
2621	</desc>
2622	</param>
2623	<param name="progress" type="IProgress" dir="return">
2624	<desc>Progress object to track the operation completion.</desc>
2625	</param>
2626	</method>
2627
2628	<method name="getWarnings">
2629	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2630
2631	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2632	<desc></desc>
2633	</param>
2634	</method>
2635
2636	</interface>
2637
2638	<enum
2639	name="VirtualSystemDescriptionType"
2640	uuid="303c0900-a746-4612-8c67-79003e91f459"
2641	>
2642	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2643	a configuration value.</desc>
2644
2645	<const name="Ignore" value="1" />
2646	<const name="OS" value="2" />
2647	<const name="Name" value="3" />
2648	<const name="Product" value="4" />
2649	<const name="Vendor" value="5" />
2650	<const name="Version" value="6" />
2651	<const name="ProductUrl" value="7" />
2652	<const name="VendorUrl" value="8" />
2653	<const name="Description" value="9" />
2654	<const name="License" value="10" />
2655	<const name="Miscellaneous" value="11" />
2656	<const name="CPU" value="12" />
2657	<const name="Memory" value="13" />
2658	<const name="HardDiskControllerIDE" value="14" />
2659	<const name="HardDiskControllerSATA" value="15" />
2660	<const name="HardDiskControllerSCSI" value="16" />
2661	<const name="HardDiskControllerSAS" value="17" />
2662	<const name="HardDiskImage" value="18" />
2663	<const name="Floppy" value="19" />
2664	<const name="CDROM" value="20" />
2665	<const name="NetworkAdapter" value="21" />
2666	<const name="USBController" value="22" />
2667	<const name="SoundCard" value="23" />
2668	<const name="SettingsFile" value="24">
2669	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2670	</const>
2671	</enum>
2672
2673	<enum
2674	name="VirtualSystemDescriptionValueType"
2675	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2676	>
2677	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2678	type to fetch.</desc>
2679
2680	<const name="Reference" value="1" />
2681	<const name="Original" value="2" />
2682	<const name="Auto" value="3" />
2683	<const name="ExtraConfig" value="4" />
2684
2685	</enum>
2686
2687	<interface
2688	name="IVirtualSystemDescription" extends="$unknown"
2689	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2690	wsmap="managed"
2691	>
2692
2693	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2694	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2695	<link to="IAppliance::interpret" /> has been called, that array contains information
2696	about how the virtual systems described in the OVF should best be imported into
2697	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2698	import an OVF into VirtualBox.
2699	</desc>
2700
2701	<attribute name="count" type="unsigned long" readonly="yes">
2702	<desc>Return the number of virtual system description entries.</desc>
2703	</attribute>
2704
2705	<method name="getDescription">
2706	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2707	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2708
2709	The list below identifies the value sets that are possible depending on the
2710	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2711	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2712	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2713	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2714	the @a aExtraConfigValues[] array item may also be used.
2715
2716	<ul>
2717	<li>
2718	"OS": the guest operating system type. There must be exactly one such array item on import. The
2719	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2720	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2721	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2722	</li>
2723	<li>
2724	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2725	if none is present on import, then an automatic name will be created from the operating system
2726	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2727	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2728	<link to="IMachine" /> name that does not exist yet.
2729	</li>
2730	<li>
2731	"Description": an arbitrary description.
2732	</li>
2733	<li>
2734	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2735	code to display such a license for agreement; the Main API does not enforce any such policy.
2736	</li>
2737	<li>
2738	Miscellaneous: reserved for future use.
2739	</li>
2740	<li>
2741	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2742	</li>
2743	<li>
2744	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2745	is present on import, then VirtualBox will set a meaningful default based on the operating system
2746	type.
2747	</li>
2748	<li>
2749	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2750	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2751	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2752	writes into the OVF.
2753	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2754	type can use to specify which hard disk controller a virtual disk should be connected to.
2755	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2756	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2757	its virtual machines supports four channels (primary master, primary slave, secondary master,
2758	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2759	</li>
2760	<li>
2761	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2762	has no value in @a aOvfValues[] or @a aVBoxValues[].
2763	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2764	</li>
2765	<li>
2766	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2767	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2768	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2769	whereas VirtualBox considers it a class of storage controllers of its own; see
2770	<link to="StorageControllerType" />).
2771	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2772	</li>
2773	<li>
2774	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2775	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2776
2777	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2778	a path since the image file should be in the same location as the OVF file itself), whereas the
2779	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2780	hard disk image. This means that on import the image will be copied and converted from the
2781	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2782
2783	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2784	format: "controller=<index>;channel=<c>"
2785	In this string, <index> must be an integer specifying the hard disk controller to connect
2786	the image to. That number must be the index of an array item with one of the hard disk controller
2787	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2788	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2789	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2790	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2791	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2792	</li>
2793	<li>
2794	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2795	attachment information as with "HardDiskImage" items.
2796	</li>
2797	<li>
2798	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2799	attachment information as with "HardDiskImage" items.
2800	</li>
2801	<li>
2802	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2803	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2804	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2805	</li>
2806	<li>
2807	"USBController": a USB controller. There can be at most one such item. If and only if such an
2808	item ispresent, USB support will be enabled for the new virtual machine.
2809	</li>
2810	<li>
2811	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2812	present, sound support will be enabled for the new virtual machine. Note that the virtual
2813	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2814	may be different from the virtual soundcard expected by the appliance.
2815	</li>
2816	</ul>
2817
2818	</desc>
2819
2820	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	</method>
2841
2842	<method name="getDescriptionByType">
2843	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2844	should be returned.</desc>
2845
2846	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	</method>
2871
2872	<method name="getValuesByType">
2873	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2874	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2875	values.</desc>
2876
2877	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2878	<desc></desc>
2879	</param>
2880
2881	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2882	<desc></desc>
2883	</param>
2884
2885	<param name="aValues" type="wstring" dir="return" safearray="yes">
2886	<desc></desc>
2887	</param>
2888
2889	</method>
2890
2891	<method name="setFinalValues">
2892	<desc>
2893	This method allows the appliance's user to change the configuration for the virtual
2894	system descriptions. For each array item returned from <link to="#getDescription" />,
2895	you must pass in one boolean value and one configuration value.
2896
2897	Each item in the boolean array determines whether the particular configuration item
2898	should be enabled.
2899	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2900	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2901	and SoundCard.
2902
2903	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2904	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2905	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2906	for valid configuration values for the individual array item types. If the
2907	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2908	</desc>
2909
2910	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2911	<desc></desc>
2912	</param>
2913
2914	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2915	<desc></desc>
2916	</param>
2917
2918	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2919	<desc></desc>
2920	</param>
2921	</method>
2922
2923	<method name="addDescription">
2924	<desc>
2925	This method adds an additional description entry to the stack of already
2926	available descriptions for this virtual system. This is handy for writing
2927	values which aren't directly supported by VirtualBox. One example would
2928	be the License type of <link to="VirtualSystemDescriptionType" />.
2929	</desc>
2930
2931	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2932	<desc></desc>
2933	</param>
2934
2935	<param name="aVBoxValue" type="wstring" dir="in">
2936	<desc></desc>
2937	</param>
2938
2939	<param name="aExtraConfigValue" type="wstring" dir="in">
2940	<desc></desc>
2941	</param>
2942	</method>
2943	</interface>
2944
2945
2946	<!--
2947	// IMachine
2948	/////////////////////////////////////////////////////////////////////////
2949	-->
2950
2951	<interface
2952	name="IInternalMachineControl" extends="$unknown"
2953	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
2954	internal="yes"
2955	wsmap="suppress"
2956	>
2957	<method name="setRemoveSavedStateFile">
2958	<desc>
2959	Updates the flag whether the saved state file is removed on a
2960	machine state change from Saved to PoweredOff.
2961	</desc>
2962	<param name="aRemove" type="boolean" dir="in"/>
2963	</method>
2964
2965	<method name="updateState">
2966	<desc>
2967	Updates the VM state.
2968	<note>
2969	This operation will also update the settings file with the correct
2970	information about the saved state file and delete this file from disk
2971	when appropriate.
2972	</note>
2973	</desc>
2974	<param name="state" type="MachineState" dir="in"/>
2975	</method>
2976
2977	<method name="getIPCId">
2978	<param name="id" type="wstring" dir="return"/>
2979	</method>
2980
2981	<method name="beginPowerUp">
2982	<desc>
2983	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2984	gives it the progress object that should be part of any pending
2985	<link to="IMachine::launchVMProcess"/> operations. The progress
2986	object may be called back to reflect an early cancelation, so some care
2987	have to be taken with respect to any cancelation callbacks. The console
2988	object will call <link to="IInternalMachineControl::endPowerUp"/>
2989	to signal the completion of the progress object.
2990	</desc>
2991	<param name="aProgress" type="IProgress" dir="in" />
2992	</method>
2993
2994	<method name="endPowerUp">
2995	<desc>
2996	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2997	This method may query status information from the progress object it
2998	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2999	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3000	call in order to complete that progress object.
3001	</desc>
3002	<param name="result" type="long" dir="in"/>
3003	</method>
3004
3005	<method name="beginPoweringDown">
3006	<desc>
3007	Called by the VM process to inform the server it wants to
3008	stop the VM execution and power down.
3009	</desc>
3010	<param name="progress" type="IProgress" dir="out">
3011	<desc>
3012	Progress object created by VBoxSVC to wait until
3013	the VM is powered down.
3014	</desc>
3015	</param>
3016	</method>
3017
3018	<method name="endPoweringDown">
3019	<desc>
3020	Called by the VM process to inform the server that powering
3021	down previously requested by #beginPoweringDown is either
3022	successfully finished or there was a failure.
3023
3024	<result name="VBOX_E_FILE_ERROR">
3025	Settings file not accessible.
3026	</result>
3027	<result name="VBOX_E_XML_ERROR">
3028	Could not parse the settings file.
3029	</result>
3030
3031	</desc>
3032
3033	<param name="result" type="long" dir="in">
3034	<desc>@c S_OK to indicate success.
3035	</desc>
3036	</param>
3037	<param name="errMsg" type="wstring" dir="in">
3038	<desc>@c human readable error message in case of failure.
3039	</desc>
3040	</param>
3041	</method>
3042
3043	<method name="runUSBDeviceFilters">
3044	<desc>
3045	Asks the server to run USB devices filters of the associated
3046	machine against the given USB device and tell if there is
3047	a match.
3048	<note>
3049	Intended to be used only for remote USB devices. Local
3050	ones don't require to call this method (this is done
3051	implicitly by the Host and USBProxyService).
3052	</note>
3053	</desc>
3054	<param name="device" type="IUSBDevice" dir="in"/>
3055	<param name="matched" type="boolean" dir="out"/>
3056	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3057	</method>
3058
3059	<method name="captureUSBDevice">
3060	<desc>
3061	Requests a capture of the given host USB device.
3062	When the request is completed, the VM process will
3063	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3064	notification.
3065	</desc>
3066	<param name="id" type="uuid" mod="string" dir="in"/>
3067	</method>
3068
3069	<method name="detachUSBDevice">
3070	<desc>
3071	Notification that a VM is going to detach (@a done = @c false) or has
3072	already detached (@a done = @c true) the given USB device.
3073	When the @a done = @c true request is completed, the VM process will
3074	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3075	notification.
3076	<note>
3077	In the @a done = @c true case, the server must run its own filters
3078	and filters of all VMs but this one on the detached device
3079	as if it were just attached to the host computer.
3080	</note>
3081	</desc>
3082	<param name="id" type="uuid" mod="string" dir="in"/>
3083	<param name="done" type="boolean" dir="in"/>
3084	</method>
3085
3086	<method name="autoCaptureUSBDevices">
3087	<desc>
3088	Requests a capture all matching USB devices attached to the host.
3089	When the request is completed, the VM process will
3090	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3091	notification per every captured device.
3092	</desc>
3093	</method>
3094
3095	<method name="detachAllUSBDevices">
3096	<desc>
3097	Notification that a VM that is being powered down. The done
3098	parameter indicates whether which stage of the power down
3099	we're at. When @a done = @c false the VM is announcing its
3100	intentions, while when @a done = @c true the VM is reporting
3101	what it has done.
3102	<note>
3103	In the @a done = @c true case, the server must run its own filters
3104	and filters of all VMs but this one on all detach devices as
3105	if they were just attached to the host computer.
3106	</note>
3107	</desc>
3108	<param name="done" type="boolean" dir="in"/>
3109	</method>
3110
3111	<method name="onSessionEnd">
3112	<desc>
3113	Triggered by the given session object when the session is about
3114	to close normally.
3115	</desc>
3116	<param name="session" type="ISession" dir="in">
3117	<desc>Session that is being closed</desc>
3118	</param>
3119	<param name="progress" type="IProgress" dir="return">
3120	<desc>
3121	Used to wait until the corresponding machine is actually
3122	dissociated from the given session on the server.
3123	Returned only when this session is a direct one.
3124	</desc>
3125	</param>
3126	</method>
3127
3128	<method name="beginSavingState">
3129	<desc>
3130	Called by the VM process to inform the server it wants to
3131	save the current state and stop the VM execution.
3132	</desc>
3133	<param name="progress" type="IProgress" dir="out">
3134	<desc>
3135	Progress object created by VBoxSVC to wait until
3136	the state is saved.
3137	</desc>
3138	</param>
3139	<param name="stateFilePath" type="wstring" dir="out">
3140	<desc>
3141	File path the VM process must save the execution state to.
3142	</desc>
3143	</param>
3144	</method>
3145
3146	<method name="endSavingState">
3147	<desc>
3148	Called by the VM process to inform the server that saving
3149	the state previously requested by #beginSavingState is either
3150	successfully finished or there was a failure.
3151
3152	<result name="VBOX_E_FILE_ERROR">
3153	Settings file not accessible.
3154	</result>
3155	<result name="VBOX_E_XML_ERROR">
3156	Could not parse the settings file.
3157	</result>
3158
3159	</desc>
3160
3161	<param name="result" type="long" dir="in">
3162	<desc>@c S_OK to indicate success.
3163	</desc>
3164	</param>
3165	<param name="errMsg" type="wstring" dir="in">
3166	<desc>@c human readable error message in case of failure.
3167	</desc>
3168	</param>
3169	</method>
3170
3171	<method name="adoptSavedState">
3172	<desc>
3173	Gets called by <link to="IConsole::adoptSavedState"/>.
3174	<result name="VBOX_E_FILE_ERROR">
3175	Invalid saved state file path.
3176	</result>
3177	</desc>
3178	<param name="savedStateFile" type="wstring" dir="in">
3179	<desc>Path to the saved state file to adopt.</desc>
3180	</param>
3181	</method>
3182
3183	<method name="beginTakingSnapshot">
3184	<desc>
3185	Called from the VM process to request from the server to perform the
3186	server-side actions of creating a snapshot (creating differencing images
3187	and the snapshot object).
3188
3189	<result name="VBOX_E_FILE_ERROR">
3190	Settings file not accessible.
3191	</result>
3192	<result name="VBOX_E_XML_ERROR">
3193	Could not parse the settings file.
3194	</result>
3195	</desc>
3196	<param name="initiator" type="IConsole" dir="in">
3197	<desc>The console object that initiated this call.</desc>
3198	</param>
3199	<param name="name" type="wstring" dir="in">
3200	<desc>Snapshot name.</desc>
3201	</param>
3202	<param name="description" type="wstring" dir="in">
3203	<desc>Snapshot description.</desc>
3204	</param>
3205	<param name="consoleProgress" type="IProgress" dir="in">
3206	<desc>
3207	Progress object created by the VM process tracking the
3208	snapshot's progress. This has the following sub-operations:
3209	<ul>
3210	<li>setting up (weight 1);</li>
3211	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3212	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3213	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3214	<li>finishing up (weight 1)</li>
3215	</ul>
3216	</desc>
3217	</param>
3218	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3219	<desc>
3220	Whether this is an online snapshot (i.e. the machine is running).
3221	</desc>
3222	</param>
3223	<param name="stateFilePath" type="wstring" dir="out">
3224	<desc>
3225	File path the VM process must save the execution state to.
3226	</desc>
3227	</param>
3228	</method>
3229
3230	<method name="endTakingSnapshot">
3231	<desc>
3232	Called by the VM process to inform the server that the snapshot
3233	previously requested by #beginTakingSnapshot is either
3234	successfully taken or there was a failure.
3235	</desc>
3236
3237	<param name="success" type="boolean" dir="in">
3238	<desc>@c true to indicate success and @c false otherwise</desc>
3239	</param>
3240	</method>
3241
3242	<method name="deleteSnapshot">
3243	<desc>
3244	Gets called by <link to="IConsole::deleteSnapshot"/>,
3245	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3246	<link to="IConsole::deleteSnapshotRange"/>.
3247	<result name="VBOX_E_INVALID_OBJECT_STATE">
3248	Snapshot has more than one child snapshot. Only possible if the
3249	delete operation does not delete all children or the range does
3250	not meet the linearity condition.
3251	</result>
3252	</desc>
3253	<param name="initiator" type="IConsole" dir="in">
3254	<desc>The console object that initiated this call.</desc>
3255	</param>
3256	<param name="startId" type="uuid" mod="string" dir="in">
3257	<desc>UUID of the first snapshot to delete.</desc>
3258	</param>
3259	<param name="endId" type="uuid" mod="string" dir="in">
3260	<desc>UUID of the last snapshot to delete.</desc>
3261	</param>
3262	<param name="deleteAllChildren" type="boolean" dir="in">
3263	<desc>Whether all children should be deleted.</desc>
3264	</param>
3265	<param name="machineState" type="MachineState" dir="out">
3266	<desc>New machine state after this operation is started.</desc>
3267	</param>
3268	<param name="progress" type="IProgress" dir="return">
3269	<desc>Progress object to track the operation completion.</desc>
3270	</param>
3271	</method>
3272
3273	<method name="finishOnlineMergeMedium">
3274	<desc>
3275	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3276	</desc>
3277	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3278	<desc>The medium attachment which needs to be cleaned up.</desc>
3279	</param>
3280	<param name="source" type="IMedium" dir="in">
3281	<desc>Merge source medium.</desc>
3282	</param>
3283	<param name="target" type="IMedium" dir="in">
3284	<desc>Merge target medium.</desc>
3285	</param>
3286	<param name="mergeForward" type="boolean" dir="in">
3287	<desc>Merge direction.</desc>
3288	</param>
3289	<param name="parentForTarget" type="IMedium" dir="in">
3290	<desc>For forward merges: new parent for target medium.</desc>
3291	</param>
3292	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3293	<desc>For backward merges: list of media which need their parent UUID
3294	updated.</desc>
3295	</param>
3296	</method>
3297
3298	<method name="restoreSnapshot">
3299	<desc>
3300	Gets called by <link to="IConsole::restoreSnapshot"/>.
3301	</desc>
3302	<param name="initiator" type="IConsole" dir="in">
3303	<desc>The console object that initiated this call.</desc>
3304	</param>
3305	<param name="snapshot" type="ISnapshot" dir="in">
3306	<desc>The snapshot to restore the VM state from.</desc>
3307	</param>
3308	<param name="machineState" type="MachineState" dir="out">
3309	<desc>New machine state after this operation is started.</desc>
3310	</param>
3311	<param name="progress" type="IProgress" dir="return">
3312	<desc>Progress object to track the operation completion.</desc>
3313	</param>
3314	</method>
3315
3316	<method name="pullGuestProperties">
3317	<desc>
3318	Get the list of the guest properties matching a set of patterns along
3319	with their values, time stamps and flags and give responsibility for
3320	managing properties to the console.
3321	</desc>
3322	<param name="name" type="wstring" dir="out" safearray="yes">
3323	<desc>
3324	The names of the properties returned.
3325	</desc>
3326	</param>
3327	<param name="value" type="wstring" dir="out" safearray="yes">
3328	<desc>
3329	The values of the properties returned. The array entries match the
3330	corresponding entries in the @a name array.
3331	</desc>
3332	</param>
3333	<param name="timestamp" type="long long" dir="out" safearray="yes">
3334	<desc>
3335	The time stamps of the properties returned. The array entries match
3336	the corresponding entries in the @a name array.
3337	</desc>
3338	</param>
3339	<param name="flags" type="wstring" dir="out" safearray="yes">
3340	<desc>
3341	The flags of the properties returned. The array entries match the
3342	corresponding entries in the @a name array.
3343	</desc>
3344	</param>
3345	</method>
3346
3347	<method name="pushGuestProperty">
3348	<desc>
3349	Update a single guest property in IMachine.
3350	</desc>
3351	<param name="name" type="wstring" dir="in">
3352	<desc>
3353	The name of the property to be updated.
3354	</desc>
3355	</param>
3356	<param name="value" type="wstring" dir="in">
3357	<desc>
3358	The value of the property.
3359	</desc>
3360	</param>
3361	<param name="timestamp" type="long long" dir="in">
3362	<desc>
3363	The timestamp of the property.
3364	</desc>
3365	</param>
3366	<param name="flags" type="wstring" dir="in">
3367	<desc>
3368	The flags of the property.
3369	</desc>
3370	</param>
3371	</method>
3372
3373	<method name="lockMedia">
3374	<desc>
3375	Locks all media attached to the machine for writing and parents of
3376	attached differencing media (if any) for reading. This operation is
3377	atomic so that if it fails no media is actually locked.
3378
3379	This method is intended to be called when the machine is in Starting or
3380	Restoring state. The locked media will be automatically unlocked when
3381	the machine is powered off or crashed.
3382	</desc>
3383	</method>
3384	<method name="unlockMedia">
3385	<desc>
3386	Unlocks all media previously locked using
3387	<link to="IInternalMachineControl::lockMedia"/>.
3388
3389	This method is intended to be used with teleportation so that it is
3390	possible to teleport between processes on the same machine.
3391	</desc>
3392	</method>
3393
3394	<method name="ejectMedium">
3395	<desc>
3396	Tells VBoxSVC that the guest has ejected the medium associated with
3397	the medium attachment.
3398	</desc>
3399	<param name="attachment" type="IMediumAttachment" dir="in">
3400	<desc>
3401	The medium attachment where the eject happened.
3402	</desc>
3403	</param>
3404	<param name="newAttachment" type="IMediumAttachment" dir="return">
3405	<desc>
3406	A new reference to the medium attachment, as the config change can
3407	result in the creation of a new instance.
3408	</desc>
3409	</param>
3410	</method>
3411
3412	<method name="reportGuestStatistics">
3413	<desc>
3414	Passes collected guest statistics to VBoxSVC.
3415	</desc>
3416	<param name="validStats" type="unsigned long" dir="in">
3417	<desc>
3418	Mask defining which parameters are valid. For example: 0x11 means
3419	that cpuIdle and XXX are valid. Other parameters should be ignored.
3420	</desc>
3421	</param>
3422	<param name="cpuUser" type="unsigned long" dir="in">
3423	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3424	</param>
3425	<param name="cpuKernel" type="unsigned long" dir="in">
3426	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3427	</param>
3428	<param name="cpuIdle" type="unsigned long" dir="in">
3429	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3430	</param>
3431	<param name="memTotal" type="unsigned long" dir="in">
3432	<desc>Total amount of physical guest RAM.</desc>
3433	</param>
3434	<param name="memFree" type="unsigned long" dir="in">
3435	<desc>Free amount of physical guest RAM.</desc>
3436	</param>
3437	<param name="memBalloon" type="unsigned long" dir="in">
3438	<desc>Amount of ballooned physical guest RAM.</desc>
3439	</param>
3440	<param name="memShared" type="unsigned long" dir="in">
3441	<desc>Amount of shared physical guest RAM.</desc>
3442	</param>
3443	<param name="memCache" type="unsigned long" dir="in">
3444	<desc>Total amount of guest (disk) cache memory.</desc>
3445	</param>
3446	<param name="pagedTotal" type="unsigned long" dir="in">
3447	<desc>Total amount of space in the page file.</desc>
3448	</param>
3449	<param name="memAllocTotal" type="unsigned long" dir="in">
3450	<desc>Total amount of memory allocated by the hypervisor.</desc>
3451	</param>
3452	<param name="memFreeTotal" type="unsigned long" dir="in">
3453	<desc>Total amount of free memory available in the hypervisor.</desc>
3454	</param>
3455	<param name="memBalloonTotal" type="unsigned long" dir="in">
3456	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3457	</param>
3458	<param name="memSharedTotal" type="unsigned long" dir="in">
3459	<desc>Total amount of shared memory in the hypervisor.</desc>
3460	</param>
3461	</method>
3462	</interface>
3463
3464	<interface
3465	name="IBIOSSettings" extends="$unknown"
3466	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3467	wsmap="managed"
3468	>
3469	<desc>
3470	The IBIOSSettings interface represents BIOS settings of the virtual
3471	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3472	</desc>
3473	<attribute name="logoFadeIn" type="boolean">
3474	<desc>Fade in flag for BIOS logo animation.</desc>
3475	</attribute>
3476
3477	<attribute name="logoFadeOut" type="boolean">
3478	<desc>Fade out flag for BIOS logo animation.</desc>
3479	</attribute>
3480
3481	<attribute name="logoDisplayTime" type="unsigned long">
3482	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3483	</attribute>
3484
3485	<attribute name="logoImagePath" type="wstring">
3486	<desc>
3487	Local file system path for external BIOS splash image. Empty string
3488	means the default image is shown on boot.
3489	</desc>
3490	</attribute>
3491
3492	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3493	<desc>Mode of the BIOS boot device menu.</desc>
3494	</attribute>
3495
3496	<attribute name="ACPIEnabled" type="boolean">
3497	<desc>ACPI support flag.</desc>
3498	</attribute>
3499
3500	<attribute name="IOAPICEnabled" type="boolean">
3501	<desc>
3502	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3503	and support IRQs above 15.
3504	</desc>
3505	</attribute>
3506
3507	<attribute name="timeOffset" type="long long">
3508	<desc>
3509	Offset in milliseconds from the host system time. This allows for
3510	guests running with a different system date/time than the host.
3511	It is equivalent to setting the system date/time in the BIOS except
3512	it is not an absolute value but a relative one. Guest Additions
3513	time synchronization honors this offset.
3514	</desc>
3515	</attribute>
3516
3517	<attribute name="PXEDebugEnabled" type="boolean">
3518	<desc>
3519	PXE debug logging flag. If set, VirtualBox will write extensive
3520	PXE trace information to the release log.
3521	</desc>
3522	</attribute>
3523	</interface>
3524
3525	<enum
3526	name="CleanupMode"
3527	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3528	>
3529	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3530	</desc>
3531	<const name="UnregisterOnly" value="1">
3532	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3533	</const>
3534	<const name="DetachAllReturnNone" value="2">
3535	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3536	</const>
3537	<const name="DetachAllReturnHardDisksOnly" value="3">
3538	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3539	</const>
3540	<const name="Full" value="4">
3541	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3542	</const>
3543	</enum>
3544
3545	<interface
3546	name="IPciAddress" extends="$unknown"
3547	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3548	wsmap="struct"
3549	>
3550
3551	<desc>
3552	Address on the PCI bus.
3553	</desc>
3554
3555	<attribute name="bus" type="short">
3556	<desc>
3557	Bus number.
3558	</desc>
3559	</attribute>
3560
3561	<attribute name="device" type="short">
3562	<desc>
3563	Device number.
3564	</desc>
3565	</attribute>
3566
3567	<attribute name="devFunction" type="short">
3568	<desc>
3569	Device function number.
3570	</desc>
3571	</attribute>
3572
3573	<method name="asLong">
3574	<desc>
3575	Convert PCI address into long.
3576	</desc>
3577	<param name="result" type="long" dir="return" />
3578	</method>
3579
3580	<method name="fromLong">
3581	<desc>
3582	Make PCI address from long.
3583	</desc>
3584	<param name="number" type="long" dir="in" />
3585	</method>
3586	</interface>
3587
3588	<interface
3589	name="IPciDeviceAttachment" extends="$unknown"
3590	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3591	wsmap="struct"
3592	>
3593
3594	<desc>
3595	Information about PCI attachments.
3596	</desc>
3597
3598	<attribute name="name" type="wstring" readonly="yes">
3599	<desc>
3600	Device name.
3601	</desc>
3602	</attribute>
3603
3604	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3605	<desc>
3606	If this is physical or virtual device.
3607	</desc>
3608	</attribute>
3609
3610	<attribute name="hostAddress" type="long" readonly="yes">
3611	<desc>
3612	Address of device on the host, applicable only to host devices.
3613	</desc>
3614	</attribute>
3615
3616	<attribute name="guestAddress" type="long" readonly="yes">
3617	<desc>
3618	Address of device on the guest.
3619	</desc>
3620	</attribute>
3621
3622	</interface>
3623
3624	<enum
3625	name="CloneMode" extends="$unknown"
3626	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3627	>
3628
3629	<desc>
3630	Clone mode, used with <link to="IMachine::cloneTo" />.
3631	</desc>
3632
3633	<const name="MachineState" value="1">
3634	<desc>Clone the state of the selected machine.</desc>
3635	</const>
3636	<const name="MachineAndChildStates" value="2">
3637	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3638	</const>
3639	<const name="AllStates" value="3">
3640	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3641	</const>
3642
3643	</enum>
3644
3645	<enum
3646	name="CloneOptions" extends="$unknown"
3647	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3648	>
3649
3650	<desc>
3651	Clone options, used with <link to="IMachine::cloneTo" />.
3652	</desc>
3653
3654	<const name="Link" value="1">
3655	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3656	</const>
3657	<const name="KeepAllMACs" value="2">
3658	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3659	</const>
3660	<const name="KeepNATMACs" value="3">
3661	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3662	</const>
3663	<const name="KeepDiskNames" value="4">
3664	<desc>Don't change the disk names.</desc>
3665	</const>
3666
3667	</enum>
3668
3669	<enum
3670	name="AutostopType" extends="$unknown"
3671	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3672	>
3673
3674	<desc>
3675	Autostop types, used with <link to="IMachine::autostopType" />.
3676	</desc>
3677
3678	<const name="Disabled" value="1">
3679	<desc>Stopping the VM during system shutdown is disabled.</desc>
3680	</const>
3681	<const name="SaveState" value="2">
3682	<desc>The state of the VM will be saved when the system shuts down.</desc>
3683	</const>
3684	<const name="PowerOff" value="3">
3685	<desc>The VM is powered off when the system shuts down.</desc>
3686	</const>
3687	<const name="AcpiShutdown" value="4">
3688	<desc>An ACPI shutdown event is generated.</desc>
3689	</const>
3690
3691	</enum>
3692
3693
3694	<interface
3695	name="IMachine" extends="$unknown"
3696	uuid="019d7a7b-1e2d-4008-b954-4b5d72d103b8"
3697	wsmap="managed"
3698	>
3699	<desc>
3700	The IMachine interface represents a virtual machine, or guest, created
3701	in VirtualBox.
3702
3703	This interface is used in two contexts. First of all, a collection of
3704	objects implementing this interface is stored in the
3705	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3706	machines that are currently registered with this VirtualBox
3707	installation. Also, once a session has been opened for the given virtual
3708	machine (e.g. the virtual machine is running), the machine object
3709	associated with the open session can be queried from the session object;
3710	see <link to="ISession"/> for details.
3711
3712	The main role of this interface is to expose the settings of the virtual
3713	machine and provide methods to change various aspects of the virtual
3714	machine's configuration. For machine objects stored in the
3715	<link to="IVirtualBox::machines"/> collection, all attributes are
3716	read-only unless explicitly stated otherwise in individual attribute
3717	and method descriptions.
3718
3719	In order to change a machine setting, a session for this machine must be
3720	opened using one of the <link to="IMachine::lockMachine" /> or
3721	<link to="IMachine::launchVMProcess"/> methods. After the
3722	machine has been successfully locked for a session, a mutable machine object
3723	needs to be queried from the session object and then the desired settings
3724	changes can be applied to the returned object using IMachine attributes and
3725	methods. See the <link to="ISession"/> interface description for more
3726	information about sessions.
3727
3728	Note that IMachine does not provide methods to control virtual machine
3729	execution (such as start the machine, or power it down) -- these methods
3730	are grouped in a separate interface called <link to="IConsole" />.
3731
3732	<see><link to="ISession"/>, <link to="IConsole"/></see>
3733	</desc>
3734
3735	<attribute name="parent" type="IVirtualBox" readonly="yes">
3736	<desc>Associated parent object.</desc>
3737	</attribute>
3738
3739	<attribute name="accessible" type="boolean" readonly="yes">
3740	<desc>
3741	Whether this virtual machine is currently accessible or not.
3742
3743	A machine is always deemed accessible unless it is registered <i>and</i>
3744	its settings file cannot be read or parsed (either because the file itself
3745	is unavailable or has invalid XML contents).
3746
3747	Every time this property is read, the accessibility state of
3748	this machine is re-evaluated. If the returned value is @c false,
3749	the <link to="#accessError"/> property may be used to get the
3750	detailed error information describing the reason of
3751	inaccessibility, including XML error messages.
3752
3753	When the machine is inaccessible, only the following properties
3754	can be used on it:
3755	<ul>
3756	<li><link to="#parent"/></li>
3757	<li><link to="#id"/></li>
3758	<li><link to="#settingsFilePath"/></li>
3759	<li><link to="#accessible"/></li>
3760	<li><link to="#accessError"/></li>
3761	</ul>
3762
3763	An attempt to access any other property or method will return
3764	an error.
3765
3766	The only possible action you can perform on an inaccessible
3767	machine is to unregister it using the
3768	<link to="IMachine::unregister"/> call (or, to check
3769	for the accessibility state once more by querying this
3770	property).
3771
3772	<note>
3773	In the current implementation, once this property returns
3774	@c true, the machine will never become inaccessible
3775	later, even if its settings file cannot be successfully
3776	read/written any more (at least, until the VirtualBox
3777	server is restarted). This limitation may be removed in
3778	future releases.
3779	</note>
3780	</desc>
3781	</attribute>
3782
3783	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3784	<desc>
3785	Error information describing the reason of machine
3786	inaccessibility.
3787
3788	Reading this property is only valid after the last call to
3789	<link to="#accessible"/> returned @c false (i.e. the
3790	machine is currently inaccessible). Otherwise, a @c null
3791	IVirtualBoxErrorInfo object will be returned.
3792	</desc>
3793	</attribute>
3794
3795	<attribute name="name" type="wstring">
3796	<desc>
3797	Name of the virtual machine.
3798
3799	Besides being used for human-readable identification purposes
3800	everywhere in VirtualBox, the virtual machine name is also used
3801	as a name of the machine's settings file and as a name of the
3802	subdirectory this settings file resides in. Thus, every time you
3803	change the value of this property, the settings file will be
3804	renamed once you call <link to="#saveSettings"/> to confirm the
3805	change. The containing subdirectory will be also renamed, but
3806	only if it has exactly the same name as the settings file
3807	itself prior to changing this property (for backward compatibility
3808	with previous API releases). The above implies the following
3809	limitations:
3810	<ul>
3811	<li>The machine name cannot be empty.</li>
3812	<li>The machine name can contain only characters that are valid
3813	file name characters according to the rules of the file
3814	system used to store VirtualBox configuration.</li>
3815	<li>You cannot have two or more machines with the same name
3816	if they use the same subdirectory for storing the machine
3817	settings files.</li>
3818	<li>You cannot change the name of the machine if it is running,
3819	or if any file in the directory containing the settings file
3820	is being used by another running machine or by any other
3821	process in the host operating system at a time when
3822	<link to="#saveSettings"/> is called.
3823	</li>
3824	</ul>
3825	If any of the above limitations are hit, <link to="#saveSettings"/>
3826	will return an appropriate error message explaining the exact
3827	reason and the changes you made to this machine will not be saved.
3828
3829	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3830	file is recommended, but not enforced. (Previous versions always
3831	used a generic ".xml" extension.)
3832	</desc>
3833	</attribute>
3834
3835	<attribute name="description" type="wstring">
3836	<desc>
3837	Description of the virtual machine.
3838
3839	The description attribute can contain any text and is
3840	typically used to describe the hardware and software
3841	configuration of the virtual machine in detail (i.e. network
3842	settings, versions of the installed software and so on).
3843	</desc>
3844	</attribute>
3845
3846	<attribute name="id" type="uuid" mod="string" readonly="yes">
3847	<desc>UUID of the virtual machine.</desc>
3848	</attribute>
3849
3850	<attribute name="OSTypeId" type="wstring">
3851	<desc>
3852	User-defined identifier of the Guest OS type.
3853	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3854	an IGuestOSType object representing details about the given
3855	Guest OS type.
3856	<note>
3857	This value may differ from the value returned by
3858	<link to="IGuest::OSTypeId"/> if Guest Additions are
3859	installed to the guest OS.
3860	</note>
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="hardwareVersion" type="wstring">
3865	<desc>Hardware version identifier. Internal use only for now.</desc>
3866	</attribute>
3867
3868	<attribute name="hardwareUUID" type="uuid" mod="string">
3869	<desc>
3870	The UUID presented to the guest via memory tables, hardware and guest
3871	properties. For most VMs this is the same as the @a id, but for VMs
3872	which have been cloned or teleported it may be the same as the source
3873	VM. This latter is because the guest shouldn't notice that it was
3874	cloned or teleported.
3875	</desc>
3876	</attribute>
3877
3878	<attribute name="CPUCount" type="unsigned long">
3879	<desc>Number of virtual CPUs in the VM.</desc>
3880	</attribute>
3881
3882	<attribute name="CPUHotPlugEnabled" type="boolean">
3883	<desc>
3884	This setting determines whether VirtualBox allows CPU
3885	hotplugging for this machine.</desc>
3886	</attribute>
3887
3888	<attribute name="CPUExecutionCap" type="unsigned long">
3889	<desc>
3890	Means to limit the number of CPU cycles a guest can use. The unit
3891	is percentage of host CPU cycles per second. The valid range
3892	is 1 - 100. 100 (the default) implies no limit.
3893	</desc>
3894	</attribute>
3895
3896	<attribute name="memorySize" type="unsigned long">
3897	<desc>System memory size in megabytes.</desc>
3898	</attribute>
3899
3900	<attribute name="memoryBalloonSize" type="unsigned long">
3901	<desc>Memory balloon size in megabytes.</desc>
3902	</attribute>
3903
3904	<attribute name="pageFusionEnabled" type="boolean">
3905	<desc>
3906	This setting determines whether VirtualBox allows page
3907	fusion for this machine (64 bits host only).
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="VRAMSize" type="unsigned long">
3912	<desc>Video memory size in megabytes.</desc>
3913	</attribute>
3914
3915	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3916	<desc>
3917	This setting determines whether VirtualBox allows this machine to make
3918	use of the 3D graphics support available on the host.</desc>
3919	</attribute>
3920
3921	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3922	<desc>
3923	This setting determines whether VirtualBox allows this machine to make
3924	use of the 2D video acceleration support available on the host.</desc>
3925	</attribute>
3926
3927	<attribute name="monitorCount" type="unsigned long">
3928	<desc>
3929	Number of virtual monitors.
3930	<note>
3931	Only effective on Windows XP and later guests with
3932	Guest Additions installed.
3933	</note>
3934	</desc>
3935	</attribute>
3936
3937	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3938	<desc>Object containing all BIOS settings.</desc>
3939	</attribute>
3940
3941	<attribute name="firmwareType" type="FirmwareType">
3942	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3943	bootstrap in this VM.</desc>
3944	</attribute>
3945
3946	<attribute name="pointingHidType" type="PointingHidType">
3947	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3948	The default is typically "PS2Mouse" but can vary depending on the
3949	requirements of the guest operating system.</desc>
3950	</attribute>
3951
3952	<attribute name="keyboardHidType" type="KeyboardHidType">
3953	<desc>Type of keyboard HID used in this VM.
3954	The default is typically "PS2Keyboard" but can vary depending on the
3955	requirements of the guest operating system.</desc>
3956	</attribute>
3957
3958	<attribute name="hpetEnabled" type="boolean">
3959	<desc>This attribute controls if High Precision Event Timer (HPET) is
3960	enabled in this VM. Use this property if you want to provide guests
3961	with additional time source, or if guest requires HPET to function correctly.
3962	Default is false.</desc>
3963	</attribute>
3964
3965	<attribute name="chipsetType" type="ChipsetType">
3966	<desc>Chipset type used in this VM.</desc>
3967	</attribute>
3968
3969	<attribute name="snapshotFolder" type="wstring">
3970	<desc>
3971	Full path to the directory used to store snapshot data
3972	(differencing media and saved state files) of this machine.
3973
3974	The initial value of this property is
3975	<tt><</tt><link to="#settingsFilePath">
3976	path_to_settings_file</link><tt>>/<</tt>
3977	<link to="#id">machine_uuid</link>
3978	<tt>></tt>.
3979
3980	Currently, it is an error to try to change this property on
3981	a machine that has snapshots (because this would require to
3982	move possibly large files to a different location).
3983	A separate method will be available for this purpose later.
3984
3985	<note>
3986	Setting this property to @c null or to an empty string will restore
3987	the initial value.
3988	</note>
3989	<note>
3990	When setting this property, the specified path can be
3991	absolute (full path) or relative to the directory where the
3992	<link to="#settingsFilePath">machine settings file</link>
3993	is located. When reading this property, a full path is
3994	always returned.
3995	</note>
3996	<note>
3997	The specified path may not exist, it will be created
3998	when necessary.
3999	</note>
4000	</desc>
4001	</attribute>
4002
4003	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4004	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4005	</attribute>
4006
4007	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4008	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4009
4010	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4011	<desc>Array of media attached to this machine.</desc>
4012	</attribute>
4013
4014	<attribute name="USBController" type="IUSBController" readonly="yes">
4015	<desc>
4016	Associated USB controller object.
4017
4018	<note>
4019	If USB functionality is not available in the given edition of
4020	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4021	</note>
4022	</desc>
4023	</attribute>
4024
4025	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4026	<desc>Associated audio adapter, always present.</desc>
4027	</attribute>
4028
4029	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4030	<desc>Array of storage controllers attached to this machine.</desc>
4031	</attribute>
4032
4033	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4034	<desc>
4035	Full name of the file containing machine settings data.
4036	</desc>
4037	</attribute>
4038
4039	<attribute name="settingsModified" type="boolean" readonly="yes">
4040	<desc>
4041	Whether the settings of this machine have been modified
4042	(but neither yet saved nor discarded).
4043	<note>
4044	Reading this property is only valid on instances returned
4045	by <link to="ISession::machine"/> and on new machines
4046	created by <link to="IVirtualBox::createMachine"/> or opened
4047	by <link to="IVirtualBox::openMachine"/> but not
4048	yet registered, or on unregistered machines after calling
4049	<link to="IMachine::unregister"/>. For all other
4050	cases, the settings can never be modified.
4051	</note>
4052	<note>
4053	For newly created unregistered machines, the value of this
4054	property is always @c true until <link to="#saveSettings"/>
4055	is called (no matter if any machine settings have been
4056	changed after the creation or not). For opened machines
4057	the value is set to @c false (and then follows to normal rules).
4058	</note>
4059	</desc>
4060	</attribute>
4061
4062	<attribute name="sessionState" type="SessionState" readonly="yes">
4063	<desc>Current session state for this machine.</desc>
4064	</attribute>
4065
4066	<attribute name="sessionType" type="wstring" readonly="yes">
4067	<desc>
4068	Type of the session. If <link to="#sessionState"/> is
4069	Spawning or Locked, this attribute contains the
4070	same value as passed to the
4071	<link to="IMachine::launchVMProcess"/> method in the
4072	@a type parameter. If the session was used with
4073	<link to="IMachine::lockMachine" />, or if
4074	<link to="#sessionState"/> is SessionClosed, the value of this
4075	attribute is an empty string.
4076	</desc>
4077	</attribute>
4078
4079	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4080	<desc>
4081	Identifier of the session process. This attribute contains the
4082	platform-dependent identifier of the process whose session was
4083	used with <link to="IMachine::lockMachine" /> call. The returned
4084	value is only valid if <link to="#sessionState"/> is Locked or
4085	Unlocking by the time this property is read.
4086	</desc>
4087	</attribute>
4088
4089	<attribute name="state" type="MachineState" readonly="yes">
4090	<desc>Current execution state of this machine.</desc>
4091	</attribute>
4092
4093	<attribute name="lastStateChange" type="long long" readonly="yes">
4094	<desc>
4095	Time stamp of the last execution state change,
4096	in milliseconds since 1970-01-01 UTC.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="stateFilePath" type="wstring" readonly="yes">
4101	<desc>
4102	Full path to the file that stores the execution state of
4103	the machine when it is in the <link to="MachineState_Saved"/> state.
4104	<note>
4105	When the machine is not in the Saved state, this attribute is
4106	an empty string.
4107	</note>
4108	</desc>
4109	</attribute>
4110
4111	<attribute name="logFolder" type="wstring" readonly="yes">
4112	<desc>
4113	Full path to the folder that stores a set of rotated log files
4114	recorded during machine execution. The most recent log file is
4115	named <tt>VBox.log</tt>, the previous log file is
4116	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4117	in the current version).
4118	</desc>
4119	</attribute>
4120
4121	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4122	<desc>
4123	Current snapshot of this machine. This is @c null if the machine
4124	currently has no snapshots. If it is not @c null, then it was
4125	set by one of <link to="IConsole::takeSnapshot" />,
4126	<link to="IConsole::deleteSnapshot" />
4127	or <link to="IConsole::restoreSnapshot" />, depending on which
4128	was called last. See <link to="ISnapshot"/> for details.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4133	<desc>
4134	Number of snapshots taken on this machine. Zero means the
4135	machine doesn't have any snapshots.
4136	</desc>
4137	</attribute>
4138
4139	<attribute name="currentStateModified" type="boolean" readonly="yes">
4140	<desc>
4141	Returns @c true if the current state of the machine is not
4142	identical to the state stored in the current snapshot.
4143
4144	The current state is identical to the current snapshot only
4145	directly after one of the following calls are made:
4146
4147	<ul>
4148	<li><link to="IConsole::restoreSnapshot"/>
4149	</li>
4150	<li><link to="IConsole::takeSnapshot"/> (issued on a
4151	"powered off" or "saved" machine, for which
4152	<link to="#settingsModified"/> returns @c false)
4153	</li>
4154	</ul>
4155
4156	The current state remains identical until one of the following
4157	happens:
4158	<ul>
4159	<li>settings of the machine are changed</li>
4160	<li>the saved state is deleted</li>
4161	<li>the current snapshot is deleted</li>
4162	<li>an attempt to execute the machine is made</li>
4163	</ul>
4164
4165	<note>
4166	For machines that don't have snapshots, this property is
4167	always @c false.
4168	</note>
4169	</desc>
4170	</attribute>
4171
4172	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4173	<desc>
4174	Collection of shared folders for this machine (permanent shared
4175	folders). These folders are shared automatically at machine startup
4176	and available only to the guest OS installed within this machine.
4177
4178	New shared folders are added to the collection using
4179	<link to="#createSharedFolder"/>. Existing shared folders can be
4180	removed using <link to="#removeSharedFolder"/>.
4181	</desc>
4182	</attribute>
4183
4184	<attribute name="clipboardMode" type="ClipboardMode">
4185	<desc>
4186	Synchronization mode between the host OS clipboard
4187	and the guest OS clipboard.
4188	</desc>
4189	</attribute>
4190
4191	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4192	<desc>
4193	A comma-separated list of simple glob patterns. Changes to guest
4194	properties whose name matches one of the patterns will generate an
4195	<link to="IGuestPropertyChangedEvent"/> signal.
4196	</desc>
4197	</attribute>
4198
4199	<attribute name="teleporterEnabled" type="boolean">
4200	<desc>
4201	When set to @a true, the virtual machine becomes a target teleporter
4202	the next time it is powered on. This can only set to @a true when the
4203	VM is in the @a PoweredOff or @a Aborted state.
4204
4205	<!-- This property is automatically set to @a false when the VM is powered
4206	on. (bird: This doesn't work yet ) -->
4207	</desc>
4208	</attribute>
4209
4210	<attribute name="teleporterPort" type="unsigned long">
4211	<desc>
4212	The TCP port the target teleporter will listen for incoming
4213	teleportations on.
4214
4215	0 means the port is automatically selected upon power on. The actual
4216	value can be read from this property while the machine is waiting for
4217	incoming teleportations.
4218	</desc>
4219	</attribute>
4220
4221	<attribute name="teleporterAddress" type="wstring">
4222	<desc>
4223	The address the target teleporter will listen on. If set to an empty
4224	string, it will listen on all addresses.
4225	</desc>
4226	</attribute>
4227
4228	<attribute name="teleporterPassword" type="wstring">
4229	<desc>
4230	The password to check for on the target teleporter. This is just a
4231	very basic measure to prevent simple hacks and operators accidentally
4232	beaming a virtual machine to the wrong place.
4233
4234	Note that you SET a plain text password while reading back a HASHED
4235	password. Setting a hashed password is currently not supported.
4236	</desc>
4237	</attribute>
4238
4239	<attribute name="faultToleranceState" type="FaultToleranceState">
4240	<desc>
4241	Fault tolerance state; disabled, source or target.
4242	This property can be changed at any time. If you change it for a running
4243	VM, then the fault tolerance address and port must be set beforehand.
4244	</desc>
4245	</attribute>
4246
4247	<attribute name="faultTolerancePort" type="unsigned long">
4248	<desc>
4249	The TCP port the fault tolerance source or target will use for
4250	communication.
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="faultToleranceAddress" type="wstring">
4255	<desc>
4256	The address the fault tolerance source or target.
4257	</desc>
4258	</attribute>
4259
4260	<attribute name="faultTolerancePassword" type="wstring">
4261	<desc>
4262	The password to check for on the standby VM. This is just a
4263	very basic measure to prevent simple hacks and operators accidentally
4264	choosing the wrong standby VM.
4265	</desc>
4266	</attribute>
4267
4268	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4269	<desc>
4270	The interval in ms used for syncing the state between source and target.
4271	</desc>
4272	</attribute>
4273
4274	<attribute name="RTCUseUTC" type="boolean">
4275	<desc>
4276	When set to @a true, the RTC device of the virtual machine will run
4277	in UTC time, otherwise in local time. Especially Unix guests prefer
4278	the time in UTC.
4279	</desc>
4280	</attribute>
4281
4282	<attribute name="ioCacheEnabled" type="boolean">
4283	<desc>
4284	When set to @a true, the builtin I/O cache of the virtual machine
4285	will be enabled.
4286	</desc>
4287	</attribute>
4288
4289	<attribute name="ioCacheSize" type="unsigned long">
4290	<desc>
4291	Maximum size of the I/O cache in MB.
4292	</desc>
4293	</attribute>
4294
4295	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4296	<desc>Array of PCI devices assigned to this machine, to get list of all
4297	PCI devices attached to the machine use
4298	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4299	is intended to list only devices additional to what described in
4300	virtual hardware config. Usually, this list keeps host's physical
4301	devices assigned to the particular machine.
4302	</desc>
4303	</attribute>
4304
4305	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4306	<desc>
4307	Bandwidth control manager.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="tracingEnabled" type="boolean">
4312	<desc>
4313	Enables the tracing facility in the VMM (including PDM devices +
4314	drivers). The VMM will consume about 0.5MB of more memory when
4315	enabled and there may be some extra overhead from tracepoints that are
4316	always enabled.
4317	</desc>
4318	</attribute>
4319
4320	<attribute name="tracingConfig" type="wstring">
4321	<desc>
4322	Tracepoint configuration to apply at startup when
4323	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4324	a space separated of tracepoint group names to enable. The special
4325	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4326	more details on available tracepoint groups and such.
4327
4328	Note that on hosts supporting DTrace (or similar), a lot of the
4329	tracepoints may be implemented exclusivly as DTrace probes. So, the
4330	effect of the same config may differ between Solaris and Windows for
4331	example.
4332	</desc>
4333	</attribute>
4334
4335	<attribute name="allowTracingToAccessVM" type="boolean">
4336	<desc>
4337	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4338	structures when firing off trace points. This is especially useful
4339	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4340	to obtail useful information such as guest register state.
4341
4342	This is disabled by default because devices and drivers normally has no
4343	business accessing the VMCPU or VM structures, and are therefore unable
4344	to get any pointers to these.
4345	</desc>
4346	</attribute>
4347
4348	<attribute name="autostartEnabled" type="boolean">
4349	<desc>
4350	Enables autostart of the VM during system boot.
4351	</desc>
4352	</attribute>
4353
4354	<attribute name="autostartDelay" type="unsigned long">
4355	<desc>
4356	Number of seconds to wait until the VM should be started during system boot.
4357	</desc>
4358	</attribute>
4359
4360	<attribute name="autostopType" type="AutostopType">
4361	<desc>
4362	Action type to do when the system is shutting down.
4363	</desc>
4364	</attribute>
4365
4366	<method name="lockMachine">
4367	<desc>
4368	Locks the machine for the given session to enable the caller
4369	to make changes to the machine or start the VM or control
4370	VM execution.
4371
4372	There are two ways to lock a machine for such uses:
4373
4374	<ul>
4375	<li>If you want to make changes to the machine settings,
4376	you must obtain an exclusive write lock on the machine
4377	by setting @a lockType to @c Write.
4378
4379	This will only succeed if no other process has locked
4380	the machine to prevent conflicting changes. Only after
4381	an exclusive write lock has been obtained using this method, one
4382	can change all VM settings or execute the VM in the process
4383	space of the session object. (Note that the latter is only of
4384	interest if you actually want to write a new front-end for
4385	virtual machines; but this API gets called internally by
4386	the existing front-ends such as VBoxHeadless and the VirtualBox
4387	GUI to acquire a write lock on the machine that they are running.)
4388
4389	On success, write-locking the machine for a session creates
4390	a second copy of the IMachine object. It is this second object
4391	upon which changes can be made; in VirtualBox terminology, the
4392	second copy is "mutable". It is only this second, mutable machine
4393	object upon which you can call methods that change the
4394	machine state. After having called this method, you can
4395	obtain this second, mutable machine object using the
4396	<link to="ISession::machine" /> attribute.
4397	</li>
4398	<li>If you only want to check the machine state or control
4399	machine execution without actually changing machine
4400	settings (e.g. to get access to VM statistics or take
4401	a snapshot or save the machine state), then set the
4402	@a lockType argument to @c Shared.
4403
4404	If no other session has obtained a lock, you will obtain an
4405	exclusive write lock as described above. However, if another
4406	session has already obtained such a lock, then a link to that
4407	existing session will be established which allows you
4408	to control that existing session.
4409
4410	To find out which type of lock was obtained, you can
4411	inspect <link to="ISession::type" />, which will have been
4412	set to either @c WriteLock or @c Shared.
4413	</li>
4414	</ul>
4415
4416	In either case, you can get access to the <link to="IConsole" />
4417	object which controls VM execution.
4418
4419	Also in all of the above cases, one must always call
4420	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4421	the machine's state will eventually be set to "Aborted".
4422
4423	To change settings on a machine, the following sequence is typically
4424	performed:
4425
4426	<ol>
4427	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4428
4429	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4430
4431	<li>Change the settings of the machine by invoking IMachine methods.</li>
4432
4433	<li>Call <link to="IMachine::saveSettings" />.</li>
4434
4435	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4436	</ol>
4437
4438	<result name="E_UNEXPECTED">
4439	Virtual machine not registered.
4440	</result>
4441	<result name="E_ACCESSDENIED">
4442	Process not started by OpenRemoteSession.
4443	</result>
4444	<result name="VBOX_E_INVALID_OBJECT_STATE">
4445	Session already open or being opened.
4446	</result>
4447	<result name="VBOX_E_VM_ERROR">
4448	Failed to assign machine to session.
4449	</result>
4450	</desc>
4451	<param name="session" type="ISession" dir="in">
4452	<desc>
4453	Session object for which the machine will be locked.
4454	</desc>
4455	</param>
4456	<param name="lockType" type="LockType" dir="in">
4457	<desc>
4458	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4459	If set to @c Shared, then either acquire an exclusive write lock or establish
4460	a link to an existing session.
4461	</desc>
4462	</param>
4463	</method>
4464
4465	<method name="launchVMProcess">
4466	<desc>
4467	Spawns a new process that will execute the virtual machine and obtains a shared
4468	lock on the machine for the calling session.
4469
4470	If launching the VM succeeds, the new VM process will create its own session
4471	and write-lock the machine for it, preventing conflicting changes from other
4472	processes. If the machine is already locked (because it is already running or
4473	because another session has a write lock), launching the VM process will therefore
4474	fail. Reversely, future attempts to obtain a write lock will also fail while the
4475	machine is running.
4476
4477	The caller's session object remains separate from the session opened by the new
4478	VM process. It receives its own <link to="IConsole" /> object which can be used
4479	to control machine execution, but it cannot be used to change all VM settings
4480	which would be available after a <link to="#lockMachine" /> call.
4481
4482	The caller must eventually release the session's shared lock by calling
4483	<link to="ISession::unlockMachine" /> on the local session object once this call
4484	has returned. However, the session's state (see <link to="ISession::state" />)
4485	will not return to "Unlocked" until the remote session has also unlocked
4486	the machine (i.e. the machine has stopped running).
4487
4488	Launching a VM process can take some time (a new VM is started in a new process,
4489	for which memory and other resources need to be set up). Because of this,
4490	an <link to="IProgress" /> object is returned to allow the caller to wait
4491	for this asynchronous operation to be completed. Until then, the caller's
4492	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4493	and <link to="ISession::console" /> attributes cannot be accessed.
4494	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4495	similar calls to wait for completion. Completion is signalled when the VM
4496	is powered on. If launching the VM fails, error messages can be queried
4497	via the progress object, if available.
4498
4499	The progress object will have at least 2 sub-operations. The first
4500	operation covers the period up to the new VM process calls powerUp.
4501	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4502	progress object. Because <link to="IConsole::powerUp"/> may require
4503	some extra sub-operations, the <link to="IProgress::operationCount"/>
4504	may change at the completion of operation.
4505
4506	For details on the teleportation progress operation, see
4507	<link to="IConsole::powerUp"/>.
4508
4509	The @a environment argument is a string containing definitions of
4510	environment variables in the following format:
4511	<pre>
4512	NAME[=VALUE]\n
4513	NAME[=VALUE]\n
4514	...
4515	</pre>
4516	where <tt>\\n</tt> is the new line character. These environment
4517	variables will be appended to the environment of the VirtualBox server
4518	process. If an environment variable exists both in the server process
4519	and in this list, the value from this list takes precedence over the
4520	server's variable. If the value of the environment variable is
4521	omitted, this variable will be removed from the resulting environment.
4522	If the environment string is @c null or empty, the server environment
4523	is inherited by the started process as is.
4524
4525	<result name="E_UNEXPECTED">
4526	Virtual machine not registered.
4527	</result>
4528	<result name="E_INVALIDARG">
4529	Invalid session type @a type.
4530	</result>
4531	<result name="VBOX_E_OBJECT_NOT_FOUND">
4532	No machine matching @a machineId found.
4533	</result>
4534	<result name="VBOX_E_INVALID_OBJECT_STATE">
4535	Session already open or being opened.
4536	</result>
4537	<result name="VBOX_E_IPRT_ERROR">
4538	Launching process for machine failed.
4539	</result>
4540	<result name="VBOX_E_VM_ERROR">
4541	Failed to assign machine to session.
4542	</result>
4543	</desc>
4544	<param name="session" type="ISession" dir="in">
4545	<desc>
4546	Client session object to which the VM process will be connected (this
4547	must be in "Unlocked" state).
4548	</desc>
4549	</param>
4550	<param name="type" type="wstring" dir="in">
4551	<desc>
4552	Front-end to use for the new VM process. The following are currently supported:
4553	<ul>
4554	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4555	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4556	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4557	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4558	the currently running VM or session owner. In this case the
4559	@a session parameter may be @c NULL (if it is non-null it isn't
4560	used in any way), and the @a progress return value will be always
4561	NULL. The operation completes immediately.</li>
4562	</ul>
4563	</desc>
4564	</param>
4565	<param name="environment" type="wstring" dir="in">
4566	<desc>
4567	Environment to pass to the VM process.
4568	</desc>
4569	</param>
4570	<param name="progress" type="IProgress" dir="return">
4571	<desc>Progress object to track the operation completion.</desc>
4572	</param>
4573	</method>
4574
4575	<method name="setBootOrder">
4576	<desc>
4577	Puts the given device to the specified position in
4578	the boot order.
4579
4580	To indicate that no device is associated with the given position,
4581	<link to="DeviceType_Null"/> should be used.
4582
4583	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4584
4585	<result name="E_INVALIDARG">
4586	Boot @a position out of range.
4587	</result>
4588	<result name="E_NOTIMPL">
4589	Booting from USB @a device currently not supported.
4590	</result>
4591
4592	</desc>
4593	<param name="position" type="unsigned long" dir="in">
4594	<desc>
4595	Position in the boot order (@c 1 to the total number of
4596	devices the machine can boot from, as returned by
4597	<link to="ISystemProperties::maxBootPosition"/>).
4598	</desc>
4599	</param>
4600	<param name="device" type="DeviceType" dir="in">
4601	<desc>
4602	The type of the device used to boot at the given position.
4603	</desc>
4604	</param>
4605	</method>
4606
4607	<method name="getBootOrder" const="yes">
4608	<desc>
4609	Returns the device type that occupies the specified
4610	position in the boot order.
4611
4612	@todo [remove?]
4613	If the machine can have more than one device of the returned type
4614	(such as hard disks), then a separate method should be used to
4615	retrieve the individual device that occupies the given position.
4616
4617	If here are no devices at the given position, then
4618	<link to="DeviceType_Null"/> is returned.
4619
4620	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4621
4622	<result name="E_INVALIDARG">
4623	Boot @a position out of range.
4624	</result>
4625
4626	</desc>
4627	<param name="position" type="unsigned long" dir="in">
4628	<desc>
4629	Position in the boot order (@c 1 to the total number of
4630	devices the machine can boot from, as returned by
4631	<link to="ISystemProperties::maxBootPosition"/>).
4632	</desc>
4633	</param>
4634	<param name="device" type="DeviceType" dir="return">
4635	<desc>
4636	Device at the given position.
4637	</desc>
4638	</param>
4639	</method>
4640
4641	<method name="attachDevice">
4642	<desc>
4643	Attaches a device and optionally mounts a medium to the given storage
4644	controller (<link to="IStorageController" />, identified by @a name),
4645	at the indicated port and device.
4646
4647	This method is intended for managing storage devices in general while a
4648	machine is powered off. It can be used to attach and detach fixed
4649	and removable media. The following kind of media can be attached
4650	to a machine:
4651
4652	<ul>
4653	<li>For fixed and removable media, you can pass in a medium that was
4654	previously opened using <link to="IVirtualBox::openMedium" />.
4655	</li>
4656
4657	<li>Only for storage devices supporting removable media (such as
4658	DVDs and floppies), you can also specify a null pointer to
4659	indicate an empty drive or one of the medium objects listed
4660	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4661	arrays to indicate a host drive.
4662	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4663	to change the media while the machine is running.
4664	</li>
4665	</ul>
4666
4667	In a VM's default configuration of virtual machines, the secondary
4668	master of the IDE controller is used for a CD/DVD drive.
4669
4670	After calling this returns successfully, a new instance of
4671	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4672	attachments (see <link to="IMachine::mediumAttachments"/>).
4673
4674	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4675	information about attaching media.
4676
4677	The specified device slot must not have a device attached to it,
4678	or this method will fail.
4679
4680	<note>
4681	You cannot attach a device to a newly created machine until
4682	this machine's settings are saved to disk using
4683	<link to="#saveSettings"/>.
4684	</note>
4685	<note>
4686	If the medium is being attached indirectly, a new differencing medium
4687	will implicitly be created for it and attached instead. If the
4688	changes made to the machine settings (including this indirect
4689	attachment) are later cancelled using <link to="#discardSettings"/>,
4690	this implicitly created differencing medium will implicitly
4691	be deleted.
4692	</note>
4693
4694	<result name="E_INVALIDARG">
4695	SATA device, SATA port, IDE port or IDE slot out of range, or
4696	file or UUID not found.
4697	</result>
4698	<result name="VBOX_E_INVALID_OBJECT_STATE">
4699	Machine must be registered before media can be attached.
4700	</result>
4701	<result name="VBOX_E_INVALID_VM_STATE">
4702	Invalid machine state.
4703	</result>
4704	<result name="VBOX_E_OBJECT_IN_USE">
4705	A medium is already attached to this or another virtual machine.
4706	</result>
4707
4708	</desc>
4709	<param name="name" type="wstring" dir="in">
4710	<desc>Name of the storage controller to attach the device to.</desc>
4711	</param>
4712	<param name="controllerPort" type="long" dir="in">
4713	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4714	the primary controller and 1 specifies the secondary controller.
4715	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4716	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port to attach the device to. This is only
4720	relevant for IDE controllers, for which 0 specifies the master device and
4721	1 specifies the slave device. For all other controller types, this must
4722	be 0.</desc>
4723	</param>
4724	<param name="type" type="DeviceType" dir="in">
4725	<desc>Device type of the attached device. For media opened by
4726	<link to="IVirtualBox::openMedium" />, this must match the device type
4727	specified there.</desc>
4728	</param>
4729	<param name="medium" type="IMedium" dir="in">
4730	<desc>Medium to mount or NULL for an empty drive.</desc>
4731	</param>
4732	</method>
4733
4734	<method name="detachDevice">
4735	<desc>
4736	Detaches the device attached to a device slot of the specified bus.
4737
4738	Detaching the device from the virtual machine is deferred. This means
4739	that the medium remains associated with the machine when this method
4740	returns and gets actually de-associated only after a successful
4741	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4742	for more detailed information about attaching media.
4743
4744	<note>
4745	You cannot detach a device from a running machine.
4746	</note>
4747	<note>
4748	Detaching differencing media implicitly created by <link
4749	to="#attachDevice"/> for the indirect attachment using this
4750	method will <b>not</b> implicitly delete them. The
4751	<link to="IMedium::deleteStorage"/> operation should be
4752	explicitly performed by the caller after the medium is successfully
4753	detached and the settings are saved with
4754	<link to="#saveSettings"/>, if it is the desired action.
4755	</note>
4756
4757	<result name="VBOX_E_INVALID_VM_STATE">
4758	Attempt to detach medium from a running virtual machine.
4759	</result>
4760	<result name="VBOX_E_OBJECT_NOT_FOUND">
4761	No medium attached to given slot/bus.
4762	</result>
4763	<result name="VBOX_E_NOT_SUPPORTED">
4764	Medium format does not support storage deletion (only for implicitly
4765	created differencing media, should not happen).
4766	</result>
4767
4768	</desc>
4769	<param name="name" type="wstring" dir="in">
4770	<desc>Name of the storage controller to detach the medium from.</desc>
4771	</param>
4772	<param name="controllerPort" type="long" dir="in">
4773	<desc>Port number to detach the medium from.</desc>
4774	</param>
4775	<param name="device" type="long" dir="in">
4776	<desc>Device slot number to detach the medium from.</desc>
4777	</param>
4778	</method>
4779
4780	<method name="passthroughDevice">
4781	<desc>
4782	Sets the passthrough mode of an existing DVD device. Changing the
4783	setting while the VM is running is forbidden. The setting is only used
4784	if at VM start the device is configured as a host DVD drive, in all
4785	other cases it is ignored. The device must already exist; see
4786	<link to="IMachine::attachDevice"/> for how to attach a new device.
4787
4788	The @a controllerPort and @a device parameters specify the device slot and
4789	have have the same meaning as with <link to="IMachine::attachDevice" />.
4790
4791	<result name="E_INVALIDARG">
4792	SATA device, SATA port, IDE port or IDE slot out of range.
4793	</result>
4794	<result name="VBOX_E_INVALID_OBJECT_STATE">
4795	Attempt to modify an unregistered virtual machine.
4796	</result>
4797	<result name="VBOX_E_INVALID_VM_STATE">
4798	Invalid machine state.
4799	</result>
4800
4801	</desc>
4802	<param name="name" type="wstring" dir="in">
4803	<desc>Name of the storage controller.</desc>
4804	</param>
4805	<param name="controllerPort" type="long" dir="in">
4806	<desc>Storage controller port.</desc>
4807	</param>
4808	<param name="device" type="long" dir="in">
4809	<desc>Device slot in the given port.</desc>
4810	</param>
4811	<param name="passthrough" type="boolean" dir="in">
4812	<desc>New value for the passthrough setting.</desc>
4813	</param>
4814	</method>
4815
4816	<method name="temporaryEjectDevice">
4817	<desc>
4818	Sets the behavior for guest-triggered medium eject. In some situations
4819	it is desirable that such ejects update the VM configuration, and in
4820	others the eject should keep the VM configuration. The device must
4821	already exist; see <link to="IMachine::attachDevice"/> for how to
4822	attach a new device.
4823
4824	The @a controllerPort and @a device parameters specify the device slot and
4825	have have the same meaning as with <link to="IMachine::attachDevice" />.
4826
4827	<result name="E_INVALIDARG">
4828	SATA device, SATA port, IDE port or IDE slot out of range.
4829	</result>
4830	<result name="VBOX_E_INVALID_OBJECT_STATE">
4831	Attempt to modify an unregistered virtual machine.
4832	</result>
4833	<result name="VBOX_E_INVALID_VM_STATE">
4834	Invalid machine state.
4835	</result>
4836
4837	</desc>
4838	<param name="name" type="wstring" dir="in">
4839	<desc>Name of the storage controller.</desc>
4840	</param>
4841	<param name="controllerPort" type="long" dir="in">
4842	<desc>Storage controller port.</desc>
4843	</param>
4844	<param name="device" type="long" dir="in">
4845	<desc>Device slot in the given port.</desc>
4846	</param>
4847	<param name="temporaryEject" type="boolean" dir="in">
4848	<desc>New value for the eject behavior.</desc>
4849	</param>
4850	</method>
4851
4852	<method name="nonRotationalDevice">
4853	<desc>
4854	Sets a flag in the device information which indicates that the medium
4855	is not based on rotational technology, i.e. that the access times are
4856	more or less independent of the position on the medium. This may or may
4857	not be supported by a particular drive, and is silently ignored in the
4858	latter case. At the moment only hard disks (which is a misnomer in this
4859	context) accept this setting. Changing the setting while the VM is
4860	running is forbidden. The device must already exist; see
4861	<link to="IMachine::attachDevice"/> for how to attach a new device.
4862
4863	The @a controllerPort and @a device parameters specify the device slot and
4864	have have the same meaning as with <link to="IMachine::attachDevice" />.
4865
4866	<result name="E_INVALIDARG">
4867	SATA device, SATA port, IDE port or IDE slot out of range.
4868	</result>
4869	<result name="VBOX_E_INVALID_OBJECT_STATE">
4870	Attempt to modify an unregistered virtual machine.
4871	</result>
4872	<result name="VBOX_E_INVALID_VM_STATE">
4873	Invalid machine state.
4874	</result>
4875
4876	</desc>
4877	<param name="name" type="wstring" dir="in">
4878	<desc>Name of the storage controller.</desc>
4879	</param>
4880	<param name="controllerPort" type="long" dir="in">
4881	<desc>Storage controller port.</desc>
4882	</param>
4883	<param name="device" type="long" dir="in">
4884	<desc>Device slot in the given port.</desc>
4885	</param>
4886	<param name="nonRotational" type="boolean" dir="in">
4887	<desc>New value for the non-rotational device flag.</desc>
4888	</param>
4889	</method>
4890
4891	<method name="setAutoDiscardForDevice">
4892	<desc>
4893	Sets a flag in the device information which indicates that the medium
4894	supports discarding unsused blocks (called trimming for SATA or unmap
4895	for SCSI devices) .This may or may not be supported by a particular drive,
4896	and is silently ignored in the latter case. At the moment only hard disks
4897	(which is a misnomer in this context) accept this setting. Changing the
4898	setting while the VM is running is forbidden. The device must already
4899	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4900	device.
4901
4902	The @a controllerPort and @a device parameters specify the device slot and
4903	have have the same meaning as with <link to="IMachine::attachDevice" />.
4904
4905	<result name="E_INVALIDARG">
4906	SATA device, SATA port, SCSI port out of range.
4907	</result>
4908	<result name="VBOX_E_INVALID_OBJECT_STATE">
4909	Attempt to modify an unregistered virtual machine.
4910	</result>
4911	<result name="VBOX_E_INVALID_VM_STATE">
4912	Invalid machine state.
4913	</result>
4914
4915	</desc>
4916	<param name="name" type="wstring" dir="in">
4917	<desc>Name of the storage controller.</desc>
4918	</param>
4919	<param name="controllerPort" type="long" dir="in">
4920	<desc>Storage controller port.</desc>
4921	</param>
4922	<param name="device" type="long" dir="in">
4923	<desc>Device slot in the given port.</desc>
4924	</param>
4925	<param name="discard" type="boolean" dir="in">
4926	<desc>New value for the discard device flag.</desc>
4927	</param>
4928	</method>
4929
4930	<method name="setBandwidthGroupForDevice">
4931	<desc>
4932	Sets the bandwidth group of an existing storage device.
4933	The device must already exist; see <link to="IMachine::attachDevice"/>
4934	for how to attach a new device.
4935
4936	The @a controllerPort and @a device parameters specify the device slot and
4937	have have the same meaning as with <link to="IMachine::attachDevice" />.
4938
4939	<result name="E_INVALIDARG">
4940	SATA device, SATA port, IDE port or IDE slot out of range.
4941	</result>
4942	<result name="VBOX_E_INVALID_OBJECT_STATE">
4943	Attempt to modify an unregistered virtual machine.
4944	</result>
4945	<result name="VBOX_E_INVALID_VM_STATE">
4946	Invalid machine state.
4947	</result>
4948
4949	</desc>
4950	<param name="name" type="wstring" dir="in">
4951	<desc>Name of the storage controller.</desc>
4952	</param>
4953	<param name="controllerPort" type="long" dir="in">
4954	<desc>Storage controller port.</desc>
4955	</param>
4956	<param name="device" type="long" dir="in">
4957	<desc>Device slot in the given port.</desc>
4958	</param>
4959	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4960	<desc>New value for the bandwidth group or NULL for no group.</desc>
4961	</param>
4962	</method>
4963
4964	<method name="mountMedium">
4965	<desc>
4966	Mounts a medium (<link to="IMedium" />, identified
4967	by the given UUID @a id) to the given storage controller
4968	(<link to="IStorageController" />, identified by @a name),
4969	at the indicated port and device. The device must already exist;
4970	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4971
4972	This method is intended only for managing removable media, where the
4973	device is fixed but media is changeable at runtime (such as DVDs
4974	and floppies). It cannot be used for fixed media such as hard disks.
4975
4976	The @a controllerPort and @a device parameters specify the device slot and
4977	have have the same meaning as with <link to="IMachine::attachDevice" />.
4978
4979	The specified device slot can have a medium mounted, which will be
4980	unmounted first. Specifying a zero UUID (or an empty string) for
4981	@a medium does just an unmount.
4982
4983	See <link to="IMedium"/> for more detailed information about
4984	attaching media.
4985
4986	<result name="E_INVALIDARG">
4987	SATA device, SATA port, IDE port or IDE slot out of range.
4988	</result>
4989	<result name="VBOX_E_INVALID_OBJECT_STATE">
4990	Attempt to attach medium to an unregistered virtual machine.
4991	</result>
4992	<result name="VBOX_E_INVALID_VM_STATE">
4993	Invalid machine state.
4994	</result>
4995	<result name="VBOX_E_OBJECT_IN_USE">
4996	Medium already attached to this or another virtual machine.
4997	</result>
4998
4999	</desc>
5000	<param name="name" type="wstring" dir="in">
5001	<desc>Name of the storage controller to attach the medium to.</desc>
5002	</param>
5003	<param name="controllerPort" type="long" dir="in">
5004	<desc>Port to attach the medium to.</desc>
5005	</param>
5006	<param name="device" type="long" dir="in">
5007	<desc>Device slot in the given port to attach the medium to.</desc>
5008	</param>
5009	<param name="medium" type="IMedium" dir="in">
5010	<desc>Medium to mount or NULL for an empty drive.</desc>
5011	</param>
5012	<param name="force" type="boolean" dir="in">
5013	<desc>Allows to force unmount/mount of a medium which is locked by
5014	the device slot in the given port to attach the medium to.</desc>
5015	</param>
5016	</method>
5017
5018	<method name="getMedium" const="yes">
5019	<desc>
5020	Returns the virtual medium attached to a device slot of the specified
5021	bus.
5022
5023	Note that if the medium was indirectly attached by
5024	<link to="#mountMedium"/> to the given device slot then this
5025	method will return not the same object as passed to the
5026	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5027	more detailed information about mounting a medium.
5028
5029	<result name="VBOX_E_OBJECT_NOT_FOUND">
5030	No medium attached to given slot/bus.
5031	</result>
5032
5033	</desc>
5034	<param name="name" type="wstring" dir="in">
5035	<desc>Name of the storage controller the medium is attached to.</desc>
5036	</param>
5037	<param name="controllerPort" type="long" dir="in">
5038	<desc>Port to query.</desc>
5039	</param>
5040	<param name="device" type="long" dir="in">
5041	<desc>Device slot in the given port to query.</desc>
5042	</param>
5043	<param name="medium" type="IMedium" dir="return">
5044	<desc>Attached medium object.</desc>
5045	</param>
5046	</method>
5047
5048	<method name="getMediumAttachmentsOfController" const="yes">
5049	<desc>
5050	Returns an array of medium attachments which are attached to the
5051	the controller with the given name.
5052
5053	<result name="VBOX_E_OBJECT_NOT_FOUND">
5054	A storage controller with given name doesn't exist.
5055	</result>
5056	</desc>
5057	<param name="name" type="wstring" dir="in"/>
5058	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5059	</method>
5060
5061	<method name="getMediumAttachment" const="yes">
5062	<desc>
5063	Returns a medium attachment which corresponds to the controller with
5064	the given name, on the given port and device slot.
5065
5066	<result name="VBOX_E_OBJECT_NOT_FOUND">
5067	No attachment exists for the given controller/port/device combination.
5068	</result>
5069	</desc>
5070	<param name="name" type="wstring" dir="in"/>
5071	<param name="controllerPort" type="long" dir="in"/>
5072	<param name="device" type="long" dir="in"/>
5073	<param name="attachment" type="IMediumAttachment" dir="return"/>
5074	</method>
5075
5076	<method name="attachHostPciDevice">
5077	<desc>
5078	Attaches host PCI device with the given (host) PCI address to the
5079	PCI bus of the virtual machine. Please note, that this operation
5080	is two phase, as real attachment will happen when VM will start,
5081	and most information will be delivered as IHostPciDevicePlugEvent
5082	on IVirtualBox event source.
5083
5084	<see><link to="IHostPciDevicePlugEvent"/></see>
5085
5086	<result name="VBOX_E_INVALID_VM_STATE">
5087	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5088	</result>
5089	<result name="VBOX_E_PDM_ERROR">
5090	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5091	</result>
5092	<result name="VBOX_E_NOT_SUPPORTED">
5093	Hardware or host OS doesn't allow PCI device passthrought.
5094	</result>
5095	</desc>
5096	<param name="hostAddress" type="long" dir="in">
5097	<desc>Address of the host PCI device.</desc>
5098	</param>
5099	<param name="desiredGuestAddress" type="long" dir="in">
5100	<desc>Desired position of this device on guest PCI bus.</desc>
5101	</param>
5102	<param name="tryToUnbind" type="boolean" dir="in">
5103	<desc>If VMM shall try to unbind existing drivers from the
5104	device before attaching it to the guest.</desc>
5105	</param>
5106	</method>
5107
5108	<method name="detachHostPciDevice">
5109	<desc>
5110	Detach host PCI device from the virtual machine.
5111	Also HostPciDevicePlugEvent on IVirtualBox event source
5112	will be delivered. As currently we don't support hot device
5113	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5114
5115	<see><link to="IHostPciDevicePlugEvent"/></see>
5116
5117	<result name="VBOX_E_INVALID_VM_STATE">
5118	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5119	</result>
5120	<result name="VBOX_E_OBJECT_NOT_FOUND">
5121	This host device is not attached to this machine.
5122	</result>
5123	<result name="VBOX_E_PDM_ERROR">
5124	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5125	</result>
5126	<result name="VBOX_E_NOT_SUPPORTED">
5127	Hardware or host OS doesn't allow PCI device passthrought.
5128	</result>
5129	</desc>
5130	<param name="hostAddress" type="long" dir="in">
5131	<desc>Address of the host PCI device.</desc>
5132	</param>
5133	</method>
5134
5135	<method name="getNetworkAdapter" const="yes">
5136	<desc>
5137	Returns the network adapter associated with the given slot.
5138	Slots are numbered sequentially, starting with zero. The total
5139	number of adapters per machine is defined by the
5140	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5141	so the maximum slot number is one less than that property's value.
5142
5143	<result name="E_INVALIDARG">
5144	Invalid @a slot number.
5145	</result>
5146
5147	</desc>
5148	<param name="slot" type="unsigned long" dir="in"/>
5149	<param name="adapter" type="INetworkAdapter" dir="return"/>
5150	</method>
5151
5152	<method name="addStorageController">
5153	<desc>
5154	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5155	machine and returns it as an instance of
5156	<link to="IStorageController" />.
5157
5158	@a name identifies the controller for subsequent calls such as
5159	<link to="#getStorageControllerByName" />,
5160	<link to="#getStorageControllerByInstance" />,
5161	<link to="#removeStorageController" />,
5162	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5163
5164	After the controller has been added, you can set its exact
5165	type by setting the <link to="IStorageController::controllerType" />.
5166
5167	<result name="VBOX_E_OBJECT_IN_USE">
5168	A storage controller with given name exists already.
5169	</result>
5170	<result name="E_INVALIDARG">
5171	Invalid @a controllerType.
5172	</result>
5173	</desc>
5174	<param name="name" type="wstring" dir="in"/>
5175	<param name="connectionType" type="StorageBus" dir="in"/>
5176	<param name="controller" type="IStorageController" dir="return"/>
5177	</method>
5178
5179	<method name="getStorageControllerByName" const="yes">
5180	<desc>
5181	Returns a storage controller with the given name.
5182
5183	<result name="VBOX_E_OBJECT_NOT_FOUND">
5184	A storage controller with given name doesn't exist.
5185	</result>
5186	</desc>
5187	<param name="name" type="wstring" dir="in"/>
5188	<param name="storageController" type="IStorageController" dir="return"/>
5189	</method>
5190
5191	<method name="getStorageControllerByInstance" const="yes">
5192	<desc>
5193	Returns a storage controller with the given instance number.
5194
5195	<result name="VBOX_E_OBJECT_NOT_FOUND">
5196	A storage controller with given instance number doesn't exist.
5197	</result>
5198	</desc>
5199	<param name="instance" type="unsigned long" dir="in"/>
5200	<param name="storageController" type="IStorageController" dir="return"/>
5201	</method>
5202
5203	<method name="removeStorageController">
5204	<desc>
5205	Removes a storage controller from the machine with all devices attached to it.
5206
5207	<result name="VBOX_E_OBJECT_NOT_FOUND">
5208	A storage controller with given name doesn't exist.
5209	</result>
5210	<result name="VBOX_E_NOT_SUPPORTED">
5211	Medium format does not support storage deletion (only for implicitly
5212	created differencing media, should not happen).
5213	</result>
5214	</desc>
5215	<param name="name" type="wstring" dir="in"/>
5216	</method>
5217
5218	<method name="setStorageControllerBootable">
5219	<desc>
5220	Sets the bootable flag of the storage controller with the given name.
5221
5222	<result name="VBOX_E_OBJECT_NOT_FOUND">
5223	A storage controller with given name doesn't exist.
5224	</result>
5225	<result name="VBOX_E_OBJECT_IN_USE">
5226	Another storage controller is marked as bootable already.
5227	</result>
5228	</desc>
5229	<param name="name" type="wstring" dir="in"/>
5230	<param name="bootable" type="boolean" dir="in"/>
5231	</method>
5232
5233	<method name="getSerialPort" const="yes">
5234	<desc>
5235	Returns the serial port associated with the given slot.
5236	Slots are numbered sequentially, starting with zero. The total
5237	number of serial ports per machine is defined by the
5238	<link to="ISystemProperties::serialPortCount"/> property,
5239	so the maximum slot number is one less than that property's value.
5240
5241	<result name="E_INVALIDARG">
5242	Invalid @a slot number.
5243	</result>
5244
5245	</desc>
5246	<param name="slot" type="unsigned long" dir="in"/>
5247	<param name="port" type="ISerialPort" dir="return"/>
5248	</method>
5249
5250	<method name="getParallelPort" const="yes">
5251	<desc>
5252	Returns the parallel port associated with the given slot.
5253	Slots are numbered sequentially, starting with zero. The total
5254	number of parallel ports per machine is defined by the
5255	<link to="ISystemProperties::parallelPortCount"/> property,
5256	so the maximum slot number is one less than that property's value.
5257
5258	<result name="E_INVALIDARG">
5259	Invalid @a slot number.
5260	</result>
5261
5262	</desc>
5263	<param name="slot" type="unsigned long" dir="in"/>
5264	<param name="port" type="IParallelPort" dir="return"/>
5265	</method>
5266
5267	<method name="getExtraDataKeys">
5268	<desc>
5269	Returns an array representing the machine-specific extra data keys
5270	which currently have values defined.
5271	</desc>
5272	<param name="value" type="wstring" dir="return" safearray="yes">
5273	<desc>Array of extra data keys.</desc>
5274	</param>
5275	</method>
5276
5277	<method name="getExtraData">
5278	<desc>
5279	Returns associated machine-specific extra data.
5280
5281	If the requested data @a key does not exist, this function will
5282	succeed and return an empty string in the @a value argument.
5283
5284	<result name="VBOX_E_FILE_ERROR">
5285	Settings file not accessible.
5286	</result>
5287	<result name="VBOX_E_XML_ERROR">
5288	Could not parse the settings file.
5289	</result>
5290
5291	</desc>
5292	<param name="key" type="wstring" dir="in">
5293	<desc>Name of the data key to get.</desc>
5294	</param>
5295	<param name="value" type="wstring" dir="return">
5296	<desc>Value of the requested data key.</desc>
5297	</param>
5298	</method>
5299
5300	<method name="setExtraData">
5301	<desc>
5302	Sets associated machine-specific extra data.
5303
5304	If you pass @c null or an empty string as a key @a value, the given
5305	@a key will be deleted.
5306
5307	<note>
5308	Before performing the actual data change, this method will ask all
5309	registered listeners using the
5310	<link to="IExtraDataCanChangeEvent"/>
5311	notification for a permission. If one of the listeners refuses the
5312	new value, the change will not be performed.
5313	</note>
5314	<note>
5315	On success, the
5316	<link to="IExtraDataChangedEvent"/> notification
5317	is called to inform all registered listeners about a successful data
5318	change.
5319	</note>
5320	<note>
5321	This method can be called outside the machine session and therefore
5322	it's a caller's responsibility to handle possible race conditions
5323	when several clients change the same key at the same time.
5324	</note>
5325
5326	<result name="VBOX_E_FILE_ERROR">
5327	Settings file not accessible.
5328	</result>
5329	<result name="VBOX_E_XML_ERROR">
5330	Could not parse the settings file.
5331	</result>
5332
5333	</desc>
5334	<param name="key" type="wstring" dir="in">
5335	<desc>Name of the data key to set.</desc>
5336	</param>
5337	<param name="value" type="wstring" dir="in">
5338	<desc>Value to assign to the key.</desc>
5339	</param>
5340	</method>
5341
5342	<method name="getCPUProperty" const="yes">
5343	<desc>
5344	Returns the virtual CPU boolean value of the specified property.
5345
5346	<result name="E_INVALIDARG">
5347	Invalid property.
5348	</result>
5349
5350	</desc>
5351	<param name="property" type="CPUPropertyType" dir="in">
5352	<desc>
5353	Property type to query.
5354	</desc>
5355	</param>
5356	<param name="value" type="boolean" dir="return">
5357	<desc>
5358	Property value.
5359	</desc>
5360	</param>
5361	</method>
5362
5363	<method name="setCPUProperty">
5364	<desc>
5365	Sets the virtual CPU boolean value of the specified property.
5366
5367	<result name="E_INVALIDARG">
5368	Invalid property.
5369	</result>
5370
5371	</desc>
5372	<param name="property" type="CPUPropertyType" dir="in">
5373	<desc>
5374	Property type to query.
5375	</desc>
5376	</param>
5377	<param name="value" type="boolean" dir="in">
5378	<desc>
5379	Property value.
5380	</desc>
5381	</param>
5382	</method>
5383
5384	<method name="getCPUIDLeaf" const="yes">
5385	<desc>
5386	Returns the virtual CPU cpuid information for the specified leaf.
5387
5388	Currently supported index values for cpuid:
5389	Standard CPUID leafs: 0 - 0xA
5390	Extended CPUID leafs: 0x80000000 - 0x8000000A
5391
5392	See the Intel and AMD programmer's manuals for detailed information
5393	about the cpuid instruction and its leafs.
5394	<result name="E_INVALIDARG">
5395	Invalid id.
5396	</result>
5397
5398	</desc>
5399	<param name="id" type="unsigned long" dir="in">
5400	<desc>
5401	CPUID leaf index.
5402	</desc>
5403	</param>
5404	<param name="valEax" type="unsigned long" dir="out">
5405	<desc>
5406	CPUID leaf value for register eax.
5407	</desc>
5408	</param>
5409	<param name="valEbx" type="unsigned long" dir="out">
5410	<desc>
5411	CPUID leaf value for register ebx.
5412	</desc>
5413	</param>
5414	<param name="valEcx" type="unsigned long" dir="out">
5415	<desc>
5416	CPUID leaf value for register ecx.
5417	</desc>
5418	</param>
5419	<param name="valEdx" type="unsigned long" dir="out">
5420	<desc>
5421	CPUID leaf value for register edx.
5422	</desc>
5423	</param>
5424	</method>
5425
5426	<method name="setCPUIDLeaf">
5427	<desc>
5428	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5429	are not passed unmodified. VirtualBox clears features that it doesn't support.
5430
5431	Currently supported index values for cpuid:
5432	Standard CPUID leafs: 0 - 0xA
5433	Extended CPUID leafs: 0x80000000 - 0x8000000A
5434
5435	See the Intel and AMD programmer's manuals for detailed information
5436	about the cpuid instruction and its leafs.
5437
5438	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5439	random crashes inside VMs.
5440	<result name="E_INVALIDARG">
5441	Invalid id.
5442	</result>
5443
5444	</desc>
5445	<param name="id" type="unsigned long" dir="in">
5446	<desc>
5447	CPUID leaf index.
5448	</desc>
5449	</param>
5450	<param name="valEax" type="unsigned long" dir="in">
5451	<desc>
5452	CPUID leaf value for register eax.
5453	</desc>
5454	</param>
5455	<param name="valEbx" type="unsigned long" dir="in">
5456	<desc>
5457	CPUID leaf value for register ebx.
5458	</desc>
5459	</param>
5460	<param name="valEcx" type="unsigned long" dir="in">
5461	<desc>
5462	CPUID leaf value for register ecx.
5463	</desc>
5464	</param>
5465	<param name="valEdx" type="unsigned long" dir="in">
5466	<desc>
5467	CPUID leaf value for register edx.
5468	</desc>
5469	</param>
5470	</method>
5471
5472	<method name="removeCPUIDLeaf">
5473	<desc>
5474	Removes the virtual CPU cpuid leaf for the specified index
5475
5476	<result name="E_INVALIDARG">
5477	Invalid id.
5478	</result>
5479
5480	</desc>
5481	<param name="id" type="unsigned long" dir="in">
5482	<desc>
5483	CPUID leaf index.
5484	</desc>
5485	</param>
5486	</method>
5487
5488	<method name="removeAllCPUIDLeaves">
5489	<desc>
5490	Removes all the virtual CPU cpuid leaves
5491	</desc>
5492	</method>
5493
5494	<method name="getHWVirtExProperty" const="yes">
5495	<desc>
5496	Returns the value of the specified hardware virtualization boolean property.
5497
5498	<result name="E_INVALIDARG">
5499	Invalid property.
5500	</result>
5501
5502	</desc>
5503	<param name="property" type="HWVirtExPropertyType" dir="in">
5504	<desc>
5505	Property type to query.
5506	</desc>
5507	</param>
5508	<param name="value" type="boolean" dir="return">
5509	<desc>
5510	Property value.
5511	</desc>
5512	</param>
5513	</method>
5514
5515	<method name="setHWVirtExProperty">
5516	<desc>
5517	Sets a new value for the specified hardware virtualization boolean property.
5518
5519	<result name="E_INVALIDARG">
5520	Invalid property.
5521	</result>
5522
5523	</desc>
5524	<param name="property" type="HWVirtExPropertyType" dir="in">
5525	<desc>
5526	Property type to set.
5527	</desc>
5528	</param>
5529	<param name="value" type="boolean" dir="in">
5530	<desc>
5531	New property value.
5532	</desc>
5533	</param>
5534	</method>
5535
5536	<method name="saveSettings">
5537	<desc>
5538	Saves any changes to machine settings made since the session
5539	has been opened or a new machine has been created, or since the
5540	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5541	For registered machines, new settings become visible to all
5542	other VirtualBox clients after successful invocation of this
5543	method.
5544	<note>
5545	The method sends <link to="IMachineDataChangedEvent"/>
5546	notification event after the configuration has been successfully
5547	saved (only for registered machines).
5548	</note>
5549	<note>
5550	Calling this method is only valid on instances returned
5551	by <link to="ISession::machine"/> and on new machines
5552	created by <link to="IVirtualBox::createMachine"/> but not
5553	yet registered, or on unregistered machines after calling
5554	<link to="IMachine::unregister"/>.
5555	</note>
5556
5557	<result name="VBOX_E_FILE_ERROR">
5558	Settings file not accessible.
5559	</result>
5560	<result name="VBOX_E_XML_ERROR">
5561	Could not parse the settings file.
5562	</result>
5563	<result name="E_ACCESSDENIED">
5564	Modification request refused.
5565	</result>
5566
5567	</desc>
5568	</method>
5569
5570	<method name="discardSettings">
5571	<desc>
5572	Discards any changes to the machine settings made since the session
5573	has been opened or since the last call to <link to="#saveSettings"/>
5574	or <link to="#discardSettings"/>.
5575	<note>
5576	Calling this method is only valid on instances returned
5577	by <link to="ISession::machine"/> and on new machines
5578	created by <link to="IVirtualBox::createMachine"/> or
5579	opened by <link to="IVirtualBox::openMachine"/> but not
5580	yet registered, or on unregistered machines after calling
5581	<link to="IMachine::unregister"/>.
5582	</note>
5583
5584	<result name="VBOX_E_INVALID_VM_STATE">
5585	Virtual machine is not mutable.
5586	</result>
5587
5588	</desc>
5589	</method>
5590
5591	<method name="unregister">
5592	<desc>
5593	Unregisters a machine previously registered with
5594	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5595	cleanup before the machine is unregistered.
5596
5597	This method does not delete any files. It only changes the machine configuration and
5598	the list of registered machines in the VirtualBox object. To delete the files which
5599	belonged to the machine, including the XML file of the machine itself, call
5600	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5601	from this method.
5602
5603	How thoroughly this method cleans up the machine configuration before unregistering
5604	the machine depends on the @a cleanupMode argument.
5605
5606	<ul>
5607	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5608	cleanup will be performed. The call will fail if the machine is in "Saved" state
5609	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5610	It is the responsibility of the caller to delete all such configuration in this mode.
5611	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5612	which it replaces.</li>
5613	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5614	state or if it has snapshots or media attached. All media attached to the current machine
5615	state or in snapshots will be detached. No medium objects will be returned;
5616	all of the machine's media will remain open.</li>
5617	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5618	except that all the hard disk medium objects which were detached from the machine will
5619	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5620	API for closing and deletion.</li>
5621	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5622	that all media will be returned in the array, including removable media like DVDs and
5623	floppies. This might be useful if the user wants to inspect in detail which media were
5624	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5625	in that case because users will typically want to preserve ISO and RAW image files.</li>
5626	</ul>
5627
5628	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5629	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5630	deleted with all its saved states and hard disk images, but images for removable
5631	drives (such as ISO and RAW files) will remain on disk.
5632
5633	This API does not verify whether the media files returned in the array are still
5634	attached to other machines (i.e. shared between several machines). If such a shared
5635	image is passed to <link to="#delete" /> however, closing the image will fail there
5636	and the image will be silently skipped.
5637
5638	This API may, however, move media from this machine's media registry to other media
5639	registries (see <link to="IMedium" /> for details on media registries). For machines
5640	created with VirtualBox 4.0 or later, if media from this machine's media registry
5641	are also attached to another machine (shared attachments), each such medium will be
5642	moved to another machine's registry. This is because without this machine's media
5643	registry, the other machine cannot find its media any more and would become inaccessible.
5644
5645	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5646	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5647	if media are moved to other machines' media registries.
5648
5649	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5650	is fired.
5651
5652	The call will fail if the machine is currently locked (see <link to="ISession" />).
5653
5654	<note>
5655	If the given machine is inaccessible (see <link to="#accessible"/>), it
5656	will be unregistered and fully uninitialized right afterwards. As a result,
5657	the returned machine object will be unusable and an attempt to call
5658	<b>any</b> method will return the "Object not ready" error.
5659	</note>
5660
5661	<result name="VBOX_E_INVALID_OBJECT_STATE">
5662	Machine is currently locked for a session.
5663	</result>
5664	</desc>
5665
5666	<param name="cleanupMode" type="CleanupMode" dir="in">
5667	<desc>How to clean up after the machine has been unregistered.</desc>
5668	</param>
5669	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5670	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5671	</param>
5672	</method>
5673
5674	<method name="delete">
5675	<desc>
5676	Deletes the files associated with this machine from disk. If medium objects are passed
5677	in with the @a aMedia argument, they are closed and, if closing was successful, their
5678	storage files are deleted as well. For convenience, this array of media files can be
5679	the same as the one returned from a previous <link to="#unregister" /> call.
5680
5681	This method must only be called on machines which are either write-locked (i.e. on instances
5682	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5683	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5684	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5685
5686	The following files will be deleted by this method:
5687	<ul>
5688	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5689	argument other than "UnregisterOnly", this will delete all saved state files that
5690	the machine had in use; possibly one if the machine was in "Saved" state and one
5691	for each online snapshot that the machine had.</li>
5692	<li>On each medium object passed in the @a aMedia array, this will call
5693	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5694	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5695	in use, e.g. because it is still attached to a second machine; in that case the
5696	storage will not be deleted.</li>
5697	<li>Finally, the machine's own XML file will be deleted.</li>
5698	</ul>
5699
5700	Since deleting large disk image files can be a time-consuming I/O operation, this
5701	method operates asynchronously and returns an IProgress object to allow the caller
5702	to monitor the progress. There will be one sub-operation for each file that is
5703	being deleted (saved state or medium storage file).
5704
5705	<note>
5706	<link to="#settingsModified"/> will return @c true after this
5707	method successfully returns.
5708	</note>
5709
5710	<result name="VBOX_E_INVALID_VM_STATE">
5711	Machine is registered but not write-locked.
5712	</result>
5713	<result name="VBOX_E_IPRT_ERROR">
5714	Could not delete the settings file.
5715	</result>
5716	</desc>
5717	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5718	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5719	</param>
5720	<param name="aProgress" type="IProgress" dir="return">
5721	<desc>Progress object to track the operation completion.</desc>
5722	</param>
5723	</method>
5724
5725	<method name="export">
5726	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5727	steps required to export VirtualBox machines to OVF.
5728	</desc>
5729
5730	<param name="aAppliance" type="IAppliance" dir="in">
5731	<desc>Appliance to export this machine to.</desc>
5732	</param>
5733	<param name="location" type="wstring" dir="in">
5734	<desc>The target location.</desc>
5735	</param>
5736	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5737	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5738	</param>
5739	</method >
5740
5741	<method name="findSnapshot">
5742	<desc>
5743	Returns a snapshot of this machine with the given name or UUID.
5744
5745	Returns a snapshot of this machine with the given UUID.
5746	A @c null argument can be used to obtain the first snapshot
5747	taken on this machine. To traverse the whole tree of snapshots
5748	starting from the root, inspect the root snapshot's
5749	<link to="ISnapshot::children" /> attribute and recurse over those children.
5750
5751	<result name="VBOX_E_OBJECT_NOT_FOUND">
5752	Virtual machine has no snapshots or snapshot not found.
5753	</result>
5754
5755	</desc>
5756	<param name="nameOrId" type="wstring" dir="in">
5757	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5758	</param>
5759	<param name="snapshot" type="ISnapshot" dir="return">
5760	<desc>Snapshot object with the given name.</desc>
5761	</param>
5762	</method>
5763
5764	<method name="createSharedFolder">
5765	<desc>
5766	Creates a new permanent shared folder by associating the given logical
5767	name with the given host path, adds it to the collection of shared
5768	folders and starts sharing it. Refer to the description of
5769	<link to="ISharedFolder"/> to read more about logical names.
5770
5771	<result name="VBOX_E_OBJECT_IN_USE">
5772	Shared folder already exists.
5773	</result>
5774	<result name="VBOX_E_FILE_ERROR">
5775	Shared folder @a hostPath not accessible.
5776	</result>
5777
5778	</desc>
5779	<param name="name" type="wstring" dir="in">
5780	<desc>Unique logical name of the shared folder.</desc>
5781	</param>
5782	<param name="hostPath" type="wstring" dir="in">
5783	<desc>Full path to the shared folder in the host file system.</desc>
5784	</param>
5785	<param name="writable" type="boolean" dir="in">
5786	<desc>Whether the share is writable or readonly.</desc>
5787	</param>
5788	<param name="automount" type="boolean" dir="in">
5789	<desc>Whether the share gets automatically mounted by the guest
5790	or not.</desc>
5791	</param>
5792	</method>
5793
5794	<method name="removeSharedFolder">
5795	<desc>
5796	Removes the permanent shared folder with the given name previously
5797	created by <link to="#createSharedFolder"/> from the collection of
5798	shared folders and stops sharing it.
5799
5800	<result name="VBOX_E_INVALID_VM_STATE">
5801	Virtual machine is not mutable.
5802	</result>
5803	<result name="VBOX_E_OBJECT_NOT_FOUND">
5804	Shared folder @a name does not exist.
5805	</result>
5806
5807	</desc>
5808	<param name="name" type="wstring" dir="in">
5809	<desc>Logical name of the shared folder to remove.</desc>
5810	</param>
5811	</method>
5812
5813	<method name="canShowConsoleWindow">
5814	<desc>
5815	Returns @c true if the VM console process can activate the
5816	console window and bring it to foreground on the desktop of
5817	the host PC.
5818	<note>
5819	This method will fail if a session for this machine is not
5820	currently open.
5821	</note>
5822
5823	<result name="VBOX_E_INVALID_VM_STATE">
5824	Machine session is not open.
5825	</result>
5826
5827	</desc>
5828	<param name="canShow" type="boolean" dir="return">
5829	<desc>
5830	@c true if the console window can be shown and @c false otherwise.
5831	</desc>
5832	</param>
5833	</method>
5834
5835	<method name="showConsoleWindow">
5836	<desc>
5837	Activates the console window and brings it to foreground on
5838	the desktop of the host PC. Many modern window managers on
5839	many platforms implement some sort of focus stealing
5840	prevention logic, so that it may be impossible to activate
5841	a window without the help of the currently active
5842	application. In this case, this method will return a non-zero
5843	identifier that represents the top-level window of the VM
5844	console process. The caller, if it represents a currently
5845	active process, is responsible to use this identifier (in a
5846	platform-dependent manner) to perform actual window
5847	activation.
5848	<note>
5849	This method will fail if a session for this machine is not
5850	currently open.
5851	</note>
5852
5853	<result name="VBOX_E_INVALID_VM_STATE">
5854	Machine session is not open.
5855	</result>
5856
5857	</desc>
5858	<param name="winId" type="long long" dir="return">
5859	<desc>
5860	Platform-dependent identifier of the top-level VM console
5861	window, or zero if this method has performed all actions
5862	necessary to implement the <i>show window</i> semantics for
5863	the given platform and/or VirtualBox front-end.
5864	</desc>
5865	</param>
5866	</method>
5867
5868	<method name="getGuestProperty" const="yes">
5869	<desc>
5870	Reads an entry from the machine's guest property store.
5871
5872	<result name="VBOX_E_INVALID_VM_STATE">
5873	Machine session is not open.
5874	</result>
5875
5876	</desc>
5877	<param name="name" type="wstring" dir="in">
5878	<desc>
5879	The name of the property to read.
5880	</desc>
5881	</param>
5882	<param name="value" type="wstring" dir="out">
5883	<desc>
5884	The value of the property. If the property does not exist then this
5885	will be empty.
5886	</desc>
5887	</param>
5888	<param name="timestamp" type="long long" dir="out">
5889	<desc>
5890	The time at which the property was last modified, as seen by the
5891	server process.
5892	</desc>
5893	</param>
5894	<param name="flags" type="wstring" dir="out">
5895	<desc>
5896	Additional property parameters, passed as a comma-separated list of
5897	"name=value" type entries.
5898	</desc>
5899	</param>
5900	</method>
5901
5902	<method name="getGuestPropertyValue" const="yes">
5903	<desc>
5904	Reads a value from the machine's guest property store.
5905
5906	<result name="VBOX_E_INVALID_VM_STATE">
5907	Machine session is not open.
5908	</result>
5909
5910	</desc>
5911	<param name="property" type="wstring" dir="in">
5912	<desc>
5913	The name of the property to read.
5914	</desc>
5915	</param>
5916	<param name="value" type="wstring" dir="return">
5917	<desc>
5918	The value of the property. If the property does not exist then this
5919	will be empty.
5920	</desc>
5921	</param>
5922	</method>
5923
5924	<method name="getGuestPropertyTimestamp" const="yes">
5925	<desc>
5926	Reads a property timestamp from the machine's guest property store.
5927
5928	<result name="VBOX_E_INVALID_VM_STATE">
5929	Machine session is not open.
5930	</result>
5931
5932	</desc>
5933	<param name="property" type="wstring" dir="in">
5934	<desc>
5935	The name of the property to read.
5936	</desc>
5937	</param>
5938	<param name="value" type="long long" dir="return">
5939	<desc>
5940	The timestamp. If the property does not exist then this will be
5941	empty.
5942	</desc>
5943	</param>
5944	</method>
5945
5946	<method name="setGuestProperty">
5947	<desc>
5948	Sets, changes or deletes an entry in the machine's guest property
5949	store.
5950
5951	<result name="E_ACCESSDENIED">
5952	Property cannot be changed.
5953	</result>
5954	<result name="E_INVALIDARG">
5955	Invalid @a flags.
5956	</result>
5957	<result name="VBOX_E_INVALID_VM_STATE">
5958	Virtual machine is not mutable or session not open.
5959	</result>
5960	<result name="VBOX_E_INVALID_OBJECT_STATE">
5961	Cannot set transient property when machine not running.
5962	</result>
5963
5964	</desc>
5965	<param name="property" type="wstring" dir="in">
5966	<desc>
5967	The name of the property to set, change or delete.
5968	</desc>
5969	</param>
5970	<param name="value" type="wstring" dir="in">
5971	<desc>
5972	The new value of the property to set, change or delete. If the
5973	property does not yet exist and value is non-empty, it will be
5974	created. If the value is @c null or empty, the property will be
5975	deleted if it exists.
5976	</desc>
5977	</param>
5978	<param name="flags" type="wstring" dir="in">
5979	<desc>
5980	Additional property parameters, passed as a comma-separated list of
5981	"name=value" type entries.
5982	</desc>
5983	</param>
5984	</method>
5985
5986	<method name="setGuestPropertyValue">
5987	<desc>
5988	Sets, changes or deletes a value in the machine's guest property
5989	store. The flags field will be left unchanged or created empty for a
5990	new property.
5991
5992	<result name="E_ACCESSDENIED">
5993	Property cannot be changed.
5994	</result>
5995	<result name="VBOX_E_INVALID_VM_STATE">
5996	Virtual machine is not mutable or session not open.
5997	</result>
5998	<result name="VBOX_E_INVALID_OBJECT_STATE">
5999	Cannot set transient property when machine not running.
6000	</result>
6001	</desc>
6002
6003	<param name="property" type="wstring" dir="in">
6004	<desc>
6005	The name of the property to set, change or delete.
6006	</desc>
6007	</param>
6008	<param name="value" type="wstring" dir="in">
6009	<desc>
6010	The new value of the property to set, change or delete. If the
6011	property does not yet exist and value is non-empty, it will be
6012	created. If the value is @c null or empty, the property will be
6013	deleted if it exists.
6014	</desc>
6015	</param>
6016	</method>
6017
6018	<method name="deleteGuestProperty" const="yes">
6019	<desc>
6020	Deletes an entry from the machine's guest property store.
6021
6022	<result name="VBOX_E_INVALID_VM_STATE">
6023	Machine session is not open.
6024	</result>
6025
6026	</desc>
6027	<param name="name" type="wstring" dir="in">
6028	<desc>
6029	The name of the property to delete.
6030	</desc>
6031	</param>
6032	</method>
6033
6034	<method name="enumerateGuestProperties" const="yes">
6035	<desc>
6036	Return a list of the guest properties matching a set of patterns along
6037	with their values, time stamps and flags.
6038	</desc>
6039	<param name="patterns" type="wstring" dir="in">
6040	<desc>
6041	The patterns to match the properties against, separated by '\|'
6042	characters. If this is empty or @c null, all properties will match.
6043	</desc>
6044	</param>
6045	<param name="name" type="wstring" dir="out" safearray="yes">
6046	<desc>
6047	The names of the properties returned.
6048	</desc>
6049	</param>
6050	<param name="value" type="wstring" dir="out" safearray="yes">
6051	<desc>
6052	The values of the properties returned. The array entries match the
6053	corresponding entries in the @a name array.
6054	</desc>
6055	</param>
6056	<param name="timestamp" type="long long" dir="out" safearray="yes">
6057	<desc>
6058	The time stamps of the properties returned. The array entries match
6059	the corresponding entries in the @a name array.
6060	</desc>
6061	</param>
6062	<param name="flags" type="wstring" dir="out" safearray="yes">
6063	<desc>
6064	The flags of the properties returned. The array entries match the
6065	corresponding entries in the @a name array.
6066	</desc>
6067	</param>
6068	</method>
6069
6070	<method name="querySavedGuestScreenInfo" const="yes">
6071	<desc>
6072	Returns the guest dimensions from the saved state.
6073	</desc>
6074	<param name="screenId" type="unsigned long" dir="in">
6075	<desc>
6076	Saved guest screen to query info from.
6077	</desc>
6078	</param>
6079	<param name="originX" type="unsigned long" dir="out">
6080	<desc>
6081	The X position of the guest monitor top left corner.
6082	</desc>
6083	</param>
6084	<param name="originY" type="unsigned long" dir="out">
6085	<desc>
6086	The Y position of the guest monitor top left corner.
6087	</desc>
6088	</param>
6089	<param name="width" type="unsigned long" dir="out">
6090	<desc>
6091	Guest width at the time of the saved state was taken.
6092	</desc>
6093	</param>
6094	<param name="height" type="unsigned long" dir="out">
6095	<desc>
6096	Guest height at the time of the saved state was taken.
6097	</desc>
6098	</param>
6099	<param name="enabled" type="boolean" dir="out">
6100	<desc>
6101	Whether the monitor is enabled in the guest.
6102	</desc>
6103	</param>
6104	</method>
6105
6106	<method name="querySavedThumbnailSize">
6107	<desc>
6108	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6109	</desc>
6110	<param name="screenId" type="unsigned long" dir="in">
6111	<desc>
6112	Saved guest screen to query info from.
6113	</desc>
6114	</param>
6115	<param name="size" type="unsigned long" dir="out">
6116	<desc>
6117	Size of buffer required to store the bitmap.
6118	</desc>
6119	</param>
6120	<param name="width" type="unsigned long" dir="out">
6121	<desc>
6122	Bitmap width.
6123	</desc>
6124	</param>
6125	<param name="height" type="unsigned long" dir="out">
6126	<desc>
6127	Bitmap height.
6128	</desc>
6129	</param>
6130	</method>
6131
6132	<method name="readSavedThumbnailToArray">
6133	<desc>
6134	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6135	</desc>
6136	<param name="screenId" type="unsigned long" dir="in">
6137	<desc>
6138	Saved guest screen to read from.
6139	</desc>
6140	</param>
6141	<param name="BGR" type="boolean" dir="in">
6142	<desc>
6143	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6144	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6145	</desc>
6146	</param>
6147	<param name="width" type="unsigned long" dir="out">
6148	<desc>
6149	Bitmap width.
6150	</desc>
6151	</param>
6152	<param name="height" type="unsigned long" dir="out">
6153	<desc>
6154	Bitmap height.
6155	</desc>
6156	</param>
6157	<param name="data" type="octet" safearray="yes" dir="return">
6158	<desc>
6159	Array with resulting bitmap data.
6160	</desc>
6161	</param>
6162	</method>
6163
6164	<method name="readSavedThumbnailPNGToArray">
6165	<desc>
6166	Thumbnail in PNG format is retrieved to an array of bytes.
6167	</desc>
6168	<param name="screenId" type="unsigned long" dir="in">
6169	<desc>
6170	Saved guest screen to read from.
6171	</desc>
6172	</param>
6173	<param name="width" type="unsigned long" dir="out">
6174	<desc>
6175	Image width.
6176	</desc>
6177	</param>
6178	<param name="height" type="unsigned long" dir="out">
6179	<desc>
6180	Image height.
6181	</desc>
6182	</param>
6183	<param name="data" type="octet" dir="return" safearray="yes">
6184	<desc>
6185	Array with resulting PNG data.
6186	</desc>
6187	</param>
6188	</method>
6189
6190	<method name="querySavedScreenshotPNGSize">
6191	<desc>
6192	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6193	</desc>
6194	<param name="screenId" type="unsigned long" dir="in">
6195	<desc>
6196	Saved guest screen to query info from.
6197	</desc>
6198	</param>
6199	<param name="size" type="unsigned long" dir="out">
6200	<desc>
6201	Size of buffer required to store the PNG binary data.
6202	</desc>
6203	</param>
6204	<param name="width" type="unsigned long" dir="out">
6205	<desc>
6206	Image width.
6207	</desc>
6208	</param>
6209	<param name="height" type="unsigned long" dir="out">
6210	<desc>
6211	Image height.
6212	</desc>
6213	</param>
6214	</method>
6215
6216	<method name="readSavedScreenshotPNGToArray">
6217	<desc>
6218	Screenshot in PNG format is retrieved to an array of bytes.
6219	</desc>
6220	<param name="screenId" type="unsigned long" dir="in">
6221	<desc>
6222	Saved guest screen to read from.
6223	</desc>
6224	</param>
6225	<param name="width" type="unsigned long" dir="out">
6226	<desc>
6227	Image width.
6228	</desc>
6229	</param>
6230	<param name="height" type="unsigned long" dir="out">
6231	<desc>
6232	Image height.
6233	</desc>
6234	</param>
6235	<param name="data" type="octet" dir="return" safearray="yes">
6236	<desc>
6237	Array with resulting PNG data.
6238	</desc>
6239	</param>
6240	</method>
6241
6242	<method name="hotPlugCPU">
6243	<desc>
6244	Plugs a CPU into the machine.
6245	</desc>
6246	<param name="cpu" type="unsigned long" dir="in">
6247	<desc>
6248	The CPU id to insert.
6249	</desc>
6250	</param>
6251	</method>
6252
6253	<method name="hotUnplugCPU">
6254	<desc>
6255	Removes a CPU from the machine.
6256	</desc>
6257	<param name="cpu" type="unsigned long" dir="in">
6258	<desc>
6259	The CPU id to remove.
6260	</desc>
6261	</param>
6262	</method>
6263
6264	<method name="getCPUStatus">
6265	<desc>
6266	Returns the current status of the given CPU.
6267	</desc>
6268	<param name="cpu" type="unsigned long" dir="in">
6269	<desc>
6270	The CPU id to check for.
6271	</desc>
6272	</param>
6273	<param name="attached" type="boolean" dir="return">
6274	<desc>
6275	Status of the CPU.
6276	</desc>
6277	</param>
6278	</method>
6279
6280	<method name="queryLogFilename">
6281	<desc>
6282	Queries for the VM log file name of an given index. Returns an empty
6283	string if a log file with that index doesn't exists.
6284	</desc>
6285	<param name="idx" type="unsigned long" dir="in">
6286	<desc>
6287	Which log file name to query. 0=current log file.
6288	</desc>
6289	</param>
6290	<param name="filename" type="wstring" dir="return">
6291	<desc>
6292	On return the full path to the log file or an empty string on error.
6293	</desc>
6294	</param>
6295	</method>
6296
6297	<method name="readLog">
6298	<desc>
6299	Reads the VM log file. The chunk size is limited, so even if you
6300	ask for a big piece there might be less data returned.
6301	</desc>
6302	<param name="idx" type="unsigned long" dir="in">
6303	<desc>
6304	Which log file to read. 0=current log file.
6305	</desc>
6306	</param>
6307	<param name="offset" type="long long" dir="in">
6308	<desc>
6309	Offset in the log file.
6310	</desc>
6311	</param>
6312	<param name="size" type="long long" dir="in">
6313	<desc>
6314	Chunk size to read in the log file.
6315	</desc>
6316	</param>
6317	<param name="data" type="octet" dir="return" safearray="yes">
6318	<desc>
6319	Data read from the log file. A data size of 0 means end of file
6320	if the requested chunk size was not 0. This is the unprocessed
6321	file data, i.e. the line ending style depends on the platform of
6322	the system the server is running on.
6323	</desc>
6324	</param>
6325	</method>
6326
6327	<method name="cloneTo">
6328	<desc>
6329	Creates a clone of this machine, either as a full clone (which means
6330	creating independent copies of the hard disk media, save states and so
6331	on), or as a linked clone (which uses its own differencing media,
6332	sharing the parent media with the source machine).
6333
6334	The target machine object must have been created previously with <link
6335	to="IVirtualBox::createMachine"/>, and all the settings will be
6336	transferred except the VM name and the hardware UUID. You can set the
6337	VM name and the new hardware UUID when creating the target machine. The
6338	network MAC addresses are newly created for all newtwork adapters. You
6339	can change that behaviour with the options parameter. The operation is
6340	performed asynchronously, so the machine object will be not be usable
6341	until the @a progress object signals completion.
6342
6343	<result name="E_INVALIDARG">
6344	@a target is @c null.
6345	</result>
6346	</desc>
6347
6348	<param name="target" type="IMachine" dir="in">
6349	<desc>Target machine object.</desc>
6350	</param>
6351	<param name="mode" type="CloneMode" dir="in">
6352	<desc>Which states should be cloned.</desc>
6353	</param>
6354	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6355	<desc>Options for the cloning operation.</desc>
6356	</param>
6357	<param name="progress" type="IProgress" dir="return">
6358	<desc>Progress object to track the operation completion.</desc>
6359	</param>
6360	</method>
6361
6362	</interface>
6363
6364	<!--
6365	// IConsole
6366	/////////////////////////////////////////////////////////////////////////
6367	-->
6368
6369	<interface
6370	name="IVRDEServerInfo" extends="$unknown"
6371	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6372	wsmap="struct"
6373	>
6374	<desc>
6375	Contains information about the remote desktop (VRDE) server capabilities and status.
6376	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6377	</desc>
6378
6379	<attribute name="active" type="boolean" readonly="yes">
6380	<desc>
6381	Whether the remote desktop connection is active.
6382	</desc>
6383	</attribute>
6384
6385	<attribute name="port" type="long" readonly="yes">
6386	<desc>
6387	VRDE server port number. If this property is equal to <tt>0</tt>, then
6388	the VRDE server failed to start, usually because there are no free IP
6389	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6390	server has not yet been started.
6391	</desc>
6392	</attribute>
6393
6394	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6395	<desc>
6396	How many times a client connected.
6397	</desc>
6398	</attribute>
6399
6400	<attribute name="beginTime" type="long long" readonly="yes">
6401	<desc>
6402	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6403	</desc>
6404	</attribute>
6405
6406	<attribute name="endTime" type="long long" readonly="yes">
6407	<desc>
6408	When the last connection was terminated or the current time, if
6409	connection is still active, in milliseconds since 1970-01-01 UTC.
6410	</desc>
6411	</attribute>
6412
6413	<attribute name="bytesSent" type="long long" readonly="yes">
6414	<desc>
6415	How many bytes were sent in last or current, if still active, connection.
6416	</desc>
6417	</attribute>
6418
6419	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6420	<desc>
6421	How many bytes were sent in all connections.
6422	</desc>
6423	</attribute>
6424
6425	<attribute name="bytesReceived" type="long long" readonly="yes">
6426	<desc>
6427	How many bytes were received in last or current, if still active, connection.
6428	</desc>
6429	</attribute>
6430
6431	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6432	<desc>
6433	How many bytes were received in all connections.
6434	</desc>
6435	</attribute>
6436
6437	<attribute name="user" type="wstring" readonly="yes">
6438	<desc>
6439	Login user name supplied by the client.
6440	</desc>
6441	</attribute>
6442
6443	<attribute name="domain" type="wstring" readonly="yes">
6444	<desc>
6445	Login domain name supplied by the client.
6446	</desc>
6447	</attribute>
6448
6449	<attribute name="clientName" type="wstring" readonly="yes">
6450	<desc>
6451	The client name supplied by the client.
6452	</desc>
6453	</attribute>
6454
6455	<attribute name="clientIP" type="wstring" readonly="yes">
6456	<desc>
6457	The IP address of the client.
6458	</desc>
6459	</attribute>
6460
6461	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6462	<desc>
6463	The client software version number.
6464	</desc>
6465	</attribute>
6466
6467	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6468	<desc>
6469	Public key exchange method used when connection was established.
6470	Values: 0 - RDP4 public key exchange scheme.
6471	1 - X509 certificates were sent to client.
6472	</desc>
6473	</attribute>
6474
6475	</interface>
6476
6477	<interface
6478	name="IConsole" extends="$unknown"
6479	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6480	wsmap="managed"
6481	>
6482	<desc>
6483	The IConsole interface represents an interface to control virtual
6484	machine execution.
6485
6486	A console object gets created when a machine has been locked for a
6487	particular session (client process) using <link to="IMachine::lockMachine" />
6488	or <link to="IMachine::launchVMProcess"/>. The console object can
6489	then be found in the session's <link to="ISession::console" /> attribute.
6490
6491	Methods of the IConsole interface allow the caller to query the current
6492	virtual machine execution state, pause the machine or power it down, save
6493	the machine state or take a snapshot, attach and detach removable media
6494	and so on.
6495
6496	<see><link to="ISession"/></see>
6497	</desc>
6498
6499	<attribute name="machine" type="IMachine" readonly="yes">
6500	<desc>
6501	Machine object for this console session.
6502	<note>
6503	This is a convenience property, it has the same value as
6504	<link to="ISession::machine"/> of the corresponding session
6505	object.
6506	</note>
6507	</desc>
6508	</attribute>
6509
6510	<attribute name="state" type="MachineState" readonly="yes">
6511	<desc>
6512	Current execution state of the machine.
6513	<note>
6514	This property always returns the same value as the corresponding
6515	property of the IMachine object for this console session.
6516	For the process that owns (executes) the VM, this is the
6517	preferable way of querying the VM state, because no IPC
6518	calls are made.
6519	</note>
6520	</desc>
6521	</attribute>
6522
6523	<attribute name="guest" type="IGuest" readonly="yes">
6524	<desc>Guest object.</desc>
6525	</attribute>
6526
6527	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6528	<desc>
6529	Virtual keyboard object.
6530	<note>
6531	If the machine is not running, any attempt to use
6532	the returned object will result in an error.
6533	</note>
6534	</desc>
6535	</attribute>
6536
6537	<attribute name="mouse" type="IMouse" readonly="yes">
6538	<desc>
6539	Virtual mouse object.
6540	<note>
6541	If the machine is not running, any attempt to use
6542	the returned object will result in an error.
6543	</note>
6544	</desc>
6545	</attribute>
6546
6547	<attribute name="display" type="IDisplay" readonly="yes">
6548	<desc>Virtual display object.
6549	<note>
6550	If the machine is not running, any attempt to use
6551	the returned object will result in an error.
6552	</note>
6553	</desc>
6554	</attribute>
6555
6556	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6557	<desc>Debugging interface.</desc>
6558	</attribute>
6559
6560	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6561	<desc>
6562	Collection of USB devices currently attached to the virtual
6563	USB controller.
6564	<note>
6565	The collection is empty if the machine is not running.
6566	</note>
6567	</desc>
6568	</attribute>
6569
6570	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6571	<desc>
6572	List of USB devices currently attached to the remote VRDE client.
6573	Once a new device is physically attached to the remote host computer,
6574	it appears in this list and remains there until detached.
6575	</desc>
6576	</attribute>
6577
6578	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6579	<desc>
6580	Collection of shared folders for the current session. These folders
6581	are called transient shared folders because they are available to the
6582	guest OS running inside the associated virtual machine only for the
6583	duration of the session (as opposed to
6584	<link to="IMachine::sharedFolders"/> which represent permanent shared
6585	folders). When the session is closed (e.g. the machine is powered down),
6586	these folders are automatically discarded.
6587
6588	New shared folders are added to the collection using
6589	<link to="#createSharedFolder"/>. Existing shared folders can be
6590	removed using <link to="#removeSharedFolder"/>.
6591	</desc>
6592	</attribute>
6593
6594	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6595	<desc>
6596	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6597	</desc>
6598	</attribute>
6599
6600	<attribute name="eventSource" type="IEventSource" readonly="yes">
6601	<desc>
6602	Event source for console events.
6603	</desc>
6604	</attribute>
6605
6606	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6607	<desc>Array of PCI devices attached to this machine.</desc>
6608	</attribute>
6609
6610	<attribute name="useHostClipboard" type="boolean">
6611	<desc>
6612	Whether the guest clipboard should be connected to the host one or
6613	whether it should only be allowed access to the VRDE clipboard. This
6614	setting may not affect existing guest clipboard connections which
6615	are already connected to the host clipboard.
6616	</desc>
6617	</attribute>
6618
6619	<method name="powerUp">
6620	<desc>
6621	Starts the virtual machine execution using the current machine
6622	state (that is, its current execution state, current settings and
6623	current storage devices).
6624
6625	<note>
6626	This method is only useful for front-ends that want to actually
6627	execute virtual machines in their own process (like the VirtualBox
6628	or VBoxSDL front-ends). Unless you are intending to write such a
6629	front-end, do not call this method. If you simply want to
6630	start virtual machine execution using one of the existing front-ends
6631	(for example the VirtualBox GUI or headless server), use
6632	<link to="IMachine::launchVMProcess"/> instead; these
6633	front-ends will power up the machine automatically for you.
6634	</note>
6635
6636	If the machine is powered off or aborted, the execution will
6637	start from the beginning (as if the real hardware were just
6638	powered on).
6639
6640	If the machine is in the <link to="MachineState_Saved"/> state,
6641	it will continue its execution the point where the state has
6642	been saved.
6643
6644	If the machine <link to="IMachine::teleporterEnabled"/> property is
6645	enabled on the machine being powered up, the machine will wait for an
6646	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6647	state. The returned progress object will have at least three
6648	operations where the last three are defined as: (1) powering up and
6649	starting TCP server, (2) waiting for incoming teleportations, and
6650	(3) perform teleportation. These operations will be reflected as the
6651	last three operations of the progress objected returned by
6652	<link to="IMachine::launchVMProcess"/> as well.
6653
6654	<see><link to="#saveState"/></see>
6655
6656	<result name="VBOX_E_INVALID_VM_STATE">
6657	Virtual machine already running.
6658	</result>
6659	<result name="VBOX_E_HOST_ERROR">
6660	Host interface does not exist or name not set.
6661	</result>
6662	<result name="VBOX_E_FILE_ERROR">
6663	Invalid saved state file.
6664	</result>
6665	</desc>
6666	<param name="progress" type="IProgress" dir="return">
6667	<desc>Progress object to track the operation completion.</desc>
6668	</param>
6669	</method>
6670
6671	<method name="powerUpPaused">
6672	<desc>
6673	Identical to powerUp except that the VM will enter the
6674	<link to="MachineState_Paused"/> state, instead of
6675	<link to="MachineState_Running"/>.
6676
6677	<see><link to="#powerUp"/></see>
6678	<result name="VBOX_E_INVALID_VM_STATE">
6679	Virtual machine already running.
6680	</result>
6681	<result name="VBOX_E_HOST_ERROR">
6682	Host interface does not exist or name not set.
6683	</result>
6684	<result name="VBOX_E_FILE_ERROR">
6685	Invalid saved state file.
6686	</result>
6687	</desc>
6688	<param name="progress" type="IProgress" dir="return">
6689	<desc>Progress object to track the operation completion.</desc>
6690	</param>
6691	</method>
6692
6693	<method name="powerDown">
6694	<desc>
6695	Initiates the power down procedure to stop the virtual machine
6696	execution.
6697
6698	The completion of the power down procedure is tracked using the returned
6699	IProgress object. After the operation is complete, the machine will go
6700	to the PoweredOff state.
6701	<result name="VBOX_E_INVALID_VM_STATE">
6702	Virtual machine must be Running, Paused or Stuck to be powered down.
6703	</result>
6704	</desc>
6705	<param name="progress" type="IProgress" dir="return">
6706	<desc>Progress object to track the operation completion.</desc>
6707	</param>
6708	</method>
6709
6710	<method name="reset">
6711	<desc>Resets the virtual machine.
6712	<result name="VBOX_E_INVALID_VM_STATE">
6713	Virtual machine not in Running state.
6714	</result>
6715	<result name="VBOX_E_VM_ERROR">
6716	Virtual machine error in reset operation.
6717	</result>
6718	</desc>
6719	</method>
6720
6721	<method name="pause">
6722	<desc>Pauses the virtual machine execution.
6723	<result name="VBOX_E_INVALID_VM_STATE">
6724	Virtual machine not in Running state.
6725	</result>
6726	<result name="VBOX_E_VM_ERROR">
6727	Virtual machine error in suspend operation.
6728	</result>
6729	</desc>
6730	</method>
6731
6732	<method name="resume">
6733	<desc>Resumes the virtual machine execution.
6734	<result name="VBOX_E_INVALID_VM_STATE">
6735	Virtual machine not in Paused state.
6736	</result>
6737	<result name="VBOX_E_VM_ERROR">
6738	Virtual machine error in resume operation.
6739	</result>
6740	</desc>
6741	</method>
6742
6743	<method name="powerButton">
6744	<desc>Sends the ACPI power button event to the guest.
6745	<result name="VBOX_E_INVALID_VM_STATE">
6746	Virtual machine not in Running state.
6747	</result>
6748	<result name="VBOX_E_PDM_ERROR">
6749	Controlled power off failed.
6750	</result>
6751	</desc>
6752	</method>
6753
6754	<method name="sleepButton">
6755	<desc>Sends the ACPI sleep button event to the guest.
6756	<result name="VBOX_E_INVALID_VM_STATE">
6757	Virtual machine not in Running state.
6758	</result>
6759	<result name="VBOX_E_PDM_ERROR">
6760	Sending sleep button event failed.
6761	</result>
6762	</desc>
6763	</method>
6764
6765	<method name="getPowerButtonHandled">
6766	<desc>Checks if the last power button event was handled by guest.
6767	<result name="VBOX_E_PDM_ERROR">
6768	Checking if the event was handled by the guest OS failed.
6769	</result>
6770	</desc>
6771	<param name="handled" type="boolean" dir="return"/>
6772	</method>
6773
6774	<method name="getGuestEnteredACPIMode">
6775	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6776	G1 (sleeping). If this method returns @c false, the guest will
6777	most likely not respond to external ACPI events.
6778	<result name="VBOX_E_INVALID_VM_STATE">
6779	Virtual machine not in Running state.
6780	</result>
6781	</desc>
6782	<param name="entered" type="boolean" dir="return"/>
6783	</method>
6784
6785	<method name="saveState">
6786	<desc>
6787	Saves the current execution state of a running virtual machine
6788	and stops its execution.
6789
6790	After this operation completes, the machine will go to the
6791	Saved state. Next time it is powered up, this state will
6792	be restored and the machine will continue its execution from
6793	the place where it was saved.
6794
6795	This operation differs from taking a snapshot to the effect
6796	that it doesn't create new differencing media. Also, once
6797	the machine is powered up from the state saved using this method,
6798	the saved state is deleted, so it will be impossible to return
6799	to this state later.
6800
6801	<note>
6802	On success, this method implicitly calls
6803	<link to="IMachine::saveSettings"/> to save all current machine
6804	settings (including runtime changes to the DVD medium, etc.).
6805	Together with the impossibility to change any VM settings when it is
6806	in the Saved state, this guarantees adequate hardware
6807	configuration of the machine when it is restored from the saved
6808	state file.
6809	</note>
6810
6811	<note>
6812	The machine must be in the Running or Paused state, otherwise
6813	the operation will fail.
6814	</note>
6815	<result name="VBOX_E_INVALID_VM_STATE">
6816	Virtual machine state neither Running nor Paused.
6817	</result>
6818	<result name="VBOX_E_FILE_ERROR">
6819	Failed to create directory for saved state file.
6820	</result>
6821
6822	<see><link to="#takeSnapshot"/></see>
6823	</desc>
6824	<param name="progress" type="IProgress" dir="return">
6825	<desc>Progress object to track the operation completion.</desc>
6826	</param>
6827	</method>
6828
6829	<method name="adoptSavedState">
6830	<desc>
6831	Associates the given saved state file to the virtual machine.
6832
6833	On success, the machine will go to the Saved state. Next time it is
6834	powered up, it will be restored from the adopted saved state and
6835	continue execution from the place where the saved state file was
6836	created.
6837
6838	The specified saved state file path may be absolute or relative to the
6839	folder the VM normally saves the state to (usually,
6840	<link to="IMachine::snapshotFolder"/>).
6841
6842	<note>
6843	It's a caller's responsibility to make sure the given saved state
6844	file is compatible with the settings of this virtual machine that
6845	represent its virtual hardware (memory size, storage disk configuration
6846	etc.). If there is a mismatch, the behavior of the virtual machine
6847	is undefined.
6848	</note>
6849	<result name="VBOX_E_INVALID_VM_STATE">
6850	Virtual machine state neither PoweredOff nor Aborted.
6851	</result>
6852	</desc>
6853	<param name="savedStateFile" type="wstring" dir="in">
6854	<desc>Path to the saved state file to adopt.</desc>
6855	</param>
6856	</method>
6857
6858	<method name="discardSavedState">
6859	<desc>
6860	Forcibly resets the machine to "Powered Off" state if it is
6861	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6862	Next time the machine is powered up, a clean boot will occur.
6863	<note>
6864	This operation is equivalent to resetting or powering off
6865	the machine without doing a proper shutdown of the guest
6866	operating system; as with resetting a running phyiscal
6867	computer, it can can lead to data loss.
6868	</note>
6869	If @a fRemoveFile is @c true, the file in the machine directory
6870	into which the machine state was saved is also deleted. If
6871	this is @c false, then the state can be recovered and later
6872	re-inserted into a machine using <link to="#adoptSavedState" />.
6873	The location of the file can be found in the
6874	<link to="IMachine::stateFilePath" /> attribute.
6875	<result name="VBOX_E_INVALID_VM_STATE">
6876	Virtual machine not in state Saved.
6877	</result>
6878	</desc>
6879	<param name="fRemoveFile" type="boolean" dir="in" >
6880	<desc>Whether to also remove the saved state file.</desc>
6881	</param>
6882	</method>
6883
6884	<method name="getDeviceActivity">
6885	<desc>
6886	Gets the current activity type of a given device or device group.
6887	<result name="E_INVALIDARG">
6888	Invalid device type.
6889	</result>
6890	</desc>
6891	<param name="type" type="DeviceType" dir="in"/>
6892	<param name="activity" type="DeviceActivity" dir="return"/>
6893	</method>
6894
6895	<method name="attachUSBDevice">
6896	<desc>
6897	Attaches a host USB device with the given UUID to the
6898	USB controller of the virtual machine.
6899
6900	The device needs to be in one of the following states:
6901	<link to="USBDeviceState_Busy"/>,
6902	<link to="USBDeviceState_Available"/> or
6903	<link to="USBDeviceState_Held"/>,
6904	otherwise an error is immediately returned.
6905
6906	When the device state is
6907	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6908	be returned if the host computer refuses to release it for some reason.
6909
6910	<see><link to="IUSBController::deviceFilters"/>,
6911	<link to="USBDeviceState"/></see>
6912	<result name="VBOX_E_INVALID_VM_STATE">
6913	Virtual machine state neither Running nor Paused.
6914	</result>
6915	<result name="VBOX_E_PDM_ERROR">
6916	Virtual machine does not have a USB controller.
6917	</result>
6918	</desc>
6919	<param name="id" type="uuid" mod="string" dir="in">
6920	<desc>UUID of the host USB device to attach.</desc>
6921	</param>
6922	</method>
6923
6924	<method name="detachUSBDevice">
6925	<desc>
6926	Detaches an USB device with the given UUID from the USB controller
6927	of the virtual machine.
6928
6929	After this method succeeds, the VirtualBox server re-initiates
6930	all USB filters as if the device were just physically attached
6931	to the host, but filters of this machine are ignored to avoid
6932	a possible automatic re-attachment.
6933
6934	<see><link to="IUSBController::deviceFilters"/>,
6935	<link to="USBDeviceState"/></see>
6936
6937	<result name="VBOX_E_PDM_ERROR">
6938	Virtual machine does not have a USB controller.
6939	</result>
6940	<result name="E_INVALIDARG">
6941	USB device not attached to this virtual machine.
6942	</result>
6943	</desc>
6944	<param name="id" type="uuid" mod="string" dir="in">
6945	<desc>UUID of the USB device to detach.</desc>
6946	</param>
6947	<param name="device" type="IUSBDevice" dir="return">
6948	<desc>Detached USB device.</desc>
6949	</param>
6950	</method>
6951
6952	<method name="findUSBDeviceByAddress">
6953	<desc>
6954	Searches for a USB device with the given host address.
6955
6956	<result name="VBOX_E_OBJECT_NOT_FOUND">
6957	Given @c name does not correspond to any USB device.
6958	</result>
6959
6960	<see><link to="IUSBDevice::address"/></see>
6961	</desc>
6962	<param name="name" type="wstring" dir="in">
6963	<desc>
6964	Address of the USB device (as assigned by the host) to
6965	search for.
6966	</desc>
6967	</param>
6968	<param name="device" type="IUSBDevice" dir="return">
6969	<desc>Found USB device object.</desc>
6970	</param>
6971	</method>
6972
6973	<method name="findUSBDeviceById">
6974	<desc>
6975	Searches for a USB device with the given UUID.
6976
6977	<result name="VBOX_E_OBJECT_NOT_FOUND">
6978	Given @c id does not correspond to any USB device.
6979	</result>
6980
6981	<see><link to="IUSBDevice::id"/></see>
6982	</desc>
6983	<param name="id" type="uuid" mod="string" dir="in">
6984	<desc>UUID of the USB device to search for.</desc>
6985	</param>
6986	<param name="device" type="IUSBDevice" dir="return">
6987	<desc>Found USB device object.</desc>
6988	</param>
6989	</method>
6990
6991	<method name="createSharedFolder">
6992	<desc>
6993	Creates a transient new shared folder by associating the given logical
6994	name with the given host path, adds it to the collection of shared
6995	folders and starts sharing it. Refer to the description of
6996	<link to="ISharedFolder"/> to read more about logical names.
6997
6998	<result name="VBOX_E_INVALID_VM_STATE">
6999	Virtual machine in Saved state or currently changing state.
7000	</result>
7001	<result name="VBOX_E_FILE_ERROR">
7002	Shared folder already exists or not accessible.
7003	</result>
7004	</desc>
7005	<param name="name" type="wstring" dir="in">
7006	<desc>Unique logical name of the shared folder.</desc>
7007	</param>
7008	<param name="hostPath" type="wstring" dir="in">
7009	<desc>Full path to the shared folder in the host file system.</desc>
7010	</param>
7011	<param name="writable" type="boolean" dir="in">
7012	<desc>Whether the share is writable or readonly</desc>
7013	</param>
7014	<param name="automount" type="boolean" dir="in">
7015	<desc>Whether the share gets automatically mounted by the guest
7016	or not.</desc>
7017	</param>
7018	</method>
7019
7020	<method name="removeSharedFolder">
7021	<desc>
7022	Removes a transient shared folder with the given name previously
7023	created by <link to="#createSharedFolder"/> from the collection of
7024	shared folders and stops sharing it.
7025	<result name="VBOX_E_INVALID_VM_STATE">
7026	Virtual machine in Saved state or currently changing state.
7027	</result>
7028	<result name="VBOX_E_FILE_ERROR">
7029	Shared folder does not exists.
7030	</result>
7031	</desc>
7032	<param name="name" type="wstring" dir="in">
7033	<desc>Logical name of the shared folder to remove.</desc>
7034	</param>
7035	</method>
7036
7037	<method name="takeSnapshot">
7038	<desc>
7039	Saves the current execution state
7040	and all settings of the machine and creates differencing images
7041	for all normal (non-independent) media.
7042	See <link to="ISnapshot" /> for an introduction to snapshots.
7043
7044	This method can be called for a PoweredOff, Saved (see
7045	<link to="#saveState"/>), Running or
7046	Paused virtual machine. When the machine is PoweredOff, an
7047	offline snapshot is created. When the machine is Running a live
7048	snapshot is created, and an online snapshot is is created when Paused.
7049
7050	The taken snapshot is always based on the
7051	<link to="IMachine::currentSnapshot">current snapshot</link>
7052	of the associated virtual machine and becomes a new current snapshot.
7053
7054	<note>
7055	This method implicitly calls <link to="IMachine::saveSettings"/> to
7056	save all current machine settings before taking an offline snapshot.
7057	</note>
7058
7059	<result name="VBOX_E_INVALID_VM_STATE">
7060	Virtual machine currently changing state.
7061	</result>
7062	</desc>
7063	<param name="name" type="wstring" dir="in">
7064	<desc>Short name for the snapshot.</desc>
7065	</param>
7066	<param name="description" type="wstring" dir="in">
7067	<desc>Optional description of the snapshot.</desc>
7068	</param>
7069	<param name="progress" type="IProgress" dir="return">
7070	<desc>Progress object to track the operation completion.</desc>
7071	</param>
7072	</method>
7073
7074	<method name="deleteSnapshot">
7075	<desc>
7076	Starts deleting the specified snapshot asynchronously.
7077	See <link to="ISnapshot" /> for an introduction to snapshots.
7078
7079	The execution state and settings of the associated machine stored in
7080	the snapshot will be deleted. The contents of all differencing media of
7081	this snapshot will be merged with the contents of their dependent child
7082	media to keep the medium chain valid (in other words, all changes
7083	represented by media being deleted will be propagated to their child
7084	medium). After that, this snapshot's differencing medium will be
7085	deleted. The parent of this snapshot will become a new parent for all
7086	its child snapshots.
7087
7088	If the deleted snapshot is the current one, its parent snapshot will
7089	become a new current snapshot. The current machine state is not directly
7090	affected in this case, except that currently attached differencing
7091	media based on media of the deleted snapshot will be also merged as
7092	described above.
7093
7094	If the deleted snapshot is the first or current snapshot, then the
7095	respective IMachine attributes will be adjusted. Deleting the current
7096	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7097	to make all current machine settings permanent.
7098
7099	Deleting a snapshot has the following preconditions:
7100
7101	<ul>
7102	<li>Child media of all normal media of the deleted snapshot
7103	must be accessible (see <link to="IMedium::state"/>) for this
7104	operation to succeed. If only one running VM refers to all images
7105	which participates in merging the operation can be performed while
7106	the VM is running. Otherwise all virtual machines whose media are
7107	directly or indirectly based on the media of deleted snapshot must
7108	be powered off. In any case, online snapshot deleting usually is
7109	slower than the same operation without any running VM.</li>
7110
7111	<li>You cannot delete the snapshot if a medium attached to it has
7112	more than one child medium (differencing images) because otherwise
7113	merging would be impossible. This might be the case if there is
7114	more than one child snapshot or differencing images were created
7115	for other reason (e.g. implicitly because of multiple machine
7116	attachments).</li>
7117	</ul>
7118
7119	The virtual machine's <link to="IMachine::state">state</link> is
7120	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7121	"DeletingSnapshotPaused" while this operation is in progress.
7122
7123	<note>
7124	Merging medium contents can be very time and disk space
7125	consuming, if these media are big in size and have many
7126	children. However, if the snapshot being deleted is the last
7127	(head) snapshot on the branch, the operation will be rather
7128	quick.
7129	</note>
7130	<result name="VBOX_E_INVALID_VM_STATE">
7131	The running virtual machine prevents deleting this snapshot. This
7132	happens only in very specific situations, usually snapshots can be
7133	deleted without trouble while a VM is running. The error message
7134	text explains the reason for the failure.
7135	</result>
7136	</desc>
7137	<param name="id" type="uuid" mod="string" dir="in">
7138	<desc>UUID of the snapshot to delete.</desc>
7139	</param>
7140	<param name="progress" type="IProgress" dir="return">
7141	<desc>Progress object to track the operation completion.</desc>
7142	</param>
7143	</method>
7144
7145	<method name="deleteSnapshotAndAllChildren">
7146	<desc>
7147	Starts deleting the specified snapshot and all its children
7148	asynchronously. See <link to="ISnapshot" /> for an introduction to
7149	snapshots. The conditions and many details are the same as with
7150	<link to="#deleteSnapshot"/>.
7151
7152	This operation is very fast if the snapshot subtree does not include
7153	the current state. It is still significantly faster than deleting the
7154	snapshots one by one if the current state is in the subtree and there
7155	are more than one snapshots from current state to the snapshot which
7156	marks the subtree, since it eliminates the incremental image merging.
7157
7158	<note>This API method is right now not implemented!</note>
7159
7160	<result name="VBOX_E_INVALID_VM_STATE">
7161	The running virtual machine prevents deleting this snapshot. This
7162	happens only in very specific situations, usually snapshots can be
7163	deleted without trouble while a VM is running. The error message
7164	text explains the reason for the failure.
7165	</result>
7166	<result name="E_NOTIMPL">
7167	The method is not implemented yet.
7168	</result>
7169	</desc>
7170	<param name="id" type="uuid" mod="string" dir="in">
7171	<desc>UUID of the snapshot to delete, including all its children.</desc>
7172	</param>
7173	<param name="progress" type="IProgress" dir="return">
7174	<desc>Progress object to track the operation completion.</desc>
7175	</param>
7176	</method>
7177
7178	<method name="deleteSnapshotRange">
7179	<desc>
7180	Starts deleting the specified snapshot range. This is limited to
7181	linear snapshot lists, which means there may not be any other child
7182	snapshots other than the direct sequence between the start and end
7183	snapshot. If the start and end snapshot point to the same snapshot this
7184	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7185	<link to="ISnapshot" /> for an introduction to snapshots. The
7186	conditions and many details are the same as with
7187	<link to="#deleteSnapshot"/>.
7188
7189	This operation is generally faster than deleting snapshots one by one
7190	and often also needs less extra disk space before freeing up disk space
7191	by deleting the removed disk images corresponding to the snapshot.
7192
7193	<note>This API method is right now not implemented!</note>
7194
7195	<result name="VBOX_E_INVALID_VM_STATE">
7196	The running virtual machine prevents deleting this snapshot. This
7197	happens only in very specific situations, usually snapshots can be
7198	deleted without trouble while a VM is running. The error message
7199	text explains the reason for the failure.
7200	</result>
7201	<result name="E_NOTIMPL">
7202	The method is not implemented yet.
7203	</result>
7204	</desc>
7205	<param name="startId" type="uuid" mod="string" dir="in">
7206	<desc>UUID of the first snapshot to delete.</desc>
7207	</param>
7208	<param name="endId" type="uuid" mod="string" dir="in">
7209	<desc>UUID of the last snapshot to delete.</desc>
7210	</param>
7211	<param name="progress" type="IProgress" dir="return">
7212	<desc>Progress object to track the operation completion.</desc>
7213	</param>
7214	</method>
7215
7216	<method name="restoreSnapshot">
7217	<desc>
7218	Starts resetting the machine's current state to the state contained
7219	in the given snapshot, asynchronously. All current settings of the
7220	machine will be reset and changes stored in differencing media
7221	will be lost.
7222	See <link to="ISnapshot" /> for an introduction to snapshots.
7223
7224	After this operation is successfully completed, new empty differencing
7225	media are created for all normal media of the machine.
7226
7227	If the given snapshot is an online snapshot, the machine will go to
7228	the <link to="MachineState_Saved"> saved state</link>, so that the
7229	next time it is powered on, the execution state will be restored
7230	from the state of the snapshot.
7231
7232	<note>
7233	The machine must not be running, otherwise the operation will fail.
7234	</note>
7235
7236	<note>
7237	If the machine state is <link to="MachineState_Saved">Saved</link>
7238	prior to this operation, the saved state file will be implicitly
7239	deleted (as if <link to="IConsole::discardSavedState"/> were
7240	called).
7241	</note>
7242
7243	<result name="VBOX_E_INVALID_VM_STATE">
7244	Virtual machine is running.
7245	</result>
7246	</desc>
7247	<param name="snapshot" type="ISnapshot" dir="in">
7248	<desc>The snapshot to restore the VM state from.</desc>
7249	</param>
7250	<param name="progress" type="IProgress" dir="return">
7251	<desc>Progress object to track the operation completion.</desc>
7252	</param>
7253	</method>
7254
7255	<method name="teleport">
7256	<desc>
7257	Teleport the VM to a different host machine or process.
7258
7259	TODO explain the details.
7260
7261	<result name="VBOX_E_INVALID_VM_STATE">
7262	Virtual machine not running or paused.
7263	</result>
7264	</desc>
7265	<param name="hostname" type="wstring" dir="in">
7266	<desc>The name or IP of the host to teleport to.</desc>
7267	</param>
7268	<param name="tcpport" type="unsigned long" dir="in">
7269	<desc>The TCP port to connect to (1..65535).</desc>
7270	</param>
7271	<param name="password" type="wstring" dir="in">
7272	<desc>The password.</desc>
7273	</param>
7274	<param name="maxDowntime" type="unsigned long" dir="in">
7275	<desc>
7276	The maximum allowed downtime given as milliseconds. 0 is not a valid
7277	value. Recommended value: 250 ms.
7278
7279	The higher the value is, the greater the chance for a successful
7280	teleportation. A small value may easily result in the teleportation
7281	process taking hours and eventually fail.
7282
7283	<note>
7284	The current implementation treats this a guideline, not as an
7285	absolute rule.
7286	</note>
7287	</desc>
7288	</param>
7289	<param name="progress" type="IProgress" dir="return">
7290	<desc>Progress object to track the operation completion.</desc>
7291	</param>
7292	</method>
7293
7294	</interface>
7295
7296	<!--
7297	// IHost
7298	/////////////////////////////////////////////////////////////////////////
7299	-->
7300
7301	<enum
7302	name="HostNetworkInterfaceMediumType"
7303	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7304	>
7305	<desc>
7306	Type of encapsulation. Ethernet encapsulation includes both wired and
7307	wireless Ethernet connections.
7308	<see><link to="IHostNetworkInterface"/></see>
7309	</desc>
7310
7311	<const name="Unknown" value="0">
7312	<desc>
7313	The type of interface cannot be determined.
7314	</desc>
7315	</const>
7316	<const name="Ethernet" value="1">
7317	<desc>
7318	Ethernet frame encapsulation.
7319	</desc>
7320	</const>
7321	<const name="PPP" value="2">
7322	<desc>
7323	Point-to-point protocol encapsulation.
7324	</desc>
7325	</const>
7326	<const name="SLIP" value="3">
7327	<desc>
7328	Serial line IP encapsulation.
7329	</desc>
7330	</const>
7331	</enum>
7332
7333	<enum
7334	name="HostNetworkInterfaceStatus"
7335	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7336	>
7337	<desc>
7338	Current status of the interface.
7339	<see><link to="IHostNetworkInterface"/></see>
7340	</desc>
7341
7342	<const name="Unknown" value="0">
7343	<desc>
7344	The state of interface cannot be determined.
7345	</desc>
7346	</const>
7347	<const name="Up" value="1">
7348	<desc>
7349	The interface is fully operational.
7350	</desc>
7351	</const>
7352	<const name="Down" value="2">
7353	<desc>
7354	The interface is not functioning.
7355	</desc>
7356	</const>
7357	</enum>
7358
7359	<enum
7360	name="HostNetworkInterfaceType"
7361	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7362	>
7363	<desc>
7364	Network interface type.
7365	</desc>
7366	<const name="Bridged" value="1"/>
7367	<const name="HostOnly" value="2"/>
7368	</enum>
7369
7370	<interface
7371	name="IHostNetworkInterface" extends="$unknown"
7372	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7373	wsmap="managed"
7374	>
7375	<desc>
7376	Represents one of host's network interfaces. IP V6 address and network
7377	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7378	separated by colons.
7379	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7380	</desc>
7381	<attribute name="name" type="wstring" readonly="yes">
7382	<desc>Returns the host network interface name.</desc>
7383	</attribute>
7384
7385	<attribute name="id" type="uuid" mod="string" readonly="yes">
7386	<desc>Returns the interface UUID.</desc>
7387	</attribute>
7388
7389	<attribute name="networkName" type="wstring" readonly="yes">
7390	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7391	</attribute>
7392
7393	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7394	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7395	</attribute>
7396
7397	<attribute name="IPAddress" type="wstring" readonly="yes">
7398	<desc>Returns the IP V4 address of the interface.</desc>
7399	</attribute>
7400
7401	<attribute name="networkMask" type="wstring" readonly="yes">
7402	<desc>Returns the network mask of the interface.</desc>
7403	</attribute>
7404
7405	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7406	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7407	</attribute>
7408
7409	<attribute name="IPV6Address" type="wstring" readonly="yes">
7410	<desc>Returns the IP V6 address of the interface.</desc>
7411	</attribute>
7412
7413	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7414	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7415	</attribute>
7416
7417	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7418	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7419	</attribute>
7420
7421	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7422	<desc>Type of protocol encapsulation used.</desc>
7423	</attribute>
7424
7425	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7426	<desc>Status of the interface.</desc>
7427	</attribute>
7428
7429	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7430	<desc>specifies the host interface type.</desc>
7431	</attribute>
7432
7433	<method name="enableStaticIpConfig">
7434	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7435	<param name="IPAddress" type="wstring" dir="in">
7436	<desc>
7437	IP address.
7438	</desc>
7439	</param>
7440	<param name="networkMask" type="wstring" dir="in">
7441	<desc>
7442	network mask.
7443	</desc>
7444	</param>
7445	</method>
7446
7447	<method name="enableStaticIpConfigV6">
7448	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7449	<param name="IPV6Address" type="wstring" dir="in">
7450	<desc>
7451	IP address.
7452	</desc>
7453	</param>
7454	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7455	<desc>
7456	network mask.
7457	</desc>
7458	</param>
7459	</method>
7460
7461	<method name="enableDynamicIpConfig">
7462	<desc>enables the dynamic IP configuration.</desc>
7463	</method>
7464
7465	<method name="dhcpRediscover">
7466	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7467	</method>
7468
7469	</interface>
7470
7471	<interface
7472	name="IHost" extends="$unknown"
7473	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7474	wsmap="managed"
7475	>
7476	<desc>
7477	The IHost interface represents the physical machine that this VirtualBox
7478	installation runs on.
7479
7480	An object implementing this interface is returned by the
7481	<link to="IVirtualBox::host" /> attribute. This interface contains
7482	read-only information about the host's physical hardware (such as what
7483	processors and disks are available, what the host operating system is,
7484	and so on) and also allows for manipulating some of the host's hardware,
7485	such as global USB device filters and host interface networking.
7486
7487	</desc>
7488	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7489	<desc>List of DVD drives available on the host.</desc>
7490	</attribute>
7491
7492	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7493	<desc>List of floppy drives available on the host.</desc>
7494	</attribute>
7495
7496	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7497	<desc>
7498	List of USB devices currently attached to the host.
7499	Once a new device is physically attached to the host computer,
7500	it appears in this list and remains there until detached.
7501
7502	<note>
7503	If USB functionality is not available in the given edition of
7504	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7505	</note>
7506	</desc>
7507	</attribute>
7508
7509	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7510	<desc>
7511	List of USB device filters in action.
7512	When a new device is physically attached to the host computer,
7513	filters from this list are applied to it (in order they are stored
7514	in the list). The first matched filter will determine the
7515	<link to="IHostUSBDeviceFilter::action">action</link>
7516	performed on the device.
7517
7518	Unless the device is ignored by these filters, filters of all
7519	currently running virtual machines
7520	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7521
7522	<note>
7523	If USB functionality is not available in the given edition of
7524	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7525	</note>
7526
7527	<see><link to="IHostUSBDeviceFilter"/>,
7528	<link to="USBDeviceState"/></see>
7529	</desc>
7530	</attribute>
7531
7532	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7533	<desc>List of host network interfaces currently defined on the host.</desc>
7534	</attribute>
7535
7536	<attribute name="processorCount" type="unsigned long" readonly="yes">
7537	<desc>Number of (logical) CPUs installed in the host system.</desc>
7538	</attribute>
7539
7540	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7541	<desc>Number of (logical) CPUs online in the host system.</desc>
7542	</attribute>
7543
7544	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7545	<desc>Number of physical processor cores installed in the host system.</desc>
7546	</attribute>
7547
7548	<method name="getProcessorSpeed">
7549	<desc>Query the (approximate) maximum speed of a specified host CPU in
7550	Megahertz.
7551	</desc>
7552	<param name="cpuId" type="unsigned long" dir="in">
7553	<desc>
7554	Identifier of the CPU.
7555	</desc>
7556	</param>
7557	<param name="speed" type="unsigned long" dir="return">
7558	<desc>
7559	Speed value. 0 is returned if value is not known or @a cpuId is
7560	invalid.
7561	</desc>
7562	</param>
7563	</method>
7564
7565	<method name="getProcessorFeature">
7566	<desc>Query whether a CPU feature is supported or not.</desc>
7567	<param name="feature" type="ProcessorFeature" dir="in">
7568	<desc>
7569	CPU Feature identifier.
7570	</desc>
7571	</param>
7572	<param name="supported" type="boolean" dir="return">
7573	<desc>
7574	Feature is supported or not.
7575	</desc>
7576	</param>
7577	</method>
7578
7579	<method name="getProcessorDescription">
7580	<desc>Query the model string of a specified host CPU.
7581	</desc>
7582	<param name="cpuId" type="unsigned long" dir="in">
7583	<desc>
7584	Identifier of the CPU.
7585	<note>
7586	The current implementation might not necessarily return the
7587	description for this exact CPU.
7588	</note>
7589	</desc>
7590	</param>
7591	<param name="description" type="wstring" dir="return">
7592	<desc>
7593	Model string. An empty string is returned if value is not known or
7594	@a cpuId is invalid.
7595	</desc>
7596	</param>
7597	</method>
7598
7599	<method name="getProcessorCPUIDLeaf">
7600	<desc>
7601	Returns the CPU cpuid information for the specified leaf.
7602	</desc>
7603	<param name="cpuId" type="unsigned long" dir="in">
7604	<desc>
7605	Identifier of the CPU. The CPU most be online.
7606	<note>
7607	The current implementation might not necessarily return the
7608	description for this exact CPU.
7609	</note>
7610	</desc>
7611	</param>
7612	<param name="leaf" type="unsigned long" dir="in">
7613	<desc>
7614	CPUID leaf index (eax).
7615	</desc>
7616	</param>
7617	<param name="subLeaf" type="unsigned long" dir="in">
7618	<desc>
7619	CPUID leaf sub index (ecx). This currently only applies to cache
7620	information on Intel CPUs. Use 0 if retrieving values for
7621	<link to="IMachine::setCPUIDLeaf"/>.
7622	</desc>
7623	</param>
7624	<param name="valEax" type="unsigned long" dir="out">
7625	<desc>
7626	CPUID leaf value for register eax.
7627	</desc>
7628	</param>
7629	<param name="valEbx" type="unsigned long" dir="out">
7630	<desc>
7631	CPUID leaf value for register ebx.
7632	</desc>
7633	</param>
7634	<param name="valEcx" type="unsigned long" dir="out">
7635	<desc>
7636	CPUID leaf value for register ecx.
7637	</desc>
7638	</param>
7639	<param name="valEdx" type="unsigned long" dir="out">
7640	<desc>
7641	CPUID leaf value for register edx.
7642	</desc>
7643	</param>
7644	</method>
7645
7646	<attribute name="memorySize" type="unsigned long" readonly="yes">
7647	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7648	</attribute>
7649
7650	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7651	<desc>Available system memory in the host system.</desc>
7652	</attribute>
7653
7654	<attribute name="operatingSystem" type="wstring" readonly="yes">
7655	<desc>Name of the host system's operating system.</desc>
7656	</attribute>
7657
7658	<attribute name="OSVersion" type="wstring" readonly="yes">
7659	<desc>Host operating system's version string.</desc>
7660	</attribute>
7661
7662	<attribute name="UTCTime" type="long long" readonly="yes">
7663	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7664	</attribute>
7665
7666	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7667	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7668	</attribute>
7669
7670	<method name="createHostOnlyNetworkInterface">
7671	<desc>
7672	Creates a new adapter for Host Only Networking.
7673	<result name="E_INVALIDARG">
7674	Host network interface @a name already exists.
7675	</result>
7676	</desc>
7677	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7678	<desc>
7679	Created host interface object.
7680	</desc>
7681	</param>
7682	<param name="progress" type="IProgress" dir="return">
7683	<desc>
7684	Progress object to track the operation completion.
7685	</desc>
7686	</param>
7687	</method>
7688
7689	<method name="removeHostOnlyNetworkInterface">
7690	<desc>
7691	Removes the given Host Only Networking interface.
7692	<result name="VBOX_E_OBJECT_NOT_FOUND">
7693	No host network interface matching @a id found.
7694	</result>
7695	</desc>
7696	<param name="id" type="uuid" mod="string" dir="in">
7697	<desc>
7698	Adapter GUID.
7699	</desc>
7700	</param>
7701	<param name="progress" type="IProgress" dir="return">
7702	<desc>
7703	Progress object to track the operation completion.
7704	</desc>
7705	</param>
7706	</method>
7707
7708	<method name="createUSBDeviceFilter">
7709	<desc>
7710	Creates a new USB device filter. All attributes except
7711	the filter name are set to empty (any match),
7712	<i>active</i> is @c false (the filter is not active).
7713
7714	The created filter can be added to the list of filters using
7715	<link to="#insertUSBDeviceFilter"/>.
7716
7717	<see><link to="#USBDeviceFilters"/></see>
7718	</desc>
7719	<param name="name" type="wstring" dir="in">
7720	<desc>
7721	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7722	</desc>
7723	</param>
7724	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7725	<desc>Created filter object.</desc>
7726	</param>
7727	</method>
7728
7729	<method name="insertUSBDeviceFilter">
7730	<desc>
7731	Inserts the given USB device to the specified position
7732	in the list of filters.
7733
7734	Positions are numbered starting from @c 0. If the specified
7735	position is equal to or greater than the number of elements in
7736	the list, the filter is added at the end of the collection.
7737
7738	<note>
7739	Duplicates are not allowed, so an attempt to insert a
7740	filter already in the list is an error.
7741	</note>
7742	<note>
7743	If USB functionality is not available in the given edition of
7744	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7745	</note>
7746
7747	<see><link to="#USBDeviceFilters"/></see>
7748
7749	<result name="VBOX_E_INVALID_OBJECT_STATE">
7750	USB device filter is not created within this VirtualBox instance.
7751	</result>
7752	<result name="E_INVALIDARG">
7753	USB device filter already in list.
7754	</result>
7755
7756	</desc>
7757	<param name="position" type="unsigned long" dir="in">
7758	<desc>Position to insert the filter to.</desc>
7759	</param>
7760	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7761	<desc>USB device filter to insert.</desc>
7762	</param>
7763	</method>
7764
7765	<method name="removeUSBDeviceFilter">
7766	<desc>
7767	Removes a USB device filter from the specified position in the
7768	list of filters.
7769
7770	Positions are numbered starting from @c 0. Specifying a
7771	position equal to or greater than the number of elements in
7772	the list will produce an error.
7773
7774	<note>
7775	If USB functionality is not available in the given edition of
7776	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7777	</note>
7778
7779	<see><link to="#USBDeviceFilters"/></see>
7780
7781	<result name="E_INVALIDARG">
7782	USB device filter list empty or invalid @a position.
7783	</result>
7784
7785	</desc>
7786	<param name="position" type="unsigned long" dir="in">
7787	<desc>Position to remove the filter from.</desc>
7788	</param>
7789	</method>
7790
7791	<method name="findHostDVDDrive">
7792	<desc>
7793	Searches for a host DVD drive with the given @c name.
7794
7795	<result name="VBOX_E_OBJECT_NOT_FOUND">
7796	Given @c name does not correspond to any host drive.
7797	</result>
7798
7799	</desc>
7800	<param name="name" type="wstring" dir="in">
7801	<desc>Name of the host drive to search for</desc>
7802	</param>
7803	<param name="drive" type="IMedium" dir="return">
7804	<desc>Found host drive object</desc>
7805	</param>
7806	</method>
7807
7808	<method name="findHostFloppyDrive">
7809	<desc>
7810	Searches for a host floppy drive with the given @c name.
7811
7812	<result name="VBOX_E_OBJECT_NOT_FOUND">
7813	Given @c name does not correspond to any host floppy drive.
7814	</result>
7815
7816	</desc>
7817	<param name="name" type="wstring" dir="in">
7818	<desc>Name of the host floppy drive to search for</desc>
7819	</param>
7820	<param name="drive" type="IMedium" dir="return">
7821	<desc>Found host floppy drive object</desc>
7822	</param>
7823	</method>
7824
7825	<method name="findHostNetworkInterfaceByName">
7826	<desc>
7827	Searches through all host network interfaces for an interface with
7828	the given @c name.
7829	<note>
7830	The method returns an error if the given @c name does not
7831	correspond to any host network interface.
7832	</note>
7833	</desc>
7834	<param name="name" type="wstring" dir="in">
7835	<desc>Name of the host network interface to search for.</desc>
7836	</param>
7837	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7838	<desc>Found host network interface object.</desc>
7839	</param>
7840	</method>
7841	<method name="findHostNetworkInterfaceById">
7842	<desc>
7843	Searches through all host network interfaces for an interface with
7844	the given GUID.
7845	<note>
7846	The method returns an error if the given GUID does not
7847	correspond to any host network interface.
7848	</note>
7849	</desc>
7850	<param name="id" type="uuid" mod="string" dir="in">
7851	<desc>GUID of the host network interface to search for.</desc>
7852	</param>
7853	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7854	<desc>Found host network interface object.</desc>
7855	</param>
7856	</method>
7857	<method name="findHostNetworkInterfacesOfType">
7858	<desc>
7859	Searches through all host network interfaces and returns a list of interfaces of the specified type
7860	</desc>
7861	<param name="type" type="HostNetworkInterfaceType" dir="in">
7862	<desc>type of the host network interfaces to search for.</desc>
7863	</param>
7864	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7865	<desc>Found host network interface objects.</desc>
7866	</param>
7867	</method>
7868
7869	<method name="findUSBDeviceById">
7870	<desc>
7871	Searches for a USB device with the given UUID.
7872
7873	<result name="VBOX_E_OBJECT_NOT_FOUND">
7874	Given @c id does not correspond to any USB device.
7875	</result>
7876
7877	<see><link to="IUSBDevice::id"/></see>
7878	</desc>
7879	<param name="id" type="uuid" mod="string" dir="in">
7880	<desc>UUID of the USB device to search for.</desc>
7881	</param>
7882	<param name="device" type="IHostUSBDevice" dir="return">
7883	<desc>Found USB device object.</desc>
7884	</param>
7885	</method>
7886
7887	<method name="findUSBDeviceByAddress">
7888	<desc>
7889	Searches for a USB device with the given host address.
7890
7891	<result name="VBOX_E_OBJECT_NOT_FOUND">
7892	Given @c name does not correspond to any USB device.
7893	</result>
7894
7895	<see><link to="IUSBDevice::address"/></see>
7896	</desc>
7897	<param name="name" type="wstring" dir="in">
7898	<desc>
7899	Address of the USB device (as assigned by the host) to
7900	search for.
7901	</desc>
7902	</param>
7903	<param name="device" type="IHostUSBDevice" dir="return">
7904	<desc>Found USB device object.</desc>
7905	</param>
7906	</method>
7907
7908	<method name="generateMACAddress">
7909	<desc>
7910	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7911	</desc>
7912	<param name="address" type="wstring" dir="return">
7913	<desc>New Ethernet MAC address.</desc>
7914	</param>
7915	</method>
7916
7917	</interface>
7918
7919	<!--
7920	// ISystemProperties
7921	/////////////////////////////////////////////////////////////////////////
7922	-->
7923
7924	<interface
7925	name="ISystemProperties"
7926	extends="$unknown"
7927	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7928	wsmap="managed"
7929	>
7930	<desc>
7931	The ISystemProperties interface represents global properties of the given
7932	VirtualBox installation.
7933
7934	These properties define limits and default values for various attributes
7935	and parameters. Most of the properties are read-only, but some can be
7936	changed by a user.
7937	</desc>
7938
7939	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7940	<desc>Minimum guest system memory in Megabytes.</desc>
7941	</attribute>
7942
7943	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7944	<desc>Maximum guest system memory in Megabytes.</desc>
7945	</attribute>
7946
7947	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7948	<desc>Minimum guest video memory in Megabytes.</desc>
7949	</attribute>
7950
7951	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7952	<desc>Maximum guest video memory in Megabytes.</desc>
7953	</attribute>
7954
7955	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7956	<desc>Minimum CPU count.</desc>
7957	</attribute>
7958
7959	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7960	<desc>Maximum CPU count.</desc>
7961	</attribute>
7962
7963	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7964	<desc>Maximum of monitors which could be connected.</desc>
7965	</attribute>
7966
7967	<attribute name="infoVDSize" type="long long" readonly="yes">
7968	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7969	does not reflect the limits of any virtual disk image format.</desc>
7970	</attribute>
7971
7972	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7973	<desc>
7974	Maximum number of serial ports associated with every
7975	<link to="IMachine"/> instance.
7976	</desc>
7977	</attribute>
7978
7979	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7980	<desc>
7981	Maximum number of parallel ports associated with every
7982	<link to="IMachine"/> instance.
7983	</desc>
7984	</attribute>
7985
7986	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7987	<desc>
7988	Maximum device position in the boot order. This value corresponds
7989	to the total number of devices a machine can boot from, to make it
7990	possible to include all possible devices to the boot list.
7991	<see><link to="IMachine::setBootOrder"/></see>
7992	</desc>
7993	</attribute>
7994
7995	<attribute name="defaultMachineFolder" type="wstring">
7996	<desc>
7997	Full path to the default directory used to create new or open
7998	existing machines when a machine settings file name contains no
7999	path.
8000
8001	Starting with VirtualBox 4.0, by default, this attribute contains
8002	the full path of folder named "VirtualBox VMs" in the user's
8003	home directory, which depends on the host platform.
8004
8005	When setting this attribute, a full path must be specified.
8006	Setting this property to @c null or an empty string or the
8007	special value "Machines" (for compatibility reasons) will restore
8008	that default value.
8009
8010	If the folder specified herein does not exist, it will be created
8011	automatically as needed.
8012
8013	<see>
8014	<link to="IVirtualBox::createMachine"/>,
8015	<link to="IVirtualBox::openMachine"/>
8016	</see>
8017	</desc>
8018	</attribute>
8019
8020	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8021	<desc>
8022	List of all medium storage formats supported by this VirtualBox
8023	installation.
8024
8025	Keep in mind that the medium format identifier
8026	(<link to="IMediumFormat::id"/>) used in other API calls like
8027	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8028	medium format is a case-insensitive string. This means that, for
8029	example, all of the following strings:
8030	<pre>
8031	"VDI"
8032	"vdi"
8033	"VdI"</pre>
8034	refer to the same medium format.
8035
8036	Note that the virtual medium framework is backend-based, therefore
8037	the list of supported formats depends on what backends are currently
8038	installed.
8039
8040	<see><link to="IMediumFormat"/></see>
8041	</desc>
8042	</attribute>
8043
8044	<attribute name="defaultHardDiskFormat" type="wstring">
8045	<desc>
8046	Identifier of the default medium format used by VirtualBox.
8047
8048	The medium format set by this attribute is used by VirtualBox
8049	when the medium format was not specified explicitly. One example is
8050	<link to="IVirtualBox::createHardDisk"/> with the empty
8051	format argument. A more complex example is implicit creation of
8052	differencing media when taking a snapshot of a virtual machine:
8053	this operation will try to use a format of the parent medium first
8054	and if this format does not support differencing media the default
8055	format specified by this argument will be used.
8056
8057	The list of supported medium formats may be obtained by the
8058	<link to="#mediumFormats"/> call. Note that the default medium
8059	format must have a capability to create differencing media;
8060	otherwise operations that create media implicitly may fail
8061	unexpectedly.
8062
8063	The initial value of this property is <tt>"VDI"</tt> in the current
8064	version of the VirtualBox product, but may change in the future.
8065
8066	<note>
8067	Setting this property to @c null or empty string will restore the
8068	initial value.
8069	</note>
8070
8071	<see>
8072	<link to="#mediumFormats"/>,
8073	<link to="IMediumFormat::id"/>,
8074	<link to="IVirtualBox::createHardDisk"/>
8075	</see>
8076	</desc>
8077	</attribute>
8078
8079	<attribute name="freeDiskSpaceWarning" type="long long">
8080	<desc>Issue a warning if the free disk space is below (or in some disk
8081	intensive operation is expected to go below) the given size in
8082	bytes.</desc>
8083	</attribute>
8084
8085	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8086	<desc>Issue a warning if the free disk space is below (or in some disk
8087	intensive operation is expected to go below) the given percentage.</desc>
8088	</attribute>
8089
8090	<attribute name="freeDiskSpaceError" type="long long">
8091	<desc>Issue an error if the free disk space is below (or in some disk
8092	intensive operation is expected to go below) the given size in
8093	bytes.</desc>
8094	</attribute>
8095
8096	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8097	<desc>Issue an error if the free disk space is below (or in some disk
8098	intensive operation is expected to go below) the given percentage.</desc>
8099	</attribute>
8100
8101	<attribute name="VRDEAuthLibrary" type="wstring">
8102	<desc>
8103	Library that provides authentication for Remote Desktop clients. The library
8104	is used if a virtual machine's authentication type is set to "external"
8105	in the VM RemoteDisplay configuration.
8106
8107	The system library extension (".DLL" or ".so") must be omitted.
8108	A full path can be specified; if not, then the library must reside on the
8109	system's default library path.
8110
8111	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8112	of that name in one of the default VirtualBox library directories.
8113
8114	For details about VirtualBox authentication libraries and how to implement
8115	them, please refer to the VirtualBox manual.
8116
8117	<note>
8118	Setting this property to @c null or empty string will restore the
8119	initial value.
8120	</note>
8121	</desc>
8122	</attribute>
8123
8124	<attribute name="webServiceAuthLibrary" type="wstring">
8125	<desc>
8126	Library that provides authentication for webservice clients. The library
8127	is used if a virtual machine's authentication type is set to "external"
8128	in the VM RemoteDisplay configuration and will be called from
8129	within the <link to="IWebsessionManager::logon" /> implementation.
8130
8131	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8132	there is no per-VM setting for this, as the webservice is a global
8133	resource (if it is running). Only for this setting (for the webservice),
8134	setting this value to a literal <tt>"null"</tt> string disables authentication,
8135	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8136	no matter what user name and password are supplied.
8137
8138	The initial value of this property is <tt>"VBoxAuth"</tt>,
8139	meaning that the webservice will use the same authentication
8140	library that is used by default for VRDE (again, see
8141	<link to="ISystemProperties::VRDEAuthLibrary" />).
8142	The format and calling convention of authentication libraries
8143	is the same for the webservice as it is for VRDE.
8144
8145	<note>
8146	Setting this property to @c null or empty string will restore the
8147	initial value.
8148	</note>
8149	</desc>
8150	</attribute>
8151
8152	<attribute name="defaultVRDEExtPack" type="wstring">
8153	<desc>
8154	The name of the extension pack providing the default VRDE.
8155
8156	This attribute is for choosing between multiple extension packs
8157	providing VRDE. If only one is installed, it will automatically be the
8158	default one. The attribute value can be empty if no VRDE extension
8159	pack is installed.
8160
8161	For details about VirtualBox Remote Desktop Extension and how to
8162	implement one, please refer to the VirtualBox SDK.
8163	</desc>
8164	</attribute>
8165
8166	<attribute name="logHistoryCount" type="unsigned long">
8167	<desc>
8168	This value specifies how many old release log files are kept.
8169	</desc>
8170	</attribute>
8171
8172	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8173	<desc>This value hold the default audio driver for the current
8174	system.</desc>
8175	</attribute>
8176
8177
8178	<method name="getMaxNetworkAdapters">
8179	<desc>
8180	Maximum total number of network adapters associated with every
8181	<link to="IMachine"/> instance.
8182	</desc>
8183
8184	<param name="chipset" type="ChipsetType" dir="in">
8185	<desc>The chipset type to get the value for.</desc>
8186	</param>
8187
8188
8189	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8190	<desc>The maximum total number of network adapters allowed.</desc>
8191	</param>
8192
8193	</method>
8194
8195	<method name="getMaxNetworkAdaptersOfType">
8196	<desc>
8197	Maximum number of network adapters of a given attachment type,
8198	associated with every <link to="IMachine"/> instance.
8199	</desc>
8200
8201	<param name="chipset" type="ChipsetType" dir="in">
8202	<desc>The chipset type to get the value for.</desc>
8203	</param>
8204
8205	<param name="type" type="NetworkAttachmentType" dir="in">
8206	<desc>Type of attachment.</desc>
8207	</param>
8208
8209	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8210	<desc>The maximum number of network adapters allowed for
8211	particular chipset and attachment type.</desc>
8212	</param>
8213
8214	</method>
8215
8216
8217	<method name="getMaxDevicesPerPortForStorageBus">
8218	<desc>Returns the maximum number of devices which can be attached to a port
8219	for the given storage bus.</desc>
8220
8221	<param name="bus" type="StorageBus" dir="in">
8222	<desc>The storage bus type to get the value for.</desc>
8223	</param>
8224
8225	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8226	<desc>The maximum number of devices which can be attached to the port for the given
8227	storage bus.</desc>
8228	</param>
8229	</method>
8230
8231	<method name="getMinPortCountForStorageBus">
8232	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8233
8234	<param name="bus" type="StorageBus" dir="in">
8235	<desc>The storage bus type to get the value for.</desc>
8236	</param>
8237
8238	<param name="minPortCount" type="unsigned long" dir="return">
8239	<desc>The minimum number of ports for the given storage bus.</desc>
8240	</param>
8241	</method>
8242
8243	<method name="getMaxPortCountForStorageBus">
8244	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8245
8246	<param name="bus" type="StorageBus" dir="in">
8247	<desc>The storage bus type to get the value for.</desc>
8248	</param>
8249
8250	<param name="maxPortCount" type="unsigned long" dir="return">
8251	<desc>The maximum number of ports for the given storage bus.</desc>
8252	</param>
8253	</method>
8254
8255	<method name="getMaxInstancesOfStorageBus">
8256	<desc>Returns the maximum number of storage bus instances which
8257	can be configured for each VM. This corresponds to the number of
8258	storage controllers one can have. Value may depend on chipset type
8259	used.</desc>
8260
8261	<param name="chipset" type="ChipsetType" dir="in">
8262	<desc>The chipset type to get the value for.</desc>
8263	</param>
8264
8265	<param name="bus" type="StorageBus" dir="in">
8266	<desc>The storage bus type to get the value for.</desc>
8267	</param>
8268
8269	<param name="maxInstances" type="unsigned long" dir="return">
8270	<desc>The maximum number of instances for the given storage bus.</desc>
8271	</param>
8272	</method>
8273
8274	<method name="getDeviceTypesForStorageBus">
8275	<desc>Returns list of all the supported device types
8276	(<link to="DeviceType"/>) for the given type of storage
8277	bus.</desc>
8278
8279	<param name="bus" type="StorageBus" dir="in">
8280	<desc>The storage bus type to get the value for.</desc>
8281	</param>
8282
8283	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8284	<desc>The list of all supported device types for the given storage bus.</desc>
8285	</param>
8286	</method>
8287
8288	<method name="getDefaultIoCacheSettingForStorageController">
8289	<desc>Returns the default I/O cache setting for the
8290	given storage controller</desc>
8291
8292	<param name="controllerType" type="StorageControllerType" dir="in">
8293	<desc>The storage controller to the setting for.</desc>
8294	</param>
8295
8296	<param name="enabled" type="boolean" dir="return">
8297	<desc>Returned flag indicating the default value</desc>
8298	</param>
8299	</method>
8300	</interface>
8301
8302	<!--
8303	// IGuest
8304	/////////////////////////////////////////////////////////////////////////
8305	-->
8306
8307	<interface
8308	name="IGuestOSType" extends="$unknown"
8309	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8310	wsmap="struct"
8311	>
8312	<desc>
8313	</desc>
8314
8315	<attribute name="familyId" type="wstring" readonly="yes">
8316	<desc>Guest OS family identifier string.</desc>
8317	</attribute>
8318
8319	<attribute name="familyDescription" type="wstring" readonly="yes">
8320	<desc>Human readable description of the guest OS family.</desc>
8321	</attribute>
8322
8323	<attribute name="id" type="wstring" readonly="yes">
8324	<desc>Guest OS identifier string.</desc>
8325	</attribute>
8326
8327	<attribute name="description" type="wstring" readonly="yes">
8328	<desc>Human readable description of the guest OS.</desc>
8329	</attribute>
8330
8331	<attribute name="is64Bit" type="boolean" readonly="yes">
8332	<desc>Returns @c true if the given OS is 64-bit</desc>
8333	</attribute>
8334
8335	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8336	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8337	</attribute>
8338
8339	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8340	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8341	</attribute>
8342
8343	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8344	<desc>Recommended RAM size in Megabytes.</desc>
8345	</attribute>
8346
8347	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8348	<desc>Recommended video RAM size in Megabytes.</desc>
8349	</attribute>
8350
8351	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8352	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8353	</attribute>
8354
8355	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8356	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8357	</attribute>
8358
8359	<attribute name="recommendedHDD" type="long long" readonly="yes">
8360	<desc>Recommended hard disk size in bytes.</desc>
8361	</attribute>
8362
8363	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8364	<desc>Returns recommended network adapter for this OS type.</desc>
8365	</attribute>
8366
8367	<attribute name="recommendedPae" type="boolean" readonly="yes">
8368	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8369	</attribute>
8370
8371	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8372	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8373	</attribute>
8374
8375	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8376	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8377	</attribute>
8378
8379	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8380	<desc>Recommended storage controller type for HD drives.</desc>
8381	</attribute>
8382
8383	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8384	<desc>Recommended storage bus type for HD drives.</desc>
8385	</attribute>
8386
8387	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8388	<desc>Recommended firmware type.</desc>
8389	</attribute>
8390
8391	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8392	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8393	</attribute>
8394
8395	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8396	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8397	</attribute>
8398
8399	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8400	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8401	</attribute>
8402
8403	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8404	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8405	</attribute>
8406
8407	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8408	<desc>Recommended chipset type.</desc>
8409	</attribute>
8410
8411	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8412	<desc>Recommended audio type.</desc>
8413	</attribute>
8414
8415	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8416	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8417	</attribute>
8418
8419	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8420	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8421	</attribute>
8422
8423	</interface>
8424
8425	<enum
8426	name="AdditionsFacilityType"
8427	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8428	>
8429	<desc>
8430	Guest Additions facility IDs.
8431	</desc>
8432
8433	<const name="None" value="0">
8434	<desc>No/invalid facility.</desc>
8435	</const>
8436	<const name="VBoxGuestDriver" value="20">
8437	<desc>VirtualBox base driver (VBoxGuest).</desc>
8438	</const>
8439	<const name="AutoLogon" value="90">
8440	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8441	</const>
8442	<const name="VBoxService" value="100">
8443	<desc>VirtualBox system service (VBoxService).</desc>
8444	</const>
8445	<const name="VBoxTrayClient" value="101">
8446	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8447	</const>
8448	<const name="Seamless" value="1000">
8449	<desc>Seamless guest desktop integration.</desc>
8450	</const>
8451	<const name="Graphics" value="1100">
8452	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8453	are not immediately acted on and guest display resizes are probably not initiated by
8454	the guest additions.
8455	</desc>
8456	</const>
8457	<const name="All" value="2147483646">
8458	<desc>All facilities selected.</desc>
8459	</const>
8460	</enum>
8461
8462	<enum
8463	name="AdditionsFacilityClass"
8464	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8465	>
8466	<desc>
8467	Guest Additions facility classes.
8468	</desc>
8469
8470	<const name="None" value="0">
8471	<desc>No/invalid class.</desc>
8472	</const>
8473	<const name="Driver" value="10">
8474	<desc>Driver.</desc>
8475	</const>
8476	<const name="Service" value="30">
8477	<desc>System service.</desc>
8478	</const>
8479	<const name="Program" value="50">
8480	<desc>Program.</desc>
8481	</const>
8482	<const name="Feature" value="100">
8483	<desc>Feature.</desc>
8484	</const>
8485	<const name="ThirdParty" value="999">
8486	<desc>Third party.</desc>
8487	</const>
8488	<const name="All" value="2147483646">
8489	<desc>All facility classes selected.</desc>
8490	</const>
8491	</enum>
8492
8493	<enum
8494	name="AdditionsFacilityStatus"
8495	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8496	>
8497	<desc>
8498	Guest Additions facility states.
8499	</desc>
8500
8501	<const name="Inactive" value="0">
8502	<desc>Facility is not active.</desc>
8503	</const>
8504	<const name="Paused" value="1">
8505	<desc>Facility has been paused.</desc>
8506	</const>
8507	<const name="PreInit" value="20">
8508	<desc>Facility is preparing to initialize.</desc>
8509	</const>
8510	<const name="Init" value="30">
8511	<desc>Facility is initializing.</desc>
8512	</const>
8513	<const name="Active" value="50">
8514	<desc>Facility is up and running.</desc>
8515	</const>
8516	<const name="Terminating" value="100">
8517	<desc>Facility is shutting down.</desc>
8518	</const>
8519	<const name="Terminated" value="101">
8520	<desc>Facility successfully shut down.</desc>
8521	</const>
8522	<const name="Failed" value="800">
8523	<desc>Facility failed to start.</desc>
8524	</const>
8525	<const name="Unknown" value="999">
8526	<desc>Facility status is unknown.</desc>
8527	</const>
8528	</enum>
8529
8530	<interface
8531	name="IAdditionsFacility" extends="$unknown"
8532	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8533	wsmap="struct"
8534	>
8535	<desc>
8536	Structure representing a Guest Additions facility.
8537	</desc>
8538
8539	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8540	<desc>The class this facility is part of.</desc>
8541	</attribute>
8542
8543	<attribute name="lastUpdated" type="long long" readonly="yes">
8544	<desc>
8545	Time stamp of the last status update,
8546	in milliseconds since 1970-01-01 UTC.
8547	</desc>
8548	</attribute>
8549
8550	<attribute name="name" type="wstring" readonly="yes">
8551	<desc>The facility's friendly name.</desc>
8552	</attribute>
8553
8554	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8555	<desc>The current status.</desc>
8556	</attribute>
8557
8558	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8559	<desc>The facility's type ID.</desc>
8560	</attribute>
8561	</interface>
8562
8563	<enum
8564	name="AdditionsRunLevelType"
8565	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8566	>
8567	<desc>
8568	Guest Additions run level type.
8569	</desc>
8570
8571	<const name="None" value="0">
8572	<desc>Guest Additions are not loaded.</desc>
8573	</const>
8574	<const name="System" value="1">
8575	<desc>Guest drivers are loaded.</desc>
8576	</const>
8577	<const name="Userland" value="2">
8578	<desc>Common components (such as application services) are loaded.</desc>
8579	</const>
8580	<const name="Desktop" value="3">
8581	<desc>Per-user desktop components are loaded.</desc>
8582	</const>
8583	</enum>
8584
8585	<enum
8586	name="AdditionsUpdateFlag"
8587	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8588	>
8589	<desc>
8590	Guest Additions update flags.
8591	</desc>
8592
8593	<const name="None" value="0">
8594	<desc>No flag set.</desc>
8595	</const>
8596	<const name="WaitForUpdateStartOnly" value="1">
8597	<desc>Only wait for the update process being started and do not
8598	wait while peforming the actual update.</desc>
8599	</const>
8600	</enum>
8601
8602	<enum
8603	name="ExecuteProcessFlag"
8604	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8605	>
8606	<desc>
8607	Guest process execution flags.
8608	</desc>
8609
8610	<const name="None" value="0">
8611	<desc>No flag set.</desc>
8612	</const>
8613	<const name="WaitForProcessStartOnly" value="1">
8614	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8615	process itself then uses an infinite timeout.</desc>
8616	</const>
8617	<const name="IgnoreOrphanedProcesses" value="2">
8618	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8619	</const>
8620	<const name="Hidden" value="4">
8621	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8622	</const>
8623	<const name="NoProfile" value="8">
8624	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8625	</const>
8626	<const name="WaitForStdOut" value="16">
8627	<desc>The guest process waits until all data from stdout is read out.</desc>
8628	</const>
8629	<const name="WaitForStdErr" value="32">
8630	<desc>The guest process waits until all data from stderr is read out.</desc>
8631	</const>
8632	</enum>
8633
8634	<enum
8635	name="ExecuteProcessStatus"
8636	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8637	>
8638	<desc>
8639	Guest process execution status.
8640	</desc>
8641	<const name="Undefined" value="0">
8642	<desc>Process is in an undefined state.</desc>
8643	</const>
8644
8645	<const name="Started" value="1">
8646	<desc>Process has been started.</desc>
8647	</const>
8648	<const name="TerminatedNormally" value="2">
8649	<desc>Process terminated normally.</desc>
8650	</const>
8651	<const name="TerminatedSignal" value="3">
8652	<desc>Process terminated via signal.</desc>
8653	</const>
8654	<const name="TerminatedAbnormally" value="4">
8655	<desc>Process terminated abnormally.</desc>
8656	</const>
8657	<const name="TimedOutKilled" value="5">
8658	<desc>Process timed out and was killed.</desc>
8659	</const>
8660	<const name="TimedOutAbnormally" value="6">
8661	<desc>Process timed out and was not killed successfully.</desc>
8662	</const>
8663	<const name="Down" value="7">
8664	<desc>Service/OS is stopping, process was killed.</desc>
8665	</const>
8666	<const name="Error" value="8">
8667	<desc>Something went wrong (error code in flags).</desc>
8668	</const>
8669	</enum>
8670
8671	<enum
8672	name="FileSeekType"
8673	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8674	>
8675	<desc>
8676	TODO
8677	</desc>
8678
8679	<const name="Set" value="0">
8680	<desc>TODO</desc>
8681	</const>
8682	<const name="Current" value="1">
8683	<desc>TODO</desc>
8684	</const>
8685	</enum>
8686
8687	<enum
8688	name="ProcessInputFlag"
8689	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8690	>
8691	<desc>
8692	Guest process input flags.
8693	</desc>
8694	<const name="None" value="0">
8695	<desc>No flag set.</desc>
8696	</const>
8697	<const name="EndOfFile" value="1">
8698	<desc>End of file (input) reached.</desc>
8699	</const>
8700	</enum>
8701
8702	<enum
8703	name="ProcessOutputFlag"
8704	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8705	>
8706	<desc>
8707	Guest process output flags for specifying which
8708	type of output to retrieve.
8709	</desc>
8710	<const name="None" value="0">
8711	<desc>No flags set. Get output from stdout.</desc>
8712	</const>
8713	<const name="StdErr" value="1">
8714	<desc>Get output from stderr.</desc>
8715	</const>
8716	</enum>
8717
8718	<enum
8719	name="ProcessWaitForFlag"
8720	uuid="858a99aa-4b3c-4863-9726-87386671f408"
8721	>
8722	<desc>
8723	TODO
8724	</desc>
8725
8726	<const name="None" value="0">
8727	<desc>TODO</desc>
8728	</const>
8729	<const name="Exit" value="1">
8730	<desc>TODO</desc>
8731	</const>
8732	<const name="StdIn" value="2">
8733	<desc>TODO</desc>
8734	</const>
8735	<const name="StdOut" value="4">
8736	<desc>TODO</desc>
8737	</const>
8738	<const name="StdErr" value="8">
8739	<desc>TODO</desc>
8740	</const>
8741	<const name="Start" value="16">
8742	<desc>TODO</desc>
8743	</const>
8744	<const name="Status" value="32">
8745	<desc>TODO</desc>
8746	</const>
8747	</enum>
8748
8749	<enum
8750	name="ProcessWaitReason"
8751	uuid="3fcbabf5-27e0-407a-9881-421b36c23978"
8752	>
8753	<desc>
8754	TODO
8755	</desc>
8756
8757	<const name="Status" value="0">
8758	<desc>TODO</desc>
8759	</const>
8760	<const name="Error" value="10">
8761	<desc>TODO</desc>
8762	</const>
8763	<const name="Timeout" value="50">
8764	<desc>TODO</desc>
8765	</const>
8766	<const name="StdIn" value="100">
8767	<desc>TODO</desc>
8768	</const>
8769	<const name="StdOut" value="150">
8770	<desc>TODO</desc>
8771	</const>
8772	<const name="StdErr" value="200">
8773	<desc>TODO</desc>
8774	</const>
8775	</enum>
8776
8777	<enum
8778	name="CopyFileFlag"
8779	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8780	>
8781	<desc>
8782	Host/Guest copy flags. At the moment none of these flags
8783	are implemented.
8784	</desc>
8785	<const name="None" value="0">
8786	<desc>No flag set.</desc>
8787	</const>
8788	<const name="Recursive" value="1">
8789	<desc>Copy directories recursively.</desc>
8790	</const>
8791	<const name="Update" value="2">
8792	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8793	</const>
8794	<const name="FollowLinks" value="4">
8795	<desc>Follow symbolic links.</desc>
8796	</const>
8797	</enum>
8798
8799	<enum
8800	name="DirectoryCreateFlag"
8801	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8802	>
8803	<desc>
8804	Directory creation flags.
8805	</desc>
8806	<const name="None" value="0">
8807	<desc>No flag set.</desc>
8808	</const>
8809	<const name="Parents" value="1">
8810	<desc>No error if existing, make parent directories as needed.</desc>
8811	</const>
8812	</enum>
8813
8814	<enum
8815	name="DirectoryRemoveRecFlag"
8816	uuid="455aabf0-7692-48f6-9061-f21579b65769"
8817	>
8818	<desc>
8819	TODO
8820	</desc>
8821
8822	<const name="None" value="0">
8823	<desc>No flag set.</desc>
8824	</const>
8825	<const name="ContentAndDir" value="1">
8826	<desc>TODO</desc>
8827	</const>
8828	<const name="ContentOnly" value="2">
8829	<desc>TODO</desc>
8830	</const>
8831	</enum>
8832
8833	<enum
8834	name="PathRenameFlag"
8835	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
8836	>
8837	<desc>
8838	TODO
8839	</desc>
8840
8841	<const name="None" value="0">
8842	<desc>No flag set.</desc>
8843	</const>
8844	<const name="NoReplace" value="1">
8845	<desc>TODO</desc>
8846	</const>
8847	<const name="Replace" value="2">
8848	<desc>TODO</desc>
8849	</const>
8850	<const name="NoSymlinks" value="4">
8851	<desc>TODO</desc>
8852	</const>
8853	</enum>
8854
8855	<enum
8856	name="ProcessCreateFlag"
8857	uuid="1497c881-70b4-42dd-8b42-2ad76f004e3f"
8858	>
8859	<desc>
8860	Guest process execution flags.
8861	</desc>
8862
8863	<const name="None" value="0">
8864	<desc>No flag set.</desc>
8865	</const>
8866	<const name="WaitForProcessStartOnly" value="1">
8867	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8868	process itself then uses an infinite timeout.</desc>
8869	</const>
8870	<const name="IgnoreOrphanedProcesses" value="2">
8871	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8872	</const>
8873	<const name="Hidden" value="4">
8874	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8875	</const>
8876	<const name="NoProfile" value="8">
8877	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8878	</const>
8879	</enum>
8880
8881	<enum
8882	name="ProcessPriority"
8883	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
8884	>
8885	<desc>
8886	TODO
8887	</desc>
8888
8889	<const name="Invalid" value="0">
8890	<desc>TODO</desc>
8891	</const>
8892	<const name="Default" value="1">
8893	<desc>TODO</desc>
8894	</const>
8895	</enum>
8896
8897	<enum
8898	name="SymlinkType"
8899	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
8900	>
8901	<desc>
8902	TODO
8903	</desc>
8904
8905	<const name="Unknown" value="0">
8906	<desc>TODO</desc>
8907	</const>
8908	<const name="Directory" value="1">
8909	<desc>TODO</desc>
8910	</const>
8911	<const name="File" value="2">
8912	<desc>TODO</desc>
8913	</const>
8914	</enum>
8915
8916	<enum
8917	name="SymlinkReadFlag"
8918	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
8919	>
8920	<desc>
8921	TODO
8922	</desc>
8923
8924	<const name="None" value="0">
8925	<desc>TODO.</desc>
8926	</const>
8927	<const name="NoSymlinks" value="1">
8928	<desc>TODO</desc>
8929	</const>
8930	</enum>
8931
8932	<enum
8933	name="ProcessStatus"
8934	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
8935	>
8936	<desc>
8937	Guest process execution status.
8938	</desc>
8939	<const name="Undefined" value="0">
8940	<desc>Process is in an undefined state.</desc>
8941	</const>
8942
8943	<const name="Starting" value="10">
8944	<desc>TODO</desc>
8945	</const>
8946	<const name="Started" value="100">
8947	<desc>Process has been started.</desc>
8948	</const>
8949	<const name="Paused" value="110">
8950	<desc>TODO</desc>
8951	</const>
8952	<const name="Terminating" value="480">
8953	<desc>TODO</desc>
8954	</const>
8955	<const name="TerminatedNormally" value="500">
8956	<desc>Process terminated normally.</desc>
8957	</const>
8958	<const name="TerminatedSignal" value="510">
8959	<desc>Process terminated via signal.</desc>
8960	</const>
8961	<const name="TerminatedAbnormally" value="511">
8962	<desc>Process terminated abnormally.</desc>
8963	</const>
8964	<const name="TimedOutKilled" value="512">
8965	<desc>Process timed out and was killed.</desc>
8966	</const>
8967	<const name="TimedOutAbnormally" value="513">
8968	<desc>Process timed out and was not killed successfully.</desc>
8969	</const>
8970	<const name="Down" value="600">
8971	<desc>Service/OS is stopping, process was killed.</desc>
8972	</const>
8973	<const name="Error" value="800">
8974	<desc>Something went wrong (error code in flags).</desc>
8975	</const>
8976	</enum>
8977
8978	<enum
8979	name="FsObjType"
8980	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
8981	>
8982	<desc>
8983	TODO
8984	</desc>
8985
8986	<const name="Undefined" value="0">
8987	<desc>TODO</desc>
8988	</const>
8989	<const name="FIFO" value="1">
8990	<desc>TODO</desc>
8991	</const>
8992	<const name="DevChar" value="10">
8993	<desc>TODO</desc>
8994	</const>
8995	<const name="DevBlock" value="11">
8996	<desc>TODO</desc>
8997	</const>
8998	<const name="Directory" value="50">
8999	<desc>TODO</desc>
9000	</const>
9001	<const name="File" value="80">
9002	<desc>TODO</desc>
9003	</const>
9004	<const name="Symlink" value="100">
9005	<desc>TODO</desc>
9006	</const>
9007	<const name="Socket" value="200">
9008	<desc>TODO</desc>
9009	</const>
9010	<const name="Whiteout" value="400">
9011	<desc>TODO</desc>
9012	</const>
9013	</enum>
9014
9015	<enum
9016	name="DragAndDropAction"
9017	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9018	>
9019	<desc>
9020	Possible actions within an Drag and Drop operation.
9021	</desc>
9022
9023	<const name="Ignore" value="0">
9024	<desc>Do nothing.</desc>
9025	</const>
9026
9027	<const name="Copy" value="1">
9028	<desc>Copy the item to the target.</desc>
9029	</const>
9030
9031	<const name="Move" value="2">
9032	<desc>Move the item to the target.</desc>
9033	</const>
9034
9035	<const name="Link" value="3">
9036	<desc>Link the item from within the target.</desc>
9037	</const>
9038	</enum>
9039
9040	<enum
9041	name="DirectoryOpenFlag"
9042	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
9043	>
9044	<desc>
9045	Directory open flags.
9046	</desc>
9047	<const name="None" value="0">
9048	<desc>No flag set.</desc>
9049	</const>
9050	</enum>
9051
9052	<enum
9053	name="GuestDirEntryType"
9054	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
9055	>
9056	<desc>
9057	Guest directory entry type.
9058	</desc>
9059	<const name="Unknown" value="0">
9060	<desc>Unknown.</desc>
9061	</const>
9062	<const name="Directory" value="4">
9063	<desc>Regular file.</desc>
9064	</const>
9065	<const name="File" value="10">
9066	<desc>Regular file.</desc>
9067	</const>
9068	<const name="Symlink" value="12">
9069	<desc>Symbolic link.</desc>
9070	</const>
9071	</enum>
9072
9073	<interface
9074	name="IGuestDirEntry" extends="$unknown"
9075	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
9076	wsmap="struct"
9077	>
9078	<desc>
9079	Structure representing a directory entry on the guest OS.
9080	</desc>
9081	<attribute name="nodeId" type="long long" readonly="yes">
9082	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
9083	</attribute>
9084	<attribute name="name" type="wstring" readonly="yes">
9085	<desc>The filename.</desc>
9086	</attribute>
9087	<attribute name="type" type="GuestDirEntryType" readonly="yes">
9088	<desc>The entry type.</desc>
9089	</attribute>
9090	</interface>
9091
9092	<interface
9093	name="IGuestSession" extends="$unknown"
9094	uuid="158aff3c-5258-4994-88cb-6fd679c7e3ed"
9095	wsmap="managed"
9096	>
9097
9098	<attribute name="user" type="wstring" readonly="yes">
9099	<desc>
9100	TODO
9101	<note>
9102	TODO
9103	</note>
9104	</desc>
9105	</attribute>
9106
9107	<attribute name="domain" type="wstring" readonly="yes">
9108	<desc>
9109	TODO
9110	<note>
9111	TODO
9112	</note>
9113	</desc>
9114	</attribute>
9115
9116	<attribute name="name" type="wstring" readonly="yes">
9117	<desc>
9118	TODO
9119	<note>
9120	TODO
9121	</note>
9122	</desc>
9123	</attribute>
9124
9125	<attribute name="id" type="unsigned long" readonly="yes">
9126	<desc>
9127	TODO
9128	<note>
9129	TODO
9130	</note>
9131	</desc>
9132	</attribute>
9133
9134	<attribute name="timeout" type="unsigned long" readonly="yes">
9135	<desc>
9136	TODO
9137	<note>
9138	TODO
9139	</note>
9140	</desc>
9141	</attribute>
9142
9143	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
9144	<desc>
9145	TODO
9146	</desc>
9147	</attribute>
9148
9149	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9150	<desc>
9151	TODO
9152	</desc>
9153	</attribute>
9154
9155	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9156	<desc>
9157	TODO
9158	</desc>
9159	</attribute>
9160
9161	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9162	<desc>
9163	TODO
9164	</desc>
9165	</attribute>
9166
9167	<method name="Close">
9168	<desc>
9169	TODO
9170
9171	<result name="VBOX_E_NOT_SUPPORTED">
9172	TODO
9173	</result>
9174	</desc>
9175	</method>
9176
9177	<method name="CopyFrom">
9178	<desc>
9179	TODO
9180
9181	<result name="VBOX_E_NOT_SUPPORTED">
9182	TODO
9183	</result>
9184	</desc>
9185	<param name="source" type="wstring" dir="in">
9186	<desc>TODO</desc>
9187	</param>
9188	<param name="dest" type="wstring" dir="in">
9189	<desc>TODO</desc>
9190	</param>
9191	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9192	<desc>TODO</desc>
9193	</param>
9194	<param name="progress" type="IProgress" dir="return">
9195	<desc>Progress object to track the operation completion.</desc>
9196	</param>
9197	</method>
9198
9199	<method name="CopyTo">
9200	<desc>
9201	TODO
9202
9203	<result name="VBOX_E_NOT_SUPPORTED">
9204	TODO
9205	</result>
9206	</desc>
9207	<param name="source" type="wstring" dir="in">
9208	<desc>TODO</desc>
9209	</param>
9210	<param name="dest" type="wstring" dir="in">
9211	<desc>TODO</desc>
9212	</param>
9213	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9214	<desc>TODO</desc>
9215	</param>
9216	<param name="progress" type="IProgress" dir="return">
9217	<desc>Progress object to track the operation completion.</desc>
9218	</param>
9219	</method>
9220
9221	<method name="DirectoryCreate">
9222	<desc>
9223	TODO
9224
9225	<result name="VBOX_E_NOT_SUPPORTED">
9226	TODO
9227	</result>
9228	</desc>
9229	<param name="path" type="wstring" dir="in">
9230	<desc>TODO</desc>
9231	</param>
9232	<param name="mode" type="unsigned long" dir="in">
9233	<desc>TODO</desc>
9234	</param>
9235	<param name="flags" type="unsigned long" dir="in">
9236	<desc>TODO</desc>
9237	</param>
9238	<param name="directory" type="IGuestDirectory" dir="return">
9239	<desc>Optional.</desc>
9240	</param>
9241	</method>
9242
9243	<method name="DirectoryCreateTemp">
9244	<desc>
9245	TODO
9246
9247	<result name="VBOX_E_NOT_SUPPORTED">
9248	TODO
9249	</result>
9250	</desc>
9251	<param name="templateName" type="wstring" dir="in">
9252	<desc>TODO</desc>
9253	</param>
9254	<param name="mode" type="unsigned long" dir="in">
9255	<desc>TODO</desc>
9256	</param>
9257	<param name="path" type="wstring" dir="in">
9258	<desc>TODO</desc>
9259	</param>
9260	<param name="directory" type="IGuestDirectory" dir="return">
9261	<desc>TODO</desc>
9262	</param>
9263	</method>
9264
9265	<method name="DirectoryExists">
9266	<desc>
9267	TODO
9268
9269	<result name="VBOX_E_NOT_SUPPORTED">
9270	TODO
9271	</result>
9272	</desc>
9273	<param name="path" type="wstring" dir="in">
9274	<desc>TODO</desc>
9275	</param>
9276	<param name="exists" type="boolean" dir="return">
9277	<desc>TODO</desc>
9278	</param>
9279	</method>
9280
9281	<method name="DirectoryOpen">
9282	<desc>
9283	TODO
9284
9285	<result name="VBOX_E_NOT_SUPPORTED">
9286	TODO
9287	</result>
9288	</desc>
9289	<param name="path" type="wstring" dir="in">
9290	<desc>TODO</desc>
9291	</param>
9292	<param name="filter" type="wstring" dir="in">
9293	<desc>TODO</desc>
9294	</param>
9295	<param name="flags" type="wstring" dir="in">
9296	<desc>TODO</desc>
9297	</param>
9298	<param name="directory" type="IGuestDirectory" dir="return">
9299	<desc>TODO</desc>
9300	</param>
9301	</method>
9302
9303	<method name="DirectoryQueryInfo">
9304	<desc>
9305	TODO
9306
9307	<result name="VBOX_E_NOT_SUPPORTED">
9308	TODO
9309	</result>
9310	</desc>
9311	<param name="path" type="wstring" dir="in">
9312	<desc>TODO</desc>
9313	</param>
9314	<param name="info" type="IGuestFsObjInfo" dir="return">
9315	<desc>TODO</desc>
9316	</param>
9317	</method>
9318
9319	<method name="DirectoryRemove">
9320	<desc>
9321	TODO
9322
9323	<result name="VBOX_E_NOT_SUPPORTED">
9324	TODO
9325	</result>
9326	</desc>
9327	<param name="path" type="wstring" dir="in">
9328	<desc>TODO</desc>
9329	</param>
9330	</method>
9331
9332	<method name="DirectoryRemoveRecursive">
9333	<desc>
9334	TODO
9335
9336	<result name="VBOX_E_NOT_SUPPORTED">
9337	TODO
9338	</result>
9339	</desc>
9340	<param name="path" type="wstring" dir="in">
9341	<desc>TODO</desc>
9342	</param>
9343	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9344	<desc>TODO</desc>
9345	</param>
9346	<param name="progress" type="IProgress" dir="return">
9347	<desc>TODO</desc>
9348	</param>
9349	</method>
9350
9351	<method name="DirectoryRename">
9352	<desc>
9353	TODO
9354
9355	<result name="VBOX_E_NOT_SUPPORTED">
9356	TODO
9357	</result>
9358	</desc>
9359	<param name="source" type="wstring" dir="in">
9360	<desc>TODO</desc>
9361	</param>
9362	<param name="dest" type="wstring" dir="in">
9363	<desc>TODO</desc>
9364	</param>
9365	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9366	<desc>TODO</desc>
9367	</param>
9368	</method>
9369
9370	<method name="DirectorySetACL">
9371	<desc>
9372	TODO
9373
9374	<result name="VBOX_E_NOT_SUPPORTED">
9375	TODO
9376	</result>
9377	</desc>
9378	<param name="path" type="wstring" dir="in">
9379	<desc>TODO</desc>
9380	</param>
9381	<param name="acl" type="wstring" dir="in">
9382	<desc>TODO</desc>
9383	</param>
9384	</method>
9385
9386	<method name="EnvironmentClear">
9387	<desc>
9388	TODO
9389
9390	<result name="VBOX_E_NOT_SUPPORTED">
9391	TODO
9392	</result>
9393	</desc>
9394	</method>
9395
9396	<method name="EnvironmentSet">
9397	<desc>
9398	TODO
9399
9400	<result name="VBOX_E_NOT_SUPPORTED">
9401	TODO
9402	</result>
9403	</desc>
9404	<param name="name" type="wstring" dir="in">
9405	<desc>TODO</desc>
9406	</param>
9407	<param name="value" type="wstring" dir="in">
9408	<desc>TODO</desc>
9409	</param>
9410	</method>
9411
9412	<method name="EnvironmentSetArray">
9413	<desc>
9414	TODO
9415
9416	<result name="VBOX_E_NOT_SUPPORTED">
9417	TODO
9418	</result>
9419	</desc>
9420	<param name="environment" type="wstring" dir="in" safearray="yes">
9421	<desc>TODO</desc>
9422	</param>
9423	</method>
9424
9425	<method name="EnvironmentUnset">
9426	<desc>
9427	TODO
9428
9429	<result name="VBOX_E_NOT_SUPPORTED">
9430	TODO
9431	</result>
9432	</desc>
9433	<param name="name" type="wstring" dir="in">
9434	<desc>TODO</desc>
9435	</param>
9436	</method>
9437
9438	<method name="FileCreateTemp">
9439	<desc>
9440	TODO
9441
9442	<result name="VBOX_E_NOT_SUPPORTED">
9443	TODO
9444	</result>
9445	</desc>
9446	<param name="templateName" type="wstring" dir="in">
9447	<desc>TODO</desc>
9448	</param>
9449	<param name="mode" type="unsigned long" dir="in">
9450	<desc>TODO</desc>
9451	</param>
9452	<param name="path" type="wstring" dir="in">
9453	<desc>TODO</desc>
9454	</param>
9455	<param name="file" type="IGuestFile" dir="return">
9456	<desc>Optional.</desc>
9457	</param>
9458	</method>
9459
9460	<method name="FileExists">
9461	<desc>
9462	TODO
9463
9464	<result name="VBOX_E_NOT_SUPPORTED">
9465	TODO
9466	</result>
9467	</desc>
9468	<param name="path" type="wstring" dir="in">
9469	<desc>TODO</desc>
9470	</param>
9471	<param name="exists" type="boolean" dir="return">
9472	<desc>TODO</desc>
9473	</param>
9474	</method>
9475
9476	<method name="FileOpen">
9477	<desc>
9478	TODO
9479
9480	<result name="VBOX_E_NOT_SUPPORTED">
9481	TODO
9482	</result>
9483	</desc>
9484	<param name="path" type="wstring" dir="in">
9485	<desc>TODO</desc>
9486	</param>
9487	<param name="openMode" type="wstring" dir="in">
9488	<desc>TODO</desc>
9489	</param>
9490	<param name="disposition" type="wstring" dir="in">
9491	<desc>TODO</desc>
9492	</param>
9493	<param name="creationMode" type="unsigned long" dir="in">
9494	<desc>TODO</desc>
9495	</param>
9496	<param name="offset" type="long long" dir="in">
9497	<desc>TODO</desc>
9498	</param>
9499	<param name="file" type="IGuestFile" dir="return">
9500	<desc>TODO</desc>
9501	</param>
9502	</method>
9503
9504	<method name="FileQueryInfo">
9505	<desc>
9506	TODO
9507
9508	<result name="VBOX_E_NOT_SUPPORTED">
9509	TODO
9510	</result>
9511	</desc>
9512	<param name="path" type="wstring" dir="in">
9513	<desc>TODO</desc>
9514	</param>
9515	<param name="info" type="IGuestFsObjInfo" dir="return">
9516	<desc>TODO</desc>
9517	</param>
9518	</method>
9519
9520	<method name="FileQuerySize">
9521	<desc>
9522	TODO
9523
9524	<result name="VBOX_E_NOT_SUPPORTED">
9525	TODO
9526	</result>
9527	</desc>
9528	<param name="path" type="wstring" dir="in">
9529	<desc>TODO</desc>
9530	</param>
9531	<param name="size" type="long long" dir="return">
9532	<desc>TODO</desc>
9533	</param>
9534	</method>
9535
9536	<method name="FileRename">
9537	<desc>
9538	TODO
9539
9540	<result name="VBOX_E_NOT_SUPPORTED">
9541	TODO
9542	</result>
9543	</desc>
9544	<param name="source" type="wstring" dir="in">
9545	<desc>TODO</desc>
9546	</param>
9547	<param name="dest" type="wstring" dir="in">
9548	<desc>TODO</desc>
9549	</param>
9550	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9551	<desc>TODO</desc>
9552	</param>
9553	</method>
9554
9555	<method name="FileSetACL">
9556	<desc>
9557	TODO
9558
9559	<result name="VBOX_E_NOT_SUPPORTED">
9560	TODO
9561	</result>
9562	</desc>
9563	<param name="file" type="wstring" dir="in">
9564	<desc>TODO</desc>
9565	</param>
9566	<param name="acl" type="wstring" dir="in">
9567	<desc>TODO</desc>
9568	</param>
9569	</method>
9570
9571	<method name="ProcessCreate">
9572	<desc>
9573	TODO
9574
9575	<result name="VBOX_E_NOT_SUPPORTED">
9576	TODO
9577	</result>
9578	</desc>
9579	<param name="command" type="wstring" dir="in">
9580	<desc>TODO</desc>
9581	</param>
9582	<param name="arguments" type="wstring" dir="in" safearray="yes">
9583	<desc>TODO</desc>
9584	</param>
9585	<param name="environment" type="wstring" dir="in" safearray="yes">
9586	<desc>TODO</desc>
9587	</param>
9588	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9589	<desc>TODO</desc>
9590	</param>
9591	<param name="timeoutMS" type="unsigned long" dir="in">
9592	<desc>TODO</desc>
9593	</param>
9594	<param name="guestProcess" type="IGuestProcess" dir="return">
9595	<desc>TODO</desc>
9596	</param>
9597	</method>
9598
9599	<method name="ProcessCreateEx">
9600	<desc>
9601	TODO
9602
9603	<result name="VBOX_E_NOT_SUPPORTED">
9604	TODO
9605	</result>
9606	</desc>
9607	<param name="command" type="wstring" dir="in">
9608	<desc>TODO</desc>
9609	</param>
9610	<param name="arguments" type="wstring" dir="in" safearray="yes">
9611	<desc>TODO</desc>
9612	</param>
9613	<param name="environment" type="wstring" dir="in" safearray="yes">
9614	<desc>TODO</desc>
9615	</param>
9616	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9617	<desc>TODO</desc>
9618	</param>
9619	<param name="timeoutMS" type="unsigned long" dir="in">
9620	<desc>TODO</desc>
9621	</param>
9622	<param name="priority" type="ProcessPriority" dir="in">
9623	<desc>TODO</desc>
9624	</param>
9625	<param name="affinity" type="long" dir="in" safearray="yes">
9626	<desc>TODO</desc>
9627	</param>
9628	<param name="guestProcess" type="IGuestProcess" dir="return">
9629	<desc>TODO</desc>
9630	</param>
9631	</method>
9632
9633	<method name="ProcessGet">
9634	<desc>
9635	TODO
9636
9637	<result name="VBOX_E_NOT_SUPPORTED">
9638	TODO
9639	</result>
9640	</desc>
9641	<param name="pid" type="unsigned long" dir="in">
9642	<desc>TODO</desc>
9643	</param>
9644	<param name="guestProcess" type="IGuestProcess" dir="return">
9645	<desc>TODO</desc>
9646	</param>
9647	</method>
9648
9649	<method name="SetTimeout">
9650	<desc>
9651	TODO
9652
9653	<result name="VBOX_E_NOT_SUPPORTED">
9654	TODO
9655	</result>
9656	</desc>
9657	<param name="timeoutMS" type="unsigned long" dir="in">
9658	<desc>TODO</desc>
9659	</param>
9660	</method>
9661
9662	<method name="SymlinkCreate">
9663	<desc>
9664	TODO
9665
9666	<result name="VBOX_E_NOT_SUPPORTED">
9667	TODO
9668	</result>
9669	</desc>
9670	<param name="source" type="wstring" dir="in">
9671	<desc>TODO</desc>
9672	</param>
9673	<param name="target" type="wstring" dir="in">
9674	<desc>TODO</desc>
9675	</param>
9676	<param name="type" type="SymlinkType" dir="in">
9677	<desc>TODO</desc>
9678	</param>
9679	</method>
9680
9681	<method name="SymlinkExists">
9682	<desc>
9683	TODO
9684
9685	<result name="VBOX_E_NOT_SUPPORTED">
9686	TODO
9687	</result>
9688	</desc>
9689	<param name="symlink" type="wstring" dir="in">
9690	<desc>TODO</desc>
9691	</param>
9692	<param name="exists" type="boolean" dir="return">
9693	<desc>TODO</desc>
9694	</param>
9695	</method>
9696
9697	<method name="SymlinkRead">
9698	<desc>
9699	TODO
9700
9701	<result name="VBOX_E_NOT_SUPPORTED">
9702	TODO
9703	</result>
9704	</desc>
9705	<param name="symlink" type="wstring" dir="in">
9706	<desc>TODO</desc>
9707	</param>
9708	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
9709	<desc>TODO</desc>
9710	</param>
9711	<param name="target" type="wstring" dir="return">
9712	<desc>TODO</desc>
9713	</param>
9714	</method>
9715
9716	<method name="SymlinkRemoveDirectory">
9717	<desc>
9718	TODO
9719
9720	<result name="VBOX_E_NOT_SUPPORTED">
9721	TODO
9722	</result>
9723	</desc>
9724	<param name="path" type="wstring" dir="in">
9725	<desc>TODO</desc>
9726	</param>
9727	</method>
9728
9729	<method name="SymlinkRemoveFile">
9730	<desc>
9731	TODO
9732
9733	<result name="VBOX_E_NOT_SUPPORTED">
9734	TODO
9735	</result>
9736	</desc>
9737	<param name="file" type="wstring" dir="in">
9738	<desc>TODO</desc>
9739	</param>
9740	</method>
9741
9742	</interface>
9743
9744	<interface
9745	name="IProcess" extends="$unknown"
9746	uuid="47b9d1f3-6728-4d29-830b-6a31bf5581d8"
9747	wsmap="suppress"
9748	>
9749	<desc>
9750	TODO
9751	</desc>
9752	<attribute name="pid" type="unsigned long" readonly="yes">
9753	<desc>
9754	TODO
9755	<note>
9756	TODO
9757	</note>
9758	</desc>
9759	</attribute>
9760	<attribute name="status" type="ProcessStatus" readonly="yes">
9761	<desc>
9762	TODO
9763	<note>
9764	TODO
9765	</note>
9766	</desc>
9767	</attribute>
9768	<attribute name="exitCode" type="long" readonly="yes">
9769	<desc>
9770	TODO
9771	<note>
9772	TODO
9773	</note>
9774	</desc>
9775	</attribute>
9776	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
9777	<desc>
9778	TODO
9779	<note>
9780	TODO
9781	</note>
9782	</desc>
9783	</attribute>
9784	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
9785	<desc>
9786	TODO
9787	<note>
9788	TODO
9789	</note>
9790	</desc>
9791	</attribute>
9792	<attribute name="executablePath" type="wstring" readonly="yes">
9793	<desc>
9794	TODO
9795	<note>
9796	TODO
9797	</note>
9798	</desc>
9799	</attribute>
9800
9801	<method name="WaitFor">
9802	<desc>
9803	TODO
9804
9805	<result name="VBOX_E_NOT_SUPPORTED">
9806	TODO
9807	</result>
9808	</desc>
9809	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
9810	<desc>TODO</desc>
9811	</param>
9812	<param name="timeoutMS" type="unsigned long" dir="in">
9813	<desc>TODO</desc>
9814	</param>
9815	<param name="reason" type="ProcessWaitReason" dir="return">
9816	<desc>TODO</desc>
9817	</param>
9818	</method>
9819
9820	<method name="Read">
9821	<desc>
9822	TODO
9823
9824	<result name="VBOX_E_NOT_SUPPORTED">
9825	TODO
9826	</result>
9827	</desc>
9828	<param name="handle" type="unsigned long" dir="in">
9829	<desc>TODO</desc>
9830	</param>
9831	<param name="size" type="unsigned long" dir="in">
9832	<desc>TODO</desc>
9833	</param>
9834	<param name="timeoutMS" type="unsigned long" dir="in">
9835	<desc>TODO</desc>
9836	</param>
9837	<param name="data" type="octet" dir="return" safearray="yes">
9838	<desc>TODO</desc>
9839	</param>
9840	</method>
9841
9842	<method name="Write">
9843	<desc>
9844	TODO
9845
9846	<result name="VBOX_E_NOT_SUPPORTED">
9847	TODO
9848	</result>
9849	</desc>
9850	<param name="handle" type="unsigned long" dir="in">
9851	<desc>TODO</desc>
9852	</param>
9853	<param name="size" type="unsigned long" dir="in">
9854	<desc>TODO</desc>
9855	</param>
9856	<param name="timeoutMS" type="unsigned long" dir="in">
9857	<desc>TODO</desc>
9858	</param>
9859	<param name="written" type="unsigned long" dir="out">
9860	<desc>TODO</desc>
9861	</param>
9862	<param name="data" type="octet" dir="return" safearray="yes">
9863	<desc>TODO</desc>
9864	</param>
9865	</method>
9866
9867	<method name="Terminate">
9868	<desc>
9869	TODO
9870
9871	<result name="VBOX_E_NOT_SUPPORTED">
9872	TODO
9873	</result>
9874	</desc>
9875	</method>
9876	</interface>
9877
9878	<interface
9879	name="IGuestProcess" extends="IProcess"
9880	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
9881	wsmap="managed"
9882	>
9883	<desc>
9884	TODO
9885	</desc>
9886	</interface>
9887
9888	<interface
9889	name="IDirectory" extends="$unknown"
9890	uuid="9659f46a-32f2-40e0-ab27-cc2e23fa5def"
9891	wsmap="suppress"
9892	>
9893	<desc>
9894	TODO
9895	</desc>
9896
9897	<attribute name="directoryName" type="wstring" readonly="yes">
9898	<desc>
9899	Full path of directory.
9900	<note>
9901	TODO
9902	</note>
9903	</desc>
9904	</attribute>
9905
9906	<method name="Read">
9907	<desc>
9908	TODO
9909
9910	<result name="VBOX_E_NOT_SUPPORTED">
9911	TODO
9912	</result>
9913	</desc>
9914	<param name="objInfo" type="IFsObjInfo" dir="return">
9915	<desc>TODO</desc>
9916	</param>
9917	</method>
9918	</interface>
9919
9920	<interface
9921	name="IGuestDirectory" extends="IDirectory"
9922	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
9923	wsmap="managed"
9924	>
9925	<desc>
9926	TODO
9927	</desc>
9928	</interface>
9929
9930	<interface
9931	name="IFile" extends="$unknown"
9932	uuid="df475838-6898-4bd7-bcb5-75f91d85c239"
9933	wsmap="suppress"
9934	>
9935	<desc>
9936	TODO
9937	</desc>
9938
9939	<attribute name="fileName" type="wstring" readonly="yes">
9940	<desc>
9941	TODO
9942	<note>
9943	TODO
9944	</note>
9945	</desc>
9946	</attribute>
9947	<attribute name="initialSize" type="long long" readonly="yes">
9948	<desc>
9949	TODO
9950	<note>
9951	TODO
9952	</note>
9953	</desc>
9954	</attribute>
9955	<attribute name="openMode" type="unsigned long" readonly="yes">
9956	<desc>
9957	TODO
9958	<note>
9959	TODO
9960	</note>
9961	</desc>
9962	</attribute>
9963	<attribute name="offset" type="long long" readonly="yes">
9964	<desc>
9965	TODO
9966	<note>
9967	TODO
9968	</note>
9969	</desc>
9970	</attribute>
9971
9972	<method name="Close">
9973	<desc>
9974	TODO
9975
9976	<result name="VBOX_E_NOT_SUPPORTED">
9977	TODO
9978	</result>
9979	</desc>
9980	</method>
9981
9982	<method name="QueryInfo">
9983	<desc>
9984	TODO
9985
9986	<result name="VBOX_E_NOT_SUPPORTED">
9987	TODO
9988	</result>
9989	</desc>
9990	<param name="objInfo" type="IFsObjInfo" dir="return">
9991	<desc>TODO</desc>
9992	</param>
9993	</method>
9994
9995	<method name="Read">
9996	<desc>
9997	TODO
9998
9999	<result name="VBOX_E_NOT_SUPPORTED">
10000	TODO
10001	</result>
10002	</desc>
10003	<param name="toRead" type="unsigned long" dir="in">
10004	<desc>TODO</desc>
10005	</param>
10006	<param name="read" type="unsigned long" dir="out">
10007	<desc>TODO</desc>
10008	</param>
10009	<param name="data" type="octet" dir="return" safearray="yes">
10010	<desc>TODO</desc>
10011	</param>
10012	</method>
10013
10014	<method name="ReadAt">
10015	<desc>
10016	TODO
10017
10018	<result name="VBOX_E_NOT_SUPPORTED">
10019	TODO
10020	</result>
10021	</desc>
10022	<param name="offset" type="long long" dir="in">
10023	<desc>TODO</desc>
10024	</param>
10025	<param name="toRead" type="unsigned long" dir="in">
10026	<desc>TODO</desc>
10027	</param>
10028	<param name="read" type="unsigned long" dir="out">
10029	<desc>TODO</desc>
10030	</param>
10031	<param name="data" type="octet" dir="return" safearray="yes">
10032	<desc>TODO</desc>
10033	</param>
10034	</method>
10035
10036	<method name="Seek">
10037	<desc>
10038	TODO
10039
10040	<result name="VBOX_E_NOT_SUPPORTED">
10041	TODO
10042	</result>
10043	</desc>
10044	<param name="offset" type="long long" dir="in">
10045	<desc>TODO</desc>
10046	</param>
10047	<param name="whence" type="FileSeekType" dir="in">
10048	<desc>TODO</desc>
10049	</param>
10050	</method>
10051
10052	<method name="SetACL">
10053	<desc>
10054	TODO
10055
10056	<result name="VBOX_E_NOT_SUPPORTED">
10057	TODO
10058	</result>
10059	</desc>
10060	<param name="acl" type="wstring" dir="in">
10061	<desc>TODO</desc>
10062	</param>
10063	</method>
10064
10065	<method name="Write">
10066	<desc>
10067	TODO
10068
10069	<result name="VBOX_E_NOT_SUPPORTED">
10070	TODO
10071	</result>
10072	</desc>
10073	<param name="data" type="octet" dir="in" safearray="yes">
10074	<desc>TODO</desc>
10075	</param>
10076	<param name="written" type="unsigned long" dir="return">
10077	<desc>TODO</desc>
10078	</param>
10079	</method>
10080
10081	<method name="WriteAt">
10082	<desc>
10083	TODO
10084
10085	<result name="VBOX_E_NOT_SUPPORTED">
10086	TODO
10087	</result>
10088	</desc>
10089	<param name="offset" type="long long" dir="in">
10090	<desc>TODO</desc>
10091	</param>
10092	<param name="data" type="octet" dir="in" safearray="yes">
10093	<desc>TODO</desc>
10094	</param>
10095	<param name="written" type="unsigned long" dir="return">
10096	<desc>TODO</desc>
10097	</param>
10098	</method>
10099
10100	</interface>
10101
10102	<interface
10103	name="IGuestFile" extends="IFile"
10104	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10105	wsmap="managed"
10106	>
10107	<desc>
10108	TODO
10109	</desc>
10110	</interface>
10111
10112	<interface
10113	name="IFsObjInfo" extends="$unknown"
10114	uuid="0b53ef38-2462-4796-a680-7f6f0dd3680a"
10115	wsmap="suppress"
10116	>
10117	<desc>
10118	TODO
10119	</desc>
10120
10121	<attribute name="accessTime" type="long long" readonly="yes">
10122	<desc>
10123	TODO
10124	<note>
10125	TODO
10126	</note>
10127	</desc>
10128	</attribute>
10129	<attribute name="allocatedSize" type="long long" readonly="yes">
10130	<desc>
10131	TODO
10132	<note>
10133	TODO
10134	</note>
10135	</desc>
10136	</attribute>
10137	<attribute name="birthTime" type="long long" readonly="yes">
10138	<desc>
10139	TODO
10140	<note>
10141	TODO
10142	</note>
10143	</desc>
10144	</attribute>
10145	<attribute name="changeTime" type="long long" readonly="yes">
10146	<desc>
10147	TODO
10148	<note>
10149	TODO
10150	</note>
10151	</desc>
10152	</attribute>
10153	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10154	<desc>
10155	TODO
10156	<note>
10157	TODO
10158	</note>
10159	</desc>
10160	</attribute>
10161	<attribute name="fileAtttributes" type="wstring" readonly="yes">
10162	<desc>
10163	TODO
10164	<note>
10165	TODO
10166	</note>
10167	</desc>
10168	</attribute>
10169	<attribute name="generationId" type="unsigned long" readonly="yes">
10170	<desc>
10171	TODO
10172	<note>
10173	TODO
10174	</note>
10175	</desc>
10176	</attribute>
10177	<attribute name="gid" type="unsigned long" readonly="yes">
10178	<desc>
10179	TODO
10180	<note>
10181	TODO
10182	</note>
10183	</desc>
10184	</attribute>
10185	<attribute name="groupName" type="wstring" readonly="yes">
10186	<desc>
10187	TODO
10188	<note>
10189	TODO
10190	</note>
10191	</desc>
10192	</attribute>
10193	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10194	<desc>
10195	TODO
10196	<note>
10197	TODO
10198	</note>
10199	</desc>
10200	</attribute>
10201	<attribute name="modificationTime" type="long long" readonly="yes">
10202	<desc>
10203	TODO
10204	<note>
10205	TODO
10206	</note>
10207	</desc>
10208	</attribute>
10209	<attribute name="name" type="wstring" readonly="yes">
10210	<desc>
10211	TODO
10212	<note>
10213	TODO
10214	</note>
10215	</desc>
10216	</attribute>
10217	<attribute name="nodeId" type="long long" readonly="yes">
10218	<desc>
10219	TODO
10220	<note>
10221	TODO
10222	</note>
10223	</desc>
10224	</attribute>
10225	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10226	<desc>
10227	TODO
10228	<note>
10229	TODO
10230	</note>
10231	</desc>
10232	</attribute>
10233	<attribute name="objectSize" type="long long" readonly="yes">
10234	<desc>
10235	TODO
10236	<note>
10237	TODO
10238	</note>
10239	</desc>
10240	</attribute>
10241	<attribute name="type" type="FsObjType" readonly="yes">
10242	<desc>
10243	TODO
10244	<note>
10245	TODO
10246	</note>
10247	</desc>
10248	</attribute>
10249	<attribute name="uid" type="unsigned long" readonly="yes">
10250	<desc>
10251	TODO
10252	<note>
10253	TODO
10254	</note>
10255	</desc>
10256	</attribute>
10257	<attribute name="userFlags" type="unsigned long" readonly="yes">
10258	<desc>
10259	TODO
10260	<note>
10261	TODO
10262	</note>
10263	</desc>
10264	</attribute>
10265	<attribute name="userName" type="wstring" readonly="yes">
10266	<desc>
10267	TODO
10268	<note>
10269	TODO
10270	</note>
10271	</desc>
10272	</attribute>
10273
10274	</interface>
10275
10276	<interface
10277	name="IGuestFsObjInfo" extends="IFsObjInfo"
10278	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10279	wsmap="managed"
10280	>
10281	<desc>
10282	TODO
10283	</desc>
10284	</interface>
10285
10286	<interface
10287	name="IGuest" extends="$unknown"
10288	uuid="a115744a-0e0b-4193-b40c-40e0d66d0f8d"
10289	wsmap="managed"
10290	>
10291	<desc>
10292	The IGuest interface represents information about the operating system
10293	running inside the virtual machine. Used in
10294	<link to="IConsole::guest"/>.
10295
10296	IGuest provides information about the guest operating system, whether
10297	Guest Additions are installed and other OS-specific virtual machine
10298	properties.
10299	</desc>
10300
10301	<attribute name="OSTypeId" type="wstring" readonly="yes">
10302	<desc>
10303	Identifier of the Guest OS type as reported by the Guest
10304	Additions.
10305	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10306	an IGuestOSType object representing details about the given
10307	Guest OS type.
10308	<note>
10309	If Guest Additions are not installed, this value will be
10310	the same as <link to="IMachine::OSTypeId"/>.
10311	</note>
10312	</desc>
10313	</attribute>
10314
10315	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10316	<desc>
10317	Current run level of the Guest Additions.
10318	</desc>
10319	</attribute>
10320
10321	<attribute name="additionsVersion" type="wstring" readonly="yes">
10322	<desc>
10323	Version of the Guest Additions in the same format as
10324	<link to="IVirtualBox::version"/>.
10325	</desc>
10326	</attribute>
10327
10328	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
10329	<desc>
10330	The internal build revision number of the additions.
10331
10332	See also <link to="IVirtualBox::revision"/>.
10333	</desc>
10334	</attribute>
10335
10336	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10337	<desc>
10338	Array of current known facilities. Only returns facilities where a status is known,
10339	e.g. facilities with an unknown status will not be returned.
10340	</desc>
10341	</attribute>
10342
10343	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10344	<desc>TODO</desc>
10345	</attribute>
10346
10347	<attribute name="memoryBalloonSize" type="unsigned long">
10348	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
10349	</attribute>
10350
10351	<attribute name="statisticsUpdateInterval" type="unsigned long">
10352	<desc>Interval to update guest statistics in seconds.</desc>
10353	</attribute>
10354
10355	<method name="internalGetStatistics">
10356	<desc>
10357	Internal method; do not use as it might change at any time.
10358	</desc>
10359	<param name="cpuUser" type="unsigned long" dir="out">
10360	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10361	</param>
10362	<param name="cpuKernel" type="unsigned long" dir="out">
10363	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10364	</param>
10365	<param name="cpuIdle" type="unsigned long" dir="out">
10366	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
10367	</param>
10368	<param name="memTotal" type="unsigned long" dir="out">
10369	<desc>Total amount of physical guest RAM.</desc>
10370	</param>
10371	<param name="memFree" type="unsigned long" dir="out">
10372	<desc>Free amount of physical guest RAM.</desc>
10373	</param>
10374	<param name="memBalloon" type="unsigned long" dir="out">
10375	<desc>Amount of ballooned physical guest RAM.</desc>
10376	</param>
10377	<param name="memShared" type="unsigned long" dir="out">
10378	<desc>Amount of shared physical guest RAM.</desc>
10379	</param>
10380	<param name="memCache" type="unsigned long" dir="out">
10381	<desc>Total amount of guest (disk) cache memory.</desc>
10382	</param>
10383	<param name="pagedTotal" type="unsigned long" dir="out">
10384	<desc>Total amount of space in the page file.</desc>
10385	</param>
10386	<param name="memAllocTotal" type="unsigned long" dir="out">
10387	<desc>Total amount of memory allocated by the hypervisor.</desc>
10388	</param>
10389	<param name="memFreeTotal" type="unsigned long" dir="out">
10390	<desc>Total amount of free memory available in the hypervisor.</desc>
10391	</param>
10392	<param name="memBalloonTotal" type="unsigned long" dir="out">
10393	<desc>Total amount of memory ballooned by the hypervisor.</desc>
10394	</param>
10395	<param name="memSharedTotal" type="unsigned long" dir="out">
10396	<desc>Total amount of shared memory in the hypervisor.</desc>
10397	</param>
10398	</method>
10399
10400	<method name="getFacilityStatus">
10401	<desc>
10402	Get the current status of a Guest Additions facility.
10403	</desc>
10404	<param name="facility" type="AdditionsFacilityType" dir="in">
10405	<desc>Facility to check status for.</desc>
10406	</param>
10407	<param name="timestamp" type="long long" dir="out">
10408	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
10409	</param>
10410	<param name="status" type="AdditionsFacilityStatus" dir="return">
10411	<desc>The current (latest) facility status.</desc>
10412	</param>
10413	</method>
10414
10415	<method name="getAdditionsStatus">
10416	<desc>
10417	Retrieve the current status of a certain Guest Additions run level.
10418
10419	<result name="VBOX_E_NOT_SUPPORTED">
10420	Wrong status level specified.
10421	</result>
10422
10423	</desc>
10424	<param name="level" type="AdditionsRunLevelType" dir="in">
10425	<desc>Status level to check</desc>
10426	</param>
10427	<param name="active" type="boolean" dir="return">
10428	<desc>Flag whether the status level has been reached or not</desc>
10429	</param>
10430	</method>
10431
10432	<method name="setCredentials">
10433	<desc>
10434	Store login credentials that can be queried by guest operating
10435	systems with Additions installed. The credentials are transient
10436	to the session and the guest may also choose to erase them. Note
10437	that the caller cannot determine whether the guest operating system
10438	has queried or made use of the credentials.
10439
10440	<result name="VBOX_E_VM_ERROR">
10441	VMM device is not available.
10442	</result>
10443
10444	</desc>
10445	<param name="userName" type="wstring" dir="in">
10446	<desc>User name string, can be empty</desc>
10447	</param>
10448	<param name="password" type="wstring" dir="in">
10449	<desc>Password string, can be empty</desc>
10450	</param>
10451	<param name="domain" type="wstring" dir="in">
10452	<desc>Domain name (guest logon scheme specific), can be empty</desc>
10453	</param>
10454	<param name="allowInteractiveLogon" type="boolean" dir="in">
10455	<desc>
10456	Flag whether the guest should alternatively allow the user to
10457	interactively specify different credentials. This flag might
10458	not be supported by all versions of the Additions.
10459	</desc>
10460	</param>
10461	</method>
10462
10463	<method name="dragHGEnter">
10464	<desc>
10465	Informs the guest about a Drag and Drop enter event.
10466
10467	This is used in Host - Guest direction.
10468
10469	<result name="VBOX_E_VM_ERROR">
10470	VMM device is not available.
10471	</result>
10472
10473	</desc>
10474	<param name="screenId" type="unsigned long" dir="in">
10475	<desc>The screen id where the Drag and Drop event occured.</desc>
10476	</param>
10477	<param name="y" type="unsigned long" dir="in">
10478	<desc>y-position of the event.</desc>
10479	</param>
10480	<param name="x" type="unsigned long" dir="in">
10481	<desc>x-position of the event.</desc>
10482	</param>
10483	<param name="defaultAction" type="DragAndDropAction" dir="in">
10484	<desc>The default action to use.</desc>
10485	</param>
10486	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10487	<desc>The actions which are allowed.</desc>
10488	</param>
10489	<param name="formats" type="wstring" dir="in" safearray="yes">
10490	<desc>The supported mime types.</desc>
10491	</param>
10492	<param name="resultAction" type="DragAndDropAction" dir="return">
10493	<desc>The resulting action of this event.</desc>
10494	</param>
10495	</method>
10496
10497	<method name="dragHGMove">
10498	<desc>
10499	Informs the guest about a Drag and Drop move event.
10500
10501	This is used in Host - Guest direction.
10502
10503	<result name="VBOX_E_VM_ERROR">
10504	VMM device is not available.
10505	</result>
10506
10507	</desc>
10508	<param name="screenId" type="unsigned long" dir="in">
10509	<desc>The screen id where the Drag and Drop event occured.</desc>
10510	</param>
10511	<param name="x" type="unsigned long" dir="in">
10512	<desc>x-position of the event.</desc>
10513	</param>
10514	<param name="y" type="unsigned long" dir="in">
10515	<desc>y-position of the event.</desc>
10516	</param>
10517	<param name="defaultAction" type="DragAndDropAction" dir="in">
10518	<desc>The default action to use.</desc>
10519	</param>
10520	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10521	<desc>The actions which are allowed.</desc>
10522	</param>
10523	<param name="formats" type="wstring" dir="in" safearray="yes">
10524	<desc>The supported mime types.</desc>
10525	</param>
10526	<param name="resultAction" type="DragAndDropAction" dir="return">
10527	<desc>The resulting action of this event.</desc>
10528	</param>
10529	</method>
10530
10531	<method name="dragHGLeave">
10532	<desc>
10533	Informs the guest about a Drag and Drop leave event.
10534
10535	This is used in Host - Guest direction.
10536
10537	<result name="VBOX_E_VM_ERROR">
10538	VMM device is not available.
10539	</result>
10540
10541	</desc>
10542	<param name="screenId" type="unsigned long" dir="in">
10543	<desc>The screen id where the Drag and Drop event occured.</desc>
10544	</param>
10545	</method>
10546
10547	<method name="dragHGDrop">
10548	<desc>
10549	Informs the guest about a drop event.
10550
10551	This is used in Host - Guest direction.
10552
10553	<result name="VBOX_E_VM_ERROR">
10554	VMM device is not available.
10555	</result>
10556
10557	</desc>
10558	<param name="screenId" type="unsigned long" dir="in">
10559	<desc>The screen id where the Drag and Drop event occured.</desc>
10560	</param>
10561	<param name="x" type="unsigned long" dir="in">
10562	<desc>x-position of the event.</desc>
10563	</param>
10564	<param name="y" type="unsigned long" dir="in">
10565	<desc>y-position of the event.</desc>
10566	</param>
10567	<param name="defaultAction" type="DragAndDropAction" dir="in">
10568	<desc>The default action to use.</desc>
10569	</param>
10570	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10571	<desc>The actions which are allowed.</desc>
10572	</param>
10573	<param name="formats" type="wstring" dir="in" safearray="yes">
10574	<desc>The supported mime types.</desc>
10575	</param>
10576	<param name="format" type="wstring" dir="out">
10577	<desc>The resulting format of this event.</desc>
10578	</param>
10579	<param name="resultAction" type="DragAndDropAction" dir="return">
10580	<desc>The resulting action of this event.</desc>
10581	</param>
10582	</method>
10583
10584	<method name="dragHGPutData">
10585	<desc>
10586	Informs the guest about a drop data event.
10587
10588	This is used in Host - Guest direction.
10589
10590	<result name="VBOX_E_VM_ERROR">
10591	VMM device is not available.
10592	</result>
10593
10594	</desc>
10595	<param name="screenId" type="unsigned long" dir="in">
10596	<desc>The screen id where the Drag and Drop event occured.</desc>
10597	</param>
10598	<param name="format" type="wstring" dir="in">
10599	<desc>The mime type the data is in.</desc>
10600	</param>
10601	<param name="data" type="octet" dir="in" safearray="yes">
10602	<desc>The actual data.</desc>
10603	</param>
10604	<param name="progress" type="IProgress" dir="return">
10605	<desc>Progress object to track the operation completion.</desc>
10606	</param>
10607	</method>
10608
10609	<method name="dragGHPending">
10610	<desc>
10611	Ask the guest if there is any Drag and Drop operation pending in the guest.
10612
10613	If no Drag and Drop operation is pending currently, Ignore is returned.
10614
10615	This is used in Guest - Host direction.
10616
10617	<result name="VBOX_E_VM_ERROR">
10618	VMM device is not available.
10619	</result>
10620
10621	</desc>
10622	<param name="screenId" type="unsigned long" dir="in">
10623	<desc>The screen id where the Drag and Drop event occured.</desc>
10624	</param>
10625	<param name="format" type="wstring" dir="out" safearray="yes">
10626	<desc>On return the supported mime types.</desc>
10627	</param>
10628	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
10629	<desc>On return the actions which are allowed.</desc>
10630	</param>
10631	<param name="defaultAction" type="DragAndDropAction" dir="return">
10632	<desc>On return the default action to use.</desc>
10633	</param>
10634	</method>
10635
10636	<method name="dragGHDropped">
10637	<desc>
10638	Informs the guest that a drop event occured for a pending Drag and Drop event.
10639
10640	This is used in Guest - Host direction.
10641
10642	<result name="VBOX_E_VM_ERROR">
10643	VMM device is not available.
10644	</result>
10645
10646	</desc>
10647
10648	<param name="format" type="wstring" dir="in">
10649	<desc>The mime type the data must be in.</desc>
10650	</param>
10651	<param name="action" type="DragAndDropAction" dir="in">
10652	<desc>The action to use.</desc>
10653	</param>
10654	<param name="progress" type="IProgress" dir="return">
10655	<desc>Progress object to track the operation completion.</desc>
10656	</param>
10657	</method>
10658
10659	<method name="dragGHGetData">
10660	<desc>
10661	Fetch the data of a previously Drag and Drop event from the guest.
10662
10663	This is used in Guest - Host direction.
10664
10665	<result name="VBOX_E_VM_ERROR">
10666	VMM device is not available.
10667	</result>
10668
10669	</desc>
10670
10671	<param name="data" type="octet" safearray="yes" dir="return">
10672	<desc>The actual data.</desc>
10673	</param>
10674	</method>
10675
10676	<method name="openSession">
10677	<desc>
10678	TODO
10679	</desc>
10680	<param name="user" type="wstring" dir="in">
10681	<desc>
10682	TODO
10683	</desc>
10684	</param>
10685	<param name="password" type="wstring" dir="in">
10686	<desc>
10687	TODO
10688	</desc>
10689	</param>
10690	<param name="domain" type="wstring" dir="in">
10691	<desc>
10692	TODO
10693	</desc>
10694	</param>
10695	<param name="sessionName" type="wstring" dir="in">
10696	<desc>
10697	TODO
10698	</desc>
10699	</param>
10700	<param name="guestSession" type="IGuestSession" dir="return">
10701	<desc>
10702	TODO
10703	</desc>
10704	</param>
10705	</method>
10706
10707	<method name="executeProcess">
10708	<desc>
10709	Executes an existing program inside the guest VM.
10710
10711	<note>
10712	Starting at VirtualBox 4.1.8 guest process execution by default is limited
10713	to serve up to 25 guest processes at a time. If all 25 guest processes
10714	are still active and running, starting a new guest process will result in an
10715	appropriate error message.
10716
10717	If ExecuteProcessFlag_WaitForStdOut and/or respectively
10718	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
10719	set, the guest process will not exit until all data from the specified
10720	stream(s) is/are read out.
10721
10722	To raise or lower the guest process execution limit, either the guest property
10723	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10724	command line by specifying "--control-procs-max-kept" needs to be modified.
10725	A restart of the guest OS is required afterwards. To serve unlimited guest
10726	processes, a value of "0" needs to be set (not recommended).
10727	</note>
10728
10729	<result name="VBOX_E_IPRT_ERROR">
10730	Could not execute process.
10731	</result>
10732
10733	</desc>
10734	<param name="execName" type="wstring" dir="in">
10735	<desc>
10736	Full path name of the command to execute on the guest; the
10737	commands has to exists in the guest VM in order to be executed.
10738	</desc>
10739	</param>
10740	<param name="flags" type="unsigned long" dir="in">
10741	<desc>
10742	<link to="ExecuteProcessFlag"/> flags.
10743	</desc>
10744	</param>
10745	<param name="arguments" type="wstring" safearray="yes" dir="in">
10746	<desc>
10747	Array of arguments passed to the execution command.
10748	</desc>
10749	</param>
10750	<param name="environment" type="wstring" safearray="yes" dir="in">
10751	<desc>
10752	Environment variables that can be set while the command is being
10753	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10754	variable just set its name ("NAME") without a value.
10755	</desc>
10756	</param>
10757	<param name="userName" type="wstring" dir="in">
10758	<desc>
10759	User name under which the command will be executed; has to exist
10760	and have the appropriate rights to execute programs in the VM.
10761	</desc>
10762	</param>
10763	<param name="password" type="wstring" dir="in">
10764	<desc>
10765	Password of the user account specified.
10766	</desc>
10767	</param>
10768	<param name="timeoutMS" type="unsigned long" dir="in">
10769	<desc>
10770	The maximum timeout value (in msec) to wait for finished program
10771	execution. Pass 0 for an infinite timeout.
10772	</desc>
10773	</param>
10774	<param name="pid" type="unsigned long" dir="out">
10775	<desc>
10776	The PID (process ID) of the started command for later reference.
10777	</desc>
10778	</param>
10779	<param name="progress" type="IProgress" dir="return">
10780	<desc>Progress object to track the operation completion.</desc>
10781	</param>
10782	</method>
10783
10784	<method name="getProcessOutput">
10785	<desc>
10786	Retrieves output of a formerly started and running guest process.
10787
10788	<note>
10789	Starting with VirtualBox 4.1.8 this only will return output data
10790	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
10791	and/or respectively ExecuteProcessFlag_WaitForStdErr of
10792	<link to="ExecuteProcessFlag"/> is set in the
10793	former <link to="#executeProcess"/> call for this guest process.
10794	</note>
10795
10796	<result name="VBOX_E_IPRT_ERROR">
10797	Could not retrieve output.
10798	</result>
10799
10800	</desc>
10801	<param name="pid" type="unsigned long" dir="in">
10802	<desc>
10803	Process id returned by earlier <link to="#executeProcess"/> call.
10804	</desc>
10805	</param>
10806	<param name="flags" type="unsigned long" dir="in">
10807	<desc>
10808	<link to="ProcessOutputFlag"/> flags.
10809	</desc>
10810	</param>
10811	<param name="timeoutMS" type="unsigned long" dir="in">
10812	<desc>
10813	The maximum timeout value (in msec) to wait for output
10814	data. Pass 0 for an infinite timeout.
10815	</desc>
10816	</param>
10817	<param name="size" type="long long" dir="in">
10818	<desc>
10819	Size in bytes to read in the buffer.
10820	</desc>
10821	</param>
10822	<param name="data" type="octet" safearray="yes" dir="return">
10823	<desc>
10824	Buffer for retrieving the actual output. A data size of 0 means end of file
10825	if the requested size was not 0. This is the unprocessed
10826	output data, i.e. the line ending style depends on the platform of
10827	the system the server is running on.
10828	</desc>
10829	</param>
10830	</method>
10831
10832	<method name="getProcessStatus">
10833	<desc>
10834	Retrieves status, exit code and the exit reason of a formerly started
10835	guest process. If a guest process exited or got terminated this function
10836	returns its final status and removes this process from the list of
10837	known guest processes for further retrieval.
10838
10839	<result name="VBOX_E_IPRT_ERROR">
10840	Process with specified PID was not found.
10841	</result>
10842
10843	</desc>
10844	<param name="pid" type="unsigned long" dir="in">
10845	<desc>
10846	Process id returned by earlier <link to="#executeProcess"/> call.
10847	</desc>
10848	</param>
10849	<param name="exitcode" type="unsigned long" dir="out">
10850	<desc>
10851	The exit code (if available).
10852	</desc>
10853	</param>
10854	<param name="flags" type="unsigned long" dir="out">
10855	<desc>
10856	Additional flags of process status. Not used at the moment and
10857	must be set to 0.
10858	</desc>
10859	</param>
10860	<param name="reason" type="ExecuteProcessStatus" dir="return">
10861	<desc>
10862	The current process status.
10863	</desc>
10864	</param>
10865	</method>
10866
10867	<method name="copyFromGuest">
10868	<desc>
10869	Copies files/directories from guest to the host.
10870
10871	<result name="VBOX_E_IPRT_ERROR">
10872	Error while copying.
10873	</result>
10874
10875	</desc>
10876	<param name="source" type="wstring" dir="in">
10877	<desc>
10878	Source file on the guest to copy.
10879	</desc>
10880	</param>
10881	<param name="dest" type="wstring" dir="in">
10882	<desc>
10883	Destination path on the host.
10884	</desc>
10885	</param>
10886	<param name="userName" type="wstring" dir="in">
10887	<desc>
10888	User name under which the copy command will be executed; the
10889	user has to exist and have the appropriate rights to read from
10890	the source path.
10891	</desc>
10892	</param>
10893	<param name="password" type="wstring" dir="in">
10894	<desc>
10895	Password of the user account specified.
10896	</desc>
10897	</param>
10898	<param name="flags" type="unsigned long" dir="in">
10899	<desc>
10900	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
10901	</desc>
10902	</param>
10903	<param name="progress" type="IProgress" dir="return">
10904	<desc>Progress object to track the operation completion.</desc>
10905	</param>
10906	</method>
10907
10908	<method name="copyToGuest">
10909	<desc>
10910	Copies files/directories from host to the guest.
10911
10912	<result name="VBOX_E_IPRT_ERROR">
10913	Error while copying.
10914	</result>
10915
10916	</desc>
10917	<param name="source" type="wstring" dir="in">
10918	<desc>
10919	Source file on the host to copy.
10920	</desc>
10921	</param>
10922	<param name="dest" type="wstring" dir="in">
10923	<desc>
10924	Destination path on the guest.
10925	</desc>
10926	</param>
10927	<param name="userName" type="wstring" dir="in">
10928	<desc>
10929	User name under which the copy command will be executed; the
10930	user has to exist and have the appropriate rights to write to
10931	the destination path.
10932	</desc>
10933	</param>
10934	<param name="password" type="wstring" dir="in">
10935	<desc>
10936	Password of the user account specified.
10937	</desc>
10938	</param>
10939	<param name="flags" type="unsigned long" dir="in">
10940	<desc>
10941	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
10942	</desc>
10943	</param>
10944	<param name="progress" type="IProgress" dir="return">
10945	<desc>Progress object to track the operation completion.</desc>
10946	</param>
10947	</method>
10948
10949	<method name="directoryClose">
10950	<desc>
10951	Closes a formerly opened guest directory.
10952
10953	<result name="VBOX_E_IPRT_ERROR">
10954	Error while closing directory.
10955	</result>
10956
10957	</desc>
10958	<param name="handle" type="unsigned long" dir="in">
10959	<desc>
10960	Handle of opened directory to close.
10961	</desc>
10962	</param>
10963	</method>
10964
10965	<method name="directoryCreate">
10966	<desc>
10967	Creates a directory on the guest.
10968
10969	<result name="VBOX_E_IPRT_ERROR">
10970	Error while creating directory.
10971	</result>
10972
10973	</desc>
10974	<param name="directory" type="wstring" dir="in">
10975	<desc>
10976	Directory to create.
10977	</desc>
10978	</param>
10979	<param name="userName" type="wstring" dir="in">
10980	<desc>
10981	User name under which the directory creation will be executed; the
10982	user has to exist and have the appropriate rights to create the
10983	desired directory.
10984	</desc>
10985	</param>
10986	<param name="password" type="wstring" dir="in">
10987	<desc>
10988	Password of the user account specified.
10989	</desc>
10990	</param>
10991	<param name="mode" type="unsigned long" dir="in">
10992	<desc>
10993	File mode.
10994	</desc>
10995	</param>
10996	<param name="flags" type="unsigned long" dir="in">
10997	<desc>
10998	<link to="DirectoryCreateFlag"/> flags.
10999	</desc>
11000	</param>
11001	</method>
11002
11003	<method name="directoryOpen">
11004	<desc>
11005	Opens a directory on the guest.
11006
11007	<result name="VBOX_E_IPRT_ERROR">
11008	Error while opening / reading directory.
11009	</result>
11010
11011	</desc>
11012	<param name="directory" type="wstring" dir="in">
11013	<desc>
11014	Directory to read.
11015	</desc>
11016	</param>
11017	<param name="filter" type="wstring" dir="in">
11018	<desc>
11019	Directory filter (DOS style wildcards). Set to empty
11020	string if no filter required.
11021	</desc>
11022	</param>
11023	<param name="flags" type="unsigned long" dir="in">
11024	<desc>
11025	<link to="DirectoryOpenFlag"/> flags.
11026	</desc>
11027	</param>
11028	<param name="userName" type="wstring" dir="in">
11029	<desc>
11030	User name under which the directory reading will be performed; the
11031	user has to exist and have the appropriate rights to access / read the
11032	desired directory.
11033	</desc>
11034	</param>
11035	<param name="password" type="wstring" dir="in">
11036	<desc>
11037	Password of the user account specified.
11038	</desc>
11039	</param>
11040	<param name="handle" type="unsigned long" dir="return">
11041	<desc>
11042	Handle of opened directory returned by openDirectory.
11043	</desc>
11044	</param>
11045	</method>
11046
11047	<method name="directoryRead">
11048	<desc>
11049	Reads the next directory entry of an opened guest directory.
11050
11051	<result name="E_ABORT">
11052	When the end of the directory has been reached.
11053	</result>
11054
11055	<result name="VBOX_E_IPRT_ERROR">
11056	Error while opening / reading directory.
11057	</result>
11058
11059	</desc>
11060	<param name="handle" type="unsigned long" dir="in">
11061	<desc>
11062	Handle of opened directory returned by openDirectory.
11063	</desc>
11064	</param>
11065	<param name="entry" type="IGuestDirEntry" dir="return">
11066	<desc>
11067	Information about next directory entry on success.
11068	</desc>
11069	</param>
11070	</method>
11071
11072	<method name="fileExists">
11073	<desc>
11074	Checks if the specified file name exists and is a regular file.
11075
11076	If the file name ends with a slash or backslash, the function assumes
11077	it's a directory and will check if the specified directory exists and
11078	is a regular directory.
11079
11080	<result name="VBOX_E_IPRT_ERROR">
11081	Error while looking up information.
11082	</result>
11083
11084	</desc>
11085	<param name="file" type="wstring" dir="in">
11086	<desc>
11087	Full path of file to check.
11088	</desc>
11089	</param>
11090	<param name="userName" type="wstring" dir="in">
11091	<desc>
11092	User name under which the lookup will be performed; the
11093	user has to exist and have the appropriate rights to access / read the
11094	desired directory.
11095	</desc>
11096	</param>
11097	<param name="password" type="wstring" dir="in">
11098	<desc>
11099	Password of the user account specified.
11100	</desc>
11101	</param>
11102	<param name="exists" type="boolean" dir="return">
11103	<desc>
11104	True if it's a regular file, false if it isn't (or doesn't exist).
11105	</desc>
11106	</param>
11107	</method>
11108
11109	<method name="fileQuerySize">
11110	<desc>
11111	Queries the size of a file, given the path to it.
11112
11113	<result name="VBOX_E_IPRT_ERROR">
11114	Error while looking up information.
11115	</result>
11116
11117	</desc>
11118	<param name="file" type="wstring" dir="in">
11119	<desc>
11120	Full path of file to query file size for.
11121	</desc>
11122	</param>
11123	<param name="userName" type="wstring" dir="in">
11124	<desc>
11125	User name under which the lookup will be performed; the
11126	user has to exist and have the appropriate rights to access / read the
11127	desired directory.
11128	</desc>
11129	</param>
11130	<param name="password" type="wstring" dir="in">
11131	<desc>
11132	Password of the user account specified.
11133	</desc>
11134	</param>
11135	<param name="size" type="long long" dir="return">
11136	<desc>
11137	Size (in bytes) of file specified.
11138	</desc>
11139	</param>
11140	</method>
11141
11142	<method name="setProcessInput">
11143	<desc>
11144	Sends input into a formerly started process.
11145
11146	<result name="VBOX_E_IPRT_ERROR">
11147	Could not send input.
11148	</result>
11149
11150	</desc>
11151	<param name="pid" type="unsigned long" dir="in">
11152	<desc>
11153	Process id returned by earlier <link to="#executeProcess"/> call.
11154	</desc>
11155	</param>
11156	<param name="flags" type="unsigned long" dir="in">
11157	<desc>
11158	<link to="ProcessInputFlag"/> flags.
11159	</desc>
11160	</param>
11161	<param name="timeoutMS" type="unsigned long" dir="in">
11162	<desc>
11163	The maximum timeout value (in msec) to wait for getting the
11164	data transfered to the guest. Pass 0 for an infinite timeout.
11165	</desc>
11166	</param>
11167	<param name="data" type="octet" dir="in" safearray="yes">
11168	<desc>
11169	Buffer of input data to send to the started process to.
11170	</desc>
11171	</param>
11172	<param name="written" type="unsigned long" dir="return">
11173	<desc>
11174	Number of bytes written.
11175	</desc>
11176	</param>
11177	</method>
11178
11179	<method name="updateGuestAdditions">
11180	<desc>
11181	Updates already installed Guest Additions in a VM
11182	(Windows guests only).
11183
11184	<result name="VBOX_E_IPRT_ERROR">
11185	Error while updating.
11186	</result>
11187
11188	</desc>
11189	<param name="source" type="wstring" dir="in">
11190	<desc>
11191	Path to the Guest Additions .ISO file to use for the upate.
11192	</desc>
11193	</param>
11194	<param name="flags" type="unsigned long" dir="in">
11195	<desc>
11196	<link to="AdditionsUpdateFlag"/> flags.
11197	</desc>
11198	</param>
11199	<param name="progress" type="IProgress" dir="return">
11200	<desc>Progress object to track the operation completion.</desc>
11201	</param>
11202	</method>
11203
11204	</interface>
11205
11206
11207	<!--
11208	// IProgress
11209	/////////////////////////////////////////////////////////////////////////
11210	-->
11211
11212	<interface
11213	name="IProgress" extends="$unknown"
11214	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11215	wsmap="managed"
11216	>
11217	<desc>
11218	The IProgress interface is used to track and control
11219	asynchronous tasks within VirtualBox.
11220
11221	An instance of this is returned every time VirtualBox starts
11222	an asynchronous task (in other words, a separate thread) which
11223	continues to run after a method call returns. For example,
11224	<link to="IConsole::saveState" />, which saves the state of
11225	a running virtual machine, can take a long time to complete.
11226	To be able to display a progress bar, a user interface such as
11227	the VirtualBox graphical user interface can use the IProgress
11228	object returned by that method.
11229
11230	Note that IProgress is a "read-only" interface in the sense
11231	that only the VirtualBox internals behind the Main API can
11232	create and manipulate progress objects, whereas client code
11233	can only use the IProgress object to monitor a task's
11234	progress and, if <link to="#cancelable" /> is @c true,
11235	cancel the task by calling <link to="#cancel" />.
11236
11237	A task represented by IProgress consists of either one or
11238	several sub-operations that run sequentially, one by one (see
11239	<link to="#operation" /> and <link to="#operationCount" />).
11240	Every operation is identified by a number (starting from 0)
11241	and has a separate description.
11242
11243	You can find the individual percentage of completion of the current
11244	operation in <link to="#operationPercent" /> and the
11245	percentage of completion of the task as a whole
11246	in <link to="#percent" />.
11247
11248	Similarly, you can wait for the completion of a particular
11249	operation via <link to="#waitForOperationCompletion" /> or
11250	for the completion of the whole task via
11251	<link to="#waitForCompletion" />.
11252	</desc>
11253
11254	<attribute name="id" type="uuid" mod="string" readonly="yes">
11255	<desc>ID of the task.</desc>
11256	</attribute>
11257
11258	<attribute name="description" type="wstring" readonly="yes">
11259	<desc>Description of the task.</desc>
11260	</attribute>
11261
11262	<attribute name="initiator" type="$unknown" readonly="yes">
11263	<desc>Initiator of the task.</desc>
11264	</attribute>
11265
11266	<attribute name="cancelable" type="boolean" readonly="yes">
11267	<desc>Whether the task can be interrupted.</desc>
11268	</attribute>
11269
11270	<attribute name="percent" type="unsigned long" readonly="yes">
11271	<desc>
11272	Current progress value of the task as a whole, in percent.
11273	This value depends on how many operations are already complete.
11274	Returns 100 if <link to="#completed" /> is @c true.
11275	</desc>
11276	</attribute>
11277
11278	<attribute name="timeRemaining" type="long" readonly="yes">
11279	<desc>
11280	Estimated remaining time until the task completes, in
11281	seconds. Returns 0 once the task has completed; returns -1
11282	if the remaining time cannot be computed, in particular if
11283	the current progress is 0.
11284
11285	Even if a value is returned, the estimate will be unreliable
11286	for low progress values. It will become more reliable as the
11287	task progresses; it is not recommended to display an ETA
11288	before at least 20% of a task have completed.
11289	</desc>
11290	</attribute>
11291
11292	<attribute name="completed" type="boolean" readonly="yes">
11293	<desc>Whether the task has been completed.</desc>
11294	</attribute>
11295
11296	<attribute name="canceled" type="boolean" readonly="yes">
11297	<desc>Whether the task has been canceled.</desc>
11298	</attribute>
11299
11300	<attribute name="resultCode" type="long" readonly="yes">
11301	<desc>
11302	Result code of the progress task.
11303	Valid only if <link to="#completed"/> is @c true.
11304	</desc>
11305	</attribute>
11306
11307	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11308	<desc>
11309	Extended information about the unsuccessful result of the
11310	progress operation. May be @c null if no extended information
11311	is available.
11312	Valid only if <link to="#completed"/> is @c true and
11313	<link to="#resultCode"/> indicates a failure.
11314	</desc>
11315	</attribute>
11316
11317	<attribute name="operationCount" type="unsigned long" readonly="yes">
11318	<desc>
11319	Number of sub-operations this task is divided into.
11320	Every task consists of at least one suboperation.
11321	</desc>
11322	</attribute>
11323
11324	<attribute name="operation" type="unsigned long" readonly="yes">
11325	<desc>Number of the sub-operation being currently executed.</desc>
11326	</attribute>
11327
11328	<attribute name="operationDescription" type="wstring" readonly="yes">
11329	<desc>
11330	Description of the sub-operation being currently executed.
11331	</desc>
11332	</attribute>
11333
11334	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11335	<desc>Progress value of the current sub-operation only, in percent.</desc>
11336	</attribute>
11337
11338	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11339	<desc>Weight value of the current sub-operation only.</desc>
11340	</attribute>
11341
11342	<attribute name="timeout" type="unsigned long">
11343	<desc>
11344	When non-zero, this specifies the number of milliseconds after which
11345	the operation will automatically be canceled. This can only be set on
11346	cancelable objects.
11347	</desc>
11348	</attribute>
11349
11350	<method name="setCurrentOperationProgress">
11351	<desc>Internal method, not to be called externally.</desc>
11352	<param name="percent" type="unsigned long" dir="in" />
11353	</method>
11354	<method name="setNextOperation">
11355	<desc>Internal method, not to be called externally.</desc>
11356	<param name="nextOperationDescription" type="wstring" dir="in" />
11357	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11358	</method>
11359
11360	<method name="waitForCompletion">
11361	<desc>
11362	Waits until the task is done (including all sub-operations)
11363	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11364
11365	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11366	thread are not processed while waiting. Neglecting event queues may
11367	have dire consequences (degrade performance, resource hogs,
11368	deadlocks, etc.), this is specially so for the main thread on
11369	platforms using XPCOM. Callers are adviced wait for short periods
11370	and service their event queues between calls, or to create a worker
11371	thread to do the waiting.
11372
11373	<result name="VBOX_E_IPRT_ERROR">
11374	Failed to wait for task completion.
11375	</result>
11376	</desc>
11377
11378	<param name="timeout" type="long" dir="in">
11379	<desc>
11380	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11381	</desc>
11382	</param>
11383	</method>
11384
11385	<method name="waitForOperationCompletion">
11386	<desc>
11387	Waits until the given operation is done with a given timeout in
11388	milliseconds; specify -1 for an indefinite wait.
11389
11390	See <link to="#waitForCompletion"> for event queue considerations.</link>
11391
11392	<result name="VBOX_E_IPRT_ERROR">
11393	Failed to wait for operation completion.
11394	</result>
11395
11396	</desc>
11397	<param name="operation" type="unsigned long" dir="in">
11398	<desc>
11399	Number of the operation to wait for.
11400	Must be less than <link to="#operationCount"/>.
11401	</desc>
11402	</param>
11403	<param name="timeout" type="long" dir="in">
11404	<desc>
11405	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11406	</desc>
11407	</param>
11408	</method>
11409
11410	<method name="waitForAsyncProgressCompletion">
11411	<desc>
11412	Waits until the other task is completed (including all
11413	sub-operations) and forward all changes from the other progress to
11414	this progress. This means sub-operation number, description, percent
11415	and so on.
11416
11417	You have to take care on setting up at least the same count on
11418	sub-operations in this progress object like there are in the other
11419	progress object.
11420
11421	If the other progress object supports cancel and this object gets any
11422	cancel request (when here enabled as well), it will be forwarded to
11423	the other progress object.
11424
11425	If there is an error in the other progress, this error isn't
11426	automatically transfered to this progress object. So you have to
11427	check any operation error within the other progress object, after
11428	this method returns.
11429	</desc>
11430
11431	<param name="pProgressAsync" type="IProgress" dir="in">
11432	<desc>
11433	The progress object of the asynchrony process.
11434	</desc>
11435	</param>
11436	</method>
11437
11438	<method name="cancel">
11439	<desc>
11440	Cancels the task.
11441	<note>
11442	If <link to="#cancelable"/> is @c false, then this method will fail.
11443	</note>
11444
11445	<result name="VBOX_E_INVALID_OBJECT_STATE">
11446	Operation cannot be canceled.
11447	</result>
11448
11449	</desc>
11450	</method>
11451
11452	</interface>
11453
11454	<!--
11455	// ISnapshot
11456	/////////////////////////////////////////////////////////////////////////
11457	-->
11458
11459	<interface
11460	name="ISnapshot" extends="$unknown"
11461	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11462	wsmap="managed"
11463	>
11464	<desc>
11465	The ISnapshot interface represents a snapshot of the virtual
11466	machine.
11467
11468	Together with the differencing media that are created
11469	when a snapshot is taken, a machine can be brought back to
11470	the exact state it was in when the snapshot was taken.
11471
11472	The ISnapshot interface has no methods, only attributes; snapshots
11473	are controlled through methods of the <link to="IConsole" /> interface
11474	which also manage the media associated with the snapshot.
11475	The following operations exist:
11476
11477	<ul>
11478	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11479	by creating new, empty differencing images for the machine's
11480	media and saving the VM settings and (if the VM is running)
11481	the current VM state in the snapshot.
11482
11483	The differencing images will then receive all data written to
11484	the machine's media, while their parent (base) images
11485	remain unmodified after the snapshot has been taken (see
11486	<link to="IMedium" /> for details about differencing images).
11487	This simplifies restoring a machine to the state of a snapshot:
11488	only the differencing images need to be deleted.
11489
11490	The current machine state is not changed by taking a snapshot
11491	except that <link to="IMachine::currentSnapshot" /> is set to
11492	the newly created snapshot, which is also added to the machine's
11493	snapshots tree.
11494	</li>
11495
11496	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11497	the state of a previous snapshot by deleting the differencing
11498	image of each of the machine's media and setting the machine's
11499	settings and state to the state that was saved in the snapshot (if any).
11500
11501	This destroys the machine's current state. After calling this,
11502	<link to="IMachine::currentSnapshot" /> points to the snapshot
11503	that was restored.
11504	</li>
11505
11506	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11507	without affecting the current machine state.
11508
11509	This does not change the current machine state, but instead frees the
11510	resources allocated when the snapshot was taken: the settings and machine
11511	state file are deleted (if any), and the snapshot's differencing image for
11512	each of the machine's media gets merged with its parent image.
11513
11514	Neither the current machine state nor other snapshots are affected
11515	by this operation, except that parent media will be modified
11516	to contain the disk data associated with the snapshot being deleted.
11517
11518	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11519	attribute is set to the current snapshot's parent or NULL if it
11520	has no parent. Otherwise the attribute is unchanged.
11521	</li>
11522	</ul>
11523
11524	Each snapshot contains a copy of virtual machine's settings (hardware
11525	configuration etc.). This copy is contained in an immutable (read-only)
11526	instance of <link to="IMachine" /> which is available from the snapshot's
11527	<link to="#machine" /> attribute. When restoring the snapshot, these
11528	settings are copied back to the original machine.
11529
11530	In addition, if the machine was running when the
11531	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11532	the current VM state is saved in the snapshot (similarly to what happens
11533	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11534	because when restoring it, the VM will be running.
11535
11536	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11537	the snapshot receives a copy of the execution state file
11538	(<link to="IMachine::stateFilePath"/>).
11539
11540	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11541	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11542	it then contains a so-called "zero execution state", representing a
11543	machine that is powered off.
11544	</desc>
11545
11546	<attribute name="id" type="uuid" mod="string" readonly="yes">
11547	<desc>UUID of the snapshot.</desc>
11548	</attribute>
11549
11550	<attribute name="name" type="wstring">
11551	<desc>Short name of the snapshot.
11552	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11553	be called implicitly.</note>
11554	</desc>
11555	</attribute>
11556
11557	<attribute name="description" type="wstring">
11558	<desc>Optional description of the snapshot.
11559	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11560	be called implicitly.</note>
11561	</desc>
11562	</attribute>
11563
11564	<attribute name="timeStamp" type="long long" readonly="yes">
11565	<desc>
11566	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
11567	</desc>
11568	</attribute>
11569
11570	<attribute name="online" type="boolean" readonly="yes">
11571	<desc>
11572	@c true if this snapshot is an online snapshot and @c false otherwise.
11573
11574	When this attribute is @c true, the
11575	<link to="IMachine::stateFilePath"/> attribute of the
11576	<link to="#machine"/> object associated with this snapshot
11577	will point to the saved state file. Otherwise, it will be
11578	an empty string.
11579	</desc>
11580	</attribute>
11581
11582	<attribute name="machine" type="IMachine" readonly="yes">
11583	<desc>
11584	Virtual machine this snapshot is taken on. This object
11585	stores all settings the machine had when taking this snapshot.
11586	<note>
11587	The returned machine object is immutable, i.e. no
11588	any settings can be changed.
11589	</note>
11590	</desc>
11591	</attribute>
11592
11593	<attribute name="parent" type="ISnapshot" readonly="yes">
11594	<desc>
11595	Parent snapshot (a snapshot this one is based on), or
11596	@c null if the snapshot has no parent (i.e. is the first snapshot).
11597	</desc>
11598	</attribute>
11599
11600	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
11601	<desc>
11602	Child snapshots (all snapshots having this one as a parent).
11603	By inspecting this attribute starting with a machine's root snapshot
11604	(which can be obtained by calling <link to="IMachine::findSnapshot" />
11605	with a @c null UUID), a machine's snapshots tree can be iterated over.
11606	</desc>
11607	</attribute>
11608
11609	<method name="getChildrenCount" const="yes">
11610	<desc>
11611	Returns the number of direct childrens of this snapshot.
11612	</desc>
11613	<param name="childrenCount" type="unsigned long" dir="return">
11614	<desc>
11615	</desc>
11616	</param>
11617	</method>
11618
11619	</interface>
11620
11621
11622	<!--
11623	// IMedium
11624	/////////////////////////////////////////////////////////////////////////
11625	-->
11626
11627	<enum
11628	name="MediumState"
11629	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
11630	>
11631	<desc>
11632	Virtual medium state.
11633	<see><link to="IMedium"/></see>
11634	</desc>
11635
11636	<const name="NotCreated" value="0">
11637	<desc>
11638	Associated medium storage does not exist (either was not created yet or
11639	was deleted).
11640	</desc>
11641	</const>
11642	<const name="Created" value="1">
11643	<desc>
11644	Associated storage exists and accessible; this gets set if the
11645	accessibility check performed by <link to="IMedium::refreshState" />
11646	was successful.
11647	</desc>
11648	</const>
11649	<const name="LockedRead" value="2">
11650	<desc>
11651	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
11652	no data modification is possible.
11653	</desc>
11654	</const>
11655	<const name="LockedWrite" value="3">
11656	<desc>
11657	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
11658	no concurrent data reading or modification is possible.
11659	</desc>
11660	</const>
11661	<const name="Inaccessible" value="4">
11662	<desc>
11663	Medium accessibility check (see <link to="IMedium::refreshState" />) has
11664	not yet been performed, or else, associated medium storage is not
11665	accessible. In the first case, <link to="IMedium::lastAccessError"/>
11666	is empty, in the second case, it describes the error that occurred.
11667	</desc>
11668	</const>
11669	<const name="Creating" value="5">
11670	<desc>
11671	Associated medium storage is being created.
11672	</desc>
11673	</const>
11674	<const name="Deleting" value="6">
11675	<desc>
11676	Associated medium storage is being deleted.
11677	</desc>
11678	</const>
11679	</enum>
11680
11681	<enum
11682	name="MediumType"
11683	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
11684	>
11685	<desc>
11686	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
11687	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
11688	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
11689	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
11690	</desc>
11691
11692	<const name="Normal" value="0">
11693	<desc>
11694	Normal medium (attached directly or indirectly, preserved
11695	when taking snapshots).
11696	</desc>
11697	</const>
11698	<const name="Immutable" value="1">
11699	<desc>
11700	Immutable medium (attached indirectly, changes are wiped out
11701	the next time the virtual machine is started).
11702	</desc>
11703	</const>
11704	<const name="Writethrough" value="2">
11705	<desc>
11706	Write through medium (attached directly, ignored when
11707	taking snapshots).
11708	</desc>
11709	</const>
11710	<const name="Shareable" value="3">
11711	<desc>
11712	Allow using this medium concurrently by several machines.
11713	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
11714	</desc>
11715	</const>
11716	<const name="Readonly" value="4">
11717	<desc>
11718	A readonly medium, which can of course be used by several machines.
11719	<note>Present and accepted since VirtualBox 4.0.</note>
11720	</desc>
11721	</const>
11722	<const name="MultiAttach" value="5">
11723	<desc>
11724	A medium which is is indirectly attached, so that one base medium can
11725	be used for several VMs which have their own differencing medium to
11726	store their modifications. In some sense a variant of Immutable
11727	with unset AutoReset flag in each differencing medium.
11728	<note>Present and accepted since VirtualBox 4.0.</note>
11729	</desc>
11730	</const>
11731	</enum>
11732
11733	<enum
11734	name="MediumVariant"
11735	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
11736	>
11737	<desc>
11738	Virtual medium image variant. More than one flag may be set.
11739	<see><link to="IMedium"/></see>
11740	</desc>
11741
11742	<const name="Standard" value="0">
11743	<desc>
11744	No particular variant requested, results in using the backend default.
11745	</desc>
11746	</const>
11747	<const name="VmdkSplit2G" value="0x01">
11748	<desc>
11749	VMDK image split in chunks of less than 2GByte.
11750	</desc>
11751	</const>
11752	<const name="VmdkRawDisk" value="0x02">
11753	<desc>
11754	VMDK image representing a raw disk.
11755	</desc>
11756	</const>
11757	<const name="VmdkStreamOptimized" value="0x04">
11758	<desc>
11759	VMDK streamOptimized image. Special import/export format which is
11760	read-only/append-only.
11761	</desc>
11762	</const>
11763	<const name="VmdkESX" value="0x08">
11764	<desc>
11765	VMDK format variant used on ESX products.
11766	</desc>
11767	</const>
11768	<const name="Fixed" value="0x10000">
11769	<desc>
11770	Fixed image. Only allowed for base images.
11771	</desc>
11772	</const>
11773	<const name="Diff" value="0x20000">
11774	<desc>
11775	Differencing image. Only allowed for child images.
11776	</desc>
11777	</const>
11778	<const name="NoCreateDir" value="0x40000000">
11779	<desc>
11780	Special flag which suppresses automatic creation of the subdirectory.
11781	Only used when passing the medium variant as an input parameter.
11782	</desc>
11783	</const>
11784	</enum>
11785
11786	<interface
11787	name="IMediumAttachment" extends="$unknown"
11788	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
11789	wsmap="struct"
11790	>
11791	<desc>
11792	The IMediumAttachment interface links storage media to virtual machines.
11793	For each medium (<link to="IMedium"/>) which has been attached to a
11794	storage controller (<link to="IStorageController"/>) of a machine
11795	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
11796	method, one instance of IMediumAttachment is added to the machine's
11797	<link to="IMachine::mediumAttachments"/> array attribute.
11798
11799	Each medium attachment specifies the storage controller as well as a
11800	port and device number and the IMedium instance representing a virtual
11801	hard disk or floppy or DVD image.
11802
11803	For removable media (DVDs or floppies), there are two additional
11804	options. For one, the IMedium instance can be @c null to represent
11805	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
11806	secondly, the medium can be one of the pseudo-media for host drives
11807	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
11808
11809	<h3>Attaching Hard Disks</h3>
11810
11811	Hard disks are attached to virtual machines using the
11812	<link to="IMachine::attachDevice"/> method and detached using the
11813	<link to="IMachine::detachDevice"/> method. Depending on a medium's
11814	type (see <link to="IMedium::type" />), hard disks are attached either
11815	<i>directly</i> or <i>indirectly</i>.
11816
11817	When a hard disk is being attached directly, it is associated with the
11818	virtual machine and used for hard disk operations when the machine is
11819	running. When a hard disk is being attached indirectly, a new differencing
11820	hard disk linked to it is implicitly created and this differencing hard
11821	disk is associated with the machine and used for hard disk operations.
11822	This also means that if <link to="IMachine::attachDevice"/> performs
11823	a direct attachment then the same hard disk will be returned in response
11824	to the subsequent <link to="IMachine::getMedium"/> call; however if
11825	an indirect attachment is performed then
11826	<link to="IMachine::getMedium"/> will return the implicitly created
11827	differencing hard disk, not the original one passed to <link
11828	to="IMachine::attachDevice"/>. In detail:
11829
11830	<ul>
11831	<li><b>Normal base</b> hard disks that do not have children (i.e.
11832	differencing hard disks linked to them) and that are not already
11833	attached to virtual machines in snapshots are attached <b>directly</b>.
11834	Otherwise, they are attached <b>indirectly</b> because having
11835	dependent children or being part of the snapshot makes it impossible
11836	to modify hard disk contents without breaking the integrity of the
11837	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
11838	quickly determine the kind of the attachment for the given hard
11839	disk. Note that if a normal base hard disk is to be indirectly
11840	attached to a virtual machine with snapshots then a special
11841	procedure called <i>smart attachment</i> is performed (see below).</li>
11842	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
11843	they are attached <b>directly</b> if they do not have children and are
11844	not attached to virtual machines in snapshots, and <b>indirectly</b>
11845	otherwise. Note that the smart attachment procedure is never performed
11846	for differencing hard disks.</li>
11847	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
11848	they are designed to be non-writable. If an immutable hard disk is
11849	attached to a virtual machine with snapshots then a special
11850	procedure called smart attachment is performed (see below).</li>
11851	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
11852	also as designed. This also means that writethrough hard disks cannot
11853	have other hard disks linked to them at all.</li>
11854	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
11855	also as designed. This also means that shareable hard disks cannot
11856	have other hard disks linked to them at all. They behave almost
11857	like writethrough hard disks, except that shareable hard disks can
11858	be attached to several virtual machines which are running, allowing
11859	concurrent accesses. You need special cluster software running in
11860	the virtual machines to make use of such disks.</li>
11861	</ul>
11862
11863	Note that the same hard disk, regardless of its type, may be attached to
11864	more than one virtual machine at a time. In this case, the machine that is
11865	started first gains exclusive access to the hard disk and attempts to
11866	start other machines having this hard disk attached will fail until the
11867	first machine is powered down.
11868
11869	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
11870	that the given hard disk remains associated with the given machine after a
11871	successful <link to="IMachine::detachDevice"/> call until
11872	<link to="IMachine::saveSettings"/> is called to save all changes to
11873	machine settings to disk. This deferring is necessary to guarantee that
11874	the hard disk configuration may be restored at any time by a call to
11875	<link to="IMachine::discardSettings"/> before the settings
11876	are saved (committed).
11877
11878	Note that if <link to="IMachine::discardSettings"/> is called after
11879	indirectly attaching some hard disks to the machine but before a call to
11880	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
11881	all differencing hard disks implicitly created by
11882	<link to="IMachine::attachDevice"/> for these indirect attachments.
11883	Such implicitly created hard disks will also be immediately deleted when
11884	detached explicitly using the <link to="IMachine::detachDevice"/>
11885	call if it is made before <link to="IMachine::saveSettings"/>. This
11886	implicit deletion is safe because newly created differencing hard
11887	disks do not contain any user data.
11888
11889	However, keep in mind that detaching differencing hard disks that were
11890	implicitly created by <link to="IMachine::attachDevice"/>
11891	before the last <link to="IMachine::saveSettings"/> call will
11892	<b>not</b> implicitly delete them as they may already contain some data
11893	(for example, as a result of virtual machine execution). If these hard
11894	disks are no more necessary, the caller can always delete them explicitly
11895	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
11896	from this machine by the <link to="IMachine::saveSettings"/> call.
11897
11898	<h3>Smart Attachment</h3>
11899
11900	When normal base or immutable hard disks are indirectly attached to a
11901	virtual machine then some additional steps are performed to make sure the
11902	virtual machine will have the most recent "view" of the hard disk being
11903	attached. These steps include walking through the machine's snapshots
11904	starting from the current one and going through ancestors up to the first
11905	snapshot. Hard disks attached to the virtual machine in all
11906	of the encountered snapshots are checked whether they are descendants of
11907	the given normal base or immutable hard disk. The first found child (which
11908	is the differencing hard disk) will be used instead of the normal base or
11909	immutable hard disk as a parent for creating a new differencing hard disk
11910	that will be actually attached to the machine. And only if no descendants
11911	are found or if the virtual machine does not have any snapshots then the
11912	normal base or immutable hard disk will be used itself as a parent for
11913	this differencing hard disk.
11914
11915	It is easier to explain what smart attachment does using the
11916	following example:
11917	<pre>
11918	BEFORE attaching B.vdi: AFTER attaching B.vdi:
11919
11920	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
11921	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
11922	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
11923	Snapshot 4 (none) Snapshot 4 (none)
11924	CurState (none) CurState (D3->D2.vdi)
11925
11926	NOT
11927	...
11928	CurState (D3->B.vdi)
11929	</pre>
11930	The first column is the virtual machine configuration before the base hard
11931	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
11932	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
11933	mean that the hard disk that is actually attached to the machine is a
11934	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
11935	another hard disk, <tt>B.vdi</tt>.
11936
11937	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
11938	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
11939	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
11940	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
11941	it cannot be attached directly and needs an indirect attachment (i.e.
11942	implicit creation of a new differencing hard disk). Due to the smart
11943	attachment procedure, the new differencing hard disk
11944	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
11945	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
11946	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
11947	machine.
11948
11949	Note that if there is more than one descendant hard disk of the given base
11950	hard disk found in a snapshot, and there is an exact device, channel and
11951	bus match, then this exact match will be used. Otherwise, the youngest
11952	descendant will be picked up.
11953
11954	There is one more important aspect of the smart attachment procedure which
11955	is not related to snapshots at all. Before walking through the snapshots
11956	as described above, the backup copy of the current list of hard disk
11957	attachment is searched for descendants. This backup copy is created when
11958	the hard disk configuration is changed for the first time after the last
11959	<link to="IMachine::saveSettings"/> call and used by
11960	<link to="IMachine::discardSettings"/> to undo the recent hard disk
11961	changes. When such a descendant is found in this backup copy, it will be
11962	simply re-attached back, without creating a new differencing hard disk for
11963	it. This optimization is necessary to make it possible to re-attach the
11964	base or immutable hard disk to a different bus, channel or device slot
11965	without losing the contents of the differencing hard disk actually
11966	attached to the machine in place of it.
11967
11968	</desc>
11969
11970	<attribute name="medium" type="IMedium" readonly="yes">
11971	<desc>Medium object associated with this attachment; it
11972	can be @c null for removable devices.</desc>
11973	</attribute>
11974
11975	<attribute name="controller" type="wstring" readonly="yes">
11976	<desc>Name of the storage controller of this attachment; this
11977	refers to one of the controllers in <link to="IMachine::storageControllers" />
11978	by name.</desc>
11979	</attribute>
11980
11981	<attribute name="port" type="long" readonly="yes">
11982	<desc>Port number of this attachment.
11983	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
11984	</desc>
11985	</attribute>
11986
11987	<attribute name="device" type="long" readonly="yes">
11988	<desc>Device slot number of this attachment.
11989	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
11990	</desc>
11991	</attribute>
11992
11993	<attribute name="type" type="DeviceType" readonly="yes">
11994	<desc>Device type of this attachment.</desc>
11995	</attribute>
11996
11997	<attribute name="passthrough" type="boolean" readonly="yes">
11998	<desc>Pass I/O requests through to a device on the host.</desc>
11999	</attribute>
12000
12001	<attribute name="temporaryEject" type="boolean" readonly="yes">
12002	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12003	</attribute>
12004
12005	<attribute name="isEjected" type="boolean" readonly="yes">
12006	<desc>Signals that the removable medium has been ejected. This is not
12007	necessarily equivalent to having a @c null medium association.</desc>
12008	</attribute>
12009
12010	<attribute name="nonRotational" type="boolean" readonly="yes">
12011	<desc>Whether the associated medium is non-rotational.</desc>
12012	</attribute>
12013
12014	<attribute name="discard" type="boolean" readonly="yes">
12015	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12016	</attribute>
12017
12018	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12019	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12020	</attribute>
12021
12022	</interface>
12023
12024	<interface
12025	name="IMedium" extends="$unknown"
12026	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
12027	wsmap="managed"
12028	>
12029	<desc>
12030	The IMedium interface represents virtual storage for a machine's
12031	hard disks, CD/DVD or floppy drives. It will typically represent
12032	a disk image on the host, for example a VDI or VMDK file representing
12033	a virtual hard disk, or an ISO or RAW file representing virtual
12034	removable media, but can also point to a network location (e.g.
12035	for iSCSI targets).
12036
12037	Instances of IMedium are connected to virtual machines by way of medium
12038	attachments, which link the storage medium to a particular device slot
12039	of a storage controller of the virtual machine.
12040	In the VirtualBox API, virtual storage is therefore always represented
12041	by the following chain of object links:
12042
12043	<ul>
12044	<li><link to="IMachine::storageControllers"/> contains an array of
12045	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12046	these are instances of <link to="IStorageController"/>).</li>
12047	<li><link to="IMachine::mediumAttachments"/> contains an array of
12048	medium attachments (instances of <link to="IMediumAttachment"/>
12049	created by <link to="IMachine::attachDevice" />),
12050	each containing a storage controller from the above array, a
12051	port/device specification, and an instance of IMedium representing
12052	the medium storage (image file).
12053
12054	For removable media, the storage medium is optional; a medium
12055	attachment with no medium represents a CD/DVD or floppy drive
12056	with no medium inserted. By contrast, hard disk attachments
12057	will always have an IMedium object attached.</li>
12058	<li>Each IMedium in turn points to a storage unit (such as a file
12059	on the host computer or a network resource) that holds actual
12060	data. This location is represented by the <link to="#location"/>
12061	attribute.</li>
12062	</ul>
12063
12064	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12065	new hard disk media can be created with the VirtualBox API using the
12066	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12067	disks (see below) are usually implicitly created by VirtualBox as
12068	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12069	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12070	should be created with external tools and then opened from within VirtualBox.
12071
12072	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12073	drive. In that case the <link to="#id" /> attribute contains the UUID of
12074	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12075
12076	<h3>Media registries</h3>
12077
12078	When a medium has been opened or created using one of the aforementioned
12079	APIs, it becomes "known" to VirtualBox. Known media can be attached
12080	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12081	They also appear in the global
12082	<link to="IVirtualBox::hardDisks" />,
12083	<link to="IVirtualBox::DVDImages" /> and
12084	<link to="IVirtualBox::floppyImages" /> arrays.
12085
12086	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12087	in the VirtualBox.xml file, which was shared between all machines and made
12088	transporting machines and their media from one host to another difficult.
12089
12090	Starting with VirtualBox 4.0, media are only added to a registry when they are
12091	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12092	backwards compatibility, which registry a medium is added to depends on which
12093	VirtualBox version created a machine:
12094
12095	<ul>
12096	<li>If the medium has first been attached to a machine which was created by
12097	VirtualBox 4.0 or later, it is added to that machine's media registry in
12098	the machine XML settings file. This way all information about a machine's
12099	media attachments is contained in a single file and can be transported
12100	easily.</li>
12101	<li>For older media attachments (i.e. if the medium was first attached to a
12102	machine which was created with a VirtualBox version before 4.0), media
12103	continue to be registered in the global VirtualBox settings file, for
12104	backwards compatibility.</li>
12105	</ul>
12106
12107	See <link to="IVirtualBox::openMedium" /> for more information.
12108
12109	Media are removed from media registries by the <link to="IMedium::close"/>,
12110	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12111
12112	<h3>Accessibility checks</h3>
12113
12114	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12115	method is called explicitly on a medium. This is done to make the VirtualBox object
12116	ready for serving requests as fast as possible and let the end-user
12117	application decide if it needs to check media accessibility right away or not.
12118
12119	As a result, when VirtualBox starts up (e.g. the VirtualBox
12120	object gets created for the first time), all known media are in the
12121	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12122	attribute is an empty string because no actual accessibility check has
12123	been made yet.
12124
12125	After calling <link to="#refreshState" />, a medium is considered
12126	<i>accessible</i> if its storage unit can be read. In that case, the
12127	<link to="#state"/> attribute has a value of "Created". If the storage
12128	unit cannot be read (for example, because it is located on a disconnected
12129	network resource, or was accidentally deleted outside VirtualBox),
12130	the medium is considered <i>inaccessible</i>, which is indicated by the
12131	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12132	obtained by reading the <link to="#lastAccessError"/> attribute.
12133
12134	<h3>Medium types</h3>
12135
12136	There are five types of medium behavior which are stored in the
12137	<link to="#type"/> attribute (see <link to="MediumType" />) and
12138	which define the medium's behavior with attachments and snapshots.
12139
12140	All media can be also divided in two groups: <i>base</i> media and
12141	<i>differencing</i> media. A base medium contains all sectors of the
12142	medium data in its own storage and therefore can be used independently.
12143	In contrast, a differencing medium is a "delta" to some other medium and
12144	contains only those sectors which differ from that other medium, which is
12145	then called a <i>parent</i>. The differencing medium is said to be
12146	<i>linked to</i> that parent. The parent may be itself a differencing
12147	medium, thus forming a chain of linked media. The last element in that
12148	chain must always be a base medium. Note that several differencing
12149	media may be linked to the same parent medium.
12150
12151	Differencing media can be distinguished from base media by querying the
12152	<link to="#parent"/> attribute: base media do not have parents they would
12153	depend on, so the value of this attribute is always @c null for them.
12154	Using this attribute, it is possible to walk up the medium tree (from the
12155	child medium to its parent). It is also possible to walk down the tree
12156	using the <link to="#children"/> attribute.
12157
12158	Note that the type of all differencing media is "normal"; all other
12159	values are meaningless for them. Base media may be of any type.
12160
12161	<h3>Automatic composition of the file name part</h3>
12162
12163	Another extension to the <link to="IMedium::location"/> attribute is that
12164	there is a possibility to cause VirtualBox to compose a unique value for
12165	the file name part of the location using the UUID of the hard disk. This
12166	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12167	e.g. before the storage unit is created, and works as follows. You set the
12168	value of the <link to="IMedium::location"/> attribute to a location
12169	specification which only contains the path specification but not the file
12170	name part and ends with either a forward slash or a backslash character.
12171	In response, VirtualBox will generate a new UUID for the hard disk and
12172	compose the file name using the following pattern:
12173	<pre>
12174	<path>/{<uuid>}.<ext>
12175	</pre>
12176	where <tt><path></tt> is the supplied path specification,
12177	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12178	is the default extension for the storage format of this hard disk. After
12179	that, you may call any of the methods that create a new hard disk storage
12180	unit and they will use the generated UUID and file name.
12181	</desc>
12182
12183	<attribute name="id" type="uuid" mod="string" readonly="yes">
12184	<desc>
12185	UUID of the medium. For a newly created medium, this value is a randomly
12186	generated UUID.
12187
12188	<note>
12189	For media in one of MediumState_NotCreated, MediumState_Creating or
12190	MediumState_Deleting states, the value of this property is undefined
12191	and will most likely be an empty UUID.
12192	</note>
12193	</desc>
12194	</attribute>
12195
12196	<attribute name="description" type="wstring">
12197	<desc>
12198	Optional description of the medium. For a newly created medium the value
12199	of this attribute is an empty string.
12200
12201	Medium types that don't support this attribute will return E_NOTIMPL in
12202	attempt to get or set this attribute's value.
12203
12204	<note>
12205	For some storage types, reading this attribute may return an outdated
12206	(last known) value when <link to="#state"/> is <link
12207	to="MediumState_Inaccessible"/> or <link
12208	to="MediumState_LockedWrite"/> because the value of this attribute is
12209	stored within the storage unit itself. Also note that changing the
12210	attribute value is not possible in such case, as well as when the
12211	medium is the <link to="MediumState_LockedRead"/> state.
12212	</note>
12213	</desc>
12214	</attribute>
12215
12216	<attribute name="state" type="MediumState" readonly="yes">
12217	<desc>
12218	Returns the current medium state, which is the last state set by
12219	the accessibility check performed by <link to="#refreshState"/>.
12220	If that method has not yet been called on the medium, the state
12221	is "Inaccessible"; as opposed to truly inaccessible media, the
12222	value of <link to="#lastAccessError"/> will be an empty string in
12223	that case.
12224
12225	<note>As of version 3.1, this no longer performs an accessibility check
12226	automatically; call <link to="#refreshState"/> for that.
12227	</note>
12228	</desc>
12229	</attribute>
12230
12231	<attribute name="variant" type="unsigned long" readonly="yes">
12232	<desc>
12233	Returns the storage format variant information for this medium
12234	as a combination of the flags described at <link to="MediumVariant" />.
12235	Before <link to="#refreshState"/> is called this method returns
12236	an undefined value.
12237	</desc>
12238	</attribute>
12239
12240	<attribute name="location" type="wstring">
12241	<desc>
12242	Location of the storage unit holding medium data.
12243
12244	The format of the location string is medium type specific. For medium
12245	types using regular files in a host's file system, the location
12246	string is the full file name.
12247
12248	Some medium types may support changing the storage unit location by
12249	simply changing the value of this property. If this operation is not
12250	supported, the implementation will return E_NOTIMPL in attempt to set
12251	this attribute's value.
12252
12253	When setting a value of the location attribute which is a regular file
12254	in the host's file system, the given file name may be either relative to
12255	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12256	absolute. Note that if the given location specification does not contain
12257	the file extension part then a proper default extension will be
12258	automatically appended by the implementation depending on the medium type.
12259	</desc>
12260	</attribute>
12261
12262	<attribute name="name" type="wstring" readonly="yes">
12263	<desc>
12264	Name of the storage unit holding medium data.
12265
12266	The returned string is a short version of the <link to="#location"/>
12267	attribute that is suitable for representing the medium in situations
12268	where the full location specification is too long (such as lists
12269	and comboboxes in GUI frontends). This string is also used by frontends
12270	to sort the media list alphabetically when needed.
12271
12272	For example, for locations that are regular files in the host's file
12273	system, the value of this attribute is just the file name (+ extension),
12274	without the path specification.
12275
12276	Note that as opposed to the <link to="#location"/> attribute, the name
12277	attribute will not necessary be unique for a list of media of the
12278	given type and format.
12279	</desc>
12280	</attribute>
12281
12282	<attribute name="deviceType" type="DeviceType" readonly="yes">
12283	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12284	medium.</desc>
12285	</attribute>
12286
12287	<attribute name="hostDrive" type="boolean" readonly="yes">
12288	<desc>True if this corresponds to a drive on the host.</desc>
12289	</attribute>
12290
12291	<attribute name="size" type="long long" readonly="yes">
12292	<desc>
12293	Physical size of the storage unit used to hold medium data (in bytes).
12294
12295	<note>
12296	For media whose <link to="#state"/> is <link
12297	to="MediumState_Inaccessible"/>, the value of this property is the
12298	last known size. For <link to="MediumState_NotCreated"/> media,
12299	the returned value is zero.
12300	</note>
12301	</desc>
12302	</attribute>
12303
12304	<attribute name="format" type="wstring" readonly="yes">
12305	<desc>
12306	Storage format of this medium.
12307
12308	The value of this attribute is a string that specifies a backend used
12309	to store medium data. The storage format is defined when you create a
12310	new medium or automatically detected when you open an existing medium,
12311	and cannot be changed later.
12312
12313	The list of all storage formats supported by this VirtualBox
12314	installation can be obtained using
12315	<link to="ISystemProperties::mediumFormats"/>.
12316	</desc>
12317	</attribute>
12318
12319	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12320	<desc>
12321	Storage medium format object corresponding to this medium.
12322
12323	The value of this attribute is a reference to the medium format object
12324	that specifies the backend properties used to store medium data. The
12325	storage format is defined when you create a new medium or automatically
12326	detected when you open an existing medium, and cannot be changed later.
12327
12328	<note>@c null is returned if there is no associated medium format
12329	object. This can e.g. happen for medium objects representing host
12330	drives and other special medium objects.</note>
12331	</desc>
12332	</attribute>
12333
12334	<attribute name="type" type="MediumType">
12335	<desc>
12336	Type (role) of this medium.
12337
12338	The following constraints apply when changing the value of this
12339	attribute:
12340	<ul>
12341	<li>If a medium is attached to a virtual machine (either in the
12342	current state or in one of the snapshots), its type cannot be
12343	changed.
12344	</li>
12345	<li>As long as the medium has children, its type cannot be set
12346	to <link to="MediumType_Writethrough"/>.
12347	</li>
12348	<li>The type of all differencing media is
12349	<link to="MediumType_Normal"/> and cannot be changed.
12350	</li>
12351	</ul>
12352
12353	The type of a newly created or opened medium is set to
12354	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12355	which have a type of <link to="MediumType_Writethrough"/>.
12356	</desc>
12357	</attribute>
12358
12359	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12360	<desc>
12361	Returns which medium types can selected for this medium.
12362
12363	<result name="E_NOTIMPL">
12364	This attribute is not implemented at the moment.
12365	</result>
12366	</desc>
12367	</attribute>
12368
12369	<attribute name="parent" type="IMedium" readonly="yes">
12370	<desc>
12371	Parent of this medium (the medium this medium is directly based
12372	on).
12373
12374	Only differencing media have parents. For base (non-differencing)
12375	media, @c null is returned.
12376	</desc>
12377	</attribute>
12378
12379	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12380	<desc>
12381	Children of this medium (all differencing media directly based
12382	on this medium). A @c null array is returned if this medium
12383	does not have any children.
12384	</desc>
12385	</attribute>
12386
12387	<attribute name="base" type="IMedium" readonly="yes">
12388	<desc>
12389	Base medium of this medium.
12390
12391	If this is a differencing medium, its base medium is the medium
12392	the given medium branch starts from. For all other types of media, this
12393	property returns the medium object itself (i.e. the same object this
12394	property is read on).
12395	</desc>
12396	</attribute>
12397
12398	<attribute name="readOnly" type="boolean" readonly="yes">
12399	<desc>
12400	Returns @c true if this medium is read-only and @c false otherwise.
12401
12402	A medium is considered to be read-only when its contents cannot be
12403	modified without breaking the integrity of other parties that depend on
12404	this medium such as its child media or snapshots of virtual machines
12405	where this medium is attached to these machines. If there are no
12406	children and no such snapshots then there is no dependency and the
12407	medium is not read-only.
12408
12409	The value of this attribute can be used to determine the kind of the
12410	attachment that will take place when attaching this medium to a
12411	virtual machine. If the value is @c false then the medium will
12412	be attached directly. If the value is @c true then the medium
12413	will be attached indirectly by creating a new differencing child
12414	medium for that. See the interface description for more information.
12415
12416	Note that all <link to="MediumType_Immutable">Immutable</link> media
12417	are always read-only while all
12418	<link to="MediumType_Writethrough">Writethrough</link> media are
12419	always not.
12420
12421	<note>
12422	The read-only condition represented by this attribute is related to
12423	the medium type and usage, not to the current
12424	<link to="IMedium::state">medium state</link> and not to the read-only
12425	state of the storage unit.
12426	</note>
12427	</desc>
12428	</attribute>
12429
12430	<attribute name="logicalSize" type="long long" readonly="yes">
12431	<desc>
12432	Logical size of this medium (in bytes), as reported to the
12433	guest OS running inside the virtual machine this medium is
12434	attached to. The logical size is defined when the medium is created
12435	and cannot be changed later.
12436
12437	<note>
12438	Reading this property on a differencing medium will return the size
12439	of its <link to="#base"/> medium.
12440	</note>
12441	<note>
12442	For media whose state is <link to="#state"/> is <link
12443	to="MediumState_Inaccessible"/>, the value of this property is the
12444	last known logical size. For <link to="MediumState_NotCreated"/>
12445	media, the returned value is zero.
12446	</note>
12447	</desc>
12448	</attribute>
12449
12450	<attribute name="autoReset" type="boolean">
12451	<desc>
12452	Whether this differencing medium will be automatically reset each
12453	time a virtual machine it is attached to is powered up. This
12454	attribute is automatically set to @c true for the last
12455	differencing image of an "immutable" medium (see
12456	<link to="MediumType" />).
12457
12458	See <link to="#reset"/> for more information about resetting
12459	differencing media.
12460
12461	<note>
12462	Reading this property on a base (non-differencing) medium will
12463	always @c false. Changing the value of this property in this
12464	case is not supported.
12465	</note>
12466
12467	<result name="VBOX_E_NOT_SUPPORTED">
12468	This is not a differencing medium (when changing the attribute
12469	value).
12470	</result>
12471	</desc>
12472	</attribute>
12473
12474	<attribute name="lastAccessError" type="wstring" readonly="yes">
12475	<desc>
12476	Text message that represents the result of the last accessibility
12477	check performed by <link to="#refreshState"/>.
12478
12479	An empty string is returned if the last accessibility check
12480	was successful or has not yet been called. As a result, if
12481	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12482	then <link to="#refreshState"/> has yet to be called; this is the
12483	default value of media after VirtualBox initialization.
12484	A non-empty string indicates a failure and should normally describe
12485	a reason of the failure (for example, a file read error).
12486	</desc>
12487	</attribute>
12488
12489	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12490	<desc>
12491	Array of UUIDs of all machines this medium is attached to.
12492
12493	A @c null array is returned if this medium is not attached to any
12494	machine or to any machine's snapshot.
12495
12496	<note>
12497	The returned array will include a machine even if this medium is not
12498	attached to that machine in the current state but attached to it in
12499	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12500	details.
12501	</note>
12502	</desc>
12503	</attribute>
12504
12505	<method name="setIDs">
12506	<desc>
12507	Changes the UUID and parent UUID for a hard disk medium.
12508	</desc>
12509	<param name="setImageId" type="boolean" dir="in">
12510	<desc>
12511	Select whether a new image UUID is set or not.
12512	</desc>
12513	</param>
12514	<param name="imageId" type="uuid" mod="string" dir="in">
12515	<desc>
12516	New UUID for the image. If an empty string is passed, then a new
12517	UUID is automatically created, provided that @a setImageId is @c true.
12518	Specifying a zero UUID is not allowed.
12519	</desc>
12520	</param>
12521	<param name="setParentId" type="boolean" dir="in">
12522	<desc>
12523	Select whether a new parent UUID is set or not.
12524	</desc>
12525	</param>
12526	<param name="parentId" type="uuid" mod="string" dir="in">
12527	<desc>
12528	New parent UUID for the image. If an empty string is passed, then a
12529	new UUID is automatically created, provided @a setParentId is
12530	@c true. A zero UUID is valid.
12531	</desc>
12532	</param>
12533	<result name="E_INVALIDARG">
12534	Invalid parameter combination.
12535	</result>
12536	<result name="VBOX_E_NOT_SUPPORTED">
12537	Medium is not a hard disk medium.
12538	</result>
12539	</method>
12540
12541	<method name="refreshState">
12542	<desc>
12543	If the current medium state (see <link to="MediumState"/>) is one of
12544	"Created", "Inaccessible" or "LockedRead", then this performs an
12545	accessibility check on the medium and sets the value of the <link to="#state"/>
12546	attribute accordingly; that value is also returned for convenience.
12547
12548	For all other state values, this does not perform a refresh but returns
12549	the state only.
12550
12551	The refresh, if performed, may take a long time (several seconds or even
12552	minutes, depending on the storage unit location and format) because it performs an
12553	accessibility check of the storage unit. This check may cause a significant
12554	delay if the storage unit of the given medium is, for example, a file located
12555	on a network share which is not currently accessible due to connectivity
12556	problems. In that case, the call will not return until a timeout
12557	interval defined by the host OS for this operation expires. For this reason,
12558	it is recommended to never read this attribute on the main UI thread to avoid
12559	making the UI unresponsive.
12560
12561	If the last known state of the medium is "Created" and the accessibility
12562	check fails, then the state would be set to "Inaccessible", and
12563	<link to="#lastAccessError"/> may be used to get more details about the
12564	failure. If the state of the medium is "LockedRead", then it remains the
12565	same, and a non-empty value of <link to="#lastAccessError"/> will
12566	indicate a failed accessibility check in this case.
12567
12568	Note that not all medium states are applicable to all medium types.
12569	</desc>
12570	<param name="state" type="MediumState" dir="return">
12571	<desc>
12572	New medium state.
12573	</desc>
12574	</param>
12575	</method>
12576
12577	<method name="getSnapshotIds">
12578	<desc>
12579	Returns an array of UUIDs of all snapshots of the given machine where
12580	this medium is attached to.
12581
12582	If the medium is attached to the machine in the current state, then the
12583	first element in the array will always be the ID of the queried machine
12584	(i.e. the value equal to the @c machineId argument), followed by
12585	snapshot IDs (if any).
12586
12587	If the medium is not attached to the machine in the current state, then
12588	the array will contain only snapshot IDs.
12589
12590	The returned array may be @c null if this medium is not attached
12591	to the given machine at all, neither in the current state nor in one of
12592	the snapshots.
12593	</desc>
12594	<param name="machineId" type="uuid" mod="string" dir="in">
12595	<desc>
12596	UUID of the machine to query.
12597	</desc>
12598	</param>
12599	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
12600	<desc>
12601	Array of snapshot UUIDs of the given machine using this medium.
12602	</desc>
12603	</param>
12604	</method>
12605
12606	<method name="lockRead">
12607	<desc>
12608	Locks this medium for reading.
12609
12610	A read lock is shared: many clients can simultaneously lock the
12611	same medium for reading unless it is already locked for writing (see
12612	<link to="#lockWrite"/>) in which case an error is returned.
12613
12614	When the medium is locked for reading, it cannot be modified
12615	from within VirtualBox. This means that any method that changes
12616	the properties of this medium or contents of the storage unit
12617	will return an error (unless explicitly stated otherwise). That
12618	includes an attempt to start a virtual machine that wants to
12619	write to the the medium.
12620
12621	When the virtual machine is started up, it locks for reading all
12622	media it uses in read-only mode. If some medium cannot be locked
12623	for reading, the startup procedure will fail.
12624	A medium is typically locked for reading while it is used by a running
12625	virtual machine but has a depending differencing image that receives
12626	the actual write operations. This way one base medium can have
12627	multiple child differencing images which can be written to
12628	simultaneously. Read-only media such as DVD and floppy images are
12629	also locked for reading only (so they can be in use by multiple
12630	machines simultaneously).
12631
12632	A medium is also locked for reading when it is the source of a
12633	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12634
12635	The medium locked for reading must be unlocked using the <link
12636	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
12637	can be nested and must be followed by the same number of paired
12638	<link to="#unlockRead"/> calls.
12639
12640	This method sets the medium state (see <link to="#state"/>) to
12641	"LockedRead" on success. The medium's previous state must be
12642	one of "Created", "Inaccessible" or "LockedRead".
12643
12644	Locking an inaccessible medium is not an error; this method performs
12645	a logical lock that prevents modifications of this medium through
12646	the VirtualBox API, not a physical file-system lock of the underlying
12647	storage unit.
12648
12649	This method returns the current state of the medium
12650	<i>before</i> the operation.
12651
12652	<result name="VBOX_E_INVALID_OBJECT_STATE">
12653	Invalid medium state (e.g. not created, locked, inaccessible,
12654	creating, deleting).
12655	</result>
12656
12657	</desc>
12658	<param name="state" type="MediumState" dir="return">
12659	<desc>
12660	State of the medium after the operation.
12661	</desc>
12662	</param>
12663	</method>
12664
12665	<method name="unlockRead">
12666	<desc>
12667	Cancels the read lock previously set by <link to="#lockRead"/>.
12668
12669	For both success and failure, this method returns the current state
12670	of the medium <i>after</i> the operation.
12671
12672	See <link to="#lockRead"/> for more details.
12673
12674	<result name="VBOX_E_INVALID_OBJECT_STATE">
12675	Medium not locked for reading.
12676	</result>
12677
12678	</desc>
12679	<param name="state" type="MediumState" dir="return">
12680	<desc>
12681	State of the medium after the operation.
12682	</desc>
12683	</param>
12684	</method>
12685
12686	<method name="lockWrite">
12687	<desc>
12688	Locks this medium for writing.
12689
12690	A write lock, as opposed to <link to="#lockRead"/>, is
12691	exclusive: there may be only one client holding a write lock,
12692	and there may be no read locks while the write lock is held.
12693	As a result, read-locking fails if a write lock is held, and
12694	write-locking fails if either a read or another write lock is held.
12695
12696	When a medium is locked for writing, it cannot be modified
12697	from within VirtualBox, and it is not guaranteed that the values
12698	of its properties are up-to-date. Any method that changes the
12699	properties of this medium or contents of the storage unit will
12700	return an error (unless explicitly stated otherwise).
12701
12702	When a virtual machine is started up, it locks for writing all
12703	media it uses to write data to. If any medium could not be locked
12704	for writing, the startup procedure will fail. If a medium has
12705	differencing images, then while the machine is running, only
12706	the last ("leaf") differencing image is locked for writing,
12707	whereas its parents are locked for reading only.
12708
12709	A medium is also locked for writing when it is the target of a
12710	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12711
12712	The medium locked for writing must be unlocked using the <link
12713	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
12714
12715	This method sets the medium state (see <link to="#state"/>) to
12716	"LockedWrite" on success. The medium's previous state must be
12717	either "Created" or "Inaccessible".
12718
12719	Locking an inaccessible medium is not an error; this method performs
12720	a logical lock that prevents modifications of this medium through
12721	the VirtualBox API, not a physical file-system lock of the underlying
12722	storage unit.
12723
12724	For both, success and failure, this method returns the current
12725	state of the medium <i>before</i> the operation.
12726
12727	<result name="VBOX_E_INVALID_OBJECT_STATE">
12728	Invalid medium state (e.g. not created, locked, inaccessible,
12729	creating, deleting).
12730	</result>
12731
12732	</desc>
12733	<param name="state" type="MediumState" dir="return">
12734	<desc>
12735	State of the medium after the operation.
12736	</desc>
12737	</param>
12738	</method>
12739
12740	<method name="unlockWrite">
12741	<desc>
12742	Cancels the write lock previously set by <link to="#lockWrite"/>.
12743
12744	For both success and failure, this method returns the current
12745	state of the medium <i>after</i> the operation.
12746
12747	See <link to="#lockWrite"/> for more details.
12748
12749	<result name="VBOX_E_INVALID_OBJECT_STATE">
12750	Medium not locked for writing.
12751	</result>
12752
12753	</desc>
12754	<param name="state" type="MediumState" dir="return">
12755	<desc>
12756	State of the medium after the operation.
12757	</desc>
12758	</param>
12759	</method>
12760
12761	<method name="close">
12762	<desc>
12763	Closes this medium.
12764
12765	The medium must not be attached to any known virtual machine
12766	and must not have any known child media, otherwise the
12767	operation will fail.
12768
12769	When the medium is successfully closed, it is removed from
12770	the list of registered media, but its storage unit is not
12771	deleted. In particular, this means that this medium can
12772	later be opened again using the <link to="IVirtualBox::openMedium"/>
12773	call.
12774
12775	Note that after this method successfully returns, the given medium
12776	object becomes uninitialized. This means that any attempt
12777	to call any of its methods or attributes will fail with the
12778	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
12779
12780	<result name="VBOX_E_INVALID_OBJECT_STATE">
12781	Invalid medium state (other than not created, created or
12782	inaccessible).
12783	</result>
12784	<result name="VBOX_E_OBJECT_IN_USE">
12785	Medium attached to virtual machine.
12786	</result>
12787	<result name="VBOX_E_FILE_ERROR">
12788	Settings file not accessible.
12789	</result>
12790	<result name="VBOX_E_XML_ERROR">
12791	Could not parse the settings file.
12792	</result>
12793
12794	</desc>
12795	</method>
12796
12797	<!-- property methods -->
12798
12799	<method name="getProperty" const="yes">
12800	<desc>
12801	Returns the value of the custom medium property with the given name.
12802
12803	The list of all properties supported by the given medium format can
12804	be obtained with <link to="IMediumFormat::describeProperties"/>.
12805
12806	<note>If this method returns an empty string in @a value, the requested
12807	property is supported but currently not assigned any value.</note>
12808
12809	<result name="VBOX_E_OBJECT_NOT_FOUND">
12810	Requested property does not exist (not supported by the format).
12811	</result>
12812	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12813	</desc>
12814	<param name="name" type="wstring" dir="in">
12815	<desc>Name of the property to get.</desc>
12816	</param>
12817	<param name="value" type="wstring" dir="return">
12818	<desc>Current property value.</desc>
12819	</param>
12820	</method>
12821
12822	<method name="setProperty">
12823	<desc>
12824	Sets the value of the custom medium property with the given name.
12825
12826	The list of all properties supported by the given medium format can
12827	be obtained with <link to="IMediumFormat::describeProperties"/>.
12828
12829	<note>Setting the property value to @c null or an empty string is
12830	equivalent to deleting the existing value. A default value (if it is
12831	defined for this property) will be used by the format backend in this
12832	case.</note>
12833
12834	<result name="VBOX_E_OBJECT_NOT_FOUND">
12835	Requested property does not exist (not supported by the format).
12836	</result>
12837	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12838	</desc>
12839	<param name="name" type="wstring" dir="in">
12840	<desc>Name of the property to set.</desc>
12841	</param>
12842	<param name="value" type="wstring" dir="in">
12843	<desc>Property value to set.</desc>
12844	</param>
12845	</method>
12846
12847	<method name="getProperties" const="yes">
12848	<desc>
12849	Returns values for a group of properties in one call.
12850
12851	The names of the properties to get are specified using the @a names
12852	argument which is a list of comma-separated property names or
12853	an empty string if all properties are to be returned.
12854	<note>Currently the value of this argument is ignored and the method
12855	always returns all existing properties.</note>
12856
12857	The list of all properties supported by the given medium format can
12858	be obtained with <link to="IMediumFormat::describeProperties"/>.
12859
12860	The method returns two arrays, the array of property names corresponding
12861	to the @a names argument and the current values of these properties.
12862	Both arrays have the same number of elements with each element at the
12863	given index in the first array corresponds to an element at the same
12864	index in the second array.
12865
12866	For properties that do not have assigned values, an empty string is
12867	returned at the appropriate index in the @a returnValues array.
12868
12869	</desc>
12870	<param name="names" type="wstring" dir="in">
12871	<desc>
12872	Names of properties to get.
12873	</desc>
12874	</param>
12875	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12876	<desc>Names of returned properties.</desc>
12877	</param>
12878	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12879	<desc>Values of returned properties.</desc>
12880	</param>
12881	</method>
12882
12883	<method name="setProperties">
12884	<desc>
12885	Sets values for a group of properties in one call.
12886
12887	The names of the properties to set are passed in the @a names
12888	array along with the new values for them in the @a values array. Both
12889	arrays have the same number of elements with each element at the given
12890	index in the first array corresponding to an element at the same index
12891	in the second array.
12892
12893	If there is at least one property name in @a names that is not valid,
12894	the method will fail before changing the values of any other properties
12895	from the @a names array.
12896
12897	Using this method over <link to="#setProperty"/> is preferred if you
12898	need to set several properties at once since it is more efficient.
12899
12900	The list of all properties supported by the given medium format can
12901	be obtained with <link to="IMediumFormat::describeProperties"/>.
12902
12903	Setting the property value to @c null or an empty string is equivalent
12904	to deleting the existing value. A default value (if it is defined for
12905	this property) will be used by the format backend in this case.
12906	</desc>
12907	<param name="names" type="wstring" safearray="yes" dir="in">
12908	<desc>Names of properties to set.</desc>
12909	</param>
12910	<param name="values" type="wstring" safearray="yes" dir="in">
12911	<desc>Values of properties to set.</desc>
12912	</param>
12913	</method>
12914
12915	<!-- storage methods -->
12916
12917	<method name="createBaseStorage">
12918	<desc>
12919	Starts creating a hard disk storage unit (fixed/dynamic, according
12920	to the variant flags) in in the background. The previous storage unit
12921	created for this object, if any, must first be deleted using
12922	<link to="#deleteStorage"/>, otherwise the operation will fail.
12923
12924	Before the operation starts, the medium is placed in
12925	<link to="MediumState_Creating"/> state. If the create operation
12926	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
12927	state.
12928
12929	After the returned progress object reports that the operation has
12930	successfully completed, the medium state will be set to <link
12931	to="MediumState_Created"/>, the medium will be remembered by this
12932	VirtualBox installation and may be attached to virtual machines.
12933
12934	<result name="VBOX_E_NOT_SUPPORTED">
12935	The variant of storage creation operation is not supported. See <link
12936	to="IMediumFormat::capabilities"/>.
12937	</result>
12938	</desc>
12939	<param name="logicalSize" type="long long" dir="in">
12940	<desc>Maximum logical size of the medium in bytes.</desc>
12941	</param>
12942	<param name="variant" type="unsigned long" dir="in">
12943	<desc>Exact image variant which should be created (as a combination of
12944	<link to="MediumVariant" /> flags).</desc>
12945	</param>
12946	<param name="progress" type="IProgress" dir="return">
12947	<desc>Progress object to track the operation completion.</desc>
12948	</param>
12949	</method>
12950
12951	<method name="deleteStorage">
12952	<desc>
12953	Starts deleting the storage unit of this medium.
12954
12955	The medium must not be attached to any known virtual machine and must
12956	not have any known child media, otherwise the operation will fail.
12957	It will also fail if there is no storage unit to delete or if deletion
12958	is already in progress, or if the medium is being in use (locked for
12959	read or for write) or inaccessible. Therefore, the only valid state for
12960	this operation to succeed is <link to="MediumState_Created"/>.
12961
12962	Before the operation starts, the medium is placed in
12963	<link to="MediumState_Deleting"/> state and gets removed from the list
12964	of remembered hard disks (media registry). If the delete operation
12965	fails, the medium will be remembered again and placed back to
12966	<link to="MediumState_Created"/> state.
12967
12968	After the returned progress object reports that the operation is
12969	complete, the medium state will be set to
12970	<link to="MediumState_NotCreated"/> and you will be able to use one of
12971	the storage creation methods to create it again.
12972
12973	<see><link to="#close"/></see>
12974
12975	<result name="VBOX_E_OBJECT_IN_USE">
12976	Medium is attached to a virtual machine.
12977	</result>
12978	<result name="VBOX_E_NOT_SUPPORTED">
12979	Storage deletion is not allowed because neither of storage creation
12980	operations are supported. See
12981	<link to="IMediumFormat::capabilities"/>.
12982	</result>
12983
12984	<note>
12985	If the deletion operation fails, it is not guaranteed that the storage
12986	unit still exists. You may check the <link to="IMedium::state"/> value
12987	to answer this question.
12988	</note>
12989	</desc>
12990	<param name="progress" type="IProgress" dir="return">
12991	<desc>Progress object to track the operation completion.</desc>
12992	</param>
12993	</method>
12994
12995	<!-- diff methods -->
12996
12997	<method name="createDiffStorage">
12998	<desc>
12999	Starts creating an empty differencing storage unit based on this
13000	medium in the format and at the location defined by the @a target
13001	argument.
13002
13003	The target medium must be in <link to="MediumState_NotCreated"/>
13004	state (i.e. must not have an existing storage unit). Upon successful
13005	completion, this operation will set the type of the target medium to
13006	<link to="MediumType_Normal"/> and create a storage unit necessary to
13007	represent the differencing medium data in the given format (according
13008	to the storage format of the target object).
13009
13010	After the returned progress object reports that the operation is
13011	successfully complete, the target medium gets remembered by this
13012	VirtualBox installation and may be attached to virtual machines.
13013
13014	<note>
13015	The medium will be set to <link to="MediumState_LockedRead"/>
13016	state for the duration of this operation.
13017	</note>
13018	<result name="VBOX_E_OBJECT_IN_USE">
13019	Medium not in @c NotCreated state.
13020	</result>
13021	</desc>
13022	<param name="target" type="IMedium" dir="in">
13023	<desc>Target medium.</desc>
13024	</param>
13025	<param name="variant" type="unsigned long" dir="in">
13026	<desc>Exact image variant which should be created (as a combination of
13027	<link to="MediumVariant" /> flags).</desc>
13028	</param>
13029	<param name="progress" type="IProgress" dir="return">
13030	<desc>Progress object to track the operation completion.</desc>
13031	</param>
13032	</method>
13033
13034	<method name="mergeTo">
13035	<desc>
13036	Starts merging the contents of this medium and all intermediate
13037	differencing media in the chain to the given target medium.
13038
13039	The target medium must be either a descendant of this medium or
13040	its ancestor (otherwise this method will immediately return a failure).
13041	It follows that there are two logical directions of the merge operation:
13042	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13043	ancestor (<i>backward merge</i>). Let us consider the following medium
13044	chain:
13045
13046	<pre>Base <- Diff_1 <- Diff_2</pre>
13047
13048	Here, calling this method on the <tt>Base</tt> medium object with
13049	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13050	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13051	merge. Note that in both cases the contents of the resulting medium
13052	will be the same, the only difference is the medium object that takes
13053	the result of the merge operation. In case of the forward merge in the
13054	above example, the result will be written to <tt>Diff_2</tt>; in case of
13055	the backward merge, the result will be written to <tt>Base</tt>. In
13056	other words, the result of the operation is always stored in the target
13057	medium.
13058
13059	Upon successful operation completion, the storage units of all media in
13060	the chain between this (source) medium and the target medium, including
13061	the source medium itself, will be automatically deleted and the
13062	relevant medium objects (including this medium) will become
13063	uninitialized. This means that any attempt to call any of
13064	their methods or attributes will fail with the
13065	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13066	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13067	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13068	Note that <tt>Diff_2</tt> in this case will become a base medium
13069	itself since it will no longer be based on any other medium.
13070
13071	Considering the above, all of the following conditions must be met in
13072	order for the merge operation to succeed:
13073	<ul>
13074	<li>
13075	Neither this (source) medium nor any intermediate
13076	differencing medium in the chain between it and the target
13077	medium is attached to any virtual machine.
13078	</li>
13079	<li>
13080	Neither the source medium nor the target medium is an
13081	<link to="MediumType_Immutable"/> medium.
13082	</li>
13083	<li>
13084	The part of the medium tree from the source medium to the
13085	target medium is a linear chain, i.e. all medium in this
13086	chain have exactly one child which is the next medium in this
13087	chain. The only exception from this rule is the target medium in
13088	the forward merge operation; it is allowed to have any number of
13089	child media because the merge operation will not change its
13090	logical contents (as it is seen by the guest OS or by children).
13091	</li>
13092	<li>
13093	None of the involved media are in
13094	<link to="MediumState_LockedRead"/> or
13095	<link to="MediumState_LockedWrite"/> state.
13096	</li>
13097	</ul>
13098
13099	<note>
13100	This (source) medium and all intermediates will be placed to <link
13101	to="MediumState_Deleting"/> state and the target medium will be
13102	placed to <link to="MediumState_LockedWrite"/> state and for the
13103	duration of this operation.
13104	</note>
13105	</desc>
13106	<param name="target" type="IMedium" dir="in">
13107	<desc>Target medium.</desc>
13108	</param>
13109	<param name="progress" type="IProgress" dir="return">
13110	<desc>Progress object to track the operation completion.</desc>
13111	</param>
13112	</method>
13113
13114	<!-- clone method -->
13115
13116	<method name="cloneTo">
13117	<desc>
13118	Starts creating a clone of this medium in the format and at the
13119	location defined by the @a target argument.
13120
13121	The target medium must be either in <link to="MediumState_NotCreated"/>
13122	state (i.e. must not have an existing storage unit) or in
13123	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13124	big enough to hold the data or else the copy will be partial). Upon
13125	successful completion, the cloned medium will contain exactly the
13126	same sector data as the medium being cloned, except that in the
13127	first case a new UUID for the clone will be randomly generated, and in
13128	the second case the UUID will remain unchanged.
13129
13130	The @a parent argument defines which medium will be the parent
13131	of the clone. Passing a @c null reference indicates that the clone will
13132	be a base image, i.e. completely independent. It is possible to specify
13133	an arbitrary medium for this parameter, including the parent of the
13134	medium which is being cloned. Even cloning to a child of the source
13135	medium is possible. Note that when cloning to an existing image, the
13136	@a parent argument is ignored.
13137
13138	After the returned progress object reports that the operation is
13139	successfully complete, the target medium gets remembered by this
13140	VirtualBox installation and may be attached to virtual machines.
13141
13142	<note>
13143	This medium will be placed to <link to="MediumState_LockedRead"/>
13144	state for the duration of this operation.
13145	</note>
13146	<result name="E_NOTIMPL">
13147	The specified cloning variant is not supported at the moment.
13148	</result>
13149	</desc>
13150	<param name="target" type="IMedium" dir="in">
13151	<desc>Target medium.</desc>
13152	</param>
13153	<param name="variant" type="unsigned long" dir="in">
13154	<desc>Exact image variant which should be created (as a combination of
13155	<link to="MediumVariant" /> flags).</desc>
13156	</param>
13157	<param name="parent" type="IMedium" dir="in">
13158	<desc>Parent of the cloned medium.</desc>
13159	</param>
13160	<param name="progress" type="IProgress" dir="return">
13161	<desc>Progress object to track the operation completion.</desc>
13162	</param>
13163	</method>
13164
13165	<!-- other methods -->
13166
13167	<method name="compact">
13168	<desc>
13169	Starts compacting of this medium. This means that the medium is
13170	transformed into a possibly more compact storage representation.
13171	This potentially creates temporary images, which can require a
13172	substantial amount of additional disk space.
13173
13174	This medium will be placed to <link to="MediumState_LockedWrite"/>
13175	state and all its parent media (if any) will be placed to
13176	<link to="MediumState_LockedRead"/> state for the duration of this
13177	operation.
13178
13179	Please note that the results can be either returned straight away,
13180	or later as the result of the background operation via the object
13181	returned via the @a progress parameter.
13182
13183	<result name="VBOX_E_NOT_SUPPORTED">
13184	Medium format does not support compacting (but potentially
13185	needs it).
13186	</result>
13187	</desc>
13188	<param name="progress" type="IProgress" dir="return">
13189	<desc>Progress object to track the operation completion.</desc>
13190	</param>
13191	</method>
13192
13193	<method name="resize">
13194	<desc>
13195	Starts resizing this medium. This means that the nominal size of the
13196	medium is set to the new value. Both increasing and decreasing the
13197	size is possible, and there are no safety checks, since VirtualBox
13198	does not make any assumptions about the medium contents.
13199
13200	Resizing usually needs additional disk space, and possibly also
13201	some temporary disk space. Note that resize does not create a full
13202	temporary copy of the medium, so the additional disk space requirement
13203	is usually much lower than using the clone operation.
13204
13205	This medium will be placed to <link to="MediumState_LockedWrite"/>
13206	state for the duration of this operation.
13207
13208	Please note that the results can be either returned straight away,
13209	or later as the result of the background operation via the object
13210	returned via the @a progress parameter.
13211
13212	<result name="VBOX_E_NOT_SUPPORTED">
13213	Medium format does not support resizing.
13214	</result>
13215	</desc>
13216	<param name="logicalSize" type="long long" dir="in">
13217	<desc>New nominal capacity of the medium in bytes.</desc>
13218	</param>
13219	<param name="progress" type="IProgress" dir="return">
13220	<desc>Progress object to track the operation completion.</desc>
13221	</param>
13222	</method>
13223
13224	<method name="reset">
13225	<desc>
13226	Starts erasing the contents of this differencing medium.
13227
13228	This operation will reset the differencing medium to its initial
13229	state when it does not contain any sector data and any read operation is
13230	redirected to its parent medium. This automatically gets called
13231	during VM power-up for every medium whose <link to="#autoReset" />
13232	attribute is @c true.
13233
13234	The medium will be write-locked for the duration of this operation (see
13235	<link to="#lockWrite" />).
13236
13237	<result name="VBOX_E_NOT_SUPPORTED">
13238	This is not a differencing medium.
13239	</result>
13240	<result name="VBOX_E_INVALID_OBJECT_STATE">
13241	Medium is not in <link to="MediumState_Created"/> or
13242	<link to="MediumState_Inaccessible"/> state.
13243	</result>
13244	</desc>
13245	<param name="progress" type="IProgress" dir="return">
13246	<desc>Progress object to track the operation completion.</desc>
13247	</param>
13248	</method>
13249
13250	</interface>
13251
13252
13253	<!--
13254	// IMediumFormat
13255	/////////////////////////////////////////////////////////////////////////
13256	-->
13257
13258	<enum
13259	name="DataType"
13260	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13261	>
13262	<const name="Int32" value="0"/>
13263	<const name="Int8" value="1"/>
13264	<const name="String" value="2"/>
13265	</enum>
13266
13267	<enum
13268	name="DataFlags"
13269	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13270	>
13271	<const name="None" value="0x00"/>
13272	<const name="Mandatory" value="0x01"/>
13273	<const name="Expert" value="0x02"/>
13274	<const name="Array" value="0x04"/>
13275	<const name="FlagMask" value="0x07"/>
13276	</enum>
13277
13278	<enum
13279	name="MediumFormatCapabilities"
13280	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13281	>
13282	<desc>
13283	Medium format capability flags.
13284	</desc>
13285
13286	<const name="Uuid" value="0x01">
13287	<desc>
13288	Supports UUIDs as expected by VirtualBox code.
13289	</desc>
13290	</const>
13291
13292	<const name="CreateFixed" value="0x02">
13293	<desc>
13294	Supports creating fixed size images, allocating all space instantly.
13295	</desc>
13296	</const>
13297
13298	<const name="CreateDynamic" value="0x04">
13299	<desc>
13300	Supports creating dynamically growing images, allocating space on
13301	demand.
13302	</desc>
13303	</const>
13304
13305	<const name="CreateSplit2G" value="0x08">
13306	<desc>
13307	Supports creating images split in chunks of a bit less than 2 GBytes.
13308	</desc>
13309	</const>
13310
13311	<const name="Differencing" value="0x10">
13312	<desc>
13313	Supports being used as a format for differencing media (see <link
13314	to="IMedium::createDiffStorage"/>).
13315	</desc>
13316	</const>
13317
13318	<const name="Asynchronous" value="0x20">
13319	<desc>
13320	Supports asynchronous I/O operations for at least some configurations.
13321	</desc>
13322	</const>
13323
13324	<const name="File" value="0x40">
13325	<desc>
13326	The format backend operates on files (the <link to="IMedium::location"/>
13327	attribute of the medium specifies a file used to store medium
13328	data; for a list of supported file extensions see
13329	<link to="IMediumFormat::describeFileExtensions"/>).
13330	</desc>
13331	</const>
13332
13333	<const name="Properties" value="0x80">
13334	<desc>
13335	The format backend uses the property interface to configure the storage
13336	location and properties (the <link to="IMediumFormat::describeProperties"/>
13337	method is used to get access to properties supported by the given medium format).
13338	</desc>
13339	</const>
13340
13341	<const name="TcpNetworking" value="0x100">
13342	<desc>
13343	The format backend uses the TCP networking interface for network access.
13344	</desc>
13345	</const>
13346
13347	<const name="VFS" value="0x200">
13348	<desc>
13349	The format backend supports virtual filesystem functionality.
13350	</desc>
13351	</const>
13352
13353	<const name="CapabilityMask" value="0x3FF"/>
13354	</enum>
13355
13356	<interface
13357	name="IMediumFormat" extends="$unknown"
13358	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13359	wsmap="managed"
13360	>
13361	<desc>
13362	The IMediumFormat interface represents a medium format.
13363
13364	Each medium format has an associated backend which is used to handle
13365	media stored in this format. This interface provides information
13366	about the properties of the associated backend.
13367
13368	Each medium format is identified by a string represented by the
13369	<link to="#id"/> attribute. This string is used in calls like
13370	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13371	format.
13372
13373	The list of all supported medium formats can be obtained using
13374	<link to="ISystemProperties::mediumFormats"/>.
13375
13376	<see><link to="IMedium"/></see>
13377	</desc>
13378
13379	<attribute name="id" type="wstring" readonly="yes">
13380	<desc>
13381	Identifier of this format.
13382
13383	The format identifier is a non-@c null non-empty ASCII string. Note that
13384	this string is case-insensitive. This means that, for example, all of
13385	the following strings:
13386	<pre>
13387	"VDI"
13388	"vdi"
13389	"VdI"</pre>
13390	refer to the same medium format.
13391
13392	This string is used in methods of other interfaces where it is necessary
13393	to specify a medium format, such as
13394	<link to="IVirtualBox::createHardDisk"/>.
13395	</desc>
13396	</attribute>
13397
13398	<attribute name="name" type="wstring" readonly="yes">
13399	<desc>
13400	Human readable description of this format.
13401
13402	Mainly for use in file open dialogs.
13403	</desc>
13404	</attribute>
13405
13406	<attribute name="capabilities" type="unsigned long" readonly="yes">
13407	<desc>
13408	Capabilities of the format as a set of bit flags.
13409
13410	For the meaning of individual capability flags see
13411	<link to="MediumFormatCapabilities"/>.
13412	</desc>
13413	</attribute>
13414
13415	<method name="describeFileExtensions">
13416	<desc>
13417	Returns two arrays describing the supported file extensions.
13418
13419	The first array contains the supported extensions and the seconds one
13420	the type each extension supports. Both have the same size.
13421
13422	Note that some backends do not work on files, so this array may be
13423	empty.
13424
13425	<see><link to="IMediumFormat::capabilities"/></see>
13426	</desc>
13427	<param name="extensions" type="wstring" safearray="yes" dir="out">
13428	<desc>The array of supported extensions.</desc>
13429	</param>
13430	<param name="type" type="DeviceType" safearray="yes" dir="out">
13431	<desc>The array which indicates the device type for every given extension.</desc>
13432	</param>
13433	</method>
13434
13435	<method name="describeProperties" const="yes">
13436	<desc>
13437	Returns several arrays describing the properties supported by this
13438	format.
13439
13440	An element with the given index in each array describes one
13441	property. Thus, the number of elements in each returned array is the
13442	same and corresponds to the number of supported properties.
13443
13444	The returned arrays are filled in only if the
13445	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13446	All arguments must be non-@c null.
13447
13448	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13449	</desc>
13450
13451	<param name="names" type="wstring" safearray="yes" dir="out">
13452	<desc>Array of property names.</desc>
13453	</param>
13454	<param name="description" type="wstring" safearray="yes" dir="out">
13455	<desc>Array of property descriptions.</desc>
13456	</param>
13457	<param name="types" type="DataType" safearray="yes" dir="out">
13458	<desc>Array of property types.</desc>
13459	</param>
13460	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13461	<desc>Array of property flags.</desc>
13462	</param>
13463	<param name="defaults" type="wstring" safearray="yes" dir="out">
13464	<desc>Array of default property values.</desc>
13465	</param>
13466	</method>
13467
13468	</interface>
13469
13470
13471	<!--
13472	// IKeyboard
13473	/////////////////////////////////////////////////////////////////////////
13474	-->
13475
13476	<interface
13477	name="IKeyboard" extends="$unknown"
13478	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13479	wsmap="managed"
13480	>
13481	<desc>
13482	The IKeyboard interface represents the virtual machine's keyboard. Used
13483	in <link to="IConsole::keyboard"/>.
13484
13485	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13486	to the virtual machine.
13487
13488	</desc>
13489	<method name="putScancode">
13490	<desc>Sends a scancode to the keyboard.
13491
13492	<result name="VBOX_E_IPRT_ERROR">
13493	Could not send scan code to virtual keyboard.
13494	</result>
13495
13496	</desc>
13497	<param name="scancode" type="long" dir="in"/>
13498	</method>
13499
13500	<method name="putScancodes">
13501	<desc>Sends an array of scancodes to the keyboard.
13502
13503	<result name="VBOX_E_IPRT_ERROR">
13504	Could not send all scan codes to virtual keyboard.
13505	</result>
13506
13507	</desc>
13508	<param name="scancodes" type="long" dir="in" safearray="yes"/>
13509	<param name="codesStored" type="unsigned long" dir="return"/>
13510	</method>
13511
13512	<method name="putCAD">
13513	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
13514	function is nothing special, it is just a convenience function
13515	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
13516
13517	<result name="VBOX_E_IPRT_ERROR">
13518	Could not send all scan codes to virtual keyboard.
13519	</result>
13520
13521	</desc>
13522	</method>
13523
13524	<attribute name="eventSource" type="IEventSource" readonly="yes">
13525	<desc>
13526	Event source for keyboard events.
13527	</desc>
13528	</attribute>
13529
13530	</interface>
13531
13532
13533	<!--
13534	// IMouse
13535	/////////////////////////////////////////////////////////////////////////
13536	-->
13537
13538	<enum
13539	name="MouseButtonState"
13540	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
13541	>
13542	<desc>
13543	Mouse button state.
13544	</desc>
13545
13546	<const name="LeftButton" value="0x01"/>
13547	<const name="RightButton" value="0x02"/>
13548	<const name="MiddleButton" value="0x04"/>
13549	<const name="WheelUp" value="0x08"/>
13550	<const name="WheelDown" value="0x10"/>
13551	<const name="XButton1" value="0x20"/>
13552	<const name="XButton2" value="0x40"/>
13553	<const name="MouseStateMask" value="0x7F"/>
13554	</enum>
13555
13556	<interface
13557	name="IMouse" extends="$unknown"
13558	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
13559	wsmap="managed"
13560	>
13561	<desc>
13562	The IMouse interface represents the virtual machine's mouse. Used in
13563	<link to="IConsole::mouse"/>.
13564
13565	Through this interface, the virtual machine's virtual mouse can be
13566	controlled.
13567	</desc>
13568
13569	<attribute name="absoluteSupported" type="boolean" readonly="yes">
13570	<desc>
13571	Whether the guest OS supports absolute mouse pointer positioning
13572	or not.
13573	<note>
13574	You can use the <link to="IMouseCapabilityChangedEvent"/>
13575	event to be instantly informed about changes of this attribute
13576	during virtual machine execution.
13577	</note>
13578	<see><link to="#putMouseEventAbsolute"/></see>
13579	</desc>
13580	</attribute>
13581
13582	<attribute name="relativeSupported" type="boolean" readonly="yes">
13583	<desc>
13584	Whether the guest OS supports relative mouse pointer positioning
13585	or not.
13586	<note>
13587	You can use the <link to="IMouseCapabilityChangedEvent"/>
13588	event to be instantly informed about changes of this attribute
13589	during virtual machine execution.
13590	</note>
13591	<see><link to="#putMouseEvent"/></see>
13592	</desc>
13593	</attribute>
13594
13595	<attribute name="needsHostCursor" type="boolean" readonly="yes">
13596	<desc>
13597	Whether the guest OS can currently switch to drawing it's own mouse
13598	cursor on demand.
13599	<note>
13600	You can use the <link to="IMouseCapabilityChangedEvent"/>
13601	event to be instantly informed about changes of this attribute
13602	during virtual machine execution.
13603	</note>
13604	<see><link to="#putMouseEvent"/></see>
13605	</desc>
13606	</attribute>
13607
13608	<method name="putMouseEvent">
13609	<desc>
13610	Initiates a mouse event using relative pointer movements
13611	along x and y axis.
13612
13613	<result name="E_ACCESSDENIED">
13614	Console not powered up.
13615	</result>
13616	<result name="VBOX_E_IPRT_ERROR">
13617	Could not send mouse event to virtual mouse.
13618	</result>
13619
13620	</desc>
13621
13622	<param name="dx" type="long" dir="in">
13623	<desc>
13624	Amount of pixels the mouse should move to the right.
13625	Negative values move the mouse to the left.
13626	</desc>
13627	</param>
13628	<param name="dy" type="long" dir="in">
13629	<desc>
13630	Amount of pixels the mouse should move downwards.
13631	Negative values move the mouse upwards.
13632	</desc>
13633	</param>
13634	<param name="dz" type="long" dir="in">
13635	<desc>
13636	Amount of mouse wheel moves.
13637	Positive values describe clockwise wheel rotations,
13638	negative values describe counterclockwise rotations.
13639	</desc>
13640	</param>
13641	<param name="dw" type="long" dir="in">
13642	<desc>
13643	Amount of horizontal mouse wheel moves.
13644	Positive values describe a movement to the left,
13645	negative values describe a movement to the right.
13646	</desc>
13647	</param>
13648	<param name="buttonState" type="long" dir="in">
13649	<desc>
13650	The current state of mouse buttons. Every bit represents
13651	a mouse button as follows:
13652	<table>
13653	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13654	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13655	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13656	</table>
13657	A value of <tt>1</tt> means the corresponding button is pressed.
13658	otherwise it is released.
13659	</desc>
13660	</param>
13661	</method>
13662
13663	<method name="putMouseEventAbsolute">
13664	<desc>
13665	Positions the mouse pointer using absolute x and y coordinates.
13666	These coordinates are expressed in pixels and
13667	start from <tt>[1,1]</tt> which corresponds to the top left
13668	corner of the virtual display.
13669
13670	<result name="E_ACCESSDENIED">
13671	Console not powered up.
13672	</result>
13673	<result name="VBOX_E_IPRT_ERROR">
13674	Could not send mouse event to virtual mouse.
13675	</result>
13676
13677	<note>
13678	This method will have effect only if absolute mouse
13679	positioning is supported by the guest OS.
13680	</note>
13681
13682	<see><link to="#absoluteSupported"/></see>
13683	</desc>
13684
13685	<param name="x" type="long" dir="in">
13686	<desc>
13687	X coordinate of the pointer in pixels, starting from @c 1.
13688	</desc>
13689	</param>
13690	<param name="y" type="long" dir="in">
13691	<desc>
13692	Y coordinate of the pointer in pixels, starting from @c 1.
13693	</desc>
13694	</param>
13695	<param name="dz" type="long" dir="in">
13696	<desc>
13697	Amount of mouse wheel moves.
13698	Positive values describe clockwise wheel rotations,
13699	negative values describe counterclockwise rotations.
13700	</desc>
13701	</param>
13702	<param name="dw" type="long" dir="in">
13703	<desc>
13704	Amount of horizontal mouse wheel moves.
13705	Positive values describe a movement to the left,
13706	negative values describe a movement to the right.
13707	</desc>
13708	</param>
13709	<param name="buttonState" type="long" dir="in">
13710	<desc>
13711	The current state of mouse buttons. Every bit represents
13712	a mouse button as follows:
13713	<table>
13714	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13715	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13716	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13717	</table>
13718	A value of @c 1 means the corresponding button is pressed.
13719	otherwise it is released.
13720	</desc>
13721	</param>
13722	</method>
13723
13724	<attribute name="eventSource" type="IEventSource" readonly="yes">
13725	<desc>
13726	Event source for mouse events.
13727	</desc>
13728	</attribute>
13729
13730	</interface>
13731
13732	<!--
13733	// IDisplay
13734	/////////////////////////////////////////////////////////////////////////
13735	-->
13736
13737	<enum
13738	name="FramebufferPixelFormat"
13739	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
13740	>
13741	<desc>
13742	Format of the video memory buffer. Constants represented by this enum can
13743	be used to test for particular values of <link
13744	to="IFramebuffer::pixelFormat"/>. See also <link
13745	to="IFramebuffer::requestResize"/>.
13746
13747	See also www.fourcc.org for more information about FOURCC pixel formats.
13748	</desc>
13749
13750	<const name="Opaque" value="0">
13751	<desc>
13752	Unknown buffer format (the user may not assume any particular format of
13753	the buffer).
13754	</desc>
13755	</const>
13756	<const name="FOURCC_RGB" value="0x32424752">
13757	<desc>
13758	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
13759	bit layout).
13760	</desc>
13761	</const>
13762	</enum>
13763
13764	<interface
13765	name="IFramebuffer" extends="$unknown"
13766	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
13767	wsmap="suppress"
13768	>
13769	<attribute name="address" type="octet" mod="ptr" readonly="yes">
13770	<desc>Address of the start byte of the frame buffer.</desc>
13771	</attribute>
13772
13773	<attribute name="width" type="unsigned long" readonly="yes">
13774	<desc>Frame buffer width, in pixels.</desc>
13775	</attribute>
13776
13777	<attribute name="height" type="unsigned long" readonly="yes">
13778	<desc>Frame buffer height, in pixels.</desc>
13779	</attribute>
13780
13781	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
13782	<desc>
13783	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
13784	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
13785	are: 8, 15, 16, 24 and 32.
13786	</desc>
13787	</attribute>
13788
13789	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
13790	<desc>
13791	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
13792	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
13793	size of the scan line must be aligned to 32 bits.
13794	</desc>
13795	</attribute>
13796
13797	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
13798	<desc>
13799	Frame buffer pixel format. It's either one of the values defined by <link
13800	to="FramebufferPixelFormat"/> or a raw FOURCC code.
13801	<note>
13802	This attribute must never return <link
13803	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
13804	<link to="#address"/> points to must be always known.
13805	</note>
13806	</desc>
13807	</attribute>
13808
13809	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
13810	<desc>
13811	Defines whether this frame buffer uses the virtual video card's memory
13812	buffer (guest VRAM) directly or not. See <link
13813	to="IFramebuffer::requestResize"/> for more information.
13814	</desc>
13815	</attribute>
13816
13817	<attribute name="heightReduction" type="unsigned long" readonly="yes">
13818	<desc>
13819	Hint from the frame buffer about how much of the standard
13820	screen height it wants to use for itself. This information is
13821	exposed to the guest through the VESA BIOS and VMMDev interface
13822	so that it can use it for determining its video mode table. It
13823	is not guaranteed that the guest respects the value.
13824	</desc>
13825	</attribute>
13826
13827	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
13828	<desc>
13829	An alpha-blended overlay which is superposed over the frame buffer.
13830	The initial purpose is to allow the display of icons providing
13831	information about the VM state, including disk activity, in front
13832	ends which do not have other means of doing that. The overlay is
13833	designed to controlled exclusively by IDisplay. It has no locking
13834	of its own, and any changes made to it are not guaranteed to be
13835	visible until the affected portion of IFramebuffer is updated. The
13836	overlay can be created lazily the first time it is requested. This
13837	attribute can also return @c null to signal that the overlay is not
13838	implemented.
13839	</desc>
13840	</attribute>
13841
13842	<attribute name="winId" type="long long" readonly="yes">
13843	<desc>
13844	Platform-dependent identifier of the window where context of this
13845	frame buffer is drawn, or zero if there's no such window.
13846	</desc>
13847	</attribute>
13848
13849	<method name="lock">
13850	<desc>
13851	Locks the frame buffer.
13852	Gets called by the IDisplay object where this frame buffer is
13853	bound to.
13854	</desc>
13855	</method>
13856
13857	<method name="unlock">
13858	<desc>
13859	Unlocks the frame buffer.
13860	Gets called by the IDisplay object where this frame buffer is
13861	bound to.
13862	</desc>
13863	</method>
13864
13865	<method name="notifyUpdate">
13866	<desc>
13867	Informs about an update.
13868	Gets called by the display object where this buffer is
13869	registered.
13870	</desc>
13871	<param name="x" type="unsigned long" dir="in"/>
13872	<param name="y" type="unsigned long" dir="in"/>
13873	<param name="width" type="unsigned long" dir="in"/>
13874	<param name="height" type="unsigned long" dir="in"/>
13875	</method>
13876
13877	<method name="requestResize">
13878	<desc>
13879	Requests a size and pixel format change.
13880
13881	There are two modes of working with the video buffer of the virtual
13882	machine. The <i>indirect</i> mode implies that the IFramebuffer
13883	implementation allocates a memory buffer for the requested display mode
13884	and provides it to the virtual machine. In <i>direct</i> mode, the
13885	IFramebuffer implementation uses the memory buffer allocated and owned
13886	by the virtual machine. This buffer represents the video memory of the
13887	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
13888	usually faster because the implementation gets a raw pointer to the
13889	guest VRAM buffer which it can directly use for visualizing the contents
13890	of the virtual display, as opposed to the indirect mode where the
13891	contents of guest VRAM are copied to the memory buffer provided by
13892	the implementation every time a display update occurs.
13893
13894	It is important to note that the direct mode is really fast only when
13895	the implementation uses the given guest VRAM buffer directly, for
13896	example, by blitting it to the window representing the virtual machine's
13897	display, which saves at least one copy operation comparing to the
13898	indirect mode. However, using the guest VRAM buffer directly is not
13899	always possible: the format and the color depth of this buffer may be
13900	not supported by the target window, or it may be unknown (opaque) as in
13901	case of text or non-linear multi-plane VGA video modes. In this case,
13902	the indirect mode (that is always available) should be used as a
13903	fallback: when the guest VRAM contents are copied to the
13904	implementation-provided memory buffer, color and format conversion is
13905	done automatically by the underlying code.
13906
13907	The @a pixelFormat parameter defines whether the direct mode is
13908	available or not. If @a pixelFormat is <link
13909	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
13910	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
13911	@a bytesPerLine parameters must be ignored and the implementation must use
13912	the indirect mode (where it provides its own buffer in one of the
13913	supported formats). In all other cases, @a pixelFormat together with
13914	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
13915	buffer pointed to by the @a VRAM parameter and the implementation is
13916	free to choose which mode to use. To indicate that this frame buffer uses
13917	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
13918	attribute must return @c true and <link to="#address"/> must
13919	return exactly the same address that is passed in the @a VRAM parameter
13920	of this method; otherwise it is assumed that the indirect strategy is
13921	chosen.
13922
13923	The @a width and @a height parameters represent the size of the
13924	requested display mode in both modes. In case of indirect mode, the
13925	provided memory buffer should be big enough to store data of the given
13926	display mode. In case of direct mode, it is guaranteed that the given
13927	@a VRAM buffer contains enough space to represent the display mode of the
13928	given size. Note that this frame buffer's <link to="#width"/> and <link
13929	to="#height"/> attributes must return exactly the same values as
13930	passed to this method after the resize is completed (see below).
13931
13932	The @a finished output parameter determines if the implementation has
13933	finished resizing the frame buffer or not. If, for some reason, the
13934	resize cannot be finished immediately during this call, @a finished
13935	must be set to @c false, and the implementation must call
13936	<link to="IDisplay::resizeCompleted"/> after it has returned from
13937	this method as soon as possible. If @a finished is @c false, the
13938	machine will not call any frame buffer methods until
13939	<link to="IDisplay::resizeCompleted"/> is called.
13940
13941	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
13942	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
13943	this frame buffer must return exactly the same values as specified in the
13944	parameters of this method, after the resize is completed. If the
13945	indirect mode is chosen, these attributes must return values describing
13946	the format of the implementation's own memory buffer <link
13947	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
13948	value must always correlate with <link to="#pixelFormat"/>. Note that
13949	the <link to="#pixelFormat"/> attribute must never return <link
13950	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
13951
13952	<note>
13953	This method is called by the IDisplay object under the
13954	<link to="#lock"/> provided by this IFramebuffer
13955	implementation. If this method returns @c false in @a finished, then
13956	this lock is not released until
13957	<link to="IDisplay::resizeCompleted"/> is called.
13958	</note>
13959	</desc>
13960	<param name="screenId" type="unsigned long" dir="in">
13961	<desc>
13962	Logical screen number. Must be used in the corresponding call to
13963	<link to="IDisplay::resizeCompleted"/> if this call is made.
13964	</desc>
13965	</param>
13966	<param name="pixelFormat" type="unsigned long" dir="in">
13967	<desc>
13968	Pixel format of the memory buffer pointed to by @a VRAM.
13969	See also <link to="FramebufferPixelFormat"/>.
13970	</desc>
13971	</param>
13972	<param name="VRAM" type="octet" mod="ptr" dir="in">
13973	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
13974	</param>
13975	<param name="bitsPerPixel" type="unsigned long" dir="in">
13976	<desc>Color depth, bits per pixel.</desc>
13977	</param>
13978	<param name="bytesPerLine" type="unsigned long" dir="in">
13979	<desc>Size of one scan line, in bytes.</desc>
13980	</param>
13981	<param name="width" type="unsigned long" dir="in">
13982	<desc>Width of the guest display, in pixels.</desc>
13983	</param>
13984	<param name="height" type="unsigned long" dir="in">
13985	<desc>Height of the guest display, in pixels.</desc>
13986	</param>
13987	<param name="finished" type="boolean" dir="return">
13988	<desc>
13989	Can the VM start using the new frame buffer immediately
13990	after this method returns or it should wait for
13991	<link to="IDisplay::resizeCompleted"/>.
13992	</desc>
13993	</param>
13994	</method>
13995
13996	<method name="videoModeSupported">
13997	<desc>
13998	Returns whether the frame buffer implementation is willing to
13999	support a given video mode. In case it is not able to render
14000	the video mode (or for some reason not willing), it should
14001	return @c false. Usually this method is called when the guest
14002	asks the VMM device whether a given video mode is supported
14003	so the information returned is directly exposed to the guest.
14004	It is important that this method returns very quickly.
14005	</desc>
14006	<param name="width" type="unsigned long" dir="in"/>
14007	<param name="height" type="unsigned long" dir="in"/>
14008	<param name="bpp" type="unsigned long" dir="in"/>
14009	<param name="supported" type="boolean" dir="return"/>
14010	</method>
14011
14012	<method name="getVisibleRegion">
14013	<desc>
14014	Returns the visible region of this frame buffer.
14015
14016	If the @a rectangles parameter is @c null then the value of the
14017	@a count parameter is ignored and the number of elements necessary to
14018	describe the current visible region is returned in @a countCopied.
14019
14020	If @a rectangles is not @c null but @a count is less
14021	than the required number of elements to store region data, the method
14022	will report a failure. If @a count is equal or greater than the
14023	required number of elements, then the actual number of elements copied
14024	to the provided array will be returned in @a countCopied.
14025
14026	<note>
14027	The address of the provided array must be in the process space of
14028	this IFramebuffer object.
14029	</note>
14030	<note>
14031	Method not yet implemented.
14032	</note>
14033	</desc>
14034	<param name="rectangles" type="octet" mod="ptr" dir="in">
14035	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14036	</param>
14037	<param name="count" type="unsigned long" dir="in">
14038	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14039	</param>
14040	<param name="countCopied" type="unsigned long" dir="return">
14041	<desc>Number of elements copied to the @a rectangles array.</desc>
14042	</param>
14043	</method>
14044
14045	<method name="setVisibleRegion">
14046	<desc>
14047	Suggests a new visible region to this frame buffer. This region
14048	represents the area of the VM display which is a union of regions of
14049	all top-level windows of the guest operating system running inside the
14050	VM (if the Guest Additions for this system support this
14051	functionality). This information may be used by the frontends to
14052	implement the seamless desktop integration feature.
14053
14054	<note>
14055	The address of the provided array must be in the process space of
14056	this IFramebuffer object.
14057	</note>
14058	<note>
14059	The IFramebuffer implementation must make a copy of the provided
14060	array of rectangles.
14061	</note>
14062	<note>
14063	Method not yet implemented.
14064	</note>
14065	</desc>
14066	<param name="rectangles" type="octet" mod="ptr" dir="in">
14067	<desc>Pointer to the @c RTRECT array.</desc>
14068	</param>
14069	<param name="count" type="unsigned long" dir="in">
14070	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14071	</param>
14072	</method>
14073
14074	<method name="processVHWACommand">
14075	<desc>
14076	Posts a Video HW Acceleration Command to the frame buffer for processing.
14077	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14078	are posted from quest to the host to be processed by the host hardware.
14079
14080	<note>
14081	The address of the provided command must be in the process space of
14082	this IFramebuffer object.
14083	</note>
14084	</desc>
14085
14086	<param name="command" type="octet" mod="ptr" dir="in">
14087	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14088	</param>
14089	</method>
14090
14091	</interface>
14092
14093	<interface
14094	name="IFramebufferOverlay" extends="IFramebuffer"
14095	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14096	wsmap="suppress"
14097	>
14098	<desc>
14099	The IFramebufferOverlay interface represents an alpha blended overlay
14100	for displaying status icons above an IFramebuffer. It is always created
14101	not visible, so that it must be explicitly shown. It only covers a
14102	portion of the IFramebuffer, determined by its width, height and
14103	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14104	that order) format, and may be written to directly. Do re-read the
14105	width though, after setting it, as it may be adjusted (increased) to
14106	make it more suitable for the front end.
14107	</desc>
14108	<attribute name="x" type="unsigned long" readonly="yes">
14109	<desc>X position of the overlay, relative to the frame buffer.</desc>
14110	</attribute>
14111
14112	<attribute name="y" type="unsigned long" readonly="yes">
14113	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14114	</attribute>
14115
14116	<attribute name="visible" type="boolean" readonly="no">
14117	<desc>
14118	Whether the overlay is currently visible.
14119	</desc>
14120	</attribute>
14121
14122	<attribute name="alpha" type="unsigned long" readonly="no">
14123	<desc>
14124	The global alpha value for the overlay. This may or may not be
14125	supported by a given front end.
14126	</desc>
14127	</attribute>
14128
14129	<method name="move">
14130	<desc>
14131	Changes the overlay's position relative to the IFramebuffer.
14132	</desc>
14133	<param name="x" type="unsigned long" dir="in"/>
14134	<param name="y" type="unsigned long" dir="in"/>
14135	</method>
14136
14137	</interface>
14138
14139	<interface
14140	name="IDisplay" extends="$unknown"
14141	uuid="4b75c45c-e22e-4b75-b7cd-7ce9a83bb36e"
14142	wsmap="managed"
14143	>
14144	<desc>
14145	The IDisplay interface represents the virtual machine's display.
14146
14147	The object implementing this interface is contained in each
14148	<link to="IConsole::display"/> attribute and represents the visual
14149	output of the virtual machine.
14150
14151	The virtual display supports pluggable output targets represented by the
14152	IFramebuffer interface. Examples of the output target are a window on
14153	the host computer or an RDP session's display on a remote computer.
14154	</desc>
14155	<method name="getScreenResolution">
14156	<desc>Queries display width, height and color depth for given screen.</desc>
14157	<param name="screenId" type="unsigned long" dir="in"/>
14158	<param name="width" type="unsigned long" dir="out"/>
14159	<param name="height" type="unsigned long" dir="out"/>
14160	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14161	</method>
14162
14163	<method name="setFramebuffer">
14164	<desc>
14165	Sets the framebuffer for given screen.
14166	</desc>
14167	<param name="screenId" type="unsigned long" dir="in"/>
14168	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14169	</method>
14170
14171	<method name="getFramebuffer">
14172	<desc>
14173	Queries the framebuffer for given screen.
14174	</desc>
14175	<param name="screenId" type="unsigned long" dir="in"/>
14176	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14177	<param name="xOrigin" type="long" dir="out"/>
14178	<param name="yOrigin" type="long" dir="out"/>
14179	</method>
14180
14181	<method name="setVideoModeHint">
14182	<desc>
14183	Asks VirtualBox to request the given video mode from
14184	the guest. This is just a hint and it cannot be guaranteed
14185	that the requested resolution will be used. Guest Additions
14186	are required for the request to be seen by guests. The caller
14187	should issue the request and wait for a resolution change and
14188	after a timeout retry.
14189
14190	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14191	parameters means that the corresponding values should be taken from the
14192	current video mode (i.e. left unchanged).
14193
14194	If the guest OS supports multi-monitor configuration then the @a display
14195	parameter specifies the number of the guest display to send the hint to:
14196	@c 0 is the primary display, @c 1 is the first secondary and
14197	so on. If the multi-monitor configuration is not supported, @a display
14198	must be @c 0.
14199
14200	<result name="E_INVALIDARG">
14201	The @a display is not associated with any monitor.
14202	</result>
14203
14204	</desc>
14205	<param name="width" type="unsigned long" dir="in"/>
14206	<param name="height" type="unsigned long" dir="in"/>
14207	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14208	<param name="display" type="unsigned long" dir="in"/>
14209	</method>
14210
14211	<method name="setSeamlessMode">
14212	<desc>
14213	Enables or disables seamless guest display rendering (seamless desktop
14214	integration) mode.
14215	<note>
14216	Calling this method has no effect if <link
14217	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14218	does not return @c Active.
14219	</note>
14220	</desc>
14221	<param name="enabled" type="boolean" dir="in"/>
14222	</method>
14223
14224	<method name="takeScreenShot">
14225	<desc>
14226	Takes a screen shot of the requested size and copies it to the
14227	32-bpp buffer allocated by the caller and pointed to by @a address.
14228	A pixel consists of 4 bytes in order: B, G, R, 0.
14229
14230	<note>This API can be used only locally by a VM process through the
14231	COM/XPCOM C++ API as it requires pointer support. It is not
14232	available for scripting langages, Java or any webservice clients.
14233	Unless you are writing a new VM frontend use
14234	<link to="#takeScreenShotToArray" />.
14235	</note>
14236
14237	<result name="E_NOTIMPL">
14238	Feature not implemented.
14239	</result>
14240	<result name="VBOX_E_IPRT_ERROR">
14241	Could not take a screenshot.
14242	</result>
14243
14244	</desc>
14245	<param name="screenId" type="unsigned long" dir="in"/>
14246	<param name="address" type="octet" mod="ptr" dir="in"/>
14247	<param name="width" type="unsigned long" dir="in"/>
14248	<param name="height" type="unsigned long" dir="in"/>
14249	</method>
14250
14251	<method name="takeScreenShotToArray">
14252	<desc>
14253	Takes a guest screen shot of the requested size and returns it as
14254	an array of bytes in uncompressed 32-bit RGBA format.
14255	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14256
14257	This API is slow, but could be the only option to get guest screenshot
14258	for scriptable languages not allowed to manipulate with addresses
14259	directly.
14260
14261	<result name="E_NOTIMPL">
14262	Feature not implemented.
14263	</result>
14264	<result name="VBOX_E_IPRT_ERROR">
14265	Could not take a screenshot.
14266	</result>
14267	</desc>
14268	<param name="screenId" type="unsigned long" dir="in">
14269	<desc>
14270	Monitor to take screenshot from.
14271	</desc>
14272	</param>
14273	<param name="width" type="unsigned long" dir="in">
14274	<desc>
14275	Desired image width.
14276	</desc>
14277	</param>
14278	<param name="height" type="unsigned long" dir="in">
14279	<desc>
14280	Desired image height.
14281	</desc>
14282	</param>
14283	<param name="screenData" type="octet" dir="return" safearray="yes">
14284	<desc>
14285	Array with resulting screen data.
14286	</desc>
14287	</param>
14288	</method>
14289
14290	<method name="takeScreenShotPNGToArray">
14291	<desc>
14292	Takes a guest screen shot of the requested size and returns it as
14293	PNG image in array.
14294
14295	<result name="E_NOTIMPL">
14296	Feature not implemented.
14297	</result>
14298	<result name="VBOX_E_IPRT_ERROR">
14299	Could not take a screenshot.
14300	</result>
14301	</desc>
14302	<param name="screenId" type="unsigned long" dir="in">
14303	<desc>
14304	Monitor to take the screenshot from.
14305	</desc>
14306	</param>
14307	<param name="width" type="unsigned long" dir="in">
14308	<desc>
14309	Desired image width.
14310	</desc>
14311	</param>
14312	<param name="height" type="unsigned long" dir="in">
14313	<desc>
14314	Desired image height.
14315	</desc>
14316	</param>
14317	<param name="screenData" type="octet" dir="return" safearray="yes">
14318	<desc>
14319	Array with resulting screen data.
14320	</desc>
14321	</param>
14322	</method>
14323
14324	<method name="drawToScreen">
14325	<desc>
14326	Draws a 32-bpp image of the specified size from the given buffer
14327	to the given point on the VM display.
14328
14329	<result name="E_NOTIMPL">
14330	Feature not implemented.
14331	</result>
14332	<result name="VBOX_E_IPRT_ERROR">
14333	Could not draw to screen.
14334	</result>
14335
14336	</desc>
14337	<param name="screenId" type="unsigned long" dir="in">
14338	<desc>
14339	Monitor to take the screenshot from.
14340	</desc>
14341	</param>
14342	<param name="address" type="octet" mod="ptr" dir="in">
14343	<desc>
14344	Address to store the screenshot to
14345	</desc>
14346	</param>
14347	<param name="x" type="unsigned long" dir="in">
14348	<desc>
14349	Relative to the screen top left corner.
14350	</desc>
14351	</param>
14352	<param name="y" type="unsigned long" dir="in">
14353	<desc>
14354	Relative to the screen top left corner.
14355	</desc>
14356	</param>
14357	<param name="width" type="unsigned long" dir="in">
14358	<desc>
14359	Desired image width.
14360	</desc>
14361	</param>
14362	<param name="height" type="unsigned long" dir="in">
14363	<desc>
14364	Desired image height.
14365	</desc>
14366	</param>
14367	</method>
14368
14369	<method name="invalidateAndUpdate">
14370	<desc>
14371	Does a full invalidation of the VM display and instructs the VM
14372	to update it.
14373
14374	<result name="VBOX_E_IPRT_ERROR">
14375	Could not invalidate and update screen.
14376	</result>
14377
14378	</desc>
14379	</method>
14380
14381	<method name="resizeCompleted">
14382	<desc>
14383	Signals that a framebuffer has completed the resize operation.
14384
14385	<result name="VBOX_E_NOT_SUPPORTED">
14386	Operation only valid for external frame buffers.
14387	</result>
14388
14389	</desc>
14390	<param name="screenId" type="unsigned long" dir="in"/>
14391	</method>
14392
14393	<method name="completeVHWACommand">
14394	<desc>
14395	Signals that the Video HW Acceleration command has completed.
14396	</desc>
14397
14398	<param name="command" type="octet" mod="ptr" dir="in">
14399	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14400	</param>
14401	</method>
14402
14403	<method name="viewportChanged">
14404	<desc>
14405	Signals that framebuffer window viewport has changed.
14406
14407	<result name="E_INVALIDARG">
14408	The specified viewport data is invalid.
14409	</result>
14410
14411	</desc>
14412
14413	<param name="screenId" type="unsigned long" dir="in">
14414	<desc>
14415	Monitor to take the screenshot from.
14416	</desc>
14417	</param>
14418	<param name="x" type="unsigned long" dir="in">
14419	<desc>
14420	Framebuffer x offset.
14421	</desc>
14422	</param>
14423	<param name="y" type="unsigned long" dir="in">
14424	<desc>
14425	Framebuffer y offset.
14426	</desc>
14427	</param>
14428	<param name="width" type="unsigned long" dir="in">
14429	<desc>
14430	Viewport width.
14431	</desc>
14432	</param>
14433	<param name="height" type="unsigned long" dir="in">
14434	<desc>
14435	Viewport height.
14436	</desc>
14437	</param>
14438	</method>
14439	</interface>
14440
14441	<!--
14442	// INetworkAdapter
14443	/////////////////////////////////////////////////////////////////////////
14444	-->
14445
14446	<enum
14447	name="NetworkAttachmentType"
14448	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14449	>
14450	<desc>
14451	Network attachment type.
14452	</desc>
14453
14454	<const name="Null" value="0">
14455	<desc>Null value, also means "not attached".</desc>
14456	</const>
14457	<const name="NAT" value="1"/>
14458	<const name="Bridged" value="2"/>
14459	<const name="Internal" value="3"/>
14460	<const name="HostOnly" value="4"/>
14461	<const name="Generic" value="5"/>
14462	</enum>
14463
14464	<enum
14465	name="NetworkAdapterType"
14466	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14467	>
14468	<desc>
14469	Network adapter type.
14470	</desc>
14471
14472	<const name="Null" value="0">
14473	<desc>Null value (never used by the API).</desc>
14474	</const>
14475	<const name="Am79C970A" value="1">
14476	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14477	</const>
14478	<const name="Am79C973" value="2">
14479	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
14480	</const>
14481	<const name="I82540EM" value="3">
14482	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
14483	</const>
14484	<const name="I82543GC" value="4">
14485	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
14486	</const>
14487	<const name="I82545EM" value="5">
14488	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
14489	</const>
14490	<const name="Virtio" value="6">
14491	<desc>Virtio network device.</desc>
14492	</const>
14493	</enum>
14494
14495	<enum
14496	name="NetworkAdapterPromiscModePolicy"
14497	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
14498	>
14499	<desc>
14500	The promiscuous mode policy of an interface.
14501	</desc>
14502
14503	<const name="Deny" value="1">
14504	<desc>Deny promiscuous mode requests.</desc>
14505	</const>
14506	<const name="AllowNetwork" value="2">
14507	<desc>
14508	Allow promicuous mode, but restrict the scope it to the internal
14509	network so that it only applies to other VMs.
14510	</desc>
14511	</const>
14512	<const name="AllowAll" value="3">
14513	<desc>
14514	Allow promicuous mode, include unrelated traffic going over the wire
14515	and internally on the host.
14516	</desc>
14517	</const>
14518	</enum>
14519
14520	<interface
14521	name="INetworkAdapter" extends="$unknown"
14522	uuid="8b2e705c-0547-4008-b7bc-788757346092"
14523	wsmap="managed"
14524	>
14525	<desc>
14526	Represents a virtual network adapter that is attached to a virtual machine.
14527	Each virtual machine has a fixed number of network adapter slots with one
14528	instance of this attached to each of them. Call
14529	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
14530	is attached to a given slot in a given machine.
14531
14532	Each network adapter can be in one of five attachment modes, which are
14533	represented by the <link to="NetworkAttachmentType" /> enumeration;
14534	see the <link to="#attachmentType" /> attribute.
14535	</desc>
14536
14537	<attribute name="adapterType" type="NetworkAdapterType">
14538	<desc>
14539	Type of the virtual network adapter. Depending on this value,
14540	VirtualBox will provide a different virtual network hardware
14541	to the guest.
14542	</desc>
14543	</attribute>
14544
14545	<attribute name="slot" type="unsigned long" readonly="yes">
14546	<desc>
14547	Slot number this adapter is plugged into. Corresponds to
14548	the value you pass to <link to="IMachine::getNetworkAdapter"/>
14549	to obtain this instance.
14550	</desc>
14551	</attribute>
14552
14553	<attribute name="enabled" type="boolean">
14554	<desc>
14555	Flag whether the network adapter is present in the
14556	guest system. If disabled, the virtual guest hardware will
14557	not contain this network adapter. Can only be changed when
14558	the VM is not running.
14559	</desc>
14560	</attribute>
14561
14562	<attribute name="MACAddress" type="wstring">
14563	<desc>
14564	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
14565	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
14566	</desc>
14567	</attribute>
14568
14569	<attribute name="attachmentType" type="NetworkAttachmentType">
14570	<desc>
14571	Sets/Gets network attachment type of this network adapter.
14572	</desc>
14573	</attribute>
14574
14575	<attribute name="bridgedInterface" type="wstring">
14576	<desc>
14577	Name of the network interface the VM should be bridged to.
14578	</desc>
14579	</attribute>
14580
14581	<attribute name="hostOnlyInterface" type="wstring">
14582	<desc>
14583	Name of the host only network interface the VM is attached to.
14584	</desc>
14585	</attribute>
14586
14587	<attribute name="internalNetwork" type="wstring">
14588	<desc>
14589	Name of the internal network the VM is attached to.
14590	</desc>
14591	</attribute>
14592
14593	<attribute name="NATNetwork" type="wstring">
14594	<desc>
14595	Name of the NAT network the VM is attached to.
14596	</desc>
14597	</attribute>
14598
14599	<attribute name="genericDriver" type="wstring">
14600	<desc>
14601	Name of the driver to use for the "Generic" network attachment type.
14602	</desc>
14603	</attribute>
14604
14605	<attribute name="cableConnected" type="boolean">
14606	<desc>
14607	Flag whether the adapter reports the cable as connected or not.
14608	It can be used to report offline situations to a VM.
14609	</desc>
14610	</attribute>
14611
14612	<attribute name="lineSpeed" type="unsigned long">
14613	<desc>
14614	Line speed reported by custom drivers, in units of 1 kbps.
14615	</desc>
14616	</attribute>
14617
14618	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
14619	<desc>
14620	The promiscuous mode policy of the network adapter when attached to an
14621	internal network, host only network or a bridge.
14622	</desc>
14623	</attribute>
14624
14625	<attribute name="traceEnabled" type="boolean">
14626	<desc>
14627	Flag whether network traffic from/to the network card should be traced.
14628	Can only be toggled when the VM is turned off.
14629	</desc>
14630	</attribute>
14631
14632	<attribute name="traceFile" type="wstring">
14633	<desc>
14634	Filename where a network trace will be stored. If not set, VBox-pid.pcap
14635	will be used.
14636	</desc>
14637	</attribute>
14638
14639	<attribute name="natDriver" type="INATEngine" readonly="yes">
14640	<desc>
14641	Points to the NAT engine which handles the network address translation
14642	for this interface. This is active only when the interface actually uses
14643	NAT.
14644	</desc>
14645	</attribute>
14646
14647	<attribute name="bootPriority" type="unsigned long">
14648	<desc>
14649	Network boot priority of the adapter. Priority 1 is highest. If not set,
14650	the priority is considered to be at the lowest possible setting.
14651	</desc>
14652	</attribute>
14653
14654	<attribute name="bandwidthGroup" type="IBandwidthGroup">
14655	<desc>The bandwidth group this network adapter is assigned to.</desc>
14656	</attribute>
14657
14658	<!-- property methods -->
14659
14660	<method name="getProperty" const="yes">
14661	<desc>
14662	Returns the value of the network attachment property with the given name.
14663
14664	If the requested data @a key does not exist, this function will
14665	succeed and return an empty string in the @a value argument.
14666
14667	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14668	</desc>
14669	<param name="key" type="wstring" dir="in">
14670	<desc>Name of the property to get.</desc>
14671	</param>
14672	<param name="value" type="wstring" dir="return">
14673	<desc>Current property value.</desc>
14674	</param>
14675	</method>
14676
14677	<method name="setProperty">
14678	<desc>
14679	Sets the value of the network attachment property with the given name.
14680
14681	Setting the property value to @c null or an empty string is equivalent
14682	to deleting the existing value.
14683
14684	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14685	</desc>
14686	<param name="key" type="wstring" dir="in">
14687	<desc>Name of the property to set.</desc>
14688	</param>
14689	<param name="value" type="wstring" dir="in">
14690	<desc>Property value to set.</desc>
14691	</param>
14692	</method>
14693
14694	<method name="getProperties" const="yes">
14695	<desc>
14696	Returns values for a group of properties in one call.
14697
14698	The names of the properties to get are specified using the @a names
14699	argument which is a list of comma-separated property names or
14700	an empty string if all properties are to be returned.
14701	<note>Currently the value of this argument is ignored and the method
14702	always returns all existing properties.</note>
14703
14704	The method returns two arrays, the array of property names corresponding
14705	to the @a names argument and the current values of these properties.
14706	Both arrays have the same number of elements with each element at the
14707	given index in the first array corresponds to an element at the same
14708	index in the second array.
14709	</desc>
14710	<param name="names" type="wstring" dir="in">
14711	<desc>
14712	Names of properties to get.
14713	</desc>
14714	</param>
14715	<param name="returnNames" type="wstring" safearray="yes" dir="out">
14716	<desc>Names of returned properties.</desc>
14717	</param>
14718	<param name="returnValues" type="wstring" safearray="yes" dir="return">
14719	<desc>Values of returned properties.</desc>
14720	</param>
14721	</method>
14722
14723	</interface>
14724
14725
14726	<!--
14727	// ISerialPort
14728	/////////////////////////////////////////////////////////////////////////
14729	-->
14730
14731	<enum
14732	name="PortMode"
14733	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
14734	>
14735	<desc>
14736	The PortMode enumeration represents possible communication modes for
14737	the virtual serial port device.
14738	</desc>
14739
14740	<const name="Disconnected" value="0">
14741	<desc>Virtual device is not attached to any real host device.</desc>
14742	</const>
14743	<const name="HostPipe" value="1">
14744	<desc>Virtual device is attached to a host pipe.</desc>
14745	</const>
14746	<const name="HostDevice" value="2">
14747	<desc>Virtual device is attached to a host device.</desc>
14748	</const>
14749	<const name="RawFile" value="3">
14750	<desc>Virtual device is attached to a raw file.</desc>
14751	</const>
14752	</enum>
14753
14754	<interface
14755	name="ISerialPort" extends="$unknown"
14756	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
14757	wsmap="managed"
14758	>
14759
14760	<desc>
14761	The ISerialPort interface represents the virtual serial port device.
14762
14763	The virtual serial port device acts like an ordinary serial port
14764	inside the virtual machine. This device communicates to the real
14765	serial port hardware in one of two modes: host pipe or host device.
14766
14767	In host pipe mode, the #path attribute specifies the path to the pipe on
14768	the host computer that represents a serial port. The #server attribute
14769	determines if this pipe is created by the virtual machine process at
14770	machine startup or it must already exist before starting machine
14771	execution.
14772
14773	In host device mode, the #path attribute specifies the name of the
14774	serial port device on the host computer.
14775
14776	There is also a third communication mode: the disconnected mode. In this
14777	mode, the guest OS running inside the virtual machine will be able to
14778	detect the serial port, but all port write operations will be discarded
14779	and all port read operations will return no data.
14780
14781	<see><link to="IMachine::getSerialPort"/></see>
14782	</desc>
14783
14784	<attribute name="slot" type="unsigned long" readonly="yes">
14785	<desc>
14786	Slot number this serial port is plugged into. Corresponds to
14787	the value you pass to <link to="IMachine::getSerialPort"/>
14788	to obtain this instance.
14789	</desc>
14790	</attribute>
14791
14792	<attribute name="enabled" type="boolean">
14793	<desc>
14794	Flag whether the serial port is enabled. If disabled,
14795	the serial port will not be reported to the guest OS.
14796	</desc>
14797	</attribute>
14798
14799	<attribute name="IOBase" type="unsigned long">
14800	<desc>Base I/O address of the serial port.</desc>
14801	</attribute>
14802
14803	<attribute name="IRQ" type="unsigned long">
14804	<desc>IRQ number of the serial port.</desc>
14805	</attribute>
14806
14807	<attribute name="hostMode" type="PortMode">
14808	<desc>
14809	How is this port connected to the host.
14810	<note>
14811	Changing this attribute may fail if the conditions for
14812	<link to="#path"/> are not met.
14813	</note>
14814	</desc>
14815	</attribute>
14816
14817	<attribute name="server" type="boolean">
14818	<desc>
14819	Flag whether this serial port acts as a server (creates a new pipe on
14820	the host) or as a client (uses the existing pipe). This attribute is
14821	used only when <link to="#hostMode"/> is PortMode_HostPipe.
14822	</desc>
14823	</attribute>
14824
14825	<attribute name="path" type="wstring">
14826	<desc>
14827	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
14828	PortMode_HostPipe, or the host serial device name when
14829	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
14830	cases, setting a @c null or empty string as the attribute's value
14831	is an error. Otherwise, the value of this property is ignored.
14832	</desc>
14833	</attribute>
14834
14835	</interface>
14836
14837	<!--
14838	// IParallelPort
14839	/////////////////////////////////////////////////////////////////////////
14840	-->
14841
14842	<interface
14843	name="IParallelPort" extends="$unknown"
14844	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
14845	wsmap="managed"
14846	>
14847
14848	<desc>
14849	The IParallelPort interface represents the virtual parallel port device.
14850
14851	The virtual parallel port device acts like an ordinary parallel port
14852	inside the virtual machine. This device communicates to the real
14853	parallel port hardware using the name of the parallel device on the host
14854	computer specified in the #path attribute.
14855
14856	Each virtual parallel port device is assigned a base I/O address and an
14857	IRQ number that will be reported to the guest operating system and used
14858	to operate the given parallel port from within the virtual machine.
14859
14860	<see><link to="IMachine::getParallelPort"/></see>
14861	</desc>
14862
14863	<attribute name="slot" type="unsigned long" readonly="yes">
14864	<desc>
14865	Slot number this parallel port is plugged into. Corresponds to
14866	the value you pass to <link to="IMachine::getParallelPort"/>
14867	to obtain this instance.
14868	</desc>
14869	</attribute>
14870
14871	<attribute name="enabled" type="boolean">
14872	<desc>
14873	Flag whether the parallel port is enabled. If disabled,
14874	the parallel port will not be reported to the guest OS.
14875	</desc>
14876	</attribute>
14877
14878	<attribute name="IOBase" type="unsigned long">
14879	<desc>Base I/O address of the parallel port.</desc>
14880	</attribute>
14881
14882	<attribute name="IRQ" type="unsigned long">
14883	<desc>IRQ number of the parallel port.</desc>
14884	</attribute>
14885
14886	<attribute name="path" type="wstring">
14887	<desc>
14888	Host parallel device name. If this parallel port is enabled, setting a
14889	@c null or an empty string as this attribute's value will result in
14890	an error.
14891	</desc>
14892	</attribute>
14893
14894	</interface>
14895
14896
14897	<!--
14898	// IMachineDebugger
14899	/////////////////////////////////////////////////////////////////////////
14900	-->
14901
14902	<interface
14903	name="IMachineDebugger" extends="$unknown"
14904	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
14905	wsmap="suppress"
14906	>
14907	<method name="dumpGuestCore">
14908	<desc>
14909	Takes a core dump of the guest.
14910
14911	See include/VBox/dbgfcorefmt.h for details on the file format.
14912	</desc>
14913	<param name="filename" type="wstring" dir="in">
14914	<desc>
14915	The name of the output file. The file must not exist.
14916	</desc>
14917	</param>
14918	<param name="compression" type="wstring" dir="in">
14919	<desc>
14920	Reserved for future compression method indicator.
14921	</desc>
14922	</param>
14923	</method>
14924
14925	<method name="dumpHostProcessCore">
14926	<desc>
14927	Takes a core dump of the VM process on the host.
14928
14929	This feature is not implemented in the 4.0.0 release but it may show up
14930	in a dot release.
14931	</desc>
14932	<param name="filename" type="wstring" dir="in">
14933	<desc>
14934	The name of the output file. The file must not exist.
14935	</desc>
14936	</param>
14937	<param name="compression" type="wstring" dir="in">
14938	<desc>
14939	Reserved for future compression method indicator.
14940	</desc>
14941	</param>
14942	</method>
14943
14944	<method name="info">
14945	<desc>
14946	Interfaces with the info dumpers (DBGFInfo).
14947
14948	This feature is not implemented in the 4.0.0 release but it may show up
14949	in a dot release.
14950	</desc>
14951	<param name="name" type="wstring" dir="in">
14952	<desc>
14953	The name of the info item.
14954	</desc>
14955	</param>
14956	<param name="args" type="wstring" dir="in">
14957	<desc>
14958	Arguments to the info dumper.
14959	</desc>
14960	</param>
14961	<param name="info" type="wstring" dir="return">
14962	<desc>
14963	The into string.
14964	</desc>
14965	</param>
14966	</method>
14967
14968	<method name="injectNMI">
14969	<desc>
14970	Inject an NMI into a running VT-x/AMD-V VM.
14971	</desc>
14972	</method>
14973
14974	<method name="modifyLogGroups">
14975	<desc>
14976	Modifies the group settings of the debug or release logger.
14977	</desc>
14978	<param name="settings" type="wstring" dir="in">
14979	<desc>
14980	The group settings string. See iprt/log.h for details. To target the
14981	release logger, prefix the string with "release:".
14982	</desc>
14983	</param>
14984	</method>
14985
14986	<method name="modifyLogFlags">
14987	<desc>
14988	Modifies the debug or release logger flags.
14989	</desc>
14990	<param name="settings" type="wstring" dir="in">
14991	<desc>
14992	The flags settings string. See iprt/log.h for details. To target the
14993	release logger, prefix the string with "release:".
14994	</desc>
14995	</param>
14996	</method>
14997
14998	<method name="modifyLogDestinations">
14999	<desc>
15000	Modifies the debug or release logger destinations.
15001	</desc>
15002	<param name="settings" type="wstring" dir="in">
15003	<desc>
15004	The destination settings string. See iprt/log.h for details. To target the
15005	release logger, prefix the string with "release:".
15006	</desc>
15007	</param>
15008	</method>
15009
15010	<method name="readPhysicalMemory">
15011	<desc>
15012	Reads guest physical memory, no side effects (MMIO++).
15013
15014	This feature is not implemented in the 4.0.0 release but may show up
15015	in a dot release.
15016	</desc>
15017	<param name="address" type="long long" dir="in">
15018	<desc>The guest physical address.</desc>
15019	</param>
15020	<param name="size" type="unsigned long" dir="in">
15021	<desc>The number of bytes to read.</desc>
15022	</param>
15023	<param name="bytes" type="octet" safearray="yes" dir="return">
15024	<desc>The bytes read.</desc>
15025	</param>
15026	</method>
15027
15028	<method name="writePhysicalMemory">
15029	<desc>
15030	Writes guest physical memory, access handles (MMIO++) are ignored.
15031
15032	This feature is not implemented in the 4.0.0 release but may show up
15033	in a dot release.
15034	</desc>
15035	<param name="address" type="long long" dir="in">
15036	<desc>The guest physical address.</desc>
15037	</param>
15038	<param name="size" type="unsigned long" dir="in">
15039	<desc>The number of bytes to read.</desc>
15040	</param>
15041	<param name="bytes" type="octet" safearray="yes" dir="in">
15042	<desc>The bytes to write.</desc>
15043	</param>
15044	</method>
15045
15046	<method name="readVirtualMemory">
15047	<desc>
15048	Reads guest virtual memory, no side effects (MMIO++).
15049
15050	This feature is not implemented in the 4.0.0 release but may show up
15051	in a dot release.
15052	</desc>
15053	<param name="cpuId" type="unsigned long" dir="in">
15054	<desc>The identifier of the Virtual CPU.</desc>
15055	</param>
15056	<param name="address" type="long long" dir="in">
15057	<desc>The guest virtual address.</desc>
15058	</param>
15059	<param name="size" type="unsigned long" dir="in">
15060	<desc>The number of bytes to read.</desc>
15061	</param>
15062	<param name="bytes" type="octet" safearray="yes" dir="return">
15063	<desc>The bytes read.</desc>
15064	</param>
15065	</method>
15066
15067	<method name="writeVirtualMemory">
15068	<desc>
15069	Writes guest virtual memory, access handles (MMIO++) are ignored.
15070
15071	This feature is not implemented in the 4.0.0 release but may show up
15072	in a dot release.
15073	</desc>
15074	<param name="cpuId" type="unsigned long" dir="in">
15075	<desc>The identifier of the Virtual CPU.</desc>
15076	</param>
15077	<param name="address" type="long long" dir="in">
15078	<desc>The guest virtual address.</desc>
15079	</param>
15080	<param name="size" type="unsigned long" dir="in">
15081	<desc>The number of bytes to read.</desc>
15082	</param>
15083	<param name="bytes" type="octet" safearray="yes" dir="in">
15084	<desc>The bytes to write.</desc>
15085	</param>
15086	</method>
15087
15088	<method name="detectOS">
15089	<desc>
15090	Tries to (re-)detect the guest OS kernel.
15091
15092	This feature is not implemented in the 4.0.0 release but may show up
15093	in a dot release.
15094	</desc>
15095	<param name="os" type="wstring" dir="return">
15096	<desc>
15097	The detected OS kernel on success.
15098	</desc>
15099	</param>
15100	</method>
15101
15102	<method name="getRegister">
15103	<desc>
15104	Gets one register.
15105
15106	This feature is not implemented in the 4.0.0 release but may show up
15107	in a dot release.
15108	</desc>
15109	<param name="cpuId" type="unsigned long" dir="in">
15110	<desc>The identifier of the Virtual CPU.</desc>
15111	</param>
15112	<param name="name" type="wstring" dir="in">
15113	<desc>The register name, case is ignored.</desc>
15114	</param>
15115	<param name="value" type="wstring" dir="return">
15116	<desc>
15117	The register value. This is usually a hex value (always 0x prefixed)
15118	but other format may be used for floating point registers (TBD).
15119	</desc>
15120	</param>
15121	</method>
15122
15123	<method name="getRegisters">
15124	<desc>
15125	Gets all the registers for the given CPU.
15126
15127	This feature is not implemented in the 4.0.0 release but may show up
15128	in a dot release.
15129	</desc>
15130	<param name="cpuId" type="unsigned long" dir="in">
15131	<desc>The identifier of the Virtual CPU.</desc>
15132	</param>
15133	<param name="names" type="wstring" dir="out" safearray="yes">
15134	<desc>Array containing the lowercase register names.</desc>
15135	</param>
15136	<param name="values" type="wstring" dir="out" safearray="yes">
15137	<desc>
15138	Array paralell to the names holding the register values as if the
15139	register was returned by <link to="IMachineDebugger::getRegister"/>.
15140	</desc>
15141	</param>
15142	</method>
15143
15144	<method name="setRegister">
15145	<desc>
15146	Gets one register.
15147
15148	This feature is not implemented in the 4.0.0 release but may show up
15149	in a dot release.
15150	</desc>
15151	<param name="cpuId" type="unsigned long" dir="in">
15152	<desc>The identifier of the Virtual CPU.</desc>
15153	</param>
15154	<param name="name" type="wstring" dir="in">
15155	<desc>The register name, case is ignored.</desc>
15156	</param>
15157	<param name="value" type="wstring" dir="in">
15158	<desc>
15159	The new register value. Hexadecimal, decimal and octal formattings
15160	are supported in addition to any special formattings returned by
15161	the getters.
15162	</desc>
15163	</param>
15164	</method>
15165
15166	<method name="setRegisters">
15167	<desc>
15168	Sets zero or more registers atomically.
15169
15170	This feature is not implemented in the 4.0.0 release but may show up
15171	in a dot release.
15172	</desc>
15173	<param name="cpuId" type="unsigned long" dir="in">
15174	<desc>The identifier of the Virtual CPU.</desc>
15175	</param>
15176	<param name="names" type="wstring" dir="in" safearray="yes">
15177	<desc>Array containing the register names, case ignored.</desc>
15178	</param>
15179	<param name="values" type="wstring" dir="in" safearray="yes">
15180	<desc>
15181	Array paralell to the names holding the register values. See
15182	<link to="IMachineDebugger::setRegister"/> for formatting
15183	guidelines.
15184	</desc>
15185	</param>
15186	</method>
15187
15188	<method name="dumpGuestStack">
15189	<desc>
15190	Produce a simple stack dump using the current guest state.
15191
15192	This feature is not implemented in the 4.0.0 release but may show up
15193	in a dot release.
15194	</desc>
15195	<param name="cpuId" type="unsigned long" dir="in">
15196	<desc>The identifier of the Virtual CPU.</desc>
15197	</param>
15198	<param name="stack" type="wstring" dir="return">
15199	<desc>String containing the formatted stack dump.</desc>
15200	</param>
15201	</method>
15202
15203	<method name="resetStats">
15204	<desc>
15205	Reset VM statistics.
15206	</desc>
15207	<param name="pattern" type="wstring" dir="in">
15208	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15209	</param>
15210	</method>
15211
15212	<method name="dumpStats">
15213	<desc>
15214	Dumps VM statistics.
15215	</desc>
15216	<param name="pattern" type="wstring" dir="in">
15217	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15218	</param>
15219	</method>
15220
15221	<method name="getStats">
15222	<desc>
15223	Get the VM statistics in a XMLish format.
15224	</desc>
15225	<param name="pattern" type="wstring" dir="in">
15226	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15227	</param>
15228	<param name="withDescriptions" type="boolean" dir="in">
15229	<desc>Whether to include the descriptions.</desc>
15230	</param>
15231	<param name="stats" type="wstring" dir="out">
15232	<desc>The XML document containing the statistics.</desc>
15233	</param>
15234	</method>
15235
15236	<attribute name="singleStep" type="boolean">
15237	<desc>Switch for enabling single-stepping.</desc>
15238	</attribute>
15239
15240	<attribute name="recompileUser" type="boolean">
15241	<desc>Switch for forcing code recompilation for user mode code.</desc>
15242	</attribute>
15243
15244	<attribute name="recompileSupervisor" type="boolean">
15245	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15246	</attribute>
15247
15248	<attribute name="PATMEnabled" type="boolean">
15249	<desc>Switch for enabling and disabling the PATM component.</desc>
15250	</attribute>
15251
15252	<attribute name="CSAMEnabled" type="boolean">
15253	<desc>Switch for enabling and disabling the CSAM component.</desc>
15254	</attribute>
15255
15256	<attribute name="logEnabled" type="boolean">
15257	<desc>Switch for enabling and disabling the debug logger.</desc>
15258	</attribute>
15259
15260	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15261	<desc>The debug logger flags.</desc>
15262	</attribute>
15263
15264	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15265	<desc>The debug logger's group settings.</desc>
15266	</attribute>
15267
15268	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15269	<desc>The debug logger's destination settings.</desc>
15270	</attribute>
15271
15272	<attribute name="logRelFlags" type="wstring" readonly="yes">
15273	<desc>The release logger flags.</desc>
15274	</attribute>
15275
15276	<attribute name="logRelGroups" type="wstring" readonly="yes">
15277	<desc>The release logger's group settings.</desc>
15278	</attribute>
15279
15280	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15281	<desc>The relase logger's destination settings.</desc>
15282	</attribute>
15283
15284	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15285	<desc>
15286	Flag indicating whether the VM is currently making use of CPU hardware
15287	virtualization extensions.
15288	</desc>
15289	</attribute>
15290
15291	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15292	<desc>
15293	Flag indicating whether the VM is currently making use of the nested paging
15294	CPU hardware virtualization extension.
15295	</desc>
15296	</attribute>
15297
15298	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15299	<desc>
15300	Flag indicating whether the VM is currently making use of the VPID
15301	VT-x extension.
15302	</desc>
15303	</attribute>
15304
15305	<attribute name="OSName" type="wstring" readonly="yes">
15306	<desc>
15307	Query the guest OS kernel name as detected by the DBGF.
15308
15309	This feature is not implemented in the 4.0.0 release but may show up
15310	in a dot release.
15311	</desc>
15312	</attribute>
15313
15314	<attribute name="OSVersion" type="wstring" readonly="yes">
15315	<desc>
15316	Query the guest OS kernel version string as detected by the DBGF.
15317
15318	This feature is not implemented in the 4.0.0 release but may show up
15319	in a dot release.
15320	</desc>
15321	</attribute>
15322
15323	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15324	<desc>
15325	Flag indicating whether the VM is currently making use of the Physical
15326	Address Extension CPU feature.
15327	</desc>
15328	</attribute>
15329
15330	<attribute name="virtualTimeRate" type="unsigned long">
15331	<desc>
15332	The rate at which the virtual time runs expressed as a percentage.
15333	The accepted range is 2% to 20000%.
15334	</desc>
15335	</attribute>
15336
15337	<attribute name="VM" type="long long" readonly="yes">
15338	<desc>
15339	Gets the VM handle. This is only for internal use while
15340	we carve the details of this interface.
15341	</desc>
15342	</attribute>
15343
15344	</interface>
15345
15346	<!--
15347	// IUSBController
15348	/////////////////////////////////////////////////////////////////////////
15349	-->
15350
15351	<interface
15352	name="IUSBController" extends="$unknown"
15353	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
15354	wsmap="managed"
15355	>
15356	<attribute name="enabled" type="boolean">
15357	<desc>
15358	Flag whether the USB controller is present in the
15359	guest system. If disabled, the virtual guest hardware will
15360	not contain any USB controller. Can only be changed when
15361	the VM is powered off.
15362	</desc>
15363	</attribute>
15364
15365	<attribute name="enabledEhci" type="boolean">
15366	<desc>
15367	Flag whether the USB EHCI controller is present in the
15368	guest system. If disabled, the virtual guest hardware will
15369	not contain a USB EHCI controller. Can only be changed when
15370	the VM is powered off.
15371	</desc>
15372	</attribute>
15373
15374	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15375	<desc>
15376	Flag whether there is an USB proxy available.
15377	</desc>
15378	</attribute>
15379
15380	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15381	<desc>
15382	USB standard version which the controller implements.
15383	This is a BCD which means that the major version is in the
15384	high byte and minor version is in the low byte.
15385	</desc>
15386	</attribute>
15387
15388	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15389	<desc>
15390	List of USB device filters associated with the machine.
15391
15392	If the machine is currently running, these filters are activated
15393	every time a new (supported) USB device is attached to the host
15394	computer that was not ignored by global filters
15395	(<link to="IHost::USBDeviceFilters"/>).
15396
15397	These filters are also activated when the machine is powered up.
15398	They are run against a list of all currently available USB
15399	devices (in states
15400	<link to="USBDeviceState_Available"/>,
15401	<link to="USBDeviceState_Busy"/>,
15402	<link to="USBDeviceState_Held"/>) that were not previously
15403	ignored by global filters.
15404
15405	If at least one filter matches the USB device in question, this
15406	device is automatically captured (attached to) the virtual USB
15407	controller of this machine.
15408
15409	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15410	</desc>
15411	</attribute>
15412
15413	<method name="createDeviceFilter">
15414	<desc>
15415	Creates a new USB device filter. All attributes except
15416	the filter name are set to empty (any match),
15417	<i>active</i> is @c false (the filter is not active).
15418
15419	The created filter can then be added to the list of filters using
15420	<link to="#insertDeviceFilter"/>.
15421
15422	<result name="VBOX_E_INVALID_VM_STATE">
15423	The virtual machine is not mutable.
15424	</result>
15425
15426	<see><link to="#deviceFilters"/></see>
15427	</desc>
15428	<param name="name" type="wstring" dir="in">
15429	<desc>
15430	Filter name. See <link to="IUSBDeviceFilter::name"/>
15431	for more info.
15432	</desc>
15433	</param>
15434	<param name="filter" type="IUSBDeviceFilter" dir="return">
15435	<desc>Created filter object.</desc>
15436	</param>
15437	</method>
15438
15439	<method name="insertDeviceFilter">
15440	<desc>
15441	Inserts the given USB device to the specified position
15442	in the list of filters.
15443
15444	Positions are numbered starting from <tt>0</tt>. If the specified
15445	position is equal to or greater than the number of elements in
15446	the list, the filter is added to the end of the collection.
15447
15448	<note>
15449	Duplicates are not allowed, so an attempt to insert a
15450	filter that is already in the collection, will return an
15451	error.
15452	</note>
15453
15454	<result name="VBOX_E_INVALID_VM_STATE">
15455	Virtual machine is not mutable.
15456	</result>
15457	<result name="E_INVALIDARG">
15458	USB device filter not created within this VirtualBox instance.
15459	</result>
15460	<result name="VBOX_E_INVALID_OBJECT_STATE">
15461	USB device filter already in list.
15462	</result>
15463
15464	<see><link to="#deviceFilters"/></see>
15465	</desc>
15466	<param name="position" type="unsigned long" dir="in">
15467	<desc>Position to insert the filter to.</desc>
15468	</param>
15469	<param name="filter" type="IUSBDeviceFilter" dir="in">
15470	<desc>USB device filter to insert.</desc>
15471	</param>
15472	</method>
15473
15474	<method name="removeDeviceFilter">
15475	<desc>
15476	Removes a USB device filter from the specified position in the
15477	list of filters.
15478
15479	Positions are numbered starting from <tt>0</tt>. Specifying a
15480	position equal to or greater than the number of elements in
15481	the list will produce an error.
15482
15483	<see><link to="#deviceFilters"/></see>
15484
15485	<result name="VBOX_E_INVALID_VM_STATE">
15486	Virtual machine is not mutable.
15487	</result>
15488	<result name="E_INVALIDARG">
15489	USB device filter list empty or invalid @a position.
15490	</result>
15491
15492	</desc>
15493	<param name="position" type="unsigned long" dir="in">
15494	<desc>Position to remove the filter from.</desc>
15495	</param>
15496	<param name="filter" type="IUSBDeviceFilter" dir="return">
15497	<desc>Removed USB device filter.</desc>
15498	</param>
15499	</method>
15500
15501	</interface>
15502
15503
15504	<!--
15505	// IUSBDevice
15506	/////////////////////////////////////////////////////////////////////////
15507	-->
15508
15509	<interface
15510	name="IUSBDevice" extends="$unknown"
15511	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
15512	wsmap="managed"
15513	>
15514	<desc>
15515	The IUSBDevice interface represents a virtual USB device attached to the
15516	virtual machine.
15517
15518	A collection of objects implementing this interface is stored in the
15519	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
15520	attached to a running virtual machine's USB controller.
15521	</desc>
15522
15523	<attribute name="id" type="uuid" mod="string" readonly="yes">
15524	<desc>
15525	Unique USB device ID. This ID is built from #vendorId,
15526	#productId, #revision and #serialNumber.
15527	</desc>
15528	</attribute>
15529
15530	<attribute name="vendorId" type="unsigned short" readonly="yes">
15531	<desc>Vendor ID.</desc>
15532	</attribute>
15533
15534	<attribute name="productId" type="unsigned short" readonly="yes">
15535	<desc>Product ID.</desc>
15536	</attribute>
15537
15538	<attribute name="revision" type="unsigned short" readonly="yes">
15539	<desc>
15540	Product revision number. This is a packed BCD represented as
15541	unsigned short. The high byte is the integer part and the low
15542	byte is the decimal.
15543	</desc>
15544	</attribute>
15545
15546	<attribute name="manufacturer" type="wstring" readonly="yes">
15547	<desc>Manufacturer string.</desc>
15548	</attribute>
15549
15550	<attribute name="product" type="wstring" readonly="yes">
15551	<desc>Product string.</desc>
15552	</attribute>
15553
15554	<attribute name="serialNumber" type="wstring" readonly="yes">
15555	<desc>Serial number string.</desc>
15556	</attribute>
15557
15558	<attribute name="address" type="wstring" readonly="yes">
15559	<desc>Host specific address of the device.</desc>
15560	</attribute>
15561
15562	<attribute name="port" type="unsigned short" readonly="yes">
15563	<desc>
15564	Host USB port number the device is physically
15565	connected to.
15566	</desc>
15567	</attribute>
15568
15569	<attribute name="version" type="unsigned short" readonly="yes">
15570	<desc>
15571	The major USB version of the device - 1 or 2.
15572	</desc>
15573	</attribute>
15574
15575	<attribute name="portVersion" type="unsigned short" readonly="yes">
15576	<desc>
15577	The major USB version of the host USB port the device is
15578	physically connected to - 1 or 2. For devices not connected to
15579	anything this will have the same value as the version attribute.
15580	</desc>
15581	</attribute>
15582
15583	<attribute name="remote" type="boolean" readonly="yes">
15584	<desc>
15585	Whether the device is physically connected to a remote VRDE
15586	client or to a local host machine.
15587	</desc>
15588	</attribute>
15589
15590	</interface>
15591
15592
15593	<!--
15594	// IUSBDeviceFilter
15595	/////////////////////////////////////////////////////////////////////////
15596	-->
15597
15598	<interface
15599	name="IUSBDeviceFilter" extends="$unknown"
15600	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
15601	wsmap="managed"
15602	>
15603	<desc>
15604	The IUSBDeviceFilter interface represents an USB device filter used
15605	to perform actions on a group of USB devices.
15606
15607	This type of filters is used by running virtual machines to
15608	automatically capture selected USB devices once they are physically
15609	attached to the host computer.
15610
15611	A USB device is matched to the given device filter if and only if all
15612	attributes of the device match the corresponding attributes of the
15613	filter (that is, attributes are joined together using the logical AND
15614	operation). On the other hand, all together, filters in the list of
15615	filters carry the semantics of the logical OR operation. So if it is
15616	desirable to create a match like "this vendor id OR this product id",
15617	one needs to create two filters and specify "any match" (see below)
15618	for unused attributes.
15619
15620	All filter attributes used for matching are strings. Each string
15621	is an expression representing a set of values of the corresponding
15622	device attribute, that will match the given filter. Currently, the
15623	following filtering expressions are supported:
15624
15625	<ul>
15626	<li><i>Interval filters</i>. Used to specify valid intervals for
15627	integer device attributes (Vendor ID, Product ID and Revision).
15628	The format of the string is:
15629
15630	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
15631
15632	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
15633	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
15634	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
15635	is omitted before a dash (<tt>-</tt>), the minimum possible integer
15636	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
15637	possible integer is assumed.
15638	</li>
15639	<li><i>Boolean filters</i>. Used to specify acceptable values for
15640	boolean device attributes. The format of the string is:
15641
15642	<tt>true\|false\|yes\|no\|0\|1</tt>
15643
15644	</li>
15645	<li><i>Exact match</i>. Used to specify a single value for the given
15646	device attribute. Any string that doesn't start with <tt>int:</tt>
15647	represents the exact match. String device attributes are compared to
15648	this string including case of symbols. Integer attributes are first
15649	converted to a string (see individual filter attributes) and then
15650	compared ignoring case.
15651
15652	</li>
15653	<li><i>Any match</i>. Any value of the corresponding device attribute
15654	will match the given filter. An empty or @c null string is
15655	used to construct this type of filtering expressions.
15656
15657	</li>
15658	</ul>
15659
15660	<note>
15661	On the Windows host platform, interval filters are not currently
15662	available. Also all string filter attributes
15663	(<link to="#manufacturer"/>, <link to="#product"/>,
15664	<link to="#serialNumber"/>) are ignored, so they behave as
15665	<i>any match</i> no matter what string expression is specified.
15666	</note>
15667
15668	<see><link to="IUSBController::deviceFilters"/>,
15669	<link to="IHostUSBDeviceFilter"/></see>
15670	</desc>
15671
15672	<attribute name="name" type="wstring">
15673	<desc>
15674	Visible name for this filter.
15675	This name is used to visually distinguish one filter from another,
15676	so it can neither be @c null nor an empty string.
15677	</desc>
15678	</attribute>
15679
15680	<attribute name="active" type="boolean">
15681	<desc>Whether this filter active or has been temporarily disabled.</desc>
15682	</attribute>
15683
15684	<attribute name="vendorId" type="wstring">
15685	<desc>
15686	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
15687	The string representation for the <i>exact matching</i>
15688	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15689	(including leading zeroes).
15690	</desc>
15691	</attribute>
15692
15693	<attribute name="productId" type="wstring">
15694	<desc>
15695	<link to="IUSBDevice::productId">Product ID</link> filter.
15696	The string representation for the <i>exact matching</i>
15697	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15698	(including leading zeroes).
15699	</desc>
15700	</attribute>
15701
15702	<attribute name="revision" type="wstring">
15703	<desc>
15704	<link to="IUSBDevice::productId">Product revision number</link>
15705	filter. The string representation for the <i>exact matching</i>
15706	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
15707	of the integer part of the revision, and <tt>F</tt> is the
15708	decimal digit of its fractional part (including leading and
15709	trailing zeros).
15710	Note that for interval filters, it's best to use the hexadecimal
15711	form, because the revision is stored as a 16 bit packed BCD value;
15712	so the expression <tt>int:0x0100-0x0199</tt> will match any
15713	revision from <tt>1.0</tt> to <tt>1.99</tt>.
15714	</desc>
15715	</attribute>
15716
15717	<attribute name="manufacturer" type="wstring">
15718	<desc>
15719	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
15720	</desc>
15721	</attribute>
15722
15723	<attribute name="product" type="wstring">
15724	<desc>
15725	<link to="IUSBDevice::product">Product</link> filter.
15726	</desc>
15727	</attribute>
15728
15729	<attribute name="serialNumber" type="wstring">
15730	<desc>
15731	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
15732	</desc>
15733	</attribute>
15734
15735	<attribute name="port" type="wstring">
15736	<desc>
15737	<link to="IUSBDevice::port">Host USB port</link> filter.
15738	</desc>
15739	</attribute>
15740
15741	<attribute name="remote" type="wstring">
15742	<desc>
15743	<link to="IUSBDevice::remote">Remote state</link> filter.
15744	<note>
15745	This filter makes sense only for machine USB filters,
15746	i.e. it is ignored by IHostUSBDeviceFilter objects.
15747	</note>
15748	</desc>
15749	</attribute>
15750
15751	<attribute name="maskedInterfaces" type="unsigned long">
15752	<desc>
15753	This is an advanced option for hiding one or more USB interfaces
15754	from the guest. The value is a bit mask where the bits that are set
15755	means the corresponding USB interface should be hidden, masked off
15756	if you like.
15757	This feature only works on Linux hosts.
15758	</desc>
15759	</attribute>
15760
15761	</interface>
15762
15763
15764	<!--
15765	// IHostUSBDevice
15766	/////////////////////////////////////////////////////////////////////////
15767	-->
15768
15769	<enum
15770	name="USBDeviceState"
15771	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
15772	>
15773	<desc>
15774	USB device state. This enumeration represents all possible states
15775	of the USB device physically attached to the host computer regarding
15776	its state on the host computer and availability to guest computers
15777	(all currently running virtual machines).
15778
15779	Once a supported USB device is attached to the host, global USB
15780	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
15781	either ignore the device, or put it to USBDeviceState_Held state, or do
15782	nothing. Unless the device is ignored by global filters, filters of all
15783	currently running guests (<link to="IUSBController::deviceFilters"/>) are
15784	activated that can put it to USBDeviceState_Captured state.
15785
15786	If the device was ignored by global filters, or didn't match
15787	any filters at all (including guest ones), it is handled by the host
15788	in a normal way. In this case, the device state is determined by
15789	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
15790	or USBDeviceState_Available, depending on the current device usage.
15791
15792	Besides auto-capturing based on filters, the device can be manually
15793	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
15794	state is USBDeviceState_Busy, USBDeviceState_Available or
15795	USBDeviceState_Held.
15796
15797	<note>
15798	Due to differences in USB stack implementations in Linux and Win32,
15799	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
15800	only to the Linux version of the product. This also means that (<link
15801	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
15802	device state is USBDeviceState_Held.
15803	</note>
15804
15805	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
15806	</desc>
15807
15808	<const name="NotSupported" value="0">
15809	<desc>
15810	Not supported by the VirtualBox server, not available to guests.
15811	</desc>
15812	</const>
15813	<const name="Unavailable" value="1">
15814	<desc>
15815	Being used by the host computer exclusively,
15816	not available to guests.
15817	</desc>
15818	</const>
15819	<const name="Busy" value="2">
15820	<desc>
15821	Being used by the host computer, potentially available to guests.
15822	</desc>
15823	</const>
15824	<const name="Available" value="3">
15825	<desc>
15826	Not used by the host computer, available to guests (the host computer
15827	can also start using the device at any time).
15828	</desc>
15829	</const>
15830	<const name="Held" value="4">
15831	<desc>
15832	Held by the VirtualBox server (ignored by the host computer),
15833	available to guests.
15834	</desc>
15835	</const>
15836	<const name="Captured" value="5">
15837	<desc>
15838	Captured by one of the guest computers, not available
15839	to anybody else.
15840	</desc>
15841	</const>
15842	</enum>
15843
15844	<interface
15845	name="IHostUSBDevice" extends="IUSBDevice"
15846	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
15847	wsmap="managed"
15848	>
15849	<desc>
15850	The IHostUSBDevice interface represents a physical USB device attached
15851	to the host computer.
15852
15853	Besides properties inherited from IUSBDevice, this interface adds the
15854	<link to="#state"/> property that holds the current state of the USB
15855	device.
15856
15857	<see><link to="IHost::USBDevices"/>,
15858	<link to="IHost::USBDeviceFilters"/></see>
15859	</desc>
15860
15861	<attribute name="state" type="USBDeviceState" readonly="yes">
15862	<desc>
15863	Current state of the device.
15864	</desc>
15865	</attribute>
15866
15867	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
15868
15869	</interface>
15870
15871
15872	<!--
15873	// IHostUSBDeviceFilter
15874	/////////////////////////////////////////////////////////////////////////
15875	-->
15876
15877	<enum
15878	name="USBDeviceFilterAction"
15879	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
15880	>
15881	<desc>
15882	Actions for host USB device filters.
15883	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
15884	</desc>
15885
15886	<const name="Null" value="0">
15887	<desc>Null value (never used by the API).</desc>
15888	</const>
15889	<const name="Ignore" value="1">
15890	<desc>Ignore the matched USB device.</desc>
15891	</const>
15892	<const name="Hold" value="2">
15893	<desc>Hold the matched USB device.</desc>
15894	</const>
15895	</enum>
15896
15897	<interface
15898	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
15899	uuid="4cc70246-d74a-400f-8222-3900489c0374"
15900	wsmap="managed"
15901	>
15902	<desc>
15903	The IHostUSBDeviceFilter interface represents a global filter for a
15904	physical USB device used by the host computer. Used indirectly in
15905	<link to="IHost::USBDeviceFilters"/>.
15906
15907	Using filters of this type, the host computer determines the initial
15908	state of the USB device after it is physically attached to the
15909	host's USB controller.
15910
15911	<note>
15912	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
15913	filters, because it makes sense only for
15914	<link to="IUSBController::deviceFilters">machine USB filters</link>.
15915	</note>
15916
15917	<see><link to="IHost::USBDeviceFilters"/></see>
15918	</desc>
15919
15920	<attribute name="action" type="USBDeviceFilterAction">
15921	<desc>
15922	Action performed by the host when an attached USB device
15923	matches this filter.
15924	</desc>
15925	</attribute>
15926
15927	</interface>
15928
15929	<!--
15930	// IAudioAdapter
15931	/////////////////////////////////////////////////////////////////////////
15932	-->
15933
15934	<enum
15935	name="AudioDriverType"
15936	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
15937	>
15938	<desc>
15939	Host audio driver type.
15940	</desc>
15941
15942	<const name="Null" value="0">
15943	<desc>Null value, also means "dummy audio driver".</desc>
15944	</const>
15945	<const name="WinMM" value="1">
15946	<desc>Windows multimedia (Windows hosts only).</desc>
15947	</const>
15948	<const name="OSS" value="2">
15949	<desc>Open Sound System (Linux hosts only).</desc>
15950	</const>
15951	<const name="ALSA" value="3">
15952	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
15953	</const>
15954	<const name="DirectSound" value="4">
15955	<desc>DirectSound (Windows hosts only).</desc>
15956	</const>
15957	<const name="CoreAudio" value="5">
15958	<desc>CoreAudio (Mac hosts only).</desc>
15959	</const>
15960	<const name="MMPM" value="6">
15961	<desc>Reserved for historical reasons.</desc>
15962	</const>
15963	<const name="Pulse" value="7">
15964	<desc>PulseAudio (Linux hosts only).</desc>
15965	</const>
15966	<const name="SolAudio" value="8">
15967	<desc>Solaris audio (Solaris hosts only).</desc>
15968	</const>
15969	</enum>
15970
15971	<enum
15972	name="AudioControllerType"
15973	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
15974	>
15975	<desc>
15976	Virtual audio controller type.
15977	</desc>
15978
15979	<const name="AC97" value="0"/>
15980	<const name="SB16" value="1"/>
15981	<const name="HDA" value="2"/>
15982	</enum>
15983
15984	<interface
15985	name="IAudioAdapter" extends="$unknown"
15986	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
15987	wsmap="managed"
15988	>
15989	<desc>
15990	The IAudioAdapter interface represents the virtual audio adapter of
15991	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
15992	</desc>
15993	<attribute name="enabled" type="boolean">
15994	<desc>
15995	Flag whether the audio adapter is present in the
15996	guest system. If disabled, the virtual guest hardware will
15997	not contain any audio adapter. Can only be changed when
15998	the VM is not running.
15999	</desc>
16000	</attribute>
16001	<attribute name="audioController" type="AudioControllerType">
16002	<desc>
16003	The audio hardware we emulate.
16004	</desc>
16005	</attribute>
16006	<attribute name="audioDriver" type="AudioDriverType">
16007	<desc>
16008	Audio driver the adapter is connected to. This setting
16009	can only be changed when the VM is not running.
16010	</desc>
16011	</attribute>
16012	</interface>
16013
16014	<enum
16015	name="AuthType"
16016	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16017	>
16018	<desc>
16019	VirtualBox authentication type.
16020	</desc>
16021
16022	<const name="Null" value="0">
16023	<desc>Null value, also means "no authentication".</desc>
16024	</const>
16025	<const name="External" value="1"/>
16026	<const name="Guest" value="2"/>
16027	</enum>
16028
16029	<!--
16030	// IVRDEServer
16031	/////////////////////////////////////////////////////////////////////////
16032	-->
16033
16034	<interface
16035	name="IVRDEServer" extends="$unknown"
16036	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16037	wsmap="managed"
16038	>
16039	<attribute name="enabled" type="boolean">
16040	<desc>VRDE server status.</desc>
16041	</attribute>
16042
16043	<attribute name="authType" type="AuthType">
16044	<desc>VRDE authentication method.</desc>
16045	</attribute>
16046
16047	<attribute name="authTimeout" type="unsigned long">
16048	<desc>Timeout for guest authentication. Milliseconds.</desc>
16049	</attribute>
16050
16051	<attribute name="allowMultiConnection" type="boolean">
16052	<desc>
16053	Flag whether multiple simultaneous connections to the VM are permitted.
16054	Note that this will be replaced by a more powerful mechanism in the future.
16055	</desc>
16056	</attribute>
16057
16058	<attribute name="reuseSingleConnection" type="boolean">
16059	<desc>
16060	Flag whether the existing connection must be dropped and a new connection
16061	must be established by the VRDE server, when a new client connects in single
16062	connection mode.
16063	</desc>
16064	</attribute>
16065
16066	<attribute name="VRDEExtPack" type="wstring">
16067	<desc>
16068	The name of Extension Pack providing VRDE for this VM. Overrides
16069	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16070	</desc>
16071	</attribute>
16072
16073	<attribute name="authLibrary" type="wstring">
16074	<desc>
16075	Library used for authentication of RDP clients by this VM. Overrides
16076	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16077	</desc>
16078	</attribute>
16079
16080	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16081	<desc>
16082	Array of names of properties, which are supported by this VRDE server.
16083	</desc>
16084	</attribute>
16085
16086	<method name="setVRDEProperty">
16087	<desc>
16088	Sets a VRDE specific property string.
16089
16090	If you pass @c null or empty string as a key @a value, the given @a key
16091	will be deleted.
16092
16093	</desc>
16094	<param name="key" type="wstring" dir="in">
16095	<desc>Name of the key to set.</desc>
16096	</param>
16097	<param name="value" type="wstring" dir="in">
16098	<desc>Value to assign to the key.</desc>
16099	</param>
16100	</method>
16101
16102	<method name="getVRDEProperty" const="yes">
16103	<desc>
16104	Returns a VRDE specific property string.
16105
16106	If the requested data @a key does not exist, this function will
16107	succeed and return an empty string in the @a value argument.
16108
16109	</desc>
16110	<param name="key" type="wstring" dir="in">
16111	<desc>Name of the key to get.</desc>
16112	</param>
16113	<param name="value" type="wstring" dir="return">
16114	<desc>Value of the requested key.</desc>
16115	</param>
16116	</method>
16117
16118	</interface>
16119
16120
16121	<!--
16122	// ISharedFolder
16123	/////////////////////////////////////////////////////////////////////////
16124	-->
16125
16126	<interface
16127	name="ISharedFolder" extends="$unknown"
16128	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16129	wsmap="struct"
16130	>
16131	<desc>
16132	The ISharedFolder interface represents a folder in the host computer's
16133	file system accessible from the guest OS running inside a virtual
16134	machine using an associated logical name.
16135
16136	There are three types of shared folders:
16137	<ul>
16138	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16139	folders available to all virtual machines.</li>
16140	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16141	VM-specific shared folders available to the given virtual machine at
16142	startup.</li>
16143	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16144	VM-specific shared folders created in the session context (for
16145	example, when the virtual machine is running) and automatically
16146	discarded when the session is closed (the VM is powered off).</li>
16147	</ul>
16148
16149	Logical names of shared folders must be unique within the given scope
16150	(global, permanent or transient). However, they do not need to be unique
16151	across scopes. In this case, the definition of the shared folder in a
16152	more specific scope takes precedence over definitions in all other
16153	scopes. The order of precedence is (more specific to more general):
16154	<ol>
16155	<li>Transient definitions</li>
16156	<li>Permanent definitions</li>
16157	<li>Global definitions</li>
16158	</ol>
16159
16160	For example, if MyMachine has a shared folder named
16161	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16162	transient shared folder named <tt>C_DRIVE</tt> (that points
16163	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16164	of <tt>C_DRIVE</tt> in the guest OS so
16165	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16166	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16167	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16168	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16169	to <tt>C:\\</tt> if it still exists.
16170
16171	Note that permanent and transient shared folders of different machines
16172	are in different name spaces, so they don't overlap and don't need to
16173	have unique logical names.
16174
16175	<note>
16176	Global shared folders are not implemented in the current version of the
16177	product.
16178	</note>
16179	</desc>
16180
16181	<attribute name="name" type="wstring" readonly="yes">
16182	<desc>Logical name of the shared folder.</desc>
16183	</attribute>
16184
16185	<attribute name="hostPath" type="wstring" readonly="yes">
16186	<desc>Full path to the shared folder in the host file system.</desc>
16187	</attribute>
16188
16189	<attribute name="accessible" type="boolean" readonly="yes">
16190	<desc>
16191	Whether the folder defined by the host path is currently
16192	accessible or not.
16193	For example, the folder can be inaccessible if it is placed
16194	on the network share that is not available by the time
16195	this property is read.
16196	</desc>
16197	</attribute>
16198
16199	<attribute name="writable" type="boolean" readonly="yes">
16200	<desc>
16201	Whether the folder defined by the host path is writable or
16202	not.
16203	</desc>
16204	</attribute>
16205
16206	<attribute name="autoMount" type="boolean" readonly="yes">
16207	<desc>
16208	Whether the folder gets automatically mounted by the guest or not.
16209	</desc>
16210	</attribute>
16211
16212	<attribute name="lastAccessError" type="wstring" readonly="yes">
16213	<desc>
16214	Text message that represents the result of the last accessibility
16215	check.
16216
16217	Accessibility checks are performed each time the <link to="#accessible"/>
16218	attribute is read. An empty string is returned if the last
16219	accessibility check was successful. A non-empty string indicates a
16220	failure and should normally describe a reason of the failure (for
16221	example, a file read error).
16222	</desc>
16223	</attribute>
16224
16225	</interface>
16226
16227	<!--
16228	// ISession
16229	/////////////////////////////////////////////////////////////////////////
16230	-->
16231
16232	<interface
16233	name="IInternalSessionControl" extends="$unknown"
16234	uuid="9ddb5449-f463-47cb-a717-d6f22da3b3a2"
16235	internal="yes"
16236	wsmap="suppress"
16237	>
16238	<method name="getPID">
16239	<desc>PID of the process that has created this Session object.
16240	</desc>
16241	<param name="pid" type="unsigned long" dir="return"/>
16242	</method>
16243
16244	<method name="getRemoteConsole">
16245	<desc>
16246	Returns the console object suitable for remote control.
16247
16248	<result name="VBOX_E_INVALID_VM_STATE">
16249	Session state prevents operation.
16250	</result>
16251	<result name="VBOX_E_INVALID_OBJECT_STATE">
16252	Session type prevents operation.
16253	</result>
16254
16255	</desc>
16256	<param name="console" type="IConsole" dir="return"/>
16257	</method>
16258
16259	<method name="assignMachine">
16260	<desc>
16261	Assigns the machine object associated with this direct-type
16262	session or informs the session that it will be a remote one
16263	(if @a machine == @c null).
16264
16265	<result name="VBOX_E_INVALID_VM_STATE">
16266	Session state prevents operation.
16267	</result>
16268	<result name="VBOX_E_INVALID_OBJECT_STATE">
16269	Session type prevents operation.
16270	</result>
16271
16272	</desc>
16273	<param name="machine" type="IMachine" dir="in"/>
16274	</method>
16275
16276	<method name="assignRemoteMachine">
16277	<desc>
16278	Assigns the machine and the (remote) console object associated with
16279	this remote-type session.
16280
16281	<result name="VBOX_E_INVALID_VM_STATE">
16282	Session state prevents operation.
16283	</result>
16284
16285	</desc>
16286	<param name="machine" type="IMachine" dir="in"/>
16287	<param name="console" type="IConsole" dir="in"/>
16288	</method>
16289
16290	<method name="updateMachineState">
16291	<desc>
16292	Updates the machine state in the VM process.
16293	Must be called only in certain cases
16294	(see the method implementation).
16295
16296	<result name="VBOX_E_INVALID_VM_STATE">
16297	Session state prevents operation.
16298	</result>
16299	<result name="VBOX_E_INVALID_OBJECT_STATE">
16300	Session type prevents operation.
16301	</result>
16302
16303	</desc>
16304	<param name="aMachineState" type="MachineState" dir="in"/>
16305	</method>
16306
16307	<method name="uninitialize">
16308	<desc>
16309	Uninitializes (closes) this session. Used by VirtualBox to close
16310	the corresponding remote session when the direct session dies
16311	or gets closed.
16312
16313	<result name="VBOX_E_INVALID_VM_STATE">
16314	Session state prevents operation.
16315	</result>
16316
16317	</desc>
16318	</method>
16319
16320	<method name="onNetworkAdapterChange">
16321	<desc>
16322	Triggered when settings of a network adapter of the
16323	associated virtual machine have changed.
16324
16325	<result name="VBOX_E_INVALID_VM_STATE">
16326	Session state prevents operation.
16327	</result>
16328	<result name="VBOX_E_INVALID_OBJECT_STATE">
16329	Session type prevents operation.
16330	</result>
16331
16332	</desc>
16333	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16334	<param name="changeAdapter" type="boolean" dir="in"/>
16335	</method>
16336
16337	<method name="onSerialPortChange">
16338	<desc>
16339	Triggered when settings of a serial port of the
16340	associated virtual machine have changed.
16341
16342	<result name="VBOX_E_INVALID_VM_STATE">
16343	Session state prevents operation.
16344	</result>
16345	<result name="VBOX_E_INVALID_OBJECT_STATE">
16346	Session type prevents operation.
16347	</result>
16348
16349	</desc>
16350	<param name="serialPort" type="ISerialPort" dir="in"/>
16351	</method>
16352
16353	<method name="onParallelPortChange">
16354	<desc>
16355	Triggered when settings of a parallel port of the
16356	associated virtual machine have changed.
16357
16358	<result name="VBOX_E_INVALID_VM_STATE">
16359	Session state prevents operation.
16360	</result>
16361	<result name="VBOX_E_INVALID_OBJECT_STATE">
16362	Session type prevents operation.
16363	</result>
16364
16365	</desc>
16366	<param name="parallelPort" type="IParallelPort" dir="in"/>
16367	</method>
16368
16369	<method name="onStorageControllerChange">
16370	<desc>
16371	Triggered when settings of a storage controller of the
16372	associated virtual machine have changed.
16373
16374	<result name="VBOX_E_INVALID_VM_STATE">
16375	Session state prevents operation.
16376	</result>
16377	<result name="VBOX_E_INVALID_OBJECT_STATE">
16378	Session type prevents operation.
16379	</result>
16380
16381	</desc>
16382	</method>
16383
16384	<method name="onMediumChange">
16385	<desc>
16386	Triggered when attached media of the
16387	associated virtual machine have changed.
16388
16389	<result name="VBOX_E_INVALID_VM_STATE">
16390	Session state prevents operation.
16391	</result>
16392	<result name="VBOX_E_INVALID_OBJECT_STATE">
16393	Session type prevents operation.
16394	</result>
16395
16396	</desc>
16397
16398	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16399	<desc>The medium attachment which changed.</desc>
16400	</param>
16401	<param name="force" type="boolean" dir="in">
16402	<desc>If the medium change was forced.</desc>
16403	</param>
16404	</method>
16405
16406	<method name="onStorageDeviceChange">
16407	<desc>
16408	Triggered when attached storage devices of the
16409	associated virtual machine have changed.
16410
16411	<result name="VBOX_E_INVALID_VM_STATE">
16412	Session state prevents operation.
16413	</result>
16414	<result name="VBOX_E_INVALID_OBJECT_STATE">
16415	Session type prevents operation.
16416	</result>
16417
16418	</desc>
16419
16420	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16421	<desc>The medium attachment which changed.</desc>
16422	</param>
16423	<param name="remove" type="boolean" dir="in">
16424	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16425	</param>
16426	</method>
16427
16428	<method name="onClipboardModeChange">
16429	<desc>
16430	Notification when the shared clipboard mode changes.
16431	</desc>
16432	<param name="clipboardMode" type="ClipboardMode" dir="in">
16433	<desc>The new shared clipboard mode.</desc>
16434	</param>
16435	</method>
16436
16437	<method name="onCPUChange">
16438	<desc>
16439	Notification when a CPU changes.
16440	</desc>
16441	<param name="cpu" type="unsigned long" dir="in">
16442	<desc>The CPU which changed</desc>
16443	</param>
16444	<param name="add" type="boolean" dir="in">
16445	<desc>Flag whether the CPU was added or removed</desc>
16446	</param>
16447	</method>
16448
16449	<method name="onCPUExecutionCapChange">
16450	<desc>
16451	Notification when the CPU execution cap changes.
16452	</desc>
16453	<param name="executionCap" type="unsigned long" dir="in">
16454	<desc>The new CPU execution cap value. (1-100)</desc>
16455	</param>
16456	</method>
16457
16458	<method name="onVRDEServerChange">
16459	<desc>
16460	Triggered when settings of the VRDE server object 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	<param name="restart" type="boolean" dir="in">
16472	<desc>Flag whether the server must be restarted</desc>
16473	</param>
16474	</method>
16475
16476	<method name="onUSBControllerChange">
16477	<desc>
16478	Triggered when settings of the USB controller object of the
16479	associated virtual machine have changed.
16480
16481	<result name="VBOX_E_INVALID_VM_STATE">
16482	Session state prevents operation.
16483	</result>
16484	<result name="VBOX_E_INVALID_OBJECT_STATE">
16485	Session type prevents operation.
16486	</result>
16487
16488	</desc>
16489	</method>
16490
16491	<method name="onSharedFolderChange">
16492	<desc>
16493	Triggered when a permanent (global or machine) shared folder has been
16494	created or removed.
16495	<note>
16496	We don't pass shared folder parameters in this notification because
16497	the order in which parallel notifications are delivered is not defined,
16498	therefore it could happen that these parameters were outdated by the
16499	time of processing this notification.
16500	</note>
16501
16502	<result name="VBOX_E_INVALID_VM_STATE">
16503	Session state prevents operation.
16504	</result>
16505	<result name="VBOX_E_INVALID_OBJECT_STATE">
16506	Session type prevents operation.
16507	</result>
16508
16509	</desc>
16510	<param name="global" type="boolean" dir="in"/>
16511	</method>
16512
16513	<method name="onUSBDeviceAttach">
16514	<desc>
16515	Triggered when a request to capture a USB device (as a result
16516	of matched USB filters or direct call to
16517	<link to="IConsole::attachUSBDevice"/>) has completed.
16518	A @c null @a error object means success, otherwise it
16519	describes a failure.
16520
16521	<result name="VBOX_E_INVALID_VM_STATE">
16522	Session state prevents operation.
16523	</result>
16524	<result name="VBOX_E_INVALID_OBJECT_STATE">
16525	Session type prevents operation.
16526	</result>
16527
16528	</desc>
16529	<param name="device" type="IUSBDevice" dir="in"/>
16530	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16531	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
16532	</method>
16533
16534	<method name="onUSBDeviceDetach">
16535	<desc>
16536	Triggered when a request to release the USB device (as a result
16537	of machine termination or direct call to
16538	<link to="IConsole::detachUSBDevice"/>) has completed.
16539	A @c null @a error object means success, otherwise it
16540	describes a failure.
16541
16542	<result name="VBOX_E_INVALID_VM_STATE">
16543	Session state prevents operation.
16544	</result>
16545	<result name="VBOX_E_INVALID_OBJECT_STATE">
16546	Session type prevents operation.
16547	</result>
16548
16549	</desc>
16550	<param name="id" type="uuid" mod="string" dir="in"/>
16551	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16552	</method>
16553
16554	<method name="onShowWindow">
16555	<desc>
16556	Called by <link to="IMachine::canShowConsoleWindow"/> and by
16557	<link to="IMachine::showConsoleWindow"/> in order to notify
16558	console listeners
16559	<link to="ICanShowWindowEvent"/>
16560	and <link to="IShowWindowEvent"/>.
16561
16562	<result name="VBOX_E_INVALID_OBJECT_STATE">
16563	Session type prevents operation.
16564	</result>
16565
16566	</desc>
16567	<param name="check" type="boolean" dir="in"/>
16568	<param name="canShow" type="boolean" dir="out"/>
16569	<param name="winId" type="long long" dir="out"/>
16570	</method>
16571
16572	<method name="onBandwidthGroupChange">
16573	<desc>
16574	Notification when one of the bandwidth groups change.
16575	</desc>
16576	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
16577	<desc>The bandwidth group which changed.</desc>
16578	</param>
16579	</method>
16580
16581	<method name="accessGuestProperty">
16582	<desc>
16583	Called by <link to="IMachine::getGuestProperty"/> and by
16584	<link to="IMachine::setGuestProperty"/> in order to read and
16585	modify guest properties.
16586
16587	<result name="VBOX_E_INVALID_VM_STATE">
16588	Machine session is not open.
16589	</result>
16590	<result name="VBOX_E_INVALID_OBJECT_STATE">
16591	Session type is not direct.
16592	</result>
16593
16594	</desc>
16595	<param name="name" type="wstring" dir="in"/>
16596	<param name="value" type="wstring" dir="in"/>
16597	<param name="flags" type="wstring" dir="in"/>
16598	<param name="isSetter" type="boolean" dir="in"/>
16599	<param name="retValue" type="wstring" dir="out"/>
16600	<param name="retTimestamp" type="long long" dir="out"/>
16601	<param name="retFlags" type="wstring" dir="out"/>
16602	</method>
16603
16604	<method name="enumerateGuestProperties" const="yes">
16605	<desc>
16606	Return a list of the guest properties matching a set of patterns along
16607	with their values, time stamps and flags.
16608
16609	<result name="VBOX_E_INVALID_VM_STATE">
16610	Machine session is not open.
16611	</result>
16612	<result name="VBOX_E_INVALID_OBJECT_STATE">
16613	Session type is not direct.
16614	</result>
16615
16616	</desc>
16617	<param name="patterns" type="wstring" dir="in">
16618	<desc>
16619	The patterns to match the properties against as a comma-separated
16620	string. If this is empty, all properties currently set will be
16621	returned.
16622	</desc>
16623	</param>
16624	<param name="key" type="wstring" dir="out" safearray="yes">
16625	<desc>
16626	The key names of the properties returned.
16627	</desc>
16628	</param>
16629	<param name="value" type="wstring" dir="out" safearray="yes">
16630	<desc>
16631	The values of the properties returned. The array entries match the
16632	corresponding entries in the @a key array.
16633	</desc>
16634	</param>
16635	<param name="timestamp" type="long long" dir="out" safearray="yes">
16636	<desc>
16637	The time stamps of the properties returned. The array entries match
16638	the corresponding entries in the @a key array.
16639	</desc>
16640	</param>
16641	<param name="flags" type="wstring" dir="out" safearray="yes">
16642	<desc>
16643	The flags of the properties returned. The array entries match the
16644	corresponding entries in the @a key array.
16645	</desc>
16646	</param>
16647	</method>
16648
16649	<method name="onlineMergeMedium">
16650	<desc>
16651	Triggers online merging of a hard disk. Used internally when deleting
16652	a snapshot while a VM referring to the same hard disk chain is running.
16653
16654	<result name="VBOX_E_INVALID_VM_STATE">
16655	Machine session is not open.
16656	</result>
16657	<result name="VBOX_E_INVALID_OBJECT_STATE">
16658	Session type is not direct.
16659	</result>
16660
16661	</desc>
16662	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16663	<desc>The medium attachment to identify the medium chain.</desc>
16664	</param>
16665	<param name="sourceIdx" type="unsigned long" dir="in">
16666	<desc>The index of the source image in the chain.
16667	Redundant, but drastically reduces IPC.</desc>
16668	</param>
16669	<param name="targetIdx" type="unsigned long" dir="in">
16670	<desc>The index of the target image in the chain.
16671	Redundant, but drastically reduces IPC.</desc>
16672	</param>
16673	<param name="source" type="IMedium" dir="in">
16674	<desc>Merge source medium.</desc>
16675	</param>
16676	<param name="target" type="IMedium" dir="in">
16677	<desc>Merge target medium.</desc>
16678	</param>
16679	<param name="mergeForward" type="boolean" dir="in">
16680	<desc>Merge direction.</desc>
16681	</param>
16682	<param name="parentForTarget" type="IMedium" dir="in">
16683	<desc>For forward merges: new parent for target medium.</desc>
16684	</param>
16685	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
16686	<desc>For backward merges: list of media which need their parent UUID
16687	updated.</desc>
16688	</param>
16689	<param name="progress" type="IProgress" dir="in">
16690	<desc>
16691	Progress object for this operation.
16692	</desc>
16693	</param>
16694	</method>
16695
16696	<method name="enableVMMStatistics">
16697	<desc>
16698	Enables or disables collection of VMM RAM statistics.
16699
16700	<result name="VBOX_E_INVALID_VM_STATE">
16701	Machine session is not open.
16702	</result>
16703	<result name="VBOX_E_INVALID_OBJECT_STATE">
16704	Session type is not direct.
16705	</result>
16706
16707	</desc>
16708	<param name="enable" type="boolean" dir="in">
16709	<desc>True enables statistics collection.</desc>
16710	</param>
16711	</method>
16712
16713	</interface>
16714
16715	<interface
16716	name="ISession" extends="$unknown"
16717	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
16718	wsmap="managed"
16719	>
16720	<desc>
16721	The ISession interface represents a client process and allows for locking
16722	virtual machines (represented by IMachine objects) to prevent conflicting
16723	changes to the machine.
16724
16725	Any caller wishing to manipulate a virtual machine needs to create a session
16726	object first, which lives in its own process space. Such session objects are
16727	then associated with <link to="IMachine" /> objects living in the VirtualBox
16728	server process to coordinate such changes.
16729
16730	There are two typical scenarios in which sessions are used:
16731
16732	<ul>
16733	<li>To alter machine settings or control a running virtual machine, one
16734	needs to lock a machine for a given session (client process) by calling
16735	<link to="IMachine::lockMachine"/>.
16736
16737	Whereas multiple sessions may control a running virtual machine, only
16738	one process can obtain a write lock on the machine to prevent conflicting
16739	changes. A write lock is also needed if a process wants to actually run a
16740	virtual machine in its own context, such as the VirtualBox GUI or
16741	VBoxHeadless front-ends. They must also lock a machine for their own
16742	sessions before they are allowed to power up the virtual machine.
16743
16744	As a result, no machine settings can be altered while another process is
16745	already using it, either because that process is modifying machine settings
16746	or because the machine is running.
16747	</li>
16748	<li>
16749	To start a VM using one of the existing VirtualBox front-ends (e.g. the
16750	VirtualBox GUI or VBoxHeadless), one would use
16751	<link to="IMachine::launchVMProcess"/>, which also takes a session object
16752	as its first parameter. This session then identifies the caller and lets the
16753	caller control the started machine (for example, pause machine execution or
16754	power it down) as well as be notified about machine execution state changes.
16755	</li>
16756	</ul>
16757
16758	How sessions objects are created in a client process depends on whether you use
16759	the Main API via COM or via the webservice:
16760
16761	<ul>
16762	<li>When using the COM API directly, an object of the Session class from the
16763	VirtualBox type library needs to be created. In regular COM C++ client code,
16764	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
16765	This object will then act as a local session object in further calls to open
16766	a session.
16767	</li>
16768
16769	<li>In the webservice, the session manager (IWebsessionManager) instead creates
16770	a session object automatically whenever <link to="IWebsessionManager::logon" />
16771	is called. A managed object reference to that session object can be retrieved by
16772	calling <link to="IWebsessionManager::getSessionObject" />.
16773	</li>
16774	</ul>
16775	</desc>
16776
16777	<attribute name="state" type="SessionState" readonly="yes">
16778	<desc>Current state of this session.</desc>
16779	</attribute>
16780
16781	<attribute name="type" type="SessionType" readonly="yes">
16782	<desc>
16783	Type of this session. The value of this attribute is valid only
16784	if the session currently has a machine locked (i.e. its
16785	<link to="#state" /> is Locked), otherwise an error will be returned.
16786	</desc>
16787	</attribute>
16788
16789	<attribute name="machine" type="IMachine" readonly="yes">
16790	<desc>Machine object associated with this session.</desc>
16791	</attribute>
16792
16793	<attribute name="console" type="IConsole" readonly="yes">
16794	<desc>Console object associated with this session.</desc>
16795	</attribute>
16796
16797	<method name="unlockMachine">
16798	<desc>
16799	Unlocks a machine that was previously locked for the current session.
16800
16801	Calling this method is required every time a machine has been locked
16802	for a particular session using the <link to="IMachine::launchVMProcess" />
16803	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
16804	the machine will be set to <link to="MachineState_Aborted" /> on the
16805	server, and changes made to the machine settings will be lost.
16806
16807	Generally, it is recommended to unlock all machines explicitly
16808	before terminating the application (regardless of the reason for
16809	the termination).
16810
16811	<note>
16812	Do not expect the session state (<link to="ISession::state" />
16813	to return to "Unlocked" immediately after you invoke this method,
16814	particularly if you have started a new VM process. The session
16815	state will automatically return to "Unlocked" once the VM is no
16816	longer executing, which can of course take a very long time.
16817	</note>
16818
16819	<result name="E_UNEXPECTED">
16820	Session is not locked.
16821	</result>
16822
16823	</desc>
16824	</method>
16825
16826	</interface>
16827
16828	<!--
16829	// IStorageController
16830	/////////////////////////////////////////////////////////////////////////
16831	-->
16832
16833	<enum
16834	name="StorageBus"
16835	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
16836	>
16837	<desc>
16838	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
16839	see <link to="IStorageController::bus" />.
16840	</desc>
16841	<const name="Null" value="0">
16842	<desc>@c null value. Never used by the API.</desc>
16843	</const>
16844	<const name="IDE" value="1"/>
16845	<const name="SATA" value="2"/>
16846	<const name="SCSI" value="3"/>
16847	<const name="Floppy" value="4"/>
16848	<const name="SAS" value="5"/>
16849	</enum>
16850
16851	<enum
16852	name="StorageControllerType"
16853	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
16854	>
16855	<desc>
16856	The exact variant of storage controller hardware presented
16857	to the guest; see <link to="IStorageController::controllerType" />.
16858	</desc>
16859
16860	<const name="Null" value="0">
16861	<desc>@c null value. Never used by the API.</desc>
16862	</const>
16863	<const name="LsiLogic" value="1">
16864	<desc>A SCSI controller of the LsiLogic variant.</desc>
16865	</const>
16866	<const name="BusLogic" value="2">
16867	<desc>A SCSI controller of the BusLogic variant.</desc>
16868	</const>
16869	<const name="IntelAhci" value="3">
16870	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
16871	</const>
16872	<const name="PIIX3" value="4">
16873	<desc>An IDE controller of the PIIX3 variant.</desc>
16874	</const>
16875	<const name="PIIX4" value="5">
16876	<desc>An IDE controller of the PIIX4 variant.</desc>
16877	</const>
16878	<const name="ICH6" value="6">
16879	<desc>An IDE controller of the ICH6 variant.</desc>
16880	</const>
16881	<const name="I82078" value="7">
16882	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
16883	</const>
16884	<const name="LsiLogicSas" value="8">
16885	<desc>A variant of the LsiLogic controller using SAS.</desc>
16886	</const>
16887	</enum>
16888
16889	<enum
16890	name="ChipsetType"
16891	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
16892	>
16893	<desc>
16894	Type of emulated chipset (mostly southbridge).
16895	</desc>
16896
16897	<const name="Null" value="0">
16898	<desc>@c null value. Never used by the API.</desc>
16899	</const>
16900	<const name="PIIX3" value="1">
16901	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
16902	</const>
16903	<const name="ICH9" value="2">
16904	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
16905	</const>
16906	</enum>
16907
16908	<interface
16909	name="IStorageController" extends="$unknown"
16910	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
16911	wsmap="managed"
16912	>
16913	<desc>
16914	Represents a storage controller that is attached to a virtual machine
16915	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
16916	attached to storage controllers in a real computer, virtual drives
16917	(represented by <link to="IMediumAttachment" />) are attached to virtual
16918	storage controllers, represented by this interface.
16919
16920	As opposed to physical hardware, VirtualBox has a very generic concept
16921	of a storage controller, and for purposes of the Main API, all virtual
16922	storage is attached to virtual machines via instances of this interface.
16923	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
16924	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
16925	is used, certain sub-types may be available and can be selected in
16926	<link to="#controllerType" />.
16927
16928	Depending on these settings, the guest operating system might see
16929	significantly different virtual hardware.
16930	</desc>
16931
16932	<attribute name="name" type="wstring" readonly="yes">
16933	<desc>
16934	Name of the storage controller, as originally specified with
16935	<link to="IMachine::addStorageController" />. This then uniquely
16936	identifies this controller with other method calls such as
16937	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
16938	</desc>
16939	</attribute>
16940
16941	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
16942	<desc>
16943	Maximum number of devices which can be attached to one port.
16944	</desc>
16945	</attribute>
16946
16947	<attribute name="minPortCount" type="unsigned long" readonly="yes">
16948	<desc>
16949	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
16950	</desc>
16951	</attribute>
16952
16953	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
16954	<desc>
16955	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
16956	</desc>
16957	</attribute>
16958
16959	<attribute name="instance" type="unsigned long">
16960	<desc>
16961	The instance number of the device in the running VM.
16962	</desc>
16963	</attribute>
16964
16965	<attribute name="portCount" type="unsigned long">
16966	<desc>
16967	The number of currently usable ports on the controller.
16968	The minimum and maximum number of ports for one controller are
16969	stored in <link to="IStorageController::minPortCount"/>
16970	and <link to="IStorageController::maxPortCount"/>.
16971	</desc>
16972	</attribute>
16973
16974	<attribute name="bus" type="StorageBus" readonly="yes">
16975	<desc>
16976	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
16977	</desc>
16978	</attribute>
16979
16980	<attribute name="controllerType" type="StorageControllerType">
16981	<desc>
16982	The exact variant of storage controller hardware presented
16983	to the guest.
16984	Depending on this value, VirtualBox will provide a different
16985	virtual storage controller hardware to the guest.
16986	For SATA, SAS and floppy controllers, only one variant is
16987	available, but for IDE and SCSI, there are several.
16988
16989	For SCSI controllers, the default type is LsiLogic.
16990	</desc>
16991	</attribute>
16992
16993	<attribute name="useHostIOCache" type="boolean">
16994	<desc>
16995	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
16996	caches and use synchronous file APIs on the host. This was the only option in the API before
16997	VirtualBox 3.2 and is still the default for IDE controllers.
16998
16999	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17000	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17001	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17002	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17003	virtual machines are running at the same time to prevent I/O cache related hangs.
17004	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17005	</desc>
17006	</attribute>
17007
17008	<attribute name="bootable" type="boolean" readonly="yes">
17009	<desc>
17010	Returns whether it is possible to boot from disks attached to this controller.
17011	</desc>
17012	</attribute>
17013
17014	<method name="getIDEEmulationPort">
17015	<desc>
17016	Gets the corresponding port number which is emulated as an IDE device.
17017	Works only with SATA controllers.
17018
17019	<result name="E_INVALIDARG">
17020	The @a devicePosition is not in the range 0 to 3.
17021	</result>
17022	<result name="E_NOTIMPL">
17023	The storage controller type is not SATAIntelAhci.
17024	</result>
17025
17026	</desc>
17027	<param name="devicePosition" type="long" dir="in"/>
17028	<param name="portNumber" type="long" dir="return"/>
17029	</method>
17030
17031	<method name="setIDEEmulationPort">
17032	<desc>
17033	Sets the port number which is emulated as an IDE device.
17034	Works only with SATA controllers.
17035
17036	<result name="E_INVALIDARG">
17037	The @a devicePosition is not in the range 0 to 3 or the
17038	@a portNumber is not in the range 0 to 29.
17039	</result>
17040	<result name="E_NOTIMPL">
17041	The storage controller type is not SATAIntelAhci.
17042	</result>
17043
17044	</desc>
17045	<param name="devicePosition" type="long" dir="in"/>
17046	<param name="portNumber" type="long" dir="in"/>
17047	</method>
17048
17049	</interface>
17050
17051	<if target="wsdl">
17052
17053	<!--
17054	// IManagedObjectRef
17055	/////////////////////////////////////////////////////////////////////////
17056	-->
17057
17058	<interface
17059	name="IManagedObjectRef" extends="$unknown"
17060	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17061	internal="yes"
17062	wsmap="managed"
17063	wscpp="hardcoded"
17064	>
17065	<desc>
17066	Managed object reference.
17067
17068	Only within the webservice, a managed object reference (which is really
17069	an opaque number) allows a webservice client to address an object
17070	that lives in the address space of the webservice server.
17071
17072	Behind each managed object reference, there is a COM object that lives
17073	in the webservice server's address space. The COM object is not freed
17074	until the managed object reference is released, either by an explicit
17075	call to <link to="IManagedObjectRef::release" /> or by logging off from
17076	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17077	all objects created during the webservice session.
17078
17079	Whenever a method call of the VirtualBox API returns a COM object, the
17080	webservice representation of that method will instead return a
17081	managed object reference, which can then be used to invoke methods
17082	on that object.
17083	</desc>
17084
17085	<method name="getInterfaceName">
17086	<desc>
17087	Returns the name of the interface that this managed object represents,
17088	for example, "IMachine", as a string.
17089	</desc>
17090	<param name="return" type="wstring" dir="return"/>
17091	</method>
17092
17093	<method name="release">
17094	<desc>
17095	Releases this managed object reference and frees the resources that
17096	were allocated for it in the webservice server process. After calling
17097	this method, the identifier of the reference can no longer be used.
17098	</desc>
17099	</method>
17100
17101	</interface>
17102
17103	<!--
17104	// IWebsessionManager
17105	/////////////////////////////////////////////////////////////////////////
17106	-->
17107
17108	<interface
17109	name="IWebsessionManager" extends="$unknown"
17110	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17111	internal="yes"
17112	wsmap="global"
17113	wscpp="hardcoded"
17114	>
17115	<desc>
17116	Websession manager. This provides essential services
17117	to webservice clients.
17118	</desc>
17119	<method name="logon">
17120	<desc>
17121	Logs a new client onto the webservice and returns a managed object reference to
17122	the IVirtualBox instance, which the client can then use as a basis to further
17123	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17124	interface, in one way or the other.
17125	</desc>
17126	<param name="username" type="wstring" dir="in"/>
17127	<param name="password" type="wstring" dir="in"/>
17128	<param name="return" type="IVirtualBox" dir="return"/>
17129	</method>
17130
17131	<method name="getSessionObject">
17132	<desc>
17133	Returns a managed object reference to the internal ISession object that was created
17134	for this web service session when the client logged on.
17135
17136	<see><link to="ISession"/></see>
17137	</desc>
17138	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17139	<param name="return" type="ISession" dir="return"/>
17140	</method>
17141
17142	<method name="logoff">
17143	<desc>
17144	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17145	and destroys all resources associated with the session (most importantly, all
17146	managed objects created in the server while the session was active).
17147	</desc>
17148	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17149	</method>
17150
17151	</interface>
17152
17153	</if>
17154
17155	<!--
17156	// IPerformanceCollector & friends
17157	/////////////////////////////////////////////////////////////////////////
17158	-->
17159
17160	<interface
17161	name="IPerformanceMetric" extends="$unknown"
17162	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17163	>
17164	<desc>
17165	The IPerformanceMetric interface represents parameters of the given
17166	performance metric.
17167	</desc>
17168
17169	<attribute name="metricName" type="wstring" readonly="yes">
17170	<desc>
17171	Name of the metric.
17172	</desc>
17173	</attribute>
17174
17175	<attribute name="object" type="$unknown" readonly="yes">
17176	<desc>
17177	Object this metric belongs to.
17178	</desc>
17179	</attribute>
17180
17181	<attribute name="description" type="wstring" readonly="yes">
17182	<desc>
17183	Textual description of the metric.
17184	</desc>
17185	</attribute>
17186
17187	<attribute name="period" type="unsigned long" readonly="yes">
17188	<desc>
17189	Time interval between samples, measured in seconds.
17190	</desc>
17191	</attribute>
17192
17193	<attribute name="count" type="unsigned long" readonly="yes">
17194	<desc>
17195	Number of recent samples retained by the performance collector for this
17196	metric.
17197
17198	When the collected sample count exceeds this number, older samples
17199	are discarded.
17200	</desc>
17201	</attribute>
17202
17203	<attribute name="unit" type="wstring" readonly="yes">
17204	<desc>
17205	Unit of measurement.
17206	</desc>
17207	</attribute>
17208
17209	<attribute name="minimumValue" type="long" readonly="yes">
17210	<desc>
17211	Minimum possible value of this metric.
17212	</desc>
17213	</attribute>
17214
17215	<attribute name="maximumValue" type="long" readonly="yes">
17216	<desc>
17217	Maximum possible value of this metric.
17218	</desc>
17219	</attribute>
17220	</interface>
17221
17222	<interface
17223	name="IPerformanceCollector" extends="$unknown"
17224	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17225	wsmap="managed"
17226	>
17227	<desc>
17228	The IPerformanceCollector interface represents a service that collects
17229	and stores performance metrics data.
17230
17231	Performance metrics are associated with objects of interfaces like IHost
17232	and IMachine. Each object has a distinct set of performance metrics. The
17233	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17234
17235	Metric data is collected at the specified intervals and is retained
17236	internally. The interval and the number of retained samples can be set
17237	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17238	and collection settings are not persistent, they are discarded as soon as
17239	VBoxSVC process terminates. Moreover, metric settings and data associated
17240	with a particular VM only exist while VM is running. They disappear as
17241	soon as VM shuts down. It is not possible to set up metrics for machines
17242	that are powered off. One needs to start VM first, then set up metric
17243	collection parameters.
17244
17245	Metrics are organized hierarchically, with each level separated by a
17246	slash (/) character. Generally, the scheme for metric names is like this:
17247
17248	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17249
17250	"Category/Metric" together form the base metric name. A base metric is
17251	the smallest unit for which a sampling interval and the number of
17252	retained samples can be set. Only base metrics can be enabled and
17253	disabled. All sub-metrics are collected when their base metric is
17254	collected. Collected values for any set of sub-metrics can be queried
17255	with <link to="IPerformanceCollector::queryMetricsData" />.
17256
17257	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17258	category, "Load" metric, "User" submetric, "average" aggregate. An
17259	aggregate function is computed over all retained data. Valid aggregate
17260	functions are:
17261
17262	<ul>
17263	<li>avg -- average</li>
17264	<li>min -- minimum</li>
17265	<li>max -- maximum</li>
17266	</ul>
17267
17268	When setting up metric parameters, querying metric data, enabling or
17269	disabling metrics wildcards can be used in metric names to specify a
17270	subset of metrics. For example, to select all CPU-related metrics
17271	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17272	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17273
17274	The valid names for base metrics are:
17275
17276	<ul>
17277	<li>CPU/Load</li>
17278	<li>CPU/MHz</li>
17279	<li>RAM/Usage</li>
17280	<li>RAM/VMM</li>
17281	</ul>
17282
17283	The general sequence for collecting and retrieving the metrics is:
17284	<ul>
17285	<li>
17286	Obtain an instance of IPerformanceCollector with
17287	<link to="IVirtualBox::performanceCollector" />
17288	</li>
17289	<li>
17290	Allocate and populate an array with references to objects the metrics
17291	will be collected for. Use references to IHost and IMachine objects.
17292	</li>
17293	<li>
17294	Allocate and populate an array with base metric names the data will
17295	be collected for.
17296	</li>
17297	<li>
17298	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17299	the metric data will be collected and stored.
17300	</li>
17301	<li>
17302	Wait for the data to get collected.
17303	</li>
17304	<li>
17305	Allocate and populate an array with references to objects the metric
17306	values will be queried for. You can re-use the object array used for
17307	setting base metrics.
17308	</li>
17309	<li>
17310	Allocate and populate an array with metric names the data will be
17311	collected for. Note that metric names differ from base metric names.
17312	</li>
17313	<li>
17314	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17315	that have been collected so far are returned. Note that the values
17316	are still retained internally and data collection continues.
17317	</li>
17318	</ul>
17319
17320	For an example of usage refer to the following files in VirtualBox SDK:
17321	<ul>
17322	<li>
17323	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17324	</li>
17325	<li>
17326	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17327	</li>
17328	</ul>
17329	</desc>
17330
17331	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17332	<desc>
17333	Array of unique names of metrics.
17334
17335	This array represents all metrics supported by the performance
17336	collector. Individual objects do not necessarily support all of them.
17337	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17338	list of supported metrics for a particular object.
17339	</desc>
17340	</attribute>
17341
17342	<method name="getMetrics">
17343	<desc>
17344	Returns parameters of specified metrics for a set of objects.
17345	<note>
17346	@c Null metrics array means all metrics. @c Null object array means
17347	all existing objects.
17348	</note>
17349	</desc>
17350	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17351	<desc>
17352	Metric name filter. Currently, only a comma-separated list of metrics
17353	is supported.
17354	</desc>
17355	</param>
17356	<param name="objects" type="$unknown" dir="in" safearray="yes">
17357	<desc>
17358	Set of objects to return metric parameters for.
17359	</desc>
17360	</param>
17361	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17362	<desc>
17363	Array of returned metric parameters.
17364	</desc>
17365	</param>
17366	</method>
17367
17368	<method name="setupMetrics">
17369	<desc>
17370	Sets parameters of specified base metrics for a set of objects. Returns
17371	an array of <link to="IPerformanceMetric" /> describing the metrics
17372	have been affected.
17373	<note>
17374	@c Null or empty metric name array means all metrics. @c Null or
17375	empty object array means all existing objects. If metric name array
17376	contains a single element and object array contains many, the single
17377	metric name array element is applied to each object array element to
17378	form metric/object pairs.
17379	</note>
17380	</desc>
17381	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17382	<desc>
17383	Metric name filter. Comma-separated list of metrics with wildcard
17384	support.
17385	</desc>
17386	</param>
17387	<param name="objects" type="$unknown" dir="in" safearray="yes">
17388	<desc>
17389	Set of objects to setup metric parameters for.
17390	</desc>
17391	</param>
17392	<param name="period" type="unsigned long" dir="in">
17393	<desc>
17394	Time interval in seconds between two consecutive samples of
17395	performance data.
17396	</desc>
17397	</param>
17398	<param name="count" type="unsigned long" dir="in">
17399	<desc>
17400	Number of samples to retain in performance data history. Older
17401	samples get discarded.
17402	</desc>
17403	</param>
17404	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17405	<desc>
17406	Array of metrics that have been modified by the call to this method.
17407	</desc>
17408	</param>
17409	</method>
17410
17411	<method name="enableMetrics">
17412	<desc>
17413	Turns on collecting specified base metrics. Returns an array of
17414	<link to="IPerformanceMetric" /> describing the metrics have been
17415	affected.
17416	<note>
17417	@c Null or empty metric name array means all metrics. @c Null or
17418	empty object array means all existing objects. If metric name array
17419	contains a single element and object array contains many, the single
17420	metric name array element is applied to each object array element to
17421	form metric/object pairs.
17422	</note>
17423	</desc>
17424	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17425	<desc>
17426	Metric name filter. Comma-separated list of metrics with wildcard
17427	support.
17428	</desc>
17429	</param>
17430	<param name="objects" type="$unknown" dir="in" safearray="yes">
17431	<desc>
17432	Set of objects to enable metrics for.
17433	</desc>
17434	</param>
17435	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17436	<desc>
17437	Array of metrics that have been modified by the call to this method.
17438	</desc>
17439	</param>
17440	</method>
17441
17442	<method name="disableMetrics">
17443	<desc>
17444	Turns off collecting specified base metrics. Returns an array of
17445	<link to="IPerformanceMetric" /> describing the metrics have been
17446	affected.
17447	<note>
17448	@c Null or empty metric name array means all metrics. @c Null or
17449	empty object array means all existing objects. If metric name array
17450	contains a single element and object array contains many, the single
17451	metric name array element is applied to each object array element to
17452	form metric/object pairs.
17453	</note>
17454	</desc>
17455	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17456	<desc>
17457	Metric name filter. Comma-separated list of metrics with wildcard
17458	support.
17459	</desc>
17460	</param>
17461	<param name="objects" type="$unknown" dir="in" safearray="yes">
17462	<desc>
17463	Set of objects to disable metrics for.
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="queryMetricsData">
17474	<desc>
17475	Queries collected metrics data for a set of objects.
17476
17477	The data itself and related metric information are returned in seven
17478	parallel and one flattened array of arrays. Elements of
17479	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17480	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17481	the same index describe one set of values corresponding to a single
17482	metric.
17483
17484	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17485	start and length of a sub-array is indicated by
17486	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17487	value for metric <tt>metricNames[i]</tt> is at
17488	<tt>returnData[returnIndices[i]]</tt>.
17489
17490	<note>
17491	@c Null or empty metric name array means all metrics. @c Null or
17492	empty object array means all existing objects. If metric name array
17493	contains a single element and object array contains many, the single
17494	metric name array element is applied to each object array element to
17495	form metric/object pairs.
17496	</note>
17497	<note>
17498	Data collection continues behind the scenes after call to @c
17499	queryMetricsData. The return data can be seen as the snapshot of the
17500	current state at the time of @c queryMetricsData call. The internally
17501	kept metric values are not cleared by the call. This makes possible
17502	querying different subsets of metrics or aggregates with subsequent
17503	calls. If periodic querying is needed it is highly suggested to query
17504	the values with @c interval*count period to avoid confusion. This way
17505	a completely new set of data values will be provided by each query.
17506	</note>
17507	</desc>
17508	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17509	<desc>
17510	Metric name filter. Comma-separated list of metrics with wildcard
17511	support.
17512	</desc>
17513	</param>
17514	<param name="objects" type="$unknown" dir="in" safearray="yes">
17515	<desc>
17516	Set of objects to query metrics for.
17517	</desc>
17518	</param>
17519	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
17520	<desc>
17521	Names of metrics returned in @c returnData.
17522	</desc>
17523	</param>
17524	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
17525	<desc>
17526	Objects associated with metrics returned in @c returnData.
17527	</desc>
17528	</param>
17529	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
17530	<desc>
17531	Units of measurement for each returned metric.
17532	</desc>
17533	</param>
17534	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
17535	<desc>
17536	Divisor that should be applied to return values in order to get
17537	floating point values. For example:
17538	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
17539	will retrieve the floating point value of i-th sample of the first
17540	metric.
17541	</desc>
17542	</param>
17543	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
17544	<desc>
17545	Sequence numbers of the first elements of value sequences of
17546	particular metrics returned in @c returnData. For aggregate metrics
17547	it is the sequence number of the sample the aggregate started
17548	calculation from.
17549	</desc>
17550	</param>
17551	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
17552	<desc>
17553	Indices of the first elements of value sequences of particular
17554	metrics returned in @c returnData.
17555	</desc>
17556	</param>
17557	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
17558	<desc>
17559	Lengths of value sequences of particular metrics.
17560	</desc>
17561	</param>
17562	<param name="returnData" type="long" dir="return" safearray="yes">
17563	<desc>
17564	Flattened array of all metric data containing sequences of values for
17565	each metric.
17566	</desc>
17567	</param>
17568	</method>
17569
17570	</interface>
17571
17572	<enum
17573	name="NATAliasMode"
17574	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
17575	>
17576	<desc></desc>
17577	<const name="AliasLog" value="0x1">
17578	<desc></desc>
17579	</const>
17580	<const name="AliasProxyOnly" value="0x02">
17581	<desc></desc>
17582	</const>
17583	<const name="AliasUseSamePorts" value="0x04">
17584	<desc></desc>
17585	</const>
17586	</enum>
17587
17588	<enum
17589	name="NATProtocol"
17590	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
17591	>
17592	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
17593	<const name="UDP" value="0">
17594	<desc>Port-forwarding uses UDP protocol.</desc>
17595	</const>
17596	<const name="TCP" value="1">
17597	<desc>Port-forwarding uses TCP protocol.</desc>
17598	</const>
17599	</enum>
17600
17601	<interface
17602	name="INATEngine" extends="$unknown"
17603	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
17604	wsmap="managed"
17605	>
17606	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
17607	allows for changing NAT behavior such as port-forwarding rules. This interface is
17608	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
17609	<attribute name="network" type="wstring">
17610	<desc>The network attribute of the NAT engine (the same value is used with built-in
17611	DHCP server to fill corresponding fields of DHCP leases).</desc>
17612	</attribute>
17613	<attribute name="hostIP" type="wstring">
17614	<desc>IP of host interface to bind all opened sockets to.
17615	<note>Changing this does not change binding of port forwarding.</note>
17616	</desc>
17617	</attribute>
17618	<attribute name="tftpPrefix" type="wstring">
17619	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
17620	the corresponding fields of DHCP leases.</desc>
17621	</attribute>
17622	<attribute name="tftpBootFile" type="wstring">
17623	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
17624	the corresponding fields of DHCP leases.</desc>
17625	</attribute>
17626	<attribute name="tftpNextServer" type="wstring">
17627	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
17628	the corresponding fields of DHCP leases.
17629	<note>The preferred form is IPv4 addresses.</note>
17630	</desc>
17631	</attribute>
17632	<attribute name="aliasMode" type="unsigned long">
17633	<desc></desc>
17634	</attribute>
17635	<attribute name="dnsPassDomain" type="boolean">
17636	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
17637	</attribute>
17638	<attribute name="dnsProxy" type="boolean">
17639	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17640	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
17641	</attribute>
17642	<attribute name="dnsUseHostResolver" type="boolean">
17643	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17644	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
17645	</attribute>
17646	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
17647	<desc>Array of NAT port-forwarding rules in string representation, in the following
17648	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
17649	</attribute>
17650	<method name="setNetworkSettings">
17651	<desc>Sets network configuration of the NAT engine.</desc>
17652	<param name="mtu" type="unsigned long" dir="in">
17653	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
17654	</param>
17655	<param name="sockSnd" type="unsigned long" dir="in">
17656	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
17657	</param>
17658	<param name="sockRcv" type="unsigned long" dir="in">
17659	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
17660	</param>
17661	<param name="TcpWndSnd" type="unsigned long" dir="in">
17662	<desc>Initial size of the NAT engine's sending TCP window in bytes when
17663	establishing a new TCP connection.</desc>
17664	</param>
17665	<param name="TcpWndRcv" type="unsigned long" dir="in">
17666	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
17667	establishing a new TCP connection.</desc>
17668	</param>
17669	</method>
17670	<method name="getNetworkSettings">
17671	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
17672	for parameter descriptions.</desc>
17673	<param name="mtu" type="unsigned long" dir="out" />
17674	<param name="sockSnd" type="unsigned long" dir="out" />
17675	<param name="sockRcv" type="unsigned long" dir="out" />
17676	<param name="TcpWndSnd" type="unsigned long" dir="out" />
17677	<param name="TcpWndRcv" type="unsigned long" dir="out" />
17678	</method>
17679	<method name="addRedirect">
17680	<desc>Adds a new NAT port-forwarding rule.</desc>
17681	<param name="name" type="wstring" dir="in">
17682	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
17683	auto-generates one using the other parameters.</desc>
17684	</param>
17685	<param name="proto" type="NATProtocol" dir="in">
17686	<desc>Protocol handled with the rule.</desc>
17687	</param>
17688	<param name="hostIp" type="wstring" dir="in">
17689	<desc>IP of the host interface to which the rule should apply. An empty ip address is
17690	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
17691	</param>
17692	<param name="hostPort" type="unsigned short" dir="in">
17693	<desc>The port number to listen on.</desc>
17694	</param>
17695	<param name="guestIp" type="wstring" dir="in">
17696	<desc>The IP address of the guest which the NAT engine will forward matching packets
17697	to. An empty IP address is acceptable, in which case the NAT engine will forward
17698	packets to the first DHCP lease (x.x.x.15).</desc>
17699	</param>
17700	<param name="guestPort" type="unsigned short" dir="in">
17701	<desc>The port number to forward.</desc>
17702	</param>
17703	</method>
17704	<method name="removeRedirect">
17705	<desc>Removes a port-forwarding rule that was previously registered.</desc>
17706	<param name="name" type="wstring" dir="in">
17707	<desc>The name of the rule to delete.</desc>
17708	</param>
17709	</method>
17710	</interface>
17711
17712	<!--
17713	// IExtPackManager
17714	/////////////////////////////////////////////////////////////////////////
17715	-->
17716
17717	<interface
17718	name="IExtPackPlugIn" extends="$unknown"
17719	uuid="58000040-e718-4746-bbce-4b86d96da461"
17720	wsmap="suppress"
17721	>
17722	<desc>
17723	Interface for keeping information about a plug-in that ships with an
17724	extension pack.
17725	</desc>
17726	<attribute name="name" type="wstring" readonly="yes">
17727	<desc>The plug-in name.</desc>
17728	</attribute>
17729	<attribute name="description" type="wstring" readonly="yes">
17730	<desc>The plug-in description.</desc>
17731	</attribute>
17732	<attribute name="frontend" type="wstring" readonly="yes">
17733	<desc>
17734	The name of the frontend or component name this plug-in plugs into.
17735	</desc>
17736	</attribute>
17737	<attribute name="modulePath" type="wstring" readonly="yes">
17738	<desc> The module path. </desc>
17739	</attribute>
17740	</interface>
17741
17742	<interface
17743	name="IExtPackBase" extends="$unknown"
17744	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
17745	wsmap="suppress"
17746	>
17747	<desc>
17748	Interface for querying information about an extension pack as well as
17749	accessing COM objects within it.
17750	</desc>
17751	<attribute name="name" type="wstring" readonly="yes">
17752	<desc>The extension pack name. This is unique.</desc>
17753	</attribute>
17754	<attribute name="description" type="wstring" readonly="yes">
17755	<desc>The extension pack description.</desc>
17756	</attribute>
17757	<attribute name="version" type="wstring" readonly="yes">
17758	<desc>
17759	The extension pack version string. This is restricted to the dotted
17760	version number and optionally a build indicator. No tree revision or
17761	tag will be included in the string as those things are available as
17762	separate properties. An optional publisher tag may be present like for
17763	<link to="IVirtualBox::version"/>.
17764
17765	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
17766	</desc>
17767	</attribute>
17768	<attribute name="revision" type="unsigned long" readonly="yes">
17769	<desc>The extension pack internal revision number.</desc>
17770	</attribute>
17771	<attribute name="edition" type="wstring" readonly="yes">
17772	<desc>
17773	Edition indicator. This is usually empty.
17774
17775	Can for instance be used to help distinguishing between two editions
17776	of the same extension pack where only the license, service contract or
17777	something differs.
17778	</desc>
17779	</attribute>
17780	<attribute name="VRDEModule" type="wstring" readonly="yes">
17781	<desc>The name of the VRDE module if the extension pack sports one.</desc>
17782	</attribute>
17783	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
17784	<desc>Plug-ins provided by this extension pack.</desc>
17785	</attribute>
17786	<attribute name="usable" type="boolean" readonly="yes">
17787	<desc>
17788	Indicates whether the extension pack is usable or not.
17789
17790	There are a number of reasons why an extension pack might be unusable,
17791	typical examples would be broken installation/file or that it is
17792	incompatible with the current VirtualBox version.
17793	</desc>
17794	</attribute>
17795	<attribute name="whyUnusable" type="wstring" readonly="yes">
17796	<desc>
17797	String indicating why the extension pack is not usable. This is an
17798	empty string if usable and always a non-empty string if not usable.
17799	</desc>
17800	</attribute>
17801	<attribute name="showLicense" type="boolean" readonly="yes">
17802	<desc>Whether to show the license before installation</desc>
17803	</attribute>
17804	<attribute name="license" type="wstring" readonly="yes">
17805	<desc>
17806	The default HTML license text for the extension pack. Same as
17807	calling <link to="#queryLicense">queryLicense</link> with
17808	preferredLocale and preferredLanguage as empty strings and format set
17809	to html.
17810	</desc>
17811	</attribute>
17812
17813	<method name="queryLicense">
17814	<desc>
17815	Full feature version of the license attribute.
17816	</desc>
17817	<param name="preferredLocale" type="wstring" dir="in">
17818	<desc>
17819	The preferred license locale. Pass an empty string to get the default
17820	license.
17821	</desc>
17822	</param>
17823	<param name="preferredLanguage" type="wstring" dir="in">
17824	<desc>
17825	The preferred license language. Pass an empty string to get the
17826	default language for the locale.
17827	</desc>
17828	</param>
17829	<param name="format" type="wstring" dir="in">
17830	<desc>
17831	The license format: html, rtf or txt. If a license is present there
17832	will always be an HTML of it, the rich text format (RTF) and plain
17833	text (txt) versions are optional. If
17834	</desc>
17835	</param>
17836	<param name="licenseText" type="wstring" dir="return">
17837	<desc>The license text.</desc>
17838	</param>
17839	</method>
17840
17841	</interface>
17842
17843	<interface
17844	name="IExtPack" extends="IExtPackBase"
17845	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
17846	wsmap="suppress"
17847	>
17848	<desc>
17849	Interface for querying information about an extension pack as well as
17850	accessing COM objects within it.
17851	</desc>
17852	<method name="queryObject">
17853	<desc>
17854	Queries the IUnknown interface to an object in the extension pack
17855	main module. This allows plug-ins and others to talk directly to an
17856	extension pack.
17857	</desc>
17858	<param name="objUuid" type="wstring" dir="in">
17859	<desc>The object ID. What exactly this is </desc>
17860	</param>
17861	<param name="returnInterface" type="$unknown" dir="return">
17862	<desc>The queried interface.</desc>
17863	</param>
17864	</method>
17865	</interface>
17866
17867	<interface
17868	name="IExtPackFile" extends="IExtPackBase"
17869	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
17870	wsmap="suppress"
17871	>
17872	<desc>
17873	Extension pack file (aka tarball, .vbox-extpack) representation returned
17874	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
17875	extension pack information with the addition of the file name.
17876	</desc>
17877	<attribute name="filePath" type="wstring" readonly="yes">
17878	<desc>
17879	The path to the extension pack file.
17880	</desc>
17881	</attribute>
17882
17883	<method name="install">
17884	<desc>
17885	Install the extension pack.
17886	</desc>
17887	<param name="replace" type="boolean" dir="in">
17888	<desc>
17889	Set this to automatically uninstall any existing extension pack with
17890	the same name as the one being installed.
17891	</desc>
17892	</param>
17893	<param name="displayInfo" type="wstring" dir="in">
17894	<desc>
17895	Platform specific display information. Reserved for future hacks.
17896	</desc>
17897	</param>
17898	<param name="progess" type="IProgress" dir="return">
17899	<desc>
17900	Progress object for the operation.
17901	</desc>
17902	</param>
17903	</method>
17904	</interface>
17905
17906	<interface
17907	name="IExtPackManager" extends="$unknown"
17908	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
17909	wsmap="suppress"
17910	>
17911	<desc>
17912	Interface for managing VirtualBox Extension Packs.
17913
17914	TODO: Describe extension packs, how they are managed and how to create
17915	one.
17916	</desc>
17917
17918	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
17919	<desc>
17920	List of the installed extension packs.
17921	</desc>
17922	</attribute>
17923
17924	<method name="find">
17925	<desc>
17926	Returns the extension pack with the specified name if found.
17927
17928	<result name="VBOX_E_OBJECT_NOT_FOUND">
17929	No extension pack matching @a name was found.
17930	</result>
17931	</desc>
17932	<param name="name" type="wstring" dir="in">
17933	<desc>The name of the extension pack to locate.</desc>
17934	</param>
17935	<param name="returnData" type="IExtPack" dir="return">
17936	<desc>The extension pack if found.</desc>
17937	</param>
17938	</method>
17939
17940	<method name="openExtPackFile">
17941	<desc>
17942	Attempts to open an extension pack file in preparation for
17943	installation.
17944	</desc>
17945	<param name="path" type="wstring" dir="in">
17946	<desc>The path of the extension pack tarball. This can optionally be
17947	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
17948	</param>
17949	<param name="file" type="IExtPackFile" dir="return">
17950	<desc>The interface of the extension pack file object.</desc>
17951	</param>
17952	</method>
17953
17954	<method name="uninstall">
17955	<desc>Uninstalls an extension pack, removing all related files.</desc>
17956	<param name="name" type="wstring" dir="in">
17957	<desc>The name of the extension pack to uninstall.</desc>
17958	</param>
17959	<param name="forcedRemoval" type="boolean" dir="in">
17960	<desc>
17961	Forced removal of the extension pack. This means that the uninstall
17962	hook will not be called.
17963	</desc>
17964	</param>
17965	<param name="displayInfo" type="wstring" dir="in">
17966	<desc>
17967	Platform specific display information. Reserved for future hacks.
17968	</desc>
17969	</param>
17970	<param name="progess" type="IProgress" dir="return">
17971	<desc>
17972	Progress object for the operation.
17973	</desc>
17974	</param>
17975	</method>
17976
17977	<method name="cleanup">
17978	<desc>Cleans up failed installs and uninstalls</desc>
17979	</method>
17980
17981	<method name="queryAllPlugInsForFrontend">
17982	<desc>
17983	Gets the path to all the plug-in modules for a given frontend.
17984
17985	This is a convenience method that is intended to simplify the plug-in
17986	loading process for a frontend.
17987	</desc>
17988	<param name="frontendName" type="wstring" dir="in">
17989	<desc>The name of the frontend or component.</desc>
17990	</param>
17991	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
17992	<desc>Array containing the plug-in modules (full paths).</desc>
17993	</param>
17994	</method>
17995
17996	<method name="isExtPackUsable">
17997	<desc>Check if the given extension pack is loaded and usable.</desc>
17998	<param name="name" type="wstring" dir="in">
17999	<desc>The name of the extension pack to check for.</desc>
18000	</param>
18001	<param name="usable" type="boolean" dir="return">
18002	<desc>Is the given extension pack loaded and usable.</desc>
18003	</param>
18004	</method>
18005
18006	</interface>
18007
18008	<!--
18009	// BandwidthGroupType
18010	/////////////////////////////////////////////////////////////////////////
18011	-->
18012	<enum
18013	name="BandwidthGroupType"
18014	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18015
18016	<desc>
18017	Type of a bandwidth control group.
18018	</desc>
18019
18020	<const name="Null" value="0">
18021	<desc>
18022	Null type, must be first.
18023	</desc>
18024	</const>
18025
18026	<const name="Disk" value="1">
18027	<desc>
18028	The bandwidth group controls disk I/O.
18029	</desc>
18030	</const>
18031
18032	<const name="Network" value="2">
18033	<desc>
18034	The bandwidth group controls network I/O.
18035	</desc>
18036	</const>
18037
18038	</enum>
18039
18040	<!--
18041	// IBandwidthGroup
18042	/////////////////////////////////////////////////////////////////////////
18043	-->
18044	<interface
18045	name="IBandwidthGroup" extends="$unknown"
18046	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18047	wsmap="managed"
18048	>
18049	<desc>Represents one bandwidth group.</desc>
18050
18051	<attribute name="name" type="wstring" readonly="yes">
18052	<desc>Name of the group.</desc>
18053	</attribute>
18054
18055	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18056	<desc>Type of the group.</desc>
18057	</attribute>
18058
18059	<attribute name="reference" type="unsigned long" readonly="yes">
18060	<desc>How many devices/medium attachements use this group.</desc>
18061	</attribute>
18062
18063	<attribute name="maxBytesPerSec" type="long long">
18064	<desc>The maximum number of bytes which can be transfered by all
18065	entities attached to this group during one second.</desc>
18066	</attribute>
18067
18068	</interface>
18069
18070	<!--
18071	// IBandwidthControl
18072	/////////////////////////////////////////////////////////////////////////
18073	-->
18074	<interface
18075	name="IBandwidthControl" extends="$unknown"
18076	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18077	wsmap="managed"
18078	>
18079	<desc>
18080	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18081	This includes network and disk I/O.
18082	</desc>
18083
18084	<attribute name="numGroups" type="unsigned long" readonly="yes">
18085	<desc>
18086	The current number of existing bandwidth groups managed.
18087	</desc>
18088	</attribute>
18089
18090	<method name="createBandwidthGroup">
18091	<desc>
18092	Creates a new bandwidth group.
18093	</desc>
18094
18095	<param name="name" type="wstring" dir="in">
18096	<desc>Name of the bandwidth group.</desc>
18097	</param>
18098	<param name="type" type="BandwidthGroupType" dir="in">
18099	<desc>The type of the bandwidth group (network or disk).</desc>
18100	</param>
18101	<param name="maxBytesPerSec" type="long long" dir="in">
18102	<desc>The maximum number of bytes which can be transfered by all
18103	entities attached to this group during one second.</desc>
18104	</param>
18105	</method>
18106
18107	<method name="deleteBandwidthGroup">
18108	<desc>
18109	Deletes a new bandwidth group.
18110	</desc>
18111
18112	<param name="name" type="wstring" dir="in">
18113	<desc>Name of the bandwidth group to delete.</desc>
18114	</param>
18115	</method>
18116
18117	<method name="getBandwidthGroup" const="yes">
18118	<desc>
18119	Get a bandwidth group by name.
18120	</desc>
18121
18122	<param name="name" type="wstring" dir="in">
18123	<desc>Name of the bandwidth group to get.</desc>
18124	</param>
18125	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18126	<desc>Where to store the bandwidth group on success.</desc>
18127	</param>
18128	</method>
18129
18130	<method name="getAllBandwidthGroups" const="yes">
18131	<desc>
18132	Get all managed bandwidth groups.
18133	</desc>
18134
18135	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18136	<desc>The array of managed bandwidth groups.</desc>
18137	</param>
18138	</method>
18139	</interface>
18140
18141	<!--
18142	// IVirtualBoxClient
18143	/////////////////////////////////////////////////////////////////////////
18144	-->
18145
18146	<interface
18147	name="IVirtualBoxClient" extends="$unknown"
18148	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18149	wsmap="suppress"
18150	>
18151	<desc>
18152	Convenience interface for client applications. Treat this as a
18153	singleton, i.e. never create more than one instance of this interface.
18154
18155	At the moment only available for clients of the local API (not usable
18156	via the webservice). Once the session logic is redesigned this might
18157	change.
18158	</desc>
18159
18160	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18161	<desc>
18162	Reference to the server-side API root object.
18163	</desc>
18164	</attribute>
18165
18166	<attribute name="session" type="ISession" readonly="yes">
18167	<desc>
18168	Create a new session object and return the reference to it.
18169	</desc>
18170	</attribute>
18171
18172	<attribute name="eventSource" type="IEventSource" readonly="yes">
18173	<desc>
18174	Event source for VirtualBoxClient events.
18175	</desc>
18176	</attribute>
18177
18178	</interface>
18179
18180	<!--
18181	// Events
18182	/////////////////////////////////////////////////////////////////////////
18183	-->
18184	<enum
18185	name="VBoxEventType"
18186	uuid="100cf5c8-7dd4-4600-8d75-636d211479c9"
18187	>
18188
18189	<desc>
18190	Type of an event.
18191	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18192	</desc>
18193
18194	<const name="Invalid" value="0">
18195	<desc>
18196	Invalid event, must be first.
18197	</desc>
18198	</const>
18199
18200	<const name="Any" value="1">
18201	<desc>
18202	Wildcard for all events.
18203	Events of this type are never delivered, and only used in
18204	<link to="IEventSource::registerListener"/> call to simplify registration.
18205	</desc>
18206	</const>
18207
18208	<const name="Vetoable" value="2">
18209	<desc>
18210	Wildcard for all vetoable events. Events of this type are never delivered, and only
18211	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18212	</desc>
18213	</const>
18214
18215	<const name="MachineEvent" value="3">
18216	<desc>
18217	Wildcard for all machine events. Events of this type are never delivered, and only used in
18218	<link to="IEventSource::registerListener"/> call to simplify registration.
18219	</desc>
18220	</const>
18221
18222	<const name="SnapshotEvent" value="4">
18223	<desc>
18224	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18225	<link to="IEventSource::registerListener"/> call to simplify registration.
18226	</desc>
18227	</const>
18228
18229	<const name="InputEvent" value="5">
18230	<desc>
18231	Wildcard for all input device (keyboard, mouse) events.
18232	Events of this type are never delivered, and only used in
18233	<link to="IEventSource::registerListener"/> call to simplify registration.
18234	</desc>
18235	</const>
18236
18237	<const name="LastWildcard" value="31">
18238	<desc>
18239	Last wildcard.
18240	</desc>
18241	</const>
18242
18243	<const name="OnMachineStateChanged" value="32">
18244	<desc>
18245	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18246	</desc>
18247	</const>
18248	<const name="OnMachineDataChanged" value="33">
18249	<desc>
18250	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18251	</desc>
18252	</const>
18253	<const name="OnExtraDataChanged" value="34">
18254	<desc>
18255	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18256	</desc>
18257	</const>
18258	<const name="OnExtraDataCanChange" value="35">
18259	<desc>
18260	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18261	</desc>
18262	</const>
18263	<const name="OnMediumRegistered" value="36">
18264	<desc>
18265	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18266	</desc>
18267	</const>
18268	<const name="OnMachineRegistered" value="37">
18269	<desc>
18270	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18271	</desc>
18272	</const>
18273	<const name="OnSessionStateChanged" value="38">
18274	<desc>
18275	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18276	</desc>
18277	</const>
18278	<const name="OnSnapshotTaken" value="39">
18279	<desc>
18280	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18281	</desc>
18282	</const>
18283	<const name="OnSnapshotDeleted" value="40">
18284	<desc>
18285	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18286	</desc>
18287	</const>
18288	<const name="OnSnapshotChanged" value="41">
18289	<desc>
18290	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18291	</desc>
18292	</const>
18293	<const name="OnGuestPropertyChanged" value="42">
18294	<desc>
18295	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18296	</desc>
18297	</const>
18298	<!-- Console events -->
18299	<const name="OnMousePointerShapeChanged" value="43">
18300	<desc>
18301	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18302	</desc>
18303	</const>
18304	<const name="OnMouseCapabilityChanged" value="44">
18305	<desc>
18306	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18307	</desc>
18308	</const>
18309	<const name="OnKeyboardLedsChanged" value="45">
18310	<desc>
18311	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18312	</desc>
18313	</const>
18314	<const name="OnStateChanged" value="46">
18315	<desc>
18316	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18317	</desc>
18318	</const>
18319	<const name="OnAdditionsStateChanged" value="47">
18320	<desc>
18321	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18322	</desc>
18323	</const>
18324	<const name="OnNetworkAdapterChanged" value="48">
18325	<desc>
18326	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18327	</desc>
18328	</const>
18329	<const name="OnSerialPortChanged" value="49">
18330	<desc>
18331	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18332	</desc>
18333	</const>
18334	<const name="OnParallelPortChanged" value="50">
18335	<desc>
18336	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18337	</desc>
18338	</const>
18339	<const name="OnStorageControllerChanged" value="51">
18340	<desc>
18341	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18342	</desc>
18343	</const>
18344	<const name="OnMediumChanged" value="52">
18345	<desc>
18346	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18347	</desc>
18348	</const>
18349	<const name="OnVRDEServerChanged" value="53">
18350	<desc>
18351	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18352	</desc>
18353	</const>
18354	<const name="OnUSBControllerChanged" value="54">
18355	<desc>
18356	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18357	</desc>
18358	</const>
18359	<const name="OnUSBDeviceStateChanged" value="55">
18360	<desc>
18361	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18362	</desc>
18363	</const>
18364	<const name="OnSharedFolderChanged" value="56">
18365	<desc>
18366	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18367	</desc>
18368	</const>
18369	<const name="OnRuntimeError" value="57">
18370	<desc>
18371	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18372	</desc>
18373	</const>
18374	<const name="OnCanShowWindow" value="58">
18375	<desc>
18376	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18377	</desc>
18378	</const>
18379	<const name="OnShowWindow" value="59">
18380	<desc>
18381	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18382	</desc>
18383	</const>
18384	<const name="OnCPUChanged" value="60">
18385	<desc>
18386	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18387	</desc>
18388	</const>
18389	<const name="OnVRDEServerInfoChanged" value="61">
18390	<desc>
18391	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18392	</desc>
18393	</const>
18394	<const name="OnEventSourceChanged" value="62">
18395	<desc>
18396	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18397	</desc>
18398	</const>
18399	<const name="OnCPUExecutionCapChanged" value="63">
18400	<desc>
18401	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18402	</desc>
18403	</const>
18404	<const name="OnGuestKeyboard" value="64">
18405	<desc>
18406	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18407	</desc>
18408	</const>
18409	<const name="OnGuestMouse" value="65">
18410	<desc>
18411	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18412	</desc>
18413	</const>
18414	<const name="OnNATRedirect" value="66">
18415	<desc>
18416	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18417	</desc>
18418	</const>
18419	<const name="OnHostPciDevicePlug" value="67">
18420	<desc>
18421	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
18422	</desc>
18423	</const>
18424	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18425	<desc>
18426	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18427	</desc>
18428	</const>
18429	<const name="OnBandwidthGroupChanged" value="69">
18430	<desc>
18431	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18432	</desc>
18433	</const>
18434	<const name="OnGuestMonitorChanged" value="70">
18435	<desc>
18436	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18437	</desc>
18438	</const>
18439	<const name="OnStorageDeviceChanged" value="71">
18440	<desc>
18441	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18442	</desc>
18443	</const>
18444	<const name="OnClipboardModeChanged" value="72">
18445	<desc>
18446	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18447	</desc>
18448	</const>
18449
18450	<!-- Last event marker -->
18451	<const name="Last" value="73">
18452	<desc>
18453	Must be last event, used for iterations and structures relying on numerical event values.
18454	</desc>
18455	</const>
18456
18457	</enum>
18458
18459	<interface
18460	name="IEventSource" extends="$unknown"
18461	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
18462	wsmap="managed"
18463	>
18464	<desc>
18465	Event source. Generally, any object which could generate events can be an event source,
18466	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
18467	an event source can work with listeners in either active or passive mode. In active mode it is up to
18468	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
18469	event source keeps track of pending events for each listener and returns available events on demand.
18470
18471	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18472	</desc>
18473
18474	<method name="createListener">
18475	<desc>
18476	Creates a new listener object, useful for passive mode.
18477	</desc>
18478	<param name="listener" type="IEventListener" dir="return"/>
18479	</method>
18480
18481	<method name="createAggregator">
18482	<desc>
18483	Creates an aggregator event source, collecting events from multiple sources.
18484	This way a single listener can listen for events coming from multiple sources,
18485	using a single blocking <link to="#getEvent"/> on the returned aggregator.
18486	</desc>
18487	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
18488	<desc>
18489	Subordinate event source this one aggregatres.
18490	</desc>
18491	</param>
18492	<param name="result" type="IEventSource" dir="return">
18493	<desc>
18494	Event source aggregating passed sources.
18495	</desc>
18496	</param>
18497	</method>
18498
18499	<method name="registerListener">
18500	<desc>
18501	Register an event listener.
18502
18503	<note>
18504	To avoid system overload, the VirtualBox server process checks if passive event
18505	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
18506	current implementation, if more than 500 pending events are detected for a passive
18507	event listener, it is forcefully unregistered by the system, and further
18508	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
18509	</note>
18510	</desc>
18511	<param name="listener" type="IEventListener" dir="in">
18512	<desc>Listener to register.</desc>
18513	</param>
18514	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
18515	<desc>
18516	Event types listener is interested in. One can use wildcards like -
18517	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
18518	than one event.
18519	</desc>
18520	</param>
18521	<param name="active" type="boolean" dir="in">
18522	<desc>
18523	Which mode this listener is operating in.
18524	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
18525	In passive mode, an internal event queue is created for this this IEventListener.
18526	For each event coming in, it is added to queues for all interested registered passive
18527	listeners. It is then up to the external code to call the listener's
18528	<link to="IEventListener::handleEvent" /> method. When done with an event, the
18529	external code must call <link to="#eventProcessed" />.
18530	</desc>
18531	</param>
18532	</method>
18533
18534	<method name="unregisterListener">
18535	<desc>
18536	Unregister an event listener. If listener is passive, and some waitable events are still
18537	in queue they are marked as processed automatically.
18538	</desc>
18539	<param name="listener" type="IEventListener" dir="in">
18540	<desc>Listener to unregister.</desc>
18541	</param>
18542	</method>
18543
18544	<method name="fireEvent">
18545	<desc>
18546	Fire an event for this source.
18547	</desc>
18548	<param name="event" type="IEvent" dir="in">
18549	<desc>Event to deliver.</desc>
18550	</param>
18551	<param name="timeout" type="long" dir="in">
18552	<desc>
18553	Maximum time to wait for event processing (if event is waitable), in ms;
18554	0 = no wait, -1 = indefinite wait.
18555	</desc>
18556	</param>
18557	<param name="result" type="boolean" dir="return">
18558	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
18559	</param>
18560	</method>
18561
18562	<method name="getEvent">
18563	<desc>
18564	Get events from this peer's event queue (for passive mode). Calling this method
18565	regularly is required for passive event listeners to avoid system overload;
18566	see <link to="IEventSource::registerListener" /> for details.
18567
18568	<result name="VBOX_E_OBJECT_NOT_FOUND">
18569	Listener is not registered, or autounregistered.
18570	</result>
18571	</desc>
18572	<param name="listener" type="IEventListener" dir="in">
18573	<desc>Which listener to get data for.</desc>
18574	</param>
18575	<param name="timeout" type="long" dir="in">
18576	<desc>
18577	Maximum time to wait for events, in ms;
18578	0 = no wait, -1 = indefinite wait.
18579	</desc>
18580	</param>
18581	<param name="event" type="IEvent" dir="return">
18582	<desc>Event retrieved, or null if none available.</desc>
18583	</param>
18584	</method>
18585
18586	<method name="eventProcessed">
18587	<desc>
18588	Must be called for waitable events after a particular listener finished its
18589	event processing. When all listeners of a particular event have called this
18590	method, the system will then call <link to="IEvent::setProcessed" />.
18591	</desc>
18592	<param name="listener" type="IEventListener" dir="in">
18593	<desc>Which listener processed event.</desc>
18594	</param>
18595	<param name="event" type="IEvent" dir="in">
18596	<desc>Which event.</desc>
18597	</param>
18598	</method>
18599
18600	</interface>
18601
18602	<interface
18603	name="IEventListener" extends="$unknown"
18604	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
18605	wsmap="managed"
18606	>
18607	<desc>
18608	Event listener. An event listener can work in either active or passive mode, depending on the way
18609	it was registered.
18610	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18611	</desc>
18612
18613	<method name="handleEvent">
18614	<desc>
18615	Handle event callback for active listeners. It is not called for
18616	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
18617	and having received acknowledgement from all passive listeners via
18618	<link to="IEventSource::eventProcessed"/>, the event is marked as
18619	processed and <link to="IEvent::waitProcessed"/> will return
18620	immediately.
18621	</desc>
18622	<param name="event" type="IEvent" dir="in">
18623	<desc>Event available.</desc>
18624	</param>
18625	</method>
18626
18627	</interface>
18628
18629	<interface
18630	name="IEvent" extends="$unknown"
18631	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
18632	wsmap="managed"
18633	>
18634	<desc>
18635	Abstract parent interface for VirtualBox events. Actual events will typically implement
18636	a more specific interface which derives from this (see below).
18637
18638	<b>Introduction to VirtualBox events</b>
18639
18640	Generally speaking, an event (represented by this interface) signals that something
18641	happened, while an event listener (see <link to="IEventListener" />) represents an
18642	entity that is interested in certain events. In order for this to work with
18643	unidirectional protocols (i.e. web services), the concepts of passive and active
18644	listener are used.
18645
18646	Event consumers can register themselves as listeners, providing an array of
18647	events they are interested in (see <link to="IEventSource::registerListener" />).
18648	When an event triggers, the listener is notified about the event. The exact
18649	mechanism of the notification depends on whether the listener was registered as
18650	an active or passive listener:
18651
18652	<ul>
18653	<li>An active listener is very similar to a callback: it is a function invoked
18654	by the API. As opposed to the callbacks that were used in the API before
18655	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
18656	</li>
18657
18658	<li>Passive listeners are somewhat trickier to implement, but do not require
18659	a client function to be callable, which is not an option with scripting
18660	languages or web service clients. Internally the <link to="IEventSource" />
18661	implementation maintains an event queue for each passive listener, and
18662	newly arrived events are put in this queue. When the listener calls
18663	<link to="IEventSource::getEvent"/>, first element from its internal event
18664	queue is returned. When the client completes processing of an event,
18665	the <link to="IEventSource::eventProcessed" /> function must be called,
18666	acknowledging that the event was processed. It supports implementing
18667	waitable events. On passive listener unregistration, all events from its
18668	queue are auto-acknowledged.
18669	</li>
18670	</ul>
18671
18672	Waitable events are useful in situations where the event generator wants to track
18673	delivery or a party wants to wait until all listeners have completed the event. A
18674	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
18675	listeners might veto a certain action, and thus the event producer has to make
18676	sure that all listeners have processed the event and not vetoed before taking
18677	the action.
18678
18679	A given event may have both passive and active listeners at the same time.
18680
18681	<b>Using events</b>
18682
18683	Any VirtualBox object capable of producing externally visible events provides an
18684	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
18685	This event source object is notified by VirtualBox once something has happened, so
18686	consumers may register event listeners with this event source. To register a listener,
18687	an object implementing the <link to="IEventListener" /> interface must be provided.
18688	For active listeners, such an object is typically created by the consumer, while for
18689	passive listeners <link to="IEventSource::createListener" /> should be used. Please
18690	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
18691
18692	Once created, the listener must be registered to listen for the desired events
18693	(see <link to="IEventSource::registerListener" />), providing an array of
18694	<link to="VBoxEventType" /> enums. Those elements can either be the individual
18695	event IDs or wildcards matching multiple event IDs.
18696
18697	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
18698	called automatically when the event is triggered, while passive listeners have to call
18699	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
18700	an event processing loop.
18701
18702	The IEvent interface is an abstract parent interface for all such VirtualBox events
18703	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
18704	or the event processing loop is to check the <link to="#type" /> attribute of the event and
18705	then cast to the appropriate specific interface using @c QueryInterface().
18706	</desc>
18707
18708	<attribute name="type" readonly="yes" type="VBoxEventType">
18709	<desc>
18710	Event type.
18711	</desc>
18712	</attribute>
18713
18714	<attribute name="source" readonly="yes" type="IEventSource">
18715	<desc>
18716	Source of this event.
18717	</desc>
18718	</attribute>
18719
18720	<attribute name="waitable" readonly="yes" type="boolean">
18721	<desc>
18722	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
18723	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
18724	as no additional overhead associated with waitability imposed.
18725	Waitable events are needed when one need to be able to wait for particular event processed,
18726	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
18727	until all consumers confirmed events.
18728	</desc>
18729	</attribute>
18730
18731	<method name="setProcessed">
18732	<desc>
18733	Internal method called by the system when all listeners of a particular event have called
18734	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
18735	</desc>
18736	</method>
18737
18738	<method name="waitProcessed">
18739	<desc>
18740	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
18741	described semantics, for non-waitable returns true immediately.
18742	</desc>
18743	<param name="timeout" type="long" dir="in">
18744	<desc>
18745	Maximum time to wait for event processeing, in ms;
18746	0 = no wait, -1 = indefinite wait.
18747	</desc>
18748	</param>
18749	<param name="result" type="boolean" dir="return">
18750	<desc>If this event was processed before timeout.</desc>
18751	</param>
18752	</method>
18753	</interface>
18754
18755
18756	<interface
18757	name="IReusableEvent" extends="IEvent"
18758	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
18759	wsmap="managed"
18760	>
18761	<desc>Base abstract interface for all reusable events.</desc>
18762
18763	<attribute name="generation" readonly="yes" type="unsigned long">
18764	<desc>Current generation of event, incremented on reuse.</desc>
18765	</attribute>
18766
18767	<method name="reuse">
18768	<desc>
18769	Marks an event as reused, increments 'generation', fields shall no
18770	longer be considered valid.
18771	</desc>
18772	</method>
18773	</interface>
18774
18775	<interface
18776	name="IMachineEvent" extends="IEvent"
18777	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
18778	wsmap="managed" id="MachineEvent"
18779	>
18780	<desc>Base abstract interface for all machine events.</desc>
18781
18782	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
18783	<desc>ID of the machine this event relates to.</desc>
18784	</attribute>
18785
18786	</interface>
18787
18788	<interface
18789	name="IMachineStateChangedEvent" extends="IMachineEvent"
18790	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
18791	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
18792	>
18793	<desc>Machine state change event.</desc>
18794
18795	<attribute name="state" readonly="yes" type="MachineState">
18796	<desc>New execution state.</desc>
18797	</attribute>
18798	</interface>
18799
18800	<interface
18801	name="IMachineDataChangedEvent" extends="IMachineEvent"
18802	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
18803	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
18804	>
18805	<desc>
18806	Any of the settings of the given machine has changed.
18807	</desc>
18808
18809	<attribute name="temporary" readonly="yes" type="boolean">
18810	<desc>@c true if the settings change is temporary. All permanent
18811	settings changes will trigger an event, and only temporary settings
18812	changes for running VMs will trigger an event. Note: sending events
18813	for temporary changes is NOT IMPLEMENTED.</desc>
18814	</attribute>
18815	</interface>
18816
18817	<interface
18818	name="IMediumRegisteredEvent" extends="IEvent"
18819	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
18820	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
18821	>
18822	<desc>
18823	The given medium was registered or unregistered
18824	within this VirtualBox installation.
18825	</desc>
18826
18827	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
18828	<desc>ID of the medium this event relates to.</desc>
18829	</attribute>
18830
18831	<attribute name="mediumType" readonly="yes" type="DeviceType">
18832	<desc>Type of the medium this event relates to.</desc>
18833	</attribute>
18834
18835	<attribute name="registered" type="boolean" readonly="yes">
18836	<desc>
18837	If @c true, the medium was registered, otherwise it was
18838	unregistered.
18839	</desc>
18840	</attribute>
18841	</interface>
18842
18843	<interface
18844	name="IMachineRegisteredEvent" extends="IMachineEvent"
18845	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
18846	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
18847	>
18848	<desc>
18849	The given machine was registered or unregistered
18850	within this VirtualBox installation.
18851	</desc>
18852
18853	<attribute name="registered" type="boolean" readonly="yes">
18854	<desc>
18855	If @c true, the machine was registered, otherwise it was
18856	unregistered.
18857	</desc>
18858	</attribute>
18859	</interface>
18860
18861	<interface
18862	name="ISessionStateChangedEvent" extends="IMachineEvent"
18863	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
18864	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
18865	>
18866	<desc>
18867	The state of the session for the given machine was changed.
18868	<see><link to="IMachine::sessionState"/></see>
18869	</desc>
18870
18871	<attribute name="state" type="SessionState" readonly="yes">
18872	<desc>
18873	New session state.
18874	</desc>
18875	</attribute>
18876	</interface>
18877
18878	<interface
18879	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
18880	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
18881	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
18882	>
18883	<desc>
18884	Notification when a guest property has changed.
18885	</desc>
18886
18887	<attribute name="name" readonly="yes" type="wstring">
18888	<desc>
18889	The name of the property that has changed.
18890	</desc>
18891	</attribute>
18892
18893	<attribute name="value" readonly="yes" type="wstring">
18894	<desc>
18895	The new property value.
18896	</desc>
18897	</attribute>
18898
18899	<attribute name="flags" readonly="yes" type="wstring">
18900	<desc>
18901	The new property flags.
18902	</desc>
18903	</attribute>
18904
18905	</interface>
18906
18907	<interface
18908	name="ISnapshotEvent" extends="IMachineEvent"
18909	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
18910	wsmap="managed" id="SnapshotEvent"
18911	>
18912	<desc>Base interface for all snapshot events.</desc>
18913
18914	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
18915	<desc>ID of the snapshot this event relates to.</desc>
18916	</attribute>
18917
18918	</interface>
18919
18920	<interface
18921	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
18922	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
18923	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
18924	>
18925	<desc>
18926	A new snapshot of the machine has been taken.
18927	<see><link to="ISnapshot"/></see>
18928	</desc>
18929	</interface>
18930
18931	<interface
18932	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
18933	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
18934	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
18935	>
18936	<desc>
18937	Snapshot of the given machine has been deleted.
18938
18939	<note>
18940	This notification is delivered <b>after</b> the snapshot
18941	object has been uninitialized on the server (so that any
18942	attempt to call its methods will return an error).
18943	</note>
18944
18945	<see><link to="ISnapshot"/></see>
18946	</desc>
18947	</interface>
18948
18949	<interface
18950	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
18951	uuid="07541941-8079-447a-a33e-47a69c7980db"
18952	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
18953	>
18954	<desc>
18955	Snapshot properties (name and/or description) have been changed.
18956	<see><link to="ISnapshot"/></see>
18957	</desc>
18958	</interface>
18959
18960	<interface
18961	name="IMousePointerShapeChangedEvent" extends="IEvent"
18962	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
18963	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
18964	>
18965	<desc>
18966	Notification when the guest mouse pointer shape has
18967	changed. The new shape data is given.
18968	</desc>
18969
18970	<attribute name="visible" type="boolean" readonly="yes">
18971	<desc>
18972	Flag whether the pointer is visible.
18973	</desc>
18974	</attribute>
18975	<attribute name="alpha" type="boolean" readonly="yes">
18976	<desc>
18977	Flag whether the pointer has an alpha channel.
18978	</desc>
18979	</attribute>
18980	<attribute name="xhot" type="unsigned long" readonly="yes">
18981	<desc>
18982	The pointer hot spot X coordinate.
18983	</desc>
18984	</attribute>
18985	<attribute name="yhot" type="unsigned long" readonly="yes">
18986	<desc>
18987	The pointer hot spot Y coordinate.
18988	</desc>
18989	</attribute>
18990	<attribute name="width" type="unsigned long" readonly="yes">
18991	<desc>
18992	Width of the pointer shape in pixels.
18993	</desc>
18994	</attribute>
18995	<attribute name="height" type="unsigned long" readonly="yes">
18996	<desc>
18997	Height of the pointer shape in pixels.
18998	</desc>
18999	</attribute>
19000	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19001	<desc>
19002	Shape buffer arrays.
19003
19004	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19005	followed by a 32-bpp XOR (color) mask.
19006
19007	For pointers without alpha channel the XOR mask pixels are 32
19008	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19009	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19010
19011	An AND mask is used for pointers with alpha channel, so if the
19012	callback does not support alpha, the pointer could be
19013	displayed as a normal color pointer.
19014
19015	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19016	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19017	height</tt>. The padding bits at the end of each scanline are
19018	undefined.
19019
19020	The XOR mask follows the AND mask on the next 4-byte aligned
19021	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19022	Bytes in the gap between the AND and the XOR mask are undefined.
19023	The XOR mask scanlines have no gap between them and the size of
19024	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19025
19026	<note>
19027	If @a shape is 0, only the pointer visibility is changed.
19028	</note>
19029	</desc>
19030	</attribute>
19031	</interface>
19032
19033	<interface
19034	name="IMouseCapabilityChangedEvent" extends="IEvent"
19035	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19036	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19037	>
19038	<desc>
19039	Notification when the mouse capabilities reported by the
19040	guest have changed. The new capabilities are passed.
19041	</desc>
19042	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19043	<desc>
19044	Supports absolute coordinates.
19045	</desc>
19046	</attribute>
19047	<attribute name="supportsRelative" type="boolean" readonly="yes">
19048	<desc>
19049	Supports relative coordinates.
19050	</desc>
19051	</attribute>
19052	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19053	<desc>
19054	If host cursor is needed.
19055	</desc>
19056	</attribute>
19057	</interface>
19058
19059	<interface
19060	name="IKeyboardLedsChangedEvent" extends="IEvent"
19061	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19062	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19063	>
19064	<desc>
19065	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19066	to alter the state of the keyboard LEDs.
19067	</desc>
19068	<attribute name="numLock" type="boolean" readonly="yes">
19069	<desc>
19070	NumLock status.
19071	</desc>
19072	</attribute>
19073	<attribute name="capsLock" type="boolean" readonly="yes">
19074	<desc>
19075	CapsLock status.
19076	</desc>
19077	</attribute>
19078	<attribute name="scrollLock" type="boolean" readonly="yes">
19079	<desc>
19080	ScrollLock status.
19081	</desc>
19082	</attribute>
19083	</interface>
19084
19085	<interface
19086	name="IStateChangedEvent" extends="IEvent"
19087	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19088	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19089	>
19090	<desc>
19091	Notification when the execution state of the machine has changed.
19092	The new state is given.
19093	</desc>
19094	<attribute name="state" type="MachineState" readonly="yes">
19095	<desc>
19096	New machine state.
19097	</desc>
19098	</attribute>
19099	</interface>
19100
19101	<interface
19102	name="IAdditionsStateChangedEvent" extends="IEvent"
19103	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19104	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19105	>
19106	<desc>
19107	Notification when a Guest Additions property changes.
19108	Interested callees should query IGuest attributes to
19109	find out what has changed.
19110	</desc>
19111	</interface>
19112
19113	<interface
19114	name="INetworkAdapterChangedEvent" extends="IEvent"
19115	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19116	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19117	>
19118	<desc>
19119	Notification when a property of one of the
19120	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19121	changes. Interested callees should use INetworkAdapter methods and
19122	attributes to find out what has changed.
19123	</desc>
19124	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19125	<desc>
19126	Network adapter that is subject to change.
19127	</desc>
19128	</attribute>
19129	</interface>
19130
19131	<interface
19132	name="ISerialPortChangedEvent" extends="IEvent"
19133	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19134	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19135	>
19136	<desc>
19137	Notification when a property of one of the
19138	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19139	Interested callees should use ISerialPort methods and attributes
19140	to find out what has changed.
19141	</desc>
19142	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19143	<desc>
19144	Serial port that is subject to change.
19145	</desc>
19146	</attribute>
19147	</interface>
19148
19149	<interface
19150	name="IParallelPortChangedEvent" extends="IEvent"
19151	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19152	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19153	>
19154	<desc>
19155	Notification when a property of one of the
19156	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19157	changes. Interested callees should use ISerialPort methods and
19158	attributes to find out what has changed.
19159	</desc>
19160	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19161	<desc>
19162	Parallel port that is subject to change.
19163	</desc>
19164	</attribute>
19165	</interface>
19166
19167	<interface
19168	name="IStorageControllerChangedEvent" extends="IEvent"
19169	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19170	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19171	>
19172	<desc>
19173	Notification when a
19174	<link to="IMachine::mediumAttachments">medium attachment</link>
19175	changes.
19176	</desc>
19177	</interface>
19178
19179	<interface
19180	name="IMediumChangedEvent" extends="IEvent"
19181	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19182	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19183	>
19184	<desc>
19185	Notification when a
19186	<link to="IMachine::mediumAttachments">medium attachment</link>
19187	changes.
19188	</desc>
19189	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19190	<desc>
19191	Medium attachment that is subject to change.
19192	</desc>
19193	</attribute>
19194	</interface>
19195
19196	<interface
19197	name="IClipboardModeChangedEvent" extends="IEvent"
19198	uuid="cac21692-7997-4595-a731-3a509db604e5"
19199	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19200	>
19201	<desc>
19202	Notification when the shared clipboard mode changes.
19203	</desc>
19204	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19205	<desc>
19206	The new clipboard mode.
19207	</desc>
19208	</attribute>
19209	</interface>
19210
19211	<interface
19212	name="ICPUChangedEvent" extends="IEvent"
19213	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
19214	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19215	>
19216	<desc>
19217	Notification when a CPU changes.
19218	</desc>
19219	<attribute name="cpu" type="unsigned long" readonly="yes">
19220	<desc>
19221	The CPU which changed.
19222	</desc>
19223	</attribute>
19224	<attribute name="add" type="boolean" readonly="yes">
19225	<desc>
19226	Flag whether the CPU was added or removed.
19227	</desc>
19228	</attribute>
19229	</interface>
19230
19231	<interface
19232	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19233	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19234	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19235	>
19236	<desc>
19237	Notification when the CPU execution cap changes.
19238	</desc>
19239	<attribute name="executionCap" type="unsigned long" readonly="yes">
19240	<desc>
19241	The new CPU execution cap value. (1-100)
19242	</desc>
19243	</attribute>
19244	</interface>
19245
19246	<interface
19247	name="IGuestKeyboardEvent" extends="IEvent"
19248	uuid="88394258-7006-40d4-b339-472ee3801844"
19249	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19250	>
19251	<desc>
19252	Notification when guest keyboard event happens.
19253	</desc>
19254	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19255	<desc>
19256	Array of scancodes.
19257	</desc>
19258	</attribute>
19259	</interface>
19260
19261	<interface
19262	name="IGuestMouseEvent" extends="IReusableEvent"
19263	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19264	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19265	>
19266	<desc>
19267	Notification when guest mouse event happens.
19268	</desc>
19269
19270	<attribute name="absolute" type="boolean" readonly="yes">
19271	<desc>
19272	If this event is relative or absolute.
19273	</desc>
19274	</attribute>
19275
19276	<attribute name="x" type="long" readonly="yes">
19277	<desc>
19278	New X position, or X delta.
19279	</desc>
19280	</attribute>
19281
19282	<attribute name="y" type="long" readonly="yes">
19283	<desc>
19284	New Y position, or Y delta.
19285	</desc>
19286	</attribute>
19287
19288	<attribute name="z" type="long" readonly="yes">
19289	<desc>
19290	Z delta.
19291	</desc>
19292	</attribute>
19293
19294	<attribute name="w" type="long" readonly="yes">
19295	<desc>
19296	W delta.
19297	</desc>
19298	</attribute>
19299
19300	<attribute name="buttons" type="long" readonly="yes">
19301	<desc>
19302	Button state bitmask.
19303	</desc>
19304	</attribute>
19305
19306	</interface>
19307
19308
19309	<interface
19310	name="IVRDEServerChangedEvent" extends="IEvent"
19311	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19312	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19313	>
19314	<desc>
19315	Notification when a property of the
19316	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19317	Interested callees should use IVRDEServer methods and attributes to
19318	find out what has changed.
19319	</desc>
19320	</interface>
19321
19322	<interface
19323	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19324	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19325	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19326	>
19327	<desc>
19328	Notification when the status of the VRDE server changes. Interested callees
19329	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19330	attributes to find out what is the current status.
19331	</desc>
19332	</interface>
19333
19334	<interface
19335	name="IUSBControllerChangedEvent" extends="IEvent"
19336	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19337	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19338	>
19339	<desc>
19340	Notification when a property of the virtual
19341	<link to="IMachine::USBController">USB controller</link> changes.
19342	Interested callees should use IUSBController methods and attributes to
19343	find out what has changed.
19344	</desc>
19345	</interface>
19346
19347	<interface
19348	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19349	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19350	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19351	>
19352	<desc>
19353	Notification when a USB device is attached to or detached from
19354	the virtual USB controller.
19355
19356	This notification is sent as a result of the indirect
19357	request to attach the device because it matches one of the
19358	machine USB filters, or as a result of the direct request
19359	issued by <link to="IConsole::attachUSBDevice"/> or
19360	<link to="IConsole::detachUSBDevice"/>.
19361
19362	This notification is sent in case of both a succeeded and a
19363	failed request completion. When the request succeeds, the
19364	@a error parameter is @c null, and the given device has been
19365	already added to (when @a attached is @c true) or removed from
19366	(when @a attached is @c false) the collection represented by
19367	<link to="IConsole::USBDevices"/>. On failure, the collection
19368	doesn't change and the @a error parameter represents the error
19369	message describing the failure.
19370	</desc>
19371	<attribute name="device" type="IUSBDevice" readonly="yes">
19372	<desc>
19373	Device that is subject to state change.
19374	</desc>
19375	</attribute>
19376	<attribute name="attached" type="boolean" readonly="yes">
19377	<desc>
19378	@c true if the device was attached and @c false otherwise.
19379	</desc>
19380	</attribute>
19381	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19382	<desc>
19383	@c null on success or an error message object on failure.
19384	</desc>
19385	</attribute>
19386	</interface>
19387
19388	<interface
19389	name="ISharedFolderChangedEvent" extends="IEvent"
19390	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19391	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19392	>
19393	<desc>
19394	Notification when a shared folder is added or removed.
19395	The @a scope argument defines one of three scopes:
19396	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19397	(<link to="Scope_Global">Global</link>),
19398	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19399	the machine (<link to="Scope_Machine">Machine</link>) or <link
19400	to="IConsole::sharedFolders">transient shared folders</link> of the
19401	machine (<link to="Scope_Session">Session</link>). Interested callees
19402	should use query the corresponding collections to find out what has
19403	changed.
19404	</desc>
19405	<attribute name="scope" type="Scope" readonly="yes">
19406	<desc>
19407	Scope of the notification.
19408	</desc>
19409	</attribute>
19410	</interface>
19411
19412	<interface
19413	name="IRuntimeErrorEvent" extends="IEvent"
19414	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19415	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19416	>
19417	<desc>
19418	Notification when an error happens during the virtual
19419	machine execution.
19420
19421	There are three kinds of runtime errors:
19422	<ul>
19423	<li><i>fatal</i></li>
19424	<li><i>non-fatal with retry</i></li>
19425	<li><i>non-fatal warnings</i></li>
19426	</ul>
19427
19428	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19429	to @c true. In case of fatal errors, the virtual machine
19430	execution is always paused before calling this notification, and
19431	the notification handler is supposed either to immediately save
19432	the virtual machine state using <link to="IConsole::saveState"/>
19433	or power it off using <link to="IConsole::powerDown"/>.
19434	Resuming the execution can lead to unpredictable results.
19435
19436	<b>Non-fatal</b> errors and warnings are indicated by the
19437	@a fatal parameter set to @c false. If the virtual machine
19438	is in the Paused state by the time the error notification is
19439	received, it means that the user can <i>try to resume</i> the machine
19440	execution after attempting to solve the problem that caused the
19441	error. In this case, the notification handler is supposed
19442	to show an appropriate message to the user (depending on the
19443	value of the @a id parameter) that offers several actions such
19444	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
19445	wants to retry, the notification handler should continue
19446	the machine execution using the <link to="IConsole::resume"/>
19447	call. If the machine execution is not Paused during this
19448	notification, then it means this notification is a <i>warning</i>
19449	(for example, about a fatal condition that can happen very soon);
19450	no immediate action is required from the user, the machine
19451	continues its normal execution.
19452
19453	Note that in either case the notification handler
19454	<b>must not</b> perform any action directly on a thread
19455	where this notification is called. Everything it is allowed to
19456	do is to post a message to another thread that will then talk
19457	to the user and take the corresponding action.
19458
19459	Currently, the following error identifiers are known:
19460	<ul>
19461	<li><tt>"HostMemoryLow"</tt></li>
19462	<li><tt>"HostAudioNotResponding"</tt></li>
19463	<li><tt>"VDIStorageFull"</tt></li>
19464	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
19465	</ul>
19466	</desc>
19467	<attribute name="fatal" type="boolean" readonly="yes">
19468	<desc>
19469	Whether the error is fatal or not.
19470	</desc>
19471	</attribute>
19472	<attribute name="id" type="wstring" readonly="yes">
19473	<desc>
19474	Error identifier.
19475	</desc>
19476	</attribute>
19477	<attribute name="message" type="wstring" readonly="yes">
19478	<desc>
19479	Optional error message.
19480	</desc>
19481	</attribute>
19482	</interface>
19483
19484
19485	<interface
19486	name="IEventSourceChangedEvent" extends="IEvent"
19487	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
19488	waitable="yes"
19489	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
19490	>
19491	<desc>
19492	Notification when an event source state changes (listener added or removed).
19493	</desc>
19494
19495	<attribute name="listener" type="IEventListener" readonly="yes">
19496	<desc>
19497	Event listener which has changed.
19498	</desc>
19499	</attribute>
19500
19501	<attribute name="add" type="boolean" readonly="yes">
19502	<desc>
19503	Flag whether listener was added or removed.
19504	</desc>
19505	</attribute>
19506	</interface>
19507
19508	<interface
19509	name="IExtraDataChangedEvent" extends="IEvent"
19510	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
19511	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
19512	>
19513	<desc>
19514	Notification when machine specific or global extra data
19515	has changed.
19516	</desc>
19517	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19518	<desc>
19519	ID of the machine this event relates to.
19520	Null for global extra data changes.
19521	</desc>
19522	</attribute>
19523	<attribute name="key" type="wstring" readonly="yes">
19524	<desc>
19525	Extra data key that has changed.
19526	</desc>
19527	</attribute>
19528	<attribute name="value" type="wstring" readonly="yes">
19529	<desc>
19530	Extra data value for the given key.
19531	</desc>
19532	</attribute>
19533	</interface>
19534
19535	<interface
19536	name="IVetoEvent" extends="IEvent"
19537	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
19538	wsmap="managed"
19539	>
19540	<desc>Base abstract interface for veto events.</desc>
19541
19542	<method name="addVeto">
19543	<desc>
19544	Adds a veto on this event.
19545	</desc>
19546	<param name="reason" type="wstring" dir="in">
19547	<desc>
19548	Reason for veto, could be null or empty string.
19549	</desc>
19550	</param>
19551	</method>
19552
19553	<method name="isVetoed">
19554	<desc>
19555	If this event was vetoed.
19556	</desc>
19557	<param name="result" type="boolean" dir="return">
19558	<desc>
19559	Reason for veto.
19560	</desc>
19561	</param>
19562	</method>
19563
19564	<method name="getVetos">
19565	<desc>
19566	Current veto reason list, if size is 0 - no veto.
19567	</desc>
19568	<param name="result" type="wstring" dir="return" safearray="yes">
19569	<desc>
19570	Array of reasons for veto provided by different event handlers.
19571	</desc>
19572	</param>
19573	</method>
19574
19575	</interface>
19576
19577	<interface
19578	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
19579	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
19580	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
19581	waitable="true"
19582	>
19583	<desc>
19584	Notification when someone tries to change extra data for
19585	either the given machine or (if @c null) global extra data.
19586	This gives the chance to veto against changes.
19587	</desc>
19588	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19589	<desc>
19590	ID of the machine this event relates to.
19591	Null for global extra data changes.
19592	</desc>
19593	</attribute>
19594	<attribute name="key" type="wstring" readonly="yes">
19595	<desc>
19596	Extra data key that has changed.
19597	</desc>
19598	</attribute>
19599	<attribute name="value" type="wstring" readonly="yes">
19600	<desc>
19601	Extra data value for the given key.
19602	</desc>
19603	</attribute>
19604	</interface>
19605
19606	<interface
19607	name="ICanShowWindowEvent" extends="IVetoEvent"
19608	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
19609	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
19610	waitable="true"
19611	>
19612	<desc>
19613	Notification when a call to
19614	<link to="IMachine::canShowConsoleWindow"/> is made by a
19615	front-end to check if a subsequent call to
19616	<link to="IMachine::showConsoleWindow"/> can succeed.
19617
19618	The callee should give an answer appropriate to the current
19619	machine state using event veto. This answer must
19620	remain valid at least until the next
19621	<link to="IConsole::state">machine state</link> change.
19622	</desc>
19623	</interface>
19624
19625	<interface
19626	name="IShowWindowEvent" extends="IEvent"
19627	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
19628	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
19629	waitable="true"
19630	>
19631	<desc>
19632	Notification when a call to
19633	<link to="IMachine::showConsoleWindow"/>
19634	requests the console window to be activated and brought to
19635	foreground on the desktop of the host PC.
19636
19637	This notification should cause the VM console process to
19638	perform the requested action as described above. If it is
19639	impossible to do it at a time of this notification, this
19640	method should return a failure.
19641
19642	Note that many modern window managers on many platforms
19643	implement some sort of focus stealing prevention logic, so
19644	that it may be impossible to activate a window without the
19645	help of the currently active application (which is supposedly
19646	an initiator of this notification). In this case, this method
19647	must return a non-zero identifier that represents the
19648	top-level window of the VM console process. The caller, if it
19649	represents a currently active process, is responsible to use
19650	this identifier (in a platform-dependent manner) to perform
19651	actual window activation.
19652
19653	This method must set @a winId to zero if it has performed all
19654	actions necessary to complete the request and the console
19655	window is now active and in foreground, to indicate that no
19656	further action is required on the caller's side.
19657	</desc>
19658	<attribute name="winId" type="long long">
19659	<desc>
19660	Platform-dependent identifier of the top-level VM console
19661	window, or zero if this method has performed all actions
19662	necessary to implement the <i>show window</i> semantics for
19663	the given platform and/or this VirtualBox front-end.
19664	</desc>
19665	</attribute>
19666	</interface>
19667
19668	<interface
19669	name="INATRedirectEvent" extends="IMachineEvent"
19670	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
19671	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
19672	>
19673	<desc>
19674	Notification when NAT redirect rule added or removed.
19675	</desc>
19676	<attribute name="slot" type="unsigned long" readonly="yes">
19677	<desc>
19678	Adapter which NAT attached to.
19679	</desc>
19680	</attribute>
19681	<attribute name="remove" type="boolean" readonly="yes">
19682	<desc>
19683	Whether rule remove or add.
19684	</desc>
19685	</attribute>
19686	<attribute name="name" type="wstring" readonly="yes">
19687	<desc>
19688	Name of the rule.
19689	</desc>
19690	</attribute>
19691	<attribute name="proto" type="NATProtocol" readonly="yes">
19692	<desc>
19693	Protocol (TCP or UDP) of the redirect rule.
19694	</desc>
19695	</attribute>
19696	<attribute name="hostIp" type="wstring" readonly="yes">
19697	<desc>
19698	Host ip address to bind socket on.
19699	</desc>
19700	</attribute>
19701	<attribute name="hostPort" type="long" readonly="yes">
19702	<desc>
19703	Host port to bind socket on.
19704	</desc>
19705	</attribute>
19706	<attribute name="guestIp" type="wstring" readonly="yes">
19707	<desc>
19708	Guest ip address to redirect to.
19709	</desc>
19710	</attribute>
19711	<attribute name="guestPort" type="long" readonly="yes">
19712	<desc>
19713	Guest port to redirect to.
19714	</desc>
19715	</attribute>
19716	</interface>
19717
19718	<interface
19719	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
19720	waitable="yes"
19721	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
19722	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
19723	>
19724	<desc>
19725	Notification when host PCI device is plugged/unplugged. Plugging
19726	usually takes place on VM startup, unplug - when
19727	<link to="IMachine::detachHostPciDevice"/> is called.
19728
19729	<see><link to="IMachine::detachHostPciDevice"/></see>
19730
19731	</desc>
19732
19733	<attribute name="plugged" type="boolean" readonly="yes">
19734	<desc>
19735	If device successfully plugged or unplugged.
19736	</desc>
19737	</attribute>
19738
19739	<attribute name="success" type="boolean" readonly="yes">
19740	<desc>
19741	If operation was successful, if false - 'message' attribute
19742	may be of interest.
19743	</desc>
19744	</attribute>
19745
19746	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
19747	<desc>
19748	Attachment info for this device.
19749	</desc>
19750	</attribute>
19751
19752	<attribute name="message" type="wstring" readonly="yes">
19753	<desc>
19754	Optional error message.
19755	</desc>
19756	</attribute>
19757
19758	</interface>
19759
19760	<interface
19761	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
19762	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
19763	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
19764	>
19765	<desc>
19766	Notification when VBoxSVC becomes unavailable (due to a crash or similar
19767	unexpected circumstances) or available again.
19768	</desc>
19769
19770	<attribute name="available" type="boolean" readonly="yes">
19771	<desc>
19772	Whether VBoxSVC is available now.
19773	</desc>
19774	</attribute>
19775	</interface>
19776
19777	<interface
19778	name="IBandwidthGroupChangedEvent" extends="IEvent"
19779	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
19780	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
19781	>
19782	<desc>
19783	Notification when one of the bandwidth groups changed
19784	</desc>
19785	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
19786	<desc>
19787	The changed bandwidth group.
19788	</desc>
19789	</attribute>
19790	</interface>
19791
19792	<enum
19793	name="GuestMonitorChangedEventType"
19794	uuid="ef172985-7e36-4297-95be-e46396968d66"
19795	>
19796
19797	<desc>
19798	How the guest monitor has been changed.
19799	</desc>
19800
19801	<const name="Enabled" value="0">
19802	<desc>
19803	The guest monitor has been enabled by the guest.
19804	</desc>
19805	</const>
19806
19807	<const name="Disabled" value="1">
19808	<desc>
19809	The guest monitor has been disabled by the guest.
19810	</desc>
19811	</const>
19812
19813	<const name="NewOrigin" value="2">
19814	<desc>
19815	The guest monitor origin has changed in the guest.
19816	</desc>
19817	</const>
19818	</enum>
19819
19820	<interface
19821	name="IGuestMonitorChangedEvent" extends="IEvent"
19822	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
19823	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
19824	>
19825	<desc>
19826	Notification when the guest enables one of its monitors.
19827	</desc>
19828
19829	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
19830	<desc>
19831	What was changed for this guest monitor.
19832	</desc>
19833	</attribute>
19834
19835	<attribute name="screenId" type="unsigned long" readonly="yes">
19836	<desc>
19837	The monitor which was changed.
19838	</desc>
19839	</attribute>
19840
19841	<attribute name="originX" type="unsigned long" readonly="yes">
19842	<desc>
19843	Physical X origin relative to the primary screen.
19844	Valid for Enabled and NewOrigin.
19845	</desc>
19846	</attribute>
19847
19848	<attribute name="originY" type="unsigned long" readonly="yes">
19849	<desc>
19850	Physical Y origin relative to the primary screen.
19851	Valid for Enabled and NewOrigin.
19852	</desc>
19853	</attribute>
19854
19855	<attribute name="width" type="unsigned long" readonly="yes">
19856	<desc>
19857	Width of the screen.
19858	Valid for Enabled.
19859	</desc>
19860	</attribute>
19861
19862	<attribute name="height" type="unsigned long" readonly="yes">
19863	<desc>
19864	Height of the screen.
19865	Valid for Enabled.
19866	</desc>
19867	</attribute>
19868
19869	</interface>
19870
19871	<interface
19872	name="IStorageDeviceChangedEvent" extends="IEvent"
19873	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
19874	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
19875	>
19876	<desc>
19877	Notification when a
19878	<link to="IMachine::mediumAttachments">storage device</link>
19879	is attached or removed.
19880	</desc>
19881	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
19882	<desc>
19883	Storage device that is subject to change.
19884	</desc>
19885	</attribute>
19886	<attribute name="removed" type="boolean" readonly="yes">
19887	<desc>
19888	Flag whether the device was removed or added to the VM.
19889	</desc>
19890	</attribute>
19891	</interface>
19892
19893	<module name="VBoxSVC" context="LocalServer">
19894	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
19895	namespace="virtualbox.org">
19896	<interface name="IVirtualBox" default="yes"/>
19897	</class>
19898	</module>
19899
19900	<module name="VBoxC" context="InprocServer" threadingModel="Free">
19901	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
19902	namespace="virtualbox.org">
19903	<interface name="IVirtualBoxClient" default="yes"/>
19904	</class>
19905
19906	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
19907	namespace="virtualbox.org">
19908	<interface name="ISession" default="yes"/>
19909	</class>
19910	</module>
19911
19912	</library>
19913
19914	</idl>
19915
19916	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format