VirtualBox.xidl@ 39411

Last change on this file since 39411 was 39058, checked in by vboxsync, 13 years ago
Added machinery to add floppy or not add USB for new VMs depending on guest type.
Property svn:eol-style set to `native`
File size: 648.7 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2011 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
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.12", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any other setting or perform a modifying operation during this time
562	will result in the @c VBOX_E_INVALID_VM_STATE error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	<note>errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).</note>
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="c28be65f-1a8f-43b4-81f1-eb60cb516e66"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417	</desc>
1418	</attribute>
1419
1420	<attribute name="revision" type="unsigned long" readonly="yes">
1421	<desc>
1422	The internal build revision number of the product.
1423	</desc>
1424	</attribute>
1425
1426	<attribute name="packageType" type="wstring" readonly="yes">
1427	<desc>
1428	A string representing the package type of this product. The
1429	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1430	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1431	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1432	this.
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="APIVersion" type="wstring" readonly="yes">
1437	<desc>
1438	A string representing the VirtualBox API version number. The format is
1439	2 integer numbers divided by an underscore (e.g. 1_0). After the
1440	first public release of packages with a particular API version the
1441	API will not be changed in an incompatible way. Note that this
1442	guarantee does not apply to development builds, and also there is no
1443	guarantee that this version is identical to the first two integer
1444	numbers of the package version.
1445	</desc>
1446	</attribute>
1447
1448	<attribute name="homeFolder" type="wstring" readonly="yes">
1449	<desc>
1450	Full path to the directory where the global settings file,
1451	<tt>VirtualBox.xml</tt>, is stored.
1452
1453	In this version of VirtualBox, the value of this property is
1454	always <tt><user_dir>/.VirtualBox</tt> (where
1455	<tt><user_dir></tt> is the path to the user directory,
1456	as determined by the host OS), and cannot be changed.
1457
1458	This path is also used as the base to resolve relative paths in
1459	places where relative paths are allowed (unless otherwise
1460	expressly indicated).
1461	</desc>
1462	</attribute>
1463
1464	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1465	<desc>
1466	Full name of the global settings file.
1467	The value of this property corresponds to the value of
1468	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="host" type="IHost" readonly="yes">
1473	<desc>Associated host object.</desc>
1474	</attribute>
1475
1476	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1477	<desc>Associated system information object.</desc>
1478	</attribute>
1479
1480	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1481	<desc>
1482	Array of machine objects registered within this VirtualBox instance.
1483	</desc>
1484	</attribute>
1485
1486	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1487	<desc>
1488	Array of medium objects known to this VirtualBox installation.
1489
1490	This array contains only base media. All differencing
1491	media of the given base medium can be enumerated using
1492	<link to="IMedium::children"/>.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1497	<desc>
1498	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1499	</desc>
1500	</attribute>
1501
1502	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1503	<desc>
1504	Array of floppy image objects currently in use by this VirtualBox instance.
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1509
1510	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1511
1512	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1513	<desc>
1514	Collection of global shared folders. Global shared folders are
1515	available to all virtual machines.
1516
1517	New shared folders are added to the collection using
1518	<link to="#createSharedFolder"/>. Existing shared folders can be
1519	removed using <link to="#removeSharedFolder"/>.
1520
1521	<note>
1522	In the current version of the product, global shared folders are not
1523	implemented and therefore this collection is always empty.
1524	</note>
1525	</desc>
1526	</attribute>
1527
1528	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1529	<desc>
1530	Associated performance collector object.
1531	</desc>
1532	</attribute>
1533
1534	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1535	<desc>
1536	DHCP servers.
1537	</desc>
1538	</attribute>
1539
1540	<attribute name="eventSource" type="IEventSource" readonly="yes">
1541	<desc>
1542	Event source for VirtualBox events.
1543	</desc>
1544	</attribute>
1545
1546	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1547	<desc>
1548	The extension pack manager.
1549	</desc>
1550	</attribute>
1551
1552
1553	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1554	<desc>
1555	Names of all internal networks.
1556	</desc>
1557	</attribute>
1558
1559	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1560	<desc>
1561	Names of all generic network drivers.
1562	</desc>
1563	</attribute>
1564
1565	<method name="composeMachineFilename">
1566	<desc>
1567	Returns a recommended full path of the settings file name for a new virtual
1568	machine.
1569
1570	This API serves two purposes:
1571
1572	<ul>
1573	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1574	for the @a settingsFile argument there, which means that API should use
1575	a recommended default file name.</li>
1576
1577	<li>It can be called manually by a client software before creating a machine,
1578	e.g. if that client wants to pre-create the machine directory to create
1579	virtual hard disks in that directory together with the new machine
1580	settings file. In that case, the file name should be stripped from the
1581	full settings file path returned by this function to obtain the
1582	machine directory.</li>
1583	</ul>
1584
1585	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1586	details about the machine name.
1587
1588	If @a baseFolder is a @c null or empty string (which is recommended), the
1589	default machine settings folder
1590	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1591	a base folder for the created machine, resulting in a file name like
1592	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1593	will be used.
1594
1595	This method does not access the host disks. In particular, it does not check
1596	for whether a machine of this name already exists.
1597	</desc>
1598	<param name="name" type="wstring" dir="in">
1599	<desc>Suggested machine name.</desc>
1600	</param>
1601	<param name="baseFolder" type="wstring" dir="in">
1602	<desc>Base machine folder (optional).</desc>
1603	</param>
1604	<param name="file" type="wstring" dir="return">
1605	<desc>Fully qualified path where the machine would be created.</desc>
1606	</param>
1607	</method>
1608
1609	<method name="createMachine">
1610	<desc>
1611	Creates a new virtual machine by creating a machine settings file at
1612	the given location.
1613
1614	VirtualBox machine settings files use a custom XML dialect. Starting
1615	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1616	and machine files can be created at arbitrary locations.
1617
1618	However, it is is recommended that machines be created in the default
1619	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1620	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1621	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1622	is called automatically to have such a recommended name composed based
1623	on the machine name given in the @a name argument.
1624
1625	If the resulting settings file already exists, this method will fail,
1626	unless @a forceOverwrite is set.
1627
1628	The new machine is created unregistered, with the initial configuration
1629	set according to the specified guest OS type. A typical sequence of
1630	actions to create a new virtual machine is as follows:
1631
1632	<ol>
1633	<li>
1634	Call this method to have a new machine created. The returned machine
1635	object will be "mutable" allowing to change any machine property.
1636	</li>
1637
1638	<li>
1639	Configure the machine using the appropriate attributes and methods.
1640	</li>
1641
1642	<li>
1643	Call <link to="IMachine::saveSettings" /> to write the settings
1644	to the machine's XML settings file. The configuration of the newly
1645	created machine will not be saved to disk until this method is
1646	called.
1647	</li>
1648
1649	<li>
1650	Call <link to="#registerMachine" /> to add the machine to the list
1651	of machines known to VirtualBox.
1652	</li>
1653	</ol>
1654
1655	The specified guest OS type identifier must match an ID of one of known
1656	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1657	array.
1658
1659	Optionally, you may specify an UUID of to assign to the created machine.
1660	However, this is not recommended and you should normally pass an empty
1661	(@c null) UUID to this method so that a new UUID will be automatically
1662	generated for every created machine. You can use UUID
1663	00000000-0000-0000-0000-000000000000 as @c null value.
1664
1665	<note>
1666	There is no way to change the name of the settings file or
1667	subfolder of the created machine directly.
1668	</note>
1669
1670	<result name="VBOX_E_OBJECT_NOT_FOUND">
1671	@a osTypeId is invalid.
1672	</result>
1673	<result name="VBOX_E_FILE_ERROR">
1674	Resulting settings file name is invalid or the settings file already
1675	exists or could not be created due to an I/O error.
1676	</result>
1677	<result name="E_INVALIDARG">
1678	@a name is empty or @c null.
1679	</result>
1680	</desc>
1681
1682	<param name="settingsFile" type="wstring" dir="in">
1683	<desc>Fully qualified path where the settings file should be created,
1684	or NULL for a default folder and file based on the @a name argument
1685	(see <link to="#composeMachineFilename" />).</desc>
1686	</param>
1687	<param name="name" type="wstring" dir="in">
1688	<desc>Machine name.</desc>
1689	</param>
1690	<param name="osTypeId" type="wstring" dir="in">
1691	<desc>Guest OS Type ID.</desc>
1692	</param>
1693	<param name="id" type="uuid" mod="string" dir="in">
1694	<desc>Machine UUID (optional).</desc>
1695	</param>
1696	<param name="forceOverwrite" type="boolean" dir="in">
1697	<desc>If true, an existing machine settings file will be overwritten.</desc>
1698	</param>
1699	<param name="machine" type="IMachine" dir="return">
1700	<desc>Created machine object.</desc>
1701	</param>
1702	</method>
1703
1704	<method name="openMachine">
1705	<desc>
1706	Opens a virtual machine from the existing settings file.
1707	The opened machine remains unregistered until you call
1708	<link to="#registerMachine"/>.
1709
1710	The specified settings file name must be fully qualified.
1711	The file must exist and be a valid machine XML settings file
1712	whose contents will be used to construct the machine object.
1713
1714	<result name="VBOX_E_FILE_ERROR">
1715	Settings file name invalid, not found or sharing violation.
1716	</result>
1717	</desc>
1718	<param name="settingsFile" type="wstring" dir="in">
1719	<desc>
1720	Name of the machine settings file.
1721	</desc>
1722	</param>
1723	<param name="machine" type="IMachine" dir="return">
1724	<desc>Opened machine object.</desc>
1725	</param>
1726	<note>
1727	<link to="IMachine::settingsModified"/> will return
1728	@c false for the created machine, until any of machine settings
1729	are changed.
1730	</note>
1731	</method>
1732
1733	<method name="registerMachine">
1734	<desc>
1735
1736	Registers the machine previously created using
1737	<link to="#createMachine"/> or opened using
1738	<link to="#openMachine"/> within this VirtualBox installation. After
1739	successful method invocation, the
1740	<link to="IMachineRegisteredEvent"/> event is fired.
1741
1742	<note>
1743	This method implicitly calls <link to="IMachine::saveSettings"/>
1744	to save all current machine settings before registering it.
1745	</note>
1746
1747	<result name="VBOX_E_OBJECT_NOT_FOUND">
1748	No matching virtual machine found.
1749	</result>
1750	<result name="VBOX_E_INVALID_OBJECT_STATE">
1751	Virtual machine was not created within this VirtualBox instance.
1752	</result>
1753
1754	</desc>
1755	<param name="machine" type="IMachine" dir="in"/>
1756	</method>
1757
1758	<method name="findMachine">
1759	<desc>
1760	Attempts to find a virtual machine given its name or UUID.
1761
1762	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1763	cannot safely be determined.</note>
1764
1765	<result name="VBOX_E_OBJECT_NOT_FOUND">
1766	Could not find registered machine matching @a nameOrId.
1767	</result>
1768
1769	</desc>
1770	<param name="nameOrId" type="wstring" dir="in">
1771	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1772	</param>
1773	<param name="machine" type="IMachine" dir="return">
1774	<desc>Machine object, if found.</desc>
1775	</param>
1776	</method>
1777
1778	<method name="createAppliance">
1779	<desc>
1780	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1781	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1782	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1783	</desc>
1784	<param name="appliance" type="IAppliance" dir="return">
1785	<desc>New appliance.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="createHardDisk">
1790	<desc>
1791	Creates a new base medium object that will use the given storage
1792	format and location for medium data.
1793
1794	The actual storage unit is not created by this method. In order to
1795	do it, and before you are able to attach the created medium to
1796	virtual machines, you must call one of the following methods to
1797	allocate a format-specific storage unit at the specified location:
1798	<ul>
1799	<li><link to="IMedium::createBaseStorage"/></li>
1800	<li><link to="IMedium::createDiffStorage"/></li>
1801	</ul>
1802
1803	Some medium attributes, such as <link to="IMedium::id"/>, may
1804	remain uninitialized until the medium storage unit is successfully
1805	created by one of the above methods.
1806
1807	After the storage unit is successfully created, it will be
1808	accessible through the <link to="#findMedium"/> method and can
1809	be found in the <link to="#hardDisks"/> array.
1810
1811	The list of all storage formats supported by this VirtualBox
1812	installation can be obtained using
1813	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1814	attribute is empty or @c null then the default storage format
1815	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1816	be used for creating a storage unit of the medium.
1817
1818	Note that the format of the location string is storage format specific.
1819	See <link to="IMedium::location"/> and IMedium for more details.
1820
1821	<result name="VBOX_E_OBJECT_NOT_FOUND">
1822	@a format identifier is invalid. See
1823	<link to="ISystemProperties::mediumFormats"/>.
1824	</result>
1825	<result name="VBOX_E_FILE_ERROR">
1826	@a location is a not valid file name (for file-based formats only).
1827	</result>
1828	</desc>
1829	<param name="format" type="wstring" dir="in">
1830	<desc>
1831	Identifier of the storage format to use for the new medium.
1832	</desc>
1833	</param>
1834	<param name="location" type="wstring" dir="in">
1835	<desc>
1836	Location of the storage unit for the new medium.
1837	</desc>
1838	</param>
1839	<param name="medium" type="IMedium" dir="return">
1840	<desc>Created medium object.</desc>
1841	</param>
1842	</method>
1843
1844	<method name="openMedium">
1845	<desc>
1846	Opens a medium from an existing storage location.
1847
1848	Once a medium has been opened, it can be passed to other VirtualBox
1849	methods, in particular to <link to="IMachine::attachDevice" />.
1850
1851	Depending on the given device type, the file at the storage location
1852	must be in one of the media formats understood by VirtualBox:
1853
1854	<ul>
1855	<li>With a "HardDisk" device type, the file must be a hard disk image
1856	in one of the formats supported by VirtualBox (see
1857	<link to="ISystemProperties::mediumFormats" />).
1858	After this method succeeds, if the medium is a base medium, it
1859	will be added to the <link to="#hardDisks"/> array attribute. </li>
1860	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1861	After this method succeeds, the medium will be added to the
1862	<link to="#DVDImages"/> array attribute.</li>
1863	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1864	After this method succeeds, the medium will be added to the
1865	<link to="#floppyImages"/> array attribute.</li>
1866	</ul>
1867
1868	After having been opened, the medium can be found by the <link to="#findMedium"/>
1869	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1870
1871	The UUID of the newly opened medium will either be retrieved from the
1872	storage location, if the format supports it (e.g. for hard disk images),
1873	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1874	If for some reason you need to change the medium's UUID, use
1875	<link to="IMedium::setIDs" />.
1876
1877	If a differencing hard disk medium is to be opened by this method, the
1878	operation will succeed only if its parent medium and all ancestors,
1879	if any, are already known to this VirtualBox installation (for example,
1880	were opened by this method before).
1881
1882	This method attempts to guess the storage format of the specified medium
1883	by reading medium data at the specified location.
1884
1885	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1886	the image is opened for read/write access and must have according permissions,
1887	as VirtualBox may actually write status information into the disk's metadata
1888	sections.
1889
1890	Note that write access is required for all typical hard disk usage in VirtualBox,
1891	since VirtualBox may need to write metadata such as a UUID into the image.
1892	The only exception is opening a source image temporarily for copying and
1893	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1894	again soon.
1895
1896	The format of the location string is storage format specific. See
1897	<link to="IMedium::location"/> and IMedium for more details.
1898
1899	<result name="VBOX_E_FILE_ERROR">
1900	Invalid medium storage file location or could not find the medium
1901	at the specified location.
1902	</result>
1903	<result name="VBOX_E_IPRT_ERROR">
1904	Could not get medium storage format.
1905	</result>
1906	<result name="E_INVALIDARG">
1907	Invalid medium storage format.
1908	</result>
1909	<result name="VBOX_E_INVALID_OBJECT_STATE">
1910	Medium has already been added to a media registry.
1911	</result>
1912	</desc>
1913	<param name="location" type="wstring" dir="in">
1914	<desc>
1915	Location of the storage unit that contains medium data in one of
1916	the supported storage formats.
1917	</desc>
1918	</param>
1919	<param name="deviceType" type="DeviceType" dir="in">
1920	<desc>
1921	Must be one of "HardDisk", "DVD" or "Floppy".
1922	</desc>
1923	</param>
1924	<param name="accessMode" type="AccessMode" dir="in">
1925	<desc>Whether to open the image in read/write or read-only mode. For
1926	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1927	</param>
1928	<param name="forceNewUuid" type="boolean" dir="in">
1929	<desc>Allows the caller to request a completely new medium UUID for
1930	the image which is to be opened. Useful if one intends to open an exact
1931	copy of a previously opened image, as this would normally fail due to
1932	the duplicate UUID.</desc>
1933	</param>
1934	<param name="medium" type="IMedium" dir="return">
1935	<desc>Opened medium object.</desc>
1936	</param>
1937	</method>
1938
1939	<method name="findMedium">
1940	<desc>
1941	Returns a medium of the given type that uses the given fully qualified
1942	location or UUID to store medium data.
1943
1944	The given medium must be known to this VirtualBox installation, i.e.
1945	it must be previously created by <link to="#createHardDisk"/> or opened
1946	by <link to="#openMedium"/>.
1947
1948	The search is done by comparing the value of the @a location argument to
1949	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1950	attributes of each known medium.
1951
1952	On case sensitive file systems, a case sensitive comparison is performed,
1953	otherwise the case of symbols in the file path is ignored.
1954
1955	<result name="VBOX_E_OBJECT_NOT_FOUND">
1956	No medium object matching @a location found.
1957	</result>
1958	</desc>
1959	<param name="location" type="wstring" dir="in">
1960	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1961	</param>
1962	<param name="type" type="DeviceType" dir="in">
1963	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1964	</param>
1965	<param name="medium" type="IMedium" dir="return">
1966	<desc>Medium object, if found.</desc>
1967	</param>
1968	</method>
1969
1970	<method name="getGuestOSType">
1971	<desc>
1972	Returns an object describing the specified guest OS type.
1973
1974	The requested guest OS type is specified using a string which is a
1975	mnemonic identifier of the guest operating system, such as
1976	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1977	particular virtual machine can be read or set using the
1978	<link to="IMachine::OSTypeId"/> attribute.
1979
1980	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1981	available guest OS type objects. Each object has an
1982	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1983	the guest OS this object describes.
1984
1985	<result name="E_INVALIDARG">
1986	@a id is not a valid Guest OS type.
1987	</result>
1988
1989	</desc>
1990	<param name="id" type="uuid" mod="string" dir="in">
1991	<desc>Guest OS type ID string.</desc>
1992	</param>
1993	<param name="type" type="IGuestOSType" dir="return">
1994	<desc>Guest OS type object.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="createSharedFolder">
1999	<desc>
2000	Creates a new global shared folder by associating the given logical
2001	name with the given host path, adds it to the collection of shared
2002	folders and starts sharing it. Refer to the description of
2003	<link to="ISharedFolder"/> to read more about logical names.
2004	<note>
2005	In the current implementation, this operation is not
2006	implemented.
2007	</note>
2008	</desc>
2009	<param name="name" type="wstring" dir="in">
2010	<desc>Unique logical name of the shared folder.</desc>
2011	</param>
2012	<param name="hostPath" type="wstring" dir="in">
2013	<desc>Full path to the shared folder in the host file system.</desc>
2014	</param>
2015	<param name="writable" type="boolean" dir="in">
2016	<desc>Whether the share is writable or readonly</desc>
2017	</param>
2018	<param name="automount" type="boolean" dir="in">
2019	<desc>Whether the share gets automatically mounted by the guest
2020	or not.</desc>
2021	</param>
2022	</method>
2023
2024	<method name="removeSharedFolder">
2025	<desc>
2026	Removes the global shared folder with the given name previously
2027	created by <link to="#createSharedFolder"/> from the collection of
2028	shared folders and stops sharing it.
2029	<note>
2030	In the current implementation, this operation is not
2031	implemented.
2032	</note>
2033	</desc>
2034	<param name="name" type="wstring" dir="in">
2035	<desc>Logical name of the shared folder to remove.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="getExtraDataKeys">
2040	<desc>
2041	Returns an array representing the global extra data keys which currently
2042	have values defined.
2043	</desc>
2044	<param name="value" type="wstring" dir="return" safearray="yes">
2045	<desc>Array of extra data keys.</desc>
2046	</param>
2047	</method>
2048
2049	<method name="getExtraData">
2050	<desc>
2051	Returns associated global extra data.
2052
2053	If the requested data @a key does not exist, this function will
2054	succeed and return an empty string in the @a value argument.
2055
2056	<result name="VBOX_E_FILE_ERROR">
2057	Settings file not accessible.
2058	</result>
2059	<result name="VBOX_E_XML_ERROR">
2060	Could not parse the settings file.
2061	</result>
2062
2063	</desc>
2064	<param name="key" type="wstring" dir="in">
2065	<desc>Name of the data key to get.</desc>
2066	</param>
2067	<param name="value" type="wstring" dir="return">
2068	<desc>Value of the requested data key.</desc>
2069	</param>
2070	</method>
2071
2072	<method name="setExtraData">
2073	<desc>
2074	Sets associated global extra data.
2075
2076	If you pass @c null or empty string as a key @a value, the given @a key
2077	will be deleted.
2078
2079	<note>
2080	Before performing the actual data change, this method will ask all
2081	registered event listener using the
2082	<link to="IExtraDataCanChangeEvent"/>
2083	notification for a permission. If one of the listeners refuses the
2084	new value, the change will not be performed.
2085	</note>
2086	<note>
2087	On success, the
2088	<link to="IExtraDataChangedEvent"/> notification
2089	is called to inform all registered listeners about a successful data
2090	change.
2091	</note>
2092
2093	<result name="VBOX_E_FILE_ERROR">
2094	Settings file not accessible.
2095	</result>
2096	<result name="VBOX_E_XML_ERROR">
2097	Could not parse the settings file.
2098	</result>
2099	<result name="E_ACCESSDENIED">
2100	Modification request refused.
2101	</result>
2102
2103	</desc>
2104	<param name="key" type="wstring" dir="in">
2105	<desc>Name of the data key to set.</desc>
2106	</param>
2107	<param name="value" type="wstring" dir="in">
2108	<desc>Value to assign to the key.</desc>
2109	</param>
2110	</method>
2111
2112	<!--method name="createDHCPServerForInterface">
2113	<desc>
2114	Creates a dhcp server settings to be used for the given interface
2115	<result name="E_INVALIDARG">
2116	Host network interface @a name already exists.
2117	</result>
2118	</desc>
2119	<param name="interface" type="IHostNetworkInterface" dir="in">
2120	<desc>Network Interface</desc>
2121	</param>
2122	<param name="server" type="IDHCPServer" dir="out">
2123	<desc>Dhcp server settings</desc>
2124	</param>
2125	</method-->
2126
2127	<method name="createDHCPServer">
2128	<desc>
2129	Creates a dhcp server settings to be used for the given internal network name
2130	<result name="E_INVALIDARG">
2131	Host network interface @a name already exists.
2132	</result>
2133	</desc>
2134	<param name="name" type="wstring" dir="in">
2135	<desc>server name</desc>
2136	</param>
2137	<param name="server" type="IDHCPServer" dir="return">
2138	<desc>Dhcp server settings</desc>
2139	</param>
2140	</method>
2141
2142	<method name="findDHCPServerByNetworkName">
2143	<desc>
2144	Searches a dhcp server settings to be used for the given internal network name
2145	<result name="E_INVALIDARG">
2146	Host network interface @a name already exists.
2147	</result>
2148
2149	</desc>
2150	<param name="name" type="wstring" dir="in">
2151	<desc>server name</desc>
2152	</param>
2153	<param name="server" type="IDHCPServer" dir="return">
2154	<desc>Dhcp server settings</desc>
2155	</param>
2156	</method>
2157
2158	<!--method name="findDHCPServerForInterface">
2159	<desc>
2160	Searches a dhcp server settings to be used for the given interface
2161	<result name="E_INVALIDARG">
2162	Host network interface @a name already exists.
2163	</result>
2164	</desc>
2165	<param name="interface" type="IHostNetworkInterface" dir="in">
2166	<desc>Network Interface</desc>
2167	</param>
2168	<param name="server" type="IDHCPServer" dir="out">
2169	<desc>Dhcp server settings</desc>
2170	</param>
2171	</method-->
2172
2173	<method name="removeDHCPServer">
2174	<desc>
2175	Removes the dhcp server settings
2176	<result name="E_INVALIDARG">
2177	Host network interface @a name already exists.
2178	</result>
2179	</desc>
2180	<param name="server" type="IDHCPServer" dir="in">
2181	<desc>Dhcp server settings to be removed</desc>
2182	</param>
2183	</method>
2184
2185
2186	<method name="checkFirmwarePresent">
2187	<desc>
2188	Check if this VirtualBox installation has a firmware
2189	of the given type available, either system-wide or per-user.
2190	Optionally, this may return a hint where this firmware can be
2191	downloaded from.
2192	</desc>
2193	<param name="firmwareType" type="FirmwareType" dir="in">
2194	<desc>
2195	Type of firmware to check.
2196	</desc>
2197	</param>
2198	<param name="version" type="wstring" dir="in">
2199	<desc>Expected version number, usually empty string (presently ignored).</desc>
2200	</param>
2201
2202	<param name="url" type="wstring" dir="out">
2203	<desc>
2204	Suggested URL to download this firmware from.
2205	</desc>
2206	</param>
2207
2208	<param name="file" type="wstring" dir="out">
2209	<desc>
2210	Filename of firmware, only valid if result == TRUE.
2211	</desc>
2212	</param>
2213
2214	<param name="result" type="boolean" dir="return">
2215	<desc>If firmware of this type and version is available.</desc>
2216	</param>
2217	</method>
2218
2219	</interface>
2220
2221	<!--
2222	// IVFSExplorer
2223	/////////////////////////////////////////////////////////////////////////
2224	-->
2225
2226	<enum
2227	name="VFSType"
2228	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2229	>
2230	<desc>
2231	Virtual file systems supported by VFSExplorer.
2232	</desc>
2233
2234	<const name="File" value="1" />
2235	<const name="Cloud" value="2" />
2236	<const name="S3" value="3" />
2237	<const name="WebDav" value="4" />
2238	</enum>
2239
2240	<enum
2241	name="VFSFileType"
2242	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2243	>
2244	<desc>
2245	File types known by VFSExplorer.
2246	</desc>
2247
2248	<const name="Unknown" value="1" />
2249	<const name="Fifo" value="2" />
2250	<const name="DevChar" value="3" />
2251	<const name="Directory" value="4" />
2252	<const name="DevBlock" value="5" />
2253	<const name="File" value="6" />
2254	<const name="SymLink" value="7" />
2255	<const name="Socket" value="8" />
2256	<const name="WhiteOut" value="9" />
2257	</enum>
2258
2259	<interface
2260	name="IVFSExplorer" extends="$unknown"
2261	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2262	wsmap="managed"
2263	>
2264	<desc>
2265	The VFSExplorer interface unifies access to different file system
2266	types. This includes local file systems as well remote file systems like
2267	S3. For a list of supported types see <link to="VFSType" />.
2268	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2269	</desc>
2270
2271	<attribute name="path" type="wstring" readonly="yes">
2272	<desc>Returns the current path in the virtual file system.</desc>
2273	</attribute>
2274
2275	<attribute name="type" type="VFSType" readonly="yes">
2276	<desc>Returns the file system type which is currently in use.</desc>
2277	</attribute>
2278
2279	<method name="update">
2280	<desc>Updates the internal list of files/directories from the
2281	current directory level. Use <link to="#entryList" /> to get the full list
2282	after a call to this method.</desc>
2283
2284	<param name="aProgress" type="IProgress" dir="return">
2285	<desc>Progress object to track the operation completion.</desc>
2286	</param>
2287	</method>
2288
2289	<method name="cd">
2290	<desc>Change the current directory level.</desc>
2291
2292	<param name="aDir" type="wstring" dir="in">
2293	<desc>The name of the directory to go in.</desc>
2294	</param>
2295
2296	<param name="aProgress" type="IProgress" dir="return">
2297	<desc>Progress object to track the operation completion.</desc>
2298	</param>
2299	</method>
2300
2301	<method name="cdUp">
2302	<desc>Go one directory upwards from the current directory level.</desc>
2303
2304	<param name="aProgress" type="IProgress" dir="return">
2305	<desc>Progress object to track the operation completion.</desc>
2306	</param>
2307	</method>
2308
2309	<method name="entryList">
2310	<desc>Returns a list of files/directories after a call to <link
2311	to="#update" />. The user is responsible for keeping this internal
2312	list up do date.</desc>
2313
2314	<param name="aNames" type="wstring" safearray="yes" dir="out">
2315	<desc>The list of names for the entries.</desc>
2316	</param>
2317
2318	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2319	<desc>The list of types for the entries.</desc>
2320	</param>
2321
2322	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2323	<desc>The list of sizes (in bytes) for the entries.</desc>
2324	</param>
2325
2326	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2327	<desc>The list of file modes (in octal form) for the entries.</desc>
2328	</param>
2329	</method>
2330
2331	<method name="exists">
2332	<desc>Checks if the given file list exists in the current directory
2333	level.</desc>
2334
2335	<param name="aNames" type="wstring" safearray="yes" dir="in">
2336	<desc>The names to check.</desc>
2337	</param>
2338
2339	<param name="aExists" type="wstring" safearray="yes" dir="return">
2340	<desc>The names which exist.</desc>
2341	</param>
2342	</method>
2343
2344	<method name="remove">
2345	<desc>Deletes the given files in the current directory level.</desc>
2346
2347	<param name="aNames" type="wstring" safearray="yes" dir="in">
2348	<desc>The names to remove.</desc>
2349	</param>
2350
2351	<param name="aProgress" type="IProgress" dir="return">
2352	<desc>Progress object to track the operation completion.</desc>
2353	</param>
2354	</method>
2355
2356	</interface>
2357
2358	<enum
2359	name="ImportOptions" extends="$unknown"
2360	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2361	>
2362
2363	<desc>
2364	Import options, used with <link to="IAppliance::importMachines" />.
2365	</desc>
2366
2367	<const name="KeepAllMACs" value="1">
2368	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2369	</const>
2370	<const name="KeepNATMACs" value="2">
2371	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2372	</const>
2373
2374	</enum>
2375
2376
2377	<!--
2378	// IAppliance
2379	/////////////////////////////////////////////////////////////////////////
2380	-->
2381
2382	<interface
2383	name="IAppliance" extends="$unknown"
2384	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2385	wsmap="managed"
2386	>
2387	<desc>
2388	Represents a platform-independent appliance in OVF format. An instance of this is returned
2389	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2390	virtual machines within an appliance with VirtualBox.
2391
2392	The OVF standard suggests two different physical file formats:
2393
2394	<ol>
2395	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2396	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2397	this descriptor file references other files such as disk images, as OVF appliances typically
2398	do, those additional files must be in the same directory as the descriptor file.</li>
2399
2400	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2401	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2402	files and optionally other files.
2403
2404	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2405	be added with a later version.</li>
2406	</ol>
2407
2408	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2409	<link to="IMachine" /> involves the following sequence of API calls:
2410
2411	<ol>
2412	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2413	</li>
2414
2415	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2416	would like to import. So long as this file is syntactically valid, this will succeed
2417	and fill the appliance object with the parsed data from the OVF file.
2418	</li>
2419
2420	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2421	contents of the IAppliance attributes accordingly. These can be inspected by a
2422	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2423	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2424	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2425	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2426	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2427	The GUI can then give the user the option to confirm and/or change these suggestions.
2428	</li>
2429
2430	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2431	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2432	</li>
2433
2434	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2435	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2436	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2437	can be found in the <link to="#machines" /> array attribute.
2438	</li>
2439	</ol>
2440
2441	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2442
2443	<ol>
2444	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2445	an empty IAppliance object.
2446	</li>
2447
2448	<li>For each machine you would like to export, call <link to="IMachine::export" />
2449	with the IAppliance object you just created. Each such call creates one instance of
2450	<link to="IVirtualSystemDescription" /> inside the appliance.
2451	</li>
2452
2453	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2454	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2455	</li>
2456
2457	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2458	file written.</li>
2459	</ol>
2460
2461	</desc>
2462
2463	<attribute name="path" type="wstring" readonly="yes">
2464	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2465	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2466	<link to="#write" /> (for export).
2467	This attribute is empty until one of these methods has been called.
2468	</desc>
2469	</attribute>
2470
2471	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2472	<desc>
2473	Array of virtual disk definitions. One such description exists for each
2474	disk definition in the OVF; each string array item represents one such piece of
2475	disk information, with the information fields separated by tab (\\t) characters.
2476
2477	The caller should be prepared for additional fields being appended to
2478	this string in future versions of VirtualBox and therefore check for
2479	the number of tabs in the strings returned.
2480
2481	In the current version, the following eight fields are returned per string
2482	in the array:
2483
2484	<ol>
2485	<li>Disk ID (unique string identifier given to disk)</li>
2486
2487	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2488
2489	<li>Populated size (optional unsigned integer indicating the current size of the
2490	disk; can be approximate; -1 if unspecified)</li>
2491
2492	<li>Format (string identifying the disk format, typically
2493	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2494
2495	<li>Reference (where to find the disk image, typically a file name; if empty,
2496	then the disk should be created on import)</li>
2497
2498	<li>Image size (optional unsigned integer indicating the size of the image,
2499	which need not necessarily be the same as the values specified above, since
2500	the image may be compressed or sparse; -1 if not specified)</li>
2501
2502	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2503	presently unsupported and always -1)</li>
2504
2505	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2506	</ol>
2507	</desc>
2508	</attribute>
2509
2510	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2511	<desc> Array of virtual system descriptions. One such description is created
2512	for each virtual system (machine) found in the OVF.
2513	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2514	(for export) has been called.
2515	</desc>
2516	</attribute>
2517
2518	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2519	<desc>
2520	Contains the UUIDs of the machines created from the information in this appliances. This is only
2521	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2522	succeeded.
2523	</desc>
2524	</attribute>
2525
2526	<method name="read">
2527	<desc>
2528	Reads an OVF file into the appliance object.
2529
2530	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2531	mere fact that this method returns successfully does not mean that VirtualBox supports all
2532	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2533	</desc>
2534	<param name="file" type="wstring" dir="in">
2535	<desc>
2536	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2537	on whether the appliance is distributed as a set of files or as a single file, respectively).
2538	</desc>
2539	</param>
2540	<param name="aProgress" type="IProgress" dir="return">
2541	<desc>Progress object to track the operation completion.</desc>
2542	</param>
2543	</method>
2544
2545	<method name="interpret">
2546	<desc>
2547	Interprets the OVF data that was read when the appliance was constructed. After
2548	calling this method, one can inspect the
2549	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2550	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2551	the appliance.
2552
2553	Calling this method is the second step of importing an appliance into VirtualBox;
2554	see <link to="IAppliance" /> for an overview.
2555
2556	After calling this method, one should call <link to="#getWarnings" /> to find out
2557	if problems were encountered during the processing which might later lead to
2558	errors.
2559	</desc>
2560	</method>
2561
2562	<method name="importMachines">
2563	<desc>
2564	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2565	and other interfaces that match the information contained in the appliance as
2566	closely as possible, as represented by the import instructions in the
2567	<link to="#virtualSystemDescriptions" /> array.
2568
2569	Calling this method is the final step of importing an appliance into VirtualBox;
2570	see <link to="IAppliance" /> for an overview.
2571
2572	Since importing the appliance will most probably involve copying and converting
2573	disk images, which can take a long time, this method operates asynchronously and
2574	returns an IProgress object to allow the caller to monitor the progress.
2575
2576	After the import succeeded, the UUIDs of the IMachine instances created can be
2577	retrieved from the <link to="#machines" /> array attribute.
2578	</desc>
2579
2580	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2581	<desc>Options for the importing operation.</desc>
2582	</param>
2583
2584	<param name="aProgress" type="IProgress" dir="return">
2585	<desc>Progress object to track the operation completion.</desc>
2586	</param>
2587	</method>
2588
2589	<method name="createVFSExplorer">
2590	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2591
2592	<param name="aUri" type="wstring" dir="in">
2593	<desc>The URI describing the file system to use.</desc>
2594	</param>
2595
2596	<param name="aExplorer" type="IVFSExplorer" dir="return">
2597	<desc></desc>
2598	</param>
2599	</method>
2600
2601	<method name="write">
2602	<desc>
2603	Writes the contents of the appliance exports into a new OVF file.
2604
2605	Calling this method is the final step of exporting an appliance from VirtualBox;
2606	see <link to="IAppliance" /> for an overview.
2607
2608	Since exporting the appliance will most probably involve copying and converting
2609	disk images, which can take a long time, this method operates asynchronously and
2610	returns an IProgress object to allow the caller to monitor the progress.
2611	</desc>
2612	<param name="format" type="wstring" dir="in">
2613	<desc>
2614	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2615	future versions of VirtualBox may support additional formats.
2616	</desc>
2617	</param>
2618	<param name="manifest" type="boolean" dir="in">
2619	<desc>
2620	Indicate if the optional manifest file (.mf) should be written. The manifest file
2621	is used for integrity checks prior import.
2622	</desc>
2623	</param>
2624	<param name="path" type="wstring" dir="in">
2625	<desc>
2626	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2627	on whether the appliance is distributed as a set of files or as a single file, respectively).
2628	</desc>
2629	</param>
2630	<param name="progress" type="IProgress" dir="return">
2631	<desc>Progress object to track the operation completion.</desc>
2632	</param>
2633	</method>
2634
2635	<method name="getWarnings">
2636	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2637
2638	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2639	<desc></desc>
2640	</param>
2641	</method>
2642
2643	</interface>
2644
2645	<enum
2646	name="VirtualSystemDescriptionType"
2647	uuid="303c0900-a746-4612-8c67-79003e91f459"
2648	>
2649	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2650	a configuration value.</desc>
2651
2652	<const name="Ignore" value="1" />
2653	<const name="OS" value="2" />
2654	<const name="Name" value="3" />
2655	<const name="Product" value="4" />
2656	<const name="Vendor" value="5" />
2657	<const name="Version" value="6" />
2658	<const name="ProductUrl" value="7" />
2659	<const name="VendorUrl" value="8" />
2660	<const name="Description" value="9" />
2661	<const name="License" value="10" />
2662	<const name="Miscellaneous" value="11" />
2663	<const name="CPU" value="12" />
2664	<const name="Memory" value="13" />
2665	<const name="HardDiskControllerIDE" value="14" />
2666	<const name="HardDiskControllerSATA" value="15" />
2667	<const name="HardDiskControllerSCSI" value="16" />
2668	<const name="HardDiskControllerSAS" value="17" />
2669	<const name="HardDiskImage" value="18" />
2670	<const name="Floppy" value="19" />
2671	<const name="CDROM" value="20" />
2672	<const name="NetworkAdapter" value="21" />
2673	<const name="USBController" value="22" />
2674	<const name="SoundCard" value="23" />
2675	<const name="SettingsFile" value="24">
2676	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2677	</const>
2678	</enum>
2679
2680	<enum
2681	name="VirtualSystemDescriptionValueType"
2682	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2683	>
2684	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2685	type to fetch.</desc>
2686
2687	<const name="Reference" value="1" />
2688	<const name="Original" value="2" />
2689	<const name="Auto" value="3" />
2690	<const name="ExtraConfig" value="4" />
2691
2692	</enum>
2693
2694	<interface
2695	name="IVirtualSystemDescription" extends="$unknown"
2696	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2697	wsmap="managed"
2698	>
2699
2700	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2701	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2702	<link to="IAppliance::interpret" /> has been called, that array contains information
2703	about how the virtual systems described in the OVF should best be imported into
2704	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2705	import an OVF into VirtualBox.
2706	</desc>
2707
2708	<attribute name="count" type="unsigned long" readonly="yes">
2709	<desc>Return the number of virtual system description entries.</desc>
2710	</attribute>
2711
2712	<method name="getDescription">
2713	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2714	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2715
2716	The list below identifies the value sets that are possible depending on the
2717	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2718	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2719	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2720	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2721	the @a aExtraConfigValues[] array item may also be used.
2722
2723	<ul>
2724	<li>
2725	"OS": the guest operating system type. There must be exactly one such array item on import. The
2726	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2727	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2728	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2729	</li>
2730	<li>
2731	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2732	if none is present on import, then an automatic name will be created from the operating system
2733	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2734	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2735	<link to="IMachine" /> name that does not exist yet.
2736	</li>
2737	<li>
2738	"Description": an arbitrary description.
2739	</li>
2740	<li>
2741	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2742	code to display such a license for agreement; the Main API does not enforce any such policy.
2743	</li>
2744	<li>
2745	Miscellaneous: reserved for future use.
2746	</li>
2747	<li>
2748	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2749	</li>
2750	<li>
2751	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2752	is present on import, then VirtualBox will set a meaningful default based on the operating system
2753	type.
2754	</li>
2755	<li>
2756	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2757	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2758	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2759	writes into the OVF.
2760	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2761	type can use to specify which hard disk controller a virtual disk should be connected to.
2762	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2763	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2764	its virtual machines supports four channels (primary master, primary slave, secondary master,
2765	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2766	</li>
2767	<li>
2768	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2769	has no value in @a aOvfValues[] or @a aVBoxValues[].
2770	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2771	</li>
2772	<li>
2773	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2774	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2775	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2776	whereas VirtualBox considers it a class of storage controllers of its own; see
2777	<link to="StorageControllerType" />).
2778	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2779	</li>
2780	<li>
2781	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2782	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2783
2784	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2785	a path since the image file should be in the same location as the OVF file itself), whereas the
2786	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2787	hard disk image. This means that on import the image will be copied and converted from the
2788	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2789
2790	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2791	format: "controller=<index>;channel=<c>"
2792	In this string, <index> must be an integer specifying the hard disk controller to connect
2793	the image to. That number must be the index of an array item with one of the hard disk controller
2794	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2795	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2796	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2797	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2798	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2799	</li>
2800	<li>
2801	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2802	attachment information as with "HardDiskImage" items.
2803	</li>
2804	<li>
2805	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2806	attachment information as with "HardDiskImage" items.
2807	</li>
2808	<li>
2809	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2810	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2811	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2812	</li>
2813	<li>
2814	"USBController": a USB controller. There can be at most one such item. If and only if such an
2815	item ispresent, USB support will be enabled for the new virtual machine.
2816	</li>
2817	<li>
2818	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2819	present, sound support will be enabled for the new virtual machine. Note that the virtual
2820	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2821	may be different from the virtual soundcard expected by the appliance.
2822	</li>
2823	</ul>
2824
2825	</desc>
2826
2827	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2828	<desc></desc>
2829	</param>
2830
2831	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2832	<desc></desc>
2833	</param>
2834
2835	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2836	<desc></desc>
2837	</param>
2838
2839	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2840	<desc></desc>
2841	</param>
2842
2843	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2844	<desc></desc>
2845	</param>
2846
2847	</method>
2848
2849	<method name="getDescriptionByType">
2850	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2851	should be returned.</desc>
2852
2853	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2854	<desc></desc>
2855	</param>
2856
2857	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2858	<desc></desc>
2859	</param>
2860
2861	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2862	<desc></desc>
2863	</param>
2864
2865	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2866	<desc></desc>
2867	</param>
2868
2869	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2870	<desc></desc>
2871	</param>
2872
2873	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2874	<desc></desc>
2875	</param>
2876
2877	</method>
2878
2879	<method name="getValuesByType">
2880	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2881	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2882	values.</desc>
2883
2884	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2885	<desc></desc>
2886	</param>
2887
2888	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2889	<desc></desc>
2890	</param>
2891
2892	<param name="aValues" type="wstring" dir="return" safearray="yes">
2893	<desc></desc>
2894	</param>
2895
2896	</method>
2897
2898	<method name="setFinalValues">
2899	<desc>
2900	This method allows the appliance's user to change the configuration for the virtual
2901	system descriptions. For each array item returned from <link to="#getDescription" />,
2902	you must pass in one boolean value and one configuration value.
2903
2904	Each item in the boolean array determines whether the particular configuration item
2905	should be enabled.
2906	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2907	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2908	and SoundCard.
2909
2910	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2911	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2912	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2913	for valid configuration values for the individual array item types. If the
2914	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2915	</desc>
2916
2917	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2918	<desc></desc>
2919	</param>
2920
2921	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2922	<desc></desc>
2923	</param>
2924
2925	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2926	<desc></desc>
2927	</param>
2928	</method>
2929
2930	<method name="addDescription">
2931	<desc>
2932	This method adds an additional description entry to the stack of already
2933	available descriptions for this virtual system. This is handy for writing
2934	values which aren't directly supported by VirtualBox. One example would
2935	be the License type of <link to="VirtualSystemDescriptionType" />.
2936	</desc>
2937
2938	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2939	<desc></desc>
2940	</param>
2941
2942	<param name="aVBoxValue" type="wstring" dir="in">
2943	<desc></desc>
2944	</param>
2945
2946	<param name="aExtraConfigValue" type="wstring" dir="in">
2947	<desc></desc>
2948	</param>
2949	</method>
2950	</interface>
2951
2952
2953	<!--
2954	// IMachine
2955	/////////////////////////////////////////////////////////////////////////
2956	-->
2957
2958	<interface
2959	name="IInternalMachineControl" extends="$unknown"
2960	uuid="2087906d-bb92-43a0-8014-4cab009e4888"
2961	internal="yes"
2962	wsmap="suppress"
2963	>
2964	<method name="setRemoveSavedStateFile">
2965	<desc>
2966	Updates the flag whether the saved state file is removed on a
2967	machine state change from Saved to PoweredOff.
2968	</desc>
2969	<param name="aRemove" type="boolean" dir="in"/>
2970	</method>
2971
2972	<method name="updateState">
2973	<desc>
2974	Updates the VM state.
2975	<note>
2976	This operation will also update the settings file with the correct
2977	information about the saved state file and delete this file from disk
2978	when appropriate.
2979	</note>
2980	</desc>
2981	<param name="state" type="MachineState" dir="in"/>
2982	</method>
2983
2984	<method name="getIPCId">
2985	<param name="id" type="wstring" dir="return"/>
2986	</method>
2987
2988	<method name="beginPowerUp">
2989	<desc>
2990	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2991	gives it the progress object that should be part of any pending
2992	<link to="IMachine::launchVMProcess"/> operations. The progress
2993	object may be called back to reflect an early cancelation, so some care
2994	have to be taken with respect to any cancelation callbacks. The console
2995	object will call <link to="IInternalMachineControl::endPowerUp"/>
2996	to signal the completion of the progress object.
2997	</desc>
2998	<param name="aProgress" type="IProgress" dir="in" />
2999	</method>
3000
3001	<method name="endPowerUp">
3002	<desc>
3003	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3004	This method may query status information from the progress object it
3005	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3006	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3007	call in order to complete that progress object.
3008	</desc>
3009	<param name="result" type="long" dir="in"/>
3010	</method>
3011
3012	<method name="beginPoweringDown">
3013	<desc>
3014	Called by the VM process to inform the server it wants to
3015	stop the VM execution and power down.
3016	</desc>
3017	<param name="progress" type="IProgress" dir="out">
3018	<desc>
3019	Progress object created by VBoxSVC to wait until
3020	the VM is powered down.
3021	</desc>
3022	</param>
3023	</method>
3024
3025	<method name="endPoweringDown">
3026	<desc>
3027	Called by the VM process to inform the server that powering
3028	down previously requested by #beginPoweringDown is either
3029	successfully finished or there was a failure.
3030
3031	<result name="VBOX_E_FILE_ERROR">
3032	Settings file not accessible.
3033	</result>
3034	<result name="VBOX_E_XML_ERROR">
3035	Could not parse the settings file.
3036	</result>
3037
3038	</desc>
3039
3040	<param name="result" type="long" dir="in">
3041	<desc>@c S_OK to indicate success.
3042	</desc>
3043	</param>
3044	<param name="errMsg" type="wstring" dir="in">
3045	<desc>@c human readable error message in case of failure.
3046	</desc>
3047	</param>
3048	</method>
3049
3050	<method name="runUSBDeviceFilters">
3051	<desc>
3052	Asks the server to run USB devices filters of the associated
3053	machine against the given USB device and tell if there is
3054	a match.
3055	<note>
3056	Intended to be used only for remote USB devices. Local
3057	ones don't require to call this method (this is done
3058	implicitly by the Host and USBProxyService).
3059	</note>
3060	</desc>
3061	<param name="device" type="IUSBDevice" dir="in"/>
3062	<param name="matched" type="boolean" dir="out"/>
3063	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3064	</method>
3065
3066	<method name="captureUSBDevice">
3067	<desc>
3068	Requests a capture of the given host USB device.
3069	When the request is completed, the VM process will
3070	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3071	notification.
3072	</desc>
3073	<param name="id" type="uuid" mod="string" dir="in"/>
3074	</method>
3075
3076	<method name="detachUSBDevice">
3077	<desc>
3078	Notification that a VM is going to detach (@a done = @c false) or has
3079	already detached (@a done = @c true) the given USB device.
3080	When the @a done = @c true request is completed, the VM process will
3081	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3082	notification.
3083	<note>
3084	In the @a done = @c true case, the server must run its own filters
3085	and filters of all VMs but this one on the detached device
3086	as if it were just attached to the host computer.
3087	</note>
3088	</desc>
3089	<param name="id" type="uuid" mod="string" dir="in"/>
3090	<param name="done" type="boolean" dir="in"/>
3091	</method>
3092
3093	<method name="autoCaptureUSBDevices">
3094	<desc>
3095	Requests a capture all matching USB devices attached to the host.
3096	When the request is completed, the VM process will
3097	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3098	notification per every captured device.
3099	</desc>
3100	</method>
3101
3102	<method name="detachAllUSBDevices">
3103	<desc>
3104	Notification that a VM that is being powered down. The done
3105	parameter indicates whether which stage of the power down
3106	we're at. When @a done = @c false the VM is announcing its
3107	intentions, while when @a done = @c true the VM is reporting
3108	what it has done.
3109	<note>
3110	In the @a done = @c true case, the server must run its own filters
3111	and filters of all VMs but this one on all detach devices as
3112	if they were just attached to the host computer.
3113	</note>
3114	</desc>
3115	<param name="done" type="boolean" dir="in"/>
3116	</method>
3117
3118	<method name="onSessionEnd">
3119	<desc>
3120	Triggered by the given session object when the session is about
3121	to close normally.
3122	</desc>
3123	<param name="session" type="ISession" dir="in">
3124	<desc>Session that is being closed</desc>
3125	</param>
3126	<param name="progress" type="IProgress" dir="return">
3127	<desc>
3128	Used to wait until the corresponding machine is actually
3129	dissociated from the given session on the server.
3130	Returned only when this session is a direct one.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="beginSavingState">
3136	<desc>
3137	Called by the VM process to inform the server it wants to
3138	save the current state and stop the VM execution.
3139	</desc>
3140	<param name="progress" type="IProgress" dir="out">
3141	<desc>
3142	Progress object created by VBoxSVC to wait until
3143	the state is saved.
3144	</desc>
3145	</param>
3146	<param name="stateFilePath" type="wstring" dir="out">
3147	<desc>
3148	File path the VM process must save the execution state to.
3149	</desc>
3150	</param>
3151	</method>
3152
3153	<method name="endSavingState">
3154	<desc>
3155	Called by the VM process to inform the server that saving
3156	the state previously requested by #beginSavingState is either
3157	successfully finished or there was a failure.
3158
3159	<result name="VBOX_E_FILE_ERROR">
3160	Settings file not accessible.
3161	</result>
3162	<result name="VBOX_E_XML_ERROR">
3163	Could not parse the settings file.
3164	</result>
3165
3166	</desc>
3167
3168	<param name="result" type="long" dir="in">
3169	<desc>@c S_OK to indicate success.
3170	</desc>
3171	</param>
3172	<param name="errMsg" type="wstring" dir="in">
3173	<desc>@c human readable error message in case of failure.
3174	</desc>
3175	</param>
3176	</method>
3177
3178	<method name="adoptSavedState">
3179	<desc>
3180	Gets called by <link to="IConsole::adoptSavedState"/>.
3181	<result name="VBOX_E_FILE_ERROR">
3182	Invalid saved state file path.
3183	</result>
3184	</desc>
3185	<param name="savedStateFile" type="wstring" dir="in">
3186	<desc>Path to the saved state file to adopt.</desc>
3187	</param>
3188	</method>
3189
3190	<method name="beginTakingSnapshot">
3191	<desc>
3192	Called from the VM process to request from the server to perform the
3193	server-side actions of creating a snapshot (creating differencing images
3194	and the snapshot object).
3195
3196	<result name="VBOX_E_FILE_ERROR">
3197	Settings file not accessible.
3198	</result>
3199	<result name="VBOX_E_XML_ERROR">
3200	Could not parse the settings file.
3201	</result>
3202	</desc>
3203	<param name="initiator" type="IConsole" dir="in">
3204	<desc>The console object that initiated this call.</desc>
3205	</param>
3206	<param name="name" type="wstring" dir="in">
3207	<desc>Snapshot name.</desc>
3208	</param>
3209	<param name="description" type="wstring" dir="in">
3210	<desc>Snapshot description.</desc>
3211	</param>
3212	<param name="consoleProgress" type="IProgress" dir="in">
3213	<desc>
3214	Progress object created by the VM process tracking the
3215	snapshot's progress. This has the following sub-operations:
3216	<ul>
3217	<li>setting up (weight 1);</li>
3218	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3219	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3220	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3221	<li>finishing up (weight 1)</li>
3222	</ul>
3223	</desc>
3224	</param>
3225	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3226	<desc>
3227	Whether this is an online snapshot (i.e. the machine is running).
3228	</desc>
3229	</param>
3230	<param name="stateFilePath" type="wstring" dir="out">
3231	<desc>
3232	File path the VM process must save the execution state to.
3233	</desc>
3234	</param>
3235	</method>
3236
3237	<method name="endTakingSnapshot">
3238	<desc>
3239	Called by the VM process to inform the server that the snapshot
3240	previously requested by #beginTakingSnapshot is either
3241	successfully taken or there was a failure.
3242	</desc>
3243
3244	<param name="success" type="boolean" dir="in">
3245	<desc>@c true to indicate success and @c false otherwise</desc>
3246	</param>
3247	</method>
3248
3249	<method name="deleteSnapshot">
3250	<desc>
3251	Gets called by <link to="IConsole::deleteSnapshot"/>,
3252	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3253	<link to="IConsole::deleteSnapshotRange"/>.
3254	<result name="VBOX_E_INVALID_OBJECT_STATE">
3255	Snapshot has more than one child snapshot. Only possible if the
3256	delete operation does not delete all children or the range does
3257	not meet the linearity condition.
3258	</result>
3259	</desc>
3260	<param name="initiator" type="IConsole" dir="in">
3261	<desc>The console object that initiated this call.</desc>
3262	</param>
3263	<param name="startId" type="uuid" mod="string" dir="in">
3264	<desc>UUID of the first snapshot to delete.</desc>
3265	</param>
3266	<param name="endId" type="uuid" mod="string" dir="in">
3267	<desc>UUID of the last snapshot to delete.</desc>
3268	</param>
3269	<param name="deleteAllChildren" type="boolean" dir="in">
3270	<desc>Whether all children should be deleted.</desc>
3271	</param>
3272	<param name="machineState" type="MachineState" dir="out">
3273	<desc>New machine state after this operation is started.</desc>
3274	</param>
3275	<param name="progress" type="IProgress" dir="return">
3276	<desc>Progress object to track the operation completion.</desc>
3277	</param>
3278	</method>
3279
3280	<method name="finishOnlineMergeMedium">
3281	<desc>
3282	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3283	</desc>
3284	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3285	<desc>The medium attachment which needs to be cleaned up.</desc>
3286	</param>
3287	<param name="source" type="IMedium" dir="in">
3288	<desc>Merge source medium.</desc>
3289	</param>
3290	<param name="target" type="IMedium" dir="in">
3291	<desc>Merge target medium.</desc>
3292	</param>
3293	<param name="mergeForward" type="boolean" dir="in">
3294	<desc>Merge direction.</desc>
3295	</param>
3296	<param name="parentForTarget" type="IMedium" dir="in">
3297	<desc>For forward merges: new parent for target medium.</desc>
3298	</param>
3299	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3300	<desc>For backward merges: list of media which need their parent UUID
3301	updated.</desc>
3302	</param>
3303	</method>
3304
3305	<method name="restoreSnapshot">
3306	<desc>
3307	Gets called by <link to="IConsole::restoreSnapshot"/>.
3308	</desc>
3309	<param name="initiator" type="IConsole" dir="in">
3310	<desc>The console object that initiated this call.</desc>
3311	</param>
3312	<param name="snapshot" type="ISnapshot" dir="in">
3313	<desc>The snapshot to restore the VM state from.</desc>
3314	</param>
3315	<param name="machineState" type="MachineState" dir="out">
3316	<desc>New machine state after this operation is started.</desc>
3317	</param>
3318	<param name="progress" type="IProgress" dir="return">
3319	<desc>Progress object to track the operation completion.</desc>
3320	</param>
3321	</method>
3322
3323	<method name="pullGuestProperties">
3324	<desc>
3325	Get the list of the guest properties matching a set of patterns along
3326	with their values, time stamps and flags and give responsibility for
3327	managing properties to the console.
3328	</desc>
3329	<param name="name" type="wstring" dir="out" safearray="yes">
3330	<desc>
3331	The names of the properties returned.
3332	</desc>
3333	</param>
3334	<param name="value" type="wstring" dir="out" safearray="yes">
3335	<desc>
3336	The values of the properties returned. The array entries match the
3337	corresponding entries in the @a name array.
3338	</desc>
3339	</param>
3340	<param name="timestamp" type="long long" dir="out" safearray="yes">
3341	<desc>
3342	The time stamps of the properties returned. The array entries match
3343	the corresponding entries in the @a name array.
3344	</desc>
3345	</param>
3346	<param name="flags" type="wstring" dir="out" safearray="yes">
3347	<desc>
3348	The flags of the properties returned. The array entries match the
3349	corresponding entries in the @a name array.
3350	</desc>
3351	</param>
3352	</method>
3353
3354	<method name="pushGuestProperty">
3355	<desc>
3356	Update a single guest property in IMachine.
3357	</desc>
3358	<param name="name" type="wstring" dir="in">
3359	<desc>
3360	The name of the property to be updated.
3361	</desc>
3362	</param>
3363	<param name="value" type="wstring" dir="in">
3364	<desc>
3365	The value of the property.
3366	</desc>
3367	</param>
3368	<param name="timestamp" type="long long" dir="in">
3369	<desc>
3370	The timestamp of the property.
3371	</desc>
3372	</param>
3373	<param name="flags" type="wstring" dir="in">
3374	<desc>
3375	The flags of the property.
3376	</desc>
3377	</param>
3378	</method>
3379
3380	<method name="lockMedia">
3381	<desc>
3382	Locks all media attached to the machine for writing and parents of
3383	attached differencing media (if any) for reading. This operation is
3384	atomic so that if it fails no media is actually locked.
3385
3386	This method is intended to be called when the machine is in Starting or
3387	Restoring state. The locked media will be automatically unlocked when
3388	the machine is powered off or crashed.
3389	</desc>
3390	</method>
3391	<method name="unlockMedia">
3392	<desc>
3393	Unlocks all media previously locked using
3394	<link to="IInternalMachineControl::lockMedia"/>.
3395
3396	This method is intended to be used with teleportation so that it is
3397	possible to teleport between processes on the same machine.
3398	</desc>
3399	</method>
3400
3401	<method name="ejectMedium">
3402	<desc>
3403	Tells VBoxSVC that the guest has ejected the medium associated with
3404	the medium attachment.
3405	</desc>
3406	<param name="attachment" type="IMediumAttachment" dir="in">
3407	<desc>
3408	The medium attachment where the eject happened.
3409	</desc>
3410	</param>
3411	<param name="newAttachment" type="IMediumAttachment" dir="return">
3412	<desc>
3413	A new reference to the medium attachment, as the config change can
3414	result in the creation of a new instance.
3415	</desc>
3416	</param>
3417	</method>
3418	</interface>
3419
3420	<interface
3421	name="IBIOSSettings" extends="$unknown"
3422	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3423	wsmap="managed"
3424	>
3425	<desc>
3426	The IBIOSSettings interface represents BIOS settings of the virtual
3427	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3428	</desc>
3429	<attribute name="logoFadeIn" type="boolean">
3430	<desc>Fade in flag for BIOS logo animation.</desc>
3431	</attribute>
3432
3433	<attribute name="logoFadeOut" type="boolean">
3434	<desc>Fade out flag for BIOS logo animation.</desc>
3435	</attribute>
3436
3437	<attribute name="logoDisplayTime" type="unsigned long">
3438	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3439	</attribute>
3440
3441	<attribute name="logoImagePath" type="wstring">
3442	<desc>
3443	Local file system path for external BIOS splash image. Empty string
3444	means the default image is shown on boot.
3445	</desc>
3446	</attribute>
3447
3448	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3449	<desc>Mode of the BIOS boot device menu.</desc>
3450	</attribute>
3451
3452	<attribute name="ACPIEnabled" type="boolean">
3453	<desc>ACPI support flag.</desc>
3454	</attribute>
3455
3456	<attribute name="IOAPICEnabled" type="boolean">
3457	<desc>
3458	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3459	and support IRQs above 15.
3460	</desc>
3461	</attribute>
3462
3463	<attribute name="timeOffset" type="long long">
3464	<desc>
3465	Offset in milliseconds from the host system time. This allows for
3466	guests running with a different system date/time than the host.
3467	It is equivalent to setting the system date/time in the BIOS except
3468	it is not an absolute value but a relative one. Guest Additions
3469	time synchronization honors this offset.
3470	</desc>
3471	</attribute>
3472
3473	<attribute name="PXEDebugEnabled" type="boolean">
3474	<desc>
3475	PXE debug logging flag. If set, VirtualBox will write extensive
3476	PXE trace information to the release log.
3477	</desc>
3478	</attribute>
3479
3480	</interface>
3481
3482	<enum
3483	name="CleanupMode"
3484	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3485	>
3486	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3487	</desc>
3488	<const name="UnregisterOnly" value="1">
3489	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3490	</const>
3491	<const name="DetachAllReturnNone" value="2">
3492	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3493	</const>
3494	<const name="DetachAllReturnHardDisksOnly" value="3">
3495	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3496	</const>
3497	<const name="Full" value="4">
3498	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3499	</const>
3500	</enum>
3501
3502	<interface
3503	name="IPciAddress" extends="$unknown"
3504	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3505	wsmap="struct"
3506	>
3507
3508	<desc>
3509	Address on the PCI bus.
3510	</desc>
3511
3512	<attribute name="bus" type="short">
3513	<desc>
3514	Bus number.
3515	</desc>
3516	</attribute>
3517
3518	<attribute name="device" type="short">
3519	<desc>
3520	Device number.
3521	</desc>
3522	</attribute>
3523
3524	<attribute name="devFunction" type="short">
3525	<desc>
3526	Device function number.
3527	</desc>
3528	</attribute>
3529
3530	<method name="asLong">
3531	<desc>
3532	Convert PCI address into long.
3533	</desc>
3534	<param name="result" type="long" dir="return" />
3535	</method>
3536
3537	<method name="fromLong">
3538	<desc>
3539	Make PCI address from long.
3540	</desc>
3541	<param name="number" type="long" dir="in" />
3542	</method>
3543	</interface>
3544
3545	<interface
3546	name="IPciDeviceAttachment" extends="$unknown"
3547	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3548	wsmap="struct"
3549	>
3550
3551	<desc>
3552	Information about PCI attachments.
3553	</desc>
3554
3555	<attribute name="name" type="wstring" readonly="yes">
3556	<desc>
3557	Device name.
3558	</desc>
3559	</attribute>
3560
3561	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3562	<desc>
3563	If this is physical or virtual device.
3564	</desc>
3565	</attribute>
3566
3567	<attribute name="hostAddress" type="long" readonly="yes">
3568	<desc>
3569	Address of device on the host, applicable only to host devices.
3570	</desc>
3571	</attribute>
3572
3573	<attribute name="guestAddress" type="long" readonly="yes">
3574	<desc>
3575	Address of device on the guest.
3576	</desc>
3577	</attribute>
3578
3579	</interface>
3580
3581	<enum
3582	name="CloneMode" extends="$unknown"
3583	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3584	>
3585
3586	<desc>
3587	Clone mode, used with <link to="IMachine::cloneTo" />.
3588	</desc>
3589
3590	<const name="MachineState" value="1">
3591	<desc>Clone the state of the selected machine.</desc>
3592	</const>
3593	<const name="MachineAndChildStates" value="2">
3594	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3595	</const>
3596	<const name="AllStates" value="3">
3597	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3598	</const>
3599
3600	</enum>
3601
3602	<enum
3603	name="CloneOptions" extends="$unknown"
3604	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3605	>
3606
3607	<desc>
3608	Clone options, used with <link to="IMachine::cloneTo" />.
3609	</desc>
3610
3611	<const name="Link" value="1">
3612	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3613	</const>
3614	<const name="KeepAllMACs" value="2">
3615	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3616	</const>
3617	<const name="KeepNATMACs" value="3">
3618	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3619	</const>
3620	<const name="KeepDiskNames" value="4">
3621	<desc>Don't change the disk names.</desc>
3622	</const>
3623
3624	</enum>
3625
3626
3627	<interface
3628	name="IMachine" extends="$unknown"
3629	uuid="5a8e9425-aa0d-4703-9f28-2353fc4ee623"
3630	wsmap="managed"
3631	>
3632	<desc>
3633	The IMachine interface represents a virtual machine, or guest, created
3634	in VirtualBox.
3635
3636	This interface is used in two contexts. First of all, a collection of
3637	objects implementing this interface is stored in the
3638	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3639	machines that are currently registered with this VirtualBox
3640	installation. Also, once a session has been opened for the given virtual
3641	machine (e.g. the virtual machine is running), the machine object
3642	associated with the open session can be queried from the session object;
3643	see <link to="ISession"/> for details.
3644
3645	The main role of this interface is to expose the settings of the virtual
3646	machine and provide methods to change various aspects of the virtual
3647	machine's configuration. For machine objects stored in the
3648	<link to="IVirtualBox::machines"/> collection, all attributes are
3649	read-only unless explicitly stated otherwise in individual attribute
3650	and method descriptions.
3651
3652	In order to change a machine setting, a session for this machine must be
3653	opened using one of the <link to="IMachine::lockMachine" /> or
3654	<link to="IMachine::launchVMProcess"/> methods. After the
3655	machine has been successfully locked for a session, a mutable machine object
3656	needs to be queried from the session object and then the desired settings
3657	changes can be applied to the returned object using IMachine attributes and
3658	methods. See the <link to="ISession"/> interface description for more
3659	information about sessions.
3660
3661	Note that IMachine does not provide methods to control virtual machine
3662	execution (such as start the machine, or power it down) -- these methods
3663	are grouped in a separate interface called <link to="IConsole" />.
3664
3665	<see><link to="ISession"/>, <link to="IConsole"/></see>
3666	</desc>
3667
3668	<attribute name="parent" type="IVirtualBox" readonly="yes">
3669	<desc>Associated parent object.</desc>
3670	</attribute>
3671
3672	<attribute name="accessible" type="boolean" readonly="yes">
3673	<desc>
3674	Whether this virtual machine is currently accessible or not.
3675
3676	A machine is always deemed accessible unless it is registered <i>and</i>
3677	its settings file cannot be read or parsed (either because the file itself
3678	is unavailable or has invalid XML contents).
3679
3680	Every time this property is read, the accessibility state of
3681	this machine is re-evaluated. If the returned value is @c false,
3682	the <link to="#accessError"/> property may be used to get the
3683	detailed error information describing the reason of
3684	inaccessibility, including XML error messages.
3685
3686	When the machine is inaccessible, only the following properties
3687	can be used on it:
3688	<ul>
3689	<li><link to="#parent"/></li>
3690	<li><link to="#id"/></li>
3691	<li><link to="#settingsFilePath"/></li>
3692	<li><link to="#accessible"/></li>
3693	<li><link to="#accessError"/></li>
3694	</ul>
3695
3696	An attempt to access any other property or method will return
3697	an error.
3698
3699	The only possible action you can perform on an inaccessible
3700	machine is to unregister it using the
3701	<link to="IMachine::unregister"/> call (or, to check
3702	for the accessibility state once more by querying this
3703	property).
3704
3705	<note>
3706	In the current implementation, once this property returns
3707	@c true, the machine will never become inaccessible
3708	later, even if its settings file cannot be successfully
3709	read/written any more (at least, until the VirtualBox
3710	server is restarted). This limitation may be removed in
3711	future releases.
3712	</note>
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3717	<desc>
3718	Error information describing the reason of machine
3719	inaccessibility.
3720
3721	Reading this property is only valid after the last call to
3722	<link to="#accessible"/> returned @c false (i.e. the
3723	machine is currently inaccessible). Otherwise, a @c null
3724	IVirtualBoxErrorInfo object will be returned.
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="name" type="wstring">
3729	<desc>
3730	Name of the virtual machine.
3731
3732	Besides being used for human-readable identification purposes
3733	everywhere in VirtualBox, the virtual machine name is also used
3734	as a name of the machine's settings file and as a name of the
3735	subdirectory this settings file resides in. Thus, every time you
3736	change the value of this property, the settings file will be
3737	renamed once you call <link to="#saveSettings"/> to confirm the
3738	change. The containing subdirectory will be also renamed, but
3739	only if it has exactly the same name as the settings file
3740	itself prior to changing this property (for backward compatibility
3741	with previous API releases). The above implies the following
3742	limitations:
3743	<ul>
3744	<li>The machine name cannot be empty.</li>
3745	<li>The machine name can contain only characters that are valid
3746	file name characters according to the rules of the file
3747	system used to store VirtualBox configuration.</li>
3748	<li>You cannot have two or more machines with the same name
3749	if they use the same subdirectory for storing the machine
3750	settings files.</li>
3751	<li>You cannot change the name of the machine if it is running,
3752	or if any file in the directory containing the settings file
3753	is being used by another running machine or by any other
3754	process in the host operating system at a time when
3755	<link to="#saveSettings"/> is called.
3756	</li>
3757	</ul>
3758	If any of the above limitations are hit, <link to="#saveSettings"/>
3759	will return an appropriate error message explaining the exact
3760	reason and the changes you made to this machine will not be saved.
3761
3762	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3763	file is recommended, but not enforced. (Previous versions always
3764	used a generic ".xml" extension.)
3765	</desc>
3766	</attribute>
3767
3768	<attribute name="description" type="wstring">
3769	<desc>
3770	Description of the virtual machine.
3771
3772	The description attribute can contain any text and is
3773	typically used to describe the hardware and software
3774	configuration of the virtual machine in detail (i.e. network
3775	settings, versions of the installed software and so on).
3776	</desc>
3777	</attribute>
3778
3779	<attribute name="id" type="uuid" mod="string" readonly="yes">
3780	<desc>UUID of the virtual machine.</desc>
3781	</attribute>
3782
3783	<attribute name="OSTypeId" type="wstring">
3784	<desc>
3785	User-defined identifier of the Guest OS type.
3786	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3787	an IGuestOSType object representing details about the given
3788	Guest OS type.
3789	<note>
3790	This value may differ from the value returned by
3791	<link to="IGuest::OSTypeId"/> if Guest Additions are
3792	installed to the guest OS.
3793	</note>
3794	</desc>
3795	</attribute>
3796
3797	<attribute name="hardwareVersion" type="wstring">
3798	<desc>Hardware version identifier. Internal use only for now.</desc>
3799	</attribute>
3800
3801	<attribute name="hardwareUUID" type="uuid" mod="string">
3802	<desc>
3803	The UUID presented to the guest via memory tables, hardware and guest
3804	properties. For most VMs this is the same as the @a id, but for VMs
3805	which have been cloned or teleported it may be the same as the source
3806	VM. This latter is because the guest shouldn't notice that it was
3807	cloned or teleported.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="CPUCount" type="unsigned long">
3812	<desc>Number of virtual CPUs in the VM.</desc>
3813	</attribute>
3814
3815	<attribute name="CPUHotPlugEnabled" type="boolean">
3816	<desc>
3817	This setting determines whether VirtualBox allows CPU
3818	hotplugging for this machine.</desc>
3819	</attribute>
3820
3821	<attribute name="CPUExecutionCap" type="unsigned long">
3822	<desc>
3823	Means to limit the number of CPU cycles a guest can use. The unit
3824	is percentage of host CPU cycles per second. The valid range
3825	is 1 - 100. 100 (the default) implies no limit.
3826	</desc>
3827	</attribute>
3828
3829	<attribute name="memorySize" type="unsigned long">
3830	<desc>System memory size in megabytes.</desc>
3831	</attribute>
3832
3833	<attribute name="memoryBalloonSize" type="unsigned long">
3834	<desc>Memory balloon size in megabytes.</desc>
3835	</attribute>
3836
3837	<attribute name="pageFusionEnabled" type="boolean">
3838	<desc>
3839	This setting determines whether VirtualBox allows page
3840	fusion for this machine (64 bits host only).
3841	</desc>
3842	</attribute>
3843
3844	<attribute name="VRAMSize" type="unsigned long">
3845	<desc>Video memory size in megabytes.</desc>
3846	</attribute>
3847
3848	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3849	<desc>
3850	This setting determines whether VirtualBox allows this machine to make
3851	use of the 3D graphics support available on the host.</desc>
3852	</attribute>
3853
3854	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3855	<desc>
3856	This setting determines whether VirtualBox allows this machine to make
3857	use of the 2D video acceleration support available on the host.</desc>
3858	</attribute>
3859
3860	<attribute name="monitorCount" type="unsigned long">
3861	<desc>
3862	Number of virtual monitors.
3863	<note>
3864	Only effective on Windows XP and later guests with
3865	Guest Additions installed.
3866	</note>
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3871	<desc>Object containing all BIOS settings.</desc>
3872	</attribute>
3873
3874	<attribute name="firmwareType" type="FirmwareType">
3875	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3876	bootstrap in this VM.</desc>
3877	</attribute>
3878
3879	<attribute name="pointingHidType" type="PointingHidType">
3880	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3881	The default is typically "PS2Mouse" but can vary depending on the
3882	requirements of the guest operating system.</desc>
3883	</attribute>
3884
3885	<attribute name="keyboardHidType" type="KeyboardHidType">
3886	<desc>Type of keyboard HID used in this VM.
3887	The default is typically "PS2Keyboard" but can vary depending on the
3888	requirements of the guest operating system.</desc>
3889	</attribute>
3890
3891	<attribute name="hpetEnabled" type="boolean">
3892	<desc>This attribute controls if High Precision Event Timer (HPET) is
3893	enabled in this VM. Use this property if you want to provide guests
3894	with additional time source, or if guest requires HPET to function correctly.
3895	Default is false.</desc>
3896	</attribute>
3897
3898	<attribute name="chipsetType" type="ChipsetType">
3899	<desc>Chipset type used in this VM.</desc>
3900	</attribute>
3901
3902	<attribute name="snapshotFolder" type="wstring">
3903	<desc>
3904	Full path to the directory used to store snapshot data
3905	(differencing media and saved state files) of this machine.
3906
3907	The initial value of this property is
3908	<tt><</tt><link to="#settingsFilePath">
3909	path_to_settings_file</link><tt>>/<</tt>
3910	<link to="#id">machine_uuid</link>
3911	<tt>></tt>.
3912
3913	Currently, it is an error to try to change this property on
3914	a machine that has snapshots (because this would require to
3915	move possibly large files to a different location).
3916	A separate method will be available for this purpose later.
3917
3918	<note>
3919	Setting this property to @c null or to an empty string will restore
3920	the initial value.
3921	</note>
3922	<note>
3923	When setting this property, the specified path can be
3924	absolute (full path) or relative to the directory where the
3925	<link to="#settingsFilePath">machine settings file</link>
3926	is located. When reading this property, a full path is
3927	always returned.
3928	</note>
3929	<note>
3930	The specified path may not exist, it will be created
3931	when necessary.
3932	</note>
3933	</desc>
3934	</attribute>
3935
3936	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3937	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3938	</attribute>
3939
3940	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
3941	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
3942
3943	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3944	<desc>Array of media attached to this machine.</desc>
3945	</attribute>
3946
3947	<attribute name="USBController" type="IUSBController" readonly="yes">
3948	<desc>
3949	Associated USB controller object.
3950
3951	<note>
3952	If USB functionality is not available in the given edition of
3953	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3954	</note>
3955	</desc>
3956	</attribute>
3957
3958	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3959	<desc>Associated audio adapter, always present.</desc>
3960	</attribute>
3961
3962	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3963	<desc>Array of storage controllers attached to this machine.</desc>
3964	</attribute>
3965
3966	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3967	<desc>
3968	Full name of the file containing machine settings data.
3969	</desc>
3970	</attribute>
3971
3972	<attribute name="settingsModified" type="boolean" readonly="yes">
3973	<desc>
3974	Whether the settings of this machine have been modified
3975	(but neither yet saved nor discarded).
3976	<note>
3977	Reading this property is only valid on instances returned
3978	by <link to="ISession::machine"/> and on new machines
3979	created by <link to="IVirtualBox::createMachine"/> or opened
3980	by <link to="IVirtualBox::openMachine"/> but not
3981	yet registered, or on unregistered machines after calling
3982	<link to="IMachine::unregister"/>. For all other
3983	cases, the settings can never be modified.
3984	</note>
3985	<note>
3986	For newly created unregistered machines, the value of this
3987	property is always @c true until <link to="#saveSettings"/>
3988	is called (no matter if any machine settings have been
3989	changed after the creation or not). For opened machines
3990	the value is set to @c false (and then follows to normal rules).
3991	</note>
3992	</desc>
3993	</attribute>
3994
3995	<attribute name="sessionState" type="SessionState" readonly="yes">
3996	<desc>Current session state for this machine.</desc>
3997	</attribute>
3998
3999	<attribute name="sessionType" type="wstring" readonly="yes">
4000	<desc>
4001	Type of the session. If <link to="#sessionState"/> is
4002	Spawning or Locked, this attribute contains the
4003	same value as passed to the
4004	<link to="IMachine::launchVMProcess"/> method in the
4005	@a type parameter. If the session was used with
4006	<link to="IMachine::lockMachine" />, or if
4007	<link to="#sessionState"/> is SessionClosed, the value of this
4008	attribute is an empty string.
4009	</desc>
4010	</attribute>
4011
4012	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4013	<desc>
4014	Identifier of the session process. This attribute contains the
4015	platform-dependent identifier of the process whose session was
4016	used with <link to="IMachine::lockMachine" /> call. The returned
4017	value is only valid if <link to="#sessionState"/> is Locked or
4018	Unlocking by the time this property is read.
4019	</desc>
4020	</attribute>
4021
4022	<attribute name="state" type="MachineState" readonly="yes">
4023	<desc>Current execution state of this machine.</desc>
4024	</attribute>
4025
4026	<attribute name="lastStateChange" type="long long" readonly="yes">
4027	<desc>
4028	Time stamp of the last execution state change,
4029	in milliseconds since 1970-01-01 UTC.
4030	</desc>
4031	</attribute>
4032
4033	<attribute name="stateFilePath" type="wstring" readonly="yes">
4034	<desc>
4035	Full path to the file that stores the execution state of
4036	the machine when it is in the <link to="MachineState_Saved"/> state.
4037	<note>
4038	When the machine is not in the Saved state, this attribute is
4039	an empty string.
4040	</note>
4041	</desc>
4042	</attribute>
4043
4044	<attribute name="logFolder" type="wstring" readonly="yes">
4045	<desc>
4046	Full path to the folder that stores a set of rotated log files
4047	recorded during machine execution. The most recent log file is
4048	named <tt>VBox.log</tt>, the previous log file is
4049	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4050	in the current version).
4051	</desc>
4052	</attribute>
4053
4054	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4055	<desc>
4056	Current snapshot of this machine. This is @c null if the machine
4057	currently has no snapshots. If it is not @c null, then it was
4058	set by one of <link to="IConsole::takeSnapshot" />,
4059	<link to="IConsole::deleteSnapshot" />
4060	or <link to="IConsole::restoreSnapshot" />, depending on which
4061	was called last. See <link to="ISnapshot"/> for details.
4062	</desc>
4063	</attribute>
4064
4065	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4066	<desc>
4067	Number of snapshots taken on this machine. Zero means the
4068	machine doesn't have any snapshots.
4069	</desc>
4070	</attribute>
4071
4072	<attribute name="currentStateModified" type="boolean" readonly="yes">
4073	<desc>
4074	Returns @c true if the current state of the machine is not
4075	identical to the state stored in the current snapshot.
4076
4077	The current state is identical to the current snapshot only
4078	directly after one of the following calls are made:
4079
4080	<ul>
4081	<li><link to="IConsole::restoreSnapshot"/>
4082	</li>
4083	<li><link to="IConsole::takeSnapshot"/> (issued on a
4084	"powered off" or "saved" machine, for which
4085	<link to="#settingsModified"/> returns @c false)
4086	</li>
4087	</ul>
4088
4089	The current state remains identical until one of the following
4090	happens:
4091	<ul>
4092	<li>settings of the machine are changed</li>
4093	<li>the saved state is deleted</li>
4094	<li>the current snapshot is deleted</li>
4095	<li>an attempt to execute the machine is made</li>
4096	</ul>
4097
4098	<note>
4099	For machines that don't have snapshots, this property is
4100	always @c false.
4101	</note>
4102	</desc>
4103	</attribute>
4104
4105	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4106	<desc>
4107	Collection of shared folders for this machine (permanent shared
4108	folders). These folders are shared automatically at machine startup
4109	and available only to the guest OS installed within this machine.
4110
4111	New shared folders are added to the collection using
4112	<link to="#createSharedFolder"/>. Existing shared folders can be
4113	removed using <link to="#removeSharedFolder"/>.
4114	</desc>
4115	</attribute>
4116
4117	<attribute name="clipboardMode" type="ClipboardMode">
4118	<desc>
4119	Synchronization mode between the host OS clipboard
4120	and the guest OS clipboard.
4121	</desc>
4122	</attribute>
4123
4124	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4125	<desc>
4126	A comma-separated list of simple glob patterns. Changes to guest
4127	properties whose name matches one of the patterns will generate an
4128	<link to="IGuestPropertyChangedEvent"/> signal.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="teleporterEnabled" type="boolean">
4133	<desc>
4134	When set to @a true, the virtual machine becomes a target teleporter
4135	the next time it is powered on. This can only set to @a true when the
4136	VM is in the @a PoweredOff or @a Aborted state.
4137
4138	<!-- This property is automatically set to @a false when the VM is powered
4139	on. (bird: This doesn't work yet ) -->
4140	</desc>
4141	</attribute>
4142
4143	<attribute name="teleporterPort" type="unsigned long">
4144	<desc>
4145	The TCP port the target teleporter will listen for incoming
4146	teleportations on.
4147
4148	0 means the port is automatically selected upon power on. The actual
4149	value can be read from this property while the machine is waiting for
4150	incoming teleportations.
4151	</desc>
4152	</attribute>
4153
4154	<attribute name="teleporterAddress" type="wstring">
4155	<desc>
4156	The address the target teleporter will listen on. If set to an empty
4157	string, it will listen on all addresses.
4158	</desc>
4159	</attribute>
4160
4161	<attribute name="teleporterPassword" type="wstring">
4162	<desc>
4163	The password to check for on the target teleporter. This is just a
4164	very basic measure to prevent simple hacks and operators accidentally
4165	beaming a virtual machine to the wrong place.
4166	</desc>
4167	</attribute>
4168
4169	<attribute name="faultToleranceState" type="FaultToleranceState">
4170	<desc>
4171	Fault tolerance state; disabled, source or target.
4172	This property can be changed at any time. If you change it for a running
4173	VM, then the fault tolerance address and port must be set beforehand.
4174	</desc>
4175	</attribute>
4176
4177	<attribute name="faultTolerancePort" type="unsigned long">
4178	<desc>
4179	The TCP port the fault tolerance source or target will use for
4180	communication.
4181	</desc>
4182	</attribute>
4183
4184	<attribute name="faultToleranceAddress" type="wstring">
4185	<desc>
4186	The address the fault tolerance source or target.
4187	</desc>
4188	</attribute>
4189
4190	<attribute name="faultTolerancePassword" type="wstring">
4191	<desc>
4192	The password to check for on the standby VM. This is just a
4193	very basic measure to prevent simple hacks and operators accidentally
4194	choosing the wrong standby VM.
4195	</desc>
4196	</attribute>
4197
4198	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4199	<desc>
4200	The interval in ms used for syncing the state between source and target.
4201	</desc>
4202	</attribute>
4203
4204	<attribute name="RTCUseUTC" type="boolean">
4205	<desc>
4206	When set to @a true, the RTC device of the virtual machine will run
4207	in UTC time, otherwise in local time. Especially Unix guests prefer
4208	the time in UTC.
4209	</desc>
4210	</attribute>
4211
4212	<attribute name="ioCacheEnabled" type="boolean">
4213	<desc>
4214	When set to @a true, the builtin I/O cache of the virtual machine
4215	will be enabled.
4216	</desc>
4217	</attribute>
4218
4219	<attribute name="ioCacheSize" type="unsigned long">
4220	<desc>
4221	Maximum size of the I/O cache in MB.
4222	</desc>
4223	</attribute>
4224
4225	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4226	<desc>
4227	Bandwidth control manager.
4228	</desc>
4229	</attribute>
4230
4231	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4232	<desc>Array of PCI devices assigned to this machine, to get list of all
4233	PCI devices attached to the machine use
4234	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4235	is intended to list only devices additional to what described in
4236	virtual hardware config. Usually, this list keeps host's physical
4237	devices assigned to the particular machine.
4238	</desc>
4239	</attribute>
4240
4241	<method name="lockMachine">
4242	<desc>
4243	Locks the machine for the given session to enable the caller
4244	to make changes to the machine or start the VM or control
4245	VM execution.
4246
4247	There are two ways to lock a machine for such uses:
4248
4249	<ul>
4250	<li>If you want to make changes to the machine settings,
4251	you must obtain an exclusive write lock on the machine
4252	by setting @a lockType to @c Write.
4253
4254	This will only succeed if no other process has locked
4255	the machine to prevent conflicting changes. Only after
4256	an exclusive write lock has been obtained using this method, one
4257	can change all VM settings or execute the VM in the process
4258	space of the session object. (Note that the latter is only of
4259	interest if you actually want to write a new front-end for
4260	virtual machines; but this API gets called internally by
4261	the existing front-ends such as VBoxHeadless and the VirtualBox
4262	GUI to acquire a write lock on the machine that they are running.)
4263
4264	On success, write-locking the machine for a session creates
4265	a second copy of the IMachine object. It is this second object
4266	upon which changes can be made; in VirtualBox terminology, the
4267	second copy is "mutable". It is only this second, mutable machine
4268	object upon which you can call methods that change the
4269	machine state. After having called this method, you can
4270	obtain this second, mutable machine object using the
4271	<link to="ISession::machine" /> attribute.
4272	</li>
4273	<li>If you only want to check the machine state or control
4274	machine execution without actually changing machine
4275	settings (e.g. to get access to VM statistics or take
4276	a snapshot or save the machine state), then set the
4277	@a lockType argument to @c Shared.
4278
4279	If no other session has obtained a lock, you will obtain an
4280	exclusive write lock as described above. However, if another
4281	session has already obtained such a lock, then a link to that
4282	existing session will be established which allows you
4283	to control that existing session.
4284
4285	To find out which type of lock was obtained, you can
4286	inspect <link to="ISession::type" />, which will have been
4287	set to either @c WriteLock or @c Shared.
4288	</li>
4289	</ul>
4290
4291	In either case, you can get access to the <link to="IConsole" />
4292	object which controls VM execution.
4293
4294	Also in all of the above cases, one must always call
4295	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4296	the machine's state will eventually be set to "Aborted".
4297
4298	To change settings on a machine, the following sequence is typically
4299	performed:
4300
4301	<ol>
4302	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4303
4304	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4305
4306	<li>Change the settings of the machine by invoking IMachine methods.</li>
4307
4308	<li>Call <link to="IMachine::saveSettings" />.</li>
4309
4310	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4311	</ol>
4312
4313	<result name="E_UNEXPECTED">
4314	Virtual machine not registered.
4315	</result>
4316	<result name="E_ACCESSDENIED">
4317	Process not started by OpenRemoteSession.
4318	</result>
4319	<result name="VBOX_E_INVALID_OBJECT_STATE">
4320	Session already open or being opened.
4321	</result>
4322	<result name="VBOX_E_VM_ERROR">
4323	Failed to assign machine to session.
4324	</result>
4325	</desc>
4326	<param name="session" type="ISession" dir="in">
4327	<desc>
4328	Session object for which the machine will be locked.
4329	</desc>
4330	</param>
4331	<param name="lockType" type="LockType" dir="in">
4332	<desc>
4333	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4334	If set to @c Shared, then either acquire an exclusive write lock or establish
4335	a link to an existing session.
4336	</desc>
4337	</param>
4338	</method>
4339
4340	<method name="launchVMProcess">
4341	<desc>
4342	Spawns a new process that will execute the virtual machine and obtains a shared
4343	lock on the machine for the calling session.
4344
4345	If launching the VM succeeds, the new VM process will create its own session
4346	and write-lock the machine for it, preventing conflicting changes from other
4347	processes. If the machine is already locked (because it is already running or
4348	because another session has a write lock), launching the VM process will therefore
4349	fail. Reversely, future attempts to obtain a write lock will also fail while the
4350	machine is running.
4351
4352	The caller's session object remains separate from the session opened by the new
4353	VM process. It receives its own <link to="IConsole" /> object which can be used
4354	to control machine execution, but it cannot be used to change all VM settings
4355	which would be available after a <link to="#lockMachine" /> call.
4356
4357	The caller must eventually release the session's shared lock by calling
4358	<link to="ISession::unlockMachine" /> on the local session object once this call
4359	has returned. However, the session's state (see <link to="ISession::state" />)
4360	will not return to "Unlocked" until the remote session has also unlocked
4361	the machine (i.e. the machine has stopped running).
4362
4363	Launching a VM process can take some time (a new VM is started in a new process,
4364	for which memory and other resources need to be set up). Because of this,
4365	an <link to="IProgress" /> object is returned to allow the caller to wait
4366	for this asynchronous operation to be completed. Until then, the caller's
4367	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4368	and <link to="ISession::console" /> attributes cannot be accessed.
4369	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4370	similar calls to wait for completion. Completion is signalled when the VM
4371	is powered on. If launching the VM fails, error messages can be queried
4372	via the progress object, if available.
4373
4374	The progress object will have at least 2 sub-operations. The first
4375	operation covers the period up to the new VM process calls powerUp.
4376	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4377	progress object. Because <link to="IConsole::powerUp"/> may require
4378	some extra sub-operations, the <link to="IProgress::operationCount"/>
4379	may change at the completion of operation.
4380
4381	For details on the teleportation progress operation, see
4382	<link to="IConsole::powerUp"/>.
4383
4384	The @a environment argument is a string containing definitions of
4385	environment variables in the following format:
4386	<pre>
4387	NAME[=VALUE]\n
4388	NAME[=VALUE]\n
4389	...
4390	</pre>
4391	where <tt>\\n</tt> is the new line character. These environment
4392	variables will be appended to the environment of the VirtualBox server
4393	process. If an environment variable exists both in the server process
4394	and in this list, the value from this list takes precedence over the
4395	server's variable. If the value of the environment variable is
4396	omitted, this variable will be removed from the resulting environment.
4397	If the environment string is @c null or empty, the server environment
4398	is inherited by the started process as is.
4399
4400	<result name="E_UNEXPECTED">
4401	Virtual machine not registered.
4402	</result>
4403	<result name="E_INVALIDARG">
4404	Invalid session type @a type.
4405	</result>
4406	<result name="VBOX_E_OBJECT_NOT_FOUND">
4407	No machine matching @a machineId found.
4408	</result>
4409	<result name="VBOX_E_INVALID_OBJECT_STATE">
4410	Session already open or being opened.
4411	</result>
4412	<result name="VBOX_E_IPRT_ERROR">
4413	Launching process for machine failed.
4414	</result>
4415	<result name="VBOX_E_VM_ERROR">
4416	Failed to assign machine to session.
4417	</result>
4418	</desc>
4419	<param name="session" type="ISession" dir="in">
4420	<desc>
4421	Client session object to which the VM process will be connected (this
4422	must be in "Unlocked" state).
4423	</desc>
4424	</param>
4425	<param name="type" type="wstring" dir="in">
4426	<desc>
4427	Front-end to use for the new VM process. The following are currently supported:
4428	<ul>
4429	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4430	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4431	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4432	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4433	the currently running VM or session owner. In this case the
4434	@a session parameter may be @c NULL (if it is non-null it isn't
4435	used in any way), and the @a progress return value will be always
4436	NULL. The operation completes immediately.</li>
4437	</ul>
4438	</desc>
4439	</param>
4440	<param name="environment" type="wstring" dir="in">
4441	<desc>
4442	Environment to pass to the VM process.
4443	</desc>
4444	</param>
4445	<param name="progress" type="IProgress" dir="return">
4446	<desc>Progress object to track the operation completion.</desc>
4447	</param>
4448	</method>
4449
4450	<method name="setBootOrder">
4451	<desc>
4452	Puts the given device to the specified position in
4453	the boot order.
4454
4455	To indicate that no device is associated with the given position,
4456	<link to="DeviceType_Null"/> should be used.
4457
4458	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4459
4460	<result name="E_INVALIDARG">
4461	Boot @a position out of range.
4462	</result>
4463	<result name="E_NOTIMPL">
4464	Booting from USB @a device currently not supported.
4465	</result>
4466
4467	</desc>
4468	<param name="position" type="unsigned long" dir="in">
4469	<desc>
4470	Position in the boot order (@c 1 to the total number of
4471	devices the machine can boot from, as returned by
4472	<link to="ISystemProperties::maxBootPosition"/>).
4473	</desc>
4474	</param>
4475	<param name="device" type="DeviceType" dir="in">
4476	<desc>
4477	The type of the device used to boot at the given position.
4478	</desc>
4479	</param>
4480	</method>
4481
4482	<method name="getBootOrder" const="yes">
4483	<desc>
4484	Returns the device type that occupies the specified
4485	position in the boot order.
4486
4487	@todo [remove?]
4488	If the machine can have more than one device of the returned type
4489	(such as hard disks), then a separate method should be used to
4490	retrieve the individual device that occupies the given position.
4491
4492	If here are no devices at the given position, then
4493	<link to="DeviceType_Null"/> is returned.
4494
4495	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4496
4497	<result name="E_INVALIDARG">
4498	Boot @a position out of range.
4499	</result>
4500
4501	</desc>
4502	<param name="position" type="unsigned long" dir="in">
4503	<desc>
4504	Position in the boot order (@c 1 to the total number of
4505	devices the machine can boot from, as returned by
4506	<link to="ISystemProperties::maxBootPosition"/>).
4507	</desc>
4508	</param>
4509	<param name="device" type="DeviceType" dir="return">
4510	<desc>
4511	Device at the given position.
4512	</desc>
4513	</param>
4514	</method>
4515
4516	<method name="attachDevice">
4517	<desc>
4518	Attaches a device and optionally mounts a medium to the given storage
4519	controller (<link to="IStorageController" />, identified by @a name),
4520	at the indicated port and device.
4521
4522	This method is intended for managing storage devices in general while a
4523	machine is powered off. It can be used to attach and detach fixed
4524	and removable media. The following kind of media can be attached
4525	to a machine:
4526
4527	<ul>
4528	<li>For fixed and removable media, you can pass in a medium that was
4529	previously opened using <link to="IVirtualBox::openMedium" />.
4530	</li>
4531
4532	<li>Only for storage devices supporting removable media (such as
4533	DVDs and floppies), you can also specify a null pointer to
4534	indicate an empty drive or one of the medium objects listed
4535	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4536	arrays to indicate a host drive.
4537	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4538	to change the media while the machine is running.
4539	</li>
4540	</ul>
4541
4542	In a VM's default configuration of virtual machines, the secondary
4543	master of the IDE controller is used for a CD/DVD drive.
4544
4545	After calling this returns successfully, a new instance of
4546	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4547	attachments (see <link to="IMachine::mediumAttachments"/>).
4548
4549	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4550	information about attaching media.
4551
4552	The specified device slot must not have a device attached to it,
4553	or this method will fail.
4554
4555	<note>
4556	You cannot attach a device to a newly created machine until
4557	this machine's settings are saved to disk using
4558	<link to="#saveSettings"/>.
4559	</note>
4560	<note>
4561	If the medium is being attached indirectly, a new differencing medium
4562	will implicitly be created for it and attached instead. If the
4563	changes made to the machine settings (including this indirect
4564	attachment) are later cancelled using <link to="#discardSettings"/>,
4565	this implicitly created differencing medium will implicitly
4566	be deleted.
4567	</note>
4568
4569	<result name="E_INVALIDARG">
4570	SATA device, SATA port, IDE port or IDE slot out of range, or
4571	file or UUID not found.
4572	</result>
4573	<result name="VBOX_E_INVALID_OBJECT_STATE">
4574	Machine must be registered before media can be attached.
4575	</result>
4576	<result name="VBOX_E_INVALID_VM_STATE">
4577	Invalid machine state.
4578	</result>
4579	<result name="VBOX_E_OBJECT_IN_USE">
4580	A medium is already attached to this or another virtual machine.
4581	</result>
4582
4583	</desc>
4584	<param name="name" type="wstring" dir="in">
4585	<desc>Name of the storage controller to attach the device to.</desc>
4586	</param>
4587	<param name="controllerPort" type="long" dir="in">
4588	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4589	the primary controller and 1 specifies the secondary controller.
4590	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4591	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4592	</param>
4593	<param name="device" type="long" dir="in">
4594	<desc>Device slot in the given port to attach the device to. This is only
4595	relevant for IDE controllers, for which 0 specifies the master device and
4596	1 specifies the slave device. For all other controller types, this must
4597	be 0.</desc>
4598	</param>
4599	<param name="type" type="DeviceType" dir="in">
4600	<desc>Device type of the attached device. For media opened by
4601	<link to="IVirtualBox::openMedium" />, this must match the device type
4602	specified there.</desc>
4603	</param>
4604	<param name="medium" type="IMedium" dir="in">
4605	<desc>Medium to mount or NULL for an empty drive.</desc>
4606	</param>
4607	</method>
4608
4609	<method name="detachDevice">
4610	<desc>
4611	Detaches the device attached to a device slot of the specified bus.
4612
4613	Detaching the device from the virtual machine is deferred. This means
4614	that the medium remains associated with the machine when this method
4615	returns and gets actually de-associated only after a successful
4616	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4617	for more detailed information about attaching media.
4618
4619	<note>
4620	You cannot detach a device from a running machine.
4621	</note>
4622	<note>
4623	Detaching differencing media implicitly created by <link
4624	to="#attachDevice"/> for the indirect attachment using this
4625	method will <b>not</b> implicitly delete them. The
4626	<link to="IMedium::deleteStorage"/> operation should be
4627	explicitly performed by the caller after the medium is successfully
4628	detached and the settings are saved with
4629	<link to="#saveSettings"/>, if it is the desired action.
4630	</note>
4631
4632	<result name="VBOX_E_INVALID_VM_STATE">
4633	Attempt to detach medium from a running virtual machine.
4634	</result>
4635	<result name="VBOX_E_OBJECT_NOT_FOUND">
4636	No medium attached to given slot/bus.
4637	</result>
4638	<result name="VBOX_E_NOT_SUPPORTED">
4639	Medium format does not support storage deletion.
4640	</result>
4641
4642	</desc>
4643	<param name="name" type="wstring" dir="in">
4644	<desc>Name of the storage controller to detach the medium from.</desc>
4645	</param>
4646	<param name="controllerPort" type="long" dir="in">
4647	<desc>Port number to detach the medium from.</desc>
4648	</param>
4649	<param name="device" type="long" dir="in">
4650	<desc>Device slot number to detach the medium from.</desc>
4651	</param>
4652	</method>
4653
4654	<method name="passthroughDevice">
4655	<desc>
4656	Sets the passthrough mode of an existing DVD device. Changing the
4657	setting while the VM is running is forbidden. The setting is only used
4658	if at VM start the device is configured as a host DVD drive, in all
4659	other cases it is ignored. The device must already exist; see
4660	<link to="IMachine::attachDevice"/> for how to attach a new device.
4661
4662	The @a controllerPort and @a device parameters specify the device slot and
4663	have have the same meaning as with <link to="IMachine::attachDevice" />.
4664
4665	<result name="E_INVALIDARG">
4666	SATA device, SATA port, IDE port or IDE slot out of range.
4667	</result>
4668	<result name="VBOX_E_INVALID_OBJECT_STATE">
4669	Attempt to modify an unregistered virtual machine.
4670	</result>
4671	<result name="VBOX_E_INVALID_VM_STATE">
4672	Invalid machine state.
4673	</result>
4674
4675	</desc>
4676	<param name="name" type="wstring" dir="in">
4677	<desc>Name of the storage controller.</desc>
4678	</param>
4679	<param name="controllerPort" type="long" dir="in">
4680	<desc>Storage controller port.</desc>
4681	</param>
4682	<param name="device" type="long" dir="in">
4683	<desc>Device slot in the given port.</desc>
4684	</param>
4685	<param name="passthrough" type="boolean" dir="in">
4686	<desc>New value for the passthrough setting.</desc>
4687	</param>
4688	</method>
4689
4690	<method name="temporaryEjectDevice">
4691	<desc>
4692	Sets the behavior for guest-triggered medium eject. In some situations
4693	it is desirable that such ejects update the VM configuration, and in
4694	others the eject should keep the VM configuration. The device must
4695	already exist; see <link to="IMachine::attachDevice"/> for how to
4696	attach a new device.
4697
4698	The @a controllerPort and @a device parameters specify the device slot and
4699	have have the same meaning as with <link to="IMachine::attachDevice" />.
4700
4701	<result name="E_INVALIDARG">
4702	SATA device, SATA port, IDE port or IDE slot out of range.
4703	</result>
4704	<result name="VBOX_E_INVALID_OBJECT_STATE">
4705	Attempt to modify an unregistered virtual machine.
4706	</result>
4707	<result name="VBOX_E_INVALID_VM_STATE">
4708	Invalid machine state.
4709	</result>
4710
4711	</desc>
4712	<param name="name" type="wstring" dir="in">
4713	<desc>Name of the storage controller.</desc>
4714	</param>
4715	<param name="controllerPort" type="long" dir="in">
4716	<desc>Storage controller port.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port.</desc>
4720	</param>
4721	<param name="temporaryEject" type="boolean" dir="in">
4722	<desc>New value for the eject behavior.</desc>
4723	</param>
4724	</method>
4725
4726	<method name="nonRotationalDevice">
4727	<desc>
4728	Sets a flag in the device information which indicates that the medium
4729	is not based on rotational technology, i.e. that the access times are
4730	more or less independent of the position on the medium. This may or may
4731	not be supported by a particular drive, and is silently ignored in the
4732	latter case. At the moment only hard disks (which is a misnomer in this
4733	context) accept this setting. Changing the setting while the VM is
4734	running is forbidden. The device must already exist; see
4735	<link to="IMachine::attachDevice"/> for how to attach a new device.
4736
4737	The @a controllerPort and @a device parameters specify the device slot and
4738	have have the same meaning as with <link to="IMachine::attachDevice" />.
4739
4740	<result name="E_INVALIDARG">
4741	SATA device, SATA port, IDE port or IDE slot out of range.
4742	</result>
4743	<result name="VBOX_E_INVALID_OBJECT_STATE">
4744	Attempt to modify an unregistered virtual machine.
4745	</result>
4746	<result name="VBOX_E_INVALID_VM_STATE">
4747	Invalid machine state.
4748	</result>
4749
4750	</desc>
4751	<param name="name" type="wstring" dir="in">
4752	<desc>Name of the storage controller.</desc>
4753	</param>
4754	<param name="controllerPort" type="long" dir="in">
4755	<desc>Storage controller port.</desc>
4756	</param>
4757	<param name="device" type="long" dir="in">
4758	<desc>Device slot in the given port.</desc>
4759	</param>
4760	<param name="nonRotational" type="boolean" dir="in">
4761	<desc>New value for the non-rotational device flag.</desc>
4762	</param>
4763	</method>
4764
4765	<method name="setAutoDiscardForDevice">
4766	<desc>
4767	Sets a flag in the device information which indicates that the medium
4768	supports discarding unsused blocks (called trimming for SATA or unmap
4769	for SCSI devices) .This may or may not be supported by a particular drive,
4770	and is silently ignored in the latter case. At the moment only hard disks
4771	(which is a misnomer in this context) accept this setting. Changing the
4772	setting while the VM is running is forbidden. The device must already
4773	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4774	device.
4775
4776	The @a controllerPort and @a device parameters specify the device slot and
4777	have have the same meaning as with <link to="IMachine::attachDevice" />.
4778
4779	<result name="E_INVALIDARG">
4780	SATA device, SATA port, SCSI port out of range.
4781	</result>
4782	<result name="VBOX_E_INVALID_OBJECT_STATE">
4783	Attempt to modify an unregistered virtual machine.
4784	</result>
4785	<result name="VBOX_E_INVALID_VM_STATE">
4786	Invalid machine state.
4787	</result>
4788
4789	</desc>
4790	<param name="name" type="wstring" dir="in">
4791	<desc>Name of the storage controller.</desc>
4792	</param>
4793	<param name="controllerPort" type="long" dir="in">
4794	<desc>Storage controller port.</desc>
4795	</param>
4796	<param name="device" type="long" dir="in">
4797	<desc>Device slot in the given port.</desc>
4798	</param>
4799	<param name="discard" type="boolean" dir="in">
4800	<desc>New value for the discard device flag.</desc>
4801	</param>
4802	</method>
4803
4804	<method name="setBandwidthGroupForDevice">
4805	<desc>
4806	Sets the bandwidth group of an existing storage device.
4807	The device must already exist; see <link to="IMachine::attachDevice"/>
4808	for how to attach a new device.
4809
4810	The @a controllerPort and @a device parameters specify the device slot and
4811	have have the same meaning as with <link to="IMachine::attachDevice" />.
4812
4813	<result name="E_INVALIDARG">
4814	SATA device, SATA port, IDE port or IDE slot out of range.
4815	</result>
4816	<result name="VBOX_E_INVALID_OBJECT_STATE">
4817	Attempt to modify an unregistered virtual machine.
4818	</result>
4819	<result name="VBOX_E_INVALID_VM_STATE">
4820	Invalid machine state.
4821	</result>
4822
4823	</desc>
4824	<param name="name" type="wstring" dir="in">
4825	<desc>Name of the storage controller.</desc>
4826	</param>
4827	<param name="controllerPort" type="long" dir="in">
4828	<desc>Storage controller port.</desc>
4829	</param>
4830	<param name="device" type="long" dir="in">
4831	<desc>Device slot in the given port.</desc>
4832	</param>
4833	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4834	<desc>New value for the bandwidth group or NULL for no group.</desc>
4835	</param>
4836	</method>
4837
4838	<method name="mountMedium">
4839	<desc>
4840	Mounts a medium (<link to="IMedium" />, identified
4841	by the given UUID @a id) to the given storage controller
4842	(<link to="IStorageController" />, identified by @a name),
4843	at the indicated port and device. The device must already exist;
4844	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4845
4846	This method is intended only for managing removable media, where the
4847	device is fixed but media is changeable at runtime (such as DVDs
4848	and floppies). It cannot be used for fixed media such as hard disks.
4849
4850	The @a controllerPort and @a device parameters specify the device slot and
4851	have have the same meaning as with <link to="IMachine::attachDevice" />.
4852
4853	The specified device slot can have a medium mounted, which will be
4854	unmounted first. Specifying a zero UUID (or an empty string) for
4855	@a medium does just an unmount.
4856
4857	See <link to="IMedium"/> for more detailed information about
4858	attaching media.
4859
4860	<result name="E_INVALIDARG">
4861	SATA device, SATA port, IDE port or IDE slot out of range.
4862	</result>
4863	<result name="VBOX_E_INVALID_OBJECT_STATE">
4864	Attempt to attach medium to an unregistered virtual machine.
4865	</result>
4866	<result name="VBOX_E_INVALID_VM_STATE">
4867	Invalid machine state.
4868	</result>
4869	<result name="VBOX_E_OBJECT_IN_USE">
4870	Medium already attached to this or another virtual machine.
4871	</result>
4872
4873	</desc>
4874	<param name="name" type="wstring" dir="in">
4875	<desc>Name of the storage controller to attach the medium to.</desc>
4876	</param>
4877	<param name="controllerPort" type="long" dir="in">
4878	<desc>Port to attach the medium to.</desc>
4879	</param>
4880	<param name="device" type="long" dir="in">
4881	<desc>Device slot in the given port to attach the medium to.</desc>
4882	</param>
4883	<param name="medium" type="IMedium" dir="in">
4884	<desc>Medium to mount or NULL for an empty drive.</desc>
4885	</param>
4886	<param name="force" type="boolean" dir="in">
4887	<desc>Allows to force unmount/mount of a medium which is locked by
4888	the device slot in the given port to attach the medium to.</desc>
4889	</param>
4890	</method>
4891
4892	<method name="getMedium" const="yes">
4893	<desc>
4894	Returns the virtual medium attached to a device slot of the specified
4895	bus.
4896
4897	Note that if the medium was indirectly attached by
4898	<link to="#mountMedium"/> to the given device slot then this
4899	method will return not the same object as passed to the
4900	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4901	more detailed information about mounting a medium.
4902
4903	<result name="VBOX_E_OBJECT_NOT_FOUND">
4904	No medium attached to given slot/bus.
4905	</result>
4906
4907	</desc>
4908	<param name="name" type="wstring" dir="in">
4909	<desc>Name of the storage controller the medium is attached to.</desc>
4910	</param>
4911	<param name="controllerPort" type="long" dir="in">
4912	<desc>Port to query.</desc>
4913	</param>
4914	<param name="device" type="long" dir="in">
4915	<desc>Device slot in the given port to query.</desc>
4916	</param>
4917	<param name="medium" type="IMedium" dir="return">
4918	<desc>Attached medium object.</desc>
4919	</param>
4920	</method>
4921
4922	<method name="getMediumAttachmentsOfController" const="yes">
4923	<desc>
4924	Returns an array of medium attachments which are attached to the
4925	the controller with the given name.
4926
4927	<result name="VBOX_E_OBJECT_NOT_FOUND">
4928	A storage controller with given name doesn't exist.
4929	</result>
4930	</desc>
4931	<param name="name" type="wstring" dir="in"/>
4932	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4933	</method>
4934
4935	<method name="getMediumAttachment" const="yes">
4936	<desc>
4937	Returns a medium attachment which corresponds to the controller with
4938	the given name, on the given port and device slot.
4939
4940	<result name="VBOX_E_OBJECT_NOT_FOUND">
4941	No attachment exists for the given controller/port/device combination.
4942	</result>
4943	</desc>
4944	<param name="name" type="wstring" dir="in"/>
4945	<param name="controllerPort" type="long" dir="in"/>
4946	<param name="device" type="long" dir="in"/>
4947	<param name="attachment" type="IMediumAttachment" dir="return"/>
4948	</method>
4949
4950	<method name="attachHostPciDevice">
4951	<desc>
4952	Attaches host PCI device with the given (host) PCI address to the
4953	PCI bus of the virtual machine. Please note, that this operation
4954	is two phase, as real attachment will happen when VM will start,
4955	and most information will be delivered as IHostPciDevicePlugEvent
4956	on IVirtualBox event source.
4957
4958	<see><link to="IHostPciDevicePlugEvent"/></see>
4959
4960	<result name="VBOX_E_INVALID_VM_STATE">
4961	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4962	</result>
4963	<result name="VBOX_E_PDM_ERROR">
4964	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4965	</result>
4966	<result name="VBOX_E_NOT_SUPPORTED">
4967	Hardware or host OS doesn't allow PCI device passthrought.
4968	</result>
4969	</desc>
4970	<param name="hostAddress" type="long" dir="in">
4971	<desc>Address of the host PCI device.</desc>
4972	</param>
4973	<param name="desiredGuestAddress" type="long" dir="in">
4974	<desc>Desired position of this device on guest PCI bus.</desc>
4975	</param>
4976	<param name="tryToUnbind" type="boolean" dir="in">
4977	<desc>If VMM shall try to unbind existing drivers from the
4978	device before attaching it to the guest.</desc>
4979	</param>
4980	</method>
4981
4982	<method name="detachHostPciDevice">
4983	<desc>
4984	Detach host PCI device from the virtual machine.
4985	Also HostPciDevicePlugEvent on IVirtualBox event source
4986	will be delivered. As currently we don't support hot device
4987	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4988
4989	<see><link to="IHostPciDevicePlugEvent"/></see>
4990
4991	<result name="VBOX_E_INVALID_VM_STATE">
4992	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4993	</result>
4994	<result name="VBOX_E_OBJECT_NOT_FOUND">
4995	This host device is not attached to this machine.
4996	</result>
4997	<result name="VBOX_E_PDM_ERROR">
4998	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4999	</result>
5000	<result name="VBOX_E_NOT_SUPPORTED">
5001	Hardware or host OS doesn't allow PCI device passthrought.
5002	</result>
5003	</desc>
5004	<param name="hostAddress" type="long" dir="in">
5005	<desc>Address of the host PCI device.</desc>
5006	</param>
5007	</method>
5008
5009	<method name="getNetworkAdapter" const="yes">
5010	<desc>
5011	Returns the network adapter associated with the given slot.
5012	Slots are numbered sequentially, starting with zero. The total
5013	number of adapters per machine is defined by the
5014	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5015	so the maximum slot number is one less than that property's value.
5016
5017	<result name="E_INVALIDARG">
5018	Invalid @a slot number.
5019	</result>
5020
5021	</desc>
5022	<param name="slot" type="unsigned long" dir="in"/>
5023	<param name="adapter" type="INetworkAdapter" dir="return"/>
5024	</method>
5025
5026	<method name="addStorageController">
5027	<desc>
5028	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5029	machine and returns it as an instance of
5030	<link to="IStorageController" />.
5031
5032	@a name identifies the controller for subsequent calls such as
5033	<link to="#getStorageControllerByName" />,
5034	<link to="#getStorageControllerByInstance" />,
5035	<link to="#removeStorageController" />,
5036	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5037
5038	After the controller has been added, you can set its exact
5039	type by setting the <link to="IStorageController::controllerType" />.
5040
5041	<result name="VBOX_E_OBJECT_IN_USE">
5042	A storage controller with given name exists already.
5043	</result>
5044	<result name="E_INVALIDARG">
5045	Invalid @a controllerType.
5046	</result>
5047	</desc>
5048	<param name="name" type="wstring" dir="in"/>
5049	<param name="connectionType" type="StorageBus" dir="in"/>
5050	<param name="controller" type="IStorageController" dir="return"/>
5051	</method>
5052
5053	<method name="getStorageControllerByName" const="yes">
5054	<desc>
5055	Returns a storage controller with the given name.
5056
5057	<result name="VBOX_E_OBJECT_NOT_FOUND">
5058	A storage controller with given name doesn't exist.
5059	</result>
5060	</desc>
5061	<param name="name" type="wstring" dir="in"/>
5062	<param name="storageController" type="IStorageController" dir="return"/>
5063	</method>
5064
5065	<method name="getStorageControllerByInstance" const="yes">
5066	<desc>
5067	Returns a storage controller with the given instance number.
5068
5069	<result name="VBOX_E_OBJECT_NOT_FOUND">
5070	A storage controller with given instance number doesn't exist.
5071	</result>
5072	</desc>
5073	<param name="instance" type="unsigned long" dir="in"/>
5074	<param name="storageController" type="IStorageController" dir="return"/>
5075	</method>
5076
5077	<method name="removeStorageController">
5078	<desc>
5079	Removes a storage controller from the machine.
5080
5081	<result name="VBOX_E_OBJECT_NOT_FOUND">
5082	A storage controller with given name doesn't exist.
5083	</result>
5084	</desc>
5085	<param name="name" type="wstring" dir="in"/>
5086	</method>
5087
5088	<method name="setStorageControllerBootable">
5089	<desc>
5090	Sets the bootable flag of the storage controller with the given name.
5091
5092	<result name="VBOX_E_OBJECT_NOT_FOUND">
5093	A storage controller with given name doesn't exist.
5094	</result>
5095	<result name="VBOX_E_OBJECT_IN_USE">
5096	Another storage controller is marked as bootable already.
5097	</result>
5098	</desc>
5099	<param name="name" type="wstring" dir="in"/>
5100	<param name="bootable" type="boolean" dir="in"/>
5101	</method>
5102
5103	<method name="getSerialPort" const="yes">
5104	<desc>
5105	Returns the serial port associated with the given slot.
5106	Slots are numbered sequentially, starting with zero. The total
5107	number of serial ports per machine is defined by the
5108	<link to="ISystemProperties::serialPortCount"/> property,
5109	so the maximum slot number is one less than that property's value.
5110
5111	<result name="E_INVALIDARG">
5112	Invalid @a slot number.
5113	</result>
5114
5115	</desc>
5116	<param name="slot" type="unsigned long" dir="in"/>
5117	<param name="port" type="ISerialPort" dir="return"/>
5118	</method>
5119
5120	<method name="getParallelPort" const="yes">
5121	<desc>
5122	Returns the parallel port associated with the given slot.
5123	Slots are numbered sequentially, starting with zero. The total
5124	number of parallel ports per machine is defined by the
5125	<link to="ISystemProperties::parallelPortCount"/> property,
5126	so the maximum slot number is one less than that property's value.
5127
5128	<result name="E_INVALIDARG">
5129	Invalid @a slot number.
5130	</result>
5131
5132	</desc>
5133	<param name="slot" type="unsigned long" dir="in"/>
5134	<param name="port" type="IParallelPort" dir="return"/>
5135	</method>
5136
5137	<method name="getExtraDataKeys">
5138	<desc>
5139	Returns an array representing the machine-specific extra data keys
5140	which currently have values defined.
5141	</desc>
5142	<param name="value" type="wstring" dir="return" safearray="yes">
5143	<desc>Array of extra data keys.</desc>
5144	</param>
5145	</method>
5146
5147	<method name="getExtraData">
5148	<desc>
5149	Returns associated machine-specific extra data.
5150
5151	If the requested data @a key does not exist, this function will
5152	succeed and return an empty string in the @a value argument.
5153
5154	<result name="VBOX_E_FILE_ERROR">
5155	Settings file not accessible.
5156	</result>
5157	<result name="VBOX_E_XML_ERROR">
5158	Could not parse the settings file.
5159	</result>
5160
5161	</desc>
5162	<param name="key" type="wstring" dir="in">
5163	<desc>Name of the data key to get.</desc>
5164	</param>
5165	<param name="value" type="wstring" dir="return">
5166	<desc>Value of the requested data key.</desc>
5167	</param>
5168	</method>
5169
5170	<method name="setExtraData">
5171	<desc>
5172	Sets associated machine-specific extra data.
5173
5174	If you pass @c null or an empty string as a key @a value, the given
5175	@a key will be deleted.
5176
5177	<note>
5178	Before performing the actual data change, this method will ask all
5179	registered listeners using the
5180	<link to="IExtraDataCanChangeEvent"/>
5181	notification for a permission. If one of the listeners refuses the
5182	new value, the change will not be performed.
5183	</note>
5184	<note>
5185	On success, the
5186	<link to="IExtraDataChangedEvent"/> notification
5187	is called to inform all registered listeners about a successful data
5188	change.
5189	</note>
5190	<note>
5191	This method can be called outside the machine session and therefore
5192	it's a caller's responsibility to handle possible race conditions
5193	when several clients change the same key at the same time.
5194	</note>
5195
5196	<result name="VBOX_E_FILE_ERROR">
5197	Settings file not accessible.
5198	</result>
5199	<result name="VBOX_E_XML_ERROR">
5200	Could not parse the settings file.
5201	</result>
5202
5203	</desc>
5204	<param name="key" type="wstring" dir="in">
5205	<desc>Name of the data key to set.</desc>
5206	</param>
5207	<param name="value" type="wstring" dir="in">
5208	<desc>Value to assign to the key.</desc>
5209	</param>
5210	</method>
5211
5212	<method name="getCPUProperty" const="yes">
5213	<desc>
5214	Returns the virtual CPU boolean value of the specified property.
5215
5216	<result name="E_INVALIDARG">
5217	Invalid property.
5218	</result>
5219
5220	</desc>
5221	<param name="property" type="CPUPropertyType" dir="in">
5222	<desc>
5223	Property type to query.
5224	</desc>
5225	</param>
5226	<param name="value" type="boolean" dir="return">
5227	<desc>
5228	Property value.
5229	</desc>
5230	</param>
5231	</method>
5232
5233	<method name="setCPUProperty">
5234	<desc>
5235	Sets the virtual CPU boolean value of the specified property.
5236
5237	<result name="E_INVALIDARG">
5238	Invalid property.
5239	</result>
5240
5241	</desc>
5242	<param name="property" type="CPUPropertyType" dir="in">
5243	<desc>
5244	Property type to query.
5245	</desc>
5246	</param>
5247	<param name="value" type="boolean" dir="in">
5248	<desc>
5249	Property value.
5250	</desc>
5251	</param>
5252	</method>
5253
5254	<method name="getCPUIDLeaf" const="yes">
5255	<desc>
5256	Returns the virtual CPU cpuid information for the specified leaf.
5257
5258	Currently supported index values for cpuid:
5259	Standard CPUID leafs: 0 - 0xA
5260	Extended CPUID leafs: 0x80000000 - 0x8000000A
5261
5262	See the Intel and AMD programmer's manuals for detailed information
5263	about the cpuid instruction and its leafs.
5264	<result name="E_INVALIDARG">
5265	Invalid id.
5266	</result>
5267
5268	</desc>
5269	<param name="id" type="unsigned long" dir="in">
5270	<desc>
5271	CPUID leaf index.
5272	</desc>
5273	</param>
5274	<param name="valEax" type="unsigned long" dir="out">
5275	<desc>
5276	CPUID leaf value for register eax.
5277	</desc>
5278	</param>
5279	<param name="valEbx" type="unsigned long" dir="out">
5280	<desc>
5281	CPUID leaf value for register ebx.
5282	</desc>
5283	</param>
5284	<param name="valEcx" type="unsigned long" dir="out">
5285	<desc>
5286	CPUID leaf value for register ecx.
5287	</desc>
5288	</param>
5289	<param name="valEdx" type="unsigned long" dir="out">
5290	<desc>
5291	CPUID leaf value for register edx.
5292	</desc>
5293	</param>
5294	</method>
5295
5296	<method name="setCPUIDLeaf">
5297	<desc>
5298	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5299	are not passed unmodified. VirtualBox clears features that it doesn't support.
5300
5301	Currently supported index values for cpuid:
5302	Standard CPUID leafs: 0 - 0xA
5303	Extended CPUID leafs: 0x80000000 - 0x8000000A
5304
5305	See the Intel and AMD programmer's manuals for detailed information
5306	about the cpuid instruction and its leafs.
5307
5308	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5309	random crashes inside VMs.
5310	<result name="E_INVALIDARG">
5311	Invalid id.
5312	</result>
5313
5314	</desc>
5315	<param name="id" type="unsigned long" dir="in">
5316	<desc>
5317	CPUID leaf index.
5318	</desc>
5319	</param>
5320	<param name="valEax" type="unsigned long" dir="in">
5321	<desc>
5322	CPUID leaf value for register eax.
5323	</desc>
5324	</param>
5325	<param name="valEbx" type="unsigned long" dir="in">
5326	<desc>
5327	CPUID leaf value for register ebx.
5328	</desc>
5329	</param>
5330	<param name="valEcx" type="unsigned long" dir="in">
5331	<desc>
5332	CPUID leaf value for register ecx.
5333	</desc>
5334	</param>
5335	<param name="valEdx" type="unsigned long" dir="in">
5336	<desc>
5337	CPUID leaf value for register edx.
5338	</desc>
5339	</param>
5340	</method>
5341
5342	<method name="removeCPUIDLeaf">
5343	<desc>
5344	Removes the virtual CPU cpuid leaf for the specified index
5345
5346	<result name="E_INVALIDARG">
5347	Invalid id.
5348	</result>
5349
5350	</desc>
5351	<param name="id" type="unsigned long" dir="in">
5352	<desc>
5353	CPUID leaf index.
5354	</desc>
5355	</param>
5356	</method>
5357
5358	<method name="removeAllCPUIDLeaves">
5359	<desc>
5360	Removes all the virtual CPU cpuid leaves
5361	</desc>
5362	</method>
5363
5364	<method name="getHWVirtExProperty" const="yes">
5365	<desc>
5366	Returns the value of the specified hardware virtualization boolean property.
5367
5368	<result name="E_INVALIDARG">
5369	Invalid property.
5370	</result>
5371
5372	</desc>
5373	<param name="property" type="HWVirtExPropertyType" dir="in">
5374	<desc>
5375	Property type to query.
5376	</desc>
5377	</param>
5378	<param name="value" type="boolean" dir="return">
5379	<desc>
5380	Property value.
5381	</desc>
5382	</param>
5383	</method>
5384
5385	<method name="setHWVirtExProperty">
5386	<desc>
5387	Sets a new value for the specified hardware virtualization boolean property.
5388
5389	<result name="E_INVALIDARG">
5390	Invalid property.
5391	</result>
5392
5393	</desc>
5394	<param name="property" type="HWVirtExPropertyType" dir="in">
5395	<desc>
5396	Property type to set.
5397	</desc>
5398	</param>
5399	<param name="value" type="boolean" dir="in">
5400	<desc>
5401	New property value.
5402	</desc>
5403	</param>
5404	</method>
5405
5406	<method name="saveSettings">
5407	<desc>
5408	Saves any changes to machine settings made since the session
5409	has been opened or a new machine has been created, or since the
5410	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5411	For registered machines, new settings become visible to all
5412	other VirtualBox clients after successful invocation of this
5413	method.
5414	<note>
5415	The method sends <link to="IMachineDataChangedEvent"/>
5416	notification event after the configuration has been successfully
5417	saved (only for registered machines).
5418	</note>
5419	<note>
5420	Calling this method is only valid on instances returned
5421	by <link to="ISession::machine"/> and on new machines
5422	created by <link to="IVirtualBox::createMachine"/> but not
5423	yet registered, or on unregistered machines after calling
5424	<link to="IMachine::unregister"/>.
5425	</note>
5426
5427	<result name="VBOX_E_FILE_ERROR">
5428	Settings file not accessible.
5429	</result>
5430	<result name="VBOX_E_XML_ERROR">
5431	Could not parse the settings file.
5432	</result>
5433	<result name="E_ACCESSDENIED">
5434	Modification request refused.
5435	</result>
5436
5437	</desc>
5438	</method>
5439
5440	<method name="discardSettings">
5441	<desc>
5442	Discards any changes to the machine settings made since the session
5443	has been opened or since the last call to <link to="#saveSettings"/>
5444	or <link to="#discardSettings"/>.
5445	<note>
5446	Calling this method is only valid on instances returned
5447	by <link to="ISession::machine"/> and on new machines
5448	created by <link to="IVirtualBox::createMachine"/> or
5449	opened by <link to="IVirtualBox::openMachine"/> but not
5450	yet registered, or on unregistered machines after calling
5451	<link to="IMachine::unregister"/>.
5452	</note>
5453
5454	<result name="VBOX_E_INVALID_VM_STATE">
5455	Virtual machine is not mutable.
5456	</result>
5457
5458	</desc>
5459	</method>
5460
5461	<method name="unregister">
5462	<desc>
5463	Unregisters a machine previously registered with
5464	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5465	cleanup before the machine is unregistered.
5466
5467	This method does not delete any files. It only changes the machine configuration and
5468	the list of registered machines in the VirtualBox object. To delete the files which
5469	belonged to the machine, including the XML file of the machine itself, call
5470	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5471	from this method.
5472
5473	How thoroughly this method cleans up the machine configuration before unregistering
5474	the machine depends on the @a cleanupMode argument.
5475
5476	<ul>
5477	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5478	cleanup will be performed. The call will fail if the machine is in "Saved" state
5479	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5480	It is the responsibility of the caller to delete all such configuration in this mode.
5481	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5482	which it replaces.</li>
5483	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5484	state or if it has snapshots or media attached. All media attached to the current machine
5485	state or in snapshots will be detached. No medium objects will be returned;
5486	all of the machine's media will remain open.</li>
5487	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5488	except that all the hard disk medium objects which were detached from the machine will
5489	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5490	API for closing and deletion.</li>
5491	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5492	that all media will be returned in the array, including removable media like DVDs and
5493	floppies. This might be useful if the user wants to inspect in detail which media were
5494	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5495	in that case because users will typically want to preserve ISO and RAW image files.</li>
5496	</ul>
5497
5498	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5499	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5500	deleted with all its saved states and hard disk images, but images for removable
5501	drives (such as ISO and RAW files) will remain on disk.
5502
5503	This API does not verify whether the media files returned in the array are still
5504	attached to other machines (i.e. shared between several machines). If such a shared
5505	image is passed to <link to="#delete" /> however, closing the image will fail there
5506	and the image will be silently skipped.
5507
5508	This API may, however, move media from this machine's media registry to other media
5509	registries (see <link to="IMedium" /> for details on media registries). For machines
5510	created with VirtualBox 4.0 or later, if media from this machine's media registry
5511	are also attached to another machine (shared attachments), each such medium will be
5512	moved to another machine's registry. This is because without this machine's media
5513	registry, the other machine cannot find its media any more and would become inaccessible.
5514
5515	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5516	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5517	if media are moved to other machines' media registries.
5518
5519	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5520	is fired.
5521
5522	The call will fail if the machine is currently locked (see <link to="ISession" />).
5523
5524	<note>
5525	If the given machine is inaccessible (see <link to="#accessible"/>), it
5526	will be unregistered and fully uninitialized right afterwards. As a result,
5527	the returned machine object will be unusable and an attempt to call
5528	<b>any</b> method will return the "Object not ready" error.
5529	</note>
5530
5531	<result name="VBOX_E_INVALID_OBJECT_STATE">
5532	Machine is currently locked for a session.
5533	</result>
5534	</desc>
5535
5536	<param name="cleanupMode" type="CleanupMode" dir="in">
5537	<desc>How to clean up after the machine has been unregistered.</desc>
5538	</param>
5539	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5540	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5541	</param>
5542	</method>
5543
5544	<method name="delete">
5545	<desc>
5546	Deletes the files associated with this machine from disk. If medium objects are passed
5547	in with the @a aMedia argument, they are closed and, if closing was successful, their
5548	storage files are deleted as well. For convenience, this array of media files can be
5549	the same as the one returned from a previous <link to="#unregister" /> call.
5550
5551	This method must only be called on machines which are either write-locked (i.e. on instances
5552	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5553	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5554	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5555
5556	The following files will be deleted by this method:
5557	<ul>
5558	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5559	argument other than "UnregisterOnly", this will delete all saved state files that
5560	the machine had in use; possibly one if the machine was in "Saved" state and one
5561	for each online snapshot that the machine had.</li>
5562	<li>On each medium object passed in the @a aMedia array, this will call
5563	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5564	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5565	in use, e.g. because it is still attached to a second machine; in that case the
5566	storage will not be deleted.</li>
5567	<li>Finally, the machine's own XML file will be deleted.</li>
5568	</ul>
5569
5570	Since deleting large disk image files can be a time-consuming I/O operation, this
5571	method operates asynchronously and returns an IProgress object to allow the caller
5572	to monitor the progress. There will be one sub-operation for each file that is
5573	being deleted (saved state or medium storage file).
5574
5575	<note>
5576	<link to="#settingsModified"/> will return @c true after this
5577	method successfully returns.
5578	</note>
5579
5580	<result name="VBOX_E_INVALID_VM_STATE">
5581	Machine is registered but not write-locked.
5582	</result>
5583	<result name="VBOX_E_IPRT_ERROR">
5584	Could not delete the settings file.
5585	</result>
5586	</desc>
5587	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5588	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5589	</param>
5590	<param name="aProgress" type="IProgress" dir="return">
5591	<desc>Progress object to track the operation completion.</desc>
5592	</param>
5593	</method>
5594
5595	<method name="export">
5596	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5597	steps required to export VirtualBox machines to OVF.
5598	</desc>
5599
5600	<param name="aAppliance" type="IAppliance" dir="in">
5601	<desc>Appliance to export this machine to.</desc>
5602	</param>
5603	<param name="location" type="wstring" dir="in">
5604	<desc>The target location.</desc>
5605	</param>
5606	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5607	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5608	</param>
5609	</method >
5610
5611	<method name="findSnapshot">
5612	<desc>
5613	Returns a snapshot of this machine with the given name or UUID.
5614
5615	Returns a snapshot of this machine with the given UUID.
5616	A @c null argument can be used to obtain the first snapshot
5617	taken on this machine. To traverse the whole tree of snapshots
5618	starting from the root, inspect the root snapshot's
5619	<link to="ISnapshot::children" /> attribute and recurse over those children.
5620
5621	<result name="VBOX_E_OBJECT_NOT_FOUND">
5622	Virtual machine has no snapshots or snapshot not found.
5623	</result>
5624
5625	</desc>
5626	<param name="nameOrId" type="wstring" dir="in">
5627	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5628	</param>
5629	<param name="snapshot" type="ISnapshot" dir="return">
5630	<desc>Snapshot object with the given name.</desc>
5631	</param>
5632	</method>
5633
5634	<method name="createSharedFolder">
5635	<desc>
5636	Creates a new permanent shared folder by associating the given logical
5637	name with the given host path, adds it to the collection of shared
5638	folders and starts sharing it. Refer to the description of
5639	<link to="ISharedFolder"/> to read more about logical names.
5640
5641	<result name="VBOX_E_OBJECT_IN_USE">
5642	Shared folder already exists.
5643	</result>
5644	<result name="VBOX_E_FILE_ERROR">
5645	Shared folder @a hostPath not accessible.
5646	</result>
5647
5648	</desc>
5649	<param name="name" type="wstring" dir="in">
5650	<desc>Unique logical name of the shared folder.</desc>
5651	</param>
5652	<param name="hostPath" type="wstring" dir="in">
5653	<desc>Full path to the shared folder in the host file system.</desc>
5654	</param>
5655	<param name="writable" type="boolean" dir="in">
5656	<desc>Whether the share is writable or readonly.</desc>
5657	</param>
5658	<param name="automount" type="boolean" dir="in">
5659	<desc>Whether the share gets automatically mounted by the guest
5660	or not.</desc>
5661	</param>
5662	</method>
5663
5664	<method name="removeSharedFolder">
5665	<desc>
5666	Removes the permanent shared folder with the given name previously
5667	created by <link to="#createSharedFolder"/> from the collection of
5668	shared folders and stops sharing it.
5669
5670	<result name="VBOX_E_INVALID_VM_STATE">
5671	Virtual machine is not mutable.
5672	</result>
5673	<result name="VBOX_E_OBJECT_NOT_FOUND">
5674	Shared folder @a name does not exist.
5675	</result>
5676
5677	</desc>
5678	<param name="name" type="wstring" dir="in">
5679	<desc>Logical name of the shared folder to remove.</desc>
5680	</param>
5681	</method>
5682
5683	<method name="canShowConsoleWindow">
5684	<desc>
5685	Returns @c true if the VM console process can activate the
5686	console window and bring it to foreground on the desktop of
5687	the host PC.
5688	<note>
5689	This method will fail if a session for this machine is not
5690	currently open.
5691	</note>
5692
5693	<result name="VBOX_E_INVALID_VM_STATE">
5694	Machine session is not open.
5695	</result>
5696
5697	</desc>
5698	<param name="canShow" type="boolean" dir="return">
5699	<desc>
5700	@c true if the console window can be shown and @c false otherwise.
5701	</desc>
5702	</param>
5703	</method>
5704
5705	<method name="showConsoleWindow">
5706	<desc>
5707	Activates the console window and brings it to foreground on
5708	the desktop of the host PC. Many modern window managers on
5709	many platforms implement some sort of focus stealing
5710	prevention logic, so that it may be impossible to activate
5711	a window without the help of the currently active
5712	application. In this case, this method will return a non-zero
5713	identifier that represents the top-level window of the VM
5714	console process. The caller, if it represents a currently
5715	active process, is responsible to use this identifier (in a
5716	platform-dependent manner) to perform actual window
5717	activation.
5718	<note>
5719	This method will fail if a session for this machine is not
5720	currently open.
5721	</note>
5722
5723	<result name="VBOX_E_INVALID_VM_STATE">
5724	Machine session is not open.
5725	</result>
5726
5727	</desc>
5728	<param name="winId" type="long long" dir="return">
5729	<desc>
5730	Platform-dependent identifier of the top-level VM console
5731	window, or zero if this method has performed all actions
5732	necessary to implement the <i>show window</i> semantics for
5733	the given platform and/or VirtualBox front-end.
5734	</desc>
5735	</param>
5736	</method>
5737
5738	<method name="getGuestProperty" const="yes">
5739	<desc>
5740	Reads an entry from the machine's guest property store.
5741
5742	<result name="VBOX_E_INVALID_VM_STATE">
5743	Machine session is not open.
5744	</result>
5745
5746	</desc>
5747	<param name="name" type="wstring" dir="in">
5748	<desc>
5749	The name of the property to read.
5750	</desc>
5751	</param>
5752	<param name="value" type="wstring" dir="out">
5753	<desc>
5754	The value of the property. If the property does not exist then this
5755	will be empty.
5756	</desc>
5757	</param>
5758	<param name="timestamp" type="long long" dir="out">
5759	<desc>
5760	The time at which the property was last modified, as seen by the
5761	server process.
5762	</desc>
5763	</param>
5764	<param name="flags" type="wstring" dir="out">
5765	<desc>
5766	Additional property parameters, passed as a comma-separated list of
5767	"name=value" type entries.
5768	</desc>
5769	</param>
5770	</method>
5771
5772	<method name="getGuestPropertyValue" const="yes">
5773	<desc>
5774	Reads a value from the machine's guest property store.
5775
5776	<result name="VBOX_E_INVALID_VM_STATE">
5777	Machine session is not open.
5778	</result>
5779
5780	</desc>
5781	<param name="property" type="wstring" dir="in">
5782	<desc>
5783	The name of the property to read.
5784	</desc>
5785	</param>
5786	<param name="value" type="wstring" dir="return">
5787	<desc>
5788	The value of the property. If the property does not exist then this
5789	will be empty.
5790	</desc>
5791	</param>
5792	</method>
5793
5794	<method name="getGuestPropertyTimestamp" const="yes">
5795	<desc>
5796	Reads a property timestamp from the machine's guest property store.
5797
5798	<result name="VBOX_E_INVALID_VM_STATE">
5799	Machine session is not open.
5800	</result>
5801
5802	</desc>
5803	<param name="property" type="wstring" dir="in">
5804	<desc>
5805	The name of the property to read.
5806	</desc>
5807	</param>
5808	<param name="value" type="long long" dir="return">
5809	<desc>
5810	The timestamp. If the property does not exist then this will be
5811	empty.
5812	</desc>
5813	</param>
5814	</method>
5815
5816	<method name="setGuestProperty">
5817	<desc>
5818	Sets, changes or deletes an entry in the machine's guest property
5819	store.
5820
5821	<result name="E_ACCESSDENIED">
5822	Property cannot be changed.
5823	</result>
5824	<result name="E_INVALIDARG">
5825	Invalid @a flags.
5826	</result>
5827	<result name="VBOX_E_INVALID_VM_STATE">
5828	Virtual machine is not mutable or session not open.
5829	</result>
5830	<result name="VBOX_E_INVALID_OBJECT_STATE">
5831	Cannot set transient property when machine not running.
5832	</result>
5833
5834	</desc>
5835	<param name="property" type="wstring" dir="in">
5836	<desc>
5837	The name of the property to set, change or delete.
5838	</desc>
5839	</param>
5840	<param name="value" type="wstring" dir="in">
5841	<desc>
5842	The new value of the property to set, change or delete. If the
5843	property does not yet exist and value is non-empty, it will be
5844	created. If the value is @c null or empty, the property will be
5845	deleted if it exists.
5846	</desc>
5847	</param>
5848	<param name="flags" type="wstring" dir="in">
5849	<desc>
5850	Additional property parameters, passed as a comma-separated list of
5851	"name=value" type entries.
5852	</desc>
5853	</param>
5854	</method>
5855
5856	<method name="setGuestPropertyValue">
5857	<desc>
5858	Sets, changes or deletes a value in the machine's guest property
5859	store. The flags field will be left unchanged or created empty for a
5860	new property.
5861
5862	<result name="E_ACCESSDENIED">
5863	Property cannot be changed.
5864	</result>
5865	<result name="VBOX_E_INVALID_VM_STATE">
5866	Virtual machine is not mutable or session not open.
5867	</result>
5868	<result name="VBOX_E_INVALID_OBJECT_STATE">
5869	Cannot set transient property when machine not running.
5870	</result>
5871	</desc>
5872
5873	<param name="property" type="wstring" dir="in">
5874	<desc>
5875	The name of the property to set, change or delete.
5876	</desc>
5877	</param>
5878	<param name="value" type="wstring" dir="in">
5879	<desc>
5880	The new value of the property to set, change or delete. If the
5881	property does not yet exist and value is non-empty, it will be
5882	created. If the value is @c null or empty, the property will be
5883	deleted if it exists.
5884	</desc>
5885	</param>
5886	</method>
5887
5888	<method name="enumerateGuestProperties" const="yes">
5889	<desc>
5890	Return a list of the guest properties matching a set of patterns along
5891	with their values, time stamps and flags.
5892	</desc>
5893	<param name="patterns" type="wstring" dir="in">
5894	<desc>
5895	The patterns to match the properties against, separated by '\|'
5896	characters. If this is empty or @c null, all properties will match.
5897	</desc>
5898	</param>
5899	<param name="name" type="wstring" dir="out" safearray="yes">
5900	<desc>
5901	The names of the properties returned.
5902	</desc>
5903	</param>
5904	<param name="value" type="wstring" dir="out" safearray="yes">
5905	<desc>
5906	The values of the properties returned. The array entries match the
5907	corresponding entries in the @a name array.
5908	</desc>
5909	</param>
5910	<param name="timestamp" type="long long" dir="out" safearray="yes">
5911	<desc>
5912	The time stamps of the properties returned. The array entries match
5913	the corresponding entries in the @a name array.
5914	</desc>
5915	</param>
5916	<param name="flags" type="wstring" dir="out" safearray="yes">
5917	<desc>
5918	The flags of the properties returned. The array entries match the
5919	corresponding entries in the @a name array.
5920	</desc>
5921	</param>
5922	</method>
5923
5924	<method name="querySavedGuestSize" const="yes">
5925	<desc>
5926	Returns the guest dimensions from the saved state.
5927	</desc>
5928	<param name="screenId" type="unsigned long" dir="in">
5929	<desc>
5930	Saved guest screen to query info from.
5931	</desc>
5932	</param>
5933	<param name="width" type="unsigned long" dir="out">
5934	<desc>
5935	Guest width at the time of the saved state was taken.
5936	</desc>
5937	</param>
5938	<param name="height" type="unsigned long" dir="out">
5939	<desc>
5940	Guest height at the time of the saved state was taken.
5941	</desc>
5942	</param>
5943	</method>
5944
5945	<method name="querySavedThumbnailSize">
5946	<desc>
5947	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5948	</desc>
5949	<param name="screenId" type="unsigned long" dir="in">
5950	<desc>
5951	Saved guest screen to query info from.
5952	</desc>
5953	</param>
5954	<param name="size" type="unsigned long" dir="out">
5955	<desc>
5956	Size of buffer required to store the bitmap.
5957	</desc>
5958	</param>
5959	<param name="width" type="unsigned long" dir="out">
5960	<desc>
5961	Bitmap width.
5962	</desc>
5963	</param>
5964	<param name="height" type="unsigned long" dir="out">
5965	<desc>
5966	Bitmap height.
5967	</desc>
5968	</param>
5969	</method>
5970
5971	<method name="readSavedThumbnailToArray">
5972	<desc>
5973	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5974	</desc>
5975	<param name="screenId" type="unsigned long" dir="in">
5976	<desc>
5977	Saved guest screen to read from.
5978	</desc>
5979	</param>
5980	<param name="BGR" type="boolean" dir="in">
5981	<desc>
5982	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5983	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5984	</desc>
5985	</param>
5986	<param name="width" type="unsigned long" dir="out">
5987	<desc>
5988	Bitmap width.
5989	</desc>
5990	</param>
5991	<param name="height" type="unsigned long" dir="out">
5992	<desc>
5993	Bitmap height.
5994	</desc>
5995	</param>
5996	<param name="data" type="octet" safearray="yes" dir="return">
5997	<desc>
5998	Array with resulting bitmap data.
5999	</desc>
6000	</param>
6001	</method>
6002
6003	<method name="readSavedThumbnailPNGToArray">
6004	<desc>
6005	Thumbnail in PNG format is retrieved to an array of bytes.
6006	</desc>
6007	<param name="screenId" type="unsigned long" dir="in">
6008	<desc>
6009	Saved guest screen to read from.
6010	</desc>
6011	</param>
6012	<param name="width" type="unsigned long" dir="out">
6013	<desc>
6014	Image width.
6015	</desc>
6016	</param>
6017	<param name="height" type="unsigned long" dir="out">
6018	<desc>
6019	Image height.
6020	</desc>
6021	</param>
6022	<param name="data" type="octet" dir="return" safearray="yes">
6023	<desc>
6024	Array with resulting PNG data.
6025	</desc>
6026	</param>
6027	</method>
6028
6029	<method name="querySavedScreenshotPNGSize">
6030	<desc>
6031	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6032	</desc>
6033	<param name="screenId" type="unsigned long" dir="in">
6034	<desc>
6035	Saved guest screen to query info from.
6036	</desc>
6037	</param>
6038	<param name="size" type="unsigned long" dir="out">
6039	<desc>
6040	Size of buffer required to store the PNG binary data.
6041	</desc>
6042	</param>
6043	<param name="width" type="unsigned long" dir="out">
6044	<desc>
6045	Image width.
6046	</desc>
6047	</param>
6048	<param name="height" type="unsigned long" dir="out">
6049	<desc>
6050	Image height.
6051	</desc>
6052	</param>
6053	</method>
6054
6055	<method name="readSavedScreenshotPNGToArray">
6056	<desc>
6057	Screenshot in PNG format is retrieved to an array of bytes.
6058	</desc>
6059	<param name="screenId" type="unsigned long" dir="in">
6060	<desc>
6061	Saved guest screen to read from.
6062	</desc>
6063	</param>
6064	<param name="width" type="unsigned long" dir="out">
6065	<desc>
6066	Image width.
6067	</desc>
6068	</param>
6069	<param name="height" type="unsigned long" dir="out">
6070	<desc>
6071	Image height.
6072	</desc>
6073	</param>
6074	<param name="data" type="octet" dir="return" safearray="yes">
6075	<desc>
6076	Array with resulting PNG data.
6077	</desc>
6078	</param>
6079	</method>
6080
6081	<method name="hotPlugCPU">
6082	<desc>
6083	Plugs a CPU into the machine.
6084	</desc>
6085	<param name="cpu" type="unsigned long" dir="in">
6086	<desc>
6087	The CPU id to insert.
6088	</desc>
6089	</param>
6090	</method>
6091
6092	<method name="hotUnplugCPU">
6093	<desc>
6094	Removes a CPU from the machine.
6095	</desc>
6096	<param name="cpu" type="unsigned long" dir="in">
6097	<desc>
6098	The CPU id to remove.
6099	</desc>
6100	</param>
6101	</method>
6102
6103	<method name="getCPUStatus">
6104	<desc>
6105	Returns the current status of the given CPU.
6106	</desc>
6107	<param name="cpu" type="unsigned long" dir="in">
6108	<desc>
6109	The CPU id to check for.
6110	</desc>
6111	</param>
6112	<param name="attached" type="boolean" dir="return">
6113	<desc>
6114	Status of the CPU.
6115	</desc>
6116	</param>
6117	</method>
6118
6119	<method name="queryLogFilename">
6120	<desc>
6121	Queries for the VM log file name of an given index. Returns an empty
6122	string if a log file with that index doesn't exists.
6123	</desc>
6124	<param name="idx" type="unsigned long" dir="in">
6125	<desc>
6126	Which log file name to query. 0=current log file.
6127	</desc>
6128	</param>
6129	<param name="filename" type="wstring" dir="return">
6130	<desc>
6131	On return the full path to the log file or an empty string on error.
6132	</desc>
6133	</param>
6134	</method>
6135
6136	<method name="readLog">
6137	<desc>
6138	Reads the VM log file. The chunk size is limited, so even if you
6139	ask for a big piece there might be less data returned.
6140	</desc>
6141	<param name="idx" type="unsigned long" dir="in">
6142	<desc>
6143	Which log file to read. 0=current log file.
6144	</desc>
6145	</param>
6146	<param name="offset" type="long long" dir="in">
6147	<desc>
6148	Offset in the log file.
6149	</desc>
6150	</param>
6151	<param name="size" type="long long" dir="in">
6152	<desc>
6153	Chunk size to read in the log file.
6154	</desc>
6155	</param>
6156	<param name="data" type="octet" dir="return" safearray="yes">
6157	<desc>
6158	Data read from the log file. A data size of 0 means end of file
6159	if the requested chunk size was not 0. This is the unprocessed
6160	file data, i.e. the line ending style depends on the platform of
6161	the system the server is running on.
6162	</desc>
6163	</param>
6164	</method>
6165
6166	<method name="cloneTo">
6167	<desc>
6168	Creates a clone of this machine, either as a full clone (which means
6169	creating independent copies of the hard disk media, save states and so
6170	on), or as a linked clone (which uses its own differencing media,
6171	sharing the parent media with the source machine).
6172
6173	The target machine object must have been created previously with <link
6174	to="IVirtualBox::createMachine"/>, and all the settings will be
6175	transferred except the VM name and the hardware UUID. You can set the
6176	VM name and the new hardware UUID when creating the target machine. The
6177	network MAC addresses are newly created for all newtwork adapters. You
6178	can change that behaviour with the options parameter. The operation is
6179	performed asynchronously, so the machine object will be not be usable
6180	until the @a progress object signals completion.
6181
6182	<result name="E_INVALIDARG">
6183	@a target is @c null.
6184	</result>
6185	</desc>
6186
6187	<param name="target" type="IMachine" dir="in">
6188	<desc>Target machine object.</desc>
6189	</param>
6190	<param name="mode" type="CloneMode" dir="in">
6191	<desc>Which states should be cloned.</desc>
6192	</param>
6193	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6194	<desc>Options for the cloning operation.</desc>
6195	</param>
6196	<param name="progress" type="IProgress" dir="return">
6197	<desc>Progress object to track the operation completion.</desc>
6198	</param>
6199	</method>
6200
6201	</interface>
6202
6203	<!--
6204	// IConsole
6205	/////////////////////////////////////////////////////////////////////////
6206	-->
6207
6208	<interface
6209	name="IVRDEServerInfo" extends="$unknown"
6210	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6211	wsmap="struct"
6212	>
6213	<desc>
6214	Contains information about the remote desktop (VRDE) server capabilities and status.
6215	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6216	</desc>
6217
6218	<attribute name="active" type="boolean" readonly="yes">
6219	<desc>
6220	Whether the remote desktop connection is active.
6221	</desc>
6222	</attribute>
6223
6224	<attribute name="port" type="long" readonly="yes">
6225	<desc>
6226	VRDE server port number. If this property is equal to <tt>0</tt>, then
6227	the VRDE server failed to start, usually because there are no free IP
6228	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6229	server has not yet been started.
6230	</desc>
6231	</attribute>
6232
6233	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6234	<desc>
6235	How many times a client connected.
6236	</desc>
6237	</attribute>
6238
6239	<attribute name="beginTime" type="long long" readonly="yes">
6240	<desc>
6241	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6242	</desc>
6243	</attribute>
6244
6245	<attribute name="endTime" type="long long" readonly="yes">
6246	<desc>
6247	When the last connection was terminated or the current time, if
6248	connection is still active, in milliseconds since 1970-01-01 UTC.
6249	</desc>
6250	</attribute>
6251
6252	<attribute name="bytesSent" type="long long" readonly="yes">
6253	<desc>
6254	How many bytes were sent in last or current, if still active, connection.
6255	</desc>
6256	</attribute>
6257
6258	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6259	<desc>
6260	How many bytes were sent in all connections.
6261	</desc>
6262	</attribute>
6263
6264	<attribute name="bytesReceived" type="long long" readonly="yes">
6265	<desc>
6266	How many bytes were received in last or current, if still active, connection.
6267	</desc>
6268	</attribute>
6269
6270	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6271	<desc>
6272	How many bytes were received in all connections.
6273	</desc>
6274	</attribute>
6275
6276	<attribute name="user" type="wstring" readonly="yes">
6277	<desc>
6278	Login user name supplied by the client.
6279	</desc>
6280	</attribute>
6281
6282	<attribute name="domain" type="wstring" readonly="yes">
6283	<desc>
6284	Login domain name supplied by the client.
6285	</desc>
6286	</attribute>
6287
6288	<attribute name="clientName" type="wstring" readonly="yes">
6289	<desc>
6290	The client name supplied by the client.
6291	</desc>
6292	</attribute>
6293
6294	<attribute name="clientIP" type="wstring" readonly="yes">
6295	<desc>
6296	The IP address of the client.
6297	</desc>
6298	</attribute>
6299
6300	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6301	<desc>
6302	The client software version number.
6303	</desc>
6304	</attribute>
6305
6306	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6307	<desc>
6308	Public key exchange method used when connection was established.
6309	Values: 0 - RDP4 public key exchange scheme.
6310	1 - X509 certificates were sent to client.
6311	</desc>
6312	</attribute>
6313
6314	</interface>
6315
6316	<interface
6317	name="IConsole" extends="$unknown"
6318	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6319	wsmap="managed"
6320	>
6321	<desc>
6322	The IConsole interface represents an interface to control virtual
6323	machine execution.
6324
6325	A console object gets created when a machine has been locked for a
6326	particular session (client process) using <link to="IMachine::lockMachine" />
6327	or <link to="IMachine::launchVMProcess"/>. The console object can
6328	then be found in the session's <link to="ISession::console" /> attribute.
6329
6330	Methods of the IConsole interface allow the caller to query the current
6331	virtual machine execution state, pause the machine or power it down, save
6332	the machine state or take a snapshot, attach and detach removable media
6333	and so on.
6334
6335	<see><link to="ISession"/></see>
6336	</desc>
6337
6338	<attribute name="machine" type="IMachine" readonly="yes">
6339	<desc>
6340	Machine object for this console session.
6341	<note>
6342	This is a convenience property, it has the same value as
6343	<link to="ISession::machine"/> of the corresponding session
6344	object.
6345	</note>
6346	</desc>
6347	</attribute>
6348
6349	<attribute name="state" type="MachineState" readonly="yes">
6350	<desc>
6351	Current execution state of the machine.
6352	<note>
6353	This property always returns the same value as the corresponding
6354	property of the IMachine object for this console session.
6355	For the process that owns (executes) the VM, this is the
6356	preferable way of querying the VM state, because no IPC
6357	calls are made.
6358	</note>
6359	</desc>
6360	</attribute>
6361
6362	<attribute name="guest" type="IGuest" readonly="yes">
6363	<desc>Guest object.</desc>
6364	</attribute>
6365
6366	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6367	<desc>
6368	Virtual keyboard object.
6369	<note>
6370	If the machine is not running, any attempt to use
6371	the returned object will result in an error.
6372	</note>
6373	</desc>
6374	</attribute>
6375
6376	<attribute name="mouse" type="IMouse" readonly="yes">
6377	<desc>
6378	Virtual mouse object.
6379	<note>
6380	If the machine is not running, any attempt to use
6381	the returned object will result in an error.
6382	</note>
6383	</desc>
6384	</attribute>
6385
6386	<attribute name="display" type="IDisplay" readonly="yes">
6387	<desc>Virtual display object.
6388	<note>
6389	If the machine is not running, any attempt to use
6390	the returned object will result in an error.
6391	</note>
6392	</desc>
6393	</attribute>
6394
6395	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6396	<desc>Debugging interface.</desc>
6397	</attribute>
6398
6399	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6400	<desc>
6401	Collection of USB devices currently attached to the virtual
6402	USB controller.
6403	<note>
6404	The collection is empty if the machine is not running.
6405	</note>
6406	</desc>
6407	</attribute>
6408
6409	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6410	<desc>
6411	List of USB devices currently attached to the remote VRDE client.
6412	Once a new device is physically attached to the remote host computer,
6413	it appears in this list and remains there until detached.
6414	</desc>
6415	</attribute>
6416
6417	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6418	<desc>
6419	Collection of shared folders for the current session. These folders
6420	are called transient shared folders because they are available to the
6421	guest OS running inside the associated virtual machine only for the
6422	duration of the session (as opposed to
6423	<link to="IMachine::sharedFolders"/> which represent permanent shared
6424	folders). When the session is closed (e.g. the machine is powered down),
6425	these folders are automatically discarded.
6426
6427	New shared folders are added to the collection using
6428	<link to="#createSharedFolder"/>. Existing shared folders can be
6429	removed using <link to="#removeSharedFolder"/>.
6430	</desc>
6431	</attribute>
6432
6433	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6434	<desc>
6435	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6436	</desc>
6437	</attribute>
6438
6439	<attribute name="eventSource" type="IEventSource" readonly="yes">
6440	<desc>
6441	Event source for console events.
6442	</desc>
6443	</attribute>
6444
6445	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6446	<desc>Array of PCI devices attached to this machine.</desc>
6447	</attribute>
6448
6449	<attribute name="useHostClipboard" type="boolean">
6450	<desc>
6451	Whether the guest clipboard should be connected to the host one or
6452	whether it should only be allowed access to the VRDE clipboard. This
6453	setting may not affect existing guest clipboard connections which
6454	are already connected to the host clipboard.
6455	</desc>
6456	</attribute>
6457
6458	<method name="powerUp">
6459	<desc>
6460	Starts the virtual machine execution using the current machine
6461	state (that is, its current execution state, current settings and
6462	current storage devices).
6463
6464	<note>
6465	This method is only useful for front-ends that want to actually
6466	execute virtual machines in their own process (like the VirtualBox
6467	or VBoxSDL front-ends). Unless you are intending to write such a
6468	front-end, do not call this method. If you simply want to
6469	start virtual machine execution using one of the existing front-ends
6470	(for example the VirtualBox GUI or headless server), use
6471	<link to="IMachine::launchVMProcess"/> instead; these
6472	front-ends will power up the machine automatically for you.
6473	</note>
6474
6475	If the machine is powered off or aborted, the execution will
6476	start from the beginning (as if the real hardware were just
6477	powered on).
6478
6479	If the machine is in the <link to="MachineState_Saved"/> state,
6480	it will continue its execution the point where the state has
6481	been saved.
6482
6483	If the machine <link to="IMachine::teleporterEnabled"/> property is
6484	enabled on the machine being powered up, the machine will wait for an
6485	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6486	state. The returned progress object will have at least three
6487	operations where the last three are defined as: (1) powering up and
6488	starting TCP server, (2) waiting for incoming teleportations, and
6489	(3) perform teleportation. These operations will be reflected as the
6490	last three operations of the progress objected returned by
6491	<link to="IMachine::launchVMProcess"/> as well.
6492
6493	<see><link to="#saveState"/></see>
6494
6495	<result name="VBOX_E_INVALID_VM_STATE">
6496	Virtual machine already running.
6497	</result>
6498	<result name="VBOX_E_HOST_ERROR">
6499	Host interface does not exist or name not set.
6500	</result>
6501	<result name="VBOX_E_FILE_ERROR">
6502	Invalid saved state file.
6503	</result>
6504	</desc>
6505	<param name="progress" type="IProgress" dir="return">
6506	<desc>Progress object to track the operation completion.</desc>
6507	</param>
6508	</method>
6509
6510	<method name="powerUpPaused">
6511	<desc>
6512	Identical to powerUp except that the VM will enter the
6513	<link to="MachineState_Paused"/> state, instead of
6514	<link to="MachineState_Running"/>.
6515
6516	<see><link to="#powerUp"/></see>
6517	<result name="VBOX_E_INVALID_VM_STATE">
6518	Virtual machine already running.
6519	</result>
6520	<result name="VBOX_E_HOST_ERROR">
6521	Host interface does not exist or name not set.
6522	</result>
6523	<result name="VBOX_E_FILE_ERROR">
6524	Invalid saved state file.
6525	</result>
6526	</desc>
6527	<param name="progress" type="IProgress" dir="return">
6528	<desc>Progress object to track the operation completion.</desc>
6529	</param>
6530	</method>
6531
6532	<method name="powerDown">
6533	<desc>
6534	Initiates the power down procedure to stop the virtual machine
6535	execution.
6536
6537	The completion of the power down procedure is tracked using the returned
6538	IProgress object. After the operation is complete, the machine will go
6539	to the PoweredOff state.
6540	<result name="VBOX_E_INVALID_VM_STATE">
6541	Virtual machine must be Running, Paused or Stuck to be powered down.
6542	</result>
6543	</desc>
6544	<param name="progress" type="IProgress" dir="return">
6545	<desc>Progress object to track the operation completion.</desc>
6546	</param>
6547	</method>
6548
6549	<method name="reset">
6550	<desc>Resets the virtual machine.
6551	<result name="VBOX_E_INVALID_VM_STATE">
6552	Virtual machine not in Running state.
6553	</result>
6554	<result name="VBOX_E_VM_ERROR">
6555	Virtual machine error in reset operation.
6556	</result>
6557	</desc>
6558	</method>
6559
6560	<method name="pause">
6561	<desc>Pauses the virtual machine execution.
6562	<result name="VBOX_E_INVALID_VM_STATE">
6563	Virtual machine not in Running state.
6564	</result>
6565	<result name="VBOX_E_VM_ERROR">
6566	Virtual machine error in suspend operation.
6567	</result>
6568	</desc>
6569	</method>
6570
6571	<method name="resume">
6572	<desc>Resumes the virtual machine execution.
6573	<result name="VBOX_E_INVALID_VM_STATE">
6574	Virtual machine not in Paused state.
6575	</result>
6576	<result name="VBOX_E_VM_ERROR">
6577	Virtual machine error in resume operation.
6578	</result>
6579	</desc>
6580	</method>
6581
6582	<method name="powerButton">
6583	<desc>Sends the ACPI power button event to the guest.
6584	<result name="VBOX_E_INVALID_VM_STATE">
6585	Virtual machine not in Running state.
6586	</result>
6587	<result name="VBOX_E_PDM_ERROR">
6588	Controlled power off failed.
6589	</result>
6590	</desc>
6591	</method>
6592
6593	<method name="sleepButton">
6594	<desc>Sends the ACPI sleep button event to the guest.
6595	<result name="VBOX_E_INVALID_VM_STATE">
6596	Virtual machine not in Running state.
6597	</result>
6598	<result name="VBOX_E_PDM_ERROR">
6599	Sending sleep button event failed.
6600	</result>
6601	</desc>
6602	</method>
6603
6604	<method name="getPowerButtonHandled">
6605	<desc>Checks if the last power button event was handled by guest.
6606	<result name="VBOX_E_PDM_ERROR">
6607	Checking if the event was handled by the guest OS failed.
6608	</result>
6609	</desc>
6610	<param name="handled" type="boolean" dir="return"/>
6611	</method>
6612
6613	<method name="getGuestEnteredACPIMode">
6614	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6615	G1 (sleeping). If this method returns @c false, the guest will
6616	most likely not respond to external ACPI events.
6617	<result name="VBOX_E_INVALID_VM_STATE">
6618	Virtual machine not in Running state.
6619	</result>
6620	</desc>
6621	<param name="entered" type="boolean" dir="return"/>
6622	</method>
6623
6624	<method name="saveState">
6625	<desc>
6626	Saves the current execution state of a running virtual machine
6627	and stops its execution.
6628
6629	After this operation completes, the machine will go to the
6630	Saved state. Next time it is powered up, this state will
6631	be restored and the machine will continue its execution from
6632	the place where it was saved.
6633
6634	This operation differs from taking a snapshot to the effect
6635	that it doesn't create new differencing media. Also, once
6636	the machine is powered up from the state saved using this method,
6637	the saved state is deleted, so it will be impossible to return
6638	to this state later.
6639
6640	<note>
6641	On success, this method implicitly calls
6642	<link to="IMachine::saveSettings"/> to save all current machine
6643	settings (including runtime changes to the DVD medium, etc.).
6644	Together with the impossibility to change any VM settings when it is
6645	in the Saved state, this guarantees adequate hardware
6646	configuration of the machine when it is restored from the saved
6647	state file.
6648	</note>
6649
6650	<note>
6651	The machine must be in the Running or Paused state, otherwise
6652	the operation will fail.
6653	</note>
6654	<result name="VBOX_E_INVALID_VM_STATE">
6655	Virtual machine state neither Running nor Paused.
6656	</result>
6657	<result name="VBOX_E_FILE_ERROR">
6658	Failed to create directory for saved state file.
6659	</result>
6660
6661	<see><link to="#takeSnapshot"/></see>
6662	</desc>
6663	<param name="progress" type="IProgress" dir="return">
6664	<desc>Progress object to track the operation completion.</desc>
6665	</param>
6666	</method>
6667
6668	<method name="adoptSavedState">
6669	<desc>
6670	Associates the given saved state file to the virtual machine.
6671
6672	On success, the machine will go to the Saved state. Next time it is
6673	powered up, it will be restored from the adopted saved state and
6674	continue execution from the place where the saved state file was
6675	created.
6676
6677	The specified saved state file path may be absolute or relative to the
6678	folder the VM normally saves the state to (usually,
6679	<link to="IMachine::snapshotFolder"/>).
6680
6681	<note>
6682	It's a caller's responsibility to make sure the given saved state
6683	file is compatible with the settings of this virtual machine that
6684	represent its virtual hardware (memory size, storage disk configuration
6685	etc.). If there is a mismatch, the behavior of the virtual machine
6686	is undefined.
6687	</note>
6688	<result name="VBOX_E_INVALID_VM_STATE">
6689	Virtual machine state neither PoweredOff nor Aborted.
6690	</result>
6691	</desc>
6692	<param name="savedStateFile" type="wstring" dir="in">
6693	<desc>Path to the saved state file to adopt.</desc>
6694	</param>
6695	</method>
6696
6697	<method name="discardSavedState">
6698	<desc>
6699	Forcibly resets the machine to "Powered Off" state if it is
6700	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6701	Next time the machine is powered up, a clean boot will occur.
6702	<note>
6703	This operation is equivalent to resetting or powering off
6704	the machine without doing a proper shutdown of the guest
6705	operating system; as with resetting a running phyiscal
6706	computer, it can can lead to data loss.
6707	</note>
6708	If @a fRemoveFile is @c true, the file in the machine directory
6709	into which the machine state was saved is also deleted. If
6710	this is @c false, then the state can be recovered and later
6711	re-inserted into a machine using <link to="#adoptSavedState" />.
6712	The location of the file can be found in the
6713	<link to="IMachine::stateFilePath" /> attribute.
6714	<result name="VBOX_E_INVALID_VM_STATE">
6715	Virtual machine not in state Saved.
6716	</result>
6717	</desc>
6718	<param name="fRemoveFile" type="boolean" dir="in" >
6719	<desc>Whether to also remove the saved state file.</desc>
6720	</param>
6721	</method>
6722
6723	<method name="getDeviceActivity">
6724	<desc>
6725	Gets the current activity type of a given device or device group.
6726	<result name="E_INVALIDARG">
6727	Invalid device type.
6728	</result>
6729	</desc>
6730	<param name="type" type="DeviceType" dir="in"/>
6731	<param name="activity" type="DeviceActivity" dir="return"/>
6732	</method>
6733
6734	<method name="attachUSBDevice">
6735	<desc>
6736	Attaches a host USB device with the given UUID to the
6737	USB controller of the virtual machine.
6738
6739	The device needs to be in one of the following states:
6740	<link to="USBDeviceState_Busy"/>,
6741	<link to="USBDeviceState_Available"/> or
6742	<link to="USBDeviceState_Held"/>,
6743	otherwise an error is immediately returned.
6744
6745	When the device state is
6746	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6747	be returned if the host computer refuses to release it for some reason.
6748
6749	<see><link to="IUSBController::deviceFilters"/>,
6750	<link to="USBDeviceState"/></see>
6751	<result name="VBOX_E_INVALID_VM_STATE">
6752	Virtual machine state neither Running nor Paused.
6753	</result>
6754	<result name="VBOX_E_PDM_ERROR">
6755	Virtual machine does not have a USB controller.
6756	</result>
6757	</desc>
6758	<param name="id" type="uuid" mod="string" dir="in">
6759	<desc>UUID of the host USB device to attach.</desc>
6760	</param>
6761	</method>
6762
6763	<method name="detachUSBDevice">
6764	<desc>
6765	Detaches an USB device with the given UUID from the USB controller
6766	of the virtual machine.
6767
6768	After this method succeeds, the VirtualBox server re-initiates
6769	all USB filters as if the device were just physically attached
6770	to the host, but filters of this machine are ignored to avoid
6771	a possible automatic re-attachment.
6772
6773	<see><link to="IUSBController::deviceFilters"/>,
6774	<link to="USBDeviceState"/></see>
6775
6776	<result name="VBOX_E_PDM_ERROR">
6777	Virtual machine does not have a USB controller.
6778	</result>
6779	<result name="E_INVALIDARG">
6780	USB device not attached to this virtual machine.
6781	</result>
6782	</desc>
6783	<param name="id" type="uuid" mod="string" dir="in">
6784	<desc>UUID of the USB device to detach.</desc>
6785	</param>
6786	<param name="device" type="IUSBDevice" dir="return">
6787	<desc>Detached USB device.</desc>
6788	</param>
6789	</method>
6790
6791	<method name="findUSBDeviceByAddress">
6792	<desc>
6793	Searches for a USB device with the given host address.
6794
6795	<result name="VBOX_E_OBJECT_NOT_FOUND">
6796	Given @c name does not correspond to any USB device.
6797	</result>
6798
6799	<see><link to="IUSBDevice::address"/></see>
6800	</desc>
6801	<param name="name" type="wstring" dir="in">
6802	<desc>
6803	Address of the USB device (as assigned by the host) to
6804	search for.
6805	</desc>
6806	</param>
6807	<param name="device" type="IUSBDevice" dir="return">
6808	<desc>Found USB device object.</desc>
6809	</param>
6810	</method>
6811
6812	<method name="findUSBDeviceById">
6813	<desc>
6814	Searches for a USB device with the given UUID.
6815
6816	<result name="VBOX_E_OBJECT_NOT_FOUND">
6817	Given @c id does not correspond to any USB device.
6818	</result>
6819
6820	<see><link to="IUSBDevice::id"/></see>
6821	</desc>
6822	<param name="id" type="uuid" mod="string" dir="in">
6823	<desc>UUID of the USB device to search for.</desc>
6824	</param>
6825	<param name="device" type="IUSBDevice" dir="return">
6826	<desc>Found USB device object.</desc>
6827	</param>
6828	</method>
6829
6830	<method name="createSharedFolder">
6831	<desc>
6832	Creates a transient new shared folder by associating the given logical
6833	name with the given host path, adds it to the collection of shared
6834	folders and starts sharing it. Refer to the description of
6835	<link to="ISharedFolder"/> to read more about logical names.
6836
6837	<result name="VBOX_E_INVALID_VM_STATE">
6838	Virtual machine in Saved state or currently changing state.
6839	</result>
6840	<result name="VBOX_E_FILE_ERROR">
6841	Shared folder already exists or not accessible.
6842	</result>
6843	</desc>
6844	<param name="name" type="wstring" dir="in">
6845	<desc>Unique logical name of the shared folder.</desc>
6846	</param>
6847	<param name="hostPath" type="wstring" dir="in">
6848	<desc>Full path to the shared folder in the host file system.</desc>
6849	</param>
6850	<param name="writable" type="boolean" dir="in">
6851	<desc>Whether the share is writable or readonly</desc>
6852	</param>
6853	<param name="automount" type="boolean" dir="in">
6854	<desc>Whether the share gets automatically mounted by the guest
6855	or not.</desc>
6856	</param>
6857	</method>
6858
6859	<method name="removeSharedFolder">
6860	<desc>
6861	Removes a transient shared folder with the given name previously
6862	created by <link to="#createSharedFolder"/> from the collection of
6863	shared folders and stops sharing it.
6864	<result name="VBOX_E_INVALID_VM_STATE">
6865	Virtual machine in Saved state or currently changing state.
6866	</result>
6867	<result name="VBOX_E_FILE_ERROR">
6868	Shared folder does not exists.
6869	</result>
6870	</desc>
6871	<param name="name" type="wstring" dir="in">
6872	<desc>Logical name of the shared folder to remove.</desc>
6873	</param>
6874	</method>
6875
6876	<method name="takeSnapshot">
6877	<desc>
6878	Saves the current execution state
6879	and all settings of the machine and creates differencing images
6880	for all normal (non-independent) media.
6881	See <link to="ISnapshot" /> for an introduction to snapshots.
6882
6883	This method can be called for a PoweredOff, Saved (see
6884	<link to="#saveState"/>), Running or
6885	Paused virtual machine. When the machine is PoweredOff, an
6886	offline snapshot is created. When the machine is Running a live
6887	snapshot is created, and an online snapshot is is created when Paused.
6888
6889	The taken snapshot is always based on the
6890	<link to="IMachine::currentSnapshot">current snapshot</link>
6891	of the associated virtual machine and becomes a new current snapshot.
6892
6893	<note>
6894	This method implicitly calls <link to="IMachine::saveSettings"/> to
6895	save all current machine settings before taking an offline snapshot.
6896	</note>
6897
6898	<result name="VBOX_E_INVALID_VM_STATE">
6899	Virtual machine currently changing state.
6900	</result>
6901	</desc>
6902	<param name="name" type="wstring" dir="in">
6903	<desc>Short name for the snapshot.</desc>
6904	</param>
6905	<param name="description" type="wstring" dir="in">
6906	<desc>Optional description of the snapshot.</desc>
6907	</param>
6908	<param name="progress" type="IProgress" dir="return">
6909	<desc>Progress object to track the operation completion.</desc>
6910	</param>
6911	</method>
6912
6913	<method name="deleteSnapshot">
6914	<desc>
6915	Starts deleting the specified snapshot asynchronously.
6916	See <link to="ISnapshot" /> for an introduction to snapshots.
6917
6918	The execution state and settings of the associated machine stored in
6919	the snapshot will be deleted. The contents of all differencing media of
6920	this snapshot will be merged with the contents of their dependent child
6921	media to keep the medium chain valid (in other words, all changes
6922	represented by media being deleted will be propagated to their child
6923	medium). After that, this snapshot's differencing medium will be
6924	deleted. The parent of this snapshot will become a new parent for all
6925	its child snapshots.
6926
6927	If the deleted snapshot is the current one, its parent snapshot will
6928	become a new current snapshot. The current machine state is not directly
6929	affected in this case, except that currently attached differencing
6930	media based on media of the deleted snapshot will be also merged as
6931	described above.
6932
6933	If the deleted snapshot is the first or current snapshot, then the
6934	respective IMachine attributes will be adjusted. Deleting the current
6935	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6936	to make all current machine settings permanent.
6937
6938	Deleting a snapshot has the following preconditions:
6939
6940	<ul>
6941	<li>Child media of all normal media of the deleted snapshot
6942	must be accessible (see <link to="IMedium::state"/>) for this
6943	operation to succeed. If only one running VM refers to all images
6944	which participates in merging the operation can be performed while
6945	the VM is running. Otherwise all virtual machines whose media are
6946	directly or indirectly based on the media of deleted snapshot must
6947	be powered off. In any case, online snapshot deleting usually is
6948	slower than the same operation without any running VM.</li>
6949
6950	<li>You cannot delete the snapshot if a medium attached to it has
6951	more than one child medium (differencing images) because otherwise
6952	merging would be impossible. This might be the case if there is
6953	more than one child snapshot or differencing images were created
6954	for other reason (e.g. implicitly because of multiple machine
6955	attachments).</li>
6956	</ul>
6957
6958	The virtual machine's <link to="IMachine::state">state</link> is
6959	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6960	"DeletingSnapshotPaused" while this operation is in progress.
6961
6962	<note>
6963	Merging medium contents can be very time and disk space
6964	consuming, if these media are big in size and have many
6965	children. However, if the snapshot being deleted is the last
6966	(head) snapshot on the branch, the operation will be rather
6967	quick.
6968	</note>
6969	<result name="VBOX_E_INVALID_VM_STATE">
6970	The running virtual machine prevents deleting this snapshot. This
6971	happens only in very specific situations, usually snapshots can be
6972	deleted without trouble while a VM is running. The error message
6973	text explains the reason for the failure.
6974	</result>
6975	</desc>
6976	<param name="id" type="uuid" mod="string" dir="in">
6977	<desc>UUID of the snapshot to delete.</desc>
6978	</param>
6979	<param name="progress" type="IProgress" dir="return">
6980	<desc>Progress object to track the operation completion.</desc>
6981	</param>
6982	</method>
6983
6984	<method name="deleteSnapshotAndAllChildren">
6985	<desc>
6986	Starts deleting the specified snapshot and all its children
6987	asynchronously. See <link to="ISnapshot" /> for an introduction to
6988	snapshots. The conditions and many details are the same as with
6989	<link to="#deleteSnapshot"/>.
6990
6991	This operation is very fast if the snapshot subtree does not include
6992	the current state. It is still significantly faster than deleting the
6993	snapshots one by one if the current state is in the subtree and there
6994	are more than one snapshots from current state to the snapshot which
6995	marks the subtree, since it eliminates the incremental image merging.
6996
6997	<note>This API method is right now not implemented!</note>
6998
6999	<result name="VBOX_E_INVALID_VM_STATE">
7000	The running virtual machine prevents deleting this snapshot. This
7001	happens only in very specific situations, usually snapshots can be
7002	deleted without trouble while a VM is running. The error message
7003	text explains the reason for the failure.
7004	</result>
7005	<result name="E_NOTIMPL">
7006	The method is not implemented yet.
7007	</result>
7008	</desc>
7009	<param name="id" type="uuid" mod="string" dir="in">
7010	<desc>UUID of the snapshot to delete, including all its children.</desc>
7011	</param>
7012	<param name="progress" type="IProgress" dir="return">
7013	<desc>Progress object to track the operation completion.</desc>
7014	</param>
7015	</method>
7016
7017	<method name="deleteSnapshotRange">
7018	<desc>
7019	Starts deleting the specified snapshot range. This is limited to
7020	linear snapshot lists, which means there may not be any other child
7021	snapshots other than the direct sequence between the start and end
7022	snapshot. If the start and end snapshot point to the same snapshot this
7023	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7024	<link to="ISnapshot" /> for an introduction to snapshots. The
7025	conditions and many details are the same as with
7026	<link to="#deleteSnapshot"/>.
7027
7028	This operation is generally faster than deleting snapshots one by one
7029	and often also needs less extra disk space before freeing up disk space
7030	by deleting the removed disk images corresponding to the snapshot.
7031
7032	<note>This API method is right now not implemented!</note>
7033
7034	<result name="VBOX_E_INVALID_VM_STATE">
7035	The running virtual machine prevents deleting this snapshot. This
7036	happens only in very specific situations, usually snapshots can be
7037	deleted without trouble while a VM is running. The error message
7038	text explains the reason for the failure.
7039	</result>
7040	<result name="E_NOTIMPL">
7041	The method is not implemented yet.
7042	</result>
7043	</desc>
7044	<param name="startId" type="uuid" mod="string" dir="in">
7045	<desc>UUID of the first snapshot to delete.</desc>
7046	</param>
7047	<param name="endId" type="uuid" mod="string" dir="in">
7048	<desc>UUID of the last snapshot to delete.</desc>
7049	</param>
7050	<param name="progress" type="IProgress" dir="return">
7051	<desc>Progress object to track the operation completion.</desc>
7052	</param>
7053	</method>
7054
7055	<method name="restoreSnapshot">
7056	<desc>
7057	Starts resetting the machine's current state to the state contained
7058	in the given snapshot, asynchronously. All current settings of the
7059	machine will be reset and changes stored in differencing media
7060	will be lost.
7061	See <link to="ISnapshot" /> for an introduction to snapshots.
7062
7063	After this operation is successfully completed, new empty differencing
7064	media are created for all normal media of the machine.
7065
7066	If the given snapshot is an online snapshot, the machine will go to
7067	the <link to="MachineState_Saved"> saved state</link>, so that the
7068	next time it is powered on, the execution state will be restored
7069	from the state of the snapshot.
7070
7071	<note>
7072	The machine must not be running, otherwise the operation will fail.
7073	</note>
7074
7075	<note>
7076	If the machine state is <link to="MachineState_Saved">Saved</link>
7077	prior to this operation, the saved state file will be implicitly
7078	deleted (as if <link to="IConsole::discardSavedState"/> were
7079	called).
7080	</note>
7081
7082	<result name="VBOX_E_INVALID_VM_STATE">
7083	Virtual machine is running.
7084	</result>
7085	</desc>
7086	<param name="snapshot" type="ISnapshot" dir="in">
7087	<desc>The snapshot to restore the VM state from.</desc>
7088	</param>
7089	<param name="progress" type="IProgress" dir="return">
7090	<desc>Progress object to track the operation completion.</desc>
7091	</param>
7092	</method>
7093
7094	<method name="teleport">
7095	<desc>
7096	Teleport the VM to a different host machine or process.
7097
7098	TODO explain the details.
7099
7100	<result name="VBOX_E_INVALID_VM_STATE">
7101	Virtual machine not running or paused.
7102	</result>
7103	</desc>
7104	<param name="hostname" type="wstring" dir="in">
7105	<desc>The name or IP of the host to teleport to.</desc>
7106	</param>
7107	<param name="tcpport" type="unsigned long" dir="in">
7108	<desc>The TCP port to connect to (1..65535).</desc>
7109	</param>
7110	<param name="password" type="wstring" dir="in">
7111	<desc>The password.</desc>
7112	</param>
7113	<param name="maxDowntime" type="unsigned long" dir="in">
7114	<desc>
7115	The maximum allowed downtime given as milliseconds. 0 is not a valid
7116	value. Recommended value: 250 ms.
7117
7118	The higher the value is, the greater the chance for a successful
7119	teleportation. A small value may easily result in the teleportation
7120	process taking hours and eventually fail.
7121
7122	<note>
7123	The current implementation treats this a guideline, not as an
7124	absolute rule.
7125	</note>
7126	</desc>
7127	</param>
7128	<param name="progress" type="IProgress" dir="return">
7129	<desc>Progress object to track the operation completion.</desc>
7130	</param>
7131	</method>
7132
7133	</interface>
7134
7135	<!--
7136	// IHost
7137	/////////////////////////////////////////////////////////////////////////
7138	-->
7139
7140	<enum
7141	name="HostNetworkInterfaceMediumType"
7142	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7143	>
7144	<desc>
7145	Type of encapsulation. Ethernet encapsulation includes both wired and
7146	wireless Ethernet connections.
7147	<see><link to="IHostNetworkInterface"/></see>
7148	</desc>
7149
7150	<const name="Unknown" value="0">
7151	<desc>
7152	The type of interface cannot be determined.
7153	</desc>
7154	</const>
7155	<const name="Ethernet" value="1">
7156	<desc>
7157	Ethernet frame encapsulation.
7158	</desc>
7159	</const>
7160	<const name="PPP" value="2">
7161	<desc>
7162	Point-to-point protocol encapsulation.
7163	</desc>
7164	</const>
7165	<const name="SLIP" value="3">
7166	<desc>
7167	Serial line IP encapsulation.
7168	</desc>
7169	</const>
7170	</enum>
7171
7172	<enum
7173	name="HostNetworkInterfaceStatus"
7174	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7175	>
7176	<desc>
7177	Current status of the interface.
7178	<see><link to="IHostNetworkInterface"/></see>
7179	</desc>
7180
7181	<const name="Unknown" value="0">
7182	<desc>
7183	The state of interface cannot be determined.
7184	</desc>
7185	</const>
7186	<const name="Up" value="1">
7187	<desc>
7188	The interface is fully operational.
7189	</desc>
7190	</const>
7191	<const name="Down" value="2">
7192	<desc>
7193	The interface is not functioning.
7194	</desc>
7195	</const>
7196	</enum>
7197
7198	<enum
7199	name="HostNetworkInterfaceType"
7200	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7201	>
7202	<desc>
7203	Network interface type.
7204	</desc>
7205	<const name="Bridged" value="1"/>
7206	<const name="HostOnly" value="2"/>
7207	</enum>
7208
7209	<interface
7210	name="IHostNetworkInterface" extends="$unknown"
7211	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7212	wsmap="managed"
7213	>
7214	<desc>
7215	Represents one of host's network interfaces. IP V6 address and network
7216	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7217	separated by colons.
7218	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7219	</desc>
7220	<attribute name="name" type="wstring" readonly="yes">
7221	<desc>Returns the host network interface name.</desc>
7222	</attribute>
7223
7224	<attribute name="id" type="uuid" mod="string" readonly="yes">
7225	<desc>Returns the interface UUID.</desc>
7226	</attribute>
7227
7228	<attribute name="networkName" type="wstring" readonly="yes">
7229	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7230	</attribute>
7231
7232	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7233	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7234	</attribute>
7235
7236	<attribute name="IPAddress" type="wstring" readonly="yes">
7237	<desc>Returns the IP V4 address of the interface.</desc>
7238	</attribute>
7239
7240	<attribute name="networkMask" type="wstring" readonly="yes">
7241	<desc>Returns the network mask of the interface.</desc>
7242	</attribute>
7243
7244	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7245	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7246	</attribute>
7247
7248	<attribute name="IPV6Address" type="wstring" readonly="yes">
7249	<desc>Returns the IP V6 address of the interface.</desc>
7250	</attribute>
7251
7252	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7253	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7254	</attribute>
7255
7256	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7257	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7258	</attribute>
7259
7260	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7261	<desc>Type of protocol encapsulation used.</desc>
7262	</attribute>
7263
7264	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7265	<desc>Status of the interface.</desc>
7266	</attribute>
7267
7268	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7269	<desc>specifies the host interface type.</desc>
7270	</attribute>
7271
7272	<method name="enableStaticIpConfig">
7273	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7274	<param name="IPAddress" type="wstring" dir="in">
7275	<desc>
7276	IP address.
7277	</desc>
7278	</param>
7279	<param name="networkMask" type="wstring" dir="in">
7280	<desc>
7281	network mask.
7282	</desc>
7283	</param>
7284	</method>
7285
7286	<method name="enableStaticIpConfigV6">
7287	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7288	<param name="IPV6Address" type="wstring" dir="in">
7289	<desc>
7290	IP address.
7291	</desc>
7292	</param>
7293	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7294	<desc>
7295	network mask.
7296	</desc>
7297	</param>
7298	</method>
7299
7300	<method name="enableDynamicIpConfig">
7301	<desc>enables the dynamic IP configuration.</desc>
7302	</method>
7303
7304	<method name="dhcpRediscover">
7305	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7306	</method>
7307
7308	</interface>
7309
7310	<interface
7311	name="IHost" extends="$unknown"
7312	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7313	wsmap="managed"
7314	>
7315	<desc>
7316	The IHost interface represents the physical machine that this VirtualBox
7317	installation runs on.
7318
7319	An object implementing this interface is returned by the
7320	<link to="IVirtualBox::host" /> attribute. This interface contains
7321	read-only information about the host's physical hardware (such as what
7322	processors and disks are available, what the host operating system is,
7323	and so on) and also allows for manipulating some of the host's hardware,
7324	such as global USB device filters and host interface networking.
7325
7326	</desc>
7327	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7328	<desc>List of DVD drives available on the host.</desc>
7329	</attribute>
7330
7331	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7332	<desc>List of floppy drives available on the host.</desc>
7333	</attribute>
7334
7335	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7336	<desc>
7337	List of USB devices currently attached to the host.
7338	Once a new device is physically attached to the host computer,
7339	it appears in this list and remains there until detached.
7340
7341	<note>
7342	If USB functionality is not available in the given edition of
7343	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7344	</note>
7345	</desc>
7346	</attribute>
7347
7348	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7349	<desc>
7350	List of USB device filters in action.
7351	When a new device is physically attached to the host computer,
7352	filters from this list are applied to it (in order they are stored
7353	in the list). The first matched filter will determine the
7354	<link to="IHostUSBDeviceFilter::action">action</link>
7355	performed on the device.
7356
7357	Unless the device is ignored by these filters, filters of all
7358	currently running virtual machines
7359	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7360
7361	<note>
7362	If USB functionality is not available in the given edition of
7363	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7364	</note>
7365
7366	<see><link to="IHostUSBDeviceFilter"/>,
7367	<link to="USBDeviceState"/></see>
7368	</desc>
7369	</attribute>
7370
7371	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7372	<desc>List of host network interfaces currently defined on the host.</desc>
7373	</attribute>
7374
7375	<attribute name="processorCount" type="unsigned long" readonly="yes">
7376	<desc>Number of (logical) CPUs installed in the host system.</desc>
7377	</attribute>
7378
7379	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7380	<desc>Number of (logical) CPUs online in the host system.</desc>
7381	</attribute>
7382
7383	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7384	<desc>Number of physical processor cores installed in the host system.</desc>
7385	</attribute>
7386
7387	<method name="getProcessorSpeed">
7388	<desc>Query the (approximate) maximum speed of a specified host CPU in
7389	Megahertz.
7390	</desc>
7391	<param name="cpuId" type="unsigned long" dir="in">
7392	<desc>
7393	Identifier of the CPU.
7394	</desc>
7395	</param>
7396	<param name="speed" type="unsigned long" dir="return">
7397	<desc>
7398	Speed value. 0 is returned if value is not known or @a cpuId is
7399	invalid.
7400	</desc>
7401	</param>
7402	</method>
7403
7404	<method name="getProcessorFeature">
7405	<desc>Query whether a CPU feature is supported or not.</desc>
7406	<param name="feature" type="ProcessorFeature" dir="in">
7407	<desc>
7408	CPU Feature identifier.
7409	</desc>
7410	</param>
7411	<param name="supported" type="boolean" dir="return">
7412	<desc>
7413	Feature is supported or not.
7414	</desc>
7415	</param>
7416	</method>
7417
7418	<method name="getProcessorDescription">
7419	<desc>Query the model string of a specified host CPU.
7420	</desc>
7421	<param name="cpuId" type="unsigned long" dir="in">
7422	<desc>
7423	Identifier of the CPU.
7424	<note>
7425	The current implementation might not necessarily return the
7426	description for this exact CPU.
7427	</note>
7428	</desc>
7429	</param>
7430	<param name="description" type="wstring" dir="return">
7431	<desc>
7432	Model string. An empty string is returned if value is not known or
7433	@a cpuId is invalid.
7434	</desc>
7435	</param>
7436	</method>
7437
7438	<method name="getProcessorCPUIDLeaf">
7439	<desc>
7440	Returns the CPU cpuid information for the specified leaf.
7441	</desc>
7442	<param name="cpuId" type="unsigned long" dir="in">
7443	<desc>
7444	Identifier of the CPU. The CPU most be online.
7445	<note>
7446	The current implementation might not necessarily return the
7447	description for this exact CPU.
7448	</note>
7449	</desc>
7450	</param>
7451	<param name="leaf" type="unsigned long" dir="in">
7452	<desc>
7453	CPUID leaf index (eax).
7454	</desc>
7455	</param>
7456	<param name="subLeaf" type="unsigned long" dir="in">
7457	<desc>
7458	CPUID leaf sub index (ecx). This currently only applies to cache
7459	information on Intel CPUs. Use 0 if retrieving values for
7460	<link to="IMachine::setCPUIDLeaf"/>.
7461	</desc>
7462	</param>
7463	<param name="valEax" type="unsigned long" dir="out">
7464	<desc>
7465	CPUID leaf value for register eax.
7466	</desc>
7467	</param>
7468	<param name="valEbx" type="unsigned long" dir="out">
7469	<desc>
7470	CPUID leaf value for register ebx.
7471	</desc>
7472	</param>
7473	<param name="valEcx" type="unsigned long" dir="out">
7474	<desc>
7475	CPUID leaf value for register ecx.
7476	</desc>
7477	</param>
7478	<param name="valEdx" type="unsigned long" dir="out">
7479	<desc>
7480	CPUID leaf value for register edx.
7481	</desc>
7482	</param>
7483	</method>
7484
7485	<attribute name="memorySize" type="unsigned long" readonly="yes">
7486	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7487	</attribute>
7488
7489	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7490	<desc>Available system memory in the host system.</desc>
7491	</attribute>
7492
7493	<attribute name="operatingSystem" type="wstring" readonly="yes">
7494	<desc>Name of the host system's operating system.</desc>
7495	</attribute>
7496
7497	<attribute name="OSVersion" type="wstring" readonly="yes">
7498	<desc>Host operating system's version string.</desc>
7499	</attribute>
7500
7501	<attribute name="UTCTime" type="long long" readonly="yes">
7502	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7503	</attribute>
7504
7505	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7506	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7507	</attribute>
7508
7509	<method name="createHostOnlyNetworkInterface">
7510	<desc>
7511	Creates a new adapter for Host Only Networking.
7512	<result name="E_INVALIDARG">
7513	Host network interface @a name already exists.
7514	</result>
7515	</desc>
7516	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7517	<desc>
7518	Created host interface object.
7519	</desc>
7520	</param>
7521	<param name="progress" type="IProgress" dir="return">
7522	<desc>
7523	Progress object to track the operation completion.
7524	</desc>
7525	</param>
7526	</method>
7527
7528	<method name="removeHostOnlyNetworkInterface">
7529	<desc>
7530	Removes the given Host Only Networking interface.
7531	<result name="VBOX_E_OBJECT_NOT_FOUND">
7532	No host network interface matching @a id found.
7533	</result>
7534	</desc>
7535	<param name="id" type="uuid" mod="string" dir="in">
7536	<desc>
7537	Adapter GUID.
7538	</desc>
7539	</param>
7540	<param name="progress" type="IProgress" dir="return">
7541	<desc>
7542	Progress object to track the operation completion.
7543	</desc>
7544	</param>
7545	</method>
7546
7547	<method name="createUSBDeviceFilter">
7548	<desc>
7549	Creates a new USB device filter. All attributes except
7550	the filter name are set to empty (any match),
7551	<i>active</i> is @c false (the filter is not active).
7552
7553	The created filter can be added to the list of filters using
7554	<link to="#insertUSBDeviceFilter"/>.
7555
7556	<see><link to="#USBDeviceFilters"/></see>
7557	</desc>
7558	<param name="name" type="wstring" dir="in">
7559	<desc>
7560	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7561	</desc>
7562	</param>
7563	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7564	<desc>Created filter object.</desc>
7565	</param>
7566	</method>
7567
7568	<method name="insertUSBDeviceFilter">
7569	<desc>
7570	Inserts the given USB device to the specified position
7571	in the list of filters.
7572
7573	Positions are numbered starting from @c 0. If the specified
7574	position is equal to or greater than the number of elements in
7575	the list, the filter is added at the end of the collection.
7576
7577	<note>
7578	Duplicates are not allowed, so an attempt to insert a
7579	filter already in the list is an error.
7580	</note>
7581	<note>
7582	If USB functionality is not available in the given edition of
7583	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7584	</note>
7585
7586	<see><link to="#USBDeviceFilters"/></see>
7587
7588	<result name="VBOX_E_INVALID_OBJECT_STATE">
7589	USB device filter is not created within this VirtualBox instance.
7590	</result>
7591	<result name="E_INVALIDARG">
7592	USB device filter already in list.
7593	</result>
7594
7595	</desc>
7596	<param name="position" type="unsigned long" dir="in">
7597	<desc>Position to insert the filter to.</desc>
7598	</param>
7599	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7600	<desc>USB device filter to insert.</desc>
7601	</param>
7602	</method>
7603
7604	<method name="removeUSBDeviceFilter">
7605	<desc>
7606	Removes a USB device filter from the specified position in the
7607	list of filters.
7608
7609	Positions are numbered starting from @c 0. Specifying a
7610	position equal to or greater than the number of elements in
7611	the list will produce an error.
7612
7613	<note>
7614	If USB functionality is not available in the given edition of
7615	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7616	</note>
7617
7618	<see><link to="#USBDeviceFilters"/></see>
7619
7620	<result name="E_INVALIDARG">
7621	USB device filter list empty or invalid @a position.
7622	</result>
7623
7624	</desc>
7625	<param name="position" type="unsigned long" dir="in">
7626	<desc>Position to remove the filter from.</desc>
7627	</param>
7628	</method>
7629
7630	<method name="findHostDVDDrive">
7631	<desc>
7632	Searches for a host DVD drive with the given @c name.
7633
7634	<result name="VBOX_E_OBJECT_NOT_FOUND">
7635	Given @c name does not correspond to any host drive.
7636	</result>
7637
7638	</desc>
7639	<param name="name" type="wstring" dir="in">
7640	<desc>Name of the host drive to search for</desc>
7641	</param>
7642	<param name="drive" type="IMedium" dir="return">
7643	<desc>Found host drive object</desc>
7644	</param>
7645	</method>
7646
7647	<method name="findHostFloppyDrive">
7648	<desc>
7649	Searches for a host floppy drive with the given @c name.
7650
7651	<result name="VBOX_E_OBJECT_NOT_FOUND">
7652	Given @c name does not correspond to any host floppy drive.
7653	</result>
7654
7655	</desc>
7656	<param name="name" type="wstring" dir="in">
7657	<desc>Name of the host floppy drive to search for</desc>
7658	</param>
7659	<param name="drive" type="IMedium" dir="return">
7660	<desc>Found host floppy drive object</desc>
7661	</param>
7662	</method>
7663
7664	<method name="findHostNetworkInterfaceByName">
7665	<desc>
7666	Searches through all host network interfaces for an interface with
7667	the given @c name.
7668	<note>
7669	The method returns an error if the given @c name does not
7670	correspond to any host network interface.
7671	</note>
7672	</desc>
7673	<param name="name" type="wstring" dir="in">
7674	<desc>Name of the host network interface to search for.</desc>
7675	</param>
7676	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7677	<desc>Found host network interface object.</desc>
7678	</param>
7679	</method>
7680	<method name="findHostNetworkInterfaceById">
7681	<desc>
7682	Searches through all host network interfaces for an interface with
7683	the given GUID.
7684	<note>
7685	The method returns an error if the given GUID does not
7686	correspond to any host network interface.
7687	</note>
7688	</desc>
7689	<param name="id" type="uuid" mod="string" dir="in">
7690	<desc>GUID of the host network interface to search for.</desc>
7691	</param>
7692	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7693	<desc>Found host network interface object.</desc>
7694	</param>
7695	</method>
7696	<method name="findHostNetworkInterfacesOfType">
7697	<desc>
7698	Searches through all host network interfaces and returns a list of interfaces of the specified type
7699	</desc>
7700	<param name="type" type="HostNetworkInterfaceType" dir="in">
7701	<desc>type of the host network interfaces to search for.</desc>
7702	</param>
7703	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7704	<desc>Found host network interface objects.</desc>
7705	</param>
7706	</method>
7707
7708	<method name="findUSBDeviceById">
7709	<desc>
7710	Searches for a USB device with the given UUID.
7711
7712	<result name="VBOX_E_OBJECT_NOT_FOUND">
7713	Given @c id does not correspond to any USB device.
7714	</result>
7715
7716	<see><link to="IUSBDevice::id"/></see>
7717	</desc>
7718	<param name="id" type="uuid" mod="string" dir="in">
7719	<desc>UUID of the USB device to search for.</desc>
7720	</param>
7721	<param name="device" type="IHostUSBDevice" dir="return">
7722	<desc>Found USB device object.</desc>
7723	</param>
7724	</method>
7725
7726	<method name="findUSBDeviceByAddress">
7727	<desc>
7728	Searches for a USB device with the given host address.
7729
7730	<result name="VBOX_E_OBJECT_NOT_FOUND">
7731	Given @c name does not correspond to any USB device.
7732	</result>
7733
7734	<see><link to="IUSBDevice::address"/></see>
7735	</desc>
7736	<param name="name" type="wstring" dir="in">
7737	<desc>
7738	Address of the USB device (as assigned by the host) to
7739	search for.
7740	</desc>
7741	</param>
7742	<param name="device" type="IHostUSBDevice" dir="return">
7743	<desc>Found USB device object.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="generateMACAddress">
7748	<desc>
7749	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7750	</desc>
7751	<param name="address" type="wstring" dir="return">
7752	<desc>New Ethernet MAC address.</desc>
7753	</param>
7754	</method>
7755
7756	</interface>
7757
7758	<!--
7759	// ISystemProperties
7760	/////////////////////////////////////////////////////////////////////////
7761	-->
7762
7763	<interface
7764	name="ISystemProperties"
7765	extends="$unknown"
7766	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7767	wsmap="managed"
7768	>
7769	<desc>
7770	The ISystemProperties interface represents global properties of the given
7771	VirtualBox installation.
7772
7773	These properties define limits and default values for various attributes
7774	and parameters. Most of the properties are read-only, but some can be
7775	changed by a user.
7776	</desc>
7777
7778	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7779	<desc>Minimum guest system memory in Megabytes.</desc>
7780	</attribute>
7781
7782	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7783	<desc>Maximum guest system memory in Megabytes.</desc>
7784	</attribute>
7785
7786	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7787	<desc>Minimum guest video memory in Megabytes.</desc>
7788	</attribute>
7789
7790	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7791	<desc>Maximum guest video memory in Megabytes.</desc>
7792	</attribute>
7793
7794	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7795	<desc>Minimum CPU count.</desc>
7796	</attribute>
7797
7798	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7799	<desc>Maximum CPU count.</desc>
7800	</attribute>
7801
7802	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7803	<desc>Maximum of monitors which could be connected.</desc>
7804	</attribute>
7805
7806	<attribute name="infoVDSize" type="long long" readonly="yes">
7807	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7808	does not reflect the limits of any virtual disk image format.</desc>
7809	</attribute>
7810
7811	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7812	<desc>
7813	Maximum number of serial ports associated with every
7814	<link to="IMachine"/> instance.
7815	</desc>
7816	</attribute>
7817
7818	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7819	<desc>
7820	Maximum number of parallel ports associated with every
7821	<link to="IMachine"/> instance.
7822	</desc>
7823	</attribute>
7824
7825	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7826	<desc>
7827	Maximum device position in the boot order. This value corresponds
7828	to the total number of devices a machine can boot from, to make it
7829	possible to include all possible devices to the boot list.
7830	<see><link to="IMachine::setBootOrder"/></see>
7831	</desc>
7832	</attribute>
7833
7834	<attribute name="defaultMachineFolder" type="wstring">
7835	<desc>
7836	Full path to the default directory used to create new or open
7837	existing machines when a machine settings file name contains no
7838	path.
7839
7840	Starting with VirtualBox 4.0, by default, this attribute contains
7841	the full path of folder named "VirtualBox VMs" in the user's
7842	home directory, which depends on the host platform.
7843
7844	When setting this attribute, a full path must be specified.
7845	Setting this property to @c null or an empty string or the
7846	special value "Machines" (for compatibility reasons) will restore
7847	that default value.
7848
7849	If the folder specified herein does not exist, it will be created
7850	automatically as needed.
7851
7852	<see>
7853	<link to="IVirtualBox::createMachine"/>,
7854	<link to="IVirtualBox::openMachine"/>
7855	</see>
7856	</desc>
7857	</attribute>
7858
7859	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7860	<desc>
7861	List of all medium storage formats supported by this VirtualBox
7862	installation.
7863
7864	Keep in mind that the medium format identifier
7865	(<link to="IMediumFormat::id"/>) used in other API calls like
7866	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7867	medium format is a case-insensitive string. This means that, for
7868	example, all of the following strings:
7869	<pre>
7870	"VDI"
7871	"vdi"
7872	"VdI"</pre>
7873	refer to the same medium format.
7874
7875	Note that the virtual medium framework is backend-based, therefore
7876	the list of supported formats depends on what backends are currently
7877	installed.
7878
7879	<see><link to="IMediumFormat"/></see>
7880	</desc>
7881	</attribute>
7882
7883	<attribute name="defaultHardDiskFormat" type="wstring">
7884	<desc>
7885	Identifier of the default medium format used by VirtualBox.
7886
7887	The medium format set by this attribute is used by VirtualBox
7888	when the medium format was not specified explicitly. One example is
7889	<link to="IVirtualBox::createHardDisk"/> with the empty
7890	format argument. A more complex example is implicit creation of
7891	differencing media when taking a snapshot of a virtual machine:
7892	this operation will try to use a format of the parent medium first
7893	and if this format does not support differencing media the default
7894	format specified by this argument will be used.
7895
7896	The list of supported medium formats may be obtained by the
7897	<link to="#mediumFormats"/> call. Note that the default medium
7898	format must have a capability to create differencing media;
7899	otherwise operations that create media implicitly may fail
7900	unexpectedly.
7901
7902	The initial value of this property is <tt>"VDI"</tt> in the current
7903	version of the VirtualBox product, but may change in the future.
7904
7905	<note>
7906	Setting this property to @c null or empty string will restore the
7907	initial value.
7908	</note>
7909
7910	<see>
7911	<link to="#mediumFormats"/>,
7912	<link to="IMediumFormat::id"/>,
7913	<link to="IVirtualBox::createHardDisk"/>
7914	</see>
7915	</desc>
7916	</attribute>
7917
7918	<attribute name="freeDiskSpaceWarning" type="long long">
7919	<desc>Issue a warning if the free disk space is below (or in some disk
7920	intensive operation is expected to go below) the given size in
7921	bytes.</desc>
7922	</attribute>
7923
7924	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7925	<desc>Issue a warning if the free disk space is below (or in some disk
7926	intensive operation is expected to go below) the given percentage.</desc>
7927	</attribute>
7928
7929	<attribute name="freeDiskSpaceError" type="long long">
7930	<desc>Issue an error if the free disk space is below (or in some disk
7931	intensive operation is expected to go below) the given size in
7932	bytes.</desc>
7933	</attribute>
7934
7935	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7936	<desc>Issue an error if the free disk space is below (or in some disk
7937	intensive operation is expected to go below) the given percentage.</desc>
7938	</attribute>
7939
7940	<attribute name="VRDEAuthLibrary" type="wstring">
7941	<desc>
7942	Library that provides authentication for Remote Desktop clients. The library
7943	is used if a virtual machine's authentication type is set to "external"
7944	in the VM RemoteDisplay configuration.
7945
7946	The system library extension (".DLL" or ".so") must be omitted.
7947	A full path can be specified; if not, then the library must reside on the
7948	system's default library path.
7949
7950	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7951	of that name in one of the default VirtualBox library directories.
7952
7953	For details about VirtualBox authentication libraries and how to implement
7954	them, please refer to the VirtualBox manual.
7955
7956	<note>
7957	Setting this property to @c null or empty string will restore the
7958	initial value.
7959	</note>
7960	</desc>
7961	</attribute>
7962
7963	<attribute name="webServiceAuthLibrary" type="wstring">
7964	<desc>
7965	Library that provides authentication for webservice clients. The library
7966	is used if a virtual machine's authentication type is set to "external"
7967	in the VM RemoteDisplay configuration and will be called from
7968	within the <link to="IWebsessionManager::logon" /> implementation.
7969
7970	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7971	there is no per-VM setting for this, as the webservice is a global
7972	resource (if it is running). Only for this setting (for the webservice),
7973	setting this value to a literal <tt>"null"</tt> string disables authentication,
7974	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7975	no matter what user name and password are supplied.
7976
7977	The initial value of this property is <tt>"VBoxAuth"</tt>,
7978	meaning that the webservice will use the same authentication
7979	library that is used by default for VRDE (again, see
7980	<link to="ISystemProperties::VRDEAuthLibrary" />).
7981	The format and calling convention of authentication libraries
7982	is the same for the webservice as it is for VRDE.
7983
7984	<note>
7985	Setting this property to @c null or empty string will restore the
7986	initial value.
7987	</note>
7988	</desc>
7989	</attribute>
7990
7991	<attribute name="defaultVRDEExtPack" type="wstring">
7992	<desc>
7993	The name of the extension pack providing the default VRDE.
7994
7995	This attribute is for choosing between multiple extension packs
7996	providing VRDE. If only one is installed, it will automatically be the
7997	default one. The attribute value can be empty if no VRDE extension
7998	pack is installed.
7999
8000	For details about VirtualBox Remote Desktop Extension and how to
8001	implement one, please refer to the VirtualBox SDK.
8002	</desc>
8003	</attribute>
8004
8005	<attribute name="logHistoryCount" type="unsigned long">
8006	<desc>
8007	This value specifies how many old release log files are kept.
8008	</desc>
8009	</attribute>
8010
8011	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8012	<desc>This value hold the default audio driver for the current
8013	system.</desc>
8014	</attribute>
8015
8016
8017	<method name="getMaxNetworkAdapters">
8018	<desc>
8019	Maximum total number of network adapters associated with every
8020	<link to="IMachine"/> instance.
8021	</desc>
8022
8023	<param name="chipset" type="ChipsetType" dir="in">
8024	<desc>The chipset type to get the value for.</desc>
8025	</param>
8026
8027
8028	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8029	<desc>The maximum total number of network adapters allowed.</desc>
8030	</param>
8031
8032	</method>
8033
8034	<method name="getMaxNetworkAdaptersOfType">
8035	<desc>
8036	Maximum number of network adapters of a given attachment type,
8037	associated with every <link to="IMachine"/> instance.
8038	</desc>
8039
8040	<param name="chipset" type="ChipsetType" dir="in">
8041	<desc>The chipset type to get the value for.</desc>
8042	</param>
8043
8044	<param name="type" type="NetworkAttachmentType" dir="in">
8045	<desc>Type of attachment.</desc>
8046	</param>
8047
8048	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8049	<desc>The maximum number of network adapters allowed for
8050	particular chipset and attachment type.</desc>
8051	</param>
8052
8053	</method>
8054
8055
8056	<method name="getMaxDevicesPerPortForStorageBus">
8057	<desc>Returns the maximum number of devices which can be attached to a port
8058	for the given storage bus.</desc>
8059
8060	<param name="bus" type="StorageBus" dir="in">
8061	<desc>The storage bus type to get the value for.</desc>
8062	</param>
8063
8064	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8065	<desc>The maximum number of devices which can be attached to the port for the given
8066	storage bus.</desc>
8067	</param>
8068	</method>
8069
8070	<method name="getMinPortCountForStorageBus">
8071	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8072
8073	<param name="bus" type="StorageBus" dir="in">
8074	<desc>The storage bus type to get the value for.</desc>
8075	</param>
8076
8077	<param name="minPortCount" type="unsigned long" dir="return">
8078	<desc>The minimum number of ports for the given storage bus.</desc>
8079	</param>
8080	</method>
8081
8082	<method name="getMaxPortCountForStorageBus">
8083	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8084
8085	<param name="bus" type="StorageBus" dir="in">
8086	<desc>The storage bus type to get the value for.</desc>
8087	</param>
8088
8089	<param name="maxPortCount" type="unsigned long" dir="return">
8090	<desc>The maximum number of ports for the given storage bus.</desc>
8091	</param>
8092	</method>
8093
8094	<method name="getMaxInstancesOfStorageBus">
8095	<desc>Returns the maximum number of storage bus instances which
8096	can be configured for each VM. This corresponds to the number of
8097	storage controllers one can have. Value may depend on chipset type
8098	used.</desc>
8099
8100	<param name="chipset" type="ChipsetType" dir="in">
8101	<desc>The chipset type to get the value for.</desc>
8102	</param>
8103
8104	<param name="bus" type="StorageBus" dir="in">
8105	<desc>The storage bus type to get the value for.</desc>
8106	</param>
8107
8108	<param name="maxInstances" type="unsigned long" dir="return">
8109	<desc>The maximum number of instances for the given storage bus.</desc>
8110	</param>
8111	</method>
8112
8113	<method name="getDeviceTypesForStorageBus">
8114	<desc>Returns list of all the supported device types
8115	(<link to="DeviceType"/>) for the given type of storage
8116	bus.</desc>
8117
8118	<param name="bus" type="StorageBus" dir="in">
8119	<desc>The storage bus type to get the value for.</desc>
8120	</param>
8121
8122	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8123	<desc>The list of all supported device types for the given storage bus.</desc>
8124	</param>
8125	</method>
8126
8127	<method name="getDefaultIoCacheSettingForStorageController">
8128	<desc>Returns the default I/O cache setting for the
8129	given storage controller</desc>
8130
8131	<param name="controllerType" type="StorageControllerType" dir="in">
8132	<desc>The storage controller to the setting for.</desc>
8133	</param>
8134
8135	<param name="enabled" type="boolean" dir="return">
8136	<desc>Returned flag indicating the default value</desc>
8137	</param>
8138	</method>
8139	</interface>
8140
8141	<!--
8142	// IGuest
8143	/////////////////////////////////////////////////////////////////////////
8144	-->
8145
8146	<interface
8147	name="IGuestOSType" extends="$unknown"
8148	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8149	wsmap="struct"
8150	>
8151	<desc>
8152	</desc>
8153
8154	<attribute name="familyId" type="wstring" readonly="yes">
8155	<desc>Guest OS family identifier string.</desc>
8156	</attribute>
8157
8158	<attribute name="familyDescription" type="wstring" readonly="yes">
8159	<desc>Human readable description of the guest OS family.</desc>
8160	</attribute>
8161
8162	<attribute name="id" type="wstring" readonly="yes">
8163	<desc>Guest OS identifier string.</desc>
8164	</attribute>
8165
8166	<attribute name="description" type="wstring" readonly="yes">
8167	<desc>Human readable description of the guest OS.</desc>
8168	</attribute>
8169
8170	<attribute name="is64Bit" type="boolean" readonly="yes">
8171	<desc>Returns @c true if the given OS is 64-bit</desc>
8172	</attribute>
8173
8174	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8175	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8176	</attribute>
8177
8178	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8179	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8180	</attribute>
8181
8182	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8183	<desc>Recommended RAM size in Megabytes.</desc>
8184	</attribute>
8185
8186	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8187	<desc>Recommended video RAM size in Megabytes.</desc>
8188	</attribute>
8189
8190	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8191	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8192	</attribute>
8193
8194	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8195	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8196	</attribute>
8197
8198	<attribute name="recommendedHDD" type="long long" readonly="yes">
8199	<desc>Recommended hard disk size in bytes.</desc>
8200	</attribute>
8201
8202	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8203	<desc>Returns recommended network adapter for this OS type.</desc>
8204	</attribute>
8205
8206	<attribute name="recommendedPae" type="boolean" readonly="yes">
8207	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8208	</attribute>
8209
8210	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8211	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8212	</attribute>
8213
8214	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8215	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8216	</attribute>
8217
8218	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8219	<desc>Recommended storage controller type for HD drives.</desc>
8220	</attribute>
8221
8222	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8223	<desc>Recommended storage bus type for HD drives.</desc>
8224	</attribute>
8225
8226	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8227	<desc>Recommended firmware type.</desc>
8228	</attribute>
8229
8230	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8231	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8232	</attribute>
8233
8234	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8235	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8236	</attribute>
8237
8238	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8239	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8240	</attribute>
8241
8242	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8243	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8244	</attribute>
8245
8246	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8247	<desc>Recommended chipset type.</desc>
8248	</attribute>
8249
8250	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8251	<desc>Recommended audio type.</desc>
8252	</attribute>
8253
8254	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8255	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8256	</attribute>
8257
8258	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8259	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8260	</attribute>
8261
8262	</interface>
8263
8264	<enum
8265	name="AdditionsFacilityType"
8266	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8267	>
8268	<desc>
8269	Guest Additions facility IDs.
8270	</desc>
8271
8272	<const name="None" value="0">
8273	<desc>No/invalid facility.</desc>
8274	</const>
8275	<const name="VBoxGuestDriver" value="20">
8276	<desc>VirtualBox base driver (VBoxGuest).</desc>
8277	</const>
8278	<const name="VBoxService" value="100">
8279	<desc>VirtualBox system service (VBoxService).</desc>
8280	</const>
8281	<const name="VBoxTrayClient" value="101">
8282	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8283	</const>
8284	<const name="Seamless" value="1000">
8285	<desc>Seamless guest desktop integration.</desc>
8286	</const>
8287	<const name="Graphics" value="1100">
8288	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8289	are not immediately acted on and guest display resizes are probably not initiated by
8290	the guest additions.
8291	</desc>
8292	</const>
8293	<const name="All" value="2147483646">
8294	<desc>All facilities selected.</desc>
8295	</const>
8296	</enum>
8297
8298	<enum
8299	name="AdditionsFacilityClass"
8300	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8301	>
8302	<desc>
8303	Guest Additions facility classes.
8304	</desc>
8305
8306	<const name="None" value="0">
8307	<desc>No/invalid class.</desc>
8308	</const>
8309	<const name="Driver" value="10">
8310	<desc>Driver.</desc>
8311	</const>
8312	<const name="Service" value="30">
8313	<desc>System service.</desc>
8314	</const>
8315	<const name="Program" value="50">
8316	<desc>Program.</desc>
8317	</const>
8318	<const name="Feature" value="100">
8319	<desc>Feature.</desc>
8320	</const>
8321	<const name="ThirdParty" value="999">
8322	<desc>Third party.</desc>
8323	</const>
8324	<const name="All" value="2147483646">
8325	<desc>All facility classes selected.</desc>
8326	</const>
8327	</enum>
8328
8329	<enum
8330	name="AdditionsFacilityStatus"
8331	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8332	>
8333	<desc>
8334	Guest Additions facility states.
8335	</desc>
8336
8337	<const name="Inactive" value="0">
8338	<desc>Facility is not active.</desc>
8339	</const>
8340	<const name="Paused" value="1">
8341	<desc>Facility has been paused.</desc>
8342	</const>
8343	<const name="PreInit" value="20">
8344	<desc>Facility is preparing to initialize.</desc>
8345	</const>
8346	<const name="Init" value="30">
8347	<desc>Facility is initializing.</desc>
8348	</const>
8349	<const name="Active" value="50">
8350	<desc>Facility is up and running.</desc>
8351	</const>
8352	<const name="Terminating" value="100">
8353	<desc>Facility is shutting down.</desc>
8354	</const>
8355	<const name="Terminated" value="101">
8356	<desc>Facility successfully shut down.</desc>
8357	</const>
8358	<const name="Failed" value="800">
8359	<desc>Facility failed to start.</desc>
8360	</const>
8361	<const name="Unknown" value="999">
8362	<desc>Facility status is unknown.</desc>
8363	</const>
8364	</enum>
8365
8366	<interface
8367	name="IAdditionsFacility" extends="$unknown"
8368	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8369	wsmap="struct"
8370	>
8371	<desc>
8372	Structure representing a Guest Additions facility.
8373	</desc>
8374
8375	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8376	<desc>The class this facility is part of.</desc>
8377	</attribute>
8378
8379	<attribute name="lastUpdated" type="long long" readonly="yes">
8380	<desc>
8381	Time stamp of the last status update,
8382	in milliseconds since 1970-01-01 UTC.
8383	</desc>
8384	</attribute>
8385
8386	<attribute name="name" type="wstring" readonly="yes">
8387	<desc>The facility's friendly name.</desc>
8388	</attribute>
8389
8390	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8391	<desc>The current status.</desc>
8392	</attribute>
8393
8394	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8395	<desc>The facility's type ID.</desc>
8396	</attribute>
8397	</interface>
8398
8399	<enum
8400	name="AdditionsRunLevelType"
8401	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8402	>
8403	<desc>
8404	Guest Additions run level type.
8405	</desc>
8406
8407	<const name="None" value="0">
8408	<desc>Guest Additions are not loaded.</desc>
8409	</const>
8410	<const name="System" value="1">
8411	<desc>Guest drivers are loaded.</desc>
8412	</const>
8413	<const name="Userland" value="2">
8414	<desc>Common components (such as application services) are loaded.</desc>
8415	</const>
8416	<const name="Desktop" value="3">
8417	<desc>Per-user desktop components are loaded.</desc>
8418	</const>
8419	</enum>
8420
8421	<enum
8422	name="AdditionsUpdateFlag"
8423	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8424	>
8425	<desc>
8426	Guest Additions update flags.
8427	</desc>
8428
8429	<const name="None" value="0">
8430	<desc>No flag set.</desc>
8431	</const>
8432	<const name="WaitForUpdateStartOnly" value="1">
8433	<desc>Only wait for the update process being started and do not
8434	wait while peforming the actual update.</desc>
8435	</const>
8436	</enum>
8437
8438	<enum
8439	name="ExecuteProcessFlag"
8440	uuid="286ceb91-5f66-4c96-9845-4483e90e00ae"
8441	>
8442	<desc>
8443	Guest process execution flags.
8444	</desc>
8445
8446	<const name="None" value="0">
8447	<desc>No flag set.</desc>
8448	</const>
8449	<const name="WaitForProcessStartOnly" value="1">
8450	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8451	process itself then uses an infinite timeout.</desc>
8452	</const>
8453	<const name="IgnoreOrphanedProcesses" value="2">
8454	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8455	</const>
8456	<const name="Hidden" value="4">
8457	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8458	</const>
8459	<const name="NoProfile" value="8">
8460	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8461	</const>
8462	</enum>
8463
8464	<enum
8465	name="ExecuteProcessStatus"
8466	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8467	>
8468	<desc>
8469	Guest process execution status.
8470	</desc>
8471	<const name="Undefined" value="0">
8472	<desc>Process is in an undefined state.</desc>
8473	</const>
8474
8475	<const name="Started" value="1">
8476	<desc>Process has been started.</desc>
8477	</const>
8478	<const name="TerminatedNormally" value="2">
8479	<desc>Process terminated normally.</desc>
8480	</const>
8481	<const name="TerminatedSignal" value="3">
8482	<desc>Process terminated via signal.</desc>
8483	</const>
8484	<const name="TerminatedAbnormally" value="4">
8485	<desc>Process terminated abnormally.</desc>
8486	</const>
8487	<const name="TimedOutKilled" value="5">
8488	<desc>Process timed out and was killed.</desc>
8489	</const>
8490	<const name="TimedOutAbnormally" value="6">
8491	<desc>Process timed out and was not killed successfully.</desc>
8492	</const>
8493	<const name="Down" value="7">
8494	<desc>Service/OS is stopping, process was killed.</desc>
8495	</const>
8496	<const name="Error" value="8">
8497	<desc>Something went wrong (error code in flags).</desc>
8498	</const>
8499	</enum>
8500
8501	<enum
8502	name="ProcessInputFlag"
8503	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8504	>
8505	<desc>
8506	Guest process input flags.
8507	</desc>
8508	<const name="None" value="0">
8509	<desc>No flag set.</desc>
8510	</const>
8511	<const name="EndOfFile" value="1">
8512	<desc>End of file (input) reached.</desc>
8513	</const>
8514	</enum>
8515
8516	<enum
8517	name="ProcessOutputFlag"
8518	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8519	>
8520	<desc>
8521	Guest process output flags for specifying which
8522	type of output to retrieve.
8523	</desc>
8524	<const name="None" value="0">
8525	<desc>No flags set. Get output from stdout.</desc>
8526	</const>
8527	<const name="StdErr" value="1">
8528	<desc>Get output from stderr.</desc>
8529	</const>
8530	</enum>
8531
8532	<enum
8533	name="CopyFileFlag"
8534	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8535	>
8536	<desc>
8537	Host/Guest copy flags. At the moment none of these flags
8538	are implemented.
8539	</desc>
8540	<const name="None" value="0">
8541	<desc>No flag set.</desc>
8542	</const>
8543	<const name="Recursive" value="1">
8544	<desc>Copy directories recursively.</desc>
8545	</const>
8546	<const name="Update" value="2">
8547	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8548	</const>
8549	<const name="FollowLinks" value="4">
8550	<desc>Follow symbolic links.</desc>
8551	</const>
8552	</enum>
8553
8554	<enum
8555	name="DirectoryCreateFlag"
8556	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8557	>
8558	<desc>
8559	Directory creation flags.
8560	</desc>
8561	<const name="None" value="0">
8562	<desc>No flag set.</desc>
8563	</const>
8564	<const name="Parents" value="1">
8565	<desc>No error if existing, make parent directories as needed.</desc>
8566	</const>
8567	</enum>
8568
8569	<enum
8570	name="DirectoryOpenFlag"
8571	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8572	>
8573	<desc>
8574	Directory open flags.
8575	</desc>
8576	<const name="None" value="0">
8577	<desc>No flag set.</desc>
8578	</const>
8579	</enum>
8580
8581	<enum
8582	name="GuestDirEntryType"
8583	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8584	>
8585	<desc>
8586	Guest directory entry type.
8587	</desc>
8588	<const name="Unknown" value="0">
8589	<desc>Unknown.</desc>
8590	</const>
8591	<const name="Directory" value="4">
8592	<desc>Regular file.</desc>
8593	</const>
8594	<const name="File" value="10">
8595	<desc>Regular file.</desc>
8596	</const>
8597	<const name="Symlink" value="12">
8598	<desc>Symbolic link.</desc>
8599	</const>
8600	</enum>
8601
8602	<interface
8603	name="IGuestDirEntry" extends="$unknown"
8604	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8605	wsmap="struct"
8606	>
8607	<desc>
8608	Structure representing a directory entry on the guest OS.
8609	</desc>
8610	<attribute name="nodeId" type="long long" readonly="yes">
8611	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8612	</attribute>
8613	<attribute name="name" type="wstring" readonly="yes">
8614	<desc>The filename.</desc>
8615	</attribute>
8616	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8617	<desc>The entry type.</desc>
8618	</attribute>
8619	</interface>
8620
8621	<interface
8622	name="IGuest" extends="$unknown"
8623	uuid="ed109b6e-0578-4b17-8ace-52646789f1a0"
8624	wsmap="managed"
8625	>
8626	<desc>
8627	The IGuest interface represents information about the operating system
8628	running inside the virtual machine. Used in
8629	<link to="IConsole::guest"/>.
8630
8631	IGuest provides information about the guest operating system, whether
8632	Guest Additions are installed and other OS-specific virtual machine
8633	properties.
8634	</desc>
8635
8636	<attribute name="OSTypeId" type="wstring" readonly="yes">
8637	<desc>
8638	Identifier of the Guest OS type as reported by the Guest
8639	Additions.
8640	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8641	an IGuestOSType object representing details about the given
8642	Guest OS type.
8643	<note>
8644	If Guest Additions are not installed, this value will be
8645	the same as <link to="IMachine::OSTypeId"/>.
8646	</note>
8647	</desc>
8648	</attribute>
8649
8650	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8651	<desc>
8652	Current run level of the Guest Additions.
8653	</desc>
8654	</attribute>
8655
8656	<attribute name="additionsVersion" type="wstring" readonly="yes">
8657	<desc>
8658	Version of the Guest Additions including the revision (3 decimal numbers
8659	separated by dots + revision number) installed on the guest or empty
8660	when the Additions are not installed.
8661	</desc>
8662	</attribute>
8663
8664	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8665	<desc>
8666	Array of current known facilities. Only returns facilities where a status is known,
8667	e.g. facilities with an unknown status will not be returned.
8668	</desc>
8669	</attribute>
8670
8671	<attribute name="memoryBalloonSize" type="unsigned long">
8672	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8673	</attribute>
8674
8675	<attribute name="statisticsUpdateInterval" type="unsigned long">
8676	<desc>Interval to update guest statistics in seconds.</desc>
8677	</attribute>
8678
8679	<method name="internalGetStatistics">
8680	<desc>
8681	Internal method; do not use as it might change at any time.
8682	</desc>
8683	<param name="cpuUser" type="unsigned long" dir="out">
8684	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8685	</param>
8686	<param name="cpuKernel" type="unsigned long" dir="out">
8687	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8688	</param>
8689	<param name="cpuIdle" type="unsigned long" dir="out">
8690	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8691	</param>
8692	<param name="memTotal" type="unsigned long" dir="out">
8693	<desc>Total amount of physical guest RAM.</desc>
8694	</param>
8695	<param name="memFree" type="unsigned long" dir="out">
8696	<desc>Free amount of physical guest RAM.</desc>
8697	</param>
8698	<param name="memBalloon" type="unsigned long" dir="out">
8699	<desc>Amount of ballooned physical guest RAM.</desc>
8700	</param>
8701	<param name="memShared" type="unsigned long" dir="out">
8702	<desc>Amount of shared physical guest RAM.</desc>
8703	</param>
8704	<param name="memCache" type="unsigned long" dir="out">
8705	<desc>Total amount of guest (disk) cache memory.</desc>
8706	</param>
8707	<param name="pagedTotal" type="unsigned long" dir="out">
8708	<desc>Total amount of space in the page file.</desc>
8709	</param>
8710	<param name="memAllocTotal" type="unsigned long" dir="out">
8711	<desc>Total amount of memory allocated by the hypervisor.</desc>
8712	</param>
8713	<param name="memFreeTotal" type="unsigned long" dir="out">
8714	<desc>Total amount of free memory available in the hypervisor.</desc>
8715	</param>
8716	<param name="memBalloonTotal" type="unsigned long" dir="out">
8717	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8718	</param>
8719	<param name="memSharedTotal" type="unsigned long" dir="out">
8720	<desc>Total amount of shared memory in the hypervisor.</desc>
8721	</param>
8722	</method>
8723
8724	<method name="getFacilityStatus">
8725	<desc>
8726	Get the current status of a Guest Additions facility.
8727	</desc>
8728	<param name="facility" type="AdditionsFacilityType" dir="in">
8729	<desc>Facility to check status for.</desc>
8730	</param>
8731	<param name="timestamp" type="long long" dir="out">
8732	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8733	</param>
8734	<param name="status" type="AdditionsFacilityStatus" dir="return">
8735	<desc>The current (latest) facility status.</desc>
8736	</param>
8737	</method>
8738
8739	<method name="getAdditionsStatus">
8740	<desc>
8741	Retrieve the current status of a certain Guest Additions run level.
8742
8743	<result name="VBOX_E_NOT_SUPPORTED">
8744	Wrong status level specified.
8745	</result>
8746
8747	</desc>
8748	<param name="level" type="AdditionsRunLevelType" dir="in">
8749	<desc>Status level to check</desc>
8750	</param>
8751	<param name="active" type="boolean" dir="return">
8752	<desc>Flag whether the status level has been reached or not</desc>
8753	</param>
8754	</method>
8755
8756	<method name="setCredentials">
8757	<desc>
8758	Store login credentials that can be queried by guest operating
8759	systems with Additions installed. The credentials are transient
8760	to the session and the guest may also choose to erase them. Note
8761	that the caller cannot determine whether the guest operating system
8762	has queried or made use of the credentials.
8763
8764	<result name="VBOX_E_VM_ERROR">
8765	VMM device is not available.
8766	</result>
8767
8768	</desc>
8769	<param name="userName" type="wstring" dir="in">
8770	<desc>User name string, can be empty</desc>
8771	</param>
8772	<param name="password" type="wstring" dir="in">
8773	<desc>Password string, can be empty</desc>
8774	</param>
8775	<param name="domain" type="wstring" dir="in">
8776	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8777	</param>
8778	<param name="allowInteractiveLogon" type="boolean" dir="in">
8779	<desc>
8780	Flag whether the guest should alternatively allow the user to
8781	interactively specify different credentials. This flag might
8782	not be supported by all versions of the Additions.
8783	</desc>
8784	</param>
8785	</method>
8786
8787	<method name="executeProcess">
8788	<desc>
8789	Executes an existing program inside the guest VM.
8790
8791	<note>
8792	Starting at VirtualBox 4.1.2 guest process execution by default is limited
8793	to serve up to 5 guest processes at a time. If a new guest process gets started
8794	which would exceed this limit, the oldest not running guest process will be discarded
8795	in order to be able to run that new process. Also, retrieving output from this
8796	old guest process will not be possible anymore then. If all 5 guest processes
8797	are still active and running, starting a new guest process will result in an
8798	appropriate error message.
8799
8800	To raise or lower the guest process execution limit, either the guest property
8801	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
8802	command line by specifying "--control-procs-max-kept" needs to be modified.
8803	A restart of the guest OS is required afterwards. To serve unlimited guest
8804	processes, a value of "0" needs to be set (not recommended).
8805	</note>
8806
8807	<result name="VBOX_E_IPRT_ERROR">
8808	Could not execute process.
8809	</result>
8810
8811	</desc>
8812	<param name="execName" type="wstring" dir="in">
8813	<desc>
8814	Full path name of the command to execute on the guest; the
8815	commands has to exists in the guest VM in order to be executed.
8816	</desc>
8817	</param>
8818	<param name="flags" type="unsigned long" dir="in">
8819	<desc>
8820	<link to="ExecuteProcessFlag"/> flags.
8821	</desc>
8822	</param>
8823	<param name="arguments" type="wstring" safearray="yes" dir="in">
8824	<desc>
8825	Array of arguments passed to the execution command.
8826	</desc>
8827	</param>
8828	<param name="environment" type="wstring" safearray="yes" dir="in">
8829	<desc>
8830	Environment variables that can be set while the command is being
8831	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8832	variable just set its name ("NAME") without a value.
8833	</desc>
8834	</param>
8835	<param name="userName" type="wstring" dir="in">
8836	<desc>
8837	User name under which the command will be executed; has to exist
8838	and have the appropriate rights to execute programs in the VM.
8839	</desc>
8840	</param>
8841	<param name="password" type="wstring" dir="in">
8842	<desc>
8843	Password of the user account specified.
8844	</desc>
8845	</param>
8846	<param name="timeoutMS" type="unsigned long" dir="in">
8847	<desc>
8848	The maximum timeout value (in msec) to wait for finished program
8849	execution. Pass 0 for an infinite timeout.
8850	</desc>
8851	</param>
8852	<param name="pid" type="unsigned long" dir="out">
8853	<desc>
8854	The PID (process ID) of the started command for later reference.
8855	</desc>
8856	</param>
8857	<param name="progress" type="IProgress" dir="return">
8858	<desc>Progress object to track the operation completion.</desc>
8859	</param>
8860	</method>
8861
8862	<method name="getProcessOutput">
8863	<desc>
8864	Retrieves output of a formerly started process.
8865
8866	<result name="VBOX_E_IPRT_ERROR">
8867	Could not retrieve output.
8868	</result>
8869
8870	</desc>
8871	<param name="pid" type="unsigned long" dir="in">
8872	<desc>
8873	Process id returned by earlier <link to="#executeProcess"/> call.
8874	</desc>
8875	</param>
8876	<param name="flags" type="unsigned long" dir="in">
8877	<desc>
8878	<link to="ProcessOutputFlag"/> flags.
8879	</desc>
8880	</param>
8881	<param name="timeoutMS" type="unsigned long" dir="in">
8882	<desc>
8883	The maximum timeout value (in msec) to wait for output
8884	data. Pass 0 for an infinite timeout.
8885	</desc>
8886	</param>
8887	<param name="size" type="long long" dir="in">
8888	<desc>
8889	Size in bytes to read in the buffer.
8890	</desc>
8891	</param>
8892	<param name="data" type="octet" safearray="yes" dir="return">
8893	<desc>
8894	Buffer for retrieving the actual output. A data size of 0 means end of file
8895	if the requested size was not 0. This is the unprocessed
8896	output data, i.e. the line ending style depends on the platform of
8897	the system the server is running on.
8898	</desc>
8899	</param>
8900	</method>
8901
8902	<method name="getProcessStatus">
8903	<desc>
8904	Retrieves status, exit code and the exit reason of a formerly started process.
8905
8906	<result name="VBOX_E_IPRT_ERROR">
8907	Process with specified PID was not found.
8908	</result>
8909
8910	</desc>
8911	<param name="pid" type="unsigned long" dir="in">
8912	<desc>
8913	Process id returned by earlier <link to="#executeProcess"/> call.
8914	</desc>
8915	</param>
8916	<param name="exitcode" type="unsigned long" dir="out">
8917	<desc>
8918	The exit code (if available).
8919	</desc>
8920	</param>
8921	<param name="flags" type="unsigned long" dir="out">
8922	<desc>
8923	Additional flags of process status. Not used at the moment and
8924	must be set to 0.
8925	</desc>
8926	</param>
8927	<param name="reason" type="ExecuteProcessStatus" dir="return">
8928	<desc>
8929	The current process status.
8930	</desc>
8931	</param>
8932	</method>
8933
8934	<method name="copyFromGuest">
8935	<desc>
8936	Copies files/directories from guest to the host.
8937
8938	<result name="VBOX_E_IPRT_ERROR">
8939	Error while copying.
8940	</result>
8941
8942	</desc>
8943	<param name="source" type="wstring" dir="in">
8944	<desc>
8945	Source file on the guest to copy.
8946	</desc>
8947	</param>
8948	<param name="dest" type="wstring" dir="in">
8949	<desc>
8950	Destination path on the host.
8951	</desc>
8952	</param>
8953	<param name="userName" type="wstring" dir="in">
8954	<desc>
8955	User name under which the copy command will be executed; the
8956	user has to exist and have the appropriate rights to read from
8957	the source path.
8958	</desc>
8959	</param>
8960	<param name="password" type="wstring" dir="in">
8961	<desc>
8962	Password of the user account specified.
8963	</desc>
8964	</param>
8965	<param name="flags" type="unsigned long" dir="in">
8966	<desc>
8967	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8968	</desc>
8969	</param>
8970	<param name="progress" type="IProgress" dir="return">
8971	<desc>Progress object to track the operation completion.</desc>
8972	</param>
8973	</method>
8974
8975	<method name="copyToGuest">
8976	<desc>
8977	Copies files/directories from host to the guest.
8978
8979	<result name="VBOX_E_IPRT_ERROR">
8980	Error while copying.
8981	</result>
8982
8983	</desc>
8984	<param name="source" type="wstring" dir="in">
8985	<desc>
8986	Source file on the host to copy.
8987	</desc>
8988	</param>
8989	<param name="dest" type="wstring" dir="in">
8990	<desc>
8991	Destination path on the guest.
8992	</desc>
8993	</param>
8994	<param name="userName" type="wstring" dir="in">
8995	<desc>
8996	User name under which the copy command will be executed; the
8997	user has to exist and have the appropriate rights to write to
8998	the destination path.
8999	</desc>
9000	</param>
9001	<param name="password" type="wstring" dir="in">
9002	<desc>
9003	Password of the user account specified.
9004	</desc>
9005	</param>
9006	<param name="flags" type="unsigned long" dir="in">
9007	<desc>
9008	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9009	</desc>
9010	</param>
9011	<param name="progress" type="IProgress" dir="return">
9012	<desc>Progress object to track the operation completion.</desc>
9013	</param>
9014	</method>
9015
9016	<method name="directoryClose">
9017	<desc>
9018	Closes a formerly opened guest directory.
9019
9020	<result name="VBOX_E_IPRT_ERROR">
9021	Error while closing directory.
9022	</result>
9023
9024	</desc>
9025	<param name="handle" type="unsigned long" dir="in">
9026	<desc>
9027	Handle of opened directory to close.
9028	</desc>
9029	</param>
9030	</method>
9031
9032	<method name="directoryCreate">
9033	<desc>
9034	Creates a directory on the guest.
9035
9036	<result name="VBOX_E_IPRT_ERROR">
9037	Error while creating directory.
9038	</result>
9039
9040	</desc>
9041	<param name="directory" type="wstring" dir="in">
9042	<desc>
9043	Directory to create.
9044	</desc>
9045	</param>
9046	<param name="userName" type="wstring" dir="in">
9047	<desc>
9048	User name under which the directory creation will be executed; the
9049	user has to exist and have the appropriate rights to create the
9050	desired directory.
9051	</desc>
9052	</param>
9053	<param name="password" type="wstring" dir="in">
9054	<desc>
9055	Password of the user account specified.
9056	</desc>
9057	</param>
9058	<param name="mode" type="unsigned long" dir="in">
9059	<desc>
9060	File mode.
9061	</desc>
9062	</param>
9063	<param name="flags" type="unsigned long" dir="in">
9064	<desc>
9065	<link to="DirectoryCreateFlag"/> flags.
9066	</desc>
9067	</param>
9068	</method>
9069
9070	<method name="directoryOpen">
9071	<desc>
9072	Opens a directory on the guest.
9073
9074	<result name="VBOX_E_IPRT_ERROR">
9075	Error while opening / reading directory.
9076	</result>
9077
9078	</desc>
9079	<param name="directory" type="wstring" dir="in">
9080	<desc>
9081	Directory to read.
9082	</desc>
9083	</param>
9084	<param name="filter" type="wstring" dir="in">
9085	<desc>
9086	Directory filter (DOS style wildcards). Set to empty
9087	string if no filter required.
9088	</desc>
9089	</param>
9090	<param name="flags" type="unsigned long" dir="in">
9091	<desc>
9092	<link to="DirectoryOpenFlag"/> flags.
9093	</desc>
9094	</param>
9095	<param name="userName" type="wstring" dir="in">
9096	<desc>
9097	User name under which the directory reading will be performed; the
9098	user has to exist and have the appropriate rights to access / read the
9099	desired directory.
9100	</desc>
9101	</param>
9102	<param name="password" type="wstring" dir="in">
9103	<desc>
9104	Password of the user account specified.
9105	</desc>
9106	</param>
9107	<param name="handle" type="unsigned long" dir="return">
9108	<desc>
9109	Handle of opened directory returned by openDirectory.
9110	</desc>
9111	</param>
9112	</method>
9113
9114	<method name="directoryRead">
9115	<desc>
9116	Reads the next directory entry of an opened guest directory.
9117
9118	<result name="E_ABORT">
9119	When the end of the directory has been reached.
9120	</result>
9121
9122	<result name="VBOX_E_IPRT_ERROR">
9123	Error while opening / reading directory.
9124	</result>
9125
9126	</desc>
9127	<param name="handle" type="unsigned long" dir="in">
9128	<desc>
9129	Handle of opened directory returned by openDirectory.
9130	</desc>
9131	</param>
9132	<param name="entry" type="IGuestDirEntry" dir="return">
9133	<desc>
9134	Information about next directory entry on success.
9135	</desc>
9136	</param>
9137	</method>
9138
9139	<method name="fileExists">
9140	<desc>
9141	Checks if the specified file name exists and is a regular file.
9142
9143	If the file name ends with a slash or backslash, the function assumes
9144	it's a directory and will check if the specified directory exists and
9145	is a regular directory.
9146
9147	<result name="VBOX_E_IPRT_ERROR">
9148	Error while looking up information.
9149	</result>
9150
9151	</desc>
9152	<param name="file" type="wstring" dir="in">
9153	<desc>
9154	Full path of file to check.
9155	</desc>
9156	</param>
9157	<param name="userName" type="wstring" dir="in">
9158	<desc>
9159	User name under which the lookup will be performed; the
9160	user has to exist and have the appropriate rights to access / read the
9161	desired directory.
9162	</desc>
9163	</param>
9164	<param name="password" type="wstring" dir="in">
9165	<desc>
9166	Password of the user account specified.
9167	</desc>
9168	</param>
9169	<param name="exists" type="boolean" dir="return">
9170	<desc>
9171	True if it's a regular file, false if it isn't (or doesn't exist).
9172	</desc>
9173	</param>
9174	</method>
9175
9176	<method name="fileQuerySize">
9177	<desc>
9178	Queries the size of a file, given the path to it.
9179
9180	<result name="VBOX_E_IPRT_ERROR">
9181	Error while looking up information.
9182	</result>
9183
9184	</desc>
9185	<param name="file" type="wstring" dir="in">
9186	<desc>
9187	Full path of file to query file size for.
9188	</desc>
9189	</param>
9190	<param name="userName" type="wstring" dir="in">
9191	<desc>
9192	User name under which the lookup will be performed; the
9193	user has to exist and have the appropriate rights to access / read the
9194	desired directory.
9195	</desc>
9196	</param>
9197	<param name="password" type="wstring" dir="in">
9198	<desc>
9199	Password of the user account specified.
9200	</desc>
9201	</param>
9202	<param name="size" type="long long" dir="return">
9203	<desc>
9204	Size (in bytes) of file specified.
9205	</desc>
9206	</param>
9207	</method>
9208
9209	<method name="setProcessInput">
9210	<desc>
9211	Sends input into a formerly started process.
9212
9213	<result name="VBOX_E_IPRT_ERROR">
9214	Could not send input.
9215	</result>
9216
9217	</desc>
9218	<param name="pid" type="unsigned long" dir="in">
9219	<desc>
9220	Process id returned by earlier <link to="#executeProcess"/> call.
9221	</desc>
9222	</param>
9223	<param name="flags" type="unsigned long" dir="in">
9224	<desc>
9225	<link to="ProcessInputFlag"/> flags.
9226	</desc>
9227	</param>
9228	<param name="timeoutMS" type="unsigned long" dir="in">
9229	<desc>
9230	The maximum timeout value (in msec) to wait for getting the
9231	data transfered to the guest. Pass 0 for an infinite timeout.
9232	</desc>
9233	</param>
9234	<param name="data" type="octet" dir="in" safearray="yes">
9235	<desc>
9236	Buffer of input data to send to the started process to.
9237	</desc>
9238	</param>
9239	<param name="written" type="unsigned long" dir="return">
9240	<desc>
9241	Number of bytes written.
9242	</desc>
9243	</param>
9244	</method>
9245
9246	<method name="updateGuestAdditions">
9247	<desc>
9248	Updates already installed Guest Additions in a VM
9249	(Windows guests only).
9250
9251	<result name="VBOX_E_IPRT_ERROR">
9252	Error while updating.
9253	</result>
9254
9255	</desc>
9256	<param name="source" type="wstring" dir="in">
9257	<desc>
9258	Path to the Guest Additions .ISO file to use for the upate.
9259	</desc>
9260	</param>
9261	<param name="flags" type="unsigned long" dir="in">
9262	<desc>
9263	<link to="AdditionsUpdateFlag"/> flags.
9264	</desc>
9265	</param>
9266	<param name="progress" type="IProgress" dir="return">
9267	<desc>Progress object to track the operation completion.</desc>
9268	</param>
9269	</method>
9270
9271	</interface>
9272
9273
9274	<!--
9275	// IProgress
9276	/////////////////////////////////////////////////////////////////////////
9277	-->
9278
9279	<interface
9280	name="IProgress" extends="$unknown"
9281	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9282	wsmap="managed"
9283	>
9284	<desc>
9285	The IProgress interface is used to track and control
9286	asynchronous tasks within VirtualBox.
9287
9288	An instance of this is returned every time VirtualBox starts
9289	an asynchronous task (in other words, a separate thread) which
9290	continues to run after a method call returns. For example,
9291	<link to="IConsole::saveState" />, which saves the state of
9292	a running virtual machine, can take a long time to complete.
9293	To be able to display a progress bar, a user interface such as
9294	the VirtualBox graphical user interface can use the IProgress
9295	object returned by that method.
9296
9297	Note that IProgress is a "read-only" interface in the sense
9298	that only the VirtualBox internals behind the Main API can
9299	create and manipulate progress objects, whereas client code
9300	can only use the IProgress object to monitor a task's
9301	progress and, if <link to="#cancelable" /> is @c true,
9302	cancel the task by calling <link to="#cancel" />.
9303
9304	A task represented by IProgress consists of either one or
9305	several sub-operations that run sequentially, one by one (see
9306	<link to="#operation" /> and <link to="#operationCount" />).
9307	Every operation is identified by a number (starting from 0)
9308	and has a separate description.
9309
9310	You can find the individual percentage of completion of the current
9311	operation in <link to="#operationPercent" /> and the
9312	percentage of completion of the task as a whole
9313	in <link to="#percent" />.
9314
9315	Similarly, you can wait for the completion of a particular
9316	operation via <link to="#waitForOperationCompletion" /> or
9317	for the completion of the whole task via
9318	<link to="#waitForCompletion" />.
9319	</desc>
9320
9321	<attribute name="id" type="uuid" mod="string" readonly="yes">
9322	<desc>ID of the task.</desc>
9323	</attribute>
9324
9325	<attribute name="description" type="wstring" readonly="yes">
9326	<desc>Description of the task.</desc>
9327	</attribute>
9328
9329	<attribute name="initiator" type="$unknown" readonly="yes">
9330	<desc>Initiator of the task.</desc>
9331	</attribute>
9332
9333	<attribute name="cancelable" type="boolean" readonly="yes">
9334	<desc>Whether the task can be interrupted.</desc>
9335	</attribute>
9336
9337	<attribute name="percent" type="unsigned long" readonly="yes">
9338	<desc>
9339	Current progress value of the task as a whole, in percent.
9340	This value depends on how many operations are already complete.
9341	Returns 100 if <link to="#completed" /> is @c true.
9342	</desc>
9343	</attribute>
9344
9345	<attribute name="timeRemaining" type="long" readonly="yes">
9346	<desc>
9347	Estimated remaining time until the task completes, in
9348	seconds. Returns 0 once the task has completed; returns -1
9349	if the remaining time cannot be computed, in particular if
9350	the current progress is 0.
9351
9352	Even if a value is returned, the estimate will be unreliable
9353	for low progress values. It will become more reliable as the
9354	task progresses; it is not recommended to display an ETA
9355	before at least 20% of a task have completed.
9356	</desc>
9357	</attribute>
9358
9359	<attribute name="completed" type="boolean" readonly="yes">
9360	<desc>Whether the task has been completed.</desc>
9361	</attribute>
9362
9363	<attribute name="canceled" type="boolean" readonly="yes">
9364	<desc>Whether the task has been canceled.</desc>
9365	</attribute>
9366
9367	<attribute name="resultCode" type="long" readonly="yes">
9368	<desc>
9369	Result code of the progress task.
9370	Valid only if <link to="#completed"/> is @c true.
9371	</desc>
9372	</attribute>
9373
9374	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9375	<desc>
9376	Extended information about the unsuccessful result of the
9377	progress operation. May be @c null if no extended information
9378	is available.
9379	Valid only if <link to="#completed"/> is @c true and
9380	<link to="#resultCode"/> indicates a failure.
9381	</desc>
9382	</attribute>
9383
9384	<attribute name="operationCount" type="unsigned long" readonly="yes">
9385	<desc>
9386	Number of sub-operations this task is divided into.
9387	Every task consists of at least one suboperation.
9388	</desc>
9389	</attribute>
9390
9391	<attribute name="operation" type="unsigned long" readonly="yes">
9392	<desc>Number of the sub-operation being currently executed.</desc>
9393	</attribute>
9394
9395	<attribute name="operationDescription" type="wstring" readonly="yes">
9396	<desc>
9397	Description of the sub-operation being currently executed.
9398	</desc>
9399	</attribute>
9400
9401	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9402	<desc>Progress value of the current sub-operation only, in percent.</desc>
9403	</attribute>
9404
9405	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9406	<desc>Weight value of the current sub-operation only.</desc>
9407	</attribute>
9408
9409	<attribute name="timeout" type="unsigned long">
9410	<desc>
9411	When non-zero, this specifies the number of milliseconds after which
9412	the operation will automatically be canceled. This can only be set on
9413	cancelable objects.
9414	</desc>
9415	</attribute>
9416
9417	<method name="setCurrentOperationProgress">
9418	<desc>Internal method, not to be called externally.</desc>
9419	<param name="percent" type="unsigned long" dir="in" />
9420	</method>
9421	<method name="setNextOperation">
9422	<desc>Internal method, not to be called externally.</desc>
9423	<param name="nextOperationDescription" type="wstring" dir="in" />
9424	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9425	</method>
9426
9427	<method name="waitForCompletion">
9428	<desc>
9429	Waits until the task is done (including all sub-operations)
9430	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9431
9432	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9433	thread are not processed while waiting. Neglecting event queues may
9434	have dire consequences (degrade performance, resource hogs,
9435	deadlocks, etc.), this is specially so for the main thread on
9436	platforms using XPCOM. Callers are adviced wait for short periods
9437	and service their event queues between calls, or to create a worker
9438	thread to do the waiting.
9439
9440	<result name="VBOX_E_IPRT_ERROR">
9441	Failed to wait for task completion.
9442	</result>
9443	</desc>
9444
9445	<param name="timeout" type="long" dir="in">
9446	<desc>
9447	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9448	</desc>
9449	</param>
9450	</method>
9451
9452	<method name="waitForOperationCompletion">
9453	<desc>
9454	Waits until the given operation is done with a given timeout in
9455	milliseconds; specify -1 for an indefinite wait.
9456
9457	See <link to="#waitForCompletion"> for event queue considerations.</link>
9458
9459	<result name="VBOX_E_IPRT_ERROR">
9460	Failed to wait for operation completion.
9461	</result>
9462
9463	</desc>
9464	<param name="operation" type="unsigned long" dir="in">
9465	<desc>
9466	Number of the operation to wait for.
9467	Must be less than <link to="#operationCount"/>.
9468	</desc>
9469	</param>
9470	<param name="timeout" type="long" dir="in">
9471	<desc>
9472	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9473	</desc>
9474	</param>
9475	</method>
9476
9477	<method name="waitForAsyncProgressCompletion">
9478	<desc>
9479	Waits until the other task is completed (including all
9480	sub-operations) and forward all changes from the other progress to
9481	this progress. This means sub-operation number, description, percent
9482	and so on.
9483
9484	You have to take care on setting up at least the same count on
9485	sub-operations in this progress object like there are in the other
9486	progress object.
9487
9488	If the other progress object supports cancel and this object gets any
9489	cancel request (when here enabled as well), it will be forwarded to
9490	the other progress object.
9491
9492	If there is an error in the other progress, this error isn't
9493	automatically transfered to this progress object. So you have to
9494	check any operation error within the other progress object, after
9495	this method returns.
9496	</desc>
9497
9498	<param name="pProgressAsync" type="IProgress" dir="in">
9499	<desc>
9500	The progress object of the asynchrony process.
9501	</desc>
9502	</param>
9503	</method>
9504
9505	<method name="cancel">
9506	<desc>
9507	Cancels the task.
9508	<note>
9509	If <link to="#cancelable"/> is @c false, then this method will fail.
9510	</note>
9511
9512	<result name="VBOX_E_INVALID_OBJECT_STATE">
9513	Operation cannot be canceled.
9514	</result>
9515
9516	</desc>
9517	</method>
9518
9519	</interface>
9520
9521	<!--
9522	// ISnapshot
9523	/////////////////////////////////////////////////////////////////////////
9524	-->
9525
9526	<interface
9527	name="ISnapshot" extends="$unknown"
9528	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9529	wsmap="managed"
9530	>
9531	<desc>
9532	The ISnapshot interface represents a snapshot of the virtual
9533	machine.
9534
9535	Together with the differencing media that are created
9536	when a snapshot is taken, a machine can be brought back to
9537	the exact state it was in when the snapshot was taken.
9538
9539	The ISnapshot interface has no methods, only attributes; snapshots
9540	are controlled through methods of the <link to="IConsole" /> interface
9541	which also manage the media associated with the snapshot.
9542	The following operations exist:
9543
9544	<ul>
9545	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9546	by creating new, empty differencing images for the machine's
9547	media and saving the VM settings and (if the VM is running)
9548	the current VM state in the snapshot.
9549
9550	The differencing images will then receive all data written to
9551	the machine's media, while their parent (base) images
9552	remain unmodified after the snapshot has been taken (see
9553	<link to="IMedium" /> for details about differencing images).
9554	This simplifies restoring a machine to the state of a snapshot:
9555	only the differencing images need to be deleted.
9556
9557	The current machine state is not changed by taking a snapshot
9558	except that <link to="IMachine::currentSnapshot" /> is set to
9559	the newly created snapshot, which is also added to the machine's
9560	snapshots tree.
9561	</li>
9562
9563	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9564	the state of a previous snapshot by deleting the differencing
9565	image of each of the machine's media and setting the machine's
9566	settings and state to the state that was saved in the snapshot (if any).
9567
9568	This destroys the machine's current state. After calling this,
9569	<link to="IMachine::currentSnapshot" /> points to the snapshot
9570	that was restored.
9571	</li>
9572
9573	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9574	without affecting the current machine state.
9575
9576	This does not change the current machine state, but instead frees the
9577	resources allocated when the snapshot was taken: the settings and machine
9578	state file are deleted (if any), and the snapshot's differencing image for
9579	each of the machine's media gets merged with its parent image.
9580
9581	Neither the current machine state nor other snapshots are affected
9582	by this operation, except that parent media will be modified
9583	to contain the disk data associated with the snapshot being deleted.
9584
9585	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9586	attribute is set to the current snapshot's parent or NULL if it
9587	has no parent. Otherwise the attribute is unchanged.
9588	</li>
9589	</ul>
9590
9591	Each snapshot contains a copy of virtual machine's settings (hardware
9592	configuration etc.). This copy is contained in an immutable (read-only)
9593	instance of <link to="IMachine" /> which is available from the snapshot's
9594	<link to="#machine" /> attribute. When restoring the snapshot, these
9595	settings are copied back to the original machine.
9596
9597	In addition, if the machine was running when the
9598	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9599	the current VM state is saved in the snapshot (similarly to what happens
9600	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9601	because when restoring it, the VM will be running.
9602
9603	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9604	the snapshot receives a copy of the execution state file
9605	(<link to="IMachine::stateFilePath"/>).
9606
9607	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9608	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9609	it then contains a so-called "zero execution state", representing a
9610	machine that is powered off.
9611	</desc>
9612
9613	<attribute name="id" type="uuid" mod="string" readonly="yes">
9614	<desc>UUID of the snapshot.</desc>
9615	</attribute>
9616
9617	<attribute name="name" type="wstring">
9618	<desc>Short name of the snapshot.
9619	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9620	be called implicitly.</note>
9621	</desc>
9622	</attribute>
9623
9624	<attribute name="description" type="wstring">
9625	<desc>Optional description of the snapshot.
9626	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9627	be called implicitly.</note>
9628	</desc>
9629	</attribute>
9630
9631	<attribute name="timeStamp" type="long long" readonly="yes">
9632	<desc>
9633	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9634	</desc>
9635	</attribute>
9636
9637	<attribute name="online" type="boolean" readonly="yes">
9638	<desc>
9639	@c true if this snapshot is an online snapshot and @c false otherwise.
9640
9641	When this attribute is @c true, the
9642	<link to="IMachine::stateFilePath"/> attribute of the
9643	<link to="#machine"/> object associated with this snapshot
9644	will point to the saved state file. Otherwise, it will be
9645	an empty string.
9646	</desc>
9647	</attribute>
9648
9649	<attribute name="machine" type="IMachine" readonly="yes">
9650	<desc>
9651	Virtual machine this snapshot is taken on. This object
9652	stores all settings the machine had when taking this snapshot.
9653	<note>
9654	The returned machine object is immutable, i.e. no
9655	any settings can be changed.
9656	</note>
9657	</desc>
9658	</attribute>
9659
9660	<attribute name="parent" type="ISnapshot" readonly="yes">
9661	<desc>
9662	Parent snapshot (a snapshot this one is based on), or
9663	@c null if the snapshot has no parent (i.e. is the first snapshot).
9664	</desc>
9665	</attribute>
9666
9667	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9668	<desc>
9669	Child snapshots (all snapshots having this one as a parent).
9670	By inspecting this attribute starting with a machine's root snapshot
9671	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9672	with a @c null UUID), a machine's snapshots tree can be iterated over.
9673	</desc>
9674	</attribute>
9675
9676	<method name="getChildrenCount" const="yes">
9677	<desc>
9678	Returns the number of direct childrens of this snapshot.
9679	</desc>
9680	<param name="childrenCount" type="unsigned long" dir="return">
9681	<desc>
9682	</desc>
9683	</param>
9684	</method>
9685
9686	</interface>
9687
9688
9689	<!--
9690	// IMedium
9691	/////////////////////////////////////////////////////////////////////////
9692	-->
9693
9694	<enum
9695	name="MediumState"
9696	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9697	>
9698	<desc>
9699	Virtual medium state.
9700	<see><link to="IMedium"/></see>
9701	</desc>
9702
9703	<const name="NotCreated" value="0">
9704	<desc>
9705	Associated medium storage does not exist (either was not created yet or
9706	was deleted).
9707	</desc>
9708	</const>
9709	<const name="Created" value="1">
9710	<desc>
9711	Associated storage exists and accessible; this gets set if the
9712	accessibility check performed by <link to="IMedium::refreshState" />
9713	was successful.
9714	</desc>
9715	</const>
9716	<const name="LockedRead" value="2">
9717	<desc>
9718	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9719	no data modification is possible.
9720	</desc>
9721	</const>
9722	<const name="LockedWrite" value="3">
9723	<desc>
9724	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9725	no concurrent data reading or modification is possible.
9726	</desc>
9727	</const>
9728	<const name="Inaccessible" value="4">
9729	<desc>
9730	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9731	not yet been performed, or else, associated medium storage is not
9732	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9733	is empty, in the second case, it describes the error that occurred.
9734	</desc>
9735	</const>
9736	<const name="Creating" value="5">
9737	<desc>
9738	Associated medium storage is being created.
9739	</desc>
9740	</const>
9741	<const name="Deleting" value="6">
9742	<desc>
9743	Associated medium storage is being deleted.
9744	</desc>
9745	</const>
9746	</enum>
9747
9748	<enum
9749	name="MediumType"
9750	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9751	>
9752	<desc>
9753	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9754	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9755	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9756	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9757	</desc>
9758
9759	<const name="Normal" value="0">
9760	<desc>
9761	Normal medium (attached directly or indirectly, preserved
9762	when taking snapshots).
9763	</desc>
9764	</const>
9765	<const name="Immutable" value="1">
9766	<desc>
9767	Immutable medium (attached indirectly, changes are wiped out
9768	the next time the virtual machine is started).
9769	</desc>
9770	</const>
9771	<const name="Writethrough" value="2">
9772	<desc>
9773	Write through medium (attached directly, ignored when
9774	taking snapshots).
9775	</desc>
9776	</const>
9777	<const name="Shareable" value="3">
9778	<desc>
9779	Allow using this medium concurrently by several machines.
9780	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9781	</desc>
9782	</const>
9783	<const name="Readonly" value="4">
9784	<desc>
9785	A readonly medium, which can of course be used by several machines.
9786	<note>Present and accepted since VirtualBox 4.0.</note>
9787	</desc>
9788	</const>
9789	<const name="MultiAttach" value="5">
9790	<desc>
9791	A medium which is is indirectly attached, so that one base medium can
9792	be used for several VMs which have their own differencing medium to
9793	store their modifications. In some sense a variant of Immutable
9794	with unset AutoReset flag in each differencing medium.
9795	<note>Present and accepted since VirtualBox 4.0.</note>
9796	</desc>
9797	</const>
9798	</enum>
9799
9800	<enum
9801	name="MediumVariant"
9802	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9803	>
9804	<desc>
9805	Virtual medium image variant. More than one flag may be set.
9806	<see><link to="IMedium"/></see>
9807	</desc>
9808
9809	<const name="Standard" value="0">
9810	<desc>
9811	No particular variant requested, results in using the backend default.
9812	</desc>
9813	</const>
9814	<const name="VmdkSplit2G" value="0x01">
9815	<desc>
9816	VMDK image split in chunks of less than 2GByte.
9817	</desc>
9818	</const>
9819	<const name="VmdkStreamOptimized" value="0x04">
9820	<desc>
9821	VMDK streamOptimized image. Special import/export format which is
9822	read-only/append-only.
9823	</desc>
9824	</const>
9825	<const name="VmdkESX" value="0x08">
9826	<desc>
9827	VMDK format variant used on ESX products.
9828	</desc>
9829	</const>
9830	<const name="Fixed" value="0x10000">
9831	<desc>
9832	Fixed image. Only allowed for base images.
9833	</desc>
9834	</const>
9835	<const name="Diff" value="0x20000">
9836	<desc>
9837	Differencing image. Only allowed for child images.
9838	</desc>
9839	</const>
9840	<const name="NoCreateDir" value="0x40000000">
9841	<desc>
9842	Special flag which suppresses automatic creation of the subdirectory.
9843	Only used when passing the medium variant as an input parameter.
9844	</desc>
9845	</const>
9846	</enum>
9847
9848	<interface
9849	name="IMediumAttachment" extends="$unknown"
9850	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
9851	wsmap="struct"
9852	>
9853	<desc>
9854	The IMediumAttachment interface links storage media to virtual machines.
9855	For each medium (<link to="IMedium"/>) which has been attached to a
9856	storage controller (<link to="IStorageController"/>) of a machine
9857	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9858	method, one instance of IMediumAttachment is added to the machine's
9859	<link to="IMachine::mediumAttachments"/> array attribute.
9860
9861	Each medium attachment specifies the storage controller as well as a
9862	port and device number and the IMedium instance representing a virtual
9863	hard disk or floppy or DVD image.
9864
9865	For removable media (DVDs or floppies), there are two additional
9866	options. For one, the IMedium instance can be @c null to represent
9867	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9868	secondly, the medium can be one of the pseudo-media for host drives
9869	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9870
9871	<h3>Attaching Hard Disks</h3>
9872
9873	Hard disks are attached to virtual machines using the
9874	<link to="IMachine::attachDevice"/> method and detached using the
9875	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9876	type (see <link to="IMedium::type" />), hard disks are attached either
9877	<i>directly</i> or <i>indirectly</i>.
9878
9879	When a hard disk is being attached directly, it is associated with the
9880	virtual machine and used for hard disk operations when the machine is
9881	running. When a hard disk is being attached indirectly, a new differencing
9882	hard disk linked to it is implicitly created and this differencing hard
9883	disk is associated with the machine and used for hard disk operations.
9884	This also means that if <link to="IMachine::attachDevice"/> performs
9885	a direct attachment then the same hard disk will be returned in response
9886	to the subsequent <link to="IMachine::getMedium"/> call; however if
9887	an indirect attachment is performed then
9888	<link to="IMachine::getMedium"/> will return the implicitly created
9889	differencing hard disk, not the original one passed to <link
9890	to="IMachine::attachDevice"/>. In detail:
9891
9892	<ul>
9893	<li><b>Normal base</b> hard disks that do not have children (i.e.
9894	differencing hard disks linked to them) and that are not already
9895	attached to virtual machines in snapshots are attached <b>directly</b>.
9896	Otherwise, they are attached <b>indirectly</b> because having
9897	dependent children or being part of the snapshot makes it impossible
9898	to modify hard disk contents without breaking the integrity of the
9899	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9900	quickly determine the kind of the attachment for the given hard
9901	disk. Note that if a normal base hard disk is to be indirectly
9902	attached to a virtual machine with snapshots then a special
9903	procedure called <i>smart attachment</i> is performed (see below).</li>
9904	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9905	they are attached <b>directly</b> if they do not have children and are
9906	not attached to virtual machines in snapshots, and <b>indirectly</b>
9907	otherwise. Note that the smart attachment procedure is never performed
9908	for differencing hard disks.</li>
9909	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9910	they are designed to be non-writable. If an immutable hard disk is
9911	attached to a virtual machine with snapshots then a special
9912	procedure called smart attachment is performed (see below).</li>
9913	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9914	also as designed. This also means that writethrough hard disks cannot
9915	have other hard disks linked to them at all.</li>
9916	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9917	also as designed. This also means that shareable hard disks cannot
9918	have other hard disks linked to them at all. They behave almost
9919	like writethrough hard disks, except that shareable hard disks can
9920	be attached to several virtual machines which are running, allowing
9921	concurrent accesses. You need special cluster software running in
9922	the virtual machines to make use of such disks.</li>
9923	</ul>
9924
9925	Note that the same hard disk, regardless of its type, may be attached to
9926	more than one virtual machine at a time. In this case, the machine that is
9927	started first gains exclusive access to the hard disk and attempts to
9928	start other machines having this hard disk attached will fail until the
9929	first machine is powered down.
9930
9931	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9932	that the given hard disk remains associated with the given machine after a
9933	successful <link to="IMachine::detachDevice"/> call until
9934	<link to="IMachine::saveSettings"/> is called to save all changes to
9935	machine settings to disk. This deferring is necessary to guarantee that
9936	the hard disk configuration may be restored at any time by a call to
9937	<link to="IMachine::discardSettings"/> before the settings
9938	are saved (committed).
9939
9940	Note that if <link to="IMachine::discardSettings"/> is called after
9941	indirectly attaching some hard disks to the machine but before a call to
9942	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9943	all differencing hard disks implicitly created by
9944	<link to="IMachine::attachDevice"/> for these indirect attachments.
9945	Such implicitly created hard disks will also be immediately deleted when
9946	detached explicitly using the <link to="IMachine::detachDevice"/>
9947	call if it is made before <link to="IMachine::saveSettings"/>. This
9948	implicit deletion is safe because newly created differencing hard
9949	disks do not contain any user data.
9950
9951	However, keep in mind that detaching differencing hard disks that were
9952	implicitly created by <link to="IMachine::attachDevice"/>
9953	before the last <link to="IMachine::saveSettings"/> call will
9954	<b>not</b> implicitly delete them as they may already contain some data
9955	(for example, as a result of virtual machine execution). If these hard
9956	disks are no more necessary, the caller can always delete them explicitly
9957	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9958	from this machine by the <link to="IMachine::saveSettings"/> call.
9959
9960	<h3>Smart Attachment</h3>
9961
9962	When normal base or immutable hard disks are indirectly attached to a
9963	virtual machine then some additional steps are performed to make sure the
9964	virtual machine will have the most recent "view" of the hard disk being
9965	attached. These steps include walking through the machine's snapshots
9966	starting from the current one and going through ancestors up to the first
9967	snapshot. Hard disks attached to the virtual machine in all
9968	of the encountered snapshots are checked whether they are descendants of
9969	the given normal base or immutable hard disk. The first found child (which
9970	is the differencing hard disk) will be used instead of the normal base or
9971	immutable hard disk as a parent for creating a new differencing hard disk
9972	that will be actually attached to the machine. And only if no descendants
9973	are found or if the virtual machine does not have any snapshots then the
9974	normal base or immutable hard disk will be used itself as a parent for
9975	this differencing hard disk.
9976
9977	It is easier to explain what smart attachment does using the
9978	following example:
9979	<pre>
9980	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9981
9982	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9983	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9984	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9985	Snapshot 4 (none) Snapshot 4 (none)
9986	CurState (none) CurState (D3->D2.vdi)
9987
9988	NOT
9989	...
9990	CurState (D3->B.vdi)
9991	</pre>
9992	The first column is the virtual machine configuration before the base hard
9993	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9994	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9995	mean that the hard disk that is actually attached to the machine is a
9996	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9997	another hard disk, <tt>B.vdi</tt>.
9998
9999	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10000	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10001	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10002	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10003	it cannot be attached directly and needs an indirect attachment (i.e.
10004	implicit creation of a new differencing hard disk). Due to the smart
10005	attachment procedure, the new differencing hard disk
10006	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10007	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10008	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10009	machine.
10010
10011	Note that if there is more than one descendant hard disk of the given base
10012	hard disk found in a snapshot, and there is an exact device, channel and
10013	bus match, then this exact match will be used. Otherwise, the youngest
10014	descendant will be picked up.
10015
10016	There is one more important aspect of the smart attachment procedure which
10017	is not related to snapshots at all. Before walking through the snapshots
10018	as described above, the backup copy of the current list of hard disk
10019	attachment is searched for descendants. This backup copy is created when
10020	the hard disk configuration is changed for the first time after the last
10021	<link to="IMachine::saveSettings"/> call and used by
10022	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10023	changes. When such a descendant is found in this backup copy, it will be
10024	simply re-attached back, without creating a new differencing hard disk for
10025	it. This optimization is necessary to make it possible to re-attach the
10026	base or immutable hard disk to a different bus, channel or device slot
10027	without losing the contents of the differencing hard disk actually
10028	attached to the machine in place of it.
10029
10030	</desc>
10031
10032	<attribute name="medium" type="IMedium" readonly="yes">
10033	<desc>Medium object associated with this attachment; it
10034	can be @c null for removable devices.</desc>
10035	</attribute>
10036
10037	<attribute name="controller" type="wstring" readonly="yes">
10038	<desc>Name of the storage controller of this attachment; this
10039	refers to one of the controllers in <link to="IMachine::storageControllers" />
10040	by name.</desc>
10041	</attribute>
10042
10043	<attribute name="port" type="long" readonly="yes">
10044	<desc>Port number of this attachment.
10045	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10046	</desc>
10047	</attribute>
10048
10049	<attribute name="device" type="long" readonly="yes">
10050	<desc>Device slot number of this attachment.
10051	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10052	</desc>
10053	</attribute>
10054
10055	<attribute name="type" type="DeviceType" readonly="yes">
10056	<desc>Device type of this attachment.</desc>
10057	</attribute>
10058
10059	<attribute name="passthrough" type="boolean" readonly="yes">
10060	<desc>Pass I/O requests through to a device on the host.</desc>
10061	</attribute>
10062
10063	<attribute name="temporaryEject" type="boolean" readonly="yes">
10064	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10065	</attribute>
10066
10067	<attribute name="isEjected" type="boolean" readonly="yes">
10068	<desc>Signals that the removable medium has been ejected. This is not
10069	necessarily equivalent to having a @c null medium association.</desc>
10070	</attribute>
10071
10072	<attribute name="nonRotational" type="boolean" readonly="yes">
10073	<desc>Whether the associated medium is non-rotational.</desc>
10074	</attribute>
10075
10076	<attribute name="discard" type="boolean" readonly="yes">
10077	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10078	</attribute>
10079
10080	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10081	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10082	</attribute>
10083
10084	</interface>
10085
10086	<interface
10087	name="IMedium" extends="$unknown"
10088	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10089	wsmap="managed"
10090	>
10091	<desc>
10092	The IMedium interface represents virtual storage for a machine's
10093	hard disks, CD/DVD or floppy drives. It will typically represent
10094	a disk image on the host, for example a VDI or VMDK file representing
10095	a virtual hard disk, or an ISO or RAW file representing virtual
10096	removable media, but can also point to a network location (e.g.
10097	for iSCSI targets).
10098
10099	Instances of IMedium are connected to virtual machines by way of medium
10100	attachments, which link the storage medium to a particular device slot
10101	of a storage controller of the virtual machine.
10102	In the VirtualBox API, virtual storage is therefore always represented
10103	by the following chain of object links:
10104
10105	<ul>
10106	<li><link to="IMachine::storageControllers"/> contains an array of
10107	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10108	these are instances of <link to="IStorageController"/>).</li>
10109	<li><link to="IMachine::mediumAttachments"/> contains an array of
10110	medium attachments (instances of <link to="IMediumAttachment"/>
10111	created by <link to="IMachine::attachDevice" />),
10112	each containing a storage controller from the above array, a
10113	port/device specification, and an instance of IMedium representing
10114	the medium storage (image file).
10115
10116	For removable media, the storage medium is optional; a medium
10117	attachment with no medium represents a CD/DVD or floppy drive
10118	with no medium inserted. By contrast, hard disk attachments
10119	will always have an IMedium object attached.</li>
10120	<li>Each IMedium in turn points to a storage unit (such as a file
10121	on the host computer or a network resource) that holds actual
10122	data. This location is represented by the <link to="#location"/>
10123	attribute.</li>
10124	</ul>
10125
10126	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10127	new hard disk media can be created with the VirtualBox API using the
10128	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10129	disks (see below) are usually implicitly created by VirtualBox as
10130	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10131	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10132	should be created with external tools and then opened from within VirtualBox.
10133
10134	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10135	drive. In that case the <link to="#id" /> attribute contains the UUID of
10136	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10137
10138	<h3>Media registries</h3>
10139
10140	When a medium has been opened or created using one of the aforementioned
10141	APIs, it becomes "known" to VirtualBox. Known media can be attached
10142	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10143	They also appear in the global
10144	<link to="IVirtualBox::hardDisks" />,
10145	<link to="IVirtualBox::DVDImages" /> and
10146	<link to="IVirtualBox::floppyImages" /> arrays.
10147
10148	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10149	in the VirtualBox.xml file, which was shared between all machines and made
10150	transporting machines and their media from one host to another difficult.
10151
10152	Starting with VirtualBox 4.0, media are only added to a registry when they are
10153	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10154	backwards compatibility, which registry a medium is added to depends on which
10155	VirtualBox version created a machine:
10156
10157	<ul>
10158	<li>If the medium has first been attached to a machine which was created by
10159	VirtualBox 4.0 or later, it is added to that machine's media registry in
10160	the machine XML settings file. This way all information about a machine's
10161	media attachments is contained in a single file and can be transported
10162	easily.</li>
10163	<li>For older media attachments (i.e. if the medium was first attached to a
10164	machine which was created with a VirtualBox version before 4.0), media
10165	continue to be registered in the global VirtualBox settings file, for
10166	backwards compatibility.</li>
10167	</ul>
10168
10169	See <link to="IVirtualBox::openMedium" /> for more information.
10170
10171	Media are removed from media registries by the <link to="IMedium::close"/>,
10172	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10173
10174	<h3>Accessibility checks</h3>
10175
10176	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10177	method is called explicitly on a medium. This is done to make the VirtualBox object
10178	ready for serving requests as fast as possible and let the end-user
10179	application decide if it needs to check media accessibility right away or not.
10180
10181	As a result, when VirtualBox starts up (e.g. the VirtualBox
10182	object gets created for the first time), all known media are in the
10183	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10184	attribute is an empty string because no actual accessibility check has
10185	been made yet.
10186
10187	After calling <link to="#refreshState" />, a medium is considered
10188	<i>accessible</i> if its storage unit can be read. In that case, the
10189	<link to="#state"/> attribute has a value of "Created". If the storage
10190	unit cannot be read (for example, because it is located on a disconnected
10191	network resource, or was accidentally deleted outside VirtualBox),
10192	the medium is considered <i>inaccessible</i>, which is indicated by the
10193	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10194	obtained by reading the <link to="#lastAccessError"/> attribute.
10195
10196	<h3>Medium types</h3>
10197
10198	There are five types of medium behavior which are stored in the
10199	<link to="#type"/> attribute (see <link to="MediumType" />) and
10200	which define the medium's behavior with attachments and snapshots.
10201
10202	All media can be also divided in two groups: <i>base</i> media and
10203	<i>differencing</i> media. A base medium contains all sectors of the
10204	medium data in its own storage and therefore can be used independently.
10205	In contrast, a differencing medium is a "delta" to some other medium and
10206	contains only those sectors which differ from that other medium, which is
10207	then called a <i>parent</i>. The differencing medium is said to be
10208	<i>linked to</i> that parent. The parent may be itself a differencing
10209	medium, thus forming a chain of linked media. The last element in that
10210	chain must always be a base medium. Note that several differencing
10211	media may be linked to the same parent medium.
10212
10213	Differencing media can be distinguished from base media by querying the
10214	<link to="#parent"/> attribute: base media do not have parents they would
10215	depend on, so the value of this attribute is always @c null for them.
10216	Using this attribute, it is possible to walk up the medium tree (from the
10217	child medium to its parent). It is also possible to walk down the tree
10218	using the <link to="#children"/> attribute.
10219
10220	Note that the type of all differencing media is "normal"; all other
10221	values are meaningless for them. Base media may be of any type.
10222
10223	<h3>Automatic composition of the file name part</h3>
10224
10225	Another extension to the <link to="IMedium::location"/> attribute is that
10226	there is a possibility to cause VirtualBox to compose a unique value for
10227	the file name part of the location using the UUID of the hard disk. This
10228	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10229	e.g. before the storage unit is created, and works as follows. You set the
10230	value of the <link to="IMedium::location"/> attribute to a location
10231	specification which only contains the path specification but not the file
10232	name part and ends with either a forward slash or a backslash character.
10233	In response, VirtualBox will generate a new UUID for the hard disk and
10234	compose the file name using the following pattern:
10235	<pre>
10236	<path>/{<uuid>}.<ext>
10237	</pre>
10238	where <tt><path></tt> is the supplied path specification,
10239	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10240	is the default extension for the storage format of this hard disk. After
10241	that, you may call any of the methods that create a new hard disk storage
10242	unit and they will use the generated UUID and file name.
10243	</desc>
10244
10245	<attribute name="id" type="uuid" mod="string" readonly="yes">
10246	<desc>
10247	UUID of the medium. For a newly created medium, this value is a randomly
10248	generated UUID.
10249
10250	<note>
10251	For media in one of MediumState_NotCreated, MediumState_Creating or
10252	MediumState_Deleting states, the value of this property is undefined
10253	and will most likely be an empty UUID.
10254	</note>
10255	</desc>
10256	</attribute>
10257
10258	<attribute name="description" type="wstring">
10259	<desc>
10260	Optional description of the medium. For a newly created medium the value
10261	of this attribute is an empty string.
10262
10263	Medium types that don't support this attribute will return E_NOTIMPL in
10264	attempt to get or set this attribute's value.
10265
10266	<note>
10267	For some storage types, reading this attribute may return an outdated
10268	(last known) value when <link to="#state"/> is <link
10269	to="MediumState_Inaccessible"/> or <link
10270	to="MediumState_LockedWrite"/> because the value of this attribute is
10271	stored within the storage unit itself. Also note that changing the
10272	attribute value is not possible in such case, as well as when the
10273	medium is the <link to="MediumState_LockedRead"/> state.
10274	</note>
10275	</desc>
10276	</attribute>
10277
10278	<attribute name="state" type="MediumState" readonly="yes">
10279	<desc>
10280	Returns the current medium state, which is the last state set by
10281	the accessibility check performed by <link to="#refreshState"/>.
10282	If that method has not yet been called on the medium, the state
10283	is "Inaccessible"; as opposed to truly inaccessible media, the
10284	value of <link to="#lastAccessError"/> will be an empty string in
10285	that case.
10286
10287	<note>As of version 3.1, this no longer performs an accessibility check
10288	automatically; call <link to="#refreshState"/> for that.
10289	</note>
10290	</desc>
10291	</attribute>
10292
10293	<attribute name="variant" type="unsigned long" readonly="yes">
10294	<desc>
10295	Returns the storage format variant information for this medium
10296	as a combination of the flags described at <link to="MediumVariant" />.
10297	Before <link to="#refreshState"/> is called this method returns
10298	an undefined value.
10299	</desc>
10300	</attribute>
10301
10302	<attribute name="location" type="wstring">
10303	<desc>
10304	Location of the storage unit holding medium data.
10305
10306	The format of the location string is medium type specific. For medium
10307	types using regular files in a host's file system, the location
10308	string is the full file name.
10309
10310	Some medium types may support changing the storage unit location by
10311	simply changing the value of this property. If this operation is not
10312	supported, the implementation will return E_NOTIMPL in attempt to set
10313	this attribute's value.
10314
10315	When setting a value of the location attribute which is a regular file
10316	in the host's file system, the given file name may be either relative to
10317	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10318	absolute. Note that if the given location specification does not contain
10319	the file extension part then a proper default extension will be
10320	automatically appended by the implementation depending on the medium type.
10321	</desc>
10322	</attribute>
10323
10324	<attribute name="name" type="wstring" readonly="yes">
10325	<desc>
10326	Name of the storage unit holding medium data.
10327
10328	The returned string is a short version of the <link to="#location"/>
10329	attribute that is suitable for representing the medium in situations
10330	where the full location specification is too long (such as lists
10331	and comboboxes in GUI frontends). This string is also used by frontends
10332	to sort the media list alphabetically when needed.
10333
10334	For example, for locations that are regular files in the host's file
10335	system, the value of this attribute is just the file name (+ extension),
10336	without the path specification.
10337
10338	Note that as opposed to the <link to="#location"/> attribute, the name
10339	attribute will not necessary be unique for a list of media of the
10340	given type and format.
10341	</desc>
10342	</attribute>
10343
10344	<attribute name="deviceType" type="DeviceType" readonly="yes">
10345	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10346	medium.</desc>
10347	</attribute>
10348
10349	<attribute name="hostDrive" type="boolean" readonly="yes">
10350	<desc>True if this corresponds to a drive on the host.</desc>
10351	</attribute>
10352
10353	<attribute name="size" type="long long" readonly="yes">
10354	<desc>
10355	Physical size of the storage unit used to hold medium data (in bytes).
10356
10357	<note>
10358	For media whose <link to="#state"/> is <link
10359	to="MediumState_Inaccessible"/>, the value of this property is the
10360	last known size. For <link to="MediumState_NotCreated"/> media,
10361	the returned value is zero.
10362	</note>
10363	</desc>
10364	</attribute>
10365
10366	<attribute name="format" type="wstring" readonly="yes">
10367	<desc>
10368	Storage format of this medium.
10369
10370	The value of this attribute is a string that specifies a backend used
10371	to store medium data. The storage format is defined when you create a
10372	new medium or automatically detected when you open an existing medium,
10373	and cannot be changed later.
10374
10375	The list of all storage formats supported by this VirtualBox
10376	installation can be obtained using
10377	<link to="ISystemProperties::mediumFormats"/>.
10378	</desc>
10379	</attribute>
10380
10381	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10382	<desc>
10383	Storage medium format object corresponding to this medium.
10384
10385	The value of this attribute is a reference to the medium format object
10386	that specifies the backend properties used to store medium data. The
10387	storage format is defined when you create a new medium or automatically
10388	detected when you open an existing medium, and cannot be changed later.
10389
10390	<note>@c null is returned if there is no associated medium format
10391	object. This can e.g. happen for medium objects representing host
10392	drives and other special medium objects.</note>
10393	</desc>
10394	</attribute>
10395
10396	<attribute name="type" type="MediumType">
10397	<desc>
10398	Type (role) of this medium.
10399
10400	The following constraints apply when changing the value of this
10401	attribute:
10402	<ul>
10403	<li>If a medium is attached to a virtual machine (either in the
10404	current state or in one of the snapshots), its type cannot be
10405	changed.
10406	</li>
10407	<li>As long as the medium has children, its type cannot be set
10408	to <link to="MediumType_Writethrough"/>.
10409	</li>
10410	<li>The type of all differencing media is
10411	<link to="MediumType_Normal"/> and cannot be changed.
10412	</li>
10413	</ul>
10414
10415	The type of a newly created or opened medium is set to
10416	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10417	which have a type of <link to="MediumType_Writethrough"/>.
10418	</desc>
10419	</attribute>
10420
10421	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10422	<desc>
10423	Returns which medium types can selected for this medium.
10424
10425	<result name="E_NOTIMPL">
10426	This attribute is not implemented at the moment.
10427	</result>
10428	</desc>
10429	</attribute>
10430
10431	<attribute name="parent" type="IMedium" readonly="yes">
10432	<desc>
10433	Parent of this medium (the medium this medium is directly based
10434	on).
10435
10436	Only differencing media have parents. For base (non-differencing)
10437	media, @c null is returned.
10438	</desc>
10439	</attribute>
10440
10441	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10442	<desc>
10443	Children of this medium (all differencing media directly based
10444	on this medium). A @c null array is returned if this medium
10445	does not have any children.
10446	</desc>
10447	</attribute>
10448
10449	<attribute name="base" type="IMedium" readonly="yes">
10450	<desc>
10451	Base medium of this medium.
10452
10453	If this is a differencing medium, its base medium is the medium
10454	the given medium branch starts from. For all other types of media, this
10455	property returns the medium object itself (i.e. the same object this
10456	property is read on).
10457	</desc>
10458	</attribute>
10459
10460	<attribute name="readOnly" type="boolean" readonly="yes">
10461	<desc>
10462	Returns @c true if this medium is read-only and @c false otherwise.
10463
10464	A medium is considered to be read-only when its contents cannot be
10465	modified without breaking the integrity of other parties that depend on
10466	this medium such as its child media or snapshots of virtual machines
10467	where this medium is attached to these machines. If there are no
10468	children and no such snapshots then there is no dependency and the
10469	medium is not read-only.
10470
10471	The value of this attribute can be used to determine the kind of the
10472	attachment that will take place when attaching this medium to a
10473	virtual machine. If the value is @c false then the medium will
10474	be attached directly. If the value is @c true then the medium
10475	will be attached indirectly by creating a new differencing child
10476	medium for that. See the interface description for more information.
10477
10478	Note that all <link to="MediumType_Immutable">Immutable</link> media
10479	are always read-only while all
10480	<link to="MediumType_Writethrough">Writethrough</link> media are
10481	always not.
10482
10483	<note>
10484	The read-only condition represented by this attribute is related to
10485	the medium type and usage, not to the current
10486	<link to="IMedium::state">medium state</link> and not to the read-only
10487	state of the storage unit.
10488	</note>
10489	</desc>
10490	</attribute>
10491
10492	<attribute name="logicalSize" type="long long" readonly="yes">
10493	<desc>
10494	Logical size of this medium (in bytes), as reported to the
10495	guest OS running inside the virtual machine this medium is
10496	attached to. The logical size is defined when the medium is created
10497	and cannot be changed later.
10498
10499	<note>
10500	Reading this property on a differencing medium will return the size
10501	of its <link to="#base"/> medium.
10502	</note>
10503	<note>
10504	For media whose state is <link to="#state"/> is <link
10505	to="MediumState_Inaccessible"/>, the value of this property is the
10506	last known logical size. For <link to="MediumState_NotCreated"/>
10507	media, the returned value is zero.
10508	</note>
10509	</desc>
10510	</attribute>
10511
10512	<attribute name="autoReset" type="boolean">
10513	<desc>
10514	Whether this differencing medium will be automatically reset each
10515	time a virtual machine it is attached to is powered up. This
10516	attribute is automatically set to @c true for the last
10517	differencing image of an "immutable" medium (see
10518	<link to="MediumType" />).
10519
10520	See <link to="#reset"/> for more information about resetting
10521	differencing media.
10522
10523	<note>
10524	Reading this property on a base (non-differencing) medium will
10525	always @c false. Changing the value of this property in this
10526	case is not supported.
10527	</note>
10528
10529	<result name="VBOX_E_NOT_SUPPORTED">
10530	This is not a differencing medium (when changing the attribute
10531	value).
10532	</result>
10533	</desc>
10534	</attribute>
10535
10536	<attribute name="lastAccessError" type="wstring" readonly="yes">
10537	<desc>
10538	Text message that represents the result of the last accessibility
10539	check performed by <link to="#refreshState"/>.
10540
10541	An empty string is returned if the last accessibility check
10542	was successful or has not yet been called. As a result, if
10543	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10544	then <link to="#refreshState"/> has yet to be called; this is the
10545	default value of media after VirtualBox initialization.
10546	A non-empty string indicates a failure and should normally describe
10547	a reason of the failure (for example, a file read error).
10548	</desc>
10549	</attribute>
10550
10551	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10552	<desc>
10553	Array of UUIDs of all machines this medium is attached to.
10554
10555	A @c null array is returned if this medium is not attached to any
10556	machine or to any machine's snapshot.
10557
10558	<note>
10559	The returned array will include a machine even if this medium is not
10560	attached to that machine in the current state but attached to it in
10561	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10562	details.
10563	</note>
10564	</desc>
10565	</attribute>
10566
10567	<method name="setIDs">
10568	<desc>
10569	Changes the UUID and parent UUID for a hard disk medium.
10570	</desc>
10571	<param name="setImageId" type="boolean" dir="in">
10572	<desc>
10573	Select whether a new image UUID is set or not.
10574	</desc>
10575	</param>
10576	<param name="imageId" type="uuid" mod="string" dir="in">
10577	<desc>
10578	New UUID for the image. If an empty string is passed, then a new
10579	UUID is automatically created, provided that @a setImageId is @c true.
10580	Specifying a zero UUID is not allowed.
10581	</desc>
10582	</param>
10583	<param name="setParentId" type="boolean" dir="in">
10584	<desc>
10585	Select whether a new parent UUID is set or not.
10586	</desc>
10587	</param>
10588	<param name="parentId" type="uuid" mod="string" dir="in">
10589	<desc>
10590	New parent UUID for the image. If an empty string is passed, then a
10591	new UUID is automatically created, provided @a setParentId is
10592	@c true. A zero UUID is valid.
10593	</desc>
10594	</param>
10595	<result name="E_INVALIDARG">
10596	Invalid parameter combination.
10597	</result>
10598	<result name="VBOX_E_NOT_SUPPORTED">
10599	Medium is not a hard disk medium.
10600	</result>
10601	</method>
10602
10603	<method name="refreshState">
10604	<desc>
10605	If the current medium state (see <link to="MediumState"/>) is one of
10606	"Created", "Inaccessible" or "LockedRead", then this performs an
10607	accessibility check on the medium and sets the value of the <link to="#state"/>
10608	attribute accordingly; that value is also returned for convenience.
10609
10610	For all other state values, this does not perform a refresh but returns
10611	the state only.
10612
10613	The refresh, if performed, may take a long time (several seconds or even
10614	minutes, depending on the storage unit location and format) because it performs an
10615	accessibility check of the storage unit. This check may cause a significant
10616	delay if the storage unit of the given medium is, for example, a file located
10617	on a network share which is not currently accessible due to connectivity
10618	problems. In that case, the call will not return until a timeout
10619	interval defined by the host OS for this operation expires. For this reason,
10620	it is recommended to never read this attribute on the main UI thread to avoid
10621	making the UI unresponsive.
10622
10623	If the last known state of the medium is "Created" and the accessibility
10624	check fails, then the state would be set to "Inaccessible", and
10625	<link to="#lastAccessError"/> may be used to get more details about the
10626	failure. If the state of the medium is "LockedRead", then it remains the
10627	same, and a non-empty value of <link to="#lastAccessError"/> will
10628	indicate a failed accessibility check in this case.
10629
10630	Note that not all medium states are applicable to all medium types.
10631	</desc>
10632	<param name="state" type="MediumState" dir="return">
10633	<desc>
10634	New medium state.
10635	</desc>
10636	</param>
10637	</method>
10638
10639	<method name="getSnapshotIds">
10640	<desc>
10641	Returns an array of UUIDs of all snapshots of the given machine where
10642	this medium is attached to.
10643
10644	If the medium is attached to the machine in the current state, then the
10645	first element in the array will always be the ID of the queried machine
10646	(i.e. the value equal to the @c machineId argument), followed by
10647	snapshot IDs (if any).
10648
10649	If the medium is not attached to the machine in the current state, then
10650	the array will contain only snapshot IDs.
10651
10652	The returned array may be @c null if this medium is not attached
10653	to the given machine at all, neither in the current state nor in one of
10654	the snapshots.
10655	</desc>
10656	<param name="machineId" type="uuid" mod="string" dir="in">
10657	<desc>
10658	UUID of the machine to query.
10659	</desc>
10660	</param>
10661	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10662	<desc>
10663	Array of snapshot UUIDs of the given machine using this medium.
10664	</desc>
10665	</param>
10666	</method>
10667
10668	<method name="lockRead">
10669	<desc>
10670	Locks this medium for reading.
10671
10672	A read lock is shared: many clients can simultaneously lock the
10673	same medium for reading unless it is already locked for writing (see
10674	<link to="#lockWrite"/>) in which case an error is returned.
10675
10676	When the medium is locked for reading, it cannot be modified
10677	from within VirtualBox. This means that any method that changes
10678	the properties of this medium or contents of the storage unit
10679	will return an error (unless explicitly stated otherwise). That
10680	includes an attempt to start a virtual machine that wants to
10681	write to the the medium.
10682
10683	When the virtual machine is started up, it locks for reading all
10684	media it uses in read-only mode. If some medium cannot be locked
10685	for reading, the startup procedure will fail.
10686	A medium is typically locked for reading while it is used by a running
10687	virtual machine but has a depending differencing image that receives
10688	the actual write operations. This way one base medium can have
10689	multiple child differencing images which can be written to
10690	simultaneously. Read-only media such as DVD and floppy images are
10691	also locked for reading only (so they can be in use by multiple
10692	machines simultaneously).
10693
10694	A medium is also locked for reading when it is the source of a
10695	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10696
10697	The medium locked for reading must be unlocked using the <link
10698	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10699	can be nested and must be followed by the same number of paired
10700	<link to="#unlockRead"/> calls.
10701
10702	This method sets the medium state (see <link to="#state"/>) to
10703	"LockedRead" on success. The medium's previous state must be
10704	one of "Created", "Inaccessible" or "LockedRead".
10705
10706	Locking an inaccessible medium is not an error; this method performs
10707	a logical lock that prevents modifications of this medium through
10708	the VirtualBox API, not a physical file-system lock of the underlying
10709	storage unit.
10710
10711	This method returns the current state of the medium
10712	<i>before</i> the operation.
10713
10714	<result name="VBOX_E_INVALID_OBJECT_STATE">
10715	Invalid medium state (e.g. not created, locked, inaccessible,
10716	creating, deleting).
10717	</result>
10718
10719	</desc>
10720	<param name="state" type="MediumState" dir="return">
10721	<desc>
10722	State of the medium after the operation.
10723	</desc>
10724	</param>
10725	</method>
10726
10727	<method name="unlockRead">
10728	<desc>
10729	Cancels the read lock previously set by <link to="#lockRead"/>.
10730
10731	For both success and failure, this method returns the current state
10732	of the medium <i>after</i> the operation.
10733
10734	See <link to="#lockRead"/> for more details.
10735
10736	<result name="VBOX_E_INVALID_OBJECT_STATE">
10737	Medium not locked for reading.
10738	</result>
10739
10740	</desc>
10741	<param name="state" type="MediumState" dir="return">
10742	<desc>
10743	State of the medium after the operation.
10744	</desc>
10745	</param>
10746	</method>
10747
10748	<method name="lockWrite">
10749	<desc>
10750	Locks this medium for writing.
10751
10752	A write lock, as opposed to <link to="#lockRead"/>, is
10753	exclusive: there may be only one client holding a write lock,
10754	and there may be no read locks while the write lock is held.
10755	As a result, read-locking fails if a write lock is held, and
10756	write-locking fails if either a read or another write lock is held.
10757
10758	When a medium is locked for writing, it cannot be modified
10759	from within VirtualBox, and it is not guaranteed that the values
10760	of its properties are up-to-date. Any method that changes the
10761	properties of this medium or contents of the storage unit will
10762	return an error (unless explicitly stated otherwise).
10763
10764	When a virtual machine is started up, it locks for writing all
10765	media it uses to write data to. If any medium could not be locked
10766	for writing, the startup procedure will fail. If a medium has
10767	differencing images, then while the machine is running, only
10768	the last ("leaf") differencing image is locked for writing,
10769	whereas its parents are locked for reading only.
10770
10771	A medium is also locked for writing when it is the target of a
10772	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10773
10774	The medium locked for writing must be unlocked using the <link
10775	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10776
10777	This method sets the medium state (see <link to="#state"/>) to
10778	"LockedWrite" on success. The medium's previous state must be
10779	either "Created" or "Inaccessible".
10780
10781	Locking an inaccessible medium is not an error; this method performs
10782	a logical lock that prevents modifications of this medium through
10783	the VirtualBox API, not a physical file-system lock of the underlying
10784	storage unit.
10785
10786	For both, success and failure, this method returns the current
10787	state of the medium <i>before</i> the operation.
10788
10789	<result name="VBOX_E_INVALID_OBJECT_STATE">
10790	Invalid medium state (e.g. not created, locked, inaccessible,
10791	creating, deleting).
10792	</result>
10793
10794	</desc>
10795	<param name="state" type="MediumState" dir="return">
10796	<desc>
10797	State of the medium after the operation.
10798	</desc>
10799	</param>
10800	</method>
10801
10802	<method name="unlockWrite">
10803	<desc>
10804	Cancels the write lock previously set by <link to="#lockWrite"/>.
10805
10806	For both success and failure, this method returns the current
10807	state of the medium <i>after</i> the operation.
10808
10809	See <link to="#lockWrite"/> for more details.
10810
10811	<result name="VBOX_E_INVALID_OBJECT_STATE">
10812	Medium not locked for writing.
10813	</result>
10814
10815	</desc>
10816	<param name="state" type="MediumState" dir="return">
10817	<desc>
10818	State of the medium after the operation.
10819	</desc>
10820	</param>
10821	</method>
10822
10823	<method name="close">
10824	<desc>
10825	Closes this medium.
10826
10827	The medium must not be attached to any known virtual machine
10828	and must not have any known child media, otherwise the
10829	operation will fail.
10830
10831	When the medium is successfully closed, it is removed from
10832	the list of registered media, but its storage unit is not
10833	deleted. In particular, this means that this medium can
10834	later be opened again using the <link to="IVirtualBox::openMedium"/>
10835	call.
10836
10837	Note that after this method successfully returns, the given medium
10838	object becomes uninitialized. This means that any attempt
10839	to call any of its methods or attributes will fail with the
10840	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10841
10842	<result name="VBOX_E_INVALID_OBJECT_STATE">
10843	Invalid medium state (other than not created, created or
10844	inaccessible).
10845	</result>
10846	<result name="VBOX_E_OBJECT_IN_USE">
10847	Medium attached to virtual machine.
10848	</result>
10849	<result name="VBOX_E_FILE_ERROR">
10850	Settings file not accessible.
10851	</result>
10852	<result name="VBOX_E_XML_ERROR">
10853	Could not parse the settings file.
10854	</result>
10855
10856	</desc>
10857	</method>
10858
10859	<!-- property methods -->
10860
10861	<method name="getProperty" const="yes">
10862	<desc>
10863	Returns the value of the custom medium property with the given name.
10864
10865	The list of all properties supported by the given medium format can
10866	be obtained with <link to="IMediumFormat::describeProperties"/>.
10867
10868	<note>If this method returns an empty string in @a value, the requested
10869	property is supported but currently not assigned any value.</note>
10870
10871	<result name="VBOX_E_OBJECT_NOT_FOUND">
10872	Requested property does not exist (not supported by the format).
10873	</result>
10874	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10875	</desc>
10876	<param name="name" type="wstring" dir="in">
10877	<desc>Name of the property to get.</desc>
10878	</param>
10879	<param name="value" type="wstring" dir="return">
10880	<desc>Current property value.</desc>
10881	</param>
10882	</method>
10883
10884	<method name="setProperty">
10885	<desc>
10886	Sets the value of the custom medium property with the given name.
10887
10888	The list of all properties supported by the given medium format can
10889	be obtained with <link to="IMediumFormat::describeProperties"/>.
10890
10891	<note>Setting the property value to @c null or an empty string is
10892	equivalent to deleting the existing value. A default value (if it is
10893	defined for this property) will be used by the format backend in this
10894	case.</note>
10895
10896	<result name="VBOX_E_OBJECT_NOT_FOUND">
10897	Requested property does not exist (not supported by the format).
10898	</result>
10899	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10900	</desc>
10901	<param name="name" type="wstring" dir="in">
10902	<desc>Name of the property to set.</desc>
10903	</param>
10904	<param name="value" type="wstring" dir="in">
10905	<desc>Property value to set.</desc>
10906	</param>
10907	</method>
10908
10909	<method name="getProperties" const="yes">
10910	<desc>
10911	Returns values for a group of properties in one call.
10912
10913	The names of the properties to get are specified using the @a names
10914	argument which is a list of comma-separated property names or
10915	an empty string if all properties are to be returned.
10916	<note>Currently the value of this argument is ignored and the method
10917	always returns all existing properties.</note>
10918
10919	The list of all properties supported by the given medium format can
10920	be obtained with <link to="IMediumFormat::describeProperties"/>.
10921
10922	The method returns two arrays, the array of property names corresponding
10923	to the @a names argument and the current values of these properties.
10924	Both arrays have the same number of elements with each element at the
10925	given index in the first array corresponds to an element at the same
10926	index in the second array.
10927
10928	For properties that do not have assigned values, an empty string is
10929	returned at the appropriate index in the @a returnValues array.
10930
10931	</desc>
10932	<param name="names" type="wstring" dir="in">
10933	<desc>
10934	Names of properties to get.
10935	</desc>
10936	</param>
10937	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10938	<desc>Names of returned properties.</desc>
10939	</param>
10940	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10941	<desc>Values of returned properties.</desc>
10942	</param>
10943	</method>
10944
10945	<method name="setProperties">
10946	<desc>
10947	Sets values for a group of properties in one call.
10948
10949	The names of the properties to set are passed in the @a names
10950	array along with the new values for them in the @a values array. Both
10951	arrays have the same number of elements with each element at the given
10952	index in the first array corresponding to an element at the same index
10953	in the second array.
10954
10955	If there is at least one property name in @a names that is not valid,
10956	the method will fail before changing the values of any other properties
10957	from the @a names array.
10958
10959	Using this method over <link to="#setProperty"/> is preferred if you
10960	need to set several properties at once since it is more efficient.
10961
10962	The list of all properties supported by the given medium format can
10963	be obtained with <link to="IMediumFormat::describeProperties"/>.
10964
10965	Setting the property value to @c null or an empty string is equivalent
10966	to deleting the existing value. A default value (if it is defined for
10967	this property) will be used by the format backend in this case.
10968	</desc>
10969	<param name="names" type="wstring" safearray="yes" dir="in">
10970	<desc>Names of properties to set.</desc>
10971	</param>
10972	<param name="values" type="wstring" safearray="yes" dir="in">
10973	<desc>Values of properties to set.</desc>
10974	</param>
10975	</method>
10976
10977	<!-- storage methods -->
10978
10979	<method name="createBaseStorage">
10980	<desc>
10981	Starts creating a hard disk storage unit (fixed/dynamic, according
10982	to the variant flags) in in the background. The previous storage unit
10983	created for this object, if any, must first be deleted using
10984	<link to="#deleteStorage"/>, otherwise the operation will fail.
10985
10986	Before the operation starts, the medium is placed in
10987	<link to="MediumState_Creating"/> state. If the create operation
10988	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10989	state.
10990
10991	After the returned progress object reports that the operation has
10992	successfully completed, the medium state will be set to <link
10993	to="MediumState_Created"/>, the medium will be remembered by this
10994	VirtualBox installation and may be attached to virtual machines.
10995
10996	<result name="VBOX_E_NOT_SUPPORTED">
10997	The variant of storage creation operation is not supported. See <link
10998	to="IMediumFormat::capabilities"/>.
10999	</result>
11000	</desc>
11001	<param name="logicalSize" type="long long" dir="in">
11002	<desc>Maximum logical size of the medium in bytes.</desc>
11003	</param>
11004	<param name="variant" type="unsigned long" dir="in">
11005	<desc>Exact image variant which should be created (as a combination of
11006	<link to="MediumVariant" /> flags).</desc>
11007	</param>
11008	<param name="progress" type="IProgress" dir="return">
11009	<desc>Progress object to track the operation completion.</desc>
11010	</param>
11011	</method>
11012
11013	<method name="deleteStorage">
11014	<desc>
11015	Starts deleting the storage unit of this medium.
11016
11017	The medium must not be attached to any known virtual machine and must
11018	not have any known child media, otherwise the operation will fail.
11019	It will also fail if there is no storage unit to delete or if deletion
11020	is already in progress, or if the medium is being in use (locked for
11021	read or for write) or inaccessible. Therefore, the only valid state for
11022	this operation to succeed is <link to="MediumState_Created"/>.
11023
11024	Before the operation starts, the medium is placed in
11025	<link to="MediumState_Deleting"/> state and gets removed from the list
11026	of remembered hard disks (media registry). If the delete operation
11027	fails, the medium will be remembered again and placed back to
11028	<link to="MediumState_Created"/> state.
11029
11030	After the returned progress object reports that the operation is
11031	complete, the medium state will be set to
11032	<link to="MediumState_NotCreated"/> and you will be able to use one of
11033	the storage creation methods to create it again.
11034
11035	<see><link to="#close"/></see>
11036
11037	<result name="VBOX_E_OBJECT_IN_USE">
11038	Medium is attached to a virtual machine.
11039	</result>
11040	<result name="VBOX_E_NOT_SUPPORTED">
11041	Storage deletion is not allowed because neither of storage creation
11042	operations are supported. See
11043	<link to="IMediumFormat::capabilities"/>.
11044	</result>
11045
11046	<note>
11047	If the deletion operation fails, it is not guaranteed that the storage
11048	unit still exists. You may check the <link to="IMedium::state"/> value
11049	to answer this question.
11050	</note>
11051	</desc>
11052	<param name="progress" type="IProgress" dir="return">
11053	<desc>Progress object to track the operation completion.</desc>
11054	</param>
11055	</method>
11056
11057	<!-- diff methods -->
11058
11059	<method name="createDiffStorage">
11060	<desc>
11061	Starts creating an empty differencing storage unit based on this
11062	medium in the format and at the location defined by the @a target
11063	argument.
11064
11065	The target medium must be in <link to="MediumState_NotCreated"/>
11066	state (i.e. must not have an existing storage unit). Upon successful
11067	completion, this operation will set the type of the target medium to
11068	<link to="MediumType_Normal"/> and create a storage unit necessary to
11069	represent the differencing medium data in the given format (according
11070	to the storage format of the target object).
11071
11072	After the returned progress object reports that the operation is
11073	successfully complete, the target medium gets remembered by this
11074	VirtualBox installation and may be attached to virtual machines.
11075
11076	<note>
11077	The medium will be set to <link to="MediumState_LockedRead"/>
11078	state for the duration of this operation.
11079	</note>
11080	<result name="VBOX_E_OBJECT_IN_USE">
11081	Medium not in @c NotCreated state.
11082	</result>
11083	</desc>
11084	<param name="target" type="IMedium" dir="in">
11085	<desc>Target medium.</desc>
11086	</param>
11087	<param name="variant" type="unsigned long" dir="in">
11088	<desc>Exact image variant which should be created (as a combination of
11089	<link to="MediumVariant" /> flags).</desc>
11090	</param>
11091	<param name="progress" type="IProgress" dir="return">
11092	<desc>Progress object to track the operation completion.</desc>
11093	</param>
11094	</method>
11095
11096	<method name="mergeTo">
11097	<desc>
11098	Starts merging the contents of this medium and all intermediate
11099	differencing media in the chain to the given target medium.
11100
11101	The target medium must be either a descendant of this medium or
11102	its ancestor (otherwise this method will immediately return a failure).
11103	It follows that there are two logical directions of the merge operation:
11104	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11105	ancestor (<i>backward merge</i>). Let us consider the following medium
11106	chain:
11107
11108	<pre>Base <- Diff_1 <- Diff_2</pre>
11109
11110	Here, calling this method on the <tt>Base</tt> medium object with
11111	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11112	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11113	merge. Note that in both cases the contents of the resulting medium
11114	will be the same, the only difference is the medium object that takes
11115	the result of the merge operation. In case of the forward merge in the
11116	above example, the result will be written to <tt>Diff_2</tt>; in case of
11117	the backward merge, the result will be written to <tt>Base</tt>. In
11118	other words, the result of the operation is always stored in the target
11119	medium.
11120
11121	Upon successful operation completion, the storage units of all media in
11122	the chain between this (source) medium and the target medium, including
11123	the source medium itself, will be automatically deleted and the
11124	relevant medium objects (including this medium) will become
11125	uninitialized. This means that any attempt to call any of
11126	their methods or attributes will fail with the
11127	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11128	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11129	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11130	Note that <tt>Diff_2</tt> in this case will become a base medium
11131	itself since it will no longer be based on any other medium.
11132
11133	Considering the above, all of the following conditions must be met in
11134	order for the merge operation to succeed:
11135	<ul>
11136	<li>
11137	Neither this (source) medium nor any intermediate
11138	differencing medium in the chain between it and the target
11139	medium is attached to any virtual machine.
11140	</li>
11141	<li>
11142	Neither the source medium nor the target medium is an
11143	<link to="MediumType_Immutable"/> medium.
11144	</li>
11145	<li>
11146	The part of the medium tree from the source medium to the
11147	target medium is a linear chain, i.e. all medium in this
11148	chain have exactly one child which is the next medium in this
11149	chain. The only exception from this rule is the target medium in
11150	the forward merge operation; it is allowed to have any number of
11151	child media because the merge operation will not change its
11152	logical contents (as it is seen by the guest OS or by children).
11153	</li>
11154	<li>
11155	None of the involved media are in
11156	<link to="MediumState_LockedRead"/> or
11157	<link to="MediumState_LockedWrite"/> state.
11158	</li>
11159	</ul>
11160
11161	<note>
11162	This (source) medium and all intermediates will be placed to <link
11163	to="MediumState_Deleting"/> state and the target medium will be
11164	placed to <link to="MediumState_LockedWrite"/> state and for the
11165	duration of this operation.
11166	</note>
11167	</desc>
11168	<param name="target" type="IMedium" dir="in">
11169	<desc>Target medium.</desc>
11170	</param>
11171	<param name="progress" type="IProgress" dir="return">
11172	<desc>Progress object to track the operation completion.</desc>
11173	</param>
11174	</method>
11175
11176	<!-- clone method -->
11177
11178	<method name="cloneTo">
11179	<desc>
11180	Starts creating a clone of this medium in the format and at the
11181	location defined by the @a target argument.
11182
11183	The target medium must be either in <link to="MediumState_NotCreated"/>
11184	state (i.e. must not have an existing storage unit) or in
11185	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11186	big enough to hold the data or else the copy will be partial). Upon
11187	successful completion, the cloned medium will contain exactly the
11188	same sector data as the medium being cloned, except that in the
11189	first case a new UUID for the clone will be randomly generated, and in
11190	the second case the UUID will remain unchanged.
11191
11192	The @a parent argument defines which medium will be the parent
11193	of the clone. Passing a @c null reference indicates that the clone will
11194	be a base image, i.e. completely independent. It is possible to specify
11195	an arbitrary medium for this parameter, including the parent of the
11196	medium which is being cloned. Even cloning to a child of the source
11197	medium is possible. Note that when cloning to an existing image, the
11198	@a parent argument is ignored.
11199
11200	After the returned progress object reports that the operation is
11201	successfully complete, the target medium gets remembered by this
11202	VirtualBox installation and may be attached to virtual machines.
11203
11204	<note>
11205	This medium will be placed to <link to="MediumState_LockedRead"/>
11206	state for the duration of this operation.
11207	</note>
11208	<result name="E_NOTIMPL">
11209	The specified cloning variant is not supported at the moment.
11210	</result>
11211	</desc>
11212	<param name="target" type="IMedium" dir="in">
11213	<desc>Target medium.</desc>
11214	</param>
11215	<param name="variant" type="unsigned long" dir="in">
11216	<desc>Exact image variant which should be created (as a combination of
11217	<link to="MediumVariant" /> flags).</desc>
11218	</param>
11219	<param name="parent" type="IMedium" dir="in">
11220	<desc>Parent of the cloned medium.</desc>
11221	</param>
11222	<param name="progress" type="IProgress" dir="return">
11223	<desc>Progress object to track the operation completion.</desc>
11224	</param>
11225	</method>
11226
11227	<!-- other methods -->
11228
11229	<method name="compact">
11230	<desc>
11231	Starts compacting of this medium. This means that the medium is
11232	transformed into a possibly more compact storage representation.
11233	This potentially creates temporary images, which can require a
11234	substantial amount of additional disk space.
11235
11236	This medium will be placed to <link to="MediumState_LockedWrite"/>
11237	state and all its parent media (if any) will be placed to
11238	<link to="MediumState_LockedRead"/> state for the duration of this
11239	operation.
11240
11241	Please note that the results can be either returned straight away,
11242	or later as the result of the background operation via the object
11243	returned via the @a progress parameter.
11244
11245	<result name="VBOX_E_NOT_SUPPORTED">
11246	Medium format does not support compacting (but potentially
11247	needs it).
11248	</result>
11249	</desc>
11250	<param name="progress" type="IProgress" dir="return">
11251	<desc>Progress object to track the operation completion.</desc>
11252	</param>
11253	</method>
11254
11255	<method name="resize">
11256	<desc>
11257	Starts resizing this medium. This means that the nominal size of the
11258	medium is set to the new value. Both increasing and decreasing the
11259	size is possible, and there are no safety checks, since VirtualBox
11260	does not make any assumptions about the medium contents.
11261
11262	Resizing usually needs additional disk space, and possibly also
11263	some temporary disk space. Note that resize does not create a full
11264	temporary copy of the medium, so the additional disk space requirement
11265	is usually much lower than using the clone operation.
11266
11267	This medium will be placed to <link to="MediumState_LockedWrite"/>
11268	state for the duration of this operation.
11269
11270	Please note that the results can be either returned straight away,
11271	or later as the result of the background operation via the object
11272	returned via the @a progress parameter.
11273
11274	<result name="VBOX_E_NOT_SUPPORTED">
11275	Medium format does not support resizing.
11276	</result>
11277	</desc>
11278	<param name="logicalSize" type="long long" dir="in">
11279	<desc>New nominal capacity of the medium in bytes.</desc>
11280	</param>
11281	<param name="progress" type="IProgress" dir="return">
11282	<desc>Progress object to track the operation completion.</desc>
11283	</param>
11284	</method>
11285
11286	<method name="reset">
11287	<desc>
11288	Starts erasing the contents of this differencing medium.
11289
11290	This operation will reset the differencing medium to its initial
11291	state when it does not contain any sector data and any read operation is
11292	redirected to its parent medium. This automatically gets called
11293	during VM power-up for every medium whose <link to="#autoReset" />
11294	attribute is @c true.
11295
11296	The medium will be write-locked for the duration of this operation (see
11297	<link to="#lockWrite" />).
11298
11299	<result name="VBOX_E_NOT_SUPPORTED">
11300	This is not a differencing medium.
11301	</result>
11302	<result name="VBOX_E_INVALID_OBJECT_STATE">
11303	Medium is not in <link to="MediumState_Created"/> or
11304	<link to="MediumState_Inaccessible"/> state.
11305	</result>
11306	</desc>
11307	<param name="progress" type="IProgress" dir="return">
11308	<desc>Progress object to track the operation completion.</desc>
11309	</param>
11310	</method>
11311
11312	</interface>
11313
11314
11315	<!--
11316	// IMediumFormat
11317	/////////////////////////////////////////////////////////////////////////
11318	-->
11319
11320	<enum
11321	name="DataType"
11322	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11323	>
11324	<const name="Int32" value="0"/>
11325	<const name="Int8" value="1"/>
11326	<const name="String" value="2"/>
11327	</enum>
11328
11329	<enum
11330	name="DataFlags"
11331	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11332	>
11333	<const name="None" value="0x00"/>
11334	<const name="Mandatory" value="0x01"/>
11335	<const name="Expert" value="0x02"/>
11336	<const name="Array" value="0x04"/>
11337	<const name="FlagMask" value="0x07"/>
11338	</enum>
11339
11340	<enum
11341	name="MediumFormatCapabilities"
11342	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11343	>
11344	<desc>
11345	Medium format capability flags.
11346	</desc>
11347
11348	<const name="Uuid" value="0x01">
11349	<desc>
11350	Supports UUIDs as expected by VirtualBox code.
11351	</desc>
11352	</const>
11353
11354	<const name="CreateFixed" value="0x02">
11355	<desc>
11356	Supports creating fixed size images, allocating all space instantly.
11357	</desc>
11358	</const>
11359
11360	<const name="CreateDynamic" value="0x04">
11361	<desc>
11362	Supports creating dynamically growing images, allocating space on
11363	demand.
11364	</desc>
11365	</const>
11366
11367	<const name="CreateSplit2G" value="0x08">
11368	<desc>
11369	Supports creating images split in chunks of a bit less than 2 GBytes.
11370	</desc>
11371	</const>
11372
11373	<const name="Differencing" value="0x10">
11374	<desc>
11375	Supports being used as a format for differencing media (see <link
11376	to="IMedium::createDiffStorage"/>).
11377	</desc>
11378	</const>
11379
11380	<const name="Asynchronous" value="0x20">
11381	<desc>
11382	Supports asynchronous I/O operations for at least some configurations.
11383	</desc>
11384	</const>
11385
11386	<const name="File" value="0x40">
11387	<desc>
11388	The format backend operates on files (the <link to="IMedium::location"/>
11389	attribute of the medium specifies a file used to store medium
11390	data; for a list of supported file extensions see
11391	<link to="IMediumFormat::describeFileExtensions"/>).
11392	</desc>
11393	</const>
11394
11395	<const name="Properties" value="0x80">
11396	<desc>
11397	The format backend uses the property interface to configure the storage
11398	location and properties (the <link to="IMediumFormat::describeProperties"/>
11399	method is used to get access to properties supported by the given medium format).
11400	</desc>
11401	</const>
11402
11403	<const name="TcpNetworking" value="0x100">
11404	<desc>
11405	The format backend uses the TCP networking interface for network access.
11406	</desc>
11407	</const>
11408
11409	<const name="VFS" value="0x200">
11410	<desc>
11411	The format backend supports virtual filesystem functionality.
11412	</desc>
11413	</const>
11414
11415	<const name="CapabilityMask" value="0x3FF"/>
11416	</enum>
11417
11418	<interface
11419	name="IMediumFormat" extends="$unknown"
11420	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11421	wsmap="managed"
11422	>
11423	<desc>
11424	The IMediumFormat interface represents a medium format.
11425
11426	Each medium format has an associated backend which is used to handle
11427	media stored in this format. This interface provides information
11428	about the properties of the associated backend.
11429
11430	Each medium format is identified by a string represented by the
11431	<link to="#id"/> attribute. This string is used in calls like
11432	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11433	format.
11434
11435	The list of all supported medium formats can be obtained using
11436	<link to="ISystemProperties::mediumFormats"/>.
11437
11438	<see><link to="IMedium"/></see>
11439	</desc>
11440
11441	<attribute name="id" type="wstring" readonly="yes">
11442	<desc>
11443	Identifier of this format.
11444
11445	The format identifier is a non-@c null non-empty ASCII string. Note that
11446	this string is case-insensitive. This means that, for example, all of
11447	the following strings:
11448	<pre>
11449	"VDI"
11450	"vdi"
11451	"VdI"</pre>
11452	refer to the same medium format.
11453
11454	This string is used in methods of other interfaces where it is necessary
11455	to specify a medium format, such as
11456	<link to="IVirtualBox::createHardDisk"/>.
11457	</desc>
11458	</attribute>
11459
11460	<attribute name="name" type="wstring" readonly="yes">
11461	<desc>
11462	Human readable description of this format.
11463
11464	Mainly for use in file open dialogs.
11465	</desc>
11466	</attribute>
11467
11468	<attribute name="capabilities" type="unsigned long" readonly="yes">
11469	<desc>
11470	Capabilities of the format as a set of bit flags.
11471
11472	For the meaning of individual capability flags see
11473	<link to="MediumFormatCapabilities"/>.
11474	</desc>
11475	</attribute>
11476
11477	<method name="describeFileExtensions">
11478	<desc>
11479	Returns two arrays describing the supported file extensions.
11480
11481	The first array contains the supported extensions and the seconds one
11482	the type each extension supports. Both have the same size.
11483
11484	Note that some backends do not work on files, so this array may be
11485	empty.
11486
11487	<see><link to="IMediumFormat::capabilities"/></see>
11488	</desc>
11489	<param name="extensions" type="wstring" safearray="yes" dir="out">
11490	<desc>The array of supported extensions.</desc>
11491	</param>
11492	<param name="type" type="DeviceType" safearray="yes" dir="out">
11493	<desc>The array which indicates the device type for every given extension.</desc>
11494	</param>
11495	</method>
11496
11497	<method name="describeProperties" const="yes">
11498	<desc>
11499	Returns several arrays describing the properties supported by this
11500	format.
11501
11502	An element with the given index in each array describes one
11503	property. Thus, the number of elements in each returned array is the
11504	same and corresponds to the number of supported properties.
11505
11506	The returned arrays are filled in only if the
11507	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11508	All arguments must be non-@c null.
11509
11510	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11511	</desc>
11512
11513	<param name="names" type="wstring" safearray="yes" dir="out">
11514	<desc>Array of property names.</desc>
11515	</param>
11516	<param name="description" type="wstring" safearray="yes" dir="out">
11517	<desc>Array of property descriptions.</desc>
11518	</param>
11519	<param name="types" type="DataType" safearray="yes" dir="out">
11520	<desc>Array of property types.</desc>
11521	</param>
11522	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11523	<desc>Array of property flags.</desc>
11524	</param>
11525	<param name="defaults" type="wstring" safearray="yes" dir="out">
11526	<desc>Array of default property values.</desc>
11527	</param>
11528	</method>
11529
11530	</interface>
11531
11532
11533	<!--
11534	// IKeyboard
11535	/////////////////////////////////////////////////////////////////////////
11536	-->
11537
11538	<interface
11539	name="IKeyboard" extends="$unknown"
11540	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11541	wsmap="managed"
11542	>
11543	<desc>
11544	The IKeyboard interface represents the virtual machine's keyboard. Used
11545	in <link to="IConsole::keyboard"/>.
11546
11547	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11548	to the virtual machine.
11549
11550	</desc>
11551	<method name="putScancode">
11552	<desc>Sends a scancode to the keyboard.
11553
11554	<result name="VBOX_E_IPRT_ERROR">
11555	Could not send scan code to virtual keyboard.
11556	</result>
11557
11558	</desc>
11559	<param name="scancode" type="long" dir="in"/>
11560	</method>
11561
11562	<method name="putScancodes">
11563	<desc>Sends an array of scancodes to the keyboard.
11564
11565	<result name="VBOX_E_IPRT_ERROR">
11566	Could not send all scan codes to virtual keyboard.
11567	</result>
11568
11569	</desc>
11570	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11571	<param name="codesStored" type="unsigned long" dir="return"/>
11572	</method>
11573
11574	<method name="putCAD">
11575	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11576	function is nothing special, it is just a convenience function
11577	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11578
11579	<result name="VBOX_E_IPRT_ERROR">
11580	Could not send all scan codes to virtual keyboard.
11581	</result>
11582
11583	</desc>
11584	</method>
11585
11586	<attribute name="eventSource" type="IEventSource" readonly="yes">
11587	<desc>
11588	Event source for keyboard events.
11589	</desc>
11590	</attribute>
11591
11592	</interface>
11593
11594
11595	<!--
11596	// IMouse
11597	/////////////////////////////////////////////////////////////////////////
11598	-->
11599
11600	<enum
11601	name="MouseButtonState"
11602	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11603	>
11604	<desc>
11605	Mouse button state.
11606	</desc>
11607
11608	<const name="LeftButton" value="0x01"/>
11609	<const name="RightButton" value="0x02"/>
11610	<const name="MiddleButton" value="0x04"/>
11611	<const name="WheelUp" value="0x08"/>
11612	<const name="WheelDown" value="0x10"/>
11613	<const name="XButton1" value="0x20"/>
11614	<const name="XButton2" value="0x40"/>
11615	<const name="MouseStateMask" value="0x7F"/>
11616	</enum>
11617
11618	<interface
11619	name="IMouse" extends="$unknown"
11620	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11621	wsmap="managed"
11622	>
11623	<desc>
11624	The IMouse interface represents the virtual machine's mouse. Used in
11625	<link to="IConsole::mouse"/>.
11626
11627	Through this interface, the virtual machine's virtual mouse can be
11628	controlled.
11629	</desc>
11630
11631	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11632	<desc>
11633	Whether the guest OS supports absolute mouse pointer positioning
11634	or not.
11635	<note>
11636	You can use the <link to="IMouseCapabilityChangedEvent"/>
11637	event to be instantly informed about changes of this attribute
11638	during virtual machine execution.
11639	</note>
11640	<see><link to="#putMouseEventAbsolute"/></see>
11641	</desc>
11642	</attribute>
11643
11644	<attribute name="relativeSupported" type="boolean" readonly="yes">
11645	<desc>
11646	Whether the guest OS supports relative mouse pointer positioning
11647	or not.
11648	<note>
11649	You can use the <link to="IMouseCapabilityChangedEvent"/>
11650	event to be instantly informed about changes of this attribute
11651	during virtual machine execution.
11652	</note>
11653	<see><link to="#putMouseEvent"/></see>
11654	</desc>
11655	</attribute>
11656
11657	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11658	<desc>
11659	Whether the guest OS can currently switch to drawing it's own mouse
11660	cursor on demand.
11661	<note>
11662	You can use the <link to="IMouseCapabilityChangedEvent"/>
11663	event to be instantly informed about changes of this attribute
11664	during virtual machine execution.
11665	</note>
11666	<see><link to="#putMouseEvent"/></see>
11667	</desc>
11668	</attribute>
11669
11670	<method name="putMouseEvent">
11671	<desc>
11672	Initiates a mouse event using relative pointer movements
11673	along x and y axis.
11674
11675	<result name="E_ACCESSDENIED">
11676	Console not powered up.
11677	</result>
11678	<result name="VBOX_E_IPRT_ERROR">
11679	Could not send mouse event to virtual mouse.
11680	</result>
11681
11682	</desc>
11683
11684	<param name="dx" type="long" dir="in">
11685	<desc>
11686	Amount of pixels the mouse should move to the right.
11687	Negative values move the mouse to the left.
11688	</desc>
11689	</param>
11690	<param name="dy" type="long" dir="in">
11691	<desc>
11692	Amount of pixels the mouse should move downwards.
11693	Negative values move the mouse upwards.
11694	</desc>
11695	</param>
11696	<param name="dz" type="long" dir="in">
11697	<desc>
11698	Amount of mouse wheel moves.
11699	Positive values describe clockwise wheel rotations,
11700	negative values describe counterclockwise rotations.
11701	</desc>
11702	</param>
11703	<param name="dw" type="long" dir="in">
11704	<desc>
11705	Amount of horizontal mouse wheel moves.
11706	Positive values describe a movement to the left,
11707	negative values describe a movement to the right.
11708	</desc>
11709	</param>
11710	<param name="buttonState" type="long" dir="in">
11711	<desc>
11712	The current state of mouse buttons. Every bit represents
11713	a mouse button as follows:
11714	<table>
11715	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11716	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11717	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11718	</table>
11719	A value of <tt>1</tt> means the corresponding button is pressed.
11720	otherwise it is released.
11721	</desc>
11722	</param>
11723	</method>
11724
11725	<method name="putMouseEventAbsolute">
11726	<desc>
11727	Positions the mouse pointer using absolute x and y coordinates.
11728	These coordinates are expressed in pixels and
11729	start from <tt>[1,1]</tt> which corresponds to the top left
11730	corner of the virtual display.
11731
11732	<result name="E_ACCESSDENIED">
11733	Console not powered up.
11734	</result>
11735	<result name="VBOX_E_IPRT_ERROR">
11736	Could not send mouse event to virtual mouse.
11737	</result>
11738
11739	<note>
11740	This method will have effect only if absolute mouse
11741	positioning is supported by the guest OS.
11742	</note>
11743
11744	<see><link to="#absoluteSupported"/></see>
11745	</desc>
11746
11747	<param name="x" type="long" dir="in">
11748	<desc>
11749	X coordinate of the pointer in pixels, starting from @c 1.
11750	</desc>
11751	</param>
11752	<param name="y" type="long" dir="in">
11753	<desc>
11754	Y coordinate of the pointer in pixels, starting from @c 1.
11755	</desc>
11756	</param>
11757	<param name="dz" type="long" dir="in">
11758	<desc>
11759	Amount of mouse wheel moves.
11760	Positive values describe clockwise wheel rotations,
11761	negative values describe counterclockwise rotations.
11762	</desc>
11763	</param>
11764	<param name="dw" type="long" dir="in">
11765	<desc>
11766	Amount of horizontal mouse wheel moves.
11767	Positive values describe a movement to the left,
11768	negative values describe a movement to the right.
11769	</desc>
11770	</param>
11771	<param name="buttonState" type="long" dir="in">
11772	<desc>
11773	The current state of mouse buttons. Every bit represents
11774	a mouse button as follows:
11775	<table>
11776	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11777	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11778	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11779	</table>
11780	A value of @c 1 means the corresponding button is pressed.
11781	otherwise it is released.
11782	</desc>
11783	</param>
11784	</method>
11785
11786	<attribute name="eventSource" type="IEventSource" readonly="yes">
11787	<desc>
11788	Event source for mouse events.
11789	</desc>
11790	</attribute>
11791
11792	</interface>
11793
11794	<!--
11795	// IDisplay
11796	/////////////////////////////////////////////////////////////////////////
11797	-->
11798
11799	<enum
11800	name="FramebufferPixelFormat"
11801	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11802	>
11803	<desc>
11804	Format of the video memory buffer. Constants represented by this enum can
11805	be used to test for particular values of <link
11806	to="IFramebuffer::pixelFormat"/>. See also <link
11807	to="IFramebuffer::requestResize"/>.
11808
11809	See also www.fourcc.org for more information about FOURCC pixel formats.
11810	</desc>
11811
11812	<const name="Opaque" value="0">
11813	<desc>
11814	Unknown buffer format (the user may not assume any particular format of
11815	the buffer).
11816	</desc>
11817	</const>
11818	<const name="FOURCC_RGB" value="0x32424752">
11819	<desc>
11820	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11821	bit layout).
11822	</desc>
11823	</const>
11824	</enum>
11825
11826	<interface
11827	name="IFramebuffer" extends="$unknown"
11828	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11829	wsmap="suppress"
11830	>
11831	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11832	<desc>Address of the start byte of the frame buffer.</desc>
11833	</attribute>
11834
11835	<attribute name="width" type="unsigned long" readonly="yes">
11836	<desc>Frame buffer width, in pixels.</desc>
11837	</attribute>
11838
11839	<attribute name="height" type="unsigned long" readonly="yes">
11840	<desc>Frame buffer height, in pixels.</desc>
11841	</attribute>
11842
11843	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11844	<desc>
11845	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11846	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11847	are: 8, 15, 16, 24 and 32.
11848	</desc>
11849	</attribute>
11850
11851	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11852	<desc>
11853	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11854	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11855	size of the scan line must be aligned to 32 bits.
11856	</desc>
11857	</attribute>
11858
11859	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11860	<desc>
11861	Frame buffer pixel format. It's either one of the values defined by <link
11862	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11863	<note>
11864	This attribute must never return <link
11865	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11866	<link to="#address"/> points to must be always known.
11867	</note>
11868	</desc>
11869	</attribute>
11870
11871	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11872	<desc>
11873	Defines whether this frame buffer uses the virtual video card's memory
11874	buffer (guest VRAM) directly or not. See <link
11875	to="IFramebuffer::requestResize"/> for more information.
11876	</desc>
11877	</attribute>
11878
11879	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11880	<desc>
11881	Hint from the frame buffer about how much of the standard
11882	screen height it wants to use for itself. This information is
11883	exposed to the guest through the VESA BIOS and VMMDev interface
11884	so that it can use it for determining its video mode table. It
11885	is not guaranteed that the guest respects the value.
11886	</desc>
11887	</attribute>
11888
11889	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11890	<desc>
11891	An alpha-blended overlay which is superposed over the frame buffer.
11892	The initial purpose is to allow the display of icons providing
11893	information about the VM state, including disk activity, in front
11894	ends which do not have other means of doing that. The overlay is
11895	designed to controlled exclusively by IDisplay. It has no locking
11896	of its own, and any changes made to it are not guaranteed to be
11897	visible until the affected portion of IFramebuffer is updated. The
11898	overlay can be created lazily the first time it is requested. This
11899	attribute can also return @c null to signal that the overlay is not
11900	implemented.
11901	</desc>
11902	</attribute>
11903
11904	<attribute name="winId" type="long long" readonly="yes">
11905	<desc>
11906	Platform-dependent identifier of the window where context of this
11907	frame buffer is drawn, or zero if there's no such window.
11908	</desc>
11909	</attribute>
11910
11911	<method name="lock">
11912	<desc>
11913	Locks the frame buffer.
11914	Gets called by the IDisplay object where this frame buffer is
11915	bound to.
11916	</desc>
11917	</method>
11918
11919	<method name="unlock">
11920	<desc>
11921	Unlocks the frame buffer.
11922	Gets called by the IDisplay object where this frame buffer is
11923	bound to.
11924	</desc>
11925	</method>
11926
11927	<method name="notifyUpdate">
11928	<desc>
11929	Informs about an update.
11930	Gets called by the display object where this buffer is
11931	registered.
11932	</desc>
11933	<param name="x" type="unsigned long" dir="in"/>
11934	<param name="y" type="unsigned long" dir="in"/>
11935	<param name="width" type="unsigned long" dir="in"/>
11936	<param name="height" type="unsigned long" dir="in"/>
11937	</method>
11938
11939	<method name="requestResize">
11940	<desc>
11941	Requests a size and pixel format change.
11942
11943	There are two modes of working with the video buffer of the virtual
11944	machine. The <i>indirect</i> mode implies that the IFramebuffer
11945	implementation allocates a memory buffer for the requested display mode
11946	and provides it to the virtual machine. In <i>direct</i> mode, the
11947	IFramebuffer implementation uses the memory buffer allocated and owned
11948	by the virtual machine. This buffer represents the video memory of the
11949	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11950	usually faster because the implementation gets a raw pointer to the
11951	guest VRAM buffer which it can directly use for visualizing the contents
11952	of the virtual display, as opposed to the indirect mode where the
11953	contents of guest VRAM are copied to the memory buffer provided by
11954	the implementation every time a display update occurs.
11955
11956	It is important to note that the direct mode is really fast only when
11957	the implementation uses the given guest VRAM buffer directly, for
11958	example, by blitting it to the window representing the virtual machine's
11959	display, which saves at least one copy operation comparing to the
11960	indirect mode. However, using the guest VRAM buffer directly is not
11961	always possible: the format and the color depth of this buffer may be
11962	not supported by the target window, or it may be unknown (opaque) as in
11963	case of text or non-linear multi-plane VGA video modes. In this case,
11964	the indirect mode (that is always available) should be used as a
11965	fallback: when the guest VRAM contents are copied to the
11966	implementation-provided memory buffer, color and format conversion is
11967	done automatically by the underlying code.
11968
11969	The @a pixelFormat parameter defines whether the direct mode is
11970	available or not. If @a pixelFormat is <link
11971	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11972	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11973	@a bytesPerLine parameters must be ignored and the implementation must use
11974	the indirect mode (where it provides its own buffer in one of the
11975	supported formats). In all other cases, @a pixelFormat together with
11976	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11977	buffer pointed to by the @a VRAM parameter and the implementation is
11978	free to choose which mode to use. To indicate that this frame buffer uses
11979	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11980	attribute must return @c true and <link to="#address"/> must
11981	return exactly the same address that is passed in the @a VRAM parameter
11982	of this method; otherwise it is assumed that the indirect strategy is
11983	chosen.
11984
11985	The @a width and @a height parameters represent the size of the
11986	requested display mode in both modes. In case of indirect mode, the
11987	provided memory buffer should be big enough to store data of the given
11988	display mode. In case of direct mode, it is guaranteed that the given
11989	@a VRAM buffer contains enough space to represent the display mode of the
11990	given size. Note that this frame buffer's <link to="#width"/> and <link
11991	to="#height"/> attributes must return exactly the same values as
11992	passed to this method after the resize is completed (see below).
11993
11994	The @a finished output parameter determines if the implementation has
11995	finished resizing the frame buffer or not. If, for some reason, the
11996	resize cannot be finished immediately during this call, @a finished
11997	must be set to @c false, and the implementation must call
11998	<link to="IDisplay::resizeCompleted"/> after it has returned from
11999	this method as soon as possible. If @a finished is @c false, the
12000	machine will not call any frame buffer methods until
12001	<link to="IDisplay::resizeCompleted"/> is called.
12002
12003	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12004	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12005	this frame buffer must return exactly the same values as specified in the
12006	parameters of this method, after the resize is completed. If the
12007	indirect mode is chosen, these attributes must return values describing
12008	the format of the implementation's own memory buffer <link
12009	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12010	value must always correlate with <link to="#pixelFormat"/>. Note that
12011	the <link to="#pixelFormat"/> attribute must never return <link
12012	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12013
12014	<note>
12015	This method is called by the IDisplay object under the
12016	<link to="#lock"/> provided by this IFramebuffer
12017	implementation. If this method returns @c false in @a finished, then
12018	this lock is not released until
12019	<link to="IDisplay::resizeCompleted"/> is called.
12020	</note>
12021	</desc>
12022	<param name="screenId" type="unsigned long" dir="in">
12023	<desc>
12024	Logical screen number. Must be used in the corresponding call to
12025	<link to="IDisplay::resizeCompleted"/> if this call is made.
12026	</desc>
12027	</param>
12028	<param name="pixelFormat" type="unsigned long" dir="in">
12029	<desc>
12030	Pixel format of the memory buffer pointed to by @a VRAM.
12031	See also <link to="FramebufferPixelFormat"/>.
12032	</desc>
12033	</param>
12034	<param name="VRAM" type="octet" mod="ptr" dir="in">
12035	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12036	</param>
12037	<param name="bitsPerPixel" type="unsigned long" dir="in">
12038	<desc>Color depth, bits per pixel.</desc>
12039	</param>
12040	<param name="bytesPerLine" type="unsigned long" dir="in">
12041	<desc>Size of one scan line, in bytes.</desc>
12042	</param>
12043	<param name="width" type="unsigned long" dir="in">
12044	<desc>Width of the guest display, in pixels.</desc>
12045	</param>
12046	<param name="height" type="unsigned long" dir="in">
12047	<desc>Height of the guest display, in pixels.</desc>
12048	</param>
12049	<param name="finished" type="boolean" dir="return">
12050	<desc>
12051	Can the VM start using the new frame buffer immediately
12052	after this method returns or it should wait for
12053	<link to="IDisplay::resizeCompleted"/>.
12054	</desc>
12055	</param>
12056	</method>
12057
12058	<method name="videoModeSupported">
12059	<desc>
12060	Returns whether the frame buffer implementation is willing to
12061	support a given video mode. In case it is not able to render
12062	the video mode (or for some reason not willing), it should
12063	return @c false. Usually this method is called when the guest
12064	asks the VMM device whether a given video mode is supported
12065	so the information returned is directly exposed to the guest.
12066	It is important that this method returns very quickly.
12067	</desc>
12068	<param name="width" type="unsigned long" dir="in"/>
12069	<param name="height" type="unsigned long" dir="in"/>
12070	<param name="bpp" type="unsigned long" dir="in"/>
12071	<param name="supported" type="boolean" dir="return"/>
12072	</method>
12073
12074	<method name="getVisibleRegion">
12075	<desc>
12076	Returns the visible region of this frame buffer.
12077
12078	If the @a rectangles parameter is @c null then the value of the
12079	@a count parameter is ignored and the number of elements necessary to
12080	describe the current visible region is returned in @a countCopied.
12081
12082	If @a rectangles is not @c null but @a count is less
12083	than the required number of elements to store region data, the method
12084	will report a failure. If @a count is equal or greater than the
12085	required number of elements, then the actual number of elements copied
12086	to the provided array will be returned in @a countCopied.
12087
12088	<note>
12089	The address of the provided array must be in the process space of
12090	this IFramebuffer object.
12091	</note>
12092	<note>
12093	Method not yet implemented.
12094	</note>
12095	</desc>
12096	<param name="rectangles" type="octet" mod="ptr" dir="in">
12097	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12098	</param>
12099	<param name="count" type="unsigned long" dir="in">
12100	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12101	</param>
12102	<param name="countCopied" type="unsigned long" dir="return">
12103	<desc>Number of elements copied to the @a rectangles array.</desc>
12104	</param>
12105	</method>
12106
12107	<method name="setVisibleRegion">
12108	<desc>
12109	Suggests a new visible region to this frame buffer. This region
12110	represents the area of the VM display which is a union of regions of
12111	all top-level windows of the guest operating system running inside the
12112	VM (if the Guest Additions for this system support this
12113	functionality). This information may be used by the frontends to
12114	implement the seamless desktop integration feature.
12115
12116	<note>
12117	The address of the provided array must be in the process space of
12118	this IFramebuffer object.
12119	</note>
12120	<note>
12121	The IFramebuffer implementation must make a copy of the provided
12122	array of rectangles.
12123	</note>
12124	<note>
12125	Method not yet implemented.
12126	</note>
12127	</desc>
12128	<param name="rectangles" type="octet" mod="ptr" dir="in">
12129	<desc>Pointer to the @c RTRECT array.</desc>
12130	</param>
12131	<param name="count" type="unsigned long" dir="in">
12132	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12133	</param>
12134	</method>
12135
12136	<method name="processVHWACommand">
12137	<desc>
12138	Posts a Video HW Acceleration Command to the frame buffer for processing.
12139	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12140	are posted from quest to the host to be processed by the host hardware.
12141
12142	<note>
12143	The address of the provided command must be in the process space of
12144	this IFramebuffer object.
12145	</note>
12146	</desc>
12147
12148	<param name="command" type="octet" mod="ptr" dir="in">
12149	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12150	</param>
12151	</method>
12152
12153	</interface>
12154
12155	<interface
12156	name="IFramebufferOverlay" extends="IFramebuffer"
12157	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12158	wsmap="suppress"
12159	>
12160	<desc>
12161	The IFramebufferOverlay interface represents an alpha blended overlay
12162	for displaying status icons above an IFramebuffer. It is always created
12163	not visible, so that it must be explicitly shown. It only covers a
12164	portion of the IFramebuffer, determined by its width, height and
12165	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12166	that order) format, and may be written to directly. Do re-read the
12167	width though, after setting it, as it may be adjusted (increased) to
12168	make it more suitable for the front end.
12169	</desc>
12170	<attribute name="x" type="unsigned long" readonly="yes">
12171	<desc>X position of the overlay, relative to the frame buffer.</desc>
12172	</attribute>
12173
12174	<attribute name="y" type="unsigned long" readonly="yes">
12175	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12176	</attribute>
12177
12178	<attribute name="visible" type="boolean" readonly="no">
12179	<desc>
12180	Whether the overlay is currently visible.
12181	</desc>
12182	</attribute>
12183
12184	<attribute name="alpha" type="unsigned long" readonly="no">
12185	<desc>
12186	The global alpha value for the overlay. This may or may not be
12187	supported by a given front end.
12188	</desc>
12189	</attribute>
12190
12191	<method name="move">
12192	<desc>
12193	Changes the overlay's position relative to the IFramebuffer.
12194	</desc>
12195	<param name="x" type="unsigned long" dir="in"/>
12196	<param name="y" type="unsigned long" dir="in"/>
12197	</method>
12198
12199	</interface>
12200
12201	<interface
12202	name="IDisplay" extends="$unknown"
12203	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12204	wsmap="managed"
12205	>
12206	<desc>
12207	The IDisplay interface represents the virtual machine's display.
12208
12209	The object implementing this interface is contained in each
12210	<link to="IConsole::display"/> attribute and represents the visual
12211	output of the virtual machine.
12212
12213	The virtual display supports pluggable output targets represented by the
12214	IFramebuffer interface. Examples of the output target are a window on
12215	the host computer or an RDP session's display on a remote computer.
12216	</desc>
12217	<method name="getScreenResolution">
12218	<desc>Queries display width, height and color depth for given screen.</desc>
12219	<param name="screenId" type="unsigned long" dir="in"/>
12220	<param name="width" type="unsigned long" dir="out"/>
12221	<param name="height" type="unsigned long" dir="out"/>
12222	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12223	</method>
12224
12225	<method name="setFramebuffer">
12226	<desc>
12227	Sets the framebuffer for given screen.
12228	</desc>
12229	<param name="screenId" type="unsigned long" dir="in"/>
12230	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12231	</method>
12232
12233	<method name="getFramebuffer">
12234	<desc>
12235	Queries the framebuffer for given screen.
12236	</desc>
12237	<param name="screenId" type="unsigned long" dir="in"/>
12238	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12239	<param name="xOrigin" type="long" dir="out"/>
12240	<param name="yOrigin" type="long" dir="out"/>
12241	</method>
12242
12243	<method name="setVideoModeHint">
12244	<desc>
12245	Asks VirtualBox to request the given video mode from
12246	the guest. This is just a hint and it cannot be guaranteed
12247	that the requested resolution will be used. Guest Additions
12248	are required for the request to be seen by guests. The caller
12249	should issue the request and wait for a resolution change and
12250	after a timeout retry.
12251
12252	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12253	parameters means that the corresponding values should be taken from the
12254	current video mode (i.e. left unchanged).
12255
12256	If the guest OS supports multi-monitor configuration then the @a display
12257	parameter specifies the number of the guest display to send the hint to:
12258	@c 0 is the primary display, @c 1 is the first secondary and
12259	so on. If the multi-monitor configuration is not supported, @a display
12260	must be @c 0.
12261
12262	<result name="E_INVALIDARG">
12263	The @a display is not associated with any monitor.
12264	</result>
12265
12266	</desc>
12267	<param name="width" type="unsigned long" dir="in"/>
12268	<param name="height" type="unsigned long" dir="in"/>
12269	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12270	<param name="display" type="unsigned long" dir="in"/>
12271	</method>
12272
12273	<method name="setSeamlessMode">
12274	<desc>
12275	Enables or disables seamless guest display rendering (seamless desktop
12276	integration) mode.
12277	<note>
12278	Calling this method has no effect if <link
12279	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12280	does not return @c Active.
12281	</note>
12282	</desc>
12283	<param name="enabled" type="boolean" dir="in"/>
12284	</method>
12285
12286	<method name="takeScreenShot">
12287	<desc>
12288	Takes a screen shot of the requested size and copies it to the
12289	32-bpp buffer allocated by the caller and pointed to by @a address.
12290	A pixel consists of 4 bytes in order: B, G, R, 0.
12291
12292	<note>This API can be used only locally by a VM process through the
12293	COM/XPCOM C++ API as it requires pointer support. It is not
12294	available for scripting langages, Java or any webservice clients.
12295	Unless you are writing a new VM frontend use
12296	<link to="#takeScreenShotToArray" />.
12297	</note>
12298
12299	<result name="E_NOTIMPL">
12300	Feature not implemented.
12301	</result>
12302	<result name="VBOX_E_IPRT_ERROR">
12303	Could not take a screenshot.
12304	</result>
12305
12306	</desc>
12307	<param name="screenId" type="unsigned long" dir="in"/>
12308	<param name="address" type="octet" mod="ptr" dir="in"/>
12309	<param name="width" type="unsigned long" dir="in"/>
12310	<param name="height" type="unsigned long" dir="in"/>
12311	</method>
12312
12313	<method name="takeScreenShotToArray">
12314	<desc>
12315	Takes a guest screen shot of the requested size and returns it as
12316	an array of bytes in uncompressed 32-bit RGBA format.
12317	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12318
12319	This API is slow, but could be the only option to get guest screenshot
12320	for scriptable languages not allowed to manipulate with addresses
12321	directly.
12322
12323	<result name="E_NOTIMPL">
12324	Feature not implemented.
12325	</result>
12326	<result name="VBOX_E_IPRT_ERROR">
12327	Could not take a screenshot.
12328	</result>
12329	</desc>
12330	<param name="screenId" type="unsigned long" dir="in">
12331	<desc>
12332	Monitor to take screenshot from.
12333	</desc>
12334	</param>
12335	<param name="width" type="unsigned long" dir="in">
12336	<desc>
12337	Desired image width.
12338	</desc>
12339	</param>
12340	<param name="height" type="unsigned long" dir="in">
12341	<desc>
12342	Desired image height.
12343	</desc>
12344	</param>
12345	<param name="screenData" type="octet" dir="return" safearray="yes">
12346	<desc>
12347	Array with resulting screen data.
12348	</desc>
12349	</param>
12350	</method>
12351
12352	<method name="takeScreenShotPNGToArray">
12353	<desc>
12354	Takes a guest screen shot of the requested size and returns it as
12355	PNG image in array.
12356
12357	<result name="E_NOTIMPL">
12358	Feature not implemented.
12359	</result>
12360	<result name="VBOX_E_IPRT_ERROR">
12361	Could not take a screenshot.
12362	</result>
12363	</desc>
12364	<param name="screenId" type="unsigned long" dir="in">
12365	<desc>
12366	Monitor to take the screenshot from.
12367	</desc>
12368	</param>
12369	<param name="width" type="unsigned long" dir="in">
12370	<desc>
12371	Desired image width.
12372	</desc>
12373	</param>
12374	<param name="height" type="unsigned long" dir="in">
12375	<desc>
12376	Desired image height.
12377	</desc>
12378	</param>
12379	<param name="screenData" type="octet" dir="return" safearray="yes">
12380	<desc>
12381	Array with resulting screen data.
12382	</desc>
12383	</param>
12384	</method>
12385
12386	<method name="drawToScreen">
12387	<desc>
12388	Draws a 32-bpp image of the specified size from the given buffer
12389	to the given point on the VM display.
12390
12391	<result name="E_NOTIMPL">
12392	Feature not implemented.
12393	</result>
12394	<result name="VBOX_E_IPRT_ERROR">
12395	Could not draw to screen.
12396	</result>
12397
12398	</desc>
12399	<param name="screenId" type="unsigned long" dir="in">
12400	<desc>
12401	Monitor to take the screenshot from.
12402	</desc>
12403	</param>
12404	<param name="address" type="octet" mod="ptr" dir="in">
12405	<desc>
12406	Address to store the screenshot to
12407	</desc>
12408	</param>
12409	<param name="x" type="unsigned long" dir="in">
12410	<desc>
12411	Relative to the screen top left corner.
12412	</desc>
12413	</param>
12414	<param name="y" type="unsigned long" dir="in">
12415	<desc>
12416	Relative to the screen top left corner.
12417	</desc>
12418	</param>
12419	<param name="width" type="unsigned long" dir="in">
12420	<desc>
12421	Desired image width.
12422	</desc>
12423	</param>
12424	<param name="height" type="unsigned long" dir="in">
12425	<desc>
12426	Desired image height.
12427	</desc>
12428	</param>
12429	</method>
12430
12431	<method name="invalidateAndUpdate">
12432	<desc>
12433	Does a full invalidation of the VM display and instructs the VM
12434	to update it.
12435
12436	<result name="VBOX_E_IPRT_ERROR">
12437	Could not invalidate and update screen.
12438	</result>
12439
12440	</desc>
12441	</method>
12442
12443	<method name="resizeCompleted">
12444	<desc>
12445	Signals that a framebuffer has completed the resize operation.
12446
12447	<result name="VBOX_E_NOT_SUPPORTED">
12448	Operation only valid for external frame buffers.
12449	</result>
12450
12451	</desc>
12452	<param name="screenId" type="unsigned long" dir="in"/>
12453	</method>
12454
12455	<method name="completeVHWACommand">
12456	<desc>
12457	Signals that the Video HW Acceleration command has completed.
12458	</desc>
12459
12460	<param name="command" type="octet" mod="ptr" dir="in">
12461	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12462	</param>
12463	</method>
12464
12465	</interface>
12466
12467	<!--
12468	// INetworkAdapter
12469	/////////////////////////////////////////////////////////////////////////
12470	-->
12471
12472	<enum
12473	name="NetworkAttachmentType"
12474	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12475	>
12476	<desc>
12477	Network attachment type.
12478	</desc>
12479
12480	<const name="Null" value="0">
12481	<desc>Null value, also means "not attached".</desc>
12482	</const>
12483	<const name="NAT" value="1"/>
12484	<const name="Bridged" value="2"/>
12485	<const name="Internal" value="3"/>
12486	<const name="HostOnly" value="4"/>
12487	<const name="Generic" value="5"/>
12488	</enum>
12489
12490	<enum
12491	name="NetworkAdapterType"
12492	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12493	>
12494	<desc>
12495	Network adapter type.
12496	</desc>
12497
12498	<const name="Null" value="0">
12499	<desc>Null value (never used by the API).</desc>
12500	</const>
12501	<const name="Am79C970A" value="1">
12502	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12503	</const>
12504	<const name="Am79C973" value="2">
12505	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12506	</const>
12507	<const name="I82540EM" value="3">
12508	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12509	</const>
12510	<const name="I82543GC" value="4">
12511	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12512	</const>
12513	<const name="I82545EM" value="5">
12514	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12515	</const>
12516	<const name="Virtio" value="6">
12517	<desc>Virtio network device.</desc>
12518	</const>
12519	</enum>
12520
12521	<enum
12522	name="NetworkAdapterPromiscModePolicy"
12523	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12524	>
12525	<desc>
12526	The promiscuous mode policy of an interface.
12527	</desc>
12528
12529	<const name="Deny" value="1">
12530	<desc>Deny promiscuous mode requests.</desc>
12531	</const>
12532	<const name="AllowNetwork" value="2">
12533	<desc>
12534	Allow promicuous mode, but restrict the scope it to the internal
12535	network so that it only applies to other VMs.
12536	</desc>
12537	</const>
12538	<const name="AllowAll" value="3">
12539	<desc>
12540	Allow promicuous mode, include unrelated traffic going over the wire
12541	and internally on the host.
12542	</desc>
12543	</const>
12544	</enum>
12545
12546	<interface
12547	name="INetworkAdapter" extends="$unknown"
12548	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12549	wsmap="managed"
12550	>
12551	<desc>
12552	Represents a virtual network adapter that is attached to a virtual machine.
12553	Each virtual machine has a fixed number of network adapter slots with one
12554	instance of this attached to each of them. Call
12555	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12556	is attached to a given slot in a given machine.
12557
12558	Each network adapter can be in one of five attachment modes, which are
12559	represented by the <link to="NetworkAttachmentType" /> enumeration;
12560	see the <link to="#attachmentType" /> attribute.
12561	</desc>
12562
12563	<attribute name="adapterType" type="NetworkAdapterType">
12564	<desc>
12565	Type of the virtual network adapter. Depending on this value,
12566	VirtualBox will provide a different virtual network hardware
12567	to the guest.
12568	</desc>
12569	</attribute>
12570
12571	<attribute name="slot" type="unsigned long" readonly="yes">
12572	<desc>
12573	Slot number this adapter is plugged into. Corresponds to
12574	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12575	to obtain this instance.
12576	</desc>
12577	</attribute>
12578
12579	<attribute name="enabled" type="boolean">
12580	<desc>
12581	Flag whether the network adapter is present in the
12582	guest system. If disabled, the virtual guest hardware will
12583	not contain this network adapter. Can only be changed when
12584	the VM is not running.
12585	</desc>
12586	</attribute>
12587
12588	<attribute name="MACAddress" type="wstring">
12589	<desc>
12590	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12591	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12592	</desc>
12593	</attribute>
12594
12595	<attribute name="attachmentType" type="NetworkAttachmentType">
12596	<desc>
12597	Sets/Gets network attachment type of this network adapter.
12598	</desc>
12599	</attribute>
12600
12601	<attribute name="bridgedInterface" type="wstring">
12602	<desc>
12603	Name of the network interface the VM should be bridged to.
12604	</desc>
12605	</attribute>
12606
12607	<attribute name="hostOnlyInterface" type="wstring">
12608	<desc>
12609	Name of the host only network interface the VM is attached to.
12610	</desc>
12611	</attribute>
12612
12613	<attribute name="internalNetwork" type="wstring">
12614	<desc>
12615	Name of the internal network the VM is attached to.
12616	</desc>
12617	</attribute>
12618
12619	<attribute name="NATNetwork" type="wstring">
12620	<desc>
12621	Name of the NAT network the VM is attached to.
12622	</desc>
12623	</attribute>
12624
12625	<attribute name="genericDriver" type="wstring">
12626	<desc>
12627	Name of the driver to use for the "Generic" network attachment type.
12628	</desc>
12629	</attribute>
12630
12631	<attribute name="cableConnected" type="boolean">
12632	<desc>
12633	Flag whether the adapter reports the cable as connected or not.
12634	It can be used to report offline situations to a VM.
12635	</desc>
12636	</attribute>
12637
12638	<attribute name="lineSpeed" type="unsigned long">
12639	<desc>
12640	Line speed reported by custom drivers, in units of 1 kbps.
12641	</desc>
12642	</attribute>
12643
12644	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12645	<desc>
12646	The promiscuous mode policy of the network adapter when attached to an
12647	internal network, host only network or a bridge.
12648	</desc>
12649	</attribute>
12650
12651	<attribute name="traceEnabled" type="boolean">
12652	<desc>
12653	Flag whether network traffic from/to the network card should be traced.
12654	Can only be toggled when the VM is turned off.
12655	</desc>
12656	</attribute>
12657
12658	<attribute name="traceFile" type="wstring">
12659	<desc>
12660	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12661	will be used.
12662	</desc>
12663	</attribute>
12664
12665	<attribute name="natDriver" type="INATEngine" readonly="yes">
12666	<desc>
12667	Points to the NAT engine which handles the network address translation
12668	for this interface. This is active only when the interface actually uses
12669	NAT.
12670	</desc>
12671	</attribute>
12672
12673	<attribute name="bootPriority" type="unsigned long">
12674	<desc>
12675	Network boot priority of the adapter. Priority 1 is highest. If not set,
12676	the priority is considered to be at the lowest possible setting.
12677	</desc>
12678	</attribute>
12679
12680	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12681	<desc>The bandwidth group this network adapter is assigned to.</desc>
12682	</attribute>
12683
12684	<!-- property methods -->
12685
12686	<method name="getProperty" const="yes">
12687	<desc>
12688	Returns the value of the network attachment property with the given name.
12689
12690	If the requested data @a key does not exist, this function will
12691	succeed and return an empty string in the @a value argument.
12692
12693	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12694	</desc>
12695	<param name="key" type="wstring" dir="in">
12696	<desc>Name of the property to get.</desc>
12697	</param>
12698	<param name="value" type="wstring" dir="return">
12699	<desc>Current property value.</desc>
12700	</param>
12701	</method>
12702
12703	<method name="setProperty">
12704	<desc>
12705	Sets the value of the network attachment property with the given name.
12706
12707	Setting the property value to @c null or an empty string is equivalent
12708	to deleting the existing value.
12709
12710	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12711	</desc>
12712	<param name="key" type="wstring" dir="in">
12713	<desc>Name of the property to set.</desc>
12714	</param>
12715	<param name="value" type="wstring" dir="in">
12716	<desc>Property value to set.</desc>
12717	</param>
12718	</method>
12719
12720	<method name="getProperties" const="yes">
12721	<desc>
12722	Returns values for a group of properties in one call.
12723
12724	The names of the properties to get are specified using the @a names
12725	argument which is a list of comma-separated property names or
12726	an empty string if all properties are to be returned.
12727	<note>Currently the value of this argument is ignored and the method
12728	always returns all existing properties.</note>
12729
12730	The method returns two arrays, the array of property names corresponding
12731	to the @a names argument and the current values of these properties.
12732	Both arrays have the same number of elements with each element at the
12733	given index in the first array corresponds to an element at the same
12734	index in the second array.
12735	</desc>
12736	<param name="names" type="wstring" dir="in">
12737	<desc>
12738	Names of properties to get.
12739	</desc>
12740	</param>
12741	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12742	<desc>Names of returned properties.</desc>
12743	</param>
12744	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12745	<desc>Values of returned properties.</desc>
12746	</param>
12747	</method>
12748
12749	</interface>
12750
12751
12752	<!--
12753	// ISerialPort
12754	/////////////////////////////////////////////////////////////////////////
12755	-->
12756
12757	<enum
12758	name="PortMode"
12759	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12760	>
12761	<desc>
12762	The PortMode enumeration represents possible communication modes for
12763	the virtual serial port device.
12764	</desc>
12765
12766	<const name="Disconnected" value="0">
12767	<desc>Virtual device is not attached to any real host device.</desc>
12768	</const>
12769	<const name="HostPipe" value="1">
12770	<desc>Virtual device is attached to a host pipe.</desc>
12771	</const>
12772	<const name="HostDevice" value="2">
12773	<desc>Virtual device is attached to a host device.</desc>
12774	</const>
12775	<const name="RawFile" value="3">
12776	<desc>Virtual device is attached to a raw file.</desc>
12777	</const>
12778	</enum>
12779
12780	<interface
12781	name="ISerialPort" extends="$unknown"
12782	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12783	wsmap="managed"
12784	>
12785
12786	<desc>
12787	The ISerialPort interface represents the virtual serial port device.
12788
12789	The virtual serial port device acts like an ordinary serial port
12790	inside the virtual machine. This device communicates to the real
12791	serial port hardware in one of two modes: host pipe or host device.
12792
12793	In host pipe mode, the #path attribute specifies the path to the pipe on
12794	the host computer that represents a serial port. The #server attribute
12795	determines if this pipe is created by the virtual machine process at
12796	machine startup or it must already exist before starting machine
12797	execution.
12798
12799	In host device mode, the #path attribute specifies the name of the
12800	serial port device on the host computer.
12801
12802	There is also a third communication mode: the disconnected mode. In this
12803	mode, the guest OS running inside the virtual machine will be able to
12804	detect the serial port, but all port write operations will be discarded
12805	and all port read operations will return no data.
12806
12807	<see><link to="IMachine::getSerialPort"/></see>
12808	</desc>
12809
12810	<attribute name="slot" type="unsigned long" readonly="yes">
12811	<desc>
12812	Slot number this serial port is plugged into. Corresponds to
12813	the value you pass to <link to="IMachine::getSerialPort"/>
12814	to obtain this instance.
12815	</desc>
12816	</attribute>
12817
12818	<attribute name="enabled" type="boolean">
12819	<desc>
12820	Flag whether the serial port is enabled. If disabled,
12821	the serial port will not be reported to the guest OS.
12822	</desc>
12823	</attribute>
12824
12825	<attribute name="IOBase" type="unsigned long">
12826	<desc>Base I/O address of the serial port.</desc>
12827	</attribute>
12828
12829	<attribute name="IRQ" type="unsigned long">
12830	<desc>IRQ number of the serial port.</desc>
12831	</attribute>
12832
12833	<attribute name="hostMode" type="PortMode">
12834	<desc>
12835	How is this port connected to the host.
12836	<note>
12837	Changing this attribute may fail if the conditions for
12838	<link to="#path"/> are not met.
12839	</note>
12840	</desc>
12841	</attribute>
12842
12843	<attribute name="server" type="boolean">
12844	<desc>
12845	Flag whether this serial port acts as a server (creates a new pipe on
12846	the host) or as a client (uses the existing pipe). This attribute is
12847	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12848	</desc>
12849	</attribute>
12850
12851	<attribute name="path" type="wstring">
12852	<desc>
12853	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12854	PortMode_HostPipe, or the host serial device name when
12855	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12856	cases, setting a @c null or empty string as the attribute's value
12857	is an error. Otherwise, the value of this property is ignored.
12858	</desc>
12859	</attribute>
12860
12861	</interface>
12862
12863	<!--
12864	// IParallelPort
12865	/////////////////////////////////////////////////////////////////////////
12866	-->
12867
12868	<interface
12869	name="IParallelPort" extends="$unknown"
12870	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12871	wsmap="managed"
12872	>
12873
12874	<desc>
12875	The IParallelPort interface represents the virtual parallel port device.
12876
12877	The virtual parallel port device acts like an ordinary parallel port
12878	inside the virtual machine. This device communicates to the real
12879	parallel port hardware using the name of the parallel device on the host
12880	computer specified in the #path attribute.
12881
12882	Each virtual parallel port device is assigned a base I/O address and an
12883	IRQ number that will be reported to the guest operating system and used
12884	to operate the given parallel port from within the virtual machine.
12885
12886	<see><link to="IMachine::getParallelPort"/></see>
12887	</desc>
12888
12889	<attribute name="slot" type="unsigned long" readonly="yes">
12890	<desc>
12891	Slot number this parallel port is plugged into. Corresponds to
12892	the value you pass to <link to="IMachine::getParallelPort"/>
12893	to obtain this instance.
12894	</desc>
12895	</attribute>
12896
12897	<attribute name="enabled" type="boolean">
12898	<desc>
12899	Flag whether the parallel port is enabled. If disabled,
12900	the parallel port will not be reported to the guest OS.
12901	</desc>
12902	</attribute>
12903
12904	<attribute name="IOBase" type="unsigned long">
12905	<desc>Base I/O address of the parallel port.</desc>
12906	</attribute>
12907
12908	<attribute name="IRQ" type="unsigned long">
12909	<desc>IRQ number of the parallel port.</desc>
12910	</attribute>
12911
12912	<attribute name="path" type="wstring">
12913	<desc>
12914	Host parallel device name. If this parallel port is enabled, setting a
12915	@c null or an empty string as this attribute's value will result in
12916	an error.
12917	</desc>
12918	</attribute>
12919
12920	</interface>
12921
12922
12923	<!--
12924	// IMachineDebugger
12925	/////////////////////////////////////////////////////////////////////////
12926	-->
12927
12928	<interface
12929	name="IMachineDebugger" extends="$unknown"
12930	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12931	wsmap="suppress"
12932	>
12933	<method name="dumpGuestCore">
12934	<desc>
12935	Takes a core dump of the guest.
12936
12937	See include/VBox/dbgfcorefmt.h for details on the file format.
12938	</desc>
12939	<param name="filename" type="wstring" dir="in">
12940	<desc>
12941	The name of the output file. The file must not exist.
12942	</desc>
12943	</param>
12944	<param name="compression" type="wstring" dir="in">
12945	<desc>
12946	Reserved for future compression method indicator.
12947	</desc>
12948	</param>
12949	</method>
12950
12951	<method name="dumpHostProcessCore">
12952	<desc>
12953	Takes a core dump of the VM process on the host.
12954
12955	This feature is not implemented in the 4.0.0 release but it may show up
12956	in a dot release.
12957	</desc>
12958	<param name="filename" type="wstring" dir="in">
12959	<desc>
12960	The name of the output file. The file must not exist.
12961	</desc>
12962	</param>
12963	<param name="compression" type="wstring" dir="in">
12964	<desc>
12965	Reserved for future compression method indicator.
12966	</desc>
12967	</param>
12968	</method>
12969
12970	<method name="info">
12971	<desc>
12972	Interfaces with the info dumpers (DBGFInfo).
12973
12974	This feature is not implemented in the 4.0.0 release but it may show up
12975	in a dot release.
12976	</desc>
12977	<param name="name" type="wstring" dir="in">
12978	<desc>
12979	The name of the info item.
12980	</desc>
12981	</param>
12982	<param name="args" type="wstring" dir="in">
12983	<desc>
12984	Arguments to the info dumper.
12985	</desc>
12986	</param>
12987	<param name="info" type="wstring" dir="return">
12988	<desc>
12989	The into string.
12990	</desc>
12991	</param>
12992	</method>
12993
12994	<method name="injectNMI">
12995	<desc>
12996	Inject an NMI into a running VT-x/AMD-V VM.
12997	</desc>
12998	</method>
12999
13000	<method name="modifyLogGroups">
13001	<desc>
13002	Modifies the group settings of the debug logger.
13003
13004	This feature is not implemented in the 4.0.0 release but may show up
13005	in a dot release.
13006	</desc>
13007	<param name="settings" type="wstring" dir="in">
13008	<desc>The group settings string. See iprt/log.h for details.</desc>
13009	</param>
13010	</method>
13011
13012	<method name="modifyLogFlags">
13013	<desc>
13014	Modifies the debug logger flags.
13015
13016	This feature is not implemented in the 4.0.0 release but may show up
13017	in a dot release.
13018	</desc>
13019	<param name="settings" type="wstring" dir="in">
13020	<desc>The flags settings string. See iprt/log.h for details.</desc>
13021	</param>
13022	</method>
13023
13024	<method name="modifyLogDestinations">
13025	<desc>
13026	Modifies the debug logger destinations.
13027
13028	This feature is not implemented in the 4.0.0 release but may show up
13029	in a dot release.
13030	</desc>
13031	<param name="settings" type="wstring" dir="in">
13032	<desc>The destination settings string. See iprt/log.h for details.</desc>
13033	</param>
13034	</method>
13035
13036	<method name="readPhysicalMemory">
13037	<desc>
13038	Reads guest physical memory, no side effects (MMIO++).
13039
13040	This feature is not implemented in the 4.0.0 release but may show up
13041	in a dot release.
13042	</desc>
13043	<param name="address" type="long long" dir="in">
13044	<desc>The guest physical address.</desc>
13045	</param>
13046	<param name="size" type="unsigned long" dir="in">
13047	<desc>The number of bytes to read.</desc>
13048	</param>
13049	<param name="bytes" type="octet" safearray="yes" dir="return">
13050	<desc>The bytes read.</desc>
13051	</param>
13052	</method>
13053
13054	<method name="writePhysicalMemory">
13055	<desc>
13056	Writes guest physical memory, access handles (MMIO++) are ignored.
13057
13058	This feature is not implemented in the 4.0.0 release but may show up
13059	in a dot release.
13060	</desc>
13061	<param name="address" type="long long" dir="in">
13062	<desc>The guest physical address.</desc>
13063	</param>
13064	<param name="size" type="unsigned long" dir="in">
13065	<desc>The number of bytes to read.</desc>
13066	</param>
13067	<param name="bytes" type="octet" safearray="yes" dir="in">
13068	<desc>The bytes to write.</desc>
13069	</param>
13070	</method>
13071
13072	<method name="readVirtualMemory">
13073	<desc>
13074	Reads guest virtual memory, no side effects (MMIO++).
13075
13076	This feature is not implemented in the 4.0.0 release but may show up
13077	in a dot release.
13078	</desc>
13079	<param name="cpuId" type="unsigned long" dir="in">
13080	<desc>The identifier of the Virtual CPU.</desc>
13081	</param>
13082	<param name="address" type="long long" dir="in">
13083	<desc>The guest virtual address.</desc>
13084	</param>
13085	<param name="size" type="unsigned long" dir="in">
13086	<desc>The number of bytes to read.</desc>
13087	</param>
13088	<param name="bytes" type="octet" safearray="yes" dir="return">
13089	<desc>The bytes read.</desc>
13090	</param>
13091	</method>
13092
13093	<method name="writeVirtualMemory">
13094	<desc>
13095	Writes guest virtual memory, access handles (MMIO++) are ignored.
13096
13097	This feature is not implemented in the 4.0.0 release but may show up
13098	in a dot release.
13099	</desc>
13100	<param name="cpuId" type="unsigned long" dir="in">
13101	<desc>The identifier of the Virtual CPU.</desc>
13102	</param>
13103	<param name="address" type="long long" dir="in">
13104	<desc>The guest virtual address.</desc>
13105	</param>
13106	<param name="size" type="unsigned long" dir="in">
13107	<desc>The number of bytes to read.</desc>
13108	</param>
13109	<param name="bytes" type="octet" safearray="yes" dir="in">
13110	<desc>The bytes to write.</desc>
13111	</param>
13112	</method>
13113
13114	<method name="detectOS">
13115	<desc>
13116	Tries to (re-)detect the guest OS kernel.
13117
13118	This feature is not implemented in the 4.0.0 release but may show up
13119	in a dot release.
13120	</desc>
13121	<param name="os" type="wstring" dir="return">
13122	<desc>
13123	The detected OS kernel on success.
13124	</desc>
13125	</param>
13126	</method>
13127
13128	<method name="getRegister">
13129	<desc>
13130	Gets one register.
13131
13132	This feature is not implemented in the 4.0.0 release but may show up
13133	in a dot release.
13134	</desc>
13135	<param name="cpuId" type="unsigned long" dir="in">
13136	<desc>The identifier of the Virtual CPU.</desc>
13137	</param>
13138	<param name="name" type="wstring" dir="in">
13139	<desc>The register name, case is ignored.</desc>
13140	</param>
13141	<param name="value" type="wstring" dir="return">
13142	<desc>
13143	The register value. This is usually a hex value (always 0x prefixed)
13144	but other format may be used for floating point registers (TBD).
13145	</desc>
13146	</param>
13147	</method>
13148
13149	<method name="getRegisters">
13150	<desc>
13151	Gets all the registers for the given CPU.
13152
13153	This feature is not implemented in the 4.0.0 release but may show up
13154	in a dot release.
13155	</desc>
13156	<param name="cpuId" type="unsigned long" dir="in">
13157	<desc>The identifier of the Virtual CPU.</desc>
13158	</param>
13159	<param name="names" type="wstring" dir="out" safearray="yes">
13160	<desc>Array containing the lowercase register names.</desc>
13161	</param>
13162	<param name="values" type="wstring" dir="out" safearray="yes">
13163	<desc>
13164	Array paralell to the names holding the register values as if the
13165	register was returned by <link to="IMachineDebugger::getRegister"/>.
13166	</desc>
13167	</param>
13168	</method>
13169
13170	<method name="setRegister">
13171	<desc>
13172	Gets one register.
13173
13174	This feature is not implemented in the 4.0.0 release but may show up
13175	in a dot release.
13176	</desc>
13177	<param name="cpuId" type="unsigned long" dir="in">
13178	<desc>The identifier of the Virtual CPU.</desc>
13179	</param>
13180	<param name="name" type="wstring" dir="in">
13181	<desc>The register name, case is ignored.</desc>
13182	</param>
13183	<param name="value" type="wstring" dir="in">
13184	<desc>
13185	The new register value. Hexadecimal, decimal and octal formattings
13186	are supported in addition to any special formattings returned by
13187	the getters.
13188	</desc>
13189	</param>
13190	</method>
13191
13192	<method name="setRegisters">
13193	<desc>
13194	Sets zero or more registers atomically.
13195
13196	This feature is not implemented in the 4.0.0 release but may show up
13197	in a dot release.
13198	</desc>
13199	<param name="cpuId" type="unsigned long" dir="in">
13200	<desc>The identifier of the Virtual CPU.</desc>
13201	</param>
13202	<param name="names" type="wstring" dir="in" safearray="yes">
13203	<desc>Array containing the register names, case ignored.</desc>
13204	</param>
13205	<param name="values" type="wstring" dir="in" safearray="yes">
13206	<desc>
13207	Array paralell to the names holding the register values. See
13208	<link to="IMachineDebugger::setRegister"/> for formatting
13209	guidelines.
13210	</desc>
13211	</param>
13212	</method>
13213
13214	<method name="dumpGuestStack">
13215	<desc>
13216	Produce a simple stack dump using the current guest state.
13217
13218	This feature is not implemented in the 4.0.0 release but may show up
13219	in a dot release.
13220	</desc>
13221	<param name="cpuId" type="unsigned long" dir="in">
13222	<desc>The identifier of the Virtual CPU.</desc>
13223	</param>
13224	<param name="stack" type="wstring" dir="return">
13225	<desc>String containing the formatted stack dump.</desc>
13226	</param>
13227	</method>
13228
13229	<method name="resetStats">
13230	<desc>
13231	Reset VM statistics.
13232	</desc>
13233	<param name="pattern" type="wstring" dir="in">
13234	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13235	</param>
13236	</method>
13237
13238	<method name="dumpStats">
13239	<desc>
13240	Dumps VM statistics.
13241	</desc>
13242	<param name="pattern" type="wstring" dir="in">
13243	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13244	</param>
13245	</method>
13246
13247	<method name="getStats">
13248	<desc>
13249	Get the VM statistics in a XMLish format.
13250	</desc>
13251	<param name="pattern" type="wstring" dir="in">
13252	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13253	</param>
13254	<param name="withDescriptions" type="boolean" dir="in">
13255	<desc>Whether to include the descriptions.</desc>
13256	</param>
13257	<param name="stats" type="wstring" dir="out">
13258	<desc>The XML document containing the statistics.</desc>
13259	</param>
13260	</method>
13261
13262	<attribute name="singlestep" type="boolean">
13263	<desc>Switch for enabling singlestepping.</desc>
13264	</attribute>
13265
13266	<attribute name="recompileUser" type="boolean">
13267	<desc>Switch for forcing code recompilation for user mode code.</desc>
13268	</attribute>
13269
13270	<attribute name="recompileSupervisor" type="boolean">
13271	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13272	</attribute>
13273
13274	<attribute name="PATMEnabled" type="boolean">
13275	<desc>Switch for enabling and disabling the PATM component.</desc>
13276	</attribute>
13277
13278	<attribute name="CSAMEnabled" type="boolean">
13279	<desc>Switch for enabling and disabling the CSAM component.</desc>
13280	</attribute>
13281
13282	<attribute name="logEnabled" type="boolean">
13283	<desc>Switch for enabling and disabling the debug logger.</desc>
13284	</attribute>
13285
13286	<attribute name="logFlags" type="wstring" readonly="yes">
13287	<desc>The debug logger flags.</desc>
13288	</attribute>
13289
13290	<attribute name="logGroups" type="wstring" readonly="yes">
13291	<desc>The debug logger's group settings.</desc>
13292	</attribute>
13293
13294	<attribute name="logDestinations" type="wstring" readonly="yes">
13295	<desc>The debug logger's destination settings.</desc>
13296	</attribute>
13297
13298	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13299	<desc>
13300	Flag indicating whether the VM is currently making use of CPU hardware
13301	virtualization extensions.
13302	</desc>
13303	</attribute>
13304
13305	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13306	<desc>
13307	Flag indicating whether the VM is currently making use of the nested paging
13308	CPU hardware virtualization extension.
13309	</desc>
13310	</attribute>
13311
13312	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13313	<desc>
13314	Flag indicating whether the VM is currently making use of the VPID
13315	VT-x extension.
13316	</desc>
13317	</attribute>
13318
13319	<attribute name="OSName" type="wstring" readonly="yes">
13320	<desc>
13321	Query the guest OS kernel name as detected by the DBGF.
13322
13323	This feature is not implemented in the 4.0.0 release but may show up
13324	in a dot release.
13325	</desc>
13326	</attribute>
13327
13328	<attribute name="OSVersion" type="wstring" readonly="yes">
13329	<desc>
13330	Query the guest OS kernel version string as detected by the DBGF.
13331
13332	This feature is not implemented in the 4.0.0 release but may show up
13333	in a dot release.
13334	</desc>
13335	</attribute>
13336
13337	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13338	<desc>
13339	Flag indicating whether the VM is currently making use of the Physical
13340	Address Extension CPU feature.
13341	</desc>
13342	</attribute>
13343
13344	<attribute name="virtualTimeRate" type="unsigned long">
13345	<desc>
13346	The rate at which the virtual time runs expressed as a percentage.
13347	The accepted range is 2% to 20000%.
13348	</desc>
13349	</attribute>
13350
13351	<attribute name="VM" type="long long" readonly="yes">
13352	<desc>
13353	Gets the VM handle. This is only for internal use while
13354	we carve the details of this interface.
13355	</desc>
13356	</attribute>
13357
13358	</interface>
13359
13360	<!--
13361	// IUSBController
13362	/////////////////////////////////////////////////////////////////////////
13363	-->
13364
13365	<interface
13366	name="IUSBController" extends="$unknown"
13367	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13368	wsmap="managed"
13369	>
13370	<attribute name="enabled" type="boolean">
13371	<desc>
13372	Flag whether the USB controller is present in the
13373	guest system. If disabled, the virtual guest hardware will
13374	not contain any USB controller. Can only be changed when
13375	the VM is powered off.
13376	</desc>
13377	</attribute>
13378
13379	<attribute name="enabledEhci" type="boolean">
13380	<desc>
13381	Flag whether the USB EHCI controller is present in the
13382	guest system. If disabled, the virtual guest hardware will
13383	not contain a USB EHCI controller. Can only be changed when
13384	the VM is powered off.
13385	</desc>
13386	</attribute>
13387
13388	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13389	<desc>
13390	Flag whether there is an USB proxy available.
13391	</desc>
13392	</attribute>
13393
13394	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13395	<desc>
13396	USB standard version which the controller implements.
13397	This is a BCD which means that the major version is in the
13398	high byte and minor version is in the low byte.
13399	</desc>
13400	</attribute>
13401
13402	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13403	<desc>
13404	List of USB device filters associated with the machine.
13405
13406	If the machine is currently running, these filters are activated
13407	every time a new (supported) USB device is attached to the host
13408	computer that was not ignored by global filters
13409	(<link to="IHost::USBDeviceFilters"/>).
13410
13411	These filters are also activated when the machine is powered up.
13412	They are run against a list of all currently available USB
13413	devices (in states
13414	<link to="USBDeviceState_Available"/>,
13415	<link to="USBDeviceState_Busy"/>,
13416	<link to="USBDeviceState_Held"/>) that were not previously
13417	ignored by global filters.
13418
13419	If at least one filter matches the USB device in question, this
13420	device is automatically captured (attached to) the virtual USB
13421	controller of this machine.
13422
13423	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13424	</desc>
13425	</attribute>
13426
13427	<method name="createDeviceFilter">
13428	<desc>
13429	Creates a new USB device filter. All attributes except
13430	the filter name are set to empty (any match),
13431	<i>active</i> is @c false (the filter is not active).
13432
13433	The created filter can then be added to the list of filters using
13434	<link to="#insertDeviceFilter"/>.
13435
13436	<result name="VBOX_E_INVALID_VM_STATE">
13437	The virtual machine is not mutable.
13438	</result>
13439
13440	<see><link to="#deviceFilters"/></see>
13441	</desc>
13442	<param name="name" type="wstring" dir="in">
13443	<desc>
13444	Filter name. See <link to="IUSBDeviceFilter::name"/>
13445	for more info.
13446	</desc>
13447	</param>
13448	<param name="filter" type="IUSBDeviceFilter" dir="return">
13449	<desc>Created filter object.</desc>
13450	</param>
13451	</method>
13452
13453	<method name="insertDeviceFilter">
13454	<desc>
13455	Inserts the given USB device to the specified position
13456	in the list of filters.
13457
13458	Positions are numbered starting from <tt>0</tt>. If the specified
13459	position is equal to or greater than the number of elements in
13460	the list, the filter is added to the end of the collection.
13461
13462	<note>
13463	Duplicates are not allowed, so an attempt to insert a
13464	filter that is already in the collection, will return an
13465	error.
13466	</note>
13467
13468	<result name="VBOX_E_INVALID_VM_STATE">
13469	Virtual machine is not mutable.
13470	</result>
13471	<result name="E_INVALIDARG">
13472	USB device filter not created within this VirtualBox instance.
13473	</result>
13474	<result name="VBOX_E_INVALID_OBJECT_STATE">
13475	USB device filter already in list.
13476	</result>
13477
13478	<see><link to="#deviceFilters"/></see>
13479	</desc>
13480	<param name="position" type="unsigned long" dir="in">
13481	<desc>Position to insert the filter to.</desc>
13482	</param>
13483	<param name="filter" type="IUSBDeviceFilter" dir="in">
13484	<desc>USB device filter to insert.</desc>
13485	</param>
13486	</method>
13487
13488	<method name="removeDeviceFilter">
13489	<desc>
13490	Removes a USB device filter from the specified position in the
13491	list of filters.
13492
13493	Positions are numbered starting from <tt>0</tt>. Specifying a
13494	position equal to or greater than the number of elements in
13495	the list will produce an error.
13496
13497	<see><link to="#deviceFilters"/></see>
13498
13499	<result name="VBOX_E_INVALID_VM_STATE">
13500	Virtual machine is not mutable.
13501	</result>
13502	<result name="E_INVALIDARG">
13503	USB device filter list empty or invalid @a position.
13504	</result>
13505
13506	</desc>
13507	<param name="position" type="unsigned long" dir="in">
13508	<desc>Position to remove the filter from.</desc>
13509	</param>
13510	<param name="filter" type="IUSBDeviceFilter" dir="return">
13511	<desc>Removed USB device filter.</desc>
13512	</param>
13513	</method>
13514
13515	</interface>
13516
13517
13518	<!--
13519	// IUSBDevice
13520	/////////////////////////////////////////////////////////////////////////
13521	-->
13522
13523	<interface
13524	name="IUSBDevice" extends="$unknown"
13525	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13526	wsmap="managed"
13527	>
13528	<desc>
13529	The IUSBDevice interface represents a virtual USB device attached to the
13530	virtual machine.
13531
13532	A collection of objects implementing this interface is stored in the
13533	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13534	attached to a running virtual machine's USB controller.
13535	</desc>
13536
13537	<attribute name="id" type="uuid" mod="string" readonly="yes">
13538	<desc>
13539	Unique USB device ID. This ID is built from #vendorId,
13540	#productId, #revision and #serialNumber.
13541	</desc>
13542	</attribute>
13543
13544	<attribute name="vendorId" type="unsigned short" readonly="yes">
13545	<desc>Vendor ID.</desc>
13546	</attribute>
13547
13548	<attribute name="productId" type="unsigned short" readonly="yes">
13549	<desc>Product ID.</desc>
13550	</attribute>
13551
13552	<attribute name="revision" type="unsigned short" readonly="yes">
13553	<desc>
13554	Product revision number. This is a packed BCD represented as
13555	unsigned short. The high byte is the integer part and the low
13556	byte is the decimal.
13557	</desc>
13558	</attribute>
13559
13560	<attribute name="manufacturer" type="wstring" readonly="yes">
13561	<desc>Manufacturer string.</desc>
13562	</attribute>
13563
13564	<attribute name="product" type="wstring" readonly="yes">
13565	<desc>Product string.</desc>
13566	</attribute>
13567
13568	<attribute name="serialNumber" type="wstring" readonly="yes">
13569	<desc>Serial number string.</desc>
13570	</attribute>
13571
13572	<attribute name="address" type="wstring" readonly="yes">
13573	<desc>Host specific address of the device.</desc>
13574	</attribute>
13575
13576	<attribute name="port" type="unsigned short" readonly="yes">
13577	<desc>
13578	Host USB port number the device is physically
13579	connected to.
13580	</desc>
13581	</attribute>
13582
13583	<attribute name="version" type="unsigned short" readonly="yes">
13584	<desc>
13585	The major USB version of the device - 1 or 2.
13586	</desc>
13587	</attribute>
13588
13589	<attribute name="portVersion" type="unsigned short" readonly="yes">
13590	<desc>
13591	The major USB version of the host USB port the device is
13592	physically connected to - 1 or 2. For devices not connected to
13593	anything this will have the same value as the version attribute.
13594	</desc>
13595	</attribute>
13596
13597	<attribute name="remote" type="boolean" readonly="yes">
13598	<desc>
13599	Whether the device is physically connected to a remote VRDE
13600	client or to a local host machine.
13601	</desc>
13602	</attribute>
13603
13604	</interface>
13605
13606
13607	<!--
13608	// IUSBDeviceFilter
13609	/////////////////////////////////////////////////////////////////////////
13610	-->
13611
13612	<interface
13613	name="IUSBDeviceFilter" extends="$unknown"
13614	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13615	wsmap="managed"
13616	>
13617	<desc>
13618	The IUSBDeviceFilter interface represents an USB device filter used
13619	to perform actions on a group of USB devices.
13620
13621	This type of filters is used by running virtual machines to
13622	automatically capture selected USB devices once they are physically
13623	attached to the host computer.
13624
13625	A USB device is matched to the given device filter if and only if all
13626	attributes of the device match the corresponding attributes of the
13627	filter (that is, attributes are joined together using the logical AND
13628	operation). On the other hand, all together, filters in the list of
13629	filters carry the semantics of the logical OR operation. So if it is
13630	desirable to create a match like "this vendor id OR this product id",
13631	one needs to create two filters and specify "any match" (see below)
13632	for unused attributes.
13633
13634	All filter attributes used for matching are strings. Each string
13635	is an expression representing a set of values of the corresponding
13636	device attribute, that will match the given filter. Currently, the
13637	following filtering expressions are supported:
13638
13639	<ul>
13640	<li><i>Interval filters</i>. Used to specify valid intervals for
13641	integer device attributes (Vendor ID, Product ID and Revision).
13642	The format of the string is:
13643
13644	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13645
13646	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13647	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13648	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13649	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13650	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13651	possible integer is assumed.
13652	</li>
13653	<li><i>Boolean filters</i>. Used to specify acceptable values for
13654	boolean device attributes. The format of the string is:
13655
13656	<tt>true\|false\|yes\|no\|0\|1</tt>
13657
13658	</li>
13659	<li><i>Exact match</i>. Used to specify a single value for the given
13660	device attribute. Any string that doesn't start with <tt>int:</tt>
13661	represents the exact match. String device attributes are compared to
13662	this string including case of symbols. Integer attributes are first
13663	converted to a string (see individual filter attributes) and then
13664	compared ignoring case.
13665
13666	</li>
13667	<li><i>Any match</i>. Any value of the corresponding device attribute
13668	will match the given filter. An empty or @c null string is
13669	used to construct this type of filtering expressions.
13670
13671	</li>
13672	</ul>
13673
13674	<note>
13675	On the Windows host platform, interval filters are not currently
13676	available. Also all string filter attributes
13677	(<link to="#manufacturer"/>, <link to="#product"/>,
13678	<link to="#serialNumber"/>) are ignored, so they behave as
13679	<i>any match</i> no matter what string expression is specified.
13680	</note>
13681
13682	<see><link to="IUSBController::deviceFilters"/>,
13683	<link to="IHostUSBDeviceFilter"/></see>
13684	</desc>
13685
13686	<attribute name="name" type="wstring">
13687	<desc>
13688	Visible name for this filter.
13689	This name is used to visually distinguish one filter from another,
13690	so it can neither be @c null nor an empty string.
13691	</desc>
13692	</attribute>
13693
13694	<attribute name="active" type="boolean">
13695	<desc>Whether this filter active or has been temporarily disabled.</desc>
13696	</attribute>
13697
13698	<attribute name="vendorId" type="wstring">
13699	<desc>
13700	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
13701	The string representation for the <i>exact matching</i>
13702	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13703	(including leading zeroes).
13704	</desc>
13705	</attribute>
13706
13707	<attribute name="productId" type="wstring">
13708	<desc>
13709	<link to="IUSBDevice::productId">Product ID</link> filter.
13710	The string representation for the <i>exact matching</i>
13711	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13712	(including leading zeroes).
13713	</desc>
13714	</attribute>
13715
13716	<attribute name="revision" type="wstring">
13717	<desc>
13718	<link to="IUSBDevice::productId">Product revision number</link>
13719	filter. The string representation for the <i>exact matching</i>
13720	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
13721	of the integer part of the revision, and <tt>F</tt> is the
13722	decimal digit of its fractional part (including leading and
13723	trailing zeros).
13724	Note that for interval filters, it's best to use the hexadecimal
13725	form, because the revision is stored as a 16 bit packed BCD value;
13726	so the expression <tt>int:0x0100-0x0199</tt> will match any
13727	revision from <tt>1.0</tt> to <tt>1.99</tt>.
13728	</desc>
13729	</attribute>
13730
13731	<attribute name="manufacturer" type="wstring">
13732	<desc>
13733	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
13734	</desc>
13735	</attribute>
13736
13737	<attribute name="product" type="wstring">
13738	<desc>
13739	<link to="IUSBDevice::product">Product</link> filter.
13740	</desc>
13741	</attribute>
13742
13743	<attribute name="serialNumber" type="wstring">
13744	<desc>
13745	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
13746	</desc>
13747	</attribute>
13748
13749	<attribute name="port" type="wstring">
13750	<desc>
13751	<link to="IUSBDevice::port">Host USB port</link> filter.
13752	</desc>
13753	</attribute>
13754
13755	<attribute name="remote" type="wstring">
13756	<desc>
13757	<link to="IUSBDevice::remote">Remote state</link> filter.
13758	<note>
13759	This filter makes sense only for machine USB filters,
13760	i.e. it is ignored by IHostUSBDeviceFilter objects.
13761	</note>
13762	</desc>
13763	</attribute>
13764
13765	<attribute name="maskedInterfaces" type="unsigned long">
13766	<desc>
13767	This is an advanced option for hiding one or more USB interfaces
13768	from the guest. The value is a bit mask where the bits that are set
13769	means the corresponding USB interface should be hidden, masked off
13770	if you like.
13771	This feature only works on Linux hosts.
13772	</desc>
13773	</attribute>
13774
13775	</interface>
13776
13777
13778	<!--
13779	// IHostUSBDevice
13780	/////////////////////////////////////////////////////////////////////////
13781	-->
13782
13783	<enum
13784	name="USBDeviceState"
13785	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
13786	>
13787	<desc>
13788	USB device state. This enumeration represents all possible states
13789	of the USB device physically attached to the host computer regarding
13790	its state on the host computer and availability to guest computers
13791	(all currently running virtual machines).
13792
13793	Once a supported USB device is attached to the host, global USB
13794	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
13795	either ignore the device, or put it to USBDeviceState_Held state, or do
13796	nothing. Unless the device is ignored by global filters, filters of all
13797	currently running guests (<link to="IUSBController::deviceFilters"/>) are
13798	activated that can put it to USBDeviceState_Captured state.
13799
13800	If the device was ignored by global filters, or didn't match
13801	any filters at all (including guest ones), it is handled by the host
13802	in a normal way. In this case, the device state is determined by
13803	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
13804	or USBDeviceState_Available, depending on the current device usage.
13805
13806	Besides auto-capturing based on filters, the device can be manually
13807	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
13808	state is USBDeviceState_Busy, USBDeviceState_Available or
13809	USBDeviceState_Held.
13810
13811	<note>
13812	Due to differences in USB stack implementations in Linux and Win32,
13813	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
13814	only to the Linux version of the product. This also means that (<link
13815	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
13816	device state is USBDeviceState_Held.
13817	</note>
13818
13819	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
13820	</desc>
13821
13822	<const name="NotSupported" value="0">
13823	<desc>
13824	Not supported by the VirtualBox server, not available to guests.
13825	</desc>
13826	</const>
13827	<const name="Unavailable" value="1">
13828	<desc>
13829	Being used by the host computer exclusively,
13830	not available to guests.
13831	</desc>
13832	</const>
13833	<const name="Busy" value="2">
13834	<desc>
13835	Being used by the host computer, potentially available to guests.
13836	</desc>
13837	</const>
13838	<const name="Available" value="3">
13839	<desc>
13840	Not used by the host computer, available to guests (the host computer
13841	can also start using the device at any time).
13842	</desc>
13843	</const>
13844	<const name="Held" value="4">
13845	<desc>
13846	Held by the VirtualBox server (ignored by the host computer),
13847	available to guests.
13848	</desc>
13849	</const>
13850	<const name="Captured" value="5">
13851	<desc>
13852	Captured by one of the guest computers, not available
13853	to anybody else.
13854	</desc>
13855	</const>
13856	</enum>
13857
13858	<interface
13859	name="IHostUSBDevice" extends="IUSBDevice"
13860	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13861	wsmap="managed"
13862	>
13863	<desc>
13864	The IHostUSBDevice interface represents a physical USB device attached
13865	to the host computer.
13866
13867	Besides properties inherited from IUSBDevice, this interface adds the
13868	<link to="#state"/> property that holds the current state of the USB
13869	device.
13870
13871	<see><link to="IHost::USBDevices"/>,
13872	<link to="IHost::USBDeviceFilters"/></see>
13873	</desc>
13874
13875	<attribute name="state" type="USBDeviceState" readonly="yes">
13876	<desc>
13877	Current state of the device.
13878	</desc>
13879	</attribute>
13880
13881	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13882
13883	</interface>
13884
13885
13886	<!--
13887	// IHostUSBDeviceFilter
13888	/////////////////////////////////////////////////////////////////////////
13889	-->
13890
13891	<enum
13892	name="USBDeviceFilterAction"
13893	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13894	>
13895	<desc>
13896	Actions for host USB device filters.
13897	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
13898	</desc>
13899
13900	<const name="Null" value="0">
13901	<desc>Null value (never used by the API).</desc>
13902	</const>
13903	<const name="Ignore" value="1">
13904	<desc>Ignore the matched USB device.</desc>
13905	</const>
13906	<const name="Hold" value="2">
13907	<desc>Hold the matched USB device.</desc>
13908	</const>
13909	</enum>
13910
13911	<interface
13912	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13913	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13914	wsmap="managed"
13915	>
13916	<desc>
13917	The IHostUSBDeviceFilter interface represents a global filter for a
13918	physical USB device used by the host computer. Used indirectly in
13919	<link to="IHost::USBDeviceFilters"/>.
13920
13921	Using filters of this type, the host computer determines the initial
13922	state of the USB device after it is physically attached to the
13923	host's USB controller.
13924
13925	<note>
13926	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13927	filters, because it makes sense only for
13928	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13929	</note>
13930
13931	<see><link to="IHost::USBDeviceFilters"/></see>
13932	</desc>
13933
13934	<attribute name="action" type="USBDeviceFilterAction">
13935	<desc>
13936	Action performed by the host when an attached USB device
13937	matches this filter.
13938	</desc>
13939	</attribute>
13940
13941	</interface>
13942
13943	<!--
13944	// IAudioAdapter
13945	/////////////////////////////////////////////////////////////////////////
13946	-->
13947
13948	<enum
13949	name="AudioDriverType"
13950	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13951	>
13952	<desc>
13953	Host audio driver type.
13954	</desc>
13955
13956	<const name="Null" value="0">
13957	<desc>Null value, also means "dummy audio driver".</desc>
13958	</const>
13959	<const name="WinMM" value="1">
13960	<desc>Windows multimedia (Windows hosts only).</desc>
13961	</const>
13962	<const name="OSS" value="2">
13963	<desc>Open Sound System (Linux hosts only).</desc>
13964	</const>
13965	<const name="ALSA" value="3">
13966	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13967	</const>
13968	<const name="DirectSound" value="4">
13969	<desc>DirectSound (Windows hosts only).</desc>
13970	</const>
13971	<const name="CoreAudio" value="5">
13972	<desc>CoreAudio (Mac hosts only).</desc>
13973	</const>
13974	<const name="MMPM" value="6">
13975	<desc>Reserved for historical reasons.</desc>
13976	</const>
13977	<const name="Pulse" value="7">
13978	<desc>PulseAudio (Linux hosts only).</desc>
13979	</const>
13980	<const name="SolAudio" value="8">
13981	<desc>Solaris audio (Solaris hosts only).</desc>
13982	</const>
13983	</enum>
13984
13985	<enum
13986	name="AudioControllerType"
13987	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13988	>
13989	<desc>
13990	Virtual audio controller type.
13991	</desc>
13992
13993	<const name="AC97" value="0"/>
13994	<const name="SB16" value="1"/>
13995	<const name="HDA" value="2"/>
13996	</enum>
13997
13998	<interface
13999	name="IAudioAdapter" extends="$unknown"
14000	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14001	wsmap="managed"
14002	>
14003	<desc>
14004	The IAudioAdapter interface represents the virtual audio adapter of
14005	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14006	</desc>
14007	<attribute name="enabled" type="boolean">
14008	<desc>
14009	Flag whether the audio adapter is present in the
14010	guest system. If disabled, the virtual guest hardware will
14011	not contain any audio adapter. Can only be changed when
14012	the VM is not running.
14013	</desc>
14014	</attribute>
14015	<attribute name="audioController" type="AudioControllerType">
14016	<desc>
14017	The audio hardware we emulate.
14018	</desc>
14019	</attribute>
14020	<attribute name="audioDriver" type="AudioDriverType">
14021	<desc>
14022	Audio driver the adapter is connected to. This setting
14023	can only be changed when the VM is not running.
14024	</desc>
14025	</attribute>
14026	</interface>
14027
14028	<enum
14029	name="AuthType"
14030	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14031	>
14032	<desc>
14033	VirtualBox authentication type.
14034	</desc>
14035
14036	<const name="Null" value="0">
14037	<desc>Null value, also means "no authentication".</desc>
14038	</const>
14039	<const name="External" value="1"/>
14040	<const name="Guest" value="2"/>
14041	</enum>
14042
14043	<!--
14044	// IVRDEServer
14045	/////////////////////////////////////////////////////////////////////////
14046	-->
14047
14048	<interface
14049	name="IVRDEServer" extends="$unknown"
14050	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14051	wsmap="managed"
14052	>
14053	<attribute name="enabled" type="boolean">
14054	<desc>VRDE server status.</desc>
14055	</attribute>
14056
14057	<attribute name="authType" type="AuthType">
14058	<desc>VRDE authentication method.</desc>
14059	</attribute>
14060
14061	<attribute name="authTimeout" type="unsigned long">
14062	<desc>Timeout for guest authentication. Milliseconds.</desc>
14063	</attribute>
14064
14065	<attribute name="allowMultiConnection" type="boolean">
14066	<desc>
14067	Flag whether multiple simultaneous connections to the VM are permitted.
14068	Note that this will be replaced by a more powerful mechanism in the future.
14069	</desc>
14070	</attribute>
14071
14072	<attribute name="reuseSingleConnection" type="boolean">
14073	<desc>
14074	Flag whether the existing connection must be dropped and a new connection
14075	must be established by the VRDE server, when a new client connects in single
14076	connection mode.
14077	</desc>
14078	</attribute>
14079
14080	<attribute name="VRDEExtPack" type="wstring">
14081	<desc>
14082	The name of Extension Pack providing VRDE for this VM. Overrides
14083	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14084	</desc>
14085	</attribute>
14086
14087	<attribute name="authLibrary" type="wstring">
14088	<desc>
14089	Library used for authentication of RDP clients by this VM. Overrides
14090	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14091	</desc>
14092	</attribute>
14093
14094	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14095	<desc>
14096	Array of names of properties, which are supported by this VRDE server.
14097	</desc>
14098	</attribute>
14099
14100	<method name="setVRDEProperty">
14101	<desc>
14102	Sets a VRDE specific property string.
14103
14104	If you pass @c null or empty string as a key @a value, the given @a key
14105	will be deleted.
14106
14107	</desc>
14108	<param name="key" type="wstring" dir="in">
14109	<desc>Name of the key to set.</desc>
14110	</param>
14111	<param name="value" type="wstring" dir="in">
14112	<desc>Value to assign to the key.</desc>
14113	</param>
14114	</method>
14115
14116	<method name="getVRDEProperty" const="yes">
14117	<desc>
14118	Returns a VRDE specific property string.
14119
14120	If the requested data @a key does not exist, this function will
14121	succeed and return an empty string in the @a value argument.
14122
14123	</desc>
14124	<param name="key" type="wstring" dir="in">
14125	<desc>Name of the key to get.</desc>
14126	</param>
14127	<param name="value" type="wstring" dir="return">
14128	<desc>Value of the requested key.</desc>
14129	</param>
14130	</method>
14131
14132	</interface>
14133
14134
14135	<!--
14136	// ISharedFolder
14137	/////////////////////////////////////////////////////////////////////////
14138	-->
14139
14140	<interface
14141	name="ISharedFolder" extends="$unknown"
14142	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14143	wsmap="struct"
14144	>
14145	<desc>
14146	The ISharedFolder interface represents a folder in the host computer's
14147	file system accessible from the guest OS running inside a virtual
14148	machine using an associated logical name.
14149
14150	There are three types of shared folders:
14151	<ul>
14152	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14153	folders available to all virtual machines.</li>
14154	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14155	VM-specific shared folders available to the given virtual machine at
14156	startup.</li>
14157	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14158	VM-specific shared folders created in the session context (for
14159	example, when the virtual machine is running) and automatically
14160	discarded when the session is closed (the VM is powered off).</li>
14161	</ul>
14162
14163	Logical names of shared folders must be unique within the given scope
14164	(global, permanent or transient). However, they do not need to be unique
14165	across scopes. In this case, the definition of the shared folder in a
14166	more specific scope takes precedence over definitions in all other
14167	scopes. The order of precedence is (more specific to more general):
14168	<ol>
14169	<li>Transient definitions</li>
14170	<li>Permanent definitions</li>
14171	<li>Global definitions</li>
14172	</ol>
14173
14174	For example, if MyMachine has a shared folder named
14175	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14176	transient shared folder named <tt>C_DRIVE</tt> (that points
14177	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14178	of <tt>C_DRIVE</tt> in the guest OS so
14179	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14180	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14181	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14182	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14183	to <tt>C:\\</tt> if it still exists.
14184
14185	Note that permanent and transient shared folders of different machines
14186	are in different name spaces, so they don't overlap and don't need to
14187	have unique logical names.
14188
14189	<note>
14190	Global shared folders are not implemented in the current version of the
14191	product.
14192	</note>
14193	</desc>
14194
14195	<attribute name="name" type="wstring" readonly="yes">
14196	<desc>Logical name of the shared folder.</desc>
14197	</attribute>
14198
14199	<attribute name="hostPath" type="wstring" readonly="yes">
14200	<desc>Full path to the shared folder in the host file system.</desc>
14201	</attribute>
14202
14203	<attribute name="accessible" type="boolean" readonly="yes">
14204	<desc>
14205	Whether the folder defined by the host path is currently
14206	accessible or not.
14207	For example, the folder can be inaccessible if it is placed
14208	on the network share that is not available by the time
14209	this property is read.
14210	</desc>
14211	</attribute>
14212
14213	<attribute name="writable" type="boolean" readonly="yes">
14214	<desc>
14215	Whether the folder defined by the host path is writable or
14216	not.
14217	</desc>
14218	</attribute>
14219
14220	<attribute name="autoMount" type="boolean" readonly="yes">
14221	<desc>
14222	Whether the folder gets automatically mounted by the guest or not.
14223	</desc>
14224	</attribute>
14225
14226	<attribute name="lastAccessError" type="wstring" readonly="yes">
14227	<desc>
14228	Text message that represents the result of the last accessibility
14229	check.
14230
14231	Accessibility checks are performed each time the <link to="#accessible"/>
14232	attribute is read. An empty string is returned if the last
14233	accessibility check was successful. A non-empty string indicates a
14234	failure and should normally describe a reason of the failure (for
14235	example, a file read error).
14236	</desc>
14237	</attribute>
14238
14239	</interface>
14240
14241	<!--
14242	// ISession
14243	/////////////////////////////////////////////////////////////////////////
14244	-->
14245
14246	<interface
14247	name="IInternalSessionControl" extends="$unknown"
14248	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14249	internal="yes"
14250	wsmap="suppress"
14251	>
14252	<method name="getPID">
14253	<desc>PID of the process that has created this Session object.
14254	</desc>
14255	<param name="pid" type="unsigned long" dir="return"/>
14256	</method>
14257
14258	<method name="getRemoteConsole">
14259	<desc>
14260	Returns the console object suitable for remote control.
14261
14262	<result name="VBOX_E_INVALID_VM_STATE">
14263	Session state prevents operation.
14264	</result>
14265	<result name="VBOX_E_INVALID_OBJECT_STATE">
14266	Session type prevents operation.
14267	</result>
14268
14269	</desc>
14270	<param name="console" type="IConsole" dir="return"/>
14271	</method>
14272
14273	<method name="assignMachine">
14274	<desc>
14275	Assigns the machine object associated with this direct-type
14276	session or informs the session that it will be a remote one
14277	(if @a machine == @c null).
14278
14279	<result name="VBOX_E_INVALID_VM_STATE">
14280	Session state prevents operation.
14281	</result>
14282	<result name="VBOX_E_INVALID_OBJECT_STATE">
14283	Session type prevents operation.
14284	</result>
14285
14286	</desc>
14287	<param name="machine" type="IMachine" dir="in"/>
14288	</method>
14289
14290	<method name="assignRemoteMachine">
14291	<desc>
14292	Assigns the machine and the (remote) console object associated with
14293	this remote-type session.
14294
14295	<result name="VBOX_E_INVALID_VM_STATE">
14296	Session state prevents operation.
14297	</result>
14298
14299	</desc>
14300	<param name="machine" type="IMachine" dir="in"/>
14301	<param name="console" type="IConsole" dir="in"/>
14302	</method>
14303
14304	<method name="updateMachineState">
14305	<desc>
14306	Updates the machine state in the VM process.
14307	Must be called only in certain cases
14308	(see the method implementation).
14309
14310	<result name="VBOX_E_INVALID_VM_STATE">
14311	Session state prevents operation.
14312	</result>
14313	<result name="VBOX_E_INVALID_OBJECT_STATE">
14314	Session type prevents operation.
14315	</result>
14316
14317	</desc>
14318	<param name="aMachineState" type="MachineState" dir="in"/>
14319	</method>
14320
14321	<method name="uninitialize">
14322	<desc>
14323	Uninitializes (closes) this session. Used by VirtualBox to close
14324	the corresponding remote session when the direct session dies
14325	or gets closed.
14326
14327	<result name="VBOX_E_INVALID_VM_STATE">
14328	Session state prevents operation.
14329	</result>
14330
14331	</desc>
14332	</method>
14333
14334	<method name="onNetworkAdapterChange">
14335	<desc>
14336	Triggered when settings of a network adapter of the
14337	associated virtual machine have changed.
14338
14339	<result name="VBOX_E_INVALID_VM_STATE">
14340	Session state prevents operation.
14341	</result>
14342	<result name="VBOX_E_INVALID_OBJECT_STATE">
14343	Session type prevents operation.
14344	</result>
14345
14346	</desc>
14347	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14348	<param name="changeAdapter" type="boolean" dir="in"/>
14349	</method>
14350
14351	<method name="onSerialPortChange">
14352	<desc>
14353	Triggered when settings of a serial port of the
14354	associated virtual machine have changed.
14355
14356	<result name="VBOX_E_INVALID_VM_STATE">
14357	Session state prevents operation.
14358	</result>
14359	<result name="VBOX_E_INVALID_OBJECT_STATE">
14360	Session type prevents operation.
14361	</result>
14362
14363	</desc>
14364	<param name="serialPort" type="ISerialPort" dir="in"/>
14365	</method>
14366
14367	<method name="onParallelPortChange">
14368	<desc>
14369	Triggered when settings of a parallel port of the
14370	associated virtual machine have changed.
14371
14372	<result name="VBOX_E_INVALID_VM_STATE">
14373	Session state prevents operation.
14374	</result>
14375	<result name="VBOX_E_INVALID_OBJECT_STATE">
14376	Session type prevents operation.
14377	</result>
14378
14379	</desc>
14380	<param name="parallelPort" type="IParallelPort" dir="in"/>
14381	</method>
14382
14383	<method name="onStorageControllerChange">
14384	<desc>
14385	Triggered when settings of a storage controller of the
14386	associated virtual machine have changed.
14387
14388	<result name="VBOX_E_INVALID_VM_STATE">
14389	Session state prevents operation.
14390	</result>
14391	<result name="VBOX_E_INVALID_OBJECT_STATE">
14392	Session type prevents operation.
14393	</result>
14394
14395	</desc>
14396	</method>
14397
14398	<method name="onMediumChange">
14399	<desc>
14400	Triggered when attached media of the
14401	associated virtual machine have changed.
14402
14403	<result name="VBOX_E_INVALID_VM_STATE">
14404	Session state prevents operation.
14405	</result>
14406	<result name="VBOX_E_INVALID_OBJECT_STATE">
14407	Session type prevents operation.
14408	</result>
14409
14410	</desc>
14411
14412	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14413	<desc>The medium attachment which changed.</desc>
14414	</param>
14415	<param name="force" type="boolean" dir="in">
14416	<desc>If the medium change was forced.</desc>
14417	</param>
14418	</method>
14419
14420	<method name="onStorageDeviceChange">
14421	<desc>
14422	Triggered when attached storage devices of the
14423	associated virtual machine have changed.
14424
14425	<result name="VBOX_E_INVALID_VM_STATE">
14426	Session state prevents operation.
14427	</result>
14428	<result name="VBOX_E_INVALID_OBJECT_STATE">
14429	Session type prevents operation.
14430	</result>
14431
14432	</desc>
14433
14434	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14435	<desc>The medium attachment which changed.</desc>
14436	</param>
14437	<param name="remove" type="boolean" dir="in">
14438	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14439	</param>
14440	</method>
14441
14442	<method name="onCPUChange">
14443	<desc>
14444	Notification when a CPU changes.
14445	</desc>
14446	<param name="cpu" type="unsigned long" dir="in">
14447	<desc>The CPU which changed</desc>
14448	</param>
14449	<param name="add" type="boolean" dir="in">
14450	<desc>Flag whether the CPU was added or removed</desc>
14451	</param>
14452	</method>
14453
14454	<method name="onCPUExecutionCapChange">
14455	<desc>
14456	Notification when the CPU execution cap changes.
14457	</desc>
14458	<param name="executionCap" type="unsigned long" dir="in">
14459	<desc>The new CPU execution cap value. (1-100)</desc>
14460	</param>
14461	</method>
14462
14463	<method name="onVRDEServerChange">
14464	<desc>
14465	Triggered when settings of the VRDE server object of the
14466	associated virtual machine have changed.
14467
14468	<result name="VBOX_E_INVALID_VM_STATE">
14469	Session state prevents operation.
14470	</result>
14471	<result name="VBOX_E_INVALID_OBJECT_STATE">
14472	Session type prevents operation.
14473	</result>
14474
14475	</desc>
14476	<param name="restart" type="boolean" dir="in">
14477	<desc>Flag whether the server must be restarted</desc>
14478	</param>
14479	</method>
14480
14481	<method name="onUSBControllerChange">
14482	<desc>
14483	Triggered when settings of the USB controller object of the
14484	associated virtual machine have changed.
14485
14486	<result name="VBOX_E_INVALID_VM_STATE">
14487	Session state prevents operation.
14488	</result>
14489	<result name="VBOX_E_INVALID_OBJECT_STATE">
14490	Session type prevents operation.
14491	</result>
14492
14493	</desc>
14494	</method>
14495
14496	<method name="onSharedFolderChange">
14497	<desc>
14498	Triggered when a permanent (global or machine) shared folder has been
14499	created or removed.
14500	<note>
14501	We don't pass shared folder parameters in this notification because
14502	the order in which parallel notifications are delivered is not defined,
14503	therefore it could happen that these parameters were outdated by the
14504	time of processing this notification.
14505	</note>
14506
14507	<result name="VBOX_E_INVALID_VM_STATE">
14508	Session state prevents operation.
14509	</result>
14510	<result name="VBOX_E_INVALID_OBJECT_STATE">
14511	Session type prevents operation.
14512	</result>
14513
14514	</desc>
14515	<param name="global" type="boolean" dir="in"/>
14516	</method>
14517
14518	<method name="onUSBDeviceAttach">
14519	<desc>
14520	Triggered when a request to capture a USB device (as a result
14521	of matched USB filters or direct call to
14522	<link to="IConsole::attachUSBDevice"/>) has completed.
14523	A @c null @a error object means success, otherwise it
14524	describes a failure.
14525
14526	<result name="VBOX_E_INVALID_VM_STATE">
14527	Session state prevents operation.
14528	</result>
14529	<result name="VBOX_E_INVALID_OBJECT_STATE">
14530	Session type prevents operation.
14531	</result>
14532
14533	</desc>
14534	<param name="device" type="IUSBDevice" dir="in"/>
14535	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14536	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14537	</method>
14538
14539	<method name="onUSBDeviceDetach">
14540	<desc>
14541	Triggered when a request to release the USB device (as a result
14542	of machine termination or direct call to
14543	<link to="IConsole::detachUSBDevice"/>) has completed.
14544	A @c null @a error object means success, otherwise it
14545	describes a failure.
14546
14547	<result name="VBOX_E_INVALID_VM_STATE">
14548	Session state prevents operation.
14549	</result>
14550	<result name="VBOX_E_INVALID_OBJECT_STATE">
14551	Session type prevents operation.
14552	</result>
14553
14554	</desc>
14555	<param name="id" type="uuid" mod="string" dir="in"/>
14556	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14557	</method>
14558
14559	<method name="onShowWindow">
14560	<desc>
14561	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14562	<link to="IMachine::showConsoleWindow"/> in order to notify
14563	console listeners
14564	<link to="ICanShowWindowEvent"/>
14565	and <link to="IShowWindowEvent"/>.
14566
14567	<result name="VBOX_E_INVALID_OBJECT_STATE">
14568	Session type prevents operation.
14569	</result>
14570
14571	</desc>
14572	<param name="check" type="boolean" dir="in"/>
14573	<param name="canShow" type="boolean" dir="out"/>
14574	<param name="winId" type="long long" dir="out"/>
14575	</method>
14576
14577	<method name="onBandwidthGroupChange">
14578	<desc>
14579	Notification when one of the bandwidth groups change.
14580	</desc>
14581	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14582	<desc>The bandwidth group which changed.</desc>
14583	</param>
14584	</method>
14585
14586	<method name="accessGuestProperty">
14587	<desc>
14588	Called by <link to="IMachine::getGuestProperty"/> and by
14589	<link to="IMachine::setGuestProperty"/> in order to read and
14590	modify guest properties.
14591
14592	<result name="VBOX_E_INVALID_VM_STATE">
14593	Machine session is not open.
14594	</result>
14595	<result name="VBOX_E_INVALID_OBJECT_STATE">
14596	Session type is not direct.
14597	</result>
14598
14599	</desc>
14600	<param name="name" type="wstring" dir="in"/>
14601	<param name="value" type="wstring" dir="in"/>
14602	<param name="flags" type="wstring" dir="in"/>
14603	<param name="isSetter" type="boolean" dir="in"/>
14604	<param name="retValue" type="wstring" dir="out"/>
14605	<param name="retTimestamp" type="long long" dir="out"/>
14606	<param name="retFlags" type="wstring" dir="out"/>
14607	</method>
14608
14609	<method name="enumerateGuestProperties" const="yes">
14610	<desc>
14611	Return a list of the guest properties matching a set of patterns along
14612	with their values, time stamps and flags.
14613
14614	<result name="VBOX_E_INVALID_VM_STATE">
14615	Machine session is not open.
14616	</result>
14617	<result name="VBOX_E_INVALID_OBJECT_STATE">
14618	Session type is not direct.
14619	</result>
14620
14621	</desc>
14622	<param name="patterns" type="wstring" dir="in">
14623	<desc>
14624	The patterns to match the properties against as a comma-separated
14625	string. If this is empty, all properties currently set will be
14626	returned.
14627	</desc>
14628	</param>
14629	<param name="key" type="wstring" dir="out" safearray="yes">
14630	<desc>
14631	The key names of the properties returned.
14632	</desc>
14633	</param>
14634	<param name="value" type="wstring" dir="out" safearray="yes">
14635	<desc>
14636	The values of the properties returned. The array entries match the
14637	corresponding entries in the @a key array.
14638	</desc>
14639	</param>
14640	<param name="timestamp" type="long long" dir="out" safearray="yes">
14641	<desc>
14642	The time stamps of the properties returned. The array entries match
14643	the corresponding entries in the @a key array.
14644	</desc>
14645	</param>
14646	<param name="flags" type="wstring" dir="out" safearray="yes">
14647	<desc>
14648	The flags of the properties returned. The array entries match the
14649	corresponding entries in the @a key array.
14650	</desc>
14651	</param>
14652	</method>
14653
14654	<method name="onlineMergeMedium">
14655	<desc>
14656	Triggers online merging of a hard disk. Used internally when deleting
14657	a snapshot while a VM referring to the same hard disk chain is running.
14658
14659	<result name="VBOX_E_INVALID_VM_STATE">
14660	Machine session is not open.
14661	</result>
14662	<result name="VBOX_E_INVALID_OBJECT_STATE">
14663	Session type is not direct.
14664	</result>
14665
14666	</desc>
14667	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14668	<desc>The medium attachment to identify the medium chain.</desc>
14669	</param>
14670	<param name="sourceIdx" type="unsigned long" dir="in">
14671	<desc>The index of the source image in the chain.
14672	Redundant, but drastically reduces IPC.</desc>
14673	</param>
14674	<param name="targetIdx" type="unsigned long" dir="in">
14675	<desc>The index of the target image in the chain.
14676	Redundant, but drastically reduces IPC.</desc>
14677	</param>
14678	<param name="source" type="IMedium" dir="in">
14679	<desc>Merge source medium.</desc>
14680	</param>
14681	<param name="target" type="IMedium" dir="in">
14682	<desc>Merge target medium.</desc>
14683	</param>
14684	<param name="mergeForward" type="boolean" dir="in">
14685	<desc>Merge direction.</desc>
14686	</param>
14687	<param name="parentForTarget" type="IMedium" dir="in">
14688	<desc>For forward merges: new parent for target medium.</desc>
14689	</param>
14690	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14691	<desc>For backward merges: list of media which need their parent UUID
14692	updated.</desc>
14693	</param>
14694	<param name="progress" type="IProgress" dir="in">
14695	<desc>
14696	Progress object for this operation.
14697	</desc>
14698	</param>
14699	</method>
14700
14701	</interface>
14702
14703	<interface
14704	name="ISession" extends="$unknown"
14705	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
14706	wsmap="managed"
14707	>
14708	<desc>
14709	The ISession interface represents a client process and allows for locking
14710	virtual machines (represented by IMachine objects) to prevent conflicting
14711	changes to the machine.
14712
14713	Any caller wishing to manipulate a virtual machine needs to create a session
14714	object first, which lives in its own process space. Such session objects are
14715	then associated with <link to="IMachine" /> objects living in the VirtualBox
14716	server process to coordinate such changes.
14717
14718	There are two typical scenarios in which sessions are used:
14719
14720	<ul>
14721	<li>To alter machine settings or control a running virtual machine, one
14722	needs to lock a machine for a given session (client process) by calling
14723	<link to="IMachine::lockMachine"/>.
14724
14725	Whereas multiple sessions may control a running virtual machine, only
14726	one process can obtain a write lock on the machine to prevent conflicting
14727	changes. A write lock is also needed if a process wants to actually run a
14728	virtual machine in its own context, such as the VirtualBox GUI or
14729	VBoxHeadless front-ends. They must also lock a machine for their own
14730	sessions before they are allowed to power up the virtual machine.
14731
14732	As a result, no machine settings can be altered while another process is
14733	already using it, either because that process is modifying machine settings
14734	or because the machine is running.
14735	</li>
14736	<li>
14737	To start a VM using one of the existing VirtualBox front-ends (e.g. the
14738	VirtualBox GUI or VBoxHeadless), one would use
14739	<link to="IMachine::launchVMProcess"/>, which also takes a session object
14740	as its first parameter. This session then identifies the caller and lets the
14741	caller control the started machine (for example, pause machine execution or
14742	power it down) as well as be notified about machine execution state changes.
14743	</li>
14744	</ul>
14745
14746	How sessions objects are created in a client process depends on whether you use
14747	the Main API via COM or via the webservice:
14748
14749	<ul>
14750	<li>When using the COM API directly, an object of the Session class from the
14751	VirtualBox type library needs to be created. In regular COM C++ client code,
14752	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
14753	This object will then act as a local session object in further calls to open
14754	a session.
14755	</li>
14756
14757	<li>In the webservice, the session manager (IWebsessionManager) instead creates
14758	a session object automatically whenever <link to="IWebsessionManager::logon" />
14759	is called. A managed object reference to that session object can be retrieved by
14760	calling <link to="IWebsessionManager::getSessionObject" />.
14761	</li>
14762	</ul>
14763	</desc>
14764
14765	<attribute name="state" type="SessionState" readonly="yes">
14766	<desc>Current state of this session.</desc>
14767	</attribute>
14768
14769	<attribute name="type" type="SessionType" readonly="yes">
14770	<desc>
14771	Type of this session. The value of this attribute is valid only
14772	if the session currently has a machine locked (i.e. its
14773	<link to="#state" /> is Locked), otherwise an error will be returned.
14774	</desc>
14775	</attribute>
14776
14777	<attribute name="machine" type="IMachine" readonly="yes">
14778	<desc>Machine object associated with this session.</desc>
14779	</attribute>
14780
14781	<attribute name="console" type="IConsole" readonly="yes">
14782	<desc>Console object associated with this session.</desc>
14783	</attribute>
14784
14785	<method name="unlockMachine">
14786	<desc>
14787	Unlocks a machine that was previously locked for the current session.
14788
14789	Calling this method is required every time a machine has been locked
14790	for a particular session using the <link to="IMachine::launchVMProcess" />
14791	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
14792	the machine will be set to <link to="MachineState_Aborted" /> on the
14793	server, and changes made to the machine settings will be lost.
14794
14795	Generally, it is recommended to unlock all machines explicitly
14796	before terminating the application (regardless of the reason for
14797	the termination).
14798
14799	<note>
14800	Do not expect the session state (<link to="ISession::state" />
14801	to return to "Unlocked" immediately after you invoke this method,
14802	particularly if you have started a new VM process. The session
14803	state will automatically return to "Unlocked" once the VM is no
14804	longer executing, which can of course take a very long time.
14805	</note>
14806
14807	<result name="E_UNEXPECTED">
14808	Session is not locked.
14809	</result>
14810
14811	</desc>
14812	</method>
14813
14814	</interface>
14815
14816	<!--
14817	// IStorageController
14818	/////////////////////////////////////////////////////////////////////////
14819	-->
14820
14821	<enum
14822	name="StorageBus"
14823	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
14824	>
14825	<desc>
14826	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
14827	see <link to="IStorageController::bus" />.
14828	</desc>
14829	<const name="Null" value="0">
14830	<desc>@c null value. Never used by the API.</desc>
14831	</const>
14832	<const name="IDE" value="1"/>
14833	<const name="SATA" value="2"/>
14834	<const name="SCSI" value="3"/>
14835	<const name="Floppy" value="4"/>
14836	<const name="SAS" value="5"/>
14837	</enum>
14838
14839	<enum
14840	name="StorageControllerType"
14841	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
14842	>
14843	<desc>
14844	The exact variant of storage controller hardware presented
14845	to the guest; see <link to="IStorageController::controllerType" />.
14846	</desc>
14847
14848	<const name="Null" value="0">
14849	<desc>@c null value. Never used by the API.</desc>
14850	</const>
14851	<const name="LsiLogic" value="1">
14852	<desc>A SCSI controller of the LsiLogic variant.</desc>
14853	</const>
14854	<const name="BusLogic" value="2">
14855	<desc>A SCSI controller of the BusLogic variant.</desc>
14856	</const>
14857	<const name="IntelAhci" value="3">
14858	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
14859	</const>
14860	<const name="PIIX3" value="4">
14861	<desc>An IDE controller of the PIIX3 variant.</desc>
14862	</const>
14863	<const name="PIIX4" value="5">
14864	<desc>An IDE controller of the PIIX4 variant.</desc>
14865	</const>
14866	<const name="ICH6" value="6">
14867	<desc>An IDE controller of the ICH6 variant.</desc>
14868	</const>
14869	<const name="I82078" value="7">
14870	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14871	</const>
14872	<const name="LsiLogicSas" value="8">
14873	<desc>A variant of the LsiLogic controller using SAS.</desc>
14874	</const>
14875	</enum>
14876
14877	<enum
14878	name="ChipsetType"
14879	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14880	>
14881	<desc>
14882	Type of emulated chipset (mostly southbridge).
14883	</desc>
14884
14885	<const name="Null" value="0">
14886	<desc>@c null value. Never used by the API.</desc>
14887	</const>
14888	<const name="PIIX3" value="1">
14889	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14890	</const>
14891	<const name="ICH9" value="2">
14892	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14893	</const>
14894	</enum>
14895
14896	<interface
14897	name="IStorageController" extends="$unknown"
14898	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14899	wsmap="managed"
14900	>
14901	<desc>
14902	Represents a storage controller that is attached to a virtual machine
14903	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14904	attached to storage controllers in a real computer, virtual drives
14905	(represented by <link to="IMediumAttachment" />) are attached to virtual
14906	storage controllers, represented by this interface.
14907
14908	As opposed to physical hardware, VirtualBox has a very generic concept
14909	of a storage controller, and for purposes of the Main API, all virtual
14910	storage is attached to virtual machines via instances of this interface.
14911	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14912	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14913	is used, certain sub-types may be available and can be selected in
14914	<link to="#controllerType" />.
14915
14916	Depending on these settings, the guest operating system might see
14917	significantly different virtual hardware.
14918	</desc>
14919
14920	<attribute name="name" type="wstring" readonly="yes">
14921	<desc>
14922	Name of the storage controller, as originally specified with
14923	<link to="IMachine::addStorageController" />. This then uniquely
14924	identifies this controller with other method calls such as
14925	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14926	</desc>
14927	</attribute>
14928
14929	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14930	<desc>
14931	Maximum number of devices which can be attached to one port.
14932	</desc>
14933	</attribute>
14934
14935	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14936	<desc>
14937	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14938	</desc>
14939	</attribute>
14940
14941	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14942	<desc>
14943	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14944	</desc>
14945	</attribute>
14946
14947	<attribute name="instance" type="unsigned long">
14948	<desc>
14949	The instance number of the device in the running VM.
14950	</desc>
14951	</attribute>
14952
14953	<attribute name="portCount" type="unsigned long">
14954	<desc>
14955	The number of currently usable ports on the controller.
14956	The minimum and maximum number of ports for one controller are
14957	stored in <link to="IStorageController::minPortCount"/>
14958	and <link to="IStorageController::maxPortCount"/>.
14959	</desc>
14960	</attribute>
14961
14962	<attribute name="bus" type="StorageBus" readonly="yes">
14963	<desc>
14964	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14965	</desc>
14966	</attribute>
14967
14968	<attribute name="controllerType" type="StorageControllerType">
14969	<desc>
14970	The exact variant of storage controller hardware presented
14971	to the guest.
14972	Depending on this value, VirtualBox will provide a different
14973	virtual storage controller hardware to the guest.
14974	For SATA, SAS and floppy controllers, only one variant is
14975	available, but for IDE and SCSI, there are several.
14976
14977	For SCSI controllers, the default type is LsiLogic.
14978	</desc>
14979	</attribute>
14980
14981	<attribute name="useHostIOCache" type="boolean">
14982	<desc>
14983	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14984	caches and use synchronous file APIs on the host. This was the only option in the API before
14985	VirtualBox 3.2 and is still the default for IDE controllers.
14986
14987	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14988	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14989	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14990	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14991	virtual machines are running at the same time to prevent I/O cache related hangs.
14992	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14993	</desc>
14994	</attribute>
14995
14996	<attribute name="bootable" type="boolean" readonly="yes">
14997	<desc>
14998	Returns whether it is possible to boot from disks attached to this controller.
14999	</desc>
15000	</attribute>
15001
15002	<method name="getIDEEmulationPort">
15003	<desc>
15004	Gets the corresponding port number which is emulated as an IDE device.
15005	Works only with SATA controllers.
15006
15007	<result name="E_INVALIDARG">
15008	The @a devicePosition is not in the range 0 to 3.
15009	</result>
15010	<result name="E_NOTIMPL">
15011	The storage controller type is not SATAIntelAhci.
15012	</result>
15013
15014	</desc>
15015	<param name="devicePosition" type="long" dir="in"/>
15016	<param name="portNumber" type="long" dir="return"/>
15017	</method>
15018
15019	<method name="setIDEEmulationPort">
15020	<desc>
15021	Sets the port number which is emulated as an IDE device.
15022	Works only with SATA controllers.
15023
15024	<result name="E_INVALIDARG">
15025	The @a devicePosition is not in the range 0 to 3 or the
15026	@a portNumber is not in the range 0 to 29.
15027	</result>
15028	<result name="E_NOTIMPL">
15029	The storage controller type is not SATAIntelAhci.
15030	</result>
15031
15032	</desc>
15033	<param name="devicePosition" type="long" dir="in"/>
15034	<param name="portNumber" type="long" dir="in"/>
15035	</method>
15036
15037	</interface>
15038
15039	<if target="wsdl">
15040
15041	<!--
15042	// IManagedObjectRef
15043	/////////////////////////////////////////////////////////////////////////
15044	-->
15045
15046	<interface
15047	name="IManagedObjectRef" extends="$unknown"
15048	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15049	internal="yes"
15050	wsmap="managed"
15051	wscpp="hardcoded"
15052	>
15053	<desc>
15054	Managed object reference.
15055
15056	Only within the webservice, a managed object reference (which is really
15057	an opaque number) allows a webservice client to address an object
15058	that lives in the address space of the webservice server.
15059
15060	Behind each managed object reference, there is a COM object that lives
15061	in the webservice server's address space. The COM object is not freed
15062	until the managed object reference is released, either by an explicit
15063	call to <link to="IManagedObjectRef::release" /> or by logging off from
15064	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15065	all objects created during the webservice session.
15066
15067	Whenever a method call of the VirtualBox API returns a COM object, the
15068	webservice representation of that method will instead return a
15069	managed object reference, which can then be used to invoke methods
15070	on that object.
15071	</desc>
15072
15073	<method name="getInterfaceName">
15074	<desc>
15075	Returns the name of the interface that this managed object represents,
15076	for example, "IMachine", as a string.
15077	</desc>
15078	<param name="return" type="wstring" dir="return"/>
15079	</method>
15080
15081	<method name="release">
15082	<desc>
15083	Releases this managed object reference and frees the resources that
15084	were allocated for it in the webservice server process. After calling
15085	this method, the identifier of the reference can no longer be used.
15086	</desc>
15087	</method>
15088
15089	</interface>
15090
15091	<!--
15092	// IWebsessionManager
15093	/////////////////////////////////////////////////////////////////////////
15094	-->
15095
15096	<interface
15097	name="IWebsessionManager" extends="$unknown"
15098	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15099	internal="yes"
15100	wsmap="global"
15101	wscpp="hardcoded"
15102	>
15103	<desc>
15104	Websession manager. This provides essential services
15105	to webservice clients.
15106	</desc>
15107	<method name="logon">
15108	<desc>
15109	Logs a new client onto the webservice and returns a managed object reference to
15110	the IVirtualBox instance, which the client can then use as a basis to further
15111	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15112	interface, in one way or the other.
15113	</desc>
15114	<param name="username" type="wstring" dir="in"/>
15115	<param name="password" type="wstring" dir="in"/>
15116	<param name="return" type="IVirtualBox" dir="return"/>
15117	</method>
15118
15119	<method name="getSessionObject">
15120	<desc>
15121	Returns a managed object reference to the internal ISession object that was created
15122	for this web service session when the client logged on.
15123
15124	<see><link to="ISession"/></see>
15125	</desc>
15126	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15127	<param name="return" type="ISession" dir="return"/>
15128	</method>
15129
15130	<method name="logoff">
15131	<desc>
15132	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
15133	and destroys all resources associated with the session (most importantly, all
15134	managed objects created in the server while the session was active).
15135	</desc>
15136	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15137	</method>
15138
15139	</interface>
15140
15141	</if>
15142
15143	<!--
15144	// IPerformanceCollector & friends
15145	/////////////////////////////////////////////////////////////////////////
15146	-->
15147
15148	<interface
15149	name="IPerformanceMetric" extends="$unknown"
15150	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15151	>
15152	<desc>
15153	The IPerformanceMetric interface represents parameters of the given
15154	performance metric.
15155	</desc>
15156
15157	<attribute name="metricName" type="wstring" readonly="yes">
15158	<desc>
15159	Name of the metric.
15160	</desc>
15161	</attribute>
15162
15163	<attribute name="object" type="$unknown" readonly="yes">
15164	<desc>
15165	Object this metric belongs to.
15166	</desc>
15167	</attribute>
15168
15169	<attribute name="description" type="wstring" readonly="yes">
15170	<desc>
15171	Textual description of the metric.
15172	</desc>
15173	</attribute>
15174
15175	<attribute name="period" type="unsigned long" readonly="yes">
15176	<desc>
15177	Time interval between samples, measured in seconds.
15178	</desc>
15179	</attribute>
15180
15181	<attribute name="count" type="unsigned long" readonly="yes">
15182	<desc>
15183	Number of recent samples retained by the performance collector for this
15184	metric.
15185
15186	When the collected sample count exceeds this number, older samples
15187	are discarded.
15188	</desc>
15189	</attribute>
15190
15191	<attribute name="unit" type="wstring" readonly="yes">
15192	<desc>
15193	Unit of measurement.
15194	</desc>
15195	</attribute>
15196
15197	<attribute name="minimumValue" type="long" readonly="yes">
15198	<desc>
15199	Minimum possible value of this metric.
15200	</desc>
15201	</attribute>
15202
15203	<attribute name="maximumValue" type="long" readonly="yes">
15204	<desc>
15205	Maximum possible value of this metric.
15206	</desc>
15207	</attribute>
15208	</interface>
15209
15210	<interface
15211	name="IPerformanceCollector" extends="$unknown"
15212	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15213	wsmap="managed"
15214	>
15215	<desc>
15216	The IPerformanceCollector interface represents a service that collects
15217	and stores performance metrics data.
15218
15219	Performance metrics are associated with objects of interfaces like IHost
15220	and IMachine. Each object has a distinct set of performance metrics. The
15221	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15222
15223	Metric data is collected at the specified intervals and is retained
15224	internally. The interval and the number of retained samples can be set
15225	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15226	and collection settings are not persistent, they are discarded as soon as
15227	VBoxSVC process terminates. Moreover, metric settings and data associated
15228	with a particular VM only exist while VM is running. They disappear as
15229	soon as VM shuts down. It is not possible to set up metrics for machines
15230	that are powered off. One needs to start VM first, then set up metric
15231	collection parameters.
15232
15233	Metrics are organized hierarchically, with each level separated by a
15234	slash (/) character. Generally, the scheme for metric names is like this:
15235
15236	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15237
15238	"Category/Metric" together form the base metric name. A base metric is
15239	the smallest unit for which a sampling interval and the number of
15240	retained samples can be set. Only base metrics can be enabled and
15241	disabled. All sub-metrics are collected when their base metric is
15242	collected. Collected values for any set of sub-metrics can be queried
15243	with <link to="IPerformanceCollector::queryMetricsData" />.
15244
15245	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15246	category, "Load" metric, "User" submetric, "average" aggregate. An
15247	aggregate function is computed over all retained data. Valid aggregate
15248	functions are:
15249
15250	<ul>
15251	<li>avg -- average</li>
15252	<li>min -- minimum</li>
15253	<li>max -- maximum</li>
15254	</ul>
15255
15256	When setting up metric parameters, querying metric data, enabling or
15257	disabling metrics wildcards can be used in metric names to specify a
15258	subset of metrics. For example, to select all CPU-related metrics
15259	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15260	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15261
15262	The valid names for base metrics are:
15263
15264	<ul>
15265	<li>CPU/Load</li>
15266	<li>CPU/MHz</li>
15267	<li>RAM/Usage</li>
15268	<li>RAM/VMM</li>
15269	</ul>
15270
15271	The general sequence for collecting and retrieving the metrics is:
15272	<ul>
15273	<li>
15274	Obtain an instance of IPerformanceCollector with
15275	<link to="IVirtualBox::performanceCollector" />
15276	</li>
15277	<li>
15278	Allocate and populate an array with references to objects the metrics
15279	will be collected for. Use references to IHost and IMachine objects.
15280	</li>
15281	<li>
15282	Allocate and populate an array with base metric names the data will
15283	be collected for.
15284	</li>
15285	<li>
15286	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15287	the metric data will be collected and stored.
15288	</li>
15289	<li>
15290	Wait for the data to get collected.
15291	</li>
15292	<li>
15293	Allocate and populate an array with references to objects the metric
15294	values will be queried for. You can re-use the object array used for
15295	setting base metrics.
15296	</li>
15297	<li>
15298	Allocate and populate an array with metric names the data will be
15299	collected for. Note that metric names differ from base metric names.
15300	</li>
15301	<li>
15302	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15303	that have been collected so far are returned. Note that the values
15304	are still retained internally and data collection continues.
15305	</li>
15306	</ul>
15307
15308	For an example of usage refer to the following files in VirtualBox SDK:
15309	<ul>
15310	<li>
15311	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15312	</li>
15313	<li>
15314	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15315	</li>
15316	</ul>
15317	</desc>
15318
15319	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15320	<desc>
15321	Array of unique names of metrics.
15322
15323	This array represents all metrics supported by the performance
15324	collector. Individual objects do not necessarily support all of them.
15325	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15326	list of supported metrics for a particular object.
15327	</desc>
15328	</attribute>
15329
15330	<method name="getMetrics">
15331	<desc>
15332	Returns parameters of specified metrics for a set of objects.
15333	<note>
15334	@c Null metrics array means all metrics. @c Null object array means
15335	all existing objects.
15336	</note>
15337	</desc>
15338	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15339	<desc>
15340	Metric name filter. Currently, only a comma-separated list of metrics
15341	is supported.
15342	</desc>
15343	</param>
15344	<param name="objects" type="$unknown" dir="in" safearray="yes">
15345	<desc>
15346	Set of objects to return metric parameters for.
15347	</desc>
15348	</param>
15349	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15350	<desc>
15351	Array of returned metric parameters.
15352	</desc>
15353	</param>
15354	</method>
15355
15356	<method name="setupMetrics">
15357	<desc>
15358	Sets parameters of specified base metrics for a set of objects. Returns
15359	an array of <link to="IPerformanceMetric" /> describing the metrics
15360	have been affected.
15361	<note>
15362	@c Null or empty metric name array means all metrics. @c Null or
15363	empty object array means all existing objects. If metric name array
15364	contains a single element and object array contains many, the single
15365	metric name array element is applied to each object array element to
15366	form metric/object pairs.
15367	</note>
15368	</desc>
15369	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15370	<desc>
15371	Metric name filter. Comma-separated list of metrics with wildcard
15372	support.
15373	</desc>
15374	</param>
15375	<param name="objects" type="$unknown" dir="in" safearray="yes">
15376	<desc>
15377	Set of objects to setup metric parameters for.
15378	</desc>
15379	</param>
15380	<param name="period" type="unsigned long" dir="in">
15381	<desc>
15382	Time interval in seconds between two consecutive samples of
15383	performance data.
15384	</desc>
15385	</param>
15386	<param name="count" type="unsigned long" dir="in">
15387	<desc>
15388	Number of samples to retain in performance data history. Older
15389	samples get discarded.
15390	</desc>
15391	</param>
15392	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15393	<desc>
15394	Array of metrics that have been modified by the call to this method.
15395	</desc>
15396	</param>
15397	</method>
15398
15399	<method name="enableMetrics">
15400	<desc>
15401	Turns on collecting specified base metrics. Returns an array of
15402	<link to="IPerformanceMetric" /> describing the metrics have been
15403	affected.
15404	<note>
15405	@c Null or empty metric name array means all metrics. @c Null or
15406	empty object array means all existing objects. If metric name array
15407	contains a single element and object array contains many, the single
15408	metric name array element is applied to each object array element to
15409	form metric/object pairs.
15410	</note>
15411	</desc>
15412	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15413	<desc>
15414	Metric name filter. Comma-separated list of metrics with wildcard
15415	support.
15416	</desc>
15417	</param>
15418	<param name="objects" type="$unknown" dir="in" safearray="yes">
15419	<desc>
15420	Set of objects to enable metrics for.
15421	</desc>
15422	</param>
15423	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15424	<desc>
15425	Array of metrics that have been modified by the call to this method.
15426	</desc>
15427	</param>
15428	</method>
15429
15430	<method name="disableMetrics">
15431	<desc>
15432	Turns off collecting specified base metrics. Returns an array of
15433	<link to="IPerformanceMetric" /> describing the metrics have been
15434	affected.
15435	<note>
15436	@c Null or empty metric name array means all metrics. @c Null or
15437	empty object array means all existing objects. If metric name array
15438	contains a single element and object array contains many, the single
15439	metric name array element is applied to each object array element to
15440	form metric/object pairs.
15441	</note>
15442	</desc>
15443	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15444	<desc>
15445	Metric name filter. Comma-separated list of metrics with wildcard
15446	support.
15447	</desc>
15448	</param>
15449	<param name="objects" type="$unknown" dir="in" safearray="yes">
15450	<desc>
15451	Set of objects to disable metrics for.
15452	</desc>
15453	</param>
15454	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15455	<desc>
15456	Array of metrics that have been modified by the call to this method.
15457	</desc>
15458	</param>
15459	</method>
15460
15461	<method name="queryMetricsData">
15462	<desc>
15463	Queries collected metrics data for a set of objects.
15464
15465	The data itself and related metric information are returned in seven
15466	parallel and one flattened array of arrays. Elements of
15467	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15468	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15469	the same index describe one set of values corresponding to a single
15470	metric.
15471
15472	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15473	start and length of a sub-array is indicated by
15474	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15475	value for metric <tt>metricNames[i]</tt> is at
15476	<tt>returnData[returnIndices[i]]</tt>.
15477
15478	<note>
15479	@c Null or empty metric name array means all metrics. @c Null or
15480	empty object array means all existing objects. If metric name array
15481	contains a single element and object array contains many, the single
15482	metric name array element is applied to each object array element to
15483	form metric/object pairs.
15484	</note>
15485	<note>
15486	Data collection continues behind the scenes after call to @c
15487	queryMetricsData. The return data can be seen as the snapshot of the
15488	current state at the time of @c queryMetricsData call. The internally
15489	kept metric values are not cleared by the call. This makes possible
15490	querying different subsets of metrics or aggregates with subsequent
15491	calls. If periodic querying is needed it is highly suggested to query
15492	the values with @c interval*count period to avoid confusion. This way
15493	a completely new set of data values will be provided by each query.
15494	</note>
15495	</desc>
15496	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15497	<desc>
15498	Metric name filter. Comma-separated list of metrics with wildcard
15499	support.
15500	</desc>
15501	</param>
15502	<param name="objects" type="$unknown" dir="in" safearray="yes">
15503	<desc>
15504	Set of objects to query metrics for.
15505	</desc>
15506	</param>
15507	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15508	<desc>
15509	Names of metrics returned in @c returnData.
15510	</desc>
15511	</param>
15512	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15513	<desc>
15514	Objects associated with metrics returned in @c returnData.
15515	</desc>
15516	</param>
15517	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15518	<desc>
15519	Units of measurement for each returned metric.
15520	</desc>
15521	</param>
15522	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15523	<desc>
15524	Divisor that should be applied to return values in order to get
15525	floating point values. For example:
15526	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15527	will retrieve the floating point value of i-th sample of the first
15528	metric.
15529	</desc>
15530	</param>
15531	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15532	<desc>
15533	Sequence numbers of the first elements of value sequences of
15534	particular metrics returned in @c returnData. For aggregate metrics
15535	it is the sequence number of the sample the aggregate started
15536	calculation from.
15537	</desc>
15538	</param>
15539	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15540	<desc>
15541	Indices of the first elements of value sequences of particular
15542	metrics returned in @c returnData.
15543	</desc>
15544	</param>
15545	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15546	<desc>
15547	Lengths of value sequences of particular metrics.
15548	</desc>
15549	</param>
15550	<param name="returnData" type="long" dir="return" safearray="yes">
15551	<desc>
15552	Flattened array of all metric data containing sequences of values for
15553	each metric.
15554	</desc>
15555	</param>
15556	</method>
15557
15558	</interface>
15559
15560	<enum
15561	name="NATAliasMode"
15562	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15563	>
15564	<desc></desc>
15565	<const name="AliasLog" value="0x1">
15566	<desc></desc>
15567	</const>
15568	<const name="AliasProxyOnly" value="0x02">
15569	<desc></desc>
15570	</const>
15571	<const name="AliasUseSamePorts" value="0x04">
15572	<desc></desc>
15573	</const>
15574	</enum>
15575
15576	<enum
15577	name="NATProtocol"
15578	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15579	>
15580	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15581	<const name="UDP" value="0">
15582	<desc>Port-forwarding uses UDP protocol.</desc>
15583	</const>
15584	<const name="TCP" value="1">
15585	<desc>Port-forwarding uses TCP protocol.</desc>
15586	</const>
15587	</enum>
15588
15589	<interface
15590	name="INATEngine" extends="$unknown"
15591	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15592	wsmap="managed"
15593	>
15594	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15595	allows for changing NAT behavior such as port-forwarding rules. This interface is
15596	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15597	<attribute name="network" type="wstring">
15598	<desc>The network attribute of the NAT engine (the same value is used with built-in
15599	DHCP server to fill corresponding fields of DHCP leases).</desc>
15600	</attribute>
15601	<attribute name="hostIP" type="wstring">
15602	<desc>IP of host interface to bind all opened sockets to.
15603	<note>Changing this does not change binding of port forwarding.</note>
15604	</desc>
15605	</attribute>
15606	<attribute name="tftpPrefix" type="wstring">
15607	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15608	the corresponding fields of DHCP leases.</desc>
15609	</attribute>
15610	<attribute name="tftpBootFile" type="wstring">
15611	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15612	the corresponding fields of DHCP leases.</desc>
15613	</attribute>
15614	<attribute name="tftpNextServer" type="wstring">
15615	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15616	the corresponding fields of DHCP leases.
15617	<note>The preferred form is IPv4 addresses.</note>
15618	</desc>
15619	</attribute>
15620	<attribute name="aliasMode" type="unsigned long">
15621	<desc></desc>
15622	</attribute>
15623	<attribute name="dnsPassDomain" type="boolean">
15624	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15625	</attribute>
15626	<attribute name="dnsProxy" type="boolean">
15627	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15628	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15629	</attribute>
15630	<attribute name="dnsUseHostResolver" type="boolean">
15631	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15632	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15633	</attribute>
15634	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15635	<desc>Array of NAT port-forwarding rules in string representation, in the following
15636	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15637	</attribute>
15638	<method name="setNetworkSettings">
15639	<desc>Sets network configuration of the NAT engine.</desc>
15640	<param name="mtu" type="unsigned long" dir="in">
15641	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15642	</param>
15643	<param name="sockSnd" type="unsigned long" dir="in">
15644	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15645	</param>
15646	<param name="sockRcv" type="unsigned long" dir="in">
15647	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15648	</param>
15649	<param name="TcpWndSnd" type="unsigned long" dir="in">
15650	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15651	establishing a new TCP connection.</desc>
15652	</param>
15653	<param name="TcpWndRcv" type="unsigned long" dir="in">
15654	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15655	establishing a new TCP connection.</desc>
15656	</param>
15657	</method>
15658	<method name="getNetworkSettings">
15659	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15660	for parameter descriptions.</desc>
15661	<param name="mtu" type="unsigned long" dir="out" />
15662	<param name="sockSnd" type="unsigned long" dir="out" />
15663	<param name="sockRcv" type="unsigned long" dir="out" />
15664	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15665	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15666	</method>
15667	<method name="addRedirect">
15668	<desc>Adds a new NAT port-forwarding rule.</desc>
15669	<param name="name" type="wstring" dir="in">
15670	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15671	auto-generates one using the other parameters.</desc>
15672	</param>
15673	<param name="proto" type="NATProtocol" dir="in">
15674	<desc>Protocol handled with the rule.</desc>
15675	</param>
15676	<param name="hostIp" type="wstring" dir="in">
15677	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15678	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15679	</param>
15680	<param name="hostPort" type="unsigned short" dir="in">
15681	<desc>The port number to listen on.</desc>
15682	</param>
15683	<param name="guestIp" type="wstring" dir="in">
15684	<desc>The IP address of the guest which the NAT engine will forward matching packets
15685	to. An empty IP address is acceptable, in which case the NAT engine will forward
15686	packets to the first DHCP lease (x.x.x.15).</desc>
15687	</param>
15688	<param name="guestPort" type="unsigned short" dir="in">
15689	<desc>The port number to forward.</desc>
15690	</param>
15691	</method>
15692	<method name="removeRedirect">
15693	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15694	<param name="name" type="wstring" dir="in">
15695	<desc>The name of the rule to delete.</desc>
15696	</param>
15697	</method>
15698	</interface>
15699
15700	<!--
15701	// IExtPackManager
15702	/////////////////////////////////////////////////////////////////////////
15703	-->
15704
15705	<interface
15706	name="IExtPackPlugIn" extends="$unknown"
15707	uuid="58000040-e718-4746-bbce-4b86d96da461"
15708	wsmap="suppress"
15709	>
15710	<desc>
15711	Interface for keeping information about a plug-in that ships with an
15712	extension pack.
15713	</desc>
15714	<attribute name="name" type="wstring" readonly="yes">
15715	<desc>The plug-in name.</desc>
15716	</attribute>
15717	<attribute name="description" type="wstring" readonly="yes">
15718	<desc>The plug-in description.</desc>
15719	</attribute>
15720	<attribute name="frontend" type="wstring" readonly="yes">
15721	<desc>
15722	The name of the frontend or component name this plug-in plugs into.
15723	</desc>
15724	</attribute>
15725	<attribute name="modulePath" type="wstring" readonly="yes">
15726	<desc> The module path. </desc>
15727	</attribute>
15728	</interface>
15729
15730	<interface
15731	name="IExtPackBase" extends="$unknown"
15732	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
15733	wsmap="suppress"
15734	>
15735	<desc>
15736	Interface for querying information about an extension pack as well as
15737	accessing COM objects within it.
15738	</desc>
15739	<attribute name="name" type="wstring" readonly="yes">
15740	<desc>The extension pack name. This is unique.</desc>
15741	</attribute>
15742	<attribute name="description" type="wstring" readonly="yes">
15743	<desc>The extension pack description.</desc>
15744	</attribute>
15745	<attribute name="version" type="wstring" readonly="yes">
15746	<desc>
15747	The extension pack version string. This is on the same form as
15748	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
15749	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
15750	or "1.2.3_BETA1-r45678-OSE"
15751	</desc>
15752	</attribute>
15753	<attribute name="revision" type="unsigned long" readonly="yes">
15754	<desc>The extension pack internal revision number.</desc>
15755	</attribute>
15756	<attribute name="VRDEModule" type="wstring" readonly="yes">
15757	<desc>The name of the VRDE module if the extension pack sports one.</desc>
15758	</attribute>
15759	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
15760	<desc>Plug-ins provided by this extension pack.</desc>
15761	</attribute>
15762	<attribute name="usable" type="boolean" readonly="yes">
15763	<desc>
15764	Indicates whether the extension pack is usable or not.
15765
15766	There are a number of reasons why an extension pack might be unusable,
15767	typical examples would be broken installation/file or that it is
15768	incompatible with the current VirtualBox version.
15769	</desc>
15770	</attribute>
15771	<attribute name="whyUnusable" type="wstring" readonly="yes">
15772	<desc>
15773	String indicating why the extension pack is not usable. This is an
15774	empty string if usable and always a non-empty string if not usable.
15775	</desc>
15776	</attribute>
15777	<attribute name="showLicense" type="boolean" readonly="yes">
15778	<desc>Whether to show the license before installation</desc>
15779	</attribute>
15780	<attribute name="license" type="wstring" readonly="yes">
15781	<desc>
15782	The default HTML license text for the extension pack. Same as
15783	calling <link to="#queryLicense">queryLicense</link> with
15784	preferredLocale and preferredLanguage as empty strings and format set
15785	to html.
15786	</desc>
15787	</attribute>
15788
15789	<method name="queryLicense">
15790	<desc>
15791	Full feature version of the license attribute.
15792	</desc>
15793	<param name="preferredLocale" type="wstring" dir="in">
15794	<desc>
15795	The preferred license locale. Pass an empty string to get the default
15796	license.
15797	</desc>
15798	</param>
15799	<param name="preferredLanguage" type="wstring" dir="in">
15800	<desc>
15801	The preferred license language. Pass an empty string to get the
15802	default language for the locale.
15803	</desc>
15804	</param>
15805	<param name="format" type="wstring" dir="in">
15806	<desc>
15807	The license format: html, rtf or txt. If a license is present there
15808	will always be an HTML of it, the rich text format (RTF) and plain
15809	text (txt) versions are optional. If
15810	</desc>
15811	</param>
15812	<param name="licenseText" type="wstring" dir="return">
15813	<desc>The license text.</desc>
15814	</param>
15815	</method>
15816
15817	</interface>
15818
15819	<interface
15820	name="IExtPack" extends="IExtPackBase"
15821	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
15822	wsmap="suppress"
15823	>
15824	<desc>
15825	Interface for querying information about an extension pack as well as
15826	accessing COM objects within it.
15827	</desc>
15828	<method name="queryObject">
15829	<desc>
15830	Queries the IUnknown interface to an object in the extension pack
15831	main module. This allows plug-ins and others to talk directly to an
15832	extension pack.
15833	</desc>
15834	<param name="objUuid" type="wstring" dir="in">
15835	<desc>The object ID. What exactly this is </desc>
15836	</param>
15837	<param name="returnInterface" type="$unknown" dir="return">
15838	<desc>The queried interface.</desc>
15839	</param>
15840	</method>
15841	</interface>
15842
15843	<interface
15844	name="IExtPackFile" extends="IExtPackBase"
15845	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
15846	wsmap="suppress"
15847	>
15848	<desc>
15849	Extension pack file (aka tarball, .vbox-extpack) representation returned
15850	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
15851	extension pack information with the addition of the file name.
15852	</desc>
15853	<attribute name="filePath" type="wstring" readonly="yes">
15854	<desc>
15855	The path to the extension pack file.
15856	</desc>
15857	</attribute>
15858
15859	<method name="install">
15860	<desc>
15861	Install the extension pack.
15862	</desc>
15863	<param name="replace" type="boolean" dir="in">
15864	<desc>
15865	Set this to automatically uninstall any existing extension pack with
15866	the same name as the one being installed.
15867	</desc>
15868	</param>
15869	<param name="displayInfo" type="wstring" dir="in">
15870	<desc>
15871	Platform specific display information. Reserved for future hacks.
15872	</desc>
15873	</param>
15874	<param name="progess" type="IProgress" dir="return">
15875	<desc>
15876	Progress object for the operation.
15877	</desc>
15878	</param>
15879	</method>
15880	</interface>
15881
15882	<interface
15883	name="IExtPackManager" extends="$unknown"
15884	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
15885	wsmap="suppress"
15886	>
15887	<desc>
15888	Interface for managing VirtualBox Extension Packs.
15889
15890	TODO: Describe extension packs, how they are managed and how to create
15891	one.
15892	</desc>
15893
15894	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15895	<desc>
15896	List of the installed extension packs.
15897	</desc>
15898	</attribute>
15899
15900	<method name="find">
15901	<desc>
15902	Returns the extension pack with the specified name if found.
15903
15904	<result name="VBOX_E_OBJECT_NOT_FOUND">
15905	No extension pack matching @a name was found.
15906	</result>
15907	</desc>
15908	<param name="name" type="wstring" dir="in">
15909	<desc>The name of the extension pack to locate.</desc>
15910	</param>
15911	<param name="returnData" type="IExtPack" dir="return">
15912	<desc>The extension pack if found.</desc>
15913	</param>
15914	</method>
15915
15916	<method name="openExtPackFile">
15917	<desc>
15918	Attempts to open an extension pack file in preparation for
15919	installation.
15920	</desc>
15921	<param name="path" type="wstring" dir="in">
15922	<desc>The path of the extension pack tarball.</desc>
15923	</param>
15924	<param name="file" type="IExtPackFile" dir="return">
15925	<desc>The interface of the extension pack file object.</desc>
15926	</param>
15927	</method>
15928
15929	<method name="uninstall">
15930	<desc>Uninstalls an extension pack, removing all related files.</desc>
15931	<param name="name" type="wstring" dir="in">
15932	<desc>The name of the extension pack to uninstall.</desc>
15933	</param>
15934	<param name="forcedRemoval" type="boolean" dir="in">
15935	<desc>
15936	Forced removal of the extension pack. This means that the uninstall
15937	hook will not be called.
15938	</desc>
15939	</param>
15940	<param name="displayInfo" type="wstring" dir="in">
15941	<desc>
15942	Platform specific display information. Reserved for future hacks.
15943	</desc>
15944	</param>
15945	<param name="progess" type="IProgress" dir="return">
15946	<desc>
15947	Progress object for the operation.
15948	</desc>
15949	</param>
15950	</method>
15951
15952	<method name="cleanup">
15953	<desc>Cleans up failed installs and uninstalls</desc>
15954	</method>
15955
15956	<method name="queryAllPlugInsForFrontend">
15957	<desc>
15958	Gets the path to all the plug-in modules for a given frontend.
15959
15960	This is a convenience method that is intended to simplify the plug-in
15961	loading process for a frontend.
15962	</desc>
15963	<param name="frontendName" type="wstring" dir="in">
15964	<desc>The name of the frontend or component.</desc>
15965	</param>
15966	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15967	<desc>Array containing the plug-in modules (full paths).</desc>
15968	</param>
15969	</method>
15970
15971	<method name="isExtPackUsable">
15972	<desc>Check if the given extension pack is loaded and usable.</desc>
15973	<param name="name" type="wstring" dir="in">
15974	<desc>The name of the extension pack to check for.</desc>
15975	</param>
15976	<param name="usable" type="boolean" dir="return">
15977	<desc>Is the given extension pack loaded and usable.</desc>
15978	</param>
15979	</method>
15980
15981	</interface>
15982
15983	<!--
15984	// BandwidthGroupType
15985	/////////////////////////////////////////////////////////////////////////
15986	-->
15987	<enum
15988	name="BandwidthGroupType"
15989	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15990
15991	<desc>
15992	Type of a bandwidth control group.
15993	</desc>
15994
15995	<const name="Null" value="0">
15996	<desc>
15997	Null type, must be first.
15998	</desc>
15999	</const>
16000
16001	<const name="Disk" value="1">
16002	<desc>
16003	The bandwidth group controls disk I/O.
16004	</desc>
16005	</const>
16006
16007	<const name="Network" value="2">
16008	<desc>
16009	The bandwidth group controls network I/O.
16010	</desc>
16011	</const>
16012
16013	</enum>
16014
16015	<!--
16016	// IBandwidthGroup
16017	/////////////////////////////////////////////////////////////////////////
16018	-->
16019	<interface
16020	name="IBandwidthGroup" extends="$unknown"
16021	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16022	wsmap="managed"
16023	>
16024	<desc>Represents one bandwidth group.</desc>
16025
16026	<attribute name="name" type="wstring" readonly="yes">
16027	<desc>Name of the group.</desc>
16028	</attribute>
16029
16030	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16031	<desc>Type of the group.</desc>
16032	</attribute>
16033
16034	<attribute name="reference" type="unsigned long" readonly="yes">
16035	<desc>How many devices/medium attachements use this group.</desc>
16036	</attribute>
16037
16038	<attribute name="maxMbPerSec" type="unsigned long">
16039	<desc>The maximum number of MBytes which can be transfered by all
16040	entities attached to this group during one second.</desc>
16041	</attribute>
16042
16043	</interface>
16044
16045	<!--
16046	// IBandwidthControl
16047	/////////////////////////////////////////////////////////////////////////
16048	-->
16049	<interface
16050	name="IBandwidthControl" extends="$unknown"
16051	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16052	wsmap="managed"
16053	>
16054	<desc>
16055	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16056	This includes network and disk I/O.
16057	</desc>
16058
16059	<attribute name="numGroups" type="unsigned long" readonly="yes">
16060	<desc>
16061	The current number of existing bandwidth groups managed.
16062	</desc>
16063	</attribute>
16064
16065	<method name="createBandwidthGroup">
16066	<desc>
16067	Creates a new bandwidth group.
16068	</desc>
16069
16070	<param name="name" type="wstring" dir="in">
16071	<desc>Name of the bandwidth group.</desc>
16072	</param>
16073	<param name="type" type="BandwidthGroupType" dir="in">
16074	<desc>The type of the bandwidth group (network or disk).</desc>
16075	</param>
16076	<param name="maxMbPerSec" type="unsigned long" dir="in">
16077	<desc>The maximum number of MBytes which can be transfered by all
16078	entities attached to this group during one second.</desc>
16079	</param>
16080	</method>
16081
16082	<method name="deleteBandwidthGroup">
16083	<desc>
16084	Deletes a new bandwidth group.
16085	</desc>
16086
16087	<param name="name" type="wstring" dir="in">
16088	<desc>Name of the bandwidth group to delete.</desc>
16089	</param>
16090	</method>
16091
16092	<method name="getBandwidthGroup" const="yes">
16093	<desc>
16094	Get a bandwidth group by name.
16095	</desc>
16096
16097	<param name="name" type="wstring" dir="in">
16098	<desc>Name of the bandwidth group to get.</desc>
16099	</param>
16100	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16101	<desc>Where to store the bandwidth group on success.</desc>
16102	</param>
16103	</method>
16104
16105	<method name="getAllBandwidthGroups" const="yes">
16106	<desc>
16107	Get all managed bandwidth groups.
16108	</desc>
16109
16110	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16111	<desc>The array of managed bandwidth groups.</desc>
16112	</param>
16113	</method>
16114	</interface>
16115
16116	<!--
16117	// IVirtualBoxClient
16118	/////////////////////////////////////////////////////////////////////////
16119	-->
16120
16121	<interface
16122	name="IVirtualBoxClient" extends="$unknown"
16123	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16124	wsmap="suppress"
16125	>
16126	<desc>
16127	Convenience interface for client applications. Treat this as a
16128	singleton, i.e. never create more than one instance of this interface.
16129
16130	At the moment only available for clients of the local API (not usable
16131	via the webservice). Once the session logic is redesigned this might
16132	change.
16133	</desc>
16134
16135	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16136	<desc>
16137	Reference to the server-side API root object.
16138	</desc>
16139	</attribute>
16140
16141	<attribute name="session" type="ISession" readonly="yes">
16142	<desc>
16143	Create a new session object and return the reference to it.
16144	</desc>
16145	</attribute>
16146
16147	<attribute name="eventSource" type="IEventSource" readonly="yes">
16148	<desc>
16149	Event source for VirtualBoxClient events.
16150	</desc>
16151	</attribute>
16152
16153	</interface>
16154
16155	<!--
16156	// Events
16157	/////////////////////////////////////////////////////////////////////////
16158	-->
16159	<enum
16160	name="VBoxEventType"
16161	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16162	>
16163
16164	<desc>
16165	Type of an event.
16166	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16167	</desc>
16168
16169	<const name="Invalid" value="0">
16170	<desc>
16171	Invalid event, must be first.
16172	</desc>
16173	</const>
16174
16175	<const name="Any" value="1">
16176	<desc>
16177	Wildcard for all events.
16178	Events of this type are never delivered, and only used in
16179	<link to="IEventSource::registerListener"/> call to simplify registration.
16180	</desc>
16181	</const>
16182
16183	<const name="Vetoable" value="2">
16184	<desc>
16185	Wildcard for all vetoable events. Events of this type are never delivered, and only
16186	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16187	</desc>
16188	</const>
16189
16190	<const name="MachineEvent" value="3">
16191	<desc>
16192	Wildcard for all machine events. Events of this type are never delivered, and only used in
16193	<link to="IEventSource::registerListener"/> call to simplify registration.
16194	</desc>
16195	</const>
16196
16197	<const name="SnapshotEvent" value="4">
16198	<desc>
16199	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16200	<link to="IEventSource::registerListener"/> call to simplify registration.
16201	</desc>
16202	</const>
16203
16204	<const name="InputEvent" value="5">
16205	<desc>
16206	Wildcard for all input device (keyboard, mouse) events.
16207	Events of this type are never delivered, and only used in
16208	<link to="IEventSource::registerListener"/> call to simplify registration.
16209	</desc>
16210	</const>
16211
16212	<const name="LastWildcard" value="31">
16213	<desc>
16214	Last wildcard.
16215	</desc>
16216	</const>
16217
16218	<const name="OnMachineStateChanged" value="32">
16219	<desc>
16220	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16221	</desc>
16222	</const>
16223	<const name="OnMachineDataChanged" value="33">
16224	<desc>
16225	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16226	</desc>
16227	</const>
16228	<const name="OnExtraDataChanged" value="34">
16229	<desc>
16230	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16231	</desc>
16232	</const>
16233	<const name="OnExtraDataCanChange" value="35">
16234	<desc>
16235	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16236	</desc>
16237	</const>
16238	<const name="OnMediumRegistered" value="36">
16239	<desc>
16240	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16241	</desc>
16242	</const>
16243	<const name="OnMachineRegistered" value="37">
16244	<desc>
16245	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16246	</desc>
16247	</const>
16248	<const name="OnSessionStateChanged" value="38">
16249	<desc>
16250	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16251	</desc>
16252	</const>
16253	<const name="OnSnapshotTaken" value="39">
16254	<desc>
16255	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16256	</desc>
16257	</const>
16258	<const name="OnSnapshotDeleted" value="40">
16259	<desc>
16260	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16261	</desc>
16262	</const>
16263	<const name="OnSnapshotChanged" value="41">
16264	<desc>
16265	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16266	</desc>
16267	</const>
16268	<const name="OnGuestPropertyChanged" value="42">
16269	<desc>
16270	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16271	</desc>
16272	</const>
16273	<!-- Console events -->
16274	<const name="OnMousePointerShapeChanged" value="43">
16275	<desc>
16276	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16277	</desc>
16278	</const>
16279	<const name="OnMouseCapabilityChanged" value="44">
16280	<desc>
16281	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16282	</desc>
16283	</const>
16284	<const name="OnKeyboardLedsChanged" value="45">
16285	<desc>
16286	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16287	</desc>
16288	</const>
16289	<const name="OnStateChanged" value="46">
16290	<desc>
16291	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16292	</desc>
16293	</const>
16294	<const name="OnAdditionsStateChanged" value="47">
16295	<desc>
16296	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16297	</desc>
16298	</const>
16299	<const name="OnNetworkAdapterChanged" value="48">
16300	<desc>
16301	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16302	</desc>
16303	</const>
16304	<const name="OnSerialPortChanged" value="49">
16305	<desc>
16306	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16307	</desc>
16308	</const>
16309	<const name="OnParallelPortChanged" value="50">
16310	<desc>
16311	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16312	</desc>
16313	</const>
16314	<const name="OnStorageControllerChanged" value="51">
16315	<desc>
16316	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16317	</desc>
16318	</const>
16319	<const name="OnMediumChanged" value="52">
16320	<desc>
16321	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16322	</desc>
16323	</const>
16324	<const name="OnVRDEServerChanged" value="53">
16325	<desc>
16326	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16327	</desc>
16328	</const>
16329	<const name="OnUSBControllerChanged" value="54">
16330	<desc>
16331	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16332	</desc>
16333	</const>
16334	<const name="OnUSBDeviceStateChanged" value="55">
16335	<desc>
16336	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16337	</desc>
16338	</const>
16339	<const name="OnSharedFolderChanged" value="56">
16340	<desc>
16341	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16342	</desc>
16343	</const>
16344	<const name="OnRuntimeError" value="57">
16345	<desc>
16346	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16347	</desc>
16348	</const>
16349	<const name="OnCanShowWindow" value="58">
16350	<desc>
16351	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16352	</desc>
16353	</const>
16354	<const name="OnShowWindow" value="59">
16355	<desc>
16356	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16357	</desc>
16358	</const>
16359	<const name="OnCPUChanged" value="60">
16360	<desc>
16361	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16362	</desc>
16363	</const>
16364	<const name="OnVRDEServerInfoChanged" value="61">
16365	<desc>
16366	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16367	</desc>
16368	</const>
16369	<const name="OnEventSourceChanged" value="62">
16370	<desc>
16371	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16372	</desc>
16373	</const>
16374	<const name="OnCPUExecutionCapChanged" value="63">
16375	<desc>
16376	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16377	</desc>
16378	</const>
16379	<const name="OnGuestKeyboard" value="64">
16380	<desc>
16381	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16382	</desc>
16383	</const>
16384	<const name="OnGuestMouse" value="65">
16385	<desc>
16386	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16387	</desc>
16388	</const>
16389	<const name="OnNATRedirect" value="66">
16390	<desc>
16391	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16392	</desc>
16393	</const>
16394	<const name="OnHostPciDevicePlug" value="67">
16395	<desc>
16396	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16397	</desc>
16398	</const>
16399	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16400	<desc>
16401	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16402	</desc>
16403	</const>
16404	<const name="OnBandwidthGroupChanged" value="69">
16405	<desc>
16406	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16407	</desc>
16408	</const>
16409	<const name="OnGuestMonitorChanged" value="70">
16410	<desc>
16411	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16412	</desc>
16413	</const>
16414	<const name="OnStorageDeviceChanged" value="71">
16415	<desc>
16416	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16417	</desc>
16418	</const>
16419
16420	<!-- Last event marker -->
16421	<const name="Last" value="72">
16422	<desc>
16423	Must be last event, used for iterations and structures relying on numerical event values.
16424	</desc>
16425	</const>
16426
16427	</enum>
16428
16429	<interface
16430	name="IEventSource" extends="$unknown"
16431	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16432	wsmap="managed"
16433	>
16434	<desc>
16435	Event source. Generally, any object which could generate events can be an event source,
16436	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16437	an event source can work with listeners in either active or passive mode. In active mode it is up to
16438	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16439	event source keeps track of pending events for each listener and returns available events on demand.
16440
16441	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16442	</desc>
16443
16444	<method name="createListener">
16445	<desc>
16446	Creates a new listener object, useful for passive mode.
16447	</desc>
16448	<param name="listener" type="IEventListener" dir="return"/>
16449	</method>
16450
16451	<method name="createAggregator">
16452	<desc>
16453	Creates an aggregator event source, collecting events from multiple sources.
16454	This way a single listener can listen for events coming from multiple sources,
16455	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16456	</desc>
16457	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16458	<desc>
16459	Subordinate event source this one aggregatres.
16460	</desc>
16461	</param>
16462	<param name="result" type="IEventSource" dir="return">
16463	<desc>
16464	Event source aggregating passed sources.
16465	</desc>
16466	</param>
16467	</method>
16468
16469	<method name="registerListener">
16470	<desc>
16471	Register an event listener.
16472
16473	<note>
16474	To avoid system overload, the VirtualBox server process checks if passive event
16475	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16476	current implementation, if more than 500 pending events are detected for a passive
16477	event listener, it is forcefully unregistered by the system, and further
16478	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16479	</note>
16480	</desc>
16481	<param name="listener" type="IEventListener" dir="in">
16482	<desc>Listener to register.</desc>
16483	</param>
16484	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16485	<desc>
16486	Event types listener is interested in. One can use wildcards like -
16487	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16488	than one event.
16489	</desc>
16490	</param>
16491	<param name="active" type="boolean" dir="in">
16492	<desc>
16493	Which mode this listener is operating in.
16494	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16495	In passive mode, an internal event queue is created for this this IEventListener.
16496	For each event coming in, it is added to queues for all interested registered passive
16497	listeners. It is then up to the external code to call the listener's
16498	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16499	external code must call <link to="#eventProcessed" />.
16500	</desc>
16501	</param>
16502	</method>
16503
16504	<method name="unregisterListener">
16505	<desc>
16506	Unregister an event listener. If listener is passive, and some waitable events are still
16507	in queue they are marked as processed automatically.
16508	</desc>
16509	<param name="listener" type="IEventListener" dir="in">
16510	<desc>Listener to unregister.</desc>
16511	</param>
16512	</method>
16513
16514	<method name="fireEvent">
16515	<desc>
16516	Fire an event for this source.
16517	</desc>
16518	<param name="event" type="IEvent" dir="in">
16519	<desc>Event to deliver.</desc>
16520	</param>
16521	<param name="timeout" type="long" dir="in">
16522	<desc>
16523	Maximum time to wait for event processing (if event is waitable), in ms;
16524	0 = no wait, -1 = indefinite wait.
16525	</desc>
16526	</param>
16527	<param name="result" type="boolean" dir="return">
16528	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16529	</param>
16530	</method>
16531
16532	<method name="getEvent">
16533	<desc>
16534	Get events from this peer's event queue (for passive mode). Calling this method
16535	regularly is required for passive event listeners to avoid system overload;
16536	see <link to="IEventSource::registerListener" /> for details.
16537
16538	<result name="VBOX_E_OBJECT_NOT_FOUND">
16539	Listener is not registered, or autounregistered.
16540	</result>
16541	</desc>
16542	<param name="listener" type="IEventListener" dir="in">
16543	<desc>Which listener to get data for.</desc>
16544	</param>
16545	<param name="timeout" type="long" dir="in">
16546	<desc>
16547	Maximum time to wait for events, in ms;
16548	0 = no wait, -1 = indefinite wait.
16549	</desc>
16550	</param>
16551	<param name="event" type="IEvent" dir="return">
16552	<desc>Event retrieved, or null if none available.</desc>
16553	</param>
16554	</method>
16555
16556	<method name="eventProcessed">
16557	<desc>
16558	Must be called for waitable events after a particular listener finished its
16559	event processing. When all listeners of a particular event have called this
16560	method, the system will then call <link to="IEvent::setProcessed" />.
16561	</desc>
16562	<param name="listener" type="IEventListener" dir="in">
16563	<desc>Which listener processed event.</desc>
16564	</param>
16565	<param name="event" type="IEvent" dir="in">
16566	<desc>Which event.</desc>
16567	</param>
16568	</method>
16569
16570	</interface>
16571
16572	<interface
16573	name="IEventListener" extends="$unknown"
16574	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16575	wsmap="managed"
16576	>
16577	<desc>
16578	Event listener. An event listener can work in either active or passive mode, depending on the way
16579	it was registered.
16580	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16581	</desc>
16582
16583	<method name="handleEvent">
16584	<desc>
16585	Handle event callback for active listeners. It is not called for
16586	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16587	and having received acknowledgement from all passive listeners via
16588	<link to="IEventSource::eventProcessed"/>, the event is marked as
16589	processed and <link to="IEvent::waitProcessed"/> will return
16590	immediately.
16591	</desc>
16592	<param name="event" type="IEvent" dir="in">
16593	<desc>Event available.</desc>
16594	</param>
16595	</method>
16596
16597	</interface>
16598
16599	<interface
16600	name="IEvent" extends="$unknown"
16601	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16602	wsmap="managed"
16603	>
16604	<desc>
16605	Abstract parent interface for VirtualBox events. Actual events will typically implement
16606	a more specific interface which derives from this (see below).
16607
16608	<b>Introduction to VirtualBox events</b>
16609
16610	Generally speaking, an event (represented by this interface) signals that something
16611	happened, while an event listener (see <link to="IEventListener" />) represents an
16612	entity that is interested in certain events. In order for this to work with
16613	unidirectional protocols (i.e. web services), the concepts of passive and active
16614	listener are used.
16615
16616	Event consumers can register themselves as listeners, providing an array of
16617	events they are interested in (see <link to="IEventSource::registerListener" />).
16618	When an event triggers, the listener is notified about the event. The exact
16619	mechanism of the notification depends on whether the listener was registered as
16620	an active or passive listener:
16621
16622	<ul>
16623	<li>An active listener is very similar to a callback: it is a function invoked
16624	by the API. As opposed to the callbacks that were used in the API before
16625	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
16626	</li>
16627
16628	<li>Passive listeners are somewhat trickier to implement, but do not require
16629	a client function to be callable, which is not an option with scripting
16630	languages or web service clients. Internally the <link to="IEventSource" />
16631	implementation maintains an event queue for each passive listener, and
16632	newly arrived events are put in this queue. When the listener calls
16633	<link to="IEventSource::getEvent"/>, first element from its internal event
16634	queue is returned. When the client completes processing of an event,
16635	the <link to="IEventSource::eventProcessed" /> function must be called,
16636	acknowledging that the event was processed. It supports implementing
16637	waitable events. On passive listener unregistration, all events from its
16638	queue are auto-acknowledged.
16639	</li>
16640	</ul>
16641
16642	Waitable events are useful in situations where the event generator wants to track
16643	delivery or a party wants to wait until all listeners have completed the event. A
16644	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16645	listeners might veto a certain action, and thus the event producer has to make
16646	sure that all listeners have processed the event and not vetoed before taking
16647	the action.
16648
16649	A given event may have both passive and active listeners at the same time.
16650
16651	<b>Using events</b>
16652
16653	Any VirtualBox object capable of producing externally visible events provides an
16654	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16655	This event source object is notified by VirtualBox once something has happened, so
16656	consumers may register event listeners with this event source. To register a listener,
16657	an object implementing the <link to="IEventListener" /> interface must be provided.
16658	For active listeners, such an object is typically created by the consumer, while for
16659	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16660	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
16661
16662	Once created, the listener must be registered to listen for the desired events
16663	(see <link to="IEventSource::registerListener" />), providing an array of
16664	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16665	event IDs or wildcards matching multiple event IDs.
16666
16667	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16668	called automatically when the event is triggered, while passive listeners have to call
16669	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16670	an event processing loop.
16671
16672	The IEvent interface is an abstract parent interface for all such VirtualBox events
16673	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16674	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16675	then cast to the appropriate specific interface using @c QueryInterface().
16676	</desc>
16677
16678	<attribute name="type" readonly="yes" type="VBoxEventType">
16679	<desc>
16680	Event type.
16681	</desc>
16682	</attribute>
16683
16684	<attribute name="source" readonly="yes" type="IEventSource">
16685	<desc>
16686	Source of this event.
16687	</desc>
16688	</attribute>
16689
16690	<attribute name="waitable" readonly="yes" type="boolean">
16691	<desc>
16692	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
16693	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
16694	as no additional overhead associated with waitability imposed.
16695	Waitable events are needed when one need to be able to wait for particular event processed,
16696	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
16697	until all consumers confirmed events.
16698	</desc>
16699	</attribute>
16700
16701	<method name="setProcessed">
16702	<desc>
16703	Internal method called by the system when all listeners of a particular event have called
16704	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
16705	</desc>
16706	</method>
16707
16708	<method name="waitProcessed">
16709	<desc>
16710	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
16711	described semantics, for non-waitable returns true immediately.
16712	</desc>
16713	<param name="timeout" type="long" dir="in">
16714	<desc>
16715	Maximum time to wait for event processeing, in ms;
16716	0 = no wait, -1 = indefinite wait.
16717	</desc>
16718	</param>
16719	<param name="result" type="boolean" dir="return">
16720	<desc>If this event was processed before timeout.</desc>
16721	</param>
16722	</method>
16723	</interface>
16724
16725
16726	<interface
16727	name="IReusableEvent" extends="IEvent"
16728	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
16729	wsmap="managed"
16730	>
16731	<desc>Base abstract interface for all reusable events.</desc>
16732
16733	<attribute name="generation" readonly="yes" type="unsigned long">
16734	<desc>Current generation of event, incremented on reuse.</desc>
16735	</attribute>
16736
16737	<method name="reuse">
16738	<desc>
16739	Marks an event as reused, increments 'generation', fields shall no
16740	longer be considered valid.
16741	</desc>
16742	</method>
16743	</interface>
16744
16745	<interface
16746	name="IMachineEvent" extends="IEvent"
16747	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
16748	wsmap="managed" id="MachineEvent"
16749	>
16750	<desc>Base abstract interface for all machine events.</desc>
16751
16752	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
16753	<desc>ID of the machine this event relates to.</desc>
16754	</attribute>
16755
16756	</interface>
16757
16758	<interface
16759	name="IMachineStateChangedEvent" extends="IMachineEvent"
16760	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
16761	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
16762	>
16763	<desc>Machine state change event.</desc>
16764
16765	<attribute name="state" readonly="yes" type="MachineState">
16766	<desc>New execution state.</desc>
16767	</attribute>
16768	</interface>
16769
16770	<interface
16771	name="IMachineDataChangedEvent" extends="IMachineEvent"
16772	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
16773	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
16774	>
16775	<desc>
16776	Any of the settings of the given machine has changed.
16777	</desc>
16778
16779	<attribute name="temporary" readonly="yes" type="boolean">
16780	<desc>@c true if the settings change is temporary. All permanent
16781	settings changes will trigger an event, and only temporary settings
16782	changes for running VMs will trigger an event. Note: sending events
16783	for temporary changes is NOT IMPLEMENTED.</desc>
16784	</attribute>
16785	</interface>
16786
16787	<interface
16788	name="IMediumRegisteredEvent" extends="IEvent"
16789	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
16790	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
16791	>
16792	<desc>
16793	The given medium was registered or unregistered
16794	within this VirtualBox installation.
16795	</desc>
16796
16797	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
16798	<desc>ID of the medium this event relates to.</desc>
16799	</attribute>
16800
16801	<attribute name="mediumType" readonly="yes" type="DeviceType">
16802	<desc>Type of the medium this event relates to.</desc>
16803	</attribute>
16804
16805	<attribute name="registered" type="boolean" readonly="yes">
16806	<desc>
16807	If @c true, the medium was registered, otherwise it was
16808	unregistered.
16809	</desc>
16810	</attribute>
16811	</interface>
16812
16813	<interface
16814	name="IMachineRegisteredEvent" extends="IMachineEvent"
16815	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
16816	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
16817	>
16818	<desc>
16819	The given machine was registered or unregistered
16820	within this VirtualBox installation.
16821	</desc>
16822
16823	<attribute name="registered" type="boolean" readonly="yes">
16824	<desc>
16825	If @c true, the machine was registered, otherwise it was
16826	unregistered.
16827	</desc>
16828	</attribute>
16829	</interface>
16830
16831	<interface
16832	name="ISessionStateChangedEvent" extends="IMachineEvent"
16833	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
16834	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
16835	>
16836	<desc>
16837	The state of the session for the given machine was changed.
16838	<see><link to="IMachine::sessionState"/></see>
16839	</desc>
16840
16841	<attribute name="state" type="SessionState" readonly="yes">
16842	<desc>
16843	New session state.
16844	</desc>
16845	</attribute>
16846	</interface>
16847
16848	<interface
16849	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
16850	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
16851	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
16852	>
16853	<desc>
16854	Notification when a guest property has changed.
16855	</desc>
16856
16857	<attribute name="name" readonly="yes" type="wstring">
16858	<desc>
16859	The name of the property that has changed.
16860	</desc>
16861	</attribute>
16862
16863	<attribute name="value" readonly="yes" type="wstring">
16864	<desc>
16865	The new property value.
16866	</desc>
16867	</attribute>
16868
16869	<attribute name="flags" readonly="yes" type="wstring">
16870	<desc>
16871	The new property flags.
16872	</desc>
16873	</attribute>
16874
16875	</interface>
16876
16877	<interface
16878	name="ISnapshotEvent" extends="IMachineEvent"
16879	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16880	wsmap="managed" id="SnapshotEvent"
16881	>
16882	<desc>Base interface for all snapshot events.</desc>
16883
16884	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16885	<desc>ID of the snapshot this event relates to.</desc>
16886	</attribute>
16887
16888	</interface>
16889
16890	<interface
16891	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16892	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16893	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16894	>
16895	<desc>
16896	A new snapshot of the machine has been taken.
16897	<see><link to="ISnapshot"/></see>
16898	</desc>
16899	</interface>
16900
16901	<interface
16902	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16903	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16904	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16905	>
16906	<desc>
16907	Snapshot of the given machine has been deleted.
16908
16909	<note>
16910	This notification is delivered <b>after</b> the snapshot
16911	object has been uninitialized on the server (so that any
16912	attempt to call its methods will return an error).
16913	</note>
16914
16915	<see><link to="ISnapshot"/></see>
16916	</desc>
16917	</interface>
16918
16919	<interface
16920	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16921	uuid="07541941-8079-447a-a33e-47a69c7980db"
16922	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16923	>
16924	<desc>
16925	Snapshot properties (name and/or description) have been changed.
16926	<see><link to="ISnapshot"/></see>
16927	</desc>
16928	</interface>
16929
16930	<interface
16931	name="IMousePointerShapeChangedEvent" extends="IEvent"
16932	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16933	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16934	>
16935	<desc>
16936	Notification when the guest mouse pointer shape has
16937	changed. The new shape data is given.
16938	</desc>
16939
16940	<attribute name="visible" type="boolean" readonly="yes">
16941	<desc>
16942	Flag whether the pointer is visible.
16943	</desc>
16944	</attribute>
16945	<attribute name="alpha" type="boolean" readonly="yes">
16946	<desc>
16947	Flag whether the pointer has an alpha channel.
16948	</desc>
16949	</attribute>
16950	<attribute name="xhot" type="unsigned long" readonly="yes">
16951	<desc>
16952	The pointer hot spot X coordinate.
16953	</desc>
16954	</attribute>
16955	<attribute name="yhot" type="unsigned long" readonly="yes">
16956	<desc>
16957	The pointer hot spot Y coordinate.
16958	</desc>
16959	</attribute>
16960	<attribute name="width" type="unsigned long" readonly="yes">
16961	<desc>
16962	Width of the pointer shape in pixels.
16963	</desc>
16964	</attribute>
16965	<attribute name="height" type="unsigned long" readonly="yes">
16966	<desc>
16967	Height of the pointer shape in pixels.
16968	</desc>
16969	</attribute>
16970	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16971	<desc>
16972	Shape buffer arrays.
16973
16974	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16975	followed by a 32-bpp XOR (color) mask.
16976
16977	For pointers without alpha channel the XOR mask pixels are 32
16978	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16979	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16980
16981	An AND mask is used for pointers with alpha channel, so if the
16982	callback does not support alpha, the pointer could be
16983	displayed as a normal color pointer.
16984
16985	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16986	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16987	height</tt>. The padding bits at the end of each scanline are
16988	undefined.
16989
16990	The XOR mask follows the AND mask on the next 4-byte aligned
16991	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16992	Bytes in the gap between the AND and the XOR mask are undefined.
16993	The XOR mask scanlines have no gap between them and the size of
16994	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16995
16996	<note>
16997	If @a shape is 0, only the pointer visibility is changed.
16998	</note>
16999	</desc>
17000	</attribute>
17001	</interface>
17002
17003	<interface
17004	name="IMouseCapabilityChangedEvent" extends="IEvent"
17005	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17006	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17007	>
17008	<desc>
17009	Notification when the mouse capabilities reported by the
17010	guest have changed. The new capabilities are passed.
17011	</desc>
17012	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17013	<desc>
17014	Supports absolute coordinates.
17015	</desc>
17016	</attribute>
17017	<attribute name="supportsRelative" type="boolean" readonly="yes">
17018	<desc>
17019	Supports relative coordinates.
17020	</desc>
17021	</attribute>
17022	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17023	<desc>
17024	If host cursor is needed.
17025	</desc>
17026	</attribute>
17027	</interface>
17028
17029	<interface
17030	name="IKeyboardLedsChangedEvent" extends="IEvent"
17031	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17032	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17033	>
17034	<desc>
17035	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17036	to alter the state of the keyboard LEDs.
17037	</desc>
17038	<attribute name="numLock" type="boolean" readonly="yes">
17039	<desc>
17040	NumLock status.
17041	</desc>
17042	</attribute>
17043	<attribute name="capsLock" type="boolean" readonly="yes">
17044	<desc>
17045	CapsLock status.
17046	</desc>
17047	</attribute>
17048	<attribute name="scrollLock" type="boolean" readonly="yes">
17049	<desc>
17050	ScrollLock status.
17051	</desc>
17052	</attribute>
17053	</interface>
17054
17055	<interface
17056	name="IStateChangedEvent" extends="IEvent"
17057	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17058	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17059	>
17060	<desc>
17061	Notification when the execution state of the machine has changed.
17062	The new state is given.
17063	</desc>
17064	<attribute name="state" type="MachineState" readonly="yes">
17065	<desc>
17066	New machine state.
17067	</desc>
17068	</attribute>
17069	</interface>
17070
17071	<interface
17072	name="IAdditionsStateChangedEvent" extends="IEvent"
17073	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17074	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17075	>
17076	<desc>
17077	Notification when a Guest Additions property changes.
17078	Interested callees should query IGuest attributes to
17079	find out what has changed.
17080	</desc>
17081	</interface>
17082
17083	<interface
17084	name="INetworkAdapterChangedEvent" extends="IEvent"
17085	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17086	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17087	>
17088	<desc>
17089	Notification when a property of one of the
17090	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17091	changes. Interested callees should use INetworkAdapter methods and
17092	attributes to find out what has changed.
17093	</desc>
17094	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17095	<desc>
17096	Network adapter that is subject to change.
17097	</desc>
17098	</attribute>
17099	</interface>
17100
17101	<interface
17102	name="ISerialPortChangedEvent" extends="IEvent"
17103	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17104	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17105	>
17106	<desc>
17107	Notification when a property of one of the
17108	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17109	Interested callees should use ISerialPort methods and attributes
17110	to find out what has changed.
17111	</desc>
17112	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17113	<desc>
17114	Serial port that is subject to change.
17115	</desc>
17116	</attribute>
17117	</interface>
17118
17119	<interface
17120	name="IParallelPortChangedEvent" extends="IEvent"
17121	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17122	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17123	>
17124	<desc>
17125	Notification when a property of one of the
17126	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17127	changes. Interested callees should use ISerialPort methods and
17128	attributes to find out what has changed.
17129	</desc>
17130	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17131	<desc>
17132	Parallel port that is subject to change.
17133	</desc>
17134	</attribute>
17135	</interface>
17136
17137	<interface
17138	name="IStorageControllerChangedEvent" extends="IEvent"
17139	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17140	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17141	>
17142	<desc>
17143	Notification when a
17144	<link to="IMachine::mediumAttachments">medium attachment</link>
17145	changes.
17146	</desc>
17147	</interface>
17148
17149	<interface
17150	name="IMediumChangedEvent" extends="IEvent"
17151	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17152	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17153	>
17154	<desc>
17155	Notification when a
17156	<link to="IMachine::mediumAttachments">medium attachment</link>
17157	changes.
17158	</desc>
17159	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17160	<desc>
17161	Medium attachment that is subject to change.
17162	</desc>
17163	</attribute>
17164	</interface>
17165
17166	<interface
17167	name="ICPUChangedEvent" extends="IEvent"
17168	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17169	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17170	>
17171	<desc>
17172	Notification when a CPU changes.
17173	</desc>
17174	<attribute name="cpu" type="unsigned long" readonly="yes">
17175	<desc>
17176	The CPU which changed.
17177	</desc>
17178	</attribute>
17179	<attribute name="add" type="boolean" readonly="yes">
17180	<desc>
17181	Flag whether the CPU was added or removed.
17182	</desc>
17183	</attribute>
17184	</interface>
17185
17186	<interface
17187	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17188	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17189	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17190	>
17191	<desc>
17192	Notification when the CPU execution cap changes.
17193	</desc>
17194	<attribute name="executionCap" type="unsigned long" readonly="yes">
17195	<desc>
17196	The new CPU execution cap value. (1-100)
17197	</desc>
17198	</attribute>
17199	</interface>
17200
17201	<interface
17202	name="IGuestKeyboardEvent" extends="IEvent"
17203	uuid="88394258-7006-40d4-b339-472ee3801844"
17204	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17205	>
17206	<desc>
17207	Notification when guest keyboard event happens.
17208	</desc>
17209	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17210	<desc>
17211	Array of scancodes.
17212	</desc>
17213	</attribute>
17214	</interface>
17215
17216	<interface
17217	name="IGuestMouseEvent" extends="IReusableEvent"
17218	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17219	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17220	>
17221	<desc>
17222	Notification when guest mouse event happens.
17223	</desc>
17224
17225	<attribute name="absolute" type="boolean" readonly="yes">
17226	<desc>
17227	If this event is relative or absolute.
17228	</desc>
17229	</attribute>
17230
17231	<attribute name="x" type="long" readonly="yes">
17232	<desc>
17233	New X position, or X delta.
17234	</desc>
17235	</attribute>
17236
17237	<attribute name="y" type="long" readonly="yes">
17238	<desc>
17239	New Y position, or Y delta.
17240	</desc>
17241	</attribute>
17242
17243	<attribute name="z" type="long" readonly="yes">
17244	<desc>
17245	Z delta.
17246	</desc>
17247	</attribute>
17248
17249	<attribute name="w" type="long" readonly="yes">
17250	<desc>
17251	W delta.
17252	</desc>
17253	</attribute>
17254
17255	<attribute name="buttons" type="long" readonly="yes">
17256	<desc>
17257	Button state bitmask.
17258	</desc>
17259	</attribute>
17260
17261	</interface>
17262
17263
17264	<interface
17265	name="IVRDEServerChangedEvent" extends="IEvent"
17266	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17267	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17268	>
17269	<desc>
17270	Notification when a property of the
17271	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17272	Interested callees should use IVRDEServer methods and attributes to
17273	find out what has changed.
17274	</desc>
17275	</interface>
17276
17277	<interface
17278	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17279	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17280	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17281	>
17282	<desc>
17283	Notification when the status of the VRDE server changes. Interested callees
17284	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17285	attributes to find out what is the current status.
17286	</desc>
17287	</interface>
17288
17289	<interface
17290	name="IUSBControllerChangedEvent" extends="IEvent"
17291	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17292	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17293	>
17294	<desc>
17295	Notification when a property of the virtual
17296	<link to="IMachine::USBController">USB controller</link> changes.
17297	Interested callees should use IUSBController methods and attributes to
17298	find out what has changed.
17299	</desc>
17300	</interface>
17301
17302	<interface
17303	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17304	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17305	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17306	>
17307	<desc>
17308	Notification when a USB device is attached to or detached from
17309	the virtual USB controller.
17310
17311	This notification is sent as a result of the indirect
17312	request to attach the device because it matches one of the
17313	machine USB filters, or as a result of the direct request
17314	issued by <link to="IConsole::attachUSBDevice"/> or
17315	<link to="IConsole::detachUSBDevice"/>.
17316
17317	This notification is sent in case of both a succeeded and a
17318	failed request completion. When the request succeeds, the
17319	@a error parameter is @c null, and the given device has been
17320	already added to (when @a attached is @c true) or removed from
17321	(when @a attached is @c false) the collection represented by
17322	<link to="IConsole::USBDevices"/>. On failure, the collection
17323	doesn't change and the @a error parameter represents the error
17324	message describing the failure.
17325	</desc>
17326	<attribute name="device" type="IUSBDevice" readonly="yes">
17327	<desc>
17328	Device that is subject to state change.
17329	</desc>
17330	</attribute>
17331	<attribute name="attached" type="boolean" readonly="yes">
17332	<desc>
17333	@c true if the device was attached and @c false otherwise.
17334	</desc>
17335	</attribute>
17336	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17337	<desc>
17338	@c null on success or an error message object on failure.
17339	</desc>
17340	</attribute>
17341	</interface>
17342
17343	<interface
17344	name="ISharedFolderChangedEvent" extends="IEvent"
17345	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17346	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17347	>
17348	<desc>
17349	Notification when a shared folder is added or removed.
17350	The @a scope argument defines one of three scopes:
17351	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17352	(<link to="Scope_Global">Global</link>),
17353	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17354	the machine (<link to="Scope_Machine">Machine</link>) or <link
17355	to="IConsole::sharedFolders">transient shared folders</link> of the
17356	machine (<link to="Scope_Session">Session</link>). Interested callees
17357	should use query the corresponding collections to find out what has
17358	changed.
17359	</desc>
17360	<attribute name="scope" type="Scope" readonly="yes">
17361	<desc>
17362	Scope of the notification.
17363	</desc>
17364	</attribute>
17365	</interface>
17366
17367	<interface
17368	name="IRuntimeErrorEvent" extends="IEvent"
17369	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17370	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17371	>
17372	<desc>
17373	Notification when an error happens during the virtual
17374	machine execution.
17375
17376	There are three kinds of runtime errors:
17377	<ul>
17378	<li><i>fatal</i></li>
17379	<li><i>non-fatal with retry</i></li>
17380	<li><i>non-fatal warnings</i></li>
17381	</ul>
17382
17383	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17384	to @c true. In case of fatal errors, the virtual machine
17385	execution is always paused before calling this notification, and
17386	the notification handler is supposed either to immediately save
17387	the virtual machine state using <link to="IConsole::saveState"/>
17388	or power it off using <link to="IConsole::powerDown"/>.
17389	Resuming the execution can lead to unpredictable results.
17390
17391	<b>Non-fatal</b> errors and warnings are indicated by the
17392	@a fatal parameter set to @c false. If the virtual machine
17393	is in the Paused state by the time the error notification is
17394	received, it means that the user can <i>try to resume</i> the machine
17395	execution after attempting to solve the problem that caused the
17396	error. In this case, the notification handler is supposed
17397	to show an appropriate message to the user (depending on the
17398	value of the @a id parameter) that offers several actions such
17399	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17400	wants to retry, the notification handler should continue
17401	the machine execution using the <link to="IConsole::resume"/>
17402	call. If the machine execution is not Paused during this
17403	notification, then it means this notification is a <i>warning</i>
17404	(for example, about a fatal condition that can happen very soon);
17405	no immediate action is required from the user, the machine
17406	continues its normal execution.
17407
17408	Note that in either case the notification handler
17409	<b>must not</b> perform any action directly on a thread
17410	where this notification is called. Everything it is allowed to
17411	do is to post a message to another thread that will then talk
17412	to the user and take the corresponding action.
17413
17414	Currently, the following error identifiers are known:
17415	<ul>
17416	<li><tt>"HostMemoryLow"</tt></li>
17417	<li><tt>"HostAudioNotResponding"</tt></li>
17418	<li><tt>"VDIStorageFull"</tt></li>
17419	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17420	</ul>
17421	</desc>
17422	<attribute name="fatal" type="boolean" readonly="yes">
17423	<desc>
17424	Whether the error is fatal or not.
17425	</desc>
17426	</attribute>
17427	<attribute name="id" type="wstring" readonly="yes">
17428	<desc>
17429	Error identifier.
17430	</desc>
17431	</attribute>
17432	<attribute name="message" type="wstring" readonly="yes">
17433	<desc>
17434	Optional error message.
17435	</desc>
17436	</attribute>
17437	</interface>
17438
17439
17440	<interface
17441	name="IEventSourceChangedEvent" extends="IEvent"
17442	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17443	waitable="yes"
17444	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17445	>
17446	<desc>
17447	Notification when an event source state changes (listener added or removed).
17448	</desc>
17449
17450	<attribute name="listener" type="IEventListener" readonly="yes">
17451	<desc>
17452	Event listener which has changed.
17453	</desc>
17454	</attribute>
17455
17456	<attribute name="add" type="boolean" readonly="yes">
17457	<desc>
17458	Flag whether listener was added or removed.
17459	</desc>
17460	</attribute>
17461	</interface>
17462
17463	<interface
17464	name="IExtraDataChangedEvent" extends="IEvent"
17465	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17466	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17467	>
17468	<desc>
17469	Notification when machine specific or global extra data
17470	has changed.
17471	</desc>
17472	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17473	<desc>
17474	ID of the machine this event relates to.
17475	Null for global extra data changes.
17476	</desc>
17477	</attribute>
17478	<attribute name="key" type="wstring" readonly="yes">
17479	<desc>
17480	Extra data key that has changed.
17481	</desc>
17482	</attribute>
17483	<attribute name="value" type="wstring" readonly="yes">
17484	<desc>
17485	Extra data value for the given key.
17486	</desc>
17487	</attribute>
17488	</interface>
17489
17490	<interface
17491	name="IVetoEvent" extends="IEvent"
17492	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17493	wsmap="managed"
17494	>
17495	<desc>Base abstract interface for veto events.</desc>
17496
17497	<method name="addVeto">
17498	<desc>
17499	Adds a veto on this event.
17500	</desc>
17501	<param name="reason" type="wstring" dir="in">
17502	<desc>
17503	Reason for veto, could be null or empty string.
17504	</desc>
17505	</param>
17506	</method>
17507
17508	<method name="isVetoed">
17509	<desc>
17510	If this event was vetoed.
17511	</desc>
17512	<param name="result" type="boolean" dir="return">
17513	<desc>
17514	Reason for veto.
17515	</desc>
17516	</param>
17517	</method>
17518
17519	<method name="getVetos">
17520	<desc>
17521	Current veto reason list, if size is 0 - no veto.
17522	</desc>
17523	<param name="result" type="wstring" dir="return" safearray="yes">
17524	<desc>
17525	Array of reasons for veto provided by different event handlers.
17526	</desc>
17527	</param>
17528	</method>
17529
17530	</interface>
17531
17532	<interface
17533	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17534	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17535	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17536	waitable="true"
17537	>
17538	<desc>
17539	Notification when someone tries to change extra data for
17540	either the given machine or (if @c null) global extra data.
17541	This gives the chance to veto against changes.
17542	</desc>
17543	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17544	<desc>
17545	ID of the machine this event relates to.
17546	Null for global extra data changes.
17547	</desc>
17548	</attribute>
17549	<attribute name="key" type="wstring" readonly="yes">
17550	<desc>
17551	Extra data key that has changed.
17552	</desc>
17553	</attribute>
17554	<attribute name="value" type="wstring" readonly="yes">
17555	<desc>
17556	Extra data value for the given key.
17557	</desc>
17558	</attribute>
17559	</interface>
17560
17561	<interface
17562	name="ICanShowWindowEvent" extends="IVetoEvent"
17563	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17564	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17565	waitable="true"
17566	>
17567	<desc>
17568	Notification when a call to
17569	<link to="IMachine::canShowConsoleWindow"/> is made by a
17570	front-end to check if a subsequent call to
17571	<link to="IMachine::showConsoleWindow"/> can succeed.
17572
17573	The callee should give an answer appropriate to the current
17574	machine state using event veto. This answer must
17575	remain valid at least until the next
17576	<link to="IConsole::state">machine state</link> change.
17577	</desc>
17578	</interface>
17579
17580	<interface
17581	name="IShowWindowEvent" extends="IEvent"
17582	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17583	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17584	waitable="true"
17585	>
17586	<desc>
17587	Notification when a call to
17588	<link to="IMachine::showConsoleWindow"/>
17589	requests the console window to be activated and brought to
17590	foreground on the desktop of the host PC.
17591
17592	This notification should cause the VM console process to
17593	perform the requested action as described above. If it is
17594	impossible to do it at a time of this notification, this
17595	method should return a failure.
17596
17597	Note that many modern window managers on many platforms
17598	implement some sort of focus stealing prevention logic, so
17599	that it may be impossible to activate a window without the
17600	help of the currently active application (which is supposedly
17601	an initiator of this notification). In this case, this method
17602	must return a non-zero identifier that represents the
17603	top-level window of the VM console process. The caller, if it
17604	represents a currently active process, is responsible to use
17605	this identifier (in a platform-dependent manner) to perform
17606	actual window activation.
17607
17608	This method must set @a winId to zero if it has performed all
17609	actions necessary to complete the request and the console
17610	window is now active and in foreground, to indicate that no
17611	further action is required on the caller's side.
17612	</desc>
17613	<attribute name="winId" type="long long">
17614	<desc>
17615	Platform-dependent identifier of the top-level VM console
17616	window, or zero if this method has performed all actions
17617	necessary to implement the <i>show window</i> semantics for
17618	the given platform and/or this VirtualBox front-end.
17619	</desc>
17620	</attribute>
17621	</interface>
17622
17623	<interface
17624	name="INATRedirectEvent" extends="IMachineEvent"
17625	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
17626	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
17627	>
17628	<desc>
17629	Notification when NAT redirect rule added or removed.
17630	</desc>
17631	<attribute name="slot" type="unsigned long" readonly="yes">
17632	<desc>
17633	Adapter which NAT attached to.
17634	</desc>
17635	</attribute>
17636	<attribute name="remove" type="boolean" readonly="yes">
17637	<desc>
17638	Whether rule remove or add.
17639	</desc>
17640	</attribute>
17641	<attribute name="name" type="wstring" readonly="yes">
17642	<desc>
17643	Name of the rule.
17644	</desc>
17645	</attribute>
17646	<attribute name="proto" type="NATProtocol" readonly="yes">
17647	<desc>
17648	Protocol (TCP or UDP) of the redirect rule.
17649	</desc>
17650	</attribute>
17651	<attribute name="hostIp" type="wstring" readonly="yes">
17652	<desc>
17653	Host ip address to bind socket on.
17654	</desc>
17655	</attribute>
17656	<attribute name="hostPort" type="long" readonly="yes">
17657	<desc>
17658	Host port to bind socket on.
17659	</desc>
17660	</attribute>
17661	<attribute name="guestIp" type="wstring" readonly="yes">
17662	<desc>
17663	Guest ip address to redirect to.
17664	</desc>
17665	</attribute>
17666	<attribute name="guestPort" type="long" readonly="yes">
17667	<desc>
17668	Guest port to redirect to.
17669	</desc>
17670	</attribute>
17671	</interface>
17672
17673	<interface
17674	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17675	waitable="yes"
17676	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17677	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17678	>
17679	<desc>
17680	Notification when host PCI device is plugged/unplugged. Plugging
17681	usually takes place on VM startup, unplug - when
17682	<link to="IMachine::detachHostPciDevice"/> is called.
17683
17684	<see><link to="IMachine::detachHostPciDevice"/></see>
17685
17686	</desc>
17687
17688	<attribute name="plugged" type="boolean" readonly="yes">
17689	<desc>
17690	If device successfully plugged or unplugged.
17691	</desc>
17692	</attribute>
17693
17694	<attribute name="success" type="boolean" readonly="yes">
17695	<desc>
17696	If operation was successful, if false - 'message' attribute
17697	may be of interest.
17698	</desc>
17699	</attribute>
17700
17701	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
17702	<desc>
17703	Attachment info for this device.
17704	</desc>
17705	</attribute>
17706
17707	<attribute name="message" type="wstring" readonly="yes">
17708	<desc>
17709	Optional error message.
17710	</desc>
17711	</attribute>
17712
17713	</interface>
17714
17715	<interface
17716	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
17717	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
17718	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
17719	>
17720	<desc>
17721	Notification when VBoxSVC becomes unavailable (due to a crash or similar
17722	unexpected circumstances) or available again.
17723	</desc>
17724
17725	<attribute name="available" type="boolean" readonly="yes">
17726	<desc>
17727	Whether VBoxSVC is available now.
17728	</desc>
17729	</attribute>
17730	</interface>
17731
17732	<interface
17733	name="IBandwidthGroupChangedEvent" extends="IEvent"
17734	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
17735	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
17736	>
17737	<desc>
17738	Notification when one of the bandwidth groups changed
17739	</desc>
17740	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
17741	<desc>
17742	The changed bandwidth group.
17743	</desc>
17744	</attribute>
17745	</interface>
17746
17747	<enum
17748	name="GuestMonitorChangedEventType"
17749	uuid="ef172985-7e36-4297-95be-e46396968d66"
17750	>
17751
17752	<desc>
17753	How the guest monitor has been changed.
17754	</desc>
17755
17756	<const name="Enabled" value="0">
17757	<desc>
17758	The guest monitor has been enabled by the guest.
17759	</desc>
17760	</const>
17761
17762	<const name="Disabled" value="1">
17763	<desc>
17764	The guest monitor has been disabled by the guest.
17765	</desc>
17766	</const>
17767
17768	<const name="NewOrigin" value="2">
17769	<desc>
17770	The guest monitor origin has changed in the guest.
17771	</desc>
17772	</const>
17773	</enum>
17774
17775	<interface
17776	name="IGuestMonitorChangedEvent" extends="IEvent"
17777	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
17778	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
17779	>
17780	<desc>
17781	Notification when the guest enables one of its monitors.
17782	</desc>
17783
17784	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
17785	<desc>
17786	What was changed for this guest monitor.
17787	</desc>
17788	</attribute>
17789
17790	<attribute name="screenId" type="unsigned long" readonly="yes">
17791	<desc>
17792	The monitor which was changed.
17793	</desc>
17794	</attribute>
17795
17796	<attribute name="originX" type="unsigned long" readonly="yes">
17797	<desc>
17798	Physical X origin relative to the primary screen.
17799	Valid for Enabled and NewOrigin.
17800	</desc>
17801	</attribute>
17802
17803	<attribute name="originY" type="unsigned long" readonly="yes">
17804	<desc>
17805	Physical Y origin relative to the primary screen.
17806	Valid for Enabled and NewOrigin.
17807	</desc>
17808	</attribute>
17809
17810	<attribute name="width" type="unsigned long" readonly="yes">
17811	<desc>
17812	Width of the screen.
17813	Valid for Enabled.
17814	</desc>
17815	</attribute>
17816
17817	<attribute name="height" type="unsigned long" readonly="yes">
17818	<desc>
17819	Height of the screen.
17820	Valid for Enabled.
17821	</desc>
17822	</attribute>
17823
17824	</interface>
17825
17826	<interface
17827	name="IStorageDeviceChangedEvent" extends="IEvent"
17828	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
17829	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
17830	>
17831	<desc>
17832	Notification when a
17833	<link to="IMachine::mediumAttachments">storage device</link>
17834	is attached or removed.
17835	</desc>
17836	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
17837	<desc>
17838	Storage device that is subject to change.
17839	</desc>
17840	</attribute>
17841	<attribute name="removed" type="boolean" readonly="yes">
17842	<desc>
17843	Flag whether the device was removed or added to the VM.
17844	</desc>
17845	</attribute>
17846	</interface>
17847
17848	<module name="VBoxSVC" context="LocalServer">
17849	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
17850	namespace="virtualbox.org">
17851	<interface name="IVirtualBox" default="yes"/>
17852	</class>
17853	</module>
17854
17855	<module name="VBoxC" context="InprocServer" threadingModel="Free">
17856	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
17857	namespace="virtualbox.org">
17858	<interface name="IVirtualBoxClient" default="yes"/>
17859	</class>
17860
17861	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
17862	namespace="virtualbox.org">
17863	<interface name="ISession" default="yes"/>
17864	</class>
17865	</module>
17866
17867	</library>
17868
17869	</idl>
17870
17871	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format